1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
36 #include "dispextern.h"
39 #include "intervals.h"
40 #include "blockinput.h"
52 #include <sys/ioctl.h>
54 #endif /* not MSDOS */
56 #include "syssignal.h"
59 #include <sys/types.h>
64 /* This is to get the definitions of the XK_ symbols. */
71 #endif /* HAVE_NTGUI */
73 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
78 /* Variables for blockinput.h: */
80 /* Non-zero if interrupt input is blocked right now. */
81 int interrupt_input_blocked
;
83 /* Nonzero means an input interrupt has arrived
84 during the current critical section. */
85 int interrupt_input_pending
;
88 /* File descriptor to use for input. */
91 #ifdef HAVE_WINDOW_SYSTEM
92 /* Make all keyboard buffers much bigger when using X windows. */
94 /* But not too big (local data > 32K error) if on macintosh */
95 #define KBD_BUFFER_SIZE 512
97 #define KBD_BUFFER_SIZE 4096
99 #else /* No X-windows, character input */
100 #define KBD_BUFFER_SIZE 256
101 #endif /* No X-windows */
103 /* Following definition copied from eval.c */
107 struct backtrace
*next
;
108 Lisp_Object
*function
;
109 Lisp_Object
*args
; /* Points to vector of args. */
110 int nargs
; /* length of vector. If nargs is UNEVALLED,
111 args points to slot holding list of
117 KBOARD
*initial_kboard
;
118 KBOARD
*current_kboard
;
122 KBOARD the_only_kboard
;
125 /* Non-nil disable property on a command means
126 do not execute it; call disabled-command-hook's value instead. */
127 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
129 #define NUM_RECENT_KEYS (100)
130 int recent_keys_index
; /* Index for storing next element into recent_keys */
131 int total_keys
; /* Total number of elements stored into recent_keys */
132 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
134 /* Vector holding the key sequence that invoked the current command.
135 It is reused for each command, and it may be longer than the current
136 sequence; this_command_key_count indicates how many elements
137 actually mean something.
138 It's easier to staticpro a single Lisp_Object than an array. */
139 Lisp_Object this_command_keys
;
140 int this_command_key_count
;
142 /* This vector is used as a buffer to record the events that were actually read
143 by read_key_sequence. */
144 Lisp_Object raw_keybuf
;
145 int raw_keybuf_count
;
147 #define GROW_RAW_KEYBUF \
148 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
150 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
152 new = Fmake_vector (make_number (newsize), Qnil); \
153 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
154 raw_keybuf_count * sizeof (Lisp_Object)); \
158 /* Number of elements of this_command_keys
159 that precede this key sequence. */
160 int this_single_command_key_start
;
162 /* Record values of this_command_key_count and echo_length ()
163 before this command was read. */
164 static int before_command_key_count
;
165 static int before_command_echo_length
;
166 /* Values of before_command_key_count and before_command_echo_length
167 saved by reset-this-command-lengths. */
168 static int before_command_key_count_1
;
169 static int before_command_echo_length_1
;
170 /* Flag set by reset-this-command-lengths,
171 saying to reset the lengths when add_command_key is called. */
172 static int before_command_restore_flag
;
174 extern int minbuf_level
;
176 extern int message_enable_multibyte
;
178 extern struct backtrace
*backtrace_list
;
180 /* If non-nil, the function that implements the display of help.
181 It's called with one argument, the help string to display. */
183 Lisp_Object Vshow_help_function
;
185 /* Nonzero means do menu prompting. */
186 static int menu_prompting
;
188 /* Character to see next line of menu prompt. */
189 static Lisp_Object menu_prompt_more_char
;
191 /* For longjmp to where kbd input is being done. */
192 static jmp_buf getcjmp
;
194 /* True while doing kbd input. */
195 int waiting_for_input
;
197 /* True while displaying for echoing. Delays C-g throwing. */
201 /* Non-null means we can start echoing at the next input pause even
202 though there is something in the echo area. */
204 static struct kboard
*ok_to_echo_at_next_pause
;
206 /* The kboard last echoing, or null for none. Reset to 0 in
207 cancel_echoing. If non-null, and a current echo area message
208 exists, and echo_message_buffer is eq to the current message
209 buffer, we know that the message comes from echo_kboard. */
211 static struct kboard
*echo_kboard
;
213 /* The buffer used for echoing. Set in echo_now, reset in
216 static Lisp_Object echo_message_buffer
;
218 /* Nonzero means disregard local maps for the menu bar. */
219 static int inhibit_local_menu_bar_menus
;
221 /* Nonzero means C-g should cause immediate error-signal. */
224 /* The user's ERASE setting. */
225 Lisp_Object Vtty_erase_char
;
227 /* Character to recognize as the help char. */
228 Lisp_Object Vhelp_char
;
230 /* List of other event types to recognize as meaning "help". */
231 Lisp_Object Vhelp_event_list
;
233 /* Form to execute when help char is typed. */
234 Lisp_Object Vhelp_form
;
236 /* Command to run when the help character follows a prefix key. */
237 Lisp_Object Vprefix_help_command
;
239 /* List of items that should move to the end of the menu bar. */
240 Lisp_Object Vmenu_bar_final_items
;
242 /* Non-nil means show the equivalent key-binding for
243 any M-x command that has one.
244 The value can be a length of time to show the message for.
245 If the value is non-nil and not a number, we wait 2 seconds. */
246 Lisp_Object Vsuggest_key_bindings
;
248 /* Character that causes a quit. Normally C-g.
250 If we are running on an ordinary terminal, this must be an ordinary
251 ASCII char, since we want to make it our interrupt character.
253 If we are not running on an ordinary terminal, it still needs to be
254 an ordinary ASCII char. This character needs to be recognized in
255 the input interrupt handler. At this point, the keystroke is
256 represented as a struct input_event, while the desired quit
257 character is specified as a lispy event. The mapping from struct
258 input_events to lispy events cannot run in an interrupt handler,
259 and the reverse mapping is difficult for anything but ASCII
262 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
266 extern Lisp_Object current_global_map
;
267 extern int minibuf_level
;
269 /* If non-nil, this is a map that overrides all other local maps. */
270 Lisp_Object Voverriding_local_map
;
272 /* If non-nil, Voverriding_local_map applies to the menu bar. */
273 Lisp_Object Voverriding_local_map_menu_flag
;
275 /* Keymap that defines special misc events that should
276 be processed immediately at a low level. */
277 Lisp_Object Vspecial_event_map
;
279 /* Current depth in recursive edits. */
280 int command_loop_level
;
282 /* Total number of times command_loop has read a key sequence. */
285 /* Last input character read as a command. */
286 Lisp_Object last_command_char
;
288 /* Last input character read as a command, not counting menus
289 reached by the mouse. */
290 Lisp_Object last_nonmenu_event
;
292 /* Last input character read for any purpose. */
293 Lisp_Object last_input_char
;
295 /* If not Qnil, a list of objects to be read as subsequent command input. */
296 Lisp_Object Vunread_command_events
;
298 /* If not Qnil, a list of objects to be read as subsequent command input
299 including input method processing. */
300 Lisp_Object Vunread_input_method_events
;
302 /* If not Qnil, a list of objects to be read as subsequent command input
303 but NOT including input method processing. */
304 Lisp_Object Vunread_post_input_method_events
;
306 /* If not -1, an event to be read as subsequent command input. */
307 int unread_command_char
;
309 /* If not Qnil, this is a switch-frame event which we decided to put
310 off until the end of a key sequence. This should be read as the
311 next command input, after any unread_command_events.
313 read_key_sequence uses this to delay switch-frame events until the
314 end of the key sequence; Fread_char uses it to put off switch-frame
315 events until a non-ASCII event is acceptable as input. */
316 Lisp_Object unread_switch_frame
;
318 /* A mask of extra modifier bits to put into every keyboard char. */
319 int extra_keyboard_modifiers
;
321 /* Char to use as prefix when a meta character is typed in.
322 This is bound on entry to minibuffer in case ESC is changed there. */
324 Lisp_Object meta_prefix_char
;
326 /* Last size recorded for a current buffer which is not a minibuffer. */
327 static int last_non_minibuf_size
;
329 /* Number of idle seconds before an auto-save and garbage collection. */
330 static Lisp_Object Vauto_save_timeout
;
332 /* Total number of times read_char has returned. */
333 int num_input_events
;
335 /* Total number of times read_char has returned, outside of macros. */
336 int num_nonmacro_input_events
;
338 /* Auto-save automatically when this many characters have been typed
339 since the last time. */
341 static int auto_save_interval
;
343 /* Value of num_nonmacro_input_events as of last auto save. */
347 /* The command being executed by the command loop.
348 Commands may set this, and the value set will be copied into
349 current_kboard->Vlast_command instead of the actual command. */
350 Lisp_Object Vthis_command
;
352 /* This is like Vthis_command, except that commands never set it. */
353 Lisp_Object real_this_command
;
355 /* The value of point when the last command was executed. */
356 int last_point_position
;
358 /* The buffer that was current when the last command was started. */
359 Lisp_Object last_point_position_buffer
;
361 /* The frame in which the last input event occurred, or Qmacro if the
362 last event came from a macro. We use this to determine when to
363 generate switch-frame events. This may be cleared by functions
364 like Fselect_frame, to make sure that a switch-frame event is
365 generated by the next character. */
366 Lisp_Object internal_last_event_frame
;
368 /* A user-visible version of the above, intended to allow users to
369 figure out where the last event came from, if the event doesn't
370 carry that information itself (i.e. if it was a character). */
371 Lisp_Object Vlast_event_frame
;
373 /* The timestamp of the last input event we received from the X server.
374 X Windows wants this for selection ownership. */
375 unsigned long last_event_timestamp
;
377 Lisp_Object Qself_insert_command
;
378 Lisp_Object Qforward_char
;
379 Lisp_Object Qbackward_char
;
380 Lisp_Object Qundefined
;
381 Lisp_Object Qtimer_event_handler
;
383 /* read_key_sequence stores here the command definition of the
384 key sequence that it reads. */
385 Lisp_Object read_key_sequence_cmd
;
387 /* Echo unfinished commands after this many seconds of pause. */
388 Lisp_Object Vecho_keystrokes
;
390 /* Form to evaluate (if non-nil) when Emacs is started. */
391 Lisp_Object Vtop_level
;
393 /* User-supplied string to translate input characters through. */
394 Lisp_Object Vkeyboard_translate_table
;
396 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
397 extern Lisp_Object Vfunction_key_map
;
399 /* Another keymap that maps key sequences into key sequences.
400 This one takes precedence over ordinary definitions. */
401 extern Lisp_Object Vkey_translation_map
;
403 /* If non-nil, this implements the current input method. */
404 Lisp_Object Vinput_method_function
;
405 Lisp_Object Qinput_method_function
;
407 /* When we call Vinput_method_function,
408 this holds the echo area message that was just erased. */
409 Lisp_Object Vinput_method_previous_message
;
411 /* Non-nil means deactivate the mark at end of this command. */
412 Lisp_Object Vdeactivate_mark
;
414 /* Menu bar specified in Lucid Emacs fashion. */
416 Lisp_Object Vlucid_menu_bar_dirty_flag
;
417 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
419 Lisp_Object Qecho_area_clear_hook
;
421 /* Hooks to run before and after each command. */
422 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
423 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
424 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
425 /* Hook run after a command if there's no more input soon. */
426 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
428 /* Delay time in microseconds before running post-command-idle-hook. */
429 int post_command_idle_delay
;
431 /* List of deferred actions to be performed at a later time.
432 The precise format isn't relevant here; we just check whether it is nil. */
433 Lisp_Object Vdeferred_action_list
;
435 /* Function to call to handle deferred actions, when there are any. */
436 Lisp_Object Vdeferred_action_function
;
437 Lisp_Object Qdeferred_action_function
;
439 Lisp_Object Qinput_method_exit_on_first_char
;
440 Lisp_Object Qinput_method_use_echo_area
;
442 /* File in which we write all commands we read. */
445 /* Nonzero if input is available. */
448 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
449 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
453 extern char *pending_malloc_warning
;
455 /* Circular buffer for pre-read keyboard input. */
456 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
458 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
460 The interrupt-level event handlers will never enqueue an event on a
461 frame which is not in Vframe_list, and once an event is dequeued,
462 internal_last_event_frame or the event itself points to the frame.
465 But while the event is sitting in the queue, it's completely
466 unprotected. Suppose the user types one command which will run for
467 a while and then delete a frame, and then types another event at
468 the frame that will be deleted, before the command gets around to
469 it. Suppose there are no references to this frame elsewhere in
470 Emacs, and a GC occurs before the second event is dequeued. Now we
471 have an event referring to a freed frame, which will crash Emacs
474 Similar things happen when an event on a scroll bar is enqueued; the
475 window may be deleted while the event is in the queue.
477 So, we use this vector to protect the frame_or_window field in the
478 event queue. That way, they'll be dequeued as dead frames or
479 windows, but still valid lisp objects.
481 If kbd_buffer[i].kind != no_event, then
482 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
483 == kbd_buffer[i].frame_or_window. */
484 static Lisp_Object kbd_buffer_frame_or_window
;
486 /* Pointer to next available character in kbd_buffer.
487 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
488 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
489 next available char is in kbd_buffer[0]. */
490 static struct input_event
*kbd_fetch_ptr
;
492 /* Pointer to next place to store character in kbd_buffer. This
493 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
494 character should go in kbd_buffer[0]. */
495 static struct input_event
* volatile kbd_store_ptr
;
497 /* The above pair of variables forms a "queue empty" flag. When we
498 enqueue a non-hook event, we increment kbd_store_ptr. When we
499 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
500 there is input available iff the two pointers are not equal.
502 Why not just have a flag set and cleared by the enqueuing and
503 dequeuing functions? Such a flag could be screwed up by interrupts
504 at inopportune times. */
506 /* If this flag is non-nil, we check mouse_moved to see when the
507 mouse moves, and motion events will appear in the input stream.
508 Otherwise, mouse motion is ignored. */
509 static Lisp_Object do_mouse_tracking
;
511 /* Symbols to head events. */
512 Lisp_Object Qmouse_movement
;
513 Lisp_Object Qscroll_bar_movement
;
514 Lisp_Object Qswitch_frame
;
515 Lisp_Object Qdelete_frame
;
516 Lisp_Object Qiconify_frame
;
517 Lisp_Object Qmake_frame_visible
;
518 Lisp_Object Qhelp_echo
;
520 /* Symbols to denote kinds of events. */
521 Lisp_Object Qfunction_key
;
522 Lisp_Object Qmouse_click
;
524 Lisp_Object Qmouse_wheel
;
525 Lisp_Object Qlanguage_change
;
527 Lisp_Object Qdrag_n_drop
;
528 /* Lisp_Object Qmouse_movement; - also an event header */
530 /* Properties of event headers. */
531 Lisp_Object Qevent_kind
;
532 Lisp_Object Qevent_symbol_elements
;
534 /* menu item parts */
535 Lisp_Object Qmenu_alias
;
536 Lisp_Object Qmenu_enable
;
537 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
538 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
539 extern Lisp_Object Vdefine_key_rebound_commands
;
540 extern Lisp_Object Qmenu_item
;
542 /* An event header symbol HEAD may have a property named
543 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
544 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
545 mask of modifiers applied to it. If present, this is used to help
546 speed up parse_modifiers. */
547 Lisp_Object Qevent_symbol_element_mask
;
549 /* An unmodified event header BASE may have a property named
550 Qmodifier_cache, which is an alist mapping modifier masks onto
551 modified versions of BASE. If present, this helps speed up
553 Lisp_Object Qmodifier_cache
;
555 /* Symbols to use for parts of windows. */
556 Lisp_Object Qmode_line
;
557 Lisp_Object Qvertical_line
;
558 Lisp_Object Qvertical_scroll_bar
;
559 Lisp_Object Qmenu_bar
;
561 Lisp_Object
recursive_edit_unwind (), command_loop ();
562 Lisp_Object
Fthis_command_keys ();
563 Lisp_Object Qextended_command_history
;
564 EMACS_TIME
timer_check ();
566 extern Lisp_Object Vhistory_length
;
568 extern char *x_get_keysym_name ();
570 static void record_menu_key ();
572 Lisp_Object Qpolling_period
;
574 /* List of absolute timers. Appears in order of next scheduled event. */
575 Lisp_Object Vtimer_list
;
577 /* List of idle time timers. Appears in order of next scheduled event. */
578 Lisp_Object Vtimer_idle_list
;
580 /* Incremented whenever a timer is run. */
583 extern Lisp_Object Vprint_level
, Vprint_length
;
585 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
587 EMACS_TIME
*input_available_clear_time
;
589 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
590 Default is 1 if INTERRUPT_INPUT is defined. */
593 /* Nonzero while interrupts are temporarily deferred during redisplay. */
594 int interrupts_deferred
;
596 /* Nonzero means use ^S/^Q for flow control. */
599 /* Allow m- file to inhibit use of FIONREAD. */
600 #ifdef BROKEN_FIONREAD
604 /* We are unable to use interrupts if FIONREAD is not available,
605 so flush SIGIO so we won't try. */
612 /* If we support a window system, turn on the code to poll periodically
613 to detect C-g. It isn't actually used when doing interrupt input. */
614 #ifdef HAVE_WINDOW_SYSTEM
615 #define POLL_FOR_INPUT
618 /* After a command is executed, if point is moved into a region that
619 has specific properties (e.g. composition, display), we adjust
620 point to the boundary of the region. But, if a command sets this
621 valiable to non-nil, we suppress this point adjustment. This
622 variable is set to nil before reading a command. */
623 Lisp_Object Vdisable_point_adjustment
;
625 /* If non-nil, always disable point adjustment. */
626 Lisp_Object Vglobal_disable_point_adjustment
;
629 /* Global variable declarations. */
631 /* Function for init_keyboard to call with no args (if nonzero). */
632 void (*keyboard_init_hook
) ();
634 static int read_avail_input ();
635 static void get_input_pending ();
636 static int readable_events ();
637 static Lisp_Object
read_char_x_menu_prompt ();
638 static Lisp_Object
read_char_minibuf_menu_prompt ();
639 static Lisp_Object
make_lispy_event ();
641 static Lisp_Object
make_lispy_movement ();
643 static Lisp_Object
modify_event_symbol ();
644 static Lisp_Object
make_lispy_switch_frame ();
645 static int parse_solitary_modifier ();
646 static void save_getcjmp ();
647 static void restore_getcjmp ();
648 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
650 /* Nonzero means don't try to suspend even if the operating system seems
652 static int cannot_suspend
;
654 #define min(a,b) ((a)<(b)?(a):(b))
655 #define max(a,b) ((a)>(b)?(a):(b))
657 /* Install the string STR as the beginning of the string of echoing,
658 so that it serves as a prompt for the next character.
659 Also start echoing. */
665 int len
= strlen (str
);
667 if (len
> ECHOBUFSIZE
- 4)
668 len
= ECHOBUFSIZE
- 4;
669 bcopy (str
, current_kboard
->echobuf
, len
);
670 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
671 *current_kboard
->echoptr
= '\0';
673 current_kboard
->echo_after_prompt
= len
;
678 /* Add C to the echo string, if echoing is going on.
679 C can be a character, which is printed prettily ("M-C-x" and all that
680 jazz), or a symbol, whose name is printed. */
686 extern char *push_key_description ();
688 if (current_kboard
->immediate_echo
)
690 char *ptr
= current_kboard
->echoptr
;
692 if (ptr
!= current_kboard
->echobuf
)
695 /* If someone has passed us a composite event, use its head symbol. */
700 if (ptr
- current_kboard
->echobuf
701 > ECHOBUFSIZE
- KEY_DESCRIPTION_SIZE
)
704 ptr
= push_key_description (XINT (c
), ptr
);
706 else if (SYMBOLP (c
))
708 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
709 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
712 bcopy (name
->data
, ptr
, STRING_BYTES (name
));
713 ptr
+= STRING_BYTES (name
);
716 if (current_kboard
->echoptr
== current_kboard
->echobuf
719 strcpy (ptr
, " (Type ? for further options)");
724 current_kboard
->echoptr
= ptr
;
730 /* Temporarily add a dash to the end of the echo string if it's not
731 empty, so that it serves as a mini-prompt for the very next character. */
736 if (!current_kboard
->immediate_echo
737 && current_kboard
->echoptr
== current_kboard
->echobuf
)
739 /* Do nothing if we just printed a prompt. */
740 if (current_kboard
->echo_after_prompt
741 == current_kboard
->echoptr
- current_kboard
->echobuf
)
743 /* Do nothing if not echoing at all. */
744 if (current_kboard
->echoptr
== 0)
747 /* Put a dash at the end of the buffer temporarily,
748 but make it go away when the next character is added. */
749 current_kboard
->echoptr
[0] = '-';
750 current_kboard
->echoptr
[1] = 0;
755 /* Display the current echo string, and begin echoing if not already
761 if (!current_kboard
->immediate_echo
)
764 current_kboard
->immediate_echo
= 1;
766 for (i
= 0; i
< this_command_key_count
; i
++)
769 c
= XVECTOR (this_command_keys
)->contents
[i
];
770 if (! (EVENT_HAS_PARAMETERS (c
)
771 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
778 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
779 ! NILP (current_buffer
->enable_multibyte_characters
));
782 /* Record in what buffer we echoed, and from which kboard. */
783 echo_message_buffer
= echo_area_buffer
[0];
784 echo_kboard
= current_kboard
;
786 if (waiting_for_input
&& !NILP (Vquit_flag
))
787 quit_throw_to_read_char ();
790 /* Turn off echoing, for the start of a new command. */
795 current_kboard
->immediate_echo
= 0;
796 current_kboard
->echoptr
= current_kboard
->echobuf
;
797 current_kboard
->echo_after_prompt
= -1;
798 ok_to_echo_at_next_pause
= NULL
;
800 echo_message_buffer
= Qnil
;
803 /* Return the length of the current echo string. */
808 return current_kboard
->echoptr
- current_kboard
->echobuf
;
811 /* Truncate the current echo message to its first LEN chars.
812 This and echo_char get used by read_key_sequence when the user
813 switches frames while entering a key sequence. */
819 current_kboard
->echobuf
[len
] = '\0';
820 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
821 truncate_echo_area (len
);
825 /* Functions for manipulating this_command_keys. */
827 add_command_key (key
)
830 int size
= XVECTOR (this_command_keys
)->size
;
832 /* If reset-this-command-length was called recently, obey it now.
833 See the doc string of that function for an explanation of why. */
834 if (before_command_restore_flag
)
836 this_command_key_count
= before_command_key_count_1
;
837 if (this_command_key_count
< this_single_command_key_start
)
838 this_single_command_key_start
= this_command_key_count
;
839 echo_truncate (before_command_echo_length_1
);
840 before_command_restore_flag
= 0;
843 if (this_command_key_count
>= size
)
845 Lisp_Object new_keys
;
847 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
848 bcopy (XVECTOR (this_command_keys
)->contents
,
849 XVECTOR (new_keys
)->contents
,
850 size
* sizeof (Lisp_Object
));
852 this_command_keys
= new_keys
;
855 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
861 int count
= specpdl_ptr
- specpdl
;
864 if (command_loop_level
> 0)
866 specbind (Qstandard_output
, Qt
);
867 specbind (Qstandard_input
, Qt
);
870 #ifdef HAVE_X_WINDOWS
871 /* The command loop has started a busy-cursor timer, so we have to
872 cancel it here, otherwise it will fire because the recursive edit
873 can take some time. */
874 if (display_busy_cursor_p
)
875 cancel_busy_cursor ();
878 val
= command_loop ();
880 Fsignal (Qquit
, Qnil
);
881 /* Handle throw from read_minibuf when using minibuffer
882 while it's active but we're in another window. */
884 Fsignal (Qerror
, Fcons (val
, Qnil
));
886 return unbind_to (count
, Qnil
);
889 /* When an auto-save happens, record the "time", and don't do again soon. */
894 last_auto_save
= num_nonmacro_input_events
;
897 /* Make an auto save happen as soon as possible at command level. */
900 force_auto_save_soon ()
902 last_auto_save
= - auto_save_interval
- 1;
904 record_asynch_buffer_change ();
907 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
908 "Invoke the editor command loop recursively.\n\
909 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
910 that tells this function to return.\n\
911 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
912 This function is called by the editor initialization to begin editing.")
915 int count
= specpdl_ptr
- specpdl
;
917 command_loop_level
++;
918 update_mode_lines
= 1;
920 record_unwind_protect (recursive_edit_unwind
,
922 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
926 return unbind_to (count
, Qnil
);
930 recursive_edit_unwind (buffer
)
934 Fset_buffer (buffer
);
936 command_loop_level
--;
937 update_mode_lines
= 1;
945 #if 0 /* Theory: if there's anything in Vunread_command_events,
946 it will right away be read by read_key_sequence,
947 and then if we do switch KBOARDS, it will go into the side
948 queue then. So we don't need to do anything special here -- rms. */
949 if (CONSP (Vunread_command_events
))
951 current_kboard
->kbd_queue
952 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
953 current_kboard
->kbd_queue_has_data
= 1;
955 Vunread_command_events
= Qnil
;
961 /* Switch to the single-kboard state, making current_kboard
962 the only KBOARD from which further input is accepted. */
965 single_kboard_state ()
972 /* Maintain a stack of kboards, so other parts of Emacs
973 can switch temporarily to the kboard of a given frame
974 and then revert to the previous status. */
979 struct kboard_stack
*next
;
982 static struct kboard_stack
*kboard_stack
;
985 push_frame_kboard (f
)
989 struct kboard_stack
*p
990 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
992 p
->next
= kboard_stack
;
993 p
->kboard
= current_kboard
;
996 current_kboard
= FRAME_KBOARD (f
);
1004 struct kboard_stack
*p
= kboard_stack
;
1005 current_kboard
= p
->kboard
;
1006 kboard_stack
= p
->next
;
1011 /* Handle errors that are not handled at inner levels
1012 by printing an error message and returning to the editor command loop. */
1018 Lisp_Object old_level
, old_length
;
1019 char macroerror
[50];
1021 if (!NILP (executing_macro
))
1023 if (executing_macro_iterations
== 1)
1024 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1026 sprintf (macroerror
, "After %d kbd macro iterations: ",
1027 executing_macro_iterations
);
1032 Vstandard_output
= Qt
;
1033 Vstandard_input
= Qt
;
1034 Vexecuting_macro
= Qnil
;
1035 executing_macro
= Qnil
;
1036 current_kboard
->Vprefix_arg
= Qnil
;
1037 current_kboard
->Vlast_prefix_arg
= Qnil
;
1040 /* Avoid unquittable loop if data contains a circular list. */
1041 old_level
= Vprint_level
;
1042 old_length
= Vprint_length
;
1043 XSETFASTINT (Vprint_level
, 10);
1044 XSETFASTINT (Vprint_length
, 10);
1045 cmd_error_internal (data
, macroerror
);
1046 Vprint_level
= old_level
;
1047 Vprint_length
= old_length
;
1051 Vinhibit_quit
= Qnil
;
1053 any_kboard_state ();
1056 return make_number (0);
1059 /* Take actions on handling an error. DATA is the data that describes
1062 CONTEXT is a C-string containing ASCII characters only which
1063 describes the context in which the error happened. If we need to
1064 generalize CONTEXT to allow multibyte characters, make it a Lisp
1068 cmd_error_internal (data
, context
)
1073 int kill_emacs_p
= 0;
1074 struct frame
*sf
= SELECTED_FRAME ();
1078 clear_message (1, 0);
1080 /* If the window system or terminal frame hasn't been initialized
1081 yet, or we're not interactive, it's best to dump this message out
1082 to stderr and exit. */
1083 if (!sf
->glyphs_initialized_p
1084 /* This is the case of the frame dumped with Emacs, when we're
1085 running under a window system. */
1086 || (!NILP (Vwindow_system
)
1087 && !inhibit_window_system
1088 && FRAME_TERMCAP_P (sf
))
1091 stream
= Qexternal_debugging_output
;
1102 write_string_1 (context
, -1, stream
);
1104 print_error_message (data
, stream
);
1106 /* If the window system or terminal frame hasn't been initialized
1107 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1111 Fkill_emacs (make_number (-1));
1115 Lisp_Object
command_loop_1 ();
1116 Lisp_Object
command_loop_2 ();
1117 Lisp_Object
top_level_1 ();
1119 /* Entry to editor-command-loop.
1120 This level has the catches for exiting/returning to editor command loop.
1121 It returns nil to exit recursive edit, t to abort it. */
1126 if (command_loop_level
> 0 || minibuf_level
> 0)
1129 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1130 executing_macro
= Qnil
;
1136 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1137 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1138 executing_macro
= Qnil
;
1140 /* End of file in -batch run causes exit here. */
1146 /* Here we catch errors in execution of commands within the
1147 editing loop, and reenter the editing loop.
1148 When there is an error, cmd_error runs and returns a non-nil
1149 value to us. A value of nil means that cmd_loop_1 itself
1150 returned due to end of file (or end of kbd macro). */
1155 register Lisp_Object val
;
1158 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1159 while (!NILP (val
));
1167 return Feval (Vtop_level
);
1173 /* On entry to the outer level, run the startup file */
1174 if (!NILP (Vtop_level
))
1175 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1176 else if (!NILP (Vpurify_flag
))
1177 message ("Bare impure Emacs (standard Lisp code not loaded)");
1179 message ("Bare Emacs (standard Lisp code not loaded)");
1183 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1184 "Exit all recursive editing levels.")
1187 #ifdef HAVE_X_WINDOWS
1188 if (display_busy_cursor_p
)
1189 cancel_busy_cursor ();
1191 Fthrow (Qtop_level
, Qnil
);
1194 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1195 "Exit from the innermost recursive edit or minibuffer.")
1198 if (command_loop_level
> 0 || minibuf_level
> 0)
1199 Fthrow (Qexit
, Qnil
);
1201 error ("No recursive edit is in progress");
1204 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1205 "Abort the command that requested this recursive edit or minibuffer input.")
1208 if (command_loop_level
> 0 || minibuf_level
> 0)
1211 error ("No recursive edit is in progress");
1214 /* This is the actual command reading loop,
1215 sans error-handling encapsulation. */
1217 Lisp_Object
Fcommand_execute ();
1218 static int read_key_sequence ();
1219 void safe_run_hooks ();
1220 static void adjust_point_for_property ();
1228 Lisp_Object keybuf
[30];
1232 struct buffer
*prev_buffer
;
1234 int was_locked
= single_kboard
;
1237 current_kboard
->Vprefix_arg
= Qnil
;
1238 current_kboard
->Vlast_prefix_arg
= Qnil
;
1239 Vdeactivate_mark
= Qnil
;
1240 waiting_for_input
= 0;
1244 this_command_key_count
= 0;
1245 this_single_command_key_start
= 0;
1247 /* Make sure this hook runs after commands that get errors and
1248 throw to top level. */
1249 /* Note that the value cell will never directly contain nil
1250 if the symbol is a local variable. */
1251 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1252 safe_run_hooks (Qpost_command_hook
);
1254 /* If displaying a message, resize the echo area window to fit
1255 that message's size exactly. */
1256 if (!NILP (echo_area_buffer
[0]))
1257 resize_echo_area_axactly ();
1259 if (!NILP (Vdeferred_action_list
))
1260 call0 (Vdeferred_action_function
);
1262 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1264 if (NILP (Vunread_command_events
)
1265 && NILP (Vunread_input_method_events
)
1266 && NILP (Vunread_post_input_method_events
)
1267 && NILP (Vexecuting_macro
)
1268 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1269 safe_run_hooks (Qpost_command_idle_hook
);
1272 /* Do this after running Vpost_command_hook, for consistency. */
1273 current_kboard
->Vlast_command
= Vthis_command
;
1274 current_kboard
->Vreal_last_command
= real_this_command
;
1278 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1281 /* Make sure the current window's buffer is selected. */
1282 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1283 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1285 /* Display any malloc warning that just came out. Use while because
1286 displaying one warning can cause another. */
1288 while (pending_malloc_warning
)
1289 display_malloc_warning ();
1293 Vdeactivate_mark
= Qnil
;
1295 /* If minibuffer on and echo area in use,
1296 wait 2 sec and redraw minibuffer. */
1299 && !NILP (echo_area_buffer
[0])
1300 && EQ (minibuf_window
, echo_area_window
))
1302 /* Bind inhibit-quit to t so that C-g gets read in
1303 rather than quitting back to the minibuffer. */
1304 int count
= specpdl_ptr
- specpdl
;
1305 specbind (Qinhibit_quit
, Qt
);
1307 Fsit_for (make_number (2), Qnil
, Qnil
);
1308 /* Clear the echo area. */
1310 safe_run_hooks (Qecho_area_clear_hook
);
1312 unbind_to (count
, Qnil
);
1314 /* If a C-g came in before, treat it as input now. */
1315 if (!NILP (Vquit_flag
))
1318 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1323 alloca (0); /* Cause a garbage collection now */
1324 /* Since we can free the most stuff here. */
1325 #endif /* C_ALLOCA */
1328 /* Select the frame that the last event came from. Usually,
1329 switch-frame events will take care of this, but if some lisp
1330 code swallows a switch-frame event, we'll fix things up here.
1331 Is this a good idea? */
1332 if (FRAMEP (internal_last_event_frame
)
1333 && !EQ (internal_last_event_frame
, selected_frame
))
1334 Fselect_frame (internal_last_event_frame
, Qnil
);
1336 /* If it has changed current-menubar from previous value,
1337 really recompute the menubar from the value. */
1338 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1339 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1340 call0 (Qrecompute_lucid_menubar
);
1342 before_command_key_count
= this_command_key_count
;
1343 before_command_echo_length
= echo_length ();
1345 Vthis_command
= Qnil
;
1346 real_this_command
= Qnil
;
1348 /* Read next key sequence; i gets its length. */
1349 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1352 /* A filter may have run while we were reading the input. */
1353 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1355 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1356 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1360 /* Now we have read a key sequence of length I,
1361 or else I is 0 and we found end of file. */
1363 if (i
== 0) /* End of file -- happens only in */
1364 return Qnil
; /* a kbd macro, at the end. */
1365 /* -1 means read_key_sequence got a menu that was rejected.
1366 Just loop around and read another command. */
1370 this_command_key_count
= 0;
1371 this_single_command_key_start
= 0;
1375 last_command_char
= keybuf
[i
- 1];
1377 /* If the previous command tried to force a specific window-start,
1378 forget about that, in case this command moves point far away
1379 from that position. But also throw away beg_unchanged and
1380 end_unchanged information in that case, so that redisplay will
1381 update the whole window properly. */
1382 if (!NILP (XWINDOW (selected_window
)->force_start
))
1385 XWINDOW (selected_window
)->force_start
= Qnil
;
1386 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1387 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1390 cmd
= read_key_sequence_cmd
;
1391 if (!NILP (Vexecuting_macro
))
1393 if (!NILP (Vquit_flag
))
1395 Vexecuting_macro
= Qt
;
1396 QUIT
; /* Make some noise. */
1397 /* Will return since macro now empty. */
1401 /* Do redisplay processing after this command except in special
1402 cases identified below. */
1403 prev_buffer
= current_buffer
;
1404 prev_modiff
= MODIFF
;
1405 last_point_position
= PT
;
1406 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1408 /* By default, we adjust point to a boundary of a region that
1409 has such a property that should be treated intangible
1410 (e.g. composition, display). But, some commands will set
1411 this variable differently. */
1412 Vdisable_point_adjustment
= Qnil
;
1414 /* Execute the command. */
1416 Vthis_command
= cmd
;
1417 real_this_command
= cmd
;
1418 /* Note that the value cell will never directly contain nil
1419 if the symbol is a local variable. */
1420 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1421 safe_run_hooks (Qpre_command_hook
);
1423 if (NILP (Vthis_command
))
1425 /* nil means key is undefined. */
1427 current_kboard
->defining_kbd_macro
= Qnil
;
1428 update_mode_lines
= 1;
1429 current_kboard
->Vprefix_arg
= Qnil
;
1433 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1435 /* In case we jump to directly_done. */
1436 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1438 /* Recognize some common commands in common situations and
1439 do them directly. */
1440 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1442 struct Lisp_Char_Table
*dp
1443 = window_display_table (XWINDOW (selected_window
));
1444 lose
= FETCH_CHAR (PT_BYTE
);
1447 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1448 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1449 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1450 && (lose
>= 0x20 && lose
< 0x7f)))
1451 : (lose
>= 0x20 && lose
< 0x7f))
1452 /* To extract the case of continuation on
1453 wide-column characters. */
1454 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1455 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1457 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1459 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1461 && !windows_or_buffers_changed
1462 && EQ (current_buffer
->selective_display
, Qnil
)
1463 && !detect_input_pending ()
1464 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1465 && NILP (Vexecuting_macro
))
1466 direct_output_forward_char (1);
1469 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1471 struct Lisp_Char_Table
*dp
1472 = window_display_table (XWINDOW (selected_window
));
1474 lose
= FETCH_CHAR (PT_BYTE
);
1476 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1477 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1478 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1479 && (lose
>= 0x20 && lose
< 0x7f)))
1480 : (lose
>= 0x20 && lose
< 0x7f))
1481 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1483 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1485 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1487 && !windows_or_buffers_changed
1488 && EQ (current_buffer
->selective_display
, Qnil
)
1489 && !detect_input_pending ()
1490 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1491 && NILP (Vexecuting_macro
))
1492 direct_output_forward_char (-1);
1495 else if (EQ (Vthis_command
, Qself_insert_command
)
1496 /* Try this optimization only on ascii keystrokes. */
1497 && INTEGERP (last_command_char
))
1499 unsigned int c
= XINT (last_command_char
);
1501 if (NILP (Vexecuting_macro
)
1502 && !EQ (minibuf_window
, selected_window
))
1504 if (!nonundocount
|| nonundocount
>= 20)
1512 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1514 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1516 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1518 || MODIFF
<= SAVE_MODIFF
1519 || windows_or_buffers_changed
1520 || !EQ (current_buffer
->selective_display
, Qnil
)
1521 || detect_input_pending ()
1522 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1523 || !NILP (Vexecuting_macro
));
1525 value
= internal_self_insert (c
, 0);
1530 /* VALUE == 1 when AFTER-CHANGE functions are
1531 installed which is the case most of the time
1532 because FONT-LOCK installs one. */
1533 if (!lose
&& !value
)
1534 direct_output_for_insert (c
);
1539 /* Here for a command that isn't executed directly */
1541 #ifdef HAVE_X_WINDOWS
1542 if (display_busy_cursor_p
)
1543 start_busy_cursor ();
1547 if (NILP (current_kboard
->Vprefix_arg
))
1549 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1551 #ifdef HAVE_X_WINDOWS
1552 if (display_busy_cursor_p
)
1553 cancel_busy_cursor ();
1557 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1559 /* Note that the value cell will never directly contain nil
1560 if the symbol is a local variable. */
1561 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1562 safe_run_hooks (Qpost_command_hook
);
1564 /* If displaying a message, resize the echo area window to fit
1565 that message's size exactly. */
1566 if (!NILP (echo_area_buffer
[0]))
1567 resize_echo_area_axactly ();
1569 if (!NILP (Vdeferred_action_list
))
1570 safe_run_hooks (Qdeferred_action_function
);
1572 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1574 if (NILP (Vunread_command_events
)
1575 && NILP (Vunread_input_method_events
)
1576 && NILP (Vunread_post_input_method_events
)
1577 && NILP (Vexecuting_macro
)
1578 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1579 safe_run_hooks (Qpost_command_idle_hook
);
1582 /* If there is a prefix argument,
1583 1) We don't want Vlast_command to be ``universal-argument''
1584 (that would be dumb), so don't set Vlast_command,
1585 2) we want to leave echoing on so that the prefix will be
1586 echoed as part of this key sequence, so don't call
1588 3) we want to leave this_command_key_count non-zero, so that
1589 read_char will realize that it is re-reading a character, and
1590 not echo it a second time.
1592 If the command didn't actually create a prefix arg,
1593 but is merely a frame event that is transparent to prefix args,
1594 then the above doesn't apply. */
1595 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1597 current_kboard
->Vlast_command
= Vthis_command
;
1598 current_kboard
->Vreal_last_command
= real_this_command
;
1600 this_command_key_count
= 0;
1601 this_single_command_key_start
= 0;
1604 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1606 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1608 current_buffer
->mark_active
= Qnil
;
1609 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1611 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1612 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1617 if (current_buffer
== prev_buffer
1618 && last_point_position
!= PT
1619 && NILP (Vdisable_point_adjustment
)
1620 && NILP (Vglobal_disable_point_adjustment
))
1621 adjust_point_for_property (last_point_position
);
1623 /* Install chars successfully executed in kbd macro. */
1625 if (!NILP (current_kboard
->defining_kbd_macro
)
1626 && NILP (current_kboard
->Vprefix_arg
))
1627 finalize_kbd_macro_chars ();
1631 any_kboard_state ();
1636 extern Lisp_Object Qcomposition
, Qdisplay
;
1638 /* Adjust point to a boundary of a region that has such a property
1639 that should be treated intangible. For the moment, we check
1640 `composition' and `display' property. LAST_PT is the last position
1644 adjust_point_for_property (last_pt
)
1649 int check_composition
= 1, check_display
= 1;
1651 while (check_composition
|| check_display
)
1653 if (check_composition
1654 && PT
> BEGV
&& PT
< ZV
1655 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1656 && COMPOSITION_VALID_P (start
, end
, val
)
1657 && start
< PT
&& end
> PT
1658 && (last_pt
<= start
|| last_pt
>= end
))
1666 check_composition
= 0;
1668 && PT
> BEGV
&& PT
< ZV
1669 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1670 && display_prop_intangible_p (val
)
1671 && start
< PT
&& end
> PT
1672 && (last_pt
<= start
|| last_pt
>= end
))
1678 check_composition
= 1;
1684 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1687 safe_run_hooks_1 (hook
)
1690 return call1 (Vrun_hooks
, Vinhibit_quit
);
1693 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1696 safe_run_hooks_error (data
)
1699 return Fset (Vinhibit_quit
, Qnil
);
1702 /* If we get an error while running the hook, cause the hook variable
1703 to be nil. Also inhibit quits, so that C-g won't cause the hook
1704 to mysteriously evaporate. */
1707 safe_run_hooks (hook
)
1710 int count
= specpdl_ptr
- specpdl
;
1711 specbind (Qinhibit_quit
, hook
);
1713 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1715 unbind_to (count
, Qnil
);
1719 /* Number of seconds between polling for input. This is a Lisp
1720 variable that can be bound. */
1724 /* Nonzero means polling for input is temporarily suppressed. */
1726 int poll_suppress_count
;
1728 /* Asynchronous timer for polling. */
1730 struct atimer
*poll_timer
;
1733 #ifdef POLL_FOR_INPUT
1735 /* Poll for input, so what we catch a C-g if it comes in. This
1736 function is called from x_make_frame_visible, see comment
1742 if (interrupt_input_blocked
== 0
1743 && !waiting_for_input
)
1744 read_avail_input (0);
1747 /* Timer callback function for poll_timer. TIMER is equal to
1751 poll_for_input (timer
)
1752 struct atimer
*timer
;
1754 if (poll_suppress_count
== 0)
1755 poll_for_input_1 ();
1758 #endif /* POLL_FOR_INPUT */
1760 /* Begin signals to poll for input, if they are appropriate.
1761 This function is called unconditionally from various places. */
1766 #ifdef POLL_FOR_INPUT
1767 if (read_socket_hook
&& !interrupt_input
)
1769 /* Turn alarm handling on unconditionally. It might have
1770 been turned off in process.c. */
1771 turn_on_atimers (1);
1773 /* If poll timer doesn't exist, are we need one with
1774 a different interval, start a new one. */
1775 if (poll_timer
== NULL
1776 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1778 EMACS_TIME interval
;
1781 cancel_atimer (poll_timer
);
1783 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1784 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1785 poll_for_input
, NULL
);
1788 /* Let the timer's callback function poll for input
1789 if this becomes zero. */
1790 --poll_suppress_count
;
1795 /* Nonzero if we are using polling to handle input asynchronously. */
1798 input_polling_used ()
1800 #ifdef POLL_FOR_INPUT
1801 return read_socket_hook
&& !interrupt_input
;
1807 /* Turn off polling. */
1812 #ifdef POLL_FOR_INPUT
1813 if (read_socket_hook
&& !interrupt_input
)
1814 ++poll_suppress_count
;
1818 /* Set the value of poll_suppress_count to COUNT
1819 and start or stop polling accordingly. */
1822 set_poll_suppress_count (count
)
1825 #ifdef POLL_FOR_INPUT
1826 if (count
== 0 && poll_suppress_count
!= 0)
1828 poll_suppress_count
= 1;
1831 else if (count
!= 0 && poll_suppress_count
== 0)
1835 poll_suppress_count
= count
;
1839 /* Bind polling_period to a value at least N.
1840 But don't decrease it. */
1843 bind_polling_period (n
)
1846 #ifdef POLL_FOR_INPUT
1847 int new = polling_period
;
1852 stop_other_atimers (poll_timer
);
1854 specbind (Qpolling_period
, make_number (new));
1855 /* Start a new alarm with the new period. */
1860 /* Apply the control modifier to CHARACTER. */
1866 /* Save the upper bits here. */
1867 int upper
= c
& ~0177;
1871 /* Everything in the columns containing the upper-case letters
1872 denotes a control character. */
1873 if (c
>= 0100 && c
< 0140)
1877 /* Set the shift modifier for a control char
1878 made from a shifted letter. But only for letters! */
1879 if (oc
>= 'A' && oc
<= 'Z')
1880 c
|= shift_modifier
;
1883 /* The lower-case letters denote control characters too. */
1884 else if (c
>= 'a' && c
<= 'z')
1887 /* Include the bits for control and shift
1888 only if the basic ASCII code can't indicate them. */
1892 /* Replace the high bits. */
1893 c
|= (upper
& ~ctrl_modifier
);
1900 /* Input of single characters from keyboard */
1902 Lisp_Object
print_help ();
1903 static Lisp_Object
kbd_buffer_get_event ();
1904 static void record_char ();
1907 static jmp_buf wrong_kboard_jmpbuf
;
1910 /* read a character from the keyboard; call the redisplay if needed */
1911 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1912 -1 means do not do redisplay, but do do autosaving.
1915 /* The arguments MAPS and NMAPS are for menu prompting.
1916 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1918 PREV_EVENT is the previous input event, or nil if we are reading
1919 the first event of a key sequence (or not reading a key sequence).
1920 If PREV_EVENT is t, that is a "magic" value that says
1921 not to run input methods, but in other respects to act as if
1922 not reading a key sequence.
1924 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1925 if we used a mouse menu to read the input, or zero otherwise. If
1926 USED_MOUSE_MENU is null, we don't dereference it.
1928 Value is t if we showed a menu and the user rejected it. */
1931 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1935 Lisp_Object prev_event
;
1936 int *used_mouse_menu
;
1940 jmp_buf local_getcjmp
;
1942 int key_already_recorded
= 0;
1943 Lisp_Object tem
, save
;
1944 Lisp_Object previous_echo_area_message
;
1945 Lisp_Object also_record
;
1947 struct gcpro gcpro1
, gcpro2
;
1951 before_command_key_count
= this_command_key_count
;
1952 before_command_echo_length
= echo_length ();
1954 previous_echo_area_message
= Qnil
;
1956 GCPRO2 (c
, previous_echo_area_message
);
1961 if (CONSP (Vunread_post_input_method_events
))
1963 c
= XCAR (Vunread_post_input_method_events
);
1964 Vunread_post_input_method_events
1965 = XCDR (Vunread_post_input_method_events
);
1967 /* Undo what read_char_x_menu_prompt did when it unread
1968 additional keys returned by Fx_popup_menu. */
1970 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
1978 if (unread_command_char
!= -1)
1980 XSETINT (c
, unread_command_char
);
1981 unread_command_char
= -1;
1987 if (CONSP (Vunread_command_events
))
1989 c
= XCAR (Vunread_command_events
);
1990 Vunread_command_events
= XCDR (Vunread_command_events
);
1992 /* Undo what read_char_x_menu_prompt did when it unread
1993 additional keys returned by Fx_popup_menu. */
1995 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2000 goto reread_for_input_method
;
2003 if (CONSP (Vunread_input_method_events
))
2005 c
= XCAR (Vunread_input_method_events
);
2006 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2008 /* Undo what read_char_x_menu_prompt did when it unread
2009 additional keys returned by Fx_popup_menu. */
2011 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2015 goto reread_for_input_method
;
2018 /* If there is no function key translated before
2019 reset-this-command-lengths takes effect, forget about it. */
2020 before_command_restore_flag
= 0;
2022 if (!NILP (Vexecuting_macro
))
2024 /* We set this to Qmacro; since that's not a frame, nobody will
2025 try to switch frames on us, and the selected window will
2028 Since this event came from a macro, it would be misleading to
2029 leave internal_last_event_frame set to wherever the last
2030 real event came from. Normally, a switch-frame event selects
2031 internal_last_event_frame after each command is read, but
2032 events read from a macro should never cause a new frame to be
2034 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2036 /* Exit the macro if we are at the end.
2037 Also, some things replace the macro with t
2038 to force an early exit. */
2039 if (EQ (Vexecuting_macro
, Qt
)
2040 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2046 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2047 if (STRINGP (Vexecuting_macro
)
2048 && (XINT (c
) & 0x80))
2049 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2051 executing_macro_index
++;
2056 if (!NILP (unread_switch_frame
))
2058 c
= unread_switch_frame
;
2059 unread_switch_frame
= Qnil
;
2061 /* This event should make it into this_command_keys, and get echoed
2062 again, so we do not set `reread'. */
2066 /* if redisplay was requested */
2067 if (commandflag
>= 0)
2069 /* If there is pending input, process any events which are not
2070 user-visible, such as X selection_request events. */
2072 || detect_input_pending_run_timers (0))
2073 swallow_events (0); /* may clear input_pending */
2075 /* Redisplay if no pending input. */
2076 while (!input_pending
)
2081 /* Normal case: no input arrived during redisplay. */
2084 /* Input arrived and pre-empted redisplay.
2085 Process any events which are not user-visible. */
2087 /* If that cleared input_pending, try again to redisplay. */
2091 /* Message turns off echoing unless more keystrokes turn it on again.
2093 The code in 20.x for the condition was
2095 1. echo_area_glyphs && *echo_area_glyphs
2096 2. && echo_area_glyphs != current_kboard->echobuf
2097 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2099 (1) means there's a current message displayed
2101 (2) means it's not the message from echoing from the current
2104 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2105 is set to a non-null value. This is done in read_char and it is
2106 set to echo_area_glyphs after a call to echo_char. That means
2107 ok_to_echo_at_next_pause is either null or
2108 current_kboard->echobuf with the appropriate current_kboard at
2111 So, condition (3) means in clear text ok_to_echo_at_next_pause
2112 must be either null, or the current message isn't from echoing at
2113 all, or it's from echoing from a different kboard than the
2116 if (/* There currently something in the echo area */
2117 !NILP (echo_area_buffer
[0])
2118 && (/* And it's either not from echoing. */
2119 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2120 /* Or it's an echo from a different kboard. */
2121 || echo_kboard
!= current_kboard
2122 /* Or we explicitly allow overwriting whatever there is. */
2123 || ok_to_echo_at_next_pause
== NULL
))
2128 /* Try reading a character via menu prompting in the minibuf.
2129 Try this before the sit-for, because the sit-for
2130 would do the wrong thing if we are supposed to do
2131 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2132 after a mouse event so don't try a minibuf menu. */
2134 if (nmaps
> 0 && INTERACTIVE
2135 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2136 /* Don't bring up a menu if we already have another event. */
2137 && NILP (Vunread_command_events
)
2138 && unread_command_char
< 0
2139 && !detect_input_pending_run_timers (0))
2141 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2144 key_already_recorded
= 1;
2149 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2150 We will do that below, temporarily for short sections of code,
2151 when appropriate. local_getcjmp must be in effect
2152 around any call to sit_for or kbd_buffer_get_event;
2153 it *must not* be in effect when we call redisplay. */
2155 if (_setjmp (local_getcjmp
))
2157 XSETINT (c
, quit_char
);
2158 internal_last_event_frame
= selected_frame
;
2159 Vlast_event_frame
= internal_last_event_frame
;
2160 /* If we report the quit char as an event,
2161 don't do so more than once. */
2162 if (!NILP (Vinhibit_quit
))
2167 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2168 if (kb
!= current_kboard
)
2170 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2171 /* We shouldn't get here if we were in single-kboard mode! */
2174 while (CONSP (*tailp
))
2175 tailp
= &XCDR (*tailp
);
2178 *tailp
= Fcons (c
, Qnil
);
2179 kb
->kbd_queue_has_data
= 1;
2180 current_kboard
= kb
;
2181 /* This is going to exit from read_char
2182 so we had better get rid of this frame's stuff. */
2184 longjmp (wrong_kboard_jmpbuf
, 1);
2191 timer_start_idle ();
2193 /* If in middle of key sequence and minibuffer not active,
2194 start echoing if enough time elapses. */
2196 if (minibuf_level
== 0
2197 && !current_kboard
->immediate_echo
2198 && this_command_key_count
> 0
2200 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2201 && NILP (Fzerop (Vecho_keystrokes
))
2202 && (/* No message. */
2203 NILP (echo_area_buffer
[0])
2204 /* Or empty message. */
2205 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2206 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2207 /* Or already echoing from same kboard. */
2208 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2209 /* Or not echoing before and echoing allowed. */
2210 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2214 /* After a mouse event, start echoing right away.
2215 This is because we are probably about to display a menu,
2216 and we don't want to delay before doing so. */
2217 if (EVENT_HAS_PARAMETERS (prev_event
))
2222 double duration
= extract_float (Vecho_keystrokes
);
2223 sec
= (int) duration
;
2224 usec
= (duration
- sec
) * 1000000;
2225 save_getcjmp (save_jump
);
2226 restore_getcjmp (local_getcjmp
);
2227 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2228 restore_getcjmp (save_jump
);
2230 && ! CONSP (Vunread_command_events
))
2235 /* Maybe auto save due to number of keystrokes. */
2237 if (commandflag
!= 0
2238 && auto_save_interval
> 0
2239 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2240 && !detect_input_pending_run_timers (0))
2242 Fdo_auto_save (Qnil
, Qnil
);
2243 /* Hooks can actually change some buffers in auto save. */
2247 /* Try reading using an X menu.
2248 This is never confused with reading using the minibuf
2249 because the recursive call of read_char in read_char_minibuf_menu_prompt
2250 does not pass on any keymaps. */
2252 if (nmaps
> 0 && INTERACTIVE
2253 && !NILP (prev_event
)
2254 && EVENT_HAS_PARAMETERS (prev_event
)
2255 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2256 && !EQ (XCAR (prev_event
), Qtool_bar
)
2257 /* Don't bring up a menu if we already have another event. */
2258 && NILP (Vunread_command_events
)
2259 && unread_command_char
< 0)
2261 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2263 /* Now that we have read an event, Emacs is not idle. */
2269 /* Maybe autosave and/or garbage collect due to idleness. */
2271 if (INTERACTIVE
&& NILP (c
))
2273 int delay_level
, buffer_size
;
2275 /* Slow down auto saves logarithmically in size of current buffer,
2276 and garbage collect while we're at it. */
2277 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2278 last_non_minibuf_size
= Z
- BEG
;
2279 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2281 while (buffer_size
> 64)
2282 delay_level
++, buffer_size
-= buffer_size
>> 2;
2283 if (delay_level
< 4) delay_level
= 4;
2284 /* delay_level is 4 for files under around 50k, 7 at 100k,
2285 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2287 /* Auto save if enough time goes by without input. */
2288 if (commandflag
!= 0
2289 && num_nonmacro_input_events
> last_auto_save
2290 && INTEGERP (Vauto_save_timeout
)
2291 && XINT (Vauto_save_timeout
) > 0)
2295 save_getcjmp (save_jump
);
2296 restore_getcjmp (local_getcjmp
);
2297 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2299 restore_getcjmp (save_jump
);
2302 && ! CONSP (Vunread_command_events
))
2304 Fdo_auto_save (Qnil
, Qnil
);
2306 /* If we have auto-saved and there is still no input
2307 available, garbage collect if there has been enough
2308 consing going on to make it worthwhile. */
2309 if (!detect_input_pending_run_timers (0)
2310 && consing_since_gc
> gc_cons_threshold
/ 2)
2311 Fgarbage_collect ();
2318 /* If this has become non-nil here, it has been set by a timer
2319 or sentinel or filter. */
2320 if (CONSP (Vunread_command_events
))
2322 c
= XCAR (Vunread_command_events
);
2323 Vunread_command_events
= XCDR (Vunread_command_events
);
2326 /* Read something from current KBOARD's side queue, if possible. */
2330 if (current_kboard
->kbd_queue_has_data
)
2332 if (!CONSP (current_kboard
->kbd_queue
))
2334 c
= XCAR (current_kboard
->kbd_queue
);
2335 current_kboard
->kbd_queue
2336 = XCDR (current_kboard
->kbd_queue
);
2337 if (NILP (current_kboard
->kbd_queue
))
2338 current_kboard
->kbd_queue_has_data
= 0;
2339 input_pending
= readable_events (0);
2340 if (EVENT_HAS_PARAMETERS (c
)
2341 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2342 internal_last_event_frame
= XCAR (XCDR (c
));
2343 Vlast_event_frame
= internal_last_event_frame
;
2348 /* If current_kboard's side queue is empty check the other kboards.
2349 If one of them has data that we have not yet seen here,
2350 switch to it and process the data waiting for it.
2352 Note: if the events queued up for another kboard
2353 have already been seen here, and therefore are not a complete command,
2354 the kbd_queue_has_data field is 0, so we skip that kboard here.
2355 That's to avoid an infinite loop switching between kboards here. */
2356 if (NILP (c
) && !single_kboard
)
2359 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2360 if (kb
->kbd_queue_has_data
)
2362 current_kboard
= kb
;
2363 /* This is going to exit from read_char
2364 so we had better get rid of this frame's stuff. */
2366 longjmp (wrong_kboard_jmpbuf
, 1);
2375 /* Finally, we read from the main queue,
2376 and if that gives us something we can't use yet, we put it on the
2377 appropriate side queue and try again. */
2383 /* Actually read a character, waiting if necessary. */
2384 save_getcjmp (save_jump
);
2385 restore_getcjmp (local_getcjmp
);
2386 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2387 restore_getcjmp (save_jump
);
2390 if (! NILP (c
) && (kb
!= current_kboard
))
2392 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2393 while (CONSP (*tailp
))
2394 tailp
= &XCDR (*tailp
);
2397 *tailp
= Fcons (c
, Qnil
);
2398 kb
->kbd_queue_has_data
= 1;
2402 current_kboard
= kb
;
2403 /* This is going to exit from read_char
2404 so we had better get rid of this frame's stuff. */
2406 longjmp (wrong_kboard_jmpbuf
, 1);
2411 /* Terminate Emacs in batch mode if at eof. */
2412 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2413 Fkill_emacs (make_number (1));
2417 /* Add in any extra modifiers, where appropriate. */
2418 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2419 || ((extra_keyboard_modifiers
& 0177) < ' '
2420 && (extra_keyboard_modifiers
& 0177) != 0))
2421 XSETINT (c
, make_ctrl_char (XINT (c
)));
2423 /* Transfer any other modifier bits directly from
2424 extra_keyboard_modifiers to c. Ignore the actual character code
2425 in the low 16 bits of extra_keyboard_modifiers. */
2426 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2437 if (commandflag
>= 0
2438 && !input_pending
&& !detect_input_pending_run_timers (0))
2446 /* Buffer switch events are only for internal wakeups
2447 so don't show them to the user.
2448 Also, don't record a key if we already did. */
2449 if (BUFFERP (c
) || key_already_recorded
)
2452 /* Process special events within read_char
2453 and loop around to read another event. */
2456 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2462 int was_locked
= single_kboard
;
2464 last_input_char
= c
;
2465 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2467 /* Resume allowing input from any kboard, if that was true before. */
2469 any_kboard_state ();
2474 /* Handle things that only apply to characters. */
2477 /* If kbd_buffer_get_event gave us an EOF, return that. */
2481 if ((STRINGP (Vkeyboard_translate_table
)
2482 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2483 || (VECTORP (Vkeyboard_translate_table
)
2484 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2485 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2486 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2489 d
= Faref (Vkeyboard_translate_table
, c
);
2490 /* nil in keyboard-translate-table means no translation. */
2496 /* If this event is a mouse click in the menu bar,
2497 return just menu-bar for now. Modify the mouse click event
2498 so we won't do this twice, then queue it up. */
2499 if (EVENT_HAS_PARAMETERS (c
)
2501 && CONSP (EVENT_START (c
))
2502 && CONSP (XCDR (EVENT_START (c
))))
2506 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2507 /* Handle menu-bar events:
2508 insert the dummy prefix event `menu-bar'. */
2509 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2511 /* Change menu-bar to (menu-bar) as the event "position". */
2512 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2515 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2520 /* Store these characters into recent_keys, the dribble file if any,
2521 and the keyboard macro being defined, if any. */
2523 if (! NILP (also_record
))
2524 record_char (also_record
);
2526 /* Wipe the echo area.
2527 But first, if we are about to use an input method,
2528 save the echo area contents for it to refer to. */
2530 && ! NILP (Vinput_method_function
)
2531 && (unsigned) XINT (c
) >= ' '
2532 && (unsigned) XINT (c
) != 127
2533 && (unsigned) XINT (c
) < 256)
2535 previous_echo_area_message
= Fcurrent_message ();
2536 Vinput_method_previous_message
= previous_echo_area_message
;
2539 /* Now wipe the echo area, except for help events which do their
2540 own stuff with the echo area. */
2541 if (!CONSP (c
) || !(EQ (Qhelp_echo
, XCAR (c
))))
2543 if (!NILP (echo_area_buffer
[0]))
2544 safe_run_hooks (Qecho_area_clear_hook
);
2545 clear_message (1, 0);
2548 reread_for_input_method
:
2550 /* Pass this to the input method, if appropriate. */
2552 && ! NILP (Vinput_method_function
)
2553 /* Don't run the input method within a key sequence,
2554 after the first event of the key sequence. */
2555 && NILP (prev_event
)
2556 && (unsigned) XINT (c
) >= ' '
2557 && (unsigned) XINT (c
) != 127
2558 && (unsigned) XINT (c
) < 256)
2562 struct gcpro gcpro1
;
2563 int count
= specpdl_ptr
- specpdl
;
2565 /* Save the echo status. */
2566 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2567 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2568 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2570 if (before_command_restore_flag
)
2572 this_command_key_count
= before_command_key_count_1
;
2573 if (this_command_key_count
< this_single_command_key_start
)
2574 this_single_command_key_start
= this_command_key_count
;
2575 echo_truncate (before_command_echo_length_1
);
2576 before_command_restore_flag
= 0;
2579 /* Save the this_command_keys status. */
2580 key_count
= this_command_key_count
;
2583 keys
= Fcopy_sequence (this_command_keys
);
2588 /* Clear out this_command_keys. */
2589 this_command_key_count
= 0;
2591 /* Now wipe the echo area. */
2592 if (!NILP (echo_area_buffer
[0]))
2593 safe_run_hooks (Qecho_area_clear_hook
);
2594 clear_message (1, 0);
2597 /* If we are not reading a key sequence,
2598 never use the echo area. */
2601 specbind (Qinput_method_use_echo_area
, Qt
);
2604 /* Call the input method. */
2605 tem
= call1 (Vinput_method_function
, c
);
2607 tem
= unbind_to (count
, tem
);
2609 /* Restore the saved echoing state
2610 and this_command_keys state. */
2611 this_command_key_count
= key_count
;
2613 this_command_keys
= keys
;
2616 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2617 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2618 if (saved_immediate_echo
)
2623 /* The input method can return no events. */
2626 /* Bring back the previous message, if any. */
2627 if (! NILP (previous_echo_area_message
))
2628 message_with_string ("%s", previous_echo_area_message
, 0);
2631 /* It returned one event or more. */
2633 Vunread_post_input_method_events
2634 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2639 /* Display help if not echoing. */
2640 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2643 int count
= specpdl_ptr
- specpdl
;
2645 specbind (Qmessage_truncate_lines
, Qt
);
2646 msg
= XCDR (XCDR (c
));
2648 if (!NILP (Vshow_help_function
))
2649 call1 (Vshow_help_function
, msg
);
2650 else if (/* Don't overwrite minibuffer contents. */
2651 !MINI_WINDOW_P (XWINDOW (selected_window
))
2652 /* Don't overwrite a keystroke echo. */
2653 && NILP (echo_message_buffer
)
2654 /* Don't overwrite a prompt. */
2655 && !cursor_in_echo_area
)
2658 message3_nolog (msg
, XSTRING (msg
)->size
, STRING_MULTIBYTE (msg
));
2663 unbind_to (count
, Qnil
);
2667 if (this_command_key_count
== 0 || ! reread
)
2669 before_command_key_count
= this_command_key_count
;
2670 before_command_echo_length
= echo_length ();
2672 /* Don't echo mouse motion events. */
2673 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2674 && NILP (Fzerop (Vecho_keystrokes
))
2675 && ! (EVENT_HAS_PARAMETERS (c
)
2676 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2679 if (! NILP (also_record
))
2680 echo_char (also_record
);
2681 /* Once we reread a character, echoing can happen
2682 the next time we pause to read a new one. */
2683 ok_to_echo_at_next_pause
= current_kboard
;
2686 /* Record this character as part of the current key. */
2687 add_command_key (c
);
2688 if (! NILP (also_record
))
2689 add_command_key (also_record
);
2692 last_input_char
= c
;
2695 /* Process the help character specially if enabled */
2696 if (!NILP (Vhelp_form
) && help_char_p (c
))
2699 count
= specpdl_ptr
- specpdl
;
2701 record_unwind_protect (Fset_window_configuration
,
2702 Fcurrent_window_configuration (Qnil
));
2704 tem0
= Feval (Vhelp_form
);
2706 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2710 c
= read_char (0, 0, 0, Qnil
, 0);
2711 while (BUFFERP (c
));
2712 /* Remove the help from the frame */
2713 unbind_to (count
, Qnil
);
2716 if (EQ (c
, make_number (040)))
2720 c
= read_char (0, 0, 0, Qnil
, 0);
2721 while (BUFFERP (c
));
2728 /* Record a key that came from a mouse menu.
2729 Record it for echoing, for this-command-keys, and so on. */
2735 /* Wipe the echo area. */
2736 clear_message (1, 0);
2740 before_command_key_count
= this_command_key_count
;
2741 before_command_echo_length
= echo_length ();
2743 /* Don't echo mouse motion events. */
2744 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2745 && NILP (Fzerop (Vecho_keystrokes
)))
2749 /* Once we reread a character, echoing can happen
2750 the next time we pause to read a new one. */
2751 ok_to_echo_at_next_pause
= 0;
2754 /* Record this character as part of the current key. */
2755 add_command_key (c
);
2757 /* Re-reading in the middle of a command */
2758 last_input_char
= c
;
2762 /* Return 1 if should recognize C as "the help character". */
2770 if (EQ (c
, Vhelp_char
))
2772 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
2773 if (EQ (c
, XCAR (tail
)))
2778 /* Record the input event C in various ways. */
2785 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2786 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2787 recent_keys_index
= 0;
2789 /* Write c to the dribble file. If c is a lispy event, write
2790 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2791 If you, dear reader, have a better idea, you've got the source. :-) */
2796 if (XUINT (c
) < 0x100)
2797 putc (XINT (c
), dribble
);
2799 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2803 Lisp_Object dribblee
;
2805 /* If it's a structured event, take the event header. */
2806 dribblee
= EVENT_HEAD (c
);
2808 if (SYMBOLP (dribblee
))
2810 putc ('<', dribble
);
2811 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2812 STRING_BYTES (XSYMBOL (dribblee
)->name
),
2814 putc ('>', dribble
);
2821 store_kbd_macro_char (c
);
2823 num_nonmacro_input_events
++;
2830 struct buffer
*old
= current_buffer
;
2831 Fprinc (object
, Qnil
);
2832 set_buffer_internal (XBUFFER (Vstandard_output
));
2833 call0 (intern ("help-mode"));
2834 set_buffer_internal (old
);
2838 /* Copy out or in the info on where C-g should throw to.
2839 This is used when running Lisp code from within get_char,
2840 in case get_char is called recursively.
2841 See read_process_output. */
2847 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2851 restore_getcjmp (temp
)
2854 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2859 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2860 of this function. */
2863 tracking_off (old_value
)
2864 Lisp_Object old_value
;
2866 do_mouse_tracking
= old_value
;
2867 if (NILP (old_value
))
2869 /* Redisplay may have been preempted because there was input
2870 available, and it assumes it will be called again after the
2871 input has been processed. If the only input available was
2872 the sort that we have just disabled, then we need to call
2874 if (!readable_events (1))
2876 redisplay_preserve_echo_area ();
2877 get_input_pending (&input_pending
, 1);
2883 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2884 "Evaluate BODY with mouse movement events enabled.\n\
2885 Within a `track-mouse' form, mouse motion generates input events that\n\
2886 you can read with `read-event'.\n\
2887 Normally, mouse motion is ignored.")
2891 int count
= specpdl_ptr
- specpdl
;
2894 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2896 do_mouse_tracking
= Qt
;
2898 val
= Fprogn (args
);
2899 return unbind_to (count
, val
);
2902 /* If mouse has moved on some frame, return one of those frames.
2903 Return 0 otherwise. */
2908 Lisp_Object tail
, frame
;
2910 FOR_EACH_FRAME (tail
, frame
)
2912 if (XFRAME (frame
)->mouse_moved
)
2913 return XFRAME (frame
);
2919 #endif /* HAVE_MOUSE */
2921 /* Low level keyboard/mouse input.
2922 kbd_buffer_store_event places events in kbd_buffer, and
2923 kbd_buffer_get_event retrieves them. */
2925 /* Return true iff there are any events in the queue that read-char
2926 would return. If this returns false, a read-char would block. */
2928 readable_events (do_timers_now
)
2932 timer_check (do_timers_now
);
2934 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2937 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2942 if (current_kboard
->kbd_queue_has_data
)
2948 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2949 if (kb
->kbd_queue_has_data
)
2955 /* Set this for debugging, to have a way to get out */
2960 event_to_kboard (event
)
2961 struct input_event
*event
;
2964 frame
= event
->frame_or_window
;
2966 frame
= XCAR (frame
);
2967 else if (WINDOWP (frame
))
2968 frame
= WINDOW_FRAME (XWINDOW (frame
));
2970 /* There are still some events that don't set this field.
2971 For now, just ignore the problem.
2972 Also ignore dead frames here. */
2973 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2976 return FRAME_KBOARD (XFRAME (frame
));
2980 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2983 kbd_buffer_store_event (event
)
2984 register struct input_event
*event
;
2986 if (event
->kind
== no_event
)
2989 if (event
->kind
== ascii_keystroke
)
2991 register int c
= event
->code
& 0377;
2993 if (event
->modifiers
& ctrl_modifier
)
2994 c
= make_ctrl_char (c
);
2996 c
|= (event
->modifiers
2997 & (meta_modifier
| alt_modifier
2998 | hyper_modifier
| super_modifier
));
3002 extern SIGTYPE
interrupt_signal ();
3005 struct input_event
*sp
;
3008 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3009 kb
!= current_kboard
))
3012 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3013 Fcons (make_number (c
), Qnil
));
3014 kb
->kbd_queue_has_data
= 1;
3015 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3017 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3020 if (event_to_kboard (sp
) == kb
)
3022 sp
->kind
= no_event
;
3023 sp
->frame_or_window
= Qnil
;
3030 /* If this results in a quit_char being returned to Emacs as
3031 input, set Vlast_event_frame properly. If this doesn't
3032 get returned to Emacs as an event, the next event read
3033 will set Vlast_event_frame again, so this is safe to do. */
3037 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3039 focus
= event
->frame_or_window
;
3040 internal_last_event_frame
= focus
;
3041 Vlast_event_frame
= focus
;
3044 last_event_timestamp
= event
->timestamp
;
3045 interrupt_signal ();
3049 if (c
&& c
== stop_character
)
3055 /* Don't insert two buffer_switch_event's in a row.
3056 Just ignore the second one. */
3057 else if (event
->kind
== buffer_switch_event
3058 && kbd_fetch_ptr
!= kbd_store_ptr
3059 && kbd_store_ptr
->kind
== buffer_switch_event
)
3062 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3063 kbd_store_ptr
= kbd_buffer
;
3065 /* Don't let the very last slot in the buffer become full,
3066 since that would make the two pointers equal,
3067 and that is indistinguishable from an empty buffer.
3068 Discard the event if it would fill the last slot. */
3069 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3071 struct input_event
*sp
= kbd_store_ptr
;
3072 sp
->kind
= event
->kind
;
3073 if (event
->kind
== selection_request_event
)
3075 /* We must not use the ordinary copying code for this case,
3076 since `part' is an enum and copying it might not copy enough
3078 bcopy (event
, (char *) sp
, sizeof (*event
));
3082 sp
->code
= event
->code
;
3083 sp
->part
= event
->part
;
3084 sp
->frame_or_window
= event
->frame_or_window
;
3085 sp
->modifiers
= event
->modifiers
;
3088 sp
->timestamp
= event
->timestamp
;
3090 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
3092 = event
->frame_or_window
);
3098 /* Discard any mouse events in the event buffer by setting them to
3101 discard_mouse_events ()
3103 struct input_event
*sp
;
3104 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3106 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3109 if (sp
->kind
== mouse_click
3111 || sp
->kind
== w32_scroll_bar_click
3113 || sp
->kind
== scroll_bar_click
)
3115 sp
->kind
= no_event
;
3120 /* Read one event from the event buffer, waiting if necessary.
3121 The value is a Lisp object representing the event.
3122 The value is nil for an event that should be ignored,
3123 or that was handled here.
3124 We always read and discard one event. */
3127 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3129 int *used_mouse_menu
;
3138 *kbp
= current_kboard
;
3142 /* Wait until there is input available. */
3145 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3148 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3152 /* If the quit flag is set, then read_char will return
3153 quit_char, so that counts as "available input." */
3154 if (!NILP (Vquit_flag
))
3155 quit_throw_to_read_char ();
3157 /* One way or another, wait until input is available; then, if
3158 interrupt handlers have not read it, read it now. */
3161 wait_for_kbd_input ();
3163 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3167 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3170 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3174 Lisp_Object minus_one
;
3176 XSETINT (minus_one
, -1);
3177 wait_reading_process_input (0, 0, minus_one
, 1);
3179 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3180 /* Pass 1 for EXPECT since we just waited to have input. */
3181 read_avail_input (1);
3183 #endif /* not VMS */
3186 if (CONSP (Vunread_command_events
))
3189 first
= XCAR (Vunread_command_events
);
3190 Vunread_command_events
= XCDR (Vunread_command_events
);
3191 *kbp
= current_kboard
;
3195 /* At this point, we know that there is a readable event available
3196 somewhere. If the event queue is empty, then there must be a
3197 mouse movement enabled and available. */
3198 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3200 struct input_event
*event
;
3202 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3206 last_event_timestamp
= event
->timestamp
;
3209 *kbp
= event_to_kboard (event
);
3211 *kbp
= current_kboard
; /* Better than returning null ptr? */
3213 *kbp
= &the_only_kboard
;
3218 /* These two kinds of events get special handling
3219 and don't actually appear to the command loop.
3220 We return nil for them. */
3221 if (event
->kind
== selection_request_event
)
3224 struct input_event copy
;
3226 /* Remove it from the buffer before processing it,
3227 since otherwise swallow_events will see it
3228 and process it again. */
3230 kbd_fetch_ptr
= event
+ 1;
3231 input_pending
= readable_events (0);
3232 x_handle_selection_request (©
);
3234 /* We're getting selection request events, but we don't have
3240 else if (event
->kind
== selection_clear_event
)
3243 struct input_event copy
;
3245 /* Remove it from the buffer before processing it. */
3247 kbd_fetch_ptr
= event
+ 1;
3248 input_pending
= readable_events (0);
3249 x_handle_selection_clear (©
);
3251 /* We're getting selection request events, but we don't have
3256 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3257 else if (event
->kind
== delete_window_event
)
3259 /* Make an event (delete-frame (FRAME)). */
3260 obj
= Fcons (event
->frame_or_window
, Qnil
);
3261 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3262 kbd_fetch_ptr
= event
+ 1;
3264 else if (event
->kind
== iconify_event
)
3266 /* Make an event (iconify-frame (FRAME)). */
3267 obj
= Fcons (event
->frame_or_window
, Qnil
);
3268 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3269 kbd_fetch_ptr
= event
+ 1;
3271 else if (event
->kind
== deiconify_event
)
3273 /* Make an event (make-frame-visible (FRAME)). */
3274 obj
= Fcons (event
->frame_or_window
, Qnil
);
3275 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3276 kbd_fetch_ptr
= event
+ 1;
3279 else if (event
->kind
== buffer_switch_event
)
3281 /* The value doesn't matter here; only the type is tested. */
3282 XSETBUFFER (obj
, current_buffer
);
3283 kbd_fetch_ptr
= event
+ 1;
3285 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3286 else if (event
->kind
== menu_bar_activate_event
)
3288 kbd_fetch_ptr
= event
+ 1;
3289 input_pending
= readable_events (0);
3290 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3291 x_activate_menubar (XFRAME (event
->frame_or_window
));
3295 else if (event
->kind
== language_change_event
)
3297 /* Make an event (language-change (FRAME CHARSET LCID)). */
3298 obj
= Fcons (event
->modifiers
, Qnil
);
3299 obj
= Fcons (event
->code
, Qnil
);
3300 obj
= Fcons (event
->frame_or_window
, obj
);
3301 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3302 kbd_fetch_ptr
= event
+ 1;
3305 /* Just discard these, by returning nil.
3306 With MULTI_KBOARD, these events are used as placeholders
3307 when we need to randomly delete events from the queue.
3308 (They shouldn't otherwise be found in the buffer,
3309 but on some machines it appears they do show up
3310 even without MULTI_KBOARD.) */
3311 /* On Windows NT/9X, no_event is used to delete extraneous
3312 mouse events during a popup-menu call. */
3313 else if (event
->kind
== no_event
)
3314 kbd_fetch_ptr
= event
+ 1;
3315 else if (event
->kind
== HELP_EVENT
)
3317 /* The car of event->frame_or_window is a frame,
3318 the cdr is the help to display. */
3319 obj
= Fcons (Qhelp_echo
, event
->frame_or_window
);
3320 kbd_fetch_ptr
= event
+ 1;
3322 else if (event
->kind
== FOCUS_IN_EVENT
)
3324 /* Notification of a FocusIn event. The frame receiving the
3325 focus is in event->frame_or_window. Generate a
3326 switch-frame event if necessary. */
3327 Lisp_Object frame
, focus
;
3329 frame
= event
->frame_or_window
;
3330 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3334 if (!EQ (frame
, internal_last_event_frame
)
3335 && !EQ (frame
, selected_frame
))
3336 obj
= make_lispy_switch_frame (frame
);
3337 internal_last_event_frame
= frame
;
3338 kbd_fetch_ptr
= event
+ 1;
3342 /* If this event is on a different frame, return a switch-frame this
3343 time, and leave the event in the queue for next time. */
3347 frame
= event
->frame_or_window
;
3349 frame
= XCAR (frame
);
3350 else if (WINDOWP (frame
))
3351 frame
= WINDOW_FRAME (XWINDOW (frame
));
3353 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3357 if (! EQ (frame
, internal_last_event_frame
)
3358 && !EQ (frame
, selected_frame
))
3359 obj
= make_lispy_switch_frame (frame
);
3360 internal_last_event_frame
= frame
;
3362 /* If we didn't decide to make a switch-frame event, go ahead
3363 and build a real event from the queue entry. */
3367 obj
= make_lispy_event (event
);
3368 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3369 /* If this was a menu selection, then set the flag to inhibit
3370 writing to last_nonmenu_event. Don't do this if the event
3371 we're returning is (menu-bar), though; that indicates the
3372 beginning of the menu sequence, and we might as well leave
3373 that as the `event with parameters' for this selection. */
3374 if ((event
->kind
== menu_bar_event
3375 || event
->kind
== TOOL_BAR_EVENT
)
3376 && !(CONSP (obj
) && EQ (XCAR (obj
), Qmenu_bar
))
3377 && !(CONSP (obj
) && EQ (XCAR (obj
), Qtool_bar
))
3379 *used_mouse_menu
= 1;
3382 /* Wipe out this event, to catch bugs. */
3383 event
->kind
= no_event
;
3384 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
3386 kbd_fetch_ptr
= event
+ 1;
3391 /* Try generating a mouse motion event. */
3392 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3394 FRAME_PTR f
= some_mouse_moved ();
3395 Lisp_Object bar_window
;
3396 enum scroll_bar_part part
;
3400 *kbp
= current_kboard
;
3401 /* Note that this uses F to determine which display to look at.
3402 If there is no valid info, it does not store anything
3403 so x remains nil. */
3405 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3409 /* Decide if we should generate a switch-frame event. Don't
3410 generate switch-frame events for motion outside of all Emacs
3416 frame
= FRAME_FOCUS_FRAME (f
);
3418 XSETFRAME (frame
, f
);
3420 if (! EQ (frame
, internal_last_event_frame
)
3421 && !EQ (frame
, selected_frame
))
3422 obj
= make_lispy_switch_frame (frame
);
3423 internal_last_event_frame
= frame
;
3426 /* If we didn't decide to make a switch-frame event, go ahead and
3427 return a mouse-motion event. */
3428 if (!NILP (x
) && NILP (obj
))
3429 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3431 #endif /* HAVE_MOUSE */
3433 /* We were promised by the above while loop that there was
3434 something for us to read! */
3437 input_pending
= readable_events (0);
3439 Vlast_event_frame
= internal_last_event_frame
;
3444 /* Process any events that are not user-visible,
3445 then return, without reading any user-visible events. */
3448 swallow_events (do_display
)
3453 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3455 struct input_event
*event
;
3457 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3461 last_event_timestamp
= event
->timestamp
;
3463 /* These two kinds of events get special handling
3464 and don't actually appear to the command loop. */
3465 if (event
->kind
== selection_request_event
)
3468 struct input_event copy
;
3470 /* Remove it from the buffer before processing it,
3471 since otherwise swallow_events called recursively could see it
3472 and process it again. */
3474 kbd_fetch_ptr
= event
+ 1;
3475 input_pending
= readable_events (0);
3476 x_handle_selection_request (©
);
3478 /* We're getting selection request events, but we don't have
3484 else if (event
->kind
== selection_clear_event
)
3487 struct input_event copy
;
3489 /* Remove it from the buffer before processing it, */
3492 kbd_fetch_ptr
= event
+ 1;
3493 input_pending
= readable_events (0);
3494 x_handle_selection_clear (©
);
3496 /* We're getting selection request events, but we don't have
3505 old_timers_run
= timers_run
;
3506 get_input_pending (&input_pending
, 1);
3508 if (timers_run
!= old_timers_run
&& do_display
)
3509 redisplay_preserve_echo_area ();
3512 static EMACS_TIME timer_idleness_start_time
;
3514 /* Record the start of when Emacs is idle,
3515 for the sake of running idle-time timers. */
3522 /* If we are already in the idle state, do nothing. */
3523 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3526 EMACS_GET_TIME (timer_idleness_start_time
);
3528 /* Mark all idle-time timers as once again candidates for running. */
3529 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
3533 timer
= XCAR (timers
);
3535 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3537 XVECTOR (timer
)->contents
[0] = Qnil
;
3541 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3546 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3549 /* This is only for debugging. */
3550 struct input_event last_timer_event
;
3552 /* Check whether a timer has fired. To prevent larger problems we simply
3553 disregard elements that are not proper timers. Do not make a circular
3554 timer list for the time being.
3556 Returns the number of seconds to wait until the next timer fires. If a
3557 timer is triggering now, return zero seconds.
3558 If no timer is active, return -1 seconds.
3560 If a timer is ripe, we run it, with quitting turned off.
3562 DO_IT_NOW is now ignored. It used to mean that we should
3563 run the timer directly instead of queueing a timer-event.
3564 Now we always run timers directly. */
3567 timer_check (do_it_now
)
3570 EMACS_TIME nexttime
;
3571 EMACS_TIME now
, idleness_now
;
3572 Lisp_Object timers
, idle_timers
, chosen_timer
;
3573 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3575 EMACS_SET_SECS (nexttime
, -1);
3576 EMACS_SET_USECS (nexttime
, -1);
3578 /* Always consider the ordinary timers. */
3579 timers
= Vtimer_list
;
3580 /* Consider the idle timers only if Emacs is idle. */
3581 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3582 idle_timers
= Vtimer_idle_list
;
3585 chosen_timer
= Qnil
;
3586 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3588 if (CONSP (timers
) || CONSP (idle_timers
))
3590 EMACS_GET_TIME (now
);
3591 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3592 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3595 while (CONSP (timers
) || CONSP (idle_timers
))
3597 Lisp_Object
*vector
;
3598 Lisp_Object timer
, idle_timer
;
3599 EMACS_TIME timer_time
, idle_timer_time
;
3600 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3602 /* Skip past invalid timers and timers already handled. */
3605 timer
= XCAR (timers
);
3606 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3608 timers
= XCDR (timers
);
3611 vector
= XVECTOR (timer
)->contents
;
3613 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3614 || !INTEGERP (vector
[3])
3615 || ! NILP (vector
[0]))
3617 timers
= XCDR (timers
);
3621 if (!NILP (idle_timers
))
3623 timer
= XCAR (idle_timers
);
3624 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3626 idle_timers
= XCDR (idle_timers
);
3629 vector
= XVECTOR (timer
)->contents
;
3631 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3632 || !INTEGERP (vector
[3])
3633 || ! NILP (vector
[0]))
3635 idle_timers
= XCDR (idle_timers
);
3640 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3641 based on the next ordinary timer.
3642 TIMER_DIFFERENCE is the distance in time from NOW to when
3643 this timer becomes ripe (negative if it's already ripe). */
3646 timer
= XCAR (timers
);
3647 vector
= XVECTOR (timer
)->contents
;
3648 EMACS_SET_SECS (timer_time
,
3649 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3650 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3651 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3654 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3655 based on the next idle timer. */
3656 if (!NILP (idle_timers
))
3658 idle_timer
= XCAR (idle_timers
);
3659 vector
= XVECTOR (idle_timer
)->contents
;
3660 EMACS_SET_SECS (idle_timer_time
,
3661 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3662 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3663 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3666 /* Decide which timer is the next timer,
3667 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3668 Also step down the list where we found that timer. */
3670 if (! NILP (timers
) && ! NILP (idle_timers
))
3673 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3674 if (EMACS_TIME_NEG_P (temp
))
3676 chosen_timer
= timer
;
3677 timers
= XCDR (timers
);
3678 difference
= timer_difference
;
3682 chosen_timer
= idle_timer
;
3683 idle_timers
= XCDR (idle_timers
);
3684 difference
= idle_timer_difference
;
3687 else if (! NILP (timers
))
3689 chosen_timer
= timer
;
3690 timers
= XCDR (timers
);
3691 difference
= timer_difference
;
3695 chosen_timer
= idle_timer
;
3696 idle_timers
= XCDR (idle_timers
);
3697 difference
= idle_timer_difference
;
3699 vector
= XVECTOR (chosen_timer
)->contents
;
3701 /* If timer is ripe, run it if it hasn't been run. */
3702 if (EMACS_TIME_NEG_P (difference
)
3703 || (EMACS_SECS (difference
) == 0
3704 && EMACS_USECS (difference
) == 0))
3706 if (NILP (vector
[0]))
3708 int was_locked
= single_kboard
;
3709 int count
= specpdl_ptr
- specpdl
;
3711 /* Mark the timer as triggered to prevent problems if the lisp
3712 code fails to reschedule it right. */
3715 specbind (Qinhibit_quit
, Qt
);
3717 call1 (Qtimer_event_handler
, chosen_timer
);
3720 unbind_to (count
, Qnil
);
3722 /* Resume allowing input from any kboard, if that was true before. */
3724 any_kboard_state ();
3726 /* Since we have handled the event,
3727 we don't need to tell the caller to wake up and do it. */
3731 /* When we encounter a timer that is still waiting,
3732 return the amount of time to wait before it is ripe. */
3739 /* No timers are pending in the future. */
3740 /* Return 0 if we generated an event, and -1 if not. */
3745 /* Caches for modify_event_symbol. */
3746 static Lisp_Object accent_key_syms
;
3747 static Lisp_Object func_key_syms
;
3748 static Lisp_Object mouse_syms
;
3750 static Lisp_Object mouse_wheel_syms
;
3752 static Lisp_Object drag_n_drop_syms
;
3754 /* This is a list of keysym codes for special "accent" characters.
3755 It parallels lispy_accent_keys. */
3757 static int lispy_accent_codes
[] =
3759 #ifdef XK_dead_circumflex
3764 #ifdef XK_dead_grave
3769 #ifdef XK_dead_tilde
3774 #ifdef XK_dead_diaeresis
3779 #ifdef XK_dead_macron
3784 #ifdef XK_dead_degree
3789 #ifdef XK_dead_acute
3794 #ifdef XK_dead_cedilla
3799 #ifdef XK_dead_breve
3804 #ifdef XK_dead_ogonek
3809 #ifdef XK_dead_caron
3814 #ifdef XK_dead_doubleacute
3815 XK_dead_doubleacute
,
3819 #ifdef XK_dead_abovedot
3826 /* This is a list of Lisp names for special "accent" characters.
3827 It parallels lispy_accent_codes. */
3829 static char *lispy_accent_keys
[] =
3847 #define FUNCTION_KEY_OFFSET 0x0
3849 char *lispy_function_keys
[] =
3853 0, /* VK_LBUTTON 0x01 */
3854 0, /* VK_RBUTTON 0x02 */
3855 "cancel", /* VK_CANCEL 0x03 */
3856 0, /* VK_MBUTTON 0x04 */
3858 0, 0, 0, /* 0x05 .. 0x07 */
3860 "backspace", /* VK_BACK 0x08 */
3861 "tab", /* VK_TAB 0x09 */
3863 0, 0, /* 0x0A .. 0x0B */
3865 "clear", /* VK_CLEAR 0x0C */
3866 "return", /* VK_RETURN 0x0D */
3868 0, 0, /* 0x0E .. 0x0F */
3870 0, /* VK_SHIFT 0x10 */
3871 0, /* VK_CONTROL 0x11 */
3872 0, /* VK_MENU 0x12 */
3873 "pause", /* VK_PAUSE 0x13 */
3874 "capslock", /* VK_CAPITAL 0x14 */
3876 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3878 "escape", /* VK_ESCAPE 0x1B */
3880 0, 0, 0, 0, /* 0x1C .. 0x1F */
3882 0, /* VK_SPACE 0x20 */
3883 "prior", /* VK_PRIOR 0x21 */
3884 "next", /* VK_NEXT 0x22 */
3885 "end", /* VK_END 0x23 */
3886 "home", /* VK_HOME 0x24 */
3887 "left", /* VK_LEFT 0x25 */
3888 "up", /* VK_UP 0x26 */
3889 "right", /* VK_RIGHT 0x27 */
3890 "down", /* VK_DOWN 0x28 */
3891 "select", /* VK_SELECT 0x29 */
3892 "print", /* VK_PRINT 0x2A */
3893 "execute", /* VK_EXECUTE 0x2B */
3894 "snapshot", /* VK_SNAPSHOT 0x2C */
3895 "insert", /* VK_INSERT 0x2D */
3896 "delete", /* VK_DELETE 0x2E */
3897 "help", /* VK_HELP 0x2F */
3899 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3901 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3903 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3905 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3907 0, 0, 0, 0, 0, 0, 0, 0, 0,
3908 0, 0, 0, 0, 0, 0, 0, 0, 0,
3909 0, 0, 0, 0, 0, 0, 0, 0,
3911 "lwindow", /* VK_LWIN 0x5B */
3912 "rwindow", /* VK_RWIN 0x5C */
3913 "apps", /* VK_APPS 0x5D */
3915 0, 0, /* 0x5E .. 0x5F */
3917 "kp-0", /* VK_NUMPAD0 0x60 */
3918 "kp-1", /* VK_NUMPAD1 0x61 */
3919 "kp-2", /* VK_NUMPAD2 0x62 */
3920 "kp-3", /* VK_NUMPAD3 0x63 */
3921 "kp-4", /* VK_NUMPAD4 0x64 */
3922 "kp-5", /* VK_NUMPAD5 0x65 */
3923 "kp-6", /* VK_NUMPAD6 0x66 */
3924 "kp-7", /* VK_NUMPAD7 0x67 */
3925 "kp-8", /* VK_NUMPAD8 0x68 */
3926 "kp-9", /* VK_NUMPAD9 0x69 */
3927 "kp-multiply", /* VK_MULTIPLY 0x6A */
3928 "kp-add", /* VK_ADD 0x6B */
3929 "kp-separator", /* VK_SEPARATOR 0x6C */
3930 "kp-subtract", /* VK_SUBTRACT 0x6D */
3931 "kp-decimal", /* VK_DECIMAL 0x6E */
3932 "kp-divide", /* VK_DIVIDE 0x6F */
3933 "f1", /* VK_F1 0x70 */
3934 "f2", /* VK_F2 0x71 */
3935 "f3", /* VK_F3 0x72 */
3936 "f4", /* VK_F4 0x73 */
3937 "f5", /* VK_F5 0x74 */
3938 "f6", /* VK_F6 0x75 */
3939 "f7", /* VK_F7 0x76 */
3940 "f8", /* VK_F8 0x77 */
3941 "f9", /* VK_F9 0x78 */
3942 "f10", /* VK_F10 0x79 */
3943 "f11", /* VK_F11 0x7A */
3944 "f12", /* VK_F12 0x7B */
3945 "f13", /* VK_F13 0x7C */
3946 "f14", /* VK_F14 0x7D */
3947 "f15", /* VK_F15 0x7E */
3948 "f16", /* VK_F16 0x7F */
3949 "f17", /* VK_F17 0x80 */
3950 "f18", /* VK_F18 0x81 */
3951 "f19", /* VK_F19 0x82 */
3952 "f20", /* VK_F20 0x83 */
3953 "f21", /* VK_F21 0x84 */
3954 "f22", /* VK_F22 0x85 */
3955 "f23", /* VK_F23 0x86 */
3956 "f24", /* VK_F24 0x87 */
3958 0, 0, 0, 0, /* 0x88 .. 0x8B */
3959 0, 0, 0, 0, /* 0x8C .. 0x8F */
3961 "kp-numlock", /* VK_NUMLOCK 0x90 */
3962 "scroll", /* VK_SCROLL 0x91 */
3964 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3965 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3966 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3967 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3968 "kp-end", /* VK_NUMPAD_END 0x96 */
3969 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3970 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3971 "kp-up", /* VK_NUMPAD_UP 0x99 */
3972 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3973 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3974 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3975 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3977 0, 0, /* 0x9E .. 0x9F */
3980 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3981 * Used only as parameters to GetAsyncKeyState and GetKeyState.
3982 * No other API or message will distinguish left and right keys this way.
3986 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3987 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3988 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3989 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3990 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3996 "attn", /* VK_ATTN 0xF6 */
3997 "crsel", /* VK_CRSEL 0xF7 */
3998 "exsel", /* VK_EXSEL 0xF8 */
3999 "ereof", /* VK_EREOF 0xF9 */
4000 "play", /* VK_PLAY 0xFA */
4001 "zoom", /* VK_ZOOM 0xFB */
4002 "noname", /* VK_NONAME 0xFC */
4003 "pa1", /* VK_PA1 0xFD */
4004 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4008 #else /* not HAVE_NTGUI */
4011 static char *lispy_kana_keys
[] =
4013 /* X Keysym value */
4014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4024 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4025 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4026 "kana-i", "kana-u", "kana-e", "kana-o",
4027 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4028 "prolongedsound", "kana-A", "kana-I", "kana-U",
4029 "kana-E", "kana-O", "kana-KA", "kana-KI",
4030 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4031 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4032 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4033 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4034 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4035 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4036 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4037 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4038 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4039 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4043 #endif /* XK_kana_A */
4045 #define FUNCTION_KEY_OFFSET 0xff00
4047 /* You'll notice that this table is arranged to be conveniently
4048 indexed by X Windows keysym values. */
4049 static char *lispy_function_keys
[] =
4051 /* X Keysym value */
4053 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4054 "backspace", "tab", "linefeed", "clear",
4056 0, 0, 0, "pause", /* 0xff10...1f */
4057 0, 0, 0, 0, 0, 0, 0, "escape",
4059 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4060 "romaji", "hiragana", "katakana", "hiragana-katakana",
4061 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4062 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4063 "eisu-toggle", /* 0xff30...3f */
4064 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4065 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4067 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4068 "down", "prior", "next", "end",
4069 "begin", 0, 0, 0, 0, 0, 0, 0,
4070 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4081 "break", /* 0xff6b */
4084 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4085 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4086 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4087 0, 0, 0, 0, 0, 0, 0, 0,
4088 "kp-tab", /* 0xff89 */
4090 "kp-enter", /* 0xff8d */
4092 "kp-f1", /* 0xff91 */
4096 "kp-home", /* 0xff95 */
4101 "kp-prior", /* kp-page-up */
4102 "kp-next", /* kp-page-down */
4108 0, 0, 0, 0, 0, 0, 0, 0, 0,
4109 "kp-multiply", /* 0xffaa */
4114 "kp-divide", /* 0xffaf */
4115 "kp-0", /* 0xffb0 */
4116 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4119 "kp-equal", /* 0xffbd */
4120 "f1", /* 0xffbe */ /* IsFunctionKey */
4122 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4123 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4124 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4125 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4126 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4127 0, 0, 0, 0, 0, 0, 0, 0,
4128 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4129 0, 0, 0, 0, 0, 0, 0, "delete"
4132 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4133 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4135 static char *iso_lispy_function_keys
[] =
4137 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4138 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4139 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4140 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4141 "iso-lefttab", /* 0xfe20 */
4142 "iso-move-line-up", "iso-move-line-down",
4143 "iso-partial-line-up", "iso-partial-line-down",
4144 "iso-partial-space-left", "iso-partial-space-right",
4145 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4146 "iso-release-margin-left", "iso-release-margin-right",
4147 "iso-release-both-margins",
4148 "iso-fast-cursor-left", "iso-fast-cursor-right",
4149 "iso-fast-cursor-up", "iso-fast-cursor-down",
4150 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4151 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4154 #endif /* not HAVE_NTGUI */
4156 Lisp_Object Vlispy_mouse_stem
;
4159 /* mouse-wheel events are generated by the wheel on devices such as
4160 the MS Intellimouse. The wheel sits in between the left and right
4161 mouse buttons, and is typically used to scroll or zoom the window
4162 underneath the pointer. mouse-wheel events specify the object on
4163 which they operate, and a delta corresponding to the amount and
4164 direction that the wheel is rotated. Clicking the mouse-wheel
4165 generates a mouse-2 event. */
4166 static char *lispy_mouse_wheel_names
[] =
4171 #endif /* WINDOWSNT */
4173 /* drag-n-drop events are generated when a set of selected files are
4174 dragged from another application and dropped onto an Emacs window. */
4175 static char *lispy_drag_n_drop_names
[] =
4180 /* Scroll bar parts. */
4181 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4182 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4183 Lisp_Object Qtop
, Qratio
;
4185 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4186 Lisp_Object
*scroll_bar_parts
[] = {
4187 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4188 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4191 /* User signal events. */
4192 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4194 Lisp_Object
*lispy_user_signals
[] =
4196 &Qusr1_signal
, &Qusr2_signal
4200 /* A vector, indexed by button number, giving the down-going location
4201 of currently depressed buttons, both scroll bar and non-scroll bar.
4203 The elements have the form
4204 (BUTTON-NUMBER MODIFIER-MASK . REST)
4205 where REST is the cdr of a position as it would be reported in the event.
4207 The make_lispy_event function stores positions here to tell the
4208 difference between click and drag events, and to store the starting
4209 location to be included in drag events. */
4211 static Lisp_Object button_down_location
;
4213 /* Information about the most recent up-going button event: Which
4214 button, what location, and what time. */
4216 static int last_mouse_button
;
4217 static int last_mouse_x
;
4218 static int last_mouse_y
;
4219 static unsigned long button_down_time
;
4221 /* The maximum time between clicks to make a double-click,
4222 or Qnil to disable double-click detection,
4223 or Qt for no time limit. */
4224 Lisp_Object Vdouble_click_time
;
4226 /* The number of clicks in this multiple-click. */
4228 int double_click_count
;
4230 /* Given a struct input_event, build the lisp event which represents
4231 it. If EVENT is 0, build a mouse movement event from the mouse
4232 movement buffer, which should have a movement event in it.
4234 Note that events must be passed to this function in the order they
4235 are received; this function stores the location of button presses
4236 in order to build drag events when the button is released. */
4239 make_lispy_event (event
)
4240 struct input_event
*event
;
4244 switch (SWITCH_ENUM_CAST (event
->kind
))
4246 /* A simple keystroke. */
4247 case ascii_keystroke
:
4249 Lisp_Object lispy_c
;
4250 int c
= event
->code
& 0377;
4251 /* Turn ASCII characters into control characters
4253 if (event
->modifiers
& ctrl_modifier
)
4254 c
= make_ctrl_char (c
);
4256 /* Add in the other modifier bits. We took care of ctrl_modifier
4257 just above, and the shift key was taken care of by the X code,
4258 and applied to control characters by make_ctrl_char. */
4259 c
|= (event
->modifiers
4260 & (meta_modifier
| alt_modifier
4261 | hyper_modifier
| super_modifier
));
4262 /* Distinguish Shift-SPC from SPC. */
4263 if ((event
->code
& 0377) == 040
4264 && event
->modifiers
& shift_modifier
)
4265 c
|= shift_modifier
;
4266 button_down_time
= 0;
4267 XSETFASTINT (lispy_c
, c
);
4271 /* A function key. The symbol may need to have modifier prefixes
4273 case non_ascii_keystroke
:
4274 button_down_time
= 0;
4276 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4277 if (event
->code
== lispy_accent_codes
[i
])
4278 return modify_event_symbol (i
,
4280 Qfunction_key
, Qnil
,
4281 lispy_accent_keys
, &accent_key_syms
,
4282 (sizeof (lispy_accent_keys
)
4283 / sizeof (lispy_accent_keys
[0])));
4285 /* Handle system-specific keysyms. */
4286 if (event
->code
& (1 << 28))
4288 /* We need to use an alist rather than a vector as the cache
4289 since we can't make a vector long enuf. */
4290 if (NILP (current_kboard
->system_key_syms
))
4291 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4292 return modify_event_symbol (event
->code
,
4295 current_kboard
->Vsystem_key_alist
,
4296 0, ¤t_kboard
->system_key_syms
,
4301 if (event
->code
>= 0x400 && event
->code
< 0x500)
4302 return modify_event_symbol (event
->code
- 0x400,
4303 event
->modifiers
& ~shift_modifier
,
4304 Qfunction_key
, Qnil
,
4305 lispy_kana_keys
, &func_key_syms
,
4306 (sizeof (lispy_kana_keys
)
4307 / sizeof (lispy_kana_keys
[0])));
4308 #endif /* XK_kana_A */
4310 #ifdef ISO_FUNCTION_KEY_OFFSET
4311 if (event
->code
< FUNCTION_KEY_OFFSET
4312 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4313 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4315 Qfunction_key
, Qnil
,
4316 iso_lispy_function_keys
, &func_key_syms
,
4317 (sizeof (iso_lispy_function_keys
)
4318 / sizeof (iso_lispy_function_keys
[0])));
4321 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4323 Qfunction_key
, Qnil
,
4324 lispy_function_keys
, &func_key_syms
,
4325 (sizeof (lispy_function_keys
)
4326 / sizeof (lispy_function_keys
[0])));
4329 /* A mouse click. Figure out where it is, decide whether it's
4330 a press, click or drag, and build the appropriate structure. */
4332 #ifndef USE_TOOLKIT_SCROLL_BARS
4333 case scroll_bar_click
:
4336 int button
= event
->code
;
4338 Lisp_Object position
;
4339 Lisp_Object
*start_pos_ptr
;
4340 Lisp_Object start_pos
;
4342 /* Build the position as appropriate for this mouse click. */
4343 if (event
->kind
== mouse_click
)
4346 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4349 Lisp_Object string_info
= Qnil
;
4352 /* Ignore mouse events that were made on frame that
4353 have been deleted. */
4354 if (! FRAME_LIVE_P (f
))
4357 /* EVENT->x and EVENT->y are frame-relative pixel
4358 coordinates at this place. Under old redisplay, COLUMN
4359 and ROW are set to frame relative glyph coordinates
4360 which are then used to determine whether this click is
4361 in a menu (non-toolkit version). */
4362 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4363 &column
, &row
, NULL
, 1);
4365 #ifndef USE_X_TOOLKIT
4366 /* In the non-toolkit version, clicks on the menu bar
4367 are ordinary button events in the event buffer.
4368 Distinguish them, and invoke the menu.
4370 (In the toolkit version, the toolkit handles the menu bar
4371 and Emacs doesn't know about it until after the user
4372 makes a selection.) */
4373 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4374 && (event
->modifiers
& down_modifier
))
4376 Lisp_Object items
, item
;
4381 /* Activate the menu bar on the down event. If the
4382 up event comes in before the menu code can deal with it,
4384 if (! (event
->modifiers
& down_modifier
))
4388 /* Find the menu bar item under `column'. */
4390 items
= FRAME_MENU_BAR_ITEMS (f
);
4391 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4393 Lisp_Object pos
, string
;
4394 string
= XVECTOR (items
)->contents
[i
+ 1];
4395 pos
= XVECTOR (items
)->contents
[i
+ 3];
4398 if (column
>= XINT (pos
)
4399 && column
< XINT (pos
) + XSTRING (string
)->size
)
4401 item
= XVECTOR (items
)->contents
[i
];
4406 /* ELisp manual 2.4b says (x y) are window relative but
4407 code says they are frame-relative. */
4409 = Fcons (event
->frame_or_window
,
4411 Fcons (Fcons (event
->x
, event
->y
),
4412 Fcons (make_number (event
->timestamp
),
4415 return Fcons (item
, Fcons (position
, Qnil
));
4417 #endif /* not USE_X_TOOLKIT */
4419 /* Set `window' to the window under frame pixel coordinates
4420 event->x/event->y. */
4421 window
= window_from_coordinates (f
, XINT (event
->x
),
4422 XINT (event
->y
), &part
, 0);
4424 if (!WINDOWP (window
))
4426 window
= event
->frame_or_window
;
4431 /* It's a click in window window at frame coordinates
4432 event->x/ event->y. */
4433 struct window
*w
= XWINDOW (window
);
4435 /* Get window relative coordinates. Original code
4436 `rounded' this to glyph boundaries. */
4437 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4438 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4440 /* Set event coordinates to window-relative coordinates
4441 for constructing the Lisp event below. */
4442 XSETINT (event
->x
, wx
);
4443 XSETINT (event
->y
, wy
);
4445 if (part
== 1 || part
== 3)
4447 /* Mode line or top line. Look for a string under
4448 the mouse that may have a `local-map' property. */
4452 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4453 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4454 if (STRINGP (string
))
4455 string_info
= Fcons (string
, make_number (charpos
));
4458 posn
= Qvertical_line
;
4460 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
4466 Fcons (Fcons (event
->x
, event
->y
),
4467 Fcons (make_number (event
->timestamp
),
4470 : Fcons (string_info
, Qnil
))))));
4472 #ifndef USE_TOOLKIT_SCROLL_BARS
4475 /* It's a scrollbar click. */
4477 Lisp_Object portion_whole
;
4480 window
= event
->frame_or_window
;
4481 portion_whole
= Fcons (event
->x
, event
->y
);
4482 part
= *scroll_bar_parts
[(int) event
->part
];
4486 Fcons (Qvertical_scroll_bar
,
4487 Fcons (portion_whole
,
4488 Fcons (make_number (event
->timestamp
),
4489 Fcons (part
, Qnil
)))));
4491 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4493 if (button
>= XVECTOR (button_down_location
)->size
)
4495 button_down_location
= larger_vector (button_down_location
,
4497 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
4500 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
4502 start_pos
= *start_pos_ptr
;
4503 *start_pos_ptr
= Qnil
;
4505 is_double
= (button
== last_mouse_button
4506 && XINT (event
->x
) == last_mouse_x
4507 && XINT (event
->y
) == last_mouse_y
4508 && button_down_time
!= 0
4509 && (EQ (Vdouble_click_time
, Qt
)
4510 || (INTEGERP (Vdouble_click_time
)
4511 && ((int)(event
->timestamp
- button_down_time
)
4512 < XINT (Vdouble_click_time
)))));
4513 last_mouse_button
= button
;
4514 last_mouse_x
= XINT (event
->x
);
4515 last_mouse_y
= XINT (event
->y
);
4517 /* If this is a button press, squirrel away the location, so
4518 we can decide later whether it was a click or a drag. */
4519 if (event
->modifiers
& down_modifier
)
4523 double_click_count
++;
4524 event
->modifiers
|= ((double_click_count
> 2)
4529 double_click_count
= 1;
4530 button_down_time
= event
->timestamp
;
4531 *start_pos_ptr
= Fcopy_alist (position
);
4534 /* Now we're releasing a button - check the co-ordinates to
4535 see if this was a click or a drag. */
4536 else if (event
->modifiers
& up_modifier
)
4538 /* If we did not see a down before this up,
4539 ignore the up. Probably this happened because
4540 the down event chose a menu item.
4541 It would be an annoyance to treat the release
4542 of the button that chose the menu item
4543 as a separate event. */
4545 if (!CONSP (start_pos
))
4548 event
->modifiers
&= ~up_modifier
;
4549 #if 0 /* Formerly we treated an up with no down as a click event. */
4550 if (!CONSP (start_pos
))
4551 event
->modifiers
|= click_modifier
;
4555 /* The third element of every position should be the (x,y)
4559 down
= Fnth (make_number (2), start_pos
);
4560 if (EQ (event
->x
, XCAR (down
))
4561 && EQ (event
->y
, XCDR (down
)))
4563 event
->modifiers
|= click_modifier
;
4567 button_down_time
= 0;
4568 event
->modifiers
|= drag_modifier
;
4570 /* Don't check is_double; treat this as multiple
4571 if the down-event was multiple. */
4572 if (double_click_count
> 1)
4573 event
->modifiers
|= ((double_click_count
> 2)
4579 /* Every mouse event should either have the down_modifier or
4580 the up_modifier set. */
4584 /* Get the symbol we should use for the mouse click. */
4587 head
= modify_event_symbol (button
,
4589 Qmouse_click
, Vlispy_mouse_stem
,
4592 XVECTOR (mouse_syms
)->size
);
4593 if (event
->modifiers
& drag_modifier
)
4598 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4601 Fcons (make_number (double_click_count
),
4610 #if USE_TOOLKIT_SCROLL_BARS
4612 /* We don't have down and up events if using toolkit scroll bars,
4613 so make this always a click event. Store in the `part' of
4614 the Lisp event a symbol which maps to the following actions:
4616 `above_handle' page up
4617 `below_handle' page down
4621 `bottom' bottom of buffer
4622 `handle' thumb has been dragged.
4623 `end-scroll' end of interaction with scroll bar
4625 The incoming input_event contains in its `part' member an
4626 index of type `enum scroll_bar_part' which we can use as an
4627 index in scroll_bar_parts to get the appropriate symbol. */
4629 case scroll_bar_click
:
4631 Lisp_Object position
, head
, window
, portion_whole
, part
;
4633 window
= event
->frame_or_window
;
4634 portion_whole
= Fcons (event
->x
, event
->y
);
4635 part
= *scroll_bar_parts
[(int) event
->part
];
4639 Fcons (Qvertical_scroll_bar
,
4640 Fcons (portion_whole
,
4641 Fcons (make_number (event
->timestamp
),
4642 Fcons (part
, Qnil
)))));
4644 /* Always treat scroll bar events as clicks. */
4645 event
->modifiers
|= click_modifier
;
4647 /* Get the symbol we should use for the mouse click. */
4648 head
= modify_event_symbol (event
->code
,
4653 XVECTOR (mouse_syms
)->size
);
4654 return Fcons (head
, Fcons (position
, Qnil
));
4657 #endif /* USE_TOOLKIT_SCROLL_BARS */
4660 case w32_scroll_bar_click
:
4662 int button
= event
->code
;
4664 Lisp_Object position
;
4665 Lisp_Object
*start_pos_ptr
;
4666 Lisp_Object start_pos
;
4670 Lisp_Object portion_whole
;
4673 window
= event
->frame_or_window
;
4674 portion_whole
= Fcons (event
->x
, event
->y
);
4675 part
= *scroll_bar_parts
[(int) event
->part
];
4679 Fcons (Qvertical_scroll_bar
,
4680 Fcons (portion_whole
,
4681 Fcons (make_number (event
->timestamp
),
4682 Fcons (part
, Qnil
)))));
4685 /* Always treat W32 scroll bar events as clicks. */
4686 event
->modifiers
|= click_modifier
;
4689 /* Get the symbol we should use for the mouse click. */
4692 head
= modify_event_symbol (button
,
4697 XVECTOR (mouse_syms
)->size
);
4706 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4709 Lisp_Object head
, position
;
4712 /* Ignore mouse events that were made on frame that
4713 have been deleted. */
4714 if (! FRAME_LIVE_P (f
))
4716 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4717 &column
, &row
, NULL
, 1);
4718 window
= window_from_coordinates (f
, column
, row
, &part
, 0);
4720 if (!WINDOWP (window
))
4722 window
= event
->frame_or_window
;
4727 int pixcolumn
, pixrow
;
4728 column
-= XINT (XWINDOW (window
)->left
);
4729 row
-= XINT (XWINDOW (window
)->top
);
4730 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
4731 &pixcolumn
, &pixrow
);
4732 XSETINT (event
->x
, pixcolumn
);
4733 XSETINT (event
->y
, pixrow
);
4738 posn
= Qvertical_line
;
4740 posn
= Qheader_line
;
4743 buffer_posn_from_coords (XWINDOW (window
),
4748 Lisp_Object head
, position
;
4753 Fcons (Fcons (event
->x
, event
->y
),
4754 Fcons (make_number (event
->timestamp
),
4757 head
= modify_event_symbol (0, event
->modifiers
,
4759 lispy_mouse_wheel_names
,
4760 &mouse_wheel_syms
, 1);
4763 Fcons (make_number (event
->code
),
4767 #endif /* WINDOWSNT */
4778 /* The frame_or_window field should be a cons of the frame in
4779 which the event occurred and a list of the filenames
4781 if (! CONSP (event
->frame_or_window
))
4784 f
= XFRAME (XCAR (event
->frame_or_window
));
4785 files
= XCDR (event
->frame_or_window
);
4787 /* Ignore mouse events that were made on frames that
4788 have been deleted. */
4789 if (! FRAME_LIVE_P (f
))
4791 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4792 &column
, &row
, NULL
, 1);
4793 window
= window_from_coordinates (f
, column
, row
, &part
, 0);
4795 if (!WINDOWP (window
))
4797 window
= XCAR (event
->frame_or_window
);
4802 /* It's an event in window `window' at frame coordinates
4803 event->x/ event->y. */
4804 struct window
*w
= XWINDOW (window
);
4806 /* Get window relative coordinates. */
4807 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4808 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4810 /* Set event coordinates to window-relative coordinates
4811 for constructing the Lisp event below. */
4812 XSETINT (event
->x
, wx
);
4813 XSETINT (event
->y
, wy
);
4818 posn
= Qvertical_line
;
4820 posn
= Qheader_line
;
4822 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
4826 Lisp_Object head
, position
;
4831 Fcons (Fcons (event
->x
, event
->y
),
4832 Fcons (make_number (event
->timestamp
),
4835 head
= modify_event_symbol (0, event
->modifiers
,
4837 lispy_drag_n_drop_names
,
4838 &drag_n_drop_syms
, 1);
4845 #endif /* HAVE_MOUSE */
4847 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4848 case menu_bar_event
:
4849 /* The event value is in the cdr of the frame_or_window slot. */
4850 if (!CONSP (event
->frame_or_window
))
4852 return XCDR (event
->frame_or_window
);
4855 case TOOL_BAR_EVENT
:
4858 if (!CONSP (event
->frame_or_window
))
4860 key
= XCDR (event
->frame_or_window
);
4862 key
= apply_modifiers (event
->modifiers
, key
);
4867 /* A user signal. */
4868 return *lispy_user_signals
[event
->code
];
4870 /* The 'kind' field of the event is something we don't recognize. */
4879 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4881 Lisp_Object bar_window
;
4882 enum scroll_bar_part part
;
4886 /* Is it a scroll bar movement? */
4887 if (frame
&& ! NILP (bar_window
))
4889 Lisp_Object part_sym
;
4891 part_sym
= *scroll_bar_parts
[(int) part
];
4892 return Fcons (Qscroll_bar_movement
,
4893 (Fcons (Fcons (bar_window
,
4894 Fcons (Qvertical_scroll_bar
,
4895 Fcons (Fcons (x
, y
),
4896 Fcons (make_number (time
),
4902 /* Or is it an ordinary mouse movement? */
4910 /* It's in a frame; which window on that frame? */
4911 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
4915 if (WINDOWP (window
))
4917 struct window
*w
= XWINDOW (window
);
4920 /* Get window relative coordinates. */
4921 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
4922 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
4929 posn
= Qvertical_line
;
4931 posn
= Qheader_line
;
4933 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
4935 else if (frame
!= 0)
4937 XSETFRAME (window
, frame
);
4948 return Fcons (Qmouse_movement
,
4949 Fcons (Fcons (window
,
4951 Fcons (Fcons (x
, y
),
4952 Fcons (make_number (time
),
4958 #endif /* HAVE_MOUSE */
4960 /* Construct a switch frame event. */
4962 make_lispy_switch_frame (frame
)
4965 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4968 /* Manipulating modifiers. */
4970 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4972 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4973 SYMBOL's name of the end of the modifiers; the string from this
4974 position is the unmodified symbol name.
4976 This doesn't use any caches. */
4979 parse_modifiers_uncached (symbol
, modifier_end
)
4983 struct Lisp_String
*name
;
4987 CHECK_SYMBOL (symbol
, 1);
4990 name
= XSYMBOL (symbol
)->name
;
4992 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
4994 int this_mod_end
= 0;
4997 /* See if the name continues with a modifier word.
4998 Check that the word appears, but don't check what follows it.
4999 Set this_mod and this_mod_end to record what we find. */
5001 switch (name
->data
[i
])
5003 #define SINGLE_LETTER_MOD(BIT) \
5004 (this_mod_end = i + 1, this_mod = BIT)
5007 SINGLE_LETTER_MOD (alt_modifier
);
5011 SINGLE_LETTER_MOD (ctrl_modifier
);
5015 SINGLE_LETTER_MOD (hyper_modifier
);
5019 SINGLE_LETTER_MOD (meta_modifier
);
5023 SINGLE_LETTER_MOD (shift_modifier
);
5027 SINGLE_LETTER_MOD (super_modifier
);
5030 #undef SINGLE_LETTER_MOD
5033 /* If we found no modifier, stop looking for them. */
5034 if (this_mod_end
== 0)
5037 /* Check there is a dash after the modifier, so that it
5038 really is a modifier. */
5039 if (this_mod_end
>= STRING_BYTES (name
)
5040 || name
->data
[this_mod_end
] != '-')
5043 /* This modifier is real; look for another. */
5044 modifiers
|= this_mod
;
5045 i
= this_mod_end
+ 1;
5048 /* Should we include the `click' modifier? */
5049 if (! (modifiers
& (down_modifier
| drag_modifier
5050 | double_modifier
| triple_modifier
))
5051 && i
+ 7 == STRING_BYTES (name
)
5052 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
5053 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
5054 modifiers
|= click_modifier
;
5062 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5063 prepended to the string BASE[0..BASE_LEN-1].
5064 This doesn't use any caches. */
5066 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5069 int base_len
, base_len_byte
;
5071 /* Since BASE could contain nulls, we can't use intern here; we have
5072 to use Fintern, which expects a genuine Lisp_String, and keeps a
5075 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5081 /* Only the event queue may use the `up' modifier; it should always
5082 be turned into a click or drag event before presented to lisp code. */
5083 if (modifiers
& up_modifier
)
5086 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5087 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5088 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5089 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5090 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5091 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5092 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5093 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5094 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5095 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5096 /* The click modifier is denoted by the absence of other modifiers. */
5100 mod_len
= p
- new_mods
;
5104 Lisp_Object new_name
;
5106 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5107 mod_len
+ base_len_byte
);
5108 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
5109 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
5111 return Fintern (new_name
, Qnil
);
5116 static char *modifier_names
[] =
5118 "up", "down", "drag", "click", "double", "triple", 0, 0,
5119 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5120 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5122 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5124 static Lisp_Object modifier_symbols
;
5126 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5128 lispy_modifier_list (modifiers
)
5131 Lisp_Object modifier_list
;
5134 modifier_list
= Qnil
;
5135 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5136 if (modifiers
& (1<<i
))
5137 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5140 return modifier_list
;
5144 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5145 where UNMODIFIED is the unmodified form of SYMBOL,
5146 MASK is the set of modifiers present in SYMBOL's name.
5147 This is similar to parse_modifiers_uncached, but uses the cache in
5148 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5149 Qevent_symbol_elements property. */
5152 parse_modifiers (symbol
)
5155 Lisp_Object elements
;
5157 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5158 if (CONSP (elements
))
5163 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5164 Lisp_Object unmodified
;
5167 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
5168 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
5171 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
5173 XSETFASTINT (mask
, modifiers
);
5174 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5176 /* Cache the parsing results on SYMBOL. */
5177 Fput (symbol
, Qevent_symbol_element_mask
,
5179 Fput (symbol
, Qevent_symbol_elements
,
5180 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5182 /* Since we know that SYMBOL is modifiers applied to unmodified,
5183 it would be nice to put that in unmodified's cache.
5184 But we can't, since we're not sure that parse_modifiers is
5191 /* Apply the modifiers MODIFIERS to the symbol BASE.
5192 BASE must be unmodified.
5194 This is like apply_modifiers_uncached, but uses BASE's
5195 Qmodifier_cache property, if present. It also builds
5196 Qevent_symbol_elements properties, since it has that info anyway.
5198 apply_modifiers copies the value of BASE's Qevent_kind property to
5199 the modified symbol. */
5201 apply_modifiers (modifiers
, base
)
5205 Lisp_Object cache
, index
, entry
, new_symbol
;
5207 /* Mask out upper bits. We don't know where this value's been. */
5208 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
5210 /* The click modifier never figures into cache indices. */
5211 cache
= Fget (base
, Qmodifier_cache
);
5212 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5213 entry
= assq_no_quit (index
, cache
);
5216 new_symbol
= XCDR (entry
);
5219 /* We have to create the symbol ourselves. */
5220 new_symbol
= apply_modifiers_uncached (modifiers
,
5221 XSYMBOL (base
)->name
->data
,
5222 XSYMBOL (base
)->name
->size
,
5223 STRING_BYTES (XSYMBOL (base
)->name
));
5225 /* Add the new symbol to the base's cache. */
5226 entry
= Fcons (index
, new_symbol
);
5227 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5229 /* We have the parsing info now for free, so add it to the caches. */
5230 XSETFASTINT (index
, modifiers
);
5231 Fput (new_symbol
, Qevent_symbol_element_mask
,
5232 Fcons (base
, Fcons (index
, Qnil
)));
5233 Fput (new_symbol
, Qevent_symbol_elements
,
5234 Fcons (base
, lispy_modifier_list (modifiers
)));
5237 /* Make sure this symbol is of the same kind as BASE.
5239 You'd think we could just set this once and for all when we
5240 intern the symbol above, but reorder_modifiers may call us when
5241 BASE's property isn't set right; we can't assume that just
5242 because it has a Qmodifier_cache property it must have its
5243 Qevent_kind set right as well. */
5244 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5248 kind
= Fget (base
, Qevent_kind
);
5250 Fput (new_symbol
, Qevent_kind
, kind
);
5257 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5258 return a symbol with the modifiers placed in the canonical order.
5259 Canonical order is alphabetical, except for down and drag, which
5260 always come last. The 'click' modifier is never written out.
5262 Fdefine_key calls this to make sure that (for example) C-M-foo
5263 and M-C-foo end up being equivalent in the keymap. */
5266 reorder_modifiers (symbol
)
5269 /* It's hopefully okay to write the code this way, since everything
5270 will soon be in caches, and no consing will be done at all. */
5273 parsed
= parse_modifiers (symbol
);
5274 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5279 /* For handling events, we often want to produce a symbol whose name
5280 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5281 to some base, like the name of a function key or mouse button.
5282 modify_event_symbol produces symbols of this sort.
5284 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5285 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5288 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5289 into symbol names, or a string specifying a name stem used to
5290 contruct a symbol name or the form `STEM-N', where N is the decimal
5291 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5292 non-nil; otherwise NAME_TABLE is used.
5294 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5295 persist between calls to modify_event_symbol that it can use to
5296 store a cache of the symbols it's generated for this NAME_TABLE
5297 before. The object stored there may be a vector or an alist.
5299 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5301 MODIFIERS is a set of modifier bits (as given in struct input_events)
5302 whose prefixes should be applied to the symbol name.
5304 SYMBOL_KIND is the value to be placed in the event_kind property of
5305 the returned symbol.
5307 The symbols we create are supposed to have an
5308 `event-symbol-elements' property, which lists the modifiers present
5309 in the symbol's name. */
5312 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5313 name_table
, symbol_table
, table_size
)
5316 Lisp_Object symbol_kind
;
5317 Lisp_Object name_alist_or_stem
;
5319 Lisp_Object
*symbol_table
;
5320 unsigned int table_size
;
5323 Lisp_Object symbol_int
;
5325 /* Get rid of the "vendor-specific" bit here. */
5326 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5328 /* Is this a request for a valid symbol? */
5329 if (symbol_num
< 0 || symbol_num
>= table_size
)
5332 if (CONSP (*symbol_table
))
5333 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5335 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5336 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5337 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5338 we've never used that symbol before. */
5341 if (! VECTORP (*symbol_table
)
5342 || XVECTOR (*symbol_table
)->size
!= table_size
)
5346 XSETFASTINT (size
, table_size
);
5347 *symbol_table
= Fmake_vector (size
, Qnil
);
5350 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5353 /* Have we already used this symbol before? */
5356 /* No; let's create it. */
5357 if (CONSP (name_alist_or_stem
))
5358 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5359 else if (STRINGP (name_alist_or_stem
))
5361 int len
= STRING_BYTES (XSTRING (name_alist_or_stem
));
5362 char *buf
= (char *) alloca (len
+ 50);
5363 sprintf (buf
, "%s-%d", XSTRING (name_alist_or_stem
)->data
,
5364 XINT (symbol_int
) + 1);
5365 value
= intern (buf
);
5367 else if (name_table
!= 0 && name_table
[symbol_num
])
5368 value
= intern (name_table
[symbol_num
]);
5370 #ifdef HAVE_WINDOW_SYSTEM
5373 char *name
= x_get_keysym_name (symbol_num
);
5375 value
= intern (name
);
5382 sprintf (buf
, "key-%d", symbol_num
);
5383 value
= intern (buf
);
5386 if (CONSP (*symbol_table
))
5387 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5389 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5391 /* Fill in the cache entries for this symbol; this also
5392 builds the Qevent_symbol_elements property, which the user
5394 apply_modifiers (modifiers
& click_modifier
, value
);
5395 Fput (value
, Qevent_kind
, symbol_kind
);
5398 /* Apply modifiers to that symbol. */
5399 return apply_modifiers (modifiers
, value
);
5402 /* Convert a list that represents an event type,
5403 such as (ctrl meta backspace), into the usual representation of that
5404 event type as a number or a symbol. */
5406 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5407 "Convert the event description list EVENT-DESC to an event type.\n\
5408 EVENT-DESC should contain one base event type (a character or symbol)\n\
5409 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
5410 drag, down, double or triple). The base must be last.\n\
5411 The return value is an event type (a character or symbol) which\n\
5412 has the same base event type and all the specified modifiers.")
5414 Lisp_Object event_desc
;
5422 while (CONSP (rest
))
5430 /* Given a symbol, see if it is a modifier name. */
5431 if (SYMBOLP (elt
) && CONSP (rest
))
5432 this = parse_solitary_modifier (elt
);
5436 else if (!NILP (base
))
5437 error ("Two bases given in one event");
5443 /* Let the symbol A refer to the character A. */
5444 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
5445 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
5447 if (INTEGERP (base
))
5449 /* Turn (shift a) into A. */
5450 if ((modifiers
& shift_modifier
) != 0
5451 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
5453 XSETINT (base
, XINT (base
) - ('a' - 'A'));
5454 modifiers
&= ~shift_modifier
;
5457 /* Turn (control a) into C-a. */
5458 if (modifiers
& ctrl_modifier
)
5459 return make_number ((modifiers
& ~ctrl_modifier
)
5460 | make_ctrl_char (XINT (base
)));
5462 return make_number (modifiers
| XINT (base
));
5464 else if (SYMBOLP (base
))
5465 return apply_modifiers (modifiers
, base
);
5467 error ("Invalid base event");
5470 /* Try to recognize SYMBOL as a modifier name.
5471 Return the modifier flag bit, or 0 if not recognized. */
5474 parse_solitary_modifier (symbol
)
5477 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
5479 switch (name
->data
[0])
5481 #define SINGLE_LETTER_MOD(BIT) \
5482 if (STRING_BYTES (name) == 1) \
5485 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5486 if (LEN == STRING_BYTES (name) \
5487 && ! strncmp (name->data, NAME, LEN)) \
5491 SINGLE_LETTER_MOD (alt_modifier
);
5495 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
5499 SINGLE_LETTER_MOD (ctrl_modifier
);
5503 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
5504 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
5508 SINGLE_LETTER_MOD (hyper_modifier
);
5512 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
5516 SINGLE_LETTER_MOD (meta_modifier
);
5520 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
5524 SINGLE_LETTER_MOD (shift_modifier
);
5528 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
5529 MULTI_LETTER_MOD (super_modifier
, "super", 5);
5530 SINGLE_LETTER_MOD (super_modifier
);
5534 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5535 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5536 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5540 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5543 #undef SINGLE_LETTER_MOD
5544 #undef MULTI_LETTER_MOD
5550 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
5551 Such a list is not valid as an event,
5552 but it can be a Lucid-style event type list. */
5555 lucid_event_type_list_p (object
)
5560 if (! CONSP (object
))
5563 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
5567 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5574 /* Store into *addr a value nonzero if terminal input chars are available.
5575 Serves the purpose of ioctl (0, FIONREAD, addr)
5576 but works even if FIONREAD does not exist.
5577 (In fact, this may actually read some input.)
5579 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5582 get_input_pending (addr
, do_timers_now
)
5586 /* First of all, have we already counted some input? */
5587 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5589 /* If input is being read as it arrives, and we have none, there is none. */
5590 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5593 /* Try to read some input and see how much we get. */
5595 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5598 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5601 gobble_input (expected
)
5606 if (interrupt_input
)
5609 mask
= sigblock (sigmask (SIGIO
));
5610 read_avail_input (expected
);
5614 #ifdef POLL_FOR_INPUT
5615 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5618 mask
= sigblock (sigmask (SIGALRM
));
5619 read_avail_input (expected
);
5625 read_avail_input (expected
);
5629 /* Put a buffer_switch_event in the buffer
5630 so that read_key_sequence will notice the new current buffer. */
5633 record_asynch_buffer_change ()
5635 struct input_event event
;
5638 event
.kind
= buffer_switch_event
;
5639 event
.frame_or_window
= Qnil
;
5642 /* We don't need a buffer-switch event unless Emacs is waiting for input.
5643 The purpose of the event is to make read_key_sequence look up the
5644 keymaps again. If we aren't in read_key_sequence, we don't need one,
5645 and the event could cause trouble by messing up (input-pending-p). */
5646 tem
= Fwaiting_for_user_input_p ();
5650 /* We never need these events if we have no asynchronous subprocesses. */
5654 /* Make sure no interrupt happens while storing the event. */
5656 if (interrupt_input
)
5659 mask
= sigblock (sigmask (SIGIO
));
5660 kbd_buffer_store_event (&event
);
5667 kbd_buffer_store_event (&event
);
5674 /* Read any terminal input already buffered up by the system
5675 into the kbd_buffer, but do not wait.
5677 EXPECTED should be nonzero if the caller knows there is some input.
5679 Except on VMS, all input is read by this function.
5680 If interrupt_input is nonzero, this function MUST be called
5681 only when SIGIO is blocked.
5683 Returns the number of keyboard chars read, or -1 meaning
5684 this is a bad time to try to read input. */
5687 read_avail_input (expected
)
5690 struct input_event buf
[KBD_BUFFER_SIZE
];
5694 if (read_socket_hook
)
5695 /* No need for FIONREAD or fcntl; just say don't wait. */
5696 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5699 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5700 the kbd_buffer can really hold. That may prevent loss
5701 of characters on some systems when input is stuffed at us. */
5702 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5705 /* Determine how many characters we should *try* to read. */
5708 #else /* not WINDOWSNT */
5710 n_to_read
= dos_keysns ();
5713 #else /* not MSDOS */
5715 /* Find out how much input is available. */
5716 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5717 /* Formerly simply reported no input, but that sometimes led to
5718 a failure of Emacs to terminate.
5719 SIGHUP seems appropriate if we can't reach the terminal. */
5720 /* ??? Is it really right to send the signal just to this process
5721 rather than to the whole process group?
5722 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5723 kill (getpid (), SIGHUP
);
5726 if (n_to_read
> sizeof cbuf
)
5727 n_to_read
= sizeof cbuf
;
5728 #else /* no FIONREAD */
5729 #if defined (USG) || defined (DGUX)
5730 /* Read some input if available, but don't wait. */
5731 n_to_read
= sizeof cbuf
;
5732 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5737 #endif /* not MSDOS */
5738 #endif /* not WINDOWSNT */
5740 /* Now read; for one reason or another, this will not block.
5741 NREAD is set to the number of chars read. */
5745 cbuf
[0] = dos_keyread ();
5748 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
5750 /* POSIX infers that processes which are not in the session leader's
5751 process group won't get SIGHUP's at logout time. BSDI adheres to
5752 this part standard and returns -1 from read (0) with errno==EIO
5753 when the control tty is taken away.
5754 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5755 if (nread
== -1 && errno
== EIO
)
5757 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5758 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5759 This looks incorrect, but it isn't, because _BSD causes
5760 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5761 and that causes a value other than 0 when there is no input. */
5767 /* We used to retry the read if it was interrupted.
5768 But this does the wrong thing when O_NDELAY causes
5769 an EAGAIN error. Does anybody know of a situation
5770 where a retry is actually needed? */
5772 nread
< 0 && (errno
== EAGAIN
5786 #if defined (USG) || defined (DGUX)
5787 fcntl (input_fd
, F_SETFL
, 0);
5788 #endif /* USG or DGUX */
5789 #endif /* no FIONREAD */
5790 for (i
= 0; i
< nread
; i
++)
5792 buf
[i
].kind
= ascii_keystroke
;
5793 buf
[i
].modifiers
= 0;
5794 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5795 buf
[i
].modifiers
= meta_modifier
;
5799 buf
[i
].code
= cbuf
[i
];
5800 buf
[i
].frame_or_window
= selected_frame
;
5804 /* Scan the chars for C-g and store them in kbd_buffer. */
5805 for (i
= 0; i
< nread
; i
++)
5807 kbd_buffer_store_event (&buf
[i
]);
5808 /* Don't look at input that follows a C-g too closely.
5809 This reduces lossage due to autorepeat on C-g. */
5810 if (buf
[i
].kind
== ascii_keystroke
5811 && buf
[i
].code
== quit_char
)
5817 #endif /* not VMS */
5819 #ifdef SIGIO /* for entire page */
5820 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5823 input_available_signal (signo
)
5826 /* Must preserve main program's value of errno. */
5827 int old_errno
= errno
;
5829 extern int select_alarmed
;
5832 #if defined (USG) && !defined (POSIX_SIGNALS)
5833 /* USG systems forget handlers when they are used;
5834 must reestablish each time */
5835 signal (signo
, input_available_signal
);
5842 if (input_available_clear_time
)
5843 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5848 nread
= read_avail_input (1);
5849 /* -1 means it's not ok to read the input now.
5850 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5851 0 means there was no keyboard input available. */
5856 select_alarmed
= 1; /* Force the select emulator back to life */
5867 /* Send ourselves a SIGIO.
5869 This function exists so that the UNBLOCK_INPUT macro in
5870 blockinput.h can have some way to take care of input we put off
5871 dealing with, without assuming that every file which uses
5872 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5874 reinvoke_input_signal ()
5877 kill (getpid (), SIGIO
);
5883 /* Return the prompt-string of a sparse keymap.
5884 This is the first element which is a string.
5885 Return nil if there is none. */
5893 register Lisp_Object tem
;
5902 static void menu_bar_item ();
5903 static void menu_bar_one_keymap ();
5905 /* These variables hold the vector under construction within
5906 menu_bar_items and its subroutines, and the current index
5907 for storing into that vector. */
5908 static Lisp_Object menu_bar_items_vector
;
5909 static int menu_bar_items_index
;
5911 /* Return a vector of menu items for a menu bar, appropriate
5912 to the current buffer. Each item has three elements in the vector:
5915 OLD is an old vector we can optionally reuse, or nil. */
5918 menu_bar_items (old
)
5921 /* The number of keymaps we're scanning right now, and the number of
5922 keymaps we have allocated space for. */
5925 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5926 in the current keymaps, or nil where it is not a prefix. */
5929 Lisp_Object def
, tem
, tail
;
5938 struct gcpro gcpro1
;
5940 /* In order to build the menus, we need to call the keymap
5941 accessors. They all call QUIT. But this function is called
5942 during redisplay, during which a quit is fatal. So inhibit
5943 quitting while building the menus.
5944 We do this instead of specbind because (1) errors will clear it anyway
5945 and (2) this avoids risk of specpdl overflow. */
5946 oquit
= Vinhibit_quit
;
5950 menu_bar_items_vector
= old
;
5952 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5953 menu_bar_items_index
= 0;
5955 GCPRO1 (menu_bar_items_vector
);
5957 /* Build our list of keymaps.
5958 If we recognize a function key and replace its escape sequence in
5959 keybuf with its symbol, or if the sequence starts with a mouse
5960 click and we need to switch buffers, we jump back here to rebuild
5961 the initial keymaps from the current buffer. */
5965 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5966 if (!NILP (Voverriding_local_map_menu_flag
))
5968 /* Yes, use them (if non-nil) as well as the global map. */
5969 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5971 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5972 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5973 if (!NILP (Voverriding_local_map
))
5974 maps
[nmaps
++] = Voverriding_local_map
;
5978 /* No, so use major and minor mode keymaps and keymap property. */
5980 Lisp_Object map
= get_local_map (PT
, current_buffer
, keymap
);
5983 nmaps
= current_minor_maps (NULL
, &tmaps
);
5984 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
5985 * sizeof (maps
[0]));
5986 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5988 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, keymap
);
5989 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, local_map
);
5991 maps
[nmaps
++] = current_global_map
;
5994 /* Look up in each map the dummy prefix key `menu-bar'. */
5998 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6000 if (! NILP (maps
[mapno
]))
6001 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
6005 tem
= Fkeymapp (def
);
6007 menu_bar_one_keymap (def
);
6010 /* Move to the end those items that should be at the end. */
6012 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6015 int end
= menu_bar_items_index
;
6017 for (i
= 0; i
< end
; i
+= 4)
6018 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6020 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6021 /* Move the item at index I to the end,
6022 shifting all the others forward. */
6023 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6024 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6025 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6026 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6028 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6029 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6030 (end
- i
- 4) * sizeof (Lisp_Object
));
6031 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6032 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6033 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6034 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6039 /* Add nil, nil, nil, nil at the end. */
6040 i
= menu_bar_items_index
;
6041 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6044 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6045 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6046 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6047 menu_bar_items_vector
= tem
;
6049 /* Add this item. */
6050 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6051 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6052 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6053 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6054 menu_bar_items_index
= i
;
6056 Vinhibit_quit
= oquit
;
6058 return menu_bar_items_vector
;
6061 /* Scan one map KEYMAP, accumulating any menu items it defines
6062 in menu_bar_items_vector. */
6064 static Lisp_Object menu_bar_one_keymap_changed_items
;
6067 menu_bar_one_keymap (keymap
)
6070 Lisp_Object tail
, item
;
6072 menu_bar_one_keymap_changed_items
= Qnil
;
6074 /* Loop over all keymap entries that have menu strings. */
6075 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6079 menu_bar_item (XCAR (item
), XCDR (item
));
6080 else if (VECTORP (item
))
6082 /* Loop over the char values represented in the vector. */
6083 int len
= XVECTOR (item
)->size
;
6085 for (c
= 0; c
< len
; c
++)
6087 Lisp_Object character
;
6088 XSETFASTINT (character
, c
);
6089 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6095 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6096 If there's already an item for KEY, add this DEF to it. */
6098 Lisp_Object item_properties
;
6101 menu_bar_item (key
, item
)
6102 Lisp_Object key
, item
;
6104 struct gcpro gcpro1
;
6108 if (EQ (item
, Qundefined
))
6110 /* If a map has an explicit `undefined' as definition,
6111 discard any previously made menu bar item. */
6113 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6114 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6116 if (menu_bar_items_index
> i
+ 4)
6117 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6118 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6119 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6120 menu_bar_items_index
-= 4;
6124 /* If there's no definition for this key yet,
6125 just ignore `undefined'. */
6129 GCPRO1 (key
); /* Is this necessary? */
6130 i
= parse_menu_item (item
, 0, 1);
6135 /* If this keymap has already contributed to this KEY,
6136 don't contribute to it a second time. */
6137 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6141 menu_bar_one_keymap_changed_items
6142 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6144 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6146 /* Find any existing item for this KEY. */
6147 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6148 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6151 /* If we did not find this KEY, add it at the end. */
6152 if (i
== menu_bar_items_index
)
6154 /* If vector is too small, get a bigger one. */
6155 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6158 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6159 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6160 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6161 menu_bar_items_vector
= tem
;
6164 /* Add this item. */
6165 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6166 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6167 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6168 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6169 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6170 menu_bar_items_index
= i
;
6172 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6176 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6177 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6181 /* This is used as the handler when calling menu_item_eval_property. */
6183 menu_item_eval_property_1 (arg
)
6186 /* If we got a quit from within the menu computation,
6187 quit all the way out of it. This takes care of C-] in the debugger. */
6188 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6189 Fsignal (Qquit
, Qnil
);
6194 /* Evaluate an expression and return the result (or nil if something
6195 went wrong). Used to evaluate dynamic parts of menu items. */
6197 menu_item_eval_property (sexpr
)
6200 int count
= specpdl_ptr
- specpdl
;
6202 specbind (Qinhibit_redisplay
, Qt
);
6203 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6204 menu_item_eval_property_1
);
6205 return unbind_to (count
, val
);
6208 /* This function parses a menu item and leaves the result in the
6209 vector item_properties.
6210 ITEM is a key binding, a possible menu item.
6211 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6212 evaluate dynamic expressions in the menu item.
6213 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6215 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6216 parse_menu_item returns true if the item is a menu item and false
6220 parse_menu_item (item
, notreal
, inmenubar
)
6222 int notreal
, inmenubar
;
6224 Lisp_Object def
, tem
, item_string
, start
;
6225 Lisp_Object cachelist
;
6227 Lisp_Object keyhint
;
6238 /* Create item_properties vector if necessary. */
6239 if (NILP (item_properties
))
6241 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6243 /* Initialize optional entries. */
6244 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6245 XVECTOR (item_properties
)->contents
[i
] = Qnil
;
6246 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = Qt
;
6248 /* Save the item here to protect it from GC. */
6249 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ITEM
] = item
;
6251 item_string
= XCAR (item
);
6255 if (STRINGP (item_string
))
6257 /* Old format menu item. */
6258 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
6260 /* Maybe help string. */
6261 if (CONSP (item
) && STRINGP (XCAR (item
)))
6263 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
6269 /* Maybee key binding cache. */
6270 if (CONSP (item
) && CONSP (XCAR (item
))
6271 && (NILP (XCAR (XCAR (item
)))
6272 || VECTORP (XCAR (XCAR (item
)))))
6274 cachelist
= XCAR (item
);
6278 /* This is the real definition--the function to run. */
6279 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = item
;
6281 /* Get enable property, if any. */
6284 tem
= Fget (item
, Qmenu_enable
);
6286 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
6289 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6291 /* New format menu item. */
6292 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
]
6294 start
= XCDR (item
);
6297 /* We have a real binding. */
6298 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
]
6301 item
= XCDR (start
);
6302 /* Is there a cache list with key equivalences. */
6303 if (CONSP (item
) && CONSP (XCAR (item
)))
6305 cachelist
= XCAR (item
);
6309 /* Parse properties. */
6310 while (CONSP (item
) && CONSP (XCDR (item
)))
6315 if (EQ (tem
, QCenable
))
6316 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
]
6318 else if (EQ (tem
, QCvisible
) && !notreal
)
6320 /* If got a visible property and that evaluates to nil
6321 then ignore this item. */
6322 tem
= menu_item_eval_property (XCAR (item
));
6326 else if (EQ (tem
, QChelp
))
6327 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
6329 else if (EQ (tem
, QCfilter
))
6331 else if (EQ (tem
, QCkey_sequence
))
6334 if (NILP (cachelist
)
6335 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6336 /* Be GC protected. Set keyhint to item instead of tem. */
6339 else if (EQ (tem
, QCkeys
))
6342 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6343 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
]
6346 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6351 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6353 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
6355 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
]
6362 else if (inmenubar
|| !NILP (start
))
6366 return 0; /* not a menu item */
6368 /* If item string is not a string, evaluate it to get string.
6369 If we don't get a string, skip this item. */
6370 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6371 if (!(STRINGP (item_string
) || notreal
))
6373 item_string
= menu_item_eval_property (item_string
);
6374 if (!STRINGP (item_string
))
6376 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
6379 /* If got a filter apply it on definition. */
6380 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6383 def
= menu_item_eval_property (list2 (XCAR (filter
),
6384 list2 (Qquote
, def
)));
6386 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = def
;
6389 /* If we got no definition, this item is just unselectable text which
6390 is OK in a submenu but not in the menubar. */
6392 return (inmenubar
? 0 : 1);
6394 /* Enable or disable selection of item. */
6395 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
];
6401 tem
= menu_item_eval_property (tem
);
6402 if (inmenubar
&& NILP (tem
))
6403 return 0; /* Ignore disabled items in menu bar. */
6404 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
6407 /* See if this is a separate pane or a submenu. */
6408 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6409 tem
= get_keymap_1 (def
, 0, 1);
6410 /* For a subkeymap, just record its details and exit. */
6413 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_MAP
] = tem
;
6414 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = tem
;
6417 /* At the top level in the menu bar, do likewise for commands also.
6418 The menu bar does not display equivalent key bindings anyway.
6419 ITEM_PROPERTY_DEF is already set up properly. */
6423 /* This is a command. See if there is an equivalent key binding. */
6424 if (NILP (cachelist
))
6426 /* We have to create a cachelist. */
6427 CHECK_IMPURE (start
);
6428 XCDR (start
) = Fcons (Fcons (Qnil
, Qnil
), XCDR (start
));
6429 cachelist
= XCAR (XCDR (start
));
6431 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6432 if (!NILP (keyhint
))
6434 XCAR (cachelist
) = XCAR (keyhint
);
6437 else if (STRINGP (tem
))
6439 XCDR (cachelist
) = Fsubstitute_command_keys (tem
);
6440 XCAR (cachelist
) = Qt
;
6443 tem
= XCAR (cachelist
);
6450 tem
= Fkey_binding (tem
, Qnil
);
6452 prefix
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6455 def
= XCAR (prefix
);
6456 prefix
= XCDR (prefix
);
6459 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6461 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
6463 if (newcache
/* Always check first time. */
6464 /* Should we check everything when precomputing key
6467 /* If something had no key binding before, don't recheck it
6468 because that is too slow--except if we have a list of
6469 rebound commands in Vdefine_key_rebound_commands, do
6470 recheck any command that appears in that list. */
6471 || (CONSP (Vdefine_key_rebound_commands
)
6472 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
6475 /* We had a saved key. Is it still bound to the command? */
6478 /* If the command is an alias for another
6479 (such as lmenu.el set it up), check if the
6480 original command matches the cached command. */
6481 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
6482 chkcache
= 1; /* Need to recompute key binding. */
6486 /* Recompute equivalent key binding. If the command is an alias
6487 for another (such as lmenu.el set it up), see if the original
6488 command name has equivalent keys. Otherwise look up the
6489 specified command itself. We don't try both, because that
6490 makes lmenu menus slow. */
6491 if (SYMBOLP (def
) && SYMBOLP (XSYMBOL (def
)->function
)
6492 && ! NILP (Fget (def
, Qmenu_alias
)))
6493 def
= XSYMBOL (def
)->function
;
6494 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
6495 XCAR (cachelist
) = tem
;
6498 XCDR (cachelist
) = Qnil
;
6502 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
6504 tem
= XCAR (cachelist
);
6508 newcache
= chkcache
;
6511 tem
= Fkey_description (tem
);
6514 if (STRINGP (XCAR (prefix
)))
6515 tem
= concat2 (XCAR (prefix
), tem
);
6516 if (STRINGP (XCDR (prefix
)))
6517 tem
= concat2 (tem
, XCDR (prefix
));
6519 XCDR (cachelist
) = tem
;
6523 tem
= XCDR (cachelist
);
6524 if (newcache
&& !NILP (tem
))
6526 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
6527 XCDR (cachelist
) = tem
;
6530 /* If we only want to precompute equivalent key bindings, stop here. */
6534 /* If we have an equivalent key binding, use that. */
6535 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
] = tem
;
6537 /* Include this when menu help is implemented.
6538 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
6539 if (!(NILP (tem) || STRINGP (tem)))
6541 tem = menu_item_eval_property (tem);
6544 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
6548 /* Handle radio buttons or toggle boxes. */
6549 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6551 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
6552 = menu_item_eval_property (tem
);
6559 /***********************************************************************
6561 ***********************************************************************/
6563 /* A vector holding tool bar items while they are parsed in function
6564 tool_bar_items runs Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
6567 static Lisp_Object tool_bar_items_vector
;
6569 /* A vector holding the result of parse_tool_bar_item. Layout is like
6570 the one for a single item in tool_bar_items_vector. */
6572 static Lisp_Object tool_bar_item_properties
;
6574 /* Next free index in tool_bar_items_vector. */
6576 static int ntool_bar_items
;
6578 /* The symbols `tool-bar', and `:image'. */
6580 extern Lisp_Object Qtool_bar
;
6581 Lisp_Object QCimage
;
6583 /* Function prototypes. */
6585 static void init_tool_bar_items
P_ ((Lisp_Object
));
6586 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6587 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6588 static void append_tool_bar_item
P_ ((void));
6591 /* Return a vector of tool bar items for keymaps currently in effect.
6592 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
6593 tool bar items found. */
6596 tool_bar_items (reuse
, nitems
)
6604 extern Lisp_Object Voverriding_local_map_menu_flag
;
6605 extern Lisp_Object Voverriding_local_map
;
6609 /* In order to build the menus, we need to call the keymap
6610 accessors. They all call QUIT. But this function is called
6611 during redisplay, during which a quit is fatal. So inhibit
6612 quitting while building the menus. We do this instead of
6613 specbind because (1) errors will clear it anyway and (2) this
6614 avoids risk of specpdl overflow. */
6615 oquit
= Vinhibit_quit
;
6618 /* Initialize tool_bar_items_vector and protect it from GC. */
6619 init_tool_bar_items (reuse
);
6621 /* Build list of keymaps in maps. Set nmaps to the number of maps
6624 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6625 if (!NILP (Voverriding_local_map_menu_flag
))
6627 /* Yes, use them (if non-nil) as well as the global map. */
6628 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6630 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6631 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6632 if (!NILP (Voverriding_local_map
))
6633 maps
[nmaps
++] = Voverriding_local_map
;
6637 /* No, so use major and minor mode keymaps and keymap property. */
6639 Lisp_Object map
= get_local_map (PT
, current_buffer
, keymap
);
6642 nmaps
= current_minor_maps (NULL
, &tmaps
);
6643 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
6644 * sizeof (maps
[0]));
6645 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6647 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, keymap
);
6648 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, local_map
);
6651 /* Add global keymap at the end. */
6652 maps
[nmaps
++] = current_global_map
;
6654 /* Process maps in reverse order and look up in each map the prefix
6656 for (i
= nmaps
- 1; i
>= 0; --i
)
6657 if (!NILP (maps
[i
]))
6661 keymap
= get_keyelt (access_keymap (maps
[i
], Qtool_bar
, 1, 1), 0);
6662 if (!NILP (Fkeymapp (keymap
)))
6666 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
6667 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6669 Lisp_Object keydef
= XCAR (tail
);
6671 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
6676 Vinhibit_quit
= oquit
;
6677 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
6678 return tool_bar_items_vector
;
6682 /* Process the definition of KEY which is DEF. */
6685 process_tool_bar_item (key
, def
)
6686 Lisp_Object key
, def
;
6689 extern Lisp_Object Qundefined
;
6690 struct gcpro gcpro1
, gcpro2
;
6692 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
6696 if (EQ (def
, Qundefined
))
6698 /* If a map has an explicit `undefined' as definition,
6699 discard any previously made item. */
6700 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
6702 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
6704 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
6706 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
6707 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
6708 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
6709 * sizeof (Lisp_Object
)));
6710 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
6715 else if (parse_tool_bar_item (key
, def
))
6716 /* Append a new tool bar item to tool_bar_items_vector. Accept
6717 more than one definition for the same key. */
6718 append_tool_bar_item ();
6724 /* Parse a tool bar item specification ITEM for key KEY and return the
6725 result in tool_bar_item_properties. Value is zero if ITEM is
6728 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
6730 CAPTION is the caption of the item, If it's not a string, it is
6731 evaluated to get a string.
6733 BINDING is the tool bar item's binding. Tool-bar items with keymaps
6734 as binding are currently ignored.
6736 The following properties are recognized:
6740 FORM is evaluated and specifies whether the tool bar item is
6741 enabled or disabled.
6745 FORM is evaluated and specifies whether the tool bar item is visible.
6747 - `:filter FUNCTION'
6749 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
6750 result is stored as the new binding.
6752 - `:button (TYPE SELECTED)'
6754 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
6755 and specifies whether the button is selected (pressed) or not.
6759 IMAGES is either a single image specification or a vector of four
6760 image specifications. See enum tool_bar_item_images.
6762 - `:help HELP-STRING'.
6764 Gives a help string to display for the tool bar item. */
6767 parse_tool_bar_item (key
, item
)
6768 Lisp_Object key
, item
;
6770 /* Access slot with index IDX of vector tool_bar_item_properties. */
6771 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
6773 Lisp_Object filter
= Qnil
;
6774 Lisp_Object caption
;
6775 extern Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
;
6776 extern Lisp_Object QCbutton
, QCtoggle
, QCradio
;
6779 /* Defininition looks like `(tool-bar-item CAPTION BINDING
6780 PROPS...)'. Rule out items that aren't lists, don't start with
6781 `tool-bar-item' or whose rest following `tool-bar-item' is not a
6784 || !EQ (XCAR (item
), Qmenu_item
)
6785 || (item
= XCDR (item
),
6789 /* Create tool_bar_item_properties vector if necessary. Reset it to
6791 if (VECTORP (tool_bar_item_properties
))
6793 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
6797 tool_bar_item_properties
6798 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
6801 PROP (TOOL_BAR_ITEM_KEY
) = key
;
6802 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
6804 /* Get the caption of the item. If the caption is not a string,
6805 evaluate it to get a string. If we don't get a string, skip this
6807 caption
= XCAR (item
);
6808 if (!STRINGP (caption
))
6810 caption
= menu_item_eval_property (caption
);
6811 if (!STRINGP (caption
))
6814 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
6816 /* Give up if rest following the caption is not a list. */
6821 /* Store the binding. */
6822 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
6825 /* Process the rest of the properties. */
6826 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
6828 Lisp_Object key
, value
;
6831 value
= XCAR (XCDR (item
));
6833 if (EQ (key
, QCenable
))
6834 /* `:enable FORM'. */
6835 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
6836 else if (EQ (key
, QCvisible
))
6838 /* `:visible FORM'. If got a visible property and that
6839 evaluates to nil then ignore this item. */
6840 if (NILP (menu_item_eval_property (value
)))
6843 else if (EQ (key
, QChelp
))
6844 /* `:help HELP-STRING'. */
6845 PROP (TOOL_BAR_ITEM_HELP
) = value
;
6846 else if (EQ (key
, QCfilter
))
6847 /* ':filter FORM'. */
6849 else if (EQ (key
, QCbutton
) && CONSP (value
))
6851 /* `:button (TYPE . SELECTED)'. */
6852 Lisp_Object type
, selected
;
6854 type
= XCAR (value
);
6855 selected
= XCDR (value
);
6856 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6858 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
6859 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
6862 else if (EQ (key
, QCimage
)
6864 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
6865 /* Value is either a single image specification or a vector
6866 of 4 such specifications for the different buttion states. */
6867 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
6870 /* If got a filter apply it on binding. */
6872 PROP (TOOL_BAR_ITEM_BINDING
)
6873 = menu_item_eval_property (list2 (filter
,
6875 PROP (TOOL_BAR_ITEM_BINDING
))));
6877 /* See if the binding is a keymap. Give up if it is. */
6878 if (!NILP (get_keymap_1 (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
6881 /* Enable or disable selection of item. */
6882 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
6883 PROP (TOOL_BAR_ITEM_ENABLED_P
)
6884 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
6886 /* Handle radio buttons or toggle boxes. */
6887 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
6888 PROP (TOOL_BAR_ITEM_SELECTED_P
)
6889 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
6897 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
6898 that can be reused. */
6901 init_tool_bar_items (reuse
)
6904 if (VECTORP (reuse
))
6905 tool_bar_items_vector
= reuse
;
6907 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
6908 ntool_bar_items
= 0;
6912 /* Append parsed tool bar item properties from
6913 tool_bar_item_properties */
6916 append_tool_bar_item ()
6918 Lisp_Object
*to
, *from
;
6920 /* Enlarge tool_bar_items_vector if necessary. */
6921 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
6922 >= XVECTOR (tool_bar_items_vector
)->size
)
6924 Lisp_Object new_vector
;
6925 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
6927 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
6928 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
6929 XVECTOR (new_vector
)->contents
,
6930 old_size
* sizeof (Lisp_Object
));
6931 tool_bar_items_vector
= new_vector
;
6934 /* Append entries from tool_bar_item_properties to the end of
6935 tool_bar_items_vector. */
6936 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
6937 from
= XVECTOR (tool_bar_item_properties
)->contents
;
6938 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
6939 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
6946 /* Read a character using menus based on maps in the array MAPS.
6947 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
6948 Return t if we displayed a menu but the user rejected it.
6950 PREV_EVENT is the previous input event, or nil if we are reading
6951 the first event of a key sequence.
6953 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
6954 if we used a mouse menu to read the input, or zero otherwise. If
6955 USED_MOUSE_MENU is null, we don't dereference it.
6957 The prompting is done based on the prompt-string of the map
6958 and the strings associated with various map elements.
6960 This can be done with X menus or with menus put in the minibuf.
6961 These are done in different ways, depending on how the input will be read.
6962 Menus using X are done after auto-saving in read-char, getting the input
6963 event from Fx_popup_menu; menus using the minibuf use read_char recursively
6964 and do auto-saving in the inner call of read_char. */
6967 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
6970 Lisp_Object prev_event
;
6971 int *used_mouse_menu
;
6974 register Lisp_Object name
;
6976 if (used_mouse_menu
)
6977 *used_mouse_menu
= 0;
6979 /* Use local over global Menu maps */
6981 if (! menu_prompting
)
6984 /* Optionally disregard all but the global map. */
6985 if (inhibit_local_menu_bar_menus
)
6987 maps
+= (nmaps
- 1);
6991 /* Get the menu name from the first map that has one (a prompt string). */
6992 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6994 name
= map_prompt (maps
[mapno
]);
6999 /* If we don't have any menus, just read a character normally. */
7004 /* If we got to this point via a mouse click,
7005 use a real menu for mouse selection. */
7006 if (EVENT_HAS_PARAMETERS (prev_event
)
7007 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7008 && !EQ (XCAR (prev_event
), Qtool_bar
))
7010 /* Display the menu and get the selection. */
7011 Lisp_Object
*realmaps
7012 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7016 /* Use the maps that are not nil. */
7017 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7018 if (!NILP (maps
[mapno
]))
7019 realmaps
[nmaps1
++] = maps
[mapno
];
7021 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7026 record_menu_key (XCAR (value
));
7028 /* If we got multiple events, unread all but
7030 There is no way to prevent those unread events
7031 from showing up later in last_nonmenu_event.
7032 So turn symbol and integer events into lists,
7033 to indicate that they came from a mouse menu,
7034 so that when present in last_nonmenu_event
7035 they won't confuse things. */
7036 for (tem
= XCDR (value
); !NILP (tem
);
7039 record_menu_key (XCAR (tem
));
7040 if (SYMBOLP (XCAR (tem
))
7041 || INTEGERP (XCAR (tem
)))
7043 = Fcons (XCAR (tem
), Qnil
);
7046 /* If we got more than one event, put all but the first
7047 onto this list to be read later.
7048 Return just the first event now. */
7049 Vunread_command_events
7050 = nconc2 (XCDR (value
), Vunread_command_events
);
7051 value
= XCAR (value
);
7053 else if (NILP (value
))
7055 if (used_mouse_menu
)
7056 *used_mouse_menu
= 1;
7059 #endif /* HAVE_MENUS */
7063 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7064 We make this bigger when necessary, and never free it. */
7065 static char *read_char_minibuf_menu_text
;
7066 /* Size of that buffer. */
7067 static int read_char_minibuf_menu_width
;
7070 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7076 register Lisp_Object name
;
7078 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7081 Lisp_Object rest
, vector
;
7084 if (! menu_prompting
)
7087 /* Make sure we have a big enough buffer for the menu text. */
7088 if (read_char_minibuf_menu_text
== 0)
7090 read_char_minibuf_menu_width
= width
+ 4;
7091 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7093 else if (width
+ 4 > read_char_minibuf_menu_width
)
7095 read_char_minibuf_menu_width
= width
+ 4;
7096 read_char_minibuf_menu_text
7097 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7099 menu
= read_char_minibuf_menu_text
;
7101 /* Get the menu name from the first map that has one (a prompt string). */
7102 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7104 name
= map_prompt (maps
[mapno
]);
7109 /* If we don't have any menus, just read a character normally. */
7113 /* Prompt string always starts with map's prompt, and a space. */
7114 strcpy (menu
, XSTRING (name
)->data
);
7115 nlength
= STRING_BYTES (XSTRING (name
));
7116 menu
[nlength
++] = ':';
7117 menu
[nlength
++] = ' ';
7120 /* Start prompting at start of first map. */
7124 /* Present the documented bindings, a line at a time. */
7131 Lisp_Object orig_defn_macro
;
7133 /* Loop over elements of map. */
7138 /* If reached end of map, start at beginning of next map. */
7142 /* At end of last map, wrap around to first map if just starting,
7143 or end this line if already have something on it. */
7147 if (notfirst
|| nobindings
) break;
7152 /* Look at the next element of the map. */
7154 elt
= XVECTOR (vector
)->contents
[idx
];
7156 elt
= Fcar_safe (rest
);
7158 if (idx
< 0 && VECTORP (elt
))
7160 /* If we found a dense table in the keymap,
7161 advanced past it, but start scanning its contents. */
7162 rest
= Fcdr_safe (rest
);
7168 /* An ordinary element. */
7169 Lisp_Object event
, tem
;
7173 event
= Fcar_safe (elt
); /* alist */
7174 elt
= Fcdr_safe (elt
);
7178 XSETINT (event
, idx
); /* vector */
7181 /* Ignore the element if it has no prompt string. */
7182 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7184 /* 1 if the char to type matches the string. */
7186 Lisp_Object upcased_event
, downcased_event
;
7189 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7191 upcased_event
= Fupcase (event
);
7192 downcased_event
= Fdowncase (event
);
7193 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
7194 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
7196 desc
= Fsingle_key_description (event
);
7199 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7201 /* Insert equivalent keybinding. */
7202 s
= concat2 (s
, tem
);
7205 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7206 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7208 /* Insert button prefix. */
7209 Lisp_Object selected
7210 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7211 if (EQ (tem
, QCradio
))
7212 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7214 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7215 s
= concat2 (tem
, s
);
7219 /* If we have room for the prompt string, add it to this line.
7220 If this is the first on the line, always add it. */
7221 if ((XSTRING (s
)->size
+ i
+ 2
7222 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
7228 /* Punctuate between strings. */
7231 strcpy (menu
+ i
, ", ");
7237 /* If the char to type doesn't match the string's
7238 first char, explicitly show what char to type. */
7241 /* Add as much of string as fits. */
7242 thiswidth
= XSTRING (desc
)->size
;
7243 if (thiswidth
+ i
> width
)
7244 thiswidth
= width
- i
;
7245 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
7247 strcpy (menu
+ i
, " = ");
7251 /* Add as much of string as fits. */
7252 thiswidth
= XSTRING (s
)->size
;
7253 if (thiswidth
+ i
> width
)
7254 thiswidth
= width
- i
;
7255 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
7261 /* If this element does not fit, end the line now,
7262 and save the element for the next line. */
7263 strcpy (menu
+ i
, "...");
7268 /* Move past this element. */
7269 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7270 /* Handle reaching end of dense table. */
7275 rest
= Fcdr_safe (rest
);
7279 /* Prompt with that and read response. */
7280 message2_nolog (menu
, strlen (menu
),
7281 ! NILP (current_buffer
->enable_multibyte_characters
));
7283 /* Make believe its not a keyboard macro in case the help char
7284 is pressed. Help characters are not recorded because menu prompting
7285 is not used on replay.
7287 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7288 current_kboard
->defining_kbd_macro
= Qnil
;
7290 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
7291 while (BUFFERP (obj
));
7292 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7294 if (!INTEGERP (obj
))
7299 if (! EQ (obj
, menu_prompt_more_char
)
7300 && (!INTEGERP (menu_prompt_more_char
)
7301 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7303 if (!NILP (current_kboard
->defining_kbd_macro
))
7304 store_kbd_macro_char (obj
);
7307 /* Help char - go round again */
7311 /* Reading key sequences. */
7313 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7314 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7315 keymap, or nil otherwise. Return the index of the first keymap in
7316 which KEY has any binding, or NMAPS if no map has a binding.
7318 If KEY is a meta ASCII character, treat it like meta-prefix-char
7319 followed by the corresponding non-meta character. Keymaps in
7320 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7323 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7326 NEXT may be the same array as CURRENT. */
7329 follow_key (key
, nmaps
, current
, defs
, next
)
7331 Lisp_Object
*current
, *defs
, *next
;
7334 int i
, first_binding
;
7337 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
7338 followed by the corresponding non-meta character.
7339 Put the results into DEFS, since we are going to alter that anyway.
7340 Do not alter CURRENT or NEXT. */
7341 if (INTEGERP (key
) && (XUINT (key
) & CHAR_META
))
7343 for (i
= 0; i
< nmaps
; i
++)
7344 if (! NILP (current
[i
]))
7347 def
= get_keyelt (access_keymap (current
[i
],
7348 meta_prefix_char
, 1, 0), 0);
7350 /* Note that since we pass the resulting bindings through
7351 get_keymap_1, non-prefix bindings for meta-prefix-char
7353 defs
[i
] = get_keymap_1 (def
, 0, 1);
7359 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
7362 first_binding
= nmaps
;
7363 for (i
= nmaps
- 1; i
>= 0; i
--)
7365 if (! NILP (current
[i
]))
7373 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
7374 if (! NILP (defs
[i
]))
7381 /* Given the set of bindings we've found, produce the next set of maps. */
7382 if (first_binding
< nmaps
)
7383 for (i
= 0; i
< nmaps
; i
++)
7384 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
7386 return first_binding
;
7389 /* Read a sequence of keys that ends with a non prefix character,
7390 storing it in KEYBUF, a buffer of size BUFSIZE.
7392 Return the length of the key sequence stored.
7393 Return -1 if the user rejected a command menu.
7395 Echo starting immediately unless `prompt' is 0.
7397 Where a key sequence ends depends on the currently active keymaps.
7398 These include any minor mode keymaps active in the current buffer,
7399 the current buffer's local map, and the global map.
7401 If a key sequence has no other bindings, we check Vfunction_key_map
7402 to see if some trailing subsequence might be the beginning of a
7403 function key's sequence. If so, we try to read the whole function
7404 key, and substitute its symbolic name into the key sequence.
7406 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7407 `double-' events into similar click events, if that would make them
7408 bound. We try to turn `triple-' events first into `double-' events,
7411 If we get a mouse click in a mode line, vertical divider, or other
7412 non-text area, we treat the click as if it were prefixed by the
7413 symbol denoting that area - `mode-line', `vertical-line', or
7416 If the sequence starts with a mouse click, we read the key sequence
7417 with respect to the buffer clicked on, not the current buffer.
7419 If the user switches frames in the midst of a key sequence, we put
7420 off the switch-frame event until later; the next call to
7421 read_char will return it.
7423 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7424 from the selected window's buffer. */
7427 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
7428 can_return_switch_frame
, fix_current_buffer
)
7429 Lisp_Object
*keybuf
;
7432 int dont_downcase_last
;
7433 int can_return_switch_frame
;
7434 int fix_current_buffer
;
7436 int count
= specpdl_ptr
- specpdl
;
7438 /* How many keys there are in the current key sequence. */
7441 /* The length of the echo buffer when we started reading, and
7442 the length of this_command_keys when we started reading. */
7446 /* The number of keymaps we're scanning right now, and the number of
7447 keymaps we have allocated space for. */
7449 int nmaps_allocated
= 0;
7451 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
7452 the current keymaps. */
7455 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7456 in the current keymaps, or nil where it is not a prefix. */
7457 Lisp_Object
*submaps
;
7459 /* The local map to start out with at start of key sequence. */
7460 Lisp_Object orig_local_map
;
7462 /* The map from the `keymap' property to start out with at start of
7464 Lisp_Object orig_keymap
;
7466 /* 1 if we have already considered switching to the local-map property
7467 of the place where a mouse click occurred. */
7468 int localized_local_map
= 0;
7470 /* The index in defs[] of the first keymap that has a binding for
7471 this key sequence. In other words, the lowest i such that
7472 defs[i] is non-nil. */
7475 /* If t < mock_input, then KEYBUF[t] should be read as the next
7478 We use this to recover after recognizing a function key. Once we
7479 realize that a suffix of the current key sequence is actually a
7480 function key's escape sequence, we replace the suffix with the
7481 function key's binding from Vfunction_key_map. Now keybuf
7482 contains a new and different key sequence, so the echo area,
7483 this_command_keys, and the submaps and defs arrays are wrong. In
7484 this situation, we set mock_input to t, set t to 0, and jump to
7485 restart_sequence; the loop will read keys from keybuf up until
7486 mock_input, thus rebuilding the state; and then it will resume
7487 reading characters from the keyboard. */
7490 /* If the sequence is unbound in submaps[], then
7491 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
7492 and fkey_map is its binding.
7494 These might be > t, indicating that all function key scanning
7495 should hold off until t reaches them. We do this when we've just
7496 recognized a function key, to avoid searching for the function
7497 key's again in Vfunction_key_map. */
7498 int fkey_start
= 0, fkey_end
= 0;
7499 Lisp_Object fkey_map
;
7501 /* Likewise, for key_translation_map. */
7502 int keytran_start
= 0, keytran_end
= 0;
7503 Lisp_Object keytran_map
;
7505 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
7506 we put it off for later. While we're reading, we keep the event here. */
7507 Lisp_Object delayed_switch_frame
;
7509 /* See the comment below... */
7510 #if defined (GOBBLE_FIRST_EVENT)
7511 Lisp_Object first_event
;
7514 Lisp_Object original_uppercase
;
7515 int original_uppercase_position
= -1;
7517 /* Gets around Microsoft compiler limitations. */
7520 struct buffer
*starting_buffer
;
7522 /* Nonzero if we seem to have got the beginning of a binding
7523 in function_key_map. */
7524 int function_key_possible
= 0;
7525 int key_translation_possible
= 0;
7527 /* Save the status of key translation before each step,
7528 so that we can restore this after downcasing. */
7529 Lisp_Object prev_fkey_map
;
7530 int prev_fkey_start
;
7533 Lisp_Object prev_keytran_map
;
7534 int prev_keytran_start
;
7535 int prev_keytran_end
;
7537 #if defined (GOBBLE_FIRST_EVENT)
7541 raw_keybuf_count
= 0;
7543 last_nonmenu_event
= Qnil
;
7545 delayed_switch_frame
= Qnil
;
7546 fkey_map
= Vfunction_key_map
;
7547 keytran_map
= Vkey_translation_map
;
7549 /* If there is no function-key-map, turn off function key scanning. */
7550 if (NILP (Fkeymapp (Vfunction_key_map
)))
7551 fkey_start
= fkey_end
= bufsize
+ 1;
7553 /* If there is no key-translation-map, turn off scanning. */
7554 if (NILP (Fkeymapp (Vkey_translation_map
)))
7555 keytran_start
= keytran_end
= bufsize
+ 1;
7560 echo_prompt (XSTRING (prompt
)->data
);
7561 else if (cursor_in_echo_area
7562 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
7563 && NILP (Fzerop (Vecho_keystrokes
)))
7564 /* This doesn't put in a dash if the echo buffer is empty, so
7565 you don't always see a dash hanging out in the minibuffer. */
7569 /* Record the initial state of the echo area and this_command_keys;
7570 we will need to restore them if we replay a key sequence. */
7572 echo_start
= echo_length ();
7573 keys_start
= this_command_key_count
;
7574 this_single_command_key_start
= keys_start
;
7576 #if defined (GOBBLE_FIRST_EVENT)
7577 /* This doesn't quite work, because some of the things that read_char
7578 does cannot safely be bypassed. It seems too risky to try to make
7581 /* Read the first char of the sequence specially, before setting
7582 up any keymaps, in case a filter runs and switches buffers on us. */
7583 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
7585 #endif /* GOBBLE_FIRST_EVENT */
7587 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7588 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7590 /* We jump here when the key sequence has been thoroughly changed, and
7591 we need to rescan it starting from the beginning. When we jump here,
7592 keybuf[0..mock_input] holds the sequence we should reread. */
7595 starting_buffer
= current_buffer
;
7596 function_key_possible
= 0;
7597 key_translation_possible
= 0;
7599 /* Build our list of keymaps.
7600 If we recognize a function key and replace its escape sequence in
7601 keybuf with its symbol, or if the sequence starts with a mouse
7602 click and we need to switch buffers, we jump back here to rebuild
7603 the initial keymaps from the current buffer. */
7607 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
7608 || !NILP (Voverriding_local_map
))
7610 if (3 > nmaps_allocated
)
7612 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
7613 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
7614 nmaps_allocated
= 3;
7617 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7618 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7619 if (!NILP (Voverriding_local_map
))
7620 submaps
[nmaps
++] = Voverriding_local_map
;
7625 nmaps
= current_minor_maps (0, &maps
);
7626 if (!NILP (orig_keymap
))
7628 if (nmaps
+ extra_maps
> nmaps_allocated
)
7630 submaps
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7631 * sizeof (submaps
[0]));
7632 defs
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7633 * sizeof (defs
[0]));
7634 nmaps_allocated
= nmaps
+ extra_maps
;
7636 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
7637 if (!NILP (orig_keymap
))
7638 submaps
[nmaps
++] = orig_keymap
;
7639 submaps
[nmaps
++] = orig_local_map
;
7641 submaps
[nmaps
++] = current_global_map
;
7644 /* Find an accurate initial value for first_binding. */
7645 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
7646 if (! NILP (submaps
[first_binding
]))
7649 /* Start from the beginning in keybuf. */
7652 /* These are no-ops the first time through, but if we restart, they
7653 revert the echo area and this_command_keys to their original state. */
7654 this_command_key_count
= keys_start
;
7655 if (INTERACTIVE
&& t
< mock_input
)
7656 echo_truncate (echo_start
);
7658 /* If the best binding for the current key sequence is a keymap, or
7659 we may be looking at a function key's escape sequence, keep on
7661 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
7662 || (first_binding
>= nmaps
7664 /* mock input is never part of a function key's sequence. */
7665 && mock_input
<= fkey_start
)
7666 || (first_binding
>= nmaps
7667 && keytran_start
< t
&& key_translation_possible
)
7668 /* Don't return in the middle of a possible function key sequence,
7669 if the only bindings we found were via case conversion.
7670 Thus, if ESC O a has a function-key-map translation
7671 and ESC o has a binding, don't return after ESC O,
7672 so that we can translate ESC O plus the next character. */
7676 int used_mouse_menu
= 0;
7678 /* Where the last real key started. If we need to throw away a
7679 key that has expanded into more than one element of keybuf
7680 (say, a mouse click on the mode line which is being treated
7681 as [mode-line (mouse-...)], then we backtrack to this point
7683 int last_real_key_start
;
7685 /* These variables are analogous to echo_start and keys_start;
7686 while those allow us to restart the entire key sequence,
7687 echo_local_start and keys_local_start allow us to throw away
7689 int echo_local_start
, keys_local_start
, local_first_binding
;
7692 error ("Key sequence too long");
7695 echo_local_start
= echo_length ();
7696 keys_local_start
= this_command_key_count
;
7697 local_first_binding
= first_binding
;
7700 /* These are no-ops, unless we throw away a keystroke below and
7701 jumped back up to replay_key; in that case, these restore the
7702 variables to their original state, allowing us to replay the
7704 if (INTERACTIVE
&& t
< mock_input
)
7705 echo_truncate (echo_local_start
);
7706 this_command_key_count
= keys_local_start
;
7707 first_binding
= local_first_binding
;
7709 /* By default, assume each event is "real". */
7710 last_real_key_start
= t
;
7712 /* Does mock_input indicate that we are re-reading a key sequence? */
7716 add_command_key (key
);
7717 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
7718 && NILP (Fzerop (Vecho_keystrokes
)))
7722 /* If not, we should actually read a character. */
7727 KBOARD
*interrupted_kboard
= current_kboard
;
7728 struct frame
*interrupted_frame
= SELECTED_FRAME ();
7729 if (setjmp (wrong_kboard_jmpbuf
))
7731 if (!NILP (delayed_switch_frame
))
7733 interrupted_kboard
->kbd_queue
7734 = Fcons (delayed_switch_frame
,
7735 interrupted_kboard
->kbd_queue
);
7736 delayed_switch_frame
= Qnil
;
7739 interrupted_kboard
->kbd_queue
7740 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
7742 /* If the side queue is non-empty, ensure it begins with a
7743 switch-frame, so we'll replay it in the right context. */
7744 if (CONSP (interrupted_kboard
->kbd_queue
)
7745 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
7746 !(EVENT_HAS_PARAMETERS (key
)
7747 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
7751 XSETFRAME (frame
, interrupted_frame
);
7752 interrupted_kboard
->kbd_queue
7753 = Fcons (make_lispy_switch_frame (frame
),
7754 interrupted_kboard
->kbd_queue
);
7757 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7758 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7759 goto replay_sequence
;
7762 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
7766 /* read_char returns t when it shows a menu and the user rejects it.
7770 unbind_to (count
, Qnil
);
7774 /* read_char returns -1 at the end of a macro.
7775 Emacs 18 handles this by returning immediately with a
7776 zero, so that's what we'll do. */
7777 if (INTEGERP (key
) && XINT (key
) == -1)
7780 /* The Microsoft C compiler can't handle the goto that
7786 /* If the current buffer has been changed from under us, the
7787 keymap may have changed, so replay the sequence. */
7791 /* Reset the current buffer from the selected window
7792 in case something changed the former and not the latter.
7793 This is to be more consistent with the behavior
7794 of the command_loop_1. */
7795 if (fix_current_buffer
)
7797 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7799 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
7800 Fset_buffer (XWINDOW (selected_window
)->buffer
);
7803 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7804 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7805 goto replay_sequence
;
7808 /* If we have a quit that was typed in another frame, and
7809 quit_throw_to_read_char switched buffers,
7810 replay to get the right keymap. */
7811 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
7814 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7818 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7819 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7820 goto replay_sequence
;
7825 if (EVENT_HAS_PARAMETERS (key
)
7826 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
7828 /* If we're at the beginning of a key sequence, and the caller
7829 says it's okay, go ahead and return this event. If we're
7830 in the midst of a key sequence, delay it until the end. */
7831 if (t
> 0 || !can_return_switch_frame
)
7833 delayed_switch_frame
= key
;
7839 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7842 /* Clicks in non-text areas get prefixed by the symbol
7843 in their CHAR-ADDRESS field. For example, a click on
7844 the mode line is prefixed by the symbol `mode-line'.
7846 Furthermore, key sequences beginning with mouse clicks
7847 are read using the keymaps of the buffer clicked on, not
7848 the current buffer. So we may have to switch the buffer
7851 When we turn one event into two events, we must make sure
7852 that neither of the two looks like the original--so that,
7853 if we replay the events, they won't be expanded again.
7854 If not for this, such reexpansion could happen either here
7855 or when user programs play with this-command-keys. */
7856 if (EVENT_HAS_PARAMETERS (key
))
7860 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
7861 if (EQ (kind
, Qmouse_click
))
7863 Lisp_Object window
, posn
;
7865 window
= POSN_WINDOW (EVENT_START (key
));
7866 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
7870 /* We're looking at the second event of a
7871 sequence which we expanded before. Set
7872 last_real_key_start appropriately. */
7874 last_real_key_start
= t
- 1;
7877 /* Key sequences beginning with mouse clicks are
7878 read using the keymaps in the buffer clicked on,
7879 not the current buffer. If we're at the
7880 beginning of a key sequence, switch buffers. */
7881 if (last_real_key_start
== 0
7883 && BUFFERP (XWINDOW (window
)->buffer
)
7884 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
7886 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7890 /* Arrange to go back to the original buffer once we're
7891 done reading the key sequence. Note that we can't
7892 use save_excursion_{save,restore} here, because they
7893 save point as well as the current buffer; we don't
7894 want to save point, because redisplay may change it,
7895 to accommodate a Fset_window_start or something. We
7896 don't want to do this at the top of the function,
7897 because we may get input from a subprocess which
7898 wants to change the selected window and stuff (say,
7900 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
7902 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7904 set_buffer_internal (XBUFFER (XWINDOW
7907 orig_local_map
= get_local_map (PT
, current_buffer
,
7909 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7910 goto replay_sequence
;
7913 /* For a mouse click, get the local text-property keymap
7914 of the place clicked on, rather than point. */
7915 if (last_real_key_start
== 0
7916 && CONSP (XCDR (key
))
7917 && ! localized_local_map
)
7919 Lisp_Object map_here
, start
, pos
;
7921 localized_local_map
= 1;
7922 start
= EVENT_START (key
);
7924 if (CONSP (start
) && CONSP (XCDR (start
)))
7926 pos
= POSN_BUFFER_POSN (start
);
7928 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
7930 map_here
= get_local_map (XINT (pos
),
7931 current_buffer
, local_map
);
7932 if (!EQ (map_here
, orig_local_map
))
7934 orig_local_map
= map_here
;
7938 goto replay_sequence
;
7940 map_here
= get_local_map (XINT (pos
),
7941 current_buffer
, keymap
);
7942 if (!EQ (map_here
, orig_keymap
))
7944 orig_keymap
= map_here
;
7948 goto replay_sequence
;
7954 /* Expand mode-line and scroll-bar events into two events:
7955 use posn as a fake prefix key. */
7958 if (t
+ 1 >= bufsize
)
7959 error ("Key sequence too long");
7964 /* Zap the position in key, so we know that we've
7965 expanded it, and don't try to do so again. */
7966 POSN_BUFFER_POSN (EVENT_START (key
))
7967 = Fcons (posn
, Qnil
);
7969 /* If on a mode line string with a local keymap,
7970 reconsider the key sequence with that keymap. */
7971 if (CONSP (POSN_STRING (EVENT_START (key
))))
7973 Lisp_Object string
, pos
, map
, map2
;
7975 string
= POSN_STRING (EVENT_START (key
));
7976 pos
= XCDR (string
);
7977 string
= XCAR (string
);
7979 && XINT (pos
) < XSTRING (string
)->size
)
7981 map
= Fget_text_property (pos
, Qlocal_map
, string
);
7983 orig_local_map
= map
;
7984 map2
= Fget_text_property (pos
, Qkeymap
, string
);
7987 if (!NILP (map
) || !NILP (map2
))
7988 goto replay_sequence
;
7995 else if (CONSP (XCDR (key
))
7996 && CONSP (EVENT_START (key
))
7997 && CONSP (XCDR (EVENT_START (key
))))
8001 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8002 /* Handle menu-bar events:
8003 insert the dummy prefix event `menu-bar'. */
8004 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8006 if (t
+ 1 >= bufsize
)
8007 error ("Key sequence too long");
8011 /* Zap the position in key, so we know that we've
8012 expanded it, and don't try to do so again. */
8013 POSN_BUFFER_POSN (EVENT_START (key
))
8014 = Fcons (posn
, Qnil
);
8017 goto replay_sequence
;
8019 else if (CONSP (posn
))
8021 /* We're looking at the second event of a
8022 sequence which we expanded before. Set
8023 last_real_key_start appropriately. */
8024 if (last_real_key_start
== t
&& t
> 0)
8025 last_real_key_start
= t
- 1;
8030 /* We have finally decided that KEY is something we might want
8032 first_binding
= (follow_key (key
,
8033 nmaps
- first_binding
,
8034 submaps
+ first_binding
,
8035 defs
+ first_binding
,
8036 submaps
+ first_binding
)
8039 /* If KEY wasn't bound, we'll try some fallbacks. */
8040 if (first_binding
>= nmaps
)
8044 head
= EVENT_HEAD (key
);
8045 if (help_char_p (head
) && t
> 0)
8047 read_key_sequence_cmd
= Vprefix_help_command
;
8049 last_nonmenu_event
= key
;
8050 /* The Microsoft C compiler can't handle the goto that
8058 Lisp_Object breakdown
;
8061 breakdown
= parse_modifiers (head
);
8062 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8063 /* Attempt to reduce an unbound mouse event to a simpler
8064 event that is bound:
8065 Drags reduce to clicks.
8066 Double-clicks reduce to clicks.
8067 Triple-clicks reduce to double-clicks, then to clicks.
8068 Down-clicks are eliminated.
8069 Double-downs reduce to downs, then are eliminated.
8070 Triple-downs reduce to double-downs, then to downs,
8071 then are eliminated. */
8072 if (modifiers
& (down_modifier
| drag_modifier
8073 | double_modifier
| triple_modifier
))
8075 while (modifiers
& (down_modifier
| drag_modifier
8076 | double_modifier
| triple_modifier
))
8078 Lisp_Object new_head
, new_click
;
8079 if (modifiers
& triple_modifier
)
8080 modifiers
^= (double_modifier
| triple_modifier
);
8081 else if (modifiers
& double_modifier
)
8082 modifiers
&= ~double_modifier
;
8083 else if (modifiers
& drag_modifier
)
8084 modifiers
&= ~drag_modifier
;
8087 /* Dispose of this `down' event by simply jumping
8088 back to replay_key, to get another event.
8090 Note that if this event came from mock input,
8091 then just jumping back to replay_key will just
8092 hand it to us again. So we have to wipe out any
8095 We could delete keybuf[t] and shift everything
8096 after that to the left by one spot, but we'd also
8097 have to fix up any variable that points into
8098 keybuf, and shifting isn't really necessary
8101 Adding prefixes for non-textual mouse clicks
8102 creates two characters of mock input, and both
8103 must be thrown away. If we're only looking at
8104 the prefix now, we can just jump back to
8105 replay_key. On the other hand, if we've already
8106 processed the prefix, and now the actual click
8107 itself is giving us trouble, then we've lost the
8108 state of the keymaps we want to backtrack to, and
8109 we need to replay the whole sequence to rebuild
8112 Beyond that, only function key expansion could
8113 create more than two keys, but that should never
8114 generate mouse events, so it's okay to zero
8115 mock_input in that case too.
8117 Isn't this just the most wonderful code ever? */
8118 if (t
== last_real_key_start
)
8125 mock_input
= last_real_key_start
;
8126 goto replay_sequence
;
8131 = apply_modifiers (modifiers
, XCAR (breakdown
));
8133 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8135 /* Look for a binding for this new key. follow_key
8136 promises that it didn't munge submaps the
8137 last time we called it, since key was unbound. */
8139 = (follow_key (new_click
,
8140 nmaps
- local_first_binding
,
8141 submaps
+ local_first_binding
,
8142 defs
+ local_first_binding
,
8143 submaps
+ local_first_binding
)
8144 + local_first_binding
);
8146 /* If that click is bound, go for it. */
8147 if (first_binding
< nmaps
)
8152 /* Otherwise, we'll leave key set to the drag event. */
8159 /* Normally, last_nonmenu_event gets the previous key we read.
8160 But when a mouse popup menu is being used,
8161 we don't update last_nonmenu_event; it continues to hold the mouse
8162 event that preceded the first level of menu. */
8163 if (!used_mouse_menu
)
8164 last_nonmenu_event
= key
;
8166 /* Record what part of this_command_keys is the current key sequence. */
8167 this_single_command_key_start
= this_command_key_count
- t
;
8169 prev_fkey_map
= fkey_map
;
8170 prev_fkey_start
= fkey_start
;
8171 prev_fkey_end
= fkey_end
;
8173 prev_keytran_map
= keytran_map
;
8174 prev_keytran_start
= keytran_start
;
8175 prev_keytran_end
= keytran_end
;
8177 /* If the sequence is unbound, see if we can hang a function key
8178 off the end of it. We only want to scan real keyboard input
8179 for function key sequences, so if mock_input says that we're
8180 re-reading old events, don't examine it. */
8181 if (first_binding
>= nmaps
8184 Lisp_Object fkey_next
;
8186 /* Continue scan from fkey_end until we find a bound suffix.
8187 If we fail, increment fkey_start
8188 and start fkey_end from there. */
8189 while (fkey_end
< t
)
8193 key
= keybuf
[fkey_end
++];
8194 /* Look up meta-characters by prefixing them
8195 with meta_prefix_char. I hate this. */
8196 if (INTEGERP (key
) && XUINT (key
) & meta_modifier
)
8201 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
8203 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
8206 fkey_next
= fkey_map
;
8209 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 1);
8211 /* Handle symbol with autoload definition. */
8212 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8213 && CONSP (XSYMBOL (fkey_next
)->function
)
8214 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8215 do_autoload (XSYMBOL (fkey_next
)->function
,
8218 /* Handle a symbol whose function definition is a keymap
8220 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8221 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8222 || !NILP (Fkeymapp (XSYMBOL (fkey_next
)->function
))))
8223 fkey_next
= XSYMBOL (fkey_next
)->function
;
8225 #if 0 /* I didn't turn this on, because it might cause trouble
8226 for the mapping of return into C-m and tab into C-i. */
8227 /* Optionally don't map function keys into other things.
8228 This enables the user to redefine kp- keys easily. */
8229 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8233 /* If the function key map gives a function, not an
8234 array, then call the function with no args and use
8235 its value instead. */
8236 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8239 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8243 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8244 fkey_next
= call1 (fkey_next
, prompt
);
8246 /* If the function returned something invalid,
8247 barf--don't ignore it.
8248 (To ignore it safely, we would need to gcpro a bunch of
8249 other variables.) */
8250 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8251 error ("Function in key-translation-map returns invalid key sequence");
8254 function_key_possible
= ! NILP (fkey_next
);
8256 /* If keybuf[fkey_start..fkey_end] is bound in the
8257 function key map and it's a suffix of the current
8258 sequence (i.e. fkey_end == t), replace it with
8259 the binding and restart with fkey_start at the end. */
8260 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8263 int len
= XFASTINT (Flength (fkey_next
));
8265 t
= fkey_start
+ len
;
8267 error ("Key sequence too long");
8269 if (VECTORP (fkey_next
))
8270 bcopy (XVECTOR (fkey_next
)->contents
,
8271 keybuf
+ fkey_start
,
8272 (t
- fkey_start
) * sizeof (keybuf
[0]));
8273 else if (STRINGP (fkey_next
))
8277 for (i
= 0; i
< len
; i
++)
8278 XSETFASTINT (keybuf
[fkey_start
+ i
],
8279 XSTRING (fkey_next
)->data
[i
]);
8283 fkey_start
= fkey_end
= t
;
8284 fkey_map
= Vfunction_key_map
;
8286 /* Do pass the results through key-translation-map.
8287 But don't retranslate what key-translation-map
8288 has already translated. */
8289 keytran_end
= keytran_start
;
8290 keytran_map
= Vkey_translation_map
;
8292 goto replay_sequence
;
8295 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
8297 /* If we no longer have a bound suffix, try a new positions for
8299 if (NILP (fkey_map
))
8301 fkey_end
= ++fkey_start
;
8302 fkey_map
= Vfunction_key_map
;
8303 function_key_possible
= 0;
8308 /* Look for this sequence in key-translation-map. */
8310 Lisp_Object keytran_next
;
8312 /* Scan from keytran_end until we find a bound suffix. */
8313 while (keytran_end
< t
)
8317 key
= keybuf
[keytran_end
++];
8318 /* Look up meta-characters by prefixing them
8319 with meta_prefix_char. I hate this. */
8320 if (INTEGERP (key
) && XUINT (key
) & meta_modifier
)
8325 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
8327 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
8330 keytran_next
= keytran_map
;
8333 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 1);
8335 /* Handle symbol with autoload definition. */
8336 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8337 && CONSP (XSYMBOL (keytran_next
)->function
)
8338 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8339 do_autoload (XSYMBOL (keytran_next
)->function
,
8342 /* Handle a symbol whose function definition is a keymap
8344 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8345 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8346 || !NILP (Fkeymapp (XSYMBOL (keytran_next
)->function
))))
8347 keytran_next
= XSYMBOL (keytran_next
)->function
;
8349 /* If the key translation map gives a function, not an
8350 array, then call the function with one arg and use
8351 its value instead. */
8352 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8353 && keytran_end
== t
)
8355 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8359 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8360 keytran_next
= call1 (keytran_next
, prompt
);
8362 /* If the function returned something invalid,
8363 barf--don't ignore it.
8364 (To ignore it safely, we would need to gcpro a bunch of
8365 other variables.) */
8366 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8367 error ("Function in key-translation-map returns invalid key sequence");
8370 key_translation_possible
= ! NILP (keytran_next
);
8372 /* If keybuf[keytran_start..keytran_end] is bound in the
8373 key translation map and it's a suffix of the current
8374 sequence (i.e. keytran_end == t), replace it with
8375 the binding and restart with keytran_start at the end. */
8376 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
8377 && keytran_end
== t
)
8379 int len
= XFASTINT (Flength (keytran_next
));
8381 t
= keytran_start
+ len
;
8383 error ("Key sequence too long");
8385 if (VECTORP (keytran_next
))
8386 bcopy (XVECTOR (keytran_next
)->contents
,
8387 keybuf
+ keytran_start
,
8388 (t
- keytran_start
) * sizeof (keybuf
[0]));
8389 else if (STRINGP (keytran_next
))
8393 for (i
= 0; i
< len
; i
++)
8394 XSETFASTINT (keybuf
[keytran_start
+ i
],
8395 XSTRING (keytran_next
)->data
[i
]);
8399 keytran_start
= keytran_end
= t
;
8400 keytran_map
= Vkey_translation_map
;
8402 /* Don't pass the results of key-translation-map
8403 through function-key-map. */
8404 fkey_start
= fkey_end
= t
;
8405 fkey_map
= Vfunction_key_map
;
8407 goto replay_sequence
;
8410 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
8412 /* If we no longer have a bound suffix, try a new positions for
8414 if (NILP (keytran_map
))
8416 keytran_end
= ++keytran_start
;
8417 keytran_map
= Vkey_translation_map
;
8418 key_translation_possible
= 0;
8423 /* If KEY is not defined in any of the keymaps,
8424 and cannot be part of a function key or translation,
8425 and is an upper case letter
8426 use the corresponding lower-case letter instead. */
8427 if (first_binding
== nmaps
&& ! function_key_possible
8428 && ! key_translation_possible
8430 && ((((XINT (key
) & 0x3ffff)
8431 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
8432 && UPPERCASEP (XINT (key
) & 0x3ffff))
8433 || (XINT (key
) & shift_modifier
)))
8435 Lisp_Object new_key
;
8437 original_uppercase
= key
;
8438 original_uppercase_position
= t
- 1;
8440 if (XINT (key
) & shift_modifier
)
8441 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
8443 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
8444 | (XINT (key
) & ~0x3ffff)));
8446 /* We have to do this unconditionally, regardless of whether
8447 the lower-case char is defined in the keymaps, because they
8448 might get translated through function-key-map. */
8449 keybuf
[t
- 1] = new_key
;
8452 fkey_map
= prev_fkey_map
;
8453 fkey_start
= prev_fkey_start
;
8454 fkey_end
= prev_fkey_end
;
8456 keytran_map
= prev_keytran_map
;
8457 keytran_start
= prev_keytran_start
;
8458 keytran_end
= prev_keytran_end
;
8460 goto replay_sequence
;
8462 /* If KEY is not defined in any of the keymaps,
8463 and cannot be part of a function key or translation,
8464 and is a shifted function key,
8465 use the corresponding unshifted function key instead. */
8466 if (first_binding
== nmaps
&& ! function_key_possible
8467 && ! key_translation_possible
8470 Lisp_Object breakdown
;
8473 breakdown
= parse_modifiers (key
);
8474 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8475 if (modifiers
& shift_modifier
)
8477 Lisp_Object new_key
;
8479 original_uppercase
= key
;
8480 original_uppercase_position
= t
- 1;
8482 modifiers
&= ~shift_modifier
;
8483 new_key
= apply_modifiers (modifiers
,
8486 keybuf
[t
- 1] = new_key
;
8489 fkey_map
= prev_fkey_map
;
8490 fkey_start
= prev_fkey_start
;
8491 fkey_end
= prev_fkey_end
;
8493 keytran_map
= prev_keytran_map
;
8494 keytran_start
= prev_keytran_start
;
8495 keytran_end
= prev_keytran_end
;
8497 goto replay_sequence
;
8503 read_key_sequence_cmd
= (first_binding
< nmaps
8504 ? defs
[first_binding
]
8507 unread_switch_frame
= delayed_switch_frame
;
8508 unbind_to (count
, Qnil
);
8510 /* Don't downcase the last character if the caller says don't.
8511 Don't downcase it if the result is undefined, either. */
8512 if ((dont_downcase_last
|| first_binding
>= nmaps
)
8513 && t
- 1 == original_uppercase_position
)
8514 keybuf
[t
- 1] = original_uppercase
;
8516 /* Occasionally we fabricate events, perhaps by expanding something
8517 according to function-key-map, or by adding a prefix symbol to a
8518 mouse click in the scroll bar or modeline. In this cases, return
8519 the entire generated key sequence, even if we hit an unbound
8520 prefix or a definition before the end. This means that you will
8521 be able to push back the event properly, and also means that
8522 read-key-sequence will always return a logical unit.
8525 for (; t
< mock_input
; t
++)
8527 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8528 && NILP (Fzerop (Vecho_keystrokes
)))
8529 echo_char (keybuf
[t
]);
8530 add_command_key (keybuf
[t
]);
8538 #if 0 /* This doc string is too long for some compilers.
8539 This commented-out definition serves for DOC. */
8540 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
8541 "Read a sequence of keystrokes and return as a string or vector.\n\
8542 The sequence is sufficient to specify a non-prefix command in the\n\
8543 current local and global maps.\n\
8545 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
8546 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
8547 as a continuation of the previous key.\n\
8549 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
8550 convert the last event to lower case. (Normally any upper case event\n\
8551 is converted to lower case if the original event is undefined and the lower\n\
8552 case equivalent is defined.) A non-nil value is appropriate for reading\n\
8553 a key sequence to be defined.\n\
8555 A C-g typed while in this function is treated like any other character,\n\
8556 and `quit-flag' is not set.\n\
8558 If the key sequence starts with a mouse click, then the sequence is read\n\
8559 using the keymaps of the buffer of the window clicked in, not the buffer\n\
8560 of the selected window as normal.\n\
8562 `read-key-sequence' drops unbound button-down events, since you normally\n\
8563 only care about the click or drag events which follow them. If a drag\n\
8564 or multi-click event is unbound, but the corresponding click event would\n\
8565 be bound, `read-key-sequence' turns the event into a click event at the\n\
8566 drag's starting position. This means that you don't have to distinguish\n\
8567 between click and drag, double, or triple events unless you want to.\n\
8569 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
8570 lines separating windows, and scroll bars with imaginary keys\n\
8571 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
8573 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
8574 function will process a switch-frame event if the user switches frames\n\
8575 before typing anything. If the user switches frames in the middle of a\n\
8576 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
8577 is nil, then the event will be put off until after the current key sequence.\n\
8579 `read-key-sequence' checks `function-key-map' for function key\n\
8580 sequences, where they wouldn't conflict with ordinary bindings. See\n\
8581 `function-key-map' for more details.\n\
8583 The optional fifth argument COMMAND-LOOP, if non-nil, means\n\
8584 that this key sequence is being read by something that will\n\
8585 read commands one after another. It should be nil if the caller\n\
8586 will read just one key sequence.")
8587 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
, command
-loop
)
8590 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
8592 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
8594 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
8595 Lisp_Object can_return_switch_frame
, command_loop
;
8597 Lisp_Object keybuf
[30];
8599 struct gcpro gcpro1
;
8600 int count
= specpdl_ptr
- specpdl
;
8603 CHECK_STRING (prompt
, 0);
8606 specbind (Qinput_method_exit_on_first_char
,
8607 (NILP (command_loop
) ? Qt
: Qnil
));
8608 specbind (Qinput_method_use_echo_area
,
8609 (NILP (command_loop
) ? Qt
: Qnil
));
8611 bzero (keybuf
, sizeof keybuf
);
8613 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
8615 if (NILP (continue_echo
))
8617 this_command_key_count
= 0;
8618 this_single_command_key_start
= 0;
8621 #ifdef HAVE_X_WINDOWS
8622 if (display_busy_cursor_p
)
8623 cancel_busy_cursor ();
8626 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
8627 prompt
, ! NILP (dont_downcase_last
),
8628 ! NILP (can_return_switch_frame
), 0);
8630 #ifdef HAVE_X_WINDOWS
8631 if (display_busy_cursor_p
)
8632 start_busy_cursor ();
8641 return unbind_to (count
, make_event_array (i
, keybuf
));
8644 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
8645 Sread_key_sequence_vector
, 1, 5, 0,
8646 "Like `read-key-sequence' but always return a vector.")
8647 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
8649 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
8650 Lisp_Object can_return_switch_frame
, command_loop
;
8652 Lisp_Object keybuf
[30];
8654 struct gcpro gcpro1
;
8655 int count
= specpdl_ptr
- specpdl
;
8658 CHECK_STRING (prompt
, 0);
8661 specbind (Qinput_method_exit_on_first_char
,
8662 (NILP (command_loop
) ? Qt
: Qnil
));
8663 specbind (Qinput_method_use_echo_area
,
8664 (NILP (command_loop
) ? Qt
: Qnil
));
8666 bzero (keybuf
, sizeof keybuf
);
8668 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
8670 if (NILP (continue_echo
))
8672 this_command_key_count
= 0;
8673 this_single_command_key_start
= 0;
8676 #ifdef HAVE_X_WINDOWS
8677 if (display_busy_cursor_p
)
8678 cancel_busy_cursor ();
8681 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
8682 prompt
, ! NILP (dont_downcase_last
),
8683 ! NILP (can_return_switch_frame
), 0);
8685 #ifdef HAVE_X_WINDOWS
8686 if (display_busy_cursor_p
)
8687 start_busy_cursor ();
8696 return unbind_to (count
, Fvector (i
, keybuf
));
8699 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
8700 "Execute CMD as an editor command.\n\
8701 CMD must be a symbol that satisfies the `commandp' predicate.\n\
8702 Optional second arg RECORD-FLAG non-nil\n\
8703 means unconditionally put this command in `command-history'.\n\
8704 Otherwise, that is done only if an arg is read using the minibuffer.\n\
8705 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
8706 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
8707 The argument SPECIAL, if non-nil, means that this command is executing\n\
8708 a special event, so ignore the prefix argument and don't clear it.")
8709 (cmd
, record_flag
, keys
, special
)
8710 Lisp_Object cmd
, record_flag
, keys
, special
;
8712 register Lisp_Object final
;
8713 register Lisp_Object tem
;
8714 Lisp_Object prefixarg
;
8715 struct backtrace backtrace
;
8716 extern int debug_on_next_call
;
8718 debug_on_next_call
= 0;
8722 prefixarg
= current_kboard
->Vprefix_arg
;
8723 Vcurrent_prefix_arg
= prefixarg
;
8724 current_kboard
->Vprefix_arg
= Qnil
;
8731 tem
= Fget (cmd
, Qdisabled
);
8732 if (!NILP (tem
) && !NILP (Vrun_hooks
))
8734 tem
= Fsymbol_value (Qdisabled_command_hook
);
8736 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
8742 final
= Findirect_function (cmd
);
8744 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
8746 struct gcpro gcpro1
, gcpro2
;
8748 GCPRO2 (cmd
, prefixarg
);
8749 do_autoload (final
, cmd
);
8756 if (STRINGP (final
) || VECTORP (final
))
8758 /* If requested, place the macro in the command history. For
8759 other sorts of commands, call-interactively takes care of
8761 if (!NILP (record_flag
))
8764 = Fcons (Fcons (Qexecute_kbd_macro
,
8765 Fcons (final
, Fcons (prefixarg
, Qnil
))),
8768 /* Don't keep command history around forever. */
8769 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
8771 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
8777 return Fexecute_kbd_macro (final
, prefixarg
);
8780 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
8782 backtrace
.next
= backtrace_list
;
8783 backtrace_list
= &backtrace
;
8784 backtrace
.function
= &Qcall_interactively
;
8785 backtrace
.args
= &cmd
;
8786 backtrace
.nargs
= 1;
8787 backtrace
.evalargs
= 0;
8789 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
8791 backtrace_list
= backtrace
.next
;
8797 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
8799 "Read function name, then read its arguments and call it.")
8801 Lisp_Object prefixarg
;
8803 Lisp_Object function
;
8805 Lisp_Object saved_keys
;
8806 Lisp_Object bindings
, value
;
8807 struct gcpro gcpro1
, gcpro2
;
8809 saved_keys
= Fvector (this_command_key_count
,
8810 XVECTOR (this_command_keys
)->contents
);
8812 GCPRO2 (saved_keys
, prefixarg
);
8814 if (EQ (prefixarg
, Qminus
))
8816 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
8817 strcpy (buf
, "C-u ");
8818 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
8820 if (sizeof (int) == sizeof (EMACS_INT
))
8821 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
8822 else if (sizeof (long) == sizeof (EMACS_INT
))
8823 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
8827 else if (INTEGERP (prefixarg
))
8829 if (sizeof (int) == sizeof (EMACS_INT
))
8830 sprintf (buf
, "%d ", XINT (prefixarg
));
8831 else if (sizeof (long) == sizeof (EMACS_INT
))
8832 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
8837 /* This isn't strictly correct if execute-extended-command
8838 is bound to anything else. Perhaps it should use
8839 this_command_keys? */
8840 strcat (buf
, "M-x ");
8842 /* Prompt with buf, and then read a string, completing from and
8843 restricting to the set of all defined commands. Don't provide
8844 any initial input. Save the command read on the extended-command
8846 function
= Fcompleting_read (build_string (buf
),
8847 Vobarray
, Qcommandp
,
8848 Qt
, Qnil
, Qextended_command_history
, Qnil
,
8851 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
8852 error ("No command name given");
8854 /* Set this_command_keys to the concatenation of saved_keys and
8855 function, followed by a RET. */
8857 struct Lisp_String
*str
;
8861 this_command_key_count
= 0;
8862 this_single_command_key_start
= 0;
8864 keys
= XVECTOR (saved_keys
)->contents
;
8865 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
8866 add_command_key (keys
[i
]);
8868 str
= XSTRING (function
);
8869 for (i
= 0; i
< str
->size
; i
++)
8870 add_command_key (Faref (function
, make_number (i
)));
8872 add_command_key (make_number ('\015'));
8877 function
= Fintern (function
, Qnil
);
8878 current_kboard
->Vprefix_arg
= prefixarg
;
8879 Vthis_command
= function
;
8880 real_this_command
= function
;
8882 /* If enabled, show which key runs this command. */
8883 if (!NILP (Vsuggest_key_bindings
)
8884 && NILP (Vexecuting_macro
)
8885 && SYMBOLP (function
))
8886 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
8892 GCPRO2 (bindings
, value
);
8893 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
8895 /* If the command has a key binding, print it now. */
8896 if (!NILP (bindings
)
8897 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
8900 /* But first wait, and skip the message if there is input. */
8902 if (!NILP (echo_area_buffer
[0]))
8903 /* This command displayed something in the echo area;
8904 so wait a few seconds, then display our suggestion message. */
8905 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
8906 ? XINT (Vsuggest_key_bindings
) : 2);
8908 /* This command left the echo area empty,
8909 so display our message immediately. */
8912 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
8913 && ! CONSP (Vunread_command_events
))
8915 Lisp_Object binding
;
8917 int message_p
= push_message ();
8919 binding
= Fkey_description (bindings
);
8922 = (char *) alloca (XSYMBOL (function
)->name
->size
8923 + STRING_BYTES (XSTRING (binding
))
8925 sprintf (newmessage
, "You can run the command `%s' with %s",
8926 XSYMBOL (function
)->name
->data
,
8927 XSTRING (binding
)->data
);
8928 message2_nolog (newmessage
,
8929 strlen (newmessage
),
8930 STRING_MULTIBYTE (binding
));
8931 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
8932 ? Vsuggest_key_bindings
: make_number (2)),
8941 RETURN_UNGCPRO (value
);
8944 /* Find the set of keymaps now active.
8945 Store into *MAPS_P a vector holding the various maps
8946 and return the number of them. The vector was malloc'd
8947 and the caller should free it. */
8950 current_active_maps (maps_p
)
8951 Lisp_Object
**maps_p
;
8953 Lisp_Object
*tmaps
, *maps
;
8956 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8957 if (!NILP (Voverriding_local_map_menu_flag
))
8959 /* Yes, use them (if non-nil) as well as the global map. */
8960 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
8962 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8963 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8964 if (!NILP (Voverriding_local_map
))
8965 maps
[nmaps
++] = Voverriding_local_map
;
8969 /* No, so use major and minor mode keymaps and keymap property. */
8971 Lisp_Object map
= get_local_map (PT
, current_buffer
, keymap
);
8974 nmaps
= current_minor_maps (NULL
, &tmaps
);
8975 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
8976 * sizeof (maps
[0]));
8977 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
8979 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, keymap
);
8980 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, local_map
);
8982 maps
[nmaps
++] = current_global_map
;
8988 /* Return nonzero if input events are pending. */
8991 detect_input_pending ()
8994 get_input_pending (&input_pending
, 0);
8996 return input_pending
;
8999 /* Return nonzero if input events are pending, and run any pending timers. */
9002 detect_input_pending_run_timers (do_display
)
9005 int old_timers_run
= timers_run
;
9008 get_input_pending (&input_pending
, 1);
9010 if (old_timers_run
!= timers_run
&& do_display
)
9012 redisplay_preserve_echo_area ();
9013 /* The following fixes a bug when using lazy-lock with
9014 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9015 from an idle timer function. The symptom of the bug is that
9016 the cursor sometimes doesn't become visible until the next X
9017 event is processed. --gerd. */
9019 rif
->flush_display (NULL
);
9022 return input_pending
;
9025 /* This is called in some cases before a possible quit.
9026 It cases the next call to detect_input_pending to recompute input_pending.
9027 So calling this function unnecessarily can't do any harm. */
9030 clear_input_pending ()
9035 /* Return nonzero if there are pending requeued events.
9036 This isn't used yet. The hope is to make wait_reading_process_input
9037 call it, and return return if it runs Lisp code that unreads something.
9038 The problem is, kbd_buffer_get_event needs to be fixed to know what
9039 to do in that case. It isn't trivial. */
9042 requeued_events_pending_p ()
9044 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9048 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9049 "T if command input is currently available with no waiting.\n\
9050 Actually, the value is nil only if we can be sure that no input is available.")
9053 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9056 get_input_pending (&input_pending
, 1);
9057 return input_pending
> 0 ? Qt
: Qnil
;
9060 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9061 "Return vector of last 100 events, not counting those from keyboard macros.")
9064 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9067 if (total_keys
< NUM_RECENT_KEYS
)
9068 return Fvector (total_keys
, keys
);
9071 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9072 bcopy (keys
+ recent_keys_index
,
9073 XVECTOR (val
)->contents
,
9074 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9076 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9077 recent_keys_index
* sizeof (Lisp_Object
));
9082 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9083 "Return the key sequence that invoked this command.\n\
9084 The value is a string or a vector.")
9087 return make_event_array (this_command_key_count
,
9088 XVECTOR (this_command_keys
)->contents
);
9091 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9092 "Return the key sequence that invoked this command, as a vector.")
9095 return Fvector (this_command_key_count
,
9096 XVECTOR (this_command_keys
)->contents
);
9099 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9100 Sthis_single_command_keys
, 0, 0, 0,
9101 "Return the key sequence that invoked this command.\n\
9102 Unlike `this-command-keys', this function's value\n\
9103 does not include prefix arguments.\n\
9104 The value is always a vector.")
9107 return Fvector (this_command_key_count
9108 - this_single_command_key_start
,
9109 (XVECTOR (this_command_keys
)->contents
9110 + this_single_command_key_start
));
9113 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9114 Sthis_single_command_raw_keys
, 0, 0, 0,
9115 "Return the raw events that were read for this command.\n\
9116 Unlike `this-single-command-keys', this function's value\n\
9117 shows the events before all translations (except for input methods).\n\
9118 The value is always a vector.")
9121 return Fvector (raw_keybuf_count
,
9122 (XVECTOR (raw_keybuf
)->contents
));
9125 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9126 Sreset_this_command_lengths
, 0, 0, 0,
9127 "Used for complicated reasons in `universal-argument-other-key'.\n\
9129 `universal-argument-other-key' rereads the event just typed.\n\
9130 It then gets translated through `function-key-map'.\n\
9131 The translated event gets included in the echo area and in\n\
9132 the value of `this-command-keys' in addition to the raw original event.\n\
9133 That is not right.\n\
9135 Calling this function directs the translated event to replace\n\
9136 the original event, so that only one version of the event actually\n\
9137 appears in the echo area and in the value of `this-command-keys.'.")
9140 before_command_restore_flag
= 1;
9141 before_command_key_count_1
= before_command_key_count
;
9142 before_command_echo_length_1
= before_command_echo_length
;
9146 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9147 Sclear_this_command_keys
, 0, 0, 0,
9148 "Clear out the vector that `this-command-keys' returns.\n\
9149 Clear vector containing last 100 events.")
9154 this_command_key_count
= 0;
9156 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9157 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9159 recent_keys_index
= 0;
9163 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9164 "Return the current depth in recursive edits.")
9168 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9172 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9173 "FOpen dribble file: ",
9174 "Start writing all keyboard characters to a dribble file called FILE.\n\
9175 If FILE is nil, close any open dribble file.")
9186 file
= Fexpand_file_name (file
, Qnil
);
9187 dribble
= fopen (XSTRING (file
)->data
, "w");
9189 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9194 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9195 "Discard the contents of the terminal input buffer.\n\
9196 Also cancel any kbd macro being defined.")
9199 current_kboard
->defining_kbd_macro
= Qnil
;
9200 update_mode_lines
++;
9202 Vunread_command_events
= Qnil
;
9203 unread_command_char
= -1;
9205 discard_tty_input ();
9207 kbd_fetch_ptr
= kbd_store_ptr
;
9208 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
9214 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9215 "Stop Emacs and return to superior process. You can resume later.\n\
9216 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
9217 control, run a subshell instead.\n\n\
9218 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
9219 to be read as terminal input by Emacs's parent, after suspension.\n\
9221 Before suspending, run the normal hook `suspend-hook'.\n\
9222 After resumption run the normal hook `suspend-resume-hook'.\n\
9224 Some operating systems cannot stop the Emacs process and resume it later.\n\
9225 On such systems, Emacs starts a subshell instead of suspending.")
9227 Lisp_Object stuffstring
;
9229 int count
= specpdl_ptr
- specpdl
;
9230 int old_height
, old_width
;
9232 struct gcpro gcpro1
;
9234 if (!NILP (stuffstring
))
9235 CHECK_STRING (stuffstring
, 0);
9237 /* Run the functions in suspend-hook. */
9238 if (!NILP (Vrun_hooks
))
9239 call1 (Vrun_hooks
, intern ("suspend-hook"));
9241 GCPRO1 (stuffstring
);
9242 get_frame_size (&old_width
, &old_height
);
9244 /* sys_suspend can get an error if it tries to fork a subshell
9245 and the system resources aren't available for that. */
9246 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9248 stuff_buffered_input (stuffstring
);
9253 unbind_to (count
, Qnil
);
9255 /* Check if terminal/window size has changed.
9256 Note that this is not useful when we are running directly
9257 with a window system; but suspend should be disabled in that case. */
9258 get_frame_size (&width
, &height
);
9259 if (width
!= old_width
|| height
!= old_height
)
9260 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9262 /* Run suspend-resume-hook. */
9263 if (!NILP (Vrun_hooks
))
9264 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9270 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9271 Then in any case stuff anything Emacs has read ahead and not used. */
9274 stuff_buffered_input (stuffstring
)
9275 Lisp_Object stuffstring
;
9277 /* stuff_char works only in BSD, versions 4.2 and up. */
9280 register unsigned char *p
;
9282 if (STRINGP (stuffstring
))
9286 p
= XSTRING (stuffstring
)->data
;
9287 count
= STRING_BYTES (XSTRING (stuffstring
));
9292 /* Anything we have read ahead, put back for the shell to read. */
9293 /* ?? What should this do when we have multiple keyboards??
9294 Should we ignore anything that was typed in at the "wrong" kboard? */
9295 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9297 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9298 kbd_fetch_ptr
= kbd_buffer
;
9299 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
9300 stuff_char (kbd_fetch_ptr
->code
);
9301 kbd_fetch_ptr
->kind
= no_event
;
9302 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
9308 #endif /* BSD_SYSTEM and not BSD4_1 */
9312 set_waiting_for_input (time_to_clear
)
9313 EMACS_TIME
*time_to_clear
;
9315 input_available_clear_time
= time_to_clear
;
9317 /* Tell interrupt_signal to throw back to read_char, */
9318 waiting_for_input
= 1;
9320 /* If interrupt_signal was called before and buffered a C-g,
9321 make it run again now, to avoid timing error. */
9322 if (!NILP (Vquit_flag
))
9323 quit_throw_to_read_char ();
9327 clear_waiting_for_input ()
9329 /* Tell interrupt_signal not to throw back to read_char, */
9330 waiting_for_input
= 0;
9331 input_available_clear_time
= 0;
9334 /* This routine is called at interrupt level in response to C-G.
9335 If interrupt_input, this is the handler for SIGINT.
9336 Otherwise, it is called from kbd_buffer_store_event,
9337 in handling SIGIO or SIGTINT.
9339 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
9340 immediately throw back to read_char.
9342 Otherwise it sets the Lisp variable quit-flag not-nil.
9343 This causes eval to throw, when it gets a chance.
9344 If quit-flag is already non-nil, it stops the job right away. */
9347 interrupt_signal (signalnum
) /* If we don't have an argument, */
9348 int signalnum
; /* some compilers complain in signal calls. */
9351 /* Must preserve main program's value of errno. */
9352 int old_errno
= errno
;
9353 struct frame
*sf
= SELECTED_FRAME ();
9355 #if defined (USG) && !defined (POSIX_SIGNALS)
9356 if (!read_socket_hook
&& NILP (Vwindow_system
))
9358 /* USG systems forget handlers when they are used;
9359 must reestablish each time */
9360 signal (SIGINT
, interrupt_signal
);
9361 signal (SIGQUIT
, interrupt_signal
);
9367 if (!NILP (Vquit_flag
)
9368 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9370 /* If SIGINT isn't blocked, don't let us be interrupted by
9371 another SIGINT, it might be harmful due to non-reentrancy
9372 in I/O functions. */
9373 sigblock (sigmask (SIGINT
));
9378 #ifdef SIGTSTP /* Support possible in later USG versions */
9380 * On systems which can suspend the current process and return to the original
9381 * shell, this command causes the user to end up back at the shell.
9382 * The "Auto-save" and "Abort" questions are not asked until
9383 * the user elects to return to emacs, at which point he can save the current
9384 * job and either dump core or continue.
9389 if (sys_suspend () == -1)
9391 printf ("Not running as a subprocess;\n");
9392 printf ("you can continue or abort.\n");
9395 /* Perhaps should really fork an inferior shell?
9396 But that would not provide any way to get back
9397 to the original shell, ever. */
9398 printf ("No support for stopping a process on this operating system;\n");
9399 printf ("you can continue or abort.\n");
9400 #endif /* not VMS */
9401 #endif /* not SIGTSTP */
9403 /* We must remain inside the screen area when the internal terminal
9404 is used. Note that [Enter] is not echoed by dos. */
9407 /* It doesn't work to autosave while GC is in progress;
9408 the code used for auto-saving doesn't cope with the mark bit. */
9409 if (!gc_in_progress
)
9411 printf ("Auto-save? (y or n) ");
9413 if (((c
= getchar ()) & ~040) == 'Y')
9415 Fdo_auto_save (Qt
, Qnil
);
9417 printf ("\r\nAuto-save done");
9418 #else /* not MSDOS */
9419 printf ("Auto-save done\n");
9420 #endif /* not MSDOS */
9422 while (c
!= '\n') c
= getchar ();
9426 /* During GC, it must be safe to reenable quitting again. */
9427 Vinhibit_quit
= Qnil
;
9430 #endif /* not MSDOS */
9431 printf ("Garbage collection in progress; cannot auto-save now\r\n");
9432 printf ("but will instead do a real quit after garbage collection ends\r\n");
9437 printf ("\r\nAbort? (y or n) ");
9438 #else /* not MSDOS */
9440 printf ("Abort (and enter debugger)? (y or n) ");
9442 printf ("Abort (and dump core)? (y or n) ");
9443 #endif /* not VMS */
9444 #endif /* not MSDOS */
9446 if (((c
= getchar ()) & ~040) == 'Y')
9448 while (c
!= '\n') c
= getchar ();
9450 printf ("\r\nContinuing...\r\n");
9451 #else /* not MSDOS */
9452 printf ("Continuing...\n");
9453 #endif /* not MSDOS */
9460 /* If executing a function that wants to be interrupted out of
9461 and the user has not deferred quitting by binding `inhibit-quit'
9462 then quit right away. */
9463 if (immediate_quit
&& NILP (Vinhibit_quit
))
9465 struct gl_state_s saved
;
9466 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9471 GCPRO4 (saved
.object
, saved
.global_code
,
9472 saved
.current_syntax_table
, saved
.old_prop
);
9473 Fsignal (Qquit
, Qnil
);
9478 /* Else request quit when it's safe */
9482 if (waiting_for_input
&& !echoing
)
9483 quit_throw_to_read_char ();
9488 /* Handle a C-g by making read_char return C-g. */
9491 quit_throw_to_read_char ()
9494 /* Prevent another signal from doing this before we finish. */
9495 clear_waiting_for_input ();
9498 Vunread_command_events
= Qnil
;
9499 unread_command_char
= -1;
9501 #if 0 /* Currently, sit_for is called from read_char without turning
9502 off polling. And that can call set_waiting_for_input.
9503 It seems to be harmless. */
9504 #ifdef POLL_FOR_INPUT
9505 /* May be > 1 if in recursive minibuffer. */
9506 if (poll_suppress_count
== 0)
9510 if (FRAMEP (internal_last_event_frame
)
9511 && !EQ (internal_last_event_frame
, selected_frame
))
9512 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
9515 _longjmp (getcjmp
, 1);
9518 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
9519 "Set mode of reading keyboard input.\n\
9520 First arg INTERRUPT non-nil means use input interrupts;\n\
9521 nil means use CBREAK mode.\n\
9522 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
9523 (no effect except in CBREAK mode).\n\
9524 Third arg META t means accept 8-bit input (for a Meta key).\n\
9525 META nil means ignore the top bit, on the assumption it is parity.\n\
9526 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
9527 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
9528 See also `current-input-mode'.")
9529 (interrupt
, flow
, meta
, quit
)
9530 Lisp_Object interrupt
, flow
, meta
, quit
;
9533 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
9534 error ("set-input-mode: QUIT must be an ASCII character");
9536 #ifdef POLL_FOR_INPUT
9541 /* this causes startup screen to be restored and messes with the mouse */
9546 /* Note SIGIO has been undef'd if FIONREAD is missing. */
9547 if (read_socket_hook
)
9549 /* When using X, don't give the user a real choice,
9550 because we haven't implemented the mechanisms to support it. */
9551 #ifdef NO_SOCK_SIGIO
9552 interrupt_input
= 0;
9553 #else /* not NO_SOCK_SIGIO */
9554 interrupt_input
= 1;
9555 #endif /* NO_SOCK_SIGIO */
9558 interrupt_input
= !NILP (interrupt
);
9559 #else /* not SIGIO */
9560 interrupt_input
= 0;
9561 #endif /* not SIGIO */
9563 /* Our VMS input only works by interrupts, as of now. */
9565 interrupt_input
= 1;
9568 flow_control
= !NILP (flow
);
9571 else if (EQ (meta
, Qt
))
9576 /* Don't let this value be out of range. */
9577 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
9583 #ifdef POLL_FOR_INPUT
9584 poll_suppress_count
= 1;
9590 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
9591 "Return information about the way Emacs currently reads keyboard input.\n\
9592 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
9593 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
9594 nil, Emacs is using CBREAK mode.\n\
9595 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
9596 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
9597 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
9598 META nil means ignoring the top bit, on the assumption it is parity.\n\
9599 META is neither t nor nil if accepting 8-bit input and using\n\
9600 all 8 bits as the character code.\n\
9601 QUIT is the character Emacs currently uses to quit.\n\
9602 The elements of this list correspond to the arguments of\n\
9608 val
[0] = interrupt_input
? Qt
: Qnil
;
9609 val
[1] = flow_control
? Qt
: Qnil
;
9610 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
9611 XSETFASTINT (val
[3], quit_char
);
9613 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
9618 * Set up a new kboard object with reasonable initial values.
9624 kb
->Voverriding_terminal_local_map
= Qnil
;
9625 kb
->Vlast_command
= Qnil
;
9626 kb
->Vreal_last_command
= Qnil
;
9627 kb
->Vprefix_arg
= Qnil
;
9628 kb
->Vlast_prefix_arg
= Qnil
;
9629 kb
->kbd_queue
= Qnil
;
9630 kb
->kbd_queue_has_data
= 0;
9631 kb
->immediate_echo
= 0;
9632 kb
->echoptr
= kb
->echobuf
;
9633 kb
->echo_after_prompt
= -1;
9634 kb
->kbd_macro_buffer
= 0;
9635 kb
->kbd_macro_bufsize
= 0;
9636 kb
->defining_kbd_macro
= Qnil
;
9637 kb
->Vlast_kbd_macro
= Qnil
;
9638 kb
->reference_count
= 0;
9639 kb
->Vsystem_key_alist
= Qnil
;
9640 kb
->system_key_syms
= Qnil
;
9641 kb
->Vdefault_minibuffer_frame
= Qnil
;
9645 * Destroy the contents of a kboard object, but not the object itself.
9646 * We use this just before deleting it, or if we're going to initialize
9653 if (kb
->kbd_macro_buffer
)
9654 xfree (kb
->kbd_macro_buffer
);
9663 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
9666 *kbp
= kb
->next_kboard
;
9675 /* This is correct before outermost invocation of the editor loop */
9676 command_loop_level
= -1;
9678 quit_char
= Ctl ('g');
9679 Vunread_command_events
= Qnil
;
9680 unread_command_char
= -1;
9681 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
9683 recent_keys_index
= 0;
9684 kbd_fetch_ptr
= kbd_buffer
;
9685 kbd_store_ptr
= kbd_buffer
;
9686 kbd_buffer_frame_or_window
9687 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
9689 do_mouse_tracking
= Qnil
;
9693 /* This means that command_loop_1 won't try to select anything the first
9695 internal_last_event_frame
= Qnil
;
9696 Vlast_event_frame
= internal_last_event_frame
;
9699 current_kboard
= initial_kboard
;
9701 wipe_kboard (current_kboard
);
9702 init_kboard (current_kboard
);
9705 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
9707 kbd_buffer_frame_or_window
9708 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
9709 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
9711 signal (SIGINT
, interrupt_signal
);
9712 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
9713 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
9714 SIGQUIT and we can't tell which one it will give us. */
9715 signal (SIGQUIT
, interrupt_signal
);
9716 #endif /* HAVE_TERMIO */
9718 /* Note SIGIO has been undef'd if FIONREAD is missing. */
9720 if (!noninteractive
)
9721 signal (SIGIO
, input_available_signal
);
9724 /* Use interrupt input by default, if it works and noninterrupt input
9725 has deficiencies. */
9727 #ifdef INTERRUPT_INPUT
9728 interrupt_input
= 1;
9730 interrupt_input
= 0;
9733 /* Our VMS input only works by interrupts, as of now. */
9735 interrupt_input
= 1;
9741 if (keyboard_init_hook
)
9742 (*keyboard_init_hook
) ();
9744 #ifdef POLL_FOR_INPUT
9745 poll_suppress_count
= 1;
9750 /* This type's only use is in syms_of_keyboard, to initialize the
9751 event header symbols and put properties on them. */
9758 struct event_head head_table
[] = {
9759 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
9760 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
9761 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
9762 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
9763 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
9764 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
9770 Vlispy_mouse_stem
= build_string ("mouse");
9771 staticpro (&Vlispy_mouse_stem
);
9774 QCimage
= intern (":image");
9775 staticpro (&QCimage
);
9777 staticpro (&Qhelp_echo
);
9778 Qhelp_echo
= intern ("help-echo");
9780 staticpro (&item_properties
);
9781 item_properties
= Qnil
;
9783 staticpro (&tool_bar_item_properties
);
9784 tool_bar_item_properties
= Qnil
;
9785 staticpro (&tool_bar_items_vector
);
9786 tool_bar_items_vector
= Qnil
;
9788 staticpro (&real_this_command
);
9789 real_this_command
= Qnil
;
9791 Qtimer_event_handler
= intern ("timer-event-handler");
9792 staticpro (&Qtimer_event_handler
);
9794 Qdisabled_command_hook
= intern ("disabled-command-hook");
9795 staticpro (&Qdisabled_command_hook
);
9797 Qself_insert_command
= intern ("self-insert-command");
9798 staticpro (&Qself_insert_command
);
9800 Qforward_char
= intern ("forward-char");
9801 staticpro (&Qforward_char
);
9803 Qbackward_char
= intern ("backward-char");
9804 staticpro (&Qbackward_char
);
9806 Qdisabled
= intern ("disabled");
9807 staticpro (&Qdisabled
);
9809 Qundefined
= intern ("undefined");
9810 staticpro (&Qundefined
);
9812 Qpre_command_hook
= intern ("pre-command-hook");
9813 staticpro (&Qpre_command_hook
);
9815 Qpost_command_hook
= intern ("post-command-hook");
9816 staticpro (&Qpost_command_hook
);
9818 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
9819 staticpro (&Qpost_command_idle_hook
);
9821 Qdeferred_action_function
= intern ("deferred-action-function");
9822 staticpro (&Qdeferred_action_function
);
9824 Qcommand_hook_internal
= intern ("command-hook-internal");
9825 staticpro (&Qcommand_hook_internal
);
9827 Qfunction_key
= intern ("function-key");
9828 staticpro (&Qfunction_key
);
9829 Qmouse_click
= intern ("mouse-click");
9830 staticpro (&Qmouse_click
);
9832 Qmouse_wheel
= intern ("mouse-wheel");
9833 staticpro (&Qmouse_wheel
);
9834 Qlanguage_change
= intern ("language-change");
9835 staticpro (&Qlanguage_change
);
9837 Qdrag_n_drop
= intern ("drag-n-drop");
9838 staticpro (&Qdrag_n_drop
);
9840 Qusr1_signal
= intern ("usr1-signal");
9841 staticpro (&Qusr1_signal
);
9842 Qusr2_signal
= intern ("usr2-signal");
9843 staticpro (&Qusr2_signal
);
9845 Qmenu_enable
= intern ("menu-enable");
9846 staticpro (&Qmenu_enable
);
9847 Qmenu_alias
= intern ("menu-alias");
9848 staticpro (&Qmenu_alias
);
9849 QCenable
= intern (":enable");
9850 staticpro (&QCenable
);
9851 QCvisible
= intern (":visible");
9852 staticpro (&QCvisible
);
9853 QChelp
= intern (":help");
9854 staticpro (&QChelp
);
9855 QCfilter
= intern (":filter");
9856 staticpro (&QCfilter
);
9857 QCbutton
= intern (":button");
9858 staticpro (&QCbutton
);
9859 QCkeys
= intern (":keys");
9860 staticpro (&QCkeys
);
9861 QCkey_sequence
= intern (":key-sequence");
9862 staticpro (&QCkey_sequence
);
9863 QCtoggle
= intern (":toggle");
9864 staticpro (&QCtoggle
);
9865 QCradio
= intern (":radio");
9866 staticpro (&QCradio
);
9868 Qmode_line
= intern ("mode-line");
9869 staticpro (&Qmode_line
);
9870 Qvertical_line
= intern ("vertical-line");
9871 staticpro (&Qvertical_line
);
9872 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
9873 staticpro (&Qvertical_scroll_bar
);
9874 Qmenu_bar
= intern ("menu-bar");
9875 staticpro (&Qmenu_bar
);
9877 Qabove_handle
= intern ("above-handle");
9878 staticpro (&Qabove_handle
);
9879 Qhandle
= intern ("handle");
9880 staticpro (&Qhandle
);
9881 Qbelow_handle
= intern ("below-handle");
9882 staticpro (&Qbelow_handle
);
9883 Qup
= intern ("up");
9885 Qdown
= intern ("down");
9887 Qtop
= intern ("top");
9889 Qbottom
= intern ("bottom");
9890 staticpro (&Qbottom
);
9891 Qend_scroll
= intern ("end-scroll");
9892 staticpro (&Qend_scroll
);
9893 Qratio
= intern ("ratio");
9894 staticpro (&Qratio
);
9896 Qevent_kind
= intern ("event-kind");
9897 staticpro (&Qevent_kind
);
9898 Qevent_symbol_elements
= intern ("event-symbol-elements");
9899 staticpro (&Qevent_symbol_elements
);
9900 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
9901 staticpro (&Qevent_symbol_element_mask
);
9902 Qmodifier_cache
= intern ("modifier-cache");
9903 staticpro (&Qmodifier_cache
);
9905 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
9906 staticpro (&Qrecompute_lucid_menubar
);
9907 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
9908 staticpro (&Qactivate_menubar_hook
);
9910 Qpolling_period
= intern ("polling-period");
9911 staticpro (&Qpolling_period
);
9913 Qinput_method_function
= intern ("input-method-function");
9914 staticpro (&Qinput_method_function
);
9916 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
9917 staticpro (&Qinput_method_exit_on_first_char
);
9918 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
9919 staticpro (&Qinput_method_use_echo_area
);
9921 Fset (Qinput_method_exit_on_first_char
, Qnil
);
9922 Fset (Qinput_method_use_echo_area
, Qnil
);
9925 struct event_head
*p
;
9927 for (p
= head_table
;
9928 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
9931 *p
->var
= intern (p
->name
);
9933 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
9934 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
9938 button_down_location
= Fmake_vector (make_number (1), Qnil
);
9939 staticpro (&button_down_location
);
9940 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
9941 staticpro (&mouse_syms
);
9945 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
9947 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
9948 for (i
= 0; i
< len
; i
++)
9949 if (modifier_names
[i
])
9950 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
9951 staticpro (&modifier_symbols
);
9954 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
9955 staticpro (&recent_keys
);
9957 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
9958 staticpro (&this_command_keys
);
9960 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
9961 staticpro (&raw_keybuf
);
9963 Qextended_command_history
= intern ("extended-command-history");
9964 Fset (Qextended_command_history
, Qnil
);
9965 staticpro (&Qextended_command_history
);
9967 kbd_buffer_frame_or_window
9968 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
9969 staticpro (&kbd_buffer_frame_or_window
);
9971 accent_key_syms
= Qnil
;
9972 staticpro (&accent_key_syms
);
9974 func_key_syms
= Qnil
;
9975 staticpro (&func_key_syms
);
9978 mouse_wheel_syms
= Qnil
;
9979 staticpro (&mouse_wheel_syms
);
9981 drag_n_drop_syms
= Qnil
;
9982 staticpro (&drag_n_drop_syms
);
9985 unread_switch_frame
= Qnil
;
9986 staticpro (&unread_switch_frame
);
9988 internal_last_event_frame
= Qnil
;
9989 staticpro (&internal_last_event_frame
);
9991 read_key_sequence_cmd
= Qnil
;
9992 staticpro (&read_key_sequence_cmd
);
9994 menu_bar_one_keymap_changed_items
= Qnil
;
9995 staticpro (&menu_bar_one_keymap_changed_items
);
9997 defsubr (&Sevent_convert_list
);
9998 defsubr (&Sread_key_sequence
);
9999 defsubr (&Sread_key_sequence_vector
);
10000 defsubr (&Srecursive_edit
);
10002 defsubr (&Strack_mouse
);
10004 defsubr (&Sinput_pending_p
);
10005 defsubr (&Scommand_execute
);
10006 defsubr (&Srecent_keys
);
10007 defsubr (&Sthis_command_keys
);
10008 defsubr (&Sthis_command_keys_vector
);
10009 defsubr (&Sthis_single_command_keys
);
10010 defsubr (&Sthis_single_command_raw_keys
);
10011 defsubr (&Sreset_this_command_lengths
);
10012 defsubr (&Sclear_this_command_keys
);
10013 defsubr (&Ssuspend_emacs
);
10014 defsubr (&Sabort_recursive_edit
);
10015 defsubr (&Sexit_recursive_edit
);
10016 defsubr (&Srecursion_depth
);
10017 defsubr (&Stop_level
);
10018 defsubr (&Sdiscard_input
);
10019 defsubr (&Sopen_dribble_file
);
10020 defsubr (&Sset_input_mode
);
10021 defsubr (&Scurrent_input_mode
);
10022 defsubr (&Sexecute_extended_command
);
10024 DEFVAR_LISP ("last-command-char", &last_command_char
,
10025 "Last input event that was part of a command.");
10027 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10028 "Last input event that was part of a command.");
10030 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10031 "Last input event in a command, except for mouse menu events.\n\
10032 Mouse menus give back keys that don't look like mouse events;\n\
10033 this variable holds the actual mouse event that led to the menu,\n\
10034 so that you can determine whether the command was run by mouse or not.");
10036 DEFVAR_LISP ("last-input-char", &last_input_char
,
10037 "Last input event.");
10039 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10040 "Last input event.");
10042 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10043 "List of events to be read as the command input.\n\
10044 These events are processed first, before actual keyboard input.");
10045 Vunread_command_events
= Qnil
;
10047 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10048 "If not -1, an object to be read as next command input event.");
10050 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10051 "List of events to be processed as input by input methods.\n\
10052 These events are processed after `unread-command-events', but\n\
10053 before actual keyboard input.");
10054 Vunread_post_input_method_events
= Qnil
;
10056 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10057 "List of events to be processed as input by input methods.\n\
10058 These events are processed after `unread-command-events', but\n\
10059 before actual keyboard input.");
10060 Vunread_input_method_events
= Qnil
;
10062 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10063 "Meta-prefix character code.\n\
10064 Meta-foo as command input turns into this character followed by foo.");
10065 XSETINT (meta_prefix_char
, 033);
10067 DEFVAR_KBOARD ("last-command", Vlast_command
,
10068 "The last command executed.\n\
10069 Normally a symbol with a function definition, but can be whatever was found\n\
10070 in the keymap, or whatever the variable `this-command' was set to by that\n\
10073 The value `mode-exit' is special; it means that the previous command\n\
10074 read an event that told it to exit, and it did so and unread that event.\n\
10075 In other words, the present command is the event that made the previous\n\
10078 The value `kill-region' is special; it means that the previous command\n\
10079 was a kill command.");
10081 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10082 "Same as `last-command', but never altered by Lisp code.");
10084 DEFVAR_LISP ("this-command", &Vthis_command
,
10085 "The command now being executed.\n\
10086 The command can set this variable; whatever is put here\n\
10087 will be in `last-command' during the following command.");
10088 Vthis_command
= Qnil
;
10090 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10091 "*Number of input events between auto-saves.\n\
10092 Zero means disable autosaving due to number of characters typed.");
10093 auto_save_interval
= 300;
10095 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10096 "*Number of seconds idle time before auto-save.\n\
10097 Zero or nil means disable auto-saving due to idleness.\n\
10098 After auto-saving due to this many seconds of idle time,\n\
10099 Emacs also does a garbage collection if that seems to be warranted.");
10100 XSETFASTINT (Vauto_save_timeout
, 30);
10102 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10103 "*Nonzero means echo unfinished commands after this many seconds of pause.\n\
10104 The value may be integer or floating point.");
10105 Vecho_keystrokes
= make_number (1);
10107 DEFVAR_INT ("polling-period", &polling_period
,
10108 "*Interval between polling for input during Lisp execution.\n\
10109 The reason for polling is to make C-g work to stop a running program.\n\
10110 Polling is needed only when using X windows and SIGIO does not work.\n\
10111 Polling is automatically disabled in all other cases.");
10112 polling_period
= 2;
10114 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10115 "*Maximum time between mouse clicks to make a double-click.\n\
10116 Measured in milliseconds. nil means disable double-click recognition;\n\
10117 t means double-clicks have no time limit and are detected\n\
10118 by position only.");
10119 Vdouble_click_time
= make_number (500);
10121 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10122 "*Non-nil means inhibit local map menu bar menus.");
10123 inhibit_local_menu_bar_menus
= 0;
10125 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10126 "Number of complete key sequences read as input so far.\n\
10127 This includes key sequences read from keyboard macros.\n\
10128 The number is effectively the number of interactive command invocations.");
10129 num_input_keys
= 0;
10131 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10132 "Number of input events read from the keyboard so far.\n\
10133 This does not include events generated by keyboard macros.");
10134 num_nonmacro_input_events
= 0;
10136 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10137 "The frame in which the most recently read event occurred.\n\
10138 If the last event came from a keyboard macro, this is set to `macro'.");
10139 Vlast_event_frame
= Qnil
;
10141 /* This variable is set up in sysdep.c. */
10142 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10143 "The ERASE character as set by the user with stty.");
10145 DEFVAR_LISP ("help-char", &Vhelp_char
,
10146 "Character to recognize as meaning Help.\n\
10147 When it is read, do `(eval help-form)', and display result if it's a string.\n\
10148 If the value of `help-form' is nil, this char can be read normally.");
10149 XSETINT (Vhelp_char
, Ctl ('H'));
10151 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10152 "List of input events to recognize as meaning Help.\n\
10153 These work just like the value of `help-char' (see that).");
10154 Vhelp_event_list
= Qnil
;
10156 DEFVAR_LISP ("help-form", &Vhelp_form
,
10157 "Form to execute when character `help-char' is read.\n\
10158 If the form returns a string, that string is displayed.\n\
10159 If `help-form' is nil, the help char is not recognized.");
10162 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10163 "Command to run when `help-char' character follows a prefix key.\n\
10164 This command is used only when there is no actual binding\n\
10165 for that character after that prefix key.");
10166 Vprefix_help_command
= Qnil
;
10168 DEFVAR_LISP ("top-level", &Vtop_level
,
10169 "Form to evaluate when Emacs starts up.\n\
10170 Useful to set before you dump a modified Emacs.");
10173 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10174 "Translate table for keyboard input, or nil.\n\
10175 Each character is looked up in this string and the contents used instead.\n\
10176 The value may be a string, a vector, or a char-table.\n\
10177 If it is a string or vector of length N,\n\
10178 character codes N and up are untranslated.\n\
10179 In a vector or a char-table, an element which is nil means \"no translation\".");
10180 Vkeyboard_translate_table
= Qnil
;
10182 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10183 "Non-nil means to always spawn a subshell instead of suspending.\n\
10184 \(Even if the operating system has support for stopping a process.\)");
10185 cannot_suspend
= 0;
10187 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10188 "Non-nil means prompt with menus when appropriate.\n\
10189 This is done when reading from a keymap that has a prompt string,\n\
10190 for elements that have prompt strings.\n\
10191 The menu is displayed on the screen\n\
10192 if X menus were enabled at configuration\n\
10193 time and the previous event was a mouse click prefix key.\n\
10194 Otherwise, menu prompting uses the echo area.");
10195 menu_prompting
= 1;
10197 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10198 "Character to see next line of menu prompt.\n\
10199 Type this character while in a menu prompt to rotate around the lines of it.");
10200 XSETINT (menu_prompt_more_char
, ' ');
10202 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10203 "A mask of additional modifier keys to use with every keyboard character.\n\
10204 Emacs applies the modifiers of the character stored here to each keyboard\n\
10205 character it reads. For example, after evaluating the expression\n\
10206 (setq extra-keyboard-modifiers ?\\C-x)\n\
10207 all input characters will have the control modifier applied to them.\n\
10209 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
10210 not count as a control character; rather, it counts as a character\n\
10211 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
10212 cancels any modification.");
10213 extra_keyboard_modifiers
= 0;
10215 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10216 "If an editing command sets this to t, deactivate the mark afterward.\n\
10217 The command loop sets this to nil before each command,\n\
10218 and tests the value when the command returns.\n\
10219 Buffer modification stores t in this variable.");
10220 Vdeactivate_mark
= Qnil
;
10222 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10223 "Temporary storage of pre-command-hook or post-command-hook.");
10224 Vcommand_hook_internal
= Qnil
;
10226 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10227 "Normal hook run before each command is executed.\n\
10228 If an unhandled error happens in running this hook,\n\
10229 the hook value is set to nil, since otherwise the error\n\
10230 might happen repeatedly and make Emacs nonfunctional.");
10231 Vpre_command_hook
= Qnil
;
10233 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10234 "Normal hook run after each command is executed.\n\
10235 If an unhandled error happens in running this hook,\n\
10236 the hook value is set to nil, since otherwise the error\n\
10237 might happen repeatedly and make Emacs nonfunctional.");
10238 Vpost_command_hook
= Qnil
;
10240 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10241 "Normal hook run after each command is executed, if idle.\n\
10242 Errors running the hook are caught and ignored.\n\
10243 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
10244 Vpost_command_idle_hook
= Qnil
;
10246 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10247 "Delay time before running `post-command-idle-hook'.\n\
10248 This is measured in microseconds.");
10249 post_command_idle_delay
= 100000;
10252 DEFVAR_LISP ("echo-area-clear-hook", ...,
10253 "Normal hook run when clearing the echo area.");
10255 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10256 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
10258 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10259 "t means menu bar, specified Lucid style, needs to be recomputed.");
10260 Vlucid_menu_bar_dirty_flag
= Qnil
;
10262 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10263 "List of menu bar items to move to the end of the menu bar.\n\
10264 The elements of the list are event types that may have menu bar bindings.");
10265 Vmenu_bar_final_items
= Qnil
;
10267 DEFVAR_KBOARD ("overriding-terminal-local-map",
10268 Voverriding_terminal_local_map
,
10269 "Per-terminal keymap that overrides all other local keymaps.\n\
10270 If this variable is non-nil, it is used as a keymap instead of the\n\
10271 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
10272 This variable is intended to let commands such as `universal-argumemnt'\n\
10273 set up a different keymap for reading the next command.");
10275 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10276 "Keymap that overrides all other local keymaps.\n\
10277 If this variable is non-nil, it is used as a keymap instead of the\n\
10278 buffer's local map, and the minor mode keymaps and text property keymaps.");
10279 Voverriding_local_map
= Qnil
;
10281 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10282 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
10283 Otherwise, the menu bar continues to reflect the buffer's local map\n\
10284 and the minor mode maps regardless of `overriding-local-map'.");
10285 Voverriding_local_map_menu_flag
= Qnil
;
10287 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10288 "Keymap defining bindings for special events to execute at low level.");
10289 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10291 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10292 "*Non-nil means generate motion events for mouse motion.");
10294 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10295 "Alist of system-specific X windows key symbols.\n\
10296 Each element should have the form (N . SYMBOL) where N is the\n\
10297 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
10298 and SYMBOL is its name.");
10300 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10301 "List of deferred actions to be performed at a later time.\n\
10302 The precise format isn't relevant here; we just check whether it is nil.");
10303 Vdeferred_action_list
= Qnil
;
10305 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10306 "Function to call to handle deferred actions, after each command.\n\
10307 This function is called with no arguments after each command\n\
10308 whenever `deferred-action-list' is non-nil.");
10309 Vdeferred_action_function
= Qnil
;
10311 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10312 "*Non-nil means show the equivalent key-binding when M-x command has one.\n\
10313 The value can be a length of time to show the message for.\n\
10314 If the value is non-nil and not a number, we wait 2 seconds.");
10315 Vsuggest_key_bindings
= Qt
;
10317 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10318 "List of active absolute time timers in order of increasing time");
10319 Vtimer_list
= Qnil
;
10321 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10322 "List of active idle-time timers in order of increasing time");
10323 Vtimer_idle_list
= Qnil
;
10325 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10326 "If non-nil, the function that implements the current input method.\n\
10327 It's called with one argument, a printing character that was just read.\n\
10328 \(That means a character with code 040...0176.)\n\
10329 Typically this function uses `read-event' to read additional events.\n\
10330 When it does so, it should first bind `input-method-function' to nil\n\
10331 so it will not be called recursively.\n\
10333 The function should return a list of zero or more events\n\
10334 to be used as input. If it wants to put back some events\n\
10335 to be reconsidered, separately, by the input method,\n\
10336 it can add them to the beginning of `unread-command-events'.\n\
10338 The input method function can find in `input-method-previous-method'\n\
10339 the previous echo area message.\n\
10341 The input method function should refer to the variables\n\
10342 `input-method-use-echo-area' and `input-method-exit-on-first-char'\n\
10343 for guidance on what to do.");
10344 Vinput_method_function
= Qnil
;
10346 DEFVAR_LISP ("input-method-previous-message",
10347 &Vinput_method_previous_message
,
10348 "When `input-method-function' is called, hold the previous echo area message.\n\
10349 This variable exists because `read-event' clears the echo area\n\
10350 before running the input method. It is nil if there was no message.");
10351 Vinput_method_previous_message
= Qnil
;
10353 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10354 "If non-nil, the function that implements the display of help.\n\
10355 It's called with one argument, the help string to display.");
10356 Vshow_help_function
= Qnil
;
10358 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10359 "If non-nil, suppress point adjustment after executing a command.\n\
10361 After a command is executed, if point is moved into a region that has\n\
10362 special properties (e.g. composition, display), we adjust point to\n\
10363 the boundary of the region. But, several special commands sets this\n\
10364 variable to non-nil, then we suppress the point adjustment.\n\
10366 This variable is set to nil before reading a command, and is checked\n\
10367 just after executing the command");
10368 Vdisable_point_adjustment
= Qnil
;
10370 DEFVAR_LISP ("global-disable-point-adjustment",
10371 &Vglobal_disable_point_adjustment
,
10372 "*If non-nil, always suppress point adjustment.\n\
10374 The default value is nil, in which case, point adjustment are\n\
10375 suppressed only after special commands that set\n\
10376 `disable-point-adjustment' (which see) to non-nil.");
10377 Vglobal_disable_point_adjustment
= Qnil
;
10381 keys_of_keyboard ()
10383 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
10384 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
10385 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
10386 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
10387 initial_define_key (meta_map
, 'x', "execute-extended-command");
10389 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
10390 "handle-delete-frame");
10391 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
10393 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",