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
;
550 #if defined(WINDOWSNT) || defined(MAC_OSX)
551 Lisp_Object Qmouse_wheel
;
554 Lisp_Object Qlanguage_change
;
556 Lisp_Object Qdrag_n_drop
;
557 Lisp_Object Qsave_session
;
559 /* Lisp_Object Qmouse_movement; - also an event header */
561 /* Properties of event headers. */
562 Lisp_Object Qevent_kind
;
563 Lisp_Object Qevent_symbol_elements
;
565 /* menu item parts */
566 Lisp_Object Qmenu_alias
;
567 Lisp_Object Qmenu_enable
;
568 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
569 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
570 extern Lisp_Object Vdefine_key_rebound_commands
;
571 extern Lisp_Object Qmenu_item
;
573 /* An event header symbol HEAD may have a property named
574 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
575 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
576 mask of modifiers applied to it. If present, this is used to help
577 speed up parse_modifiers. */
578 Lisp_Object Qevent_symbol_element_mask
;
580 /* An unmodified event header BASE may have a property named
581 Qmodifier_cache, which is an alist mapping modifier masks onto
582 modified versions of BASE. If present, this helps speed up
584 Lisp_Object Qmodifier_cache
;
586 /* Symbols to use for parts of windows. */
587 Lisp_Object Qmode_line
;
588 Lisp_Object Qvertical_line
;
589 Lisp_Object Qvertical_scroll_bar
;
590 Lisp_Object Qmenu_bar
;
591 extern Lisp_Object Qleft_margin
, Qright_margin
;
593 Lisp_Object
recursive_edit_unwind (), command_loop ();
594 Lisp_Object
Fthis_command_keys ();
595 Lisp_Object Qextended_command_history
;
596 EMACS_TIME
timer_check ();
598 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
600 extern char *x_get_keysym_name ();
602 static void record_menu_key ();
603 static int echo_length ();
605 Lisp_Object Qpolling_period
;
607 /* List of absolute timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_list
;
610 /* List of idle time timers. Appears in order of next scheduled event. */
611 Lisp_Object Vtimer_idle_list
;
613 /* Incremented whenever a timer is run. */
616 extern Lisp_Object Vprint_level
, Vprint_length
;
618 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
620 EMACS_TIME
*input_available_clear_time
;
622 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
623 Default is 1 if INTERRUPT_INPUT is defined. */
626 /* Nonzero while interrupts are temporarily deferred during redisplay. */
627 int interrupts_deferred
;
629 /* Nonzero means use ^S/^Q for flow control. */
632 /* Allow m- file to inhibit use of FIONREAD. */
633 #ifdef BROKEN_FIONREAD
637 /* We are unable to use interrupts if FIONREAD is not available,
638 so flush SIGIO so we won't try. */
645 /* If we support a window system, turn on the code to poll periodically
646 to detect C-g. It isn't actually used when doing interrupt input. */
647 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
648 #define POLL_FOR_INPUT
651 /* After a command is executed, if point is moved into a region that
652 has specific properties (e.g. composition, display), we adjust
653 point to the boundary of the region. But, if a command sets this
654 variable to non-nil, we suppress this point adjustment. This
655 variable is set to nil before reading a command. */
657 Lisp_Object Vdisable_point_adjustment
;
659 /* If non-nil, always disable point adjustment. */
661 Lisp_Object Vglobal_disable_point_adjustment
;
663 /* The time when Emacs started being idle. */
665 static EMACS_TIME timer_idleness_start_time
;
667 /* After Emacs stops being idle, this saves the last value
668 of timer_idleness_start_time from when it was idle. */
670 static EMACS_TIME timer_last_idleness_start_time
;
673 /* Global variable declarations. */
675 /* Function for init_keyboard to call with no args (if nonzero). */
676 void (*keyboard_init_hook
) ();
678 static int read_avail_input
P_ ((int));
679 static void get_input_pending
P_ ((int *, int));
680 static void get_filtered_input_pending
P_ ((int *, int, int));
681 static int readable_events
P_ ((int));
682 static int readable_filtered_events
P_ ((int, int));
683 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
684 Lisp_Object
, int *));
685 static Lisp_Object
read_char_x_menu_prompt ();
686 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
688 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
690 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
691 enum scroll_bar_part
,
692 Lisp_Object
, Lisp_Object
,
695 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
696 Lisp_Object
, char **,
697 Lisp_Object
*, unsigned));
698 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
699 static int parse_solitary_modifier
P_ ((Lisp_Object
));
700 static int parse_solitary_modifier ();
701 static void save_getcjmp
P_ ((jmp_buf));
702 static void save_getcjmp ();
703 static void restore_getcjmp
P_ ((jmp_buf));
704 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
705 static void clear_event
P_ ((struct input_event
*));
706 static void any_kboard_state
P_ ((void));
707 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
709 /* Nonzero means don't try to suspend even if the operating system seems
711 static int cannot_suspend
;
713 /* Install the string STR as the beginning of the string of echoing,
714 so that it serves as a prompt for the next character.
715 Also start echoing. */
721 current_kboard
->echo_string
= str
;
722 current_kboard
->echo_after_prompt
= SCHARS (str
);
726 /* Add C to the echo string, if echoing is going on.
727 C can be a character, which is printed prettily ("M-C-x" and all that
728 jazz), or a symbol, whose name is printed. */
734 if (current_kboard
->immediate_echo
)
736 int size
= KEY_DESCRIPTION_SIZE
+ 100;
737 char *buffer
= (char *) alloca (size
);
739 Lisp_Object echo_string
;
741 echo_string
= current_kboard
->echo_string
;
743 /* If someone has passed us a composite event, use its head symbol. */
748 ptr
= push_key_description (XINT (c
), ptr
, 1);
750 else if (SYMBOLP (c
))
752 Lisp_Object name
= SYMBOL_NAME (c
);
753 int nbytes
= SBYTES (name
);
755 if (size
- (ptr
- buffer
) < nbytes
)
757 int offset
= ptr
- buffer
;
758 size
= max (2 * size
, size
+ nbytes
);
759 buffer
= (char *) alloca (size
);
760 ptr
= buffer
+ offset
;
763 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
764 STRING_MULTIBYTE (name
), 1);
767 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
770 const char *text
= " (Type ? for further options)";
771 int len
= strlen (text
);
773 if (size
- (ptr
- buffer
) < len
)
775 int offset
= ptr
- buffer
;
777 buffer
= (char *) alloca (size
);
778 ptr
= buffer
+ offset
;
781 bcopy (text
, ptr
, len
);
785 /* Replace a dash from echo_dash with a space, otherwise
786 add a space at the end as a separator between keys. */
787 if (STRINGP (echo_string
)
788 && SCHARS (echo_string
) > 1)
790 Lisp_Object last_char
, prev_char
, idx
;
792 idx
= make_number (SCHARS (echo_string
) - 2);
793 prev_char
= Faref (echo_string
, idx
);
795 idx
= make_number (SCHARS (echo_string
) - 1);
796 last_char
= Faref (echo_string
, idx
);
798 /* We test PREV_CHAR to make sure this isn't the echoing
800 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
801 Faset (echo_string
, idx
, make_number (' '));
803 echo_string
= concat2 (echo_string
, build_string (" "));
806 current_kboard
->echo_string
807 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
813 /* Temporarily add a dash to the end of the echo string if it's not
814 empty, so that it serves as a mini-prompt for the very next character. */
819 /* Do nothing if not echoing at all. */
820 if (NILP (current_kboard
->echo_string
))
823 if (!current_kboard
->immediate_echo
824 && SCHARS (current_kboard
->echo_string
) == 0)
827 /* Do nothing if we just printed a prompt. */
828 if (current_kboard
->echo_after_prompt
829 == SCHARS (current_kboard
->echo_string
))
832 /* Put a dash at the end of the buffer temporarily,
833 but make it go away when the next character is added. */
834 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
839 /* Display the current echo string, and begin echoing if not already
845 if (!current_kboard
->immediate_echo
)
848 current_kboard
->immediate_echo
= 1;
850 for (i
= 0; i
< this_command_key_count
; i
++)
854 /* Set before_command_echo_length to the value that would
855 have been saved before the start of this subcommand in
856 command_loop_1, if we had already been echoing then. */
857 if (i
== this_single_command_key_start
)
858 before_command_echo_length
= echo_length ();
860 c
= XVECTOR (this_command_keys
)->contents
[i
];
861 if (! (EVENT_HAS_PARAMETERS (c
)
862 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
866 /* Set before_command_echo_length to the value that would
867 have been saved before the start of this subcommand in
868 command_loop_1, if we had already been echoing then. */
869 if (this_command_key_count
== this_single_command_key_start
)
870 before_command_echo_length
= echo_length ();
872 /* Put a dash at the end to invite the user to type more. */
877 message3_nolog (current_kboard
->echo_string
,
878 SBYTES (current_kboard
->echo_string
),
879 STRING_MULTIBYTE (current_kboard
->echo_string
));
882 /* Record in what buffer we echoed, and from which kboard. */
883 echo_message_buffer
= echo_area_buffer
[0];
884 echo_kboard
= current_kboard
;
886 if (waiting_for_input
&& !NILP (Vquit_flag
))
887 quit_throw_to_read_char ();
890 /* Turn off echoing, for the start of a new command. */
895 current_kboard
->immediate_echo
= 0;
896 current_kboard
->echo_after_prompt
= -1;
897 current_kboard
->echo_string
= Qnil
;
898 ok_to_echo_at_next_pause
= NULL
;
900 echo_message_buffer
= Qnil
;
903 /* Return the length of the current echo string. */
908 return (STRINGP (current_kboard
->echo_string
)
909 ? SCHARS (current_kboard
->echo_string
)
913 /* Truncate the current echo message to its first LEN chars.
914 This and echo_char get used by read_key_sequence when the user
915 switches frames while entering a key sequence. */
918 echo_truncate (nchars
)
921 if (STRINGP (current_kboard
->echo_string
))
922 current_kboard
->echo_string
923 = Fsubstring (current_kboard
->echo_string
,
924 make_number (0), make_number (nchars
));
925 truncate_echo_area (nchars
);
929 /* Functions for manipulating this_command_keys. */
931 add_command_key (key
)
934 #if 0 /* Not needed after we made Freset_this_command_lengths
935 do the job immediately. */
936 /* If reset-this-command-length was called recently, obey it now.
937 See the doc string of that function for an explanation of why. */
938 if (before_command_restore_flag
)
940 this_command_key_count
= before_command_key_count_1
;
941 if (this_command_key_count
< this_single_command_key_start
)
942 this_single_command_key_start
= this_command_key_count
;
943 echo_truncate (before_command_echo_length_1
);
944 before_command_restore_flag
= 0;
948 if (this_command_key_count
>= ASIZE (this_command_keys
))
949 this_command_keys
= larger_vector (this_command_keys
,
950 2 * ASIZE (this_command_keys
),
953 AREF (this_command_keys
, this_command_key_count
) = key
;
954 ++this_command_key_count
;
961 int count
= SPECPDL_INDEX ();
964 if (command_loop_level
> 0)
966 specbind (Qstandard_output
, Qt
);
967 specbind (Qstandard_input
, Qt
);
970 #ifdef HAVE_X_WINDOWS
971 /* The command loop has started an hourglass timer, so we have to
972 cancel it here, otherwise it will fire because the recursive edit
973 can take some time. Do not check for display_hourglass_p here,
974 because it could already be nil. */
978 /* This function may have been called from a debugger called from
979 within redisplay, for instance by Edebugging a function called
980 from fontification-functions. We want to allow redisplay in
981 the debugging session.
983 The recursive edit is left with a `(throw exit ...)'. The `exit'
984 tag is not caught anywhere in redisplay, i.e. when we leave the
985 recursive edit, the original redisplay leading to the recursive
986 edit will be unwound. The outcome should therefore be safe. */
987 specbind (Qinhibit_redisplay
, Qnil
);
990 val
= command_loop ();
992 Fsignal (Qquit
, Qnil
);
993 /* Handle throw from read_minibuf when using minibuffer
994 while it's active but we're in another window. */
996 Fsignal (Qerror
, Fcons (val
, Qnil
));
998 return unbind_to (count
, Qnil
);
1001 /* When an auto-save happens, record the "time", and don't do again soon. */
1006 last_auto_save
= num_nonmacro_input_events
;
1009 /* Make an auto save happen as soon as possible at command level. */
1012 force_auto_save_soon ()
1014 last_auto_save
= - auto_save_interval
- 1;
1016 record_asynch_buffer_change ();
1019 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1020 doc
: /* Invoke the editor command loop recursively.
1021 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1022 that tells this function to return.
1023 Alternately, `(throw 'exit t)' makes this function signal an error.
1024 This function is called by the editor initialization to begin editing. */)
1027 int count
= SPECPDL_INDEX ();
1030 command_loop_level
++;
1031 update_mode_lines
= 1;
1033 if (command_loop_level
1034 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1035 buffer
= Fcurrent_buffer ();
1039 /* If we leave recursive_edit_1 below with a `throw' for instance,
1040 like it is done in the splash screen display, we have to
1041 make sure that we restore single_kboard as command_loop_1
1042 would have done if it were left normally. */
1043 record_unwind_protect (recursive_edit_unwind
,
1044 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1046 recursive_edit_1 ();
1047 return unbind_to (count
, Qnil
);
1051 recursive_edit_unwind (info
)
1054 if (BUFFERP (XCAR (info
)))
1055 Fset_buffer (XCAR (info
));
1057 if (NILP (XCDR (info
)))
1058 any_kboard_state ();
1060 single_kboard_state ();
1062 command_loop_level
--;
1063 update_mode_lines
= 1;
1072 #if 0 /* Theory: if there's anything in Vunread_command_events,
1073 it will right away be read by read_key_sequence,
1074 and then if we do switch KBOARDS, it will go into the side
1075 queue then. So we don't need to do anything special here -- rms. */
1076 if (CONSP (Vunread_command_events
))
1078 current_kboard
->kbd_queue
1079 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1080 current_kboard
->kbd_queue_has_data
= 1;
1082 Vunread_command_events
= Qnil
;
1088 /* Switch to the single-kboard state, making current_kboard
1089 the only KBOARD from which further input is accepted. */
1092 single_kboard_state ()
1099 /* Maintain a stack of kboards, so other parts of Emacs
1100 can switch temporarily to the kboard of a given frame
1101 and then revert to the previous status. */
1106 struct kboard_stack
*next
;
1109 static struct kboard_stack
*kboard_stack
;
1112 push_frame_kboard (f
)
1116 struct kboard_stack
*p
1117 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1119 p
->next
= kboard_stack
;
1120 p
->kboard
= current_kboard
;
1123 current_kboard
= FRAME_KBOARD (f
);
1131 struct kboard_stack
*p
= kboard_stack
;
1132 current_kboard
= p
->kboard
;
1133 kboard_stack
= p
->next
;
1138 /* Handle errors that are not handled at inner levels
1139 by printing an error message and returning to the editor command loop. */
1145 Lisp_Object old_level
, old_length
;
1146 char macroerror
[50];
1148 #ifdef HAVE_X_WINDOWS
1149 if (display_hourglass_p
)
1150 cancel_hourglass ();
1153 if (!NILP (executing_macro
))
1155 if (executing_macro_iterations
== 1)
1156 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1158 sprintf (macroerror
, "After %d kbd macro iterations: ",
1159 executing_macro_iterations
);
1164 Vstandard_output
= Qt
;
1165 Vstandard_input
= Qt
;
1166 Vexecuting_macro
= Qnil
;
1167 executing_macro
= Qnil
;
1168 current_kboard
->Vprefix_arg
= Qnil
;
1169 current_kboard
->Vlast_prefix_arg
= Qnil
;
1172 /* Avoid unquittable loop if data contains a circular list. */
1173 old_level
= Vprint_level
;
1174 old_length
= Vprint_length
;
1175 XSETFASTINT (Vprint_level
, 10);
1176 XSETFASTINT (Vprint_length
, 10);
1177 cmd_error_internal (data
, macroerror
);
1178 Vprint_level
= old_level
;
1179 Vprint_length
= old_length
;
1183 Vinhibit_quit
= Qnil
;
1185 any_kboard_state ();
1188 return make_number (0);
1191 /* Take actions on handling an error. DATA is the data that describes
1194 CONTEXT is a C-string containing ASCII characters only which
1195 describes the context in which the error happened. If we need to
1196 generalize CONTEXT to allow multibyte characters, make it a Lisp
1200 cmd_error_internal (data
, context
)
1205 int kill_emacs_p
= 0;
1206 struct frame
*sf
= SELECTED_FRAME ();
1210 clear_message (1, 0);
1212 /* If the window system or terminal frame hasn't been initialized
1213 yet, or we're not interactive, it's best to dump this message out
1214 to stderr and exit. */
1215 if (!sf
->glyphs_initialized_p
1216 /* This is the case of the frame dumped with Emacs, when we're
1217 running under a window system. */
1218 || (!NILP (Vwindow_system
)
1219 && !inhibit_window_system
1220 && FRAME_TERMCAP_P (sf
))
1223 stream
= Qexternal_debugging_output
;
1229 message_log_maybe_newline ();
1234 /* The immediate context is not interesting for Quits,
1235 since they are asyncronous. */
1236 if (EQ (XCAR (data
), Qquit
))
1237 Vsignaling_function
= Qnil
;
1239 print_error_message (data
, stream
, context
, Vsignaling_function
);
1241 Vsignaling_function
= Qnil
;
1243 /* If the window system or terminal frame hasn't been initialized
1244 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1248 Fkill_emacs (make_number (-1));
1252 Lisp_Object
command_loop_1 ();
1253 Lisp_Object
command_loop_2 ();
1254 Lisp_Object
top_level_1 ();
1256 /* Entry to editor-command-loop.
1257 This level has the catches for exiting/returning to editor command loop.
1258 It returns nil to exit recursive edit, t to abort it. */
1263 if (command_loop_level
> 0 || minibuf_level
> 0)
1266 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1267 executing_macro
= Qnil
;
1273 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1274 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1275 executing_macro
= Qnil
;
1277 /* End of file in -batch run causes exit here. */
1283 /* Here we catch errors in execution of commands within the
1284 editing loop, and reenter the editing loop.
1285 When there is an error, cmd_error runs and returns a non-nil
1286 value to us. A value of nil means that command_loop_1 itself
1287 returned due to end of file (or end of kbd macro). */
1292 register Lisp_Object val
;
1295 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1296 while (!NILP (val
));
1304 return Feval (Vtop_level
);
1310 /* On entry to the outer level, run the startup file */
1311 if (!NILP (Vtop_level
))
1312 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1313 else if (!NILP (Vpurify_flag
))
1314 message ("Bare impure Emacs (standard Lisp code not loaded)");
1316 message ("Bare Emacs (standard Lisp code not loaded)");
1320 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1321 doc
: /* Exit all recursive editing levels. */)
1324 #ifdef HAVE_X_WINDOWS
1325 if (display_hourglass_p
)
1326 cancel_hourglass ();
1328 return Fthrow (Qtop_level
, Qnil
);
1331 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1332 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1335 if (command_loop_level
> 0 || minibuf_level
> 0)
1336 Fthrow (Qexit
, Qnil
);
1338 error ("No recursive edit is in progress");
1342 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1343 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1346 if (command_loop_level
> 0 || minibuf_level
> 0)
1349 error ("No recursive edit is in progress");
1353 /* This is the actual command reading loop,
1354 sans error-handling encapsulation. */
1356 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1358 void safe_run_hooks
P_ ((Lisp_Object
));
1359 static void adjust_point_for_property
P_ ((int, int));
1361 /* Cancel hourglass from protect_unwind.
1363 #ifdef HAVE_X_WINDOWS
1365 cancel_hourglass_unwind (arg
)
1368 cancel_hourglass ();
1378 Lisp_Object keybuf
[30];
1382 struct buffer
*prev_buffer
= NULL
;
1384 int was_locked
= single_kboard
;
1386 int already_adjusted
;
1388 current_kboard
->Vprefix_arg
= Qnil
;
1389 current_kboard
->Vlast_prefix_arg
= Qnil
;
1390 Vdeactivate_mark
= Qnil
;
1391 waiting_for_input
= 0;
1395 this_command_key_count
= 0;
1396 this_command_key_count_reset
= 0;
1397 this_single_command_key_start
= 0;
1399 if (NILP (Vmemory_full
))
1401 /* Make sure this hook runs after commands that get errors and
1402 throw to top level. */
1403 /* Note that the value cell will never directly contain nil
1404 if the symbol is a local variable. */
1405 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1406 safe_run_hooks (Qpost_command_hook
);
1408 /* If displaying a message, resize the echo area window to fit
1409 that message's size exactly. */
1410 if (!NILP (echo_area_buffer
[0]))
1411 resize_echo_area_exactly ();
1413 if (!NILP (Vdeferred_action_list
))
1414 call0 (Vdeferred_action_function
);
1416 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1418 if (NILP (Vunread_command_events
)
1419 && NILP (Vunread_input_method_events
)
1420 && NILP (Vunread_post_input_method_events
)
1421 && NILP (Vexecuting_macro
)
1422 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1423 safe_run_hooks (Qpost_command_idle_hook
);
1427 Vmemory_full
= Qnil
;
1429 /* Do this after running Vpost_command_hook, for consistency. */
1430 current_kboard
->Vlast_command
= Vthis_command
;
1431 current_kboard
->Vreal_last_command
= real_this_command
;
1435 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1438 /* Make sure the current window's buffer is selected. */
1439 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1440 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1442 /* Display any malloc warning that just came out. Use while because
1443 displaying one warning can cause another. */
1445 while (pending_malloc_warning
)
1446 display_malloc_warning ();
1450 Vdeactivate_mark
= Qnil
;
1452 /* If minibuffer on and echo area in use,
1453 wait a short time and redraw minibuffer. */
1456 && !NILP (echo_area_buffer
[0])
1457 && EQ (minibuf_window
, echo_area_window
)
1458 && NUMBERP (Vminibuffer_message_timeout
))
1460 /* Bind inhibit-quit to t so that C-g gets read in
1461 rather than quitting back to the minibuffer. */
1462 int count
= SPECPDL_INDEX ();
1463 specbind (Qinhibit_quit
, Qt
);
1465 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1466 /* Clear the echo area. */
1468 safe_run_hooks (Qecho_area_clear_hook
);
1470 unbind_to (count
, Qnil
);
1472 /* If a C-g came in before, treat it as input now. */
1473 if (!NILP (Vquit_flag
))
1476 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1481 alloca (0); /* Cause a garbage collection now */
1482 /* Since we can free the most stuff here. */
1483 #endif /* C_ALLOCA */
1486 /* Select the frame that the last event came from. Usually,
1487 switch-frame events will take care of this, but if some lisp
1488 code swallows a switch-frame event, we'll fix things up here.
1489 Is this a good idea? */
1490 if (FRAMEP (internal_last_event_frame
)
1491 && !EQ (internal_last_event_frame
, selected_frame
))
1492 Fselect_frame (internal_last_event_frame
, Qnil
);
1494 /* If it has changed current-menubar from previous value,
1495 really recompute the menubar from the value. */
1496 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1497 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1498 call0 (Qrecompute_lucid_menubar
);
1500 before_command_key_count
= this_command_key_count
;
1501 before_command_echo_length
= echo_length ();
1503 Vthis_command
= Qnil
;
1504 real_this_command
= Qnil
;
1506 /* Read next key sequence; i gets its length. */
1507 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1510 /* A filter may have run while we were reading the input. */
1511 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1513 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1514 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1518 /* Now we have read a key sequence of length I,
1519 or else I is 0 and we found end of file. */
1521 if (i
== 0) /* End of file -- happens only in */
1522 return Qnil
; /* a kbd macro, at the end. */
1523 /* -1 means read_key_sequence got a menu that was rejected.
1524 Just loop around and read another command. */
1528 this_command_key_count
= 0;
1529 this_command_key_count_reset
= 0;
1530 this_single_command_key_start
= 0;
1534 last_command_char
= keybuf
[i
- 1];
1536 /* If the previous command tried to force a specific window-start,
1537 forget about that, in case this command moves point far away
1538 from that position. But also throw away beg_unchanged and
1539 end_unchanged information in that case, so that redisplay will
1540 update the whole window properly. */
1541 if (!NILP (XWINDOW (selected_window
)->force_start
))
1544 XWINDOW (selected_window
)->force_start
= Qnil
;
1545 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1546 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1549 cmd
= read_key_sequence_cmd
;
1550 if (!NILP (Vexecuting_macro
))
1552 if (!NILP (Vquit_flag
))
1554 Vexecuting_macro
= Qt
;
1555 QUIT
; /* Make some noise. */
1556 /* Will return since macro now empty. */
1560 /* Do redisplay processing after this command except in special
1561 cases identified below. */
1562 prev_buffer
= current_buffer
;
1563 prev_modiff
= MODIFF
;
1564 last_point_position
= PT
;
1565 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1567 /* By default, we adjust point to a boundary of a region that
1568 has such a property that should be treated intangible
1569 (e.g. composition, display). But, some commands will set
1570 this variable differently. */
1571 Vdisable_point_adjustment
= Qnil
;
1573 /* Process filters and timers may have messed with deactivate-mark.
1574 reset it before we execute the command. */
1575 Vdeactivate_mark
= Qnil
;
1577 /* Remap command through active keymaps */
1578 Vthis_original_command
= cmd
;
1582 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1586 /* Execute the command. */
1588 Vthis_command
= cmd
;
1589 real_this_command
= cmd
;
1590 /* Note that the value cell will never directly contain nil
1591 if the symbol is a local variable. */
1592 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1593 safe_run_hooks (Qpre_command_hook
);
1595 already_adjusted
= 0;
1597 if (NILP (Vthis_command
))
1599 /* nil means key is undefined. */
1601 current_kboard
->defining_kbd_macro
= Qnil
;
1602 update_mode_lines
= 1;
1603 current_kboard
->Vprefix_arg
= Qnil
;
1607 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1609 /* In case we jump to directly_done. */
1610 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1612 /* Recognize some common commands in common situations and
1613 do them directly. */
1614 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1616 struct Lisp_Char_Table
*dp
1617 = window_display_table (XWINDOW (selected_window
));
1618 lose
= FETCH_CHAR (PT_BYTE
);
1620 if (! NILP (Vpost_command_hook
))
1621 /* Put this before calling adjust_point_for_property
1622 so it will only get called once in any case. */
1624 if (current_buffer
== prev_buffer
1625 && last_point_position
!= PT
1626 && NILP (Vdisable_point_adjustment
)
1627 && NILP (Vglobal_disable_point_adjustment
))
1628 adjust_point_for_property (last_point_position
, 0);
1629 already_adjusted
= 1;
1630 if (PT
== last_point_position
+ 1
1632 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1633 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1634 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1635 && (lose
>= 0x20 && lose
< 0x7f)))
1636 : (lose
>= 0x20 && lose
< 0x7f))
1637 /* To extract the case of continuation on
1638 wide-column characters. */
1639 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1640 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1642 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1644 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1646 && !windows_or_buffers_changed
1647 && EQ (current_buffer
->selective_display
, Qnil
)
1648 && !detect_input_pending ()
1649 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1650 && NILP (Vexecuting_macro
))
1651 direct_output_forward_char (1);
1654 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1656 struct Lisp_Char_Table
*dp
1657 = window_display_table (XWINDOW (selected_window
));
1659 lose
= FETCH_CHAR (PT_BYTE
);
1660 if (! NILP (Vpost_command_hook
))
1662 if (current_buffer
== prev_buffer
1663 && last_point_position
!= PT
1664 && NILP (Vdisable_point_adjustment
)
1665 && NILP (Vglobal_disable_point_adjustment
))
1666 adjust_point_for_property (last_point_position
, 0);
1667 already_adjusted
= 1;
1668 if (PT
== last_point_position
- 1
1670 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1671 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1672 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1673 && (lose
>= 0x20 && lose
< 0x7f)))
1674 : (lose
>= 0x20 && lose
< 0x7f))
1675 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1677 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1679 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1681 && !windows_or_buffers_changed
1682 && EQ (current_buffer
->selective_display
, Qnil
)
1683 && !detect_input_pending ()
1684 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1685 && NILP (Vexecuting_macro
))
1686 direct_output_forward_char (-1);
1689 else if (EQ (Vthis_command
, Qself_insert_command
)
1690 /* Try this optimization only on char keystrokes. */
1691 && NATNUMP (last_command_char
)
1692 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1695 = translate_char (Vtranslation_table_for_input
,
1696 XFASTINT (last_command_char
), 0, 0, 0);
1698 if (NILP (Vexecuting_macro
)
1699 && !EQ (minibuf_window
, selected_window
))
1701 if (!nonundocount
|| nonundocount
>= 20)
1709 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1711 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1713 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1715 || MODIFF
<= SAVE_MODIFF
1716 || windows_or_buffers_changed
1717 || !EQ (current_buffer
->selective_display
, Qnil
)
1718 || detect_input_pending ()
1719 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1720 || !NILP (Vexecuting_macro
));
1722 value
= internal_self_insert (c
, 0);
1727 if (! NILP (Vpost_command_hook
))
1728 /* Put this before calling adjust_point_for_property
1729 so it will only get called once in any case. */
1732 /* VALUE == 1 when AFTER-CHANGE functions are
1733 installed which is the case most of the time
1734 because FONT-LOCK installs one. */
1735 if (!lose
&& !value
)
1736 direct_output_for_insert (c
);
1741 /* Here for a command that isn't executed directly */
1744 #ifdef HAVE_X_WINDOWS
1745 int scount
= SPECPDL_INDEX ();
1747 if (display_hourglass_p
1748 && NILP (Vexecuting_macro
))
1750 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1756 if (NILP (current_kboard
->Vprefix_arg
))
1758 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1760 #ifdef HAVE_X_WINDOWS
1761 /* Do not check display_hourglass_p here, because
1762 Fcommand_execute could change it, but we should cancel
1763 hourglass cursor anyway.
1764 But don't cancel the hourglass within a macro
1765 just because a command in the macro finishes. */
1766 if (NILP (Vexecuting_macro
))
1767 unbind_to (scount
, Qnil
);
1772 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1774 /* Note that the value cell will never directly contain nil
1775 if the symbol is a local variable. */
1776 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1777 safe_run_hooks (Qpost_command_hook
);
1779 /* If displaying a message, resize the echo area window to fit
1780 that message's size exactly. */
1781 if (!NILP (echo_area_buffer
[0]))
1782 resize_echo_area_exactly ();
1784 if (!NILP (Vdeferred_action_list
))
1785 safe_run_hooks (Qdeferred_action_function
);
1787 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1789 if (NILP (Vunread_command_events
)
1790 && NILP (Vunread_input_method_events
)
1791 && NILP (Vunread_post_input_method_events
)
1792 && NILP (Vexecuting_macro
)
1793 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1794 safe_run_hooks (Qpost_command_idle_hook
);
1797 /* If there is a prefix argument,
1798 1) We don't want Vlast_command to be ``universal-argument''
1799 (that would be dumb), so don't set Vlast_command,
1800 2) we want to leave echoing on so that the prefix will be
1801 echoed as part of this key sequence, so don't call
1803 3) we want to leave this_command_key_count non-zero, so that
1804 read_char will realize that it is re-reading a character, and
1805 not echo it a second time.
1807 If the command didn't actually create a prefix arg,
1808 but is merely a frame event that is transparent to prefix args,
1809 then the above doesn't apply. */
1810 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1812 current_kboard
->Vlast_command
= Vthis_command
;
1813 current_kboard
->Vreal_last_command
= real_this_command
;
1815 this_command_key_count
= 0;
1816 this_command_key_count_reset
= 0;
1817 this_single_command_key_start
= 0;
1820 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1822 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1824 /* We could also call `deactivate'mark'. */
1825 if (EQ (Vtransient_mark_mode
, Qlambda
))
1826 Vtransient_mark_mode
= Qnil
;
1829 current_buffer
->mark_active
= Qnil
;
1830 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1833 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1834 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1839 if (current_buffer
== prev_buffer
1840 && last_point_position
!= PT
1841 && NILP (Vdisable_point_adjustment
)
1842 && NILP (Vglobal_disable_point_adjustment
)
1843 && !already_adjusted
)
1844 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1846 /* Install chars successfully executed in kbd macro. */
1848 if (!NILP (current_kboard
->defining_kbd_macro
)
1849 && NILP (current_kboard
->Vprefix_arg
))
1850 finalize_kbd_macro_chars ();
1854 any_kboard_state ();
1859 extern Lisp_Object Qcomposition
, Qdisplay
;
1861 /* Adjust point to a boundary of a region that has such a property
1862 that should be treated intangible. For the moment, we check
1863 `composition', `display' and `invisible' properties.
1864 LAST_PT is the last position of point. */
1866 extern Lisp_Object Qafter_string
, Qbefore_string
;
1867 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1870 adjust_point_for_property (last_pt
, modified
)
1875 Lisp_Object val
, overlay
, tmp
;
1876 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
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
3741 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3743 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3745 sp
->kind
= NO_EVENT
;
3751 /* Return non-zero if there are any real events waiting in the event
3752 buffer, not counting `NO_EVENT's.
3754 If DISCARD is non-zero, discard NO_EVENT events at the front of
3755 the input queue, possibly leaving the input queue empty if there
3756 are no real input events. */
3759 kbd_buffer_events_waiting (discard
)
3762 struct input_event
*sp
;
3764 for (sp
= kbd_fetch_ptr
;
3765 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3768 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3775 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3779 /* Clear input event EVENT. */
3783 struct input_event
*event
;
3785 int idx
= 2 * (event
- kbd_buffer
);
3786 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3787 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3788 event
->kind
= NO_EVENT
;
3792 /* Read one event from the event buffer, waiting if necessary.
3793 The value is a Lisp object representing the event.
3794 The value is nil for an event that should be ignored,
3795 or that was handled here.
3796 We always read and discard one event. */
3799 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3801 int *used_mouse_menu
;
3810 *kbp
= current_kboard
;
3814 /* Wait until there is input available. */
3817 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3820 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3824 /* If the quit flag is set, then read_char will return
3825 quit_char, so that counts as "available input." */
3826 if (!NILP (Vquit_flag
))
3827 quit_throw_to_read_char ();
3829 /* One way or another, wait until input is available; then, if
3830 interrupt handlers have not read it, read it now. */
3833 wait_for_kbd_input ();
3835 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3839 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3842 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3846 Lisp_Object minus_one
;
3848 XSETINT (minus_one
, -1);
3849 wait_reading_process_input (0, 0, minus_one
, 1);
3851 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3852 /* Pass 1 for EXPECT since we just waited to have input. */
3853 read_avail_input (1);
3855 #endif /* not VMS */
3858 if (CONSP (Vunread_command_events
))
3861 first
= XCAR (Vunread_command_events
);
3862 Vunread_command_events
= XCDR (Vunread_command_events
);
3863 *kbp
= current_kboard
;
3867 /* At this point, we know that there is a readable event available
3868 somewhere. If the event queue is empty, then there must be a
3869 mouse movement enabled and available. */
3870 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3872 struct input_event
*event
;
3874 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3878 last_event_timestamp
= event
->timestamp
;
3881 *kbp
= event_to_kboard (event
);
3883 *kbp
= current_kboard
; /* Better than returning null ptr? */
3885 *kbp
= &the_only_kboard
;
3890 /* These two kinds of events get special handling
3891 and don't actually appear to the command loop.
3892 We return nil for them. */
3893 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3896 struct input_event copy
;
3898 /* Remove it from the buffer before processing it,
3899 since otherwise swallow_events will see it
3900 and process it again. */
3902 kbd_fetch_ptr
= event
+ 1;
3903 input_pending
= readable_events (0);
3904 x_handle_selection_request (©
);
3906 /* We're getting selection request events, but we don't have
3912 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3915 struct input_event copy
;
3917 /* Remove it from the buffer before processing it. */
3919 kbd_fetch_ptr
= event
+ 1;
3920 input_pending
= readable_events (0);
3921 x_handle_selection_clear (©
);
3923 /* We're getting selection request events, but we don't have
3928 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3929 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3931 /* Make an event (delete-frame (FRAME)). */
3932 obj
= Fcons (event
->frame_or_window
, Qnil
);
3933 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3934 kbd_fetch_ptr
= event
+ 1;
3937 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3938 else if (event
->kind
== ICONIFY_EVENT
)
3940 /* Make an event (iconify-frame (FRAME)). */
3941 obj
= Fcons (event
->frame_or_window
, Qnil
);
3942 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3943 kbd_fetch_ptr
= event
+ 1;
3945 else if (event
->kind
== DEICONIFY_EVENT
)
3947 /* Make an event (make-frame-visible (FRAME)). */
3948 obj
= Fcons (event
->frame_or_window
, Qnil
);
3949 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3950 kbd_fetch_ptr
= event
+ 1;
3953 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3955 /* The value doesn't matter here; only the type is tested. */
3956 XSETBUFFER (obj
, current_buffer
);
3957 kbd_fetch_ptr
= event
+ 1;
3959 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3960 || defined (USE_GTK)
3961 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3963 kbd_fetch_ptr
= event
+ 1;
3964 input_pending
= readable_events (0);
3965 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3966 x_activate_menubar (XFRAME (event
->frame_or_window
));
3970 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3972 /* Make an event (language-change (FRAME CHARSET LCID)). */
3973 obj
= Fcons (event
->modifiers
, Qnil
);
3974 obj
= Fcons (event
->code
, obj
);
3975 obj
= Fcons (event
->frame_or_window
, obj
);
3976 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3977 kbd_fetch_ptr
= event
+ 1;
3980 else if (event
->kind
== SAVE_SESSION_EVENT
)
3982 obj
= Fcons (Qsave_session
, Qnil
);
3983 kbd_fetch_ptr
= event
+ 1;
3985 /* Just discard these, by returning nil.
3986 With MULTI_KBOARD, these events are used as placeholders
3987 when we need to randomly delete events from the queue.
3988 (They shouldn't otherwise be found in the buffer,
3989 but on some machines it appears they do show up
3990 even without MULTI_KBOARD.) */
3991 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3992 mouse events during a popup-menu call. */
3993 else if (event
->kind
== NO_EVENT
)
3994 kbd_fetch_ptr
= event
+ 1;
3995 else if (event
->kind
== HELP_EVENT
)
3997 Lisp_Object object
, position
, help
, frame
, window
;
3999 frame
= event
->frame_or_window
;
4000 object
= event
->arg
;
4001 position
= make_number (event
->code
);
4004 clear_event (event
);
4006 kbd_fetch_ptr
= event
+ 1;
4007 if (!WINDOWP (window
))
4009 obj
= Fcons (Qhelp_echo
,
4010 list5 (frame
, help
, window
, object
, position
));
4012 else if (event
->kind
== FOCUS_IN_EVENT
)
4014 /* Notification of a FocusIn event. The frame receiving the
4015 focus is in event->frame_or_window. Generate a
4016 switch-frame event if necessary. */
4017 Lisp_Object frame
, focus
;
4019 frame
= event
->frame_or_window
;
4020 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4024 if (!EQ (frame
, internal_last_event_frame
)
4025 && !EQ (frame
, selected_frame
))
4026 obj
= make_lispy_switch_frame (frame
);
4027 internal_last_event_frame
= frame
;
4028 kbd_fetch_ptr
= event
+ 1;
4032 /* If this event is on a different frame, return a switch-frame this
4033 time, and leave the event in the queue for next time. */
4037 frame
= event
->frame_or_window
;
4039 frame
= XCAR (frame
);
4040 else if (WINDOWP (frame
))
4041 frame
= WINDOW_FRAME (XWINDOW (frame
));
4043 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4047 if (! EQ (frame
, internal_last_event_frame
)
4048 && !EQ (frame
, selected_frame
))
4049 obj
= make_lispy_switch_frame (frame
);
4050 internal_last_event_frame
= frame
;
4052 /* If we didn't decide to make a switch-frame event, go ahead
4053 and build a real event from the queue entry. */
4057 obj
= make_lispy_event (event
);
4059 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4060 || defined (USE_GTK)
4061 /* If this was a menu selection, then set the flag to inhibit
4062 writing to last_nonmenu_event. Don't do this if the event
4063 we're returning is (menu-bar), though; that indicates the
4064 beginning of the menu sequence, and we might as well leave
4065 that as the `event with parameters' for this selection. */
4067 && !EQ (event
->frame_or_window
, event
->arg
)
4068 && (event
->kind
== MENU_BAR_EVENT
4069 || event
->kind
== TOOL_BAR_EVENT
))
4070 *used_mouse_menu
= 1;
4073 /* Wipe out this event, to catch bugs. */
4074 clear_event (event
);
4075 kbd_fetch_ptr
= event
+ 1;
4080 /* Try generating a mouse motion event. */
4081 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4083 FRAME_PTR f
= some_mouse_moved ();
4084 Lisp_Object bar_window
;
4085 enum scroll_bar_part part
;
4089 *kbp
= current_kboard
;
4090 /* Note that this uses F to determine which display to look at.
4091 If there is no valid info, it does not store anything
4092 so x remains nil. */
4094 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4098 /* Decide if we should generate a switch-frame event. Don't
4099 generate switch-frame events for motion outside of all Emacs
4105 frame
= FRAME_FOCUS_FRAME (f
);
4107 XSETFRAME (frame
, f
);
4109 if (! EQ (frame
, internal_last_event_frame
)
4110 && !EQ (frame
, selected_frame
))
4111 obj
= make_lispy_switch_frame (frame
);
4112 internal_last_event_frame
= frame
;
4115 /* If we didn't decide to make a switch-frame event, go ahead and
4116 return a mouse-motion event. */
4117 if (!NILP (x
) && NILP (obj
))
4118 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4120 #endif /* HAVE_MOUSE */
4122 /* We were promised by the above while loop that there was
4123 something for us to read! */
4126 input_pending
= readable_events (0);
4128 Vlast_event_frame
= internal_last_event_frame
;
4133 /* Process any events that are not user-visible,
4134 then return, without reading any user-visible events. */
4137 swallow_events (do_display
)
4142 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4144 struct input_event
*event
;
4146 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4150 last_event_timestamp
= event
->timestamp
;
4152 /* These two kinds of events get special handling
4153 and don't actually appear to the command loop. */
4154 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4157 struct input_event copy
;
4159 /* Remove it from the buffer before processing it,
4160 since otherwise swallow_events called recursively could see it
4161 and process it again. */
4163 kbd_fetch_ptr
= event
+ 1;
4164 input_pending
= readable_events (0);
4165 x_handle_selection_request (©
);
4167 /* We're getting selection request events, but we don't have
4173 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4176 struct input_event copy
;
4178 /* Remove it from the buffer before processing it, */
4181 kbd_fetch_ptr
= event
+ 1;
4182 input_pending
= readable_events (0);
4183 x_handle_selection_clear (©
);
4185 /* We're getting selection request events, but we don't have
4194 old_timers_run
= timers_run
;
4195 get_input_pending (&input_pending
, 1);
4197 if (timers_run
!= old_timers_run
&& do_display
)
4198 redisplay_preserve_echo_area (7);
4201 /* Record the start of when Emacs is idle,
4202 for the sake of running idle-time timers. */
4209 /* If we are already in the idle state, do nothing. */
4210 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4213 EMACS_GET_TIME (timer_idleness_start_time
);
4215 timer_last_idleness_start_time
= timer_idleness_start_time
;
4217 /* Mark all idle-time timers as once again candidates for running. */
4218 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4222 timer
= XCAR (timers
);
4224 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4226 XVECTOR (timer
)->contents
[0] = Qnil
;
4230 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4235 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4238 /* This is only for debugging. */
4239 struct input_event last_timer_event
;
4241 /* Check whether a timer has fired. To prevent larger problems we simply
4242 disregard elements that are not proper timers. Do not make a circular
4243 timer list for the time being.
4245 Returns the number of seconds to wait until the next timer fires. If a
4246 timer is triggering now, return zero seconds.
4247 If no timer is active, return -1 seconds.
4249 If a timer is ripe, we run it, with quitting turned off.
4251 DO_IT_NOW is now ignored. It used to mean that we should
4252 run the timer directly instead of queueing a timer-event.
4253 Now we always run timers directly. */
4256 timer_check (do_it_now
)
4259 EMACS_TIME nexttime
;
4260 EMACS_TIME now
, idleness_now
;
4261 Lisp_Object timers
, idle_timers
, chosen_timer
;
4262 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4264 EMACS_SET_SECS (nexttime
, -1);
4265 EMACS_SET_USECS (nexttime
, -1);
4267 /* Always consider the ordinary timers. */
4268 timers
= Vtimer_list
;
4269 /* Consider the idle timers only if Emacs is idle. */
4270 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4271 idle_timers
= Vtimer_idle_list
;
4274 chosen_timer
= Qnil
;
4275 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4277 if (CONSP (timers
) || CONSP (idle_timers
))
4279 EMACS_GET_TIME (now
);
4280 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4281 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4284 while (CONSP (timers
) || CONSP (idle_timers
))
4286 Lisp_Object
*vector
;
4287 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4288 EMACS_TIME timer_time
, idle_timer_time
;
4289 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4291 /* Skip past invalid timers and timers already handled. */
4294 timer
= XCAR (timers
);
4295 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4297 timers
= XCDR (timers
);
4300 vector
= XVECTOR (timer
)->contents
;
4302 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4303 || !INTEGERP (vector
[3])
4304 || ! NILP (vector
[0]))
4306 timers
= XCDR (timers
);
4310 if (!NILP (idle_timers
))
4312 timer
= XCAR (idle_timers
);
4313 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4315 idle_timers
= XCDR (idle_timers
);
4318 vector
= XVECTOR (timer
)->contents
;
4320 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4321 || !INTEGERP (vector
[3])
4322 || ! NILP (vector
[0]))
4324 idle_timers
= XCDR (idle_timers
);
4329 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4330 based on the next ordinary timer.
4331 TIMER_DIFFERENCE is the distance in time from NOW to when
4332 this timer becomes ripe (negative if it's already ripe). */
4335 timer
= XCAR (timers
);
4336 vector
= XVECTOR (timer
)->contents
;
4337 EMACS_SET_SECS (timer_time
,
4338 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4339 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4340 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4343 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4344 based on the next idle timer. */
4345 if (!NILP (idle_timers
))
4347 idle_timer
= XCAR (idle_timers
);
4348 vector
= XVECTOR (idle_timer
)->contents
;
4349 EMACS_SET_SECS (idle_timer_time
,
4350 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4351 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4352 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4355 /* Decide which timer is the next timer,
4356 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4357 Also step down the list where we found that timer. */
4359 if (! NILP (timers
) && ! NILP (idle_timers
))
4362 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4363 if (EMACS_TIME_NEG_P (temp
))
4365 chosen_timer
= timer
;
4366 timers
= XCDR (timers
);
4367 difference
= timer_difference
;
4371 chosen_timer
= idle_timer
;
4372 idle_timers
= XCDR (idle_timers
);
4373 difference
= idle_timer_difference
;
4376 else if (! NILP (timers
))
4378 chosen_timer
= timer
;
4379 timers
= XCDR (timers
);
4380 difference
= timer_difference
;
4384 chosen_timer
= idle_timer
;
4385 idle_timers
= XCDR (idle_timers
);
4386 difference
= idle_timer_difference
;
4388 vector
= XVECTOR (chosen_timer
)->contents
;
4390 /* If timer is ripe, run it if it hasn't been run. */
4391 if (EMACS_TIME_NEG_P (difference
)
4392 || (EMACS_SECS (difference
) == 0
4393 && EMACS_USECS (difference
) == 0))
4395 if (NILP (vector
[0]))
4397 int was_locked
= single_kboard
;
4398 int count
= SPECPDL_INDEX ();
4399 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4401 /* Mark the timer as triggered to prevent problems if the lisp
4402 code fails to reschedule it right. */
4405 specbind (Qinhibit_quit
, Qt
);
4407 call1 (Qtimer_event_handler
, chosen_timer
);
4408 Vdeactivate_mark
= old_deactivate_mark
;
4410 unbind_to (count
, Qnil
);
4412 /* Resume allowing input from any kboard, if that was true before. */
4414 any_kboard_state ();
4416 /* Since we have handled the event,
4417 we don't need to tell the caller to wake up and do it. */
4421 /* When we encounter a timer that is still waiting,
4422 return the amount of time to wait before it is ripe. */
4429 /* No timers are pending in the future. */
4430 /* Return 0 if we generated an event, and -1 if not. */
4435 /* Caches for modify_event_symbol. */
4436 static Lisp_Object accent_key_syms
;
4437 static Lisp_Object func_key_syms
;
4438 static Lisp_Object mouse_syms
;
4439 #if defined(WINDOWSNT) || defined(MAC_OSX)
4440 static Lisp_Object mouse_wheel_syms
;
4442 static Lisp_Object drag_n_drop_syms
;
4444 /* This is a list of keysym codes for special "accent" characters.
4445 It parallels lispy_accent_keys. */
4447 static int lispy_accent_codes
[] =
4449 #ifdef XK_dead_circumflex
4454 #ifdef XK_dead_grave
4459 #ifdef XK_dead_tilde
4464 #ifdef XK_dead_diaeresis
4469 #ifdef XK_dead_macron
4474 #ifdef XK_dead_degree
4479 #ifdef XK_dead_acute
4484 #ifdef XK_dead_cedilla
4489 #ifdef XK_dead_breve
4494 #ifdef XK_dead_ogonek
4499 #ifdef XK_dead_caron
4504 #ifdef XK_dead_doubleacute
4505 XK_dead_doubleacute
,
4509 #ifdef XK_dead_abovedot
4514 #ifdef XK_dead_abovering
4524 #ifdef XK_dead_belowdot
4529 #ifdef XK_dead_voiced_sound
4530 XK_dead_voiced_sound
,
4534 #ifdef XK_dead_semivoiced_sound
4535 XK_dead_semivoiced_sound
,
4551 /* This is a list of Lisp names for special "accent" characters.
4552 It parallels lispy_accent_codes. */
4554 static char *lispy_accent_keys
[] =
4572 "dead-voiced-sound",
4573 "dead-semivoiced-sound",
4579 #define FUNCTION_KEY_OFFSET 0x0
4581 char *lispy_function_keys
[] =
4585 0, /* VK_LBUTTON 0x01 */
4586 0, /* VK_RBUTTON 0x02 */
4587 "cancel", /* VK_CANCEL 0x03 */
4588 0, /* VK_MBUTTON 0x04 */
4590 0, 0, 0, /* 0x05 .. 0x07 */
4592 "backspace", /* VK_BACK 0x08 */
4593 "tab", /* VK_TAB 0x09 */
4595 0, 0, /* 0x0A .. 0x0B */
4597 "clear", /* VK_CLEAR 0x0C */
4598 "return", /* VK_RETURN 0x0D */
4600 0, 0, /* 0x0E .. 0x0F */
4602 0, /* VK_SHIFT 0x10 */
4603 0, /* VK_CONTROL 0x11 */
4604 0, /* VK_MENU 0x12 */
4605 "pause", /* VK_PAUSE 0x13 */
4606 "capslock", /* VK_CAPITAL 0x14 */
4608 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4610 "escape", /* VK_ESCAPE 0x1B */
4612 0, 0, 0, 0, /* 0x1C .. 0x1F */
4614 0, /* VK_SPACE 0x20 */
4615 "prior", /* VK_PRIOR 0x21 */
4616 "next", /* VK_NEXT 0x22 */
4617 "end", /* VK_END 0x23 */
4618 "home", /* VK_HOME 0x24 */
4619 "left", /* VK_LEFT 0x25 */
4620 "up", /* VK_UP 0x26 */
4621 "right", /* VK_RIGHT 0x27 */
4622 "down", /* VK_DOWN 0x28 */
4623 "select", /* VK_SELECT 0x29 */
4624 "print", /* VK_PRINT 0x2A */
4625 "execute", /* VK_EXECUTE 0x2B */
4626 "snapshot", /* VK_SNAPSHOT 0x2C */
4627 "insert", /* VK_INSERT 0x2D */
4628 "delete", /* VK_DELETE 0x2E */
4629 "help", /* VK_HELP 0x2F */
4631 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4633 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4635 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4637 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4639 0, 0, 0, 0, 0, 0, 0, 0, 0,
4640 0, 0, 0, 0, 0, 0, 0, 0, 0,
4641 0, 0, 0, 0, 0, 0, 0, 0,
4643 "lwindow", /* VK_LWIN 0x5B */
4644 "rwindow", /* VK_RWIN 0x5C */
4645 "apps", /* VK_APPS 0x5D */
4647 0, 0, /* 0x5E .. 0x5F */
4649 "kp-0", /* VK_NUMPAD0 0x60 */
4650 "kp-1", /* VK_NUMPAD1 0x61 */
4651 "kp-2", /* VK_NUMPAD2 0x62 */
4652 "kp-3", /* VK_NUMPAD3 0x63 */
4653 "kp-4", /* VK_NUMPAD4 0x64 */
4654 "kp-5", /* VK_NUMPAD5 0x65 */
4655 "kp-6", /* VK_NUMPAD6 0x66 */
4656 "kp-7", /* VK_NUMPAD7 0x67 */
4657 "kp-8", /* VK_NUMPAD8 0x68 */
4658 "kp-9", /* VK_NUMPAD9 0x69 */
4659 "kp-multiply", /* VK_MULTIPLY 0x6A */
4660 "kp-add", /* VK_ADD 0x6B */
4661 "kp-separator", /* VK_SEPARATOR 0x6C */
4662 "kp-subtract", /* VK_SUBTRACT 0x6D */
4663 "kp-decimal", /* VK_DECIMAL 0x6E */
4664 "kp-divide", /* VK_DIVIDE 0x6F */
4665 "f1", /* VK_F1 0x70 */
4666 "f2", /* VK_F2 0x71 */
4667 "f3", /* VK_F3 0x72 */
4668 "f4", /* VK_F4 0x73 */
4669 "f5", /* VK_F5 0x74 */
4670 "f6", /* VK_F6 0x75 */
4671 "f7", /* VK_F7 0x76 */
4672 "f8", /* VK_F8 0x77 */
4673 "f9", /* VK_F9 0x78 */
4674 "f10", /* VK_F10 0x79 */
4675 "f11", /* VK_F11 0x7A */
4676 "f12", /* VK_F12 0x7B */
4677 "f13", /* VK_F13 0x7C */
4678 "f14", /* VK_F14 0x7D */
4679 "f15", /* VK_F15 0x7E */
4680 "f16", /* VK_F16 0x7F */
4681 "f17", /* VK_F17 0x80 */
4682 "f18", /* VK_F18 0x81 */
4683 "f19", /* VK_F19 0x82 */
4684 "f20", /* VK_F20 0x83 */
4685 "f21", /* VK_F21 0x84 */
4686 "f22", /* VK_F22 0x85 */
4687 "f23", /* VK_F23 0x86 */
4688 "f24", /* VK_F24 0x87 */
4690 0, 0, 0, 0, /* 0x88 .. 0x8B */
4691 0, 0, 0, 0, /* 0x8C .. 0x8F */
4693 "kp-numlock", /* VK_NUMLOCK 0x90 */
4694 "scroll", /* VK_SCROLL 0x91 */
4696 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4697 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4698 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4699 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4700 "kp-end", /* VK_NUMPAD_END 0x96 */
4701 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4702 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4703 "kp-up", /* VK_NUMPAD_UP 0x99 */
4704 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4705 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4706 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4707 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4709 0, 0, /* 0x9E .. 0x9F */
4712 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4713 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4714 * No other API or message will distinguish left and right keys this way.
4718 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4719 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
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,
4728 "attn", /* VK_ATTN 0xF6 */
4729 "crsel", /* VK_CRSEL 0xF7 */
4730 "exsel", /* VK_EXSEL 0xF8 */
4731 "ereof", /* VK_EREOF 0xF9 */
4732 "play", /* VK_PLAY 0xFA */
4733 "zoom", /* VK_ZOOM 0xFB */
4734 "noname", /* VK_NONAME 0xFC */
4735 "pa1", /* VK_PA1 0xFD */
4736 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4740 #else /* not HAVE_NTGUI */
4742 /* This should be dealt with in XTread_socket now, and that doesn't
4743 depend on the client system having the Kana syms defined. See also
4744 the XK_kana_A case below. */
4747 static char *lispy_kana_keys
[] =
4749 /* X Keysym value */
4750 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4751 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4752 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4753 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4754 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4755 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4756 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4757 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4758 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4759 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4760 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4761 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4762 "kana-i", "kana-u", "kana-e", "kana-o",
4763 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4764 "prolongedsound", "kana-A", "kana-I", "kana-U",
4765 "kana-E", "kana-O", "kana-KA", "kana-KI",
4766 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4767 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4768 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4769 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4770 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4771 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4772 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4773 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4774 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4775 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4776 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4777 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4779 #endif /* XK_kana_A */
4782 #define FUNCTION_KEY_OFFSET 0xff00
4784 /* You'll notice that this table is arranged to be conveniently
4785 indexed by X Windows keysym values. */
4786 static char *lispy_function_keys
[] =
4788 /* X Keysym value */
4790 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4791 "backspace", "tab", "linefeed", "clear",
4793 0, 0, 0, "pause", /* 0xff10...1f */
4794 0, 0, 0, 0, 0, 0, 0, "escape",
4796 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4797 "romaji", "hiragana", "katakana", "hiragana-katakana",
4798 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4799 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4800 "eisu-toggle", /* 0xff30...3f */
4801 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4802 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4804 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4805 "down", "prior", "next", "end",
4806 "begin", 0, 0, 0, 0, 0, 0, 0,
4807 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4818 "break", /* 0xff6b */
4821 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4822 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4823 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4824 0, 0, 0, 0, 0, 0, 0, 0,
4825 "kp-tab", /* 0xff89 */
4827 "kp-enter", /* 0xff8d */
4829 "kp-f1", /* 0xff91 */
4833 "kp-home", /* 0xff95 */
4838 "kp-prior", /* kp-page-up */
4839 "kp-next", /* kp-page-down */
4845 0, 0, 0, 0, 0, 0, 0, 0, 0,
4846 "kp-multiply", /* 0xffaa */
4851 "kp-divide", /* 0xffaf */
4852 "kp-0", /* 0xffb0 */
4853 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4856 "kp-equal", /* 0xffbd */
4857 "f1", /* 0xffbe */ /* IsFunctionKey */
4859 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4860 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4861 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4862 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4863 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4864 0, 0, 0, 0, 0, 0, 0, 0,
4865 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4866 0, 0, 0, 0, 0, 0, 0, "delete"
4869 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4870 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4872 static char *iso_lispy_function_keys
[] =
4874 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4875 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4876 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4877 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4878 "iso-lefttab", /* 0xfe20 */
4879 "iso-move-line-up", "iso-move-line-down",
4880 "iso-partial-line-up", "iso-partial-line-down",
4881 "iso-partial-space-left", "iso-partial-space-right",
4882 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4883 "iso-release-margin-left", "iso-release-margin-right",
4884 "iso-release-both-margins",
4885 "iso-fast-cursor-left", "iso-fast-cursor-right",
4886 "iso-fast-cursor-up", "iso-fast-cursor-down",
4887 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4888 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4891 #endif /* not HAVE_NTGUI */
4893 Lisp_Object Vlispy_mouse_stem
;
4895 #if defined(WINDOWSNT) || defined(MAC_OSX)
4896 /* mouse-wheel events are generated by the wheel on devices such as
4897 the MS Intellimouse. The wheel sits in between the left and right
4898 mouse buttons, and is typically used to scroll or zoom the window
4899 underneath the pointer. mouse-wheel events specify the object on
4900 which they operate, and a delta corresponding to the amount and
4901 direction that the wheel is rotated. Clicking the mouse-wheel
4902 generates a mouse-2 event. */
4903 static char *lispy_mouse_wheel_names
[] =
4908 #endif /* WINDOWSNT */
4910 /* drag-n-drop events are generated when a set of selected files are
4911 dragged from another application and dropped onto an Emacs window. */
4912 static char *lispy_drag_n_drop_names
[] =
4917 /* Scroll bar parts. */
4918 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4919 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4920 Lisp_Object Qtop
, Qratio
;
4922 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4923 Lisp_Object
*scroll_bar_parts
[] = {
4924 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4925 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4928 /* User signal events. */
4929 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4931 Lisp_Object
*lispy_user_signals
[] =
4933 &Qusr1_signal
, &Qusr2_signal
4937 /* A vector, indexed by button number, giving the down-going location
4938 of currently depressed buttons, both scroll bar and non-scroll bar.
4940 The elements have the form
4941 (BUTTON-NUMBER MODIFIER-MASK . REST)
4942 where REST is the cdr of a position as it would be reported in the event.
4944 The make_lispy_event function stores positions here to tell the
4945 difference between click and drag events, and to store the starting
4946 location to be included in drag events. */
4948 static Lisp_Object button_down_location
;
4950 /* Information about the most recent up-going button event: Which
4951 button, what location, and what time. */
4953 static int last_mouse_button
;
4954 static int last_mouse_x
;
4955 static int last_mouse_y
;
4956 static unsigned long button_down_time
;
4958 /* The maximum time between clicks to make a double-click, or Qnil to
4959 disable double-click detection, or Qt for no time limit. */
4961 Lisp_Object Vdouble_click_time
;
4963 /* Maximum number of pixels the mouse may be moved between clicks
4964 to make a double-click. */
4966 EMACS_INT double_click_fuzz
;
4968 /* The number of clicks in this multiple-click. */
4970 int double_click_count
;
4972 /* Given a struct input_event, build the lisp event which represents
4973 it. If EVENT is 0, build a mouse movement event from the mouse
4974 movement buffer, which should have a movement event in it.
4976 Note that events must be passed to this function in the order they
4977 are received; this function stores the location of button presses
4978 in order to build drag events when the button is released. */
4981 make_lispy_event (event
)
4982 struct input_event
*event
;
4986 switch (SWITCH_ENUM_CAST (event
->kind
))
4988 /* A simple keystroke. */
4989 case ASCII_KEYSTROKE_EVENT
:
4991 Lisp_Object lispy_c
;
4992 int c
= event
->code
& 0377;
4993 /* Turn ASCII characters into control characters
4995 if (event
->modifiers
& ctrl_modifier
)
4996 c
= make_ctrl_char (c
);
4998 /* Add in the other modifier bits. We took care of ctrl_modifier
4999 just above, and the shift key was taken care of by the X code,
5000 and applied to control characters by make_ctrl_char. */
5001 c
|= (event
->modifiers
5002 & (meta_modifier
| alt_modifier
5003 | hyper_modifier
| super_modifier
));
5004 /* Distinguish Shift-SPC from SPC. */
5005 if ((event
->code
& 0377) == 040
5006 && event
->modifiers
& shift_modifier
)
5007 c
|= shift_modifier
;
5008 button_down_time
= 0;
5009 XSETFASTINT (lispy_c
, c
);
5013 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5015 Lisp_Object lispy_c
;
5016 int c
= event
->code
;
5018 /* Add in the other modifier bits. We took care of ctrl_modifier
5019 just above, and the shift key was taken care of by the X code,
5020 and applied to control characters by make_ctrl_char. */
5021 c
|= (event
->modifiers
5022 & (meta_modifier
| alt_modifier
5023 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5024 /* What about the `shift' modifier ? */
5025 button_down_time
= 0;
5026 XSETFASTINT (lispy_c
, c
);
5030 /* A function key. The symbol may need to have modifier prefixes
5032 case NON_ASCII_KEYSTROKE_EVENT
:
5033 button_down_time
= 0;
5035 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5036 if (event
->code
== lispy_accent_codes
[i
])
5037 return modify_event_symbol (i
,
5039 Qfunction_key
, Qnil
,
5040 lispy_accent_keys
, &accent_key_syms
,
5041 (sizeof (lispy_accent_keys
)
5042 / sizeof (lispy_accent_keys
[0])));
5046 if (event
->code
>= 0x400 && event
->code
< 0x500)
5047 return modify_event_symbol (event
->code
- 0x400,
5048 event
->modifiers
& ~shift_modifier
,
5049 Qfunction_key
, Qnil
,
5050 lispy_kana_keys
, &func_key_syms
,
5051 (sizeof (lispy_kana_keys
)
5052 / sizeof (lispy_kana_keys
[0])));
5053 #endif /* XK_kana_A */
5056 #ifdef ISO_FUNCTION_KEY_OFFSET
5057 if (event
->code
< FUNCTION_KEY_OFFSET
5058 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5059 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5061 Qfunction_key
, Qnil
,
5062 iso_lispy_function_keys
, &func_key_syms
,
5063 (sizeof (iso_lispy_function_keys
)
5064 / sizeof (iso_lispy_function_keys
[0])));
5067 /* Handle system-specific or unknown keysyms. */
5068 if (event
->code
& (1 << 28)
5069 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5070 || (event
->code
- FUNCTION_KEY_OFFSET
5071 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5072 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5074 /* We need to use an alist rather than a vector as the cache
5075 since we can't make a vector long enuf. */
5076 if (NILP (current_kboard
->system_key_syms
))
5077 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5078 return modify_event_symbol (event
->code
,
5081 current_kboard
->Vsystem_key_alist
,
5082 0, ¤t_kboard
->system_key_syms
,
5086 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5088 Qfunction_key
, Qnil
,
5089 lispy_function_keys
, &func_key_syms
,
5090 (sizeof (lispy_function_keys
)
5091 / sizeof (lispy_function_keys
[0])));
5094 /* A mouse click. Figure out where it is, decide whether it's
5095 a press, click or drag, and build the appropriate structure. */
5096 case MOUSE_CLICK_EVENT
:
5097 #ifndef USE_TOOLKIT_SCROLL_BARS
5098 case SCROLL_BAR_CLICK_EVENT
:
5101 int button
= event
->code
;
5103 Lisp_Object position
;
5104 Lisp_Object
*start_pos_ptr
;
5105 Lisp_Object start_pos
;
5110 /* Build the position as appropriate for this mouse click. */
5111 if (event
->kind
== MOUSE_CLICK_EVENT
)
5113 enum window_part part
;
5114 struct frame
*f
= XFRAME (event
->frame_or_window
);
5116 Lisp_Object string_info
= Qnil
;
5119 /* Ignore mouse events that were made on frame that
5120 have been deleted. */
5121 if (! FRAME_LIVE_P (f
))
5124 /* EVENT->x and EVENT->y are frame-relative pixel
5125 coordinates at this place. Under old redisplay, COLUMN
5126 and ROW are set to frame relative glyph coordinates
5127 which are then used to determine whether this click is
5128 in a menu (non-toolkit version). */
5129 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5130 &column
, &row
, NULL
, 1);
5132 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5133 /* In the non-toolkit version, clicks on the menu bar
5134 are ordinary button events in the event buffer.
5135 Distinguish them, and invoke the menu.
5137 (In the toolkit version, the toolkit handles the menu bar
5138 and Emacs doesn't know about it until after the user
5139 makes a selection.) */
5140 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5141 && (event
->modifiers
& down_modifier
))
5143 Lisp_Object items
, item
;
5148 /* Activate the menu bar on the down event. If the
5149 up event comes in before the menu code can deal with it,
5151 if (! (event
->modifiers
& down_modifier
))
5155 /* Find the menu bar item under `column'. */
5157 items
= FRAME_MENU_BAR_ITEMS (f
);
5158 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5160 Lisp_Object pos
, string
;
5161 string
= AREF (items
, i
+ 1);
5162 pos
= AREF (items
, i
+ 3);
5165 if (column
>= XINT (pos
)
5166 && column
< XINT (pos
) + SCHARS (string
))
5168 item
= AREF (items
, i
);
5173 /* ELisp manual 2.4b says (x y) are window relative but
5174 code says they are frame-relative. */
5176 = Fcons (event
->frame_or_window
,
5178 Fcons (Fcons (event
->x
, event
->y
),
5179 Fcons (make_number (event
->timestamp
),
5182 return Fcons (item
, Fcons (position
, Qnil
));
5184 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5186 /* Set `window' to the window under frame pixel coordinates
5187 event->x/event->y. */
5188 window
= window_from_coordinates (f
, XINT (event
->x
),
5189 XINT (event
->y
), &part
, 0);
5191 if (!WINDOWP (window
))
5193 window
= event
->frame_or_window
;
5198 /* It's a click in window window at frame coordinates
5199 event->x/ event->y. */
5200 struct window
*w
= XWINDOW (window
);
5202 /* Get window relative coordinates. Original code
5203 `rounded' this to glyph boundaries. */
5204 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5205 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5207 /* Set event coordinates to window-relative coordinates
5208 for constructing the Lisp event below. */
5209 XSETINT (event
->x
, wx
);
5210 XSETINT (event
->y
, wy
);
5212 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5214 /* Mode line or header line. Look for a string under
5215 the mouse that may have a `local-map' property. */
5219 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5220 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5221 if (STRINGP (string
))
5222 string_info
= Fcons (string
, make_number (charpos
));
5224 else if (part
== ON_VERTICAL_BORDER
)
5225 posn
= Qvertical_line
;
5226 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5229 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5231 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5232 if (STRINGP (object
))
5233 string_info
= Fcons (object
, make_number (charpos
));
5238 struct display_pos p
;
5239 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5240 posn
= make_number (CHARPOS (p
.pos
));
5241 if (STRINGP (object
))
5244 make_number (CHARPOS (p
.string_pos
)));
5251 Fcons (Fcons (event
->x
, event
->y
),
5252 Fcons (make_number (event
->timestamp
),
5255 : Fcons (string_info
, Qnil
))))));
5257 #ifndef USE_TOOLKIT_SCROLL_BARS
5260 /* It's a scrollbar click. */
5261 Lisp_Object portion_whole
;
5264 window
= event
->frame_or_window
;
5265 portion_whole
= Fcons (event
->x
, event
->y
);
5266 part
= *scroll_bar_parts
[(int) event
->part
];
5270 Fcons (Qvertical_scroll_bar
,
5271 Fcons (portion_whole
,
5272 Fcons (make_number (event
->timestamp
),
5273 Fcons (part
, Qnil
)))));
5275 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5277 if (button
>= ASIZE (button_down_location
))
5279 button_down_location
= larger_vector (button_down_location
,
5281 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5284 start_pos_ptr
= &AREF (button_down_location
, button
);
5285 start_pos
= *start_pos_ptr
;
5286 *start_pos_ptr
= Qnil
;
5289 /* On window-system frames, use the value of
5290 double-click-fuzz as is. On other frames, interpret it
5291 as a multiple of 1/8 characters. */
5295 if (WINDOWP (event
->frame_or_window
))
5296 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5297 else if (FRAMEP (event
->frame_or_window
))
5298 f
= XFRAME (event
->frame_or_window
);
5302 if (FRAME_WINDOW_P (f
))
5303 fuzz
= double_click_fuzz
;
5305 fuzz
= double_click_fuzz
/ 8;
5307 is_double
= (button
== last_mouse_button
5308 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5309 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5310 && button_down_time
!= 0
5311 && (EQ (Vdouble_click_time
, Qt
)
5312 || (INTEGERP (Vdouble_click_time
)
5313 && ((int)(event
->timestamp
- button_down_time
)
5314 < XINT (Vdouble_click_time
)))));
5317 last_mouse_button
= button
;
5318 last_mouse_x
= XINT (event
->x
);
5319 last_mouse_y
= XINT (event
->y
);
5321 /* If this is a button press, squirrel away the location, so
5322 we can decide later whether it was a click or a drag. */
5323 if (event
->modifiers
& down_modifier
)
5327 double_click_count
++;
5328 event
->modifiers
|= ((double_click_count
> 2)
5333 double_click_count
= 1;
5334 button_down_time
= event
->timestamp
;
5335 *start_pos_ptr
= Fcopy_alist (position
);
5338 /* Now we're releasing a button - check the co-ordinates to
5339 see if this was a click or a drag. */
5340 else if (event
->modifiers
& up_modifier
)
5342 /* If we did not see a down before this up, ignore the up.
5343 Probably this happened because the down event chose a
5344 menu item. It would be an annoyance to treat the
5345 release of the button that chose the menu item as a
5348 if (!CONSP (start_pos
))
5351 event
->modifiers
&= ~up_modifier
;
5352 #if 0 /* Formerly we treated an up with no down as a click event. */
5353 if (!CONSP (start_pos
))
5354 event
->modifiers
|= click_modifier
;
5359 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5361 /* The third element of every position
5362 should be the (x,y) pair. */
5363 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5365 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5367 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5368 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5371 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5372 && ydiff
< double_click_fuzz
5373 && ydiff
> - double_click_fuzz
)
5374 /* Mouse hasn't moved (much). */
5375 event
->modifiers
|= click_modifier
;
5378 button_down_time
= 0;
5379 event
->modifiers
|= drag_modifier
;
5382 /* Don't check is_double; treat this as multiple
5383 if the down-event was multiple. */
5384 if (double_click_count
> 1)
5385 event
->modifiers
|= ((double_click_count
> 2)
5391 /* Every mouse event should either have the down_modifier or
5392 the up_modifier set. */
5396 /* Get the symbol we should use for the mouse click. */
5399 head
= modify_event_symbol (button
,
5401 Qmouse_click
, Vlispy_mouse_stem
,
5404 XVECTOR (mouse_syms
)->size
);
5405 if (event
->modifiers
& drag_modifier
)
5410 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5413 Fcons (make_number (double_click_count
),
5422 #ifdef USE_TOOLKIT_SCROLL_BARS
5424 /* We don't have down and up events if using toolkit scroll bars,
5425 so make this always a click event. Store in the `part' of
5426 the Lisp event a symbol which maps to the following actions:
5428 `above_handle' page up
5429 `below_handle' page down
5433 `bottom' bottom of buffer
5434 `handle' thumb has been dragged.
5435 `end-scroll' end of interaction with scroll bar
5437 The incoming input_event contains in its `part' member an
5438 index of type `enum scroll_bar_part' which we can use as an
5439 index in scroll_bar_parts to get the appropriate symbol. */
5441 case SCROLL_BAR_CLICK_EVENT
:
5443 Lisp_Object position
, head
, window
, portion_whole
, part
;
5445 window
= event
->frame_or_window
;
5446 portion_whole
= Fcons (event
->x
, event
->y
);
5447 part
= *scroll_bar_parts
[(int) event
->part
];
5451 Fcons (Qvertical_scroll_bar
,
5452 Fcons (portion_whole
,
5453 Fcons (make_number (event
->timestamp
),
5454 Fcons (part
, Qnil
)))));
5456 /* Always treat scroll bar events as clicks. */
5457 event
->modifiers
|= click_modifier
;
5458 event
->modifiers
&= ~up_modifier
;
5460 if (event
->code
>= ASIZE (mouse_syms
))
5461 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5463 /* Get the symbol we should use for the mouse click. */
5464 head
= modify_event_symbol (event
->code
,
5469 XVECTOR (mouse_syms
)->size
);
5470 return Fcons (head
, Fcons (position
, Qnil
));
5473 #endif /* USE_TOOLKIT_SCROLL_BARS */
5476 case W32_SCROLL_BAR_CLICK_EVENT
:
5478 int button
= event
->code
;
5480 Lisp_Object position
;
5481 Lisp_Object
*start_pos_ptr
;
5482 Lisp_Object start_pos
;
5486 Lisp_Object portion_whole
;
5489 window
= event
->frame_or_window
;
5490 portion_whole
= Fcons (event
->x
, event
->y
);
5491 part
= *scroll_bar_parts
[(int) event
->part
];
5495 Fcons (Qvertical_scroll_bar
,
5496 Fcons (portion_whole
,
5497 Fcons (make_number (event
->timestamp
),
5498 Fcons (part
, Qnil
)))));
5501 /* Always treat W32 scroll bar events as clicks. */
5502 event
->modifiers
|= click_modifier
;
5505 /* Get the symbol we should use for the mouse click. */
5508 head
= modify_event_symbol (button
,
5513 XVECTOR (mouse_syms
)->size
);
5519 #endif /* WINDOWSNT */
5520 #if defined(WINDOWSNT) || defined(MAC_OSX)
5521 case MOUSE_WHEEL_EVENT
:
5523 enum window_part part
;
5524 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5527 Lisp_Object head
, position
;
5530 /* Ignore mouse events that were made on frame that
5531 have been deleted. */
5532 if (! FRAME_LIVE_P (f
))
5534 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5535 &column
, &row
, NULL
, 1);
5536 window
= window_from_coordinates (f
, XINT (event
->x
),
5537 XINT (event
->y
), &part
, 0);
5539 if (!WINDOWP (window
))
5541 window
= event
->frame_or_window
;
5546 int pixcolumn
, pixrow
;
5547 column
-= XINT (XWINDOW (window
)->left
);
5548 row
-= XINT (XWINDOW (window
)->top
);
5549 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5550 &pixcolumn
, &pixrow
);
5551 XSETINT (event
->x
, pixcolumn
);
5552 XSETINT (event
->y
, pixrow
);
5554 if (part
== ON_MODE_LINE
)
5556 else if (part
== ON_VERTICAL_BORDER
)
5557 posn
= Qvertical_line
;
5558 else if (part
== ON_HEADER_LINE
)
5559 posn
= Qheader_line
;
5563 struct display_pos p
;
5564 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5566 posn
= make_number (CHARPOS (p
.pos
));
5571 Lisp_Object head
, position
;
5576 Fcons (Fcons (event
->x
, event
->y
),
5577 Fcons (make_number (event
->timestamp
),
5580 head
= modify_event_symbol (0, event
->modifiers
,
5582 lispy_mouse_wheel_names
,
5583 &mouse_wheel_syms
, 1);
5586 /* Insert 1 here so event-click-count works. */
5587 Fcons (make_number (1),
5588 Fcons (make_number (event
->code
),
5592 #endif /* WINDOWSNT || MAC_OSX */
5594 case DRAG_N_DROP_EVENT
:
5596 enum window_part part
;
5602 /* The frame_or_window field should be a cons of the frame in
5603 which the event occurred and a list of the filenames
5605 if (! CONSP (event
->frame_or_window
))
5608 f
= XFRAME (XCAR (event
->frame_or_window
));
5609 files
= XCDR (event
->frame_or_window
);
5611 /* Ignore mouse events that were made on frames that
5612 have been deleted. */
5613 if (! FRAME_LIVE_P (f
))
5616 window
= window_from_coordinates (f
, XINT (event
->x
),
5617 XINT (event
->y
), &part
, 0);
5619 if (!WINDOWP (window
))
5621 window
= XCAR (event
->frame_or_window
);
5626 /* It's an event in window `window' at frame coordinates
5627 event->x/ event->y. */
5628 struct window
*w
= XWINDOW (window
);
5630 /* Get window relative coordinates. */
5631 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5632 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5634 /* Set event coordinates to window-relative coordinates
5635 for constructing the Lisp event below. */
5636 XSETINT (event
->x
, wx
);
5637 XSETINT (event
->y
, wy
);
5639 if (part
== ON_MODE_LINE
)
5641 else if (part
== ON_VERTICAL_BORDER
)
5642 posn
= Qvertical_line
;
5643 else if (part
== ON_HEADER_LINE
)
5644 posn
= Qheader_line
;
5648 struct display_pos p
;
5649 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5650 posn
= make_number (CHARPOS (p
.pos
));
5655 Lisp_Object head
, position
;
5660 Fcons (Fcons (event
->x
, event
->y
),
5661 Fcons (make_number (event
->timestamp
),
5664 head
= modify_event_symbol (0, event
->modifiers
,
5666 lispy_drag_n_drop_names
,
5667 &drag_n_drop_syms
, 1);
5674 #endif /* HAVE_MOUSE */
5676 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5677 || defined (USE_GTK)
5678 case MENU_BAR_EVENT
:
5679 if (EQ (event
->arg
, event
->frame_or_window
))
5680 /* This is the prefix key. We translate this to
5681 `(menu_bar)' because the code in keyboard.c for menu
5682 events, which we use, relies on this. */
5683 return Fcons (Qmenu_bar
, Qnil
);
5687 case SELECT_WINDOW_EVENT
:
5688 /* Make an event (select-window (WINDOW)). */
5689 return Fcons (Qselect_window
,
5690 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5693 case TOOL_BAR_EVENT
:
5694 if (EQ (event
->arg
, event
->frame_or_window
))
5695 /* This is the prefix key. We translate this to
5696 `(tool_bar)' because the code in keyboard.c for tool bar
5697 events, which we use, relies on this. */
5698 return Fcons (Qtool_bar
, Qnil
);
5699 else if (SYMBOLP (event
->arg
))
5700 return apply_modifiers (event
->modifiers
, event
->arg
);
5703 case USER_SIGNAL_EVENT
:
5704 /* A user signal. */
5705 return *lispy_user_signals
[event
->code
];
5707 case SAVE_SESSION_EVENT
:
5708 return Qsave_session
;
5710 /* The 'kind' field of the event is something we don't recognize. */
5719 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5721 Lisp_Object bar_window
;
5722 enum scroll_bar_part part
;
5726 /* Is it a scroll bar movement? */
5727 if (frame
&& ! NILP (bar_window
))
5729 Lisp_Object part_sym
;
5731 part_sym
= *scroll_bar_parts
[(int) part
];
5732 return Fcons (Qscroll_bar_movement
,
5733 (Fcons (Fcons (bar_window
,
5734 Fcons (Qvertical_scroll_bar
,
5735 Fcons (Fcons (x
, y
),
5736 Fcons (make_number (time
),
5742 /* Or is it an ordinary mouse movement? */
5745 enum window_part area
;
5750 /* It's in a frame; which window on that frame? */
5751 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5755 if (WINDOWP (window
))
5757 struct window
*w
= XWINDOW (window
);
5760 /* Get window relative coordinates. */
5761 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5762 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5766 if (area
== ON_MODE_LINE
)
5768 else if (area
== ON_VERTICAL_BORDER
)
5769 posn
= Qvertical_line
;
5770 else if (area
== ON_HEADER_LINE
)
5771 posn
= Qheader_line
;
5775 struct display_pos p
;
5776 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5777 posn
= make_number (CHARPOS (p
.pos
));
5780 else if (frame
!= 0)
5782 XSETFRAME (window
, frame
);
5793 return Fcons (Qmouse_movement
,
5794 Fcons (Fcons (window
,
5796 Fcons (Fcons (x
, y
),
5797 Fcons (make_number (time
),
5803 #endif /* HAVE_MOUSE */
5805 /* Construct a switch frame event. */
5807 make_lispy_switch_frame (frame
)
5810 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5813 /* Manipulating modifiers. */
5815 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5817 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5818 SYMBOL's name of the end of the modifiers; the string from this
5819 position is the unmodified symbol name.
5821 This doesn't use any caches. */
5824 parse_modifiers_uncached (symbol
, modifier_end
)
5832 CHECK_SYMBOL (symbol
);
5835 name
= SYMBOL_NAME (symbol
);
5837 for (i
= 0; i
+2 <= SBYTES (name
); )
5839 int this_mod_end
= 0;
5842 /* See if the name continues with a modifier word.
5843 Check that the word appears, but don't check what follows it.
5844 Set this_mod and this_mod_end to record what we find. */
5846 switch (SREF (name
, i
))
5848 #define SINGLE_LETTER_MOD(BIT) \
5849 (this_mod_end = i + 1, this_mod = BIT)
5852 SINGLE_LETTER_MOD (alt_modifier
);
5856 SINGLE_LETTER_MOD (ctrl_modifier
);
5860 SINGLE_LETTER_MOD (hyper_modifier
);
5864 SINGLE_LETTER_MOD (meta_modifier
);
5868 SINGLE_LETTER_MOD (shift_modifier
);
5872 SINGLE_LETTER_MOD (super_modifier
);
5875 #undef SINGLE_LETTER_MOD
5877 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5878 if (i + LEN + 1 <= SBYTES (name) \
5879 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5881 this_mod_end = i + LEN; \
5886 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5887 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5888 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5892 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5894 #undef MULTI_LETTER_MOD
5898 /* If we found no modifier, stop looking for them. */
5899 if (this_mod_end
== 0)
5902 /* Check there is a dash after the modifier, so that it
5903 really is a modifier. */
5904 if (this_mod_end
>= SBYTES (name
)
5905 || SREF (name
, this_mod_end
) != '-')
5908 /* This modifier is real; look for another. */
5909 modifiers
|= this_mod
;
5910 i
= this_mod_end
+ 1;
5913 /* Should we include the `click' modifier? */
5914 if (! (modifiers
& (down_modifier
| drag_modifier
5915 | double_modifier
| triple_modifier
))
5916 && i
+ 7 == SBYTES (name
)
5917 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5918 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5919 modifiers
|= click_modifier
;
5927 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5928 prepended to the string BASE[0..BASE_LEN-1].
5929 This doesn't use any caches. */
5931 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5934 int base_len
, base_len_byte
;
5936 /* Since BASE could contain nulls, we can't use intern here; we have
5937 to use Fintern, which expects a genuine Lisp_String, and keeps a
5940 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5946 /* Only the event queue may use the `up' modifier; it should always
5947 be turned into a click or drag event before presented to lisp code. */
5948 if (modifiers
& up_modifier
)
5951 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5952 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5953 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5954 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5955 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5956 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5957 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5958 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5959 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5960 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5961 /* The click modifier is denoted by the absence of other modifiers. */
5965 mod_len
= p
- new_mods
;
5969 Lisp_Object new_name
;
5971 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5972 mod_len
+ base_len_byte
);
5973 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5974 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5976 return Fintern (new_name
, Qnil
);
5981 static char *modifier_names
[] =
5983 "up", "down", "drag", "click", "double", "triple", 0, 0,
5984 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5985 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5987 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5989 static Lisp_Object modifier_symbols
;
5991 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5993 lispy_modifier_list (modifiers
)
5996 Lisp_Object modifier_list
;
5999 modifier_list
= Qnil
;
6000 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6001 if (modifiers
& (1<<i
))
6002 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6005 return modifier_list
;
6009 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6010 where UNMODIFIED is the unmodified form of SYMBOL,
6011 MASK is the set of modifiers present in SYMBOL's name.
6012 This is similar to parse_modifiers_uncached, but uses the cache in
6013 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6014 Qevent_symbol_elements property. */
6017 parse_modifiers (symbol
)
6020 Lisp_Object elements
;
6022 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6023 if (CONSP (elements
))
6028 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6029 Lisp_Object unmodified
;
6032 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6033 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6036 if (modifiers
& ~VALMASK
)
6038 XSETFASTINT (mask
, modifiers
);
6039 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6041 /* Cache the parsing results on SYMBOL. */
6042 Fput (symbol
, Qevent_symbol_element_mask
,
6044 Fput (symbol
, Qevent_symbol_elements
,
6045 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6047 /* Since we know that SYMBOL is modifiers applied to unmodified,
6048 it would be nice to put that in unmodified's cache.
6049 But we can't, since we're not sure that parse_modifiers is
6056 /* Apply the modifiers MODIFIERS to the symbol BASE.
6057 BASE must be unmodified.
6059 This is like apply_modifiers_uncached, but uses BASE's
6060 Qmodifier_cache property, if present. It also builds
6061 Qevent_symbol_elements properties, since it has that info anyway.
6063 apply_modifiers copies the value of BASE's Qevent_kind property to
6064 the modified symbol. */
6066 apply_modifiers (modifiers
, base
)
6070 Lisp_Object cache
, index
, entry
, new_symbol
;
6072 /* Mask out upper bits. We don't know where this value's been. */
6073 modifiers
&= VALMASK
;
6075 /* The click modifier never figures into cache indices. */
6076 cache
= Fget (base
, Qmodifier_cache
);
6077 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6078 entry
= assq_no_quit (index
, cache
);
6081 new_symbol
= XCDR (entry
);
6084 /* We have to create the symbol ourselves. */
6085 new_symbol
= apply_modifiers_uncached (modifiers
,
6086 SDATA (SYMBOL_NAME (base
)),
6087 SCHARS (SYMBOL_NAME (base
)),
6088 SBYTES (SYMBOL_NAME (base
)));
6090 /* Add the new symbol to the base's cache. */
6091 entry
= Fcons (index
, new_symbol
);
6092 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6094 /* We have the parsing info now for free, so add it to the caches. */
6095 XSETFASTINT (index
, modifiers
);
6096 Fput (new_symbol
, Qevent_symbol_element_mask
,
6097 Fcons (base
, Fcons (index
, Qnil
)));
6098 Fput (new_symbol
, Qevent_symbol_elements
,
6099 Fcons (base
, lispy_modifier_list (modifiers
)));
6102 /* Make sure this symbol is of the same kind as BASE.
6104 You'd think we could just set this once and for all when we
6105 intern the symbol above, but reorder_modifiers may call us when
6106 BASE's property isn't set right; we can't assume that just
6107 because it has a Qmodifier_cache property it must have its
6108 Qevent_kind set right as well. */
6109 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6113 kind
= Fget (base
, Qevent_kind
);
6115 Fput (new_symbol
, Qevent_kind
, kind
);
6122 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6123 return a symbol with the modifiers placed in the canonical order.
6124 Canonical order is alphabetical, except for down and drag, which
6125 always come last. The 'click' modifier is never written out.
6127 Fdefine_key calls this to make sure that (for example) C-M-foo
6128 and M-C-foo end up being equivalent in the keymap. */
6131 reorder_modifiers (symbol
)
6134 /* It's hopefully okay to write the code this way, since everything
6135 will soon be in caches, and no consing will be done at all. */
6138 parsed
= parse_modifiers (symbol
);
6139 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6144 /* For handling events, we often want to produce a symbol whose name
6145 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6146 to some base, like the name of a function key or mouse button.
6147 modify_event_symbol produces symbols of this sort.
6149 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6150 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6153 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6154 into symbol names, or a string specifying a name stem used to
6155 construct a symbol name or the form `STEM-N', where N is the decimal
6156 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6157 non-nil; otherwise NAME_TABLE is used.
6159 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6160 persist between calls to modify_event_symbol that it can use to
6161 store a cache of the symbols it's generated for this NAME_TABLE
6162 before. The object stored there may be a vector or an alist.
6164 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6166 MODIFIERS is a set of modifier bits (as given in struct input_events)
6167 whose prefixes should be applied to the symbol name.
6169 SYMBOL_KIND is the value to be placed in the event_kind property of
6170 the returned symbol.
6172 The symbols we create are supposed to have an
6173 `event-symbol-elements' property, which lists the modifiers present
6174 in the symbol's name. */
6177 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6178 name_table
, symbol_table
, table_size
)
6181 Lisp_Object symbol_kind
;
6182 Lisp_Object name_alist_or_stem
;
6184 Lisp_Object
*symbol_table
;
6185 unsigned int table_size
;
6188 Lisp_Object symbol_int
;
6190 /* Get rid of the "vendor-specific" bit here. */
6191 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6193 /* Is this a request for a valid symbol? */
6194 if (symbol_num
< 0 || symbol_num
>= table_size
)
6197 if (CONSP (*symbol_table
))
6198 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6200 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6201 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6202 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6203 we've never used that symbol before. */
6206 if (! VECTORP (*symbol_table
)
6207 || XVECTOR (*symbol_table
)->size
!= table_size
)
6211 XSETFASTINT (size
, table_size
);
6212 *symbol_table
= Fmake_vector (size
, Qnil
);
6215 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6218 /* Have we already used this symbol before? */
6221 /* No; let's create it. */
6222 if (CONSP (name_alist_or_stem
))
6223 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6224 else if (STRINGP (name_alist_or_stem
))
6226 int len
= SBYTES (name_alist_or_stem
);
6227 char *buf
= (char *) alloca (len
+ 50);
6228 if (sizeof (int) == sizeof (EMACS_INT
))
6229 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6230 XINT (symbol_int
) + 1);
6231 else if (sizeof (long) == sizeof (EMACS_INT
))
6232 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6233 XINT (symbol_int
) + 1);
6234 value
= intern (buf
);
6236 else if (name_table
!= 0 && name_table
[symbol_num
])
6237 value
= intern (name_table
[symbol_num
]);
6239 #ifdef HAVE_WINDOW_SYSTEM
6242 char *name
= x_get_keysym_name (symbol_num
);
6244 value
= intern (name
);
6251 sprintf (buf
, "key-%d", symbol_num
);
6252 value
= intern (buf
);
6255 if (CONSP (*symbol_table
))
6256 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6258 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6260 /* Fill in the cache entries for this symbol; this also
6261 builds the Qevent_symbol_elements property, which the user
6263 apply_modifiers (modifiers
& click_modifier
, value
);
6264 Fput (value
, Qevent_kind
, symbol_kind
);
6267 /* Apply modifiers to that symbol. */
6268 return apply_modifiers (modifiers
, value
);
6271 /* Convert a list that represents an event type,
6272 such as (ctrl meta backspace), into the usual representation of that
6273 event type as a number or a symbol. */
6275 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6276 doc
: /* Convert the event description list EVENT-DESC to an event type.
6277 EVENT-DESC should contain one base event type (a character or symbol)
6278 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6279 drag, down, double or triple). The base must be last.
6280 The return value is an event type (a character or symbol) which
6281 has the same base event type and all the specified modifiers. */)
6283 Lisp_Object event_desc
;
6291 while (CONSP (rest
))
6299 /* Given a symbol, see if it is a modifier name. */
6300 if (SYMBOLP (elt
) && CONSP (rest
))
6301 this = parse_solitary_modifier (elt
);
6305 else if (!NILP (base
))
6306 error ("Two bases given in one event");
6312 /* Let the symbol A refer to the character A. */
6313 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6314 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6316 if (INTEGERP (base
))
6318 /* Turn (shift a) into A. */
6319 if ((modifiers
& shift_modifier
) != 0
6320 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6322 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6323 modifiers
&= ~shift_modifier
;
6326 /* Turn (control a) into C-a. */
6327 if (modifiers
& ctrl_modifier
)
6328 return make_number ((modifiers
& ~ctrl_modifier
)
6329 | make_ctrl_char (XINT (base
)));
6331 return make_number (modifiers
| XINT (base
));
6333 else if (SYMBOLP (base
))
6334 return apply_modifiers (modifiers
, base
);
6337 error ("Invalid base event");
6342 /* Try to recognize SYMBOL as a modifier name.
6343 Return the modifier flag bit, or 0 if not recognized. */
6346 parse_solitary_modifier (symbol
)
6349 Lisp_Object name
= SYMBOL_NAME (symbol
);
6351 switch (SREF (name
, 0))
6353 #define SINGLE_LETTER_MOD(BIT) \
6354 if (SBYTES (name) == 1) \
6357 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6358 if (LEN == SBYTES (name) \
6359 && ! strncmp (SDATA (name), NAME, LEN)) \
6363 SINGLE_LETTER_MOD (alt_modifier
);
6367 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6371 SINGLE_LETTER_MOD (ctrl_modifier
);
6375 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6376 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6380 SINGLE_LETTER_MOD (hyper_modifier
);
6384 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6388 SINGLE_LETTER_MOD (meta_modifier
);
6392 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6396 SINGLE_LETTER_MOD (shift_modifier
);
6400 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6401 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6402 SINGLE_LETTER_MOD (super_modifier
);
6406 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6407 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6408 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6412 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6415 #undef SINGLE_LETTER_MOD
6416 #undef MULTI_LETTER_MOD
6422 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6423 Such a list is not valid as an event,
6424 but it can be a Lucid-style event type list. */
6427 lucid_event_type_list_p (object
)
6432 if (! CONSP (object
))
6435 if (EQ (XCAR (object
), Qhelp_echo
)
6436 || EQ (XCAR (object
), Qvertical_line
)
6437 || EQ (XCAR (object
), Qmode_line
)
6438 || EQ (XCAR (object
), Qheader_line
))
6441 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6445 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6452 /* Store into *addr a value nonzero if terminal input chars are available.
6453 Serves the purpose of ioctl (0, FIONREAD, addr)
6454 but works even if FIONREAD does not exist.
6455 (In fact, this may actually read some input.)
6457 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6458 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6461 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6466 /* First of all, have we already counted some input? */
6467 *addr
= (!NILP (Vquit_flag
)
6468 || readable_filtered_events (do_timers_now
, filter_events
));
6470 /* If input is being read as it arrives, and we have none, there is none. */
6471 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6474 /* Try to read some input and see how much we get. */
6476 *addr
= (!NILP (Vquit_flag
)
6477 || readable_filtered_events (do_timers_now
, filter_events
));
6480 /* Store into *addr a value nonzero if terminal input chars are available.
6481 Serves the purpose of ioctl (0, FIONREAD, addr)
6482 but works even if FIONREAD does not exist.
6483 (In fact, this may actually read some input.)
6485 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6488 get_input_pending (addr
, do_timers_now
)
6492 get_filtered_input_pending (addr
, do_timers_now
, 0);
6495 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6498 gobble_input (expected
)
6503 if (interrupt_input
)
6506 mask
= sigblock (sigmask (SIGIO
));
6507 read_avail_input (expected
);
6511 #ifdef POLL_FOR_INPUT
6512 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6515 mask
= sigblock (sigmask (SIGALRM
));
6516 read_avail_input (expected
);
6522 read_avail_input (expected
);
6526 /* Put a BUFFER_SWITCH_EVENT in the buffer
6527 so that read_key_sequence will notice the new current buffer. */
6530 record_asynch_buffer_change ()
6532 struct input_event event
;
6535 event
.kind
= BUFFER_SWITCH_EVENT
;
6536 event
.frame_or_window
= Qnil
;
6540 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6541 The purpose of the event is to make read_key_sequence look up the
6542 keymaps again. If we aren't in read_key_sequence, we don't need one,
6543 and the event could cause trouble by messing up (input-pending-p). */
6544 tem
= Fwaiting_for_user_input_p ();
6548 /* We never need these events if we have no asynchronous subprocesses. */
6552 /* Make sure no interrupt happens while storing the event. */
6554 if (interrupt_input
)
6557 mask
= sigblock (sigmask (SIGIO
));
6558 kbd_buffer_store_event (&event
);
6565 kbd_buffer_store_event (&event
);
6572 /* Read any terminal input already buffered up by the system
6573 into the kbd_buffer, but do not wait.
6575 EXPECTED should be nonzero if the caller knows there is some input.
6577 Except on VMS, all input is read by this function.
6578 If interrupt_input is nonzero, this function MUST be called
6579 only when SIGIO is blocked.
6581 Returns the number of keyboard chars read, or -1 meaning
6582 this is a bad time to try to read input. */
6585 read_avail_input (expected
)
6588 struct input_event buf
[KBD_BUFFER_SIZE
];
6592 if (read_socket_hook
)
6593 /* No need for FIONREAD or fcntl; just say don't wait. */
6594 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6597 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6598 the kbd_buffer can really hold. That may prevent loss
6599 of characters on some systems when input is stuffed at us. */
6600 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6603 /* Determine how many characters we should *try* to read. */
6606 #else /* not WINDOWSNT */
6608 n_to_read
= dos_keysns ();
6611 #else /* not MSDOS */
6613 /* Find out how much input is available. */
6614 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6615 /* Formerly simply reported no input, but that sometimes led to
6616 a failure of Emacs to terminate.
6617 SIGHUP seems appropriate if we can't reach the terminal. */
6618 /* ??? Is it really right to send the signal just to this process
6619 rather than to the whole process group?
6620 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6621 kill (getpid (), SIGHUP
);
6624 if (n_to_read
> sizeof cbuf
)
6625 n_to_read
= sizeof cbuf
;
6626 #else /* no FIONREAD */
6627 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6628 /* Read some input if available, but don't wait. */
6629 n_to_read
= sizeof cbuf
;
6630 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6635 #endif /* not MSDOS */
6636 #endif /* not WINDOWSNT */
6638 /* Now read; for one reason or another, this will not block.
6639 NREAD is set to the number of chars read. */
6643 cbuf
[0] = dos_keyread ();
6646 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6648 /* POSIX infers that processes which are not in the session leader's
6649 process group won't get SIGHUP's at logout time. BSDI adheres to
6650 this part standard and returns -1 from read (0) with errno==EIO
6651 when the control tty is taken away.
6652 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6653 if (nread
== -1 && errno
== EIO
)
6655 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6656 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6657 This looks incorrect, but it isn't, because _BSD causes
6658 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6659 and that causes a value other than 0 when there is no input. */
6665 /* We used to retry the read if it was interrupted.
6666 But this does the wrong thing when O_NDELAY causes
6667 an EAGAIN error. Does anybody know of a situation
6668 where a retry is actually needed? */
6670 nread
< 0 && (errno
== EAGAIN
6684 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6685 fcntl (input_fd
, F_SETFL
, 0);
6686 #endif /* USG or DGUX or CYGWIN */
6687 #endif /* no FIONREAD */
6688 for (i
= 0; i
< nread
; i
++)
6690 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6691 buf
[i
].modifiers
= 0;
6692 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6693 buf
[i
].modifiers
= meta_modifier
;
6697 buf
[i
].code
= cbuf
[i
];
6698 buf
[i
].frame_or_window
= selected_frame
;
6703 /* Scan the chars for C-g and store them in kbd_buffer. */
6704 for (i
= 0; i
< nread
; i
++)
6706 kbd_buffer_store_event (&buf
[i
]);
6707 /* Don't look at input that follows a C-g too closely.
6708 This reduces lossage due to autorepeat on C-g. */
6709 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6710 && buf
[i
].code
== quit_char
)
6716 #endif /* not VMS */
6718 #ifdef SIGIO /* for entire page */
6719 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6722 input_available_signal (signo
)
6725 /* Must preserve main program's value of errno. */
6726 int old_errno
= errno
;
6728 extern int select_alarmed
;
6731 #if defined (USG) && !defined (POSIX_SIGNALS)
6732 /* USG systems forget handlers when they are used;
6733 must reestablish each time */
6734 signal (signo
, input_available_signal
);
6741 if (input_available_clear_time
)
6742 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6747 nread
= read_avail_input (1);
6748 /* -1 means it's not ok to read the input now.
6749 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6750 0 means there was no keyboard input available. */
6755 select_alarmed
= 1; /* Force the select emulator back to life */
6766 /* Send ourselves a SIGIO.
6768 This function exists so that the UNBLOCK_INPUT macro in
6769 blockinput.h can have some way to take care of input we put off
6770 dealing with, without assuming that every file which uses
6771 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6773 reinvoke_input_signal ()
6776 kill (getpid (), SIGIO
);
6782 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6783 static Lisp_Object menu_bar_one_keymap_changed_items
;
6785 /* These variables hold the vector under construction within
6786 menu_bar_items and its subroutines, and the current index
6787 for storing into that vector. */
6788 static Lisp_Object menu_bar_items_vector
;
6789 static int menu_bar_items_index
;
6791 /* Return a vector of menu items for a menu bar, appropriate
6792 to the current buffer. Each item has three elements in the vector:
6795 OLD is an old vector we can optionally reuse, or nil. */
6798 menu_bar_items (old
)
6801 /* The number of keymaps we're scanning right now, and the number of
6802 keymaps we have allocated space for. */
6805 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6806 in the current keymaps, or nil where it is not a prefix. */
6809 Lisp_Object def
, tail
;
6818 struct gcpro gcpro1
;
6820 /* In order to build the menus, we need to call the keymap
6821 accessors. They all call QUIT. But this function is called
6822 during redisplay, during which a quit is fatal. So inhibit
6823 quitting while building the menus.
6824 We do this instead of specbind because (1) errors will clear it anyway
6825 and (2) this avoids risk of specpdl overflow. */
6826 oquit
= Vinhibit_quit
;
6830 menu_bar_items_vector
= old
;
6832 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6833 menu_bar_items_index
= 0;
6835 GCPRO1 (menu_bar_items_vector
);
6837 /* Build our list of keymaps.
6838 If we recognize a function key and replace its escape sequence in
6839 keybuf with its symbol, or if the sequence starts with a mouse
6840 click and we need to switch buffers, we jump back here to rebuild
6841 the initial keymaps from the current buffer. */
6845 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6846 if (!NILP (Voverriding_local_map_menu_flag
))
6848 /* Yes, use them (if non-nil) as well as the global map. */
6849 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6851 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6852 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6853 if (!NILP (Voverriding_local_map
))
6854 maps
[nmaps
++] = Voverriding_local_map
;
6858 /* No, so use major and minor mode keymaps and keymap property.
6859 Note that menu-bar bindings in the local-map and keymap
6860 properties may not work reliable, as they are only
6861 recognized when the menu-bar (or mode-line) is updated,
6862 which does not normally happen after every command. */
6865 nminor
= current_minor_maps (NULL
, &tmaps
);
6866 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6868 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6869 maps
[nmaps
++] = tem
;
6870 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6872 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6874 maps
[nmaps
++] = current_global_map
;
6877 /* Look up in each map the dummy prefix key `menu-bar'. */
6881 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6882 if (!NILP (maps
[mapno
]))
6884 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6888 menu_bar_one_keymap_changed_items
= Qnil
;
6889 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6893 /* Move to the end those items that should be at the end. */
6895 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6898 int end
= menu_bar_items_index
;
6900 for (i
= 0; i
< end
; i
+= 4)
6901 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6903 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6904 /* Move the item at index I to the end,
6905 shifting all the others forward. */
6906 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6907 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6908 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6909 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6911 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6912 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6913 (end
- i
- 4) * sizeof (Lisp_Object
));
6914 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6915 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6916 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6917 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6922 /* Add nil, nil, nil, nil at the end. */
6923 i
= menu_bar_items_index
;
6924 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6927 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6928 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6929 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6930 menu_bar_items_vector
= tem
;
6932 /* Add this item. */
6933 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6934 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6935 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6936 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6937 menu_bar_items_index
= i
;
6939 Vinhibit_quit
= oquit
;
6941 return menu_bar_items_vector
;
6944 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6945 If there's already an item for KEY, add this DEF to it. */
6947 Lisp_Object item_properties
;
6950 menu_bar_item (key
, item
, dummy1
, dummy2
)
6951 Lisp_Object key
, item
, dummy1
;
6954 struct gcpro gcpro1
;
6958 if (EQ (item
, Qundefined
))
6960 /* If a map has an explicit `undefined' as definition,
6961 discard any previously made menu bar item. */
6963 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6964 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6966 if (menu_bar_items_index
> i
+ 4)
6967 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6968 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6969 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6970 menu_bar_items_index
-= 4;
6974 /* If this keymap has already contributed to this KEY,
6975 don't contribute to it a second time. */
6976 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6977 if (!NILP (tem
) || NILP (item
))
6980 menu_bar_one_keymap_changed_items
6981 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6983 /* We add to menu_bar_one_keymap_changed_items before doing the
6984 parse_menu_item, so that if it turns out it wasn't a menu item,
6985 it still correctly hides any further menu item. */
6987 i
= parse_menu_item (item
, 0, 1);
6992 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6994 /* Find any existing item for this KEY. */
6995 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6996 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6999 /* If we did not find this KEY, add it at the end. */
7000 if (i
== menu_bar_items_index
)
7002 /* If vector is too small, get a bigger one. */
7003 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7006 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7007 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7008 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7009 menu_bar_items_vector
= tem
;
7012 /* Add this item. */
7013 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7014 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7015 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7016 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7017 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7018 menu_bar_items_index
= i
;
7020 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7024 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7025 /* If the new and the old items are not both keymaps,
7026 the lookup will only find `item'. */
7027 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7028 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7032 /* This is used as the handler when calling menu_item_eval_property. */
7034 menu_item_eval_property_1 (arg
)
7037 /* If we got a quit from within the menu computation,
7038 quit all the way out of it. This takes care of C-] in the debugger. */
7039 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7040 Fsignal (Qquit
, Qnil
);
7045 /* Evaluate an expression and return the result (or nil if something
7046 went wrong). Used to evaluate dynamic parts of menu items. */
7048 menu_item_eval_property (sexpr
)
7051 int count
= SPECPDL_INDEX ();
7053 specbind (Qinhibit_redisplay
, Qt
);
7054 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7055 menu_item_eval_property_1
);
7056 return unbind_to (count
, val
);
7059 /* This function parses a menu item and leaves the result in the
7060 vector item_properties.
7061 ITEM is a key binding, a possible menu item.
7062 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7063 evaluate dynamic expressions in the menu item.
7064 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7066 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7067 parse_menu_item returns true if the item is a menu item and false
7071 parse_menu_item (item
, notreal
, inmenubar
)
7073 int notreal
, inmenubar
;
7075 Lisp_Object def
, tem
, item_string
, start
;
7076 Lisp_Object cachelist
;
7078 Lisp_Object keyhint
;
7089 /* Create item_properties vector if necessary. */
7090 if (NILP (item_properties
))
7092 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7094 /* Initialize optional entries. */
7095 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7096 AREF (item_properties
, i
) = Qnil
;
7097 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7099 /* Save the item here to protect it from GC. */
7100 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7102 item_string
= XCAR (item
);
7106 if (STRINGP (item_string
))
7108 /* Old format menu item. */
7109 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7111 /* Maybe help string. */
7112 if (CONSP (item
) && STRINGP (XCAR (item
)))
7114 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7119 /* Maybe key binding cache. */
7120 if (CONSP (item
) && CONSP (XCAR (item
))
7121 && (NILP (XCAR (XCAR (item
)))
7122 || VECTORP (XCAR (XCAR (item
)))))
7124 cachelist
= XCAR (item
);
7128 /* This is the real definition--the function to run. */
7129 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7131 /* Get enable property, if any. */
7134 tem
= Fget (item
, Qmenu_enable
);
7136 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7139 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7141 /* New format menu item. */
7142 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7143 start
= XCDR (item
);
7146 /* We have a real binding. */
7147 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7149 item
= XCDR (start
);
7150 /* Is there a cache list with key equivalences. */
7151 if (CONSP (item
) && CONSP (XCAR (item
)))
7153 cachelist
= XCAR (item
);
7157 /* Parse properties. */
7158 while (CONSP (item
) && CONSP (XCDR (item
)))
7163 if (EQ (tem
, QCenable
))
7164 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7165 else if (EQ (tem
, QCvisible
) && !notreal
)
7167 /* If got a visible property and that evaluates to nil
7168 then ignore this item. */
7169 tem
= menu_item_eval_property (XCAR (item
));
7173 else if (EQ (tem
, QChelp
))
7174 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7175 else if (EQ (tem
, QCfilter
))
7177 else if (EQ (tem
, QCkey_sequence
))
7180 if (NILP (cachelist
)
7181 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7182 /* Be GC protected. Set keyhint to item instead of tem. */
7185 else if (EQ (tem
, QCkeys
))
7188 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7189 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7191 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7196 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7198 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7200 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7207 else if (inmenubar
|| !NILP (start
))
7211 return 0; /* not a menu item */
7213 /* If item string is not a string, evaluate it to get string.
7214 If we don't get a string, skip this item. */
7215 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7216 if (!(STRINGP (item_string
) || notreal
))
7218 item_string
= menu_item_eval_property (item_string
);
7219 if (!STRINGP (item_string
))
7221 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7224 /* If got a filter apply it on definition. */
7225 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7228 def
= menu_item_eval_property (list2 (XCAR (filter
),
7229 list2 (Qquote
, def
)));
7231 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7234 /* Enable or disable selection of item. */
7235 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7241 tem
= menu_item_eval_property (tem
);
7242 if (inmenubar
&& NILP (tem
))
7243 return 0; /* Ignore disabled items in menu bar. */
7244 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7247 /* If we got no definition, this item is just unselectable text which
7248 is OK in a submenu but not in the menubar. */
7250 return (inmenubar
? 0 : 1);
7252 /* See if this is a separate pane or a submenu. */
7253 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7254 tem
= get_keymap (def
, 0, 1);
7255 /* For a subkeymap, just record its details and exit. */
7258 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7259 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7263 /* At the top level in the menu bar, do likewise for commands also.
7264 The menu bar does not display equivalent key bindings anyway.
7265 ITEM_PROPERTY_DEF is already set up properly. */
7269 /* This is a command. See if there is an equivalent key binding. */
7270 if (NILP (cachelist
))
7272 /* We have to create a cachelist. */
7273 CHECK_IMPURE (start
);
7274 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7275 cachelist
= XCAR (XCDR (start
));
7277 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7278 if (!NILP (keyhint
))
7280 XSETCAR (cachelist
, XCAR (keyhint
));
7283 else if (STRINGP (tem
))
7285 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7286 XSETCAR (cachelist
, Qt
);
7290 tem
= XCAR (cachelist
);
7297 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7299 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7302 def
= XCAR (prefix
);
7303 prefix
= XCDR (prefix
);
7306 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7308 if (!update_menu_bindings
)
7310 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7312 if (newcache
/* Always check first time. */
7313 /* Should we check everything when precomputing key
7315 /* If something had no key binding before, don't recheck it
7316 because that is too slow--except if we have a list of
7317 rebound commands in Vdefine_key_rebound_commands, do
7318 recheck any command that appears in that list. */
7319 || (CONSP (Vdefine_key_rebound_commands
)
7320 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7323 /* We had a saved key. Is it still bound to the command? */
7326 /* If the command is an alias for another
7327 (such as lmenu.el set it up), check if the
7328 original command matches the cached command. */
7329 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7330 chkcache
= 1; /* Need to recompute key binding. */
7334 /* Recompute equivalent key binding. If the command is an alias
7335 for another (such as lmenu.el set it up), see if the original
7336 command name has equivalent keys. Otherwise look up the
7337 specified command itself. We don't try both, because that
7338 makes lmenu menus slow. */
7340 && SYMBOLP (XSYMBOL (def
)->function
)
7341 && ! NILP (Fget (def
, Qmenu_alias
)))
7342 def
= XSYMBOL (def
)->function
;
7343 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7344 XSETCAR (cachelist
, tem
);
7347 XSETCDR (cachelist
, Qnil
);
7351 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7353 tem
= XCAR (cachelist
);
7357 newcache
= chkcache
;
7360 tem
= Fkey_description (tem
);
7363 if (STRINGP (XCAR (prefix
)))
7364 tem
= concat2 (XCAR (prefix
), tem
);
7365 if (STRINGP (XCDR (prefix
)))
7366 tem
= concat2 (tem
, XCDR (prefix
));
7368 XSETCDR (cachelist
, tem
);
7372 tem
= XCDR (cachelist
);
7373 if (newcache
&& !NILP (tem
))
7375 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7376 XSETCDR (cachelist
, tem
);
7379 /* If we only want to precompute equivalent key bindings, stop here. */
7383 /* If we have an equivalent key binding, use that. */
7384 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7386 /* Include this when menu help is implemented.
7387 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7388 if (!(NILP (tem) || STRINGP (tem)))
7390 tem = menu_item_eval_property (tem);
7393 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7397 /* Handle radio buttons or toggle boxes. */
7398 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7400 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7401 = menu_item_eval_property (tem
);
7408 /***********************************************************************
7410 ***********************************************************************/
7412 /* A vector holding tool bar items while they are parsed in function
7413 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7416 static Lisp_Object tool_bar_items_vector
;
7418 /* A vector holding the result of parse_tool_bar_item. Layout is like
7419 the one for a single item in tool_bar_items_vector. */
7421 static Lisp_Object tool_bar_item_properties
;
7423 /* Next free index in tool_bar_items_vector. */
7425 static int ntool_bar_items
;
7427 /* The symbols `tool-bar', and `:image'. */
7429 extern Lisp_Object Qtool_bar
;
7430 Lisp_Object QCimage
;
7432 /* Function prototypes. */
7434 static void init_tool_bar_items
P_ ((Lisp_Object
));
7435 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7436 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7437 static void append_tool_bar_item
P_ ((void));
7440 /* Return a vector of tool bar items for keymaps currently in effect.
7441 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7442 tool bar items found. */
7445 tool_bar_items (reuse
, nitems
)
7456 /* In order to build the menus, we need to call the keymap
7457 accessors. They all call QUIT. But this function is called
7458 during redisplay, during which a quit is fatal. So inhibit
7459 quitting while building the menus. We do this instead of
7460 specbind because (1) errors will clear it anyway and (2) this
7461 avoids risk of specpdl overflow. */
7462 oquit
= Vinhibit_quit
;
7465 /* Initialize tool_bar_items_vector and protect it from GC. */
7466 init_tool_bar_items (reuse
);
7468 /* Build list of keymaps in maps. Set nmaps to the number of maps
7471 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7472 if (!NILP (Voverriding_local_map_menu_flag
))
7474 /* Yes, use them (if non-nil) as well as the global map. */
7475 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7477 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7478 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7479 if (!NILP (Voverriding_local_map
))
7480 maps
[nmaps
++] = Voverriding_local_map
;
7484 /* No, so use major and minor mode keymaps and keymap property.
7485 Note that tool-bar bindings in the local-map and keymap
7486 properties may not work reliable, as they are only
7487 recognized when the tool-bar (or mode-line) is updated,
7488 which does not normally happen after every command. */
7491 nminor
= current_minor_maps (NULL
, &tmaps
);
7492 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7494 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7495 maps
[nmaps
++] = tem
;
7496 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7498 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7501 /* Add global keymap at the end. */
7502 maps
[nmaps
++] = current_global_map
;
7504 /* Process maps in reverse order and look up in each map the prefix
7506 for (i
= nmaps
- 1; i
>= 0; --i
)
7507 if (!NILP (maps
[i
]))
7511 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7516 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7517 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7519 Lisp_Object keydef
= XCAR (tail
);
7521 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7526 Vinhibit_quit
= oquit
;
7527 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7528 return tool_bar_items_vector
;
7532 /* Process the definition of KEY which is DEF. */
7535 process_tool_bar_item (key
, def
)
7536 Lisp_Object key
, def
;
7539 extern Lisp_Object Qundefined
;
7540 struct gcpro gcpro1
, gcpro2
;
7542 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7546 if (EQ (def
, Qundefined
))
7548 /* If a map has an explicit `undefined' as definition,
7549 discard any previously made item. */
7550 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7552 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7554 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7556 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7557 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7558 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7559 * sizeof (Lisp_Object
)));
7560 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7565 else if (parse_tool_bar_item (key
, def
))
7566 /* Append a new tool bar item to tool_bar_items_vector. Accept
7567 more than one definition for the same key. */
7568 append_tool_bar_item ();
7574 /* Parse a tool bar item specification ITEM for key KEY and return the
7575 result in tool_bar_item_properties. Value is zero if ITEM is
7578 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7580 CAPTION is the caption of the item, If it's not a string, it is
7581 evaluated to get a string.
7583 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7584 as binding are currently ignored.
7586 The following properties are recognized:
7590 FORM is evaluated and specifies whether the tool bar item is
7591 enabled or disabled.
7595 FORM is evaluated and specifies whether the tool bar item is visible.
7597 - `:filter FUNCTION'
7599 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7600 result is stored as the new binding.
7602 - `:button (TYPE SELECTED)'
7604 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7605 and specifies whether the button is selected (pressed) or not.
7609 IMAGES is either a single image specification or a vector of four
7610 image specifications. See enum tool_bar_item_images.
7612 - `:help HELP-STRING'.
7614 Gives a help string to display for the tool bar item. */
7617 parse_tool_bar_item (key
, item
)
7618 Lisp_Object key
, item
;
7620 /* Access slot with index IDX of vector tool_bar_item_properties. */
7621 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7623 Lisp_Object filter
= Qnil
;
7624 Lisp_Object caption
;
7627 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7628 Rule out items that aren't lists, don't start with
7629 `menu-item' or whose rest following `tool-bar-item' is not a
7632 || !EQ (XCAR (item
), Qmenu_item
)
7633 || (item
= XCDR (item
),
7637 /* Create tool_bar_item_properties vector if necessary. Reset it to
7639 if (VECTORP (tool_bar_item_properties
))
7641 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7645 tool_bar_item_properties
7646 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7649 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7650 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7652 /* Get the caption of the item. If the caption is not a string,
7653 evaluate it to get a string. If we don't get a string, skip this
7655 caption
= XCAR (item
);
7656 if (!STRINGP (caption
))
7658 caption
= menu_item_eval_property (caption
);
7659 if (!STRINGP (caption
))
7662 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7664 /* Give up if rest following the caption is not a list. */
7669 /* Store the binding. */
7670 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7673 /* Ignore cached key binding, if any. */
7674 if (CONSP (item
) && CONSP (XCAR (item
)))
7677 /* Process the rest of the properties. */
7678 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7680 Lisp_Object key
, value
;
7683 value
= XCAR (XCDR (item
));
7685 if (EQ (key
, QCenable
))
7686 /* `:enable FORM'. */
7687 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7688 else if (EQ (key
, QCvisible
))
7690 /* `:visible FORM'. If got a visible property and that
7691 evaluates to nil then ignore this item. */
7692 if (NILP (menu_item_eval_property (value
)))
7695 else if (EQ (key
, QChelp
))
7696 /* `:help HELP-STRING'. */
7697 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7698 else if (EQ (key
, QCfilter
))
7699 /* ':filter FORM'. */
7701 else if (EQ (key
, QCbutton
) && CONSP (value
))
7703 /* `:button (TYPE . SELECTED)'. */
7704 Lisp_Object type
, selected
;
7706 type
= XCAR (value
);
7707 selected
= XCDR (value
);
7708 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7710 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7711 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7714 else if (EQ (key
, QCimage
)
7716 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7717 /* Value is either a single image specification or a vector
7718 of 4 such specifications for the different button states. */
7719 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7722 /* If got a filter apply it on binding. */
7724 PROP (TOOL_BAR_ITEM_BINDING
)
7725 = menu_item_eval_property (list2 (filter
,
7727 PROP (TOOL_BAR_ITEM_BINDING
))));
7729 /* See if the binding is a keymap. Give up if it is. */
7730 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7733 /* Enable or disable selection of item. */
7734 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7735 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7736 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7738 /* Handle radio buttons or toggle boxes. */
7739 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7740 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7741 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7749 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7750 that can be reused. */
7753 init_tool_bar_items (reuse
)
7756 if (VECTORP (reuse
))
7757 tool_bar_items_vector
= reuse
;
7759 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7760 ntool_bar_items
= 0;
7764 /* Append parsed tool bar item properties from
7765 tool_bar_item_properties */
7768 append_tool_bar_item ()
7770 Lisp_Object
*to
, *from
;
7772 /* Enlarge tool_bar_items_vector if necessary. */
7773 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7774 >= XVECTOR (tool_bar_items_vector
)->size
)
7776 Lisp_Object new_vector
;
7777 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7779 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7780 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7781 XVECTOR (new_vector
)->contents
,
7782 old_size
* sizeof (Lisp_Object
));
7783 tool_bar_items_vector
= new_vector
;
7786 /* Append entries from tool_bar_item_properties to the end of
7787 tool_bar_items_vector. */
7788 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7789 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7790 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7791 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7798 /* Read a character using menus based on maps in the array MAPS.
7799 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7800 Return t if we displayed a menu but the user rejected it.
7802 PREV_EVENT is the previous input event, or nil if we are reading
7803 the first event of a key sequence.
7805 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7806 if we used a mouse menu to read the input, or zero otherwise. If
7807 USED_MOUSE_MENU is null, we don't dereference it.
7809 The prompting is done based on the prompt-string of the map
7810 and the strings associated with various map elements.
7812 This can be done with X menus or with menus put in the minibuf.
7813 These are done in different ways, depending on how the input will be read.
7814 Menus using X are done after auto-saving in read-char, getting the input
7815 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7816 and do auto-saving in the inner call of read_char. */
7819 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7822 Lisp_Object prev_event
;
7823 int *used_mouse_menu
;
7826 register Lisp_Object name
= Qnil
;
7828 if (used_mouse_menu
)
7829 *used_mouse_menu
= 0;
7831 /* Use local over global Menu maps */
7833 if (! menu_prompting
)
7836 /* Optionally disregard all but the global map. */
7837 if (inhibit_local_menu_bar_menus
)
7839 maps
+= (nmaps
- 1);
7843 /* Get the menu name from the first map that has one (a prompt string). */
7844 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7846 name
= Fkeymap_prompt (maps
[mapno
]);
7851 /* If we don't have any menus, just read a character normally. */
7852 if (!STRINGP (name
))
7856 /* If we got to this point via a mouse click,
7857 use a real menu for mouse selection. */
7858 if (EVENT_HAS_PARAMETERS (prev_event
)
7859 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7860 && !EQ (XCAR (prev_event
), Qtool_bar
))
7862 /* Display the menu and get the selection. */
7863 Lisp_Object
*realmaps
7864 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7868 /* Use the maps that are not nil. */
7869 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7870 if (!NILP (maps
[mapno
]))
7871 realmaps
[nmaps1
++] = maps
[mapno
];
7873 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7878 record_menu_key (XCAR (value
));
7880 /* If we got multiple events, unread all but
7882 There is no way to prevent those unread events
7883 from showing up later in last_nonmenu_event.
7884 So turn symbol and integer events into lists,
7885 to indicate that they came from a mouse menu,
7886 so that when present in last_nonmenu_event
7887 they won't confuse things. */
7888 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7890 record_menu_key (XCAR (tem
));
7891 if (SYMBOLP (XCAR (tem
))
7892 || INTEGERP (XCAR (tem
)))
7893 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7896 /* If we got more than one event, put all but the first
7897 onto this list to be read later.
7898 Return just the first event now. */
7899 Vunread_command_events
7900 = nconc2 (XCDR (value
), Vunread_command_events
);
7901 value
= XCAR (value
);
7903 else if (NILP (value
))
7905 if (used_mouse_menu
)
7906 *used_mouse_menu
= 1;
7909 #endif /* HAVE_MENUS */
7913 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7914 We make this bigger when necessary, and never free it. */
7915 static char *read_char_minibuf_menu_text
;
7916 /* Size of that buffer. */
7917 static int read_char_minibuf_menu_width
;
7920 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7926 register Lisp_Object name
;
7928 /* FIXME: Use the minibuffer's frame width. */
7929 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7932 Lisp_Object rest
, vector
;
7938 if (! menu_prompting
)
7941 /* Make sure we have a big enough buffer for the menu text. */
7942 if (read_char_minibuf_menu_text
== 0)
7944 read_char_minibuf_menu_width
= width
+ 4;
7945 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7947 else if (width
+ 4 > read_char_minibuf_menu_width
)
7949 read_char_minibuf_menu_width
= width
+ 4;
7950 read_char_minibuf_menu_text
7951 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7953 menu
= read_char_minibuf_menu_text
;
7955 /* Get the menu name from the first map that has one (a prompt string). */
7956 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7958 name
= Fkeymap_prompt (maps
[mapno
]);
7963 /* If we don't have any menus, just read a character normally. */
7964 if (!STRINGP (name
))
7967 /* Prompt string always starts with map's prompt, and a space. */
7968 strcpy (menu
, SDATA (name
));
7969 nlength
= SBYTES (name
);
7970 menu
[nlength
++] = ':';
7971 menu
[nlength
++] = ' ';
7974 /* Start prompting at start of first map. */
7978 /* Present the documented bindings, a line at a time. */
7985 Lisp_Object orig_defn_macro
;
7987 /* Loop over elements of map. */
7992 /* If reached end of map, start at beginning of next map. */
7996 /* At end of last map, wrap around to first map if just starting,
7997 or end this line if already have something on it. */
8001 if (notfirst
|| nobindings
) break;
8006 /* Look at the next element of the map. */
8008 elt
= XVECTOR (vector
)->contents
[idx
];
8010 elt
= Fcar_safe (rest
);
8012 if (idx
< 0 && VECTORP (elt
))
8014 /* If we found a dense table in the keymap,
8015 advanced past it, but start scanning its contents. */
8016 rest
= Fcdr_safe (rest
);
8022 /* An ordinary element. */
8023 Lisp_Object event
, tem
;
8027 event
= Fcar_safe (elt
); /* alist */
8028 elt
= Fcdr_safe (elt
);
8032 XSETINT (event
, idx
); /* vector */
8035 /* Ignore the element if it has no prompt string. */
8036 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8038 /* 1 if the char to type matches the string. */
8040 Lisp_Object upcased_event
, downcased_event
;
8041 Lisp_Object desc
= Qnil
;
8043 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8045 upcased_event
= Fupcase (event
);
8046 downcased_event
= Fdowncase (event
);
8047 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8048 || XINT (downcased_event
) == SREF (s
, 0));
8050 desc
= Fsingle_key_description (event
, Qnil
);
8052 #if 0 /* It is redundant to list the equivalent key bindings because
8053 the prefix is what the user has already typed. */
8055 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8057 /* Insert equivalent keybinding. */
8058 s
= concat2 (s
, tem
);
8061 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8062 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8064 /* Insert button prefix. */
8065 Lisp_Object selected
8066 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8067 if (EQ (tem
, QCradio
))
8068 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8070 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8071 s
= concat2 (tem
, s
);
8075 /* If we have room for the prompt string, add it to this line.
8076 If this is the first on the line, always add it. */
8077 if ((SCHARS (s
) + i
+ 2
8078 + (char_matches
? 0 : SCHARS (desc
) + 3))
8084 /* Punctuate between strings. */
8087 strcpy (menu
+ i
, ", ");
8093 /* If the char to type doesn't match the string's
8094 first char, explicitly show what char to type. */
8097 /* Add as much of string as fits. */
8098 thiswidth
= SCHARS (desc
);
8099 if (thiswidth
+ i
> width
)
8100 thiswidth
= width
- i
;
8101 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8103 strcpy (menu
+ i
, " = ");
8107 /* Add as much of string as fits. */
8108 thiswidth
= SCHARS (s
);
8109 if (thiswidth
+ i
> width
)
8110 thiswidth
= width
- i
;
8111 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8117 /* If this element does not fit, end the line now,
8118 and save the element for the next line. */
8119 strcpy (menu
+ i
, "...");
8124 /* Move past this element. */
8125 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8126 /* Handle reaching end of dense table. */
8131 rest
= Fcdr_safe (rest
);
8135 /* Prompt with that and read response. */
8136 message2_nolog (menu
, strlen (menu
),
8137 ! NILP (current_buffer
->enable_multibyte_characters
));
8139 /* Make believe its not a keyboard macro in case the help char
8140 is pressed. Help characters are not recorded because menu prompting
8141 is not used on replay.
8143 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8144 current_kboard
->defining_kbd_macro
= Qnil
;
8146 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8147 while (BUFFERP (obj
));
8148 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8150 if (!INTEGERP (obj
))
8155 if (! EQ (obj
, menu_prompt_more_char
)
8156 && (!INTEGERP (menu_prompt_more_char
)
8157 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8159 if (!NILP (current_kboard
->defining_kbd_macro
))
8160 store_kbd_macro_char (obj
);
8163 /* Help char - go round again */
8167 /* Reading key sequences. */
8169 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8170 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8171 keymap, or nil otherwise. Return the index of the first keymap in
8172 which KEY has any binding, or NMAPS if no map has a binding.
8174 If KEY is a meta ASCII character, treat it like meta-prefix-char
8175 followed by the corresponding non-meta character. Keymaps in
8176 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8179 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8182 NEXT may be the same array as CURRENT. */
8185 follow_key (key
, nmaps
, current
, defs
, next
)
8187 Lisp_Object
*current
, *defs
, *next
;
8190 int i
, first_binding
;
8192 first_binding
= nmaps
;
8193 for (i
= nmaps
- 1; i
>= 0; i
--)
8195 if (! NILP (current
[i
]))
8197 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8198 if (! NILP (defs
[i
]))
8205 /* Given the set of bindings we've found, produce the next set of maps. */
8206 if (first_binding
< nmaps
)
8207 for (i
= 0; i
< nmaps
; i
++)
8208 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8210 return first_binding
;
8213 /* Structure used to keep track of partial application of key remapping
8214 such as Vfunction_key_map and Vkey_translation_map. */
8215 typedef struct keyremap
8217 Lisp_Object map
, parent
;
8221 /* Lookup KEY in MAP.
8222 MAP is a keymap mapping keys to key vectors or functions.
8223 If the mapping is a function and DO_FUNCTION is non-zero, then
8224 the function is called with PROMPT as parameter and its return
8225 value is used as the return value of this function (after checking
8226 that it is indeed a vector). */
8229 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8230 Lisp_Object map
, key
, prompt
;
8235 next
= access_keymap (map
, key
, 1, 0, 1);
8237 /* Handle symbol with autoload definition. */
8238 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8239 && CONSP (XSYMBOL (next
)->function
)
8240 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8241 do_autoload (XSYMBOL (next
)->function
, next
);
8243 /* Handle a symbol whose function definition is a keymap
8245 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8246 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8247 || KEYMAPP (XSYMBOL (next
)->function
)))
8248 next
= XSYMBOL (next
)->function
;
8250 /* If the keymap gives a function, not an
8251 array, then call the function with one arg and use
8252 its value instead. */
8253 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8258 next
= call1 (next
, prompt
);
8259 /* If the function returned something invalid,
8260 barf--don't ignore it.
8261 (To ignore it safely, we would need to gcpro a bunch of
8262 other variables.) */
8263 if (! (VECTORP (next
) || STRINGP (next
)))
8264 error ("Function %s returns invalid key sequence", tem
);
8269 /* Do one step of the key remapping used for function-key-map and
8270 key-translation-map:
8271 KEYBUF is the buffer holding the input events.
8272 BUFSIZE is its maximum size.
8273 FKEY is a pointer to the keyremap structure to use.
8274 INPUT is the index of the last element in KEYBUF.
8275 DOIT if non-zero says that the remapping can actually take place.
8276 DIFF is used to return the number of keys added/removed by the remapping.
8277 PARENT is the root of the keymap.
8278 PROMPT is the prompt to use if the remapping happens through a function.
8279 The return value is non-zero if the remapping actually took place. */
8282 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8283 Lisp_Object
*keybuf
, prompt
;
8285 int input
, doit
, *diff
, bufsize
;
8287 Lisp_Object next
, key
;
8289 key
= keybuf
[fkey
->end
++];
8290 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8292 /* If keybuf[fkey->start..fkey->end] is bound in the
8293 map and we're in a position to do the key remapping, replace it with
8294 the binding and restart with fkey->start at the end. */
8295 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8297 int len
= XFASTINT (Flength (next
));
8300 *diff
= len
- (fkey
->end
- fkey
->start
);
8302 if (input
+ *diff
>= bufsize
)
8303 error ("Key sequence too long");
8305 /* Shift the keys that follow fkey->end. */
8307 for (i
= fkey
->end
; i
< input
; i
++)
8308 keybuf
[i
+ *diff
] = keybuf
[i
];
8310 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8311 keybuf
[i
+ *diff
] = keybuf
[i
];
8312 /* Overwrite the old keys with the new ones. */
8313 for (i
= 0; i
< len
; i
++)
8314 keybuf
[fkey
->start
+ i
]
8315 = Faref (next
, make_number (i
));
8317 fkey
->start
= fkey
->end
+= *diff
;
8318 fkey
->map
= fkey
->parent
;
8323 fkey
->map
= get_keymap (next
, 0, 1);
8325 /* If we no longer have a bound suffix, try a new position for
8327 if (!CONSP (fkey
->map
))
8329 fkey
->end
= ++fkey
->start
;
8330 fkey
->map
= fkey
->parent
;
8335 /* Read a sequence of keys that ends with a non prefix character,
8336 storing it in KEYBUF, a buffer of size BUFSIZE.
8338 Return the length of the key sequence stored.
8339 Return -1 if the user rejected a command menu.
8341 Echo starting immediately unless `prompt' is 0.
8343 Where a key sequence ends depends on the currently active keymaps.
8344 These include any minor mode keymaps active in the current buffer,
8345 the current buffer's local map, and the global map.
8347 If a key sequence has no other bindings, we check Vfunction_key_map
8348 to see if some trailing subsequence might be the beginning of a
8349 function key's sequence. If so, we try to read the whole function
8350 key, and substitute its symbolic name into the key sequence.
8352 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8353 `double-' events into similar click events, if that would make them
8354 bound. We try to turn `triple-' events first into `double-' events,
8357 If we get a mouse click in a mode line, vertical divider, or other
8358 non-text area, we treat the click as if it were prefixed by the
8359 symbol denoting that area - `mode-line', `vertical-line', or
8362 If the sequence starts with a mouse click, we read the key sequence
8363 with respect to the buffer clicked on, not the current buffer.
8365 If the user switches frames in the midst of a key sequence, we put
8366 off the switch-frame event until later; the next call to
8367 read_char will return it.
8369 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8370 from the selected window's buffer. */
8373 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8374 can_return_switch_frame
, fix_current_buffer
)
8375 Lisp_Object
*keybuf
;
8378 int dont_downcase_last
;
8379 int can_return_switch_frame
;
8380 int fix_current_buffer
;
8382 volatile Lisp_Object from_string
;
8383 volatile int count
= SPECPDL_INDEX ();
8385 /* How many keys there are in the current key sequence. */
8388 /* The length of the echo buffer when we started reading, and
8389 the length of this_command_keys when we started reading. */
8390 volatile int echo_start
;
8391 volatile int keys_start
;
8393 /* The number of keymaps we're scanning right now, and the number of
8394 keymaps we have allocated space for. */
8396 volatile int nmaps_allocated
= 0;
8398 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8399 the current keymaps. */
8400 Lisp_Object
*volatile defs
= NULL
;
8402 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8403 in the current keymaps, or nil where it is not a prefix. */
8404 Lisp_Object
*volatile submaps
= NULL
;
8406 /* The local map to start out with at start of key sequence. */
8407 volatile Lisp_Object orig_local_map
;
8409 /* The map from the `keymap' property to start out with at start of
8411 volatile Lisp_Object orig_keymap
;
8413 /* 1 if we have already considered switching to the local-map property
8414 of the place where a mouse click occurred. */
8415 volatile int localized_local_map
= 0;
8417 /* The index in defs[] of the first keymap that has a binding for
8418 this key sequence. In other words, the lowest i such that
8419 defs[i] is non-nil. */
8420 volatile int first_binding
;
8421 /* Index of the first key that has no binding.
8422 It is useless to try fkey.start larger than that. */
8423 volatile int first_unbound
;
8425 /* If t < mock_input, then KEYBUF[t] should be read as the next
8428 We use this to recover after recognizing a function key. Once we
8429 realize that a suffix of the current key sequence is actually a
8430 function key's escape sequence, we replace the suffix with the
8431 function key's binding from Vfunction_key_map. Now keybuf
8432 contains a new and different key sequence, so the echo area,
8433 this_command_keys, and the submaps and defs arrays are wrong. In
8434 this situation, we set mock_input to t, set t to 0, and jump to
8435 restart_sequence; the loop will read keys from keybuf up until
8436 mock_input, thus rebuilding the state; and then it will resume
8437 reading characters from the keyboard. */
8438 volatile int mock_input
= 0;
8440 /* If the sequence is unbound in submaps[], then
8441 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8442 and fkey.map is its binding.
8444 These might be > t, indicating that all function key scanning
8445 should hold off until t reaches them. We do this when we've just
8446 recognized a function key, to avoid searching for the function
8447 key's again in Vfunction_key_map. */
8448 volatile keyremap fkey
;
8450 /* Likewise, for key_translation_map. */
8451 volatile keyremap keytran
;
8453 /* If we receive a `switch-frame' or `select-window' event in the middle of
8454 a key sequence, we put it off for later.
8455 While we're reading, we keep the event here. */
8456 volatile Lisp_Object delayed_switch_frame
;
8458 /* See the comment below... */
8459 #if defined (GOBBLE_FIRST_EVENT)
8460 Lisp_Object first_event
;
8463 volatile Lisp_Object original_uppercase
;
8464 volatile int original_uppercase_position
= -1;
8466 /* Gets around Microsoft compiler limitations. */
8469 struct buffer
*starting_buffer
;
8471 /* List of events for which a fake prefix key has been generated. */
8472 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8474 #if defined (GOBBLE_FIRST_EVENT)
8478 struct gcpro gcpro1
;
8480 GCPRO1 (fake_prefixed_keys
);
8481 raw_keybuf_count
= 0;
8483 last_nonmenu_event
= Qnil
;
8485 delayed_switch_frame
= Qnil
;
8486 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8487 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8488 /* If there is no translation-map, turn off scanning. */
8489 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8490 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8495 echo_prompt (prompt
);
8496 else if (cursor_in_echo_area
8497 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8498 && NILP (Fzerop (Vecho_keystrokes
)))
8499 /* This doesn't put in a dash if the echo buffer is empty, so
8500 you don't always see a dash hanging out in the minibuffer. */
8504 /* Record the initial state of the echo area and this_command_keys;
8505 we will need to restore them if we replay a key sequence. */
8507 echo_start
= echo_length ();
8508 keys_start
= this_command_key_count
;
8509 this_single_command_key_start
= keys_start
;
8511 #if defined (GOBBLE_FIRST_EVENT)
8512 /* This doesn't quite work, because some of the things that read_char
8513 does cannot safely be bypassed. It seems too risky to try to make
8516 /* Read the first char of the sequence specially, before setting
8517 up any keymaps, in case a filter runs and switches buffers on us. */
8518 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8520 #endif /* GOBBLE_FIRST_EVENT */
8522 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8523 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8526 /* We jump here when the key sequence has been thoroughly changed, and
8527 we need to rescan it starting from the beginning. When we jump here,
8528 keybuf[0..mock_input] holds the sequence we should reread. */
8531 starting_buffer
= current_buffer
;
8532 first_unbound
= bufsize
+ 1;
8534 /* Build our list of keymaps.
8535 If we recognize a function key and replace its escape sequence in
8536 keybuf with its symbol, or if the sequence starts with a mouse
8537 click and we need to switch buffers, we jump back here to rebuild
8538 the initial keymaps from the current buffer. */
8541 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8542 || !NILP (Voverriding_local_map
))
8544 if (3 > nmaps_allocated
)
8546 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8547 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8548 nmaps_allocated
= 3;
8550 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8551 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8552 if (!NILP (Voverriding_local_map
))
8553 submaps
[nmaps
++] = Voverriding_local_map
;
8561 nminor
= current_minor_maps (0, &maps
);
8562 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8564 if (total
> nmaps_allocated
)
8566 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8567 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8568 nmaps_allocated
= total
;
8571 if (!NILP (orig_keymap
))
8572 submaps
[nmaps
++] = orig_keymap
;
8574 bcopy (maps
, (void *) (submaps
+ nmaps
),
8575 nminor
* sizeof (submaps
[0]));
8579 submaps
[nmaps
++] = orig_local_map
;
8581 submaps
[nmaps
++] = current_global_map
;
8583 /* Find an accurate initial value for first_binding. */
8584 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8585 if (! NILP (submaps
[first_binding
]))
8588 /* Start from the beginning in keybuf. */
8591 /* These are no-ops the first time through, but if we restart, they
8592 revert the echo area and this_command_keys to their original state. */
8593 this_command_key_count
= keys_start
;
8594 if (INTERACTIVE
&& t
< mock_input
)
8595 echo_truncate (echo_start
);
8597 /* If the best binding for the current key sequence is a keymap, or
8598 we may be looking at a function key's escape sequence, keep on
8600 while (first_binding
< nmaps
8601 /* Keep reading as long as there's a prefix binding. */
8602 ? !NILP (submaps
[first_binding
])
8603 /* Don't return in the middle of a possible function key sequence,
8604 if the only bindings we found were via case conversion.
8605 Thus, if ESC O a has a function-key-map translation
8606 and ESC o has a binding, don't return after ESC O,
8607 so that we can translate ESC O plus the next character. */
8608 : (fkey
.start
< t
|| keytran
.start
< t
))
8611 int used_mouse_menu
= 0;
8613 /* Where the last real key started. If we need to throw away a
8614 key that has expanded into more than one element of keybuf
8615 (say, a mouse click on the mode line which is being treated
8616 as [mode-line (mouse-...)], then we backtrack to this point
8618 volatile int last_real_key_start
;
8620 /* These variables are analogous to echo_start and keys_start;
8621 while those allow us to restart the entire key sequence,
8622 echo_local_start and keys_local_start allow us to throw away
8624 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8626 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8627 eassert (fkey
.start
<= fkey
.end
);
8628 eassert (keytran
.start
<= keytran
.end
);
8629 /* key-translation-map is applied *after* function-key-map. */
8630 eassert (keytran
.end
<= fkey
.start
);
8632 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8633 { /* The prefix upto first_unbound has no binding and has
8634 no translation left to do either, so we know it's unbound.
8635 If we don't stop now, we risk staying here indefinitely
8636 (if the user keeps entering fkey or keytran prefixes
8637 like C-c ESC ESC ESC ESC ...) */
8639 for (i
= first_unbound
+ 1; i
< t
; i
++)
8640 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8641 mock_input
= t
- first_unbound
- 1;
8642 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8643 fkey
.map
= fkey
.parent
;
8644 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8645 keytran
.map
= keytran
.parent
;
8646 goto replay_sequence
;
8650 error ("Key sequence too long");
8653 echo_local_start
= echo_length ();
8654 keys_local_start
= this_command_key_count
;
8655 local_first_binding
= first_binding
;
8658 /* These are no-ops, unless we throw away a keystroke below and
8659 jumped back up to replay_key; in that case, these restore the
8660 variables to their original state, allowing us to replay the
8662 if (INTERACTIVE
&& t
< mock_input
)
8663 echo_truncate (echo_local_start
);
8664 this_command_key_count
= keys_local_start
;
8665 first_binding
= local_first_binding
;
8667 /* By default, assume each event is "real". */
8668 last_real_key_start
= t
;
8670 /* Does mock_input indicate that we are re-reading a key sequence? */
8674 add_command_key (key
);
8675 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8676 && NILP (Fzerop (Vecho_keystrokes
)))
8680 /* If not, we should actually read a character. */
8685 KBOARD
*interrupted_kboard
= current_kboard
;
8686 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8687 if (setjmp (wrong_kboard_jmpbuf
))
8689 if (!NILP (delayed_switch_frame
))
8691 interrupted_kboard
->kbd_queue
8692 = Fcons (delayed_switch_frame
,
8693 interrupted_kboard
->kbd_queue
);
8694 delayed_switch_frame
= Qnil
;
8697 interrupted_kboard
->kbd_queue
8698 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8700 /* If the side queue is non-empty, ensure it begins with a
8701 switch-frame, so we'll replay it in the right context. */
8702 if (CONSP (interrupted_kboard
->kbd_queue
)
8703 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8704 !(EVENT_HAS_PARAMETERS (key
)
8705 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8709 XSETFRAME (frame
, interrupted_frame
);
8710 interrupted_kboard
->kbd_queue
8711 = Fcons (make_lispy_switch_frame (frame
),
8712 interrupted_kboard
->kbd_queue
);
8715 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8716 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8717 goto replay_sequence
;
8720 key
= read_char (NILP (prompt
), nmaps
,
8721 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8725 /* read_char returns t when it shows a menu and the user rejects it.
8729 unbind_to (count
, Qnil
);
8734 /* read_char returns -1 at the end of a macro.
8735 Emacs 18 handles this by returning immediately with a
8736 zero, so that's what we'll do. */
8737 if (INTEGERP (key
) && XINT (key
) == -1)
8740 /* The Microsoft C compiler can't handle the goto that
8746 /* If the current buffer has been changed from under us, the
8747 keymap may have changed, so replay the sequence. */
8750 EMACS_TIME initial_idleness_start_time
;
8751 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8752 EMACS_SECS (timer_last_idleness_start_time
),
8753 EMACS_USECS (timer_last_idleness_start_time
));
8755 /* Resume idle state, using the same start-time as before. */
8756 timer_start_idle ();
8757 timer_idleness_start_time
= initial_idleness_start_time
;
8760 /* Reset the current buffer from the selected window
8761 in case something changed the former and not the latter.
8762 This is to be more consistent with the behavior
8763 of the command_loop_1. */
8764 if (fix_current_buffer
)
8766 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8768 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8769 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8772 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8773 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8774 goto replay_sequence
;
8777 /* If we have a quit that was typed in another frame, and
8778 quit_throw_to_read_char switched buffers,
8779 replay to get the right keymap. */
8781 && XINT (key
) == quit_char
8782 && current_buffer
!= starting_buffer
)
8785 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8789 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8790 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8791 goto replay_sequence
;
8796 if (EVENT_HAS_PARAMETERS (key
)
8797 /* Either a `switch-frame' or a `select-window' event. */
8798 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8800 /* If we're at the beginning of a key sequence, and the caller
8801 says it's okay, go ahead and return this event. If we're
8802 in the midst of a key sequence, delay it until the end. */
8803 if (t
> 0 || !can_return_switch_frame
)
8805 delayed_switch_frame
= key
;
8811 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8814 /* Clicks in non-text areas get prefixed by the symbol
8815 in their CHAR-ADDRESS field. For example, a click on
8816 the mode line is prefixed by the symbol `mode-line'.
8818 Furthermore, key sequences beginning with mouse clicks
8819 are read using the keymaps of the buffer clicked on, not
8820 the current buffer. So we may have to switch the buffer
8823 When we turn one event into two events, we must make sure
8824 that neither of the two looks like the original--so that,
8825 if we replay the events, they won't be expanded again.
8826 If not for this, such reexpansion could happen either here
8827 or when user programs play with this-command-keys. */
8828 if (EVENT_HAS_PARAMETERS (key
))
8832 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8833 if (EQ (kind
, Qmouse_click
))
8835 Lisp_Object window
, posn
;
8837 window
= POSN_WINDOW (EVENT_START (key
));
8838 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8841 || (!NILP (fake_prefixed_keys
)
8842 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8844 /* We're looking a second time at an event for which
8845 we generated a fake prefix key. Set
8846 last_real_key_start appropriately. */
8848 last_real_key_start
= t
- 1;
8851 /* Key sequences beginning with mouse clicks are
8852 read using the keymaps in the buffer clicked on,
8853 not the current buffer. If we're at the
8854 beginning of a key sequence, switch buffers. */
8855 if (last_real_key_start
== 0
8857 && BUFFERP (XWINDOW (window
)->buffer
)
8858 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8860 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8864 /* Arrange to go back to the original buffer once we're
8865 done reading the key sequence. Note that we can't
8866 use save_excursion_{save,restore} here, because they
8867 save point as well as the current buffer; we don't
8868 want to save point, because redisplay may change it,
8869 to accommodate a Fset_window_start or something. We
8870 don't want to do this at the top of the function,
8871 because we may get input from a subprocess which
8872 wants to change the selected window and stuff (say,
8874 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8876 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8878 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8879 orig_local_map
= get_local_map (PT
, current_buffer
,
8881 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8882 goto replay_sequence
;
8885 /* For a mouse click, get the local text-property keymap
8886 of the place clicked on, rather than point. */
8887 if (last_real_key_start
== 0
8888 && CONSP (XCDR (key
))
8889 && ! localized_local_map
)
8891 Lisp_Object map_here
, start
, pos
;
8893 localized_local_map
= 1;
8894 start
= EVENT_START (key
);
8896 if (CONSP (start
) && CONSP (XCDR (start
)))
8898 pos
= POSN_BUFFER_POSN (start
);
8900 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8902 map_here
= get_local_map (XINT (pos
),
8903 current_buffer
, Qlocal_map
);
8904 if (!EQ (map_here
, orig_local_map
))
8906 orig_local_map
= map_here
;
8910 goto replay_sequence
;
8912 map_here
= get_local_map (XINT (pos
),
8913 current_buffer
, Qkeymap
);
8914 if (!EQ (map_here
, orig_keymap
))
8916 orig_keymap
= map_here
;
8920 goto replay_sequence
;
8926 /* Expand mode-line and scroll-bar events into two events:
8927 use posn as a fake prefix key. */
8929 && (NILP (fake_prefixed_keys
)
8930 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8932 if (t
+ 1 >= bufsize
)
8933 error ("Key sequence too long");
8936 keybuf
[t
+ 1] = key
;
8939 /* Record that a fake prefix key has been generated
8940 for KEY. Don't modify the event; this would
8941 prevent proper action when the event is pushed
8942 back into unread-command-events. */
8943 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8945 /* If on a mode line string with a local keymap,
8946 reconsider the key sequence with that keymap. */
8947 if (CONSP (POSN_STRING (EVENT_START (key
))))
8949 Lisp_Object string
, pos
, map
, map2
;
8951 string
= POSN_STRING (EVENT_START (key
));
8952 pos
= XCDR (string
);
8953 string
= XCAR (string
);
8955 && XINT (pos
) < SCHARS (string
))
8957 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8959 orig_local_map
= map
;
8960 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8963 if (!NILP (map
) || !NILP (map2
))
8964 goto replay_sequence
;
8970 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8971 && NILP (from_string
))
8973 /* For a click on a string, i.e. overlay string or a
8974 string displayed via the `display' property,
8975 consider `local-map' and `keymap' properties of
8977 Lisp_Object string
, pos
, map
, map2
;
8979 string
= POSN_STRING (EVENT_START (key
));
8980 pos
= XCDR (string
);
8981 string
= XCAR (string
);
8983 && XINT (pos
) < SCHARS (string
))
8985 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8987 orig_local_map
= map
;
8988 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8992 if (!NILP (map
) || !NILP (map2
))
8994 from_string
= string
;
8995 goto replay_sequence
;
9000 else if (CONSP (XCDR (key
))
9001 && CONSP (EVENT_START (key
))
9002 && CONSP (XCDR (EVENT_START (key
))))
9006 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
9007 /* Handle menu-bar events:
9008 insert the dummy prefix event `menu-bar'. */
9009 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9011 if (t
+ 1 >= bufsize
)
9012 error ("Key sequence too long");
9016 /* Zap the position in key, so we know that we've
9017 expanded it, and don't try to do so again. */
9018 POSN_BUFFER_SET_POSN (EVENT_START (key
),
9019 Fcons (posn
, Qnil
));
9022 goto replay_sequence
;
9024 else if (CONSP (posn
))
9026 /* We're looking at the second event of a
9027 sequence which we expanded before. Set
9028 last_real_key_start appropriately. */
9029 if (last_real_key_start
== t
&& t
> 0)
9030 last_real_key_start
= t
- 1;
9035 /* We have finally decided that KEY is something we might want
9037 first_binding
= (follow_key (key
,
9038 nmaps
- first_binding
,
9039 submaps
+ first_binding
,
9040 defs
+ first_binding
,
9041 submaps
+ first_binding
)
9044 /* If KEY wasn't bound, we'll try some fallbacks. */
9045 if (first_binding
< nmaps
)
9046 /* This is needed for the following scenario:
9047 event 0: a down-event that gets dropped by calling replay_key.
9048 event 1: some normal prefix like C-h.
9049 After event 0, first_unbound is 0, after event 1 fkey.start
9050 and keytran.start are both 1, so when we see that C-h is bound,
9051 we need to update first_unbound. */
9052 first_unbound
= max (t
+ 1, first_unbound
);
9057 /* Remember the position to put an upper bound on fkey.start. */
9058 first_unbound
= min (t
, first_unbound
);
9060 head
= EVENT_HEAD (key
);
9061 if (help_char_p (head
) && t
> 0)
9063 read_key_sequence_cmd
= Vprefix_help_command
;
9065 last_nonmenu_event
= key
;
9066 /* The Microsoft C compiler can't handle the goto that
9074 Lisp_Object breakdown
;
9077 breakdown
= parse_modifiers (head
);
9078 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9079 /* Attempt to reduce an unbound mouse event to a simpler
9080 event that is bound:
9081 Drags reduce to clicks.
9082 Double-clicks reduce to clicks.
9083 Triple-clicks reduce to double-clicks, then to clicks.
9084 Down-clicks are eliminated.
9085 Double-downs reduce to downs, then are eliminated.
9086 Triple-downs reduce to double-downs, then to downs,
9087 then are eliminated. */
9088 if (modifiers
& (down_modifier
| drag_modifier
9089 | double_modifier
| triple_modifier
))
9091 while (modifiers
& (down_modifier
| drag_modifier
9092 | double_modifier
| triple_modifier
))
9094 Lisp_Object new_head
, new_click
;
9095 if (modifiers
& triple_modifier
)
9096 modifiers
^= (double_modifier
| triple_modifier
);
9097 else if (modifiers
& double_modifier
)
9098 modifiers
&= ~double_modifier
;
9099 else if (modifiers
& drag_modifier
)
9100 modifiers
&= ~drag_modifier
;
9103 /* Dispose of this `down' event by simply jumping
9104 back to replay_key, to get another event.
9106 Note that if this event came from mock input,
9107 then just jumping back to replay_key will just
9108 hand it to us again. So we have to wipe out any
9111 We could delete keybuf[t] and shift everything
9112 after that to the left by one spot, but we'd also
9113 have to fix up any variable that points into
9114 keybuf, and shifting isn't really necessary
9117 Adding prefixes for non-textual mouse clicks
9118 creates two characters of mock input, and both
9119 must be thrown away. If we're only looking at
9120 the prefix now, we can just jump back to
9121 replay_key. On the other hand, if we've already
9122 processed the prefix, and now the actual click
9123 itself is giving us trouble, then we've lost the
9124 state of the keymaps we want to backtrack to, and
9125 we need to replay the whole sequence to rebuild
9128 Beyond that, only function key expansion could
9129 create more than two keys, but that should never
9130 generate mouse events, so it's okay to zero
9131 mock_input in that case too.
9133 FIXME: The above paragraph seems just plain
9134 wrong, if you consider things like
9135 xterm-mouse-mode. -stef
9137 Isn't this just the most wonderful code ever? */
9138 if (t
== last_real_key_start
)
9145 mock_input
= last_real_key_start
;
9146 goto replay_sequence
;
9151 = apply_modifiers (modifiers
, XCAR (breakdown
));
9153 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9155 /* Look for a binding for this new key. follow_key
9156 promises that it didn't munge submaps the
9157 last time we called it, since key was unbound. */
9159 = (follow_key (new_click
,
9160 nmaps
- local_first_binding
,
9161 submaps
+ local_first_binding
,
9162 defs
+ local_first_binding
,
9163 submaps
+ local_first_binding
)
9164 + local_first_binding
);
9166 /* If that click is bound, go for it. */
9167 if (first_binding
< nmaps
)
9172 /* Otherwise, we'll leave key set to the drag event. */
9179 /* Normally, last_nonmenu_event gets the previous key we read.
9180 But when a mouse popup menu is being used,
9181 we don't update last_nonmenu_event; it continues to hold the mouse
9182 event that preceded the first level of menu. */
9183 if (!used_mouse_menu
)
9184 last_nonmenu_event
= key
;
9186 /* Record what part of this_command_keys is the current key sequence. */
9187 this_single_command_key_start
= this_command_key_count
- t
;
9189 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9190 /* There is a binding and it's not a prefix.
9191 There is thus no function-key in this sequence.
9192 Moving fkey.start is important in this case to allow keytran.start
9193 to go over the sequence before we return (since we keep the
9194 invariant that keytran.end <= fkey.start). */
9197 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9200 /* If the sequence is unbound, see if we can hang a function key
9201 off the end of it. */
9202 /* Continue scan from fkey.end until we find a bound suffix. */
9203 while (fkey
.end
< t
)
9205 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9208 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9209 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9210 max (t
, mock_input
),
9211 /* If there's a binding (i.e.
9212 first_binding >= nmaps) we don't want
9213 to apply this function-key-mapping. */
9214 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9219 mock_input
= diff
+ max (t
, mock_input
);
9220 goto replay_sequence
;
9224 /* Look for this sequence in key-translation-map.
9225 Scan from keytran.end until we find a bound suffix. */
9226 while (keytran
.end
< fkey
.start
)
9228 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9231 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9232 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9237 mock_input
= diff
+ max (t
, mock_input
);
9238 /* Adjust the function-key-map counters. */
9242 goto replay_sequence
;
9246 /* If KEY is not defined in any of the keymaps,
9247 and cannot be part of a function key or translation,
9248 and is an upper case letter
9249 use the corresponding lower-case letter instead. */
9250 if (first_binding
>= nmaps
9251 && fkey
.start
>= t
&& keytran
.start
>= t
9253 && ((((XINT (key
) & 0x3ffff)
9254 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9255 && UPPERCASEP (XINT (key
) & 0x3ffff))
9256 || (XINT (key
) & shift_modifier
)))
9258 Lisp_Object new_key
;
9260 original_uppercase
= key
;
9261 original_uppercase_position
= t
- 1;
9263 if (XINT (key
) & shift_modifier
)
9264 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9266 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9267 | (XINT (key
) & ~0x3ffff)));
9269 /* We have to do this unconditionally, regardless of whether
9270 the lower-case char is defined in the keymaps, because they
9271 might get translated through function-key-map. */
9272 keybuf
[t
- 1] = new_key
;
9273 mock_input
= max (t
, mock_input
);
9275 goto replay_sequence
;
9277 /* If KEY is not defined in any of the keymaps,
9278 and cannot be part of a function key or translation,
9279 and is a shifted function key,
9280 use the corresponding unshifted function key instead. */
9281 if (first_binding
>= nmaps
9282 && fkey
.start
>= t
&& keytran
.start
>= t
9285 Lisp_Object breakdown
;
9288 breakdown
= parse_modifiers (key
);
9289 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9290 if (modifiers
& shift_modifier
)
9292 Lisp_Object new_key
;
9294 original_uppercase
= key
;
9295 original_uppercase_position
= t
- 1;
9297 modifiers
&= ~shift_modifier
;
9298 new_key
= apply_modifiers (modifiers
,
9301 keybuf
[t
- 1] = new_key
;
9302 mock_input
= max (t
, mock_input
);
9304 goto replay_sequence
;
9310 read_key_sequence_cmd
= (first_binding
< nmaps
9311 ? defs
[first_binding
]
9314 unread_switch_frame
= delayed_switch_frame
;
9315 unbind_to (count
, Qnil
);
9317 /* Don't downcase the last character if the caller says don't.
9318 Don't downcase it if the result is undefined, either. */
9319 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9320 && t
- 1 == original_uppercase_position
)
9321 keybuf
[t
- 1] = original_uppercase
;
9323 /* Occasionally we fabricate events, perhaps by expanding something
9324 according to function-key-map, or by adding a prefix symbol to a
9325 mouse click in the scroll bar or modeline. In this cases, return
9326 the entire generated key sequence, even if we hit an unbound
9327 prefix or a definition before the end. This means that you will
9328 be able to push back the event properly, and also means that
9329 read-key-sequence will always return a logical unit.
9332 for (; t
< mock_input
; t
++)
9334 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9335 && NILP (Fzerop (Vecho_keystrokes
)))
9336 echo_char (keybuf
[t
]);
9337 add_command_key (keybuf
[t
]);
9346 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9347 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9348 The sequence is sufficient to specify a non-prefix command in the
9349 current local and global maps.
9351 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9352 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9353 as a continuation of the previous key.
9355 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9356 convert the last event to lower case. (Normally any upper case event
9357 is converted to lower case if the original event is undefined and the lower
9358 case equivalent is defined.) A non-nil value is appropriate for reading
9359 a key sequence to be defined.
9361 A C-g typed while in this function is treated like any other character,
9362 and `quit-flag' is not set.
9364 If the key sequence starts with a mouse click, then the sequence is read
9365 using the keymaps of the buffer of the window clicked in, not the buffer
9366 of the selected window as normal.
9368 `read-key-sequence' drops unbound button-down events, since you normally
9369 only care about the click or drag events which follow them. If a drag
9370 or multi-click event is unbound, but the corresponding click event would
9371 be bound, `read-key-sequence' turns the event into a click event at the
9372 drag's starting position. This means that you don't have to distinguish
9373 between click and drag, double, or triple events unless you want to.
9375 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9376 lines separating windows, and scroll bars with imaginary keys
9377 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9379 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9380 function will process a switch-frame event if the user switches frames
9381 before typing anything. If the user switches frames in the middle of a
9382 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9383 is nil, then the event will be put off until after the current key sequence.
9385 `read-key-sequence' checks `function-key-map' for function key
9386 sequences, where they wouldn't conflict with ordinary bindings. See
9387 `function-key-map' for more details.
9389 The optional fifth argument COMMAND-LOOP, if non-nil, means
9390 that this key sequence is being read by something that will
9391 read commands one after another. It should be nil if the caller
9392 will read just one key sequence. */)
9393 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9395 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9396 Lisp_Object can_return_switch_frame
, command_loop
;
9398 Lisp_Object keybuf
[30];
9400 struct gcpro gcpro1
;
9401 int count
= SPECPDL_INDEX ();
9404 CHECK_STRING (prompt
);
9407 specbind (Qinput_method_exit_on_first_char
,
9408 (NILP (command_loop
) ? Qt
: Qnil
));
9409 specbind (Qinput_method_use_echo_area
,
9410 (NILP (command_loop
) ? Qt
: Qnil
));
9412 bzero (keybuf
, sizeof keybuf
);
9414 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9416 if (NILP (continue_echo
))
9418 this_command_key_count
= 0;
9419 this_command_key_count_reset
= 0;
9420 this_single_command_key_start
= 0;
9423 #ifdef HAVE_X_WINDOWS
9424 if (display_hourglass_p
)
9425 cancel_hourglass ();
9428 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9429 prompt
, ! NILP (dont_downcase_last
),
9430 ! NILP (can_return_switch_frame
), 0);
9432 #if 0 /* The following is fine for code reading a key sequence and
9433 then proceeding with a lenghty computation, but it's not good
9434 for code reading keys in a loop, like an input method. */
9435 #ifdef HAVE_X_WINDOWS
9436 if (display_hourglass_p
)
9447 return unbind_to (count
, make_event_array (i
, keybuf
));
9450 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9451 Sread_key_sequence_vector
, 1, 5, 0,
9452 doc
: /* Like `read-key-sequence' but always return a vector. */)
9453 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9455 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9456 Lisp_Object can_return_switch_frame
, command_loop
;
9458 Lisp_Object keybuf
[30];
9460 struct gcpro gcpro1
;
9461 int count
= SPECPDL_INDEX ();
9464 CHECK_STRING (prompt
);
9467 specbind (Qinput_method_exit_on_first_char
,
9468 (NILP (command_loop
) ? Qt
: Qnil
));
9469 specbind (Qinput_method_use_echo_area
,
9470 (NILP (command_loop
) ? Qt
: Qnil
));
9472 bzero (keybuf
, sizeof keybuf
);
9474 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9476 if (NILP (continue_echo
))
9478 this_command_key_count
= 0;
9479 this_command_key_count_reset
= 0;
9480 this_single_command_key_start
= 0;
9483 #ifdef HAVE_X_WINDOWS
9484 if (display_hourglass_p
)
9485 cancel_hourglass ();
9488 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9489 prompt
, ! NILP (dont_downcase_last
),
9490 ! NILP (can_return_switch_frame
), 0);
9492 #ifdef HAVE_X_WINDOWS
9493 if (display_hourglass_p
)
9503 return unbind_to (count
, Fvector (i
, keybuf
));
9506 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9507 doc
: /* Execute CMD as an editor command.
9508 CMD must be a symbol that satisfies the `commandp' predicate.
9509 Optional second arg RECORD-FLAG non-nil
9510 means unconditionally put this command in `command-history'.
9511 Otherwise, that is done only if an arg is read using the minibuffer.
9512 The argument KEYS specifies the value to use instead of (this-command-keys)
9513 when reading the arguments; if it is nil, (this-command-keys) is used.
9514 The argument SPECIAL, if non-nil, means that this command is executing
9515 a special event, so ignore the prefix argument and don't clear it. */)
9516 (cmd
, record_flag
, keys
, special
)
9517 Lisp_Object cmd
, record_flag
, keys
, special
;
9519 register Lisp_Object final
;
9520 register Lisp_Object tem
;
9521 Lisp_Object prefixarg
;
9522 struct backtrace backtrace
;
9523 extern int debug_on_next_call
;
9525 debug_on_next_call
= 0;
9529 prefixarg
= current_kboard
->Vprefix_arg
;
9530 Vcurrent_prefix_arg
= prefixarg
;
9531 current_kboard
->Vprefix_arg
= Qnil
;
9538 tem
= Fget (cmd
, Qdisabled
);
9539 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9541 tem
= Fsymbol_value (Qdisabled_command_hook
);
9543 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9549 final
= Findirect_function (cmd
);
9551 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9553 struct gcpro gcpro1
, gcpro2
;
9555 GCPRO2 (cmd
, prefixarg
);
9556 do_autoload (final
, cmd
);
9563 if (STRINGP (final
) || VECTORP (final
))
9565 /* If requested, place the macro in the command history. For
9566 other sorts of commands, call-interactively takes care of
9568 if (!NILP (record_flag
))
9571 = Fcons (Fcons (Qexecute_kbd_macro
,
9572 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9575 /* Don't keep command history around forever. */
9576 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9578 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9580 XSETCDR (tem
, Qnil
);
9584 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9587 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9589 backtrace
.next
= backtrace_list
;
9590 backtrace_list
= &backtrace
;
9591 backtrace
.function
= &Qcall_interactively
;
9592 backtrace
.args
= &cmd
;
9593 backtrace
.nargs
= 1;
9594 backtrace
.evalargs
= 0;
9596 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9598 backtrace_list
= backtrace
.next
;
9606 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9608 doc
: /* Read function name, then read its arguments and call it. */)
9610 Lisp_Object prefixarg
;
9612 Lisp_Object function
;
9614 int saved_last_point_position
;
9615 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9616 Lisp_Object bindings
, value
;
9617 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9619 saved_keys
= Fvector (this_command_key_count
,
9620 XVECTOR (this_command_keys
)->contents
);
9621 saved_last_point_position_buffer
= last_point_position_buffer
;
9622 saved_last_point_position
= last_point_position
;
9624 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9626 if (EQ (prefixarg
, Qminus
))
9628 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9629 strcpy (buf
, "C-u ");
9630 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9632 if (sizeof (int) == sizeof (EMACS_INT
))
9633 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9634 else if (sizeof (long) == sizeof (EMACS_INT
))
9635 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9639 else if (INTEGERP (prefixarg
))
9641 if (sizeof (int) == sizeof (EMACS_INT
))
9642 sprintf (buf
, "%d ", XINT (prefixarg
));
9643 else if (sizeof (long) == sizeof (EMACS_INT
))
9644 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9649 /* This isn't strictly correct if execute-extended-command
9650 is bound to anything else. Perhaps it should use
9651 this_command_keys? */
9652 strcat (buf
, "M-x ");
9654 /* Prompt with buf, and then read a string, completing from and
9655 restricting to the set of all defined commands. Don't provide
9656 any initial input. Save the command read on the extended-command
9658 function
= Fcompleting_read (build_string (buf
),
9659 Vobarray
, Qcommandp
,
9660 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9663 if (STRINGP (function
) && SCHARS (function
) == 0)
9664 error ("No command name given");
9666 /* Set this_command_keys to the concatenation of saved_keys and
9667 function, followed by a RET. */
9672 this_command_key_count
= 0;
9673 this_command_key_count_reset
= 0;
9674 this_single_command_key_start
= 0;
9676 keys
= XVECTOR (saved_keys
)->contents
;
9677 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9678 add_command_key (keys
[i
]);
9680 for (i
= 0; i
< SCHARS (function
); i
++)
9681 add_command_key (Faref (function
, make_number (i
)));
9683 add_command_key (make_number ('\015'));
9686 last_point_position
= saved_last_point_position
;
9687 last_point_position_buffer
= saved_last_point_position_buffer
;
9691 function
= Fintern (function
, Qnil
);
9692 current_kboard
->Vprefix_arg
= prefixarg
;
9693 Vthis_command
= function
;
9694 real_this_command
= function
;
9696 /* If enabled, show which key runs this command. */
9697 if (!NILP (Vsuggest_key_bindings
)
9698 && NILP (Vexecuting_macro
)
9699 && SYMBOLP (function
))
9700 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9706 GCPRO2 (bindings
, value
);
9707 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9709 /* If the command has a key binding, print it now. */
9710 if (!NILP (bindings
)
9711 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9714 /* But first wait, and skip the message if there is input. */
9716 if (!NILP (echo_area_buffer
[0]))
9717 /* This command displayed something in the echo area;
9718 so wait a few seconds, then display our suggestion message. */
9719 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9720 ? XINT (Vsuggest_key_bindings
) : 2);
9722 /* This command left the echo area empty,
9723 so display our message immediately. */
9726 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9727 && ! CONSP (Vunread_command_events
))
9729 Lisp_Object binding
;
9731 int message_p
= push_message ();
9732 int count
= SPECPDL_INDEX ();
9734 record_unwind_protect (pop_message_unwind
, Qnil
);
9735 binding
= Fkey_description (bindings
);
9738 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9741 sprintf (newmessage
, "You can run the command `%s' with %s",
9742 SDATA (SYMBOL_NAME (function
)),
9744 message2_nolog (newmessage
,
9745 strlen (newmessage
),
9746 STRING_MULTIBYTE (binding
));
9747 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9748 ? Vsuggest_key_bindings
: make_number (2)),
9753 unbind_to (count
, Qnil
);
9757 RETURN_UNGCPRO (value
);
9761 /* Return nonzero if input events are pending. */
9764 detect_input_pending ()
9767 get_input_pending (&input_pending
, 0);
9769 return input_pending
;
9772 /* Return nonzero if input events are pending, and run any pending timers. */
9775 detect_input_pending_run_timers (do_display
)
9778 int old_timers_run
= timers_run
;
9781 get_input_pending (&input_pending
, 1);
9783 if (old_timers_run
!= timers_run
&& do_display
)
9785 redisplay_preserve_echo_area (8);
9786 /* The following fixes a bug when using lazy-lock with
9787 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9788 from an idle timer function. The symptom of the bug is that
9789 the cursor sometimes doesn't become visible until the next X
9790 event is processed. --gerd. */
9792 rif
->flush_display (NULL
);
9795 return input_pending
;
9798 /* This is called in some cases before a possible quit.
9799 It cases the next call to detect_input_pending to recompute input_pending.
9800 So calling this function unnecessarily can't do any harm. */
9803 clear_input_pending ()
9808 /* Return nonzero if there are pending requeued events.
9809 This isn't used yet. The hope is to make wait_reading_process_input
9810 call it, and return if it runs Lisp code that unreads something.
9811 The problem is, kbd_buffer_get_event needs to be fixed to know what
9812 to do in that case. It isn't trivial. */
9815 requeued_events_pending_p ()
9817 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9821 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9822 doc
: /* Return t if command input is currently available with no wait.
9823 Actually, the value is nil only if we can be sure that no input is available;
9824 if there is a doubt, the value is t. */)
9827 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9830 get_filtered_input_pending (&input_pending
, 1, 1);
9831 return input_pending
> 0 ? Qt
: Qnil
;
9834 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9835 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9838 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9841 if (total_keys
< NUM_RECENT_KEYS
)
9842 return Fvector (total_keys
, keys
);
9845 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9846 bcopy (keys
+ recent_keys_index
,
9847 XVECTOR (val
)->contents
,
9848 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9850 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9851 recent_keys_index
* sizeof (Lisp_Object
));
9856 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9857 doc
: /* Return the key sequence that invoked this command.
9858 However, if the command has called `read-key-sequence', it returns
9859 the last key sequence that has been read.
9860 The value is a string or a vector. */)
9863 return make_event_array (this_command_key_count
,
9864 XVECTOR (this_command_keys
)->contents
);
9867 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9868 doc
: /* Return the key sequence that invoked this command, as a vector.
9869 However, if the command has called `read-key-sequence', it returns
9870 the last key sequence that has been read. */)
9873 return Fvector (this_command_key_count
,
9874 XVECTOR (this_command_keys
)->contents
);
9877 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9878 Sthis_single_command_keys
, 0, 0, 0,
9879 doc
: /* Return the key sequence that invoked this command.
9880 More generally, it returns the last key sequence read, either by
9881 the command loop or by `read-key-sequence'.
9882 Unlike `this-command-keys', this function's value
9883 does not include prefix arguments.
9884 The value is always a vector. */)
9887 return Fvector (this_command_key_count
9888 - this_single_command_key_start
,
9889 (XVECTOR (this_command_keys
)->contents
9890 + this_single_command_key_start
));
9893 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9894 Sthis_single_command_raw_keys
, 0, 0, 0,
9895 doc
: /* Return the raw events that were read for this command.
9896 More generally, it returns the last key sequence read, either by
9897 the command loop or by `read-key-sequence'.
9898 Unlike `this-single-command-keys', this function's value
9899 shows the events before all translations (except for input methods).
9900 The value is always a vector. */)
9903 return Fvector (raw_keybuf_count
,
9904 (XVECTOR (raw_keybuf
)->contents
));
9907 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9908 Sreset_this_command_lengths
, 0, 0, 0,
9909 doc
: /* Make the unread events replace the last command and echo.
9910 Used in `universal-argument-other-key'.
9912 `universal-argument-other-key' rereads the event just typed.
9913 It then gets translated through `function-key-map'.
9914 The translated event has to replace the real events,
9915 both in the value of (this-command-keys) and in echoing.
9916 To achieve this, `universal-argument-other-key' calls
9917 `reset-this-command-lengths', which discards the record of reading
9918 these events the first time. */)
9921 this_command_key_count
= before_command_key_count
;
9922 if (this_command_key_count
< this_single_command_key_start
)
9923 this_single_command_key_start
= this_command_key_count
;
9925 echo_truncate (before_command_echo_length
);
9927 /* Cause whatever we put into unread-command-events
9928 to echo as if it were being freshly read from the keyboard. */
9929 this_command_key_count_reset
= 1;
9934 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9935 Sclear_this_command_keys
, 0, 1, 0,
9936 doc
: /* Clear out the vector that `this-command-keys' returns.
9937 Also clear the record of the last 100 events, unless optional arg
9938 KEEP-RECORD is non-nil. */)
9940 Lisp_Object keep_record
;
9944 this_command_key_count
= 0;
9945 this_command_key_count_reset
= 0;
9947 if (NILP (keep_record
))
9949 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9950 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9952 recent_keys_index
= 0;
9957 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9958 doc
: /* Return the current depth in recursive edits. */)
9962 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9966 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9967 "FOpen dribble file: ",
9968 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9969 If FILE is nil, close any open dribble file. */)
9980 file
= Fexpand_file_name (file
, Qnil
);
9981 dribble
= fopen (SDATA (file
), "w");
9983 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9988 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9989 doc
: /* Discard the contents of the terminal input buffer.
9990 Also end any kbd macro being defined. */)
9993 if (!NILP (current_kboard
->defining_kbd_macro
))
9995 /* Discard the last command from the macro. */
9996 Fcancel_kbd_macro_events ();
10000 update_mode_lines
++;
10002 Vunread_command_events
= Qnil
;
10003 unread_command_char
= -1;
10005 discard_tty_input ();
10007 kbd_fetch_ptr
= kbd_store_ptr
;
10008 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10014 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10015 doc
: /* Stop Emacs and return to superior process. You can resume later.
10016 If `cannot-suspend' is non-nil, or if the system doesn't support job
10017 control, run a subshell instead.
10019 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10020 to be read as terminal input by Emacs's parent, after suspension.
10022 Before suspending, run the normal hook `suspend-hook'.
10023 After resumption run the normal hook `suspend-resume-hook'.
10025 Some operating systems cannot stop the Emacs process and resume it later.
10026 On such systems, Emacs starts a subshell instead of suspending. */)
10028 Lisp_Object stuffstring
;
10030 int count
= SPECPDL_INDEX ();
10031 int old_height
, old_width
;
10033 struct gcpro gcpro1
;
10035 if (!NILP (stuffstring
))
10036 CHECK_STRING (stuffstring
);
10038 /* Run the functions in suspend-hook. */
10039 if (!NILP (Vrun_hooks
))
10040 call1 (Vrun_hooks
, intern ("suspend-hook"));
10042 GCPRO1 (stuffstring
);
10043 get_frame_size (&old_width
, &old_height
);
10044 reset_sys_modes ();
10045 /* sys_suspend can get an error if it tries to fork a subshell
10046 and the system resources aren't available for that. */
10047 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10049 stuff_buffered_input (stuffstring
);
10050 if (cannot_suspend
)
10054 unbind_to (count
, Qnil
);
10056 /* Check if terminal/window size has changed.
10057 Note that this is not useful when we are running directly
10058 with a window system; but suspend should be disabled in that case. */
10059 get_frame_size (&width
, &height
);
10060 if (width
!= old_width
|| height
!= old_height
)
10061 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10063 /* Run suspend-resume-hook. */
10064 if (!NILP (Vrun_hooks
))
10065 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10071 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10072 Then in any case stuff anything Emacs has read ahead and not used. */
10075 stuff_buffered_input (stuffstring
)
10076 Lisp_Object stuffstring
;
10078 /* stuff_char works only in BSD, versions 4.2 and up. */
10081 register unsigned char *p
;
10083 if (STRINGP (stuffstring
))
10085 register int count
;
10087 p
= SDATA (stuffstring
);
10088 count
= SBYTES (stuffstring
);
10089 while (count
-- > 0)
10094 /* Anything we have read ahead, put back for the shell to read. */
10095 /* ?? What should this do when we have multiple keyboards??
10096 Should we ignore anything that was typed in at the "wrong" kboard? */
10097 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10101 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10102 kbd_fetch_ptr
= kbd_buffer
;
10103 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10104 stuff_char (kbd_fetch_ptr
->code
);
10106 kbd_fetch_ptr
->kind
= NO_EVENT
;
10107 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10108 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10109 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10114 #endif /* BSD_SYSTEM and not BSD4_1 */
10118 set_waiting_for_input (time_to_clear
)
10119 EMACS_TIME
*time_to_clear
;
10121 input_available_clear_time
= time_to_clear
;
10123 /* Tell interrupt_signal to throw back to read_char, */
10124 waiting_for_input
= 1;
10126 /* If interrupt_signal was called before and buffered a C-g,
10127 make it run again now, to avoid timing error. */
10128 if (!NILP (Vquit_flag
))
10129 quit_throw_to_read_char ();
10133 clear_waiting_for_input ()
10135 /* Tell interrupt_signal not to throw back to read_char, */
10136 waiting_for_input
= 0;
10137 input_available_clear_time
= 0;
10140 /* This routine is called at interrupt level in response to C-g.
10142 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10143 is called from kbd_buffer_store_event, in handling SIGIO or
10146 If `waiting_for_input' is non zero, then unless `echoing' is
10147 nonzero, immediately throw back to read_char.
10149 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10150 eval to throw, when it gets a chance. If quit-flag is already
10151 non-nil, it stops the job right away. */
10154 interrupt_signal (signalnum
) /* If we don't have an argument, */
10155 int signalnum
; /* some compilers complain in signal calls. */
10158 /* Must preserve main program's value of errno. */
10159 int old_errno
= errno
;
10160 struct frame
*sf
= SELECTED_FRAME ();
10162 #if defined (USG) && !defined (POSIX_SIGNALS)
10163 if (!read_socket_hook
&& NILP (Vwindow_system
))
10165 /* USG systems forget handlers when they are used;
10166 must reestablish each time */
10167 signal (SIGINT
, interrupt_signal
);
10168 signal (SIGQUIT
, interrupt_signal
);
10174 if (!NILP (Vquit_flag
)
10175 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10177 /* If SIGINT isn't blocked, don't let us be interrupted by
10178 another SIGINT, it might be harmful due to non-reentrancy
10179 in I/O functions. */
10180 sigblock (sigmask (SIGINT
));
10183 reset_sys_modes ();
10185 #ifdef SIGTSTP /* Support possible in later USG versions */
10187 * On systems which can suspend the current process and return to the original
10188 * shell, this command causes the user to end up back at the shell.
10189 * The "Auto-save" and "Abort" questions are not asked until
10190 * the user elects to return to emacs, at which point he can save the current
10191 * job and either dump core or continue.
10196 if (sys_suspend () == -1)
10198 printf ("Not running as a subprocess;\n");
10199 printf ("you can continue or abort.\n");
10201 #else /* not VMS */
10202 /* Perhaps should really fork an inferior shell?
10203 But that would not provide any way to get back
10204 to the original shell, ever. */
10205 printf ("No support for stopping a process on this operating system;\n");
10206 printf ("you can continue or abort.\n");
10207 #endif /* not VMS */
10208 #endif /* not SIGTSTP */
10210 /* We must remain inside the screen area when the internal terminal
10211 is used. Note that [Enter] is not echoed by dos. */
10214 /* It doesn't work to autosave while GC is in progress;
10215 the code used for auto-saving doesn't cope with the mark bit. */
10216 if (!gc_in_progress
)
10218 printf ("Auto-save? (y or n) ");
10220 if (((c
= getchar ()) & ~040) == 'Y')
10222 Fdo_auto_save (Qt
, Qnil
);
10224 printf ("\r\nAuto-save done");
10225 #else /* not MSDOS */
10226 printf ("Auto-save done\n");
10227 #endif /* not MSDOS */
10229 while (c
!= '\n') c
= getchar ();
10233 /* During GC, it must be safe to reenable quitting again. */
10234 Vinhibit_quit
= Qnil
;
10237 #endif /* not MSDOS */
10238 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10239 printf ("but will instead do a real quit after garbage collection ends\r\n");
10244 printf ("\r\nAbort? (y or n) ");
10245 #else /* not MSDOS */
10247 printf ("Abort (and enter debugger)? (y or n) ");
10248 #else /* not VMS */
10249 printf ("Abort (and dump core)? (y or n) ");
10250 #endif /* not VMS */
10251 #endif /* not MSDOS */
10253 if (((c
= getchar ()) & ~040) == 'Y')
10255 while (c
!= '\n') c
= getchar ();
10257 printf ("\r\nContinuing...\r\n");
10258 #else /* not MSDOS */
10259 printf ("Continuing...\n");
10260 #endif /* not MSDOS */
10267 /* If executing a function that wants to be interrupted out of
10268 and the user has not deferred quitting by binding `inhibit-quit'
10269 then quit right away. */
10270 if (immediate_quit
&& NILP (Vinhibit_quit
))
10272 struct gl_state_s saved
;
10273 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10275 immediate_quit
= 0;
10278 GCPRO4 (saved
.object
, saved
.global_code
,
10279 saved
.current_syntax_table
, saved
.old_prop
);
10280 Fsignal (Qquit
, Qnil
);
10285 /* Else request quit when it's safe */
10289 if (waiting_for_input
&& !echoing
)
10290 quit_throw_to_read_char ();
10295 /* Handle a C-g by making read_char return C-g. */
10298 quit_throw_to_read_char ()
10301 /* Prevent another signal from doing this before we finish. */
10302 clear_waiting_for_input ();
10305 Vunread_command_events
= Qnil
;
10306 unread_command_char
= -1;
10308 #if 0 /* Currently, sit_for is called from read_char without turning
10309 off polling. And that can call set_waiting_for_input.
10310 It seems to be harmless. */
10311 #ifdef POLL_FOR_INPUT
10312 /* May be > 1 if in recursive minibuffer. */
10313 if (poll_suppress_count
== 0)
10317 if (FRAMEP (internal_last_event_frame
)
10318 && !EQ (internal_last_event_frame
, selected_frame
))
10319 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10322 _longjmp (getcjmp
, 1);
10325 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10326 doc
: /* Set mode of reading keyboard input.
10327 First arg INTERRUPT non-nil means use input interrupts;
10328 nil means use CBREAK mode.
10329 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10330 (no effect except in CBREAK mode).
10331 Third arg META t means accept 8-bit input (for a Meta key).
10332 META nil means ignore the top bit, on the assumption it is parity.
10333 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10334 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10335 See also `current-input-mode'. */)
10336 (interrupt
, flow
, meta
, quit
)
10337 Lisp_Object interrupt
, flow
, meta
, quit
;
10340 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10341 error ("set-input-mode: QUIT must be an ASCII character");
10343 #ifdef POLL_FOR_INPUT
10348 /* this causes startup screen to be restored and messes with the mouse */
10349 reset_sys_modes ();
10353 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10354 if (read_socket_hook
)
10356 /* When using X, don't give the user a real choice,
10357 because we haven't implemented the mechanisms to support it. */
10358 #ifdef NO_SOCK_SIGIO
10359 interrupt_input
= 0;
10360 #else /* not NO_SOCK_SIGIO */
10361 interrupt_input
= 1;
10362 #endif /* NO_SOCK_SIGIO */
10365 interrupt_input
= !NILP (interrupt
);
10366 #else /* not SIGIO */
10367 interrupt_input
= 0;
10368 #endif /* not SIGIO */
10370 /* Our VMS input only works by interrupts, as of now. */
10372 interrupt_input
= 1;
10375 flow_control
= !NILP (flow
);
10378 else if (EQ (meta
, Qt
))
10383 /* Don't let this value be out of range. */
10384 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10390 #ifdef POLL_FOR_INPUT
10391 poll_suppress_count
= 1;
10397 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10398 doc
: /* Return information about the way Emacs currently reads keyboard input.
10399 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10400 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10401 nil, Emacs is using CBREAK mode.
10402 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10403 terminal; this does not apply if Emacs uses interrupt-driven input.
10404 META is t if accepting 8-bit input with 8th bit as Meta flag.
10405 META nil means ignoring the top bit, on the assumption it is parity.
10406 META is neither t nor nil if accepting 8-bit input and using
10407 all 8 bits as the character code.
10408 QUIT is the character Emacs currently uses to quit.
10409 The elements of this list correspond to the arguments of
10410 `set-input-mode'. */)
10413 Lisp_Object val
[4];
10415 val
[0] = interrupt_input
? Qt
: Qnil
;
10416 val
[1] = flow_control
? Qt
: Qnil
;
10417 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10418 XSETFASTINT (val
[3], quit_char
);
10420 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10425 * Set up a new kboard object with reasonable initial values.
10431 kb
->Voverriding_terminal_local_map
= Qnil
;
10432 kb
->Vlast_command
= Qnil
;
10433 kb
->Vreal_last_command
= Qnil
;
10434 kb
->Vprefix_arg
= Qnil
;
10435 kb
->Vlast_prefix_arg
= Qnil
;
10436 kb
->kbd_queue
= Qnil
;
10437 kb
->kbd_queue_has_data
= 0;
10438 kb
->immediate_echo
= 0;
10439 kb
->echo_string
= Qnil
;
10440 kb
->echo_after_prompt
= -1;
10441 kb
->kbd_macro_buffer
= 0;
10442 kb
->kbd_macro_bufsize
= 0;
10443 kb
->defining_kbd_macro
= Qnil
;
10444 kb
->Vlast_kbd_macro
= Qnil
;
10445 kb
->reference_count
= 0;
10446 kb
->Vsystem_key_alist
= Qnil
;
10447 kb
->system_key_syms
= Qnil
;
10448 kb
->Vdefault_minibuffer_frame
= Qnil
;
10452 * Destroy the contents of a kboard object, but not the object itself.
10453 * We use this just before deleting it, or if we're going to initialize
10454 * it a second time.
10460 if (kb
->kbd_macro_buffer
)
10461 xfree (kb
->kbd_macro_buffer
);
10464 #ifdef MULTI_KBOARD
10466 /* Free KB and memory referenced from it. */
10474 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10477 *kbp
= kb
->next_kboard
;
10479 /* Prevent a dangling reference to KB. */
10480 if (kb
== current_kboard
10481 && FRAMEP (selected_frame
)
10482 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10484 current_kboard
= XFRAME (selected_frame
)->kboard
;
10485 if (current_kboard
== kb
)
10493 #endif /* MULTI_KBOARD */
10498 /* This is correct before outermost invocation of the editor loop */
10499 command_loop_level
= -1;
10500 immediate_quit
= 0;
10501 quit_char
= Ctl ('g');
10502 Vunread_command_events
= Qnil
;
10503 unread_command_char
= -1;
10504 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10506 recent_keys_index
= 0;
10507 kbd_fetch_ptr
= kbd_buffer
;
10508 kbd_store_ptr
= kbd_buffer
;
10509 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10511 do_mouse_tracking
= Qnil
;
10515 /* This means that command_loop_1 won't try to select anything the first
10517 internal_last_event_frame
= Qnil
;
10518 Vlast_event_frame
= internal_last_event_frame
;
10520 #ifdef MULTI_KBOARD
10521 current_kboard
= initial_kboard
;
10523 wipe_kboard (current_kboard
);
10524 init_kboard (current_kboard
);
10526 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10528 signal (SIGINT
, interrupt_signal
);
10529 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10530 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10531 SIGQUIT and we can't tell which one it will give us. */
10532 signal (SIGQUIT
, interrupt_signal
);
10533 #endif /* HAVE_TERMIO */
10535 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10537 if (!noninteractive
)
10538 signal (SIGIO
, input_available_signal
);
10541 /* Use interrupt input by default, if it works and noninterrupt input
10542 has deficiencies. */
10544 #ifdef INTERRUPT_INPUT
10545 interrupt_input
= 1;
10547 interrupt_input
= 0;
10550 /* Our VMS input only works by interrupts, as of now. */
10552 interrupt_input
= 1;
10558 if (keyboard_init_hook
)
10559 (*keyboard_init_hook
) ();
10561 #ifdef POLL_FOR_INPUT
10562 poll_suppress_count
= 1;
10567 /* At least provide an escape route since C-g doesn't work. */
10568 signal (SIGINT
, interrupt_signal
);
10572 /* This type's only use is in syms_of_keyboard, to initialize the
10573 event header symbols and put properties on them. */
10574 struct event_head
{
10580 struct event_head head_table
[] = {
10581 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10582 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10583 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10584 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10585 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10586 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10587 /* `select-window' should be handled just like `switch-frame'
10588 in read_key_sequence. */
10589 {&Qselect_window
, "select-window", &Qswitch_frame
}
10593 syms_of_keyboard ()
10595 Vpre_help_message
= Qnil
;
10596 staticpro (&Vpre_help_message
);
10598 Vlispy_mouse_stem
= build_string ("mouse");
10599 staticpro (&Vlispy_mouse_stem
);
10602 QCimage
= intern (":image");
10603 staticpro (&QCimage
);
10605 staticpro (&Qhelp_echo
);
10606 Qhelp_echo
= intern ("help-echo");
10608 staticpro (&item_properties
);
10609 item_properties
= Qnil
;
10611 staticpro (&tool_bar_item_properties
);
10612 tool_bar_item_properties
= Qnil
;
10613 staticpro (&tool_bar_items_vector
);
10614 tool_bar_items_vector
= Qnil
;
10616 staticpro (&real_this_command
);
10617 real_this_command
= Qnil
;
10619 Qtimer_event_handler
= intern ("timer-event-handler");
10620 staticpro (&Qtimer_event_handler
);
10622 Qdisabled_command_hook
= intern ("disabled-command-hook");
10623 staticpro (&Qdisabled_command_hook
);
10625 Qself_insert_command
= intern ("self-insert-command");
10626 staticpro (&Qself_insert_command
);
10628 Qforward_char
= intern ("forward-char");
10629 staticpro (&Qforward_char
);
10631 Qbackward_char
= intern ("backward-char");
10632 staticpro (&Qbackward_char
);
10634 Qdisabled
= intern ("disabled");
10635 staticpro (&Qdisabled
);
10637 Qundefined
= intern ("undefined");
10638 staticpro (&Qundefined
);
10640 Qpre_command_hook
= intern ("pre-command-hook");
10641 staticpro (&Qpre_command_hook
);
10643 Qpost_command_hook
= intern ("post-command-hook");
10644 staticpro (&Qpost_command_hook
);
10646 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10647 staticpro (&Qpost_command_idle_hook
);
10649 Qdeferred_action_function
= intern ("deferred-action-function");
10650 staticpro (&Qdeferred_action_function
);
10652 Qcommand_hook_internal
= intern ("command-hook-internal");
10653 staticpro (&Qcommand_hook_internal
);
10655 Qfunction_key
= intern ("function-key");
10656 staticpro (&Qfunction_key
);
10657 Qmouse_click
= intern ("mouse-click");
10658 staticpro (&Qmouse_click
);
10659 #if defined(WINDOWSNT) || defined(MAC_OSX)
10660 Qmouse_wheel
= intern ("mouse-wheel");
10661 staticpro (&Qmouse_wheel
);
10664 Qlanguage_change
= intern ("language-change");
10665 staticpro (&Qlanguage_change
);
10667 Qdrag_n_drop
= intern ("drag-n-drop");
10668 staticpro (&Qdrag_n_drop
);
10670 Qsave_session
= intern ("save-session");
10671 staticpro(&Qsave_session
);
10673 Qusr1_signal
= intern ("usr1-signal");
10674 staticpro (&Qusr1_signal
);
10675 Qusr2_signal
= intern ("usr2-signal");
10676 staticpro (&Qusr2_signal
);
10678 Qmenu_enable
= intern ("menu-enable");
10679 staticpro (&Qmenu_enable
);
10680 Qmenu_alias
= intern ("menu-alias");
10681 staticpro (&Qmenu_alias
);
10682 QCenable
= intern (":enable");
10683 staticpro (&QCenable
);
10684 QCvisible
= intern (":visible");
10685 staticpro (&QCvisible
);
10686 QChelp
= intern (":help");
10687 staticpro (&QChelp
);
10688 QCfilter
= intern (":filter");
10689 staticpro (&QCfilter
);
10690 QCbutton
= intern (":button");
10691 staticpro (&QCbutton
);
10692 QCkeys
= intern (":keys");
10693 staticpro (&QCkeys
);
10694 QCkey_sequence
= intern (":key-sequence");
10695 staticpro (&QCkey_sequence
);
10696 QCtoggle
= intern (":toggle");
10697 staticpro (&QCtoggle
);
10698 QCradio
= intern (":radio");
10699 staticpro (&QCradio
);
10701 Qmode_line
= intern ("mode-line");
10702 staticpro (&Qmode_line
);
10703 Qvertical_line
= intern ("vertical-line");
10704 staticpro (&Qvertical_line
);
10705 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10706 staticpro (&Qvertical_scroll_bar
);
10707 Qmenu_bar
= intern ("menu-bar");
10708 staticpro (&Qmenu_bar
);
10710 Qabove_handle
= intern ("above-handle");
10711 staticpro (&Qabove_handle
);
10712 Qhandle
= intern ("handle");
10713 staticpro (&Qhandle
);
10714 Qbelow_handle
= intern ("below-handle");
10715 staticpro (&Qbelow_handle
);
10716 Qup
= intern ("up");
10718 Qdown
= intern ("down");
10719 staticpro (&Qdown
);
10720 Qtop
= intern ("top");
10722 Qbottom
= intern ("bottom");
10723 staticpro (&Qbottom
);
10724 Qend_scroll
= intern ("end-scroll");
10725 staticpro (&Qend_scroll
);
10726 Qratio
= intern ("ratio");
10727 staticpro (&Qratio
);
10729 Qevent_kind
= intern ("event-kind");
10730 staticpro (&Qevent_kind
);
10731 Qevent_symbol_elements
= intern ("event-symbol-elements");
10732 staticpro (&Qevent_symbol_elements
);
10733 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10734 staticpro (&Qevent_symbol_element_mask
);
10735 Qmodifier_cache
= intern ("modifier-cache");
10736 staticpro (&Qmodifier_cache
);
10738 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10739 staticpro (&Qrecompute_lucid_menubar
);
10740 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10741 staticpro (&Qactivate_menubar_hook
);
10743 Qpolling_period
= intern ("polling-period");
10744 staticpro (&Qpolling_period
);
10746 Qinput_method_function
= intern ("input-method-function");
10747 staticpro (&Qinput_method_function
);
10749 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10750 staticpro (&Qinput_method_exit_on_first_char
);
10751 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10752 staticpro (&Qinput_method_use_echo_area
);
10754 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10755 Fset (Qinput_method_use_echo_area
, Qnil
);
10757 last_point_position_buffer
= Qnil
;
10760 struct event_head
*p
;
10762 for (p
= head_table
;
10763 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10766 *p
->var
= intern (p
->name
);
10767 staticpro (p
->var
);
10768 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10769 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10773 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10774 staticpro (&button_down_location
);
10775 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10776 staticpro (&mouse_syms
);
10780 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10782 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10783 for (i
= 0; i
< len
; i
++)
10784 if (modifier_names
[i
])
10785 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10786 staticpro (&modifier_symbols
);
10789 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10790 staticpro (&recent_keys
);
10792 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10793 staticpro (&this_command_keys
);
10795 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10796 staticpro (&raw_keybuf
);
10798 Qextended_command_history
= intern ("extended-command-history");
10799 Fset (Qextended_command_history
, Qnil
);
10800 staticpro (&Qextended_command_history
);
10802 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10803 staticpro (&kbd_buffer_gcpro
);
10805 accent_key_syms
= Qnil
;
10806 staticpro (&accent_key_syms
);
10808 func_key_syms
= Qnil
;
10809 staticpro (&func_key_syms
);
10811 #if defined(WINDOWSNT) || defined(MAC_OSX)
10812 mouse_wheel_syms
= Qnil
;
10813 staticpro (&mouse_wheel_syms
);
10814 drag_n_drop_syms
= Qnil
;
10815 staticpro (&drag_n_drop_syms
);
10818 unread_switch_frame
= Qnil
;
10819 staticpro (&unread_switch_frame
);
10821 internal_last_event_frame
= Qnil
;
10822 staticpro (&internal_last_event_frame
);
10824 read_key_sequence_cmd
= Qnil
;
10825 staticpro (&read_key_sequence_cmd
);
10827 menu_bar_one_keymap_changed_items
= Qnil
;
10828 staticpro (&menu_bar_one_keymap_changed_items
);
10830 defsubr (&Sevent_convert_list
);
10831 defsubr (&Sread_key_sequence
);
10832 defsubr (&Sread_key_sequence_vector
);
10833 defsubr (&Srecursive_edit
);
10835 defsubr (&Strack_mouse
);
10837 defsubr (&Sinput_pending_p
);
10838 defsubr (&Scommand_execute
);
10839 defsubr (&Srecent_keys
);
10840 defsubr (&Sthis_command_keys
);
10841 defsubr (&Sthis_command_keys_vector
);
10842 defsubr (&Sthis_single_command_keys
);
10843 defsubr (&Sthis_single_command_raw_keys
);
10844 defsubr (&Sreset_this_command_lengths
);
10845 defsubr (&Sclear_this_command_keys
);
10846 defsubr (&Ssuspend_emacs
);
10847 defsubr (&Sabort_recursive_edit
);
10848 defsubr (&Sexit_recursive_edit
);
10849 defsubr (&Srecursion_depth
);
10850 defsubr (&Stop_level
);
10851 defsubr (&Sdiscard_input
);
10852 defsubr (&Sopen_dribble_file
);
10853 defsubr (&Sset_input_mode
);
10854 defsubr (&Scurrent_input_mode
);
10855 defsubr (&Sexecute_extended_command
);
10857 DEFVAR_LISP ("last-command-char", &last_command_char
,
10858 doc
: /* Last input event that was part of a command. */);
10860 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10861 doc
: /* Last input event that was part of a command. */);
10863 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10864 doc
: /* Last input event in a command, except for mouse menu events.
10865 Mouse menus give back keys that don't look like mouse events;
10866 this variable holds the actual mouse event that led to the menu,
10867 so that you can determine whether the command was run by mouse or not. */);
10869 DEFVAR_LISP ("last-input-char", &last_input_char
,
10870 doc
: /* Last input event. */);
10872 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10873 doc
: /* Last input event. */);
10875 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10876 doc
: /* List of events to be read as the command input.
10877 These events are processed first, before actual keyboard input. */);
10878 Vunread_command_events
= Qnil
;
10880 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10881 doc
: /* If not -1, an object to be read as next command input event. */);
10883 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10884 doc
: /* List of events to be processed as input by input methods.
10885 These events are processed after `unread-command-events', but
10886 before actual keyboard input. */);
10887 Vunread_post_input_method_events
= Qnil
;
10889 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10890 doc
: /* List of events to be processed as input by input methods.
10891 These events are processed after `unread-command-events', but
10892 before actual keyboard input. */);
10893 Vunread_input_method_events
= Qnil
;
10895 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10896 doc
: /* Meta-prefix character code.
10897 Meta-foo as command input turns into this character followed by foo. */);
10898 XSETINT (meta_prefix_char
, 033);
10900 DEFVAR_KBOARD ("last-command", Vlast_command
,
10901 doc
: /* The last command executed.
10902 Normally a symbol with a function definition, but can be whatever was found
10903 in the keymap, or whatever the variable `this-command' was set to by that
10906 The value `mode-exit' is special; it means that the previous command
10907 read an event that told it to exit, and it did so and unread that event.
10908 In other words, the present command is the event that made the previous
10911 The value `kill-region' is special; it means that the previous command
10912 was a kill command. */);
10914 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10915 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10917 DEFVAR_LISP ("this-command", &Vthis_command
,
10918 doc
: /* The command now being executed.
10919 The command can set this variable; whatever is put here
10920 will be in `last-command' during the following command. */);
10921 Vthis_command
= Qnil
;
10923 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10924 doc
: /* The command bound to the current key sequence before remapping.
10925 It equals `this-command' if the original command was not remapped through
10926 any of the active keymaps. Otherwise, the value of `this-command' is the
10927 result of looking up the original command in the active keymaps. */);
10928 Vthis_original_command
= Qnil
;
10930 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10931 doc
: /* *Number of input events between auto-saves.
10932 Zero means disable autosaving due to number of characters typed. */);
10933 auto_save_interval
= 300;
10935 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10936 doc
: /* *Number of seconds idle time before auto-save.
10937 Zero or nil means disable auto-saving due to idleness.
10938 After auto-saving due to this many seconds of idle time,
10939 Emacs also does a garbage collection if that seems to be warranted. */);
10940 XSETFASTINT (Vauto_save_timeout
, 30);
10942 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10943 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10944 The value may be integer or floating point. */);
10945 Vecho_keystrokes
= make_number (1);
10947 DEFVAR_INT ("polling-period", &polling_period
,
10948 doc
: /* *Interval between polling for input during Lisp execution.
10949 The reason for polling is to make C-g work to stop a running program.
10950 Polling is needed only when using X windows and SIGIO does not work.
10951 Polling is automatically disabled in all other cases. */);
10952 polling_period
= 2;
10954 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10955 doc
: /* *Maximum time between mouse clicks to make a double-click.
10956 Measured in milliseconds. nil means disable double-click recognition;
10957 t means double-clicks have no time limit and are detected
10958 by position only. */);
10959 Vdouble_click_time
= make_number (500);
10961 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10962 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10963 On window-system frames, value is the number of pixels the mouse may have
10964 moved horizontally or vertically between two clicks to make a double-click.
10965 On non window-system frames, value is interpreted in units of 1/8 characters
10968 This variable is also the threshold for motion of the mouse
10969 to count as a drag. */);
10970 double_click_fuzz
= 3;
10972 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10973 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10974 inhibit_local_menu_bar_menus
= 0;
10976 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10977 doc
: /* Number of complete key sequences read as input so far.
10978 This includes key sequences read from keyboard macros.
10979 The number is effectively the number of interactive command invocations. */);
10980 num_input_keys
= 0;
10982 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10983 doc
: /* Number of input events read from the keyboard so far.
10984 This does not include events generated by keyboard macros. */);
10985 num_nonmacro_input_events
= 0;
10987 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10988 doc
: /* The frame in which the most recently read event occurred.
10989 If the last event came from a keyboard macro, this is set to `macro'. */);
10990 Vlast_event_frame
= Qnil
;
10992 /* This variable is set up in sysdep.c. */
10993 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10994 doc
: /* The ERASE character as set by the user with stty. */);
10996 DEFVAR_LISP ("help-char", &Vhelp_char
,
10997 doc
: /* Character to recognize as meaning Help.
10998 When it is read, do `(eval help-form)', and display result if it's a string.
10999 If the value of `help-form' is nil, this char can be read normally. */);
11000 XSETINT (Vhelp_char
, Ctl ('H'));
11002 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11003 doc
: /* List of input events to recognize as meaning Help.
11004 These work just like the value of `help-char' (see that). */);
11005 Vhelp_event_list
= Qnil
;
11007 DEFVAR_LISP ("help-form", &Vhelp_form
,
11008 doc
: /* Form to execute when character `help-char' is read.
11009 If the form returns a string, that string is displayed.
11010 If `help-form' is nil, the help char is not recognized. */);
11013 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11014 doc
: /* Command to run when `help-char' character follows a prefix key.
11015 This command is used only when there is no actual binding
11016 for that character after that prefix key. */);
11017 Vprefix_help_command
= Qnil
;
11019 DEFVAR_LISP ("top-level", &Vtop_level
,
11020 doc
: /* Form to evaluate when Emacs starts up.
11021 Useful to set before you dump a modified Emacs. */);
11024 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11025 doc
: /* Translate table for keyboard input, or nil.
11026 Each character is looked up in this string and the contents used instead.
11027 The value may be a string, a vector, or a char-table.
11028 If it is a string or vector of length N,
11029 character codes N and up are untranslated.
11030 In a vector or a char-table, an element which is nil means "no translation".
11032 This is applied to the characters supplied to input methods, not their
11033 output. See also `translation-table-for-input'. */);
11034 Vkeyboard_translate_table
= Qnil
;
11036 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11037 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11038 \(Even if the operating system has support for stopping a process.\) */);
11039 cannot_suspend
= 0;
11041 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11042 doc
: /* Non-nil means prompt with menus when appropriate.
11043 This is done when reading from a keymap that has a prompt string,
11044 for elements that have prompt strings.
11045 The menu is displayed on the screen
11046 if X menus were enabled at configuration
11047 time and the previous event was a mouse click prefix key.
11048 Otherwise, menu prompting uses the echo area. */);
11049 menu_prompting
= 1;
11051 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11052 doc
: /* Character to see next line of menu prompt.
11053 Type this character while in a menu prompt to rotate around the lines of it. */);
11054 XSETINT (menu_prompt_more_char
, ' ');
11056 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11057 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11058 Emacs applies the modifiers of the character stored here to each keyboard
11059 character it reads. For example, after evaluating the expression
11060 (setq extra-keyboard-modifiers ?\\C-x)
11061 all input characters will have the control modifier applied to them.
11063 Note that the character ?\\C-@, equivalent to the integer zero, does
11064 not count as a control character; rather, it counts as a character
11065 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11066 cancels any modification. */);
11067 extra_keyboard_modifiers
= 0;
11069 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11070 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11071 The command loop sets this to nil before each command,
11072 and tests the value when the command returns.
11073 Buffer modification stores t in this variable. */);
11074 Vdeactivate_mark
= Qnil
;
11076 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11077 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11078 Vcommand_hook_internal
= Qnil
;
11080 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11081 doc
: /* Normal hook run before each command is executed.
11082 If an unhandled error happens in running this hook,
11083 the hook value is set to nil, since otherwise the error
11084 might happen repeatedly and make Emacs nonfunctional. */);
11085 Vpre_command_hook
= Qnil
;
11087 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11088 doc
: /* Normal hook run after each command is executed.
11089 If an unhandled error happens in running this hook,
11090 the hook value is set to nil, since otherwise the error
11091 might happen repeatedly and make Emacs nonfunctional. */);
11092 Vpost_command_hook
= Qnil
;
11094 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11095 doc
: /* Normal hook run after each command is executed, if idle.
11096 Errors running the hook are caught and ignored. */);
11097 Vpost_command_idle_hook
= Qnil
;
11099 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11100 doc
: /* Delay time before running `post-command-idle-hook'.
11101 This is measured in microseconds. */);
11102 post_command_idle_delay
= 100000;
11105 DEFVAR_LISP ("echo-area-clear-hook", ...,
11106 doc
: /* Normal hook run when clearing the echo area. */);
11108 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11109 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11111 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11112 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11113 Vlucid_menu_bar_dirty_flag
= Qnil
;
11115 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11116 doc
: /* List of menu bar items to move to the end of the menu bar.
11117 The elements of the list are event types that may have menu bar bindings. */);
11118 Vmenu_bar_final_items
= Qnil
;
11120 DEFVAR_KBOARD ("overriding-terminal-local-map",
11121 Voverriding_terminal_local_map
,
11122 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11123 If this variable is non-nil, it is used as a keymap instead of the
11124 buffer's local map, and the minor mode keymaps and text property keymaps.
11125 This variable is intended to let commands such as `universal-argument'
11126 set up a different keymap for reading the next command. */);
11128 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11129 doc
: /* Keymap that overrides all other local keymaps.
11130 If this variable is non-nil, it is used as a keymap instead of the
11131 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11132 Voverriding_local_map
= Qnil
;
11134 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11135 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11136 Otherwise, the menu bar continues to reflect the buffer's local map
11137 and the minor mode maps regardless of `overriding-local-map'. */);
11138 Voverriding_local_map_menu_flag
= Qnil
;
11140 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11141 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11142 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11144 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11145 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11147 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11148 doc
: /* Alist of system-specific X windows key symbols.
11149 Each element should have the form (N . SYMBOL) where N is the
11150 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11151 and SYMBOL is its name. */);
11153 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11154 doc
: /* List of deferred actions to be performed at a later time.
11155 The precise format isn't relevant here; we just check whether it is nil. */);
11156 Vdeferred_action_list
= Qnil
;
11158 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11159 doc
: /* Function to call to handle deferred actions, after each command.
11160 This function is called with no arguments after each command
11161 whenever `deferred-action-list' is non-nil. */);
11162 Vdeferred_action_function
= Qnil
;
11164 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11165 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11166 The value can be a length of time to show the message for.
11167 If the value is non-nil and not a number, we wait 2 seconds. */);
11168 Vsuggest_key_bindings
= Qt
;
11170 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11171 doc
: /* List of active absolute time timers in order of increasing time. */);
11172 Vtimer_list
= Qnil
;
11174 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11175 doc
: /* List of active idle-time timers in order of increasing time. */);
11176 Vtimer_idle_list
= Qnil
;
11178 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11179 doc
: /* If non-nil, the function that implements the current input method.
11180 It's called with one argument, a printing character that was just read.
11181 \(That means a character with code 040...0176.)
11182 Typically this function uses `read-event' to read additional events.
11183 When it does so, it should first bind `input-method-function' to nil
11184 so it will not be called recursively.
11186 The function should return a list of zero or more events
11187 to be used as input. If it wants to put back some events
11188 to be reconsidered, separately, by the input method,
11189 it can add them to the beginning of `unread-command-events'.
11191 The input method function can find in `input-method-previous-method'
11192 the previous echo area message.
11194 The input method function should refer to the variables
11195 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11196 for guidance on what to do. */);
11197 Vinput_method_function
= Qnil
;
11199 DEFVAR_LISP ("input-method-previous-message",
11200 &Vinput_method_previous_message
,
11201 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11202 This variable exists because `read-event' clears the echo area
11203 before running the input method. It is nil if there was no message. */);
11204 Vinput_method_previous_message
= Qnil
;
11206 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11207 doc
: /* If non-nil, the function that implements the display of help.
11208 It's called with one argument, the help string to display. */);
11209 Vshow_help_function
= Qnil
;
11211 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11212 doc
: /* If non-nil, suppress point adjustment after executing a command.
11214 After a command is executed, if point is moved into a region that has
11215 special properties (e.g. composition, display), we adjust point to
11216 the boundary of the region. But, several special commands sets this
11217 variable to non-nil, then we suppress the point adjustment.
11219 This variable is set to nil before reading a command, and is checked
11220 just after executing the command. */);
11221 Vdisable_point_adjustment
= Qnil
;
11223 DEFVAR_LISP ("global-disable-point-adjustment",
11224 &Vglobal_disable_point_adjustment
,
11225 doc
: /* *If non-nil, always suppress point adjustment.
11227 The default value is nil, in which case, point adjustment are
11228 suppressed only after special commands that set
11229 `disable-point-adjustment' (which see) to non-nil. */);
11230 Vglobal_disable_point_adjustment
= Qnil
;
11232 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11233 doc
: /* Non-nil means updating menu bindings is allowed.
11234 A value of nil means menu bindings should not be updated.
11235 Used during Emacs' startup. */);
11236 update_menu_bindings
= 1;
11238 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11239 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11240 If the value is not a number, such messages don't time out. */);
11241 Vminibuffer_message_timeout
= make_number (2);
11245 keys_of_keyboard ()
11247 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11248 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11249 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11250 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11251 initial_define_key (meta_map
, 'x', "execute-extended-command");
11253 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11254 "handle-delete-frame");
11255 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11257 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11259 /* Handling it at such a low-level causes read_key_sequence to get
11260 * confused because it doesn't realize that the current_buffer was
11261 * changed by read_char.
11263 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11264 * "handle-select-window"); */
11265 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11266 "handle-save-session");