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));
1362 Lisp_Object keybuf
[30];
1366 struct buffer
*prev_buffer
= NULL
;
1368 int was_locked
= single_kboard
;
1370 int already_adjusted
;
1372 current_kboard
->Vprefix_arg
= Qnil
;
1373 current_kboard
->Vlast_prefix_arg
= Qnil
;
1374 Vdeactivate_mark
= Qnil
;
1375 waiting_for_input
= 0;
1379 this_command_key_count
= 0;
1380 this_command_key_count_reset
= 0;
1381 this_single_command_key_start
= 0;
1383 if (NILP (Vmemory_full
))
1385 /* Make sure this hook runs after commands that get errors and
1386 throw to top level. */
1387 /* Note that the value cell will never directly contain nil
1388 if the symbol is a local variable. */
1389 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1390 safe_run_hooks (Qpost_command_hook
);
1392 /* If displaying a message, resize the echo area window to fit
1393 that message's size exactly. */
1394 if (!NILP (echo_area_buffer
[0]))
1395 resize_echo_area_exactly ();
1397 if (!NILP (Vdeferred_action_list
))
1398 call0 (Vdeferred_action_function
);
1400 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1402 if (NILP (Vunread_command_events
)
1403 && NILP (Vunread_input_method_events
)
1404 && NILP (Vunread_post_input_method_events
)
1405 && NILP (Vexecuting_macro
)
1406 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1407 safe_run_hooks (Qpost_command_idle_hook
);
1411 Vmemory_full
= Qnil
;
1413 /* Do this after running Vpost_command_hook, for consistency. */
1414 current_kboard
->Vlast_command
= Vthis_command
;
1415 current_kboard
->Vreal_last_command
= real_this_command
;
1419 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1422 /* Make sure the current window's buffer is selected. */
1423 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1424 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1426 /* Display any malloc warning that just came out. Use while because
1427 displaying one warning can cause another. */
1429 while (pending_malloc_warning
)
1430 display_malloc_warning ();
1434 Vdeactivate_mark
= Qnil
;
1436 /* If minibuffer on and echo area in use,
1437 wait a short time and redraw minibuffer. */
1440 && !NILP (echo_area_buffer
[0])
1441 && EQ (minibuf_window
, echo_area_window
)
1442 && NUMBERP (Vminibuffer_message_timeout
))
1444 /* Bind inhibit-quit to t so that C-g gets read in
1445 rather than quitting back to the minibuffer. */
1446 int count
= SPECPDL_INDEX ();
1447 specbind (Qinhibit_quit
, Qt
);
1449 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1450 /* Clear the echo area. */
1452 safe_run_hooks (Qecho_area_clear_hook
);
1454 unbind_to (count
, Qnil
);
1456 /* If a C-g came in before, treat it as input now. */
1457 if (!NILP (Vquit_flag
))
1460 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1465 alloca (0); /* Cause a garbage collection now */
1466 /* Since we can free the most stuff here. */
1467 #endif /* C_ALLOCA */
1470 /* Select the frame that the last event came from. Usually,
1471 switch-frame events will take care of this, but if some lisp
1472 code swallows a switch-frame event, we'll fix things up here.
1473 Is this a good idea? */
1474 if (FRAMEP (internal_last_event_frame
)
1475 && !EQ (internal_last_event_frame
, selected_frame
))
1476 Fselect_frame (internal_last_event_frame
, Qnil
);
1478 /* If it has changed current-menubar from previous value,
1479 really recompute the menubar from the value. */
1480 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1481 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1482 call0 (Qrecompute_lucid_menubar
);
1484 before_command_key_count
= this_command_key_count
;
1485 before_command_echo_length
= echo_length ();
1487 Vthis_command
= Qnil
;
1488 real_this_command
= Qnil
;
1490 /* Read next key sequence; i gets its length. */
1491 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1494 /* A filter may have run while we were reading the input. */
1495 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1497 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1498 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1502 /* Now we have read a key sequence of length I,
1503 or else I is 0 and we found end of file. */
1505 if (i
== 0) /* End of file -- happens only in */
1506 return Qnil
; /* a kbd macro, at the end. */
1507 /* -1 means read_key_sequence got a menu that was rejected.
1508 Just loop around and read another command. */
1512 this_command_key_count
= 0;
1513 this_command_key_count_reset
= 0;
1514 this_single_command_key_start
= 0;
1518 last_command_char
= keybuf
[i
- 1];
1520 /* If the previous command tried to force a specific window-start,
1521 forget about that, in case this command moves point far away
1522 from that position. But also throw away beg_unchanged and
1523 end_unchanged information in that case, so that redisplay will
1524 update the whole window properly. */
1525 if (!NILP (XWINDOW (selected_window
)->force_start
))
1528 XWINDOW (selected_window
)->force_start
= Qnil
;
1529 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1530 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1533 cmd
= read_key_sequence_cmd
;
1534 if (!NILP (Vexecuting_macro
))
1536 if (!NILP (Vquit_flag
))
1538 Vexecuting_macro
= Qt
;
1539 QUIT
; /* Make some noise. */
1540 /* Will return since macro now empty. */
1544 /* Do redisplay processing after this command except in special
1545 cases identified below. */
1546 prev_buffer
= current_buffer
;
1547 prev_modiff
= MODIFF
;
1548 last_point_position
= PT
;
1549 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1551 /* By default, we adjust point to a boundary of a region that
1552 has such a property that should be treated intangible
1553 (e.g. composition, display). But, some commands will set
1554 this variable differently. */
1555 Vdisable_point_adjustment
= Qnil
;
1557 /* Process filters and timers may have messed with deactivate-mark.
1558 reset it before we execute the command. */
1559 Vdeactivate_mark
= Qnil
;
1561 /* Remap command through active keymaps */
1562 Vthis_original_command
= cmd
;
1566 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1570 /* Execute the command. */
1572 Vthis_command
= cmd
;
1573 real_this_command
= cmd
;
1574 /* Note that the value cell will never directly contain nil
1575 if the symbol is a local variable. */
1576 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1577 safe_run_hooks (Qpre_command_hook
);
1579 already_adjusted
= 0;
1581 if (NILP (Vthis_command
))
1583 /* nil means key is undefined. */
1585 current_kboard
->defining_kbd_macro
= Qnil
;
1586 update_mode_lines
= 1;
1587 current_kboard
->Vprefix_arg
= Qnil
;
1591 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1593 /* In case we jump to directly_done. */
1594 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1596 /* Recognize some common commands in common situations and
1597 do them directly. */
1598 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1600 struct Lisp_Char_Table
*dp
1601 = window_display_table (XWINDOW (selected_window
));
1602 lose
= FETCH_CHAR (PT_BYTE
);
1604 if (! NILP (Vpost_command_hook
))
1605 /* Put this before calling adjust_point_for_property
1606 so it will only get called once in any case. */
1608 if (current_buffer
== prev_buffer
1609 && last_point_position
!= PT
1610 && NILP (Vdisable_point_adjustment
)
1611 && NILP (Vglobal_disable_point_adjustment
))
1612 adjust_point_for_property (last_point_position
, 0);
1613 already_adjusted
= 1;
1614 if (PT
== last_point_position
+ 1
1616 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1617 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1618 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1619 && (lose
>= 0x20 && lose
< 0x7f)))
1620 : (lose
>= 0x20 && lose
< 0x7f))
1621 /* To extract the case of continuation on
1622 wide-column characters. */
1623 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1624 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1626 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1628 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1630 && !windows_or_buffers_changed
1631 && EQ (current_buffer
->selective_display
, Qnil
)
1632 && !detect_input_pending ()
1633 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1634 && NILP (Vexecuting_macro
))
1635 direct_output_forward_char (1);
1638 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1640 struct Lisp_Char_Table
*dp
1641 = window_display_table (XWINDOW (selected_window
));
1643 lose
= FETCH_CHAR (PT_BYTE
);
1644 if (! NILP (Vpost_command_hook
))
1646 if (current_buffer
== prev_buffer
1647 && last_point_position
!= PT
1648 && NILP (Vdisable_point_adjustment
)
1649 && NILP (Vglobal_disable_point_adjustment
))
1650 adjust_point_for_property (last_point_position
, 0);
1651 already_adjusted
= 1;
1652 if (PT
== last_point_position
- 1
1654 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1655 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1656 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1657 && (lose
>= 0x20 && lose
< 0x7f)))
1658 : (lose
>= 0x20 && lose
< 0x7f))
1659 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1661 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1663 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1665 && !windows_or_buffers_changed
1666 && EQ (current_buffer
->selective_display
, Qnil
)
1667 && !detect_input_pending ()
1668 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1669 && NILP (Vexecuting_macro
))
1670 direct_output_forward_char (-1);
1673 else if (EQ (Vthis_command
, Qself_insert_command
)
1674 /* Try this optimization only on char keystrokes. */
1675 && NATNUMP (last_command_char
)
1676 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1679 = translate_char (Vtranslation_table_for_input
,
1680 XFASTINT (last_command_char
), 0, 0, 0);
1682 if (NILP (Vexecuting_macro
)
1683 && !EQ (minibuf_window
, selected_window
))
1685 if (!nonundocount
|| nonundocount
>= 20)
1693 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1695 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1697 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1699 || MODIFF
<= SAVE_MODIFF
1700 || windows_or_buffers_changed
1701 || !EQ (current_buffer
->selective_display
, Qnil
)
1702 || detect_input_pending ()
1703 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1704 || !NILP (Vexecuting_macro
));
1706 value
= internal_self_insert (c
, 0);
1711 if (! NILP (Vpost_command_hook
))
1712 /* Put this before calling adjust_point_for_property
1713 so it will only get called once in any case. */
1716 /* VALUE == 1 when AFTER-CHANGE functions are
1717 installed which is the case most of the time
1718 because FONT-LOCK installs one. */
1719 if (!lose
&& !value
)
1720 direct_output_for_insert (c
);
1725 /* Here for a command that isn't executed directly */
1727 #ifdef HAVE_X_WINDOWS
1728 if (display_hourglass_p
1729 && NILP (Vexecuting_macro
))
1734 if (NILP (current_kboard
->Vprefix_arg
))
1736 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1738 #ifdef HAVE_X_WINDOWS
1739 /* Do not check display_hourglass_p here, because
1740 Fcommand_execute could change it, but we should cancel
1741 hourglass cursor anyway.
1742 But don't cancel the hourglass within a macro
1743 just because a command in the macro finishes. */
1744 if (NILP (Vexecuting_macro
))
1745 cancel_hourglass ();
1749 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1751 /* Note that the value cell will never directly contain nil
1752 if the symbol is a local variable. */
1753 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1754 safe_run_hooks (Qpost_command_hook
);
1756 /* If displaying a message, resize the echo area window to fit
1757 that message's size exactly. */
1758 if (!NILP (echo_area_buffer
[0]))
1759 resize_echo_area_exactly ();
1761 if (!NILP (Vdeferred_action_list
))
1762 safe_run_hooks (Qdeferred_action_function
);
1764 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1766 if (NILP (Vunread_command_events
)
1767 && NILP (Vunread_input_method_events
)
1768 && NILP (Vunread_post_input_method_events
)
1769 && NILP (Vexecuting_macro
)
1770 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1771 safe_run_hooks (Qpost_command_idle_hook
);
1774 /* If there is a prefix argument,
1775 1) We don't want Vlast_command to be ``universal-argument''
1776 (that would be dumb), so don't set Vlast_command,
1777 2) we want to leave echoing on so that the prefix will be
1778 echoed as part of this key sequence, so don't call
1780 3) we want to leave this_command_key_count non-zero, so that
1781 read_char will realize that it is re-reading a character, and
1782 not echo it a second time.
1784 If the command didn't actually create a prefix arg,
1785 but is merely a frame event that is transparent to prefix args,
1786 then the above doesn't apply. */
1787 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1789 current_kboard
->Vlast_command
= Vthis_command
;
1790 current_kboard
->Vreal_last_command
= real_this_command
;
1792 this_command_key_count
= 0;
1793 this_command_key_count_reset
= 0;
1794 this_single_command_key_start
= 0;
1797 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1799 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1801 /* We could also call `deactivate'mark'. */
1802 if (EQ (Vtransient_mark_mode
, Qlambda
))
1803 Vtransient_mark_mode
= Qnil
;
1806 current_buffer
->mark_active
= Qnil
;
1807 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1810 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1811 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1816 if (current_buffer
== prev_buffer
1817 && last_point_position
!= PT
1818 && NILP (Vdisable_point_adjustment
)
1819 && NILP (Vglobal_disable_point_adjustment
)
1820 && !already_adjusted
)
1821 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1823 /* Install chars successfully executed in kbd macro. */
1825 if (!NILP (current_kboard
->defining_kbd_macro
)
1826 && NILP (current_kboard
->Vprefix_arg
))
1827 finalize_kbd_macro_chars ();
1831 any_kboard_state ();
1836 extern Lisp_Object Qcomposition
, Qdisplay
;
1838 /* Adjust point to a boundary of a region that has such a property
1839 that should be treated intangible. For the moment, we check
1840 `composition', `display' and `invisible' properties.
1841 LAST_PT is the last position of point. */
1843 extern Lisp_Object Qafter_string
, Qbefore_string
;
1844 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1847 adjust_point_for_property (last_pt
, modified
)
1852 Lisp_Object val
, overlay
, tmp
;
1853 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1855 while (check_composition
|| check_display
|| check_invisible
)
1857 if (check_composition
1858 && PT
> BEGV
&& PT
< ZV
1859 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1860 && COMPOSITION_VALID_P (beg
, end
, val
)
1861 && beg
< PT
/* && end > PT <- It's always the case. */
1862 && (last_pt
<= beg
|| last_pt
>= end
))
1865 SET_PT (PT
< last_pt
? beg
: end
);
1866 check_display
= check_invisible
= 1;
1868 check_composition
= 0;
1870 && PT
> BEGV
&& PT
< ZV
1871 && !NILP (val
= get_char_property_and_overlay
1872 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1873 && display_prop_intangible_p (val
)
1874 && (!OVERLAYP (overlay
)
1875 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1876 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1877 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1878 && beg
< PT
) /* && end > PT <- It's always the case. */
1881 SET_PT (PT
< last_pt
? beg
: end
);
1882 check_composition
= check_invisible
= 1;
1885 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1887 int inv
, ellipsis
= 0;
1890 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1892 && !NILP (val
= get_char_property_and_overlay
1893 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1894 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1896 ellipsis
= ellipsis
|| inv
> 1
1897 || (OVERLAYP (overlay
)
1898 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1899 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1900 tmp
= Fnext_single_char_property_change
1901 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1902 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1905 && !NILP (val
= get_char_property_and_overlay
1906 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1907 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1909 ellipsis
= ellipsis
|| inv
> 1
1910 || (OVERLAYP (overlay
)
1911 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1912 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1913 tmp
= Fprevious_single_char_property_change
1914 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1915 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1918 /* Move away from the inside area. */
1919 if (beg
< PT
&& end
> PT
)
1921 SET_PT (PT
< last_pt
? beg
: end
);
1922 check_composition
= check_display
= 1;
1924 xassert (PT
== beg
|| PT
== end
);
1925 /* Pretend the area doesn't exist if the buffer is not
1927 if (!modified
&& !ellipsis
&& beg
< end
)
1929 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1930 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1931 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1932 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1933 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1934 /* We've already moved as far as we can. Trying to go
1935 to the other end would mean moving backwards and thus
1936 could lead to an infinite loop. */
1938 else if (val
= get_pos_property (make_number (PT
),
1940 TEXT_PROP_MEANS_INVISIBLE (val
)
1941 && (val
= get_pos_property
1942 (make_number (PT
== beg
? end
: beg
),
1944 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1945 (check_composition
= check_display
= 1,
1946 SET_PT (PT
== beg
? end
: beg
));
1949 check_invisible
= 0;
1953 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1956 safe_run_hooks_1 (hook
)
1959 return call1 (Vrun_hooks
, Vinhibit_quit
);
1962 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1965 safe_run_hooks_error (data
)
1968 return Fset (Vinhibit_quit
, Qnil
);
1971 /* If we get an error while running the hook, cause the hook variable
1972 to be nil. Also inhibit quits, so that C-g won't cause the hook
1973 to mysteriously evaporate. */
1976 safe_run_hooks (hook
)
1979 int count
= SPECPDL_INDEX ();
1980 specbind (Qinhibit_quit
, hook
);
1982 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1984 unbind_to (count
, Qnil
);
1988 /* Number of seconds between polling for input. This is a Lisp
1989 variable that can be bound. */
1991 EMACS_INT polling_period
;
1993 /* Nonzero means polling for input is temporarily suppressed. */
1995 int poll_suppress_count
;
1997 /* Asynchronous timer for polling. */
1999 struct atimer
*poll_timer
;
2002 #ifdef POLL_FOR_INPUT
2004 /* Poll for input, so what we catch a C-g if it comes in. This
2005 function is called from x_make_frame_visible, see comment
2011 if (interrupt_input_blocked
== 0
2012 && !waiting_for_input
)
2013 read_avail_input (0);
2016 /* Timer callback function for poll_timer. TIMER is equal to
2020 poll_for_input (timer
)
2021 struct atimer
*timer
;
2023 if (poll_suppress_count
== 0)
2024 poll_for_input_1 ();
2027 #endif /* POLL_FOR_INPUT */
2029 /* Begin signals to poll for input, if they are appropriate.
2030 This function is called unconditionally from various places. */
2035 #ifdef POLL_FOR_INPUT
2036 if (read_socket_hook
&& !interrupt_input
)
2038 /* Turn alarm handling on unconditionally. It might have
2039 been turned off in process.c. */
2040 turn_on_atimers (1);
2042 /* If poll timer doesn't exist, are we need one with
2043 a different interval, start a new one. */
2044 if (poll_timer
== NULL
2045 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2047 EMACS_TIME interval
;
2050 cancel_atimer (poll_timer
);
2052 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2053 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2054 poll_for_input
, NULL
);
2057 /* Let the timer's callback function poll for input
2058 if this becomes zero. */
2059 --poll_suppress_count
;
2064 /* Nonzero if we are using polling to handle input asynchronously. */
2067 input_polling_used ()
2069 #ifdef POLL_FOR_INPUT
2070 return read_socket_hook
&& !interrupt_input
;
2076 /* Turn off polling. */
2081 #ifdef POLL_FOR_INPUT
2082 if (read_socket_hook
&& !interrupt_input
)
2083 ++poll_suppress_count
;
2087 /* Set the value of poll_suppress_count to COUNT
2088 and start or stop polling accordingly. */
2091 set_poll_suppress_count (count
)
2094 #ifdef POLL_FOR_INPUT
2095 if (count
== 0 && poll_suppress_count
!= 0)
2097 poll_suppress_count
= 1;
2100 else if (count
!= 0 && poll_suppress_count
== 0)
2104 poll_suppress_count
= count
;
2108 /* Bind polling_period to a value at least N.
2109 But don't decrease it. */
2112 bind_polling_period (n
)
2115 #ifdef POLL_FOR_INPUT
2116 int new = polling_period
;
2121 stop_other_atimers (poll_timer
);
2123 specbind (Qpolling_period
, make_number (new));
2124 /* Start a new alarm with the new period. */
2129 /* Apply the control modifier to CHARACTER. */
2135 /* Save the upper bits here. */
2136 int upper
= c
& ~0177;
2140 /* Everything in the columns containing the upper-case letters
2141 denotes a control character. */
2142 if (c
>= 0100 && c
< 0140)
2146 /* Set the shift modifier for a control char
2147 made from a shifted letter. But only for letters! */
2148 if (oc
>= 'A' && oc
<= 'Z')
2149 c
|= shift_modifier
;
2152 /* The lower-case letters denote control characters too. */
2153 else if (c
>= 'a' && c
<= 'z')
2156 /* Include the bits for control and shift
2157 only if the basic ASCII code can't indicate them. */
2161 /* Replace the high bits. */
2162 c
|= (upper
& ~ctrl_modifier
);
2167 /* Display help echo in the echo area.
2169 HELP a string means display that string, HELP nil means clear the
2170 help echo. If HELP is a function, call it with OBJECT and POS as
2171 arguments; the function should return a help string or nil for
2172 none. For all other types of HELP evaluate it to obtain a string.
2174 WINDOW is the window in which the help was generated, if any.
2175 It is nil if not in a window.
2177 If OBJECT is a buffer, POS is the position in the buffer where the
2178 `help-echo' text property was found.
2180 If OBJECT is an overlay, that overlay has a `help-echo' property,
2181 and POS is the position in the overlay's buffer under the mouse.
2183 If OBJECT is a string (an overlay string or a string displayed with
2184 the `display' property). POS is the position in that string under
2187 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2188 echo overwrites a keystroke echo currently displayed in the echo
2191 Note: this function may only be called with HELP nil or a string
2192 from X code running asynchronously. */
2195 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2196 Lisp_Object help
, window
, object
, pos
;
2197 int ok_to_overwrite_keystroke_echo
;
2199 if (!NILP (help
) && !STRINGP (help
))
2201 if (FUNCTIONP (help
))
2203 Lisp_Object args
[4];
2208 help
= safe_call (4, args
);
2211 help
= safe_eval (help
);
2213 if (!STRINGP (help
))
2217 if (STRINGP (help
) || NILP (help
))
2219 if (!NILP (Vshow_help_function
))
2220 call1 (Vshow_help_function
, help
);
2221 else if (/* Don't overwrite minibuffer contents. */
2222 !MINI_WINDOW_P (XWINDOW (selected_window
))
2223 /* Don't overwrite a keystroke echo. */
2224 && (NILP (echo_message_buffer
)
2225 || ok_to_overwrite_keystroke_echo
)
2226 /* Don't overwrite a prompt. */
2227 && !cursor_in_echo_area
)
2231 int count
= SPECPDL_INDEX ();
2233 if (!help_echo_showing_p
)
2234 Vpre_help_message
= current_message ();
2236 specbind (Qmessage_truncate_lines
, Qt
);
2237 message3_nolog (help
, SBYTES (help
),
2238 STRING_MULTIBYTE (help
));
2239 unbind_to (count
, Qnil
);
2241 else if (STRINGP (Vpre_help_message
))
2243 message3_nolog (Vpre_help_message
,
2244 SBYTES (Vpre_help_message
),
2245 STRING_MULTIBYTE (Vpre_help_message
));
2246 Vpre_help_message
= Qnil
;
2252 help_echo_showing_p
= STRINGP (help
);
2258 /* Input of single characters from keyboard */
2260 Lisp_Object
print_help ();
2261 static Lisp_Object
kbd_buffer_get_event ();
2262 static void record_char ();
2265 static jmp_buf wrong_kboard_jmpbuf
;
2268 #define STOP_POLLING \
2269 do { if (! polling_stopped_here) stop_polling (); \
2270 polling_stopped_here = 1; } while (0)
2272 #define RESUME_POLLING \
2273 do { if (polling_stopped_here) start_polling (); \
2274 polling_stopped_here = 0; } while (0)
2276 /* read a character from the keyboard; call the redisplay if needed */
2277 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2278 -1 means do not do redisplay, but do do autosaving.
2281 /* The arguments MAPS and NMAPS are for menu prompting.
2282 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2284 PREV_EVENT is the previous input event, or nil if we are reading
2285 the first event of a key sequence (or not reading a key sequence).
2286 If PREV_EVENT is t, that is a "magic" value that says
2287 not to run input methods, but in other respects to act as if
2288 not reading a key sequence.
2290 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2291 if we used a mouse menu to read the input, or zero otherwise. If
2292 USED_MOUSE_MENU is null, we don't dereference it.
2294 Value is t if we showed a menu and the user rejected it. */
2297 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2301 Lisp_Object prev_event
;
2302 int *used_mouse_menu
;
2304 volatile Lisp_Object c
;
2306 jmp_buf local_getcjmp
;
2308 volatile int key_already_recorded
= 0;
2309 Lisp_Object tem
, save
;
2310 volatile Lisp_Object previous_echo_area_message
;
2311 volatile Lisp_Object also_record
;
2312 volatile int reread
;
2313 struct gcpro gcpro1
, gcpro2
;
2314 EMACS_TIME last_idle_start
;
2315 int polling_stopped_here
= 0;
2319 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2320 before_command_key_count
= this_command_key_count
;
2321 before_command_echo_length
= echo_length ();
2324 previous_echo_area_message
= Qnil
;
2326 GCPRO2 (c
, previous_echo_area_message
);
2331 if (CONSP (Vunread_post_input_method_events
))
2333 c
= XCAR (Vunread_post_input_method_events
);
2334 Vunread_post_input_method_events
2335 = XCDR (Vunread_post_input_method_events
);
2337 /* Undo what read_char_x_menu_prompt did when it unread
2338 additional keys returned by Fx_popup_menu. */
2340 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2348 if (unread_command_char
!= -1)
2350 XSETINT (c
, unread_command_char
);
2351 unread_command_char
= -1;
2357 if (CONSP (Vunread_command_events
))
2359 c
= XCAR (Vunread_command_events
);
2360 Vunread_command_events
= XCDR (Vunread_command_events
);
2362 /* Undo what read_char_x_menu_prompt did when it unread
2363 additional keys returned by Fx_popup_menu. */
2365 && EQ (XCDR (c
), Qdisabled
)
2366 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2369 /* If the queued event is something that used the mouse,
2370 set used_mouse_menu accordingly. */
2372 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2373 *used_mouse_menu
= 1;
2376 goto reread_for_input_method
;
2379 if (CONSP (Vunread_input_method_events
))
2381 c
= XCAR (Vunread_input_method_events
);
2382 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2384 /* Undo what read_char_x_menu_prompt did when it unread
2385 additional keys returned by Fx_popup_menu. */
2387 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2391 goto reread_for_input_method
;
2394 this_command_key_count_reset
= 0;
2396 if (!NILP (Vexecuting_macro
))
2398 /* We set this to Qmacro; since that's not a frame, nobody will
2399 try to switch frames on us, and the selected window will
2402 Since this event came from a macro, it would be misleading to
2403 leave internal_last_event_frame set to wherever the last
2404 real event came from. Normally, a switch-frame event selects
2405 internal_last_event_frame after each command is read, but
2406 events read from a macro should never cause a new frame to be
2408 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2410 /* Exit the macro if we are at the end.
2411 Also, some things replace the macro with t
2412 to force an early exit. */
2413 if (EQ (Vexecuting_macro
, Qt
)
2414 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2420 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2421 if (STRINGP (Vexecuting_macro
)
2422 && (XINT (c
) & 0x80))
2423 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2425 executing_macro_index
++;
2430 if (!NILP (unread_switch_frame
))
2432 c
= unread_switch_frame
;
2433 unread_switch_frame
= Qnil
;
2435 /* This event should make it into this_command_keys, and get echoed
2436 again, so we do not set `reread'. */
2440 /* if redisplay was requested */
2441 if (commandflag
>= 0)
2443 /* If there is pending input, process any events which are not
2444 user-visible, such as X selection_request events. */
2446 || detect_input_pending_run_timers (0))
2447 swallow_events (0); /* may clear input_pending */
2449 /* Redisplay if no pending input. */
2450 while (!input_pending
)
2452 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2453 redisplay_preserve_echo_area (5);
2458 /* Normal case: no input arrived during redisplay. */
2461 /* Input arrived and pre-empted redisplay.
2462 Process any events which are not user-visible. */
2464 /* If that cleared input_pending, try again to redisplay. */
2468 /* Message turns off echoing unless more keystrokes turn it on again.
2470 The code in 20.x for the condition was
2472 1. echo_area_glyphs && *echo_area_glyphs
2473 2. && echo_area_glyphs != current_kboard->echobuf
2474 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2476 (1) means there's a current message displayed
2478 (2) means it's not the message from echoing from the current
2481 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2482 is set to a non-null value. This is done in read_char and it is
2483 set to echo_area_glyphs after a call to echo_char. That means
2484 ok_to_echo_at_next_pause is either null or
2485 current_kboard->echobuf with the appropriate current_kboard at
2488 So, condition (3) means in clear text ok_to_echo_at_next_pause
2489 must be either null, or the current message isn't from echoing at
2490 all, or it's from echoing from a different kboard than the
2493 if (/* There currently is something in the echo area. */
2494 !NILP (echo_area_buffer
[0])
2495 && (/* And it's either not from echoing. */
2496 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2497 /* Or it's an echo from a different kboard. */
2498 || echo_kboard
!= current_kboard
2499 /* Or we explicitly allow overwriting whatever there is. */
2500 || ok_to_echo_at_next_pause
== NULL
))
2505 /* Try reading a character via menu prompting in the minibuf.
2506 Try this before the sit-for, because the sit-for
2507 would do the wrong thing if we are supposed to do
2508 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2509 after a mouse event so don't try a minibuf menu. */
2511 if (nmaps
> 0 && INTERACTIVE
2512 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2513 /* Don't bring up a menu if we already have another event. */
2514 && NILP (Vunread_command_events
)
2515 && unread_command_char
< 0
2516 && !detect_input_pending_run_timers (0))
2518 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2521 key_already_recorded
= 1;
2526 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2527 We will do that below, temporarily for short sections of code,
2528 when appropriate. local_getcjmp must be in effect
2529 around any call to sit_for or kbd_buffer_get_event;
2530 it *must not* be in effect when we call redisplay. */
2532 if (_setjmp (local_getcjmp
))
2534 XSETINT (c
, quit_char
);
2535 internal_last_event_frame
= selected_frame
;
2536 Vlast_event_frame
= internal_last_event_frame
;
2537 /* If we report the quit char as an event,
2538 don't do so more than once. */
2539 if (!NILP (Vinhibit_quit
))
2544 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2545 if (kb
!= current_kboard
)
2547 Lisp_Object link
= kb
->kbd_queue
;
2548 /* We shouldn't get here if we were in single-kboard mode! */
2553 while (CONSP (XCDR (link
)))
2555 if (!NILP (XCDR (link
)))
2559 kb
->kbd_queue
= Fcons (c
, Qnil
);
2561 XSETCDR (link
, Fcons (c
, Qnil
));
2562 kb
->kbd_queue_has_data
= 1;
2563 current_kboard
= kb
;
2564 /* This is going to exit from read_char
2565 so we had better get rid of this frame's stuff. */
2567 longjmp (wrong_kboard_jmpbuf
, 1);
2574 timer_start_idle ();
2576 /* If in middle of key sequence and minibuffer not active,
2577 start echoing if enough time elapses. */
2579 if (minibuf_level
== 0
2580 && !current_kboard
->immediate_echo
2581 && this_command_key_count
> 0
2583 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2584 && NILP (Fzerop (Vecho_keystrokes
))
2585 && (/* No message. */
2586 NILP (echo_area_buffer
[0])
2587 /* Or empty message. */
2588 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2589 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2590 /* Or already echoing from same kboard. */
2591 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2592 /* Or not echoing before and echoing allowed. */
2593 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2597 /* After a mouse event, start echoing right away.
2598 This is because we are probably about to display a menu,
2599 and we don't want to delay before doing so. */
2600 if (EVENT_HAS_PARAMETERS (prev_event
))
2605 double duration
= extract_float (Vecho_keystrokes
);
2606 sec
= (int) duration
;
2607 usec
= (duration
- sec
) * 1000000;
2608 save_getcjmp (save_jump
);
2609 restore_getcjmp (local_getcjmp
);
2610 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2611 restore_getcjmp (save_jump
);
2613 && ! CONSP (Vunread_command_events
))
2618 /* Maybe auto save due to number of keystrokes. */
2620 if (commandflag
!= 0
2621 && auto_save_interval
> 0
2622 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2623 && !detect_input_pending_run_timers (0))
2625 Fdo_auto_save (Qnil
, Qnil
);
2626 /* Hooks can actually change some buffers in auto save. */
2630 /* Try reading using an X menu.
2631 This is never confused with reading using the minibuf
2632 because the recursive call of read_char in read_char_minibuf_menu_prompt
2633 does not pass on any keymaps. */
2635 if (nmaps
> 0 && INTERACTIVE
2636 && !NILP (prev_event
)
2637 && EVENT_HAS_PARAMETERS (prev_event
)
2638 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2639 && !EQ (XCAR (prev_event
), Qtool_bar
)
2640 /* Don't bring up a menu if we already have another event. */
2641 && NILP (Vunread_command_events
)
2642 && unread_command_char
< 0)
2644 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2646 /* Now that we have read an event, Emacs is not idle. */
2652 /* Maybe autosave and/or garbage collect due to idleness. */
2654 if (INTERACTIVE
&& NILP (c
))
2656 int delay_level
, buffer_size
;
2658 /* Slow down auto saves logarithmically in size of current buffer,
2659 and garbage collect while we're at it. */
2660 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2661 last_non_minibuf_size
= Z
- BEG
;
2662 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2664 while (buffer_size
> 64)
2665 delay_level
++, buffer_size
-= buffer_size
>> 2;
2666 if (delay_level
< 4) delay_level
= 4;
2667 /* delay_level is 4 for files under around 50k, 7 at 100k,
2668 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2670 /* Auto save if enough time goes by without input. */
2671 if (commandflag
!= 0
2672 && num_nonmacro_input_events
> last_auto_save
2673 && INTEGERP (Vauto_save_timeout
)
2674 && XINT (Vauto_save_timeout
) > 0)
2678 save_getcjmp (save_jump
);
2679 restore_getcjmp (local_getcjmp
);
2680 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2682 restore_getcjmp (save_jump
);
2685 && ! CONSP (Vunread_command_events
))
2687 Fdo_auto_save (Qnil
, Qnil
);
2689 /* If we have auto-saved and there is still no input
2690 available, garbage collect if there has been enough
2691 consing going on to make it worthwhile. */
2692 if (!detect_input_pending_run_timers (0)
2693 && consing_since_gc
> gc_cons_threshold
/ 2)
2694 Fgarbage_collect ();
2701 /* If this has become non-nil here, it has been set by a timer
2702 or sentinel or filter. */
2703 if (CONSP (Vunread_command_events
))
2705 c
= XCAR (Vunread_command_events
);
2706 Vunread_command_events
= XCDR (Vunread_command_events
);
2709 /* Read something from current KBOARD's side queue, if possible. */
2713 if (current_kboard
->kbd_queue_has_data
)
2715 if (!CONSP (current_kboard
->kbd_queue
))
2717 c
= XCAR (current_kboard
->kbd_queue
);
2718 current_kboard
->kbd_queue
2719 = XCDR (current_kboard
->kbd_queue
);
2720 if (NILP (current_kboard
->kbd_queue
))
2721 current_kboard
->kbd_queue_has_data
= 0;
2722 input_pending
= readable_events (0);
2723 if (EVENT_HAS_PARAMETERS (c
)
2724 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2725 internal_last_event_frame
= XCAR (XCDR (c
));
2726 Vlast_event_frame
= internal_last_event_frame
;
2731 /* If current_kboard's side queue is empty check the other kboards.
2732 If one of them has data that we have not yet seen here,
2733 switch to it and process the data waiting for it.
2735 Note: if the events queued up for another kboard
2736 have already been seen here, and therefore are not a complete command,
2737 the kbd_queue_has_data field is 0, so we skip that kboard here.
2738 That's to avoid an infinite loop switching between kboards here. */
2739 if (NILP (c
) && !single_kboard
)
2742 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2743 if (kb
->kbd_queue_has_data
)
2745 current_kboard
= kb
;
2746 /* This is going to exit from read_char
2747 so we had better get rid of this frame's stuff. */
2749 longjmp (wrong_kboard_jmpbuf
, 1);
2758 /* Finally, we read from the main queue,
2759 and if that gives us something we can't use yet, we put it on the
2760 appropriate side queue and try again. */
2766 /* Actually read a character, waiting if necessary. */
2767 save_getcjmp (save_jump
);
2768 restore_getcjmp (local_getcjmp
);
2769 timer_start_idle ();
2770 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2771 restore_getcjmp (save_jump
);
2774 if (! NILP (c
) && (kb
!= current_kboard
))
2776 Lisp_Object link
= kb
->kbd_queue
;
2779 while (CONSP (XCDR (link
)))
2781 if (!NILP (XCDR (link
)))
2785 kb
->kbd_queue
= Fcons (c
, Qnil
);
2787 XSETCDR (link
, Fcons (c
, Qnil
));
2788 kb
->kbd_queue_has_data
= 1;
2792 current_kboard
= kb
;
2793 /* This is going to exit from read_char
2794 so we had better get rid of this frame's stuff. */
2796 longjmp (wrong_kboard_jmpbuf
, 1);
2801 /* Terminate Emacs in batch mode if at eof. */
2802 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2803 Fkill_emacs (make_number (1));
2807 /* Add in any extra modifiers, where appropriate. */
2808 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2809 || ((extra_keyboard_modifiers
& 0177) < ' '
2810 && (extra_keyboard_modifiers
& 0177) != 0))
2811 XSETINT (c
, make_ctrl_char (XINT (c
)));
2813 /* Transfer any other modifier bits directly from
2814 extra_keyboard_modifiers to c. Ignore the actual character code
2815 in the low 16 bits of extra_keyboard_modifiers. */
2816 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2821 /* Record the last idle start time so that we can reset it
2822 should the next event read be a help-echo. */
2823 last_idle_start
= timer_idleness_start_time
;
2829 if (commandflag
>= 0
2830 && !input_pending
&& !detect_input_pending_run_timers (0))
2838 /* Buffer switch events are only for internal wakeups
2839 so don't show them to the user.
2840 Also, don't record a key if we already did. */
2841 if (BUFFERP (c
) || key_already_recorded
)
2844 /* Process special events within read_char
2845 and loop around to read another event. */
2848 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2853 int was_locked
= single_kboard
;
2855 last_input_char
= c
;
2856 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2858 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2859 /* We stopped being idle for this event; undo that. This
2860 prevents automatic window selection (under
2861 mouse_autoselect_window from acting as a real input event, for
2862 example banishing the mouse under mouse-avoidance-mode. */
2863 timer_idleness_start_time
= last_idle_start
;
2865 /* Resume allowing input from any kboard, if that was true before. */
2867 any_kboard_state ();
2872 /* Handle things that only apply to characters. */
2875 /* If kbd_buffer_get_event gave us an EOF, return that. */
2879 if ((STRINGP (Vkeyboard_translate_table
)
2880 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2881 || (VECTORP (Vkeyboard_translate_table
)
2882 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2883 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2884 && CHAR_VALID_P (XINT (c
), 0)))
2887 d
= Faref (Vkeyboard_translate_table
, c
);
2888 /* nil in keyboard-translate-table means no translation. */
2894 /* If this event is a mouse click in the menu bar,
2895 return just menu-bar for now. Modify the mouse click event
2896 so we won't do this twice, then queue it up. */
2897 if (EVENT_HAS_PARAMETERS (c
)
2899 && CONSP (EVENT_START (c
))
2900 && CONSP (XCDR (EVENT_START (c
))))
2904 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2905 /* Handle menu-bar events:
2906 insert the dummy prefix event `menu-bar'. */
2907 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2909 /* Change menu-bar to (menu-bar) as the event "position". */
2910 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2913 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2918 /* Store these characters into recent_keys, the dribble file if any,
2919 and the keyboard macro being defined, if any. */
2921 if (! NILP (also_record
))
2922 record_char (also_record
);
2924 /* Wipe the echo area.
2925 But first, if we are about to use an input method,
2926 save the echo area contents for it to refer to. */
2928 && ! NILP (Vinput_method_function
)
2929 && (unsigned) XINT (c
) >= ' '
2930 && (unsigned) XINT (c
) != 127
2931 && (unsigned) XINT (c
) < 256)
2933 previous_echo_area_message
= Fcurrent_message ();
2934 Vinput_method_previous_message
= previous_echo_area_message
;
2937 /* Now wipe the echo area, except for help events which do their
2938 own stuff with the echo area. */
2940 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2941 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2943 if (!NILP (echo_area_buffer
[0]))
2944 safe_run_hooks (Qecho_area_clear_hook
);
2945 clear_message (1, 0);
2948 reread_for_input_method
:
2950 /* Pass this to the input method, if appropriate. */
2952 && ! NILP (Vinput_method_function
)
2953 /* Don't run the input method within a key sequence,
2954 after the first event of the key sequence. */
2955 && NILP (prev_event
)
2956 && (unsigned) XINT (c
) >= ' '
2957 && (unsigned) XINT (c
) != 127
2958 && (unsigned) XINT (c
) < 256)
2961 int key_count
, key_count_reset
;
2962 struct gcpro gcpro1
;
2963 int count
= SPECPDL_INDEX ();
2965 /* Save the echo status. */
2966 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2967 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2968 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2971 if (before_command_restore_flag
)
2973 this_command_key_count
= before_command_key_count_1
;
2974 if (this_command_key_count
< this_single_command_key_start
)
2975 this_single_command_key_start
= this_command_key_count
;
2976 echo_truncate (before_command_echo_length_1
);
2977 before_command_restore_flag
= 0;
2981 /* Save the this_command_keys status. */
2982 key_count
= this_command_key_count
;
2983 key_count_reset
= this_command_key_count_reset
;
2986 keys
= Fcopy_sequence (this_command_keys
);
2991 /* Clear out this_command_keys. */
2992 this_command_key_count
= 0;
2993 this_command_key_count_reset
= 0;
2995 /* Now wipe the echo area. */
2996 if (!NILP (echo_area_buffer
[0]))
2997 safe_run_hooks (Qecho_area_clear_hook
);
2998 clear_message (1, 0);
3001 /* If we are not reading a key sequence,
3002 never use the echo area. */
3005 specbind (Qinput_method_use_echo_area
, Qt
);
3008 /* Call the input method. */
3009 tem
= call1 (Vinput_method_function
, c
);
3011 tem
= unbind_to (count
, tem
);
3013 /* Restore the saved echoing state
3014 and this_command_keys state. */
3015 this_command_key_count
= key_count
;
3016 this_command_key_count_reset
= key_count_reset
;
3018 this_command_keys
= keys
;
3021 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3022 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3023 if (saved_immediate_echo
)
3028 /* The input method can return no events. */
3031 /* Bring back the previous message, if any. */
3032 if (! NILP (previous_echo_area_message
))
3033 message_with_string ("%s", previous_echo_area_message
, 0);
3036 /* It returned one event or more. */
3038 Vunread_post_input_method_events
3039 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3044 /* Display help if not echoing. */
3045 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3047 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3048 Lisp_Object help
, object
, position
, window
, tem
;
3050 tem
= Fcdr (XCDR (c
));
3053 window
= Fcar (tem
);
3055 object
= Fcar (tem
);
3057 position
= Fcar (tem
);
3059 show_help_echo (help
, window
, object
, position
, 0);
3061 /* We stopped being idle for this event; undo that. */
3062 timer_idleness_start_time
= last_idle_start
;
3066 if (! reread
|| this_command_key_count
== 0
3067 || this_command_key_count_reset
)
3070 /* Don't echo mouse motion events. */
3071 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3072 && NILP (Fzerop (Vecho_keystrokes
))
3073 && ! (EVENT_HAS_PARAMETERS (c
)
3074 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3077 if (! NILP (also_record
))
3078 echo_char (also_record
);
3079 /* Once we reread a character, echoing can happen
3080 the next time we pause to read a new one. */
3081 ok_to_echo_at_next_pause
= current_kboard
;
3084 /* Record this character as part of the current key. */
3085 add_command_key (c
);
3086 if (! NILP (also_record
))
3087 add_command_key (also_record
);
3090 last_input_char
= c
;
3093 /* Process the help character specially if enabled */
3094 if (!NILP (Vhelp_form
) && help_char_p (c
))
3097 count
= SPECPDL_INDEX ();
3099 record_unwind_protect (Fset_window_configuration
,
3100 Fcurrent_window_configuration (Qnil
));
3102 tem0
= Feval (Vhelp_form
);
3104 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3108 c
= read_char (0, 0, 0, Qnil
, 0);
3109 while (BUFFERP (c
));
3110 /* Remove the help from the frame */
3111 unbind_to (count
, Qnil
);
3114 if (EQ (c
, make_number (040)))
3118 c
= read_char (0, 0, 0, Qnil
, 0);
3119 while (BUFFERP (c
));
3128 /* Record a key that came from a mouse menu.
3129 Record it for echoing, for this-command-keys, and so on. */
3135 /* Wipe the echo area. */
3136 clear_message (1, 0);
3141 before_command_key_count
= this_command_key_count
;
3142 before_command_echo_length
= echo_length ();
3145 /* Don't echo mouse motion events. */
3146 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3147 && NILP (Fzerop (Vecho_keystrokes
)))
3151 /* Once we reread a character, echoing can happen
3152 the next time we pause to read a new one. */
3153 ok_to_echo_at_next_pause
= 0;
3156 /* Record this character as part of the current key. */
3157 add_command_key (c
);
3159 /* Re-reading in the middle of a command */
3160 last_input_char
= c
;
3164 /* Return 1 if should recognize C as "the help character". */
3172 if (EQ (c
, Vhelp_char
))
3174 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3175 if (EQ (c
, XCAR (tail
)))
3180 /* Record the input event C in various ways. */
3188 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3190 /* To avoid filling recent_keys with help-echo and mouse-movement
3191 events, we filter out repeated help-echo events, only store the
3192 first and last in a series of mouse-movement events, and don't
3193 store repeated help-echo events which are only separated by
3194 mouse-movement events. */
3196 Lisp_Object ev1
, ev2
, ev3
;
3199 if ((ix1
= recent_keys_index
- 1) < 0)
3200 ix1
= NUM_RECENT_KEYS
- 1;
3201 ev1
= AREF (recent_keys
, ix1
);
3203 if ((ix2
= ix1
- 1) < 0)
3204 ix2
= NUM_RECENT_KEYS
- 1;
3205 ev2
= AREF (recent_keys
, ix2
);
3207 if ((ix3
= ix2
- 1) < 0)
3208 ix3
= NUM_RECENT_KEYS
- 1;
3209 ev3
= AREF (recent_keys
, ix3
);
3211 if (EQ (XCAR (c
), Qhelp_echo
))
3213 /* Don't record `help-echo' in recent_keys unless it shows some help
3214 message, and a different help than the previously recorded
3216 Lisp_Object help
, last_help
;
3218 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3219 if (!STRINGP (help
))
3221 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3222 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3224 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3225 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3226 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3228 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3229 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3230 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3231 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3234 else if (EQ (XCAR (c
), Qmouse_movement
))
3236 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3237 So additional mouse movement events replace the last element. */
3238 Lisp_Object last_window
, window
;
3240 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3241 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3242 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3243 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3244 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3246 ASET (recent_keys
, ix1
, c
);
3252 store_kbd_macro_char (c
);
3257 ASET (recent_keys
, recent_keys_index
, c
);
3258 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3259 recent_keys_index
= 0;
3261 else if (recorded
< 0)
3263 /* We need to remove one or two events from recent_keys.
3264 To do this, we simply put nil at those events and move the
3265 recent_keys_index backwards over those events. Usually,
3266 users will never see those nil events, as they will be
3267 overwritten by the command keys entered to see recent_keys
3270 while (recorded
++ < 0 && total_keys
> 0)
3272 if (total_keys
< NUM_RECENT_KEYS
)
3274 if (--recent_keys_index
< 0)
3275 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3276 ASET (recent_keys
, recent_keys_index
, Qnil
);
3280 num_nonmacro_input_events
++;
3282 /* Write c to the dribble file. If c is a lispy event, write
3283 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3284 If you, dear reader, have a better idea, you've got the source. :-) */
3289 if (XUINT (c
) < 0x100)
3290 putc (XINT (c
), dribble
);
3292 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3296 Lisp_Object dribblee
;
3298 /* If it's a structured event, take the event header. */
3299 dribblee
= EVENT_HEAD (c
);
3301 if (SYMBOLP (dribblee
))
3303 putc ('<', dribble
);
3304 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3305 SBYTES (SYMBOL_NAME (dribblee
)),
3307 putc ('>', dribble
);
3319 struct buffer
*old
= current_buffer
;
3320 Fprinc (object
, Qnil
);
3321 set_buffer_internal (XBUFFER (Vstandard_output
));
3322 call0 (intern ("help-mode"));
3323 set_buffer_internal (old
);
3327 /* Copy out or in the info on where C-g should throw to.
3328 This is used when running Lisp code from within get_char,
3329 in case get_char is called recursively.
3330 See read_process_output. */
3336 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3340 restore_getcjmp (temp
)
3343 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3348 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3349 of this function. */
3352 tracking_off (old_value
)
3353 Lisp_Object old_value
;
3355 do_mouse_tracking
= old_value
;
3356 if (NILP (old_value
))
3358 /* Redisplay may have been preempted because there was input
3359 available, and it assumes it will be called again after the
3360 input has been processed. If the only input available was
3361 the sort that we have just disabled, then we need to call
3363 if (!readable_events (1))
3365 redisplay_preserve_echo_area (6);
3366 get_input_pending (&input_pending
, 1);
3372 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3373 doc
: /* Evaluate BODY with mouse movement events enabled.
3374 Within a `track-mouse' form, mouse motion generates input events that
3375 you can read with `read-event'.
3376 Normally, mouse motion is ignored.
3377 usage: (track-mouse BODY ...) */)
3381 int count
= SPECPDL_INDEX ();
3384 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3386 do_mouse_tracking
= Qt
;
3388 val
= Fprogn (args
);
3389 return unbind_to (count
, val
);
3392 /* If mouse has moved on some frame, return one of those frames.
3393 Return 0 otherwise. */
3398 Lisp_Object tail
, frame
;
3400 FOR_EACH_FRAME (tail
, frame
)
3402 if (XFRAME (frame
)->mouse_moved
)
3403 return XFRAME (frame
);
3409 #endif /* HAVE_MOUSE */
3411 /* Low level keyboard/mouse input.
3412 kbd_buffer_store_event places events in kbd_buffer, and
3413 kbd_buffer_get_event retrieves them. */
3415 /* Return true iff there are any events in the queue that read-char
3416 would return. If this returns false, a read-char would block. */
3418 readable_filtered_events (do_timers_now
, filter_events
)
3423 timer_check (do_timers_now
);
3425 /* If the buffer contains only FOCUS_IN_EVENT events,
3426 and FILTER_EVENTS is nonzero, report it as empty. */
3427 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3429 int have_live_event
= 1;
3433 struct input_event
*event
;
3435 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3439 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3442 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3444 if (event
== kbd_store_ptr
)
3445 have_live_event
= 0;
3448 if (have_live_event
) return 1;
3452 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3457 if (current_kboard
->kbd_queue_has_data
)
3463 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3464 if (kb
->kbd_queue_has_data
)
3470 /* Return true iff there are any events in the queue that read-char
3471 would return. If this returns false, a read-char would block. */
3473 readable_events (do_timers_now
)
3476 return readable_filtered_events (do_timers_now
, 0);
3479 /* Set this for debugging, to have a way to get out */
3484 event_to_kboard (event
)
3485 struct input_event
*event
;
3488 frame
= event
->frame_or_window
;
3490 frame
= XCAR (frame
);
3491 else if (WINDOWP (frame
))
3492 frame
= WINDOW_FRAME (XWINDOW (frame
));
3494 /* There are still some events that don't set this field.
3495 For now, just ignore the problem.
3496 Also ignore dead frames here. */
3497 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3500 return FRAME_KBOARD (XFRAME (frame
));
3504 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3507 kbd_buffer_store_event (event
)
3508 register struct input_event
*event
;
3510 if (event
->kind
== NO_EVENT
)
3513 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3515 register int c
= event
->code
& 0377;
3517 if (event
->modifiers
& ctrl_modifier
)
3518 c
= make_ctrl_char (c
);
3520 c
|= (event
->modifiers
3521 & (meta_modifier
| alt_modifier
3522 | hyper_modifier
| super_modifier
));
3528 struct input_event
*sp
;
3531 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3532 kb
!= current_kboard
))
3535 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3536 Fcons (make_number (c
), Qnil
));
3537 kb
->kbd_queue_has_data
= 1;
3538 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3540 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3543 if (event_to_kboard (sp
) == kb
)
3545 sp
->kind
= NO_EVENT
;
3546 sp
->frame_or_window
= Qnil
;
3554 /* If this results in a quit_char being returned to Emacs as
3555 input, set Vlast_event_frame properly. If this doesn't
3556 get returned to Emacs as an event, the next event read
3557 will set Vlast_event_frame again, so this is safe to do. */
3561 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3563 focus
= event
->frame_or_window
;
3564 internal_last_event_frame
= focus
;
3565 Vlast_event_frame
= focus
;
3568 last_event_timestamp
= event
->timestamp
;
3569 interrupt_signal (0 /* dummy */);
3573 if (c
&& c
== stop_character
)
3579 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3580 Just ignore the second one. */
3581 else if (event
->kind
== BUFFER_SWITCH_EVENT
3582 && kbd_fetch_ptr
!= kbd_store_ptr
3583 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3586 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3587 kbd_store_ptr
= kbd_buffer
;
3589 /* Don't let the very last slot in the buffer become full,
3590 since that would make the two pointers equal,
3591 and that is indistinguishable from an empty buffer.
3592 Discard the event if it would fill the last slot. */
3593 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3597 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3598 prone to assign individual members for other events, in case
3599 the input_event structure is changed. --2000-07-13, gerd. */
3600 struct input_event
*sp
= kbd_store_ptr
;
3601 sp
->kind
= event
->kind
;
3602 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3604 /* We must not use the ordinary copying code for this case,
3605 since `part' is an enum and copying it might not copy enough
3607 bcopy (event
, (char *) sp
, sizeof (*event
));
3612 sp
->code
= event
->code
;
3613 sp
->part
= event
->part
;
3614 sp
->frame_or_window
= event
->frame_or_window
;
3615 sp
->arg
= event
->arg
;
3616 sp
->modifiers
= event
->modifiers
;
3619 sp
->timestamp
= event
->timestamp
;
3622 *kbd_store_ptr
= *event
;
3625 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3626 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3627 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3633 /* Generate HELP_EVENT input_events in BUFP which has room for
3634 SIZE events. If there's not enough room in BUFP, ignore this
3637 HELP is the help form.
3639 FRAME is the frame on which the help is generated. OBJECT is the
3640 Lisp object where the help was found (a buffer, a string, an
3641 overlay, or nil if neither from a string nor from a buffer. POS is
3642 the position within OBJECT where the help was found.
3644 Value is the number of input_events generated. */
3647 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3648 struct input_event
*bufp
;
3650 Lisp_Object help
, frame
, object
, window
;
3655 bufp
->kind
= HELP_EVENT
;
3656 bufp
->frame_or_window
= frame
;
3658 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3667 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3670 kbd_buffer_store_help_event (frame
, help
)
3671 Lisp_Object frame
, help
;
3673 struct input_event event
;
3675 event
.kind
= HELP_EVENT
;
3676 event
.frame_or_window
= frame
;
3681 kbd_buffer_store_event (&event
);
3685 /* Discard any mouse events in the event buffer by setting them to
3688 discard_mouse_events ()
3690 struct input_event
*sp
;
3691 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3693 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3696 if (sp
->kind
== MOUSE_CLICK_EVENT
3698 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3700 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3702 sp
->kind
= NO_EVENT
;
3708 /* Return non-zero if there are any real events waiting in the event
3709 buffer, not counting `NO_EVENT's.
3711 If DISCARD is non-zero, discard NO_EVENT events at the front of
3712 the input queue, possibly leaving the input queue empty if there
3713 are no real input events. */
3716 kbd_buffer_events_waiting (discard
)
3719 struct input_event
*sp
;
3721 for (sp
= kbd_fetch_ptr
;
3722 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3725 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3732 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3736 /* Clear input event EVENT. */
3740 struct input_event
*event
;
3742 int idx
= 2 * (event
- kbd_buffer
);
3743 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3744 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3745 event
->kind
= NO_EVENT
;
3749 /* Read one event from the event buffer, waiting if necessary.
3750 The value is a Lisp object representing the event.
3751 The value is nil for an event that should be ignored,
3752 or that was handled here.
3753 We always read and discard one event. */
3756 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3758 int *used_mouse_menu
;
3767 *kbp
= current_kboard
;
3771 /* Wait until there is input available. */
3774 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3777 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3781 /* If the quit flag is set, then read_char will return
3782 quit_char, so that counts as "available input." */
3783 if (!NILP (Vquit_flag
))
3784 quit_throw_to_read_char ();
3786 /* One way or another, wait until input is available; then, if
3787 interrupt handlers have not read it, read it now. */
3790 wait_for_kbd_input ();
3792 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3796 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3799 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3803 Lisp_Object minus_one
;
3805 XSETINT (minus_one
, -1);
3806 wait_reading_process_input (0, 0, minus_one
, 1);
3808 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3809 /* Pass 1 for EXPECT since we just waited to have input. */
3810 read_avail_input (1);
3812 #endif /* not VMS */
3815 if (CONSP (Vunread_command_events
))
3818 first
= XCAR (Vunread_command_events
);
3819 Vunread_command_events
= XCDR (Vunread_command_events
);
3820 *kbp
= current_kboard
;
3824 /* At this point, we know that there is a readable event available
3825 somewhere. If the event queue is empty, then there must be a
3826 mouse movement enabled and available. */
3827 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3829 struct input_event
*event
;
3831 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3835 last_event_timestamp
= event
->timestamp
;
3838 *kbp
= event_to_kboard (event
);
3840 *kbp
= current_kboard
; /* Better than returning null ptr? */
3842 *kbp
= &the_only_kboard
;
3847 /* These two kinds of events get special handling
3848 and don't actually appear to the command loop.
3849 We return nil for them. */
3850 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3853 struct input_event copy
;
3855 /* Remove it from the buffer before processing it,
3856 since otherwise swallow_events will see it
3857 and process it again. */
3859 kbd_fetch_ptr
= event
+ 1;
3860 input_pending
= readable_events (0);
3861 x_handle_selection_request (©
);
3863 /* We're getting selection request events, but we don't have
3869 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3872 struct input_event copy
;
3874 /* Remove it from the buffer before processing it. */
3876 kbd_fetch_ptr
= event
+ 1;
3877 input_pending
= readable_events (0);
3878 x_handle_selection_clear (©
);
3880 /* We're getting selection request events, but we don't have
3885 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3886 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3888 /* Make an event (delete-frame (FRAME)). */
3889 obj
= Fcons (event
->frame_or_window
, Qnil
);
3890 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3891 kbd_fetch_ptr
= event
+ 1;
3894 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3895 else if (event
->kind
== ICONIFY_EVENT
)
3897 /* Make an event (iconify-frame (FRAME)). */
3898 obj
= Fcons (event
->frame_or_window
, Qnil
);
3899 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3900 kbd_fetch_ptr
= event
+ 1;
3902 else if (event
->kind
== DEICONIFY_EVENT
)
3904 /* Make an event (make-frame-visible (FRAME)). */
3905 obj
= Fcons (event
->frame_or_window
, Qnil
);
3906 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3907 kbd_fetch_ptr
= event
+ 1;
3910 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3912 /* The value doesn't matter here; only the type is tested. */
3913 XSETBUFFER (obj
, current_buffer
);
3914 kbd_fetch_ptr
= event
+ 1;
3916 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3917 || defined (USE_GTK)
3918 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3920 kbd_fetch_ptr
= event
+ 1;
3921 input_pending
= readable_events (0);
3922 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3923 x_activate_menubar (XFRAME (event
->frame_or_window
));
3927 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3929 /* Make an event (language-change (FRAME CHARSET LCID)). */
3930 obj
= Fcons (event
->modifiers
, Qnil
);
3931 obj
= Fcons (event
->code
, obj
);
3932 obj
= Fcons (event
->frame_or_window
, obj
);
3933 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3934 kbd_fetch_ptr
= event
+ 1;
3937 else if (event
->kind
== SAVE_SESSION_EVENT
)
3939 obj
= Fcons (Qsave_session
, Qnil
);
3940 kbd_fetch_ptr
= event
+ 1;
3942 /* Just discard these, by returning nil.
3943 With MULTI_KBOARD, these events are used as placeholders
3944 when we need to randomly delete events from the queue.
3945 (They shouldn't otherwise be found in the buffer,
3946 but on some machines it appears they do show up
3947 even without MULTI_KBOARD.) */
3948 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3949 mouse events during a popup-menu call. */
3950 else if (event
->kind
== NO_EVENT
)
3951 kbd_fetch_ptr
= event
+ 1;
3952 else if (event
->kind
== HELP_EVENT
)
3954 Lisp_Object object
, position
, help
, frame
, window
;
3956 frame
= event
->frame_or_window
;
3957 object
= event
->arg
;
3958 position
= make_number (event
->code
);
3961 clear_event (event
);
3963 kbd_fetch_ptr
= event
+ 1;
3964 if (!WINDOWP (window
))
3966 obj
= Fcons (Qhelp_echo
,
3967 list5 (frame
, help
, window
, object
, position
));
3969 else if (event
->kind
== FOCUS_IN_EVENT
)
3971 /* Notification of a FocusIn event. The frame receiving the
3972 focus is in event->frame_or_window. Generate a
3973 switch-frame event if necessary. */
3974 Lisp_Object frame
, focus
;
3976 frame
= event
->frame_or_window
;
3977 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3981 if (!EQ (frame
, internal_last_event_frame
)
3982 && !EQ (frame
, selected_frame
))
3983 obj
= make_lispy_switch_frame (frame
);
3984 internal_last_event_frame
= frame
;
3985 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== SELECT_WINDOW_EVENT
)
3989 /* Make an event (select-window (WINDOW)). */
3990 obj
= Fcons (event
->frame_or_window
, Qnil
);
3991 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
3993 kbd_fetch_ptr
= event
+ 1;
3997 /* If this event is on a different frame, return a switch-frame this
3998 time, and leave the event in the queue for next time. */
4002 frame
= event
->frame_or_window
;
4004 frame
= XCAR (frame
);
4005 else if (WINDOWP (frame
))
4006 frame
= WINDOW_FRAME (XWINDOW (frame
));
4008 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4012 if (! EQ (frame
, internal_last_event_frame
)
4013 && !EQ (frame
, selected_frame
))
4014 obj
= make_lispy_switch_frame (frame
);
4015 internal_last_event_frame
= frame
;
4017 /* If we didn't decide to make a switch-frame event, go ahead
4018 and build a real event from the queue entry. */
4022 obj
= make_lispy_event (event
);
4024 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4025 || defined (USE_GTK)
4026 /* If this was a menu selection, then set the flag to inhibit
4027 writing to last_nonmenu_event. Don't do this if the event
4028 we're returning is (menu-bar), though; that indicates the
4029 beginning of the menu sequence, and we might as well leave
4030 that as the `event with parameters' for this selection. */
4032 && !EQ (event
->frame_or_window
, event
->arg
)
4033 && (event
->kind
== MENU_BAR_EVENT
4034 || event
->kind
== TOOL_BAR_EVENT
))
4035 *used_mouse_menu
= 1;
4038 /* Wipe out this event, to catch bugs. */
4039 clear_event (event
);
4040 kbd_fetch_ptr
= event
+ 1;
4045 /* Try generating a mouse motion event. */
4046 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4048 FRAME_PTR f
= some_mouse_moved ();
4049 Lisp_Object bar_window
;
4050 enum scroll_bar_part part
;
4054 *kbp
= current_kboard
;
4055 /* Note that this uses F to determine which display to look at.
4056 If there is no valid info, it does not store anything
4057 so x remains nil. */
4059 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4063 /* Decide if we should generate a switch-frame event. Don't
4064 generate switch-frame events for motion outside of all Emacs
4070 frame
= FRAME_FOCUS_FRAME (f
);
4072 XSETFRAME (frame
, f
);
4074 if (! EQ (frame
, internal_last_event_frame
)
4075 && !EQ (frame
, selected_frame
))
4076 obj
= make_lispy_switch_frame (frame
);
4077 internal_last_event_frame
= frame
;
4080 /* If we didn't decide to make a switch-frame event, go ahead and
4081 return a mouse-motion event. */
4082 if (!NILP (x
) && NILP (obj
))
4083 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4085 #endif /* HAVE_MOUSE */
4087 /* We were promised by the above while loop that there was
4088 something for us to read! */
4091 input_pending
= readable_events (0);
4093 Vlast_event_frame
= internal_last_event_frame
;
4098 /* Process any events that are not user-visible,
4099 then return, without reading any user-visible events. */
4102 swallow_events (do_display
)
4107 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4109 struct input_event
*event
;
4111 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4115 last_event_timestamp
= event
->timestamp
;
4117 /* These two kinds of events get special handling
4118 and don't actually appear to the command loop. */
4119 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4122 struct input_event copy
;
4124 /* Remove it from the buffer before processing it,
4125 since otherwise swallow_events called recursively could see it
4126 and process it again. */
4128 kbd_fetch_ptr
= event
+ 1;
4129 input_pending
= readable_events (0);
4130 x_handle_selection_request (©
);
4132 /* We're getting selection request events, but we don't have
4138 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4141 struct input_event copy
;
4143 /* Remove it from the buffer before processing it, */
4146 kbd_fetch_ptr
= event
+ 1;
4147 input_pending
= readable_events (0);
4148 x_handle_selection_clear (©
);
4150 /* We're getting selection request events, but we don't have
4159 old_timers_run
= timers_run
;
4160 get_input_pending (&input_pending
, 1);
4162 if (timers_run
!= old_timers_run
&& do_display
)
4163 redisplay_preserve_echo_area (7);
4166 /* Record the start of when Emacs is idle,
4167 for the sake of running idle-time timers. */
4174 /* If we are already in the idle state, do nothing. */
4175 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4178 EMACS_GET_TIME (timer_idleness_start_time
);
4180 timer_last_idleness_start_time
= timer_idleness_start_time
;
4182 /* Mark all idle-time timers as once again candidates for running. */
4183 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4187 timer
= XCAR (timers
);
4189 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4191 XVECTOR (timer
)->contents
[0] = Qnil
;
4195 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4200 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4203 /* This is only for debugging. */
4204 struct input_event last_timer_event
;
4206 /* Check whether a timer has fired. To prevent larger problems we simply
4207 disregard elements that are not proper timers. Do not make a circular
4208 timer list for the time being.
4210 Returns the number of seconds to wait until the next timer fires. If a
4211 timer is triggering now, return zero seconds.
4212 If no timer is active, return -1 seconds.
4214 If a timer is ripe, we run it, with quitting turned off.
4216 DO_IT_NOW is now ignored. It used to mean that we should
4217 run the timer directly instead of queueing a timer-event.
4218 Now we always run timers directly. */
4221 timer_check (do_it_now
)
4224 EMACS_TIME nexttime
;
4225 EMACS_TIME now
, idleness_now
;
4226 Lisp_Object timers
, idle_timers
, chosen_timer
;
4227 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4229 EMACS_SET_SECS (nexttime
, -1);
4230 EMACS_SET_USECS (nexttime
, -1);
4232 /* Always consider the ordinary timers. */
4233 timers
= Vtimer_list
;
4234 /* Consider the idle timers only if Emacs is idle. */
4235 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4236 idle_timers
= Vtimer_idle_list
;
4239 chosen_timer
= Qnil
;
4240 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4242 if (CONSP (timers
) || CONSP (idle_timers
))
4244 EMACS_GET_TIME (now
);
4245 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4246 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4249 while (CONSP (timers
) || CONSP (idle_timers
))
4251 Lisp_Object
*vector
;
4252 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4253 EMACS_TIME timer_time
, idle_timer_time
;
4254 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4256 /* Skip past invalid timers and timers already handled. */
4259 timer
= XCAR (timers
);
4260 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4262 timers
= XCDR (timers
);
4265 vector
= XVECTOR (timer
)->contents
;
4267 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4268 || !INTEGERP (vector
[3])
4269 || ! NILP (vector
[0]))
4271 timers
= XCDR (timers
);
4275 if (!NILP (idle_timers
))
4277 timer
= XCAR (idle_timers
);
4278 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4280 idle_timers
= XCDR (idle_timers
);
4283 vector
= XVECTOR (timer
)->contents
;
4285 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4286 || !INTEGERP (vector
[3])
4287 || ! NILP (vector
[0]))
4289 idle_timers
= XCDR (idle_timers
);
4294 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4295 based on the next ordinary timer.
4296 TIMER_DIFFERENCE is the distance in time from NOW to when
4297 this timer becomes ripe (negative if it's already ripe). */
4300 timer
= XCAR (timers
);
4301 vector
= XVECTOR (timer
)->contents
;
4302 EMACS_SET_SECS (timer_time
,
4303 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4304 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4305 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4308 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4309 based on the next idle timer. */
4310 if (!NILP (idle_timers
))
4312 idle_timer
= XCAR (idle_timers
);
4313 vector
= XVECTOR (idle_timer
)->contents
;
4314 EMACS_SET_SECS (idle_timer_time
,
4315 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4316 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4317 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4320 /* Decide which timer is the next timer,
4321 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4322 Also step down the list where we found that timer. */
4324 if (! NILP (timers
) && ! NILP (idle_timers
))
4327 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4328 if (EMACS_TIME_NEG_P (temp
))
4330 chosen_timer
= timer
;
4331 timers
= XCDR (timers
);
4332 difference
= timer_difference
;
4336 chosen_timer
= idle_timer
;
4337 idle_timers
= XCDR (idle_timers
);
4338 difference
= idle_timer_difference
;
4341 else if (! NILP (timers
))
4343 chosen_timer
= timer
;
4344 timers
= XCDR (timers
);
4345 difference
= timer_difference
;
4349 chosen_timer
= idle_timer
;
4350 idle_timers
= XCDR (idle_timers
);
4351 difference
= idle_timer_difference
;
4353 vector
= XVECTOR (chosen_timer
)->contents
;
4355 /* If timer is ripe, run it if it hasn't been run. */
4356 if (EMACS_TIME_NEG_P (difference
)
4357 || (EMACS_SECS (difference
) == 0
4358 && EMACS_USECS (difference
) == 0))
4360 if (NILP (vector
[0]))
4362 int was_locked
= single_kboard
;
4363 int count
= SPECPDL_INDEX ();
4364 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4366 /* Mark the timer as triggered to prevent problems if the lisp
4367 code fails to reschedule it right. */
4370 specbind (Qinhibit_quit
, Qt
);
4372 call1 (Qtimer_event_handler
, chosen_timer
);
4373 Vdeactivate_mark
= old_deactivate_mark
;
4375 unbind_to (count
, Qnil
);
4377 /* Resume allowing input from any kboard, if that was true before. */
4379 any_kboard_state ();
4381 /* Since we have handled the event,
4382 we don't need to tell the caller to wake up and do it. */
4386 /* When we encounter a timer that is still waiting,
4387 return the amount of time to wait before it is ripe. */
4394 /* No timers are pending in the future. */
4395 /* Return 0 if we generated an event, and -1 if not. */
4400 /* Caches for modify_event_symbol. */
4401 static Lisp_Object accent_key_syms
;
4402 static Lisp_Object func_key_syms
;
4403 static Lisp_Object mouse_syms
;
4404 #if defined(WINDOWSNT) || defined(MAC_OSX)
4405 static Lisp_Object mouse_wheel_syms
;
4407 static Lisp_Object drag_n_drop_syms
;
4409 /* This is a list of keysym codes for special "accent" characters.
4410 It parallels lispy_accent_keys. */
4412 static int lispy_accent_codes
[] =
4414 #ifdef XK_dead_circumflex
4419 #ifdef XK_dead_grave
4424 #ifdef XK_dead_tilde
4429 #ifdef XK_dead_diaeresis
4434 #ifdef XK_dead_macron
4439 #ifdef XK_dead_degree
4444 #ifdef XK_dead_acute
4449 #ifdef XK_dead_cedilla
4454 #ifdef XK_dead_breve
4459 #ifdef XK_dead_ogonek
4464 #ifdef XK_dead_caron
4469 #ifdef XK_dead_doubleacute
4470 XK_dead_doubleacute
,
4474 #ifdef XK_dead_abovedot
4479 #ifdef XK_dead_abovering
4489 #ifdef XK_dead_belowdot
4494 #ifdef XK_dead_voiced_sound
4495 XK_dead_voiced_sound
,
4499 #ifdef XK_dead_semivoiced_sound
4500 XK_dead_semivoiced_sound
,
4516 /* This is a list of Lisp names for special "accent" characters.
4517 It parallels lispy_accent_codes. */
4519 static char *lispy_accent_keys
[] =
4537 "dead-voiced-sound",
4538 "dead-semivoiced-sound",
4544 #define FUNCTION_KEY_OFFSET 0x0
4546 char *lispy_function_keys
[] =
4550 0, /* VK_LBUTTON 0x01 */
4551 0, /* VK_RBUTTON 0x02 */
4552 "cancel", /* VK_CANCEL 0x03 */
4553 0, /* VK_MBUTTON 0x04 */
4555 0, 0, 0, /* 0x05 .. 0x07 */
4557 "backspace", /* VK_BACK 0x08 */
4558 "tab", /* VK_TAB 0x09 */
4560 0, 0, /* 0x0A .. 0x0B */
4562 "clear", /* VK_CLEAR 0x0C */
4563 "return", /* VK_RETURN 0x0D */
4565 0, 0, /* 0x0E .. 0x0F */
4567 0, /* VK_SHIFT 0x10 */
4568 0, /* VK_CONTROL 0x11 */
4569 0, /* VK_MENU 0x12 */
4570 "pause", /* VK_PAUSE 0x13 */
4571 "capslock", /* VK_CAPITAL 0x14 */
4573 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4575 "escape", /* VK_ESCAPE 0x1B */
4577 0, 0, 0, 0, /* 0x1C .. 0x1F */
4579 0, /* VK_SPACE 0x20 */
4580 "prior", /* VK_PRIOR 0x21 */
4581 "next", /* VK_NEXT 0x22 */
4582 "end", /* VK_END 0x23 */
4583 "home", /* VK_HOME 0x24 */
4584 "left", /* VK_LEFT 0x25 */
4585 "up", /* VK_UP 0x26 */
4586 "right", /* VK_RIGHT 0x27 */
4587 "down", /* VK_DOWN 0x28 */
4588 "select", /* VK_SELECT 0x29 */
4589 "print", /* VK_PRINT 0x2A */
4590 "execute", /* VK_EXECUTE 0x2B */
4591 "snapshot", /* VK_SNAPSHOT 0x2C */
4592 "insert", /* VK_INSERT 0x2D */
4593 "delete", /* VK_DELETE 0x2E */
4594 "help", /* VK_HELP 0x2F */
4596 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4598 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4600 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4602 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4604 0, 0, 0, 0, 0, 0, 0, 0, 0,
4605 0, 0, 0, 0, 0, 0, 0, 0, 0,
4606 0, 0, 0, 0, 0, 0, 0, 0,
4608 "lwindow", /* VK_LWIN 0x5B */
4609 "rwindow", /* VK_RWIN 0x5C */
4610 "apps", /* VK_APPS 0x5D */
4612 0, 0, /* 0x5E .. 0x5F */
4614 "kp-0", /* VK_NUMPAD0 0x60 */
4615 "kp-1", /* VK_NUMPAD1 0x61 */
4616 "kp-2", /* VK_NUMPAD2 0x62 */
4617 "kp-3", /* VK_NUMPAD3 0x63 */
4618 "kp-4", /* VK_NUMPAD4 0x64 */
4619 "kp-5", /* VK_NUMPAD5 0x65 */
4620 "kp-6", /* VK_NUMPAD6 0x66 */
4621 "kp-7", /* VK_NUMPAD7 0x67 */
4622 "kp-8", /* VK_NUMPAD8 0x68 */
4623 "kp-9", /* VK_NUMPAD9 0x69 */
4624 "kp-multiply", /* VK_MULTIPLY 0x6A */
4625 "kp-add", /* VK_ADD 0x6B */
4626 "kp-separator", /* VK_SEPARATOR 0x6C */
4627 "kp-subtract", /* VK_SUBTRACT 0x6D */
4628 "kp-decimal", /* VK_DECIMAL 0x6E */
4629 "kp-divide", /* VK_DIVIDE 0x6F */
4630 "f1", /* VK_F1 0x70 */
4631 "f2", /* VK_F2 0x71 */
4632 "f3", /* VK_F3 0x72 */
4633 "f4", /* VK_F4 0x73 */
4634 "f5", /* VK_F5 0x74 */
4635 "f6", /* VK_F6 0x75 */
4636 "f7", /* VK_F7 0x76 */
4637 "f8", /* VK_F8 0x77 */
4638 "f9", /* VK_F9 0x78 */
4639 "f10", /* VK_F10 0x79 */
4640 "f11", /* VK_F11 0x7A */
4641 "f12", /* VK_F12 0x7B */
4642 "f13", /* VK_F13 0x7C */
4643 "f14", /* VK_F14 0x7D */
4644 "f15", /* VK_F15 0x7E */
4645 "f16", /* VK_F16 0x7F */
4646 "f17", /* VK_F17 0x80 */
4647 "f18", /* VK_F18 0x81 */
4648 "f19", /* VK_F19 0x82 */
4649 "f20", /* VK_F20 0x83 */
4650 "f21", /* VK_F21 0x84 */
4651 "f22", /* VK_F22 0x85 */
4652 "f23", /* VK_F23 0x86 */
4653 "f24", /* VK_F24 0x87 */
4655 0, 0, 0, 0, /* 0x88 .. 0x8B */
4656 0, 0, 0, 0, /* 0x8C .. 0x8F */
4658 "kp-numlock", /* VK_NUMLOCK 0x90 */
4659 "scroll", /* VK_SCROLL 0x91 */
4661 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4662 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4663 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4664 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4665 "kp-end", /* VK_NUMPAD_END 0x96 */
4666 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4667 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4668 "kp-up", /* VK_NUMPAD_UP 0x99 */
4669 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4670 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4671 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4672 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4674 0, 0, /* 0x9E .. 0x9F */
4677 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4678 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4679 * No other API or message will distinguish left and right keys this way.
4683 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4684 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4685 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4686 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4687 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4693 "attn", /* VK_ATTN 0xF6 */
4694 "crsel", /* VK_CRSEL 0xF7 */
4695 "exsel", /* VK_EXSEL 0xF8 */
4696 "ereof", /* VK_EREOF 0xF9 */
4697 "play", /* VK_PLAY 0xFA */
4698 "zoom", /* VK_ZOOM 0xFB */
4699 "noname", /* VK_NONAME 0xFC */
4700 "pa1", /* VK_PA1 0xFD */
4701 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4705 #else /* not HAVE_NTGUI */
4707 /* This should be dealt with in XTread_socket now, and that doesn't
4708 depend on the client system having the Kana syms defined. See also
4709 the XK_kana_A case below. */
4712 static char *lispy_kana_keys
[] =
4714 /* X Keysym value */
4715 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4716 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4717 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4718 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4719 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4720 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4721 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4722 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4723 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4724 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4725 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4726 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4727 "kana-i", "kana-u", "kana-e", "kana-o",
4728 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4729 "prolongedsound", "kana-A", "kana-I", "kana-U",
4730 "kana-E", "kana-O", "kana-KA", "kana-KI",
4731 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4732 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4733 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4734 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4735 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4736 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4737 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4738 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4739 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4740 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4741 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4742 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4744 #endif /* XK_kana_A */
4747 #define FUNCTION_KEY_OFFSET 0xff00
4749 /* You'll notice that this table is arranged to be conveniently
4750 indexed by X Windows keysym values. */
4751 static char *lispy_function_keys
[] =
4753 /* X Keysym value */
4755 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4756 "backspace", "tab", "linefeed", "clear",
4758 0, 0, 0, "pause", /* 0xff10...1f */
4759 0, 0, 0, 0, 0, 0, 0, "escape",
4761 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4762 "romaji", "hiragana", "katakana", "hiragana-katakana",
4763 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4764 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4765 "eisu-toggle", /* 0xff30...3f */
4766 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4767 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4769 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4770 "down", "prior", "next", "end",
4771 "begin", 0, 0, 0, 0, 0, 0, 0,
4772 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4783 "break", /* 0xff6b */
4786 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4787 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4788 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4789 0, 0, 0, 0, 0, 0, 0, 0,
4790 "kp-tab", /* 0xff89 */
4792 "kp-enter", /* 0xff8d */
4794 "kp-f1", /* 0xff91 */
4798 "kp-home", /* 0xff95 */
4803 "kp-prior", /* kp-page-up */
4804 "kp-next", /* kp-page-down */
4810 0, 0, 0, 0, 0, 0, 0, 0, 0,
4811 "kp-multiply", /* 0xffaa */
4816 "kp-divide", /* 0xffaf */
4817 "kp-0", /* 0xffb0 */
4818 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4821 "kp-equal", /* 0xffbd */
4822 "f1", /* 0xffbe */ /* IsFunctionKey */
4824 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4825 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4826 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4827 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4828 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4829 0, 0, 0, 0, 0, 0, 0, 0,
4830 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4831 0, 0, 0, 0, 0, 0, 0, "delete"
4834 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4835 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4837 static char *iso_lispy_function_keys
[] =
4839 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4840 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4841 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4842 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4843 "iso-lefttab", /* 0xfe20 */
4844 "iso-move-line-up", "iso-move-line-down",
4845 "iso-partial-line-up", "iso-partial-line-down",
4846 "iso-partial-space-left", "iso-partial-space-right",
4847 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4848 "iso-release-margin-left", "iso-release-margin-right",
4849 "iso-release-both-margins",
4850 "iso-fast-cursor-left", "iso-fast-cursor-right",
4851 "iso-fast-cursor-up", "iso-fast-cursor-down",
4852 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4853 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4856 #endif /* not HAVE_NTGUI */
4858 Lisp_Object Vlispy_mouse_stem
;
4860 #if defined(WINDOWSNT) || defined(MAC_OSX)
4861 /* mouse-wheel events are generated by the wheel on devices such as
4862 the MS Intellimouse. The wheel sits in between the left and right
4863 mouse buttons, and is typically used to scroll or zoom the window
4864 underneath the pointer. mouse-wheel events specify the object on
4865 which they operate, and a delta corresponding to the amount and
4866 direction that the wheel is rotated. Clicking the mouse-wheel
4867 generates a mouse-2 event. */
4868 static char *lispy_mouse_wheel_names
[] =
4873 #endif /* WINDOWSNT */
4875 /* drag-n-drop events are generated when a set of selected files are
4876 dragged from another application and dropped onto an Emacs window. */
4877 static char *lispy_drag_n_drop_names
[] =
4882 /* Scroll bar parts. */
4883 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4884 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4885 Lisp_Object Qtop
, Qratio
;
4887 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4888 Lisp_Object
*scroll_bar_parts
[] = {
4889 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4890 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4893 /* User signal events. */
4894 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4896 Lisp_Object
*lispy_user_signals
[] =
4898 &Qusr1_signal
, &Qusr2_signal
4902 /* A vector, indexed by button number, giving the down-going location
4903 of currently depressed buttons, both scroll bar and non-scroll bar.
4905 The elements have the form
4906 (BUTTON-NUMBER MODIFIER-MASK . REST)
4907 where REST is the cdr of a position as it would be reported in the event.
4909 The make_lispy_event function stores positions here to tell the
4910 difference between click and drag events, and to store the starting
4911 location to be included in drag events. */
4913 static Lisp_Object button_down_location
;
4915 /* Information about the most recent up-going button event: Which
4916 button, what location, and what time. */
4918 static int last_mouse_button
;
4919 static int last_mouse_x
;
4920 static int last_mouse_y
;
4921 static unsigned long button_down_time
;
4923 /* The maximum time between clicks to make a double-click, or Qnil to
4924 disable double-click detection, or Qt for no time limit. */
4926 Lisp_Object Vdouble_click_time
;
4928 /* Maximum number of pixels the mouse may be moved between clicks
4929 to make a double-click. */
4931 EMACS_INT double_click_fuzz
;
4933 /* The number of clicks in this multiple-click. */
4935 int double_click_count
;
4937 /* Given a struct input_event, build the lisp event which represents
4938 it. If EVENT is 0, build a mouse movement event from the mouse
4939 movement buffer, which should have a movement event in it.
4941 Note that events must be passed to this function in the order they
4942 are received; this function stores the location of button presses
4943 in order to build drag events when the button is released. */
4946 make_lispy_event (event
)
4947 struct input_event
*event
;
4951 switch (SWITCH_ENUM_CAST (event
->kind
))
4953 /* A simple keystroke. */
4954 case ASCII_KEYSTROKE_EVENT
:
4956 Lisp_Object lispy_c
;
4957 int c
= event
->code
& 0377;
4958 /* Turn ASCII characters into control characters
4960 if (event
->modifiers
& ctrl_modifier
)
4961 c
= make_ctrl_char (c
);
4963 /* Add in the other modifier bits. We took care of ctrl_modifier
4964 just above, and the shift key was taken care of by the X code,
4965 and applied to control characters by make_ctrl_char. */
4966 c
|= (event
->modifiers
4967 & (meta_modifier
| alt_modifier
4968 | hyper_modifier
| super_modifier
));
4969 /* Distinguish Shift-SPC from SPC. */
4970 if ((event
->code
& 0377) == 040
4971 && event
->modifiers
& shift_modifier
)
4972 c
|= shift_modifier
;
4973 button_down_time
= 0;
4974 XSETFASTINT (lispy_c
, c
);
4978 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4980 Lisp_Object lispy_c
;
4982 XSETFASTINT (lispy_c
, event
->code
);
4986 /* A function key. The symbol may need to have modifier prefixes
4988 case NON_ASCII_KEYSTROKE_EVENT
:
4989 button_down_time
= 0;
4991 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4992 if (event
->code
== lispy_accent_codes
[i
])
4993 return modify_event_symbol (i
,
4995 Qfunction_key
, Qnil
,
4996 lispy_accent_keys
, &accent_key_syms
,
4997 (sizeof (lispy_accent_keys
)
4998 / sizeof (lispy_accent_keys
[0])));
5002 if (event
->code
>= 0x400 && event
->code
< 0x500)
5003 return modify_event_symbol (event
->code
- 0x400,
5004 event
->modifiers
& ~shift_modifier
,
5005 Qfunction_key
, Qnil
,
5006 lispy_kana_keys
, &func_key_syms
,
5007 (sizeof (lispy_kana_keys
)
5008 / sizeof (lispy_kana_keys
[0])));
5009 #endif /* XK_kana_A */
5012 #ifdef ISO_FUNCTION_KEY_OFFSET
5013 if (event
->code
< FUNCTION_KEY_OFFSET
5014 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5015 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5017 Qfunction_key
, Qnil
,
5018 iso_lispy_function_keys
, &func_key_syms
,
5019 (sizeof (iso_lispy_function_keys
)
5020 / sizeof (iso_lispy_function_keys
[0])));
5023 /* Handle system-specific or unknown keysyms. */
5024 if (event
->code
& (1 << 28)
5025 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5026 || (event
->code
- FUNCTION_KEY_OFFSET
5027 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5028 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5030 /* We need to use an alist rather than a vector as the cache
5031 since we can't make a vector long enuf. */
5032 if (NILP (current_kboard
->system_key_syms
))
5033 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5034 return modify_event_symbol (event
->code
,
5037 current_kboard
->Vsystem_key_alist
,
5038 0, ¤t_kboard
->system_key_syms
,
5042 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5044 Qfunction_key
, Qnil
,
5045 lispy_function_keys
, &func_key_syms
,
5046 (sizeof (lispy_function_keys
)
5047 / sizeof (lispy_function_keys
[0])));
5050 /* A mouse click. Figure out where it is, decide whether it's
5051 a press, click or drag, and build the appropriate structure. */
5052 case MOUSE_CLICK_EVENT
:
5053 #ifndef USE_TOOLKIT_SCROLL_BARS
5054 case SCROLL_BAR_CLICK_EVENT
:
5057 int button
= event
->code
;
5059 Lisp_Object position
;
5060 Lisp_Object
*start_pos_ptr
;
5061 Lisp_Object start_pos
;
5066 /* Build the position as appropriate for this mouse click. */
5067 if (event
->kind
== MOUSE_CLICK_EVENT
)
5070 struct frame
*f
= XFRAME (event
->frame_or_window
);
5072 Lisp_Object string_info
= Qnil
;
5075 /* Ignore mouse events that were made on frame that
5076 have been deleted. */
5077 if (! FRAME_LIVE_P (f
))
5080 /* EVENT->x and EVENT->y are frame-relative pixel
5081 coordinates at this place. Under old redisplay, COLUMN
5082 and ROW are set to frame relative glyph coordinates
5083 which are then used to determine whether this click is
5084 in a menu (non-toolkit version). */
5085 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5086 &column
, &row
, NULL
, 1);
5088 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5089 /* In the non-toolkit version, clicks on the menu bar
5090 are ordinary button events in the event buffer.
5091 Distinguish them, and invoke the menu.
5093 (In the toolkit version, the toolkit handles the menu bar
5094 and Emacs doesn't know about it until after the user
5095 makes a selection.) */
5096 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5097 && (event
->modifiers
& down_modifier
))
5099 Lisp_Object items
, item
;
5104 /* Activate the menu bar on the down event. If the
5105 up event comes in before the menu code can deal with it,
5107 if (! (event
->modifiers
& down_modifier
))
5111 /* Find the menu bar item under `column'. */
5113 items
= FRAME_MENU_BAR_ITEMS (f
);
5114 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5116 Lisp_Object pos
, string
;
5117 string
= AREF (items
, i
+ 1);
5118 pos
= AREF (items
, i
+ 3);
5121 if (column
>= XINT (pos
)
5122 && column
< XINT (pos
) + SCHARS (string
))
5124 item
= AREF (items
, i
);
5129 /* ELisp manual 2.4b says (x y) are window relative but
5130 code says they are frame-relative. */
5132 = Fcons (event
->frame_or_window
,
5134 Fcons (Fcons (event
->x
, event
->y
),
5135 Fcons (make_number (event
->timestamp
),
5138 return Fcons (item
, Fcons (position
, Qnil
));
5140 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5142 /* Set `window' to the window under frame pixel coordinates
5143 event->x/event->y. */
5144 window
= window_from_coordinates (f
, XINT (event
->x
),
5145 XINT (event
->y
), &part
, 0);
5147 if (!WINDOWP (window
))
5149 window
= event
->frame_or_window
;
5154 /* It's a click in window window at frame coordinates
5155 event->x/ event->y. */
5156 struct window
*w
= XWINDOW (window
);
5158 /* Get window relative coordinates. Original code
5159 `rounded' this to glyph boundaries. */
5160 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5161 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5163 /* Set event coordinates to window-relative coordinates
5164 for constructing the Lisp event below. */
5165 XSETINT (event
->x
, wx
);
5166 XSETINT (event
->y
, wy
);
5168 if (part
== 1 || part
== 3)
5170 /* Mode line or header line. Look for a string under
5171 the mouse that may have a `local-map' property. */
5175 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
5176 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
5177 if (STRINGP (string
))
5178 string_info
= Fcons (string
, make_number (charpos
));
5181 posn
= Qvertical_line
;
5182 else if (part
== 6 || part
== 7)
5185 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5187 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
5188 if (STRINGP (object
))
5189 string_info
= Fcons (object
, make_number (charpos
));
5194 struct display_pos p
;
5195 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5196 posn
= make_number (CHARPOS (p
.pos
));
5197 if (STRINGP (object
))
5200 make_number (CHARPOS (p
.string_pos
)));
5207 Fcons (Fcons (event
->x
, event
->y
),
5208 Fcons (make_number (event
->timestamp
),
5211 : Fcons (string_info
, Qnil
))))));
5213 #ifndef USE_TOOLKIT_SCROLL_BARS
5216 /* It's a scrollbar click. */
5217 Lisp_Object portion_whole
;
5220 window
= event
->frame_or_window
;
5221 portion_whole
= Fcons (event
->x
, event
->y
);
5222 part
= *scroll_bar_parts
[(int) event
->part
];
5226 Fcons (Qvertical_scroll_bar
,
5227 Fcons (portion_whole
,
5228 Fcons (make_number (event
->timestamp
),
5229 Fcons (part
, Qnil
)))));
5231 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5233 if (button
>= ASIZE (button_down_location
))
5235 button_down_location
= larger_vector (button_down_location
,
5237 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5240 start_pos_ptr
= &AREF (button_down_location
, button
);
5241 start_pos
= *start_pos_ptr
;
5242 *start_pos_ptr
= Qnil
;
5245 /* On window-system frames, use the value of
5246 double-click-fuzz as is. On other frames, interpret it
5247 as a multiple of 1/8 characters. */
5251 if (WINDOWP (event
->frame_or_window
))
5252 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5253 else if (FRAMEP (event
->frame_or_window
))
5254 f
= XFRAME (event
->frame_or_window
);
5258 if (FRAME_WINDOW_P (f
))
5259 fuzz
= double_click_fuzz
;
5261 fuzz
= double_click_fuzz
/ 8;
5263 is_double
= (button
== last_mouse_button
5264 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5265 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5266 && button_down_time
!= 0
5267 && (EQ (Vdouble_click_time
, Qt
)
5268 || (INTEGERP (Vdouble_click_time
)
5269 && ((int)(event
->timestamp
- button_down_time
)
5270 < XINT (Vdouble_click_time
)))));
5273 last_mouse_button
= button
;
5274 last_mouse_x
= XINT (event
->x
);
5275 last_mouse_y
= XINT (event
->y
);
5277 /* If this is a button press, squirrel away the location, so
5278 we can decide later whether it was a click or a drag. */
5279 if (event
->modifiers
& down_modifier
)
5283 double_click_count
++;
5284 event
->modifiers
|= ((double_click_count
> 2)
5289 double_click_count
= 1;
5290 button_down_time
= event
->timestamp
;
5291 *start_pos_ptr
= Fcopy_alist (position
);
5294 /* Now we're releasing a button - check the co-ordinates to
5295 see if this was a click or a drag. */
5296 else if (event
->modifiers
& up_modifier
)
5298 /* If we did not see a down before this up, ignore the up.
5299 Probably this happened because the down event chose a
5300 menu item. It would be an annoyance to treat the
5301 release of the button that chose the menu item as a
5304 if (!CONSP (start_pos
))
5307 event
->modifiers
&= ~up_modifier
;
5308 #if 0 /* Formerly we treated an up with no down as a click event. */
5309 if (!CONSP (start_pos
))
5310 event
->modifiers
|= click_modifier
;
5315 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5317 /* The third element of every position
5318 should be the (x,y) pair. */
5319 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5321 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5323 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5324 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5327 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5328 && ydiff
< double_click_fuzz
5329 && ydiff
> - double_click_fuzz
)
5330 /* Mouse hasn't moved (much). */
5331 event
->modifiers
|= click_modifier
;
5334 button_down_time
= 0;
5335 event
->modifiers
|= drag_modifier
;
5338 /* Don't check is_double; treat this as multiple
5339 if the down-event was multiple. */
5340 if (double_click_count
> 1)
5341 event
->modifiers
|= ((double_click_count
> 2)
5347 /* Every mouse event should either have the down_modifier or
5348 the up_modifier set. */
5352 /* Get the symbol we should use for the mouse click. */
5355 head
= modify_event_symbol (button
,
5357 Qmouse_click
, Vlispy_mouse_stem
,
5360 XVECTOR (mouse_syms
)->size
);
5361 if (event
->modifiers
& drag_modifier
)
5366 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5369 Fcons (make_number (double_click_count
),
5378 #ifdef USE_TOOLKIT_SCROLL_BARS
5380 /* We don't have down and up events if using toolkit scroll bars,
5381 so make this always a click event. Store in the `part' of
5382 the Lisp event a symbol which maps to the following actions:
5384 `above_handle' page up
5385 `below_handle' page down
5389 `bottom' bottom of buffer
5390 `handle' thumb has been dragged.
5391 `end-scroll' end of interaction with scroll bar
5393 The incoming input_event contains in its `part' member an
5394 index of type `enum scroll_bar_part' which we can use as an
5395 index in scroll_bar_parts to get the appropriate symbol. */
5397 case SCROLL_BAR_CLICK_EVENT
:
5399 Lisp_Object position
, head
, window
, portion_whole
, part
;
5401 window
= event
->frame_or_window
;
5402 portion_whole
= Fcons (event
->x
, event
->y
);
5403 part
= *scroll_bar_parts
[(int) event
->part
];
5407 Fcons (Qvertical_scroll_bar
,
5408 Fcons (portion_whole
,
5409 Fcons (make_number (event
->timestamp
),
5410 Fcons (part
, Qnil
)))));
5412 /* Always treat scroll bar events as clicks. */
5413 event
->modifiers
|= click_modifier
;
5414 event
->modifiers
&= ~up_modifier
;
5416 /* Get the symbol we should use for the mouse click. */
5417 head
= modify_event_symbol (event
->code
,
5422 XVECTOR (mouse_syms
)->size
);
5423 return Fcons (head
, Fcons (position
, Qnil
));
5426 #endif /* USE_TOOLKIT_SCROLL_BARS */
5429 case W32_SCROLL_BAR_CLICK_EVENT
:
5431 int button
= event
->code
;
5433 Lisp_Object position
;
5434 Lisp_Object
*start_pos_ptr
;
5435 Lisp_Object start_pos
;
5439 Lisp_Object portion_whole
;
5442 window
= event
->frame_or_window
;
5443 portion_whole
= Fcons (event
->x
, event
->y
);
5444 part
= *scroll_bar_parts
[(int) event
->part
];
5448 Fcons (Qvertical_scroll_bar
,
5449 Fcons (portion_whole
,
5450 Fcons (make_number (event
->timestamp
),
5451 Fcons (part
, Qnil
)))));
5454 /* Always treat W32 scroll bar events as clicks. */
5455 event
->modifiers
|= click_modifier
;
5458 /* Get the symbol we should use for the mouse click. */
5461 head
= modify_event_symbol (button
,
5466 XVECTOR (mouse_syms
)->size
);
5472 #endif /* WINDOWSNT */
5473 #if defined(WINDOWSNT) || defined(MAC_OSX)
5474 case MOUSE_WHEEL_EVENT
:
5477 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5480 Lisp_Object head
, position
;
5483 /* Ignore mouse events that were made on frame that
5484 have been deleted. */
5485 if (! FRAME_LIVE_P (f
))
5487 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5488 &column
, &row
, NULL
, 1);
5489 window
= window_from_coordinates (f
, XINT (event
->x
),
5490 XINT (event
->y
), &part
, 0);
5492 if (!WINDOWP (window
))
5494 window
= event
->frame_or_window
;
5499 int pixcolumn
, pixrow
;
5500 column
-= XINT (XWINDOW (window
)->left
);
5501 row
-= XINT (XWINDOW (window
)->top
);
5502 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5503 &pixcolumn
, &pixrow
);
5504 XSETINT (event
->x
, pixcolumn
);
5505 XSETINT (event
->y
, pixrow
);
5510 posn
= Qvertical_line
;
5512 posn
= Qheader_line
;
5516 struct display_pos p
;
5517 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5519 posn
= make_number (CHARPOS (p
.pos
));
5524 Lisp_Object head
, position
;
5529 Fcons (Fcons (event
->x
, event
->y
),
5530 Fcons (make_number (event
->timestamp
),
5533 head
= modify_event_symbol (0, event
->modifiers
,
5535 lispy_mouse_wheel_names
,
5536 &mouse_wheel_syms
, 1);
5539 /* Insert 1 here so event-click-count works. */
5540 Fcons (make_number (1),
5541 Fcons (make_number (event
->code
),
5545 #endif /* WINDOWSNT || MAC_OSX */
5547 case DRAG_N_DROP_EVENT
:
5555 /* The frame_or_window field should be a cons of the frame in
5556 which the event occurred and a list of the filenames
5558 if (! CONSP (event
->frame_or_window
))
5561 f
= XFRAME (XCAR (event
->frame_or_window
));
5562 files
= XCDR (event
->frame_or_window
);
5564 /* Ignore mouse events that were made on frames that
5565 have been deleted. */
5566 if (! FRAME_LIVE_P (f
))
5569 window
= window_from_coordinates (f
, XINT (event
->x
),
5570 XINT (event
->y
), &part
, 0);
5572 if (!WINDOWP (window
))
5574 window
= XCAR (event
->frame_or_window
);
5579 /* It's an event in window `window' at frame coordinates
5580 event->x/ event->y. */
5581 struct window
*w
= XWINDOW (window
);
5583 /* Get window relative coordinates. */
5584 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5585 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5587 /* Set event coordinates to window-relative coordinates
5588 for constructing the Lisp event below. */
5589 XSETINT (event
->x
, wx
);
5590 XSETINT (event
->y
, wy
);
5595 posn
= Qvertical_line
;
5597 posn
= Qheader_line
;
5601 struct display_pos p
;
5602 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5603 posn
= make_number (CHARPOS (p
.pos
));
5608 Lisp_Object head
, position
;
5613 Fcons (Fcons (event
->x
, event
->y
),
5614 Fcons (make_number (event
->timestamp
),
5617 head
= modify_event_symbol (0, event
->modifiers
,
5619 lispy_drag_n_drop_names
,
5620 &drag_n_drop_syms
, 1);
5627 #endif /* HAVE_MOUSE */
5629 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5630 || defined (USE_GTK)
5631 case MENU_BAR_EVENT
:
5632 if (EQ (event
->arg
, event
->frame_or_window
))
5633 /* This is the prefix key. We translate this to
5634 `(menu_bar)' because the code in keyboard.c for menu
5635 events, which we use, relies on this. */
5636 return Fcons (Qmenu_bar
, Qnil
);
5640 case TOOL_BAR_EVENT
:
5641 if (EQ (event
->arg
, event
->frame_or_window
))
5642 /* This is the prefix key. We translate this to
5643 `(tool_bar)' because the code in keyboard.c for tool bar
5644 events, which we use, relies on this. */
5645 return Fcons (Qtool_bar
, Qnil
);
5646 else if (SYMBOLP (event
->arg
))
5647 return apply_modifiers (event
->modifiers
, event
->arg
);
5650 case USER_SIGNAL_EVENT
:
5651 /* A user signal. */
5652 return *lispy_user_signals
[event
->code
];
5654 case SAVE_SESSION_EVENT
:
5655 return Qsave_session
;
5657 /* The 'kind' field of the event is something we don't recognize. */
5666 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5668 Lisp_Object bar_window
;
5669 enum scroll_bar_part part
;
5673 /* Is it a scroll bar movement? */
5674 if (frame
&& ! NILP (bar_window
))
5676 Lisp_Object part_sym
;
5678 part_sym
= *scroll_bar_parts
[(int) part
];
5679 return Fcons (Qscroll_bar_movement
,
5680 (Fcons (Fcons (bar_window
,
5681 Fcons (Qvertical_scroll_bar
,
5682 Fcons (Fcons (x
, y
),
5683 Fcons (make_number (time
),
5689 /* Or is it an ordinary mouse movement? */
5697 /* It's in a frame; which window on that frame? */
5698 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5702 if (WINDOWP (window
))
5704 struct window
*w
= XWINDOW (window
);
5707 /* Get window relative coordinates. */
5708 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5709 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5716 posn
= Qvertical_line
;
5718 posn
= Qheader_line
;
5722 struct display_pos p
;
5723 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5724 posn
= make_number (CHARPOS (p
.pos
));
5727 else if (frame
!= 0)
5729 XSETFRAME (window
, frame
);
5740 return Fcons (Qmouse_movement
,
5741 Fcons (Fcons (window
,
5743 Fcons (Fcons (x
, y
),
5744 Fcons (make_number (time
),
5750 #endif /* HAVE_MOUSE */
5752 /* Construct a switch frame event. */
5754 make_lispy_switch_frame (frame
)
5757 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5760 /* Manipulating modifiers. */
5762 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5764 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5765 SYMBOL's name of the end of the modifiers; the string from this
5766 position is the unmodified symbol name.
5768 This doesn't use any caches. */
5771 parse_modifiers_uncached (symbol
, modifier_end
)
5779 CHECK_SYMBOL (symbol
);
5782 name
= SYMBOL_NAME (symbol
);
5784 for (i
= 0; i
+2 <= SBYTES (name
); )
5786 int this_mod_end
= 0;
5789 /* See if the name continues with a modifier word.
5790 Check that the word appears, but don't check what follows it.
5791 Set this_mod and this_mod_end to record what we find. */
5793 switch (SREF (name
, i
))
5795 #define SINGLE_LETTER_MOD(BIT) \
5796 (this_mod_end = i + 1, this_mod = BIT)
5799 SINGLE_LETTER_MOD (alt_modifier
);
5803 SINGLE_LETTER_MOD (ctrl_modifier
);
5807 SINGLE_LETTER_MOD (hyper_modifier
);
5811 SINGLE_LETTER_MOD (meta_modifier
);
5815 SINGLE_LETTER_MOD (shift_modifier
);
5819 SINGLE_LETTER_MOD (super_modifier
);
5822 #undef SINGLE_LETTER_MOD
5825 /* If we found no modifier, stop looking for them. */
5826 if (this_mod_end
== 0)
5829 /* Check there is a dash after the modifier, so that it
5830 really is a modifier. */
5831 if (this_mod_end
>= SBYTES (name
)
5832 || SREF (name
, this_mod_end
) != '-')
5835 /* This modifier is real; look for another. */
5836 modifiers
|= this_mod
;
5837 i
= this_mod_end
+ 1;
5840 /* Should we include the `click' modifier? */
5841 if (! (modifiers
& (down_modifier
| drag_modifier
5842 | double_modifier
| triple_modifier
))
5843 && i
+ 7 == SBYTES (name
)
5844 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5845 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5846 modifiers
|= click_modifier
;
5854 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5855 prepended to the string BASE[0..BASE_LEN-1].
5856 This doesn't use any caches. */
5858 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5861 int base_len
, base_len_byte
;
5863 /* Since BASE could contain nulls, we can't use intern here; we have
5864 to use Fintern, which expects a genuine Lisp_String, and keeps a
5867 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5873 /* Only the event queue may use the `up' modifier; it should always
5874 be turned into a click or drag event before presented to lisp code. */
5875 if (modifiers
& up_modifier
)
5878 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5879 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5880 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5881 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5882 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5883 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5884 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5885 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5886 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5887 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5888 /* The click modifier is denoted by the absence of other modifiers. */
5892 mod_len
= p
- new_mods
;
5896 Lisp_Object new_name
;
5898 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5899 mod_len
+ base_len_byte
);
5900 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5901 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5903 return Fintern (new_name
, Qnil
);
5908 static char *modifier_names
[] =
5910 "up", "down", "drag", "click", "double", "triple", 0, 0,
5911 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5912 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5914 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5916 static Lisp_Object modifier_symbols
;
5918 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5920 lispy_modifier_list (modifiers
)
5923 Lisp_Object modifier_list
;
5926 modifier_list
= Qnil
;
5927 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5928 if (modifiers
& (1<<i
))
5929 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5932 return modifier_list
;
5936 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5937 where UNMODIFIED is the unmodified form of SYMBOL,
5938 MASK is the set of modifiers present in SYMBOL's name.
5939 This is similar to parse_modifiers_uncached, but uses the cache in
5940 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5941 Qevent_symbol_elements property. */
5944 parse_modifiers (symbol
)
5947 Lisp_Object elements
;
5949 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5950 if (CONSP (elements
))
5955 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5956 Lisp_Object unmodified
;
5959 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
5960 SBYTES (SYMBOL_NAME (symbol
)) - end
),
5963 if (modifiers
& ~VALMASK
)
5965 XSETFASTINT (mask
, modifiers
);
5966 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5968 /* Cache the parsing results on SYMBOL. */
5969 Fput (symbol
, Qevent_symbol_element_mask
,
5971 Fput (symbol
, Qevent_symbol_elements
,
5972 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5974 /* Since we know that SYMBOL is modifiers applied to unmodified,
5975 it would be nice to put that in unmodified's cache.
5976 But we can't, since we're not sure that parse_modifiers is
5983 /* Apply the modifiers MODIFIERS to the symbol BASE.
5984 BASE must be unmodified.
5986 This is like apply_modifiers_uncached, but uses BASE's
5987 Qmodifier_cache property, if present. It also builds
5988 Qevent_symbol_elements properties, since it has that info anyway.
5990 apply_modifiers copies the value of BASE's Qevent_kind property to
5991 the modified symbol. */
5993 apply_modifiers (modifiers
, base
)
5997 Lisp_Object cache
, index
, entry
, new_symbol
;
5999 /* Mask out upper bits. We don't know where this value's been. */
6000 modifiers
&= VALMASK
;
6002 /* The click modifier never figures into cache indices. */
6003 cache
= Fget (base
, Qmodifier_cache
);
6004 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6005 entry
= assq_no_quit (index
, cache
);
6008 new_symbol
= XCDR (entry
);
6011 /* We have to create the symbol ourselves. */
6012 new_symbol
= apply_modifiers_uncached (modifiers
,
6013 SDATA (SYMBOL_NAME (base
)),
6014 SCHARS (SYMBOL_NAME (base
)),
6015 SBYTES (SYMBOL_NAME (base
)));
6017 /* Add the new symbol to the base's cache. */
6018 entry
= Fcons (index
, new_symbol
);
6019 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6021 /* We have the parsing info now for free, so add it to the caches. */
6022 XSETFASTINT (index
, modifiers
);
6023 Fput (new_symbol
, Qevent_symbol_element_mask
,
6024 Fcons (base
, Fcons (index
, Qnil
)));
6025 Fput (new_symbol
, Qevent_symbol_elements
,
6026 Fcons (base
, lispy_modifier_list (modifiers
)));
6029 /* Make sure this symbol is of the same kind as BASE.
6031 You'd think we could just set this once and for all when we
6032 intern the symbol above, but reorder_modifiers may call us when
6033 BASE's property isn't set right; we can't assume that just
6034 because it has a Qmodifier_cache property it must have its
6035 Qevent_kind set right as well. */
6036 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6040 kind
= Fget (base
, Qevent_kind
);
6042 Fput (new_symbol
, Qevent_kind
, kind
);
6049 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6050 return a symbol with the modifiers placed in the canonical order.
6051 Canonical order is alphabetical, except for down and drag, which
6052 always come last. The 'click' modifier is never written out.
6054 Fdefine_key calls this to make sure that (for example) C-M-foo
6055 and M-C-foo end up being equivalent in the keymap. */
6058 reorder_modifiers (symbol
)
6061 /* It's hopefully okay to write the code this way, since everything
6062 will soon be in caches, and no consing will be done at all. */
6065 parsed
= parse_modifiers (symbol
);
6066 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6071 /* For handling events, we often want to produce a symbol whose name
6072 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6073 to some base, like the name of a function key or mouse button.
6074 modify_event_symbol produces symbols of this sort.
6076 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6077 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6080 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6081 into symbol names, or a string specifying a name stem used to
6082 construct a symbol name or the form `STEM-N', where N is the decimal
6083 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6084 non-nil; otherwise NAME_TABLE is used.
6086 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6087 persist between calls to modify_event_symbol that it can use to
6088 store a cache of the symbols it's generated for this NAME_TABLE
6089 before. The object stored there may be a vector or an alist.
6091 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6093 MODIFIERS is a set of modifier bits (as given in struct input_events)
6094 whose prefixes should be applied to the symbol name.
6096 SYMBOL_KIND is the value to be placed in the event_kind property of
6097 the returned symbol.
6099 The symbols we create are supposed to have an
6100 `event-symbol-elements' property, which lists the modifiers present
6101 in the symbol's name. */
6104 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6105 name_table
, symbol_table
, table_size
)
6108 Lisp_Object symbol_kind
;
6109 Lisp_Object name_alist_or_stem
;
6111 Lisp_Object
*symbol_table
;
6112 unsigned int table_size
;
6115 Lisp_Object symbol_int
;
6117 /* Get rid of the "vendor-specific" bit here. */
6118 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6120 /* Is this a request for a valid symbol? */
6121 if (symbol_num
< 0 || symbol_num
>= table_size
)
6124 if (CONSP (*symbol_table
))
6125 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6127 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6128 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6129 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6130 we've never used that symbol before. */
6133 if (! VECTORP (*symbol_table
)
6134 || XVECTOR (*symbol_table
)->size
!= table_size
)
6138 XSETFASTINT (size
, table_size
);
6139 *symbol_table
= Fmake_vector (size
, Qnil
);
6142 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6145 /* Have we already used this symbol before? */
6148 /* No; let's create it. */
6149 if (CONSP (name_alist_or_stem
))
6150 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6151 else if (STRINGP (name_alist_or_stem
))
6153 int len
= SBYTES (name_alist_or_stem
);
6154 char *buf
= (char *) alloca (len
+ 50);
6155 if (sizeof (int) == sizeof (EMACS_INT
))
6156 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6157 XINT (symbol_int
) + 1);
6158 else if (sizeof (long) == sizeof (EMACS_INT
))
6159 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6160 XINT (symbol_int
) + 1);
6161 value
= intern (buf
);
6163 else if (name_table
!= 0 && name_table
[symbol_num
])
6164 value
= intern (name_table
[symbol_num
]);
6166 #ifdef HAVE_WINDOW_SYSTEM
6169 char *name
= x_get_keysym_name (symbol_num
);
6171 value
= intern (name
);
6178 sprintf (buf
, "key-%d", symbol_num
);
6179 value
= intern (buf
);
6182 if (CONSP (*symbol_table
))
6183 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6185 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6187 /* Fill in the cache entries for this symbol; this also
6188 builds the Qevent_symbol_elements property, which the user
6190 apply_modifiers (modifiers
& click_modifier
, value
);
6191 Fput (value
, Qevent_kind
, symbol_kind
);
6194 /* Apply modifiers to that symbol. */
6195 return apply_modifiers (modifiers
, value
);
6198 /* Convert a list that represents an event type,
6199 such as (ctrl meta backspace), into the usual representation of that
6200 event type as a number or a symbol. */
6202 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6203 doc
: /* Convert the event description list EVENT-DESC to an event type.
6204 EVENT-DESC should contain one base event type (a character or symbol)
6205 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6206 drag, down, double or triple). The base must be last.
6207 The return value is an event type (a character or symbol) which
6208 has the same base event type and all the specified modifiers. */)
6210 Lisp_Object event_desc
;
6218 while (CONSP (rest
))
6226 /* Given a symbol, see if it is a modifier name. */
6227 if (SYMBOLP (elt
) && CONSP (rest
))
6228 this = parse_solitary_modifier (elt
);
6232 else if (!NILP (base
))
6233 error ("Two bases given in one event");
6239 /* Let the symbol A refer to the character A. */
6240 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6241 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6243 if (INTEGERP (base
))
6245 /* Turn (shift a) into A. */
6246 if ((modifiers
& shift_modifier
) != 0
6247 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6249 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6250 modifiers
&= ~shift_modifier
;
6253 /* Turn (control a) into C-a. */
6254 if (modifiers
& ctrl_modifier
)
6255 return make_number ((modifiers
& ~ctrl_modifier
)
6256 | make_ctrl_char (XINT (base
)));
6258 return make_number (modifiers
| XINT (base
));
6260 else if (SYMBOLP (base
))
6261 return apply_modifiers (modifiers
, base
);
6264 error ("Invalid base event");
6269 /* Try to recognize SYMBOL as a modifier name.
6270 Return the modifier flag bit, or 0 if not recognized. */
6273 parse_solitary_modifier (symbol
)
6276 Lisp_Object name
= SYMBOL_NAME (symbol
);
6278 switch (SREF (name
, 0))
6280 #define SINGLE_LETTER_MOD(BIT) \
6281 if (SBYTES (name) == 1) \
6284 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6285 if (LEN == SBYTES (name) \
6286 && ! strncmp (SDATA (name), NAME, LEN)) \
6290 SINGLE_LETTER_MOD (alt_modifier
);
6294 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6298 SINGLE_LETTER_MOD (ctrl_modifier
);
6302 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6303 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6307 SINGLE_LETTER_MOD (hyper_modifier
);
6311 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6315 SINGLE_LETTER_MOD (meta_modifier
);
6319 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6323 SINGLE_LETTER_MOD (shift_modifier
);
6327 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6328 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6329 SINGLE_LETTER_MOD (super_modifier
);
6333 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6334 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6335 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6339 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6342 #undef SINGLE_LETTER_MOD
6343 #undef MULTI_LETTER_MOD
6349 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6350 Such a list is not valid as an event,
6351 but it can be a Lucid-style event type list. */
6354 lucid_event_type_list_p (object
)
6359 if (! CONSP (object
))
6362 if (EQ (XCAR (object
), Qhelp_echo
)
6363 || EQ (XCAR (object
), Qvertical_line
)
6364 || EQ (XCAR (object
), Qmode_line
)
6365 || EQ (XCAR (object
), Qheader_line
))
6368 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6372 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6379 /* Store into *addr a value nonzero if terminal input chars are available.
6380 Serves the purpose of ioctl (0, FIONREAD, addr)
6381 but works even if FIONREAD does not exist.
6382 (In fact, this may actually read some input.)
6384 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6385 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6388 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6393 /* First of all, have we already counted some input? */
6394 *addr
= (!NILP (Vquit_flag
)
6395 || readable_filtered_events (do_timers_now
, filter_events
));
6397 /* If input is being read as it arrives, and we have none, there is none. */
6398 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6401 /* Try to read some input and see how much we get. */
6403 *addr
= (!NILP (Vquit_flag
)
6404 || readable_filtered_events (do_timers_now
, filter_events
));
6407 /* Store into *addr a value nonzero if terminal input chars are available.
6408 Serves the purpose of ioctl (0, FIONREAD, addr)
6409 but works even if FIONREAD does not exist.
6410 (In fact, this may actually read some input.)
6412 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6415 get_input_pending (addr
, do_timers_now
)
6419 get_filtered_input_pending (addr
, do_timers_now
, 0);
6422 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6425 gobble_input (expected
)
6430 if (interrupt_input
)
6433 mask
= sigblock (sigmask (SIGIO
));
6434 read_avail_input (expected
);
6438 #ifdef POLL_FOR_INPUT
6439 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6442 mask
= sigblock (sigmask (SIGALRM
));
6443 read_avail_input (expected
);
6449 read_avail_input (expected
);
6453 /* Put a BUFFER_SWITCH_EVENT in the buffer
6454 so that read_key_sequence will notice the new current buffer. */
6457 record_asynch_buffer_change ()
6459 struct input_event event
;
6462 event
.kind
= BUFFER_SWITCH_EVENT
;
6463 event
.frame_or_window
= Qnil
;
6467 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6468 The purpose of the event is to make read_key_sequence look up the
6469 keymaps again. If we aren't in read_key_sequence, we don't need one,
6470 and the event could cause trouble by messing up (input-pending-p). */
6471 tem
= Fwaiting_for_user_input_p ();
6475 /* We never need these events if we have no asynchronous subprocesses. */
6479 /* Make sure no interrupt happens while storing the event. */
6481 if (interrupt_input
)
6484 mask
= sigblock (sigmask (SIGIO
));
6485 kbd_buffer_store_event (&event
);
6492 kbd_buffer_store_event (&event
);
6499 /* Read any terminal input already buffered up by the system
6500 into the kbd_buffer, but do not wait.
6502 EXPECTED should be nonzero if the caller knows there is some input.
6504 Except on VMS, all input is read by this function.
6505 If interrupt_input is nonzero, this function MUST be called
6506 only when SIGIO is blocked.
6508 Returns the number of keyboard chars read, or -1 meaning
6509 this is a bad time to try to read input. */
6512 read_avail_input (expected
)
6515 struct input_event buf
[KBD_BUFFER_SIZE
];
6519 if (read_socket_hook
)
6520 /* No need for FIONREAD or fcntl; just say don't wait. */
6521 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6524 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6525 the kbd_buffer can really hold. That may prevent loss
6526 of characters on some systems when input is stuffed at us. */
6527 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6530 /* Determine how many characters we should *try* to read. */
6533 #else /* not WINDOWSNT */
6535 n_to_read
= dos_keysns ();
6538 #else /* not MSDOS */
6540 /* Find out how much input is available. */
6541 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6542 /* Formerly simply reported no input, but that sometimes led to
6543 a failure of Emacs to terminate.
6544 SIGHUP seems appropriate if we can't reach the terminal. */
6545 /* ??? Is it really right to send the signal just to this process
6546 rather than to the whole process group?
6547 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6548 kill (getpid (), SIGHUP
);
6551 if (n_to_read
> sizeof cbuf
)
6552 n_to_read
= sizeof cbuf
;
6553 #else /* no FIONREAD */
6554 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6555 /* Read some input if available, but don't wait. */
6556 n_to_read
= sizeof cbuf
;
6557 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6562 #endif /* not MSDOS */
6563 #endif /* not WINDOWSNT */
6565 /* Now read; for one reason or another, this will not block.
6566 NREAD is set to the number of chars read. */
6570 cbuf
[0] = dos_keyread ();
6573 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6575 /* POSIX infers that processes which are not in the session leader's
6576 process group won't get SIGHUP's at logout time. BSDI adheres to
6577 this part standard and returns -1 from read (0) with errno==EIO
6578 when the control tty is taken away.
6579 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6580 if (nread
== -1 && errno
== EIO
)
6582 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6583 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6584 This looks incorrect, but it isn't, because _BSD causes
6585 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6586 and that causes a value other than 0 when there is no input. */
6592 /* We used to retry the read if it was interrupted.
6593 But this does the wrong thing when O_NDELAY causes
6594 an EAGAIN error. Does anybody know of a situation
6595 where a retry is actually needed? */
6597 nread
< 0 && (errno
== EAGAIN
6611 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6612 fcntl (input_fd
, F_SETFL
, 0);
6613 #endif /* USG or DGUX or CYGWIN */
6614 #endif /* no FIONREAD */
6615 for (i
= 0; i
< nread
; i
++)
6617 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6618 buf
[i
].modifiers
= 0;
6619 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6620 buf
[i
].modifiers
= meta_modifier
;
6624 buf
[i
].code
= cbuf
[i
];
6625 buf
[i
].frame_or_window
= selected_frame
;
6630 /* Scan the chars for C-g and store them in kbd_buffer. */
6631 for (i
= 0; i
< nread
; i
++)
6633 kbd_buffer_store_event (&buf
[i
]);
6634 /* Don't look at input that follows a C-g too closely.
6635 This reduces lossage due to autorepeat on C-g. */
6636 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6637 && buf
[i
].code
== quit_char
)
6643 #endif /* not VMS */
6645 #ifdef SIGIO /* for entire page */
6646 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6649 input_available_signal (signo
)
6652 /* Must preserve main program's value of errno. */
6653 int old_errno
= errno
;
6655 extern int select_alarmed
;
6658 #if defined (USG) && !defined (POSIX_SIGNALS)
6659 /* USG systems forget handlers when they are used;
6660 must reestablish each time */
6661 signal (signo
, input_available_signal
);
6668 if (input_available_clear_time
)
6669 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6674 nread
= read_avail_input (1);
6675 /* -1 means it's not ok to read the input now.
6676 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6677 0 means there was no keyboard input available. */
6682 select_alarmed
= 1; /* Force the select emulator back to life */
6693 /* Send ourselves a SIGIO.
6695 This function exists so that the UNBLOCK_INPUT macro in
6696 blockinput.h can have some way to take care of input we put off
6697 dealing with, without assuming that every file which uses
6698 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6700 reinvoke_input_signal ()
6703 kill (getpid (), SIGIO
);
6709 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6710 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6712 /* These variables hold the vector under construction within
6713 menu_bar_items and its subroutines, and the current index
6714 for storing into that vector. */
6715 static Lisp_Object menu_bar_items_vector
;
6716 static int menu_bar_items_index
;
6718 /* Return a vector of menu items for a menu bar, appropriate
6719 to the current buffer. Each item has three elements in the vector:
6722 OLD is an old vector we can optionally reuse, or nil. */
6725 menu_bar_items (old
)
6728 /* The number of keymaps we're scanning right now, and the number of
6729 keymaps we have allocated space for. */
6732 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6733 in the current keymaps, or nil where it is not a prefix. */
6736 Lisp_Object def
, tail
;
6745 struct gcpro gcpro1
;
6747 /* In order to build the menus, we need to call the keymap
6748 accessors. They all call QUIT. But this function is called
6749 during redisplay, during which a quit is fatal. So inhibit
6750 quitting while building the menus.
6751 We do this instead of specbind because (1) errors will clear it anyway
6752 and (2) this avoids risk of specpdl overflow. */
6753 oquit
= Vinhibit_quit
;
6757 menu_bar_items_vector
= old
;
6759 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6760 menu_bar_items_index
= 0;
6762 GCPRO1 (menu_bar_items_vector
);
6764 /* Build our list of keymaps.
6765 If we recognize a function key and replace its escape sequence in
6766 keybuf with its symbol, or if the sequence starts with a mouse
6767 click and we need to switch buffers, we jump back here to rebuild
6768 the initial keymaps from the current buffer. */
6772 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6773 if (!NILP (Voverriding_local_map_menu_flag
))
6775 /* Yes, use them (if non-nil) as well as the global map. */
6776 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6778 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6779 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6780 if (!NILP (Voverriding_local_map
))
6781 maps
[nmaps
++] = Voverriding_local_map
;
6785 /* No, so use major and minor mode keymaps and keymap property.
6786 Note that menu-bar bindings in the local-map and keymap
6787 properties may not work reliable, as they are only
6788 recognized when the menu-bar (or mode-line) is updated,
6789 which does not normally happen after every command. */
6792 nminor
= current_minor_maps (NULL
, &tmaps
);
6793 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6795 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6796 maps
[nmaps
++] = tem
;
6797 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6799 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6801 maps
[nmaps
++] = current_global_map
;
6804 /* Look up in each map the dummy prefix key `menu-bar'. */
6808 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6809 if (!NILP (maps
[mapno
]))
6811 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6814 menu_bar_one_keymap (def
);
6817 /* Move to the end those items that should be at the end. */
6819 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6822 int end
= menu_bar_items_index
;
6824 for (i
= 0; i
< end
; i
+= 4)
6825 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6827 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6828 /* Move the item at index I to the end,
6829 shifting all the others forward. */
6830 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6831 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6832 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6833 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6835 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6836 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6837 (end
- i
- 4) * sizeof (Lisp_Object
));
6838 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6839 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6840 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6841 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6846 /* Add nil, nil, nil, nil at the end. */
6847 i
= menu_bar_items_index
;
6848 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6851 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6852 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6853 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6854 menu_bar_items_vector
= tem
;
6856 /* Add this item. */
6857 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6858 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6859 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6860 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6861 menu_bar_items_index
= i
;
6863 Vinhibit_quit
= oquit
;
6865 return menu_bar_items_vector
;
6868 /* Scan one map KEYMAP, accumulating any menu items it defines
6869 in menu_bar_items_vector. */
6871 static Lisp_Object menu_bar_one_keymap_changed_items
;
6874 menu_bar_one_keymap (keymap
)
6877 Lisp_Object tail
, item
;
6879 menu_bar_one_keymap_changed_items
= Qnil
;
6881 /* Loop over all keymap entries that have menu strings. */
6882 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6886 menu_bar_item (XCAR (item
), XCDR (item
));
6887 else if (VECTORP (item
))
6889 /* Loop over the char values represented in the vector. */
6890 int len
= XVECTOR (item
)->size
;
6892 for (c
= 0; c
< len
; c
++)
6894 Lisp_Object character
;
6895 XSETFASTINT (character
, c
);
6896 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6902 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6903 If there's already an item for KEY, add this DEF to it. */
6905 Lisp_Object item_properties
;
6908 menu_bar_item (key
, item
)
6909 Lisp_Object key
, item
;
6911 struct gcpro gcpro1
;
6915 if (EQ (item
, Qundefined
))
6917 /* If a map has an explicit `undefined' as definition,
6918 discard any previously made menu bar item. */
6920 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6921 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6923 if (menu_bar_items_index
> i
+ 4)
6924 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6925 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6926 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6927 menu_bar_items_index
-= 4;
6931 /* If this keymap has already contributed to this KEY,
6932 don't contribute to it a second time. */
6933 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6934 if (!NILP (tem
) || NILP (item
))
6937 menu_bar_one_keymap_changed_items
6938 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6940 /* We add to menu_bar_one_keymap_changed_items before doing the
6941 parse_menu_item, so that if it turns out it wasn't a menu item,
6942 it still correctly hides any further menu item. */
6944 i
= parse_menu_item (item
, 0, 1);
6949 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6951 /* Find any existing item for this KEY. */
6952 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6953 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6956 /* If we did not find this KEY, add it at the end. */
6957 if (i
== menu_bar_items_index
)
6959 /* If vector is too small, get a bigger one. */
6960 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6963 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6964 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6965 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6966 menu_bar_items_vector
= tem
;
6969 /* Add this item. */
6970 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6971 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6972 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6973 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6974 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6975 menu_bar_items_index
= i
;
6977 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6981 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6982 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6986 /* This is used as the handler when calling menu_item_eval_property. */
6988 menu_item_eval_property_1 (arg
)
6991 /* If we got a quit from within the menu computation,
6992 quit all the way out of it. This takes care of C-] in the debugger. */
6993 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6994 Fsignal (Qquit
, Qnil
);
6999 /* Evaluate an expression and return the result (or nil if something
7000 went wrong). Used to evaluate dynamic parts of menu items. */
7002 menu_item_eval_property (sexpr
)
7005 int count
= SPECPDL_INDEX ();
7007 specbind (Qinhibit_redisplay
, Qt
);
7008 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7009 menu_item_eval_property_1
);
7010 return unbind_to (count
, val
);
7013 /* This function parses a menu item and leaves the result in the
7014 vector item_properties.
7015 ITEM is a key binding, a possible menu item.
7016 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7017 evaluate dynamic expressions in the menu item.
7018 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7020 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7021 parse_menu_item returns true if the item is a menu item and false
7025 parse_menu_item (item
, notreal
, inmenubar
)
7027 int notreal
, inmenubar
;
7029 Lisp_Object def
, tem
, item_string
, start
;
7030 Lisp_Object cachelist
;
7032 Lisp_Object keyhint
;
7043 /* Create item_properties vector if necessary. */
7044 if (NILP (item_properties
))
7046 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7048 /* Initialize optional entries. */
7049 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7050 AREF (item_properties
, i
) = Qnil
;
7051 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7053 /* Save the item here to protect it from GC. */
7054 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7056 item_string
= XCAR (item
);
7060 if (STRINGP (item_string
))
7062 /* Old format menu item. */
7063 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7065 /* Maybe help string. */
7066 if (CONSP (item
) && STRINGP (XCAR (item
)))
7068 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7073 /* Maybe key binding cache. */
7074 if (CONSP (item
) && CONSP (XCAR (item
))
7075 && (NILP (XCAR (XCAR (item
)))
7076 || VECTORP (XCAR (XCAR (item
)))))
7078 cachelist
= XCAR (item
);
7082 /* This is the real definition--the function to run. */
7083 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7085 /* Get enable property, if any. */
7088 tem
= Fget (item
, Qmenu_enable
);
7090 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7093 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7095 /* New format menu item. */
7096 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7097 start
= XCDR (item
);
7100 /* We have a real binding. */
7101 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7103 item
= XCDR (start
);
7104 /* Is there a cache list with key equivalences. */
7105 if (CONSP (item
) && CONSP (XCAR (item
)))
7107 cachelist
= XCAR (item
);
7111 /* Parse properties. */
7112 while (CONSP (item
) && CONSP (XCDR (item
)))
7117 if (EQ (tem
, QCenable
))
7118 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7119 else if (EQ (tem
, QCvisible
) && !notreal
)
7121 /* If got a visible property and that evaluates to nil
7122 then ignore this item. */
7123 tem
= menu_item_eval_property (XCAR (item
));
7127 else if (EQ (tem
, QChelp
))
7128 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7129 else if (EQ (tem
, QCfilter
))
7131 else if (EQ (tem
, QCkey_sequence
))
7134 if (NILP (cachelist
)
7135 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7136 /* Be GC protected. Set keyhint to item instead of tem. */
7139 else if (EQ (tem
, QCkeys
))
7142 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7143 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7145 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7150 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7152 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7154 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7161 else if (inmenubar
|| !NILP (start
))
7165 return 0; /* not a menu item */
7167 /* If item string is not a string, evaluate it to get string.
7168 If we don't get a string, skip this item. */
7169 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7170 if (!(STRINGP (item_string
) || notreal
))
7172 item_string
= menu_item_eval_property (item_string
);
7173 if (!STRINGP (item_string
))
7175 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7178 /* If got a filter apply it on definition. */
7179 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7182 def
= menu_item_eval_property (list2 (XCAR (filter
),
7183 list2 (Qquote
, def
)));
7185 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7188 /* Enable or disable selection of item. */
7189 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7195 tem
= menu_item_eval_property (tem
);
7196 if (inmenubar
&& NILP (tem
))
7197 return 0; /* Ignore disabled items in menu bar. */
7198 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7201 /* If we got no definition, this item is just unselectable text which
7202 is OK in a submenu but not in the menubar. */
7204 return (inmenubar
? 0 : 1);
7206 /* See if this is a separate pane or a submenu. */
7207 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7208 tem
= get_keymap (def
, 0, 1);
7209 /* For a subkeymap, just record its details and exit. */
7212 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7213 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7217 /* At the top level in the menu bar, do likewise for commands also.
7218 The menu bar does not display equivalent key bindings anyway.
7219 ITEM_PROPERTY_DEF is already set up properly. */
7223 /* This is a command. See if there is an equivalent key binding. */
7224 if (NILP (cachelist
))
7226 /* We have to create a cachelist. */
7227 CHECK_IMPURE (start
);
7228 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7229 cachelist
= XCAR (XCDR (start
));
7231 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7232 if (!NILP (keyhint
))
7234 XSETCAR (cachelist
, XCAR (keyhint
));
7237 else if (STRINGP (tem
))
7239 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7240 XSETCAR (cachelist
, Qt
);
7244 tem
= XCAR (cachelist
);
7251 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7253 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7256 def
= XCAR (prefix
);
7257 prefix
= XCDR (prefix
);
7260 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7262 if (!update_menu_bindings
)
7264 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7266 if (newcache
/* Always check first time. */
7267 /* Should we check everything when precomputing key
7269 /* If something had no key binding before, don't recheck it
7270 because that is too slow--except if we have a list of
7271 rebound commands in Vdefine_key_rebound_commands, do
7272 recheck any command that appears in that list. */
7273 || (CONSP (Vdefine_key_rebound_commands
)
7274 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7277 /* We had a saved key. Is it still bound to the command? */
7280 /* If the command is an alias for another
7281 (such as lmenu.el set it up), check if the
7282 original command matches the cached command. */
7283 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7284 chkcache
= 1; /* Need to recompute key binding. */
7288 /* Recompute equivalent key binding. If the command is an alias
7289 for another (such as lmenu.el set it up), see if the original
7290 command name has equivalent keys. Otherwise look up the
7291 specified command itself. We don't try both, because that
7292 makes lmenu menus slow. */
7294 && SYMBOLP (XSYMBOL (def
)->function
)
7295 && ! NILP (Fget (def
, Qmenu_alias
)))
7296 def
= XSYMBOL (def
)->function
;
7297 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7298 XSETCAR (cachelist
, tem
);
7301 XSETCDR (cachelist
, Qnil
);
7305 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7307 tem
= XCAR (cachelist
);
7311 newcache
= chkcache
;
7314 tem
= Fkey_description (tem
);
7317 if (STRINGP (XCAR (prefix
)))
7318 tem
= concat2 (XCAR (prefix
), tem
);
7319 if (STRINGP (XCDR (prefix
)))
7320 tem
= concat2 (tem
, XCDR (prefix
));
7322 XSETCDR (cachelist
, tem
);
7326 tem
= XCDR (cachelist
);
7327 if (newcache
&& !NILP (tem
))
7329 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7330 XSETCDR (cachelist
, tem
);
7333 /* If we only want to precompute equivalent key bindings, stop here. */
7337 /* If we have an equivalent key binding, use that. */
7338 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7340 /* Include this when menu help is implemented.
7341 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7342 if (!(NILP (tem) || STRINGP (tem)))
7344 tem = menu_item_eval_property (tem);
7347 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7351 /* Handle radio buttons or toggle boxes. */
7352 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7354 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7355 = menu_item_eval_property (tem
);
7362 /***********************************************************************
7364 ***********************************************************************/
7366 /* A vector holding tool bar items while they are parsed in function
7367 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7370 static Lisp_Object tool_bar_items_vector
;
7372 /* A vector holding the result of parse_tool_bar_item. Layout is like
7373 the one for a single item in tool_bar_items_vector. */
7375 static Lisp_Object tool_bar_item_properties
;
7377 /* Next free index in tool_bar_items_vector. */
7379 static int ntool_bar_items
;
7381 /* The symbols `tool-bar', and `:image'. */
7383 extern Lisp_Object Qtool_bar
;
7384 Lisp_Object QCimage
;
7386 /* Function prototypes. */
7388 static void init_tool_bar_items
P_ ((Lisp_Object
));
7389 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7390 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7391 static void append_tool_bar_item
P_ ((void));
7394 /* Return a vector of tool bar items for keymaps currently in effect.
7395 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7396 tool bar items found. */
7399 tool_bar_items (reuse
, nitems
)
7410 /* In order to build the menus, we need to call the keymap
7411 accessors. They all call QUIT. But this function is called
7412 during redisplay, during which a quit is fatal. So inhibit
7413 quitting while building the menus. We do this instead of
7414 specbind because (1) errors will clear it anyway and (2) this
7415 avoids risk of specpdl overflow. */
7416 oquit
= Vinhibit_quit
;
7419 /* Initialize tool_bar_items_vector and protect it from GC. */
7420 init_tool_bar_items (reuse
);
7422 /* Build list of keymaps in maps. Set nmaps to the number of maps
7425 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7426 if (!NILP (Voverriding_local_map_menu_flag
))
7428 /* Yes, use them (if non-nil) as well as the global map. */
7429 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7431 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7432 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7433 if (!NILP (Voverriding_local_map
))
7434 maps
[nmaps
++] = Voverriding_local_map
;
7438 /* No, so use major and minor mode keymaps and keymap property.
7439 Note that tool-bar bindings in the local-map and keymap
7440 properties may not work reliable, as they are only
7441 recognized when the tool-bar (or mode-line) is updated,
7442 which does not normally happen after every command. */
7445 nminor
= current_minor_maps (NULL
, &tmaps
);
7446 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7448 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7449 maps
[nmaps
++] = tem
;
7450 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7452 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7455 /* Add global keymap at the end. */
7456 maps
[nmaps
++] = current_global_map
;
7458 /* Process maps in reverse order and look up in each map the prefix
7460 for (i
= nmaps
- 1; i
>= 0; --i
)
7461 if (!NILP (maps
[i
]))
7465 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7470 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7471 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7473 Lisp_Object keydef
= XCAR (tail
);
7475 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7480 Vinhibit_quit
= oquit
;
7481 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7482 return tool_bar_items_vector
;
7486 /* Process the definition of KEY which is DEF. */
7489 process_tool_bar_item (key
, def
)
7490 Lisp_Object key
, def
;
7493 extern Lisp_Object Qundefined
;
7494 struct gcpro gcpro1
, gcpro2
;
7496 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7500 if (EQ (def
, Qundefined
))
7502 /* If a map has an explicit `undefined' as definition,
7503 discard any previously made item. */
7504 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7506 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7508 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7510 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7511 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7512 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7513 * sizeof (Lisp_Object
)));
7514 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7519 else if (parse_tool_bar_item (key
, def
))
7520 /* Append a new tool bar item to tool_bar_items_vector. Accept
7521 more than one definition for the same key. */
7522 append_tool_bar_item ();
7528 /* Parse a tool bar item specification ITEM for key KEY and return the
7529 result in tool_bar_item_properties. Value is zero if ITEM is
7532 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7534 CAPTION is the caption of the item, If it's not a string, it is
7535 evaluated to get a string.
7537 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7538 as binding are currently ignored.
7540 The following properties are recognized:
7544 FORM is evaluated and specifies whether the tool bar item is
7545 enabled or disabled.
7549 FORM is evaluated and specifies whether the tool bar item is visible.
7551 - `:filter FUNCTION'
7553 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7554 result is stored as the new binding.
7556 - `:button (TYPE SELECTED)'
7558 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7559 and specifies whether the button is selected (pressed) or not.
7563 IMAGES is either a single image specification or a vector of four
7564 image specifications. See enum tool_bar_item_images.
7566 - `:help HELP-STRING'.
7568 Gives a help string to display for the tool bar item. */
7571 parse_tool_bar_item (key
, item
)
7572 Lisp_Object key
, item
;
7574 /* Access slot with index IDX of vector tool_bar_item_properties. */
7575 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7577 Lisp_Object filter
= Qnil
;
7578 Lisp_Object caption
;
7581 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7582 Rule out items that aren't lists, don't start with
7583 `menu-item' or whose rest following `tool-bar-item' is not a
7586 || !EQ (XCAR (item
), Qmenu_item
)
7587 || (item
= XCDR (item
),
7591 /* Create tool_bar_item_properties vector if necessary. Reset it to
7593 if (VECTORP (tool_bar_item_properties
))
7595 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7599 tool_bar_item_properties
7600 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7603 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7604 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7606 /* Get the caption of the item. If the caption is not a string,
7607 evaluate it to get a string. If we don't get a string, skip this
7609 caption
= XCAR (item
);
7610 if (!STRINGP (caption
))
7612 caption
= menu_item_eval_property (caption
);
7613 if (!STRINGP (caption
))
7616 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7618 /* Give up if rest following the caption is not a list. */
7623 /* Store the binding. */
7624 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7627 /* Ignore cached key binding, if any. */
7628 if (CONSP (item
) && CONSP (XCAR (item
)))
7631 /* Process the rest of the properties. */
7632 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7634 Lisp_Object key
, value
;
7637 value
= XCAR (XCDR (item
));
7639 if (EQ (key
, QCenable
))
7640 /* `:enable FORM'. */
7641 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7642 else if (EQ (key
, QCvisible
))
7644 /* `:visible FORM'. If got a visible property and that
7645 evaluates to nil then ignore this item. */
7646 if (NILP (menu_item_eval_property (value
)))
7649 else if (EQ (key
, QChelp
))
7650 /* `:help HELP-STRING'. */
7651 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7652 else if (EQ (key
, QCfilter
))
7653 /* ':filter FORM'. */
7655 else if (EQ (key
, QCbutton
) && CONSP (value
))
7657 /* `:button (TYPE . SELECTED)'. */
7658 Lisp_Object type
, selected
;
7660 type
= XCAR (value
);
7661 selected
= XCDR (value
);
7662 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7664 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7665 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7668 else if (EQ (key
, QCimage
)
7670 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7671 /* Value is either a single image specification or a vector
7672 of 4 such specifications for the different button states. */
7673 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7676 /* If got a filter apply it on binding. */
7678 PROP (TOOL_BAR_ITEM_BINDING
)
7679 = menu_item_eval_property (list2 (filter
,
7681 PROP (TOOL_BAR_ITEM_BINDING
))));
7683 /* See if the binding is a keymap. Give up if it is. */
7684 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7687 /* Enable or disable selection of item. */
7688 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7689 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7690 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7692 /* Handle radio buttons or toggle boxes. */
7693 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7694 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7695 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7703 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7704 that can be reused. */
7707 init_tool_bar_items (reuse
)
7710 if (VECTORP (reuse
))
7711 tool_bar_items_vector
= reuse
;
7713 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7714 ntool_bar_items
= 0;
7718 /* Append parsed tool bar item properties from
7719 tool_bar_item_properties */
7722 append_tool_bar_item ()
7724 Lisp_Object
*to
, *from
;
7726 /* Enlarge tool_bar_items_vector if necessary. */
7727 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7728 >= XVECTOR (tool_bar_items_vector
)->size
)
7730 Lisp_Object new_vector
;
7731 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7733 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7734 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7735 XVECTOR (new_vector
)->contents
,
7736 old_size
* sizeof (Lisp_Object
));
7737 tool_bar_items_vector
= new_vector
;
7740 /* Append entries from tool_bar_item_properties to the end of
7741 tool_bar_items_vector. */
7742 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7743 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7744 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7745 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7752 /* Read a character using menus based on maps in the array MAPS.
7753 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7754 Return t if we displayed a menu but the user rejected it.
7756 PREV_EVENT is the previous input event, or nil if we are reading
7757 the first event of a key sequence.
7759 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7760 if we used a mouse menu to read the input, or zero otherwise. If
7761 USED_MOUSE_MENU is null, we don't dereference it.
7763 The prompting is done based on the prompt-string of the map
7764 and the strings associated with various map elements.
7766 This can be done with X menus or with menus put in the minibuf.
7767 These are done in different ways, depending on how the input will be read.
7768 Menus using X are done after auto-saving in read-char, getting the input
7769 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7770 and do auto-saving in the inner call of read_char. */
7773 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7776 Lisp_Object prev_event
;
7777 int *used_mouse_menu
;
7780 register Lisp_Object name
= Qnil
;
7782 if (used_mouse_menu
)
7783 *used_mouse_menu
= 0;
7785 /* Use local over global Menu maps */
7787 if (! menu_prompting
)
7790 /* Optionally disregard all but the global map. */
7791 if (inhibit_local_menu_bar_menus
)
7793 maps
+= (nmaps
- 1);
7797 /* Get the menu name from the first map that has one (a prompt string). */
7798 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7800 name
= Fkeymap_prompt (maps
[mapno
]);
7805 /* If we don't have any menus, just read a character normally. */
7806 if (!STRINGP (name
))
7810 /* If we got to this point via a mouse click,
7811 use a real menu for mouse selection. */
7812 if (EVENT_HAS_PARAMETERS (prev_event
)
7813 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7814 && !EQ (XCAR (prev_event
), Qtool_bar
))
7816 /* Display the menu and get the selection. */
7817 Lisp_Object
*realmaps
7818 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7822 /* Use the maps that are not nil. */
7823 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7824 if (!NILP (maps
[mapno
]))
7825 realmaps
[nmaps1
++] = maps
[mapno
];
7827 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7832 record_menu_key (XCAR (value
));
7834 /* If we got multiple events, unread all but
7836 There is no way to prevent those unread events
7837 from showing up later in last_nonmenu_event.
7838 So turn symbol and integer events into lists,
7839 to indicate that they came from a mouse menu,
7840 so that when present in last_nonmenu_event
7841 they won't confuse things. */
7842 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7844 record_menu_key (XCAR (tem
));
7845 if (SYMBOLP (XCAR (tem
))
7846 || INTEGERP (XCAR (tem
)))
7847 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7850 /* If we got more than one event, put all but the first
7851 onto this list to be read later.
7852 Return just the first event now. */
7853 Vunread_command_events
7854 = nconc2 (XCDR (value
), Vunread_command_events
);
7855 value
= XCAR (value
);
7857 else if (NILP (value
))
7859 if (used_mouse_menu
)
7860 *used_mouse_menu
= 1;
7863 #endif /* HAVE_MENUS */
7867 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7868 We make this bigger when necessary, and never free it. */
7869 static char *read_char_minibuf_menu_text
;
7870 /* Size of that buffer. */
7871 static int read_char_minibuf_menu_width
;
7874 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7880 register Lisp_Object name
;
7882 /* FIXME: Use the minibuffer's frame width. */
7883 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7886 Lisp_Object rest
, vector
;
7892 if (! menu_prompting
)
7895 /* Make sure we have a big enough buffer for the menu text. */
7896 if (read_char_minibuf_menu_text
== 0)
7898 read_char_minibuf_menu_width
= width
+ 4;
7899 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7901 else if (width
+ 4 > read_char_minibuf_menu_width
)
7903 read_char_minibuf_menu_width
= width
+ 4;
7904 read_char_minibuf_menu_text
7905 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7907 menu
= read_char_minibuf_menu_text
;
7909 /* Get the menu name from the first map that has one (a prompt string). */
7910 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7912 name
= Fkeymap_prompt (maps
[mapno
]);
7917 /* If we don't have any menus, just read a character normally. */
7918 if (!STRINGP (name
))
7921 /* Prompt string always starts with map's prompt, and a space. */
7922 strcpy (menu
, SDATA (name
));
7923 nlength
= SBYTES (name
);
7924 menu
[nlength
++] = ':';
7925 menu
[nlength
++] = ' ';
7928 /* Start prompting at start of first map. */
7932 /* Present the documented bindings, a line at a time. */
7939 Lisp_Object orig_defn_macro
;
7941 /* Loop over elements of map. */
7946 /* If reached end of map, start at beginning of next map. */
7950 /* At end of last map, wrap around to first map if just starting,
7951 or end this line if already have something on it. */
7955 if (notfirst
|| nobindings
) break;
7960 /* Look at the next element of the map. */
7962 elt
= XVECTOR (vector
)->contents
[idx
];
7964 elt
= Fcar_safe (rest
);
7966 if (idx
< 0 && VECTORP (elt
))
7968 /* If we found a dense table in the keymap,
7969 advanced past it, but start scanning its contents. */
7970 rest
= Fcdr_safe (rest
);
7976 /* An ordinary element. */
7977 Lisp_Object event
, tem
;
7981 event
= Fcar_safe (elt
); /* alist */
7982 elt
= Fcdr_safe (elt
);
7986 XSETINT (event
, idx
); /* vector */
7989 /* Ignore the element if it has no prompt string. */
7990 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7992 /* 1 if the char to type matches the string. */
7994 Lisp_Object upcased_event
, downcased_event
;
7995 Lisp_Object desc
= Qnil
;
7997 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7999 upcased_event
= Fupcase (event
);
8000 downcased_event
= Fdowncase (event
);
8001 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8002 || XINT (downcased_event
) == SREF (s
, 0));
8004 desc
= Fsingle_key_description (event
, Qnil
);
8006 #if 0 /* It is redundant to list the equivalent key bindings because
8007 the prefix is what the user has already typed. */
8009 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8011 /* Insert equivalent keybinding. */
8012 s
= concat2 (s
, tem
);
8015 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8016 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8018 /* Insert button prefix. */
8019 Lisp_Object selected
8020 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8021 if (EQ (tem
, QCradio
))
8022 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8024 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8025 s
= concat2 (tem
, s
);
8029 /* If we have room for the prompt string, add it to this line.
8030 If this is the first on the line, always add it. */
8031 if ((SCHARS (s
) + i
+ 2
8032 + (char_matches
? 0 : SCHARS (desc
) + 3))
8038 /* Punctuate between strings. */
8041 strcpy (menu
+ i
, ", ");
8047 /* If the char to type doesn't match the string's
8048 first char, explicitly show what char to type. */
8051 /* Add as much of string as fits. */
8052 thiswidth
= SCHARS (desc
);
8053 if (thiswidth
+ i
> width
)
8054 thiswidth
= width
- i
;
8055 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8057 strcpy (menu
+ i
, " = ");
8061 /* Add as much of string as fits. */
8062 thiswidth
= SCHARS (s
);
8063 if (thiswidth
+ i
> width
)
8064 thiswidth
= width
- i
;
8065 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8071 /* If this element does not fit, end the line now,
8072 and save the element for the next line. */
8073 strcpy (menu
+ i
, "...");
8078 /* Move past this element. */
8079 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8080 /* Handle reaching end of dense table. */
8085 rest
= Fcdr_safe (rest
);
8089 /* Prompt with that and read response. */
8090 message2_nolog (menu
, strlen (menu
),
8091 ! NILP (current_buffer
->enable_multibyte_characters
));
8093 /* Make believe its not a keyboard macro in case the help char
8094 is pressed. Help characters are not recorded because menu prompting
8095 is not used on replay.
8097 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8098 current_kboard
->defining_kbd_macro
= Qnil
;
8100 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8101 while (BUFFERP (obj
));
8102 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8104 if (!INTEGERP (obj
))
8109 if (! EQ (obj
, menu_prompt_more_char
)
8110 && (!INTEGERP (menu_prompt_more_char
)
8111 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8113 if (!NILP (current_kboard
->defining_kbd_macro
))
8114 store_kbd_macro_char (obj
);
8117 /* Help char - go round again */
8121 /* Reading key sequences. */
8123 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8124 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8125 keymap, or nil otherwise. Return the index of the first keymap in
8126 which KEY has any binding, or NMAPS if no map has a binding.
8128 If KEY is a meta ASCII character, treat it like meta-prefix-char
8129 followed by the corresponding non-meta character. Keymaps in
8130 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8133 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8136 NEXT may be the same array as CURRENT. */
8139 follow_key (key
, nmaps
, current
, defs
, next
)
8141 Lisp_Object
*current
, *defs
, *next
;
8144 int i
, first_binding
;
8147 first_binding
= nmaps
;
8148 for (i
= nmaps
- 1; i
>= 0; i
--)
8150 if (! NILP (current
[i
]))
8158 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
8159 if (! NILP (defs
[i
]))
8166 /* Given the set of bindings we've found, produce the next set of maps. */
8167 if (first_binding
< nmaps
)
8168 for (i
= 0; i
< nmaps
; i
++)
8169 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8171 return first_binding
;
8174 /* Structure used to keep track of partial application of key remapping
8175 such as Vfunction_key_map and Vkey_translation_map. */
8176 typedef struct keyremap
8183 /* Read a sequence of keys that ends with a non prefix character,
8184 storing it in KEYBUF, a buffer of size BUFSIZE.
8186 Return the length of the key sequence stored.
8187 Return -1 if the user rejected a command menu.
8189 Echo starting immediately unless `prompt' is 0.
8191 Where a key sequence ends depends on the currently active keymaps.
8192 These include any minor mode keymaps active in the current buffer,
8193 the current buffer's local map, and the global map.
8195 If a key sequence has no other bindings, we check Vfunction_key_map
8196 to see if some trailing subsequence might be the beginning of a
8197 function key's sequence. If so, we try to read the whole function
8198 key, and substitute its symbolic name into the key sequence.
8200 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8201 `double-' events into similar click events, if that would make them
8202 bound. We try to turn `triple-' events first into `double-' events,
8205 If we get a mouse click in a mode line, vertical divider, or other
8206 non-text area, we treat the click as if it were prefixed by the
8207 symbol denoting that area - `mode-line', `vertical-line', or
8210 If the sequence starts with a mouse click, we read the key sequence
8211 with respect to the buffer clicked on, not the current buffer.
8213 If the user switches frames in the midst of a key sequence, we put
8214 off the switch-frame event until later; the next call to
8215 read_char will return it.
8217 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8218 from the selected window's buffer. */
8221 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8222 can_return_switch_frame
, fix_current_buffer
)
8223 Lisp_Object
*keybuf
;
8226 int dont_downcase_last
;
8227 int can_return_switch_frame
;
8228 int fix_current_buffer
;
8230 volatile Lisp_Object from_string
;
8231 volatile int count
= SPECPDL_INDEX ();
8233 /* How many keys there are in the current key sequence. */
8236 /* The length of the echo buffer when we started reading, and
8237 the length of this_command_keys when we started reading. */
8238 volatile int echo_start
;
8239 volatile int keys_start
;
8241 /* The number of keymaps we're scanning right now, and the number of
8242 keymaps we have allocated space for. */
8244 volatile int nmaps_allocated
= 0;
8246 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8247 the current keymaps. */
8248 Lisp_Object
*volatile defs
= NULL
;
8250 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8251 in the current keymaps, or nil where it is not a prefix. */
8252 Lisp_Object
*volatile submaps
= NULL
;
8254 /* The local map to start out with at start of key sequence. */
8255 volatile Lisp_Object orig_local_map
;
8257 /* The map from the `keymap' property to start out with at start of
8259 volatile Lisp_Object orig_keymap
;
8261 /* 1 if we have already considered switching to the local-map property
8262 of the place where a mouse click occurred. */
8263 volatile int localized_local_map
= 0;
8265 /* The index in defs[] of the first keymap that has a binding for
8266 this key sequence. In other words, the lowest i such that
8267 defs[i] is non-nil. */
8268 volatile int first_binding
;
8269 /* Index of the first key that has no binding.
8270 It is useless to try fkey.start larger than that. */
8271 volatile int first_unbound
;
8273 /* If t < mock_input, then KEYBUF[t] should be read as the next
8276 We use this to recover after recognizing a function key. Once we
8277 realize that a suffix of the current key sequence is actually a
8278 function key's escape sequence, we replace the suffix with the
8279 function key's binding from Vfunction_key_map. Now keybuf
8280 contains a new and different key sequence, so the echo area,
8281 this_command_keys, and the submaps and defs arrays are wrong. In
8282 this situation, we set mock_input to t, set t to 0, and jump to
8283 restart_sequence; the loop will read keys from keybuf up until
8284 mock_input, thus rebuilding the state; and then it will resume
8285 reading characters from the keyboard. */
8286 volatile int mock_input
= 0;
8288 /* If the sequence is unbound in submaps[], then
8289 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8290 and fkey.map is its binding.
8292 These might be > t, indicating that all function key scanning
8293 should hold off until t reaches them. We do this when we've just
8294 recognized a function key, to avoid searching for the function
8295 key's again in Vfunction_key_map. */
8296 volatile keyremap fkey
;
8298 /* Likewise, for key_translation_map. */
8299 volatile keyremap keytran
;
8301 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8302 we put it off for later. While we're reading, we keep the event here. */
8303 volatile Lisp_Object delayed_switch_frame
;
8305 /* See the comment below... */
8306 #if defined (GOBBLE_FIRST_EVENT)
8307 Lisp_Object first_event
;
8310 volatile Lisp_Object original_uppercase
;
8311 volatile int original_uppercase_position
= -1;
8313 /* Gets around Microsoft compiler limitations. */
8316 struct buffer
*starting_buffer
;
8318 /* List of events for which a fake prefix key has been generated. */
8319 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8321 #if defined (GOBBLE_FIRST_EVENT)
8325 struct gcpro gcpro1
;
8327 GCPRO1 (fake_prefixed_keys
);
8328 raw_keybuf_count
= 0;
8330 last_nonmenu_event
= Qnil
;
8332 delayed_switch_frame
= Qnil
;
8333 fkey
.map
= Vfunction_key_map
;
8334 keytran
.map
= Vkey_translation_map
;
8335 /* If there is no translation-map, turn off scanning. */
8336 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8337 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8342 echo_prompt (prompt
);
8343 else if (cursor_in_echo_area
8344 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8345 && NILP (Fzerop (Vecho_keystrokes
)))
8346 /* This doesn't put in a dash if the echo buffer is empty, so
8347 you don't always see a dash hanging out in the minibuffer. */
8351 /* Record the initial state of the echo area and this_command_keys;
8352 we will need to restore them if we replay a key sequence. */
8354 echo_start
= echo_length ();
8355 keys_start
= this_command_key_count
;
8356 this_single_command_key_start
= keys_start
;
8358 #if defined (GOBBLE_FIRST_EVENT)
8359 /* This doesn't quite work, because some of the things that read_char
8360 does cannot safely be bypassed. It seems too risky to try to make
8363 /* Read the first char of the sequence specially, before setting
8364 up any keymaps, in case a filter runs and switches buffers on us. */
8365 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8367 #endif /* GOBBLE_FIRST_EVENT */
8369 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8370 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8373 /* We jump here when the key sequence has been thoroughly changed, and
8374 we need to rescan it starting from the beginning. When we jump here,
8375 keybuf[0..mock_input] holds the sequence we should reread. */
8378 starting_buffer
= current_buffer
;
8379 first_unbound
= bufsize
+ 1;
8381 /* Build our list of keymaps.
8382 If we recognize a function key and replace its escape sequence in
8383 keybuf with its symbol, or if the sequence starts with a mouse
8384 click and we need to switch buffers, we jump back here to rebuild
8385 the initial keymaps from the current buffer. */
8388 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8389 || !NILP (Voverriding_local_map
))
8391 if (3 > nmaps_allocated
)
8393 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8394 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8395 nmaps_allocated
= 3;
8397 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8398 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8399 if (!NILP (Voverriding_local_map
))
8400 submaps
[nmaps
++] = Voverriding_local_map
;
8408 nminor
= current_minor_maps (0, &maps
);
8409 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8411 if (total
> nmaps_allocated
)
8413 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8414 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8415 nmaps_allocated
= total
;
8418 if (!NILP (orig_keymap
))
8419 submaps
[nmaps
++] = orig_keymap
;
8421 bcopy (maps
, (void *) (submaps
+ nmaps
),
8422 nminor
* sizeof (submaps
[0]));
8426 submaps
[nmaps
++] = orig_local_map
;
8428 submaps
[nmaps
++] = current_global_map
;
8430 /* Find an accurate initial value for first_binding. */
8431 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8432 if (! NILP (submaps
[first_binding
]))
8435 /* Start from the beginning in keybuf. */
8438 /* These are no-ops the first time through, but if we restart, they
8439 revert the echo area and this_command_keys to their original state. */
8440 this_command_key_count
= keys_start
;
8441 if (INTERACTIVE
&& t
< mock_input
)
8442 echo_truncate (echo_start
);
8444 /* If the best binding for the current key sequence is a keymap, or
8445 we may be looking at a function key's escape sequence, keep on
8447 while (first_binding
< nmaps
8448 /* Keep reading as long as there's a prefix binding. */
8449 ? !NILP (submaps
[first_binding
])
8450 /* Don't return in the middle of a possible function key sequence,
8451 if the only bindings we found were via case conversion.
8452 Thus, if ESC O a has a function-key-map translation
8453 and ESC o has a binding, don't return after ESC O,
8454 so that we can translate ESC O plus the next character. */
8455 : (fkey
.start
< t
|| keytran
.start
< t
))
8458 int used_mouse_menu
= 0;
8460 /* Where the last real key started. If we need to throw away a
8461 key that has expanded into more than one element of keybuf
8462 (say, a mouse click on the mode line which is being treated
8463 as [mode-line (mouse-...)], then we backtrack to this point
8465 volatile int last_real_key_start
;
8467 /* These variables are analogous to echo_start and keys_start;
8468 while those allow us to restart the entire key sequence,
8469 echo_local_start and keys_local_start allow us to throw away
8471 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8473 /* key-translation-map is applied *after* function-key-map. */
8474 eassert (keytran
.end
<= fkey
.start
);
8476 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8477 { /* The prefix upto first_unbound has no binding and has
8478 no translation left to do either, so we know it's unbound.
8479 If we don't stop now, we risk staying here indefinitely
8480 (if the user keeps entering fkey or keytran prefixes
8481 like C-c ESC ESC ESC ESC ...) */
8483 for (i
= first_unbound
+ 1; i
< t
; i
++)
8484 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8485 mock_input
= t
- first_unbound
- 1;
8486 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8487 fkey
.map
= Vfunction_key_map
;
8488 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8489 keytran
.map
= Vkey_translation_map
;
8490 goto replay_sequence
;
8494 error ("Key sequence too long");
8497 echo_local_start
= echo_length ();
8498 keys_local_start
= this_command_key_count
;
8499 local_first_binding
= first_binding
;
8502 /* These are no-ops, unless we throw away a keystroke below and
8503 jumped back up to replay_key; in that case, these restore the
8504 variables to their original state, allowing us to replay the
8506 if (INTERACTIVE
&& t
< mock_input
)
8507 echo_truncate (echo_local_start
);
8508 this_command_key_count
= keys_local_start
;
8509 first_binding
= local_first_binding
;
8511 /* By default, assume each event is "real". */
8512 last_real_key_start
= t
;
8514 /* Does mock_input indicate that we are re-reading a key sequence? */
8518 add_command_key (key
);
8519 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8520 && NILP (Fzerop (Vecho_keystrokes
)))
8524 /* If not, we should actually read a character. */
8529 KBOARD
*interrupted_kboard
= current_kboard
;
8530 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8531 if (setjmp (wrong_kboard_jmpbuf
))
8533 if (!NILP (delayed_switch_frame
))
8535 interrupted_kboard
->kbd_queue
8536 = Fcons (delayed_switch_frame
,
8537 interrupted_kboard
->kbd_queue
);
8538 delayed_switch_frame
= Qnil
;
8541 interrupted_kboard
->kbd_queue
8542 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8544 /* If the side queue is non-empty, ensure it begins with a
8545 switch-frame, so we'll replay it in the right context. */
8546 if (CONSP (interrupted_kboard
->kbd_queue
)
8547 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8548 !(EVENT_HAS_PARAMETERS (key
)
8549 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8553 XSETFRAME (frame
, interrupted_frame
);
8554 interrupted_kboard
->kbd_queue
8555 = Fcons (make_lispy_switch_frame (frame
),
8556 interrupted_kboard
->kbd_queue
);
8559 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8560 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8561 goto replay_sequence
;
8564 key
= read_char (NILP (prompt
), nmaps
,
8565 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8569 /* read_char returns t when it shows a menu and the user rejects it.
8573 unbind_to (count
, Qnil
);
8578 /* read_char returns -1 at the end of a macro.
8579 Emacs 18 handles this by returning immediately with a
8580 zero, so that's what we'll do. */
8581 if (INTEGERP (key
) && XINT (key
) == -1)
8584 /* The Microsoft C compiler can't handle the goto that
8590 /* If the current buffer has been changed from under us, the
8591 keymap may have changed, so replay the sequence. */
8594 EMACS_TIME initial_idleness_start_time
;
8595 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8596 EMACS_SECS (timer_last_idleness_start_time
),
8597 EMACS_USECS (timer_last_idleness_start_time
));
8599 /* Resume idle state, using the same start-time as before. */
8600 timer_start_idle ();
8601 timer_idleness_start_time
= initial_idleness_start_time
;
8604 /* Reset the current buffer from the selected window
8605 in case something changed the former and not the latter.
8606 This is to be more consistent with the behavior
8607 of the command_loop_1. */
8608 if (fix_current_buffer
)
8610 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8612 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8613 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8616 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8617 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8618 goto replay_sequence
;
8621 /* If we have a quit that was typed in another frame, and
8622 quit_throw_to_read_char switched buffers,
8623 replay to get the right keymap. */
8625 && XINT (key
) == quit_char
8626 && current_buffer
!= starting_buffer
)
8629 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8633 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8634 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8635 goto replay_sequence
;
8640 if (EVENT_HAS_PARAMETERS (key
)
8641 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8643 /* If we're at the beginning of a key sequence, and the caller
8644 says it's okay, go ahead and return this event. If we're
8645 in the midst of a key sequence, delay it until the end. */
8646 if (t
> 0 || !can_return_switch_frame
)
8648 delayed_switch_frame
= key
;
8654 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8657 /* Clicks in non-text areas get prefixed by the symbol
8658 in their CHAR-ADDRESS field. For example, a click on
8659 the mode line is prefixed by the symbol `mode-line'.
8661 Furthermore, key sequences beginning with mouse clicks
8662 are read using the keymaps of the buffer clicked on, not
8663 the current buffer. So we may have to switch the buffer
8666 When we turn one event into two events, we must make sure
8667 that neither of the two looks like the original--so that,
8668 if we replay the events, they won't be expanded again.
8669 If not for this, such reexpansion could happen either here
8670 or when user programs play with this-command-keys. */
8671 if (EVENT_HAS_PARAMETERS (key
))
8675 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8676 if (EQ (kind
, Qmouse_click
))
8678 Lisp_Object window
, posn
;
8680 window
= POSN_WINDOW (EVENT_START (key
));
8681 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8684 || (!NILP (fake_prefixed_keys
)
8685 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8687 /* We're looking a second time at an event for which
8688 we generated a fake prefix key. Set
8689 last_real_key_start appropriately. */
8691 last_real_key_start
= t
- 1;
8694 /* Key sequences beginning with mouse clicks are
8695 read using the keymaps in the buffer clicked on,
8696 not the current buffer. If we're at the
8697 beginning of a key sequence, switch buffers. */
8698 if (last_real_key_start
== 0
8700 && BUFFERP (XWINDOW (window
)->buffer
)
8701 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8703 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8707 /* Arrange to go back to the original buffer once we're
8708 done reading the key sequence. Note that we can't
8709 use save_excursion_{save,restore} here, because they
8710 save point as well as the current buffer; we don't
8711 want to save point, because redisplay may change it,
8712 to accommodate a Fset_window_start or something. We
8713 don't want to do this at the top of the function,
8714 because we may get input from a subprocess which
8715 wants to change the selected window and stuff (say,
8717 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8719 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8721 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8722 orig_local_map
= get_local_map (PT
, current_buffer
,
8724 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8725 goto replay_sequence
;
8728 /* For a mouse click, get the local text-property keymap
8729 of the place clicked on, rather than point. */
8730 if (last_real_key_start
== 0
8731 && CONSP (XCDR (key
))
8732 && ! localized_local_map
)
8734 Lisp_Object map_here
, start
, pos
;
8736 localized_local_map
= 1;
8737 start
= EVENT_START (key
);
8739 if (CONSP (start
) && CONSP (XCDR (start
)))
8741 pos
= POSN_BUFFER_POSN (start
);
8743 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8745 map_here
= get_local_map (XINT (pos
),
8746 current_buffer
, Qlocal_map
);
8747 if (!EQ (map_here
, orig_local_map
))
8749 orig_local_map
= map_here
;
8753 goto replay_sequence
;
8755 map_here
= get_local_map (XINT (pos
),
8756 current_buffer
, Qkeymap
);
8757 if (!EQ (map_here
, orig_keymap
))
8759 orig_keymap
= map_here
;
8763 goto replay_sequence
;
8769 /* Expand mode-line and scroll-bar events into two events:
8770 use posn as a fake prefix key. */
8772 && (NILP (fake_prefixed_keys
)
8773 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8775 if (t
+ 1 >= bufsize
)
8776 error ("Key sequence too long");
8779 keybuf
[t
+ 1] = key
;
8782 /* Record that a fake prefix key has been generated
8783 for KEY. Don't modify the event; this would
8784 prevent proper action when the event is pushed
8785 back into unread-command-events. */
8786 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8788 /* If on a mode line string with a local keymap,
8789 reconsider the key sequence with that keymap. */
8790 if (CONSP (POSN_STRING (EVENT_START (key
))))
8792 Lisp_Object string
, pos
, map
, map2
;
8794 string
= POSN_STRING (EVENT_START (key
));
8795 pos
= XCDR (string
);
8796 string
= XCAR (string
);
8798 && XINT (pos
) < SCHARS (string
))
8800 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8802 orig_local_map
= map
;
8803 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8806 if (!NILP (map
) || !NILP (map2
))
8807 goto replay_sequence
;
8813 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8814 && NILP (from_string
))
8816 /* For a click on a string, i.e. overlay string or a
8817 string displayed via the `display' property,
8818 consider `local-map' and `keymap' properties of
8820 Lisp_Object string
, pos
, map
, map2
;
8822 string
= POSN_STRING (EVENT_START (key
));
8823 pos
= XCDR (string
);
8824 string
= XCAR (string
);
8826 && XINT (pos
) < SCHARS (string
))
8828 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8830 orig_local_map
= map
;
8831 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8835 if (!NILP (map
) || !NILP (map2
))
8837 from_string
= string
;
8838 goto replay_sequence
;
8843 else if (CONSP (XCDR (key
))
8844 && CONSP (EVENT_START (key
))
8845 && CONSP (XCDR (EVENT_START (key
))))
8849 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8850 /* Handle menu-bar events:
8851 insert the dummy prefix event `menu-bar'. */
8852 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8854 if (t
+ 1 >= bufsize
)
8855 error ("Key sequence too long");
8859 /* Zap the position in key, so we know that we've
8860 expanded it, and don't try to do so again. */
8861 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8862 Fcons (posn
, Qnil
));
8865 goto replay_sequence
;
8867 else if (CONSP (posn
))
8869 /* We're looking at the second event of a
8870 sequence which we expanded before. Set
8871 last_real_key_start appropriately. */
8872 if (last_real_key_start
== t
&& t
> 0)
8873 last_real_key_start
= t
- 1;
8878 /* We have finally decided that KEY is something we might want
8880 first_binding
= (follow_key (key
,
8881 nmaps
- first_binding
,
8882 submaps
+ first_binding
,
8883 defs
+ first_binding
,
8884 submaps
+ first_binding
)
8887 /* If KEY wasn't bound, we'll try some fallbacks. */
8888 if (first_binding
< nmaps
)
8889 /* This is needed for the following scenario:
8890 event 0: a down-event that gets dropped by calling replay_key.
8891 event 1: some normal prefix like C-h.
8892 After event 0, first_unbound is 0, after event 1 fkey.start
8893 and keytran.start are both 1, so when we see that C-h is bound,
8894 we need to update first_unbound. */
8895 first_unbound
= max (t
+ 1, first_unbound
);
8900 /* Remember the position to put an upper bound on fkey.start. */
8901 first_unbound
= min (t
, first_unbound
);
8903 head
= EVENT_HEAD (key
);
8904 if (help_char_p (head
) && t
> 0)
8906 read_key_sequence_cmd
= Vprefix_help_command
;
8908 last_nonmenu_event
= key
;
8909 /* The Microsoft C compiler can't handle the goto that
8917 Lisp_Object breakdown
;
8920 breakdown
= parse_modifiers (head
);
8921 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8922 /* Attempt to reduce an unbound mouse event to a simpler
8923 event that is bound:
8924 Drags reduce to clicks.
8925 Double-clicks reduce to clicks.
8926 Triple-clicks reduce to double-clicks, then to clicks.
8927 Down-clicks are eliminated.
8928 Double-downs reduce to downs, then are eliminated.
8929 Triple-downs reduce to double-downs, then to downs,
8930 then are eliminated. */
8931 if (modifiers
& (down_modifier
| drag_modifier
8932 | double_modifier
| triple_modifier
))
8934 while (modifiers
& (down_modifier
| drag_modifier
8935 | double_modifier
| triple_modifier
))
8937 Lisp_Object new_head
, new_click
;
8938 if (modifiers
& triple_modifier
)
8939 modifiers
^= (double_modifier
| triple_modifier
);
8940 else if (modifiers
& double_modifier
)
8941 modifiers
&= ~double_modifier
;
8942 else if (modifiers
& drag_modifier
)
8943 modifiers
&= ~drag_modifier
;
8946 /* Dispose of this `down' event by simply jumping
8947 back to replay_key, to get another event.
8949 Note that if this event came from mock input,
8950 then just jumping back to replay_key will just
8951 hand it to us again. So we have to wipe out any
8954 We could delete keybuf[t] and shift everything
8955 after that to the left by one spot, but we'd also
8956 have to fix up any variable that points into
8957 keybuf, and shifting isn't really necessary
8960 Adding prefixes for non-textual mouse clicks
8961 creates two characters of mock input, and both
8962 must be thrown away. If we're only looking at
8963 the prefix now, we can just jump back to
8964 replay_key. On the other hand, if we've already
8965 processed the prefix, and now the actual click
8966 itself is giving us trouble, then we've lost the
8967 state of the keymaps we want to backtrack to, and
8968 we need to replay the whole sequence to rebuild
8971 Beyond that, only function key expansion could
8972 create more than two keys, but that should never
8973 generate mouse events, so it's okay to zero
8974 mock_input in that case too.
8976 FIXME: The above paragraph seems just plain
8977 wrong, if you consider things like
8978 xterm-mouse-mode. -stef
8980 Isn't this just the most wonderful code ever? */
8981 if (t
== last_real_key_start
)
8988 mock_input
= last_real_key_start
;
8989 goto replay_sequence
;
8994 = apply_modifiers (modifiers
, XCAR (breakdown
));
8996 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8998 /* Look for a binding for this new key. follow_key
8999 promises that it didn't munge submaps the
9000 last time we called it, since key was unbound. */
9002 = (follow_key (new_click
,
9003 nmaps
- local_first_binding
,
9004 submaps
+ local_first_binding
,
9005 defs
+ local_first_binding
,
9006 submaps
+ local_first_binding
)
9007 + local_first_binding
);
9009 /* If that click is bound, go for it. */
9010 if (first_binding
< nmaps
)
9015 /* Otherwise, we'll leave key set to the drag event. */
9022 /* Normally, last_nonmenu_event gets the previous key we read.
9023 But when a mouse popup menu is being used,
9024 we don't update last_nonmenu_event; it continues to hold the mouse
9025 event that preceded the first level of menu. */
9026 if (!used_mouse_menu
)
9027 last_nonmenu_event
= key
;
9029 /* Record what part of this_command_keys is the current key sequence. */
9030 this_single_command_key_start
= this_command_key_count
- t
;
9032 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9033 /* There is a binding and it's not a prefix.
9034 There is thus no function-key in this sequence.
9035 Moving fkey.start is important in this case to allow keytran.start
9036 to go over the sequence before we return (since we keep the
9037 invariant that keytran.end <= fkey.start). */
9040 (fkey
.start
= fkey
.end
= t
, fkey
.map
= Vfunction_key_map
);
9043 /* If the sequence is unbound, see if we can hang a function key
9044 off the end of it. */
9048 /* Continue scan from fkey.end until we find a bound suffix.
9049 If we fail, increment fkey.start and start over from there. */
9050 while (fkey
.end
< t
)
9054 key
= keybuf
[fkey
.end
++];
9055 next
= access_keymap (fkey
.map
, key
, 1, 0, 1);
9057 /* Handle symbol with autoload definition. */
9058 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9059 && CONSP (XSYMBOL (next
)->function
)
9060 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9061 do_autoload (XSYMBOL (next
)->function
, next
);
9063 /* Handle a symbol whose function definition is a keymap
9065 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9066 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9067 || KEYMAPP (XSYMBOL (next
)->function
)))
9068 next
= XSYMBOL (next
)->function
;
9070 #if 0 /* I didn't turn this on, because it might cause trouble
9071 for the mapping of return into C-m and tab into C-i. */
9072 /* Optionally don't map function keys into other things.
9073 This enables the user to redefine kp- keys easily. */
9074 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
9078 /* If the function key map gives a function, not an
9079 array, then call the function with no args and use
9080 its value instead. */
9081 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9082 /* If there's a binding (i.e. first_binding >= nmaps)
9083 we don't want to apply this function-key-mapping. */
9084 && fkey
.end
== t
&& first_binding
>= nmaps
)
9086 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9090 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9091 next
= call1 (next
, prompt
);
9093 /* If the function returned something invalid,
9094 barf--don't ignore it.
9095 (To ignore it safely, we would need to gcpro a bunch of
9096 other variables.) */
9097 if (! (VECTORP (next
) || STRINGP (next
)))
9098 error ("Function in key-translation-map returns invalid key sequence");
9101 /* If keybuf[fkey.start..fkey.end] is bound in the
9102 function key map and it's a suffix of the current
9103 sequence (i.e. fkey.end == t), replace it with
9104 the binding and restart with fkey.start at the end. */
9105 if ((VECTORP (next
) || STRINGP (next
))
9106 /* If there's a binding (i.e. first_binding >= nmaps)
9107 we don't want to apply this function-key-mapping. */
9108 && fkey
.end
== t
&& first_binding
>= nmaps
)
9110 int len
= XFASTINT (Flength (next
));
9112 t
= fkey
.start
+ len
;
9114 error ("Key sequence too long");
9117 bcopy (XVECTOR (next
)->contents
,
9118 keybuf
+ fkey
.start
,
9119 (t
- fkey
.start
) * sizeof (keybuf
[0]));
9120 else if (STRINGP (next
))
9124 for (i
= 0; i
< len
; i
++)
9125 XSETFASTINT (keybuf
[fkey
.start
+ i
], SREF (next
, i
));
9129 fkey
.start
= fkey
.end
= t
;
9130 fkey
.map
= Vfunction_key_map
;
9132 /* Do pass the results through key-translation-map.
9133 But don't retranslate what key-translation-map
9134 has already translated. */
9135 keytran
.end
= keytran
.start
;
9136 keytran
.map
= Vkey_translation_map
;
9138 goto replay_sequence
;
9141 fkey
.map
= get_keymap (next
, 0, 1);
9143 /* If we no longer have a bound suffix, try a new positions for
9145 if (!CONSP (fkey
.map
))
9147 fkey
.end
= ++fkey
.start
;
9148 fkey
.map
= Vfunction_key_map
;
9153 /* Look for this sequence in key-translation-map. */
9157 /* Scan from keytran.end until we find a bound suffix. */
9158 while (keytran
.end
< fkey
.start
)
9162 key
= keybuf
[keytran
.end
++];
9163 next
= access_keymap (keytran
.map
, key
, 1, 0, 1);
9165 /* Handle symbol with autoload definition. */
9166 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9167 && CONSP (XSYMBOL (next
)->function
)
9168 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9169 do_autoload (XSYMBOL (next
)->function
, next
);
9171 /* Handle a symbol whose function definition is a keymap
9173 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9174 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9175 || KEYMAPP (XSYMBOL (next
)->function
)))
9176 next
= XSYMBOL (next
)->function
;
9178 /* If the key translation map gives a function, not an
9179 array, then call the function with one arg and use
9180 its value instead. */
9181 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
)))
9183 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9187 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9188 next
= call1 (next
, prompt
);
9190 /* If the function returned something invalid,
9191 barf--don't ignore it.
9192 (To ignore it safely, we would need to gcpro a bunch of
9193 other variables.) */
9194 if (! (VECTORP (next
) || STRINGP (next
)))
9195 error ("Function in key-translation-map returns invalid key sequence");
9198 /* If keybuf[keytran.start..keytran.end] is bound in the
9199 key translation map and it's a suffix of the current
9200 sequence (i.e. keytran.end == t), replace it with
9201 the binding and restart with keytran.start at the end. */
9202 if ((VECTORP (next
) || STRINGP (next
)))
9204 int len
= XFASTINT (Flength (next
));
9205 int i
, diff
= len
- (keytran
.end
- keytran
.start
);
9207 mock_input
= max (t
, mock_input
);
9208 if (mock_input
+ diff
>= bufsize
)
9209 error ("Key sequence too long");
9211 /* Shift the keys that are after keytran.end. */
9213 for (i
= keytran
.end
; i
< mock_input
; i
++)
9214 keybuf
[i
+ diff
] = keybuf
[i
];
9216 for (i
= mock_input
- 1; i
>= keytran
.end
; i
--)
9217 keybuf
[i
+ diff
] = keybuf
[i
];
9218 /* Replace the keys between keytran.start and keytran.end
9219 with those from next. */
9220 for (i
= 0; i
< len
; i
++)
9221 keybuf
[keytran
.start
+ i
]
9222 = Faref (next
, make_number (i
));
9225 keytran
.start
= keytran
.end
+= diff
;
9226 keytran
.map
= Vkey_translation_map
;
9228 /* Adjust the function-key-map counters. */
9232 goto replay_sequence
;
9235 keytran
.map
= get_keymap (next
, 0, 1);
9237 /* If we no longer have a bound suffix, try a new positions for
9239 if (!CONSP (keytran
.map
))
9241 keytran
.end
= ++keytran
.start
;
9242 keytran
.map
= Vkey_translation_map
;
9247 /* If KEY is not defined in any of the keymaps,
9248 and cannot be part of a function key or translation,
9249 and is an upper case letter
9250 use the corresponding lower-case letter instead. */
9251 if (first_binding
>= nmaps
9252 && fkey
.start
>= t
&& keytran
.start
>= t
9254 && ((((XINT (key
) & 0x3ffff)
9255 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9256 && UPPERCASEP (XINT (key
) & 0x3ffff))
9257 || (XINT (key
) & shift_modifier
)))
9259 Lisp_Object new_key
;
9261 original_uppercase
= key
;
9262 original_uppercase_position
= t
- 1;
9264 if (XINT (key
) & shift_modifier
)
9265 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9267 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9268 | (XINT (key
) & ~0x3ffff)));
9270 /* We have to do this unconditionally, regardless of whether
9271 the lower-case char is defined in the keymaps, because they
9272 might get translated through function-key-map. */
9273 keybuf
[t
- 1] = new_key
;
9274 mock_input
= max (t
, mock_input
);
9276 goto replay_sequence
;
9278 /* If KEY is not defined in any of the keymaps,
9279 and cannot be part of a function key or translation,
9280 and is a shifted function key,
9281 use the corresponding unshifted function key instead. */
9282 if (first_binding
>= nmaps
9283 && fkey
.start
>= t
&& keytran
.start
>= t
9286 Lisp_Object breakdown
;
9289 breakdown
= parse_modifiers (key
);
9290 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9291 if (modifiers
& shift_modifier
)
9293 Lisp_Object new_key
;
9295 original_uppercase
= key
;
9296 original_uppercase_position
= t
- 1;
9298 modifiers
&= ~shift_modifier
;
9299 new_key
= apply_modifiers (modifiers
,
9302 keybuf
[t
- 1] = new_key
;
9303 mock_input
= max (t
, mock_input
);
9305 goto replay_sequence
;
9311 read_key_sequence_cmd
= (first_binding
< nmaps
9312 ? defs
[first_binding
]
9315 unread_switch_frame
= delayed_switch_frame
;
9316 unbind_to (count
, Qnil
);
9318 /* Don't downcase the last character if the caller says don't.
9319 Don't downcase it if the result is undefined, either. */
9320 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9321 && t
- 1 == original_uppercase_position
)
9322 keybuf
[t
- 1] = original_uppercase
;
9324 /* Occasionally we fabricate events, perhaps by expanding something
9325 according to function-key-map, or by adding a prefix symbol to a
9326 mouse click in the scroll bar or modeline. In this cases, return
9327 the entire generated key sequence, even if we hit an unbound
9328 prefix or a definition before the end. This means that you will
9329 be able to push back the event properly, and also means that
9330 read-key-sequence will always return a logical unit.
9333 for (; t
< mock_input
; t
++)
9335 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9336 && NILP (Fzerop (Vecho_keystrokes
)))
9337 echo_char (keybuf
[t
]);
9338 add_command_key (keybuf
[t
]);
9347 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9348 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9349 The sequence is sufficient to specify a non-prefix command in the
9350 current local and global maps.
9352 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9353 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9354 as a continuation of the previous key.
9356 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9357 convert the last event to lower case. (Normally any upper case event
9358 is converted to lower case if the original event is undefined and the lower
9359 case equivalent is defined.) A non-nil value is appropriate for reading
9360 a key sequence to be defined.
9362 A C-g typed while in this function is treated like any other character,
9363 and `quit-flag' is not set.
9365 If the key sequence starts with a mouse click, then the sequence is read
9366 using the keymaps of the buffer of the window clicked in, not the buffer
9367 of the selected window as normal.
9369 `read-key-sequence' drops unbound button-down events, since you normally
9370 only care about the click or drag events which follow them. If a drag
9371 or multi-click event is unbound, but the corresponding click event would
9372 be bound, `read-key-sequence' turns the event into a click event at the
9373 drag's starting position. This means that you don't have to distinguish
9374 between click and drag, double, or triple events unless you want to.
9376 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9377 lines separating windows, and scroll bars with imaginary keys
9378 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9380 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9381 function will process a switch-frame event if the user switches frames
9382 before typing anything. If the user switches frames in the middle of a
9383 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9384 is nil, then the event will be put off until after the current key sequence.
9386 `read-key-sequence' checks `function-key-map' for function key
9387 sequences, where they wouldn't conflict with ordinary bindings. See
9388 `function-key-map' for more details.
9390 The optional fifth argument COMMAND-LOOP, if non-nil, means
9391 that this key sequence is being read by something that will
9392 read commands one after another. It should be nil if the caller
9393 will read just one key sequence. */)
9394 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9396 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9397 Lisp_Object can_return_switch_frame
, command_loop
;
9399 Lisp_Object keybuf
[30];
9401 struct gcpro gcpro1
;
9402 int count
= SPECPDL_INDEX ();
9405 CHECK_STRING (prompt
);
9408 specbind (Qinput_method_exit_on_first_char
,
9409 (NILP (command_loop
) ? Qt
: Qnil
));
9410 specbind (Qinput_method_use_echo_area
,
9411 (NILP (command_loop
) ? Qt
: Qnil
));
9413 bzero (keybuf
, sizeof keybuf
);
9415 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9417 if (NILP (continue_echo
))
9419 this_command_key_count
= 0;
9420 this_command_key_count_reset
= 0;
9421 this_single_command_key_start
= 0;
9424 #ifdef HAVE_X_WINDOWS
9425 if (display_hourglass_p
)
9426 cancel_hourglass ();
9429 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9430 prompt
, ! NILP (dont_downcase_last
),
9431 ! NILP (can_return_switch_frame
), 0);
9433 #if 0 /* The following is fine for code reading a key sequence and
9434 then proceeding with a lenghty computation, but it's not good
9435 for code reading keys in a loop, like an input method. */
9436 #ifdef HAVE_X_WINDOWS
9437 if (display_hourglass_p
)
9448 return unbind_to (count
, make_event_array (i
, keybuf
));
9451 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9452 Sread_key_sequence_vector
, 1, 5, 0,
9453 doc
: /* Like `read-key-sequence' but always return a vector. */)
9454 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9456 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9457 Lisp_Object can_return_switch_frame
, command_loop
;
9459 Lisp_Object keybuf
[30];
9461 struct gcpro gcpro1
;
9462 int count
= SPECPDL_INDEX ();
9465 CHECK_STRING (prompt
);
9468 specbind (Qinput_method_exit_on_first_char
,
9469 (NILP (command_loop
) ? Qt
: Qnil
));
9470 specbind (Qinput_method_use_echo_area
,
9471 (NILP (command_loop
) ? Qt
: Qnil
));
9473 bzero (keybuf
, sizeof keybuf
);
9475 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9477 if (NILP (continue_echo
))
9479 this_command_key_count
= 0;
9480 this_command_key_count_reset
= 0;
9481 this_single_command_key_start
= 0;
9484 #ifdef HAVE_X_WINDOWS
9485 if (display_hourglass_p
)
9486 cancel_hourglass ();
9489 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9490 prompt
, ! NILP (dont_downcase_last
),
9491 ! NILP (can_return_switch_frame
), 0);
9493 #ifdef HAVE_X_WINDOWS
9494 if (display_hourglass_p
)
9504 return unbind_to (count
, Fvector (i
, keybuf
));
9507 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9508 doc
: /* Execute CMD as an editor command.
9509 CMD must be a symbol that satisfies the `commandp' predicate.
9510 Optional second arg RECORD-FLAG non-nil
9511 means unconditionally put this command in `command-history'.
9512 Otherwise, that is done only if an arg is read using the minibuffer.
9513 The argument KEYS specifies the value to use instead of (this-command-keys)
9514 when reading the arguments; if it is nil, (this-command-keys) is used.
9515 The argument SPECIAL, if non-nil, means that this command is executing
9516 a special event, so ignore the prefix argument and don't clear it. */)
9517 (cmd
, record_flag
, keys
, special
)
9518 Lisp_Object cmd
, record_flag
, keys
, special
;
9520 register Lisp_Object final
;
9521 register Lisp_Object tem
;
9522 Lisp_Object prefixarg
;
9523 struct backtrace backtrace
;
9524 extern int debug_on_next_call
;
9526 debug_on_next_call
= 0;
9530 prefixarg
= current_kboard
->Vprefix_arg
;
9531 Vcurrent_prefix_arg
= prefixarg
;
9532 current_kboard
->Vprefix_arg
= Qnil
;
9539 tem
= Fget (cmd
, Qdisabled
);
9540 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9542 tem
= Fsymbol_value (Qdisabled_command_hook
);
9544 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9550 final
= Findirect_function (cmd
);
9552 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9554 struct gcpro gcpro1
, gcpro2
;
9556 GCPRO2 (cmd
, prefixarg
);
9557 do_autoload (final
, cmd
);
9564 if (STRINGP (final
) || VECTORP (final
))
9566 /* If requested, place the macro in the command history. For
9567 other sorts of commands, call-interactively takes care of
9569 if (!NILP (record_flag
))
9572 = Fcons (Fcons (Qexecute_kbd_macro
,
9573 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9576 /* Don't keep command history around forever. */
9577 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9579 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9581 XSETCDR (tem
, Qnil
);
9585 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9588 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9590 backtrace
.next
= backtrace_list
;
9591 backtrace_list
= &backtrace
;
9592 backtrace
.function
= &Qcall_interactively
;
9593 backtrace
.args
= &cmd
;
9594 backtrace
.nargs
= 1;
9595 backtrace
.evalargs
= 0;
9597 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9599 backtrace_list
= backtrace
.next
;
9607 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9609 doc
: /* Read function name, then read its arguments and call it. */)
9611 Lisp_Object prefixarg
;
9613 Lisp_Object function
;
9615 int saved_last_point_position
;
9616 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9617 Lisp_Object bindings
, value
;
9618 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9620 saved_keys
= Fvector (this_command_key_count
,
9621 XVECTOR (this_command_keys
)->contents
);
9622 saved_last_point_position_buffer
= last_point_position_buffer
;
9623 saved_last_point_position
= last_point_position
;
9625 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9627 if (EQ (prefixarg
, Qminus
))
9629 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9630 strcpy (buf
, "C-u ");
9631 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9633 if (sizeof (int) == sizeof (EMACS_INT
))
9634 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9635 else if (sizeof (long) == sizeof (EMACS_INT
))
9636 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9640 else if (INTEGERP (prefixarg
))
9642 if (sizeof (int) == sizeof (EMACS_INT
))
9643 sprintf (buf
, "%d ", XINT (prefixarg
));
9644 else if (sizeof (long) == sizeof (EMACS_INT
))
9645 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9650 /* This isn't strictly correct if execute-extended-command
9651 is bound to anything else. Perhaps it should use
9652 this_command_keys? */
9653 strcat (buf
, "M-x ");
9655 /* Prompt with buf, and then read a string, completing from and
9656 restricting to the set of all defined commands. Don't provide
9657 any initial input. Save the command read on the extended-command
9659 function
= Fcompleting_read (build_string (buf
),
9660 Vobarray
, Qcommandp
,
9661 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9664 if (STRINGP (function
) && SCHARS (function
) == 0)
9665 error ("No command name given");
9667 /* Set this_command_keys to the concatenation of saved_keys and
9668 function, followed by a RET. */
9673 this_command_key_count
= 0;
9674 this_command_key_count_reset
= 0;
9675 this_single_command_key_start
= 0;
9677 keys
= XVECTOR (saved_keys
)->contents
;
9678 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9679 add_command_key (keys
[i
]);
9681 for (i
= 0; i
< SCHARS (function
); i
++)
9682 add_command_key (Faref (function
, make_number (i
)));
9684 add_command_key (make_number ('\015'));
9687 last_point_position
= saved_last_point_position
;
9688 last_point_position_buffer
= saved_last_point_position_buffer
;
9692 function
= Fintern (function
, Qnil
);
9693 current_kboard
->Vprefix_arg
= prefixarg
;
9694 Vthis_command
= function
;
9695 real_this_command
= function
;
9697 /* If enabled, show which key runs this command. */
9698 if (!NILP (Vsuggest_key_bindings
)
9699 && NILP (Vexecuting_macro
)
9700 && SYMBOLP (function
))
9701 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9707 GCPRO2 (bindings
, value
);
9708 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9710 /* If the command has a key binding, print it now. */
9711 if (!NILP (bindings
)
9712 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9715 /* But first wait, and skip the message if there is input. */
9717 if (!NILP (echo_area_buffer
[0]))
9718 /* This command displayed something in the echo area;
9719 so wait a few seconds, then display our suggestion message. */
9720 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9721 ? XINT (Vsuggest_key_bindings
) : 2);
9723 /* This command left the echo area empty,
9724 so display our message immediately. */
9727 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9728 && ! CONSP (Vunread_command_events
))
9730 Lisp_Object binding
;
9732 int message_p
= push_message ();
9733 int count
= SPECPDL_INDEX ();
9735 record_unwind_protect (pop_message_unwind
, Qnil
);
9736 binding
= Fkey_description (bindings
);
9739 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9742 sprintf (newmessage
, "You can run the command `%s' with %s",
9743 SDATA (SYMBOL_NAME (function
)),
9745 message2_nolog (newmessage
,
9746 strlen (newmessage
),
9747 STRING_MULTIBYTE (binding
));
9748 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9749 ? Vsuggest_key_bindings
: make_number (2)),
9754 unbind_to (count
, Qnil
);
9758 RETURN_UNGCPRO (value
);
9762 /* Return nonzero if input events are pending. */
9765 detect_input_pending ()
9768 get_input_pending (&input_pending
, 0);
9770 return input_pending
;
9773 /* Return nonzero if input events are pending, and run any pending timers. */
9776 detect_input_pending_run_timers (do_display
)
9779 int old_timers_run
= timers_run
;
9782 get_input_pending (&input_pending
, 1);
9784 if (old_timers_run
!= timers_run
&& do_display
)
9786 redisplay_preserve_echo_area (8);
9787 /* The following fixes a bug when using lazy-lock with
9788 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9789 from an idle timer function. The symptom of the bug is that
9790 the cursor sometimes doesn't become visible until the next X
9791 event is processed. --gerd. */
9793 rif
->flush_display (NULL
);
9796 return input_pending
;
9799 /* This is called in some cases before a possible quit.
9800 It cases the next call to detect_input_pending to recompute input_pending.
9801 So calling this function unnecessarily can't do any harm. */
9804 clear_input_pending ()
9809 /* Return nonzero if there are pending requeued events.
9810 This isn't used yet. The hope is to make wait_reading_process_input
9811 call it, and return if it runs Lisp code that unreads something.
9812 The problem is, kbd_buffer_get_event needs to be fixed to know what
9813 to do in that case. It isn't trivial. */
9816 requeued_events_pending_p ()
9818 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9822 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9823 doc
: /* Return t if command input is currently available with no wait.
9824 Actually, the value is nil only if we can be sure that no input is available;
9825 if there is a doubt, the value is t. */)
9828 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9831 get_filtered_input_pending (&input_pending
, 1, 1);
9832 return input_pending
> 0 ? Qt
: Qnil
;
9835 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9836 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9839 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9842 if (total_keys
< NUM_RECENT_KEYS
)
9843 return Fvector (total_keys
, keys
);
9846 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9847 bcopy (keys
+ recent_keys_index
,
9848 XVECTOR (val
)->contents
,
9849 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9851 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9852 recent_keys_index
* sizeof (Lisp_Object
));
9857 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9858 doc
: /* Return the key sequence that invoked this command.
9859 However, if the command has called `read-key-sequence', it returns
9860 the last key sequence that has been read.
9861 The value is a string or a vector. */)
9864 return make_event_array (this_command_key_count
,
9865 XVECTOR (this_command_keys
)->contents
);
9868 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9869 doc
: /* Return the key sequence that invoked this command, as a vector.
9870 However, if the command has called `read-key-sequence', it returns
9871 the last key sequence that has been read. */)
9874 return Fvector (this_command_key_count
,
9875 XVECTOR (this_command_keys
)->contents
);
9878 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9879 Sthis_single_command_keys
, 0, 0, 0,
9880 doc
: /* Return the key sequence that invoked this command.
9881 More generally, it returns the last key sequence read, either by
9882 the command loop or by `read-key-sequence'.
9883 Unlike `this-command-keys', this function's value
9884 does not include prefix arguments.
9885 The value is always a vector. */)
9888 return Fvector (this_command_key_count
9889 - this_single_command_key_start
,
9890 (XVECTOR (this_command_keys
)->contents
9891 + this_single_command_key_start
));
9894 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9895 Sthis_single_command_raw_keys
, 0, 0, 0,
9896 doc
: /* Return the raw events that were read for this command.
9897 More generally, it returns the last key sequence read, either by
9898 the command loop or by `read-key-sequence'.
9899 Unlike `this-single-command-keys', this function's value
9900 shows the events before all translations (except for input methods).
9901 The value is always a vector. */)
9904 return Fvector (raw_keybuf_count
,
9905 (XVECTOR (raw_keybuf
)->contents
));
9908 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9909 Sreset_this_command_lengths
, 0, 0, 0,
9910 doc
: /* Make the unread events replace the last command and echo.
9911 Used in `universal-argument-other-key'.
9913 `universal-argument-other-key' rereads the event just typed.
9914 It then gets translated through `function-key-map'.
9915 The translated event has to replace the real events,
9916 both in the value of (this-command-keys) and in echoing.
9917 To achieve this, `universal-argument-other-key' calls
9918 `reset-this-command-lengths', which discards the record of reading
9919 these events the first time. */)
9922 this_command_key_count
= before_command_key_count
;
9923 if (this_command_key_count
< this_single_command_key_start
)
9924 this_single_command_key_start
= this_command_key_count
;
9926 echo_truncate (before_command_echo_length
);
9928 /* Cause whatever we put into unread-command-events
9929 to echo as if it were being freshly read from the keyboard. */
9930 this_command_key_count_reset
= 1;
9935 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9936 Sclear_this_command_keys
, 0, 1, 0,
9937 doc
: /* Clear out the vector that `this-command-keys' returns.
9938 Also clear the record of the last 100 events, unless optional arg
9939 KEEP-RECORD is non-nil. */)
9941 Lisp_Object keep_record
;
9945 this_command_key_count
= 0;
9946 this_command_key_count_reset
= 0;
9948 if (NILP (keep_record
))
9950 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9951 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9953 recent_keys_index
= 0;
9958 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9959 doc
: /* Return the current depth in recursive edits. */)
9963 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9967 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9968 "FOpen dribble file: ",
9969 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9970 If FILE is nil, close any open dribble file. */)
9981 file
= Fexpand_file_name (file
, Qnil
);
9982 dribble
= fopen (SDATA (file
), "w");
9984 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9989 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9990 doc
: /* Discard the contents of the terminal input buffer.
9991 Also end any kbd macro being defined. */)
9994 if (!NILP (current_kboard
->defining_kbd_macro
))
9996 /* Discard the last command from the macro. */
9997 Fcancel_kbd_macro_events ();
10001 update_mode_lines
++;
10003 Vunread_command_events
= Qnil
;
10004 unread_command_char
= -1;
10006 discard_tty_input ();
10008 kbd_fetch_ptr
= kbd_store_ptr
;
10009 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10015 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10016 doc
: /* Stop Emacs and return to superior process. You can resume later.
10017 If `cannot-suspend' is non-nil, or if the system doesn't support job
10018 control, run a subshell instead.
10020 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10021 to be read as terminal input by Emacs's parent, after suspension.
10023 Before suspending, run the normal hook `suspend-hook'.
10024 After resumption run the normal hook `suspend-resume-hook'.
10026 Some operating systems cannot stop the Emacs process and resume it later.
10027 On such systems, Emacs starts a subshell instead of suspending. */)
10029 Lisp_Object stuffstring
;
10031 int count
= SPECPDL_INDEX ();
10032 int old_height
, old_width
;
10034 struct gcpro gcpro1
;
10036 if (!NILP (stuffstring
))
10037 CHECK_STRING (stuffstring
);
10039 /* Run the functions in suspend-hook. */
10040 if (!NILP (Vrun_hooks
))
10041 call1 (Vrun_hooks
, intern ("suspend-hook"));
10043 GCPRO1 (stuffstring
);
10044 get_frame_size (&old_width
, &old_height
);
10045 reset_sys_modes ();
10046 /* sys_suspend can get an error if it tries to fork a subshell
10047 and the system resources aren't available for that. */
10048 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10050 stuff_buffered_input (stuffstring
);
10051 if (cannot_suspend
)
10055 unbind_to (count
, Qnil
);
10057 /* Check if terminal/window size has changed.
10058 Note that this is not useful when we are running directly
10059 with a window system; but suspend should be disabled in that case. */
10060 get_frame_size (&width
, &height
);
10061 if (width
!= old_width
|| height
!= old_height
)
10062 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10064 /* Run suspend-resume-hook. */
10065 if (!NILP (Vrun_hooks
))
10066 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10072 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10073 Then in any case stuff anything Emacs has read ahead and not used. */
10076 stuff_buffered_input (stuffstring
)
10077 Lisp_Object stuffstring
;
10079 /* stuff_char works only in BSD, versions 4.2 and up. */
10082 register unsigned char *p
;
10084 if (STRINGP (stuffstring
))
10086 register int count
;
10088 p
= SDATA (stuffstring
);
10089 count
= SBYTES (stuffstring
);
10090 while (count
-- > 0)
10095 /* Anything we have read ahead, put back for the shell to read. */
10096 /* ?? What should this do when we have multiple keyboards??
10097 Should we ignore anything that was typed in at the "wrong" kboard? */
10098 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10102 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10103 kbd_fetch_ptr
= kbd_buffer
;
10104 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10105 stuff_char (kbd_fetch_ptr
->code
);
10107 kbd_fetch_ptr
->kind
= NO_EVENT
;
10108 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10109 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10110 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10115 #endif /* BSD_SYSTEM and not BSD4_1 */
10119 set_waiting_for_input (time_to_clear
)
10120 EMACS_TIME
*time_to_clear
;
10122 input_available_clear_time
= time_to_clear
;
10124 /* Tell interrupt_signal to throw back to read_char, */
10125 waiting_for_input
= 1;
10127 /* If interrupt_signal was called before and buffered a C-g,
10128 make it run again now, to avoid timing error. */
10129 if (!NILP (Vquit_flag
))
10130 quit_throw_to_read_char ();
10134 clear_waiting_for_input ()
10136 /* Tell interrupt_signal not to throw back to read_char, */
10137 waiting_for_input
= 0;
10138 input_available_clear_time
= 0;
10141 /* This routine is called at interrupt level in response to C-g.
10143 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10144 is called from kbd_buffer_store_event, in handling SIGIO or
10147 If `waiting_for_input' is non zero, then unless `echoing' is
10148 nonzero, immediately throw back to read_char.
10150 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10151 eval to throw, when it gets a chance. If quit-flag is already
10152 non-nil, it stops the job right away. */
10155 interrupt_signal (signalnum
) /* If we don't have an argument, */
10156 int signalnum
; /* some compilers complain in signal calls. */
10159 /* Must preserve main program's value of errno. */
10160 int old_errno
= errno
;
10161 struct frame
*sf
= SELECTED_FRAME ();
10163 #if defined (USG) && !defined (POSIX_SIGNALS)
10164 if (!read_socket_hook
&& NILP (Vwindow_system
))
10166 /* USG systems forget handlers when they are used;
10167 must reestablish each time */
10168 signal (SIGINT
, interrupt_signal
);
10169 signal (SIGQUIT
, interrupt_signal
);
10175 if (!NILP (Vquit_flag
)
10176 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10178 /* If SIGINT isn't blocked, don't let us be interrupted by
10179 another SIGINT, it might be harmful due to non-reentrancy
10180 in I/O functions. */
10181 sigblock (sigmask (SIGINT
));
10184 reset_sys_modes ();
10186 #ifdef SIGTSTP /* Support possible in later USG versions */
10188 * On systems which can suspend the current process and return to the original
10189 * shell, this command causes the user to end up back at the shell.
10190 * The "Auto-save" and "Abort" questions are not asked until
10191 * the user elects to return to emacs, at which point he can save the current
10192 * job and either dump core or continue.
10197 if (sys_suspend () == -1)
10199 printf ("Not running as a subprocess;\n");
10200 printf ("you can continue or abort.\n");
10202 #else /* not VMS */
10203 /* Perhaps should really fork an inferior shell?
10204 But that would not provide any way to get back
10205 to the original shell, ever. */
10206 printf ("No support for stopping a process on this operating system;\n");
10207 printf ("you can continue or abort.\n");
10208 #endif /* not VMS */
10209 #endif /* not SIGTSTP */
10211 /* We must remain inside the screen area when the internal terminal
10212 is used. Note that [Enter] is not echoed by dos. */
10215 /* It doesn't work to autosave while GC is in progress;
10216 the code used for auto-saving doesn't cope with the mark bit. */
10217 if (!gc_in_progress
)
10219 printf ("Auto-save? (y or n) ");
10221 if (((c
= getchar ()) & ~040) == 'Y')
10223 Fdo_auto_save (Qt
, Qnil
);
10225 printf ("\r\nAuto-save done");
10226 #else /* not MSDOS */
10227 printf ("Auto-save done\n");
10228 #endif /* not MSDOS */
10230 while (c
!= '\n') c
= getchar ();
10234 /* During GC, it must be safe to reenable quitting again. */
10235 Vinhibit_quit
= Qnil
;
10238 #endif /* not MSDOS */
10239 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10240 printf ("but will instead do a real quit after garbage collection ends\r\n");
10245 printf ("\r\nAbort? (y or n) ");
10246 #else /* not MSDOS */
10248 printf ("Abort (and enter debugger)? (y or n) ");
10249 #else /* not VMS */
10250 printf ("Abort (and dump core)? (y or n) ");
10251 #endif /* not VMS */
10252 #endif /* not MSDOS */
10254 if (((c
= getchar ()) & ~040) == 'Y')
10256 while (c
!= '\n') c
= getchar ();
10258 printf ("\r\nContinuing...\r\n");
10259 #else /* not MSDOS */
10260 printf ("Continuing...\n");
10261 #endif /* not MSDOS */
10268 /* If executing a function that wants to be interrupted out of
10269 and the user has not deferred quitting by binding `inhibit-quit'
10270 then quit right away. */
10271 if (immediate_quit
&& NILP (Vinhibit_quit
))
10273 struct gl_state_s saved
;
10274 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10276 immediate_quit
= 0;
10279 GCPRO4 (saved
.object
, saved
.global_code
,
10280 saved
.current_syntax_table
, saved
.old_prop
);
10281 Fsignal (Qquit
, Qnil
);
10286 /* Else request quit when it's safe */
10290 if (waiting_for_input
&& !echoing
)
10291 quit_throw_to_read_char ();
10296 /* Handle a C-g by making read_char return C-g. */
10299 quit_throw_to_read_char ()
10302 /* Prevent another signal from doing this before we finish. */
10303 clear_waiting_for_input ();
10306 Vunread_command_events
= Qnil
;
10307 unread_command_char
= -1;
10309 #if 0 /* Currently, sit_for is called from read_char without turning
10310 off polling. And that can call set_waiting_for_input.
10311 It seems to be harmless. */
10312 #ifdef POLL_FOR_INPUT
10313 /* May be > 1 if in recursive minibuffer. */
10314 if (poll_suppress_count
== 0)
10318 if (FRAMEP (internal_last_event_frame
)
10319 && !EQ (internal_last_event_frame
, selected_frame
))
10320 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10323 _longjmp (getcjmp
, 1);
10326 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10327 doc
: /* Set mode of reading keyboard input.
10328 First arg INTERRUPT non-nil means use input interrupts;
10329 nil means use CBREAK mode.
10330 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10331 (no effect except in CBREAK mode).
10332 Third arg META t means accept 8-bit input (for a Meta key).
10333 META nil means ignore the top bit, on the assumption it is parity.
10334 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10335 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10336 See also `current-input-mode'. */)
10337 (interrupt
, flow
, meta
, quit
)
10338 Lisp_Object interrupt
, flow
, meta
, quit
;
10341 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10342 error ("set-input-mode: QUIT must be an ASCII character");
10344 #ifdef POLL_FOR_INPUT
10349 /* this causes startup screen to be restored and messes with the mouse */
10350 reset_sys_modes ();
10354 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10355 if (read_socket_hook
)
10357 /* When using X, don't give the user a real choice,
10358 because we haven't implemented the mechanisms to support it. */
10359 #ifdef NO_SOCK_SIGIO
10360 interrupt_input
= 0;
10361 #else /* not NO_SOCK_SIGIO */
10362 interrupt_input
= 1;
10363 #endif /* NO_SOCK_SIGIO */
10366 interrupt_input
= !NILP (interrupt
);
10367 #else /* not SIGIO */
10368 interrupt_input
= 0;
10369 #endif /* not SIGIO */
10371 /* Our VMS input only works by interrupts, as of now. */
10373 interrupt_input
= 1;
10376 flow_control
= !NILP (flow
);
10379 else if (EQ (meta
, Qt
))
10384 /* Don't let this value be out of range. */
10385 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10391 #ifdef POLL_FOR_INPUT
10392 poll_suppress_count
= 1;
10398 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10399 doc
: /* Return information about the way Emacs currently reads keyboard input.
10400 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10401 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10402 nil, Emacs is using CBREAK mode.
10403 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10404 terminal; this does not apply if Emacs uses interrupt-driven input.
10405 META is t if accepting 8-bit input with 8th bit as Meta flag.
10406 META nil means ignoring the top bit, on the assumption it is parity.
10407 META is neither t nor nil if accepting 8-bit input and using
10408 all 8 bits as the character code.
10409 QUIT is the character Emacs currently uses to quit.
10410 The elements of this list correspond to the arguments of
10411 `set-input-mode'. */)
10414 Lisp_Object val
[4];
10416 val
[0] = interrupt_input
? Qt
: Qnil
;
10417 val
[1] = flow_control
? Qt
: Qnil
;
10418 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10419 XSETFASTINT (val
[3], quit_char
);
10421 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10426 * Set up a new kboard object with reasonable initial values.
10432 kb
->Voverriding_terminal_local_map
= Qnil
;
10433 kb
->Vlast_command
= Qnil
;
10434 kb
->Vreal_last_command
= Qnil
;
10435 kb
->Vprefix_arg
= Qnil
;
10436 kb
->Vlast_prefix_arg
= Qnil
;
10437 kb
->kbd_queue
= Qnil
;
10438 kb
->kbd_queue_has_data
= 0;
10439 kb
->immediate_echo
= 0;
10440 kb
->echo_string
= Qnil
;
10441 kb
->echo_after_prompt
= -1;
10442 kb
->kbd_macro_buffer
= 0;
10443 kb
->kbd_macro_bufsize
= 0;
10444 kb
->defining_kbd_macro
= Qnil
;
10445 kb
->Vlast_kbd_macro
= Qnil
;
10446 kb
->reference_count
= 0;
10447 kb
->Vsystem_key_alist
= Qnil
;
10448 kb
->system_key_syms
= Qnil
;
10449 kb
->Vdefault_minibuffer_frame
= Qnil
;
10453 * Destroy the contents of a kboard object, but not the object itself.
10454 * We use this just before deleting it, or if we're going to initialize
10455 * it a second time.
10461 if (kb
->kbd_macro_buffer
)
10462 xfree (kb
->kbd_macro_buffer
);
10465 #ifdef MULTI_KBOARD
10467 /* Free KB and memory referenced from it. */
10475 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10478 *kbp
= kb
->next_kboard
;
10480 /* Prevent a dangling reference to KB. */
10481 if (kb
== current_kboard
10482 && FRAMEP (selected_frame
)
10483 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10485 current_kboard
= XFRAME (selected_frame
)->kboard
;
10486 if (current_kboard
== kb
)
10494 #endif /* MULTI_KBOARD */
10499 /* This is correct before outermost invocation of the editor loop */
10500 command_loop_level
= -1;
10501 immediate_quit
= 0;
10502 quit_char
= Ctl ('g');
10503 Vunread_command_events
= Qnil
;
10504 unread_command_char
= -1;
10505 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10507 recent_keys_index
= 0;
10508 kbd_fetch_ptr
= kbd_buffer
;
10509 kbd_store_ptr
= kbd_buffer
;
10510 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10512 do_mouse_tracking
= Qnil
;
10516 /* This means that command_loop_1 won't try to select anything the first
10518 internal_last_event_frame
= Qnil
;
10519 Vlast_event_frame
= internal_last_event_frame
;
10521 #ifdef MULTI_KBOARD
10522 current_kboard
= initial_kboard
;
10524 wipe_kboard (current_kboard
);
10525 init_kboard (current_kboard
);
10527 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10529 signal (SIGINT
, interrupt_signal
);
10530 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10531 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10532 SIGQUIT and we can't tell which one it will give us. */
10533 signal (SIGQUIT
, interrupt_signal
);
10534 #endif /* HAVE_TERMIO */
10536 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10538 if (!noninteractive
)
10539 signal (SIGIO
, input_available_signal
);
10542 /* Use interrupt input by default, if it works and noninterrupt input
10543 has deficiencies. */
10545 #ifdef INTERRUPT_INPUT
10546 interrupt_input
= 1;
10548 interrupt_input
= 0;
10551 /* Our VMS input only works by interrupts, as of now. */
10553 interrupt_input
= 1;
10559 if (keyboard_init_hook
)
10560 (*keyboard_init_hook
) ();
10562 #ifdef POLL_FOR_INPUT
10563 poll_suppress_count
= 1;
10568 /* This type's only use is in syms_of_keyboard, to initialize the
10569 event header symbols and put properties on them. */
10570 struct event_head
{
10576 struct event_head head_table
[] = {
10577 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10578 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10579 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10580 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10581 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10582 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10583 {&Qselect_window
, "select-window", &Qselect_window
}
10587 syms_of_keyboard ()
10589 Vpre_help_message
= Qnil
;
10590 staticpro (&Vpre_help_message
);
10592 Vlispy_mouse_stem
= build_string ("mouse");
10593 staticpro (&Vlispy_mouse_stem
);
10596 QCimage
= intern (":image");
10597 staticpro (&QCimage
);
10599 staticpro (&Qhelp_echo
);
10600 Qhelp_echo
= intern ("help-echo");
10602 staticpro (&item_properties
);
10603 item_properties
= Qnil
;
10605 staticpro (&tool_bar_item_properties
);
10606 tool_bar_item_properties
= Qnil
;
10607 staticpro (&tool_bar_items_vector
);
10608 tool_bar_items_vector
= Qnil
;
10610 staticpro (&real_this_command
);
10611 real_this_command
= Qnil
;
10613 Qtimer_event_handler
= intern ("timer-event-handler");
10614 staticpro (&Qtimer_event_handler
);
10616 Qdisabled_command_hook
= intern ("disabled-command-hook");
10617 staticpro (&Qdisabled_command_hook
);
10619 Qself_insert_command
= intern ("self-insert-command");
10620 staticpro (&Qself_insert_command
);
10622 Qforward_char
= intern ("forward-char");
10623 staticpro (&Qforward_char
);
10625 Qbackward_char
= intern ("backward-char");
10626 staticpro (&Qbackward_char
);
10628 Qdisabled
= intern ("disabled");
10629 staticpro (&Qdisabled
);
10631 Qundefined
= intern ("undefined");
10632 staticpro (&Qundefined
);
10634 Qpre_command_hook
= intern ("pre-command-hook");
10635 staticpro (&Qpre_command_hook
);
10637 Qpost_command_hook
= intern ("post-command-hook");
10638 staticpro (&Qpost_command_hook
);
10640 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10641 staticpro (&Qpost_command_idle_hook
);
10643 Qdeferred_action_function
= intern ("deferred-action-function");
10644 staticpro (&Qdeferred_action_function
);
10646 Qcommand_hook_internal
= intern ("command-hook-internal");
10647 staticpro (&Qcommand_hook_internal
);
10649 Qfunction_key
= intern ("function-key");
10650 staticpro (&Qfunction_key
);
10651 Qmouse_click
= intern ("mouse-click");
10652 staticpro (&Qmouse_click
);
10653 #if defined(WINDOWSNT) || defined(MAC_OSX)
10654 Qmouse_wheel
= intern ("mouse-wheel");
10655 staticpro (&Qmouse_wheel
);
10658 Qlanguage_change
= intern ("language-change");
10659 staticpro (&Qlanguage_change
);
10661 Qdrag_n_drop
= intern ("drag-n-drop");
10662 staticpro (&Qdrag_n_drop
);
10664 Qsave_session
= intern ("save-session");
10665 staticpro(&Qsave_session
);
10667 Qusr1_signal
= intern ("usr1-signal");
10668 staticpro (&Qusr1_signal
);
10669 Qusr2_signal
= intern ("usr2-signal");
10670 staticpro (&Qusr2_signal
);
10672 Qmenu_enable
= intern ("menu-enable");
10673 staticpro (&Qmenu_enable
);
10674 Qmenu_alias
= intern ("menu-alias");
10675 staticpro (&Qmenu_alias
);
10676 QCenable
= intern (":enable");
10677 staticpro (&QCenable
);
10678 QCvisible
= intern (":visible");
10679 staticpro (&QCvisible
);
10680 QChelp
= intern (":help");
10681 staticpro (&QChelp
);
10682 QCfilter
= intern (":filter");
10683 staticpro (&QCfilter
);
10684 QCbutton
= intern (":button");
10685 staticpro (&QCbutton
);
10686 QCkeys
= intern (":keys");
10687 staticpro (&QCkeys
);
10688 QCkey_sequence
= intern (":key-sequence");
10689 staticpro (&QCkey_sequence
);
10690 QCtoggle
= intern (":toggle");
10691 staticpro (&QCtoggle
);
10692 QCradio
= intern (":radio");
10693 staticpro (&QCradio
);
10695 Qmode_line
= intern ("mode-line");
10696 staticpro (&Qmode_line
);
10697 Qvertical_line
= intern ("vertical-line");
10698 staticpro (&Qvertical_line
);
10699 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10700 staticpro (&Qvertical_scroll_bar
);
10701 Qmenu_bar
= intern ("menu-bar");
10702 staticpro (&Qmenu_bar
);
10704 Qabove_handle
= intern ("above-handle");
10705 staticpro (&Qabove_handle
);
10706 Qhandle
= intern ("handle");
10707 staticpro (&Qhandle
);
10708 Qbelow_handle
= intern ("below-handle");
10709 staticpro (&Qbelow_handle
);
10710 Qup
= intern ("up");
10712 Qdown
= intern ("down");
10713 staticpro (&Qdown
);
10714 Qtop
= intern ("top");
10716 Qbottom
= intern ("bottom");
10717 staticpro (&Qbottom
);
10718 Qend_scroll
= intern ("end-scroll");
10719 staticpro (&Qend_scroll
);
10720 Qratio
= intern ("ratio");
10721 staticpro (&Qratio
);
10723 Qevent_kind
= intern ("event-kind");
10724 staticpro (&Qevent_kind
);
10725 Qevent_symbol_elements
= intern ("event-symbol-elements");
10726 staticpro (&Qevent_symbol_elements
);
10727 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10728 staticpro (&Qevent_symbol_element_mask
);
10729 Qmodifier_cache
= intern ("modifier-cache");
10730 staticpro (&Qmodifier_cache
);
10732 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10733 staticpro (&Qrecompute_lucid_menubar
);
10734 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10735 staticpro (&Qactivate_menubar_hook
);
10737 Qpolling_period
= intern ("polling-period");
10738 staticpro (&Qpolling_period
);
10740 Qinput_method_function
= intern ("input-method-function");
10741 staticpro (&Qinput_method_function
);
10743 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10744 staticpro (&Qinput_method_exit_on_first_char
);
10745 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10746 staticpro (&Qinput_method_use_echo_area
);
10748 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10749 Fset (Qinput_method_use_echo_area
, Qnil
);
10751 last_point_position_buffer
= Qnil
;
10754 struct event_head
*p
;
10756 for (p
= head_table
;
10757 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10760 *p
->var
= intern (p
->name
);
10761 staticpro (p
->var
);
10762 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10763 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10767 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10768 staticpro (&button_down_location
);
10769 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10770 staticpro (&mouse_syms
);
10774 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10776 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10777 for (i
= 0; i
< len
; i
++)
10778 if (modifier_names
[i
])
10779 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10780 staticpro (&modifier_symbols
);
10783 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10784 staticpro (&recent_keys
);
10786 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10787 staticpro (&this_command_keys
);
10789 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10790 staticpro (&raw_keybuf
);
10792 Qextended_command_history
= intern ("extended-command-history");
10793 Fset (Qextended_command_history
, Qnil
);
10794 staticpro (&Qextended_command_history
);
10796 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10797 staticpro (&kbd_buffer_gcpro
);
10799 accent_key_syms
= Qnil
;
10800 staticpro (&accent_key_syms
);
10802 func_key_syms
= Qnil
;
10803 staticpro (&func_key_syms
);
10805 #if defined(WINDOWSNT) || defined(MAC_OSX)
10806 mouse_wheel_syms
= Qnil
;
10807 staticpro (&mouse_wheel_syms
);
10808 drag_n_drop_syms
= Qnil
;
10809 staticpro (&drag_n_drop_syms
);
10812 unread_switch_frame
= Qnil
;
10813 staticpro (&unread_switch_frame
);
10815 internal_last_event_frame
= Qnil
;
10816 staticpro (&internal_last_event_frame
);
10818 read_key_sequence_cmd
= Qnil
;
10819 staticpro (&read_key_sequence_cmd
);
10821 menu_bar_one_keymap_changed_items
= Qnil
;
10822 staticpro (&menu_bar_one_keymap_changed_items
);
10824 defsubr (&Sevent_convert_list
);
10825 defsubr (&Sread_key_sequence
);
10826 defsubr (&Sread_key_sequence_vector
);
10827 defsubr (&Srecursive_edit
);
10829 defsubr (&Strack_mouse
);
10831 defsubr (&Sinput_pending_p
);
10832 defsubr (&Scommand_execute
);
10833 defsubr (&Srecent_keys
);
10834 defsubr (&Sthis_command_keys
);
10835 defsubr (&Sthis_command_keys_vector
);
10836 defsubr (&Sthis_single_command_keys
);
10837 defsubr (&Sthis_single_command_raw_keys
);
10838 defsubr (&Sreset_this_command_lengths
);
10839 defsubr (&Sclear_this_command_keys
);
10840 defsubr (&Ssuspend_emacs
);
10841 defsubr (&Sabort_recursive_edit
);
10842 defsubr (&Sexit_recursive_edit
);
10843 defsubr (&Srecursion_depth
);
10844 defsubr (&Stop_level
);
10845 defsubr (&Sdiscard_input
);
10846 defsubr (&Sopen_dribble_file
);
10847 defsubr (&Sset_input_mode
);
10848 defsubr (&Scurrent_input_mode
);
10849 defsubr (&Sexecute_extended_command
);
10851 DEFVAR_LISP ("last-command-char", &last_command_char
,
10852 doc
: /* Last input event that was part of a command. */);
10854 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10855 doc
: /* Last input event that was part of a command. */);
10857 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10858 doc
: /* Last input event in a command, except for mouse menu events.
10859 Mouse menus give back keys that don't look like mouse events;
10860 this variable holds the actual mouse event that led to the menu,
10861 so that you can determine whether the command was run by mouse or not. */);
10863 DEFVAR_LISP ("last-input-char", &last_input_char
,
10864 doc
: /* Last input event. */);
10866 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10867 doc
: /* Last input event. */);
10869 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10870 doc
: /* List of events to be read as the command input.
10871 These events are processed first, before actual keyboard input. */);
10872 Vunread_command_events
= Qnil
;
10874 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10875 doc
: /* If not -1, an object to be read as next command input event. */);
10877 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10878 doc
: /* List of events to be processed as input by input methods.
10879 These events are processed after `unread-command-events', but
10880 before actual keyboard input. */);
10881 Vunread_post_input_method_events
= Qnil
;
10883 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10884 doc
: /* List of events to be processed as input by input methods.
10885 These events are processed after `unread-command-events', but
10886 before actual keyboard input. */);
10887 Vunread_input_method_events
= Qnil
;
10889 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10890 doc
: /* Meta-prefix character code.
10891 Meta-foo as command input turns into this character followed by foo. */);
10892 XSETINT (meta_prefix_char
, 033);
10894 DEFVAR_KBOARD ("last-command", Vlast_command
,
10895 doc
: /* The last command executed.
10896 Normally a symbol with a function definition, but can be whatever was found
10897 in the keymap, or whatever the variable `this-command' was set to by that
10900 The value `mode-exit' is special; it means that the previous command
10901 read an event that told it to exit, and it did so and unread that event.
10902 In other words, the present command is the event that made the previous
10905 The value `kill-region' is special; it means that the previous command
10906 was a kill command. */);
10908 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10909 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10911 DEFVAR_LISP ("this-command", &Vthis_command
,
10912 doc
: /* The command now being executed.
10913 The command can set this variable; whatever is put here
10914 will be in `last-command' during the following command. */);
10915 Vthis_command
= Qnil
;
10917 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10918 doc
: /* The command bound to the current key sequence before remapping.
10919 It equals `this-command' if the original command was not remapped through
10920 any of the active keymaps. Otherwise, the value of `this-command' is the
10921 result of looking up the original command in the active keymaps. */);
10922 Vthis_original_command
= Qnil
;
10924 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10925 doc
: /* *Number of input events between auto-saves.
10926 Zero means disable autosaving due to number of characters typed. */);
10927 auto_save_interval
= 300;
10929 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10930 doc
: /* *Number of seconds idle time before auto-save.
10931 Zero or nil means disable auto-saving due to idleness.
10932 After auto-saving due to this many seconds of idle time,
10933 Emacs also does a garbage collection if that seems to be warranted. */);
10934 XSETFASTINT (Vauto_save_timeout
, 30);
10936 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10937 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10938 The value may be integer or floating point. */);
10939 Vecho_keystrokes
= make_number (1);
10941 DEFVAR_INT ("polling-period", &polling_period
,
10942 doc
: /* *Interval between polling for input during Lisp execution.
10943 The reason for polling is to make C-g work to stop a running program.
10944 Polling is needed only when using X windows and SIGIO does not work.
10945 Polling is automatically disabled in all other cases. */);
10946 polling_period
= 2;
10948 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10949 doc
: /* *Maximum time between mouse clicks to make a double-click.
10950 Measured in milliseconds. nil means disable double-click recognition;
10951 t means double-clicks have no time limit and are detected
10952 by position only. */);
10953 Vdouble_click_time
= make_number (500);
10955 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10956 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10957 On window-system frames, value is the number of pixels the mouse may have
10958 moved horizontally or vertically between two clicks to make a double-click.
10959 On non window-system frames, value is interpreted in units of 1/8 characters
10962 This variable is also the threshold for motion of the mouse
10963 to count as a drag. */);
10964 double_click_fuzz
= 3;
10966 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10967 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10968 inhibit_local_menu_bar_menus
= 0;
10970 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10971 doc
: /* Number of complete key sequences read as input so far.
10972 This includes key sequences read from keyboard macros.
10973 The number is effectively the number of interactive command invocations. */);
10974 num_input_keys
= 0;
10976 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10977 doc
: /* Number of input events read from the keyboard so far.
10978 This does not include events generated by keyboard macros. */);
10979 num_nonmacro_input_events
= 0;
10981 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10982 doc
: /* The frame in which the most recently read event occurred.
10983 If the last event came from a keyboard macro, this is set to `macro'. */);
10984 Vlast_event_frame
= Qnil
;
10986 /* This variable is set up in sysdep.c. */
10987 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10988 doc
: /* The ERASE character as set by the user with stty. */);
10990 DEFVAR_LISP ("help-char", &Vhelp_char
,
10991 doc
: /* Character to recognize as meaning Help.
10992 When it is read, do `(eval help-form)', and display result if it's a string.
10993 If the value of `help-form' is nil, this char can be read normally. */);
10994 XSETINT (Vhelp_char
, Ctl ('H'));
10996 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10997 doc
: /* List of input events to recognize as meaning Help.
10998 These work just like the value of `help-char' (see that). */);
10999 Vhelp_event_list
= Qnil
;
11001 DEFVAR_LISP ("help-form", &Vhelp_form
,
11002 doc
: /* Form to execute when character `help-char' is read.
11003 If the form returns a string, that string is displayed.
11004 If `help-form' is nil, the help char is not recognized. */);
11007 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11008 doc
: /* Command to run when `help-char' character follows a prefix key.
11009 This command is used only when there is no actual binding
11010 for that character after that prefix key. */);
11011 Vprefix_help_command
= Qnil
;
11013 DEFVAR_LISP ("top-level", &Vtop_level
,
11014 doc
: /* Form to evaluate when Emacs starts up.
11015 Useful to set before you dump a modified Emacs. */);
11018 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11019 doc
: /* Translate table for keyboard input, or nil.
11020 Each character is looked up in this string and the contents used instead.
11021 The value may be a string, a vector, or a char-table.
11022 If it is a string or vector of length N,
11023 character codes N and up are untranslated.
11024 In a vector or a char-table, an element which is nil means "no translation".
11026 This is applied to the characters supplied to input methods, not their
11027 output. See also `translation-table-for-input'. */);
11028 Vkeyboard_translate_table
= Qnil
;
11030 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11031 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11032 \(Even if the operating system has support for stopping a process.\) */);
11033 cannot_suspend
= 0;
11035 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11036 doc
: /* Non-nil means prompt with menus when appropriate.
11037 This is done when reading from a keymap that has a prompt string,
11038 for elements that have prompt strings.
11039 The menu is displayed on the screen
11040 if X menus were enabled at configuration
11041 time and the previous event was a mouse click prefix key.
11042 Otherwise, menu prompting uses the echo area. */);
11043 menu_prompting
= 1;
11045 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11046 doc
: /* Character to see next line of menu prompt.
11047 Type this character while in a menu prompt to rotate around the lines of it. */);
11048 XSETINT (menu_prompt_more_char
, ' ');
11050 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11051 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11052 Emacs applies the modifiers of the character stored here to each keyboard
11053 character it reads. For example, after evaluating the expression
11054 (setq extra-keyboard-modifiers ?\\C-x)
11055 all input characters will have the control modifier applied to them.
11057 Note that the character ?\\C-@, equivalent to the integer zero, does
11058 not count as a control character; rather, it counts as a character
11059 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11060 cancels any modification. */);
11061 extra_keyboard_modifiers
= 0;
11063 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11064 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11065 The command loop sets this to nil before each command,
11066 and tests the value when the command returns.
11067 Buffer modification stores t in this variable. */);
11068 Vdeactivate_mark
= Qnil
;
11070 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11071 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11072 Vcommand_hook_internal
= Qnil
;
11074 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11075 doc
: /* Normal hook run before each command is executed.
11076 If an unhandled error happens in running this hook,
11077 the hook value is set to nil, since otherwise the error
11078 might happen repeatedly and make Emacs nonfunctional. */);
11079 Vpre_command_hook
= Qnil
;
11081 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11082 doc
: /* Normal hook run after each command is executed.
11083 If an unhandled error happens in running this hook,
11084 the hook value is set to nil, since otherwise the error
11085 might happen repeatedly and make Emacs nonfunctional. */);
11086 Vpost_command_hook
= Qnil
;
11088 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11089 doc
: /* Normal hook run after each command is executed, if idle.
11090 Errors running the hook are caught and ignored. */);
11091 Vpost_command_idle_hook
= Qnil
;
11093 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11094 doc
: /* Delay time before running `post-command-idle-hook'.
11095 This is measured in microseconds. */);
11096 post_command_idle_delay
= 100000;
11099 DEFVAR_LISP ("echo-area-clear-hook", ...,
11100 doc
: /* Normal hook run when clearing the echo area. */);
11102 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11103 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11105 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11106 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11107 Vlucid_menu_bar_dirty_flag
= Qnil
;
11109 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11110 doc
: /* List of menu bar items to move to the end of the menu bar.
11111 The elements of the list are event types that may have menu bar bindings. */);
11112 Vmenu_bar_final_items
= Qnil
;
11114 DEFVAR_KBOARD ("overriding-terminal-local-map",
11115 Voverriding_terminal_local_map
,
11116 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11117 If this variable is non-nil, it is used as a keymap instead of the
11118 buffer's local map, and the minor mode keymaps and text property keymaps.
11119 This variable is intended to let commands such as `universal-argument'
11120 set up a different keymap for reading the next command. */);
11122 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11123 doc
: /* Keymap that overrides all other local keymaps.
11124 If this variable is non-nil, it is used as a keymap instead of the
11125 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11126 Voverriding_local_map
= Qnil
;
11128 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11129 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11130 Otherwise, the menu bar continues to reflect the buffer's local map
11131 and the minor mode maps regardless of `overriding-local-map'. */);
11132 Voverriding_local_map_menu_flag
= Qnil
;
11134 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11135 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11136 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11138 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11139 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11141 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11142 doc
: /* Alist of system-specific X windows key symbols.
11143 Each element should have the form (N . SYMBOL) where N is the
11144 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11145 and SYMBOL is its name. */);
11147 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11148 doc
: /* List of deferred actions to be performed at a later time.
11149 The precise format isn't relevant here; we just check whether it is nil. */);
11150 Vdeferred_action_list
= Qnil
;
11152 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11153 doc
: /* Function to call to handle deferred actions, after each command.
11154 This function is called with no arguments after each command
11155 whenever `deferred-action-list' is non-nil. */);
11156 Vdeferred_action_function
= Qnil
;
11158 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11159 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11160 The value can be a length of time to show the message for.
11161 If the value is non-nil and not a number, we wait 2 seconds. */);
11162 Vsuggest_key_bindings
= Qt
;
11164 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11165 doc
: /* List of active absolute time timers in order of increasing time. */);
11166 Vtimer_list
= Qnil
;
11168 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11169 doc
: /* List of active idle-time timers in order of increasing time. */);
11170 Vtimer_idle_list
= Qnil
;
11172 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11173 doc
: /* If non-nil, the function that implements the current input method.
11174 It's called with one argument, a printing character that was just read.
11175 \(That means a character with code 040...0176.)
11176 Typically this function uses `read-event' to read additional events.
11177 When it does so, it should first bind `input-method-function' to nil
11178 so it will not be called recursively.
11180 The function should return a list of zero or more events
11181 to be used as input. If it wants to put back some events
11182 to be reconsidered, separately, by the input method,
11183 it can add them to the beginning of `unread-command-events'.
11185 The input method function can find in `input-method-previous-method'
11186 the previous echo area message.
11188 The input method function should refer to the variables
11189 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11190 for guidance on what to do. */);
11191 Vinput_method_function
= Qnil
;
11193 DEFVAR_LISP ("input-method-previous-message",
11194 &Vinput_method_previous_message
,
11195 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11196 This variable exists because `read-event' clears the echo area
11197 before running the input method. It is nil if there was no message. */);
11198 Vinput_method_previous_message
= Qnil
;
11200 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11201 doc
: /* If non-nil, the function that implements the display of help.
11202 It's called with one argument, the help string to display. */);
11203 Vshow_help_function
= Qnil
;
11205 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11206 doc
: /* If non-nil, suppress point adjustment after executing a command.
11208 After a command is executed, if point is moved into a region that has
11209 special properties (e.g. composition, display), we adjust point to
11210 the boundary of the region. But, several special commands sets this
11211 variable to non-nil, then we suppress the point adjustment.
11213 This variable is set to nil before reading a command, and is checked
11214 just after executing the command. */);
11215 Vdisable_point_adjustment
= Qnil
;
11217 DEFVAR_LISP ("global-disable-point-adjustment",
11218 &Vglobal_disable_point_adjustment
,
11219 doc
: /* *If non-nil, always suppress point adjustment.
11221 The default value is nil, in which case, point adjustment are
11222 suppressed only after special commands that set
11223 `disable-point-adjustment' (which see) to non-nil. */);
11224 Vglobal_disable_point_adjustment
= Qnil
;
11226 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11227 doc
: /* Non-nil means updating menu bindings is allowed.
11228 A value of nil means menu bindings should not be updated.
11229 Used during Emacs' startup. */);
11230 update_menu_bindings
= 1;
11232 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11233 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11234 If the value is not a number, such messages don't time out. */);
11235 Vminibuffer_message_timeout
= make_number (2);
11239 keys_of_keyboard ()
11241 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11242 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11243 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11244 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11245 initial_define_key (meta_map
, 'x', "execute-extended-command");
11247 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11248 "handle-delete-frame");
11249 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11251 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11253 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11254 "handle-select-window");
11255 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11256 "handle-save-session");