1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97 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"
37 #include "dispextern.h"
40 #include "intervals.h"
41 #include "blockinput.h"
51 #include <sys/ioctl.h>
53 #endif /* not MSDOS */
55 #include "syssignal.h"
58 /* This is to get the definitions of the XK_ symbols. */
65 #endif /* HAVE_NTGUI */
67 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
72 /* Variables for blockinput.h: */
74 /* Non-zero if interrupt input is blocked right now. */
75 int interrupt_input_blocked
;
77 /* Nonzero means an input interrupt has arrived
78 during the current critical section. */
79 int interrupt_input_pending
;
82 /* File descriptor to use for input. */
85 #ifdef HAVE_WINDOW_SYSTEM
86 /* Make all keyboard buffers much bigger when using X windows. */
87 #define KBD_BUFFER_SIZE 4096
88 #else /* No X-windows, character input */
89 #define KBD_BUFFER_SIZE 256
90 #endif /* No X-windows */
92 /* Following definition copied from eval.c */
96 struct backtrace
*next
;
97 Lisp_Object
*function
;
98 Lisp_Object
*args
; /* Points to vector of args. */
99 int nargs
; /* length of vector. If nargs is UNEVALLED,
100 args points to slot holding list of
106 KBOARD
*initial_kboard
;
107 KBOARD
*current_kboard
;
111 KBOARD the_only_kboard
;
114 /* Non-nil disable property on a command means
115 do not execute it; call disabled-command-hook's value instead. */
116 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
118 #define NUM_RECENT_KEYS (100)
119 int recent_keys_index
; /* Index for storing next element into recent_keys */
120 int total_keys
; /* Total number of elements stored into recent_keys */
121 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
123 /* Vector holding the key sequence that invoked the current command.
124 It is reused for each command, and it may be longer than the current
125 sequence; this_command_key_count indicates how many elements
126 actually mean something.
127 It's easier to staticpro a single Lisp_Object than an array. */
128 Lisp_Object this_command_keys
;
129 int this_command_key_count
;
131 /* Number of elements of this_command_keys
132 that precede this key sequence. */
133 int this_single_command_key_start
;
135 /* Record values of this_command_key_count and echo_length ()
136 before this command was read. */
137 static int before_command_key_count
;
138 static int before_command_echo_length
;
139 /* Values of before_command_key_count and before_command_echo_length
140 saved by reset-this-command-lengths. */
141 static int before_command_key_count_1
;
142 static int before_command_echo_length_1
;
143 /* Flag set by reset-this-command-lengths,
144 saying to reset the lengths when add_command_key is called. */
145 static int before_command_restore_flag
;
147 extern int minbuf_level
;
149 extern int message_enable_multibyte
;
151 extern struct backtrace
*backtrace_list
;
153 /* Nonzero means do menu prompting. */
154 static int menu_prompting
;
156 /* Character to see next line of menu prompt. */
157 static Lisp_Object menu_prompt_more_char
;
159 /* For longjmp to where kbd input is being done. */
160 static jmp_buf getcjmp
;
162 /* True while doing kbd input. */
163 int waiting_for_input
;
165 /* True while displaying for echoing. Delays C-g throwing. */
168 /* True means we can start echoing at the next input pause
169 even though there is something in the echo area. */
170 static char *ok_to_echo_at_next_pause
;
172 /* Nonzero means disregard local maps for the menu bar. */
173 static int inhibit_local_menu_bar_menus
;
175 /* Nonzero means C-g should cause immediate error-signal. */
178 /* The user's ERASE setting. */
179 Lisp_Object Vtty_erase_char
;
181 /* Character to recognize as the help char. */
182 Lisp_Object Vhelp_char
;
184 /* List of other event types to recognize as meaning "help". */
185 Lisp_Object Vhelp_event_list
;
187 /* Form to execute when help char is typed. */
188 Lisp_Object Vhelp_form
;
190 /* Command to run when the help character follows a prefix key. */
191 Lisp_Object Vprefix_help_command
;
193 /* List of items that should move to the end of the menu bar. */
194 Lisp_Object Vmenu_bar_final_items
;
196 /* Non-nil means show the equivalent key-binding for
197 any M-x command that has one.
198 The value can be a length of time to show the message for.
199 If the value is non-nil and not a number, we wait 2 seconds. */
200 Lisp_Object Vsuggest_key_bindings
;
202 /* Character that causes a quit. Normally C-g.
204 If we are running on an ordinary terminal, this must be an ordinary
205 ASCII char, since we want to make it our interrupt character.
207 If we are not running on an ordinary terminal, it still needs to be
208 an ordinary ASCII char. This character needs to be recognized in
209 the input interrupt handler. At this point, the keystroke is
210 represented as a struct input_event, while the desired quit
211 character is specified as a lispy event. The mapping from struct
212 input_events to lispy events cannot run in an interrupt handler,
213 and the reverse mapping is difficult for anything but ASCII
216 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
220 extern Lisp_Object current_global_map
;
221 extern int minibuf_level
;
223 /* If non-nil, this is a map that overrides all other local maps. */
224 Lisp_Object Voverriding_local_map
;
226 /* If non-nil, Voverriding_local_map applies to the menu bar. */
227 Lisp_Object Voverriding_local_map_menu_flag
;
229 /* Keymap that defines special misc events that should
230 be processed immediately at a low level. */
231 Lisp_Object Vspecial_event_map
;
233 /* Current depth in recursive edits. */
234 int command_loop_level
;
236 /* Total number of times command_loop has read a key sequence. */
239 /* Last input character read as a command. */
240 Lisp_Object last_command_char
;
242 /* Last input character read as a command, not counting menus
243 reached by the mouse. */
244 Lisp_Object last_nonmenu_event
;
246 /* Last input character read for any purpose. */
247 Lisp_Object last_input_char
;
249 /* If not Qnil, a list of objects to be read as subsequent command input. */
250 Lisp_Object Vunread_command_events
;
252 /* If not -1, an event to be read as subsequent command input. */
253 int unread_command_char
;
255 /* If not Qnil, this is a switch-frame event which we decided to put
256 off until the end of a key sequence. This should be read as the
257 next command input, after any unread_command_events.
259 read_key_sequence uses this to delay switch-frame events until the
260 end of the key sequence; Fread_char uses it to put off switch-frame
261 events until a non-ASCII event is acceptable as input. */
262 Lisp_Object unread_switch_frame
;
264 /* A mask of extra modifier bits to put into every keyboard char. */
265 int extra_keyboard_modifiers
;
267 /* Char to use as prefix when a meta character is typed in.
268 This is bound on entry to minibuffer in case ESC is changed there. */
270 Lisp_Object meta_prefix_char
;
272 /* Last size recorded for a current buffer which is not a minibuffer. */
273 static int last_non_minibuf_size
;
275 /* Number of idle seconds before an auto-save and garbage collection. */
276 static Lisp_Object Vauto_save_timeout
;
278 /* Total number of times read_char has returned. */
279 int num_input_events
;
281 /* Total number of times read_char has returned, outside of macros. */
282 int num_nonmacro_input_events
;
284 /* Auto-save automatically when this many characters have been typed
285 since the last time. */
287 static int auto_save_interval
;
289 /* Value of num_nonmacro_input_events as of last auto save. */
293 /* The command being executed by the command loop.
294 Commands may set this, and the value set will be copied into
295 current_kboard->Vlast_command instead of the actual command. */
296 Lisp_Object this_command
;
298 /* The value of point when the last command was executed. */
299 int last_point_position
;
301 /* The buffer that was current when the last command was started. */
302 Lisp_Object last_point_position_buffer
;
304 /* The frame in which the last input event occurred, or Qmacro if the
305 last event came from a macro. We use this to determine when to
306 generate switch-frame events. This may be cleared by functions
307 like Fselect_frame, to make sure that a switch-frame event is
308 generated by the next character. */
309 Lisp_Object internal_last_event_frame
;
311 /* A user-visible version of the above, intended to allow users to
312 figure out where the last event came from, if the event doesn't
313 carry that information itself (i.e. if it was a character). */
314 Lisp_Object Vlast_event_frame
;
316 /* The timestamp of the last input event we received from the X server.
317 X Windows wants this for selection ownership. */
318 unsigned long last_event_timestamp
;
320 Lisp_Object Qself_insert_command
;
321 Lisp_Object Qforward_char
;
322 Lisp_Object Qbackward_char
;
323 Lisp_Object Qundefined
;
324 Lisp_Object Qtimer_event_handler
;
326 /* read_key_sequence stores here the command definition of the
327 key sequence that it reads. */
328 Lisp_Object read_key_sequence_cmd
;
330 /* Form to evaluate (if non-nil) when Emacs is started. */
331 Lisp_Object Vtop_level
;
333 /* User-supplied string to translate input characters through. */
334 Lisp_Object Vkeyboard_translate_table
;
336 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
337 extern Lisp_Object Vfunction_key_map
;
339 /* Another keymap that maps key sequences into key sequences.
340 This one takes precedence over ordinary definitions. */
341 extern Lisp_Object Vkey_translation_map
;
343 /* Non-nil means deactivate the mark at end of this command. */
344 Lisp_Object Vdeactivate_mark
;
346 /* Menu bar specified in Lucid Emacs fashion. */
348 Lisp_Object Vlucid_menu_bar_dirty_flag
;
349 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
351 Lisp_Object Qecho_area_clear_hook
;
353 /* Hooks to run before and after each command. */
354 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
355 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
356 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
357 /* Hook run after a command if there's no more input soon. */
358 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
360 /* Delay time in microseconds before running post-command-idle-hook. */
361 int post_command_idle_delay
;
363 /* List of deferred actions to be performed at a later time.
364 The precise format isn't relevant here; we just check whether it is nil. */
365 Lisp_Object Vdeferred_action_list
;
367 /* Function to call to handle deferred actions, when there are any. */
368 Lisp_Object Vdeferred_action_function
;
369 Lisp_Object Qdeferred_action_function
;
371 /* File in which we write all commands we read. */
374 /* Nonzero if input is available. */
377 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
378 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
382 extern char *pending_malloc_warning
;
384 /* Circular buffer for pre-read keyboard input. */
385 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
387 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
389 The interrupt-level event handlers will never enqueue an event on a
390 frame which is not in Vframe_list, and once an event is dequeued,
391 internal_last_event_frame or the event itself points to the frame.
394 But while the event is sitting in the queue, it's completely
395 unprotected. Suppose the user types one command which will run for
396 a while and then delete a frame, and then types another event at
397 the frame that will be deleted, before the command gets around to
398 it. Suppose there are no references to this frame elsewhere in
399 Emacs, and a GC occurs before the second event is dequeued. Now we
400 have an event referring to a freed frame, which will crash Emacs
403 Similar things happen when an event on a scroll bar is enqueued; the
404 window may be deleted while the event is in the queue.
406 So, we use this vector to protect the frame_or_window field in the
407 event queue. That way, they'll be dequeued as dead frames or
408 windows, but still valid lisp objects.
410 If kbd_buffer[i].kind != no_event, then
411 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
412 == kbd_buffer[i].frame_or_window. */
413 static Lisp_Object kbd_buffer_frame_or_window
;
415 /* Pointer to next available character in kbd_buffer.
416 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
417 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
418 next available char is in kbd_buffer[0]. */
419 static struct input_event
*kbd_fetch_ptr
;
421 /* Pointer to next place to store character in kbd_buffer. This
422 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
423 character should go in kbd_buffer[0]. */
424 static volatile struct input_event
*kbd_store_ptr
;
426 /* The above pair of variables forms a "queue empty" flag. When we
427 enqueue a non-hook event, we increment kbd_store_ptr. When we
428 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
429 there is input available iff the two pointers are not equal.
431 Why not just have a flag set and cleared by the enqueuing and
432 dequeuing functions? Such a flag could be screwed up by interrupts
433 at inopportune times. */
435 /* If this flag is non-nil, we check mouse_moved to see when the
436 mouse moves, and motion events will appear in the input stream.
437 Otherwise, mouse motion is ignored. */
438 static Lisp_Object do_mouse_tracking
;
440 /* Symbols to head events. */
441 Lisp_Object Qmouse_movement
;
442 Lisp_Object Qscroll_bar_movement
;
443 Lisp_Object Qswitch_frame
;
444 Lisp_Object Qdelete_frame
;
445 Lisp_Object Qiconify_frame
;
446 Lisp_Object Qmake_frame_visible
;
448 /* Symbols to denote kinds of events. */
449 Lisp_Object Qfunction_key
;
450 Lisp_Object Qmouse_click
;
452 Lisp_Object Qmouse_wheel
;
454 Lisp_Object Qdrag_n_drop
;
455 /* Lisp_Object Qmouse_movement; - also an event header */
457 /* Properties of event headers. */
458 Lisp_Object Qevent_kind
;
459 Lisp_Object Qevent_symbol_elements
;
461 /* menu item parts */
462 Lisp_Object Qmenu_alias
;
463 Lisp_Object Qmenu_enable
;
464 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
465 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
466 extern Lisp_Object Vdefine_key_rebound_commands
;
467 extern Lisp_Object Qmenu_item
;
469 /* An event header symbol HEAD may have a property named
470 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
471 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
472 mask of modifiers applied to it. If present, this is used to help
473 speed up parse_modifiers. */
474 Lisp_Object Qevent_symbol_element_mask
;
476 /* An unmodified event header BASE may have a property named
477 Qmodifier_cache, which is an alist mapping modifier masks onto
478 modified versions of BASE. If present, this helps speed up
480 Lisp_Object Qmodifier_cache
;
482 /* Symbols to use for parts of windows. */
483 Lisp_Object Qmode_line
;
484 Lisp_Object Qvertical_line
;
485 Lisp_Object Qvertical_scroll_bar
;
486 Lisp_Object Qmenu_bar
;
488 Lisp_Object
recursive_edit_unwind (), command_loop ();
489 Lisp_Object
Fthis_command_keys ();
490 Lisp_Object Qextended_command_history
;
491 EMACS_TIME
timer_check ();
493 extern Lisp_Object Vhistory_length
;
495 extern char *x_get_keysym_name ();
497 static void record_menu_key ();
499 Lisp_Object Qpolling_period
;
501 /* List of absolute timers. Appears in order of next scheduled event. */
502 Lisp_Object Vtimer_list
;
504 /* List of idle time timers. Appears in order of next scheduled event. */
505 Lisp_Object Vtimer_idle_list
;
507 /* Incremented whenever a timer is run. */
510 extern Lisp_Object Vprint_level
, Vprint_length
;
512 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
514 EMACS_TIME
*input_available_clear_time
;
516 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
517 Default is 1 if INTERRUPT_INPUT is defined. */
520 /* Nonzero while interrupts are temporarily deferred during redisplay. */
521 int interrupts_deferred
;
523 /* Nonzero means use ^S/^Q for flow control. */
526 /* Allow m- file to inhibit use of FIONREAD. */
527 #ifdef BROKEN_FIONREAD
531 /* We are unable to use interrupts if FIONREAD is not available,
532 so flush SIGIO so we won't try. */
539 /* If we support a window system, turn on the code to poll periodically
540 to detect C-g. It isn't actually used when doing interrupt input. */
541 #ifdef HAVE_WINDOW_SYSTEM
542 #define POLL_FOR_INPUT
545 /* Global variable declarations. */
547 /* Function for init_keyboard to call with no args (if nonzero). */
548 void (*keyboard_init_hook
) ();
550 static int read_avail_input ();
551 static void get_input_pending ();
552 static int readable_events ();
553 static Lisp_Object
read_char_x_menu_prompt ();
554 static Lisp_Object
read_char_minibuf_menu_prompt ();
555 static Lisp_Object
make_lispy_event ();
557 static Lisp_Object
make_lispy_movement ();
559 static Lisp_Object
modify_event_symbol ();
560 static Lisp_Object
make_lispy_switch_frame ();
561 static int parse_solitary_modifier ();
562 static void save_getcjmp ();
563 static void restore_getcjmp ();
565 /* > 0 if we are to echo keystrokes. */
566 static int echo_keystrokes
;
568 /* Nonzero means don't try to suspend even if the operating system seems
570 static int cannot_suspend
;
572 #define min(a,b) ((a)<(b)?(a):(b))
573 #define max(a,b) ((a)>(b)?(a):(b))
575 /* Install the string STR as the beginning of the string of echoing,
576 so that it serves as a prompt for the next character.
577 Also start echoing. */
583 int len
= strlen (str
);
585 if (len
> ECHOBUFSIZE
- 4)
586 len
= ECHOBUFSIZE
- 4;
587 bcopy (str
, current_kboard
->echobuf
, len
);
588 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
589 *current_kboard
->echoptr
= '\0';
591 current_kboard
->echo_after_prompt
= len
;
596 /* Add C to the echo string, if echoing is going on.
597 C can be a character, which is printed prettily ("M-C-x" and all that
598 jazz), or a symbol, whose name is printed. */
604 extern char *push_key_description ();
606 if (current_kboard
->immediate_echo
)
608 char *ptr
= current_kboard
->echoptr
;
610 if (ptr
!= current_kboard
->echobuf
)
613 /* If someone has passed us a composite event, use its head symbol. */
618 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
621 ptr
= push_key_description (XINT (c
), ptr
);
623 else if (SYMBOLP (c
))
625 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
626 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
629 bcopy (name
->data
, ptr
, STRING_BYTES (name
));
630 ptr
+= STRING_BYTES (name
);
633 if (current_kboard
->echoptr
== current_kboard
->echobuf
636 strcpy (ptr
, " (Type ? for further options)");
641 current_kboard
->echoptr
= ptr
;
647 /* Temporarily add a dash to the end of the echo string if it's not
648 empty, so that it serves as a mini-prompt for the very next character. */
653 if (!current_kboard
->immediate_echo
654 && current_kboard
->echoptr
== current_kboard
->echobuf
)
656 /* Do nothing if we just printed a prompt. */
657 if (current_kboard
->echo_after_prompt
658 == current_kboard
->echoptr
- current_kboard
->echobuf
)
660 /* Do nothing if not echoing at all. */
661 if (current_kboard
->echoptr
== 0)
664 /* Put a dash at the end of the buffer temporarily,
665 but make it go away when the next character is added. */
666 current_kboard
->echoptr
[0] = '-';
667 current_kboard
->echoptr
[1] = 0;
672 /* Display the current echo string, and begin echoing if not already
678 if (!current_kboard
->immediate_echo
)
681 current_kboard
->immediate_echo
= 1;
683 for (i
= 0; i
< this_command_key_count
; i
++)
686 c
= XVECTOR (this_command_keys
)->contents
[i
];
687 if (! (EVENT_HAS_PARAMETERS (c
)
688 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
695 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
696 ! NILP (current_buffer
->enable_multibyte_characters
));
700 if (waiting_for_input
&& !NILP (Vquit_flag
))
701 quit_throw_to_read_char ();
704 /* Turn off echoing, for the start of a new command. */
709 current_kboard
->immediate_echo
= 0;
710 current_kboard
->echoptr
= current_kboard
->echobuf
;
711 current_kboard
->echo_after_prompt
= -1;
712 ok_to_echo_at_next_pause
= 0;
715 /* Return the length of the current echo string. */
720 return current_kboard
->echoptr
- current_kboard
->echobuf
;
723 /* Truncate the current echo message to its first LEN chars.
724 This and echo_char get used by read_key_sequence when the user
725 switches frames while entering a key sequence. */
731 current_kboard
->echobuf
[len
] = '\0';
732 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
733 truncate_echo_area (len
);
737 /* Functions for manipulating this_command_keys. */
739 add_command_key (key
)
742 int size
= XVECTOR (this_command_keys
)->size
;
744 /* If reset-this-command-length was called recently, obey it now.
745 See the doc string of that function for an explanation of why. */
746 if (before_command_restore_flag
)
748 this_command_key_count
= before_command_key_count_1
;
749 if (this_command_key_count
< this_single_command_key_start
)
750 this_single_command_key_start
= this_command_key_count
;
751 echo_truncate (before_command_echo_length_1
);
752 before_command_restore_flag
= 0;
755 if (this_command_key_count
>= size
)
757 Lisp_Object new_keys
;
759 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
760 bcopy (XVECTOR (this_command_keys
)->contents
,
761 XVECTOR (new_keys
)->contents
,
762 size
* sizeof (Lisp_Object
));
764 this_command_keys
= new_keys
;
767 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
773 int count
= specpdl_ptr
- specpdl
;
776 if (command_loop_level
> 0)
778 specbind (Qstandard_output
, Qt
);
779 specbind (Qstandard_input
, Qt
);
782 val
= command_loop ();
784 Fsignal (Qquit
, Qnil
);
785 /* Handle throw from read_minibuf when using minibuffer
786 while it's active but we're in another window. */
788 Fsignal (Qerror
, Fcons (val
, Qnil
));
790 return unbind_to (count
, Qnil
);
793 /* When an auto-save happens, record the "time", and don't do again soon. */
798 last_auto_save
= num_nonmacro_input_events
;
801 /* Make an auto save happen as soon as possible at command level. */
804 force_auto_save_soon ()
806 last_auto_save
= - auto_save_interval
- 1;
808 record_asynch_buffer_change ();
811 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
812 "Invoke the editor command loop recursively.\n\
813 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
814 that tells this function to return.\n\
815 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
816 This function is called by the editor initialization to begin editing.")
819 int count
= specpdl_ptr
- specpdl
;
822 command_loop_level
++;
823 update_mode_lines
= 1;
825 record_unwind_protect (recursive_edit_unwind
,
827 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
831 return unbind_to (count
, Qnil
);
835 recursive_edit_unwind (buffer
)
839 Fset_buffer (buffer
);
841 command_loop_level
--;
842 update_mode_lines
= 1;
850 #if 0 /* Theory: if there's anything in Vunread_command_events,
851 it will right away be read by read_key_sequence,
852 and then if we do switch KBOARDS, it will go into the side
853 queue then. So we don't need to do anything special here -- rms. */
854 if (CONSP (Vunread_command_events
))
856 current_kboard
->kbd_queue
857 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
858 current_kboard
->kbd_queue_has_data
= 1;
860 Vunread_command_events
= Qnil
;
866 /* Switch to the single-kboard state, making current_kboard
867 the only KBOARD from which further input is accepted. */
870 single_kboard_state ()
877 /* Maintain a stack of kboards, so other parts of Emacs
878 can switch temporarily to the kboard of a given frame
879 and then revert to the previous status. */
884 struct kboard_stack
*next
;
887 static struct kboard_stack
*kboard_stack
;
890 push_frame_kboard (f
)
894 struct kboard_stack
*p
895 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
897 p
->next
= kboard_stack
;
898 p
->kboard
= current_kboard
;
901 current_kboard
= FRAME_KBOARD (f
);
909 struct kboard_stack
*p
= kboard_stack
;
910 current_kboard
= p
->kboard
;
911 kboard_stack
= p
->next
;
916 /* Handle errors that are not handled at inner levels
917 by printing an error message and returning to the editor command loop. */
923 Lisp_Object old_level
, old_length
;
926 if (!NILP (executing_macro
))
928 if (executing_macro_iterations
== 1)
929 sprintf (macroerror
, "After 1 kbd macro iteration: ");
931 sprintf (macroerror
, "After %d kbd macro iterations: ",
932 executing_macro_iterations
);
937 Vstandard_output
= Qt
;
938 Vstandard_input
= Qt
;
939 Vexecuting_macro
= Qnil
;
940 executing_macro
= Qnil
;
941 current_kboard
->Vprefix_arg
= Qnil
;
944 /* Avoid unquittable loop if data contains a circular list. */
945 old_level
= Vprint_level
;
946 old_length
= Vprint_length
;
947 XSETFASTINT (Vprint_level
, 10);
948 XSETFASTINT (Vprint_length
, 10);
949 cmd_error_internal (data
, macroerror
);
950 Vprint_level
= old_level
;
951 Vprint_length
= old_length
;
955 Vinhibit_quit
= Qnil
;
960 return make_number (0);
963 /* Take actions on handling an error. DATA is the data that describes
966 CONTEXT is a C-string containing ASCII characters only which
967 describes the context in which the error happened. If we need to
968 generalize CONTEXT to allow multibyte characters, make it a Lisp
972 cmd_error_internal (data
, context
)
980 echo_area_glyphs
= 0;
982 /* If the window system or terminal frame hasn't been initialized
983 yet, or we're not interactive, it's best to dump this message out
984 to stderr and exit. */
985 if (! FRAME_MESSAGE_BUF (selected_frame
)
987 stream
= Qexternal_debugging_output
;
996 write_string_1 (context
, -1, stream
);
998 print_error_message (data
, stream
);
1000 /* If the window system or terminal frame hasn't been initialized
1001 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1002 if (! FRAME_MESSAGE_BUF (selected_frame
)
1006 Fkill_emacs (make_number (-1));
1010 Lisp_Object
command_loop_1 ();
1011 Lisp_Object
command_loop_2 ();
1012 Lisp_Object
top_level_1 ();
1014 /* Entry to editor-command-loop.
1015 This level has the catches for exiting/returning to editor command loop.
1016 It returns nil to exit recursive edit, t to abort it. */
1021 if (command_loop_level
> 0 || minibuf_level
> 0)
1023 return internal_catch (Qexit
, command_loop_2
, Qnil
);
1028 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1029 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1031 /* End of file in -batch run causes exit here. */
1037 /* Here we catch errors in execution of commands within the
1038 editing loop, and reenter the editing loop.
1039 When there is an error, cmd_error runs and returns a non-nil
1040 value to us. A value of nil means that cmd_loop_1 itself
1041 returned due to end of file (or end of kbd macro). */
1046 register Lisp_Object val
;
1049 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1050 while (!NILP (val
));
1058 return Feval (Vtop_level
);
1064 /* On entry to the outer level, run the startup file */
1065 if (!NILP (Vtop_level
))
1066 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1067 else if (!NILP (Vpurify_flag
))
1068 message ("Bare impure Emacs (standard Lisp code not loaded)");
1070 message ("Bare Emacs (standard Lisp code not loaded)");
1074 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1075 "Exit all recursive editing levels.")
1078 Fthrow (Qtop_level
, Qnil
);
1081 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1082 "Exit from the innermost recursive edit or minibuffer.")
1085 if (command_loop_level
> 0 || minibuf_level
> 0)
1086 Fthrow (Qexit
, Qnil
);
1088 error ("No recursive edit is in progress");
1091 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1092 "Abort the command that requested this recursive edit or minibuffer input.")
1095 if (command_loop_level
> 0 || minibuf_level
> 0)
1098 error ("No recursive edit is in progress");
1101 /* This is the actual command reading loop,
1102 sans error-handling encapsulation. */
1104 Lisp_Object
Fcommand_execute ();
1105 static int read_key_sequence ();
1106 void safe_run_hooks ();
1111 Lisp_Object cmd
, tem
;
1114 Lisp_Object keybuf
[30];
1119 struct buffer
*prev_buffer
;
1121 int was_locked
= single_kboard
;
1124 current_kboard
->Vprefix_arg
= Qnil
;
1125 Vdeactivate_mark
= Qnil
;
1126 waiting_for_input
= 0;
1131 this_command_key_count
= 0;
1132 this_single_command_key_start
= 0;
1134 /* Make sure this hook runs after commands that get errors and
1135 throw to top level. */
1136 /* Note that the value cell will never directly contain nil
1137 if the symbol is a local variable. */
1138 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1139 safe_run_hooks (Qpost_command_hook
);
1141 if (!NILP (Vdeferred_action_list
))
1142 call0 (Vdeferred_action_function
);
1144 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1146 if (NILP (Vunread_command_events
)
1147 && NILP (Vexecuting_macro
)
1148 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1149 safe_run_hooks (Qpost_command_idle_hook
);
1152 /* Do this after running Vpost_command_hook, for consistency. */
1153 current_kboard
->Vlast_command
= this_command
;
1157 /* Make sure the current window's buffer is selected. */
1158 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1159 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1161 /* Display any malloc warning that just came out. Use while because
1162 displaying one warning can cause another. */
1164 while (pending_malloc_warning
)
1165 display_malloc_warning ();
1169 Vdeactivate_mark
= Qnil
;
1171 /* If minibuffer on and echo area in use,
1172 wait 2 sec and redraw minibuffer. */
1174 if (minibuf_level
&& echo_area_glyphs
1175 && EQ (minibuf_window
, echo_area_window
))
1177 /* Bind inhibit-quit to t so that C-g gets read in
1178 rather than quitting back to the minibuffer. */
1179 int count
= specpdl_ptr
- specpdl
;
1180 specbind (Qinhibit_quit
, Qt
);
1182 Fsit_for (make_number (2), Qnil
, Qnil
);
1183 /* Clear the echo area. */
1185 safe_run_hooks (Qecho_area_clear_hook
);
1187 unbind_to (count
, Qnil
);
1189 /* If a C-g came in before, treat it as input now. */
1190 if (!NILP (Vquit_flag
))
1193 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1198 alloca (0); /* Cause a garbage collection now */
1199 /* Since we can free the most stuff here. */
1200 #endif /* C_ALLOCA */
1203 /* Select the frame that the last event came from. Usually,
1204 switch-frame events will take care of this, but if some lisp
1205 code swallows a switch-frame event, we'll fix things up here.
1206 Is this a good idea? */
1207 if (FRAMEP (internal_last_event_frame
)
1208 && XFRAME (internal_last_event_frame
) != selected_frame
)
1209 Fselect_frame (internal_last_event_frame
, Qnil
);
1211 /* If it has changed current-menubar from previous value,
1212 really recompute the menubar from the value. */
1213 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1214 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1215 call0 (Qrecompute_lucid_menubar
);
1217 before_command_key_count
= this_command_key_count
;
1218 before_command_echo_length
= echo_length ();
1220 this_command
= Qnil
;
1222 /* Read next key sequence; i gets its length. */
1223 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1226 /* A filter may have run while we were reading the input. */
1227 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1228 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1232 /* Now we have read a key sequence of length I,
1233 or else I is 0 and we found end of file. */
1235 if (i
== 0) /* End of file -- happens only in */
1236 return Qnil
; /* a kbd macro, at the end. */
1237 /* -1 means read_key_sequence got a menu that was rejected.
1238 Just loop around and read another command. */
1242 this_command_key_count
= 0;
1243 this_single_command_key_start
= 0;
1247 last_command_char
= keybuf
[i
- 1];
1249 /* If the previous command tried to force a specific window-start,
1250 forget about that, in case this command moves point far away
1251 from that position. But also throw away beg_unchanged and
1252 end_unchanged information in that case, so that redisplay will
1253 update the whole window properly. */
1254 if (!NILP (XWINDOW (selected_window
)->force_start
))
1256 XWINDOW (selected_window
)->force_start
= Qnil
;
1257 beg_unchanged
= end_unchanged
= 0;
1260 cmd
= read_key_sequence_cmd
;
1261 if (!NILP (Vexecuting_macro
))
1263 if (!NILP (Vquit_flag
))
1265 Vexecuting_macro
= Qt
;
1266 QUIT
; /* Make some noise. */
1267 /* Will return since macro now empty. */
1271 /* Do redisplay processing after this command except in special
1272 cases identified below that set no_redisplay to 1.
1273 (actually, there's currently no way to prevent the redisplay,
1274 and no_redisplay is ignored.
1275 Perhaps someday we will really implement it.) */
1278 prev_buffer
= current_buffer
;
1279 prev_modiff
= MODIFF
;
1280 last_point_position
= PT
;
1281 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1283 /* Execute the command. */
1286 /* Note that the value cell will never directly contain nil
1287 if the symbol is a local variable. */
1288 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1289 safe_run_hooks (Qpre_command_hook
);
1291 if (NILP (this_command
))
1293 /* nil means key is undefined. */
1295 current_kboard
->defining_kbd_macro
= Qnil
;
1296 update_mode_lines
= 1;
1297 current_kboard
->Vprefix_arg
= Qnil
;
1301 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1303 /* Recognize some common commands in common situations and
1304 do them directly. */
1305 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1307 struct Lisp_Char_Table
*dp
1308 = window_display_table (XWINDOW (selected_window
));
1309 lose
= FETCH_BYTE (PT_BYTE
);
1312 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1313 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1314 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1315 && (lose
>= 0x20 && lose
< 0x7f)))
1316 : (lose
>= 0x20 && lose
< 0x7f))
1317 /* To extract the case of continuation on
1318 wide-column characters. */
1319 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1320 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1322 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1324 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1326 && !windows_or_buffers_changed
1327 && EQ (current_buffer
->selective_display
, Qnil
)
1328 && !detect_input_pending ()
1329 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1330 && NILP (Vexecuting_macro
))
1331 no_redisplay
= direct_output_forward_char (1);
1334 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1336 struct Lisp_Char_Table
*dp
1337 = window_display_table (XWINDOW (selected_window
));
1339 lose
= FETCH_BYTE (PT_BYTE
);
1341 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1342 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1343 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1344 && (lose
>= 0x20 && lose
< 0x7f)))
1345 : (lose
>= 0x20 && lose
< 0x7f))
1346 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1348 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1350 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1352 && !windows_or_buffers_changed
1353 && EQ (current_buffer
->selective_display
, Qnil
)
1354 && !detect_input_pending ()
1355 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1356 && NILP (Vexecuting_macro
))
1357 no_redisplay
= direct_output_forward_char (-1);
1360 else if (EQ (this_command
, Qself_insert_command
)
1361 /* Try this optimization only on ascii keystrokes. */
1362 && INTEGERP (last_command_char
))
1364 unsigned int c
= XINT (last_command_char
);
1367 if (NILP (Vexecuting_macro
)
1368 && !EQ (minibuf_window
, selected_window
))
1370 if (!nonundocount
|| nonundocount
>= 20)
1377 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1379 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1381 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1383 || MODIFF
<= SAVE_MODIFF
1384 || windows_or_buffers_changed
1385 || !EQ (current_buffer
->selective_display
, Qnil
)
1386 || detect_input_pending ()
1387 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1388 || !NILP (Vexecuting_macro
));
1389 value
= internal_self_insert (c
, 0);
1396 && (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
1398 struct Lisp_Char_Table
*dp
1399 = window_display_table (XWINDOW (selected_window
));
1402 /* Add the offset to the character, for Finsert_char.
1403 We pass internal_self_insert the unmodified character
1404 because it itself does this offsetting. */
1405 if (! NILP (current_buffer
->enable_multibyte_characters
))
1406 lose
= unibyte_char_to_multibyte (lose
);
1412 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1415 /* Do it only for char codes
1416 that by default display as themselves. */
1417 if (lose
>= 0x20 && lose
<= 0x7e)
1418 no_redisplay
= direct_output_for_insert (lose
);
1420 else if (VECTORP (obj
)
1421 && XVECTOR (obj
)->size
== 1
1422 && (obj
= XVECTOR (obj
)->contents
[0],
1424 /* Insist face not specified in glyph. */
1425 && (XINT (obj
) & ((-1) << 8)) == 0)
1427 = direct_output_for_insert (XINT (obj
));
1431 if (lose
>= 0x20 && lose
<= 0x7e)
1432 no_redisplay
= direct_output_for_insert (lose
);
1439 /* Here for a command that isn't executed directly */
1442 if (NILP (current_kboard
->Vprefix_arg
))
1444 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1449 /* Note that the value cell will never directly contain nil
1450 if the symbol is a local variable. */
1451 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1452 safe_run_hooks (Qpost_command_hook
);
1454 if (!NILP (Vdeferred_action_list
))
1455 safe_run_hooks (Qdeferred_action_function
);
1457 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1459 if (NILP (Vunread_command_events
)
1460 && NILP (Vexecuting_macro
)
1461 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1462 safe_run_hooks (Qpost_command_idle_hook
);
1465 /* If there is a prefix argument,
1466 1) We don't want Vlast_command to be ``universal-argument''
1467 (that would be dumb), so don't set Vlast_command,
1468 2) we want to leave echoing on so that the prefix will be
1469 echoed as part of this key sequence, so don't call
1471 3) we want to leave this_command_key_count non-zero, so that
1472 read_char will realize that it is re-reading a character, and
1473 not echo it a second time.
1475 If the command didn't actually create a prefix arg,
1476 but is merely a frame event that is transparent to prefix args,
1477 then the above doesn't apply. */
1478 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1480 current_kboard
->Vlast_command
= this_command
;
1482 this_command_key_count
= 0;
1483 this_single_command_key_start
= 0;
1486 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1488 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1490 current_buffer
->mark_active
= Qnil
;
1491 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1493 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1494 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1498 /* Install chars successfully executed in kbd macro. */
1500 if (!NILP (current_kboard
->defining_kbd_macro
)
1501 && NILP (current_kboard
->Vprefix_arg
))
1502 finalize_kbd_macro_chars ();
1506 any_kboard_state ();
1511 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1514 safe_run_hooks_1 (hook
)
1517 return call1 (Vrun_hooks
, Vinhibit_quit
);
1520 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1523 safe_run_hooks_error (data
)
1526 Fset (Vinhibit_quit
, Qnil
);
1529 /* If we get an error while running the hook, cause the hook variable
1530 to be nil. Also inhibit quits, so that C-g won't cause the hook
1531 to mysteriously evaporate. */
1534 safe_run_hooks (hook
)
1538 int count
= specpdl_ptr
- specpdl
;
1539 specbind (Qinhibit_quit
, hook
);
1541 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1543 unbind_to (count
, Qnil
);
1546 /* Number of seconds between polling for input. */
1549 /* Nonzero means polling for input is temporarily suppressed. */
1550 int poll_suppress_count
;
1552 /* Nonzero if polling_for_input is actually being used. */
1553 int polling_for_input
;
1555 #ifdef POLL_FOR_INPUT
1557 /* Handle an alarm once each second and read pending input
1558 so as to handle a C-g if it comces in. */
1561 input_poll_signal (signalnum
) /* If we don't have an argument, */
1562 int signalnum
; /* some compilers complain in signal calls. */
1564 /* This causes the call to start_polling at the end
1565 to do its job. It also arranges for a quit or error
1566 from within read_avail_input to resume polling. */
1567 poll_suppress_count
++;
1568 if (interrupt_input_blocked
== 0
1569 && !waiting_for_input
)
1570 read_avail_input (0);
1571 /* Turn on the SIGALRM handler and request another alarm. */
1577 /* Begin signals to poll for input, if they are appropriate.
1578 This function is called unconditionally from various places. */
1583 #ifdef POLL_FOR_INPUT
1584 if (read_socket_hook
&& !interrupt_input
)
1586 poll_suppress_count
--;
1587 if (poll_suppress_count
== 0)
1589 signal (SIGALRM
, input_poll_signal
);
1590 polling_for_input
= 1;
1591 alarm (polling_period
);
1597 /* Nonzero if we are using polling to handle input asynchronously. */
1600 input_polling_used ()
1602 #ifdef POLL_FOR_INPUT
1603 return read_socket_hook
&& !interrupt_input
;
1609 /* Turn off polling. */
1614 #ifdef POLL_FOR_INPUT
1615 if (read_socket_hook
&& !interrupt_input
)
1617 if (poll_suppress_count
== 0)
1619 polling_for_input
= 0;
1622 poll_suppress_count
++;
1627 /* Set the value of poll_suppress_count to COUNT
1628 and start or stop polling accordingly. */
1631 set_poll_suppress_count (count
)
1634 #ifdef POLL_FOR_INPUT
1635 if (count
== 0 && poll_suppress_count
!= 0)
1637 poll_suppress_count
= 1;
1640 else if (count
!= 0 && poll_suppress_count
== 0)
1644 poll_suppress_count
= count
;
1648 /* Bind polling_period to a value at least N.
1649 But don't decrease it. */
1652 bind_polling_period (n
)
1655 #ifdef POLL_FOR_INPUT
1656 int new = polling_period
;
1662 specbind (Qpolling_period
, make_number (new));
1663 /* Start a new alarm with the new period. */
1668 /* Apply the control modifier to CHARACTER. */
1674 /* Save the upper bits here. */
1675 int upper
= c
& ~0177;
1679 /* Everything in the columns containing the upper-case letters
1680 denotes a control character. */
1681 if (c
>= 0100 && c
< 0140)
1685 /* Set the shift modifier for a control char
1686 made from a shifted letter. But only for letters! */
1687 if (oc
>= 'A' && oc
<= 'Z')
1688 c
|= shift_modifier
;
1691 /* The lower-case letters denote control characters too. */
1692 else if (c
>= 'a' && c
<= 'z')
1695 /* Include the bits for control and shift
1696 only if the basic ASCII code can't indicate them. */
1700 /* Replace the high bits. */
1701 c
|= (upper
& ~ctrl_modifier
);
1708 /* Input of single characters from keyboard */
1710 Lisp_Object
print_help ();
1711 static Lisp_Object
kbd_buffer_get_event ();
1712 static void record_char ();
1715 static jmp_buf wrong_kboard_jmpbuf
;
1718 /* read a character from the keyboard; call the redisplay if needed */
1719 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1720 -1 means do not do redisplay, but do do autosaving.
1723 /* The arguments MAPS and NMAPS are for menu prompting.
1724 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1726 PREV_EVENT is the previous input event, or nil if we are reading
1727 the first event of a key sequence.
1729 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1730 if we used a mouse menu to read the input, or zero otherwise. If
1731 USED_MOUSE_MENU is null, we don't dereference it.
1733 Value is t if we showed a menu and the user rejected it. */
1736 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1740 Lisp_Object prev_event
;
1741 int *used_mouse_menu
;
1745 jmp_buf local_getcjmp
;
1747 int key_already_recorded
= 0;
1748 Lisp_Object tem
, save
;
1749 Lisp_Object also_record
;
1750 struct gcpro gcpro1
;
1754 before_command_key_count
= this_command_key_count
;
1755 before_command_echo_length
= echo_length ();
1762 if (CONSP (Vunread_command_events
))
1764 c
= XCONS (Vunread_command_events
)->car
;
1765 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1767 /* Undo what read_char_x_menu_prompt did when it unread
1768 additional keys returned by Fx_popup_menu. */
1770 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1771 && NILP (XCONS (c
)->cdr
))
1774 if (this_command_key_count
== 0)
1780 if (unread_command_char
!= -1)
1782 XSETINT (c
, unread_command_char
);
1783 unread_command_char
= -1;
1785 if (this_command_key_count
== 0)
1791 /* If there is no function key translated before
1792 reset-this-command-lengths takes effect, forget about it. */
1793 before_command_restore_flag
= 0;
1795 if (!NILP (Vexecuting_macro
))
1797 /* We set this to Qmacro; since that's not a frame, nobody will
1798 try to switch frames on us, and the selected window will
1801 Since this event came from a macro, it would be misleading to
1802 leave internal_last_event_frame set to wherever the last
1803 real event came from. Normally, a switch-frame event selects
1804 internal_last_event_frame after each command is read, but
1805 events read from a macro should never cause a new frame to be
1807 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1809 /* Exit the macro if we are at the end.
1810 Also, some things replace the macro with t
1811 to force an early exit. */
1812 if (EQ (Vexecuting_macro
, Qt
)
1813 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1819 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1820 if (STRINGP (Vexecuting_macro
)
1821 && (XINT (c
) & 0x80))
1822 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1824 executing_macro_index
++;
1829 if (!NILP (unread_switch_frame
))
1831 c
= unread_switch_frame
;
1832 unread_switch_frame
= Qnil
;
1834 /* This event should make it into this_command_keys, and get echoed
1835 again, so we go to reread_first, rather than reread. */
1839 /* if redisplay was requested */
1840 if (commandflag
>= 0)
1842 /* If there is pending input, process any events which are not
1843 user-visible, such as X selection_request events. */
1845 || detect_input_pending_run_timers (0))
1846 swallow_events (0); /* may clear input_pending */
1848 /* Redisplay if no pending input. */
1849 while (!input_pending
)
1854 /* Normal case: no input arrived during redisplay. */
1857 /* Input arrived and pre-empted redisplay.
1858 Process any events which are not user-visible. */
1860 /* If that cleared input_pending, try again to redisplay. */
1864 /* Message turns off echoing unless more keystrokes turn it on again. */
1865 if (echo_area_glyphs
&& *echo_area_glyphs
1866 && echo_area_glyphs
!= current_kboard
->echobuf
1867 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1870 /* If already echoing, continue. */
1873 /* Try reading a character via menu prompting in the minibuf.
1874 Try this before the sit-for, because the sit-for
1875 would do the wrong thing if we are supposed to do
1876 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1877 after a mouse event so don't try a minibuf menu. */
1879 if (nmaps
> 0 && INTERACTIVE
1880 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1881 /* Don't bring up a menu if we already have another event. */
1882 && NILP (Vunread_command_events
)
1883 && unread_command_char
< 0
1884 && !detect_input_pending_run_timers (0))
1886 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1889 key_already_recorded
= 1;
1894 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1895 We will do that below, temporarily for short sections of code,
1896 when appropriate. local_getcjmp must be in effect
1897 around any call to sit_for or kbd_buffer_get_event;
1898 it *must not* be in effect when we call redisplay. */
1900 if (_setjmp (local_getcjmp
))
1902 XSETINT (c
, quit_char
);
1903 XSETFRAME (internal_last_event_frame
, selected_frame
);
1904 Vlast_event_frame
= internal_last_event_frame
;
1905 /* If we report the quit char as an event,
1906 don't do so more than once. */
1907 if (!NILP (Vinhibit_quit
))
1912 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1913 if (kb
!= current_kboard
)
1915 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1916 /* We shouldn't get here if we were in single-kboard mode! */
1919 while (CONSP (*tailp
))
1920 tailp
= &XCONS (*tailp
)->cdr
;
1923 *tailp
= Fcons (c
, Qnil
);
1924 kb
->kbd_queue_has_data
= 1;
1925 current_kboard
= kb
;
1926 /* This is going to exit from read_char
1927 so we had better get rid of this frame's stuff. */
1929 longjmp (wrong_kboard_jmpbuf
, 1);
1936 timer_start_idle ();
1938 /* If in middle of key sequence and minibuffer not active,
1939 start echoing if enough time elapses. */
1941 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1942 && this_command_key_count
> 0
1944 && echo_keystrokes
> 0
1945 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1946 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1950 /* After a mouse event, start echoing right away.
1951 This is because we are probably about to display a menu,
1952 and we don't want to delay before doing so. */
1953 if (EVENT_HAS_PARAMETERS (prev_event
))
1957 save_getcjmp (save_jump
);
1958 restore_getcjmp (local_getcjmp
);
1959 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1960 restore_getcjmp (save_jump
);
1962 && ! CONSP (Vunread_command_events
))
1967 /* Maybe auto save due to number of keystrokes. */
1969 if (commandflag
!= 0
1970 && auto_save_interval
> 0
1971 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1972 && !detect_input_pending_run_timers (0))
1974 Fdo_auto_save (Qnil
, Qnil
);
1975 /* Hooks can actually change some buffers in auto save. */
1979 /* Try reading using an X menu.
1980 This is never confused with reading using the minibuf
1981 because the recursive call of read_char in read_char_minibuf_menu_prompt
1982 does not pass on any keymaps. */
1984 if (nmaps
> 0 && INTERACTIVE
1985 && !NILP (prev_event
)
1986 && EVENT_HAS_PARAMETERS (prev_event
)
1987 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1988 /* Don't bring up a menu if we already have another event. */
1989 && NILP (Vunread_command_events
)
1990 && unread_command_char
< 0)
1992 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1994 /* Now that we have read an event, Emacs is not idle. */
2000 /* Maybe autosave and/or garbage collect due to idleness. */
2002 if (INTERACTIVE
&& NILP (c
))
2004 int delay_level
, buffer_size
;
2006 /* Slow down auto saves logarithmically in size of current buffer,
2007 and garbage collect while we're at it. */
2008 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2009 last_non_minibuf_size
= Z
- BEG
;
2010 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2012 while (buffer_size
> 64)
2013 delay_level
++, buffer_size
-= buffer_size
>> 2;
2014 if (delay_level
< 4) delay_level
= 4;
2015 /* delay_level is 4 for files under around 50k, 7 at 100k,
2016 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2018 /* Auto save if enough time goes by without input. */
2019 if (commandflag
!= 0
2020 && num_nonmacro_input_events
> last_auto_save
2021 && INTEGERP (Vauto_save_timeout
)
2022 && XINT (Vauto_save_timeout
) > 0)
2026 save_getcjmp (save_jump
);
2027 restore_getcjmp (local_getcjmp
);
2028 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2030 restore_getcjmp (save_jump
);
2033 && ! CONSP (Vunread_command_events
))
2035 Fdo_auto_save (Qnil
, Qnil
);
2037 /* If we have auto-saved and there is still no input
2038 available, garbage collect if there has been enough
2039 consing going on to make it worthwhile. */
2040 if (!detect_input_pending_run_timers (0)
2041 && consing_since_gc
> gc_cons_threshold
/ 2)
2042 Fgarbage_collect ();
2049 /* If this has become non-nil here, it has been set by a timer
2050 or sentinel or filter. */
2051 if (CONSP (Vunread_command_events
))
2053 c
= XCONS (Vunread_command_events
)->car
;
2054 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2057 /* Read something from current KBOARD's side queue, if possible. */
2061 if (current_kboard
->kbd_queue_has_data
)
2063 if (!CONSP (current_kboard
->kbd_queue
))
2065 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2066 current_kboard
->kbd_queue
2067 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2068 if (NILP (current_kboard
->kbd_queue
))
2069 current_kboard
->kbd_queue_has_data
= 0;
2070 input_pending
= readable_events (0);
2071 if (EVENT_HAS_PARAMETERS (c
)
2072 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2073 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2074 Vlast_event_frame
= internal_last_event_frame
;
2079 /* If current_kboard's side queue is empty check the other kboards.
2080 If one of them has data that we have not yet seen here,
2081 switch to it and process the data waiting for it.
2083 Note: if the events queued up for another kboard
2084 have already been seen here, and therefore are not a complete command,
2085 the kbd_queue_has_data field is 0, so we skip that kboard here.
2086 That's to avoid an infinite loop switching between kboards here. */
2087 if (NILP (c
) && !single_kboard
)
2090 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2091 if (kb
->kbd_queue_has_data
)
2093 current_kboard
= kb
;
2094 /* This is going to exit from read_char
2095 so we had better get rid of this frame's stuff. */
2097 longjmp (wrong_kboard_jmpbuf
, 1);
2106 /* Finally, we read from the main queue,
2107 and if that gives us something we can't use yet, we put it on the
2108 appropriate side queue and try again. */
2114 /* Actually read a character, waiting if necessary. */
2115 save_getcjmp (save_jump
);
2116 restore_getcjmp (local_getcjmp
);
2117 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2118 restore_getcjmp (save_jump
);
2121 if (! NILP (c
) && (kb
!= current_kboard
))
2123 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2124 while (CONSP (*tailp
))
2125 tailp
= &XCONS (*tailp
)->cdr
;
2128 *tailp
= Fcons (c
, Qnil
);
2129 kb
->kbd_queue_has_data
= 1;
2133 current_kboard
= kb
;
2134 /* This is going to exit from read_char
2135 so we had better get rid of this frame's stuff. */
2137 longjmp (wrong_kboard_jmpbuf
, 1);
2142 /* Terminate Emacs in batch mode if at eof. */
2143 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2144 Fkill_emacs (make_number (1));
2148 /* Add in any extra modifiers, where appropriate. */
2149 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2150 || ((extra_keyboard_modifiers
& 0177) < ' '
2151 && (extra_keyboard_modifiers
& 0177) != 0))
2152 XSETINT (c
, make_ctrl_char (XINT (c
)));
2154 /* Transfer any other modifier bits directly from
2155 extra_keyboard_modifiers to c. Ignore the actual character code
2156 in the low 16 bits of extra_keyboard_modifiers. */
2157 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2168 if (commandflag
>= 0
2169 && !input_pending
&& !detect_input_pending_run_timers (0))
2177 /* Buffer switch events are only for internal wakeups
2178 so don't show them to the user.
2179 Also, don't record a key if we already did. */
2180 if (BUFFERP (c
) || key_already_recorded
)
2183 /* Process special events within read_char
2184 and loop around to read another event. */
2187 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2193 int was_locked
= single_kboard
;
2195 last_input_char
= c
;
2196 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2198 /* Resume allowing input from any kboard, if that was true before. */
2200 any_kboard_state ();
2205 /* Wipe the echo area. */
2206 if (echo_area_glyphs
)
2207 safe_run_hooks (Qecho_area_clear_hook
);
2208 echo_area_glyphs
= 0;
2210 /* Handle things that only apply to characters. */
2213 /* If kbd_buffer_get_event gave us an EOF, return that. */
2217 if ((STRINGP (Vkeyboard_translate_table
)
2218 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2219 || (VECTORP (Vkeyboard_translate_table
)
2220 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2221 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2222 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2225 d
= Faref (Vkeyboard_translate_table
, c
);
2226 /* nil in keyboard-translate-table means no translation. */
2232 /* If this event is a mouse click in the menu bar,
2233 return just menu-bar for now. Modify the mouse click event
2234 so we won't do this twice, then queue it up. */
2235 if (EVENT_HAS_PARAMETERS (c
)
2236 && CONSP (XCONS (c
)->cdr
)
2237 && CONSP (EVENT_START (c
))
2238 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2242 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2243 /* Handle menu-bar events:
2244 insert the dummy prefix event `menu-bar'. */
2245 if (EQ (posn
, Qmenu_bar
))
2247 /* Change menu-bar to (menu-bar) as the event "position". */
2248 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2251 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2257 if (! NILP (also_record
))
2258 record_char (also_record
);
2263 before_command_key_count
= this_command_key_count
;
2264 before_command_echo_length
= echo_length ();
2266 /* Don't echo mouse motion events. */
2268 && ! (EVENT_HAS_PARAMETERS (c
)
2269 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2272 if (! NILP (also_record
))
2273 echo_char (also_record
);
2274 /* Once we reread a character, echoing can happen
2275 the next time we pause to read a new one. */
2276 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2279 /* Record this character as part of the current key. */
2280 add_command_key (c
);
2281 if (! NILP (also_record
))
2282 add_command_key (also_record
);
2284 /* Re-reading in the middle of a command */
2286 last_input_char
= c
;
2289 /* Process the help character specially if enabled */
2290 if (!NILP (Vhelp_form
) && help_char_p (c
))
2293 count
= specpdl_ptr
- specpdl
;
2295 record_unwind_protect (Fset_window_configuration
,
2296 Fcurrent_window_configuration (Qnil
));
2298 tem0
= Feval (Vhelp_form
);
2300 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2304 c
= read_char (0, 0, 0, Qnil
, 0);
2305 while (BUFFERP (c
));
2306 /* Remove the help from the frame */
2307 unbind_to (count
, Qnil
);
2310 if (EQ (c
, make_number (040)))
2314 c
= read_char (0, 0, 0, Qnil
, 0);
2315 while (BUFFERP (c
));
2322 /* Record a key that came from a mouse menu.
2323 Record it for echoing, for this-command-keys, and so on. */
2329 /* Wipe the echo area. */
2330 echo_area_glyphs
= 0;
2334 before_command_key_count
= this_command_key_count
;
2335 before_command_echo_length
= echo_length ();
2337 /* Don't echo mouse motion events. */
2338 if (echo_keystrokes
)
2342 /* Once we reread a character, echoing can happen
2343 the next time we pause to read a new one. */
2344 ok_to_echo_at_next_pause
= 0;
2347 /* Record this character as part of the current key. */
2348 add_command_key (c
);
2350 /* Re-reading in the middle of a command */
2351 last_input_char
= c
;
2355 /* Return 1 if should recognize C as "the help character". */
2363 if (EQ (c
, Vhelp_char
))
2365 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2366 if (EQ (c
, XCONS (tail
)->car
))
2371 /* Record the input event C in various ways. */
2378 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2379 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2380 recent_keys_index
= 0;
2382 /* Write c to the dribble file. If c is a lispy event, write
2383 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2384 If you, dear reader, have a better idea, you've got the source. :-) */
2389 if (XUINT (c
) < 0x100)
2390 putc (XINT (c
), dribble
);
2392 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2396 Lisp_Object dribblee
;
2398 /* If it's a structured event, take the event header. */
2399 dribblee
= EVENT_HEAD (c
);
2401 if (SYMBOLP (dribblee
))
2403 putc ('<', dribble
);
2404 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2405 STRING_BYTES (XSYMBOL (dribblee
)->name
),
2407 putc ('>', dribble
);
2414 store_kbd_macro_char (c
);
2416 num_nonmacro_input_events
++;
2423 struct buffer
*old
= current_buffer
;
2424 Fprinc (object
, Qnil
);
2425 set_buffer_internal (XBUFFER (Vstandard_output
));
2426 call0 (intern ("help-mode"));
2427 set_buffer_internal (old
);
2431 /* Copy out or in the info on where C-g should throw to.
2432 This is used when running Lisp code from within get_char,
2433 in case get_char is called recursively.
2434 See read_process_output. */
2440 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2444 restore_getcjmp (temp
)
2447 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2452 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2453 of this function. */
2456 tracking_off (old_value
)
2457 Lisp_Object old_value
;
2459 do_mouse_tracking
= old_value
;
2460 if (NILP (old_value
))
2462 /* Redisplay may have been preempted because there was input
2463 available, and it assumes it will be called again after the
2464 input has been processed. If the only input available was
2465 the sort that we have just disabled, then we need to call
2467 if (!readable_events (1))
2469 redisplay_preserve_echo_area ();
2470 get_input_pending (&input_pending
, 1);
2475 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2476 "Evaluate BODY with mouse movement events enabled.\n\
2477 Within a `track-mouse' form, mouse motion generates input events that\n\
2478 you can read with `read-event'.\n\
2479 Normally, mouse motion is ignored.")
2483 int count
= specpdl_ptr
- specpdl
;
2486 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2488 do_mouse_tracking
= Qt
;
2490 val
= Fprogn (args
);
2491 return unbind_to (count
, val
);
2494 /* If mouse has moved on some frame, return one of those frames.
2495 Return 0 otherwise. */
2500 Lisp_Object tail
, frame
;
2502 FOR_EACH_FRAME (tail
, frame
)
2504 if (XFRAME (frame
)->mouse_moved
)
2505 return XFRAME (frame
);
2511 #endif /* HAVE_MOUSE */
2513 /* Low level keyboard/mouse input.
2514 kbd_buffer_store_event places events in kbd_buffer, and
2515 kbd_buffer_get_event retrieves them. */
2517 /* Return true iff there are any events in the queue that read-char
2518 would return. If this returns false, a read-char would block. */
2520 readable_events (do_timers_now
)
2524 timer_check (do_timers_now
);
2526 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2529 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2534 if (current_kboard
->kbd_queue_has_data
)
2540 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2541 if (kb
->kbd_queue_has_data
)
2547 /* Set this for debugging, to have a way to get out */
2552 event_to_kboard (event
)
2553 struct input_event
*event
;
2556 frame
= event
->frame_or_window
;
2558 frame
= XCONS (frame
)->car
;
2559 else if (WINDOWP (frame
))
2560 frame
= WINDOW_FRAME (XWINDOW (frame
));
2562 /* There are still some events that don't set this field.
2563 For now, just ignore the problem.
2564 Also ignore dead frames here. */
2565 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2568 return FRAME_KBOARD (XFRAME (frame
));
2572 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2575 kbd_buffer_store_event (event
)
2576 register struct input_event
*event
;
2578 if (event
->kind
== no_event
)
2581 if (event
->kind
== ascii_keystroke
)
2583 register int c
= event
->code
& 0377;
2585 if (event
->modifiers
& ctrl_modifier
)
2586 c
= make_ctrl_char (c
);
2588 c
|= (event
->modifiers
2589 & (meta_modifier
| alt_modifier
2590 | hyper_modifier
| super_modifier
));
2594 extern SIGTYPE
interrupt_signal ();
2597 struct input_event
*sp
;
2600 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2601 kb
!= current_kboard
))
2604 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2605 Fcons (make_number (c
), Qnil
));
2606 kb
->kbd_queue_has_data
= 1;
2607 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2609 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2612 if (event_to_kboard (sp
) == kb
)
2614 sp
->kind
= no_event
;
2615 sp
->frame_or_window
= Qnil
;
2622 /* If this results in a quit_char being returned to Emacs as
2623 input, set Vlast_event_frame properly. If this doesn't
2624 get returned to Emacs as an event, the next event read
2625 will set Vlast_event_frame again, so this is safe to do. */
2629 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2631 focus
= event
->frame_or_window
;
2632 internal_last_event_frame
= focus
;
2633 Vlast_event_frame
= focus
;
2636 last_event_timestamp
= event
->timestamp
;
2637 interrupt_signal ();
2641 if (c
&& c
== stop_character
)
2647 /* Don't insert two buffer_switch_event's in a row.
2648 Just ignore the second one. */
2649 else if (event
->kind
== buffer_switch_event
2650 && kbd_fetch_ptr
!= kbd_store_ptr
2651 && kbd_store_ptr
->kind
== buffer_switch_event
)
2654 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2655 kbd_store_ptr
= kbd_buffer
;
2657 /* Don't let the very last slot in the buffer become full,
2658 since that would make the two pointers equal,
2659 and that is indistinguishable from an empty buffer.
2660 Discard the event if it would fill the last slot. */
2661 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2663 volatile struct input_event
*sp
= kbd_store_ptr
;
2664 sp
->kind
= event
->kind
;
2665 if (event
->kind
== selection_request_event
)
2667 /* We must not use the ordinary copying code for this case,
2668 since `part' is an enum and copying it might not copy enough
2670 bcopy (event
, (char *) sp
, sizeof (*event
));
2674 sp
->code
= event
->code
;
2675 sp
->part
= event
->part
;
2676 sp
->frame_or_window
= event
->frame_or_window
;
2677 sp
->modifiers
= event
->modifiers
;
2680 sp
->timestamp
= event
->timestamp
;
2682 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2684 = event
->frame_or_window
);
2690 /* Discard any mouse events in the event buffer by setting them to
2693 discard_mouse_events ()
2695 struct input_event
*sp
;
2696 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2698 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2701 if (sp
->kind
== mouse_click
2703 || sp
->kind
== w32_scroll_bar_click
2705 || sp
->kind
== scroll_bar_click
)
2707 sp
->kind
= no_event
;
2712 /* Read one event from the event buffer, waiting if necessary.
2713 The value is a Lisp object representing the event.
2714 The value is nil for an event that should be ignored,
2715 or that was handled here.
2716 We always read and discard one event. */
2719 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2721 int *used_mouse_menu
;
2725 EMACS_TIME next_timer_delay
;
2731 *kbp
= current_kboard
;
2735 /* Wait until there is input available. */
2738 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2741 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2745 /* If the quit flag is set, then read_char will return
2746 quit_char, so that counts as "available input." */
2747 if (!NILP (Vquit_flag
))
2748 quit_throw_to_read_char ();
2750 /* One way or another, wait until input is available; then, if
2751 interrupt handlers have not read it, read it now. */
2754 wait_for_kbd_input ();
2756 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2760 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2763 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2767 Lisp_Object minus_one
;
2769 XSETINT (minus_one
, -1);
2770 wait_reading_process_input (0, 0, minus_one
, 1);
2772 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2773 /* Pass 1 for EXPECT since we just waited to have input. */
2774 read_avail_input (1);
2776 #endif /* not VMS */
2779 if (CONSP (Vunread_command_events
))
2782 first
= XCONS (Vunread_command_events
)->car
;
2783 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2784 *kbp
= current_kboard
;
2788 /* At this point, we know that there is a readable event available
2789 somewhere. If the event queue is empty, then there must be a
2790 mouse movement enabled and available. */
2791 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2793 struct input_event
*event
;
2795 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2799 last_event_timestamp
= event
->timestamp
;
2802 *kbp
= event_to_kboard (event
);
2804 *kbp
= current_kboard
; /* Better than returning null ptr? */
2806 *kbp
= &the_only_kboard
;
2811 /* These two kinds of events get special handling
2812 and don't actually appear to the command loop.
2813 We return nil for them. */
2814 if (event
->kind
== selection_request_event
)
2817 struct input_event copy
;
2819 /* Remove it from the buffer before processing it,
2820 since otherwise swallow_events will see it
2821 and process it again. */
2823 kbd_fetch_ptr
= event
+ 1;
2824 input_pending
= readable_events (0);
2825 x_handle_selection_request (©
);
2827 /* We're getting selection request events, but we don't have
2833 else if (event
->kind
== selection_clear_event
)
2836 struct input_event copy
;
2838 /* Remove it from the buffer before processing it. */
2840 kbd_fetch_ptr
= event
+ 1;
2841 input_pending
= readable_events (0);
2842 x_handle_selection_clear (©
);
2844 /* We're getting selection request events, but we don't have
2849 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2850 else if (event
->kind
== delete_window_event
)
2852 /* Make an event (delete-frame (FRAME)). */
2853 obj
= Fcons (event
->frame_or_window
, Qnil
);
2854 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2855 kbd_fetch_ptr
= event
+ 1;
2857 else if (event
->kind
== iconify_event
)
2859 /* Make an event (iconify-frame (FRAME)). */
2860 obj
= Fcons (event
->frame_or_window
, Qnil
);
2861 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2862 kbd_fetch_ptr
= event
+ 1;
2864 else if (event
->kind
== deiconify_event
)
2866 /* Make an event (make-frame-visible (FRAME)). */
2867 obj
= Fcons (event
->frame_or_window
, Qnil
);
2868 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2869 kbd_fetch_ptr
= event
+ 1;
2872 else if (event
->kind
== buffer_switch_event
)
2874 /* The value doesn't matter here; only the type is tested. */
2875 XSETBUFFER (obj
, current_buffer
);
2876 kbd_fetch_ptr
= event
+ 1;
2878 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2879 else if (event
->kind
== menu_bar_activate_event
)
2881 kbd_fetch_ptr
= event
+ 1;
2882 input_pending
= readable_events (0);
2883 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2884 x_activate_menubar (XFRAME (event
->frame_or_window
));
2887 /* Just discard these, by returning nil.
2888 With MULTI_KBOARD, these events are used as placeholders
2889 when we need to randomly delete events from the queue.
2890 (They shouldn't otherwise be found in the buffer,
2891 but on some machines it appears they do show up
2892 even without MULTI_KBOARD.) */
2893 /* On Windows NT/9X, no_event is used to delete extraneous
2894 mouse events during a popup-menu call. */
2895 else if (event
->kind
== no_event
)
2896 kbd_fetch_ptr
= event
+ 1;
2898 /* If this event is on a different frame, return a switch-frame this
2899 time, and leave the event in the queue for next time. */
2905 frame
= event
->frame_or_window
;
2907 frame
= XCONS (frame
)->car
;
2908 else if (WINDOWP (frame
))
2909 frame
= WINDOW_FRAME (XWINDOW (frame
));
2911 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2915 if (! EQ (frame
, internal_last_event_frame
)
2916 && XFRAME (frame
) != selected_frame
)
2917 obj
= make_lispy_switch_frame (frame
);
2918 internal_last_event_frame
= frame
;
2920 /* If we didn't decide to make a switch-frame event, go ahead
2921 and build a real event from the queue entry. */
2925 obj
= make_lispy_event (event
);
2926 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2927 /* If this was a menu selection, then set the flag to inhibit
2928 writing to last_nonmenu_event. Don't do this if the event
2929 we're returning is (menu-bar), though; that indicates the
2930 beginning of the menu sequence, and we might as well leave
2931 that as the `event with parameters' for this selection. */
2932 if (event
->kind
== menu_bar_event
2933 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2935 *used_mouse_menu
= 1;
2938 /* Wipe out this event, to catch bugs. */
2939 event
->kind
= no_event
;
2940 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2942 kbd_fetch_ptr
= event
+ 1;
2947 /* Try generating a mouse motion event. */
2948 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2950 FRAME_PTR f
= some_mouse_moved ();
2951 Lisp_Object bar_window
;
2952 enum scroll_bar_part part
;
2956 *kbp
= current_kboard
;
2957 /* Note that this uses F to determine which display to look at.
2958 If there is no valid info, it does not store anything
2959 so x remains nil. */
2961 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2965 /* Decide if we should generate a switch-frame event. Don't
2966 generate switch-frame events for motion outside of all Emacs
2972 frame
= FRAME_FOCUS_FRAME (f
);
2974 XSETFRAME (frame
, f
);
2976 if (! EQ (frame
, internal_last_event_frame
)
2977 && XFRAME (frame
) != selected_frame
)
2978 obj
= make_lispy_switch_frame (frame
);
2979 internal_last_event_frame
= frame
;
2982 /* If we didn't decide to make a switch-frame event, go ahead and
2983 return a mouse-motion event. */
2984 if (!NILP (x
) && NILP (obj
))
2985 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2987 #endif /* HAVE_MOUSE */
2989 /* We were promised by the above while loop that there was
2990 something for us to read! */
2993 input_pending
= readable_events (0);
2995 Vlast_event_frame
= internal_last_event_frame
;
3000 /* Process any events that are not user-visible,
3001 then return, without reading any user-visible events. */
3004 swallow_events (do_display
)
3009 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3011 struct input_event
*event
;
3013 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3017 last_event_timestamp
= event
->timestamp
;
3019 /* These two kinds of events get special handling
3020 and don't actually appear to the command loop. */
3021 if (event
->kind
== selection_request_event
)
3024 struct input_event copy
;
3026 /* Remove it from the buffer before processing it,
3027 since otherwise swallow_events called recursively could see it
3028 and process it again. */
3030 kbd_fetch_ptr
= event
+ 1;
3031 input_pending
= readable_events (0);
3032 x_handle_selection_request (©
);
3034 /* We're getting selection request events, but we don't have
3040 else if (event
->kind
== selection_clear_event
)
3043 struct input_event copy
;
3045 /* Remove it from the buffer before processing it, */
3048 kbd_fetch_ptr
= event
+ 1;
3049 input_pending
= readable_events (0);
3050 x_handle_selection_clear (©
);
3052 /* We're getting selection request events, but we don't have
3061 old_timers_run
= timers_run
;
3062 get_input_pending (&input_pending
, 1);
3064 if (timers_run
!= old_timers_run
&& do_display
)
3065 redisplay_preserve_echo_area ();
3068 static EMACS_TIME timer_idleness_start_time
;
3070 /* Record the start of when Emacs is idle,
3071 for the sake of running idle-time timers. */
3078 /* If we are already in the idle state, do nothing. */
3079 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3082 EMACS_GET_TIME (timer_idleness_start_time
);
3084 /* Mark all idle-time timers as once again candidates for running. */
3085 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3089 timer
= XCONS (timers
)->car
;
3091 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3093 XVECTOR (timer
)->contents
[0] = Qnil
;
3097 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3102 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3105 /* This is only for debugging. */
3106 struct input_event last_timer_event
;
3108 /* Check whether a timer has fired. To prevent larger problems we simply
3109 disregard elements that are not proper timers. Do not make a circular
3110 timer list for the time being.
3112 Returns the number of seconds to wait until the next timer fires. If a
3113 timer is triggering now, return zero seconds.
3114 If no timer is active, return -1 seconds.
3116 If a timer is ripe, we run it, with quitting turned off.
3118 DO_IT_NOW is now ignored. It used to mean that we should
3119 run the timer directly instead of queueing a timer-event.
3120 Now we always run timers directly. */
3123 timer_check (do_it_now
)
3126 EMACS_TIME nexttime
;
3127 EMACS_TIME now
, idleness_now
;
3128 Lisp_Object timers
, idle_timers
, chosen_timer
;
3129 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3131 EMACS_SET_SECS (nexttime
, -1);
3132 EMACS_SET_USECS (nexttime
, -1);
3134 /* Always consider the ordinary timers. */
3135 timers
= Vtimer_list
;
3136 /* Consider the idle timers only if Emacs is idle. */
3137 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3138 idle_timers
= Vtimer_idle_list
;
3141 chosen_timer
= Qnil
;
3142 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3144 if (CONSP (timers
) || CONSP (idle_timers
))
3146 EMACS_GET_TIME (now
);
3147 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3148 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3151 while (CONSP (timers
) || CONSP (idle_timers
))
3153 int triggertime
= EMACS_SECS (now
);
3154 Lisp_Object
*vector
;
3155 Lisp_Object timer
, idle_timer
;
3156 EMACS_TIME timer_time
, idle_timer_time
;
3157 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3159 /* Skip past invalid timers and timers already handled. */
3162 timer
= XCONS (timers
)->car
;
3163 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3165 timers
= XCONS (timers
)->cdr
;
3168 vector
= XVECTOR (timer
)->contents
;
3170 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3171 || !INTEGERP (vector
[3])
3172 || ! NILP (vector
[0]))
3174 timers
= XCONS (timers
)->cdr
;
3178 if (!NILP (idle_timers
))
3180 timer
= XCONS (idle_timers
)->car
;
3181 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3183 idle_timers
= XCONS (idle_timers
)->cdr
;
3186 vector
= XVECTOR (timer
)->contents
;
3188 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3189 || !INTEGERP (vector
[3])
3190 || ! NILP (vector
[0]))
3192 idle_timers
= XCONS (idle_timers
)->cdr
;
3197 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3198 based on the next ordinary timer.
3199 TIMER_DIFFERENCE is the distance in time from NOW to when
3200 this timer becomes ripe (negative if it's already ripe). */
3203 timer
= XCONS (timers
)->car
;
3204 vector
= XVECTOR (timer
)->contents
;
3205 EMACS_SET_SECS (timer_time
,
3206 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3207 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3208 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3211 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3212 based on the next idle timer. */
3213 if (!NILP (idle_timers
))
3215 idle_timer
= XCONS (idle_timers
)->car
;
3216 vector
= XVECTOR (idle_timer
)->contents
;
3217 EMACS_SET_SECS (idle_timer_time
,
3218 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3219 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3220 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3223 /* Decide which timer is the next timer,
3224 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3225 Also step down the list where we found that timer. */
3227 if (! NILP (timers
) && ! NILP (idle_timers
))
3230 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3231 if (EMACS_TIME_NEG_P (temp
))
3233 chosen_timer
= timer
;
3234 timers
= XCONS (timers
)->cdr
;
3235 difference
= timer_difference
;
3239 chosen_timer
= idle_timer
;
3240 idle_timers
= XCONS (idle_timers
)->cdr
;
3241 difference
= idle_timer_difference
;
3244 else if (! NILP (timers
))
3246 chosen_timer
= timer
;
3247 timers
= XCONS (timers
)->cdr
;
3248 difference
= timer_difference
;
3252 chosen_timer
= idle_timer
;
3253 idle_timers
= XCONS (idle_timers
)->cdr
;
3254 difference
= idle_timer_difference
;
3256 vector
= XVECTOR (chosen_timer
)->contents
;
3258 /* If timer is rupe, run it if it hasn't been run. */
3259 if (EMACS_TIME_NEG_P (difference
)
3260 || (EMACS_SECS (difference
) == 0
3261 && EMACS_USECS (difference
) == 0))
3263 if (NILP (vector
[0]))
3266 int was_locked
= single_kboard
;
3267 int count
= specpdl_ptr
- specpdl
;
3269 /* Mark the timer as triggered to prevent problems if the lisp
3270 code fails to reschedule it right. */
3273 specbind (Qinhibit_quit
, Qt
);
3275 call1 (Qtimer_event_handler
, chosen_timer
);
3278 unbind_to (count
, Qnil
);
3280 /* Resume allowing input from any kboard, if that was true before. */
3282 any_kboard_state ();
3284 /* Since we have handled the event,
3285 we don't need to tell the caller to wake up and do it. */
3289 /* When we encounter a timer that is still waiting,
3290 return the amount of time to wait before it is ripe. */
3297 /* No timers are pending in the future. */
3298 /* Return 0 if we generated an event, and -1 if not. */
3303 /* Caches for modify_event_symbol. */
3304 static Lisp_Object accent_key_syms
;
3305 static Lisp_Object func_key_syms
;
3306 static Lisp_Object mouse_syms
;
3308 static Lisp_Object mouse_wheel_syms
;
3310 static Lisp_Object drag_n_drop_syms
;
3312 /* This is a list of keysym codes for special "accent" characters.
3313 It parallels lispy_accent_keys. */
3315 static int lispy_accent_codes
[] =
3317 #ifdef XK_dead_circumflex
3322 #ifdef XK_dead_grave
3327 #ifdef XK_dead_tilde
3332 #ifdef XK_dead_diaeresis
3337 #ifdef XK_dead_macron
3342 #ifdef XK_dead_degree
3347 #ifdef XK_dead_acute
3352 #ifdef XK_dead_cedilla
3357 #ifdef XK_dead_breve
3362 #ifdef XK_dead_ogonek
3367 #ifdef XK_dead_caron
3372 #ifdef XK_dead_doubleacute
3373 XK_dead_doubleacute
,
3377 #ifdef XK_dead_abovedot
3384 /* This is a list of Lisp names for special "accent" characters.
3385 It parallels lispy_accent_codes. */
3387 static char *lispy_accent_keys
[] =
3405 #define FUNCTION_KEY_OFFSET 0x0
3407 char *lispy_function_keys
[] =
3411 0, /* VK_LBUTTON 0x01 */
3412 0, /* VK_RBUTTON 0x02 */
3413 "cancel", /* VK_CANCEL 0x03 */
3414 0, /* VK_MBUTTON 0x04 */
3416 0, 0, 0, /* 0x05 .. 0x07 */
3418 "backspace", /* VK_BACK 0x08 */
3419 "tab", /* VK_TAB 0x09 */
3421 0, 0, /* 0x0A .. 0x0B */
3423 "clear", /* VK_CLEAR 0x0C */
3424 "return", /* VK_RETURN 0x0D */
3426 0, 0, /* 0x0E .. 0x0F */
3428 "shift", /* VK_SHIFT 0x10 */
3429 "control", /* VK_CONTROL 0x11 */
3430 "menu", /* VK_MENU 0x12 */
3431 "pause", /* VK_PAUSE 0x13 */
3432 "capital", /* VK_CAPITAL 0x14 */
3434 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3436 0, /* VK_ESCAPE 0x1B */
3438 0, 0, 0, 0, /* 0x1C .. 0x1F */
3440 0, /* VK_SPACE 0x20 */
3441 "prior", /* VK_PRIOR 0x21 */
3442 "next", /* VK_NEXT 0x22 */
3443 "end", /* VK_END 0x23 */
3444 "home", /* VK_HOME 0x24 */
3445 "left", /* VK_LEFT 0x25 */
3446 "up", /* VK_UP 0x26 */
3447 "right", /* VK_RIGHT 0x27 */
3448 "down", /* VK_DOWN 0x28 */
3449 "select", /* VK_SELECT 0x29 */
3450 "print", /* VK_PRINT 0x2A */
3451 "execute", /* VK_EXECUTE 0x2B */
3452 "snapshot", /* VK_SNAPSHOT 0x2C */
3453 "insert", /* VK_INSERT 0x2D */
3454 "delete", /* VK_DELETE 0x2E */
3455 "help", /* VK_HELP 0x2F */
3457 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3459 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3461 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3463 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3465 0, 0, 0, 0, 0, 0, 0, 0, 0,
3466 0, 0, 0, 0, 0, 0, 0, 0, 0,
3467 0, 0, 0, 0, 0, 0, 0, 0,
3469 "lwindow", /* VK_LWIN 0x5B */
3470 "rwindow", /* VK_RWIN 0x5C */
3471 "apps", /* VK_APPS 0x5D */
3473 0, 0, /* 0x5E .. 0x5F */
3475 "kp-0", /* VK_NUMPAD0 0x60 */
3476 "kp-1", /* VK_NUMPAD1 0x61 */
3477 "kp-2", /* VK_NUMPAD2 0x62 */
3478 "kp-3", /* VK_NUMPAD3 0x63 */
3479 "kp-4", /* VK_NUMPAD4 0x64 */
3480 "kp-5", /* VK_NUMPAD5 0x65 */
3481 "kp-6", /* VK_NUMPAD6 0x66 */
3482 "kp-7", /* VK_NUMPAD7 0x67 */
3483 "kp-8", /* VK_NUMPAD8 0x68 */
3484 "kp-9", /* VK_NUMPAD9 0x69 */
3485 "kp-multiply", /* VK_MULTIPLY 0x6A */
3486 "kp-add", /* VK_ADD 0x6B */
3487 "kp-separator", /* VK_SEPARATOR 0x6C */
3488 "kp-subtract", /* VK_SUBTRACT 0x6D */
3489 "kp-decimal", /* VK_DECIMAL 0x6E */
3490 "kp-divide", /* VK_DIVIDE 0x6F */
3491 "f1", /* VK_F1 0x70 */
3492 "f2", /* VK_F2 0x71 */
3493 "f3", /* VK_F3 0x72 */
3494 "f4", /* VK_F4 0x73 */
3495 "f5", /* VK_F5 0x74 */
3496 "f6", /* VK_F6 0x75 */
3497 "f7", /* VK_F7 0x76 */
3498 "f8", /* VK_F8 0x77 */
3499 "f9", /* VK_F9 0x78 */
3500 "f10", /* VK_F10 0x79 */
3501 "f11", /* VK_F11 0x7A */
3502 "f12", /* VK_F12 0x7B */
3503 "f13", /* VK_F13 0x7C */
3504 "f14", /* VK_F14 0x7D */
3505 "f15", /* VK_F15 0x7E */
3506 "f16", /* VK_F16 0x7F */
3507 "f17", /* VK_F17 0x80 */
3508 "f18", /* VK_F18 0x81 */
3509 "f19", /* VK_F19 0x82 */
3510 "f20", /* VK_F20 0x83 */
3511 "f21", /* VK_F21 0x84 */
3512 "f22", /* VK_F22 0x85 */
3513 "f23", /* VK_F23 0x86 */
3514 "f24", /* VK_F24 0x87 */
3516 0, 0, 0, 0, /* 0x88 .. 0x8B */
3517 0, 0, 0, 0, /* 0x8C .. 0x8F */
3519 "kp-numlock", /* VK_NUMLOCK 0x90 */
3520 "scroll", /* VK_SCROLL 0x91 */
3522 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3523 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3524 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3525 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3526 "kp-end", /* VK_NUMPAD_END 0x96 */
3527 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3528 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3529 "kp-up", /* VK_NUMPAD_UP 0x99 */
3530 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3531 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3532 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3533 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3535 0, 0, /* 0x9E .. 0x9F */
3538 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3539 * Used only as parameters to GetAsyncKeyState and GetKeyState.
3540 * No other API or message will distinguish left and right keys this way.
3544 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3545 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3546 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3547 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3548 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3554 "attn", /* VK_ATTN 0xF6 */
3555 "crsel", /* VK_CRSEL 0xF7 */
3556 "exsel", /* VK_EXSEL 0xF8 */
3557 "ereof", /* VK_EREOF 0xF9 */
3558 "play", /* VK_PLAY 0xFA */
3559 "zoom", /* VK_ZOOM 0xFB */
3560 "noname", /* VK_NONAME 0xFC */
3561 "pa1", /* VK_PA1 0xFD */
3562 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3565 #else /* not HAVE_NTGUI */
3568 static char *lispy_kana_keys
[] =
3570 /* X Keysym value */
3571 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3572 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3573 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3574 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3575 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3576 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3577 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3578 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3579 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3580 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3581 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3582 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3583 "kana-i", "kana-u", "kana-e", "kana-o",
3584 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3585 "prolongedsound", "kana-A", "kana-I", "kana-U",
3586 "kana-E", "kana-O", "kana-KA", "kana-KI",
3587 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3588 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3589 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3590 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3591 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3592 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3593 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3594 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3595 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3596 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3597 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3598 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3600 #endif /* XK_kana_A */
3602 #define FUNCTION_KEY_OFFSET 0xff00
3604 /* You'll notice that this table is arranged to be conveniently
3605 indexed by X Windows keysym values. */
3606 static char *lispy_function_keys
[] =
3608 /* X Keysym value */
3610 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3618 0, 0, 0, /* 0xff10 */
3620 0, 0, 0, 0, 0, 0, 0,
3623 0, "kanji", "muhenkan",
3624 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3625 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3626 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3628 "home", /* 0xff50 */ /* IsCursorKey */
3639 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3650 "break", /* 0xff6b */
3652 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3654 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3655 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3656 0, 0, 0, 0, 0, 0, 0, 0,
3657 "kp-tab", /* 0xff89 */
3659 "kp-enter", /* 0xff8d */
3661 "kp-f1", /* 0xff91 */
3665 "kp-home", /* 0xff95 */
3670 "kp-prior", /* kp-page-up */
3671 "kp-next", /* kp-page-down */
3677 0, 0, 0, 0, 0, 0, 0, 0, 0,
3678 "kp-multiply", /* 0xffaa */
3683 "kp-divide", /* 0xffaf */
3684 "kp-0", /* 0xffb0 */
3685 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3688 "kp-equal", /* 0xffbd */
3689 "f1", /* 0xffbe */ /* IsFunctionKey */
3691 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3692 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3693 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3694 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3695 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3696 0, 0, 0, 0, 0, 0, 0, 0,
3697 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3698 0, 0, 0, 0, 0, 0, 0, "delete"
3701 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3702 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3704 static char *iso_lispy_function_keys
[] =
3706 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3707 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3708 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3709 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3710 "iso-lefttab", /* 0xfe20 */
3711 "iso-move-line-up", "iso-move-line-down",
3712 "iso-partial-line-up", "iso-partial-line-down",
3713 "iso-partial-space-left", "iso-partial-space-right",
3714 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3715 "iso-release-margin-left", "iso-release-margin-right",
3716 "iso-release-both-margins",
3717 "iso-fast-cursor-left", "iso-fast-cursor-right",
3718 "iso-fast-cursor-up", "iso-fast-cursor-down",
3719 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3720 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3723 #endif /* not HAVE_NTGUI */
3725 static char *lispy_mouse_names
[] =
3727 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3731 /* mouse-wheel events are generated by the wheel on devices such as
3732 the MS Intellimouse. The wheel sits in between the left and right
3733 mouse buttons, and is typically used to scroll or zoom the window
3734 underneath the pointer. mouse-wheel events specify the object on
3735 which they operate, and a delta corresponding to the amount and
3736 direction that the wheel is rotated. Clicking the mouse-wheel
3737 generates a mouse-2 event. */
3738 static char *lispy_mouse_wheel_names
[] =
3743 #endif /* WINDOWSNT */
3745 /* drag-n-drop events are generated when a set of selected files are
3746 dragged from another application and dropped onto an Emacs window. */
3747 static char *lispy_drag_n_drop_names
[] =
3752 /* Scroll bar parts. */
3753 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3754 Lisp_Object Qup
, Qdown
;
3756 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3757 Lisp_Object
*scroll_bar_parts
[] = {
3758 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3763 /* A vector, indexed by button number, giving the down-going location
3764 of currently depressed buttons, both scroll bar and non-scroll bar.
3766 The elements have the form
3767 (BUTTON-NUMBER MODIFIER-MASK . REST)
3768 where REST is the cdr of a position as it would be reported in the event.
3770 The make_lispy_event function stores positions here to tell the
3771 difference between click and drag events, and to store the starting
3772 location to be included in drag events. */
3774 static Lisp_Object button_down_location
;
3776 /* Information about the most recent up-going button event: Which
3777 button, what location, and what time. */
3779 static int last_mouse_button
;
3780 static int last_mouse_x
;
3781 static int last_mouse_y
;
3782 static unsigned long button_down_time
;
3784 /* The maximum time between clicks to make a double-click,
3785 or Qnil to disable double-click detection,
3786 or Qt for no time limit. */
3787 Lisp_Object Vdouble_click_time
;
3789 /* The number of clicks in this multiple-click. */
3791 int double_click_count
;
3793 /* Given a struct input_event, build the lisp event which represents
3794 it. If EVENT is 0, build a mouse movement event from the mouse
3795 movement buffer, which should have a movement event in it.
3797 Note that events must be passed to this function in the order they
3798 are received; this function stores the location of button presses
3799 in order to build drag events when the button is released. */
3802 make_lispy_event (event
)
3803 struct input_event
*event
;
3807 switch (SWITCH_ENUM_CAST (event
->kind
))
3809 /* A simple keystroke. */
3810 case ascii_keystroke
:
3812 Lisp_Object lispy_c
;
3813 int c
= event
->code
& 0377;
3814 /* Turn ASCII characters into control characters
3816 if (event
->modifiers
& ctrl_modifier
)
3817 c
= make_ctrl_char (c
);
3819 /* Add in the other modifier bits. We took care of ctrl_modifier
3820 just above, and the shift key was taken care of by the X code,
3821 and applied to control characters by make_ctrl_char. */
3822 c
|= (event
->modifiers
3823 & (meta_modifier
| alt_modifier
3824 | hyper_modifier
| super_modifier
));
3825 /* Distinguish Shift-SPC from SPC. */
3826 if ((event
->code
& 0377) == 040
3827 && event
->modifiers
& shift_modifier
)
3828 c
|= shift_modifier
;
3829 button_down_time
= 0;
3830 XSETFASTINT (lispy_c
, c
);
3834 /* A function key. The symbol may need to have modifier prefixes
3836 case non_ascii_keystroke
:
3837 button_down_time
= 0;
3839 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3840 if (event
->code
== lispy_accent_codes
[i
])
3841 return modify_event_symbol (i
,
3843 Qfunction_key
, Qnil
,
3844 lispy_accent_keys
, &accent_key_syms
,
3845 (sizeof (lispy_accent_keys
)
3846 / sizeof (lispy_accent_keys
[0])));
3848 /* Handle system-specific keysyms. */
3849 if (event
->code
& (1 << 28))
3851 /* We need to use an alist rather than a vector as the cache
3852 since we can't make a vector long enuf. */
3853 if (NILP (current_kboard
->system_key_syms
))
3854 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3855 return modify_event_symbol (event
->code
,
3858 current_kboard
->Vsystem_key_alist
,
3859 0, ¤t_kboard
->system_key_syms
,
3864 if (event
->code
>= 0x400 && event
->code
< 0x500)
3865 return modify_event_symbol (event
->code
- 0x400,
3866 event
->modifiers
& ~shift_modifier
,
3867 Qfunction_key
, Qnil
,
3868 lispy_kana_keys
, &func_key_syms
,
3869 (sizeof (lispy_kana_keys
)
3870 / sizeof (lispy_kana_keys
[0])));
3871 #endif /* XK_kana_A */
3873 #ifdef ISO_FUNCTION_KEY_OFFSET
3874 if (event
->code
< FUNCTION_KEY_OFFSET
3875 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3876 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3878 Qfunction_key
, Qnil
,
3879 iso_lispy_function_keys
, &func_key_syms
,
3880 (sizeof (iso_lispy_function_keys
)
3881 / sizeof (iso_lispy_function_keys
[0])));
3884 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3886 Qfunction_key
, Qnil
,
3887 lispy_function_keys
, &func_key_syms
,
3888 (sizeof (lispy_function_keys
)
3889 / sizeof (lispy_function_keys
[0])));
3892 /* A mouse click. Figure out where it is, decide whether it's
3893 a press, click or drag, and build the appropriate structure. */
3895 case scroll_bar_click
:
3897 int button
= event
->code
;
3899 Lisp_Object position
;
3900 Lisp_Object
*start_pos_ptr
;
3901 Lisp_Object start_pos
;
3903 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3906 /* Build the position as appropriate for this mouse click. */
3907 if (event
->kind
== mouse_click
)
3910 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3915 /* Ignore mouse events that were made on frame that
3916 have been deleted. */
3917 if (! FRAME_LIVE_P (f
))
3920 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3921 &column
, &row
, NULL
, 1);
3923 #ifndef USE_X_TOOLKIT
3924 /* In the non-toolkit version, clicks on the menu bar
3925 are ordinary button events in the event buffer.
3926 Distinguish them, and invoke the menu.
3928 (In the toolkit version, the toolkit handles the menu bar
3929 and Emacs doesn't know about it until after the user
3930 makes a selection.) */
3931 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3932 && (event
->modifiers
& down_modifier
))
3934 Lisp_Object items
, item
;
3939 /* Activate the menu bar on the down event. If the
3940 up event comes in before the menu code can deal with it,
3942 if (! (event
->modifiers
& down_modifier
))
3947 items
= FRAME_MENU_BAR_ITEMS (f
);
3948 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3950 Lisp_Object pos
, string
;
3951 string
= XVECTOR (items
)->contents
[i
+ 1];
3952 pos
= XVECTOR (items
)->contents
[i
+ 3];
3955 if (column
>= XINT (pos
)
3956 && column
< XINT (pos
) + XSTRING (string
)->size
)
3958 item
= XVECTOR (items
)->contents
[i
];
3964 = Fcons (event
->frame_or_window
,
3966 Fcons (Fcons (event
->x
, event
->y
),
3967 Fcons (make_number (event
->timestamp
),
3970 return Fcons (item
, Fcons (position
, Qnil
));
3972 #endif /* not USE_X_TOOLKIT */
3974 window
= window_from_coordinates (f
, column
, row
, &part
);
3976 if (!WINDOWP (window
))
3978 window
= event
->frame_or_window
;
3983 int pixcolumn
, pixrow
;
3984 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3985 row
-= XINT (XWINDOW (window
)->top
);
3986 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3987 XSETINT (event
->x
, pixcolumn
);
3988 XSETINT (event
->y
, pixrow
);
3993 posn
= Qvertical_line
;
3996 buffer_posn_from_coords (XWINDOW (window
),
4003 Fcons (Fcons (event
->x
, event
->y
),
4004 Fcons (make_number (event
->timestamp
),
4010 Lisp_Object portion_whole
;
4013 window
= event
->frame_or_window
;
4014 portion_whole
= Fcons (event
->x
, event
->y
);
4015 part
= *scroll_bar_parts
[(int) event
->part
];
4019 Fcons (Qvertical_scroll_bar
,
4020 Fcons (portion_whole
,
4021 Fcons (make_number (event
->timestamp
),
4022 Fcons (part
, Qnil
)))));
4025 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
4027 start_pos
= *start_pos_ptr
;
4028 *start_pos_ptr
= Qnil
;
4030 is_double
= (button
== last_mouse_button
4031 && XINT (event
->x
) == last_mouse_x
4032 && XINT (event
->y
) == last_mouse_y
4033 && button_down_time
!= 0
4034 && (EQ (Vdouble_click_time
, Qt
)
4035 || (INTEGERP (Vdouble_click_time
)
4036 && ((int)(event
->timestamp
- button_down_time
)
4037 < XINT (Vdouble_click_time
)))));
4038 last_mouse_button
= button
;
4039 last_mouse_x
= XINT (event
->x
);
4040 last_mouse_y
= XINT (event
->y
);
4042 /* If this is a button press, squirrel away the location, so
4043 we can decide later whether it was a click or a drag. */
4044 if (event
->modifiers
& down_modifier
)
4048 double_click_count
++;
4049 event
->modifiers
|= ((double_click_count
> 2)
4054 double_click_count
= 1;
4055 button_down_time
= event
->timestamp
;
4056 *start_pos_ptr
= Fcopy_alist (position
);
4059 /* Now we're releasing a button - check the co-ordinates to
4060 see if this was a click or a drag. */
4061 else if (event
->modifiers
& up_modifier
)
4063 /* If we did not see a down before this up,
4064 ignore the up. Probably this happened because
4065 the down event chose a menu item.
4066 It would be an annoyance to treat the release
4067 of the button that chose the menu item
4068 as a separate event. */
4070 if (!CONSP (start_pos
))
4073 event
->modifiers
&= ~up_modifier
;
4074 #if 0 /* Formerly we treated an up with no down as a click event. */
4075 if (!CONSP (start_pos
))
4076 event
->modifiers
|= click_modifier
;
4080 /* The third element of every position should be the (x,y)
4084 down
= Fnth (make_number (2), start_pos
);
4085 if (EQ (event
->x
, XCONS (down
)->car
)
4086 && EQ (event
->y
, XCONS (down
)->cdr
))
4088 event
->modifiers
|= click_modifier
;
4092 button_down_time
= 0;
4093 event
->modifiers
|= drag_modifier
;
4095 /* Don't check is_double; treat this as multiple
4096 if the down-event was multiple. */
4097 if (double_click_count
> 1)
4098 event
->modifiers
|= ((double_click_count
> 2)
4104 /* Every mouse event should either have the down_modifier or
4105 the up_modifier set. */
4109 /* Get the symbol we should use for the mouse click. */
4112 head
= modify_event_symbol (button
,
4115 lispy_mouse_names
, &mouse_syms
,
4116 (sizeof (lispy_mouse_names
)
4117 / sizeof (lispy_mouse_names
[0])));
4118 if (event
->modifiers
& drag_modifier
)
4123 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4126 Fcons (make_number (double_click_count
),
4136 case w32_scroll_bar_click
:
4138 int button
= event
->code
;
4140 Lisp_Object position
;
4141 Lisp_Object
*start_pos_ptr
;
4142 Lisp_Object start_pos
;
4144 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4149 Lisp_Object portion_whole
;
4152 window
= event
->frame_or_window
;
4153 portion_whole
= Fcons (event
->x
, event
->y
);
4154 part
= *scroll_bar_parts
[(int) event
->part
];
4158 Fcons (Qvertical_scroll_bar
,
4159 Fcons (portion_whole
,
4160 Fcons (make_number (event
->timestamp
),
4161 Fcons (part
, Qnil
)))));
4164 /* Always treat W32 scroll bar events as clicks. */
4165 event
->modifiers
|= click_modifier
;
4168 /* Get the symbol we should use for the mouse click. */
4171 head
= modify_event_symbol (button
,
4174 lispy_mouse_names
, &mouse_syms
,
4175 (sizeof (lispy_mouse_names
)
4176 / sizeof (lispy_mouse_names
[0])));
4185 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4188 Lisp_Object head
, position
;
4191 /* Ignore mouse events that were made on frame that
4192 have been deleted. */
4193 if (! FRAME_LIVE_P (f
))
4195 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4196 &column
, &row
, NULL
, 1);
4197 window
= window_from_coordinates (f
, column
, row
, &part
);
4199 if (!WINDOWP (window
))
4201 window
= event
->frame_or_window
;
4206 int pixcolumn
, pixrow
;
4207 column
-= XINT (XWINDOW (window
)->left
);
4208 row
-= XINT (XWINDOW (window
)->top
);
4209 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4210 XSETINT (event
->x
, pixcolumn
);
4211 XSETINT (event
->y
, pixrow
);
4216 posn
= Qvertical_line
;
4219 buffer_posn_from_coords (XWINDOW (window
),
4224 Lisp_Object head
, position
;
4229 Fcons (Fcons (event
->x
, event
->y
),
4230 Fcons (make_number (event
->timestamp
),
4233 head
= modify_event_symbol (0, event
->modifiers
,
4235 lispy_mouse_wheel_names
,
4236 &mouse_wheel_syms
, 1);
4239 Fcons (make_number (event
->code
),
4243 #endif /* WINDOWSNT */
4251 Lisp_Object head
, position
;
4255 /* The frame_or_window field should be a cons of the frame in
4256 which the event occurred and a list of the filenames
4258 if (! CONSP (event
->frame_or_window
))
4261 f
= XFRAME (XCONS (event
->frame_or_window
)->car
);
4262 files
= XCONS (event
->frame_or_window
)->cdr
;
4264 /* Ignore mouse events that were made on frames that
4265 have been deleted. */
4266 if (! FRAME_LIVE_P (f
))
4268 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4269 &column
, &row
, NULL
, 1);
4270 window
= window_from_coordinates (f
, column
, row
, &part
);
4272 if (!WINDOWP (window
))
4274 window
= XCONS (event
->frame_or_window
)->car
;
4279 int pixcolumn
, pixrow
;
4280 column
-= XINT (XWINDOW (window
)->left
);
4281 row
-= XINT (XWINDOW (window
)->top
);
4282 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4283 XSETINT (event
->x
, pixcolumn
);
4284 XSETINT (event
->y
, pixrow
);
4289 posn
= Qvertical_line
;
4292 buffer_posn_from_coords (XWINDOW (window
),
4297 Lisp_Object head
, position
;
4302 Fcons (Fcons (event
->x
, event
->y
),
4303 Fcons (make_number (event
->timestamp
),
4306 head
= modify_event_symbol (0, event
->modifiers
,
4308 lispy_drag_n_drop_names
,
4309 &drag_n_drop_syms
, 1);
4316 #endif /* HAVE_MOUSE */
4318 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4319 case menu_bar_event
:
4320 /* The event value is in the cdr of the frame_or_window slot. */
4321 if (!CONSP (event
->frame_or_window
))
4323 return XCONS (event
->frame_or_window
)->cdr
;
4326 /* The 'kind' field of the event is something we don't recognize. */
4335 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4337 Lisp_Object bar_window
;
4338 enum scroll_bar_part part
;
4342 /* Is it a scroll bar movement? */
4343 if (frame
&& ! NILP (bar_window
))
4345 Lisp_Object part_sym
;
4347 part_sym
= *scroll_bar_parts
[(int) part
];
4348 return Fcons (Qscroll_bar_movement
,
4349 (Fcons (Fcons (bar_window
,
4350 Fcons (Qvertical_scroll_bar
,
4351 Fcons (Fcons (x
, y
),
4352 Fcons (make_number (time
),
4358 /* Or is it an ordinary mouse movement? */
4368 /* It's in a frame; which window on that frame? */
4369 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4371 window
= window_from_coordinates (frame
, column
, row
, &area
);
4376 if (WINDOWP (window
))
4378 int pixcolumn
, pixrow
;
4379 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4380 row
-= XINT (XWINDOW (window
)->top
);
4381 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4382 XSETINT (x
, pixcolumn
);
4383 XSETINT (y
, pixrow
);
4388 posn
= Qvertical_line
;
4391 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4393 else if (frame
!= 0)
4395 XSETFRAME (window
, frame
);
4406 return Fcons (Qmouse_movement
,
4407 Fcons (Fcons (window
,
4409 Fcons (Fcons (x
, y
),
4410 Fcons (make_number (time
),
4416 #endif /* HAVE_MOUSE */
4418 /* Construct a switch frame event. */
4420 make_lispy_switch_frame (frame
)
4423 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4426 /* Manipulating modifiers. */
4428 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4430 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4431 SYMBOL's name of the end of the modifiers; the string from this
4432 position is the unmodified symbol name.
4434 This doesn't use any caches. */
4437 parse_modifiers_uncached (symbol
, modifier_end
)
4441 struct Lisp_String
*name
;
4445 CHECK_SYMBOL (symbol
, 1);
4448 name
= XSYMBOL (symbol
)->name
;
4450 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
4452 int this_mod_end
= 0;
4455 /* See if the name continues with a modifier word.
4456 Check that the word appears, but don't check what follows it.
4457 Set this_mod and this_mod_end to record what we find. */
4459 switch (name
->data
[i
])
4461 #define SINGLE_LETTER_MOD(BIT) \
4462 (this_mod_end = i + 1, this_mod = BIT)
4465 SINGLE_LETTER_MOD (alt_modifier
);
4469 SINGLE_LETTER_MOD (ctrl_modifier
);
4473 SINGLE_LETTER_MOD (hyper_modifier
);
4477 SINGLE_LETTER_MOD (meta_modifier
);
4481 SINGLE_LETTER_MOD (shift_modifier
);
4485 SINGLE_LETTER_MOD (super_modifier
);
4488 #undef SINGLE_LETTER_MOD
4491 /* If we found no modifier, stop looking for them. */
4492 if (this_mod_end
== 0)
4495 /* Check there is a dash after the modifier, so that it
4496 really is a modifier. */
4497 if (this_mod_end
>= STRING_BYTES (name
)
4498 || name
->data
[this_mod_end
] != '-')
4501 /* This modifier is real; look for another. */
4502 modifiers
|= this_mod
;
4503 i
= this_mod_end
+ 1;
4506 /* Should we include the `click' modifier? */
4507 if (! (modifiers
& (down_modifier
| drag_modifier
4508 | double_modifier
| triple_modifier
))
4509 && i
+ 7 == STRING_BYTES (name
)
4510 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4511 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4512 modifiers
|= click_modifier
;
4520 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4521 prepended to the string BASE[0..BASE_LEN-1].
4522 This doesn't use any caches. */
4524 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
4527 int base_len
, base_len_byte
;
4529 /* Since BASE could contain nulls, we can't use intern here; we have
4530 to use Fintern, which expects a genuine Lisp_String, and keeps a
4533 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4539 /* Only the event queue may use the `up' modifier; it should always
4540 be turned into a click or drag event before presented to lisp code. */
4541 if (modifiers
& up_modifier
)
4544 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4545 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4546 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4547 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4548 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4549 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4550 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4551 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4552 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4553 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4554 /* The click modifier is denoted by the absence of other modifiers. */
4558 mod_len
= p
- new_mods
;
4562 Lisp_Object new_name
;
4564 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
4565 mod_len
+ base_len_byte
);
4566 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4567 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
4569 return Fintern (new_name
, Qnil
);
4574 static char *modifier_names
[] =
4576 "up", "down", "drag", "click", "double", "triple", 0, 0,
4577 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4578 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4580 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4582 static Lisp_Object modifier_symbols
;
4584 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4586 lispy_modifier_list (modifiers
)
4589 Lisp_Object modifier_list
;
4592 modifier_list
= Qnil
;
4593 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4594 if (modifiers
& (1<<i
))
4595 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4598 return modifier_list
;
4602 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4603 where UNMODIFIED is the unmodified form of SYMBOL,
4604 MASK is the set of modifiers present in SYMBOL's name.
4605 This is similar to parse_modifiers_uncached, but uses the cache in
4606 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4607 Qevent_symbol_elements property. */
4610 parse_modifiers (symbol
)
4613 Lisp_Object elements
;
4615 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4616 if (CONSP (elements
))
4621 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4622 Lisp_Object unmodified
;
4625 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4626 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
4629 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4631 XSETFASTINT (mask
, modifiers
);
4632 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4634 /* Cache the parsing results on SYMBOL. */
4635 Fput (symbol
, Qevent_symbol_element_mask
,
4637 Fput (symbol
, Qevent_symbol_elements
,
4638 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4640 /* Since we know that SYMBOL is modifiers applied to unmodified,
4641 it would be nice to put that in unmodified's cache.
4642 But we can't, since we're not sure that parse_modifiers is
4649 /* Apply the modifiers MODIFIERS to the symbol BASE.
4650 BASE must be unmodified.
4652 This is like apply_modifiers_uncached, but uses BASE's
4653 Qmodifier_cache property, if present. It also builds
4654 Qevent_symbol_elements properties, since it has that info anyway.
4656 apply_modifiers copies the value of BASE's Qevent_kind property to
4657 the modified symbol. */
4659 apply_modifiers (modifiers
, base
)
4663 Lisp_Object cache
, index
, entry
, new_symbol
;
4665 /* Mask out upper bits. We don't know where this value's been. */
4666 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4668 /* The click modifier never figures into cache indices. */
4669 cache
= Fget (base
, Qmodifier_cache
);
4670 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4671 entry
= assq_no_quit (index
, cache
);
4674 new_symbol
= XCONS (entry
)->cdr
;
4677 /* We have to create the symbol ourselves. */
4678 new_symbol
= apply_modifiers_uncached (modifiers
,
4679 XSYMBOL (base
)->name
->data
,
4680 XSYMBOL (base
)->name
->size
,
4681 STRING_BYTES (XSYMBOL (base
)->name
));
4683 /* Add the new symbol to the base's cache. */
4684 entry
= Fcons (index
, new_symbol
);
4685 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4687 /* We have the parsing info now for free, so add it to the caches. */
4688 XSETFASTINT (index
, modifiers
);
4689 Fput (new_symbol
, Qevent_symbol_element_mask
,
4690 Fcons (base
, Fcons (index
, Qnil
)));
4691 Fput (new_symbol
, Qevent_symbol_elements
,
4692 Fcons (base
, lispy_modifier_list (modifiers
)));
4695 /* Make sure this symbol is of the same kind as BASE.
4697 You'd think we could just set this once and for all when we
4698 intern the symbol above, but reorder_modifiers may call us when
4699 BASE's property isn't set right; we can't assume that just
4700 because it has a Qmodifier_cache property it must have its
4701 Qevent_kind set right as well. */
4702 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4706 kind
= Fget (base
, Qevent_kind
);
4708 Fput (new_symbol
, Qevent_kind
, kind
);
4715 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4716 return a symbol with the modifiers placed in the canonical order.
4717 Canonical order is alphabetical, except for down and drag, which
4718 always come last. The 'click' modifier is never written out.
4720 Fdefine_key calls this to make sure that (for example) C-M-foo
4721 and M-C-foo end up being equivalent in the keymap. */
4724 reorder_modifiers (symbol
)
4727 /* It's hopefully okay to write the code this way, since everything
4728 will soon be in caches, and no consing will be done at all. */
4731 parsed
= parse_modifiers (symbol
);
4732 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4733 XCONS (parsed
)->car
);
4737 /* For handling events, we often want to produce a symbol whose name
4738 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4739 to some base, like the name of a function key or mouse button.
4740 modify_event_symbol produces symbols of this sort.
4742 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4743 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4746 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4747 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4749 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4750 persist between calls to modify_event_symbol that it can use to
4751 store a cache of the symbols it's generated for this NAME_TABLE
4752 before. The object stored there may be a vector or an alist.
4754 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4756 MODIFIERS is a set of modifier bits (as given in struct input_events)
4757 whose prefixes should be applied to the symbol name.
4759 SYMBOL_KIND is the value to be placed in the event_kind property of
4760 the returned symbol.
4762 The symbols we create are supposed to have an
4763 `event-symbol-elements' property, which lists the modifiers present
4764 in the symbol's name. */
4767 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4768 name_table
, symbol_table
, table_size
)
4771 Lisp_Object symbol_kind
;
4772 Lisp_Object name_alist
;
4774 Lisp_Object
*symbol_table
;
4775 unsigned int table_size
;
4778 Lisp_Object symbol_int
;
4780 /* Get rid of the "vendor-specific" bit here. */
4781 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4783 /* Is this a request for a valid symbol? */
4784 if (symbol_num
< 0 || symbol_num
>= table_size
)
4787 if (CONSP (*symbol_table
))
4788 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4790 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4791 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4792 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4793 we've never used that symbol before. */
4796 if (! VECTORP (*symbol_table
)
4797 || XVECTOR (*symbol_table
)->size
!= table_size
)
4801 XSETFASTINT (size
, table_size
);
4802 *symbol_table
= Fmake_vector (size
, Qnil
);
4805 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4808 /* Have we already used this symbol before? */
4811 /* No; let's create it. */
4812 if (!NILP (name_alist
))
4813 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4814 else if (name_table
!= 0 && name_table
[symbol_num
])
4815 value
= intern (name_table
[symbol_num
]);
4817 #ifdef HAVE_WINDOW_SYSTEM
4820 char *name
= x_get_keysym_name (symbol_num
);
4822 value
= intern (name
);
4829 sprintf (buf
, "key-%d", symbol_num
);
4830 value
= intern (buf
);
4833 if (CONSP (*symbol_table
))
4834 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4836 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4838 /* Fill in the cache entries for this symbol; this also
4839 builds the Qevent_symbol_elements property, which the user
4841 apply_modifiers (modifiers
& click_modifier
, value
);
4842 Fput (value
, Qevent_kind
, symbol_kind
);
4845 /* Apply modifiers to that symbol. */
4846 return apply_modifiers (modifiers
, value
);
4849 /* Convert a list that represents an event type,
4850 such as (ctrl meta backspace), into the usual representation of that
4851 event type as a number or a symbol. */
4853 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4854 "Convert the event description list EVENT-DESC to an event type.\n\
4855 EVENT-DESC should contain one base event type (a character or symbol)\n\
4856 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4857 drag, down, double or triple). The base must be last.\n\
4858 The return value is an event type (a character or symbol) which\n\
4859 has the same base event type and all the specified modifiers.")
4861 Lisp_Object event_desc
;
4869 while (CONSP (rest
))
4874 elt
= XCONS (rest
)->car
;
4875 rest
= XCONS (rest
)->cdr
;
4877 /* Given a symbol, see if it is a modifier name. */
4878 if (SYMBOLP (elt
) && CONSP (rest
))
4879 this = parse_solitary_modifier (elt
);
4883 else if (!NILP (base
))
4884 error ("Two bases given in one event");
4890 /* Let the symbol A refer to the character A. */
4891 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4892 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4894 if (INTEGERP (base
))
4896 /* Turn (shift a) into A. */
4897 if ((modifiers
& shift_modifier
) != 0
4898 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4900 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4901 modifiers
&= ~shift_modifier
;
4904 /* Turn (control a) into C-a. */
4905 if (modifiers
& ctrl_modifier
)
4906 return make_number ((modifiers
& ~ctrl_modifier
)
4907 | make_ctrl_char (XINT (base
)));
4909 return make_number (modifiers
| XINT (base
));
4911 else if (SYMBOLP (base
))
4912 return apply_modifiers (modifiers
, base
);
4914 error ("Invalid base event");
4917 /* Try to recognize SYMBOL as a modifier name.
4918 Return the modifier flag bit, or 0 if not recognized. */
4921 parse_solitary_modifier (symbol
)
4924 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4926 switch (name
->data
[0])
4928 #define SINGLE_LETTER_MOD(BIT) \
4929 if (STRING_BYTES (name) == 1) \
4932 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4933 if (LEN == STRING_BYTES (name) \
4934 && ! strncmp (name->data, NAME, LEN)) \
4938 SINGLE_LETTER_MOD (alt_modifier
);
4942 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4946 SINGLE_LETTER_MOD (ctrl_modifier
);
4950 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4951 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4955 SINGLE_LETTER_MOD (hyper_modifier
);
4959 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4963 SINGLE_LETTER_MOD (meta_modifier
);
4967 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4971 SINGLE_LETTER_MOD (shift_modifier
);
4975 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4976 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4977 SINGLE_LETTER_MOD (super_modifier
);
4981 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4982 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4983 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4987 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4990 #undef SINGLE_LETTER_MOD
4991 #undef MULTI_LETTER_MOD
4997 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4998 Such a list is not valid as an event,
4999 but it can be a Lucid-style event type list. */
5002 lucid_event_type_list_p (object
)
5007 if (! CONSP (object
))
5010 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5013 elt
= XCONS (tail
)->car
;
5014 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5021 /* Store into *addr a value nonzero if terminal input chars are available.
5022 Serves the purpose of ioctl (0, FIONREAD, addr)
5023 but works even if FIONREAD does not exist.
5024 (In fact, this may actually read some input.)
5026 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5029 get_input_pending (addr
, do_timers_now
)
5033 /* First of all, have we already counted some input? */
5034 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5036 /* If input is being read as it arrives, and we have none, there is none. */
5037 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5040 /* Try to read some input and see how much we get. */
5042 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5045 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5048 gobble_input (expected
)
5053 if (interrupt_input
)
5056 mask
= sigblock (sigmask (SIGIO
));
5057 read_avail_input (expected
);
5061 #ifdef POLL_FOR_INPUT
5062 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5065 mask
= sigblock (sigmask (SIGALRM
));
5066 read_avail_input (expected
);
5072 read_avail_input (expected
);
5076 /* Put a buffer_switch_event in the buffer
5077 so that read_key_sequence will notice the new current buffer. */
5080 record_asynch_buffer_change ()
5082 struct input_event event
;
5085 event
.kind
= buffer_switch_event
;
5086 event
.frame_or_window
= Qnil
;
5089 /* We don't need a buffer-switch event unless Emacs is waiting for input.
5090 The purpose of the event is to make read_key_sequence look up the
5091 keymaps again. If we aren't in read_key_sequence, we don't need one,
5092 and the event could cause trouble by messing up (input-pending-p). */
5093 tem
= Fwaiting_for_user_input_p ();
5097 /* We never need these events if we have no asynchronous subprocesses. */
5101 /* Make sure no interrupt happens while storing the event. */
5103 if (interrupt_input
)
5106 mask
= sigblock (sigmask (SIGIO
));
5107 kbd_buffer_store_event (&event
);
5114 kbd_buffer_store_event (&event
);
5121 /* Read any terminal input already buffered up by the system
5122 into the kbd_buffer, but do not wait.
5124 EXPECTED should be nonzero if the caller knows there is some input.
5126 Except on VMS, all input is read by this function.
5127 If interrupt_input is nonzero, this function MUST be called
5128 only when SIGIO is blocked.
5130 Returns the number of keyboard chars read, or -1 meaning
5131 this is a bad time to try to read input. */
5134 read_avail_input (expected
)
5137 struct input_event buf
[KBD_BUFFER_SIZE
];
5141 if (read_socket_hook
)
5142 /* No need for FIONREAD or fcntl; just say don't wait. */
5143 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5146 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5147 the kbd_buffer can really hold. That may prevent loss
5148 of characters on some systems when input is stuffed at us. */
5149 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5152 /* Determine how many characters we should *try* to read. */
5155 #else /* not WINDOWSNT */
5157 n_to_read
= dos_keysns ();
5160 #else /* not MSDOS */
5162 /* Find out how much input is available. */
5163 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5164 /* Formerly simply reported no input, but that sometimes led to
5165 a failure of Emacs to terminate.
5166 SIGHUP seems appropriate if we can't reach the terminal. */
5167 /* ??? Is it really right to send the signal just to this process
5168 rather than to the whole process group?
5169 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5170 kill (getpid (), SIGHUP
);
5173 if (n_to_read
> sizeof cbuf
)
5174 n_to_read
= sizeof cbuf
;
5175 #else /* no FIONREAD */
5176 #if defined (USG) || defined (DGUX)
5177 /* Read some input if available, but don't wait. */
5178 n_to_read
= sizeof cbuf
;
5179 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5184 #endif /* not MSDOS */
5185 #endif /* not WINDOWSNT */
5187 /* Now read; for one reason or another, this will not block.
5188 NREAD is set to the number of chars read. */
5192 cbuf
[0] = dos_keyread ();
5195 nread
= read (input_fd
, cbuf
, n_to_read
);
5197 /* POSIX infers that processes which are not in the session leader's
5198 process group won't get SIGHUP's at logout time. BSDI adheres to
5199 this part standard and returns -1 from read (0) with errno==EIO
5200 when the control tty is taken away.
5201 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5202 if (nread
== -1 && errno
== EIO
)
5204 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5205 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5206 This looks incorrect, but it isn't, because _BSD causes
5207 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5208 and that causes a value other than 0 when there is no input. */
5214 /* We used to retry the read if it was interrupted.
5215 But this does the wrong thing when O_NDELAY causes
5216 an EAGAIN error. Does anybody know of a situation
5217 where a retry is actually needed? */
5219 nread
< 0 && (errno
== EAGAIN
5233 #if defined (USG) || defined (DGUX)
5234 fcntl (input_fd
, F_SETFL
, 0);
5235 #endif /* USG or DGUX */
5236 #endif /* no FIONREAD */
5237 for (i
= 0; i
< nread
; i
++)
5239 buf
[i
].kind
= ascii_keystroke
;
5240 buf
[i
].modifiers
= 0;
5241 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5242 buf
[i
].modifiers
= meta_modifier
;
5246 buf
[i
].code
= cbuf
[i
];
5247 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5251 /* Scan the chars for C-g and store them in kbd_buffer. */
5252 for (i
= 0; i
< nread
; i
++)
5254 kbd_buffer_store_event (&buf
[i
]);
5255 /* Don't look at input that follows a C-g too closely.
5256 This reduces lossage due to autorepeat on C-g. */
5257 if (buf
[i
].kind
== ascii_keystroke
5258 && buf
[i
].code
== quit_char
)
5264 #endif /* not VMS */
5266 #ifdef SIGIO /* for entire page */
5267 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5270 input_available_signal (signo
)
5273 /* Must preserve main program's value of errno. */
5274 int old_errno
= errno
;
5276 extern int select_alarmed
;
5279 #if defined (USG) && !defined (POSIX_SIGNALS)
5280 /* USG systems forget handlers when they are used;
5281 must reestablish each time */
5282 signal (signo
, input_available_signal
);
5289 if (input_available_clear_time
)
5290 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5295 nread
= read_avail_input (1);
5296 /* -1 means it's not ok to read the input now.
5297 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5298 0 means there was no keyboard input available. */
5303 select_alarmed
= 1; /* Force the select emulator back to life */
5314 /* Send ourselves a SIGIO.
5316 This function exists so that the UNBLOCK_INPUT macro in
5317 blockinput.h can have some way to take care of input we put off
5318 dealing with, without assuming that every file which uses
5319 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5321 reinvoke_input_signal ()
5324 kill (getpid (), SIGIO
);
5330 /* Return the prompt-string of a sparse keymap.
5331 This is the first element which is a string.
5332 Return nil if there is none. */
5340 register Lisp_Object tem
;
5349 static void menu_bar_item ();
5350 static void menu_bar_one_keymap ();
5352 /* These variables hold the vector under construction within
5353 menu_bar_items and its subroutines, and the current index
5354 for storing into that vector. */
5355 static Lisp_Object menu_bar_items_vector
;
5356 static int menu_bar_items_index
;
5358 /* Return a vector of menu items for a menu bar, appropriate
5359 to the current buffer. Each item has three elements in the vector:
5362 OLD is an old vector we can optionally reuse, or nil. */
5365 menu_bar_items (old
)
5368 /* The number of keymaps we're scanning right now, and the number of
5369 keymaps we have allocated space for. */
5372 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5373 in the current keymaps, or nil where it is not a prefix. */
5376 Lisp_Object def
, tem
, tail
;
5385 struct gcpro gcpro1
;
5387 /* In order to build the menus, we need to call the keymap
5388 accessors. They all call QUIT. But this function is called
5389 during redisplay, during which a quit is fatal. So inhibit
5390 quitting while building the menus.
5391 We do this instead of specbind because (1) errors will clear it anyway
5392 and (2) this avoids risk of specpdl overflow. */
5393 oquit
= Vinhibit_quit
;
5397 menu_bar_items_vector
= old
;
5399 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5400 menu_bar_items_index
= 0;
5402 GCPRO1 (menu_bar_items_vector
);
5404 /* Build our list of keymaps.
5405 If we recognize a function key and replace its escape sequence in
5406 keybuf with its symbol, or if the sequence starts with a mouse
5407 click and we need to switch buffers, we jump back here to rebuild
5408 the initial keymaps from the current buffer. */
5412 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5413 if (!NILP (Voverriding_local_map_menu_flag
))
5415 /* Yes, use them (if non-nil) as well as the global map. */
5416 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5418 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5419 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5420 if (!NILP (Voverriding_local_map
))
5421 maps
[nmaps
++] = Voverriding_local_map
;
5425 /* No, so use major and minor mode keymaps. */
5426 nmaps
= current_minor_maps (NULL
, &tmaps
);
5427 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5428 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5429 #ifdef USE_TEXT_PROPERTIES
5430 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5432 maps
[nmaps
++] = current_buffer
->keymap
;
5435 maps
[nmaps
++] = current_global_map
;
5438 /* Look up in each map the dummy prefix key `menu-bar'. */
5442 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5444 if (! NILP (maps
[mapno
]))
5445 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5449 tem
= Fkeymapp (def
);
5451 menu_bar_one_keymap (def
);
5454 /* Move to the end those items that should be at the end. */
5456 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5459 int end
= menu_bar_items_index
;
5461 for (i
= 0; i
< end
; i
+= 4)
5462 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5464 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5465 /* Move the item at index I to the end,
5466 shifting all the others forward. */
5467 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5468 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5469 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5470 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5472 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5473 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5474 (end
- i
- 4) * sizeof (Lisp_Object
));
5475 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5476 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5477 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5478 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5483 /* Add nil, nil, nil, nil at the end. */
5484 i
= menu_bar_items_index
;
5485 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5488 int newsize
= 2 * i
;
5489 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5490 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5491 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5492 menu_bar_items_vector
= tem
;
5494 /* Add this item. */
5495 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5496 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5497 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5498 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5499 menu_bar_items_index
= i
;
5501 Vinhibit_quit
= oquit
;
5503 return menu_bar_items_vector
;
5506 /* Scan one map KEYMAP, accumulating any menu items it defines
5507 in menu_bar_items_vector. */
5510 menu_bar_one_keymap (keymap
)
5513 Lisp_Object tail
, item
, table
;
5515 /* Loop over all keymap entries that have menu strings. */
5516 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5518 item
= XCONS (tail
)->car
;
5520 menu_bar_item (XCONS (item
)->car
, XCONS (item
)->cdr
);
5521 else if (VECTORP (item
))
5523 /* Loop over the char values represented in the vector. */
5524 int len
= XVECTOR (item
)->size
;
5526 for (c
= 0; c
< len
; c
++)
5528 Lisp_Object character
;
5529 XSETFASTINT (character
, c
);
5530 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
5536 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5537 If there's already an item for KEY, add this DEF to it. */
5539 Lisp_Object item_properties
;
5542 menu_bar_item (key
, item
)
5543 Lisp_Object key
, item
;
5545 struct gcpro gcpro1
;
5548 if (EQ (item
, Qundefined
))
5550 /* If a map has an explicit `undefined' as definition,
5551 discard any previously made menu bar item. */
5553 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5554 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5556 if (menu_bar_items_index
> i
+ 4)
5557 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5558 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5559 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5560 menu_bar_items_index
-= 4;
5564 /* If there's no definition for this key yet,
5565 just ignore `undefined'. */
5569 GCPRO1 (key
); /* Is this necessary? */
5570 i
= parse_menu_item (item
, 0, 1);
5575 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5577 /* Find any existing item for this KEY. */
5578 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5579 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5582 /* If we did not find this KEY, add it at the end. */
5583 if (i
== menu_bar_items_index
)
5585 /* If vector is too small, get a bigger one. */
5586 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5589 int newsize
= 2 * i
;
5590 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5591 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5592 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5593 menu_bar_items_vector
= tem
;
5596 /* Add this item. */
5597 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5598 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
5599 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5600 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
5601 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5602 menu_bar_items_index
= i
;
5604 /* We did find an item for this KEY. Add ITEM to its list of maps. */
5608 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5609 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
5613 /* This is used as the handler when calling menu_item_eval_property. */
5615 menu_item_eval_property_1 (arg
)
5618 /* If we got a quit from within the menu computation,
5619 quit all the way out of it. This takes care of C-] in the debugger. */
5620 if (CONSP (arg
) && EQ (XCONS (arg
)->car
, Qquit
))
5621 Fsignal (Qquit
, Qnil
);
5626 /* Evaluate an expression and return the result (or nil if something
5627 went wrong). Used to evaluate dynamic parts of menu items. */
5629 menu_item_eval_property (sexpr
)
5633 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
5634 menu_item_eval_property_1
);
5638 /* This function parses a menu item and leaves the result in the
5639 vector item_properties.
5640 ITEM is a key binding, a possible menu item.
5641 If NOTREAL is nonzero, only check for equivalent key bindings, don't
5642 evaluate dynamic expressions in the menu item.
5643 INMENUBAR is > 0 when this is considered for an entry in a menu bar
5645 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
5646 parse_menu_item returns true if the item is a menu item and false
5650 parse_menu_item (item
, notreal
, inmenubar
)
5652 int notreal
, inmenubar
;
5654 Lisp_Object def
, tem
, item_string
, start
;
5655 Lisp_Object cachelist
= Qnil
;
5656 Lisp_Object filter
= Qnil
;
5657 Lisp_Object keyhint
= Qnil
;
5664 /* Create item_properties vector if necessary. */
5665 if (NILP (item_properties
))
5667 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
5669 /* Initialize optional entries. */
5670 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
5671 XVECTOR (item_properties
)->contents
[i
] = Qnil
;
5672 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = Qt
;
5674 /* Save the item here to protect it from GC. */
5675 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ITEM
] = item
;
5677 item_string
= XCONS (item
)->car
;
5680 item
= XCONS (item
)->cdr
;
5681 if (STRINGP (item_string
))
5683 /* Old format menu item. */
5684 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
5686 /* Maybe help string. */
5687 if (CONSP (item
) && STRINGP (XCONS (item
)->car
))
5689 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5690 = XCONS (item
)->car
;
5692 item
= XCONS (item
)->cdr
;
5695 /* Maybee key binding cache. */
5696 if (CONSP (item
) && CONSP (XCONS (item
)->car
)
5697 && (NILP (XCONS (XCONS (item
)->car
)->car
)
5698 || VECTORP (XCONS (XCONS (item
)->car
)->car
)))
5700 cachelist
= XCONS (item
)->car
;
5701 item
= XCONS (item
)->cdr
;
5704 /* This is the real definition--the function to run. */
5705 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = item
;
5707 /* Get enable property, if any. */
5710 tem
= Fget (item
, Qmenu_enable
);
5712 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
5715 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
5717 /* New format menu item. */
5718 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
]
5719 = XCONS (item
)->car
;
5720 start
= XCONS (item
)->cdr
;
5723 /* We have a real binding. */
5724 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
]
5725 = XCONS (start
)->car
;
5727 item
= XCONS (start
)->cdr
;
5728 /* Is there a cache list with key equivalences. */
5729 if (CONSP (item
) && CONSP (XCONS (item
)->car
))
5731 cachelist
= XCONS (item
)->car
;
5732 item
= XCONS (item
)->cdr
;
5735 /* Parse properties. */
5736 while (CONSP (item
) && CONSP (XCONS (item
)->cdr
))
5738 tem
= XCONS (item
)->car
;
5739 item
= XCONS (item
)->cdr
;
5741 if (EQ (tem
, QCenable
))
5742 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
]
5743 = XCONS (item
)->car
;
5744 else if (EQ (tem
, QCvisible
) && !notreal
)
5746 /* If got a visible property and that evaluates to nil
5747 then ignore this item. */
5748 tem
= menu_item_eval_property (XCONS (item
)->car
);
5752 else if (EQ (tem
, QChelp
))
5753 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5754 = XCONS (item
)->car
;
5755 else if (EQ (tem
, QCfilter
))
5757 else if (EQ (tem
, QCkey_sequence
))
5759 tem
= XCONS (item
)->car
;
5760 if (NILP (cachelist
)
5761 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
5762 /* Be GC protected. Set keyhint to item instead of tem. */
5765 else if (EQ (tem
, QCkeys
))
5767 tem
= XCONS (item
)->car
;
5768 if (CONSP (tem
) || STRINGP (tem
) && NILP (cachelist
))
5769 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
]
5772 else if (EQ (tem
, QCbutton
) && CONSP (XCONS (item
)->car
))
5775 tem
= XCONS (item
)->car
;
5776 type
= XCONS (tem
)->car
;
5777 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
5779 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
5781 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
]
5785 item
= XCONS (item
)->cdr
;
5788 else if (inmenubar
|| !NILP (start
))
5792 return 0; /* not a menu item */
5794 /* If item string is not a string, evaluate it to get string.
5795 If we don't get a string, skip this item. */
5796 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5797 if (!(STRINGP (item_string
) || notreal
))
5799 item_string
= menu_item_eval_property (item_string
);
5800 if (!STRINGP (item_string
))
5802 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
5805 /* If got a filter apply it on definition. */
5806 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5809 def
= menu_item_eval_property (Fcons (XCONS (filter
)->car
,
5810 Fcons (def
, Qnil
)));
5811 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = def
;
5814 /* If we got no definition, this item is just unselectable text which
5815 is OK in a submenu but not in the menubar. */
5817 return (inmenubar
? 0 : 1);
5819 /* Enable or disable selection of item. */
5820 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
];
5826 tem
= menu_item_eval_property (tem
);
5827 if (inmenubar
&& NILP (tem
))
5828 return 0; /* Ignore disabled items in menu bar. */
5829 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
5832 /* See if this is a separate pane or a submenu. */
5833 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5834 tem
= get_keymap_1 (def
, 0, 1);
5837 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_MAP
] = tem
;
5838 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = tem
;
5841 else if (inmenubar
> 0)
5842 return 0; /* Entries in menu bar must be submenus. */
5844 /* This is a command. See if there is an equivalent key binding. */
5845 if (NILP (cachelist
))
5847 /* We have to create a cachelist. */
5848 CHECK_IMPURE (start
);
5849 XCONS (start
)->cdr
= Fcons (Fcons (Qnil
, Qnil
), XCONS (start
)->cdr
);
5850 cachelist
= XCONS (XCONS (start
)->cdr
)->car
;
5852 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
5853 if (!NILP (keyhint
))
5855 XCONS (cachelist
)->car
= XCONS (keyhint
)->car
;
5858 else if (STRINGP (tem
))
5860 XCONS (cachelist
)->cdr
= Fsubstitute_command_keys (tem
);
5861 XCONS (cachelist
)->car
= Qt
;
5864 tem
= XCONS (cachelist
)->car
;
5871 tem
= Fkey_binding (tem
, Qnil
);
5873 prefix
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
5876 def
= XCONS (prefix
)->car
;
5877 prefix
= XCONS (prefix
)->cdr
;
5880 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5882 if (NILP (XCONS (cachelist
)->car
)) /* Have no saved key. */
5884 if (newcache
/* Always check first time. */
5885 /* Should we check everything when precomputing key
5888 /* If something had no key binding before, don't recheck it
5889 because that is too slow--except if we have a list of
5890 rebound commands in Vdefine_key_rebound_commands, do
5891 recheck any command that appears in that list. */
5892 || (CONSP (Vdefine_key_rebound_commands
)
5893 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
5896 /* We had a saved key. Is it still bound to the command? */
5899 /* If the command is an alias for another
5900 (such as lmenu.el set it up), check if the
5901 original command matches the cached command. */
5902 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
)))
5903 chkcache
= 1; /* Need to recompute key binding. */
5907 /* Recompute equivalent key binding. If the command is an alias
5908 for another (such as lmenu.el set it up), see if the original
5909 command name has equivalent keys. Otherwise look up the
5910 specified command itself. We don't try both, because that
5911 makes lmenu menus slow. */
5912 if (SYMBOLP (def
) && SYMBOLP (XSYMBOL (def
)->function
)
5913 && ! NILP (Fget (def
, Qmenu_alias
)))
5914 def
= XSYMBOL (def
)->function
;
5915 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
5916 XCONS (cachelist
)->car
= tem
;
5919 XCONS (cachelist
)->cdr
= Qnil
;
5923 else if (!NILP (keyhint
) && !NILP (XCONS (cachelist
)->car
))
5925 tem
= XCONS (cachelist
)->car
;
5929 newcache
= chkcache
;
5932 tem
= Fkey_description (tem
);
5935 if (STRINGP (XCONS (prefix
)->car
))
5936 tem
= concat2 (XCONS (prefix
)->car
, tem
);
5937 if (STRINGP (XCONS (prefix
)->cdr
))
5938 tem
= concat2 (tem
, XCONS (prefix
)->cdr
);
5940 XCONS (cachelist
)->cdr
= tem
;
5944 tem
= XCONS (cachelist
)->cdr
;
5945 if (newcache
&& !NILP (tem
))
5947 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
5948 XCONS (cachelist
)->cdr
= tem
;
5951 /* If we only want to precompute equivalent key bindings, stop here. */
5955 /* If we have an equivalent key binding, use that. */
5956 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
] = tem
;
5958 /* Include this when menu help is implemented.
5959 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
5960 if (!(NILP (tem) || STRINGP (tem)))
5962 tem = menu_item_eval_property (tem);
5965 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
5969 /* Handle radio buttons or toggle boxes. */
5970 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
5972 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
5973 = menu_item_eval_property (tem
);
5978 /* Read a character using menus based on maps in the array MAPS.
5979 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5980 Return t if we displayed a menu but the user rejected it.
5982 PREV_EVENT is the previous input event, or nil if we are reading
5983 the first event of a key sequence.
5985 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5986 if we used a mouse menu to read the input, or zero otherwise. If
5987 USED_MOUSE_MENU is null, we don't dereference it.
5989 The prompting is done based on the prompt-string of the map
5990 and the strings associated with various map elements.
5992 This can be done with X menus or with menus put in the minibuf.
5993 These are done in different ways, depending on how the input will be read.
5994 Menus using X are done after auto-saving in read-char, getting the input
5995 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5996 and do auto-saving in the inner call of read_char. */
5999 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
6002 Lisp_Object prev_event
;
6003 int *used_mouse_menu
;
6006 register Lisp_Object name
;
6007 Lisp_Object rest
, vector
;
6009 if (used_mouse_menu
)
6010 *used_mouse_menu
= 0;
6012 /* Use local over global Menu maps */
6014 if (! menu_prompting
)
6017 /* Optionally disregard all but the global map. */
6018 if (inhibit_local_menu_bar_menus
)
6020 maps
+= (nmaps
- 1);
6024 /* Get the menu name from the first map that has one (a prompt string). */
6025 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6027 name
= map_prompt (maps
[mapno
]);
6032 /* If we don't have any menus, just read a character normally. */
6037 /* If we got to this point via a mouse click,
6038 use a real menu for mouse selection. */
6039 if (EVENT_HAS_PARAMETERS (prev_event
)
6040 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
6042 /* Display the menu and get the selection. */
6043 Lisp_Object
*realmaps
6044 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
6048 /* Use the maps that are not nil. */
6049 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6050 if (!NILP (maps
[mapno
]))
6051 realmaps
[nmaps1
++] = maps
[mapno
];
6053 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
6058 record_menu_key (XCONS (value
)->car
);
6060 /* If we got multiple events, unread all but
6062 There is no way to prevent those unread events
6063 from showing up later in last_nonmenu_event.
6064 So turn symbol and integer events into lists,
6065 to indicate that they came from a mouse menu,
6066 so that when present in last_nonmenu_event
6067 they won't confuse things. */
6068 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
6069 tem
= XCONS (tem
)->cdr
)
6071 record_menu_key (XCONS (tem
)->car
);
6072 if (SYMBOLP (XCONS (tem
)->car
)
6073 || INTEGERP (XCONS (tem
)->car
))
6075 = Fcons (XCONS (tem
)->car
, Qnil
);
6078 /* If we got more than one event, put all but the first
6079 onto this list to be read later.
6080 Return just the first event now. */
6081 Vunread_command_events
6082 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
6083 value
= XCONS (value
)->car
;
6085 else if (NILP (value
))
6087 if (used_mouse_menu
)
6088 *used_mouse_menu
= 1;
6091 #endif /* HAVE_MENUS */
6095 /* Buffer in use so far for the minibuf prompts for menu keymaps.
6096 We make this bigger when necessary, and never free it. */
6097 static char *read_char_minibuf_menu_text
;
6098 /* Size of that buffer. */
6099 static int read_char_minibuf_menu_width
;
6102 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
6108 register Lisp_Object name
;
6110 int width
= FRAME_WIDTH (selected_frame
) - 4;
6113 Lisp_Object rest
, vector
;
6116 if (! menu_prompting
)
6119 /* Make sure we have a big enough buffer for the menu text. */
6120 if (read_char_minibuf_menu_text
== 0)
6122 read_char_minibuf_menu_width
= width
+ 4;
6123 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
6125 else if (width
+ 4 > read_char_minibuf_menu_width
)
6127 read_char_minibuf_menu_width
= width
+ 4;
6128 read_char_minibuf_menu_text
6129 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
6131 menu
= read_char_minibuf_menu_text
;
6133 /* Get the menu name from the first map that has one (a prompt string). */
6134 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6136 name
= map_prompt (maps
[mapno
]);
6141 /* If we don't have any menus, just read a character normally. */
6145 /* Prompt string always starts with map's prompt, and a space. */
6146 strcpy (menu
, XSTRING (name
)->data
);
6147 nlength
= STRING_BYTES (XSTRING (name
));
6148 menu
[nlength
++] = ':';
6149 menu
[nlength
++] = ' ';
6152 /* Start prompting at start of first map. */
6156 /* Present the documented bindings, a line at a time. */
6163 Lisp_Object orig_defn_macro
;
6165 /* Loop over elements of map. */
6170 /* If reached end of map, start at beginning of next map. */
6174 /* At end of last map, wrap around to first map if just starting,
6175 or end this line if already have something on it. */
6179 if (notfirst
|| nobindings
) break;
6184 /* Look at the next element of the map. */
6186 elt
= XVECTOR (vector
)->contents
[idx
];
6188 elt
= Fcar_safe (rest
);
6190 if (idx
< 0 && VECTORP (elt
))
6192 /* If we found a dense table in the keymap,
6193 advanced past it, but start scanning its contents. */
6194 rest
= Fcdr_safe (rest
);
6200 /* An ordinary element. */
6201 Lisp_Object event
, tem
;
6205 event
= Fcar_safe (elt
); /* alist */
6206 elt
= Fcdr_safe (elt
);
6210 XSETINT (event
, idx
); /* vector */
6213 /* Ignore the element if it has no prompt string. */
6214 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
6216 /* 1 if the char to type matches the string. */
6218 Lisp_Object upcased_event
, downcased_event
;
6221 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6223 upcased_event
= Fupcase (event
);
6224 downcased_event
= Fdowncase (event
);
6225 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
6226 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
6228 desc
= Fsingle_key_description (event
);
6231 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6233 /* Insert equivalent keybinding. */
6234 s
= concat2 (s
, tem
);
6237 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
6238 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
6240 /* Insert button prefix. */
6241 Lisp_Object selected
6242 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6243 if (EQ (tem
, QCradio
))
6244 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
6246 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
6247 s
= concat2 (tem
, s
);
6251 /* If we have room for the prompt string, add it to this line.
6252 If this is the first on the line, always add it. */
6253 if ((XSTRING (s
)->size
+ i
+ 2
6254 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
6260 /* Punctuate between strings. */
6263 strcpy (menu
+ i
, ", ");
6269 /* If the char to type doesn't match the string's
6270 first char, explicitly show what char to type. */
6273 /* Add as much of string as fits. */
6274 thiswidth
= XSTRING (desc
)->size
;
6275 if (thiswidth
+ i
> width
)
6276 thiswidth
= width
- i
;
6277 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
6279 strcpy (menu
+ i
, " = ");
6283 /* Add as much of string as fits. */
6284 thiswidth
= XSTRING (s
)->size
;
6285 if (thiswidth
+ i
> width
)
6286 thiswidth
= width
- i
;
6287 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
6293 /* If this element does not fit, end the line now,
6294 and save the element for the next line. */
6295 strcpy (menu
+ i
, "...");
6300 /* Move past this element. */
6301 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
6302 /* Handle reaching end of dense table. */
6307 rest
= Fcdr_safe (rest
);
6311 /* Prompt with that and read response. */
6312 message2_nolog (menu
, strlen (menu
),
6313 ! NILP (current_buffer
->enable_multibyte_characters
));
6315 /* Make believe its not a keyboard macro in case the help char
6316 is pressed. Help characters are not recorded because menu prompting
6317 is not used on replay.
6319 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
6320 current_kboard
->defining_kbd_macro
= Qnil
;
6322 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
6323 while (BUFFERP (obj
));
6324 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
6326 if (!INTEGERP (obj
))
6331 if (! EQ (obj
, menu_prompt_more_char
)
6332 && (!INTEGERP (menu_prompt_more_char
)
6333 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
6335 if (!NILP (current_kboard
->defining_kbd_macro
))
6336 store_kbd_macro_char (obj
);
6339 /* Help char - go round again */
6343 /* Reading key sequences. */
6345 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
6346 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
6347 keymap, or nil otherwise. Return the index of the first keymap in
6348 which KEY has any binding, or NMAPS if no map has a binding.
6350 If KEY is a meta ASCII character, treat it like meta-prefix-char
6351 followed by the corresponding non-meta character. Keymaps in
6352 CURRENT with non-prefix bindings for meta-prefix-char become nil in
6355 If KEY has no bindings in any of the CURRENT maps, NEXT is left
6358 NEXT may be the same array as CURRENT. */
6361 follow_key (key
, nmaps
, current
, defs
, next
)
6363 Lisp_Object
*current
, *defs
, *next
;
6366 int i
, first_binding
;
6369 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
6370 followed by the corresponding non-meta character.
6371 Put the results into DEFS, since we are going to alter that anyway.
6372 Do not alter CURRENT or NEXT. */
6373 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
6375 for (i
= 0; i
< nmaps
; i
++)
6376 if (! NILP (current
[i
]))
6379 def
= get_keyelt (access_keymap (current
[i
],
6380 meta_prefix_char
, 1, 0), 0);
6382 /* Note that since we pass the resulting bindings through
6383 get_keymap_1, non-prefix bindings for meta-prefix-char
6385 defs
[i
] = get_keymap_1 (def
, 0, 1);
6391 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
6394 first_binding
= nmaps
;
6395 for (i
= nmaps
- 1; i
>= 0; i
--)
6397 if (! NILP (current
[i
]))
6405 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
6406 if (! NILP (defs
[i
]))
6413 /* Given the set of bindings we've found, produce the next set of maps. */
6414 if (first_binding
< nmaps
)
6415 for (i
= 0; i
< nmaps
; i
++)
6416 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
6418 return first_binding
;
6421 /* Read a sequence of keys that ends with a non prefix character,
6422 storing it in KEYBUF, a buffer of size BUFSIZE.
6424 Return the length of the key sequence stored.
6425 Return -1 if the user rejected a command menu.
6427 Echo starting immediately unless `prompt' is 0.
6429 Where a key sequence ends depends on the currently active keymaps.
6430 These include any minor mode keymaps active in the current buffer,
6431 the current buffer's local map, and the global map.
6433 If a key sequence has no other bindings, we check Vfunction_key_map
6434 to see if some trailing subsequence might be the beginning of a
6435 function key's sequence. If so, we try to read the whole function
6436 key, and substitute its symbolic name into the key sequence.
6438 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
6439 `double-' events into similar click events, if that would make them
6440 bound. We try to turn `triple-' events first into `double-' events,
6443 If we get a mouse click in a mode line, vertical divider, or other
6444 non-text area, we treat the click as if it were prefixed by the
6445 symbol denoting that area - `mode-line', `vertical-line', or
6448 If the sequence starts with a mouse click, we read the key sequence
6449 with respect to the buffer clicked on, not the current buffer.
6451 If the user switches frames in the midst of a key sequence, we put
6452 off the switch-frame event until later; the next call to
6453 read_char will return it.
6455 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
6456 from the selected window's buffer. */
6459 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
6460 can_return_switch_frame
, fix_current_buffer
)
6461 Lisp_Object
*keybuf
;
6464 int dont_downcase_last
;
6465 int can_return_switch_frame
;
6466 int fix_current_buffer
;
6468 int count
= specpdl_ptr
- specpdl
;
6470 /* How many keys there are in the current key sequence. */
6473 /* The length of the echo buffer when we started reading, and
6474 the length of this_command_keys when we started reading. */
6478 /* The number of keymaps we're scanning right now, and the number of
6479 keymaps we have allocated space for. */
6481 int nmaps_allocated
= 0;
6483 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
6484 the current keymaps. */
6487 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6488 in the current keymaps, or nil where it is not a prefix. */
6489 Lisp_Object
*submaps
;
6491 /* The local map to start out with at start of key sequence. */
6492 Lisp_Object orig_local_map
;
6494 /* 1 if we have already considered switching to the local-map property
6495 of the place where a mouse click occurred. */
6496 int localized_local_map
= 0;
6498 /* The index in defs[] of the first keymap that has a binding for
6499 this key sequence. In other words, the lowest i such that
6500 defs[i] is non-nil. */
6503 /* If t < mock_input, then KEYBUF[t] should be read as the next
6506 We use this to recover after recognizing a function key. Once we
6507 realize that a suffix of the current key sequence is actually a
6508 function key's escape sequence, we replace the suffix with the
6509 function key's binding from Vfunction_key_map. Now keybuf
6510 contains a new and different key sequence, so the echo area,
6511 this_command_keys, and the submaps and defs arrays are wrong. In
6512 this situation, we set mock_input to t, set t to 0, and jump to
6513 restart_sequence; the loop will read keys from keybuf up until
6514 mock_input, thus rebuilding the state; and then it will resume
6515 reading characters from the keyboard. */
6518 /* If the sequence is unbound in submaps[], then
6519 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6520 and fkey_map is its binding.
6522 These might be > t, indicating that all function key scanning
6523 should hold off until t reaches them. We do this when we've just
6524 recognized a function key, to avoid searching for the function
6525 key's again in Vfunction_key_map. */
6526 int fkey_start
= 0, fkey_end
= 0;
6527 Lisp_Object fkey_map
;
6529 /* Likewise, for key_translation_map. */
6530 int keytran_start
= 0, keytran_end
= 0;
6531 Lisp_Object keytran_map
;
6533 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6534 we put it off for later. While we're reading, we keep the event here. */
6535 Lisp_Object delayed_switch_frame
;
6537 /* See the comment below... */
6538 #if defined (GOBBLE_FIRST_EVENT)
6539 Lisp_Object first_event
;
6542 Lisp_Object original_uppercase
;
6543 int original_uppercase_position
= -1;
6545 /* Gets around Microsoft compiler limitations. */
6548 struct buffer
*starting_buffer
;
6550 /* Nonzero if we seem to have got the beginning of a binding
6551 in function_key_map. */
6552 int function_key_possible
= 0;
6553 int key_translation_possible
= 0;
6555 /* Save the status of key translation before each step,
6556 so that we can restore this after downcasing. */
6557 Lisp_Object prev_fkey_map
;
6558 int prev_fkey_start
;
6561 Lisp_Object prev_keytran_map
;
6562 int prev_keytran_start
;
6563 int prev_keytran_end
;
6567 last_nonmenu_event
= Qnil
;
6569 delayed_switch_frame
= Qnil
;
6570 fkey_map
= Vfunction_key_map
;
6571 keytran_map
= Vkey_translation_map
;
6573 /* If there is no function-key-map, turn off function key scanning. */
6574 if (NILP (Fkeymapp (Vfunction_key_map
)))
6575 fkey_start
= fkey_end
= bufsize
+ 1;
6577 /* If there is no key-translation-map, turn off scanning. */
6578 if (NILP (Fkeymapp (Vkey_translation_map
)))
6579 keytran_start
= keytran_end
= bufsize
+ 1;
6584 echo_prompt (XSTRING (prompt
)->data
);
6585 else if (cursor_in_echo_area
&& echo_keystrokes
)
6586 /* This doesn't put in a dash if the echo buffer is empty, so
6587 you don't always see a dash hanging out in the minibuffer. */
6591 /* Record the initial state of the echo area and this_command_keys;
6592 we will need to restore them if we replay a key sequence. */
6594 echo_start
= echo_length ();
6595 keys_start
= this_command_key_count
;
6596 this_single_command_key_start
= keys_start
;
6598 #if defined (GOBBLE_FIRST_EVENT)
6599 /* This doesn't quite work, because some of the things that read_char
6600 does cannot safely be bypassed. It seems too risky to try to make
6603 /* Read the first char of the sequence specially, before setting
6604 up any keymaps, in case a filter runs and switches buffers on us. */
6605 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6607 #endif /* GOBBLE_FIRST_EVENT */
6609 orig_local_map
= get_local_map (PT
, current_buffer
);
6611 /* We jump here when the key sequence has been thoroughly changed, and
6612 we need to rescan it starting from the beginning. When we jump here,
6613 keybuf[0..mock_input] holds the sequence we should reread. */
6616 starting_buffer
= current_buffer
;
6617 function_key_possible
= 0;
6618 key_translation_possible
= 0;
6620 /* Build our list of keymaps.
6621 If we recognize a function key and replace its escape sequence in
6622 keybuf with its symbol, or if the sequence starts with a mouse
6623 click and we need to switch buffers, we jump back here to rebuild
6624 the initial keymaps from the current buffer. */
6628 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6629 || !NILP (Voverriding_local_map
))
6631 if (3 > nmaps_allocated
)
6633 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6634 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6635 nmaps_allocated
= 3;
6638 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6639 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6640 if (!NILP (Voverriding_local_map
))
6641 submaps
[nmaps
++] = Voverriding_local_map
;
6645 nmaps
= current_minor_maps (0, &maps
);
6646 if (nmaps
+ 2 > nmaps_allocated
)
6648 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6649 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6650 nmaps_allocated
= nmaps
+ 2;
6652 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6653 #ifdef USE_TEXT_PROPERTIES
6654 submaps
[nmaps
++] = orig_local_map
;
6656 submaps
[nmaps
++] = current_buffer
->keymap
;
6659 submaps
[nmaps
++] = current_global_map
;
6662 /* Find an accurate initial value for first_binding. */
6663 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6664 if (! NILP (submaps
[first_binding
]))
6667 /* Start from the beginning in keybuf. */
6670 /* These are no-ops the first time through, but if we restart, they
6671 revert the echo area and this_command_keys to their original state. */
6672 this_command_key_count
= keys_start
;
6673 if (INTERACTIVE
&& t
< mock_input
)
6674 echo_truncate (echo_start
);
6676 /* If the best binding for the current key sequence is a keymap, or
6677 we may be looking at a function key's escape sequence, keep on
6679 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6680 || (first_binding
>= nmaps
6682 /* mock input is never part of a function key's sequence. */
6683 && mock_input
<= fkey_start
)
6684 || (first_binding
>= nmaps
6685 && keytran_start
< t
&& key_translation_possible
)
6686 /* Don't return in the middle of a possible function key sequence,
6687 if the only bindings we found were via case conversion.
6688 Thus, if ESC O a has a function-key-map translation
6689 and ESC o has a binding, don't return after ESC O,
6690 so that we can translate ESC O plus the next character. */
6694 int used_mouse_menu
= 0;
6696 /* Where the last real key started. If we need to throw away a
6697 key that has expanded into more than one element of keybuf
6698 (say, a mouse click on the mode line which is being treated
6699 as [mode-line (mouse-...)], then we backtrack to this point
6701 int last_real_key_start
;
6703 /* These variables are analogous to echo_start and keys_start;
6704 while those allow us to restart the entire key sequence,
6705 echo_local_start and keys_local_start allow us to throw away
6707 int echo_local_start
, keys_local_start
, local_first_binding
;
6710 error ("Key sequence too long");
6713 echo_local_start
= echo_length ();
6714 keys_local_start
= this_command_key_count
;
6715 local_first_binding
= first_binding
;
6718 /* These are no-ops, unless we throw away a keystroke below and
6719 jumped back up to replay_key; in that case, these restore the
6720 variables to their original state, allowing us to replay the
6722 if (INTERACTIVE
&& t
< mock_input
)
6723 echo_truncate (echo_local_start
);
6724 this_command_key_count
= keys_local_start
;
6725 first_binding
= local_first_binding
;
6727 /* By default, assume each event is "real". */
6728 last_real_key_start
= t
;
6730 /* Does mock_input indicate that we are re-reading a key sequence? */
6734 add_command_key (key
);
6735 if (echo_keystrokes
)
6739 /* If not, we should actually read a character. */
6742 struct buffer
*buf
= current_buffer
;
6746 KBOARD
*interrupted_kboard
= current_kboard
;
6747 struct frame
*interrupted_frame
= selected_frame
;
6748 if (setjmp (wrong_kboard_jmpbuf
))
6750 if (!NILP (delayed_switch_frame
))
6752 interrupted_kboard
->kbd_queue
6753 = Fcons (delayed_switch_frame
,
6754 interrupted_kboard
->kbd_queue
);
6755 delayed_switch_frame
= Qnil
;
6758 interrupted_kboard
->kbd_queue
6759 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6761 /* If the side queue is non-empty, ensure it begins with a
6762 switch-frame, so we'll replay it in the right context. */
6763 if (CONSP (interrupted_kboard
->kbd_queue
)
6764 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6765 !(EVENT_HAS_PARAMETERS (key
)
6766 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6770 XSETFRAME (frame
, interrupted_frame
);
6771 interrupted_kboard
->kbd_queue
6772 = Fcons (make_lispy_switch_frame (frame
),
6773 interrupted_kboard
->kbd_queue
);
6776 orig_local_map
= get_local_map (PT
, current_buffer
);
6777 goto replay_sequence
;
6780 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6784 /* read_char returns t when it shows a menu and the user rejects it.
6789 /* read_char returns -1 at the end of a macro.
6790 Emacs 18 handles this by returning immediately with a
6791 zero, so that's what we'll do. */
6792 if (INTEGERP (key
) && XINT (key
) == -1)
6795 /* The Microsoft C compiler can't handle the goto that
6801 /* If the current buffer has been changed from under us, the
6802 keymap may have changed, so replay the sequence. */
6806 /* Reset the current buffer from the selected window
6807 in case something changed the former and not the latter.
6808 This is to be more consistent with the behavior
6809 of the command_loop_1. */
6810 if (fix_current_buffer
)
6811 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6812 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6814 orig_local_map
= get_local_map (PT
, current_buffer
);
6815 goto replay_sequence
;
6818 /* If we have a quit that was typed in another frame, and
6819 quit_throw_to_read_char switched buffers,
6820 replay to get the right keymap. */
6821 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6826 orig_local_map
= get_local_map (PT
, current_buffer
);
6827 goto replay_sequence
;
6833 /* Clicks in non-text areas get prefixed by the symbol
6834 in their CHAR-ADDRESS field. For example, a click on
6835 the mode line is prefixed by the symbol `mode-line'.
6837 Furthermore, key sequences beginning with mouse clicks
6838 are read using the keymaps of the buffer clicked on, not
6839 the current buffer. So we may have to switch the buffer
6842 When we turn one event into two events, we must make sure
6843 that neither of the two looks like the original--so that,
6844 if we replay the events, they won't be expanded again.
6845 If not for this, such reexpansion could happen either here
6846 or when user programs play with this-command-keys. */
6847 if (EVENT_HAS_PARAMETERS (key
))
6851 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6852 if (EQ (kind
, Qmouse_click
))
6854 Lisp_Object window
, posn
;
6856 window
= POSN_WINDOW (EVENT_START (key
));
6857 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6860 /* We're looking at the second event of a
6861 sequence which we expanded before. Set
6862 last_real_key_start appropriately. */
6864 last_real_key_start
= t
- 1;
6867 /* Key sequences beginning with mouse clicks are
6868 read using the keymaps in the buffer clicked on,
6869 not the current buffer. If we're at the
6870 beginning of a key sequence, switch buffers. */
6871 if (last_real_key_start
== 0
6873 && BUFFERP (XWINDOW (window
)->buffer
)
6874 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6879 /* Arrange to go back to the original buffer once we're
6880 done reading the key sequence. Note that we can't
6881 use save_excursion_{save,restore} here, because they
6882 save point as well as the current buffer; we don't
6883 want to save point, because redisplay may change it,
6884 to accommodate a Fset_window_start or something. We
6885 don't want to do this at the top of the function,
6886 because we may get input from a subprocess which
6887 wants to change the selected window and stuff (say,
6889 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6891 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6892 orig_local_map
= get_local_map (PT
, current_buffer
);
6893 goto replay_sequence
;
6895 /* For a mouse click, get the local text-property keymap
6896 of the place clicked on, rather than point. */
6897 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6898 && ! localized_local_map
)
6900 Lisp_Object map_here
, start
, pos
;
6902 localized_local_map
= 1;
6903 start
= EVENT_START (key
);
6904 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6906 pos
= POSN_BUFFER_POSN (start
);
6908 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6910 map_here
= get_local_map (XINT (pos
), current_buffer
);
6911 if (!EQ (map_here
, orig_local_map
))
6913 orig_local_map
= map_here
;
6917 goto replay_sequence
;
6923 /* Expand mode-line and scroll-bar events into two events:
6924 use posn as a fake prefix key. */
6927 if (t
+ 1 >= bufsize
)
6928 error ("Key sequence too long");
6933 /* Zap the position in key, so we know that we've
6934 expanded it, and don't try to do so again. */
6935 POSN_BUFFER_POSN (EVENT_START (key
))
6936 = Fcons (posn
, Qnil
);
6940 else if (EQ (kind
, Qswitch_frame
))
6942 /* If we're at the beginning of a key sequence, and the caller
6943 says it's okay, go ahead and return this event. If we're
6944 in the midst of a key sequence, delay it until the end. */
6945 if (t
> 0 || !can_return_switch_frame
)
6947 delayed_switch_frame
= key
;
6951 else if (CONSP (XCONS (key
)->cdr
)
6952 && CONSP (EVENT_START (key
))
6953 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6957 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6958 /* Handle menu-bar events:
6959 insert the dummy prefix event `menu-bar'. */
6960 if (EQ (posn
, Qmenu_bar
))
6962 if (t
+ 1 >= bufsize
)
6963 error ("Key sequence too long");
6967 /* Zap the position in key, so we know that we've
6968 expanded it, and don't try to do so again. */
6969 POSN_BUFFER_POSN (EVENT_START (key
))
6970 = Fcons (posn
, Qnil
);
6973 goto replay_sequence
;
6975 else if (CONSP (posn
))
6977 /* We're looking at the second event of a
6978 sequence which we expanded before. Set
6979 last_real_key_start appropriately. */
6980 if (last_real_key_start
== t
&& t
> 0)
6981 last_real_key_start
= t
- 1;
6986 /* We have finally decided that KEY is something we might want
6988 first_binding
= (follow_key (key
,
6989 nmaps
- first_binding
,
6990 submaps
+ first_binding
,
6991 defs
+ first_binding
,
6992 submaps
+ first_binding
)
6995 /* If KEY wasn't bound, we'll try some fallbacks. */
6996 if (first_binding
>= nmaps
)
7000 head
= EVENT_HEAD (key
);
7001 if (help_char_p (head
) && t
> 0)
7003 read_key_sequence_cmd
= Vprefix_help_command
;
7005 last_nonmenu_event
= key
;
7006 /* The Microsoft C compiler can't handle the goto that
7014 Lisp_Object breakdown
;
7017 breakdown
= parse_modifiers (head
);
7018 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7019 /* Attempt to reduce an unbound mouse event to a simpler
7020 event that is bound:
7021 Drags reduce to clicks.
7022 Double-clicks reduce to clicks.
7023 Triple-clicks reduce to double-clicks, then to clicks.
7024 Down-clicks are eliminated.
7025 Double-downs reduce to downs, then are eliminated.
7026 Triple-downs reduce to double-downs, then to downs,
7027 then are eliminated. */
7028 if (modifiers
& (down_modifier
| drag_modifier
7029 | double_modifier
| triple_modifier
))
7031 while (modifiers
& (down_modifier
| drag_modifier
7032 | double_modifier
| triple_modifier
))
7034 Lisp_Object new_head
, new_click
;
7035 if (modifiers
& triple_modifier
)
7036 modifiers
^= (double_modifier
| triple_modifier
);
7037 else if (modifiers
& double_modifier
)
7038 modifiers
&= ~double_modifier
;
7039 else if (modifiers
& drag_modifier
)
7040 modifiers
&= ~drag_modifier
;
7043 /* Dispose of this `down' event by simply jumping
7044 back to replay_key, to get another event.
7046 Note that if this event came from mock input,
7047 then just jumping back to replay_key will just
7048 hand it to us again. So we have to wipe out any
7051 We could delete keybuf[t] and shift everything
7052 after that to the left by one spot, but we'd also
7053 have to fix up any variable that points into
7054 keybuf, and shifting isn't really necessary
7057 Adding prefixes for non-textual mouse clicks
7058 creates two characters of mock input, and both
7059 must be thrown away. If we're only looking at
7060 the prefix now, we can just jump back to
7061 replay_key. On the other hand, if we've already
7062 processed the prefix, and now the actual click
7063 itself is giving us trouble, then we've lost the
7064 state of the keymaps we want to backtrack to, and
7065 we need to replay the whole sequence to rebuild
7068 Beyond that, only function key expansion could
7069 create more than two keys, but that should never
7070 generate mouse events, so it's okay to zero
7071 mock_input in that case too.
7073 Isn't this just the most wonderful code ever? */
7074 if (t
== last_real_key_start
)
7081 mock_input
= last_real_key_start
;
7082 goto replay_sequence
;
7087 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
7089 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
7091 /* Look for a binding for this new key. follow_key
7092 promises that it didn't munge submaps the
7093 last time we called it, since key was unbound. */
7095 = (follow_key (new_click
,
7096 nmaps
- local_first_binding
,
7097 submaps
+ local_first_binding
,
7098 defs
+ local_first_binding
,
7099 submaps
+ local_first_binding
)
7100 + local_first_binding
);
7102 /* If that click is bound, go for it. */
7103 if (first_binding
< nmaps
)
7108 /* Otherwise, we'll leave key set to the drag event. */
7115 /* Normally, last_nonmenu_event gets the previous key we read.
7116 But when a mouse popup menu is being used,
7117 we don't update last_nonmenu_event; it continues to hold the mouse
7118 event that preceded the first level of menu. */
7119 if (!used_mouse_menu
)
7120 last_nonmenu_event
= key
;
7122 /* Record what part of this_command_keys is the current key sequence. */
7123 this_single_command_key_start
= this_command_key_count
- t
;
7125 prev_fkey_map
= fkey_map
;
7126 prev_fkey_start
= fkey_start
;
7127 prev_fkey_end
= fkey_end
;
7129 prev_keytran_map
= keytran_map
;
7130 prev_keytran_start
= keytran_start
;
7131 prev_keytran_end
= keytran_end
;
7133 /* If the sequence is unbound, see if we can hang a function key
7134 off the end of it. We only want to scan real keyboard input
7135 for function key sequences, so if mock_input says that we're
7136 re-reading old events, don't examine it. */
7137 if (first_binding
>= nmaps
7140 Lisp_Object fkey_next
;
7142 /* Continue scan from fkey_end until we find a bound suffix.
7143 If we fail, increment fkey_start
7144 and start fkey_end from there. */
7145 while (fkey_end
< t
)
7149 key
= keybuf
[fkey_end
++];
7150 /* Look up meta-characters by prefixing them
7151 with meta_prefix_char. I hate this. */
7152 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7157 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
7159 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7162 fkey_next
= fkey_map
;
7165 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
7167 #if 0 /* I didn't turn this on, because it might cause trouble
7168 for the mapping of return into C-m and tab into C-i. */
7169 /* Optionally don't map function keys into other things.
7170 This enables the user to redefine kp- keys easily. */
7171 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
7175 /* If the function key map gives a function, not an
7176 array, then call the function with no args and use
7177 its value instead. */
7178 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
7181 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7185 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7186 fkey_next
= call1 (fkey_next
, prompt
);
7188 /* If the function returned something invalid,
7189 barf--don't ignore it.
7190 (To ignore it safely, we would need to gcpro a bunch of
7191 other variables.) */
7192 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
7193 error ("Function in key-translation-map returns invalid key sequence");
7196 function_key_possible
= ! NILP (fkey_next
);
7198 /* If keybuf[fkey_start..fkey_end] is bound in the
7199 function key map and it's a suffix of the current
7200 sequence (i.e. fkey_end == t), replace it with
7201 the binding and restart with fkey_start at the end. */
7202 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
7205 int len
= XFASTINT (Flength (fkey_next
));
7207 t
= fkey_start
+ len
;
7209 error ("Key sequence too long");
7211 if (VECTORP (fkey_next
))
7212 bcopy (XVECTOR (fkey_next
)->contents
,
7213 keybuf
+ fkey_start
,
7214 (t
- fkey_start
) * sizeof (keybuf
[0]));
7215 else if (STRINGP (fkey_next
))
7219 for (i
= 0; i
< len
; i
++)
7220 XSETFASTINT (keybuf
[fkey_start
+ i
],
7221 XSTRING (fkey_next
)->data
[i
]);
7225 fkey_start
= fkey_end
= t
;
7226 fkey_map
= Vfunction_key_map
;
7228 /* Do pass the results through key-translation-map. */
7229 keytran_start
= keytran_end
= 0;
7230 keytran_map
= Vkey_translation_map
;
7232 goto replay_sequence
;
7235 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
7237 /* If we no longer have a bound suffix, try a new positions for
7239 if (NILP (fkey_map
))
7241 fkey_end
= ++fkey_start
;
7242 fkey_map
= Vfunction_key_map
;
7243 function_key_possible
= 0;
7248 /* Look for this sequence in key-translation-map. */
7250 Lisp_Object keytran_next
;
7252 /* Scan from keytran_end until we find a bound suffix. */
7253 while (keytran_end
< t
)
7257 key
= keybuf
[keytran_end
++];
7258 /* Look up meta-characters by prefixing them
7259 with meta_prefix_char. I hate this. */
7260 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7265 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
7267 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7270 keytran_next
= keytran_map
;
7273 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
7275 /* If the key translation map gives a function, not an
7276 array, then call the function with no args and use
7277 its value instead. */
7278 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
7279 && keytran_end
== t
)
7281 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7285 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7286 keytran_next
= call1 (keytran_next
, prompt
);
7288 /* If the function returned something invalid,
7289 barf--don't ignore it.
7290 (To ignore it safely, we would need to gcpro a bunch of
7291 other variables.) */
7292 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
7293 error ("Function in key-translation-map returns invalid key sequence");
7296 key_translation_possible
= ! NILP (keytran_next
);
7298 /* If keybuf[keytran_start..keytran_end] is bound in the
7299 key translation map and it's a suffix of the current
7300 sequence (i.e. keytran_end == t), replace it with
7301 the binding and restart with keytran_start at the end. */
7302 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
7303 && keytran_end
== t
)
7305 int len
= XFASTINT (Flength (keytran_next
));
7307 t
= keytran_start
+ len
;
7309 error ("Key sequence too long");
7311 if (VECTORP (keytran_next
))
7312 bcopy (XVECTOR (keytran_next
)->contents
,
7313 keybuf
+ keytran_start
,
7314 (t
- keytran_start
) * sizeof (keybuf
[0]));
7315 else if (STRINGP (keytran_next
))
7319 for (i
= 0; i
< len
; i
++)
7320 XSETFASTINT (keybuf
[keytran_start
+ i
],
7321 XSTRING (keytran_next
)->data
[i
]);
7325 keytran_start
= keytran_end
= t
;
7326 keytran_map
= Vkey_translation_map
;
7328 /* Don't pass the results of key-translation-map
7329 through function-key-map. */
7330 fkey_start
= fkey_end
= t
;
7331 fkey_map
= Vkey_translation_map
;
7333 goto replay_sequence
;
7336 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
7338 /* If we no longer have a bound suffix, try a new positions for
7340 if (NILP (keytran_map
))
7342 keytran_end
= ++keytran_start
;
7343 keytran_map
= Vkey_translation_map
;
7344 key_translation_possible
= 0;
7349 /* If KEY is not defined in any of the keymaps,
7350 and cannot be part of a function key or translation,
7351 and is an upper case letter
7352 use the corresponding lower-case letter instead. */
7353 if (first_binding
== nmaps
&& ! function_key_possible
7354 && ! key_translation_possible
7356 && ((((XINT (key
) & 0x3ffff)
7357 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
7358 && UPPERCASEP (XINT (key
) & 0x3ffff))
7359 || (XINT (key
) & shift_modifier
)))
7361 Lisp_Object new_key
;
7363 original_uppercase
= key
;
7364 original_uppercase_position
= t
- 1;
7366 if (XINT (key
) & shift_modifier
)
7367 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
7369 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
7370 | (XINT (key
) & ~0x3ffff)));
7372 /* We have to do this unconditionally, regardless of whether
7373 the lower-case char is defined in the keymaps, because they
7374 might get translated through function-key-map. */
7375 keybuf
[t
- 1] = new_key
;
7378 fkey_map
= prev_fkey_map
;
7379 fkey_start
= prev_fkey_start
;
7380 fkey_end
= prev_fkey_end
;
7382 keytran_map
= prev_keytran_map
;
7383 keytran_start
= prev_keytran_start
;
7384 keytran_end
= prev_keytran_end
;
7386 goto replay_sequence
;
7388 /* If KEY is not defined in any of the keymaps,
7389 and cannot be part of a function key or translation,
7390 and is a shifted function key,
7391 use the corresponding unshifted function key instead. */
7392 if (first_binding
== nmaps
&& ! function_key_possible
7393 && ! key_translation_possible
7396 Lisp_Object breakdown
;
7399 breakdown
= parse_modifiers (key
);
7400 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7401 if (modifiers
& shift_modifier
)
7403 Lisp_Object new_key
;
7405 original_uppercase
= key
;
7406 original_uppercase_position
= t
- 1;
7408 modifiers
&= ~shift_modifier
;
7409 new_key
= apply_modifiers (modifiers
,
7410 XCONS (breakdown
)->car
);
7412 keybuf
[t
- 1] = new_key
;
7415 fkey_map
= prev_fkey_map
;
7416 fkey_start
= prev_fkey_start
;
7417 fkey_end
= prev_fkey_end
;
7419 keytran_map
= prev_keytran_map
;
7420 keytran_start
= prev_keytran_start
;
7421 keytran_end
= prev_keytran_end
;
7423 goto replay_sequence
;
7429 read_key_sequence_cmd
= (first_binding
< nmaps
7430 ? defs
[first_binding
]
7433 unread_switch_frame
= delayed_switch_frame
;
7434 unbind_to (count
, Qnil
);
7436 /* Don't downcase the last character if the caller says don't.
7437 Don't downcase it if the result is undefined, either. */
7438 if ((dont_downcase_last
|| first_binding
>= nmaps
)
7439 && t
- 1 == original_uppercase_position
)
7440 keybuf
[t
- 1] = original_uppercase
;
7442 /* Occasionally we fabricate events, perhaps by expanding something
7443 according to function-key-map, or by adding a prefix symbol to a
7444 mouse click in the scroll bar or modeline. In this cases, return
7445 the entire generated key sequence, even if we hit an unbound
7446 prefix or a definition before the end. This means that you will
7447 be able to push back the event properly, and also means that
7448 read-key-sequence will always return a logical unit.
7451 for (; t
< mock_input
; t
++)
7453 if (echo_keystrokes
)
7454 echo_char (keybuf
[t
]);
7455 add_command_key (keybuf
[t
]);
7461 #if 0 /* This doc string is too long for some compilers.
7462 This commented-out definition serves for DOC. */
7463 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7464 "Read a sequence of keystrokes and return as a string or vector.\n\
7465 The sequence is sufficient to specify a non-prefix command in the\n\
7466 current local and global maps.\n\
7468 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
7469 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
7470 as a continuation of the previous key.\n\
7472 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
7473 convert the last event to lower case. (Normally any upper case event\n\
7474 is converted to lower case if the original event is undefined and the lower\n\
7475 case equivalent is defined.) A non-nil value is appropriate for reading\n\
7476 a key sequence to be defined.\n\
7478 A C-g typed while in this function is treated like any other character,\n\
7479 and `quit-flag' is not set.\n\
7481 If the key sequence starts with a mouse click, then the sequence is read\n\
7482 using the keymaps of the buffer of the window clicked in, not the buffer\n\
7483 of the selected window as normal.\n\
7485 `read-key-sequence' drops unbound button-down events, since you normally\n\
7486 only care about the click or drag events which follow them. If a drag\n\
7487 or multi-click event is unbound, but the corresponding click event would\n\
7488 be bound, `read-key-sequence' turns the event into a click event at the\n\
7489 drag's starting position. This means that you don't have to distinguish\n\
7490 between click and drag, double, or triple events unless you want to.\n\
7492 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7493 lines separating windows, and scroll bars with imaginary keys\n\
7494 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7496 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7497 function will process a switch-frame event if the user switches frames\n\
7498 before typing anything. If the user switches frames in the middle of a\n\
7499 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7500 is nil, then the event will be put off until after the current key sequence.\n\
7502 `read-key-sequence' checks `function-key-map' for function key\n\
7503 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7504 `function-key-map' for more details.")
7505 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7508 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7510 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7511 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7512 Lisp_Object can_return_switch_frame
;
7514 Lisp_Object keybuf
[30];
7516 struct gcpro gcpro1
, gcpro2
;
7519 CHECK_STRING (prompt
, 0);
7522 bzero (keybuf
, sizeof keybuf
);
7524 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7526 if (NILP (continue_echo
))
7528 this_command_key_count
= 0;
7529 this_single_command_key_start
= 0;
7532 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7533 prompt
, ! NILP (dont_downcase_last
),
7534 ! NILP (can_return_switch_frame
), 0);
7542 return make_event_array (i
, keybuf
);
7545 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
7546 Sread_key_sequence_vector
, 1, 4, 0,
7547 "Like `read-key-sequence' but always return a vector.")
7548 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7549 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7550 Lisp_Object can_return_switch_frame
;
7552 Lisp_Object keybuf
[30];
7554 struct gcpro gcpro1
, gcpro2
;
7557 CHECK_STRING (prompt
, 0);
7560 bzero (keybuf
, sizeof keybuf
);
7562 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7564 if (NILP (continue_echo
))
7566 this_command_key_count
= 0;
7567 this_single_command_key_start
= 0;
7570 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7571 prompt
, ! NILP (dont_downcase_last
),
7572 ! NILP (can_return_switch_frame
), 0);
7580 return Fvector (i
, keybuf
);
7583 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7584 "Execute CMD as an editor command.\n\
7585 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7586 Optional second arg RECORD-FLAG non-nil\n\
7587 means unconditionally put this command in `command-history'.\n\
7588 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7589 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7590 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7591 The argument SPECIAL, if non-nil, means that this command is executing\n\
7592 a special event, so ignore the prefix argument and don't clear it.")
7593 (cmd
, record_flag
, keys
, special
)
7594 Lisp_Object cmd
, record_flag
, keys
, special
;
7596 register Lisp_Object final
;
7597 register Lisp_Object tem
;
7598 Lisp_Object prefixarg
;
7599 struct backtrace backtrace
;
7600 extern int debug_on_next_call
;
7602 debug_on_next_call
= 0;
7606 prefixarg
= current_kboard
->Vprefix_arg
;
7607 Vcurrent_prefix_arg
= prefixarg
;
7608 current_kboard
->Vprefix_arg
= Qnil
;
7615 tem
= Fget (cmd
, Qdisabled
);
7616 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7618 tem
= Fsymbol_value (Qdisabled_command_hook
);
7620 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7626 final
= Findirect_function (cmd
);
7628 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7630 struct gcpro gcpro1
, gcpro2
;
7632 GCPRO2 (cmd
, prefixarg
);
7633 do_autoload (final
, cmd
);
7640 if (STRINGP (final
) || VECTORP (final
))
7642 /* If requested, place the macro in the command history. For
7643 other sorts of commands, call-interactively takes care of
7645 if (!NILP (record_flag
))
7648 = Fcons (Fcons (Qexecute_kbd_macro
,
7649 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7652 /* Don't keep command history around forever. */
7653 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
7655 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
7657 XCONS (tem
)->cdr
= Qnil
;
7661 return Fexecute_kbd_macro (final
, prefixarg
);
7664 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7666 backtrace
.next
= backtrace_list
;
7667 backtrace_list
= &backtrace
;
7668 backtrace
.function
= &Qcall_interactively
;
7669 backtrace
.args
= &cmd
;
7670 backtrace
.nargs
= 1;
7671 backtrace
.evalargs
= 0;
7673 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7675 backtrace_list
= backtrace
.next
;
7681 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7683 "Read function name, then read its arguments and call it.")
7685 Lisp_Object prefixarg
;
7687 Lisp_Object function
;
7689 Lisp_Object saved_keys
;
7690 Lisp_Object bindings
, value
;
7691 struct gcpro gcpro1
, gcpro2
;
7693 saved_keys
= Fvector (this_command_key_count
,
7694 XVECTOR (this_command_keys
)->contents
);
7696 GCPRO2 (saved_keys
, prefixarg
);
7698 if (EQ (prefixarg
, Qminus
))
7700 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7701 strcpy (buf
, "C-u ");
7702 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7704 if (sizeof (int) == sizeof (EMACS_INT
))
7705 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7706 else if (sizeof (long) == sizeof (EMACS_INT
))
7707 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7711 else if (INTEGERP (prefixarg
))
7713 if (sizeof (int) == sizeof (EMACS_INT
))
7714 sprintf (buf
, "%d ", XINT (prefixarg
));
7715 else if (sizeof (long) == sizeof (EMACS_INT
))
7716 sprintf (buf
, "%ld ", XINT (prefixarg
));
7721 /* This isn't strictly correct if execute-extended-command
7722 is bound to anything else. Perhaps it should use
7723 this_command_keys? */
7724 strcat (buf
, "M-x ");
7726 /* Prompt with buf, and then read a string, completing from and
7727 restricting to the set of all defined commands. Don't provide
7728 any initial input. Save the command read on the extended-command
7730 function
= Fcompleting_read (build_string (buf
),
7731 Vobarray
, Qcommandp
,
7732 Qt
, Qnil
, Qextended_command_history
, Qnil
,
7735 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7736 error ("No command name given");
7738 /* Set this_command_keys to the concatenation of saved_keys and
7739 function, followed by a RET. */
7741 struct Lisp_String
*str
;
7745 this_command_key_count
= 0;
7746 this_single_command_key_start
= 0;
7748 keys
= XVECTOR (saved_keys
)->contents
;
7749 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7750 add_command_key (keys
[i
]);
7752 str
= XSTRING (function
);
7753 for (i
= 0; i
< str
->size
; i
++)
7754 add_command_key (Faref (function
, make_number (i
)));
7756 add_command_key (make_number ('\015'));
7761 function
= Fintern (function
, Qnil
);
7762 current_kboard
->Vprefix_arg
= prefixarg
;
7763 this_command
= function
;
7765 /* If enabled, show which key runs this command. */
7766 if (!NILP (Vsuggest_key_bindings
)
7767 && NILP (Vexecuting_macro
)
7768 && SYMBOLP (function
))
7769 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7775 GCPRO2 (bindings
, value
);
7776 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7778 /* If the command has a key binding, print it now. */
7779 if (!NILP (bindings
)
7780 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
7783 /* But first wait, and skip the message if there is input. */
7784 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7785 ? Vsuggest_key_bindings
: make_number (2)),
7787 && ! CONSP (Vunread_command_events
))
7789 Lisp_Object binding
;
7791 char *oldmessage
= echo_area_glyphs
;
7792 int oldmessage_len
= echo_area_glyphs_length
;
7793 int oldmultibyte
= message_enable_multibyte
;
7795 binding
= Fkey_description (bindings
);
7798 = (char *) alloca (XSYMBOL (function
)->name
->size
7799 + STRING_BYTES (XSTRING (binding
))
7801 sprintf (newmessage
, "You can run the command `%s' with %s",
7802 XSYMBOL (function
)->name
->data
,
7803 XSTRING (binding
)->data
);
7804 message2_nolog (newmessage
,
7805 strlen (newmessage
),
7806 STRING_MULTIBYTE (binding
));
7807 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7808 ? Vsuggest_key_bindings
: make_number (2)),
7810 message2_nolog (oldmessage
, oldmessage_len
, oldmultibyte
);
7814 RETURN_UNGCPRO (value
);
7817 /* Find the set of keymaps now active.
7818 Store into *MAPS_P a vector holding the various maps
7819 and return the number of them. The vector was malloc'd
7820 and the caller should free it. */
7823 current_active_maps (maps_p
)
7824 Lisp_Object
**maps_p
;
7826 Lisp_Object
*tmaps
, *maps
;
7829 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7830 if (!NILP (Voverriding_local_map_menu_flag
))
7832 /* Yes, use them (if non-nil) as well as the global map. */
7833 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7835 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7836 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7837 if (!NILP (Voverriding_local_map
))
7838 maps
[nmaps
++] = Voverriding_local_map
;
7842 /* No, so use major and minor mode keymaps. */
7843 nmaps
= current_minor_maps (NULL
, &tmaps
);
7844 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7845 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7846 #ifdef USE_TEXT_PROPERTIES
7847 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7849 maps
[nmaps
++] = current_buffer
->keymap
;
7852 maps
[nmaps
++] = current_global_map
;
7858 /* Return nonzero if input events are pending. */
7861 detect_input_pending ()
7864 get_input_pending (&input_pending
, 0);
7866 return input_pending
;
7869 /* Return nonzero if input events are pending, and run any pending timers. */
7872 detect_input_pending_run_timers (do_display
)
7875 int old_timers_run
= timers_run
;
7878 get_input_pending (&input_pending
, 1);
7880 if (old_timers_run
!= timers_run
&& do_display
)
7881 redisplay_preserve_echo_area ();
7883 return input_pending
;
7886 /* This is called in some cases before a possible quit.
7887 It cases the next call to detect_input_pending to recompute input_pending.
7888 So calling this function unnecessarily can't do any harm. */
7891 clear_input_pending ()
7896 /* Return nonzero if there are pending requeued events.
7897 This isn't used yet. The hope is to make wait_reading_process_input
7898 call it, and return return if it runs Lisp code that unreads something.
7899 The problem is, kbd_buffer_get_event needs to be fixed to know what
7900 to do in that case. It isn't trivial. */
7903 requeued_events_pending_p ()
7905 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7909 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7910 "T if command input is currently available with no waiting.\n\
7911 Actually, the value is nil only if we can be sure that no input is available.")
7914 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7917 get_input_pending (&input_pending
, 1);
7918 return input_pending
> 0 ? Qt
: Qnil
;
7921 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7922 "Return vector of last 100 events, not counting those from keyboard macros.")
7925 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7928 if (total_keys
< NUM_RECENT_KEYS
)
7929 return Fvector (total_keys
, keys
);
7932 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7933 bcopy (keys
+ recent_keys_index
,
7934 XVECTOR (val
)->contents
,
7935 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7937 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7938 recent_keys_index
* sizeof (Lisp_Object
));
7943 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7944 "Return the key sequence that invoked this command.\n\
7945 The value is a string or a vector.")
7948 return make_event_array (this_command_key_count
,
7949 XVECTOR (this_command_keys
)->contents
);
7952 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
7953 "Return the key sequence that invoked this command, as a vector.")
7956 return Fvector (this_command_key_count
,
7957 XVECTOR (this_command_keys
)->contents
);
7960 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7961 Sthis_single_command_keys
, 0, 0, 0,
7962 "Return the key sequence that invoked this command.\n\
7963 Unlike `this-command-keys', this function's value\n\
7964 does not include prefix arguments.\n\
7965 The value is always a vector.")
7968 return Fvector (this_command_key_count
7969 - this_single_command_key_start
,
7970 (XVECTOR (this_command_keys
)->contents
7971 + this_single_command_key_start
));
7974 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7975 Sreset_this_command_lengths
, 0, 0, 0,
7976 "Used for complicated reasons in `universal-argument-other-key'.\n\
7978 `universal-argument-other-key' rereads the event just typed.\n\
7979 It then gets translated through `function-key-map'.\n\
7980 The translated event gets included in the echo area and in\n\
7981 the value of `this-command-keys' in addition to the raw original event.\n\
7982 That is not right.\n\
7984 Calling this function directs the translated event to replace\n\
7985 the original event, so that only one version of the event actually\n\
7986 appears in the echo area and in the value of `this-command-keys.'.")
7989 before_command_restore_flag
= 1;
7990 before_command_key_count_1
= before_command_key_count
;
7991 before_command_echo_length_1
= before_command_echo_length
;
7994 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7995 "Return the current depth in recursive edits.")
7999 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
8003 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
8004 "FOpen dribble file: ",
8005 "Start writing all keyboard characters to a dribble file called FILE.\n\
8006 If FILE is nil, close any open dribble file.")
8017 file
= Fexpand_file_name (file
, Qnil
);
8018 dribble
= fopen (XSTRING (file
)->data
, "w");
8020 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
8025 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
8026 "Discard the contents of the terminal input buffer.\n\
8027 Also cancel any kbd macro being defined.")
8030 current_kboard
->defining_kbd_macro
= Qnil
;
8031 update_mode_lines
++;
8033 Vunread_command_events
= Qnil
;
8034 unread_command_char
= -1;
8036 discard_tty_input ();
8038 /* Without the cast, GCC complains that this assignment loses the
8039 volatile qualifier of kbd_store_ptr. Is there anything wrong
8041 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
8042 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8048 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
8049 "Stop Emacs and return to superior process. You can resume later.\n\
8050 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
8051 control, run a subshell instead.\n\n\
8052 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
8053 to be read as terminal input by Emacs's parent, after suspension.\n\
8055 Before suspending, run the normal hook `suspend-hook'.\n\
8056 After resumption run the normal hook `suspend-resume-hook'.\n\
8058 Some operating systems cannot stop the Emacs process and resume it later.\n\
8059 On such systems, Emacs starts a subshell instead of suspending.")
8061 Lisp_Object stuffstring
;
8064 int count
= specpdl_ptr
- specpdl
;
8065 int old_height
, old_width
;
8067 struct gcpro gcpro1
, gcpro2
;
8069 if (!NILP (stuffstring
))
8070 CHECK_STRING (stuffstring
, 0);
8072 /* Run the functions in suspend-hook. */
8073 if (!NILP (Vrun_hooks
))
8074 call1 (Vrun_hooks
, intern ("suspend-hook"));
8076 GCPRO1 (stuffstring
);
8077 get_frame_size (&old_width
, &old_height
);
8079 /* sys_suspend can get an error if it tries to fork a subshell
8080 and the system resources aren't available for that. */
8081 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
8083 stuff_buffered_input (stuffstring
);
8088 unbind_to (count
, Qnil
);
8090 /* Check if terminal/window size has changed.
8091 Note that this is not useful when we are running directly
8092 with a window system; but suspend should be disabled in that case. */
8093 get_frame_size (&width
, &height
);
8094 if (width
!= old_width
|| height
!= old_height
)
8095 change_frame_size (selected_frame
, height
, width
, 0, 0);
8097 /* Run suspend-resume-hook. */
8098 if (!NILP (Vrun_hooks
))
8099 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
8105 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
8106 Then in any case stuff anything Emacs has read ahead and not used. */
8109 stuff_buffered_input (stuffstring
)
8110 Lisp_Object stuffstring
;
8112 /* stuff_char works only in BSD, versions 4.2 and up. */
8115 register unsigned char *p
;
8117 if (STRINGP (stuffstring
))
8121 p
= XSTRING (stuffstring
)->data
;
8122 count
= STRING_BYTES (XSTRING (stuffstring
));
8127 /* Anything we have read ahead, put back for the shell to read. */
8128 /* ?? What should this do when we have multiple keyboards??
8129 Should we ignore anything that was typed in at the "wrong" kboard? */
8130 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
8132 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
8133 kbd_fetch_ptr
= kbd_buffer
;
8134 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
8135 stuff_char (kbd_fetch_ptr
->code
);
8136 kbd_fetch_ptr
->kind
= no_event
;
8137 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
8143 #endif /* BSD_SYSTEM and not BSD4_1 */
8147 set_waiting_for_input (time_to_clear
)
8148 EMACS_TIME
*time_to_clear
;
8150 input_available_clear_time
= time_to_clear
;
8152 /* Tell interrupt_signal to throw back to read_char, */
8153 waiting_for_input
= 1;
8155 /* If interrupt_signal was called before and buffered a C-g,
8156 make it run again now, to avoid timing error. */
8157 if (!NILP (Vquit_flag
))
8158 quit_throw_to_read_char ();
8162 clear_waiting_for_input ()
8164 /* Tell interrupt_signal not to throw back to read_char, */
8165 waiting_for_input
= 0;
8166 input_available_clear_time
= 0;
8169 /* This routine is called at interrupt level in response to C-G.
8170 If interrupt_input, this is the handler for SIGINT.
8171 Otherwise, it is called from kbd_buffer_store_event,
8172 in handling SIGIO or SIGTINT.
8174 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
8175 immediately throw back to read_char.
8177 Otherwise it sets the Lisp variable quit-flag not-nil.
8178 This causes eval to throw, when it gets a chance.
8179 If quit-flag is already non-nil, it stops the job right away. */
8182 interrupt_signal (signalnum
) /* If we don't have an argument, */
8183 int signalnum
; /* some compilers complain in signal calls. */
8186 /* Must preserve main program's value of errno. */
8187 int old_errno
= errno
;
8189 #if defined (USG) && !defined (POSIX_SIGNALS)
8190 if (!read_socket_hook
&& NILP (Vwindow_system
))
8192 /* USG systems forget handlers when they are used;
8193 must reestablish each time */
8194 signal (SIGINT
, interrupt_signal
);
8195 signal (SIGQUIT
, interrupt_signal
);
8201 if (!NILP (Vquit_flag
)
8202 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
8204 /* If SIGINT isn't blocked, don't let us be interrupted by
8205 another SIGINT, it might be harmful due to non-reentrancy
8206 in I/O functions. */
8207 sigblock (sigmask (SIGINT
));
8212 #ifdef SIGTSTP /* Support possible in later USG versions */
8214 * On systems which can suspend the current process and return to the original
8215 * shell, this command causes the user to end up back at the shell.
8216 * The "Auto-save" and "Abort" questions are not asked until
8217 * the user elects to return to emacs, at which point he can save the current
8218 * job and either dump core or continue.
8223 if (sys_suspend () == -1)
8225 printf ("Not running as a subprocess;\n");
8226 printf ("you can continue or abort.\n");
8229 /* Perhaps should really fork an inferior shell?
8230 But that would not provide any way to get back
8231 to the original shell, ever. */
8232 printf ("No support for stopping a process on this operating system;\n");
8233 printf ("you can continue or abort.\n");
8234 #endif /* not VMS */
8235 #endif /* not SIGTSTP */
8237 /* We must remain inside the screen area when the internal terminal
8238 is used. Note that [Enter] is not echoed by dos. */
8241 /* It doesn't work to autosave while GC is in progress;
8242 the code used for auto-saving doesn't cope with the mark bit. */
8243 if (!gc_in_progress
)
8245 printf ("Auto-save? (y or n) ");
8247 if (((c
= getchar ()) & ~040) == 'Y')
8249 Fdo_auto_save (Qt
, Qnil
);
8251 printf ("\r\nAuto-save done");
8252 #else /* not MSDOS */
8253 printf ("Auto-save done\n");
8254 #endif /* not MSDOS */
8256 while (c
!= '\n') c
= getchar ();
8260 /* During GC, it must be safe to reenable quitting again. */
8261 Vinhibit_quit
= Qnil
;
8264 #endif /* not MSDOS */
8265 printf ("Garbage collection in progress; cannot auto-save now\r\n");
8266 printf ("but will instead do a real quit after garbage collection ends\r\n");
8271 printf ("\r\nAbort? (y or n) ");
8272 #else /* not MSDOS */
8274 printf ("Abort (and enter debugger)? (y or n) ");
8276 printf ("Abort (and dump core)? (y or n) ");
8277 #endif /* not VMS */
8278 #endif /* not MSDOS */
8280 if (((c
= getchar ()) & ~040) == 'Y')
8282 while (c
!= '\n') c
= getchar ();
8284 printf ("\r\nContinuing...\r\n");
8285 #else /* not MSDOS */
8286 printf ("Continuing...\n");
8287 #endif /* not MSDOS */
8294 /* If executing a function that wants to be interrupted out of
8295 and the user has not deferred quitting by binding `inhibit-quit'
8296 then quit right away. */
8297 if (immediate_quit
&& NILP (Vinhibit_quit
))
8299 struct gl_state_s saved
;
8300 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8305 GCPRO4 (saved
.object
, saved
.global_code
,
8306 saved
.current_syntax_table
, saved
.old_prop
);
8307 Fsignal (Qquit
, Qnil
);
8312 /* Else request quit when it's safe */
8316 if (waiting_for_input
&& !echoing
)
8317 quit_throw_to_read_char ();
8322 /* Handle a C-g by making read_char return C-g. */
8325 quit_throw_to_read_char ()
8327 quit_error_check ();
8329 /* Prevent another signal from doing this before we finish. */
8330 clear_waiting_for_input ();
8333 Vunread_command_events
= Qnil
;
8334 unread_command_char
= -1;
8336 #if 0 /* Currently, sit_for is called from read_char without turning
8337 off polling. And that can call set_waiting_for_input.
8338 It seems to be harmless. */
8339 #ifdef POLL_FOR_INPUT
8340 /* May be > 1 if in recursive minibuffer. */
8341 if (poll_suppress_count
== 0)
8345 if (FRAMEP (internal_last_event_frame
)
8346 && XFRAME (internal_last_event_frame
) != selected_frame
)
8347 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
8350 _longjmp (getcjmp
, 1);
8353 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
8354 "Set mode of reading keyboard input.\n\
8355 First arg INTERRUPT non-nil means use input interrupts;\n\
8356 nil means use CBREAK mode.\n\
8357 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
8358 (no effect except in CBREAK mode).\n\
8359 Third arg META t means accept 8-bit input (for a Meta key).\n\
8360 META nil means ignore the top bit, on the assumption it is parity.\n\
8361 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
8362 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
8363 See also `current-input-mode'.")
8364 (interrupt
, flow
, meta
, quit
)
8365 Lisp_Object interrupt
, flow
, meta
, quit
;
8368 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
8369 error ("set-input-mode: QUIT must be an ASCII character");
8371 #ifdef POLL_FOR_INPUT
8376 /* this causes startup screen to be restored and messes with the mouse */
8381 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8382 if (read_socket_hook
)
8384 /* When using X, don't give the user a real choice,
8385 because we haven't implemented the mechanisms to support it. */
8386 #ifdef NO_SOCK_SIGIO
8387 interrupt_input
= 0;
8388 #else /* not NO_SOCK_SIGIO */
8389 interrupt_input
= 1;
8390 #endif /* NO_SOCK_SIGIO */
8393 interrupt_input
= !NILP (interrupt
);
8394 #else /* not SIGIO */
8395 interrupt_input
= 0;
8396 #endif /* not SIGIO */
8398 /* Our VMS input only works by interrupts, as of now. */
8400 interrupt_input
= 1;
8403 flow_control
= !NILP (flow
);
8406 else if (EQ (meta
, Qt
))
8411 /* Don't let this value be out of range. */
8412 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
8418 #ifdef POLL_FOR_INPUT
8419 poll_suppress_count
= 1;
8425 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
8426 "Return information about the way Emacs currently reads keyboard input.\n\
8427 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
8428 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
8429 nil, Emacs is using CBREAK mode.\n\
8430 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
8431 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
8432 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
8433 META nil means ignoring the top bit, on the assumption it is parity.\n\
8434 META is neither t nor nil if accepting 8-bit input and using\n\
8435 all 8 bits as the character code.\n\
8436 QUIT is the character Emacs currently uses to quit.\n\
8437 The elements of this list correspond to the arguments of\n\
8443 val
[0] = interrupt_input
? Qt
: Qnil
;
8444 val
[1] = flow_control
? Qt
: Qnil
;
8445 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
8446 XSETFASTINT (val
[3], quit_char
);
8448 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
8453 * Set up a new kboard object with reasonable initial values.
8459 kb
->Voverriding_terminal_local_map
= Qnil
;
8460 kb
->Vlast_command
= Qnil
;
8461 kb
->Vprefix_arg
= Qnil
;
8462 kb
->kbd_queue
= Qnil
;
8463 kb
->kbd_queue_has_data
= 0;
8464 kb
->immediate_echo
= 0;
8465 kb
->echoptr
= kb
->echobuf
;
8466 kb
->echo_after_prompt
= -1;
8467 kb
->kbd_macro_buffer
= 0;
8468 kb
->kbd_macro_bufsize
= 0;
8469 kb
->defining_kbd_macro
= Qnil
;
8470 kb
->Vlast_kbd_macro
= Qnil
;
8471 kb
->reference_count
= 0;
8472 kb
->Vsystem_key_alist
= Qnil
;
8473 kb
->system_key_syms
= Qnil
;
8474 kb
->Vdefault_minibuffer_frame
= Qnil
;
8478 * Destroy the contents of a kboard object, but not the object itself.
8479 * We use this just before deleting it, or if we're going to initialize
8486 if (kb
->kbd_macro_buffer
)
8487 xfree (kb
->kbd_macro_buffer
);
8496 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
8499 *kbp
= kb
->next_kboard
;
8508 /* This is correct before outermost invocation of the editor loop */
8509 command_loop_level
= -1;
8511 quit_char
= Ctl ('g');
8512 Vunread_command_events
= Qnil
;
8513 unread_command_char
= -1;
8514 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
8516 recent_keys_index
= 0;
8517 kbd_fetch_ptr
= kbd_buffer
;
8518 kbd_store_ptr
= kbd_buffer
;
8519 kbd_buffer_frame_or_window
8520 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8522 do_mouse_tracking
= Qnil
;
8526 /* This means that command_loop_1 won't try to select anything the first
8528 internal_last_event_frame
= Qnil
;
8529 Vlast_event_frame
= internal_last_event_frame
;
8532 current_kboard
= initial_kboard
;
8534 wipe_kboard (current_kboard
);
8535 init_kboard (current_kboard
);
8538 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8540 kbd_buffer_frame_or_window
8541 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8542 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
8544 signal (SIGINT
, interrupt_signal
);
8545 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
8546 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
8547 SIGQUIT and we can't tell which one it will give us. */
8548 signal (SIGQUIT
, interrupt_signal
);
8549 #endif /* HAVE_TERMIO */
8551 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8553 if (!noninteractive
)
8554 signal (SIGIO
, input_available_signal
);
8557 /* Use interrupt input by default, if it works and noninterrupt input
8558 has deficiencies. */
8560 #ifdef INTERRUPT_INPUT
8561 interrupt_input
= 1;
8563 interrupt_input
= 0;
8566 /* Our VMS input only works by interrupts, as of now. */
8568 interrupt_input
= 1;
8574 if (keyboard_init_hook
)
8575 (*keyboard_init_hook
) ();
8577 #ifdef POLL_FOR_INPUT
8578 poll_suppress_count
= 1;
8583 /* This type's only use is in syms_of_keyboard, to initialize the
8584 event header symbols and put properties on them. */
8591 struct event_head head_table
[] = {
8592 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8593 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8594 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8595 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8596 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8597 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8603 staticpro (&item_properties
);
8604 item_properties
= Qnil
;
8606 Qtimer_event_handler
= intern ("timer-event-handler");
8607 staticpro (&Qtimer_event_handler
);
8609 Qdisabled_command_hook
= intern ("disabled-command-hook");
8610 staticpro (&Qdisabled_command_hook
);
8612 Qself_insert_command
= intern ("self-insert-command");
8613 staticpro (&Qself_insert_command
);
8615 Qforward_char
= intern ("forward-char");
8616 staticpro (&Qforward_char
);
8618 Qbackward_char
= intern ("backward-char");
8619 staticpro (&Qbackward_char
);
8621 Qdisabled
= intern ("disabled");
8622 staticpro (&Qdisabled
);
8624 Qundefined
= intern ("undefined");
8625 staticpro (&Qundefined
);
8627 Qpre_command_hook
= intern ("pre-command-hook");
8628 staticpro (&Qpre_command_hook
);
8630 Qpost_command_hook
= intern ("post-command-hook");
8631 staticpro (&Qpost_command_hook
);
8633 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8634 staticpro (&Qpost_command_idle_hook
);
8636 Qdeferred_action_function
= intern ("deferred-action-function");
8637 staticpro (&Qdeferred_action_function
);
8639 Qcommand_hook_internal
= intern ("command-hook-internal");
8640 staticpro (&Qcommand_hook_internal
);
8642 Qfunction_key
= intern ("function-key");
8643 staticpro (&Qfunction_key
);
8644 Qmouse_click
= intern ("mouse-click");
8645 staticpro (&Qmouse_click
);
8647 Qmouse_wheel
= intern ("mouse-wheel");
8648 staticpro (&Qmouse_wheel
);
8650 Qdrag_n_drop
= intern ("drag-n-drop");
8651 staticpro (&Qdrag_n_drop
);
8653 Qmenu_enable
= intern ("menu-enable");
8654 staticpro (&Qmenu_enable
);
8655 Qmenu_alias
= intern ("menu-alias");
8656 staticpro (&Qmenu_alias
);
8657 QCenable
= intern (":enable");
8658 staticpro (&QCenable
);
8659 QCvisible
= intern (":visible");
8660 staticpro (&QCvisible
);
8661 QCfilter
= intern (":filter");
8662 staticpro (&QCfilter
);
8663 QCbutton
= intern (":button");
8664 staticpro (&QCbutton
);
8665 QCkeys
= intern (":keys");
8666 staticpro (&QCkeys
);
8667 QCkey_sequence
= intern (":key-sequence");
8668 staticpro (&QCkey_sequence
);
8669 QCtoggle
= intern (":toggle");
8670 staticpro (&QCtoggle
);
8671 QCradio
= intern (":radio");
8672 staticpro (&QCradio
);
8674 Qmode_line
= intern ("mode-line");
8675 staticpro (&Qmode_line
);
8676 Qvertical_line
= intern ("vertical-line");
8677 staticpro (&Qvertical_line
);
8678 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8679 staticpro (&Qvertical_scroll_bar
);
8680 Qmenu_bar
= intern ("menu-bar");
8681 staticpro (&Qmenu_bar
);
8683 Qabove_handle
= intern ("above-handle");
8684 staticpro (&Qabove_handle
);
8685 Qhandle
= intern ("handle");
8686 staticpro (&Qhandle
);
8687 Qbelow_handle
= intern ("below-handle");
8688 staticpro (&Qbelow_handle
);
8689 Qup
= intern ("up");
8691 Qdown
= intern ("down");
8694 Qevent_kind
= intern ("event-kind");
8695 staticpro (&Qevent_kind
);
8696 Qevent_symbol_elements
= intern ("event-symbol-elements");
8697 staticpro (&Qevent_symbol_elements
);
8698 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8699 staticpro (&Qevent_symbol_element_mask
);
8700 Qmodifier_cache
= intern ("modifier-cache");
8701 staticpro (&Qmodifier_cache
);
8703 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8704 staticpro (&Qrecompute_lucid_menubar
);
8705 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8706 staticpro (&Qactivate_menubar_hook
);
8708 Qpolling_period
= intern ("polling-period");
8709 staticpro (&Qpolling_period
);
8712 struct event_head
*p
;
8714 for (p
= head_table
;
8715 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8718 *p
->var
= intern (p
->name
);
8720 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8721 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8725 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8726 staticpro (&button_down_location
);
8730 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8732 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8733 for (i
= 0; i
< len
; i
++)
8734 if (modifier_names
[i
])
8735 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8736 staticpro (&modifier_symbols
);
8739 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8740 staticpro (&recent_keys
);
8742 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8743 staticpro (&this_command_keys
);
8745 Qextended_command_history
= intern ("extended-command-history");
8746 Fset (Qextended_command_history
, Qnil
);
8747 staticpro (&Qextended_command_history
);
8749 kbd_buffer_frame_or_window
8750 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8751 staticpro (&kbd_buffer_frame_or_window
);
8753 accent_key_syms
= Qnil
;
8754 staticpro (&accent_key_syms
);
8756 func_key_syms
= Qnil
;
8757 staticpro (&func_key_syms
);
8760 staticpro (&mouse_syms
);
8763 mouse_wheel_syms
= Qnil
;
8764 staticpro (&mouse_wheel_syms
);
8766 drag_n_drop_syms
= Qnil
;
8767 staticpro (&drag_n_drop_syms
);
8770 unread_switch_frame
= Qnil
;
8771 staticpro (&unread_switch_frame
);
8773 internal_last_event_frame
= Qnil
;
8774 staticpro (&internal_last_event_frame
);
8776 read_key_sequence_cmd
= Qnil
;
8777 staticpro (&read_key_sequence_cmd
);
8779 defsubr (&Sevent_convert_list
);
8780 defsubr (&Sread_key_sequence
);
8781 defsubr (&Sread_key_sequence_vector
);
8782 defsubr (&Srecursive_edit
);
8784 defsubr (&Strack_mouse
);
8786 defsubr (&Sinput_pending_p
);
8787 defsubr (&Scommand_execute
);
8788 defsubr (&Srecent_keys
);
8789 defsubr (&Sthis_command_keys
);
8790 defsubr (&Sthis_command_keys_vector
);
8791 defsubr (&Sthis_single_command_keys
);
8792 defsubr (&Sreset_this_command_lengths
);
8793 defsubr (&Ssuspend_emacs
);
8794 defsubr (&Sabort_recursive_edit
);
8795 defsubr (&Sexit_recursive_edit
);
8796 defsubr (&Srecursion_depth
);
8797 defsubr (&Stop_level
);
8798 defsubr (&Sdiscard_input
);
8799 defsubr (&Sopen_dribble_file
);
8800 defsubr (&Sset_input_mode
);
8801 defsubr (&Scurrent_input_mode
);
8802 defsubr (&Sexecute_extended_command
);
8804 DEFVAR_LISP ("last-command-char", &last_command_char
,
8805 "Last input event that was part of a command.");
8807 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8808 "Last input event that was part of a command.");
8810 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8811 "Last input event in a command, except for mouse menu events.\n\
8812 Mouse menus give back keys that don't look like mouse events;\n\
8813 this variable holds the actual mouse event that led to the menu,\n\
8814 so that you can determine whether the command was run by mouse or not.");
8816 DEFVAR_LISP ("last-input-char", &last_input_char
,
8817 "Last input event.");
8819 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8820 "Last input event.");
8822 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8823 "List of objects to be read as next command input events.");
8825 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8826 "If not -1, an object to be read as next command input event.");
8828 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8829 "Meta-prefix character code. Meta-foo as command input\n\
8830 turns into this character followed by foo.");
8831 XSETINT (meta_prefix_char
, 033);
8833 DEFVAR_KBOARD ("last-command", Vlast_command
,
8834 "The last command executed. Normally a symbol with a function definition,\n\
8835 but can be whatever was found in the keymap, or whatever the variable\n\
8836 `this-command' was set to by that command.\n\
8838 The value `mode-exit' is special; it means that the previous command\n\
8839 read an event that told it to exit, and it did so and unread that event.\n\
8840 In other words, the present command is the event that made the previous\n\
8843 The value `kill-region' is special; it means that the previous command\n\
8844 was a kill command.");
8846 DEFVAR_LISP ("this-command", &this_command
,
8847 "The command now being executed.\n\
8848 The command can set this variable; whatever is put here\n\
8849 will be in `last-command' during the following command.");
8850 this_command
= Qnil
;
8852 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8853 "*Number of keyboard input characters between auto-saves.\n\
8854 Zero means disable autosaving due to number of characters typed.");
8855 auto_save_interval
= 300;
8857 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8858 "*Number of seconds idle time before auto-save.\n\
8859 Zero or nil means disable auto-saving due to idleness.\n\
8860 After auto-saving due to this many seconds of idle time,\n\
8861 Emacs also does a garbage collection if that seems to be warranted.");
8862 XSETFASTINT (Vauto_save_timeout
, 30);
8864 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8865 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8866 echo_keystrokes
= 1;
8868 DEFVAR_INT ("polling-period", &polling_period
,
8869 "*Interval between polling for input during Lisp execution.\n\
8870 The reason for polling is to make C-g work to stop a running program.\n\
8871 Polling is needed only when using X windows and SIGIO does not work.\n\
8872 Polling is automatically disabled in all other cases.");
8875 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8876 "*Maximum time between mouse clicks to make a double-click.\n\
8877 Measured in milliseconds. nil means disable double-click recognition;\n\
8878 t means double-clicks have no time limit and are detected\n\
8879 by position only.");
8880 Vdouble_click_time
= make_number (500);
8882 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8883 "*Non-nil means inhibit local map menu bar menus.");
8884 inhibit_local_menu_bar_menus
= 0;
8886 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8887 "Number of complete key sequences read as input so far.\n\
8888 This includes key sequences read from keyboard macros.\n\
8889 The number is effectively the number of interactive command invocations.");
8892 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8893 "Number of input events read from the keyboard so far.\n\
8894 This does not include events generated by keyboard macros.");
8895 num_nonmacro_input_events
= 0;
8897 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8898 "The frame in which the most recently read event occurred.\n\
8899 If the last event came from a keyboard macro, this is set to `macro'.");
8900 Vlast_event_frame
= Qnil
;
8902 /* This variable is set up in sysdep.c. */
8903 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8904 "The ERASE character as set by the user with stty.");
8906 DEFVAR_LISP ("help-char", &Vhelp_char
,
8907 "Character to recognize as meaning Help.\n\
8908 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8909 If the value of `help-form' is nil, this char can be read normally.");
8910 XSETINT (Vhelp_char
, Ctl ('H'));
8912 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8913 "List of input events to recognize as meaning Help.\n\
8914 These work just like the value of `help-char' (see that).");
8915 Vhelp_event_list
= Qnil
;
8917 DEFVAR_LISP ("help-form", &Vhelp_form
,
8918 "Form to execute when character `help-char' is read.\n\
8919 If the form returns a string, that string is displayed.\n\
8920 If `help-form' is nil, the help char is not recognized.");
8923 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8924 "Command to run when `help-char' character follows a prefix key.\n\
8925 This command is used only when there is no actual binding\n\
8926 for that character after that prefix key.");
8927 Vprefix_help_command
= Qnil
;
8929 DEFVAR_LISP ("top-level", &Vtop_level
,
8930 "Form to evaluate when Emacs starts up.\n\
8931 Useful to set before you dump a modified Emacs.");
8934 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8935 "Translate table for keyboard input, or nil.\n\
8936 Each character is looked up in this string and the contents used instead.\n\
8937 The value may be a string, a vector, or a char-table.\n\
8938 If it is a string or vector of length N,\n\
8939 character codes N and up are untranslated.\n\
8940 In a vector or a char-table, an element which is nil means \"no translation\".");
8941 Vkeyboard_translate_table
= Qnil
;
8943 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8944 "Non-nil means to always spawn a subshell instead of suspending,\n\
8945 even if the operating system has support for stopping a process.");
8948 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8949 "Non-nil means prompt with menus when appropriate.\n\
8950 This is done when reading from a keymap that has a prompt string,\n\
8951 for elements that have prompt strings.\n\
8952 The menu is displayed on the screen\n\
8953 if X menus were enabled at configuration\n\
8954 time and the previous event was a mouse click prefix key.\n\
8955 Otherwise, menu prompting uses the echo area.");
8958 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8959 "Character to see next line of menu prompt.\n\
8960 Type this character while in a menu prompt to rotate around the lines of it.");
8961 XSETINT (menu_prompt_more_char
, ' ');
8963 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8964 "A mask of additional modifier keys to use with every keyboard character.\n\
8965 Emacs applies the modifiers of the character stored here to each keyboard\n\
8966 character it reads. For example, after evaluating the expression\n\
8967 (setq extra-keyboard-modifiers ?\\C-x)\n\
8968 all input characters will have the control modifier applied to them.\n\
8970 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8971 not count as a control character; rather, it counts as a character\n\
8972 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8973 cancels any modification.");
8974 extra_keyboard_modifiers
= 0;
8976 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8977 "If an editing command sets this to t, deactivate the mark afterward.\n\
8978 The command loop sets this to nil before each command,\n\
8979 and tests the value when the command returns.\n\
8980 Buffer modification stores t in this variable.");
8981 Vdeactivate_mark
= Qnil
;
8983 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8984 "Temporary storage of pre-command-hook or post-command-hook.");
8985 Vcommand_hook_internal
= Qnil
;
8987 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8988 "Normal hook run before each command is executed.\n\
8989 Errors running the hook are caught and ignored.");
8990 Vpre_command_hook
= Qnil
;
8992 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8993 "Normal hook run after each command is executed.\n\
8994 Errors running the hook are caught and ignored.");
8995 Vpost_command_hook
= Qnil
;
8997 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8998 "Normal hook run after each command is executed, if idle.\n\
8999 Errors running the hook are caught and ignored.\n\
9000 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
9001 Vpost_command_idle_hook
= Qnil
;
9003 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
9004 "Delay time before running `post-command-idle-hook'.\n\
9005 This is measured in microseconds.");
9006 post_command_idle_delay
= 100000;
9009 DEFVAR_LISP ("echo-area-clear-hook", ...,
9010 "Normal hook run when clearing the echo area.");
9012 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
9013 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
9015 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
9016 "t means menu bar, specified Lucid style, needs to be recomputed.");
9017 Vlucid_menu_bar_dirty_flag
= Qnil
;
9019 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
9020 "List of menu bar items to move to the end of the menu bar.\n\
9021 The elements of the list are event types that may have menu bar bindings.");
9022 Vmenu_bar_final_items
= Qnil
;
9024 DEFVAR_KBOARD ("overriding-terminal-local-map",
9025 Voverriding_terminal_local_map
,
9026 "Per-terminal keymap that overrides all other local keymaps.\n\
9027 If this variable is non-nil, it is used as a keymap instead of the\n\
9028 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
9029 This variable is intended to let commands such as `universal-argumemnt'\n\
9030 set up a different keymap for reading the next command.");
9032 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
9033 "Keymap that overrides all other local keymaps.\n\
9034 If this variable is non-nil, it is used as a keymap instead of the\n\
9035 buffer's local map, and the minor mode keymaps and text property keymaps.");
9036 Voverriding_local_map
= Qnil
;
9038 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
9039 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
9040 Otherwise, the menu bar continues to reflect the buffer's local map\n\
9041 and the minor mode maps regardless of `overriding-local-map'.");
9042 Voverriding_local_map_menu_flag
= Qnil
;
9044 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
9045 "Keymap defining bindings for special events to execute at low level.");
9046 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
9048 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
9049 "*Non-nil means generate motion events for mouse motion.");
9051 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
9052 "Alist of system-specific X windows key symbols.\n\
9053 Each element should have the form (N . SYMBOL) where N is the\n\
9054 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
9055 and SYMBOL is its name.");
9057 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
9058 "List of deferred actions to be performed at a later time.\n\
9059 The precise format isn't relevant here; we just check whether it is nil.");
9060 Vdeferred_action_list
= Qnil
;
9062 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
9063 "Function to call to handle deferred actions, after each command.\n\
9064 This function is called with no arguments after each command\n\
9065 whenever `deferred-action-list' is non-nil.");
9066 Vdeferred_action_function
= Qnil
;
9068 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
9069 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
9070 The value can be a length of time to show the message for.\n\
9071 If the value is non-nil and not a number, we wait 2 seconds.");
9072 Vsuggest_key_bindings
= Qt
;
9074 DEFVAR_LISP ("timer-list", &Vtimer_list
,
9075 "List of active absolute time timers in order of increasing time");
9078 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
9079 "List of active idle-time timers in order of increasing time");
9080 Vtimer_idle_list
= Qnil
;
9086 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
9087 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
9088 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
9089 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
9090 initial_define_key (meta_map
, 'x', "execute-extended-command");
9092 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
9093 "handle-delete-frame");
9094 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
9096 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",