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
) > 0)
790 Lisp_Object last_char
, idx
;
792 idx
= make_number (SCHARS (echo_string
) - 1);
793 last_char
= Faref (echo_string
, idx
);
795 if (XINT (last_char
) == '-')
796 Faset (echo_string
, idx
, make_number (' '));
798 echo_string
= concat2 (echo_string
, build_string (" "));
801 current_kboard
->echo_string
802 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
808 /* Temporarily add a dash to the end of the echo string if it's not
809 empty, so that it serves as a mini-prompt for the very next character. */
814 /* Do nothing if not echoing at all. */
815 if (NILP (current_kboard
->echo_string
))
818 if (!current_kboard
->immediate_echo
819 && SCHARS (current_kboard
->echo_string
) == 0)
822 /* Do nothing if we just printed a prompt. */
823 if (current_kboard
->echo_after_prompt
824 == SCHARS (current_kboard
->echo_string
))
827 /* Put a dash at the end of the buffer temporarily,
828 but make it go away when the next character is added. */
829 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
834 /* Display the current echo string, and begin echoing if not already
840 if (!current_kboard
->immediate_echo
)
843 current_kboard
->immediate_echo
= 1;
845 for (i
= 0; i
< this_command_key_count
; i
++)
849 /* Set before_command_echo_length to the value that would
850 have been saved before the start of this subcommand in
851 command_loop_1, if we had already been echoing then. */
852 if (i
== this_single_command_key_start
)
853 before_command_echo_length
= echo_length ();
855 c
= XVECTOR (this_command_keys
)->contents
[i
];
856 if (! (EVENT_HAS_PARAMETERS (c
)
857 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
861 /* Set before_command_echo_length to the value that would
862 have been saved before the start of this subcommand in
863 command_loop_1, if we had already been echoing then. */
864 if (this_command_key_count
== this_single_command_key_start
)
865 before_command_echo_length
= echo_length ();
867 /* Put a dash at the end to invite the user to type more. */
872 message3_nolog (current_kboard
->echo_string
,
873 SBYTES (current_kboard
->echo_string
),
874 STRING_MULTIBYTE (current_kboard
->echo_string
));
877 /* Record in what buffer we echoed, and from which kboard. */
878 echo_message_buffer
= echo_area_buffer
[0];
879 echo_kboard
= current_kboard
;
881 if (waiting_for_input
&& !NILP (Vquit_flag
))
882 quit_throw_to_read_char ();
885 /* Turn off echoing, for the start of a new command. */
890 current_kboard
->immediate_echo
= 0;
891 current_kboard
->echo_after_prompt
= -1;
892 current_kboard
->echo_string
= Qnil
;
893 ok_to_echo_at_next_pause
= NULL
;
895 echo_message_buffer
= Qnil
;
898 /* Return the length of the current echo string. */
903 return (STRINGP (current_kboard
->echo_string
)
904 ? SCHARS (current_kboard
->echo_string
)
908 /* Truncate the current echo message to its first LEN chars.
909 This and echo_char get used by read_key_sequence when the user
910 switches frames while entering a key sequence. */
913 echo_truncate (nchars
)
916 if (STRINGP (current_kboard
->echo_string
))
917 current_kboard
->echo_string
918 = Fsubstring (current_kboard
->echo_string
,
919 make_number (0), make_number (nchars
));
920 truncate_echo_area (nchars
);
924 /* Functions for manipulating this_command_keys. */
926 add_command_key (key
)
929 #if 0 /* Not needed after we made Freset_this_command_lengths
930 do the job immediately. */
931 /* If reset-this-command-length was called recently, obey it now.
932 See the doc string of that function for an explanation of why. */
933 if (before_command_restore_flag
)
935 this_command_key_count
= before_command_key_count_1
;
936 if (this_command_key_count
< this_single_command_key_start
)
937 this_single_command_key_start
= this_command_key_count
;
938 echo_truncate (before_command_echo_length_1
);
939 before_command_restore_flag
= 0;
943 if (this_command_key_count
>= ASIZE (this_command_keys
))
944 this_command_keys
= larger_vector (this_command_keys
,
945 2 * ASIZE (this_command_keys
),
948 AREF (this_command_keys
, this_command_key_count
) = key
;
949 ++this_command_key_count
;
956 int count
= SPECPDL_INDEX ();
959 if (command_loop_level
> 0)
961 specbind (Qstandard_output
, Qt
);
962 specbind (Qstandard_input
, Qt
);
965 #ifdef HAVE_X_WINDOWS
966 /* The command loop has started an hourglass timer, so we have to
967 cancel it here, otherwise it will fire because the recursive edit
968 can take some time. Do not check for display_hourglass_p here,
969 because it could already be nil. */
973 /* This function may have been called from a debugger called from
974 within redisplay, for instance by Edebugging a function called
975 from fontification-functions. We want to allow redisplay in
976 the debugging session.
978 The recursive edit is left with a `(throw exit ...)'. The `exit'
979 tag is not caught anywhere in redisplay, i.e. when we leave the
980 recursive edit, the original redisplay leading to the recursive
981 edit will be unwound. The outcome should therefore be safe. */
982 specbind (Qinhibit_redisplay
, Qnil
);
985 val
= command_loop ();
987 Fsignal (Qquit
, Qnil
);
988 /* Handle throw from read_minibuf when using minibuffer
989 while it's active but we're in another window. */
991 Fsignal (Qerror
, Fcons (val
, Qnil
));
993 return unbind_to (count
, Qnil
);
996 /* When an auto-save happens, record the "time", and don't do again soon. */
1001 last_auto_save
= num_nonmacro_input_events
;
1004 /* Make an auto save happen as soon as possible at command level. */
1007 force_auto_save_soon ()
1009 last_auto_save
= - auto_save_interval
- 1;
1011 record_asynch_buffer_change ();
1014 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1015 doc
: /* Invoke the editor command loop recursively.
1016 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1017 that tells this function to return.
1018 Alternately, `(throw 'exit t)' makes this function signal an error.
1019 This function is called by the editor initialization to begin editing. */)
1022 int count
= SPECPDL_INDEX ();
1025 command_loop_level
++;
1026 update_mode_lines
= 1;
1028 if (command_loop_level
1029 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1030 buffer
= Fcurrent_buffer ();
1034 /* If we leave recursive_edit_1 below with a `throw' for instance,
1035 like it is done in the splash screen display, we have to
1036 make sure that we restore single_kboard as command_loop_1
1037 would have done if it were left normally. */
1038 record_unwind_protect (recursive_edit_unwind
,
1039 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1041 recursive_edit_1 ();
1042 return unbind_to (count
, Qnil
);
1046 recursive_edit_unwind (info
)
1049 if (BUFFERP (XCAR (info
)))
1050 Fset_buffer (XCAR (info
));
1052 if (NILP (XCDR (info
)))
1053 any_kboard_state ();
1055 single_kboard_state ();
1057 command_loop_level
--;
1058 update_mode_lines
= 1;
1067 #if 0 /* Theory: if there's anything in Vunread_command_events,
1068 it will right away be read by read_key_sequence,
1069 and then if we do switch KBOARDS, it will go into the side
1070 queue then. So we don't need to do anything special here -- rms. */
1071 if (CONSP (Vunread_command_events
))
1073 current_kboard
->kbd_queue
1074 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1075 current_kboard
->kbd_queue_has_data
= 1;
1077 Vunread_command_events
= Qnil
;
1083 /* Switch to the single-kboard state, making current_kboard
1084 the only KBOARD from which further input is accepted. */
1087 single_kboard_state ()
1094 /* Maintain a stack of kboards, so other parts of Emacs
1095 can switch temporarily to the kboard of a given frame
1096 and then revert to the previous status. */
1101 struct kboard_stack
*next
;
1104 static struct kboard_stack
*kboard_stack
;
1107 push_frame_kboard (f
)
1111 struct kboard_stack
*p
1112 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1114 p
->next
= kboard_stack
;
1115 p
->kboard
= current_kboard
;
1118 current_kboard
= FRAME_KBOARD (f
);
1126 struct kboard_stack
*p
= kboard_stack
;
1127 current_kboard
= p
->kboard
;
1128 kboard_stack
= p
->next
;
1133 /* Handle errors that are not handled at inner levels
1134 by printing an error message and returning to the editor command loop. */
1140 Lisp_Object old_level
, old_length
;
1141 char macroerror
[50];
1143 #ifdef HAVE_X_WINDOWS
1144 if (display_hourglass_p
)
1145 cancel_hourglass ();
1148 if (!NILP (executing_macro
))
1150 if (executing_macro_iterations
== 1)
1151 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1153 sprintf (macroerror
, "After %d kbd macro iterations: ",
1154 executing_macro_iterations
);
1159 Vstandard_output
= Qt
;
1160 Vstandard_input
= Qt
;
1161 Vexecuting_macro
= Qnil
;
1162 executing_macro
= Qnil
;
1163 current_kboard
->Vprefix_arg
= Qnil
;
1164 current_kboard
->Vlast_prefix_arg
= Qnil
;
1167 /* Avoid unquittable loop if data contains a circular list. */
1168 old_level
= Vprint_level
;
1169 old_length
= Vprint_length
;
1170 XSETFASTINT (Vprint_level
, 10);
1171 XSETFASTINT (Vprint_length
, 10);
1172 cmd_error_internal (data
, macroerror
);
1173 Vprint_level
= old_level
;
1174 Vprint_length
= old_length
;
1178 Vinhibit_quit
= Qnil
;
1180 any_kboard_state ();
1183 return make_number (0);
1186 /* Take actions on handling an error. DATA is the data that describes
1189 CONTEXT is a C-string containing ASCII characters only which
1190 describes the context in which the error happened. If we need to
1191 generalize CONTEXT to allow multibyte characters, make it a Lisp
1195 cmd_error_internal (data
, context
)
1200 int kill_emacs_p
= 0;
1201 struct frame
*sf
= SELECTED_FRAME ();
1205 clear_message (1, 0);
1207 /* If the window system or terminal frame hasn't been initialized
1208 yet, or we're not interactive, it's best to dump this message out
1209 to stderr and exit. */
1210 if (!sf
->glyphs_initialized_p
1211 /* This is the case of the frame dumped with Emacs, when we're
1212 running under a window system. */
1213 || (!NILP (Vwindow_system
)
1214 && !inhibit_window_system
1215 && FRAME_TERMCAP_P (sf
))
1218 stream
= Qexternal_debugging_output
;
1224 message_log_maybe_newline ();
1229 /* The immediate context is not interesting for Quits,
1230 since they are asyncronous. */
1231 if (EQ (XCAR (data
), Qquit
))
1232 Vsignaling_function
= Qnil
;
1234 print_error_message (data
, stream
, context
, Vsignaling_function
);
1236 Vsignaling_function
= Qnil
;
1238 /* If the window system or terminal frame hasn't been initialized
1239 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1243 Fkill_emacs (make_number (-1));
1247 Lisp_Object
command_loop_1 ();
1248 Lisp_Object
command_loop_2 ();
1249 Lisp_Object
top_level_1 ();
1251 /* Entry to editor-command-loop.
1252 This level has the catches for exiting/returning to editor command loop.
1253 It returns nil to exit recursive edit, t to abort it. */
1258 if (command_loop_level
> 0 || minibuf_level
> 0)
1261 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1262 executing_macro
= Qnil
;
1268 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1269 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1270 executing_macro
= Qnil
;
1272 /* End of file in -batch run causes exit here. */
1278 /* Here we catch errors in execution of commands within the
1279 editing loop, and reenter the editing loop.
1280 When there is an error, cmd_error runs and returns a non-nil
1281 value to us. A value of nil means that command_loop_1 itself
1282 returned due to end of file (or end of kbd macro). */
1287 register Lisp_Object val
;
1290 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1291 while (!NILP (val
));
1299 return Feval (Vtop_level
);
1305 /* On entry to the outer level, run the startup file */
1306 if (!NILP (Vtop_level
))
1307 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1308 else if (!NILP (Vpurify_flag
))
1309 message ("Bare impure Emacs (standard Lisp code not loaded)");
1311 message ("Bare Emacs (standard Lisp code not loaded)");
1315 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1316 doc
: /* Exit all recursive editing levels. */)
1319 #ifdef HAVE_X_WINDOWS
1320 if (display_hourglass_p
)
1321 cancel_hourglass ();
1323 return Fthrow (Qtop_level
, Qnil
);
1326 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1327 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1330 if (command_loop_level
> 0 || minibuf_level
> 0)
1331 Fthrow (Qexit
, Qnil
);
1333 error ("No recursive edit is in progress");
1337 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1338 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1341 if (command_loop_level
> 0 || minibuf_level
> 0)
1344 error ("No recursive edit is in progress");
1348 /* This is the actual command reading loop,
1349 sans error-handling encapsulation. */
1351 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1353 void safe_run_hooks
P_ ((Lisp_Object
));
1354 static void adjust_point_for_property
P_ ((int, int));
1356 /* Cancel hourglass from protect_unwind.
1358 #ifdef HAVE_X_WINDOWS
1360 cancel_hourglass_unwind (arg
)
1363 cancel_hourglass ();
1373 Lisp_Object keybuf
[30];
1377 struct buffer
*prev_buffer
= NULL
;
1379 int was_locked
= single_kboard
;
1381 int already_adjusted
;
1383 current_kboard
->Vprefix_arg
= Qnil
;
1384 current_kboard
->Vlast_prefix_arg
= Qnil
;
1385 Vdeactivate_mark
= Qnil
;
1386 waiting_for_input
= 0;
1390 this_command_key_count
= 0;
1391 this_command_key_count_reset
= 0;
1392 this_single_command_key_start
= 0;
1394 if (NILP (Vmemory_full
))
1396 /* Make sure this hook runs after commands that get errors and
1397 throw to top level. */
1398 /* Note that the value cell will never directly contain nil
1399 if the symbol is a local variable. */
1400 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1401 safe_run_hooks (Qpost_command_hook
);
1403 /* If displaying a message, resize the echo area window to fit
1404 that message's size exactly. */
1405 if (!NILP (echo_area_buffer
[0]))
1406 resize_echo_area_exactly ();
1408 if (!NILP (Vdeferred_action_list
))
1409 call0 (Vdeferred_action_function
);
1411 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1413 if (NILP (Vunread_command_events
)
1414 && NILP (Vunread_input_method_events
)
1415 && NILP (Vunread_post_input_method_events
)
1416 && NILP (Vexecuting_macro
)
1417 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1418 safe_run_hooks (Qpost_command_idle_hook
);
1422 Vmemory_full
= Qnil
;
1424 /* Do this after running Vpost_command_hook, for consistency. */
1425 current_kboard
->Vlast_command
= Vthis_command
;
1426 current_kboard
->Vreal_last_command
= real_this_command
;
1430 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1433 /* Make sure the current window's buffer is selected. */
1434 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1435 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1437 /* Display any malloc warning that just came out. Use while because
1438 displaying one warning can cause another. */
1440 while (pending_malloc_warning
)
1441 display_malloc_warning ();
1445 Vdeactivate_mark
= Qnil
;
1447 /* If minibuffer on and echo area in use,
1448 wait a short time and redraw minibuffer. */
1451 && !NILP (echo_area_buffer
[0])
1452 && EQ (minibuf_window
, echo_area_window
)
1453 && NUMBERP (Vminibuffer_message_timeout
))
1455 /* Bind inhibit-quit to t so that C-g gets read in
1456 rather than quitting back to the minibuffer. */
1457 int count
= SPECPDL_INDEX ();
1458 specbind (Qinhibit_quit
, Qt
);
1460 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1461 /* Clear the echo area. */
1463 safe_run_hooks (Qecho_area_clear_hook
);
1465 unbind_to (count
, Qnil
);
1467 /* If a C-g came in before, treat it as input now. */
1468 if (!NILP (Vquit_flag
))
1471 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1476 alloca (0); /* Cause a garbage collection now */
1477 /* Since we can free the most stuff here. */
1478 #endif /* C_ALLOCA */
1481 /* Select the frame that the last event came from. Usually,
1482 switch-frame events will take care of this, but if some lisp
1483 code swallows a switch-frame event, we'll fix things up here.
1484 Is this a good idea? */
1485 if (FRAMEP (internal_last_event_frame
)
1486 && !EQ (internal_last_event_frame
, selected_frame
))
1487 Fselect_frame (internal_last_event_frame
, Qnil
);
1489 /* If it has changed current-menubar from previous value,
1490 really recompute the menubar from the value. */
1491 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1492 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1493 call0 (Qrecompute_lucid_menubar
);
1495 before_command_key_count
= this_command_key_count
;
1496 before_command_echo_length
= echo_length ();
1498 Vthis_command
= Qnil
;
1499 real_this_command
= Qnil
;
1501 /* Read next key sequence; i gets its length. */
1502 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1505 /* A filter may have run while we were reading the input. */
1506 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1508 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1509 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1513 /* Now we have read a key sequence of length I,
1514 or else I is 0 and we found end of file. */
1516 if (i
== 0) /* End of file -- happens only in */
1517 return Qnil
; /* a kbd macro, at the end. */
1518 /* -1 means read_key_sequence got a menu that was rejected.
1519 Just loop around and read another command. */
1523 this_command_key_count
= 0;
1524 this_command_key_count_reset
= 0;
1525 this_single_command_key_start
= 0;
1529 last_command_char
= keybuf
[i
- 1];
1531 /* If the previous command tried to force a specific window-start,
1532 forget about that, in case this command moves point far away
1533 from that position. But also throw away beg_unchanged and
1534 end_unchanged information in that case, so that redisplay will
1535 update the whole window properly. */
1536 if (!NILP (XWINDOW (selected_window
)->force_start
))
1539 XWINDOW (selected_window
)->force_start
= Qnil
;
1540 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1541 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1544 cmd
= read_key_sequence_cmd
;
1545 if (!NILP (Vexecuting_macro
))
1547 if (!NILP (Vquit_flag
))
1549 Vexecuting_macro
= Qt
;
1550 QUIT
; /* Make some noise. */
1551 /* Will return since macro now empty. */
1555 /* Do redisplay processing after this command except in special
1556 cases identified below. */
1557 prev_buffer
= current_buffer
;
1558 prev_modiff
= MODIFF
;
1559 last_point_position
= PT
;
1560 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1562 /* By default, we adjust point to a boundary of a region that
1563 has such a property that should be treated intangible
1564 (e.g. composition, display). But, some commands will set
1565 this variable differently. */
1566 Vdisable_point_adjustment
= Qnil
;
1568 /* Process filters and timers may have messed with deactivate-mark.
1569 reset it before we execute the command. */
1570 Vdeactivate_mark
= Qnil
;
1572 /* Remap command through active keymaps */
1573 Vthis_original_command
= cmd
;
1577 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1581 /* Execute the command. */
1583 Vthis_command
= cmd
;
1584 real_this_command
= cmd
;
1585 /* Note that the value cell will never directly contain nil
1586 if the symbol is a local variable. */
1587 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1588 safe_run_hooks (Qpre_command_hook
);
1590 already_adjusted
= 0;
1592 if (NILP (Vthis_command
))
1594 /* nil means key is undefined. */
1596 current_kboard
->defining_kbd_macro
= Qnil
;
1597 update_mode_lines
= 1;
1598 current_kboard
->Vprefix_arg
= Qnil
;
1602 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1604 /* In case we jump to directly_done. */
1605 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1607 /* Recognize some common commands in common situations and
1608 do them directly. */
1609 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1611 struct Lisp_Char_Table
*dp
1612 = window_display_table (XWINDOW (selected_window
));
1613 lose
= FETCH_CHAR (PT_BYTE
);
1615 if (! NILP (Vpost_command_hook
))
1616 /* Put this before calling adjust_point_for_property
1617 so it will only get called once in any case. */
1619 if (current_buffer
== prev_buffer
1620 && last_point_position
!= PT
1621 && NILP (Vdisable_point_adjustment
)
1622 && NILP (Vglobal_disable_point_adjustment
))
1623 adjust_point_for_property (last_point_position
, 0);
1624 already_adjusted
= 1;
1625 if (PT
== last_point_position
+ 1
1627 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1628 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1629 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1630 && (lose
>= 0x20 && lose
< 0x7f)))
1631 : (lose
>= 0x20 && lose
< 0x7f))
1632 /* To extract the case of continuation on
1633 wide-column characters. */
1634 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1635 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1637 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1639 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1641 && !windows_or_buffers_changed
1642 && EQ (current_buffer
->selective_display
, Qnil
)
1643 && !detect_input_pending ()
1644 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1645 && NILP (Vexecuting_macro
))
1646 direct_output_forward_char (1);
1649 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1651 struct Lisp_Char_Table
*dp
1652 = window_display_table (XWINDOW (selected_window
));
1654 lose
= FETCH_CHAR (PT_BYTE
);
1655 if (! NILP (Vpost_command_hook
))
1657 if (current_buffer
== prev_buffer
1658 && last_point_position
!= PT
1659 && NILP (Vdisable_point_adjustment
)
1660 && NILP (Vglobal_disable_point_adjustment
))
1661 adjust_point_for_property (last_point_position
, 0);
1662 already_adjusted
= 1;
1663 if (PT
== last_point_position
- 1
1665 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1666 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1667 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1668 && (lose
>= 0x20 && lose
< 0x7f)))
1669 : (lose
>= 0x20 && lose
< 0x7f))
1670 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1672 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1674 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1676 && !windows_or_buffers_changed
1677 && EQ (current_buffer
->selective_display
, Qnil
)
1678 && !detect_input_pending ()
1679 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1680 && NILP (Vexecuting_macro
))
1681 direct_output_forward_char (-1);
1684 else if (EQ (Vthis_command
, Qself_insert_command
)
1685 /* Try this optimization only on char keystrokes. */
1686 && NATNUMP (last_command_char
)
1687 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1690 = translate_char (Vtranslation_table_for_input
,
1691 XFASTINT (last_command_char
), 0, 0, 0);
1693 if (NILP (Vexecuting_macro
)
1694 && !EQ (minibuf_window
, selected_window
))
1696 if (!nonundocount
|| nonundocount
>= 20)
1704 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1706 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1708 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1710 || MODIFF
<= SAVE_MODIFF
1711 || windows_or_buffers_changed
1712 || !EQ (current_buffer
->selective_display
, Qnil
)
1713 || detect_input_pending ()
1714 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1715 || !NILP (Vexecuting_macro
));
1717 value
= internal_self_insert (c
, 0);
1722 if (! NILP (Vpost_command_hook
))
1723 /* Put this before calling adjust_point_for_property
1724 so it will only get called once in any case. */
1727 /* VALUE == 1 when AFTER-CHANGE functions are
1728 installed which is the case most of the time
1729 because FONT-LOCK installs one. */
1730 if (!lose
&& !value
)
1731 direct_output_for_insert (c
);
1736 /* Here for a command that isn't executed directly */
1739 #ifdef HAVE_X_WINDOWS
1740 int scount
= SPECPDL_INDEX ();
1742 if (display_hourglass_p
1743 && NILP (Vexecuting_macro
))
1745 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1751 if (NILP (current_kboard
->Vprefix_arg
))
1753 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1755 #ifdef HAVE_X_WINDOWS
1756 /* Do not check display_hourglass_p here, because
1757 Fcommand_execute could change it, but we should cancel
1758 hourglass cursor anyway.
1759 But don't cancel the hourglass within a macro
1760 just because a command in the macro finishes. */
1761 if (NILP (Vexecuting_macro
))
1762 unbind_to (scount
, Qnil
);
1767 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1769 /* Note that the value cell will never directly contain nil
1770 if the symbol is a local variable. */
1771 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1772 safe_run_hooks (Qpost_command_hook
);
1774 /* If displaying a message, resize the echo area window to fit
1775 that message's size exactly. */
1776 if (!NILP (echo_area_buffer
[0]))
1777 resize_echo_area_exactly ();
1779 if (!NILP (Vdeferred_action_list
))
1780 safe_run_hooks (Qdeferred_action_function
);
1782 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1784 if (NILP (Vunread_command_events
)
1785 && NILP (Vunread_input_method_events
)
1786 && NILP (Vunread_post_input_method_events
)
1787 && NILP (Vexecuting_macro
)
1788 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1789 safe_run_hooks (Qpost_command_idle_hook
);
1792 /* If there is a prefix argument,
1793 1) We don't want Vlast_command to be ``universal-argument''
1794 (that would be dumb), so don't set Vlast_command,
1795 2) we want to leave echoing on so that the prefix will be
1796 echoed as part of this key sequence, so don't call
1798 3) we want to leave this_command_key_count non-zero, so that
1799 read_char will realize that it is re-reading a character, and
1800 not echo it a second time.
1802 If the command didn't actually create a prefix arg,
1803 but is merely a frame event that is transparent to prefix args,
1804 then the above doesn't apply. */
1805 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1807 current_kboard
->Vlast_command
= Vthis_command
;
1808 current_kboard
->Vreal_last_command
= real_this_command
;
1810 this_command_key_count
= 0;
1811 this_command_key_count_reset
= 0;
1812 this_single_command_key_start
= 0;
1815 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1817 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1819 /* We could also call `deactivate'mark'. */
1820 if (EQ (Vtransient_mark_mode
, Qlambda
))
1821 Vtransient_mark_mode
= Qnil
;
1824 current_buffer
->mark_active
= Qnil
;
1825 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1828 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1829 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1834 if (current_buffer
== prev_buffer
1835 && last_point_position
!= PT
1836 && NILP (Vdisable_point_adjustment
)
1837 && NILP (Vglobal_disable_point_adjustment
)
1838 && !already_adjusted
)
1839 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1841 /* Install chars successfully executed in kbd macro. */
1843 if (!NILP (current_kboard
->defining_kbd_macro
)
1844 && NILP (current_kboard
->Vprefix_arg
))
1845 finalize_kbd_macro_chars ();
1849 any_kboard_state ();
1854 extern Lisp_Object Qcomposition
, Qdisplay
;
1856 /* Adjust point to a boundary of a region that has such a property
1857 that should be treated intangible. For the moment, we check
1858 `composition', `display' and `invisible' properties.
1859 LAST_PT is the last position of point. */
1861 extern Lisp_Object Qafter_string
, Qbefore_string
;
1862 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1865 adjust_point_for_property (last_pt
, modified
)
1870 Lisp_Object val
, overlay
, tmp
;
1871 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1873 while (check_composition
|| check_display
|| check_invisible
)
1875 if (check_composition
1876 && PT
> BEGV
&& PT
< ZV
1877 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1878 && COMPOSITION_VALID_P (beg
, end
, val
)
1879 && beg
< PT
/* && end > PT <- It's always the case. */
1880 && (last_pt
<= beg
|| last_pt
>= end
))
1883 SET_PT (PT
< last_pt
? beg
: end
);
1884 check_display
= check_invisible
= 1;
1886 check_composition
= 0;
1888 && PT
> BEGV
&& PT
< ZV
1889 && !NILP (val
= get_char_property_and_overlay
1890 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1891 && display_prop_intangible_p (val
)
1892 && (!OVERLAYP (overlay
)
1893 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1894 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1895 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1896 && beg
< PT
) /* && end > PT <- It's always the case. */
1899 SET_PT (PT
< last_pt
? beg
: end
);
1900 check_composition
= check_invisible
= 1;
1903 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1905 int inv
, ellipsis
= 0;
1908 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1910 && !NILP (val
= get_char_property_and_overlay
1911 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1912 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1914 ellipsis
= ellipsis
|| inv
> 1
1915 || (OVERLAYP (overlay
)
1916 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1917 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1918 tmp
= Fnext_single_char_property_change
1919 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1920 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1923 && !NILP (val
= get_char_property_and_overlay
1924 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1925 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1927 ellipsis
= ellipsis
|| inv
> 1
1928 || (OVERLAYP (overlay
)
1929 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1930 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1931 tmp
= Fprevious_single_char_property_change
1932 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1933 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1936 /* Move away from the inside area. */
1937 if (beg
< PT
&& end
> PT
)
1939 SET_PT (PT
< last_pt
? beg
: end
);
1940 check_composition
= check_display
= 1;
1942 xassert (PT
== beg
|| PT
== end
);
1943 /* Pretend the area doesn't exist if the buffer is not
1945 if (!modified
&& !ellipsis
&& beg
< end
)
1947 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1948 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1949 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1950 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1951 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1952 /* We've already moved as far as we can. Trying to go
1953 to the other end would mean moving backwards and thus
1954 could lead to an infinite loop. */
1956 else if (val
= get_pos_property (make_number (PT
),
1958 TEXT_PROP_MEANS_INVISIBLE (val
)
1959 && (val
= get_pos_property
1960 (make_number (PT
== beg
? end
: beg
),
1962 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1963 (check_composition
= check_display
= 1,
1964 SET_PT (PT
== beg
? end
: beg
));
1967 check_invisible
= 0;
1971 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1974 safe_run_hooks_1 (hook
)
1977 return call1 (Vrun_hooks
, Vinhibit_quit
);
1980 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1983 safe_run_hooks_error (data
)
1986 return Fset (Vinhibit_quit
, Qnil
);
1989 /* If we get an error while running the hook, cause the hook variable
1990 to be nil. Also inhibit quits, so that C-g won't cause the hook
1991 to mysteriously evaporate. */
1994 safe_run_hooks (hook
)
1997 int count
= SPECPDL_INDEX ();
1998 specbind (Qinhibit_quit
, hook
);
2000 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2002 unbind_to (count
, Qnil
);
2006 /* Number of seconds between polling for input. This is a Lisp
2007 variable that can be bound. */
2009 EMACS_INT polling_period
;
2011 /* Nonzero means polling for input is temporarily suppressed. */
2013 int poll_suppress_count
;
2015 /* Asynchronous timer for polling. */
2017 struct atimer
*poll_timer
;
2020 #ifdef POLL_FOR_INPUT
2022 /* Poll for input, so what we catch a C-g if it comes in. This
2023 function is called from x_make_frame_visible, see comment
2029 if (interrupt_input_blocked
== 0
2030 && !waiting_for_input
)
2031 read_avail_input (0);
2034 /* Timer callback function for poll_timer. TIMER is equal to
2038 poll_for_input (timer
)
2039 struct atimer
*timer
;
2041 if (poll_suppress_count
== 0)
2042 poll_for_input_1 ();
2045 #endif /* POLL_FOR_INPUT */
2047 /* Begin signals to poll for input, if they are appropriate.
2048 This function is called unconditionally from various places. */
2053 #ifdef POLL_FOR_INPUT
2054 if (read_socket_hook
&& !interrupt_input
)
2056 /* Turn alarm handling on unconditionally. It might have
2057 been turned off in process.c. */
2058 turn_on_atimers (1);
2060 /* If poll timer doesn't exist, are we need one with
2061 a different interval, start a new one. */
2062 if (poll_timer
== NULL
2063 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2065 EMACS_TIME interval
;
2068 cancel_atimer (poll_timer
);
2070 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2071 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2072 poll_for_input
, NULL
);
2075 /* Let the timer's callback function poll for input
2076 if this becomes zero. */
2077 --poll_suppress_count
;
2082 /* Nonzero if we are using polling to handle input asynchronously. */
2085 input_polling_used ()
2087 #ifdef POLL_FOR_INPUT
2088 return read_socket_hook
&& !interrupt_input
;
2094 /* Turn off polling. */
2099 #ifdef POLL_FOR_INPUT
2100 if (read_socket_hook
&& !interrupt_input
)
2101 ++poll_suppress_count
;
2105 /* Set the value of poll_suppress_count to COUNT
2106 and start or stop polling accordingly. */
2109 set_poll_suppress_count (count
)
2112 #ifdef POLL_FOR_INPUT
2113 if (count
== 0 && poll_suppress_count
!= 0)
2115 poll_suppress_count
= 1;
2118 else if (count
!= 0 && poll_suppress_count
== 0)
2122 poll_suppress_count
= count
;
2126 /* Bind polling_period to a value at least N.
2127 But don't decrease it. */
2130 bind_polling_period (n
)
2133 #ifdef POLL_FOR_INPUT
2134 int new = polling_period
;
2139 stop_other_atimers (poll_timer
);
2141 specbind (Qpolling_period
, make_number (new));
2142 /* Start a new alarm with the new period. */
2147 /* Apply the control modifier to CHARACTER. */
2153 /* Save the upper bits here. */
2154 int upper
= c
& ~0177;
2158 /* Everything in the columns containing the upper-case letters
2159 denotes a control character. */
2160 if (c
>= 0100 && c
< 0140)
2164 /* Set the shift modifier for a control char
2165 made from a shifted letter. But only for letters! */
2166 if (oc
>= 'A' && oc
<= 'Z')
2167 c
|= shift_modifier
;
2170 /* The lower-case letters denote control characters too. */
2171 else if (c
>= 'a' && c
<= 'z')
2174 /* Include the bits for control and shift
2175 only if the basic ASCII code can't indicate them. */
2179 /* Replace the high bits. */
2180 c
|= (upper
& ~ctrl_modifier
);
2185 /* Display help echo in the echo area.
2187 HELP a string means display that string, HELP nil means clear the
2188 help echo. If HELP is a function, call it with OBJECT and POS as
2189 arguments; the function should return a help string or nil for
2190 none. For all other types of HELP evaluate it to obtain a string.
2192 WINDOW is the window in which the help was generated, if any.
2193 It is nil if not in a window.
2195 If OBJECT is a buffer, POS is the position in the buffer where the
2196 `help-echo' text property was found.
2198 If OBJECT is an overlay, that overlay has a `help-echo' property,
2199 and POS is the position in the overlay's buffer under the mouse.
2201 If OBJECT is a string (an overlay string or a string displayed with
2202 the `display' property). POS is the position in that string under
2205 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2206 echo overwrites a keystroke echo currently displayed in the echo
2209 Note: this function may only be called with HELP nil or a string
2210 from X code running asynchronously. */
2213 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2214 Lisp_Object help
, window
, object
, pos
;
2215 int ok_to_overwrite_keystroke_echo
;
2217 if (!NILP (help
) && !STRINGP (help
))
2219 if (FUNCTIONP (help
))
2221 Lisp_Object args
[4];
2226 help
= safe_call (4, args
);
2229 help
= safe_eval (help
);
2231 if (!STRINGP (help
))
2235 if (STRINGP (help
) || NILP (help
))
2237 if (!NILP (Vshow_help_function
))
2238 call1 (Vshow_help_function
, help
);
2239 else if (/* Don't overwrite minibuffer contents. */
2240 !MINI_WINDOW_P (XWINDOW (selected_window
))
2241 /* Don't overwrite a keystroke echo. */
2242 && (NILP (echo_message_buffer
)
2243 || ok_to_overwrite_keystroke_echo
)
2244 /* Don't overwrite a prompt. */
2245 && !cursor_in_echo_area
)
2249 int count
= SPECPDL_INDEX ();
2251 if (!help_echo_showing_p
)
2252 Vpre_help_message
= current_message ();
2254 specbind (Qmessage_truncate_lines
, Qt
);
2255 message3_nolog (help
, SBYTES (help
),
2256 STRING_MULTIBYTE (help
));
2257 unbind_to (count
, Qnil
);
2259 else if (STRINGP (Vpre_help_message
))
2261 message3_nolog (Vpre_help_message
,
2262 SBYTES (Vpre_help_message
),
2263 STRING_MULTIBYTE (Vpre_help_message
));
2264 Vpre_help_message
= Qnil
;
2270 help_echo_showing_p
= STRINGP (help
);
2276 /* Input of single characters from keyboard */
2278 Lisp_Object
print_help ();
2279 static Lisp_Object
kbd_buffer_get_event ();
2280 static void record_char ();
2283 static jmp_buf wrong_kboard_jmpbuf
;
2286 #define STOP_POLLING \
2287 do { if (! polling_stopped_here) stop_polling (); \
2288 polling_stopped_here = 1; } while (0)
2290 #define RESUME_POLLING \
2291 do { if (polling_stopped_here) start_polling (); \
2292 polling_stopped_here = 0; } while (0)
2294 /* read a character from the keyboard; call the redisplay if needed */
2295 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2296 -1 means do not do redisplay, but do do autosaving.
2299 /* The arguments MAPS and NMAPS are for menu prompting.
2300 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2302 PREV_EVENT is the previous input event, or nil if we are reading
2303 the first event of a key sequence (or not reading a key sequence).
2304 If PREV_EVENT is t, that is a "magic" value that says
2305 not to run input methods, but in other respects to act as if
2306 not reading a key sequence.
2308 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2309 if we used a mouse menu to read the input, or zero otherwise. If
2310 USED_MOUSE_MENU is null, we don't dereference it.
2312 Value is t if we showed a menu and the user rejected it. */
2315 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2319 Lisp_Object prev_event
;
2320 int *used_mouse_menu
;
2322 volatile Lisp_Object c
;
2324 jmp_buf local_getcjmp
;
2326 volatile int key_already_recorded
= 0;
2327 Lisp_Object tem
, save
;
2328 volatile Lisp_Object previous_echo_area_message
;
2329 volatile Lisp_Object also_record
;
2330 volatile int reread
;
2331 struct gcpro gcpro1
, gcpro2
;
2332 EMACS_TIME last_idle_start
;
2333 int polling_stopped_here
= 0;
2337 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2338 before_command_key_count
= this_command_key_count
;
2339 before_command_echo_length
= echo_length ();
2342 previous_echo_area_message
= Qnil
;
2344 GCPRO2 (c
, previous_echo_area_message
);
2349 if (CONSP (Vunread_post_input_method_events
))
2351 c
= XCAR (Vunread_post_input_method_events
);
2352 Vunread_post_input_method_events
2353 = XCDR (Vunread_post_input_method_events
);
2355 /* Undo what read_char_x_menu_prompt did when it unread
2356 additional keys returned by Fx_popup_menu. */
2358 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2366 if (unread_command_char
!= -1)
2368 XSETINT (c
, unread_command_char
);
2369 unread_command_char
= -1;
2375 if (CONSP (Vunread_command_events
))
2377 c
= XCAR (Vunread_command_events
);
2378 Vunread_command_events
= XCDR (Vunread_command_events
);
2380 /* Undo what read_char_x_menu_prompt did when it unread
2381 additional keys returned by Fx_popup_menu. */
2383 && EQ (XCDR (c
), Qdisabled
)
2384 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2387 /* If the queued event is something that used the mouse,
2388 set used_mouse_menu accordingly. */
2390 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2391 *used_mouse_menu
= 1;
2394 goto reread_for_input_method
;
2397 if (CONSP (Vunread_input_method_events
))
2399 c
= XCAR (Vunread_input_method_events
);
2400 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2402 /* Undo what read_char_x_menu_prompt did when it unread
2403 additional keys returned by Fx_popup_menu. */
2405 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2409 goto reread_for_input_method
;
2412 this_command_key_count_reset
= 0;
2414 if (!NILP (Vexecuting_macro
))
2416 /* We set this to Qmacro; since that's not a frame, nobody will
2417 try to switch frames on us, and the selected window will
2420 Since this event came from a macro, it would be misleading to
2421 leave internal_last_event_frame set to wherever the last
2422 real event came from. Normally, a switch-frame event selects
2423 internal_last_event_frame after each command is read, but
2424 events read from a macro should never cause a new frame to be
2426 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2428 /* Exit the macro if we are at the end.
2429 Also, some things replace the macro with t
2430 to force an early exit. */
2431 if (EQ (Vexecuting_macro
, Qt
)
2432 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2438 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2439 if (STRINGP (Vexecuting_macro
)
2440 && (XINT (c
) & 0x80))
2441 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2443 executing_macro_index
++;
2448 if (!NILP (unread_switch_frame
))
2450 c
= unread_switch_frame
;
2451 unread_switch_frame
= Qnil
;
2453 /* This event should make it into this_command_keys, and get echoed
2454 again, so we do not set `reread'. */
2458 /* if redisplay was requested */
2459 if (commandflag
>= 0)
2461 /* If there is pending input, process any events which are not
2462 user-visible, such as X selection_request events. */
2464 || detect_input_pending_run_timers (0))
2465 swallow_events (0); /* may clear input_pending */
2467 /* Redisplay if no pending input. */
2468 while (!input_pending
)
2470 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2471 redisplay_preserve_echo_area (5);
2476 /* Normal case: no input arrived during redisplay. */
2479 /* Input arrived and pre-empted redisplay.
2480 Process any events which are not user-visible. */
2482 /* If that cleared input_pending, try again to redisplay. */
2486 /* Message turns off echoing unless more keystrokes turn it on again.
2488 The code in 20.x for the condition was
2490 1. echo_area_glyphs && *echo_area_glyphs
2491 2. && echo_area_glyphs != current_kboard->echobuf
2492 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2494 (1) means there's a current message displayed
2496 (2) means it's not the message from echoing from the current
2499 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2500 is set to a non-null value. This is done in read_char and it is
2501 set to echo_area_glyphs after a call to echo_char. That means
2502 ok_to_echo_at_next_pause is either null or
2503 current_kboard->echobuf with the appropriate current_kboard at
2506 So, condition (3) means in clear text ok_to_echo_at_next_pause
2507 must be either null, or the current message isn't from echoing at
2508 all, or it's from echoing from a different kboard than the
2511 if (/* There currently is something in the echo area. */
2512 !NILP (echo_area_buffer
[0])
2513 && (/* And it's either not from echoing. */
2514 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2515 /* Or it's an echo from a different kboard. */
2516 || echo_kboard
!= current_kboard
2517 /* Or we explicitly allow overwriting whatever there is. */
2518 || ok_to_echo_at_next_pause
== NULL
))
2523 /* Try reading a character via menu prompting in the minibuf.
2524 Try this before the sit-for, because the sit-for
2525 would do the wrong thing if we are supposed to do
2526 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2527 after a mouse event so don't try a minibuf menu. */
2529 if (nmaps
> 0 && INTERACTIVE
2530 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2531 /* Don't bring up a menu if we already have another event. */
2532 && NILP (Vunread_command_events
)
2533 && unread_command_char
< 0
2534 && !detect_input_pending_run_timers (0))
2536 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2539 key_already_recorded
= 1;
2544 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2545 We will do that below, temporarily for short sections of code,
2546 when appropriate. local_getcjmp must be in effect
2547 around any call to sit_for or kbd_buffer_get_event;
2548 it *must not* be in effect when we call redisplay. */
2550 if (_setjmp (local_getcjmp
))
2552 XSETINT (c
, quit_char
);
2553 internal_last_event_frame
= selected_frame
;
2554 Vlast_event_frame
= internal_last_event_frame
;
2555 /* If we report the quit char as an event,
2556 don't do so more than once. */
2557 if (!NILP (Vinhibit_quit
))
2562 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2563 if (kb
!= current_kboard
)
2565 Lisp_Object link
= kb
->kbd_queue
;
2566 /* We shouldn't get here if we were in single-kboard mode! */
2571 while (CONSP (XCDR (link
)))
2573 if (!NILP (XCDR (link
)))
2577 kb
->kbd_queue
= Fcons (c
, Qnil
);
2579 XSETCDR (link
, Fcons (c
, Qnil
));
2580 kb
->kbd_queue_has_data
= 1;
2581 current_kboard
= kb
;
2582 /* This is going to exit from read_char
2583 so we had better get rid of this frame's stuff. */
2585 longjmp (wrong_kboard_jmpbuf
, 1);
2592 timer_start_idle ();
2594 /* If in middle of key sequence and minibuffer not active,
2595 start echoing if enough time elapses. */
2597 if (minibuf_level
== 0
2598 && !current_kboard
->immediate_echo
2599 && this_command_key_count
> 0
2601 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2602 && NILP (Fzerop (Vecho_keystrokes
))
2603 && (/* No message. */
2604 NILP (echo_area_buffer
[0])
2605 /* Or empty message. */
2606 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2607 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2608 /* Or already echoing from same kboard. */
2609 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2610 /* Or not echoing before and echoing allowed. */
2611 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2615 /* After a mouse event, start echoing right away.
2616 This is because we are probably about to display a menu,
2617 and we don't want to delay before doing so. */
2618 if (EVENT_HAS_PARAMETERS (prev_event
))
2623 double duration
= extract_float (Vecho_keystrokes
);
2624 sec
= (int) duration
;
2625 usec
= (duration
- sec
) * 1000000;
2626 save_getcjmp (save_jump
);
2627 restore_getcjmp (local_getcjmp
);
2628 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2629 restore_getcjmp (save_jump
);
2631 && ! CONSP (Vunread_command_events
))
2636 /* Maybe auto save due to number of keystrokes. */
2638 if (commandflag
!= 0
2639 && auto_save_interval
> 0
2640 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2641 && !detect_input_pending_run_timers (0))
2643 Fdo_auto_save (Qnil
, Qnil
);
2644 /* Hooks can actually change some buffers in auto save. */
2648 /* Try reading using an X menu.
2649 This is never confused with reading using the minibuf
2650 because the recursive call of read_char in read_char_minibuf_menu_prompt
2651 does not pass on any keymaps. */
2653 if (nmaps
> 0 && INTERACTIVE
2654 && !NILP (prev_event
)
2655 && EVENT_HAS_PARAMETERS (prev_event
)
2656 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2657 && !EQ (XCAR (prev_event
), Qtool_bar
)
2658 /* Don't bring up a menu if we already have another event. */
2659 && NILP (Vunread_command_events
)
2660 && unread_command_char
< 0)
2662 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2664 /* Now that we have read an event, Emacs is not idle. */
2670 /* Maybe autosave and/or garbage collect due to idleness. */
2672 if (INTERACTIVE
&& NILP (c
))
2674 int delay_level
, buffer_size
;
2676 /* Slow down auto saves logarithmically in size of current buffer,
2677 and garbage collect while we're at it. */
2678 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2679 last_non_minibuf_size
= Z
- BEG
;
2680 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2682 while (buffer_size
> 64)
2683 delay_level
++, buffer_size
-= buffer_size
>> 2;
2684 if (delay_level
< 4) delay_level
= 4;
2685 /* delay_level is 4 for files under around 50k, 7 at 100k,
2686 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2688 /* Auto save if enough time goes by without input. */
2689 if (commandflag
!= 0
2690 && num_nonmacro_input_events
> last_auto_save
2691 && INTEGERP (Vauto_save_timeout
)
2692 && XINT (Vauto_save_timeout
) > 0)
2696 save_getcjmp (save_jump
);
2697 restore_getcjmp (local_getcjmp
);
2698 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2700 restore_getcjmp (save_jump
);
2703 && ! CONSP (Vunread_command_events
))
2705 Fdo_auto_save (Qnil
, Qnil
);
2707 /* If we have auto-saved and there is still no input
2708 available, garbage collect if there has been enough
2709 consing going on to make it worthwhile. */
2710 if (!detect_input_pending_run_timers (0)
2711 && consing_since_gc
> gc_cons_threshold
/ 2)
2712 Fgarbage_collect ();
2719 /* If this has become non-nil here, it has been set by a timer
2720 or sentinel or filter. */
2721 if (CONSP (Vunread_command_events
))
2723 c
= XCAR (Vunread_command_events
);
2724 Vunread_command_events
= XCDR (Vunread_command_events
);
2727 /* Read something from current KBOARD's side queue, if possible. */
2731 if (current_kboard
->kbd_queue_has_data
)
2733 if (!CONSP (current_kboard
->kbd_queue
))
2735 c
= XCAR (current_kboard
->kbd_queue
);
2736 current_kboard
->kbd_queue
2737 = XCDR (current_kboard
->kbd_queue
);
2738 if (NILP (current_kboard
->kbd_queue
))
2739 current_kboard
->kbd_queue_has_data
= 0;
2740 input_pending
= readable_events (0);
2741 if (EVENT_HAS_PARAMETERS (c
)
2742 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2743 internal_last_event_frame
= XCAR (XCDR (c
));
2744 Vlast_event_frame
= internal_last_event_frame
;
2749 /* If current_kboard's side queue is empty check the other kboards.
2750 If one of them has data that we have not yet seen here,
2751 switch to it and process the data waiting for it.
2753 Note: if the events queued up for another kboard
2754 have already been seen here, and therefore are not a complete command,
2755 the kbd_queue_has_data field is 0, so we skip that kboard here.
2756 That's to avoid an infinite loop switching between kboards here. */
2757 if (NILP (c
) && !single_kboard
)
2760 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2761 if (kb
->kbd_queue_has_data
)
2763 current_kboard
= kb
;
2764 /* This is going to exit from read_char
2765 so we had better get rid of this frame's stuff. */
2767 longjmp (wrong_kboard_jmpbuf
, 1);
2776 /* Finally, we read from the main queue,
2777 and if that gives us something we can't use yet, we put it on the
2778 appropriate side queue and try again. */
2784 /* Actually read a character, waiting if necessary. */
2785 save_getcjmp (save_jump
);
2786 restore_getcjmp (local_getcjmp
);
2787 timer_start_idle ();
2788 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2789 restore_getcjmp (save_jump
);
2792 if (! NILP (c
) && (kb
!= current_kboard
))
2794 Lisp_Object link
= kb
->kbd_queue
;
2797 while (CONSP (XCDR (link
)))
2799 if (!NILP (XCDR (link
)))
2803 kb
->kbd_queue
= Fcons (c
, Qnil
);
2805 XSETCDR (link
, Fcons (c
, Qnil
));
2806 kb
->kbd_queue_has_data
= 1;
2810 current_kboard
= kb
;
2811 /* This is going to exit from read_char
2812 so we had better get rid of this frame's stuff. */
2814 longjmp (wrong_kboard_jmpbuf
, 1);
2819 /* Terminate Emacs in batch mode if at eof. */
2820 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2821 Fkill_emacs (make_number (1));
2825 /* Add in any extra modifiers, where appropriate. */
2826 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2827 || ((extra_keyboard_modifiers
& 0177) < ' '
2828 && (extra_keyboard_modifiers
& 0177) != 0))
2829 XSETINT (c
, make_ctrl_char (XINT (c
)));
2831 /* Transfer any other modifier bits directly from
2832 extra_keyboard_modifiers to c. Ignore the actual character code
2833 in the low 16 bits of extra_keyboard_modifiers. */
2834 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2839 /* Record the last idle start time so that we can reset it
2840 should the next event read be a help-echo. */
2841 last_idle_start
= timer_idleness_start_time
;
2847 if (commandflag
>= 0
2848 && !input_pending
&& !detect_input_pending_run_timers (0))
2856 /* Buffer switch events are only for internal wakeups
2857 so don't show them to the user.
2858 Also, don't record a key if we already did. */
2859 if (BUFFERP (c
) || key_already_recorded
)
2862 /* Process special events within read_char
2863 and loop around to read another event. */
2866 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2871 int was_locked
= single_kboard
;
2873 last_input_char
= c
;
2874 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2876 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2877 /* We stopped being idle for this event; undo that. This
2878 prevents automatic window selection (under
2879 mouse_autoselect_window from acting as a real input event, for
2880 example banishing the mouse under mouse-avoidance-mode. */
2881 timer_idleness_start_time
= last_idle_start
;
2883 /* Resume allowing input from any kboard, if that was true before. */
2885 any_kboard_state ();
2890 /* Handle things that only apply to characters. */
2893 /* If kbd_buffer_get_event gave us an EOF, return that. */
2897 if ((STRINGP (Vkeyboard_translate_table
)
2898 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2899 || (VECTORP (Vkeyboard_translate_table
)
2900 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2901 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2902 && CHAR_VALID_P (XINT (c
), 0)))
2905 d
= Faref (Vkeyboard_translate_table
, c
);
2906 /* nil in keyboard-translate-table means no translation. */
2912 /* If this event is a mouse click in the menu bar,
2913 return just menu-bar for now. Modify the mouse click event
2914 so we won't do this twice, then queue it up. */
2915 if (EVENT_HAS_PARAMETERS (c
)
2917 && CONSP (EVENT_START (c
))
2918 && CONSP (XCDR (EVENT_START (c
))))
2922 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2923 /* Handle menu-bar events:
2924 insert the dummy prefix event `menu-bar'. */
2925 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2927 /* Change menu-bar to (menu-bar) as the event "position". */
2928 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2931 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2936 /* Store these characters into recent_keys, the dribble file if any,
2937 and the keyboard macro being defined, if any. */
2939 if (! NILP (also_record
))
2940 record_char (also_record
);
2942 /* Wipe the echo area.
2943 But first, if we are about to use an input method,
2944 save the echo area contents for it to refer to. */
2946 && ! NILP (Vinput_method_function
)
2947 && (unsigned) XINT (c
) >= ' '
2948 && (unsigned) XINT (c
) != 127
2949 && (unsigned) XINT (c
) < 256)
2951 previous_echo_area_message
= Fcurrent_message ();
2952 Vinput_method_previous_message
= previous_echo_area_message
;
2955 /* Now wipe the echo area, except for help events which do their
2956 own stuff with the echo area. */
2958 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2959 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2961 if (!NILP (echo_area_buffer
[0]))
2962 safe_run_hooks (Qecho_area_clear_hook
);
2963 clear_message (1, 0);
2966 reread_for_input_method
:
2968 /* Pass this to the input method, if appropriate. */
2970 && ! NILP (Vinput_method_function
)
2971 /* Don't run the input method within a key sequence,
2972 after the first event of the key sequence. */
2973 && NILP (prev_event
)
2974 && (unsigned) XINT (c
) >= ' '
2975 && (unsigned) XINT (c
) != 127
2976 && (unsigned) XINT (c
) < 256)
2979 int key_count
, key_count_reset
;
2980 struct gcpro gcpro1
;
2981 int count
= SPECPDL_INDEX ();
2983 /* Save the echo status. */
2984 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2985 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2986 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2989 if (before_command_restore_flag
)
2991 this_command_key_count
= before_command_key_count_1
;
2992 if (this_command_key_count
< this_single_command_key_start
)
2993 this_single_command_key_start
= this_command_key_count
;
2994 echo_truncate (before_command_echo_length_1
);
2995 before_command_restore_flag
= 0;
2999 /* Save the this_command_keys status. */
3000 key_count
= this_command_key_count
;
3001 key_count_reset
= this_command_key_count_reset
;
3004 keys
= Fcopy_sequence (this_command_keys
);
3009 /* Clear out this_command_keys. */
3010 this_command_key_count
= 0;
3011 this_command_key_count_reset
= 0;
3013 /* Now wipe the echo area. */
3014 if (!NILP (echo_area_buffer
[0]))
3015 safe_run_hooks (Qecho_area_clear_hook
);
3016 clear_message (1, 0);
3019 /* If we are not reading a key sequence,
3020 never use the echo area. */
3023 specbind (Qinput_method_use_echo_area
, Qt
);
3026 /* Call the input method. */
3027 tem
= call1 (Vinput_method_function
, c
);
3029 tem
= unbind_to (count
, tem
);
3031 /* Restore the saved echoing state
3032 and this_command_keys state. */
3033 this_command_key_count
= key_count
;
3034 this_command_key_count_reset
= key_count_reset
;
3036 this_command_keys
= keys
;
3039 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3040 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3041 if (saved_immediate_echo
)
3046 /* The input method can return no events. */
3049 /* Bring back the previous message, if any. */
3050 if (! NILP (previous_echo_area_message
))
3051 message_with_string ("%s", previous_echo_area_message
, 0);
3054 /* It returned one event or more. */
3056 Vunread_post_input_method_events
3057 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3062 /* Display help if not echoing. */
3063 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3065 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3066 Lisp_Object help
, object
, position
, window
, tem
;
3068 tem
= Fcdr (XCDR (c
));
3071 window
= Fcar (tem
);
3073 object
= Fcar (tem
);
3075 position
= Fcar (tem
);
3077 show_help_echo (help
, window
, object
, position
, 0);
3079 /* We stopped being idle for this event; undo that. */
3080 timer_idleness_start_time
= last_idle_start
;
3084 if (! reread
|| this_command_key_count
== 0
3085 || this_command_key_count_reset
)
3088 /* Don't echo mouse motion events. */
3089 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3090 && NILP (Fzerop (Vecho_keystrokes
))
3091 && ! (EVENT_HAS_PARAMETERS (c
)
3092 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3095 if (! NILP (also_record
))
3096 echo_char (also_record
);
3097 /* Once we reread a character, echoing can happen
3098 the next time we pause to read a new one. */
3099 ok_to_echo_at_next_pause
= current_kboard
;
3102 /* Record this character as part of the current key. */
3103 add_command_key (c
);
3104 if (! NILP (also_record
))
3105 add_command_key (also_record
);
3108 last_input_char
= c
;
3111 /* Process the help character specially if enabled */
3112 if (!NILP (Vhelp_form
) && help_char_p (c
))
3115 count
= SPECPDL_INDEX ();
3117 record_unwind_protect (Fset_window_configuration
,
3118 Fcurrent_window_configuration (Qnil
));
3120 tem0
= Feval (Vhelp_form
);
3122 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3126 c
= read_char (0, 0, 0, Qnil
, 0);
3127 while (BUFFERP (c
));
3128 /* Remove the help from the frame */
3129 unbind_to (count
, Qnil
);
3132 if (EQ (c
, make_number (040)))
3136 c
= read_char (0, 0, 0, Qnil
, 0);
3137 while (BUFFERP (c
));
3146 /* Record a key that came from a mouse menu.
3147 Record it for echoing, for this-command-keys, and so on. */
3153 /* Wipe the echo area. */
3154 clear_message (1, 0);
3159 before_command_key_count
= this_command_key_count
;
3160 before_command_echo_length
= echo_length ();
3163 /* Don't echo mouse motion events. */
3164 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3165 && NILP (Fzerop (Vecho_keystrokes
)))
3169 /* Once we reread a character, echoing can happen
3170 the next time we pause to read a new one. */
3171 ok_to_echo_at_next_pause
= 0;
3174 /* Record this character as part of the current key. */
3175 add_command_key (c
);
3177 /* Re-reading in the middle of a command */
3178 last_input_char
= c
;
3182 /* Return 1 if should recognize C as "the help character". */
3190 if (EQ (c
, Vhelp_char
))
3192 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3193 if (EQ (c
, XCAR (tail
)))
3198 /* Record the input event C in various ways. */
3206 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3208 /* To avoid filling recent_keys with help-echo and mouse-movement
3209 events, we filter out repeated help-echo events, only store the
3210 first and last in a series of mouse-movement events, and don't
3211 store repeated help-echo events which are only separated by
3212 mouse-movement events. */
3214 Lisp_Object ev1
, ev2
, ev3
;
3217 if ((ix1
= recent_keys_index
- 1) < 0)
3218 ix1
= NUM_RECENT_KEYS
- 1;
3219 ev1
= AREF (recent_keys
, ix1
);
3221 if ((ix2
= ix1
- 1) < 0)
3222 ix2
= NUM_RECENT_KEYS
- 1;
3223 ev2
= AREF (recent_keys
, ix2
);
3225 if ((ix3
= ix2
- 1) < 0)
3226 ix3
= NUM_RECENT_KEYS
- 1;
3227 ev3
= AREF (recent_keys
, ix3
);
3229 if (EQ (XCAR (c
), Qhelp_echo
))
3231 /* Don't record `help-echo' in recent_keys unless it shows some help
3232 message, and a different help than the previously recorded
3234 Lisp_Object help
, last_help
;
3236 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3237 if (!STRINGP (help
))
3239 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3240 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3242 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3243 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3244 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3246 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3247 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3248 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3249 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3252 else if (EQ (XCAR (c
), Qmouse_movement
))
3254 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3255 So additional mouse movement events replace the last element. */
3256 Lisp_Object last_window
, window
;
3258 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3259 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3260 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3261 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3262 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3264 ASET (recent_keys
, ix1
, c
);
3270 store_kbd_macro_char (c
);
3275 ASET (recent_keys
, recent_keys_index
, c
);
3276 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3277 recent_keys_index
= 0;
3279 else if (recorded
< 0)
3281 /* We need to remove one or two events from recent_keys.
3282 To do this, we simply put nil at those events and move the
3283 recent_keys_index backwards over those events. Usually,
3284 users will never see those nil events, as they will be
3285 overwritten by the command keys entered to see recent_keys
3288 while (recorded
++ < 0 && total_keys
> 0)
3290 if (total_keys
< NUM_RECENT_KEYS
)
3292 if (--recent_keys_index
< 0)
3293 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3294 ASET (recent_keys
, recent_keys_index
, Qnil
);
3298 num_nonmacro_input_events
++;
3300 /* Write c to the dribble file. If c is a lispy event, write
3301 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3302 If you, dear reader, have a better idea, you've got the source. :-) */
3307 if (XUINT (c
) < 0x100)
3308 putc (XINT (c
), dribble
);
3310 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3314 Lisp_Object dribblee
;
3316 /* If it's a structured event, take the event header. */
3317 dribblee
= EVENT_HEAD (c
);
3319 if (SYMBOLP (dribblee
))
3321 putc ('<', dribble
);
3322 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3323 SBYTES (SYMBOL_NAME (dribblee
)),
3325 putc ('>', dribble
);
3337 struct buffer
*old
= current_buffer
;
3338 Fprinc (object
, Qnil
);
3339 set_buffer_internal (XBUFFER (Vstandard_output
));
3340 call0 (intern ("help-mode"));
3341 set_buffer_internal (old
);
3345 /* Copy out or in the info on where C-g should throw to.
3346 This is used when running Lisp code from within get_char,
3347 in case get_char is called recursively.
3348 See read_process_output. */
3354 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3358 restore_getcjmp (temp
)
3361 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3366 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3367 of this function. */
3370 tracking_off (old_value
)
3371 Lisp_Object old_value
;
3373 do_mouse_tracking
= old_value
;
3374 if (NILP (old_value
))
3376 /* Redisplay may have been preempted because there was input
3377 available, and it assumes it will be called again after the
3378 input has been processed. If the only input available was
3379 the sort that we have just disabled, then we need to call
3381 if (!readable_events (1))
3383 redisplay_preserve_echo_area (6);
3384 get_input_pending (&input_pending
, 1);
3390 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3391 doc
: /* Evaluate BODY with mouse movement events enabled.
3392 Within a `track-mouse' form, mouse motion generates input events that
3393 you can read with `read-event'.
3394 Normally, mouse motion is ignored.
3395 usage: (track-mouse BODY ...) */)
3399 int count
= SPECPDL_INDEX ();
3402 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3404 do_mouse_tracking
= Qt
;
3406 val
= Fprogn (args
);
3407 return unbind_to (count
, val
);
3410 /* If mouse has moved on some frame, return one of those frames.
3411 Return 0 otherwise. */
3416 Lisp_Object tail
, frame
;
3418 FOR_EACH_FRAME (tail
, frame
)
3420 if (XFRAME (frame
)->mouse_moved
)
3421 return XFRAME (frame
);
3427 #endif /* HAVE_MOUSE */
3429 /* Low level keyboard/mouse input.
3430 kbd_buffer_store_event places events in kbd_buffer, and
3431 kbd_buffer_get_event retrieves them. */
3433 /* Return true iff there are any events in the queue that read-char
3434 would return. If this returns false, a read-char would block. */
3436 readable_filtered_events (do_timers_now
, filter_events
)
3441 timer_check (do_timers_now
);
3443 /* If the buffer contains only FOCUS_IN_EVENT events,
3444 and FILTER_EVENTS is nonzero, report it as empty. */
3445 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3447 int have_live_event
= 1;
3451 struct input_event
*event
;
3453 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3457 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3460 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3462 if (event
== kbd_store_ptr
)
3463 have_live_event
= 0;
3466 if (have_live_event
) return 1;
3470 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3475 if (current_kboard
->kbd_queue_has_data
)
3481 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3482 if (kb
->kbd_queue_has_data
)
3488 /* Return true iff there are any events in the queue that read-char
3489 would return. If this returns false, a read-char would block. */
3491 readable_events (do_timers_now
)
3494 return readable_filtered_events (do_timers_now
, 0);
3497 /* Set this for debugging, to have a way to get out */
3502 event_to_kboard (event
)
3503 struct input_event
*event
;
3506 frame
= event
->frame_or_window
;
3508 frame
= XCAR (frame
);
3509 else if (WINDOWP (frame
))
3510 frame
= WINDOW_FRAME (XWINDOW (frame
));
3512 /* There are still some events that don't set this field.
3513 For now, just ignore the problem.
3514 Also ignore dead frames here. */
3515 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3518 return FRAME_KBOARD (XFRAME (frame
));
3522 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3525 kbd_buffer_store_event (event
)
3526 register struct input_event
*event
;
3528 if (event
->kind
== NO_EVENT
)
3531 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3533 register int c
= event
->code
& 0377;
3535 if (event
->modifiers
& ctrl_modifier
)
3536 c
= make_ctrl_char (c
);
3538 c
|= (event
->modifiers
3539 & (meta_modifier
| alt_modifier
3540 | hyper_modifier
| super_modifier
));
3546 struct input_event
*sp
;
3549 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3550 kb
!= current_kboard
))
3553 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3554 Fcons (make_number (c
), Qnil
));
3555 kb
->kbd_queue_has_data
= 1;
3556 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3558 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3561 if (event_to_kboard (sp
) == kb
)
3563 sp
->kind
= NO_EVENT
;
3564 sp
->frame_or_window
= Qnil
;
3572 /* If this results in a quit_char being returned to Emacs as
3573 input, set Vlast_event_frame properly. If this doesn't
3574 get returned to Emacs as an event, the next event read
3575 will set Vlast_event_frame again, so this is safe to do. */
3579 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3581 focus
= event
->frame_or_window
;
3582 internal_last_event_frame
= focus
;
3583 Vlast_event_frame
= focus
;
3586 last_event_timestamp
= event
->timestamp
;
3587 interrupt_signal (0 /* dummy */);
3591 if (c
&& c
== stop_character
)
3597 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3598 Just ignore the second one. */
3599 else if (event
->kind
== BUFFER_SWITCH_EVENT
3600 && kbd_fetch_ptr
!= kbd_store_ptr
3601 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3604 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3605 kbd_store_ptr
= kbd_buffer
;
3607 /* Don't let the very last slot in the buffer become full,
3608 since that would make the two pointers equal,
3609 and that is indistinguishable from an empty buffer.
3610 Discard the event if it would fill the last slot. */
3611 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3615 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3616 prone to assign individual members for other events, in case
3617 the input_event structure is changed. --2000-07-13, gerd. */
3618 struct input_event
*sp
= kbd_store_ptr
;
3619 sp
->kind
= event
->kind
;
3620 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3622 /* We must not use the ordinary copying code for this case,
3623 since `part' is an enum and copying it might not copy enough
3625 bcopy (event
, (char *) sp
, sizeof (*event
));
3630 sp
->code
= event
->code
;
3631 sp
->part
= event
->part
;
3632 sp
->frame_or_window
= event
->frame_or_window
;
3633 sp
->arg
= event
->arg
;
3634 sp
->modifiers
= event
->modifiers
;
3637 sp
->timestamp
= event
->timestamp
;
3640 *kbd_store_ptr
= *event
;
3643 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3644 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3645 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3651 /* Generate HELP_EVENT input_events in BUFP which has room for
3652 SIZE events. If there's not enough room in BUFP, ignore this
3655 HELP is the help form.
3657 FRAME is the frame on which the help is generated. OBJECT is the
3658 Lisp object where the help was found (a buffer, a string, an
3659 overlay, or nil if neither from a string nor from a buffer. POS is
3660 the position within OBJECT where the help was found.
3662 Value is the number of input_events generated. */
3665 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3666 struct input_event
*bufp
;
3668 Lisp_Object help
, frame
, object
, window
;
3673 bufp
->kind
= HELP_EVENT
;
3674 bufp
->frame_or_window
= frame
;
3676 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3685 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3688 kbd_buffer_store_help_event (frame
, help
)
3689 Lisp_Object frame
, help
;
3691 struct input_event event
;
3693 event
.kind
= HELP_EVENT
;
3694 event
.frame_or_window
= frame
;
3699 kbd_buffer_store_event (&event
);
3703 /* Discard any mouse events in the event buffer by setting them to
3706 discard_mouse_events ()
3708 struct input_event
*sp
;
3709 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3711 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3714 if (sp
->kind
== MOUSE_CLICK_EVENT
3716 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3718 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3720 sp
->kind
= NO_EVENT
;
3726 /* Return non-zero if there are any real events waiting in the event
3727 buffer, not counting `NO_EVENT's.
3729 If DISCARD is non-zero, discard NO_EVENT events at the front of
3730 the input queue, possibly leaving the input queue empty if there
3731 are no real input events. */
3734 kbd_buffer_events_waiting (discard
)
3737 struct input_event
*sp
;
3739 for (sp
= kbd_fetch_ptr
;
3740 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3743 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3750 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3754 /* Clear input event EVENT. */
3758 struct input_event
*event
;
3760 int idx
= 2 * (event
- kbd_buffer
);
3761 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3762 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3763 event
->kind
= NO_EVENT
;
3767 /* Read one event from the event buffer, waiting if necessary.
3768 The value is a Lisp object representing the event.
3769 The value is nil for an event that should be ignored,
3770 or that was handled here.
3771 We always read and discard one event. */
3774 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3776 int *used_mouse_menu
;
3785 *kbp
= current_kboard
;
3789 /* Wait until there is input available. */
3792 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3795 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3799 /* If the quit flag is set, then read_char will return
3800 quit_char, so that counts as "available input." */
3801 if (!NILP (Vquit_flag
))
3802 quit_throw_to_read_char ();
3804 /* One way or another, wait until input is available; then, if
3805 interrupt handlers have not read it, read it now. */
3808 wait_for_kbd_input ();
3810 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3814 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3817 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3821 Lisp_Object minus_one
;
3823 XSETINT (minus_one
, -1);
3824 wait_reading_process_input (0, 0, minus_one
, 1);
3826 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3827 /* Pass 1 for EXPECT since we just waited to have input. */
3828 read_avail_input (1);
3830 #endif /* not VMS */
3833 if (CONSP (Vunread_command_events
))
3836 first
= XCAR (Vunread_command_events
);
3837 Vunread_command_events
= XCDR (Vunread_command_events
);
3838 *kbp
= current_kboard
;
3842 /* At this point, we know that there is a readable event available
3843 somewhere. If the event queue is empty, then there must be a
3844 mouse movement enabled and available. */
3845 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3847 struct input_event
*event
;
3849 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3853 last_event_timestamp
= event
->timestamp
;
3856 *kbp
= event_to_kboard (event
);
3858 *kbp
= current_kboard
; /* Better than returning null ptr? */
3860 *kbp
= &the_only_kboard
;
3865 /* These two kinds of events get special handling
3866 and don't actually appear to the command loop.
3867 We return nil for them. */
3868 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3871 struct input_event copy
;
3873 /* Remove it from the buffer before processing it,
3874 since otherwise swallow_events will see it
3875 and process it again. */
3877 kbd_fetch_ptr
= event
+ 1;
3878 input_pending
= readable_events (0);
3879 x_handle_selection_request (©
);
3881 /* We're getting selection request events, but we don't have
3887 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3890 struct input_event copy
;
3892 /* Remove it from the buffer before processing it. */
3894 kbd_fetch_ptr
= event
+ 1;
3895 input_pending
= readable_events (0);
3896 x_handle_selection_clear (©
);
3898 /* We're getting selection request events, but we don't have
3903 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3904 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3906 /* Make an event (delete-frame (FRAME)). */
3907 obj
= Fcons (event
->frame_or_window
, Qnil
);
3908 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3909 kbd_fetch_ptr
= event
+ 1;
3912 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3913 else if (event
->kind
== ICONIFY_EVENT
)
3915 /* Make an event (iconify-frame (FRAME)). */
3916 obj
= Fcons (event
->frame_or_window
, Qnil
);
3917 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3918 kbd_fetch_ptr
= event
+ 1;
3920 else if (event
->kind
== DEICONIFY_EVENT
)
3922 /* Make an event (make-frame-visible (FRAME)). */
3923 obj
= Fcons (event
->frame_or_window
, Qnil
);
3924 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3925 kbd_fetch_ptr
= event
+ 1;
3928 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3930 /* The value doesn't matter here; only the type is tested. */
3931 XSETBUFFER (obj
, current_buffer
);
3932 kbd_fetch_ptr
= event
+ 1;
3934 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3935 || defined (USE_GTK)
3936 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3938 kbd_fetch_ptr
= event
+ 1;
3939 input_pending
= readable_events (0);
3940 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3941 x_activate_menubar (XFRAME (event
->frame_or_window
));
3945 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3947 /* Make an event (language-change (FRAME CHARSET LCID)). */
3948 obj
= Fcons (event
->modifiers
, Qnil
);
3949 obj
= Fcons (event
->code
, obj
);
3950 obj
= Fcons (event
->frame_or_window
, obj
);
3951 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3952 kbd_fetch_ptr
= event
+ 1;
3955 else if (event
->kind
== SAVE_SESSION_EVENT
)
3957 obj
= Fcons (Qsave_session
, Qnil
);
3958 kbd_fetch_ptr
= event
+ 1;
3960 /* Just discard these, by returning nil.
3961 With MULTI_KBOARD, these events are used as placeholders
3962 when we need to randomly delete events from the queue.
3963 (They shouldn't otherwise be found in the buffer,
3964 but on some machines it appears they do show up
3965 even without MULTI_KBOARD.) */
3966 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3967 mouse events during a popup-menu call. */
3968 else if (event
->kind
== NO_EVENT
)
3969 kbd_fetch_ptr
= event
+ 1;
3970 else if (event
->kind
== HELP_EVENT
)
3972 Lisp_Object object
, position
, help
, frame
, window
;
3974 frame
= event
->frame_or_window
;
3975 object
= event
->arg
;
3976 position
= make_number (event
->code
);
3979 clear_event (event
);
3981 kbd_fetch_ptr
= event
+ 1;
3982 if (!WINDOWP (window
))
3984 obj
= Fcons (Qhelp_echo
,
3985 list5 (frame
, help
, window
, object
, position
));
3987 else if (event
->kind
== FOCUS_IN_EVENT
)
3989 /* Notification of a FocusIn event. The frame receiving the
3990 focus is in event->frame_or_window. Generate a
3991 switch-frame event if necessary. */
3992 Lisp_Object frame
, focus
;
3994 frame
= event
->frame_or_window
;
3995 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3999 if (!EQ (frame
, internal_last_event_frame
)
4000 && !EQ (frame
, selected_frame
))
4001 obj
= make_lispy_switch_frame (frame
);
4002 internal_last_event_frame
= frame
;
4003 kbd_fetch_ptr
= event
+ 1;
4005 else if (event
->kind
== SELECT_WINDOW_EVENT
)
4007 /* Make an event (select-window (WINDOW)). */
4008 obj
= Fcons (event
->frame_or_window
, Qnil
);
4009 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
4011 kbd_fetch_ptr
= event
+ 1;
4015 /* If this event is on a different frame, return a switch-frame this
4016 time, and leave the event in the queue for next time. */
4020 frame
= event
->frame_or_window
;
4022 frame
= XCAR (frame
);
4023 else if (WINDOWP (frame
))
4024 frame
= WINDOW_FRAME (XWINDOW (frame
));
4026 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4030 if (! EQ (frame
, internal_last_event_frame
)
4031 && !EQ (frame
, selected_frame
))
4032 obj
= make_lispy_switch_frame (frame
);
4033 internal_last_event_frame
= frame
;
4035 /* If we didn't decide to make a switch-frame event, go ahead
4036 and build a real event from the queue entry. */
4040 obj
= make_lispy_event (event
);
4042 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4043 || defined (USE_GTK)
4044 /* If this was a menu selection, then set the flag to inhibit
4045 writing to last_nonmenu_event. Don't do this if the event
4046 we're returning is (menu-bar), though; that indicates the
4047 beginning of the menu sequence, and we might as well leave
4048 that as the `event with parameters' for this selection. */
4050 && !EQ (event
->frame_or_window
, event
->arg
)
4051 && (event
->kind
== MENU_BAR_EVENT
4052 || event
->kind
== TOOL_BAR_EVENT
))
4053 *used_mouse_menu
= 1;
4056 /* Wipe out this event, to catch bugs. */
4057 clear_event (event
);
4058 kbd_fetch_ptr
= event
+ 1;
4063 /* Try generating a mouse motion event. */
4064 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4066 FRAME_PTR f
= some_mouse_moved ();
4067 Lisp_Object bar_window
;
4068 enum scroll_bar_part part
;
4072 *kbp
= current_kboard
;
4073 /* Note that this uses F to determine which display to look at.
4074 If there is no valid info, it does not store anything
4075 so x remains nil. */
4077 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4081 /* Decide if we should generate a switch-frame event. Don't
4082 generate switch-frame events for motion outside of all Emacs
4088 frame
= FRAME_FOCUS_FRAME (f
);
4090 XSETFRAME (frame
, f
);
4092 if (! EQ (frame
, internal_last_event_frame
)
4093 && !EQ (frame
, selected_frame
))
4094 obj
= make_lispy_switch_frame (frame
);
4095 internal_last_event_frame
= frame
;
4098 /* If we didn't decide to make a switch-frame event, go ahead and
4099 return a mouse-motion event. */
4100 if (!NILP (x
) && NILP (obj
))
4101 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4103 #endif /* HAVE_MOUSE */
4105 /* We were promised by the above while loop that there was
4106 something for us to read! */
4109 input_pending
= readable_events (0);
4111 Vlast_event_frame
= internal_last_event_frame
;
4116 /* Process any events that are not user-visible,
4117 then return, without reading any user-visible events. */
4120 swallow_events (do_display
)
4125 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4127 struct input_event
*event
;
4129 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4133 last_event_timestamp
= event
->timestamp
;
4135 /* These two kinds of events get special handling
4136 and don't actually appear to the command loop. */
4137 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4140 struct input_event copy
;
4142 /* Remove it from the buffer before processing it,
4143 since otherwise swallow_events called recursively could see it
4144 and process it again. */
4146 kbd_fetch_ptr
= event
+ 1;
4147 input_pending
= readable_events (0);
4148 x_handle_selection_request (©
);
4150 /* We're getting selection request events, but we don't have
4156 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4159 struct input_event copy
;
4161 /* Remove it from the buffer before processing it, */
4164 kbd_fetch_ptr
= event
+ 1;
4165 input_pending
= readable_events (0);
4166 x_handle_selection_clear (©
);
4168 /* We're getting selection request events, but we don't have
4177 old_timers_run
= timers_run
;
4178 get_input_pending (&input_pending
, 1);
4180 if (timers_run
!= old_timers_run
&& do_display
)
4181 redisplay_preserve_echo_area (7);
4184 /* Record the start of when Emacs is idle,
4185 for the sake of running idle-time timers. */
4192 /* If we are already in the idle state, do nothing. */
4193 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4196 EMACS_GET_TIME (timer_idleness_start_time
);
4198 timer_last_idleness_start_time
= timer_idleness_start_time
;
4200 /* Mark all idle-time timers as once again candidates for running. */
4201 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4205 timer
= XCAR (timers
);
4207 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4209 XVECTOR (timer
)->contents
[0] = Qnil
;
4213 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4218 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4221 /* This is only for debugging. */
4222 struct input_event last_timer_event
;
4224 /* Check whether a timer has fired. To prevent larger problems we simply
4225 disregard elements that are not proper timers. Do not make a circular
4226 timer list for the time being.
4228 Returns the number of seconds to wait until the next timer fires. If a
4229 timer is triggering now, return zero seconds.
4230 If no timer is active, return -1 seconds.
4232 If a timer is ripe, we run it, with quitting turned off.
4234 DO_IT_NOW is now ignored. It used to mean that we should
4235 run the timer directly instead of queueing a timer-event.
4236 Now we always run timers directly. */
4239 timer_check (do_it_now
)
4242 EMACS_TIME nexttime
;
4243 EMACS_TIME now
, idleness_now
;
4244 Lisp_Object timers
, idle_timers
, chosen_timer
;
4245 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4247 EMACS_SET_SECS (nexttime
, -1);
4248 EMACS_SET_USECS (nexttime
, -1);
4250 /* Always consider the ordinary timers. */
4251 timers
= Vtimer_list
;
4252 /* Consider the idle timers only if Emacs is idle. */
4253 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4254 idle_timers
= Vtimer_idle_list
;
4257 chosen_timer
= Qnil
;
4258 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4260 if (CONSP (timers
) || CONSP (idle_timers
))
4262 EMACS_GET_TIME (now
);
4263 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4264 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4267 while (CONSP (timers
) || CONSP (idle_timers
))
4269 Lisp_Object
*vector
;
4270 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4271 EMACS_TIME timer_time
, idle_timer_time
;
4272 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4274 /* Skip past invalid timers and timers already handled. */
4277 timer
= XCAR (timers
);
4278 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4280 timers
= XCDR (timers
);
4283 vector
= XVECTOR (timer
)->contents
;
4285 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4286 || !INTEGERP (vector
[3])
4287 || ! NILP (vector
[0]))
4289 timers
= XCDR (timers
);
4293 if (!NILP (idle_timers
))
4295 timer
= XCAR (idle_timers
);
4296 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4298 idle_timers
= XCDR (idle_timers
);
4301 vector
= XVECTOR (timer
)->contents
;
4303 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4304 || !INTEGERP (vector
[3])
4305 || ! NILP (vector
[0]))
4307 idle_timers
= XCDR (idle_timers
);
4312 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4313 based on the next ordinary timer.
4314 TIMER_DIFFERENCE is the distance in time from NOW to when
4315 this timer becomes ripe (negative if it's already ripe). */
4318 timer
= XCAR (timers
);
4319 vector
= XVECTOR (timer
)->contents
;
4320 EMACS_SET_SECS (timer_time
,
4321 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4322 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4323 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4326 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4327 based on the next idle timer. */
4328 if (!NILP (idle_timers
))
4330 idle_timer
= XCAR (idle_timers
);
4331 vector
= XVECTOR (idle_timer
)->contents
;
4332 EMACS_SET_SECS (idle_timer_time
,
4333 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4334 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4335 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4338 /* Decide which timer is the next timer,
4339 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4340 Also step down the list where we found that timer. */
4342 if (! NILP (timers
) && ! NILP (idle_timers
))
4345 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4346 if (EMACS_TIME_NEG_P (temp
))
4348 chosen_timer
= timer
;
4349 timers
= XCDR (timers
);
4350 difference
= timer_difference
;
4354 chosen_timer
= idle_timer
;
4355 idle_timers
= XCDR (idle_timers
);
4356 difference
= idle_timer_difference
;
4359 else if (! NILP (timers
))
4361 chosen_timer
= timer
;
4362 timers
= XCDR (timers
);
4363 difference
= timer_difference
;
4367 chosen_timer
= idle_timer
;
4368 idle_timers
= XCDR (idle_timers
);
4369 difference
= idle_timer_difference
;
4371 vector
= XVECTOR (chosen_timer
)->contents
;
4373 /* If timer is ripe, run it if it hasn't been run. */
4374 if (EMACS_TIME_NEG_P (difference
)
4375 || (EMACS_SECS (difference
) == 0
4376 && EMACS_USECS (difference
) == 0))
4378 if (NILP (vector
[0]))
4380 int was_locked
= single_kboard
;
4381 int count
= SPECPDL_INDEX ();
4382 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4384 /* Mark the timer as triggered to prevent problems if the lisp
4385 code fails to reschedule it right. */
4388 specbind (Qinhibit_quit
, Qt
);
4390 call1 (Qtimer_event_handler
, chosen_timer
);
4391 Vdeactivate_mark
= old_deactivate_mark
;
4393 unbind_to (count
, Qnil
);
4395 /* Resume allowing input from any kboard, if that was true before. */
4397 any_kboard_state ();
4399 /* Since we have handled the event,
4400 we don't need to tell the caller to wake up and do it. */
4404 /* When we encounter a timer that is still waiting,
4405 return the amount of time to wait before it is ripe. */
4412 /* No timers are pending in the future. */
4413 /* Return 0 if we generated an event, and -1 if not. */
4418 /* Caches for modify_event_symbol. */
4419 static Lisp_Object accent_key_syms
;
4420 static Lisp_Object func_key_syms
;
4421 static Lisp_Object mouse_syms
;
4422 #if defined(WINDOWSNT) || defined(MAC_OSX)
4423 static Lisp_Object mouse_wheel_syms
;
4425 static Lisp_Object drag_n_drop_syms
;
4427 /* This is a list of keysym codes for special "accent" characters.
4428 It parallels lispy_accent_keys. */
4430 static int lispy_accent_codes
[] =
4432 #ifdef XK_dead_circumflex
4437 #ifdef XK_dead_grave
4442 #ifdef XK_dead_tilde
4447 #ifdef XK_dead_diaeresis
4452 #ifdef XK_dead_macron
4457 #ifdef XK_dead_degree
4462 #ifdef XK_dead_acute
4467 #ifdef XK_dead_cedilla
4472 #ifdef XK_dead_breve
4477 #ifdef XK_dead_ogonek
4482 #ifdef XK_dead_caron
4487 #ifdef XK_dead_doubleacute
4488 XK_dead_doubleacute
,
4492 #ifdef XK_dead_abovedot
4497 #ifdef XK_dead_abovering
4507 #ifdef XK_dead_belowdot
4512 #ifdef XK_dead_voiced_sound
4513 XK_dead_voiced_sound
,
4517 #ifdef XK_dead_semivoiced_sound
4518 XK_dead_semivoiced_sound
,
4534 /* This is a list of Lisp names for special "accent" characters.
4535 It parallels lispy_accent_codes. */
4537 static char *lispy_accent_keys
[] =
4555 "dead-voiced-sound",
4556 "dead-semivoiced-sound",
4562 #define FUNCTION_KEY_OFFSET 0x0
4564 char *lispy_function_keys
[] =
4568 0, /* VK_LBUTTON 0x01 */
4569 0, /* VK_RBUTTON 0x02 */
4570 "cancel", /* VK_CANCEL 0x03 */
4571 0, /* VK_MBUTTON 0x04 */
4573 0, 0, 0, /* 0x05 .. 0x07 */
4575 "backspace", /* VK_BACK 0x08 */
4576 "tab", /* VK_TAB 0x09 */
4578 0, 0, /* 0x0A .. 0x0B */
4580 "clear", /* VK_CLEAR 0x0C */
4581 "return", /* VK_RETURN 0x0D */
4583 0, 0, /* 0x0E .. 0x0F */
4585 0, /* VK_SHIFT 0x10 */
4586 0, /* VK_CONTROL 0x11 */
4587 0, /* VK_MENU 0x12 */
4588 "pause", /* VK_PAUSE 0x13 */
4589 "capslock", /* VK_CAPITAL 0x14 */
4591 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4593 "escape", /* VK_ESCAPE 0x1B */
4595 0, 0, 0, 0, /* 0x1C .. 0x1F */
4597 0, /* VK_SPACE 0x20 */
4598 "prior", /* VK_PRIOR 0x21 */
4599 "next", /* VK_NEXT 0x22 */
4600 "end", /* VK_END 0x23 */
4601 "home", /* VK_HOME 0x24 */
4602 "left", /* VK_LEFT 0x25 */
4603 "up", /* VK_UP 0x26 */
4604 "right", /* VK_RIGHT 0x27 */
4605 "down", /* VK_DOWN 0x28 */
4606 "select", /* VK_SELECT 0x29 */
4607 "print", /* VK_PRINT 0x2A */
4608 "execute", /* VK_EXECUTE 0x2B */
4609 "snapshot", /* VK_SNAPSHOT 0x2C */
4610 "insert", /* VK_INSERT 0x2D */
4611 "delete", /* VK_DELETE 0x2E */
4612 "help", /* VK_HELP 0x2F */
4614 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4616 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4618 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4620 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4622 0, 0, 0, 0, 0, 0, 0, 0, 0,
4623 0, 0, 0, 0, 0, 0, 0, 0, 0,
4624 0, 0, 0, 0, 0, 0, 0, 0,
4626 "lwindow", /* VK_LWIN 0x5B */
4627 "rwindow", /* VK_RWIN 0x5C */
4628 "apps", /* VK_APPS 0x5D */
4630 0, 0, /* 0x5E .. 0x5F */
4632 "kp-0", /* VK_NUMPAD0 0x60 */
4633 "kp-1", /* VK_NUMPAD1 0x61 */
4634 "kp-2", /* VK_NUMPAD2 0x62 */
4635 "kp-3", /* VK_NUMPAD3 0x63 */
4636 "kp-4", /* VK_NUMPAD4 0x64 */
4637 "kp-5", /* VK_NUMPAD5 0x65 */
4638 "kp-6", /* VK_NUMPAD6 0x66 */
4639 "kp-7", /* VK_NUMPAD7 0x67 */
4640 "kp-8", /* VK_NUMPAD8 0x68 */
4641 "kp-9", /* VK_NUMPAD9 0x69 */
4642 "kp-multiply", /* VK_MULTIPLY 0x6A */
4643 "kp-add", /* VK_ADD 0x6B */
4644 "kp-separator", /* VK_SEPARATOR 0x6C */
4645 "kp-subtract", /* VK_SUBTRACT 0x6D */
4646 "kp-decimal", /* VK_DECIMAL 0x6E */
4647 "kp-divide", /* VK_DIVIDE 0x6F */
4648 "f1", /* VK_F1 0x70 */
4649 "f2", /* VK_F2 0x71 */
4650 "f3", /* VK_F3 0x72 */
4651 "f4", /* VK_F4 0x73 */
4652 "f5", /* VK_F5 0x74 */
4653 "f6", /* VK_F6 0x75 */
4654 "f7", /* VK_F7 0x76 */
4655 "f8", /* VK_F8 0x77 */
4656 "f9", /* VK_F9 0x78 */
4657 "f10", /* VK_F10 0x79 */
4658 "f11", /* VK_F11 0x7A */
4659 "f12", /* VK_F12 0x7B */
4660 "f13", /* VK_F13 0x7C */
4661 "f14", /* VK_F14 0x7D */
4662 "f15", /* VK_F15 0x7E */
4663 "f16", /* VK_F16 0x7F */
4664 "f17", /* VK_F17 0x80 */
4665 "f18", /* VK_F18 0x81 */
4666 "f19", /* VK_F19 0x82 */
4667 "f20", /* VK_F20 0x83 */
4668 "f21", /* VK_F21 0x84 */
4669 "f22", /* VK_F22 0x85 */
4670 "f23", /* VK_F23 0x86 */
4671 "f24", /* VK_F24 0x87 */
4673 0, 0, 0, 0, /* 0x88 .. 0x8B */
4674 0, 0, 0, 0, /* 0x8C .. 0x8F */
4676 "kp-numlock", /* VK_NUMLOCK 0x90 */
4677 "scroll", /* VK_SCROLL 0x91 */
4679 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4680 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4681 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4682 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4683 "kp-end", /* VK_NUMPAD_END 0x96 */
4684 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4685 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4686 "kp-up", /* VK_NUMPAD_UP 0x99 */
4687 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4688 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4689 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4690 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4692 0, 0, /* 0x9E .. 0x9F */
4695 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4696 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4697 * No other API or message will distinguish left and right keys this way.
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,
4703 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4704 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4705 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4711 "attn", /* VK_ATTN 0xF6 */
4712 "crsel", /* VK_CRSEL 0xF7 */
4713 "exsel", /* VK_EXSEL 0xF8 */
4714 "ereof", /* VK_EREOF 0xF9 */
4715 "play", /* VK_PLAY 0xFA */
4716 "zoom", /* VK_ZOOM 0xFB */
4717 "noname", /* VK_NONAME 0xFC */
4718 "pa1", /* VK_PA1 0xFD */
4719 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4723 #else /* not HAVE_NTGUI */
4725 /* This should be dealt with in XTread_socket now, and that doesn't
4726 depend on the client system having the Kana syms defined. See also
4727 the XK_kana_A case below. */
4730 static char *lispy_kana_keys
[] =
4732 /* X Keysym value */
4733 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4734 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4735 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4736 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4737 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4738 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4739 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4740 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4741 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4742 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4743 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4744 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4745 "kana-i", "kana-u", "kana-e", "kana-o",
4746 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4747 "prolongedsound", "kana-A", "kana-I", "kana-U",
4748 "kana-E", "kana-O", "kana-KA", "kana-KI",
4749 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4750 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4751 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4752 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4753 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4754 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4755 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4756 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4757 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4758 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4759 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4760 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4762 #endif /* XK_kana_A */
4765 #define FUNCTION_KEY_OFFSET 0xff00
4767 /* You'll notice that this table is arranged to be conveniently
4768 indexed by X Windows keysym values. */
4769 static char *lispy_function_keys
[] =
4771 /* X Keysym value */
4773 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4774 "backspace", "tab", "linefeed", "clear",
4776 0, 0, 0, "pause", /* 0xff10...1f */
4777 0, 0, 0, 0, 0, 0, 0, "escape",
4779 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4780 "romaji", "hiragana", "katakana", "hiragana-katakana",
4781 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4782 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4783 "eisu-toggle", /* 0xff30...3f */
4784 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4785 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4787 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4788 "down", "prior", "next", "end",
4789 "begin", 0, 0, 0, 0, 0, 0, 0,
4790 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4801 "break", /* 0xff6b */
4804 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4805 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4806 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4807 0, 0, 0, 0, 0, 0, 0, 0,
4808 "kp-tab", /* 0xff89 */
4810 "kp-enter", /* 0xff8d */
4812 "kp-f1", /* 0xff91 */
4816 "kp-home", /* 0xff95 */
4821 "kp-prior", /* kp-page-up */
4822 "kp-next", /* kp-page-down */
4828 0, 0, 0, 0, 0, 0, 0, 0, 0,
4829 "kp-multiply", /* 0xffaa */
4834 "kp-divide", /* 0xffaf */
4835 "kp-0", /* 0xffb0 */
4836 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4839 "kp-equal", /* 0xffbd */
4840 "f1", /* 0xffbe */ /* IsFunctionKey */
4842 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4843 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4844 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4845 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4846 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4847 0, 0, 0, 0, 0, 0, 0, 0,
4848 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4849 0, 0, 0, 0, 0, 0, 0, "delete"
4852 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4853 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4855 static char *iso_lispy_function_keys
[] =
4857 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4858 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4859 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4860 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4861 "iso-lefttab", /* 0xfe20 */
4862 "iso-move-line-up", "iso-move-line-down",
4863 "iso-partial-line-up", "iso-partial-line-down",
4864 "iso-partial-space-left", "iso-partial-space-right",
4865 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4866 "iso-release-margin-left", "iso-release-margin-right",
4867 "iso-release-both-margins",
4868 "iso-fast-cursor-left", "iso-fast-cursor-right",
4869 "iso-fast-cursor-up", "iso-fast-cursor-down",
4870 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4871 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4874 #endif /* not HAVE_NTGUI */
4876 Lisp_Object Vlispy_mouse_stem
;
4878 #if defined(WINDOWSNT) || defined(MAC_OSX)
4879 /* mouse-wheel events are generated by the wheel on devices such as
4880 the MS Intellimouse. The wheel sits in between the left and right
4881 mouse buttons, and is typically used to scroll or zoom the window
4882 underneath the pointer. mouse-wheel events specify the object on
4883 which they operate, and a delta corresponding to the amount and
4884 direction that the wheel is rotated. Clicking the mouse-wheel
4885 generates a mouse-2 event. */
4886 static char *lispy_mouse_wheel_names
[] =
4891 #endif /* WINDOWSNT */
4893 /* drag-n-drop events are generated when a set of selected files are
4894 dragged from another application and dropped onto an Emacs window. */
4895 static char *lispy_drag_n_drop_names
[] =
4900 /* Scroll bar parts. */
4901 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4902 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4903 Lisp_Object Qtop
, Qratio
;
4905 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4906 Lisp_Object
*scroll_bar_parts
[] = {
4907 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4908 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4911 /* User signal events. */
4912 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4914 Lisp_Object
*lispy_user_signals
[] =
4916 &Qusr1_signal
, &Qusr2_signal
4920 /* A vector, indexed by button number, giving the down-going location
4921 of currently depressed buttons, both scroll bar and non-scroll bar.
4923 The elements have the form
4924 (BUTTON-NUMBER MODIFIER-MASK . REST)
4925 where REST is the cdr of a position as it would be reported in the event.
4927 The make_lispy_event function stores positions here to tell the
4928 difference between click and drag events, and to store the starting
4929 location to be included in drag events. */
4931 static Lisp_Object button_down_location
;
4933 /* Information about the most recent up-going button event: Which
4934 button, what location, and what time. */
4936 static int last_mouse_button
;
4937 static int last_mouse_x
;
4938 static int last_mouse_y
;
4939 static unsigned long button_down_time
;
4941 /* The maximum time between clicks to make a double-click, or Qnil to
4942 disable double-click detection, or Qt for no time limit. */
4944 Lisp_Object Vdouble_click_time
;
4946 /* Maximum number of pixels the mouse may be moved between clicks
4947 to make a double-click. */
4949 EMACS_INT double_click_fuzz
;
4951 /* The number of clicks in this multiple-click. */
4953 int double_click_count
;
4955 /* Given a struct input_event, build the lisp event which represents
4956 it. If EVENT is 0, build a mouse movement event from the mouse
4957 movement buffer, which should have a movement event in it.
4959 Note that events must be passed to this function in the order they
4960 are received; this function stores the location of button presses
4961 in order to build drag events when the button is released. */
4964 make_lispy_event (event
)
4965 struct input_event
*event
;
4969 switch (SWITCH_ENUM_CAST (event
->kind
))
4971 /* A simple keystroke. */
4972 case ASCII_KEYSTROKE_EVENT
:
4974 Lisp_Object lispy_c
;
4975 int c
= event
->code
& 0377;
4976 /* Turn ASCII characters into control characters
4978 if (event
->modifiers
& ctrl_modifier
)
4979 c
= make_ctrl_char (c
);
4981 /* Add in the other modifier bits. We took care of ctrl_modifier
4982 just above, and the shift key was taken care of by the X code,
4983 and applied to control characters by make_ctrl_char. */
4984 c
|= (event
->modifiers
4985 & (meta_modifier
| alt_modifier
4986 | hyper_modifier
| super_modifier
));
4987 /* Distinguish Shift-SPC from SPC. */
4988 if ((event
->code
& 0377) == 040
4989 && event
->modifiers
& shift_modifier
)
4990 c
|= shift_modifier
;
4991 button_down_time
= 0;
4992 XSETFASTINT (lispy_c
, c
);
4996 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4998 Lisp_Object lispy_c
;
5000 XSETFASTINT (lispy_c
, event
->code
);
5004 /* A function key. The symbol may need to have modifier prefixes
5006 case NON_ASCII_KEYSTROKE_EVENT
:
5007 button_down_time
= 0;
5009 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5010 if (event
->code
== lispy_accent_codes
[i
])
5011 return modify_event_symbol (i
,
5013 Qfunction_key
, Qnil
,
5014 lispy_accent_keys
, &accent_key_syms
,
5015 (sizeof (lispy_accent_keys
)
5016 / sizeof (lispy_accent_keys
[0])));
5020 if (event
->code
>= 0x400 && event
->code
< 0x500)
5021 return modify_event_symbol (event
->code
- 0x400,
5022 event
->modifiers
& ~shift_modifier
,
5023 Qfunction_key
, Qnil
,
5024 lispy_kana_keys
, &func_key_syms
,
5025 (sizeof (lispy_kana_keys
)
5026 / sizeof (lispy_kana_keys
[0])));
5027 #endif /* XK_kana_A */
5030 #ifdef ISO_FUNCTION_KEY_OFFSET
5031 if (event
->code
< FUNCTION_KEY_OFFSET
5032 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5033 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5035 Qfunction_key
, Qnil
,
5036 iso_lispy_function_keys
, &func_key_syms
,
5037 (sizeof (iso_lispy_function_keys
)
5038 / sizeof (iso_lispy_function_keys
[0])));
5041 /* Handle system-specific or unknown keysyms. */
5042 if (event
->code
& (1 << 28)
5043 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5044 || (event
->code
- FUNCTION_KEY_OFFSET
5045 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5046 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5048 /* We need to use an alist rather than a vector as the cache
5049 since we can't make a vector long enuf. */
5050 if (NILP (current_kboard
->system_key_syms
))
5051 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5052 return modify_event_symbol (event
->code
,
5055 current_kboard
->Vsystem_key_alist
,
5056 0, ¤t_kboard
->system_key_syms
,
5060 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5062 Qfunction_key
, Qnil
,
5063 lispy_function_keys
, &func_key_syms
,
5064 (sizeof (lispy_function_keys
)
5065 / sizeof (lispy_function_keys
[0])));
5068 /* A mouse click. Figure out where it is, decide whether it's
5069 a press, click or drag, and build the appropriate structure. */
5070 case MOUSE_CLICK_EVENT
:
5071 #ifndef USE_TOOLKIT_SCROLL_BARS
5072 case SCROLL_BAR_CLICK_EVENT
:
5075 int button
= event
->code
;
5077 Lisp_Object position
;
5078 Lisp_Object
*start_pos_ptr
;
5079 Lisp_Object start_pos
;
5084 /* Build the position as appropriate for this mouse click. */
5085 if (event
->kind
== MOUSE_CLICK_EVENT
)
5088 struct frame
*f
= XFRAME (event
->frame_or_window
);
5090 Lisp_Object string_info
= Qnil
;
5093 /* Ignore mouse events that were made on frame that
5094 have been deleted. */
5095 if (! FRAME_LIVE_P (f
))
5098 /* EVENT->x and EVENT->y are frame-relative pixel
5099 coordinates at this place. Under old redisplay, COLUMN
5100 and ROW are set to frame relative glyph coordinates
5101 which are then used to determine whether this click is
5102 in a menu (non-toolkit version). */
5103 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5104 &column
, &row
, NULL
, 1);
5106 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5107 /* In the non-toolkit version, clicks on the menu bar
5108 are ordinary button events in the event buffer.
5109 Distinguish them, and invoke the menu.
5111 (In the toolkit version, the toolkit handles the menu bar
5112 and Emacs doesn't know about it until after the user
5113 makes a selection.) */
5114 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5115 && (event
->modifiers
& down_modifier
))
5117 Lisp_Object items
, item
;
5122 /* Activate the menu bar on the down event. If the
5123 up event comes in before the menu code can deal with it,
5125 if (! (event
->modifiers
& down_modifier
))
5129 /* Find the menu bar item under `column'. */
5131 items
= FRAME_MENU_BAR_ITEMS (f
);
5132 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5134 Lisp_Object pos
, string
;
5135 string
= AREF (items
, i
+ 1);
5136 pos
= AREF (items
, i
+ 3);
5139 if (column
>= XINT (pos
)
5140 && column
< XINT (pos
) + SCHARS (string
))
5142 item
= AREF (items
, i
);
5147 /* ELisp manual 2.4b says (x y) are window relative but
5148 code says they are frame-relative. */
5150 = Fcons (event
->frame_or_window
,
5152 Fcons (Fcons (event
->x
, event
->y
),
5153 Fcons (make_number (event
->timestamp
),
5156 return Fcons (item
, Fcons (position
, Qnil
));
5158 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5160 /* Set `window' to the window under frame pixel coordinates
5161 event->x/event->y. */
5162 window
= window_from_coordinates (f
, XINT (event
->x
),
5163 XINT (event
->y
), &part
, 0);
5165 if (!WINDOWP (window
))
5167 window
= event
->frame_or_window
;
5172 /* It's a click in window window at frame coordinates
5173 event->x/ event->y. */
5174 struct window
*w
= XWINDOW (window
);
5176 /* Get window relative coordinates. Original code
5177 `rounded' this to glyph boundaries. */
5178 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5179 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5181 /* Set event coordinates to window-relative coordinates
5182 for constructing the Lisp event below. */
5183 XSETINT (event
->x
, wx
);
5184 XSETINT (event
->y
, wy
);
5186 if (part
== 1 || part
== 3)
5188 /* Mode line or header line. Look for a string under
5189 the mouse that may have a `local-map' property. */
5193 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
5194 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
5195 if (STRINGP (string
))
5196 string_info
= Fcons (string
, make_number (charpos
));
5199 posn
= Qvertical_line
;
5200 else if (part
== 6 || part
== 7)
5203 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5205 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
5206 if (STRINGP (object
))
5207 string_info
= Fcons (object
, make_number (charpos
));
5212 struct display_pos p
;
5213 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5214 posn
= make_number (CHARPOS (p
.pos
));
5215 if (STRINGP (object
))
5218 make_number (CHARPOS (p
.string_pos
)));
5225 Fcons (Fcons (event
->x
, event
->y
),
5226 Fcons (make_number (event
->timestamp
),
5229 : Fcons (string_info
, Qnil
))))));
5231 #ifndef USE_TOOLKIT_SCROLL_BARS
5234 /* It's a scrollbar click. */
5235 Lisp_Object portion_whole
;
5238 window
= event
->frame_or_window
;
5239 portion_whole
= Fcons (event
->x
, event
->y
);
5240 part
= *scroll_bar_parts
[(int) event
->part
];
5244 Fcons (Qvertical_scroll_bar
,
5245 Fcons (portion_whole
,
5246 Fcons (make_number (event
->timestamp
),
5247 Fcons (part
, Qnil
)))));
5249 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5251 if (button
>= ASIZE (button_down_location
))
5253 button_down_location
= larger_vector (button_down_location
,
5255 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5258 start_pos_ptr
= &AREF (button_down_location
, button
);
5259 start_pos
= *start_pos_ptr
;
5260 *start_pos_ptr
= Qnil
;
5263 /* On window-system frames, use the value of
5264 double-click-fuzz as is. On other frames, interpret it
5265 as a multiple of 1/8 characters. */
5269 if (WINDOWP (event
->frame_or_window
))
5270 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5271 else if (FRAMEP (event
->frame_or_window
))
5272 f
= XFRAME (event
->frame_or_window
);
5276 if (FRAME_WINDOW_P (f
))
5277 fuzz
= double_click_fuzz
;
5279 fuzz
= double_click_fuzz
/ 8;
5281 is_double
= (button
== last_mouse_button
5282 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5283 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5284 && button_down_time
!= 0
5285 && (EQ (Vdouble_click_time
, Qt
)
5286 || (INTEGERP (Vdouble_click_time
)
5287 && ((int)(event
->timestamp
- button_down_time
)
5288 < XINT (Vdouble_click_time
)))));
5291 last_mouse_button
= button
;
5292 last_mouse_x
= XINT (event
->x
);
5293 last_mouse_y
= XINT (event
->y
);
5295 /* If this is a button press, squirrel away the location, so
5296 we can decide later whether it was a click or a drag. */
5297 if (event
->modifiers
& down_modifier
)
5301 double_click_count
++;
5302 event
->modifiers
|= ((double_click_count
> 2)
5307 double_click_count
= 1;
5308 button_down_time
= event
->timestamp
;
5309 *start_pos_ptr
= Fcopy_alist (position
);
5312 /* Now we're releasing a button - check the co-ordinates to
5313 see if this was a click or a drag. */
5314 else if (event
->modifiers
& up_modifier
)
5316 /* If we did not see a down before this up, ignore the up.
5317 Probably this happened because the down event chose a
5318 menu item. It would be an annoyance to treat the
5319 release of the button that chose the menu item as a
5322 if (!CONSP (start_pos
))
5325 event
->modifiers
&= ~up_modifier
;
5326 #if 0 /* Formerly we treated an up with no down as a click event. */
5327 if (!CONSP (start_pos
))
5328 event
->modifiers
|= click_modifier
;
5333 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5335 /* The third element of every position
5336 should be the (x,y) pair. */
5337 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5339 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5341 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5342 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5345 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5346 && ydiff
< double_click_fuzz
5347 && ydiff
> - double_click_fuzz
)
5348 /* Mouse hasn't moved (much). */
5349 event
->modifiers
|= click_modifier
;
5352 button_down_time
= 0;
5353 event
->modifiers
|= drag_modifier
;
5356 /* Don't check is_double; treat this as multiple
5357 if the down-event was multiple. */
5358 if (double_click_count
> 1)
5359 event
->modifiers
|= ((double_click_count
> 2)
5365 /* Every mouse event should either have the down_modifier or
5366 the up_modifier set. */
5370 /* Get the symbol we should use for the mouse click. */
5373 head
= modify_event_symbol (button
,
5375 Qmouse_click
, Vlispy_mouse_stem
,
5378 XVECTOR (mouse_syms
)->size
);
5379 if (event
->modifiers
& drag_modifier
)
5384 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5387 Fcons (make_number (double_click_count
),
5396 #ifdef USE_TOOLKIT_SCROLL_BARS
5398 /* We don't have down and up events if using toolkit scroll bars,
5399 so make this always a click event. Store in the `part' of
5400 the Lisp event a symbol which maps to the following actions:
5402 `above_handle' page up
5403 `below_handle' page down
5407 `bottom' bottom of buffer
5408 `handle' thumb has been dragged.
5409 `end-scroll' end of interaction with scroll bar
5411 The incoming input_event contains in its `part' member an
5412 index of type `enum scroll_bar_part' which we can use as an
5413 index in scroll_bar_parts to get the appropriate symbol. */
5415 case SCROLL_BAR_CLICK_EVENT
:
5417 Lisp_Object position
, head
, window
, portion_whole
, part
;
5419 window
= event
->frame_or_window
;
5420 portion_whole
= Fcons (event
->x
, event
->y
);
5421 part
= *scroll_bar_parts
[(int) event
->part
];
5425 Fcons (Qvertical_scroll_bar
,
5426 Fcons (portion_whole
,
5427 Fcons (make_number (event
->timestamp
),
5428 Fcons (part
, Qnil
)))));
5430 /* Always treat scroll bar events as clicks. */
5431 event
->modifiers
|= click_modifier
;
5432 event
->modifiers
&= ~up_modifier
;
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
:
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
);
5528 posn
= Qvertical_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
:
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
);
5613 posn
= Qvertical_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 TOOL_BAR_EVENT
:
5659 if (EQ (event
->arg
, event
->frame_or_window
))
5660 /* This is the prefix key. We translate this to
5661 `(tool_bar)' because the code in keyboard.c for tool bar
5662 events, which we use, relies on this. */
5663 return Fcons (Qtool_bar
, Qnil
);
5664 else if (SYMBOLP (event
->arg
))
5665 return apply_modifiers (event
->modifiers
, event
->arg
);
5668 case USER_SIGNAL_EVENT
:
5669 /* A user signal. */
5670 return *lispy_user_signals
[event
->code
];
5672 case SAVE_SESSION_EVENT
:
5673 return Qsave_session
;
5675 /* The 'kind' field of the event is something we don't recognize. */
5684 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5686 Lisp_Object bar_window
;
5687 enum scroll_bar_part part
;
5691 /* Is it a scroll bar movement? */
5692 if (frame
&& ! NILP (bar_window
))
5694 Lisp_Object part_sym
;
5696 part_sym
= *scroll_bar_parts
[(int) part
];
5697 return Fcons (Qscroll_bar_movement
,
5698 (Fcons (Fcons (bar_window
,
5699 Fcons (Qvertical_scroll_bar
,
5700 Fcons (Fcons (x
, y
),
5701 Fcons (make_number (time
),
5707 /* Or is it an ordinary mouse movement? */
5715 /* It's in a frame; which window on that frame? */
5716 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5720 if (WINDOWP (window
))
5722 struct window
*w
= XWINDOW (window
);
5725 /* Get window relative coordinates. */
5726 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5727 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5734 posn
= Qvertical_line
;
5736 posn
= Qheader_line
;
5740 struct display_pos p
;
5741 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5742 posn
= make_number (CHARPOS (p
.pos
));
5745 else if (frame
!= 0)
5747 XSETFRAME (window
, frame
);
5758 return Fcons (Qmouse_movement
,
5759 Fcons (Fcons (window
,
5761 Fcons (Fcons (x
, y
),
5762 Fcons (make_number (time
),
5768 #endif /* HAVE_MOUSE */
5770 /* Construct a switch frame event. */
5772 make_lispy_switch_frame (frame
)
5775 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5778 /* Manipulating modifiers. */
5780 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5782 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5783 SYMBOL's name of the end of the modifiers; the string from this
5784 position is the unmodified symbol name.
5786 This doesn't use any caches. */
5789 parse_modifiers_uncached (symbol
, modifier_end
)
5797 CHECK_SYMBOL (symbol
);
5800 name
= SYMBOL_NAME (symbol
);
5802 for (i
= 0; i
+2 <= SBYTES (name
); )
5804 int this_mod_end
= 0;
5807 /* See if the name continues with a modifier word.
5808 Check that the word appears, but don't check what follows it.
5809 Set this_mod and this_mod_end to record what we find. */
5811 switch (SREF (name
, i
))
5813 #define SINGLE_LETTER_MOD(BIT) \
5814 (this_mod_end = i + 1, this_mod = BIT)
5817 SINGLE_LETTER_MOD (alt_modifier
);
5821 SINGLE_LETTER_MOD (ctrl_modifier
);
5825 SINGLE_LETTER_MOD (hyper_modifier
);
5829 SINGLE_LETTER_MOD (meta_modifier
);
5833 SINGLE_LETTER_MOD (shift_modifier
);
5837 SINGLE_LETTER_MOD (super_modifier
);
5840 #undef SINGLE_LETTER_MOD
5843 /* If we found no modifier, stop looking for them. */
5844 if (this_mod_end
== 0)
5847 /* Check there is a dash after the modifier, so that it
5848 really is a modifier. */
5849 if (this_mod_end
>= SBYTES (name
)
5850 || SREF (name
, this_mod_end
) != '-')
5853 /* This modifier is real; look for another. */
5854 modifiers
|= this_mod
;
5855 i
= this_mod_end
+ 1;
5858 /* Should we include the `click' modifier? */
5859 if (! (modifiers
& (down_modifier
| drag_modifier
5860 | double_modifier
| triple_modifier
))
5861 && i
+ 7 == SBYTES (name
)
5862 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5863 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5864 modifiers
|= click_modifier
;
5872 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5873 prepended to the string BASE[0..BASE_LEN-1].
5874 This doesn't use any caches. */
5876 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5879 int base_len
, base_len_byte
;
5881 /* Since BASE could contain nulls, we can't use intern here; we have
5882 to use Fintern, which expects a genuine Lisp_String, and keeps a
5885 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5891 /* Only the event queue may use the `up' modifier; it should always
5892 be turned into a click or drag event before presented to lisp code. */
5893 if (modifiers
& up_modifier
)
5896 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5897 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5898 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5899 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5900 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5901 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5902 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5903 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5904 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5905 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5906 /* The click modifier is denoted by the absence of other modifiers. */
5910 mod_len
= p
- new_mods
;
5914 Lisp_Object new_name
;
5916 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5917 mod_len
+ base_len_byte
);
5918 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5919 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5921 return Fintern (new_name
, Qnil
);
5926 static char *modifier_names
[] =
5928 "up", "down", "drag", "click", "double", "triple", 0, 0,
5929 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5930 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5932 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5934 static Lisp_Object modifier_symbols
;
5936 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5938 lispy_modifier_list (modifiers
)
5941 Lisp_Object modifier_list
;
5944 modifier_list
= Qnil
;
5945 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5946 if (modifiers
& (1<<i
))
5947 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5950 return modifier_list
;
5954 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5955 where UNMODIFIED is the unmodified form of SYMBOL,
5956 MASK is the set of modifiers present in SYMBOL's name.
5957 This is similar to parse_modifiers_uncached, but uses the cache in
5958 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5959 Qevent_symbol_elements property. */
5962 parse_modifiers (symbol
)
5965 Lisp_Object elements
;
5967 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5968 if (CONSP (elements
))
5973 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5974 Lisp_Object unmodified
;
5977 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
5978 SBYTES (SYMBOL_NAME (symbol
)) - end
),
5981 if (modifiers
& ~VALMASK
)
5983 XSETFASTINT (mask
, modifiers
);
5984 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5986 /* Cache the parsing results on SYMBOL. */
5987 Fput (symbol
, Qevent_symbol_element_mask
,
5989 Fput (symbol
, Qevent_symbol_elements
,
5990 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5992 /* Since we know that SYMBOL is modifiers applied to unmodified,
5993 it would be nice to put that in unmodified's cache.
5994 But we can't, since we're not sure that parse_modifiers is
6001 /* Apply the modifiers MODIFIERS to the symbol BASE.
6002 BASE must be unmodified.
6004 This is like apply_modifiers_uncached, but uses BASE's
6005 Qmodifier_cache property, if present. It also builds
6006 Qevent_symbol_elements properties, since it has that info anyway.
6008 apply_modifiers copies the value of BASE's Qevent_kind property to
6009 the modified symbol. */
6011 apply_modifiers (modifiers
, base
)
6015 Lisp_Object cache
, index
, entry
, new_symbol
;
6017 /* Mask out upper bits. We don't know where this value's been. */
6018 modifiers
&= VALMASK
;
6020 /* The click modifier never figures into cache indices. */
6021 cache
= Fget (base
, Qmodifier_cache
);
6022 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6023 entry
= assq_no_quit (index
, cache
);
6026 new_symbol
= XCDR (entry
);
6029 /* We have to create the symbol ourselves. */
6030 new_symbol
= apply_modifiers_uncached (modifiers
,
6031 SDATA (SYMBOL_NAME (base
)),
6032 SCHARS (SYMBOL_NAME (base
)),
6033 SBYTES (SYMBOL_NAME (base
)));
6035 /* Add the new symbol to the base's cache. */
6036 entry
= Fcons (index
, new_symbol
);
6037 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6039 /* We have the parsing info now for free, so add it to the caches. */
6040 XSETFASTINT (index
, modifiers
);
6041 Fput (new_symbol
, Qevent_symbol_element_mask
,
6042 Fcons (base
, Fcons (index
, Qnil
)));
6043 Fput (new_symbol
, Qevent_symbol_elements
,
6044 Fcons (base
, lispy_modifier_list (modifiers
)));
6047 /* Make sure this symbol is of the same kind as BASE.
6049 You'd think we could just set this once and for all when we
6050 intern the symbol above, but reorder_modifiers may call us when
6051 BASE's property isn't set right; we can't assume that just
6052 because it has a Qmodifier_cache property it must have its
6053 Qevent_kind set right as well. */
6054 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6058 kind
= Fget (base
, Qevent_kind
);
6060 Fput (new_symbol
, Qevent_kind
, kind
);
6067 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6068 return a symbol with the modifiers placed in the canonical order.
6069 Canonical order is alphabetical, except for down and drag, which
6070 always come last. The 'click' modifier is never written out.
6072 Fdefine_key calls this to make sure that (for example) C-M-foo
6073 and M-C-foo end up being equivalent in the keymap. */
6076 reorder_modifiers (symbol
)
6079 /* It's hopefully okay to write the code this way, since everything
6080 will soon be in caches, and no consing will be done at all. */
6083 parsed
= parse_modifiers (symbol
);
6084 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6089 /* For handling events, we often want to produce a symbol whose name
6090 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6091 to some base, like the name of a function key or mouse button.
6092 modify_event_symbol produces symbols of this sort.
6094 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6095 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6098 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6099 into symbol names, or a string specifying a name stem used to
6100 construct a symbol name or the form `STEM-N', where N is the decimal
6101 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6102 non-nil; otherwise NAME_TABLE is used.
6104 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6105 persist between calls to modify_event_symbol that it can use to
6106 store a cache of the symbols it's generated for this NAME_TABLE
6107 before. The object stored there may be a vector or an alist.
6109 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6111 MODIFIERS is a set of modifier bits (as given in struct input_events)
6112 whose prefixes should be applied to the symbol name.
6114 SYMBOL_KIND is the value to be placed in the event_kind property of
6115 the returned symbol.
6117 The symbols we create are supposed to have an
6118 `event-symbol-elements' property, which lists the modifiers present
6119 in the symbol's name. */
6122 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6123 name_table
, symbol_table
, table_size
)
6126 Lisp_Object symbol_kind
;
6127 Lisp_Object name_alist_or_stem
;
6129 Lisp_Object
*symbol_table
;
6130 unsigned int table_size
;
6133 Lisp_Object symbol_int
;
6135 /* Get rid of the "vendor-specific" bit here. */
6136 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6138 /* Is this a request for a valid symbol? */
6139 if (symbol_num
< 0 || symbol_num
>= table_size
)
6142 if (CONSP (*symbol_table
))
6143 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6145 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6146 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6147 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6148 we've never used that symbol before. */
6151 if (! VECTORP (*symbol_table
)
6152 || XVECTOR (*symbol_table
)->size
!= table_size
)
6156 XSETFASTINT (size
, table_size
);
6157 *symbol_table
= Fmake_vector (size
, Qnil
);
6160 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6163 /* Have we already used this symbol before? */
6166 /* No; let's create it. */
6167 if (CONSP (name_alist_or_stem
))
6168 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6169 else if (STRINGP (name_alist_or_stem
))
6171 int len
= SBYTES (name_alist_or_stem
);
6172 char *buf
= (char *) alloca (len
+ 50);
6173 if (sizeof (int) == sizeof (EMACS_INT
))
6174 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6175 XINT (symbol_int
) + 1);
6176 else if (sizeof (long) == sizeof (EMACS_INT
))
6177 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6178 XINT (symbol_int
) + 1);
6179 value
= intern (buf
);
6181 else if (name_table
!= 0 && name_table
[symbol_num
])
6182 value
= intern (name_table
[symbol_num
]);
6184 #ifdef HAVE_WINDOW_SYSTEM
6187 char *name
= x_get_keysym_name (symbol_num
);
6189 value
= intern (name
);
6196 sprintf (buf
, "key-%d", symbol_num
);
6197 value
= intern (buf
);
6200 if (CONSP (*symbol_table
))
6201 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6203 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6205 /* Fill in the cache entries for this symbol; this also
6206 builds the Qevent_symbol_elements property, which the user
6208 apply_modifiers (modifiers
& click_modifier
, value
);
6209 Fput (value
, Qevent_kind
, symbol_kind
);
6212 /* Apply modifiers to that symbol. */
6213 return apply_modifiers (modifiers
, value
);
6216 /* Convert a list that represents an event type,
6217 such as (ctrl meta backspace), into the usual representation of that
6218 event type as a number or a symbol. */
6220 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6221 doc
: /* Convert the event description list EVENT-DESC to an event type.
6222 EVENT-DESC should contain one base event type (a character or symbol)
6223 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6224 drag, down, double or triple). The base must be last.
6225 The return value is an event type (a character or symbol) which
6226 has the same base event type and all the specified modifiers. */)
6228 Lisp_Object event_desc
;
6236 while (CONSP (rest
))
6244 /* Given a symbol, see if it is a modifier name. */
6245 if (SYMBOLP (elt
) && CONSP (rest
))
6246 this = parse_solitary_modifier (elt
);
6250 else if (!NILP (base
))
6251 error ("Two bases given in one event");
6257 /* Let the symbol A refer to the character A. */
6258 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6259 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6261 if (INTEGERP (base
))
6263 /* Turn (shift a) into A. */
6264 if ((modifiers
& shift_modifier
) != 0
6265 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6267 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6268 modifiers
&= ~shift_modifier
;
6271 /* Turn (control a) into C-a. */
6272 if (modifiers
& ctrl_modifier
)
6273 return make_number ((modifiers
& ~ctrl_modifier
)
6274 | make_ctrl_char (XINT (base
)));
6276 return make_number (modifiers
| XINT (base
));
6278 else if (SYMBOLP (base
))
6279 return apply_modifiers (modifiers
, base
);
6282 error ("Invalid base event");
6287 /* Try to recognize SYMBOL as a modifier name.
6288 Return the modifier flag bit, or 0 if not recognized. */
6291 parse_solitary_modifier (symbol
)
6294 Lisp_Object name
= SYMBOL_NAME (symbol
);
6296 switch (SREF (name
, 0))
6298 #define SINGLE_LETTER_MOD(BIT) \
6299 if (SBYTES (name) == 1) \
6302 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6303 if (LEN == SBYTES (name) \
6304 && ! strncmp (SDATA (name), NAME, LEN)) \
6308 SINGLE_LETTER_MOD (alt_modifier
);
6312 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6316 SINGLE_LETTER_MOD (ctrl_modifier
);
6320 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6321 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6325 SINGLE_LETTER_MOD (hyper_modifier
);
6329 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6333 SINGLE_LETTER_MOD (meta_modifier
);
6337 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6341 SINGLE_LETTER_MOD (shift_modifier
);
6345 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6346 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6347 SINGLE_LETTER_MOD (super_modifier
);
6351 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6352 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6353 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6357 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6360 #undef SINGLE_LETTER_MOD
6361 #undef MULTI_LETTER_MOD
6367 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6368 Such a list is not valid as an event,
6369 but it can be a Lucid-style event type list. */
6372 lucid_event_type_list_p (object
)
6377 if (! CONSP (object
))
6380 if (EQ (XCAR (object
), Qhelp_echo
)
6381 || EQ (XCAR (object
), Qvertical_line
)
6382 || EQ (XCAR (object
), Qmode_line
)
6383 || EQ (XCAR (object
), Qheader_line
))
6386 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6390 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6397 /* Store into *addr a value nonzero if terminal input chars are available.
6398 Serves the purpose of ioctl (0, FIONREAD, addr)
6399 but works even if FIONREAD does not exist.
6400 (In fact, this may actually read some input.)
6402 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6403 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6406 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6411 /* First of all, have we already counted some input? */
6412 *addr
= (!NILP (Vquit_flag
)
6413 || readable_filtered_events (do_timers_now
, filter_events
));
6415 /* If input is being read as it arrives, and we have none, there is none. */
6416 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6419 /* Try to read some input and see how much we get. */
6421 *addr
= (!NILP (Vquit_flag
)
6422 || readable_filtered_events (do_timers_now
, filter_events
));
6425 /* Store into *addr a value nonzero if terminal input chars are available.
6426 Serves the purpose of ioctl (0, FIONREAD, addr)
6427 but works even if FIONREAD does not exist.
6428 (In fact, this may actually read some input.)
6430 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6433 get_input_pending (addr
, do_timers_now
)
6437 get_filtered_input_pending (addr
, do_timers_now
, 0);
6440 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6443 gobble_input (expected
)
6448 if (interrupt_input
)
6451 mask
= sigblock (sigmask (SIGIO
));
6452 read_avail_input (expected
);
6456 #ifdef POLL_FOR_INPUT
6457 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6460 mask
= sigblock (sigmask (SIGALRM
));
6461 read_avail_input (expected
);
6467 read_avail_input (expected
);
6471 /* Put a BUFFER_SWITCH_EVENT in the buffer
6472 so that read_key_sequence will notice the new current buffer. */
6475 record_asynch_buffer_change ()
6477 struct input_event event
;
6480 event
.kind
= BUFFER_SWITCH_EVENT
;
6481 event
.frame_or_window
= Qnil
;
6485 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6486 The purpose of the event is to make read_key_sequence look up the
6487 keymaps again. If we aren't in read_key_sequence, we don't need one,
6488 and the event could cause trouble by messing up (input-pending-p). */
6489 tem
= Fwaiting_for_user_input_p ();
6493 /* We never need these events if we have no asynchronous subprocesses. */
6497 /* Make sure no interrupt happens while storing the event. */
6499 if (interrupt_input
)
6502 mask
= sigblock (sigmask (SIGIO
));
6503 kbd_buffer_store_event (&event
);
6510 kbd_buffer_store_event (&event
);
6517 /* Read any terminal input already buffered up by the system
6518 into the kbd_buffer, but do not wait.
6520 EXPECTED should be nonzero if the caller knows there is some input.
6522 Except on VMS, all input is read by this function.
6523 If interrupt_input is nonzero, this function MUST be called
6524 only when SIGIO is blocked.
6526 Returns the number of keyboard chars read, or -1 meaning
6527 this is a bad time to try to read input. */
6530 read_avail_input (expected
)
6533 struct input_event buf
[KBD_BUFFER_SIZE
];
6537 if (read_socket_hook
)
6538 /* No need for FIONREAD or fcntl; just say don't wait. */
6539 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6542 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6543 the kbd_buffer can really hold. That may prevent loss
6544 of characters on some systems when input is stuffed at us. */
6545 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6548 /* Determine how many characters we should *try* to read. */
6551 #else /* not WINDOWSNT */
6553 n_to_read
= dos_keysns ();
6556 #else /* not MSDOS */
6558 /* Find out how much input is available. */
6559 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6560 /* Formerly simply reported no input, but that sometimes led to
6561 a failure of Emacs to terminate.
6562 SIGHUP seems appropriate if we can't reach the terminal. */
6563 /* ??? Is it really right to send the signal just to this process
6564 rather than to the whole process group?
6565 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6566 kill (getpid (), SIGHUP
);
6569 if (n_to_read
> sizeof cbuf
)
6570 n_to_read
= sizeof cbuf
;
6571 #else /* no FIONREAD */
6572 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6573 /* Read some input if available, but don't wait. */
6574 n_to_read
= sizeof cbuf
;
6575 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6580 #endif /* not MSDOS */
6581 #endif /* not WINDOWSNT */
6583 /* Now read; for one reason or another, this will not block.
6584 NREAD is set to the number of chars read. */
6588 cbuf
[0] = dos_keyread ();
6591 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6593 /* POSIX infers that processes which are not in the session leader's
6594 process group won't get SIGHUP's at logout time. BSDI adheres to
6595 this part standard and returns -1 from read (0) with errno==EIO
6596 when the control tty is taken away.
6597 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6598 if (nread
== -1 && errno
== EIO
)
6600 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6601 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6602 This looks incorrect, but it isn't, because _BSD causes
6603 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6604 and that causes a value other than 0 when there is no input. */
6610 /* We used to retry the read if it was interrupted.
6611 But this does the wrong thing when O_NDELAY causes
6612 an EAGAIN error. Does anybody know of a situation
6613 where a retry is actually needed? */
6615 nread
< 0 && (errno
== EAGAIN
6629 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6630 fcntl (input_fd
, F_SETFL
, 0);
6631 #endif /* USG or DGUX or CYGWIN */
6632 #endif /* no FIONREAD */
6633 for (i
= 0; i
< nread
; i
++)
6635 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6636 buf
[i
].modifiers
= 0;
6637 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6638 buf
[i
].modifiers
= meta_modifier
;
6642 buf
[i
].code
= cbuf
[i
];
6643 buf
[i
].frame_or_window
= selected_frame
;
6648 /* Scan the chars for C-g and store them in kbd_buffer. */
6649 for (i
= 0; i
< nread
; i
++)
6651 kbd_buffer_store_event (&buf
[i
]);
6652 /* Don't look at input that follows a C-g too closely.
6653 This reduces lossage due to autorepeat on C-g. */
6654 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6655 && buf
[i
].code
== quit_char
)
6661 #endif /* not VMS */
6663 #ifdef SIGIO /* for entire page */
6664 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6667 input_available_signal (signo
)
6670 /* Must preserve main program's value of errno. */
6671 int old_errno
= errno
;
6673 extern int select_alarmed
;
6676 #if defined (USG) && !defined (POSIX_SIGNALS)
6677 /* USG systems forget handlers when they are used;
6678 must reestablish each time */
6679 signal (signo
, input_available_signal
);
6686 if (input_available_clear_time
)
6687 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6692 nread
= read_avail_input (1);
6693 /* -1 means it's not ok to read the input now.
6694 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6695 0 means there was no keyboard input available. */
6700 select_alarmed
= 1; /* Force the select emulator back to life */
6711 /* Send ourselves a SIGIO.
6713 This function exists so that the UNBLOCK_INPUT macro in
6714 blockinput.h can have some way to take care of input we put off
6715 dealing with, without assuming that every file which uses
6716 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6718 reinvoke_input_signal ()
6721 kill (getpid (), SIGIO
);
6727 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6728 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6730 /* These variables hold the vector under construction within
6731 menu_bar_items and its subroutines, and the current index
6732 for storing into that vector. */
6733 static Lisp_Object menu_bar_items_vector
;
6734 static int menu_bar_items_index
;
6736 /* Return a vector of menu items for a menu bar, appropriate
6737 to the current buffer. Each item has three elements in the vector:
6740 OLD is an old vector we can optionally reuse, or nil. */
6743 menu_bar_items (old
)
6746 /* The number of keymaps we're scanning right now, and the number of
6747 keymaps we have allocated space for. */
6750 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6751 in the current keymaps, or nil where it is not a prefix. */
6754 Lisp_Object def
, tail
;
6763 struct gcpro gcpro1
;
6765 /* In order to build the menus, we need to call the keymap
6766 accessors. They all call QUIT. But this function is called
6767 during redisplay, during which a quit is fatal. So inhibit
6768 quitting while building the menus.
6769 We do this instead of specbind because (1) errors will clear it anyway
6770 and (2) this avoids risk of specpdl overflow. */
6771 oquit
= Vinhibit_quit
;
6775 menu_bar_items_vector
= old
;
6777 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6778 menu_bar_items_index
= 0;
6780 GCPRO1 (menu_bar_items_vector
);
6782 /* Build our list of keymaps.
6783 If we recognize a function key and replace its escape sequence in
6784 keybuf with its symbol, or if the sequence starts with a mouse
6785 click and we need to switch buffers, we jump back here to rebuild
6786 the initial keymaps from the current buffer. */
6790 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6791 if (!NILP (Voverriding_local_map_menu_flag
))
6793 /* Yes, use them (if non-nil) as well as the global map. */
6794 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6796 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6797 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6798 if (!NILP (Voverriding_local_map
))
6799 maps
[nmaps
++] = Voverriding_local_map
;
6803 /* No, so use major and minor mode keymaps and keymap property.
6804 Note that menu-bar bindings in the local-map and keymap
6805 properties may not work reliable, as they are only
6806 recognized when the menu-bar (or mode-line) is updated,
6807 which does not normally happen after every command. */
6810 nminor
= current_minor_maps (NULL
, &tmaps
);
6811 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6813 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6814 maps
[nmaps
++] = tem
;
6815 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6817 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6819 maps
[nmaps
++] = current_global_map
;
6822 /* Look up in each map the dummy prefix key `menu-bar'. */
6826 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6827 if (!NILP (maps
[mapno
]))
6829 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6832 menu_bar_one_keymap (def
);
6835 /* Move to the end those items that should be at the end. */
6837 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6840 int end
= menu_bar_items_index
;
6842 for (i
= 0; i
< end
; i
+= 4)
6843 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6845 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6846 /* Move the item at index I to the end,
6847 shifting all the others forward. */
6848 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6849 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6850 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6851 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6853 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6854 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6855 (end
- i
- 4) * sizeof (Lisp_Object
));
6856 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6857 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6858 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6859 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6864 /* Add nil, nil, nil, nil at the end. */
6865 i
= menu_bar_items_index
;
6866 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6869 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6870 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6871 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6872 menu_bar_items_vector
= tem
;
6874 /* Add this item. */
6875 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6876 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6877 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6878 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6879 menu_bar_items_index
= i
;
6881 Vinhibit_quit
= oquit
;
6883 return menu_bar_items_vector
;
6886 /* Scan one map KEYMAP, accumulating any menu items it defines
6887 in menu_bar_items_vector. */
6889 static Lisp_Object menu_bar_one_keymap_changed_items
;
6892 menu_bar_one_keymap (keymap
)
6895 Lisp_Object tail
, item
;
6897 menu_bar_one_keymap_changed_items
= Qnil
;
6899 /* Loop over all keymap entries that have menu strings. */
6900 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6904 menu_bar_item (XCAR (item
), XCDR (item
));
6905 else if (VECTORP (item
))
6907 /* Loop over the char values represented in the vector. */
6908 int len
= XVECTOR (item
)->size
;
6910 for (c
= 0; c
< len
; c
++)
6912 Lisp_Object character
;
6913 XSETFASTINT (character
, c
);
6914 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6920 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6921 If there's already an item for KEY, add this DEF to it. */
6923 Lisp_Object item_properties
;
6926 menu_bar_item (key
, item
)
6927 Lisp_Object key
, item
;
6929 struct gcpro gcpro1
;
6933 if (EQ (item
, Qundefined
))
6935 /* If a map has an explicit `undefined' as definition,
6936 discard any previously made menu bar item. */
6938 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6939 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6941 if (menu_bar_items_index
> i
+ 4)
6942 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6943 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6944 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6945 menu_bar_items_index
-= 4;
6949 /* If this keymap has already contributed to this KEY,
6950 don't contribute to it a second time. */
6951 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6952 if (!NILP (tem
) || NILP (item
))
6955 menu_bar_one_keymap_changed_items
6956 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6958 /* We add to menu_bar_one_keymap_changed_items before doing the
6959 parse_menu_item, so that if it turns out it wasn't a menu item,
6960 it still correctly hides any further menu item. */
6962 i
= parse_menu_item (item
, 0, 1);
6967 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6969 /* Find any existing item for this KEY. */
6970 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6971 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6974 /* If we did not find this KEY, add it at the end. */
6975 if (i
== menu_bar_items_index
)
6977 /* If vector is too small, get a bigger one. */
6978 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6981 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6982 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6983 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6984 menu_bar_items_vector
= tem
;
6987 /* Add this item. */
6988 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6989 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6990 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6991 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6992 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6993 menu_bar_items_index
= i
;
6995 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6999 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7000 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
7004 /* This is used as the handler when calling menu_item_eval_property. */
7006 menu_item_eval_property_1 (arg
)
7009 /* If we got a quit from within the menu computation,
7010 quit all the way out of it. This takes care of C-] in the debugger. */
7011 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7012 Fsignal (Qquit
, Qnil
);
7017 /* Evaluate an expression and return the result (or nil if something
7018 went wrong). Used to evaluate dynamic parts of menu items. */
7020 menu_item_eval_property (sexpr
)
7023 int count
= SPECPDL_INDEX ();
7025 specbind (Qinhibit_redisplay
, Qt
);
7026 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7027 menu_item_eval_property_1
);
7028 return unbind_to (count
, val
);
7031 /* This function parses a menu item and leaves the result in the
7032 vector item_properties.
7033 ITEM is a key binding, a possible menu item.
7034 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7035 evaluate dynamic expressions in the menu item.
7036 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7038 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7039 parse_menu_item returns true if the item is a menu item and false
7043 parse_menu_item (item
, notreal
, inmenubar
)
7045 int notreal
, inmenubar
;
7047 Lisp_Object def
, tem
, item_string
, start
;
7048 Lisp_Object cachelist
;
7050 Lisp_Object keyhint
;
7061 /* Create item_properties vector if necessary. */
7062 if (NILP (item_properties
))
7064 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7066 /* Initialize optional entries. */
7067 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7068 AREF (item_properties
, i
) = Qnil
;
7069 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7071 /* Save the item here to protect it from GC. */
7072 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7074 item_string
= XCAR (item
);
7078 if (STRINGP (item_string
))
7080 /* Old format menu item. */
7081 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7083 /* Maybe help string. */
7084 if (CONSP (item
) && STRINGP (XCAR (item
)))
7086 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7091 /* Maybe key binding cache. */
7092 if (CONSP (item
) && CONSP (XCAR (item
))
7093 && (NILP (XCAR (XCAR (item
)))
7094 || VECTORP (XCAR (XCAR (item
)))))
7096 cachelist
= XCAR (item
);
7100 /* This is the real definition--the function to run. */
7101 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7103 /* Get enable property, if any. */
7106 tem
= Fget (item
, Qmenu_enable
);
7108 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7111 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7113 /* New format menu item. */
7114 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7115 start
= XCDR (item
);
7118 /* We have a real binding. */
7119 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7121 item
= XCDR (start
);
7122 /* Is there a cache list with key equivalences. */
7123 if (CONSP (item
) && CONSP (XCAR (item
)))
7125 cachelist
= XCAR (item
);
7129 /* Parse properties. */
7130 while (CONSP (item
) && CONSP (XCDR (item
)))
7135 if (EQ (tem
, QCenable
))
7136 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7137 else if (EQ (tem
, QCvisible
) && !notreal
)
7139 /* If got a visible property and that evaluates to nil
7140 then ignore this item. */
7141 tem
= menu_item_eval_property (XCAR (item
));
7145 else if (EQ (tem
, QChelp
))
7146 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7147 else if (EQ (tem
, QCfilter
))
7149 else if (EQ (tem
, QCkey_sequence
))
7152 if (NILP (cachelist
)
7153 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7154 /* Be GC protected. Set keyhint to item instead of tem. */
7157 else if (EQ (tem
, QCkeys
))
7160 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7161 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7163 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7168 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7170 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7172 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7179 else if (inmenubar
|| !NILP (start
))
7183 return 0; /* not a menu item */
7185 /* If item string is not a string, evaluate it to get string.
7186 If we don't get a string, skip this item. */
7187 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7188 if (!(STRINGP (item_string
) || notreal
))
7190 item_string
= menu_item_eval_property (item_string
);
7191 if (!STRINGP (item_string
))
7193 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7196 /* If got a filter apply it on definition. */
7197 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7200 def
= menu_item_eval_property (list2 (XCAR (filter
),
7201 list2 (Qquote
, def
)));
7203 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7206 /* Enable or disable selection of item. */
7207 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7213 tem
= menu_item_eval_property (tem
);
7214 if (inmenubar
&& NILP (tem
))
7215 return 0; /* Ignore disabled items in menu bar. */
7216 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7219 /* If we got no definition, this item is just unselectable text which
7220 is OK in a submenu but not in the menubar. */
7222 return (inmenubar
? 0 : 1);
7224 /* See if this is a separate pane or a submenu. */
7225 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7226 tem
= get_keymap (def
, 0, 1);
7227 /* For a subkeymap, just record its details and exit. */
7230 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7231 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7235 /* At the top level in the menu bar, do likewise for commands also.
7236 The menu bar does not display equivalent key bindings anyway.
7237 ITEM_PROPERTY_DEF is already set up properly. */
7241 /* This is a command. See if there is an equivalent key binding. */
7242 if (NILP (cachelist
))
7244 /* We have to create a cachelist. */
7245 CHECK_IMPURE (start
);
7246 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7247 cachelist
= XCAR (XCDR (start
));
7249 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7250 if (!NILP (keyhint
))
7252 XSETCAR (cachelist
, XCAR (keyhint
));
7255 else if (STRINGP (tem
))
7257 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7258 XSETCAR (cachelist
, Qt
);
7262 tem
= XCAR (cachelist
);
7269 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7271 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7274 def
= XCAR (prefix
);
7275 prefix
= XCDR (prefix
);
7278 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7280 if (!update_menu_bindings
)
7282 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7284 if (newcache
/* Always check first time. */
7285 /* Should we check everything when precomputing key
7287 /* If something had no key binding before, don't recheck it
7288 because that is too slow--except if we have a list of
7289 rebound commands in Vdefine_key_rebound_commands, do
7290 recheck any command that appears in that list. */
7291 || (CONSP (Vdefine_key_rebound_commands
)
7292 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7295 /* We had a saved key. Is it still bound to the command? */
7298 /* If the command is an alias for another
7299 (such as lmenu.el set it up), check if the
7300 original command matches the cached command. */
7301 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7302 chkcache
= 1; /* Need to recompute key binding. */
7306 /* Recompute equivalent key binding. If the command is an alias
7307 for another (such as lmenu.el set it up), see if the original
7308 command name has equivalent keys. Otherwise look up the
7309 specified command itself. We don't try both, because that
7310 makes lmenu menus slow. */
7312 && SYMBOLP (XSYMBOL (def
)->function
)
7313 && ! NILP (Fget (def
, Qmenu_alias
)))
7314 def
= XSYMBOL (def
)->function
;
7315 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7316 XSETCAR (cachelist
, tem
);
7319 XSETCDR (cachelist
, Qnil
);
7323 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7325 tem
= XCAR (cachelist
);
7329 newcache
= chkcache
;
7332 tem
= Fkey_description (tem
);
7335 if (STRINGP (XCAR (prefix
)))
7336 tem
= concat2 (XCAR (prefix
), tem
);
7337 if (STRINGP (XCDR (prefix
)))
7338 tem
= concat2 (tem
, XCDR (prefix
));
7340 XSETCDR (cachelist
, tem
);
7344 tem
= XCDR (cachelist
);
7345 if (newcache
&& !NILP (tem
))
7347 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7348 XSETCDR (cachelist
, tem
);
7351 /* If we only want to precompute equivalent key bindings, stop here. */
7355 /* If we have an equivalent key binding, use that. */
7356 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7358 /* Include this when menu help is implemented.
7359 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7360 if (!(NILP (tem) || STRINGP (tem)))
7362 tem = menu_item_eval_property (tem);
7365 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7369 /* Handle radio buttons or toggle boxes. */
7370 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7372 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7373 = menu_item_eval_property (tem
);
7380 /***********************************************************************
7382 ***********************************************************************/
7384 /* A vector holding tool bar items while they are parsed in function
7385 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7388 static Lisp_Object tool_bar_items_vector
;
7390 /* A vector holding the result of parse_tool_bar_item. Layout is like
7391 the one for a single item in tool_bar_items_vector. */
7393 static Lisp_Object tool_bar_item_properties
;
7395 /* Next free index in tool_bar_items_vector. */
7397 static int ntool_bar_items
;
7399 /* The symbols `tool-bar', and `:image'. */
7401 extern Lisp_Object Qtool_bar
;
7402 Lisp_Object QCimage
;
7404 /* Function prototypes. */
7406 static void init_tool_bar_items
P_ ((Lisp_Object
));
7407 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7408 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7409 static void append_tool_bar_item
P_ ((void));
7412 /* Return a vector of tool bar items for keymaps currently in effect.
7413 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7414 tool bar items found. */
7417 tool_bar_items (reuse
, nitems
)
7428 /* In order to build the menus, we need to call the keymap
7429 accessors. They all call QUIT. But this function is called
7430 during redisplay, during which a quit is fatal. So inhibit
7431 quitting while building the menus. We do this instead of
7432 specbind because (1) errors will clear it anyway and (2) this
7433 avoids risk of specpdl overflow. */
7434 oquit
= Vinhibit_quit
;
7437 /* Initialize tool_bar_items_vector and protect it from GC. */
7438 init_tool_bar_items (reuse
);
7440 /* Build list of keymaps in maps. Set nmaps to the number of maps
7443 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7444 if (!NILP (Voverriding_local_map_menu_flag
))
7446 /* Yes, use them (if non-nil) as well as the global map. */
7447 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7449 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7450 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7451 if (!NILP (Voverriding_local_map
))
7452 maps
[nmaps
++] = Voverriding_local_map
;
7456 /* No, so use major and minor mode keymaps and keymap property.
7457 Note that tool-bar bindings in the local-map and keymap
7458 properties may not work reliable, as they are only
7459 recognized when the tool-bar (or mode-line) is updated,
7460 which does not normally happen after every command. */
7463 nminor
= current_minor_maps (NULL
, &tmaps
);
7464 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7466 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7467 maps
[nmaps
++] = tem
;
7468 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7470 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7473 /* Add global keymap at the end. */
7474 maps
[nmaps
++] = current_global_map
;
7476 /* Process maps in reverse order and look up in each map the prefix
7478 for (i
= nmaps
- 1; i
>= 0; --i
)
7479 if (!NILP (maps
[i
]))
7483 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7488 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7489 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7491 Lisp_Object keydef
= XCAR (tail
);
7493 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7498 Vinhibit_quit
= oquit
;
7499 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7500 return tool_bar_items_vector
;
7504 /* Process the definition of KEY which is DEF. */
7507 process_tool_bar_item (key
, def
)
7508 Lisp_Object key
, def
;
7511 extern Lisp_Object Qundefined
;
7512 struct gcpro gcpro1
, gcpro2
;
7514 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7518 if (EQ (def
, Qundefined
))
7520 /* If a map has an explicit `undefined' as definition,
7521 discard any previously made item. */
7522 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7524 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7526 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7528 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7529 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7530 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7531 * sizeof (Lisp_Object
)));
7532 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7537 else if (parse_tool_bar_item (key
, def
))
7538 /* Append a new tool bar item to tool_bar_items_vector. Accept
7539 more than one definition for the same key. */
7540 append_tool_bar_item ();
7546 /* Parse a tool bar item specification ITEM for key KEY and return the
7547 result in tool_bar_item_properties. Value is zero if ITEM is
7550 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7552 CAPTION is the caption of the item, If it's not a string, it is
7553 evaluated to get a string.
7555 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7556 as binding are currently ignored.
7558 The following properties are recognized:
7562 FORM is evaluated and specifies whether the tool bar item is
7563 enabled or disabled.
7567 FORM is evaluated and specifies whether the tool bar item is visible.
7569 - `:filter FUNCTION'
7571 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7572 result is stored as the new binding.
7574 - `:button (TYPE SELECTED)'
7576 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7577 and specifies whether the button is selected (pressed) or not.
7581 IMAGES is either a single image specification or a vector of four
7582 image specifications. See enum tool_bar_item_images.
7584 - `:help HELP-STRING'.
7586 Gives a help string to display for the tool bar item. */
7589 parse_tool_bar_item (key
, item
)
7590 Lisp_Object key
, item
;
7592 /* Access slot with index IDX of vector tool_bar_item_properties. */
7593 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7595 Lisp_Object filter
= Qnil
;
7596 Lisp_Object caption
;
7599 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7600 Rule out items that aren't lists, don't start with
7601 `menu-item' or whose rest following `tool-bar-item' is not a
7604 || !EQ (XCAR (item
), Qmenu_item
)
7605 || (item
= XCDR (item
),
7609 /* Create tool_bar_item_properties vector if necessary. Reset it to
7611 if (VECTORP (tool_bar_item_properties
))
7613 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7617 tool_bar_item_properties
7618 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7621 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7622 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7624 /* Get the caption of the item. If the caption is not a string,
7625 evaluate it to get a string. If we don't get a string, skip this
7627 caption
= XCAR (item
);
7628 if (!STRINGP (caption
))
7630 caption
= menu_item_eval_property (caption
);
7631 if (!STRINGP (caption
))
7634 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7636 /* Give up if rest following the caption is not a list. */
7641 /* Store the binding. */
7642 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7645 /* Ignore cached key binding, if any. */
7646 if (CONSP (item
) && CONSP (XCAR (item
)))
7649 /* Process the rest of the properties. */
7650 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7652 Lisp_Object key
, value
;
7655 value
= XCAR (XCDR (item
));
7657 if (EQ (key
, QCenable
))
7658 /* `:enable FORM'. */
7659 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7660 else if (EQ (key
, QCvisible
))
7662 /* `:visible FORM'. If got a visible property and that
7663 evaluates to nil then ignore this item. */
7664 if (NILP (menu_item_eval_property (value
)))
7667 else if (EQ (key
, QChelp
))
7668 /* `:help HELP-STRING'. */
7669 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7670 else if (EQ (key
, QCfilter
))
7671 /* ':filter FORM'. */
7673 else if (EQ (key
, QCbutton
) && CONSP (value
))
7675 /* `:button (TYPE . SELECTED)'. */
7676 Lisp_Object type
, selected
;
7678 type
= XCAR (value
);
7679 selected
= XCDR (value
);
7680 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7682 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7683 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7686 else if (EQ (key
, QCimage
)
7688 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7689 /* Value is either a single image specification or a vector
7690 of 4 such specifications for the different button states. */
7691 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7694 /* If got a filter apply it on binding. */
7696 PROP (TOOL_BAR_ITEM_BINDING
)
7697 = menu_item_eval_property (list2 (filter
,
7699 PROP (TOOL_BAR_ITEM_BINDING
))));
7701 /* See if the binding is a keymap. Give up if it is. */
7702 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7705 /* Enable or disable selection of item. */
7706 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7707 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7708 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7710 /* Handle radio buttons or toggle boxes. */
7711 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7712 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7713 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7721 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7722 that can be reused. */
7725 init_tool_bar_items (reuse
)
7728 if (VECTORP (reuse
))
7729 tool_bar_items_vector
= reuse
;
7731 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7732 ntool_bar_items
= 0;
7736 /* Append parsed tool bar item properties from
7737 tool_bar_item_properties */
7740 append_tool_bar_item ()
7742 Lisp_Object
*to
, *from
;
7744 /* Enlarge tool_bar_items_vector if necessary. */
7745 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7746 >= XVECTOR (tool_bar_items_vector
)->size
)
7748 Lisp_Object new_vector
;
7749 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7751 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7752 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7753 XVECTOR (new_vector
)->contents
,
7754 old_size
* sizeof (Lisp_Object
));
7755 tool_bar_items_vector
= new_vector
;
7758 /* Append entries from tool_bar_item_properties to the end of
7759 tool_bar_items_vector. */
7760 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7761 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7762 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7763 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7770 /* Read a character using menus based on maps in the array MAPS.
7771 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7772 Return t if we displayed a menu but the user rejected it.
7774 PREV_EVENT is the previous input event, or nil if we are reading
7775 the first event of a key sequence.
7777 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7778 if we used a mouse menu to read the input, or zero otherwise. If
7779 USED_MOUSE_MENU is null, we don't dereference it.
7781 The prompting is done based on the prompt-string of the map
7782 and the strings associated with various map elements.
7784 This can be done with X menus or with menus put in the minibuf.
7785 These are done in different ways, depending on how the input will be read.
7786 Menus using X are done after auto-saving in read-char, getting the input
7787 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7788 and do auto-saving in the inner call of read_char. */
7791 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7794 Lisp_Object prev_event
;
7795 int *used_mouse_menu
;
7798 register Lisp_Object name
= Qnil
;
7800 if (used_mouse_menu
)
7801 *used_mouse_menu
= 0;
7803 /* Use local over global Menu maps */
7805 if (! menu_prompting
)
7808 /* Optionally disregard all but the global map. */
7809 if (inhibit_local_menu_bar_menus
)
7811 maps
+= (nmaps
- 1);
7815 /* Get the menu name from the first map that has one (a prompt string). */
7816 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7818 name
= Fkeymap_prompt (maps
[mapno
]);
7823 /* If we don't have any menus, just read a character normally. */
7824 if (!STRINGP (name
))
7828 /* If we got to this point via a mouse click,
7829 use a real menu for mouse selection. */
7830 if (EVENT_HAS_PARAMETERS (prev_event
)
7831 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7832 && !EQ (XCAR (prev_event
), Qtool_bar
))
7834 /* Display the menu and get the selection. */
7835 Lisp_Object
*realmaps
7836 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7840 /* Use the maps that are not nil. */
7841 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7842 if (!NILP (maps
[mapno
]))
7843 realmaps
[nmaps1
++] = maps
[mapno
];
7845 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7850 record_menu_key (XCAR (value
));
7852 /* If we got multiple events, unread all but
7854 There is no way to prevent those unread events
7855 from showing up later in last_nonmenu_event.
7856 So turn symbol and integer events into lists,
7857 to indicate that they came from a mouse menu,
7858 so that when present in last_nonmenu_event
7859 they won't confuse things. */
7860 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7862 record_menu_key (XCAR (tem
));
7863 if (SYMBOLP (XCAR (tem
))
7864 || INTEGERP (XCAR (tem
)))
7865 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7868 /* If we got more than one event, put all but the first
7869 onto this list to be read later.
7870 Return just the first event now. */
7871 Vunread_command_events
7872 = nconc2 (XCDR (value
), Vunread_command_events
);
7873 value
= XCAR (value
);
7875 else if (NILP (value
))
7877 if (used_mouse_menu
)
7878 *used_mouse_menu
= 1;
7881 #endif /* HAVE_MENUS */
7885 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7886 We make this bigger when necessary, and never free it. */
7887 static char *read_char_minibuf_menu_text
;
7888 /* Size of that buffer. */
7889 static int read_char_minibuf_menu_width
;
7892 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7898 register Lisp_Object name
;
7900 /* FIXME: Use the minibuffer's frame width. */
7901 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7904 Lisp_Object rest
, vector
;
7910 if (! menu_prompting
)
7913 /* Make sure we have a big enough buffer for the menu text. */
7914 if (read_char_minibuf_menu_text
== 0)
7916 read_char_minibuf_menu_width
= width
+ 4;
7917 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7919 else if (width
+ 4 > read_char_minibuf_menu_width
)
7921 read_char_minibuf_menu_width
= width
+ 4;
7922 read_char_minibuf_menu_text
7923 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7925 menu
= read_char_minibuf_menu_text
;
7927 /* Get the menu name from the first map that has one (a prompt string). */
7928 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7930 name
= Fkeymap_prompt (maps
[mapno
]);
7935 /* If we don't have any menus, just read a character normally. */
7936 if (!STRINGP (name
))
7939 /* Prompt string always starts with map's prompt, and a space. */
7940 strcpy (menu
, SDATA (name
));
7941 nlength
= SBYTES (name
);
7942 menu
[nlength
++] = ':';
7943 menu
[nlength
++] = ' ';
7946 /* Start prompting at start of first map. */
7950 /* Present the documented bindings, a line at a time. */
7957 Lisp_Object orig_defn_macro
;
7959 /* Loop over elements of map. */
7964 /* If reached end of map, start at beginning of next map. */
7968 /* At end of last map, wrap around to first map if just starting,
7969 or end this line if already have something on it. */
7973 if (notfirst
|| nobindings
) break;
7978 /* Look at the next element of the map. */
7980 elt
= XVECTOR (vector
)->contents
[idx
];
7982 elt
= Fcar_safe (rest
);
7984 if (idx
< 0 && VECTORP (elt
))
7986 /* If we found a dense table in the keymap,
7987 advanced past it, but start scanning its contents. */
7988 rest
= Fcdr_safe (rest
);
7994 /* An ordinary element. */
7995 Lisp_Object event
, tem
;
7999 event
= Fcar_safe (elt
); /* alist */
8000 elt
= Fcdr_safe (elt
);
8004 XSETINT (event
, idx
); /* vector */
8007 /* Ignore the element if it has no prompt string. */
8008 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8010 /* 1 if the char to type matches the string. */
8012 Lisp_Object upcased_event
, downcased_event
;
8013 Lisp_Object desc
= Qnil
;
8015 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8017 upcased_event
= Fupcase (event
);
8018 downcased_event
= Fdowncase (event
);
8019 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8020 || XINT (downcased_event
) == SREF (s
, 0));
8022 desc
= Fsingle_key_description (event
, Qnil
);
8024 #if 0 /* It is redundant to list the equivalent key bindings because
8025 the prefix is what the user has already typed. */
8027 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8029 /* Insert equivalent keybinding. */
8030 s
= concat2 (s
, tem
);
8033 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8034 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8036 /* Insert button prefix. */
8037 Lisp_Object selected
8038 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8039 if (EQ (tem
, QCradio
))
8040 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8042 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8043 s
= concat2 (tem
, s
);
8047 /* If we have room for the prompt string, add it to this line.
8048 If this is the first on the line, always add it. */
8049 if ((SCHARS (s
) + i
+ 2
8050 + (char_matches
? 0 : SCHARS (desc
) + 3))
8056 /* Punctuate between strings. */
8059 strcpy (menu
+ i
, ", ");
8065 /* If the char to type doesn't match the string's
8066 first char, explicitly show what char to type. */
8069 /* Add as much of string as fits. */
8070 thiswidth
= SCHARS (desc
);
8071 if (thiswidth
+ i
> width
)
8072 thiswidth
= width
- i
;
8073 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8075 strcpy (menu
+ i
, " = ");
8079 /* Add as much of string as fits. */
8080 thiswidth
= SCHARS (s
);
8081 if (thiswidth
+ i
> width
)
8082 thiswidth
= width
- i
;
8083 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8089 /* If this element does not fit, end the line now,
8090 and save the element for the next line. */
8091 strcpy (menu
+ i
, "...");
8096 /* Move past this element. */
8097 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8098 /* Handle reaching end of dense table. */
8103 rest
= Fcdr_safe (rest
);
8107 /* Prompt with that and read response. */
8108 message2_nolog (menu
, strlen (menu
),
8109 ! NILP (current_buffer
->enable_multibyte_characters
));
8111 /* Make believe its not a keyboard macro in case the help char
8112 is pressed. Help characters are not recorded because menu prompting
8113 is not used on replay.
8115 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8116 current_kboard
->defining_kbd_macro
= Qnil
;
8118 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8119 while (BUFFERP (obj
));
8120 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8122 if (!INTEGERP (obj
))
8127 if (! EQ (obj
, menu_prompt_more_char
)
8128 && (!INTEGERP (menu_prompt_more_char
)
8129 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8131 if (!NILP (current_kboard
->defining_kbd_macro
))
8132 store_kbd_macro_char (obj
);
8135 /* Help char - go round again */
8139 /* Reading key sequences. */
8141 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8142 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8143 keymap, or nil otherwise. Return the index of the first keymap in
8144 which KEY has any binding, or NMAPS if no map has a binding.
8146 If KEY is a meta ASCII character, treat it like meta-prefix-char
8147 followed by the corresponding non-meta character. Keymaps in
8148 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8151 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8154 NEXT may be the same array as CURRENT. */
8157 follow_key (key
, nmaps
, current
, defs
, next
)
8159 Lisp_Object
*current
, *defs
, *next
;
8162 int i
, first_binding
;
8165 first_binding
= nmaps
;
8166 for (i
= nmaps
- 1; i
>= 0; i
--)
8168 if (! NILP (current
[i
]))
8176 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
8177 if (! NILP (defs
[i
]))
8184 /* Given the set of bindings we've found, produce the next set of maps. */
8185 if (first_binding
< nmaps
)
8186 for (i
= 0; i
< nmaps
; i
++)
8187 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8189 return first_binding
;
8192 /* Structure used to keep track of partial application of key remapping
8193 such as Vfunction_key_map and Vkey_translation_map. */
8194 typedef struct keyremap
8201 /* Read a sequence of keys that ends with a non prefix character,
8202 storing it in KEYBUF, a buffer of size BUFSIZE.
8204 Return the length of the key sequence stored.
8205 Return -1 if the user rejected a command menu.
8207 Echo starting immediately unless `prompt' is 0.
8209 Where a key sequence ends depends on the currently active keymaps.
8210 These include any minor mode keymaps active in the current buffer,
8211 the current buffer's local map, and the global map.
8213 If a key sequence has no other bindings, we check Vfunction_key_map
8214 to see if some trailing subsequence might be the beginning of a
8215 function key's sequence. If so, we try to read the whole function
8216 key, and substitute its symbolic name into the key sequence.
8218 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8219 `double-' events into similar click events, if that would make them
8220 bound. We try to turn `triple-' events first into `double-' events,
8223 If we get a mouse click in a mode line, vertical divider, or other
8224 non-text area, we treat the click as if it were prefixed by the
8225 symbol denoting that area - `mode-line', `vertical-line', or
8228 If the sequence starts with a mouse click, we read the key sequence
8229 with respect to the buffer clicked on, not the current buffer.
8231 If the user switches frames in the midst of a key sequence, we put
8232 off the switch-frame event until later; the next call to
8233 read_char will return it.
8235 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8236 from the selected window's buffer. */
8239 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8240 can_return_switch_frame
, fix_current_buffer
)
8241 Lisp_Object
*keybuf
;
8244 int dont_downcase_last
;
8245 int can_return_switch_frame
;
8246 int fix_current_buffer
;
8248 volatile Lisp_Object from_string
;
8249 volatile int count
= SPECPDL_INDEX ();
8251 /* How many keys there are in the current key sequence. */
8254 /* The length of the echo buffer when we started reading, and
8255 the length of this_command_keys when we started reading. */
8256 volatile int echo_start
;
8257 volatile int keys_start
;
8259 /* The number of keymaps we're scanning right now, and the number of
8260 keymaps we have allocated space for. */
8262 volatile int nmaps_allocated
= 0;
8264 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8265 the current keymaps. */
8266 Lisp_Object
*volatile defs
= NULL
;
8268 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8269 in the current keymaps, or nil where it is not a prefix. */
8270 Lisp_Object
*volatile submaps
= NULL
;
8272 /* The local map to start out with at start of key sequence. */
8273 volatile Lisp_Object orig_local_map
;
8275 /* The map from the `keymap' property to start out with at start of
8277 volatile Lisp_Object orig_keymap
;
8279 /* 1 if we have already considered switching to the local-map property
8280 of the place where a mouse click occurred. */
8281 volatile int localized_local_map
= 0;
8283 /* The index in defs[] of the first keymap that has a binding for
8284 this key sequence. In other words, the lowest i such that
8285 defs[i] is non-nil. */
8286 volatile int first_binding
;
8287 /* Index of the first key that has no binding.
8288 It is useless to try fkey.start larger than that. */
8289 volatile int first_unbound
;
8291 /* If t < mock_input, then KEYBUF[t] should be read as the next
8294 We use this to recover after recognizing a function key. Once we
8295 realize that a suffix of the current key sequence is actually a
8296 function key's escape sequence, we replace the suffix with the
8297 function key's binding from Vfunction_key_map. Now keybuf
8298 contains a new and different key sequence, so the echo area,
8299 this_command_keys, and the submaps and defs arrays are wrong. In
8300 this situation, we set mock_input to t, set t to 0, and jump to
8301 restart_sequence; the loop will read keys from keybuf up until
8302 mock_input, thus rebuilding the state; and then it will resume
8303 reading characters from the keyboard. */
8304 volatile int mock_input
= 0;
8306 /* If the sequence is unbound in submaps[], then
8307 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8308 and fkey.map is its binding.
8310 These might be > t, indicating that all function key scanning
8311 should hold off until t reaches them. We do this when we've just
8312 recognized a function key, to avoid searching for the function
8313 key's again in Vfunction_key_map. */
8314 volatile keyremap fkey
;
8316 /* Likewise, for key_translation_map. */
8317 volatile keyremap keytran
;
8319 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8320 we put it off for later. While we're reading, we keep the event here. */
8321 volatile Lisp_Object delayed_switch_frame
;
8323 /* See the comment below... */
8324 #if defined (GOBBLE_FIRST_EVENT)
8325 Lisp_Object first_event
;
8328 volatile Lisp_Object original_uppercase
;
8329 volatile int original_uppercase_position
= -1;
8331 /* Gets around Microsoft compiler limitations. */
8334 struct buffer
*starting_buffer
;
8336 /* List of events for which a fake prefix key has been generated. */
8337 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8339 #if defined (GOBBLE_FIRST_EVENT)
8343 struct gcpro gcpro1
;
8345 GCPRO1 (fake_prefixed_keys
);
8346 raw_keybuf_count
= 0;
8348 last_nonmenu_event
= Qnil
;
8350 delayed_switch_frame
= Qnil
;
8351 fkey
.map
= Vfunction_key_map
;
8352 keytran
.map
= Vkey_translation_map
;
8353 /* If there is no translation-map, turn off scanning. */
8354 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8355 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8360 echo_prompt (prompt
);
8361 else if (cursor_in_echo_area
8362 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8363 && NILP (Fzerop (Vecho_keystrokes
)))
8364 /* This doesn't put in a dash if the echo buffer is empty, so
8365 you don't always see a dash hanging out in the minibuffer. */
8369 /* Record the initial state of the echo area and this_command_keys;
8370 we will need to restore them if we replay a key sequence. */
8372 echo_start
= echo_length ();
8373 keys_start
= this_command_key_count
;
8374 this_single_command_key_start
= keys_start
;
8376 #if defined (GOBBLE_FIRST_EVENT)
8377 /* This doesn't quite work, because some of the things that read_char
8378 does cannot safely be bypassed. It seems too risky to try to make
8381 /* Read the first char of the sequence specially, before setting
8382 up any keymaps, in case a filter runs and switches buffers on us. */
8383 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8385 #endif /* GOBBLE_FIRST_EVENT */
8387 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8388 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8391 /* We jump here when the key sequence has been thoroughly changed, and
8392 we need to rescan it starting from the beginning. When we jump here,
8393 keybuf[0..mock_input] holds the sequence we should reread. */
8396 starting_buffer
= current_buffer
;
8397 first_unbound
= bufsize
+ 1;
8399 /* Build our list of keymaps.
8400 If we recognize a function key and replace its escape sequence in
8401 keybuf with its symbol, or if the sequence starts with a mouse
8402 click and we need to switch buffers, we jump back here to rebuild
8403 the initial keymaps from the current buffer. */
8406 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8407 || !NILP (Voverriding_local_map
))
8409 if (3 > nmaps_allocated
)
8411 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8412 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8413 nmaps_allocated
= 3;
8415 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8416 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8417 if (!NILP (Voverriding_local_map
))
8418 submaps
[nmaps
++] = Voverriding_local_map
;
8426 nminor
= current_minor_maps (0, &maps
);
8427 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8429 if (total
> nmaps_allocated
)
8431 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8432 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8433 nmaps_allocated
= total
;
8436 if (!NILP (orig_keymap
))
8437 submaps
[nmaps
++] = orig_keymap
;
8439 bcopy (maps
, (void *) (submaps
+ nmaps
),
8440 nminor
* sizeof (submaps
[0]));
8444 submaps
[nmaps
++] = orig_local_map
;
8446 submaps
[nmaps
++] = current_global_map
;
8448 /* Find an accurate initial value for first_binding. */
8449 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8450 if (! NILP (submaps
[first_binding
]))
8453 /* Start from the beginning in keybuf. */
8456 /* These are no-ops the first time through, but if we restart, they
8457 revert the echo area and this_command_keys to their original state. */
8458 this_command_key_count
= keys_start
;
8459 if (INTERACTIVE
&& t
< mock_input
)
8460 echo_truncate (echo_start
);
8462 /* If the best binding for the current key sequence is a keymap, or
8463 we may be looking at a function key's escape sequence, keep on
8465 while (first_binding
< nmaps
8466 /* Keep reading as long as there's a prefix binding. */
8467 ? !NILP (submaps
[first_binding
])
8468 /* Don't return in the middle of a possible function key sequence,
8469 if the only bindings we found were via case conversion.
8470 Thus, if ESC O a has a function-key-map translation
8471 and ESC o has a binding, don't return after ESC O,
8472 so that we can translate ESC O plus the next character. */
8473 : (fkey
.start
< t
|| keytran
.start
< t
))
8476 int used_mouse_menu
= 0;
8478 /* Where the last real key started. If we need to throw away a
8479 key that has expanded into more than one element of keybuf
8480 (say, a mouse click on the mode line which is being treated
8481 as [mode-line (mouse-...)], then we backtrack to this point
8483 volatile int last_real_key_start
;
8485 /* These variables are analogous to echo_start and keys_start;
8486 while those allow us to restart the entire key sequence,
8487 echo_local_start and keys_local_start allow us to throw away
8489 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8491 /* key-translation-map is applied *after* function-key-map. */
8492 eassert (keytran
.end
<= fkey
.start
);
8494 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8495 { /* The prefix upto first_unbound has no binding and has
8496 no translation left to do either, so we know it's unbound.
8497 If we don't stop now, we risk staying here indefinitely
8498 (if the user keeps entering fkey or keytran prefixes
8499 like C-c ESC ESC ESC ESC ...) */
8501 for (i
= first_unbound
+ 1; i
< t
; i
++)
8502 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8503 mock_input
= t
- first_unbound
- 1;
8504 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8505 fkey
.map
= Vfunction_key_map
;
8506 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8507 keytran
.map
= Vkey_translation_map
;
8508 goto replay_sequence
;
8512 error ("Key sequence too long");
8515 echo_local_start
= echo_length ();
8516 keys_local_start
= this_command_key_count
;
8517 local_first_binding
= first_binding
;
8520 /* These are no-ops, unless we throw away a keystroke below and
8521 jumped back up to replay_key; in that case, these restore the
8522 variables to their original state, allowing us to replay the
8524 if (INTERACTIVE
&& t
< mock_input
)
8525 echo_truncate (echo_local_start
);
8526 this_command_key_count
= keys_local_start
;
8527 first_binding
= local_first_binding
;
8529 /* By default, assume each event is "real". */
8530 last_real_key_start
= t
;
8532 /* Does mock_input indicate that we are re-reading a key sequence? */
8536 add_command_key (key
);
8537 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8538 && NILP (Fzerop (Vecho_keystrokes
)))
8542 /* If not, we should actually read a character. */
8547 KBOARD
*interrupted_kboard
= current_kboard
;
8548 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8549 if (setjmp (wrong_kboard_jmpbuf
))
8551 if (!NILP (delayed_switch_frame
))
8553 interrupted_kboard
->kbd_queue
8554 = Fcons (delayed_switch_frame
,
8555 interrupted_kboard
->kbd_queue
);
8556 delayed_switch_frame
= Qnil
;
8559 interrupted_kboard
->kbd_queue
8560 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8562 /* If the side queue is non-empty, ensure it begins with a
8563 switch-frame, so we'll replay it in the right context. */
8564 if (CONSP (interrupted_kboard
->kbd_queue
)
8565 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8566 !(EVENT_HAS_PARAMETERS (key
)
8567 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8571 XSETFRAME (frame
, interrupted_frame
);
8572 interrupted_kboard
->kbd_queue
8573 = Fcons (make_lispy_switch_frame (frame
),
8574 interrupted_kboard
->kbd_queue
);
8577 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8578 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8579 goto replay_sequence
;
8582 key
= read_char (NILP (prompt
), nmaps
,
8583 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8587 /* read_char returns t when it shows a menu and the user rejects it.
8591 unbind_to (count
, Qnil
);
8596 /* read_char returns -1 at the end of a macro.
8597 Emacs 18 handles this by returning immediately with a
8598 zero, so that's what we'll do. */
8599 if (INTEGERP (key
) && XINT (key
) == -1)
8602 /* The Microsoft C compiler can't handle the goto that
8608 /* If the current buffer has been changed from under us, the
8609 keymap may have changed, so replay the sequence. */
8612 EMACS_TIME initial_idleness_start_time
;
8613 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8614 EMACS_SECS (timer_last_idleness_start_time
),
8615 EMACS_USECS (timer_last_idleness_start_time
));
8617 /* Resume idle state, using the same start-time as before. */
8618 timer_start_idle ();
8619 timer_idleness_start_time
= initial_idleness_start_time
;
8622 /* Reset the current buffer from the selected window
8623 in case something changed the former and not the latter.
8624 This is to be more consistent with the behavior
8625 of the command_loop_1. */
8626 if (fix_current_buffer
)
8628 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8630 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8631 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8634 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8635 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8636 goto replay_sequence
;
8639 /* If we have a quit that was typed in another frame, and
8640 quit_throw_to_read_char switched buffers,
8641 replay to get the right keymap. */
8643 && XINT (key
) == quit_char
8644 && current_buffer
!= starting_buffer
)
8647 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8651 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8652 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8653 goto replay_sequence
;
8658 if (EVENT_HAS_PARAMETERS (key
)
8659 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8661 /* If we're at the beginning of a key sequence, and the caller
8662 says it's okay, go ahead and return this event. If we're
8663 in the midst of a key sequence, delay it until the end. */
8664 if (t
> 0 || !can_return_switch_frame
)
8666 delayed_switch_frame
= key
;
8672 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8675 /* Clicks in non-text areas get prefixed by the symbol
8676 in their CHAR-ADDRESS field. For example, a click on
8677 the mode line is prefixed by the symbol `mode-line'.
8679 Furthermore, key sequences beginning with mouse clicks
8680 are read using the keymaps of the buffer clicked on, not
8681 the current buffer. So we may have to switch the buffer
8684 When we turn one event into two events, we must make sure
8685 that neither of the two looks like the original--so that,
8686 if we replay the events, they won't be expanded again.
8687 If not for this, such reexpansion could happen either here
8688 or when user programs play with this-command-keys. */
8689 if (EVENT_HAS_PARAMETERS (key
))
8693 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8694 if (EQ (kind
, Qmouse_click
))
8696 Lisp_Object window
, posn
;
8698 window
= POSN_WINDOW (EVENT_START (key
));
8699 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8702 || (!NILP (fake_prefixed_keys
)
8703 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8705 /* We're looking a second time at an event for which
8706 we generated a fake prefix key. Set
8707 last_real_key_start appropriately. */
8709 last_real_key_start
= t
- 1;
8712 /* Key sequences beginning with mouse clicks are
8713 read using the keymaps in the buffer clicked on,
8714 not the current buffer. If we're at the
8715 beginning of a key sequence, switch buffers. */
8716 if (last_real_key_start
== 0
8718 && BUFFERP (XWINDOW (window
)->buffer
)
8719 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8721 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8725 /* Arrange to go back to the original buffer once we're
8726 done reading the key sequence. Note that we can't
8727 use save_excursion_{save,restore} here, because they
8728 save point as well as the current buffer; we don't
8729 want to save point, because redisplay may change it,
8730 to accommodate a Fset_window_start or something. We
8731 don't want to do this at the top of the function,
8732 because we may get input from a subprocess which
8733 wants to change the selected window and stuff (say,
8735 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8737 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8739 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8740 orig_local_map
= get_local_map (PT
, current_buffer
,
8742 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8743 goto replay_sequence
;
8746 /* For a mouse click, get the local text-property keymap
8747 of the place clicked on, rather than point. */
8748 if (last_real_key_start
== 0
8749 && CONSP (XCDR (key
))
8750 && ! localized_local_map
)
8752 Lisp_Object map_here
, start
, pos
;
8754 localized_local_map
= 1;
8755 start
= EVENT_START (key
);
8757 if (CONSP (start
) && CONSP (XCDR (start
)))
8759 pos
= POSN_BUFFER_POSN (start
);
8761 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8763 map_here
= get_local_map (XINT (pos
),
8764 current_buffer
, Qlocal_map
);
8765 if (!EQ (map_here
, orig_local_map
))
8767 orig_local_map
= map_here
;
8771 goto replay_sequence
;
8773 map_here
= get_local_map (XINT (pos
),
8774 current_buffer
, Qkeymap
);
8775 if (!EQ (map_here
, orig_keymap
))
8777 orig_keymap
= map_here
;
8781 goto replay_sequence
;
8787 /* Expand mode-line and scroll-bar events into two events:
8788 use posn as a fake prefix key. */
8790 && (NILP (fake_prefixed_keys
)
8791 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8793 if (t
+ 1 >= bufsize
)
8794 error ("Key sequence too long");
8797 keybuf
[t
+ 1] = key
;
8800 /* Record that a fake prefix key has been generated
8801 for KEY. Don't modify the event; this would
8802 prevent proper action when the event is pushed
8803 back into unread-command-events. */
8804 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8806 /* If on a mode line string with a local keymap,
8807 reconsider the key sequence with that keymap. */
8808 if (CONSP (POSN_STRING (EVENT_START (key
))))
8810 Lisp_Object string
, pos
, map
, map2
;
8812 string
= POSN_STRING (EVENT_START (key
));
8813 pos
= XCDR (string
);
8814 string
= XCAR (string
);
8816 && XINT (pos
) < SCHARS (string
))
8818 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8820 orig_local_map
= map
;
8821 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8824 if (!NILP (map
) || !NILP (map2
))
8825 goto replay_sequence
;
8831 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8832 && NILP (from_string
))
8834 /* For a click on a string, i.e. overlay string or a
8835 string displayed via the `display' property,
8836 consider `local-map' and `keymap' properties of
8838 Lisp_Object string
, pos
, map
, map2
;
8840 string
= POSN_STRING (EVENT_START (key
));
8841 pos
= XCDR (string
);
8842 string
= XCAR (string
);
8844 && XINT (pos
) < SCHARS (string
))
8846 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8848 orig_local_map
= map
;
8849 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8853 if (!NILP (map
) || !NILP (map2
))
8855 from_string
= string
;
8856 goto replay_sequence
;
8861 else if (CONSP (XCDR (key
))
8862 && CONSP (EVENT_START (key
))
8863 && CONSP (XCDR (EVENT_START (key
))))
8867 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8868 /* Handle menu-bar events:
8869 insert the dummy prefix event `menu-bar'. */
8870 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8872 if (t
+ 1 >= bufsize
)
8873 error ("Key sequence too long");
8877 /* Zap the position in key, so we know that we've
8878 expanded it, and don't try to do so again. */
8879 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8880 Fcons (posn
, Qnil
));
8883 goto replay_sequence
;
8885 else if (CONSP (posn
))
8887 /* We're looking at the second event of a
8888 sequence which we expanded before. Set
8889 last_real_key_start appropriately. */
8890 if (last_real_key_start
== t
&& t
> 0)
8891 last_real_key_start
= t
- 1;
8896 /* We have finally decided that KEY is something we might want
8898 first_binding
= (follow_key (key
,
8899 nmaps
- first_binding
,
8900 submaps
+ first_binding
,
8901 defs
+ first_binding
,
8902 submaps
+ first_binding
)
8905 /* If KEY wasn't bound, we'll try some fallbacks. */
8906 if (first_binding
< nmaps
)
8907 /* This is needed for the following scenario:
8908 event 0: a down-event that gets dropped by calling replay_key.
8909 event 1: some normal prefix like C-h.
8910 After event 0, first_unbound is 0, after event 1 fkey.start
8911 and keytran.start are both 1, so when we see that C-h is bound,
8912 we need to update first_unbound. */
8913 first_unbound
= max (t
+ 1, first_unbound
);
8918 /* Remember the position to put an upper bound on fkey.start. */
8919 first_unbound
= min (t
, first_unbound
);
8921 head
= EVENT_HEAD (key
);
8922 if (help_char_p (head
) && t
> 0)
8924 read_key_sequence_cmd
= Vprefix_help_command
;
8926 last_nonmenu_event
= key
;
8927 /* The Microsoft C compiler can't handle the goto that
8935 Lisp_Object breakdown
;
8938 breakdown
= parse_modifiers (head
);
8939 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8940 /* Attempt to reduce an unbound mouse event to a simpler
8941 event that is bound:
8942 Drags reduce to clicks.
8943 Double-clicks reduce to clicks.
8944 Triple-clicks reduce to double-clicks, then to clicks.
8945 Down-clicks are eliminated.
8946 Double-downs reduce to downs, then are eliminated.
8947 Triple-downs reduce to double-downs, then to downs,
8948 then are eliminated. */
8949 if (modifiers
& (down_modifier
| drag_modifier
8950 | double_modifier
| triple_modifier
))
8952 while (modifiers
& (down_modifier
| drag_modifier
8953 | double_modifier
| triple_modifier
))
8955 Lisp_Object new_head
, new_click
;
8956 if (modifiers
& triple_modifier
)
8957 modifiers
^= (double_modifier
| triple_modifier
);
8958 else if (modifiers
& double_modifier
)
8959 modifiers
&= ~double_modifier
;
8960 else if (modifiers
& drag_modifier
)
8961 modifiers
&= ~drag_modifier
;
8964 /* Dispose of this `down' event by simply jumping
8965 back to replay_key, to get another event.
8967 Note that if this event came from mock input,
8968 then just jumping back to replay_key will just
8969 hand it to us again. So we have to wipe out any
8972 We could delete keybuf[t] and shift everything
8973 after that to the left by one spot, but we'd also
8974 have to fix up any variable that points into
8975 keybuf, and shifting isn't really necessary
8978 Adding prefixes for non-textual mouse clicks
8979 creates two characters of mock input, and both
8980 must be thrown away. If we're only looking at
8981 the prefix now, we can just jump back to
8982 replay_key. On the other hand, if we've already
8983 processed the prefix, and now the actual click
8984 itself is giving us trouble, then we've lost the
8985 state of the keymaps we want to backtrack to, and
8986 we need to replay the whole sequence to rebuild
8989 Beyond that, only function key expansion could
8990 create more than two keys, but that should never
8991 generate mouse events, so it's okay to zero
8992 mock_input in that case too.
8994 FIXME: The above paragraph seems just plain
8995 wrong, if you consider things like
8996 xterm-mouse-mode. -stef
8998 Isn't this just the most wonderful code ever? */
8999 if (t
== last_real_key_start
)
9006 mock_input
= last_real_key_start
;
9007 goto replay_sequence
;
9012 = apply_modifiers (modifiers
, XCAR (breakdown
));
9014 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9016 /* Look for a binding for this new key. follow_key
9017 promises that it didn't munge submaps the
9018 last time we called it, since key was unbound. */
9020 = (follow_key (new_click
,
9021 nmaps
- local_first_binding
,
9022 submaps
+ local_first_binding
,
9023 defs
+ local_first_binding
,
9024 submaps
+ local_first_binding
)
9025 + local_first_binding
);
9027 /* If that click is bound, go for it. */
9028 if (first_binding
< nmaps
)
9033 /* Otherwise, we'll leave key set to the drag event. */
9040 /* Normally, last_nonmenu_event gets the previous key we read.
9041 But when a mouse popup menu is being used,
9042 we don't update last_nonmenu_event; it continues to hold the mouse
9043 event that preceded the first level of menu. */
9044 if (!used_mouse_menu
)
9045 last_nonmenu_event
= key
;
9047 /* Record what part of this_command_keys is the current key sequence. */
9048 this_single_command_key_start
= this_command_key_count
- t
;
9050 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9051 /* There is a binding and it's not a prefix.
9052 There is thus no function-key in this sequence.
9053 Moving fkey.start is important in this case to allow keytran.start
9054 to go over the sequence before we return (since we keep the
9055 invariant that keytran.end <= fkey.start). */
9058 (fkey
.start
= fkey
.end
= t
, fkey
.map
= Vfunction_key_map
);
9061 /* If the sequence is unbound, see if we can hang a function key
9062 off the end of it. */
9066 /* Continue scan from fkey.end until we find a bound suffix.
9067 If we fail, increment fkey.start and start over from there. */
9068 while (fkey
.end
< t
)
9072 key
= keybuf
[fkey
.end
++];
9073 next
= access_keymap (fkey
.map
, key
, 1, 0, 1);
9075 /* Handle symbol with autoload definition. */
9076 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9077 && CONSP (XSYMBOL (next
)->function
)
9078 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9079 do_autoload (XSYMBOL (next
)->function
, next
);
9081 /* Handle a symbol whose function definition is a keymap
9083 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9084 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9085 || KEYMAPP (XSYMBOL (next
)->function
)))
9086 next
= XSYMBOL (next
)->function
;
9088 #if 0 /* I didn't turn this on, because it might cause trouble
9089 for the mapping of return into C-m and tab into C-i. */
9090 /* Optionally don't map function keys into other things.
9091 This enables the user to redefine kp- keys easily. */
9092 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
9096 /* If the function key map gives a function, not an
9097 array, then call the function with no args and use
9098 its value instead. */
9099 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9100 /* If there's a binding (i.e. first_binding >= nmaps)
9101 we don't want to apply this function-key-mapping. */
9102 && fkey
.end
== t
&& first_binding
>= nmaps
)
9104 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9108 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9109 next
= call1 (next
, prompt
);
9111 /* If the function returned something invalid,
9112 barf--don't ignore it.
9113 (To ignore it safely, we would need to gcpro a bunch of
9114 other variables.) */
9115 if (! (VECTORP (next
) || STRINGP (next
)))
9116 error ("Function in key-translation-map returns invalid key sequence");
9119 /* If keybuf[fkey.start..fkey.end] is bound in the
9120 function key map and it's a suffix of the current
9121 sequence (i.e. fkey.end == t), replace it with
9122 the binding and restart with fkey.start at the end. */
9123 if ((VECTORP (next
) || STRINGP (next
))
9124 /* If there's a binding (i.e. first_binding >= nmaps)
9125 we don't want to apply this function-key-mapping. */
9126 && fkey
.end
== t
&& first_binding
>= nmaps
)
9128 int len
= XFASTINT (Flength (next
));
9130 t
= fkey
.start
+ len
;
9132 error ("Key sequence too long");
9135 bcopy (XVECTOR (next
)->contents
,
9136 keybuf
+ fkey
.start
,
9137 (t
- fkey
.start
) * sizeof (keybuf
[0]));
9138 else if (STRINGP (next
))
9142 for (i
= 0; i
< len
; i
++)
9143 XSETFASTINT (keybuf
[fkey
.start
+ i
], SREF (next
, i
));
9147 fkey
.start
= fkey
.end
= t
;
9148 fkey
.map
= Vfunction_key_map
;
9150 /* Do pass the results through key-translation-map.
9151 But don't retranslate what key-translation-map
9152 has already translated. */
9153 keytran
.end
= keytran
.start
;
9154 keytran
.map
= Vkey_translation_map
;
9156 goto replay_sequence
;
9159 fkey
.map
= get_keymap (next
, 0, 1);
9161 /* If we no longer have a bound suffix, try a new positions for
9163 if (!CONSP (fkey
.map
))
9165 fkey
.end
= ++fkey
.start
;
9166 fkey
.map
= Vfunction_key_map
;
9171 /* Look for this sequence in key-translation-map. */
9175 /* Scan from keytran.end until we find a bound suffix. */
9176 while (keytran
.end
< fkey
.start
)
9180 key
= keybuf
[keytran
.end
++];
9181 next
= access_keymap (keytran
.map
, key
, 1, 0, 1);
9183 /* Handle symbol with autoload definition. */
9184 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9185 && CONSP (XSYMBOL (next
)->function
)
9186 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9187 do_autoload (XSYMBOL (next
)->function
, next
);
9189 /* Handle a symbol whose function definition is a keymap
9191 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9192 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9193 || KEYMAPP (XSYMBOL (next
)->function
)))
9194 next
= XSYMBOL (next
)->function
;
9196 /* If the key translation map gives a function, not an
9197 array, then call the function with one arg and use
9198 its value instead. */
9199 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
)))
9201 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9205 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9206 next
= call1 (next
, prompt
);
9208 /* If the function returned something invalid,
9209 barf--don't ignore it.
9210 (To ignore it safely, we would need to gcpro a bunch of
9211 other variables.) */
9212 if (! (VECTORP (next
) || STRINGP (next
)))
9213 error ("Function in key-translation-map returns invalid key sequence");
9216 /* If keybuf[keytran.start..keytran.end] is bound in the
9217 key translation map and it's a suffix of the current
9218 sequence (i.e. keytran.end == t), replace it with
9219 the binding and restart with keytran.start at the end. */
9220 if ((VECTORP (next
) || STRINGP (next
)))
9222 int len
= XFASTINT (Flength (next
));
9223 int i
, diff
= len
- (keytran
.end
- keytran
.start
);
9225 mock_input
= max (t
, mock_input
);
9226 if (mock_input
+ diff
>= bufsize
)
9227 error ("Key sequence too long");
9229 /* Shift the keys that are after keytran.end. */
9231 for (i
= keytran
.end
; i
< mock_input
; i
++)
9232 keybuf
[i
+ diff
] = keybuf
[i
];
9234 for (i
= mock_input
- 1; i
>= keytran
.end
; i
--)
9235 keybuf
[i
+ diff
] = keybuf
[i
];
9236 /* Replace the keys between keytran.start and keytran.end
9237 with those from next. */
9238 for (i
= 0; i
< len
; i
++)
9239 keybuf
[keytran
.start
+ i
]
9240 = Faref (next
, make_number (i
));
9243 keytran
.start
= keytran
.end
+= diff
;
9244 keytran
.map
= Vkey_translation_map
;
9246 /* Adjust the function-key-map counters. */
9250 goto replay_sequence
;
9253 keytran
.map
= get_keymap (next
, 0, 1);
9255 /* If we no longer have a bound suffix, try a new positions for
9257 if (!CONSP (keytran
.map
))
9259 keytran
.end
= ++keytran
.start
;
9260 keytran
.map
= Vkey_translation_map
;
9265 /* If KEY is not defined in any of the keymaps,
9266 and cannot be part of a function key or translation,
9267 and is an upper case letter
9268 use the corresponding lower-case letter instead. */
9269 if (first_binding
>= nmaps
9270 && fkey
.start
>= t
&& keytran
.start
>= t
9272 && ((((XINT (key
) & 0x3ffff)
9273 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9274 && UPPERCASEP (XINT (key
) & 0x3ffff))
9275 || (XINT (key
) & shift_modifier
)))
9277 Lisp_Object new_key
;
9279 original_uppercase
= key
;
9280 original_uppercase_position
= t
- 1;
9282 if (XINT (key
) & shift_modifier
)
9283 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9285 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9286 | (XINT (key
) & ~0x3ffff)));
9288 /* We have to do this unconditionally, regardless of whether
9289 the lower-case char is defined in the keymaps, because they
9290 might get translated through function-key-map. */
9291 keybuf
[t
- 1] = new_key
;
9292 mock_input
= max (t
, mock_input
);
9294 goto replay_sequence
;
9296 /* If KEY is not defined in any of the keymaps,
9297 and cannot be part of a function key or translation,
9298 and is a shifted function key,
9299 use the corresponding unshifted function key instead. */
9300 if (first_binding
>= nmaps
9301 && fkey
.start
>= t
&& keytran
.start
>= t
9304 Lisp_Object breakdown
;
9307 breakdown
= parse_modifiers (key
);
9308 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9309 if (modifiers
& shift_modifier
)
9311 Lisp_Object new_key
;
9313 original_uppercase
= key
;
9314 original_uppercase_position
= t
- 1;
9316 modifiers
&= ~shift_modifier
;
9317 new_key
= apply_modifiers (modifiers
,
9320 keybuf
[t
- 1] = new_key
;
9321 mock_input
= max (t
, mock_input
);
9323 goto replay_sequence
;
9329 read_key_sequence_cmd
= (first_binding
< nmaps
9330 ? defs
[first_binding
]
9333 unread_switch_frame
= delayed_switch_frame
;
9334 unbind_to (count
, Qnil
);
9336 /* Don't downcase the last character if the caller says don't.
9337 Don't downcase it if the result is undefined, either. */
9338 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9339 && t
- 1 == original_uppercase_position
)
9340 keybuf
[t
- 1] = original_uppercase
;
9342 /* Occasionally we fabricate events, perhaps by expanding something
9343 according to function-key-map, or by adding a prefix symbol to a
9344 mouse click in the scroll bar or modeline. In this cases, return
9345 the entire generated key sequence, even if we hit an unbound
9346 prefix or a definition before the end. This means that you will
9347 be able to push back the event properly, and also means that
9348 read-key-sequence will always return a logical unit.
9351 for (; t
< mock_input
; t
++)
9353 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9354 && NILP (Fzerop (Vecho_keystrokes
)))
9355 echo_char (keybuf
[t
]);
9356 add_command_key (keybuf
[t
]);
9365 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9366 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9367 The sequence is sufficient to specify a non-prefix command in the
9368 current local and global maps.
9370 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9371 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9372 as a continuation of the previous key.
9374 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9375 convert the last event to lower case. (Normally any upper case event
9376 is converted to lower case if the original event is undefined and the lower
9377 case equivalent is defined.) A non-nil value is appropriate for reading
9378 a key sequence to be defined.
9380 A C-g typed while in this function is treated like any other character,
9381 and `quit-flag' is not set.
9383 If the key sequence starts with a mouse click, then the sequence is read
9384 using the keymaps of the buffer of the window clicked in, not the buffer
9385 of the selected window as normal.
9387 `read-key-sequence' drops unbound button-down events, since you normally
9388 only care about the click or drag events which follow them. If a drag
9389 or multi-click event is unbound, but the corresponding click event would
9390 be bound, `read-key-sequence' turns the event into a click event at the
9391 drag's starting position. This means that you don't have to distinguish
9392 between click and drag, double, or triple events unless you want to.
9394 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9395 lines separating windows, and scroll bars with imaginary keys
9396 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9398 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9399 function will process a switch-frame event if the user switches frames
9400 before typing anything. If the user switches frames in the middle of a
9401 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9402 is nil, then the event will be put off until after the current key sequence.
9404 `read-key-sequence' checks `function-key-map' for function key
9405 sequences, where they wouldn't conflict with ordinary bindings. See
9406 `function-key-map' for more details.
9408 The optional fifth argument COMMAND-LOOP, if non-nil, means
9409 that this key sequence is being read by something that will
9410 read commands one after another. It should be nil if the caller
9411 will read just one key sequence. */)
9412 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9414 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9415 Lisp_Object can_return_switch_frame
, command_loop
;
9417 Lisp_Object keybuf
[30];
9419 struct gcpro gcpro1
;
9420 int count
= SPECPDL_INDEX ();
9423 CHECK_STRING (prompt
);
9426 specbind (Qinput_method_exit_on_first_char
,
9427 (NILP (command_loop
) ? Qt
: Qnil
));
9428 specbind (Qinput_method_use_echo_area
,
9429 (NILP (command_loop
) ? Qt
: Qnil
));
9431 bzero (keybuf
, sizeof keybuf
);
9433 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9435 if (NILP (continue_echo
))
9437 this_command_key_count
= 0;
9438 this_command_key_count_reset
= 0;
9439 this_single_command_key_start
= 0;
9442 #ifdef HAVE_X_WINDOWS
9443 if (display_hourglass_p
)
9444 cancel_hourglass ();
9447 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9448 prompt
, ! NILP (dont_downcase_last
),
9449 ! NILP (can_return_switch_frame
), 0);
9451 #if 0 /* The following is fine for code reading a key sequence and
9452 then proceeding with a lenghty computation, but it's not good
9453 for code reading keys in a loop, like an input method. */
9454 #ifdef HAVE_X_WINDOWS
9455 if (display_hourglass_p
)
9466 return unbind_to (count
, make_event_array (i
, keybuf
));
9469 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9470 Sread_key_sequence_vector
, 1, 5, 0,
9471 doc
: /* Like `read-key-sequence' but always return a vector. */)
9472 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9474 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9475 Lisp_Object can_return_switch_frame
, command_loop
;
9477 Lisp_Object keybuf
[30];
9479 struct gcpro gcpro1
;
9480 int count
= SPECPDL_INDEX ();
9483 CHECK_STRING (prompt
);
9486 specbind (Qinput_method_exit_on_first_char
,
9487 (NILP (command_loop
) ? Qt
: Qnil
));
9488 specbind (Qinput_method_use_echo_area
,
9489 (NILP (command_loop
) ? Qt
: Qnil
));
9491 bzero (keybuf
, sizeof keybuf
);
9493 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9495 if (NILP (continue_echo
))
9497 this_command_key_count
= 0;
9498 this_command_key_count_reset
= 0;
9499 this_single_command_key_start
= 0;
9502 #ifdef HAVE_X_WINDOWS
9503 if (display_hourglass_p
)
9504 cancel_hourglass ();
9507 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9508 prompt
, ! NILP (dont_downcase_last
),
9509 ! NILP (can_return_switch_frame
), 0);
9511 #ifdef HAVE_X_WINDOWS
9512 if (display_hourglass_p
)
9522 return unbind_to (count
, Fvector (i
, keybuf
));
9525 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9526 doc
: /* Execute CMD as an editor command.
9527 CMD must be a symbol that satisfies the `commandp' predicate.
9528 Optional second arg RECORD-FLAG non-nil
9529 means unconditionally put this command in `command-history'.
9530 Otherwise, that is done only if an arg is read using the minibuffer.
9531 The argument KEYS specifies the value to use instead of (this-command-keys)
9532 when reading the arguments; if it is nil, (this-command-keys) is used.
9533 The argument SPECIAL, if non-nil, means that this command is executing
9534 a special event, so ignore the prefix argument and don't clear it. */)
9535 (cmd
, record_flag
, keys
, special
)
9536 Lisp_Object cmd
, record_flag
, keys
, special
;
9538 register Lisp_Object final
;
9539 register Lisp_Object tem
;
9540 Lisp_Object prefixarg
;
9541 struct backtrace backtrace
;
9542 extern int debug_on_next_call
;
9544 debug_on_next_call
= 0;
9548 prefixarg
= current_kboard
->Vprefix_arg
;
9549 Vcurrent_prefix_arg
= prefixarg
;
9550 current_kboard
->Vprefix_arg
= Qnil
;
9557 tem
= Fget (cmd
, Qdisabled
);
9558 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9560 tem
= Fsymbol_value (Qdisabled_command_hook
);
9562 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9568 final
= Findirect_function (cmd
);
9570 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9572 struct gcpro gcpro1
, gcpro2
;
9574 GCPRO2 (cmd
, prefixarg
);
9575 do_autoload (final
, cmd
);
9582 if (STRINGP (final
) || VECTORP (final
))
9584 /* If requested, place the macro in the command history. For
9585 other sorts of commands, call-interactively takes care of
9587 if (!NILP (record_flag
))
9590 = Fcons (Fcons (Qexecute_kbd_macro
,
9591 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9594 /* Don't keep command history around forever. */
9595 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9597 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9599 XSETCDR (tem
, Qnil
);
9603 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9606 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9608 backtrace
.next
= backtrace_list
;
9609 backtrace_list
= &backtrace
;
9610 backtrace
.function
= &Qcall_interactively
;
9611 backtrace
.args
= &cmd
;
9612 backtrace
.nargs
= 1;
9613 backtrace
.evalargs
= 0;
9615 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9617 backtrace_list
= backtrace
.next
;
9625 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9627 doc
: /* Read function name, then read its arguments and call it. */)
9629 Lisp_Object prefixarg
;
9631 Lisp_Object function
;
9633 int saved_last_point_position
;
9634 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9635 Lisp_Object bindings
, value
;
9636 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9638 saved_keys
= Fvector (this_command_key_count
,
9639 XVECTOR (this_command_keys
)->contents
);
9640 saved_last_point_position_buffer
= last_point_position_buffer
;
9641 saved_last_point_position
= last_point_position
;
9643 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9645 if (EQ (prefixarg
, Qminus
))
9647 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9648 strcpy (buf
, "C-u ");
9649 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9651 if (sizeof (int) == sizeof (EMACS_INT
))
9652 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9653 else if (sizeof (long) == sizeof (EMACS_INT
))
9654 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9658 else if (INTEGERP (prefixarg
))
9660 if (sizeof (int) == sizeof (EMACS_INT
))
9661 sprintf (buf
, "%d ", XINT (prefixarg
));
9662 else if (sizeof (long) == sizeof (EMACS_INT
))
9663 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9668 /* This isn't strictly correct if execute-extended-command
9669 is bound to anything else. Perhaps it should use
9670 this_command_keys? */
9671 strcat (buf
, "M-x ");
9673 /* Prompt with buf, and then read a string, completing from and
9674 restricting to the set of all defined commands. Don't provide
9675 any initial input. Save the command read on the extended-command
9677 function
= Fcompleting_read (build_string (buf
),
9678 Vobarray
, Qcommandp
,
9679 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9682 if (STRINGP (function
) && SCHARS (function
) == 0)
9683 error ("No command name given");
9685 /* Set this_command_keys to the concatenation of saved_keys and
9686 function, followed by a RET. */
9691 this_command_key_count
= 0;
9692 this_command_key_count_reset
= 0;
9693 this_single_command_key_start
= 0;
9695 keys
= XVECTOR (saved_keys
)->contents
;
9696 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9697 add_command_key (keys
[i
]);
9699 for (i
= 0; i
< SCHARS (function
); i
++)
9700 add_command_key (Faref (function
, make_number (i
)));
9702 add_command_key (make_number ('\015'));
9705 last_point_position
= saved_last_point_position
;
9706 last_point_position_buffer
= saved_last_point_position_buffer
;
9710 function
= Fintern (function
, Qnil
);
9711 current_kboard
->Vprefix_arg
= prefixarg
;
9712 Vthis_command
= function
;
9713 real_this_command
= function
;
9715 /* If enabled, show which key runs this command. */
9716 if (!NILP (Vsuggest_key_bindings
)
9717 && NILP (Vexecuting_macro
)
9718 && SYMBOLP (function
))
9719 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9725 GCPRO2 (bindings
, value
);
9726 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9728 /* If the command has a key binding, print it now. */
9729 if (!NILP (bindings
)
9730 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9733 /* But first wait, and skip the message if there is input. */
9735 if (!NILP (echo_area_buffer
[0]))
9736 /* This command displayed something in the echo area;
9737 so wait a few seconds, then display our suggestion message. */
9738 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9739 ? XINT (Vsuggest_key_bindings
) : 2);
9741 /* This command left the echo area empty,
9742 so display our message immediately. */
9745 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9746 && ! CONSP (Vunread_command_events
))
9748 Lisp_Object binding
;
9750 int message_p
= push_message ();
9751 int count
= SPECPDL_INDEX ();
9753 record_unwind_protect (pop_message_unwind
, Qnil
);
9754 binding
= Fkey_description (bindings
);
9757 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9760 sprintf (newmessage
, "You can run the command `%s' with %s",
9761 SDATA (SYMBOL_NAME (function
)),
9763 message2_nolog (newmessage
,
9764 strlen (newmessage
),
9765 STRING_MULTIBYTE (binding
));
9766 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9767 ? Vsuggest_key_bindings
: make_number (2)),
9772 unbind_to (count
, Qnil
);
9776 RETURN_UNGCPRO (value
);
9780 /* Return nonzero if input events are pending. */
9783 detect_input_pending ()
9786 get_input_pending (&input_pending
, 0);
9788 return input_pending
;
9791 /* Return nonzero if input events are pending, and run any pending timers. */
9794 detect_input_pending_run_timers (do_display
)
9797 int old_timers_run
= timers_run
;
9800 get_input_pending (&input_pending
, 1);
9802 if (old_timers_run
!= timers_run
&& do_display
)
9804 redisplay_preserve_echo_area (8);
9805 /* The following fixes a bug when using lazy-lock with
9806 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9807 from an idle timer function. The symptom of the bug is that
9808 the cursor sometimes doesn't become visible until the next X
9809 event is processed. --gerd. */
9811 rif
->flush_display (NULL
);
9814 return input_pending
;
9817 /* This is called in some cases before a possible quit.
9818 It cases the next call to detect_input_pending to recompute input_pending.
9819 So calling this function unnecessarily can't do any harm. */
9822 clear_input_pending ()
9827 /* Return nonzero if there are pending requeued events.
9828 This isn't used yet. The hope is to make wait_reading_process_input
9829 call it, and return if it runs Lisp code that unreads something.
9830 The problem is, kbd_buffer_get_event needs to be fixed to know what
9831 to do in that case. It isn't trivial. */
9834 requeued_events_pending_p ()
9836 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9840 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9841 doc
: /* Return t if command input is currently available with no wait.
9842 Actually, the value is nil only if we can be sure that no input is available;
9843 if there is a doubt, the value is t. */)
9846 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9849 get_filtered_input_pending (&input_pending
, 1, 1);
9850 return input_pending
> 0 ? Qt
: Qnil
;
9853 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9854 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9857 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9860 if (total_keys
< NUM_RECENT_KEYS
)
9861 return Fvector (total_keys
, keys
);
9864 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9865 bcopy (keys
+ recent_keys_index
,
9866 XVECTOR (val
)->contents
,
9867 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9869 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9870 recent_keys_index
* sizeof (Lisp_Object
));
9875 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9876 doc
: /* Return the key sequence that invoked this command.
9877 However, if the command has called `read-key-sequence', it returns
9878 the last key sequence that has been read.
9879 The value is a string or a vector. */)
9882 return make_event_array (this_command_key_count
,
9883 XVECTOR (this_command_keys
)->contents
);
9886 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9887 doc
: /* Return the key sequence that invoked this command, as a vector.
9888 However, if the command has called `read-key-sequence', it returns
9889 the last key sequence that has been read. */)
9892 return Fvector (this_command_key_count
,
9893 XVECTOR (this_command_keys
)->contents
);
9896 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9897 Sthis_single_command_keys
, 0, 0, 0,
9898 doc
: /* Return the key sequence that invoked this command.
9899 More generally, it returns the last key sequence read, either by
9900 the command loop or by `read-key-sequence'.
9901 Unlike `this-command-keys', this function's value
9902 does not include prefix arguments.
9903 The value is always a vector. */)
9906 return Fvector (this_command_key_count
9907 - this_single_command_key_start
,
9908 (XVECTOR (this_command_keys
)->contents
9909 + this_single_command_key_start
));
9912 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9913 Sthis_single_command_raw_keys
, 0, 0, 0,
9914 doc
: /* Return the raw events that were read for this command.
9915 More generally, it returns the last key sequence read, either by
9916 the command loop or by `read-key-sequence'.
9917 Unlike `this-single-command-keys', this function's value
9918 shows the events before all translations (except for input methods).
9919 The value is always a vector. */)
9922 return Fvector (raw_keybuf_count
,
9923 (XVECTOR (raw_keybuf
)->contents
));
9926 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9927 Sreset_this_command_lengths
, 0, 0, 0,
9928 doc
: /* Make the unread events replace the last command and echo.
9929 Used in `universal-argument-other-key'.
9931 `universal-argument-other-key' rereads the event just typed.
9932 It then gets translated through `function-key-map'.
9933 The translated event has to replace the real events,
9934 both in the value of (this-command-keys) and in echoing.
9935 To achieve this, `universal-argument-other-key' calls
9936 `reset-this-command-lengths', which discards the record of reading
9937 these events the first time. */)
9940 this_command_key_count
= before_command_key_count
;
9941 if (this_command_key_count
< this_single_command_key_start
)
9942 this_single_command_key_start
= this_command_key_count
;
9944 echo_truncate (before_command_echo_length
);
9946 /* Cause whatever we put into unread-command-events
9947 to echo as if it were being freshly read from the keyboard. */
9948 this_command_key_count_reset
= 1;
9953 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9954 Sclear_this_command_keys
, 0, 1, 0,
9955 doc
: /* Clear out the vector that `this-command-keys' returns.
9956 Also clear the record of the last 100 events, unless optional arg
9957 KEEP-RECORD is non-nil. */)
9959 Lisp_Object keep_record
;
9963 this_command_key_count
= 0;
9964 this_command_key_count_reset
= 0;
9966 if (NILP (keep_record
))
9968 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9969 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9971 recent_keys_index
= 0;
9976 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9977 doc
: /* Return the current depth in recursive edits. */)
9981 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9985 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9986 "FOpen dribble file: ",
9987 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9988 If FILE is nil, close any open dribble file. */)
9999 file
= Fexpand_file_name (file
, Qnil
);
10000 dribble
= fopen (SDATA (file
), "w");
10002 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10007 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10008 doc
: /* Discard the contents of the terminal input buffer.
10009 Also end any kbd macro being defined. */)
10012 if (!NILP (current_kboard
->defining_kbd_macro
))
10014 /* Discard the last command from the macro. */
10015 Fcancel_kbd_macro_events ();
10019 update_mode_lines
++;
10021 Vunread_command_events
= Qnil
;
10022 unread_command_char
= -1;
10024 discard_tty_input ();
10026 kbd_fetch_ptr
= kbd_store_ptr
;
10027 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10033 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10034 doc
: /* Stop Emacs and return to superior process. You can resume later.
10035 If `cannot-suspend' is non-nil, or if the system doesn't support job
10036 control, run a subshell instead.
10038 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10039 to be read as terminal input by Emacs's parent, after suspension.
10041 Before suspending, run the normal hook `suspend-hook'.
10042 After resumption run the normal hook `suspend-resume-hook'.
10044 Some operating systems cannot stop the Emacs process and resume it later.
10045 On such systems, Emacs starts a subshell instead of suspending. */)
10047 Lisp_Object stuffstring
;
10049 int count
= SPECPDL_INDEX ();
10050 int old_height
, old_width
;
10052 struct gcpro gcpro1
;
10054 if (!NILP (stuffstring
))
10055 CHECK_STRING (stuffstring
);
10057 /* Run the functions in suspend-hook. */
10058 if (!NILP (Vrun_hooks
))
10059 call1 (Vrun_hooks
, intern ("suspend-hook"));
10061 GCPRO1 (stuffstring
);
10062 get_frame_size (&old_width
, &old_height
);
10063 reset_sys_modes ();
10064 /* sys_suspend can get an error if it tries to fork a subshell
10065 and the system resources aren't available for that. */
10066 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10068 stuff_buffered_input (stuffstring
);
10069 if (cannot_suspend
)
10073 unbind_to (count
, Qnil
);
10075 /* Check if terminal/window size has changed.
10076 Note that this is not useful when we are running directly
10077 with a window system; but suspend should be disabled in that case. */
10078 get_frame_size (&width
, &height
);
10079 if (width
!= old_width
|| height
!= old_height
)
10080 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10082 /* Run suspend-resume-hook. */
10083 if (!NILP (Vrun_hooks
))
10084 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10090 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10091 Then in any case stuff anything Emacs has read ahead and not used. */
10094 stuff_buffered_input (stuffstring
)
10095 Lisp_Object stuffstring
;
10097 /* stuff_char works only in BSD, versions 4.2 and up. */
10100 register unsigned char *p
;
10102 if (STRINGP (stuffstring
))
10104 register int count
;
10106 p
= SDATA (stuffstring
);
10107 count
= SBYTES (stuffstring
);
10108 while (count
-- > 0)
10113 /* Anything we have read ahead, put back for the shell to read. */
10114 /* ?? What should this do when we have multiple keyboards??
10115 Should we ignore anything that was typed in at the "wrong" kboard? */
10116 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10120 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10121 kbd_fetch_ptr
= kbd_buffer
;
10122 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10123 stuff_char (kbd_fetch_ptr
->code
);
10125 kbd_fetch_ptr
->kind
= NO_EVENT
;
10126 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10127 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10128 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10133 #endif /* BSD_SYSTEM and not BSD4_1 */
10137 set_waiting_for_input (time_to_clear
)
10138 EMACS_TIME
*time_to_clear
;
10140 input_available_clear_time
= time_to_clear
;
10142 /* Tell interrupt_signal to throw back to read_char, */
10143 waiting_for_input
= 1;
10145 /* If interrupt_signal was called before and buffered a C-g,
10146 make it run again now, to avoid timing error. */
10147 if (!NILP (Vquit_flag
))
10148 quit_throw_to_read_char ();
10152 clear_waiting_for_input ()
10154 /* Tell interrupt_signal not to throw back to read_char, */
10155 waiting_for_input
= 0;
10156 input_available_clear_time
= 0;
10159 /* This routine is called at interrupt level in response to C-g.
10161 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10162 is called from kbd_buffer_store_event, in handling SIGIO or
10165 If `waiting_for_input' is non zero, then unless `echoing' is
10166 nonzero, immediately throw back to read_char.
10168 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10169 eval to throw, when it gets a chance. If quit-flag is already
10170 non-nil, it stops the job right away. */
10173 interrupt_signal (signalnum
) /* If we don't have an argument, */
10174 int signalnum
; /* some compilers complain in signal calls. */
10177 /* Must preserve main program's value of errno. */
10178 int old_errno
= errno
;
10179 struct frame
*sf
= SELECTED_FRAME ();
10181 #if defined (USG) && !defined (POSIX_SIGNALS)
10182 if (!read_socket_hook
&& NILP (Vwindow_system
))
10184 /* USG systems forget handlers when they are used;
10185 must reestablish each time */
10186 signal (SIGINT
, interrupt_signal
);
10187 signal (SIGQUIT
, interrupt_signal
);
10193 if (!NILP (Vquit_flag
)
10194 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10196 /* If SIGINT isn't blocked, don't let us be interrupted by
10197 another SIGINT, it might be harmful due to non-reentrancy
10198 in I/O functions. */
10199 sigblock (sigmask (SIGINT
));
10202 reset_sys_modes ();
10204 #ifdef SIGTSTP /* Support possible in later USG versions */
10206 * On systems which can suspend the current process and return to the original
10207 * shell, this command causes the user to end up back at the shell.
10208 * The "Auto-save" and "Abort" questions are not asked until
10209 * the user elects to return to emacs, at which point he can save the current
10210 * job and either dump core or continue.
10215 if (sys_suspend () == -1)
10217 printf ("Not running as a subprocess;\n");
10218 printf ("you can continue or abort.\n");
10220 #else /* not VMS */
10221 /* Perhaps should really fork an inferior shell?
10222 But that would not provide any way to get back
10223 to the original shell, ever. */
10224 printf ("No support for stopping a process on this operating system;\n");
10225 printf ("you can continue or abort.\n");
10226 #endif /* not VMS */
10227 #endif /* not SIGTSTP */
10229 /* We must remain inside the screen area when the internal terminal
10230 is used. Note that [Enter] is not echoed by dos. */
10233 /* It doesn't work to autosave while GC is in progress;
10234 the code used for auto-saving doesn't cope with the mark bit. */
10235 if (!gc_in_progress
)
10237 printf ("Auto-save? (y or n) ");
10239 if (((c
= getchar ()) & ~040) == 'Y')
10241 Fdo_auto_save (Qt
, Qnil
);
10243 printf ("\r\nAuto-save done");
10244 #else /* not MSDOS */
10245 printf ("Auto-save done\n");
10246 #endif /* not MSDOS */
10248 while (c
!= '\n') c
= getchar ();
10252 /* During GC, it must be safe to reenable quitting again. */
10253 Vinhibit_quit
= Qnil
;
10256 #endif /* not MSDOS */
10257 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10258 printf ("but will instead do a real quit after garbage collection ends\r\n");
10263 printf ("\r\nAbort? (y or n) ");
10264 #else /* not MSDOS */
10266 printf ("Abort (and enter debugger)? (y or n) ");
10267 #else /* not VMS */
10268 printf ("Abort (and dump core)? (y or n) ");
10269 #endif /* not VMS */
10270 #endif /* not MSDOS */
10272 if (((c
= getchar ()) & ~040) == 'Y')
10274 while (c
!= '\n') c
= getchar ();
10276 printf ("\r\nContinuing...\r\n");
10277 #else /* not MSDOS */
10278 printf ("Continuing...\n");
10279 #endif /* not MSDOS */
10286 /* If executing a function that wants to be interrupted out of
10287 and the user has not deferred quitting by binding `inhibit-quit'
10288 then quit right away. */
10289 if (immediate_quit
&& NILP (Vinhibit_quit
))
10291 struct gl_state_s saved
;
10292 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10294 immediate_quit
= 0;
10297 GCPRO4 (saved
.object
, saved
.global_code
,
10298 saved
.current_syntax_table
, saved
.old_prop
);
10299 Fsignal (Qquit
, Qnil
);
10304 /* Else request quit when it's safe */
10308 if (waiting_for_input
&& !echoing
)
10309 quit_throw_to_read_char ();
10314 /* Handle a C-g by making read_char return C-g. */
10317 quit_throw_to_read_char ()
10320 /* Prevent another signal from doing this before we finish. */
10321 clear_waiting_for_input ();
10324 Vunread_command_events
= Qnil
;
10325 unread_command_char
= -1;
10327 #if 0 /* Currently, sit_for is called from read_char without turning
10328 off polling. And that can call set_waiting_for_input.
10329 It seems to be harmless. */
10330 #ifdef POLL_FOR_INPUT
10331 /* May be > 1 if in recursive minibuffer. */
10332 if (poll_suppress_count
== 0)
10336 if (FRAMEP (internal_last_event_frame
)
10337 && !EQ (internal_last_event_frame
, selected_frame
))
10338 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10341 _longjmp (getcjmp
, 1);
10344 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10345 doc
: /* Set mode of reading keyboard input.
10346 First arg INTERRUPT non-nil means use input interrupts;
10347 nil means use CBREAK mode.
10348 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10349 (no effect except in CBREAK mode).
10350 Third arg META t means accept 8-bit input (for a Meta key).
10351 META nil means ignore the top bit, on the assumption it is parity.
10352 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10353 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10354 See also `current-input-mode'. */)
10355 (interrupt
, flow
, meta
, quit
)
10356 Lisp_Object interrupt
, flow
, meta
, quit
;
10359 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10360 error ("set-input-mode: QUIT must be an ASCII character");
10362 #ifdef POLL_FOR_INPUT
10367 /* this causes startup screen to be restored and messes with the mouse */
10368 reset_sys_modes ();
10372 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10373 if (read_socket_hook
)
10375 /* When using X, don't give the user a real choice,
10376 because we haven't implemented the mechanisms to support it. */
10377 #ifdef NO_SOCK_SIGIO
10378 interrupt_input
= 0;
10379 #else /* not NO_SOCK_SIGIO */
10380 interrupt_input
= 1;
10381 #endif /* NO_SOCK_SIGIO */
10384 interrupt_input
= !NILP (interrupt
);
10385 #else /* not SIGIO */
10386 interrupt_input
= 0;
10387 #endif /* not SIGIO */
10389 /* Our VMS input only works by interrupts, as of now. */
10391 interrupt_input
= 1;
10394 flow_control
= !NILP (flow
);
10397 else if (EQ (meta
, Qt
))
10402 /* Don't let this value be out of range. */
10403 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10409 #ifdef POLL_FOR_INPUT
10410 poll_suppress_count
= 1;
10416 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10417 doc
: /* Return information about the way Emacs currently reads keyboard input.
10418 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10419 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10420 nil, Emacs is using CBREAK mode.
10421 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10422 terminal; this does not apply if Emacs uses interrupt-driven input.
10423 META is t if accepting 8-bit input with 8th bit as Meta flag.
10424 META nil means ignoring the top bit, on the assumption it is parity.
10425 META is neither t nor nil if accepting 8-bit input and using
10426 all 8 bits as the character code.
10427 QUIT is the character Emacs currently uses to quit.
10428 The elements of this list correspond to the arguments of
10429 `set-input-mode'. */)
10432 Lisp_Object val
[4];
10434 val
[0] = interrupt_input
? Qt
: Qnil
;
10435 val
[1] = flow_control
? Qt
: Qnil
;
10436 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10437 XSETFASTINT (val
[3], quit_char
);
10439 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10444 * Set up a new kboard object with reasonable initial values.
10450 kb
->Voverriding_terminal_local_map
= Qnil
;
10451 kb
->Vlast_command
= Qnil
;
10452 kb
->Vreal_last_command
= Qnil
;
10453 kb
->Vprefix_arg
= Qnil
;
10454 kb
->Vlast_prefix_arg
= Qnil
;
10455 kb
->kbd_queue
= Qnil
;
10456 kb
->kbd_queue_has_data
= 0;
10457 kb
->immediate_echo
= 0;
10458 kb
->echo_string
= Qnil
;
10459 kb
->echo_after_prompt
= -1;
10460 kb
->kbd_macro_buffer
= 0;
10461 kb
->kbd_macro_bufsize
= 0;
10462 kb
->defining_kbd_macro
= Qnil
;
10463 kb
->Vlast_kbd_macro
= Qnil
;
10464 kb
->reference_count
= 0;
10465 kb
->Vsystem_key_alist
= Qnil
;
10466 kb
->system_key_syms
= Qnil
;
10467 kb
->Vdefault_minibuffer_frame
= Qnil
;
10471 * Destroy the contents of a kboard object, but not the object itself.
10472 * We use this just before deleting it, or if we're going to initialize
10473 * it a second time.
10479 if (kb
->kbd_macro_buffer
)
10480 xfree (kb
->kbd_macro_buffer
);
10483 #ifdef MULTI_KBOARD
10485 /* Free KB and memory referenced from it. */
10493 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10496 *kbp
= kb
->next_kboard
;
10498 /* Prevent a dangling reference to KB. */
10499 if (kb
== current_kboard
10500 && FRAMEP (selected_frame
)
10501 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10503 current_kboard
= XFRAME (selected_frame
)->kboard
;
10504 if (current_kboard
== kb
)
10512 #endif /* MULTI_KBOARD */
10517 /* This is correct before outermost invocation of the editor loop */
10518 command_loop_level
= -1;
10519 immediate_quit
= 0;
10520 quit_char
= Ctl ('g');
10521 Vunread_command_events
= Qnil
;
10522 unread_command_char
= -1;
10523 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10525 recent_keys_index
= 0;
10526 kbd_fetch_ptr
= kbd_buffer
;
10527 kbd_store_ptr
= kbd_buffer
;
10528 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10530 do_mouse_tracking
= Qnil
;
10534 /* This means that command_loop_1 won't try to select anything the first
10536 internal_last_event_frame
= Qnil
;
10537 Vlast_event_frame
= internal_last_event_frame
;
10539 #ifdef MULTI_KBOARD
10540 current_kboard
= initial_kboard
;
10542 wipe_kboard (current_kboard
);
10543 init_kboard (current_kboard
);
10545 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10547 signal (SIGINT
, interrupt_signal
);
10548 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10549 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10550 SIGQUIT and we can't tell which one it will give us. */
10551 signal (SIGQUIT
, interrupt_signal
);
10552 #endif /* HAVE_TERMIO */
10554 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10556 if (!noninteractive
)
10557 signal (SIGIO
, input_available_signal
);
10560 /* Use interrupt input by default, if it works and noninterrupt input
10561 has deficiencies. */
10563 #ifdef INTERRUPT_INPUT
10564 interrupt_input
= 1;
10566 interrupt_input
= 0;
10569 /* Our VMS input only works by interrupts, as of now. */
10571 interrupt_input
= 1;
10577 if (keyboard_init_hook
)
10578 (*keyboard_init_hook
) ();
10580 #ifdef POLL_FOR_INPUT
10581 poll_suppress_count
= 1;
10586 /* This type's only use is in syms_of_keyboard, to initialize the
10587 event header symbols and put properties on them. */
10588 struct event_head
{
10594 struct event_head head_table
[] = {
10595 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10596 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10597 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10598 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10599 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10600 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10601 {&Qselect_window
, "select-window", &Qselect_window
}
10605 syms_of_keyboard ()
10607 Vpre_help_message
= Qnil
;
10608 staticpro (&Vpre_help_message
);
10610 Vlispy_mouse_stem
= build_string ("mouse");
10611 staticpro (&Vlispy_mouse_stem
);
10614 QCimage
= intern (":image");
10615 staticpro (&QCimage
);
10617 staticpro (&Qhelp_echo
);
10618 Qhelp_echo
= intern ("help-echo");
10620 staticpro (&item_properties
);
10621 item_properties
= Qnil
;
10623 staticpro (&tool_bar_item_properties
);
10624 tool_bar_item_properties
= Qnil
;
10625 staticpro (&tool_bar_items_vector
);
10626 tool_bar_items_vector
= Qnil
;
10628 staticpro (&real_this_command
);
10629 real_this_command
= Qnil
;
10631 Qtimer_event_handler
= intern ("timer-event-handler");
10632 staticpro (&Qtimer_event_handler
);
10634 Qdisabled_command_hook
= intern ("disabled-command-hook");
10635 staticpro (&Qdisabled_command_hook
);
10637 Qself_insert_command
= intern ("self-insert-command");
10638 staticpro (&Qself_insert_command
);
10640 Qforward_char
= intern ("forward-char");
10641 staticpro (&Qforward_char
);
10643 Qbackward_char
= intern ("backward-char");
10644 staticpro (&Qbackward_char
);
10646 Qdisabled
= intern ("disabled");
10647 staticpro (&Qdisabled
);
10649 Qundefined
= intern ("undefined");
10650 staticpro (&Qundefined
);
10652 Qpre_command_hook
= intern ("pre-command-hook");
10653 staticpro (&Qpre_command_hook
);
10655 Qpost_command_hook
= intern ("post-command-hook");
10656 staticpro (&Qpost_command_hook
);
10658 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10659 staticpro (&Qpost_command_idle_hook
);
10661 Qdeferred_action_function
= intern ("deferred-action-function");
10662 staticpro (&Qdeferred_action_function
);
10664 Qcommand_hook_internal
= intern ("command-hook-internal");
10665 staticpro (&Qcommand_hook_internal
);
10667 Qfunction_key
= intern ("function-key");
10668 staticpro (&Qfunction_key
);
10669 Qmouse_click
= intern ("mouse-click");
10670 staticpro (&Qmouse_click
);
10671 #if defined(WINDOWSNT) || defined(MAC_OSX)
10672 Qmouse_wheel
= intern ("mouse-wheel");
10673 staticpro (&Qmouse_wheel
);
10676 Qlanguage_change
= intern ("language-change");
10677 staticpro (&Qlanguage_change
);
10679 Qdrag_n_drop
= intern ("drag-n-drop");
10680 staticpro (&Qdrag_n_drop
);
10682 Qsave_session
= intern ("save-session");
10683 staticpro(&Qsave_session
);
10685 Qusr1_signal
= intern ("usr1-signal");
10686 staticpro (&Qusr1_signal
);
10687 Qusr2_signal
= intern ("usr2-signal");
10688 staticpro (&Qusr2_signal
);
10690 Qmenu_enable
= intern ("menu-enable");
10691 staticpro (&Qmenu_enable
);
10692 Qmenu_alias
= intern ("menu-alias");
10693 staticpro (&Qmenu_alias
);
10694 QCenable
= intern (":enable");
10695 staticpro (&QCenable
);
10696 QCvisible
= intern (":visible");
10697 staticpro (&QCvisible
);
10698 QChelp
= intern (":help");
10699 staticpro (&QChelp
);
10700 QCfilter
= intern (":filter");
10701 staticpro (&QCfilter
);
10702 QCbutton
= intern (":button");
10703 staticpro (&QCbutton
);
10704 QCkeys
= intern (":keys");
10705 staticpro (&QCkeys
);
10706 QCkey_sequence
= intern (":key-sequence");
10707 staticpro (&QCkey_sequence
);
10708 QCtoggle
= intern (":toggle");
10709 staticpro (&QCtoggle
);
10710 QCradio
= intern (":radio");
10711 staticpro (&QCradio
);
10713 Qmode_line
= intern ("mode-line");
10714 staticpro (&Qmode_line
);
10715 Qvertical_line
= intern ("vertical-line");
10716 staticpro (&Qvertical_line
);
10717 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10718 staticpro (&Qvertical_scroll_bar
);
10719 Qmenu_bar
= intern ("menu-bar");
10720 staticpro (&Qmenu_bar
);
10722 Qabove_handle
= intern ("above-handle");
10723 staticpro (&Qabove_handle
);
10724 Qhandle
= intern ("handle");
10725 staticpro (&Qhandle
);
10726 Qbelow_handle
= intern ("below-handle");
10727 staticpro (&Qbelow_handle
);
10728 Qup
= intern ("up");
10730 Qdown
= intern ("down");
10731 staticpro (&Qdown
);
10732 Qtop
= intern ("top");
10734 Qbottom
= intern ("bottom");
10735 staticpro (&Qbottom
);
10736 Qend_scroll
= intern ("end-scroll");
10737 staticpro (&Qend_scroll
);
10738 Qratio
= intern ("ratio");
10739 staticpro (&Qratio
);
10741 Qevent_kind
= intern ("event-kind");
10742 staticpro (&Qevent_kind
);
10743 Qevent_symbol_elements
= intern ("event-symbol-elements");
10744 staticpro (&Qevent_symbol_elements
);
10745 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10746 staticpro (&Qevent_symbol_element_mask
);
10747 Qmodifier_cache
= intern ("modifier-cache");
10748 staticpro (&Qmodifier_cache
);
10750 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10751 staticpro (&Qrecompute_lucid_menubar
);
10752 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10753 staticpro (&Qactivate_menubar_hook
);
10755 Qpolling_period
= intern ("polling-period");
10756 staticpro (&Qpolling_period
);
10758 Qinput_method_function
= intern ("input-method-function");
10759 staticpro (&Qinput_method_function
);
10761 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10762 staticpro (&Qinput_method_exit_on_first_char
);
10763 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10764 staticpro (&Qinput_method_use_echo_area
);
10766 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10767 Fset (Qinput_method_use_echo_area
, Qnil
);
10769 last_point_position_buffer
= Qnil
;
10772 struct event_head
*p
;
10774 for (p
= head_table
;
10775 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10778 *p
->var
= intern (p
->name
);
10779 staticpro (p
->var
);
10780 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10781 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10785 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10786 staticpro (&button_down_location
);
10787 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10788 staticpro (&mouse_syms
);
10792 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10794 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10795 for (i
= 0; i
< len
; i
++)
10796 if (modifier_names
[i
])
10797 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10798 staticpro (&modifier_symbols
);
10801 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10802 staticpro (&recent_keys
);
10804 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10805 staticpro (&this_command_keys
);
10807 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10808 staticpro (&raw_keybuf
);
10810 Qextended_command_history
= intern ("extended-command-history");
10811 Fset (Qextended_command_history
, Qnil
);
10812 staticpro (&Qextended_command_history
);
10814 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10815 staticpro (&kbd_buffer_gcpro
);
10817 accent_key_syms
= Qnil
;
10818 staticpro (&accent_key_syms
);
10820 func_key_syms
= Qnil
;
10821 staticpro (&func_key_syms
);
10823 #if defined(WINDOWSNT) || defined(MAC_OSX)
10824 mouse_wheel_syms
= Qnil
;
10825 staticpro (&mouse_wheel_syms
);
10826 drag_n_drop_syms
= Qnil
;
10827 staticpro (&drag_n_drop_syms
);
10830 unread_switch_frame
= Qnil
;
10831 staticpro (&unread_switch_frame
);
10833 internal_last_event_frame
= Qnil
;
10834 staticpro (&internal_last_event_frame
);
10836 read_key_sequence_cmd
= Qnil
;
10837 staticpro (&read_key_sequence_cmd
);
10839 menu_bar_one_keymap_changed_items
= Qnil
;
10840 staticpro (&menu_bar_one_keymap_changed_items
);
10842 defsubr (&Sevent_convert_list
);
10843 defsubr (&Sread_key_sequence
);
10844 defsubr (&Sread_key_sequence_vector
);
10845 defsubr (&Srecursive_edit
);
10847 defsubr (&Strack_mouse
);
10849 defsubr (&Sinput_pending_p
);
10850 defsubr (&Scommand_execute
);
10851 defsubr (&Srecent_keys
);
10852 defsubr (&Sthis_command_keys
);
10853 defsubr (&Sthis_command_keys_vector
);
10854 defsubr (&Sthis_single_command_keys
);
10855 defsubr (&Sthis_single_command_raw_keys
);
10856 defsubr (&Sreset_this_command_lengths
);
10857 defsubr (&Sclear_this_command_keys
);
10858 defsubr (&Ssuspend_emacs
);
10859 defsubr (&Sabort_recursive_edit
);
10860 defsubr (&Sexit_recursive_edit
);
10861 defsubr (&Srecursion_depth
);
10862 defsubr (&Stop_level
);
10863 defsubr (&Sdiscard_input
);
10864 defsubr (&Sopen_dribble_file
);
10865 defsubr (&Sset_input_mode
);
10866 defsubr (&Scurrent_input_mode
);
10867 defsubr (&Sexecute_extended_command
);
10869 DEFVAR_LISP ("last-command-char", &last_command_char
,
10870 doc
: /* Last input event that was part of a command. */);
10872 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10873 doc
: /* Last input event that was part of a command. */);
10875 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10876 doc
: /* Last input event in a command, except for mouse menu events.
10877 Mouse menus give back keys that don't look like mouse events;
10878 this variable holds the actual mouse event that led to the menu,
10879 so that you can determine whether the command was run by mouse or not. */);
10881 DEFVAR_LISP ("last-input-char", &last_input_char
,
10882 doc
: /* Last input event. */);
10884 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10885 doc
: /* Last input event. */);
10887 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10888 doc
: /* List of events to be read as the command input.
10889 These events are processed first, before actual keyboard input. */);
10890 Vunread_command_events
= Qnil
;
10892 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10893 doc
: /* If not -1, an object to be read as next command input event. */);
10895 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10896 doc
: /* List of events to be processed as input by input methods.
10897 These events are processed after `unread-command-events', but
10898 before actual keyboard input. */);
10899 Vunread_post_input_method_events
= Qnil
;
10901 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10902 doc
: /* List of events to be processed as input by input methods.
10903 These events are processed after `unread-command-events', but
10904 before actual keyboard input. */);
10905 Vunread_input_method_events
= Qnil
;
10907 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10908 doc
: /* Meta-prefix character code.
10909 Meta-foo as command input turns into this character followed by foo. */);
10910 XSETINT (meta_prefix_char
, 033);
10912 DEFVAR_KBOARD ("last-command", Vlast_command
,
10913 doc
: /* The last command executed.
10914 Normally a symbol with a function definition, but can be whatever was found
10915 in the keymap, or whatever the variable `this-command' was set to by that
10918 The value `mode-exit' is special; it means that the previous command
10919 read an event that told it to exit, and it did so and unread that event.
10920 In other words, the present command is the event that made the previous
10923 The value `kill-region' is special; it means that the previous command
10924 was a kill command. */);
10926 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10927 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10929 DEFVAR_LISP ("this-command", &Vthis_command
,
10930 doc
: /* The command now being executed.
10931 The command can set this variable; whatever is put here
10932 will be in `last-command' during the following command. */);
10933 Vthis_command
= Qnil
;
10935 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10936 doc
: /* The command bound to the current key sequence before remapping.
10937 It equals `this-command' if the original command was not remapped through
10938 any of the active keymaps. Otherwise, the value of `this-command' is the
10939 result of looking up the original command in the active keymaps. */);
10940 Vthis_original_command
= Qnil
;
10942 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10943 doc
: /* *Number of input events between auto-saves.
10944 Zero means disable autosaving due to number of characters typed. */);
10945 auto_save_interval
= 300;
10947 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10948 doc
: /* *Number of seconds idle time before auto-save.
10949 Zero or nil means disable auto-saving due to idleness.
10950 After auto-saving due to this many seconds of idle time,
10951 Emacs also does a garbage collection if that seems to be warranted. */);
10952 XSETFASTINT (Vauto_save_timeout
, 30);
10954 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10955 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10956 The value may be integer or floating point. */);
10957 Vecho_keystrokes
= make_number (1);
10959 DEFVAR_INT ("polling-period", &polling_period
,
10960 doc
: /* *Interval between polling for input during Lisp execution.
10961 The reason for polling is to make C-g work to stop a running program.
10962 Polling is needed only when using X windows and SIGIO does not work.
10963 Polling is automatically disabled in all other cases. */);
10964 polling_period
= 2;
10966 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10967 doc
: /* *Maximum time between mouse clicks to make a double-click.
10968 Measured in milliseconds. nil means disable double-click recognition;
10969 t means double-clicks have no time limit and are detected
10970 by position only. */);
10971 Vdouble_click_time
= make_number (500);
10973 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10974 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10975 On window-system frames, value is the number of pixels the mouse may have
10976 moved horizontally or vertically between two clicks to make a double-click.
10977 On non window-system frames, value is interpreted in units of 1/8 characters
10980 This variable is also the threshold for motion of the mouse
10981 to count as a drag. */);
10982 double_click_fuzz
= 3;
10984 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10985 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10986 inhibit_local_menu_bar_menus
= 0;
10988 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10989 doc
: /* Number of complete key sequences read as input so far.
10990 This includes key sequences read from keyboard macros.
10991 The number is effectively the number of interactive command invocations. */);
10992 num_input_keys
= 0;
10994 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10995 doc
: /* Number of input events read from the keyboard so far.
10996 This does not include events generated by keyboard macros. */);
10997 num_nonmacro_input_events
= 0;
10999 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11000 doc
: /* The frame in which the most recently read event occurred.
11001 If the last event came from a keyboard macro, this is set to `macro'. */);
11002 Vlast_event_frame
= Qnil
;
11004 /* This variable is set up in sysdep.c. */
11005 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11006 doc
: /* The ERASE character as set by the user with stty. */);
11008 DEFVAR_LISP ("help-char", &Vhelp_char
,
11009 doc
: /* Character to recognize as meaning Help.
11010 When it is read, do `(eval help-form)', and display result if it's a string.
11011 If the value of `help-form' is nil, this char can be read normally. */);
11012 XSETINT (Vhelp_char
, Ctl ('H'));
11014 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11015 doc
: /* List of input events to recognize as meaning Help.
11016 These work just like the value of `help-char' (see that). */);
11017 Vhelp_event_list
= Qnil
;
11019 DEFVAR_LISP ("help-form", &Vhelp_form
,
11020 doc
: /* Form to execute when character `help-char' is read.
11021 If the form returns a string, that string is displayed.
11022 If `help-form' is nil, the help char is not recognized. */);
11025 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11026 doc
: /* Command to run when `help-char' character follows a prefix key.
11027 This command is used only when there is no actual binding
11028 for that character after that prefix key. */);
11029 Vprefix_help_command
= Qnil
;
11031 DEFVAR_LISP ("top-level", &Vtop_level
,
11032 doc
: /* Form to evaluate when Emacs starts up.
11033 Useful to set before you dump a modified Emacs. */);
11036 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11037 doc
: /* Translate table for keyboard input, or nil.
11038 Each character is looked up in this string and the contents used instead.
11039 The value may be a string, a vector, or a char-table.
11040 If it is a string or vector of length N,
11041 character codes N and up are untranslated.
11042 In a vector or a char-table, an element which is nil means "no translation".
11044 This is applied to the characters supplied to input methods, not their
11045 output. See also `translation-table-for-input'. */);
11046 Vkeyboard_translate_table
= Qnil
;
11048 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11049 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11050 \(Even if the operating system has support for stopping a process.\) */);
11051 cannot_suspend
= 0;
11053 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11054 doc
: /* Non-nil means prompt with menus when appropriate.
11055 This is done when reading from a keymap that has a prompt string,
11056 for elements that have prompt strings.
11057 The menu is displayed on the screen
11058 if X menus were enabled at configuration
11059 time and the previous event was a mouse click prefix key.
11060 Otherwise, menu prompting uses the echo area. */);
11061 menu_prompting
= 1;
11063 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11064 doc
: /* Character to see next line of menu prompt.
11065 Type this character while in a menu prompt to rotate around the lines of it. */);
11066 XSETINT (menu_prompt_more_char
, ' ');
11068 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11069 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11070 Emacs applies the modifiers of the character stored here to each keyboard
11071 character it reads. For example, after evaluating the expression
11072 (setq extra-keyboard-modifiers ?\\C-x)
11073 all input characters will have the control modifier applied to them.
11075 Note that the character ?\\C-@, equivalent to the integer zero, does
11076 not count as a control character; rather, it counts as a character
11077 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11078 cancels any modification. */);
11079 extra_keyboard_modifiers
= 0;
11081 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11082 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11083 The command loop sets this to nil before each command,
11084 and tests the value when the command returns.
11085 Buffer modification stores t in this variable. */);
11086 Vdeactivate_mark
= Qnil
;
11088 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11089 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11090 Vcommand_hook_internal
= Qnil
;
11092 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11093 doc
: /* Normal hook run before each command is executed.
11094 If an unhandled error happens in running this hook,
11095 the hook value is set to nil, since otherwise the error
11096 might happen repeatedly and make Emacs nonfunctional. */);
11097 Vpre_command_hook
= Qnil
;
11099 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11100 doc
: /* Normal hook run after each command is executed.
11101 If an unhandled error happens in running this hook,
11102 the hook value is set to nil, since otherwise the error
11103 might happen repeatedly and make Emacs nonfunctional. */);
11104 Vpost_command_hook
= Qnil
;
11106 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11107 doc
: /* Normal hook run after each command is executed, if idle.
11108 Errors running the hook are caught and ignored. */);
11109 Vpost_command_idle_hook
= Qnil
;
11111 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11112 doc
: /* Delay time before running `post-command-idle-hook'.
11113 This is measured in microseconds. */);
11114 post_command_idle_delay
= 100000;
11117 DEFVAR_LISP ("echo-area-clear-hook", ...,
11118 doc
: /* Normal hook run when clearing the echo area. */);
11120 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11121 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11123 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11124 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11125 Vlucid_menu_bar_dirty_flag
= Qnil
;
11127 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11128 doc
: /* List of menu bar items to move to the end of the menu bar.
11129 The elements of the list are event types that may have menu bar bindings. */);
11130 Vmenu_bar_final_items
= Qnil
;
11132 DEFVAR_KBOARD ("overriding-terminal-local-map",
11133 Voverriding_terminal_local_map
,
11134 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11135 If this variable is non-nil, it is used as a keymap instead of the
11136 buffer's local map, and the minor mode keymaps and text property keymaps.
11137 This variable is intended to let commands such as `universal-argument'
11138 set up a different keymap for reading the next command. */);
11140 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11141 doc
: /* Keymap that overrides all other local keymaps.
11142 If this variable is non-nil, it is used as a keymap instead of the
11143 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11144 Voverriding_local_map
= Qnil
;
11146 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11147 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11148 Otherwise, the menu bar continues to reflect the buffer's local map
11149 and the minor mode maps regardless of `overriding-local-map'. */);
11150 Voverriding_local_map_menu_flag
= Qnil
;
11152 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11153 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11154 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11156 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11157 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11159 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11160 doc
: /* Alist of system-specific X windows key symbols.
11161 Each element should have the form (N . SYMBOL) where N is the
11162 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11163 and SYMBOL is its name. */);
11165 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11166 doc
: /* List of deferred actions to be performed at a later time.
11167 The precise format isn't relevant here; we just check whether it is nil. */);
11168 Vdeferred_action_list
= Qnil
;
11170 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11171 doc
: /* Function to call to handle deferred actions, after each command.
11172 This function is called with no arguments after each command
11173 whenever `deferred-action-list' is non-nil. */);
11174 Vdeferred_action_function
= Qnil
;
11176 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11177 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11178 The value can be a length of time to show the message for.
11179 If the value is non-nil and not a number, we wait 2 seconds. */);
11180 Vsuggest_key_bindings
= Qt
;
11182 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11183 doc
: /* List of active absolute time timers in order of increasing time. */);
11184 Vtimer_list
= Qnil
;
11186 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11187 doc
: /* List of active idle-time timers in order of increasing time. */);
11188 Vtimer_idle_list
= Qnil
;
11190 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11191 doc
: /* If non-nil, the function that implements the current input method.
11192 It's called with one argument, a printing character that was just read.
11193 \(That means a character with code 040...0176.)
11194 Typically this function uses `read-event' to read additional events.
11195 When it does so, it should first bind `input-method-function' to nil
11196 so it will not be called recursively.
11198 The function should return a list of zero or more events
11199 to be used as input. If it wants to put back some events
11200 to be reconsidered, separately, by the input method,
11201 it can add them to the beginning of `unread-command-events'.
11203 The input method function can find in `input-method-previous-method'
11204 the previous echo area message.
11206 The input method function should refer to the variables
11207 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11208 for guidance on what to do. */);
11209 Vinput_method_function
= Qnil
;
11211 DEFVAR_LISP ("input-method-previous-message",
11212 &Vinput_method_previous_message
,
11213 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11214 This variable exists because `read-event' clears the echo area
11215 before running the input method. It is nil if there was no message. */);
11216 Vinput_method_previous_message
= Qnil
;
11218 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11219 doc
: /* If non-nil, the function that implements the display of help.
11220 It's called with one argument, the help string to display. */);
11221 Vshow_help_function
= Qnil
;
11223 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11224 doc
: /* If non-nil, suppress point adjustment after executing a command.
11226 After a command is executed, if point is moved into a region that has
11227 special properties (e.g. composition, display), we adjust point to
11228 the boundary of the region. But, several special commands sets this
11229 variable to non-nil, then we suppress the point adjustment.
11231 This variable is set to nil before reading a command, and is checked
11232 just after executing the command. */);
11233 Vdisable_point_adjustment
= Qnil
;
11235 DEFVAR_LISP ("global-disable-point-adjustment",
11236 &Vglobal_disable_point_adjustment
,
11237 doc
: /* *If non-nil, always suppress point adjustment.
11239 The default value is nil, in which case, point adjustment are
11240 suppressed only after special commands that set
11241 `disable-point-adjustment' (which see) to non-nil. */);
11242 Vglobal_disable_point_adjustment
= Qnil
;
11244 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11245 doc
: /* Non-nil means updating menu bindings is allowed.
11246 A value of nil means menu bindings should not be updated.
11247 Used during Emacs' startup. */);
11248 update_menu_bindings
= 1;
11250 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11251 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11252 If the value is not a number, such messages don't time out. */);
11253 Vminibuffer_message_timeout
= make_number (2);
11257 keys_of_keyboard ()
11259 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11260 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11261 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11262 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11263 initial_define_key (meta_map
, 'x', "execute-extended-command");
11265 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11266 "handle-delete-frame");
11267 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11269 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11271 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11272 "handle-select-window");
11273 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11274 "handle-save-session");