1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000, 01, 02
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"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* 1 after calling Freset_this_command_lengths.
150 int this_command_key_count_reset
;
152 /* This vector is used as a buffer to record the events that were actually read
153 by read_key_sequence. */
154 Lisp_Object raw_keybuf
;
155 int raw_keybuf_count
;
157 #define GROW_RAW_KEYBUF \
158 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
160 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
162 new = Fmake_vector (make_number (newsize), Qnil); \
163 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
164 raw_keybuf_count * sizeof (Lisp_Object)); \
168 /* Number of elements of this_command_keys
169 that precede this key sequence. */
170 int this_single_command_key_start
;
172 /* Record values of this_command_key_count and echo_length ()
173 before this command was read. */
174 static int before_command_key_count
;
175 static int before_command_echo_length
;
177 extern int minbuf_level
;
179 extern int message_enable_multibyte
;
181 extern struct backtrace
*backtrace_list
;
183 /* If non-nil, the function that implements the display of help.
184 It's called with one argument, the help string to display. */
186 Lisp_Object Vshow_help_function
;
188 /* If a string, the message displayed before displaying a help-echo
191 Lisp_Object Vpre_help_message
;
193 /* Nonzero means do menu prompting. */
195 static int menu_prompting
;
197 /* Character to see next line of menu prompt. */
199 static Lisp_Object menu_prompt_more_char
;
201 /* For longjmp to where kbd input is being done. */
203 static jmp_buf getcjmp
;
205 /* True while doing kbd input. */
206 int waiting_for_input
;
208 /* True while displaying for echoing. Delays C-g throwing. */
212 /* Non-null means we can start echoing at the next input pause even
213 though there is something in the echo area. */
215 static struct kboard
*ok_to_echo_at_next_pause
;
217 /* The kboard last echoing, or null for none. Reset to 0 in
218 cancel_echoing. If non-null, and a current echo area message
219 exists, and echo_message_buffer is eq to the current message
220 buffer, we know that the message comes from echo_kboard. */
222 struct kboard
*echo_kboard
;
224 /* The buffer used for echoing. Set in echo_now, reset in
227 Lisp_Object echo_message_buffer
;
229 /* Nonzero means disregard local maps for the menu bar. */
230 static int inhibit_local_menu_bar_menus
;
232 /* Nonzero means C-g should cause immediate error-signal. */
235 /* The user's ERASE setting. */
236 Lisp_Object Vtty_erase_char
;
238 /* Character to recognize as the help char. */
239 Lisp_Object Vhelp_char
;
241 /* List of other event types to recognize as meaning "help". */
242 Lisp_Object Vhelp_event_list
;
244 /* Form to execute when help char is typed. */
245 Lisp_Object Vhelp_form
;
247 /* Command to run when the help character follows a prefix key. */
248 Lisp_Object Vprefix_help_command
;
250 /* List of items that should move to the end of the menu bar. */
251 Lisp_Object Vmenu_bar_final_items
;
253 /* Non-nil means show the equivalent key-binding for
254 any M-x command that has one.
255 The value can be a length of time to show the message for.
256 If the value is non-nil and not a number, we wait 2 seconds. */
257 Lisp_Object Vsuggest_key_bindings
;
259 /* How long to display an echo-area message when the minibuffer is active.
260 If the value is not a number, such messages don't time out. */
261 Lisp_Object Vminibuffer_message_timeout
;
263 /* Character that causes a quit. Normally C-g.
265 If we are running on an ordinary terminal, this must be an ordinary
266 ASCII char, since we want to make it our interrupt character.
268 If we are not running on an ordinary terminal, it still needs to be
269 an ordinary ASCII char. This character needs to be recognized in
270 the input interrupt handler. At this point, the keystroke is
271 represented as a struct input_event, while the desired quit
272 character is specified as a lispy event. The mapping from struct
273 input_events to lispy events cannot run in an interrupt handler,
274 and the reverse mapping is difficult for anything but ASCII
277 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
281 extern Lisp_Object current_global_map
;
282 extern int minibuf_level
;
284 /* If non-nil, this is a map that overrides all other local maps. */
285 Lisp_Object Voverriding_local_map
;
287 /* If non-nil, Voverriding_local_map applies to the menu bar. */
288 Lisp_Object Voverriding_local_map_menu_flag
;
290 /* Keymap that defines special misc events that should
291 be processed immediately at a low level. */
292 Lisp_Object Vspecial_event_map
;
294 /* Current depth in recursive edits. */
295 int command_loop_level
;
297 /* Total number of times command_loop has read a key sequence. */
298 EMACS_INT num_input_keys
;
300 /* Last input character read as a command. */
301 Lisp_Object last_command_char
;
303 /* Last input character read as a command, not counting menus
304 reached by the mouse. */
305 Lisp_Object last_nonmenu_event
;
307 /* Last input character read for any purpose. */
308 Lisp_Object last_input_char
;
310 /* If not Qnil, a list of objects to be read as subsequent command input. */
311 Lisp_Object Vunread_command_events
;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 including input method processing. */
315 Lisp_Object Vunread_input_method_events
;
317 /* If not Qnil, a list of objects to be read as subsequent command input
318 but NOT including input method processing. */
319 Lisp_Object Vunread_post_input_method_events
;
321 /* If not -1, an event to be read as subsequent command input. */
322 EMACS_INT unread_command_char
;
324 /* If not Qnil, this is a switch-frame event which we decided to put
325 off until the end of a key sequence. This should be read as the
326 next command input, after any unread_command_events.
328 read_key_sequence uses this to delay switch-frame events until the
329 end of the key sequence; Fread_char uses it to put off switch-frame
330 events until a non-ASCII event is acceptable as input. */
331 Lisp_Object unread_switch_frame
;
333 /* A mask of extra modifier bits to put into every keyboard char. */
334 EMACS_INT extra_keyboard_modifiers
;
336 /* Char to use as prefix when a meta character is typed in.
337 This is bound on entry to minibuffer in case ESC is changed there. */
339 Lisp_Object meta_prefix_char
;
341 /* Last size recorded for a current buffer which is not a minibuffer. */
342 static int last_non_minibuf_size
;
344 /* Number of idle seconds before an auto-save and garbage collection. */
345 static Lisp_Object Vauto_save_timeout
;
347 /* Total number of times read_char has returned. */
348 int num_input_events
;
350 /* Total number of times read_char has returned, outside of macros. */
351 EMACS_INT num_nonmacro_input_events
;
353 /* Auto-save automatically when this many characters have been typed
354 since the last time. */
356 static EMACS_INT auto_save_interval
;
358 /* Value of num_nonmacro_input_events as of last auto save. */
362 /* The command being executed by the command loop.
363 Commands may set this, and the value set will be copied into
364 current_kboard->Vlast_command instead of the actual command. */
365 Lisp_Object Vthis_command
;
367 /* This is like Vthis_command, except that commands never set it. */
368 Lisp_Object real_this_command
;
370 /* If the lookup of the command returns a binding, the original
371 command is stored in this-original-command. It is nil otherwise. */
372 Lisp_Object Vthis_original_command
;
374 /* The value of point when the last command was executed. */
375 int last_point_position
;
377 /* The buffer that was current when the last command was started. */
378 Lisp_Object last_point_position_buffer
;
380 /* The frame in which the last input event occurred, or Qmacro if the
381 last event came from a macro. We use this to determine when to
382 generate switch-frame events. This may be cleared by functions
383 like Fselect_frame, to make sure that a switch-frame event is
384 generated by the next character. */
385 Lisp_Object internal_last_event_frame
;
387 /* A user-visible version of the above, intended to allow users to
388 figure out where the last event came from, if the event doesn't
389 carry that information itself (i.e. if it was a character). */
390 Lisp_Object Vlast_event_frame
;
392 /* The timestamp of the last input event we received from the X server.
393 X Windows wants this for selection ownership. */
394 unsigned long last_event_timestamp
;
396 Lisp_Object Qself_insert_command
;
397 Lisp_Object Qforward_char
;
398 Lisp_Object Qbackward_char
;
399 Lisp_Object Qundefined
;
400 Lisp_Object Qtimer_event_handler
;
402 /* read_key_sequence stores here the command definition of the
403 key sequence that it reads. */
404 Lisp_Object read_key_sequence_cmd
;
406 /* Echo unfinished commands after this many seconds of pause. */
407 Lisp_Object Vecho_keystrokes
;
409 /* Form to evaluate (if non-nil) when Emacs is started. */
410 Lisp_Object Vtop_level
;
412 /* User-supplied table to translate input characters. */
413 Lisp_Object Vkeyboard_translate_table
;
415 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
416 extern Lisp_Object Vfunction_key_map
;
418 /* Another keymap that maps key sequences into key sequences.
419 This one takes precedence over ordinary definitions. */
420 extern Lisp_Object Vkey_translation_map
;
422 /* If non-nil, this implements the current input method. */
423 Lisp_Object Vinput_method_function
;
424 Lisp_Object Qinput_method_function
;
426 /* When we call Vinput_method_function,
427 this holds the echo area message that was just erased. */
428 Lisp_Object Vinput_method_previous_message
;
430 /* Non-nil means deactivate the mark at end of this command. */
431 Lisp_Object Vdeactivate_mark
;
433 /* Menu bar specified in Lucid Emacs fashion. */
435 Lisp_Object Vlucid_menu_bar_dirty_flag
;
436 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
438 Lisp_Object Qecho_area_clear_hook
;
440 /* Hooks to run before and after each command. */
441 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
442 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
443 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Hook run after a command if there's no more input soon. */
445 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
447 /* Delay time in microseconds before running post-command-idle-hook. */
448 EMACS_INT post_command_idle_delay
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
468 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
472 /* Non-zero means force key bindings update in parse_menu_item. */
474 int update_menu_bindings
;
476 extern char *pending_malloc_warning
;
478 /* Circular buffer for pre-read keyboard input. */
480 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
482 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
484 The interrupt-level event handlers will never enqueue an event on a
485 frame which is not in Vframe_list, and once an event is dequeued,
486 internal_last_event_frame or the event itself points to the frame.
489 But while the event is sitting in the queue, it's completely
490 unprotected. Suppose the user types one command which will run for
491 a while and then delete a frame, and then types another event at
492 the frame that will be deleted, before the command gets around to
493 it. Suppose there are no references to this frame elsewhere in
494 Emacs, and a GC occurs before the second event is dequeued. Now we
495 have an event referring to a freed frame, which will crash Emacs
498 Similar things happen when an event on a scroll bar is enqueued; the
499 window may be deleted while the event is in the queue.
501 So, we use this vector to protect the Lisp_Objects in the event
502 queue. That way, they'll be dequeued as dead frames or windows,
503 but still valid Lisp objects.
505 If kbd_buffer[i].kind != NO_EVENT, then
507 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
508 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
510 static Lisp_Object kbd_buffer_gcpro
;
512 /* Pointer to next available character in kbd_buffer.
513 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
514 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
515 next available char is in kbd_buffer[0]. */
516 static struct input_event
*kbd_fetch_ptr
;
518 /* Pointer to next place to store character in kbd_buffer. This
519 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
520 character should go in kbd_buffer[0]. */
521 static struct input_event
* volatile kbd_store_ptr
;
523 /* The above pair of variables forms a "queue empty" flag. When we
524 enqueue a non-hook event, we increment kbd_store_ptr. When we
525 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
526 there is input available iff the two pointers are not equal.
528 Why not just have a flag set and cleared by the enqueuing and
529 dequeuing functions? Such a flag could be screwed up by interrupts
530 at inopportune times. */
532 /* If this flag is non-nil, we check mouse_moved to see when the
533 mouse moves, and motion events will appear in the input stream.
534 Otherwise, mouse motion is ignored. */
535 Lisp_Object do_mouse_tracking
;
537 /* Symbols to head events. */
538 Lisp_Object Qmouse_movement
;
539 Lisp_Object Qscroll_bar_movement
;
540 Lisp_Object Qswitch_frame
;
541 Lisp_Object Qdelete_frame
;
542 Lisp_Object Qiconify_frame
;
543 Lisp_Object Qmake_frame_visible
;
544 Lisp_Object Qselect_window
;
545 Lisp_Object Qhelp_echo
;
547 /* Symbols to denote kinds of events. */
548 Lisp_Object Qfunction_key
;
549 Lisp_Object Qmouse_click
;
550 #if defined(WINDOWSNT) || defined(MAC_OSX)
551 Lisp_Object Qmouse_wheel
;
554 Lisp_Object Qlanguage_change
;
556 Lisp_Object Qdrag_n_drop
;
557 Lisp_Object Qsave_session
;
559 /* Lisp_Object Qmouse_movement; - also an event header */
561 /* Properties of event headers. */
562 Lisp_Object Qevent_kind
;
563 Lisp_Object Qevent_symbol_elements
;
565 /* menu item parts */
566 Lisp_Object Qmenu_alias
;
567 Lisp_Object Qmenu_enable
;
568 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
569 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
570 extern Lisp_Object Vdefine_key_rebound_commands
;
571 extern Lisp_Object Qmenu_item
;
573 /* An event header symbol HEAD may have a property named
574 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
575 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
576 mask of modifiers applied to it. If present, this is used to help
577 speed up parse_modifiers. */
578 Lisp_Object Qevent_symbol_element_mask
;
580 /* An unmodified event header BASE may have a property named
581 Qmodifier_cache, which is an alist mapping modifier masks onto
582 modified versions of BASE. If present, this helps speed up
584 Lisp_Object Qmodifier_cache
;
586 /* Symbols to use for parts of windows. */
587 Lisp_Object Qmode_line
;
588 Lisp_Object Qvertical_line
;
589 Lisp_Object Qvertical_scroll_bar
;
590 Lisp_Object Qmenu_bar
;
591 extern Lisp_Object Qleft_margin
, Qright_margin
;
593 Lisp_Object
recursive_edit_unwind (), command_loop ();
594 Lisp_Object
Fthis_command_keys ();
595 Lisp_Object Qextended_command_history
;
596 EMACS_TIME
timer_check ();
598 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
600 extern char *x_get_keysym_name ();
602 static void record_menu_key ();
603 static int echo_length ();
605 Lisp_Object Qpolling_period
;
607 /* List of absolute timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_list
;
610 /* List of idle time timers. Appears in order of next scheduled event. */
611 Lisp_Object Vtimer_idle_list
;
613 /* Incremented whenever a timer is run. */
616 extern Lisp_Object Vprint_level
, Vprint_length
;
618 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
620 EMACS_TIME
*input_available_clear_time
;
622 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
623 Default is 1 if INTERRUPT_INPUT is defined. */
626 /* Nonzero while interrupts are temporarily deferred during redisplay. */
627 int interrupts_deferred
;
629 /* Nonzero means use ^S/^Q for flow control. */
632 /* Allow m- file to inhibit use of FIONREAD. */
633 #ifdef BROKEN_FIONREAD
637 /* We are unable to use interrupts if FIONREAD is not available,
638 so flush SIGIO so we won't try. */
645 /* If we support a window system, turn on the code to poll periodically
646 to detect C-g. It isn't actually used when doing interrupt input. */
647 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
648 #define POLL_FOR_INPUT
651 /* After a command is executed, if point is moved into a region that
652 has specific properties (e.g. composition, display), we adjust
653 point to the boundary of the region. But, if a command sets this
654 variable to non-nil, we suppress this point adjustment. This
655 variable is set to nil before reading a command. */
657 Lisp_Object Vdisable_point_adjustment
;
659 /* If non-nil, always disable point adjustment. */
661 Lisp_Object Vglobal_disable_point_adjustment
;
663 /* The time when Emacs started being idle. */
665 static EMACS_TIME timer_idleness_start_time
;
667 /* After Emacs stops being idle, this saves the last value
668 of timer_idleness_start_time from when it was idle. */
670 static EMACS_TIME timer_last_idleness_start_time
;
673 /* Global variable declarations. */
675 /* Function for init_keyboard to call with no args (if nonzero). */
676 void (*keyboard_init_hook
) ();
678 static int read_avail_input
P_ ((int));
679 static void get_input_pending
P_ ((int *, int));
680 static void get_filtered_input_pending
P_ ((int *, int, int));
681 static int readable_events
P_ ((int));
682 static int readable_filtered_events
P_ ((int, int));
683 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
684 Lisp_Object
, int *));
685 static Lisp_Object
read_char_x_menu_prompt ();
686 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
688 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
690 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
691 enum scroll_bar_part
,
692 Lisp_Object
, Lisp_Object
,
695 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
696 Lisp_Object
, char **,
697 Lisp_Object
*, unsigned));
698 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
699 static int parse_solitary_modifier
P_ ((Lisp_Object
));
700 static int parse_solitary_modifier ();
701 static void save_getcjmp
P_ ((jmp_buf));
702 static void save_getcjmp ();
703 static void restore_getcjmp
P_ ((jmp_buf));
704 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
705 static void clear_event
P_ ((struct input_event
*));
706 static void any_kboard_state
P_ ((void));
707 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
709 /* Nonzero means don't try to suspend even if the operating system seems
711 static int cannot_suspend
;
713 /* Install the string STR as the beginning of the string of echoing,
714 so that it serves as a prompt for the next character.
715 Also start echoing. */
721 current_kboard
->echo_string
= str
;
722 current_kboard
->echo_after_prompt
= SCHARS (str
);
726 /* Add C to the echo string, if echoing is going on.
727 C can be a character, which is printed prettily ("M-C-x" and all that
728 jazz), or a symbol, whose name is printed. */
734 if (current_kboard
->immediate_echo
)
736 int size
= KEY_DESCRIPTION_SIZE
+ 100;
737 char *buffer
= (char *) alloca (size
);
739 Lisp_Object echo_string
;
741 echo_string
= current_kboard
->echo_string
;
743 /* If someone has passed us a composite event, use its head symbol. */
748 ptr
= push_key_description (XINT (c
), ptr
, 1);
750 else if (SYMBOLP (c
))
752 Lisp_Object name
= SYMBOL_NAME (c
);
753 int nbytes
= SBYTES (name
);
755 if (size
- (ptr
- buffer
) < nbytes
)
757 int offset
= ptr
- buffer
;
758 size
= max (2 * size
, size
+ nbytes
);
759 buffer
= (char *) alloca (size
);
760 ptr
= buffer
+ offset
;
763 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
764 STRING_MULTIBYTE (name
), 1);
767 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
770 const char *text
= " (Type ? for further options)";
771 int len
= strlen (text
);
773 if (size
- (ptr
- buffer
) < len
)
775 int offset
= ptr
- buffer
;
777 buffer
= (char *) alloca (size
);
778 ptr
= buffer
+ offset
;
781 bcopy (text
, ptr
, len
);
785 /* Replace a dash from echo_dash with a space, otherwise
786 add a space at the end as a separator between keys. */
787 if (STRINGP (echo_string
)
788 && SCHARS (echo_string
) > 1)
790 Lisp_Object last_char
, prev_char
, idx
;
792 idx
= make_number (SCHARS (echo_string
) - 2);
793 prev_char
= Faref (echo_string
, idx
);
795 idx
= make_number (SCHARS (echo_string
) - 1);
796 last_char
= Faref (echo_string
, idx
);
798 /* We test PREV_CHAR to make sure this isn't the echoing
800 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
801 Faset (echo_string
, idx
, make_number (' '));
803 echo_string
= concat2 (echo_string
, build_string (" "));
806 current_kboard
->echo_string
807 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
813 /* Temporarily add a dash to the end of the echo string if it's not
814 empty, so that it serves as a mini-prompt for the very next character. */
819 /* Do nothing if not echoing at all. */
820 if (NILP (current_kboard
->echo_string
))
823 if (!current_kboard
->immediate_echo
824 && SCHARS (current_kboard
->echo_string
) == 0)
827 /* Do nothing if we just printed a prompt. */
828 if (current_kboard
->echo_after_prompt
829 == SCHARS (current_kboard
->echo_string
))
832 /* Put a dash at the end of the buffer temporarily,
833 but make it go away when the next character is added. */
834 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
839 /* Display the current echo string, and begin echoing if not already
845 if (!current_kboard
->immediate_echo
)
848 current_kboard
->immediate_echo
= 1;
850 for (i
= 0; i
< this_command_key_count
; i
++)
854 /* Set before_command_echo_length to the value that would
855 have been saved before the start of this subcommand in
856 command_loop_1, if we had already been echoing then. */
857 if (i
== this_single_command_key_start
)
858 before_command_echo_length
= echo_length ();
860 c
= XVECTOR (this_command_keys
)->contents
[i
];
861 if (! (EVENT_HAS_PARAMETERS (c
)
862 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
866 /* Set before_command_echo_length to the value that would
867 have been saved before the start of this subcommand in
868 command_loop_1, if we had already been echoing then. */
869 if (this_command_key_count
== this_single_command_key_start
)
870 before_command_echo_length
= echo_length ();
872 /* Put a dash at the end to invite the user to type more. */
877 message3_nolog (current_kboard
->echo_string
,
878 SBYTES (current_kboard
->echo_string
),
879 STRING_MULTIBYTE (current_kboard
->echo_string
));
882 /* Record in what buffer we echoed, and from which kboard. */
883 echo_message_buffer
= echo_area_buffer
[0];
884 echo_kboard
= current_kboard
;
886 if (waiting_for_input
&& !NILP (Vquit_flag
))
887 quit_throw_to_read_char ();
890 /* Turn off echoing, for the start of a new command. */
895 current_kboard
->immediate_echo
= 0;
896 current_kboard
->echo_after_prompt
= -1;
897 current_kboard
->echo_string
= Qnil
;
898 ok_to_echo_at_next_pause
= NULL
;
900 echo_message_buffer
= Qnil
;
903 /* Return the length of the current echo string. */
908 return (STRINGP (current_kboard
->echo_string
)
909 ? SCHARS (current_kboard
->echo_string
)
913 /* Truncate the current echo message to its first LEN chars.
914 This and echo_char get used by read_key_sequence when the user
915 switches frames while entering a key sequence. */
918 echo_truncate (nchars
)
921 if (STRINGP (current_kboard
->echo_string
))
922 current_kboard
->echo_string
923 = Fsubstring (current_kboard
->echo_string
,
924 make_number (0), make_number (nchars
));
925 truncate_echo_area (nchars
);
929 /* Functions for manipulating this_command_keys. */
931 add_command_key (key
)
934 #if 0 /* Not needed after we made Freset_this_command_lengths
935 do the job immediately. */
936 /* If reset-this-command-length was called recently, obey it now.
937 See the doc string of that function for an explanation of why. */
938 if (before_command_restore_flag
)
940 this_command_key_count
= before_command_key_count_1
;
941 if (this_command_key_count
< this_single_command_key_start
)
942 this_single_command_key_start
= this_command_key_count
;
943 echo_truncate (before_command_echo_length_1
);
944 before_command_restore_flag
= 0;
948 if (this_command_key_count
>= ASIZE (this_command_keys
))
949 this_command_keys
= larger_vector (this_command_keys
,
950 2 * ASIZE (this_command_keys
),
953 AREF (this_command_keys
, this_command_key_count
) = key
;
954 ++this_command_key_count
;
961 int count
= SPECPDL_INDEX ();
964 if (command_loop_level
> 0)
966 specbind (Qstandard_output
, Qt
);
967 specbind (Qstandard_input
, Qt
);
970 #ifdef HAVE_X_WINDOWS
971 /* The command loop has started an hourglass timer, so we have to
972 cancel it here, otherwise it will fire because the recursive edit
973 can take some time. Do not check for display_hourglass_p here,
974 because it could already be nil. */
978 /* This function may have been called from a debugger called from
979 within redisplay, for instance by Edebugging a function called
980 from fontification-functions. We want to allow redisplay in
981 the debugging session.
983 The recursive edit is left with a `(throw exit ...)'. The `exit'
984 tag is not caught anywhere in redisplay, i.e. when we leave the
985 recursive edit, the original redisplay leading to the recursive
986 edit will be unwound. The outcome should therefore be safe. */
987 specbind (Qinhibit_redisplay
, Qnil
);
990 val
= command_loop ();
992 Fsignal (Qquit
, Qnil
);
993 /* Handle throw from read_minibuf when using minibuffer
994 while it's active but we're in another window. */
996 Fsignal (Qerror
, Fcons (val
, Qnil
));
998 return unbind_to (count
, Qnil
);
1001 /* When an auto-save happens, record the "time", and don't do again soon. */
1006 last_auto_save
= num_nonmacro_input_events
;
1009 /* Make an auto save happen as soon as possible at command level. */
1012 force_auto_save_soon ()
1014 last_auto_save
= - auto_save_interval
- 1;
1016 record_asynch_buffer_change ();
1019 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1020 doc
: /* Invoke the editor command loop recursively.
1021 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1022 that tells this function to return.
1023 Alternately, `(throw 'exit t)' makes this function signal an error.
1024 This function is called by the editor initialization to begin editing. */)
1027 int count
= SPECPDL_INDEX ();
1030 command_loop_level
++;
1031 update_mode_lines
= 1;
1033 if (command_loop_level
1034 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1035 buffer
= Fcurrent_buffer ();
1039 /* If we leave recursive_edit_1 below with a `throw' for instance,
1040 like it is done in the splash screen display, we have to
1041 make sure that we restore single_kboard as command_loop_1
1042 would have done if it were left normally. */
1043 record_unwind_protect (recursive_edit_unwind
,
1044 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1046 recursive_edit_1 ();
1047 return unbind_to (count
, Qnil
);
1051 recursive_edit_unwind (info
)
1054 if (BUFFERP (XCAR (info
)))
1055 Fset_buffer (XCAR (info
));
1057 if (NILP (XCDR (info
)))
1058 any_kboard_state ();
1060 single_kboard_state ();
1062 command_loop_level
--;
1063 update_mode_lines
= 1;
1072 #if 0 /* Theory: if there's anything in Vunread_command_events,
1073 it will right away be read by read_key_sequence,
1074 and then if we do switch KBOARDS, it will go into the side
1075 queue then. So we don't need to do anything special here -- rms. */
1076 if (CONSP (Vunread_command_events
))
1078 current_kboard
->kbd_queue
1079 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1080 current_kboard
->kbd_queue_has_data
= 1;
1082 Vunread_command_events
= Qnil
;
1088 /* Switch to the single-kboard state, making current_kboard
1089 the only KBOARD from which further input is accepted. */
1092 single_kboard_state ()
1099 /* Maintain a stack of kboards, so other parts of Emacs
1100 can switch temporarily to the kboard of a given frame
1101 and then revert to the previous status. */
1106 struct kboard_stack
*next
;
1109 static struct kboard_stack
*kboard_stack
;
1112 push_frame_kboard (f
)
1116 struct kboard_stack
*p
1117 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1119 p
->next
= kboard_stack
;
1120 p
->kboard
= current_kboard
;
1123 current_kboard
= FRAME_KBOARD (f
);
1131 struct kboard_stack
*p
= kboard_stack
;
1132 current_kboard
= p
->kboard
;
1133 kboard_stack
= p
->next
;
1138 /* Handle errors that are not handled at inner levels
1139 by printing an error message and returning to the editor command loop. */
1145 Lisp_Object old_level
, old_length
;
1146 char macroerror
[50];
1148 #ifdef HAVE_X_WINDOWS
1149 if (display_hourglass_p
)
1150 cancel_hourglass ();
1153 if (!NILP (executing_macro
))
1155 if (executing_macro_iterations
== 1)
1156 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1158 sprintf (macroerror
, "After %d kbd macro iterations: ",
1159 executing_macro_iterations
);
1164 Vstandard_output
= Qt
;
1165 Vstandard_input
= Qt
;
1166 Vexecuting_macro
= Qnil
;
1167 executing_macro
= Qnil
;
1168 current_kboard
->Vprefix_arg
= Qnil
;
1169 current_kboard
->Vlast_prefix_arg
= Qnil
;
1172 /* Avoid unquittable loop if data contains a circular list. */
1173 old_level
= Vprint_level
;
1174 old_length
= Vprint_length
;
1175 XSETFASTINT (Vprint_level
, 10);
1176 XSETFASTINT (Vprint_length
, 10);
1177 cmd_error_internal (data
, macroerror
);
1178 Vprint_level
= old_level
;
1179 Vprint_length
= old_length
;
1183 Vinhibit_quit
= Qnil
;
1185 any_kboard_state ();
1188 return make_number (0);
1191 /* Take actions on handling an error. DATA is the data that describes
1194 CONTEXT is a C-string containing ASCII characters only which
1195 describes the context in which the error happened. If we need to
1196 generalize CONTEXT to allow multibyte characters, make it a Lisp
1200 cmd_error_internal (data
, context
)
1205 int kill_emacs_p
= 0;
1206 struct frame
*sf
= SELECTED_FRAME ();
1210 clear_message (1, 0);
1212 /* If the window system or terminal frame hasn't been initialized
1213 yet, or we're not interactive, it's best to dump this message out
1214 to stderr and exit. */
1215 if (!sf
->glyphs_initialized_p
1216 /* This is the case of the frame dumped with Emacs, when we're
1217 running under a window system. */
1218 || (!NILP (Vwindow_system
)
1219 && !inhibit_window_system
1220 && FRAME_TERMCAP_P (sf
))
1223 stream
= Qexternal_debugging_output
;
1229 message_log_maybe_newline ();
1234 /* The immediate context is not interesting for Quits,
1235 since they are asyncronous. */
1236 if (EQ (XCAR (data
), Qquit
))
1237 Vsignaling_function
= Qnil
;
1239 print_error_message (data
, stream
, context
, Vsignaling_function
);
1241 Vsignaling_function
= Qnil
;
1243 /* If the window system or terminal frame hasn't been initialized
1244 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1248 Fkill_emacs (make_number (-1));
1252 Lisp_Object
command_loop_1 ();
1253 Lisp_Object
command_loop_2 ();
1254 Lisp_Object
top_level_1 ();
1256 /* Entry to editor-command-loop.
1257 This level has the catches for exiting/returning to editor command loop.
1258 It returns nil to exit recursive edit, t to abort it. */
1263 if (command_loop_level
> 0 || minibuf_level
> 0)
1266 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1267 executing_macro
= Qnil
;
1273 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1274 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1275 executing_macro
= Qnil
;
1277 /* End of file in -batch run causes exit here. */
1283 /* Here we catch errors in execution of commands within the
1284 editing loop, and reenter the editing loop.
1285 When there is an error, cmd_error runs and returns a non-nil
1286 value to us. A value of nil means that command_loop_1 itself
1287 returned due to end of file (or end of kbd macro). */
1292 register Lisp_Object val
;
1295 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1296 while (!NILP (val
));
1304 return Feval (Vtop_level
);
1310 /* On entry to the outer level, run the startup file */
1311 if (!NILP (Vtop_level
))
1312 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1313 else if (!NILP (Vpurify_flag
))
1314 message ("Bare impure Emacs (standard Lisp code not loaded)");
1316 message ("Bare Emacs (standard Lisp code not loaded)");
1320 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1321 doc
: /* Exit all recursive editing levels. */)
1324 #ifdef HAVE_X_WINDOWS
1325 if (display_hourglass_p
)
1326 cancel_hourglass ();
1328 return Fthrow (Qtop_level
, Qnil
);
1331 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1332 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1335 if (command_loop_level
> 0 || minibuf_level
> 0)
1336 Fthrow (Qexit
, Qnil
);
1338 error ("No recursive edit is in progress");
1342 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1343 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1346 if (command_loop_level
> 0 || minibuf_level
> 0)
1349 error ("No recursive edit is in progress");
1353 /* This is the actual command reading loop,
1354 sans error-handling encapsulation. */
1356 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1358 void safe_run_hooks
P_ ((Lisp_Object
));
1359 static void adjust_point_for_property
P_ ((int, int));
1361 /* Cancel hourglass from protect_unwind.
1363 #ifdef HAVE_X_WINDOWS
1365 cancel_hourglass_unwind (arg
)
1368 cancel_hourglass ();
1378 Lisp_Object keybuf
[30];
1382 struct buffer
*prev_buffer
= NULL
;
1384 int was_locked
= single_kboard
;
1386 int already_adjusted
;
1388 current_kboard
->Vprefix_arg
= Qnil
;
1389 current_kboard
->Vlast_prefix_arg
= Qnil
;
1390 Vdeactivate_mark
= Qnil
;
1391 waiting_for_input
= 0;
1395 this_command_key_count
= 0;
1396 this_command_key_count_reset
= 0;
1397 this_single_command_key_start
= 0;
1399 if (NILP (Vmemory_full
))
1401 /* Make sure this hook runs after commands that get errors and
1402 throw to top level. */
1403 /* Note that the value cell will never directly contain nil
1404 if the symbol is a local variable. */
1405 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1406 safe_run_hooks (Qpost_command_hook
);
1408 /* If displaying a message, resize the echo area window to fit
1409 that message's size exactly. */
1410 if (!NILP (echo_area_buffer
[0]))
1411 resize_echo_area_exactly ();
1413 if (!NILP (Vdeferred_action_list
))
1414 call0 (Vdeferred_action_function
);
1416 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1418 if (NILP (Vunread_command_events
)
1419 && NILP (Vunread_input_method_events
)
1420 && NILP (Vunread_post_input_method_events
)
1421 && NILP (Vexecuting_macro
)
1422 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1423 safe_run_hooks (Qpost_command_idle_hook
);
1427 Vmemory_full
= Qnil
;
1429 /* Do this after running Vpost_command_hook, for consistency. */
1430 current_kboard
->Vlast_command
= Vthis_command
;
1431 current_kboard
->Vreal_last_command
= real_this_command
;
1435 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1438 /* Make sure the current window's buffer is selected. */
1439 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1440 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1442 /* Display any malloc warning that just came out. Use while because
1443 displaying one warning can cause another. */
1445 while (pending_malloc_warning
)
1446 display_malloc_warning ();
1450 Vdeactivate_mark
= Qnil
;
1452 /* If minibuffer on and echo area in use,
1453 wait a short time and redraw minibuffer. */
1456 && !NILP (echo_area_buffer
[0])
1457 && EQ (minibuf_window
, echo_area_window
)
1458 && NUMBERP (Vminibuffer_message_timeout
))
1460 /* Bind inhibit-quit to t so that C-g gets read in
1461 rather than quitting back to the minibuffer. */
1462 int count
= SPECPDL_INDEX ();
1463 specbind (Qinhibit_quit
, Qt
);
1465 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1466 /* Clear the echo area. */
1468 safe_run_hooks (Qecho_area_clear_hook
);
1470 unbind_to (count
, Qnil
);
1472 /* If a C-g came in before, treat it as input now. */
1473 if (!NILP (Vquit_flag
))
1476 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1481 alloca (0); /* Cause a garbage collection now */
1482 /* Since we can free the most stuff here. */
1483 #endif /* C_ALLOCA */
1486 /* Select the frame that the last event came from. Usually,
1487 switch-frame events will take care of this, but if some lisp
1488 code swallows a switch-frame event, we'll fix things up here.
1489 Is this a good idea? */
1490 if (FRAMEP (internal_last_event_frame
)
1491 && !EQ (internal_last_event_frame
, selected_frame
))
1492 Fselect_frame (internal_last_event_frame
, Qnil
);
1494 /* If it has changed current-menubar from previous value,
1495 really recompute the menubar from the value. */
1496 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1497 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1498 call0 (Qrecompute_lucid_menubar
);
1500 before_command_key_count
= this_command_key_count
;
1501 before_command_echo_length
= echo_length ();
1503 Vthis_command
= Qnil
;
1504 real_this_command
= Qnil
;
1506 /* Read next key sequence; i gets its length. */
1507 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1510 /* A filter may have run while we were reading the input. */
1511 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1513 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1514 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1518 /* Now we have read a key sequence of length I,
1519 or else I is 0 and we found end of file. */
1521 if (i
== 0) /* End of file -- happens only in */
1522 return Qnil
; /* a kbd macro, at the end. */
1523 /* -1 means read_key_sequence got a menu that was rejected.
1524 Just loop around and read another command. */
1528 this_command_key_count
= 0;
1529 this_command_key_count_reset
= 0;
1530 this_single_command_key_start
= 0;
1534 last_command_char
= keybuf
[i
- 1];
1536 /* If the previous command tried to force a specific window-start,
1537 forget about that, in case this command moves point far away
1538 from that position. But also throw away beg_unchanged and
1539 end_unchanged information in that case, so that redisplay will
1540 update the whole window properly. */
1541 if (!NILP (XWINDOW (selected_window
)->force_start
))
1544 XWINDOW (selected_window
)->force_start
= Qnil
;
1545 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1546 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1549 cmd
= read_key_sequence_cmd
;
1550 if (!NILP (Vexecuting_macro
))
1552 if (!NILP (Vquit_flag
))
1554 Vexecuting_macro
= Qt
;
1555 QUIT
; /* Make some noise. */
1556 /* Will return since macro now empty. */
1560 /* Do redisplay processing after this command except in special
1561 cases identified below. */
1562 prev_buffer
= current_buffer
;
1563 prev_modiff
= MODIFF
;
1564 last_point_position
= PT
;
1565 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1567 /* By default, we adjust point to a boundary of a region that
1568 has such a property that should be treated intangible
1569 (e.g. composition, display). But, some commands will set
1570 this variable differently. */
1571 Vdisable_point_adjustment
= Qnil
;
1573 /* Process filters and timers may have messed with deactivate-mark.
1574 reset it before we execute the command. */
1575 Vdeactivate_mark
= Qnil
;
1577 /* Remap command through active keymaps */
1578 Vthis_original_command
= cmd
;
1582 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1586 /* Execute the command. */
1588 Vthis_command
= cmd
;
1589 real_this_command
= cmd
;
1590 /* Note that the value cell will never directly contain nil
1591 if the symbol is a local variable. */
1592 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1593 safe_run_hooks (Qpre_command_hook
);
1595 already_adjusted
= 0;
1597 if (NILP (Vthis_command
))
1599 /* nil means key is undefined. */
1601 current_kboard
->defining_kbd_macro
= Qnil
;
1602 update_mode_lines
= 1;
1603 current_kboard
->Vprefix_arg
= Qnil
;
1607 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1609 /* In case we jump to directly_done. */
1610 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1612 /* Recognize some common commands in common situations and
1613 do them directly. */
1614 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1616 struct Lisp_Char_Table
*dp
1617 = window_display_table (XWINDOW (selected_window
));
1618 lose
= FETCH_CHAR (PT_BYTE
);
1620 if (! NILP (Vpost_command_hook
))
1621 /* Put this before calling adjust_point_for_property
1622 so it will only get called once in any case. */
1624 if (current_buffer
== prev_buffer
1625 && last_point_position
!= PT
1626 && NILP (Vdisable_point_adjustment
)
1627 && NILP (Vglobal_disable_point_adjustment
))
1628 adjust_point_for_property (last_point_position
, 0);
1629 already_adjusted
= 1;
1630 if (PT
== last_point_position
+ 1
1632 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1633 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1634 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1635 && (lose
>= 0x20 && lose
< 0x7f)))
1636 : (lose
>= 0x20 && lose
< 0x7f))
1637 /* To extract the case of continuation on
1638 wide-column characters. */
1639 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1640 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1642 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1644 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1646 && !windows_or_buffers_changed
1647 && EQ (current_buffer
->selective_display
, Qnil
)
1648 && !detect_input_pending ()
1649 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1650 && NILP (Vexecuting_macro
))
1651 direct_output_forward_char (1);
1654 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1656 struct Lisp_Char_Table
*dp
1657 = window_display_table (XWINDOW (selected_window
));
1659 lose
= FETCH_CHAR (PT_BYTE
);
1660 if (! NILP (Vpost_command_hook
))
1662 if (current_buffer
== prev_buffer
1663 && last_point_position
!= PT
1664 && NILP (Vdisable_point_adjustment
)
1665 && NILP (Vglobal_disable_point_adjustment
))
1666 adjust_point_for_property (last_point_position
, 0);
1667 already_adjusted
= 1;
1668 if (PT
== last_point_position
- 1
1670 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1671 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1672 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1673 && (lose
>= 0x20 && lose
< 0x7f)))
1674 : (lose
>= 0x20 && lose
< 0x7f))
1675 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1677 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1679 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1681 && !windows_or_buffers_changed
1682 && EQ (current_buffer
->selective_display
, Qnil
)
1683 && !detect_input_pending ()
1684 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1685 && NILP (Vexecuting_macro
))
1686 direct_output_forward_char (-1);
1689 else if (EQ (Vthis_command
, Qself_insert_command
)
1690 /* Try this optimization only on char keystrokes. */
1691 && NATNUMP (last_command_char
)
1692 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1695 = translate_char (Vtranslation_table_for_input
,
1696 XFASTINT (last_command_char
), 0, 0, 0);
1698 if (NILP (Vexecuting_macro
)
1699 && !EQ (minibuf_window
, selected_window
))
1701 if (!nonundocount
|| nonundocount
>= 20)
1709 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1711 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1713 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1715 || MODIFF
<= SAVE_MODIFF
1716 || windows_or_buffers_changed
1717 || !EQ (current_buffer
->selective_display
, Qnil
)
1718 || detect_input_pending ()
1719 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1720 || !NILP (Vexecuting_macro
));
1722 value
= internal_self_insert (c
, 0);
1727 if (! NILP (Vpost_command_hook
))
1728 /* Put this before calling adjust_point_for_property
1729 so it will only get called once in any case. */
1732 /* VALUE == 1 when AFTER-CHANGE functions are
1733 installed which is the case most of the time
1734 because FONT-LOCK installs one. */
1735 if (!lose
&& !value
)
1736 direct_output_for_insert (c
);
1741 /* Here for a command that isn't executed directly */
1744 #ifdef HAVE_X_WINDOWS
1745 int scount
= SPECPDL_INDEX ();
1747 if (display_hourglass_p
1748 && NILP (Vexecuting_macro
))
1750 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1756 if (NILP (current_kboard
->Vprefix_arg
))
1758 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1760 #ifdef HAVE_X_WINDOWS
1761 /* Do not check display_hourglass_p here, because
1762 Fcommand_execute could change it, but we should cancel
1763 hourglass cursor anyway.
1764 But don't cancel the hourglass within a macro
1765 just because a command in the macro finishes. */
1766 if (NILP (Vexecuting_macro
))
1767 unbind_to (scount
, Qnil
);
1772 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1774 /* Note that the value cell will never directly contain nil
1775 if the symbol is a local variable. */
1776 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1777 safe_run_hooks (Qpost_command_hook
);
1779 /* If displaying a message, resize the echo area window to fit
1780 that message's size exactly. */
1781 if (!NILP (echo_area_buffer
[0]))
1782 resize_echo_area_exactly ();
1784 if (!NILP (Vdeferred_action_list
))
1785 safe_run_hooks (Qdeferred_action_function
);
1787 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1789 if (NILP (Vunread_command_events
)
1790 && NILP (Vunread_input_method_events
)
1791 && NILP (Vunread_post_input_method_events
)
1792 && NILP (Vexecuting_macro
)
1793 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1794 safe_run_hooks (Qpost_command_idle_hook
);
1797 /* If there is a prefix argument,
1798 1) We don't want Vlast_command to be ``universal-argument''
1799 (that would be dumb), so don't set Vlast_command,
1800 2) we want to leave echoing on so that the prefix will be
1801 echoed as part of this key sequence, so don't call
1803 3) we want to leave this_command_key_count non-zero, so that
1804 read_char will realize that it is re-reading a character, and
1805 not echo it a second time.
1807 If the command didn't actually create a prefix arg,
1808 but is merely a frame event that is transparent to prefix args,
1809 then the above doesn't apply. */
1810 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1812 current_kboard
->Vlast_command
= Vthis_command
;
1813 current_kboard
->Vreal_last_command
= real_this_command
;
1815 this_command_key_count
= 0;
1816 this_command_key_count_reset
= 0;
1817 this_single_command_key_start
= 0;
1820 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1822 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1824 /* We could also call `deactivate'mark'. */
1825 if (EQ (Vtransient_mark_mode
, Qlambda
))
1826 Vtransient_mark_mode
= Qnil
;
1829 current_buffer
->mark_active
= Qnil
;
1830 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1833 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1834 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1839 if (current_buffer
== prev_buffer
1840 && last_point_position
!= PT
1841 && NILP (Vdisable_point_adjustment
)
1842 && NILP (Vglobal_disable_point_adjustment
)
1843 && !already_adjusted
)
1844 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1846 /* Install chars successfully executed in kbd macro. */
1848 if (!NILP (current_kboard
->defining_kbd_macro
)
1849 && NILP (current_kboard
->Vprefix_arg
))
1850 finalize_kbd_macro_chars ();
1854 any_kboard_state ();
1859 extern Lisp_Object Qcomposition
, Qdisplay
;
1861 /* Adjust point to a boundary of a region that has such a property
1862 that should be treated intangible. For the moment, we check
1863 `composition', `display' and `invisible' properties.
1864 LAST_PT is the last position of point. */
1866 extern Lisp_Object Qafter_string
, Qbefore_string
;
1867 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1870 adjust_point_for_property (last_pt
, modified
)
1875 Lisp_Object val
, overlay
, tmp
;
1876 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1878 while (check_composition
|| check_display
|| check_invisible
)
1880 if (check_composition
1881 && PT
> BEGV
&& PT
< ZV
1882 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1883 && COMPOSITION_VALID_P (beg
, end
, val
)
1884 && beg
< PT
/* && end > PT <- It's always the case. */
1885 && (last_pt
<= beg
|| last_pt
>= end
))
1888 SET_PT (PT
< last_pt
? beg
: end
);
1889 check_display
= check_invisible
= 1;
1891 check_composition
= 0;
1893 && PT
> BEGV
&& PT
< ZV
1894 && !NILP (val
= get_char_property_and_overlay
1895 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1896 && display_prop_intangible_p (val
)
1897 && (!OVERLAYP (overlay
)
1898 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1899 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1900 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1901 && beg
< PT
) /* && end > PT <- It's always the case. */
1904 SET_PT (PT
< last_pt
? beg
: end
);
1905 check_composition
= check_invisible
= 1;
1908 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1910 int inv
, ellipsis
= 0;
1913 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1915 && !NILP (val
= get_char_property_and_overlay
1916 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1917 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1919 ellipsis
= ellipsis
|| inv
> 1
1920 || (OVERLAYP (overlay
)
1921 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1922 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1923 tmp
= Fnext_single_char_property_change
1924 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1925 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1928 && !NILP (val
= get_char_property_and_overlay
1929 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1930 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1932 ellipsis
= ellipsis
|| inv
> 1
1933 || (OVERLAYP (overlay
)
1934 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1935 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1936 tmp
= Fprevious_single_char_property_change
1937 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1938 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1941 /* Move away from the inside area. */
1942 if (beg
< PT
&& end
> PT
)
1944 SET_PT (PT
< last_pt
? beg
: end
);
1945 check_composition
= check_display
= 1;
1947 xassert (PT
== beg
|| PT
== end
);
1948 /* Pretend the area doesn't exist if the buffer is not
1950 if (!modified
&& !ellipsis
&& beg
< end
)
1952 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1953 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1954 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1955 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1956 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1957 /* We've already moved as far as we can. Trying to go
1958 to the other end would mean moving backwards and thus
1959 could lead to an infinite loop. */
1961 else if (val
= get_pos_property (make_number (PT
),
1963 TEXT_PROP_MEANS_INVISIBLE (val
)
1964 && (val
= get_pos_property
1965 (make_number (PT
== beg
? end
: beg
),
1967 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1968 (check_composition
= check_display
= 1,
1969 SET_PT (PT
== beg
? end
: beg
));
1972 check_invisible
= 0;
1976 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1979 safe_run_hooks_1 (hook
)
1982 return call1 (Vrun_hooks
, Vinhibit_quit
);
1985 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1988 safe_run_hooks_error (data
)
1991 return Fset (Vinhibit_quit
, Qnil
);
1994 /* If we get an error while running the hook, cause the hook variable
1995 to be nil. Also inhibit quits, so that C-g won't cause the hook
1996 to mysteriously evaporate. */
1999 safe_run_hooks (hook
)
2002 int count
= SPECPDL_INDEX ();
2003 specbind (Qinhibit_quit
, hook
);
2005 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2007 unbind_to (count
, Qnil
);
2011 /* Number of seconds between polling for input. This is a Lisp
2012 variable that can be bound. */
2014 EMACS_INT polling_period
;
2016 /* Nonzero means polling for input is temporarily suppressed. */
2018 int poll_suppress_count
;
2020 /* Asynchronous timer for polling. */
2022 struct atimer
*poll_timer
;
2025 #ifdef POLL_FOR_INPUT
2027 /* Poll for input, so what we catch a C-g if it comes in. This
2028 function is called from x_make_frame_visible, see comment
2034 if (interrupt_input_blocked
== 0
2035 && !waiting_for_input
)
2036 read_avail_input (0);
2039 /* Timer callback function for poll_timer. TIMER is equal to
2043 poll_for_input (timer
)
2044 struct atimer
*timer
;
2046 if (poll_suppress_count
== 0)
2047 poll_for_input_1 ();
2050 #endif /* POLL_FOR_INPUT */
2052 /* Begin signals to poll for input, if they are appropriate.
2053 This function is called unconditionally from various places. */
2058 #ifdef POLL_FOR_INPUT
2059 if (read_socket_hook
&& !interrupt_input
)
2061 /* Turn alarm handling on unconditionally. It might have
2062 been turned off in process.c. */
2063 turn_on_atimers (1);
2065 /* If poll timer doesn't exist, are we need one with
2066 a different interval, start a new one. */
2067 if (poll_timer
== NULL
2068 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2070 EMACS_TIME interval
;
2073 cancel_atimer (poll_timer
);
2075 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2076 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2077 poll_for_input
, NULL
);
2080 /* Let the timer's callback function poll for input
2081 if this becomes zero. */
2082 --poll_suppress_count
;
2087 /* Nonzero if we are using polling to handle input asynchronously. */
2090 input_polling_used ()
2092 #ifdef POLL_FOR_INPUT
2093 return read_socket_hook
&& !interrupt_input
;
2099 /* Turn off polling. */
2104 #ifdef POLL_FOR_INPUT
2105 if (read_socket_hook
&& !interrupt_input
)
2106 ++poll_suppress_count
;
2110 /* Set the value of poll_suppress_count to COUNT
2111 and start or stop polling accordingly. */
2114 set_poll_suppress_count (count
)
2117 #ifdef POLL_FOR_INPUT
2118 if (count
== 0 && poll_suppress_count
!= 0)
2120 poll_suppress_count
= 1;
2123 else if (count
!= 0 && poll_suppress_count
== 0)
2127 poll_suppress_count
= count
;
2131 /* Bind polling_period to a value at least N.
2132 But don't decrease it. */
2135 bind_polling_period (n
)
2138 #ifdef POLL_FOR_INPUT
2139 int new = polling_period
;
2144 stop_other_atimers (poll_timer
);
2146 specbind (Qpolling_period
, make_number (new));
2147 /* Start a new alarm with the new period. */
2152 /* Apply the control modifier to CHARACTER. */
2158 /* Save the upper bits here. */
2159 int upper
= c
& ~0177;
2163 /* Everything in the columns containing the upper-case letters
2164 denotes a control character. */
2165 if (c
>= 0100 && c
< 0140)
2169 /* Set the shift modifier for a control char
2170 made from a shifted letter. But only for letters! */
2171 if (oc
>= 'A' && oc
<= 'Z')
2172 c
|= shift_modifier
;
2175 /* The lower-case letters denote control characters too. */
2176 else if (c
>= 'a' && c
<= 'z')
2179 /* Include the bits for control and shift
2180 only if the basic ASCII code can't indicate them. */
2184 /* Replace the high bits. */
2185 c
|= (upper
& ~ctrl_modifier
);
2190 /* Display help echo in the echo area.
2192 HELP a string means display that string, HELP nil means clear the
2193 help echo. If HELP is a function, call it with OBJECT and POS as
2194 arguments; the function should return a help string or nil for
2195 none. For all other types of HELP evaluate it to obtain a string.
2197 WINDOW is the window in which the help was generated, if any.
2198 It is nil if not in a window.
2200 If OBJECT is a buffer, POS is the position in the buffer where the
2201 `help-echo' text property was found.
2203 If OBJECT is an overlay, that overlay has a `help-echo' property,
2204 and POS is the position in the overlay's buffer under the mouse.
2206 If OBJECT is a string (an overlay string or a string displayed with
2207 the `display' property). POS is the position in that string under
2210 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2211 echo overwrites a keystroke echo currently displayed in the echo
2214 Note: this function may only be called with HELP nil or a string
2215 from X code running asynchronously. */
2218 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2219 Lisp_Object help
, window
, object
, pos
;
2220 int ok_to_overwrite_keystroke_echo
;
2222 if (!NILP (help
) && !STRINGP (help
))
2224 if (FUNCTIONP (help
))
2226 Lisp_Object args
[4];
2231 help
= safe_call (4, args
);
2234 help
= safe_eval (help
);
2236 if (!STRINGP (help
))
2240 if (STRINGP (help
) || NILP (help
))
2242 if (!NILP (Vshow_help_function
))
2243 call1 (Vshow_help_function
, help
);
2244 else if (/* Don't overwrite minibuffer contents. */
2245 !MINI_WINDOW_P (XWINDOW (selected_window
))
2246 /* Don't overwrite a keystroke echo. */
2247 && (NILP (echo_message_buffer
)
2248 || ok_to_overwrite_keystroke_echo
)
2249 /* Don't overwrite a prompt. */
2250 && !cursor_in_echo_area
)
2254 int count
= SPECPDL_INDEX ();
2256 if (!help_echo_showing_p
)
2257 Vpre_help_message
= current_message ();
2259 specbind (Qmessage_truncate_lines
, Qt
);
2260 message3_nolog (help
, SBYTES (help
),
2261 STRING_MULTIBYTE (help
));
2262 unbind_to (count
, Qnil
);
2264 else if (STRINGP (Vpre_help_message
))
2266 message3_nolog (Vpre_help_message
,
2267 SBYTES (Vpre_help_message
),
2268 STRING_MULTIBYTE (Vpre_help_message
));
2269 Vpre_help_message
= Qnil
;
2275 help_echo_showing_p
= STRINGP (help
);
2281 /* Input of single characters from keyboard */
2283 Lisp_Object
print_help ();
2284 static Lisp_Object
kbd_buffer_get_event ();
2285 static void record_char ();
2288 static jmp_buf wrong_kboard_jmpbuf
;
2291 #define STOP_POLLING \
2292 do { if (! polling_stopped_here) stop_polling (); \
2293 polling_stopped_here = 1; } while (0)
2295 #define RESUME_POLLING \
2296 do { if (polling_stopped_here) start_polling (); \
2297 polling_stopped_here = 0; } while (0)
2299 /* read a character from the keyboard; call the redisplay if needed */
2300 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2301 -1 means do not do redisplay, but do do autosaving.
2304 /* The arguments MAPS and NMAPS are for menu prompting.
2305 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2307 PREV_EVENT is the previous input event, or nil if we are reading
2308 the first event of a key sequence (or not reading a key sequence).
2309 If PREV_EVENT is t, that is a "magic" value that says
2310 not to run input methods, but in other respects to act as if
2311 not reading a key sequence.
2313 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2314 if we used a mouse menu to read the input, or zero otherwise. If
2315 USED_MOUSE_MENU is null, we don't dereference it.
2317 Value is t if we showed a menu and the user rejected it. */
2320 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2324 Lisp_Object prev_event
;
2325 int *used_mouse_menu
;
2327 volatile Lisp_Object c
;
2329 jmp_buf local_getcjmp
;
2331 volatile int key_already_recorded
= 0;
2332 Lisp_Object tem
, save
;
2333 volatile Lisp_Object previous_echo_area_message
;
2334 volatile Lisp_Object also_record
;
2335 volatile int reread
;
2336 struct gcpro gcpro1
, gcpro2
;
2337 EMACS_TIME last_idle_start
;
2338 int polling_stopped_here
= 0;
2342 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2343 before_command_key_count
= this_command_key_count
;
2344 before_command_echo_length
= echo_length ();
2347 previous_echo_area_message
= Qnil
;
2349 GCPRO2 (c
, previous_echo_area_message
);
2354 if (CONSP (Vunread_post_input_method_events
))
2356 c
= XCAR (Vunread_post_input_method_events
);
2357 Vunread_post_input_method_events
2358 = XCDR (Vunread_post_input_method_events
);
2360 /* Undo what read_char_x_menu_prompt did when it unread
2361 additional keys returned by Fx_popup_menu. */
2363 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2371 if (unread_command_char
!= -1)
2373 XSETINT (c
, unread_command_char
);
2374 unread_command_char
= -1;
2380 if (CONSP (Vunread_command_events
))
2382 c
= XCAR (Vunread_command_events
);
2383 Vunread_command_events
= XCDR (Vunread_command_events
);
2385 /* Undo what read_char_x_menu_prompt did when it unread
2386 additional keys returned by Fx_popup_menu. */
2388 && EQ (XCDR (c
), Qdisabled
)
2389 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2392 /* If the queued event is something that used the mouse,
2393 set used_mouse_menu accordingly. */
2395 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2396 *used_mouse_menu
= 1;
2399 goto reread_for_input_method
;
2402 if (CONSP (Vunread_input_method_events
))
2404 c
= XCAR (Vunread_input_method_events
);
2405 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2407 /* Undo what read_char_x_menu_prompt did when it unread
2408 additional keys returned by Fx_popup_menu. */
2410 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2414 goto reread_for_input_method
;
2417 this_command_key_count_reset
= 0;
2419 if (!NILP (Vexecuting_macro
))
2421 /* We set this to Qmacro; since that's not a frame, nobody will
2422 try to switch frames on us, and the selected window will
2425 Since this event came from a macro, it would be misleading to
2426 leave internal_last_event_frame set to wherever the last
2427 real event came from. Normally, a switch-frame event selects
2428 internal_last_event_frame after each command is read, but
2429 events read from a macro should never cause a new frame to be
2431 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2433 /* Exit the macro if we are at the end.
2434 Also, some things replace the macro with t
2435 to force an early exit. */
2436 if (EQ (Vexecuting_macro
, Qt
)
2437 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2443 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2444 if (STRINGP (Vexecuting_macro
)
2445 && (XINT (c
) & 0x80))
2446 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2448 executing_macro_index
++;
2453 if (!NILP (unread_switch_frame
))
2455 c
= unread_switch_frame
;
2456 unread_switch_frame
= Qnil
;
2458 /* This event should make it into this_command_keys, and get echoed
2459 again, so we do not set `reread'. */
2463 /* if redisplay was requested */
2464 if (commandflag
>= 0)
2466 /* If there is pending input, process any events which are not
2467 user-visible, such as X selection_request events. */
2469 || detect_input_pending_run_timers (0))
2470 swallow_events (0); /* may clear input_pending */
2472 /* Redisplay if no pending input. */
2473 while (!input_pending
)
2475 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2476 redisplay_preserve_echo_area (5);
2481 /* Normal case: no input arrived during redisplay. */
2484 /* Input arrived and pre-empted redisplay.
2485 Process any events which are not user-visible. */
2487 /* If that cleared input_pending, try again to redisplay. */
2491 /* Message turns off echoing unless more keystrokes turn it on again.
2493 The code in 20.x for the condition was
2495 1. echo_area_glyphs && *echo_area_glyphs
2496 2. && echo_area_glyphs != current_kboard->echobuf
2497 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2499 (1) means there's a current message displayed
2501 (2) means it's not the message from echoing from the current
2504 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2505 is set to a non-null value. This is done in read_char and it is
2506 set to echo_area_glyphs after a call to echo_char. That means
2507 ok_to_echo_at_next_pause is either null or
2508 current_kboard->echobuf with the appropriate current_kboard at
2511 So, condition (3) means in clear text ok_to_echo_at_next_pause
2512 must be either null, or the current message isn't from echoing at
2513 all, or it's from echoing from a different kboard than the
2516 if (/* There currently is something in the echo area. */
2517 !NILP (echo_area_buffer
[0])
2518 && (/* And it's either not from echoing. */
2519 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2520 /* Or it's an echo from a different kboard. */
2521 || echo_kboard
!= current_kboard
2522 /* Or we explicitly allow overwriting whatever there is. */
2523 || ok_to_echo_at_next_pause
== NULL
))
2528 /* Try reading a character via menu prompting in the minibuf.
2529 Try this before the sit-for, because the sit-for
2530 would do the wrong thing if we are supposed to do
2531 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2532 after a mouse event so don't try a minibuf menu. */
2534 if (nmaps
> 0 && INTERACTIVE
2535 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2536 /* Don't bring up a menu if we already have another event. */
2537 && NILP (Vunread_command_events
)
2538 && unread_command_char
< 0
2539 && !detect_input_pending_run_timers (0))
2541 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2544 key_already_recorded
= 1;
2549 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2550 We will do that below, temporarily for short sections of code,
2551 when appropriate. local_getcjmp must be in effect
2552 around any call to sit_for or kbd_buffer_get_event;
2553 it *must not* be in effect when we call redisplay. */
2555 if (_setjmp (local_getcjmp
))
2557 XSETINT (c
, quit_char
);
2558 internal_last_event_frame
= selected_frame
;
2559 Vlast_event_frame
= internal_last_event_frame
;
2560 /* If we report the quit char as an event,
2561 don't do so more than once. */
2562 if (!NILP (Vinhibit_quit
))
2567 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2568 if (kb
!= current_kboard
)
2570 Lisp_Object link
= kb
->kbd_queue
;
2571 /* We shouldn't get here if we were in single-kboard mode! */
2576 while (CONSP (XCDR (link
)))
2578 if (!NILP (XCDR (link
)))
2582 kb
->kbd_queue
= Fcons (c
, Qnil
);
2584 XSETCDR (link
, Fcons (c
, Qnil
));
2585 kb
->kbd_queue_has_data
= 1;
2586 current_kboard
= kb
;
2587 /* This is going to exit from read_char
2588 so we had better get rid of this frame's stuff. */
2590 longjmp (wrong_kboard_jmpbuf
, 1);
2597 timer_start_idle ();
2599 /* If in middle of key sequence and minibuffer not active,
2600 start echoing if enough time elapses. */
2602 if (minibuf_level
== 0
2603 && !current_kboard
->immediate_echo
2604 && this_command_key_count
> 0
2606 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2607 && NILP (Fzerop (Vecho_keystrokes
))
2608 && (/* No message. */
2609 NILP (echo_area_buffer
[0])
2610 /* Or empty message. */
2611 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2612 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2613 /* Or already echoing from same kboard. */
2614 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2615 /* Or not echoing before and echoing allowed. */
2616 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2620 /* After a mouse event, start echoing right away.
2621 This is because we are probably about to display a menu,
2622 and we don't want to delay before doing so. */
2623 if (EVENT_HAS_PARAMETERS (prev_event
))
2628 double duration
= extract_float (Vecho_keystrokes
);
2629 sec
= (int) duration
;
2630 usec
= (duration
- sec
) * 1000000;
2631 save_getcjmp (save_jump
);
2632 restore_getcjmp (local_getcjmp
);
2633 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2634 restore_getcjmp (save_jump
);
2636 && ! CONSP (Vunread_command_events
))
2641 /* Maybe auto save due to number of keystrokes. */
2643 if (commandflag
!= 0
2644 && auto_save_interval
> 0
2645 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2646 && !detect_input_pending_run_timers (0))
2648 Fdo_auto_save (Qnil
, Qnil
);
2649 /* Hooks can actually change some buffers in auto save. */
2653 /* Try reading using an X menu.
2654 This is never confused with reading using the minibuf
2655 because the recursive call of read_char in read_char_minibuf_menu_prompt
2656 does not pass on any keymaps. */
2658 if (nmaps
> 0 && INTERACTIVE
2659 && !NILP (prev_event
)
2660 && EVENT_HAS_PARAMETERS (prev_event
)
2661 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2662 && !EQ (XCAR (prev_event
), Qtool_bar
)
2663 /* Don't bring up a menu if we already have another event. */
2664 && NILP (Vunread_command_events
)
2665 && unread_command_char
< 0)
2667 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2669 /* Now that we have read an event, Emacs is not idle. */
2675 /* Maybe autosave and/or garbage collect due to idleness. */
2677 if (INTERACTIVE
&& NILP (c
))
2679 int delay_level
, buffer_size
;
2681 /* Slow down auto saves logarithmically in size of current buffer,
2682 and garbage collect while we're at it. */
2683 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2684 last_non_minibuf_size
= Z
- BEG
;
2685 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2687 while (buffer_size
> 64)
2688 delay_level
++, buffer_size
-= buffer_size
>> 2;
2689 if (delay_level
< 4) delay_level
= 4;
2690 /* delay_level is 4 for files under around 50k, 7 at 100k,
2691 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2693 /* Auto save if enough time goes by without input. */
2694 if (commandflag
!= 0
2695 && num_nonmacro_input_events
> last_auto_save
2696 && INTEGERP (Vauto_save_timeout
)
2697 && XINT (Vauto_save_timeout
) > 0)
2701 save_getcjmp (save_jump
);
2702 restore_getcjmp (local_getcjmp
);
2703 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2705 restore_getcjmp (save_jump
);
2708 && ! CONSP (Vunread_command_events
))
2710 Fdo_auto_save (Qnil
, Qnil
);
2712 /* If we have auto-saved and there is still no input
2713 available, garbage collect if there has been enough
2714 consing going on to make it worthwhile. */
2715 if (!detect_input_pending_run_timers (0)
2716 && consing_since_gc
> gc_cons_threshold
/ 2)
2717 Fgarbage_collect ();
2724 /* If this has become non-nil here, it has been set by a timer
2725 or sentinel or filter. */
2726 if (CONSP (Vunread_command_events
))
2728 c
= XCAR (Vunread_command_events
);
2729 Vunread_command_events
= XCDR (Vunread_command_events
);
2732 /* Read something from current KBOARD's side queue, if possible. */
2736 if (current_kboard
->kbd_queue_has_data
)
2738 if (!CONSP (current_kboard
->kbd_queue
))
2740 c
= XCAR (current_kboard
->kbd_queue
);
2741 current_kboard
->kbd_queue
2742 = XCDR (current_kboard
->kbd_queue
);
2743 if (NILP (current_kboard
->kbd_queue
))
2744 current_kboard
->kbd_queue_has_data
= 0;
2745 input_pending
= readable_events (0);
2746 if (EVENT_HAS_PARAMETERS (c
)
2747 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2748 internal_last_event_frame
= XCAR (XCDR (c
));
2749 Vlast_event_frame
= internal_last_event_frame
;
2754 /* If current_kboard's side queue is empty check the other kboards.
2755 If one of them has data that we have not yet seen here,
2756 switch to it and process the data waiting for it.
2758 Note: if the events queued up for another kboard
2759 have already been seen here, and therefore are not a complete command,
2760 the kbd_queue_has_data field is 0, so we skip that kboard here.
2761 That's to avoid an infinite loop switching between kboards here. */
2762 if (NILP (c
) && !single_kboard
)
2765 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2766 if (kb
->kbd_queue_has_data
)
2768 current_kboard
= kb
;
2769 /* This is going to exit from read_char
2770 so we had better get rid of this frame's stuff. */
2772 longjmp (wrong_kboard_jmpbuf
, 1);
2781 /* Finally, we read from the main queue,
2782 and if that gives us something we can't use yet, we put it on the
2783 appropriate side queue and try again. */
2789 /* Actually read a character, waiting if necessary. */
2790 save_getcjmp (save_jump
);
2791 restore_getcjmp (local_getcjmp
);
2792 timer_start_idle ();
2793 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2794 restore_getcjmp (save_jump
);
2797 if (! NILP (c
) && (kb
!= current_kboard
))
2799 Lisp_Object link
= kb
->kbd_queue
;
2802 while (CONSP (XCDR (link
)))
2804 if (!NILP (XCDR (link
)))
2808 kb
->kbd_queue
= Fcons (c
, Qnil
);
2810 XSETCDR (link
, Fcons (c
, Qnil
));
2811 kb
->kbd_queue_has_data
= 1;
2815 current_kboard
= kb
;
2816 /* This is going to exit from read_char
2817 so we had better get rid of this frame's stuff. */
2819 longjmp (wrong_kboard_jmpbuf
, 1);
2824 /* Terminate Emacs in batch mode if at eof. */
2825 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2826 Fkill_emacs (make_number (1));
2830 /* Add in any extra modifiers, where appropriate. */
2831 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2832 || ((extra_keyboard_modifiers
& 0177) < ' '
2833 && (extra_keyboard_modifiers
& 0177) != 0))
2834 XSETINT (c
, make_ctrl_char (XINT (c
)));
2836 /* Transfer any other modifier bits directly from
2837 extra_keyboard_modifiers to c. Ignore the actual character code
2838 in the low 16 bits of extra_keyboard_modifiers. */
2839 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2844 /* Record the last idle start time so that we can reset it
2845 should the next event read be a help-echo. */
2846 last_idle_start
= timer_idleness_start_time
;
2852 if (commandflag
>= 0
2853 && !input_pending
&& !detect_input_pending_run_timers (0))
2861 /* Buffer switch events are only for internal wakeups
2862 so don't show them to the user.
2863 Also, don't record a key if we already did. */
2864 if (BUFFERP (c
) || key_already_recorded
)
2867 /* Process special events within read_char
2868 and loop around to read another event. */
2871 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2876 int was_locked
= single_kboard
;
2878 last_input_char
= c
;
2879 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2881 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2882 /* We stopped being idle for this event; undo that. This
2883 prevents automatic window selection (under
2884 mouse_autoselect_window from acting as a real input event, for
2885 example banishing the mouse under mouse-avoidance-mode. */
2886 timer_idleness_start_time
= last_idle_start
;
2888 /* Resume allowing input from any kboard, if that was true before. */
2890 any_kboard_state ();
2895 /* Handle things that only apply to characters. */
2898 /* If kbd_buffer_get_event gave us an EOF, return that. */
2902 if ((STRINGP (Vkeyboard_translate_table
)
2903 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2904 || (VECTORP (Vkeyboard_translate_table
)
2905 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2906 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2907 && CHAR_VALID_P (XINT (c
), 0)))
2910 d
= Faref (Vkeyboard_translate_table
, c
);
2911 /* nil in keyboard-translate-table means no translation. */
2917 /* If this event is a mouse click in the menu bar,
2918 return just menu-bar for now. Modify the mouse click event
2919 so we won't do this twice, then queue it up. */
2920 if (EVENT_HAS_PARAMETERS (c
)
2922 && CONSP (EVENT_START (c
))
2923 && CONSP (XCDR (EVENT_START (c
))))
2927 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2928 /* Handle menu-bar events:
2929 insert the dummy prefix event `menu-bar'. */
2930 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2932 /* Change menu-bar to (menu-bar) as the event "position". */
2933 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2936 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2941 /* Store these characters into recent_keys, the dribble file if any,
2942 and the keyboard macro being defined, if any. */
2944 if (! NILP (also_record
))
2945 record_char (also_record
);
2947 /* Wipe the echo area.
2948 But first, if we are about to use an input method,
2949 save the echo area contents for it to refer to. */
2951 && ! NILP (Vinput_method_function
)
2952 && (unsigned) XINT (c
) >= ' '
2953 && (unsigned) XINT (c
) != 127
2954 && (unsigned) XINT (c
) < 256)
2956 previous_echo_area_message
= Fcurrent_message ();
2957 Vinput_method_previous_message
= previous_echo_area_message
;
2960 /* Now wipe the echo area, except for help events which do their
2961 own stuff with the echo area. */
2963 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2964 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2966 if (!NILP (echo_area_buffer
[0]))
2967 safe_run_hooks (Qecho_area_clear_hook
);
2968 clear_message (1, 0);
2971 reread_for_input_method
:
2973 /* Pass this to the input method, if appropriate. */
2975 && ! NILP (Vinput_method_function
)
2976 /* Don't run the input method within a key sequence,
2977 after the first event of the key sequence. */
2978 && NILP (prev_event
)
2979 && (unsigned) XINT (c
) >= ' '
2980 && (unsigned) XINT (c
) != 127
2981 && (unsigned) XINT (c
) < 256)
2984 int key_count
, key_count_reset
;
2985 struct gcpro gcpro1
;
2986 int count
= SPECPDL_INDEX ();
2988 /* Save the echo status. */
2989 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2990 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2991 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2994 if (before_command_restore_flag
)
2996 this_command_key_count
= before_command_key_count_1
;
2997 if (this_command_key_count
< this_single_command_key_start
)
2998 this_single_command_key_start
= this_command_key_count
;
2999 echo_truncate (before_command_echo_length_1
);
3000 before_command_restore_flag
= 0;
3004 /* Save the this_command_keys status. */
3005 key_count
= this_command_key_count
;
3006 key_count_reset
= this_command_key_count_reset
;
3009 keys
= Fcopy_sequence (this_command_keys
);
3014 /* Clear out this_command_keys. */
3015 this_command_key_count
= 0;
3016 this_command_key_count_reset
= 0;
3018 /* Now wipe the echo area. */
3019 if (!NILP (echo_area_buffer
[0]))
3020 safe_run_hooks (Qecho_area_clear_hook
);
3021 clear_message (1, 0);
3024 /* If we are not reading a key sequence,
3025 never use the echo area. */
3028 specbind (Qinput_method_use_echo_area
, Qt
);
3031 /* Call the input method. */
3032 tem
= call1 (Vinput_method_function
, c
);
3034 tem
= unbind_to (count
, tem
);
3036 /* Restore the saved echoing state
3037 and this_command_keys state. */
3038 this_command_key_count
= key_count
;
3039 this_command_key_count_reset
= key_count_reset
;
3041 this_command_keys
= keys
;
3044 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3045 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3046 if (saved_immediate_echo
)
3051 /* The input method can return no events. */
3054 /* Bring back the previous message, if any. */
3055 if (! NILP (previous_echo_area_message
))
3056 message_with_string ("%s", previous_echo_area_message
, 0);
3059 /* It returned one event or more. */
3061 Vunread_post_input_method_events
3062 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3067 /* Display help if not echoing. */
3068 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3070 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3071 Lisp_Object help
, object
, position
, window
, tem
;
3073 tem
= Fcdr (XCDR (c
));
3076 window
= Fcar (tem
);
3078 object
= Fcar (tem
);
3080 position
= Fcar (tem
);
3082 show_help_echo (help
, window
, object
, position
, 0);
3084 /* We stopped being idle for this event; undo that. */
3085 timer_idleness_start_time
= last_idle_start
;
3089 if (! reread
|| this_command_key_count
== 0
3090 || this_command_key_count_reset
)
3093 /* Don't echo mouse motion events. */
3094 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3095 && NILP (Fzerop (Vecho_keystrokes
))
3096 && ! (EVENT_HAS_PARAMETERS (c
)
3097 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3100 if (! NILP (also_record
))
3101 echo_char (also_record
);
3102 /* Once we reread a character, echoing can happen
3103 the next time we pause to read a new one. */
3104 ok_to_echo_at_next_pause
= current_kboard
;
3107 /* Record this character as part of the current key. */
3108 add_command_key (c
);
3109 if (! NILP (also_record
))
3110 add_command_key (also_record
);
3113 last_input_char
= c
;
3116 /* Process the help character specially if enabled */
3117 if (!NILP (Vhelp_form
) && help_char_p (c
))
3120 count
= SPECPDL_INDEX ();
3122 record_unwind_protect (Fset_window_configuration
,
3123 Fcurrent_window_configuration (Qnil
));
3125 tem0
= Feval (Vhelp_form
);
3127 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3131 c
= read_char (0, 0, 0, Qnil
, 0);
3132 while (BUFFERP (c
));
3133 /* Remove the help from the frame */
3134 unbind_to (count
, Qnil
);
3137 if (EQ (c
, make_number (040)))
3141 c
= read_char (0, 0, 0, Qnil
, 0);
3142 while (BUFFERP (c
));
3151 /* Record a key that came from a mouse menu.
3152 Record it for echoing, for this-command-keys, and so on. */
3158 /* Wipe the echo area. */
3159 clear_message (1, 0);
3164 before_command_key_count
= this_command_key_count
;
3165 before_command_echo_length
= echo_length ();
3168 /* Don't echo mouse motion events. */
3169 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3170 && NILP (Fzerop (Vecho_keystrokes
)))
3174 /* Once we reread a character, echoing can happen
3175 the next time we pause to read a new one. */
3176 ok_to_echo_at_next_pause
= 0;
3179 /* Record this character as part of the current key. */
3180 add_command_key (c
);
3182 /* Re-reading in the middle of a command */
3183 last_input_char
= c
;
3187 /* Return 1 if should recognize C as "the help character". */
3195 if (EQ (c
, Vhelp_char
))
3197 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3198 if (EQ (c
, XCAR (tail
)))
3203 /* Record the input event C in various ways. */
3211 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3213 /* To avoid filling recent_keys with help-echo and mouse-movement
3214 events, we filter out repeated help-echo events, only store the
3215 first and last in a series of mouse-movement events, and don't
3216 store repeated help-echo events which are only separated by
3217 mouse-movement events. */
3219 Lisp_Object ev1
, ev2
, ev3
;
3222 if ((ix1
= recent_keys_index
- 1) < 0)
3223 ix1
= NUM_RECENT_KEYS
- 1;
3224 ev1
= AREF (recent_keys
, ix1
);
3226 if ((ix2
= ix1
- 1) < 0)
3227 ix2
= NUM_RECENT_KEYS
- 1;
3228 ev2
= AREF (recent_keys
, ix2
);
3230 if ((ix3
= ix2
- 1) < 0)
3231 ix3
= NUM_RECENT_KEYS
- 1;
3232 ev3
= AREF (recent_keys
, ix3
);
3234 if (EQ (XCAR (c
), Qhelp_echo
))
3236 /* Don't record `help-echo' in recent_keys unless it shows some help
3237 message, and a different help than the previously recorded
3239 Lisp_Object help
, last_help
;
3241 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3242 if (!STRINGP (help
))
3244 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3245 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3247 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3248 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3249 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3251 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3252 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3253 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3254 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3257 else if (EQ (XCAR (c
), Qmouse_movement
))
3259 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3260 So additional mouse movement events replace the last element. */
3261 Lisp_Object last_window
, window
;
3263 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3264 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3265 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3266 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3267 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3269 ASET (recent_keys
, ix1
, c
);
3275 store_kbd_macro_char (c
);
3280 ASET (recent_keys
, recent_keys_index
, c
);
3281 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3282 recent_keys_index
= 0;
3284 else if (recorded
< 0)
3286 /* We need to remove one or two events from recent_keys.
3287 To do this, we simply put nil at those events and move the
3288 recent_keys_index backwards over those events. Usually,
3289 users will never see those nil events, as they will be
3290 overwritten by the command keys entered to see recent_keys
3293 while (recorded
++ < 0 && total_keys
> 0)
3295 if (total_keys
< NUM_RECENT_KEYS
)
3297 if (--recent_keys_index
< 0)
3298 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3299 ASET (recent_keys
, recent_keys_index
, Qnil
);
3303 num_nonmacro_input_events
++;
3305 /* Write c to the dribble file. If c is a lispy event, write
3306 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3307 If you, dear reader, have a better idea, you've got the source. :-) */
3312 if (XUINT (c
) < 0x100)
3313 putc (XINT (c
), dribble
);
3315 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3319 Lisp_Object dribblee
;
3321 /* If it's a structured event, take the event header. */
3322 dribblee
= EVENT_HEAD (c
);
3324 if (SYMBOLP (dribblee
))
3326 putc ('<', dribble
);
3327 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3328 SBYTES (SYMBOL_NAME (dribblee
)),
3330 putc ('>', dribble
);
3342 struct buffer
*old
= current_buffer
;
3343 Fprinc (object
, Qnil
);
3344 set_buffer_internal (XBUFFER (Vstandard_output
));
3345 call0 (intern ("help-mode"));
3346 set_buffer_internal (old
);
3350 /* Copy out or in the info on where C-g should throw to.
3351 This is used when running Lisp code from within get_char,
3352 in case get_char is called recursively.
3353 See read_process_output. */
3359 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3363 restore_getcjmp (temp
)
3366 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3371 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3372 of this function. */
3375 tracking_off (old_value
)
3376 Lisp_Object old_value
;
3378 do_mouse_tracking
= old_value
;
3379 if (NILP (old_value
))
3381 /* Redisplay may have been preempted because there was input
3382 available, and it assumes it will be called again after the
3383 input has been processed. If the only input available was
3384 the sort that we have just disabled, then we need to call
3386 if (!readable_events (1))
3388 redisplay_preserve_echo_area (6);
3389 get_input_pending (&input_pending
, 1);
3395 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3396 doc
: /* Evaluate BODY with mouse movement events enabled.
3397 Within a `track-mouse' form, mouse motion generates input events that
3398 you can read with `read-event'.
3399 Normally, mouse motion is ignored.
3400 usage: (track-mouse BODY ...) */)
3404 int count
= SPECPDL_INDEX ();
3407 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3409 do_mouse_tracking
= Qt
;
3411 val
= Fprogn (args
);
3412 return unbind_to (count
, val
);
3415 /* If mouse has moved on some frame, return one of those frames.
3416 Return 0 otherwise. */
3421 Lisp_Object tail
, frame
;
3423 FOR_EACH_FRAME (tail
, frame
)
3425 if (XFRAME (frame
)->mouse_moved
)
3426 return XFRAME (frame
);
3432 #endif /* HAVE_MOUSE */
3434 /* Low level keyboard/mouse input.
3435 kbd_buffer_store_event places events in kbd_buffer, and
3436 kbd_buffer_get_event retrieves them. */
3438 /* Return true iff there are any events in the queue that read-char
3439 would return. If this returns false, a read-char would block. */
3441 readable_filtered_events (do_timers_now
, filter_events
)
3446 timer_check (do_timers_now
);
3448 /* If the buffer contains only FOCUS_IN_EVENT events,
3449 and FILTER_EVENTS is nonzero, report it as empty. */
3450 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3452 int have_live_event
= 1;
3456 struct input_event
*event
;
3458 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3462 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3465 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3467 if (event
== kbd_store_ptr
)
3468 have_live_event
= 0;
3471 if (have_live_event
) return 1;
3475 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3480 if (current_kboard
->kbd_queue_has_data
)
3486 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3487 if (kb
->kbd_queue_has_data
)
3493 /* Return true iff there are any events in the queue that read-char
3494 would return. If this returns false, a read-char would block. */
3496 readable_events (do_timers_now
)
3499 return readable_filtered_events (do_timers_now
, 0);
3502 /* Set this for debugging, to have a way to get out */
3507 event_to_kboard (event
)
3508 struct input_event
*event
;
3511 frame
= event
->frame_or_window
;
3513 frame
= XCAR (frame
);
3514 else if (WINDOWP (frame
))
3515 frame
= WINDOW_FRAME (XWINDOW (frame
));
3517 /* There are still some events that don't set this field.
3518 For now, just ignore the problem.
3519 Also ignore dead frames here. */
3520 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3523 return FRAME_KBOARD (XFRAME (frame
));
3527 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3530 kbd_buffer_store_event (event
)
3531 register struct input_event
*event
;
3533 if (event
->kind
== NO_EVENT
)
3536 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3538 register int c
= event
->code
& 0377;
3540 if (event
->modifiers
& ctrl_modifier
)
3541 c
= make_ctrl_char (c
);
3543 c
|= (event
->modifiers
3544 & (meta_modifier
| alt_modifier
3545 | hyper_modifier
| super_modifier
));
3551 struct input_event
*sp
;
3554 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3555 kb
!= current_kboard
))
3558 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3559 Fcons (make_number (c
), Qnil
));
3560 kb
->kbd_queue_has_data
= 1;
3561 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3563 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3566 if (event_to_kboard (sp
) == kb
)
3568 sp
->kind
= NO_EVENT
;
3569 sp
->frame_or_window
= Qnil
;
3577 /* If this results in a quit_char being returned to Emacs as
3578 input, set Vlast_event_frame properly. If this doesn't
3579 get returned to Emacs as an event, the next event read
3580 will set Vlast_event_frame again, so this is safe to do. */
3584 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3586 focus
= event
->frame_or_window
;
3587 internal_last_event_frame
= focus
;
3588 Vlast_event_frame
= focus
;
3591 last_event_timestamp
= event
->timestamp
;
3592 interrupt_signal (0 /* dummy */);
3596 if (c
&& c
== stop_character
)
3602 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3603 Just ignore the second one. */
3604 else if (event
->kind
== BUFFER_SWITCH_EVENT
3605 && kbd_fetch_ptr
!= kbd_store_ptr
3606 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3609 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3610 kbd_store_ptr
= kbd_buffer
;
3612 /* Don't let the very last slot in the buffer become full,
3613 since that would make the two pointers equal,
3614 and that is indistinguishable from an empty buffer.
3615 Discard the event if it would fill the last slot. */
3616 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3620 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3621 prone to assign individual members for other events, in case
3622 the input_event structure is changed. --2000-07-13, gerd. */
3623 struct input_event
*sp
= kbd_store_ptr
;
3624 sp
->kind
= event
->kind
;
3625 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3627 /* We must not use the ordinary copying code for this case,
3628 since `part' is an enum and copying it might not copy enough
3630 bcopy (event
, (char *) sp
, sizeof (*event
));
3635 sp
->code
= event
->code
;
3636 sp
->part
= event
->part
;
3637 sp
->frame_or_window
= event
->frame_or_window
;
3638 sp
->arg
= event
->arg
;
3639 sp
->modifiers
= event
->modifiers
;
3642 sp
->timestamp
= event
->timestamp
;
3645 *kbd_store_ptr
= *event
;
3648 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3649 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3650 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3656 /* Generate HELP_EVENT input_events in BUFP which has room for
3657 SIZE events. If there's not enough room in BUFP, ignore this
3660 HELP is the help form.
3662 FRAME is the frame on which the help is generated. OBJECT is the
3663 Lisp object where the help was found (a buffer, a string, an
3664 overlay, or nil if neither from a string nor from a buffer. POS is
3665 the position within OBJECT where the help was found.
3667 Value is the number of input_events generated. */
3670 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3671 struct input_event
*bufp
;
3673 Lisp_Object help
, frame
, object
, window
;
3678 bufp
->kind
= HELP_EVENT
;
3679 bufp
->frame_or_window
= frame
;
3681 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3690 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3693 kbd_buffer_store_help_event (frame
, help
)
3694 Lisp_Object frame
, help
;
3696 struct input_event event
;
3698 event
.kind
= HELP_EVENT
;
3699 event
.frame_or_window
= frame
;
3704 kbd_buffer_store_event (&event
);
3708 /* Discard any mouse events in the event buffer by setting them to
3711 discard_mouse_events ()
3713 struct input_event
*sp
;
3714 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3716 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3719 if (sp
->kind
== MOUSE_CLICK_EVENT
3721 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3723 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3725 sp
->kind
= NO_EVENT
;
3731 /* Return non-zero if there are any real events waiting in the event
3732 buffer, not counting `NO_EVENT's.
3734 If DISCARD is non-zero, discard NO_EVENT events at the front of
3735 the input queue, possibly leaving the input queue empty if there
3736 are no real input events. */
3739 kbd_buffer_events_waiting (discard
)
3742 struct input_event
*sp
;
3744 for (sp
= kbd_fetch_ptr
;
3745 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3748 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3755 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3759 /* Clear input event EVENT. */
3763 struct input_event
*event
;
3765 int idx
= 2 * (event
- kbd_buffer
);
3766 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3767 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3768 event
->kind
= NO_EVENT
;
3772 /* Read one event from the event buffer, waiting if necessary.
3773 The value is a Lisp object representing the event.
3774 The value is nil for an event that should be ignored,
3775 or that was handled here.
3776 We always read and discard one event. */
3779 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3781 int *used_mouse_menu
;
3790 *kbp
= current_kboard
;
3794 /* Wait until there is input available. */
3797 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3800 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3804 /* If the quit flag is set, then read_char will return
3805 quit_char, so that counts as "available input." */
3806 if (!NILP (Vquit_flag
))
3807 quit_throw_to_read_char ();
3809 /* One way or another, wait until input is available; then, if
3810 interrupt handlers have not read it, read it now. */
3813 wait_for_kbd_input ();
3815 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3819 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3822 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3826 Lisp_Object minus_one
;
3828 XSETINT (minus_one
, -1);
3829 wait_reading_process_input (0, 0, minus_one
, 1);
3831 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3832 /* Pass 1 for EXPECT since we just waited to have input. */
3833 read_avail_input (1);
3835 #endif /* not VMS */
3838 if (CONSP (Vunread_command_events
))
3841 first
= XCAR (Vunread_command_events
);
3842 Vunread_command_events
= XCDR (Vunread_command_events
);
3843 *kbp
= current_kboard
;
3847 /* At this point, we know that there is a readable event available
3848 somewhere. If the event queue is empty, then there must be a
3849 mouse movement enabled and available. */
3850 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3852 struct input_event
*event
;
3854 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3858 last_event_timestamp
= event
->timestamp
;
3861 *kbp
= event_to_kboard (event
);
3863 *kbp
= current_kboard
; /* Better than returning null ptr? */
3865 *kbp
= &the_only_kboard
;
3870 /* These two kinds of events get special handling
3871 and don't actually appear to the command loop.
3872 We return nil for them. */
3873 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3876 struct input_event copy
;
3878 /* Remove it from the buffer before processing it,
3879 since otherwise swallow_events will see it
3880 and process it again. */
3882 kbd_fetch_ptr
= event
+ 1;
3883 input_pending
= readable_events (0);
3884 x_handle_selection_request (©
);
3886 /* We're getting selection request events, but we don't have
3892 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3895 struct input_event copy
;
3897 /* Remove it from the buffer before processing it. */
3899 kbd_fetch_ptr
= event
+ 1;
3900 input_pending
= readable_events (0);
3901 x_handle_selection_clear (©
);
3903 /* We're getting selection request events, but we don't have
3908 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3909 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3911 /* Make an event (delete-frame (FRAME)). */
3912 obj
= Fcons (event
->frame_or_window
, Qnil
);
3913 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3914 kbd_fetch_ptr
= event
+ 1;
3917 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3918 else if (event
->kind
== ICONIFY_EVENT
)
3920 /* Make an event (iconify-frame (FRAME)). */
3921 obj
= Fcons (event
->frame_or_window
, Qnil
);
3922 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3923 kbd_fetch_ptr
= event
+ 1;
3925 else if (event
->kind
== DEICONIFY_EVENT
)
3927 /* Make an event (make-frame-visible (FRAME)). */
3928 obj
= Fcons (event
->frame_or_window
, Qnil
);
3929 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3930 kbd_fetch_ptr
= event
+ 1;
3933 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3935 /* The value doesn't matter here; only the type is tested. */
3936 XSETBUFFER (obj
, current_buffer
);
3937 kbd_fetch_ptr
= event
+ 1;
3939 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3940 || defined (USE_GTK)
3941 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3943 kbd_fetch_ptr
= event
+ 1;
3944 input_pending
= readable_events (0);
3945 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3946 x_activate_menubar (XFRAME (event
->frame_or_window
));
3950 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3952 /* Make an event (language-change (FRAME CHARSET LCID)). */
3953 obj
= Fcons (event
->modifiers
, Qnil
);
3954 obj
= Fcons (event
->code
, obj
);
3955 obj
= Fcons (event
->frame_or_window
, obj
);
3956 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3957 kbd_fetch_ptr
= event
+ 1;
3960 else if (event
->kind
== SAVE_SESSION_EVENT
)
3962 obj
= Fcons (Qsave_session
, Qnil
);
3963 kbd_fetch_ptr
= event
+ 1;
3965 /* Just discard these, by returning nil.
3966 With MULTI_KBOARD, these events are used as placeholders
3967 when we need to randomly delete events from the queue.
3968 (They shouldn't otherwise be found in the buffer,
3969 but on some machines it appears they do show up
3970 even without MULTI_KBOARD.) */
3971 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3972 mouse events during a popup-menu call. */
3973 else if (event
->kind
== NO_EVENT
)
3974 kbd_fetch_ptr
= event
+ 1;
3975 else if (event
->kind
== HELP_EVENT
)
3977 Lisp_Object object
, position
, help
, frame
, window
;
3979 frame
= event
->frame_or_window
;
3980 object
= event
->arg
;
3981 position
= make_number (event
->code
);
3984 clear_event (event
);
3986 kbd_fetch_ptr
= event
+ 1;
3987 if (!WINDOWP (window
))
3989 obj
= Fcons (Qhelp_echo
,
3990 list5 (frame
, help
, window
, object
, position
));
3992 else if (event
->kind
== FOCUS_IN_EVENT
)
3994 /* Notification of a FocusIn event. The frame receiving the
3995 focus is in event->frame_or_window. Generate a
3996 switch-frame event if necessary. */
3997 Lisp_Object frame
, focus
;
3999 frame
= event
->frame_or_window
;
4000 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4004 if (!EQ (frame
, internal_last_event_frame
)
4005 && !EQ (frame
, selected_frame
))
4006 obj
= make_lispy_switch_frame (frame
);
4007 internal_last_event_frame
= frame
;
4008 kbd_fetch_ptr
= event
+ 1;
4012 /* If this event is on a different frame, return a switch-frame this
4013 time, and leave the event in the queue for next time. */
4017 frame
= event
->frame_or_window
;
4019 frame
= XCAR (frame
);
4020 else if (WINDOWP (frame
))
4021 frame
= WINDOW_FRAME (XWINDOW (frame
));
4023 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4027 if (! EQ (frame
, internal_last_event_frame
)
4028 && !EQ (frame
, selected_frame
))
4029 obj
= make_lispy_switch_frame (frame
);
4030 internal_last_event_frame
= frame
;
4032 /* If we didn't decide to make a switch-frame event, go ahead
4033 and build a real event from the queue entry. */
4037 obj
= make_lispy_event (event
);
4039 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4040 || defined (USE_GTK)
4041 /* If this was a menu selection, then set the flag to inhibit
4042 writing to last_nonmenu_event. Don't do this if the event
4043 we're returning is (menu-bar), though; that indicates the
4044 beginning of the menu sequence, and we might as well leave
4045 that as the `event with parameters' for this selection. */
4047 && !EQ (event
->frame_or_window
, event
->arg
)
4048 && (event
->kind
== MENU_BAR_EVENT
4049 || event
->kind
== TOOL_BAR_EVENT
))
4050 *used_mouse_menu
= 1;
4053 /* Wipe out this event, to catch bugs. */
4054 clear_event (event
);
4055 kbd_fetch_ptr
= event
+ 1;
4060 /* Try generating a mouse motion event. */
4061 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4063 FRAME_PTR f
= some_mouse_moved ();
4064 Lisp_Object bar_window
;
4065 enum scroll_bar_part part
;
4069 *kbp
= current_kboard
;
4070 /* Note that this uses F to determine which display to look at.
4071 If there is no valid info, it does not store anything
4072 so x remains nil. */
4074 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4078 /* Decide if we should generate a switch-frame event. Don't
4079 generate switch-frame events for motion outside of all Emacs
4085 frame
= FRAME_FOCUS_FRAME (f
);
4087 XSETFRAME (frame
, f
);
4089 if (! EQ (frame
, internal_last_event_frame
)
4090 && !EQ (frame
, selected_frame
))
4091 obj
= make_lispy_switch_frame (frame
);
4092 internal_last_event_frame
= frame
;
4095 /* If we didn't decide to make a switch-frame event, go ahead and
4096 return a mouse-motion event. */
4097 if (!NILP (x
) && NILP (obj
))
4098 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4100 #endif /* HAVE_MOUSE */
4102 /* We were promised by the above while loop that there was
4103 something for us to read! */
4106 input_pending
= readable_events (0);
4108 Vlast_event_frame
= internal_last_event_frame
;
4113 /* Process any events that are not user-visible,
4114 then return, without reading any user-visible events. */
4117 swallow_events (do_display
)
4122 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4124 struct input_event
*event
;
4126 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4130 last_event_timestamp
= event
->timestamp
;
4132 /* These two kinds of events get special handling
4133 and don't actually appear to the command loop. */
4134 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4137 struct input_event copy
;
4139 /* Remove it from the buffer before processing it,
4140 since otherwise swallow_events called recursively could see it
4141 and process it again. */
4143 kbd_fetch_ptr
= event
+ 1;
4144 input_pending
= readable_events (0);
4145 x_handle_selection_request (©
);
4147 /* We're getting selection request events, but we don't have
4153 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4156 struct input_event copy
;
4158 /* Remove it from the buffer before processing it, */
4161 kbd_fetch_ptr
= event
+ 1;
4162 input_pending
= readable_events (0);
4163 x_handle_selection_clear (©
);
4165 /* We're getting selection request events, but we don't have
4174 old_timers_run
= timers_run
;
4175 get_input_pending (&input_pending
, 1);
4177 if (timers_run
!= old_timers_run
&& do_display
)
4178 redisplay_preserve_echo_area (7);
4181 /* Record the start of when Emacs is idle,
4182 for the sake of running idle-time timers. */
4189 /* If we are already in the idle state, do nothing. */
4190 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4193 EMACS_GET_TIME (timer_idleness_start_time
);
4195 timer_last_idleness_start_time
= timer_idleness_start_time
;
4197 /* Mark all idle-time timers as once again candidates for running. */
4198 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4202 timer
= XCAR (timers
);
4204 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4206 XVECTOR (timer
)->contents
[0] = Qnil
;
4210 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4215 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4218 /* This is only for debugging. */
4219 struct input_event last_timer_event
;
4221 /* Check whether a timer has fired. To prevent larger problems we simply
4222 disregard elements that are not proper timers. Do not make a circular
4223 timer list for the time being.
4225 Returns the number of seconds to wait until the next timer fires. If a
4226 timer is triggering now, return zero seconds.
4227 If no timer is active, return -1 seconds.
4229 If a timer is ripe, we run it, with quitting turned off.
4231 DO_IT_NOW is now ignored. It used to mean that we should
4232 run the timer directly instead of queueing a timer-event.
4233 Now we always run timers directly. */
4236 timer_check (do_it_now
)
4239 EMACS_TIME nexttime
;
4240 EMACS_TIME now
, idleness_now
;
4241 Lisp_Object timers
, idle_timers
, chosen_timer
;
4242 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4244 EMACS_SET_SECS (nexttime
, -1);
4245 EMACS_SET_USECS (nexttime
, -1);
4247 /* Always consider the ordinary timers. */
4248 timers
= Vtimer_list
;
4249 /* Consider the idle timers only if Emacs is idle. */
4250 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4251 idle_timers
= Vtimer_idle_list
;
4254 chosen_timer
= Qnil
;
4255 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4257 if (CONSP (timers
) || CONSP (idle_timers
))
4259 EMACS_GET_TIME (now
);
4260 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4261 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4264 while (CONSP (timers
) || CONSP (idle_timers
))
4266 Lisp_Object
*vector
;
4267 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4268 EMACS_TIME timer_time
, idle_timer_time
;
4269 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4271 /* Skip past invalid timers and timers already handled. */
4274 timer
= XCAR (timers
);
4275 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4277 timers
= XCDR (timers
);
4280 vector
= XVECTOR (timer
)->contents
;
4282 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4283 || !INTEGERP (vector
[3])
4284 || ! NILP (vector
[0]))
4286 timers
= XCDR (timers
);
4290 if (!NILP (idle_timers
))
4292 timer
= XCAR (idle_timers
);
4293 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4295 idle_timers
= XCDR (idle_timers
);
4298 vector
= XVECTOR (timer
)->contents
;
4300 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4301 || !INTEGERP (vector
[3])
4302 || ! NILP (vector
[0]))
4304 idle_timers
= XCDR (idle_timers
);
4309 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4310 based on the next ordinary timer.
4311 TIMER_DIFFERENCE is the distance in time from NOW to when
4312 this timer becomes ripe (negative if it's already ripe). */
4315 timer
= XCAR (timers
);
4316 vector
= XVECTOR (timer
)->contents
;
4317 EMACS_SET_SECS (timer_time
,
4318 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4319 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4320 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4323 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4324 based on the next idle timer. */
4325 if (!NILP (idle_timers
))
4327 idle_timer
= XCAR (idle_timers
);
4328 vector
= XVECTOR (idle_timer
)->contents
;
4329 EMACS_SET_SECS (idle_timer_time
,
4330 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4331 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4332 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4335 /* Decide which timer is the next timer,
4336 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4337 Also step down the list where we found that timer. */
4339 if (! NILP (timers
) && ! NILP (idle_timers
))
4342 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4343 if (EMACS_TIME_NEG_P (temp
))
4345 chosen_timer
= timer
;
4346 timers
= XCDR (timers
);
4347 difference
= timer_difference
;
4351 chosen_timer
= idle_timer
;
4352 idle_timers
= XCDR (idle_timers
);
4353 difference
= idle_timer_difference
;
4356 else if (! NILP (timers
))
4358 chosen_timer
= timer
;
4359 timers
= XCDR (timers
);
4360 difference
= timer_difference
;
4364 chosen_timer
= idle_timer
;
4365 idle_timers
= XCDR (idle_timers
);
4366 difference
= idle_timer_difference
;
4368 vector
= XVECTOR (chosen_timer
)->contents
;
4370 /* If timer is ripe, run it if it hasn't been run. */
4371 if (EMACS_TIME_NEG_P (difference
)
4372 || (EMACS_SECS (difference
) == 0
4373 && EMACS_USECS (difference
) == 0))
4375 if (NILP (vector
[0]))
4377 int was_locked
= single_kboard
;
4378 int count
= SPECPDL_INDEX ();
4379 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4381 /* Mark the timer as triggered to prevent problems if the lisp
4382 code fails to reschedule it right. */
4385 specbind (Qinhibit_quit
, Qt
);
4387 call1 (Qtimer_event_handler
, chosen_timer
);
4388 Vdeactivate_mark
= old_deactivate_mark
;
4390 unbind_to (count
, Qnil
);
4392 /* Resume allowing input from any kboard, if that was true before. */
4394 any_kboard_state ();
4396 /* Since we have handled the event,
4397 we don't need to tell the caller to wake up and do it. */
4401 /* When we encounter a timer that is still waiting,
4402 return the amount of time to wait before it is ripe. */
4409 /* No timers are pending in the future. */
4410 /* Return 0 if we generated an event, and -1 if not. */
4415 /* Caches for modify_event_symbol. */
4416 static Lisp_Object accent_key_syms
;
4417 static Lisp_Object func_key_syms
;
4418 static Lisp_Object mouse_syms
;
4419 #if defined(WINDOWSNT) || defined(MAC_OSX)
4420 static Lisp_Object mouse_wheel_syms
;
4422 static Lisp_Object drag_n_drop_syms
;
4424 /* This is a list of keysym codes for special "accent" characters.
4425 It parallels lispy_accent_keys. */
4427 static int lispy_accent_codes
[] =
4429 #ifdef XK_dead_circumflex
4434 #ifdef XK_dead_grave
4439 #ifdef XK_dead_tilde
4444 #ifdef XK_dead_diaeresis
4449 #ifdef XK_dead_macron
4454 #ifdef XK_dead_degree
4459 #ifdef XK_dead_acute
4464 #ifdef XK_dead_cedilla
4469 #ifdef XK_dead_breve
4474 #ifdef XK_dead_ogonek
4479 #ifdef XK_dead_caron
4484 #ifdef XK_dead_doubleacute
4485 XK_dead_doubleacute
,
4489 #ifdef XK_dead_abovedot
4494 #ifdef XK_dead_abovering
4504 #ifdef XK_dead_belowdot
4509 #ifdef XK_dead_voiced_sound
4510 XK_dead_voiced_sound
,
4514 #ifdef XK_dead_semivoiced_sound
4515 XK_dead_semivoiced_sound
,
4531 /* This is a list of Lisp names for special "accent" characters.
4532 It parallels lispy_accent_codes. */
4534 static char *lispy_accent_keys
[] =
4552 "dead-voiced-sound",
4553 "dead-semivoiced-sound",
4559 #define FUNCTION_KEY_OFFSET 0x0
4561 char *lispy_function_keys
[] =
4565 0, /* VK_LBUTTON 0x01 */
4566 0, /* VK_RBUTTON 0x02 */
4567 "cancel", /* VK_CANCEL 0x03 */
4568 0, /* VK_MBUTTON 0x04 */
4570 0, 0, 0, /* 0x05 .. 0x07 */
4572 "backspace", /* VK_BACK 0x08 */
4573 "tab", /* VK_TAB 0x09 */
4575 0, 0, /* 0x0A .. 0x0B */
4577 "clear", /* VK_CLEAR 0x0C */
4578 "return", /* VK_RETURN 0x0D */
4580 0, 0, /* 0x0E .. 0x0F */
4582 0, /* VK_SHIFT 0x10 */
4583 0, /* VK_CONTROL 0x11 */
4584 0, /* VK_MENU 0x12 */
4585 "pause", /* VK_PAUSE 0x13 */
4586 "capslock", /* VK_CAPITAL 0x14 */
4588 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4590 "escape", /* VK_ESCAPE 0x1B */
4592 0, 0, 0, 0, /* 0x1C .. 0x1F */
4594 0, /* VK_SPACE 0x20 */
4595 "prior", /* VK_PRIOR 0x21 */
4596 "next", /* VK_NEXT 0x22 */
4597 "end", /* VK_END 0x23 */
4598 "home", /* VK_HOME 0x24 */
4599 "left", /* VK_LEFT 0x25 */
4600 "up", /* VK_UP 0x26 */
4601 "right", /* VK_RIGHT 0x27 */
4602 "down", /* VK_DOWN 0x28 */
4603 "select", /* VK_SELECT 0x29 */
4604 "print", /* VK_PRINT 0x2A */
4605 "execute", /* VK_EXECUTE 0x2B */
4606 "snapshot", /* VK_SNAPSHOT 0x2C */
4607 "insert", /* VK_INSERT 0x2D */
4608 "delete", /* VK_DELETE 0x2E */
4609 "help", /* VK_HELP 0x2F */
4611 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4613 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4615 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4617 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4619 0, 0, 0, 0, 0, 0, 0, 0, 0,
4620 0, 0, 0, 0, 0, 0, 0, 0, 0,
4621 0, 0, 0, 0, 0, 0, 0, 0,
4623 "lwindow", /* VK_LWIN 0x5B */
4624 "rwindow", /* VK_RWIN 0x5C */
4625 "apps", /* VK_APPS 0x5D */
4627 0, 0, /* 0x5E .. 0x5F */
4629 "kp-0", /* VK_NUMPAD0 0x60 */
4630 "kp-1", /* VK_NUMPAD1 0x61 */
4631 "kp-2", /* VK_NUMPAD2 0x62 */
4632 "kp-3", /* VK_NUMPAD3 0x63 */
4633 "kp-4", /* VK_NUMPAD4 0x64 */
4634 "kp-5", /* VK_NUMPAD5 0x65 */
4635 "kp-6", /* VK_NUMPAD6 0x66 */
4636 "kp-7", /* VK_NUMPAD7 0x67 */
4637 "kp-8", /* VK_NUMPAD8 0x68 */
4638 "kp-9", /* VK_NUMPAD9 0x69 */
4639 "kp-multiply", /* VK_MULTIPLY 0x6A */
4640 "kp-add", /* VK_ADD 0x6B */
4641 "kp-separator", /* VK_SEPARATOR 0x6C */
4642 "kp-subtract", /* VK_SUBTRACT 0x6D */
4643 "kp-decimal", /* VK_DECIMAL 0x6E */
4644 "kp-divide", /* VK_DIVIDE 0x6F */
4645 "f1", /* VK_F1 0x70 */
4646 "f2", /* VK_F2 0x71 */
4647 "f3", /* VK_F3 0x72 */
4648 "f4", /* VK_F4 0x73 */
4649 "f5", /* VK_F5 0x74 */
4650 "f6", /* VK_F6 0x75 */
4651 "f7", /* VK_F7 0x76 */
4652 "f8", /* VK_F8 0x77 */
4653 "f9", /* VK_F9 0x78 */
4654 "f10", /* VK_F10 0x79 */
4655 "f11", /* VK_F11 0x7A */
4656 "f12", /* VK_F12 0x7B */
4657 "f13", /* VK_F13 0x7C */
4658 "f14", /* VK_F14 0x7D */
4659 "f15", /* VK_F15 0x7E */
4660 "f16", /* VK_F16 0x7F */
4661 "f17", /* VK_F17 0x80 */
4662 "f18", /* VK_F18 0x81 */
4663 "f19", /* VK_F19 0x82 */
4664 "f20", /* VK_F20 0x83 */
4665 "f21", /* VK_F21 0x84 */
4666 "f22", /* VK_F22 0x85 */
4667 "f23", /* VK_F23 0x86 */
4668 "f24", /* VK_F24 0x87 */
4670 0, 0, 0, 0, /* 0x88 .. 0x8B */
4671 0, 0, 0, 0, /* 0x8C .. 0x8F */
4673 "kp-numlock", /* VK_NUMLOCK 0x90 */
4674 "scroll", /* VK_SCROLL 0x91 */
4676 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4677 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4678 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4679 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4680 "kp-end", /* VK_NUMPAD_END 0x96 */
4681 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4682 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4683 "kp-up", /* VK_NUMPAD_UP 0x99 */
4684 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4685 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4686 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4687 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4689 0, 0, /* 0x9E .. 0x9F */
4692 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4693 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4694 * No other API or message will distinguish left and right keys this way.
4698 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4699 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4700 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4701 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4702 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4708 "attn", /* VK_ATTN 0xF6 */
4709 "crsel", /* VK_CRSEL 0xF7 */
4710 "exsel", /* VK_EXSEL 0xF8 */
4711 "ereof", /* VK_EREOF 0xF9 */
4712 "play", /* VK_PLAY 0xFA */
4713 "zoom", /* VK_ZOOM 0xFB */
4714 "noname", /* VK_NONAME 0xFC */
4715 "pa1", /* VK_PA1 0xFD */
4716 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4720 #else /* not HAVE_NTGUI */
4722 /* This should be dealt with in XTread_socket now, and that doesn't
4723 depend on the client system having the Kana syms defined. See also
4724 the XK_kana_A case below. */
4727 static char *lispy_kana_keys
[] =
4729 /* X Keysym value */
4730 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4731 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4732 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4733 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4734 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4735 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4736 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4737 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4738 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4739 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4740 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4741 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4742 "kana-i", "kana-u", "kana-e", "kana-o",
4743 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4744 "prolongedsound", "kana-A", "kana-I", "kana-U",
4745 "kana-E", "kana-O", "kana-KA", "kana-KI",
4746 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4747 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4748 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4749 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4750 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4751 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4752 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4753 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4754 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4755 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4756 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4757 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4759 #endif /* XK_kana_A */
4762 #define FUNCTION_KEY_OFFSET 0xff00
4764 /* You'll notice that this table is arranged to be conveniently
4765 indexed by X Windows keysym values. */
4766 static char *lispy_function_keys
[] =
4768 /* X Keysym value */
4770 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4771 "backspace", "tab", "linefeed", "clear",
4773 0, 0, 0, "pause", /* 0xff10...1f */
4774 0, 0, 0, 0, 0, 0, 0, "escape",
4776 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4777 "romaji", "hiragana", "katakana", "hiragana-katakana",
4778 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4779 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4780 "eisu-toggle", /* 0xff30...3f */
4781 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4782 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4784 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4785 "down", "prior", "next", "end",
4786 "begin", 0, 0, 0, 0, 0, 0, 0,
4787 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4798 "break", /* 0xff6b */
4801 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4802 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4803 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4804 0, 0, 0, 0, 0, 0, 0, 0,
4805 "kp-tab", /* 0xff89 */
4807 "kp-enter", /* 0xff8d */
4809 "kp-f1", /* 0xff91 */
4813 "kp-home", /* 0xff95 */
4818 "kp-prior", /* kp-page-up */
4819 "kp-next", /* kp-page-down */
4825 0, 0, 0, 0, 0, 0, 0, 0, 0,
4826 "kp-multiply", /* 0xffaa */
4831 "kp-divide", /* 0xffaf */
4832 "kp-0", /* 0xffb0 */
4833 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4836 "kp-equal", /* 0xffbd */
4837 "f1", /* 0xffbe */ /* IsFunctionKey */
4839 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4840 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4841 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4842 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4843 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4844 0, 0, 0, 0, 0, 0, 0, 0,
4845 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4846 0, 0, 0, 0, 0, 0, 0, "delete"
4849 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4850 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4852 static char *iso_lispy_function_keys
[] =
4854 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4855 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4856 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4857 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4858 "iso-lefttab", /* 0xfe20 */
4859 "iso-move-line-up", "iso-move-line-down",
4860 "iso-partial-line-up", "iso-partial-line-down",
4861 "iso-partial-space-left", "iso-partial-space-right",
4862 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4863 "iso-release-margin-left", "iso-release-margin-right",
4864 "iso-release-both-margins",
4865 "iso-fast-cursor-left", "iso-fast-cursor-right",
4866 "iso-fast-cursor-up", "iso-fast-cursor-down",
4867 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4868 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4871 #endif /* not HAVE_NTGUI */
4873 Lisp_Object Vlispy_mouse_stem
;
4875 #if defined(WINDOWSNT) || defined(MAC_OSX)
4876 /* mouse-wheel events are generated by the wheel on devices such as
4877 the MS Intellimouse. The wheel sits in between the left and right
4878 mouse buttons, and is typically used to scroll or zoom the window
4879 underneath the pointer. mouse-wheel events specify the object on
4880 which they operate, and a delta corresponding to the amount and
4881 direction that the wheel is rotated. Clicking the mouse-wheel
4882 generates a mouse-2 event. */
4883 static char *lispy_mouse_wheel_names
[] =
4888 #endif /* WINDOWSNT */
4890 /* drag-n-drop events are generated when a set of selected files are
4891 dragged from another application and dropped onto an Emacs window. */
4892 static char *lispy_drag_n_drop_names
[] =
4897 /* Scroll bar parts. */
4898 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4899 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4900 Lisp_Object Qtop
, Qratio
;
4902 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4903 Lisp_Object
*scroll_bar_parts
[] = {
4904 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4905 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4908 /* User signal events. */
4909 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4911 Lisp_Object
*lispy_user_signals
[] =
4913 &Qusr1_signal
, &Qusr2_signal
4917 /* A vector, indexed by button number, giving the down-going location
4918 of currently depressed buttons, both scroll bar and non-scroll bar.
4920 The elements have the form
4921 (BUTTON-NUMBER MODIFIER-MASK . REST)
4922 where REST is the cdr of a position as it would be reported in the event.
4924 The make_lispy_event function stores positions here to tell the
4925 difference between click and drag events, and to store the starting
4926 location to be included in drag events. */
4928 static Lisp_Object button_down_location
;
4930 /* Information about the most recent up-going button event: Which
4931 button, what location, and what time. */
4933 static int last_mouse_button
;
4934 static int last_mouse_x
;
4935 static int last_mouse_y
;
4936 static unsigned long button_down_time
;
4938 /* The maximum time between clicks to make a double-click, or Qnil to
4939 disable double-click detection, or Qt for no time limit. */
4941 Lisp_Object Vdouble_click_time
;
4943 /* Maximum number of pixels the mouse may be moved between clicks
4944 to make a double-click. */
4946 EMACS_INT double_click_fuzz
;
4948 /* The number of clicks in this multiple-click. */
4950 int double_click_count
;
4952 /* Given a struct input_event, build the lisp event which represents
4953 it. If EVENT is 0, build a mouse movement event from the mouse
4954 movement buffer, which should have a movement event in it.
4956 Note that events must be passed to this function in the order they
4957 are received; this function stores the location of button presses
4958 in order to build drag events when the button is released. */
4961 make_lispy_event (event
)
4962 struct input_event
*event
;
4966 switch (SWITCH_ENUM_CAST (event
->kind
))
4968 /* A simple keystroke. */
4969 case ASCII_KEYSTROKE_EVENT
:
4971 Lisp_Object lispy_c
;
4972 int c
= event
->code
& 0377;
4973 /* Turn ASCII characters into control characters
4975 if (event
->modifiers
& ctrl_modifier
)
4976 c
= make_ctrl_char (c
);
4978 /* Add in the other modifier bits. We took care of ctrl_modifier
4979 just above, and the shift key was taken care of by the X code,
4980 and applied to control characters by make_ctrl_char. */
4981 c
|= (event
->modifiers
4982 & (meta_modifier
| alt_modifier
4983 | hyper_modifier
| super_modifier
));
4984 /* Distinguish Shift-SPC from SPC. */
4985 if ((event
->code
& 0377) == 040
4986 && event
->modifiers
& shift_modifier
)
4987 c
|= shift_modifier
;
4988 button_down_time
= 0;
4989 XSETFASTINT (lispy_c
, c
);
4993 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4995 Lisp_Object lispy_c
;
4997 XSETFASTINT (lispy_c
, event
->code
);
5001 /* A function key. The symbol may need to have modifier prefixes
5003 case NON_ASCII_KEYSTROKE_EVENT
:
5004 button_down_time
= 0;
5006 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5007 if (event
->code
== lispy_accent_codes
[i
])
5008 return modify_event_symbol (i
,
5010 Qfunction_key
, Qnil
,
5011 lispy_accent_keys
, &accent_key_syms
,
5012 (sizeof (lispy_accent_keys
)
5013 / sizeof (lispy_accent_keys
[0])));
5017 if (event
->code
>= 0x400 && event
->code
< 0x500)
5018 return modify_event_symbol (event
->code
- 0x400,
5019 event
->modifiers
& ~shift_modifier
,
5020 Qfunction_key
, Qnil
,
5021 lispy_kana_keys
, &func_key_syms
,
5022 (sizeof (lispy_kana_keys
)
5023 / sizeof (lispy_kana_keys
[0])));
5024 #endif /* XK_kana_A */
5027 #ifdef ISO_FUNCTION_KEY_OFFSET
5028 if (event
->code
< FUNCTION_KEY_OFFSET
5029 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5030 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5032 Qfunction_key
, Qnil
,
5033 iso_lispy_function_keys
, &func_key_syms
,
5034 (sizeof (iso_lispy_function_keys
)
5035 / sizeof (iso_lispy_function_keys
[0])));
5038 /* Handle system-specific or unknown keysyms. */
5039 if (event
->code
& (1 << 28)
5040 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5041 || (event
->code
- FUNCTION_KEY_OFFSET
5042 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5043 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5045 /* We need to use an alist rather than a vector as the cache
5046 since we can't make a vector long enuf. */
5047 if (NILP (current_kboard
->system_key_syms
))
5048 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5049 return modify_event_symbol (event
->code
,
5052 current_kboard
->Vsystem_key_alist
,
5053 0, ¤t_kboard
->system_key_syms
,
5057 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5059 Qfunction_key
, Qnil
,
5060 lispy_function_keys
, &func_key_syms
,
5061 (sizeof (lispy_function_keys
)
5062 / sizeof (lispy_function_keys
[0])));
5065 /* A mouse click. Figure out where it is, decide whether it's
5066 a press, click or drag, and build the appropriate structure. */
5067 case MOUSE_CLICK_EVENT
:
5068 #ifndef USE_TOOLKIT_SCROLL_BARS
5069 case SCROLL_BAR_CLICK_EVENT
:
5072 int button
= event
->code
;
5074 Lisp_Object position
;
5075 Lisp_Object
*start_pos_ptr
;
5076 Lisp_Object start_pos
;
5081 /* Build the position as appropriate for this mouse click. */
5082 if (event
->kind
== MOUSE_CLICK_EVENT
)
5084 enum window_part part
;
5085 struct frame
*f
= XFRAME (event
->frame_or_window
);
5087 Lisp_Object string_info
= Qnil
;
5090 /* Ignore mouse events that were made on frame that
5091 have been deleted. */
5092 if (! FRAME_LIVE_P (f
))
5095 /* EVENT->x and EVENT->y are frame-relative pixel
5096 coordinates at this place. Under old redisplay, COLUMN
5097 and ROW are set to frame relative glyph coordinates
5098 which are then used to determine whether this click is
5099 in a menu (non-toolkit version). */
5100 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5101 &column
, &row
, NULL
, 1);
5103 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5104 /* In the non-toolkit version, clicks on the menu bar
5105 are ordinary button events in the event buffer.
5106 Distinguish them, and invoke the menu.
5108 (In the toolkit version, the toolkit handles the menu bar
5109 and Emacs doesn't know about it until after the user
5110 makes a selection.) */
5111 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5112 && (event
->modifiers
& down_modifier
))
5114 Lisp_Object items
, item
;
5119 /* Activate the menu bar on the down event. If the
5120 up event comes in before the menu code can deal with it,
5122 if (! (event
->modifiers
& down_modifier
))
5126 /* Find the menu bar item under `column'. */
5128 items
= FRAME_MENU_BAR_ITEMS (f
);
5129 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5131 Lisp_Object pos
, string
;
5132 string
= AREF (items
, i
+ 1);
5133 pos
= AREF (items
, i
+ 3);
5136 if (column
>= XINT (pos
)
5137 && column
< XINT (pos
) + SCHARS (string
))
5139 item
= AREF (items
, i
);
5144 /* ELisp manual 2.4b says (x y) are window relative but
5145 code says they are frame-relative. */
5147 = Fcons (event
->frame_or_window
,
5149 Fcons (Fcons (event
->x
, event
->y
),
5150 Fcons (make_number (event
->timestamp
),
5153 return Fcons (item
, Fcons (position
, Qnil
));
5155 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5157 /* Set `window' to the window under frame pixel coordinates
5158 event->x/event->y. */
5159 window
= window_from_coordinates (f
, XINT (event
->x
),
5160 XINT (event
->y
), &part
, 0);
5162 if (!WINDOWP (window
))
5164 window
= event
->frame_or_window
;
5169 /* It's a click in window window at frame coordinates
5170 event->x/ event->y. */
5171 struct window
*w
= XWINDOW (window
);
5173 /* Get window relative coordinates. Original code
5174 `rounded' this to glyph boundaries. */
5175 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5176 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5178 /* Set event coordinates to window-relative coordinates
5179 for constructing the Lisp event below. */
5180 XSETINT (event
->x
, wx
);
5181 XSETINT (event
->y
, wy
);
5183 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5185 /* Mode line or header line. Look for a string under
5186 the mouse that may have a `local-map' property. */
5190 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5191 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5192 if (STRINGP (string
))
5193 string_info
= Fcons (string
, make_number (charpos
));
5195 else if (part
== ON_VERTICAL_BORDER
)
5196 posn
= Qvertical_line
;
5197 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5200 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5202 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5203 if (STRINGP (object
))
5204 string_info
= Fcons (object
, make_number (charpos
));
5209 struct display_pos p
;
5210 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5211 posn
= make_number (CHARPOS (p
.pos
));
5212 if (STRINGP (object
))
5215 make_number (CHARPOS (p
.string_pos
)));
5222 Fcons (Fcons (event
->x
, event
->y
),
5223 Fcons (make_number (event
->timestamp
),
5226 : Fcons (string_info
, Qnil
))))));
5228 #ifndef USE_TOOLKIT_SCROLL_BARS
5231 /* It's a scrollbar click. */
5232 Lisp_Object portion_whole
;
5235 window
= event
->frame_or_window
;
5236 portion_whole
= Fcons (event
->x
, event
->y
);
5237 part
= *scroll_bar_parts
[(int) event
->part
];
5241 Fcons (Qvertical_scroll_bar
,
5242 Fcons (portion_whole
,
5243 Fcons (make_number (event
->timestamp
),
5244 Fcons (part
, Qnil
)))));
5246 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5248 if (button
>= ASIZE (button_down_location
))
5250 button_down_location
= larger_vector (button_down_location
,
5252 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5255 start_pos_ptr
= &AREF (button_down_location
, button
);
5256 start_pos
= *start_pos_ptr
;
5257 *start_pos_ptr
= Qnil
;
5260 /* On window-system frames, use the value of
5261 double-click-fuzz as is. On other frames, interpret it
5262 as a multiple of 1/8 characters. */
5266 if (WINDOWP (event
->frame_or_window
))
5267 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5268 else if (FRAMEP (event
->frame_or_window
))
5269 f
= XFRAME (event
->frame_or_window
);
5273 if (FRAME_WINDOW_P (f
))
5274 fuzz
= double_click_fuzz
;
5276 fuzz
= double_click_fuzz
/ 8;
5278 is_double
= (button
== last_mouse_button
5279 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5280 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5281 && button_down_time
!= 0
5282 && (EQ (Vdouble_click_time
, Qt
)
5283 || (INTEGERP (Vdouble_click_time
)
5284 && ((int)(event
->timestamp
- button_down_time
)
5285 < XINT (Vdouble_click_time
)))));
5288 last_mouse_button
= button
;
5289 last_mouse_x
= XINT (event
->x
);
5290 last_mouse_y
= XINT (event
->y
);
5292 /* If this is a button press, squirrel away the location, so
5293 we can decide later whether it was a click or a drag. */
5294 if (event
->modifiers
& down_modifier
)
5298 double_click_count
++;
5299 event
->modifiers
|= ((double_click_count
> 2)
5304 double_click_count
= 1;
5305 button_down_time
= event
->timestamp
;
5306 *start_pos_ptr
= Fcopy_alist (position
);
5309 /* Now we're releasing a button - check the co-ordinates to
5310 see if this was a click or a drag. */
5311 else if (event
->modifiers
& up_modifier
)
5313 /* If we did not see a down before this up, ignore the up.
5314 Probably this happened because the down event chose a
5315 menu item. It would be an annoyance to treat the
5316 release of the button that chose the menu item as a
5319 if (!CONSP (start_pos
))
5322 event
->modifiers
&= ~up_modifier
;
5323 #if 0 /* Formerly we treated an up with no down as a click event. */
5324 if (!CONSP (start_pos
))
5325 event
->modifiers
|= click_modifier
;
5330 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5332 /* The third element of every position
5333 should be the (x,y) pair. */
5334 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5336 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5338 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5339 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5342 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5343 && ydiff
< double_click_fuzz
5344 && ydiff
> - double_click_fuzz
)
5345 /* Mouse hasn't moved (much). */
5346 event
->modifiers
|= click_modifier
;
5349 button_down_time
= 0;
5350 event
->modifiers
|= drag_modifier
;
5353 /* Don't check is_double; treat this as multiple
5354 if the down-event was multiple. */
5355 if (double_click_count
> 1)
5356 event
->modifiers
|= ((double_click_count
> 2)
5362 /* Every mouse event should either have the down_modifier or
5363 the up_modifier set. */
5367 /* Get the symbol we should use for the mouse click. */
5370 head
= modify_event_symbol (button
,
5372 Qmouse_click
, Vlispy_mouse_stem
,
5375 XVECTOR (mouse_syms
)->size
);
5376 if (event
->modifiers
& drag_modifier
)
5381 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5384 Fcons (make_number (double_click_count
),
5393 #ifdef USE_TOOLKIT_SCROLL_BARS
5395 /* We don't have down and up events if using toolkit scroll bars,
5396 so make this always a click event. Store in the `part' of
5397 the Lisp event a symbol which maps to the following actions:
5399 `above_handle' page up
5400 `below_handle' page down
5404 `bottom' bottom of buffer
5405 `handle' thumb has been dragged.
5406 `end-scroll' end of interaction with scroll bar
5408 The incoming input_event contains in its `part' member an
5409 index of type `enum scroll_bar_part' which we can use as an
5410 index in scroll_bar_parts to get the appropriate symbol. */
5412 case SCROLL_BAR_CLICK_EVENT
:
5414 Lisp_Object position
, head
, window
, portion_whole
, part
;
5416 window
= event
->frame_or_window
;
5417 portion_whole
= Fcons (event
->x
, event
->y
);
5418 part
= *scroll_bar_parts
[(int) event
->part
];
5422 Fcons (Qvertical_scroll_bar
,
5423 Fcons (portion_whole
,
5424 Fcons (make_number (event
->timestamp
),
5425 Fcons (part
, Qnil
)))));
5427 /* Always treat scroll bar events as clicks. */
5428 event
->modifiers
|= click_modifier
;
5429 event
->modifiers
&= ~up_modifier
;
5431 if (event
->code
>= ASIZE (mouse_syms
))
5432 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5434 /* Get the symbol we should use for the mouse click. */
5435 head
= modify_event_symbol (event
->code
,
5440 XVECTOR (mouse_syms
)->size
);
5441 return Fcons (head
, Fcons (position
, Qnil
));
5444 #endif /* USE_TOOLKIT_SCROLL_BARS */
5447 case W32_SCROLL_BAR_CLICK_EVENT
:
5449 int button
= event
->code
;
5451 Lisp_Object position
;
5452 Lisp_Object
*start_pos_ptr
;
5453 Lisp_Object start_pos
;
5457 Lisp_Object portion_whole
;
5460 window
= event
->frame_or_window
;
5461 portion_whole
= Fcons (event
->x
, event
->y
);
5462 part
= *scroll_bar_parts
[(int) event
->part
];
5466 Fcons (Qvertical_scroll_bar
,
5467 Fcons (portion_whole
,
5468 Fcons (make_number (event
->timestamp
),
5469 Fcons (part
, Qnil
)))));
5472 /* Always treat W32 scroll bar events as clicks. */
5473 event
->modifiers
|= click_modifier
;
5476 /* Get the symbol we should use for the mouse click. */
5479 head
= modify_event_symbol (button
,
5484 XVECTOR (mouse_syms
)->size
);
5490 #endif /* WINDOWSNT */
5491 #if defined(WINDOWSNT) || defined(MAC_OSX)
5492 case MOUSE_WHEEL_EVENT
:
5494 enum window_part part
;
5495 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5498 Lisp_Object head
, position
;
5501 /* Ignore mouse events that were made on frame that
5502 have been deleted. */
5503 if (! FRAME_LIVE_P (f
))
5505 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5506 &column
, &row
, NULL
, 1);
5507 window
= window_from_coordinates (f
, XINT (event
->x
),
5508 XINT (event
->y
), &part
, 0);
5510 if (!WINDOWP (window
))
5512 window
= event
->frame_or_window
;
5517 int pixcolumn
, pixrow
;
5518 column
-= XINT (XWINDOW (window
)->left
);
5519 row
-= XINT (XWINDOW (window
)->top
);
5520 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5521 &pixcolumn
, &pixrow
);
5522 XSETINT (event
->x
, pixcolumn
);
5523 XSETINT (event
->y
, pixrow
);
5525 if (part
== ON_MODE_LINE
)
5527 else if (part
== ON_VERTICAL_BORDER
)
5528 posn
= Qvertical_line
;
5529 else if (part
== ON_HEADER_LINE
)
5530 posn
= Qheader_line
;
5534 struct display_pos p
;
5535 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5537 posn
= make_number (CHARPOS (p
.pos
));
5542 Lisp_Object head
, position
;
5547 Fcons (Fcons (event
->x
, event
->y
),
5548 Fcons (make_number (event
->timestamp
),
5551 head
= modify_event_symbol (0, event
->modifiers
,
5553 lispy_mouse_wheel_names
,
5554 &mouse_wheel_syms
, 1);
5557 /* Insert 1 here so event-click-count works. */
5558 Fcons (make_number (1),
5559 Fcons (make_number (event
->code
),
5563 #endif /* WINDOWSNT || MAC_OSX */
5565 case DRAG_N_DROP_EVENT
:
5567 enum window_part part
;
5573 /* The frame_or_window field should be a cons of the frame in
5574 which the event occurred and a list of the filenames
5576 if (! CONSP (event
->frame_or_window
))
5579 f
= XFRAME (XCAR (event
->frame_or_window
));
5580 files
= XCDR (event
->frame_or_window
);
5582 /* Ignore mouse events that were made on frames that
5583 have been deleted. */
5584 if (! FRAME_LIVE_P (f
))
5587 window
= window_from_coordinates (f
, XINT (event
->x
),
5588 XINT (event
->y
), &part
, 0);
5590 if (!WINDOWP (window
))
5592 window
= XCAR (event
->frame_or_window
);
5597 /* It's an event in window `window' at frame coordinates
5598 event->x/ event->y. */
5599 struct window
*w
= XWINDOW (window
);
5601 /* Get window relative coordinates. */
5602 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5603 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5605 /* Set event coordinates to window-relative coordinates
5606 for constructing the Lisp event below. */
5607 XSETINT (event
->x
, wx
);
5608 XSETINT (event
->y
, wy
);
5610 if (part
== ON_MODE_LINE
)
5612 else if (part
== ON_VERTICAL_BORDER
)
5613 posn
= Qvertical_line
;
5614 else if (part
== ON_HEADER_LINE
)
5615 posn
= Qheader_line
;
5619 struct display_pos p
;
5620 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5621 posn
= make_number (CHARPOS (p
.pos
));
5626 Lisp_Object head
, position
;
5631 Fcons (Fcons (event
->x
, event
->y
),
5632 Fcons (make_number (event
->timestamp
),
5635 head
= modify_event_symbol (0, event
->modifiers
,
5637 lispy_drag_n_drop_names
,
5638 &drag_n_drop_syms
, 1);
5645 #endif /* HAVE_MOUSE */
5647 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5648 || defined (USE_GTK)
5649 case MENU_BAR_EVENT
:
5650 if (EQ (event
->arg
, event
->frame_or_window
))
5651 /* This is the prefix key. We translate this to
5652 `(menu_bar)' because the code in keyboard.c for menu
5653 events, which we use, relies on this. */
5654 return Fcons (Qmenu_bar
, Qnil
);
5658 case SELECT_WINDOW_EVENT
:
5659 /* Make an event (select-window (WINDOW)). */
5660 return Fcons (Qselect_window
,
5661 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5664 case TOOL_BAR_EVENT
:
5665 if (EQ (event
->arg
, event
->frame_or_window
))
5666 /* This is the prefix key. We translate this to
5667 `(tool_bar)' because the code in keyboard.c for tool bar
5668 events, which we use, relies on this. */
5669 return Fcons (Qtool_bar
, Qnil
);
5670 else if (SYMBOLP (event
->arg
))
5671 return apply_modifiers (event
->modifiers
, event
->arg
);
5674 case USER_SIGNAL_EVENT
:
5675 /* A user signal. */
5676 return *lispy_user_signals
[event
->code
];
5678 case SAVE_SESSION_EVENT
:
5679 return Qsave_session
;
5681 /* The 'kind' field of the event is something we don't recognize. */
5690 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5692 Lisp_Object bar_window
;
5693 enum scroll_bar_part part
;
5697 /* Is it a scroll bar movement? */
5698 if (frame
&& ! NILP (bar_window
))
5700 Lisp_Object part_sym
;
5702 part_sym
= *scroll_bar_parts
[(int) part
];
5703 return Fcons (Qscroll_bar_movement
,
5704 (Fcons (Fcons (bar_window
,
5705 Fcons (Qvertical_scroll_bar
,
5706 Fcons (Fcons (x
, y
),
5707 Fcons (make_number (time
),
5713 /* Or is it an ordinary mouse movement? */
5716 enum window_part area
;
5721 /* It's in a frame; which window on that frame? */
5722 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5726 if (WINDOWP (window
))
5728 struct window
*w
= XWINDOW (window
);
5731 /* Get window relative coordinates. */
5732 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5733 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5737 if (area
== ON_MODE_LINE
)
5739 else if (area
== ON_VERTICAL_BORDER
)
5740 posn
= Qvertical_line
;
5741 else if (area
== ON_HEADER_LINE
)
5742 posn
= Qheader_line
;
5746 struct display_pos p
;
5747 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5748 posn
= make_number (CHARPOS (p
.pos
));
5751 else if (frame
!= 0)
5753 XSETFRAME (window
, frame
);
5764 return Fcons (Qmouse_movement
,
5765 Fcons (Fcons (window
,
5767 Fcons (Fcons (x
, y
),
5768 Fcons (make_number (time
),
5774 #endif /* HAVE_MOUSE */
5776 /* Construct a switch frame event. */
5778 make_lispy_switch_frame (frame
)
5781 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5784 /* Manipulating modifiers. */
5786 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5788 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5789 SYMBOL's name of the end of the modifiers; the string from this
5790 position is the unmodified symbol name.
5792 This doesn't use any caches. */
5795 parse_modifiers_uncached (symbol
, modifier_end
)
5803 CHECK_SYMBOL (symbol
);
5806 name
= SYMBOL_NAME (symbol
);
5808 for (i
= 0; i
+2 <= SBYTES (name
); )
5810 int this_mod_end
= 0;
5813 /* See if the name continues with a modifier word.
5814 Check that the word appears, but don't check what follows it.
5815 Set this_mod and this_mod_end to record what we find. */
5817 switch (SREF (name
, i
))
5819 #define SINGLE_LETTER_MOD(BIT) \
5820 (this_mod_end = i + 1, this_mod = BIT)
5823 SINGLE_LETTER_MOD (alt_modifier
);
5827 SINGLE_LETTER_MOD (ctrl_modifier
);
5831 SINGLE_LETTER_MOD (hyper_modifier
);
5835 SINGLE_LETTER_MOD (meta_modifier
);
5839 SINGLE_LETTER_MOD (shift_modifier
);
5843 SINGLE_LETTER_MOD (super_modifier
);
5846 #undef SINGLE_LETTER_MOD
5848 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5849 if (i + LEN + 1 <= SBYTES (name) \
5850 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5852 this_mod_end = i + LEN; \
5857 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5858 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5859 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5863 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5865 #undef MULTI_LETTER_MOD
5869 /* If we found no modifier, stop looking for them. */
5870 if (this_mod_end
== 0)
5873 /* Check there is a dash after the modifier, so that it
5874 really is a modifier. */
5875 if (this_mod_end
>= SBYTES (name
)
5876 || SREF (name
, this_mod_end
) != '-')
5879 /* This modifier is real; look for another. */
5880 modifiers
|= this_mod
;
5881 i
= this_mod_end
+ 1;
5884 /* Should we include the `click' modifier? */
5885 if (! (modifiers
& (down_modifier
| drag_modifier
5886 | double_modifier
| triple_modifier
))
5887 && i
+ 7 == SBYTES (name
)
5888 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5889 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5890 modifiers
|= click_modifier
;
5898 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5899 prepended to the string BASE[0..BASE_LEN-1].
5900 This doesn't use any caches. */
5902 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5905 int base_len
, base_len_byte
;
5907 /* Since BASE could contain nulls, we can't use intern here; we have
5908 to use Fintern, which expects a genuine Lisp_String, and keeps a
5911 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5917 /* Only the event queue may use the `up' modifier; it should always
5918 be turned into a click or drag event before presented to lisp code. */
5919 if (modifiers
& up_modifier
)
5922 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5923 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5924 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5925 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5926 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5927 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5928 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5929 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5930 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5931 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5932 /* The click modifier is denoted by the absence of other modifiers. */
5936 mod_len
= p
- new_mods
;
5940 Lisp_Object new_name
;
5942 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5943 mod_len
+ base_len_byte
);
5944 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5945 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5947 return Fintern (new_name
, Qnil
);
5952 static char *modifier_names
[] =
5954 "up", "down", "drag", "click", "double", "triple", 0, 0,
5955 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5956 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5958 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5960 static Lisp_Object modifier_symbols
;
5962 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5964 lispy_modifier_list (modifiers
)
5967 Lisp_Object modifier_list
;
5970 modifier_list
= Qnil
;
5971 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5972 if (modifiers
& (1<<i
))
5973 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5976 return modifier_list
;
5980 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5981 where UNMODIFIED is the unmodified form of SYMBOL,
5982 MASK is the set of modifiers present in SYMBOL's name.
5983 This is similar to parse_modifiers_uncached, but uses the cache in
5984 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5985 Qevent_symbol_elements property. */
5988 parse_modifiers (symbol
)
5991 Lisp_Object elements
;
5993 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5994 if (CONSP (elements
))
5999 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6000 Lisp_Object unmodified
;
6003 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6004 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6007 if (modifiers
& ~VALMASK
)
6009 XSETFASTINT (mask
, modifiers
);
6010 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6012 /* Cache the parsing results on SYMBOL. */
6013 Fput (symbol
, Qevent_symbol_element_mask
,
6015 Fput (symbol
, Qevent_symbol_elements
,
6016 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6018 /* Since we know that SYMBOL is modifiers applied to unmodified,
6019 it would be nice to put that in unmodified's cache.
6020 But we can't, since we're not sure that parse_modifiers is
6027 /* Apply the modifiers MODIFIERS to the symbol BASE.
6028 BASE must be unmodified.
6030 This is like apply_modifiers_uncached, but uses BASE's
6031 Qmodifier_cache property, if present. It also builds
6032 Qevent_symbol_elements properties, since it has that info anyway.
6034 apply_modifiers copies the value of BASE's Qevent_kind property to
6035 the modified symbol. */
6037 apply_modifiers (modifiers
, base
)
6041 Lisp_Object cache
, index
, entry
, new_symbol
;
6043 /* Mask out upper bits. We don't know where this value's been. */
6044 modifiers
&= VALMASK
;
6046 /* The click modifier never figures into cache indices. */
6047 cache
= Fget (base
, Qmodifier_cache
);
6048 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6049 entry
= assq_no_quit (index
, cache
);
6052 new_symbol
= XCDR (entry
);
6055 /* We have to create the symbol ourselves. */
6056 new_symbol
= apply_modifiers_uncached (modifiers
,
6057 SDATA (SYMBOL_NAME (base
)),
6058 SCHARS (SYMBOL_NAME (base
)),
6059 SBYTES (SYMBOL_NAME (base
)));
6061 /* Add the new symbol to the base's cache. */
6062 entry
= Fcons (index
, new_symbol
);
6063 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6065 /* We have the parsing info now for free, so add it to the caches. */
6066 XSETFASTINT (index
, modifiers
);
6067 Fput (new_symbol
, Qevent_symbol_element_mask
,
6068 Fcons (base
, Fcons (index
, Qnil
)));
6069 Fput (new_symbol
, Qevent_symbol_elements
,
6070 Fcons (base
, lispy_modifier_list (modifiers
)));
6073 /* Make sure this symbol is of the same kind as BASE.
6075 You'd think we could just set this once and for all when we
6076 intern the symbol above, but reorder_modifiers may call us when
6077 BASE's property isn't set right; we can't assume that just
6078 because it has a Qmodifier_cache property it must have its
6079 Qevent_kind set right as well. */
6080 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6084 kind
= Fget (base
, Qevent_kind
);
6086 Fput (new_symbol
, Qevent_kind
, kind
);
6093 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6094 return a symbol with the modifiers placed in the canonical order.
6095 Canonical order is alphabetical, except for down and drag, which
6096 always come last. The 'click' modifier is never written out.
6098 Fdefine_key calls this to make sure that (for example) C-M-foo
6099 and M-C-foo end up being equivalent in the keymap. */
6102 reorder_modifiers (symbol
)
6105 /* It's hopefully okay to write the code this way, since everything
6106 will soon be in caches, and no consing will be done at all. */
6109 parsed
= parse_modifiers (symbol
);
6110 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6115 /* For handling events, we often want to produce a symbol whose name
6116 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6117 to some base, like the name of a function key or mouse button.
6118 modify_event_symbol produces symbols of this sort.
6120 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6121 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6124 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6125 into symbol names, or a string specifying a name stem used to
6126 construct a symbol name or the form `STEM-N', where N is the decimal
6127 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6128 non-nil; otherwise NAME_TABLE is used.
6130 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6131 persist between calls to modify_event_symbol that it can use to
6132 store a cache of the symbols it's generated for this NAME_TABLE
6133 before. The object stored there may be a vector or an alist.
6135 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6137 MODIFIERS is a set of modifier bits (as given in struct input_events)
6138 whose prefixes should be applied to the symbol name.
6140 SYMBOL_KIND is the value to be placed in the event_kind property of
6141 the returned symbol.
6143 The symbols we create are supposed to have an
6144 `event-symbol-elements' property, which lists the modifiers present
6145 in the symbol's name. */
6148 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6149 name_table
, symbol_table
, table_size
)
6152 Lisp_Object symbol_kind
;
6153 Lisp_Object name_alist_or_stem
;
6155 Lisp_Object
*symbol_table
;
6156 unsigned int table_size
;
6159 Lisp_Object symbol_int
;
6161 /* Get rid of the "vendor-specific" bit here. */
6162 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6164 /* Is this a request for a valid symbol? */
6165 if (symbol_num
< 0 || symbol_num
>= table_size
)
6168 if (CONSP (*symbol_table
))
6169 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6171 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6172 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6173 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6174 we've never used that symbol before. */
6177 if (! VECTORP (*symbol_table
)
6178 || XVECTOR (*symbol_table
)->size
!= table_size
)
6182 XSETFASTINT (size
, table_size
);
6183 *symbol_table
= Fmake_vector (size
, Qnil
);
6186 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6189 /* Have we already used this symbol before? */
6192 /* No; let's create it. */
6193 if (CONSP (name_alist_or_stem
))
6194 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6195 else if (STRINGP (name_alist_or_stem
))
6197 int len
= SBYTES (name_alist_or_stem
);
6198 char *buf
= (char *) alloca (len
+ 50);
6199 if (sizeof (int) == sizeof (EMACS_INT
))
6200 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6201 XINT (symbol_int
) + 1);
6202 else if (sizeof (long) == sizeof (EMACS_INT
))
6203 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6204 XINT (symbol_int
) + 1);
6205 value
= intern (buf
);
6207 else if (name_table
!= 0 && name_table
[symbol_num
])
6208 value
= intern (name_table
[symbol_num
]);
6210 #ifdef HAVE_WINDOW_SYSTEM
6213 char *name
= x_get_keysym_name (symbol_num
);
6215 value
= intern (name
);
6222 sprintf (buf
, "key-%d", symbol_num
);
6223 value
= intern (buf
);
6226 if (CONSP (*symbol_table
))
6227 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6229 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6231 /* Fill in the cache entries for this symbol; this also
6232 builds the Qevent_symbol_elements property, which the user
6234 apply_modifiers (modifiers
& click_modifier
, value
);
6235 Fput (value
, Qevent_kind
, symbol_kind
);
6238 /* Apply modifiers to that symbol. */
6239 return apply_modifiers (modifiers
, value
);
6242 /* Convert a list that represents an event type,
6243 such as (ctrl meta backspace), into the usual representation of that
6244 event type as a number or a symbol. */
6246 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6247 doc
: /* Convert the event description list EVENT-DESC to an event type.
6248 EVENT-DESC should contain one base event type (a character or symbol)
6249 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6250 drag, down, double or triple). The base must be last.
6251 The return value is an event type (a character or symbol) which
6252 has the same base event type and all the specified modifiers. */)
6254 Lisp_Object event_desc
;
6262 while (CONSP (rest
))
6270 /* Given a symbol, see if it is a modifier name. */
6271 if (SYMBOLP (elt
) && CONSP (rest
))
6272 this = parse_solitary_modifier (elt
);
6276 else if (!NILP (base
))
6277 error ("Two bases given in one event");
6283 /* Let the symbol A refer to the character A. */
6284 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6285 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6287 if (INTEGERP (base
))
6289 /* Turn (shift a) into A. */
6290 if ((modifiers
& shift_modifier
) != 0
6291 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6293 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6294 modifiers
&= ~shift_modifier
;
6297 /* Turn (control a) into C-a. */
6298 if (modifiers
& ctrl_modifier
)
6299 return make_number ((modifiers
& ~ctrl_modifier
)
6300 | make_ctrl_char (XINT (base
)));
6302 return make_number (modifiers
| XINT (base
));
6304 else if (SYMBOLP (base
))
6305 return apply_modifiers (modifiers
, base
);
6308 error ("Invalid base event");
6313 /* Try to recognize SYMBOL as a modifier name.
6314 Return the modifier flag bit, or 0 if not recognized. */
6317 parse_solitary_modifier (symbol
)
6320 Lisp_Object name
= SYMBOL_NAME (symbol
);
6322 switch (SREF (name
, 0))
6324 #define SINGLE_LETTER_MOD(BIT) \
6325 if (SBYTES (name) == 1) \
6328 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6329 if (LEN == SBYTES (name) \
6330 && ! strncmp (SDATA (name), NAME, LEN)) \
6334 SINGLE_LETTER_MOD (alt_modifier
);
6338 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6342 SINGLE_LETTER_MOD (ctrl_modifier
);
6346 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6347 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6351 SINGLE_LETTER_MOD (hyper_modifier
);
6355 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6359 SINGLE_LETTER_MOD (meta_modifier
);
6363 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6367 SINGLE_LETTER_MOD (shift_modifier
);
6371 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6372 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6373 SINGLE_LETTER_MOD (super_modifier
);
6377 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6378 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6379 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6383 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6386 #undef SINGLE_LETTER_MOD
6387 #undef MULTI_LETTER_MOD
6393 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6394 Such a list is not valid as an event,
6395 but it can be a Lucid-style event type list. */
6398 lucid_event_type_list_p (object
)
6403 if (! CONSP (object
))
6406 if (EQ (XCAR (object
), Qhelp_echo
)
6407 || EQ (XCAR (object
), Qvertical_line
)
6408 || EQ (XCAR (object
), Qmode_line
)
6409 || EQ (XCAR (object
), Qheader_line
))
6412 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6416 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6423 /* Store into *addr a value nonzero if terminal input chars are available.
6424 Serves the purpose of ioctl (0, FIONREAD, addr)
6425 but works even if FIONREAD does not exist.
6426 (In fact, this may actually read some input.)
6428 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6429 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6432 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6437 /* First of all, have we already counted some input? */
6438 *addr
= (!NILP (Vquit_flag
)
6439 || readable_filtered_events (do_timers_now
, filter_events
));
6441 /* If input is being read as it arrives, and we have none, there is none. */
6442 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6445 /* Try to read some input and see how much we get. */
6447 *addr
= (!NILP (Vquit_flag
)
6448 || readable_filtered_events (do_timers_now
, filter_events
));
6451 /* Store into *addr a value nonzero if terminal input chars are available.
6452 Serves the purpose of ioctl (0, FIONREAD, addr)
6453 but works even if FIONREAD does not exist.
6454 (In fact, this may actually read some input.)
6456 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6459 get_input_pending (addr
, do_timers_now
)
6463 get_filtered_input_pending (addr
, do_timers_now
, 0);
6466 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6469 gobble_input (expected
)
6474 if (interrupt_input
)
6477 mask
= sigblock (sigmask (SIGIO
));
6478 read_avail_input (expected
);
6482 #ifdef POLL_FOR_INPUT
6483 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6486 mask
= sigblock (sigmask (SIGALRM
));
6487 read_avail_input (expected
);
6493 read_avail_input (expected
);
6497 /* Put a BUFFER_SWITCH_EVENT in the buffer
6498 so that read_key_sequence will notice the new current buffer. */
6501 record_asynch_buffer_change ()
6503 struct input_event event
;
6506 event
.kind
= BUFFER_SWITCH_EVENT
;
6507 event
.frame_or_window
= Qnil
;
6511 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6512 The purpose of the event is to make read_key_sequence look up the
6513 keymaps again. If we aren't in read_key_sequence, we don't need one,
6514 and the event could cause trouble by messing up (input-pending-p). */
6515 tem
= Fwaiting_for_user_input_p ();
6519 /* We never need these events if we have no asynchronous subprocesses. */
6523 /* Make sure no interrupt happens while storing the event. */
6525 if (interrupt_input
)
6528 mask
= sigblock (sigmask (SIGIO
));
6529 kbd_buffer_store_event (&event
);
6536 kbd_buffer_store_event (&event
);
6543 /* Read any terminal input already buffered up by the system
6544 into the kbd_buffer, but do not wait.
6546 EXPECTED should be nonzero if the caller knows there is some input.
6548 Except on VMS, all input is read by this function.
6549 If interrupt_input is nonzero, this function MUST be called
6550 only when SIGIO is blocked.
6552 Returns the number of keyboard chars read, or -1 meaning
6553 this is a bad time to try to read input. */
6556 read_avail_input (expected
)
6559 struct input_event buf
[KBD_BUFFER_SIZE
];
6563 if (read_socket_hook
)
6564 /* No need for FIONREAD or fcntl; just say don't wait. */
6565 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6568 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6569 the kbd_buffer can really hold. That may prevent loss
6570 of characters on some systems when input is stuffed at us. */
6571 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6574 /* Determine how many characters we should *try* to read. */
6577 #else /* not WINDOWSNT */
6579 n_to_read
= dos_keysns ();
6582 #else /* not MSDOS */
6584 /* Find out how much input is available. */
6585 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6586 /* Formerly simply reported no input, but that sometimes led to
6587 a failure of Emacs to terminate.
6588 SIGHUP seems appropriate if we can't reach the terminal. */
6589 /* ??? Is it really right to send the signal just to this process
6590 rather than to the whole process group?
6591 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6592 kill (getpid (), SIGHUP
);
6595 if (n_to_read
> sizeof cbuf
)
6596 n_to_read
= sizeof cbuf
;
6597 #else /* no FIONREAD */
6598 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6599 /* Read some input if available, but don't wait. */
6600 n_to_read
= sizeof cbuf
;
6601 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6606 #endif /* not MSDOS */
6607 #endif /* not WINDOWSNT */
6609 /* Now read; for one reason or another, this will not block.
6610 NREAD is set to the number of chars read. */
6614 cbuf
[0] = dos_keyread ();
6617 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6619 /* POSIX infers that processes which are not in the session leader's
6620 process group won't get SIGHUP's at logout time. BSDI adheres to
6621 this part standard and returns -1 from read (0) with errno==EIO
6622 when the control tty is taken away.
6623 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6624 if (nread
== -1 && errno
== EIO
)
6626 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6627 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6628 This looks incorrect, but it isn't, because _BSD causes
6629 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6630 and that causes a value other than 0 when there is no input. */
6636 /* We used to retry the read if it was interrupted.
6637 But this does the wrong thing when O_NDELAY causes
6638 an EAGAIN error. Does anybody know of a situation
6639 where a retry is actually needed? */
6641 nread
< 0 && (errno
== EAGAIN
6655 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6656 fcntl (input_fd
, F_SETFL
, 0);
6657 #endif /* USG or DGUX or CYGWIN */
6658 #endif /* no FIONREAD */
6659 for (i
= 0; i
< nread
; i
++)
6661 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6662 buf
[i
].modifiers
= 0;
6663 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6664 buf
[i
].modifiers
= meta_modifier
;
6668 buf
[i
].code
= cbuf
[i
];
6669 buf
[i
].frame_or_window
= selected_frame
;
6674 /* Scan the chars for C-g and store them in kbd_buffer. */
6675 for (i
= 0; i
< nread
; i
++)
6677 kbd_buffer_store_event (&buf
[i
]);
6678 /* Don't look at input that follows a C-g too closely.
6679 This reduces lossage due to autorepeat on C-g. */
6680 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6681 && buf
[i
].code
== quit_char
)
6687 #endif /* not VMS */
6689 #ifdef SIGIO /* for entire page */
6690 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6693 input_available_signal (signo
)
6696 /* Must preserve main program's value of errno. */
6697 int old_errno
= errno
;
6699 extern int select_alarmed
;
6702 #if defined (USG) && !defined (POSIX_SIGNALS)
6703 /* USG systems forget handlers when they are used;
6704 must reestablish each time */
6705 signal (signo
, input_available_signal
);
6712 if (input_available_clear_time
)
6713 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6718 nread
= read_avail_input (1);
6719 /* -1 means it's not ok to read the input now.
6720 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6721 0 means there was no keyboard input available. */
6726 select_alarmed
= 1; /* Force the select emulator back to life */
6737 /* Send ourselves a SIGIO.
6739 This function exists so that the UNBLOCK_INPUT macro in
6740 blockinput.h can have some way to take care of input we put off
6741 dealing with, without assuming that every file which uses
6742 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6744 reinvoke_input_signal ()
6747 kill (getpid (), SIGIO
);
6753 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6754 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6756 /* These variables hold the vector under construction within
6757 menu_bar_items and its subroutines, and the current index
6758 for storing into that vector. */
6759 static Lisp_Object menu_bar_items_vector
;
6760 static int menu_bar_items_index
;
6762 /* Return a vector of menu items for a menu bar, appropriate
6763 to the current buffer. Each item has three elements in the vector:
6766 OLD is an old vector we can optionally reuse, or nil. */
6769 menu_bar_items (old
)
6772 /* The number of keymaps we're scanning right now, and the number of
6773 keymaps we have allocated space for. */
6776 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6777 in the current keymaps, or nil where it is not a prefix. */
6780 Lisp_Object def
, tail
;
6789 struct gcpro gcpro1
;
6791 /* In order to build the menus, we need to call the keymap
6792 accessors. They all call QUIT. But this function is called
6793 during redisplay, during which a quit is fatal. So inhibit
6794 quitting while building the menus.
6795 We do this instead of specbind because (1) errors will clear it anyway
6796 and (2) this avoids risk of specpdl overflow. */
6797 oquit
= Vinhibit_quit
;
6801 menu_bar_items_vector
= old
;
6803 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6804 menu_bar_items_index
= 0;
6806 GCPRO1 (menu_bar_items_vector
);
6808 /* Build our list of keymaps.
6809 If we recognize a function key and replace its escape sequence in
6810 keybuf with its symbol, or if the sequence starts with a mouse
6811 click and we need to switch buffers, we jump back here to rebuild
6812 the initial keymaps from the current buffer. */
6816 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6817 if (!NILP (Voverriding_local_map_menu_flag
))
6819 /* Yes, use them (if non-nil) as well as the global map. */
6820 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6822 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6823 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6824 if (!NILP (Voverriding_local_map
))
6825 maps
[nmaps
++] = Voverriding_local_map
;
6829 /* No, so use major and minor mode keymaps and keymap property.
6830 Note that menu-bar bindings in the local-map and keymap
6831 properties may not work reliable, as they are only
6832 recognized when the menu-bar (or mode-line) is updated,
6833 which does not normally happen after every command. */
6836 nminor
= current_minor_maps (NULL
, &tmaps
);
6837 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6839 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6840 maps
[nmaps
++] = tem
;
6841 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6843 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6845 maps
[nmaps
++] = current_global_map
;
6848 /* Look up in each map the dummy prefix key `menu-bar'. */
6852 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6853 if (!NILP (maps
[mapno
]))
6855 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6858 menu_bar_one_keymap (def
);
6861 /* Move to the end those items that should be at the end. */
6863 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6866 int end
= menu_bar_items_index
;
6868 for (i
= 0; i
< end
; i
+= 4)
6869 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6871 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6872 /* Move the item at index I to the end,
6873 shifting all the others forward. */
6874 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6875 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6876 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6877 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6879 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6880 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6881 (end
- i
- 4) * sizeof (Lisp_Object
));
6882 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6883 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6884 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6885 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6890 /* Add nil, nil, nil, nil at the end. */
6891 i
= menu_bar_items_index
;
6892 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6895 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6896 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6897 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6898 menu_bar_items_vector
= tem
;
6900 /* Add this item. */
6901 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6902 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6903 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6904 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6905 menu_bar_items_index
= i
;
6907 Vinhibit_quit
= oquit
;
6909 return menu_bar_items_vector
;
6912 /* Scan one map KEYMAP, accumulating any menu items it defines
6913 in menu_bar_items_vector. */
6915 static Lisp_Object menu_bar_one_keymap_changed_items
;
6918 menu_bar_one_keymap (keymap
)
6921 Lisp_Object tail
, item
;
6923 menu_bar_one_keymap_changed_items
= Qnil
;
6925 /* Loop over all keymap entries that have menu strings. */
6926 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6930 menu_bar_item (XCAR (item
), XCDR (item
));
6931 else if (VECTORP (item
))
6933 /* Loop over the char values represented in the vector. */
6934 int len
= XVECTOR (item
)->size
;
6936 for (c
= 0; c
< len
; c
++)
6938 Lisp_Object character
;
6939 XSETFASTINT (character
, c
);
6940 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6946 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6947 If there's already an item for KEY, add this DEF to it. */
6949 Lisp_Object item_properties
;
6952 menu_bar_item (key
, item
)
6953 Lisp_Object key
, item
;
6955 struct gcpro gcpro1
;
6959 if (EQ (item
, Qundefined
))
6961 /* If a map has an explicit `undefined' as definition,
6962 discard any previously made menu bar item. */
6964 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6965 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6967 if (menu_bar_items_index
> i
+ 4)
6968 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6969 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6970 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6971 menu_bar_items_index
-= 4;
6975 /* If this keymap has already contributed to this KEY,
6976 don't contribute to it a second time. */
6977 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6978 if (!NILP (tem
) || NILP (item
))
6981 menu_bar_one_keymap_changed_items
6982 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6984 /* We add to menu_bar_one_keymap_changed_items before doing the
6985 parse_menu_item, so that if it turns out it wasn't a menu item,
6986 it still correctly hides any further menu item. */
6988 i
= parse_menu_item (item
, 0, 1);
6993 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6995 /* Find any existing item for this KEY. */
6996 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6997 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7000 /* If we did not find this KEY, add it at the end. */
7001 if (i
== menu_bar_items_index
)
7003 /* If vector is too small, get a bigger one. */
7004 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7007 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7008 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7009 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7010 menu_bar_items_vector
= tem
;
7013 /* Add this item. */
7014 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7015 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7016 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7017 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7018 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7019 menu_bar_items_index
= i
;
7021 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7025 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7026 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
7030 /* This is used as the handler when calling menu_item_eval_property. */
7032 menu_item_eval_property_1 (arg
)
7035 /* If we got a quit from within the menu computation,
7036 quit all the way out of it. This takes care of C-] in the debugger. */
7037 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7038 Fsignal (Qquit
, Qnil
);
7043 /* Evaluate an expression and return the result (or nil if something
7044 went wrong). Used to evaluate dynamic parts of menu items. */
7046 menu_item_eval_property (sexpr
)
7049 int count
= SPECPDL_INDEX ();
7051 specbind (Qinhibit_redisplay
, Qt
);
7052 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7053 menu_item_eval_property_1
);
7054 return unbind_to (count
, val
);
7057 /* This function parses a menu item and leaves the result in the
7058 vector item_properties.
7059 ITEM is a key binding, a possible menu item.
7060 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7061 evaluate dynamic expressions in the menu item.
7062 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7064 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7065 parse_menu_item returns true if the item is a menu item and false
7069 parse_menu_item (item
, notreal
, inmenubar
)
7071 int notreal
, inmenubar
;
7073 Lisp_Object def
, tem
, item_string
, start
;
7074 Lisp_Object cachelist
;
7076 Lisp_Object keyhint
;
7087 /* Create item_properties vector if necessary. */
7088 if (NILP (item_properties
))
7090 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7092 /* Initialize optional entries. */
7093 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7094 AREF (item_properties
, i
) = Qnil
;
7095 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7097 /* Save the item here to protect it from GC. */
7098 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7100 item_string
= XCAR (item
);
7104 if (STRINGP (item_string
))
7106 /* Old format menu item. */
7107 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7109 /* Maybe help string. */
7110 if (CONSP (item
) && STRINGP (XCAR (item
)))
7112 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7117 /* Maybe key binding cache. */
7118 if (CONSP (item
) && CONSP (XCAR (item
))
7119 && (NILP (XCAR (XCAR (item
)))
7120 || VECTORP (XCAR (XCAR (item
)))))
7122 cachelist
= XCAR (item
);
7126 /* This is the real definition--the function to run. */
7127 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7129 /* Get enable property, if any. */
7132 tem
= Fget (item
, Qmenu_enable
);
7134 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7137 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7139 /* New format menu item. */
7140 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7141 start
= XCDR (item
);
7144 /* We have a real binding. */
7145 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7147 item
= XCDR (start
);
7148 /* Is there a cache list with key equivalences. */
7149 if (CONSP (item
) && CONSP (XCAR (item
)))
7151 cachelist
= XCAR (item
);
7155 /* Parse properties. */
7156 while (CONSP (item
) && CONSP (XCDR (item
)))
7161 if (EQ (tem
, QCenable
))
7162 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7163 else if (EQ (tem
, QCvisible
) && !notreal
)
7165 /* If got a visible property and that evaluates to nil
7166 then ignore this item. */
7167 tem
= menu_item_eval_property (XCAR (item
));
7171 else if (EQ (tem
, QChelp
))
7172 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7173 else if (EQ (tem
, QCfilter
))
7175 else if (EQ (tem
, QCkey_sequence
))
7178 if (NILP (cachelist
)
7179 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7180 /* Be GC protected. Set keyhint to item instead of tem. */
7183 else if (EQ (tem
, QCkeys
))
7186 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7187 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7189 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7194 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7196 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7198 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7205 else if (inmenubar
|| !NILP (start
))
7209 return 0; /* not a menu item */
7211 /* If item string is not a string, evaluate it to get string.
7212 If we don't get a string, skip this item. */
7213 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7214 if (!(STRINGP (item_string
) || notreal
))
7216 item_string
= menu_item_eval_property (item_string
);
7217 if (!STRINGP (item_string
))
7219 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7222 /* If got a filter apply it on definition. */
7223 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7226 def
= menu_item_eval_property (list2 (XCAR (filter
),
7227 list2 (Qquote
, def
)));
7229 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7232 /* Enable or disable selection of item. */
7233 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7239 tem
= menu_item_eval_property (tem
);
7240 if (inmenubar
&& NILP (tem
))
7241 return 0; /* Ignore disabled items in menu bar. */
7242 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7245 /* If we got no definition, this item is just unselectable text which
7246 is OK in a submenu but not in the menubar. */
7248 return (inmenubar
? 0 : 1);
7250 /* See if this is a separate pane or a submenu. */
7251 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7252 tem
= get_keymap (def
, 0, 1);
7253 /* For a subkeymap, just record its details and exit. */
7256 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7257 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7261 /* At the top level in the menu bar, do likewise for commands also.
7262 The menu bar does not display equivalent key bindings anyway.
7263 ITEM_PROPERTY_DEF is already set up properly. */
7267 /* This is a command. See if there is an equivalent key binding. */
7268 if (NILP (cachelist
))
7270 /* We have to create a cachelist. */
7271 CHECK_IMPURE (start
);
7272 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7273 cachelist
= XCAR (XCDR (start
));
7275 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7276 if (!NILP (keyhint
))
7278 XSETCAR (cachelist
, XCAR (keyhint
));
7281 else if (STRINGP (tem
))
7283 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7284 XSETCAR (cachelist
, Qt
);
7288 tem
= XCAR (cachelist
);
7295 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7297 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7300 def
= XCAR (prefix
);
7301 prefix
= XCDR (prefix
);
7304 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7306 if (!update_menu_bindings
)
7308 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7310 if (newcache
/* Always check first time. */
7311 /* Should we check everything when precomputing key
7313 /* If something had no key binding before, don't recheck it
7314 because that is too slow--except if we have a list of
7315 rebound commands in Vdefine_key_rebound_commands, do
7316 recheck any command that appears in that list. */
7317 || (CONSP (Vdefine_key_rebound_commands
)
7318 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7321 /* We had a saved key. Is it still bound to the command? */
7324 /* If the command is an alias for another
7325 (such as lmenu.el set it up), check if the
7326 original command matches the cached command. */
7327 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7328 chkcache
= 1; /* Need to recompute key binding. */
7332 /* Recompute equivalent key binding. If the command is an alias
7333 for another (such as lmenu.el set it up), see if the original
7334 command name has equivalent keys. Otherwise look up the
7335 specified command itself. We don't try both, because that
7336 makes lmenu menus slow. */
7338 && SYMBOLP (XSYMBOL (def
)->function
)
7339 && ! NILP (Fget (def
, Qmenu_alias
)))
7340 def
= XSYMBOL (def
)->function
;
7341 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7342 XSETCAR (cachelist
, tem
);
7345 XSETCDR (cachelist
, Qnil
);
7349 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7351 tem
= XCAR (cachelist
);
7355 newcache
= chkcache
;
7358 tem
= Fkey_description (tem
);
7361 if (STRINGP (XCAR (prefix
)))
7362 tem
= concat2 (XCAR (prefix
), tem
);
7363 if (STRINGP (XCDR (prefix
)))
7364 tem
= concat2 (tem
, XCDR (prefix
));
7366 XSETCDR (cachelist
, tem
);
7370 tem
= XCDR (cachelist
);
7371 if (newcache
&& !NILP (tem
))
7373 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7374 XSETCDR (cachelist
, tem
);
7377 /* If we only want to precompute equivalent key bindings, stop here. */
7381 /* If we have an equivalent key binding, use that. */
7382 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7384 /* Include this when menu help is implemented.
7385 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7386 if (!(NILP (tem) || STRINGP (tem)))
7388 tem = menu_item_eval_property (tem);
7391 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7395 /* Handle radio buttons or toggle boxes. */
7396 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7398 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7399 = menu_item_eval_property (tem
);
7406 /***********************************************************************
7408 ***********************************************************************/
7410 /* A vector holding tool bar items while they are parsed in function
7411 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7414 static Lisp_Object tool_bar_items_vector
;
7416 /* A vector holding the result of parse_tool_bar_item. Layout is like
7417 the one for a single item in tool_bar_items_vector. */
7419 static Lisp_Object tool_bar_item_properties
;
7421 /* Next free index in tool_bar_items_vector. */
7423 static int ntool_bar_items
;
7425 /* The symbols `tool-bar', and `:image'. */
7427 extern Lisp_Object Qtool_bar
;
7428 Lisp_Object QCimage
;
7430 /* Function prototypes. */
7432 static void init_tool_bar_items
P_ ((Lisp_Object
));
7433 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7434 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7435 static void append_tool_bar_item
P_ ((void));
7438 /* Return a vector of tool bar items for keymaps currently in effect.
7439 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7440 tool bar items found. */
7443 tool_bar_items (reuse
, nitems
)
7454 /* In order to build the menus, we need to call the keymap
7455 accessors. They all call QUIT. But this function is called
7456 during redisplay, during which a quit is fatal. So inhibit
7457 quitting while building the menus. We do this instead of
7458 specbind because (1) errors will clear it anyway and (2) this
7459 avoids risk of specpdl overflow. */
7460 oquit
= Vinhibit_quit
;
7463 /* Initialize tool_bar_items_vector and protect it from GC. */
7464 init_tool_bar_items (reuse
);
7466 /* Build list of keymaps in maps. Set nmaps to the number of maps
7469 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7470 if (!NILP (Voverriding_local_map_menu_flag
))
7472 /* Yes, use them (if non-nil) as well as the global map. */
7473 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7475 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7476 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7477 if (!NILP (Voverriding_local_map
))
7478 maps
[nmaps
++] = Voverriding_local_map
;
7482 /* No, so use major and minor mode keymaps and keymap property.
7483 Note that tool-bar bindings in the local-map and keymap
7484 properties may not work reliable, as they are only
7485 recognized when the tool-bar (or mode-line) is updated,
7486 which does not normally happen after every command. */
7489 nminor
= current_minor_maps (NULL
, &tmaps
);
7490 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7492 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7493 maps
[nmaps
++] = tem
;
7494 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7496 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7499 /* Add global keymap at the end. */
7500 maps
[nmaps
++] = current_global_map
;
7502 /* Process maps in reverse order and look up in each map the prefix
7504 for (i
= nmaps
- 1; i
>= 0; --i
)
7505 if (!NILP (maps
[i
]))
7509 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7514 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7515 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7517 Lisp_Object keydef
= XCAR (tail
);
7519 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7524 Vinhibit_quit
= oquit
;
7525 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7526 return tool_bar_items_vector
;
7530 /* Process the definition of KEY which is DEF. */
7533 process_tool_bar_item (key
, def
)
7534 Lisp_Object key
, def
;
7537 extern Lisp_Object Qundefined
;
7538 struct gcpro gcpro1
, gcpro2
;
7540 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7544 if (EQ (def
, Qundefined
))
7546 /* If a map has an explicit `undefined' as definition,
7547 discard any previously made item. */
7548 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7550 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7552 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7554 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7555 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7556 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7557 * sizeof (Lisp_Object
)));
7558 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7563 else if (parse_tool_bar_item (key
, def
))
7564 /* Append a new tool bar item to tool_bar_items_vector. Accept
7565 more than one definition for the same key. */
7566 append_tool_bar_item ();
7572 /* Parse a tool bar item specification ITEM for key KEY and return the
7573 result in tool_bar_item_properties. Value is zero if ITEM is
7576 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7578 CAPTION is the caption of the item, If it's not a string, it is
7579 evaluated to get a string.
7581 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7582 as binding are currently ignored.
7584 The following properties are recognized:
7588 FORM is evaluated and specifies whether the tool bar item is
7589 enabled or disabled.
7593 FORM is evaluated and specifies whether the tool bar item is visible.
7595 - `:filter FUNCTION'
7597 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7598 result is stored as the new binding.
7600 - `:button (TYPE SELECTED)'
7602 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7603 and specifies whether the button is selected (pressed) or not.
7607 IMAGES is either a single image specification or a vector of four
7608 image specifications. See enum tool_bar_item_images.
7610 - `:help HELP-STRING'.
7612 Gives a help string to display for the tool bar item. */
7615 parse_tool_bar_item (key
, item
)
7616 Lisp_Object key
, item
;
7618 /* Access slot with index IDX of vector tool_bar_item_properties. */
7619 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7621 Lisp_Object filter
= Qnil
;
7622 Lisp_Object caption
;
7625 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7626 Rule out items that aren't lists, don't start with
7627 `menu-item' or whose rest following `tool-bar-item' is not a
7630 || !EQ (XCAR (item
), Qmenu_item
)
7631 || (item
= XCDR (item
),
7635 /* Create tool_bar_item_properties vector if necessary. Reset it to
7637 if (VECTORP (tool_bar_item_properties
))
7639 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7643 tool_bar_item_properties
7644 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7647 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7648 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7650 /* Get the caption of the item. If the caption is not a string,
7651 evaluate it to get a string. If we don't get a string, skip this
7653 caption
= XCAR (item
);
7654 if (!STRINGP (caption
))
7656 caption
= menu_item_eval_property (caption
);
7657 if (!STRINGP (caption
))
7660 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7662 /* Give up if rest following the caption is not a list. */
7667 /* Store the binding. */
7668 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7671 /* Ignore cached key binding, if any. */
7672 if (CONSP (item
) && CONSP (XCAR (item
)))
7675 /* Process the rest of the properties. */
7676 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7678 Lisp_Object key
, value
;
7681 value
= XCAR (XCDR (item
));
7683 if (EQ (key
, QCenable
))
7684 /* `:enable FORM'. */
7685 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7686 else if (EQ (key
, QCvisible
))
7688 /* `:visible FORM'. If got a visible property and that
7689 evaluates to nil then ignore this item. */
7690 if (NILP (menu_item_eval_property (value
)))
7693 else if (EQ (key
, QChelp
))
7694 /* `:help HELP-STRING'. */
7695 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7696 else if (EQ (key
, QCfilter
))
7697 /* ':filter FORM'. */
7699 else if (EQ (key
, QCbutton
) && CONSP (value
))
7701 /* `:button (TYPE . SELECTED)'. */
7702 Lisp_Object type
, selected
;
7704 type
= XCAR (value
);
7705 selected
= XCDR (value
);
7706 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7708 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7709 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7712 else if (EQ (key
, QCimage
)
7714 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7715 /* Value is either a single image specification or a vector
7716 of 4 such specifications for the different button states. */
7717 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7720 /* If got a filter apply it on binding. */
7722 PROP (TOOL_BAR_ITEM_BINDING
)
7723 = menu_item_eval_property (list2 (filter
,
7725 PROP (TOOL_BAR_ITEM_BINDING
))));
7727 /* See if the binding is a keymap. Give up if it is. */
7728 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7731 /* Enable or disable selection of item. */
7732 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7733 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7734 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7736 /* Handle radio buttons or toggle boxes. */
7737 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7738 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7739 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7747 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7748 that can be reused. */
7751 init_tool_bar_items (reuse
)
7754 if (VECTORP (reuse
))
7755 tool_bar_items_vector
= reuse
;
7757 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7758 ntool_bar_items
= 0;
7762 /* Append parsed tool bar item properties from
7763 tool_bar_item_properties */
7766 append_tool_bar_item ()
7768 Lisp_Object
*to
, *from
;
7770 /* Enlarge tool_bar_items_vector if necessary. */
7771 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7772 >= XVECTOR (tool_bar_items_vector
)->size
)
7774 Lisp_Object new_vector
;
7775 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7777 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7778 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7779 XVECTOR (new_vector
)->contents
,
7780 old_size
* sizeof (Lisp_Object
));
7781 tool_bar_items_vector
= new_vector
;
7784 /* Append entries from tool_bar_item_properties to the end of
7785 tool_bar_items_vector. */
7786 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7787 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7788 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7789 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7796 /* Read a character using menus based on maps in the array MAPS.
7797 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7798 Return t if we displayed a menu but the user rejected it.
7800 PREV_EVENT is the previous input event, or nil if we are reading
7801 the first event of a key sequence.
7803 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7804 if we used a mouse menu to read the input, or zero otherwise. If
7805 USED_MOUSE_MENU is null, we don't dereference it.
7807 The prompting is done based on the prompt-string of the map
7808 and the strings associated with various map elements.
7810 This can be done with X menus or with menus put in the minibuf.
7811 These are done in different ways, depending on how the input will be read.
7812 Menus using X are done after auto-saving in read-char, getting the input
7813 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7814 and do auto-saving in the inner call of read_char. */
7817 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7820 Lisp_Object prev_event
;
7821 int *used_mouse_menu
;
7824 register Lisp_Object name
= Qnil
;
7826 if (used_mouse_menu
)
7827 *used_mouse_menu
= 0;
7829 /* Use local over global Menu maps */
7831 if (! menu_prompting
)
7834 /* Optionally disregard all but the global map. */
7835 if (inhibit_local_menu_bar_menus
)
7837 maps
+= (nmaps
- 1);
7841 /* Get the menu name from the first map that has one (a prompt string). */
7842 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7844 name
= Fkeymap_prompt (maps
[mapno
]);
7849 /* If we don't have any menus, just read a character normally. */
7850 if (!STRINGP (name
))
7854 /* If we got to this point via a mouse click,
7855 use a real menu for mouse selection. */
7856 if (EVENT_HAS_PARAMETERS (prev_event
)
7857 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7858 && !EQ (XCAR (prev_event
), Qtool_bar
))
7860 /* Display the menu and get the selection. */
7861 Lisp_Object
*realmaps
7862 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7866 /* Use the maps that are not nil. */
7867 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7868 if (!NILP (maps
[mapno
]))
7869 realmaps
[nmaps1
++] = maps
[mapno
];
7871 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7876 record_menu_key (XCAR (value
));
7878 /* If we got multiple events, unread all but
7880 There is no way to prevent those unread events
7881 from showing up later in last_nonmenu_event.
7882 So turn symbol and integer events into lists,
7883 to indicate that they came from a mouse menu,
7884 so that when present in last_nonmenu_event
7885 they won't confuse things. */
7886 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7888 record_menu_key (XCAR (tem
));
7889 if (SYMBOLP (XCAR (tem
))
7890 || INTEGERP (XCAR (tem
)))
7891 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7894 /* If we got more than one event, put all but the first
7895 onto this list to be read later.
7896 Return just the first event now. */
7897 Vunread_command_events
7898 = nconc2 (XCDR (value
), Vunread_command_events
);
7899 value
= XCAR (value
);
7901 else if (NILP (value
))
7903 if (used_mouse_menu
)
7904 *used_mouse_menu
= 1;
7907 #endif /* HAVE_MENUS */
7911 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7912 We make this bigger when necessary, and never free it. */
7913 static char *read_char_minibuf_menu_text
;
7914 /* Size of that buffer. */
7915 static int read_char_minibuf_menu_width
;
7918 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7924 register Lisp_Object name
;
7926 /* FIXME: Use the minibuffer's frame width. */
7927 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7930 Lisp_Object rest
, vector
;
7936 if (! menu_prompting
)
7939 /* Make sure we have a big enough buffer for the menu text. */
7940 if (read_char_minibuf_menu_text
== 0)
7942 read_char_minibuf_menu_width
= width
+ 4;
7943 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7945 else if (width
+ 4 > read_char_minibuf_menu_width
)
7947 read_char_minibuf_menu_width
= width
+ 4;
7948 read_char_minibuf_menu_text
7949 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7951 menu
= read_char_minibuf_menu_text
;
7953 /* Get the menu name from the first map that has one (a prompt string). */
7954 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7956 name
= Fkeymap_prompt (maps
[mapno
]);
7961 /* If we don't have any menus, just read a character normally. */
7962 if (!STRINGP (name
))
7965 /* Prompt string always starts with map's prompt, and a space. */
7966 strcpy (menu
, SDATA (name
));
7967 nlength
= SBYTES (name
);
7968 menu
[nlength
++] = ':';
7969 menu
[nlength
++] = ' ';
7972 /* Start prompting at start of first map. */
7976 /* Present the documented bindings, a line at a time. */
7983 Lisp_Object orig_defn_macro
;
7985 /* Loop over elements of map. */
7990 /* If reached end of map, start at beginning of next map. */
7994 /* At end of last map, wrap around to first map if just starting,
7995 or end this line if already have something on it. */
7999 if (notfirst
|| nobindings
) break;
8004 /* Look at the next element of the map. */
8006 elt
= XVECTOR (vector
)->contents
[idx
];
8008 elt
= Fcar_safe (rest
);
8010 if (idx
< 0 && VECTORP (elt
))
8012 /* If we found a dense table in the keymap,
8013 advanced past it, but start scanning its contents. */
8014 rest
= Fcdr_safe (rest
);
8020 /* An ordinary element. */
8021 Lisp_Object event
, tem
;
8025 event
= Fcar_safe (elt
); /* alist */
8026 elt
= Fcdr_safe (elt
);
8030 XSETINT (event
, idx
); /* vector */
8033 /* Ignore the element if it has no prompt string. */
8034 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8036 /* 1 if the char to type matches the string. */
8038 Lisp_Object upcased_event
, downcased_event
;
8039 Lisp_Object desc
= Qnil
;
8041 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8043 upcased_event
= Fupcase (event
);
8044 downcased_event
= Fdowncase (event
);
8045 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8046 || XINT (downcased_event
) == SREF (s
, 0));
8048 desc
= Fsingle_key_description (event
, Qnil
);
8050 #if 0 /* It is redundant to list the equivalent key bindings because
8051 the prefix is what the user has already typed. */
8053 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8055 /* Insert equivalent keybinding. */
8056 s
= concat2 (s
, tem
);
8059 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8060 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8062 /* Insert button prefix. */
8063 Lisp_Object selected
8064 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8065 if (EQ (tem
, QCradio
))
8066 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8068 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8069 s
= concat2 (tem
, s
);
8073 /* If we have room for the prompt string, add it to this line.
8074 If this is the first on the line, always add it. */
8075 if ((SCHARS (s
) + i
+ 2
8076 + (char_matches
? 0 : SCHARS (desc
) + 3))
8082 /* Punctuate between strings. */
8085 strcpy (menu
+ i
, ", ");
8091 /* If the char to type doesn't match the string's
8092 first char, explicitly show what char to type. */
8095 /* Add as much of string as fits. */
8096 thiswidth
= SCHARS (desc
);
8097 if (thiswidth
+ i
> width
)
8098 thiswidth
= width
- i
;
8099 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8101 strcpy (menu
+ i
, " = ");
8105 /* Add as much of string as fits. */
8106 thiswidth
= SCHARS (s
);
8107 if (thiswidth
+ i
> width
)
8108 thiswidth
= width
- i
;
8109 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8115 /* If this element does not fit, end the line now,
8116 and save the element for the next line. */
8117 strcpy (menu
+ i
, "...");
8122 /* Move past this element. */
8123 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8124 /* Handle reaching end of dense table. */
8129 rest
= Fcdr_safe (rest
);
8133 /* Prompt with that and read response. */
8134 message2_nolog (menu
, strlen (menu
),
8135 ! NILP (current_buffer
->enable_multibyte_characters
));
8137 /* Make believe its not a keyboard macro in case the help char
8138 is pressed. Help characters are not recorded because menu prompting
8139 is not used on replay.
8141 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8142 current_kboard
->defining_kbd_macro
= Qnil
;
8144 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8145 while (BUFFERP (obj
));
8146 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8148 if (!INTEGERP (obj
))
8153 if (! EQ (obj
, menu_prompt_more_char
)
8154 && (!INTEGERP (menu_prompt_more_char
)
8155 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8157 if (!NILP (current_kboard
->defining_kbd_macro
))
8158 store_kbd_macro_char (obj
);
8161 /* Help char - go round again */
8165 /* Reading key sequences. */
8167 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8168 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8169 keymap, or nil otherwise. Return the index of the first keymap in
8170 which KEY has any binding, or NMAPS if no map has a binding.
8172 If KEY is a meta ASCII character, treat it like meta-prefix-char
8173 followed by the corresponding non-meta character. Keymaps in
8174 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8177 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8180 NEXT may be the same array as CURRENT. */
8183 follow_key (key
, nmaps
, current
, defs
, next
)
8185 Lisp_Object
*current
, *defs
, *next
;
8188 int i
, first_binding
;
8191 first_binding
= nmaps
;
8192 for (i
= nmaps
- 1; i
>= 0; i
--)
8194 if (! NILP (current
[i
]))
8202 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
8203 if (! NILP (defs
[i
]))
8210 /* Given the set of bindings we've found, produce the next set of maps. */
8211 if (first_binding
< nmaps
)
8212 for (i
= 0; i
< nmaps
; i
++)
8213 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8215 return first_binding
;
8218 /* Structure used to keep track of partial application of key remapping
8219 such as Vfunction_key_map and Vkey_translation_map. */
8220 typedef struct keyremap
8227 /* Read a sequence of keys that ends with a non prefix character,
8228 storing it in KEYBUF, a buffer of size BUFSIZE.
8230 Return the length of the key sequence stored.
8231 Return -1 if the user rejected a command menu.
8233 Echo starting immediately unless `prompt' is 0.
8235 Where a key sequence ends depends on the currently active keymaps.
8236 These include any minor mode keymaps active in the current buffer,
8237 the current buffer's local map, and the global map.
8239 If a key sequence has no other bindings, we check Vfunction_key_map
8240 to see if some trailing subsequence might be the beginning of a
8241 function key's sequence. If so, we try to read the whole function
8242 key, and substitute its symbolic name into the key sequence.
8244 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8245 `double-' events into similar click events, if that would make them
8246 bound. We try to turn `triple-' events first into `double-' events,
8249 If we get a mouse click in a mode line, vertical divider, or other
8250 non-text area, we treat the click as if it were prefixed by the
8251 symbol denoting that area - `mode-line', `vertical-line', or
8254 If the sequence starts with a mouse click, we read the key sequence
8255 with respect to the buffer clicked on, not the current buffer.
8257 If the user switches frames in the midst of a key sequence, we put
8258 off the switch-frame event until later; the next call to
8259 read_char will return it.
8261 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8262 from the selected window's buffer. */
8265 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8266 can_return_switch_frame
, fix_current_buffer
)
8267 Lisp_Object
*keybuf
;
8270 int dont_downcase_last
;
8271 int can_return_switch_frame
;
8272 int fix_current_buffer
;
8274 volatile Lisp_Object from_string
;
8275 volatile int count
= SPECPDL_INDEX ();
8277 /* How many keys there are in the current key sequence. */
8280 /* The length of the echo buffer when we started reading, and
8281 the length of this_command_keys when we started reading. */
8282 volatile int echo_start
;
8283 volatile int keys_start
;
8285 /* The number of keymaps we're scanning right now, and the number of
8286 keymaps we have allocated space for. */
8288 volatile int nmaps_allocated
= 0;
8290 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8291 the current keymaps. */
8292 Lisp_Object
*volatile defs
= NULL
;
8294 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8295 in the current keymaps, or nil where it is not a prefix. */
8296 Lisp_Object
*volatile submaps
= NULL
;
8298 /* The local map to start out with at start of key sequence. */
8299 volatile Lisp_Object orig_local_map
;
8301 /* The map from the `keymap' property to start out with at start of
8303 volatile Lisp_Object orig_keymap
;
8305 /* 1 if we have already considered switching to the local-map property
8306 of the place where a mouse click occurred. */
8307 volatile int localized_local_map
= 0;
8309 /* The index in defs[] of the first keymap that has a binding for
8310 this key sequence. In other words, the lowest i such that
8311 defs[i] is non-nil. */
8312 volatile int first_binding
;
8313 /* Index of the first key that has no binding.
8314 It is useless to try fkey.start larger than that. */
8315 volatile int first_unbound
;
8317 /* If t < mock_input, then KEYBUF[t] should be read as the next
8320 We use this to recover after recognizing a function key. Once we
8321 realize that a suffix of the current key sequence is actually a
8322 function key's escape sequence, we replace the suffix with the
8323 function key's binding from Vfunction_key_map. Now keybuf
8324 contains a new and different key sequence, so the echo area,
8325 this_command_keys, and the submaps and defs arrays are wrong. In
8326 this situation, we set mock_input to t, set t to 0, and jump to
8327 restart_sequence; the loop will read keys from keybuf up until
8328 mock_input, thus rebuilding the state; and then it will resume
8329 reading characters from the keyboard. */
8330 volatile int mock_input
= 0;
8332 /* If the sequence is unbound in submaps[], then
8333 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8334 and fkey.map is its binding.
8336 These might be > t, indicating that all function key scanning
8337 should hold off until t reaches them. We do this when we've just
8338 recognized a function key, to avoid searching for the function
8339 key's again in Vfunction_key_map. */
8340 volatile keyremap fkey
;
8342 /* Likewise, for key_translation_map. */
8343 volatile keyremap keytran
;
8345 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8346 we put it off for later. While we're reading, we keep the event here. */
8347 volatile Lisp_Object delayed_switch_frame
;
8349 /* See the comment below... */
8350 #if defined (GOBBLE_FIRST_EVENT)
8351 Lisp_Object first_event
;
8354 volatile Lisp_Object original_uppercase
;
8355 volatile int original_uppercase_position
= -1;
8357 /* Gets around Microsoft compiler limitations. */
8360 struct buffer
*starting_buffer
;
8362 /* List of events for which a fake prefix key has been generated. */
8363 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8365 #if defined (GOBBLE_FIRST_EVENT)
8369 struct gcpro gcpro1
;
8371 GCPRO1 (fake_prefixed_keys
);
8372 raw_keybuf_count
= 0;
8374 last_nonmenu_event
= Qnil
;
8376 delayed_switch_frame
= Qnil
;
8377 fkey
.map
= Vfunction_key_map
;
8378 keytran
.map
= Vkey_translation_map
;
8379 /* If there is no translation-map, turn off scanning. */
8380 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8381 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8386 echo_prompt (prompt
);
8387 else if (cursor_in_echo_area
8388 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8389 && NILP (Fzerop (Vecho_keystrokes
)))
8390 /* This doesn't put in a dash if the echo buffer is empty, so
8391 you don't always see a dash hanging out in the minibuffer. */
8395 /* Record the initial state of the echo area and this_command_keys;
8396 we will need to restore them if we replay a key sequence. */
8398 echo_start
= echo_length ();
8399 keys_start
= this_command_key_count
;
8400 this_single_command_key_start
= keys_start
;
8402 #if defined (GOBBLE_FIRST_EVENT)
8403 /* This doesn't quite work, because some of the things that read_char
8404 does cannot safely be bypassed. It seems too risky to try to make
8407 /* Read the first char of the sequence specially, before setting
8408 up any keymaps, in case a filter runs and switches buffers on us. */
8409 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8411 #endif /* GOBBLE_FIRST_EVENT */
8413 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8414 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8417 /* We jump here when the key sequence has been thoroughly changed, and
8418 we need to rescan it starting from the beginning. When we jump here,
8419 keybuf[0..mock_input] holds the sequence we should reread. */
8422 starting_buffer
= current_buffer
;
8423 first_unbound
= bufsize
+ 1;
8425 /* Build our list of keymaps.
8426 If we recognize a function key and replace its escape sequence in
8427 keybuf with its symbol, or if the sequence starts with a mouse
8428 click and we need to switch buffers, we jump back here to rebuild
8429 the initial keymaps from the current buffer. */
8432 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8433 || !NILP (Voverriding_local_map
))
8435 if (3 > nmaps_allocated
)
8437 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8438 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8439 nmaps_allocated
= 3;
8441 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8442 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8443 if (!NILP (Voverriding_local_map
))
8444 submaps
[nmaps
++] = Voverriding_local_map
;
8452 nminor
= current_minor_maps (0, &maps
);
8453 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8455 if (total
> nmaps_allocated
)
8457 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8458 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8459 nmaps_allocated
= total
;
8462 if (!NILP (orig_keymap
))
8463 submaps
[nmaps
++] = orig_keymap
;
8465 bcopy (maps
, (void *) (submaps
+ nmaps
),
8466 nminor
* sizeof (submaps
[0]));
8470 submaps
[nmaps
++] = orig_local_map
;
8472 submaps
[nmaps
++] = current_global_map
;
8474 /* Find an accurate initial value for first_binding. */
8475 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8476 if (! NILP (submaps
[first_binding
]))
8479 /* Start from the beginning in keybuf. */
8482 /* These are no-ops the first time through, but if we restart, they
8483 revert the echo area and this_command_keys to their original state. */
8484 this_command_key_count
= keys_start
;
8485 if (INTERACTIVE
&& t
< mock_input
)
8486 echo_truncate (echo_start
);
8488 /* If the best binding for the current key sequence is a keymap, or
8489 we may be looking at a function key's escape sequence, keep on
8491 while (first_binding
< nmaps
8492 /* Keep reading as long as there's a prefix binding. */
8493 ? !NILP (submaps
[first_binding
])
8494 /* Don't return in the middle of a possible function key sequence,
8495 if the only bindings we found were via case conversion.
8496 Thus, if ESC O a has a function-key-map translation
8497 and ESC o has a binding, don't return after ESC O,
8498 so that we can translate ESC O plus the next character. */
8499 : (fkey
.start
< t
|| keytran
.start
< t
))
8502 int used_mouse_menu
= 0;
8504 /* Where the last real key started. If we need to throw away a
8505 key that has expanded into more than one element of keybuf
8506 (say, a mouse click on the mode line which is being treated
8507 as [mode-line (mouse-...)], then we backtrack to this point
8509 volatile int last_real_key_start
;
8511 /* These variables are analogous to echo_start and keys_start;
8512 while those allow us to restart the entire key sequence,
8513 echo_local_start and keys_local_start allow us to throw away
8515 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8517 /* key-translation-map is applied *after* function-key-map. */
8518 eassert (keytran
.end
<= fkey
.start
);
8520 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8521 { /* The prefix upto first_unbound has no binding and has
8522 no translation left to do either, so we know it's unbound.
8523 If we don't stop now, we risk staying here indefinitely
8524 (if the user keeps entering fkey or keytran prefixes
8525 like C-c ESC ESC ESC ESC ...) */
8527 for (i
= first_unbound
+ 1; i
< t
; i
++)
8528 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8529 mock_input
= t
- first_unbound
- 1;
8530 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8531 fkey
.map
= Vfunction_key_map
;
8532 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8533 keytran
.map
= Vkey_translation_map
;
8534 goto replay_sequence
;
8538 error ("Key sequence too long");
8541 echo_local_start
= echo_length ();
8542 keys_local_start
= this_command_key_count
;
8543 local_first_binding
= first_binding
;
8546 /* These are no-ops, unless we throw away a keystroke below and
8547 jumped back up to replay_key; in that case, these restore the
8548 variables to their original state, allowing us to replay the
8550 if (INTERACTIVE
&& t
< mock_input
)
8551 echo_truncate (echo_local_start
);
8552 this_command_key_count
= keys_local_start
;
8553 first_binding
= local_first_binding
;
8555 /* By default, assume each event is "real". */
8556 last_real_key_start
= t
;
8558 /* Does mock_input indicate that we are re-reading a key sequence? */
8562 add_command_key (key
);
8563 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8564 && NILP (Fzerop (Vecho_keystrokes
)))
8568 /* If not, we should actually read a character. */
8573 KBOARD
*interrupted_kboard
= current_kboard
;
8574 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8575 if (setjmp (wrong_kboard_jmpbuf
))
8577 if (!NILP (delayed_switch_frame
))
8579 interrupted_kboard
->kbd_queue
8580 = Fcons (delayed_switch_frame
,
8581 interrupted_kboard
->kbd_queue
);
8582 delayed_switch_frame
= Qnil
;
8585 interrupted_kboard
->kbd_queue
8586 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8588 /* If the side queue is non-empty, ensure it begins with a
8589 switch-frame, so we'll replay it in the right context. */
8590 if (CONSP (interrupted_kboard
->kbd_queue
)
8591 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8592 !(EVENT_HAS_PARAMETERS (key
)
8593 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8597 XSETFRAME (frame
, interrupted_frame
);
8598 interrupted_kboard
->kbd_queue
8599 = Fcons (make_lispy_switch_frame (frame
),
8600 interrupted_kboard
->kbd_queue
);
8603 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8604 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8605 goto replay_sequence
;
8608 key
= read_char (NILP (prompt
), nmaps
,
8609 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8613 /* read_char returns t when it shows a menu and the user rejects it.
8617 unbind_to (count
, Qnil
);
8622 /* read_char returns -1 at the end of a macro.
8623 Emacs 18 handles this by returning immediately with a
8624 zero, so that's what we'll do. */
8625 if (INTEGERP (key
) && XINT (key
) == -1)
8628 /* The Microsoft C compiler can't handle the goto that
8634 /* If the current buffer has been changed from under us, the
8635 keymap may have changed, so replay the sequence. */
8638 EMACS_TIME initial_idleness_start_time
;
8639 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8640 EMACS_SECS (timer_last_idleness_start_time
),
8641 EMACS_USECS (timer_last_idleness_start_time
));
8643 /* Resume idle state, using the same start-time as before. */
8644 timer_start_idle ();
8645 timer_idleness_start_time
= initial_idleness_start_time
;
8648 /* Reset the current buffer from the selected window
8649 in case something changed the former and not the latter.
8650 This is to be more consistent with the behavior
8651 of the command_loop_1. */
8652 if (fix_current_buffer
)
8654 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8656 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8657 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8660 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8661 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8662 goto replay_sequence
;
8665 /* If we have a quit that was typed in another frame, and
8666 quit_throw_to_read_char switched buffers,
8667 replay to get the right keymap. */
8669 && XINT (key
) == quit_char
8670 && current_buffer
!= starting_buffer
)
8673 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8677 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8678 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8679 goto replay_sequence
;
8684 if (EVENT_HAS_PARAMETERS (key
)
8685 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8687 /* If we're at the beginning of a key sequence, and the caller
8688 says it's okay, go ahead and return this event. If we're
8689 in the midst of a key sequence, delay it until the end. */
8690 if (t
> 0 || !can_return_switch_frame
)
8692 delayed_switch_frame
= key
;
8698 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8701 /* Clicks in non-text areas get prefixed by the symbol
8702 in their CHAR-ADDRESS field. For example, a click on
8703 the mode line is prefixed by the symbol `mode-line'.
8705 Furthermore, key sequences beginning with mouse clicks
8706 are read using the keymaps of the buffer clicked on, not
8707 the current buffer. So we may have to switch the buffer
8710 When we turn one event into two events, we must make sure
8711 that neither of the two looks like the original--so that,
8712 if we replay the events, they won't be expanded again.
8713 If not for this, such reexpansion could happen either here
8714 or when user programs play with this-command-keys. */
8715 if (EVENT_HAS_PARAMETERS (key
))
8719 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8720 if (EQ (kind
, Qmouse_click
))
8722 Lisp_Object window
, posn
;
8724 window
= POSN_WINDOW (EVENT_START (key
));
8725 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8728 || (!NILP (fake_prefixed_keys
)
8729 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8731 /* We're looking a second time at an event for which
8732 we generated a fake prefix key. Set
8733 last_real_key_start appropriately. */
8735 last_real_key_start
= t
- 1;
8738 /* Key sequences beginning with mouse clicks are
8739 read using the keymaps in the buffer clicked on,
8740 not the current buffer. If we're at the
8741 beginning of a key sequence, switch buffers. */
8742 if (last_real_key_start
== 0
8744 && BUFFERP (XWINDOW (window
)->buffer
)
8745 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8747 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8751 /* Arrange to go back to the original buffer once we're
8752 done reading the key sequence. Note that we can't
8753 use save_excursion_{save,restore} here, because they
8754 save point as well as the current buffer; we don't
8755 want to save point, because redisplay may change it,
8756 to accommodate a Fset_window_start or something. We
8757 don't want to do this at the top of the function,
8758 because we may get input from a subprocess which
8759 wants to change the selected window and stuff (say,
8761 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8763 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8765 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8766 orig_local_map
= get_local_map (PT
, current_buffer
,
8768 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8769 goto replay_sequence
;
8772 /* For a mouse click, get the local text-property keymap
8773 of the place clicked on, rather than point. */
8774 if (last_real_key_start
== 0
8775 && CONSP (XCDR (key
))
8776 && ! localized_local_map
)
8778 Lisp_Object map_here
, start
, pos
;
8780 localized_local_map
= 1;
8781 start
= EVENT_START (key
);
8783 if (CONSP (start
) && CONSP (XCDR (start
)))
8785 pos
= POSN_BUFFER_POSN (start
);
8787 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8789 map_here
= get_local_map (XINT (pos
),
8790 current_buffer
, Qlocal_map
);
8791 if (!EQ (map_here
, orig_local_map
))
8793 orig_local_map
= map_here
;
8797 goto replay_sequence
;
8799 map_here
= get_local_map (XINT (pos
),
8800 current_buffer
, Qkeymap
);
8801 if (!EQ (map_here
, orig_keymap
))
8803 orig_keymap
= map_here
;
8807 goto replay_sequence
;
8813 /* Expand mode-line and scroll-bar events into two events:
8814 use posn as a fake prefix key. */
8816 && (NILP (fake_prefixed_keys
)
8817 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8819 if (t
+ 1 >= bufsize
)
8820 error ("Key sequence too long");
8823 keybuf
[t
+ 1] = key
;
8826 /* Record that a fake prefix key has been generated
8827 for KEY. Don't modify the event; this would
8828 prevent proper action when the event is pushed
8829 back into unread-command-events. */
8830 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8832 /* If on a mode line string with a local keymap,
8833 reconsider the key sequence with that keymap. */
8834 if (CONSP (POSN_STRING (EVENT_START (key
))))
8836 Lisp_Object string
, pos
, map
, map2
;
8838 string
= POSN_STRING (EVENT_START (key
));
8839 pos
= XCDR (string
);
8840 string
= XCAR (string
);
8842 && XINT (pos
) < SCHARS (string
))
8844 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8846 orig_local_map
= map
;
8847 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8850 if (!NILP (map
) || !NILP (map2
))
8851 goto replay_sequence
;
8857 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8858 && NILP (from_string
))
8860 /* For a click on a string, i.e. overlay string or a
8861 string displayed via the `display' property,
8862 consider `local-map' and `keymap' properties of
8864 Lisp_Object string
, pos
, map
, map2
;
8866 string
= POSN_STRING (EVENT_START (key
));
8867 pos
= XCDR (string
);
8868 string
= XCAR (string
);
8870 && XINT (pos
) < SCHARS (string
))
8872 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8874 orig_local_map
= map
;
8875 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8879 if (!NILP (map
) || !NILP (map2
))
8881 from_string
= string
;
8882 goto replay_sequence
;
8887 else if (CONSP (XCDR (key
))
8888 && CONSP (EVENT_START (key
))
8889 && CONSP (XCDR (EVENT_START (key
))))
8893 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8894 /* Handle menu-bar events:
8895 insert the dummy prefix event `menu-bar'. */
8896 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8898 if (t
+ 1 >= bufsize
)
8899 error ("Key sequence too long");
8903 /* Zap the position in key, so we know that we've
8904 expanded it, and don't try to do so again. */
8905 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8906 Fcons (posn
, Qnil
));
8909 goto replay_sequence
;
8911 else if (CONSP (posn
))
8913 /* We're looking at the second event of a
8914 sequence which we expanded before. Set
8915 last_real_key_start appropriately. */
8916 if (last_real_key_start
== t
&& t
> 0)
8917 last_real_key_start
= t
- 1;
8922 /* We have finally decided that KEY is something we might want
8924 first_binding
= (follow_key (key
,
8925 nmaps
- first_binding
,
8926 submaps
+ first_binding
,
8927 defs
+ first_binding
,
8928 submaps
+ first_binding
)
8931 /* If KEY wasn't bound, we'll try some fallbacks. */
8932 if (first_binding
< nmaps
)
8933 /* This is needed for the following scenario:
8934 event 0: a down-event that gets dropped by calling replay_key.
8935 event 1: some normal prefix like C-h.
8936 After event 0, first_unbound is 0, after event 1 fkey.start
8937 and keytran.start are both 1, so when we see that C-h is bound,
8938 we need to update first_unbound. */
8939 first_unbound
= max (t
+ 1, first_unbound
);
8944 /* Remember the position to put an upper bound on fkey.start. */
8945 first_unbound
= min (t
, first_unbound
);
8947 head
= EVENT_HEAD (key
);
8948 if (help_char_p (head
) && t
> 0)
8950 read_key_sequence_cmd
= Vprefix_help_command
;
8952 last_nonmenu_event
= key
;
8953 /* The Microsoft C compiler can't handle the goto that
8961 Lisp_Object breakdown
;
8964 breakdown
= parse_modifiers (head
);
8965 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8966 /* Attempt to reduce an unbound mouse event to a simpler
8967 event that is bound:
8968 Drags reduce to clicks.
8969 Double-clicks reduce to clicks.
8970 Triple-clicks reduce to double-clicks, then to clicks.
8971 Down-clicks are eliminated.
8972 Double-downs reduce to downs, then are eliminated.
8973 Triple-downs reduce to double-downs, then to downs,
8974 then are eliminated. */
8975 if (modifiers
& (down_modifier
| drag_modifier
8976 | double_modifier
| triple_modifier
))
8978 while (modifiers
& (down_modifier
| drag_modifier
8979 | double_modifier
| triple_modifier
))
8981 Lisp_Object new_head
, new_click
;
8982 if (modifiers
& triple_modifier
)
8983 modifiers
^= (double_modifier
| triple_modifier
);
8984 else if (modifiers
& double_modifier
)
8985 modifiers
&= ~double_modifier
;
8986 else if (modifiers
& drag_modifier
)
8987 modifiers
&= ~drag_modifier
;
8990 /* Dispose of this `down' event by simply jumping
8991 back to replay_key, to get another event.
8993 Note that if this event came from mock input,
8994 then just jumping back to replay_key will just
8995 hand it to us again. So we have to wipe out any
8998 We could delete keybuf[t] and shift everything
8999 after that to the left by one spot, but we'd also
9000 have to fix up any variable that points into
9001 keybuf, and shifting isn't really necessary
9004 Adding prefixes for non-textual mouse clicks
9005 creates two characters of mock input, and both
9006 must be thrown away. If we're only looking at
9007 the prefix now, we can just jump back to
9008 replay_key. On the other hand, if we've already
9009 processed the prefix, and now the actual click
9010 itself is giving us trouble, then we've lost the
9011 state of the keymaps we want to backtrack to, and
9012 we need to replay the whole sequence to rebuild
9015 Beyond that, only function key expansion could
9016 create more than two keys, but that should never
9017 generate mouse events, so it's okay to zero
9018 mock_input in that case too.
9020 FIXME: The above paragraph seems just plain
9021 wrong, if you consider things like
9022 xterm-mouse-mode. -stef
9024 Isn't this just the most wonderful code ever? */
9025 if (t
== last_real_key_start
)
9032 mock_input
= last_real_key_start
;
9033 goto replay_sequence
;
9038 = apply_modifiers (modifiers
, XCAR (breakdown
));
9040 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9042 /* Look for a binding for this new key. follow_key
9043 promises that it didn't munge submaps the
9044 last time we called it, since key was unbound. */
9046 = (follow_key (new_click
,
9047 nmaps
- local_first_binding
,
9048 submaps
+ local_first_binding
,
9049 defs
+ local_first_binding
,
9050 submaps
+ local_first_binding
)
9051 + local_first_binding
);
9053 /* If that click is bound, go for it. */
9054 if (first_binding
< nmaps
)
9059 /* Otherwise, we'll leave key set to the drag event. */
9066 /* Normally, last_nonmenu_event gets the previous key we read.
9067 But when a mouse popup menu is being used,
9068 we don't update last_nonmenu_event; it continues to hold the mouse
9069 event that preceded the first level of menu. */
9070 if (!used_mouse_menu
)
9071 last_nonmenu_event
= key
;
9073 /* Record what part of this_command_keys is the current key sequence. */
9074 this_single_command_key_start
= this_command_key_count
- t
;
9076 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9077 /* There is a binding and it's not a prefix.
9078 There is thus no function-key in this sequence.
9079 Moving fkey.start is important in this case to allow keytran.start
9080 to go over the sequence before we return (since we keep the
9081 invariant that keytran.end <= fkey.start). */
9084 (fkey
.start
= fkey
.end
= t
, fkey
.map
= Vfunction_key_map
);
9087 /* If the sequence is unbound, see if we can hang a function key
9088 off the end of it. */
9092 /* Continue scan from fkey.end until we find a bound suffix.
9093 If we fail, increment fkey.start and start over from there. */
9094 while (fkey
.end
< t
)
9098 key
= keybuf
[fkey
.end
++];
9099 next
= access_keymap (fkey
.map
, key
, 1, 0, 1);
9101 /* Handle symbol with autoload definition. */
9102 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9103 && CONSP (XSYMBOL (next
)->function
)
9104 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9105 do_autoload (XSYMBOL (next
)->function
, next
);
9107 /* Handle a symbol whose function definition is a keymap
9109 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9110 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9111 || KEYMAPP (XSYMBOL (next
)->function
)))
9112 next
= XSYMBOL (next
)->function
;
9114 #if 0 /* I didn't turn this on, because it might cause trouble
9115 for the mapping of return into C-m and tab into C-i. */
9116 /* Optionally don't map function keys into other things.
9117 This enables the user to redefine kp- keys easily. */
9118 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
9122 /* If the function key map gives a function, not an
9123 array, then call the function with no args and use
9124 its value instead. */
9125 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9126 /* If there's a binding (i.e. first_binding >= nmaps)
9127 we don't want to apply this function-key-mapping. */
9128 && fkey
.end
== t
&& first_binding
>= nmaps
)
9130 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9134 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9135 next
= call1 (next
, prompt
);
9137 /* If the function returned something invalid,
9138 barf--don't ignore it.
9139 (To ignore it safely, we would need to gcpro a bunch of
9140 other variables.) */
9141 if (! (VECTORP (next
) || STRINGP (next
)))
9142 error ("Function in key-translation-map returns invalid key sequence");
9145 /* If keybuf[fkey.start..fkey.end] is bound in the
9146 function key map and it's a suffix of the current
9147 sequence (i.e. fkey.end == t), replace it with
9148 the binding and restart with fkey.start at the end. */
9149 if ((VECTORP (next
) || STRINGP (next
))
9150 /* If there's a binding (i.e. first_binding >= nmaps)
9151 we don't want to apply this function-key-mapping. */
9152 && fkey
.end
== t
&& first_binding
>= nmaps
)
9154 int len
= XFASTINT (Flength (next
));
9156 t
= fkey
.start
+ len
;
9158 error ("Key sequence too long");
9161 bcopy (XVECTOR (next
)->contents
,
9162 keybuf
+ fkey
.start
,
9163 (t
- fkey
.start
) * sizeof (keybuf
[0]));
9164 else if (STRINGP (next
))
9168 for (i
= 0; i
< len
; i
++)
9169 XSETFASTINT (keybuf
[fkey
.start
+ i
], SREF (next
, i
));
9173 fkey
.start
= fkey
.end
= t
;
9174 fkey
.map
= Vfunction_key_map
;
9176 /* Do pass the results through key-translation-map.
9177 But don't retranslate what key-translation-map
9178 has already translated. */
9179 keytran
.end
= keytran
.start
;
9180 keytran
.map
= Vkey_translation_map
;
9182 goto replay_sequence
;
9185 fkey
.map
= get_keymap (next
, 0, 1);
9187 /* If we no longer have a bound suffix, try a new positions for
9189 if (!CONSP (fkey
.map
))
9191 fkey
.end
= ++fkey
.start
;
9192 fkey
.map
= Vfunction_key_map
;
9197 /* Look for this sequence in key-translation-map. */
9201 /* Scan from keytran.end until we find a bound suffix. */
9202 while (keytran
.end
< fkey
.start
)
9206 key
= keybuf
[keytran
.end
++];
9207 next
= access_keymap (keytran
.map
, key
, 1, 0, 1);
9209 /* Handle symbol with autoload definition. */
9210 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9211 && CONSP (XSYMBOL (next
)->function
)
9212 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9213 do_autoload (XSYMBOL (next
)->function
, next
);
9215 /* Handle a symbol whose function definition is a keymap
9217 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9218 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9219 || KEYMAPP (XSYMBOL (next
)->function
)))
9220 next
= XSYMBOL (next
)->function
;
9222 /* If the key translation map gives a function, not an
9223 array, then call the function with one arg and use
9224 its value instead. */
9225 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
)))
9227 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9231 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9232 next
= call1 (next
, prompt
);
9234 /* If the function returned something invalid,
9235 barf--don't ignore it.
9236 (To ignore it safely, we would need to gcpro a bunch of
9237 other variables.) */
9238 if (! (VECTORP (next
) || STRINGP (next
)))
9239 error ("Function in key-translation-map returns invalid key sequence");
9242 /* If keybuf[keytran.start..keytran.end] is bound in the
9243 key translation map and it's a suffix of the current
9244 sequence (i.e. keytran.end == t), replace it with
9245 the binding and restart with keytran.start at the end. */
9246 if ((VECTORP (next
) || STRINGP (next
)))
9248 int len
= XFASTINT (Flength (next
));
9249 int i
, diff
= len
- (keytran
.end
- keytran
.start
);
9251 mock_input
= max (t
, mock_input
);
9252 if (mock_input
+ diff
>= bufsize
)
9253 error ("Key sequence too long");
9255 /* Shift the keys that are after keytran.end. */
9257 for (i
= keytran
.end
; i
< mock_input
; i
++)
9258 keybuf
[i
+ diff
] = keybuf
[i
];
9260 for (i
= mock_input
- 1; i
>= keytran
.end
; i
--)
9261 keybuf
[i
+ diff
] = keybuf
[i
];
9262 /* Replace the keys between keytran.start and keytran.end
9263 with those from next. */
9264 for (i
= 0; i
< len
; i
++)
9265 keybuf
[keytran
.start
+ i
]
9266 = Faref (next
, make_number (i
));
9269 keytran
.start
= keytran
.end
+= diff
;
9270 keytran
.map
= Vkey_translation_map
;
9272 /* Adjust the function-key-map counters. */
9276 goto replay_sequence
;
9279 keytran
.map
= get_keymap (next
, 0, 1);
9281 /* If we no longer have a bound suffix, try a new positions for
9283 if (!CONSP (keytran
.map
))
9285 keytran
.end
= ++keytran
.start
;
9286 keytran
.map
= Vkey_translation_map
;
9291 /* If KEY is not defined in any of the keymaps,
9292 and cannot be part of a function key or translation,
9293 and is an upper case letter
9294 use the corresponding lower-case letter instead. */
9295 if (first_binding
>= nmaps
9296 && fkey
.start
>= t
&& keytran
.start
>= t
9298 && ((((XINT (key
) & 0x3ffff)
9299 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9300 && UPPERCASEP (XINT (key
) & 0x3ffff))
9301 || (XINT (key
) & shift_modifier
)))
9303 Lisp_Object new_key
;
9305 original_uppercase
= key
;
9306 original_uppercase_position
= t
- 1;
9308 if (XINT (key
) & shift_modifier
)
9309 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9311 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9312 | (XINT (key
) & ~0x3ffff)));
9314 /* We have to do this unconditionally, regardless of whether
9315 the lower-case char is defined in the keymaps, because they
9316 might get translated through function-key-map. */
9317 keybuf
[t
- 1] = new_key
;
9318 mock_input
= max (t
, mock_input
);
9320 goto replay_sequence
;
9322 /* If KEY is not defined in any of the keymaps,
9323 and cannot be part of a function key or translation,
9324 and is a shifted function key,
9325 use the corresponding unshifted function key instead. */
9326 if (first_binding
>= nmaps
9327 && fkey
.start
>= t
&& keytran
.start
>= t
9330 Lisp_Object breakdown
;
9333 breakdown
= parse_modifiers (key
);
9334 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9335 if (modifiers
& shift_modifier
)
9337 Lisp_Object new_key
;
9339 original_uppercase
= key
;
9340 original_uppercase_position
= t
- 1;
9342 modifiers
&= ~shift_modifier
;
9343 new_key
= apply_modifiers (modifiers
,
9346 keybuf
[t
- 1] = new_key
;
9347 mock_input
= max (t
, mock_input
);
9349 goto replay_sequence
;
9355 read_key_sequence_cmd
= (first_binding
< nmaps
9356 ? defs
[first_binding
]
9359 unread_switch_frame
= delayed_switch_frame
;
9360 unbind_to (count
, Qnil
);
9362 /* Don't downcase the last character if the caller says don't.
9363 Don't downcase it if the result is undefined, either. */
9364 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9365 && t
- 1 == original_uppercase_position
)
9366 keybuf
[t
- 1] = original_uppercase
;
9368 /* Occasionally we fabricate events, perhaps by expanding something
9369 according to function-key-map, or by adding a prefix symbol to a
9370 mouse click in the scroll bar or modeline. In this cases, return
9371 the entire generated key sequence, even if we hit an unbound
9372 prefix or a definition before the end. This means that you will
9373 be able to push back the event properly, and also means that
9374 read-key-sequence will always return a logical unit.
9377 for (; t
< mock_input
; t
++)
9379 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9380 && NILP (Fzerop (Vecho_keystrokes
)))
9381 echo_char (keybuf
[t
]);
9382 add_command_key (keybuf
[t
]);
9391 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9392 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9393 The sequence is sufficient to specify a non-prefix command in the
9394 current local and global maps.
9396 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9397 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9398 as a continuation of the previous key.
9400 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9401 convert the last event to lower case. (Normally any upper case event
9402 is converted to lower case if the original event is undefined and the lower
9403 case equivalent is defined.) A non-nil value is appropriate for reading
9404 a key sequence to be defined.
9406 A C-g typed while in this function is treated like any other character,
9407 and `quit-flag' is not set.
9409 If the key sequence starts with a mouse click, then the sequence is read
9410 using the keymaps of the buffer of the window clicked in, not the buffer
9411 of the selected window as normal.
9413 `read-key-sequence' drops unbound button-down events, since you normally
9414 only care about the click or drag events which follow them. If a drag
9415 or multi-click event is unbound, but the corresponding click event would
9416 be bound, `read-key-sequence' turns the event into a click event at the
9417 drag's starting position. This means that you don't have to distinguish
9418 between click and drag, double, or triple events unless you want to.
9420 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9421 lines separating windows, and scroll bars with imaginary keys
9422 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9424 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9425 function will process a switch-frame event if the user switches frames
9426 before typing anything. If the user switches frames in the middle of a
9427 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9428 is nil, then the event will be put off until after the current key sequence.
9430 `read-key-sequence' checks `function-key-map' for function key
9431 sequences, where they wouldn't conflict with ordinary bindings. See
9432 `function-key-map' for more details.
9434 The optional fifth argument COMMAND-LOOP, if non-nil, means
9435 that this key sequence is being read by something that will
9436 read commands one after another. It should be nil if the caller
9437 will read just one key sequence. */)
9438 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9440 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9441 Lisp_Object can_return_switch_frame
, command_loop
;
9443 Lisp_Object keybuf
[30];
9445 struct gcpro gcpro1
;
9446 int count
= SPECPDL_INDEX ();
9449 CHECK_STRING (prompt
);
9452 specbind (Qinput_method_exit_on_first_char
,
9453 (NILP (command_loop
) ? Qt
: Qnil
));
9454 specbind (Qinput_method_use_echo_area
,
9455 (NILP (command_loop
) ? Qt
: Qnil
));
9457 bzero (keybuf
, sizeof keybuf
);
9459 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9461 if (NILP (continue_echo
))
9463 this_command_key_count
= 0;
9464 this_command_key_count_reset
= 0;
9465 this_single_command_key_start
= 0;
9468 #ifdef HAVE_X_WINDOWS
9469 if (display_hourglass_p
)
9470 cancel_hourglass ();
9473 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9474 prompt
, ! NILP (dont_downcase_last
),
9475 ! NILP (can_return_switch_frame
), 0);
9477 #if 0 /* The following is fine for code reading a key sequence and
9478 then proceeding with a lenghty computation, but it's not good
9479 for code reading keys in a loop, like an input method. */
9480 #ifdef HAVE_X_WINDOWS
9481 if (display_hourglass_p
)
9492 return unbind_to (count
, make_event_array (i
, keybuf
));
9495 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9496 Sread_key_sequence_vector
, 1, 5, 0,
9497 doc
: /* Like `read-key-sequence' but always return a vector. */)
9498 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9500 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9501 Lisp_Object can_return_switch_frame
, command_loop
;
9503 Lisp_Object keybuf
[30];
9505 struct gcpro gcpro1
;
9506 int count
= SPECPDL_INDEX ();
9509 CHECK_STRING (prompt
);
9512 specbind (Qinput_method_exit_on_first_char
,
9513 (NILP (command_loop
) ? Qt
: Qnil
));
9514 specbind (Qinput_method_use_echo_area
,
9515 (NILP (command_loop
) ? Qt
: Qnil
));
9517 bzero (keybuf
, sizeof keybuf
);
9519 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9521 if (NILP (continue_echo
))
9523 this_command_key_count
= 0;
9524 this_command_key_count_reset
= 0;
9525 this_single_command_key_start
= 0;
9528 #ifdef HAVE_X_WINDOWS
9529 if (display_hourglass_p
)
9530 cancel_hourglass ();
9533 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9534 prompt
, ! NILP (dont_downcase_last
),
9535 ! NILP (can_return_switch_frame
), 0);
9537 #ifdef HAVE_X_WINDOWS
9538 if (display_hourglass_p
)
9548 return unbind_to (count
, Fvector (i
, keybuf
));
9551 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9552 doc
: /* Execute CMD as an editor command.
9553 CMD must be a symbol that satisfies the `commandp' predicate.
9554 Optional second arg RECORD-FLAG non-nil
9555 means unconditionally put this command in `command-history'.
9556 Otherwise, that is done only if an arg is read using the minibuffer.
9557 The argument KEYS specifies the value to use instead of (this-command-keys)
9558 when reading the arguments; if it is nil, (this-command-keys) is used.
9559 The argument SPECIAL, if non-nil, means that this command is executing
9560 a special event, so ignore the prefix argument and don't clear it. */)
9561 (cmd
, record_flag
, keys
, special
)
9562 Lisp_Object cmd
, record_flag
, keys
, special
;
9564 register Lisp_Object final
;
9565 register Lisp_Object tem
;
9566 Lisp_Object prefixarg
;
9567 struct backtrace backtrace
;
9568 extern int debug_on_next_call
;
9570 debug_on_next_call
= 0;
9574 prefixarg
= current_kboard
->Vprefix_arg
;
9575 Vcurrent_prefix_arg
= prefixarg
;
9576 current_kboard
->Vprefix_arg
= Qnil
;
9583 tem
= Fget (cmd
, Qdisabled
);
9584 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9586 tem
= Fsymbol_value (Qdisabled_command_hook
);
9588 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9594 final
= Findirect_function (cmd
);
9596 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9598 struct gcpro gcpro1
, gcpro2
;
9600 GCPRO2 (cmd
, prefixarg
);
9601 do_autoload (final
, cmd
);
9608 if (STRINGP (final
) || VECTORP (final
))
9610 /* If requested, place the macro in the command history. For
9611 other sorts of commands, call-interactively takes care of
9613 if (!NILP (record_flag
))
9616 = Fcons (Fcons (Qexecute_kbd_macro
,
9617 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9620 /* Don't keep command history around forever. */
9621 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9623 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9625 XSETCDR (tem
, Qnil
);
9629 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9632 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9634 backtrace
.next
= backtrace_list
;
9635 backtrace_list
= &backtrace
;
9636 backtrace
.function
= &Qcall_interactively
;
9637 backtrace
.args
= &cmd
;
9638 backtrace
.nargs
= 1;
9639 backtrace
.evalargs
= 0;
9641 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9643 backtrace_list
= backtrace
.next
;
9651 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9653 doc
: /* Read function name, then read its arguments and call it. */)
9655 Lisp_Object prefixarg
;
9657 Lisp_Object function
;
9659 int saved_last_point_position
;
9660 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9661 Lisp_Object bindings
, value
;
9662 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9664 saved_keys
= Fvector (this_command_key_count
,
9665 XVECTOR (this_command_keys
)->contents
);
9666 saved_last_point_position_buffer
= last_point_position_buffer
;
9667 saved_last_point_position
= last_point_position
;
9669 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9671 if (EQ (prefixarg
, Qminus
))
9673 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9674 strcpy (buf
, "C-u ");
9675 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9677 if (sizeof (int) == sizeof (EMACS_INT
))
9678 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9679 else if (sizeof (long) == sizeof (EMACS_INT
))
9680 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9684 else if (INTEGERP (prefixarg
))
9686 if (sizeof (int) == sizeof (EMACS_INT
))
9687 sprintf (buf
, "%d ", XINT (prefixarg
));
9688 else if (sizeof (long) == sizeof (EMACS_INT
))
9689 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9694 /* This isn't strictly correct if execute-extended-command
9695 is bound to anything else. Perhaps it should use
9696 this_command_keys? */
9697 strcat (buf
, "M-x ");
9699 /* Prompt with buf, and then read a string, completing from and
9700 restricting to the set of all defined commands. Don't provide
9701 any initial input. Save the command read on the extended-command
9703 function
= Fcompleting_read (build_string (buf
),
9704 Vobarray
, Qcommandp
,
9705 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9708 if (STRINGP (function
) && SCHARS (function
) == 0)
9709 error ("No command name given");
9711 /* Set this_command_keys to the concatenation of saved_keys and
9712 function, followed by a RET. */
9717 this_command_key_count
= 0;
9718 this_command_key_count_reset
= 0;
9719 this_single_command_key_start
= 0;
9721 keys
= XVECTOR (saved_keys
)->contents
;
9722 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9723 add_command_key (keys
[i
]);
9725 for (i
= 0; i
< SCHARS (function
); i
++)
9726 add_command_key (Faref (function
, make_number (i
)));
9728 add_command_key (make_number ('\015'));
9731 last_point_position
= saved_last_point_position
;
9732 last_point_position_buffer
= saved_last_point_position_buffer
;
9736 function
= Fintern (function
, Qnil
);
9737 current_kboard
->Vprefix_arg
= prefixarg
;
9738 Vthis_command
= function
;
9739 real_this_command
= function
;
9741 /* If enabled, show which key runs this command. */
9742 if (!NILP (Vsuggest_key_bindings
)
9743 && NILP (Vexecuting_macro
)
9744 && SYMBOLP (function
))
9745 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9751 GCPRO2 (bindings
, value
);
9752 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9754 /* If the command has a key binding, print it now. */
9755 if (!NILP (bindings
)
9756 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9759 /* But first wait, and skip the message if there is input. */
9761 if (!NILP (echo_area_buffer
[0]))
9762 /* This command displayed something in the echo area;
9763 so wait a few seconds, then display our suggestion message. */
9764 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9765 ? XINT (Vsuggest_key_bindings
) : 2);
9767 /* This command left the echo area empty,
9768 so display our message immediately. */
9771 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9772 && ! CONSP (Vunread_command_events
))
9774 Lisp_Object binding
;
9776 int message_p
= push_message ();
9777 int count
= SPECPDL_INDEX ();
9779 record_unwind_protect (pop_message_unwind
, Qnil
);
9780 binding
= Fkey_description (bindings
);
9783 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9786 sprintf (newmessage
, "You can run the command `%s' with %s",
9787 SDATA (SYMBOL_NAME (function
)),
9789 message2_nolog (newmessage
,
9790 strlen (newmessage
),
9791 STRING_MULTIBYTE (binding
));
9792 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9793 ? Vsuggest_key_bindings
: make_number (2)),
9798 unbind_to (count
, Qnil
);
9802 RETURN_UNGCPRO (value
);
9806 /* Return nonzero if input events are pending. */
9809 detect_input_pending ()
9812 get_input_pending (&input_pending
, 0);
9814 return input_pending
;
9817 /* Return nonzero if input events are pending, and run any pending timers. */
9820 detect_input_pending_run_timers (do_display
)
9823 int old_timers_run
= timers_run
;
9826 get_input_pending (&input_pending
, 1);
9828 if (old_timers_run
!= timers_run
&& do_display
)
9830 redisplay_preserve_echo_area (8);
9831 /* The following fixes a bug when using lazy-lock with
9832 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9833 from an idle timer function. The symptom of the bug is that
9834 the cursor sometimes doesn't become visible until the next X
9835 event is processed. --gerd. */
9837 rif
->flush_display (NULL
);
9840 return input_pending
;
9843 /* This is called in some cases before a possible quit.
9844 It cases the next call to detect_input_pending to recompute input_pending.
9845 So calling this function unnecessarily can't do any harm. */
9848 clear_input_pending ()
9853 /* Return nonzero if there are pending requeued events.
9854 This isn't used yet. The hope is to make wait_reading_process_input
9855 call it, and return if it runs Lisp code that unreads something.
9856 The problem is, kbd_buffer_get_event needs to be fixed to know what
9857 to do in that case. It isn't trivial. */
9860 requeued_events_pending_p ()
9862 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9866 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9867 doc
: /* Return t if command input is currently available with no wait.
9868 Actually, the value is nil only if we can be sure that no input is available;
9869 if there is a doubt, the value is t. */)
9872 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9875 get_filtered_input_pending (&input_pending
, 1, 1);
9876 return input_pending
> 0 ? Qt
: Qnil
;
9879 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9880 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9883 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9886 if (total_keys
< NUM_RECENT_KEYS
)
9887 return Fvector (total_keys
, keys
);
9890 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9891 bcopy (keys
+ recent_keys_index
,
9892 XVECTOR (val
)->contents
,
9893 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9895 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9896 recent_keys_index
* sizeof (Lisp_Object
));
9901 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9902 doc
: /* Return the key sequence that invoked this command.
9903 However, if the command has called `read-key-sequence', it returns
9904 the last key sequence that has been read.
9905 The value is a string or a vector. */)
9908 return make_event_array (this_command_key_count
,
9909 XVECTOR (this_command_keys
)->contents
);
9912 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9913 doc
: /* Return the key sequence that invoked this command, as a vector.
9914 However, if the command has called `read-key-sequence', it returns
9915 the last key sequence that has been read. */)
9918 return Fvector (this_command_key_count
,
9919 XVECTOR (this_command_keys
)->contents
);
9922 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9923 Sthis_single_command_keys
, 0, 0, 0,
9924 doc
: /* Return the key sequence that invoked this command.
9925 More generally, it returns the last key sequence read, either by
9926 the command loop or by `read-key-sequence'.
9927 Unlike `this-command-keys', this function's value
9928 does not include prefix arguments.
9929 The value is always a vector. */)
9932 return Fvector (this_command_key_count
9933 - this_single_command_key_start
,
9934 (XVECTOR (this_command_keys
)->contents
9935 + this_single_command_key_start
));
9938 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9939 Sthis_single_command_raw_keys
, 0, 0, 0,
9940 doc
: /* Return the raw events that were read for this command.
9941 More generally, it returns the last key sequence read, either by
9942 the command loop or by `read-key-sequence'.
9943 Unlike `this-single-command-keys', this function's value
9944 shows the events before all translations (except for input methods).
9945 The value is always a vector. */)
9948 return Fvector (raw_keybuf_count
,
9949 (XVECTOR (raw_keybuf
)->contents
));
9952 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9953 Sreset_this_command_lengths
, 0, 0, 0,
9954 doc
: /* Make the unread events replace the last command and echo.
9955 Used in `universal-argument-other-key'.
9957 `universal-argument-other-key' rereads the event just typed.
9958 It then gets translated through `function-key-map'.
9959 The translated event has to replace the real events,
9960 both in the value of (this-command-keys) and in echoing.
9961 To achieve this, `universal-argument-other-key' calls
9962 `reset-this-command-lengths', which discards the record of reading
9963 these events the first time. */)
9966 this_command_key_count
= before_command_key_count
;
9967 if (this_command_key_count
< this_single_command_key_start
)
9968 this_single_command_key_start
= this_command_key_count
;
9970 echo_truncate (before_command_echo_length
);
9972 /* Cause whatever we put into unread-command-events
9973 to echo as if it were being freshly read from the keyboard. */
9974 this_command_key_count_reset
= 1;
9979 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9980 Sclear_this_command_keys
, 0, 1, 0,
9981 doc
: /* Clear out the vector that `this-command-keys' returns.
9982 Also clear the record of the last 100 events, unless optional arg
9983 KEEP-RECORD is non-nil. */)
9985 Lisp_Object keep_record
;
9989 this_command_key_count
= 0;
9990 this_command_key_count_reset
= 0;
9992 if (NILP (keep_record
))
9994 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9995 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9997 recent_keys_index
= 0;
10002 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10003 doc
: /* Return the current depth in recursive edits. */)
10007 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10011 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10012 "FOpen dribble file: ",
10013 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10014 If FILE is nil, close any open dribble file. */)
10025 file
= Fexpand_file_name (file
, Qnil
);
10026 dribble
= fopen (SDATA (file
), "w");
10028 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10033 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10034 doc
: /* Discard the contents of the terminal input buffer.
10035 Also end any kbd macro being defined. */)
10038 if (!NILP (current_kboard
->defining_kbd_macro
))
10040 /* Discard the last command from the macro. */
10041 Fcancel_kbd_macro_events ();
10045 update_mode_lines
++;
10047 Vunread_command_events
= Qnil
;
10048 unread_command_char
= -1;
10050 discard_tty_input ();
10052 kbd_fetch_ptr
= kbd_store_ptr
;
10053 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10059 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10060 doc
: /* Stop Emacs and return to superior process. You can resume later.
10061 If `cannot-suspend' is non-nil, or if the system doesn't support job
10062 control, run a subshell instead.
10064 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10065 to be read as terminal input by Emacs's parent, after suspension.
10067 Before suspending, run the normal hook `suspend-hook'.
10068 After resumption run the normal hook `suspend-resume-hook'.
10070 Some operating systems cannot stop the Emacs process and resume it later.
10071 On such systems, Emacs starts a subshell instead of suspending. */)
10073 Lisp_Object stuffstring
;
10075 int count
= SPECPDL_INDEX ();
10076 int old_height
, old_width
;
10078 struct gcpro gcpro1
;
10080 if (!NILP (stuffstring
))
10081 CHECK_STRING (stuffstring
);
10083 /* Run the functions in suspend-hook. */
10084 if (!NILP (Vrun_hooks
))
10085 call1 (Vrun_hooks
, intern ("suspend-hook"));
10087 GCPRO1 (stuffstring
);
10088 get_frame_size (&old_width
, &old_height
);
10089 reset_sys_modes ();
10090 /* sys_suspend can get an error if it tries to fork a subshell
10091 and the system resources aren't available for that. */
10092 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10094 stuff_buffered_input (stuffstring
);
10095 if (cannot_suspend
)
10099 unbind_to (count
, Qnil
);
10101 /* Check if terminal/window size has changed.
10102 Note that this is not useful when we are running directly
10103 with a window system; but suspend should be disabled in that case. */
10104 get_frame_size (&width
, &height
);
10105 if (width
!= old_width
|| height
!= old_height
)
10106 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10108 /* Run suspend-resume-hook. */
10109 if (!NILP (Vrun_hooks
))
10110 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10116 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10117 Then in any case stuff anything Emacs has read ahead and not used. */
10120 stuff_buffered_input (stuffstring
)
10121 Lisp_Object stuffstring
;
10123 /* stuff_char works only in BSD, versions 4.2 and up. */
10126 register unsigned char *p
;
10128 if (STRINGP (stuffstring
))
10130 register int count
;
10132 p
= SDATA (stuffstring
);
10133 count
= SBYTES (stuffstring
);
10134 while (count
-- > 0)
10139 /* Anything we have read ahead, put back for the shell to read. */
10140 /* ?? What should this do when we have multiple keyboards??
10141 Should we ignore anything that was typed in at the "wrong" kboard? */
10142 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10146 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10147 kbd_fetch_ptr
= kbd_buffer
;
10148 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10149 stuff_char (kbd_fetch_ptr
->code
);
10151 kbd_fetch_ptr
->kind
= NO_EVENT
;
10152 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10153 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10154 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10159 #endif /* BSD_SYSTEM and not BSD4_1 */
10163 set_waiting_for_input (time_to_clear
)
10164 EMACS_TIME
*time_to_clear
;
10166 input_available_clear_time
= time_to_clear
;
10168 /* Tell interrupt_signal to throw back to read_char, */
10169 waiting_for_input
= 1;
10171 /* If interrupt_signal was called before and buffered a C-g,
10172 make it run again now, to avoid timing error. */
10173 if (!NILP (Vquit_flag
))
10174 quit_throw_to_read_char ();
10178 clear_waiting_for_input ()
10180 /* Tell interrupt_signal not to throw back to read_char, */
10181 waiting_for_input
= 0;
10182 input_available_clear_time
= 0;
10185 /* This routine is called at interrupt level in response to C-g.
10187 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10188 is called from kbd_buffer_store_event, in handling SIGIO or
10191 If `waiting_for_input' is non zero, then unless `echoing' is
10192 nonzero, immediately throw back to read_char.
10194 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10195 eval to throw, when it gets a chance. If quit-flag is already
10196 non-nil, it stops the job right away. */
10199 interrupt_signal (signalnum
) /* If we don't have an argument, */
10200 int signalnum
; /* some compilers complain in signal calls. */
10203 /* Must preserve main program's value of errno. */
10204 int old_errno
= errno
;
10205 struct frame
*sf
= SELECTED_FRAME ();
10207 #if defined (USG) && !defined (POSIX_SIGNALS)
10208 if (!read_socket_hook
&& NILP (Vwindow_system
))
10210 /* USG systems forget handlers when they are used;
10211 must reestablish each time */
10212 signal (SIGINT
, interrupt_signal
);
10213 signal (SIGQUIT
, interrupt_signal
);
10219 if (!NILP (Vquit_flag
)
10220 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10222 /* If SIGINT isn't blocked, don't let us be interrupted by
10223 another SIGINT, it might be harmful due to non-reentrancy
10224 in I/O functions. */
10225 sigblock (sigmask (SIGINT
));
10228 reset_sys_modes ();
10230 #ifdef SIGTSTP /* Support possible in later USG versions */
10232 * On systems which can suspend the current process and return to the original
10233 * shell, this command causes the user to end up back at the shell.
10234 * The "Auto-save" and "Abort" questions are not asked until
10235 * the user elects to return to emacs, at which point he can save the current
10236 * job and either dump core or continue.
10241 if (sys_suspend () == -1)
10243 printf ("Not running as a subprocess;\n");
10244 printf ("you can continue or abort.\n");
10246 #else /* not VMS */
10247 /* Perhaps should really fork an inferior shell?
10248 But that would not provide any way to get back
10249 to the original shell, ever. */
10250 printf ("No support for stopping a process on this operating system;\n");
10251 printf ("you can continue or abort.\n");
10252 #endif /* not VMS */
10253 #endif /* not SIGTSTP */
10255 /* We must remain inside the screen area when the internal terminal
10256 is used. Note that [Enter] is not echoed by dos. */
10259 /* It doesn't work to autosave while GC is in progress;
10260 the code used for auto-saving doesn't cope with the mark bit. */
10261 if (!gc_in_progress
)
10263 printf ("Auto-save? (y or n) ");
10265 if (((c
= getchar ()) & ~040) == 'Y')
10267 Fdo_auto_save (Qt
, Qnil
);
10269 printf ("\r\nAuto-save done");
10270 #else /* not MSDOS */
10271 printf ("Auto-save done\n");
10272 #endif /* not MSDOS */
10274 while (c
!= '\n') c
= getchar ();
10278 /* During GC, it must be safe to reenable quitting again. */
10279 Vinhibit_quit
= Qnil
;
10282 #endif /* not MSDOS */
10283 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10284 printf ("but will instead do a real quit after garbage collection ends\r\n");
10289 printf ("\r\nAbort? (y or n) ");
10290 #else /* not MSDOS */
10292 printf ("Abort (and enter debugger)? (y or n) ");
10293 #else /* not VMS */
10294 printf ("Abort (and dump core)? (y or n) ");
10295 #endif /* not VMS */
10296 #endif /* not MSDOS */
10298 if (((c
= getchar ()) & ~040) == 'Y')
10300 while (c
!= '\n') c
= getchar ();
10302 printf ("\r\nContinuing...\r\n");
10303 #else /* not MSDOS */
10304 printf ("Continuing...\n");
10305 #endif /* not MSDOS */
10312 /* If executing a function that wants to be interrupted out of
10313 and the user has not deferred quitting by binding `inhibit-quit'
10314 then quit right away. */
10315 if (immediate_quit
&& NILP (Vinhibit_quit
))
10317 struct gl_state_s saved
;
10318 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10320 immediate_quit
= 0;
10323 GCPRO4 (saved
.object
, saved
.global_code
,
10324 saved
.current_syntax_table
, saved
.old_prop
);
10325 Fsignal (Qquit
, Qnil
);
10330 /* Else request quit when it's safe */
10334 if (waiting_for_input
&& !echoing
)
10335 quit_throw_to_read_char ();
10340 /* Handle a C-g by making read_char return C-g. */
10343 quit_throw_to_read_char ()
10346 /* Prevent another signal from doing this before we finish. */
10347 clear_waiting_for_input ();
10350 Vunread_command_events
= Qnil
;
10351 unread_command_char
= -1;
10353 #if 0 /* Currently, sit_for is called from read_char without turning
10354 off polling. And that can call set_waiting_for_input.
10355 It seems to be harmless. */
10356 #ifdef POLL_FOR_INPUT
10357 /* May be > 1 if in recursive minibuffer. */
10358 if (poll_suppress_count
== 0)
10362 if (FRAMEP (internal_last_event_frame
)
10363 && !EQ (internal_last_event_frame
, selected_frame
))
10364 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10367 _longjmp (getcjmp
, 1);
10370 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10371 doc
: /* Set mode of reading keyboard input.
10372 First arg INTERRUPT non-nil means use input interrupts;
10373 nil means use CBREAK mode.
10374 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10375 (no effect except in CBREAK mode).
10376 Third arg META t means accept 8-bit input (for a Meta key).
10377 META nil means ignore the top bit, on the assumption it is parity.
10378 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10379 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10380 See also `current-input-mode'. */)
10381 (interrupt
, flow
, meta
, quit
)
10382 Lisp_Object interrupt
, flow
, meta
, quit
;
10385 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10386 error ("set-input-mode: QUIT must be an ASCII character");
10388 #ifdef POLL_FOR_INPUT
10393 /* this causes startup screen to be restored and messes with the mouse */
10394 reset_sys_modes ();
10398 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10399 if (read_socket_hook
)
10401 /* When using X, don't give the user a real choice,
10402 because we haven't implemented the mechanisms to support it. */
10403 #ifdef NO_SOCK_SIGIO
10404 interrupt_input
= 0;
10405 #else /* not NO_SOCK_SIGIO */
10406 interrupt_input
= 1;
10407 #endif /* NO_SOCK_SIGIO */
10410 interrupt_input
= !NILP (interrupt
);
10411 #else /* not SIGIO */
10412 interrupt_input
= 0;
10413 #endif /* not SIGIO */
10415 /* Our VMS input only works by interrupts, as of now. */
10417 interrupt_input
= 1;
10420 flow_control
= !NILP (flow
);
10423 else if (EQ (meta
, Qt
))
10428 /* Don't let this value be out of range. */
10429 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10435 #ifdef POLL_FOR_INPUT
10436 poll_suppress_count
= 1;
10442 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10443 doc
: /* Return information about the way Emacs currently reads keyboard input.
10444 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10445 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10446 nil, Emacs is using CBREAK mode.
10447 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10448 terminal; this does not apply if Emacs uses interrupt-driven input.
10449 META is t if accepting 8-bit input with 8th bit as Meta flag.
10450 META nil means ignoring the top bit, on the assumption it is parity.
10451 META is neither t nor nil if accepting 8-bit input and using
10452 all 8 bits as the character code.
10453 QUIT is the character Emacs currently uses to quit.
10454 The elements of this list correspond to the arguments of
10455 `set-input-mode'. */)
10458 Lisp_Object val
[4];
10460 val
[0] = interrupt_input
? Qt
: Qnil
;
10461 val
[1] = flow_control
? Qt
: Qnil
;
10462 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10463 XSETFASTINT (val
[3], quit_char
);
10465 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10470 * Set up a new kboard object with reasonable initial values.
10476 kb
->Voverriding_terminal_local_map
= Qnil
;
10477 kb
->Vlast_command
= Qnil
;
10478 kb
->Vreal_last_command
= Qnil
;
10479 kb
->Vprefix_arg
= Qnil
;
10480 kb
->Vlast_prefix_arg
= Qnil
;
10481 kb
->kbd_queue
= Qnil
;
10482 kb
->kbd_queue_has_data
= 0;
10483 kb
->immediate_echo
= 0;
10484 kb
->echo_string
= Qnil
;
10485 kb
->echo_after_prompt
= -1;
10486 kb
->kbd_macro_buffer
= 0;
10487 kb
->kbd_macro_bufsize
= 0;
10488 kb
->defining_kbd_macro
= Qnil
;
10489 kb
->Vlast_kbd_macro
= Qnil
;
10490 kb
->reference_count
= 0;
10491 kb
->Vsystem_key_alist
= Qnil
;
10492 kb
->system_key_syms
= Qnil
;
10493 kb
->Vdefault_minibuffer_frame
= Qnil
;
10497 * Destroy the contents of a kboard object, but not the object itself.
10498 * We use this just before deleting it, or if we're going to initialize
10499 * it a second time.
10505 if (kb
->kbd_macro_buffer
)
10506 xfree (kb
->kbd_macro_buffer
);
10509 #ifdef MULTI_KBOARD
10511 /* Free KB and memory referenced from it. */
10519 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10522 *kbp
= kb
->next_kboard
;
10524 /* Prevent a dangling reference to KB. */
10525 if (kb
== current_kboard
10526 && FRAMEP (selected_frame
)
10527 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10529 current_kboard
= XFRAME (selected_frame
)->kboard
;
10530 if (current_kboard
== kb
)
10538 #endif /* MULTI_KBOARD */
10543 /* This is correct before outermost invocation of the editor loop */
10544 command_loop_level
= -1;
10545 immediate_quit
= 0;
10546 quit_char
= Ctl ('g');
10547 Vunread_command_events
= Qnil
;
10548 unread_command_char
= -1;
10549 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10551 recent_keys_index
= 0;
10552 kbd_fetch_ptr
= kbd_buffer
;
10553 kbd_store_ptr
= kbd_buffer
;
10554 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10556 do_mouse_tracking
= Qnil
;
10560 /* This means that command_loop_1 won't try to select anything the first
10562 internal_last_event_frame
= Qnil
;
10563 Vlast_event_frame
= internal_last_event_frame
;
10565 #ifdef MULTI_KBOARD
10566 current_kboard
= initial_kboard
;
10568 wipe_kboard (current_kboard
);
10569 init_kboard (current_kboard
);
10571 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10573 signal (SIGINT
, interrupt_signal
);
10574 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10575 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10576 SIGQUIT and we can't tell which one it will give us. */
10577 signal (SIGQUIT
, interrupt_signal
);
10578 #endif /* HAVE_TERMIO */
10580 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10582 if (!noninteractive
)
10583 signal (SIGIO
, input_available_signal
);
10586 /* Use interrupt input by default, if it works and noninterrupt input
10587 has deficiencies. */
10589 #ifdef INTERRUPT_INPUT
10590 interrupt_input
= 1;
10592 interrupt_input
= 0;
10595 /* Our VMS input only works by interrupts, as of now. */
10597 interrupt_input
= 1;
10603 if (keyboard_init_hook
)
10604 (*keyboard_init_hook
) ();
10606 #ifdef POLL_FOR_INPUT
10607 poll_suppress_count
= 1;
10612 /* At least provide an escape route since C-g doesn't work. */
10613 signal (SIGINT
, interrupt_signal
);
10617 /* This type's only use is in syms_of_keyboard, to initialize the
10618 event header symbols and put properties on them. */
10619 struct event_head
{
10625 struct event_head head_table
[] = {
10626 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10627 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10628 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10629 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10630 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10631 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10632 /* `select-window' should be handled just like `switch-frame'
10633 in read_key_sequence. */
10634 {&Qselect_window
, "select-window", &Qswitch_frame
}
10638 syms_of_keyboard ()
10640 Vpre_help_message
= Qnil
;
10641 staticpro (&Vpre_help_message
);
10643 Vlispy_mouse_stem
= build_string ("mouse");
10644 staticpro (&Vlispy_mouse_stem
);
10647 QCimage
= intern (":image");
10648 staticpro (&QCimage
);
10650 staticpro (&Qhelp_echo
);
10651 Qhelp_echo
= intern ("help-echo");
10653 staticpro (&item_properties
);
10654 item_properties
= Qnil
;
10656 staticpro (&tool_bar_item_properties
);
10657 tool_bar_item_properties
= Qnil
;
10658 staticpro (&tool_bar_items_vector
);
10659 tool_bar_items_vector
= Qnil
;
10661 staticpro (&real_this_command
);
10662 real_this_command
= Qnil
;
10664 Qtimer_event_handler
= intern ("timer-event-handler");
10665 staticpro (&Qtimer_event_handler
);
10667 Qdisabled_command_hook
= intern ("disabled-command-hook");
10668 staticpro (&Qdisabled_command_hook
);
10670 Qself_insert_command
= intern ("self-insert-command");
10671 staticpro (&Qself_insert_command
);
10673 Qforward_char
= intern ("forward-char");
10674 staticpro (&Qforward_char
);
10676 Qbackward_char
= intern ("backward-char");
10677 staticpro (&Qbackward_char
);
10679 Qdisabled
= intern ("disabled");
10680 staticpro (&Qdisabled
);
10682 Qundefined
= intern ("undefined");
10683 staticpro (&Qundefined
);
10685 Qpre_command_hook
= intern ("pre-command-hook");
10686 staticpro (&Qpre_command_hook
);
10688 Qpost_command_hook
= intern ("post-command-hook");
10689 staticpro (&Qpost_command_hook
);
10691 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10692 staticpro (&Qpost_command_idle_hook
);
10694 Qdeferred_action_function
= intern ("deferred-action-function");
10695 staticpro (&Qdeferred_action_function
);
10697 Qcommand_hook_internal
= intern ("command-hook-internal");
10698 staticpro (&Qcommand_hook_internal
);
10700 Qfunction_key
= intern ("function-key");
10701 staticpro (&Qfunction_key
);
10702 Qmouse_click
= intern ("mouse-click");
10703 staticpro (&Qmouse_click
);
10704 #if defined(WINDOWSNT) || defined(MAC_OSX)
10705 Qmouse_wheel
= intern ("mouse-wheel");
10706 staticpro (&Qmouse_wheel
);
10709 Qlanguage_change
= intern ("language-change");
10710 staticpro (&Qlanguage_change
);
10712 Qdrag_n_drop
= intern ("drag-n-drop");
10713 staticpro (&Qdrag_n_drop
);
10715 Qsave_session
= intern ("save-session");
10716 staticpro(&Qsave_session
);
10718 Qusr1_signal
= intern ("usr1-signal");
10719 staticpro (&Qusr1_signal
);
10720 Qusr2_signal
= intern ("usr2-signal");
10721 staticpro (&Qusr2_signal
);
10723 Qmenu_enable
= intern ("menu-enable");
10724 staticpro (&Qmenu_enable
);
10725 Qmenu_alias
= intern ("menu-alias");
10726 staticpro (&Qmenu_alias
);
10727 QCenable
= intern (":enable");
10728 staticpro (&QCenable
);
10729 QCvisible
= intern (":visible");
10730 staticpro (&QCvisible
);
10731 QChelp
= intern (":help");
10732 staticpro (&QChelp
);
10733 QCfilter
= intern (":filter");
10734 staticpro (&QCfilter
);
10735 QCbutton
= intern (":button");
10736 staticpro (&QCbutton
);
10737 QCkeys
= intern (":keys");
10738 staticpro (&QCkeys
);
10739 QCkey_sequence
= intern (":key-sequence");
10740 staticpro (&QCkey_sequence
);
10741 QCtoggle
= intern (":toggle");
10742 staticpro (&QCtoggle
);
10743 QCradio
= intern (":radio");
10744 staticpro (&QCradio
);
10746 Qmode_line
= intern ("mode-line");
10747 staticpro (&Qmode_line
);
10748 Qvertical_line
= intern ("vertical-line");
10749 staticpro (&Qvertical_line
);
10750 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10751 staticpro (&Qvertical_scroll_bar
);
10752 Qmenu_bar
= intern ("menu-bar");
10753 staticpro (&Qmenu_bar
);
10755 Qabove_handle
= intern ("above-handle");
10756 staticpro (&Qabove_handle
);
10757 Qhandle
= intern ("handle");
10758 staticpro (&Qhandle
);
10759 Qbelow_handle
= intern ("below-handle");
10760 staticpro (&Qbelow_handle
);
10761 Qup
= intern ("up");
10763 Qdown
= intern ("down");
10764 staticpro (&Qdown
);
10765 Qtop
= intern ("top");
10767 Qbottom
= intern ("bottom");
10768 staticpro (&Qbottom
);
10769 Qend_scroll
= intern ("end-scroll");
10770 staticpro (&Qend_scroll
);
10771 Qratio
= intern ("ratio");
10772 staticpro (&Qratio
);
10774 Qevent_kind
= intern ("event-kind");
10775 staticpro (&Qevent_kind
);
10776 Qevent_symbol_elements
= intern ("event-symbol-elements");
10777 staticpro (&Qevent_symbol_elements
);
10778 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10779 staticpro (&Qevent_symbol_element_mask
);
10780 Qmodifier_cache
= intern ("modifier-cache");
10781 staticpro (&Qmodifier_cache
);
10783 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10784 staticpro (&Qrecompute_lucid_menubar
);
10785 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10786 staticpro (&Qactivate_menubar_hook
);
10788 Qpolling_period
= intern ("polling-period");
10789 staticpro (&Qpolling_period
);
10791 Qinput_method_function
= intern ("input-method-function");
10792 staticpro (&Qinput_method_function
);
10794 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10795 staticpro (&Qinput_method_exit_on_first_char
);
10796 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10797 staticpro (&Qinput_method_use_echo_area
);
10799 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10800 Fset (Qinput_method_use_echo_area
, Qnil
);
10802 last_point_position_buffer
= Qnil
;
10805 struct event_head
*p
;
10807 for (p
= head_table
;
10808 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10811 *p
->var
= intern (p
->name
);
10812 staticpro (p
->var
);
10813 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10814 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10818 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10819 staticpro (&button_down_location
);
10820 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10821 staticpro (&mouse_syms
);
10825 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10827 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10828 for (i
= 0; i
< len
; i
++)
10829 if (modifier_names
[i
])
10830 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10831 staticpro (&modifier_symbols
);
10834 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10835 staticpro (&recent_keys
);
10837 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10838 staticpro (&this_command_keys
);
10840 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10841 staticpro (&raw_keybuf
);
10843 Qextended_command_history
= intern ("extended-command-history");
10844 Fset (Qextended_command_history
, Qnil
);
10845 staticpro (&Qextended_command_history
);
10847 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10848 staticpro (&kbd_buffer_gcpro
);
10850 accent_key_syms
= Qnil
;
10851 staticpro (&accent_key_syms
);
10853 func_key_syms
= Qnil
;
10854 staticpro (&func_key_syms
);
10856 #if defined(WINDOWSNT) || defined(MAC_OSX)
10857 mouse_wheel_syms
= Qnil
;
10858 staticpro (&mouse_wheel_syms
);
10859 drag_n_drop_syms
= Qnil
;
10860 staticpro (&drag_n_drop_syms
);
10863 unread_switch_frame
= Qnil
;
10864 staticpro (&unread_switch_frame
);
10866 internal_last_event_frame
= Qnil
;
10867 staticpro (&internal_last_event_frame
);
10869 read_key_sequence_cmd
= Qnil
;
10870 staticpro (&read_key_sequence_cmd
);
10872 menu_bar_one_keymap_changed_items
= Qnil
;
10873 staticpro (&menu_bar_one_keymap_changed_items
);
10875 defsubr (&Sevent_convert_list
);
10876 defsubr (&Sread_key_sequence
);
10877 defsubr (&Sread_key_sequence_vector
);
10878 defsubr (&Srecursive_edit
);
10880 defsubr (&Strack_mouse
);
10882 defsubr (&Sinput_pending_p
);
10883 defsubr (&Scommand_execute
);
10884 defsubr (&Srecent_keys
);
10885 defsubr (&Sthis_command_keys
);
10886 defsubr (&Sthis_command_keys_vector
);
10887 defsubr (&Sthis_single_command_keys
);
10888 defsubr (&Sthis_single_command_raw_keys
);
10889 defsubr (&Sreset_this_command_lengths
);
10890 defsubr (&Sclear_this_command_keys
);
10891 defsubr (&Ssuspend_emacs
);
10892 defsubr (&Sabort_recursive_edit
);
10893 defsubr (&Sexit_recursive_edit
);
10894 defsubr (&Srecursion_depth
);
10895 defsubr (&Stop_level
);
10896 defsubr (&Sdiscard_input
);
10897 defsubr (&Sopen_dribble_file
);
10898 defsubr (&Sset_input_mode
);
10899 defsubr (&Scurrent_input_mode
);
10900 defsubr (&Sexecute_extended_command
);
10902 DEFVAR_LISP ("last-command-char", &last_command_char
,
10903 doc
: /* Last input event that was part of a command. */);
10905 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10906 doc
: /* Last input event that was part of a command. */);
10908 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10909 doc
: /* Last input event in a command, except for mouse menu events.
10910 Mouse menus give back keys that don't look like mouse events;
10911 this variable holds the actual mouse event that led to the menu,
10912 so that you can determine whether the command was run by mouse or not. */);
10914 DEFVAR_LISP ("last-input-char", &last_input_char
,
10915 doc
: /* Last input event. */);
10917 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10918 doc
: /* Last input event. */);
10920 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10921 doc
: /* List of events to be read as the command input.
10922 These events are processed first, before actual keyboard input. */);
10923 Vunread_command_events
= Qnil
;
10925 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10926 doc
: /* If not -1, an object to be read as next command input event. */);
10928 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10929 doc
: /* List of events to be processed as input by input methods.
10930 These events are processed after `unread-command-events', but
10931 before actual keyboard input. */);
10932 Vunread_post_input_method_events
= Qnil
;
10934 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10935 doc
: /* List of events to be processed as input by input methods.
10936 These events are processed after `unread-command-events', but
10937 before actual keyboard input. */);
10938 Vunread_input_method_events
= Qnil
;
10940 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10941 doc
: /* Meta-prefix character code.
10942 Meta-foo as command input turns into this character followed by foo. */);
10943 XSETINT (meta_prefix_char
, 033);
10945 DEFVAR_KBOARD ("last-command", Vlast_command
,
10946 doc
: /* The last command executed.
10947 Normally a symbol with a function definition, but can be whatever was found
10948 in the keymap, or whatever the variable `this-command' was set to by that
10951 The value `mode-exit' is special; it means that the previous command
10952 read an event that told it to exit, and it did so and unread that event.
10953 In other words, the present command is the event that made the previous
10956 The value `kill-region' is special; it means that the previous command
10957 was a kill command. */);
10959 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10960 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10962 DEFVAR_LISP ("this-command", &Vthis_command
,
10963 doc
: /* The command now being executed.
10964 The command can set this variable; whatever is put here
10965 will be in `last-command' during the following command. */);
10966 Vthis_command
= Qnil
;
10968 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10969 doc
: /* The command bound to the current key sequence before remapping.
10970 It equals `this-command' if the original command was not remapped through
10971 any of the active keymaps. Otherwise, the value of `this-command' is the
10972 result of looking up the original command in the active keymaps. */);
10973 Vthis_original_command
= Qnil
;
10975 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10976 doc
: /* *Number of input events between auto-saves.
10977 Zero means disable autosaving due to number of characters typed. */);
10978 auto_save_interval
= 300;
10980 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10981 doc
: /* *Number of seconds idle time before auto-save.
10982 Zero or nil means disable auto-saving due to idleness.
10983 After auto-saving due to this many seconds of idle time,
10984 Emacs also does a garbage collection if that seems to be warranted. */);
10985 XSETFASTINT (Vauto_save_timeout
, 30);
10987 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10988 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10989 The value may be integer or floating point. */);
10990 Vecho_keystrokes
= make_number (1);
10992 DEFVAR_INT ("polling-period", &polling_period
,
10993 doc
: /* *Interval between polling for input during Lisp execution.
10994 The reason for polling is to make C-g work to stop a running program.
10995 Polling is needed only when using X windows and SIGIO does not work.
10996 Polling is automatically disabled in all other cases. */);
10997 polling_period
= 2;
10999 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11000 doc
: /* *Maximum time between mouse clicks to make a double-click.
11001 Measured in milliseconds. nil means disable double-click recognition;
11002 t means double-clicks have no time limit and are detected
11003 by position only. */);
11004 Vdouble_click_time
= make_number (500);
11006 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11007 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11008 On window-system frames, value is the number of pixels the mouse may have
11009 moved horizontally or vertically between two clicks to make a double-click.
11010 On non window-system frames, value is interpreted in units of 1/8 characters
11013 This variable is also the threshold for motion of the mouse
11014 to count as a drag. */);
11015 double_click_fuzz
= 3;
11017 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11018 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11019 inhibit_local_menu_bar_menus
= 0;
11021 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11022 doc
: /* Number of complete key sequences read as input so far.
11023 This includes key sequences read from keyboard macros.
11024 The number is effectively the number of interactive command invocations. */);
11025 num_input_keys
= 0;
11027 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11028 doc
: /* Number of input events read from the keyboard so far.
11029 This does not include events generated by keyboard macros. */);
11030 num_nonmacro_input_events
= 0;
11032 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11033 doc
: /* The frame in which the most recently read event occurred.
11034 If the last event came from a keyboard macro, this is set to `macro'. */);
11035 Vlast_event_frame
= Qnil
;
11037 /* This variable is set up in sysdep.c. */
11038 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11039 doc
: /* The ERASE character as set by the user with stty. */);
11041 DEFVAR_LISP ("help-char", &Vhelp_char
,
11042 doc
: /* Character to recognize as meaning Help.
11043 When it is read, do `(eval help-form)', and display result if it's a string.
11044 If the value of `help-form' is nil, this char can be read normally. */);
11045 XSETINT (Vhelp_char
, Ctl ('H'));
11047 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11048 doc
: /* List of input events to recognize as meaning Help.
11049 These work just like the value of `help-char' (see that). */);
11050 Vhelp_event_list
= Qnil
;
11052 DEFVAR_LISP ("help-form", &Vhelp_form
,
11053 doc
: /* Form to execute when character `help-char' is read.
11054 If the form returns a string, that string is displayed.
11055 If `help-form' is nil, the help char is not recognized. */);
11058 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11059 doc
: /* Command to run when `help-char' character follows a prefix key.
11060 This command is used only when there is no actual binding
11061 for that character after that prefix key. */);
11062 Vprefix_help_command
= Qnil
;
11064 DEFVAR_LISP ("top-level", &Vtop_level
,
11065 doc
: /* Form to evaluate when Emacs starts up.
11066 Useful to set before you dump a modified Emacs. */);
11069 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11070 doc
: /* Translate table for keyboard input, or nil.
11071 Each character is looked up in this string and the contents used instead.
11072 The value may be a string, a vector, or a char-table.
11073 If it is a string or vector of length N,
11074 character codes N and up are untranslated.
11075 In a vector or a char-table, an element which is nil means "no translation".
11077 This is applied to the characters supplied to input methods, not their
11078 output. See also `translation-table-for-input'. */);
11079 Vkeyboard_translate_table
= Qnil
;
11081 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11082 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11083 \(Even if the operating system has support for stopping a process.\) */);
11084 cannot_suspend
= 0;
11086 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11087 doc
: /* Non-nil means prompt with menus when appropriate.
11088 This is done when reading from a keymap that has a prompt string,
11089 for elements that have prompt strings.
11090 The menu is displayed on the screen
11091 if X menus were enabled at configuration
11092 time and the previous event was a mouse click prefix key.
11093 Otherwise, menu prompting uses the echo area. */);
11094 menu_prompting
= 1;
11096 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11097 doc
: /* Character to see next line of menu prompt.
11098 Type this character while in a menu prompt to rotate around the lines of it. */);
11099 XSETINT (menu_prompt_more_char
, ' ');
11101 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11102 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11103 Emacs applies the modifiers of the character stored here to each keyboard
11104 character it reads. For example, after evaluating the expression
11105 (setq extra-keyboard-modifiers ?\\C-x)
11106 all input characters will have the control modifier applied to them.
11108 Note that the character ?\\C-@, equivalent to the integer zero, does
11109 not count as a control character; rather, it counts as a character
11110 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11111 cancels any modification. */);
11112 extra_keyboard_modifiers
= 0;
11114 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11115 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11116 The command loop sets this to nil before each command,
11117 and tests the value when the command returns.
11118 Buffer modification stores t in this variable. */);
11119 Vdeactivate_mark
= Qnil
;
11121 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11122 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11123 Vcommand_hook_internal
= Qnil
;
11125 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11126 doc
: /* Normal hook run before each command is executed.
11127 If an unhandled error happens in running this hook,
11128 the hook value is set to nil, since otherwise the error
11129 might happen repeatedly and make Emacs nonfunctional. */);
11130 Vpre_command_hook
= Qnil
;
11132 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11133 doc
: /* Normal hook run after each command is executed.
11134 If an unhandled error happens in running this hook,
11135 the hook value is set to nil, since otherwise the error
11136 might happen repeatedly and make Emacs nonfunctional. */);
11137 Vpost_command_hook
= Qnil
;
11139 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11140 doc
: /* Normal hook run after each command is executed, if idle.
11141 Errors running the hook are caught and ignored. */);
11142 Vpost_command_idle_hook
= Qnil
;
11144 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11145 doc
: /* Delay time before running `post-command-idle-hook'.
11146 This is measured in microseconds. */);
11147 post_command_idle_delay
= 100000;
11150 DEFVAR_LISP ("echo-area-clear-hook", ...,
11151 doc
: /* Normal hook run when clearing the echo area. */);
11153 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11154 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11156 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11157 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11158 Vlucid_menu_bar_dirty_flag
= Qnil
;
11160 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11161 doc
: /* List of menu bar items to move to the end of the menu bar.
11162 The elements of the list are event types that may have menu bar bindings. */);
11163 Vmenu_bar_final_items
= Qnil
;
11165 DEFVAR_KBOARD ("overriding-terminal-local-map",
11166 Voverriding_terminal_local_map
,
11167 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11168 If this variable is non-nil, it is used as a keymap instead of the
11169 buffer's local map, and the minor mode keymaps and text property keymaps.
11170 This variable is intended to let commands such as `universal-argument'
11171 set up a different keymap for reading the next command. */);
11173 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11174 doc
: /* Keymap that overrides all other local keymaps.
11175 If this variable is non-nil, it is used as a keymap instead of the
11176 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11177 Voverriding_local_map
= Qnil
;
11179 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11180 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11181 Otherwise, the menu bar continues to reflect the buffer's local map
11182 and the minor mode maps regardless of `overriding-local-map'. */);
11183 Voverriding_local_map_menu_flag
= Qnil
;
11185 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11186 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11187 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11189 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11190 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11192 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11193 doc
: /* Alist of system-specific X windows key symbols.
11194 Each element should have the form (N . SYMBOL) where N is the
11195 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11196 and SYMBOL is its name. */);
11198 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11199 doc
: /* List of deferred actions to be performed at a later time.
11200 The precise format isn't relevant here; we just check whether it is nil. */);
11201 Vdeferred_action_list
= Qnil
;
11203 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11204 doc
: /* Function to call to handle deferred actions, after each command.
11205 This function is called with no arguments after each command
11206 whenever `deferred-action-list' is non-nil. */);
11207 Vdeferred_action_function
= Qnil
;
11209 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11210 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11211 The value can be a length of time to show the message for.
11212 If the value is non-nil and not a number, we wait 2 seconds. */);
11213 Vsuggest_key_bindings
= Qt
;
11215 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11216 doc
: /* List of active absolute time timers in order of increasing time. */);
11217 Vtimer_list
= Qnil
;
11219 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11220 doc
: /* List of active idle-time timers in order of increasing time. */);
11221 Vtimer_idle_list
= Qnil
;
11223 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11224 doc
: /* If non-nil, the function that implements the current input method.
11225 It's called with one argument, a printing character that was just read.
11226 \(That means a character with code 040...0176.)
11227 Typically this function uses `read-event' to read additional events.
11228 When it does so, it should first bind `input-method-function' to nil
11229 so it will not be called recursively.
11231 The function should return a list of zero or more events
11232 to be used as input. If it wants to put back some events
11233 to be reconsidered, separately, by the input method,
11234 it can add them to the beginning of `unread-command-events'.
11236 The input method function can find in `input-method-previous-method'
11237 the previous echo area message.
11239 The input method function should refer to the variables
11240 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11241 for guidance on what to do. */);
11242 Vinput_method_function
= Qnil
;
11244 DEFVAR_LISP ("input-method-previous-message",
11245 &Vinput_method_previous_message
,
11246 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11247 This variable exists because `read-event' clears the echo area
11248 before running the input method. It is nil if there was no message. */);
11249 Vinput_method_previous_message
= Qnil
;
11251 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11252 doc
: /* If non-nil, the function that implements the display of help.
11253 It's called with one argument, the help string to display. */);
11254 Vshow_help_function
= Qnil
;
11256 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11257 doc
: /* If non-nil, suppress point adjustment after executing a command.
11259 After a command is executed, if point is moved into a region that has
11260 special properties (e.g. composition, display), we adjust point to
11261 the boundary of the region. But, several special commands sets this
11262 variable to non-nil, then we suppress the point adjustment.
11264 This variable is set to nil before reading a command, and is checked
11265 just after executing the command. */);
11266 Vdisable_point_adjustment
= Qnil
;
11268 DEFVAR_LISP ("global-disable-point-adjustment",
11269 &Vglobal_disable_point_adjustment
,
11270 doc
: /* *If non-nil, always suppress point adjustment.
11272 The default value is nil, in which case, point adjustment are
11273 suppressed only after special commands that set
11274 `disable-point-adjustment' (which see) to non-nil. */);
11275 Vglobal_disable_point_adjustment
= Qnil
;
11277 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11278 doc
: /* Non-nil means updating menu bindings is allowed.
11279 A value of nil means menu bindings should not be updated.
11280 Used during Emacs' startup. */);
11281 update_menu_bindings
= 1;
11283 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11284 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11285 If the value is not a number, such messages don't time out. */);
11286 Vminibuffer_message_timeout
= make_number (2);
11290 keys_of_keyboard ()
11292 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11293 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11294 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11295 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11296 initial_define_key (meta_map
, 'x', "execute-extended-command");
11298 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11299 "handle-delete-frame");
11300 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11302 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11304 /* Handling it at such a low-level causes read_key_sequence to get
11305 * confused because it doesn't realize that the current_buffer was
11306 * changed by read_char.
11308 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11309 * "handle-select-window"); */
11310 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11311 "handle-save-session");