1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
48 #include <sys/ioctl.h>
50 #endif /* not MSDOS */
52 #include "syssignal.h"
55 /* This is to get the definitions of the XK_ symbols. */
62 #endif /* HAVE_NTGUI */
64 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
69 /* Variables for blockinput.h: */
71 /* Non-zero if interrupt input is blocked right now. */
72 int interrupt_input_blocked
;
74 /* Nonzero means an input interrupt has arrived
75 during the current critical section. */
76 int interrupt_input_pending
;
79 /* File descriptor to use for input. */
82 #ifdef HAVE_WINDOW_SYSTEM
83 /* Make all keyboard buffers much bigger when using X windows. */
84 #define KBD_BUFFER_SIZE 4096
85 #else /* No X-windows, character input */
86 #define KBD_BUFFER_SIZE 256
87 #endif /* No X-windows */
89 /* Following definition copied from eval.c */
93 struct backtrace
*next
;
94 Lisp_Object
*function
;
95 Lisp_Object
*args
; /* Points to vector of args. */
96 int nargs
; /* length of vector. If nargs is UNEVALLED,
97 args points to slot holding list of
103 KBOARD
*initial_kboard
;
104 KBOARD
*current_kboard
;
108 KBOARD the_only_kboard
;
111 /* Non-nil disable property on a command means
112 do not execute it; call disabled-command-hook's value instead. */
113 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
115 #define NUM_RECENT_KEYS (100)
116 int recent_keys_index
; /* Index for storing next element into recent_keys */
117 int total_keys
; /* Total number of elements stored into recent_keys */
118 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
120 /* Vector holding the key sequence that invoked the current command.
121 It is reused for each command, and it may be longer than the current
122 sequence; this_command_key_count indicates how many elements
123 actually mean something.
124 It's easier to staticpro a single Lisp_Object than an array. */
125 Lisp_Object this_command_keys
;
126 int this_command_key_count
;
128 /* Record values of this_command_key_count and echo_length ()
129 before this command was read. */
130 static int before_command_key_count
;
131 static int before_command_echo_length
;
132 /* Values of before_command_key_count and before_command_echo_length
133 saved by reset-this-command-lengths. */
134 static int before_command_key_count_1
;
135 static int before_command_echo_length_1
;
136 /* Flag set by reset-this-command-lengths,
137 saying to reset the lengths when add_command_key is called. */
138 static int before_command_restore_flag
;
140 extern int minbuf_level
;
142 extern struct backtrace
*backtrace_list
;
144 /* Nonzero means do menu prompting. */
145 static int menu_prompting
;
147 /* Character to see next line of menu prompt. */
148 static Lisp_Object menu_prompt_more_char
;
150 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
159 /* True means we can start echoing at the next input pause
160 even though there is something in the echo area. */
161 static char *ok_to_echo_at_next_pause
;
163 /* Nonzero means disregard local maps for the menu bar. */
164 static int inhibit_local_menu_bar_menus
;
166 /* Nonzero means C-g should cause immediate error-signal. */
169 /* Character to recognize as the help char. */
170 Lisp_Object Vhelp_char
;
172 /* List of other event types to recognize as meaning "help". */
173 Lisp_Object Vhelp_event_list
;
175 /* Form to execute when help char is typed. */
176 Lisp_Object Vhelp_form
;
178 /* Command to run when the help character follows a prefix key. */
179 Lisp_Object Vprefix_help_command
;
181 /* List of items that should move to the end of the menu bar. */
182 Lisp_Object Vmenu_bar_final_items
;
184 /* Non-nil means show the equivalent key-binding for
185 any M-x command that has one.
186 The value can be a length of time to show the message for.
187 If the value is non-nil and not a number, we wait 2 seconds. */
188 Lisp_Object Vsuggest_key_bindings
;
190 /* Character that causes a quit. Normally C-g.
192 If we are running on an ordinary terminal, this must be an ordinary
193 ASCII char, since we want to make it our interrupt character.
195 If we are not running on an ordinary terminal, it still needs to be
196 an ordinary ASCII char. This character needs to be recognized in
197 the input interrupt handler. At this point, the keystroke is
198 represented as a struct input_event, while the desired quit
199 character is specified as a lispy event. The mapping from struct
200 input_events to lispy events cannot run in an interrupt handler,
201 and the reverse mapping is difficult for anything but ASCII
204 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
208 extern Lisp_Object current_global_map
;
209 extern int minibuf_level
;
211 /* If non-nil, this is a map that overrides all other local maps. */
212 Lisp_Object Voverriding_local_map
;
214 /* If non-nil, Voverriding_local_map applies to the menu bar. */
215 Lisp_Object Voverriding_local_map_menu_flag
;
217 /* Keymap that defines special misc events that should
218 be processed immediately at a low level. */
219 Lisp_Object Vspecial_event_map
;
221 /* Current depth in recursive edits. */
222 int command_loop_level
;
224 /* Total number of times command_loop has read a key sequence. */
227 /* Last input character read as a command. */
228 Lisp_Object last_command_char
;
230 /* Last input character read as a command, not counting menus
231 reached by the mouse. */
232 Lisp_Object last_nonmenu_event
;
234 /* Last input character read for any purpose. */
235 Lisp_Object last_input_char
;
237 /* If not Qnil, a list of objects to be read as subsequent command input. */
238 Lisp_Object Vunread_command_events
;
240 /* If not -1, an event to be read as subsequent command input. */
241 int unread_command_char
;
243 /* If not Qnil, this is a switch-frame event which we decided to put
244 off until the end of a key sequence. This should be read as the
245 next command input, after any unread_command_events.
247 read_key_sequence uses this to delay switch-frame events until the
248 end of the key sequence; Fread_char uses it to put off switch-frame
249 events until a non-ASCII event is acceptable as input. */
250 Lisp_Object unread_switch_frame
;
252 /* A mask of extra modifier bits to put into every keyboard char. */
253 int extra_keyboard_modifiers
;
255 /* Char to use as prefix when a meta character is typed in.
256 This is bound on entry to minibuffer in case ESC is changed there. */
258 Lisp_Object meta_prefix_char
;
260 /* Last size recorded for a current buffer which is not a minibuffer. */
261 static int last_non_minibuf_size
;
263 /* Number of idle seconds before an auto-save and garbage collection. */
264 static Lisp_Object Vauto_save_timeout
;
266 /* Total number of times read_char has returned. */
269 /* Total number of times read_char has returned, outside of macros. */
270 int num_nonmacro_input_chars
;
272 /* Auto-save automatically when this many characters have been typed
273 since the last time. */
275 static int auto_save_interval
;
277 /* Value of num_nonmacro_input_chars as of last auto save. */
281 /* The command being executed by the command loop.
282 Commands may set this, and the value set will be copied into
283 current_kboard->Vlast_command instead of the actual command. */
284 Lisp_Object this_command
;
286 /* The value of point when the last command was executed. */
287 int last_point_position
;
289 /* The buffer that was current when the last command was started. */
290 Lisp_Object last_point_position_buffer
;
293 /* The frame in which the last input event occurred, or Qmacro if the
294 last event came from a macro. We use this to determine when to
295 generate switch-frame events. This may be cleared by functions
296 like Fselect_frame, to make sure that a switch-frame event is
297 generated by the next character. */
298 Lisp_Object internal_last_event_frame
;
301 /* A user-visible version of the above, intended to allow users to
302 figure out where the last event came from, if the event doesn't
303 carry that information itself (i.e. if it was a character). */
304 Lisp_Object Vlast_event_frame
;
306 /* The timestamp of the last input event we received from the X server.
307 X Windows wants this for selection ownership. */
308 unsigned long last_event_timestamp
;
310 Lisp_Object Qself_insert_command
;
311 Lisp_Object Qforward_char
;
312 Lisp_Object Qbackward_char
;
313 Lisp_Object Qundefined
;
315 /* read_key_sequence stores here the command definition of the
316 key sequence that it reads. */
317 Lisp_Object read_key_sequence_cmd
;
319 /* Form to evaluate (if non-nil) when Emacs is started. */
320 Lisp_Object Vtop_level
;
322 /* User-supplied string to translate input characters through. */
323 Lisp_Object Vkeyboard_translate_table
;
325 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
326 extern Lisp_Object Vfunction_key_map
;
328 /* Another keymap that maps key sequences into key sequences.
329 This one takes precedence over ordinary definitions. */
330 extern Lisp_Object Vkey_translation_map
;
332 /* Non-nil means deactivate the mark at end of this command. */
333 Lisp_Object Vdeactivate_mark
;
335 /* Menu bar specified in Lucid Emacs fashion. */
337 Lisp_Object Vlucid_menu_bar_dirty_flag
;
338 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
340 /* Hooks to run before and after each command. */
341 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
342 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
343 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
344 /* Hook run after a command if there's no more input soon. */
345 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
347 /* Delay time in microseconds before running post-command-idle-hook. */
348 int post_command_idle_delay
;
350 /* List of deferred actions to be performed at a later time.
351 The precise format isn't relevant here; we just check whether it is nil. */
352 Lisp_Object Vdeferred_action_list
;
354 /* Function to call to handle deferred actions, when there are any. */
355 Lisp_Object Vdeferred_action_function
;
356 Lisp_Object Qdeferred_action_function
;
358 /* File in which we write all commands we read. */
361 /* Nonzero if input is available. */
364 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
365 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
369 extern char *pending_malloc_warning
;
371 /* Circular buffer for pre-read keyboard input. */
372 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
374 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
376 The interrupt-level event handlers will never enqueue an event on a
377 frame which is not in Vframe_list, and once an event is dequeued,
378 internal_last_event_frame or the event itself points to the frame.
381 But while the event is sitting in the queue, it's completely
382 unprotected. Suppose the user types one command which will run for
383 a while and then delete a frame, and then types another event at
384 the frame that will be deleted, before the command gets around to
385 it. Suppose there are no references to this frame elsewhere in
386 Emacs, and a GC occurs before the second event is dequeued. Now we
387 have an event referring to a freed frame, which will crash Emacs
390 Similar things happen when an event on a scroll bar is enqueued; the
391 window may be deleted while the event is in the queue.
393 So, we use this vector to protect the frame_or_window field in the
394 event queue. That way, they'll be dequeued as dead frames or
395 windows, but still valid lisp objects.
397 If kbd_buffer[i].kind != no_event, then
398 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
399 == kbd_buffer[i].frame_or_window. */
400 static Lisp_Object kbd_buffer_frame_or_window
;
402 /* Pointer to next available character in kbd_buffer.
403 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
404 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
405 next available char is in kbd_buffer[0]. */
406 static struct input_event
*kbd_fetch_ptr
;
408 /* Pointer to next place to store character in kbd_buffer. This
409 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
410 character should go in kbd_buffer[0]. */
411 static volatile struct input_event
*kbd_store_ptr
;
413 /* The above pair of variables forms a "queue empty" flag. When we
414 enqueue a non-hook event, we increment kbd_store_ptr. When we
415 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
416 there is input available iff the two pointers are not equal.
418 Why not just have a flag set and cleared by the enqueuing and
419 dequeuing functions? Such a flag could be screwed up by interrupts
420 at inopportune times. */
422 /* If this flag is non-nil, we check mouse_moved to see when the
423 mouse moves, and motion events will appear in the input stream.
424 Otherwise, mouse motion is ignored. */
425 static Lisp_Object do_mouse_tracking
;
427 /* Symbols to head events. */
428 Lisp_Object Qmouse_movement
;
429 Lisp_Object Qscroll_bar_movement
;
430 Lisp_Object Qswitch_frame
;
431 Lisp_Object Qdelete_frame
;
432 Lisp_Object Qiconify_frame
;
433 Lisp_Object Qmake_frame_visible
;
435 /* Symbols to denote kinds of events. */
436 Lisp_Object Qfunction_key
;
437 Lisp_Object Qmouse_click
;
438 Lisp_Object Qtimer_event
;
439 /* Lisp_Object Qmouse_movement; - also an event header */
441 /* Properties of event headers. */
442 Lisp_Object Qevent_kind
;
443 Lisp_Object Qevent_symbol_elements
;
445 Lisp_Object Qmenu_enable
;
447 /* An event header symbol HEAD may have a property named
448 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
449 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
450 mask of modifiers applied to it. If present, this is used to help
451 speed up parse_modifiers. */
452 Lisp_Object Qevent_symbol_element_mask
;
454 /* An unmodified event header BASE may have a property named
455 Qmodifier_cache, which is an alist mapping modifier masks onto
456 modified versions of BASE. If present, this helps speed up
458 Lisp_Object Qmodifier_cache
;
460 /* Symbols to use for parts of windows. */
461 Lisp_Object Qmode_line
;
462 Lisp_Object Qvertical_line
;
463 Lisp_Object Qvertical_scroll_bar
;
464 Lisp_Object Qmenu_bar
;
466 extern Lisp_Object Qmenu_enable
;
468 Lisp_Object
recursive_edit_unwind (), command_loop ();
469 Lisp_Object
Fthis_command_keys ();
470 Lisp_Object Qextended_command_history
;
471 EMACS_TIME
timer_check ();
473 extern char *x_get_keysym_name ();
475 Lisp_Object Qpolling_period
;
477 /* List of absolute timers. Appears in order of next scheduled event. */
478 Lisp_Object Vtimer_list
;
480 /* List of idle time timers. Appears in order of next scheduled event. */
481 Lisp_Object Vtimer_idle_list
;
483 extern Lisp_Object Vprint_level
, Vprint_length
;
485 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
487 EMACS_TIME
*input_available_clear_time
;
489 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
490 Default is 1 if INTERRUPT_INPUT is defined. */
493 /* Nonzero while interrupts are temporarily deferred during redisplay. */
494 int interrupts_deferred
;
496 /* nonzero means use ^S/^Q for flow control. */
499 /* Allow m- file to inhibit use of FIONREAD. */
500 #ifdef BROKEN_FIONREAD
504 /* We are unable to use interrupts if FIONREAD is not available,
505 so flush SIGIO so we won't try. */
512 /* If we support a window system, turn on the code to poll periodically
513 to detect C-g. It isn't actually used when doing interrupt input. */
514 #ifdef HAVE_WINDOW_SYSTEM
515 #define POLL_FOR_INPUT
518 /* Non-nil enables Column Number mode. */
519 Lisp_Object Vcolumn_number_mode
;
521 /* Global variable declarations. */
523 /* Function for init_keyboard to call with no args (if nonzero). */
524 void (*keyboard_init_hook
) ();
526 static int read_avail_input ();
527 static void get_input_pending ();
528 static int readable_events ();
529 static Lisp_Object
read_char_x_menu_prompt ();
530 static Lisp_Object
read_char_minibuf_menu_prompt ();
531 static Lisp_Object
make_lispy_event ();
533 static Lisp_Object
make_lispy_movement ();
535 static Lisp_Object
modify_event_symbol ();
536 static Lisp_Object
make_lispy_switch_frame ();
537 static int parse_solitary_modifier ();
539 /* > 0 if we are to echo keystrokes. */
540 static int echo_keystrokes
;
542 /* Nonzero means don't try to suspend even if the operating system seems
544 static int cannot_suspend
;
546 #define min(a,b) ((a)<(b)?(a):(b))
547 #define max(a,b) ((a)>(b)?(a):(b))
549 /* Install the string STR as the beginning of the string of echoing,
550 so that it serves as a prompt for the next character.
551 Also start echoing. */
556 int len
= strlen (str
);
558 if (len
> ECHOBUFSIZE
- 4)
559 len
= ECHOBUFSIZE
- 4;
560 bcopy (str
, current_kboard
->echobuf
, len
);
561 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
562 *current_kboard
->echoptr
= '\0';
564 current_kboard
->echo_after_prompt
= len
;
569 /* Add C to the echo string, if echoing is going on.
570 C can be a character, which is printed prettily ("M-C-x" and all that
571 jazz), or a symbol, whose name is printed. */
576 extern char *push_key_description ();
578 if (current_kboard
->immediate_echo
)
580 char *ptr
= current_kboard
->echoptr
;
582 if (ptr
!= current_kboard
->echobuf
)
585 /* If someone has passed us a composite event, use its head symbol. */
590 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
593 ptr
= push_key_description (XINT (c
), ptr
);
595 else if (SYMBOLP (c
))
597 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
598 if ((ptr
- current_kboard
->echobuf
) + name
->size
+ 4 > ECHOBUFSIZE
)
600 bcopy (name
->data
, ptr
, name
->size
);
604 if (current_kboard
->echoptr
== current_kboard
->echobuf
607 strcpy (ptr
, " (Type ? for further options)");
612 current_kboard
->echoptr
= ptr
;
618 /* Temporarily add a dash to the end of the echo string if it's not
619 empty, so that it serves as a mini-prompt for the very next character. */
623 if (!current_kboard
->immediate_echo
624 && current_kboard
->echoptr
== current_kboard
->echobuf
)
626 /* Do nothing if we just printed a prompt. */
627 if (current_kboard
->echo_after_prompt
628 == current_kboard
->echoptr
- current_kboard
->echobuf
)
630 /* Do nothing if not echoing at all. */
631 if (current_kboard
->echoptr
== 0)
634 /* Put a dash at the end of the buffer temporarily,
635 but make it go away when the next character is added. */
636 current_kboard
->echoptr
[0] = '-';
637 current_kboard
->echoptr
[1] = 0;
642 /* Display the current echo string, and begin echoing if not already
647 if (!current_kboard
->immediate_echo
)
650 current_kboard
->immediate_echo
= 1;
652 for (i
= 0; i
< this_command_key_count
; i
++)
655 c
= XVECTOR (this_command_keys
)->contents
[i
];
656 if (! (EVENT_HAS_PARAMETERS (c
)
657 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
664 message1_nolog (current_kboard
->echobuf
);
667 if (waiting_for_input
&& !NILP (Vquit_flag
))
668 quit_throw_to_read_char ();
671 /* Turn off echoing, for the start of a new command. */
675 current_kboard
->immediate_echo
= 0;
676 current_kboard
->echoptr
= current_kboard
->echobuf
;
677 current_kboard
->echo_after_prompt
= -1;
678 ok_to_echo_at_next_pause
= 0;
681 /* Return the length of the current echo string. */
686 return current_kboard
->echoptr
- current_kboard
->echobuf
;
689 /* Truncate the current echo message to its first LEN chars.
690 This and echo_char get used by read_key_sequence when the user
691 switches frames while entering a key sequence. */
697 current_kboard
->echobuf
[len
] = '\0';
698 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
699 truncate_echo_area (len
);
703 /* Functions for manipulating this_command_keys. */
705 add_command_key (key
)
708 int size
= XVECTOR (this_command_keys
)->size
;
710 /* If reset-this-command-length was called recently, obey it now.
711 See the doc string of that function for an explanation of why. */
712 if (before_command_restore_flag
)
714 this_command_key_count
= before_command_key_count_1
;
715 echo_truncate (before_command_echo_length_1
);
716 before_command_restore_flag
= 0;
719 if (this_command_key_count
>= size
)
721 Lisp_Object new_keys
;
723 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
724 bcopy (XVECTOR (this_command_keys
)->contents
,
725 XVECTOR (new_keys
)->contents
,
726 size
* sizeof (Lisp_Object
));
728 this_command_keys
= new_keys
;
731 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
737 int count
= specpdl_ptr
- specpdl
;
740 if (command_loop_level
> 0)
742 specbind (Qstandard_output
, Qt
);
743 specbind (Qstandard_input
, Qt
);
746 val
= command_loop ();
748 Fsignal (Qquit
, Qnil
);
750 return unbind_to (count
, Qnil
);
753 /* When an auto-save happens, record the "time", and don't do again soon. */
757 last_auto_save
= num_nonmacro_input_chars
;
760 /* Make an auto save happen as soon as possible at command level. */
762 force_auto_save_soon ()
764 last_auto_save
= - auto_save_interval
- 1;
766 record_asynch_buffer_change ();
769 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
770 "Invoke the editor command loop recursively.\n\
771 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
772 that tells this function to return.\n\
773 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
774 This function is called by the editor initialization to begin editing.")
777 int count
= specpdl_ptr
- specpdl
;
780 command_loop_level
++;
781 update_mode_lines
= 1;
783 record_unwind_protect (recursive_edit_unwind
,
785 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
789 return unbind_to (count
, Qnil
);
793 recursive_edit_unwind (buffer
)
797 Fset_buffer (buffer
);
799 command_loop_level
--;
800 update_mode_lines
= 1;
808 #if 0 /* Theory: if there's anything in Vunread_command_events,
809 it will right away be read by read_key_sequence,
810 and then if we do switch KBOARDS, it will go into the side
811 queue then. So we don't need to do anything special here -- rms. */
812 if (CONSP (Vunread_command_events
))
814 current_kboard
->kbd_queue
815 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
816 current_kboard
->kbd_queue_has_data
= 1;
818 Vunread_command_events
= Qnil
;
824 /* Switch to the single-kboard state, making current_kboard
825 the only KBOARD from which further input is accepted. */
828 single_kboard_state ()
835 /* Maintain a stack of kboards, so other parts of Emacs
836 can switch temporarily to the kboard of a given frame
837 and then revert to the previous status. */
842 struct kboard_stack
*next
;
845 static struct kboard_stack
*kboard_stack
;
848 push_frame_kboard (f
)
852 struct kboard_stack
*p
853 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
855 p
->next
= kboard_stack
;
856 p
->kboard
= current_kboard
;
859 current_kboard
= FRAME_KBOARD (f
);
867 struct kboard_stack
*p
= kboard_stack
;
868 current_kboard
= p
->kboard
;
869 kboard_stack
= p
->next
;
874 /* Handle errors that are not handled at inner levels
875 by printing an error message and returning to the editor command loop. */
881 Lisp_Object old_level
, old_length
;
883 Vstandard_output
= Qt
;
884 Vstandard_input
= Qt
;
885 Vexecuting_macro
= Qnil
;
886 current_kboard
->Vprefix_arg
= Qnil
;
889 /* Avoid unquittable loop if data contains a circular list. */
890 old_level
= Vprint_level
;
891 old_length
= Vprint_length
;
892 XSETFASTINT (Vprint_level
, 10);
893 XSETFASTINT (Vprint_length
, 10);
894 cmd_error_internal (data
, NULL
);
895 Vprint_level
= old_level
;
896 Vprint_length
= old_length
;
900 Vinhibit_quit
= Qnil
;
905 return make_number (0);
908 cmd_error_internal (data
, context
)
916 echo_area_glyphs
= 0;
918 /* If the window system or terminal frame hasn't been initialized
919 yet, or we're not interactive, it's best to dump this message out
920 to stderr and exit. */
921 if (! FRAME_MESSAGE_BUF (selected_frame
)
923 stream
= Qexternal_debugging_output
;
932 write_string_1 (context
, -1, stream
);
934 print_error_message (data
, stream
);
936 /* If the window system or terminal frame hasn't been initialized
937 yet, or we're in -batch mode, this error should cause Emacs to exit. */
938 if (! FRAME_MESSAGE_BUF (selected_frame
)
942 Fkill_emacs (make_number (-1));
946 Lisp_Object
command_loop_1 ();
947 Lisp_Object
command_loop_2 ();
948 Lisp_Object
top_level_1 ();
950 /* Entry to editor-command-loop.
951 This level has the catches for exiting/returning to editor command loop.
952 It returns nil to exit recursive edit, t to abort it. */
957 if (command_loop_level
> 0 || minibuf_level
> 0)
959 return internal_catch (Qexit
, command_loop_2
, Qnil
);
964 internal_catch (Qtop_level
, top_level_1
, Qnil
);
965 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
967 /* End of file in -batch run causes exit here. */
973 /* Here we catch errors in execution of commands within the
974 editing loop, and reenter the editing loop.
975 When there is an error, cmd_error runs and returns a non-nil
976 value to us. A value of nil means that cmd_loop_1 itself
977 returned due to end of file (or end of kbd macro). */
982 register Lisp_Object val
;
985 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
994 return Feval (Vtop_level
);
1000 /* On entry to the outer level, run the startup file */
1001 if (!NILP (Vtop_level
))
1002 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1003 else if (!NILP (Vpurify_flag
))
1004 message ("Bare impure Emacs (standard Lisp code not loaded)");
1006 message ("Bare Emacs (standard Lisp code not loaded)");
1010 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1011 "Exit all recursive editing levels.")
1014 Fthrow (Qtop_level
, Qnil
);
1017 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1018 "Exit from the innermost recursive edit or minibuffer.")
1021 if (command_loop_level
> 0 || minibuf_level
> 0)
1022 Fthrow (Qexit
, Qnil
);
1024 error ("No recursive edit is in progress");
1027 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1028 "Abort the command that requested this recursive edit or minibuffer input.")
1031 if (command_loop_level
> 0 || minibuf_level
> 0)
1034 error ("No recursive edit is in progress");
1037 /* This is the actual command reading loop,
1038 sans error-handling encapsulation. */
1040 Lisp_Object
Fcommand_execute ();
1041 static int read_key_sequence ();
1042 void safe_run_hooks ();
1047 Lisp_Object cmd
, tem
;
1050 Lisp_Object keybuf
[30];
1055 struct buffer
*prev_buffer
;
1057 int was_locked
= single_kboard
;
1060 current_kboard
->Vprefix_arg
= Qnil
;
1061 Vdeactivate_mark
= Qnil
;
1062 waiting_for_input
= 0;
1067 this_command_key_count
= 0;
1069 /* Make sure this hook runs after commands that get errors and
1070 throw to top level. */
1071 /* Note that the value cell will never directly contain nil
1072 if the symbol is a local variable. */
1073 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1074 safe_run_hooks (Qpost_command_hook
);
1076 if (!NILP (Vdeferred_action_list
))
1077 call0 (Vdeferred_action_function
);
1079 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1081 if (NILP (Vunread_command_events
)
1082 && NILP (Vexecuting_macro
)
1083 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1084 safe_run_hooks (Qpost_command_idle_hook
);
1087 /* Do this after running Vpost_command_hook, for consistency. */
1088 current_kboard
->Vlast_command
= this_command
;
1092 /* Make sure the current window's buffer is selected. */
1093 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1094 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1096 /* Display any malloc warning that just came out. Use while because
1097 displaying one warning can cause another. */
1099 while (pending_malloc_warning
)
1100 display_malloc_warning ();
1104 Vdeactivate_mark
= Qnil
;
1106 /* If minibuffer on and echo area in use,
1107 wait 2 sec and redraw minibuffer. */
1109 if (minibuf_level
&& echo_area_glyphs
1110 && EQ (minibuf_window
, echo_area_window
))
1112 /* Bind inhibit-quit to t so that C-g gets read in
1113 rather than quitting back to the minibuffer. */
1114 int count
= specpdl_ptr
- specpdl
;
1115 specbind (Qinhibit_quit
, Qt
);
1116 Fsit_for (make_number (2), Qnil
, Qnil
);
1117 unbind_to (count
, Qnil
);
1119 /* Clear the echo area. */
1122 /* If a C-g came in before, treat it as input now. */
1123 if (!NILP (Vquit_flag
))
1126 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1131 alloca (0); /* Cause a garbage collection now */
1132 /* Since we can free the most stuff here. */
1133 #endif /* C_ALLOCA */
1137 /* Select the frame that the last event came from. Usually,
1138 switch-frame events will take care of this, but if some lisp
1139 code swallows a switch-frame event, we'll fix things up here.
1140 Is this a good idea? */
1141 if (FRAMEP (internal_last_event_frame
)
1142 && XFRAME (internal_last_event_frame
) != selected_frame
)
1143 Fselect_frame (internal_last_event_frame
, Qnil
);
1146 /* If it has changed current-menubar from previous value,
1147 really recompute the menubar from the value. */
1148 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1149 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1150 call0 (Qrecompute_lucid_menubar
);
1152 before_command_key_count
= this_command_key_count
;
1153 before_command_echo_length
= echo_length ();
1155 this_command
= Qnil
;
1157 /* Read next key sequence; i gets its length. */
1158 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1163 /* Now we have read a key sequence of length I,
1164 or else I is 0 and we found end of file. */
1166 if (i
== 0) /* End of file -- happens only in */
1167 return Qnil
; /* a kbd macro, at the end. */
1168 /* -1 means read_key_sequence got a menu that was rejected.
1169 Just loop around and read another command. */
1173 this_command_key_count
= 0;
1177 last_command_char
= keybuf
[i
- 1];
1179 /* If the previous command tried to force a specific window-start,
1180 forget about that, in case this command moves point far away
1181 from that position. But also throw away beg_unchanged and
1182 end_unchanged information in that case, so that redisplay will
1183 update the whole window properly. */
1184 if (!NILP (XWINDOW (selected_window
)->force_start
))
1186 XWINDOW (selected_window
)->force_start
= Qnil
;
1187 beg_unchanged
= end_unchanged
= 0;
1190 cmd
= read_key_sequence_cmd
;
1191 if (!NILP (Vexecuting_macro
))
1193 if (!NILP (Vquit_flag
))
1195 Vexecuting_macro
= Qt
;
1196 QUIT
; /* Make some noise. */
1197 /* Will return since macro now empty. */
1201 /* Do redisplay processing after this command except in special
1202 cases identified below that set no_redisplay to 1.
1203 (actually, there's currently no way to prevent the redisplay,
1204 and no_redisplay is ignored.
1205 Perhaps someday we will really implement it.) */
1208 prev_buffer
= current_buffer
;
1209 prev_modiff
= MODIFF
;
1210 last_point_position
= PT
;
1211 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1213 /* Execute the command. */
1216 /* Note that the value cell will never directly contain nil
1217 if the symbol is a local variable. */
1218 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1219 safe_run_hooks (Qpre_command_hook
);
1221 if (NILP (this_command
))
1223 /* nil means key is undefined. */
1225 current_kboard
->defining_kbd_macro
= Qnil
;
1226 update_mode_lines
= 1;
1227 current_kboard
->Vprefix_arg
= Qnil
;
1231 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1233 /* Recognize some common commands in common situations and
1234 do them directly. */
1235 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1237 struct Lisp_Char_Table
*dp
1238 = window_display_table (XWINDOW (selected_window
));
1239 lose
= FETCH_CHAR (PT
);
1242 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1243 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1244 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1245 && (lose
>= 0x20 && lose
< 0x7f)))
1246 : (lose
>= 0x20 && lose
< 0x7f))
1247 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1249 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1251 && !windows_or_buffers_changed
1252 && EQ (current_buffer
->selective_display
, Qnil
)
1253 && !detect_input_pending ()
1254 && NILP (Vcolumn_number_mode
)
1255 && NILP (Vexecuting_macro
))
1256 no_redisplay
= direct_output_forward_char (1);
1259 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1261 struct Lisp_Char_Table
*dp
1262 = window_display_table (XWINDOW (selected_window
));
1264 lose
= FETCH_CHAR (PT
);
1266 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1267 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1268 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1269 && (lose
>= 0x20 && lose
< 0x7f)))
1270 : (lose
>= 0x20 && lose
< 0x7f))
1271 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1273 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1275 && !windows_or_buffers_changed
1276 && EQ (current_buffer
->selective_display
, Qnil
)
1277 && !detect_input_pending ()
1278 && NILP (Vcolumn_number_mode
)
1279 && NILP (Vexecuting_macro
))
1280 no_redisplay
= direct_output_forward_char (-1);
1283 else if (EQ (this_command
, Qself_insert_command
)
1284 /* Try this optimization only on ascii keystrokes. */
1285 && INTEGERP (last_command_char
))
1287 unsigned char c
= XINT (last_command_char
);
1290 if (NILP (Vexecuting_macro
)
1291 && !EQ (minibuf_window
, selected_window
))
1293 if (!nonundocount
|| nonundocount
>= 20)
1300 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1302 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1304 || MODIFF
<= SAVE_MODIFF
1305 || windows_or_buffers_changed
1306 || !EQ (current_buffer
->selective_display
, Qnil
)
1307 || detect_input_pending ()
1308 || !NILP (Vcolumn_number_mode
)
1309 || !NILP (Vexecuting_macro
));
1310 value
= internal_self_insert (c
, 0);
1317 && (PT
== ZV
|| FETCH_CHAR (PT
) == '\n'))
1319 struct Lisp_Char_Table
*dp
1320 = window_display_table (XWINDOW (selected_window
));
1327 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1330 /* Do it only for char codes
1331 that by default display as themselves. */
1332 if (lose
>= 0x20 && lose
<= 0x7e)
1333 no_redisplay
= direct_output_for_insert (lose
);
1335 else if (VECTORP (obj
)
1336 && XVECTOR (obj
)->size
== 1
1337 && (obj
= XVECTOR (obj
)->contents
[0],
1339 /* Insist face not specified in glyph. */
1340 && (XINT (obj
) & ((-1) << 8)) == 0)
1342 = direct_output_for_insert (XINT (obj
));
1346 if (lose
>= 0x20 && lose
<= 0x7e)
1347 no_redisplay
= direct_output_for_insert (lose
);
1354 /* Here for a command that isn't executed directly */
1357 if (NILP (current_kboard
->Vprefix_arg
))
1359 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1364 /* Note that the value cell will never directly contain nil
1365 if the symbol is a local variable. */
1366 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1367 safe_run_hooks (Qpost_command_hook
);
1369 if (!NILP (Vdeferred_action_list
))
1370 safe_run_hooks (Qdeferred_action_function
);
1372 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1374 if (NILP (Vunread_command_events
)
1375 && NILP (Vexecuting_macro
)
1376 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1)))
1377 safe_run_hooks (Qpost_command_idle_hook
);
1380 /* If there is a prefix argument,
1381 1) We don't want Vlast_command to be ``universal-argument''
1382 (that would be dumb), so don't set Vlast_command,
1383 2) we want to leave echoing on so that the prefix will be
1384 echoed as part of this key sequence, so don't call
1386 3) we want to leave this_command_key_count non-zero, so that
1387 read_char will realize that it is re-reading a character, and
1388 not echo it a second time.
1390 If the command didn't actually create a prefix arg,
1391 but is merely a frame event that is transparent to prefix args,
1392 then the above doesn't apply. */
1393 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1395 current_kboard
->Vlast_command
= this_command
;
1397 this_command_key_count
= 0;
1400 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1402 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1404 current_buffer
->mark_active
= Qnil
;
1405 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1407 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1408 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1412 /* Install chars successfully executed in kbd macro. */
1414 if (!NILP (current_kboard
->defining_kbd_macro
)
1415 && NILP (current_kboard
->Vprefix_arg
))
1416 finalize_kbd_macro_chars ();
1420 any_kboard_state ();
1425 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1428 safe_run_hooks_1 (hook
)
1431 return call1 (Vrun_hooks
, Vinhibit_quit
);
1434 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1437 safe_run_hooks_error (data
)
1440 Fset (Vinhibit_quit
, Qnil
);
1443 /* If we get an error while running the hook, cause the hook variable
1444 to be nil. Also inhibit quits, so that C-g won't cause the hook
1445 to mysteriously evaporate. */
1448 safe_run_hooks (hook
)
1452 int count
= specpdl_ptr
- specpdl
;
1453 specbind (Qinhibit_quit
, hook
);
1455 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1457 unbind_to (count
, Qnil
);
1460 /* Number of seconds between polling for input. */
1463 /* Nonzero means polling for input is temporarily suppressed. */
1464 int poll_suppress_count
;
1466 /* Nonzero if polling_for_input is actually being used. */
1467 int polling_for_input
;
1469 #ifdef POLL_FOR_INPUT
1471 /* Handle an alarm once each second and read pending input
1472 so as to handle a C-g if it comces in. */
1475 input_poll_signal (signalnum
) /* If we don't have an argument, */
1476 int signalnum
; /* some compilers complain in signal calls. */
1478 if (interrupt_input_blocked
== 0
1479 && !waiting_for_input
)
1480 read_avail_input (0);
1481 signal (SIGALRM
, input_poll_signal
);
1482 alarm (polling_period
);
1487 /* Begin signals to poll for input, if they are appropriate.
1488 This function is called unconditionally from various places. */
1492 #ifdef POLL_FOR_INPUT
1493 if (read_socket_hook
&& !interrupt_input
)
1495 poll_suppress_count
--;
1496 if (poll_suppress_count
== 0)
1498 signal (SIGALRM
, input_poll_signal
);
1499 polling_for_input
= 1;
1500 alarm (polling_period
);
1506 /* Nonzero if we are using polling to handle input asynchronously. */
1509 input_polling_used ()
1511 #ifdef POLL_FOR_INPUT
1512 return read_socket_hook
&& !interrupt_input
;
1518 /* Turn off polling. */
1522 #ifdef POLL_FOR_INPUT
1523 if (read_socket_hook
&& !interrupt_input
)
1525 if (poll_suppress_count
== 0)
1527 polling_for_input
= 0;
1530 poll_suppress_count
++;
1535 /* Set the value of poll_suppress_count to COUNT
1536 and start or stop polling accordingly. */
1539 set_poll_suppress_count (count
)
1542 #ifdef POLL_FOR_INPUT
1543 if (count
== 0 && poll_suppress_count
!= 0)
1545 poll_suppress_count
= 1;
1548 else if (count
!= 0 && poll_suppress_count
== 0)
1552 poll_suppress_count
= count
;
1556 /* Bind polling_period to a value at least N.
1557 But don't decrease it. */
1559 bind_polling_period (n
)
1562 #ifdef POLL_FOR_INPUT
1563 int new = polling_period
;
1569 specbind (Qpolling_period
, make_number (new));
1570 /* Start a new alarm with the new period. */
1575 /* Apply the control modifier to CHARACTER. */
1581 /* Save the upper bits here. */
1582 int upper
= c
& ~0177;
1586 /* Everything in the columns containing the upper-case letters
1587 denotes a control character. */
1588 if (c
>= 0100 && c
< 0140)
1592 /* Set the shift modifier for a control char
1593 made from a shifted letter. But only for letters! */
1594 if (oc
>= 'A' && oc
<= 'Z')
1595 c
|= shift_modifier
;
1598 /* The lower-case letters denote control characters too. */
1599 else if (c
>= 'a' && c
<= 'z')
1602 /* Include the bits for control and shift
1603 only if the basic ASCII code can't indicate them. */
1607 /* Replace the high bits. */
1608 c
|= (upper
& ~ctrl_modifier
);
1615 /* Input of single characters from keyboard */
1617 Lisp_Object
print_help ();
1618 static Lisp_Object
kbd_buffer_get_event ();
1619 static void record_char ();
1622 static jmp_buf wrong_kboard_jmpbuf
;
1625 /* read a character from the keyboard; call the redisplay if needed */
1626 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1627 -1 means do not do redisplay, but do do autosaving.
1630 /* The arguments MAPS and NMAPS are for menu prompting.
1631 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1633 PREV_EVENT is the previous input event, or nil if we are reading
1634 the first event of a key sequence.
1636 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1637 if we used a mouse menu to read the input, or zero otherwise. If
1638 USED_MOUSE_MENU is null, we don't dereference it.
1640 Value is t if we showed a menu and the user rejected it. */
1643 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1647 Lisp_Object prev_event
;
1648 int *used_mouse_menu
;
1650 register Lisp_Object c
;
1652 jmp_buf local_getcjmp
;
1654 int key_already_recorded
= 0;
1655 Lisp_Object tem
, save
;
1656 Lisp_Object also_record
;
1659 before_command_key_count
= this_command_key_count
;
1660 before_command_echo_length
= echo_length ();
1664 if (CONSP (Vunread_command_events
))
1666 c
= XCONS (Vunread_command_events
)->car
;
1667 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1669 /* Undo what read_char_x_menu_prompt did when it unread
1670 additional keys returned by Fx_popup_menu. */
1672 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1673 && NILP (XCONS (c
)->cdr
))
1676 if (this_command_key_count
== 0)
1682 if (unread_command_char
!= -1)
1684 XSETINT (c
, unread_command_char
);
1685 unread_command_char
= -1;
1687 if (this_command_key_count
== 0)
1693 /* If there is no function key translated before
1694 reset-this-command-lengths takes effect, forget about it. */
1695 before_command_restore_flag
= 0;
1697 if (!NILP (Vexecuting_macro
))
1700 /* We set this to Qmacro; since that's not a frame, nobody will
1701 try to switch frames on us, and the selected window will
1704 Since this event came from a macro, it would be misleading to
1705 leave internal_last_event_frame set to wherever the last
1706 real event came from. Normally, a switch-frame event selects
1707 internal_last_event_frame after each command is read, but
1708 events read from a macro should never cause a new frame to be
1710 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1713 /* Exit the macro if we are at the end.
1714 Also, some things replace the macro with t
1715 to force an early exit. */
1716 if (EQ (Vexecuting_macro
, Qt
)
1717 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1723 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1724 if (STRINGP (Vexecuting_macro
)
1725 && (XINT (c
) & 0x80))
1726 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1728 executing_macro_index
++;
1733 if (!NILP (unread_switch_frame
))
1735 c
= unread_switch_frame
;
1736 unread_switch_frame
= Qnil
;
1738 /* This event should make it into this_command_keys, and get echoed
1739 again, so we go to reread_first, rather than reread. */
1743 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1746 /* Message turns off echoing unless more keystrokes turn it on again. */
1747 if (echo_area_glyphs
&& *echo_area_glyphs
1748 && echo_area_glyphs
!= current_kboard
->echobuf
1749 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1752 /* If already echoing, continue. */
1755 /* Try reading a character via menu prompting in the minibuf.
1756 Try this before the sit-for, because the sit-for
1757 would do the wrong thing if we are supposed to do
1758 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1759 after a mouse event so don't try a minibuf menu. */
1761 if (nmaps
> 0 && INTERACTIVE
1762 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1763 /* Don't bring up a menu if we already have another event. */
1764 && NILP (Vunread_command_events
)
1765 && unread_command_char
< 0
1766 && !detect_input_pending ())
1768 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1771 key_already_recorded
= 1;
1776 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1777 We will do that below, temporarily for short sections of code,
1778 when appropriate. local_getcjmp must be in effect
1779 around any call to sit_for or kbd_buffer_get_event;
1780 it *must not* be in effect when we call redisplay. */
1782 if (_setjmp (local_getcjmp
))
1784 XSETINT (c
, quit_char
);
1786 XSETFRAME (internal_last_event_frame
, selected_frame
);
1787 Vlast_event_frame
= internal_last_event_frame
;
1789 /* If we report the quit char as an event,
1790 don't do so more than once. */
1791 if (!NILP (Vinhibit_quit
))
1796 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1797 if (kb
!= current_kboard
)
1799 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1800 /* We shouldn't get here if we were in single-kboard mode! */
1803 while (CONSP (*tailp
))
1804 tailp
= &XCONS (*tailp
)->cdr
;
1807 *tailp
= Fcons (c
, Qnil
);
1808 kb
->kbd_queue_has_data
= 1;
1809 current_kboard
= kb
;
1810 longjmp (wrong_kboard_jmpbuf
, 1);
1817 timer_start_idle ();
1819 /* If in middle of key sequence and minibuffer not active,
1820 start echoing if enough time elapses. */
1822 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1823 && this_command_key_count
> 0
1825 && echo_keystrokes
> 0
1826 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1827 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1831 /* After a mouse event, start echoing right away.
1832 This is because we are probably about to display a menu,
1833 and we don't want to delay before doing so. */
1834 if (EVENT_HAS_PARAMETERS (prev_event
))
1838 save_getcjmp (save_jump
);
1839 restore_getcjmp (local_getcjmp
);
1840 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1841 restore_getcjmp (save_jump
);
1847 /* Maybe auto save due to number of keystrokes. */
1849 if (commandflag
!= 0
1850 && auto_save_interval
> 0
1851 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1852 && !detect_input_pending ())
1854 Fdo_auto_save (Qnil
, Qnil
);
1855 /* Hooks can actually change some buffers in auto save. */
1859 /* Try reading using an X menu.
1860 This is never confused with reading using the minibuf
1861 because the recursive call of read_char in read_char_minibuf_menu_prompt
1862 does not pass on any keymaps. */
1864 if (nmaps
> 0 && INTERACTIVE
1865 && !NILP (prev_event
)
1866 && EVENT_HAS_PARAMETERS (prev_event
)
1867 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1868 /* Don't bring up a menu if we already have another event. */
1869 && NILP (Vunread_command_events
)
1870 && unread_command_char
< 0)
1871 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1873 /* Maybe autosave and/or garbage collect due to idleness. */
1875 if (INTERACTIVE
&& NILP (c
))
1877 int delay_level
, buffer_size
;
1879 /* Slow down auto saves logarithmically in size of current buffer,
1880 and garbage collect while we're at it. */
1881 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1882 last_non_minibuf_size
= Z
- BEG
;
1883 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1885 while (buffer_size
> 64)
1886 delay_level
++, buffer_size
-= buffer_size
>> 2;
1887 if (delay_level
< 4) delay_level
= 4;
1888 /* delay_level is 4 for files under around 50k, 7 at 100k,
1889 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1891 /* Auto save if enough time goes by without input. */
1892 if (commandflag
!= 0
1893 && num_nonmacro_input_chars
> last_auto_save
1894 && INTEGERP (Vauto_save_timeout
)
1895 && XINT (Vauto_save_timeout
) > 0)
1899 save_getcjmp (save_jump
);
1900 restore_getcjmp (local_getcjmp
);
1901 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
1903 restore_getcjmp (save_jump
);
1907 Fdo_auto_save (Qnil
, Qnil
);
1909 /* If we have auto-saved and there is still no input
1910 available, garbage collect if there has been enough
1911 consing going on to make it worthwhile. */
1912 if (!detect_input_pending ()
1913 && consing_since_gc
> gc_cons_threshold
/ 2)
1914 Fgarbage_collect ();
1921 /* Read something from current KBOARD's side queue, if possible. */
1925 if (current_kboard
->kbd_queue_has_data
)
1927 if (!CONSP (current_kboard
->kbd_queue
))
1929 c
= XCONS (current_kboard
->kbd_queue
)->car
;
1930 current_kboard
->kbd_queue
1931 = XCONS (current_kboard
->kbd_queue
)->cdr
;
1932 if (NILP (current_kboard
->kbd_queue
))
1933 current_kboard
->kbd_queue_has_data
= 0;
1934 input_pending
= readable_events (0);
1936 if (EVENT_HAS_PARAMETERS (c
)
1937 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
1938 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
1939 Vlast_event_frame
= internal_last_event_frame
;
1945 /* If current_kboard's side queue is empty check the other kboards.
1946 If one of them has data that we have not yet seen here,
1947 switch to it and process the data waiting for it.
1949 Note: if the events queued up for another kboard
1950 have already been seen here, and therefore are not a complete command,
1951 the kbd_queue_has_data field is 0, so we skip that kboard here.
1952 That's to avoid an infinite loop switching between kboards here. */
1953 if (NILP (c
) && !single_kboard
)
1956 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
1957 if (kb
->kbd_queue_has_data
)
1959 current_kboard
= kb
;
1960 longjmp (wrong_kboard_jmpbuf
, 1);
1969 /* Finally, we read from the main queue,
1970 and if that gives us something we can't use yet, we put it on the
1971 appropriate side queue and try again. */
1977 /* Actually read a character, waiting if necessary. */
1978 save_getcjmp (save_jump
);
1979 restore_getcjmp (local_getcjmp
);
1980 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
1981 restore_getcjmp (save_jump
);
1984 if (! NILP (c
) && (kb
!= current_kboard
))
1986 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1987 while (CONSP (*tailp
))
1988 tailp
= &XCONS (*tailp
)->cdr
;
1991 *tailp
= Fcons (c
, Qnil
);
1992 kb
->kbd_queue_has_data
= 1;
1996 current_kboard
= kb
;
1997 longjmp (wrong_kboard_jmpbuf
, 1);
2002 /* Terminate Emacs in batch mode if at eof. */
2003 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2004 Fkill_emacs (make_number (1));
2008 /* Add in any extra modifiers, where appropriate. */
2009 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2010 || ((extra_keyboard_modifiers
& 0177) < ' '
2011 && (extra_keyboard_modifiers
& 0177) != 0))
2012 XSETINT (c
, make_ctrl_char (XINT (c
)));
2014 /* Transfer any other modifier bits directly from
2015 extra_keyboard_modifiers to c. Ignore the actual character code
2016 in the low 16 bits of extra_keyboard_modifiers. */
2017 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2022 /* Now that we have read an event, Emacs is not idle--
2023 unless the event was a timer event. */
2024 if (! (CONSP (c
) && EQ (XCONS (c
)->car
, Qtimer_event
)))
2031 if (commandflag
>= 0
2032 && !input_pending
&& !detect_input_pending ())
2040 /* Buffer switch events are only for internal wakeups
2041 so don't show them to the user. */
2045 if (key_already_recorded
)
2048 /* Process special events within read_char
2049 and loop around to read another event. */
2052 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2058 int was_locked
= single_kboard
;
2060 last_input_char
= c
;
2061 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2063 /* Resume allowing input from any kboard, if that was true before. */
2065 any_kboard_state ();
2070 /* Wipe the echo area. */
2071 echo_area_glyphs
= 0;
2073 /* Handle things that only apply to characters. */
2076 /* If kbd_buffer_get_event gave us an EOF, return that. */
2080 if (STRINGP (Vkeyboard_translate_table
)
2081 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
2082 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
2083 else if ((VECTORP (Vkeyboard_translate_table
)
2084 && XVECTOR (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
2085 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2088 d
= Faref (Vkeyboard_translate_table
, c
);
2089 /* nil in keyboard-translate-table means no translation. */
2095 /* If this event is a mouse click in the menu bar,
2096 return just menu-bar for now. Modify the mouse click event
2097 so we won't do this twice, then queue it up. */
2098 if (EVENT_HAS_PARAMETERS (c
)
2099 && CONSP (XCONS (c
)->cdr
)
2100 && CONSP (EVENT_START (c
))
2101 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2105 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2106 /* Handle menu-bar events:
2107 insert the dummy prefix event `menu-bar'. */
2108 if (EQ (posn
, Qmenu_bar
))
2110 /* Change menu-bar to (menu-bar) as the event "position". */
2111 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2114 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2120 if (! NILP (also_record
))
2121 record_char (also_record
);
2125 before_command_key_count
= this_command_key_count
;
2126 before_command_echo_length
= echo_length ();
2128 /* Don't echo mouse motion events. */
2130 && ! (EVENT_HAS_PARAMETERS (c
)
2131 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2134 if (! NILP (also_record
))
2135 echo_char (also_record
);
2136 /* Once we reread a character, echoing can happen
2137 the next time we pause to read a new one. */
2138 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2141 /* Record this character as part of the current key. */
2142 add_command_key (c
);
2143 if (! NILP (also_record
))
2144 add_command_key (also_record
);
2146 /* Re-reading in the middle of a command */
2148 last_input_char
= c
;
2151 /* Process the help character specially if enabled */
2152 if (!NILP (Vhelp_form
) && help_char_p (c
))
2155 count
= specpdl_ptr
- specpdl
;
2157 record_unwind_protect (Fset_window_configuration
,
2158 Fcurrent_window_configuration (Qnil
));
2160 tem0
= Feval (Vhelp_form
);
2162 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2166 c
= read_char (0, 0, 0, Qnil
, 0);
2167 while (BUFFERP (c
));
2168 /* Remove the help from the frame */
2169 unbind_to (count
, Qnil
);
2172 if (EQ (c
, make_number (040)))
2176 c
= read_char (0, 0, 0, Qnil
, 0);
2177 while (BUFFERP (c
));
2184 /* Return 1 if should recognize C as "the help character". */
2192 if (EQ (c
, Vhelp_char
))
2194 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2195 if (EQ (c
, XCONS (tail
)->car
))
2200 /* Record the input event C in various ways. */
2207 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2208 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2209 recent_keys_index
= 0;
2211 /* Write c to the dribble file. If c is a lispy event, write
2212 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2213 If you, dear reader, have a better idea, you've got the source. :-) */
2218 if (XUINT (c
) < 0x100)
2219 putc (XINT (c
), dribble
);
2221 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2225 Lisp_Object dribblee
;
2227 /* If it's a structured event, take the event header. */
2228 dribblee
= EVENT_HEAD (c
);
2230 if (SYMBOLP (dribblee
))
2232 putc ('<', dribble
);
2233 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2234 XSYMBOL (dribblee
)->name
->size
,
2236 putc ('>', dribble
);
2243 store_kbd_macro_char (c
);
2245 num_nonmacro_input_chars
++;
2252 struct buffer
*old
= current_buffer
;
2253 Fprinc (object
, Qnil
);
2254 set_buffer_internal (XBUFFER (Vstandard_output
));
2255 call0 (intern ("help-mode"));
2256 set_buffer_internal (old
);
2260 /* Copy out or in the info on where C-g should throw to.
2261 This is used when running Lisp code from within get_char,
2262 in case get_char is called recursively.
2263 See read_process_output. */
2268 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2271 restore_getcjmp (temp
)
2274 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2279 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2280 of this function. */
2283 tracking_off (old_value
)
2284 Lisp_Object old_value
;
2286 do_mouse_tracking
= old_value
;
2287 if (NILP (old_value
))
2289 /* Redisplay may have been preempted because there was input
2290 available, and it assumes it will be called again after the
2291 input has been processed. If the only input available was
2292 the sort that we have just disabled, then we need to call
2294 if (!readable_events (1))
2296 redisplay_preserve_echo_area ();
2297 get_input_pending (&input_pending
, 1);
2302 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2303 "Evaluate BODY with mouse movement events enabled.\n\
2304 Within a `track-mouse' form, mouse motion generates input events that\n\
2305 you can read with `read-event'.\n\
2306 Normally, mouse motion is ignored.")
2310 int count
= specpdl_ptr
- specpdl
;
2313 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2315 do_mouse_tracking
= Qt
;
2317 val
= Fprogn (args
);
2318 return unbind_to (count
, val
);
2321 /* If mouse has moved on some frame, return one of those frames.
2322 Return 0 otherwise. */
2327 Lisp_Object tail
, frame
;
2329 FOR_EACH_FRAME (tail
, frame
)
2331 if (XFRAME (frame
)->mouse_moved
)
2332 return XFRAME (frame
);
2338 #endif /* HAVE_MOUSE */
2340 /* Low level keyboard/mouse input.
2341 kbd_buffer_store_event places events in kbd_buffer, and
2342 kbd_buffer_get_event retrieves them. */
2344 /* Return true iff there are any events in the queue that read-char
2345 would return. If this returns false, a read-char would block. */
2347 readable_events (do_timers_now
)
2350 timer_check (do_timers_now
);
2351 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2354 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2359 if (current_kboard
->kbd_queue_has_data
)
2365 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2366 if (kb
->kbd_queue_has_data
)
2372 /* Set this for debugging, to have a way to get out */
2377 event_to_kboard (event
)
2378 struct input_event
*event
;
2381 frame
= event
->frame_or_window
;
2383 frame
= XCONS (frame
)->car
;
2384 else if (WINDOWP (frame
))
2385 frame
= WINDOW_FRAME (XWINDOW (frame
));
2387 /* There are still some events that don't set this field.
2388 For now, just ignore the problem.
2389 Also ignore dead frames here. */
2390 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2393 return FRAME_KBOARD (XFRAME (frame
));
2397 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2400 kbd_buffer_store_event (event
)
2401 register struct input_event
*event
;
2403 if (event
->kind
== no_event
)
2406 if (event
->kind
== ascii_keystroke
)
2408 register int c
= event
->code
& 0377;
2410 if (event
->modifiers
& ctrl_modifier
)
2411 c
= make_ctrl_char (c
);
2413 c
|= (event
->modifiers
2414 & (meta_modifier
| alt_modifier
2415 | hyper_modifier
| super_modifier
));
2419 extern SIGTYPE
interrupt_signal ();
2422 struct input_event
*sp
;
2425 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2426 kb
!= current_kboard
))
2429 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2430 Fcons (make_number (c
), Qnil
));
2431 kb
->kbd_queue_has_data
= 1;
2432 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2434 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2437 if (event_to_kboard (sp
) == kb
)
2439 sp
->kind
= no_event
;
2440 sp
->frame_or_window
= Qnil
;
2448 /* If this results in a quit_char being returned to Emacs as
2449 input, set Vlast_event_frame properly. If this doesn't
2450 get returned to Emacs as an event, the next event read
2451 will set Vlast_event_frame again, so this is safe to do. */
2455 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2457 focus
= event
->frame_or_window
;
2458 internal_last_event_frame
= focus
;
2459 Vlast_event_frame
= focus
;
2463 last_event_timestamp
= event
->timestamp
;
2464 interrupt_signal ();
2468 if (c
&& c
== stop_character
)
2474 /* Don't insert two buffer_switch_event's in a row.
2475 Just ignore the second one. */
2476 else if (event
->kind
== buffer_switch_event
2477 && kbd_fetch_ptr
!= kbd_store_ptr
2478 && kbd_store_ptr
->kind
== buffer_switch_event
)
2481 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2482 kbd_store_ptr
= kbd_buffer
;
2484 /* Don't let the very last slot in the buffer become full,
2485 since that would make the two pointers equal,
2486 and that is indistinguishable from an empty buffer.
2487 Discard the event if it would fill the last slot. */
2488 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2490 volatile struct input_event
*sp
= kbd_store_ptr
;
2491 sp
->kind
= event
->kind
;
2492 if (event
->kind
== selection_request_event
)
2494 /* We must not use the ordinary copying code for this case,
2495 since `part' is an enum and copying it might not copy enough
2497 bcopy (event
, (char *) sp
, sizeof (*event
));
2501 sp
->code
= event
->code
;
2502 sp
->part
= event
->part
;
2503 sp
->frame_or_window
= event
->frame_or_window
;
2504 sp
->modifiers
= event
->modifiers
;
2507 sp
->timestamp
= event
->timestamp
;
2509 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2511 = event
->frame_or_window
);
2517 /* Read one event from the event buffer, waiting if necessary.
2518 The value is a Lisp object representing the event.
2519 The value is nil for an event that should be ignored,
2520 or that was handled here.
2521 We always read and discard one event. */
2524 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2526 int *used_mouse_menu
;
2530 EMACS_TIME next_timer_delay
;
2536 *kbp
= current_kboard
;
2540 /* Wait until there is input available. */
2543 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2546 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2550 /* If the quit flag is set, then read_char will return
2551 quit_char, so that counts as "available input." */
2552 if (!NILP (Vquit_flag
))
2553 quit_throw_to_read_char ();
2555 /* One way or another, wait until input is available; then, if
2556 interrupt handlers have not read it, read it now. */
2559 wait_for_kbd_input ();
2561 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2565 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2568 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2572 Lisp_Object minus_one
;
2574 XSETINT (minus_one
, -1);
2575 wait_reading_process_input (0, 0, minus_one
, 1);
2577 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2578 /* Pass 1 for EXPECT since we just waited to have input. */
2579 read_avail_input (1);
2581 #endif /* not VMS */
2584 /* At this point, we know that there is a readable event available
2585 somewhere. If the event queue is empty, then there must be a
2586 mouse movement enabled and available. */
2587 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2589 struct input_event
*event
;
2591 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2595 last_event_timestamp
= event
->timestamp
;
2598 *kbp
= event_to_kboard (event
);
2600 *kbp
= current_kboard
; /* Better than returning null ptr? */
2602 *kbp
= &the_only_kboard
;
2607 /* These two kinds of events get special handling
2608 and don't actually appear to the command loop.
2609 We return nil for them. */
2610 if (event
->kind
== selection_request_event
)
2613 struct input_event copy
;
2615 /* Remove it from the buffer before processing it,
2616 since otherwise swallow_events will see it
2617 and process it again. */
2619 kbd_fetch_ptr
= event
+ 1;
2620 input_pending
= readable_events (0);
2621 x_handle_selection_request (©
);
2623 /* We're getting selection request events, but we don't have
2629 else if (event
->kind
== selection_clear_event
)
2632 struct input_event copy
;
2634 /* Remove it from the buffer before processing it. */
2636 kbd_fetch_ptr
= event
+ 1;
2637 input_pending
= readable_events (0);
2638 x_handle_selection_clear (©
);
2640 /* We're getting selection request events, but we don't have
2645 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2646 else if (event
->kind
== delete_window_event
)
2648 /* Make an event (delete-frame (FRAME)). */
2649 obj
= Fcons (event
->frame_or_window
, Qnil
);
2650 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2651 kbd_fetch_ptr
= event
+ 1;
2653 else if (event
->kind
== iconify_event
)
2655 /* Make an event (iconify-frame (FRAME)). */
2656 obj
= Fcons (event
->frame_or_window
, Qnil
);
2657 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2658 kbd_fetch_ptr
= event
+ 1;
2660 else if (event
->kind
== deiconify_event
)
2662 /* Make an event (make-frame-visible (FRAME)). */
2663 obj
= Fcons (event
->frame_or_window
, Qnil
);
2664 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2665 kbd_fetch_ptr
= event
+ 1;
2668 else if (event
->kind
== buffer_switch_event
)
2670 /* The value doesn't matter here; only the type is tested. */
2671 XSETBUFFER (obj
, current_buffer
);
2672 kbd_fetch_ptr
= event
+ 1;
2674 #ifdef USE_X_TOOLKIT
2675 else if (event
->kind
== menu_bar_activate_event
)
2677 kbd_fetch_ptr
= event
+ 1;
2678 input_pending
= readable_events (0);
2679 x_activate_menubar (XFRAME (event
->frame_or_window
));
2682 /* Just discard these, by returning nil.
2683 With MULTI_KBOARD, these events are used as placeholders
2684 when we need to randomly delete events from the queue.
2685 (They shouldn't otherwise be found in the buffer,
2686 but on some machines it appears they do show up
2687 even without MULTI_KBOARD.) */
2688 else if (event
->kind
== no_event
)
2689 kbd_fetch_ptr
= event
+ 1;
2691 /* If this event is on a different frame, return a switch-frame this
2692 time, and leave the event in the queue for next time. */
2699 frame
= event
->frame_or_window
;
2701 frame
= XCONS (frame
)->car
;
2702 else if (WINDOWP (frame
))
2703 frame
= WINDOW_FRAME (XWINDOW (frame
));
2705 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2709 if (! EQ (frame
, internal_last_event_frame
)
2710 && XFRAME (frame
) != selected_frame
)
2711 obj
= make_lispy_switch_frame (frame
);
2712 internal_last_event_frame
= frame
;
2713 #endif /* MULTI_FRAME */
2715 /* If we didn't decide to make a switch-frame event, go ahead
2716 and build a real event from the queue entry. */
2720 obj
= make_lispy_event (event
);
2721 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2722 /* If this was a menu selection, then set the flag to inhibit
2723 writing to last_nonmenu_event. Don't do this if the event
2724 we're returning is (menu-bar), though; that indicates the
2725 beginning of the menu sequence, and we might as well leave
2726 that as the `event with parameters' for this selection. */
2727 if (event
->kind
== menu_bar_event
2728 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2730 *used_mouse_menu
= 1;
2733 /* Wipe out this event, to catch bugs. */
2734 event
->kind
= no_event
;
2735 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2737 kbd_fetch_ptr
= event
+ 1;
2742 /* Try generating a mouse motion event. */
2743 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2745 FRAME_PTR f
= some_mouse_moved ();
2746 Lisp_Object bar_window
;
2747 enum scroll_bar_part part
;
2751 *kbp
= current_kboard
;
2752 /* Note that this uses F to determine which display to look at.
2753 If there is no valid info, it does not store anything
2754 so x remains nil. */
2756 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2761 /* Decide if we should generate a switch-frame event. Don't
2762 generate switch-frame events for motion outside of all Emacs
2768 frame
= FRAME_FOCUS_FRAME (f
);
2770 XSETFRAME (frame
, f
);
2772 if (! EQ (frame
, internal_last_event_frame
)
2773 && XFRAME (frame
) != selected_frame
)
2774 obj
= make_lispy_switch_frame (frame
);
2775 internal_last_event_frame
= frame
;
2779 /* If we didn't decide to make a switch-frame event, go ahead and
2780 return a mouse-motion event. */
2781 if (!NILP (x
) && NILP (obj
))
2782 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2784 #endif /* HAVE_MOUSE */
2786 /* We were promised by the above while loop that there was
2787 something for us to read! */
2790 input_pending
= readable_events (0);
2793 Vlast_event_frame
= internal_last_event_frame
;
2799 /* Process any events that are not user-visible,
2800 then return, without reading any user-visible events. */
2803 swallow_events (do_display
)
2806 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2808 struct input_event
*event
;
2810 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2814 last_event_timestamp
= event
->timestamp
;
2816 /* These two kinds of events get special handling
2817 and don't actually appear to the command loop. */
2818 if (event
->kind
== selection_request_event
)
2821 struct input_event copy
;
2823 /* Remove it from the buffer before processing it,
2824 since otherwise swallow_events called recursively could see it
2825 and process it again. */
2827 kbd_fetch_ptr
= event
+ 1;
2828 input_pending
= readable_events (0);
2829 x_handle_selection_request (©
);
2831 /* We're getting selection request events, but we don't have
2837 else if (event
->kind
== selection_clear_event
)
2840 struct input_event copy
;
2842 /* Remove it from the buffer before processing it, */
2845 kbd_fetch_ptr
= event
+ 1;
2846 input_pending
= readable_events (0);
2847 x_handle_selection_clear (©
);
2849 /* We're getting selection request events, but we don't have
2854 else if (event
->kind
== timer_event
)
2856 Lisp_Object tem
, lisp_event
;
2857 int was_locked
= single_kboard
;
2859 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
2860 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
2862 lisp_event
= Fcons (Qtimer_event
,
2863 Fcons (Fcdr (event
->frame_or_window
), Qnil
));
2864 kbd_fetch_ptr
= event
+ 1;
2865 if (kbd_fetch_ptr
== kbd_store_ptr
)
2867 Fcommand_execute (tem
, Qnil
, Fvector (1, &lisp_event
), Qt
);
2869 redisplay_preserve_echo_area ();
2871 /* Resume allowing input from any kboard, if that was true before. */
2873 any_kboard_state ();
2879 get_input_pending (&input_pending
, 1);
2882 static EMACS_TIME timer_idleness_start_time
;
2884 /* Record the start of when Emacs is idle,
2885 for the sake of running idle-time timers. */
2891 /* If we are already in the idle state, do nothing. */
2892 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2895 EMACS_GET_TIME (timer_idleness_start_time
);
2897 /* Mark all idle-time timers as once again candidates for running. */
2898 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
2902 timer
= XCONS (timers
)->car
;
2904 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
2906 XVECTOR (timer
)->contents
[0] = Qnil
;
2910 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
2914 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
2917 /* Check whether a timer has fired. To prevent larger problems we simply
2918 disregard elements that are not proper timers. Do not make a circular
2919 timer list for the time being.
2921 Returns the number of seconds to wait until the next timer fires. If a
2922 timer is triggering now, return zero seconds.
2923 If no timer is active, return -1 seconds.
2925 If a timer is triggering now, either queue a timer-event
2926 or run the timer's handler function if DO_IT_NOW is nonzero. */
2929 timer_check (do_it_now
)
2932 EMACS_TIME nexttime
;
2934 Lisp_Object timers
, timer
;
2935 /* Nonzero if we generate some events. */
2936 int events_generated
= 0;
2937 struct gcpro gcpro1
, gcpro2
;
2940 EMACS_SET_SECS (nexttime
, -1);
2941 EMACS_SET_USECS (nexttime
, -1);
2943 timers
= Vtimer_list
;
2945 GCPRO2 (timers
, timer
);
2947 if (CONSP (Vtimer_list
) || CONSP (Vtimer_idle_list
))
2948 EMACS_GET_TIME (now
);
2950 for (listnum
= 0; listnum
< 2; listnum
++)
2952 EMACS_TIME compare_time
;
2954 /* Always first scan the absolute timer list. */
2957 timers
= Vtimer_list
;
2960 /* If Emacs is idle, scan the idle timer list
2961 using the length of idleness as the time value. */
2962 else if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
2964 timers
= Vtimer_idle_list
;
2965 EMACS_SUB_TIME (compare_time
, now
, timer_idleness_start_time
);
2970 while (CONSP (timers
))
2972 int triggertime
= EMACS_SECS (now
);
2973 Lisp_Object
*vector
;
2974 EMACS_TIME timer_time
;
2975 EMACS_TIME difference
;
2977 timer
= XCONS (timers
)->car
;
2978 timers
= XCONS (timers
)->cdr
;
2980 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
2982 vector
= XVECTOR (timer
)->contents
;
2984 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
2985 || !INTEGERP (vector
[3]))
2988 EMACS_SET_SECS (timer_time
,
2989 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
2990 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
2991 EMACS_SUB_TIME (difference
, timer_time
, compare_time
);
2992 /* If event is past, run it if it hasn't been run. */
2993 if (EMACS_TIME_NEG_P (difference
)
2994 || (EMACS_SECS (difference
) == 0
2995 && EMACS_USECS (difference
) == 0))
2997 if (NILP (vector
[0]))
2999 /* Mark the timer as triggered to prevent problems if the lisp
3000 code fails to reschedule it right. */
3003 /* Run the timer or queue a timer event. */
3006 Lisp_Object tem
, event
;
3007 int was_locked
= single_kboard
;
3009 tem
= get_keymap_1 (Vspecial_event_map
, 0, 0);
3010 tem
= get_keyelt (access_keymap (tem
, Qtimer_event
, 0, 0),
3012 event
= Fcons (Qtimer_event
, Fcons (timer
, Qnil
));
3013 Fcommand_execute (tem
, Qnil
, Fvector (1, &event
), Qt
);
3015 /* Resume allowing input from any kboard, if that was true before. */
3017 any_kboard_state ();
3019 /* Since we have handled the event,
3020 we don't need to tell the caller to wake up and do it. */
3024 /* Generate a timer event so the caller will handle it. */
3025 struct input_event event
;
3027 event
.kind
= timer_event
;
3028 event
.modifiers
= 0;
3029 event
.x
= event
.y
= Qnil
;
3030 event
.timestamp
= triggertime
;
3031 /* Store the timer in the frame slot. */
3032 event
.frame_or_window
= Fcons (Fselected_frame (), timer
);
3033 kbd_buffer_store_event (&event
);
3035 /* Tell caller to handle this event right away. */
3036 events_generated
= 1;
3037 EMACS_SET_SECS (nexttime
, 0);
3038 EMACS_SET_USECS (nexttime
, 0);
3043 /* When we encounter a timer that is still waiting,
3044 return the amount of time to wait before it is ripe. */
3047 /* But if we generated an event,
3048 tell the caller to handle it now. */
3049 if (events_generated
)
3055 /* No timers are pending in the future. */
3056 /* Return 0 if we generated an event, and -1 if not. */
3061 /* Caches for modify_event_symbol. */
3062 static Lisp_Object accent_key_syms
;
3063 static Lisp_Object func_key_syms
;
3064 static Lisp_Object mouse_syms
;
3066 /* This is a list of keysym codes for special "accent" characters.
3067 It parallels lispy_accent_keys. */
3069 static int lispy_accent_codes
[] =
3071 #ifdef XK_dead_circumflex
3076 #ifdef XK_dead_grave
3081 #ifdef XK_dead_tilde
3086 #ifdef XK_dead_diaeresis
3091 #ifdef XK_dead_macron
3096 #ifdef XK_dead_degree
3101 #ifdef XK_dead_acute
3106 #ifdef XK_dead_cedilla
3111 #ifdef XK_dead_breve
3116 #ifdef XK_dead_ogonek
3121 #ifdef XK_dead_caron
3126 #ifdef XK_dead_doubleacute
3127 XK_dead_doubleacute
,
3131 #ifdef XK_dead_abovedot
3138 /* This is a list of Lisp names for special "accent" characters.
3139 It parallels lispy_accent_codes. */
3141 static char *lispy_accent_keys
[] =
3159 #define FUNCTION_KEY_OFFSET 0x0
3161 char *lispy_function_keys
[] =
3165 0, /* VK_LBUTTON 0x01 */
3166 0, /* VK_RBUTTON 0x02 */
3167 "cancel", /* VK_CANCEL 0x03 */
3168 0, /* VK_MBUTTON 0x04 */
3170 0, 0, 0, /* 0x05 .. 0x07 */
3172 "backspace", /* VK_BACK 0x08 */
3173 "tab", /* VK_TAB 0x09 */
3175 0, 0, /* 0x0A .. 0x0B */
3177 "clear", /* VK_CLEAR 0x0C */
3178 "return", /* VK_RETURN 0x0D */
3180 0, 0, /* 0x0E .. 0x0F */
3182 "shift", /* VK_SHIFT 0x10 */
3183 "control", /* VK_CONTROL 0x11 */
3184 "menu", /* VK_MENU 0x12 */
3185 "pause", /* VK_PAUSE 0x13 */
3186 "capital", /* VK_CAPITAL 0x14 */
3188 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3190 0, /* VK_ESCAPE 0x1B */
3192 0, 0, 0, 0, /* 0x1C .. 0x1F */
3194 0, /* VK_SPACE 0x20 */
3195 "prior", /* VK_PRIOR 0x21 */
3196 "next", /* VK_NEXT 0x22 */
3197 "end", /* VK_END 0x23 */
3198 "home", /* VK_HOME 0x24 */
3199 "left", /* VK_LEFT 0x25 */
3200 "up", /* VK_UP 0x26 */
3201 "right", /* VK_RIGHT 0x27 */
3202 "down", /* VK_DOWN 0x28 */
3203 "select", /* VK_SELECT 0x29 */
3204 "print", /* VK_PRINT 0x2A */
3205 "execute", /* VK_EXECUTE 0x2B */
3206 "snapshot", /* VK_SNAPSHOT 0x2C */
3207 "insert", /* VK_INSERT 0x2D */
3208 "delete", /* VK_DELETE 0x2E */
3209 "help", /* VK_HELP 0x2F */
3211 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3213 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3215 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3217 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3219 0, 0, 0, 0, 0, 0, 0, 0, 0,
3220 0, 0, 0, 0, 0, 0, 0, 0, 0,
3221 0, 0, 0, 0, 0, 0, 0, 0,
3223 "lwindow", /* VK_LWIN 0x5B */
3224 "rwindow", /* VK_RWIN 0x5C */
3225 "apps", /* VK_APPS 0x5D */
3227 0, 0, /* 0x5E .. 0x5F */
3229 "kp-0", /* VK_NUMPAD0 0x60 */
3230 "kp-1", /* VK_NUMPAD1 0x61 */
3231 "kp-2", /* VK_NUMPAD2 0x62 */
3232 "kp-3", /* VK_NUMPAD3 0x63 */
3233 "kp-4", /* VK_NUMPAD4 0x64 */
3234 "kp-5", /* VK_NUMPAD5 0x65 */
3235 "kp-6", /* VK_NUMPAD6 0x66 */
3236 "kp-7", /* VK_NUMPAD7 0x67 */
3237 "kp-8", /* VK_NUMPAD8 0x68 */
3238 "kp-9", /* VK_NUMPAD9 0x69 */
3239 "kp-multiply", /* VK_MULTIPLY 0x6A */
3240 "kp-add", /* VK_ADD 0x6B */
3241 "kp-separator", /* VK_SEPARATOR 0x6C */
3242 "kp-subtract", /* VK_SUBTRACT 0x6D */
3243 "kp-decimal", /* VK_DECIMAL 0x6E */
3244 "kp-divide", /* VK_DIVIDE 0x6F */
3245 "f1", /* VK_F1 0x70 */
3246 "f2", /* VK_F2 0x71 */
3247 "f3", /* VK_F3 0x72 */
3248 "f4", /* VK_F4 0x73 */
3249 "f5", /* VK_F5 0x74 */
3250 "f6", /* VK_F6 0x75 */
3251 "f7", /* VK_F7 0x76 */
3252 "f8", /* VK_F8 0x77 */
3253 "f9", /* VK_F9 0x78 */
3254 "f10", /* VK_F10 0x79 */
3255 "f11", /* VK_F11 0x7A */
3256 "f12", /* VK_F12 0x7B */
3257 "f13", /* VK_F13 0x7C */
3258 "f14", /* VK_F14 0x7D */
3259 "f15", /* VK_F15 0x7E */
3260 "f16", /* VK_F16 0x7F */
3261 "f17", /* VK_F17 0x80 */
3262 "f18", /* VK_F18 0x81 */
3263 "f19", /* VK_F19 0x82 */
3264 "f20", /* VK_F20 0x83 */
3265 "f21", /* VK_F21 0x84 */
3266 "f22", /* VK_F22 0x85 */
3267 "f23", /* VK_F23 0x86 */
3268 "f24", /* VK_F24 0x87 */
3270 0, 0, 0, 0, /* 0x88 .. 0x8B */
3271 0, 0, 0, 0, /* 0x8C .. 0x8F */
3273 "kp-numlock", /* VK_NUMLOCK 0x90 */
3274 "scroll", /* VK_SCROLL 0x91 */
3276 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3277 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3278 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3279 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3280 "kp-end", /* VK_NUMPAD_END 0x96 */
3281 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3282 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3283 "kp-up", /* VK_NUMPAD_UP 0x99 */
3284 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3285 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3286 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3287 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3289 0, 0, /* 0x9E .. 0x9F */
3292 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3293 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3294 * No other API or message will distinguish left and right keys this way.
3298 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3299 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3300 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3301 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3302 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3308 "attn", /* VK_ATTN 0xF6 */
3309 "crsel", /* VK_CRSEL 0xF7 */
3310 "exsel", /* VK_EXSEL 0xF8 */
3311 "ereof", /* VK_EREOF 0xF9 */
3312 "play", /* VK_PLAY 0xFA */
3313 "zoom", /* VK_ZOOM 0xFB */
3314 "noname", /* VK_NONAME 0xFC */
3315 "pa1", /* VK_PA1 0xFD */
3316 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3321 #define FUNCTION_KEY_OFFSET 0xff00
3323 /* You'll notice that this table is arranged to be conveniently
3324 indexed by X Windows keysym values. */
3325 static char *lispy_function_keys
[] =
3327 /* X Keysym value */
3329 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3337 0, 0, 0, /* 0xff10 */
3339 0, 0, 0, 0, 0, 0, 0,
3342 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3343 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3344 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3346 "home", /* 0xff50 */ /* IsCursorKey */
3357 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3368 "break", /* 0xff6b */
3370 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3372 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3373 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3374 0, 0, 0, 0, 0, 0, 0, 0,
3375 "kp-tab", /* 0xff89 */
3377 "kp-enter", /* 0xff8d */
3379 "kp-f1", /* 0xff91 */
3383 "kp-home", /* 0xff95 */
3388 "kp-prior", /* kp-page-up */
3389 "kp-next", /* kp-page-down */
3395 0, 0, 0, 0, 0, 0, 0, 0, 0,
3396 "kp-multiply", /* 0xffaa */
3401 "kp-divide", /* 0xffaf */
3402 "kp-0", /* 0xffb0 */
3403 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3406 "kp-equal", /* 0xffbd */
3407 "f1", /* 0xffbe */ /* IsFunctionKey */
3409 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3410 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3411 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3412 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3413 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3414 0, 0, 0, 0, 0, 0, 0, 0,
3415 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3416 0, 0, 0, 0, 0, 0, 0, "delete"
3419 #endif /* HAVE_NTGUI */
3421 static char *lispy_mouse_names
[] =
3423 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3426 /* Scroll bar parts. */
3427 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3429 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3430 Lisp_Object
*scroll_bar_parts
[] = {
3431 &Qabove_handle
, &Qhandle
, &Qbelow_handle
3435 /* A vector, indexed by button number, giving the down-going location
3436 of currently depressed buttons, both scroll bar and non-scroll bar.
3438 The elements have the form
3439 (BUTTON-NUMBER MODIFIER-MASK . REST)
3440 where REST is the cdr of a position as it would be reported in the event.
3442 The make_lispy_event function stores positions here to tell the
3443 difference between click and drag events, and to store the starting
3444 location to be included in drag events. */
3446 static Lisp_Object button_down_location
;
3448 /* Information about the most recent up-going button event: Which
3449 button, what location, and what time. */
3451 static int last_mouse_button
;
3452 static int last_mouse_x
;
3453 static int last_mouse_y
;
3454 static unsigned long button_down_time
;
3456 /* The maximum time between clicks to make a double-click,
3457 or Qnil to disable double-click detection,
3458 or Qt for no time limit. */
3459 Lisp_Object Vdouble_click_time
;
3461 /* The number of clicks in this multiple-click. */
3463 int double_click_count
;
3465 /* Given a struct input_event, build the lisp event which represents
3466 it. If EVENT is 0, build a mouse movement event from the mouse
3467 movement buffer, which should have a movement event in it.
3469 Note that events must be passed to this function in the order they
3470 are received; this function stores the location of button presses
3471 in order to build drag events when the button is released. */
3474 make_lispy_event (event
)
3475 struct input_event
*event
;
3479 switch (SWITCH_ENUM_CAST (event
->kind
))
3481 /* A simple keystroke. */
3482 case ascii_keystroke
:
3484 Lisp_Object lispy_c
;
3485 int c
= event
->code
& 0377;
3486 /* Turn ASCII characters into control characters
3488 if (event
->modifiers
& ctrl_modifier
)
3489 c
= make_ctrl_char (c
);
3491 /* Add in the other modifier bits. We took care of ctrl_modifier
3492 just above, and the shift key was taken care of by the X code,
3493 and applied to control characters by make_ctrl_char. */
3494 c
|= (event
->modifiers
3495 & (meta_modifier
| alt_modifier
3496 | hyper_modifier
| super_modifier
));
3497 button_down_time
= 0;
3498 XSETFASTINT (lispy_c
, c
);
3502 /* A function key. The symbol may need to have modifier prefixes
3504 case non_ascii_keystroke
:
3505 button_down_time
= 0;
3507 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3508 if (event
->code
== lispy_accent_codes
[i
])
3509 return modify_event_symbol (i
,
3511 Qfunction_key
, Qnil
,
3512 lispy_accent_keys
, &accent_key_syms
,
3513 (sizeof (lispy_accent_keys
)
3514 / sizeof (lispy_accent_keys
[0])));
3516 /* Handle system-specific keysyms. */
3517 if (event
->code
& (1 << 28))
3519 /* We need to use an alist rather than a vector as the cache
3520 since we can't make a vector long enuf. */
3521 if (NILP (current_kboard
->system_key_syms
))
3522 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3523 return modify_event_symbol (event
->code
,
3526 current_kboard
->Vsystem_key_alist
,
3527 0, ¤t_kboard
->system_key_syms
,
3531 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3533 Qfunction_key
, Qnil
,
3534 lispy_function_keys
, &func_key_syms
,
3535 (sizeof (lispy_function_keys
)
3536 / sizeof (lispy_function_keys
[0])));
3540 return Fcons (Qtimer_event
, Fcons (Fcdr (event
->frame_or_window
), Qnil
));
3543 /* A mouse click. Figure out where it is, decide whether it's
3544 a press, click or drag, and build the appropriate structure. */
3546 case scroll_bar_click
:
3548 int button
= event
->code
;
3550 Lisp_Object position
;
3551 Lisp_Object
*start_pos_ptr
;
3552 Lisp_Object start_pos
;
3554 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3557 /* Build the position as appropriate for this mouse click. */
3558 if (event
->kind
== mouse_click
)
3561 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3566 /* Ignore mouse events that were made on frame that
3567 have been deleted. */
3568 if (! FRAME_LIVE_P (f
))
3571 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3572 &column
, &row
, NULL
, 1);
3574 #ifndef USE_X_TOOLKIT
3575 /* In the non-toolkit version, clicks on the menu bar
3576 are ordinary button events in the event buffer.
3577 Distinguish them, and invoke the menu.
3579 (In the toolkit version, the toolkit handles the menu bar
3580 and Emacs doesn't know about it until after the user
3581 makes a selection.) */
3582 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3583 && (event
->modifiers
& down_modifier
))
3585 Lisp_Object items
, item
;
3590 /* Activate the menu bar on the down event. If the
3591 up event comes in before the menu code can deal with it,
3593 if (! (event
->modifiers
& down_modifier
))
3598 items
= FRAME_MENU_BAR_ITEMS (f
);
3599 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 3)
3601 Lisp_Object pos
, string
;
3602 string
= XVECTOR (items
)->contents
[i
+ 1];
3603 pos
= XVECTOR (items
)->contents
[i
+ 2];
3606 if (column
>= XINT (pos
)
3607 && column
< XINT (pos
) + XSTRING (string
)->size
)
3609 item
= XVECTOR (items
)->contents
[i
];
3615 = Fcons (event
->frame_or_window
,
3617 Fcons (Fcons (event
->x
, event
->y
),
3618 Fcons (make_number (event
->timestamp
),
3621 return Fcons (item
, Fcons (position
, Qnil
));
3623 #endif /* not USE_X_TOOLKIT */
3625 window
= window_from_coordinates (f
, column
, row
, &part
);
3627 if (!WINDOWP (window
))
3629 window
= event
->frame_or_window
;
3634 int pixcolumn
, pixrow
;
3635 column
-= XINT (XWINDOW (window
)->left
);
3636 row
-= XINT (XWINDOW (window
)->top
);
3637 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3638 XSETINT (event
->x
, pixcolumn
);
3639 XSETINT (event
->y
, pixrow
);
3644 posn
= Qvertical_line
;
3647 buffer_posn_from_coords (XWINDOW (window
),
3654 Fcons (Fcons (event
->x
, event
->y
),
3655 Fcons (make_number (event
->timestamp
),
3661 Lisp_Object portion_whole
;
3664 window
= event
->frame_or_window
;
3665 portion_whole
= Fcons (event
->x
, event
->y
);
3666 part
= *scroll_bar_parts
[(int) event
->part
];
3670 Fcons (Qvertical_scroll_bar
,
3671 Fcons (portion_whole
,
3672 Fcons (make_number (event
->timestamp
),
3673 Fcons (part
, Qnil
)))));
3676 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3678 start_pos
= *start_pos_ptr
;
3679 *start_pos_ptr
= Qnil
;
3681 is_double
= (button
== last_mouse_button
3682 && XINT (event
->x
) == last_mouse_x
3683 && XINT (event
->y
) == last_mouse_y
3684 && button_down_time
!= 0
3685 && (EQ (Vdouble_click_time
, Qt
)
3686 || (INTEGERP (Vdouble_click_time
)
3687 && ((int)(event
->timestamp
- button_down_time
)
3688 < XINT (Vdouble_click_time
)))));
3689 last_mouse_button
= button
;
3690 last_mouse_x
= XINT (event
->x
);
3691 last_mouse_y
= XINT (event
->y
);
3693 /* If this is a button press, squirrel away the location, so
3694 we can decide later whether it was a click or a drag. */
3695 if (event
->modifiers
& down_modifier
)
3699 double_click_count
++;
3700 event
->modifiers
|= ((double_click_count
> 2)
3705 double_click_count
= 1;
3706 button_down_time
= event
->timestamp
;
3707 *start_pos_ptr
= Fcopy_alist (position
);
3710 /* Now we're releasing a button - check the co-ordinates to
3711 see if this was a click or a drag. */
3712 else if (event
->modifiers
& up_modifier
)
3714 /* If we did not see a down before this up,
3715 ignore the up. Probably this happened because
3716 the down event chose a menu item.
3717 It would be an annoyance to treat the release
3718 of the button that chose the menu item
3719 as a separate event. */
3721 if (!CONSP (start_pos
))
3724 event
->modifiers
&= ~up_modifier
;
3725 #if 0 /* Formerly we treated an up with no down as a click event. */
3726 if (!CONSP (start_pos
))
3727 event
->modifiers
|= click_modifier
;
3731 /* The third element of every position should be the (x,y)
3735 down
= Fnth (make_number (2), start_pos
);
3736 if (EQ (event
->x
, XCONS (down
)->car
)
3737 && EQ (event
->y
, XCONS (down
)->cdr
))
3739 event
->modifiers
|= click_modifier
;
3743 button_down_time
= 0;
3744 event
->modifiers
|= drag_modifier
;
3746 /* Don't check is_double; treat this as multiple
3747 if the down-event was multiple. */
3748 if (double_click_count
> 1)
3749 event
->modifiers
|= ((double_click_count
> 2)
3755 /* Every mouse event should either have the down_modifier or
3756 the up_modifier set. */
3760 /* Get the symbol we should use for the mouse click. */
3763 head
= modify_event_symbol (button
,
3766 lispy_mouse_names
, &mouse_syms
,
3767 (sizeof (lispy_mouse_names
)
3768 / sizeof (lispy_mouse_names
[0])));
3769 if (event
->modifiers
& drag_modifier
)
3774 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
3777 Fcons (make_number (double_click_count
),
3785 #endif /* HAVE_MOUSE */
3787 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3788 case menu_bar_event
:
3789 /* The event value is in the cdr of the frame_or_window slot. */
3790 if (!CONSP (event
->frame_or_window
))
3792 return XCONS (event
->frame_or_window
)->cdr
;
3795 /* The 'kind' field of the event is something we don't recognize. */
3804 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
3806 Lisp_Object bar_window
;
3807 enum scroll_bar_part part
;
3812 /* Is it a scroll bar movement? */
3813 if (frame
&& ! NILP (bar_window
))
3815 Lisp_Object part_sym
;
3817 part_sym
= *scroll_bar_parts
[(int) part
];
3818 return Fcons (Qscroll_bar_movement
,
3819 (Fcons (Fcons (bar_window
,
3820 Fcons (Qvertical_scroll_bar
,
3821 Fcons (Fcons (x
, y
),
3822 Fcons (make_number (time
),
3828 /* Or is it an ordinary mouse movement? */
3830 #endif /* MULTI_FRAME */
3843 /* It's in a frame; which window on that frame? */
3844 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
3846 window
= window_from_coordinates (frame
, column
, row
, &area
);
3851 if (WINDOWP (window
))
3853 int pixcolumn
, pixrow
;
3854 column
-= XINT (XWINDOW (window
)->left
);
3855 row
-= XINT (XWINDOW (window
)->top
);
3856 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
3857 XSETINT (x
, pixcolumn
);
3858 XSETINT (y
, pixrow
);
3863 posn
= Qvertical_line
;
3866 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
3869 else if (frame
!= 0)
3871 XSETFRAME (window
, frame
);
3883 return Fcons (Qmouse_movement
,
3884 Fcons (Fcons (window
,
3886 Fcons (Fcons (x
, y
),
3887 Fcons (make_number (time
),
3893 #endif /* HAVE_MOUSE */
3895 /* Construct a switch frame event. */
3897 make_lispy_switch_frame (frame
)
3900 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
3903 /* Manipulating modifiers. */
3905 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
3907 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
3908 SYMBOL's name of the end of the modifiers; the string from this
3909 position is the unmodified symbol name.
3911 This doesn't use any caches. */
3914 parse_modifiers_uncached (symbol
, modifier_end
)
3918 struct Lisp_String
*name
;
3922 CHECK_SYMBOL (symbol
, 1);
3925 name
= XSYMBOL (symbol
)->name
;
3927 for (i
= 0; i
+2 <= name
->size
; )
3929 int this_mod_end
= 0;
3932 /* See if the name continues with a modifier word.
3933 Check that the word appears, but don't check what follows it.
3934 Set this_mod and this_mod_end to record what we find. */
3936 switch (name
->data
[i
])
3938 #define SINGLE_LETTER_MOD(BIT) \
3939 (this_mod_end = i + 1, this_mod = BIT)
3942 SINGLE_LETTER_MOD (alt_modifier
);
3946 SINGLE_LETTER_MOD (ctrl_modifier
);
3950 SINGLE_LETTER_MOD (hyper_modifier
);
3954 SINGLE_LETTER_MOD (meta_modifier
);
3958 SINGLE_LETTER_MOD (shift_modifier
);
3962 SINGLE_LETTER_MOD (super_modifier
);
3965 #undef SINGLE_LETTER_MOD
3968 /* If we found no modifier, stop looking for them. */
3969 if (this_mod_end
== 0)
3972 /* Check there is a dash after the modifier, so that it
3973 really is a modifier. */
3974 if (this_mod_end
>= name
->size
|| name
->data
[this_mod_end
] != '-')
3977 /* This modifier is real; look for another. */
3978 modifiers
|= this_mod
;
3979 i
= this_mod_end
+ 1;
3982 /* Should we include the `click' modifier? */
3983 if (! (modifiers
& (down_modifier
| drag_modifier
3984 | double_modifier
| triple_modifier
))
3985 && i
+ 7 == name
->size
3986 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
3987 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
3988 modifiers
|= click_modifier
;
3996 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
3997 prepended to the string BASE[0..BASE_LEN-1].
3998 This doesn't use any caches. */
4000 apply_modifiers_uncached (modifiers
, base
, base_len
)
4005 /* Since BASE could contain nulls, we can't use intern here; we have
4006 to use Fintern, which expects a genuine Lisp_String, and keeps a
4009 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4015 /* Only the event queue may use the `up' modifier; it should always
4016 be turned into a click or drag event before presented to lisp code. */
4017 if (modifiers
& up_modifier
)
4020 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4021 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4022 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4023 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4024 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4025 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4026 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4027 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4028 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4029 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4030 /* The click modifier is denoted by the absence of other modifiers. */
4034 mod_len
= p
- new_mods
;
4038 Lisp_Object new_name
;
4040 new_name
= make_uninit_string (mod_len
+ base_len
);
4041 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4042 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
4044 return Fintern (new_name
, Qnil
);
4049 static char *modifier_names
[] =
4051 "up", "down", "drag", "click", "double", "triple", 0, 0,
4052 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4053 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4055 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4057 static Lisp_Object modifier_symbols
;
4059 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4061 lispy_modifier_list (modifiers
)
4064 Lisp_Object modifier_list
;
4067 modifier_list
= Qnil
;
4068 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4069 if (modifiers
& (1<<i
))
4070 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4073 return modifier_list
;
4077 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4078 where UNMODIFIED is the unmodified form of SYMBOL,
4079 MASK is the set of modifiers present in SYMBOL's name.
4080 This is similar to parse_modifiers_uncached, but uses the cache in
4081 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4082 Qevent_symbol_elements property. */
4085 parse_modifiers (symbol
)
4088 Lisp_Object elements
;
4090 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4091 if (CONSP (elements
))
4096 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4097 Lisp_Object unmodified
;
4100 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4101 XSYMBOL (symbol
)->name
->size
- end
),
4104 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4106 XSETFASTINT (mask
, modifiers
);
4107 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4109 /* Cache the parsing results on SYMBOL. */
4110 Fput (symbol
, Qevent_symbol_element_mask
,
4112 Fput (symbol
, Qevent_symbol_elements
,
4113 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4115 /* Since we know that SYMBOL is modifiers applied to unmodified,
4116 it would be nice to put that in unmodified's cache.
4117 But we can't, since we're not sure that parse_modifiers is
4124 /* Apply the modifiers MODIFIERS to the symbol BASE.
4125 BASE must be unmodified.
4127 This is like apply_modifiers_uncached, but uses BASE's
4128 Qmodifier_cache property, if present. It also builds
4129 Qevent_symbol_elements properties, since it has that info anyway.
4131 apply_modifiers copies the value of BASE's Qevent_kind property to
4132 the modified symbol. */
4134 apply_modifiers (modifiers
, base
)
4138 Lisp_Object cache
, index
, entry
, new_symbol
;
4140 /* Mask out upper bits. We don't know where this value's been. */
4141 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4143 /* The click modifier never figures into cache indices. */
4144 cache
= Fget (base
, Qmodifier_cache
);
4145 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4146 entry
= assq_no_quit (index
, cache
);
4149 new_symbol
= XCONS (entry
)->cdr
;
4152 /* We have to create the symbol ourselves. */
4153 new_symbol
= apply_modifiers_uncached (modifiers
,
4154 XSYMBOL (base
)->name
->data
,
4155 XSYMBOL (base
)->name
->size
);
4157 /* Add the new symbol to the base's cache. */
4158 entry
= Fcons (index
, new_symbol
);
4159 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4161 /* We have the parsing info now for free, so add it to the caches. */
4162 XSETFASTINT (index
, modifiers
);
4163 Fput (new_symbol
, Qevent_symbol_element_mask
,
4164 Fcons (base
, Fcons (index
, Qnil
)));
4165 Fput (new_symbol
, Qevent_symbol_elements
,
4166 Fcons (base
, lispy_modifier_list (modifiers
)));
4169 /* Make sure this symbol is of the same kind as BASE.
4171 You'd think we could just set this once and for all when we
4172 intern the symbol above, but reorder_modifiers may call us when
4173 BASE's property isn't set right; we can't assume that just
4174 because it has a Qmodifier_cache property it must have its
4175 Qevent_kind set right as well. */
4176 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4180 kind
= Fget (base
, Qevent_kind
);
4182 Fput (new_symbol
, Qevent_kind
, kind
);
4189 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4190 return a symbol with the modifiers placed in the canonical order.
4191 Canonical order is alphabetical, except for down and drag, which
4192 always come last. The 'click' modifier is never written out.
4194 Fdefine_key calls this to make sure that (for example) C-M-foo
4195 and M-C-foo end up being equivalent in the keymap. */
4198 reorder_modifiers (symbol
)
4201 /* It's hopefully okay to write the code this way, since everything
4202 will soon be in caches, and no consing will be done at all. */
4205 parsed
= parse_modifiers (symbol
);
4206 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4207 XCONS (parsed
)->car
);
4211 /* For handling events, we often want to produce a symbol whose name
4212 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4213 to some base, like the name of a function key or mouse button.
4214 modify_event_symbol produces symbols of this sort.
4216 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4217 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4220 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4221 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4223 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4224 persist between calls to modify_event_symbol that it can use to
4225 store a cache of the symbols it's generated for this NAME_TABLE
4226 before. The object stored there may be a vector or an alist.
4228 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4230 MODIFIERS is a set of modifier bits (as given in struct input_events)
4231 whose prefixes should be applied to the symbol name.
4233 SYMBOL_KIND is the value to be placed in the event_kind property of
4234 the returned symbol.
4236 The symbols we create are supposed to have an
4237 `event-symbol-elements' property, which lists the modifiers present
4238 in the symbol's name. */
4241 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4242 name_table
, symbol_table
, table_size
)
4245 Lisp_Object symbol_kind
;
4246 Lisp_Object name_alist
;
4248 Lisp_Object
*symbol_table
;
4249 unsigned int table_size
;
4252 Lisp_Object symbol_int
;
4254 /* Get rid of the "vendor-specific" bit here. */
4255 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4257 /* Is this a request for a valid symbol? */
4258 if (symbol_num
< 0 || symbol_num
>= table_size
)
4261 if (CONSP (*symbol_table
))
4262 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4264 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4265 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4266 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4267 we've never used that symbol before. */
4270 if (! VECTORP (*symbol_table
)
4271 || XVECTOR (*symbol_table
)->size
!= table_size
)
4275 XSETFASTINT (size
, table_size
);
4276 *symbol_table
= Fmake_vector (size
, Qnil
);
4279 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4282 /* Have we already used this symbol before? */
4285 /* No; let's create it. */
4286 if (!NILP (name_alist
))
4287 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4288 else if (name_table
[symbol_num
])
4289 value
= intern (name_table
[symbol_num
]);
4291 #ifdef HAVE_WINDOW_SYSTEM
4294 char *name
= x_get_keysym_name (symbol_num
);
4296 value
= intern (name
);
4303 sprintf (buf
, "key-%d", symbol_num
);
4304 value
= intern (buf
);
4307 if (CONSP (*symbol_table
))
4308 *symbol_table
= Fcons (value
, *symbol_table
);
4310 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4312 /* Fill in the cache entries for this symbol; this also
4313 builds the Qevent_symbol_elements property, which the user
4315 apply_modifiers (modifiers
& click_modifier
, value
);
4316 Fput (value
, Qevent_kind
, symbol_kind
);
4319 /* Apply modifiers to that symbol. */
4320 return apply_modifiers (modifiers
, value
);
4323 /* Convert a list that represents an event type,
4324 such as (ctrl meta backspace), into the usual representation of that
4325 event type as a number or a symbol. */
4327 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4328 "Convert the event description list EVENT-DESC to an event type.\n\
4329 EVENT-DESC should contain one base event type (a character or symbol)\n\
4330 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4331 drag, down, double or triple).\n\
4332 The return value is an event type (a character or symbol) which\n\
4333 has the same base event type and all the specified modifiers.")
4335 Lisp_Object event_desc
;
4343 while (CONSP (rest
))
4348 elt
= XCONS (rest
)->car
;
4350 /* Given a symbol, see if it is a modifier name. */
4352 this = parse_solitary_modifier (elt
);
4356 else if (!NILP (base
))
4357 error ("Two bases given in one event");
4361 rest
= XCONS (rest
)->cdr
;
4364 /* Let the symbol A refer to the character A. */
4365 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4366 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4368 if (INTEGERP (base
))
4370 /* Turn (shift a) into A. */
4371 if ((modifiers
& shift_modifier
) != 0
4372 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4374 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4375 modifiers
&= ~shift_modifier
;
4378 /* Turn (control a) into C-a. */
4379 if (modifiers
& ctrl_modifier
)
4380 return make_number ((modifiers
& ~ctrl_modifier
)
4381 | make_ctrl_char (XINT (base
)));
4383 return make_number (modifiers
| XINT (base
));
4385 else if (SYMBOLP (base
))
4386 return apply_modifiers (modifiers
, base
);
4388 error ("Invalid base event");
4391 /* Try to recognize SYMBOL as a modifier name.
4392 Return the modifier flag bit, or 0 if not recognized. */
4395 parse_solitary_modifier (symbol
)
4398 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4400 switch (name
->data
[0])
4402 #define SINGLE_LETTER_MOD(BIT) \
4403 if (name->size == 1) \
4406 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4407 if (LEN == name->size \
4408 && ! strncmp (name->data, NAME, LEN)) \
4412 SINGLE_LETTER_MOD (alt_modifier
);
4416 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4420 SINGLE_LETTER_MOD (ctrl_modifier
);
4424 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4425 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4429 SINGLE_LETTER_MOD (hyper_modifier
);
4433 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4437 SINGLE_LETTER_MOD (meta_modifier
);
4441 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4445 SINGLE_LETTER_MOD (shift_modifier
);
4449 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4450 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4451 SINGLE_LETTER_MOD (super_modifier
);
4455 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4456 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4457 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4461 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4464 #undef SINGLE_LETTER_MOD
4465 #undef MULTI_LETTER_MOD
4471 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4472 Such a list is not valid as an event,
4473 but it can be a Lucid-style event type list. */
4476 lucid_event_type_list_p (object
)
4481 if (! CONSP (object
))
4484 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4487 elt
= XCONS (tail
)->car
;
4488 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4495 /* Store into *addr a value nonzero if terminal input chars are available.
4496 Serves the purpose of ioctl (0, FIONREAD, addr)
4497 but works even if FIONREAD does not exist.
4498 (In fact, this may actually read some input.)
4500 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4503 get_input_pending (addr
, do_timers_now
)
4507 /* First of all, have we already counted some input? */
4508 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4510 /* If input is being read as it arrives, and we have none, there is none. */
4511 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4514 /* Try to read some input and see how much we get. */
4516 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4519 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4522 gobble_input (expected
)
4527 if (interrupt_input
)
4530 mask
= sigblockx (SIGIO
);
4531 read_avail_input (expected
);
4535 #ifdef POLL_FOR_INPUT
4536 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4539 mask
= sigblockx (SIGALRM
);
4540 read_avail_input (expected
);
4546 read_avail_input (expected
);
4550 /* Put a buffer_switch_event in the buffer
4551 so that read_key_sequence will notice the new current buffer. */
4553 record_asynch_buffer_change ()
4555 struct input_event event
;
4558 event
.kind
= buffer_switch_event
;
4559 event
.frame_or_window
= Qnil
;
4562 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4563 The purpose of the event is to make read_key_sequence look up the
4564 keymaps again. If we aren't in read_key_sequence, we don't need one,
4565 and the event could cause trouble by messing up (input-pending-p). */
4566 tem
= Fwaiting_for_user_input_p ();
4570 /* We never need these events if we have no asynchronous subprocesses. */
4574 /* Make sure no interrupt happens while storing the event. */
4576 if (interrupt_input
)
4579 mask
= sigblockx (SIGIO
);
4580 kbd_buffer_store_event (&event
);
4587 kbd_buffer_store_event (&event
);
4594 /* Read any terminal input already buffered up by the system
4595 into the kbd_buffer, but do not wait.
4597 EXPECTED should be nonzero if the caller knows there is some input.
4599 Except on VMS, all input is read by this function.
4600 If interrupt_input is nonzero, this function MUST be called
4601 only when SIGIO is blocked.
4603 Returns the number of keyboard chars read, or -1 meaning
4604 this is a bad time to try to read input. */
4607 read_avail_input (expected
)
4610 struct input_event buf
[KBD_BUFFER_SIZE
];
4614 if (read_socket_hook
)
4615 /* No need for FIONREAD or fcntl; just say don't wait. */
4616 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
,
4617 expected
, expected
);
4620 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
4621 the kbd_buffer can really hold. That may prevent loss
4622 of characters on some systems when input is stuffed at us. */
4623 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
4626 /* Determine how many characters we should *try* to read. */
4629 #else /* not WINDOWSNT */
4631 n_to_read
= dos_keysns ();
4634 #else /* not MSDOS */
4636 /* Find out how much input is available. */
4637 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
4638 /* Formerly simply reported no input, but that sometimes led to
4639 a failure of Emacs to terminate.
4640 SIGHUP seems appropriate if we can't reach the terminal. */
4641 /* ??? Is it really right to send the signal just to this process
4642 rather than to the whole process group?
4643 Perhaps on systems with FIONREAD Emacs is alone in its group. */
4644 kill (getpid (), SIGHUP
);
4647 if (n_to_read
> sizeof cbuf
)
4648 n_to_read
= sizeof cbuf
;
4649 #else /* no FIONREAD */
4650 #if defined (USG) || defined (DGUX)
4651 /* Read some input if available, but don't wait. */
4652 n_to_read
= sizeof cbuf
;
4653 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
4658 #endif /* not MSDOS */
4659 #endif /* not WINDOWSNT */
4661 /* Now read; for one reason or another, this will not block.
4662 NREAD is set to the number of chars read. */
4666 cbuf
[0] = dos_keyread ();
4669 nread
= read (input_fd
, cbuf
, n_to_read
);
4671 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
4672 /* The kernel sometimes fails to deliver SIGHUP for ptys.
4673 This looks incorrect, but it isn't, because _BSD causes
4674 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
4675 and that causes a value other than 0 when there is no input. */
4681 /* We used to retry the read if it was interrupted.
4682 But this does the wrong thing when O_NDELAY causes
4683 an EAGAIN error. Does anybody know of a situation
4684 where a retry is actually needed? */
4686 nread
< 0 && (errno
== EAGAIN
4700 #if defined (USG) || defined (DGUX)
4701 fcntl (input_fd
, F_SETFL
, 0);
4702 #endif /* USG or DGUX */
4703 #endif /* no FIONREAD */
4704 for (i
= 0; i
< nread
; i
++)
4706 buf
[i
].kind
= ascii_keystroke
;
4707 buf
[i
].modifiers
= 0;
4708 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
4709 buf
[i
].modifiers
= meta_modifier
;
4713 buf
[i
].code
= cbuf
[i
];
4715 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
4717 buf
[i
].frame_or_window
= Qnil
;
4722 /* Scan the chars for C-g and store them in kbd_buffer. */
4723 for (i
= 0; i
< nread
; i
++)
4725 kbd_buffer_store_event (&buf
[i
]);
4726 /* Don't look at input that follows a C-g too closely.
4727 This reduces lossage due to autorepeat on C-g. */
4728 if (buf
[i
].kind
== ascii_keystroke
4729 && buf
[i
].code
== quit_char
)
4735 #endif /* not VMS */
4737 #ifdef SIGIO /* for entire page */
4738 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4741 input_available_signal (signo
)
4744 /* Must preserve main program's value of errno. */
4745 int old_errno
= errno
;
4747 extern int select_alarmed
;
4751 /* USG systems forget handlers when they are used;
4752 must reestablish each time */
4753 signal (signo
, input_available_signal
);
4760 if (input_available_clear_time
)
4761 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
4766 nread
= read_avail_input (1);
4767 /* -1 means it's not ok to read the input now.
4768 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
4769 0 means there was no keyboard input available. */
4774 select_alarmed
= 1; /* Force the select emulator back to life */
4785 /* Send ourselves a SIGIO.
4787 This function exists so that the UNBLOCK_INPUT macro in
4788 blockinput.h can have some way to take care of input we put off
4789 dealing with, without assuming that every file which uses
4790 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
4792 reinvoke_input_signal ()
4801 /* Return the prompt-string of a sparse keymap.
4802 This is the first element which is a string.
4803 Return nil if there is none. */
4811 register Lisp_Object tem
;
4820 static void menu_bar_item ();
4821 static void menu_bar_one_keymap ();
4823 /* These variables hold the vector under construction within
4824 menu_bar_items and its subroutines, and the current index
4825 for storing into that vector. */
4826 static Lisp_Object menu_bar_items_vector
;
4827 static int menu_bar_items_index
;
4829 /* Return a vector of menu items for a menu bar, appropriate
4830 to the current buffer. Each item has three elements in the vector:
4833 OLD is an old vector we can optionally reuse, or nil. */
4836 menu_bar_items (old
)
4839 /* The number of keymaps we're scanning right now, and the number of
4840 keymaps we have allocated space for. */
4843 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
4844 in the current keymaps, or nil where it is not a prefix. */
4847 Lisp_Object def
, tem
, tail
;
4856 struct gcpro gcpro1
;
4858 /* In order to build the menus, we need to call the keymap
4859 accessors. They all call QUIT. But this function is called
4860 during redisplay, during which a quit is fatal. So inhibit
4861 quitting while building the menus.
4862 We do this instead of specbind because (1) errors will clear it anyway
4863 and (2) this avoids risk of specpdl overflow. */
4864 oquit
= Vinhibit_quit
;
4868 menu_bar_items_vector
= old
;
4870 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
4871 menu_bar_items_index
= 0;
4873 GCPRO1 (menu_bar_items_vector
);
4875 /* Build our list of keymaps.
4876 If we recognize a function key and replace its escape sequence in
4877 keybuf with its symbol, or if the sequence starts with a mouse
4878 click and we need to switch buffers, we jump back here to rebuild
4879 the initial keymaps from the current buffer. */
4883 /* Should overriding-terminal-local-map and overriding-local-map apply? */
4884 if (!NILP (Voverriding_local_map_menu_flag
))
4886 /* Yes, use them (if non-nil) as well as the global map. */
4887 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
4889 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
4890 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
4891 if (!NILP (Voverriding_local_map
))
4892 maps
[nmaps
++] = Voverriding_local_map
;
4896 /* No, so use major and minor mode keymaps. */
4897 nmaps
= current_minor_maps (NULL
, &tmaps
);
4898 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
4899 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
4900 #ifdef USE_TEXT_PROPERTIES
4901 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
4903 maps
[nmaps
++] = current_buffer
->keymap
;
4906 maps
[nmaps
++] = current_global_map
;
4909 /* Look up in each map the dummy prefix key `menu-bar'. */
4913 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
4915 if (! NILP (maps
[mapno
]))
4916 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
4920 tem
= Fkeymapp (def
);
4922 menu_bar_one_keymap (def
);
4925 /* Move to the end those items that should be at the end. */
4927 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4930 int end
= menu_bar_items_index
;
4932 for (i
= 0; i
< end
; i
+= 3)
4933 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
4935 Lisp_Object tem0
, tem1
, tem2
;
4936 /* Move the item at index I to the end,
4937 shifting all the others forward. */
4938 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
4939 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
4940 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
4942 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
4943 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
4944 (end
- i
- 3) * sizeof (Lisp_Object
));
4945 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem0
;
4946 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem1
;
4947 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem2
;
4952 /* Add nil, nil, nil at the end. */
4953 i
= menu_bar_items_index
;
4954 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
4957 int newsize
= 2 * i
;
4958 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
4959 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
4960 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
4961 menu_bar_items_vector
= tem
;
4963 /* Add this item. */
4964 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4965 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4966 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
4967 menu_bar_items_index
= i
;
4969 Vinhibit_quit
= oquit
;
4971 return menu_bar_items_vector
;
4974 /* Scan one map KEYMAP, accumulating any menu items it defines
4975 in menu_bar_items_vector. */
4978 menu_bar_one_keymap (keymap
)
4981 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
4983 /* Loop over all keymap entries that have menu strings. */
4984 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4986 item
= XCONS (tail
)->car
;
4989 key
= XCONS (item
)->car
;
4990 binding
= XCONS (item
)->cdr
;
4991 if (CONSP (binding
))
4993 item_string
= XCONS (binding
)->car
;
4994 if (STRINGP (item_string
))
4995 menu_bar_item (key
, item_string
, Fcdr (binding
));
4997 else if (EQ (binding
, Qundefined
))
4998 menu_bar_item (key
, Qnil
, binding
);
5000 else if (VECTORP (item
))
5002 /* Loop over the char values represented in the vector. */
5003 int len
= XVECTOR (item
)->size
;
5005 for (c
= 0; c
< len
; c
++)
5007 Lisp_Object character
;
5008 XSETFASTINT (character
, c
);
5009 binding
= XVECTOR (item
)->contents
[c
];
5010 if (CONSP (binding
))
5012 item_string
= XCONS (binding
)->car
;
5013 if (STRINGP (item_string
))
5014 menu_bar_item (key
, item_string
, Fcdr (binding
));
5016 else if (EQ (binding
, Qundefined
))
5017 menu_bar_item (key
, Qnil
, binding
);
5023 /* This is used as the handler when calling internal_condition_case_1. */
5026 menu_bar_item_1 (arg
)
5032 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5033 If there's already an item for KEY, add this DEF to it. */
5036 menu_bar_item (key
, item_string
, def
)
5037 Lisp_Object key
, item_string
, def
;
5040 Lisp_Object enabled
;
5043 if (EQ (def
, Qundefined
))
5045 /* If a map has an explicit `undefined' as definition,
5046 discard any previously made menu bar item. */
5048 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
5049 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5051 if (menu_bar_items_index
> i
+ 3)
5052 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3],
5053 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5054 (menu_bar_items_index
- i
- 3) * sizeof (Lisp_Object
));
5055 menu_bar_items_index
-= 3;
5059 /* If there's no definition for this key yet,
5060 just ignore `undefined'. */
5064 /* See if this entry is enabled. */
5069 /* No property, or nil, means enable.
5070 Otherwise, enable if value is not nil. */
5071 tem
= Fget (def
, Qmenu_enable
);
5073 /* (condition-case nil (eval tem)
5075 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5079 /* Ignore this item if it's not enabled. */
5083 /* Find any existing item for this KEY. */
5084 for (i
= 0; i
< menu_bar_items_index
; i
+= 3)
5085 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5088 /* If we did not find this KEY, add it at the end. */
5089 if (i
== menu_bar_items_index
)
5091 /* If vector is too small, get a bigger one. */
5092 if (i
+ 3 > XVECTOR (menu_bar_items_vector
)->size
)
5095 int newsize
= 2 * i
;
5096 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5097 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5098 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5099 menu_bar_items_vector
= tem
;
5101 /* Add this item. */
5102 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5103 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5104 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5105 menu_bar_items_index
= i
;
5107 /* We did find an item for this KEY. Add DEF to its list of maps. */
5111 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5112 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5116 /* Read a character using menus based on maps in the array MAPS.
5117 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5118 Return t if we displayed a menu but the user rejected it.
5120 PREV_EVENT is the previous input event, or nil if we are reading
5121 the first event of a key sequence.
5123 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5124 if we used a mouse menu to read the input, or zero otherwise. If
5125 USED_MOUSE_MENU is null, we don't dereference it.
5127 The prompting is done based on the prompt-string of the map
5128 and the strings associated with various map elements.
5130 This can be done with X menus or with menus put in the minibuf.
5131 These are done in different ways, depending on how the input will be read.
5132 Menus using X are done after auto-saving in read-char, getting the input
5133 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5134 and do auto-saving in the inner call of read_char. */
5137 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5140 Lisp_Object prev_event
;
5141 int *used_mouse_menu
;
5144 register Lisp_Object name
;
5145 Lisp_Object rest
, vector
;
5147 if (used_mouse_menu
)
5148 *used_mouse_menu
= 0;
5150 /* Use local over global Menu maps */
5152 if (! menu_prompting
)
5155 /* Optionally disregard all but the global map. */
5156 if (inhibit_local_menu_bar_menus
)
5158 maps
+= (nmaps
- 1);
5162 /* Get the menu name from the first map that has one (a prompt string). */
5163 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5165 name
= map_prompt (maps
[mapno
]);
5170 /* If we don't have any menus, just read a character normally. */
5175 /* If we got to this point via a mouse click,
5176 use a real menu for mouse selection. */
5177 if (EVENT_HAS_PARAMETERS (prev_event
)
5178 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5180 /* Display the menu and get the selection. */
5181 Lisp_Object
*realmaps
5182 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5186 /* Use the maps that are not nil. */
5187 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5188 if (!NILP (maps
[mapno
]))
5189 realmaps
[nmaps1
++] = maps
[mapno
];
5191 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5196 /* If we got multiple events, unread all but
5198 There is no way to prevent those unread events
5199 from showing up later in last_nonmenu_event.
5200 So turn symbol and integer events into lists,
5201 to indicate that they came from a mouse menu,
5202 so that when present in last_nonmenu_event
5203 they won't confuse things. */
5204 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5205 tem
= XCONS (tem
)->cdr
)
5206 if (SYMBOLP (XCONS (tem
)->car
)
5207 || INTEGERP (XCONS (tem
)->car
))
5209 = Fcons (XCONS (tem
)->car
, Qnil
);
5211 /* If we got more than one event, put all but the first
5212 onto this list to be read later.
5213 Return just the first event now. */
5214 Vunread_command_events
5215 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5216 value
= XCONS (value
)->car
;
5218 else if (NILP (value
))
5220 if (used_mouse_menu
)
5221 *used_mouse_menu
= 1;
5224 #endif /* HAVE_MENUS */
5228 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5229 We make this bigger when necessary, and never free it. */
5230 static char *read_char_minibuf_menu_text
;
5231 /* Size of that buffer. */
5232 static int read_char_minibuf_menu_width
;
5235 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5241 register Lisp_Object name
;
5243 int width
= FRAME_WIDTH (selected_frame
) - 4;
5246 Lisp_Object rest
, vector
;
5249 if (! menu_prompting
)
5252 /* Make sure we have a big enough buffer for the menu text. */
5253 if (read_char_minibuf_menu_text
== 0)
5255 read_char_minibuf_menu_width
= width
+ 4;
5256 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5258 else if (width
+ 4 > read_char_minibuf_menu_width
)
5260 read_char_minibuf_menu_width
= width
+ 4;
5261 read_char_minibuf_menu_text
5262 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5264 menu
= read_char_minibuf_menu_text
;
5266 /* Get the menu name from the first map that has one (a prompt string). */
5267 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5269 name
= map_prompt (maps
[mapno
]);
5274 /* If we don't have any menus, just read a character normally. */
5278 /* Prompt string always starts with map's prompt, and a space. */
5279 strcpy (menu
, XSTRING (name
)->data
);
5280 nlength
= XSTRING (name
)->size
;
5281 menu
[nlength
++] = ':';
5282 menu
[nlength
++] = ' ';
5285 /* Start prompting at start of first map. */
5289 /* Present the documented bindings, a line at a time. */
5296 Lisp_Object orig_defn_macro
;
5298 /* Loop over elements of map. */
5303 /* If reached end of map, start at beginning of next map. */
5307 /* At end of last map, wrap around to first map if just starting,
5308 or end this line if already have something on it. */
5312 if (notfirst
|| nobindings
) break;
5317 /* Look at the next element of the map. */
5319 elt
= XVECTOR (vector
)->contents
[idx
];
5321 elt
= Fcar_safe (rest
);
5323 if (idx
< 0 && VECTORP (elt
))
5325 /* If we found a dense table in the keymap,
5326 advanced past it, but start scanning its contents. */
5327 rest
= Fcdr_safe (rest
);
5333 /* An ordinary element. */
5338 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5339 event
= Fcar_safe (elt
);
5343 s
= Fcar_safe (elt
); /* vector */
5344 XSETINT (event
, idx
);
5347 /* Ignore the element if it has no prompt string. */
5348 if (STRINGP (s
) && INTEGERP (event
))
5350 /* 1 if the char to type matches the string. */
5352 Lisp_Object upcased_event
, downcased_event
;
5355 upcased_event
= Fupcase (event
);
5356 downcased_event
= Fdowncase (event
);
5357 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5358 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5360 desc
= Fsingle_key_description (event
);
5362 /* If we have room for the prompt string, add it to this line.
5363 If this is the first on the line, always add it. */
5364 if ((XSTRING (s
)->size
+ i
+ 2
5365 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5371 /* Punctuate between strings. */
5374 strcpy (menu
+ i
, ", ");
5380 /* If the char to type doesn't match the string's
5381 first char, explicitly show what char to type. */
5384 /* Add as much of string as fits. */
5385 thiswidth
= XSTRING (desc
)->size
;
5386 if (thiswidth
+ i
> width
)
5387 thiswidth
= width
- i
;
5388 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5390 strcpy (menu
+ i
, " = ");
5394 /* Add as much of string as fits. */
5395 thiswidth
= XSTRING (s
)->size
;
5396 if (thiswidth
+ i
> width
)
5397 thiswidth
= width
- i
;
5398 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5404 /* If this element does not fit, end the line now,
5405 and save the element for the next line. */
5406 strcpy (menu
+ i
, "...");
5411 /* Move past this element. */
5412 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5413 /* Handle reaching end of dense table. */
5418 rest
= Fcdr_safe (rest
);
5422 /* Prompt with that and read response. */
5425 /* Make believe its not a keyboard macro in case the help char
5426 is pressed. Help characters are not recorded because menu prompting
5427 is not used on replay.
5429 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5430 current_kboard
->defining_kbd_macro
= Qnil
;
5432 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5433 while (BUFFERP (obj
));
5434 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5436 if (!INTEGERP (obj
))
5441 if (! EQ (obj
, menu_prompt_more_char
)
5442 && (!INTEGERP (menu_prompt_more_char
)
5443 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5445 if (!NILP (current_kboard
->defining_kbd_macro
))
5446 store_kbd_macro_char (obj
);
5449 /* Help char - go round again */
5453 /* Reading key sequences. */
5455 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5456 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5457 keymap, or nil otherwise. Return the index of the first keymap in
5458 which KEY has any binding, or NMAPS if no map has a binding.
5460 If KEY is a meta ASCII character, treat it like meta-prefix-char
5461 followed by the corresponding non-meta character. Keymaps in
5462 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5465 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5468 NEXT may be the same array as CURRENT. */
5471 follow_key (key
, nmaps
, current
, defs
, next
)
5473 Lisp_Object
*current
, *defs
, *next
;
5476 int i
, first_binding
;
5479 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5480 followed by the corresponding non-meta character.
5481 Put the results into DEFS, since we are going to alter that anyway.
5482 Do not alter CURRENT or NEXT. */
5483 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5485 for (i
= 0; i
< nmaps
; i
++)
5486 if (! NILP (current
[i
]))
5489 def
= get_keyelt (access_keymap (current
[i
],
5490 meta_prefix_char
, 1, 0));
5492 /* Note that since we pass the resulting bindings through
5493 get_keymap_1, non-prefix bindings for meta-prefix-char
5495 defs
[i
] = get_keymap_1 (def
, 0, 1);
5501 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5504 first_binding
= nmaps
;
5505 for (i
= nmaps
- 1; i
>= 0; i
--)
5507 if (! NILP (current
[i
]))
5515 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0));
5516 if (! NILP (defs
[i
]))
5523 /* Given the set of bindings we've found, produce the next set of maps. */
5524 if (first_binding
< nmaps
)
5525 for (i
= 0; i
< nmaps
; i
++)
5526 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5528 return first_binding
;
5531 /* Read a sequence of keys that ends with a non prefix character,
5532 storing it in KEYBUF, a buffer of size BUFSIZE.
5534 Return the length of the key sequence stored.
5535 Return -1 if the user rejected a command menu.
5537 Echo starting immediately unless `prompt' is 0.
5539 Where a key sequence ends depends on the currently active keymaps.
5540 These include any minor mode keymaps active in the current buffer,
5541 the current buffer's local map, and the global map.
5543 If a key sequence has no other bindings, we check Vfunction_key_map
5544 to see if some trailing subsequence might be the beginning of a
5545 function key's sequence. If so, we try to read the whole function
5546 key, and substitute its symbolic name into the key sequence.
5548 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5549 `double-' events into similar click events, if that would make them
5550 bound. We try to turn `triple-' events first into `double-' events,
5553 If we get a mouse click in a mode line, vertical divider, or other
5554 non-text area, we treat the click as if it were prefixed by the
5555 symbol denoting that area - `mode-line', `vertical-line', or
5558 If the sequence starts with a mouse click, we read the key sequence
5559 with respect to the buffer clicked on, not the current buffer.
5561 If the user switches frames in the midst of a key sequence, we put
5562 off the switch-frame event until later; the next call to
5563 read_char will return it. */
5566 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
5567 can_return_switch_frame
)
5568 Lisp_Object
*keybuf
;
5571 int dont_downcase_last
;
5572 int can_return_switch_frame
;
5574 int count
= specpdl_ptr
- specpdl
;
5576 /* How many keys there are in the current key sequence. */
5579 /* The length of the echo buffer when we started reading, and
5580 the length of this_command_keys when we started reading. */
5584 /* The number of keymaps we're scanning right now, and the number of
5585 keymaps we have allocated space for. */
5587 int nmaps_allocated
= 0;
5589 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
5590 the current keymaps. */
5593 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5594 in the current keymaps, or nil where it is not a prefix. */
5595 Lisp_Object
*submaps
;
5597 /* The local map to start out with at start of key sequence. */
5598 Lisp_Object orig_local_map
;
5600 /* 1 if we have already considered switching to the local-map property
5601 of the place where a mouse click occurred. */
5602 int localized_local_map
= 0;
5604 /* The index in defs[] of the first keymap that has a binding for
5605 this key sequence. In other words, the lowest i such that
5606 defs[i] is non-nil. */
5609 /* If t < mock_input, then KEYBUF[t] should be read as the next
5612 We use this to recover after recognizing a function key. Once we
5613 realize that a suffix of the current key sequence is actually a
5614 function key's escape sequence, we replace the suffix with the
5615 function key's binding from Vfunction_key_map. Now keybuf
5616 contains a new and different key sequence, so the echo area,
5617 this_command_keys, and the submaps and defs arrays are wrong. In
5618 this situation, we set mock_input to t, set t to 0, and jump to
5619 restart_sequence; the loop will read keys from keybuf up until
5620 mock_input, thus rebuilding the state; and then it will resume
5621 reading characters from the keyboard. */
5624 /* If the sequence is unbound in submaps[], then
5625 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
5626 and fkey_map is its binding.
5628 These might be > t, indicating that all function key scanning
5629 should hold off until t reaches them. We do this when we've just
5630 recognized a function key, to avoid searching for the function
5631 key's again in Vfunction_key_map. */
5632 int fkey_start
= 0, fkey_end
= 0;
5633 Lisp_Object fkey_map
;
5635 /* Likewise, for key_translation_map. */
5636 int keytran_start
= 0, keytran_end
= 0;
5637 Lisp_Object keytran_map
;
5639 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
5640 we put it off for later. While we're reading, we keep the event here. */
5641 Lisp_Object delayed_switch_frame
;
5643 /* See the comment below... */
5644 #if defined (GOBBLE_FIRST_EVENT)
5645 Lisp_Object first_event
;
5648 Lisp_Object original_uppercase
;
5649 int original_uppercase_position
= -1;
5651 /* Gets around Microsoft compiler limitations. */
5654 struct buffer
*starting_buffer
;
5656 /* Nonzero if we seem to have got the beginning of a binding
5657 in function_key_map. */
5658 int function_key_possible
= 0;
5659 int key_translation_possible
= 0;
5661 /* Save the status of key translation before each step,
5662 so that we can restore this after downcasing. */
5663 Lisp_Object prev_fkey_map
;
5664 Lisp_Object prev_fkey_start
;
5665 Lisp_Object prev_fkey_end
;
5667 Lisp_Object prev_keytran_map
;
5668 Lisp_Object prev_keytran_start
;
5669 Lisp_Object prev_keytran_end
;
5673 last_nonmenu_event
= Qnil
;
5675 delayed_switch_frame
= Qnil
;
5676 fkey_map
= Vfunction_key_map
;
5677 keytran_map
= Vkey_translation_map
;
5679 /* If there is no function-key-map, turn off function key scanning. */
5680 if (NILP (Fkeymapp (Vfunction_key_map
)))
5681 fkey_start
= fkey_end
= bufsize
+ 1;
5683 /* If there is no key-translation-map, turn off scanning. */
5684 if (NILP (Fkeymapp (Vkey_translation_map
)))
5685 keytran_start
= keytran_end
= bufsize
+ 1;
5690 echo_prompt (XSTRING (prompt
)->data
);
5691 else if (cursor_in_echo_area
&& echo_keystrokes
)
5692 /* This doesn't put in a dash if the echo buffer is empty, so
5693 you don't always see a dash hanging out in the minibuffer. */
5697 /* Record the initial state of the echo area and this_command_keys;
5698 we will need to restore them if we replay a key sequence. */
5700 echo_start
= echo_length ();
5701 keys_start
= this_command_key_count
;
5703 #if defined (GOBBLE_FIRST_EVENT)
5704 /* This doesn't quite work, because some of the things that read_char
5705 does cannot safely be bypassed. It seems too risky to try to make
5708 /* Read the first char of the sequence specially, before setting
5709 up any keymaps, in case a filter runs and switches buffers on us. */
5710 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
5712 #endif /* GOBBLE_FIRST_EVENT */
5714 orig_local_map
= get_local_map (PT
, current_buffer
);
5716 /* We jump here when the key sequence has been thoroughly changed, and
5717 we need to rescan it starting from the beginning. When we jump here,
5718 keybuf[0..mock_input] holds the sequence we should reread. */
5721 starting_buffer
= current_buffer
;
5722 function_key_possible
= 0;
5723 key_translation_possible
= 0;
5725 /* Build our list of keymaps.
5726 If we recognize a function key and replace its escape sequence in
5727 keybuf with its symbol, or if the sequence starts with a mouse
5728 click and we need to switch buffers, we jump back here to rebuild
5729 the initial keymaps from the current buffer. */
5733 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
5734 || !NILP (Voverriding_local_map
))
5736 if (3 > nmaps_allocated
)
5738 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
5739 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
5740 nmaps_allocated
= 3;
5743 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5744 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5745 if (!NILP (Voverriding_local_map
))
5746 submaps
[nmaps
++] = Voverriding_local_map
;
5750 nmaps
= current_minor_maps (0, &maps
);
5751 if (nmaps
+ 2 > nmaps_allocated
)
5753 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
5754 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
5755 nmaps_allocated
= nmaps
+ 2;
5757 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
5758 #ifdef USE_TEXT_PROPERTIES
5759 submaps
[nmaps
++] = orig_local_map
;
5761 submaps
[nmaps
++] = current_buffer
->keymap
;
5764 submaps
[nmaps
++] = current_global_map
;
5767 /* Find an accurate initial value for first_binding. */
5768 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
5769 if (! NILP (submaps
[first_binding
]))
5772 /* Start from the beginning in keybuf. */
5775 /* These are no-ops the first time through, but if we restart, they
5776 revert the echo area and this_command_keys to their original state. */
5777 this_command_key_count
= keys_start
;
5778 if (INTERACTIVE
&& t
< mock_input
)
5779 echo_truncate (echo_start
);
5781 /* If the best binding for the current key sequence is a keymap, or
5782 we may be looking at a function key's escape sequence, keep on
5784 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
5785 || (first_binding
>= nmaps
5787 /* mock input is never part of a function key's sequence. */
5788 && mock_input
<= fkey_start
)
5789 || (first_binding
>= nmaps
5790 && keytran_start
< t
&& key_translation_possible
)
5791 /* Don't return in the middle of a possible function key sequence,
5792 if the only bindings we found were via case conversion.
5793 Thus, if ESC O a has a function-key-map translation
5794 and ESC o has a binding, don't return after ESC O,
5795 so that we can translate ESC O plus the next character. */
5799 int used_mouse_menu
= 0;
5801 /* Where the last real key started. If we need to throw away a
5802 key that has expanded into more than one element of keybuf
5803 (say, a mouse click on the mode line which is being treated
5804 as [mode-line (mouse-...)], then we backtrack to this point
5806 int last_real_key_start
;
5808 /* These variables are analogous to echo_start and keys_start;
5809 while those allow us to restart the entire key sequence,
5810 echo_local_start and keys_local_start allow us to throw away
5812 int echo_local_start
, keys_local_start
, local_first_binding
;
5815 error ("Key sequence too long");
5818 echo_local_start
= echo_length ();
5819 keys_local_start
= this_command_key_count
;
5820 local_first_binding
= first_binding
;
5823 /* These are no-ops, unless we throw away a keystroke below and
5824 jumped back up to replay_key; in that case, these restore the
5825 variables to their original state, allowing us to replay the
5827 if (INTERACTIVE
&& t
< mock_input
)
5828 echo_truncate (echo_local_start
);
5829 this_command_key_count
= keys_local_start
;
5830 first_binding
= local_first_binding
;
5832 /* By default, assume each event is "real". */
5833 last_real_key_start
= t
;
5835 /* Does mock_input indicate that we are re-reading a key sequence? */
5839 add_command_key (key
);
5840 if (echo_keystrokes
)
5844 /* If not, we should actually read a character. */
5847 struct buffer
*buf
= current_buffer
;
5851 KBOARD
*interrupted_kboard
= current_kboard
;
5852 struct frame
*interrupted_frame
= selected_frame
;
5853 if (setjmp (wrong_kboard_jmpbuf
))
5855 if (!NILP (delayed_switch_frame
))
5857 interrupted_kboard
->kbd_queue
5858 = Fcons (delayed_switch_frame
,
5859 interrupted_kboard
->kbd_queue
);
5860 delayed_switch_frame
= Qnil
;
5863 interrupted_kboard
->kbd_queue
5864 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
5866 /* If the side queue is non-empty, ensure it begins with a
5867 switch-frame, so we'll replay it in the right context. */
5868 if (CONSP (interrupted_kboard
->kbd_queue
)
5869 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
5870 !(EVENT_HAS_PARAMETERS (key
)
5871 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
5875 XSETFRAME (frame
, interrupted_frame
);
5876 interrupted_kboard
->kbd_queue
5877 = Fcons (make_lispy_switch_frame (frame
),
5878 interrupted_kboard
->kbd_queue
);
5881 orig_local_map
= get_local_map (PT
, current_buffer
);
5882 goto replay_sequence
;
5885 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
5889 /* read_char returns t when it shows a menu and the user rejects it.
5894 /* read_char returns -1 at the end of a macro.
5895 Emacs 18 handles this by returning immediately with a
5896 zero, so that's what we'll do. */
5897 if (INTEGERP (key
) && XINT (key
) == -1)
5900 /* The Microsoft C compiler can't handle the goto that
5906 /* If the current buffer has been changed from under us, the
5907 keymap may have changed, so replay the sequence. */
5911 orig_local_map
= get_local_map (PT
, current_buffer
);
5912 goto replay_sequence
;
5915 /* If we have a quit that was typed in another frame, and
5916 quit_throw_to_read_char switched buffers,
5917 replay to get the right keymap. */
5918 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
5923 orig_local_map
= get_local_map (PT
, current_buffer
);
5924 goto replay_sequence
;
5930 /* Clicks in non-text areas get prefixed by the symbol
5931 in their CHAR-ADDRESS field. For example, a click on
5932 the mode line is prefixed by the symbol `mode-line'.
5934 Furthermore, key sequences beginning with mouse clicks
5935 are read using the keymaps of the buffer clicked on, not
5936 the current buffer. So we may have to switch the buffer
5939 When we turn one event into two events, we must make sure
5940 that neither of the two looks like the original--so that,
5941 if we replay the events, they won't be expanded again.
5942 If not for this, such reexpansion could happen either here
5943 or when user programs play with this-command-keys. */
5944 if (EVENT_HAS_PARAMETERS (key
))
5948 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
5949 if (EQ (kind
, Qmouse_click
))
5951 Lisp_Object window
, posn
;
5953 window
= POSN_WINDOW (EVENT_START (key
));
5954 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
5957 /* We're looking at the second event of a
5958 sequence which we expanded before. Set
5959 last_real_key_start appropriately. */
5961 last_real_key_start
= t
- 1;
5964 /* Key sequences beginning with mouse clicks are
5965 read using the keymaps in the buffer clicked on,
5966 not the current buffer. If we're at the
5967 beginning of a key sequence, switch buffers. */
5968 if (last_real_key_start
== 0
5970 && BUFFERP (XWINDOW (window
)->buffer
)
5971 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
5976 /* Arrange to go back to the original buffer once we're
5977 done reading the key sequence. Note that we can't
5978 use save_excursion_{save,restore} here, because they
5979 save point as well as the current buffer; we don't
5980 want to save point, because redisplay may change it,
5981 to accommodate a Fset_window_start or something. We
5982 don't want to do this at the top of the function,
5983 because we may get input from a subprocess which
5984 wants to change the selected window and stuff (say,
5986 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5988 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
5989 orig_local_map
= get_local_map (PT
, current_buffer
);
5990 goto replay_sequence
;
5992 /* For a mouse click, get the local text-property keymap
5993 of the place clicked on, rather than point. */
5994 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
5995 && ! localized_local_map
)
5997 Lisp_Object map_here
, start
, pos
;
5999 localized_local_map
= 1;
6000 start
= EVENT_START (key
);
6001 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6003 pos
= POSN_BUFFER_POSN (start
);
6005 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6007 map_here
= get_local_map (XINT (pos
), current_buffer
);
6008 if (!EQ (map_here
, orig_local_map
))
6010 orig_local_map
= map_here
;
6014 goto replay_sequence
;
6020 /* Expand mode-line and scroll-bar events into two events:
6021 use posn as a fake prefix key. */
6024 if (t
+ 1 >= bufsize
)
6025 error ("Key sequence too long");
6030 /* Zap the position in key, so we know that we've
6031 expanded it, and don't try to do so again. */
6032 POSN_BUFFER_POSN (EVENT_START (key
))
6033 = Fcons (posn
, Qnil
);
6037 else if (EQ (kind
, Qswitch_frame
))
6039 /* If we're at the beginning of a key sequence, and the caller
6040 says it's okay, go ahead and return this event. If we're
6041 in the midst of a key sequence, delay it until the end. */
6042 if (t
> 0 || !can_return_switch_frame
)
6044 delayed_switch_frame
= key
;
6048 else if (CONSP (XCONS (key
)->cdr
)
6049 && CONSP (EVENT_START (key
))
6050 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6054 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6055 /* Handle menu-bar events:
6056 insert the dummy prefix event `menu-bar'. */
6057 if (EQ (posn
, Qmenu_bar
))
6059 if (t
+ 1 >= bufsize
)
6060 error ("Key sequence too long");
6064 /* Zap the position in key, so we know that we've
6065 expanded it, and don't try to do so again. */
6066 POSN_BUFFER_POSN (EVENT_START (key
))
6067 = Fcons (posn
, Qnil
);
6070 goto replay_sequence
;
6072 else if (CONSP (posn
))
6074 /* We're looking at the second event of a
6075 sequence which we expanded before. Set
6076 last_real_key_start appropriately. */
6077 if (last_real_key_start
== t
&& t
> 0)
6078 last_real_key_start
= t
- 1;
6083 /* We have finally decided that KEY is something we might want
6085 first_binding
= (follow_key (key
,
6086 nmaps
- first_binding
,
6087 submaps
+ first_binding
,
6088 defs
+ first_binding
,
6089 submaps
+ first_binding
)
6092 /* If KEY wasn't bound, we'll try some fallbacks. */
6093 if (first_binding
>= nmaps
)
6097 head
= EVENT_HEAD (key
);
6098 if (help_char_p (head
) && t
> 0)
6100 read_key_sequence_cmd
= Vprefix_help_command
;
6102 last_nonmenu_event
= key
;
6103 /* The Microsoft C compiler can't handle the goto that
6111 Lisp_Object breakdown
;
6114 breakdown
= parse_modifiers (head
);
6115 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6116 /* Attempt to reduce an unbound mouse event to a simpler
6117 event that is bound:
6118 Drags reduce to clicks.
6119 Double-clicks reduce to clicks.
6120 Triple-clicks reduce to double-clicks, then to clicks.
6121 Down-clicks are eliminated.
6122 Double-downs reduce to downs, then are eliminated.
6123 Triple-downs reduce to double-downs, then to downs,
6124 then are eliminated. */
6125 if (modifiers
& (down_modifier
| drag_modifier
6126 | double_modifier
| triple_modifier
))
6128 while (modifiers
& (down_modifier
| drag_modifier
6129 | double_modifier
| triple_modifier
))
6131 Lisp_Object new_head
, new_click
;
6132 if (modifiers
& triple_modifier
)
6133 modifiers
^= (double_modifier
| triple_modifier
);
6134 else if (modifiers
& double_modifier
)
6135 modifiers
&= ~double_modifier
;
6136 else if (modifiers
& drag_modifier
)
6137 modifiers
&= ~drag_modifier
;
6140 /* Dispose of this `down' event by simply jumping
6141 back to replay_key, to get another event.
6143 Note that if this event came from mock input,
6144 then just jumping back to replay_key will just
6145 hand it to us again. So we have to wipe out any
6148 We could delete keybuf[t] and shift everything
6149 after that to the left by one spot, but we'd also
6150 have to fix up any variable that points into
6151 keybuf, and shifting isn't really necessary
6154 Adding prefixes for non-textual mouse clicks
6155 creates two characters of mock input, and both
6156 must be thrown away. If we're only looking at
6157 the prefix now, we can just jump back to
6158 replay_key. On the other hand, if we've already
6159 processed the prefix, and now the actual click
6160 itself is giving us trouble, then we've lost the
6161 state of the keymaps we want to backtrack to, and
6162 we need to replay the whole sequence to rebuild
6165 Beyond that, only function key expansion could
6166 create more than two keys, but that should never
6167 generate mouse events, so it's okay to zero
6168 mock_input in that case too.
6170 Isn't this just the most wonderful code ever? */
6171 if (t
== last_real_key_start
)
6178 mock_input
= last_real_key_start
;
6179 goto replay_sequence
;
6184 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6186 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6188 /* Look for a binding for this new key. follow_key
6189 promises that it didn't munge submaps the
6190 last time we called it, since key was unbound. */
6192 = (follow_key (new_click
,
6193 nmaps
- local_first_binding
,
6194 submaps
+ local_first_binding
,
6195 defs
+ local_first_binding
,
6196 submaps
+ local_first_binding
)
6197 + local_first_binding
);
6199 /* If that click is bound, go for it. */
6200 if (first_binding
< nmaps
)
6205 /* Otherwise, we'll leave key set to the drag event. */
6212 /* Normally, last_nonmenu_event gets the previous key we read.
6213 But when a mouse popup menu is being used,
6214 we don't update last_nonmenu_event; it continues to hold the mouse
6215 event that preceded the first level of menu. */
6216 if (!used_mouse_menu
)
6217 last_nonmenu_event
= key
;
6219 prev_fkey_map
= fkey_map
;
6220 prev_fkey_start
= fkey_start
;
6221 prev_fkey_end
= fkey_end
;
6223 prev_keytran_map
= keytran_map
;
6224 prev_keytran_start
= keytran_start
;
6225 prev_keytran_end
= keytran_end
;
6227 /* If the sequence is unbound, see if we can hang a function key
6228 off the end of it. We only want to scan real keyboard input
6229 for function key sequences, so if mock_input says that we're
6230 re-reading old events, don't examine it. */
6231 if (first_binding
>= nmaps
6234 Lisp_Object fkey_next
;
6236 /* Continue scan from fkey_end until we find a bound suffix.
6237 If we fail, increment fkey_start
6238 and start fkey_end from there. */
6239 while (fkey_end
< t
)
6243 key
= keybuf
[fkey_end
++];
6244 /* Look up meta-characters by prefixing them
6245 with meta_prefix_char. I hate this. */
6246 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6251 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
6253 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6256 fkey_next
= fkey_map
;
6259 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
6261 #if 0 /* I didn't turn this on, because it might cause trouble
6262 for the mapping of return into C-m and tab into C-i. */
6263 /* Optionally don't map function keys into other things.
6264 This enables the user to redefine kp- keys easily. */
6265 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6269 /* If the function key map gives a function, not an
6270 array, then call the function with no args and use
6271 its value instead. */
6272 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6275 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6279 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6280 fkey_next
= call1 (fkey_next
, prompt
);
6282 /* If the function returned something invalid,
6283 barf--don't ignore it.
6284 (To ignore it safely, we would need to gcpro a bunch of
6285 other variables.) */
6286 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6287 error ("Function in function-key-map returns invalid key sequence");
6290 function_key_possible
= ! NILP (fkey_next
);
6292 /* If keybuf[fkey_start..fkey_end] is bound in the
6293 function key map and it's a suffix of the current
6294 sequence (i.e. fkey_end == t), replace it with
6295 the binding and restart with fkey_start at the end. */
6296 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6299 int len
= XFASTINT (Flength (fkey_next
));
6301 t
= fkey_start
+ len
;
6303 error ("Key sequence too long");
6305 if (VECTORP (fkey_next
))
6306 bcopy (XVECTOR (fkey_next
)->contents
,
6307 keybuf
+ fkey_start
,
6308 (t
- fkey_start
) * sizeof (keybuf
[0]));
6309 else if (STRINGP (fkey_next
))
6313 for (i
= 0; i
< len
; i
++)
6314 XSETFASTINT (keybuf
[fkey_start
+ i
],
6315 XSTRING (fkey_next
)->data
[i
]);
6319 fkey_start
= fkey_end
= t
;
6320 fkey_map
= Vfunction_key_map
;
6322 /* Do pass the results through key-translation-map. */
6323 keytran_start
= keytran_end
= 0;
6324 keytran_map
= Vkey_translation_map
;
6326 goto replay_sequence
;
6329 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6331 /* If we no longer have a bound suffix, try a new positions for
6333 if (NILP (fkey_map
))
6335 fkey_end
= ++fkey_start
;
6336 fkey_map
= Vfunction_key_map
;
6337 function_key_possible
= 0;
6342 /* Look for this sequence in key-translation-map. */
6344 Lisp_Object keytran_next
;
6346 /* Scan from keytran_end until we find a bound suffix. */
6347 while (keytran_end
< t
)
6351 key
= keybuf
[keytran_end
++];
6352 /* Look up meta-characters by prefixing them
6353 with meta_prefix_char. I hate this. */
6354 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6359 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
6361 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6364 keytran_next
= keytran_map
;
6367 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
6369 /* If the key translation map gives a function, not an
6370 array, then call the function with no args and use
6371 its value instead. */
6372 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6373 && keytran_end
== t
)
6375 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6379 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6380 keytran_next
= call1 (keytran_next
, prompt
);
6382 /* If the function returned something invalid,
6383 barf--don't ignore it.
6384 (To ignore it safely, we would need to gcpro a bunch of
6385 other variables.) */
6386 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6387 error ("Function in key-translation-map returns invalid key sequence");
6390 key_translation_possible
= ! NILP (keytran_next
);
6392 /* If keybuf[keytran_start..keytran_end] is bound in the
6393 key translation map and it's a suffix of the current
6394 sequence (i.e. keytran_end == t), replace it with
6395 the binding and restart with keytran_start at the end. */
6396 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6397 && keytran_end
== t
)
6399 int len
= XFASTINT (Flength (keytran_next
));
6401 t
= keytran_start
+ len
;
6403 error ("Key sequence too long");
6405 if (VECTORP (keytran_next
))
6406 bcopy (XVECTOR (keytran_next
)->contents
,
6407 keybuf
+ keytran_start
,
6408 (t
- keytran_start
) * sizeof (keybuf
[0]));
6409 else if (STRINGP (keytran_next
))
6413 for (i
= 0; i
< len
; i
++)
6414 XSETFASTINT (keybuf
[keytran_start
+ i
],
6415 XSTRING (keytran_next
)->data
[i
]);
6419 keytran_start
= keytran_end
= t
;
6420 keytran_map
= Vkey_translation_map
;
6422 /* Don't pass the results of key-translation-map
6423 through function-key-map. */
6424 fkey_start
= fkey_end
= t
;
6425 fkey_map
= Vkey_translation_map
;
6427 goto replay_sequence
;
6430 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6432 /* If we no longer have a bound suffix, try a new positions for
6434 if (NILP (keytran_map
))
6436 keytran_end
= ++keytran_start
;
6437 keytran_map
= Vkey_translation_map
;
6438 key_translation_possible
= 0;
6443 /* If KEY is not defined in any of the keymaps,
6444 and cannot be part of a function key or translation,
6445 and is an upper case letter
6446 use the corresponding lower-case letter instead. */
6447 if (first_binding
== nmaps
&& ! function_key_possible
6448 && ! key_translation_possible
6450 && ((((XINT (key
) & 0x3ffff)
6451 < XSTRING (current_buffer
->downcase_table
)->size
)
6452 && UPPERCASEP (XINT (key
) & 0x3ffff))
6453 || (XINT (key
) & shift_modifier
)))
6455 Lisp_Object new_key
;
6457 original_uppercase
= key
;
6458 original_uppercase_position
= t
- 1;
6460 if (XINT (new_key
) & shift_modifier
)
6461 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6463 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6464 | (XINT (key
) & ~0x3ffff)));
6466 /* We have to do this unconditionally, regardless of whether
6467 the lower-case char is defined in the keymaps, because they
6468 might get translated through function-key-map. */
6469 keybuf
[t
- 1] = new_key
;
6472 fkey_map
= prev_fkey_map
;
6473 fkey_start
= prev_fkey_start
;
6474 fkey_end
= prev_fkey_end
;
6476 keytran_map
= prev_keytran_map
;
6477 keytran_start
= prev_keytran_start
;
6478 keytran_end
= prev_keytran_end
;
6480 goto replay_sequence
;
6482 /* If KEY is not defined in any of the keymaps,
6483 and cannot be part of a function key or translation,
6484 and is a shifted function key,
6485 use the corresponding unshifted function key instead. */
6486 if (first_binding
== nmaps
&& ! function_key_possible
6487 && ! key_translation_possible
6490 Lisp_Object breakdown
;
6493 breakdown
= parse_modifiers (key
);
6494 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6495 if (modifiers
& shift_modifier
)
6497 Lisp_Object new_key
;
6499 original_uppercase
= key
;
6500 original_uppercase_position
= t
- 1;
6502 modifiers
&= ~shift_modifier
;
6503 new_key
= apply_modifiers (modifiers
,
6504 XCONS (breakdown
)->car
);
6506 keybuf
[t
- 1] = new_key
;
6509 fkey_map
= prev_fkey_map
;
6510 fkey_start
= prev_fkey_start
;
6511 fkey_end
= prev_fkey_end
;
6513 keytran_map
= prev_keytran_map
;
6514 keytran_start
= prev_keytran_start
;
6515 keytran_end
= prev_keytran_end
;
6517 goto replay_sequence
;
6523 read_key_sequence_cmd
= (first_binding
< nmaps
6524 ? defs
[first_binding
]
6527 unread_switch_frame
= delayed_switch_frame
;
6528 unbind_to (count
, Qnil
);
6530 /* Don't downcase the last character if the caller says don't.
6531 Don't downcase it if the result is undefined, either. */
6532 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6533 && t
- 1 == original_uppercase_position
)
6534 keybuf
[t
- 1] = original_uppercase
;
6536 /* Occasionally we fabricate events, perhaps by expanding something
6537 according to function-key-map, or by adding a prefix symbol to a
6538 mouse click in the scroll bar or modeline. In this cases, return
6539 the entire generated key sequence, even if we hit an unbound
6540 prefix or a definition before the end. This means that you will
6541 be able to push back the event properly, and also means that
6542 read-key-sequence will always return a logical unit.
6545 for (; t
< mock_input
; t
++)
6547 if (echo_keystrokes
)
6548 echo_char (keybuf
[t
]);
6549 add_command_key (keybuf
[t
]);
6555 #if 0 /* This doc string is too long for some compilers.
6556 This commented-out definition serves for DOC. */
6557 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6558 "Read a sequence of keystrokes and return as a string or vector.\n\
6559 The sequence is sufficient to specify a non-prefix command in the\n\
6560 current local and global maps.\n\
6562 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
6563 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
6564 as a continuation of the previous key.\n\
6566 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
6567 convert the last event to lower case. (Normally any upper case event\n\
6568 is converted to lower case if the original event is undefined and the lower\n\
6569 case equivalent is defined.) A non-nil value is appropriate for reading\n\
6570 a key sequence to be defined.\n\
6572 A C-g typed while in this function is treated like any other character,\n\
6573 and `quit-flag' is not set.\n\
6575 If the key sequence starts with a mouse click, then the sequence is read\n\
6576 using the keymaps of the buffer of the window clicked in, not the buffer\n\
6577 of the selected window as normal.\n\
6579 `read-key-sequence' drops unbound button-down events, since you normally\n\
6580 only care about the click or drag events which follow them. If a drag\n\
6581 or multi-click event is unbound, but the corresponding click event would\n\
6582 be bound, `read-key-sequence' turns the event into a click event at the\n\
6583 drag's starting position. This means that you don't have to distinguish\n\
6584 between click and drag, double, or triple events unless you want to.\n\
6586 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
6587 lines separating windows, and scroll bars with imaginary keys\n\
6588 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
6590 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
6591 function will process a switch-frame event if the user switches frames\n\
6592 before typing anything. If the user switches frames in the middle of a\n\
6593 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
6594 is nil, then the event will be put off until after the current key sequence.\n\
6596 `read-key-sequence' checks `function-key-map' for function key\n\
6597 sequences, where they wouldn't conflict with ordinary bindings. See\n\
6598 `function-key-map' for more details.")
6599 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6602 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
6604 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
6605 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
6606 Lisp_Object can_return_switch_frame
;
6608 Lisp_Object keybuf
[30];
6610 struct gcpro gcpro1
, gcpro2
;
6613 CHECK_STRING (prompt
, 0);
6616 bzero (keybuf
, sizeof keybuf
);
6618 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
6620 if (NILP (continue_echo
))
6621 this_command_key_count
= 0;
6623 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
6624 prompt
, ! NILP (dont_downcase_last
),
6625 ! NILP (can_return_switch_frame
));
6633 return make_event_array (i
, keybuf
);
6636 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
6637 "Execute CMD as an editor command.\n\
6638 CMD must be a symbol that satisfies the `commandp' predicate.\n\
6639 Optional second arg RECORD-FLAG non-nil\n\
6640 means unconditionally put this command in `command-history'.\n\
6641 Otherwise, that is done only if an arg is read using the minibuffer.\n\
6642 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
6643 when reading the arguments; if it is nil, (this_command_key_count) is used.\n\
6644 The argument SPECIAL, if non-nil, means that this command is executing\n\
6645 a special event, so ignore the prefix argument and don't clear it.")
6646 (cmd
, record_flag
, keys
, special
)
6647 Lisp_Object cmd
, record_flag
, keys
, special
;
6649 register Lisp_Object final
;
6650 register Lisp_Object tem
;
6651 Lisp_Object prefixarg
;
6652 struct backtrace backtrace
;
6653 extern int debug_on_next_call
;
6655 debug_on_next_call
= 0;
6659 prefixarg
= current_kboard
->Vprefix_arg
;
6660 Vcurrent_prefix_arg
= prefixarg
;
6661 current_kboard
->Vprefix_arg
= Qnil
;
6668 tem
= Fget (cmd
, Qdisabled
);
6669 if (!NILP (tem
) && !NILP (Vrun_hooks
))
6671 tem
= Fsymbol_value (Qdisabled_command_hook
);
6673 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
6679 final
= Findirect_function (cmd
);
6681 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
6682 do_autoload (final
, cmd
);
6687 if (STRINGP (final
) || VECTORP (final
))
6689 /* If requested, place the macro in the command history. For
6690 other sorts of commands, call-interactively takes care of
6692 if (!NILP (record_flag
))
6694 = Fcons (Fcons (Qexecute_kbd_macro
,
6695 Fcons (final
, Fcons (prefixarg
, Qnil
))),
6698 return Fexecute_kbd_macro (final
, prefixarg
);
6700 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
6702 backtrace
.next
= backtrace_list
;
6703 backtrace_list
= &backtrace
;
6704 backtrace
.function
= &Qcall_interactively
;
6705 backtrace
.args
= &cmd
;
6706 backtrace
.nargs
= 1;
6707 backtrace
.evalargs
= 0;
6709 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
6711 backtrace_list
= backtrace
.next
;
6717 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
6719 "Read function name, then read its arguments and call it.")
6721 Lisp_Object prefixarg
;
6723 Lisp_Object function
;
6725 Lisp_Object saved_keys
;
6726 struct gcpro gcpro1
;
6728 saved_keys
= Fvector (this_command_key_count
,
6729 XVECTOR (this_command_keys
)->contents
);
6731 GCPRO1 (saved_keys
);
6733 if (EQ (prefixarg
, Qminus
))
6735 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
6736 strcpy (buf
, "C-u ");
6737 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
6739 if (sizeof (int) == sizeof (EMACS_INT
))
6740 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
6741 else if (sizeof (long) == sizeof (EMACS_INT
))
6742 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
6746 else if (INTEGERP (prefixarg
))
6748 if (sizeof (int) == sizeof (EMACS_INT
))
6749 sprintf (buf
, "%d ", XINT (prefixarg
));
6750 else if (sizeof (long) == sizeof (EMACS_INT
))
6751 sprintf (buf
, "%ld ", XINT (prefixarg
));
6756 /* This isn't strictly correct if execute-extended-command
6757 is bound to anything else. Perhaps it should use
6758 this_command_keys? */
6759 strcat (buf
, "M-x ");
6761 /* Prompt with buf, and then read a string, completing from and
6762 restricting to the set of all defined commands. Don't provide
6763 any initial input. Save the command read on the extended-command
6765 function
= Fcompleting_read (build_string (buf
),
6766 Vobarray
, Qcommandp
,
6767 Qt
, Qnil
, Qextended_command_history
);
6769 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
6770 error ("No command name given");
6772 /* Set this_command_keys to the concatenation of saved_keys and
6773 function, followed by a RET. */
6775 struct Lisp_String
*str
;
6780 this_command_key_count
= 0;
6782 keys
= XVECTOR (saved_keys
)->contents
;
6783 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
6784 add_command_key (keys
[i
]);
6786 str
= XSTRING (function
);
6787 for (i
= 0; i
< str
->size
; i
++)
6789 XSETFASTINT (tem
, str
->data
[i
]);
6790 add_command_key (tem
);
6793 XSETFASTINT (tem
, '\015');
6794 add_command_key (tem
);
6799 function
= Fintern (function
, Qnil
);
6800 current_kboard
->Vprefix_arg
= prefixarg
;
6801 this_command
= function
;
6803 /* If enabled, show which key runs this command. */
6804 if (!NILP (Vsuggest_key_bindings
)
6805 && SYMBOLP (function
))
6807 Lisp_Object bindings
;
6809 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
6812 if (!NILP (bindings
))
6814 message ("You can run the command `%s' by typing %s",
6815 XSYMBOL (function
)->name
->data
,
6816 XSTRING (Fkey_description (bindings
))->data
);
6817 Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
6818 ? Vsuggest_key_bindings
: make_number (2)),
6823 return Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
6826 /* Find the set of keymaps now active.
6827 Store into *MAPS_P a vector holding the various maps
6828 and return the number of them. The vector was malloc'd
6829 and the caller should free it. */
6832 current_active_maps (maps_p
)
6833 Lisp_Object
**maps_p
;
6835 Lisp_Object
*tmaps
, *maps
;
6838 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6839 if (!NILP (Voverriding_local_map_menu_flag
))
6841 /* Yes, use them (if non-nil) as well as the global map. */
6842 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
6844 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6845 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6846 if (!NILP (Voverriding_local_map
))
6847 maps
[nmaps
++] = Voverriding_local_map
;
6851 /* No, so use major and minor mode keymaps. */
6852 nmaps
= current_minor_maps (NULL
, &tmaps
);
6853 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
6854 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6855 #ifdef USE_TEXT_PROPERTIES
6856 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
6858 maps
[nmaps
++] = current_buffer
->keymap
;
6861 maps
[nmaps
++] = current_global_map
;
6867 /* Return nonzero if input events are pending. */
6869 detect_input_pending ()
6872 get_input_pending (&input_pending
, 0);
6874 return input_pending
;
6877 /* Return nonzero if input events are pending.
6878 Execute timers immediately; don't make events for them. */
6880 detect_input_pending_run_timers ()
6883 get_input_pending (&input_pending
, 1);
6885 return input_pending
;
6888 /* This is called in some cases before a possible quit.
6889 It cases the next call to detect_input_pending to recompute input_pending.
6890 So calling this function unnecessarily can't do any harm. */
6891 clear_input_pending ()
6896 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
6897 "T if command input is currently available with no waiting.\n\
6898 Actually, the value is nil only if we can be sure that no input is available.")
6901 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
6904 get_input_pending (&input_pending
, 1);
6905 return input_pending
> 0 ? Qt
: Qnil
;
6908 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
6909 "Return vector of last 100 events, not counting those from keyboard macros.")
6912 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
6915 if (total_keys
< NUM_RECENT_KEYS
)
6916 return Fvector (total_keys
, keys
);
6919 val
= Fvector (NUM_RECENT_KEYS
, keys
);
6920 bcopy (keys
+ recent_keys_index
,
6921 XVECTOR (val
)->contents
,
6922 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
6924 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
6925 recent_keys_index
* sizeof (Lisp_Object
));
6930 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
6931 "Return the key sequence that invoked this command.\n\
6932 The value is a string or a vector.")
6935 return make_event_array (this_command_key_count
,
6936 XVECTOR (this_command_keys
)->contents
);
6939 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
6940 Sreset_this_command_lengths
, 0, 0, 0,
6941 "Used for complicated reasons in `universal-argument-other-key'.\n\
6943 `universal-argument-other-key' rereads the event just typed.\n\
6944 It then gets translated through `function-key-map'.\n\
6945 The translated event gets included in the echo area and in\n\
6946 the value of `this-command-keys' in addition to the raw original event.\n\
6947 That is not right.\n\
6949 Calling this function directs the translated event to replace\n\
6950 the original event, so that only one version of the event actually\n\
6951 appears in the echo area and in the value of `this-command-keys.'.")
6954 before_command_restore_flag
= 1;
6955 before_command_key_count_1
= before_command_key_count
;
6956 before_command_echo_length_1
= before_command_echo_length
;
6959 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
6960 "Return the current depth in recursive edits.")
6964 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
6968 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
6969 "FOpen dribble file: ",
6970 "Start writing all keyboard characters to a dribble file called FILE.\n\
6971 If FILE is nil, close any open dribble file.")
6982 file
= Fexpand_file_name (file
, Qnil
);
6983 dribble
= fopen (XSTRING (file
)->data
, "w");
6985 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
6990 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
6991 "Discard the contents of the terminal input buffer.\n\
6992 Also cancel any kbd macro being defined.")
6995 current_kboard
->defining_kbd_macro
= Qnil
;
6996 update_mode_lines
++;
6998 Vunread_command_events
= Qnil
;
6999 unread_command_char
= -1;
7001 discard_tty_input ();
7003 /* Without the cast, GCC complains that this assignment loses the
7004 volatile qualifier of kbd_store_ptr. Is there anything wrong
7006 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7007 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7013 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7014 "Stop Emacs and return to superior process. You can resume later.\n\
7015 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7016 control, run a subshell instead.\n\n\
7017 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7018 to be read as terminal input by Emacs's parent, after suspension.\n\
7020 Before suspending, run the normal hook `suspend-hook'.\n\
7021 After resumption run the normal hook `suspend-resume-hook'.\n\
7023 Some operating systems cannot stop the Emacs process and resume it later.\n\
7024 On such systems, Emacs starts a subshell instead of suspending.")
7026 Lisp_Object stuffstring
;
7029 int count
= specpdl_ptr
- specpdl
;
7030 int old_height
, old_width
;
7032 struct gcpro gcpro1
, gcpro2
;
7033 extern init_sys_modes ();
7035 if (!NILP (stuffstring
))
7036 CHECK_STRING (stuffstring
, 0);
7038 /* Run the functions in suspend-hook. */
7039 if (!NILP (Vrun_hooks
))
7040 call1 (Vrun_hooks
, intern ("suspend-hook"));
7042 GCPRO1 (stuffstring
);
7043 get_frame_size (&old_width
, &old_height
);
7045 /* sys_suspend can get an error if it tries to fork a subshell
7046 and the system resources aren't available for that. */
7047 record_unwind_protect (init_sys_modes
, 0);
7048 stuff_buffered_input (stuffstring
);
7053 unbind_to (count
, Qnil
);
7055 /* Check if terminal/window size has changed.
7056 Note that this is not useful when we are running directly
7057 with a window system; but suspend should be disabled in that case. */
7058 get_frame_size (&width
, &height
);
7059 if (width
!= old_width
|| height
!= old_height
)
7060 change_frame_size (selected_frame
, height
, width
, 0, 0);
7062 /* Run suspend-resume-hook. */
7063 if (!NILP (Vrun_hooks
))
7064 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7070 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7071 Then in any case stuff anything Emacs has read ahead and not used. */
7073 stuff_buffered_input (stuffstring
)
7074 Lisp_Object stuffstring
;
7076 /* stuff_char works only in BSD, versions 4.2 and up. */
7079 register unsigned char *p
;
7081 if (STRINGP (stuffstring
))
7085 p
= XSTRING (stuffstring
)->data
;
7086 count
= XSTRING (stuffstring
)->size
;
7091 /* Anything we have read ahead, put back for the shell to read. */
7092 /* ?? What should this do when we have multiple keyboards??
7093 Should we ignore anything that was typed in at the "wrong" kboard? */
7094 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7096 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7097 kbd_fetch_ptr
= kbd_buffer
;
7098 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7099 stuff_char (kbd_fetch_ptr
->code
);
7100 kbd_fetch_ptr
->kind
= no_event
;
7101 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7107 #endif /* BSD and not BSD4_1 */
7110 set_waiting_for_input (time_to_clear
)
7111 EMACS_TIME
*time_to_clear
;
7113 input_available_clear_time
= time_to_clear
;
7115 /* Tell interrupt_signal to throw back to read_char, */
7116 waiting_for_input
= 1;
7118 /* If interrupt_signal was called before and buffered a C-g,
7119 make it run again now, to avoid timing error. */
7120 if (!NILP (Vquit_flag
))
7121 quit_throw_to_read_char ();
7124 clear_waiting_for_input ()
7126 /* Tell interrupt_signal not to throw back to read_char, */
7127 waiting_for_input
= 0;
7128 input_available_clear_time
= 0;
7131 /* This routine is called at interrupt level in response to C-G.
7132 If interrupt_input, this is the handler for SIGINT.
7133 Otherwise, it is called from kbd_buffer_store_event,
7134 in handling SIGIO or SIGTINT.
7136 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7137 immediately throw back to read_char.
7139 Otherwise it sets the Lisp variable quit-flag not-nil.
7140 This causes eval to throw, when it gets a chance.
7141 If quit-flag is already non-nil, it stops the job right away. */
7144 interrupt_signal (signalnum
) /* If we don't have an argument, */
7145 int signalnum
; /* some compilers complain in signal calls. */
7148 /* Must preserve main program's value of errno. */
7149 int old_errno
= errno
;
7152 if (!read_socket_hook
&& NILP (Vwindow_system
))
7154 /* USG systems forget handlers when they are used;
7155 must reestablish each time */
7156 signal (SIGINT
, interrupt_signal
);
7157 signal (SIGQUIT
, interrupt_signal
);
7163 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
7168 #ifdef SIGTSTP /* Support possible in later USG versions */
7170 * On systems which can suspend the current process and return to the original
7171 * shell, this command causes the user to end up back at the shell.
7172 * The "Auto-save" and "Abort" questions are not asked until
7173 * the user elects to return to emacs, at which point he can save the current
7174 * job and either dump core or continue.
7179 if (sys_suspend () == -1)
7181 printf ("Not running as a subprocess;\n");
7182 printf ("you can continue or abort.\n");
7185 /* Perhaps should really fork an inferior shell?
7186 But that would not provide any way to get back
7187 to the original shell, ever. */
7188 printf ("No support for stopping a process on this operating system;\n");
7189 printf ("you can continue or abort.\n");
7190 #endif /* not VMS */
7191 #endif /* not SIGTSTP */
7193 /* We must remain inside the screen area when the internal terminal
7194 is used. Note that [Enter] is not echoed by dos. */
7197 /* It doesn't work to autosave while GC is in progress;
7198 the code used for auto-saving doesn't cope with the mark bit. */
7199 if (!gc_in_progress
)
7201 printf ("Auto-save? (y or n) ");
7203 if (((c
= getchar ()) & ~040) == 'Y')
7205 Fdo_auto_save (Qt
, Qnil
);
7207 printf ("\r\nAuto-save done");
7208 #else /* not MSDOS */
7209 printf ("Auto-save done\n");
7210 #endif /* not MSDOS */
7212 while (c
!= '\n') c
= getchar ();
7216 /* During GC, it must be safe to reenable quitting again. */
7217 Vinhibit_quit
= Qnil
;
7220 #endif /* not MSDOS */
7221 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7222 printf ("but will instead do a real quit after garbage collection ends\r\n");
7227 printf ("\r\nAbort? (y or n) ");
7228 #else /* not MSDOS */
7230 printf ("Abort (and enter debugger)? (y or n) ");
7232 printf ("Abort (and dump core)? (y or n) ");
7233 #endif /* not VMS */
7234 #endif /* not MSDOS */
7236 if (((c
= getchar ()) & ~040) == 'Y')
7238 while (c
!= '\n') c
= getchar ();
7240 printf ("\r\nContinuing...\r\n");
7241 #else /* not MSDOS */
7242 printf ("Continuing...\n");
7243 #endif /* not MSDOS */
7249 /* If executing a function that wants to be interrupted out of
7250 and the user has not deferred quitting by binding `inhibit-quit'
7251 then quit right away. */
7252 if (immediate_quit
&& NILP (Vinhibit_quit
))
7256 Fsignal (Qquit
, Qnil
);
7259 /* Else request quit when it's safe */
7263 if (waiting_for_input
&& !echoing
)
7264 quit_throw_to_read_char ();
7269 /* Handle a C-g by making read_char return C-g. */
7271 quit_throw_to_read_char ()
7273 quit_error_check ();
7275 /* Prevent another signal from doing this before we finish. */
7276 clear_waiting_for_input ();
7279 Vunread_command_events
= Qnil
;
7280 unread_command_char
= -1;
7282 #if 0 /* Currently, sit_for is called from read_char without turning
7283 off polling. And that can call set_waiting_for_input.
7284 It seems to be harmless. */
7285 #ifdef POLL_FOR_INPUT
7286 /* May be > 1 if in recursive minibuffer. */
7287 if (poll_suppress_count
== 0)
7292 if (FRAMEP (internal_last_event_frame
)
7293 && XFRAME (internal_last_event_frame
) != selected_frame
)
7294 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7298 _longjmp (getcjmp
, 1);
7301 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7302 "Set mode of reading keyboard input.\n\
7303 First arg INTERRUPT non-nil means use input interrupts;\n\
7304 nil means use CBREAK mode.\n\
7305 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7306 (no effect except in CBREAK mode).\n\
7307 Third arg META t means accept 8-bit input (for a Meta key).\n\
7308 META nil means ignore the top bit, on the assumption it is parity.\n\
7309 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7310 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7311 See also `current-input-mode'.")
7312 (interrupt
, flow
, meta
, quit
)
7313 Lisp_Object interrupt
, flow
, meta
, quit
;
7316 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7317 error ("set-input-mode: QUIT must be an ASCII character");
7319 #ifdef POLL_FOR_INPUT
7324 /* this causes startup screen to be restored and messes with the mouse */
7329 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7330 if (read_socket_hook
)
7332 /* When using X, don't give the user a real choice,
7333 because we haven't implemented the mechanisms to support it. */
7334 #ifdef NO_SOCK_SIGIO
7335 interrupt_input
= 0;
7336 #else /* not NO_SOCK_SIGIO */
7337 interrupt_input
= 1;
7338 #endif /* NO_SOCK_SIGIO */
7341 interrupt_input
= !NILP (interrupt
);
7342 #else /* not SIGIO */
7343 interrupt_input
= 0;
7344 #endif /* not SIGIO */
7346 /* Our VMS input only works by interrupts, as of now. */
7348 interrupt_input
= 1;
7351 flow_control
= !NILP (flow
);
7354 else if (EQ (meta
, Qt
))
7359 /* Don't let this value be out of range. */
7360 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7366 #ifdef POLL_FOR_INPUT
7367 poll_suppress_count
= 1;
7373 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7374 "Return information about the way Emacs currently reads keyboard input.\n\
7375 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7376 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7377 nil, Emacs is using CBREAK mode.\n\
7378 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7379 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7380 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7381 META nil means ignoring the top bit, on the assumption it is parity.\n\
7382 META is neither t nor nil if accepting 8-bit input and using\n\
7383 all 8 bits as the character code.\n\
7384 QUIT is the character Emacs currently uses to quit.\n\
7385 The elements of this list correspond to the arguments of\n\
7391 val
[0] = interrupt_input
? Qt
: Qnil
;
7392 val
[1] = flow_control
? Qt
: Qnil
;
7393 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7394 XSETFASTINT (val
[3], quit_char
);
7396 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7401 * Set up a new kboard object with reasonable initial values.
7407 kb
->Voverriding_terminal_local_map
= Qnil
;
7408 kb
->Vlast_command
= Qnil
;
7409 kb
->Vprefix_arg
= Qnil
;
7410 kb
->kbd_queue
= Qnil
;
7411 kb
->kbd_queue_has_data
= 0;
7412 kb
->immediate_echo
= 0;
7413 kb
->echoptr
= kb
->echobuf
;
7414 kb
->echo_after_prompt
= -1;
7415 kb
->kbd_macro_buffer
= 0;
7416 kb
->kbd_macro_bufsize
= 0;
7417 kb
->defining_kbd_macro
= Qnil
;
7418 kb
->Vlast_kbd_macro
= Qnil
;
7419 kb
->reference_count
= 0;
7420 kb
->Vsystem_key_alist
= Qnil
;
7421 kb
->system_key_syms
= Qnil
;
7422 kb
->Vdefault_minibuffer_frame
= Qnil
;
7426 * Destroy the contents of a kboard object, but not the object itself.
7427 * We use this just before deleting it, or if we're going to initialize
7434 if (kb
->kbd_macro_buffer
)
7435 xfree (kb
->kbd_macro_buffer
);
7444 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7447 *kbp
= kb
->next_kboard
;
7455 /* This is correct before outermost invocation of the editor loop */
7456 command_loop_level
= -1;
7458 quit_char
= Ctl ('g');
7459 Vunread_command_events
= Qnil
;
7460 unread_command_char
= -1;
7462 recent_keys_index
= 0;
7463 kbd_fetch_ptr
= kbd_buffer
;
7464 kbd_store_ptr
= kbd_buffer
;
7465 kbd_buffer_frame_or_window
7466 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7468 do_mouse_tracking
= Qnil
;
7473 /* This means that command_loop_1 won't try to select anything the first
7475 internal_last_event_frame
= Qnil
;
7476 Vlast_event_frame
= internal_last_event_frame
;
7480 current_kboard
= initial_kboard
;
7482 wipe_kboard (current_kboard
);
7483 init_kboard (current_kboard
);
7486 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7488 kbd_buffer_frame_or_window
7489 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7490 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
7492 signal (SIGINT
, interrupt_signal
);
7493 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
7494 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
7495 SIGQUIT and we can't tell which one it will give us. */
7496 signal (SIGQUIT
, interrupt_signal
);
7497 #endif /* HAVE_TERMIO */
7499 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7501 if (!noninteractive
)
7502 signal (SIGIO
, input_available_signal
);
7505 /* Use interrupt input by default, if it works and noninterrupt input
7506 has deficiencies. */
7508 #ifdef INTERRUPT_INPUT
7509 interrupt_input
= 1;
7511 interrupt_input
= 0;
7514 /* Our VMS input only works by interrupts, as of now. */
7516 interrupt_input
= 1;
7522 if (keyboard_init_hook
)
7523 (*keyboard_init_hook
) ();
7525 #ifdef POLL_FOR_INPUT
7526 poll_suppress_count
= 1;
7531 /* This type's only use is in syms_of_keyboard, to initialize the
7532 event header symbols and put properties on them. */
7539 struct event_head head_table
[] = {
7540 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
7541 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
7542 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
7543 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
7544 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
7545 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
7550 Qdisabled_command_hook
= intern ("disabled-command-hook");
7551 staticpro (&Qdisabled_command_hook
);
7553 Qself_insert_command
= intern ("self-insert-command");
7554 staticpro (&Qself_insert_command
);
7556 Qforward_char
= intern ("forward-char");
7557 staticpro (&Qforward_char
);
7559 Qbackward_char
= intern ("backward-char");
7560 staticpro (&Qbackward_char
);
7562 Qdisabled
= intern ("disabled");
7563 staticpro (&Qdisabled
);
7565 Qundefined
= intern ("undefined");
7566 staticpro (&Qundefined
);
7568 Qpre_command_hook
= intern ("pre-command-hook");
7569 staticpro (&Qpre_command_hook
);
7571 Qpost_command_hook
= intern ("post-command-hook");
7572 staticpro (&Qpost_command_hook
);
7574 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
7575 staticpro (&Qpost_command_idle_hook
);
7577 Qdeferred_action_function
= intern ("deferred-action-function");
7578 staticpro (&Qdeferred_action_function
);
7580 Qcommand_hook_internal
= intern ("command-hook-internal");
7581 staticpro (&Qcommand_hook_internal
);
7583 Qfunction_key
= intern ("function-key");
7584 staticpro (&Qfunction_key
);
7585 Qmouse_click
= intern ("mouse-click");
7586 staticpro (&Qmouse_click
);
7587 Qtimer_event
= intern ("timer-event");
7588 staticpro (&Qtimer_event
);
7590 Qmenu_enable
= intern ("menu-enable");
7591 staticpro (&Qmenu_enable
);
7593 Qmode_line
= intern ("mode-line");
7594 staticpro (&Qmode_line
);
7595 Qvertical_line
= intern ("vertical-line");
7596 staticpro (&Qvertical_line
);
7597 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
7598 staticpro (&Qvertical_scroll_bar
);
7599 Qmenu_bar
= intern ("menu-bar");
7600 staticpro (&Qmenu_bar
);
7602 Qabove_handle
= intern ("above-handle");
7603 staticpro (&Qabove_handle
);
7604 Qhandle
= intern ("handle");
7605 staticpro (&Qhandle
);
7606 Qbelow_handle
= intern ("below-handle");
7607 staticpro (&Qbelow_handle
);
7609 Qevent_kind
= intern ("event-kind");
7610 staticpro (&Qevent_kind
);
7611 Qevent_symbol_elements
= intern ("event-symbol-elements");
7612 staticpro (&Qevent_symbol_elements
);
7613 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
7614 staticpro (&Qevent_symbol_element_mask
);
7615 Qmodifier_cache
= intern ("modifier-cache");
7616 staticpro (&Qmodifier_cache
);
7618 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
7619 staticpro (&Qrecompute_lucid_menubar
);
7620 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
7621 staticpro (&Qactivate_menubar_hook
);
7623 Qpolling_period
= intern ("polling-period");
7624 staticpro (&Qpolling_period
);
7627 struct event_head
*p
;
7629 for (p
= head_table
;
7630 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
7633 *p
->var
= intern (p
->name
);
7635 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
7636 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
7640 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
7641 staticpro (&button_down_location
);
7645 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
7647 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
7648 for (i
= 0; i
< len
; i
++)
7649 if (modifier_names
[i
])
7650 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
7651 staticpro (&modifier_symbols
);
7654 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
7655 staticpro (&recent_keys
);
7657 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
7658 staticpro (&this_command_keys
);
7660 Qextended_command_history
= intern ("extended-command-history");
7661 Fset (Qextended_command_history
, Qnil
);
7662 staticpro (&Qextended_command_history
);
7664 kbd_buffer_frame_or_window
7665 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7666 staticpro (&kbd_buffer_frame_or_window
);
7668 accent_key_syms
= Qnil
;
7669 staticpro (&accent_key_syms
);
7671 func_key_syms
= Qnil
;
7672 staticpro (&func_key_syms
);
7675 staticpro (&mouse_syms
);
7677 unread_switch_frame
= Qnil
;
7678 staticpro (&unread_switch_frame
);
7680 defsubr (&Sevent_convert_list
);
7681 defsubr (&Sread_key_sequence
);
7682 defsubr (&Srecursive_edit
);
7684 defsubr (&Strack_mouse
);
7686 defsubr (&Sinput_pending_p
);
7687 defsubr (&Scommand_execute
);
7688 defsubr (&Srecent_keys
);
7689 defsubr (&Sthis_command_keys
);
7690 defsubr (&Sreset_this_command_lengths
);
7691 defsubr (&Ssuspend_emacs
);
7692 defsubr (&Sabort_recursive_edit
);
7693 defsubr (&Sexit_recursive_edit
);
7694 defsubr (&Srecursion_depth
);
7695 defsubr (&Stop_level
);
7696 defsubr (&Sdiscard_input
);
7697 defsubr (&Sopen_dribble_file
);
7698 defsubr (&Sset_input_mode
);
7699 defsubr (&Scurrent_input_mode
);
7700 defsubr (&Sexecute_extended_command
);
7702 DEFVAR_LISP ("last-command-char", &last_command_char
,
7703 "Last input event that was part of a command.");
7705 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
7706 "Last input event that was part of a command.");
7708 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
7709 "Last input event in a command, except for mouse menu events.\n\
7710 Mouse menus give back keys that don't look like mouse events;\n\
7711 this variable holds the actual mouse event that led to the menu,\n\
7712 so that you can determine whether the command was run by mouse or not.");
7714 DEFVAR_LISP ("last-input-char", &last_input_char
,
7715 "Last input event.");
7717 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
7718 "Last input event.");
7720 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
7721 "List of objects to be read as next command input events.");
7723 DEFVAR_INT ("unread-command-char", &unread_command_char
,
7724 "If not -1, an object to be read as next command input event.");
7726 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
7727 "Meta-prefix character code. Meta-foo as command input\n\
7728 turns into this character followed by foo.");
7729 XSETINT (meta_prefix_char
, 033);
7731 DEFVAR_KBOARD ("last-command", Vlast_command
,
7732 "The last command executed. Normally a symbol with a function definition,\n\
7733 but can be whatever was found in the keymap, or whatever the variable\n\
7734 `this-command' was set to by that command.\n\
7736 The value `mode-exit' is special; it means that the previous command\n\
7737 read an event that told it to exit, and it did so and unread that event.\n\
7738 In other words, the present command is the event that made the previous\n\
7741 The value `kill-region' is special; it means that the previous command\n\
7742 was a kill command.");
7744 DEFVAR_LISP ("this-command", &this_command
,
7745 "The command now being executed.\n\
7746 The command can set this variable; whatever is put here\n\
7747 will be in `last-command' during the following command.");
7748 this_command
= Qnil
;
7750 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
7751 "*Number of keyboard input characters between auto-saves.\n\
7752 Zero means disable autosaving due to number of characters typed.");
7753 auto_save_interval
= 300;
7755 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
7756 "*Number of seconds idle time before auto-save.\n\
7757 Zero or nil means disable auto-saving due to idleness.\n\
7758 After auto-saving due to this many seconds of idle time,\n\
7759 Emacs also does a garbage collection if that seems to be warranted.");
7760 XSETFASTINT (Vauto_save_timeout
, 30);
7762 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
7763 "*Nonzero means echo unfinished commands after this many seconds of pause.");
7764 echo_keystrokes
= 1;
7766 DEFVAR_INT ("polling-period", &polling_period
,
7767 "*Interval between polling for input during Lisp execution.\n\
7768 The reason for polling is to make C-g work to stop a running program.\n\
7769 Polling is needed only when using X windows and SIGIO does not work.\n\
7770 Polling is automatically disabled in all other cases.");
7773 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
7774 "*Maximum time between mouse clicks to make a double-click.\n\
7775 Measured in milliseconds. nil means disable double-click recognition;\n\
7776 t means double-clicks have no time limit and are detected\n\
7777 by position only.");
7778 Vdouble_click_time
= make_number (500);
7780 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
7781 "*Non-nil means inhibit local map menu bar menus.");
7782 inhibit_local_menu_bar_menus
= 0;
7784 DEFVAR_INT ("num-input-keys", &num_input_keys
,
7785 "Number of complete keys read from the keyboard so far.");
7788 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
7789 "The frame in which the most recently read event occurred.\n\
7790 If the last event came from a keyboard macro, this is set to `macro'.");
7791 Vlast_event_frame
= Qnil
;
7793 DEFVAR_LISP ("help-char", &Vhelp_char
,
7794 "Character to recognize as meaning Help.\n\
7795 When it is read, do `(eval help-form)', and display result if it's a string.\n\
7796 If the value of `help-form' is nil, this char can be read normally.");
7797 XSETINT (Vhelp_char
, Ctl ('H'));
7799 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
7800 "List of input events to recognize as meaning Help.\n\
7801 These work just like the value of `help-char' (see that).");
7802 Vhelp_event_list
= Qnil
;
7804 DEFVAR_LISP ("help-form", &Vhelp_form
,
7805 "Form to execute when character `help-char' is read.\n\
7806 If the form returns a string, that string is displayed.\n\
7807 If `help-form' is nil, the help char is not recognized.");
7810 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
7811 "Command to run when `help-char' character follows a prefix key.\n\
7812 This command is used only when there is no actual binding\n\
7813 for that character after that prefix key.");
7814 Vprefix_help_command
= Qnil
;
7816 DEFVAR_LISP ("top-level", &Vtop_level
,
7817 "Form to evaluate when Emacs starts up.\n\
7818 Useful to set before you dump a modified Emacs.");
7821 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
7822 "Translate table for keyboard input, or nil.\n\
7823 Each character is looked up in this string and the contents used instead.\n\
7824 The value may be a string, a vector, or a char-table.\n\
7825 If it is a string or vector of length N,\n\
7826 character codes N and up are untranslated.\n\
7827 In a vector or a char-table, an element which is nil means \"no translation\".");
7828 Vkeyboard_translate_table
= Qnil
;
7830 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
7831 "Non-nil means to always spawn a subshell instead of suspending,\n\
7832 even if the operating system has support for stopping a process.");
7835 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
7836 "Non-nil means prompt with menus when appropriate.\n\
7837 This is done when reading from a keymap that has a prompt string,\n\
7838 for elements that have prompt strings.\n\
7839 The menu is displayed on the screen\n\
7840 if X menus were enabled at configuration\n\
7841 time and the previous event was a mouse click prefix key.\n\
7842 Otherwise, menu prompting uses the echo area.");
7845 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
7846 "Character to see next line of menu prompt.\n\
7847 Type this character while in a menu prompt to rotate around the lines of it.");
7848 XSETINT (menu_prompt_more_char
, ' ');
7850 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
7851 "A mask of additional modifier keys to use with every keyboard character.\n\
7852 Emacs applies the modifiers of the character stored here to each keyboard\n\
7853 character it reads. For example, after evaluating the expression\n\
7854 (setq extra-keyboard-modifiers ?\\C-x)\n\
7855 all input characters will have the control modifier applied to them.\n\
7857 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
7858 not count as a control character; rather, it counts as a character\n\
7859 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
7860 cancels any modification.");
7861 extra_keyboard_modifiers
= 0;
7863 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
7864 "If an editing command sets this to t, deactivate the mark afterward.\n\
7865 The command loop sets this to nil before each command,\n\
7866 and tests the value when the command returns.\n\
7867 Buffer modification stores t in this variable.");
7868 Vdeactivate_mark
= Qnil
;
7870 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
7871 "Temporary storage of pre-command-hook or post-command-hook.");
7872 Vcommand_hook_internal
= Qnil
;
7874 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
7875 "Normal hook run before each command is executed.\n\
7876 Errors running the hook are caught and ignored.");
7877 Vpre_command_hook
= Qnil
;
7879 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
7880 "Normal hook run after each command is executed.\n\
7881 Errors running the hook are caught and ignored.");
7882 Vpost_command_hook
= Qnil
;
7884 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
7885 "Normal hook run after each command is executed, if idle.\n\
7886 Errors running the hook are caught and ignored.");
7887 Vpost_command_idle_hook
= Qnil
;
7889 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
7890 "Delay time before running `post-command-idle-hook'.\n\
7891 This is measured in microseconds.");
7892 post_command_idle_delay
= 100000;
7894 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
7895 "t means menu bar, specified Lucid style, needs to be recomputed.");
7896 Vlucid_menu_bar_dirty_flag
= Qnil
;
7898 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
7899 "List of menu bar items to move to the end of the menu bar.\n\
7900 The elements of the list are event types that may have menu bar bindings.");
7901 Vmenu_bar_final_items
= Qnil
;
7903 DEFVAR_KBOARD ("overriding-terminal-local-map",
7904 Voverriding_terminal_local_map
,
7905 "Keymap that overrides all other local keymaps.\n\
7906 If this variable is non-nil, it is used as a keymap instead of the\n\
7907 buffer's local map, and the minor mode keymaps and text property keymaps.");
7909 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
7910 "Keymap that overrides all other local keymaps.\n\
7911 If this variable is non-nil, it is used as a keymap instead of the\n\
7912 buffer's local map, and the minor mode keymaps and text property keymaps.");
7913 Voverriding_local_map
= Qnil
;
7915 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
7916 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
7917 Otherwise, the menu bar continues to reflect the buffer's local map\n\
7918 and the minor mode maps regardless of `overriding-local-map'.");
7919 Voverriding_local_map_menu_flag
= Qnil
;
7921 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
7922 "Keymap defining bindings for special events to execute at low level.");
7923 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
7925 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
7926 "*Non-nil means generate motion events for mouse motion.");
7928 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
7929 "Alist of system-specific X windows key symbols.\n\
7930 Each element should have the form (N . SYMBOL) where N is the\n\
7931 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
7932 and SYMBOL is its name.");
7934 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
7935 "List of deferred actions to be performed at a later time.\n\
7936 The precise format isn't relevant here; we just check whether it is nil.");
7937 Vdeferred_action_list
= Qnil
;
7939 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
7940 "Function to call to handle deferred actions, after each command.\n\
7941 This function is called with no arguments after each command\n\
7942 whenever `deferred-action-list' is non-nil.");
7943 Vdeferred_action_function
= Qnil
;
7945 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
7946 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
7947 The value can be a length of time to show the message for.\n\
7948 If the value is non-nil and not a number, we wait 2 seconds.");
7949 Vsuggest_key_bindings
= Qt
;
7951 DEFVAR_LISP ("column-number-mode", &Vcolumn_number_mode
,
7952 "Non-nil enables display of the current column number in the mode line.");
7953 Vcolumn_number_mode
= Qnil
;
7955 DEFVAR_LISP ("timer-list", &Vtimer_list
,
7956 "List of active absolute time timers in order of increasing time");
7959 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
7960 "List of active idle-time timers in order of increasing time");
7961 Vtimer_idle_list
= Qnil
;
7966 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
7967 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
7968 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
7969 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
7970 initial_define_key (meta_map
, 'x', "execute-extended-command");
7972 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
7973 "handle-delete-frame");
7974 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
7976 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",