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,03
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
;
551 Lisp_Object Qmouse_wheel
;
554 Lisp_Object Qlanguage_change
;
556 Lisp_Object Qdrag_n_drop
;
557 Lisp_Object Qsave_session
;
559 /* Lisp_Object Qmouse_movement; - also an event header */
561 /* Properties of event headers. */
562 Lisp_Object Qevent_kind
;
563 Lisp_Object Qevent_symbol_elements
;
565 /* menu item parts */
566 Lisp_Object Qmenu_alias
;
567 Lisp_Object Qmenu_enable
;
568 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
569 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
570 extern Lisp_Object Vdefine_key_rebound_commands
;
571 extern Lisp_Object Qmenu_item
;
573 /* An event header symbol HEAD may have a property named
574 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
575 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
576 mask of modifiers applied to it. If present, this is used to help
577 speed up parse_modifiers. */
578 Lisp_Object Qevent_symbol_element_mask
;
580 /* An unmodified event header BASE may have a property named
581 Qmodifier_cache, which is an alist mapping modifier masks onto
582 modified versions of BASE. If present, this helps speed up
584 Lisp_Object Qmodifier_cache
;
586 /* Symbols to use for parts of windows. */
587 Lisp_Object Qmode_line
;
588 Lisp_Object Qvertical_line
;
589 Lisp_Object Qvertical_scroll_bar
;
590 Lisp_Object Qmenu_bar
;
591 extern Lisp_Object Qleft_margin
, Qright_margin
;
593 Lisp_Object
recursive_edit_unwind (), command_loop ();
594 Lisp_Object
Fthis_command_keys ();
595 Lisp_Object Qextended_command_history
;
596 EMACS_TIME
timer_check ();
598 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
600 extern char *x_get_keysym_name ();
602 static void record_menu_key ();
603 static int echo_length ();
605 Lisp_Object Qpolling_period
;
607 /* List of absolute timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_list
;
610 /* List of idle time timers. Appears in order of next scheduled event. */
611 Lisp_Object Vtimer_idle_list
;
613 /* Incremented whenever a timer is run. */
616 extern Lisp_Object Vprint_level
, Vprint_length
;
618 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
620 EMACS_TIME
*input_available_clear_time
;
622 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
623 Default is 1 if INTERRUPT_INPUT is defined. */
626 /* Nonzero while interrupts are temporarily deferred during redisplay. */
627 int interrupts_deferred
;
629 /* Nonzero means use ^S/^Q for flow control. */
632 /* Allow m- file to inhibit use of FIONREAD. */
633 #ifdef BROKEN_FIONREAD
637 /* We are unable to use interrupts if FIONREAD is not available,
638 so flush SIGIO so we won't try. */
645 /* If we support a window system, turn on the code to poll periodically
646 to detect C-g. It isn't actually used when doing interrupt input. */
647 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
648 #define POLL_FOR_INPUT
651 /* After a command is executed, if point is moved into a region that
652 has specific properties (e.g. composition, display), we adjust
653 point to the boundary of the region. But, if a command sets this
654 variable to non-nil, we suppress this point adjustment. This
655 variable is set to nil before reading a command. */
657 Lisp_Object Vdisable_point_adjustment
;
659 /* If non-nil, always disable point adjustment. */
661 Lisp_Object Vglobal_disable_point_adjustment
;
663 /* The time when Emacs started being idle. */
665 static EMACS_TIME timer_idleness_start_time
;
667 /* After Emacs stops being idle, this saves the last value
668 of timer_idleness_start_time from when it was idle. */
670 static EMACS_TIME timer_last_idleness_start_time
;
673 /* Global variable declarations. */
675 /* Function for init_keyboard to call with no args (if nonzero). */
676 void (*keyboard_init_hook
) ();
678 static int read_avail_input
P_ ((int));
679 static void get_input_pending
P_ ((int *, int));
680 static void get_filtered_input_pending
P_ ((int *, int, int));
681 static int readable_events
P_ ((int));
682 static int readable_filtered_events
P_ ((int, int));
683 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
684 Lisp_Object
, int *));
685 static Lisp_Object
read_char_x_menu_prompt ();
686 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
688 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
690 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
691 enum scroll_bar_part
,
692 Lisp_Object
, Lisp_Object
,
695 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
696 Lisp_Object
, char **,
697 Lisp_Object
*, unsigned));
698 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
699 static int parse_solitary_modifier
P_ ((Lisp_Object
));
700 static int parse_solitary_modifier ();
701 static void save_getcjmp
P_ ((jmp_buf));
702 static void save_getcjmp ();
703 static void restore_getcjmp
P_ ((jmp_buf));
704 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
705 static void clear_event
P_ ((struct input_event
*));
706 static void any_kboard_state
P_ ((void));
707 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
709 /* Nonzero means don't try to suspend even if the operating system seems
711 static int cannot_suspend
;
713 /* Install the string STR as the beginning of the string of echoing,
714 so that it serves as a prompt for the next character.
715 Also start echoing. */
721 current_kboard
->echo_string
= str
;
722 current_kboard
->echo_after_prompt
= SCHARS (str
);
726 /* Add C to the echo string, if echoing is going on.
727 C can be a character, which is printed prettily ("M-C-x" and all that
728 jazz), or a symbol, whose name is printed. */
734 if (current_kboard
->immediate_echo
)
736 int size
= KEY_DESCRIPTION_SIZE
+ 100;
737 char *buffer
= (char *) alloca (size
);
739 Lisp_Object echo_string
;
741 echo_string
= current_kboard
->echo_string
;
743 /* If someone has passed us a composite event, use its head symbol. */
748 ptr
= push_key_description (XINT (c
), ptr
, 1);
750 else if (SYMBOLP (c
))
752 Lisp_Object name
= SYMBOL_NAME (c
);
753 int nbytes
= SBYTES (name
);
755 if (size
- (ptr
- buffer
) < nbytes
)
757 int offset
= ptr
- buffer
;
758 size
= max (2 * size
, size
+ nbytes
);
759 buffer
= (char *) alloca (size
);
760 ptr
= buffer
+ offset
;
763 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
764 STRING_MULTIBYTE (name
), 1);
767 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
770 const char *text
= " (Type ? for further options)";
771 int len
= strlen (text
);
773 if (size
- (ptr
- buffer
) < len
)
775 int offset
= ptr
- buffer
;
777 buffer
= (char *) alloca (size
);
778 ptr
= buffer
+ offset
;
781 bcopy (text
, ptr
, len
);
785 /* Replace a dash from echo_dash with a space, otherwise
786 add a space at the end as a separator between keys. */
787 if (STRINGP (echo_string
)
788 && SCHARS (echo_string
) > 1)
790 Lisp_Object last_char
, prev_char
, idx
;
792 idx
= make_number (SCHARS (echo_string
) - 2);
793 prev_char
= Faref (echo_string
, idx
);
795 idx
= make_number (SCHARS (echo_string
) - 1);
796 last_char
= Faref (echo_string
, idx
);
798 /* We test PREV_CHAR to make sure this isn't the echoing
800 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
801 Faset (echo_string
, idx
, make_number (' '));
803 echo_string
= concat2 (echo_string
, build_string (" "));
806 current_kboard
->echo_string
807 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
813 /* Temporarily add a dash to the end of the echo string if it's not
814 empty, so that it serves as a mini-prompt for the very next character. */
819 /* Do nothing if not echoing at all. */
820 if (NILP (current_kboard
->echo_string
))
823 if (!current_kboard
->immediate_echo
824 && SCHARS (current_kboard
->echo_string
) == 0)
827 /* Do nothing if we just printed a prompt. */
828 if (current_kboard
->echo_after_prompt
829 == SCHARS (current_kboard
->echo_string
))
832 /* Put a dash at the end of the buffer temporarily,
833 but make it go away when the next character is added. */
834 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
839 /* Display the current echo string, and begin echoing if not already
845 if (!current_kboard
->immediate_echo
)
848 current_kboard
->immediate_echo
= 1;
850 for (i
= 0; i
< this_command_key_count
; i
++)
854 /* Set before_command_echo_length to the value that would
855 have been saved before the start of this subcommand in
856 command_loop_1, if we had already been echoing then. */
857 if (i
== this_single_command_key_start
)
858 before_command_echo_length
= echo_length ();
860 c
= XVECTOR (this_command_keys
)->contents
[i
];
861 if (! (EVENT_HAS_PARAMETERS (c
)
862 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
866 /* Set before_command_echo_length to the value that would
867 have been saved before the start of this subcommand in
868 command_loop_1, if we had already been echoing then. */
869 if (this_command_key_count
== this_single_command_key_start
)
870 before_command_echo_length
= echo_length ();
872 /* Put a dash at the end to invite the user to type more. */
877 message3_nolog (current_kboard
->echo_string
,
878 SBYTES (current_kboard
->echo_string
),
879 STRING_MULTIBYTE (current_kboard
->echo_string
));
882 /* Record in what buffer we echoed, and from which kboard. */
883 echo_message_buffer
= echo_area_buffer
[0];
884 echo_kboard
= current_kboard
;
886 if (waiting_for_input
&& !NILP (Vquit_flag
))
887 quit_throw_to_read_char ();
890 /* Turn off echoing, for the start of a new command. */
895 current_kboard
->immediate_echo
= 0;
896 current_kboard
->echo_after_prompt
= -1;
897 current_kboard
->echo_string
= Qnil
;
898 ok_to_echo_at_next_pause
= NULL
;
900 echo_message_buffer
= Qnil
;
903 /* Return the length of the current echo string. */
908 return (STRINGP (current_kboard
->echo_string
)
909 ? SCHARS (current_kboard
->echo_string
)
913 /* Truncate the current echo message to its first LEN chars.
914 This and echo_char get used by read_key_sequence when the user
915 switches frames while entering a key sequence. */
918 echo_truncate (nchars
)
921 if (STRINGP (current_kboard
->echo_string
))
922 current_kboard
->echo_string
923 = Fsubstring (current_kboard
->echo_string
,
924 make_number (0), make_number (nchars
));
925 truncate_echo_area (nchars
);
929 /* Functions for manipulating this_command_keys. */
931 add_command_key (key
)
934 #if 0 /* Not needed after we made Freset_this_command_lengths
935 do the job immediately. */
936 /* If reset-this-command-length was called recently, obey it now.
937 See the doc string of that function for an explanation of why. */
938 if (before_command_restore_flag
)
940 this_command_key_count
= before_command_key_count_1
;
941 if (this_command_key_count
< this_single_command_key_start
)
942 this_single_command_key_start
= this_command_key_count
;
943 echo_truncate (before_command_echo_length_1
);
944 before_command_restore_flag
= 0;
948 if (this_command_key_count
>= ASIZE (this_command_keys
))
949 this_command_keys
= larger_vector (this_command_keys
,
950 2 * ASIZE (this_command_keys
),
953 AREF (this_command_keys
, this_command_key_count
) = key
;
954 ++this_command_key_count
;
961 int count
= SPECPDL_INDEX ();
964 if (command_loop_level
> 0)
966 specbind (Qstandard_output
, Qt
);
967 specbind (Qstandard_input
, Qt
);
970 #ifdef HAVE_X_WINDOWS
971 /* The command loop has started an hourglass timer, so we have to
972 cancel it here, otherwise it will fire because the recursive edit
973 can take some time. Do not check for display_hourglass_p here,
974 because it could already be nil. */
978 /* This function may have been called from a debugger called from
979 within redisplay, for instance by Edebugging a function called
980 from fontification-functions. We want to allow redisplay in
981 the debugging session.
983 The recursive edit is left with a `(throw exit ...)'. The `exit'
984 tag is not caught anywhere in redisplay, i.e. when we leave the
985 recursive edit, the original redisplay leading to the recursive
986 edit will be unwound. The outcome should therefore be safe. */
987 specbind (Qinhibit_redisplay
, Qnil
);
990 val
= command_loop ();
992 Fsignal (Qquit
, Qnil
);
993 /* Handle throw from read_minibuf when using minibuffer
994 while it's active but we're in another window. */
996 Fsignal (Qerror
, Fcons (val
, Qnil
));
998 return unbind_to (count
, Qnil
);
1001 /* When an auto-save happens, record the "time", and don't do again soon. */
1006 last_auto_save
= num_nonmacro_input_events
;
1009 /* Make an auto save happen as soon as possible at command level. */
1012 force_auto_save_soon ()
1014 last_auto_save
= - auto_save_interval
- 1;
1016 record_asynch_buffer_change ();
1019 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1020 doc
: /* Invoke the editor command loop recursively.
1021 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1022 that tells this function to return.
1023 Alternately, `(throw 'exit t)' makes this function signal an error.
1024 This function is called by the editor initialization to begin editing. */)
1027 int count
= SPECPDL_INDEX ();
1030 command_loop_level
++;
1031 update_mode_lines
= 1;
1033 if (command_loop_level
1034 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1035 buffer
= Fcurrent_buffer ();
1039 /* If we leave recursive_edit_1 below with a `throw' for instance,
1040 like it is done in the splash screen display, we have to
1041 make sure that we restore single_kboard as command_loop_1
1042 would have done if it were left normally. */
1043 record_unwind_protect (recursive_edit_unwind
,
1044 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1046 recursive_edit_1 ();
1047 return unbind_to (count
, Qnil
);
1051 recursive_edit_unwind (info
)
1054 if (BUFFERP (XCAR (info
)))
1055 Fset_buffer (XCAR (info
));
1057 if (NILP (XCDR (info
)))
1058 any_kboard_state ();
1060 single_kboard_state ();
1062 command_loop_level
--;
1063 update_mode_lines
= 1;
1072 #if 0 /* Theory: if there's anything in Vunread_command_events,
1073 it will right away be read by read_key_sequence,
1074 and then if we do switch KBOARDS, it will go into the side
1075 queue then. So we don't need to do anything special here -- rms. */
1076 if (CONSP (Vunread_command_events
))
1078 current_kboard
->kbd_queue
1079 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1080 current_kboard
->kbd_queue_has_data
= 1;
1082 Vunread_command_events
= Qnil
;
1088 /* Switch to the single-kboard state, making current_kboard
1089 the only KBOARD from which further input is accepted. */
1092 single_kboard_state ()
1099 /* Maintain a stack of kboards, so other parts of Emacs
1100 can switch temporarily to the kboard of a given frame
1101 and then revert to the previous status. */
1106 struct kboard_stack
*next
;
1109 static struct kboard_stack
*kboard_stack
;
1112 push_frame_kboard (f
)
1116 struct kboard_stack
*p
1117 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1119 p
->next
= kboard_stack
;
1120 p
->kboard
= current_kboard
;
1123 current_kboard
= FRAME_KBOARD (f
);
1131 struct kboard_stack
*p
= kboard_stack
;
1132 current_kboard
= p
->kboard
;
1133 kboard_stack
= p
->next
;
1138 /* Handle errors that are not handled at inner levels
1139 by printing an error message and returning to the editor command loop. */
1145 Lisp_Object old_level
, old_length
;
1146 char macroerror
[50];
1148 #ifdef HAVE_X_WINDOWS
1149 if (display_hourglass_p
)
1150 cancel_hourglass ();
1153 if (!NILP (executing_macro
))
1155 if (executing_macro_iterations
== 1)
1156 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1158 sprintf (macroerror
, "After %d kbd macro iterations: ",
1159 executing_macro_iterations
);
1164 Vstandard_output
= Qt
;
1165 Vstandard_input
= Qt
;
1166 Vexecuting_macro
= Qnil
;
1167 executing_macro
= Qnil
;
1168 current_kboard
->Vprefix_arg
= Qnil
;
1169 current_kboard
->Vlast_prefix_arg
= Qnil
;
1172 /* Avoid unquittable loop if data contains a circular list. */
1173 old_level
= Vprint_level
;
1174 old_length
= Vprint_length
;
1175 XSETFASTINT (Vprint_level
, 10);
1176 XSETFASTINT (Vprint_length
, 10);
1177 cmd_error_internal (data
, macroerror
);
1178 Vprint_level
= old_level
;
1179 Vprint_length
= old_length
;
1183 Vinhibit_quit
= Qnil
;
1185 any_kboard_state ();
1188 return make_number (0);
1191 /* Take actions on handling an error. DATA is the data that describes
1194 CONTEXT is a C-string containing ASCII characters only which
1195 describes the context in which the error happened. If we need to
1196 generalize CONTEXT to allow multibyte characters, make it a Lisp
1200 cmd_error_internal (data
, context
)
1205 int kill_emacs_p
= 0;
1206 struct frame
*sf
= SELECTED_FRAME ();
1210 clear_message (1, 0);
1212 /* If the window system or terminal frame hasn't been initialized
1213 yet, or we're not interactive, it's best to dump this message out
1214 to stderr and exit. */
1215 if (!sf
->glyphs_initialized_p
1216 /* This is the case of the frame dumped with Emacs, when we're
1217 running under a window system. */
1218 || (!NILP (Vwindow_system
)
1219 && !inhibit_window_system
1220 && FRAME_TERMCAP_P (sf
))
1223 stream
= Qexternal_debugging_output
;
1229 message_log_maybe_newline ();
1234 /* The immediate context is not interesting for Quits,
1235 since they are asyncronous. */
1236 if (EQ (XCAR (data
), Qquit
))
1237 Vsignaling_function
= Qnil
;
1239 print_error_message (data
, stream
, context
, Vsignaling_function
);
1241 Vsignaling_function
= Qnil
;
1243 /* If the window system or terminal frame hasn't been initialized
1244 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1248 Fkill_emacs (make_number (-1));
1252 Lisp_Object
command_loop_1 ();
1253 Lisp_Object
command_loop_2 ();
1254 Lisp_Object
top_level_1 ();
1256 /* Entry to editor-command-loop.
1257 This level has the catches for exiting/returning to editor command loop.
1258 It returns nil to exit recursive edit, t to abort it. */
1263 if (command_loop_level
> 0 || minibuf_level
> 0)
1266 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1267 executing_macro
= Qnil
;
1273 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1274 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1275 executing_macro
= Qnil
;
1277 /* End of file in -batch run causes exit here. */
1283 /* Here we catch errors in execution of commands within the
1284 editing loop, and reenter the editing loop.
1285 When there is an error, cmd_error runs and returns a non-nil
1286 value to us. A value of nil means that command_loop_1 itself
1287 returned due to end of file (or end of kbd macro). */
1292 register Lisp_Object val
;
1295 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1296 while (!NILP (val
));
1304 return Feval (Vtop_level
);
1310 /* On entry to the outer level, run the startup file */
1311 if (!NILP (Vtop_level
))
1312 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1313 else if (!NILP (Vpurify_flag
))
1314 message ("Bare impure Emacs (standard Lisp code not loaded)");
1316 message ("Bare Emacs (standard Lisp code not loaded)");
1320 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1321 doc
: /* Exit all recursive editing levels. */)
1324 #ifdef HAVE_X_WINDOWS
1325 if (display_hourglass_p
)
1326 cancel_hourglass ();
1328 return Fthrow (Qtop_level
, Qnil
);
1331 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1332 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1335 if (command_loop_level
> 0 || minibuf_level
> 0)
1336 Fthrow (Qexit
, Qnil
);
1338 error ("No recursive edit is in progress");
1342 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1343 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1346 if (command_loop_level
> 0 || minibuf_level
> 0)
1349 error ("No recursive edit is in progress");
1353 /* This is the actual command reading loop,
1354 sans error-handling encapsulation. */
1356 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1358 void safe_run_hooks
P_ ((Lisp_Object
));
1359 static void adjust_point_for_property
P_ ((int, int));
1361 /* Cancel hourglass from protect_unwind.
1363 #ifdef HAVE_X_WINDOWS
1365 cancel_hourglass_unwind (arg
)
1368 cancel_hourglass ();
1378 Lisp_Object keybuf
[30];
1382 struct buffer
*prev_buffer
= NULL
;
1384 int was_locked
= single_kboard
;
1386 int already_adjusted
;
1388 current_kboard
->Vprefix_arg
= Qnil
;
1389 current_kboard
->Vlast_prefix_arg
= Qnil
;
1390 Vdeactivate_mark
= Qnil
;
1391 waiting_for_input
= 0;
1395 this_command_key_count
= 0;
1396 this_command_key_count_reset
= 0;
1397 this_single_command_key_start
= 0;
1399 if (NILP (Vmemory_full
))
1401 /* Make sure this hook runs after commands that get errors and
1402 throw to top level. */
1403 /* Note that the value cell will never directly contain nil
1404 if the symbol is a local variable. */
1405 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1406 safe_run_hooks (Qpost_command_hook
);
1408 /* If displaying a message, resize the echo area window to fit
1409 that message's size exactly. */
1410 if (!NILP (echo_area_buffer
[0]))
1411 resize_echo_area_exactly ();
1413 if (!NILP (Vdeferred_action_list
))
1414 call0 (Vdeferred_action_function
);
1416 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1418 if (NILP (Vunread_command_events
)
1419 && NILP (Vunread_input_method_events
)
1420 && NILP (Vunread_post_input_method_events
)
1421 && NILP (Vexecuting_macro
)
1422 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1423 safe_run_hooks (Qpost_command_idle_hook
);
1427 Vmemory_full
= Qnil
;
1429 /* Do this after running Vpost_command_hook, for consistency. */
1430 current_kboard
->Vlast_command
= Vthis_command
;
1431 current_kboard
->Vreal_last_command
= real_this_command
;
1435 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1438 /* Make sure the current window's buffer is selected. */
1439 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1440 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1442 /* Display any malloc warning that just came out. Use while because
1443 displaying one warning can cause another. */
1445 while (pending_malloc_warning
)
1446 display_malloc_warning ();
1450 Vdeactivate_mark
= Qnil
;
1452 /* If minibuffer on and echo area in use,
1453 wait a short time and redraw minibuffer. */
1456 && !NILP (echo_area_buffer
[0])
1457 && EQ (minibuf_window
, echo_area_window
)
1458 && NUMBERP (Vminibuffer_message_timeout
))
1460 /* Bind inhibit-quit to t so that C-g gets read in
1461 rather than quitting back to the minibuffer. */
1462 int count
= SPECPDL_INDEX ();
1463 specbind (Qinhibit_quit
, Qt
);
1465 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1466 /* Clear the echo area. */
1468 safe_run_hooks (Qecho_area_clear_hook
);
1470 unbind_to (count
, Qnil
);
1472 /* If a C-g came in before, treat it as input now. */
1473 if (!NILP (Vquit_flag
))
1476 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1481 alloca (0); /* Cause a garbage collection now */
1482 /* Since we can free the most stuff here. */
1483 #endif /* C_ALLOCA */
1486 /* Select the frame that the last event came from. Usually,
1487 switch-frame events will take care of this, but if some lisp
1488 code swallows a switch-frame event, we'll fix things up here.
1489 Is this a good idea? */
1490 if (FRAMEP (internal_last_event_frame
)
1491 && !EQ (internal_last_event_frame
, selected_frame
))
1492 Fselect_frame (internal_last_event_frame
, Qnil
);
1494 /* If it has changed current-menubar from previous value,
1495 really recompute the menubar from the value. */
1496 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1497 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1498 call0 (Qrecompute_lucid_menubar
);
1500 before_command_key_count
= this_command_key_count
;
1501 before_command_echo_length
= echo_length ();
1503 Vthis_command
= Qnil
;
1504 real_this_command
= Qnil
;
1506 /* Read next key sequence; i gets its length. */
1507 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1510 /* A filter may have run while we were reading the input. */
1511 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1513 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1514 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1518 /* Now we have read a key sequence of length I,
1519 or else I is 0 and we found end of file. */
1521 if (i
== 0) /* End of file -- happens only in */
1522 return Qnil
; /* a kbd macro, at the end. */
1523 /* -1 means read_key_sequence got a menu that was rejected.
1524 Just loop around and read another command. */
1528 this_command_key_count
= 0;
1529 this_command_key_count_reset
= 0;
1530 this_single_command_key_start
= 0;
1534 last_command_char
= keybuf
[i
- 1];
1536 /* If the previous command tried to force a specific window-start,
1537 forget about that, in case this command moves point far away
1538 from that position. But also throw away beg_unchanged and
1539 end_unchanged information in that case, so that redisplay will
1540 update the whole window properly. */
1541 if (!NILP (XWINDOW (selected_window
)->force_start
))
1544 XWINDOW (selected_window
)->force_start
= Qnil
;
1545 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1546 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1549 cmd
= read_key_sequence_cmd
;
1550 if (!NILP (Vexecuting_macro
))
1552 if (!NILP (Vquit_flag
))
1554 Vexecuting_macro
= Qt
;
1555 QUIT
; /* Make some noise. */
1556 /* Will return since macro now empty. */
1560 /* Do redisplay processing after this command except in special
1561 cases identified below. */
1562 prev_buffer
= current_buffer
;
1563 prev_modiff
= MODIFF
;
1564 last_point_position
= PT
;
1565 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1567 /* By default, we adjust point to a boundary of a region that
1568 has such a property that should be treated intangible
1569 (e.g. composition, display). But, some commands will set
1570 this variable differently. */
1571 Vdisable_point_adjustment
= Qnil
;
1573 /* Process filters and timers may have messed with deactivate-mark.
1574 reset it before we execute the command. */
1575 Vdeactivate_mark
= Qnil
;
1577 /* Remap command through active keymaps */
1578 Vthis_original_command
= cmd
;
1582 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1586 /* Execute the command. */
1588 Vthis_command
= cmd
;
1589 real_this_command
= cmd
;
1590 /* Note that the value cell will never directly contain nil
1591 if the symbol is a local variable. */
1592 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1593 safe_run_hooks (Qpre_command_hook
);
1595 already_adjusted
= 0;
1597 if (NILP (Vthis_command
))
1599 /* nil means key is undefined. */
1601 current_kboard
->defining_kbd_macro
= Qnil
;
1602 update_mode_lines
= 1;
1603 current_kboard
->Vprefix_arg
= Qnil
;
1607 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1609 /* In case we jump to directly_done. */
1610 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1612 /* Recognize some common commands in common situations and
1613 do them directly. */
1614 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1616 struct Lisp_Char_Table
*dp
1617 = window_display_table (XWINDOW (selected_window
));
1618 lose
= FETCH_CHAR (PT_BYTE
);
1620 if (! NILP (Vpost_command_hook
))
1621 /* Put this before calling adjust_point_for_property
1622 so it will only get called once in any case. */
1624 if (current_buffer
== prev_buffer
1625 && last_point_position
!= PT
1626 && NILP (Vdisable_point_adjustment
)
1627 && NILP (Vglobal_disable_point_adjustment
))
1628 adjust_point_for_property (last_point_position
, 0);
1629 already_adjusted
= 1;
1630 if (PT
== last_point_position
+ 1
1632 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1633 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1634 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1635 && (lose
>= 0x20 && lose
< 0x7f)))
1636 : (lose
>= 0x20 && lose
< 0x7f))
1637 /* To extract the case of continuation on
1638 wide-column characters. */
1639 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1640 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1642 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1644 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1646 && !windows_or_buffers_changed
1647 && EQ (current_buffer
->selective_display
, Qnil
)
1648 && !detect_input_pending ()
1649 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1650 && NILP (Vexecuting_macro
))
1651 direct_output_forward_char (1);
1654 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1656 struct Lisp_Char_Table
*dp
1657 = window_display_table (XWINDOW (selected_window
));
1659 lose
= FETCH_CHAR (PT_BYTE
);
1660 if (! NILP (Vpost_command_hook
))
1662 if (current_buffer
== prev_buffer
1663 && last_point_position
!= PT
1664 && NILP (Vdisable_point_adjustment
)
1665 && NILP (Vglobal_disable_point_adjustment
))
1666 adjust_point_for_property (last_point_position
, 0);
1667 already_adjusted
= 1;
1668 if (PT
== last_point_position
- 1
1670 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1671 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1672 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1673 && (lose
>= 0x20 && lose
< 0x7f)))
1674 : (lose
>= 0x20 && lose
< 0x7f))
1675 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1677 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1679 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1681 && !windows_or_buffers_changed
1682 && EQ (current_buffer
->selective_display
, Qnil
)
1683 && !detect_input_pending ()
1684 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1685 && NILP (Vexecuting_macro
))
1686 direct_output_forward_char (-1);
1689 else if (EQ (Vthis_command
, Qself_insert_command
)
1690 /* Try this optimization only on char keystrokes. */
1691 && NATNUMP (last_command_char
)
1692 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1695 = translate_char (Vtranslation_table_for_input
,
1696 XFASTINT (last_command_char
), 0, 0, 0);
1698 if (NILP (Vexecuting_macro
)
1699 && !EQ (minibuf_window
, selected_window
))
1701 if (!nonundocount
|| nonundocount
>= 20)
1709 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1711 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1713 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1715 || MODIFF
<= SAVE_MODIFF
1716 || windows_or_buffers_changed
1717 || !EQ (current_buffer
->selective_display
, Qnil
)
1718 || detect_input_pending ()
1719 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1720 || !NILP (Vexecuting_macro
));
1722 value
= internal_self_insert (c
, 0);
1727 if (! NILP (Vpost_command_hook
))
1728 /* Put this before calling adjust_point_for_property
1729 so it will only get called once in any case. */
1732 /* VALUE == 1 when AFTER-CHANGE functions are
1733 installed which is the case most of the time
1734 because FONT-LOCK installs one. */
1735 if (!lose
&& !value
)
1736 direct_output_for_insert (c
);
1741 /* Here for a command that isn't executed directly */
1744 #ifdef HAVE_X_WINDOWS
1745 int scount
= SPECPDL_INDEX ();
1747 if (display_hourglass_p
1748 && NILP (Vexecuting_macro
))
1750 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1756 if (NILP (current_kboard
->Vprefix_arg
))
1758 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1760 #ifdef HAVE_X_WINDOWS
1761 /* Do not check display_hourglass_p here, because
1762 Fcommand_execute could change it, but we should cancel
1763 hourglass cursor anyway.
1764 But don't cancel the hourglass within a macro
1765 just because a command in the macro finishes. */
1766 if (NILP (Vexecuting_macro
))
1767 unbind_to (scount
, Qnil
);
1772 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1774 /* Note that the value cell will never directly contain nil
1775 if the symbol is a local variable. */
1776 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1777 safe_run_hooks (Qpost_command_hook
);
1779 /* If displaying a message, resize the echo area window to fit
1780 that message's size exactly. */
1781 if (!NILP (echo_area_buffer
[0]))
1782 resize_echo_area_exactly ();
1784 if (!NILP (Vdeferred_action_list
))
1785 safe_run_hooks (Qdeferred_action_function
);
1787 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1789 if (NILP (Vunread_command_events
)
1790 && NILP (Vunread_input_method_events
)
1791 && NILP (Vunread_post_input_method_events
)
1792 && NILP (Vexecuting_macro
)
1793 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1794 safe_run_hooks (Qpost_command_idle_hook
);
1797 /* If there is a prefix argument,
1798 1) We don't want Vlast_command to be ``universal-argument''
1799 (that would be dumb), so don't set Vlast_command,
1800 2) we want to leave echoing on so that the prefix will be
1801 echoed as part of this key sequence, so don't call
1803 3) we want to leave this_command_key_count non-zero, so that
1804 read_char will realize that it is re-reading a character, and
1805 not echo it a second time.
1807 If the command didn't actually create a prefix arg,
1808 but is merely a frame event that is transparent to prefix args,
1809 then the above doesn't apply. */
1810 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1812 current_kboard
->Vlast_command
= Vthis_command
;
1813 current_kboard
->Vreal_last_command
= real_this_command
;
1815 this_command_key_count
= 0;
1816 this_command_key_count_reset
= 0;
1817 this_single_command_key_start
= 0;
1820 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1822 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1824 /* We could also call `deactivate'mark'. */
1825 if (EQ (Vtransient_mark_mode
, Qlambda
))
1826 Vtransient_mark_mode
= Qnil
;
1829 current_buffer
->mark_active
= Qnil
;
1830 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1833 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1834 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1839 if (current_buffer
== prev_buffer
1840 && last_point_position
!= PT
1841 && NILP (Vdisable_point_adjustment
)
1842 && NILP (Vglobal_disable_point_adjustment
)
1843 && !already_adjusted
)
1844 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1846 /* Install chars successfully executed in kbd macro. */
1848 if (!NILP (current_kboard
->defining_kbd_macro
)
1849 && NILP (current_kboard
->Vprefix_arg
))
1850 finalize_kbd_macro_chars ();
1854 any_kboard_state ();
1859 extern Lisp_Object Qcomposition
, Qdisplay
;
1861 /* Adjust point to a boundary of a region that has such a property
1862 that should be treated intangible. For the moment, we check
1863 `composition', `display' and `invisible' properties.
1864 LAST_PT is the last position of point. */
1866 extern Lisp_Object Qafter_string
, Qbefore_string
;
1867 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1870 adjust_point_for_property (last_pt
, modified
)
1875 Lisp_Object val
, overlay
, tmp
;
1876 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1879 /* FIXME: cycling is probably not necessary because these properties
1880 can't be usefully combined anyway. */
1881 while (check_composition
|| check_display
|| check_invisible
)
1883 if (check_composition
1884 && PT
> BEGV
&& PT
< ZV
1885 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1886 && COMPOSITION_VALID_P (beg
, end
, val
)
1887 && beg
< PT
/* && end > PT <- It's always the case. */
1888 && (last_pt
<= beg
|| last_pt
>= end
))
1891 SET_PT (PT
< last_pt
? beg
: end
);
1892 check_display
= check_invisible
= 1;
1894 check_composition
= 0;
1896 && PT
> BEGV
&& PT
< ZV
1897 && !NILP (val
= get_char_property_and_overlay
1898 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1899 && display_prop_intangible_p (val
)
1900 && (!OVERLAYP (overlay
)
1901 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1902 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1903 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1904 && beg
< PT
) /* && end > PT <- It's always the case. */
1907 SET_PT (PT
< last_pt
? beg
: end
);
1908 check_composition
= check_invisible
= 1;
1911 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1913 int inv
, ellipsis
= 0;
1916 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1918 && !NILP (val
= get_char_property_and_overlay
1919 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1920 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1922 ellipsis
= ellipsis
|| inv
> 1
1923 || (OVERLAYP (overlay
)
1924 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1925 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1926 tmp
= Fnext_single_char_property_change
1927 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1928 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1931 && !NILP (val
= get_char_property_and_overlay
1932 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1933 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1935 ellipsis
= ellipsis
|| inv
> 1
1936 || (OVERLAYP (overlay
)
1937 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1938 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1939 tmp
= Fprevious_single_char_property_change
1940 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1941 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1944 /* Move away from the inside area. */
1945 if (beg
< PT
&& end
> PT
)
1947 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1948 /* We haven't moved yet (so we don't need to fear
1949 infinite-looping) and we were outside the range
1950 before (so either end of the range still corresponds
1951 to a move in the right direction): pretend we moved
1952 less than we actually did, so that we still have
1953 more freedom below in choosing which end of the range
1955 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1956 /* We either have moved already or the last point
1957 was already in the range: we don't get to choose
1958 which end of the range we have to go to. */
1959 : (PT
< last_pt
? beg
: end
));
1960 check_composition
= check_display
= 1;
1962 xassert (PT
== beg
|| PT
== end
);
1963 /* Pretend the area doesn't exist if the buffer is not
1965 if (!modified
&& !ellipsis
&& beg
< end
)
1967 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1968 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1969 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1970 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1971 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1972 /* We've already moved as far as we can. Trying to go
1973 to the other end would mean moving backwards and thus
1974 could lead to an infinite loop. */
1976 else if (val
= get_pos_property (make_number (PT
),
1978 TEXT_PROP_MEANS_INVISIBLE (val
)
1979 && (val
= get_pos_property
1980 (make_number (PT
== beg
? end
: beg
),
1982 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1983 (check_composition
= check_display
= 1,
1984 SET_PT (PT
== beg
? end
: beg
));
1987 check_invisible
= 0;
1991 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1994 safe_run_hooks_1 (hook
)
1997 return call1 (Vrun_hooks
, Vinhibit_quit
);
2000 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2003 safe_run_hooks_error (data
)
2006 Lisp_Object args
[3];
2007 args
[0] = build_string ("Error in %s: %s");
2008 args
[1] = Vinhibit_quit
;
2011 return Fset (Vinhibit_quit
, Qnil
);
2014 /* If we get an error while running the hook, cause the hook variable
2015 to be nil. Also inhibit quits, so that C-g won't cause the hook
2016 to mysteriously evaporate. */
2019 safe_run_hooks (hook
)
2022 int count
= SPECPDL_INDEX ();
2023 specbind (Qinhibit_quit
, hook
);
2025 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2027 unbind_to (count
, Qnil
);
2031 /* Number of seconds between polling for input. This is a Lisp
2032 variable that can be bound. */
2034 EMACS_INT polling_period
;
2036 /* Nonzero means polling for input is temporarily suppressed. */
2038 int poll_suppress_count
;
2040 /* Asynchronous timer for polling. */
2042 struct atimer
*poll_timer
;
2045 #ifdef POLL_FOR_INPUT
2047 /* Poll for input, so what we catch a C-g if it comes in. This
2048 function is called from x_make_frame_visible, see comment
2054 if (interrupt_input_blocked
== 0
2055 && !waiting_for_input
)
2056 read_avail_input (0);
2059 /* Timer callback function for poll_timer. TIMER is equal to
2063 poll_for_input (timer
)
2064 struct atimer
*timer
;
2066 if (poll_suppress_count
== 0)
2067 poll_for_input_1 ();
2070 #endif /* POLL_FOR_INPUT */
2072 /* Begin signals to poll for input, if they are appropriate.
2073 This function is called unconditionally from various places. */
2078 #ifdef POLL_FOR_INPUT
2079 if (read_socket_hook
&& !interrupt_input
)
2081 /* Turn alarm handling on unconditionally. It might have
2082 been turned off in process.c. */
2083 turn_on_atimers (1);
2085 /* If poll timer doesn't exist, are we need one with
2086 a different interval, start a new one. */
2087 if (poll_timer
== NULL
2088 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2090 EMACS_TIME interval
;
2093 cancel_atimer (poll_timer
);
2095 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2096 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2097 poll_for_input
, NULL
);
2100 /* Let the timer's callback function poll for input
2101 if this becomes zero. */
2102 --poll_suppress_count
;
2107 /* Nonzero if we are using polling to handle input asynchronously. */
2110 input_polling_used ()
2112 #ifdef POLL_FOR_INPUT
2113 return read_socket_hook
&& !interrupt_input
;
2119 /* Turn off polling. */
2124 #ifdef POLL_FOR_INPUT
2125 if (read_socket_hook
&& !interrupt_input
)
2126 ++poll_suppress_count
;
2130 /* Set the value of poll_suppress_count to COUNT
2131 and start or stop polling accordingly. */
2134 set_poll_suppress_count (count
)
2137 #ifdef POLL_FOR_INPUT
2138 if (count
== 0 && poll_suppress_count
!= 0)
2140 poll_suppress_count
= 1;
2143 else if (count
!= 0 && poll_suppress_count
== 0)
2147 poll_suppress_count
= count
;
2151 /* Bind polling_period to a value at least N.
2152 But don't decrease it. */
2155 bind_polling_period (n
)
2158 #ifdef POLL_FOR_INPUT
2159 int new = polling_period
;
2164 stop_other_atimers (poll_timer
);
2166 specbind (Qpolling_period
, make_number (new));
2167 /* Start a new alarm with the new period. */
2172 /* Apply the control modifier to CHARACTER. */
2178 /* Save the upper bits here. */
2179 int upper
= c
& ~0177;
2183 /* Everything in the columns containing the upper-case letters
2184 denotes a control character. */
2185 if (c
>= 0100 && c
< 0140)
2189 /* Set the shift modifier for a control char
2190 made from a shifted letter. But only for letters! */
2191 if (oc
>= 'A' && oc
<= 'Z')
2192 c
|= shift_modifier
;
2195 /* The lower-case letters denote control characters too. */
2196 else if (c
>= 'a' && c
<= 'z')
2199 /* Include the bits for control and shift
2200 only if the basic ASCII code can't indicate them. */
2204 /* Replace the high bits. */
2205 c
|= (upper
& ~ctrl_modifier
);
2210 /* Display help echo in the echo area.
2212 HELP a string means display that string, HELP nil means clear the
2213 help echo. If HELP is a function, call it with OBJECT and POS as
2214 arguments; the function should return a help string or nil for
2215 none. For all other types of HELP evaluate it to obtain a string.
2217 WINDOW is the window in which the help was generated, if any.
2218 It is nil if not in a window.
2220 If OBJECT is a buffer, POS is the position in the buffer where the
2221 `help-echo' text property was found.
2223 If OBJECT is an overlay, that overlay has a `help-echo' property,
2224 and POS is the position in the overlay's buffer under the mouse.
2226 If OBJECT is a string (an overlay string or a string displayed with
2227 the `display' property). POS is the position in that string under
2230 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2231 echo overwrites a keystroke echo currently displayed in the echo
2234 Note: this function may only be called with HELP nil or a string
2235 from X code running asynchronously. */
2238 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2239 Lisp_Object help
, window
, object
, pos
;
2240 int ok_to_overwrite_keystroke_echo
;
2242 if (!NILP (help
) && !STRINGP (help
))
2244 if (FUNCTIONP (help
))
2246 Lisp_Object args
[4];
2251 help
= safe_call (4, args
);
2254 help
= safe_eval (help
);
2256 if (!STRINGP (help
))
2260 if (STRINGP (help
) || NILP (help
))
2262 if (!NILP (Vshow_help_function
))
2263 call1 (Vshow_help_function
, help
);
2264 else if (/* Don't overwrite minibuffer contents. */
2265 !MINI_WINDOW_P (XWINDOW (selected_window
))
2266 /* Don't overwrite a keystroke echo. */
2267 && (NILP (echo_message_buffer
)
2268 || ok_to_overwrite_keystroke_echo
)
2269 /* Don't overwrite a prompt. */
2270 && !cursor_in_echo_area
)
2274 int count
= SPECPDL_INDEX ();
2276 if (!help_echo_showing_p
)
2277 Vpre_help_message
= current_message ();
2279 specbind (Qmessage_truncate_lines
, Qt
);
2280 message3_nolog (help
, SBYTES (help
),
2281 STRING_MULTIBYTE (help
));
2282 unbind_to (count
, Qnil
);
2284 else if (STRINGP (Vpre_help_message
))
2286 message3_nolog (Vpre_help_message
,
2287 SBYTES (Vpre_help_message
),
2288 STRING_MULTIBYTE (Vpre_help_message
));
2289 Vpre_help_message
= Qnil
;
2295 help_echo_showing_p
= STRINGP (help
);
2301 /* Input of single characters from keyboard */
2303 Lisp_Object
print_help ();
2304 static Lisp_Object
kbd_buffer_get_event ();
2305 static void record_char ();
2308 static jmp_buf wrong_kboard_jmpbuf
;
2311 #define STOP_POLLING \
2312 do { if (! polling_stopped_here) stop_polling (); \
2313 polling_stopped_here = 1; } while (0)
2315 #define RESUME_POLLING \
2316 do { if (polling_stopped_here) start_polling (); \
2317 polling_stopped_here = 0; } while (0)
2319 /* read a character from the keyboard; call the redisplay if needed */
2320 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2321 -1 means do not do redisplay, but do do autosaving.
2324 /* The arguments MAPS and NMAPS are for menu prompting.
2325 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2327 PREV_EVENT is the previous input event, or nil if we are reading
2328 the first event of a key sequence (or not reading a key sequence).
2329 If PREV_EVENT is t, that is a "magic" value that says
2330 not to run input methods, but in other respects to act as if
2331 not reading a key sequence.
2333 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2334 if we used a mouse menu to read the input, or zero otherwise. If
2335 USED_MOUSE_MENU is null, we don't dereference it.
2337 Value is t if we showed a menu and the user rejected it. */
2340 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2344 Lisp_Object prev_event
;
2345 int *used_mouse_menu
;
2347 volatile Lisp_Object c
;
2349 jmp_buf local_getcjmp
;
2351 volatile int key_already_recorded
= 0;
2352 Lisp_Object tem
, save
;
2353 volatile Lisp_Object previous_echo_area_message
;
2354 volatile Lisp_Object also_record
;
2355 volatile int reread
;
2356 struct gcpro gcpro1
, gcpro2
;
2357 EMACS_TIME last_idle_start
;
2358 int polling_stopped_here
= 0;
2362 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2363 before_command_key_count
= this_command_key_count
;
2364 before_command_echo_length
= echo_length ();
2367 previous_echo_area_message
= Qnil
;
2369 GCPRO2 (c
, previous_echo_area_message
);
2374 if (CONSP (Vunread_post_input_method_events
))
2376 c
= XCAR (Vunread_post_input_method_events
);
2377 Vunread_post_input_method_events
2378 = XCDR (Vunread_post_input_method_events
);
2380 /* Undo what read_char_x_menu_prompt did when it unread
2381 additional keys returned by Fx_popup_menu. */
2383 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2391 if (unread_command_char
!= -1)
2393 XSETINT (c
, unread_command_char
);
2394 unread_command_char
= -1;
2400 if (CONSP (Vunread_command_events
))
2402 c
= XCAR (Vunread_command_events
);
2403 Vunread_command_events
= XCDR (Vunread_command_events
);
2405 /* Undo what read_char_x_menu_prompt did when it unread
2406 additional keys returned by Fx_popup_menu. */
2408 && EQ (XCDR (c
), Qdisabled
)
2409 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2412 /* If the queued event is something that used the mouse,
2413 set used_mouse_menu accordingly. */
2415 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2416 *used_mouse_menu
= 1;
2419 goto reread_for_input_method
;
2422 if (CONSP (Vunread_input_method_events
))
2424 c
= XCAR (Vunread_input_method_events
);
2425 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2427 /* Undo what read_char_x_menu_prompt did when it unread
2428 additional keys returned by Fx_popup_menu. */
2430 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2434 goto reread_for_input_method
;
2437 this_command_key_count_reset
= 0;
2439 if (!NILP (Vexecuting_macro
))
2441 /* We set this to Qmacro; since that's not a frame, nobody will
2442 try to switch frames on us, and the selected window will
2445 Since this event came from a macro, it would be misleading to
2446 leave internal_last_event_frame set to wherever the last
2447 real event came from. Normally, a switch-frame event selects
2448 internal_last_event_frame after each command is read, but
2449 events read from a macro should never cause a new frame to be
2451 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2453 /* Exit the macro if we are at the end.
2454 Also, some things replace the macro with t
2455 to force an early exit. */
2456 if (EQ (Vexecuting_macro
, Qt
)
2457 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2463 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2464 if (STRINGP (Vexecuting_macro
)
2465 && (XINT (c
) & 0x80))
2466 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2468 executing_macro_index
++;
2473 if (!NILP (unread_switch_frame
))
2475 c
= unread_switch_frame
;
2476 unread_switch_frame
= Qnil
;
2478 /* This event should make it into this_command_keys, and get echoed
2479 again, so we do not set `reread'. */
2483 /* if redisplay was requested */
2484 if (commandflag
>= 0)
2486 /* If there is pending input, process any events which are not
2487 user-visible, such as X selection_request events. */
2489 || detect_input_pending_run_timers (0))
2490 swallow_events (0); /* may clear input_pending */
2492 /* Redisplay if no pending input. */
2493 while (!input_pending
)
2495 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2496 redisplay_preserve_echo_area (5);
2501 /* Normal case: no input arrived during redisplay. */
2504 /* Input arrived and pre-empted redisplay.
2505 Process any events which are not user-visible. */
2507 /* If that cleared input_pending, try again to redisplay. */
2511 /* Message turns off echoing unless more keystrokes turn it on again.
2513 The code in 20.x for the condition was
2515 1. echo_area_glyphs && *echo_area_glyphs
2516 2. && echo_area_glyphs != current_kboard->echobuf
2517 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2519 (1) means there's a current message displayed
2521 (2) means it's not the message from echoing from the current
2524 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2525 is set to a non-null value. This is done in read_char and it is
2526 set to echo_area_glyphs after a call to echo_char. That means
2527 ok_to_echo_at_next_pause is either null or
2528 current_kboard->echobuf with the appropriate current_kboard at
2531 So, condition (3) means in clear text ok_to_echo_at_next_pause
2532 must be either null, or the current message isn't from echoing at
2533 all, or it's from echoing from a different kboard than the
2536 if (/* There currently is something in the echo area. */
2537 !NILP (echo_area_buffer
[0])
2538 && (/* And it's either not from echoing. */
2539 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2540 /* Or it's an echo from a different kboard. */
2541 || echo_kboard
!= current_kboard
2542 /* Or we explicitly allow overwriting whatever there is. */
2543 || ok_to_echo_at_next_pause
== NULL
))
2548 /* Try reading a character via menu prompting in the minibuf.
2549 Try this before the sit-for, because the sit-for
2550 would do the wrong thing if we are supposed to do
2551 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2552 after a mouse event so don't try a minibuf menu. */
2554 if (nmaps
> 0 && INTERACTIVE
2555 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2556 /* Don't bring up a menu if we already have another event. */
2557 && NILP (Vunread_command_events
)
2558 && unread_command_char
< 0
2559 && !detect_input_pending_run_timers (0))
2561 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2564 key_already_recorded
= 1;
2569 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2570 We will do that below, temporarily for short sections of code,
2571 when appropriate. local_getcjmp must be in effect
2572 around any call to sit_for or kbd_buffer_get_event;
2573 it *must not* be in effect when we call redisplay. */
2575 if (_setjmp (local_getcjmp
))
2577 XSETINT (c
, quit_char
);
2578 internal_last_event_frame
= selected_frame
;
2579 Vlast_event_frame
= internal_last_event_frame
;
2580 /* If we report the quit char as an event,
2581 don't do so more than once. */
2582 if (!NILP (Vinhibit_quit
))
2587 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2588 if (kb
!= current_kboard
)
2590 Lisp_Object link
= kb
->kbd_queue
;
2591 /* We shouldn't get here if we were in single-kboard mode! */
2596 while (CONSP (XCDR (link
)))
2598 if (!NILP (XCDR (link
)))
2602 kb
->kbd_queue
= Fcons (c
, Qnil
);
2604 XSETCDR (link
, Fcons (c
, Qnil
));
2605 kb
->kbd_queue_has_data
= 1;
2606 current_kboard
= kb
;
2607 /* This is going to exit from read_char
2608 so we had better get rid of this frame's stuff. */
2610 longjmp (wrong_kboard_jmpbuf
, 1);
2617 timer_start_idle ();
2619 /* If in middle of key sequence and minibuffer not active,
2620 start echoing if enough time elapses. */
2622 if (minibuf_level
== 0
2623 && !current_kboard
->immediate_echo
2624 && this_command_key_count
> 0
2626 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2627 && NILP (Fzerop (Vecho_keystrokes
))
2628 && (/* No message. */
2629 NILP (echo_area_buffer
[0])
2630 /* Or empty message. */
2631 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2632 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2633 /* Or already echoing from same kboard. */
2634 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2635 /* Or not echoing before and echoing allowed. */
2636 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2640 /* After a mouse event, start echoing right away.
2641 This is because we are probably about to display a menu,
2642 and we don't want to delay before doing so. */
2643 if (EVENT_HAS_PARAMETERS (prev_event
))
2648 double duration
= extract_float (Vecho_keystrokes
);
2649 sec
= (int) duration
;
2650 usec
= (duration
- sec
) * 1000000;
2651 save_getcjmp (save_jump
);
2652 restore_getcjmp (local_getcjmp
);
2653 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2654 restore_getcjmp (save_jump
);
2656 && ! CONSP (Vunread_command_events
))
2661 /* Maybe auto save due to number of keystrokes. */
2663 if (commandflag
!= 0
2664 && auto_save_interval
> 0
2665 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2666 && !detect_input_pending_run_timers (0))
2668 Fdo_auto_save (Qnil
, Qnil
);
2669 /* Hooks can actually change some buffers in auto save. */
2673 /* Try reading using an X menu.
2674 This is never confused with reading using the minibuf
2675 because the recursive call of read_char in read_char_minibuf_menu_prompt
2676 does not pass on any keymaps. */
2678 if (nmaps
> 0 && INTERACTIVE
2679 && !NILP (prev_event
)
2680 && EVENT_HAS_PARAMETERS (prev_event
)
2681 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2682 && !EQ (XCAR (prev_event
), Qtool_bar
)
2683 /* Don't bring up a menu if we already have another event. */
2684 && NILP (Vunread_command_events
)
2685 && unread_command_char
< 0)
2687 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2689 /* Now that we have read an event, Emacs is not idle. */
2695 /* Maybe autosave and/or garbage collect due to idleness. */
2697 if (INTERACTIVE
&& NILP (c
))
2699 int delay_level
, buffer_size
;
2701 /* Slow down auto saves logarithmically in size of current buffer,
2702 and garbage collect while we're at it. */
2703 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2704 last_non_minibuf_size
= Z
- BEG
;
2705 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2707 while (buffer_size
> 64)
2708 delay_level
++, buffer_size
-= buffer_size
>> 2;
2709 if (delay_level
< 4) delay_level
= 4;
2710 /* delay_level is 4 for files under around 50k, 7 at 100k,
2711 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2713 /* Auto save if enough time goes by without input. */
2714 if (commandflag
!= 0
2715 && num_nonmacro_input_events
> last_auto_save
2716 && INTEGERP (Vauto_save_timeout
)
2717 && XINT (Vauto_save_timeout
) > 0)
2721 save_getcjmp (save_jump
);
2722 restore_getcjmp (local_getcjmp
);
2723 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2725 restore_getcjmp (save_jump
);
2728 && ! CONSP (Vunread_command_events
))
2730 Fdo_auto_save (Qnil
, Qnil
);
2732 /* If we have auto-saved and there is still no input
2733 available, garbage collect if there has been enough
2734 consing going on to make it worthwhile. */
2735 if (!detect_input_pending_run_timers (0)
2736 && consing_since_gc
> gc_cons_threshold
/ 2)
2737 Fgarbage_collect ();
2744 /* If this has become non-nil here, it has been set by a timer
2745 or sentinel or filter. */
2746 if (CONSP (Vunread_command_events
))
2748 c
= XCAR (Vunread_command_events
);
2749 Vunread_command_events
= XCDR (Vunread_command_events
);
2752 /* Read something from current KBOARD's side queue, if possible. */
2756 if (current_kboard
->kbd_queue_has_data
)
2758 if (!CONSP (current_kboard
->kbd_queue
))
2760 c
= XCAR (current_kboard
->kbd_queue
);
2761 current_kboard
->kbd_queue
2762 = XCDR (current_kboard
->kbd_queue
);
2763 if (NILP (current_kboard
->kbd_queue
))
2764 current_kboard
->kbd_queue_has_data
= 0;
2765 input_pending
= readable_events (0);
2766 if (EVENT_HAS_PARAMETERS (c
)
2767 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2768 internal_last_event_frame
= XCAR (XCDR (c
));
2769 Vlast_event_frame
= internal_last_event_frame
;
2774 /* If current_kboard's side queue is empty check the other kboards.
2775 If one of them has data that we have not yet seen here,
2776 switch to it and process the data waiting for it.
2778 Note: if the events queued up for another kboard
2779 have already been seen here, and therefore are not a complete command,
2780 the kbd_queue_has_data field is 0, so we skip that kboard here.
2781 That's to avoid an infinite loop switching between kboards here. */
2782 if (NILP (c
) && !single_kboard
)
2785 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2786 if (kb
->kbd_queue_has_data
)
2788 current_kboard
= kb
;
2789 /* This is going to exit from read_char
2790 so we had better get rid of this frame's stuff. */
2792 longjmp (wrong_kboard_jmpbuf
, 1);
2801 /* Finally, we read from the main queue,
2802 and if that gives us something we can't use yet, we put it on the
2803 appropriate side queue and try again. */
2809 /* Actually read a character, waiting if necessary. */
2810 save_getcjmp (save_jump
);
2811 restore_getcjmp (local_getcjmp
);
2812 timer_start_idle ();
2813 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2814 restore_getcjmp (save_jump
);
2817 if (! NILP (c
) && (kb
!= current_kboard
))
2819 Lisp_Object link
= kb
->kbd_queue
;
2822 while (CONSP (XCDR (link
)))
2824 if (!NILP (XCDR (link
)))
2828 kb
->kbd_queue
= Fcons (c
, Qnil
);
2830 XSETCDR (link
, Fcons (c
, Qnil
));
2831 kb
->kbd_queue_has_data
= 1;
2835 current_kboard
= kb
;
2836 /* This is going to exit from read_char
2837 so we had better get rid of this frame's stuff. */
2839 longjmp (wrong_kboard_jmpbuf
, 1);
2844 /* Terminate Emacs in batch mode if at eof. */
2845 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2846 Fkill_emacs (make_number (1));
2850 /* Add in any extra modifiers, where appropriate. */
2851 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2852 || ((extra_keyboard_modifiers
& 0177) < ' '
2853 && (extra_keyboard_modifiers
& 0177) != 0))
2854 XSETINT (c
, make_ctrl_char (XINT (c
)));
2856 /* Transfer any other modifier bits directly from
2857 extra_keyboard_modifiers to c. Ignore the actual character code
2858 in the low 16 bits of extra_keyboard_modifiers. */
2859 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2864 /* Record the last idle start time so that we can reset it
2865 should the next event read be a help-echo. */
2866 last_idle_start
= timer_idleness_start_time
;
2872 if (commandflag
>= 0
2873 && !input_pending
&& !detect_input_pending_run_timers (0))
2881 /* Buffer switch events are only for internal wakeups
2882 so don't show them to the user.
2883 Also, don't record a key if we already did. */
2884 if (BUFFERP (c
) || key_already_recorded
)
2887 /* Process special events within read_char
2888 and loop around to read another event. */
2891 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2896 int was_locked
= single_kboard
;
2898 last_input_char
= c
;
2899 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2901 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2902 /* We stopped being idle for this event; undo that. This
2903 prevents automatic window selection (under
2904 mouse_autoselect_window from acting as a real input event, for
2905 example banishing the mouse under mouse-avoidance-mode. */
2906 timer_idleness_start_time
= last_idle_start
;
2908 /* Resume allowing input from any kboard, if that was true before. */
2910 any_kboard_state ();
2915 /* Handle things that only apply to characters. */
2918 /* If kbd_buffer_get_event gave us an EOF, return that. */
2922 if ((STRINGP (Vkeyboard_translate_table
)
2923 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2924 || (VECTORP (Vkeyboard_translate_table
)
2925 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2926 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2927 && CHAR_VALID_P (XINT (c
), 0)))
2930 d
= Faref (Vkeyboard_translate_table
, c
);
2931 /* nil in keyboard-translate-table means no translation. */
2937 /* If this event is a mouse click in the menu bar,
2938 return just menu-bar for now. Modify the mouse click event
2939 so we won't do this twice, then queue it up. */
2940 if (EVENT_HAS_PARAMETERS (c
)
2942 && CONSP (EVENT_START (c
))
2943 && CONSP (XCDR (EVENT_START (c
))))
2947 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2948 /* Handle menu-bar events:
2949 insert the dummy prefix event `menu-bar'. */
2950 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2952 /* Change menu-bar to (menu-bar) as the event "position". */
2953 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2956 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2961 /* Store these characters into recent_keys, the dribble file if any,
2962 and the keyboard macro being defined, if any. */
2964 if (! NILP (also_record
))
2965 record_char (also_record
);
2967 /* Wipe the echo area.
2968 But first, if we are about to use an input method,
2969 save the echo area contents for it to refer to. */
2971 && ! NILP (Vinput_method_function
)
2972 && (unsigned) XINT (c
) >= ' '
2973 && (unsigned) XINT (c
) != 127
2974 && (unsigned) XINT (c
) < 256)
2976 previous_echo_area_message
= Fcurrent_message ();
2977 Vinput_method_previous_message
= previous_echo_area_message
;
2980 /* Now wipe the echo area, except for help events which do their
2981 own stuff with the echo area. */
2983 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2984 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2986 if (!NILP (echo_area_buffer
[0]))
2987 safe_run_hooks (Qecho_area_clear_hook
);
2988 clear_message (1, 0);
2991 reread_for_input_method
:
2993 /* Pass this to the input method, if appropriate. */
2995 && ! NILP (Vinput_method_function
)
2996 /* Don't run the input method within a key sequence,
2997 after the first event of the key sequence. */
2998 && NILP (prev_event
)
2999 && (unsigned) XINT (c
) >= ' '
3000 && (unsigned) XINT (c
) != 127
3001 && (unsigned) XINT (c
) < 256)
3004 int key_count
, key_count_reset
;
3005 struct gcpro gcpro1
;
3006 int count
= SPECPDL_INDEX ();
3008 /* Save the echo status. */
3009 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3010 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3011 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3014 if (before_command_restore_flag
)
3016 this_command_key_count
= before_command_key_count_1
;
3017 if (this_command_key_count
< this_single_command_key_start
)
3018 this_single_command_key_start
= this_command_key_count
;
3019 echo_truncate (before_command_echo_length_1
);
3020 before_command_restore_flag
= 0;
3024 /* Save the this_command_keys status. */
3025 key_count
= this_command_key_count
;
3026 key_count_reset
= this_command_key_count_reset
;
3029 keys
= Fcopy_sequence (this_command_keys
);
3034 /* Clear out this_command_keys. */
3035 this_command_key_count
= 0;
3036 this_command_key_count_reset
= 0;
3038 /* Now wipe the echo area. */
3039 if (!NILP (echo_area_buffer
[0]))
3040 safe_run_hooks (Qecho_area_clear_hook
);
3041 clear_message (1, 0);
3044 /* If we are not reading a key sequence,
3045 never use the echo area. */
3048 specbind (Qinput_method_use_echo_area
, Qt
);
3051 /* Call the input method. */
3052 tem
= call1 (Vinput_method_function
, c
);
3054 tem
= unbind_to (count
, tem
);
3056 /* Restore the saved echoing state
3057 and this_command_keys state. */
3058 this_command_key_count
= key_count
;
3059 this_command_key_count_reset
= key_count_reset
;
3061 this_command_keys
= keys
;
3064 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3065 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3066 if (saved_immediate_echo
)
3071 /* The input method can return no events. */
3074 /* Bring back the previous message, if any. */
3075 if (! NILP (previous_echo_area_message
))
3076 message_with_string ("%s", previous_echo_area_message
, 0);
3079 /* It returned one event or more. */
3081 Vunread_post_input_method_events
3082 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3087 /* Display help if not echoing. */
3088 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3090 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3091 Lisp_Object help
, object
, position
, window
, tem
;
3093 tem
= Fcdr (XCDR (c
));
3096 window
= Fcar (tem
);
3098 object
= Fcar (tem
);
3100 position
= Fcar (tem
);
3102 show_help_echo (help
, window
, object
, position
, 0);
3104 /* We stopped being idle for this event; undo that. */
3105 timer_idleness_start_time
= last_idle_start
;
3109 if (! reread
|| this_command_key_count
== 0
3110 || this_command_key_count_reset
)
3113 /* Don't echo mouse motion events. */
3114 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3115 && NILP (Fzerop (Vecho_keystrokes
))
3116 && ! (EVENT_HAS_PARAMETERS (c
)
3117 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3120 if (! NILP (also_record
))
3121 echo_char (also_record
);
3122 /* Once we reread a character, echoing can happen
3123 the next time we pause to read a new one. */
3124 ok_to_echo_at_next_pause
= current_kboard
;
3127 /* Record this character as part of the current key. */
3128 add_command_key (c
);
3129 if (! NILP (also_record
))
3130 add_command_key (also_record
);
3133 last_input_char
= c
;
3136 /* Process the help character specially if enabled */
3137 if (!NILP (Vhelp_form
) && help_char_p (c
))
3140 count
= SPECPDL_INDEX ();
3142 record_unwind_protect (Fset_window_configuration
,
3143 Fcurrent_window_configuration (Qnil
));
3145 tem0
= Feval (Vhelp_form
);
3147 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3151 c
= read_char (0, 0, 0, Qnil
, 0);
3152 while (BUFFERP (c
));
3153 /* Remove the help from the frame */
3154 unbind_to (count
, Qnil
);
3157 if (EQ (c
, make_number (040)))
3161 c
= read_char (0, 0, 0, Qnil
, 0);
3162 while (BUFFERP (c
));
3171 /* Record a key that came from a mouse menu.
3172 Record it for echoing, for this-command-keys, and so on. */
3178 /* Wipe the echo area. */
3179 clear_message (1, 0);
3184 before_command_key_count
= this_command_key_count
;
3185 before_command_echo_length
= echo_length ();
3188 /* Don't echo mouse motion events. */
3189 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3190 && NILP (Fzerop (Vecho_keystrokes
)))
3194 /* Once we reread a character, echoing can happen
3195 the next time we pause to read a new one. */
3196 ok_to_echo_at_next_pause
= 0;
3199 /* Record this character as part of the current key. */
3200 add_command_key (c
);
3202 /* Re-reading in the middle of a command */
3203 last_input_char
= c
;
3207 /* Return 1 if should recognize C as "the help character". */
3215 if (EQ (c
, Vhelp_char
))
3217 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3218 if (EQ (c
, XCAR (tail
)))
3223 /* Record the input event C in various ways. */
3231 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3233 /* To avoid filling recent_keys with help-echo and mouse-movement
3234 events, we filter out repeated help-echo events, only store the
3235 first and last in a series of mouse-movement events, and don't
3236 store repeated help-echo events which are only separated by
3237 mouse-movement events. */
3239 Lisp_Object ev1
, ev2
, ev3
;
3242 if ((ix1
= recent_keys_index
- 1) < 0)
3243 ix1
= NUM_RECENT_KEYS
- 1;
3244 ev1
= AREF (recent_keys
, ix1
);
3246 if ((ix2
= ix1
- 1) < 0)
3247 ix2
= NUM_RECENT_KEYS
- 1;
3248 ev2
= AREF (recent_keys
, ix2
);
3250 if ((ix3
= ix2
- 1) < 0)
3251 ix3
= NUM_RECENT_KEYS
- 1;
3252 ev3
= AREF (recent_keys
, ix3
);
3254 if (EQ (XCAR (c
), Qhelp_echo
))
3256 /* Don't record `help-echo' in recent_keys unless it shows some help
3257 message, and a different help than the previously recorded
3259 Lisp_Object help
, last_help
;
3261 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3262 if (!STRINGP (help
))
3264 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3265 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3267 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3268 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3269 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3271 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3272 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3273 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3274 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3277 else if (EQ (XCAR (c
), Qmouse_movement
))
3279 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3280 So additional mouse movement events replace the last element. */
3281 Lisp_Object last_window
, window
;
3283 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3284 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3285 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3286 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3287 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3289 ASET (recent_keys
, ix1
, c
);
3295 store_kbd_macro_char (c
);
3300 ASET (recent_keys
, recent_keys_index
, c
);
3301 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3302 recent_keys_index
= 0;
3304 else if (recorded
< 0)
3306 /* We need to remove one or two events from recent_keys.
3307 To do this, we simply put nil at those events and move the
3308 recent_keys_index backwards over those events. Usually,
3309 users will never see those nil events, as they will be
3310 overwritten by the command keys entered to see recent_keys
3313 while (recorded
++ < 0 && total_keys
> 0)
3315 if (total_keys
< NUM_RECENT_KEYS
)
3317 if (--recent_keys_index
< 0)
3318 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3319 ASET (recent_keys
, recent_keys_index
, Qnil
);
3323 num_nonmacro_input_events
++;
3325 /* Write c to the dribble file. If c is a lispy event, write
3326 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3327 If you, dear reader, have a better idea, you've got the source. :-) */
3332 if (XUINT (c
) < 0x100)
3333 putc (XINT (c
), dribble
);
3335 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3339 Lisp_Object dribblee
;
3341 /* If it's a structured event, take the event header. */
3342 dribblee
= EVENT_HEAD (c
);
3344 if (SYMBOLP (dribblee
))
3346 putc ('<', dribble
);
3347 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3348 SBYTES (SYMBOL_NAME (dribblee
)),
3350 putc ('>', dribble
);
3362 struct buffer
*old
= current_buffer
;
3363 Fprinc (object
, Qnil
);
3364 set_buffer_internal (XBUFFER (Vstandard_output
));
3365 call0 (intern ("help-mode"));
3366 set_buffer_internal (old
);
3370 /* Copy out or in the info on where C-g should throw to.
3371 This is used when running Lisp code from within get_char,
3372 in case get_char is called recursively.
3373 See read_process_output. */
3379 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3383 restore_getcjmp (temp
)
3386 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3391 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3392 of this function. */
3395 tracking_off (old_value
)
3396 Lisp_Object old_value
;
3398 do_mouse_tracking
= old_value
;
3399 if (NILP (old_value
))
3401 /* Redisplay may have been preempted because there was input
3402 available, and it assumes it will be called again after the
3403 input has been processed. If the only input available was
3404 the sort that we have just disabled, then we need to call
3406 if (!readable_events (1))
3408 redisplay_preserve_echo_area (6);
3409 get_input_pending (&input_pending
, 1);
3415 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3416 doc
: /* Evaluate BODY with mouse movement events enabled.
3417 Within a `track-mouse' form, mouse motion generates input events that
3418 you can read with `read-event'.
3419 Normally, mouse motion is ignored.
3420 usage: (track-mouse BODY ...) */)
3424 int count
= SPECPDL_INDEX ();
3427 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3429 do_mouse_tracking
= Qt
;
3431 val
= Fprogn (args
);
3432 return unbind_to (count
, val
);
3435 /* If mouse has moved on some frame, return one of those frames.
3436 Return 0 otherwise. */
3441 Lisp_Object tail
, frame
;
3443 FOR_EACH_FRAME (tail
, frame
)
3445 if (XFRAME (frame
)->mouse_moved
)
3446 return XFRAME (frame
);
3452 #endif /* HAVE_MOUSE */
3454 /* Low level keyboard/mouse input.
3455 kbd_buffer_store_event places events in kbd_buffer, and
3456 kbd_buffer_get_event retrieves them. */
3458 /* Return true iff there are any events in the queue that read-char
3459 would return. If this returns false, a read-char would block. */
3461 readable_filtered_events (do_timers_now
, filter_events
)
3466 timer_check (do_timers_now
);
3468 /* If the buffer contains only FOCUS_IN_EVENT events,
3469 and FILTER_EVENTS is nonzero, report it as empty. */
3470 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3472 int have_live_event
= 1;
3476 struct input_event
*event
;
3478 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3482 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3485 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3487 if (event
== kbd_store_ptr
)
3488 have_live_event
= 0;
3491 if (have_live_event
) return 1;
3495 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3500 if (current_kboard
->kbd_queue_has_data
)
3506 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3507 if (kb
->kbd_queue_has_data
)
3513 /* Return true iff there are any events in the queue that read-char
3514 would return. If this returns false, a read-char would block. */
3516 readable_events (do_timers_now
)
3519 return readable_filtered_events (do_timers_now
, 0);
3522 /* Set this for debugging, to have a way to get out */
3527 event_to_kboard (event
)
3528 struct input_event
*event
;
3531 frame
= event
->frame_or_window
;
3533 frame
= XCAR (frame
);
3534 else if (WINDOWP (frame
))
3535 frame
= WINDOW_FRAME (XWINDOW (frame
));
3537 /* There are still some events that don't set this field.
3538 For now, just ignore the problem.
3539 Also ignore dead frames here. */
3540 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3543 return FRAME_KBOARD (XFRAME (frame
));
3547 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3550 kbd_buffer_store_event (event
)
3551 register struct input_event
*event
;
3553 if (event
->kind
== NO_EVENT
)
3556 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3558 register int c
= event
->code
& 0377;
3560 if (event
->modifiers
& ctrl_modifier
)
3561 c
= make_ctrl_char (c
);
3563 c
|= (event
->modifiers
3564 & (meta_modifier
| alt_modifier
3565 | hyper_modifier
| super_modifier
));
3571 struct input_event
*sp
;
3574 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3575 kb
!= current_kboard
))
3578 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3579 Fcons (make_number (c
), Qnil
));
3580 kb
->kbd_queue_has_data
= 1;
3581 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3583 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3586 if (event_to_kboard (sp
) == kb
)
3588 sp
->kind
= NO_EVENT
;
3589 sp
->frame_or_window
= Qnil
;
3597 /* If this results in a quit_char being returned to Emacs as
3598 input, set Vlast_event_frame properly. If this doesn't
3599 get returned to Emacs as an event, the next event read
3600 will set Vlast_event_frame again, so this is safe to do. */
3604 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3606 focus
= event
->frame_or_window
;
3607 internal_last_event_frame
= focus
;
3608 Vlast_event_frame
= focus
;
3611 last_event_timestamp
= event
->timestamp
;
3612 interrupt_signal (0 /* dummy */);
3616 if (c
&& c
== stop_character
)
3622 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3623 Just ignore the second one. */
3624 else if (event
->kind
== BUFFER_SWITCH_EVENT
3625 && kbd_fetch_ptr
!= kbd_store_ptr
3626 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3629 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3630 kbd_store_ptr
= kbd_buffer
;
3632 /* Don't let the very last slot in the buffer become full,
3633 since that would make the two pointers equal,
3634 and that is indistinguishable from an empty buffer.
3635 Discard the event if it would fill the last slot. */
3636 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3640 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3641 prone to assign individual members for other events, in case
3642 the input_event structure is changed. --2000-07-13, gerd. */
3643 struct input_event
*sp
= kbd_store_ptr
;
3644 sp
->kind
= event
->kind
;
3645 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3647 /* We must not use the ordinary copying code for this case,
3648 since `part' is an enum and copying it might not copy enough
3650 bcopy (event
, (char *) sp
, sizeof (*event
));
3655 sp
->code
= event
->code
;
3656 sp
->part
= event
->part
;
3657 sp
->frame_or_window
= event
->frame_or_window
;
3658 sp
->arg
= event
->arg
;
3659 sp
->modifiers
= event
->modifiers
;
3662 sp
->timestamp
= event
->timestamp
;
3665 *kbd_store_ptr
= *event
;
3668 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3669 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3670 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3676 /* Generate HELP_EVENT input_events in BUFP which has room for
3677 SIZE events. If there's not enough room in BUFP, ignore this
3680 HELP is the help form.
3682 FRAME is the frame on which the help is generated. OBJECT is the
3683 Lisp object where the help was found (a buffer, a string, an
3684 overlay, or nil if neither from a string nor from a buffer. POS is
3685 the position within OBJECT where the help was found.
3687 Value is the number of input_events generated. */
3690 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3691 struct input_event
*bufp
;
3693 Lisp_Object help
, frame
, object
, window
;
3698 bufp
->kind
= HELP_EVENT
;
3699 bufp
->frame_or_window
= frame
;
3701 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3710 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3713 kbd_buffer_store_help_event (frame
, help
)
3714 Lisp_Object frame
, help
;
3716 struct input_event event
;
3718 event
.kind
= HELP_EVENT
;
3719 event
.frame_or_window
= frame
;
3724 kbd_buffer_store_event (&event
);
3728 /* Discard any mouse events in the event buffer by setting them to
3731 discard_mouse_events ()
3733 struct input_event
*sp
;
3734 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3736 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3739 if (sp
->kind
== MOUSE_CLICK_EVENT
3740 || sp
->kind
== WHEEL_EVENT
3742 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3744 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3746 sp
->kind
= NO_EVENT
;
3752 /* Return non-zero if there are any real events waiting in the event
3753 buffer, not counting `NO_EVENT's.
3755 If DISCARD is non-zero, discard NO_EVENT events at the front of
3756 the input queue, possibly leaving the input queue empty if there
3757 are no real input events. */
3760 kbd_buffer_events_waiting (discard
)
3763 struct input_event
*sp
;
3765 for (sp
= kbd_fetch_ptr
;
3766 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3769 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3776 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3780 /* Clear input event EVENT. */
3784 struct input_event
*event
;
3786 int idx
= 2 * (event
- kbd_buffer
);
3787 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3788 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3789 event
->kind
= NO_EVENT
;
3793 /* Read one event from the event buffer, waiting if necessary.
3794 The value is a Lisp object representing the event.
3795 The value is nil for an event that should be ignored,
3796 or that was handled here.
3797 We always read and discard one event. */
3800 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3802 int *used_mouse_menu
;
3811 *kbp
= current_kboard
;
3815 /* Wait until there is input available. */
3818 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3821 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3825 /* If the quit flag is set, then read_char will return
3826 quit_char, so that counts as "available input." */
3827 if (!NILP (Vquit_flag
))
3828 quit_throw_to_read_char ();
3830 /* One way or another, wait until input is available; then, if
3831 interrupt handlers have not read it, read it now. */
3834 wait_for_kbd_input ();
3836 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3840 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3843 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3847 Lisp_Object minus_one
;
3849 XSETINT (minus_one
, -1);
3850 wait_reading_process_input (0, 0, minus_one
, 1);
3852 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3853 /* Pass 1 for EXPECT since we just waited to have input. */
3854 read_avail_input (1);
3856 #endif /* not VMS */
3859 if (CONSP (Vunread_command_events
))
3862 first
= XCAR (Vunread_command_events
);
3863 Vunread_command_events
= XCDR (Vunread_command_events
);
3864 *kbp
= current_kboard
;
3868 /* At this point, we know that there is a readable event available
3869 somewhere. If the event queue is empty, then there must be a
3870 mouse movement enabled and available. */
3871 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3873 struct input_event
*event
;
3875 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3879 last_event_timestamp
= event
->timestamp
;
3882 *kbp
= event_to_kboard (event
);
3884 *kbp
= current_kboard
; /* Better than returning null ptr? */
3886 *kbp
= &the_only_kboard
;
3891 /* These two kinds of events get special handling
3892 and don't actually appear to the command loop.
3893 We return nil for them. */
3894 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3897 struct input_event copy
;
3899 /* Remove it from the buffer before processing it,
3900 since otherwise swallow_events will see it
3901 and process it again. */
3903 kbd_fetch_ptr
= event
+ 1;
3904 input_pending
= readable_events (0);
3905 x_handle_selection_request (©
);
3907 /* We're getting selection request events, but we don't have
3913 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3916 struct input_event copy
;
3918 /* Remove it from the buffer before processing it. */
3920 kbd_fetch_ptr
= event
+ 1;
3921 input_pending
= readable_events (0);
3922 x_handle_selection_clear (©
);
3924 /* We're getting selection request events, but we don't have
3929 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3930 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3932 /* Make an event (delete-frame (FRAME)). */
3933 obj
= Fcons (event
->frame_or_window
, Qnil
);
3934 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3935 kbd_fetch_ptr
= event
+ 1;
3938 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3939 else if (event
->kind
== ICONIFY_EVENT
)
3941 /* Make an event (iconify-frame (FRAME)). */
3942 obj
= Fcons (event
->frame_or_window
, Qnil
);
3943 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3944 kbd_fetch_ptr
= event
+ 1;
3946 else if (event
->kind
== DEICONIFY_EVENT
)
3948 /* Make an event (make-frame-visible (FRAME)). */
3949 obj
= Fcons (event
->frame_or_window
, Qnil
);
3950 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3951 kbd_fetch_ptr
= event
+ 1;
3954 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3956 /* The value doesn't matter here; only the type is tested. */
3957 XSETBUFFER (obj
, current_buffer
);
3958 kbd_fetch_ptr
= event
+ 1;
3960 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3961 || defined (USE_GTK)
3962 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3964 kbd_fetch_ptr
= event
+ 1;
3965 input_pending
= readable_events (0);
3966 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3967 x_activate_menubar (XFRAME (event
->frame_or_window
));
3971 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3973 /* Make an event (language-change (FRAME CHARSET LCID)). */
3974 obj
= Fcons (event
->modifiers
, Qnil
);
3975 obj
= Fcons (event
->code
, obj
);
3976 obj
= Fcons (event
->frame_or_window
, obj
);
3977 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3978 kbd_fetch_ptr
= event
+ 1;
3981 else if (event
->kind
== SAVE_SESSION_EVENT
)
3983 obj
= Fcons (Qsave_session
, Qnil
);
3984 kbd_fetch_ptr
= event
+ 1;
3986 /* Just discard these, by returning nil.
3987 With MULTI_KBOARD, these events are used as placeholders
3988 when we need to randomly delete events from the queue.
3989 (They shouldn't otherwise be found in the buffer,
3990 but on some machines it appears they do show up
3991 even without MULTI_KBOARD.) */
3992 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3993 mouse events during a popup-menu call. */
3994 else if (event
->kind
== NO_EVENT
)
3995 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== HELP_EVENT
)
3998 Lisp_Object object
, position
, help
, frame
, window
;
4000 frame
= event
->frame_or_window
;
4001 object
= event
->arg
;
4002 position
= make_number (event
->code
);
4005 clear_event (event
);
4007 kbd_fetch_ptr
= event
+ 1;
4008 if (!WINDOWP (window
))
4010 obj
= Fcons (Qhelp_echo
,
4011 list5 (frame
, help
, window
, object
, position
));
4013 else if (event
->kind
== FOCUS_IN_EVENT
)
4015 /* Notification of a FocusIn event. The frame receiving the
4016 focus is in event->frame_or_window. Generate a
4017 switch-frame event if necessary. */
4018 Lisp_Object frame
, focus
;
4020 frame
= event
->frame_or_window
;
4021 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4025 if (!EQ (frame
, internal_last_event_frame
)
4026 && !EQ (frame
, selected_frame
))
4027 obj
= make_lispy_switch_frame (frame
);
4028 internal_last_event_frame
= frame
;
4029 kbd_fetch_ptr
= event
+ 1;
4033 /* If this event is on a different frame, return a switch-frame this
4034 time, and leave the event in the queue for next time. */
4038 frame
= event
->frame_or_window
;
4040 frame
= XCAR (frame
);
4041 else if (WINDOWP (frame
))
4042 frame
= WINDOW_FRAME (XWINDOW (frame
));
4044 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4048 if (! EQ (frame
, internal_last_event_frame
)
4049 && !EQ (frame
, selected_frame
))
4050 obj
= make_lispy_switch_frame (frame
);
4051 internal_last_event_frame
= frame
;
4053 /* If we didn't decide to make a switch-frame event, go ahead
4054 and build a real event from the queue entry. */
4058 obj
= make_lispy_event (event
);
4060 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4061 || defined (USE_GTK)
4062 /* If this was a menu selection, then set the flag to inhibit
4063 writing to last_nonmenu_event. Don't do this if the event
4064 we're returning is (menu-bar), though; that indicates the
4065 beginning of the menu sequence, and we might as well leave
4066 that as the `event with parameters' for this selection. */
4068 && !EQ (event
->frame_or_window
, event
->arg
)
4069 && (event
->kind
== MENU_BAR_EVENT
4070 || event
->kind
== TOOL_BAR_EVENT
))
4071 *used_mouse_menu
= 1;
4074 /* Wipe out this event, to catch bugs. */
4075 clear_event (event
);
4076 kbd_fetch_ptr
= event
+ 1;
4081 /* Try generating a mouse motion event. */
4082 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4084 FRAME_PTR f
= some_mouse_moved ();
4085 Lisp_Object bar_window
;
4086 enum scroll_bar_part part
;
4090 *kbp
= current_kboard
;
4091 /* Note that this uses F to determine which display to look at.
4092 If there is no valid info, it does not store anything
4093 so x remains nil. */
4095 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4099 /* Decide if we should generate a switch-frame event. Don't
4100 generate switch-frame events for motion outside of all Emacs
4106 frame
= FRAME_FOCUS_FRAME (f
);
4108 XSETFRAME (frame
, f
);
4110 if (! EQ (frame
, internal_last_event_frame
)
4111 && !EQ (frame
, selected_frame
))
4112 obj
= make_lispy_switch_frame (frame
);
4113 internal_last_event_frame
= frame
;
4116 /* If we didn't decide to make a switch-frame event, go ahead and
4117 return a mouse-motion event. */
4118 if (!NILP (x
) && NILP (obj
))
4119 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4121 #endif /* HAVE_MOUSE */
4123 /* We were promised by the above while loop that there was
4124 something for us to read! */
4127 input_pending
= readable_events (0);
4129 Vlast_event_frame
= internal_last_event_frame
;
4134 /* Process any events that are not user-visible,
4135 then return, without reading any user-visible events. */
4138 swallow_events (do_display
)
4143 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4145 struct input_event
*event
;
4147 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4151 last_event_timestamp
= event
->timestamp
;
4153 /* These two kinds of events get special handling
4154 and don't actually appear to the command loop. */
4155 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4158 struct input_event copy
;
4160 /* Remove it from the buffer before processing it,
4161 since otherwise swallow_events called recursively could see it
4162 and process it again. */
4164 kbd_fetch_ptr
= event
+ 1;
4165 input_pending
= readable_events (0);
4166 x_handle_selection_request (©
);
4168 /* We're getting selection request events, but we don't have
4174 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4177 struct input_event copy
;
4179 /* Remove it from the buffer before processing it, */
4182 kbd_fetch_ptr
= event
+ 1;
4183 input_pending
= readable_events (0);
4184 x_handle_selection_clear (©
);
4186 /* We're getting selection request events, but we don't have
4195 old_timers_run
= timers_run
;
4196 get_input_pending (&input_pending
, 1);
4198 if (timers_run
!= old_timers_run
&& do_display
)
4199 redisplay_preserve_echo_area (7);
4202 /* Record the start of when Emacs is idle,
4203 for the sake of running idle-time timers. */
4210 /* If we are already in the idle state, do nothing. */
4211 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4214 EMACS_GET_TIME (timer_idleness_start_time
);
4216 timer_last_idleness_start_time
= timer_idleness_start_time
;
4218 /* Mark all idle-time timers as once again candidates for running. */
4219 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4223 timer
= XCAR (timers
);
4225 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4227 XVECTOR (timer
)->contents
[0] = Qnil
;
4231 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4236 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4239 /* This is only for debugging. */
4240 struct input_event last_timer_event
;
4242 /* Check whether a timer has fired. To prevent larger problems we simply
4243 disregard elements that are not proper timers. Do not make a circular
4244 timer list for the time being.
4246 Returns the number of seconds to wait until the next timer fires. If a
4247 timer is triggering now, return zero seconds.
4248 If no timer is active, return -1 seconds.
4250 If a timer is ripe, we run it, with quitting turned off.
4252 DO_IT_NOW is now ignored. It used to mean that we should
4253 run the timer directly instead of queueing a timer-event.
4254 Now we always run timers directly. */
4257 timer_check (do_it_now
)
4260 EMACS_TIME nexttime
;
4261 EMACS_TIME now
, idleness_now
;
4262 Lisp_Object timers
, idle_timers
, chosen_timer
;
4263 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4265 EMACS_SET_SECS (nexttime
, -1);
4266 EMACS_SET_USECS (nexttime
, -1);
4268 /* Always consider the ordinary timers. */
4269 timers
= Vtimer_list
;
4270 /* Consider the idle timers only if Emacs is idle. */
4271 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4272 idle_timers
= Vtimer_idle_list
;
4275 chosen_timer
= Qnil
;
4276 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4278 if (CONSP (timers
) || CONSP (idle_timers
))
4280 EMACS_GET_TIME (now
);
4281 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4282 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4285 while (CONSP (timers
) || CONSP (idle_timers
))
4287 Lisp_Object
*vector
;
4288 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4289 EMACS_TIME timer_time
, idle_timer_time
;
4290 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4292 /* Skip past invalid timers and timers already handled. */
4295 timer
= XCAR (timers
);
4296 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4298 timers
= XCDR (timers
);
4301 vector
= XVECTOR (timer
)->contents
;
4303 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4304 || !INTEGERP (vector
[3])
4305 || ! NILP (vector
[0]))
4307 timers
= XCDR (timers
);
4311 if (!NILP (idle_timers
))
4313 timer
= XCAR (idle_timers
);
4314 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4316 idle_timers
= XCDR (idle_timers
);
4319 vector
= XVECTOR (timer
)->contents
;
4321 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4322 || !INTEGERP (vector
[3])
4323 || ! NILP (vector
[0]))
4325 idle_timers
= XCDR (idle_timers
);
4330 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4331 based on the next ordinary timer.
4332 TIMER_DIFFERENCE is the distance in time from NOW to when
4333 this timer becomes ripe (negative if it's already ripe). */
4336 timer
= XCAR (timers
);
4337 vector
= XVECTOR (timer
)->contents
;
4338 EMACS_SET_SECS (timer_time
,
4339 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4340 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4341 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4344 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4345 based on the next idle timer. */
4346 if (!NILP (idle_timers
))
4348 idle_timer
= XCAR (idle_timers
);
4349 vector
= XVECTOR (idle_timer
)->contents
;
4350 EMACS_SET_SECS (idle_timer_time
,
4351 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4352 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4353 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4356 /* Decide which timer is the next timer,
4357 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4358 Also step down the list where we found that timer. */
4360 if (! NILP (timers
) && ! NILP (idle_timers
))
4363 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4364 if (EMACS_TIME_NEG_P (temp
))
4366 chosen_timer
= timer
;
4367 timers
= XCDR (timers
);
4368 difference
= timer_difference
;
4372 chosen_timer
= idle_timer
;
4373 idle_timers
= XCDR (idle_timers
);
4374 difference
= idle_timer_difference
;
4377 else if (! NILP (timers
))
4379 chosen_timer
= timer
;
4380 timers
= XCDR (timers
);
4381 difference
= timer_difference
;
4385 chosen_timer
= idle_timer
;
4386 idle_timers
= XCDR (idle_timers
);
4387 difference
= idle_timer_difference
;
4389 vector
= XVECTOR (chosen_timer
)->contents
;
4391 /* If timer is ripe, run it if it hasn't been run. */
4392 if (EMACS_TIME_NEG_P (difference
)
4393 || (EMACS_SECS (difference
) == 0
4394 && EMACS_USECS (difference
) == 0))
4396 if (NILP (vector
[0]))
4398 int was_locked
= single_kboard
;
4399 int count
= SPECPDL_INDEX ();
4400 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4402 /* Mark the timer as triggered to prevent problems if the lisp
4403 code fails to reschedule it right. */
4406 specbind (Qinhibit_quit
, Qt
);
4408 call1 (Qtimer_event_handler
, chosen_timer
);
4409 Vdeactivate_mark
= old_deactivate_mark
;
4411 unbind_to (count
, Qnil
);
4413 /* Resume allowing input from any kboard, if that was true before. */
4415 any_kboard_state ();
4417 /* Since we have handled the event,
4418 we don't need to tell the caller to wake up and do it. */
4422 /* When we encounter a timer that is still waiting,
4423 return the amount of time to wait before it is ripe. */
4430 /* No timers are pending in the future. */
4431 /* Return 0 if we generated an event, and -1 if not. */
4436 /* Caches for modify_event_symbol. */
4437 static Lisp_Object accent_key_syms
;
4438 static Lisp_Object func_key_syms
;
4439 static Lisp_Object mouse_syms
;
4440 static Lisp_Object wheel_syms
;
4441 #if defined(MAC_OSX)
4442 static Lisp_Object mouse_wheel_syms
;
4444 static Lisp_Object drag_n_drop_syms
;
4446 /* This is a list of keysym codes for special "accent" characters.
4447 It parallels lispy_accent_keys. */
4449 static int lispy_accent_codes
[] =
4451 #ifdef XK_dead_circumflex
4456 #ifdef XK_dead_grave
4461 #ifdef XK_dead_tilde
4466 #ifdef XK_dead_diaeresis
4471 #ifdef XK_dead_macron
4476 #ifdef XK_dead_degree
4481 #ifdef XK_dead_acute
4486 #ifdef XK_dead_cedilla
4491 #ifdef XK_dead_breve
4496 #ifdef XK_dead_ogonek
4501 #ifdef XK_dead_caron
4506 #ifdef XK_dead_doubleacute
4507 XK_dead_doubleacute
,
4511 #ifdef XK_dead_abovedot
4516 #ifdef XK_dead_abovering
4526 #ifdef XK_dead_belowdot
4531 #ifdef XK_dead_voiced_sound
4532 XK_dead_voiced_sound
,
4536 #ifdef XK_dead_semivoiced_sound
4537 XK_dead_semivoiced_sound
,
4553 /* This is a list of Lisp names for special "accent" characters.
4554 It parallels lispy_accent_codes. */
4556 static char *lispy_accent_keys
[] =
4574 "dead-voiced-sound",
4575 "dead-semivoiced-sound",
4581 #define FUNCTION_KEY_OFFSET 0x0
4583 char *lispy_function_keys
[] =
4587 0, /* VK_LBUTTON 0x01 */
4588 0, /* VK_RBUTTON 0x02 */
4589 "cancel", /* VK_CANCEL 0x03 */
4590 0, /* VK_MBUTTON 0x04 */
4592 0, 0, 0, /* 0x05 .. 0x07 */
4594 "backspace", /* VK_BACK 0x08 */
4595 "tab", /* VK_TAB 0x09 */
4597 0, 0, /* 0x0A .. 0x0B */
4599 "clear", /* VK_CLEAR 0x0C */
4600 "return", /* VK_RETURN 0x0D */
4602 0, 0, /* 0x0E .. 0x0F */
4604 0, /* VK_SHIFT 0x10 */
4605 0, /* VK_CONTROL 0x11 */
4606 0, /* VK_MENU 0x12 */
4607 "pause", /* VK_PAUSE 0x13 */
4608 "capslock", /* VK_CAPITAL 0x14 */
4610 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4612 "escape", /* VK_ESCAPE 0x1B */
4614 0, 0, 0, 0, /* 0x1C .. 0x1F */
4616 0, /* VK_SPACE 0x20 */
4617 "prior", /* VK_PRIOR 0x21 */
4618 "next", /* VK_NEXT 0x22 */
4619 "end", /* VK_END 0x23 */
4620 "home", /* VK_HOME 0x24 */
4621 "left", /* VK_LEFT 0x25 */
4622 "up", /* VK_UP 0x26 */
4623 "right", /* VK_RIGHT 0x27 */
4624 "down", /* VK_DOWN 0x28 */
4625 "select", /* VK_SELECT 0x29 */
4626 "print", /* VK_PRINT 0x2A */
4627 "execute", /* VK_EXECUTE 0x2B */
4628 "snapshot", /* VK_SNAPSHOT 0x2C */
4629 "insert", /* VK_INSERT 0x2D */
4630 "delete", /* VK_DELETE 0x2E */
4631 "help", /* VK_HELP 0x2F */
4633 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4635 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4637 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4639 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4641 0, 0, 0, 0, 0, 0, 0, 0, 0,
4642 0, 0, 0, 0, 0, 0, 0, 0, 0,
4643 0, 0, 0, 0, 0, 0, 0, 0,
4645 "lwindow", /* VK_LWIN 0x5B */
4646 "rwindow", /* VK_RWIN 0x5C */
4647 "apps", /* VK_APPS 0x5D */
4649 0, 0, /* 0x5E .. 0x5F */
4651 "kp-0", /* VK_NUMPAD0 0x60 */
4652 "kp-1", /* VK_NUMPAD1 0x61 */
4653 "kp-2", /* VK_NUMPAD2 0x62 */
4654 "kp-3", /* VK_NUMPAD3 0x63 */
4655 "kp-4", /* VK_NUMPAD4 0x64 */
4656 "kp-5", /* VK_NUMPAD5 0x65 */
4657 "kp-6", /* VK_NUMPAD6 0x66 */
4658 "kp-7", /* VK_NUMPAD7 0x67 */
4659 "kp-8", /* VK_NUMPAD8 0x68 */
4660 "kp-9", /* VK_NUMPAD9 0x69 */
4661 "kp-multiply", /* VK_MULTIPLY 0x6A */
4662 "kp-add", /* VK_ADD 0x6B */
4663 "kp-separator", /* VK_SEPARATOR 0x6C */
4664 "kp-subtract", /* VK_SUBTRACT 0x6D */
4665 "kp-decimal", /* VK_DECIMAL 0x6E */
4666 "kp-divide", /* VK_DIVIDE 0x6F */
4667 "f1", /* VK_F1 0x70 */
4668 "f2", /* VK_F2 0x71 */
4669 "f3", /* VK_F3 0x72 */
4670 "f4", /* VK_F4 0x73 */
4671 "f5", /* VK_F5 0x74 */
4672 "f6", /* VK_F6 0x75 */
4673 "f7", /* VK_F7 0x76 */
4674 "f8", /* VK_F8 0x77 */
4675 "f9", /* VK_F9 0x78 */
4676 "f10", /* VK_F10 0x79 */
4677 "f11", /* VK_F11 0x7A */
4678 "f12", /* VK_F12 0x7B */
4679 "f13", /* VK_F13 0x7C */
4680 "f14", /* VK_F14 0x7D */
4681 "f15", /* VK_F15 0x7E */
4682 "f16", /* VK_F16 0x7F */
4683 "f17", /* VK_F17 0x80 */
4684 "f18", /* VK_F18 0x81 */
4685 "f19", /* VK_F19 0x82 */
4686 "f20", /* VK_F20 0x83 */
4687 "f21", /* VK_F21 0x84 */
4688 "f22", /* VK_F22 0x85 */
4689 "f23", /* VK_F23 0x86 */
4690 "f24", /* VK_F24 0x87 */
4692 0, 0, 0, 0, /* 0x88 .. 0x8B */
4693 0, 0, 0, 0, /* 0x8C .. 0x8F */
4695 "kp-numlock", /* VK_NUMLOCK 0x90 */
4696 "scroll", /* VK_SCROLL 0x91 */
4698 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4699 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4700 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4701 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4702 "kp-end", /* VK_NUMPAD_END 0x96 */
4703 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4704 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4705 "kp-up", /* VK_NUMPAD_UP 0x99 */
4706 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4707 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4708 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4709 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4711 0, 0, /* 0x9E .. 0x9F */
4714 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4715 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4716 * No other API or message will distinguish left and right keys this way.
4720 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4721 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4722 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4723 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4724 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4730 "attn", /* VK_ATTN 0xF6 */
4731 "crsel", /* VK_CRSEL 0xF7 */
4732 "exsel", /* VK_EXSEL 0xF8 */
4733 "ereof", /* VK_EREOF 0xF9 */
4734 "play", /* VK_PLAY 0xFA */
4735 "zoom", /* VK_ZOOM 0xFB */
4736 "noname", /* VK_NONAME 0xFC */
4737 "pa1", /* VK_PA1 0xFD */
4738 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4742 #else /* not HAVE_NTGUI */
4744 /* This should be dealt with in XTread_socket now, and that doesn't
4745 depend on the client system having the Kana syms defined. See also
4746 the XK_kana_A case below. */
4749 static char *lispy_kana_keys
[] =
4751 /* X Keysym value */
4752 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4753 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4754 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4755 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4756 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4757 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4758 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4759 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4760 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4761 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4762 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4763 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4764 "kana-i", "kana-u", "kana-e", "kana-o",
4765 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4766 "prolongedsound", "kana-A", "kana-I", "kana-U",
4767 "kana-E", "kana-O", "kana-KA", "kana-KI",
4768 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4769 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4770 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4771 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4772 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4773 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4774 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4775 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4776 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4777 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4778 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4779 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4781 #endif /* XK_kana_A */
4784 #define FUNCTION_KEY_OFFSET 0xff00
4786 /* You'll notice that this table is arranged to be conveniently
4787 indexed by X Windows keysym values. */
4788 static char *lispy_function_keys
[] =
4790 /* X Keysym value */
4792 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4793 "backspace", "tab", "linefeed", "clear",
4795 0, 0, 0, "pause", /* 0xff10...1f */
4796 0, 0, 0, 0, 0, 0, 0, "escape",
4798 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4799 "romaji", "hiragana", "katakana", "hiragana-katakana",
4800 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4801 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4802 "eisu-toggle", /* 0xff30...3f */
4803 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4804 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4806 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4807 "down", "prior", "next", "end",
4808 "begin", 0, 0, 0, 0, 0, 0, 0,
4809 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4820 "break", /* 0xff6b */
4823 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4824 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4825 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4826 0, 0, 0, 0, 0, 0, 0, 0,
4827 "kp-tab", /* 0xff89 */
4829 "kp-enter", /* 0xff8d */
4831 "kp-f1", /* 0xff91 */
4835 "kp-home", /* 0xff95 */
4840 "kp-prior", /* kp-page-up */
4841 "kp-next", /* kp-page-down */
4847 0, 0, 0, 0, 0, 0, 0, 0, 0,
4848 "kp-multiply", /* 0xffaa */
4853 "kp-divide", /* 0xffaf */
4854 "kp-0", /* 0xffb0 */
4855 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4858 "kp-equal", /* 0xffbd */
4859 "f1", /* 0xffbe */ /* IsFunctionKey */
4861 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4862 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4863 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4864 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4865 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4866 0, 0, 0, 0, 0, 0, 0, 0,
4867 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4868 0, 0, 0, 0, 0, 0, 0, "delete"
4871 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4872 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4874 static char *iso_lispy_function_keys
[] =
4876 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4877 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4878 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4879 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4880 "iso-lefttab", /* 0xfe20 */
4881 "iso-move-line-up", "iso-move-line-down",
4882 "iso-partial-line-up", "iso-partial-line-down",
4883 "iso-partial-space-left", "iso-partial-space-right",
4884 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4885 "iso-release-margin-left", "iso-release-margin-right",
4886 "iso-release-both-margins",
4887 "iso-fast-cursor-left", "iso-fast-cursor-right",
4888 "iso-fast-cursor-up", "iso-fast-cursor-down",
4889 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4890 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4893 #endif /* not HAVE_NTGUI */
4895 Lisp_Object Vlispy_mouse_stem
;
4897 static char *lispy_wheel_names
[] =
4899 "wheel-up", "wheel-down"
4902 #if defined(MAC_OSX)
4903 /* mouse-wheel events are generated by the wheel on devices such as
4904 the MS Intellimouse. The wheel sits in between the left and right
4905 mouse buttons, and is typically used to scroll or zoom the window
4906 underneath the pointer. mouse-wheel events specify the object on
4907 which they operate, and a delta corresponding to the amount and
4908 direction that the wheel is rotated. Clicking the mouse-wheel
4909 generates a mouse-2 event. */
4910 static char *lispy_mouse_wheel_names
[] =
4915 #endif /* MAC_OSX */
4917 /* drag-n-drop events are generated when a set of selected files are
4918 dragged from another application and dropped onto an Emacs window. */
4919 static char *lispy_drag_n_drop_names
[] =
4924 /* Scroll bar parts. */
4925 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4926 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4927 Lisp_Object Qtop
, Qratio
;
4929 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4930 Lisp_Object
*scroll_bar_parts
[] = {
4931 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4932 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4935 /* User signal events. */
4936 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4938 Lisp_Object
*lispy_user_signals
[] =
4940 &Qusr1_signal
, &Qusr2_signal
4944 /* A vector, indexed by button number, giving the down-going location
4945 of currently depressed buttons, both scroll bar and non-scroll bar.
4947 The elements have the form
4948 (BUTTON-NUMBER MODIFIER-MASK . REST)
4949 where REST is the cdr of a position as it would be reported in the event.
4951 The make_lispy_event function stores positions here to tell the
4952 difference between click and drag events, and to store the starting
4953 location to be included in drag events. */
4955 static Lisp_Object button_down_location
;
4957 /* Information about the most recent up-going button event: Which
4958 button, what location, and what time. */
4960 static int last_mouse_button
;
4961 static int last_mouse_x
;
4962 static int last_mouse_y
;
4963 static unsigned long button_down_time
;
4965 /* The maximum time between clicks to make a double-click, or Qnil to
4966 disable double-click detection, or Qt for no time limit. */
4968 Lisp_Object Vdouble_click_time
;
4970 /* Maximum number of pixels the mouse may be moved between clicks
4971 to make a double-click. */
4973 EMACS_INT double_click_fuzz
;
4975 /* The number of clicks in this multiple-click. */
4977 int double_click_count
;
4979 /* Given a struct input_event, build the lisp event which represents
4980 it. If EVENT is 0, build a mouse movement event from the mouse
4981 movement buffer, which should have a movement event in it.
4983 Note that events must be passed to this function in the order they
4984 are received; this function stores the location of button presses
4985 in order to build drag events when the button is released. */
4988 make_lispy_event (event
)
4989 struct input_event
*event
;
4993 switch (SWITCH_ENUM_CAST (event
->kind
))
4995 /* A simple keystroke. */
4996 case ASCII_KEYSTROKE_EVENT
:
4998 Lisp_Object lispy_c
;
4999 int c
= event
->code
& 0377;
5000 /* Turn ASCII characters into control characters
5002 if (event
->modifiers
& ctrl_modifier
)
5003 c
= make_ctrl_char (c
);
5005 /* Add in the other modifier bits. We took care of ctrl_modifier
5006 just above, and the shift key was taken care of by the X code,
5007 and applied to control characters by make_ctrl_char. */
5008 c
|= (event
->modifiers
5009 & (meta_modifier
| alt_modifier
5010 | hyper_modifier
| super_modifier
));
5011 /* Distinguish Shift-SPC from SPC. */
5012 if ((event
->code
& 0377) == 040
5013 && event
->modifiers
& shift_modifier
)
5014 c
|= shift_modifier
;
5015 button_down_time
= 0;
5016 XSETFASTINT (lispy_c
, c
);
5020 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5022 Lisp_Object lispy_c
;
5023 int c
= event
->code
;
5025 /* Add in the other modifier bits. We took care of ctrl_modifier
5026 just above, and the shift key was taken care of by the X code,
5027 and applied to control characters by make_ctrl_char. */
5028 c
|= (event
->modifiers
5029 & (meta_modifier
| alt_modifier
5030 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5031 /* What about the `shift' modifier ? */
5032 button_down_time
= 0;
5033 XSETFASTINT (lispy_c
, c
);
5037 /* A function key. The symbol may need to have modifier prefixes
5039 case NON_ASCII_KEYSTROKE_EVENT
:
5040 button_down_time
= 0;
5042 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5043 if (event
->code
== lispy_accent_codes
[i
])
5044 return modify_event_symbol (i
,
5046 Qfunction_key
, Qnil
,
5047 lispy_accent_keys
, &accent_key_syms
,
5048 (sizeof (lispy_accent_keys
)
5049 / sizeof (lispy_accent_keys
[0])));
5053 if (event
->code
>= 0x400 && event
->code
< 0x500)
5054 return modify_event_symbol (event
->code
- 0x400,
5055 event
->modifiers
& ~shift_modifier
,
5056 Qfunction_key
, Qnil
,
5057 lispy_kana_keys
, &func_key_syms
,
5058 (sizeof (lispy_kana_keys
)
5059 / sizeof (lispy_kana_keys
[0])));
5060 #endif /* XK_kana_A */
5063 #ifdef ISO_FUNCTION_KEY_OFFSET
5064 if (event
->code
< FUNCTION_KEY_OFFSET
5065 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5066 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5068 Qfunction_key
, Qnil
,
5069 iso_lispy_function_keys
, &func_key_syms
,
5070 (sizeof (iso_lispy_function_keys
)
5071 / sizeof (iso_lispy_function_keys
[0])));
5074 /* Handle system-specific or unknown keysyms. */
5075 if (event
->code
& (1 << 28)
5076 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5077 || (event
->code
- FUNCTION_KEY_OFFSET
5078 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5079 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5081 /* We need to use an alist rather than a vector as the cache
5082 since we can't make a vector long enuf. */
5083 if (NILP (current_kboard
->system_key_syms
))
5084 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5085 return modify_event_symbol (event
->code
,
5088 current_kboard
->Vsystem_key_alist
,
5089 0, ¤t_kboard
->system_key_syms
,
5093 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5095 Qfunction_key
, Qnil
,
5096 lispy_function_keys
, &func_key_syms
,
5097 (sizeof (lispy_function_keys
)
5098 / sizeof (lispy_function_keys
[0])));
5101 /* A mouse click. Figure out where it is, decide whether it's
5102 a press, click or drag, and build the appropriate structure. */
5103 case MOUSE_CLICK_EVENT
:
5104 #ifndef USE_TOOLKIT_SCROLL_BARS
5105 case SCROLL_BAR_CLICK_EVENT
:
5108 int button
= event
->code
;
5110 Lisp_Object position
;
5111 Lisp_Object
*start_pos_ptr
;
5112 Lisp_Object start_pos
;
5117 /* Build the position as appropriate for this mouse click. */
5118 if (event
->kind
== MOUSE_CLICK_EVENT
)
5120 enum window_part part
;
5121 struct frame
*f
= XFRAME (event
->frame_or_window
);
5123 Lisp_Object string_info
= Qnil
;
5127 /* Ignore mouse events that were made on frame that
5128 have been deleted. */
5129 if (! FRAME_LIVE_P (f
))
5132 /* EVENT->x and EVENT->y are frame-relative pixel
5133 coordinates at this place. Under old redisplay, COLUMN
5134 and ROW are set to frame relative glyph coordinates
5135 which are then used to determine whether this click is
5136 in a menu (non-toolkit version). */
5137 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5138 &column
, &row
, NULL
, 1);
5140 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5141 /* In the non-toolkit version, clicks on the menu bar
5142 are ordinary button events in the event buffer.
5143 Distinguish them, and invoke the menu.
5145 (In the toolkit version, the toolkit handles the menu bar
5146 and Emacs doesn't know about it until after the user
5147 makes a selection.) */
5148 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5149 && (event
->modifiers
& down_modifier
))
5151 Lisp_Object items
, item
;
5156 /* Activate the menu bar on the down event. If the
5157 up event comes in before the menu code can deal with it,
5159 if (! (event
->modifiers
& down_modifier
))
5163 /* Find the menu bar item under `column'. */
5165 items
= FRAME_MENU_BAR_ITEMS (f
);
5166 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5168 Lisp_Object pos
, string
;
5169 string
= AREF (items
, i
+ 1);
5170 pos
= AREF (items
, i
+ 3);
5173 if (column
>= XINT (pos
)
5174 && column
< XINT (pos
) + SCHARS (string
))
5176 item
= AREF (items
, i
);
5181 /* ELisp manual 2.4b says (x y) are window relative but
5182 code says they are frame-relative. */
5184 = Fcons (event
->frame_or_window
,
5186 Fcons (Fcons (event
->x
, event
->y
),
5187 Fcons (make_number (event
->timestamp
),
5190 return Fcons (item
, Fcons (position
, Qnil
));
5192 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5194 /* Set `window' to the window under frame pixel coordinates
5195 event->x/event->y. */
5196 window
= window_from_coordinates (f
, XINT (event
->x
),
5198 &part
, &wx
, &wy
, 0);
5200 if (!WINDOWP (window
))
5202 window
= event
->frame_or_window
;
5207 /* It's a click in window window at frame coordinates
5208 event->x/ event->y. */
5209 struct window
*w
= XWINDOW (window
);
5211 /* Set event coordinates to window-relative coordinates
5212 for constructing the Lisp event below. */
5213 XSETINT (event
->x
, wx
);
5214 XSETINT (event
->y
, wy
);
5216 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5218 /* Mode line or header line. Look for a string under
5219 the mouse that may have a `local-map' property. */
5223 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5224 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5225 if (STRINGP (string
))
5226 string_info
= Fcons (string
, make_number (charpos
));
5228 else if (part
== ON_VERTICAL_BORDER
)
5229 posn
= Qvertical_line
;
5230 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5233 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5235 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5236 if (STRINGP (object
))
5237 string_info
= Fcons (object
, make_number (charpos
));
5242 struct display_pos p
;
5243 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5244 posn
= make_number (CHARPOS (p
.pos
));
5245 if (STRINGP (object
))
5248 make_number (CHARPOS (p
.string_pos
)));
5255 Fcons (Fcons (event
->x
, event
->y
),
5256 Fcons (make_number (event
->timestamp
),
5259 : Fcons (string_info
, Qnil
))))));
5261 #ifndef USE_TOOLKIT_SCROLL_BARS
5264 /* It's a scrollbar click. */
5265 Lisp_Object portion_whole
;
5268 window
= event
->frame_or_window
;
5269 portion_whole
= Fcons (event
->x
, event
->y
);
5270 part
= *scroll_bar_parts
[(int) event
->part
];
5274 Fcons (Qvertical_scroll_bar
,
5275 Fcons (portion_whole
,
5276 Fcons (make_number (event
->timestamp
),
5277 Fcons (part
, Qnil
)))));
5279 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5281 if (button
>= ASIZE (button_down_location
))
5283 button_down_location
= larger_vector (button_down_location
,
5285 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5288 start_pos_ptr
= &AREF (button_down_location
, button
);
5289 start_pos
= *start_pos_ptr
;
5290 *start_pos_ptr
= Qnil
;
5293 /* On window-system frames, use the value of
5294 double-click-fuzz as is. On other frames, interpret it
5295 as a multiple of 1/8 characters. */
5299 if (WINDOWP (event
->frame_or_window
))
5300 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5301 else if (FRAMEP (event
->frame_or_window
))
5302 f
= XFRAME (event
->frame_or_window
);
5306 if (FRAME_WINDOW_P (f
))
5307 fuzz
= double_click_fuzz
;
5309 fuzz
= double_click_fuzz
/ 8;
5311 is_double
= (button
== last_mouse_button
5312 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5313 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5314 && button_down_time
!= 0
5315 && (EQ (Vdouble_click_time
, Qt
)
5316 || (INTEGERP (Vdouble_click_time
)
5317 && ((int)(event
->timestamp
- button_down_time
)
5318 < XINT (Vdouble_click_time
)))));
5321 last_mouse_button
= button
;
5322 last_mouse_x
= XINT (event
->x
);
5323 last_mouse_y
= XINT (event
->y
);
5325 /* If this is a button press, squirrel away the location, so
5326 we can decide later whether it was a click or a drag. */
5327 if (event
->modifiers
& down_modifier
)
5331 double_click_count
++;
5332 event
->modifiers
|= ((double_click_count
> 2)
5337 double_click_count
= 1;
5338 button_down_time
= event
->timestamp
;
5339 *start_pos_ptr
= Fcopy_alist (position
);
5342 /* Now we're releasing a button - check the co-ordinates to
5343 see if this was a click or a drag. */
5344 else if (event
->modifiers
& up_modifier
)
5346 /* If we did not see a down before this up, ignore the up.
5347 Probably this happened because the down event chose a
5348 menu item. It would be an annoyance to treat the
5349 release of the button that chose the menu item as a
5352 if (!CONSP (start_pos
))
5355 event
->modifiers
&= ~up_modifier
;
5356 #if 0 /* Formerly we treated an up with no down as a click event. */
5357 if (!CONSP (start_pos
))
5358 event
->modifiers
|= click_modifier
;
5363 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5365 /* The third element of every position
5366 should be the (x,y) pair. */
5367 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5369 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5371 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5372 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5375 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5376 && ydiff
< double_click_fuzz
5377 && ydiff
> - double_click_fuzz
)
5378 /* Mouse hasn't moved (much). */
5379 event
->modifiers
|= click_modifier
;
5382 button_down_time
= 0;
5383 event
->modifiers
|= drag_modifier
;
5386 /* Don't check is_double; treat this as multiple
5387 if the down-event was multiple. */
5388 if (double_click_count
> 1)
5389 event
->modifiers
|= ((double_click_count
> 2)
5395 /* Every mouse event should either have the down_modifier or
5396 the up_modifier set. */
5400 /* Get the symbol we should use for the mouse click. */
5403 head
= modify_event_symbol (button
,
5405 Qmouse_click
, Vlispy_mouse_stem
,
5408 XVECTOR (mouse_syms
)->size
);
5409 if (event
->modifiers
& drag_modifier
)
5414 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5417 Fcons (make_number (double_click_count
),
5428 Lisp_Object position
;
5432 /* Build the position as appropriate for this mouse click. */
5433 enum window_part part
;
5434 struct frame
*f
= XFRAME (event
->frame_or_window
);
5436 Lisp_Object string_info
= Qnil
;
5441 /* Ignore wheel events that were made on frame that have been
5443 if (! FRAME_LIVE_P (f
))
5446 /* EVENT->x and EVENT->y are frame-relative pixel
5447 coordinates at this place. Under old redisplay, COLUMN
5448 and ROW are set to frame relative glyph coordinates
5449 which are then used to determine whether this click is
5450 in a menu (non-toolkit version). */
5451 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5452 &column
, &row
, NULL
, 1);
5454 /* Set `window' to the window under frame pixel coordinates
5455 event->x/event->y. */
5456 window
= window_from_coordinates (f
, XINT (event
->x
),
5458 &part
, &wx
, &wy
, 0);
5460 if (!WINDOWP (window
))
5462 window
= event
->frame_or_window
;
5467 /* It's a click in window window at frame coordinates
5468 event->x/ event->y. */
5469 struct window
*w
= XWINDOW (window
);
5471 /* Set event coordinates to window-relative coordinates
5472 for constructing the Lisp event below. */
5473 XSETINT (event
->x
, wx
);
5474 XSETINT (event
->y
, wy
);
5476 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5478 /* Mode line or header line. Look for a string under
5479 the mouse that may have a `local-map' property. */
5483 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5484 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5485 if (STRINGP (string
))
5486 string_info
= Fcons (string
, make_number (charpos
));
5488 else if (part
== ON_VERTICAL_BORDER
)
5489 posn
= Qvertical_line
;
5490 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5493 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5495 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5496 if (STRINGP (object
))
5497 string_info
= Fcons (object
, make_number (charpos
));
5502 struct display_pos p
;
5503 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5504 posn
= make_number (CHARPOS (p
.pos
));
5505 if (STRINGP (object
))
5508 make_number (CHARPOS (p
.string_pos
)));
5515 Fcons (Fcons (event
->x
, event
->y
),
5516 Fcons (make_number (event
->timestamp
),
5519 : Fcons (string_info
, Qnil
))))));
5521 /* Set double or triple modifiers to indicate the wheel speed. */
5523 /* On window-system frames, use the value of
5524 double-click-fuzz as is. On other frames, interpret it
5525 as a multiple of 1/8 characters. */
5530 if (WINDOWP (event
->frame_or_window
))
5531 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5532 else if (FRAMEP (event
->frame_or_window
))
5533 f
= XFRAME (event
->frame_or_window
);
5537 if (FRAME_WINDOW_P (f
))
5538 fuzz
= double_click_fuzz
;
5540 fuzz
= double_click_fuzz
/ 8;
5542 is_double
= (last_mouse_button
< 0
5543 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5544 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5545 && button_down_time
!= 0
5546 && (EQ (Vdouble_click_time
, Qt
)
5547 || (INTEGERP (Vdouble_click_time
)
5548 && ((int)(event
->timestamp
- button_down_time
)
5549 < XINT (Vdouble_click_time
)))));
5552 double_click_count
++;
5553 event
->modifiers
|= ((double_click_count
> 2)
5559 double_click_count
= 1;
5560 event
->modifiers
|= click_modifier
;
5563 button_down_time
= event
->timestamp
;
5564 /* Use a negative value to distinguish wheel from mouse button. */
5565 last_mouse_button
= -1;
5566 last_mouse_x
= XINT (event
->x
);
5567 last_mouse_y
= XINT (event
->y
);
5573 if (event
->modifiers
& up_modifier
)
5575 /* Emit a wheel-up event. */
5576 event
->modifiers
&= ~up_modifier
;
5579 else if (event
->modifiers
& down_modifier
)
5581 /* Emit a wheel-down event. */
5582 event
->modifiers
&= ~down_modifier
;
5586 /* Every wheel event should either have the down_modifier or
5587 the up_modifier set. */
5590 /* Get the symbol we should use for the wheel event. */
5591 head
= modify_event_symbol (symbol_num
,
5597 ASIZE (wheel_syms
));
5600 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5603 Fcons (make_number (double_click_count
),
5612 #ifdef USE_TOOLKIT_SCROLL_BARS
5614 /* We don't have down and up events if using toolkit scroll bars,
5615 so make this always a click event. Store in the `part' of
5616 the Lisp event a symbol which maps to the following actions:
5618 `above_handle' page up
5619 `below_handle' page down
5623 `bottom' bottom of buffer
5624 `handle' thumb has been dragged.
5625 `end-scroll' end of interaction with scroll bar
5627 The incoming input_event contains in its `part' member an
5628 index of type `enum scroll_bar_part' which we can use as an
5629 index in scroll_bar_parts to get the appropriate symbol. */
5631 case SCROLL_BAR_CLICK_EVENT
:
5633 Lisp_Object position
, head
, window
, portion_whole
, part
;
5635 window
= event
->frame_or_window
;
5636 portion_whole
= Fcons (event
->x
, event
->y
);
5637 part
= *scroll_bar_parts
[(int) event
->part
];
5641 Fcons (Qvertical_scroll_bar
,
5642 Fcons (portion_whole
,
5643 Fcons (make_number (event
->timestamp
),
5644 Fcons (part
, Qnil
)))));
5646 /* Always treat scroll bar events as clicks. */
5647 event
->modifiers
|= click_modifier
;
5648 event
->modifiers
&= ~up_modifier
;
5650 if (event
->code
>= ASIZE (mouse_syms
))
5651 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5653 /* Get the symbol we should use for the mouse click. */
5654 head
= modify_event_symbol (event
->code
,
5659 XVECTOR (mouse_syms
)->size
);
5660 return Fcons (head
, Fcons (position
, Qnil
));
5663 #endif /* USE_TOOLKIT_SCROLL_BARS */
5666 case W32_SCROLL_BAR_CLICK_EVENT
:
5668 int button
= event
->code
;
5670 Lisp_Object position
;
5671 Lisp_Object
*start_pos_ptr
;
5672 Lisp_Object start_pos
;
5676 Lisp_Object portion_whole
;
5679 window
= event
->frame_or_window
;
5680 portion_whole
= Fcons (event
->x
, event
->y
);
5681 part
= *scroll_bar_parts
[(int) event
->part
];
5685 Fcons (Qvertical_scroll_bar
,
5686 Fcons (portion_whole
,
5687 Fcons (make_number (event
->timestamp
),
5688 Fcons (part
, Qnil
)))));
5691 /* Always treat W32 scroll bar events as clicks. */
5692 event
->modifiers
|= click_modifier
;
5695 /* Get the symbol we should use for the mouse click. */
5698 head
= modify_event_symbol (button
,
5703 XVECTOR (mouse_syms
)->size
);
5709 #endif /* WINDOWSNT */
5710 #if defined(MAC_OSX)
5711 case MOUSE_WHEEL_EVENT
:
5713 enum window_part part
;
5714 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5717 Lisp_Object head
, position
;
5720 /* Ignore mouse events that were made on frame that
5721 have been deleted. */
5722 if (! FRAME_LIVE_P (f
))
5724 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5725 &column
, &row
, NULL
, 1);
5726 window
= window_from_coordinates (f
, XINT (event
->x
),
5730 if (!WINDOWP (window
))
5732 window
= event
->frame_or_window
;
5737 int pixcolumn
, pixrow
;
5738 column
-= WINDOW_LEFT_EDGE_COL (XWINDOW (window
));
5739 row
-= WINDOW_TOP_EDGE_LINE (XWINDOW (window
));
5740 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5741 &pixcolumn
, &pixrow
);
5742 XSETINT (event
->x
, pixcolumn
);
5743 XSETINT (event
->y
, pixrow
);
5745 if (part
== ON_MODE_LINE
)
5747 else if (part
== ON_VERTICAL_BORDER
)
5748 posn
= Qvertical_line
;
5749 else if (part
== ON_HEADER_LINE
)
5750 posn
= Qheader_line
;
5754 struct display_pos p
;
5755 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5757 posn
= make_number (CHARPOS (p
.pos
));
5762 Lisp_Object head
, position
;
5767 Fcons (Fcons (event
->x
, event
->y
),
5768 Fcons (make_number (event
->timestamp
),
5771 head
= modify_event_symbol (0, event
->modifiers
,
5773 lispy_mouse_wheel_names
,
5774 &mouse_wheel_syms
, 1);
5777 /* Insert 1 here so event-click-count works. */
5778 Fcons (make_number (1),
5779 Fcons (make_number (event
->code
),
5783 #endif /* MAC_OSX */
5785 case DRAG_N_DROP_EVENT
:
5787 enum window_part part
;
5794 /* The frame_or_window field should be a cons of the frame in
5795 which the event occurred and a list of the filenames
5797 if (! CONSP (event
->frame_or_window
))
5800 f
= XFRAME (XCAR (event
->frame_or_window
));
5801 files
= XCDR (event
->frame_or_window
);
5803 /* Ignore mouse events that were made on frames that
5804 have been deleted. */
5805 if (! FRAME_LIVE_P (f
))
5808 window
= window_from_coordinates (f
, XINT (event
->x
),
5810 &part
, &wx
, &wy
, 0);
5812 if (!WINDOWP (window
))
5814 window
= XCAR (event
->frame_or_window
);
5819 /* It's an event in window `window' at frame coordinates
5820 event->x/ event->y. */
5821 struct window
*w
= XWINDOW (window
);
5823 /* Set event coordinates to window-relative coordinates
5824 for constructing the Lisp event below. */
5825 XSETINT (event
->x
, wx
);
5826 XSETINT (event
->y
, wy
);
5828 if (part
== ON_MODE_LINE
)
5830 else if (part
== ON_VERTICAL_BORDER
)
5831 posn
= Qvertical_line
;
5832 else if (part
== ON_HEADER_LINE
)
5833 posn
= Qheader_line
;
5837 struct display_pos p
;
5838 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5839 posn
= make_number (CHARPOS (p
.pos
));
5844 Lisp_Object head
, position
;
5849 Fcons (Fcons (event
->x
, event
->y
),
5850 Fcons (make_number (event
->timestamp
),
5853 head
= modify_event_symbol (0, event
->modifiers
,
5855 lispy_drag_n_drop_names
,
5856 &drag_n_drop_syms
, 1);
5863 #endif /* HAVE_MOUSE */
5865 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5866 || defined (USE_GTK)
5867 case MENU_BAR_EVENT
:
5868 if (EQ (event
->arg
, event
->frame_or_window
))
5869 /* This is the prefix key. We translate this to
5870 `(menu_bar)' because the code in keyboard.c for menu
5871 events, which we use, relies on this. */
5872 return Fcons (Qmenu_bar
, Qnil
);
5876 case SELECT_WINDOW_EVENT
:
5877 /* Make an event (select-window (WINDOW)). */
5878 return Fcons (Qselect_window
,
5879 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5882 case TOOL_BAR_EVENT
:
5883 if (EQ (event
->arg
, event
->frame_or_window
))
5884 /* This is the prefix key. We translate this to
5885 `(tool_bar)' because the code in keyboard.c for tool bar
5886 events, which we use, relies on this. */
5887 return Fcons (Qtool_bar
, Qnil
);
5888 else if (SYMBOLP (event
->arg
))
5889 return apply_modifiers (event
->modifiers
, event
->arg
);
5892 case USER_SIGNAL_EVENT
:
5893 /* A user signal. */
5894 return *lispy_user_signals
[event
->code
];
5896 case SAVE_SESSION_EVENT
:
5897 return Qsave_session
;
5899 /* The 'kind' field of the event is something we don't recognize. */
5908 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5910 Lisp_Object bar_window
;
5911 enum scroll_bar_part part
;
5915 /* Is it a scroll bar movement? */
5916 if (frame
&& ! NILP (bar_window
))
5918 Lisp_Object part_sym
;
5920 part_sym
= *scroll_bar_parts
[(int) part
];
5921 return Fcons (Qscroll_bar_movement
,
5922 (Fcons (Fcons (bar_window
,
5923 Fcons (Qvertical_scroll_bar
,
5924 Fcons (Fcons (x
, y
),
5925 Fcons (make_number (time
),
5931 /* Or is it an ordinary mouse movement? */
5934 enum window_part area
;
5940 /* It's in a frame; which window on that frame? */
5941 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
),
5942 &area
, &wx
, &wy
, 0);
5946 if (WINDOWP (window
))
5948 struct window
*w
= XWINDOW (window
);
5950 /* Set window relative coordinates. */
5954 if (area
== ON_MODE_LINE
)
5956 else if (area
== ON_VERTICAL_BORDER
)
5957 posn
= Qvertical_line
;
5958 else if (area
== ON_HEADER_LINE
)
5959 posn
= Qheader_line
;
5963 struct display_pos p
;
5964 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5965 posn
= make_number (CHARPOS (p
.pos
));
5968 else if (frame
!= 0)
5970 XSETFRAME (window
, frame
);
5981 return Fcons (Qmouse_movement
,
5982 Fcons (Fcons (window
,
5984 Fcons (Fcons (x
, y
),
5985 Fcons (make_number (time
),
5991 #endif /* HAVE_MOUSE */
5993 /* Construct a switch frame event. */
5995 make_lispy_switch_frame (frame
)
5998 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6001 /* Manipulating modifiers. */
6003 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6005 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6006 SYMBOL's name of the end of the modifiers; the string from this
6007 position is the unmodified symbol name.
6009 This doesn't use any caches. */
6012 parse_modifiers_uncached (symbol
, modifier_end
)
6020 CHECK_SYMBOL (symbol
);
6023 name
= SYMBOL_NAME (symbol
);
6025 for (i
= 0; i
+2 <= SBYTES (name
); )
6027 int this_mod_end
= 0;
6030 /* See if the name continues with a modifier word.
6031 Check that the word appears, but don't check what follows it.
6032 Set this_mod and this_mod_end to record what we find. */
6034 switch (SREF (name
, i
))
6036 #define SINGLE_LETTER_MOD(BIT) \
6037 (this_mod_end = i + 1, this_mod = BIT)
6040 SINGLE_LETTER_MOD (alt_modifier
);
6044 SINGLE_LETTER_MOD (ctrl_modifier
);
6048 SINGLE_LETTER_MOD (hyper_modifier
);
6052 SINGLE_LETTER_MOD (meta_modifier
);
6056 SINGLE_LETTER_MOD (shift_modifier
);
6060 SINGLE_LETTER_MOD (super_modifier
);
6063 #undef SINGLE_LETTER_MOD
6065 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6066 if (i + LEN + 1 <= SBYTES (name) \
6067 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6069 this_mod_end = i + LEN; \
6074 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6075 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6076 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6080 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6082 #undef MULTI_LETTER_MOD
6086 /* If we found no modifier, stop looking for them. */
6087 if (this_mod_end
== 0)
6090 /* Check there is a dash after the modifier, so that it
6091 really is a modifier. */
6092 if (this_mod_end
>= SBYTES (name
)
6093 || SREF (name
, this_mod_end
) != '-')
6096 /* This modifier is real; look for another. */
6097 modifiers
|= this_mod
;
6098 i
= this_mod_end
+ 1;
6101 /* Should we include the `click' modifier? */
6102 if (! (modifiers
& (down_modifier
| drag_modifier
6103 | double_modifier
| triple_modifier
))
6104 && i
+ 7 == SBYTES (name
)
6105 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6106 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6107 modifiers
|= click_modifier
;
6115 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6116 prepended to the string BASE[0..BASE_LEN-1].
6117 This doesn't use any caches. */
6119 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6122 int base_len
, base_len_byte
;
6124 /* Since BASE could contain nulls, we can't use intern here; we have
6125 to use Fintern, which expects a genuine Lisp_String, and keeps a
6128 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6134 /* Only the event queue may use the `up' modifier; it should always
6135 be turned into a click or drag event before presented to lisp code. */
6136 if (modifiers
& up_modifier
)
6139 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6140 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6141 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6142 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6143 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6144 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6145 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6146 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6147 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6148 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6149 /* The click modifier is denoted by the absence of other modifiers. */
6153 mod_len
= p
- new_mods
;
6157 Lisp_Object new_name
;
6159 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6160 mod_len
+ base_len_byte
);
6161 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6162 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6164 return Fintern (new_name
, Qnil
);
6169 static char *modifier_names
[] =
6171 "up", "down", "drag", "click", "double", "triple", 0, 0,
6172 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6173 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6175 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6177 static Lisp_Object modifier_symbols
;
6179 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6181 lispy_modifier_list (modifiers
)
6184 Lisp_Object modifier_list
;
6187 modifier_list
= Qnil
;
6188 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6189 if (modifiers
& (1<<i
))
6190 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6193 return modifier_list
;
6197 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6198 where UNMODIFIED is the unmodified form of SYMBOL,
6199 MASK is the set of modifiers present in SYMBOL's name.
6200 This is similar to parse_modifiers_uncached, but uses the cache in
6201 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6202 Qevent_symbol_elements property. */
6205 parse_modifiers (symbol
)
6208 Lisp_Object elements
;
6210 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6211 if (CONSP (elements
))
6216 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6217 Lisp_Object unmodified
;
6220 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6221 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6224 if (modifiers
& ~VALMASK
)
6226 XSETFASTINT (mask
, modifiers
);
6227 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6229 /* Cache the parsing results on SYMBOL. */
6230 Fput (symbol
, Qevent_symbol_element_mask
,
6232 Fput (symbol
, Qevent_symbol_elements
,
6233 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6235 /* Since we know that SYMBOL is modifiers applied to unmodified,
6236 it would be nice to put that in unmodified's cache.
6237 But we can't, since we're not sure that parse_modifiers is
6244 /* Apply the modifiers MODIFIERS to the symbol BASE.
6245 BASE must be unmodified.
6247 This is like apply_modifiers_uncached, but uses BASE's
6248 Qmodifier_cache property, if present. It also builds
6249 Qevent_symbol_elements properties, since it has that info anyway.
6251 apply_modifiers copies the value of BASE's Qevent_kind property to
6252 the modified symbol. */
6254 apply_modifiers (modifiers
, base
)
6258 Lisp_Object cache
, index
, entry
, new_symbol
;
6260 /* Mask out upper bits. We don't know where this value's been. */
6261 modifiers
&= VALMASK
;
6263 /* The click modifier never figures into cache indices. */
6264 cache
= Fget (base
, Qmodifier_cache
);
6265 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6266 entry
= assq_no_quit (index
, cache
);
6269 new_symbol
= XCDR (entry
);
6272 /* We have to create the symbol ourselves. */
6273 new_symbol
= apply_modifiers_uncached (modifiers
,
6274 SDATA (SYMBOL_NAME (base
)),
6275 SCHARS (SYMBOL_NAME (base
)),
6276 SBYTES (SYMBOL_NAME (base
)));
6278 /* Add the new symbol to the base's cache. */
6279 entry
= Fcons (index
, new_symbol
);
6280 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6282 /* We have the parsing info now for free, so we could add it to
6284 XSETFASTINT (index, modifiers);
6285 Fput (new_symbol, Qevent_symbol_element_mask,
6286 Fcons (base, Fcons (index, Qnil)));
6287 Fput (new_symbol, Qevent_symbol_elements,
6288 Fcons (base, lispy_modifier_list (modifiers)));
6289 Sadly, this is only correct if `base' is indeed a base event,
6290 which is not necessarily the case. -stef */
6293 /* Make sure this symbol is of the same kind as BASE.
6295 You'd think we could just set this once and for all when we
6296 intern the symbol above, but reorder_modifiers may call us when
6297 BASE's property isn't set right; we can't assume that just
6298 because it has a Qmodifier_cache property it must have its
6299 Qevent_kind set right as well. */
6300 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6304 kind
= Fget (base
, Qevent_kind
);
6306 Fput (new_symbol
, Qevent_kind
, kind
);
6313 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6314 return a symbol with the modifiers placed in the canonical order.
6315 Canonical order is alphabetical, except for down and drag, which
6316 always come last. The 'click' modifier is never written out.
6318 Fdefine_key calls this to make sure that (for example) C-M-foo
6319 and M-C-foo end up being equivalent in the keymap. */
6322 reorder_modifiers (symbol
)
6325 /* It's hopefully okay to write the code this way, since everything
6326 will soon be in caches, and no consing will be done at all. */
6329 parsed
= parse_modifiers (symbol
);
6330 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6335 /* For handling events, we often want to produce a symbol whose name
6336 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6337 to some base, like the name of a function key or mouse button.
6338 modify_event_symbol produces symbols of this sort.
6340 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6341 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6344 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6345 into symbol names, or a string specifying a name stem used to
6346 construct a symbol name or the form `STEM-N', where N is the decimal
6347 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6348 non-nil; otherwise NAME_TABLE is used.
6350 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6351 persist between calls to modify_event_symbol that it can use to
6352 store a cache of the symbols it's generated for this NAME_TABLE
6353 before. The object stored there may be a vector or an alist.
6355 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6357 MODIFIERS is a set of modifier bits (as given in struct input_events)
6358 whose prefixes should be applied to the symbol name.
6360 SYMBOL_KIND is the value to be placed in the event_kind property of
6361 the returned symbol.
6363 The symbols we create are supposed to have an
6364 `event-symbol-elements' property, which lists the modifiers present
6365 in the symbol's name. */
6368 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6369 name_table
, symbol_table
, table_size
)
6372 Lisp_Object symbol_kind
;
6373 Lisp_Object name_alist_or_stem
;
6375 Lisp_Object
*symbol_table
;
6376 unsigned int table_size
;
6379 Lisp_Object symbol_int
;
6381 /* Get rid of the "vendor-specific" bit here. */
6382 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6384 /* Is this a request for a valid symbol? */
6385 if (symbol_num
< 0 || symbol_num
>= table_size
)
6388 if (CONSP (*symbol_table
))
6389 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6391 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6392 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6393 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6394 we've never used that symbol before. */
6397 if (! VECTORP (*symbol_table
)
6398 || XVECTOR (*symbol_table
)->size
!= table_size
)
6402 XSETFASTINT (size
, table_size
);
6403 *symbol_table
= Fmake_vector (size
, Qnil
);
6406 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6409 /* Have we already used this symbol before? */
6412 /* No; let's create it. */
6413 if (CONSP (name_alist_or_stem
))
6414 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6415 else if (STRINGP (name_alist_or_stem
))
6417 int len
= SBYTES (name_alist_or_stem
);
6418 char *buf
= (char *) alloca (len
+ 50);
6419 if (sizeof (int) == sizeof (EMACS_INT
))
6420 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6421 XINT (symbol_int
) + 1);
6422 else if (sizeof (long) == sizeof (EMACS_INT
))
6423 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6424 XINT (symbol_int
) + 1);
6425 value
= intern (buf
);
6427 else if (name_table
!= 0 && name_table
[symbol_num
])
6428 value
= intern (name_table
[symbol_num
]);
6430 #ifdef HAVE_WINDOW_SYSTEM
6433 char *name
= x_get_keysym_name (symbol_num
);
6435 value
= intern (name
);
6442 sprintf (buf
, "key-%d", symbol_num
);
6443 value
= intern (buf
);
6446 if (CONSP (*symbol_table
))
6447 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6449 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6451 /* Fill in the cache entries for this symbol; this also
6452 builds the Qevent_symbol_elements property, which the user
6454 apply_modifiers (modifiers
& click_modifier
, value
);
6455 Fput (value
, Qevent_kind
, symbol_kind
);
6458 /* Apply modifiers to that symbol. */
6459 return apply_modifiers (modifiers
, value
);
6462 /* Convert a list that represents an event type,
6463 such as (ctrl meta backspace), into the usual representation of that
6464 event type as a number or a symbol. */
6466 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6467 doc
: /* Convert the event description list EVENT-DESC to an event type.
6468 EVENT-DESC should contain one base event type (a character or symbol)
6469 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6470 drag, down, double or triple). The base must be last.
6471 The return value is an event type (a character or symbol) which
6472 has the same base event type and all the specified modifiers. */)
6474 Lisp_Object event_desc
;
6482 while (CONSP (rest
))
6490 /* Given a symbol, see if it is a modifier name. */
6491 if (SYMBOLP (elt
) && CONSP (rest
))
6492 this = parse_solitary_modifier (elt
);
6496 else if (!NILP (base
))
6497 error ("Two bases given in one event");
6503 /* Let the symbol A refer to the character A. */
6504 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6505 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6507 if (INTEGERP (base
))
6509 /* Turn (shift a) into A. */
6510 if ((modifiers
& shift_modifier
) != 0
6511 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6513 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6514 modifiers
&= ~shift_modifier
;
6517 /* Turn (control a) into C-a. */
6518 if (modifiers
& ctrl_modifier
)
6519 return make_number ((modifiers
& ~ctrl_modifier
)
6520 | make_ctrl_char (XINT (base
)));
6522 return make_number (modifiers
| XINT (base
));
6524 else if (SYMBOLP (base
))
6525 return apply_modifiers (modifiers
, base
);
6528 error ("Invalid base event");
6533 /* Try to recognize SYMBOL as a modifier name.
6534 Return the modifier flag bit, or 0 if not recognized. */
6537 parse_solitary_modifier (symbol
)
6540 Lisp_Object name
= SYMBOL_NAME (symbol
);
6542 switch (SREF (name
, 0))
6544 #define SINGLE_LETTER_MOD(BIT) \
6545 if (SBYTES (name) == 1) \
6548 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6549 if (LEN == SBYTES (name) \
6550 && ! strncmp (SDATA (name), NAME, LEN)) \
6554 SINGLE_LETTER_MOD (alt_modifier
);
6558 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6562 SINGLE_LETTER_MOD (ctrl_modifier
);
6566 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6567 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6571 SINGLE_LETTER_MOD (hyper_modifier
);
6575 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6579 SINGLE_LETTER_MOD (meta_modifier
);
6583 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6587 SINGLE_LETTER_MOD (shift_modifier
);
6591 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6592 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6593 SINGLE_LETTER_MOD (super_modifier
);
6597 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6598 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6599 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6603 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6606 #undef SINGLE_LETTER_MOD
6607 #undef MULTI_LETTER_MOD
6613 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6614 Such a list is not valid as an event,
6615 but it can be a Lucid-style event type list. */
6618 lucid_event_type_list_p (object
)
6623 if (! CONSP (object
))
6626 if (EQ (XCAR (object
), Qhelp_echo
)
6627 || EQ (XCAR (object
), Qvertical_line
)
6628 || EQ (XCAR (object
), Qmode_line
)
6629 || EQ (XCAR (object
), Qheader_line
))
6632 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6636 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6643 /* Store into *addr a value nonzero if terminal input chars are available.
6644 Serves the purpose of ioctl (0, FIONREAD, addr)
6645 but works even if FIONREAD does not exist.
6646 (In fact, this may actually read some input.)
6648 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6649 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6652 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6657 /* First of all, have we already counted some input? */
6658 *addr
= (!NILP (Vquit_flag
)
6659 || readable_filtered_events (do_timers_now
, filter_events
));
6661 /* If input is being read as it arrives, and we have none, there is none. */
6662 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6665 /* Try to read some input and see how much we get. */
6667 *addr
= (!NILP (Vquit_flag
)
6668 || readable_filtered_events (do_timers_now
, filter_events
));
6671 /* Store into *addr a value nonzero if terminal input chars are available.
6672 Serves the purpose of ioctl (0, FIONREAD, addr)
6673 but works even if FIONREAD does not exist.
6674 (In fact, this may actually read some input.)
6676 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6679 get_input_pending (addr
, do_timers_now
)
6683 get_filtered_input_pending (addr
, do_timers_now
, 0);
6686 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6689 gobble_input (expected
)
6694 if (interrupt_input
)
6697 mask
= sigblock (sigmask (SIGIO
));
6698 read_avail_input (expected
);
6702 #ifdef POLL_FOR_INPUT
6703 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6706 mask
= sigblock (sigmask (SIGALRM
));
6707 read_avail_input (expected
);
6713 read_avail_input (expected
);
6717 /* Put a BUFFER_SWITCH_EVENT in the buffer
6718 so that read_key_sequence will notice the new current buffer. */
6721 record_asynch_buffer_change ()
6723 struct input_event event
;
6726 event
.kind
= BUFFER_SWITCH_EVENT
;
6727 event
.frame_or_window
= Qnil
;
6731 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6732 The purpose of the event is to make read_key_sequence look up the
6733 keymaps again. If we aren't in read_key_sequence, we don't need one,
6734 and the event could cause trouble by messing up (input-pending-p). */
6735 tem
= Fwaiting_for_user_input_p ();
6739 /* We never need these events if we have no asynchronous subprocesses. */
6743 /* Make sure no interrupt happens while storing the event. */
6745 if (interrupt_input
)
6748 mask
= sigblock (sigmask (SIGIO
));
6749 kbd_buffer_store_event (&event
);
6756 kbd_buffer_store_event (&event
);
6763 /* Read any terminal input already buffered up by the system
6764 into the kbd_buffer, but do not wait.
6766 EXPECTED should be nonzero if the caller knows there is some input.
6768 Except on VMS, all input is read by this function.
6769 If interrupt_input is nonzero, this function MUST be called
6770 only when SIGIO is blocked.
6772 Returns the number of keyboard chars read, or -1 meaning
6773 this is a bad time to try to read input. */
6776 read_avail_input (expected
)
6779 struct input_event buf
[KBD_BUFFER_SIZE
];
6783 if (read_socket_hook
)
6784 /* No need for FIONREAD or fcntl; just say don't wait. */
6785 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6788 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6789 the kbd_buffer can really hold. That may prevent loss
6790 of characters on some systems when input is stuffed at us. */
6791 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6794 /* Determine how many characters we should *try* to read. */
6797 #else /* not WINDOWSNT */
6799 n_to_read
= dos_keysns ();
6802 #else /* not MSDOS */
6804 /* Find out how much input is available. */
6805 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6806 /* Formerly simply reported no input, but that sometimes led to
6807 a failure of Emacs to terminate.
6808 SIGHUP seems appropriate if we can't reach the terminal. */
6809 /* ??? Is it really right to send the signal just to this process
6810 rather than to the whole process group?
6811 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6812 kill (getpid (), SIGHUP
);
6815 if (n_to_read
> sizeof cbuf
)
6816 n_to_read
= sizeof cbuf
;
6817 #else /* no FIONREAD */
6818 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6819 /* Read some input if available, but don't wait. */
6820 n_to_read
= sizeof cbuf
;
6821 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6826 #endif /* not MSDOS */
6827 #endif /* not WINDOWSNT */
6829 /* Now read; for one reason or another, this will not block.
6830 NREAD is set to the number of chars read. */
6834 cbuf
[0] = dos_keyread ();
6837 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6839 /* POSIX infers that processes which are not in the session leader's
6840 process group won't get SIGHUP's at logout time. BSDI adheres to
6841 this part standard and returns -1 from read (0) with errno==EIO
6842 when the control tty is taken away.
6843 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6844 if (nread
== -1 && errno
== EIO
)
6846 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6847 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6848 This looks incorrect, but it isn't, because _BSD causes
6849 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6850 and that causes a value other than 0 when there is no input. */
6856 /* We used to retry the read if it was interrupted.
6857 But this does the wrong thing when O_NDELAY causes
6858 an EAGAIN error. Does anybody know of a situation
6859 where a retry is actually needed? */
6861 nread
< 0 && (errno
== EAGAIN
6875 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6876 fcntl (input_fd
, F_SETFL
, 0);
6877 #endif /* USG or DGUX or CYGWIN */
6878 #endif /* no FIONREAD */
6879 for (i
= 0; i
< nread
; i
++)
6881 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6882 buf
[i
].modifiers
= 0;
6883 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6884 buf
[i
].modifiers
= meta_modifier
;
6888 buf
[i
].code
= cbuf
[i
];
6889 buf
[i
].frame_or_window
= selected_frame
;
6894 /* Scan the chars for C-g and store them in kbd_buffer. */
6895 for (i
= 0; i
< nread
; i
++)
6897 kbd_buffer_store_event (&buf
[i
]);
6898 /* Don't look at input that follows a C-g too closely.
6899 This reduces lossage due to autorepeat on C-g. */
6900 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6901 && buf
[i
].code
== quit_char
)
6907 #endif /* not VMS */
6909 #ifdef SIGIO /* for entire page */
6910 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6913 input_available_signal (signo
)
6916 /* Must preserve main program's value of errno. */
6917 int old_errno
= errno
;
6919 extern int select_alarmed
;
6922 #if defined (USG) && !defined (POSIX_SIGNALS)
6923 /* USG systems forget handlers when they are used;
6924 must reestablish each time */
6925 signal (signo
, input_available_signal
);
6932 if (input_available_clear_time
)
6933 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6938 nread
= read_avail_input (1);
6939 /* -1 means it's not ok to read the input now.
6940 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6941 0 means there was no keyboard input available. */
6946 select_alarmed
= 1; /* Force the select emulator back to life */
6957 /* Send ourselves a SIGIO.
6959 This function exists so that the UNBLOCK_INPUT macro in
6960 blockinput.h can have some way to take care of input we put off
6961 dealing with, without assuming that every file which uses
6962 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6964 reinvoke_input_signal ()
6967 kill (getpid (), SIGIO
);
6973 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6974 static Lisp_Object menu_bar_one_keymap_changed_items
;
6976 /* These variables hold the vector under construction within
6977 menu_bar_items and its subroutines, and the current index
6978 for storing into that vector. */
6979 static Lisp_Object menu_bar_items_vector
;
6980 static int menu_bar_items_index
;
6982 /* Return a vector of menu items for a menu bar, appropriate
6983 to the current buffer. Each item has three elements in the vector:
6986 OLD is an old vector we can optionally reuse, or nil. */
6989 menu_bar_items (old
)
6992 /* The number of keymaps we're scanning right now, and the number of
6993 keymaps we have allocated space for. */
6996 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6997 in the current keymaps, or nil where it is not a prefix. */
7000 Lisp_Object def
, tail
;
7009 struct gcpro gcpro1
;
7011 /* In order to build the menus, we need to call the keymap
7012 accessors. They all call QUIT. But this function is called
7013 during redisplay, during which a quit is fatal. So inhibit
7014 quitting while building the menus.
7015 We do this instead of specbind because (1) errors will clear it anyway
7016 and (2) this avoids risk of specpdl overflow. */
7017 oquit
= Vinhibit_quit
;
7021 menu_bar_items_vector
= old
;
7023 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7024 menu_bar_items_index
= 0;
7026 GCPRO1 (menu_bar_items_vector
);
7028 /* Build our list of keymaps.
7029 If we recognize a function key and replace its escape sequence in
7030 keybuf with its symbol, or if the sequence starts with a mouse
7031 click and we need to switch buffers, we jump back here to rebuild
7032 the initial keymaps from the current buffer. */
7036 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7037 if (!NILP (Voverriding_local_map_menu_flag
))
7039 /* Yes, use them (if non-nil) as well as the global map. */
7040 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7042 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7043 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7044 if (!NILP (Voverriding_local_map
))
7045 maps
[nmaps
++] = Voverriding_local_map
;
7049 /* No, so use major and minor mode keymaps and keymap property.
7050 Note that menu-bar bindings in the local-map and keymap
7051 properties may not work reliable, as they are only
7052 recognized when the menu-bar (or mode-line) is updated,
7053 which does not normally happen after every command. */
7056 nminor
= current_minor_maps (NULL
, &tmaps
);
7057 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7059 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7060 maps
[nmaps
++] = tem
;
7061 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7063 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7065 maps
[nmaps
++] = current_global_map
;
7068 /* Look up in each map the dummy prefix key `menu-bar'. */
7072 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7073 if (!NILP (maps
[mapno
]))
7075 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7079 menu_bar_one_keymap_changed_items
= Qnil
;
7080 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7084 /* Move to the end those items that should be at the end. */
7086 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7089 int end
= menu_bar_items_index
;
7091 for (i
= 0; i
< end
; i
+= 4)
7092 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7094 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7095 /* Move the item at index I to the end,
7096 shifting all the others forward. */
7097 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7098 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7099 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7100 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7102 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7103 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7104 (end
- i
- 4) * sizeof (Lisp_Object
));
7105 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7106 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7107 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7108 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7113 /* Add nil, nil, nil, nil at the end. */
7114 i
= menu_bar_items_index
;
7115 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7118 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7119 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7120 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7121 menu_bar_items_vector
= tem
;
7123 /* Add this item. */
7124 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7125 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7126 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7127 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7128 menu_bar_items_index
= i
;
7130 Vinhibit_quit
= oquit
;
7132 return menu_bar_items_vector
;
7135 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7136 If there's already an item for KEY, add this DEF to it. */
7138 Lisp_Object item_properties
;
7141 menu_bar_item (key
, item
, dummy1
, dummy2
)
7142 Lisp_Object key
, item
, dummy1
;
7145 struct gcpro gcpro1
;
7149 if (EQ (item
, Qundefined
))
7151 /* If a map has an explicit `undefined' as definition,
7152 discard any previously made menu bar item. */
7154 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7155 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7157 if (menu_bar_items_index
> i
+ 4)
7158 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7159 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7160 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7161 menu_bar_items_index
-= 4;
7165 /* If this keymap has already contributed to this KEY,
7166 don't contribute to it a second time. */
7167 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7168 if (!NILP (tem
) || NILP (item
))
7171 menu_bar_one_keymap_changed_items
7172 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7174 /* We add to menu_bar_one_keymap_changed_items before doing the
7175 parse_menu_item, so that if it turns out it wasn't a menu item,
7176 it still correctly hides any further menu item. */
7178 i
= parse_menu_item (item
, 0, 1);
7183 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7185 /* Find any existing item for this KEY. */
7186 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7187 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7190 /* If we did not find this KEY, add it at the end. */
7191 if (i
== menu_bar_items_index
)
7193 /* If vector is too small, get a bigger one. */
7194 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7197 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7198 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7199 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7200 menu_bar_items_vector
= tem
;
7203 /* Add this item. */
7204 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7205 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7206 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7207 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7208 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7209 menu_bar_items_index
= i
;
7211 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7215 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7216 /* If the new and the old items are not both keymaps,
7217 the lookup will only find `item'. */
7218 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7219 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7223 /* This is used as the handler when calling menu_item_eval_property. */
7225 menu_item_eval_property_1 (arg
)
7228 /* If we got a quit from within the menu computation,
7229 quit all the way out of it. This takes care of C-] in the debugger. */
7230 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7231 Fsignal (Qquit
, Qnil
);
7236 /* Evaluate an expression and return the result (or nil if something
7237 went wrong). Used to evaluate dynamic parts of menu items. */
7239 menu_item_eval_property (sexpr
)
7242 int count
= SPECPDL_INDEX ();
7244 specbind (Qinhibit_redisplay
, Qt
);
7245 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7246 menu_item_eval_property_1
);
7247 return unbind_to (count
, val
);
7250 /* This function parses a menu item and leaves the result in the
7251 vector item_properties.
7252 ITEM is a key binding, a possible menu item.
7253 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7254 evaluate dynamic expressions in the menu item.
7255 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7257 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7258 parse_menu_item returns true if the item is a menu item and false
7262 parse_menu_item (item
, notreal
, inmenubar
)
7264 int notreal
, inmenubar
;
7266 Lisp_Object def
, tem
, item_string
, start
;
7267 Lisp_Object cachelist
;
7269 Lisp_Object keyhint
;
7280 /* Create item_properties vector if necessary. */
7281 if (NILP (item_properties
))
7283 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7285 /* Initialize optional entries. */
7286 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7287 AREF (item_properties
, i
) = Qnil
;
7288 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7290 /* Save the item here to protect it from GC. */
7291 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7293 item_string
= XCAR (item
);
7297 if (STRINGP (item_string
))
7299 /* Old format menu item. */
7300 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7302 /* Maybe help string. */
7303 if (CONSP (item
) && STRINGP (XCAR (item
)))
7305 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7310 /* Maybe key binding cache. */
7311 if (CONSP (item
) && CONSP (XCAR (item
))
7312 && (NILP (XCAR (XCAR (item
)))
7313 || VECTORP (XCAR (XCAR (item
)))))
7315 cachelist
= XCAR (item
);
7319 /* This is the real definition--the function to run. */
7320 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7322 /* Get enable property, if any. */
7325 tem
= Fget (item
, Qmenu_enable
);
7327 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7330 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7332 /* New format menu item. */
7333 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7334 start
= XCDR (item
);
7337 /* We have a real binding. */
7338 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7340 item
= XCDR (start
);
7341 /* Is there a cache list with key equivalences. */
7342 if (CONSP (item
) && CONSP (XCAR (item
)))
7344 cachelist
= XCAR (item
);
7348 /* Parse properties. */
7349 while (CONSP (item
) && CONSP (XCDR (item
)))
7354 if (EQ (tem
, QCenable
))
7355 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7356 else if (EQ (tem
, QCvisible
) && !notreal
)
7358 /* If got a visible property and that evaluates to nil
7359 then ignore this item. */
7360 tem
= menu_item_eval_property (XCAR (item
));
7364 else if (EQ (tem
, QChelp
))
7365 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7366 else if (EQ (tem
, QCfilter
))
7368 else if (EQ (tem
, QCkey_sequence
))
7371 if (NILP (cachelist
)
7372 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7373 /* Be GC protected. Set keyhint to item instead of tem. */
7376 else if (EQ (tem
, QCkeys
))
7379 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7380 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7382 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7387 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7389 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7391 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7398 else if (inmenubar
|| !NILP (start
))
7402 return 0; /* not a menu item */
7404 /* If item string is not a string, evaluate it to get string.
7405 If we don't get a string, skip this item. */
7406 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7407 if (!(STRINGP (item_string
) || notreal
))
7409 item_string
= menu_item_eval_property (item_string
);
7410 if (!STRINGP (item_string
))
7412 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7415 /* If got a filter apply it on definition. */
7416 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7419 def
= menu_item_eval_property (list2 (XCAR (filter
),
7420 list2 (Qquote
, def
)));
7422 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7425 /* Enable or disable selection of item. */
7426 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7432 tem
= menu_item_eval_property (tem
);
7433 if (inmenubar
&& NILP (tem
))
7434 return 0; /* Ignore disabled items in menu bar. */
7435 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7438 /* If we got no definition, this item is just unselectable text which
7439 is OK in a submenu but not in the menubar. */
7441 return (inmenubar
? 0 : 1);
7443 /* See if this is a separate pane or a submenu. */
7444 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7445 tem
= get_keymap (def
, 0, 1);
7446 /* For a subkeymap, just record its details and exit. */
7449 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7450 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7454 /* At the top level in the menu bar, do likewise for commands also.
7455 The menu bar does not display equivalent key bindings anyway.
7456 ITEM_PROPERTY_DEF is already set up properly. */
7460 /* This is a command. See if there is an equivalent key binding. */
7461 if (NILP (cachelist
))
7463 /* We have to create a cachelist. */
7464 CHECK_IMPURE (start
);
7465 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7466 cachelist
= XCAR (XCDR (start
));
7468 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7469 if (!NILP (keyhint
))
7471 XSETCAR (cachelist
, XCAR (keyhint
));
7474 else if (STRINGP (tem
))
7476 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7477 XSETCAR (cachelist
, Qt
);
7481 tem
= XCAR (cachelist
);
7488 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7490 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7493 def
= XCAR (prefix
);
7494 prefix
= XCDR (prefix
);
7497 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7499 if (!update_menu_bindings
)
7501 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7503 if (newcache
/* Always check first time. */
7504 /* Should we check everything when precomputing key
7506 /* If something had no key binding before, don't recheck it
7507 because that is too slow--except if we have a list of
7508 rebound commands in Vdefine_key_rebound_commands, do
7509 recheck any command that appears in that list. */
7510 || (CONSP (Vdefine_key_rebound_commands
)
7511 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7514 /* We had a saved key. Is it still bound to the command? */
7517 /* If the command is an alias for another
7518 (such as lmenu.el set it up), check if the
7519 original command matches the cached command. */
7520 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7521 chkcache
= 1; /* Need to recompute key binding. */
7525 /* Recompute equivalent key binding. If the command is an alias
7526 for another (such as lmenu.el set it up), see if the original
7527 command name has equivalent keys. Otherwise look up the
7528 specified command itself. We don't try both, because that
7529 makes lmenu menus slow. */
7531 && SYMBOLP (XSYMBOL (def
)->function
)
7532 && ! NILP (Fget (def
, Qmenu_alias
)))
7533 def
= XSYMBOL (def
)->function
;
7534 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7535 XSETCAR (cachelist
, tem
);
7538 XSETCDR (cachelist
, Qnil
);
7542 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7544 tem
= XCAR (cachelist
);
7548 newcache
= chkcache
;
7551 tem
= Fkey_description (tem
);
7554 if (STRINGP (XCAR (prefix
)))
7555 tem
= concat2 (XCAR (prefix
), tem
);
7556 if (STRINGP (XCDR (prefix
)))
7557 tem
= concat2 (tem
, XCDR (prefix
));
7559 XSETCDR (cachelist
, tem
);
7563 tem
= XCDR (cachelist
);
7564 if (newcache
&& !NILP (tem
))
7566 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7567 XSETCDR (cachelist
, tem
);
7570 /* If we only want to precompute equivalent key bindings, stop here. */
7574 /* If we have an equivalent key binding, use that. */
7575 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7577 /* Include this when menu help is implemented.
7578 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7579 if (!(NILP (tem) || STRINGP (tem)))
7581 tem = menu_item_eval_property (tem);
7584 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7588 /* Handle radio buttons or toggle boxes. */
7589 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7591 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7592 = menu_item_eval_property (tem
);
7599 /***********************************************************************
7601 ***********************************************************************/
7603 /* A vector holding tool bar items while they are parsed in function
7604 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7607 static Lisp_Object tool_bar_items_vector
;
7609 /* A vector holding the result of parse_tool_bar_item. Layout is like
7610 the one for a single item in tool_bar_items_vector. */
7612 static Lisp_Object tool_bar_item_properties
;
7614 /* Next free index in tool_bar_items_vector. */
7616 static int ntool_bar_items
;
7618 /* The symbols `tool-bar', and `:image'. */
7620 extern Lisp_Object Qtool_bar
;
7621 Lisp_Object QCimage
;
7623 /* Function prototypes. */
7625 static void init_tool_bar_items
P_ ((Lisp_Object
));
7626 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7627 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7628 static void append_tool_bar_item
P_ ((void));
7631 /* Return a vector of tool bar items for keymaps currently in effect.
7632 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7633 tool bar items found. */
7636 tool_bar_items (reuse
, nitems
)
7647 /* In order to build the menus, we need to call the keymap
7648 accessors. They all call QUIT. But this function is called
7649 during redisplay, during which a quit is fatal. So inhibit
7650 quitting while building the menus. We do this instead of
7651 specbind because (1) errors will clear it anyway and (2) this
7652 avoids risk of specpdl overflow. */
7653 oquit
= Vinhibit_quit
;
7656 /* Initialize tool_bar_items_vector and protect it from GC. */
7657 init_tool_bar_items (reuse
);
7659 /* Build list of keymaps in maps. Set nmaps to the number of maps
7662 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7663 if (!NILP (Voverriding_local_map_menu_flag
))
7665 /* Yes, use them (if non-nil) as well as the global map. */
7666 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7668 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7669 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7670 if (!NILP (Voverriding_local_map
))
7671 maps
[nmaps
++] = Voverriding_local_map
;
7675 /* No, so use major and minor mode keymaps and keymap property.
7676 Note that tool-bar bindings in the local-map and keymap
7677 properties may not work reliable, as they are only
7678 recognized when the tool-bar (or mode-line) is updated,
7679 which does not normally happen after every command. */
7682 nminor
= current_minor_maps (NULL
, &tmaps
);
7683 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7685 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7686 maps
[nmaps
++] = tem
;
7687 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7689 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7692 /* Add global keymap at the end. */
7693 maps
[nmaps
++] = current_global_map
;
7695 /* Process maps in reverse order and look up in each map the prefix
7697 for (i
= nmaps
- 1; i
>= 0; --i
)
7698 if (!NILP (maps
[i
]))
7702 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7707 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7708 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7710 Lisp_Object keydef
= XCAR (tail
);
7712 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7717 Vinhibit_quit
= oquit
;
7718 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7719 return tool_bar_items_vector
;
7723 /* Process the definition of KEY which is DEF. */
7726 process_tool_bar_item (key
, def
)
7727 Lisp_Object key
, def
;
7730 extern Lisp_Object Qundefined
;
7731 struct gcpro gcpro1
, gcpro2
;
7733 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7737 if (EQ (def
, Qundefined
))
7739 /* If a map has an explicit `undefined' as definition,
7740 discard any previously made item. */
7741 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7743 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7745 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7747 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7748 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7749 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7750 * sizeof (Lisp_Object
)));
7751 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7756 else if (parse_tool_bar_item (key
, def
))
7757 /* Append a new tool bar item to tool_bar_items_vector. Accept
7758 more than one definition for the same key. */
7759 append_tool_bar_item ();
7765 /* Parse a tool bar item specification ITEM for key KEY and return the
7766 result in tool_bar_item_properties. Value is zero if ITEM is
7769 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7771 CAPTION is the caption of the item, If it's not a string, it is
7772 evaluated to get a string.
7774 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7775 as binding are currently ignored.
7777 The following properties are recognized:
7781 FORM is evaluated and specifies whether the tool bar item is
7782 enabled or disabled.
7786 FORM is evaluated and specifies whether the tool bar item is visible.
7788 - `:filter FUNCTION'
7790 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7791 result is stored as the new binding.
7793 - `:button (TYPE SELECTED)'
7795 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7796 and specifies whether the button is selected (pressed) or not.
7800 IMAGES is either a single image specification or a vector of four
7801 image specifications. See enum tool_bar_item_images.
7803 - `:help HELP-STRING'.
7805 Gives a help string to display for the tool bar item. */
7808 parse_tool_bar_item (key
, item
)
7809 Lisp_Object key
, item
;
7811 /* Access slot with index IDX of vector tool_bar_item_properties. */
7812 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7814 Lisp_Object filter
= Qnil
;
7815 Lisp_Object caption
;
7818 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7819 Rule out items that aren't lists, don't start with
7820 `menu-item' or whose rest following `tool-bar-item' is not a
7823 || !EQ (XCAR (item
), Qmenu_item
)
7824 || (item
= XCDR (item
),
7828 /* Create tool_bar_item_properties vector if necessary. Reset it to
7830 if (VECTORP (tool_bar_item_properties
))
7832 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7836 tool_bar_item_properties
7837 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7840 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7841 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7843 /* Get the caption of the item. If the caption is not a string,
7844 evaluate it to get a string. If we don't get a string, skip this
7846 caption
= XCAR (item
);
7847 if (!STRINGP (caption
))
7849 caption
= menu_item_eval_property (caption
);
7850 if (!STRINGP (caption
))
7853 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7855 /* Give up if rest following the caption is not a list. */
7860 /* Store the binding. */
7861 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7864 /* Ignore cached key binding, if any. */
7865 if (CONSP (item
) && CONSP (XCAR (item
)))
7868 /* Process the rest of the properties. */
7869 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7871 Lisp_Object key
, value
;
7874 value
= XCAR (XCDR (item
));
7876 if (EQ (key
, QCenable
))
7877 /* `:enable FORM'. */
7878 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7879 else if (EQ (key
, QCvisible
))
7881 /* `:visible FORM'. If got a visible property and that
7882 evaluates to nil then ignore this item. */
7883 if (NILP (menu_item_eval_property (value
)))
7886 else if (EQ (key
, QChelp
))
7887 /* `:help HELP-STRING'. */
7888 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7889 else if (EQ (key
, QCfilter
))
7890 /* ':filter FORM'. */
7892 else if (EQ (key
, QCbutton
) && CONSP (value
))
7894 /* `:button (TYPE . SELECTED)'. */
7895 Lisp_Object type
, selected
;
7897 type
= XCAR (value
);
7898 selected
= XCDR (value
);
7899 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7901 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7902 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7905 else if (EQ (key
, QCimage
)
7907 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7908 /* Value is either a single image specification or a vector
7909 of 4 such specifications for the different button states. */
7910 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7913 /* If got a filter apply it on binding. */
7915 PROP (TOOL_BAR_ITEM_BINDING
)
7916 = menu_item_eval_property (list2 (filter
,
7918 PROP (TOOL_BAR_ITEM_BINDING
))));
7920 /* See if the binding is a keymap. Give up if it is. */
7921 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7924 /* Enable or disable selection of item. */
7925 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7926 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7927 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7929 /* Handle radio buttons or toggle boxes. */
7930 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7931 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7932 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7940 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7941 that can be reused. */
7944 init_tool_bar_items (reuse
)
7947 if (VECTORP (reuse
))
7948 tool_bar_items_vector
= reuse
;
7950 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7951 ntool_bar_items
= 0;
7955 /* Append parsed tool bar item properties from
7956 tool_bar_item_properties */
7959 append_tool_bar_item ()
7961 Lisp_Object
*to
, *from
;
7963 /* Enlarge tool_bar_items_vector if necessary. */
7964 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7965 >= XVECTOR (tool_bar_items_vector
)->size
)
7967 Lisp_Object new_vector
;
7968 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7970 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7971 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7972 XVECTOR (new_vector
)->contents
,
7973 old_size
* sizeof (Lisp_Object
));
7974 tool_bar_items_vector
= new_vector
;
7977 /* Append entries from tool_bar_item_properties to the end of
7978 tool_bar_items_vector. */
7979 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7980 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7981 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7982 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7989 /* Read a character using menus based on maps in the array MAPS.
7990 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7991 Return t if we displayed a menu but the user rejected it.
7993 PREV_EVENT is the previous input event, or nil if we are reading
7994 the first event of a key sequence.
7996 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7997 if we used a mouse menu to read the input, or zero otherwise. If
7998 USED_MOUSE_MENU is null, we don't dereference it.
8000 The prompting is done based on the prompt-string of the map
8001 and the strings associated with various map elements.
8003 This can be done with X menus or with menus put in the minibuf.
8004 These are done in different ways, depending on how the input will be read.
8005 Menus using X are done after auto-saving in read-char, getting the input
8006 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8007 and do auto-saving in the inner call of read_char. */
8010 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8013 Lisp_Object prev_event
;
8014 int *used_mouse_menu
;
8017 register Lisp_Object name
= Qnil
;
8019 if (used_mouse_menu
)
8020 *used_mouse_menu
= 0;
8022 /* Use local over global Menu maps */
8024 if (! menu_prompting
)
8027 /* Optionally disregard all but the global map. */
8028 if (inhibit_local_menu_bar_menus
)
8030 maps
+= (nmaps
- 1);
8034 /* Get the menu name from the first map that has one (a prompt string). */
8035 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8037 name
= Fkeymap_prompt (maps
[mapno
]);
8042 /* If we don't have any menus, just read a character normally. */
8043 if (!STRINGP (name
))
8047 /* If we got to this point via a mouse click,
8048 use a real menu for mouse selection. */
8049 if (EVENT_HAS_PARAMETERS (prev_event
)
8050 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8051 && !EQ (XCAR (prev_event
), Qtool_bar
))
8053 /* Display the menu and get the selection. */
8054 Lisp_Object
*realmaps
8055 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8059 /* Use the maps that are not nil. */
8060 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8061 if (!NILP (maps
[mapno
]))
8062 realmaps
[nmaps1
++] = maps
[mapno
];
8064 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8069 record_menu_key (XCAR (value
));
8071 /* If we got multiple events, unread all but
8073 There is no way to prevent those unread events
8074 from showing up later in last_nonmenu_event.
8075 So turn symbol and integer events into lists,
8076 to indicate that they came from a mouse menu,
8077 so that when present in last_nonmenu_event
8078 they won't confuse things. */
8079 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8081 record_menu_key (XCAR (tem
));
8082 if (SYMBOLP (XCAR (tem
))
8083 || INTEGERP (XCAR (tem
)))
8084 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8087 /* If we got more than one event, put all but the first
8088 onto this list to be read later.
8089 Return just the first event now. */
8090 Vunread_command_events
8091 = nconc2 (XCDR (value
), Vunread_command_events
);
8092 value
= XCAR (value
);
8094 else if (NILP (value
))
8096 if (used_mouse_menu
)
8097 *used_mouse_menu
= 1;
8100 #endif /* HAVE_MENUS */
8104 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8105 We make this bigger when necessary, and never free it. */
8106 static char *read_char_minibuf_menu_text
;
8107 /* Size of that buffer. */
8108 static int read_char_minibuf_menu_width
;
8111 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8117 register Lisp_Object name
;
8119 /* FIXME: Use the minibuffer's frame width. */
8120 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8123 Lisp_Object rest
, vector
;
8129 if (! menu_prompting
)
8132 /* Make sure we have a big enough buffer for the menu text. */
8133 if (read_char_minibuf_menu_text
== 0)
8135 read_char_minibuf_menu_width
= width
+ 4;
8136 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8138 else if (width
+ 4 > read_char_minibuf_menu_width
)
8140 read_char_minibuf_menu_width
= width
+ 4;
8141 read_char_minibuf_menu_text
8142 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8144 menu
= read_char_minibuf_menu_text
;
8146 /* Get the menu name from the first map that has one (a prompt string). */
8147 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8149 name
= Fkeymap_prompt (maps
[mapno
]);
8154 /* If we don't have any menus, just read a character normally. */
8155 if (!STRINGP (name
))
8158 /* Prompt string always starts with map's prompt, and a space. */
8159 strcpy (menu
, SDATA (name
));
8160 nlength
= SBYTES (name
);
8161 menu
[nlength
++] = ':';
8162 menu
[nlength
++] = ' ';
8165 /* Start prompting at start of first map. */
8169 /* Present the documented bindings, a line at a time. */
8176 Lisp_Object orig_defn_macro
;
8178 /* Loop over elements of map. */
8183 /* If reached end of map, start at beginning of next map. */
8187 /* At end of last map, wrap around to first map if just starting,
8188 or end this line if already have something on it. */
8192 if (notfirst
|| nobindings
) break;
8197 /* Look at the next element of the map. */
8199 elt
= XVECTOR (vector
)->contents
[idx
];
8201 elt
= Fcar_safe (rest
);
8203 if (idx
< 0 && VECTORP (elt
))
8205 /* If we found a dense table in the keymap,
8206 advanced past it, but start scanning its contents. */
8207 rest
= Fcdr_safe (rest
);
8213 /* An ordinary element. */
8214 Lisp_Object event
, tem
;
8218 event
= Fcar_safe (elt
); /* alist */
8219 elt
= Fcdr_safe (elt
);
8223 XSETINT (event
, idx
); /* vector */
8226 /* Ignore the element if it has no prompt string. */
8227 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8229 /* 1 if the char to type matches the string. */
8231 Lisp_Object upcased_event
, downcased_event
;
8232 Lisp_Object desc
= Qnil
;
8234 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8236 upcased_event
= Fupcase (event
);
8237 downcased_event
= Fdowncase (event
);
8238 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8239 || XINT (downcased_event
) == SREF (s
, 0));
8241 desc
= Fsingle_key_description (event
, Qnil
);
8243 #if 0 /* It is redundant to list the equivalent key bindings because
8244 the prefix is what the user has already typed. */
8246 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8248 /* Insert equivalent keybinding. */
8249 s
= concat2 (s
, tem
);
8252 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8253 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8255 /* Insert button prefix. */
8256 Lisp_Object selected
8257 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8258 if (EQ (tem
, QCradio
))
8259 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8261 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8262 s
= concat2 (tem
, s
);
8266 /* If we have room for the prompt string, add it to this line.
8267 If this is the first on the line, always add it. */
8268 if ((SCHARS (s
) + i
+ 2
8269 + (char_matches
? 0 : SCHARS (desc
) + 3))
8275 /* Punctuate between strings. */
8278 strcpy (menu
+ i
, ", ");
8284 /* If the char to type doesn't match the string's
8285 first char, explicitly show what char to type. */
8288 /* Add as much of string as fits. */
8289 thiswidth
= SCHARS (desc
);
8290 if (thiswidth
+ i
> width
)
8291 thiswidth
= width
- i
;
8292 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8294 strcpy (menu
+ i
, " = ");
8298 /* Add as much of string as fits. */
8299 thiswidth
= SCHARS (s
);
8300 if (thiswidth
+ i
> width
)
8301 thiswidth
= width
- i
;
8302 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8308 /* If this element does not fit, end the line now,
8309 and save the element for the next line. */
8310 strcpy (menu
+ i
, "...");
8315 /* Move past this element. */
8316 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8317 /* Handle reaching end of dense table. */
8322 rest
= Fcdr_safe (rest
);
8326 /* Prompt with that and read response. */
8327 message2_nolog (menu
, strlen (menu
),
8328 ! NILP (current_buffer
->enable_multibyte_characters
));
8330 /* Make believe its not a keyboard macro in case the help char
8331 is pressed. Help characters are not recorded because menu prompting
8332 is not used on replay.
8334 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8335 current_kboard
->defining_kbd_macro
= Qnil
;
8337 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8338 while (BUFFERP (obj
));
8339 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8341 if (!INTEGERP (obj
))
8346 if (! EQ (obj
, menu_prompt_more_char
)
8347 && (!INTEGERP (menu_prompt_more_char
)
8348 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8350 if (!NILP (current_kboard
->defining_kbd_macro
))
8351 store_kbd_macro_char (obj
);
8354 /* Help char - go round again */
8358 /* Reading key sequences. */
8360 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8361 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8362 keymap, or nil otherwise. Return the index of the first keymap in
8363 which KEY has any binding, or NMAPS if no map has a binding.
8365 If KEY is a meta ASCII character, treat it like meta-prefix-char
8366 followed by the corresponding non-meta character. Keymaps in
8367 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8370 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8373 NEXT may be the same array as CURRENT. */
8376 follow_key (key
, nmaps
, current
, defs
, next
)
8378 Lisp_Object
*current
, *defs
, *next
;
8381 int i
, first_binding
;
8383 first_binding
= nmaps
;
8384 for (i
= nmaps
- 1; i
>= 0; i
--)
8386 if (! NILP (current
[i
]))
8388 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8389 if (! NILP (defs
[i
]))
8396 /* Given the set of bindings we've found, produce the next set of maps. */
8397 if (first_binding
< nmaps
)
8398 for (i
= 0; i
< nmaps
; i
++)
8399 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8401 return first_binding
;
8404 /* Structure used to keep track of partial application of key remapping
8405 such as Vfunction_key_map and Vkey_translation_map. */
8406 typedef struct keyremap
8408 Lisp_Object map
, parent
;
8412 /* Lookup KEY in MAP.
8413 MAP is a keymap mapping keys to key vectors or functions.
8414 If the mapping is a function and DO_FUNCTION is non-zero, then
8415 the function is called with PROMPT as parameter and its return
8416 value is used as the return value of this function (after checking
8417 that it is indeed a vector). */
8420 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8421 Lisp_Object map
, key
, prompt
;
8426 next
= access_keymap (map
, key
, 1, 0, 1);
8428 /* Handle symbol with autoload definition. */
8429 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8430 && CONSP (XSYMBOL (next
)->function
)
8431 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8432 do_autoload (XSYMBOL (next
)->function
, next
);
8434 /* Handle a symbol whose function definition is a keymap
8436 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8437 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8438 || KEYMAPP (XSYMBOL (next
)->function
)))
8439 next
= XSYMBOL (next
)->function
;
8441 /* If the keymap gives a function, not an
8442 array, then call the function with one arg and use
8443 its value instead. */
8444 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8449 next
= call1 (next
, prompt
);
8450 /* If the function returned something invalid,
8451 barf--don't ignore it.
8452 (To ignore it safely, we would need to gcpro a bunch of
8453 other variables.) */
8454 if (! (VECTORP (next
) || STRINGP (next
)))
8455 error ("Function %s returns invalid key sequence", tem
);
8460 /* Do one step of the key remapping used for function-key-map and
8461 key-translation-map:
8462 KEYBUF is the buffer holding the input events.
8463 BUFSIZE is its maximum size.
8464 FKEY is a pointer to the keyremap structure to use.
8465 INPUT is the index of the last element in KEYBUF.
8466 DOIT if non-zero says that the remapping can actually take place.
8467 DIFF is used to return the number of keys added/removed by the remapping.
8468 PARENT is the root of the keymap.
8469 PROMPT is the prompt to use if the remapping happens through a function.
8470 The return value is non-zero if the remapping actually took place. */
8473 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8474 Lisp_Object
*keybuf
, prompt
;
8476 int input
, doit
, *diff
, bufsize
;
8478 Lisp_Object next
, key
;
8480 key
= keybuf
[fkey
->end
++];
8481 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8483 /* If keybuf[fkey->start..fkey->end] is bound in the
8484 map and we're in a position to do the key remapping, replace it with
8485 the binding and restart with fkey->start at the end. */
8486 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8488 int len
= XFASTINT (Flength (next
));
8491 *diff
= len
- (fkey
->end
- fkey
->start
);
8493 if (input
+ *diff
>= bufsize
)
8494 error ("Key sequence too long");
8496 /* Shift the keys that follow fkey->end. */
8498 for (i
= fkey
->end
; i
< input
; i
++)
8499 keybuf
[i
+ *diff
] = keybuf
[i
];
8501 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8502 keybuf
[i
+ *diff
] = keybuf
[i
];
8503 /* Overwrite the old keys with the new ones. */
8504 for (i
= 0; i
< len
; i
++)
8505 keybuf
[fkey
->start
+ i
]
8506 = Faref (next
, make_number (i
));
8508 fkey
->start
= fkey
->end
+= *diff
;
8509 fkey
->map
= fkey
->parent
;
8514 fkey
->map
= get_keymap (next
, 0, 1);
8516 /* If we no longer have a bound suffix, try a new position for
8518 if (!CONSP (fkey
->map
))
8520 fkey
->end
= ++fkey
->start
;
8521 fkey
->map
= fkey
->parent
;
8526 /* Read a sequence of keys that ends with a non prefix character,
8527 storing it in KEYBUF, a buffer of size BUFSIZE.
8529 Return the length of the key sequence stored.
8530 Return -1 if the user rejected a command menu.
8532 Echo starting immediately unless `prompt' is 0.
8534 Where a key sequence ends depends on the currently active keymaps.
8535 These include any minor mode keymaps active in the current buffer,
8536 the current buffer's local map, and the global map.
8538 If a key sequence has no other bindings, we check Vfunction_key_map
8539 to see if some trailing subsequence might be the beginning of a
8540 function key's sequence. If so, we try to read the whole function
8541 key, and substitute its symbolic name into the key sequence.
8543 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8544 `double-' events into similar click events, if that would make them
8545 bound. We try to turn `triple-' events first into `double-' events,
8548 If we get a mouse click in a mode line, vertical divider, or other
8549 non-text area, we treat the click as if it were prefixed by the
8550 symbol denoting that area - `mode-line', `vertical-line', or
8553 If the sequence starts with a mouse click, we read the key sequence
8554 with respect to the buffer clicked on, not the current buffer.
8556 If the user switches frames in the midst of a key sequence, we put
8557 off the switch-frame event until later; the next call to
8558 read_char will return it.
8560 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8561 from the selected window's buffer. */
8564 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8565 can_return_switch_frame
, fix_current_buffer
)
8566 Lisp_Object
*keybuf
;
8569 int dont_downcase_last
;
8570 int can_return_switch_frame
;
8571 int fix_current_buffer
;
8573 volatile Lisp_Object from_string
;
8574 volatile int count
= SPECPDL_INDEX ();
8576 /* How many keys there are in the current key sequence. */
8579 /* The length of the echo buffer when we started reading, and
8580 the length of this_command_keys when we started reading. */
8581 volatile int echo_start
;
8582 volatile int keys_start
;
8584 /* The number of keymaps we're scanning right now, and the number of
8585 keymaps we have allocated space for. */
8587 volatile int nmaps_allocated
= 0;
8589 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8590 the current keymaps. */
8591 Lisp_Object
*volatile defs
= NULL
;
8593 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8594 in the current keymaps, or nil where it is not a prefix. */
8595 Lisp_Object
*volatile submaps
= NULL
;
8597 /* The local map to start out with at start of key sequence. */
8598 volatile Lisp_Object orig_local_map
;
8600 /* The map from the `keymap' property to start out with at start of
8602 volatile Lisp_Object orig_keymap
;
8604 /* 1 if we have already considered switching to the local-map property
8605 of the place where a mouse click occurred. */
8606 volatile int localized_local_map
= 0;
8608 /* The index in defs[] of the first keymap that has a binding for
8609 this key sequence. In other words, the lowest i such that
8610 defs[i] is non-nil. */
8611 volatile int first_binding
;
8612 /* Index of the first key that has no binding.
8613 It is useless to try fkey.start larger than that. */
8614 volatile int first_unbound
;
8616 /* If t < mock_input, then KEYBUF[t] should be read as the next
8619 We use this to recover after recognizing a function key. Once we
8620 realize that a suffix of the current key sequence is actually a
8621 function key's escape sequence, we replace the suffix with the
8622 function key's binding from Vfunction_key_map. Now keybuf
8623 contains a new and different key sequence, so the echo area,
8624 this_command_keys, and the submaps and defs arrays are wrong. In
8625 this situation, we set mock_input to t, set t to 0, and jump to
8626 restart_sequence; the loop will read keys from keybuf up until
8627 mock_input, thus rebuilding the state; and then it will resume
8628 reading characters from the keyboard. */
8629 volatile int mock_input
= 0;
8631 /* If the sequence is unbound in submaps[], then
8632 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8633 and fkey.map is its binding.
8635 These might be > t, indicating that all function key scanning
8636 should hold off until t reaches them. We do this when we've just
8637 recognized a function key, to avoid searching for the function
8638 key's again in Vfunction_key_map. */
8639 volatile keyremap fkey
;
8641 /* Likewise, for key_translation_map. */
8642 volatile keyremap keytran
;
8644 /* If we receive a `switch-frame' or `select-window' event in the middle of
8645 a key sequence, we put it off for later.
8646 While we're reading, we keep the event here. */
8647 volatile Lisp_Object delayed_switch_frame
;
8649 /* See the comment below... */
8650 #if defined (GOBBLE_FIRST_EVENT)
8651 Lisp_Object first_event
;
8654 volatile Lisp_Object original_uppercase
;
8655 volatile int original_uppercase_position
= -1;
8657 /* Gets around Microsoft compiler limitations. */
8660 struct buffer
*starting_buffer
;
8662 /* List of events for which a fake prefix key has been generated. */
8663 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8665 #if defined (GOBBLE_FIRST_EVENT)
8669 struct gcpro gcpro1
;
8671 GCPRO1 (fake_prefixed_keys
);
8672 raw_keybuf_count
= 0;
8674 last_nonmenu_event
= Qnil
;
8676 delayed_switch_frame
= Qnil
;
8677 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8678 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8679 /* If there is no translation-map, turn off scanning. */
8680 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8681 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8686 echo_prompt (prompt
);
8687 else if (cursor_in_echo_area
8688 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8689 && NILP (Fzerop (Vecho_keystrokes
)))
8690 /* This doesn't put in a dash if the echo buffer is empty, so
8691 you don't always see a dash hanging out in the minibuffer. */
8695 /* Record the initial state of the echo area and this_command_keys;
8696 we will need to restore them if we replay a key sequence. */
8698 echo_start
= echo_length ();
8699 keys_start
= this_command_key_count
;
8700 this_single_command_key_start
= keys_start
;
8702 #if defined (GOBBLE_FIRST_EVENT)
8703 /* This doesn't quite work, because some of the things that read_char
8704 does cannot safely be bypassed. It seems too risky to try to make
8707 /* Read the first char of the sequence specially, before setting
8708 up any keymaps, in case a filter runs and switches buffers on us. */
8709 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8711 #endif /* GOBBLE_FIRST_EVENT */
8713 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8714 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8717 /* We jump here when the key sequence has been thoroughly changed, and
8718 we need to rescan it starting from the beginning. When we jump here,
8719 keybuf[0..mock_input] holds the sequence we should reread. */
8722 starting_buffer
= current_buffer
;
8723 first_unbound
= bufsize
+ 1;
8725 /* Build our list of keymaps.
8726 If we recognize a function key and replace its escape sequence in
8727 keybuf with its symbol, or if the sequence starts with a mouse
8728 click and we need to switch buffers, we jump back here to rebuild
8729 the initial keymaps from the current buffer. */
8732 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8733 || !NILP (Voverriding_local_map
))
8735 if (3 > nmaps_allocated
)
8737 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8738 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8739 nmaps_allocated
= 3;
8741 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8742 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8743 if (!NILP (Voverriding_local_map
))
8744 submaps
[nmaps
++] = Voverriding_local_map
;
8752 nminor
= current_minor_maps (0, &maps
);
8753 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8755 if (total
> nmaps_allocated
)
8757 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8758 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8759 nmaps_allocated
= total
;
8762 if (!NILP (orig_keymap
))
8763 submaps
[nmaps
++] = orig_keymap
;
8765 bcopy (maps
, (void *) (submaps
+ nmaps
),
8766 nminor
* sizeof (submaps
[0]));
8770 submaps
[nmaps
++] = orig_local_map
;
8772 submaps
[nmaps
++] = current_global_map
;
8774 /* Find an accurate initial value for first_binding. */
8775 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8776 if (! NILP (submaps
[first_binding
]))
8779 /* Start from the beginning in keybuf. */
8782 /* These are no-ops the first time through, but if we restart, they
8783 revert the echo area and this_command_keys to their original state. */
8784 this_command_key_count
= keys_start
;
8785 if (INTERACTIVE
&& t
< mock_input
)
8786 echo_truncate (echo_start
);
8788 /* If the best binding for the current key sequence is a keymap, or
8789 we may be looking at a function key's escape sequence, keep on
8791 while (first_binding
< nmaps
8792 /* Keep reading as long as there's a prefix binding. */
8793 ? !NILP (submaps
[first_binding
])
8794 /* Don't return in the middle of a possible function key sequence,
8795 if the only bindings we found were via case conversion.
8796 Thus, if ESC O a has a function-key-map translation
8797 and ESC o has a binding, don't return after ESC O,
8798 so that we can translate ESC O plus the next character. */
8799 : (fkey
.start
< t
|| keytran
.start
< t
))
8802 int used_mouse_menu
= 0;
8804 /* Where the last real key started. If we need to throw away a
8805 key that has expanded into more than one element of keybuf
8806 (say, a mouse click on the mode line which is being treated
8807 as [mode-line (mouse-...)], then we backtrack to this point
8809 volatile int last_real_key_start
;
8811 /* These variables are analogous to echo_start and keys_start;
8812 while those allow us to restart the entire key sequence,
8813 echo_local_start and keys_local_start allow us to throw away
8815 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8817 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8818 eassert (fkey
.start
<= fkey
.end
);
8819 eassert (keytran
.start
<= keytran
.end
);
8820 /* key-translation-map is applied *after* function-key-map. */
8821 eassert (keytran
.end
<= fkey
.start
);
8823 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8824 { /* The prefix upto first_unbound has no binding and has
8825 no translation left to do either, so we know it's unbound.
8826 If we don't stop now, we risk staying here indefinitely
8827 (if the user keeps entering fkey or keytran prefixes
8828 like C-c ESC ESC ESC ESC ...) */
8830 for (i
= first_unbound
+ 1; i
< t
; i
++)
8831 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8832 mock_input
= t
- first_unbound
- 1;
8833 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8834 fkey
.map
= fkey
.parent
;
8835 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8836 keytran
.map
= keytran
.parent
;
8837 goto replay_sequence
;
8841 error ("Key sequence too long");
8844 echo_local_start
= echo_length ();
8845 keys_local_start
= this_command_key_count
;
8846 local_first_binding
= first_binding
;
8849 /* These are no-ops, unless we throw away a keystroke below and
8850 jumped back up to replay_key; in that case, these restore the
8851 variables to their original state, allowing us to replay the
8853 if (INTERACTIVE
&& t
< mock_input
)
8854 echo_truncate (echo_local_start
);
8855 this_command_key_count
= keys_local_start
;
8856 first_binding
= local_first_binding
;
8858 /* By default, assume each event is "real". */
8859 last_real_key_start
= t
;
8861 /* Does mock_input indicate that we are re-reading a key sequence? */
8865 add_command_key (key
);
8866 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8867 && NILP (Fzerop (Vecho_keystrokes
)))
8871 /* If not, we should actually read a character. */
8876 KBOARD
*interrupted_kboard
= current_kboard
;
8877 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8878 if (setjmp (wrong_kboard_jmpbuf
))
8880 if (!NILP (delayed_switch_frame
))
8882 interrupted_kboard
->kbd_queue
8883 = Fcons (delayed_switch_frame
,
8884 interrupted_kboard
->kbd_queue
);
8885 delayed_switch_frame
= Qnil
;
8888 interrupted_kboard
->kbd_queue
8889 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8891 /* If the side queue is non-empty, ensure it begins with a
8892 switch-frame, so we'll replay it in the right context. */
8893 if (CONSP (interrupted_kboard
->kbd_queue
)
8894 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8895 !(EVENT_HAS_PARAMETERS (key
)
8896 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8900 XSETFRAME (frame
, interrupted_frame
);
8901 interrupted_kboard
->kbd_queue
8902 = Fcons (make_lispy_switch_frame (frame
),
8903 interrupted_kboard
->kbd_queue
);
8906 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8907 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8908 goto replay_sequence
;
8911 key
= read_char (NILP (prompt
), nmaps
,
8912 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8916 /* read_char returns t when it shows a menu and the user rejects it.
8920 unbind_to (count
, Qnil
);
8925 /* read_char returns -1 at the end of a macro.
8926 Emacs 18 handles this by returning immediately with a
8927 zero, so that's what we'll do. */
8928 if (INTEGERP (key
) && XINT (key
) == -1)
8931 /* The Microsoft C compiler can't handle the goto that
8937 /* If the current buffer has been changed from under us, the
8938 keymap may have changed, so replay the sequence. */
8941 EMACS_TIME initial_idleness_start_time
;
8942 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8943 EMACS_SECS (timer_last_idleness_start_time
),
8944 EMACS_USECS (timer_last_idleness_start_time
));
8946 /* Resume idle state, using the same start-time as before. */
8947 timer_start_idle ();
8948 timer_idleness_start_time
= initial_idleness_start_time
;
8951 /* Reset the current buffer from the selected window
8952 in case something changed the former and not the latter.
8953 This is to be more consistent with the behavior
8954 of the command_loop_1. */
8955 if (fix_current_buffer
)
8957 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8959 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8960 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8963 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8964 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8965 goto replay_sequence
;
8968 /* If we have a quit that was typed in another frame, and
8969 quit_throw_to_read_char switched buffers,
8970 replay to get the right keymap. */
8972 && XINT (key
) == quit_char
8973 && current_buffer
!= starting_buffer
)
8976 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8980 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8981 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8982 goto replay_sequence
;
8987 if (EVENT_HAS_PARAMETERS (key
)
8988 /* Either a `switch-frame' or a `select-window' event. */
8989 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8991 /* If we're at the beginning of a key sequence, and the caller
8992 says it's okay, go ahead and return this event. If we're
8993 in the midst of a key sequence, delay it until the end. */
8994 if (t
> 0 || !can_return_switch_frame
)
8996 delayed_switch_frame
= key
;
9002 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9005 /* Clicks in non-text areas get prefixed by the symbol
9006 in their CHAR-ADDRESS field. For example, a click on
9007 the mode line is prefixed by the symbol `mode-line'.
9009 Furthermore, key sequences beginning with mouse clicks
9010 are read using the keymaps of the buffer clicked on, not
9011 the current buffer. So we may have to switch the buffer
9014 When we turn one event into two events, we must make sure
9015 that neither of the two looks like the original--so that,
9016 if we replay the events, they won't be expanded again.
9017 If not for this, such reexpansion could happen either here
9018 or when user programs play with this-command-keys. */
9019 if (EVENT_HAS_PARAMETERS (key
))
9023 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9024 if (EQ (kind
, Qmouse_click
))
9026 Lisp_Object window
, posn
;
9028 window
= POSN_WINDOW (EVENT_START (key
));
9029 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
9032 || (!NILP (fake_prefixed_keys
)
9033 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9035 /* We're looking a second time at an event for which
9036 we generated a fake prefix key. Set
9037 last_real_key_start appropriately. */
9039 last_real_key_start
= t
- 1;
9042 /* Key sequences beginning with mouse clicks are
9043 read using the keymaps in the buffer clicked on,
9044 not the current buffer. If we're at the
9045 beginning of a key sequence, switch buffers. */
9046 if (last_real_key_start
== 0
9048 && BUFFERP (XWINDOW (window
)->buffer
)
9049 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9051 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9055 /* Arrange to go back to the original buffer once we're
9056 done reading the key sequence. Note that we can't
9057 use save_excursion_{save,restore} here, because they
9058 save point as well as the current buffer; we don't
9059 want to save point, because redisplay may change it,
9060 to accommodate a Fset_window_start or something. We
9061 don't want to do this at the top of the function,
9062 because we may get input from a subprocess which
9063 wants to change the selected window and stuff (say,
9065 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9067 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9069 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9070 orig_local_map
= get_local_map (PT
, current_buffer
,
9072 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9073 goto replay_sequence
;
9076 /* For a mouse click, get the local text-property keymap
9077 of the place clicked on, rather than point. */
9078 if (last_real_key_start
== 0
9079 && CONSP (XCDR (key
))
9080 && ! localized_local_map
)
9082 Lisp_Object map_here
, start
, pos
;
9084 localized_local_map
= 1;
9085 start
= EVENT_START (key
);
9087 if (CONSP (start
) && CONSP (XCDR (start
)))
9089 pos
= POSN_BUFFER_POSN (start
);
9091 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9093 map_here
= get_local_map (XINT (pos
),
9094 current_buffer
, Qlocal_map
);
9095 if (!EQ (map_here
, orig_local_map
))
9097 orig_local_map
= map_here
;
9101 goto replay_sequence
;
9103 map_here
= get_local_map (XINT (pos
),
9104 current_buffer
, Qkeymap
);
9105 if (!EQ (map_here
, orig_keymap
))
9107 orig_keymap
= map_here
;
9111 goto replay_sequence
;
9117 /* Expand mode-line and scroll-bar events into two events:
9118 use posn as a fake prefix key. */
9120 && (NILP (fake_prefixed_keys
)
9121 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9123 if (t
+ 1 >= bufsize
)
9124 error ("Key sequence too long");
9127 keybuf
[t
+ 1] = key
;
9130 /* Record that a fake prefix key has been generated
9131 for KEY. Don't modify the event; this would
9132 prevent proper action when the event is pushed
9133 back into unread-command-events. */
9134 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9136 /* If on a mode line string with a local keymap,
9137 reconsider the key sequence with that keymap. */
9138 if (CONSP (POSN_STRING (EVENT_START (key
))))
9140 Lisp_Object string
, pos
, map
, map2
;
9142 string
= POSN_STRING (EVENT_START (key
));
9143 pos
= XCDR (string
);
9144 string
= XCAR (string
);
9146 && XINT (pos
) < SCHARS (string
))
9148 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9150 orig_local_map
= map
;
9151 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9154 if (!NILP (map
) || !NILP (map2
))
9155 goto replay_sequence
;
9161 else if (CONSP (POSN_STRING (EVENT_START (key
)))
9162 && NILP (from_string
))
9164 /* For a click on a string, i.e. overlay string or a
9165 string displayed via the `display' property,
9166 consider `local-map' and `keymap' properties of
9168 Lisp_Object string
, pos
, map
, map2
;
9170 string
= POSN_STRING (EVENT_START (key
));
9171 pos
= XCDR (string
);
9172 string
= XCAR (string
);
9174 && XINT (pos
) < SCHARS (string
))
9176 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9178 orig_local_map
= map
;
9179 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9183 if (!NILP (map
) || !NILP (map2
))
9185 from_string
= string
;
9186 goto replay_sequence
;
9191 else if (CONSP (XCDR (key
))
9192 && CONSP (EVENT_START (key
))
9193 && CONSP (XCDR (EVENT_START (key
))))
9197 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
9198 /* Handle menu-bar events:
9199 insert the dummy prefix event `menu-bar'. */
9200 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9202 if (t
+ 1 >= bufsize
)
9203 error ("Key sequence too long");
9207 /* Zap the position in key, so we know that we've
9208 expanded it, and don't try to do so again. */
9209 POSN_BUFFER_SET_POSN (EVENT_START (key
),
9210 Fcons (posn
, Qnil
));
9213 goto replay_sequence
;
9215 else if (CONSP (posn
))
9217 /* We're looking at the second event of a
9218 sequence which we expanded before. Set
9219 last_real_key_start appropriately. */
9220 if (last_real_key_start
== t
&& t
> 0)
9221 last_real_key_start
= t
- 1;
9226 /* We have finally decided that KEY is something we might want
9228 first_binding
= (follow_key (key
,
9229 nmaps
- first_binding
,
9230 submaps
+ first_binding
,
9231 defs
+ first_binding
,
9232 submaps
+ first_binding
)
9235 /* If KEY wasn't bound, we'll try some fallbacks. */
9236 if (first_binding
< nmaps
)
9237 /* This is needed for the following scenario:
9238 event 0: a down-event that gets dropped by calling replay_key.
9239 event 1: some normal prefix like C-h.
9240 After event 0, first_unbound is 0, after event 1 fkey.start
9241 and keytran.start are both 1, so when we see that C-h is bound,
9242 we need to update first_unbound. */
9243 first_unbound
= max (t
+ 1, first_unbound
);
9248 /* Remember the position to put an upper bound on fkey.start. */
9249 first_unbound
= min (t
, first_unbound
);
9251 head
= EVENT_HEAD (key
);
9252 if (help_char_p (head
) && t
> 0)
9254 read_key_sequence_cmd
= Vprefix_help_command
;
9256 last_nonmenu_event
= key
;
9257 /* The Microsoft C compiler can't handle the goto that
9265 Lisp_Object breakdown
;
9268 breakdown
= parse_modifiers (head
);
9269 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9270 /* Attempt to reduce an unbound mouse event to a simpler
9271 event that is bound:
9272 Drags reduce to clicks.
9273 Double-clicks reduce to clicks.
9274 Triple-clicks reduce to double-clicks, then to clicks.
9275 Down-clicks are eliminated.
9276 Double-downs reduce to downs, then are eliminated.
9277 Triple-downs reduce to double-downs, then to downs,
9278 then are eliminated. */
9279 if (modifiers
& (down_modifier
| drag_modifier
9280 | double_modifier
| triple_modifier
))
9282 while (modifiers
& (down_modifier
| drag_modifier
9283 | double_modifier
| triple_modifier
))
9285 Lisp_Object new_head
, new_click
;
9286 if (modifiers
& triple_modifier
)
9287 modifiers
^= (double_modifier
| triple_modifier
);
9288 else if (modifiers
& double_modifier
)
9289 modifiers
&= ~double_modifier
;
9290 else if (modifiers
& drag_modifier
)
9291 modifiers
&= ~drag_modifier
;
9294 /* Dispose of this `down' event by simply jumping
9295 back to replay_key, to get another event.
9297 Note that if this event came from mock input,
9298 then just jumping back to replay_key will just
9299 hand it to us again. So we have to wipe out any
9302 We could delete keybuf[t] and shift everything
9303 after that to the left by one spot, but we'd also
9304 have to fix up any variable that points into
9305 keybuf, and shifting isn't really necessary
9308 Adding prefixes for non-textual mouse clicks
9309 creates two characters of mock input, and both
9310 must be thrown away. If we're only looking at
9311 the prefix now, we can just jump back to
9312 replay_key. On the other hand, if we've already
9313 processed the prefix, and now the actual click
9314 itself is giving us trouble, then we've lost the
9315 state of the keymaps we want to backtrack to, and
9316 we need to replay the whole sequence to rebuild
9319 Beyond that, only function key expansion could
9320 create more than two keys, but that should never
9321 generate mouse events, so it's okay to zero
9322 mock_input in that case too.
9324 FIXME: The above paragraph seems just plain
9325 wrong, if you consider things like
9326 xterm-mouse-mode. -stef
9328 Isn't this just the most wonderful code ever? */
9330 /* If mock_input > t + 1, the above simplification
9331 will actually end up dropping keys on the floor.
9332 This is probably OK for now, but even
9333 if mock_input <= t + 1, we need to adjust fkey
9335 Typical case [header-line down-mouse-N]:
9336 mock_input = 2, t = 1, fkey.end = 1,
9337 last_real_key_start = 0. */
9338 if (fkey
.end
> last_real_key_start
)
9340 fkey
.end
= fkey
.start
9341 = min (last_real_key_start
, fkey
.start
);
9342 fkey
.map
= fkey
.parent
;
9343 if (keytran
.end
> last_real_key_start
)
9345 keytran
.end
= keytran
.start
9346 = min (last_real_key_start
, keytran
.start
);
9347 keytran
.map
= keytran
.parent
;
9350 if (t
== last_real_key_start
)
9357 mock_input
= last_real_key_start
;
9358 goto replay_sequence
;
9363 = apply_modifiers (modifiers
, XCAR (breakdown
));
9365 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9367 /* Look for a binding for this new key. follow_key
9368 promises that it didn't munge submaps the
9369 last time we called it, since key was unbound. */
9371 = (follow_key (new_click
,
9372 nmaps
- local_first_binding
,
9373 submaps
+ local_first_binding
,
9374 defs
+ local_first_binding
,
9375 submaps
+ local_first_binding
)
9376 + local_first_binding
);
9378 /* If that click is bound, go for it. */
9379 if (first_binding
< nmaps
)
9384 /* Otherwise, we'll leave key set to the drag event. */
9391 /* Normally, last_nonmenu_event gets the previous key we read.
9392 But when a mouse popup menu is being used,
9393 we don't update last_nonmenu_event; it continues to hold the mouse
9394 event that preceded the first level of menu. */
9395 if (!used_mouse_menu
)
9396 last_nonmenu_event
= key
;
9398 /* Record what part of this_command_keys is the current key sequence. */
9399 this_single_command_key_start
= this_command_key_count
- t
;
9401 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9402 /* There is a binding and it's not a prefix.
9403 There is thus no function-key in this sequence.
9404 Moving fkey.start is important in this case to allow keytran.start
9405 to go over the sequence before we return (since we keep the
9406 invariant that keytran.end <= fkey.start). */
9409 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9412 /* If the sequence is unbound, see if we can hang a function key
9413 off the end of it. */
9414 /* Continue scan from fkey.end until we find a bound suffix. */
9415 while (fkey
.end
< t
)
9417 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9420 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9421 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9422 max (t
, mock_input
),
9423 /* If there's a binding (i.e.
9424 first_binding >= nmaps) we don't want
9425 to apply this function-key-mapping. */
9426 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9431 mock_input
= diff
+ max (t
, mock_input
);
9432 goto replay_sequence
;
9436 /* Look for this sequence in key-translation-map.
9437 Scan from keytran.end until we find a bound suffix. */
9438 while (keytran
.end
< fkey
.start
)
9440 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9443 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9444 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9449 mock_input
= diff
+ max (t
, mock_input
);
9450 /* Adjust the function-key-map counters. */
9454 goto replay_sequence
;
9458 /* If KEY is not defined in any of the keymaps,
9459 and cannot be part of a function key or translation,
9460 and is an upper case letter
9461 use the corresponding lower-case letter instead. */
9462 if (first_binding
>= nmaps
9463 && fkey
.start
>= t
&& keytran
.start
>= t
9465 && ((((XINT (key
) & 0x3ffff)
9466 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9467 && UPPERCASEP (XINT (key
) & 0x3ffff))
9468 || (XINT (key
) & shift_modifier
)))
9470 Lisp_Object new_key
;
9472 original_uppercase
= key
;
9473 original_uppercase_position
= t
- 1;
9475 if (XINT (key
) & shift_modifier
)
9476 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9478 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9479 | (XINT (key
) & ~0x3ffff)));
9481 /* We have to do this unconditionally, regardless of whether
9482 the lower-case char is defined in the keymaps, because they
9483 might get translated through function-key-map. */
9484 keybuf
[t
- 1] = new_key
;
9485 mock_input
= max (t
, mock_input
);
9487 goto replay_sequence
;
9489 /* If KEY is not defined in any of the keymaps,
9490 and cannot be part of a function key or translation,
9491 and is a shifted function key,
9492 use the corresponding unshifted function key instead. */
9493 if (first_binding
>= nmaps
9494 && fkey
.start
>= t
&& keytran
.start
>= t
9497 Lisp_Object breakdown
;
9500 breakdown
= parse_modifiers (key
);
9501 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9502 if (modifiers
& shift_modifier
)
9504 Lisp_Object new_key
;
9506 original_uppercase
= key
;
9507 original_uppercase_position
= t
- 1;
9509 modifiers
&= ~shift_modifier
;
9510 new_key
= apply_modifiers (modifiers
,
9513 keybuf
[t
- 1] = new_key
;
9514 mock_input
= max (t
, mock_input
);
9516 goto replay_sequence
;
9522 read_key_sequence_cmd
= (first_binding
< nmaps
9523 ? defs
[first_binding
]
9526 unread_switch_frame
= delayed_switch_frame
;
9527 unbind_to (count
, Qnil
);
9529 /* Don't downcase the last character if the caller says don't.
9530 Don't downcase it if the result is undefined, either. */
9531 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9532 && t
- 1 == original_uppercase_position
)
9533 keybuf
[t
- 1] = original_uppercase
;
9535 /* Occasionally we fabricate events, perhaps by expanding something
9536 according to function-key-map, or by adding a prefix symbol to a
9537 mouse click in the scroll bar or modeline. In this cases, return
9538 the entire generated key sequence, even if we hit an unbound
9539 prefix or a definition before the end. This means that you will
9540 be able to push back the event properly, and also means that
9541 read-key-sequence will always return a logical unit.
9544 for (; t
< mock_input
; t
++)
9546 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9547 && NILP (Fzerop (Vecho_keystrokes
)))
9548 echo_char (keybuf
[t
]);
9549 add_command_key (keybuf
[t
]);
9558 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9559 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9560 The sequence is sufficient to specify a non-prefix command in the
9561 current local and global maps.
9563 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9564 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9565 as a continuation of the previous key.
9567 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9568 convert the last event to lower case. (Normally any upper case event
9569 is converted to lower case if the original event is undefined and the lower
9570 case equivalent is defined.) A non-nil value is appropriate for reading
9571 a key sequence to be defined.
9573 A C-g typed while in this function is treated like any other character,
9574 and `quit-flag' is not set.
9576 If the key sequence starts with a mouse click, then the sequence is read
9577 using the keymaps of the buffer of the window clicked in, not the buffer
9578 of the selected window as normal.
9580 `read-key-sequence' drops unbound button-down events, since you normally
9581 only care about the click or drag events which follow them. If a drag
9582 or multi-click event is unbound, but the corresponding click event would
9583 be bound, `read-key-sequence' turns the event into a click event at the
9584 drag's starting position. This means that you don't have to distinguish
9585 between click and drag, double, or triple events unless you want to.
9587 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9588 lines separating windows, and scroll bars with imaginary keys
9589 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9591 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9592 function will process a switch-frame event if the user switches frames
9593 before typing anything. If the user switches frames in the middle of a
9594 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9595 is nil, then the event will be put off until after the current key sequence.
9597 `read-key-sequence' checks `function-key-map' for function key
9598 sequences, where they wouldn't conflict with ordinary bindings. See
9599 `function-key-map' for more details.
9601 The optional fifth argument COMMAND-LOOP, if non-nil, means
9602 that this key sequence is being read by something that will
9603 read commands one after another. It should be nil if the caller
9604 will read just one key sequence. */)
9605 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9607 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9608 Lisp_Object can_return_switch_frame
, command_loop
;
9610 Lisp_Object keybuf
[30];
9612 struct gcpro gcpro1
;
9613 int count
= SPECPDL_INDEX ();
9616 CHECK_STRING (prompt
);
9619 specbind (Qinput_method_exit_on_first_char
,
9620 (NILP (command_loop
) ? Qt
: Qnil
));
9621 specbind (Qinput_method_use_echo_area
,
9622 (NILP (command_loop
) ? Qt
: Qnil
));
9624 bzero (keybuf
, sizeof keybuf
);
9626 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9628 if (NILP (continue_echo
))
9630 this_command_key_count
= 0;
9631 this_command_key_count_reset
= 0;
9632 this_single_command_key_start
= 0;
9635 #ifdef HAVE_X_WINDOWS
9636 if (display_hourglass_p
)
9637 cancel_hourglass ();
9640 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9641 prompt
, ! NILP (dont_downcase_last
),
9642 ! NILP (can_return_switch_frame
), 0);
9644 #if 0 /* The following is fine for code reading a key sequence and
9645 then proceeding with a lenghty computation, but it's not good
9646 for code reading keys in a loop, like an input method. */
9647 #ifdef HAVE_X_WINDOWS
9648 if (display_hourglass_p
)
9659 return unbind_to (count
, make_event_array (i
, keybuf
));
9662 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9663 Sread_key_sequence_vector
, 1, 5, 0,
9664 doc
: /* Like `read-key-sequence' but always return a vector. */)
9665 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9667 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9668 Lisp_Object can_return_switch_frame
, command_loop
;
9670 Lisp_Object keybuf
[30];
9672 struct gcpro gcpro1
;
9673 int count
= SPECPDL_INDEX ();
9676 CHECK_STRING (prompt
);
9679 specbind (Qinput_method_exit_on_first_char
,
9680 (NILP (command_loop
) ? Qt
: Qnil
));
9681 specbind (Qinput_method_use_echo_area
,
9682 (NILP (command_loop
) ? Qt
: Qnil
));
9684 bzero (keybuf
, sizeof keybuf
);
9686 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9688 if (NILP (continue_echo
))
9690 this_command_key_count
= 0;
9691 this_command_key_count_reset
= 0;
9692 this_single_command_key_start
= 0;
9695 #ifdef HAVE_X_WINDOWS
9696 if (display_hourglass_p
)
9697 cancel_hourglass ();
9700 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9701 prompt
, ! NILP (dont_downcase_last
),
9702 ! NILP (can_return_switch_frame
), 0);
9704 #ifdef HAVE_X_WINDOWS
9705 if (display_hourglass_p
)
9715 return unbind_to (count
, Fvector (i
, keybuf
));
9718 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9719 doc
: /* Execute CMD as an editor command.
9720 CMD must be a symbol that satisfies the `commandp' predicate.
9721 Optional second arg RECORD-FLAG non-nil
9722 means unconditionally put this command in `command-history'.
9723 Otherwise, that is done only if an arg is read using the minibuffer.
9724 The argument KEYS specifies the value to use instead of (this-command-keys)
9725 when reading the arguments; if it is nil, (this-command-keys) is used.
9726 The argument SPECIAL, if non-nil, means that this command is executing
9727 a special event, so ignore the prefix argument and don't clear it. */)
9728 (cmd
, record_flag
, keys
, special
)
9729 Lisp_Object cmd
, record_flag
, keys
, special
;
9731 register Lisp_Object final
;
9732 register Lisp_Object tem
;
9733 Lisp_Object prefixarg
;
9734 struct backtrace backtrace
;
9735 extern int debug_on_next_call
;
9737 debug_on_next_call
= 0;
9741 prefixarg
= current_kboard
->Vprefix_arg
;
9742 Vcurrent_prefix_arg
= prefixarg
;
9743 current_kboard
->Vprefix_arg
= Qnil
;
9750 tem
= Fget (cmd
, Qdisabled
);
9751 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9753 tem
= Fsymbol_value (Qdisabled_command_hook
);
9755 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9761 final
= Findirect_function (cmd
);
9763 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9765 struct gcpro gcpro1
, gcpro2
;
9767 GCPRO2 (cmd
, prefixarg
);
9768 do_autoload (final
, cmd
);
9775 if (STRINGP (final
) || VECTORP (final
))
9777 /* If requested, place the macro in the command history. For
9778 other sorts of commands, call-interactively takes care of
9780 if (!NILP (record_flag
))
9783 = Fcons (Fcons (Qexecute_kbd_macro
,
9784 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9787 /* Don't keep command history around forever. */
9788 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9790 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9792 XSETCDR (tem
, Qnil
);
9796 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9799 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9801 backtrace
.next
= backtrace_list
;
9802 backtrace_list
= &backtrace
;
9803 backtrace
.function
= &Qcall_interactively
;
9804 backtrace
.args
= &cmd
;
9805 backtrace
.nargs
= 1;
9806 backtrace
.evalargs
= 0;
9808 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9810 backtrace_list
= backtrace
.next
;
9818 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9820 doc
: /* Read function name, then read its arguments and call it. */)
9822 Lisp_Object prefixarg
;
9824 Lisp_Object function
;
9826 int saved_last_point_position
;
9827 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9828 Lisp_Object bindings
, value
;
9829 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9831 saved_keys
= Fvector (this_command_key_count
,
9832 XVECTOR (this_command_keys
)->contents
);
9833 saved_last_point_position_buffer
= last_point_position_buffer
;
9834 saved_last_point_position
= last_point_position
;
9836 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9838 if (EQ (prefixarg
, Qminus
))
9840 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9841 strcpy (buf
, "C-u ");
9842 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9844 if (sizeof (int) == sizeof (EMACS_INT
))
9845 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9846 else if (sizeof (long) == sizeof (EMACS_INT
))
9847 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9851 else if (INTEGERP (prefixarg
))
9853 if (sizeof (int) == sizeof (EMACS_INT
))
9854 sprintf (buf
, "%d ", XINT (prefixarg
));
9855 else if (sizeof (long) == sizeof (EMACS_INT
))
9856 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9861 /* This isn't strictly correct if execute-extended-command
9862 is bound to anything else. Perhaps it should use
9863 this_command_keys? */
9864 strcat (buf
, "M-x ");
9866 /* Prompt with buf, and then read a string, completing from and
9867 restricting to the set of all defined commands. Don't provide
9868 any initial input. Save the command read on the extended-command
9870 function
= Fcompleting_read (build_string (buf
),
9871 Vobarray
, Qcommandp
,
9872 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9875 if (STRINGP (function
) && SCHARS (function
) == 0)
9876 error ("No command name given");
9878 /* Set this_command_keys to the concatenation of saved_keys and
9879 function, followed by a RET. */
9884 this_command_key_count
= 0;
9885 this_command_key_count_reset
= 0;
9886 this_single_command_key_start
= 0;
9888 keys
= XVECTOR (saved_keys
)->contents
;
9889 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9890 add_command_key (keys
[i
]);
9892 for (i
= 0; i
< SCHARS (function
); i
++)
9893 add_command_key (Faref (function
, make_number (i
)));
9895 add_command_key (make_number ('\015'));
9898 last_point_position
= saved_last_point_position
;
9899 last_point_position_buffer
= saved_last_point_position_buffer
;
9903 function
= Fintern (function
, Qnil
);
9904 current_kboard
->Vprefix_arg
= prefixarg
;
9905 Vthis_command
= function
;
9906 real_this_command
= function
;
9908 /* If enabled, show which key runs this command. */
9909 if (!NILP (Vsuggest_key_bindings
)
9910 && NILP (Vexecuting_macro
)
9911 && SYMBOLP (function
))
9912 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9918 GCPRO2 (bindings
, value
);
9919 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9921 /* If the command has a key binding, print it now. */
9922 if (!NILP (bindings
)
9923 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9926 /* But first wait, and skip the message if there is input. */
9928 if (!NILP (echo_area_buffer
[0]))
9929 /* This command displayed something in the echo area;
9930 so wait a few seconds, then display our suggestion message. */
9931 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9932 ? XINT (Vsuggest_key_bindings
) : 2);
9934 /* This command left the echo area empty,
9935 so display our message immediately. */
9938 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9939 && ! CONSP (Vunread_command_events
))
9941 Lisp_Object binding
;
9943 int message_p
= push_message ();
9944 int count
= SPECPDL_INDEX ();
9946 record_unwind_protect (pop_message_unwind
, Qnil
);
9947 binding
= Fkey_description (bindings
);
9950 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9953 sprintf (newmessage
, "You can run the command `%s' with %s",
9954 SDATA (SYMBOL_NAME (function
)),
9956 message2_nolog (newmessage
,
9957 strlen (newmessage
),
9958 STRING_MULTIBYTE (binding
));
9959 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9960 ? Vsuggest_key_bindings
: make_number (2)),
9965 unbind_to (count
, Qnil
);
9969 RETURN_UNGCPRO (value
);
9973 /* Return nonzero if input events are pending. */
9976 detect_input_pending ()
9979 get_input_pending (&input_pending
, 0);
9981 return input_pending
;
9984 /* Return nonzero if input events are pending, and run any pending timers. */
9987 detect_input_pending_run_timers (do_display
)
9990 int old_timers_run
= timers_run
;
9993 get_input_pending (&input_pending
, 1);
9995 if (old_timers_run
!= timers_run
&& do_display
)
9997 redisplay_preserve_echo_area (8);
9998 /* The following fixes a bug when using lazy-lock with
9999 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10000 from an idle timer function. The symptom of the bug is that
10001 the cursor sometimes doesn't become visible until the next X
10002 event is processed. --gerd. */
10004 rif
->flush_display (NULL
);
10007 return input_pending
;
10010 /* This is called in some cases before a possible quit.
10011 It cases the next call to detect_input_pending to recompute input_pending.
10012 So calling this function unnecessarily can't do any harm. */
10015 clear_input_pending ()
10020 /* Return nonzero if there are pending requeued events.
10021 This isn't used yet. The hope is to make wait_reading_process_input
10022 call it, and return if it runs Lisp code that unreads something.
10023 The problem is, kbd_buffer_get_event needs to be fixed to know what
10024 to do in that case. It isn't trivial. */
10027 requeued_events_pending_p ()
10029 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10033 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10034 doc
: /* Return t if command input is currently available with no wait.
10035 Actually, the value is nil only if we can be sure that no input is available;
10036 if there is a doubt, the value is t. */)
10039 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10042 get_filtered_input_pending (&input_pending
, 1, 1);
10043 return input_pending
> 0 ? Qt
: Qnil
;
10046 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10047 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10050 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10053 if (total_keys
< NUM_RECENT_KEYS
)
10054 return Fvector (total_keys
, keys
);
10057 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10058 bcopy (keys
+ recent_keys_index
,
10059 XVECTOR (val
)->contents
,
10060 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10062 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10063 recent_keys_index
* sizeof (Lisp_Object
));
10068 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10069 doc
: /* Return the key sequence that invoked this command.
10070 However, if the command has called `read-key-sequence', it returns
10071 the last key sequence that has been read.
10072 The value is a string or a vector. */)
10075 return make_event_array (this_command_key_count
,
10076 XVECTOR (this_command_keys
)->contents
);
10079 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10080 doc
: /* Return the key sequence that invoked this command, as a vector.
10081 However, if the command has called `read-key-sequence', it returns
10082 the last key sequence that has been read. */)
10085 return Fvector (this_command_key_count
,
10086 XVECTOR (this_command_keys
)->contents
);
10089 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10090 Sthis_single_command_keys
, 0, 0, 0,
10091 doc
: /* Return the key sequence that invoked this command.
10092 More generally, it returns the last key sequence read, either by
10093 the command loop or by `read-key-sequence'.
10094 Unlike `this-command-keys', this function's value
10095 does not include prefix arguments.
10096 The value is always a vector. */)
10099 return Fvector (this_command_key_count
10100 - this_single_command_key_start
,
10101 (XVECTOR (this_command_keys
)->contents
10102 + this_single_command_key_start
));
10105 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10106 Sthis_single_command_raw_keys
, 0, 0, 0,
10107 doc
: /* Return the raw events that were read for this command.
10108 More generally, it returns the last key sequence read, either by
10109 the command loop or by `read-key-sequence'.
10110 Unlike `this-single-command-keys', this function's value
10111 shows the events before all translations (except for input methods).
10112 The value is always a vector. */)
10115 return Fvector (raw_keybuf_count
,
10116 (XVECTOR (raw_keybuf
)->contents
));
10119 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10120 Sreset_this_command_lengths
, 0, 0, 0,
10121 doc
: /* Make the unread events replace the last command and echo.
10122 Used in `universal-argument-other-key'.
10124 `universal-argument-other-key' rereads the event just typed.
10125 It then gets translated through `function-key-map'.
10126 The translated event has to replace the real events,
10127 both in the value of (this-command-keys) and in echoing.
10128 To achieve this, `universal-argument-other-key' calls
10129 `reset-this-command-lengths', which discards the record of reading
10130 these events the first time. */)
10133 this_command_key_count
= before_command_key_count
;
10134 if (this_command_key_count
< this_single_command_key_start
)
10135 this_single_command_key_start
= this_command_key_count
;
10137 echo_truncate (before_command_echo_length
);
10139 /* Cause whatever we put into unread-command-events
10140 to echo as if it were being freshly read from the keyboard. */
10141 this_command_key_count_reset
= 1;
10146 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10147 Sclear_this_command_keys
, 0, 1, 0,
10148 doc
: /* Clear out the vector that `this-command-keys' returns.
10149 Also clear the record of the last 100 events, unless optional arg
10150 KEEP-RECORD is non-nil. */)
10152 Lisp_Object keep_record
;
10156 this_command_key_count
= 0;
10157 this_command_key_count_reset
= 0;
10159 if (NILP (keep_record
))
10161 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10162 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10164 recent_keys_index
= 0;
10169 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10170 doc
: /* Return the current depth in recursive edits. */)
10174 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10178 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10179 "FOpen dribble file: ",
10180 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10181 If FILE is nil, close any open dribble file. */)
10192 file
= Fexpand_file_name (file
, Qnil
);
10193 dribble
= fopen (SDATA (file
), "w");
10195 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10200 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10201 doc
: /* Discard the contents of the terminal input buffer.
10202 Also end any kbd macro being defined. */)
10205 if (!NILP (current_kboard
->defining_kbd_macro
))
10207 /* Discard the last command from the macro. */
10208 Fcancel_kbd_macro_events ();
10212 update_mode_lines
++;
10214 Vunread_command_events
= Qnil
;
10215 unread_command_char
= -1;
10217 discard_tty_input ();
10219 kbd_fetch_ptr
= kbd_store_ptr
;
10220 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10226 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10227 doc
: /* Stop Emacs and return to superior process. You can resume later.
10228 If `cannot-suspend' is non-nil, or if the system doesn't support job
10229 control, run a subshell instead.
10231 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10232 to be read as terminal input by Emacs's parent, after suspension.
10234 Before suspending, run the normal hook `suspend-hook'.
10235 After resumption run the normal hook `suspend-resume-hook'.
10237 Some operating systems cannot stop the Emacs process and resume it later.
10238 On such systems, Emacs starts a subshell instead of suspending. */)
10240 Lisp_Object stuffstring
;
10242 int count
= SPECPDL_INDEX ();
10243 int old_height
, old_width
;
10245 struct gcpro gcpro1
;
10247 if (!NILP (stuffstring
))
10248 CHECK_STRING (stuffstring
);
10250 /* Run the functions in suspend-hook. */
10251 if (!NILP (Vrun_hooks
))
10252 call1 (Vrun_hooks
, intern ("suspend-hook"));
10254 GCPRO1 (stuffstring
);
10255 get_frame_size (&old_width
, &old_height
);
10256 reset_sys_modes ();
10257 /* sys_suspend can get an error if it tries to fork a subshell
10258 and the system resources aren't available for that. */
10259 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10261 stuff_buffered_input (stuffstring
);
10262 if (cannot_suspend
)
10266 unbind_to (count
, Qnil
);
10268 /* Check if terminal/window size has changed.
10269 Note that this is not useful when we are running directly
10270 with a window system; but suspend should be disabled in that case. */
10271 get_frame_size (&width
, &height
);
10272 if (width
!= old_width
|| height
!= old_height
)
10273 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10275 /* Run suspend-resume-hook. */
10276 if (!NILP (Vrun_hooks
))
10277 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10283 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10284 Then in any case stuff anything Emacs has read ahead and not used. */
10287 stuff_buffered_input (stuffstring
)
10288 Lisp_Object stuffstring
;
10290 /* stuff_char works only in BSD, versions 4.2 and up. */
10293 register unsigned char *p
;
10295 if (STRINGP (stuffstring
))
10297 register int count
;
10299 p
= SDATA (stuffstring
);
10300 count
= SBYTES (stuffstring
);
10301 while (count
-- > 0)
10306 /* Anything we have read ahead, put back for the shell to read. */
10307 /* ?? What should this do when we have multiple keyboards??
10308 Should we ignore anything that was typed in at the "wrong" kboard? */
10309 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10313 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10314 kbd_fetch_ptr
= kbd_buffer
;
10315 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10316 stuff_char (kbd_fetch_ptr
->code
);
10318 kbd_fetch_ptr
->kind
= NO_EVENT
;
10319 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10320 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10321 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10326 #endif /* BSD_SYSTEM and not BSD4_1 */
10330 set_waiting_for_input (time_to_clear
)
10331 EMACS_TIME
*time_to_clear
;
10333 input_available_clear_time
= time_to_clear
;
10335 /* Tell interrupt_signal to throw back to read_char, */
10336 waiting_for_input
= 1;
10338 /* If interrupt_signal was called before and buffered a C-g,
10339 make it run again now, to avoid timing error. */
10340 if (!NILP (Vquit_flag
))
10341 quit_throw_to_read_char ();
10345 clear_waiting_for_input ()
10347 /* Tell interrupt_signal not to throw back to read_char, */
10348 waiting_for_input
= 0;
10349 input_available_clear_time
= 0;
10352 /* This routine is called at interrupt level in response to C-g.
10354 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10355 is called from kbd_buffer_store_event, in handling SIGIO or
10358 If `waiting_for_input' is non zero, then unless `echoing' is
10359 nonzero, immediately throw back to read_char.
10361 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10362 eval to throw, when it gets a chance. If quit-flag is already
10363 non-nil, it stops the job right away. */
10366 interrupt_signal (signalnum
) /* If we don't have an argument, */
10367 int signalnum
; /* some compilers complain in signal calls. */
10370 /* Must preserve main program's value of errno. */
10371 int old_errno
= errno
;
10372 struct frame
*sf
= SELECTED_FRAME ();
10374 #if defined (USG) && !defined (POSIX_SIGNALS)
10375 if (!read_socket_hook
&& NILP (Vwindow_system
))
10377 /* USG systems forget handlers when they are used;
10378 must reestablish each time */
10379 signal (SIGINT
, interrupt_signal
);
10380 signal (SIGQUIT
, interrupt_signal
);
10386 if (!NILP (Vquit_flag
)
10387 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10389 /* If SIGINT isn't blocked, don't let us be interrupted by
10390 another SIGINT, it might be harmful due to non-reentrancy
10391 in I/O functions. */
10392 sigblock (sigmask (SIGINT
));
10395 reset_sys_modes ();
10397 #ifdef SIGTSTP /* Support possible in later USG versions */
10399 * On systems which can suspend the current process and return to the original
10400 * shell, this command causes the user to end up back at the shell.
10401 * The "Auto-save" and "Abort" questions are not asked until
10402 * the user elects to return to emacs, at which point he can save the current
10403 * job and either dump core or continue.
10408 if (sys_suspend () == -1)
10410 printf ("Not running as a subprocess;\n");
10411 printf ("you can continue or abort.\n");
10413 #else /* not VMS */
10414 /* Perhaps should really fork an inferior shell?
10415 But that would not provide any way to get back
10416 to the original shell, ever. */
10417 printf ("No support for stopping a process on this operating system;\n");
10418 printf ("you can continue or abort.\n");
10419 #endif /* not VMS */
10420 #endif /* not SIGTSTP */
10422 /* We must remain inside the screen area when the internal terminal
10423 is used. Note that [Enter] is not echoed by dos. */
10426 /* It doesn't work to autosave while GC is in progress;
10427 the code used for auto-saving doesn't cope with the mark bit. */
10428 if (!gc_in_progress
)
10430 printf ("Auto-save? (y or n) ");
10432 if (((c
= getchar ()) & ~040) == 'Y')
10434 Fdo_auto_save (Qt
, Qnil
);
10436 printf ("\r\nAuto-save done");
10437 #else /* not MSDOS */
10438 printf ("Auto-save done\n");
10439 #endif /* not MSDOS */
10441 while (c
!= '\n') c
= getchar ();
10445 /* During GC, it must be safe to reenable quitting again. */
10446 Vinhibit_quit
= Qnil
;
10449 #endif /* not MSDOS */
10450 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10451 printf ("but will instead do a real quit after garbage collection ends\r\n");
10456 printf ("\r\nAbort? (y or n) ");
10457 #else /* not MSDOS */
10459 printf ("Abort (and enter debugger)? (y or n) ");
10460 #else /* not VMS */
10461 printf ("Abort (and dump core)? (y or n) ");
10462 #endif /* not VMS */
10463 #endif /* not MSDOS */
10465 if (((c
= getchar ()) & ~040) == 'Y')
10467 while (c
!= '\n') c
= getchar ();
10469 printf ("\r\nContinuing...\r\n");
10470 #else /* not MSDOS */
10471 printf ("Continuing...\n");
10472 #endif /* not MSDOS */
10479 /* If executing a function that wants to be interrupted out of
10480 and the user has not deferred quitting by binding `inhibit-quit'
10481 then quit right away. */
10482 if (immediate_quit
&& NILP (Vinhibit_quit
))
10484 struct gl_state_s saved
;
10485 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10487 immediate_quit
= 0;
10490 GCPRO4 (saved
.object
, saved
.global_code
,
10491 saved
.current_syntax_table
, saved
.old_prop
);
10492 Fsignal (Qquit
, Qnil
);
10497 /* Else request quit when it's safe */
10501 if (waiting_for_input
&& !echoing
)
10502 quit_throw_to_read_char ();
10507 /* Handle a C-g by making read_char return C-g. */
10510 quit_throw_to_read_char ()
10513 /* Prevent another signal from doing this before we finish. */
10514 clear_waiting_for_input ();
10517 Vunread_command_events
= Qnil
;
10518 unread_command_char
= -1;
10520 #if 0 /* Currently, sit_for is called from read_char without turning
10521 off polling. And that can call set_waiting_for_input.
10522 It seems to be harmless. */
10523 #ifdef POLL_FOR_INPUT
10524 /* May be > 1 if in recursive minibuffer. */
10525 if (poll_suppress_count
== 0)
10529 if (FRAMEP (internal_last_event_frame
)
10530 && !EQ (internal_last_event_frame
, selected_frame
))
10531 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10534 _longjmp (getcjmp
, 1);
10537 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10538 doc
: /* Set mode of reading keyboard input.
10539 First arg INTERRUPT non-nil means use input interrupts;
10540 nil means use CBREAK mode.
10541 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10542 (no effect except in CBREAK mode).
10543 Third arg META t means accept 8-bit input (for a Meta key).
10544 META nil means ignore the top bit, on the assumption it is parity.
10545 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10546 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10547 See also `current-input-mode'. */)
10548 (interrupt
, flow
, meta
, quit
)
10549 Lisp_Object interrupt
, flow
, meta
, quit
;
10552 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10553 error ("set-input-mode: QUIT must be an ASCII character");
10555 #ifdef POLL_FOR_INPUT
10560 /* this causes startup screen to be restored and messes with the mouse */
10561 reset_sys_modes ();
10565 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10566 if (read_socket_hook
)
10568 /* When using X, don't give the user a real choice,
10569 because we haven't implemented the mechanisms to support it. */
10570 #ifdef NO_SOCK_SIGIO
10571 interrupt_input
= 0;
10572 #else /* not NO_SOCK_SIGIO */
10573 interrupt_input
= 1;
10574 #endif /* NO_SOCK_SIGIO */
10577 interrupt_input
= !NILP (interrupt
);
10578 #else /* not SIGIO */
10579 interrupt_input
= 0;
10580 #endif /* not SIGIO */
10582 /* Our VMS input only works by interrupts, as of now. */
10584 interrupt_input
= 1;
10587 flow_control
= !NILP (flow
);
10590 else if (EQ (meta
, Qt
))
10595 /* Don't let this value be out of range. */
10596 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10602 #ifdef POLL_FOR_INPUT
10603 poll_suppress_count
= 1;
10609 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10610 doc
: /* Return information about the way Emacs currently reads keyboard input.
10611 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10612 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10613 nil, Emacs is using CBREAK mode.
10614 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10615 terminal; this does not apply if Emacs uses interrupt-driven input.
10616 META is t if accepting 8-bit input with 8th bit as Meta flag.
10617 META nil means ignoring the top bit, on the assumption it is parity.
10618 META is neither t nor nil if accepting 8-bit input and using
10619 all 8 bits as the character code.
10620 QUIT is the character Emacs currently uses to quit.
10621 The elements of this list correspond to the arguments of
10622 `set-input-mode'. */)
10625 Lisp_Object val
[4];
10627 val
[0] = interrupt_input
? Qt
: Qnil
;
10628 val
[1] = flow_control
? Qt
: Qnil
;
10629 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10630 XSETFASTINT (val
[3], quit_char
);
10632 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10637 * Set up a new kboard object with reasonable initial values.
10643 kb
->Voverriding_terminal_local_map
= Qnil
;
10644 kb
->Vlast_command
= Qnil
;
10645 kb
->Vreal_last_command
= Qnil
;
10646 kb
->Vprefix_arg
= Qnil
;
10647 kb
->Vlast_prefix_arg
= Qnil
;
10648 kb
->kbd_queue
= Qnil
;
10649 kb
->kbd_queue_has_data
= 0;
10650 kb
->immediate_echo
= 0;
10651 kb
->echo_string
= Qnil
;
10652 kb
->echo_after_prompt
= -1;
10653 kb
->kbd_macro_buffer
= 0;
10654 kb
->kbd_macro_bufsize
= 0;
10655 kb
->defining_kbd_macro
= Qnil
;
10656 kb
->Vlast_kbd_macro
= Qnil
;
10657 kb
->reference_count
= 0;
10658 kb
->Vsystem_key_alist
= Qnil
;
10659 kb
->system_key_syms
= Qnil
;
10660 kb
->Vdefault_minibuffer_frame
= Qnil
;
10664 * Destroy the contents of a kboard object, but not the object itself.
10665 * We use this just before deleting it, or if we're going to initialize
10666 * it a second time.
10672 if (kb
->kbd_macro_buffer
)
10673 xfree (kb
->kbd_macro_buffer
);
10676 #ifdef MULTI_KBOARD
10678 /* Free KB and memory referenced from it. */
10686 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10689 *kbp
= kb
->next_kboard
;
10691 /* Prevent a dangling reference to KB. */
10692 if (kb
== current_kboard
10693 && FRAMEP (selected_frame
)
10694 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10696 current_kboard
= XFRAME (selected_frame
)->kboard
;
10697 if (current_kboard
== kb
)
10705 #endif /* MULTI_KBOARD */
10710 /* This is correct before outermost invocation of the editor loop */
10711 command_loop_level
= -1;
10712 immediate_quit
= 0;
10713 quit_char
= Ctl ('g');
10714 Vunread_command_events
= Qnil
;
10715 unread_command_char
= -1;
10716 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10718 recent_keys_index
= 0;
10719 kbd_fetch_ptr
= kbd_buffer
;
10720 kbd_store_ptr
= kbd_buffer
;
10721 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10723 do_mouse_tracking
= Qnil
;
10727 /* This means that command_loop_1 won't try to select anything the first
10729 internal_last_event_frame
= Qnil
;
10730 Vlast_event_frame
= internal_last_event_frame
;
10732 #ifdef MULTI_KBOARD
10733 current_kboard
= initial_kboard
;
10735 wipe_kboard (current_kboard
);
10736 init_kboard (current_kboard
);
10738 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10740 signal (SIGINT
, interrupt_signal
);
10741 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10742 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10743 SIGQUIT and we can't tell which one it will give us. */
10744 signal (SIGQUIT
, interrupt_signal
);
10745 #endif /* HAVE_TERMIO */
10747 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10749 if (!noninteractive
)
10750 signal (SIGIO
, input_available_signal
);
10753 /* Use interrupt input by default, if it works and noninterrupt input
10754 has deficiencies. */
10756 #ifdef INTERRUPT_INPUT
10757 interrupt_input
= 1;
10759 interrupt_input
= 0;
10762 /* Our VMS input only works by interrupts, as of now. */
10764 interrupt_input
= 1;
10770 if (keyboard_init_hook
)
10771 (*keyboard_init_hook
) ();
10773 #ifdef POLL_FOR_INPUT
10774 poll_suppress_count
= 1;
10779 /* At least provide an escape route since C-g doesn't work. */
10780 signal (SIGINT
, interrupt_signal
);
10784 /* This type's only use is in syms_of_keyboard, to initialize the
10785 event header symbols and put properties on them. */
10786 struct event_head
{
10792 struct event_head head_table
[] = {
10793 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10794 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10795 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10796 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10797 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10798 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10799 /* `select-window' should be handled just like `switch-frame'
10800 in read_key_sequence. */
10801 {&Qselect_window
, "select-window", &Qswitch_frame
}
10805 syms_of_keyboard ()
10807 Vpre_help_message
= Qnil
;
10808 staticpro (&Vpre_help_message
);
10810 Vlispy_mouse_stem
= build_string ("mouse");
10811 staticpro (&Vlispy_mouse_stem
);
10814 QCimage
= intern (":image");
10815 staticpro (&QCimage
);
10817 staticpro (&Qhelp_echo
);
10818 Qhelp_echo
= intern ("help-echo");
10820 staticpro (&item_properties
);
10821 item_properties
= Qnil
;
10823 staticpro (&tool_bar_item_properties
);
10824 tool_bar_item_properties
= Qnil
;
10825 staticpro (&tool_bar_items_vector
);
10826 tool_bar_items_vector
= Qnil
;
10828 staticpro (&real_this_command
);
10829 real_this_command
= Qnil
;
10831 Qtimer_event_handler
= intern ("timer-event-handler");
10832 staticpro (&Qtimer_event_handler
);
10834 Qdisabled_command_hook
= intern ("disabled-command-hook");
10835 staticpro (&Qdisabled_command_hook
);
10837 Qself_insert_command
= intern ("self-insert-command");
10838 staticpro (&Qself_insert_command
);
10840 Qforward_char
= intern ("forward-char");
10841 staticpro (&Qforward_char
);
10843 Qbackward_char
= intern ("backward-char");
10844 staticpro (&Qbackward_char
);
10846 Qdisabled
= intern ("disabled");
10847 staticpro (&Qdisabled
);
10849 Qundefined
= intern ("undefined");
10850 staticpro (&Qundefined
);
10852 Qpre_command_hook
= intern ("pre-command-hook");
10853 staticpro (&Qpre_command_hook
);
10855 Qpost_command_hook
= intern ("post-command-hook");
10856 staticpro (&Qpost_command_hook
);
10858 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10859 staticpro (&Qpost_command_idle_hook
);
10861 Qdeferred_action_function
= intern ("deferred-action-function");
10862 staticpro (&Qdeferred_action_function
);
10864 Qcommand_hook_internal
= intern ("command-hook-internal");
10865 staticpro (&Qcommand_hook_internal
);
10867 Qfunction_key
= intern ("function-key");
10868 staticpro (&Qfunction_key
);
10869 Qmouse_click
= intern ("mouse-click");
10870 staticpro (&Qmouse_click
);
10871 #if defined(MAC_OSX)
10872 Qmouse_wheel
= intern ("mouse-wheel");
10873 staticpro (&Qmouse_wheel
);
10876 Qlanguage_change
= intern ("language-change");
10877 staticpro (&Qlanguage_change
);
10879 Qdrag_n_drop
= intern ("drag-n-drop");
10880 staticpro (&Qdrag_n_drop
);
10882 Qsave_session
= intern ("save-session");
10883 staticpro(&Qsave_session
);
10885 Qusr1_signal
= intern ("usr1-signal");
10886 staticpro (&Qusr1_signal
);
10887 Qusr2_signal
= intern ("usr2-signal");
10888 staticpro (&Qusr2_signal
);
10890 Qmenu_enable
= intern ("menu-enable");
10891 staticpro (&Qmenu_enable
);
10892 Qmenu_alias
= intern ("menu-alias");
10893 staticpro (&Qmenu_alias
);
10894 QCenable
= intern (":enable");
10895 staticpro (&QCenable
);
10896 QCvisible
= intern (":visible");
10897 staticpro (&QCvisible
);
10898 QChelp
= intern (":help");
10899 staticpro (&QChelp
);
10900 QCfilter
= intern (":filter");
10901 staticpro (&QCfilter
);
10902 QCbutton
= intern (":button");
10903 staticpro (&QCbutton
);
10904 QCkeys
= intern (":keys");
10905 staticpro (&QCkeys
);
10906 QCkey_sequence
= intern (":key-sequence");
10907 staticpro (&QCkey_sequence
);
10908 QCtoggle
= intern (":toggle");
10909 staticpro (&QCtoggle
);
10910 QCradio
= intern (":radio");
10911 staticpro (&QCradio
);
10913 Qmode_line
= intern ("mode-line");
10914 staticpro (&Qmode_line
);
10915 Qvertical_line
= intern ("vertical-line");
10916 staticpro (&Qvertical_line
);
10917 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10918 staticpro (&Qvertical_scroll_bar
);
10919 Qmenu_bar
= intern ("menu-bar");
10920 staticpro (&Qmenu_bar
);
10922 Qabove_handle
= intern ("above-handle");
10923 staticpro (&Qabove_handle
);
10924 Qhandle
= intern ("handle");
10925 staticpro (&Qhandle
);
10926 Qbelow_handle
= intern ("below-handle");
10927 staticpro (&Qbelow_handle
);
10928 Qup
= intern ("up");
10930 Qdown
= intern ("down");
10931 staticpro (&Qdown
);
10932 Qtop
= intern ("top");
10934 Qbottom
= intern ("bottom");
10935 staticpro (&Qbottom
);
10936 Qend_scroll
= intern ("end-scroll");
10937 staticpro (&Qend_scroll
);
10938 Qratio
= intern ("ratio");
10939 staticpro (&Qratio
);
10941 Qevent_kind
= intern ("event-kind");
10942 staticpro (&Qevent_kind
);
10943 Qevent_symbol_elements
= intern ("event-symbol-elements");
10944 staticpro (&Qevent_symbol_elements
);
10945 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10946 staticpro (&Qevent_symbol_element_mask
);
10947 Qmodifier_cache
= intern ("modifier-cache");
10948 staticpro (&Qmodifier_cache
);
10950 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10951 staticpro (&Qrecompute_lucid_menubar
);
10952 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10953 staticpro (&Qactivate_menubar_hook
);
10955 Qpolling_period
= intern ("polling-period");
10956 staticpro (&Qpolling_period
);
10958 Qinput_method_function
= intern ("input-method-function");
10959 staticpro (&Qinput_method_function
);
10961 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10962 staticpro (&Qinput_method_exit_on_first_char
);
10963 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10964 staticpro (&Qinput_method_use_echo_area
);
10966 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10967 Fset (Qinput_method_use_echo_area
, Qnil
);
10969 last_point_position_buffer
= Qnil
;
10972 struct event_head
*p
;
10974 for (p
= head_table
;
10975 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10978 *p
->var
= intern (p
->name
);
10979 staticpro (p
->var
);
10980 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10981 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10985 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10986 staticpro (&button_down_location
);
10987 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10988 staticpro (&mouse_syms
);
10989 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10990 staticpro (&wheel_syms
);
10994 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10996 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10997 for (i
= 0; i
< len
; i
++)
10998 if (modifier_names
[i
])
10999 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11000 staticpro (&modifier_symbols
);
11003 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11004 staticpro (&recent_keys
);
11006 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11007 staticpro (&this_command_keys
);
11009 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11010 staticpro (&raw_keybuf
);
11012 Qextended_command_history
= intern ("extended-command-history");
11013 Fset (Qextended_command_history
, Qnil
);
11014 staticpro (&Qextended_command_history
);
11016 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
11017 staticpro (&kbd_buffer_gcpro
);
11019 accent_key_syms
= Qnil
;
11020 staticpro (&accent_key_syms
);
11022 func_key_syms
= Qnil
;
11023 staticpro (&func_key_syms
);
11025 #if defined(MAC_OSX)
11026 mouse_wheel_syms
= Qnil
;
11027 staticpro (&mouse_wheel_syms
);
11028 drag_n_drop_syms
= Qnil
;
11029 staticpro (&drag_n_drop_syms
);
11032 unread_switch_frame
= Qnil
;
11033 staticpro (&unread_switch_frame
);
11035 internal_last_event_frame
= Qnil
;
11036 staticpro (&internal_last_event_frame
);
11038 read_key_sequence_cmd
= Qnil
;
11039 staticpro (&read_key_sequence_cmd
);
11041 menu_bar_one_keymap_changed_items
= Qnil
;
11042 staticpro (&menu_bar_one_keymap_changed_items
);
11044 defsubr (&Sevent_convert_list
);
11045 defsubr (&Sread_key_sequence
);
11046 defsubr (&Sread_key_sequence_vector
);
11047 defsubr (&Srecursive_edit
);
11049 defsubr (&Strack_mouse
);
11051 defsubr (&Sinput_pending_p
);
11052 defsubr (&Scommand_execute
);
11053 defsubr (&Srecent_keys
);
11054 defsubr (&Sthis_command_keys
);
11055 defsubr (&Sthis_command_keys_vector
);
11056 defsubr (&Sthis_single_command_keys
);
11057 defsubr (&Sthis_single_command_raw_keys
);
11058 defsubr (&Sreset_this_command_lengths
);
11059 defsubr (&Sclear_this_command_keys
);
11060 defsubr (&Ssuspend_emacs
);
11061 defsubr (&Sabort_recursive_edit
);
11062 defsubr (&Sexit_recursive_edit
);
11063 defsubr (&Srecursion_depth
);
11064 defsubr (&Stop_level
);
11065 defsubr (&Sdiscard_input
);
11066 defsubr (&Sopen_dribble_file
);
11067 defsubr (&Sset_input_mode
);
11068 defsubr (&Scurrent_input_mode
);
11069 defsubr (&Sexecute_extended_command
);
11071 DEFVAR_LISP ("last-command-char", &last_command_char
,
11072 doc
: /* Last input event that was part of a command. */);
11074 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11075 doc
: /* Last input event that was part of a command. */);
11077 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11078 doc
: /* Last input event in a command, except for mouse menu events.
11079 Mouse menus give back keys that don't look like mouse events;
11080 this variable holds the actual mouse event that led to the menu,
11081 so that you can determine whether the command was run by mouse or not. */);
11083 DEFVAR_LISP ("last-input-char", &last_input_char
,
11084 doc
: /* Last input event. */);
11086 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11087 doc
: /* Last input event. */);
11089 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11090 doc
: /* List of events to be read as the command input.
11091 These events are processed first, before actual keyboard input. */);
11092 Vunread_command_events
= Qnil
;
11094 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11095 doc
: /* If not -1, an object to be read as next command input event. */);
11097 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11098 doc
: /* List of events to be processed as input by input methods.
11099 These events are processed after `unread-command-events', but
11100 before actual keyboard input. */);
11101 Vunread_post_input_method_events
= Qnil
;
11103 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11104 doc
: /* List of events to be processed as input by input methods.
11105 These events are processed after `unread-command-events', but
11106 before actual keyboard input. */);
11107 Vunread_input_method_events
= Qnil
;
11109 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11110 doc
: /* Meta-prefix character code.
11111 Meta-foo as command input turns into this character followed by foo. */);
11112 XSETINT (meta_prefix_char
, 033);
11114 DEFVAR_KBOARD ("last-command", Vlast_command
,
11115 doc
: /* The last command executed.
11116 Normally a symbol with a function definition, but can be whatever was found
11117 in the keymap, or whatever the variable `this-command' was set to by that
11120 The value `mode-exit' is special; it means that the previous command
11121 read an event that told it to exit, and it did so and unread that event.
11122 In other words, the present command is the event that made the previous
11125 The value `kill-region' is special; it means that the previous command
11126 was a kill command. */);
11128 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11129 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11131 DEFVAR_LISP ("this-command", &Vthis_command
,
11132 doc
: /* The command now being executed.
11133 The command can set this variable; whatever is put here
11134 will be in `last-command' during the following command. */);
11135 Vthis_command
= Qnil
;
11137 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11138 doc
: /* The command bound to the current key sequence before remapping.
11139 It equals `this-command' if the original command was not remapped through
11140 any of the active keymaps. Otherwise, the value of `this-command' is the
11141 result of looking up the original command in the active keymaps. */);
11142 Vthis_original_command
= Qnil
;
11144 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11145 doc
: /* *Number of input events between auto-saves.
11146 Zero means disable autosaving due to number of characters typed. */);
11147 auto_save_interval
= 300;
11149 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11150 doc
: /* *Number of seconds idle time before auto-save.
11151 Zero or nil means disable auto-saving due to idleness.
11152 After auto-saving due to this many seconds of idle time,
11153 Emacs also does a garbage collection if that seems to be warranted. */);
11154 XSETFASTINT (Vauto_save_timeout
, 30);
11156 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11157 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11158 The value may be integer or floating point. */);
11159 Vecho_keystrokes
= make_number (1);
11161 DEFVAR_INT ("polling-period", &polling_period
,
11162 doc
: /* *Interval between polling for input during Lisp execution.
11163 The reason for polling is to make C-g work to stop a running program.
11164 Polling is needed only when using X windows and SIGIO does not work.
11165 Polling is automatically disabled in all other cases. */);
11166 polling_period
= 2;
11168 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11169 doc
: /* *Maximum time between mouse clicks to make a double-click.
11170 Measured in milliseconds. nil means disable double-click recognition;
11171 t means double-clicks have no time limit and are detected
11172 by position only. */);
11173 Vdouble_click_time
= make_number (500);
11175 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11176 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11177 On window-system frames, value is the number of pixels the mouse may have
11178 moved horizontally or vertically between two clicks to make a double-click.
11179 On non window-system frames, value is interpreted in units of 1/8 characters
11182 This variable is also the threshold for motion of the mouse
11183 to count as a drag. */);
11184 double_click_fuzz
= 3;
11186 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11187 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11188 inhibit_local_menu_bar_menus
= 0;
11190 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11191 doc
: /* Number of complete key sequences read as input so far.
11192 This includes key sequences read from keyboard macros.
11193 The number is effectively the number of interactive command invocations. */);
11194 num_input_keys
= 0;
11196 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11197 doc
: /* Number of input events read from the keyboard so far.
11198 This does not include events generated by keyboard macros. */);
11199 num_nonmacro_input_events
= 0;
11201 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11202 doc
: /* The frame in which the most recently read event occurred.
11203 If the last event came from a keyboard macro, this is set to `macro'. */);
11204 Vlast_event_frame
= Qnil
;
11206 /* This variable is set up in sysdep.c. */
11207 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11208 doc
: /* The ERASE character as set by the user with stty. */);
11210 DEFVAR_LISP ("help-char", &Vhelp_char
,
11211 doc
: /* Character to recognize as meaning Help.
11212 When it is read, do `(eval help-form)', and display result if it's a string.
11213 If the value of `help-form' is nil, this char can be read normally. */);
11214 XSETINT (Vhelp_char
, Ctl ('H'));
11216 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11217 doc
: /* List of input events to recognize as meaning Help.
11218 These work just like the value of `help-char' (see that). */);
11219 Vhelp_event_list
= Qnil
;
11221 DEFVAR_LISP ("help-form", &Vhelp_form
,
11222 doc
: /* Form to execute when character `help-char' is read.
11223 If the form returns a string, that string is displayed.
11224 If `help-form' is nil, the help char is not recognized. */);
11227 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11228 doc
: /* Command to run when `help-char' character follows a prefix key.
11229 This command is used only when there is no actual binding
11230 for that character after that prefix key. */);
11231 Vprefix_help_command
= Qnil
;
11233 DEFVAR_LISP ("top-level", &Vtop_level
,
11234 doc
: /* Form to evaluate when Emacs starts up.
11235 Useful to set before you dump a modified Emacs. */);
11238 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11239 doc
: /* Translate table for keyboard input, or nil.
11240 Each character is looked up in this string and the contents used instead.
11241 The value may be a string, a vector, or a char-table.
11242 If it is a string or vector of length N,
11243 character codes N and up are untranslated.
11244 In a vector or a char-table, an element which is nil means "no translation".
11246 This is applied to the characters supplied to input methods, not their
11247 output. See also `translation-table-for-input'. */);
11248 Vkeyboard_translate_table
= Qnil
;
11250 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11251 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11252 \(Even if the operating system has support for stopping a process.\) */);
11253 cannot_suspend
= 0;
11255 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11256 doc
: /* Non-nil means prompt with menus when appropriate.
11257 This is done when reading from a keymap that has a prompt string,
11258 for elements that have prompt strings.
11259 The menu is displayed on the screen
11260 if X menus were enabled at configuration
11261 time and the previous event was a mouse click prefix key.
11262 Otherwise, menu prompting uses the echo area. */);
11263 menu_prompting
= 1;
11265 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11266 doc
: /* Character to see next line of menu prompt.
11267 Type this character while in a menu prompt to rotate around the lines of it. */);
11268 XSETINT (menu_prompt_more_char
, ' ');
11270 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11271 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11272 Emacs applies the modifiers of the character stored here to each keyboard
11273 character it reads. For example, after evaluating the expression
11274 (setq extra-keyboard-modifiers ?\\C-x)
11275 all input characters will have the control modifier applied to them.
11277 Note that the character ?\\C-@, equivalent to the integer zero, does
11278 not count as a control character; rather, it counts as a character
11279 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11280 cancels any modification. */);
11281 extra_keyboard_modifiers
= 0;
11283 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11284 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11285 The command loop sets this to nil before each command,
11286 and tests the value when the command returns.
11287 Buffer modification stores t in this variable. */);
11288 Vdeactivate_mark
= Qnil
;
11290 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11291 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11292 Vcommand_hook_internal
= Qnil
;
11294 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11295 doc
: /* Normal hook run before each command is executed.
11296 If an unhandled error happens in running this hook,
11297 the hook value is set to nil, since otherwise the error
11298 might happen repeatedly and make Emacs nonfunctional. */);
11299 Vpre_command_hook
= Qnil
;
11301 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11302 doc
: /* Normal hook run after each command is executed.
11303 If an unhandled error happens in running this hook,
11304 the hook value is set to nil, since otherwise the error
11305 might happen repeatedly and make Emacs nonfunctional. */);
11306 Vpost_command_hook
= Qnil
;
11308 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11309 doc
: /* Normal hook run after each command is executed, if idle.
11310 Errors running the hook are caught and ignored. */);
11311 Vpost_command_idle_hook
= Qnil
;
11313 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11314 doc
: /* Delay time before running `post-command-idle-hook'.
11315 This is measured in microseconds. */);
11316 post_command_idle_delay
= 100000;
11319 DEFVAR_LISP ("echo-area-clear-hook", ...,
11320 doc
: /* Normal hook run when clearing the echo area. */);
11322 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11323 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11325 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11326 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11327 Vlucid_menu_bar_dirty_flag
= Qnil
;
11329 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11330 doc
: /* List of menu bar items to move to the end of the menu bar.
11331 The elements of the list are event types that may have menu bar bindings. */);
11332 Vmenu_bar_final_items
= Qnil
;
11334 DEFVAR_KBOARD ("overriding-terminal-local-map",
11335 Voverriding_terminal_local_map
,
11336 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11337 If this variable is non-nil, it is used as a keymap instead of the
11338 buffer's local map, and the minor mode keymaps and text property keymaps.
11339 This variable is intended to let commands such as `universal-argument'
11340 set up a different keymap for reading the next command. */);
11342 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11343 doc
: /* Keymap that overrides all other local keymaps.
11344 If this variable is non-nil, it is used as a keymap instead of the
11345 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11346 Voverriding_local_map
= Qnil
;
11348 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11349 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11350 Otherwise, the menu bar continues to reflect the buffer's local map
11351 and the minor mode maps regardless of `overriding-local-map'. */);
11352 Voverriding_local_map_menu_flag
= Qnil
;
11354 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11355 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11356 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11358 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11359 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11361 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11362 doc
: /* Alist of system-specific X windows key symbols.
11363 Each element should have the form (N . SYMBOL) where N is the
11364 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11365 and SYMBOL is its name. */);
11367 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11368 doc
: /* List of deferred actions to be performed at a later time.
11369 The precise format isn't relevant here; we just check whether it is nil. */);
11370 Vdeferred_action_list
= Qnil
;
11372 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11373 doc
: /* Function to call to handle deferred actions, after each command.
11374 This function is called with no arguments after each command
11375 whenever `deferred-action-list' is non-nil. */);
11376 Vdeferred_action_function
= Qnil
;
11378 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11379 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11380 The value can be a length of time to show the message for.
11381 If the value is non-nil and not a number, we wait 2 seconds. */);
11382 Vsuggest_key_bindings
= Qt
;
11384 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11385 doc
: /* List of active absolute time timers in order of increasing time. */);
11386 Vtimer_list
= Qnil
;
11388 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11389 doc
: /* List of active idle-time timers in order of increasing time. */);
11390 Vtimer_idle_list
= Qnil
;
11392 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11393 doc
: /* If non-nil, the function that implements the current input method.
11394 It's called with one argument, a printing character that was just read.
11395 \(That means a character with code 040...0176.)
11396 Typically this function uses `read-event' to read additional events.
11397 When it does so, it should first bind `input-method-function' to nil
11398 so it will not be called recursively.
11400 The function should return a list of zero or more events
11401 to be used as input. If it wants to put back some events
11402 to be reconsidered, separately, by the input method,
11403 it can add them to the beginning of `unread-command-events'.
11405 The input method function can find in `input-method-previous-method'
11406 the previous echo area message.
11408 The input method function should refer to the variables
11409 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11410 for guidance on what to do. */);
11411 Vinput_method_function
= Qnil
;
11413 DEFVAR_LISP ("input-method-previous-message",
11414 &Vinput_method_previous_message
,
11415 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11416 This variable exists because `read-event' clears the echo area
11417 before running the input method. It is nil if there was no message. */);
11418 Vinput_method_previous_message
= Qnil
;
11420 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11421 doc
: /* If non-nil, the function that implements the display of help.
11422 It's called with one argument, the help string to display. */);
11423 Vshow_help_function
= Qnil
;
11425 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11426 doc
: /* If non-nil, suppress point adjustment after executing a command.
11428 After a command is executed, if point is moved into a region that has
11429 special properties (e.g. composition, display), we adjust point to
11430 the boundary of the region. But, several special commands sets this
11431 variable to non-nil, then we suppress the point adjustment.
11433 This variable is set to nil before reading a command, and is checked
11434 just after executing the command. */);
11435 Vdisable_point_adjustment
= Qnil
;
11437 DEFVAR_LISP ("global-disable-point-adjustment",
11438 &Vglobal_disable_point_adjustment
,
11439 doc
: /* *If non-nil, always suppress point adjustment.
11441 The default value is nil, in which case, point adjustment are
11442 suppressed only after special commands that set
11443 `disable-point-adjustment' (which see) to non-nil. */);
11444 Vglobal_disable_point_adjustment
= Qnil
;
11446 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11447 doc
: /* Non-nil means updating menu bindings is allowed.
11448 A value of nil means menu bindings should not be updated.
11449 Used during Emacs' startup. */);
11450 update_menu_bindings
= 1;
11452 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11453 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11454 If the value is not a number, such messages don't time out. */);
11455 Vminibuffer_message_timeout
= make_number (2);
11459 keys_of_keyboard ()
11461 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11462 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11463 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11464 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11465 initial_define_key (meta_map
, 'x', "execute-extended-command");
11467 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11468 "handle-delete-frame");
11469 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11471 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11473 /* Handling it at such a low-level causes read_key_sequence to get
11474 * confused because it doesn't realize that the current_buffer was
11475 * changed by read_char.
11477 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11478 * "handle-select-window"); */
11479 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11480 "handle-save-session");