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"
39 #include "intervals.h"
40 #include "blockinput.h"
49 #include <sys/ioctl.h>
51 #endif /* not MSDOS */
53 #include "syssignal.h"
56 /* This is to get the definitions of the XK_ symbols. */
63 #endif /* HAVE_NTGUI */
65 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
70 /* Variables for blockinput.h: */
72 /* Non-zero if interrupt input is blocked right now. */
73 int interrupt_input_blocked
;
75 /* Nonzero means an input interrupt has arrived
76 during the current critical section. */
77 int interrupt_input_pending
;
80 /* File descriptor to use for input. */
83 #ifdef HAVE_WINDOW_SYSTEM
84 /* Make all keyboard buffers much bigger when using X windows. */
85 #define KBD_BUFFER_SIZE 4096
86 #else /* No X-windows, character input */
87 #define KBD_BUFFER_SIZE 256
88 #endif /* No X-windows */
90 /* Following definition copied from eval.c */
94 struct backtrace
*next
;
95 Lisp_Object
*function
;
96 Lisp_Object
*args
; /* Points to vector of args. */
97 int nargs
; /* length of vector. If nargs is UNEVALLED,
98 args points to slot holding list of
104 KBOARD
*initial_kboard
;
105 KBOARD
*current_kboard
;
109 KBOARD the_only_kboard
;
112 /* Non-nil disable property on a command means
113 do not execute it; call disabled-command-hook's value instead. */
114 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
116 #define NUM_RECENT_KEYS (100)
117 int recent_keys_index
; /* Index for storing next element into recent_keys */
118 int total_keys
; /* Total number of elements stored into recent_keys */
119 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
121 /* Vector holding the key sequence that invoked the current command.
122 It is reused for each command, and it may be longer than the current
123 sequence; this_command_key_count indicates how many elements
124 actually mean something.
125 It's easier to staticpro a single Lisp_Object than an array. */
126 Lisp_Object this_command_keys
;
127 int this_command_key_count
;
129 /* Number of elements of this_command_keys
130 that precede this key sequence. */
131 int this_single_command_key_start
;
133 /* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135 static int before_command_key_count
;
136 static int before_command_echo_length
;
137 /* Values of before_command_key_count and before_command_echo_length
138 saved by reset-this-command-lengths. */
139 static int before_command_key_count_1
;
140 static int before_command_echo_length_1
;
141 /* Flag set by reset-this-command-lengths,
142 saying to reset the lengths when add_command_key is called. */
143 static int before_command_restore_flag
;
145 extern int minbuf_level
;
147 extern int message_enable_multibyte
;
149 extern struct backtrace
*backtrace_list
;
151 /* Nonzero means do menu prompting. */
152 static int menu_prompting
;
154 /* Character to see next line of menu prompt. */
155 static Lisp_Object menu_prompt_more_char
;
157 /* For longjmp to where kbd input is being done. */
158 static jmp_buf getcjmp
;
160 /* True while doing kbd input. */
161 int waiting_for_input
;
163 /* True while displaying for echoing. Delays C-g throwing. */
166 /* True means we can start echoing at the next input pause
167 even though there is something in the echo area. */
168 static char *ok_to_echo_at_next_pause
;
170 /* Nonzero means disregard local maps for the menu bar. */
171 static int inhibit_local_menu_bar_menus
;
173 /* Nonzero means C-g should cause immediate error-signal. */
176 /* The user's ERASE setting. */
177 Lisp_Object Vtty_erase_char
;
179 /* Character to recognize as the help char. */
180 Lisp_Object Vhelp_char
;
182 /* List of other event types to recognize as meaning "help". */
183 Lisp_Object Vhelp_event_list
;
185 /* Form to execute when help char is typed. */
186 Lisp_Object Vhelp_form
;
188 /* Command to run when the help character follows a prefix key. */
189 Lisp_Object Vprefix_help_command
;
191 /* List of items that should move to the end of the menu bar. */
192 Lisp_Object Vmenu_bar_final_items
;
194 /* Non-nil means show the equivalent key-binding for
195 any M-x command that has one.
196 The value can be a length of time to show the message for.
197 If the value is non-nil and not a number, we wait 2 seconds. */
198 Lisp_Object Vsuggest_key_bindings
;
200 /* Character that causes a quit. Normally C-g.
202 If we are running on an ordinary terminal, this must be an ordinary
203 ASCII char, since we want to make it our interrupt character.
205 If we are not running on an ordinary terminal, it still needs to be
206 an ordinary ASCII char. This character needs to be recognized in
207 the input interrupt handler. At this point, the keystroke is
208 represented as a struct input_event, while the desired quit
209 character is specified as a lispy event. The mapping from struct
210 input_events to lispy events cannot run in an interrupt handler,
211 and the reverse mapping is difficult for anything but ASCII
214 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
218 extern Lisp_Object current_global_map
;
219 extern int minibuf_level
;
221 /* If non-nil, this is a map that overrides all other local maps. */
222 Lisp_Object Voverriding_local_map
;
224 /* If non-nil, Voverriding_local_map applies to the menu bar. */
225 Lisp_Object Voverriding_local_map_menu_flag
;
227 /* Keymap that defines special misc events that should
228 be processed immediately at a low level. */
229 Lisp_Object Vspecial_event_map
;
231 /* Current depth in recursive edits. */
232 int command_loop_level
;
234 /* Total number of times command_loop has read a key sequence. */
237 /* Last input character read as a command. */
238 Lisp_Object last_command_char
;
240 /* Last input character read as a command, not counting menus
241 reached by the mouse. */
242 Lisp_Object last_nonmenu_event
;
244 /* Last input character read for any purpose. */
245 Lisp_Object last_input_char
;
247 /* If not Qnil, a list of objects to be read as subsequent command input. */
248 Lisp_Object Vunread_command_events
;
250 /* If not -1, an event to be read as subsequent command input. */
251 int unread_command_char
;
253 /* If not Qnil, this is a switch-frame event which we decided to put
254 off until the end of a key sequence. This should be read as the
255 next command input, after any unread_command_events.
257 read_key_sequence uses this to delay switch-frame events until the
258 end of the key sequence; Fread_char uses it to put off switch-frame
259 events until a non-ASCII event is acceptable as input. */
260 Lisp_Object unread_switch_frame
;
262 /* A mask of extra modifier bits to put into every keyboard char. */
263 int extra_keyboard_modifiers
;
265 /* Char to use as prefix when a meta character is typed in.
266 This is bound on entry to minibuffer in case ESC is changed there. */
268 Lisp_Object meta_prefix_char
;
270 /* Last size recorded for a current buffer which is not a minibuffer. */
271 static int last_non_minibuf_size
;
273 /* Number of idle seconds before an auto-save and garbage collection. */
274 static Lisp_Object Vauto_save_timeout
;
276 /* Total number of times read_char has returned. */
277 int num_input_events
;
279 /* Total number of times read_char has returned, outside of macros. */
280 int num_nonmacro_input_events
;
282 /* Auto-save automatically when this many characters have been typed
283 since the last time. */
285 static int auto_save_interval
;
287 /* Value of num_nonmacro_input_events as of last auto save. */
291 /* The command being executed by the command loop.
292 Commands may set this, and the value set will be copied into
293 current_kboard->Vlast_command instead of the actual command. */
294 Lisp_Object this_command
;
296 /* The value of point when the last command was executed. */
297 int last_point_position
;
299 /* The buffer that was current when the last command was started. */
300 Lisp_Object last_point_position_buffer
;
302 /* The frame in which the last input event occurred, or Qmacro if the
303 last event came from a macro. We use this to determine when to
304 generate switch-frame events. This may be cleared by functions
305 like Fselect_frame, to make sure that a switch-frame event is
306 generated by the next character. */
307 Lisp_Object internal_last_event_frame
;
309 /* A user-visible version of the above, intended to allow users to
310 figure out where the last event came from, if the event doesn't
311 carry that information itself (i.e. if it was a character). */
312 Lisp_Object Vlast_event_frame
;
314 /* The timestamp of the last input event we received from the X server.
315 X Windows wants this for selection ownership. */
316 unsigned long last_event_timestamp
;
318 Lisp_Object Qself_insert_command
;
319 Lisp_Object Qforward_char
;
320 Lisp_Object Qbackward_char
;
321 Lisp_Object Qundefined
;
322 Lisp_Object Qtimer_event_handler
;
324 /* read_key_sequence stores here the command definition of the
325 key sequence that it reads. */
326 Lisp_Object read_key_sequence_cmd
;
328 /* Form to evaluate (if non-nil) when Emacs is started. */
329 Lisp_Object Vtop_level
;
331 /* User-supplied string to translate input characters through. */
332 Lisp_Object Vkeyboard_translate_table
;
334 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
335 extern Lisp_Object Vfunction_key_map
;
337 /* Another keymap that maps key sequences into key sequences.
338 This one takes precedence over ordinary definitions. */
339 extern Lisp_Object Vkey_translation_map
;
341 /* Non-nil means deactivate the mark at end of this command. */
342 Lisp_Object Vdeactivate_mark
;
344 /* Menu bar specified in Lucid Emacs fashion. */
346 Lisp_Object Vlucid_menu_bar_dirty_flag
;
347 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
349 Lisp_Object Qecho_area_clear_hook
;
351 /* Hooks to run before and after each command. */
352 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
353 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
354 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
355 /* Hook run after a command if there's no more input soon. */
356 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
358 /* Delay time in microseconds before running post-command-idle-hook. */
359 int post_command_idle_delay
;
361 /* List of deferred actions to be performed at a later time.
362 The precise format isn't relevant here; we just check whether it is nil. */
363 Lisp_Object Vdeferred_action_list
;
365 /* Function to call to handle deferred actions, when there are any. */
366 Lisp_Object Vdeferred_action_function
;
367 Lisp_Object Qdeferred_action_function
;
369 /* File in which we write all commands we read. */
372 /* Nonzero if input is available. */
375 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
376 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
380 extern char *pending_malloc_warning
;
382 /* Circular buffer for pre-read keyboard input. */
383 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
385 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
387 The interrupt-level event handlers will never enqueue an event on a
388 frame which is not in Vframe_list, and once an event is dequeued,
389 internal_last_event_frame or the event itself points to the frame.
392 But while the event is sitting in the queue, it's completely
393 unprotected. Suppose the user types one command which will run for
394 a while and then delete a frame, and then types another event at
395 the frame that will be deleted, before the command gets around to
396 it. Suppose there are no references to this frame elsewhere in
397 Emacs, and a GC occurs before the second event is dequeued. Now we
398 have an event referring to a freed frame, which will crash Emacs
401 Similar things happen when an event on a scroll bar is enqueued; the
402 window may be deleted while the event is in the queue.
404 So, we use this vector to protect the frame_or_window field in the
405 event queue. That way, they'll be dequeued as dead frames or
406 windows, but still valid lisp objects.
408 If kbd_buffer[i].kind != no_event, then
409 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
410 == kbd_buffer[i].frame_or_window. */
411 static Lisp_Object kbd_buffer_frame_or_window
;
413 /* Pointer to next available character in kbd_buffer.
414 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
415 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
416 next available char is in kbd_buffer[0]. */
417 static struct input_event
*kbd_fetch_ptr
;
419 /* Pointer to next place to store character in kbd_buffer. This
420 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
421 character should go in kbd_buffer[0]. */
422 static volatile struct input_event
*kbd_store_ptr
;
424 /* The above pair of variables forms a "queue empty" flag. When we
425 enqueue a non-hook event, we increment kbd_store_ptr. When we
426 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
427 there is input available iff the two pointers are not equal.
429 Why not just have a flag set and cleared by the enqueuing and
430 dequeuing functions? Such a flag could be screwed up by interrupts
431 at inopportune times. */
433 /* If this flag is non-nil, we check mouse_moved to see when the
434 mouse moves, and motion events will appear in the input stream.
435 Otherwise, mouse motion is ignored. */
436 static Lisp_Object do_mouse_tracking
;
438 /* Symbols to head events. */
439 Lisp_Object Qmouse_movement
;
440 Lisp_Object Qscroll_bar_movement
;
441 Lisp_Object Qswitch_frame
;
442 Lisp_Object Qdelete_frame
;
443 Lisp_Object Qiconify_frame
;
444 Lisp_Object Qmake_frame_visible
;
446 /* Symbols to denote kinds of events. */
447 Lisp_Object Qfunction_key
;
448 Lisp_Object Qmouse_click
;
450 Lisp_Object Qmouse_wheel
;
452 /* Lisp_Object Qmouse_movement; - also an event header */
454 /* Properties of event headers. */
455 Lisp_Object Qevent_kind
;
456 Lisp_Object Qevent_symbol_elements
;
458 Lisp_Object Qmenu_enable
;
460 /* An event header symbol HEAD may have a property named
461 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
462 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
463 mask of modifiers applied to it. If present, this is used to help
464 speed up parse_modifiers. */
465 Lisp_Object Qevent_symbol_element_mask
;
467 /* An unmodified event header BASE may have a property named
468 Qmodifier_cache, which is an alist mapping modifier masks onto
469 modified versions of BASE. If present, this helps speed up
471 Lisp_Object Qmodifier_cache
;
473 /* Symbols to use for parts of windows. */
474 Lisp_Object Qmode_line
;
475 Lisp_Object Qvertical_line
;
476 Lisp_Object Qvertical_scroll_bar
;
477 Lisp_Object Qmenu_bar
;
479 extern Lisp_Object Qmenu_enable
;
481 Lisp_Object
recursive_edit_unwind (), command_loop ();
482 Lisp_Object
Fthis_command_keys ();
483 Lisp_Object Qextended_command_history
;
484 EMACS_TIME
timer_check ();
486 extern char *x_get_keysym_name ();
488 static void record_menu_key ();
490 void swallow_events ();
492 Lisp_Object Qpolling_period
;
494 /* List of absolute timers. Appears in order of next scheduled event. */
495 Lisp_Object Vtimer_list
;
497 /* List of idle time timers. Appears in order of next scheduled event. */
498 Lisp_Object Vtimer_idle_list
;
500 /* Incremented whenever a timer is run. */
503 extern Lisp_Object Vprint_level
, Vprint_length
;
505 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
507 EMACS_TIME
*input_available_clear_time
;
509 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
510 Default is 1 if INTERRUPT_INPUT is defined. */
513 /* Nonzero while interrupts are temporarily deferred during redisplay. */
514 int interrupts_deferred
;
516 /* Nonzero means use ^S/^Q for flow control. */
519 /* Allow m- file to inhibit use of FIONREAD. */
520 #ifdef BROKEN_FIONREAD
524 /* We are unable to use interrupts if FIONREAD is not available,
525 so flush SIGIO so we won't try. */
532 /* If we support a window system, turn on the code to poll periodically
533 to detect C-g. It isn't actually used when doing interrupt input. */
534 #ifdef HAVE_WINDOW_SYSTEM
535 #define POLL_FOR_INPUT
538 /* Global variable declarations. */
540 /* Function for init_keyboard to call with no args (if nonzero). */
541 void (*keyboard_init_hook
) ();
543 static int read_avail_input ();
544 static void get_input_pending ();
545 static int readable_events ();
546 static Lisp_Object
read_char_x_menu_prompt ();
547 static Lisp_Object
read_char_minibuf_menu_prompt ();
548 static Lisp_Object
make_lispy_event ();
550 static Lisp_Object
make_lispy_movement ();
552 static Lisp_Object
modify_event_symbol ();
553 static Lisp_Object
make_lispy_switch_frame ();
554 static int parse_solitary_modifier ();
556 /* > 0 if we are to echo keystrokes. */
557 static int echo_keystrokes
;
559 /* Nonzero means don't try to suspend even if the operating system seems
561 static int cannot_suspend
;
563 #define min(a,b) ((a)<(b)?(a):(b))
564 #define max(a,b) ((a)>(b)?(a):(b))
566 /* Install the string STR as the beginning of the string of echoing,
567 so that it serves as a prompt for the next character.
568 Also start echoing. */
573 int len
= strlen (str
);
575 if (len
> ECHOBUFSIZE
- 4)
576 len
= ECHOBUFSIZE
- 4;
577 bcopy (str
, current_kboard
->echobuf
, len
);
578 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
579 *current_kboard
->echoptr
= '\0';
581 current_kboard
->echo_after_prompt
= len
;
586 /* Add C to the echo string, if echoing is going on.
587 C can be a character, which is printed prettily ("M-C-x" and all that
588 jazz), or a symbol, whose name is printed. */
593 extern char *push_key_description ();
595 if (current_kboard
->immediate_echo
)
597 char *ptr
= current_kboard
->echoptr
;
599 if (ptr
!= current_kboard
->echobuf
)
602 /* If someone has passed us a composite event, use its head symbol. */
607 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
610 ptr
= push_key_description (XINT (c
), ptr
);
612 else if (SYMBOLP (c
))
614 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
615 if ((ptr
- current_kboard
->echobuf
) + name
->size_byte
+ 4
618 bcopy (name
->data
, ptr
, name
->size_byte
);
619 ptr
+= name
->size_byte
;
622 if (current_kboard
->echoptr
== current_kboard
->echobuf
625 strcpy (ptr
, " (Type ? for further options)");
630 current_kboard
->echoptr
= ptr
;
636 /* Temporarily add a dash to the end of the echo string if it's not
637 empty, so that it serves as a mini-prompt for the very next character. */
641 if (!current_kboard
->immediate_echo
642 && current_kboard
->echoptr
== current_kboard
->echobuf
)
644 /* Do nothing if we just printed a prompt. */
645 if (current_kboard
->echo_after_prompt
646 == current_kboard
->echoptr
- current_kboard
->echobuf
)
648 /* Do nothing if not echoing at all. */
649 if (current_kboard
->echoptr
== 0)
652 /* Put a dash at the end of the buffer temporarily,
653 but make it go away when the next character is added. */
654 current_kboard
->echoptr
[0] = '-';
655 current_kboard
->echoptr
[1] = 0;
660 /* Display the current echo string, and begin echoing if not already
666 if (!current_kboard
->immediate_echo
)
669 current_kboard
->immediate_echo
= 1;
671 for (i
= 0; i
< this_command_key_count
; i
++)
674 c
= XVECTOR (this_command_keys
)->contents
[i
];
675 if (! (EVENT_HAS_PARAMETERS (c
)
676 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
683 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
684 ! NILP (current_buffer
->enable_multibyte_characters
));
688 if (waiting_for_input
&& !NILP (Vquit_flag
))
689 quit_throw_to_read_char ();
692 /* Turn off echoing, for the start of a new command. */
696 current_kboard
->immediate_echo
= 0;
697 current_kboard
->echoptr
= current_kboard
->echobuf
;
698 current_kboard
->echo_after_prompt
= -1;
699 ok_to_echo_at_next_pause
= 0;
702 /* Return the length of the current echo string. */
707 return current_kboard
->echoptr
- current_kboard
->echobuf
;
710 /* Truncate the current echo message to its first LEN chars.
711 This and echo_char get used by read_key_sequence when the user
712 switches frames while entering a key sequence. */
718 current_kboard
->echobuf
[len
] = '\0';
719 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
720 truncate_echo_area (len
);
724 /* Functions for manipulating this_command_keys. */
726 add_command_key (key
)
729 int size
= XVECTOR (this_command_keys
)->size
;
731 /* If reset-this-command-length was called recently, obey it now.
732 See the doc string of that function for an explanation of why. */
733 if (before_command_restore_flag
)
735 this_command_key_count
= before_command_key_count_1
;
736 if (this_command_key_count
< this_single_command_key_start
)
737 this_single_command_key_start
= this_command_key_count
;
738 echo_truncate (before_command_echo_length_1
);
739 before_command_restore_flag
= 0;
742 if (this_command_key_count
>= size
)
744 Lisp_Object new_keys
;
746 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
747 bcopy (XVECTOR (this_command_keys
)->contents
,
748 XVECTOR (new_keys
)->contents
,
749 size
* sizeof (Lisp_Object
));
751 this_command_keys
= new_keys
;
754 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
760 int count
= specpdl_ptr
- specpdl
;
763 if (command_loop_level
> 0)
765 specbind (Qstandard_output
, Qt
);
766 specbind (Qstandard_input
, Qt
);
769 val
= command_loop ();
771 Fsignal (Qquit
, Qnil
);
772 /* Handle throw from read_minibuf when using minibuffer
773 while it's active but we're in another window. */
775 Fsignal (Qerror
, Fcons (val
, Qnil
));
777 return unbind_to (count
, Qnil
);
780 /* When an auto-save happens, record the "time", and don't do again soon. */
785 last_auto_save
= num_nonmacro_input_events
;
788 /* Make an auto save happen as soon as possible at command level. */
790 force_auto_save_soon ()
792 last_auto_save
= - auto_save_interval
- 1;
794 record_asynch_buffer_change ();
797 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
798 "Invoke the editor command loop recursively.\n\
799 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
800 that tells this function to return.\n\
801 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
802 This function is called by the editor initialization to begin editing.")
805 int count
= specpdl_ptr
- specpdl
;
808 command_loop_level
++;
809 update_mode_lines
= 1;
811 record_unwind_protect (recursive_edit_unwind
,
813 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
817 return unbind_to (count
, Qnil
);
821 recursive_edit_unwind (buffer
)
825 Fset_buffer (buffer
);
827 command_loop_level
--;
828 update_mode_lines
= 1;
836 #if 0 /* Theory: if there's anything in Vunread_command_events,
837 it will right away be read by read_key_sequence,
838 and then if we do switch KBOARDS, it will go into the side
839 queue then. So we don't need to do anything special here -- rms. */
840 if (CONSP (Vunread_command_events
))
842 current_kboard
->kbd_queue
843 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
844 current_kboard
->kbd_queue_has_data
= 1;
846 Vunread_command_events
= Qnil
;
852 /* Switch to the single-kboard state, making current_kboard
853 the only KBOARD from which further input is accepted. */
856 single_kboard_state ()
863 /* Maintain a stack of kboards, so other parts of Emacs
864 can switch temporarily to the kboard of a given frame
865 and then revert to the previous status. */
870 struct kboard_stack
*next
;
873 static struct kboard_stack
*kboard_stack
;
876 push_frame_kboard (f
)
880 struct kboard_stack
*p
881 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
883 p
->next
= kboard_stack
;
884 p
->kboard
= current_kboard
;
887 current_kboard
= FRAME_KBOARD (f
);
895 struct kboard_stack
*p
= kboard_stack
;
896 current_kboard
= p
->kboard
;
897 kboard_stack
= p
->next
;
902 /* Handle errors that are not handled at inner levels
903 by printing an error message and returning to the editor command loop. */
909 Lisp_Object old_level
, old_length
;
912 if (!NILP (executing_macro
))
914 if (executing_macro_iterations
== 1)
915 sprintf (macroerror
, "After 1 kbd macro iteration: ");
917 sprintf (macroerror
, "After %d kbd macro iterations: ",
918 executing_macro_iterations
);
923 Vstandard_output
= Qt
;
924 Vstandard_input
= Qt
;
925 Vexecuting_macro
= Qnil
;
926 executing_macro
= Qnil
;
927 current_kboard
->Vprefix_arg
= Qnil
;
930 /* Avoid unquittable loop if data contains a circular list. */
931 old_level
= Vprint_level
;
932 old_length
= Vprint_length
;
933 XSETFASTINT (Vprint_level
, 10);
934 XSETFASTINT (Vprint_length
, 10);
935 cmd_error_internal (data
, macroerror
);
936 Vprint_level
= old_level
;
937 Vprint_length
= old_length
;
941 Vinhibit_quit
= Qnil
;
946 return make_number (0);
949 /* Take actions on handling an error. DATA is the data that describes
952 CONTEXT is a C-string containing ASCII characters only which
953 describes the context in which the error happened. If we need to
954 generalize CONTEXT to allow multibyte characters, make it a Lisp
958 cmd_error_internal (data
, context
)
966 echo_area_glyphs
= 0;
968 /* If the window system or terminal frame hasn't been initialized
969 yet, or we're not interactive, it's best to dump this message out
970 to stderr and exit. */
971 if (! FRAME_MESSAGE_BUF (selected_frame
)
973 stream
= Qexternal_debugging_output
;
982 write_string_1 (context
, -1, stream
);
984 print_error_message (data
, stream
);
986 /* If the window system or terminal frame hasn't been initialized
987 yet, or we're in -batch mode, this error should cause Emacs to exit. */
988 if (! FRAME_MESSAGE_BUF (selected_frame
)
992 Fkill_emacs (make_number (-1));
996 Lisp_Object
command_loop_1 ();
997 Lisp_Object
command_loop_2 ();
998 Lisp_Object
top_level_1 ();
1000 /* Entry to editor-command-loop.
1001 This level has the catches for exiting/returning to editor command loop.
1002 It returns nil to exit recursive edit, t to abort it. */
1007 if (command_loop_level
> 0 || minibuf_level
> 0)
1009 return internal_catch (Qexit
, command_loop_2
, Qnil
);
1014 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1015 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1017 /* End of file in -batch run causes exit here. */
1023 /* Here we catch errors in execution of commands within the
1024 editing loop, and reenter the editing loop.
1025 When there is an error, cmd_error runs and returns a non-nil
1026 value to us. A value of nil means that cmd_loop_1 itself
1027 returned due to end of file (or end of kbd macro). */
1032 register Lisp_Object val
;
1035 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1036 while (!NILP (val
));
1044 return Feval (Vtop_level
);
1050 /* On entry to the outer level, run the startup file */
1051 if (!NILP (Vtop_level
))
1052 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1053 else if (!NILP (Vpurify_flag
))
1054 message ("Bare impure Emacs (standard Lisp code not loaded)");
1056 message ("Bare Emacs (standard Lisp code not loaded)");
1060 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1061 "Exit all recursive editing levels.")
1064 Fthrow (Qtop_level
, Qnil
);
1067 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1068 "Exit from the innermost recursive edit or minibuffer.")
1071 if (command_loop_level
> 0 || minibuf_level
> 0)
1072 Fthrow (Qexit
, Qnil
);
1074 error ("No recursive edit is in progress");
1077 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1078 "Abort the command that requested this recursive edit or minibuffer input.")
1081 if (command_loop_level
> 0 || minibuf_level
> 0)
1084 error ("No recursive edit is in progress");
1087 /* This is the actual command reading loop,
1088 sans error-handling encapsulation. */
1090 Lisp_Object
Fcommand_execute ();
1091 static int read_key_sequence ();
1092 void safe_run_hooks ();
1097 Lisp_Object cmd
, tem
;
1100 Lisp_Object keybuf
[30];
1105 struct buffer
*prev_buffer
;
1107 int was_locked
= single_kboard
;
1110 current_kboard
->Vprefix_arg
= Qnil
;
1111 Vdeactivate_mark
= Qnil
;
1112 waiting_for_input
= 0;
1117 this_command_key_count
= 0;
1118 this_single_command_key_start
= 0;
1120 /* Make sure this hook runs after commands that get errors and
1121 throw to top level. */
1122 /* Note that the value cell will never directly contain nil
1123 if the symbol is a local variable. */
1124 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1125 safe_run_hooks (Qpost_command_hook
);
1127 if (!NILP (Vdeferred_action_list
))
1128 call0 (Vdeferred_action_function
);
1130 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1132 if (NILP (Vunread_command_events
)
1133 && NILP (Vexecuting_macro
)
1134 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1135 safe_run_hooks (Qpost_command_idle_hook
);
1138 /* Do this after running Vpost_command_hook, for consistency. */
1139 current_kboard
->Vlast_command
= this_command
;
1143 /* Make sure the current window's buffer is selected. */
1144 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1145 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1147 /* Display any malloc warning that just came out. Use while because
1148 displaying one warning can cause another. */
1150 while (pending_malloc_warning
)
1151 display_malloc_warning ();
1155 Vdeactivate_mark
= Qnil
;
1157 /* If minibuffer on and echo area in use,
1158 wait 2 sec and redraw minibuffer. */
1160 if (minibuf_level
&& echo_area_glyphs
1161 && EQ (minibuf_window
, echo_area_window
))
1163 /* Bind inhibit-quit to t so that C-g gets read in
1164 rather than quitting back to the minibuffer. */
1165 int count
= specpdl_ptr
- specpdl
;
1166 specbind (Qinhibit_quit
, Qt
);
1168 Fsit_for (make_number (2), Qnil
, Qnil
);
1169 /* Clear the echo area. */
1171 safe_run_hooks (Qecho_area_clear_hook
);
1173 unbind_to (count
, Qnil
);
1175 /* If a C-g came in before, treat it as input now. */
1176 if (!NILP (Vquit_flag
))
1179 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1184 alloca (0); /* Cause a garbage collection now */
1185 /* Since we can free the most stuff here. */
1186 #endif /* C_ALLOCA */
1189 /* Select the frame that the last event came from. Usually,
1190 switch-frame events will take care of this, but if some lisp
1191 code swallows a switch-frame event, we'll fix things up here.
1192 Is this a good idea? */
1193 if (FRAMEP (internal_last_event_frame
)
1194 && XFRAME (internal_last_event_frame
) != selected_frame
)
1195 Fselect_frame (internal_last_event_frame
, Qnil
);
1197 /* If it has changed current-menubar from previous value,
1198 really recompute the menubar from the value. */
1199 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1200 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1201 call0 (Qrecompute_lucid_menubar
);
1203 before_command_key_count
= this_command_key_count
;
1204 before_command_echo_length
= echo_length ();
1206 this_command
= Qnil
;
1208 /* Read next key sequence; i gets its length. */
1209 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1212 /* A filter may have run while we were reading the input. */
1213 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1214 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1218 /* Now we have read a key sequence of length I,
1219 or else I is 0 and we found end of file. */
1221 if (i
== 0) /* End of file -- happens only in */
1222 return Qnil
; /* a kbd macro, at the end. */
1223 /* -1 means read_key_sequence got a menu that was rejected.
1224 Just loop around and read another command. */
1228 this_command_key_count
= 0;
1229 this_single_command_key_start
= 0;
1233 last_command_char
= keybuf
[i
- 1];
1235 /* If the previous command tried to force a specific window-start,
1236 forget about that, in case this command moves point far away
1237 from that position. But also throw away beg_unchanged and
1238 end_unchanged information in that case, so that redisplay will
1239 update the whole window properly. */
1240 if (!NILP (XWINDOW (selected_window
)->force_start
))
1242 XWINDOW (selected_window
)->force_start
= Qnil
;
1243 beg_unchanged
= end_unchanged
= 0;
1246 cmd
= read_key_sequence_cmd
;
1247 if (!NILP (Vexecuting_macro
))
1249 if (!NILP (Vquit_flag
))
1251 Vexecuting_macro
= Qt
;
1252 QUIT
; /* Make some noise. */
1253 /* Will return since macro now empty. */
1257 /* Do redisplay processing after this command except in special
1258 cases identified below that set no_redisplay to 1.
1259 (actually, there's currently no way to prevent the redisplay,
1260 and no_redisplay is ignored.
1261 Perhaps someday we will really implement it.) */
1264 prev_buffer
= current_buffer
;
1265 prev_modiff
= MODIFF
;
1266 last_point_position
= PT
;
1267 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1269 /* Execute the command. */
1272 /* Note that the value cell will never directly contain nil
1273 if the symbol is a local variable. */
1274 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1275 safe_run_hooks (Qpre_command_hook
);
1277 if (NILP (this_command
))
1279 /* nil means key is undefined. */
1281 current_kboard
->defining_kbd_macro
= Qnil
;
1282 update_mode_lines
= 1;
1283 current_kboard
->Vprefix_arg
= Qnil
;
1287 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1289 /* Recognize some common commands in common situations and
1290 do them directly. */
1291 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1293 struct Lisp_Char_Table
*dp
1294 = window_display_table (XWINDOW (selected_window
));
1295 lose
= FETCH_BYTE (PT_BYTE
);
1298 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1299 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1300 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1301 && (lose
>= 0x20 && lose
< 0x7f)))
1302 : (lose
>= 0x20 && lose
< 0x7f))
1303 /* To extract the case of continuation on
1304 wide-column characters. */
1305 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1306 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1308 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1310 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1312 && !windows_or_buffers_changed
1313 && EQ (current_buffer
->selective_display
, Qnil
)
1314 && !detect_input_pending ()
1315 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1316 && NILP (Vexecuting_macro
))
1317 no_redisplay
= direct_output_forward_char (1);
1320 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1322 struct Lisp_Char_Table
*dp
1323 = window_display_table (XWINDOW (selected_window
));
1325 lose
= FETCH_BYTE (PT_BYTE
);
1327 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1328 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1329 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1330 && (lose
>= 0x20 && lose
< 0x7f)))
1331 : (lose
>= 0x20 && lose
< 0x7f))
1332 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1334 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1336 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1338 && !windows_or_buffers_changed
1339 && EQ (current_buffer
->selective_display
, Qnil
)
1340 && !detect_input_pending ()
1341 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1342 && NILP (Vexecuting_macro
))
1343 no_redisplay
= direct_output_forward_char (-1);
1346 else if (EQ (this_command
, Qself_insert_command
)
1347 /* Try this optimization only on ascii keystrokes. */
1348 && INTEGERP (last_command_char
))
1350 unsigned int c
= XINT (last_command_char
);
1353 if (NILP (Vexecuting_macro
)
1354 && !EQ (minibuf_window
, selected_window
))
1356 if (!nonundocount
|| nonundocount
>= 20)
1363 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1365 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1367 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1369 || MODIFF
<= SAVE_MODIFF
1370 || windows_or_buffers_changed
1371 || !EQ (current_buffer
->selective_display
, Qnil
)
1372 || detect_input_pending ()
1373 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1374 || !NILP (Vexecuting_macro
));
1375 value
= internal_self_insert (c
, 0);
1382 && (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
1384 struct Lisp_Char_Table
*dp
1385 = window_display_table (XWINDOW (selected_window
));
1388 /* Add the offset to the character, for Finsert_char.
1389 We pass internal_self_insert the unmodified character
1390 because it itself does this offsetting. */
1391 if (! NILP (current_buffer
->enable_multibyte_characters
))
1392 lose
= unibyte_char_to_multibyte (lose
);
1398 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1401 /* Do it only for char codes
1402 that by default display as themselves. */
1403 if (lose
>= 0x20 && lose
<= 0x7e)
1404 no_redisplay
= direct_output_for_insert (lose
);
1406 else if (VECTORP (obj
)
1407 && XVECTOR (obj
)->size
== 1
1408 && (obj
= XVECTOR (obj
)->contents
[0],
1410 /* Insist face not specified in glyph. */
1411 && (XINT (obj
) & ((-1) << 8)) == 0)
1413 = direct_output_for_insert (XINT (obj
));
1417 if (lose
>= 0x20 && lose
<= 0x7e)
1418 no_redisplay
= direct_output_for_insert (lose
);
1425 /* Here for a command that isn't executed directly */
1428 if (NILP (current_kboard
->Vprefix_arg
))
1430 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1435 /* Note that the value cell will never directly contain nil
1436 if the symbol is a local variable. */
1437 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1438 safe_run_hooks (Qpost_command_hook
);
1440 if (!NILP (Vdeferred_action_list
))
1441 safe_run_hooks (Qdeferred_action_function
);
1443 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1445 if (NILP (Vunread_command_events
)
1446 && NILP (Vexecuting_macro
)
1447 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1448 safe_run_hooks (Qpost_command_idle_hook
);
1451 /* If there is a prefix argument,
1452 1) We don't want Vlast_command to be ``universal-argument''
1453 (that would be dumb), so don't set Vlast_command,
1454 2) we want to leave echoing on so that the prefix will be
1455 echoed as part of this key sequence, so don't call
1457 3) we want to leave this_command_key_count non-zero, so that
1458 read_char will realize that it is re-reading a character, and
1459 not echo it a second time.
1461 If the command didn't actually create a prefix arg,
1462 but is merely a frame event that is transparent to prefix args,
1463 then the above doesn't apply. */
1464 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1466 current_kboard
->Vlast_command
= this_command
;
1468 this_command_key_count
= 0;
1469 this_single_command_key_start
= 0;
1472 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1474 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1476 current_buffer
->mark_active
= Qnil
;
1477 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1479 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1480 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1484 /* Install chars successfully executed in kbd macro. */
1486 if (!NILP (current_kboard
->defining_kbd_macro
)
1487 && NILP (current_kboard
->Vprefix_arg
))
1488 finalize_kbd_macro_chars ();
1492 any_kboard_state ();
1497 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1500 safe_run_hooks_1 (hook
)
1503 return call1 (Vrun_hooks
, Vinhibit_quit
);
1506 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1509 safe_run_hooks_error (data
)
1512 Fset (Vinhibit_quit
, Qnil
);
1515 /* If we get an error while running the hook, cause the hook variable
1516 to be nil. Also inhibit quits, so that C-g won't cause the hook
1517 to mysteriously evaporate. */
1520 safe_run_hooks (hook
)
1524 int count
= specpdl_ptr
- specpdl
;
1525 specbind (Qinhibit_quit
, hook
);
1527 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1529 unbind_to (count
, Qnil
);
1532 /* Number of seconds between polling for input. */
1535 /* Nonzero means polling for input is temporarily suppressed. */
1536 int poll_suppress_count
;
1538 /* Nonzero if polling_for_input is actually being used. */
1539 int polling_for_input
;
1541 #ifdef POLL_FOR_INPUT
1543 /* Handle an alarm once each second and read pending input
1544 so as to handle a C-g if it comces in. */
1547 input_poll_signal (signalnum
) /* If we don't have an argument, */
1548 int signalnum
; /* some compilers complain in signal calls. */
1550 /* This causes the call to start_polling at the end
1551 to do its job. It also arranges for a quit or error
1552 from within read_avail_input to resume polling. */
1553 poll_suppress_count
++;
1554 if (interrupt_input_blocked
== 0
1555 && !waiting_for_input
)
1556 read_avail_input (0);
1557 /* Turn on the SIGALRM handler and request another alarm. */
1563 /* Begin signals to poll for input, if they are appropriate.
1564 This function is called unconditionally from various places. */
1569 #ifdef POLL_FOR_INPUT
1570 if (read_socket_hook
&& !interrupt_input
)
1572 poll_suppress_count
--;
1573 if (poll_suppress_count
== 0)
1575 signal (SIGALRM
, input_poll_signal
);
1576 polling_for_input
= 1;
1577 alarm (polling_period
);
1583 /* Nonzero if we are using polling to handle input asynchronously. */
1586 input_polling_used ()
1588 #ifdef POLL_FOR_INPUT
1589 return read_socket_hook
&& !interrupt_input
;
1595 /* Turn off polling. */
1600 #ifdef POLL_FOR_INPUT
1601 if (read_socket_hook
&& !interrupt_input
)
1603 if (poll_suppress_count
== 0)
1605 polling_for_input
= 0;
1608 poll_suppress_count
++;
1613 /* Set the value of poll_suppress_count to COUNT
1614 and start or stop polling accordingly. */
1617 set_poll_suppress_count (count
)
1620 #ifdef POLL_FOR_INPUT
1621 if (count
== 0 && poll_suppress_count
!= 0)
1623 poll_suppress_count
= 1;
1626 else if (count
!= 0 && poll_suppress_count
== 0)
1630 poll_suppress_count
= count
;
1634 /* Bind polling_period to a value at least N.
1635 But don't decrease it. */
1638 bind_polling_period (n
)
1641 #ifdef POLL_FOR_INPUT
1642 int new = polling_period
;
1648 specbind (Qpolling_period
, make_number (new));
1649 /* Start a new alarm with the new period. */
1654 /* Apply the control modifier to CHARACTER. */
1660 /* Save the upper bits here. */
1661 int upper
= c
& ~0177;
1665 /* Everything in the columns containing the upper-case letters
1666 denotes a control character. */
1667 if (c
>= 0100 && c
< 0140)
1671 /* Set the shift modifier for a control char
1672 made from a shifted letter. But only for letters! */
1673 if (oc
>= 'A' && oc
<= 'Z')
1674 c
|= shift_modifier
;
1677 /* The lower-case letters denote control characters too. */
1678 else if (c
>= 'a' && c
<= 'z')
1681 /* Include the bits for control and shift
1682 only if the basic ASCII code can't indicate them. */
1686 /* Replace the high bits. */
1687 c
|= (upper
& ~ctrl_modifier
);
1694 /* Input of single characters from keyboard */
1696 Lisp_Object
print_help ();
1697 static Lisp_Object
kbd_buffer_get_event ();
1698 static void record_char ();
1701 static jmp_buf wrong_kboard_jmpbuf
;
1704 /* read a character from the keyboard; call the redisplay if needed */
1705 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1706 -1 means do not do redisplay, but do do autosaving.
1709 /* The arguments MAPS and NMAPS are for menu prompting.
1710 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1712 PREV_EVENT is the previous input event, or nil if we are reading
1713 the first event of a key sequence.
1715 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1716 if we used a mouse menu to read the input, or zero otherwise. If
1717 USED_MOUSE_MENU is null, we don't dereference it.
1719 Value is t if we showed a menu and the user rejected it. */
1722 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1726 Lisp_Object prev_event
;
1727 int *used_mouse_menu
;
1731 jmp_buf local_getcjmp
;
1733 int key_already_recorded
= 0;
1734 Lisp_Object tem
, save
;
1735 Lisp_Object also_record
;
1736 struct gcpro gcpro1
;
1740 before_command_key_count
= this_command_key_count
;
1741 before_command_echo_length
= echo_length ();
1748 if (CONSP (Vunread_command_events
))
1750 c
= XCONS (Vunread_command_events
)->car
;
1751 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1753 /* Undo what read_char_x_menu_prompt did when it unread
1754 additional keys returned by Fx_popup_menu. */
1756 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1757 && NILP (XCONS (c
)->cdr
))
1760 if (this_command_key_count
== 0)
1766 if (unread_command_char
!= -1)
1768 XSETINT (c
, unread_command_char
);
1769 unread_command_char
= -1;
1771 if (this_command_key_count
== 0)
1777 /* If there is no function key translated before
1778 reset-this-command-lengths takes effect, forget about it. */
1779 before_command_restore_flag
= 0;
1781 if (!NILP (Vexecuting_macro
))
1783 /* We set this to Qmacro; since that's not a frame, nobody will
1784 try to switch frames on us, and the selected window will
1787 Since this event came from a macro, it would be misleading to
1788 leave internal_last_event_frame set to wherever the last
1789 real event came from. Normally, a switch-frame event selects
1790 internal_last_event_frame after each command is read, but
1791 events read from a macro should never cause a new frame to be
1793 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1795 /* Exit the macro if we are at the end.
1796 Also, some things replace the macro with t
1797 to force an early exit. */
1798 if (EQ (Vexecuting_macro
, Qt
)
1799 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1805 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1806 if (STRINGP (Vexecuting_macro
)
1807 && (XINT (c
) & 0x80))
1808 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1810 executing_macro_index
++;
1815 if (!NILP (unread_switch_frame
))
1817 c
= unread_switch_frame
;
1818 unread_switch_frame
= Qnil
;
1820 /* This event should make it into this_command_keys, and get echoed
1821 again, so we go to reread_first, rather than reread. */
1825 if (commandflag
>= 0)
1828 || detect_input_pending_run_timers (0))
1835 /* Message turns off echoing unless more keystrokes turn it on again. */
1836 if (echo_area_glyphs
&& *echo_area_glyphs
1837 && echo_area_glyphs
!= current_kboard
->echobuf
1838 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1841 /* If already echoing, continue. */
1844 /* Try reading a character via menu prompting in the minibuf.
1845 Try this before the sit-for, because the sit-for
1846 would do the wrong thing if we are supposed to do
1847 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1848 after a mouse event so don't try a minibuf menu. */
1850 if (nmaps
> 0 && INTERACTIVE
1851 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1852 /* Don't bring up a menu if we already have another event. */
1853 && NILP (Vunread_command_events
)
1854 && unread_command_char
< 0
1855 && !detect_input_pending_run_timers (0))
1857 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1860 key_already_recorded
= 1;
1865 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1866 We will do that below, temporarily for short sections of code,
1867 when appropriate. local_getcjmp must be in effect
1868 around any call to sit_for or kbd_buffer_get_event;
1869 it *must not* be in effect when we call redisplay. */
1871 if (_setjmp (local_getcjmp
))
1873 XSETINT (c
, quit_char
);
1874 XSETFRAME (internal_last_event_frame
, selected_frame
);
1875 Vlast_event_frame
= internal_last_event_frame
;
1876 /* If we report the quit char as an event,
1877 don't do so more than once. */
1878 if (!NILP (Vinhibit_quit
))
1883 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1884 if (kb
!= current_kboard
)
1886 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1887 /* We shouldn't get here if we were in single-kboard mode! */
1890 while (CONSP (*tailp
))
1891 tailp
= &XCONS (*tailp
)->cdr
;
1894 *tailp
= Fcons (c
, Qnil
);
1895 kb
->kbd_queue_has_data
= 1;
1896 current_kboard
= kb
;
1897 /* This is going to exit from read_char
1898 so we had better get rid of this frame's stuff. */
1900 longjmp (wrong_kboard_jmpbuf
, 1);
1907 timer_start_idle ();
1909 /* If in middle of key sequence and minibuffer not active,
1910 start echoing if enough time elapses. */
1912 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1913 && this_command_key_count
> 0
1915 && echo_keystrokes
> 0
1916 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1917 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1921 /* After a mouse event, start echoing right away.
1922 This is because we are probably about to display a menu,
1923 and we don't want to delay before doing so. */
1924 if (EVENT_HAS_PARAMETERS (prev_event
))
1928 save_getcjmp (save_jump
);
1929 restore_getcjmp (local_getcjmp
);
1930 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1931 restore_getcjmp (save_jump
);
1933 && ! CONSP (Vunread_command_events
))
1938 /* Maybe auto save due to number of keystrokes. */
1940 if (commandflag
!= 0
1941 && auto_save_interval
> 0
1942 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1943 && !detect_input_pending_run_timers (0))
1945 Fdo_auto_save (Qnil
, Qnil
);
1946 /* Hooks can actually change some buffers in auto save. */
1950 /* Try reading using an X menu.
1951 This is never confused with reading using the minibuf
1952 because the recursive call of read_char in read_char_minibuf_menu_prompt
1953 does not pass on any keymaps. */
1955 if (nmaps
> 0 && INTERACTIVE
1956 && !NILP (prev_event
)
1957 && EVENT_HAS_PARAMETERS (prev_event
)
1958 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1959 /* Don't bring up a menu if we already have another event. */
1960 && NILP (Vunread_command_events
)
1961 && unread_command_char
< 0)
1963 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1965 /* Now that we have read an event, Emacs is not idle. */
1971 /* Maybe autosave and/or garbage collect due to idleness. */
1973 if (INTERACTIVE
&& NILP (c
))
1975 int delay_level
, buffer_size
;
1977 /* Slow down auto saves logarithmically in size of current buffer,
1978 and garbage collect while we're at it. */
1979 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1980 last_non_minibuf_size
= Z
- BEG
;
1981 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1983 while (buffer_size
> 64)
1984 delay_level
++, buffer_size
-= buffer_size
>> 2;
1985 if (delay_level
< 4) delay_level
= 4;
1986 /* delay_level is 4 for files under around 50k, 7 at 100k,
1987 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1989 /* Auto save if enough time goes by without input. */
1990 if (commandflag
!= 0
1991 && num_nonmacro_input_events
> last_auto_save
1992 && INTEGERP (Vauto_save_timeout
)
1993 && XINT (Vauto_save_timeout
) > 0)
1997 save_getcjmp (save_jump
);
1998 restore_getcjmp (local_getcjmp
);
1999 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2001 restore_getcjmp (save_jump
);
2004 && ! CONSP (Vunread_command_events
))
2006 Fdo_auto_save (Qnil
, Qnil
);
2008 /* If we have auto-saved and there is still no input
2009 available, garbage collect if there has been enough
2010 consing going on to make it worthwhile. */
2011 if (!detect_input_pending_run_timers (0)
2012 && consing_since_gc
> gc_cons_threshold
/ 2)
2013 Fgarbage_collect ();
2020 /* If this has become non-nil here, it has been set by a timer
2021 or sentinel or filter. */
2022 if (CONSP (Vunread_command_events
))
2024 c
= XCONS (Vunread_command_events
)->car
;
2025 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2028 /* Read something from current KBOARD's side queue, if possible. */
2032 if (current_kboard
->kbd_queue_has_data
)
2034 if (!CONSP (current_kboard
->kbd_queue
))
2036 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2037 current_kboard
->kbd_queue
2038 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2039 if (NILP (current_kboard
->kbd_queue
))
2040 current_kboard
->kbd_queue_has_data
= 0;
2041 input_pending
= readable_events (0);
2042 if (EVENT_HAS_PARAMETERS (c
)
2043 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2044 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2045 Vlast_event_frame
= internal_last_event_frame
;
2050 /* If current_kboard's side queue is empty check the other kboards.
2051 If one of them has data that we have not yet seen here,
2052 switch to it and process the data waiting for it.
2054 Note: if the events queued up for another kboard
2055 have already been seen here, and therefore are not a complete command,
2056 the kbd_queue_has_data field is 0, so we skip that kboard here.
2057 That's to avoid an infinite loop switching between kboards here. */
2058 if (NILP (c
) && !single_kboard
)
2061 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2062 if (kb
->kbd_queue_has_data
)
2064 current_kboard
= kb
;
2065 /* This is going to exit from read_char
2066 so we had better get rid of this frame's stuff. */
2068 longjmp (wrong_kboard_jmpbuf
, 1);
2077 /* Finally, we read from the main queue,
2078 and if that gives us something we can't use yet, we put it on the
2079 appropriate side queue and try again. */
2085 /* Actually read a character, waiting if necessary. */
2086 save_getcjmp (save_jump
);
2087 restore_getcjmp (local_getcjmp
);
2088 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2089 restore_getcjmp (save_jump
);
2092 if (! NILP (c
) && (kb
!= current_kboard
))
2094 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2095 while (CONSP (*tailp
))
2096 tailp
= &XCONS (*tailp
)->cdr
;
2099 *tailp
= Fcons (c
, Qnil
);
2100 kb
->kbd_queue_has_data
= 1;
2104 current_kboard
= kb
;
2105 /* This is going to exit from read_char
2106 so we had better get rid of this frame's stuff. */
2108 longjmp (wrong_kboard_jmpbuf
, 1);
2113 /* Terminate Emacs in batch mode if at eof. */
2114 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2115 Fkill_emacs (make_number (1));
2119 /* Add in any extra modifiers, where appropriate. */
2120 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2121 || ((extra_keyboard_modifiers
& 0177) < ' '
2122 && (extra_keyboard_modifiers
& 0177) != 0))
2123 XSETINT (c
, make_ctrl_char (XINT (c
)));
2125 /* Transfer any other modifier bits directly from
2126 extra_keyboard_modifiers to c. Ignore the actual character code
2127 in the low 16 bits of extra_keyboard_modifiers. */
2128 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2139 if (commandflag
>= 0
2140 && !input_pending
&& !detect_input_pending_run_timers (0))
2148 /* Buffer switch events are only for internal wakeups
2149 so don't show them to the user.
2150 Also, don't record a key if we already did. */
2151 if (BUFFERP (c
) || key_already_recorded
)
2154 /* Process special events within read_char
2155 and loop around to read another event. */
2158 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2164 int was_locked
= single_kboard
;
2166 last_input_char
= c
;
2167 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2169 /* Resume allowing input from any kboard, if that was true before. */
2171 any_kboard_state ();
2176 /* Wipe the echo area. */
2177 if (echo_area_glyphs
)
2178 safe_run_hooks (Qecho_area_clear_hook
);
2179 echo_area_glyphs
= 0;
2181 /* Handle things that only apply to characters. */
2184 /* If kbd_buffer_get_event gave us an EOF, return that. */
2188 if ((STRINGP (Vkeyboard_translate_table
)
2189 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2190 || (VECTORP (Vkeyboard_translate_table
)
2191 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2192 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2193 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2196 d
= Faref (Vkeyboard_translate_table
, c
);
2197 /* nil in keyboard-translate-table means no translation. */
2203 /* If this event is a mouse click in the menu bar,
2204 return just menu-bar for now. Modify the mouse click event
2205 so we won't do this twice, then queue it up. */
2206 if (EVENT_HAS_PARAMETERS (c
)
2207 && CONSP (XCONS (c
)->cdr
)
2208 && CONSP (EVENT_START (c
))
2209 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2213 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2214 /* Handle menu-bar events:
2215 insert the dummy prefix event `menu-bar'. */
2216 if (EQ (posn
, Qmenu_bar
))
2218 /* Change menu-bar to (menu-bar) as the event "position". */
2219 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2222 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2228 if (! NILP (also_record
))
2229 record_char (also_record
);
2234 before_command_key_count
= this_command_key_count
;
2235 before_command_echo_length
= echo_length ();
2237 /* Don't echo mouse motion events. */
2239 && ! (EVENT_HAS_PARAMETERS (c
)
2240 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2243 if (! NILP (also_record
))
2244 echo_char (also_record
);
2245 /* Once we reread a character, echoing can happen
2246 the next time we pause to read a new one. */
2247 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2250 /* Record this character as part of the current key. */
2251 add_command_key (c
);
2252 if (! NILP (also_record
))
2253 add_command_key (also_record
);
2255 /* Re-reading in the middle of a command */
2257 last_input_char
= c
;
2260 /* Process the help character specially if enabled */
2261 if (!NILP (Vhelp_form
) && help_char_p (c
))
2264 count
= specpdl_ptr
- specpdl
;
2266 record_unwind_protect (Fset_window_configuration
,
2267 Fcurrent_window_configuration (Qnil
));
2269 tem0
= Feval (Vhelp_form
);
2271 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2275 c
= read_char (0, 0, 0, Qnil
, 0);
2276 while (BUFFERP (c
));
2277 /* Remove the help from the frame */
2278 unbind_to (count
, Qnil
);
2281 if (EQ (c
, make_number (040)))
2285 c
= read_char (0, 0, 0, Qnil
, 0);
2286 while (BUFFERP (c
));
2293 /* Record a key that came from a mouse menu.
2294 Record it for echoing, for this-command-keys, and so on. */
2300 /* Wipe the echo area. */
2301 echo_area_glyphs
= 0;
2305 before_command_key_count
= this_command_key_count
;
2306 before_command_echo_length
= echo_length ();
2308 /* Don't echo mouse motion events. */
2309 if (echo_keystrokes
)
2313 /* Once we reread a character, echoing can happen
2314 the next time we pause to read a new one. */
2315 ok_to_echo_at_next_pause
= 0;
2318 /* Record this character as part of the current key. */
2319 add_command_key (c
);
2321 /* Re-reading in the middle of a command */
2322 last_input_char
= c
;
2326 /* Return 1 if should recognize C as "the help character". */
2334 if (EQ (c
, Vhelp_char
))
2336 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2337 if (EQ (c
, XCONS (tail
)->car
))
2342 /* Record the input event C in various ways. */
2349 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2350 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2351 recent_keys_index
= 0;
2353 /* Write c to the dribble file. If c is a lispy event, write
2354 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2355 If you, dear reader, have a better idea, you've got the source. :-) */
2360 if (XUINT (c
) < 0x100)
2361 putc (XINT (c
), dribble
);
2363 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2367 Lisp_Object dribblee
;
2369 /* If it's a structured event, take the event header. */
2370 dribblee
= EVENT_HEAD (c
);
2372 if (SYMBOLP (dribblee
))
2374 putc ('<', dribble
);
2375 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2376 XSYMBOL (dribblee
)->name
->size_byte
,
2378 putc ('>', dribble
);
2385 store_kbd_macro_char (c
);
2387 num_nonmacro_input_events
++;
2394 struct buffer
*old
= current_buffer
;
2395 Fprinc (object
, Qnil
);
2396 set_buffer_internal (XBUFFER (Vstandard_output
));
2397 call0 (intern ("help-mode"));
2398 set_buffer_internal (old
);
2402 /* Copy out or in the info on where C-g should throw to.
2403 This is used when running Lisp code from within get_char,
2404 in case get_char is called recursively.
2405 See read_process_output. */
2410 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2413 restore_getcjmp (temp
)
2416 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2421 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2422 of this function. */
2425 tracking_off (old_value
)
2426 Lisp_Object old_value
;
2428 do_mouse_tracking
= old_value
;
2429 if (NILP (old_value
))
2431 /* Redisplay may have been preempted because there was input
2432 available, and it assumes it will be called again after the
2433 input has been processed. If the only input available was
2434 the sort that we have just disabled, then we need to call
2436 if (!readable_events (1))
2438 redisplay_preserve_echo_area ();
2439 get_input_pending (&input_pending
, 1);
2444 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2445 "Evaluate BODY with mouse movement events enabled.\n\
2446 Within a `track-mouse' form, mouse motion generates input events that\n\
2447 you can read with `read-event'.\n\
2448 Normally, mouse motion is ignored.")
2452 int count
= specpdl_ptr
- specpdl
;
2455 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2457 do_mouse_tracking
= Qt
;
2459 val
= Fprogn (args
);
2460 return unbind_to (count
, val
);
2463 /* If mouse has moved on some frame, return one of those frames.
2464 Return 0 otherwise. */
2469 Lisp_Object tail
, frame
;
2471 FOR_EACH_FRAME (tail
, frame
)
2473 if (XFRAME (frame
)->mouse_moved
)
2474 return XFRAME (frame
);
2480 #endif /* HAVE_MOUSE */
2482 /* Low level keyboard/mouse input.
2483 kbd_buffer_store_event places events in kbd_buffer, and
2484 kbd_buffer_get_event retrieves them. */
2486 /* Return true iff there are any events in the queue that read-char
2487 would return. If this returns false, a read-char would block. */
2489 readable_events (do_timers_now
)
2493 timer_check (do_timers_now
);
2495 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2498 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2503 if (current_kboard
->kbd_queue_has_data
)
2509 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2510 if (kb
->kbd_queue_has_data
)
2516 /* Set this for debugging, to have a way to get out */
2521 event_to_kboard (event
)
2522 struct input_event
*event
;
2525 frame
= event
->frame_or_window
;
2527 frame
= XCONS (frame
)->car
;
2528 else if (WINDOWP (frame
))
2529 frame
= WINDOW_FRAME (XWINDOW (frame
));
2531 /* There are still some events that don't set this field.
2532 For now, just ignore the problem.
2533 Also ignore dead frames here. */
2534 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2537 return FRAME_KBOARD (XFRAME (frame
));
2541 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2544 kbd_buffer_store_event (event
)
2545 register struct input_event
*event
;
2547 if (event
->kind
== no_event
)
2550 if (event
->kind
== ascii_keystroke
)
2552 register int c
= event
->code
& 0377;
2554 if (event
->modifiers
& ctrl_modifier
)
2555 c
= make_ctrl_char (c
);
2557 c
|= (event
->modifiers
2558 & (meta_modifier
| alt_modifier
2559 | hyper_modifier
| super_modifier
));
2563 extern SIGTYPE
interrupt_signal ();
2566 struct input_event
*sp
;
2569 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2570 kb
!= current_kboard
))
2573 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2574 Fcons (make_number (c
), Qnil
));
2575 kb
->kbd_queue_has_data
= 1;
2576 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2578 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2581 if (event_to_kboard (sp
) == kb
)
2583 sp
->kind
= no_event
;
2584 sp
->frame_or_window
= Qnil
;
2591 /* If this results in a quit_char being returned to Emacs as
2592 input, set Vlast_event_frame properly. If this doesn't
2593 get returned to Emacs as an event, the next event read
2594 will set Vlast_event_frame again, so this is safe to do. */
2598 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2600 focus
= event
->frame_or_window
;
2601 internal_last_event_frame
= focus
;
2602 Vlast_event_frame
= focus
;
2605 last_event_timestamp
= event
->timestamp
;
2606 interrupt_signal ();
2610 if (c
&& c
== stop_character
)
2616 /* Don't insert two buffer_switch_event's in a row.
2617 Just ignore the second one. */
2618 else if (event
->kind
== buffer_switch_event
2619 && kbd_fetch_ptr
!= kbd_store_ptr
2620 && kbd_store_ptr
->kind
== buffer_switch_event
)
2623 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2624 kbd_store_ptr
= kbd_buffer
;
2626 /* Don't let the very last slot in the buffer become full,
2627 since that would make the two pointers equal,
2628 and that is indistinguishable from an empty buffer.
2629 Discard the event if it would fill the last slot. */
2630 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2632 volatile struct input_event
*sp
= kbd_store_ptr
;
2633 sp
->kind
= event
->kind
;
2634 if (event
->kind
== selection_request_event
)
2636 /* We must not use the ordinary copying code for this case,
2637 since `part' is an enum and copying it might not copy enough
2639 bcopy (event
, (char *) sp
, sizeof (*event
));
2643 sp
->code
= event
->code
;
2644 sp
->part
= event
->part
;
2645 sp
->frame_or_window
= event
->frame_or_window
;
2646 sp
->modifiers
= event
->modifiers
;
2649 sp
->timestamp
= event
->timestamp
;
2651 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2653 = event
->frame_or_window
);
2659 /* Discard any mouse events in the event buffer by setting them to
2662 discard_mouse_events ()
2664 struct input_event
*sp
;
2665 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2667 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2670 if (sp
->kind
== mouse_click
2672 || sp
->kind
== w32_scroll_bar_click
2674 || sp
->kind
== scroll_bar_click
)
2676 sp
->kind
= no_event
;
2681 /* Read one event from the event buffer, waiting if necessary.
2682 The value is a Lisp object representing the event.
2683 The value is nil for an event that should be ignored,
2684 or that was handled here.
2685 We always read and discard one event. */
2688 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2690 int *used_mouse_menu
;
2694 EMACS_TIME next_timer_delay
;
2700 *kbp
= current_kboard
;
2704 /* Wait until there is input available. */
2707 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2710 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2714 /* If the quit flag is set, then read_char will return
2715 quit_char, so that counts as "available input." */
2716 if (!NILP (Vquit_flag
))
2717 quit_throw_to_read_char ();
2719 /* One way or another, wait until input is available; then, if
2720 interrupt handlers have not read it, read it now. */
2723 wait_for_kbd_input ();
2725 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2729 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2732 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2736 Lisp_Object minus_one
;
2738 XSETINT (minus_one
, -1);
2739 wait_reading_process_input (0, 0, minus_one
, 1);
2741 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2742 /* Pass 1 for EXPECT since we just waited to have input. */
2743 read_avail_input (1);
2745 #endif /* not VMS */
2748 if (CONSP (Vunread_command_events
))
2751 first
= XCONS (Vunread_command_events
)->car
;
2752 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2753 *kbp
= current_kboard
;
2757 /* At this point, we know that there is a readable event available
2758 somewhere. If the event queue is empty, then there must be a
2759 mouse movement enabled and available. */
2760 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2762 struct input_event
*event
;
2764 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2768 last_event_timestamp
= event
->timestamp
;
2771 *kbp
= event_to_kboard (event
);
2773 *kbp
= current_kboard
; /* Better than returning null ptr? */
2775 *kbp
= &the_only_kboard
;
2780 /* These two kinds of events get special handling
2781 and don't actually appear to the command loop.
2782 We return nil for them. */
2783 if (event
->kind
== selection_request_event
)
2786 struct input_event copy
;
2788 /* Remove it from the buffer before processing it,
2789 since otherwise swallow_events will see it
2790 and process it again. */
2792 kbd_fetch_ptr
= event
+ 1;
2793 input_pending
= readable_events (0);
2794 x_handle_selection_request (©
);
2796 /* We're getting selection request events, but we don't have
2802 else if (event
->kind
== selection_clear_event
)
2805 struct input_event copy
;
2807 /* Remove it from the buffer before processing it. */
2809 kbd_fetch_ptr
= event
+ 1;
2810 input_pending
= readable_events (0);
2811 x_handle_selection_clear (©
);
2813 /* We're getting selection request events, but we don't have
2818 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2819 else if (event
->kind
== delete_window_event
)
2821 /* Make an event (delete-frame (FRAME)). */
2822 obj
= Fcons (event
->frame_or_window
, Qnil
);
2823 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2824 kbd_fetch_ptr
= event
+ 1;
2826 else if (event
->kind
== iconify_event
)
2828 /* Make an event (iconify-frame (FRAME)). */
2829 obj
= Fcons (event
->frame_or_window
, Qnil
);
2830 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2831 kbd_fetch_ptr
= event
+ 1;
2833 else if (event
->kind
== deiconify_event
)
2835 /* Make an event (make-frame-visible (FRAME)). */
2836 obj
= Fcons (event
->frame_or_window
, Qnil
);
2837 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2838 kbd_fetch_ptr
= event
+ 1;
2841 else if (event
->kind
== buffer_switch_event
)
2843 /* The value doesn't matter here; only the type is tested. */
2844 XSETBUFFER (obj
, current_buffer
);
2845 kbd_fetch_ptr
= event
+ 1;
2847 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2848 else if (event
->kind
== menu_bar_activate_event
)
2850 kbd_fetch_ptr
= event
+ 1;
2851 input_pending
= readable_events (0);
2852 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2853 x_activate_menubar (XFRAME (event
->frame_or_window
));
2856 /* Just discard these, by returning nil.
2857 With MULTI_KBOARD, these events are used as placeholders
2858 when we need to randomly delete events from the queue.
2859 (They shouldn't otherwise be found in the buffer,
2860 but on some machines it appears they do show up
2861 even without MULTI_KBOARD.) */
2862 /* On Windows NT/9X, no_event is used to delete extraneous
2863 mouse events during a popup-menu call. */
2864 else if (event
->kind
== no_event
)
2865 kbd_fetch_ptr
= event
+ 1;
2867 /* If this event is on a different frame, return a switch-frame this
2868 time, and leave the event in the queue for next time. */
2874 frame
= event
->frame_or_window
;
2876 frame
= XCONS (frame
)->car
;
2877 else if (WINDOWP (frame
))
2878 frame
= WINDOW_FRAME (XWINDOW (frame
));
2880 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2884 if (! EQ (frame
, internal_last_event_frame
)
2885 && XFRAME (frame
) != selected_frame
)
2886 obj
= make_lispy_switch_frame (frame
);
2887 internal_last_event_frame
= frame
;
2889 /* If we didn't decide to make a switch-frame event, go ahead
2890 and build a real event from the queue entry. */
2894 obj
= make_lispy_event (event
);
2895 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2896 /* If this was a menu selection, then set the flag to inhibit
2897 writing to last_nonmenu_event. Don't do this if the event
2898 we're returning is (menu-bar), though; that indicates the
2899 beginning of the menu sequence, and we might as well leave
2900 that as the `event with parameters' for this selection. */
2901 if (event
->kind
== menu_bar_event
2902 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2904 *used_mouse_menu
= 1;
2907 /* Wipe out this event, to catch bugs. */
2908 event
->kind
= no_event
;
2909 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2911 kbd_fetch_ptr
= event
+ 1;
2916 /* Try generating a mouse motion event. */
2917 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2919 FRAME_PTR f
= some_mouse_moved ();
2920 Lisp_Object bar_window
;
2921 enum scroll_bar_part part
;
2925 *kbp
= current_kboard
;
2926 /* Note that this uses F to determine which display to look at.
2927 If there is no valid info, it does not store anything
2928 so x remains nil. */
2930 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2934 /* Decide if we should generate a switch-frame event. Don't
2935 generate switch-frame events for motion outside of all Emacs
2941 frame
= FRAME_FOCUS_FRAME (f
);
2943 XSETFRAME (frame
, f
);
2945 if (! EQ (frame
, internal_last_event_frame
)
2946 && XFRAME (frame
) != selected_frame
)
2947 obj
= make_lispy_switch_frame (frame
);
2948 internal_last_event_frame
= frame
;
2951 /* If we didn't decide to make a switch-frame event, go ahead and
2952 return a mouse-motion event. */
2953 if (!NILP (x
) && NILP (obj
))
2954 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2956 #endif /* HAVE_MOUSE */
2958 /* We were promised by the above while loop that there was
2959 something for us to read! */
2962 input_pending
= readable_events (0);
2964 Vlast_event_frame
= internal_last_event_frame
;
2969 /* Process any events that are not user-visible,
2970 then return, without reading any user-visible events. */
2973 swallow_events (do_display
)
2978 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2980 struct input_event
*event
;
2982 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2986 last_event_timestamp
= event
->timestamp
;
2988 /* These two kinds of events get special handling
2989 and don't actually appear to the command loop. */
2990 if (event
->kind
== selection_request_event
)
2993 struct input_event copy
;
2995 /* Remove it from the buffer before processing it,
2996 since otherwise swallow_events called recursively could see it
2997 and process it again. */
2999 kbd_fetch_ptr
= event
+ 1;
3000 input_pending
= readable_events (0);
3001 x_handle_selection_request (©
);
3003 /* We're getting selection request events, but we don't have
3009 else if (event
->kind
== selection_clear_event
)
3012 struct input_event copy
;
3014 /* Remove it from the buffer before processing it, */
3017 kbd_fetch_ptr
= event
+ 1;
3018 input_pending
= readable_events (0);
3019 x_handle_selection_clear (©
);
3021 /* We're getting selection request events, but we don't have
3030 old_timers_run
= timers_run
;
3031 get_input_pending (&input_pending
, 1);
3033 if (timers_run
!= old_timers_run
&& do_display
)
3034 redisplay_preserve_echo_area ();
3037 static EMACS_TIME timer_idleness_start_time
;
3039 /* Record the start of when Emacs is idle,
3040 for the sake of running idle-time timers. */
3047 /* If we are already in the idle state, do nothing. */
3048 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3051 EMACS_GET_TIME (timer_idleness_start_time
);
3053 /* Mark all idle-time timers as once again candidates for running. */
3054 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3058 timer
= XCONS (timers
)->car
;
3060 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3062 XVECTOR (timer
)->contents
[0] = Qnil
;
3066 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3071 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3074 /* This is only for debugging. */
3075 struct input_event last_timer_event
;
3077 /* Check whether a timer has fired. To prevent larger problems we simply
3078 disregard elements that are not proper timers. Do not make a circular
3079 timer list for the time being.
3081 Returns the number of seconds to wait until the next timer fires. If a
3082 timer is triggering now, return zero seconds.
3083 If no timer is active, return -1 seconds.
3085 If a timer is ripe, we run it, with quitting turned off.
3087 DO_IT_NOW is now ignored. It used to mean that we should
3088 run the timer directly instead of queueing a timer-event.
3089 Now we always run timers directly. */
3092 timer_check (do_it_now
)
3095 EMACS_TIME nexttime
;
3096 EMACS_TIME now
, idleness_now
;
3097 Lisp_Object timers
, idle_timers
, chosen_timer
;
3098 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3100 EMACS_SET_SECS (nexttime
, -1);
3101 EMACS_SET_USECS (nexttime
, -1);
3103 /* Always consider the ordinary timers. */
3104 timers
= Vtimer_list
;
3105 /* Consider the idle timers only if Emacs is idle. */
3106 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3107 idle_timers
= Vtimer_idle_list
;
3110 chosen_timer
= Qnil
;
3111 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3113 if (CONSP (timers
) || CONSP (idle_timers
))
3115 EMACS_GET_TIME (now
);
3116 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3117 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3120 while (CONSP (timers
) || CONSP (idle_timers
))
3122 int triggertime
= EMACS_SECS (now
);
3123 Lisp_Object
*vector
;
3124 Lisp_Object timer
, idle_timer
;
3125 EMACS_TIME timer_time
, idle_timer_time
;
3126 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3128 /* Skip past invalid timers and timers already handled. */
3131 timer
= XCONS (timers
)->car
;
3132 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3134 timers
= XCONS (timers
)->cdr
;
3137 vector
= XVECTOR (timer
)->contents
;
3139 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3140 || !INTEGERP (vector
[3])
3141 || ! NILP (vector
[0]))
3143 timers
= XCONS (timers
)->cdr
;
3147 if (!NILP (idle_timers
))
3149 timer
= XCONS (idle_timers
)->car
;
3150 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3152 idle_timers
= XCONS (idle_timers
)->cdr
;
3155 vector
= XVECTOR (timer
)->contents
;
3157 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3158 || !INTEGERP (vector
[3])
3159 || ! NILP (vector
[0]))
3161 idle_timers
= XCONS (idle_timers
)->cdr
;
3166 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3167 based on the next ordinary timer.
3168 TIMER_DIFFERENCE is the distance in time from NOW to when
3169 this timer becomes ripe (negative if it's already ripe). */
3172 timer
= XCONS (timers
)->car
;
3173 vector
= XVECTOR (timer
)->contents
;
3174 EMACS_SET_SECS (timer_time
,
3175 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3176 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3177 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3180 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3181 based on the next idle timer. */
3182 if (!NILP (idle_timers
))
3184 idle_timer
= XCONS (idle_timers
)->car
;
3185 vector
= XVECTOR (idle_timer
)->contents
;
3186 EMACS_SET_SECS (idle_timer_time
,
3187 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3188 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3189 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3192 /* Decide which timer is the next timer,
3193 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3194 Also step down the list where we found that timer. */
3196 if (! NILP (timers
) && ! NILP (idle_timers
))
3199 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3200 if (EMACS_TIME_NEG_P (temp
))
3202 chosen_timer
= timer
;
3203 timers
= XCONS (timers
)->cdr
;
3204 difference
= timer_difference
;
3208 chosen_timer
= idle_timer
;
3209 idle_timers
= XCONS (idle_timers
)->cdr
;
3210 difference
= idle_timer_difference
;
3213 else if (! NILP (timers
))
3215 chosen_timer
= timer
;
3216 timers
= XCONS (timers
)->cdr
;
3217 difference
= timer_difference
;
3221 chosen_timer
= idle_timer
;
3222 idle_timers
= XCONS (idle_timers
)->cdr
;
3223 difference
= idle_timer_difference
;
3225 vector
= XVECTOR (chosen_timer
)->contents
;
3227 /* If timer is rupe, run it if it hasn't been run. */
3228 if (EMACS_TIME_NEG_P (difference
)
3229 || (EMACS_SECS (difference
) == 0
3230 && EMACS_USECS (difference
) == 0))
3232 if (NILP (vector
[0]))
3235 int was_locked
= single_kboard
;
3236 int count
= specpdl_ptr
- specpdl
;
3238 /* Mark the timer as triggered to prevent problems if the lisp
3239 code fails to reschedule it right. */
3242 specbind (Qinhibit_quit
, Qt
);
3244 call1 (Qtimer_event_handler
, chosen_timer
);
3247 unbind_to (count
, Qnil
);
3249 /* Resume allowing input from any kboard, if that was true before. */
3251 any_kboard_state ();
3253 /* Since we have handled the event,
3254 we don't need to tell the caller to wake up and do it. */
3258 /* When we encounter a timer that is still waiting,
3259 return the amount of time to wait before it is ripe. */
3266 /* No timers are pending in the future. */
3267 /* Return 0 if we generated an event, and -1 if not. */
3272 /* Caches for modify_event_symbol. */
3273 static Lisp_Object accent_key_syms
;
3274 static Lisp_Object func_key_syms
;
3275 static Lisp_Object mouse_syms
;
3277 static Lisp_Object mouse_wheel_syms
;
3280 /* This is a list of keysym codes for special "accent" characters.
3281 It parallels lispy_accent_keys. */
3283 static int lispy_accent_codes
[] =
3285 #ifdef XK_dead_circumflex
3290 #ifdef XK_dead_grave
3295 #ifdef XK_dead_tilde
3300 #ifdef XK_dead_diaeresis
3305 #ifdef XK_dead_macron
3310 #ifdef XK_dead_degree
3315 #ifdef XK_dead_acute
3320 #ifdef XK_dead_cedilla
3325 #ifdef XK_dead_breve
3330 #ifdef XK_dead_ogonek
3335 #ifdef XK_dead_caron
3340 #ifdef XK_dead_doubleacute
3341 XK_dead_doubleacute
,
3345 #ifdef XK_dead_abovedot
3352 /* This is a list of Lisp names for special "accent" characters.
3353 It parallels lispy_accent_codes. */
3355 static char *lispy_accent_keys
[] =
3373 #define FUNCTION_KEY_OFFSET 0x0
3375 char *lispy_function_keys
[] =
3379 0, /* VK_LBUTTON 0x01 */
3380 0, /* VK_RBUTTON 0x02 */
3381 "cancel", /* VK_CANCEL 0x03 */
3382 0, /* VK_MBUTTON 0x04 */
3384 0, 0, 0, /* 0x05 .. 0x07 */
3386 "backspace", /* VK_BACK 0x08 */
3387 "tab", /* VK_TAB 0x09 */
3389 0, 0, /* 0x0A .. 0x0B */
3391 "clear", /* VK_CLEAR 0x0C */
3392 "return", /* VK_RETURN 0x0D */
3394 0, 0, /* 0x0E .. 0x0F */
3396 "shift", /* VK_SHIFT 0x10 */
3397 "control", /* VK_CONTROL 0x11 */
3398 "menu", /* VK_MENU 0x12 */
3399 "pause", /* VK_PAUSE 0x13 */
3400 "capital", /* VK_CAPITAL 0x14 */
3402 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3404 0, /* VK_ESCAPE 0x1B */
3406 0, 0, 0, 0, /* 0x1C .. 0x1F */
3408 0, /* VK_SPACE 0x20 */
3409 "prior", /* VK_PRIOR 0x21 */
3410 "next", /* VK_NEXT 0x22 */
3411 "end", /* VK_END 0x23 */
3412 "home", /* VK_HOME 0x24 */
3413 "left", /* VK_LEFT 0x25 */
3414 "up", /* VK_UP 0x26 */
3415 "right", /* VK_RIGHT 0x27 */
3416 "down", /* VK_DOWN 0x28 */
3417 "select", /* VK_SELECT 0x29 */
3418 "print", /* VK_PRINT 0x2A */
3419 "execute", /* VK_EXECUTE 0x2B */
3420 "snapshot", /* VK_SNAPSHOT 0x2C */
3421 "insert", /* VK_INSERT 0x2D */
3422 "delete", /* VK_DELETE 0x2E */
3423 "help", /* VK_HELP 0x2F */
3425 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3427 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3429 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3431 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3433 0, 0, 0, 0, 0, 0, 0, 0, 0,
3434 0, 0, 0, 0, 0, 0, 0, 0, 0,
3435 0, 0, 0, 0, 0, 0, 0, 0,
3437 "lwindow", /* VK_LWIN 0x5B */
3438 "rwindow", /* VK_RWIN 0x5C */
3439 "apps", /* VK_APPS 0x5D */
3441 0, 0, /* 0x5E .. 0x5F */
3443 "kp-0", /* VK_NUMPAD0 0x60 */
3444 "kp-1", /* VK_NUMPAD1 0x61 */
3445 "kp-2", /* VK_NUMPAD2 0x62 */
3446 "kp-3", /* VK_NUMPAD3 0x63 */
3447 "kp-4", /* VK_NUMPAD4 0x64 */
3448 "kp-5", /* VK_NUMPAD5 0x65 */
3449 "kp-6", /* VK_NUMPAD6 0x66 */
3450 "kp-7", /* VK_NUMPAD7 0x67 */
3451 "kp-8", /* VK_NUMPAD8 0x68 */
3452 "kp-9", /* VK_NUMPAD9 0x69 */
3453 "kp-multiply", /* VK_MULTIPLY 0x6A */
3454 "kp-add", /* VK_ADD 0x6B */
3455 "kp-separator", /* VK_SEPARATOR 0x6C */
3456 "kp-subtract", /* VK_SUBTRACT 0x6D */
3457 "kp-decimal", /* VK_DECIMAL 0x6E */
3458 "kp-divide", /* VK_DIVIDE 0x6F */
3459 "f1", /* VK_F1 0x70 */
3460 "f2", /* VK_F2 0x71 */
3461 "f3", /* VK_F3 0x72 */
3462 "f4", /* VK_F4 0x73 */
3463 "f5", /* VK_F5 0x74 */
3464 "f6", /* VK_F6 0x75 */
3465 "f7", /* VK_F7 0x76 */
3466 "f8", /* VK_F8 0x77 */
3467 "f9", /* VK_F9 0x78 */
3468 "f10", /* VK_F10 0x79 */
3469 "f11", /* VK_F11 0x7A */
3470 "f12", /* VK_F12 0x7B */
3471 "f13", /* VK_F13 0x7C */
3472 "f14", /* VK_F14 0x7D */
3473 "f15", /* VK_F15 0x7E */
3474 "f16", /* VK_F16 0x7F */
3475 "f17", /* VK_F17 0x80 */
3476 "f18", /* VK_F18 0x81 */
3477 "f19", /* VK_F19 0x82 */
3478 "f20", /* VK_F20 0x83 */
3479 "f21", /* VK_F21 0x84 */
3480 "f22", /* VK_F22 0x85 */
3481 "f23", /* VK_F23 0x86 */
3482 "f24", /* VK_F24 0x87 */
3484 0, 0, 0, 0, /* 0x88 .. 0x8B */
3485 0, 0, 0, 0, /* 0x8C .. 0x8F */
3487 "kp-numlock", /* VK_NUMLOCK 0x90 */
3488 "scroll", /* VK_SCROLL 0x91 */
3490 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3491 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3492 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3493 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3494 "kp-end", /* VK_NUMPAD_END 0x96 */
3495 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3496 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3497 "kp-up", /* VK_NUMPAD_UP 0x99 */
3498 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3499 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3500 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3501 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3503 0, 0, /* 0x9E .. 0x9F */
3506 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3507 * Used only as parameters to GetAsyncKeyState() and GetKeyState().
3508 * No other API or message will distinguish left and right keys this way.
3512 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3513 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3514 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3515 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3516 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3522 "attn", /* VK_ATTN 0xF6 */
3523 "crsel", /* VK_CRSEL 0xF7 */
3524 "exsel", /* VK_EXSEL 0xF8 */
3525 "ereof", /* VK_EREOF 0xF9 */
3526 "play", /* VK_PLAY 0xFA */
3527 "zoom", /* VK_ZOOM 0xFB */
3528 "noname", /* VK_NONAME 0xFC */
3529 "pa1", /* VK_PA1 0xFD */
3530 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3533 #else /* not HAVE_NTGUI */
3536 static char *lispy_kana_keys
[] =
3538 /* X Keysym value */
3539 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3540 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3541 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3542 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3543 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3544 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3545 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3546 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3547 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3548 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3549 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3550 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3551 "kana-i", "kana-u", "kana-e", "kana-o",
3552 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3553 "prolongedsound", "kana-A", "kana-I", "kana-U",
3554 "kana-E", "kana-O", "kana-KA", "kana-KI",
3555 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3556 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3557 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3558 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3559 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3560 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3561 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3562 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3563 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3564 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3565 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3566 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3568 #endif /* XK_kana_A */
3570 #define FUNCTION_KEY_OFFSET 0xff00
3572 /* You'll notice that this table is arranged to be conveniently
3573 indexed by X Windows keysym values. */
3574 static char *lispy_function_keys
[] =
3576 /* X Keysym value */
3578 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3586 0, 0, 0, /* 0xff10 */
3588 0, 0, 0, 0, 0, 0, 0,
3591 0, "kanji", "muhenkan",
3592 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3593 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3594 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3596 "home", /* 0xff50 */ /* IsCursorKey */
3607 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3618 "break", /* 0xff6b */
3620 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3622 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3623 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3624 0, 0, 0, 0, 0, 0, 0, 0,
3625 "kp-tab", /* 0xff89 */
3627 "kp-enter", /* 0xff8d */
3629 "kp-f1", /* 0xff91 */
3633 "kp-home", /* 0xff95 */
3638 "kp-prior", /* kp-page-up */
3639 "kp-next", /* kp-page-down */
3645 0, 0, 0, 0, 0, 0, 0, 0, 0,
3646 "kp-multiply", /* 0xffaa */
3651 "kp-divide", /* 0xffaf */
3652 "kp-0", /* 0xffb0 */
3653 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3656 "kp-equal", /* 0xffbd */
3657 "f1", /* 0xffbe */ /* IsFunctionKey */
3659 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3660 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3661 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3662 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3663 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3664 0, 0, 0, 0, 0, 0, 0, 0,
3665 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3666 0, 0, 0, 0, 0, 0, 0, "delete"
3669 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3670 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3672 static char *iso_lispy_function_keys
[] =
3674 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3675 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3676 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3677 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3678 "iso-lefttab", /* 0xfe20 */
3679 "iso-move-line-up", "iso-move-line-down",
3680 "iso-partial-line-up", "iso-partial-line-down",
3681 "iso-partial-space-left", "iso-partial-space-right",
3682 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3683 "iso-release-margin-left", "iso-release-margin-right",
3684 "iso-release-both-margins",
3685 "iso-fast-cursor-left", "iso-fast-cursor-right",
3686 "iso-fast-cursor-up", "iso-fast-cursor-down",
3687 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3688 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3691 #endif /* not HAVE_NTGUI */
3693 static char *lispy_mouse_names
[] =
3695 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3699 /* mouse-wheel events are generated by the wheel on devices such as
3700 the MS Intellimouse. The wheel sits in between the left and right
3701 mouse buttons, and is typically used to scroll or zoom the window
3702 underneath the pointer. mouse-wheel events specify the object on
3703 which they operate, and a delta corresponding to the amount and
3704 direction that the wheel is rotated. Clicking the mouse-wheel
3705 generates a mouse-2 event. */
3706 static char *lispy_mouse_wheel_names
[] =
3710 #endif /* WINDOWSNT */
3712 /* Scroll bar parts. */
3713 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3714 Lisp_Object Qup
, Qdown
;
3716 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3717 Lisp_Object
*scroll_bar_parts
[] = {
3718 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3723 /* A vector, indexed by button number, giving the down-going location
3724 of currently depressed buttons, both scroll bar and non-scroll bar.
3726 The elements have the form
3727 (BUTTON-NUMBER MODIFIER-MASK . REST)
3728 where REST is the cdr of a position as it would be reported in the event.
3730 The make_lispy_event function stores positions here to tell the
3731 difference between click and drag events, and to store the starting
3732 location to be included in drag events. */
3734 static Lisp_Object button_down_location
;
3736 /* Information about the most recent up-going button event: Which
3737 button, what location, and what time. */
3739 static int last_mouse_button
;
3740 static int last_mouse_x
;
3741 static int last_mouse_y
;
3742 static unsigned long button_down_time
;
3744 /* The maximum time between clicks to make a double-click,
3745 or Qnil to disable double-click detection,
3746 or Qt for no time limit. */
3747 Lisp_Object Vdouble_click_time
;
3749 /* The number of clicks in this multiple-click. */
3751 int double_click_count
;
3753 /* Given a struct input_event, build the lisp event which represents
3754 it. If EVENT is 0, build a mouse movement event from the mouse
3755 movement buffer, which should have a movement event in it.
3757 Note that events must be passed to this function in the order they
3758 are received; this function stores the location of button presses
3759 in order to build drag events when the button is released. */
3762 make_lispy_event (event
)
3763 struct input_event
*event
;
3767 switch (SWITCH_ENUM_CAST (event
->kind
))
3769 /* A simple keystroke. */
3770 case ascii_keystroke
:
3772 Lisp_Object lispy_c
;
3773 int c
= event
->code
& 0377;
3774 /* Turn ASCII characters into control characters
3776 if (event
->modifiers
& ctrl_modifier
)
3777 c
= make_ctrl_char (c
);
3779 /* Add in the other modifier bits. We took care of ctrl_modifier
3780 just above, and the shift key was taken care of by the X code,
3781 and applied to control characters by make_ctrl_char. */
3782 c
|= (event
->modifiers
3783 & (meta_modifier
| alt_modifier
3784 | hyper_modifier
| super_modifier
));
3785 /* Distinguish Shift-SPC from SPC. */
3786 if ((event
->code
& 0377) == 040
3787 && event
->modifiers
& shift_modifier
)
3788 c
|= shift_modifier
;
3789 button_down_time
= 0;
3790 XSETFASTINT (lispy_c
, c
);
3794 /* A function key. The symbol may need to have modifier prefixes
3796 case non_ascii_keystroke
:
3797 button_down_time
= 0;
3799 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3800 if (event
->code
== lispy_accent_codes
[i
])
3801 return modify_event_symbol (i
,
3803 Qfunction_key
, Qnil
,
3804 lispy_accent_keys
, &accent_key_syms
,
3805 (sizeof (lispy_accent_keys
)
3806 / sizeof (lispy_accent_keys
[0])));
3808 /* Handle system-specific keysyms. */
3809 if (event
->code
& (1 << 28))
3811 /* We need to use an alist rather than a vector as the cache
3812 since we can't make a vector long enuf. */
3813 if (NILP (current_kboard
->system_key_syms
))
3814 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3815 return modify_event_symbol (event
->code
,
3818 current_kboard
->Vsystem_key_alist
,
3819 0, ¤t_kboard
->system_key_syms
,
3824 if (event
->code
>= 0x400 && event
->code
< 0x500)
3825 return modify_event_symbol (event
->code
- 0x400,
3826 event
->modifiers
& ~shift_modifier
,
3827 Qfunction_key
, Qnil
,
3828 lispy_kana_keys
, &func_key_syms
,
3829 (sizeof (lispy_kana_keys
)
3830 / sizeof (lispy_kana_keys
[0])));
3831 #endif /* XK_kana_A */
3833 #ifdef ISO_FUNCTION_KEY_OFFSET
3834 if (event
->code
< FUNCTION_KEY_OFFSET
3835 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3836 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3838 Qfunction_key
, Qnil
,
3839 iso_lispy_function_keys
, &func_key_syms
,
3840 (sizeof (iso_lispy_function_keys
)
3841 / sizeof (iso_lispy_function_keys
[0])));
3844 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3846 Qfunction_key
, Qnil
,
3847 lispy_function_keys
, &func_key_syms
,
3848 (sizeof (lispy_function_keys
)
3849 / sizeof (lispy_function_keys
[0])));
3852 /* A mouse click. Figure out where it is, decide whether it's
3853 a press, click or drag, and build the appropriate structure. */
3855 case scroll_bar_click
:
3857 int button
= event
->code
;
3859 Lisp_Object position
;
3860 Lisp_Object
*start_pos_ptr
;
3861 Lisp_Object start_pos
;
3863 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3866 /* Build the position as appropriate for this mouse click. */
3867 if (event
->kind
== mouse_click
)
3870 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3875 /* Ignore mouse events that were made on frame that
3876 have been deleted. */
3877 if (! FRAME_LIVE_P (f
))
3880 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3881 &column
, &row
, NULL
, 1);
3883 #ifndef USE_X_TOOLKIT
3884 /* In the non-toolkit version, clicks on the menu bar
3885 are ordinary button events in the event buffer.
3886 Distinguish them, and invoke the menu.
3888 (In the toolkit version, the toolkit handles the menu bar
3889 and Emacs doesn't know about it until after the user
3890 makes a selection.) */
3891 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3892 && (event
->modifiers
& down_modifier
))
3894 Lisp_Object items
, item
;
3899 /* Activate the menu bar on the down event. If the
3900 up event comes in before the menu code can deal with it,
3902 if (! (event
->modifiers
& down_modifier
))
3907 items
= FRAME_MENU_BAR_ITEMS (f
);
3908 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3910 Lisp_Object pos
, string
;
3911 string
= XVECTOR (items
)->contents
[i
+ 1];
3912 pos
= XVECTOR (items
)->contents
[i
+ 3];
3915 if (column
>= XINT (pos
)
3916 && column
< XINT (pos
) + XSTRING (string
)->size
)
3918 item
= XVECTOR (items
)->contents
[i
];
3924 = Fcons (event
->frame_or_window
,
3926 Fcons (Fcons (event
->x
, event
->y
),
3927 Fcons (make_number (event
->timestamp
),
3930 return Fcons (item
, Fcons (position
, Qnil
));
3932 #endif /* not USE_X_TOOLKIT */
3934 window
= window_from_coordinates (f
, column
, row
, &part
);
3936 if (!WINDOWP (window
))
3938 window
= event
->frame_or_window
;
3943 int pixcolumn
, pixrow
;
3944 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3945 row
-= XINT (XWINDOW (window
)->top
);
3946 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3947 XSETINT (event
->x
, pixcolumn
);
3948 XSETINT (event
->y
, pixrow
);
3953 posn
= Qvertical_line
;
3956 buffer_posn_from_coords (XWINDOW (window
),
3963 Fcons (Fcons (event
->x
, event
->y
),
3964 Fcons (make_number (event
->timestamp
),
3970 Lisp_Object portion_whole
;
3973 window
= event
->frame_or_window
;
3974 portion_whole
= Fcons (event
->x
, event
->y
);
3975 part
= *scroll_bar_parts
[(int) event
->part
];
3979 Fcons (Qvertical_scroll_bar
,
3980 Fcons (portion_whole
,
3981 Fcons (make_number (event
->timestamp
),
3982 Fcons (part
, Qnil
)))));
3985 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
3987 start_pos
= *start_pos_ptr
;
3988 *start_pos_ptr
= Qnil
;
3990 is_double
= (button
== last_mouse_button
3991 && XINT (event
->x
) == last_mouse_x
3992 && XINT (event
->y
) == last_mouse_y
3993 && button_down_time
!= 0
3994 && (EQ (Vdouble_click_time
, Qt
)
3995 || (INTEGERP (Vdouble_click_time
)
3996 && ((int)(event
->timestamp
- button_down_time
)
3997 < XINT (Vdouble_click_time
)))));
3998 last_mouse_button
= button
;
3999 last_mouse_x
= XINT (event
->x
);
4000 last_mouse_y
= XINT (event
->y
);
4002 /* If this is a button press, squirrel away the location, so
4003 we can decide later whether it was a click or a drag. */
4004 if (event
->modifiers
& down_modifier
)
4008 double_click_count
++;
4009 event
->modifiers
|= ((double_click_count
> 2)
4014 double_click_count
= 1;
4015 button_down_time
= event
->timestamp
;
4016 *start_pos_ptr
= Fcopy_alist (position
);
4019 /* Now we're releasing a button - check the co-ordinates to
4020 see if this was a click or a drag. */
4021 else if (event
->modifiers
& up_modifier
)
4023 /* If we did not see a down before this up,
4024 ignore the up. Probably this happened because
4025 the down event chose a menu item.
4026 It would be an annoyance to treat the release
4027 of the button that chose the menu item
4028 as a separate event. */
4030 if (!CONSP (start_pos
))
4033 event
->modifiers
&= ~up_modifier
;
4034 #if 0 /* Formerly we treated an up with no down as a click event. */
4035 if (!CONSP (start_pos
))
4036 event
->modifiers
|= click_modifier
;
4040 /* The third element of every position should be the (x,y)
4044 down
= Fnth (make_number (2), start_pos
);
4045 if (EQ (event
->x
, XCONS (down
)->car
)
4046 && EQ (event
->y
, XCONS (down
)->cdr
))
4048 event
->modifiers
|= click_modifier
;
4052 button_down_time
= 0;
4053 event
->modifiers
|= drag_modifier
;
4055 /* Don't check is_double; treat this as multiple
4056 if the down-event was multiple. */
4057 if (double_click_count
> 1)
4058 event
->modifiers
|= ((double_click_count
> 2)
4064 /* Every mouse event should either have the down_modifier or
4065 the up_modifier set. */
4069 /* Get the symbol we should use for the mouse click. */
4072 head
= modify_event_symbol (button
,
4075 lispy_mouse_names
, &mouse_syms
,
4076 (sizeof (lispy_mouse_names
)
4077 / sizeof (lispy_mouse_names
[0])));
4078 if (event
->modifiers
& drag_modifier
)
4083 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4086 Fcons (make_number (double_click_count
),
4096 case w32_scroll_bar_click
:
4098 int button
= event
->code
;
4100 Lisp_Object position
;
4101 Lisp_Object
*start_pos_ptr
;
4102 Lisp_Object start_pos
;
4104 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4109 Lisp_Object portion_whole
;
4112 window
= event
->frame_or_window
;
4113 portion_whole
= Fcons (event
->x
, event
->y
);
4114 part
= *scroll_bar_parts
[(int) event
->part
];
4118 Fcons (Qvertical_scroll_bar
,
4119 Fcons (portion_whole
,
4120 Fcons (make_number (event
->timestamp
),
4121 Fcons (part
, Qnil
)))));
4124 /* Always treat W32 scroll bar events as clicks. */
4125 event
->modifiers
|= click_modifier
;
4128 /* Get the symbol we should use for the mouse click. */
4131 head
= modify_event_symbol (button
,
4134 lispy_mouse_names
, &mouse_syms
,
4135 (sizeof (lispy_mouse_names
)
4136 / sizeof (lispy_mouse_names
[0])));
4145 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4148 Lisp_Object head
, position
;
4151 /* Ignore mouse events that were made on frame that
4152 have been deleted. */
4153 if (! FRAME_LIVE_P (f
))
4155 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4156 &column
, &row
, NULL
, 1);
4157 window
= window_from_coordinates (f
, column
, row
, &part
);
4159 if (!WINDOWP (window
))
4161 window
= event
->frame_or_window
;
4166 int pixcolumn
, pixrow
;
4167 column
-= XINT (XWINDOW (window
)->left
);
4168 row
-= XINT (XWINDOW (window
)->top
);
4169 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4170 XSETINT (event
->x
, pixcolumn
);
4171 XSETINT (event
->y
, pixrow
);
4176 posn
= Qvertical_line
;
4179 buffer_posn_from_coords (XWINDOW (window
),
4184 Lisp_Object head
, position
;
4189 Fcons (Fcons (event
->x
, event
->y
),
4190 Fcons (make_number (event
->timestamp
),
4193 head
= modify_event_symbol (0, event
->modifiers
,
4195 lispy_mouse_wheel_names
,
4196 &mouse_wheel_syms
, 1);
4199 Fcons (make_number (event
->code
),
4203 #endif /* WINDOWSNT */
4204 #endif /* HAVE_MOUSE */
4206 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4207 case menu_bar_event
:
4208 /* The event value is in the cdr of the frame_or_window slot. */
4209 if (!CONSP (event
->frame_or_window
))
4211 return XCONS (event
->frame_or_window
)->cdr
;
4214 /* The 'kind' field of the event is something we don't recognize. */
4223 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4225 Lisp_Object bar_window
;
4226 enum scroll_bar_part part
;
4230 /* Is it a scroll bar movement? */
4231 if (frame
&& ! NILP (bar_window
))
4233 Lisp_Object part_sym
;
4235 part_sym
= *scroll_bar_parts
[(int) part
];
4236 return Fcons (Qscroll_bar_movement
,
4237 (Fcons (Fcons (bar_window
,
4238 Fcons (Qvertical_scroll_bar
,
4239 Fcons (Fcons (x
, y
),
4240 Fcons (make_number (time
),
4246 /* Or is it an ordinary mouse movement? */
4256 /* It's in a frame; which window on that frame? */
4257 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4259 window
= window_from_coordinates (frame
, column
, row
, &area
);
4264 if (WINDOWP (window
))
4266 int pixcolumn
, pixrow
;
4267 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4268 row
-= XINT (XWINDOW (window
)->top
);
4269 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4270 XSETINT (x
, pixcolumn
);
4271 XSETINT (y
, pixrow
);
4276 posn
= Qvertical_line
;
4279 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4281 else if (frame
!= 0)
4283 XSETFRAME (window
, frame
);
4294 return Fcons (Qmouse_movement
,
4295 Fcons (Fcons (window
,
4297 Fcons (Fcons (x
, y
),
4298 Fcons (make_number (time
),
4304 #endif /* HAVE_MOUSE */
4306 /* Construct a switch frame event. */
4308 make_lispy_switch_frame (frame
)
4311 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4314 /* Manipulating modifiers. */
4316 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4318 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4319 SYMBOL's name of the end of the modifiers; the string from this
4320 position is the unmodified symbol name.
4322 This doesn't use any caches. */
4325 parse_modifiers_uncached (symbol
, modifier_end
)
4329 struct Lisp_String
*name
;
4333 CHECK_SYMBOL (symbol
, 1);
4336 name
= XSYMBOL (symbol
)->name
;
4338 for (i
= 0; i
+2 <= name
->size_byte
; )
4340 int this_mod_end
= 0;
4343 /* See if the name continues with a modifier word.
4344 Check that the word appears, but don't check what follows it.
4345 Set this_mod and this_mod_end to record what we find. */
4347 switch (name
->data
[i
])
4349 #define SINGLE_LETTER_MOD(BIT) \
4350 (this_mod_end = i + 1, this_mod = BIT)
4353 SINGLE_LETTER_MOD (alt_modifier
);
4357 SINGLE_LETTER_MOD (ctrl_modifier
);
4361 SINGLE_LETTER_MOD (hyper_modifier
);
4365 SINGLE_LETTER_MOD (meta_modifier
);
4369 SINGLE_LETTER_MOD (shift_modifier
);
4373 SINGLE_LETTER_MOD (super_modifier
);
4376 #undef SINGLE_LETTER_MOD
4379 /* If we found no modifier, stop looking for them. */
4380 if (this_mod_end
== 0)
4383 /* Check there is a dash after the modifier, so that it
4384 really is a modifier. */
4385 if (this_mod_end
>= name
->size_byte
|| name
->data
[this_mod_end
] != '-')
4388 /* This modifier is real; look for another. */
4389 modifiers
|= this_mod
;
4390 i
= this_mod_end
+ 1;
4393 /* Should we include the `click' modifier? */
4394 if (! (modifiers
& (down_modifier
| drag_modifier
4395 | double_modifier
| triple_modifier
))
4396 && i
+ 7 == name
->size_byte
4397 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4398 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4399 modifiers
|= click_modifier
;
4407 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4408 prepended to the string BASE[0..BASE_LEN-1].
4409 This doesn't use any caches. */
4411 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
4414 int base_len
, base_len_byte
;
4416 /* Since BASE could contain nulls, we can't use intern here; we have
4417 to use Fintern, which expects a genuine Lisp_String, and keeps a
4420 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4426 /* Only the event queue may use the `up' modifier; it should always
4427 be turned into a click or drag event before presented to lisp code. */
4428 if (modifiers
& up_modifier
)
4431 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4432 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4433 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4434 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4435 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4436 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4437 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4438 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4439 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4440 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4441 /* The click modifier is denoted by the absence of other modifiers. */
4445 mod_len
= p
- new_mods
;
4449 Lisp_Object new_name
;
4451 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
4452 mod_len
+ base_len_byte
);
4453 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4454 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
4456 return Fintern (new_name
, Qnil
);
4461 static char *modifier_names
[] =
4463 "up", "down", "drag", "click", "double", "triple", 0, 0,
4464 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4465 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4467 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4469 static Lisp_Object modifier_symbols
;
4471 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4473 lispy_modifier_list (modifiers
)
4476 Lisp_Object modifier_list
;
4479 modifier_list
= Qnil
;
4480 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4481 if (modifiers
& (1<<i
))
4482 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4485 return modifier_list
;
4489 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4490 where UNMODIFIED is the unmodified form of SYMBOL,
4491 MASK is the set of modifiers present in SYMBOL's name.
4492 This is similar to parse_modifiers_uncached, but uses the cache in
4493 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4494 Qevent_symbol_elements property. */
4497 parse_modifiers (symbol
)
4500 Lisp_Object elements
;
4502 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4503 if (CONSP (elements
))
4508 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4509 Lisp_Object unmodified
;
4512 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4513 XSYMBOL (symbol
)->name
->size_byte
- end
),
4516 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4518 XSETFASTINT (mask
, modifiers
);
4519 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4521 /* Cache the parsing results on SYMBOL. */
4522 Fput (symbol
, Qevent_symbol_element_mask
,
4524 Fput (symbol
, Qevent_symbol_elements
,
4525 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4527 /* Since we know that SYMBOL is modifiers applied to unmodified,
4528 it would be nice to put that in unmodified's cache.
4529 But we can't, since we're not sure that parse_modifiers is
4536 /* Apply the modifiers MODIFIERS to the symbol BASE.
4537 BASE must be unmodified.
4539 This is like apply_modifiers_uncached, but uses BASE's
4540 Qmodifier_cache property, if present. It also builds
4541 Qevent_symbol_elements properties, since it has that info anyway.
4543 apply_modifiers copies the value of BASE's Qevent_kind property to
4544 the modified symbol. */
4546 apply_modifiers (modifiers
, base
)
4550 Lisp_Object cache
, index
, entry
, new_symbol
;
4552 /* Mask out upper bits. We don't know where this value's been. */
4553 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4555 /* The click modifier never figures into cache indices. */
4556 cache
= Fget (base
, Qmodifier_cache
);
4557 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4558 entry
= assq_no_quit (index
, cache
);
4561 new_symbol
= XCONS (entry
)->cdr
;
4564 /* We have to create the symbol ourselves. */
4565 new_symbol
= apply_modifiers_uncached (modifiers
,
4566 XSYMBOL (base
)->name
->data
,
4567 XSYMBOL (base
)->name
->size
,
4568 XSYMBOL (base
)->name
->size_byte
);
4570 /* Add the new symbol to the base's cache. */
4571 entry
= Fcons (index
, new_symbol
);
4572 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4574 /* We have the parsing info now for free, so add it to the caches. */
4575 XSETFASTINT (index
, modifiers
);
4576 Fput (new_symbol
, Qevent_symbol_element_mask
,
4577 Fcons (base
, Fcons (index
, Qnil
)));
4578 Fput (new_symbol
, Qevent_symbol_elements
,
4579 Fcons (base
, lispy_modifier_list (modifiers
)));
4582 /* Make sure this symbol is of the same kind as BASE.
4584 You'd think we could just set this once and for all when we
4585 intern the symbol above, but reorder_modifiers may call us when
4586 BASE's property isn't set right; we can't assume that just
4587 because it has a Qmodifier_cache property it must have its
4588 Qevent_kind set right as well. */
4589 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4593 kind
= Fget (base
, Qevent_kind
);
4595 Fput (new_symbol
, Qevent_kind
, kind
);
4602 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4603 return a symbol with the modifiers placed in the canonical order.
4604 Canonical order is alphabetical, except for down and drag, which
4605 always come last. The 'click' modifier is never written out.
4607 Fdefine_key calls this to make sure that (for example) C-M-foo
4608 and M-C-foo end up being equivalent in the keymap. */
4611 reorder_modifiers (symbol
)
4614 /* It's hopefully okay to write the code this way, since everything
4615 will soon be in caches, and no consing will be done at all. */
4618 parsed
= parse_modifiers (symbol
);
4619 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4620 XCONS (parsed
)->car
);
4624 /* For handling events, we often want to produce a symbol whose name
4625 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4626 to some base, like the name of a function key or mouse button.
4627 modify_event_symbol produces symbols of this sort.
4629 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4630 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4633 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4634 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4636 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4637 persist between calls to modify_event_symbol that it can use to
4638 store a cache of the symbols it's generated for this NAME_TABLE
4639 before. The object stored there may be a vector or an alist.
4641 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4643 MODIFIERS is a set of modifier bits (as given in struct input_events)
4644 whose prefixes should be applied to the symbol name.
4646 SYMBOL_KIND is the value to be placed in the event_kind property of
4647 the returned symbol.
4649 The symbols we create are supposed to have an
4650 `event-symbol-elements' property, which lists the modifiers present
4651 in the symbol's name. */
4654 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4655 name_table
, symbol_table
, table_size
)
4658 Lisp_Object symbol_kind
;
4659 Lisp_Object name_alist
;
4661 Lisp_Object
*symbol_table
;
4662 unsigned int table_size
;
4665 Lisp_Object symbol_int
;
4667 /* Get rid of the "vendor-specific" bit here. */
4668 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4670 /* Is this a request for a valid symbol? */
4671 if (symbol_num
< 0 || symbol_num
>= table_size
)
4674 if (CONSP (*symbol_table
))
4675 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4677 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4678 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4679 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4680 we've never used that symbol before. */
4683 if (! VECTORP (*symbol_table
)
4684 || XVECTOR (*symbol_table
)->size
!= table_size
)
4688 XSETFASTINT (size
, table_size
);
4689 *symbol_table
= Fmake_vector (size
, Qnil
);
4692 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4695 /* Have we already used this symbol before? */
4698 /* No; let's create it. */
4699 if (!NILP (name_alist
))
4700 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4701 else if (name_table
!= 0 && name_table
[symbol_num
])
4702 value
= intern (name_table
[symbol_num
]);
4704 #ifdef HAVE_WINDOW_SYSTEM
4707 char *name
= x_get_keysym_name (symbol_num
);
4709 value
= intern (name
);
4716 sprintf (buf
, "key-%d", symbol_num
);
4717 value
= intern (buf
);
4720 if (CONSP (*symbol_table
))
4721 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4723 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4725 /* Fill in the cache entries for this symbol; this also
4726 builds the Qevent_symbol_elements property, which the user
4728 apply_modifiers (modifiers
& click_modifier
, value
);
4729 Fput (value
, Qevent_kind
, symbol_kind
);
4732 /* Apply modifiers to that symbol. */
4733 return apply_modifiers (modifiers
, value
);
4736 /* Convert a list that represents an event type,
4737 such as (ctrl meta backspace), into the usual representation of that
4738 event type as a number or a symbol. */
4740 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4741 "Convert the event description list EVENT-DESC to an event type.\n\
4742 EVENT-DESC should contain one base event type (a character or symbol)\n\
4743 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4744 drag, down, double or triple). The base must be last.\n\
4745 The return value is an event type (a character or symbol) which\n\
4746 has the same base event type and all the specified modifiers.")
4748 Lisp_Object event_desc
;
4756 while (CONSP (rest
))
4761 elt
= XCONS (rest
)->car
;
4762 rest
= XCONS (rest
)->cdr
;
4764 /* Given a symbol, see if it is a modifier name. */
4765 if (SYMBOLP (elt
) && CONSP (rest
))
4766 this = parse_solitary_modifier (elt
);
4770 else if (!NILP (base
))
4771 error ("Two bases given in one event");
4777 /* Let the symbol A refer to the character A. */
4778 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4779 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4781 if (INTEGERP (base
))
4783 /* Turn (shift a) into A. */
4784 if ((modifiers
& shift_modifier
) != 0
4785 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4787 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4788 modifiers
&= ~shift_modifier
;
4791 /* Turn (control a) into C-a. */
4792 if (modifiers
& ctrl_modifier
)
4793 return make_number ((modifiers
& ~ctrl_modifier
)
4794 | make_ctrl_char (XINT (base
)));
4796 return make_number (modifiers
| XINT (base
));
4798 else if (SYMBOLP (base
))
4799 return apply_modifiers (modifiers
, base
);
4801 error ("Invalid base event");
4804 /* Try to recognize SYMBOL as a modifier name.
4805 Return the modifier flag bit, or 0 if not recognized. */
4808 parse_solitary_modifier (symbol
)
4811 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4813 switch (name
->data
[0])
4815 #define SINGLE_LETTER_MOD(BIT) \
4816 if (name->size_byte == 1) \
4819 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4820 if (LEN == name->size_byte \
4821 && ! strncmp (name->data, NAME, LEN)) \
4825 SINGLE_LETTER_MOD (alt_modifier
);
4829 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4833 SINGLE_LETTER_MOD (ctrl_modifier
);
4837 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4838 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4842 SINGLE_LETTER_MOD (hyper_modifier
);
4846 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4850 SINGLE_LETTER_MOD (meta_modifier
);
4854 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4858 SINGLE_LETTER_MOD (shift_modifier
);
4862 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4863 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4864 SINGLE_LETTER_MOD (super_modifier
);
4868 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4869 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4870 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4874 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4877 #undef SINGLE_LETTER_MOD
4878 #undef MULTI_LETTER_MOD
4884 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4885 Such a list is not valid as an event,
4886 but it can be a Lucid-style event type list. */
4889 lucid_event_type_list_p (object
)
4894 if (! CONSP (object
))
4897 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4900 elt
= XCONS (tail
)->car
;
4901 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
4908 /* Store into *addr a value nonzero if terminal input chars are available.
4909 Serves the purpose of ioctl (0, FIONREAD, addr)
4910 but works even if FIONREAD does not exist.
4911 (In fact, this may actually read some input.)
4913 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
4916 get_input_pending (addr
, do_timers_now
)
4920 /* First of all, have we already counted some input? */
4921 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4923 /* If input is being read as it arrives, and we have none, there is none. */
4924 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
4927 /* Try to read some input and see how much we get. */
4929 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
4932 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
4935 gobble_input (expected
)
4940 if (interrupt_input
)
4943 mask
= sigblock (sigmask (SIGIO
));
4944 read_avail_input (expected
);
4948 #ifdef POLL_FOR_INPUT
4949 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
4952 mask
= sigblock (sigmask (SIGALRM
));
4953 read_avail_input (expected
);
4959 read_avail_input (expected
);
4963 /* Put a buffer_switch_event in the buffer
4964 so that read_key_sequence will notice the new current buffer. */
4967 record_asynch_buffer_change ()
4969 struct input_event event
;
4972 event
.kind
= buffer_switch_event
;
4973 event
.frame_or_window
= Qnil
;
4976 /* We don't need a buffer-switch event unless Emacs is waiting for input.
4977 The purpose of the event is to make read_key_sequence look up the
4978 keymaps again. If we aren't in read_key_sequence, we don't need one,
4979 and the event could cause trouble by messing up (input-pending-p). */
4980 tem
= Fwaiting_for_user_input_p ();
4984 /* We never need these events if we have no asynchronous subprocesses. */
4988 /* Make sure no interrupt happens while storing the event. */
4990 if (interrupt_input
)
4993 mask
= sigblock (sigmask (SIGIO
));
4994 kbd_buffer_store_event (&event
);
5001 kbd_buffer_store_event (&event
);
5008 /* Read any terminal input already buffered up by the system
5009 into the kbd_buffer, but do not wait.
5011 EXPECTED should be nonzero if the caller knows there is some input.
5013 Except on VMS, all input is read by this function.
5014 If interrupt_input is nonzero, this function MUST be called
5015 only when SIGIO is blocked.
5017 Returns the number of keyboard chars read, or -1 meaning
5018 this is a bad time to try to read input. */
5021 read_avail_input (expected
)
5024 struct input_event buf
[KBD_BUFFER_SIZE
];
5028 if (read_socket_hook
)
5029 /* No need for FIONREAD or fcntl; just say don't wait. */
5030 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5033 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5034 the kbd_buffer can really hold. That may prevent loss
5035 of characters on some systems when input is stuffed at us. */
5036 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5039 /* Determine how many characters we should *try* to read. */
5042 #else /* not WINDOWSNT */
5044 n_to_read
= dos_keysns ();
5047 #else /* not MSDOS */
5049 /* Find out how much input is available. */
5050 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5051 /* Formerly simply reported no input, but that sometimes led to
5052 a failure of Emacs to terminate.
5053 SIGHUP seems appropriate if we can't reach the terminal. */
5054 /* ??? Is it really right to send the signal just to this process
5055 rather than to the whole process group?
5056 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5057 kill (getpid (), SIGHUP
);
5060 if (n_to_read
> sizeof cbuf
)
5061 n_to_read
= sizeof cbuf
;
5062 #else /* no FIONREAD */
5063 #if defined (USG) || defined (DGUX)
5064 /* Read some input if available, but don't wait. */
5065 n_to_read
= sizeof cbuf
;
5066 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5071 #endif /* not MSDOS */
5072 #endif /* not WINDOWSNT */
5074 /* Now read; for one reason or another, this will not block.
5075 NREAD is set to the number of chars read. */
5079 cbuf
[0] = dos_keyread ();
5082 nread
= read (input_fd
, cbuf
, n_to_read
);
5084 /* POSIX infers that processes which are not in the session leader's
5085 process group won't get SIGHUP's at logout time. BSDI adheres to
5086 this part standard and returns -1 from read(0) with errno==EIO
5087 when the control tty is taken away.
5088 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5089 if (nread
== -1 && errno
== EIO
)
5091 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5092 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5093 This looks incorrect, but it isn't, because _BSD causes
5094 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5095 and that causes a value other than 0 when there is no input. */
5101 /* We used to retry the read if it was interrupted.
5102 But this does the wrong thing when O_NDELAY causes
5103 an EAGAIN error. Does anybody know of a situation
5104 where a retry is actually needed? */
5106 nread
< 0 && (errno
== EAGAIN
5120 #if defined (USG) || defined (DGUX)
5121 fcntl (input_fd
, F_SETFL
, 0);
5122 #endif /* USG or DGUX */
5123 #endif /* no FIONREAD */
5124 for (i
= 0; i
< nread
; i
++)
5126 buf
[i
].kind
= ascii_keystroke
;
5127 buf
[i
].modifiers
= 0;
5128 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5129 buf
[i
].modifiers
= meta_modifier
;
5133 buf
[i
].code
= cbuf
[i
];
5134 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5138 /* Scan the chars for C-g and store them in kbd_buffer. */
5139 for (i
= 0; i
< nread
; i
++)
5141 kbd_buffer_store_event (&buf
[i
]);
5142 /* Don't look at input that follows a C-g too closely.
5143 This reduces lossage due to autorepeat on C-g. */
5144 if (buf
[i
].kind
== ascii_keystroke
5145 && buf
[i
].code
== quit_char
)
5151 #endif /* not VMS */
5153 #ifdef SIGIO /* for entire page */
5154 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5157 input_available_signal (signo
)
5160 /* Must preserve main program's value of errno. */
5161 int old_errno
= errno
;
5163 extern int select_alarmed
;
5166 #if defined (USG) && !defined (POSIX_SIGNALS)
5167 /* USG systems forget handlers when they are used;
5168 must reestablish each time */
5169 signal (signo
, input_available_signal
);
5176 if (input_available_clear_time
)
5177 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5182 nread
= read_avail_input (1);
5183 /* -1 means it's not ok to read the input now.
5184 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5185 0 means there was no keyboard input available. */
5190 select_alarmed
= 1; /* Force the select emulator back to life */
5201 /* Send ourselves a SIGIO.
5203 This function exists so that the UNBLOCK_INPUT macro in
5204 blockinput.h can have some way to take care of input we put off
5205 dealing with, without assuming that every file which uses
5206 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5208 reinvoke_input_signal ()
5211 kill (getpid (), SIGIO
);
5217 /* Return the prompt-string of a sparse keymap.
5218 This is the first element which is a string.
5219 Return nil if there is none. */
5227 register Lisp_Object tem
;
5236 static void menu_bar_item ();
5237 static void menu_bar_one_keymap ();
5239 /* These variables hold the vector under construction within
5240 menu_bar_items and its subroutines, and the current index
5241 for storing into that vector. */
5242 static Lisp_Object menu_bar_items_vector
;
5243 static int menu_bar_items_index
;
5245 /* Return a vector of menu items for a menu bar, appropriate
5246 to the current buffer. Each item has three elements in the vector:
5249 OLD is an old vector we can optionally reuse, or nil. */
5252 menu_bar_items (old
)
5255 /* The number of keymaps we're scanning right now, and the number of
5256 keymaps we have allocated space for. */
5259 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5260 in the current keymaps, or nil where it is not a prefix. */
5263 Lisp_Object def
, tem
, tail
;
5272 struct gcpro gcpro1
;
5274 /* In order to build the menus, we need to call the keymap
5275 accessors. They all call QUIT. But this function is called
5276 during redisplay, during which a quit is fatal. So inhibit
5277 quitting while building the menus.
5278 We do this instead of specbind because (1) errors will clear it anyway
5279 and (2) this avoids risk of specpdl overflow. */
5280 oquit
= Vinhibit_quit
;
5284 menu_bar_items_vector
= old
;
5286 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5287 menu_bar_items_index
= 0;
5289 GCPRO1 (menu_bar_items_vector
);
5291 /* Build our list of keymaps.
5292 If we recognize a function key and replace its escape sequence in
5293 keybuf with its symbol, or if the sequence starts with a mouse
5294 click and we need to switch buffers, we jump back here to rebuild
5295 the initial keymaps from the current buffer. */
5299 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5300 if (!NILP (Voverriding_local_map_menu_flag
))
5302 /* Yes, use them (if non-nil) as well as the global map. */
5303 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5305 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5306 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5307 if (!NILP (Voverriding_local_map
))
5308 maps
[nmaps
++] = Voverriding_local_map
;
5312 /* No, so use major and minor mode keymaps. */
5313 nmaps
= current_minor_maps (NULL
, &tmaps
);
5314 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5315 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5316 #ifdef USE_TEXT_PROPERTIES
5317 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5319 maps
[nmaps
++] = current_buffer
->keymap
;
5322 maps
[nmaps
++] = current_global_map
;
5325 /* Look up in each map the dummy prefix key `menu-bar'. */
5329 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5331 if (! NILP (maps
[mapno
]))
5332 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5336 tem
= Fkeymapp (def
);
5338 menu_bar_one_keymap (def
);
5341 /* Move to the end those items that should be at the end. */
5343 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5346 int end
= menu_bar_items_index
;
5348 for (i
= 0; i
< end
; i
+= 4)
5349 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5351 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5352 /* Move the item at index I to the end,
5353 shifting all the others forward. */
5354 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5355 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5356 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5357 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5359 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5360 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5361 (end
- i
- 4) * sizeof (Lisp_Object
));
5362 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5363 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5364 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5365 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5370 /* Add nil, nil, nil, nil at the end. */
5371 i
= menu_bar_items_index
;
5372 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5375 int newsize
= 2 * i
;
5376 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5377 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5378 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5379 menu_bar_items_vector
= tem
;
5381 /* Add this item. */
5382 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5383 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5384 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5385 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5386 menu_bar_items_index
= i
;
5388 Vinhibit_quit
= oquit
;
5390 return menu_bar_items_vector
;
5393 /* Scan one map KEYMAP, accumulating any menu items it defines
5394 in menu_bar_items_vector. */
5397 menu_bar_one_keymap (keymap
)
5400 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
5402 /* Loop over all keymap entries that have menu strings. */
5403 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5405 item
= XCONS (tail
)->car
;
5408 key
= XCONS (item
)->car
;
5409 binding
= XCONS (item
)->cdr
;
5410 if (CONSP (binding
))
5412 item_string
= XCONS (binding
)->car
;
5413 if (STRINGP (item_string
))
5414 menu_bar_item (key
, item_string
, Fcdr (binding
));
5416 else if (EQ (binding
, Qundefined
))
5417 menu_bar_item (key
, Qnil
, binding
);
5419 else if (VECTORP (item
))
5421 /* Loop over the char values represented in the vector. */
5422 int len
= XVECTOR (item
)->size
;
5424 for (c
= 0; c
< len
; c
++)
5426 Lisp_Object character
;
5427 XSETFASTINT (character
, c
);
5428 binding
= XVECTOR (item
)->contents
[c
];
5429 if (CONSP (binding
))
5431 item_string
= XCONS (binding
)->car
;
5432 if (STRINGP (item_string
))
5433 menu_bar_item (key
, item_string
, Fcdr (binding
));
5435 else if (EQ (binding
, Qundefined
))
5436 menu_bar_item (key
, Qnil
, binding
);
5442 /* This is used as the handler when calling internal_condition_case_1. */
5445 menu_bar_item_1 (arg
)
5451 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5452 If there's already an item for KEY, add this DEF to it. */
5455 menu_bar_item (key
, item_string
, def
)
5456 Lisp_Object key
, item_string
, def
;
5459 Lisp_Object enabled
;
5462 /* Skip menu-bar equiv keys data. */
5463 if (CONSP (def
) && CONSP (XCONS (def
)->car
))
5464 def
= XCONS (def
)->cdr
;
5466 if (EQ (def
, Qundefined
))
5468 /* If a map has an explicit `undefined' as definition,
5469 discard any previously made menu bar item. */
5471 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5472 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5474 if (menu_bar_items_index
> i
+ 4)
5475 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5476 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5477 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5478 menu_bar_items_index
-= 4;
5482 /* If there's no definition for this key yet,
5483 just ignore `undefined'. */
5487 /* See if this entry is enabled. */
5492 /* No property, or nil, means enable.
5493 Otherwise, enable if value is not nil. */
5494 tem
= Fget (def
, Qmenu_enable
);
5496 /* (condition-case nil (eval tem)
5498 enabled
= internal_condition_case_1 (Feval
, tem
, Qerror
,
5502 /* Ignore this item if it's not enabled. */
5506 /* Find any existing item for this KEY. */
5507 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5508 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5511 /* If we did not find this KEY, add it at the end. */
5512 if (i
== menu_bar_items_index
)
5514 /* If vector is too small, get a bigger one. */
5515 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5518 int newsize
= 2 * i
;
5519 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5520 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5521 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5522 menu_bar_items_vector
= tem
;
5524 /* Add this item. */
5525 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5526 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = item_string
;
5527 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (def
, Qnil
);
5528 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5529 menu_bar_items_index
= i
;
5531 /* We did find an item for this KEY. Add DEF to its list of maps. */
5535 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5536 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (def
, old
);
5540 /* Read a character using menus based on maps in the array MAPS.
5541 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5542 Return t if we displayed a menu but the user rejected it.
5544 PREV_EVENT is the previous input event, or nil if we are reading
5545 the first event of a key sequence.
5547 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5548 if we used a mouse menu to read the input, or zero otherwise. If
5549 USED_MOUSE_MENU is null, we don't dereference it.
5551 The prompting is done based on the prompt-string of the map
5552 and the strings associated with various map elements.
5554 This can be done with X menus or with menus put in the minibuf.
5555 These are done in different ways, depending on how the input will be read.
5556 Menus using X are done after auto-saving in read-char, getting the input
5557 event from Fx_popup_menu; menus using the minibuf use read_char recursively
5558 and do auto-saving in the inner call of read_char. */
5561 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
5564 Lisp_Object prev_event
;
5565 int *used_mouse_menu
;
5568 register Lisp_Object name
;
5569 Lisp_Object rest
, vector
;
5571 if (used_mouse_menu
)
5572 *used_mouse_menu
= 0;
5574 /* Use local over global Menu maps */
5576 if (! menu_prompting
)
5579 /* Optionally disregard all but the global map. */
5580 if (inhibit_local_menu_bar_menus
)
5582 maps
+= (nmaps
- 1);
5586 /* Get the menu name from the first map that has one (a prompt string). */
5587 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5589 name
= map_prompt (maps
[mapno
]);
5594 /* If we don't have any menus, just read a character normally. */
5599 /* If we got to this point via a mouse click,
5600 use a real menu for mouse selection. */
5601 if (EVENT_HAS_PARAMETERS (prev_event
)
5602 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
5604 /* Display the menu and get the selection. */
5605 Lisp_Object
*realmaps
5606 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
5610 /* Use the maps that are not nil. */
5611 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5612 if (!NILP (maps
[mapno
]))
5613 realmaps
[nmaps1
++] = maps
[mapno
];
5615 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
5620 record_menu_key (XCONS (value
)->car
);
5622 /* If we got multiple events, unread all but
5624 There is no way to prevent those unread events
5625 from showing up later in last_nonmenu_event.
5626 So turn symbol and integer events into lists,
5627 to indicate that they came from a mouse menu,
5628 so that when present in last_nonmenu_event
5629 they won't confuse things. */
5630 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
5631 tem
= XCONS (tem
)->cdr
)
5633 record_menu_key (XCONS (tem
)->car
);
5634 if (SYMBOLP (XCONS (tem
)->car
)
5635 || INTEGERP (XCONS (tem
)->car
))
5637 = Fcons (XCONS (tem
)->car
, Qnil
);
5640 /* If we got more than one event, put all but the first
5641 onto this list to be read later.
5642 Return just the first event now. */
5643 Vunread_command_events
5644 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
5645 value
= XCONS (value
)->car
;
5647 else if (NILP (value
))
5649 if (used_mouse_menu
)
5650 *used_mouse_menu
= 1;
5653 #endif /* HAVE_MENUS */
5657 /* Buffer in use so far for the minibuf prompts for menu keymaps.
5658 We make this bigger when necessary, and never free it. */
5659 static char *read_char_minibuf_menu_text
;
5660 /* Size of that buffer. */
5661 static int read_char_minibuf_menu_width
;
5664 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
5670 register Lisp_Object name
;
5672 int width
= FRAME_WIDTH (selected_frame
) - 4;
5675 Lisp_Object rest
, vector
;
5678 if (! menu_prompting
)
5681 /* Make sure we have a big enough buffer for the menu text. */
5682 if (read_char_minibuf_menu_text
== 0)
5684 read_char_minibuf_menu_width
= width
+ 4;
5685 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
5687 else if (width
+ 4 > read_char_minibuf_menu_width
)
5689 read_char_minibuf_menu_width
= width
+ 4;
5690 read_char_minibuf_menu_text
5691 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
5693 menu
= read_char_minibuf_menu_text
;
5695 /* Get the menu name from the first map that has one (a prompt string). */
5696 for (mapno
= 0; mapno
< nmaps
; mapno
++)
5698 name
= map_prompt (maps
[mapno
]);
5703 /* If we don't have any menus, just read a character normally. */
5707 /* Prompt string always starts with map's prompt, and a space. */
5708 strcpy (menu
, XSTRING (name
)->data
);
5709 nlength
= XSTRING (name
)->size_byte
;
5710 menu
[nlength
++] = ':';
5711 menu
[nlength
++] = ' ';
5714 /* Start prompting at start of first map. */
5718 /* Present the documented bindings, a line at a time. */
5725 Lisp_Object orig_defn_macro
;
5727 /* Loop over elements of map. */
5732 /* If reached end of map, start at beginning of next map. */
5736 /* At end of last map, wrap around to first map if just starting,
5737 or end this line if already have something on it. */
5741 if (notfirst
|| nobindings
) break;
5746 /* Look at the next element of the map. */
5748 elt
= XVECTOR (vector
)->contents
[idx
];
5750 elt
= Fcar_safe (rest
);
5752 if (idx
< 0 && VECTORP (elt
))
5754 /* If we found a dense table in the keymap,
5755 advanced past it, but start scanning its contents. */
5756 rest
= Fcdr_safe (rest
);
5762 /* An ordinary element. */
5767 s
= Fcar_safe (Fcdr_safe (elt
)); /* alist */
5768 event
= Fcar_safe (elt
);
5772 s
= Fcar_safe (elt
); /* vector */
5773 XSETINT (event
, idx
);
5776 /* Ignore the element if it has no prompt string. */
5777 if (STRINGP (s
) && INTEGERP (event
))
5779 /* 1 if the char to type matches the string. */
5781 Lisp_Object upcased_event
, downcased_event
;
5784 upcased_event
= Fupcase (event
);
5785 downcased_event
= Fdowncase (event
);
5786 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
5787 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
5789 desc
= Fsingle_key_description (event
);
5791 /* If we have room for the prompt string, add it to this line.
5792 If this is the first on the line, always add it. */
5793 if ((XSTRING (s
)->size
+ i
+ 2
5794 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
5800 /* Punctuate between strings. */
5803 strcpy (menu
+ i
, ", ");
5809 /* If the char to type doesn't match the string's
5810 first char, explicitly show what char to type. */
5813 /* Add as much of string as fits. */
5814 thiswidth
= XSTRING (desc
)->size
;
5815 if (thiswidth
+ i
> width
)
5816 thiswidth
= width
- i
;
5817 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
5819 strcpy (menu
+ i
, " = ");
5823 /* Add as much of string as fits. */
5824 thiswidth
= XSTRING (s
)->size
;
5825 if (thiswidth
+ i
> width
)
5826 thiswidth
= width
- i
;
5827 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
5833 /* If this element does not fit, end the line now,
5834 and save the element for the next line. */
5835 strcpy (menu
+ i
, "...");
5840 /* Move past this element. */
5841 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
5842 /* Handle reaching end of dense table. */
5847 rest
= Fcdr_safe (rest
);
5851 /* Prompt with that and read response. */
5852 message2_nolog (menu
, strlen (menu
),
5853 ! NILP (current_buffer
->enable_multibyte_characters
));
5855 /* Make believe its not a keyboard macro in case the help char
5856 is pressed. Help characters are not recorded because menu prompting
5857 is not used on replay.
5859 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
5860 current_kboard
->defining_kbd_macro
= Qnil
;
5862 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
5863 while (BUFFERP (obj
));
5864 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
5866 if (!INTEGERP (obj
))
5871 if (! EQ (obj
, menu_prompt_more_char
)
5872 && (!INTEGERP (menu_prompt_more_char
)
5873 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
5875 if (!NILP (current_kboard
->defining_kbd_macro
))
5876 store_kbd_macro_char (obj
);
5879 /* Help char - go round again */
5883 /* Reading key sequences. */
5885 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
5886 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
5887 keymap, or nil otherwise. Return the index of the first keymap in
5888 which KEY has any binding, or NMAPS if no map has a binding.
5890 If KEY is a meta ASCII character, treat it like meta-prefix-char
5891 followed by the corresponding non-meta character. Keymaps in
5892 CURRENT with non-prefix bindings for meta-prefix-char become nil in
5895 If KEY has no bindings in any of the CURRENT maps, NEXT is left
5898 NEXT may be the same array as CURRENT. */
5901 follow_key (key
, nmaps
, current
, defs
, next
)
5903 Lisp_Object
*current
, *defs
, *next
;
5906 int i
, first_binding
;
5909 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
5910 followed by the corresponding non-meta character.
5911 Put the results into DEFS, since we are going to alter that anyway.
5912 Do not alter CURRENT or NEXT. */
5913 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
5915 for (i
= 0; i
< nmaps
; i
++)
5916 if (! NILP (current
[i
]))
5919 def
= get_keyelt (access_keymap (current
[i
],
5920 meta_prefix_char
, 1, 0), 0);
5922 /* Note that since we pass the resulting bindings through
5923 get_keymap_1, non-prefix bindings for meta-prefix-char
5925 defs
[i
] = get_keymap_1 (def
, 0, 1);
5931 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
5934 first_binding
= nmaps
;
5935 for (i
= nmaps
- 1; i
>= 0; i
--)
5937 if (! NILP (current
[i
]))
5945 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
5946 if (! NILP (defs
[i
]))
5953 /* Given the set of bindings we've found, produce the next set of maps. */
5954 if (first_binding
< nmaps
)
5955 for (i
= 0; i
< nmaps
; i
++)
5956 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
5958 return first_binding
;
5961 /* Read a sequence of keys that ends with a non prefix character,
5962 storing it in KEYBUF, a buffer of size BUFSIZE.
5964 Return the length of the key sequence stored.
5965 Return -1 if the user rejected a command menu.
5967 Echo starting immediately unless `prompt' is 0.
5969 Where a key sequence ends depends on the currently active keymaps.
5970 These include any minor mode keymaps active in the current buffer,
5971 the current buffer's local map, and the global map.
5973 If a key sequence has no other bindings, we check Vfunction_key_map
5974 to see if some trailing subsequence might be the beginning of a
5975 function key's sequence. If so, we try to read the whole function
5976 key, and substitute its symbolic name into the key sequence.
5978 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
5979 `double-' events into similar click events, if that would make them
5980 bound. We try to turn `triple-' events first into `double-' events,
5983 If we get a mouse click in a mode line, vertical divider, or other
5984 non-text area, we treat the click as if it were prefixed by the
5985 symbol denoting that area - `mode-line', `vertical-line', or
5988 If the sequence starts with a mouse click, we read the key sequence
5989 with respect to the buffer clicked on, not the current buffer.
5991 If the user switches frames in the midst of a key sequence, we put
5992 off the switch-frame event until later; the next call to
5993 read_char will return it.
5995 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
5996 from the selected window's buffer. */
5999 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
6000 can_return_switch_frame
, fix_current_buffer
)
6001 Lisp_Object
*keybuf
;
6004 int dont_downcase_last
;
6005 int can_return_switch_frame
;
6006 int fix_current_buffer
;
6008 int count
= specpdl_ptr
- specpdl
;
6010 /* How many keys there are in the current key sequence. */
6013 /* The length of the echo buffer when we started reading, and
6014 the length of this_command_keys when we started reading. */
6018 /* The number of keymaps we're scanning right now, and the number of
6019 keymaps we have allocated space for. */
6021 int nmaps_allocated
= 0;
6023 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
6024 the current keymaps. */
6027 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6028 in the current keymaps, or nil where it is not a prefix. */
6029 Lisp_Object
*submaps
;
6031 /* The local map to start out with at start of key sequence. */
6032 Lisp_Object orig_local_map
;
6034 /* 1 if we have already considered switching to the local-map property
6035 of the place where a mouse click occurred. */
6036 int localized_local_map
= 0;
6038 /* The index in defs[] of the first keymap that has a binding for
6039 this key sequence. In other words, the lowest i such that
6040 defs[i] is non-nil. */
6043 /* If t < mock_input, then KEYBUF[t] should be read as the next
6046 We use this to recover after recognizing a function key. Once we
6047 realize that a suffix of the current key sequence is actually a
6048 function key's escape sequence, we replace the suffix with the
6049 function key's binding from Vfunction_key_map. Now keybuf
6050 contains a new and different key sequence, so the echo area,
6051 this_command_keys, and the submaps and defs arrays are wrong. In
6052 this situation, we set mock_input to t, set t to 0, and jump to
6053 restart_sequence; the loop will read keys from keybuf up until
6054 mock_input, thus rebuilding the state; and then it will resume
6055 reading characters from the keyboard. */
6058 /* If the sequence is unbound in submaps[], then
6059 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6060 and fkey_map is its binding.
6062 These might be > t, indicating that all function key scanning
6063 should hold off until t reaches them. We do this when we've just
6064 recognized a function key, to avoid searching for the function
6065 key's again in Vfunction_key_map. */
6066 int fkey_start
= 0, fkey_end
= 0;
6067 Lisp_Object fkey_map
;
6069 /* Likewise, for key_translation_map. */
6070 int keytran_start
= 0, keytran_end
= 0;
6071 Lisp_Object keytran_map
;
6073 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6074 we put it off for later. While we're reading, we keep the event here. */
6075 Lisp_Object delayed_switch_frame
;
6077 /* See the comment below... */
6078 #if defined (GOBBLE_FIRST_EVENT)
6079 Lisp_Object first_event
;
6082 Lisp_Object original_uppercase
;
6083 int original_uppercase_position
= -1;
6085 /* Gets around Microsoft compiler limitations. */
6088 struct buffer
*starting_buffer
;
6090 /* Nonzero if we seem to have got the beginning of a binding
6091 in function_key_map. */
6092 int function_key_possible
= 0;
6093 int key_translation_possible
= 0;
6095 /* Save the status of key translation before each step,
6096 so that we can restore this after downcasing. */
6097 Lisp_Object prev_fkey_map
;
6098 int prev_fkey_start
;
6101 Lisp_Object prev_keytran_map
;
6102 int prev_keytran_start
;
6103 int prev_keytran_end
;
6107 last_nonmenu_event
= Qnil
;
6109 delayed_switch_frame
= Qnil
;
6110 fkey_map
= Vfunction_key_map
;
6111 keytran_map
= Vkey_translation_map
;
6113 /* If there is no function-key-map, turn off function key scanning. */
6114 if (NILP (Fkeymapp (Vfunction_key_map
)))
6115 fkey_start
= fkey_end
= bufsize
+ 1;
6117 /* If there is no key-translation-map, turn off scanning. */
6118 if (NILP (Fkeymapp (Vkey_translation_map
)))
6119 keytran_start
= keytran_end
= bufsize
+ 1;
6124 echo_prompt (XSTRING (prompt
)->data
);
6125 else if (cursor_in_echo_area
&& echo_keystrokes
)
6126 /* This doesn't put in a dash if the echo buffer is empty, so
6127 you don't always see a dash hanging out in the minibuffer. */
6131 /* Record the initial state of the echo area and this_command_keys;
6132 we will need to restore them if we replay a key sequence. */
6134 echo_start
= echo_length ();
6135 keys_start
= this_command_key_count
;
6136 this_single_command_key_start
= keys_start
;
6138 #if defined (GOBBLE_FIRST_EVENT)
6139 /* This doesn't quite work, because some of the things that read_char
6140 does cannot safely be bypassed. It seems too risky to try to make
6143 /* Read the first char of the sequence specially, before setting
6144 up any keymaps, in case a filter runs and switches buffers on us. */
6145 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6147 #endif /* GOBBLE_FIRST_EVENT */
6149 orig_local_map
= get_local_map (PT
, current_buffer
);
6151 /* We jump here when the key sequence has been thoroughly changed, and
6152 we need to rescan it starting from the beginning. When we jump here,
6153 keybuf[0..mock_input] holds the sequence we should reread. */
6156 starting_buffer
= current_buffer
;
6157 function_key_possible
= 0;
6158 key_translation_possible
= 0;
6160 /* Build our list of keymaps.
6161 If we recognize a function key and replace its escape sequence in
6162 keybuf with its symbol, or if the sequence starts with a mouse
6163 click and we need to switch buffers, we jump back here to rebuild
6164 the initial keymaps from the current buffer. */
6168 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6169 || !NILP (Voverriding_local_map
))
6171 if (3 > nmaps_allocated
)
6173 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6174 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6175 nmaps_allocated
= 3;
6178 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6179 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6180 if (!NILP (Voverriding_local_map
))
6181 submaps
[nmaps
++] = Voverriding_local_map
;
6185 nmaps
= current_minor_maps (0, &maps
);
6186 if (nmaps
+ 2 > nmaps_allocated
)
6188 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6189 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6190 nmaps_allocated
= nmaps
+ 2;
6192 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6193 #ifdef USE_TEXT_PROPERTIES
6194 submaps
[nmaps
++] = orig_local_map
;
6196 submaps
[nmaps
++] = current_buffer
->keymap
;
6199 submaps
[nmaps
++] = current_global_map
;
6202 /* Find an accurate initial value for first_binding. */
6203 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6204 if (! NILP (submaps
[first_binding
]))
6207 /* Start from the beginning in keybuf. */
6210 /* These are no-ops the first time through, but if we restart, they
6211 revert the echo area and this_command_keys to their original state. */
6212 this_command_key_count
= keys_start
;
6213 if (INTERACTIVE
&& t
< mock_input
)
6214 echo_truncate (echo_start
);
6216 /* If the best binding for the current key sequence is a keymap, or
6217 we may be looking at a function key's escape sequence, keep on
6219 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6220 || (first_binding
>= nmaps
6222 /* mock input is never part of a function key's sequence. */
6223 && mock_input
<= fkey_start
)
6224 || (first_binding
>= nmaps
6225 && keytran_start
< t
&& key_translation_possible
)
6226 /* Don't return in the middle of a possible function key sequence,
6227 if the only bindings we found were via case conversion.
6228 Thus, if ESC O a has a function-key-map translation
6229 and ESC o has a binding, don't return after ESC O,
6230 so that we can translate ESC O plus the next character. */
6234 int used_mouse_menu
= 0;
6236 /* Where the last real key started. If we need to throw away a
6237 key that has expanded into more than one element of keybuf
6238 (say, a mouse click on the mode line which is being treated
6239 as [mode-line (mouse-...)], then we backtrack to this point
6241 int last_real_key_start
;
6243 /* These variables are analogous to echo_start and keys_start;
6244 while those allow us to restart the entire key sequence,
6245 echo_local_start and keys_local_start allow us to throw away
6247 int echo_local_start
, keys_local_start
, local_first_binding
;
6250 error ("Key sequence too long");
6253 echo_local_start
= echo_length ();
6254 keys_local_start
= this_command_key_count
;
6255 local_first_binding
= first_binding
;
6258 /* These are no-ops, unless we throw away a keystroke below and
6259 jumped back up to replay_key; in that case, these restore the
6260 variables to their original state, allowing us to replay the
6262 if (INTERACTIVE
&& t
< mock_input
)
6263 echo_truncate (echo_local_start
);
6264 this_command_key_count
= keys_local_start
;
6265 first_binding
= local_first_binding
;
6267 /* By default, assume each event is "real". */
6268 last_real_key_start
= t
;
6270 /* Does mock_input indicate that we are re-reading a key sequence? */
6274 add_command_key (key
);
6275 if (echo_keystrokes
)
6279 /* If not, we should actually read a character. */
6282 struct buffer
*buf
= current_buffer
;
6286 KBOARD
*interrupted_kboard
= current_kboard
;
6287 struct frame
*interrupted_frame
= selected_frame
;
6288 if (setjmp (wrong_kboard_jmpbuf
))
6290 if (!NILP (delayed_switch_frame
))
6292 interrupted_kboard
->kbd_queue
6293 = Fcons (delayed_switch_frame
,
6294 interrupted_kboard
->kbd_queue
);
6295 delayed_switch_frame
= Qnil
;
6298 interrupted_kboard
->kbd_queue
6299 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6301 /* If the side queue is non-empty, ensure it begins with a
6302 switch-frame, so we'll replay it in the right context. */
6303 if (CONSP (interrupted_kboard
->kbd_queue
)
6304 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6305 !(EVENT_HAS_PARAMETERS (key
)
6306 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6310 XSETFRAME (frame
, interrupted_frame
);
6311 interrupted_kboard
->kbd_queue
6312 = Fcons (make_lispy_switch_frame (frame
),
6313 interrupted_kboard
->kbd_queue
);
6316 orig_local_map
= get_local_map (PT
, current_buffer
);
6317 goto replay_sequence
;
6320 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6324 /* read_char returns t when it shows a menu and the user rejects it.
6329 /* read_char returns -1 at the end of a macro.
6330 Emacs 18 handles this by returning immediately with a
6331 zero, so that's what we'll do. */
6332 if (INTEGERP (key
) && XINT (key
) == -1)
6335 /* The Microsoft C compiler can't handle the goto that
6341 /* If the current buffer has been changed from under us, the
6342 keymap may have changed, so replay the sequence. */
6346 /* Reset the current buffer from the selected window
6347 in case something changed the former and not the latter.
6348 This is to be more consistent with the behavior
6349 of the command_loop_1. */
6350 if (fix_current_buffer
)
6351 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6352 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6354 orig_local_map
= get_local_map (PT
, current_buffer
);
6355 goto replay_sequence
;
6358 /* If we have a quit that was typed in another frame, and
6359 quit_throw_to_read_char switched buffers,
6360 replay to get the right keymap. */
6361 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6366 orig_local_map
= get_local_map (PT
, current_buffer
);
6367 goto replay_sequence
;
6373 /* Clicks in non-text areas get prefixed by the symbol
6374 in their CHAR-ADDRESS field. For example, a click on
6375 the mode line is prefixed by the symbol `mode-line'.
6377 Furthermore, key sequences beginning with mouse clicks
6378 are read using the keymaps of the buffer clicked on, not
6379 the current buffer. So we may have to switch the buffer
6382 When we turn one event into two events, we must make sure
6383 that neither of the two looks like the original--so that,
6384 if we replay the events, they won't be expanded again.
6385 If not for this, such reexpansion could happen either here
6386 or when user programs play with this-command-keys. */
6387 if (EVENT_HAS_PARAMETERS (key
))
6391 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6392 if (EQ (kind
, Qmouse_click
))
6394 Lisp_Object window
, posn
;
6396 window
= POSN_WINDOW (EVENT_START (key
));
6397 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6400 /* We're looking at the second event of a
6401 sequence which we expanded before. Set
6402 last_real_key_start appropriately. */
6404 last_real_key_start
= t
- 1;
6407 /* Key sequences beginning with mouse clicks are
6408 read using the keymaps in the buffer clicked on,
6409 not the current buffer. If we're at the
6410 beginning of a key sequence, switch buffers. */
6411 if (last_real_key_start
== 0
6413 && BUFFERP (XWINDOW (window
)->buffer
)
6414 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6419 /* Arrange to go back to the original buffer once we're
6420 done reading the key sequence. Note that we can't
6421 use save_excursion_{save,restore} here, because they
6422 save point as well as the current buffer; we don't
6423 want to save point, because redisplay may change it,
6424 to accommodate a Fset_window_start or something. We
6425 don't want to do this at the top of the function,
6426 because we may get input from a subprocess which
6427 wants to change the selected window and stuff (say,
6429 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6431 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6432 orig_local_map
= get_local_map (PT
, current_buffer
);
6433 goto replay_sequence
;
6435 /* For a mouse click, get the local text-property keymap
6436 of the place clicked on, rather than point. */
6437 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6438 && ! localized_local_map
)
6440 Lisp_Object map_here
, start
, pos
;
6442 localized_local_map
= 1;
6443 start
= EVENT_START (key
);
6444 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6446 pos
= POSN_BUFFER_POSN (start
);
6448 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6450 map_here
= get_local_map (XINT (pos
), current_buffer
);
6451 if (!EQ (map_here
, orig_local_map
))
6453 orig_local_map
= map_here
;
6457 goto replay_sequence
;
6463 /* Expand mode-line and scroll-bar events into two events:
6464 use posn as a fake prefix key. */
6467 if (t
+ 1 >= bufsize
)
6468 error ("Key sequence too long");
6473 /* Zap the position in key, so we know that we've
6474 expanded it, and don't try to do so again. */
6475 POSN_BUFFER_POSN (EVENT_START (key
))
6476 = Fcons (posn
, Qnil
);
6480 else if (EQ (kind
, Qswitch_frame
))
6482 /* If we're at the beginning of a key sequence, and the caller
6483 says it's okay, go ahead and return this event. If we're
6484 in the midst of a key sequence, delay it until the end. */
6485 if (t
> 0 || !can_return_switch_frame
)
6487 delayed_switch_frame
= key
;
6491 else if (CONSP (XCONS (key
)->cdr
)
6492 && CONSP (EVENT_START (key
))
6493 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6497 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6498 /* Handle menu-bar events:
6499 insert the dummy prefix event `menu-bar'. */
6500 if (EQ (posn
, Qmenu_bar
))
6502 if (t
+ 1 >= bufsize
)
6503 error ("Key sequence too long");
6507 /* Zap the position in key, so we know that we've
6508 expanded it, and don't try to do so again. */
6509 POSN_BUFFER_POSN (EVENT_START (key
))
6510 = Fcons (posn
, Qnil
);
6513 goto replay_sequence
;
6515 else if (CONSP (posn
))
6517 /* We're looking at the second event of a
6518 sequence which we expanded before. Set
6519 last_real_key_start appropriately. */
6520 if (last_real_key_start
== t
&& t
> 0)
6521 last_real_key_start
= t
- 1;
6526 /* We have finally decided that KEY is something we might want
6528 first_binding
= (follow_key (key
,
6529 nmaps
- first_binding
,
6530 submaps
+ first_binding
,
6531 defs
+ first_binding
,
6532 submaps
+ first_binding
)
6535 /* If KEY wasn't bound, we'll try some fallbacks. */
6536 if (first_binding
>= nmaps
)
6540 head
= EVENT_HEAD (key
);
6541 if (help_char_p (head
) && t
> 0)
6543 read_key_sequence_cmd
= Vprefix_help_command
;
6545 last_nonmenu_event
= key
;
6546 /* The Microsoft C compiler can't handle the goto that
6554 Lisp_Object breakdown
;
6557 breakdown
= parse_modifiers (head
);
6558 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6559 /* Attempt to reduce an unbound mouse event to a simpler
6560 event that is bound:
6561 Drags reduce to clicks.
6562 Double-clicks reduce to clicks.
6563 Triple-clicks reduce to double-clicks, then to clicks.
6564 Down-clicks are eliminated.
6565 Double-downs reduce to downs, then are eliminated.
6566 Triple-downs reduce to double-downs, then to downs,
6567 then are eliminated. */
6568 if (modifiers
& (down_modifier
| drag_modifier
6569 | double_modifier
| triple_modifier
))
6571 while (modifiers
& (down_modifier
| drag_modifier
6572 | double_modifier
| triple_modifier
))
6574 Lisp_Object new_head
, new_click
;
6575 if (modifiers
& triple_modifier
)
6576 modifiers
^= (double_modifier
| triple_modifier
);
6577 else if (modifiers
& double_modifier
)
6578 modifiers
&= ~double_modifier
;
6579 else if (modifiers
& drag_modifier
)
6580 modifiers
&= ~drag_modifier
;
6583 /* Dispose of this `down' event by simply jumping
6584 back to replay_key, to get another event.
6586 Note that if this event came from mock input,
6587 then just jumping back to replay_key will just
6588 hand it to us again. So we have to wipe out any
6591 We could delete keybuf[t] and shift everything
6592 after that to the left by one spot, but we'd also
6593 have to fix up any variable that points into
6594 keybuf, and shifting isn't really necessary
6597 Adding prefixes for non-textual mouse clicks
6598 creates two characters of mock input, and both
6599 must be thrown away. If we're only looking at
6600 the prefix now, we can just jump back to
6601 replay_key. On the other hand, if we've already
6602 processed the prefix, and now the actual click
6603 itself is giving us trouble, then we've lost the
6604 state of the keymaps we want to backtrack to, and
6605 we need to replay the whole sequence to rebuild
6608 Beyond that, only function key expansion could
6609 create more than two keys, but that should never
6610 generate mouse events, so it's okay to zero
6611 mock_input in that case too.
6613 Isn't this just the most wonderful code ever? */
6614 if (t
== last_real_key_start
)
6621 mock_input
= last_real_key_start
;
6622 goto replay_sequence
;
6627 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
6629 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
6631 /* Look for a binding for this new key. follow_key
6632 promises that it didn't munge submaps the
6633 last time we called it, since key was unbound. */
6635 = (follow_key (new_click
,
6636 nmaps
- local_first_binding
,
6637 submaps
+ local_first_binding
,
6638 defs
+ local_first_binding
,
6639 submaps
+ local_first_binding
)
6640 + local_first_binding
);
6642 /* If that click is bound, go for it. */
6643 if (first_binding
< nmaps
)
6648 /* Otherwise, we'll leave key set to the drag event. */
6655 /* Normally, last_nonmenu_event gets the previous key we read.
6656 But when a mouse popup menu is being used,
6657 we don't update last_nonmenu_event; it continues to hold the mouse
6658 event that preceded the first level of menu. */
6659 if (!used_mouse_menu
)
6660 last_nonmenu_event
= key
;
6662 /* Record what part of this_command_keys is the current key sequence. */
6663 this_single_command_key_start
= this_command_key_count
- t
;
6665 prev_fkey_map
= fkey_map
;
6666 prev_fkey_start
= fkey_start
;
6667 prev_fkey_end
= fkey_end
;
6669 prev_keytran_map
= keytran_map
;
6670 prev_keytran_start
= keytran_start
;
6671 prev_keytran_end
= keytran_end
;
6673 /* If the sequence is unbound, see if we can hang a function key
6674 off the end of it. We only want to scan real keyboard input
6675 for function key sequences, so if mock_input says that we're
6676 re-reading old events, don't examine it. */
6677 if (first_binding
>= nmaps
6680 Lisp_Object fkey_next
;
6682 /* Continue scan from fkey_end until we find a bound suffix.
6683 If we fail, increment fkey_start
6684 and start fkey_end from there. */
6685 while (fkey_end
< t
)
6689 key
= keybuf
[fkey_end
++];
6690 /* Look up meta-characters by prefixing them
6691 with meta_prefix_char. I hate this. */
6692 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6697 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
6699 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6702 fkey_next
= fkey_map
;
6705 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
6707 #if 0 /* I didn't turn this on, because it might cause trouble
6708 for the mapping of return into C-m and tab into C-i. */
6709 /* Optionally don't map function keys into other things.
6710 This enables the user to redefine kp- keys easily. */
6711 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
6715 /* If the function key map gives a function, not an
6716 array, then call the function with no args and use
6717 its value instead. */
6718 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
6721 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6725 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6726 fkey_next
= call1 (fkey_next
, prompt
);
6728 /* If the function returned something invalid,
6729 barf--don't ignore it.
6730 (To ignore it safely, we would need to gcpro a bunch of
6731 other variables.) */
6732 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
6733 error ("Function in key-translation-map returns invalid key sequence");
6736 function_key_possible
= ! NILP (fkey_next
);
6738 /* If keybuf[fkey_start..fkey_end] is bound in the
6739 function key map and it's a suffix of the current
6740 sequence (i.e. fkey_end == t), replace it with
6741 the binding and restart with fkey_start at the end. */
6742 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
6745 int len
= XFASTINT (Flength (fkey_next
));
6747 t
= fkey_start
+ len
;
6749 error ("Key sequence too long");
6751 if (VECTORP (fkey_next
))
6752 bcopy (XVECTOR (fkey_next
)->contents
,
6753 keybuf
+ fkey_start
,
6754 (t
- fkey_start
) * sizeof (keybuf
[0]));
6755 else if (STRINGP (fkey_next
))
6759 for (i
= 0; i
< len
; i
++)
6760 XSETFASTINT (keybuf
[fkey_start
+ i
],
6761 XSTRING (fkey_next
)->data
[i
]);
6765 fkey_start
= fkey_end
= t
;
6766 fkey_map
= Vfunction_key_map
;
6768 /* Do pass the results through key-translation-map. */
6769 keytran_start
= keytran_end
= 0;
6770 keytran_map
= Vkey_translation_map
;
6772 goto replay_sequence
;
6775 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
6777 /* If we no longer have a bound suffix, try a new positions for
6779 if (NILP (fkey_map
))
6781 fkey_end
= ++fkey_start
;
6782 fkey_map
= Vfunction_key_map
;
6783 function_key_possible
= 0;
6788 /* Look for this sequence in key-translation-map. */
6790 Lisp_Object keytran_next
;
6792 /* Scan from keytran_end until we find a bound suffix. */
6793 while (keytran_end
< t
)
6797 key
= keybuf
[keytran_end
++];
6798 /* Look up meta-characters by prefixing them
6799 with meta_prefix_char. I hate this. */
6800 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
6805 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
6807 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
6810 keytran_next
= keytran_map
;
6813 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
6815 /* If the key translation map gives a function, not an
6816 array, then call the function with no args and use
6817 its value instead. */
6818 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
6819 && keytran_end
== t
)
6821 struct gcpro gcpro1
, gcpro2
, gcpro3
;
6825 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
6826 keytran_next
= call1 (keytran_next
, prompt
);
6828 /* If the function returned something invalid,
6829 barf--don't ignore it.
6830 (To ignore it safely, we would need to gcpro a bunch of
6831 other variables.) */
6832 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
6833 error ("Function in key-translation-map returns invalid key sequence");
6836 key_translation_possible
= ! NILP (keytran_next
);
6838 /* If keybuf[keytran_start..keytran_end] is bound in the
6839 key translation map and it's a suffix of the current
6840 sequence (i.e. keytran_end == t), replace it with
6841 the binding and restart with keytran_start at the end. */
6842 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
6843 && keytran_end
== t
)
6845 int len
= XFASTINT (Flength (keytran_next
));
6847 t
= keytran_start
+ len
;
6849 error ("Key sequence too long");
6851 if (VECTORP (keytran_next
))
6852 bcopy (XVECTOR (keytran_next
)->contents
,
6853 keybuf
+ keytran_start
,
6854 (t
- keytran_start
) * sizeof (keybuf
[0]));
6855 else if (STRINGP (keytran_next
))
6859 for (i
= 0; i
< len
; i
++)
6860 XSETFASTINT (keybuf
[keytran_start
+ i
],
6861 XSTRING (keytran_next
)->data
[i
]);
6865 keytran_start
= keytran_end
= t
;
6866 keytran_map
= Vkey_translation_map
;
6868 /* Don't pass the results of key-translation-map
6869 through function-key-map. */
6870 fkey_start
= fkey_end
= t
;
6871 fkey_map
= Vkey_translation_map
;
6873 goto replay_sequence
;
6876 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
6878 /* If we no longer have a bound suffix, try a new positions for
6880 if (NILP (keytran_map
))
6882 keytran_end
= ++keytran_start
;
6883 keytran_map
= Vkey_translation_map
;
6884 key_translation_possible
= 0;
6889 /* If KEY is not defined in any of the keymaps,
6890 and cannot be part of a function key or translation,
6891 and is an upper case letter
6892 use the corresponding lower-case letter instead. */
6893 if (first_binding
== nmaps
&& ! function_key_possible
6894 && ! key_translation_possible
6896 && ((((XINT (key
) & 0x3ffff)
6897 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
6898 && UPPERCASEP (XINT (key
) & 0x3ffff))
6899 || (XINT (key
) & shift_modifier
)))
6901 Lisp_Object new_key
;
6903 original_uppercase
= key
;
6904 original_uppercase_position
= t
- 1;
6906 if (XINT (key
) & shift_modifier
)
6907 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
6909 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
6910 | (XINT (key
) & ~0x3ffff)));
6912 /* We have to do this unconditionally, regardless of whether
6913 the lower-case char is defined in the keymaps, because they
6914 might get translated through function-key-map. */
6915 keybuf
[t
- 1] = new_key
;
6918 fkey_map
= prev_fkey_map
;
6919 fkey_start
= prev_fkey_start
;
6920 fkey_end
= prev_fkey_end
;
6922 keytran_map
= prev_keytran_map
;
6923 keytran_start
= prev_keytran_start
;
6924 keytran_end
= prev_keytran_end
;
6926 goto replay_sequence
;
6928 /* If KEY is not defined in any of the keymaps,
6929 and cannot be part of a function key or translation,
6930 and is a shifted function key,
6931 use the corresponding unshifted function key instead. */
6932 if (first_binding
== nmaps
&& ! function_key_possible
6933 && ! key_translation_possible
6936 Lisp_Object breakdown
;
6939 breakdown
= parse_modifiers (key
);
6940 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
6941 if (modifiers
& shift_modifier
)
6943 Lisp_Object new_key
;
6945 original_uppercase
= key
;
6946 original_uppercase_position
= t
- 1;
6948 modifiers
&= ~shift_modifier
;
6949 new_key
= apply_modifiers (modifiers
,
6950 XCONS (breakdown
)->car
);
6952 keybuf
[t
- 1] = new_key
;
6955 fkey_map
= prev_fkey_map
;
6956 fkey_start
= prev_fkey_start
;
6957 fkey_end
= prev_fkey_end
;
6959 keytran_map
= prev_keytran_map
;
6960 keytran_start
= prev_keytran_start
;
6961 keytran_end
= prev_keytran_end
;
6963 goto replay_sequence
;
6969 read_key_sequence_cmd
= (first_binding
< nmaps
6970 ? defs
[first_binding
]
6973 unread_switch_frame
= delayed_switch_frame
;
6974 unbind_to (count
, Qnil
);
6976 /* Don't downcase the last character if the caller says don't.
6977 Don't downcase it if the result is undefined, either. */
6978 if ((dont_downcase_last
|| first_binding
>= nmaps
)
6979 && t
- 1 == original_uppercase_position
)
6980 keybuf
[t
- 1] = original_uppercase
;
6982 /* Occasionally we fabricate events, perhaps by expanding something
6983 according to function-key-map, or by adding a prefix symbol to a
6984 mouse click in the scroll bar or modeline. In this cases, return
6985 the entire generated key sequence, even if we hit an unbound
6986 prefix or a definition before the end. This means that you will
6987 be able to push back the event properly, and also means that
6988 read-key-sequence will always return a logical unit.
6991 for (; t
< mock_input
; t
++)
6993 if (echo_keystrokes
)
6994 echo_char (keybuf
[t
]);
6995 add_command_key (keybuf
[t
]);
7001 #if 0 /* This doc string is too long for some compilers.
7002 This commented-out definition serves for DOC. */
7003 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7004 "Read a sequence of keystrokes and return as a string or vector.\n\
7005 The sequence is sufficient to specify a non-prefix command in the\n\
7006 current local and global maps.\n\
7008 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
7009 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
7010 as a continuation of the previous key.\n\
7012 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
7013 convert the last event to lower case. (Normally any upper case event\n\
7014 is converted to lower case if the original event is undefined and the lower\n\
7015 case equivalent is defined.) A non-nil value is appropriate for reading\n\
7016 a key sequence to be defined.\n\
7018 A C-g typed while in this function is treated like any other character,\n\
7019 and `quit-flag' is not set.\n\
7021 If the key sequence starts with a mouse click, then the sequence is read\n\
7022 using the keymaps of the buffer of the window clicked in, not the buffer\n\
7023 of the selected window as normal.\n\
7025 `read-key-sequence' drops unbound button-down events, since you normally\n\
7026 only care about the click or drag events which follow them. If a drag\n\
7027 or multi-click event is unbound, but the corresponding click event would\n\
7028 be bound, `read-key-sequence' turns the event into a click event at the\n\
7029 drag's starting position. This means that you don't have to distinguish\n\
7030 between click and drag, double, or triple events unless you want to.\n\
7032 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7033 lines separating windows, and scroll bars with imaginary keys\n\
7034 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7036 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7037 function will process a switch-frame event if the user switches frames\n\
7038 before typing anything. If the user switches frames in the middle of a\n\
7039 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7040 is nil, then the event will be put off until after the current key sequence.\n\
7042 `read-key-sequence' checks `function-key-map' for function key\n\
7043 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7044 `function-key-map' for more details.")
7045 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7048 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7050 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7051 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7052 Lisp_Object can_return_switch_frame
;
7054 Lisp_Object keybuf
[30];
7056 struct gcpro gcpro1
, gcpro2
;
7059 CHECK_STRING (prompt
, 0);
7062 bzero (keybuf
, sizeof keybuf
);
7064 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7066 if (NILP (continue_echo
))
7068 this_command_key_count
= 0;
7069 this_single_command_key_start
= 0;
7072 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7073 prompt
, ! NILP (dont_downcase_last
),
7074 ! NILP (can_return_switch_frame
), 0);
7082 return make_event_array (i
, keybuf
);
7085 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7086 "Execute CMD as an editor command.\n\
7087 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7088 Optional second arg RECORD-FLAG non-nil\n\
7089 means unconditionally put this command in `command-history'.\n\
7090 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7091 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7092 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7093 The argument SPECIAL, if non-nil, means that this command is executing\n\
7094 a special event, so ignore the prefix argument and don't clear it.")
7095 (cmd
, record_flag
, keys
, special
)
7096 Lisp_Object cmd
, record_flag
, keys
, special
;
7098 register Lisp_Object final
;
7099 register Lisp_Object tem
;
7100 Lisp_Object prefixarg
;
7101 struct backtrace backtrace
;
7102 extern int debug_on_next_call
;
7104 debug_on_next_call
= 0;
7108 prefixarg
= current_kboard
->Vprefix_arg
;
7109 Vcurrent_prefix_arg
= prefixarg
;
7110 current_kboard
->Vprefix_arg
= Qnil
;
7117 tem
= Fget (cmd
, Qdisabled
);
7118 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7120 tem
= Fsymbol_value (Qdisabled_command_hook
);
7122 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7128 final
= Findirect_function (cmd
);
7130 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7132 struct gcpro gcpro1
, gcpro2
;
7134 GCPRO2 (cmd
, prefixarg
);
7135 do_autoload (final
, cmd
);
7142 if (STRINGP (final
) || VECTORP (final
))
7144 /* If requested, place the macro in the command history. For
7145 other sorts of commands, call-interactively takes care of
7147 if (!NILP (record_flag
))
7149 = Fcons (Fcons (Qexecute_kbd_macro
,
7150 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7153 return Fexecute_kbd_macro (final
, prefixarg
);
7155 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7157 backtrace
.next
= backtrace_list
;
7158 backtrace_list
= &backtrace
;
7159 backtrace
.function
= &Qcall_interactively
;
7160 backtrace
.args
= &cmd
;
7161 backtrace
.nargs
= 1;
7162 backtrace
.evalargs
= 0;
7164 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7166 backtrace_list
= backtrace
.next
;
7172 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7174 "Read function name, then read its arguments and call it.")
7176 Lisp_Object prefixarg
;
7178 Lisp_Object function
;
7180 Lisp_Object saved_keys
;
7181 Lisp_Object bindings
, value
;
7182 struct gcpro gcpro1
, gcpro2
;
7184 saved_keys
= Fvector (this_command_key_count
,
7185 XVECTOR (this_command_keys
)->contents
);
7187 GCPRO2 (saved_keys
, prefixarg
);
7189 if (EQ (prefixarg
, Qminus
))
7191 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7192 strcpy (buf
, "C-u ");
7193 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7195 if (sizeof (int) == sizeof (EMACS_INT
))
7196 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7197 else if (sizeof (long) == sizeof (EMACS_INT
))
7198 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7202 else if (INTEGERP (prefixarg
))
7204 if (sizeof (int) == sizeof (EMACS_INT
))
7205 sprintf (buf
, "%d ", XINT (prefixarg
));
7206 else if (sizeof (long) == sizeof (EMACS_INT
))
7207 sprintf (buf
, "%ld ", XINT (prefixarg
));
7212 /* This isn't strictly correct if execute-extended-command
7213 is bound to anything else. Perhaps it should use
7214 this_command_keys? */
7215 strcat (buf
, "M-x ");
7217 /* Prompt with buf, and then read a string, completing from and
7218 restricting to the set of all defined commands. Don't provide
7219 any initial input. Save the command read on the extended-command
7221 function
= Fcompleting_read (build_string (buf
),
7222 Vobarray
, Qcommandp
,
7223 Qt
, Qnil
, Qextended_command_history
, Qnil
,
7226 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7227 error ("No command name given");
7229 /* Set this_command_keys to the concatenation of saved_keys and
7230 function, followed by a RET. */
7232 struct Lisp_String
*str
;
7236 this_command_key_count
= 0;
7237 this_single_command_key_start
= 0;
7239 keys
= XVECTOR (saved_keys
)->contents
;
7240 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7241 add_command_key (keys
[i
]);
7243 str
= XSTRING (function
);
7244 for (i
= 0; i
< str
->size
; i
++)
7245 add_command_key (Faref (function
, make_number (i
)));
7247 add_command_key (make_number ('\015'));
7252 function
= Fintern (function
, Qnil
);
7253 current_kboard
->Vprefix_arg
= prefixarg
;
7254 this_command
= function
;
7256 /* If enabled, show which key runs this command. */
7257 if (!NILP (Vsuggest_key_bindings
)
7258 && NILP (Vexecuting_macro
)
7259 && SYMBOLP (function
))
7260 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7266 GCPRO2 (bindings
, value
);
7267 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7269 /* If the command has a key binding, print it now. */
7270 if (!NILP (bindings
)
7271 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
7274 /* But first wait, and skip the message if there is input. */
7275 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7276 ? Vsuggest_key_bindings
: make_number (2)),
7278 && ! CONSP (Vunread_command_events
))
7280 Lisp_Object binding
;
7282 char *oldmessage
= echo_area_glyphs
;
7283 int oldmessage_len
= echo_area_glyphs_length
;
7284 int oldmultibyte
= message_enable_multibyte
;
7286 binding
= Fkey_description (bindings
);
7289 = (char *) alloca (XSYMBOL (function
)->name
->size
7290 + XSTRING (binding
)->size_byte
7292 sprintf (newmessage
, "You can run the command `%s' with %s",
7293 XSYMBOL (function
)->name
->data
,
7294 XSTRING (binding
)->data
);
7295 message2_nolog (newmessage
,
7296 strlen (newmessage
),
7297 STRING_MULTIBYTE (binding
));
7298 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7299 ? Vsuggest_key_bindings
: make_number (2)),
7301 message2_nolog (oldmessage
, oldmessage_len
, oldmultibyte
);
7305 RETURN_UNGCPRO (value
);
7308 /* Find the set of keymaps now active.
7309 Store into *MAPS_P a vector holding the various maps
7310 and return the number of them. The vector was malloc'd
7311 and the caller should free it. */
7314 current_active_maps (maps_p
)
7315 Lisp_Object
**maps_p
;
7317 Lisp_Object
*tmaps
, *maps
;
7320 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7321 if (!NILP (Voverriding_local_map_menu_flag
))
7323 /* Yes, use them (if non-nil) as well as the global map. */
7324 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7326 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7327 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7328 if (!NILP (Voverriding_local_map
))
7329 maps
[nmaps
++] = Voverriding_local_map
;
7333 /* No, so use major and minor mode keymaps. */
7334 nmaps
= current_minor_maps (NULL
, &tmaps
);
7335 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7336 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7337 #ifdef USE_TEXT_PROPERTIES
7338 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7340 maps
[nmaps
++] = current_buffer
->keymap
;
7343 maps
[nmaps
++] = current_global_map
;
7349 /* Return nonzero if input events are pending. */
7351 detect_input_pending ()
7354 get_input_pending (&input_pending
, 0);
7356 return input_pending
;
7359 /* Return nonzero if input events are pending, and run any pending timers. */
7361 detect_input_pending_run_timers (do_display
)
7364 int old_timers_run
= timers_run
;
7367 get_input_pending (&input_pending
, 1);
7369 if (old_timers_run
!= timers_run
&& do_display
)
7370 redisplay_preserve_echo_area ();
7372 return input_pending
;
7375 /* This is called in some cases before a possible quit.
7376 It cases the next call to detect_input_pending to recompute input_pending.
7377 So calling this function unnecessarily can't do any harm. */
7380 clear_input_pending ()
7385 /* Return nonzero if there are pending requeued events.
7386 This isn't used yet. The hope is to make wait_reading_process_input
7387 call it, and return return if it runs Lisp code that unreads something.
7388 The problem is, kbd_buffer_get_event needs to be fixed to know what
7389 to do in that case. It isn't trivial. */
7391 requeued_events_pending_p ()
7393 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7397 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7398 "T if command input is currently available with no waiting.\n\
7399 Actually, the value is nil only if we can be sure that no input is available.")
7402 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7405 get_input_pending (&input_pending
, 1);
7406 return input_pending
> 0 ? Qt
: Qnil
;
7409 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7410 "Return vector of last 100 events, not counting those from keyboard macros.")
7413 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7416 if (total_keys
< NUM_RECENT_KEYS
)
7417 return Fvector (total_keys
, keys
);
7420 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7421 bcopy (keys
+ recent_keys_index
,
7422 XVECTOR (val
)->contents
,
7423 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7425 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7426 recent_keys_index
* sizeof (Lisp_Object
));
7431 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7432 "Return the key sequence that invoked this command.\n\
7433 The value is a string or a vector.")
7436 return make_event_array (this_command_key_count
,
7437 XVECTOR (this_command_keys
)->contents
);
7440 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7441 Sthis_single_command_keys
, 0, 0, 0,
7442 "Return the key sequence that invoked this command.\n\
7443 Unlike `this-command-keys', this function's value\n\
7444 does not include prefix arguments.\n\
7445 The value is a string or a vector.")
7448 return make_event_array (this_command_key_count
7449 - this_single_command_key_start
,
7450 (XVECTOR (this_command_keys
)->contents
7451 + this_single_command_key_start
));
7454 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7455 Sreset_this_command_lengths
, 0, 0, 0,
7456 "Used for complicated reasons in `universal-argument-other-key'.\n\
7458 `universal-argument-other-key' rereads the event just typed.\n\
7459 It then gets translated through `function-key-map'.\n\
7460 The translated event gets included in the echo area and in\n\
7461 the value of `this-command-keys' in addition to the raw original event.\n\
7462 That is not right.\n\
7464 Calling this function directs the translated event to replace\n\
7465 the original event, so that only one version of the event actually\n\
7466 appears in the echo area and in the value of `this-command-keys.'.")
7469 before_command_restore_flag
= 1;
7470 before_command_key_count_1
= before_command_key_count
;
7471 before_command_echo_length_1
= before_command_echo_length
;
7474 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
7475 "Return the current depth in recursive edits.")
7479 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
7483 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
7484 "FOpen dribble file: ",
7485 "Start writing all keyboard characters to a dribble file called FILE.\n\
7486 If FILE is nil, close any open dribble file.")
7497 file
= Fexpand_file_name (file
, Qnil
);
7498 dribble
= fopen (XSTRING (file
)->data
, "w");
7500 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
7505 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
7506 "Discard the contents of the terminal input buffer.\n\
7507 Also cancel any kbd macro being defined.")
7510 current_kboard
->defining_kbd_macro
= Qnil
;
7511 update_mode_lines
++;
7513 Vunread_command_events
= Qnil
;
7514 unread_command_char
= -1;
7516 discard_tty_input ();
7518 /* Without the cast, GCC complains that this assignment loses the
7519 volatile qualifier of kbd_store_ptr. Is there anything wrong
7521 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
7522 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
7528 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
7529 "Stop Emacs and return to superior process. You can resume later.\n\
7530 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
7531 control, run a subshell instead.\n\n\
7532 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
7533 to be read as terminal input by Emacs's parent, after suspension.\n\
7535 Before suspending, run the normal hook `suspend-hook'.\n\
7536 After resumption run the normal hook `suspend-resume-hook'.\n\
7538 Some operating systems cannot stop the Emacs process and resume it later.\n\
7539 On such systems, Emacs starts a subshell instead of suspending.")
7541 Lisp_Object stuffstring
;
7544 int count
= specpdl_ptr
- specpdl
;
7545 int old_height
, old_width
;
7547 struct gcpro gcpro1
, gcpro2
;
7549 if (!NILP (stuffstring
))
7550 CHECK_STRING (stuffstring
, 0);
7552 /* Run the functions in suspend-hook. */
7553 if (!NILP (Vrun_hooks
))
7554 call1 (Vrun_hooks
, intern ("suspend-hook"));
7556 GCPRO1 (stuffstring
);
7557 get_frame_size (&old_width
, &old_height
);
7559 /* sys_suspend can get an error if it tries to fork a subshell
7560 and the system resources aren't available for that. */
7561 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
7563 stuff_buffered_input (stuffstring
);
7568 unbind_to (count
, Qnil
);
7570 /* Check if terminal/window size has changed.
7571 Note that this is not useful when we are running directly
7572 with a window system; but suspend should be disabled in that case. */
7573 get_frame_size (&width
, &height
);
7574 if (width
!= old_width
|| height
!= old_height
)
7575 change_frame_size (selected_frame
, height
, width
, 0, 0);
7577 /* Run suspend-resume-hook. */
7578 if (!NILP (Vrun_hooks
))
7579 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
7585 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
7586 Then in any case stuff anything Emacs has read ahead and not used. */
7589 stuff_buffered_input (stuffstring
)
7590 Lisp_Object stuffstring
;
7592 /* stuff_char works only in BSD, versions 4.2 and up. */
7595 register unsigned char *p
;
7597 if (STRINGP (stuffstring
))
7601 p
= XSTRING (stuffstring
)->data
;
7602 count
= XSTRING (stuffstring
)->size_byte
;
7607 /* Anything we have read ahead, put back for the shell to read. */
7608 /* ?? What should this do when we have multiple keyboards??
7609 Should we ignore anything that was typed in at the "wrong" kboard? */
7610 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
7612 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
7613 kbd_fetch_ptr
= kbd_buffer
;
7614 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
7615 stuff_char (kbd_fetch_ptr
->code
);
7616 kbd_fetch_ptr
->kind
= no_event
;
7617 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
7623 #endif /* BSD_SYSTEM and not BSD4_1 */
7626 set_waiting_for_input (time_to_clear
)
7627 EMACS_TIME
*time_to_clear
;
7629 input_available_clear_time
= time_to_clear
;
7631 /* Tell interrupt_signal to throw back to read_char, */
7632 waiting_for_input
= 1;
7634 /* If interrupt_signal was called before and buffered a C-g,
7635 make it run again now, to avoid timing error. */
7636 if (!NILP (Vquit_flag
))
7637 quit_throw_to_read_char ();
7641 clear_waiting_for_input ()
7643 /* Tell interrupt_signal not to throw back to read_char, */
7644 waiting_for_input
= 0;
7645 input_available_clear_time
= 0;
7648 /* This routine is called at interrupt level in response to C-G.
7649 If interrupt_input, this is the handler for SIGINT.
7650 Otherwise, it is called from kbd_buffer_store_event,
7651 in handling SIGIO or SIGTINT.
7653 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
7654 immediately throw back to read_char.
7656 Otherwise it sets the Lisp variable quit-flag not-nil.
7657 This causes eval to throw, when it gets a chance.
7658 If quit-flag is already non-nil, it stops the job right away. */
7661 interrupt_signal (signalnum
) /* If we don't have an argument, */
7662 int signalnum
; /* some compilers complain in signal calls. */
7665 /* Must preserve main program's value of errno. */
7666 int old_errno
= errno
;
7668 #if defined (USG) && !defined (POSIX_SIGNALS)
7669 if (!read_socket_hook
&& NILP (Vwindow_system
))
7671 /* USG systems forget handlers when they are used;
7672 must reestablish each time */
7673 signal (SIGINT
, interrupt_signal
);
7674 signal (SIGQUIT
, interrupt_signal
);
7680 if (!NILP (Vquit_flag
)
7681 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
7683 /* If SIGINT isn't blocked, don't let us be interrupted by
7684 another SIGINT, it might be harmful due to non-reentrancy
7685 in I/O functions. */
7686 sigblock (sigmask (SIGINT
));
7691 #ifdef SIGTSTP /* Support possible in later USG versions */
7693 * On systems which can suspend the current process and return to the original
7694 * shell, this command causes the user to end up back at the shell.
7695 * The "Auto-save" and "Abort" questions are not asked until
7696 * the user elects to return to emacs, at which point he can save the current
7697 * job and either dump core or continue.
7702 if (sys_suspend () == -1)
7704 printf ("Not running as a subprocess;\n");
7705 printf ("you can continue or abort.\n");
7708 /* Perhaps should really fork an inferior shell?
7709 But that would not provide any way to get back
7710 to the original shell, ever. */
7711 printf ("No support for stopping a process on this operating system;\n");
7712 printf ("you can continue or abort.\n");
7713 #endif /* not VMS */
7714 #endif /* not SIGTSTP */
7716 /* We must remain inside the screen area when the internal terminal
7717 is used. Note that [Enter] is not echoed by dos. */
7720 /* It doesn't work to autosave while GC is in progress;
7721 the code used for auto-saving doesn't cope with the mark bit. */
7722 if (!gc_in_progress
)
7724 printf ("Auto-save? (y or n) ");
7726 if (((c
= getchar ()) & ~040) == 'Y')
7728 Fdo_auto_save (Qt
, Qnil
);
7730 printf ("\r\nAuto-save done");
7731 #else /* not MSDOS */
7732 printf ("Auto-save done\n");
7733 #endif /* not MSDOS */
7735 while (c
!= '\n') c
= getchar ();
7739 /* During GC, it must be safe to reenable quitting again. */
7740 Vinhibit_quit
= Qnil
;
7743 #endif /* not MSDOS */
7744 printf ("Garbage collection in progress; cannot auto-save now\r\n");
7745 printf ("but will instead do a real quit after garbage collection ends\r\n");
7750 printf ("\r\nAbort? (y or n) ");
7751 #else /* not MSDOS */
7753 printf ("Abort (and enter debugger)? (y or n) ");
7755 printf ("Abort (and dump core)? (y or n) ");
7756 #endif /* not VMS */
7757 #endif /* not MSDOS */
7759 if (((c
= getchar ()) & ~040) == 'Y')
7761 while (c
!= '\n') c
= getchar ();
7763 printf ("\r\nContinuing...\r\n");
7764 #else /* not MSDOS */
7765 printf ("Continuing...\n");
7766 #endif /* not MSDOS */
7773 /* If executing a function that wants to be interrupted out of
7774 and the user has not deferred quitting by binding `inhibit-quit'
7775 then quit right away. */
7776 if (immediate_quit
&& NILP (Vinhibit_quit
))
7780 Fsignal (Qquit
, Qnil
);
7783 /* Else request quit when it's safe */
7787 if (waiting_for_input
&& !echoing
)
7788 quit_throw_to_read_char ();
7793 /* Handle a C-g by making read_char return C-g. */
7796 quit_throw_to_read_char ()
7798 quit_error_check ();
7800 /* Prevent another signal from doing this before we finish. */
7801 clear_waiting_for_input ();
7804 Vunread_command_events
= Qnil
;
7805 unread_command_char
= -1;
7807 #if 0 /* Currently, sit_for is called from read_char without turning
7808 off polling. And that can call set_waiting_for_input.
7809 It seems to be harmless. */
7810 #ifdef POLL_FOR_INPUT
7811 /* May be > 1 if in recursive minibuffer. */
7812 if (poll_suppress_count
== 0)
7816 if (FRAMEP (internal_last_event_frame
)
7817 && XFRAME (internal_last_event_frame
) != selected_frame
)
7818 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
7821 _longjmp (getcjmp
, 1);
7824 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
7825 "Set mode of reading keyboard input.\n\
7826 First arg INTERRUPT non-nil means use input interrupts;\n\
7827 nil means use CBREAK mode.\n\
7828 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
7829 (no effect except in CBREAK mode).\n\
7830 Third arg META t means accept 8-bit input (for a Meta key).\n\
7831 META nil means ignore the top bit, on the assumption it is parity.\n\
7832 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
7833 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
7834 See also `current-input-mode'.")
7835 (interrupt
, flow
, meta
, quit
)
7836 Lisp_Object interrupt
, flow
, meta
, quit
;
7839 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
7840 error ("set-input-mode: QUIT must be an ASCII character");
7842 #ifdef POLL_FOR_INPUT
7847 /* this causes startup screen to be restored and messes with the mouse */
7852 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7853 if (read_socket_hook
)
7855 /* When using X, don't give the user a real choice,
7856 because we haven't implemented the mechanisms to support it. */
7857 #ifdef NO_SOCK_SIGIO
7858 interrupt_input
= 0;
7859 #else /* not NO_SOCK_SIGIO */
7860 interrupt_input
= 1;
7861 #endif /* NO_SOCK_SIGIO */
7864 interrupt_input
= !NILP (interrupt
);
7865 #else /* not SIGIO */
7866 interrupt_input
= 0;
7867 #endif /* not SIGIO */
7869 /* Our VMS input only works by interrupts, as of now. */
7871 interrupt_input
= 1;
7874 flow_control
= !NILP (flow
);
7877 else if (EQ (meta
, Qt
))
7882 /* Don't let this value be out of range. */
7883 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
7889 #ifdef POLL_FOR_INPUT
7890 poll_suppress_count
= 1;
7896 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
7897 "Return information about the way Emacs currently reads keyboard input.\n\
7898 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
7899 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
7900 nil, Emacs is using CBREAK mode.\n\
7901 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
7902 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
7903 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
7904 META nil means ignoring the top bit, on the assumption it is parity.\n\
7905 META is neither t nor nil if accepting 8-bit input and using\n\
7906 all 8 bits as the character code.\n\
7907 QUIT is the character Emacs currently uses to quit.\n\
7908 The elements of this list correspond to the arguments of\n\
7914 val
[0] = interrupt_input
? Qt
: Qnil
;
7915 val
[1] = flow_control
? Qt
: Qnil
;
7916 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
7917 XSETFASTINT (val
[3], quit_char
);
7919 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
7924 * Set up a new kboard object with reasonable initial values.
7930 kb
->Voverriding_terminal_local_map
= Qnil
;
7931 kb
->Vlast_command
= Qnil
;
7932 kb
->Vprefix_arg
= Qnil
;
7933 kb
->kbd_queue
= Qnil
;
7934 kb
->kbd_queue_has_data
= 0;
7935 kb
->immediate_echo
= 0;
7936 kb
->echoptr
= kb
->echobuf
;
7937 kb
->echo_after_prompt
= -1;
7938 kb
->kbd_macro_buffer
= 0;
7939 kb
->kbd_macro_bufsize
= 0;
7940 kb
->defining_kbd_macro
= Qnil
;
7941 kb
->Vlast_kbd_macro
= Qnil
;
7942 kb
->reference_count
= 0;
7943 kb
->Vsystem_key_alist
= Qnil
;
7944 kb
->system_key_syms
= Qnil
;
7945 kb
->Vdefault_minibuffer_frame
= Qnil
;
7949 * Destroy the contents of a kboard object, but not the object itself.
7950 * We use this just before deleting it, or if we're going to initialize
7957 if (kb
->kbd_macro_buffer
)
7958 xfree (kb
->kbd_macro_buffer
);
7967 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
7970 *kbp
= kb
->next_kboard
;
7978 /* This is correct before outermost invocation of the editor loop */
7979 command_loop_level
= -1;
7981 quit_char
= Ctl ('g');
7982 Vunread_command_events
= Qnil
;
7983 unread_command_char
= -1;
7984 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
7986 recent_keys_index
= 0;
7987 kbd_fetch_ptr
= kbd_buffer
;
7988 kbd_store_ptr
= kbd_buffer
;
7989 kbd_buffer_frame_or_window
7990 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
7992 do_mouse_tracking
= Qnil
;
7996 /* This means that command_loop_1 won't try to select anything the first
7998 internal_last_event_frame
= Qnil
;
7999 Vlast_event_frame
= internal_last_event_frame
;
8002 current_kboard
= initial_kboard
;
8004 wipe_kboard (current_kboard
);
8005 init_kboard (current_kboard
);
8008 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8010 kbd_buffer_frame_or_window
8011 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8012 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
8014 signal (SIGINT
, interrupt_signal
);
8015 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
8016 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
8017 SIGQUIT and we can't tell which one it will give us. */
8018 signal (SIGQUIT
, interrupt_signal
);
8019 #endif /* HAVE_TERMIO */
8021 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8023 if (!noninteractive
)
8024 signal (SIGIO
, input_available_signal
);
8027 /* Use interrupt input by default, if it works and noninterrupt input
8028 has deficiencies. */
8030 #ifdef INTERRUPT_INPUT
8031 interrupt_input
= 1;
8033 interrupt_input
= 0;
8036 /* Our VMS input only works by interrupts, as of now. */
8038 interrupt_input
= 1;
8044 if (keyboard_init_hook
)
8045 (*keyboard_init_hook
) ();
8047 #ifdef POLL_FOR_INPUT
8048 poll_suppress_count
= 1;
8053 /* This type's only use is in syms_of_keyboard, to initialize the
8054 event header symbols and put properties on them. */
8061 struct event_head head_table
[] = {
8062 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8063 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8064 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8065 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8066 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8067 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8072 Qtimer_event_handler
= intern ("timer-event-handler");
8073 staticpro (&Qtimer_event_handler
);
8075 Qdisabled_command_hook
= intern ("disabled-command-hook");
8076 staticpro (&Qdisabled_command_hook
);
8078 Qself_insert_command
= intern ("self-insert-command");
8079 staticpro (&Qself_insert_command
);
8081 Qforward_char
= intern ("forward-char");
8082 staticpro (&Qforward_char
);
8084 Qbackward_char
= intern ("backward-char");
8085 staticpro (&Qbackward_char
);
8087 Qdisabled
= intern ("disabled");
8088 staticpro (&Qdisabled
);
8090 Qundefined
= intern ("undefined");
8091 staticpro (&Qundefined
);
8093 Qpre_command_hook
= intern ("pre-command-hook");
8094 staticpro (&Qpre_command_hook
);
8096 Qpost_command_hook
= intern ("post-command-hook");
8097 staticpro (&Qpost_command_hook
);
8099 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8100 staticpro (&Qpost_command_idle_hook
);
8102 Qdeferred_action_function
= intern ("deferred-action-function");
8103 staticpro (&Qdeferred_action_function
);
8105 Qcommand_hook_internal
= intern ("command-hook-internal");
8106 staticpro (&Qcommand_hook_internal
);
8108 Qfunction_key
= intern ("function-key");
8109 staticpro (&Qfunction_key
);
8110 Qmouse_click
= intern ("mouse-click");
8111 staticpro (&Qmouse_click
);
8113 Qmouse_wheel
= intern ("mouse-wheel");
8114 staticpro (&Qmouse_wheel
);
8117 Qmenu_enable
= intern ("menu-enable");
8118 staticpro (&Qmenu_enable
);
8120 Qmode_line
= intern ("mode-line");
8121 staticpro (&Qmode_line
);
8122 Qvertical_line
= intern ("vertical-line");
8123 staticpro (&Qvertical_line
);
8124 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8125 staticpro (&Qvertical_scroll_bar
);
8126 Qmenu_bar
= intern ("menu-bar");
8127 staticpro (&Qmenu_bar
);
8129 Qabove_handle
= intern ("above-handle");
8130 staticpro (&Qabove_handle
);
8131 Qhandle
= intern ("handle");
8132 staticpro (&Qhandle
);
8133 Qbelow_handle
= intern ("below-handle");
8134 staticpro (&Qbelow_handle
);
8135 Qup
= intern ("up");
8137 Qdown
= intern ("down");
8140 Qevent_kind
= intern ("event-kind");
8141 staticpro (&Qevent_kind
);
8142 Qevent_symbol_elements
= intern ("event-symbol-elements");
8143 staticpro (&Qevent_symbol_elements
);
8144 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8145 staticpro (&Qevent_symbol_element_mask
);
8146 Qmodifier_cache
= intern ("modifier-cache");
8147 staticpro (&Qmodifier_cache
);
8149 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8150 staticpro (&Qrecompute_lucid_menubar
);
8151 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8152 staticpro (&Qactivate_menubar_hook
);
8154 Qpolling_period
= intern ("polling-period");
8155 staticpro (&Qpolling_period
);
8158 struct event_head
*p
;
8160 for (p
= head_table
;
8161 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8164 *p
->var
= intern (p
->name
);
8166 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8167 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8171 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8172 staticpro (&button_down_location
);
8176 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8178 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8179 for (i
= 0; i
< len
; i
++)
8180 if (modifier_names
[i
])
8181 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8182 staticpro (&modifier_symbols
);
8185 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8186 staticpro (&recent_keys
);
8188 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8189 staticpro (&this_command_keys
);
8191 Qextended_command_history
= intern ("extended-command-history");
8192 Fset (Qextended_command_history
, Qnil
);
8193 staticpro (&Qextended_command_history
);
8195 kbd_buffer_frame_or_window
8196 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8197 staticpro (&kbd_buffer_frame_or_window
);
8199 accent_key_syms
= Qnil
;
8200 staticpro (&accent_key_syms
);
8202 func_key_syms
= Qnil
;
8203 staticpro (&func_key_syms
);
8206 staticpro (&mouse_syms
);
8209 mouse_wheel_syms
= Qnil
;
8210 staticpro (&mouse_wheel_syms
);
8213 unread_switch_frame
= Qnil
;
8214 staticpro (&unread_switch_frame
);
8216 internal_last_event_frame
= Qnil
;
8217 staticpro (&internal_last_event_frame
);
8219 read_key_sequence_cmd
= Qnil
;
8220 staticpro (&read_key_sequence_cmd
);
8222 defsubr (&Sevent_convert_list
);
8223 defsubr (&Sread_key_sequence
);
8224 defsubr (&Srecursive_edit
);
8226 defsubr (&Strack_mouse
);
8228 defsubr (&Sinput_pending_p
);
8229 defsubr (&Scommand_execute
);
8230 defsubr (&Srecent_keys
);
8231 defsubr (&Sthis_command_keys
);
8232 defsubr (&Sthis_single_command_keys
);
8233 defsubr (&Sreset_this_command_lengths
);
8234 defsubr (&Ssuspend_emacs
);
8235 defsubr (&Sabort_recursive_edit
);
8236 defsubr (&Sexit_recursive_edit
);
8237 defsubr (&Srecursion_depth
);
8238 defsubr (&Stop_level
);
8239 defsubr (&Sdiscard_input
);
8240 defsubr (&Sopen_dribble_file
);
8241 defsubr (&Sset_input_mode
);
8242 defsubr (&Scurrent_input_mode
);
8243 defsubr (&Sexecute_extended_command
);
8245 DEFVAR_LISP ("last-command-char", &last_command_char
,
8246 "Last input event that was part of a command.");
8248 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8249 "Last input event that was part of a command.");
8251 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8252 "Last input event in a command, except for mouse menu events.\n\
8253 Mouse menus give back keys that don't look like mouse events;\n\
8254 this variable holds the actual mouse event that led to the menu,\n\
8255 so that you can determine whether the command was run by mouse or not.");
8257 DEFVAR_LISP ("last-input-char", &last_input_char
,
8258 "Last input event.");
8260 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8261 "Last input event.");
8263 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8264 "List of objects to be read as next command input events.");
8266 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8267 "If not -1, an object to be read as next command input event.");
8269 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8270 "Meta-prefix character code. Meta-foo as command input\n\
8271 turns into this character followed by foo.");
8272 XSETINT (meta_prefix_char
, 033);
8274 DEFVAR_KBOARD ("last-command", Vlast_command
,
8275 "The last command executed. Normally a symbol with a function definition,\n\
8276 but can be whatever was found in the keymap, or whatever the variable\n\
8277 `this-command' was set to by that command.\n\
8279 The value `mode-exit' is special; it means that the previous command\n\
8280 read an event that told it to exit, and it did so and unread that event.\n\
8281 In other words, the present command is the event that made the previous\n\
8284 The value `kill-region' is special; it means that the previous command\n\
8285 was a kill command.");
8287 DEFVAR_LISP ("this-command", &this_command
,
8288 "The command now being executed.\n\
8289 The command can set this variable; whatever is put here\n\
8290 will be in `last-command' during the following command.");
8291 this_command
= Qnil
;
8293 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8294 "*Number of keyboard input characters between auto-saves.\n\
8295 Zero means disable autosaving due to number of characters typed.");
8296 auto_save_interval
= 300;
8298 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8299 "*Number of seconds idle time before auto-save.\n\
8300 Zero or nil means disable auto-saving due to idleness.\n\
8301 After auto-saving due to this many seconds of idle time,\n\
8302 Emacs also does a garbage collection if that seems to be warranted.");
8303 XSETFASTINT (Vauto_save_timeout
, 30);
8305 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8306 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8307 echo_keystrokes
= 1;
8309 DEFVAR_INT ("polling-period", &polling_period
,
8310 "*Interval between polling for input during Lisp execution.\n\
8311 The reason for polling is to make C-g work to stop a running program.\n\
8312 Polling is needed only when using X windows and SIGIO does not work.\n\
8313 Polling is automatically disabled in all other cases.");
8316 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8317 "*Maximum time between mouse clicks to make a double-click.\n\
8318 Measured in milliseconds. nil means disable double-click recognition;\n\
8319 t means double-clicks have no time limit and are detected\n\
8320 by position only.");
8321 Vdouble_click_time
= make_number (500);
8323 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8324 "*Non-nil means inhibit local map menu bar menus.");
8325 inhibit_local_menu_bar_menus
= 0;
8327 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8328 "Number of complete key sequences read as input so far.\n\
8329 This includes key sequences read from keyboard macros.\n\
8330 The number is effectively the number of interactive command invocations.");
8333 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8334 "Number of input events read from the keyboard so far.\n\
8335 This does not include events generated by keyboard macros.");
8336 num_nonmacro_input_events
= 0;
8338 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8339 "The frame in which the most recently read event occurred.\n\
8340 If the last event came from a keyboard macro, this is set to `macro'.");
8341 Vlast_event_frame
= Qnil
;
8343 /* This variable is set up in sysdep.c. */
8344 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8345 "The ERASE character as set by the user with stty.");
8347 DEFVAR_LISP ("help-char", &Vhelp_char
,
8348 "Character to recognize as meaning Help.\n\
8349 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8350 If the value of `help-form' is nil, this char can be read normally.");
8351 XSETINT (Vhelp_char
, Ctl ('H'));
8353 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8354 "List of input events to recognize as meaning Help.\n\
8355 These work just like the value of `help-char' (see that).");
8356 Vhelp_event_list
= Qnil
;
8358 DEFVAR_LISP ("help-form", &Vhelp_form
,
8359 "Form to execute when character `help-char' is read.\n\
8360 If the form returns a string, that string is displayed.\n\
8361 If `help-form' is nil, the help char is not recognized.");
8364 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8365 "Command to run when `help-char' character follows a prefix key.\n\
8366 This command is used only when there is no actual binding\n\
8367 for that character after that prefix key.");
8368 Vprefix_help_command
= Qnil
;
8370 DEFVAR_LISP ("top-level", &Vtop_level
,
8371 "Form to evaluate when Emacs starts up.\n\
8372 Useful to set before you dump a modified Emacs.");
8375 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8376 "Translate table for keyboard input, or nil.\n\
8377 Each character is looked up in this string and the contents used instead.\n\
8378 The value may be a string, a vector, or a char-table.\n\
8379 If it is a string or vector of length N,\n\
8380 character codes N and up are untranslated.\n\
8381 In a vector or a char-table, an element which is nil means \"no translation\".");
8382 Vkeyboard_translate_table
= Qnil
;
8384 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8385 "Non-nil means to always spawn a subshell instead of suspending,\n\
8386 even if the operating system has support for stopping a process.");
8389 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8390 "Non-nil means prompt with menus when appropriate.\n\
8391 This is done when reading from a keymap that has a prompt string,\n\
8392 for elements that have prompt strings.\n\
8393 The menu is displayed on the screen\n\
8394 if X menus were enabled at configuration\n\
8395 time and the previous event was a mouse click prefix key.\n\
8396 Otherwise, menu prompting uses the echo area.");
8399 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8400 "Character to see next line of menu prompt.\n\
8401 Type this character while in a menu prompt to rotate around the lines of it.");
8402 XSETINT (menu_prompt_more_char
, ' ');
8404 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8405 "A mask of additional modifier keys to use with every keyboard character.\n\
8406 Emacs applies the modifiers of the character stored here to each keyboard\n\
8407 character it reads. For example, after evaluating the expression\n\
8408 (setq extra-keyboard-modifiers ?\\C-x)\n\
8409 all input characters will have the control modifier applied to them.\n\
8411 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8412 not count as a control character; rather, it counts as a character\n\
8413 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8414 cancels any modification.");
8415 extra_keyboard_modifiers
= 0;
8417 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8418 "If an editing command sets this to t, deactivate the mark afterward.\n\
8419 The command loop sets this to nil before each command,\n\
8420 and tests the value when the command returns.\n\
8421 Buffer modification stores t in this variable.");
8422 Vdeactivate_mark
= Qnil
;
8424 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8425 "Temporary storage of pre-command-hook or post-command-hook.");
8426 Vcommand_hook_internal
= Qnil
;
8428 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8429 "Normal hook run before each command is executed.\n\
8430 Errors running the hook are caught and ignored.");
8431 Vpre_command_hook
= Qnil
;
8433 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
8434 "Normal hook run after each command is executed.\n\
8435 Errors running the hook are caught and ignored.");
8436 Vpost_command_hook
= Qnil
;
8438 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
8439 "Normal hook run after each command is executed, if idle.\n\
8440 Errors running the hook are caught and ignored.\n\
8441 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
8442 Vpost_command_idle_hook
= Qnil
;
8444 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
8445 "Delay time before running `post-command-idle-hook'.\n\
8446 This is measured in microseconds.");
8447 post_command_idle_delay
= 100000;
8450 DEFVAR_LISP ("echo-area-clear-hook", ...,
8451 "Normal hook run when clearing the echo area.");
8453 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
8454 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
8456 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
8457 "t means menu bar, specified Lucid style, needs to be recomputed.");
8458 Vlucid_menu_bar_dirty_flag
= Qnil
;
8460 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
8461 "List of menu bar items to move to the end of the menu bar.\n\
8462 The elements of the list are event types that may have menu bar bindings.");
8463 Vmenu_bar_final_items
= Qnil
;
8465 DEFVAR_KBOARD ("overriding-terminal-local-map",
8466 Voverriding_terminal_local_map
,
8467 "Per-terminal keymap that overrides all other local keymaps.\n\
8468 If this variable is non-nil, it is used as a keymap instead of the\n\
8469 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
8470 This variable is intended to let commands such as `universal-argumemnt'\n\
8471 set up a different keymap for reading the next command.");
8473 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
8474 "Keymap that overrides all other local keymaps.\n\
8475 If this variable is non-nil, it is used as a keymap instead of the\n\
8476 buffer's local map, and the minor mode keymaps and text property keymaps.");
8477 Voverriding_local_map
= Qnil
;
8479 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
8480 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
8481 Otherwise, the menu bar continues to reflect the buffer's local map\n\
8482 and the minor mode maps regardless of `overriding-local-map'.");
8483 Voverriding_local_map_menu_flag
= Qnil
;
8485 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
8486 "Keymap defining bindings for special events to execute at low level.");
8487 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
8489 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
8490 "*Non-nil means generate motion events for mouse motion.");
8492 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
8493 "Alist of system-specific X windows key symbols.\n\
8494 Each element should have the form (N . SYMBOL) where N is the\n\
8495 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
8496 and SYMBOL is its name.");
8498 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
8499 "List of deferred actions to be performed at a later time.\n\
8500 The precise format isn't relevant here; we just check whether it is nil.");
8501 Vdeferred_action_list
= Qnil
;
8503 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
8504 "Function to call to handle deferred actions, after each command.\n\
8505 This function is called with no arguments after each command\n\
8506 whenever `deferred-action-list' is non-nil.");
8507 Vdeferred_action_function
= Qnil
;
8509 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
8510 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
8511 The value can be a length of time to show the message for.\n\
8512 If the value is non-nil and not a number, we wait 2 seconds.");
8513 Vsuggest_key_bindings
= Qt
;
8515 DEFVAR_LISP ("timer-list", &Vtimer_list
,
8516 "List of active absolute time timers in order of increasing time");
8519 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
8520 "List of active idle-time timers in order of increasing time");
8521 Vtimer_idle_list
= Qnil
;
8526 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
8527 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
8528 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
8529 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
8530 initial_define_key (meta_map
, 'x', "execute-extended-command");
8532 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
8533 "handle-delete-frame");
8534 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
8536 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",