1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000
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"
36 #include "dispextern.h"
39 #include "intervals.h"
40 #include "blockinput.h"
52 #include <sys/ioctl.h>
54 #endif /* not MSDOS */
56 #include "syssignal.h"
59 #include <sys/types.h>
64 /* This is to get the definitions of the XK_ symbols. */
71 #endif /* HAVE_NTGUI */
73 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
78 /* Variables for blockinput.h: */
80 /* Non-zero if interrupt input is blocked right now. */
81 int interrupt_input_blocked
;
83 /* Nonzero means an input interrupt has arrived
84 during the current critical section. */
85 int interrupt_input_pending
;
88 /* File descriptor to use for input. */
91 #ifdef HAVE_WINDOW_SYSTEM
92 /* Make all keyboard buffers much bigger when using X windows. */
94 /* But not too big (local data > 32K error) if on macintosh */
95 #define KBD_BUFFER_SIZE 512
97 #define KBD_BUFFER_SIZE 4096
99 #else /* No X-windows, character input */
100 #define KBD_BUFFER_SIZE 256
101 #endif /* No X-windows */
103 /* Following definition copied from eval.c */
107 struct backtrace
*next
;
108 Lisp_Object
*function
;
109 Lisp_Object
*args
; /* Points to vector of args. */
110 int nargs
; /* length of vector. If nargs is UNEVALLED,
111 args points to slot holding list of
117 KBOARD
*initial_kboard
;
118 KBOARD
*current_kboard
;
122 KBOARD the_only_kboard
;
125 /* Non-nil disable property on a command means
126 do not execute it; call disabled-command-hook's value instead. */
127 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
129 #define NUM_RECENT_KEYS (100)
130 int recent_keys_index
; /* Index for storing next element into recent_keys */
131 int total_keys
; /* Total number of elements stored into recent_keys */
132 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
134 /* Vector holding the key sequence that invoked the current command.
135 It is reused for each command, and it may be longer than the current
136 sequence; this_command_key_count indicates how many elements
137 actually mean something.
138 It's easier to staticpro a single Lisp_Object than an array. */
139 Lisp_Object this_command_keys
;
140 int this_command_key_count
;
142 /* This vector is used as a buffer to record the events that were actually read
143 by read_key_sequence. */
144 Lisp_Object raw_keybuf
;
145 int raw_keybuf_count
;
147 #define GROW_RAW_KEYBUF \
148 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
150 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
152 new = Fmake_vector (make_number (newsize), Qnil); \
153 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
154 raw_keybuf_count * sizeof (Lisp_Object)); \
158 /* Number of elements of this_command_keys
159 that precede this key sequence. */
160 int this_single_command_key_start
;
162 /* Record values of this_command_key_count and echo_length ()
163 before this command was read. */
164 static int before_command_key_count
;
165 static int before_command_echo_length
;
166 /* Values of before_command_key_count and before_command_echo_length
167 saved by reset-this-command-lengths. */
168 static int before_command_key_count_1
;
169 static int before_command_echo_length_1
;
170 /* Flag set by reset-this-command-lengths,
171 saying to reset the lengths when add_command_key is called. */
172 static int before_command_restore_flag
;
174 extern int minbuf_level
;
176 extern int message_enable_multibyte
;
178 extern struct backtrace
*backtrace_list
;
180 /* If non-nil, the function that implements the display of help.
181 It's called with one argument, the help string to display. */
183 Lisp_Object Vshow_help_function
;
185 /* Nonzero means do menu prompting. */
186 static int menu_prompting
;
188 /* Character to see next line of menu prompt. */
189 static Lisp_Object menu_prompt_more_char
;
191 /* For longjmp to where kbd input is being done. */
192 static jmp_buf getcjmp
;
194 /* True while doing kbd input. */
195 int waiting_for_input
;
197 /* True while displaying for echoing. Delays C-g throwing. */
201 /* Non-null means we can start echoing at the next input pause even
202 though there is something in the echo area. */
204 static struct kboard
*ok_to_echo_at_next_pause
;
206 /* The kboard last echoing, or null for none. Reset to 0 in
207 cancel_echoing. If non-null, and a current echo area message
208 exists, and echo_message_buffer is eq to the current message
209 buffer, we know that the message comes from echo_kboard. */
211 static struct kboard
*echo_kboard
;
213 /* The buffer used for echoing. Set in echo_now, reset in
216 static Lisp_Object echo_message_buffer
;
218 /* Nonzero means disregard local maps for the menu bar. */
219 static int inhibit_local_menu_bar_menus
;
221 /* Nonzero means C-g should cause immediate error-signal. */
224 /* The user's ERASE setting. */
225 Lisp_Object Vtty_erase_char
;
227 /* Character to recognize as the help char. */
228 Lisp_Object Vhelp_char
;
230 /* List of other event types to recognize as meaning "help". */
231 Lisp_Object Vhelp_event_list
;
233 /* Form to execute when help char is typed. */
234 Lisp_Object Vhelp_form
;
236 /* Command to run when the help character follows a prefix key. */
237 Lisp_Object Vprefix_help_command
;
239 /* List of items that should move to the end of the menu bar. */
240 Lisp_Object Vmenu_bar_final_items
;
242 /* Non-nil means show the equivalent key-binding for
243 any M-x command that has one.
244 The value can be a length of time to show the message for.
245 If the value is non-nil and not a number, we wait 2 seconds. */
246 Lisp_Object Vsuggest_key_bindings
;
248 /* Character that causes a quit. Normally C-g.
250 If we are running on an ordinary terminal, this must be an ordinary
251 ASCII char, since we want to make it our interrupt character.
253 If we are not running on an ordinary terminal, it still needs to be
254 an ordinary ASCII char. This character needs to be recognized in
255 the input interrupt handler. At this point, the keystroke is
256 represented as a struct input_event, while the desired quit
257 character is specified as a lispy event. The mapping from struct
258 input_events to lispy events cannot run in an interrupt handler,
259 and the reverse mapping is difficult for anything but ASCII
262 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
266 extern Lisp_Object current_global_map
;
267 extern int minibuf_level
;
269 /* If non-nil, this is a map that overrides all other local maps. */
270 Lisp_Object Voverriding_local_map
;
272 /* If non-nil, Voverriding_local_map applies to the menu bar. */
273 Lisp_Object Voverriding_local_map_menu_flag
;
275 /* Keymap that defines special misc events that should
276 be processed immediately at a low level. */
277 Lisp_Object Vspecial_event_map
;
279 /* Current depth in recursive edits. */
280 int command_loop_level
;
282 /* Total number of times command_loop has read a key sequence. */
285 /* Last input character read as a command. */
286 Lisp_Object last_command_char
;
288 /* Last input character read as a command, not counting menus
289 reached by the mouse. */
290 Lisp_Object last_nonmenu_event
;
292 /* Last input character read for any purpose. */
293 Lisp_Object last_input_char
;
295 /* If not Qnil, a list of objects to be read as subsequent command input. */
296 Lisp_Object Vunread_command_events
;
298 /* If not Qnil, a list of objects to be read as subsequent command input
299 including input method processing. */
300 Lisp_Object Vunread_input_method_events
;
302 /* If not Qnil, a list of objects to be read as subsequent command input
303 but NOT including input method processing. */
304 Lisp_Object Vunread_post_input_method_events
;
306 /* If not -1, an event to be read as subsequent command input. */
307 int unread_command_char
;
309 /* If not Qnil, this is a switch-frame event which we decided to put
310 off until the end of a key sequence. This should be read as the
311 next command input, after any unread_command_events.
313 read_key_sequence uses this to delay switch-frame events until the
314 end of the key sequence; Fread_char uses it to put off switch-frame
315 events until a non-ASCII event is acceptable as input. */
316 Lisp_Object unread_switch_frame
;
318 /* A mask of extra modifier bits to put into every keyboard char. */
319 int extra_keyboard_modifiers
;
321 /* Char to use as prefix when a meta character is typed in.
322 This is bound on entry to minibuffer in case ESC is changed there. */
324 Lisp_Object meta_prefix_char
;
326 /* Last size recorded for a current buffer which is not a minibuffer. */
327 static int last_non_minibuf_size
;
329 /* Number of idle seconds before an auto-save and garbage collection. */
330 static Lisp_Object Vauto_save_timeout
;
332 /* Total number of times read_char has returned. */
333 int num_input_events
;
335 /* Total number of times read_char has returned, outside of macros. */
336 int num_nonmacro_input_events
;
338 /* Auto-save automatically when this many characters have been typed
339 since the last time. */
341 static int auto_save_interval
;
343 /* Value of num_nonmacro_input_events as of last auto save. */
347 /* The command being executed by the command loop.
348 Commands may set this, and the value set will be copied into
349 current_kboard->Vlast_command instead of the actual command. */
350 Lisp_Object Vthis_command
;
352 /* This is like Vthis_command, except that commands never set it. */
353 Lisp_Object real_this_command
;
355 /* The value of point when the last command was executed. */
356 int last_point_position
;
358 /* The buffer that was current when the last command was started. */
359 Lisp_Object last_point_position_buffer
;
361 /* The frame in which the last input event occurred, or Qmacro if the
362 last event came from a macro. We use this to determine when to
363 generate switch-frame events. This may be cleared by functions
364 like Fselect_frame, to make sure that a switch-frame event is
365 generated by the next character. */
366 Lisp_Object internal_last_event_frame
;
368 /* A user-visible version of the above, intended to allow users to
369 figure out where the last event came from, if the event doesn't
370 carry that information itself (i.e. if it was a character). */
371 Lisp_Object Vlast_event_frame
;
373 /* The timestamp of the last input event we received from the X server.
374 X Windows wants this for selection ownership. */
375 unsigned long last_event_timestamp
;
377 Lisp_Object Qself_insert_command
;
378 Lisp_Object Qforward_char
;
379 Lisp_Object Qbackward_char
;
380 Lisp_Object Qundefined
;
381 Lisp_Object Qtimer_event_handler
;
383 /* read_key_sequence stores here the command definition of the
384 key sequence that it reads. */
385 Lisp_Object read_key_sequence_cmd
;
387 /* Echo unfinished commands after this many seconds of pause. */
388 Lisp_Object Vecho_keystrokes
;
390 /* Form to evaluate (if non-nil) when Emacs is started. */
391 Lisp_Object Vtop_level
;
393 /* User-supplied string to translate input characters through. */
394 Lisp_Object Vkeyboard_translate_table
;
396 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
397 extern Lisp_Object Vfunction_key_map
;
399 /* Another keymap that maps key sequences into key sequences.
400 This one takes precedence over ordinary definitions. */
401 extern Lisp_Object Vkey_translation_map
;
403 /* If non-nil, this implements the current input method. */
404 Lisp_Object Vinput_method_function
;
405 Lisp_Object Qinput_method_function
;
407 /* When we call Vinput_method_function,
408 this holds the echo area message that was just erased. */
409 Lisp_Object Vinput_method_previous_message
;
411 /* Non-nil means deactivate the mark at end of this command. */
412 Lisp_Object Vdeactivate_mark
;
414 /* Menu bar specified in Lucid Emacs fashion. */
416 Lisp_Object Vlucid_menu_bar_dirty_flag
;
417 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
419 Lisp_Object Qecho_area_clear_hook
;
421 /* Hooks to run before and after each command. */
422 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
423 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
424 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
425 /* Hook run after a command if there's no more input soon. */
426 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
428 /* Delay time in microseconds before running post-command-idle-hook. */
429 int post_command_idle_delay
;
431 /* List of deferred actions to be performed at a later time.
432 The precise format isn't relevant here; we just check whether it is nil. */
433 Lisp_Object Vdeferred_action_list
;
435 /* Function to call to handle deferred actions, when there are any. */
436 Lisp_Object Vdeferred_action_function
;
437 Lisp_Object Qdeferred_action_function
;
439 Lisp_Object Qinput_method_exit_on_first_char
;
440 Lisp_Object Qinput_method_use_echo_area
;
442 /* File in which we write all commands we read. */
445 /* Nonzero if input is available. */
448 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
449 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
453 extern char *pending_malloc_warning
;
455 /* Circular buffer for pre-read keyboard input. */
457 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
459 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
461 The interrupt-level event handlers will never enqueue an event on a
462 frame which is not in Vframe_list, and once an event is dequeued,
463 internal_last_event_frame or the event itself points to the frame.
466 But while the event is sitting in the queue, it's completely
467 unprotected. Suppose the user types one command which will run for
468 a while and then delete a frame, and then types another event at
469 the frame that will be deleted, before the command gets around to
470 it. Suppose there are no references to this frame elsewhere in
471 Emacs, and a GC occurs before the second event is dequeued. Now we
472 have an event referring to a freed frame, which will crash Emacs
475 Similar things happen when an event on a scroll bar is enqueued; the
476 window may be deleted while the event is in the queue.
478 So, we use this vector to protect the Lisp_Objects in the event
479 queue. That way, they'll be dequeued as dead frames or windows,
480 but still valid Lisp objects.
482 If kbd_buffer[i].kind != no_event, then
484 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
485 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
487 static Lisp_Object kbd_buffer_gcpro
;
489 /* Pointer to next available character in kbd_buffer.
490 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
491 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
492 next available char is in kbd_buffer[0]. */
493 static struct input_event
*kbd_fetch_ptr
;
495 /* Pointer to next place to store character in kbd_buffer. This
496 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
497 character should go in kbd_buffer[0]. */
498 static struct input_event
* volatile kbd_store_ptr
;
500 /* The above pair of variables forms a "queue empty" flag. When we
501 enqueue a non-hook event, we increment kbd_store_ptr. When we
502 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
503 there is input available iff the two pointers are not equal.
505 Why not just have a flag set and cleared by the enqueuing and
506 dequeuing functions? Such a flag could be screwed up by interrupts
507 at inopportune times. */
509 /* If this flag is non-nil, we check mouse_moved to see when the
510 mouse moves, and motion events will appear in the input stream.
511 Otherwise, mouse motion is ignored. */
512 static Lisp_Object do_mouse_tracking
;
514 /* Symbols to head events. */
515 Lisp_Object Qmouse_movement
;
516 Lisp_Object Qscroll_bar_movement
;
517 Lisp_Object Qswitch_frame
;
518 Lisp_Object Qdelete_frame
;
519 Lisp_Object Qiconify_frame
;
520 Lisp_Object Qmake_frame_visible
;
521 Lisp_Object Qhelp_echo
;
523 /* Symbols to denote kinds of events. */
524 Lisp_Object Qfunction_key
;
525 Lisp_Object Qmouse_click
;
527 Lisp_Object Qmouse_wheel
;
528 Lisp_Object Qlanguage_change
;
530 Lisp_Object Qdrag_n_drop
;
531 /* Lisp_Object Qmouse_movement; - also an event header */
533 /* Properties of event headers. */
534 Lisp_Object Qevent_kind
;
535 Lisp_Object Qevent_symbol_elements
;
537 /* menu item parts */
538 Lisp_Object Qmenu_alias
;
539 Lisp_Object Qmenu_enable
;
540 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
541 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
542 extern Lisp_Object Vdefine_key_rebound_commands
;
543 extern Lisp_Object Qmenu_item
;
545 /* An event header symbol HEAD may have a property named
546 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
547 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
548 mask of modifiers applied to it. If present, this is used to help
549 speed up parse_modifiers. */
550 Lisp_Object Qevent_symbol_element_mask
;
552 /* An unmodified event header BASE may have a property named
553 Qmodifier_cache, which is an alist mapping modifier masks onto
554 modified versions of BASE. If present, this helps speed up
556 Lisp_Object Qmodifier_cache
;
558 /* Symbols to use for parts of windows. */
559 Lisp_Object Qmode_line
;
560 Lisp_Object Qvertical_line
;
561 Lisp_Object Qvertical_scroll_bar
;
562 Lisp_Object Qmenu_bar
;
564 Lisp_Object
recursive_edit_unwind (), command_loop ();
565 Lisp_Object
Fthis_command_keys ();
566 Lisp_Object Qextended_command_history
;
567 EMACS_TIME
timer_check ();
569 extern Lisp_Object Vhistory_length
;
571 extern char *x_get_keysym_name ();
573 static void record_menu_key ();
575 Lisp_Object Qpolling_period
;
577 /* List of absolute timers. Appears in order of next scheduled event. */
578 Lisp_Object Vtimer_list
;
580 /* List of idle time timers. Appears in order of next scheduled event. */
581 Lisp_Object Vtimer_idle_list
;
583 /* Incremented whenever a timer is run. */
586 extern Lisp_Object Vprint_level
, Vprint_length
;
588 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
590 EMACS_TIME
*input_available_clear_time
;
592 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
593 Default is 1 if INTERRUPT_INPUT is defined. */
596 /* Nonzero while interrupts are temporarily deferred during redisplay. */
597 int interrupts_deferred
;
599 /* Nonzero means use ^S/^Q for flow control. */
602 /* Allow m- file to inhibit use of FIONREAD. */
603 #ifdef BROKEN_FIONREAD
607 /* We are unable to use interrupts if FIONREAD is not available,
608 so flush SIGIO so we won't try. */
615 /* If we support a window system, turn on the code to poll periodically
616 to detect C-g. It isn't actually used when doing interrupt input. */
617 #ifdef HAVE_WINDOW_SYSTEM
618 #define POLL_FOR_INPUT
621 /* After a command is executed, if point is moved into a region that
622 has specific properties (e.g. composition, display), we adjust
623 point to the boundary of the region. But, if a command sets this
624 valiable to non-nil, we suppress this point adjustment. This
625 variable is set to nil before reading a command. */
627 Lisp_Object Vdisable_point_adjustment
;
629 /* If non-nil, always disable point adjustment. */
631 Lisp_Object Vglobal_disable_point_adjustment
;
634 /* Global variable declarations. */
636 /* Function for init_keyboard to call with no args (if nonzero). */
637 void (*keyboard_init_hook
) ();
639 static int read_avail_input ();
640 static void get_input_pending ();
641 static int readable_events ();
642 static Lisp_Object
read_char_x_menu_prompt ();
643 static Lisp_Object
read_char_minibuf_menu_prompt ();
644 static Lisp_Object
make_lispy_event ();
646 static Lisp_Object
make_lispy_movement ();
648 static Lisp_Object
modify_event_symbol ();
649 static Lisp_Object
make_lispy_switch_frame ();
650 static int parse_solitary_modifier ();
651 static void save_getcjmp ();
652 static void restore_getcjmp ();
653 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
655 /* Nonzero means don't try to suspend even if the operating system seems
657 static int cannot_suspend
;
659 #define min(a,b) ((a)<(b)?(a):(b))
660 #define max(a,b) ((a)>(b)?(a):(b))
662 /* Install the string STR as the beginning of the string of echoing,
663 so that it serves as a prompt for the next character.
664 Also start echoing. */
670 int len
= strlen (str
);
672 if (len
> ECHOBUFSIZE
- 4)
673 len
= ECHOBUFSIZE
- 4;
674 bcopy (str
, current_kboard
->echobuf
, len
);
675 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
676 *current_kboard
->echoptr
= '\0';
678 current_kboard
->echo_after_prompt
= len
;
683 /* Add C to the echo string, if echoing is going on.
684 C can be a character, which is printed prettily ("M-C-x" and all that
685 jazz), or a symbol, whose name is printed. */
691 extern char *push_key_description ();
693 if (current_kboard
->immediate_echo
)
695 char *ptr
= current_kboard
->echoptr
;
697 if (ptr
!= current_kboard
->echobuf
)
700 /* If someone has passed us a composite event, use its head symbol. */
705 if (ptr
- current_kboard
->echobuf
706 > ECHOBUFSIZE
- KEY_DESCRIPTION_SIZE
)
709 ptr
= push_key_description (XINT (c
), ptr
);
711 else if (SYMBOLP (c
))
713 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
714 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
717 bcopy (name
->data
, ptr
, STRING_BYTES (name
));
718 ptr
+= STRING_BYTES (name
);
721 if (current_kboard
->echoptr
== current_kboard
->echobuf
724 strcpy (ptr
, " (Type ? for further options)");
729 current_kboard
->echoptr
= ptr
;
735 /* Temporarily add a dash to the end of the echo string if it's not
736 empty, so that it serves as a mini-prompt for the very next character. */
741 if (!current_kboard
->immediate_echo
742 && current_kboard
->echoptr
== current_kboard
->echobuf
)
744 /* Do nothing if we just printed a prompt. */
745 if (current_kboard
->echo_after_prompt
746 == current_kboard
->echoptr
- current_kboard
->echobuf
)
748 /* Do nothing if not echoing at all. */
749 if (current_kboard
->echoptr
== 0)
752 /* Put a dash at the end of the buffer temporarily,
753 but make it go away when the next character is added. */
754 current_kboard
->echoptr
[0] = '-';
755 current_kboard
->echoptr
[1] = 0;
760 /* Display the current echo string, and begin echoing if not already
766 if (!current_kboard
->immediate_echo
)
769 current_kboard
->immediate_echo
= 1;
771 for (i
= 0; i
< this_command_key_count
; i
++)
774 c
= XVECTOR (this_command_keys
)->contents
[i
];
775 if (! (EVENT_HAS_PARAMETERS (c
)
776 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
783 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
784 ! NILP (current_buffer
->enable_multibyte_characters
));
787 /* Record in what buffer we echoed, and from which kboard. */
788 echo_message_buffer
= echo_area_buffer
[0];
789 echo_kboard
= current_kboard
;
791 if (waiting_for_input
&& !NILP (Vquit_flag
))
792 quit_throw_to_read_char ();
795 /* Turn off echoing, for the start of a new command. */
800 current_kboard
->immediate_echo
= 0;
801 current_kboard
->echoptr
= current_kboard
->echobuf
;
802 current_kboard
->echo_after_prompt
= -1;
803 ok_to_echo_at_next_pause
= NULL
;
805 echo_message_buffer
= Qnil
;
808 /* Return the length of the current echo string. */
813 return current_kboard
->echoptr
- current_kboard
->echobuf
;
816 /* Truncate the current echo message to its first LEN chars.
817 This and echo_char get used by read_key_sequence when the user
818 switches frames while entering a key sequence. */
824 current_kboard
->echobuf
[len
] = '\0';
825 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
826 truncate_echo_area (len
);
830 /* Functions for manipulating this_command_keys. */
832 add_command_key (key
)
835 int size
= XVECTOR (this_command_keys
)->size
;
837 /* If reset-this-command-length was called recently, obey it now.
838 See the doc string of that function for an explanation of why. */
839 if (before_command_restore_flag
)
841 this_command_key_count
= before_command_key_count_1
;
842 if (this_command_key_count
< this_single_command_key_start
)
843 this_single_command_key_start
= this_command_key_count
;
844 echo_truncate (before_command_echo_length_1
);
845 before_command_restore_flag
= 0;
848 if (this_command_key_count
>= size
)
850 Lisp_Object new_keys
;
852 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
853 bcopy (XVECTOR (this_command_keys
)->contents
,
854 XVECTOR (new_keys
)->contents
,
855 size
* sizeof (Lisp_Object
));
857 this_command_keys
= new_keys
;
860 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
866 int count
= specpdl_ptr
- specpdl
;
869 if (command_loop_level
> 0)
871 specbind (Qstandard_output
, Qt
);
872 specbind (Qstandard_input
, Qt
);
875 #ifdef HAVE_X_WINDOWS
876 /* The command loop has started a busy-cursor timer, so we have to
877 cancel it here, otherwise it will fire because the recursive edit
878 can take some time. */
879 if (display_busy_cursor_p
)
880 cancel_busy_cursor ();
883 val
= command_loop ();
885 Fsignal (Qquit
, Qnil
);
886 /* Handle throw from read_minibuf when using minibuffer
887 while it's active but we're in another window. */
889 Fsignal (Qerror
, Fcons (val
, Qnil
));
891 return unbind_to (count
, Qnil
);
894 /* When an auto-save happens, record the "time", and don't do again soon. */
899 last_auto_save
= num_nonmacro_input_events
;
902 /* Make an auto save happen as soon as possible at command level. */
905 force_auto_save_soon ()
907 last_auto_save
= - auto_save_interval
- 1;
909 record_asynch_buffer_change ();
912 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
913 "Invoke the editor command loop recursively.\n\
914 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
915 that tells this function to return.\n\
916 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
917 This function is called by the editor initialization to begin editing.")
920 int count
= specpdl_ptr
- specpdl
;
922 command_loop_level
++;
923 update_mode_lines
= 1;
925 record_unwind_protect (recursive_edit_unwind
,
927 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
931 return unbind_to (count
, Qnil
);
935 recursive_edit_unwind (buffer
)
939 Fset_buffer (buffer
);
941 command_loop_level
--;
942 update_mode_lines
= 1;
950 #if 0 /* Theory: if there's anything in Vunread_command_events,
951 it will right away be read by read_key_sequence,
952 and then if we do switch KBOARDS, it will go into the side
953 queue then. So we don't need to do anything special here -- rms. */
954 if (CONSP (Vunread_command_events
))
956 current_kboard
->kbd_queue
957 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
958 current_kboard
->kbd_queue_has_data
= 1;
960 Vunread_command_events
= Qnil
;
966 /* Switch to the single-kboard state, making current_kboard
967 the only KBOARD from which further input is accepted. */
970 single_kboard_state ()
977 /* Maintain a stack of kboards, so other parts of Emacs
978 can switch temporarily to the kboard of a given frame
979 and then revert to the previous status. */
984 struct kboard_stack
*next
;
987 static struct kboard_stack
*kboard_stack
;
990 push_frame_kboard (f
)
994 struct kboard_stack
*p
995 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
997 p
->next
= kboard_stack
;
998 p
->kboard
= current_kboard
;
1001 current_kboard
= FRAME_KBOARD (f
);
1009 struct kboard_stack
*p
= kboard_stack
;
1010 current_kboard
= p
->kboard
;
1011 kboard_stack
= p
->next
;
1016 /* Handle errors that are not handled at inner levels
1017 by printing an error message and returning to the editor command loop. */
1023 Lisp_Object old_level
, old_length
;
1024 char macroerror
[50];
1026 if (!NILP (executing_macro
))
1028 if (executing_macro_iterations
== 1)
1029 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1031 sprintf (macroerror
, "After %d kbd macro iterations: ",
1032 executing_macro_iterations
);
1037 Vstandard_output
= Qt
;
1038 Vstandard_input
= Qt
;
1039 Vexecuting_macro
= Qnil
;
1040 executing_macro
= Qnil
;
1041 current_kboard
->Vprefix_arg
= Qnil
;
1042 current_kboard
->Vlast_prefix_arg
= Qnil
;
1045 /* Avoid unquittable loop if data contains a circular list. */
1046 old_level
= Vprint_level
;
1047 old_length
= Vprint_length
;
1048 XSETFASTINT (Vprint_level
, 10);
1049 XSETFASTINT (Vprint_length
, 10);
1050 cmd_error_internal (data
, macroerror
);
1051 Vprint_level
= old_level
;
1052 Vprint_length
= old_length
;
1056 Vinhibit_quit
= Qnil
;
1058 any_kboard_state ();
1061 return make_number (0);
1064 /* Take actions on handling an error. DATA is the data that describes
1067 CONTEXT is a C-string containing ASCII characters only which
1068 describes the context in which the error happened. If we need to
1069 generalize CONTEXT to allow multibyte characters, make it a Lisp
1073 cmd_error_internal (data
, context
)
1078 int kill_emacs_p
= 0;
1079 struct frame
*sf
= SELECTED_FRAME ();
1083 clear_message (1, 0);
1085 /* If the window system or terminal frame hasn't been initialized
1086 yet, or we're not interactive, it's best to dump this message out
1087 to stderr and exit. */
1088 if (!sf
->glyphs_initialized_p
1089 /* This is the case of the frame dumped with Emacs, when we're
1090 running under a window system. */
1091 || (!NILP (Vwindow_system
)
1092 && !inhibit_window_system
1093 && FRAME_TERMCAP_P (sf
))
1096 stream
= Qexternal_debugging_output
;
1107 write_string_1 (context
, -1, stream
);
1109 print_error_message (data
, stream
);
1111 /* If the window system or terminal frame hasn't been initialized
1112 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1116 Fkill_emacs (make_number (-1));
1120 Lisp_Object
command_loop_1 ();
1121 Lisp_Object
command_loop_2 ();
1122 Lisp_Object
top_level_1 ();
1124 /* Entry to editor-command-loop.
1125 This level has the catches for exiting/returning to editor command loop.
1126 It returns nil to exit recursive edit, t to abort it. */
1131 if (command_loop_level
> 0 || minibuf_level
> 0)
1134 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1135 executing_macro
= Qnil
;
1141 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1142 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1143 executing_macro
= Qnil
;
1145 /* End of file in -batch run causes exit here. */
1151 /* Here we catch errors in execution of commands within the
1152 editing loop, and reenter the editing loop.
1153 When there is an error, cmd_error runs and returns a non-nil
1154 value to us. A value of nil means that cmd_loop_1 itself
1155 returned due to end of file (or end of kbd macro). */
1160 register Lisp_Object val
;
1163 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1164 while (!NILP (val
));
1172 return Feval (Vtop_level
);
1178 /* On entry to the outer level, run the startup file */
1179 if (!NILP (Vtop_level
))
1180 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1181 else if (!NILP (Vpurify_flag
))
1182 message ("Bare impure Emacs (standard Lisp code not loaded)");
1184 message ("Bare Emacs (standard Lisp code not loaded)");
1188 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1189 "Exit all recursive editing levels.")
1192 #ifdef HAVE_X_WINDOWS
1193 if (display_busy_cursor_p
)
1194 cancel_busy_cursor ();
1196 Fthrow (Qtop_level
, Qnil
);
1199 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1200 "Exit from the innermost recursive edit or minibuffer.")
1203 if (command_loop_level
> 0 || minibuf_level
> 0)
1204 Fthrow (Qexit
, Qnil
);
1206 error ("No recursive edit is in progress");
1209 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1210 "Abort the command that requested this recursive edit or minibuffer input.")
1213 if (command_loop_level
> 0 || minibuf_level
> 0)
1216 error ("No recursive edit is in progress");
1219 /* This is the actual command reading loop,
1220 sans error-handling encapsulation. */
1222 Lisp_Object
Fcommand_execute ();
1223 static int read_key_sequence ();
1224 void safe_run_hooks ();
1225 static void adjust_point_for_property ();
1233 Lisp_Object keybuf
[30];
1237 struct buffer
*prev_buffer
;
1239 int was_locked
= single_kboard
;
1242 current_kboard
->Vprefix_arg
= Qnil
;
1243 current_kboard
->Vlast_prefix_arg
= Qnil
;
1244 Vdeactivate_mark
= Qnil
;
1245 waiting_for_input
= 0;
1249 this_command_key_count
= 0;
1250 this_single_command_key_start
= 0;
1252 /* Make sure this hook runs after commands that get errors and
1253 throw to top level. */
1254 /* Note that the value cell will never directly contain nil
1255 if the symbol is a local variable. */
1256 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1257 safe_run_hooks (Qpost_command_hook
);
1259 /* If displaying a message, resize the echo area window to fit
1260 that message's size exactly. */
1261 if (!NILP (echo_area_buffer
[0]))
1262 resize_echo_area_axactly ();
1264 if (!NILP (Vdeferred_action_list
))
1265 call0 (Vdeferred_action_function
);
1267 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1269 if (NILP (Vunread_command_events
)
1270 && NILP (Vunread_input_method_events
)
1271 && NILP (Vunread_post_input_method_events
)
1272 && NILP (Vexecuting_macro
)
1273 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1274 safe_run_hooks (Qpost_command_idle_hook
);
1277 /* Do this after running Vpost_command_hook, for consistency. */
1278 current_kboard
->Vlast_command
= Vthis_command
;
1279 current_kboard
->Vreal_last_command
= real_this_command
;
1283 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1286 /* Make sure the current window's buffer is selected. */
1287 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1288 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1290 /* Display any malloc warning that just came out. Use while because
1291 displaying one warning can cause another. */
1293 while (pending_malloc_warning
)
1294 display_malloc_warning ();
1298 Vdeactivate_mark
= Qnil
;
1300 /* If minibuffer on and echo area in use,
1301 wait 2 sec and redraw minibuffer. */
1304 && !NILP (echo_area_buffer
[0])
1305 && EQ (minibuf_window
, echo_area_window
))
1307 /* Bind inhibit-quit to t so that C-g gets read in
1308 rather than quitting back to the minibuffer. */
1309 int count
= specpdl_ptr
- specpdl
;
1310 specbind (Qinhibit_quit
, Qt
);
1312 Fsit_for (make_number (2), Qnil
, Qnil
);
1313 /* Clear the echo area. */
1315 safe_run_hooks (Qecho_area_clear_hook
);
1317 unbind_to (count
, Qnil
);
1319 /* If a C-g came in before, treat it as input now. */
1320 if (!NILP (Vquit_flag
))
1323 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1328 alloca (0); /* Cause a garbage collection now */
1329 /* Since we can free the most stuff here. */
1330 #endif /* C_ALLOCA */
1333 /* Select the frame that the last event came from. Usually,
1334 switch-frame events will take care of this, but if some lisp
1335 code swallows a switch-frame event, we'll fix things up here.
1336 Is this a good idea? */
1337 if (FRAMEP (internal_last_event_frame
)
1338 && !EQ (internal_last_event_frame
, selected_frame
))
1339 Fselect_frame (internal_last_event_frame
, Qnil
);
1341 /* If it has changed current-menubar from previous value,
1342 really recompute the menubar from the value. */
1343 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1344 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1345 call0 (Qrecompute_lucid_menubar
);
1347 before_command_key_count
= this_command_key_count
;
1348 before_command_echo_length
= echo_length ();
1350 Vthis_command
= Qnil
;
1351 real_this_command
= Qnil
;
1353 /* Read next key sequence; i gets its length. */
1354 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1357 /* A filter may have run while we were reading the input. */
1358 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1360 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1361 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1365 /* Now we have read a key sequence of length I,
1366 or else I is 0 and we found end of file. */
1368 if (i
== 0) /* End of file -- happens only in */
1369 return Qnil
; /* a kbd macro, at the end. */
1370 /* -1 means read_key_sequence got a menu that was rejected.
1371 Just loop around and read another command. */
1375 this_command_key_count
= 0;
1376 this_single_command_key_start
= 0;
1380 last_command_char
= keybuf
[i
- 1];
1382 /* If the previous command tried to force a specific window-start,
1383 forget about that, in case this command moves point far away
1384 from that position. But also throw away beg_unchanged and
1385 end_unchanged information in that case, so that redisplay will
1386 update the whole window properly. */
1387 if (!NILP (XWINDOW (selected_window
)->force_start
))
1390 XWINDOW (selected_window
)->force_start
= Qnil
;
1391 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1392 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1395 cmd
= read_key_sequence_cmd
;
1396 if (!NILP (Vexecuting_macro
))
1398 if (!NILP (Vquit_flag
))
1400 Vexecuting_macro
= Qt
;
1401 QUIT
; /* Make some noise. */
1402 /* Will return since macro now empty. */
1406 /* Do redisplay processing after this command except in special
1407 cases identified below. */
1408 prev_buffer
= current_buffer
;
1409 prev_modiff
= MODIFF
;
1410 last_point_position
= PT
;
1411 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1413 /* By default, we adjust point to a boundary of a region that
1414 has such a property that should be treated intangible
1415 (e.g. composition, display). But, some commands will set
1416 this variable differently. */
1417 Vdisable_point_adjustment
= Qnil
;
1419 /* Execute the command. */
1421 Vthis_command
= cmd
;
1422 real_this_command
= cmd
;
1423 /* Note that the value cell will never directly contain nil
1424 if the symbol is a local variable. */
1425 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1426 safe_run_hooks (Qpre_command_hook
);
1428 if (NILP (Vthis_command
))
1430 /* nil means key is undefined. */
1432 current_kboard
->defining_kbd_macro
= Qnil
;
1433 update_mode_lines
= 1;
1434 current_kboard
->Vprefix_arg
= Qnil
;
1438 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1440 /* In case we jump to directly_done. */
1441 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1443 /* Recognize some common commands in common situations and
1444 do them directly. */
1445 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1447 struct Lisp_Char_Table
*dp
1448 = window_display_table (XWINDOW (selected_window
));
1449 lose
= FETCH_CHAR (PT_BYTE
);
1452 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1453 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1454 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1455 && (lose
>= 0x20 && lose
< 0x7f)))
1456 : (lose
>= 0x20 && lose
< 0x7f))
1457 /* To extract the case of continuation on
1458 wide-column characters. */
1459 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1460 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1462 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1464 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1466 && !windows_or_buffers_changed
1467 && EQ (current_buffer
->selective_display
, Qnil
)
1468 && !detect_input_pending ()
1469 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1470 && NILP (Vexecuting_macro
))
1471 direct_output_forward_char (1);
1474 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1476 struct Lisp_Char_Table
*dp
1477 = window_display_table (XWINDOW (selected_window
));
1479 lose
= FETCH_CHAR (PT_BYTE
);
1481 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1482 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1483 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1484 && (lose
>= 0x20 && lose
< 0x7f)))
1485 : (lose
>= 0x20 && lose
< 0x7f))
1486 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1488 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1490 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1492 && !windows_or_buffers_changed
1493 && EQ (current_buffer
->selective_display
, Qnil
)
1494 && !detect_input_pending ()
1495 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1496 && NILP (Vexecuting_macro
))
1497 direct_output_forward_char (-1);
1500 else if (EQ (Vthis_command
, Qself_insert_command
)
1501 /* Try this optimization only on ascii keystrokes. */
1502 && INTEGERP (last_command_char
))
1504 unsigned int c
= XINT (last_command_char
);
1506 if (NILP (Vexecuting_macro
)
1507 && !EQ (minibuf_window
, selected_window
))
1509 if (!nonundocount
|| nonundocount
>= 20)
1517 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1519 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1521 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1523 || MODIFF
<= SAVE_MODIFF
1524 || windows_or_buffers_changed
1525 || !EQ (current_buffer
->selective_display
, Qnil
)
1526 || detect_input_pending ()
1527 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1528 || !NILP (Vexecuting_macro
));
1530 value
= internal_self_insert (c
, 0);
1535 /* VALUE == 1 when AFTER-CHANGE functions are
1536 installed which is the case most of the time
1537 because FONT-LOCK installs one. */
1538 if (!lose
&& !value
)
1539 direct_output_for_insert (c
);
1544 /* Here for a command that isn't executed directly */
1546 #ifdef HAVE_X_WINDOWS
1547 if (display_busy_cursor_p
)
1548 start_busy_cursor ();
1552 if (NILP (current_kboard
->Vprefix_arg
))
1554 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1556 #ifdef HAVE_X_WINDOWS
1557 if (display_busy_cursor_p
)
1558 cancel_busy_cursor ();
1562 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1564 /* Note that the value cell will never directly contain nil
1565 if the symbol is a local variable. */
1566 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1567 safe_run_hooks (Qpost_command_hook
);
1569 /* If displaying a message, resize the echo area window to fit
1570 that message's size exactly. */
1571 if (!NILP (echo_area_buffer
[0]))
1572 resize_echo_area_axactly ();
1574 if (!NILP (Vdeferred_action_list
))
1575 safe_run_hooks (Qdeferred_action_function
);
1577 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1579 if (NILP (Vunread_command_events
)
1580 && NILP (Vunread_input_method_events
)
1581 && NILP (Vunread_post_input_method_events
)
1582 && NILP (Vexecuting_macro
)
1583 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1584 safe_run_hooks (Qpost_command_idle_hook
);
1587 /* If there is a prefix argument,
1588 1) We don't want Vlast_command to be ``universal-argument''
1589 (that would be dumb), so don't set Vlast_command,
1590 2) we want to leave echoing on so that the prefix will be
1591 echoed as part of this key sequence, so don't call
1593 3) we want to leave this_command_key_count non-zero, so that
1594 read_char will realize that it is re-reading a character, and
1595 not echo it a second time.
1597 If the command didn't actually create a prefix arg,
1598 but is merely a frame event that is transparent to prefix args,
1599 then the above doesn't apply. */
1600 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1602 current_kboard
->Vlast_command
= Vthis_command
;
1603 current_kboard
->Vreal_last_command
= real_this_command
;
1605 this_command_key_count
= 0;
1606 this_single_command_key_start
= 0;
1609 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1611 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1613 current_buffer
->mark_active
= Qnil
;
1614 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1616 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1617 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1622 if (current_buffer
== prev_buffer
1623 && last_point_position
!= PT
1624 && NILP (Vdisable_point_adjustment
)
1625 && NILP (Vglobal_disable_point_adjustment
))
1626 adjust_point_for_property (last_point_position
);
1628 /* Install chars successfully executed in kbd macro. */
1630 if (!NILP (current_kboard
->defining_kbd_macro
)
1631 && NILP (current_kboard
->Vprefix_arg
))
1632 finalize_kbd_macro_chars ();
1636 any_kboard_state ();
1641 extern Lisp_Object Qcomposition
, Qdisplay
;
1643 /* Adjust point to a boundary of a region that has such a property
1644 that should be treated intangible. For the moment, we check
1645 `composition' and `display' property. LAST_PT is the last position
1649 adjust_point_for_property (last_pt
)
1654 int check_composition
= 1, check_display
= 1;
1656 while (check_composition
|| check_display
)
1658 if (check_composition
1659 && PT
> BEGV
&& PT
< ZV
1660 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1661 && COMPOSITION_VALID_P (start
, end
, val
)
1662 && start
< PT
&& end
> PT
1663 && (last_pt
<= start
|| last_pt
>= end
))
1671 check_composition
= 0;
1673 && PT
> BEGV
&& PT
< ZV
1674 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1675 && display_prop_intangible_p (val
)
1676 && start
< PT
&& end
> PT
1677 && (last_pt
<= start
|| last_pt
>= end
))
1683 check_composition
= 1;
1689 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1692 safe_run_hooks_1 (hook
)
1695 return call1 (Vrun_hooks
, Vinhibit_quit
);
1698 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1701 safe_run_hooks_error (data
)
1704 return Fset (Vinhibit_quit
, Qnil
);
1707 /* If we get an error while running the hook, cause the hook variable
1708 to be nil. Also inhibit quits, so that C-g won't cause the hook
1709 to mysteriously evaporate. */
1712 safe_run_hooks (hook
)
1715 int count
= specpdl_ptr
- specpdl
;
1716 specbind (Qinhibit_quit
, hook
);
1718 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1720 unbind_to (count
, Qnil
);
1724 /* Number of seconds between polling for input. This is a Lisp
1725 variable that can be bound. */
1729 /* Nonzero means polling for input is temporarily suppressed. */
1731 int poll_suppress_count
;
1733 /* Asynchronous timer for polling. */
1735 struct atimer
*poll_timer
;
1738 #ifdef POLL_FOR_INPUT
1740 /* Poll for input, so what we catch a C-g if it comes in. This
1741 function is called from x_make_frame_visible, see comment
1747 if (interrupt_input_blocked
== 0
1748 && !waiting_for_input
)
1749 read_avail_input (0);
1752 /* Timer callback function for poll_timer. TIMER is equal to
1756 poll_for_input (timer
)
1757 struct atimer
*timer
;
1759 if (poll_suppress_count
== 0)
1760 poll_for_input_1 ();
1763 #endif /* POLL_FOR_INPUT */
1765 /* Begin signals to poll for input, if they are appropriate.
1766 This function is called unconditionally from various places. */
1771 #ifdef POLL_FOR_INPUT
1772 if (read_socket_hook
&& !interrupt_input
)
1774 /* Turn alarm handling on unconditionally. It might have
1775 been turned off in process.c. */
1776 turn_on_atimers (1);
1778 /* If poll timer doesn't exist, are we need one with
1779 a different interval, start a new one. */
1780 if (poll_timer
== NULL
1781 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1783 EMACS_TIME interval
;
1786 cancel_atimer (poll_timer
);
1788 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1789 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1790 poll_for_input
, NULL
);
1793 /* Let the timer's callback function poll for input
1794 if this becomes zero. */
1795 --poll_suppress_count
;
1800 /* Nonzero if we are using polling to handle input asynchronously. */
1803 input_polling_used ()
1805 #ifdef POLL_FOR_INPUT
1806 return read_socket_hook
&& !interrupt_input
;
1812 /* Turn off polling. */
1817 #ifdef POLL_FOR_INPUT
1818 if (read_socket_hook
&& !interrupt_input
)
1819 ++poll_suppress_count
;
1823 /* Set the value of poll_suppress_count to COUNT
1824 and start or stop polling accordingly. */
1827 set_poll_suppress_count (count
)
1830 #ifdef POLL_FOR_INPUT
1831 if (count
== 0 && poll_suppress_count
!= 0)
1833 poll_suppress_count
= 1;
1836 else if (count
!= 0 && poll_suppress_count
== 0)
1840 poll_suppress_count
= count
;
1844 /* Bind polling_period to a value at least N.
1845 But don't decrease it. */
1848 bind_polling_period (n
)
1851 #ifdef POLL_FOR_INPUT
1852 int new = polling_period
;
1857 stop_other_atimers (poll_timer
);
1859 specbind (Qpolling_period
, make_number (new));
1860 /* Start a new alarm with the new period. */
1865 /* Apply the control modifier to CHARACTER. */
1871 /* Save the upper bits here. */
1872 int upper
= c
& ~0177;
1876 /* Everything in the columns containing the upper-case letters
1877 denotes a control character. */
1878 if (c
>= 0100 && c
< 0140)
1882 /* Set the shift modifier for a control char
1883 made from a shifted letter. But only for letters! */
1884 if (oc
>= 'A' && oc
<= 'Z')
1885 c
|= shift_modifier
;
1888 /* The lower-case letters denote control characters too. */
1889 else if (c
>= 'a' && c
<= 'z')
1892 /* Include the bits for control and shift
1893 only if the basic ASCII code can't indicate them. */
1897 /* Replace the high bits. */
1898 c
|= (upper
& ~ctrl_modifier
);
1903 /* Display help echo in the echo area.
1905 MSG a string means display that string, MSG nil means clear the
1906 help echo. If MSG is neither a string nor nil, it is evaluated
1909 OK_TO_IVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
1910 echo overwrites a keystroke echo currently displayed in the echo
1913 Note: this function may only be called with MSG being nil or
1914 a string from X code running asynchronously. */
1917 show_help_echo (msg
, ok_to_overwrite_keystroke_echo
)
1919 int ok_to_overwrite_keystroke_echo
;
1921 if (!NILP (msg
) && !STRINGP (msg
))
1923 msg
= eval_form (msg
);
1928 if (STRINGP (msg
) || NILP (msg
))
1930 if (!NILP (Vshow_help_function
))
1931 call1 (Vshow_help_function
, msg
);
1932 else if (/* Don't overwrite minibuffer contents. */
1933 !MINI_WINDOW_P (XWINDOW (selected_window
))
1934 /* Don't overwrite a keystroke echo. */
1935 && (NILP (echo_message_buffer
) || ok_to_overwrite_keystroke_echo
)
1936 /* Don't overwrite a prompt. */
1937 && !cursor_in_echo_area
)
1941 int count
= specpdl_ptr
- specpdl
;
1942 specbind (Qmessage_truncate_lines
, Qt
);
1943 message3_nolog (msg
, XSTRING (msg
)->size
, STRING_MULTIBYTE (msg
));
1944 unbind_to (count
, Qnil
);
1954 /* Input of single characters from keyboard */
1956 Lisp_Object
print_help ();
1957 static Lisp_Object
kbd_buffer_get_event ();
1958 static void record_char ();
1961 static jmp_buf wrong_kboard_jmpbuf
;
1964 /* read a character from the keyboard; call the redisplay if needed */
1965 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1966 -1 means do not do redisplay, but do do autosaving.
1969 /* The arguments MAPS and NMAPS are for menu prompting.
1970 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1972 PREV_EVENT is the previous input event, or nil if we are reading
1973 the first event of a key sequence (or not reading a key sequence).
1974 If PREV_EVENT is t, that is a "magic" value that says
1975 not to run input methods, but in other respects to act as if
1976 not reading a key sequence.
1978 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1979 if we used a mouse menu to read the input, or zero otherwise. If
1980 USED_MOUSE_MENU is null, we don't dereference it.
1982 Value is t if we showed a menu and the user rejected it. */
1985 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1989 Lisp_Object prev_event
;
1990 int *used_mouse_menu
;
1994 jmp_buf local_getcjmp
;
1996 int key_already_recorded
= 0;
1997 Lisp_Object tem
, save
;
1998 Lisp_Object previous_echo_area_message
;
1999 Lisp_Object also_record
;
2001 struct gcpro gcpro1
, gcpro2
;
2005 before_command_key_count
= this_command_key_count
;
2006 before_command_echo_length
= echo_length ();
2008 previous_echo_area_message
= Qnil
;
2010 GCPRO2 (c
, previous_echo_area_message
);
2015 if (CONSP (Vunread_post_input_method_events
))
2017 c
= XCAR (Vunread_post_input_method_events
);
2018 Vunread_post_input_method_events
2019 = XCDR (Vunread_post_input_method_events
);
2021 /* Undo what read_char_x_menu_prompt did when it unread
2022 additional keys returned by Fx_popup_menu. */
2024 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2032 if (unread_command_char
!= -1)
2034 XSETINT (c
, unread_command_char
);
2035 unread_command_char
= -1;
2041 if (CONSP (Vunread_command_events
))
2043 c
= XCAR (Vunread_command_events
);
2044 Vunread_command_events
= XCDR (Vunread_command_events
);
2046 /* Undo what read_char_x_menu_prompt did when it unread
2047 additional keys returned by Fx_popup_menu. */
2049 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2054 goto reread_for_input_method
;
2057 if (CONSP (Vunread_input_method_events
))
2059 c
= XCAR (Vunread_input_method_events
);
2060 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2062 /* Undo what read_char_x_menu_prompt did when it unread
2063 additional keys returned by Fx_popup_menu. */
2065 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2069 goto reread_for_input_method
;
2072 /* If there is no function key translated before
2073 reset-this-command-lengths takes effect, forget about it. */
2074 before_command_restore_flag
= 0;
2076 if (!NILP (Vexecuting_macro
))
2078 /* We set this to Qmacro; since that's not a frame, nobody will
2079 try to switch frames on us, and the selected window will
2082 Since this event came from a macro, it would be misleading to
2083 leave internal_last_event_frame set to wherever the last
2084 real event came from. Normally, a switch-frame event selects
2085 internal_last_event_frame after each command is read, but
2086 events read from a macro should never cause a new frame to be
2088 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2090 /* Exit the macro if we are at the end.
2091 Also, some things replace the macro with t
2092 to force an early exit. */
2093 if (EQ (Vexecuting_macro
, Qt
)
2094 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2100 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2101 if (STRINGP (Vexecuting_macro
)
2102 && (XINT (c
) & 0x80))
2103 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2105 executing_macro_index
++;
2110 if (!NILP (unread_switch_frame
))
2112 c
= unread_switch_frame
;
2113 unread_switch_frame
= Qnil
;
2115 /* This event should make it into this_command_keys, and get echoed
2116 again, so we do not set `reread'. */
2120 /* if redisplay was requested */
2121 if (commandflag
>= 0)
2123 /* If there is pending input, process any events which are not
2124 user-visible, such as X selection_request events. */
2126 || detect_input_pending_run_timers (0))
2127 swallow_events (0); /* may clear input_pending */
2129 /* Redisplay if no pending input. */
2130 while (!input_pending
)
2135 /* Normal case: no input arrived during redisplay. */
2138 /* Input arrived and pre-empted redisplay.
2139 Process any events which are not user-visible. */
2141 /* If that cleared input_pending, try again to redisplay. */
2145 /* Message turns off echoing unless more keystrokes turn it on again.
2147 The code in 20.x for the condition was
2149 1. echo_area_glyphs && *echo_area_glyphs
2150 2. && echo_area_glyphs != current_kboard->echobuf
2151 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2153 (1) means there's a current message displayed
2155 (2) means it's not the message from echoing from the current
2158 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2159 is set to a non-null value. This is done in read_char and it is
2160 set to echo_area_glyphs after a call to echo_char. That means
2161 ok_to_echo_at_next_pause is either null or
2162 current_kboard->echobuf with the appropriate current_kboard at
2165 So, condition (3) means in clear text ok_to_echo_at_next_pause
2166 must be either null, or the current message isn't from echoing at
2167 all, or it's from echoing from a different kboard than the
2170 if (/* There currently something in the echo area */
2171 !NILP (echo_area_buffer
[0])
2172 && (/* And it's either not from echoing. */
2173 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2174 /* Or it's an echo from a different kboard. */
2175 || echo_kboard
!= current_kboard
2176 /* Or we explicitly allow overwriting whatever there is. */
2177 || ok_to_echo_at_next_pause
== NULL
))
2182 /* Try reading a character via menu prompting in the minibuf.
2183 Try this before the sit-for, because the sit-for
2184 would do the wrong thing if we are supposed to do
2185 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2186 after a mouse event so don't try a minibuf menu. */
2188 if (nmaps
> 0 && INTERACTIVE
2189 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2190 /* Don't bring up a menu if we already have another event. */
2191 && NILP (Vunread_command_events
)
2192 && unread_command_char
< 0
2193 && !detect_input_pending_run_timers (0))
2195 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2198 key_already_recorded
= 1;
2203 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2204 We will do that below, temporarily for short sections of code,
2205 when appropriate. local_getcjmp must be in effect
2206 around any call to sit_for or kbd_buffer_get_event;
2207 it *must not* be in effect when we call redisplay. */
2209 if (_setjmp (local_getcjmp
))
2211 XSETINT (c
, quit_char
);
2212 internal_last_event_frame
= selected_frame
;
2213 Vlast_event_frame
= internal_last_event_frame
;
2214 /* If we report the quit char as an event,
2215 don't do so more than once. */
2216 if (!NILP (Vinhibit_quit
))
2221 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2222 if (kb
!= current_kboard
)
2224 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2225 /* We shouldn't get here if we were in single-kboard mode! */
2228 while (CONSP (*tailp
))
2229 tailp
= &XCDR (*tailp
);
2232 *tailp
= Fcons (c
, Qnil
);
2233 kb
->kbd_queue_has_data
= 1;
2234 current_kboard
= kb
;
2235 /* This is going to exit from read_char
2236 so we had better get rid of this frame's stuff. */
2238 longjmp (wrong_kboard_jmpbuf
, 1);
2245 timer_start_idle ();
2247 /* If in middle of key sequence and minibuffer not active,
2248 start echoing if enough time elapses. */
2250 if (minibuf_level
== 0
2251 && !current_kboard
->immediate_echo
2252 && this_command_key_count
> 0
2254 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2255 && NILP (Fzerop (Vecho_keystrokes
))
2256 && (/* No message. */
2257 NILP (echo_area_buffer
[0])
2258 /* Or empty message. */
2259 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2260 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2261 /* Or already echoing from same kboard. */
2262 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2263 /* Or not echoing before and echoing allowed. */
2264 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2268 /* After a mouse event, start echoing right away.
2269 This is because we are probably about to display a menu,
2270 and we don't want to delay before doing so. */
2271 if (EVENT_HAS_PARAMETERS (prev_event
))
2276 double duration
= extract_float (Vecho_keystrokes
);
2277 sec
= (int) duration
;
2278 usec
= (duration
- sec
) * 1000000;
2279 save_getcjmp (save_jump
);
2280 restore_getcjmp (local_getcjmp
);
2281 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2282 restore_getcjmp (save_jump
);
2284 && ! CONSP (Vunread_command_events
))
2289 /* Maybe auto save due to number of keystrokes. */
2291 if (commandflag
!= 0
2292 && auto_save_interval
> 0
2293 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2294 && !detect_input_pending_run_timers (0))
2296 Fdo_auto_save (Qnil
, Qnil
);
2297 /* Hooks can actually change some buffers in auto save. */
2301 /* Try reading using an X menu.
2302 This is never confused with reading using the minibuf
2303 because the recursive call of read_char in read_char_minibuf_menu_prompt
2304 does not pass on any keymaps. */
2306 if (nmaps
> 0 && INTERACTIVE
2307 && !NILP (prev_event
)
2308 && EVENT_HAS_PARAMETERS (prev_event
)
2309 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2310 && !EQ (XCAR (prev_event
), Qtool_bar
)
2311 /* Don't bring up a menu if we already have another event. */
2312 && NILP (Vunread_command_events
)
2313 && unread_command_char
< 0)
2315 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2317 /* Now that we have read an event, Emacs is not idle. */
2323 /* Maybe autosave and/or garbage collect due to idleness. */
2325 if (INTERACTIVE
&& NILP (c
))
2327 int delay_level
, buffer_size
;
2329 /* Slow down auto saves logarithmically in size of current buffer,
2330 and garbage collect while we're at it. */
2331 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2332 last_non_minibuf_size
= Z
- BEG
;
2333 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2335 while (buffer_size
> 64)
2336 delay_level
++, buffer_size
-= buffer_size
>> 2;
2337 if (delay_level
< 4) delay_level
= 4;
2338 /* delay_level is 4 for files under around 50k, 7 at 100k,
2339 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2341 /* Auto save if enough time goes by without input. */
2342 if (commandflag
!= 0
2343 && num_nonmacro_input_events
> last_auto_save
2344 && INTEGERP (Vauto_save_timeout
)
2345 && XINT (Vauto_save_timeout
) > 0)
2349 save_getcjmp (save_jump
);
2350 restore_getcjmp (local_getcjmp
);
2351 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2353 restore_getcjmp (save_jump
);
2356 && ! CONSP (Vunread_command_events
))
2358 Fdo_auto_save (Qnil
, Qnil
);
2360 /* If we have auto-saved and there is still no input
2361 available, garbage collect if there has been enough
2362 consing going on to make it worthwhile. */
2363 if (!detect_input_pending_run_timers (0)
2364 && consing_since_gc
> gc_cons_threshold
/ 2)
2365 Fgarbage_collect ();
2372 /* If this has become non-nil here, it has been set by a timer
2373 or sentinel or filter. */
2374 if (CONSP (Vunread_command_events
))
2376 c
= XCAR (Vunread_command_events
);
2377 Vunread_command_events
= XCDR (Vunread_command_events
);
2380 /* Read something from current KBOARD's side queue, if possible. */
2384 if (current_kboard
->kbd_queue_has_data
)
2386 if (!CONSP (current_kboard
->kbd_queue
))
2388 c
= XCAR (current_kboard
->kbd_queue
);
2389 current_kboard
->kbd_queue
2390 = XCDR (current_kboard
->kbd_queue
);
2391 if (NILP (current_kboard
->kbd_queue
))
2392 current_kboard
->kbd_queue_has_data
= 0;
2393 input_pending
= readable_events (0);
2394 if (EVENT_HAS_PARAMETERS (c
)
2395 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2396 internal_last_event_frame
= XCAR (XCDR (c
));
2397 Vlast_event_frame
= internal_last_event_frame
;
2402 /* If current_kboard's side queue is empty check the other kboards.
2403 If one of them has data that we have not yet seen here,
2404 switch to it and process the data waiting for it.
2406 Note: if the events queued up for another kboard
2407 have already been seen here, and therefore are not a complete command,
2408 the kbd_queue_has_data field is 0, so we skip that kboard here.
2409 That's to avoid an infinite loop switching between kboards here. */
2410 if (NILP (c
) && !single_kboard
)
2413 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2414 if (kb
->kbd_queue_has_data
)
2416 current_kboard
= kb
;
2417 /* This is going to exit from read_char
2418 so we had better get rid of this frame's stuff. */
2420 longjmp (wrong_kboard_jmpbuf
, 1);
2429 /* Finally, we read from the main queue,
2430 and if that gives us something we can't use yet, we put it on the
2431 appropriate side queue and try again. */
2437 /* Actually read a character, waiting if necessary. */
2438 save_getcjmp (save_jump
);
2439 restore_getcjmp (local_getcjmp
);
2440 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2441 restore_getcjmp (save_jump
);
2444 if (! NILP (c
) && (kb
!= current_kboard
))
2446 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2447 while (CONSP (*tailp
))
2448 tailp
= &XCDR (*tailp
);
2451 *tailp
= Fcons (c
, Qnil
);
2452 kb
->kbd_queue_has_data
= 1;
2456 current_kboard
= kb
;
2457 /* This is going to exit from read_char
2458 so we had better get rid of this frame's stuff. */
2460 longjmp (wrong_kboard_jmpbuf
, 1);
2465 /* Terminate Emacs in batch mode if at eof. */
2466 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2467 Fkill_emacs (make_number (1));
2471 /* Add in any extra modifiers, where appropriate. */
2472 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2473 || ((extra_keyboard_modifiers
& 0177) < ' '
2474 && (extra_keyboard_modifiers
& 0177) != 0))
2475 XSETINT (c
, make_ctrl_char (XINT (c
)));
2477 /* Transfer any other modifier bits directly from
2478 extra_keyboard_modifiers to c. Ignore the actual character code
2479 in the low 16 bits of extra_keyboard_modifiers. */
2480 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2491 if (commandflag
>= 0
2492 && !input_pending
&& !detect_input_pending_run_timers (0))
2500 /* Buffer switch events are only for internal wakeups
2501 so don't show them to the user.
2502 Also, don't record a key if we already did. */
2503 if (BUFFERP (c
) || key_already_recorded
)
2506 /* Process special events within read_char
2507 and loop around to read another event. */
2510 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2516 int was_locked
= single_kboard
;
2518 last_input_char
= c
;
2519 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2521 /* Resume allowing input from any kboard, if that was true before. */
2523 any_kboard_state ();
2528 /* Handle things that only apply to characters. */
2531 /* If kbd_buffer_get_event gave us an EOF, return that. */
2535 if ((STRINGP (Vkeyboard_translate_table
)
2536 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2537 || (VECTORP (Vkeyboard_translate_table
)
2538 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2539 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2540 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2543 d
= Faref (Vkeyboard_translate_table
, c
);
2544 /* nil in keyboard-translate-table means no translation. */
2550 /* If this event is a mouse click in the menu bar,
2551 return just menu-bar for now. Modify the mouse click event
2552 so we won't do this twice, then queue it up. */
2553 if (EVENT_HAS_PARAMETERS (c
)
2555 && CONSP (EVENT_START (c
))
2556 && CONSP (XCDR (EVENT_START (c
))))
2560 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2561 /* Handle menu-bar events:
2562 insert the dummy prefix event `menu-bar'. */
2563 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2565 /* Change menu-bar to (menu-bar) as the event "position". */
2566 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2569 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2574 /* Store these characters into recent_keys, the dribble file if any,
2575 and the keyboard macro being defined, if any. */
2577 if (! NILP (also_record
))
2578 record_char (also_record
);
2580 /* Wipe the echo area.
2581 But first, if we are about to use an input method,
2582 save the echo area contents for it to refer to. */
2584 && ! NILP (Vinput_method_function
)
2585 && (unsigned) XINT (c
) >= ' '
2586 && (unsigned) XINT (c
) != 127
2587 && (unsigned) XINT (c
) < 256)
2589 previous_echo_area_message
= Fcurrent_message ();
2590 Vinput_method_previous_message
= previous_echo_area_message
;
2593 /* Now wipe the echo area, except for help events which do their
2594 own stuff with the echo area. */
2595 if (!CONSP (c
) || !(EQ (Qhelp_echo
, XCAR (c
))))
2597 if (!NILP (echo_area_buffer
[0]))
2598 safe_run_hooks (Qecho_area_clear_hook
);
2599 clear_message (1, 0);
2602 reread_for_input_method
:
2604 /* Pass this to the input method, if appropriate. */
2606 && ! NILP (Vinput_method_function
)
2607 /* Don't run the input method within a key sequence,
2608 after the first event of the key sequence. */
2609 && NILP (prev_event
)
2610 && (unsigned) XINT (c
) >= ' '
2611 && (unsigned) XINT (c
) != 127
2612 && (unsigned) XINT (c
) < 256)
2616 struct gcpro gcpro1
;
2617 int count
= specpdl_ptr
- specpdl
;
2619 /* Save the echo status. */
2620 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2621 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2622 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2624 if (before_command_restore_flag
)
2626 this_command_key_count
= before_command_key_count_1
;
2627 if (this_command_key_count
< this_single_command_key_start
)
2628 this_single_command_key_start
= this_command_key_count
;
2629 echo_truncate (before_command_echo_length_1
);
2630 before_command_restore_flag
= 0;
2633 /* Save the this_command_keys status. */
2634 key_count
= this_command_key_count
;
2637 keys
= Fcopy_sequence (this_command_keys
);
2642 /* Clear out this_command_keys. */
2643 this_command_key_count
= 0;
2645 /* Now wipe the echo area. */
2646 if (!NILP (echo_area_buffer
[0]))
2647 safe_run_hooks (Qecho_area_clear_hook
);
2648 clear_message (1, 0);
2651 /* If we are not reading a key sequence,
2652 never use the echo area. */
2655 specbind (Qinput_method_use_echo_area
, Qt
);
2658 /* Call the input method. */
2659 tem
= call1 (Vinput_method_function
, c
);
2661 tem
= unbind_to (count
, tem
);
2663 /* Restore the saved echoing state
2664 and this_command_keys state. */
2665 this_command_key_count
= key_count
;
2667 this_command_keys
= keys
;
2670 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2671 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2672 if (saved_immediate_echo
)
2677 /* The input method can return no events. */
2680 /* Bring back the previous message, if any. */
2681 if (! NILP (previous_echo_area_message
))
2682 message_with_string ("%s", previous_echo_area_message
, 0);
2685 /* It returned one event or more. */
2687 Vunread_post_input_method_events
2688 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2693 /* Display help if not echoing. */
2694 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2696 show_help_echo (XCDR (XCDR (c
)), 0);
2700 if (this_command_key_count
== 0 || ! reread
)
2702 before_command_key_count
= this_command_key_count
;
2703 before_command_echo_length
= echo_length ();
2705 /* Don't echo mouse motion events. */
2706 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2707 && NILP (Fzerop (Vecho_keystrokes
))
2708 && ! (EVENT_HAS_PARAMETERS (c
)
2709 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2712 if (! NILP (also_record
))
2713 echo_char (also_record
);
2714 /* Once we reread a character, echoing can happen
2715 the next time we pause to read a new one. */
2716 ok_to_echo_at_next_pause
= current_kboard
;
2719 /* Record this character as part of the current key. */
2720 add_command_key (c
);
2721 if (! NILP (also_record
))
2722 add_command_key (also_record
);
2725 last_input_char
= c
;
2728 /* Process the help character specially if enabled */
2729 if (!NILP (Vhelp_form
) && help_char_p (c
))
2732 count
= specpdl_ptr
- specpdl
;
2734 record_unwind_protect (Fset_window_configuration
,
2735 Fcurrent_window_configuration (Qnil
));
2737 tem0
= Feval (Vhelp_form
);
2739 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2743 c
= read_char (0, 0, 0, Qnil
, 0);
2744 while (BUFFERP (c
));
2745 /* Remove the help from the frame */
2746 unbind_to (count
, Qnil
);
2749 if (EQ (c
, make_number (040)))
2753 c
= read_char (0, 0, 0, Qnil
, 0);
2754 while (BUFFERP (c
));
2761 /* Record a key that came from a mouse menu.
2762 Record it for echoing, for this-command-keys, and so on. */
2768 /* Wipe the echo area. */
2769 clear_message (1, 0);
2773 before_command_key_count
= this_command_key_count
;
2774 before_command_echo_length
= echo_length ();
2776 /* Don't echo mouse motion events. */
2777 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2778 && NILP (Fzerop (Vecho_keystrokes
)))
2782 /* Once we reread a character, echoing can happen
2783 the next time we pause to read a new one. */
2784 ok_to_echo_at_next_pause
= 0;
2787 /* Record this character as part of the current key. */
2788 add_command_key (c
);
2790 /* Re-reading in the middle of a command */
2791 last_input_char
= c
;
2795 /* Return 1 if should recognize C as "the help character". */
2803 if (EQ (c
, Vhelp_char
))
2805 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
2806 if (EQ (c
, XCAR (tail
)))
2811 /* Record the input event C in various ways. */
2818 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2819 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2820 recent_keys_index
= 0;
2822 /* Write c to the dribble file. If c is a lispy event, write
2823 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2824 If you, dear reader, have a better idea, you've got the source. :-) */
2829 if (XUINT (c
) < 0x100)
2830 putc (XINT (c
), dribble
);
2832 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2836 Lisp_Object dribblee
;
2838 /* If it's a structured event, take the event header. */
2839 dribblee
= EVENT_HEAD (c
);
2841 if (SYMBOLP (dribblee
))
2843 putc ('<', dribble
);
2844 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2845 STRING_BYTES (XSYMBOL (dribblee
)->name
),
2847 putc ('>', dribble
);
2854 store_kbd_macro_char (c
);
2856 num_nonmacro_input_events
++;
2863 struct buffer
*old
= current_buffer
;
2864 Fprinc (object
, Qnil
);
2865 set_buffer_internal (XBUFFER (Vstandard_output
));
2866 call0 (intern ("help-mode"));
2867 set_buffer_internal (old
);
2871 /* Copy out or in the info on where C-g should throw to.
2872 This is used when running Lisp code from within get_char,
2873 in case get_char is called recursively.
2874 See read_process_output. */
2880 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2884 restore_getcjmp (temp
)
2887 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2892 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2893 of this function. */
2896 tracking_off (old_value
)
2897 Lisp_Object old_value
;
2899 do_mouse_tracking
= old_value
;
2900 if (NILP (old_value
))
2902 /* Redisplay may have been preempted because there was input
2903 available, and it assumes it will be called again after the
2904 input has been processed. If the only input available was
2905 the sort that we have just disabled, then we need to call
2907 if (!readable_events (1))
2909 redisplay_preserve_echo_area ();
2910 get_input_pending (&input_pending
, 1);
2916 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2917 "Evaluate BODY with mouse movement events enabled.\n\
2918 Within a `track-mouse' form, mouse motion generates input events that\n\
2919 you can read with `read-event'.\n\
2920 Normally, mouse motion is ignored.")
2924 int count
= specpdl_ptr
- specpdl
;
2927 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2929 do_mouse_tracking
= Qt
;
2931 val
= Fprogn (args
);
2932 return unbind_to (count
, val
);
2935 /* If mouse has moved on some frame, return one of those frames.
2936 Return 0 otherwise. */
2941 Lisp_Object tail
, frame
;
2943 FOR_EACH_FRAME (tail
, frame
)
2945 if (XFRAME (frame
)->mouse_moved
)
2946 return XFRAME (frame
);
2952 #endif /* HAVE_MOUSE */
2954 /* Low level keyboard/mouse input.
2955 kbd_buffer_store_event places events in kbd_buffer, and
2956 kbd_buffer_get_event retrieves them. */
2958 /* Return true iff there are any events in the queue that read-char
2959 would return. If this returns false, a read-char would block. */
2961 readable_events (do_timers_now
)
2965 timer_check (do_timers_now
);
2967 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2970 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2975 if (current_kboard
->kbd_queue_has_data
)
2981 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2982 if (kb
->kbd_queue_has_data
)
2988 /* Set this for debugging, to have a way to get out */
2993 event_to_kboard (event
)
2994 struct input_event
*event
;
2997 frame
= event
->frame_or_window
;
2999 frame
= XCAR (frame
);
3000 else if (WINDOWP (frame
))
3001 frame
= WINDOW_FRAME (XWINDOW (frame
));
3003 /* There are still some events that don't set this field.
3004 For now, just ignore the problem.
3005 Also ignore dead frames here. */
3006 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3009 return FRAME_KBOARD (XFRAME (frame
));
3013 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3016 kbd_buffer_store_event (event
)
3017 register struct input_event
*event
;
3019 if (event
->kind
== no_event
)
3022 if (event
->kind
== ascii_keystroke
)
3024 register int c
= event
->code
& 0377;
3026 if (event
->modifiers
& ctrl_modifier
)
3027 c
= make_ctrl_char (c
);
3029 c
|= (event
->modifiers
3030 & (meta_modifier
| alt_modifier
3031 | hyper_modifier
| super_modifier
));
3035 extern SIGTYPE
interrupt_signal ();
3038 struct input_event
*sp
;
3041 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3042 kb
!= current_kboard
))
3045 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3046 Fcons (make_number (c
), Qnil
));
3047 kb
->kbd_queue_has_data
= 1;
3048 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3050 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3053 if (event_to_kboard (sp
) == kb
)
3055 sp
->kind
= no_event
;
3056 sp
->frame_or_window
= Qnil
;
3064 /* If this results in a quit_char being returned to Emacs as
3065 input, set Vlast_event_frame properly. If this doesn't
3066 get returned to Emacs as an event, the next event read
3067 will set Vlast_event_frame again, so this is safe to do. */
3071 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3073 focus
= event
->frame_or_window
;
3074 internal_last_event_frame
= focus
;
3075 Vlast_event_frame
= focus
;
3078 last_event_timestamp
= event
->timestamp
;
3079 interrupt_signal ();
3083 if (c
&& c
== stop_character
)
3089 /* Don't insert two buffer_switch_event's in a row.
3090 Just ignore the second one. */
3091 else if (event
->kind
== buffer_switch_event
3092 && kbd_fetch_ptr
!= kbd_store_ptr
3093 && kbd_store_ptr
->kind
== buffer_switch_event
)
3096 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3097 kbd_store_ptr
= kbd_buffer
;
3099 /* Don't let the very last slot in the buffer become full,
3100 since that would make the two pointers equal,
3101 and that is indistinguishable from an empty buffer.
3102 Discard the event if it would fill the last slot. */
3103 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3107 #if 0 /* The selection_request_event case looks bogus, and it's error
3108 prone to assign individual members for other events, in case
3109 the input_event structure is changed. --2000-07-13, gerd. */
3110 struct input_event
*sp
= kbd_store_ptr
;
3111 sp
->kind
= event
->kind
;
3112 if (event
->kind
== selection_request_event
)
3114 /* We must not use the ordinary copying code for this case,
3115 since `part' is an enum and copying it might not copy enough
3117 bcopy (event
, (char *) sp
, sizeof (*event
));
3122 sp
->code
= event
->code
;
3123 sp
->part
= event
->part
;
3124 sp
->frame_or_window
= event
->frame_or_window
;
3125 sp
->arg
= event
->arg
;
3126 sp
->modifiers
= event
->modifiers
;
3129 sp
->timestamp
= event
->timestamp
;
3132 *kbd_store_ptr
= *event
;
3135 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3136 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3137 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3142 /* Discard any mouse events in the event buffer by setting them to
3145 discard_mouse_events ()
3147 struct input_event
*sp
;
3148 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3150 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3153 if (sp
->kind
== mouse_click
3155 || sp
->kind
== w32_scroll_bar_click
3157 || sp
->kind
== scroll_bar_click
)
3159 sp
->kind
= no_event
;
3164 /* Read one event from the event buffer, waiting if necessary.
3165 The value is a Lisp object representing the event.
3166 The value is nil for an event that should be ignored,
3167 or that was handled here.
3168 We always read and discard one event. */
3171 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3173 int *used_mouse_menu
;
3182 *kbp
= current_kboard
;
3186 /* Wait until there is input available. */
3189 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3192 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3196 /* If the quit flag is set, then read_char will return
3197 quit_char, so that counts as "available input." */
3198 if (!NILP (Vquit_flag
))
3199 quit_throw_to_read_char ();
3201 /* One way or another, wait until input is available; then, if
3202 interrupt handlers have not read it, read it now. */
3205 wait_for_kbd_input ();
3207 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3211 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3214 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3218 Lisp_Object minus_one
;
3220 XSETINT (minus_one
, -1);
3221 wait_reading_process_input (0, 0, minus_one
, 1);
3223 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3224 /* Pass 1 for EXPECT since we just waited to have input. */
3225 read_avail_input (1);
3227 #endif /* not VMS */
3230 if (CONSP (Vunread_command_events
))
3233 first
= XCAR (Vunread_command_events
);
3234 Vunread_command_events
= XCDR (Vunread_command_events
);
3235 *kbp
= current_kboard
;
3239 /* At this point, we know that there is a readable event available
3240 somewhere. If the event queue is empty, then there must be a
3241 mouse movement enabled and available. */
3242 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3244 struct input_event
*event
;
3246 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3250 last_event_timestamp
= event
->timestamp
;
3253 *kbp
= event_to_kboard (event
);
3255 *kbp
= current_kboard
; /* Better than returning null ptr? */
3257 *kbp
= &the_only_kboard
;
3262 /* These two kinds of events get special handling
3263 and don't actually appear to the command loop.
3264 We return nil for them. */
3265 if (event
->kind
== selection_request_event
)
3268 struct input_event copy
;
3270 /* Remove it from the buffer before processing it,
3271 since otherwise swallow_events will see it
3272 and process it again. */
3274 kbd_fetch_ptr
= event
+ 1;
3275 input_pending
= readable_events (0);
3276 x_handle_selection_request (©
);
3278 /* We're getting selection request events, but we don't have
3284 else if (event
->kind
== selection_clear_event
)
3287 struct input_event copy
;
3289 /* Remove it from the buffer before processing it. */
3291 kbd_fetch_ptr
= event
+ 1;
3292 input_pending
= readable_events (0);
3293 x_handle_selection_clear (©
);
3295 /* We're getting selection request events, but we don't have
3300 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3301 else if (event
->kind
== delete_window_event
)
3303 /* Make an event (delete-frame (FRAME)). */
3304 obj
= Fcons (event
->frame_or_window
, Qnil
);
3305 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3306 kbd_fetch_ptr
= event
+ 1;
3308 else if (event
->kind
== iconify_event
)
3310 /* Make an event (iconify-frame (FRAME)). */
3311 obj
= Fcons (event
->frame_or_window
, Qnil
);
3312 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3313 kbd_fetch_ptr
= event
+ 1;
3315 else if (event
->kind
== deiconify_event
)
3317 /* Make an event (make-frame-visible (FRAME)). */
3318 obj
= Fcons (event
->frame_or_window
, Qnil
);
3319 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3320 kbd_fetch_ptr
= event
+ 1;
3323 else if (event
->kind
== buffer_switch_event
)
3325 /* The value doesn't matter here; only the type is tested. */
3326 XSETBUFFER (obj
, current_buffer
);
3327 kbd_fetch_ptr
= event
+ 1;
3329 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3330 else if (event
->kind
== menu_bar_activate_event
)
3332 kbd_fetch_ptr
= event
+ 1;
3333 input_pending
= readable_events (0);
3334 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3335 x_activate_menubar (XFRAME (event
->frame_or_window
));
3339 else if (event
->kind
== language_change_event
)
3341 /* Make an event (language-change (FRAME CHARSET LCID)). */
3342 obj
= Fcons (event
->modifiers
, Qnil
);
3343 obj
= Fcons (event
->code
, Qnil
);
3344 obj
= Fcons (event
->frame_or_window
, obj
);
3345 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3346 kbd_fetch_ptr
= event
+ 1;
3349 /* Just discard these, by returning nil.
3350 With MULTI_KBOARD, these events are used as placeholders
3351 when we need to randomly delete events from the queue.
3352 (They shouldn't otherwise be found in the buffer,
3353 but on some machines it appears they do show up
3354 even without MULTI_KBOARD.) */
3355 /* On Windows NT/9X, no_event is used to delete extraneous
3356 mouse events during a popup-menu call. */
3357 else if (event
->kind
== no_event
)
3358 kbd_fetch_ptr
= event
+ 1;
3359 else if (event
->kind
== HELP_EVENT
)
3361 /* Event->frame_or_window is a frame, event->arg is the
3363 obj
= Fcons (Qhelp_echo
,
3364 Fcons (event
->frame_or_window
,
3366 kbd_fetch_ptr
= event
+ 1;
3368 else if (event
->kind
== FOCUS_IN_EVENT
)
3370 /* Notification of a FocusIn event. The frame receiving the
3371 focus is in event->frame_or_window. Generate a
3372 switch-frame event if necessary. */
3373 Lisp_Object frame
, focus
;
3375 frame
= event
->frame_or_window
;
3376 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3380 if (!EQ (frame
, internal_last_event_frame
)
3381 && !EQ (frame
, selected_frame
))
3382 obj
= make_lispy_switch_frame (frame
);
3383 internal_last_event_frame
= frame
;
3384 kbd_fetch_ptr
= event
+ 1;
3388 /* If this event is on a different frame, return a switch-frame this
3389 time, and leave the event in the queue for next time. */
3393 frame
= event
->frame_or_window
;
3395 frame
= XCAR (frame
);
3396 else if (WINDOWP (frame
))
3397 frame
= WINDOW_FRAME (XWINDOW (frame
));
3399 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3403 if (! EQ (frame
, internal_last_event_frame
)
3404 && !EQ (frame
, selected_frame
))
3405 obj
= make_lispy_switch_frame (frame
);
3406 internal_last_event_frame
= frame
;
3408 /* If we didn't decide to make a switch-frame event, go ahead
3409 and build a real event from the queue entry. */
3415 obj
= make_lispy_event (event
);
3417 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3418 /* If this was a menu selection, then set the flag to inhibit
3419 writing to last_nonmenu_event. Don't do this if the event
3420 we're returning is (menu-bar), though; that indicates the
3421 beginning of the menu sequence, and we might as well leave
3422 that as the `event with parameters' for this selection. */
3424 && !EQ (event
->frame_or_window
, event
->arg
)
3425 && (event
->kind
== MENU_BAR_EVENT
3426 || event
->kind
== TOOL_BAR_EVENT
))
3427 *used_mouse_menu
= 1;
3430 /* Wipe out this event, to catch bugs. */
3431 event
->kind
= no_event
;
3432 idx
= 2 * (event
- kbd_buffer
);
3433 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3434 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3436 kbd_fetch_ptr
= event
+ 1;
3441 /* Try generating a mouse motion event. */
3442 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3444 FRAME_PTR f
= some_mouse_moved ();
3445 Lisp_Object bar_window
;
3446 enum scroll_bar_part part
;
3450 *kbp
= current_kboard
;
3451 /* Note that this uses F to determine which display to look at.
3452 If there is no valid info, it does not store anything
3453 so x remains nil. */
3455 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3459 /* Decide if we should generate a switch-frame event. Don't
3460 generate switch-frame events for motion outside of all Emacs
3466 frame
= FRAME_FOCUS_FRAME (f
);
3468 XSETFRAME (frame
, f
);
3470 if (! EQ (frame
, internal_last_event_frame
)
3471 && !EQ (frame
, selected_frame
))
3472 obj
= make_lispy_switch_frame (frame
);
3473 internal_last_event_frame
= frame
;
3476 /* If we didn't decide to make a switch-frame event, go ahead and
3477 return a mouse-motion event. */
3478 if (!NILP (x
) && NILP (obj
))
3479 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3481 #endif /* HAVE_MOUSE */
3483 /* We were promised by the above while loop that there was
3484 something for us to read! */
3487 input_pending
= readable_events (0);
3489 Vlast_event_frame
= internal_last_event_frame
;
3494 /* Process any events that are not user-visible,
3495 then return, without reading any user-visible events. */
3498 swallow_events (do_display
)
3503 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3505 struct input_event
*event
;
3507 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3511 last_event_timestamp
= event
->timestamp
;
3513 /* These two kinds of events get special handling
3514 and don't actually appear to the command loop. */
3515 if (event
->kind
== selection_request_event
)
3518 struct input_event copy
;
3520 /* Remove it from the buffer before processing it,
3521 since otherwise swallow_events called recursively could see it
3522 and process it again. */
3524 kbd_fetch_ptr
= event
+ 1;
3525 input_pending
= readable_events (0);
3526 x_handle_selection_request (©
);
3528 /* We're getting selection request events, but we don't have
3534 else if (event
->kind
== selection_clear_event
)
3537 struct input_event copy
;
3539 /* Remove it from the buffer before processing it, */
3542 kbd_fetch_ptr
= event
+ 1;
3543 input_pending
= readable_events (0);
3544 x_handle_selection_clear (©
);
3546 /* We're getting selection request events, but we don't have
3555 old_timers_run
= timers_run
;
3556 get_input_pending (&input_pending
, 1);
3558 if (timers_run
!= old_timers_run
&& do_display
)
3559 redisplay_preserve_echo_area ();
3562 static EMACS_TIME timer_idleness_start_time
;
3564 /* Record the start of when Emacs is idle,
3565 for the sake of running idle-time timers. */
3572 /* If we are already in the idle state, do nothing. */
3573 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3576 EMACS_GET_TIME (timer_idleness_start_time
);
3578 /* Mark all idle-time timers as once again candidates for running. */
3579 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
3583 timer
= XCAR (timers
);
3585 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3587 XVECTOR (timer
)->contents
[0] = Qnil
;
3591 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3596 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3599 /* This is only for debugging. */
3600 struct input_event last_timer_event
;
3602 /* Check whether a timer has fired. To prevent larger problems we simply
3603 disregard elements that are not proper timers. Do not make a circular
3604 timer list for the time being.
3606 Returns the number of seconds to wait until the next timer fires. If a
3607 timer is triggering now, return zero seconds.
3608 If no timer is active, return -1 seconds.
3610 If a timer is ripe, we run it, with quitting turned off.
3612 DO_IT_NOW is now ignored. It used to mean that we should
3613 run the timer directly instead of queueing a timer-event.
3614 Now we always run timers directly. */
3617 timer_check (do_it_now
)
3620 EMACS_TIME nexttime
;
3621 EMACS_TIME now
, idleness_now
;
3622 Lisp_Object timers
, idle_timers
, chosen_timer
;
3623 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3625 EMACS_SET_SECS (nexttime
, -1);
3626 EMACS_SET_USECS (nexttime
, -1);
3628 /* Always consider the ordinary timers. */
3629 timers
= Vtimer_list
;
3630 /* Consider the idle timers only if Emacs is idle. */
3631 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3632 idle_timers
= Vtimer_idle_list
;
3635 chosen_timer
= Qnil
;
3636 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3638 if (CONSP (timers
) || CONSP (idle_timers
))
3640 EMACS_GET_TIME (now
);
3641 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3642 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3645 while (CONSP (timers
) || CONSP (idle_timers
))
3647 Lisp_Object
*vector
;
3648 Lisp_Object timer
, idle_timer
;
3649 EMACS_TIME timer_time
, idle_timer_time
;
3650 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3652 /* Skip past invalid timers and timers already handled. */
3655 timer
= XCAR (timers
);
3656 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3658 timers
= XCDR (timers
);
3661 vector
= XVECTOR (timer
)->contents
;
3663 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3664 || !INTEGERP (vector
[3])
3665 || ! NILP (vector
[0]))
3667 timers
= XCDR (timers
);
3671 if (!NILP (idle_timers
))
3673 timer
= XCAR (idle_timers
);
3674 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3676 idle_timers
= XCDR (idle_timers
);
3679 vector
= XVECTOR (timer
)->contents
;
3681 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3682 || !INTEGERP (vector
[3])
3683 || ! NILP (vector
[0]))
3685 idle_timers
= XCDR (idle_timers
);
3690 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3691 based on the next ordinary timer.
3692 TIMER_DIFFERENCE is the distance in time from NOW to when
3693 this timer becomes ripe (negative if it's already ripe). */
3696 timer
= XCAR (timers
);
3697 vector
= XVECTOR (timer
)->contents
;
3698 EMACS_SET_SECS (timer_time
,
3699 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3700 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3701 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3704 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3705 based on the next idle timer. */
3706 if (!NILP (idle_timers
))
3708 idle_timer
= XCAR (idle_timers
);
3709 vector
= XVECTOR (idle_timer
)->contents
;
3710 EMACS_SET_SECS (idle_timer_time
,
3711 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3712 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3713 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3716 /* Decide which timer is the next timer,
3717 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3718 Also step down the list where we found that timer. */
3720 if (! NILP (timers
) && ! NILP (idle_timers
))
3723 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3724 if (EMACS_TIME_NEG_P (temp
))
3726 chosen_timer
= timer
;
3727 timers
= XCDR (timers
);
3728 difference
= timer_difference
;
3732 chosen_timer
= idle_timer
;
3733 idle_timers
= XCDR (idle_timers
);
3734 difference
= idle_timer_difference
;
3737 else if (! NILP (timers
))
3739 chosen_timer
= timer
;
3740 timers
= XCDR (timers
);
3741 difference
= timer_difference
;
3745 chosen_timer
= idle_timer
;
3746 idle_timers
= XCDR (idle_timers
);
3747 difference
= idle_timer_difference
;
3749 vector
= XVECTOR (chosen_timer
)->contents
;
3751 /* If timer is ripe, run it if it hasn't been run. */
3752 if (EMACS_TIME_NEG_P (difference
)
3753 || (EMACS_SECS (difference
) == 0
3754 && EMACS_USECS (difference
) == 0))
3756 if (NILP (vector
[0]))
3758 int was_locked
= single_kboard
;
3759 int count
= specpdl_ptr
- specpdl
;
3761 /* Mark the timer as triggered to prevent problems if the lisp
3762 code fails to reschedule it right. */
3765 specbind (Qinhibit_quit
, Qt
);
3767 call1 (Qtimer_event_handler
, chosen_timer
);
3770 unbind_to (count
, Qnil
);
3772 /* Resume allowing input from any kboard, if that was true before. */
3774 any_kboard_state ();
3776 /* Since we have handled the event,
3777 we don't need to tell the caller to wake up and do it. */
3781 /* When we encounter a timer that is still waiting,
3782 return the amount of time to wait before it is ripe. */
3789 /* No timers are pending in the future. */
3790 /* Return 0 if we generated an event, and -1 if not. */
3795 /* Caches for modify_event_symbol. */
3796 static Lisp_Object accent_key_syms
;
3797 static Lisp_Object func_key_syms
;
3798 static Lisp_Object mouse_syms
;
3800 static Lisp_Object mouse_wheel_syms
;
3802 static Lisp_Object drag_n_drop_syms
;
3804 /* This is a list of keysym codes for special "accent" characters.
3805 It parallels lispy_accent_keys. */
3807 static int lispy_accent_codes
[] =
3809 #ifdef XK_dead_circumflex
3814 #ifdef XK_dead_grave
3819 #ifdef XK_dead_tilde
3824 #ifdef XK_dead_diaeresis
3829 #ifdef XK_dead_macron
3834 #ifdef XK_dead_degree
3839 #ifdef XK_dead_acute
3844 #ifdef XK_dead_cedilla
3849 #ifdef XK_dead_breve
3854 #ifdef XK_dead_ogonek
3859 #ifdef XK_dead_caron
3864 #ifdef XK_dead_doubleacute
3865 XK_dead_doubleacute
,
3869 #ifdef XK_dead_abovedot
3876 /* This is a list of Lisp names for special "accent" characters.
3877 It parallels lispy_accent_codes. */
3879 static char *lispy_accent_keys
[] =
3897 #define FUNCTION_KEY_OFFSET 0x0
3899 char *lispy_function_keys
[] =
3903 0, /* VK_LBUTTON 0x01 */
3904 0, /* VK_RBUTTON 0x02 */
3905 "cancel", /* VK_CANCEL 0x03 */
3906 0, /* VK_MBUTTON 0x04 */
3908 0, 0, 0, /* 0x05 .. 0x07 */
3910 "backspace", /* VK_BACK 0x08 */
3911 "tab", /* VK_TAB 0x09 */
3913 0, 0, /* 0x0A .. 0x0B */
3915 "clear", /* VK_CLEAR 0x0C */
3916 "return", /* VK_RETURN 0x0D */
3918 0, 0, /* 0x0E .. 0x0F */
3920 0, /* VK_SHIFT 0x10 */
3921 0, /* VK_CONTROL 0x11 */
3922 0, /* VK_MENU 0x12 */
3923 "pause", /* VK_PAUSE 0x13 */
3924 "capslock", /* VK_CAPITAL 0x14 */
3926 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3928 "escape", /* VK_ESCAPE 0x1B */
3930 0, 0, 0, 0, /* 0x1C .. 0x1F */
3932 0, /* VK_SPACE 0x20 */
3933 "prior", /* VK_PRIOR 0x21 */
3934 "next", /* VK_NEXT 0x22 */
3935 "end", /* VK_END 0x23 */
3936 "home", /* VK_HOME 0x24 */
3937 "left", /* VK_LEFT 0x25 */
3938 "up", /* VK_UP 0x26 */
3939 "right", /* VK_RIGHT 0x27 */
3940 "down", /* VK_DOWN 0x28 */
3941 "select", /* VK_SELECT 0x29 */
3942 "print", /* VK_PRINT 0x2A */
3943 "execute", /* VK_EXECUTE 0x2B */
3944 "snapshot", /* VK_SNAPSHOT 0x2C */
3945 "insert", /* VK_INSERT 0x2D */
3946 "delete", /* VK_DELETE 0x2E */
3947 "help", /* VK_HELP 0x2F */
3949 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3951 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3953 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3955 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3957 0, 0, 0, 0, 0, 0, 0, 0, 0,
3958 0, 0, 0, 0, 0, 0, 0, 0, 0,
3959 0, 0, 0, 0, 0, 0, 0, 0,
3961 "lwindow", /* VK_LWIN 0x5B */
3962 "rwindow", /* VK_RWIN 0x5C */
3963 "apps", /* VK_APPS 0x5D */
3965 0, 0, /* 0x5E .. 0x5F */
3967 "kp-0", /* VK_NUMPAD0 0x60 */
3968 "kp-1", /* VK_NUMPAD1 0x61 */
3969 "kp-2", /* VK_NUMPAD2 0x62 */
3970 "kp-3", /* VK_NUMPAD3 0x63 */
3971 "kp-4", /* VK_NUMPAD4 0x64 */
3972 "kp-5", /* VK_NUMPAD5 0x65 */
3973 "kp-6", /* VK_NUMPAD6 0x66 */
3974 "kp-7", /* VK_NUMPAD7 0x67 */
3975 "kp-8", /* VK_NUMPAD8 0x68 */
3976 "kp-9", /* VK_NUMPAD9 0x69 */
3977 "kp-multiply", /* VK_MULTIPLY 0x6A */
3978 "kp-add", /* VK_ADD 0x6B */
3979 "kp-separator", /* VK_SEPARATOR 0x6C */
3980 "kp-subtract", /* VK_SUBTRACT 0x6D */
3981 "kp-decimal", /* VK_DECIMAL 0x6E */
3982 "kp-divide", /* VK_DIVIDE 0x6F */
3983 "f1", /* VK_F1 0x70 */
3984 "f2", /* VK_F2 0x71 */
3985 "f3", /* VK_F3 0x72 */
3986 "f4", /* VK_F4 0x73 */
3987 "f5", /* VK_F5 0x74 */
3988 "f6", /* VK_F6 0x75 */
3989 "f7", /* VK_F7 0x76 */
3990 "f8", /* VK_F8 0x77 */
3991 "f9", /* VK_F9 0x78 */
3992 "f10", /* VK_F10 0x79 */
3993 "f11", /* VK_F11 0x7A */
3994 "f12", /* VK_F12 0x7B */
3995 "f13", /* VK_F13 0x7C */
3996 "f14", /* VK_F14 0x7D */
3997 "f15", /* VK_F15 0x7E */
3998 "f16", /* VK_F16 0x7F */
3999 "f17", /* VK_F17 0x80 */
4000 "f18", /* VK_F18 0x81 */
4001 "f19", /* VK_F19 0x82 */
4002 "f20", /* VK_F20 0x83 */
4003 "f21", /* VK_F21 0x84 */
4004 "f22", /* VK_F22 0x85 */
4005 "f23", /* VK_F23 0x86 */
4006 "f24", /* VK_F24 0x87 */
4008 0, 0, 0, 0, /* 0x88 .. 0x8B */
4009 0, 0, 0, 0, /* 0x8C .. 0x8F */
4011 "kp-numlock", /* VK_NUMLOCK 0x90 */
4012 "scroll", /* VK_SCROLL 0x91 */
4014 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4015 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4016 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4017 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4018 "kp-end", /* VK_NUMPAD_END 0x96 */
4019 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4020 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4021 "kp-up", /* VK_NUMPAD_UP 0x99 */
4022 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4023 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4024 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4025 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4027 0, 0, /* 0x9E .. 0x9F */
4030 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4031 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4032 * No other API or message will distinguish left and right keys this way.
4036 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4037 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4038 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4039 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4040 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4046 "attn", /* VK_ATTN 0xF6 */
4047 "crsel", /* VK_CRSEL 0xF7 */
4048 "exsel", /* VK_EXSEL 0xF8 */
4049 "ereof", /* VK_EREOF 0xF9 */
4050 "play", /* VK_PLAY 0xFA */
4051 "zoom", /* VK_ZOOM 0xFB */
4052 "noname", /* VK_NONAME 0xFC */
4053 "pa1", /* VK_PA1 0xFD */
4054 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4058 #else /* not HAVE_NTGUI */
4061 static char *lispy_kana_keys
[] =
4063 /* X Keysym value */
4064 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4065 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4066 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4069 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4070 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4071 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4072 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4073 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4074 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4075 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4076 "kana-i", "kana-u", "kana-e", "kana-o",
4077 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4078 "prolongedsound", "kana-A", "kana-I", "kana-U",
4079 "kana-E", "kana-O", "kana-KA", "kana-KI",
4080 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4081 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4082 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4083 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4084 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4085 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4086 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4087 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4088 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4089 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4090 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4091 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4093 #endif /* XK_kana_A */
4095 #define FUNCTION_KEY_OFFSET 0xff00
4097 /* You'll notice that this table is arranged to be conveniently
4098 indexed by X Windows keysym values. */
4099 static char *lispy_function_keys
[] =
4101 /* X Keysym value */
4103 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4104 "backspace", "tab", "linefeed", "clear",
4106 0, 0, 0, "pause", /* 0xff10...1f */
4107 0, 0, 0, 0, 0, 0, 0, "escape",
4109 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4110 "romaji", "hiragana", "katakana", "hiragana-katakana",
4111 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4112 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4113 "eisu-toggle", /* 0xff30...3f */
4114 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4115 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4117 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4118 "down", "prior", "next", "end",
4119 "begin", 0, 0, 0, 0, 0, 0, 0,
4120 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4131 "break", /* 0xff6b */
4134 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4135 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4136 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4137 0, 0, 0, 0, 0, 0, 0, 0,
4138 "kp-tab", /* 0xff89 */
4140 "kp-enter", /* 0xff8d */
4142 "kp-f1", /* 0xff91 */
4146 "kp-home", /* 0xff95 */
4151 "kp-prior", /* kp-page-up */
4152 "kp-next", /* kp-page-down */
4158 0, 0, 0, 0, 0, 0, 0, 0, 0,
4159 "kp-multiply", /* 0xffaa */
4164 "kp-divide", /* 0xffaf */
4165 "kp-0", /* 0xffb0 */
4166 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4169 "kp-equal", /* 0xffbd */
4170 "f1", /* 0xffbe */ /* IsFunctionKey */
4172 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4173 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4174 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4175 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4176 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4177 0, 0, 0, 0, 0, 0, 0, 0,
4178 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4179 0, 0, 0, 0, 0, 0, 0, "delete"
4182 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4183 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4185 static char *iso_lispy_function_keys
[] =
4187 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4188 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4189 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4190 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4191 "iso-lefttab", /* 0xfe20 */
4192 "iso-move-line-up", "iso-move-line-down",
4193 "iso-partial-line-up", "iso-partial-line-down",
4194 "iso-partial-space-left", "iso-partial-space-right",
4195 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4196 "iso-release-margin-left", "iso-release-margin-right",
4197 "iso-release-both-margins",
4198 "iso-fast-cursor-left", "iso-fast-cursor-right",
4199 "iso-fast-cursor-up", "iso-fast-cursor-down",
4200 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4201 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4204 #endif /* not HAVE_NTGUI */
4206 Lisp_Object Vlispy_mouse_stem
;
4209 /* mouse-wheel events are generated by the wheel on devices such as
4210 the MS Intellimouse. The wheel sits in between the left and right
4211 mouse buttons, and is typically used to scroll or zoom the window
4212 underneath the pointer. mouse-wheel events specify the object on
4213 which they operate, and a delta corresponding to the amount and
4214 direction that the wheel is rotated. Clicking the mouse-wheel
4215 generates a mouse-2 event. */
4216 static char *lispy_mouse_wheel_names
[] =
4221 #endif /* WINDOWSNT */
4223 /* drag-n-drop events are generated when a set of selected files are
4224 dragged from another application and dropped onto an Emacs window. */
4225 static char *lispy_drag_n_drop_names
[] =
4230 /* Scroll bar parts. */
4231 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4232 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4233 Lisp_Object Qtop
, Qratio
;
4235 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4236 Lisp_Object
*scroll_bar_parts
[] = {
4237 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4238 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4241 /* User signal events. */
4242 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4244 Lisp_Object
*lispy_user_signals
[] =
4246 &Qusr1_signal
, &Qusr2_signal
4250 /* A vector, indexed by button number, giving the down-going location
4251 of currently depressed buttons, both scroll bar and non-scroll bar.
4253 The elements have the form
4254 (BUTTON-NUMBER MODIFIER-MASK . REST)
4255 where REST is the cdr of a position as it would be reported in the event.
4257 The make_lispy_event function stores positions here to tell the
4258 difference between click and drag events, and to store the starting
4259 location to be included in drag events. */
4261 static Lisp_Object button_down_location
;
4263 /* Information about the most recent up-going button event: Which
4264 button, what location, and what time. */
4266 static int last_mouse_button
;
4267 static int last_mouse_x
;
4268 static int last_mouse_y
;
4269 static unsigned long button_down_time
;
4271 /* The maximum time between clicks to make a double-click,
4272 or Qnil to disable double-click detection,
4273 or Qt for no time limit. */
4274 Lisp_Object Vdouble_click_time
;
4276 /* The number of clicks in this multiple-click. */
4278 int double_click_count
;
4280 /* Given a struct input_event, build the lisp event which represents
4281 it. If EVENT is 0, build a mouse movement event from the mouse
4282 movement buffer, which should have a movement event in it.
4284 Note that events must be passed to this function in the order they
4285 are received; this function stores the location of button presses
4286 in order to build drag events when the button is released. */
4289 make_lispy_event (event
)
4290 struct input_event
*event
;
4294 switch (SWITCH_ENUM_CAST (event
->kind
))
4296 /* A simple keystroke. */
4297 case ascii_keystroke
:
4299 Lisp_Object lispy_c
;
4300 int c
= event
->code
& 0377;
4301 /* Turn ASCII characters into control characters
4303 if (event
->modifiers
& ctrl_modifier
)
4304 c
= make_ctrl_char (c
);
4306 /* Add in the other modifier bits. We took care of ctrl_modifier
4307 just above, and the shift key was taken care of by the X code,
4308 and applied to control characters by make_ctrl_char. */
4309 c
|= (event
->modifiers
4310 & (meta_modifier
| alt_modifier
4311 | hyper_modifier
| super_modifier
));
4312 /* Distinguish Shift-SPC from SPC. */
4313 if ((event
->code
& 0377) == 040
4314 && event
->modifiers
& shift_modifier
)
4315 c
|= shift_modifier
;
4316 button_down_time
= 0;
4317 XSETFASTINT (lispy_c
, c
);
4321 /* A function key. The symbol may need to have modifier prefixes
4323 case non_ascii_keystroke
:
4324 button_down_time
= 0;
4326 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4327 if (event
->code
== lispy_accent_codes
[i
])
4328 return modify_event_symbol (i
,
4330 Qfunction_key
, Qnil
,
4331 lispy_accent_keys
, &accent_key_syms
,
4332 (sizeof (lispy_accent_keys
)
4333 / sizeof (lispy_accent_keys
[0])));
4335 /* Handle system-specific keysyms. */
4336 if (event
->code
& (1 << 28))
4338 /* We need to use an alist rather than a vector as the cache
4339 since we can't make a vector long enuf. */
4340 if (NILP (current_kboard
->system_key_syms
))
4341 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4342 return modify_event_symbol (event
->code
,
4345 current_kboard
->Vsystem_key_alist
,
4346 0, ¤t_kboard
->system_key_syms
,
4351 if (event
->code
>= 0x400 && event
->code
< 0x500)
4352 return modify_event_symbol (event
->code
- 0x400,
4353 event
->modifiers
& ~shift_modifier
,
4354 Qfunction_key
, Qnil
,
4355 lispy_kana_keys
, &func_key_syms
,
4356 (sizeof (lispy_kana_keys
)
4357 / sizeof (lispy_kana_keys
[0])));
4358 #endif /* XK_kana_A */
4360 #ifdef ISO_FUNCTION_KEY_OFFSET
4361 if (event
->code
< FUNCTION_KEY_OFFSET
4362 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4363 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4365 Qfunction_key
, Qnil
,
4366 iso_lispy_function_keys
, &func_key_syms
,
4367 (sizeof (iso_lispy_function_keys
)
4368 / sizeof (iso_lispy_function_keys
[0])));
4371 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4373 Qfunction_key
, Qnil
,
4374 lispy_function_keys
, &func_key_syms
,
4375 (sizeof (lispy_function_keys
)
4376 / sizeof (lispy_function_keys
[0])));
4379 /* A mouse click. Figure out where it is, decide whether it's
4380 a press, click or drag, and build the appropriate structure. */
4382 #ifndef USE_TOOLKIT_SCROLL_BARS
4383 case scroll_bar_click
:
4386 int button
= event
->code
;
4388 Lisp_Object position
;
4389 Lisp_Object
*start_pos_ptr
;
4390 Lisp_Object start_pos
;
4392 /* Build the position as appropriate for this mouse click. */
4393 if (event
->kind
== mouse_click
)
4396 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4399 Lisp_Object string_info
= Qnil
;
4402 /* Ignore mouse events that were made on frame that
4403 have been deleted. */
4404 if (! FRAME_LIVE_P (f
))
4407 /* EVENT->x and EVENT->y are frame-relative pixel
4408 coordinates at this place. Under old redisplay, COLUMN
4409 and ROW are set to frame relative glyph coordinates
4410 which are then used to determine whether this click is
4411 in a menu (non-toolkit version). */
4412 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4413 &column
, &row
, NULL
, 1);
4415 #ifndef USE_X_TOOLKIT
4416 /* In the non-toolkit version, clicks on the menu bar
4417 are ordinary button events in the event buffer.
4418 Distinguish them, and invoke the menu.
4420 (In the toolkit version, the toolkit handles the menu bar
4421 and Emacs doesn't know about it until after the user
4422 makes a selection.) */
4423 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4424 && (event
->modifiers
& down_modifier
))
4426 Lisp_Object items
, item
;
4431 /* Activate the menu bar on the down event. If the
4432 up event comes in before the menu code can deal with it,
4434 if (! (event
->modifiers
& down_modifier
))
4438 /* Find the menu bar item under `column'. */
4440 items
= FRAME_MENU_BAR_ITEMS (f
);
4441 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4443 Lisp_Object pos
, string
;
4444 string
= XVECTOR (items
)->contents
[i
+ 1];
4445 pos
= XVECTOR (items
)->contents
[i
+ 3];
4448 if (column
>= XINT (pos
)
4449 && column
< XINT (pos
) + XSTRING (string
)->size
)
4451 item
= XVECTOR (items
)->contents
[i
];
4456 /* ELisp manual 2.4b says (x y) are window relative but
4457 code says they are frame-relative. */
4459 = Fcons (event
->frame_or_window
,
4461 Fcons (Fcons (event
->x
, event
->y
),
4462 Fcons (make_number (event
->timestamp
),
4465 return Fcons (item
, Fcons (position
, Qnil
));
4467 #endif /* not USE_X_TOOLKIT */
4469 /* Set `window' to the window under frame pixel coordinates
4470 event->x/event->y. */
4471 window
= window_from_coordinates (f
, XINT (event
->x
),
4472 XINT (event
->y
), &part
, 0);
4474 if (!WINDOWP (window
))
4476 window
= event
->frame_or_window
;
4481 /* It's a click in window window at frame coordinates
4482 event->x/ event->y. */
4483 struct window
*w
= XWINDOW (window
);
4485 /* Get window relative coordinates. Original code
4486 `rounded' this to glyph boundaries. */
4487 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4488 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4490 /* Set event coordinates to window-relative coordinates
4491 for constructing the Lisp event below. */
4492 XSETINT (event
->x
, wx
);
4493 XSETINT (event
->y
, wy
);
4495 if (part
== 1 || part
== 3)
4497 /* Mode line or top line. Look for a string under
4498 the mouse that may have a `local-map' property. */
4502 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4503 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4504 if (STRINGP (string
))
4505 string_info
= Fcons (string
, make_number (charpos
));
4508 posn
= Qvertical_line
;
4510 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
4516 Fcons (Fcons (event
->x
, event
->y
),
4517 Fcons (make_number (event
->timestamp
),
4520 : Fcons (string_info
, Qnil
))))));
4522 #ifndef USE_TOOLKIT_SCROLL_BARS
4525 /* It's a scrollbar click. */
4527 Lisp_Object portion_whole
;
4530 window
= event
->frame_or_window
;
4531 portion_whole
= Fcons (event
->x
, event
->y
);
4532 part
= *scroll_bar_parts
[(int) event
->part
];
4536 Fcons (Qvertical_scroll_bar
,
4537 Fcons (portion_whole
,
4538 Fcons (make_number (event
->timestamp
),
4539 Fcons (part
, Qnil
)))));
4541 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4543 if (button
>= XVECTOR (button_down_location
)->size
)
4545 button_down_location
= larger_vector (button_down_location
,
4547 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
4550 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
4552 start_pos
= *start_pos_ptr
;
4553 *start_pos_ptr
= Qnil
;
4555 is_double
= (button
== last_mouse_button
4556 && XINT (event
->x
) == last_mouse_x
4557 && XINT (event
->y
) == last_mouse_y
4558 && button_down_time
!= 0
4559 && (EQ (Vdouble_click_time
, Qt
)
4560 || (INTEGERP (Vdouble_click_time
)
4561 && ((int)(event
->timestamp
- button_down_time
)
4562 < XINT (Vdouble_click_time
)))));
4563 last_mouse_button
= button
;
4564 last_mouse_x
= XINT (event
->x
);
4565 last_mouse_y
= XINT (event
->y
);
4567 /* If this is a button press, squirrel away the location, so
4568 we can decide later whether it was a click or a drag. */
4569 if (event
->modifiers
& down_modifier
)
4573 double_click_count
++;
4574 event
->modifiers
|= ((double_click_count
> 2)
4579 double_click_count
= 1;
4580 button_down_time
= event
->timestamp
;
4581 *start_pos_ptr
= Fcopy_alist (position
);
4584 /* Now we're releasing a button - check the co-ordinates to
4585 see if this was a click or a drag. */
4586 else if (event
->modifiers
& up_modifier
)
4588 /* If we did not see a down before this up,
4589 ignore the up. Probably this happened because
4590 the down event chose a menu item.
4591 It would be an annoyance to treat the release
4592 of the button that chose the menu item
4593 as a separate event. */
4595 if (!CONSP (start_pos
))
4598 event
->modifiers
&= ~up_modifier
;
4599 #if 0 /* Formerly we treated an up with no down as a click event. */
4600 if (!CONSP (start_pos
))
4601 event
->modifiers
|= click_modifier
;
4605 /* The third element of every position should be the (x,y)
4609 down
= Fnth (make_number (2), start_pos
);
4610 if (EQ (event
->x
, XCAR (down
))
4611 && EQ (event
->y
, XCDR (down
)))
4613 event
->modifiers
|= click_modifier
;
4617 button_down_time
= 0;
4618 event
->modifiers
|= drag_modifier
;
4620 /* Don't check is_double; treat this as multiple
4621 if the down-event was multiple. */
4622 if (double_click_count
> 1)
4623 event
->modifiers
|= ((double_click_count
> 2)
4629 /* Every mouse event should either have the down_modifier or
4630 the up_modifier set. */
4634 /* Get the symbol we should use for the mouse click. */
4637 head
= modify_event_symbol (button
,
4639 Qmouse_click
, Vlispy_mouse_stem
,
4642 XVECTOR (mouse_syms
)->size
);
4643 if (event
->modifiers
& drag_modifier
)
4648 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4651 Fcons (make_number (double_click_count
),
4660 #if USE_TOOLKIT_SCROLL_BARS
4662 /* We don't have down and up events if using toolkit scroll bars,
4663 so make this always a click event. Store in the `part' of
4664 the Lisp event a symbol which maps to the following actions:
4666 `above_handle' page up
4667 `below_handle' page down
4671 `bottom' bottom of buffer
4672 `handle' thumb has been dragged.
4673 `end-scroll' end of interaction with scroll bar
4675 The incoming input_event contains in its `part' member an
4676 index of type `enum scroll_bar_part' which we can use as an
4677 index in scroll_bar_parts to get the appropriate symbol. */
4679 case scroll_bar_click
:
4681 Lisp_Object position
, head
, window
, portion_whole
, part
;
4683 window
= event
->frame_or_window
;
4684 portion_whole
= Fcons (event
->x
, event
->y
);
4685 part
= *scroll_bar_parts
[(int) event
->part
];
4689 Fcons (Qvertical_scroll_bar
,
4690 Fcons (portion_whole
,
4691 Fcons (make_number (event
->timestamp
),
4692 Fcons (part
, Qnil
)))));
4694 /* Always treat scroll bar events as clicks. */
4695 event
->modifiers
|= click_modifier
;
4697 /* Get the symbol we should use for the mouse click. */
4698 head
= modify_event_symbol (event
->code
,
4703 XVECTOR (mouse_syms
)->size
);
4704 return Fcons (head
, Fcons (position
, Qnil
));
4707 #endif /* USE_TOOLKIT_SCROLL_BARS */
4710 case w32_scroll_bar_click
:
4712 int button
= event
->code
;
4714 Lisp_Object position
;
4715 Lisp_Object
*start_pos_ptr
;
4716 Lisp_Object start_pos
;
4720 Lisp_Object portion_whole
;
4723 window
= event
->frame_or_window
;
4724 portion_whole
= Fcons (event
->x
, event
->y
);
4725 part
= *scroll_bar_parts
[(int) event
->part
];
4729 Fcons (Qvertical_scroll_bar
,
4730 Fcons (portion_whole
,
4731 Fcons (make_number (event
->timestamp
),
4732 Fcons (part
, Qnil
)))));
4735 /* Always treat W32 scroll bar events as clicks. */
4736 event
->modifiers
|= click_modifier
;
4739 /* Get the symbol we should use for the mouse click. */
4742 head
= modify_event_symbol (button
,
4747 XVECTOR (mouse_syms
)->size
);
4756 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4759 Lisp_Object head
, position
;
4762 /* Ignore mouse events that were made on frame that
4763 have been deleted. */
4764 if (! FRAME_LIVE_P (f
))
4766 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4767 &column
, &row
, NULL
, 1);
4768 window
= window_from_coordinates (f
, column
, row
, &part
, 0);
4770 if (!WINDOWP (window
))
4772 window
= event
->frame_or_window
;
4777 int pixcolumn
, pixrow
;
4778 column
-= XINT (XWINDOW (window
)->left
);
4779 row
-= XINT (XWINDOW (window
)->top
);
4780 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
4781 &pixcolumn
, &pixrow
);
4782 XSETINT (event
->x
, pixcolumn
);
4783 XSETINT (event
->y
, pixrow
);
4788 posn
= Qvertical_line
;
4790 posn
= Qheader_line
;
4793 buffer_posn_from_coords (XWINDOW (window
),
4798 Lisp_Object head
, position
;
4803 Fcons (Fcons (event
->x
, event
->y
),
4804 Fcons (make_number (event
->timestamp
),
4807 head
= modify_event_symbol (0, event
->modifiers
,
4809 lispy_mouse_wheel_names
,
4810 &mouse_wheel_syms
, 1);
4813 Fcons (make_number (event
->code
),
4817 #endif /* WINDOWSNT */
4828 /* The frame_or_window field should be a cons of the frame in
4829 which the event occurred and a list of the filenames
4831 if (! CONSP (event
->frame_or_window
))
4834 f
= XFRAME (XCAR (event
->frame_or_window
));
4835 files
= XCDR (event
->frame_or_window
);
4837 /* Ignore mouse events that were made on frames that
4838 have been deleted. */
4839 if (! FRAME_LIVE_P (f
))
4841 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4842 &column
, &row
, NULL
, 1);
4843 window
= window_from_coordinates (f
, column
, row
, &part
, 0);
4845 if (!WINDOWP (window
))
4847 window
= XCAR (event
->frame_or_window
);
4852 /* It's an event in window `window' at frame coordinates
4853 event->x/ event->y. */
4854 struct window
*w
= XWINDOW (window
);
4856 /* Get window relative coordinates. */
4857 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4858 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4860 /* Set event coordinates to window-relative coordinates
4861 for constructing the Lisp event below. */
4862 XSETINT (event
->x
, wx
);
4863 XSETINT (event
->y
, wy
);
4868 posn
= Qvertical_line
;
4870 posn
= Qheader_line
;
4872 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
4876 Lisp_Object head
, position
;
4881 Fcons (Fcons (event
->x
, event
->y
),
4882 Fcons (make_number (event
->timestamp
),
4885 head
= modify_event_symbol (0, event
->modifiers
,
4887 lispy_drag_n_drop_names
,
4888 &drag_n_drop_syms
, 1);
4895 #endif /* HAVE_MOUSE */
4897 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4898 case MENU_BAR_EVENT
:
4899 if (EQ (event
->arg
, event
->frame_or_window
))
4900 /* This is the prefix key. We translate this to
4901 `(menu_bar)' because the code in keyboard.c for menu
4902 events, which we use, relies on this. */
4903 return Fcons (Qmenu_bar
, Qnil
);
4907 case TOOL_BAR_EVENT
:
4908 if (EQ (event
->arg
, event
->frame_or_window
))
4909 /* This is the prefix key. We translate this to
4910 `(tool_bar)' because the code in keyboard.c for menu
4911 events, which we use, relies on this. */
4912 return Fcons (Qtool_bar
, Qnil
);
4913 else if (SYMBOLP (event
->arg
))
4914 return apply_modifiers (event
->modifiers
, event
->arg
);
4917 case USER_SIGNAL_EVENT
:
4918 /* A user signal. */
4919 return *lispy_user_signals
[event
->code
];
4921 /* The 'kind' field of the event is something we don't recognize. */
4930 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4932 Lisp_Object bar_window
;
4933 enum scroll_bar_part part
;
4937 /* Is it a scroll bar movement? */
4938 if (frame
&& ! NILP (bar_window
))
4940 Lisp_Object part_sym
;
4942 part_sym
= *scroll_bar_parts
[(int) part
];
4943 return Fcons (Qscroll_bar_movement
,
4944 (Fcons (Fcons (bar_window
,
4945 Fcons (Qvertical_scroll_bar
,
4946 Fcons (Fcons (x
, y
),
4947 Fcons (make_number (time
),
4953 /* Or is it an ordinary mouse movement? */
4961 /* It's in a frame; which window on that frame? */
4962 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
4966 if (WINDOWP (window
))
4968 struct window
*w
= XWINDOW (window
);
4971 /* Get window relative coordinates. */
4972 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
4973 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
4980 posn
= Qvertical_line
;
4982 posn
= Qheader_line
;
4984 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
4986 else if (frame
!= 0)
4988 XSETFRAME (window
, frame
);
4999 return Fcons (Qmouse_movement
,
5000 Fcons (Fcons (window
,
5002 Fcons (Fcons (x
, y
),
5003 Fcons (make_number (time
),
5009 #endif /* HAVE_MOUSE */
5011 /* Construct a switch frame event. */
5013 make_lispy_switch_frame (frame
)
5016 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5019 /* Manipulating modifiers. */
5021 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5023 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5024 SYMBOL's name of the end of the modifiers; the string from this
5025 position is the unmodified symbol name.
5027 This doesn't use any caches. */
5030 parse_modifiers_uncached (symbol
, modifier_end
)
5034 struct Lisp_String
*name
;
5038 CHECK_SYMBOL (symbol
, 1);
5041 name
= XSYMBOL (symbol
)->name
;
5043 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
5045 int this_mod_end
= 0;
5048 /* See if the name continues with a modifier word.
5049 Check that the word appears, but don't check what follows it.
5050 Set this_mod and this_mod_end to record what we find. */
5052 switch (name
->data
[i
])
5054 #define SINGLE_LETTER_MOD(BIT) \
5055 (this_mod_end = i + 1, this_mod = BIT)
5058 SINGLE_LETTER_MOD (alt_modifier
);
5062 SINGLE_LETTER_MOD (ctrl_modifier
);
5066 SINGLE_LETTER_MOD (hyper_modifier
);
5070 SINGLE_LETTER_MOD (meta_modifier
);
5074 SINGLE_LETTER_MOD (shift_modifier
);
5078 SINGLE_LETTER_MOD (super_modifier
);
5081 #undef SINGLE_LETTER_MOD
5084 /* If we found no modifier, stop looking for them. */
5085 if (this_mod_end
== 0)
5088 /* Check there is a dash after the modifier, so that it
5089 really is a modifier. */
5090 if (this_mod_end
>= STRING_BYTES (name
)
5091 || name
->data
[this_mod_end
] != '-')
5094 /* This modifier is real; look for another. */
5095 modifiers
|= this_mod
;
5096 i
= this_mod_end
+ 1;
5099 /* Should we include the `click' modifier? */
5100 if (! (modifiers
& (down_modifier
| drag_modifier
5101 | double_modifier
| triple_modifier
))
5102 && i
+ 7 == STRING_BYTES (name
)
5103 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
5104 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
5105 modifiers
|= click_modifier
;
5113 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5114 prepended to the string BASE[0..BASE_LEN-1].
5115 This doesn't use any caches. */
5117 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5120 int base_len
, base_len_byte
;
5122 /* Since BASE could contain nulls, we can't use intern here; we have
5123 to use Fintern, which expects a genuine Lisp_String, and keeps a
5126 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5132 /* Only the event queue may use the `up' modifier; it should always
5133 be turned into a click or drag event before presented to lisp code. */
5134 if (modifiers
& up_modifier
)
5137 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5138 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5139 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5140 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5141 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5142 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5143 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5144 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5145 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5146 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5147 /* The click modifier is denoted by the absence of other modifiers. */
5151 mod_len
= p
- new_mods
;
5155 Lisp_Object new_name
;
5157 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5158 mod_len
+ base_len_byte
);
5159 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
5160 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
5162 return Fintern (new_name
, Qnil
);
5167 static char *modifier_names
[] =
5169 "up", "down", "drag", "click", "double", "triple", 0, 0,
5170 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5171 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5173 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5175 static Lisp_Object modifier_symbols
;
5177 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5179 lispy_modifier_list (modifiers
)
5182 Lisp_Object modifier_list
;
5185 modifier_list
= Qnil
;
5186 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5187 if (modifiers
& (1<<i
))
5188 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5191 return modifier_list
;
5195 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5196 where UNMODIFIED is the unmodified form of SYMBOL,
5197 MASK is the set of modifiers present in SYMBOL's name.
5198 This is similar to parse_modifiers_uncached, but uses the cache in
5199 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5200 Qevent_symbol_elements property. */
5203 parse_modifiers (symbol
)
5206 Lisp_Object elements
;
5208 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5209 if (CONSP (elements
))
5214 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5215 Lisp_Object unmodified
;
5218 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
5219 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
5222 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
5224 XSETFASTINT (mask
, modifiers
);
5225 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5227 /* Cache the parsing results on SYMBOL. */
5228 Fput (symbol
, Qevent_symbol_element_mask
,
5230 Fput (symbol
, Qevent_symbol_elements
,
5231 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5233 /* Since we know that SYMBOL is modifiers applied to unmodified,
5234 it would be nice to put that in unmodified's cache.
5235 But we can't, since we're not sure that parse_modifiers is
5242 /* Apply the modifiers MODIFIERS to the symbol BASE.
5243 BASE must be unmodified.
5245 This is like apply_modifiers_uncached, but uses BASE's
5246 Qmodifier_cache property, if present. It also builds
5247 Qevent_symbol_elements properties, since it has that info anyway.
5249 apply_modifiers copies the value of BASE's Qevent_kind property to
5250 the modified symbol. */
5252 apply_modifiers (modifiers
, base
)
5256 Lisp_Object cache
, index
, entry
, new_symbol
;
5258 /* Mask out upper bits. We don't know where this value's been. */
5259 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
5261 /* The click modifier never figures into cache indices. */
5262 cache
= Fget (base
, Qmodifier_cache
);
5263 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5264 entry
= assq_no_quit (index
, cache
);
5267 new_symbol
= XCDR (entry
);
5270 /* We have to create the symbol ourselves. */
5271 new_symbol
= apply_modifiers_uncached (modifiers
,
5272 XSYMBOL (base
)->name
->data
,
5273 XSYMBOL (base
)->name
->size
,
5274 STRING_BYTES (XSYMBOL (base
)->name
));
5276 /* Add the new symbol to the base's cache. */
5277 entry
= Fcons (index
, new_symbol
);
5278 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5280 /* We have the parsing info now for free, so add it to the caches. */
5281 XSETFASTINT (index
, modifiers
);
5282 Fput (new_symbol
, Qevent_symbol_element_mask
,
5283 Fcons (base
, Fcons (index
, Qnil
)));
5284 Fput (new_symbol
, Qevent_symbol_elements
,
5285 Fcons (base
, lispy_modifier_list (modifiers
)));
5288 /* Make sure this symbol is of the same kind as BASE.
5290 You'd think we could just set this once and for all when we
5291 intern the symbol above, but reorder_modifiers may call us when
5292 BASE's property isn't set right; we can't assume that just
5293 because it has a Qmodifier_cache property it must have its
5294 Qevent_kind set right as well. */
5295 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5299 kind
= Fget (base
, Qevent_kind
);
5301 Fput (new_symbol
, Qevent_kind
, kind
);
5308 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5309 return a symbol with the modifiers placed in the canonical order.
5310 Canonical order is alphabetical, except for down and drag, which
5311 always come last. The 'click' modifier is never written out.
5313 Fdefine_key calls this to make sure that (for example) C-M-foo
5314 and M-C-foo end up being equivalent in the keymap. */
5317 reorder_modifiers (symbol
)
5320 /* It's hopefully okay to write the code this way, since everything
5321 will soon be in caches, and no consing will be done at all. */
5324 parsed
= parse_modifiers (symbol
);
5325 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5330 /* For handling events, we often want to produce a symbol whose name
5331 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5332 to some base, like the name of a function key or mouse button.
5333 modify_event_symbol produces symbols of this sort.
5335 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5336 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5339 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5340 into symbol names, or a string specifying a name stem used to
5341 contruct a symbol name or the form `STEM-N', where N is the decimal
5342 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5343 non-nil; otherwise NAME_TABLE is used.
5345 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5346 persist between calls to modify_event_symbol that it can use to
5347 store a cache of the symbols it's generated for this NAME_TABLE
5348 before. The object stored there may be a vector or an alist.
5350 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5352 MODIFIERS is a set of modifier bits (as given in struct input_events)
5353 whose prefixes should be applied to the symbol name.
5355 SYMBOL_KIND is the value to be placed in the event_kind property of
5356 the returned symbol.
5358 The symbols we create are supposed to have an
5359 `event-symbol-elements' property, which lists the modifiers present
5360 in the symbol's name. */
5363 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5364 name_table
, symbol_table
, table_size
)
5367 Lisp_Object symbol_kind
;
5368 Lisp_Object name_alist_or_stem
;
5370 Lisp_Object
*symbol_table
;
5371 unsigned int table_size
;
5374 Lisp_Object symbol_int
;
5376 /* Get rid of the "vendor-specific" bit here. */
5377 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5379 /* Is this a request for a valid symbol? */
5380 if (symbol_num
< 0 || symbol_num
>= table_size
)
5383 if (CONSP (*symbol_table
))
5384 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5386 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5387 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5388 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5389 we've never used that symbol before. */
5392 if (! VECTORP (*symbol_table
)
5393 || XVECTOR (*symbol_table
)->size
!= table_size
)
5397 XSETFASTINT (size
, table_size
);
5398 *symbol_table
= Fmake_vector (size
, Qnil
);
5401 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5404 /* Have we already used this symbol before? */
5407 /* No; let's create it. */
5408 if (CONSP (name_alist_or_stem
))
5409 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5410 else if (STRINGP (name_alist_or_stem
))
5412 int len
= STRING_BYTES (XSTRING (name_alist_or_stem
));
5413 char *buf
= (char *) alloca (len
+ 50);
5414 sprintf (buf
, "%s-%d", XSTRING (name_alist_or_stem
)->data
,
5415 XINT (symbol_int
) + 1);
5416 value
= intern (buf
);
5418 else if (name_table
!= 0 && name_table
[symbol_num
])
5419 value
= intern (name_table
[symbol_num
]);
5421 #ifdef HAVE_WINDOW_SYSTEM
5424 char *name
= x_get_keysym_name (symbol_num
);
5426 value
= intern (name
);
5433 sprintf (buf
, "key-%d", symbol_num
);
5434 value
= intern (buf
);
5437 if (CONSP (*symbol_table
))
5438 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5440 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5442 /* Fill in the cache entries for this symbol; this also
5443 builds the Qevent_symbol_elements property, which the user
5445 apply_modifiers (modifiers
& click_modifier
, value
);
5446 Fput (value
, Qevent_kind
, symbol_kind
);
5449 /* Apply modifiers to that symbol. */
5450 return apply_modifiers (modifiers
, value
);
5453 /* Convert a list that represents an event type,
5454 such as (ctrl meta backspace), into the usual representation of that
5455 event type as a number or a symbol. */
5457 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5458 "Convert the event description list EVENT-DESC to an event type.\n\
5459 EVENT-DESC should contain one base event type (a character or symbol)\n\
5460 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
5461 drag, down, double or triple). The base must be last.\n\
5462 The return value is an event type (a character or symbol) which\n\
5463 has the same base event type and all the specified modifiers.")
5465 Lisp_Object event_desc
;
5473 while (CONSP (rest
))
5481 /* Given a symbol, see if it is a modifier name. */
5482 if (SYMBOLP (elt
) && CONSP (rest
))
5483 this = parse_solitary_modifier (elt
);
5487 else if (!NILP (base
))
5488 error ("Two bases given in one event");
5494 /* Let the symbol A refer to the character A. */
5495 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
5496 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
5498 if (INTEGERP (base
))
5500 /* Turn (shift a) into A. */
5501 if ((modifiers
& shift_modifier
) != 0
5502 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
5504 XSETINT (base
, XINT (base
) - ('a' - 'A'));
5505 modifiers
&= ~shift_modifier
;
5508 /* Turn (control a) into C-a. */
5509 if (modifiers
& ctrl_modifier
)
5510 return make_number ((modifiers
& ~ctrl_modifier
)
5511 | make_ctrl_char (XINT (base
)));
5513 return make_number (modifiers
| XINT (base
));
5515 else if (SYMBOLP (base
))
5516 return apply_modifiers (modifiers
, base
);
5518 error ("Invalid base event");
5521 /* Try to recognize SYMBOL as a modifier name.
5522 Return the modifier flag bit, or 0 if not recognized. */
5525 parse_solitary_modifier (symbol
)
5528 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
5530 switch (name
->data
[0])
5532 #define SINGLE_LETTER_MOD(BIT) \
5533 if (STRING_BYTES (name) == 1) \
5536 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5537 if (LEN == STRING_BYTES (name) \
5538 && ! strncmp (name->data, NAME, LEN)) \
5542 SINGLE_LETTER_MOD (alt_modifier
);
5546 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
5550 SINGLE_LETTER_MOD (ctrl_modifier
);
5554 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
5555 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
5559 SINGLE_LETTER_MOD (hyper_modifier
);
5563 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
5567 SINGLE_LETTER_MOD (meta_modifier
);
5571 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
5575 SINGLE_LETTER_MOD (shift_modifier
);
5579 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
5580 MULTI_LETTER_MOD (super_modifier
, "super", 5);
5581 SINGLE_LETTER_MOD (super_modifier
);
5585 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5586 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5587 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5591 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5594 #undef SINGLE_LETTER_MOD
5595 #undef MULTI_LETTER_MOD
5601 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
5602 Such a list is not valid as an event,
5603 but it can be a Lucid-style event type list. */
5606 lucid_event_type_list_p (object
)
5611 if (! CONSP (object
))
5614 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
5618 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5625 /* Store into *addr a value nonzero if terminal input chars are available.
5626 Serves the purpose of ioctl (0, FIONREAD, addr)
5627 but works even if FIONREAD does not exist.
5628 (In fact, this may actually read some input.)
5630 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5633 get_input_pending (addr
, do_timers_now
)
5637 /* First of all, have we already counted some input? */
5638 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5640 /* If input is being read as it arrives, and we have none, there is none. */
5641 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5644 /* Try to read some input and see how much we get. */
5646 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5649 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5652 gobble_input (expected
)
5657 if (interrupt_input
)
5660 mask
= sigblock (sigmask (SIGIO
));
5661 read_avail_input (expected
);
5665 #ifdef POLL_FOR_INPUT
5666 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5669 mask
= sigblock (sigmask (SIGALRM
));
5670 read_avail_input (expected
);
5676 read_avail_input (expected
);
5680 /* Put a buffer_switch_event in the buffer
5681 so that read_key_sequence will notice the new current buffer. */
5684 record_asynch_buffer_change ()
5686 struct input_event event
;
5689 event
.kind
= buffer_switch_event
;
5690 event
.frame_or_window
= Qnil
;
5694 /* We don't need a buffer-switch event unless Emacs is waiting for input.
5695 The purpose of the event is to make read_key_sequence look up the
5696 keymaps again. If we aren't in read_key_sequence, we don't need one,
5697 and the event could cause trouble by messing up (input-pending-p). */
5698 tem
= Fwaiting_for_user_input_p ();
5702 /* We never need these events if we have no asynchronous subprocesses. */
5706 /* Make sure no interrupt happens while storing the event. */
5708 if (interrupt_input
)
5711 mask
= sigblock (sigmask (SIGIO
));
5712 kbd_buffer_store_event (&event
);
5719 kbd_buffer_store_event (&event
);
5726 /* Read any terminal input already buffered up by the system
5727 into the kbd_buffer, but do not wait.
5729 EXPECTED should be nonzero if the caller knows there is some input.
5731 Except on VMS, all input is read by this function.
5732 If interrupt_input is nonzero, this function MUST be called
5733 only when SIGIO is blocked.
5735 Returns the number of keyboard chars read, or -1 meaning
5736 this is a bad time to try to read input. */
5739 read_avail_input (expected
)
5742 struct input_event buf
[KBD_BUFFER_SIZE
];
5746 if (read_socket_hook
)
5747 /* No need for FIONREAD or fcntl; just say don't wait. */
5748 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5751 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5752 the kbd_buffer can really hold. That may prevent loss
5753 of characters on some systems when input is stuffed at us. */
5754 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5757 /* Determine how many characters we should *try* to read. */
5760 #else /* not WINDOWSNT */
5762 n_to_read
= dos_keysns ();
5765 #else /* not MSDOS */
5767 /* Find out how much input is available. */
5768 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5769 /* Formerly simply reported no input, but that sometimes led to
5770 a failure of Emacs to terminate.
5771 SIGHUP seems appropriate if we can't reach the terminal. */
5772 /* ??? Is it really right to send the signal just to this process
5773 rather than to the whole process group?
5774 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5775 kill (getpid (), SIGHUP
);
5778 if (n_to_read
> sizeof cbuf
)
5779 n_to_read
= sizeof cbuf
;
5780 #else /* no FIONREAD */
5781 #if defined (USG) || defined (DGUX)
5782 /* Read some input if available, but don't wait. */
5783 n_to_read
= sizeof cbuf
;
5784 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5789 #endif /* not MSDOS */
5790 #endif /* not WINDOWSNT */
5792 /* Now read; for one reason or another, this will not block.
5793 NREAD is set to the number of chars read. */
5797 cbuf
[0] = dos_keyread ();
5800 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
5802 /* POSIX infers that processes which are not in the session leader's
5803 process group won't get SIGHUP's at logout time. BSDI adheres to
5804 this part standard and returns -1 from read (0) with errno==EIO
5805 when the control tty is taken away.
5806 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5807 if (nread
== -1 && errno
== EIO
)
5809 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5810 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5811 This looks incorrect, but it isn't, because _BSD causes
5812 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5813 and that causes a value other than 0 when there is no input. */
5819 /* We used to retry the read if it was interrupted.
5820 But this does the wrong thing when O_NDELAY causes
5821 an EAGAIN error. Does anybody know of a situation
5822 where a retry is actually needed? */
5824 nread
< 0 && (errno
== EAGAIN
5838 #if defined (USG) || defined (DGUX)
5839 fcntl (input_fd
, F_SETFL
, 0);
5840 #endif /* USG or DGUX */
5841 #endif /* no FIONREAD */
5842 for (i
= 0; i
< nread
; i
++)
5844 buf
[i
].kind
= ascii_keystroke
;
5845 buf
[i
].modifiers
= 0;
5846 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5847 buf
[i
].modifiers
= meta_modifier
;
5851 buf
[i
].code
= cbuf
[i
];
5852 buf
[i
].frame_or_window
= selected_frame
;
5857 /* Scan the chars for C-g and store them in kbd_buffer. */
5858 for (i
= 0; i
< nread
; i
++)
5860 kbd_buffer_store_event (&buf
[i
]);
5861 /* Don't look at input that follows a C-g too closely.
5862 This reduces lossage due to autorepeat on C-g. */
5863 if (buf
[i
].kind
== ascii_keystroke
5864 && buf
[i
].code
== quit_char
)
5870 #endif /* not VMS */
5872 #ifdef SIGIO /* for entire page */
5873 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5876 input_available_signal (signo
)
5879 /* Must preserve main program's value of errno. */
5880 int old_errno
= errno
;
5882 extern int select_alarmed
;
5885 #if defined (USG) && !defined (POSIX_SIGNALS)
5886 /* USG systems forget handlers when they are used;
5887 must reestablish each time */
5888 signal (signo
, input_available_signal
);
5895 if (input_available_clear_time
)
5896 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5901 nread
= read_avail_input (1);
5902 /* -1 means it's not ok to read the input now.
5903 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5904 0 means there was no keyboard input available. */
5909 select_alarmed
= 1; /* Force the select emulator back to life */
5920 /* Send ourselves a SIGIO.
5922 This function exists so that the UNBLOCK_INPUT macro in
5923 blockinput.h can have some way to take care of input we put off
5924 dealing with, without assuming that every file which uses
5925 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5927 reinvoke_input_signal ()
5930 kill (getpid (), SIGIO
);
5936 /* Return the prompt-string of a sparse keymap.
5937 This is the first element which is a string.
5938 Return nil if there is none. */
5946 register Lisp_Object tem
;
5955 static void menu_bar_item ();
5956 static void menu_bar_one_keymap ();
5958 /* These variables hold the vector under construction within
5959 menu_bar_items and its subroutines, and the current index
5960 for storing into that vector. */
5961 static Lisp_Object menu_bar_items_vector
;
5962 static int menu_bar_items_index
;
5964 /* Return a vector of menu items for a menu bar, appropriate
5965 to the current buffer. Each item has three elements in the vector:
5968 OLD is an old vector we can optionally reuse, or nil. */
5971 menu_bar_items (old
)
5974 /* The number of keymaps we're scanning right now, and the number of
5975 keymaps we have allocated space for. */
5978 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5979 in the current keymaps, or nil where it is not a prefix. */
5982 Lisp_Object def
, tem
, tail
;
5991 struct gcpro gcpro1
;
5993 /* In order to build the menus, we need to call the keymap
5994 accessors. They all call QUIT. But this function is called
5995 during redisplay, during which a quit is fatal. So inhibit
5996 quitting while building the menus.
5997 We do this instead of specbind because (1) errors will clear it anyway
5998 and (2) this avoids risk of specpdl overflow. */
5999 oquit
= Vinhibit_quit
;
6003 menu_bar_items_vector
= old
;
6005 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6006 menu_bar_items_index
= 0;
6008 GCPRO1 (menu_bar_items_vector
);
6010 /* Build our list of keymaps.
6011 If we recognize a function key and replace its escape sequence in
6012 keybuf with its symbol, or if the sequence starts with a mouse
6013 click and we need to switch buffers, we jump back here to rebuild
6014 the initial keymaps from the current buffer. */
6018 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6019 if (!NILP (Voverriding_local_map_menu_flag
))
6021 /* Yes, use them (if non-nil) as well as the global map. */
6022 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6024 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6025 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6026 if (!NILP (Voverriding_local_map
))
6027 maps
[nmaps
++] = Voverriding_local_map
;
6031 /* No, so use major and minor mode keymaps and keymap property. */
6033 Lisp_Object map
= get_local_map (PT
, current_buffer
, keymap
);
6036 nmaps
= current_minor_maps (NULL
, &tmaps
);
6037 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
6038 * sizeof (maps
[0]));
6039 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6041 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, keymap
);
6042 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, local_map
);
6044 maps
[nmaps
++] = current_global_map
;
6047 /* Look up in each map the dummy prefix key `menu-bar'. */
6051 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6053 if (! NILP (maps
[mapno
]))
6054 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
6058 tem
= Fkeymapp (def
);
6060 menu_bar_one_keymap (def
);
6063 /* Move to the end those items that should be at the end. */
6065 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6068 int end
= menu_bar_items_index
;
6070 for (i
= 0; i
< end
; i
+= 4)
6071 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6073 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6074 /* Move the item at index I to the end,
6075 shifting all the others forward. */
6076 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6077 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6078 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6079 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6081 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6082 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6083 (end
- i
- 4) * sizeof (Lisp_Object
));
6084 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6085 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6086 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6087 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6092 /* Add nil, nil, nil, nil at the end. */
6093 i
= menu_bar_items_index
;
6094 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6097 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6098 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6099 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6100 menu_bar_items_vector
= tem
;
6102 /* Add this item. */
6103 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6104 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6105 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6106 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6107 menu_bar_items_index
= i
;
6109 Vinhibit_quit
= oquit
;
6111 return menu_bar_items_vector
;
6114 /* Scan one map KEYMAP, accumulating any menu items it defines
6115 in menu_bar_items_vector. */
6117 static Lisp_Object menu_bar_one_keymap_changed_items
;
6120 menu_bar_one_keymap (keymap
)
6123 Lisp_Object tail
, item
;
6125 menu_bar_one_keymap_changed_items
= Qnil
;
6127 /* Loop over all keymap entries that have menu strings. */
6128 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6132 menu_bar_item (XCAR (item
), XCDR (item
));
6133 else if (VECTORP (item
))
6135 /* Loop over the char values represented in the vector. */
6136 int len
= XVECTOR (item
)->size
;
6138 for (c
= 0; c
< len
; c
++)
6140 Lisp_Object character
;
6141 XSETFASTINT (character
, c
);
6142 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6148 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6149 If there's already an item for KEY, add this DEF to it. */
6151 Lisp_Object item_properties
;
6154 menu_bar_item (key
, item
)
6155 Lisp_Object key
, item
;
6157 struct gcpro gcpro1
;
6161 if (EQ (item
, Qundefined
))
6163 /* If a map has an explicit `undefined' as definition,
6164 discard any previously made menu bar item. */
6166 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6167 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6169 if (menu_bar_items_index
> i
+ 4)
6170 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6171 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6172 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6173 menu_bar_items_index
-= 4;
6177 /* If there's no definition for this key yet,
6178 just ignore `undefined'. */
6182 GCPRO1 (key
); /* Is this necessary? */
6183 i
= parse_menu_item (item
, 0, 1);
6188 /* If this keymap has already contributed to this KEY,
6189 don't contribute to it a second time. */
6190 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6194 menu_bar_one_keymap_changed_items
6195 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6197 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6199 /* Find any existing item for this KEY. */
6200 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6201 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6204 /* If we did not find this KEY, add it at the end. */
6205 if (i
== menu_bar_items_index
)
6207 /* If vector is too small, get a bigger one. */
6208 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6211 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6212 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6213 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6214 menu_bar_items_vector
= tem
;
6217 /* Add this item. */
6218 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6219 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6220 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6221 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6222 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6223 menu_bar_items_index
= i
;
6225 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6229 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6230 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6234 /* This is used as the handler when calling menu_item_eval_property. */
6236 menu_item_eval_property_1 (arg
)
6239 /* If we got a quit from within the menu computation,
6240 quit all the way out of it. This takes care of C-] in the debugger. */
6241 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6242 Fsignal (Qquit
, Qnil
);
6247 /* Evaluate an expression and return the result (or nil if something
6248 went wrong). Used to evaluate dynamic parts of menu items. */
6250 menu_item_eval_property (sexpr
)
6253 int count
= specpdl_ptr
- specpdl
;
6255 specbind (Qinhibit_redisplay
, Qt
);
6256 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6257 menu_item_eval_property_1
);
6258 return unbind_to (count
, val
);
6261 /* This function parses a menu item and leaves the result in the
6262 vector item_properties.
6263 ITEM is a key binding, a possible menu item.
6264 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6265 evaluate dynamic expressions in the menu item.
6266 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6268 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6269 parse_menu_item returns true if the item is a menu item and false
6273 parse_menu_item (item
, notreal
, inmenubar
)
6275 int notreal
, inmenubar
;
6277 Lisp_Object def
, tem
, item_string
, start
;
6278 Lisp_Object cachelist
;
6280 Lisp_Object keyhint
;
6291 /* Create item_properties vector if necessary. */
6292 if (NILP (item_properties
))
6294 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6296 /* Initialize optional entries. */
6297 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6298 XVECTOR (item_properties
)->contents
[i
] = Qnil
;
6299 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = Qt
;
6301 /* Save the item here to protect it from GC. */
6302 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ITEM
] = item
;
6304 item_string
= XCAR (item
);
6308 if (STRINGP (item_string
))
6310 /* Old format menu item. */
6311 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
6313 /* Maybe help string. */
6314 if (CONSP (item
) && STRINGP (XCAR (item
)))
6316 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
6322 /* Maybe key binding cache. */
6323 if (CONSP (item
) && CONSP (XCAR (item
))
6324 && (NILP (XCAR (XCAR (item
)))
6325 || VECTORP (XCAR (XCAR (item
)))))
6327 cachelist
= XCAR (item
);
6331 /* This is the real definition--the function to run. */
6332 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = item
;
6334 /* Get enable property, if any. */
6337 tem
= Fget (item
, Qmenu_enable
);
6339 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
6342 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6344 /* New format menu item. */
6345 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
]
6347 start
= XCDR (item
);
6350 /* We have a real binding. */
6351 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
]
6354 item
= XCDR (start
);
6355 /* Is there a cache list with key equivalences. */
6356 if (CONSP (item
) && CONSP (XCAR (item
)))
6358 cachelist
= XCAR (item
);
6362 /* Parse properties. */
6363 while (CONSP (item
) && CONSP (XCDR (item
)))
6368 if (EQ (tem
, QCenable
))
6369 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
]
6371 else if (EQ (tem
, QCvisible
) && !notreal
)
6373 /* If got a visible property and that evaluates to nil
6374 then ignore this item. */
6375 tem
= menu_item_eval_property (XCAR (item
));
6379 else if (EQ (tem
, QChelp
))
6380 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
6382 else if (EQ (tem
, QCfilter
))
6384 else if (EQ (tem
, QCkey_sequence
))
6387 if (NILP (cachelist
)
6388 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6389 /* Be GC protected. Set keyhint to item instead of tem. */
6392 else if (EQ (tem
, QCkeys
))
6395 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6396 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
]
6399 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6404 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6406 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
6408 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
]
6415 else if (inmenubar
|| !NILP (start
))
6419 return 0; /* not a menu item */
6421 /* If item string is not a string, evaluate it to get string.
6422 If we don't get a string, skip this item. */
6423 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6424 if (!(STRINGP (item_string
) || notreal
))
6426 item_string
= menu_item_eval_property (item_string
);
6427 if (!STRINGP (item_string
))
6429 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
6432 /* If got a filter apply it on definition. */
6433 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6436 def
= menu_item_eval_property (list2 (XCAR (filter
),
6437 list2 (Qquote
, def
)));
6439 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = def
;
6442 /* If we got no definition, this item is just unselectable text which
6443 is OK in a submenu but not in the menubar. */
6445 return (inmenubar
? 0 : 1);
6447 /* Enable or disable selection of item. */
6448 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
];
6454 tem
= menu_item_eval_property (tem
);
6455 if (inmenubar
&& NILP (tem
))
6456 return 0; /* Ignore disabled items in menu bar. */
6457 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
6460 /* See if this is a separate pane or a submenu. */
6461 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6462 tem
= get_keymap_1 (def
, 0, 1);
6463 /* For a subkeymap, just record its details and exit. */
6466 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_MAP
] = tem
;
6467 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = tem
;
6470 /* At the top level in the menu bar, do likewise for commands also.
6471 The menu bar does not display equivalent key bindings anyway.
6472 ITEM_PROPERTY_DEF is already set up properly. */
6476 /* This is a command. See if there is an equivalent key binding. */
6477 if (NILP (cachelist
))
6479 /* We have to create a cachelist. */
6480 CHECK_IMPURE (start
);
6481 XCDR (start
) = Fcons (Fcons (Qnil
, Qnil
), XCDR (start
));
6482 cachelist
= XCAR (XCDR (start
));
6484 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6485 if (!NILP (keyhint
))
6487 XCAR (cachelist
) = XCAR (keyhint
);
6490 else if (STRINGP (tem
))
6492 XCDR (cachelist
) = Fsubstitute_command_keys (tem
);
6493 XCAR (cachelist
) = Qt
;
6496 tem
= XCAR (cachelist
);
6503 tem
= Fkey_binding (tem
, Qnil
);
6505 prefix
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6508 def
= XCAR (prefix
);
6509 prefix
= XCDR (prefix
);
6512 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6514 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
6516 if (newcache
/* Always check first time. */
6517 /* Should we check everything when precomputing key
6520 /* If something had no key binding before, don't recheck it
6521 because that is too slow--except if we have a list of
6522 rebound commands in Vdefine_key_rebound_commands, do
6523 recheck any command that appears in that list. */
6524 || (CONSP (Vdefine_key_rebound_commands
)
6525 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
6528 /* We had a saved key. Is it still bound to the command? */
6531 /* If the command is an alias for another
6532 (such as lmenu.el set it up), check if the
6533 original command matches the cached command. */
6534 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
6535 chkcache
= 1; /* Need to recompute key binding. */
6539 /* Recompute equivalent key binding. If the command is an alias
6540 for another (such as lmenu.el set it up), see if the original
6541 command name has equivalent keys. Otherwise look up the
6542 specified command itself. We don't try both, because that
6543 makes lmenu menus slow. */
6544 if (SYMBOLP (def
) && SYMBOLP (XSYMBOL (def
)->function
)
6545 && ! NILP (Fget (def
, Qmenu_alias
)))
6546 def
= XSYMBOL (def
)->function
;
6547 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
6548 XCAR (cachelist
) = tem
;
6551 XCDR (cachelist
) = Qnil
;
6555 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
6557 tem
= XCAR (cachelist
);
6561 newcache
= chkcache
;
6564 tem
= Fkey_description (tem
);
6567 if (STRINGP (XCAR (prefix
)))
6568 tem
= concat2 (XCAR (prefix
), tem
);
6569 if (STRINGP (XCDR (prefix
)))
6570 tem
= concat2 (tem
, XCDR (prefix
));
6572 XCDR (cachelist
) = tem
;
6576 tem
= XCDR (cachelist
);
6577 if (newcache
&& !NILP (tem
))
6579 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
6580 XCDR (cachelist
) = tem
;
6583 /* If we only want to precompute equivalent key bindings, stop here. */
6587 /* If we have an equivalent key binding, use that. */
6588 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
] = tem
;
6590 /* Include this when menu help is implemented.
6591 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
6592 if (!(NILP (tem) || STRINGP (tem)))
6594 tem = menu_item_eval_property (tem);
6597 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
6601 /* Handle radio buttons or toggle boxes. */
6602 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6604 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
6605 = menu_item_eval_property (tem
);
6612 /***********************************************************************
6614 ***********************************************************************/
6616 /* A vector holding tool bar items while they are parsed in function
6617 tool_bar_items runs Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
6620 static Lisp_Object tool_bar_items_vector
;
6622 /* A vector holding the result of parse_tool_bar_item. Layout is like
6623 the one for a single item in tool_bar_items_vector. */
6625 static Lisp_Object tool_bar_item_properties
;
6627 /* Next free index in tool_bar_items_vector. */
6629 static int ntool_bar_items
;
6631 /* The symbols `tool-bar', and `:image'. */
6633 extern Lisp_Object Qtool_bar
;
6634 Lisp_Object QCimage
;
6636 /* Function prototypes. */
6638 static void init_tool_bar_items
P_ ((Lisp_Object
));
6639 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6640 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6641 static void append_tool_bar_item
P_ ((void));
6644 /* Return a vector of tool bar items for keymaps currently in effect.
6645 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
6646 tool bar items found. */
6649 tool_bar_items (reuse
, nitems
)
6657 extern Lisp_Object Voverriding_local_map_menu_flag
;
6658 extern Lisp_Object Voverriding_local_map
;
6662 /* In order to build the menus, we need to call the keymap
6663 accessors. They all call QUIT. But this function is called
6664 during redisplay, during which a quit is fatal. So inhibit
6665 quitting while building the menus. We do this instead of
6666 specbind because (1) errors will clear it anyway and (2) this
6667 avoids risk of specpdl overflow. */
6668 oquit
= Vinhibit_quit
;
6671 /* Initialize tool_bar_items_vector and protect it from GC. */
6672 init_tool_bar_items (reuse
);
6674 /* Build list of keymaps in maps. Set nmaps to the number of maps
6677 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6678 if (!NILP (Voverriding_local_map_menu_flag
))
6680 /* Yes, use them (if non-nil) as well as the global map. */
6681 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6683 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6684 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6685 if (!NILP (Voverriding_local_map
))
6686 maps
[nmaps
++] = Voverriding_local_map
;
6690 /* No, so use major and minor mode keymaps and keymap property. */
6692 Lisp_Object map
= get_local_map (PT
, current_buffer
, keymap
);
6695 nmaps
= current_minor_maps (NULL
, &tmaps
);
6696 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
6697 * sizeof (maps
[0]));
6698 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6700 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, keymap
);
6701 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, local_map
);
6704 /* Add global keymap at the end. */
6705 maps
[nmaps
++] = current_global_map
;
6707 /* Process maps in reverse order and look up in each map the prefix
6709 for (i
= nmaps
- 1; i
>= 0; --i
)
6710 if (!NILP (maps
[i
]))
6714 keymap
= get_keyelt (access_keymap (maps
[i
], Qtool_bar
, 1, 1), 0);
6715 if (!NILP (Fkeymapp (keymap
)))
6719 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
6720 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6722 Lisp_Object keydef
= XCAR (tail
);
6724 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
6729 Vinhibit_quit
= oquit
;
6730 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
6731 return tool_bar_items_vector
;
6735 /* Process the definition of KEY which is DEF. */
6738 process_tool_bar_item (key
, def
)
6739 Lisp_Object key
, def
;
6742 extern Lisp_Object Qundefined
;
6743 struct gcpro gcpro1
, gcpro2
;
6745 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
6749 if (EQ (def
, Qundefined
))
6751 /* If a map has an explicit `undefined' as definition,
6752 discard any previously made item. */
6753 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
6755 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
6757 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
6759 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
6760 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
6761 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
6762 * sizeof (Lisp_Object
)));
6763 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
6768 else if (parse_tool_bar_item (key
, def
))
6769 /* Append a new tool bar item to tool_bar_items_vector. Accept
6770 more than one definition for the same key. */
6771 append_tool_bar_item ();
6777 /* Parse a tool bar item specification ITEM for key KEY and return the
6778 result in tool_bar_item_properties. Value is zero if ITEM is
6781 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
6783 CAPTION is the caption of the item, If it's not a string, it is
6784 evaluated to get a string.
6786 BINDING is the tool bar item's binding. Tool-bar items with keymaps
6787 as binding are currently ignored.
6789 The following properties are recognized:
6793 FORM is evaluated and specifies whether the tool bar item is
6794 enabled or disabled.
6798 FORM is evaluated and specifies whether the tool bar item is visible.
6800 - `:filter FUNCTION'
6802 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
6803 result is stored as the new binding.
6805 - `:button (TYPE SELECTED)'
6807 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
6808 and specifies whether the button is selected (pressed) or not.
6812 IMAGES is either a single image specification or a vector of four
6813 image specifications. See enum tool_bar_item_images.
6815 - `:help HELP-STRING'.
6817 Gives a help string to display for the tool bar item. */
6820 parse_tool_bar_item (key
, item
)
6821 Lisp_Object key
, item
;
6823 /* Access slot with index IDX of vector tool_bar_item_properties. */
6824 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
6826 Lisp_Object filter
= Qnil
;
6827 Lisp_Object caption
;
6828 extern Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
;
6829 extern Lisp_Object QCbutton
, QCtoggle
, QCradio
;
6832 /* Defininition looks like `(tool-bar-item CAPTION BINDING
6833 PROPS...)'. Rule out items that aren't lists, don't start with
6834 `tool-bar-item' or whose rest following `tool-bar-item' is not a
6837 || !EQ (XCAR (item
), Qmenu_item
)
6838 || (item
= XCDR (item
),
6842 /* Create tool_bar_item_properties vector if necessary. Reset it to
6844 if (VECTORP (tool_bar_item_properties
))
6846 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
6850 tool_bar_item_properties
6851 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
6854 PROP (TOOL_BAR_ITEM_KEY
) = key
;
6855 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
6857 /* Get the caption of the item. If the caption is not a string,
6858 evaluate it to get a string. If we don't get a string, skip this
6860 caption
= XCAR (item
);
6861 if (!STRINGP (caption
))
6863 caption
= menu_item_eval_property (caption
);
6864 if (!STRINGP (caption
))
6867 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
6869 /* Give up if rest following the caption is not a list. */
6874 /* Store the binding. */
6875 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
6878 /* Process the rest of the properties. */
6879 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
6881 Lisp_Object key
, value
;
6884 value
= XCAR (XCDR (item
));
6886 if (EQ (key
, QCenable
))
6887 /* `:enable FORM'. */
6888 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
6889 else if (EQ (key
, QCvisible
))
6891 /* `:visible FORM'. If got a visible property and that
6892 evaluates to nil then ignore this item. */
6893 if (NILP (menu_item_eval_property (value
)))
6896 else if (EQ (key
, QChelp
))
6897 /* `:help HELP-STRING'. */
6898 PROP (TOOL_BAR_ITEM_HELP
) = value
;
6899 else if (EQ (key
, QCfilter
))
6900 /* ':filter FORM'. */
6902 else if (EQ (key
, QCbutton
) && CONSP (value
))
6904 /* `:button (TYPE . SELECTED)'. */
6905 Lisp_Object type
, selected
;
6907 type
= XCAR (value
);
6908 selected
= XCDR (value
);
6909 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6911 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
6912 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
6915 else if (EQ (key
, QCimage
)
6917 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
6918 /* Value is either a single image specification or a vector
6919 of 4 such specifications for the different buttion states. */
6920 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
6923 /* If got a filter apply it on binding. */
6925 PROP (TOOL_BAR_ITEM_BINDING
)
6926 = menu_item_eval_property (list2 (filter
,
6928 PROP (TOOL_BAR_ITEM_BINDING
))));
6930 /* See if the binding is a keymap. Give up if it is. */
6931 if (!NILP (get_keymap_1 (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
6934 /* Enable or disable selection of item. */
6935 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
6936 PROP (TOOL_BAR_ITEM_ENABLED_P
)
6937 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
6939 /* Handle radio buttons or toggle boxes. */
6940 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
6941 PROP (TOOL_BAR_ITEM_SELECTED_P
)
6942 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
6950 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
6951 that can be reused. */
6954 init_tool_bar_items (reuse
)
6957 if (VECTORP (reuse
))
6958 tool_bar_items_vector
= reuse
;
6960 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
6961 ntool_bar_items
= 0;
6965 /* Append parsed tool bar item properties from
6966 tool_bar_item_properties */
6969 append_tool_bar_item ()
6971 Lisp_Object
*to
, *from
;
6973 /* Enlarge tool_bar_items_vector if necessary. */
6974 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
6975 >= XVECTOR (tool_bar_items_vector
)->size
)
6977 Lisp_Object new_vector
;
6978 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
6980 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
6981 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
6982 XVECTOR (new_vector
)->contents
,
6983 old_size
* sizeof (Lisp_Object
));
6984 tool_bar_items_vector
= new_vector
;
6987 /* Append entries from tool_bar_item_properties to the end of
6988 tool_bar_items_vector. */
6989 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
6990 from
= XVECTOR (tool_bar_item_properties
)->contents
;
6991 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
6992 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
6999 /* Read a character using menus based on maps in the array MAPS.
7000 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7001 Return t if we displayed a menu but the user rejected it.
7003 PREV_EVENT is the previous input event, or nil if we are reading
7004 the first event of a key sequence.
7006 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7007 if we used a mouse menu to read the input, or zero otherwise. If
7008 USED_MOUSE_MENU is null, we don't dereference it.
7010 The prompting is done based on the prompt-string of the map
7011 and the strings associated with various map elements.
7013 This can be done with X menus or with menus put in the minibuf.
7014 These are done in different ways, depending on how the input will be read.
7015 Menus using X are done after auto-saving in read-char, getting the input
7016 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7017 and do auto-saving in the inner call of read_char. */
7020 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7023 Lisp_Object prev_event
;
7024 int *used_mouse_menu
;
7027 register Lisp_Object name
;
7029 if (used_mouse_menu
)
7030 *used_mouse_menu
= 0;
7032 /* Use local over global Menu maps */
7034 if (! menu_prompting
)
7037 /* Optionally disregard all but the global map. */
7038 if (inhibit_local_menu_bar_menus
)
7040 maps
+= (nmaps
- 1);
7044 /* Get the menu name from the first map that has one (a prompt string). */
7045 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7047 name
= map_prompt (maps
[mapno
]);
7052 /* If we don't have any menus, just read a character normally. */
7057 /* If we got to this point via a mouse click,
7058 use a real menu for mouse selection. */
7059 if (EVENT_HAS_PARAMETERS (prev_event
)
7060 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7061 && !EQ (XCAR (prev_event
), Qtool_bar
))
7063 /* Display the menu and get the selection. */
7064 Lisp_Object
*realmaps
7065 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7069 /* Use the maps that are not nil. */
7070 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7071 if (!NILP (maps
[mapno
]))
7072 realmaps
[nmaps1
++] = maps
[mapno
];
7074 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7079 record_menu_key (XCAR (value
));
7081 /* If we got multiple events, unread all but
7083 There is no way to prevent those unread events
7084 from showing up later in last_nonmenu_event.
7085 So turn symbol and integer events into lists,
7086 to indicate that they came from a mouse menu,
7087 so that when present in last_nonmenu_event
7088 they won't confuse things. */
7089 for (tem
= XCDR (value
); !NILP (tem
);
7092 record_menu_key (XCAR (tem
));
7093 if (SYMBOLP (XCAR (tem
))
7094 || INTEGERP (XCAR (tem
)))
7096 = Fcons (XCAR (tem
), Qnil
);
7099 /* If we got more than one event, put all but the first
7100 onto this list to be read later.
7101 Return just the first event now. */
7102 Vunread_command_events
7103 = nconc2 (XCDR (value
), Vunread_command_events
);
7104 value
= XCAR (value
);
7106 else if (NILP (value
))
7108 if (used_mouse_menu
)
7109 *used_mouse_menu
= 1;
7112 #endif /* HAVE_MENUS */
7116 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7117 We make this bigger when necessary, and never free it. */
7118 static char *read_char_minibuf_menu_text
;
7119 /* Size of that buffer. */
7120 static int read_char_minibuf_menu_width
;
7123 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7129 register Lisp_Object name
;
7131 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7134 Lisp_Object rest
, vector
;
7137 if (! menu_prompting
)
7140 /* Make sure we have a big enough buffer for the menu text. */
7141 if (read_char_minibuf_menu_text
== 0)
7143 read_char_minibuf_menu_width
= width
+ 4;
7144 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7146 else if (width
+ 4 > read_char_minibuf_menu_width
)
7148 read_char_minibuf_menu_width
= width
+ 4;
7149 read_char_minibuf_menu_text
7150 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7152 menu
= read_char_minibuf_menu_text
;
7154 /* Get the menu name from the first map that has one (a prompt string). */
7155 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7157 name
= map_prompt (maps
[mapno
]);
7162 /* If we don't have any menus, just read a character normally. */
7166 /* Prompt string always starts with map's prompt, and a space. */
7167 strcpy (menu
, XSTRING (name
)->data
);
7168 nlength
= STRING_BYTES (XSTRING (name
));
7169 menu
[nlength
++] = ':';
7170 menu
[nlength
++] = ' ';
7173 /* Start prompting at start of first map. */
7177 /* Present the documented bindings, a line at a time. */
7184 Lisp_Object orig_defn_macro
;
7186 /* Loop over elements of map. */
7191 /* If reached end of map, start at beginning of next map. */
7195 /* At end of last map, wrap around to first map if just starting,
7196 or end this line if already have something on it. */
7200 if (notfirst
|| nobindings
) break;
7205 /* Look at the next element of the map. */
7207 elt
= XVECTOR (vector
)->contents
[idx
];
7209 elt
= Fcar_safe (rest
);
7211 if (idx
< 0 && VECTORP (elt
))
7213 /* If we found a dense table in the keymap,
7214 advanced past it, but start scanning its contents. */
7215 rest
= Fcdr_safe (rest
);
7221 /* An ordinary element. */
7222 Lisp_Object event
, tem
;
7226 event
= Fcar_safe (elt
); /* alist */
7227 elt
= Fcdr_safe (elt
);
7231 XSETINT (event
, idx
); /* vector */
7234 /* Ignore the element if it has no prompt string. */
7235 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7237 /* 1 if the char to type matches the string. */
7239 Lisp_Object upcased_event
, downcased_event
;
7242 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7244 upcased_event
= Fupcase (event
);
7245 downcased_event
= Fdowncase (event
);
7246 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
7247 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
7249 desc
= Fsingle_key_description (event
);
7252 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7254 /* Insert equivalent keybinding. */
7255 s
= concat2 (s
, tem
);
7258 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7259 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7261 /* Insert button prefix. */
7262 Lisp_Object selected
7263 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7264 if (EQ (tem
, QCradio
))
7265 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7267 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7268 s
= concat2 (tem
, s
);
7272 /* If we have room for the prompt string, add it to this line.
7273 If this is the first on the line, always add it. */
7274 if ((XSTRING (s
)->size
+ i
+ 2
7275 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
7281 /* Punctuate between strings. */
7284 strcpy (menu
+ i
, ", ");
7290 /* If the char to type doesn't match the string's
7291 first char, explicitly show what char to type. */
7294 /* Add as much of string as fits. */
7295 thiswidth
= XSTRING (desc
)->size
;
7296 if (thiswidth
+ i
> width
)
7297 thiswidth
= width
- i
;
7298 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
7300 strcpy (menu
+ i
, " = ");
7304 /* Add as much of string as fits. */
7305 thiswidth
= XSTRING (s
)->size
;
7306 if (thiswidth
+ i
> width
)
7307 thiswidth
= width
- i
;
7308 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
7314 /* If this element does not fit, end the line now,
7315 and save the element for the next line. */
7316 strcpy (menu
+ i
, "...");
7321 /* Move past this element. */
7322 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7323 /* Handle reaching end of dense table. */
7328 rest
= Fcdr_safe (rest
);
7332 /* Prompt with that and read response. */
7333 message2_nolog (menu
, strlen (menu
),
7334 ! NILP (current_buffer
->enable_multibyte_characters
));
7336 /* Make believe its not a keyboard macro in case the help char
7337 is pressed. Help characters are not recorded because menu prompting
7338 is not used on replay.
7340 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7341 current_kboard
->defining_kbd_macro
= Qnil
;
7343 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
7344 while (BUFFERP (obj
));
7345 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7347 if (!INTEGERP (obj
))
7352 if (! EQ (obj
, menu_prompt_more_char
)
7353 && (!INTEGERP (menu_prompt_more_char
)
7354 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7356 if (!NILP (current_kboard
->defining_kbd_macro
))
7357 store_kbd_macro_char (obj
);
7360 /* Help char - go round again */
7364 /* Reading key sequences. */
7366 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7367 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7368 keymap, or nil otherwise. Return the index of the first keymap in
7369 which KEY has any binding, or NMAPS if no map has a binding.
7371 If KEY is a meta ASCII character, treat it like meta-prefix-char
7372 followed by the corresponding non-meta character. Keymaps in
7373 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7376 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7379 NEXT may be the same array as CURRENT. */
7382 follow_key (key
, nmaps
, current
, defs
, next
)
7384 Lisp_Object
*current
, *defs
, *next
;
7387 int i
, first_binding
;
7390 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
7391 followed by the corresponding non-meta character.
7392 Put the results into DEFS, since we are going to alter that anyway.
7393 Do not alter CURRENT or NEXT. */
7394 if (INTEGERP (key
) && (XUINT (key
) & CHAR_META
))
7396 for (i
= 0; i
< nmaps
; i
++)
7397 if (! NILP (current
[i
]))
7400 def
= get_keyelt (access_keymap (current
[i
],
7401 meta_prefix_char
, 1, 0), 0);
7403 /* Note that since we pass the resulting bindings through
7404 get_keymap_1, non-prefix bindings for meta-prefix-char
7406 defs
[i
] = get_keymap_1 (def
, 0, 1);
7412 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
7415 first_binding
= nmaps
;
7416 for (i
= nmaps
- 1; i
>= 0; i
--)
7418 if (! NILP (current
[i
]))
7426 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 1);
7427 if (! NILP (defs
[i
]))
7434 /* Given the set of bindings we've found, produce the next set of maps. */
7435 if (first_binding
< nmaps
)
7436 for (i
= 0; i
< nmaps
; i
++)
7437 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
7439 return first_binding
;
7442 /* Read a sequence of keys that ends with a non prefix character,
7443 storing it in KEYBUF, a buffer of size BUFSIZE.
7445 Return the length of the key sequence stored.
7446 Return -1 if the user rejected a command menu.
7448 Echo starting immediately unless `prompt' is 0.
7450 Where a key sequence ends depends on the currently active keymaps.
7451 These include any minor mode keymaps active in the current buffer,
7452 the current buffer's local map, and the global map.
7454 If a key sequence has no other bindings, we check Vfunction_key_map
7455 to see if some trailing subsequence might be the beginning of a
7456 function key's sequence. If so, we try to read the whole function
7457 key, and substitute its symbolic name into the key sequence.
7459 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7460 `double-' events into similar click events, if that would make them
7461 bound. We try to turn `triple-' events first into `double-' events,
7464 If we get a mouse click in a mode line, vertical divider, or other
7465 non-text area, we treat the click as if it were prefixed by the
7466 symbol denoting that area - `mode-line', `vertical-line', or
7469 If the sequence starts with a mouse click, we read the key sequence
7470 with respect to the buffer clicked on, not the current buffer.
7472 If the user switches frames in the midst of a key sequence, we put
7473 off the switch-frame event until later; the next call to
7474 read_char will return it.
7476 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7477 from the selected window's buffer. */
7480 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
7481 can_return_switch_frame
, fix_current_buffer
)
7482 Lisp_Object
*keybuf
;
7485 int dont_downcase_last
;
7486 int can_return_switch_frame
;
7487 int fix_current_buffer
;
7489 int count
= specpdl_ptr
- specpdl
;
7491 /* How many keys there are in the current key sequence. */
7494 /* The length of the echo buffer when we started reading, and
7495 the length of this_command_keys when we started reading. */
7499 /* The number of keymaps we're scanning right now, and the number of
7500 keymaps we have allocated space for. */
7502 int nmaps_allocated
= 0;
7504 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
7505 the current keymaps. */
7508 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7509 in the current keymaps, or nil where it is not a prefix. */
7510 Lisp_Object
*submaps
;
7512 /* The local map to start out with at start of key sequence. */
7513 Lisp_Object orig_local_map
;
7515 /* The map from the `keymap' property to start out with at start of
7517 Lisp_Object orig_keymap
;
7519 /* 1 if we have already considered switching to the local-map property
7520 of the place where a mouse click occurred. */
7521 int localized_local_map
= 0;
7523 /* The index in defs[] of the first keymap that has a binding for
7524 this key sequence. In other words, the lowest i such that
7525 defs[i] is non-nil. */
7528 /* If t < mock_input, then KEYBUF[t] should be read as the next
7531 We use this to recover after recognizing a function key. Once we
7532 realize that a suffix of the current key sequence is actually a
7533 function key's escape sequence, we replace the suffix with the
7534 function key's binding from Vfunction_key_map. Now keybuf
7535 contains a new and different key sequence, so the echo area,
7536 this_command_keys, and the submaps and defs arrays are wrong. In
7537 this situation, we set mock_input to t, set t to 0, and jump to
7538 restart_sequence; the loop will read keys from keybuf up until
7539 mock_input, thus rebuilding the state; and then it will resume
7540 reading characters from the keyboard. */
7543 /* If the sequence is unbound in submaps[], then
7544 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
7545 and fkey_map is its binding.
7547 These might be > t, indicating that all function key scanning
7548 should hold off until t reaches them. We do this when we've just
7549 recognized a function key, to avoid searching for the function
7550 key's again in Vfunction_key_map. */
7551 int fkey_start
= 0, fkey_end
= 0;
7552 Lisp_Object fkey_map
;
7554 /* Likewise, for key_translation_map. */
7555 int keytran_start
= 0, keytran_end
= 0;
7556 Lisp_Object keytran_map
;
7558 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
7559 we put it off for later. While we're reading, we keep the event here. */
7560 Lisp_Object delayed_switch_frame
;
7562 /* See the comment below... */
7563 #if defined (GOBBLE_FIRST_EVENT)
7564 Lisp_Object first_event
;
7567 Lisp_Object original_uppercase
;
7568 int original_uppercase_position
= -1;
7570 /* Gets around Microsoft compiler limitations. */
7573 struct buffer
*starting_buffer
;
7575 /* Nonzero if we seem to have got the beginning of a binding
7576 in function_key_map. */
7577 int function_key_possible
= 0;
7578 int key_translation_possible
= 0;
7580 /* Save the status of key translation before each step,
7581 so that we can restore this after downcasing. */
7582 Lisp_Object prev_fkey_map
;
7583 int prev_fkey_start
;
7586 Lisp_Object prev_keytran_map
;
7587 int prev_keytran_start
;
7588 int prev_keytran_end
;
7590 #if defined (GOBBLE_FIRST_EVENT)
7594 raw_keybuf_count
= 0;
7596 last_nonmenu_event
= Qnil
;
7598 delayed_switch_frame
= Qnil
;
7599 fkey_map
= Vfunction_key_map
;
7600 keytran_map
= Vkey_translation_map
;
7602 /* If there is no function-key-map, turn off function key scanning. */
7603 if (NILP (Fkeymapp (Vfunction_key_map
)))
7604 fkey_start
= fkey_end
= bufsize
+ 1;
7606 /* If there is no key-translation-map, turn off scanning. */
7607 if (NILP (Fkeymapp (Vkey_translation_map
)))
7608 keytran_start
= keytran_end
= bufsize
+ 1;
7613 echo_prompt (XSTRING (prompt
)->data
);
7614 else if (cursor_in_echo_area
7615 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
7616 && NILP (Fzerop (Vecho_keystrokes
)))
7617 /* This doesn't put in a dash if the echo buffer is empty, so
7618 you don't always see a dash hanging out in the minibuffer. */
7622 /* Record the initial state of the echo area and this_command_keys;
7623 we will need to restore them if we replay a key sequence. */
7625 echo_start
= echo_length ();
7626 keys_start
= this_command_key_count
;
7627 this_single_command_key_start
= keys_start
;
7629 #if defined (GOBBLE_FIRST_EVENT)
7630 /* This doesn't quite work, because some of the things that read_char
7631 does cannot safely be bypassed. It seems too risky to try to make
7634 /* Read the first char of the sequence specially, before setting
7635 up any keymaps, in case a filter runs and switches buffers on us. */
7636 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
7638 #endif /* GOBBLE_FIRST_EVENT */
7640 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7641 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7643 /* We jump here when the key sequence has been thoroughly changed, and
7644 we need to rescan it starting from the beginning. When we jump here,
7645 keybuf[0..mock_input] holds the sequence we should reread. */
7648 starting_buffer
= current_buffer
;
7649 function_key_possible
= 0;
7650 key_translation_possible
= 0;
7652 /* Build our list of keymaps.
7653 If we recognize a function key and replace its escape sequence in
7654 keybuf with its symbol, or if the sequence starts with a mouse
7655 click and we need to switch buffers, we jump back here to rebuild
7656 the initial keymaps from the current buffer. */
7660 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
7661 || !NILP (Voverriding_local_map
))
7663 if (3 > nmaps_allocated
)
7665 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
7666 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
7667 nmaps_allocated
= 3;
7670 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7671 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7672 if (!NILP (Voverriding_local_map
))
7673 submaps
[nmaps
++] = Voverriding_local_map
;
7678 nmaps
= current_minor_maps (0, &maps
);
7679 if (!NILP (orig_keymap
))
7681 if (nmaps
+ extra_maps
> nmaps_allocated
)
7683 submaps
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7684 * sizeof (submaps
[0]));
7685 defs
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7686 * sizeof (defs
[0]));
7687 nmaps_allocated
= nmaps
+ extra_maps
;
7689 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
7690 if (!NILP (orig_keymap
))
7691 submaps
[nmaps
++] = orig_keymap
;
7692 submaps
[nmaps
++] = orig_local_map
;
7694 submaps
[nmaps
++] = current_global_map
;
7697 /* Find an accurate initial value for first_binding. */
7698 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
7699 if (! NILP (submaps
[first_binding
]))
7702 /* Start from the beginning in keybuf. */
7705 /* These are no-ops the first time through, but if we restart, they
7706 revert the echo area and this_command_keys to their original state. */
7707 this_command_key_count
= keys_start
;
7708 if (INTERACTIVE
&& t
< mock_input
)
7709 echo_truncate (echo_start
);
7711 /* If the best binding for the current key sequence is a keymap, or
7712 we may be looking at a function key's escape sequence, keep on
7714 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
7715 || (first_binding
>= nmaps
7717 /* mock input is never part of a function key's sequence. */
7718 && mock_input
<= fkey_start
)
7719 || (first_binding
>= nmaps
7720 && keytran_start
< t
&& key_translation_possible
)
7721 /* Don't return in the middle of a possible function key sequence,
7722 if the only bindings we found were via case conversion.
7723 Thus, if ESC O a has a function-key-map translation
7724 and ESC o has a binding, don't return after ESC O,
7725 so that we can translate ESC O plus the next character. */
7729 int used_mouse_menu
= 0;
7731 /* Where the last real key started. If we need to throw away a
7732 key that has expanded into more than one element of keybuf
7733 (say, a mouse click on the mode line which is being treated
7734 as [mode-line (mouse-...)], then we backtrack to this point
7736 int last_real_key_start
;
7738 /* These variables are analogous to echo_start and keys_start;
7739 while those allow us to restart the entire key sequence,
7740 echo_local_start and keys_local_start allow us to throw away
7742 int echo_local_start
, keys_local_start
, local_first_binding
;
7745 error ("Key sequence too long");
7748 echo_local_start
= echo_length ();
7749 keys_local_start
= this_command_key_count
;
7750 local_first_binding
= first_binding
;
7753 /* These are no-ops, unless we throw away a keystroke below and
7754 jumped back up to replay_key; in that case, these restore the
7755 variables to their original state, allowing us to replay the
7757 if (INTERACTIVE
&& t
< mock_input
)
7758 echo_truncate (echo_local_start
);
7759 this_command_key_count
= keys_local_start
;
7760 first_binding
= local_first_binding
;
7762 /* By default, assume each event is "real". */
7763 last_real_key_start
= t
;
7765 /* Does mock_input indicate that we are re-reading a key sequence? */
7769 add_command_key (key
);
7770 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
7771 && NILP (Fzerop (Vecho_keystrokes
)))
7775 /* If not, we should actually read a character. */
7780 KBOARD
*interrupted_kboard
= current_kboard
;
7781 struct frame
*interrupted_frame
= SELECTED_FRAME ();
7782 if (setjmp (wrong_kboard_jmpbuf
))
7784 if (!NILP (delayed_switch_frame
))
7786 interrupted_kboard
->kbd_queue
7787 = Fcons (delayed_switch_frame
,
7788 interrupted_kboard
->kbd_queue
);
7789 delayed_switch_frame
= Qnil
;
7792 interrupted_kboard
->kbd_queue
7793 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
7795 /* If the side queue is non-empty, ensure it begins with a
7796 switch-frame, so we'll replay it in the right context. */
7797 if (CONSP (interrupted_kboard
->kbd_queue
)
7798 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
7799 !(EVENT_HAS_PARAMETERS (key
)
7800 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
7804 XSETFRAME (frame
, interrupted_frame
);
7805 interrupted_kboard
->kbd_queue
7806 = Fcons (make_lispy_switch_frame (frame
),
7807 interrupted_kboard
->kbd_queue
);
7810 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7811 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7812 goto replay_sequence
;
7815 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
7819 /* read_char returns t when it shows a menu and the user rejects it.
7823 unbind_to (count
, Qnil
);
7827 /* read_char returns -1 at the end of a macro.
7828 Emacs 18 handles this by returning immediately with a
7829 zero, so that's what we'll do. */
7830 if (INTEGERP (key
) && XINT (key
) == -1)
7833 /* The Microsoft C compiler can't handle the goto that
7839 /* If the current buffer has been changed from under us, the
7840 keymap may have changed, so replay the sequence. */
7844 /* Reset the current buffer from the selected window
7845 in case something changed the former and not the latter.
7846 This is to be more consistent with the behavior
7847 of the command_loop_1. */
7848 if (fix_current_buffer
)
7850 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7852 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
7853 Fset_buffer (XWINDOW (selected_window
)->buffer
);
7856 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7857 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7858 goto replay_sequence
;
7861 /* If we have a quit that was typed in another frame, and
7862 quit_throw_to_read_char switched buffers,
7863 replay to get the right keymap. */
7864 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
7867 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7871 orig_local_map
= get_local_map (PT
, current_buffer
, local_map
);
7872 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7873 goto replay_sequence
;
7878 if (EVENT_HAS_PARAMETERS (key
)
7879 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
7881 /* If we're at the beginning of a key sequence, and the caller
7882 says it's okay, go ahead and return this event. If we're
7883 in the midst of a key sequence, delay it until the end. */
7884 if (t
> 0 || !can_return_switch_frame
)
7886 delayed_switch_frame
= key
;
7892 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7895 /* Clicks in non-text areas get prefixed by the symbol
7896 in their CHAR-ADDRESS field. For example, a click on
7897 the mode line is prefixed by the symbol `mode-line'.
7899 Furthermore, key sequences beginning with mouse clicks
7900 are read using the keymaps of the buffer clicked on, not
7901 the current buffer. So we may have to switch the buffer
7904 When we turn one event into two events, we must make sure
7905 that neither of the two looks like the original--so that,
7906 if we replay the events, they won't be expanded again.
7907 If not for this, such reexpansion could happen either here
7908 or when user programs play with this-command-keys. */
7909 if (EVENT_HAS_PARAMETERS (key
))
7913 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
7914 if (EQ (kind
, Qmouse_click
))
7916 Lisp_Object window
, posn
;
7918 window
= POSN_WINDOW (EVENT_START (key
));
7919 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
7923 /* We're looking at the second event of a
7924 sequence which we expanded before. Set
7925 last_real_key_start appropriately. */
7927 last_real_key_start
= t
- 1;
7930 /* Key sequences beginning with mouse clicks are
7931 read using the keymaps in the buffer clicked on,
7932 not the current buffer. If we're at the
7933 beginning of a key sequence, switch buffers. */
7934 if (last_real_key_start
== 0
7936 && BUFFERP (XWINDOW (window
)->buffer
)
7937 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
7939 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
7943 /* Arrange to go back to the original buffer once we're
7944 done reading the key sequence. Note that we can't
7945 use save_excursion_{save,restore} here, because they
7946 save point as well as the current buffer; we don't
7947 want to save point, because redisplay may change it,
7948 to accommodate a Fset_window_start or something. We
7949 don't want to do this at the top of the function,
7950 because we may get input from a subprocess which
7951 wants to change the selected window and stuff (say,
7953 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
7955 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7957 set_buffer_internal (XBUFFER (XWINDOW
7960 orig_local_map
= get_local_map (PT
, current_buffer
,
7962 orig_keymap
= get_local_map (PT
, current_buffer
, keymap
);
7963 goto replay_sequence
;
7966 /* For a mouse click, get the local text-property keymap
7967 of the place clicked on, rather than point. */
7968 if (last_real_key_start
== 0
7969 && CONSP (XCDR (key
))
7970 && ! localized_local_map
)
7972 Lisp_Object map_here
, start
, pos
;
7974 localized_local_map
= 1;
7975 start
= EVENT_START (key
);
7977 if (CONSP (start
) && CONSP (XCDR (start
)))
7979 pos
= POSN_BUFFER_POSN (start
);
7981 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
7983 map_here
= get_local_map (XINT (pos
),
7984 current_buffer
, local_map
);
7985 if (!EQ (map_here
, orig_local_map
))
7987 orig_local_map
= map_here
;
7991 goto replay_sequence
;
7993 map_here
= get_local_map (XINT (pos
),
7994 current_buffer
, keymap
);
7995 if (!EQ (map_here
, orig_keymap
))
7997 orig_keymap
= map_here
;
8001 goto replay_sequence
;
8007 /* Expand mode-line and scroll-bar events into two events:
8008 use posn as a fake prefix key. */
8011 if (t
+ 1 >= bufsize
)
8012 error ("Key sequence too long");
8017 /* Zap the position in key, so we know that we've
8018 expanded it, and don't try to do so again. */
8019 POSN_BUFFER_POSN (EVENT_START (key
))
8020 = Fcons (posn
, Qnil
);
8022 /* If on a mode line string with a local keymap,
8023 reconsider the key sequence with that keymap. */
8024 if (CONSP (POSN_STRING (EVENT_START (key
))))
8026 Lisp_Object string
, pos
, map
, map2
;
8028 string
= POSN_STRING (EVENT_START (key
));
8029 pos
= XCDR (string
);
8030 string
= XCAR (string
);
8032 && XINT (pos
) < XSTRING (string
)->size
)
8034 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8036 orig_local_map
= map
;
8037 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8040 if (!NILP (map
) || !NILP (map2
))
8041 goto replay_sequence
;
8048 else if (CONSP (XCDR (key
))
8049 && CONSP (EVENT_START (key
))
8050 && CONSP (XCDR (EVENT_START (key
))))
8054 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8055 /* Handle menu-bar events:
8056 insert the dummy prefix event `menu-bar'. */
8057 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8059 if (t
+ 1 >= bufsize
)
8060 error ("Key sequence too long");
8064 /* Zap the position in key, so we know that we've
8065 expanded it, and don't try to do so again. */
8066 POSN_BUFFER_POSN (EVENT_START (key
))
8067 = Fcons (posn
, Qnil
);
8070 goto replay_sequence
;
8072 else if (CONSP (posn
))
8074 /* We're looking at the second event of a
8075 sequence which we expanded before. Set
8076 last_real_key_start appropriately. */
8077 if (last_real_key_start
== t
&& t
> 0)
8078 last_real_key_start
= t
- 1;
8083 /* We have finally decided that KEY is something we might want
8085 first_binding
= (follow_key (key
,
8086 nmaps
- first_binding
,
8087 submaps
+ first_binding
,
8088 defs
+ first_binding
,
8089 submaps
+ first_binding
)
8092 /* If KEY wasn't bound, we'll try some fallbacks. */
8093 if (first_binding
>= nmaps
)
8097 head
= EVENT_HEAD (key
);
8098 if (help_char_p (head
) && t
> 0)
8100 read_key_sequence_cmd
= Vprefix_help_command
;
8102 last_nonmenu_event
= key
;
8103 /* The Microsoft C compiler can't handle the goto that
8111 Lisp_Object breakdown
;
8114 breakdown
= parse_modifiers (head
);
8115 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8116 /* Attempt to reduce an unbound mouse event to a simpler
8117 event that is bound:
8118 Drags reduce to clicks.
8119 Double-clicks reduce to clicks.
8120 Triple-clicks reduce to double-clicks, then to clicks.
8121 Down-clicks are eliminated.
8122 Double-downs reduce to downs, then are eliminated.
8123 Triple-downs reduce to double-downs, then to downs,
8124 then are eliminated. */
8125 if (modifiers
& (down_modifier
| drag_modifier
8126 | double_modifier
| triple_modifier
))
8128 while (modifiers
& (down_modifier
| drag_modifier
8129 | double_modifier
| triple_modifier
))
8131 Lisp_Object new_head
, new_click
;
8132 if (modifiers
& triple_modifier
)
8133 modifiers
^= (double_modifier
| triple_modifier
);
8134 else if (modifiers
& double_modifier
)
8135 modifiers
&= ~double_modifier
;
8136 else if (modifiers
& drag_modifier
)
8137 modifiers
&= ~drag_modifier
;
8140 /* Dispose of this `down' event by simply jumping
8141 back to replay_key, to get another event.
8143 Note that if this event came from mock input,
8144 then just jumping back to replay_key will just
8145 hand it to us again. So we have to wipe out any
8148 We could delete keybuf[t] and shift everything
8149 after that to the left by one spot, but we'd also
8150 have to fix up any variable that points into
8151 keybuf, and shifting isn't really necessary
8154 Adding prefixes for non-textual mouse clicks
8155 creates two characters of mock input, and both
8156 must be thrown away. If we're only looking at
8157 the prefix now, we can just jump back to
8158 replay_key. On the other hand, if we've already
8159 processed the prefix, and now the actual click
8160 itself is giving us trouble, then we've lost the
8161 state of the keymaps we want to backtrack to, and
8162 we need to replay the whole sequence to rebuild
8165 Beyond that, only function key expansion could
8166 create more than two keys, but that should never
8167 generate mouse events, so it's okay to zero
8168 mock_input in that case too.
8170 Isn't this just the most wonderful code ever? */
8171 if (t
== last_real_key_start
)
8178 mock_input
= last_real_key_start
;
8179 goto replay_sequence
;
8184 = apply_modifiers (modifiers
, XCAR (breakdown
));
8186 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8188 /* Look for a binding for this new key. follow_key
8189 promises that it didn't munge submaps the
8190 last time we called it, since key was unbound. */
8192 = (follow_key (new_click
,
8193 nmaps
- local_first_binding
,
8194 submaps
+ local_first_binding
,
8195 defs
+ local_first_binding
,
8196 submaps
+ local_first_binding
)
8197 + local_first_binding
);
8199 /* If that click is bound, go for it. */
8200 if (first_binding
< nmaps
)
8205 /* Otherwise, we'll leave key set to the drag event. */
8212 /* Normally, last_nonmenu_event gets the previous key we read.
8213 But when a mouse popup menu is being used,
8214 we don't update last_nonmenu_event; it continues to hold the mouse
8215 event that preceded the first level of menu. */
8216 if (!used_mouse_menu
)
8217 last_nonmenu_event
= key
;
8219 /* Record what part of this_command_keys is the current key sequence. */
8220 this_single_command_key_start
= this_command_key_count
- t
;
8222 prev_fkey_map
= fkey_map
;
8223 prev_fkey_start
= fkey_start
;
8224 prev_fkey_end
= fkey_end
;
8226 prev_keytran_map
= keytran_map
;
8227 prev_keytran_start
= keytran_start
;
8228 prev_keytran_end
= keytran_end
;
8230 /* If the sequence is unbound, see if we can hang a function key
8231 off the end of it. We only want to scan real keyboard input
8232 for function key sequences, so if mock_input says that we're
8233 re-reading old events, don't examine it. */
8234 if (first_binding
>= nmaps
8237 Lisp_Object fkey_next
;
8239 /* Continue scan from fkey_end until we find a bound suffix.
8240 If we fail, increment fkey_start
8241 and start fkey_end from there. */
8242 while (fkey_end
< t
)
8246 key
= keybuf
[fkey_end
++];
8247 /* Look up meta-characters by prefixing them
8248 with meta_prefix_char. I hate this. */
8249 if (INTEGERP (key
) && XUINT (key
) & meta_modifier
)
8254 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
8256 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
8259 fkey_next
= fkey_map
;
8262 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 1);
8264 /* Handle symbol with autoload definition. */
8265 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8266 && CONSP (XSYMBOL (fkey_next
)->function
)
8267 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8268 do_autoload (XSYMBOL (fkey_next
)->function
,
8271 /* Handle a symbol whose function definition is a keymap
8273 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8274 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8275 || !NILP (Fkeymapp (XSYMBOL (fkey_next
)->function
))))
8276 fkey_next
= XSYMBOL (fkey_next
)->function
;
8278 #if 0 /* I didn't turn this on, because it might cause trouble
8279 for the mapping of return into C-m and tab into C-i. */
8280 /* Optionally don't map function keys into other things.
8281 This enables the user to redefine kp- keys easily. */
8282 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8286 /* If the function key map gives a function, not an
8287 array, then call the function with no args and use
8288 its value instead. */
8289 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8292 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8296 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8297 fkey_next
= call1 (fkey_next
, prompt
);
8299 /* If the function returned something invalid,
8300 barf--don't ignore it.
8301 (To ignore it safely, we would need to gcpro a bunch of
8302 other variables.) */
8303 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8304 error ("Function in key-translation-map returns invalid key sequence");
8307 function_key_possible
= ! NILP (fkey_next
);
8309 /* If keybuf[fkey_start..fkey_end] is bound in the
8310 function key map and it's a suffix of the current
8311 sequence (i.e. fkey_end == t), replace it with
8312 the binding and restart with fkey_start at the end. */
8313 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8316 int len
= XFASTINT (Flength (fkey_next
));
8318 t
= fkey_start
+ len
;
8320 error ("Key sequence too long");
8322 if (VECTORP (fkey_next
))
8323 bcopy (XVECTOR (fkey_next
)->contents
,
8324 keybuf
+ fkey_start
,
8325 (t
- fkey_start
) * sizeof (keybuf
[0]));
8326 else if (STRINGP (fkey_next
))
8330 for (i
= 0; i
< len
; i
++)
8331 XSETFASTINT (keybuf
[fkey_start
+ i
],
8332 XSTRING (fkey_next
)->data
[i
]);
8336 fkey_start
= fkey_end
= t
;
8337 fkey_map
= Vfunction_key_map
;
8339 /* Do pass the results through key-translation-map.
8340 But don't retranslate what key-translation-map
8341 has already translated. */
8342 keytran_end
= keytran_start
;
8343 keytran_map
= Vkey_translation_map
;
8345 goto replay_sequence
;
8348 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
8350 /* If we no longer have a bound suffix, try a new positions for
8352 if (NILP (fkey_map
))
8354 fkey_end
= ++fkey_start
;
8355 fkey_map
= Vfunction_key_map
;
8356 function_key_possible
= 0;
8361 /* Look for this sequence in key-translation-map. */
8363 Lisp_Object keytran_next
;
8365 /* Scan from keytran_end until we find a bound suffix. */
8366 while (keytran_end
< t
)
8370 key
= keybuf
[keytran_end
++];
8371 /* Look up meta-characters by prefixing them
8372 with meta_prefix_char. I hate this. */
8373 if (INTEGERP (key
) && XUINT (key
) & meta_modifier
)
8378 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
8380 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
8383 keytran_next
= keytran_map
;
8386 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 1);
8388 /* Handle symbol with autoload definition. */
8389 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8390 && CONSP (XSYMBOL (keytran_next
)->function
)
8391 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8392 do_autoload (XSYMBOL (keytran_next
)->function
,
8395 /* Handle a symbol whose function definition is a keymap
8397 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8398 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8399 || !NILP (Fkeymapp (XSYMBOL (keytran_next
)->function
))))
8400 keytran_next
= XSYMBOL (keytran_next
)->function
;
8402 /* If the key translation map gives a function, not an
8403 array, then call the function with one arg and use
8404 its value instead. */
8405 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8406 && keytran_end
== t
)
8408 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8412 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8413 keytran_next
= call1 (keytran_next
, prompt
);
8415 /* If the function returned something invalid,
8416 barf--don't ignore it.
8417 (To ignore it safely, we would need to gcpro a bunch of
8418 other variables.) */
8419 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8420 error ("Function in key-translation-map returns invalid key sequence");
8423 key_translation_possible
= ! NILP (keytran_next
);
8425 /* If keybuf[keytran_start..keytran_end] is bound in the
8426 key translation map and it's a suffix of the current
8427 sequence (i.e. keytran_end == t), replace it with
8428 the binding and restart with keytran_start at the end. */
8429 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
8430 && keytran_end
== t
)
8432 int len
= XFASTINT (Flength (keytran_next
));
8434 t
= keytran_start
+ len
;
8436 error ("Key sequence too long");
8438 if (VECTORP (keytran_next
))
8439 bcopy (XVECTOR (keytran_next
)->contents
,
8440 keybuf
+ keytran_start
,
8441 (t
- keytran_start
) * sizeof (keybuf
[0]));
8442 else if (STRINGP (keytran_next
))
8446 for (i
= 0; i
< len
; i
++)
8447 XSETFASTINT (keybuf
[keytran_start
+ i
],
8448 XSTRING (keytran_next
)->data
[i
]);
8452 keytran_start
= keytran_end
= t
;
8453 keytran_map
= Vkey_translation_map
;
8455 /* Don't pass the results of key-translation-map
8456 through function-key-map. */
8457 fkey_start
= fkey_end
= t
;
8458 fkey_map
= Vfunction_key_map
;
8460 goto replay_sequence
;
8463 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
8465 /* If we no longer have a bound suffix, try a new positions for
8467 if (NILP (keytran_map
))
8469 keytran_end
= ++keytran_start
;
8470 keytran_map
= Vkey_translation_map
;
8471 key_translation_possible
= 0;
8476 /* If KEY is not defined in any of the keymaps,
8477 and cannot be part of a function key or translation,
8478 and is an upper case letter
8479 use the corresponding lower-case letter instead. */
8480 if (first_binding
== nmaps
&& ! function_key_possible
8481 && ! key_translation_possible
8483 && ((((XINT (key
) & 0x3ffff)
8484 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
8485 && UPPERCASEP (XINT (key
) & 0x3ffff))
8486 || (XINT (key
) & shift_modifier
)))
8488 Lisp_Object new_key
;
8490 original_uppercase
= key
;
8491 original_uppercase_position
= t
- 1;
8493 if (XINT (key
) & shift_modifier
)
8494 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
8496 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
8497 | (XINT (key
) & ~0x3ffff)));
8499 /* We have to do this unconditionally, regardless of whether
8500 the lower-case char is defined in the keymaps, because they
8501 might get translated through function-key-map. */
8502 keybuf
[t
- 1] = new_key
;
8505 fkey_map
= prev_fkey_map
;
8506 fkey_start
= prev_fkey_start
;
8507 fkey_end
= prev_fkey_end
;
8509 keytran_map
= prev_keytran_map
;
8510 keytran_start
= prev_keytran_start
;
8511 keytran_end
= prev_keytran_end
;
8513 goto replay_sequence
;
8515 /* If KEY is not defined in any of the keymaps,
8516 and cannot be part of a function key or translation,
8517 and is a shifted function key,
8518 use the corresponding unshifted function key instead. */
8519 if (first_binding
== nmaps
&& ! function_key_possible
8520 && ! key_translation_possible
8523 Lisp_Object breakdown
;
8526 breakdown
= parse_modifiers (key
);
8527 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8528 if (modifiers
& shift_modifier
)
8530 Lisp_Object new_key
;
8532 original_uppercase
= key
;
8533 original_uppercase_position
= t
- 1;
8535 modifiers
&= ~shift_modifier
;
8536 new_key
= apply_modifiers (modifiers
,
8539 keybuf
[t
- 1] = new_key
;
8542 fkey_map
= prev_fkey_map
;
8543 fkey_start
= prev_fkey_start
;
8544 fkey_end
= prev_fkey_end
;
8546 keytran_map
= prev_keytran_map
;
8547 keytran_start
= prev_keytran_start
;
8548 keytran_end
= prev_keytran_end
;
8550 goto replay_sequence
;
8556 read_key_sequence_cmd
= (first_binding
< nmaps
8557 ? defs
[first_binding
]
8560 unread_switch_frame
= delayed_switch_frame
;
8561 unbind_to (count
, Qnil
);
8563 /* Don't downcase the last character if the caller says don't.
8564 Don't downcase it if the result is undefined, either. */
8565 if ((dont_downcase_last
|| first_binding
>= nmaps
)
8566 && t
- 1 == original_uppercase_position
)
8567 keybuf
[t
- 1] = original_uppercase
;
8569 /* Occasionally we fabricate events, perhaps by expanding something
8570 according to function-key-map, or by adding a prefix symbol to a
8571 mouse click in the scroll bar or modeline. In this cases, return
8572 the entire generated key sequence, even if we hit an unbound
8573 prefix or a definition before the end. This means that you will
8574 be able to push back the event properly, and also means that
8575 read-key-sequence will always return a logical unit.
8578 for (; t
< mock_input
; t
++)
8580 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8581 && NILP (Fzerop (Vecho_keystrokes
)))
8582 echo_char (keybuf
[t
]);
8583 add_command_key (keybuf
[t
]);
8591 #if 0 /* This doc string is too long for some compilers.
8592 This commented-out definition serves for DOC. */
8593 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
8594 "Read a sequence of keystrokes and return as a string or vector.\n\
8595 The sequence is sufficient to specify a non-prefix command in the\n\
8596 current local and global maps.\n\
8598 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
8599 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
8600 as a continuation of the previous key.\n\
8602 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
8603 convert the last event to lower case. (Normally any upper case event\n\
8604 is converted to lower case if the original event is undefined and the lower\n\
8605 case equivalent is defined.) A non-nil value is appropriate for reading\n\
8606 a key sequence to be defined.\n\
8608 A C-g typed while in this function is treated like any other character,\n\
8609 and `quit-flag' is not set.\n\
8611 If the key sequence starts with a mouse click, then the sequence is read\n\
8612 using the keymaps of the buffer of the window clicked in, not the buffer\n\
8613 of the selected window as normal.\n\
8615 `read-key-sequence' drops unbound button-down events, since you normally\n\
8616 only care about the click or drag events which follow them. If a drag\n\
8617 or multi-click event is unbound, but the corresponding click event would\n\
8618 be bound, `read-key-sequence' turns the event into a click event at the\n\
8619 drag's starting position. This means that you don't have to distinguish\n\
8620 between click and drag, double, or triple events unless you want to.\n\
8622 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
8623 lines separating windows, and scroll bars with imaginary keys\n\
8624 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
8626 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
8627 function will process a switch-frame event if the user switches frames\n\
8628 before typing anything. If the user switches frames in the middle of a\n\
8629 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
8630 is nil, then the event will be put off until after the current key sequence.\n\
8632 `read-key-sequence' checks `function-key-map' for function key\n\
8633 sequences, where they wouldn't conflict with ordinary bindings. See\n\
8634 `function-key-map' for more details.\n\
8636 The optional fifth argument COMMAND-LOOP, if non-nil, means\n\
8637 that this key sequence is being read by something that will\n\
8638 read commands one after another. It should be nil if the caller\n\
8639 will read just one key sequence.")
8640 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
, command
-loop
)
8643 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
8645 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
8647 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
8648 Lisp_Object can_return_switch_frame
, command_loop
;
8650 Lisp_Object keybuf
[30];
8652 struct gcpro gcpro1
;
8653 int count
= specpdl_ptr
- specpdl
;
8656 CHECK_STRING (prompt
, 0);
8659 specbind (Qinput_method_exit_on_first_char
,
8660 (NILP (command_loop
) ? Qt
: Qnil
));
8661 specbind (Qinput_method_use_echo_area
,
8662 (NILP (command_loop
) ? Qt
: Qnil
));
8664 bzero (keybuf
, sizeof keybuf
);
8666 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
8668 if (NILP (continue_echo
))
8670 this_command_key_count
= 0;
8671 this_single_command_key_start
= 0;
8674 #ifdef HAVE_X_WINDOWS
8675 if (display_busy_cursor_p
)
8676 cancel_busy_cursor ();
8679 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
8680 prompt
, ! NILP (dont_downcase_last
),
8681 ! NILP (can_return_switch_frame
), 0);
8683 #ifdef HAVE_X_WINDOWS
8684 if (display_busy_cursor_p
)
8685 start_busy_cursor ();
8694 return unbind_to (count
, make_event_array (i
, keybuf
));
8697 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
8698 Sread_key_sequence_vector
, 1, 5, 0,
8699 "Like `read-key-sequence' but always return a vector.")
8700 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
8702 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
8703 Lisp_Object can_return_switch_frame
, command_loop
;
8705 Lisp_Object keybuf
[30];
8707 struct gcpro gcpro1
;
8708 int count
= specpdl_ptr
- specpdl
;
8711 CHECK_STRING (prompt
, 0);
8714 specbind (Qinput_method_exit_on_first_char
,
8715 (NILP (command_loop
) ? Qt
: Qnil
));
8716 specbind (Qinput_method_use_echo_area
,
8717 (NILP (command_loop
) ? Qt
: Qnil
));
8719 bzero (keybuf
, sizeof keybuf
);
8721 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
8723 if (NILP (continue_echo
))
8725 this_command_key_count
= 0;
8726 this_single_command_key_start
= 0;
8729 #ifdef HAVE_X_WINDOWS
8730 if (display_busy_cursor_p
)
8731 cancel_busy_cursor ();
8734 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
8735 prompt
, ! NILP (dont_downcase_last
),
8736 ! NILP (can_return_switch_frame
), 0);
8738 #ifdef HAVE_X_WINDOWS
8739 if (display_busy_cursor_p
)
8740 start_busy_cursor ();
8749 return unbind_to (count
, Fvector (i
, keybuf
));
8752 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
8753 "Execute CMD as an editor command.\n\
8754 CMD must be a symbol that satisfies the `commandp' predicate.\n\
8755 Optional second arg RECORD-FLAG non-nil\n\
8756 means unconditionally put this command in `command-history'.\n\
8757 Otherwise, that is done only if an arg is read using the minibuffer.\n\
8758 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
8759 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
8760 The argument SPECIAL, if non-nil, means that this command is executing\n\
8761 a special event, so ignore the prefix argument and don't clear it.")
8762 (cmd
, record_flag
, keys
, special
)
8763 Lisp_Object cmd
, record_flag
, keys
, special
;
8765 register Lisp_Object final
;
8766 register Lisp_Object tem
;
8767 Lisp_Object prefixarg
;
8768 struct backtrace backtrace
;
8769 extern int debug_on_next_call
;
8771 debug_on_next_call
= 0;
8775 prefixarg
= current_kboard
->Vprefix_arg
;
8776 Vcurrent_prefix_arg
= prefixarg
;
8777 current_kboard
->Vprefix_arg
= Qnil
;
8784 tem
= Fget (cmd
, Qdisabled
);
8785 if (!NILP (tem
) && !NILP (Vrun_hooks
))
8787 tem
= Fsymbol_value (Qdisabled_command_hook
);
8789 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
8795 final
= Findirect_function (cmd
);
8797 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
8799 struct gcpro gcpro1
, gcpro2
;
8801 GCPRO2 (cmd
, prefixarg
);
8802 do_autoload (final
, cmd
);
8809 if (STRINGP (final
) || VECTORP (final
))
8811 /* If requested, place the macro in the command history. For
8812 other sorts of commands, call-interactively takes care of
8814 if (!NILP (record_flag
))
8817 = Fcons (Fcons (Qexecute_kbd_macro
,
8818 Fcons (final
, Fcons (prefixarg
, Qnil
))),
8821 /* Don't keep command history around forever. */
8822 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
8824 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
8830 return Fexecute_kbd_macro (final
, prefixarg
);
8833 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
8835 backtrace
.next
= backtrace_list
;
8836 backtrace_list
= &backtrace
;
8837 backtrace
.function
= &Qcall_interactively
;
8838 backtrace
.args
= &cmd
;
8839 backtrace
.nargs
= 1;
8840 backtrace
.evalargs
= 0;
8842 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
8844 backtrace_list
= backtrace
.next
;
8850 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
8852 "Read function name, then read its arguments and call it.")
8854 Lisp_Object prefixarg
;
8856 Lisp_Object function
;
8858 Lisp_Object saved_keys
;
8859 Lisp_Object bindings
, value
;
8860 struct gcpro gcpro1
, gcpro2
;
8862 saved_keys
= Fvector (this_command_key_count
,
8863 XVECTOR (this_command_keys
)->contents
);
8865 GCPRO2 (saved_keys
, prefixarg
);
8867 if (EQ (prefixarg
, Qminus
))
8869 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
8870 strcpy (buf
, "C-u ");
8871 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
8873 if (sizeof (int) == sizeof (EMACS_INT
))
8874 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
8875 else if (sizeof (long) == sizeof (EMACS_INT
))
8876 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
8880 else if (INTEGERP (prefixarg
))
8882 if (sizeof (int) == sizeof (EMACS_INT
))
8883 sprintf (buf
, "%d ", XINT (prefixarg
));
8884 else if (sizeof (long) == sizeof (EMACS_INT
))
8885 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
8890 /* This isn't strictly correct if execute-extended-command
8891 is bound to anything else. Perhaps it should use
8892 this_command_keys? */
8893 strcat (buf
, "M-x ");
8895 /* Prompt with buf, and then read a string, completing from and
8896 restricting to the set of all defined commands. Don't provide
8897 any initial input. Save the command read on the extended-command
8899 function
= Fcompleting_read (build_string (buf
),
8900 Vobarray
, Qcommandp
,
8901 Qt
, Qnil
, Qextended_command_history
, Qnil
,
8904 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
8905 error ("No command name given");
8907 /* Set this_command_keys to the concatenation of saved_keys and
8908 function, followed by a RET. */
8910 struct Lisp_String
*str
;
8914 this_command_key_count
= 0;
8915 this_single_command_key_start
= 0;
8917 keys
= XVECTOR (saved_keys
)->contents
;
8918 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
8919 add_command_key (keys
[i
]);
8921 str
= XSTRING (function
);
8922 for (i
= 0; i
< str
->size
; i
++)
8923 add_command_key (Faref (function
, make_number (i
)));
8925 add_command_key (make_number ('\015'));
8930 function
= Fintern (function
, Qnil
);
8931 current_kboard
->Vprefix_arg
= prefixarg
;
8932 Vthis_command
= function
;
8933 real_this_command
= function
;
8935 /* If enabled, show which key runs this command. */
8936 if (!NILP (Vsuggest_key_bindings
)
8937 && NILP (Vexecuting_macro
)
8938 && SYMBOLP (function
))
8939 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
8945 GCPRO2 (bindings
, value
);
8946 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
8948 /* If the command has a key binding, print it now. */
8949 if (!NILP (bindings
)
8950 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
8953 /* But first wait, and skip the message if there is input. */
8955 if (!NILP (echo_area_buffer
[0]))
8956 /* This command displayed something in the echo area;
8957 so wait a few seconds, then display our suggestion message. */
8958 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
8959 ? XINT (Vsuggest_key_bindings
) : 2);
8961 /* This command left the echo area empty,
8962 so display our message immediately. */
8965 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
8966 && ! CONSP (Vunread_command_events
))
8968 Lisp_Object binding
;
8970 int message_p
= push_message ();
8972 binding
= Fkey_description (bindings
);
8975 = (char *) alloca (XSYMBOL (function
)->name
->size
8976 + STRING_BYTES (XSTRING (binding
))
8978 sprintf (newmessage
, "You can run the command `%s' with %s",
8979 XSYMBOL (function
)->name
->data
,
8980 XSTRING (binding
)->data
);
8981 message2_nolog (newmessage
,
8982 strlen (newmessage
),
8983 STRING_MULTIBYTE (binding
));
8984 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
8985 ? Vsuggest_key_bindings
: make_number (2)),
8994 RETURN_UNGCPRO (value
);
8997 /* Find the set of keymaps now active.
8998 Store into *MAPS_P a vector holding the various maps
8999 and return the number of them. The vector was malloc'd
9000 and the caller should free it. */
9003 current_active_maps (maps_p
)
9004 Lisp_Object
**maps_p
;
9006 Lisp_Object
*tmaps
, *maps
;
9009 /* Should overriding-terminal-local-map and overriding-local-map apply? */
9010 if (!NILP (Voverriding_local_map_menu_flag
))
9012 /* Yes, use them (if non-nil) as well as the global map. */
9013 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
9015 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9016 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9017 if (!NILP (Voverriding_local_map
))
9018 maps
[nmaps
++] = Voverriding_local_map
;
9022 /* No, so use major and minor mode keymaps and keymap property. */
9024 Lisp_Object map
= get_local_map (PT
, current_buffer
, keymap
);
9027 nmaps
= current_minor_maps (NULL
, &tmaps
);
9028 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
9029 * sizeof (maps
[0]));
9030 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
9032 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, keymap
);
9033 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, local_map
);
9035 maps
[nmaps
++] = current_global_map
;
9041 /* Return nonzero if input events are pending. */
9044 detect_input_pending ()
9047 get_input_pending (&input_pending
, 0);
9049 return input_pending
;
9052 /* Return nonzero if input events are pending, and run any pending timers. */
9055 detect_input_pending_run_timers (do_display
)
9058 int old_timers_run
= timers_run
;
9061 get_input_pending (&input_pending
, 1);
9063 if (old_timers_run
!= timers_run
&& do_display
)
9065 redisplay_preserve_echo_area ();
9066 /* The following fixes a bug when using lazy-lock with
9067 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9068 from an idle timer function. The symptom of the bug is that
9069 the cursor sometimes doesn't become visible until the next X
9070 event is processed. --gerd. */
9072 rif
->flush_display (NULL
);
9075 return input_pending
;
9078 /* This is called in some cases before a possible quit.
9079 It cases the next call to detect_input_pending to recompute input_pending.
9080 So calling this function unnecessarily can't do any harm. */
9083 clear_input_pending ()
9088 /* Return nonzero if there are pending requeued events.
9089 This isn't used yet. The hope is to make wait_reading_process_input
9090 call it, and return return if it runs Lisp code that unreads something.
9091 The problem is, kbd_buffer_get_event needs to be fixed to know what
9092 to do in that case. It isn't trivial. */
9095 requeued_events_pending_p ()
9097 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9101 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9102 "T if command input is currently available with no waiting.\n\
9103 Actually, the value is nil only if we can be sure that no input is available.")
9106 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9109 get_input_pending (&input_pending
, 1);
9110 return input_pending
> 0 ? Qt
: Qnil
;
9113 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9114 "Return vector of last 100 events, not counting those from keyboard macros.")
9117 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9120 if (total_keys
< NUM_RECENT_KEYS
)
9121 return Fvector (total_keys
, keys
);
9124 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9125 bcopy (keys
+ recent_keys_index
,
9126 XVECTOR (val
)->contents
,
9127 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9129 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9130 recent_keys_index
* sizeof (Lisp_Object
));
9135 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9136 "Return the key sequence that invoked this command.\n\
9137 The value is a string or a vector.")
9140 return make_event_array (this_command_key_count
,
9141 XVECTOR (this_command_keys
)->contents
);
9144 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9145 "Return the key sequence that invoked this command, as a vector.")
9148 return Fvector (this_command_key_count
,
9149 XVECTOR (this_command_keys
)->contents
);
9152 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9153 Sthis_single_command_keys
, 0, 0, 0,
9154 "Return the key sequence that invoked this command.\n\
9155 Unlike `this-command-keys', this function's value\n\
9156 does not include prefix arguments.\n\
9157 The value is always a vector.")
9160 return Fvector (this_command_key_count
9161 - this_single_command_key_start
,
9162 (XVECTOR (this_command_keys
)->contents
9163 + this_single_command_key_start
));
9166 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9167 Sthis_single_command_raw_keys
, 0, 0, 0,
9168 "Return the raw events that were read for this command.\n\
9169 Unlike `this-single-command-keys', this function's value\n\
9170 shows the events before all translations (except for input methods).\n\
9171 The value is always a vector.")
9174 return Fvector (raw_keybuf_count
,
9175 (XVECTOR (raw_keybuf
)->contents
));
9178 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9179 Sreset_this_command_lengths
, 0, 0, 0,
9180 "Used for complicated reasons in `universal-argument-other-key'.\n\
9182 `universal-argument-other-key' rereads the event just typed.\n\
9183 It then gets translated through `function-key-map'.\n\
9184 The translated event gets included in the echo area and in\n\
9185 the value of `this-command-keys' in addition to the raw original event.\n\
9186 That is not right.\n\
9188 Calling this function directs the translated event to replace\n\
9189 the original event, so that only one version of the event actually\n\
9190 appears in the echo area and in the value of `this-command-keys.'.")
9193 before_command_restore_flag
= 1;
9194 before_command_key_count_1
= before_command_key_count
;
9195 before_command_echo_length_1
= before_command_echo_length
;
9199 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9200 Sclear_this_command_keys
, 0, 0, 0,
9201 "Clear out the vector that `this-command-keys' returns.\n\
9202 Clear vector containing last 100 events.")
9207 this_command_key_count
= 0;
9209 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9210 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9212 recent_keys_index
= 0;
9216 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9217 "Return the current depth in recursive edits.")
9221 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9225 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9226 "FOpen dribble file: ",
9227 "Start writing all keyboard characters to a dribble file called FILE.\n\
9228 If FILE is nil, close any open dribble file.")
9239 file
= Fexpand_file_name (file
, Qnil
);
9240 dribble
= fopen (XSTRING (file
)->data
, "w");
9242 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9247 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9248 "Discard the contents of the terminal input buffer.\n\
9249 Also cancel any kbd macro being defined.")
9252 current_kboard
->defining_kbd_macro
= Qnil
;
9253 update_mode_lines
++;
9255 Vunread_command_events
= Qnil
;
9256 unread_command_char
= -1;
9258 discard_tty_input ();
9260 kbd_fetch_ptr
= kbd_store_ptr
;
9261 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9267 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9268 "Stop Emacs and return to superior process. You can resume later.\n\
9269 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
9270 control, run a subshell instead.\n\n\
9271 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
9272 to be read as terminal input by Emacs's parent, after suspension.\n\
9274 Before suspending, run the normal hook `suspend-hook'.\n\
9275 After resumption run the normal hook `suspend-resume-hook'.\n\
9277 Some operating systems cannot stop the Emacs process and resume it later.\n\
9278 On such systems, Emacs starts a subshell instead of suspending.")
9280 Lisp_Object stuffstring
;
9282 int count
= specpdl_ptr
- specpdl
;
9283 int old_height
, old_width
;
9285 struct gcpro gcpro1
;
9287 if (!NILP (stuffstring
))
9288 CHECK_STRING (stuffstring
, 0);
9290 /* Run the functions in suspend-hook. */
9291 if (!NILP (Vrun_hooks
))
9292 call1 (Vrun_hooks
, intern ("suspend-hook"));
9294 GCPRO1 (stuffstring
);
9295 get_frame_size (&old_width
, &old_height
);
9297 /* sys_suspend can get an error if it tries to fork a subshell
9298 and the system resources aren't available for that. */
9299 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9301 stuff_buffered_input (stuffstring
);
9306 unbind_to (count
, Qnil
);
9308 /* Check if terminal/window size has changed.
9309 Note that this is not useful when we are running directly
9310 with a window system; but suspend should be disabled in that case. */
9311 get_frame_size (&width
, &height
);
9312 if (width
!= old_width
|| height
!= old_height
)
9313 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9315 /* Run suspend-resume-hook. */
9316 if (!NILP (Vrun_hooks
))
9317 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9323 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9324 Then in any case stuff anything Emacs has read ahead and not used. */
9327 stuff_buffered_input (stuffstring
)
9328 Lisp_Object stuffstring
;
9330 /* stuff_char works only in BSD, versions 4.2 and up. */
9333 register unsigned char *p
;
9335 if (STRINGP (stuffstring
))
9339 p
= XSTRING (stuffstring
)->data
;
9340 count
= STRING_BYTES (XSTRING (stuffstring
));
9346 /* Anything we have read ahead, put back for the shell to read. */
9347 /* ?? What should this do when we have multiple keyboards??
9348 Should we ignore anything that was typed in at the "wrong" kboard? */
9349 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9353 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9354 kbd_fetch_ptr
= kbd_buffer
;
9355 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
9356 stuff_char (kbd_fetch_ptr
->code
);
9358 kbd_fetch_ptr
->kind
= no_event
;
9359 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9360 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9361 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9366 #endif /* BSD_SYSTEM and not BSD4_1 */
9370 set_waiting_for_input (time_to_clear
)
9371 EMACS_TIME
*time_to_clear
;
9373 input_available_clear_time
= time_to_clear
;
9375 /* Tell interrupt_signal to throw back to read_char, */
9376 waiting_for_input
= 1;
9378 /* If interrupt_signal was called before and buffered a C-g,
9379 make it run again now, to avoid timing error. */
9380 if (!NILP (Vquit_flag
))
9381 quit_throw_to_read_char ();
9385 clear_waiting_for_input ()
9387 /* Tell interrupt_signal not to throw back to read_char, */
9388 waiting_for_input
= 0;
9389 input_available_clear_time
= 0;
9392 /* This routine is called at interrupt level in response to C-G.
9394 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9395 is called from kbd_buffer_store_event, in handling SIGIO or
9398 If `waiting_for_input' is non zero, then unless `echoing' is
9399 nonzero, immediately throw back to read_char.
9401 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9402 eval to throw, when it gets a chance. If quit-flag is already
9403 non-nil, it stops the job right away. */
9406 interrupt_signal (signalnum
) /* If we don't have an argument, */
9407 int signalnum
; /* some compilers complain in signal calls. */
9410 /* Must preserve main program's value of errno. */
9411 int old_errno
= errno
;
9412 struct frame
*sf
= SELECTED_FRAME ();
9414 #if defined (USG) && !defined (POSIX_SIGNALS)
9415 if (!read_socket_hook
&& NILP (Vwindow_system
))
9417 /* USG systems forget handlers when they are used;
9418 must reestablish each time */
9419 signal (SIGINT
, interrupt_signal
);
9420 signal (SIGQUIT
, interrupt_signal
);
9426 if (!NILP (Vquit_flag
)
9427 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9429 /* If SIGINT isn't blocked, don't let us be interrupted by
9430 another SIGINT, it might be harmful due to non-reentrancy
9431 in I/O functions. */
9432 sigblock (sigmask (SIGINT
));
9437 #ifdef SIGTSTP /* Support possible in later USG versions */
9439 * On systems which can suspend the current process and return to the original
9440 * shell, this command causes the user to end up back at the shell.
9441 * The "Auto-save" and "Abort" questions are not asked until
9442 * the user elects to return to emacs, at which point he can save the current
9443 * job and either dump core or continue.
9448 if (sys_suspend () == -1)
9450 printf ("Not running as a subprocess;\n");
9451 printf ("you can continue or abort.\n");
9454 /* Perhaps should really fork an inferior shell?
9455 But that would not provide any way to get back
9456 to the original shell, ever. */
9457 printf ("No support for stopping a process on this operating system;\n");
9458 printf ("you can continue or abort.\n");
9459 #endif /* not VMS */
9460 #endif /* not SIGTSTP */
9462 /* We must remain inside the screen area when the internal terminal
9463 is used. Note that [Enter] is not echoed by dos. */
9466 /* It doesn't work to autosave while GC is in progress;
9467 the code used for auto-saving doesn't cope with the mark bit. */
9468 if (!gc_in_progress
)
9470 printf ("Auto-save? (y or n) ");
9472 if (((c
= getchar ()) & ~040) == 'Y')
9474 Fdo_auto_save (Qt
, Qnil
);
9476 printf ("\r\nAuto-save done");
9477 #else /* not MSDOS */
9478 printf ("Auto-save done\n");
9479 #endif /* not MSDOS */
9481 while (c
!= '\n') c
= getchar ();
9485 /* During GC, it must be safe to reenable quitting again. */
9486 Vinhibit_quit
= Qnil
;
9489 #endif /* not MSDOS */
9490 printf ("Garbage collection in progress; cannot auto-save now\r\n");
9491 printf ("but will instead do a real quit after garbage collection ends\r\n");
9496 printf ("\r\nAbort? (y or n) ");
9497 #else /* not MSDOS */
9499 printf ("Abort (and enter debugger)? (y or n) ");
9501 printf ("Abort (and dump core)? (y or n) ");
9502 #endif /* not VMS */
9503 #endif /* not MSDOS */
9505 if (((c
= getchar ()) & ~040) == 'Y')
9507 while (c
!= '\n') c
= getchar ();
9509 printf ("\r\nContinuing...\r\n");
9510 #else /* not MSDOS */
9511 printf ("Continuing...\n");
9512 #endif /* not MSDOS */
9519 /* If executing a function that wants to be interrupted out of
9520 and the user has not deferred quitting by binding `inhibit-quit'
9521 then quit right away. */
9522 if (immediate_quit
&& NILP (Vinhibit_quit
))
9524 struct gl_state_s saved
;
9525 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9530 GCPRO4 (saved
.object
, saved
.global_code
,
9531 saved
.current_syntax_table
, saved
.old_prop
);
9532 Fsignal (Qquit
, Qnil
);
9537 /* Else request quit when it's safe */
9541 if (waiting_for_input
&& !echoing
)
9542 quit_throw_to_read_char ();
9547 /* Handle a C-g by making read_char return C-g. */
9550 quit_throw_to_read_char ()
9553 /* Prevent another signal from doing this before we finish. */
9554 clear_waiting_for_input ();
9557 Vunread_command_events
= Qnil
;
9558 unread_command_char
= -1;
9560 #if 0 /* Currently, sit_for is called from read_char without turning
9561 off polling. And that can call set_waiting_for_input.
9562 It seems to be harmless. */
9563 #ifdef POLL_FOR_INPUT
9564 /* May be > 1 if in recursive minibuffer. */
9565 if (poll_suppress_count
== 0)
9569 if (FRAMEP (internal_last_event_frame
)
9570 && !EQ (internal_last_event_frame
, selected_frame
))
9571 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
9574 _longjmp (getcjmp
, 1);
9577 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
9578 "Set mode of reading keyboard input.\n\
9579 First arg INTERRUPT non-nil means use input interrupts;\n\
9580 nil means use CBREAK mode.\n\
9581 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
9582 (no effect except in CBREAK mode).\n\
9583 Third arg META t means accept 8-bit input (for a Meta key).\n\
9584 META nil means ignore the top bit, on the assumption it is parity.\n\
9585 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
9586 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
9587 See also `current-input-mode'.")
9588 (interrupt
, flow
, meta
, quit
)
9589 Lisp_Object interrupt
, flow
, meta
, quit
;
9592 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
9593 error ("set-input-mode: QUIT must be an ASCII character");
9595 #ifdef POLL_FOR_INPUT
9600 /* this causes startup screen to be restored and messes with the mouse */
9605 /* Note SIGIO has been undef'd if FIONREAD is missing. */
9606 if (read_socket_hook
)
9608 /* When using X, don't give the user a real choice,
9609 because we haven't implemented the mechanisms to support it. */
9610 #ifdef NO_SOCK_SIGIO
9611 interrupt_input
= 0;
9612 #else /* not NO_SOCK_SIGIO */
9613 interrupt_input
= 1;
9614 #endif /* NO_SOCK_SIGIO */
9617 interrupt_input
= !NILP (interrupt
);
9618 #else /* not SIGIO */
9619 interrupt_input
= 0;
9620 #endif /* not SIGIO */
9622 /* Our VMS input only works by interrupts, as of now. */
9624 interrupt_input
= 1;
9627 flow_control
= !NILP (flow
);
9630 else if (EQ (meta
, Qt
))
9635 /* Don't let this value be out of range. */
9636 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
9642 #ifdef POLL_FOR_INPUT
9643 poll_suppress_count
= 1;
9649 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
9650 "Return information about the way Emacs currently reads keyboard input.\n\
9651 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
9652 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
9653 nil, Emacs is using CBREAK mode.\n\
9654 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
9655 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
9656 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
9657 META nil means ignoring the top bit, on the assumption it is parity.\n\
9658 META is neither t nor nil if accepting 8-bit input and using\n\
9659 all 8 bits as the character code.\n\
9660 QUIT is the character Emacs currently uses to quit.\n\
9661 The elements of this list correspond to the arguments of\n\
9667 val
[0] = interrupt_input
? Qt
: Qnil
;
9668 val
[1] = flow_control
? Qt
: Qnil
;
9669 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
9670 XSETFASTINT (val
[3], quit_char
);
9672 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
9677 * Set up a new kboard object with reasonable initial values.
9683 kb
->Voverriding_terminal_local_map
= Qnil
;
9684 kb
->Vlast_command
= Qnil
;
9685 kb
->Vreal_last_command
= Qnil
;
9686 kb
->Vprefix_arg
= Qnil
;
9687 kb
->Vlast_prefix_arg
= Qnil
;
9688 kb
->kbd_queue
= Qnil
;
9689 kb
->kbd_queue_has_data
= 0;
9690 kb
->immediate_echo
= 0;
9691 kb
->echoptr
= kb
->echobuf
;
9692 kb
->echo_after_prompt
= -1;
9693 kb
->kbd_macro_buffer
= 0;
9694 kb
->kbd_macro_bufsize
= 0;
9695 kb
->defining_kbd_macro
= Qnil
;
9696 kb
->Vlast_kbd_macro
= Qnil
;
9697 kb
->reference_count
= 0;
9698 kb
->Vsystem_key_alist
= Qnil
;
9699 kb
->system_key_syms
= Qnil
;
9700 kb
->Vdefault_minibuffer_frame
= Qnil
;
9704 * Destroy the contents of a kboard object, but not the object itself.
9705 * We use this just before deleting it, or if we're going to initialize
9712 if (kb
->kbd_macro_buffer
)
9713 xfree (kb
->kbd_macro_buffer
);
9722 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
9725 *kbp
= kb
->next_kboard
;
9734 /* This is correct before outermost invocation of the editor loop */
9735 command_loop_level
= -1;
9737 quit_char
= Ctl ('g');
9738 Vunread_command_events
= Qnil
;
9739 unread_command_char
= -1;
9740 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
9742 recent_keys_index
= 0;
9743 kbd_fetch_ptr
= kbd_buffer
;
9744 kbd_store_ptr
= kbd_buffer
;
9745 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
9747 do_mouse_tracking
= Qnil
;
9751 /* This means that command_loop_1 won't try to select anything the first
9753 internal_last_event_frame
= Qnil
;
9754 Vlast_event_frame
= internal_last_event_frame
;
9757 current_kboard
= initial_kboard
;
9759 wipe_kboard (current_kboard
);
9760 init_kboard (current_kboard
);
9763 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9765 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
9766 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
9768 signal (SIGINT
, interrupt_signal
);
9769 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
9770 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
9771 SIGQUIT and we can't tell which one it will give us. */
9772 signal (SIGQUIT
, interrupt_signal
);
9773 #endif /* HAVE_TERMIO */
9775 /* Note SIGIO has been undef'd if FIONREAD is missing. */
9777 if (!noninteractive
)
9778 signal (SIGIO
, input_available_signal
);
9781 /* Use interrupt input by default, if it works and noninterrupt input
9782 has deficiencies. */
9784 #ifdef INTERRUPT_INPUT
9785 interrupt_input
= 1;
9787 interrupt_input
= 0;
9790 /* Our VMS input only works by interrupts, as of now. */
9792 interrupt_input
= 1;
9798 if (keyboard_init_hook
)
9799 (*keyboard_init_hook
) ();
9801 #ifdef POLL_FOR_INPUT
9802 poll_suppress_count
= 1;
9807 /* This type's only use is in syms_of_keyboard, to initialize the
9808 event header symbols and put properties on them. */
9815 struct event_head head_table
[] = {
9816 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
9817 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
9818 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
9819 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
9820 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
9821 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
9827 Vlispy_mouse_stem
= build_string ("mouse");
9828 staticpro (&Vlispy_mouse_stem
);
9831 QCimage
= intern (":image");
9832 staticpro (&QCimage
);
9834 staticpro (&Qhelp_echo
);
9835 Qhelp_echo
= intern ("help-echo");
9837 staticpro (&item_properties
);
9838 item_properties
= Qnil
;
9840 staticpro (&tool_bar_item_properties
);
9841 tool_bar_item_properties
= Qnil
;
9842 staticpro (&tool_bar_items_vector
);
9843 tool_bar_items_vector
= Qnil
;
9845 staticpro (&real_this_command
);
9846 real_this_command
= Qnil
;
9848 Qtimer_event_handler
= intern ("timer-event-handler");
9849 staticpro (&Qtimer_event_handler
);
9851 Qdisabled_command_hook
= intern ("disabled-command-hook");
9852 staticpro (&Qdisabled_command_hook
);
9854 Qself_insert_command
= intern ("self-insert-command");
9855 staticpro (&Qself_insert_command
);
9857 Qforward_char
= intern ("forward-char");
9858 staticpro (&Qforward_char
);
9860 Qbackward_char
= intern ("backward-char");
9861 staticpro (&Qbackward_char
);
9863 Qdisabled
= intern ("disabled");
9864 staticpro (&Qdisabled
);
9866 Qundefined
= intern ("undefined");
9867 staticpro (&Qundefined
);
9869 Qpre_command_hook
= intern ("pre-command-hook");
9870 staticpro (&Qpre_command_hook
);
9872 Qpost_command_hook
= intern ("post-command-hook");
9873 staticpro (&Qpost_command_hook
);
9875 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
9876 staticpro (&Qpost_command_idle_hook
);
9878 Qdeferred_action_function
= intern ("deferred-action-function");
9879 staticpro (&Qdeferred_action_function
);
9881 Qcommand_hook_internal
= intern ("command-hook-internal");
9882 staticpro (&Qcommand_hook_internal
);
9884 Qfunction_key
= intern ("function-key");
9885 staticpro (&Qfunction_key
);
9886 Qmouse_click
= intern ("mouse-click");
9887 staticpro (&Qmouse_click
);
9889 Qmouse_wheel
= intern ("mouse-wheel");
9890 staticpro (&Qmouse_wheel
);
9891 Qlanguage_change
= intern ("language-change");
9892 staticpro (&Qlanguage_change
);
9894 Qdrag_n_drop
= intern ("drag-n-drop");
9895 staticpro (&Qdrag_n_drop
);
9897 Qusr1_signal
= intern ("usr1-signal");
9898 staticpro (&Qusr1_signal
);
9899 Qusr2_signal
= intern ("usr2-signal");
9900 staticpro (&Qusr2_signal
);
9902 Qmenu_enable
= intern ("menu-enable");
9903 staticpro (&Qmenu_enable
);
9904 Qmenu_alias
= intern ("menu-alias");
9905 staticpro (&Qmenu_alias
);
9906 QCenable
= intern (":enable");
9907 staticpro (&QCenable
);
9908 QCvisible
= intern (":visible");
9909 staticpro (&QCvisible
);
9910 QChelp
= intern (":help");
9911 staticpro (&QChelp
);
9912 QCfilter
= intern (":filter");
9913 staticpro (&QCfilter
);
9914 QCbutton
= intern (":button");
9915 staticpro (&QCbutton
);
9916 QCkeys
= intern (":keys");
9917 staticpro (&QCkeys
);
9918 QCkey_sequence
= intern (":key-sequence");
9919 staticpro (&QCkey_sequence
);
9920 QCtoggle
= intern (":toggle");
9921 staticpro (&QCtoggle
);
9922 QCradio
= intern (":radio");
9923 staticpro (&QCradio
);
9925 Qmode_line
= intern ("mode-line");
9926 staticpro (&Qmode_line
);
9927 Qvertical_line
= intern ("vertical-line");
9928 staticpro (&Qvertical_line
);
9929 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
9930 staticpro (&Qvertical_scroll_bar
);
9931 Qmenu_bar
= intern ("menu-bar");
9932 staticpro (&Qmenu_bar
);
9934 Qabove_handle
= intern ("above-handle");
9935 staticpro (&Qabove_handle
);
9936 Qhandle
= intern ("handle");
9937 staticpro (&Qhandle
);
9938 Qbelow_handle
= intern ("below-handle");
9939 staticpro (&Qbelow_handle
);
9940 Qup
= intern ("up");
9942 Qdown
= intern ("down");
9944 Qtop
= intern ("top");
9946 Qbottom
= intern ("bottom");
9947 staticpro (&Qbottom
);
9948 Qend_scroll
= intern ("end-scroll");
9949 staticpro (&Qend_scroll
);
9950 Qratio
= intern ("ratio");
9951 staticpro (&Qratio
);
9953 Qevent_kind
= intern ("event-kind");
9954 staticpro (&Qevent_kind
);
9955 Qevent_symbol_elements
= intern ("event-symbol-elements");
9956 staticpro (&Qevent_symbol_elements
);
9957 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
9958 staticpro (&Qevent_symbol_element_mask
);
9959 Qmodifier_cache
= intern ("modifier-cache");
9960 staticpro (&Qmodifier_cache
);
9962 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
9963 staticpro (&Qrecompute_lucid_menubar
);
9964 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
9965 staticpro (&Qactivate_menubar_hook
);
9967 Qpolling_period
= intern ("polling-period");
9968 staticpro (&Qpolling_period
);
9970 Qinput_method_function
= intern ("input-method-function");
9971 staticpro (&Qinput_method_function
);
9973 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
9974 staticpro (&Qinput_method_exit_on_first_char
);
9975 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
9976 staticpro (&Qinput_method_use_echo_area
);
9978 Fset (Qinput_method_exit_on_first_char
, Qnil
);
9979 Fset (Qinput_method_use_echo_area
, Qnil
);
9982 struct event_head
*p
;
9984 for (p
= head_table
;
9985 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
9988 *p
->var
= intern (p
->name
);
9990 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
9991 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
9995 button_down_location
= Fmake_vector (make_number (1), Qnil
);
9996 staticpro (&button_down_location
);
9997 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
9998 staticpro (&mouse_syms
);
10002 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10004 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10005 for (i
= 0; i
< len
; i
++)
10006 if (modifier_names
[i
])
10007 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10008 staticpro (&modifier_symbols
);
10011 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10012 staticpro (&recent_keys
);
10014 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10015 staticpro (&this_command_keys
);
10017 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10018 staticpro (&raw_keybuf
);
10020 Qextended_command_history
= intern ("extended-command-history");
10021 Fset (Qextended_command_history
, Qnil
);
10022 staticpro (&Qextended_command_history
);
10024 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10025 staticpro (&kbd_buffer_gcpro
);
10027 accent_key_syms
= Qnil
;
10028 staticpro (&accent_key_syms
);
10030 func_key_syms
= Qnil
;
10031 staticpro (&func_key_syms
);
10034 mouse_wheel_syms
= Qnil
;
10035 staticpro (&mouse_wheel_syms
);
10037 drag_n_drop_syms
= Qnil
;
10038 staticpro (&drag_n_drop_syms
);
10041 unread_switch_frame
= Qnil
;
10042 staticpro (&unread_switch_frame
);
10044 internal_last_event_frame
= Qnil
;
10045 staticpro (&internal_last_event_frame
);
10047 read_key_sequence_cmd
= Qnil
;
10048 staticpro (&read_key_sequence_cmd
);
10050 menu_bar_one_keymap_changed_items
= Qnil
;
10051 staticpro (&menu_bar_one_keymap_changed_items
);
10053 defsubr (&Sevent_convert_list
);
10054 defsubr (&Sread_key_sequence
);
10055 defsubr (&Sread_key_sequence_vector
);
10056 defsubr (&Srecursive_edit
);
10058 defsubr (&Strack_mouse
);
10060 defsubr (&Sinput_pending_p
);
10061 defsubr (&Scommand_execute
);
10062 defsubr (&Srecent_keys
);
10063 defsubr (&Sthis_command_keys
);
10064 defsubr (&Sthis_command_keys_vector
);
10065 defsubr (&Sthis_single_command_keys
);
10066 defsubr (&Sthis_single_command_raw_keys
);
10067 defsubr (&Sreset_this_command_lengths
);
10068 defsubr (&Sclear_this_command_keys
);
10069 defsubr (&Ssuspend_emacs
);
10070 defsubr (&Sabort_recursive_edit
);
10071 defsubr (&Sexit_recursive_edit
);
10072 defsubr (&Srecursion_depth
);
10073 defsubr (&Stop_level
);
10074 defsubr (&Sdiscard_input
);
10075 defsubr (&Sopen_dribble_file
);
10076 defsubr (&Sset_input_mode
);
10077 defsubr (&Scurrent_input_mode
);
10078 defsubr (&Sexecute_extended_command
);
10080 DEFVAR_LISP ("last-command-char", &last_command_char
,
10081 "Last input event that was part of a command.");
10083 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10084 "Last input event that was part of a command.");
10086 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10087 "Last input event in a command, except for mouse menu events.\n\
10088 Mouse menus give back keys that don't look like mouse events;\n\
10089 this variable holds the actual mouse event that led to the menu,\n\
10090 so that you can determine whether the command was run by mouse or not.");
10092 DEFVAR_LISP ("last-input-char", &last_input_char
,
10093 "Last input event.");
10095 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10096 "Last input event.");
10098 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10099 "List of events to be read as the command input.\n\
10100 These events are processed first, before actual keyboard input.");
10101 Vunread_command_events
= Qnil
;
10103 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10104 "If not -1, an object to be read as next command input event.");
10106 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10107 "List of events to be processed as input by input methods.\n\
10108 These events are processed after `unread-command-events', but\n\
10109 before actual keyboard input.");
10110 Vunread_post_input_method_events
= Qnil
;
10112 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10113 "List of events to be processed as input by input methods.\n\
10114 These events are processed after `unread-command-events', but\n\
10115 before actual keyboard input.");
10116 Vunread_input_method_events
= Qnil
;
10118 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10119 "Meta-prefix character code.\n\
10120 Meta-foo as command input turns into this character followed by foo.");
10121 XSETINT (meta_prefix_char
, 033);
10123 DEFVAR_KBOARD ("last-command", Vlast_command
,
10124 "The last command executed.\n\
10125 Normally a symbol with a function definition, but can be whatever was found\n\
10126 in the keymap, or whatever the variable `this-command' was set to by that\n\
10129 The value `mode-exit' is special; it means that the previous command\n\
10130 read an event that told it to exit, and it did so and unread that event.\n\
10131 In other words, the present command is the event that made the previous\n\
10134 The value `kill-region' is special; it means that the previous command\n\
10135 was a kill command.");
10137 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10138 "Same as `last-command', but never altered by Lisp code.");
10140 DEFVAR_LISP ("this-command", &Vthis_command
,
10141 "The command now being executed.\n\
10142 The command can set this variable; whatever is put here\n\
10143 will be in `last-command' during the following command.");
10144 Vthis_command
= Qnil
;
10146 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10147 "*Number of input events between auto-saves.\n\
10148 Zero means disable autosaving due to number of characters typed.");
10149 auto_save_interval
= 300;
10151 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10152 "*Number of seconds idle time before auto-save.\n\
10153 Zero or nil means disable auto-saving due to idleness.\n\
10154 After auto-saving due to this many seconds of idle time,\n\
10155 Emacs also does a garbage collection if that seems to be warranted.");
10156 XSETFASTINT (Vauto_save_timeout
, 30);
10158 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10159 "*Nonzero means echo unfinished commands after this many seconds of pause.\n\
10160 The value may be integer or floating point.");
10161 Vecho_keystrokes
= make_number (1);
10163 DEFVAR_INT ("polling-period", &polling_period
,
10164 "*Interval between polling for input during Lisp execution.\n\
10165 The reason for polling is to make C-g work to stop a running program.\n\
10166 Polling is needed only when using X windows and SIGIO does not work.\n\
10167 Polling is automatically disabled in all other cases.");
10168 polling_period
= 2;
10170 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10171 "*Maximum time between mouse clicks to make a double-click.\n\
10172 Measured in milliseconds. nil means disable double-click recognition;\n\
10173 t means double-clicks have no time limit and are detected\n\
10174 by position only.");
10175 Vdouble_click_time
= make_number (500);
10177 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10178 "*Non-nil means inhibit local map menu bar menus.");
10179 inhibit_local_menu_bar_menus
= 0;
10181 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10182 "Number of complete key sequences read as input so far.\n\
10183 This includes key sequences read from keyboard macros.\n\
10184 The number is effectively the number of interactive command invocations.");
10185 num_input_keys
= 0;
10187 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10188 "Number of input events read from the keyboard so far.\n\
10189 This does not include events generated by keyboard macros.");
10190 num_nonmacro_input_events
= 0;
10192 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10193 "The frame in which the most recently read event occurred.\n\
10194 If the last event came from a keyboard macro, this is set to `macro'.");
10195 Vlast_event_frame
= Qnil
;
10197 /* This variable is set up in sysdep.c. */
10198 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10199 "The ERASE character as set by the user with stty.");
10201 DEFVAR_LISP ("help-char", &Vhelp_char
,
10202 "Character to recognize as meaning Help.\n\
10203 When it is read, do `(eval help-form)', and display result if it's a string.\n\
10204 If the value of `help-form' is nil, this char can be read normally.");
10205 XSETINT (Vhelp_char
, Ctl ('H'));
10207 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10208 "List of input events to recognize as meaning Help.\n\
10209 These work just like the value of `help-char' (see that).");
10210 Vhelp_event_list
= Qnil
;
10212 DEFVAR_LISP ("help-form", &Vhelp_form
,
10213 "Form to execute when character `help-char' is read.\n\
10214 If the form returns a string, that string is displayed.\n\
10215 If `help-form' is nil, the help char is not recognized.");
10218 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10219 "Command to run when `help-char' character follows a prefix key.\n\
10220 This command is used only when there is no actual binding\n\
10221 for that character after that prefix key.");
10222 Vprefix_help_command
= Qnil
;
10224 DEFVAR_LISP ("top-level", &Vtop_level
,
10225 "Form to evaluate when Emacs starts up.\n\
10226 Useful to set before you dump a modified Emacs.");
10229 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10230 "Translate table for keyboard input, or nil.\n\
10231 Each character is looked up in this string and the contents used instead.\n\
10232 The value may be a string, a vector, or a char-table.\n\
10233 If it is a string or vector of length N,\n\
10234 character codes N and up are untranslated.\n\
10235 In a vector or a char-table, an element which is nil means \"no translation\".");
10236 Vkeyboard_translate_table
= Qnil
;
10238 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10239 "Non-nil means to always spawn a subshell instead of suspending.\n\
10240 \(Even if the operating system has support for stopping a process.\)");
10241 cannot_suspend
= 0;
10243 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10244 "Non-nil means prompt with menus when appropriate.\n\
10245 This is done when reading from a keymap that has a prompt string,\n\
10246 for elements that have prompt strings.\n\
10247 The menu is displayed on the screen\n\
10248 if X menus were enabled at configuration\n\
10249 time and the previous event was a mouse click prefix key.\n\
10250 Otherwise, menu prompting uses the echo area.");
10251 menu_prompting
= 1;
10253 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10254 "Character to see next line of menu prompt.\n\
10255 Type this character while in a menu prompt to rotate around the lines of it.");
10256 XSETINT (menu_prompt_more_char
, ' ');
10258 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10259 "A mask of additional modifier keys to use with every keyboard character.\n\
10260 Emacs applies the modifiers of the character stored here to each keyboard\n\
10261 character it reads. For example, after evaluating the expression\n\
10262 (setq extra-keyboard-modifiers ?\\C-x)\n\
10263 all input characters will have the control modifier applied to them.\n\
10265 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
10266 not count as a control character; rather, it counts as a character\n\
10267 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
10268 cancels any modification.");
10269 extra_keyboard_modifiers
= 0;
10271 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10272 "If an editing command sets this to t, deactivate the mark afterward.\n\
10273 The command loop sets this to nil before each command,\n\
10274 and tests the value when the command returns.\n\
10275 Buffer modification stores t in this variable.");
10276 Vdeactivate_mark
= Qnil
;
10278 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10279 "Temporary storage of pre-command-hook or post-command-hook.");
10280 Vcommand_hook_internal
= Qnil
;
10282 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10283 "Normal hook run before each command is executed.\n\
10284 If an unhandled error happens in running this hook,\n\
10285 the hook value is set to nil, since otherwise the error\n\
10286 might happen repeatedly and make Emacs nonfunctional.");
10287 Vpre_command_hook
= Qnil
;
10289 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10290 "Normal hook run after each command is executed.\n\
10291 If an unhandled error happens in running this hook,\n\
10292 the hook value is set to nil, since otherwise the error\n\
10293 might happen repeatedly and make Emacs nonfunctional.");
10294 Vpost_command_hook
= Qnil
;
10296 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10297 "Normal hook run after each command is executed, if idle.\n\
10298 Errors running the hook are caught and ignored.\n\
10299 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
10300 Vpost_command_idle_hook
= Qnil
;
10302 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10303 "Delay time before running `post-command-idle-hook'.\n\
10304 This is measured in microseconds.");
10305 post_command_idle_delay
= 100000;
10308 DEFVAR_LISP ("echo-area-clear-hook", ...,
10309 "Normal hook run when clearing the echo area.");
10311 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10312 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
10314 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10315 "t means menu bar, specified Lucid style, needs to be recomputed.");
10316 Vlucid_menu_bar_dirty_flag
= Qnil
;
10318 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10319 "List of menu bar items to move to the end of the menu bar.\n\
10320 The elements of the list are event types that may have menu bar bindings.");
10321 Vmenu_bar_final_items
= Qnil
;
10323 DEFVAR_KBOARD ("overriding-terminal-local-map",
10324 Voverriding_terminal_local_map
,
10325 "Per-terminal keymap that overrides all other local keymaps.\n\
10326 If this variable is non-nil, it is used as a keymap instead of the\n\
10327 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
10328 This variable is intended to let commands such as `universal-argumemnt'\n\
10329 set up a different keymap for reading the next command.");
10331 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10332 "Keymap that overrides all other local keymaps.\n\
10333 If this variable is non-nil, it is used as a keymap instead of the\n\
10334 buffer's local map, and the minor mode keymaps and text property keymaps.");
10335 Voverriding_local_map
= Qnil
;
10337 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10338 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
10339 Otherwise, the menu bar continues to reflect the buffer's local map\n\
10340 and the minor mode maps regardless of `overriding-local-map'.");
10341 Voverriding_local_map_menu_flag
= Qnil
;
10343 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10344 "Keymap defining bindings for special events to execute at low level.");
10345 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10347 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10348 "*Non-nil means generate motion events for mouse motion.");
10350 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10351 "Alist of system-specific X windows key symbols.\n\
10352 Each element should have the form (N . SYMBOL) where N is the\n\
10353 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
10354 and SYMBOL is its name.");
10356 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10357 "List of deferred actions to be performed at a later time.\n\
10358 The precise format isn't relevant here; we just check whether it is nil.");
10359 Vdeferred_action_list
= Qnil
;
10361 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10362 "Function to call to handle deferred actions, after each command.\n\
10363 This function is called with no arguments after each command\n\
10364 whenever `deferred-action-list' is non-nil.");
10365 Vdeferred_action_function
= Qnil
;
10367 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10368 "*Non-nil means show the equivalent key-binding when M-x command has one.\n\
10369 The value can be a length of time to show the message for.\n\
10370 If the value is non-nil and not a number, we wait 2 seconds.");
10371 Vsuggest_key_bindings
= Qt
;
10373 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10374 "List of active absolute time timers in order of increasing time");
10375 Vtimer_list
= Qnil
;
10377 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10378 "List of active idle-time timers in order of increasing time");
10379 Vtimer_idle_list
= Qnil
;
10381 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10382 "If non-nil, the function that implements the current input method.\n\
10383 It's called with one argument, a printing character that was just read.\n\
10384 \(That means a character with code 040...0176.)\n\
10385 Typically this function uses `read-event' to read additional events.\n\
10386 When it does so, it should first bind `input-method-function' to nil\n\
10387 so it will not be called recursively.\n\
10389 The function should return a list of zero or more events\n\
10390 to be used as input. If it wants to put back some events\n\
10391 to be reconsidered, separately, by the input method,\n\
10392 it can add them to the beginning of `unread-command-events'.\n\
10394 The input method function can find in `input-method-previous-method'\n\
10395 the previous echo area message.\n\
10397 The input method function should refer to the variables\n\
10398 `input-method-use-echo-area' and `input-method-exit-on-first-char'\n\
10399 for guidance on what to do.");
10400 Vinput_method_function
= Qnil
;
10402 DEFVAR_LISP ("input-method-previous-message",
10403 &Vinput_method_previous_message
,
10404 "When `input-method-function' is called, hold the previous echo area message.\n\
10405 This variable exists because `read-event' clears the echo area\n\
10406 before running the input method. It is nil if there was no message.");
10407 Vinput_method_previous_message
= Qnil
;
10409 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10410 "If non-nil, the function that implements the display of help.\n\
10411 It's called with one argument, the help string to display.");
10412 Vshow_help_function
= Qnil
;
10414 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10415 "If non-nil, suppress point adjustment after executing a command.\n\
10417 After a command is executed, if point is moved into a region that has\n\
10418 special properties (e.g. composition, display), we adjust point to\n\
10419 the boundary of the region. But, several special commands sets this\n\
10420 variable to non-nil, then we suppress the point adjustment.\n\
10422 This variable is set to nil before reading a command, and is checked\n\
10423 just after executing the command");
10424 Vdisable_point_adjustment
= Qnil
;
10426 DEFVAR_LISP ("global-disable-point-adjustment",
10427 &Vglobal_disable_point_adjustment
,
10428 "*If non-nil, always suppress point adjustment.\n\
10430 The default value is nil, in which case, point adjustment are\n\
10431 suppressed only after special commands that set\n\
10432 `disable-point-adjustment' (which see) to non-nil.");
10433 Vglobal_disable_point_adjustment
= Qnil
;
10437 keys_of_keyboard ()
10439 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
10440 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
10441 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
10442 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
10443 initial_define_key (meta_map
, 'x', "execute-extended-command");
10445 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
10446 "handle-delete-frame");
10447 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
10449 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",