1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993 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, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
36 #include "dispextern.h"
38 #include "intervals.h"
39 #include "blockinput.h"
44 #include <sys/ioctl.h>
47 #include "syssignal.h"
53 /* Variables for blockinput.h: */
55 /* Non-zero if interrupt input is blocked right now. */
56 int interrupt_input_blocked
;
58 /* Nonzero means an input interrupt has arrived
59 during the current critical section. */
60 int interrupt_input_pending
;
64 extern Lisp_Object Vmouse_grabbed
;
66 /* Make all keyboard buffers much bigger when using X windows. */
67 #define KBD_BUFFER_SIZE 4096
68 #else /* No X-windows, character input */
69 #define KBD_BUFFER_SIZE 256
70 #endif /* No X-windows */
72 /* Following definition copied from eval.c */
76 struct backtrace
*next
;
77 Lisp_Object
*function
;
78 Lisp_Object
*args
; /* Points to vector of args. */
79 int nargs
; /* length of vector. If nargs is UNEVALLED,
80 args points to slot holding list of
85 /* Non-nil disable property on a command means
86 do not execute it; call disabled-command-hook's value instead. */
87 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
89 #define NUM_RECENT_KEYS (100)
90 int recent_keys_index
; /* Index for storing next element into recent_keys */
91 int total_keys
; /* Total number of elements stored into recent_keys */
92 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
94 /* Vector holding the key sequence that invoked the current command.
95 It is reused for each command, and it may be longer than the current
96 sequence; this_command_key_count indicates how many elements
97 actually mean something.
98 It's easier to staticpro a single Lisp_Object than an array. */
99 Lisp_Object this_command_keys
;
100 int this_command_key_count
;
102 extern int minbuf_level
;
104 extern struct backtrace
*backtrace_list
;
106 /* Nonzero means do menu prompting. */
107 static int menu_prompting
;
109 /* Character to see next line of menu prompt. */
110 static Lisp_Object menu_prompt_more_char
;
112 /* For longjmp to where kbd input is being done. */
113 static jmp_buf getcjmp
;
115 /* True while doing kbd input. */
116 int waiting_for_input
;
118 /* True while displaying for echoing. Delays C-g throwing. */
121 /* Nonzero means C-G should cause immediate error-signal. */
124 /* Character to recognize as the help char. */
125 Lisp_Object Vhelp_char
;
127 /* Form to execute when help char is typed. */
128 Lisp_Object Vhelp_form
;
130 /* Command to run when the help character follows a prefix key. */
131 Lisp_Object Vprefix_help_command
;
133 /* List of items that should move to the end of the menu bar. */
134 Lisp_Object Vmenu_bar_final_items
;
136 /* Character that causes a quit. Normally C-g.
138 If we are running on an ordinary terminal, this must be an ordinary
139 ASCII char, since we want to make it our interrupt character.
141 If we are not running on an ordinary terminal, it still needs to be
142 an ordinary ASCII char. This character needs to be recognized in
143 the input interrupt handler. At this point, the keystroke is
144 represented as a struct input_event, while the desired quit
145 character is specified as a lispy event. The mapping from struct
146 input_events to lispy events cannot run in an interrupt handler,
147 and the reverse mapping is difficult for anything but ASCII
150 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
154 extern Lisp_Object current_global_map
;
155 extern int minibuf_level
;
157 /* Current depth in recursive edits. */
158 int command_loop_level
;
160 /* Total number of times command_loop has read a key sequence. */
163 /* Last input character read as a command. */
164 Lisp_Object last_command_char
;
166 /* Last input character read as a command, not counting menus
167 reached by the mouse. */
168 Lisp_Object last_nonmenu_event
;
170 /* Last input character read for any purpose. */
171 Lisp_Object last_input_char
;
173 /* If not Qnil, a list of objects to be read as subsequent command input. */
174 Lisp_Object unread_command_events
;
176 /* If not -1, an event to be read as subsequent command input. */
177 int unread_command_char
;
179 /* If not Qnil, this is a switch-frame event which we decided to put
180 off until the end of a key sequence. This should be read as the
181 next command input, after any unread_command_events.
183 read_key_sequence uses this to delay switch-frame events until the
184 end of the key sequence; Fread_char uses it to put off switch-frame
185 events until a non-ASCII event is acceptable as input. */
186 Lisp_Object unread_switch_frame
;
188 /* A mask of extra modifier bits to put into every keyboard char. */
189 int extra_keyboard_modifiers
;
191 /* Char to use as prefix when a meta character is typed in.
192 This is bound on entry to minibuffer in case ESC is changed there. */
194 Lisp_Object meta_prefix_char
;
196 /* Last size recorded for a current buffer which is not a minibuffer. */
197 static int last_non_minibuf_size
;
199 /* Number of idle seconds before an auto-save and garbage collection. */
200 static Lisp_Object Vauto_save_timeout
;
202 /* Total number of times read_char has returned. */
205 /* Total number of times read_char has returned, outside of macros. */
206 int num_nonmacro_input_chars
;
208 /* Auto-save automatically when this many characters have been typed
209 since the last time. */
211 static int auto_save_interval
;
213 /* Value of num_nonmacro_input_chars as of last auto save. */
217 /* Last command executed by the editor command loop, not counting
218 commands that set the prefix argument. */
220 Lisp_Object last_command
;
222 /* The command being executed by the command loop.
223 Commands may set this, and the value set will be copied into last_command
224 instead of the actual command. */
225 Lisp_Object this_command
;
228 /* The frame in which the last input event occurred, or Qmacro if the
229 last event came from a macro. We use this to determine when to
230 generate switch-frame events. This may be cleared by functions
231 like Fselect_frame, to make sure that a switch-frame event is
232 generated by the next character. */
233 Lisp_Object internal_last_event_frame
;
235 /* A user-visible version of the above, intended to allow users to
236 figure out where the last event came from, if the event doesn't
237 carry that information itself (i.e. if it was a character). */
238 Lisp_Object Vlast_event_frame
;
241 /* The timestamp of the last input event we received from the X server.
242 X Windows wants this for selection ownership. */
243 unsigned long last_event_timestamp
;
245 Lisp_Object Qself_insert_command
;
246 Lisp_Object Qforward_char
;
247 Lisp_Object Qbackward_char
;
248 Lisp_Object Qundefined
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 Lisp_Object read_key_sequence_cmd
;
254 /* Form to evaluate (if non-nil) when Emacs is started. */
255 Lisp_Object Vtop_level
;
257 /* User-supplied string to translate input characters through. */
258 Lisp_Object Vkeyboard_translate_table
;
260 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
261 extern Lisp_Object Vfunction_key_map
;
263 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
264 Lisp_Object Vkey_translation_map
;
266 /* Non-nil means deactivate the mark at end of this command. */
267 Lisp_Object Vdeactivate_mark
;
269 /* Menu bar specified in Lucid Emacs fashion. */
271 Lisp_Object Vlucid_menu_bar_dirty_flag
;
272 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
274 /* Hooks to run before and after each command. */
275 Lisp_Object Qpre_command_hook
, Qpost_command_hook
;
276 Lisp_Object Vpre_command_hook
, Vpost_command_hook
;
278 /* File in which we write all commands we read. */
281 /* Nonzero if input is available. */
284 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
285 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
289 extern char *pending_malloc_warning
;
291 /* Circular buffer for pre-read keyboard input. */
292 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
294 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
296 The interrupt-level event handlers will never enqueue an event on a
297 frame which is not in Vframe_list, and once an event is dequeued,
298 internal_last_event_frame or the event itself points to the frame.
301 But while the event is sitting in the queue, it's completely
302 unprotected. Suppose the user types one command which will run for
303 a while and then delete a frame, and then types another event at
304 the frame that will be deleted, before the command gets around to
305 it. Suppose there are no references to this frame elsewhere in
306 Emacs, and a GC occurs before the second event is dequeued. Now we
307 have an event referring to a freed frame, which will crash Emacs
310 Similar things happen when an event on a scroll bar is enqueued; the
311 window may be deleted while the event is in the queue.
313 So, we use this vector to protect the frame_or_window field in the
314 event queue. That way, they'll be dequeued as dead frames or
315 windows, but still valid lisp objects.
317 If kbd_buffer[i].kind != no_event, then
318 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
319 == kbd_buffer[i].frame_or_window. */
320 static Lisp_Object kbd_buffer_frame_or_window
;
322 /* Pointer to next available character in kbd_buffer.
323 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
324 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
325 next available char is in kbd_buffer[0]. */
326 static struct input_event
*kbd_fetch_ptr
;
328 /* Pointer to next place to store character in kbd_buffer. This
329 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
330 character should go in kbd_buffer[0]. */
334 static struct input_event
*kbd_store_ptr
;
336 /* The above pair of variables forms a "queue empty" flag. When we
337 enqueue a non-hook event, we increment kbd_write_count. When we
338 dequeue a non-hook event, we increment kbd_read_count. We say that
339 there is input available iff the two counters are not equal.
341 Why not just have a flag set and cleared by the enqueuing and
342 dequeuing functions? Such a flag could be screwed up by interrupts
343 at inopportune times. */
345 /* If this flag is non-zero, we check mouse_moved to see when the
346 mouse moves, and motion events will appear in the input stream. If
347 it is zero, mouse motion is ignored. */
348 static int do_mouse_tracking
;
350 /* The window system handling code should set this if the mouse has
351 moved since the last call to the mouse_position_hook. Calling that
352 hook should clear this. Code assumes that if this is set, it can
353 call mouse_position_hook to get the promised position, so don't set
354 it unless you're prepared to substantiate the claim! */
357 /* True iff there is an event in kbd_buffer, or if mouse tracking is
358 enabled and there is a new mouse position in the mouse movement
359 buffer. Note that if this is false, that doesn't mean that there
360 is readable input; all the events in the queue might be button-up
361 events, and do_mouse_tracking might be off. */
362 #define EVENT_QUEUES_EMPTY \
363 ((kbd_fetch_ptr == kbd_store_ptr) && (!do_mouse_tracking || !mouse_moved))
366 /* Symbols to head events. */
367 Lisp_Object Qmouse_movement
;
368 Lisp_Object Qscroll_bar_movement
;
369 Lisp_Object Qswitch_frame
;
371 /* Symbols to denote kinds of events. */
372 Lisp_Object Qfunction_key
;
373 Lisp_Object Qmouse_click
;
374 /* Lisp_Object Qmouse_movement; - also an event header */
376 /* Properties of event headers. */
377 Lisp_Object Qevent_kind
;
378 Lisp_Object Qevent_symbol_elements
;
380 Lisp_Object Qmenu_enable
;
382 /* An event header symbol HEAD may have a property named
383 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
384 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
385 mask of modifiers applied to it. If present, this is used to help
386 speed up parse_modifiers. */
387 Lisp_Object Qevent_symbol_element_mask
;
389 /* An unmodified event header BASE may have a property named
390 Qmodifier_cache, which is an alist mapping modifier masks onto
391 modified versions of BASE. If present, this helps speed up
393 Lisp_Object Qmodifier_cache
;
395 /* Symbols to use for parts of windows. */
396 Lisp_Object Qmode_line
;
397 Lisp_Object Qvertical_line
;
398 Lisp_Object Qvertical_scroll_bar
;
399 Lisp_Object Qmenu_bar
;
401 extern Lisp_Object Qmenu_enable
;
403 Lisp_Object
recursive_edit_unwind (), command_loop ();
404 Lisp_Object
Fthis_command_keys ();
406 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
408 EMACS_TIME
*input_available_clear_time
;
410 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
411 Default is 1 if INTERRUPT_INPUT is defined. */
414 /* Nonzero while interrupts are temporarily deferred during redisplay. */
415 int interrupts_deferred
;
417 /* nonzero means use ^S/^Q for flow control. */
420 /* Allow m- file to inhibit use of FIONREAD. */
421 #ifdef BROKEN_FIONREAD
425 /* We are unable to use interrupts if FIONREAD is not available,
426 so flush SIGIO so we won't try. */
433 /* If we support X Windows, turn on the code to poll periodically
434 to detect C-g. It isn't actually used when doing interrupt input. */
435 #ifdef HAVE_X_WINDOWS
436 #define POLL_FOR_INPUT
439 /* Global variable declarations. */
441 /* Function for init_keyboard to call with no args (if nonzero). */
442 void (*keyboard_init_hook
) ();
444 static int read_avail_input ();
445 static void get_input_pending ();
446 static int readable_events ();
447 static Lisp_Object
read_char_menu_prompt ();
448 static Lisp_Object
make_lispy_event ();
449 static Lisp_Object
make_lispy_movement ();
450 static Lisp_Object
modify_event_symbol ();
451 static Lisp_Object
make_lispy_switch_frame ();
453 /* > 0 if we are to echo keystrokes. */
454 static int echo_keystrokes
;
456 /* Nonzero means echo each character as typed. */
457 static int immediate_echo
;
459 /* The text we're echoing in the modeline - partial key sequences,
460 usually. '\0'-terminated. This really shouldn't have a fixed size. */
461 static char echobuf
[300];
463 /* Where to append more text to echobuf if we want to. */
464 static char *echoptr
;
466 #define min(a,b) ((a)<(b)?(a):(b))
467 #define max(a,b) ((a)>(b)?(a):(b))
469 /* Install the string STR as the beginning of the string of echoing,
470 so that it serves as a prompt for the next character.
471 Also start echoing. */
476 int len
= strlen (str
);
477 if (len
> sizeof echobuf
- 4)
478 len
= sizeof echobuf
- 4;
479 bcopy (str
, echobuf
, len
);
480 echoptr
= echobuf
+ len
;
486 /* Add C to the echo string, if echoing is going on.
487 C can be a character, which is printed prettily ("M-C-x" and all that
488 jazz), or a symbol, whose name is printed. */
493 extern char *push_key_description ();
502 /* If someone has passed us a composite event, use its head symbol. */
505 if (XTYPE (c
) == Lisp_Int
)
507 if (ptr
- echobuf
> sizeof echobuf
- 6)
510 ptr
= push_key_description (XINT (c
), ptr
);
512 else if (XTYPE (c
) == Lisp_Symbol
)
514 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
515 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
517 bcopy (name
->data
, ptr
, name
->size
);
521 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
523 strcpy (ptr
, " (Type ? for further options)");
534 /* Temporarily add a dash to the end of the echo string if it's not
535 empty, so that it serves as a mini-prompt for the very next character. */
539 if (!immediate_echo
&& echoptr
== echobuf
)
541 /* Do nothing if not echoing at all. */
545 /* Put a dash at the end of the buffer temporarily,
546 but make it go away when the next character is added. */
553 /* Display the current echo string, and begin echoing if not already
563 for (i
= 0; i
< this_command_key_count
; i
++)
564 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
572 if (waiting_for_input
&& !NILP (Vquit_flag
))
573 quit_throw_to_read_char ();
576 /* Turn off echoing, for the start of a new command. */
584 /* Return the length of the current echo string. */
589 return echoptr
- echobuf
;
592 /* Truncate the current echo message to its first LEN chars.
593 This and echo_char get used by read_key_sequence when the user
594 switches frames while entering a key sequence. */
601 echoptr
= echobuf
+ len
;
605 /* Functions for manipulating this_command_keys. */
607 add_command_key (key
)
610 int size
= XVECTOR (this_command_keys
)->size
;
612 if (this_command_key_count
>= size
)
614 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
616 bcopy (XVECTOR (this_command_keys
)->contents
,
617 XVECTOR (new_keys
)->contents
,
618 size
* sizeof (Lisp_Object
));
620 this_command_keys
= new_keys
;
623 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
629 int count
= specpdl_ptr
- specpdl
;
632 if (command_loop_level
> 0)
634 specbind (Qstandard_output
, Qt
);
635 specbind (Qstandard_input
, Qt
);
638 val
= command_loop ();
640 Fsignal (Qquit
, Qnil
);
642 return unbind_to (count
, Qnil
);
645 /* When an auto-save happens, record the "time", and don't do again soon. */
648 last_auto_save
= num_nonmacro_input_chars
;
651 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
652 "Invoke the editor command loop recursively.\n\
653 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
654 that tells this function to return.\n\
655 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
656 This function is called by the editor initialization to begin editing.")
659 int count
= specpdl_ptr
- specpdl
;
662 command_loop_level
++;
663 update_mode_lines
= 1;
665 record_unwind_protect (recursive_edit_unwind
,
667 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
671 return unbind_to (count
, Qnil
);
675 recursive_edit_unwind (buffer
)
679 Fset_buffer (buffer
);
681 command_loop_level
--;
682 update_mode_lines
= 1;
690 Lisp_Object errmsg
, tail
, errname
, file_error
;
697 Vstandard_output
= Qt
;
698 Vstandard_input
= Qt
;
699 Vexecuting_macro
= Qnil
;
700 echo_area_glyphs
= 0;
702 /* If the window system or terminal frame hasn't been initialized
703 yet, or we're not interactive, it's best to dump this message out
704 to stderr and exit. */
705 if (! FRAME_MESSAGE_BUF (selected_frame
)
707 stream
= Qexternal_debugging_output
;
715 errname
= Fcar (data
);
717 if (EQ (errname
, Qerror
))
720 if (!CONSP (data
)) data
= Qnil
;
721 errmsg
= Fcar (data
);
726 errmsg
= Fget (errname
, Qerror_message
);
727 file_error
= Fmemq (Qfile_error
,
728 Fget (errname
, Qerror_conditions
));
731 /* Print an error message including the data items.
732 This is done by printing it into a scratch buffer
733 and then making a copy of the text in the buffer. */
735 if (!CONSP (data
)) data
= Qnil
;
739 /* For file-error, make error message by concatenating
740 all the data items. They are all strings. */
741 if (!NILP (file_error
) && !NILP (tail
))
742 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
744 if (XTYPE (errmsg
) == Lisp_String
)
745 Fprinc (errmsg
, stream
);
747 write_string_1 ("peculiar error", -1, stream
);
749 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
751 write_string_1 (i
? ", " : ": ", 2, stream
);
752 if (!NILP (file_error
))
753 Fprinc (Fcar (tail
), stream
);
755 Fprin1 (Fcar (tail
), stream
);
759 /* If the window system or terminal frame hasn't been initialized
760 yet, or we're in -batch mode, this error should cause Emacs to exit. */
761 if (! FRAME_MESSAGE_BUF (selected_frame
)
765 Fkill_emacs (make_number (-1));
770 Vinhibit_quit
= Qnil
;
771 return make_number (0);
774 Lisp_Object
command_loop_1 ();
775 Lisp_Object
command_loop_2 ();
776 Lisp_Object
top_level_1 ();
778 /* Entry to editor-command-loop.
779 This level has the catches for exiting/returning to editor command loop.
780 It returns nil to exit recursive edit, t to abort it. */
785 if (command_loop_level
> 0 || minibuf_level
> 0)
787 return internal_catch (Qexit
, command_loop_2
, Qnil
);
792 internal_catch (Qtop_level
, top_level_1
, Qnil
);
793 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
795 /* End of file in -batch run causes exit here. */
801 /* Here we catch errors in execution of commands within the
802 editing loop, and reenter the editing loop.
803 When there is an error, cmd_error runs and returns a non-nil
804 value to us. A value of nil means that cmd_loop_1 itself
805 returned due to end of file (or end of kbd macro). */
810 register Lisp_Object val
;
813 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
822 return Feval (Vtop_level
);
828 /* On entry to the outer level, run the startup file */
829 if (!NILP (Vtop_level
))
830 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
831 else if (!NILP (Vpurify_flag
))
832 message ("Bare impure Emacs (standard Lisp code not loaded)");
834 message ("Bare Emacs (standard Lisp code not loaded)");
838 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
839 "Exit all recursive editing levels.")
842 Fthrow (Qtop_level
, Qnil
);
845 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
846 "Exit from the innermost recursive edit or minibuffer.")
849 if (command_loop_level
> 0 || minibuf_level
> 0)
850 Fthrow (Qexit
, Qnil
);
852 error ("No recursive edit is in progress");
855 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
856 "Abort the command that requested this recursive edit or minibuffer input.")
859 if (command_loop_level
> 0 || minibuf_level
> 0)
862 error ("No recursive edit is in progress");
865 /* This is the actual command reading loop,
866 sans error-handling encapsulation. */
868 Lisp_Object
Fcommand_execute ();
869 static int read_key_sequence ();
874 Lisp_Object cmd
, tem
;
877 Lisp_Object keybuf
[30];
882 struct buffer
*prev_buffer
;
885 Vdeactivate_mark
= Qnil
;
886 waiting_for_input
= 0;
889 /* Don't clear out last_command at the beginning of a macro. */
890 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
895 this_command_key_count
= 0;
897 /* Make sure this hook runs after commands that get errors and
898 throw to top level. */
899 if (!NILP (Vpost_command_hook
))
900 call1 (Vrun_hooks
, Qpost_command_hook
);
904 /* Install chars successfully executed in kbd macro. */
906 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
907 finalize_kbd_macro_chars ();
909 /* Make sure the current window's buffer is selected. */
910 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
911 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
913 /* Display any malloc warning that just came out. Use while because
914 displaying one warning can cause another. */
916 while (pending_malloc_warning
)
917 display_malloc_warning ();
921 Vdeactivate_mark
= Qnil
;
923 /* If minibuffer on and echo area in use,
924 wait 2 sec and redraw minibuffer. */
926 if (minibuf_level
&& echo_area_glyphs
)
928 /* Bind inhibit-quit to t so that C-g gets read in
929 rather than quitting back to the minibuffer. */
930 int count
= specpdl_ptr
- specpdl
;
931 specbind (Qinhibit_quit
, Qt
);
932 Fsit_for (make_number (2), Qnil
, Qnil
);
933 unbind_to (count
, Qnil
);
935 echo_area_glyphs
= 0;
937 if (!NILP (Vquit_flag
))
940 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
945 alloca (0); /* Cause a garbage collection now */
946 /* Since we can free the most stuff here. */
947 #endif /* C_ALLOCA */
951 /* Select the frame that the last event came from. Usually,
952 switch-frame events will take care of this, but if some lisp
953 code swallows a switch-frame event, we'll fix things up here.
954 Is this a good idea? */
955 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
956 && XFRAME (internal_last_event_frame
) != selected_frame
)
957 Fselect_frame (internal_last_event_frame
, Qnil
);
960 /* If it has changed current-menubar from previous value,
961 really recompute the menubar from the value. */
962 if (! NILP (Vlucid_menu_bar_dirty_flag
)
963 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
964 call0 (Qrecompute_lucid_menubar
);
966 #if 0 /* This is done in xdisp.c now. */
968 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
970 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
971 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
973 /* If the user has switched buffers or windows, we need to
974 recompute to reflect the new bindings. But we'll
975 recompute when update_mode_lines is set too; that means
976 that people can use force-mode-line-update to request
977 that the menu bar be recomputed. The adverse effect on
978 the rest of the redisplay algorithm is about the same as
979 windows_or_buffers_changed anyway. */
980 if (windows_or_buffers_changed
982 || (XFASTINT (w
->last_modified
) < MODIFF
983 && (XFASTINT (w
->last_modified
)
984 <= XBUFFER (w
->buffer
)->save_modified
)))
986 struct buffer
*prev
= current_buffer
;
987 current_buffer
= XBUFFER (w
->buffer
);
988 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
989 current_buffer
= prev
;
992 #endif /* MULTI_FRAME */
995 /* Read next key sequence; i gets its length. */
996 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), 0);
1000 /* Now we have read a key sequence of length I,
1001 or else I is 0 and we found end of file. */
1003 if (i
== 0) /* End of file -- happens only in */
1004 return Qnil
; /* a kbd macro, at the end. */
1005 /* -1 means read_key_sequence got a menu that was rejected.
1006 Just loop around and read another command. */
1010 this_command_key_count
= 0;
1014 last_command_char
= keybuf
[i
- 1];
1016 /* If the previous command tried to force a specific window-start,
1017 forget about that, in case this command moves point far away
1018 from that position. */
1019 XWINDOW (selected_window
)->force_start
= Qnil
;
1021 cmd
= read_key_sequence_cmd
;
1022 if (!NILP (Vexecuting_macro
))
1024 if (!NILP (Vquit_flag
))
1026 Vexecuting_macro
= Qt
;
1027 QUIT
; /* Make some noise. */
1028 /* Will return since macro now empty. */
1032 /* Do redisplay processing after this command except in special
1033 cases identified below that set no_redisplay to 1. */
1036 prev_buffer
= current_buffer
;
1037 prev_modiff
= MODIFF
;
1039 /* Execute the command. */
1042 if (!NILP (Vpre_command_hook
))
1043 call1 (Vrun_hooks
, Qpre_command_hook
);
1045 if (NILP (this_command
))
1047 /* nil means key is undefined. */
1049 defining_kbd_macro
= 0;
1050 update_mode_lines
= 1;
1056 if (NILP (Vprefix_arg
) && ! no_direct
)
1058 /* Recognize some common commands in common situations and
1059 do them directly. */
1060 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1062 struct Lisp_Vector
*dp
1063 = window_display_table (XWINDOW (selected_window
));
1064 lose
= FETCH_CHAR (point
);
1067 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1068 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1069 : (lose
>= 0x20 && lose
< 0x7f))
1070 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1072 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1074 && !windows_or_buffers_changed
1075 && EQ (current_buffer
->selective_display
, Qnil
)
1076 && !detect_input_pending ()
1077 && NILP (Vexecuting_macro
))
1078 no_redisplay
= direct_output_forward_char (1);
1081 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1083 struct Lisp_Vector
*dp
1084 = window_display_table (XWINDOW (selected_window
));
1086 lose
= FETCH_CHAR (point
);
1088 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1089 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1090 : (lose
>= 0x20 && lose
< 0x7f))
1091 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1093 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1095 && !windows_or_buffers_changed
1096 && EQ (current_buffer
->selective_display
, Qnil
)
1097 && !detect_input_pending ()
1098 && NILP (Vexecuting_macro
))
1099 no_redisplay
= direct_output_forward_char (-1);
1102 else if (EQ (this_command
, Qself_insert_command
)
1103 /* Try this optimization only on ascii keystrokes. */
1104 && XTYPE (last_command_char
) == Lisp_Int
)
1106 unsigned char c
= XINT (last_command_char
);
1108 if (NILP (Vexecuting_macro
) &&
1109 !EQ (minibuf_window
, selected_window
))
1111 if (!nonundocount
|| nonundocount
>= 20)
1118 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1120 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1122 || MODIFF
<= current_buffer
->save_modified
1123 || windows_or_buffers_changed
1124 || !EQ (current_buffer
->selective_display
, Qnil
)
1125 || detect_input_pending ()
1126 || !NILP (Vexecuting_macro
);
1127 if (internal_self_insert (c
, 0))
1133 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1135 struct Lisp_Vector
*dp
1136 = window_display_table (XWINDOW (selected_window
));
1141 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1143 if (XTYPE (obj
) == Lisp_Vector
1144 && XVECTOR (obj
)->size
== 1
1145 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1148 direct_output_for_insert (XINT (obj
));
1152 if (lose
>= 0x20 && lose
<= 0x7e)
1153 no_redisplay
= direct_output_for_insert (lose
);
1160 /* Here for a command that isn't executed directly */
1163 if (NILP (Vprefix_arg
))
1165 Fcommand_execute (this_command
, Qnil
);
1170 if (!NILP (Vpost_command_hook
))
1171 call1 (Vrun_hooks
, Qpost_command_hook
);
1173 /* If there is a prefix argument,
1174 1) We don't want last_command to be ``universal-argument''
1175 (that would be dumb), so don't set last_command,
1176 2) we want to leave echoing on so that the prefix will be
1177 echoed as part of this key sequence, so don't call
1179 3) we want to leave this_command_key_count non-zero, so that
1180 read_char will realize that it is re-reading a character, and
1181 not echo it a second time. */
1182 if (NILP (Vprefix_arg
))
1184 last_command
= this_command
;
1186 this_command_key_count
= 0;
1189 if (!NILP (current_buffer
->mark_active
))
1191 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1193 current_buffer
->mark_active
= Qnil
;
1194 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1196 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1197 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1202 /* Number of seconds between polling for input. */
1205 /* Nonzero means polling for input is temporarily suppressed. */
1206 int poll_suppress_count
;
1208 #ifdef POLL_FOR_INPUT
1209 int polling_for_input
;
1211 /* Handle an alarm once each second and read pending input
1212 so as to handle a C-g if it comces in. */
1215 input_poll_signal ()
1217 if (interrupt_input_blocked
== 0
1218 && !waiting_for_input
)
1219 read_avail_input (0);
1220 signal (SIGALRM
, input_poll_signal
);
1221 alarm (polling_period
);
1226 /* Begin signals to poll for input, if they are appropriate.
1227 This function is called unconditionally from various places. */
1231 #ifdef POLL_FOR_INPUT
1232 if (read_socket_hook
&& !interrupt_input
)
1234 poll_suppress_count
--;
1235 if (poll_suppress_count
== 0)
1237 signal (SIGALRM
, input_poll_signal
);
1238 polling_for_input
= 1;
1239 alarm (polling_period
);
1245 /* Turn off polling. */
1249 #ifdef POLL_FOR_INPUT
1250 if (read_socket_hook
&& !interrupt_input
)
1252 if (poll_suppress_count
== 0)
1254 polling_for_input
= 0;
1257 poll_suppress_count
++;
1262 /* Set the value of poll_suppress_count to COUNT
1263 and start or stop polling accordingly. */
1266 set_poll_suppress_count (count
)
1269 #ifdef POLL_FOR_INPUT
1270 if (count
== 0 && poll_suppress_count
!= 0)
1272 poll_suppress_count
= 1;
1275 else if (count
!= 0 && poll_suppress_count
== 0)
1279 poll_suppress_count
= count
;
1283 /* Applying the control modifier to CHARACTER. */
1288 /* Save the upper bits here. */
1289 int upper
= c
& ~0177;
1293 /* Everything in the columns containing the upper-case letters
1294 denotes a control character. */
1295 if (c
>= 0100 && c
< 0140)
1299 /* Set the shift modifier for a control char
1300 made from a shifted letter. But only for letters! */
1301 if (oc
>= 'A' && oc
<= 'Z')
1302 c
|= shift_modifier
;
1305 /* The lower-case letters denote control characters too. */
1306 else if (c
>= 'a' && c
<= 'z')
1309 /* Include the bits for control and shift
1310 only if the basic ASCII code can't indicate them. */
1314 /* Replace the high bits. */
1315 c
|= (upper
& ~ctrl_modifier
);
1322 /* Input of single characters from keyboard */
1324 Lisp_Object
print_help ();
1325 static Lisp_Object
kbd_buffer_get_event ();
1327 /* read a character from the keyboard; call the redisplay if needed */
1328 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1329 -1 means do not do redisplay, but do do autosaving.
1332 /* The arguments MAPS and NMAPS are for menu prompting.
1333 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1335 PREV_EVENT is the previous input event, or nil if we are reading
1336 the first event of a key sequence.
1338 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1339 if we used a mouse menu to read the input, or zero otherwise. If
1340 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1342 Value is t if we showed a menu and the user rejected it. */
1345 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1349 Lisp_Object prev_event
;
1350 int *used_mouse_menu
;
1352 register Lisp_Object c
;
1356 if (CONSP (unread_command_events
))
1358 c
= XCONS (unread_command_events
)->car
;
1359 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1361 if (this_command_key_count
== 0)
1367 if (unread_command_char
!= -1)
1369 XSET (c
, Lisp_Int
, unread_command_char
);
1370 unread_command_char
= -1;
1372 if (this_command_key_count
== 0)
1378 if (!NILP (Vexecuting_macro
))
1381 /* We set this to Qmacro; since that's not a frame, nobody will
1382 try to switch frames on us, and the selected window will
1385 Since this event came from a macro, it would be misleading to
1386 leave internal_last_event_frame set to wherever the last
1387 real event came from. Normally, a switch-frame event selects
1388 internal_last_event_frame after each command is read, but
1389 events read from a macro should never cause a new frame to be
1391 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1394 /* Exit the macro if we are at the end.
1395 Also, some things replace the macro with t
1396 to force an early exit. */
1397 if (EQ (Vexecuting_macro
, Qt
)
1398 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1400 XSET (c
, Lisp_Int
, -1);
1404 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1405 if (XTYPE (Vexecuting_macro
) == Lisp_String
1406 && (XINT (c
) & 0x80))
1407 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1409 executing_macro_index
++;
1414 if (!NILP (unread_switch_frame
))
1416 c
= unread_switch_frame
;
1417 unread_switch_frame
= Qnil
;
1419 /* This event should make it into this_command_keys, and get echoed
1420 again, so we go to reread_first, rather than reread. */
1424 /* Save outer setjmp data, in case called recursively. */
1425 save_getcjmp (save_jump
);
1429 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1432 if (_setjmp (getcjmp
))
1434 XSET (c
, Lisp_Int
, quit_char
);
1436 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1437 Vlast_event_frame
= internal_last_event_frame
;
1439 /* If we report the quit char as an event,
1440 don't do so more than once. */
1441 if (!NILP (Vinhibit_quit
))
1447 /* Message turns off echoing unless more keystrokes turn it on again. */
1448 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1451 /* If already echoing, continue. */
1454 /* If in middle of key sequence and minibuffer not active,
1455 start echoing if enough time elapses. */
1456 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1457 && echo_keystrokes
> 0
1458 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1462 /* After a mouse event, start echoing right away.
1463 This is because we are probably about to display a menu,
1464 and we don't want to delay before doing so. */
1465 if (EVENT_HAS_PARAMETERS (prev_event
))
1469 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1475 /* Maybe auto save due to number of keystrokes or idle time. */
1477 if (commandflag
!= 0
1478 && auto_save_interval
> 0
1479 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1480 && !detect_input_pending ())
1483 save_getcjmp (temp
);
1484 Fdo_auto_save (Qnil
, Qnil
);
1485 restore_getcjmp (temp
);
1488 /* Try reading a character via menu prompting.
1489 Try this before the sit-for, because the sit-for
1490 would do the wrong thing if we are supposed to do
1493 if (INTERACTIVE
&& !NILP (prev_event
))
1494 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1496 /* Slow down auto saves logarithmically in size of current buffer,
1497 and garbage collect while we're at it. */
1498 if (INTERACTIVE
&& NILP (c
))
1500 int delay_level
, buffer_size
;
1502 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1503 last_non_minibuf_size
= Z
- BEG
;
1504 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1506 while (buffer_size
> 64)
1507 delay_level
++, buffer_size
-= buffer_size
>> 2;
1508 if (delay_level
< 4) delay_level
= 4;
1509 /* delay_level is 4 for files under around 50k, 7 at 100k,
1510 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1512 /* Auto save if enough time goes by without input. */
1513 if (commandflag
!= 0
1514 && num_nonmacro_input_chars
> last_auto_save
1515 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1516 && XINT (Vauto_save_timeout
) > 0)
1519 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1520 tem0
= sit_for (delay
, 0, 1, 1);
1524 save_getcjmp (temp
);
1525 Fdo_auto_save (Qnil
, Qnil
);
1526 restore_getcjmp (temp
);
1528 /* If we have auto-saved and there is still no input
1529 available, garbage collect if there has been enough
1530 consing going on to make it worthwhile. */
1531 if (!detect_input_pending ()
1532 && consing_since_gc
> gc_cons_threshold
/ 2)
1534 Fgarbage_collect ();
1541 /* Actually read a character, waiting if necessary. */
1544 c
= kbd_buffer_get_event ();
1547 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1551 /* Terminate Emacs in batch mode if at eof. */
1552 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1553 Fkill_emacs (make_number (1));
1555 if (XTYPE (c
) == Lisp_Int
)
1557 /* Add in any extra modifiers, where appropriate. */
1558 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1559 || ((extra_keyboard_modifiers
& 0177) < ' '
1560 && (extra_keyboard_modifiers
& 0177) != 0))
1561 XSETINT (c
, make_ctrl_char (XINT (c
)));
1563 /* Transfer any other modifier bits directly from
1564 extra_keyboard_modifiers to c. Ignore the actual character code
1565 in the low 16 bits of extra_keyboard_modifiers. */
1566 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1571 restore_getcjmp (save_jump
);
1575 echo_area_glyphs
= 0;
1577 /* Handle things that only apply to characters. */
1578 if (XTYPE (c
) == Lisp_Int
)
1580 /* If kbd_buffer_get_event gave us an EOF, return that. */
1584 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1585 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1586 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1590 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1591 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1592 recent_keys_index
= 0;
1594 /* Write c to the dribble file. If c is a lispy event, write
1595 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1596 If you, dear reader, have a better idea, you've got the source. :-) */
1599 if (XTYPE (c
) == Lisp_Int
)
1600 putc (XINT (c
), dribble
);
1603 Lisp_Object dribblee
= c
;
1605 /* If it's a structured event, take the event header. */
1606 dribblee
= EVENT_HEAD (dribblee
);
1608 if (XTYPE (dribblee
) == Lisp_Symbol
)
1610 putc ('<', dribble
);
1611 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1612 XSYMBOL (dribblee
)->name
->size
,
1614 putc ('>', dribble
);
1621 store_kbd_macro_char (c
);
1623 num_nonmacro_input_chars
++;
1628 /* Record this character as part of the current key.
1629 Don't record mouse motion; it should never matter. */
1630 if (! (EVENT_HAS_PARAMETERS (c
)
1631 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1634 add_command_key (c
);
1637 /* Re-reading in the middle of a command */
1639 last_input_char
= c
;
1642 /* Process the help character specially if enabled */
1643 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1646 count
= specpdl_ptr
- specpdl
;
1648 record_unwind_protect (Fset_window_configuration
,
1649 Fcurrent_window_configuration (Qnil
));
1651 tem0
= Feval (Vhelp_form
);
1652 if (XTYPE (tem0
) == Lisp_String
)
1653 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1656 c
= read_char (0, 0, 0, Qnil
, 0);
1657 /* Remove the help from the frame */
1658 unbind_to (count
, Qnil
);
1660 if (EQ (c
, make_number (040)))
1663 c
= read_char (0, 0, 0, Qnil
, 0);
1674 Fprinc (object
, Qnil
);
1678 /* Copy out or in the info on where C-g should throw to.
1679 This is used when running Lisp code from within get_char,
1680 in case get_char is called recursively.
1681 See read_process_output. */
1686 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1689 restore_getcjmp (temp
)
1692 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1696 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1697 of this function. */
1699 tracking_off (old_value
)
1700 Lisp_Object old_value
;
1702 if (! XFASTINT (old_value
))
1704 do_mouse_tracking
= 0;
1706 /* Redisplay may have been preempted because there was input
1707 available, and it assumes it will be called again after the
1708 input has been processed. If the only input available was
1709 the sort that we have just disabled, then we need to call
1711 if (!readable_events ())
1713 redisplay_preserve_echo_area ();
1714 get_input_pending (&input_pending
);
1719 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1720 "Evaluate BODY with mouse movement events enabled.\n\
1721 Within a `track-mouse' form, mouse motion generates input events that\n\
1722 you can read with `read-event'.\n\
1723 Normally, mouse motion is ignored.")
1727 int count
= specpdl_ptr
- specpdl
;
1730 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1731 record_unwind_protect (tracking_off
, val
);
1733 do_mouse_tracking
= 1;
1735 val
= Fprogn (args
);
1736 return unbind_to (count
, val
);
1739 /* Low level keyboard/mouse input.
1740 kbd_buffer_store_event places events in kbd_buffer, and
1741 kbd_buffer_get_event retrieves them.
1742 mouse_moved indicates when the mouse has moved again, and
1743 *mouse_position_hook provides the mouse position. */
1745 /* Return true iff there are any events in the queue that read-char
1746 would return. If this returns false, a read-char would block. */
1750 return ! EVENT_QUEUES_EMPTY
;
1753 /* Set this for debugging, to have a way to get out */
1756 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1759 kbd_buffer_store_event (event
)
1760 register struct input_event
*event
;
1762 if (event
->kind
== no_event
)
1765 if (event
->kind
== ascii_keystroke
)
1767 register int c
= XFASTINT (event
->code
) & 0377;
1769 if (event
->modifiers
& ctrl_modifier
)
1770 c
= make_ctrl_char (c
);
1772 c
|= (event
->modifiers
1773 & (meta_modifier
| alt_modifier
1774 | hyper_modifier
| super_modifier
));
1778 extern SIGTYPE
interrupt_signal ();
1781 /* If this results in a quit_char being returned to Emacs as
1782 input, set Vlast_event_frame properly. If this doesn't
1783 get returned to Emacs as an event, the next event read
1784 will set Vlast_event_frame again, so this is safe to do. */
1787 FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1790 internal_last_event_frame
= event
->frame_or_window
;
1792 internal_last_event_frame
= focus
;
1793 Vlast_event_frame
= internal_last_event_frame
;
1797 last_event_timestamp
= event
->timestamp
;
1798 interrupt_signal ();
1802 if (c
&& c
== stop_character
)
1809 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1810 kbd_store_ptr
= kbd_buffer
;
1812 /* Don't let the very last slot in the buffer become full,
1813 since that would make the two pointers equal,
1814 and that is indistinguishable from an empty buffer.
1815 Discard the event if it would fill the last slot. */
1816 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1818 kbd_store_ptr
->kind
= event
->kind
;
1819 kbd_store_ptr
->code
= event
->code
;
1820 kbd_store_ptr
->part
= event
->part
;
1821 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1822 kbd_store_ptr
->modifiers
= event
->modifiers
;
1823 kbd_store_ptr
->x
= event
->x
;
1824 kbd_store_ptr
->y
= event
->y
;
1825 kbd_store_ptr
->timestamp
= event
->timestamp
;
1826 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1828 = event
->frame_or_window
);
1834 /* Read one event from the event buffer, waiting if necessary.
1835 The value is a Lisp object representing the event.
1836 The value is nil for an event that should be ignored,
1837 or that was handled here.
1838 We always read and discard one event. */
1841 kbd_buffer_get_event ()
1849 XSET (obj
, Lisp_Int
, c
);
1853 /* Wait until there is input available. */
1856 if (!EVENT_QUEUES_EMPTY
)
1859 /* If the quit flag is set, then read_char will return
1860 quit_char, so that counts as "available input." */
1861 if (!NILP (Vquit_flag
))
1862 quit_throw_to_read_char ();
1864 /* One way or another, wait until input is available; then, if
1865 interrupt handlers have not read it, read it now. */
1868 wait_for_kbd_input ();
1870 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1874 if (EVENT_QUEUES_EMPTY
)
1876 Lisp_Object minus_one
;
1878 XSET (minus_one
, Lisp_Int
, -1);
1879 wait_reading_process_input (0, 0, minus_one
, 1);
1881 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1883 read_avail_input (0);
1886 #endif /* not VMS */
1889 /* At this point, we know that there is a readable event available
1890 somewhere. If the event queue is empty, then there must be a
1891 mouse movement enabled and available. */
1892 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1894 struct input_event
*event
;
1896 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1900 last_event_timestamp
= event
->timestamp
;
1904 /* These two kinds of events get special handling
1905 and don't actually appear to the command loop.
1906 We return nil for them. */
1907 if (event
->kind
== selection_request_event
)
1910 x_handle_selection_request (event
);
1911 kbd_fetch_ptr
= event
+ 1;
1913 /* We're getting selection request events, but we don't have
1919 else if (event
->kind
== selection_clear_event
)
1922 x_handle_selection_clear (event
);
1923 kbd_fetch_ptr
= event
+ 1;
1925 /* We're getting selection request events, but we don't have
1930 /* Just discard these, by returning nil.
1931 (They shouldn't be found in the buffer,
1932 but on some machines it appears they do show up.) */
1933 else if (event
->kind
== no_event
)
1934 kbd_fetch_ptr
= event
+ 1;
1936 /* If this event is on a different frame, return a switch-frame this
1937 time, and leave the event in the queue for next time. */
1941 Lisp_Object frame
= event
->frame_or_window
;
1944 if (XTYPE (frame
) == Lisp_Window
)
1945 frame
= WINDOW_FRAME (XWINDOW (frame
));
1947 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1951 if (! EQ (frame
, internal_last_event_frame
)
1952 && XFRAME (frame
) != selected_frame
)
1953 obj
= make_lispy_switch_frame (frame
);
1954 internal_last_event_frame
= frame
;
1955 #endif /* MULTI_FRAME */
1957 /* If we didn't decide to make a switch-frame event, go ahead
1958 and build a real event from the queue entry. */
1962 obj
= make_lispy_event (event
);
1964 /* Wipe out this event, to catch bugs. */
1965 event
->kind
= no_event
;
1966 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
1969 kbd_fetch_ptr
= event
+ 1;
1973 /* Try generating a mouse motion event. */
1974 else if (do_mouse_tracking
&& mouse_moved
)
1977 Lisp_Object bar_window
;
1978 enum scroll_bar_part part
;
1982 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
1987 /* Decide if we should generate a switch-frame event. Don't
1988 generate switch-frame events for motion outside of all Emacs
1992 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
1995 XSET (frame
, Lisp_Frame
, f
);
1997 if (! EQ (frame
, internal_last_event_frame
)
1998 && XFRAME (frame
) != selected_frame
)
1999 obj
= make_lispy_switch_frame (frame
);
2000 internal_last_event_frame
= frame
;
2004 /* If we didn't decide to make a switch-frame event, go ahead and
2005 return a mouse-motion event. */
2007 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2010 /* We were promised by the above while loop that there was
2011 something for us to read! */
2014 input_pending
= readable_events ();
2017 Vlast_event_frame
= internal_last_event_frame
;
2023 /* Process any events that are not user-visible,
2024 then return, without reading any user-visible events. */
2029 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2031 struct input_event
*event
;
2033 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2037 last_event_timestamp
= event
->timestamp
;
2039 /* These two kinds of events get special handling
2040 and don't actually appear to the command loop. */
2041 if (event
->kind
== selection_request_event
)
2044 x_handle_selection_request (event
);
2045 kbd_fetch_ptr
= event
+ 1;
2047 /* We're getting selection request events, but we don't have
2053 else if (event
->kind
== selection_clear_event
)
2056 x_handle_selection_clear (event
);
2057 kbd_fetch_ptr
= event
+ 1;
2059 /* We're getting selection request events, but we don't have
2068 get_input_pending (&input_pending
);
2071 /* Caches for modify_event_symbol. */
2072 static Lisp_Object func_key_syms
;
2073 static Lisp_Object mouse_syms
;
2075 /* You'll notice that this table is arranged to be conveniently
2076 indexed by X Windows keysym values. */
2077 static char *lispy_function_keys
[] =
2079 /* X Keysym value */
2081 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2089 0, 0, 0, /* 0xff10 */
2091 0, 0, 0, 0, 0, 0, 0,
2094 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2095 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2096 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2098 "home", /* 0xff50 */ /* IsCursorKey */
2109 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2120 "break", /* 0xff6b */
2122 /* Here are some keys found mostly on HP keyboards. The X event
2123 handling code will strip bit 29, which flags vendor-specific
2125 "reset", /* 0x1000ff6c */
2134 "kp-backtab", /* 0x1000ff75 */
2136 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2137 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2138 0, 0, 0, 0, 0, 0, 0, 0,
2139 "kp-tab", /* 0xff89 */
2141 "kp-enter", /* 0xff8d */
2143 "kp-f1", /* 0xff91 */
2148 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2149 "kp-multiply", /* 0xffaa */
2154 "kp-divide", /* 0xffaf */
2155 "kp-0", /* 0xffb0 */
2156 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2159 "kp-equal", /* 0xffbd */
2160 "f1", /* 0xffbe */ /* IsFunctionKey */
2162 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2163 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2164 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2165 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2166 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2167 0, 0, 0, 0, 0, 0, 0, 0,
2168 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2169 0, 0, 0, 0, 0, 0, 0, "delete"
2172 static char *lispy_mouse_names
[] =
2174 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2177 /* Scroll bar parts. */
2178 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2180 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2181 Lisp_Object
*scroll_bar_parts
[] = {
2182 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2186 /* A vector, indexed by button number, giving the down-going location
2187 of currently depressed buttons, both scroll bar and non-scroll bar.
2189 The elements have the form
2190 (BUTTON-NUMBER MODIFIER-MASK . REST)
2191 where REST is the cdr of a position as it would be reported in the event.
2193 The make_lispy_event function stores positions here to tell the
2194 difference between click and drag events, and to store the starting
2195 location to be included in drag events. */
2197 static Lisp_Object button_down_location
;
2199 /* Information about the most recent up-going button event: Which
2200 button, what location, and what time. */
2202 static int last_mouse_button
;
2203 static int last_mouse_x
;
2204 static int last_mouse_y
;
2205 static unsigned long button_down_time
;
2207 /* The maximum time between clicks to make a double-click,
2208 or Qnil to disable double-click detection,
2209 or Qt for no time limit. */
2210 Lisp_Object Vdouble_click_time
;
2212 /* The number of clicks in this multiple-click. */
2214 int double_click_count
;
2216 /* Given a struct input_event, build the lisp event which represents
2217 it. If EVENT is 0, build a mouse movement event from the mouse
2218 movement buffer, which should have a movement event in it.
2220 Note that events must be passed to this function in the order they
2221 are received; this function stores the location of button presses
2222 in order to build drag events when the button is released. */
2225 make_lispy_event (event
)
2226 struct input_event
*event
;
2228 #ifdef SWITCH_ENUM_BUG
2229 switch ((int) event
->kind
)
2231 switch (event
->kind
)
2234 /* A simple keystroke. */
2235 case ascii_keystroke
:
2237 int c
= XFASTINT (event
->code
);
2238 /* Turn ASCII characters into control characters
2240 if (event
->modifiers
& ctrl_modifier
)
2241 c
= make_ctrl_char (c
);
2243 /* Add in the other modifier bits. We took care of ctrl_modifier
2244 just above, and the shift key was taken care of by the X code,
2245 and applied to control characters by make_ctrl_char. */
2246 c
|= (event
->modifiers
2247 & (meta_modifier
| alt_modifier
2248 | hyper_modifier
| super_modifier
));
2249 button_down_time
= 0;
2253 /* A function key. The symbol may need to have modifier prefixes
2255 case non_ascii_keystroke
:
2256 button_down_time
= 0;
2257 return modify_event_symbol (XFASTINT (event
->code
), event
->modifiers
,
2259 lispy_function_keys
, &func_key_syms
,
2260 (sizeof (lispy_function_keys
)
2261 / sizeof (lispy_function_keys
[0])));
2264 /* A mouse click. Figure out where it is, decide whether it's
2265 a press, click or drag, and build the appropriate structure. */
2267 case scroll_bar_click
:
2269 int button
= XFASTINT (event
->code
);
2271 Lisp_Object position
;
2272 Lisp_Object
*start_pos_ptr
;
2273 Lisp_Object start_pos
;
2275 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2278 /* Build the position as appropriate for this mouse click. */
2279 if (event
->kind
== mouse_click
)
2282 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2284 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2288 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2292 items
= FRAME_MENU_BAR_ITEMS (f
);
2293 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2295 Lisp_Object pos
, string
;
2296 pos
= Fcdr (Fcdr (Fcar (items
)));
2297 string
= Fcar (Fcdr (Fcar (items
)));
2298 if (XINT (event
->x
) >= XINT (pos
)
2299 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2303 = Fcons (event
->frame_or_window
,
2305 Fcons (Fcons (event
->x
, event
->y
),
2306 Fcons (make_number (event
->timestamp
),
2310 return Fcons (Fcar (Fcar (items
)),
2311 Fcons (position
, Qnil
));
2313 return Fcons (Qnil
, Fcons (position
, Qnil
));
2315 else if (XTYPE (window
) != Lisp_Window
)
2320 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2322 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2327 posn
= Qvertical_line
;
2329 XSET (posn
, Lisp_Int
,
2330 buffer_posn_from_coords (XWINDOW (window
),
2338 Fcons (Fcons (event
->x
, event
->y
),
2339 Fcons (make_number (event
->timestamp
),
2344 Lisp_Object window
= event
->frame_or_window
;
2345 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2346 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2350 Fcons (Qvertical_scroll_bar
,
2351 Fcons (portion_whole
,
2352 Fcons (make_number (event
->timestamp
),
2357 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2359 start_pos
= *start_pos_ptr
;
2360 *start_pos_ptr
= Qnil
;
2362 is_double
= (button
== last_mouse_button
2363 && XINT (event
->x
) == last_mouse_x
2364 && XINT (event
->y
) == last_mouse_y
2365 && button_down_time
!= 0
2366 && (EQ (Vdouble_click_time
, Qt
)
2367 || (INTEGERP (Vdouble_click_time
)
2368 && ((int)(event
->timestamp
- button_down_time
)
2369 < XINT (Vdouble_click_time
)))));
2370 last_mouse_button
= button
;
2371 last_mouse_x
= XINT (event
->x
);
2372 last_mouse_y
= XINT (event
->y
);
2374 /* If this is a button press, squirrel away the location, so
2375 we can decide later whether it was a click or a drag. */
2376 if (event
->modifiers
& down_modifier
)
2380 double_click_count
++;
2381 event
->modifiers
|= ((double_click_count
> 2)
2386 double_click_count
= 1;
2387 button_down_time
= event
->timestamp
;
2388 *start_pos_ptr
= Fcopy_alist (position
);
2391 /* Now we're releasing a button - check the co-ordinates to
2392 see if this was a click or a drag. */
2393 else if (event
->modifiers
& up_modifier
)
2395 /* If we did not see a down before this up,
2396 ignore the up. Probably this happened because
2397 the down event chose a menu item.
2398 It would be an annoyance to treat the release
2399 of the button that chose the menu item
2400 as a separate event. */
2402 if (XTYPE (start_pos
) != Lisp_Cons
)
2405 event
->modifiers
&= ~up_modifier
;
2406 #if 0 /* Formerly we treated an up with no down as a click event. */
2407 if (XTYPE (start_pos
) != Lisp_Cons
)
2408 event
->modifiers
|= click_modifier
;
2412 /* The third element of every position should be the (x,y)
2414 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2416 if (EQ (event
->x
, XCONS (down
)->car
)
2417 && EQ (event
->y
, XCONS (down
)->cdr
))
2419 if (is_double
&& double_click_count
> 1)
2420 event
->modifiers
|= ((double_click_count
> 2)
2424 event
->modifiers
|= click_modifier
;
2428 button_down_time
= 0;
2429 event
->modifiers
|= drag_modifier
;
2434 /* Every mouse event should either have the down_modifier or
2435 the up_modifier set. */
2439 /* Get the symbol we should use for the mouse click. */
2441 = modify_event_symbol (button
,
2444 lispy_mouse_names
, &mouse_syms
,
2445 (sizeof (lispy_mouse_names
)
2446 / sizeof (lispy_mouse_names
[0])));
2448 if (event
->modifiers
& drag_modifier
)
2453 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2456 Fcons (make_number (double_click_count
),
2465 /* The 'kind' field of the event is something we don't recognize. */
2472 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2474 Lisp_Object bar_window
;
2475 enum scroll_bar_part part
;
2479 /* Is it a scroll bar movement? */
2480 if (frame
&& ! NILP (bar_window
))
2482 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2484 return Fcons (Qscroll_bar_movement
,
2485 (Fcons (Fcons (bar_window
,
2486 Fcons (Qvertical_scroll_bar
,
2487 Fcons (Fcons (x
, y
),
2488 Fcons (make_number (time
),
2494 /* Or is it an ordinary mouse movement? */
2498 Lisp_Object window
=
2500 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2504 if (XTYPE (window
) == Lisp_Window
)
2506 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2507 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2512 posn
= Qvertical_line
;
2514 XSET (posn
, Lisp_Int
,
2515 buffer_posn_from_coords (XWINDOW (window
),
2516 XINT (x
), XINT (y
)));
2526 return Fcons (Qmouse_movement
,
2527 Fcons (Fcons (window
,
2529 Fcons (Fcons (x
, y
),
2530 Fcons (make_number (time
),
2536 /* Construct a switch frame event. */
2538 make_lispy_switch_frame (frame
)
2541 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2544 /* Manipulating modifiers. */
2546 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2548 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2549 SYMBOL's name of the end of the modifiers; the string from this
2550 position is the unmodified symbol name.
2552 This doesn't use any caches. */
2554 parse_modifiers_uncached (symbol
, modifier_end
)
2558 struct Lisp_String
*name
;
2562 CHECK_SYMBOL (symbol
, 1);
2565 name
= XSYMBOL (symbol
)->name
;
2568 for (i
= 0; i
+2 <= name
->size
; )
2569 switch (name
->data
[i
])
2571 #define SINGLE_LETTER_MOD(bit) \
2572 if (name->data[i+1] != '-') \
2573 goto no_more_modifiers; \
2578 SINGLE_LETTER_MOD (alt_modifier
);
2582 SINGLE_LETTER_MOD (ctrl_modifier
);
2586 SINGLE_LETTER_MOD (hyper_modifier
);
2590 SINGLE_LETTER_MOD (meta_modifier
);
2594 SINGLE_LETTER_MOD (shift_modifier
);
2598 SINGLE_LETTER_MOD (super_modifier
);
2602 if (i
+ 5 > name
->size
)
2603 goto no_more_modifiers
;
2604 if (! strncmp (name
->data
+ i
, "drag-", 5))
2606 modifiers
|= drag_modifier
;
2609 else if (! strncmp (name
->data
+ i
, "down-", 5))
2611 modifiers
|= down_modifier
;
2614 else if (i
+ 7 <= name
->size
2615 && ! strncmp (name
->data
+ i
, "double-", 7))
2617 modifiers
|= double_modifier
;
2621 goto no_more_modifiers
;
2625 if (i
+ 7 > name
->size
)
2626 goto no_more_modifiers
;
2627 if (! strncmp (name
->data
+ i
, "triple-", 7))
2629 modifiers
|= triple_modifier
;
2633 goto no_more_modifiers
;
2637 goto no_more_modifiers
;
2639 #undef SINGLE_LETTER_MOD
2643 /* Should we include the `click' modifier? */
2644 if (! (modifiers
& (down_modifier
| drag_modifier
2645 | double_modifier
| triple_modifier
))
2646 && i
+ 7 == name
->size
2647 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2648 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2649 modifiers
|= click_modifier
;
2658 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2659 prepended to the string BASE[0..BASE_LEN-1].
2660 This doesn't use any caches. */
2662 apply_modifiers_uncached (modifiers
, base
, base_len
)
2667 /* Since BASE could contain nulls, we can't use intern here; we have
2668 to use Fintern, which expects a genuine Lisp_String, and keeps a
2671 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2677 /* Only the event queue may use the `up' modifier; it should always
2678 be turned into a click or drag event before presented to lisp code. */
2679 if (modifiers
& up_modifier
)
2682 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2683 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2684 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2685 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2686 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2687 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2688 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2689 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2690 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2691 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2692 /* The click modifier is denoted by the absence of other modifiers. */
2696 mod_len
= p
- new_mods
;
2700 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2702 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2703 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2705 return Fintern (new_name
, Qnil
);
2710 static char *modifier_names
[] =
2712 "up", "down", "drag", "click", "double", "triple", 0, 0,
2713 0, 0, 0, 0, 0, 0, 0, 0,
2714 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2716 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2718 static Lisp_Object modifier_symbols
;
2720 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2722 lispy_modifier_list (modifiers
)
2725 Lisp_Object modifier_list
;
2728 modifier_list
= Qnil
;
2729 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2730 if (modifiers
& (1<<i
))
2731 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2734 return modifier_list
;
2738 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2739 where UNMODIFIED is the unmodified form of SYMBOL,
2740 MASK is the set of modifiers present in SYMBOL's name.
2741 This is similar to parse_modifiers_uncached, but uses the cache in
2742 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2743 Qevent_symbol_elements property. */
2745 parse_modifiers (symbol
)
2748 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2750 if (CONSP (elements
))
2755 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2756 Lisp_Object unmodified
2757 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2758 XSYMBOL (symbol
)->name
->size
- end
),
2762 if (modifiers
& ~((1<<VALBITS
) - 1))
2764 XFASTINT (mask
) = modifiers
;
2765 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2767 /* Cache the parsing results on SYMBOL. */
2768 Fput (symbol
, Qevent_symbol_element_mask
,
2770 Fput (symbol
, Qevent_symbol_elements
,
2771 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2773 /* Since we know that SYMBOL is modifiers applied to unmodified,
2774 it would be nice to put that in unmodified's cache.
2775 But we can't, since we're not sure that parse_modifiers is
2782 /* Apply the modifiers MODIFIERS to the symbol BASE.
2783 BASE must be unmodified.
2785 This is like apply_modifiers_uncached, but uses BASE's
2786 Qmodifier_cache property, if present. It also builds
2787 Qevent_symbol_elements properties, since it has that info anyway.
2789 apply_modifiers copies the value of BASE's Qevent_kind property to
2790 the modified symbol. */
2792 apply_modifiers (modifiers
, base
)
2796 Lisp_Object cache
, index
, entry
, new_symbol
;
2798 /* Mask out upper bits. We don't know where this value's been. */
2799 modifiers
&= (1<<VALBITS
) - 1;
2801 /* The click modifier never figures into cache indices. */
2802 cache
= Fget (base
, Qmodifier_cache
);
2803 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2804 entry
= Fassq (index
, cache
);
2807 new_symbol
= XCONS (entry
)->cdr
;
2810 /* We have to create the symbol ourselves. */
2811 new_symbol
= apply_modifiers_uncached (modifiers
,
2812 XSYMBOL (base
)->name
->data
,
2813 XSYMBOL (base
)->name
->size
);
2815 /* Add the new symbol to the base's cache. */
2816 entry
= Fcons (index
, new_symbol
);
2817 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2819 /* We have the parsing info now for free, so add it to the caches. */
2820 XFASTINT (index
) = modifiers
;
2821 Fput (new_symbol
, Qevent_symbol_element_mask
,
2822 Fcons (base
, Fcons (index
, Qnil
)));
2823 Fput (new_symbol
, Qevent_symbol_elements
,
2824 Fcons (base
, lispy_modifier_list (modifiers
)));
2827 /* Make sure this symbol is of the same kind as BASE.
2829 You'd think we could just set this once and for all when we
2830 intern the symbol above, but reorder_modifiers may call us when
2831 BASE's property isn't set right; we can't assume that just
2832 because it has a Qmodifier_cache property it must have its
2833 Qevent_kind set right as well. */
2834 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2836 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2839 Fput (new_symbol
, Qevent_kind
, kind
);
2846 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2847 return a symbol with the modifiers placed in the canonical order.
2848 Canonical order is alphabetical, except for down and drag, which
2849 always come last. The 'click' modifier is never written out.
2851 Fdefine_key calls this to make sure that (for example) C-M-foo
2852 and M-C-foo end up being equivalent in the keymap. */
2855 reorder_modifiers (symbol
)
2858 /* It's hopefully okay to write the code this way, since everything
2859 will soon be in caches, and no consing will be done at all. */
2860 Lisp_Object parsed
= parse_modifiers (symbol
);
2862 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2863 XCONS (parsed
)->car
);
2867 /* For handling events, we often want to produce a symbol whose name
2868 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2869 to some base, like the name of a function key or mouse button.
2870 modify_event_symbol produces symbols of this sort.
2872 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2873 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2876 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2877 persist between calls to modify_event_symbol that it can use to
2878 store a cache of the symbols it's generated for this NAME_TABLE
2881 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2883 MODIFIERS is a set of modifier bits (as given in struct input_events)
2884 whose prefixes should be applied to the symbol name.
2886 SYMBOL_KIND is the value to be placed in the event_kind property of
2887 the returned symbol.
2889 The symbols we create are supposed to have an
2890 `event-symbol-elements' property, which lists the modifiers present
2891 in the symbol's name. */
2894 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2895 symbol_table
, table_size
)
2898 Lisp_Object symbol_kind
;
2900 Lisp_Object
*symbol_table
;
2905 /* Is this a request for a valid symbol? */
2906 if (symbol_num
< 0 || symbol_num
>= table_size
)
2909 /* If *symbol_table doesn't seem to be initialized properly, fix that.
2910 *symbol_table should be a lisp vector TABLE_SIZE elements long,
2911 where the Nth element is the symbol for NAME_TABLE[N], or nil if
2912 we've never used that symbol before. */
2913 if (XTYPE (*symbol_table
) != Lisp_Vector
2914 || XVECTOR (*symbol_table
)->size
!= table_size
)
2918 XFASTINT (size
) = table_size
;
2919 *symbol_table
= Fmake_vector (size
, Qnil
);
2922 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
2924 /* Have we already used this symbol before? */
2927 /* No; let's create it. */
2928 if (name_table
[symbol_num
])
2929 *slot
= intern (name_table
[symbol_num
]);
2933 sprintf (buf
, "key-%d", symbol_num
);
2934 *slot
= intern (buf
);
2937 /* Fill in the cache entries for this symbol; this also
2938 builds the Qevent_symbol_elements property, which the user
2940 apply_modifiers (modifiers
& click_modifier
, *slot
);
2941 Fput (*slot
, Qevent_kind
, symbol_kind
);
2944 /* Apply modifiers to that symbol. */
2945 return apply_modifiers (modifiers
, *slot
);
2949 /* Store into *addr a value nonzero if terminal input chars are available.
2950 Serves the purpose of ioctl (0, FIONREAD, addr)
2951 but works even if FIONREAD does not exist.
2952 (In fact, this may actually read some input.) */
2955 get_input_pending (addr
)
2958 /* First of all, have we already counted some input? */
2959 *addr
= !NILP (Vquit_flag
) || readable_events ();
2961 /* If input is being read as it arrives, and we have none, there is none. */
2962 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
2965 /* Try to read some input and see how much we get. */
2967 *addr
= !NILP (Vquit_flag
) || readable_events ();
2970 /* Interface to read_avail_input, blocking SIGIO if necessary. */
2973 gobble_input (expected
)
2978 if (interrupt_input
)
2981 mask
= sigblockx (SIGIO
);
2982 read_avail_input (expected
);
2987 read_avail_input (expected
);
2993 /* Read any terminal input already buffered up by the system
2994 into the kbd_buffer, but do not wait.
2996 EXPECTED should be nonzero if the caller knows there is some input.
2998 Except on VMS, all input is read by this function.
2999 If interrupt_input is nonzero, this function MUST be called
3000 only when SIGIO is blocked.
3002 Returns the number of keyboard chars read, or -1 meaning
3003 this is a bad time to try to read input. */
3006 read_avail_input (expected
)
3009 struct input_event buf
[KBD_BUFFER_SIZE
];
3013 if (read_socket_hook
)
3014 /* No need for FIONREAD or fcntl; just say don't wait. */
3015 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3018 unsigned char cbuf
[KBD_BUFFER_SIZE
];
3021 /* Find out how much input is available. */
3022 if (ioctl (0, FIONREAD
, &nread
) < 0)
3023 /* Formerly simply reported no input, but that sometimes led to
3024 a failure of Emacs to terminate.
3025 SIGHUP seems appropriate if we can't reach the terminal. */
3026 /* ??? Is it really right to send the signal just to this process
3027 rather than to the whole process group?
3028 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3029 kill (getpid (), SIGHUP
);
3032 if (nread
> sizeof cbuf
)
3033 nread
= sizeof cbuf
;
3034 #else /* no FIONREAD */
3036 /* Read some input if available, but don't wait. */
3037 nread
= sizeof cbuf
;
3038 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3044 /* Now read; for one reason or another, this will not block. */
3047 nread
= read (fileno (stdin
), cbuf
, nread
);
3049 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3050 This looks incorrect, but it isn't, because _BSD causes
3051 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3052 and that causes a value other than 0 when there is no input. */
3056 /* Retry the read if it is interrupted. */
3058 || ! (errno
== EAGAIN
|| errno
== EFAULT
3068 fcntl (fileno (stdin
), F_SETFL
, 0);
3070 #endif /* no FIONREAD */
3071 for (i
= 0; i
< nread
; i
++)
3073 buf
[i
].kind
= ascii_keystroke
;
3074 buf
[i
].modifiers
= 0;
3075 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3076 buf
[i
].modifiers
= meta_modifier
;
3080 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3082 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3084 buf
[i
].frame_or_window
= Qnil
;
3089 /* Scan the chars for C-g and store them in kbd_buffer. */
3090 for (i
= 0; i
< nread
; i
++)
3092 kbd_buffer_store_event (&buf
[i
]);
3093 /* Don't look at input that follows a C-g too closely.
3094 This reduces lossage due to autorepeat on C-g. */
3095 if (buf
[i
].kind
== ascii_keystroke
3096 && XINT(buf
[i
].code
) == quit_char
)
3102 #endif /* not VMS */
3104 #ifdef SIGIO /* for entire page */
3105 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3108 input_available_signal (signo
)
3111 /* Must preserve main program's value of errno. */
3112 int old_errno
= errno
;
3114 extern int select_alarmed
;
3118 /* USG systems forget handlers when they are used;
3119 must reestablish each time */
3120 signal (signo
, input_available_signal
);
3127 if (input_available_clear_time
)
3128 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3133 nread
= read_avail_input (1);
3134 /* -1 means it's not ok to read the input now.
3135 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3136 0 means there was no keyboard input available. */
3141 select_alarmed
= 1; /* Force the select emulator back to life */
3152 /* Send ourselves a SIGIO.
3154 This function exists so that the UNBLOCK_INPUT macro in
3155 blockinput.h can have some way to take care of input we put off
3156 dealing with, without assuming that every file which uses
3157 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3159 reinvoke_input_signal ()
3168 /* Return the prompt-string of a sparse keymap.
3169 This is the first element which is a string.
3170 Return nil if there is none. */
3178 register Lisp_Object tem
;
3180 if (XTYPE (tem
) == Lisp_String
)
3187 static Lisp_Object
menu_bar_item ();
3188 static Lisp_Object
menu_bar_one_keymap ();
3190 /* Return a list of menu items for a menu bar, appropriate
3191 to the current buffer.
3192 The elements have the form (KEY STRING . nil). */
3197 /* The number of keymaps we're scanning right now, and the number of
3198 keymaps we have allocated space for. */
3201 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3202 in the current keymaps, or nil where it is not a prefix. */
3205 Lisp_Object def
, tem
, tail
;
3212 /* In order to build the menus, we need to call the keymap
3213 accessors. They all call QUIT. But this function is called
3214 during redisplay, during which a quit is fatal. So inhibit
3215 quitting while building the menus.
3216 We do this instead of specbind because (1) errors will clear it anyway
3217 and (2) this avoids risk of specpdl overflow. */
3218 oquit
= Vinhibit_quit
;
3221 /* Build our list of keymaps.
3222 If we recognize a function key and replace its escape sequence in
3223 keybuf with its symbol, or if the sequence starts with a mouse
3224 click and we need to switch buffers, we jump back here to rebuild
3225 the initial keymaps from the current buffer. */
3229 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3230 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3231 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3232 #ifdef USE_TEXT_PROPERTIES
3233 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3235 maps
[nmaps
-2] = current_buffer
->keymap
;
3237 maps
[nmaps
-1] = current_global_map
;
3240 /* Look up in each map the dummy prefix key `menu-bar'. */
3244 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3246 if (! NILP (maps
[mapno
]))
3247 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3251 tem
= Fkeymapp (def
);
3253 result
= menu_bar_one_keymap (def
, result
);
3256 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3260 elt
= Fassq (XCONS (tail
)->car
, result
);
3262 result
= Fcons (elt
, Fdelq (elt
, result
));
3265 result
= Fnreverse (result
);
3266 Vinhibit_quit
= oquit
;
3270 /* Scan one map KEYMAP, accumulating any menu items it defines
3271 that have not yet been seen in RESULT. Return the updated RESULT. */
3274 menu_bar_one_keymap (keymap
, result
)
3275 Lisp_Object keymap
, result
;
3277 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3279 /* Loop over all keymap entries that have menu strings. */
3280 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3282 item
= XCONS (tail
)->car
;
3283 if (XTYPE (item
) == Lisp_Cons
)
3285 key
= XCONS (item
)->car
;
3286 binding
= XCONS (item
)->cdr
;
3287 if (XTYPE (binding
) == Lisp_Cons
)
3289 item_string
= XCONS (binding
)->car
;
3290 if (XTYPE (item_string
) == Lisp_String
)
3291 result
= menu_bar_item (key
, item_string
,
3292 Fcdr (binding
), result
);
3294 else if (EQ (binding
, Qundefined
))
3295 result
= menu_bar_item (key
, item_string
,
3298 else if (XTYPE (item
) == Lisp_Vector
)
3300 /* Loop over the char values represented in the vector. */
3301 int len
= XVECTOR (item
)->size
;
3303 for (c
= 0; c
< len
; c
++)
3305 Lisp_Object character
;
3306 XFASTINT (character
) = c
;
3307 binding
= XVECTOR (item
)->contents
[c
];
3308 if (XTYPE (binding
) == Lisp_Cons
)
3310 item_string
= XCONS (binding
)->car
;
3311 if (XTYPE (item_string
) == Lisp_String
)
3312 result
= menu_bar_item (key
, item_string
,
3313 Fcdr (binding
), result
);
3315 else if (EQ (binding
, Qundefined
))
3316 result
= menu_bar_item (key
, item_string
,
3326 menu_bar_item (key
, item_string
, def
, result
)
3327 Lisp_Object key
, item_string
, def
, result
;
3330 Lisp_Object enabled
;
3332 if (EQ (def
, Qundefined
))
3334 /* If a map has an explicit nil as definition,
3335 discard any previously made menu bar item. */
3336 tem
= Fassq (key
, result
);
3337 return Fdelq (tem
, result
);
3340 /* See if this entry is enabled. */
3343 if (XTYPE (def
) == Lisp_Symbol
)
3345 /* No property, or nil, means enable.
3346 Otherwise, enable if value is not nil. */
3347 tem
= Fget (def
, Qmenu_enable
);
3349 enabled
= Feval (tem
);
3352 /* Add an entry for this key and string
3353 if there is none yet. */
3354 tem
= Fassq (key
, result
);
3355 if (!NILP (enabled
) && NILP (tem
))
3356 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3361 static int echo_flag
;
3362 static int echo_now
;
3364 /* Read a character using menus based on maps in the array MAPS.
3365 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3366 Return t if we displayed a menu but the user rejected it.
3368 PREV_EVENT is the previous input event, or nil if we are reading
3369 the first event of a key sequence.
3371 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3372 if we used a mouse menu to read the input, or zero otherwise. If
3373 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3375 The prompting is done based on the prompt-string of the map
3376 and the strings associated with various map elements. */
3379 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3382 Lisp_Object prev_event
;
3383 int *used_mouse_menu
;
3386 register Lisp_Object name
;
3388 int width
= FRAME_WIDTH (selected_frame
) - 4;
3389 char *menu
= (char *) alloca (width
+ 4);
3391 Lisp_Object rest
, vector
;
3393 if (used_mouse_menu
)
3394 *used_mouse_menu
= 0;
3396 /* Use local over global Menu maps */
3398 if (! menu_prompting
)
3401 /* Get the menu name from the first map that has one (a prompt string). */
3402 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3404 name
= map_prompt (maps
[mapno
]);
3409 /* If we don't have any menus, just read a character normally. */
3413 #ifdef HAVE_X_WINDOWS
3415 /* If we got to this point via a mouse click,
3416 use a real menu for mouse selection. */
3417 if (EVENT_HAS_PARAMETERS (prev_event
))
3419 /* Display the menu and get the selection. */
3420 Lisp_Object
*realmaps
3421 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3425 /* Use the maps that are not nil. */
3426 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3427 if (!NILP (maps
[mapno
]))
3428 realmaps
[nmaps1
++] = maps
[mapno
];
3430 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3433 /* If we got more than one event, put all but the first
3434 onto this list to be read later.
3435 Return just the first event now. */
3436 unread_command_events
3437 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3438 value
= XCONS (value
)->car
;
3442 if (used_mouse_menu
)
3443 *used_mouse_menu
= 1;
3446 #endif /* HAVE_X_MENU */
3447 #endif /* HAVE_X_WINDOWS */
3449 /* Prompt string always starts with map's prompt, and a space. */
3450 strcpy (menu
, XSTRING (name
)->data
);
3451 nlength
= XSTRING (name
)->size
;
3452 menu
[nlength
++] = ':';
3453 menu
[nlength
++] = ' ';
3456 /* Start prompting at start of first map. */
3460 /* Present the documented bindings, a line at a time. */
3468 /* Loop over elements of map. */
3473 /* If reached end of map, start at beginning of next map. */
3477 /* At end of last map, wrap around to first map if just starting,
3478 or end this line if already have something on it. */
3489 /* Look at the next element of the map. */
3491 elt
= XVECTOR (vector
)->contents
[idx
];
3493 elt
= Fcar_safe (rest
);
3495 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3497 /* If we found a dense table in the keymap,
3498 advanced past it, but start scanning its contents. */
3499 rest
= Fcdr_safe (rest
);
3505 /* An ordinary element. */
3506 s
= Fcar_safe (Fcdr_safe (elt
));
3507 if (XTYPE (s
) != Lisp_String
)
3508 /* Ignore the element if it has no prompt string. */
3510 /* If we have room for the prompt string, add it to this line.
3511 If this is the first on the line, always add it. */
3512 else if (XSTRING (s
)->size
+ i
< width
3517 /* Punctuate between strings. */
3520 strcpy (menu
+ i
, ", ");
3525 /* Add as much of string as fits. */
3526 thiswidth
= XSTRING (s
)->size
;
3527 if (thiswidth
+ i
> width
)
3528 thiswidth
= width
- i
;
3529 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3534 /* If this element does not fit, end the line now,
3535 and save the element for the next line. */
3536 strcpy (menu
+ i
, "...");
3540 /* Move past this element. */
3541 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3542 /* Handle reaching end of dense table. */
3547 rest
= Fcdr_safe (rest
);
3551 /* Prompt with that and read response. */
3553 obj
= read_char (1, 0, 0, Qnil
, 0);
3555 if (XTYPE (obj
) != Lisp_Int
)
3560 if (! EQ (obj
, menu_prompt_more_char
)
3561 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3562 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3567 /* Reading key sequences. */
3569 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3570 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3571 keymap, or nil otherwise. Return the index of the first keymap in
3572 which KEY has any binding, or NMAPS if no map has a binding.
3574 If KEY is a meta ASCII character, treat it like meta-prefix-char
3575 followed by the corresponding non-meta character. Keymaps in
3576 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3579 When KEY is not defined in any of the keymaps, if it is an upper
3580 case letter and there are bindings for the corresponding lower-case
3581 letter, return the bindings for the lower-case letter.
3583 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3586 NEXT may == CURRENT. */
3589 follow_key (key
, nmaps
, current
, defs
, next
)
3591 Lisp_Object
*current
, *defs
, *next
;
3594 int i
, first_binding
;
3596 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3597 followed by the corresponding non-meta character. */
3598 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3600 for (i
= 0; i
< nmaps
; i
++)
3601 if (! NILP (current
[i
]))
3604 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3606 /* Note that since we pass the resulting bindings through
3607 get_keymap_1, non-prefix bindings for meta-prefix-char
3609 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3615 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3618 first_binding
= nmaps
;
3619 for (i
= nmaps
- 1; i
>= 0; i
--)
3621 if (! NILP (current
[i
]))
3623 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3624 if (! NILP (defs
[i
]))
3631 /* When KEY is not defined in any of the keymaps, if it is an upper
3632 case letter and there are bindings for the corresponding
3633 lower-case letter, return the bindings for the lower-case letter. */
3634 if (first_binding
== nmaps
3635 && XTYPE (key
) == Lisp_Int
3636 && ((((XINT (key
) & 0x3ffff)
3637 < XSTRING (current_buffer
->downcase_table
)->size
)
3638 && UPPERCASEP (XINT (key
) & 0x3ffff))
3639 || (XINT (key
) & shift_modifier
)))
3641 if (XINT (key
) & shift_modifier
)
3642 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3644 XSETINT (key
, DOWNCASE (XINT (key
)));
3646 first_binding
= nmaps
;
3647 for (i
= nmaps
- 1; i
>= 0; i
--)
3649 if (! NILP (current
[i
]))
3651 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3652 if (! NILP (defs
[i
]))
3660 /* Given the set of bindings we've found, produce the next set of maps. */
3661 if (first_binding
< nmaps
)
3662 for (i
= 0; i
< nmaps
; i
++)
3663 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3665 return first_binding
;
3668 /* Read a sequence of keys that ends with a non prefix character,
3669 storing it in KEYBUF, a buffer of size BUFSIZE.
3671 Return the length of the key sequence stored.
3672 Return -1 if the user rejected a command menu.
3674 Echo starting immediately unless `prompt' is 0.
3676 Where a key sequence ends depends on the currently active keymaps.
3677 These include any minor mode keymaps active in the current buffer,
3678 the current buffer's local map, and the global map.
3680 If a key sequence has no other bindings, we check Vfunction_key_map
3681 to see if some trailing subsequence might be the beginning of a
3682 function key's sequence. If so, we try to read the whole function
3683 key, and substitute its symbolic name into the key sequence.
3685 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3686 `double-' events into similar click events, if that would make them
3687 bound. We try to turn `triple-' events first into `double-' events,
3690 If we get a mouse click in a mode line, vertical divider, or other
3691 non-text area, we treat the click as if it were prefixed by the
3692 symbol denoting that area - `mode-line', `vertical-line', or
3695 If the sequence starts with a mouse click, we read the key sequence
3696 with respect to the buffer clicked on, not the current buffer.
3698 If the user switches frames in the midst of a key sequence, we put
3699 off the switch-frame event until later; the next call to
3700 read_char will return it. */
3703 read_key_sequence (keybuf
, bufsize
, prompt
)
3704 Lisp_Object
*keybuf
;
3708 int count
= specpdl_ptr
- specpdl
;
3710 /* How many keys there are in the current key sequence. */
3713 /* The length of the echo buffer when we started reading, and
3714 the length of this_command_keys when we started reading. */
3718 /* The number of keymaps we're scanning right now, and the number of
3719 keymaps we have allocated space for. */
3721 int nmaps_allocated
= 0;
3723 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3724 the current keymaps. */
3727 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3728 in the current keymaps, or nil where it is not a prefix. */
3729 Lisp_Object
*submaps
;
3731 /* The index in defs[] of the first keymap that has a binding for
3732 this key sequence. In other words, the lowest i such that
3733 defs[i] is non-nil. */
3736 /* If t < mock_input, then KEYBUF[t] should be read as the next
3739 We use this to recover after recognizing a function key. Once we
3740 realize that a suffix of the current key sequence is actually a
3741 function key's escape sequence, we replace the suffix with the
3742 function key's binding from Vfunction_key_map. Now keybuf
3743 contains a new and different key sequence, so the echo area,
3744 this_command_keys, and the submaps and defs arrays are wrong. In
3745 this situation, we set mock_input to t, set t to 0, and jump to
3746 restart_sequence; the loop will read keys from keybuf up until
3747 mock_input, thus rebuilding the state; and then it will resume
3748 reading characters from the keyboard. */
3751 /* If the sequence is unbound in submaps[], then
3752 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3753 and fkey_map is its binding.
3755 These might be > t, indicating that all function key scanning
3756 should hold off until t reaches them. We do this when we've just
3757 recognized a function key, to avoid searching for the function
3758 key's again in Vfunction_key_map. */
3759 int fkey_start
= 0, fkey_end
= 0;
3760 Lisp_Object fkey_map
;
3762 /* Likewise, for key_translation_map. */
3763 int keytran_start
= 0, keytran_end
= 0;
3764 Lisp_Object keytran_map
;
3766 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3767 we put it off for later. While we're reading, we keep the event here. */
3768 Lisp_Object delayed_switch_frame
;
3770 Lisp_Object first_event
;
3774 last_nonmenu_event
= Qnil
;
3776 delayed_switch_frame
= Qnil
;
3777 fkey_map
= Vfunction_key_map
;
3778 keytran_map
= Vkey_translation_map
;
3780 /* If there is no function-key-map, turn off function key scanning. */
3781 if (NILP (Fkeymapp (Vfunction_key_map
)))
3782 fkey_start
= fkey_end
= bufsize
+ 1;
3784 /* If there is no key-translation-map, turn off scanning. */
3785 if (NILP (Fkeymapp (Vkey_translation_map
)))
3786 keytran_start
= keytran_end
= bufsize
+ 1;
3791 echo_prompt (prompt
);
3792 else if (cursor_in_echo_area
)
3793 /* This doesn't put in a dash if the echo buffer is empty, so
3794 you don't always see a dash hanging out in the minibuffer. */
3798 /* Record the initial state of the echo area and this_command_keys;
3799 we will need to restore them if we replay a key sequence. */
3801 echo_start
= echo_length ();
3802 keys_start
= this_command_key_count
;
3804 #if 0 /* This doesn't quite work, because some of the things
3805 that read_char does cannot safely be bypassed.
3806 It seems too risky to try to make this work right. */
3807 /* Read the first char of the sequence specially, before setting
3808 up any keymaps, in case a filter runs and switches buffers on us. */
3809 first_event
= read_char (!prompt
, 0, submaps
, last_nonmenu_event
,
3813 /* We jump here when the key sequence has been thoroughly changed, and
3814 we need to rescan it starting from the beginning. When we jump here,
3815 keybuf[0..mock_input] holds the sequence we should reread. */
3818 /* Build our list of keymaps.
3819 If we recognize a function key and replace its escape sequence in
3820 keybuf with its symbol, or if the sequence starts with a mouse
3821 click and we need to switch buffers, we jump back here to rebuild
3822 the initial keymaps from the current buffer. */
3826 nmaps
= current_minor_maps (0, &maps
) + 2;
3827 if (nmaps
> nmaps_allocated
)
3829 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3830 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3831 nmaps_allocated
= nmaps
;
3833 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3834 #ifdef USE_TEXT_PROPERTIES
3835 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3837 submaps
[nmaps
-2] = current_buffer
->keymap
;
3839 submaps
[nmaps
-1] = current_global_map
;
3842 /* Find an accurate initial value for first_binding. */
3843 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3844 if (! NILP (submaps
[first_binding
]))
3847 /* We jump here when a function key substitution has forced us to
3848 reprocess the current key sequence. keybuf[0..mock_input] is the
3849 sequence we want to reread. */
3852 /* These are no-ops the first time through, but if we restart, they
3853 revert the echo area and this_command_keys to their original state. */
3854 this_command_key_count
= keys_start
;
3856 echo_truncate (echo_start
);
3858 /* If the best binding for the current key sequence is a keymap, or
3859 we may be looking at a function key's escape sequence, keep on
3861 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3862 || (first_binding
>= nmaps
3864 /* mock input is never part of a function key's sequence. */
3865 && mock_input
<= fkey_start
)
3866 || (first_binding
>= nmaps
3867 && keytran_start
< t
3868 /* mock input is never part of a function key's sequence. */
3869 && mock_input
<= keytran_start
))
3872 int used_mouse_menu
= 0;
3874 /* Where the last real key started. If we need to throw away a
3875 key that has expanded into more than one element of keybuf
3876 (say, a mouse click on the mode line which is being treated
3877 as [mode-line (mouse-...)], then we backtrack to this point
3879 int last_real_key_start
;
3881 /* These variables are analogous to echo_start and keys_start;
3882 while those allow us to restart the entire key sequence,
3883 echo_local_start and keys_local_start allow us to throw away
3885 int echo_local_start
, keys_local_start
, local_first_binding
;
3888 error ("key sequence too long");
3891 echo_local_start
= echo_length ();
3892 keys_local_start
= this_command_key_count
;
3893 local_first_binding
= first_binding
;
3896 /* These are no-ops, unless we throw away a keystroke below and
3897 jumped back up to replay_key; in that case, these restore the
3898 variables to their original state, allowing us to replay the
3901 echo_truncate (echo_local_start
);
3902 this_command_key_count
= keys_local_start
;
3903 first_binding
= local_first_binding
;
3905 /* By default, assume each event is "real". */
3906 last_real_key_start
= t
;
3908 /* Does mock_input indicate that we are re-reading a key sequence? */
3912 add_command_key (key
);
3916 /* If not, we should actually read a character. */
3919 struct buffer
*buf
= current_buffer
;
3921 key
= read_char (!prompt
, nmaps
, submaps
, last_nonmenu_event
,
3924 /* read_char returns t when it shows a menu and the user rejects it.
3929 /* read_char returns -1 at the end of a macro.
3930 Emacs 18 handles this by returning immediately with a
3931 zero, so that's what we'll do. */
3932 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
3941 /* Clicks in non-text areas get prefixed by the symbol
3942 in their CHAR-ADDRESS field. For example, a click on
3943 the mode line is prefixed by the symbol `mode-line'.
3945 Furthermore, key sequences beginning with mouse clicks
3946 are read using the keymaps of the buffer clicked on, not
3947 the current buffer. So we may have to switch the buffer
3950 When we turn one event into two events, we must make sure
3951 that neither of the two looks like the original--so that,
3952 if we replay the events, they won't be expanded again.
3953 If not for this, such reexpansion could happen either here
3954 or when user programs play with this-command-keys. */
3955 if (EVENT_HAS_PARAMETERS (key
))
3957 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
3959 if (EQ (kind
, Qmouse_click
))
3961 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
3962 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
3964 if (XTYPE (posn
) == Lisp_Cons
)
3966 /* We're looking at the second event of a
3967 sequence which we expanded before. Set
3968 last_real_key_start appropriately. */
3970 last_real_key_start
= t
- 1;
3973 /* Key sequences beginning with mouse clicks are
3974 read using the keymaps in the buffer clicked on,
3975 not the current buffer. If we're at the
3976 beginning of a key sequence, switch buffers. */
3977 if (last_real_key_start
== 0
3978 && XTYPE (window
) == Lisp_Window
3979 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
3980 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
3985 /* Arrange to go back to the original buffer once we're
3986 done reading the key sequence. Note that we can't
3987 use save_excursion_{save,restore} here, because they
3988 save point as well as the current buffer; we don't
3989 want to save point, because redisplay may change it,
3990 to accommodate a Fset_window_start or something. We
3991 don't want to do this at the top of the function,
3992 because we may get input from a subprocess which
3993 wants to change the selected window and stuff (say,
3995 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3997 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
3998 goto replay_sequence
;
4000 else if (XTYPE (posn
) == Lisp_Symbol
)
4002 /* Expand mode-line and scroll-bar events into two events:
4003 use posn as a fake prefix key. */
4005 if (t
+ 1 >= bufsize
)
4006 error ("key sequence too long");
4011 /* Zap the position in key, so we know that we've
4012 expanded it, and don't try to do so again. */
4013 POSN_BUFFER_POSN (EVENT_START (key
))
4014 = Fcons (posn
, Qnil
);
4018 else if (EQ (kind
, Qswitch_frame
))
4020 /* If we're at the beginning of a key sequence, go
4021 ahead and return this event. If we're in the
4022 midst of a key sequence, delay it until the end. */
4025 delayed_switch_frame
= key
;
4031 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4033 /* Handle menu-bar events:
4034 insert the dummy prefix event `menu-bar'. */
4035 if (EQ (posn
, Qmenu_bar
))
4037 if (t
+ 1 >= bufsize
)
4038 error ("key sequence too long");
4039 /* Run the Lucid hook. */
4040 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4041 /* If it has changed current-menubar from previous value,
4042 really recompute the menubar from the value. */
4043 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4044 call0 (Qrecompute_lucid_menubar
);
4048 /* Zap the position in key, so we know that we've
4049 expanded it, and don't try to do so again. */
4050 POSN_BUFFER_POSN (EVENT_START (key
))
4051 = Fcons (posn
, Qnil
);
4054 goto replay_sequence
;
4056 else if (XTYPE (posn
) == Lisp_Cons
)
4058 /* We're looking at the second event of a
4059 sequence which we expanded before. Set
4060 last_real_key_start appropriately. */
4061 if (last_real_key_start
== t
&& t
> 0)
4062 last_real_key_start
= t
- 1;
4067 /* We have finally decided that KEY is something we might want
4069 first_binding
= (follow_key (key
,
4070 nmaps
- first_binding
,
4071 submaps
+ first_binding
,
4072 defs
+ first_binding
,
4073 submaps
+ first_binding
)
4076 /* If KEY wasn't bound, we'll try some fallbacks. */
4077 if (first_binding
>= nmaps
)
4079 Lisp_Object head
= EVENT_HEAD (key
);
4081 if (EQ (head
, Vhelp_char
))
4083 read_key_sequence_cmd
= Vprefix_help_command
;
4085 last_nonmenu_event
= key
;
4089 if (XTYPE (head
) == Lisp_Symbol
)
4091 Lisp_Object breakdown
= parse_modifiers (head
);
4092 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4094 /* Attempt to reduce an unbound mouse event to a simpler
4095 event that is bound:
4096 Drags reduce to clicks.
4097 Double-clicks reduce to clicks.
4098 Triple-clicks reduce to double-clicks, then to clicks.
4099 Down-clicks are eliminated.
4100 Double-downs reduce to downs, then are eliminated.
4101 Triple-downs reduce to double-downs, then to downs,
4102 then are eliminated. */
4103 if (modifiers
& (down_modifier
| drag_modifier
4104 | double_modifier
| triple_modifier
))
4106 while (modifiers
& (down_modifier
| drag_modifier
4107 | double_modifier
| triple_modifier
))
4109 Lisp_Object new_head
, new_click
;
4110 if (modifiers
& triple_modifier
)
4111 modifiers
^= (double_modifier
| triple_modifier
);
4112 else if (modifiers
& (drag_modifier
| double_modifier
))
4113 modifiers
&= ~(drag_modifier
| double_modifier
);
4116 /* Dispose of this `down' event by simply jumping
4117 back to replay_key, to get another event.
4119 Note that if this event came from mock input,
4120 then just jumping back to replay_key will just
4121 hand it to us again. So we have to wipe out any
4124 We could delete keybuf[t] and shift everything
4125 after that to the left by one spot, but we'd also
4126 have to fix up any variable that points into
4127 keybuf, and shifting isn't really necessary
4130 Adding prefixes for non-textual mouse clicks
4131 creates two characters of mock input, and both
4132 must be thrown away. If we're only looking at
4133 the prefix now, we can just jump back to
4134 replay_key. On the other hand, if we've already
4135 processed the prefix, and now the actual click
4136 itself is giving us trouble, then we've lost the
4137 state of the keymaps we want to backtrack to, and
4138 we need to replay the whole sequence to rebuild
4141 Beyond that, only function key expansion could
4142 create more than two keys, but that should never
4143 generate mouse events, so it's okay to zero
4144 mock_input in that case too.
4146 Isn't this just the most wonderful code ever? */
4147 if (t
== last_real_key_start
)
4154 mock_input
= last_real_key_start
;
4155 goto replay_sequence
;
4160 apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4162 Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4164 /* Look for a binding for this new key. follow_key
4165 promises that it didn't munge submaps the
4166 last time we called it, since key was unbound. */
4168 (follow_key (new_click
,
4169 nmaps
- local_first_binding
,
4170 submaps
+ local_first_binding
,
4171 defs
+ local_first_binding
,
4172 submaps
+ local_first_binding
)
4173 + local_first_binding
);
4175 /* If that click is bound, go for it. */
4176 if (first_binding
< nmaps
)
4181 /* Otherwise, we'll leave key set to the drag event. */
4188 /* Normally, last_nonmenu_event gets the previous key we read.
4189 But when a mouse popup menu is being used,
4190 we don't update last_nonmenu_event; it continues to hold the mouse
4191 event that preceded the first level of menu. */
4192 if (!used_mouse_menu
)
4193 last_nonmenu_event
= key
;
4195 /* If the sequence is unbound, see if we can hang a function key
4196 off the end of it. We only want to scan real keyboard input
4197 for function key sequences, so if mock_input says that we're
4198 re-reading old events, don't examine it. */
4199 if (first_binding
>= nmaps
4202 Lisp_Object fkey_next
;
4204 /* Scan from fkey_end until we find a bound suffix. */
4205 while (fkey_end
< t
)
4209 key
= keybuf
[fkey_end
++];
4210 /* Look up meta-characters by prefixing them
4211 with meta_prefix_char. I hate this. */
4212 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4217 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4219 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4222 fkey_next
= fkey_map
;
4225 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4227 /* If keybuf[fkey_start..fkey_end] is bound in the
4228 function key map and it's a suffix of the current
4229 sequence (i.e. fkey_end == t), replace it with
4230 the binding and restart with fkey_start at the end. */
4231 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4234 int len
= XFASTINT (Flength (fkey_next
));
4236 t
= fkey_start
+ len
;
4238 error ("key sequence too long");
4240 if (VECTORP (fkey_next
))
4241 bcopy (XVECTOR (fkey_next
)->contents
,
4242 keybuf
+ fkey_start
,
4243 (t
- fkey_start
) * sizeof (keybuf
[0]));
4244 else if (STRINGP (fkey_next
))
4248 for (i
= 0; i
< len
; i
++)
4249 XFASTINT (keybuf
[fkey_start
+ i
]) =
4250 XSTRING (fkey_next
)->data
[i
];
4254 fkey_start
= fkey_end
= t
;
4255 fkey_map
= Vfunction_key_map
;
4257 goto replay_sequence
;
4260 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4262 /* If we no longer have a bound suffix, try a new positions for
4264 if (NILP (fkey_map
))
4266 fkey_end
= ++fkey_start
;
4267 fkey_map
= Vfunction_key_map
;
4272 /* Look for this sequence in key-translation-map. */
4274 Lisp_Object keytran_next
;
4276 /* Scan from keytran_end until we find a bound suffix. */
4277 while (keytran_end
< t
)
4281 key
= keybuf
[keytran_end
++];
4282 /* Look up meta-characters by prefixing them
4283 with meta_prefix_char. I hate this. */
4284 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4289 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4291 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4294 keytran_next
= keytran_map
;
4297 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4299 /* If keybuf[keytran_start..keytran_end] is bound in the
4300 function key map and it's a suffix of the current
4301 sequence (i.e. keytran_end == t), replace it with
4302 the binding and restart with keytran_start at the end. */
4303 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4304 && keytran_end
== t
)
4306 int len
= XFASTINT (Flength (keytran_next
));
4308 t
= keytran_start
+ len
;
4310 error ("key sequence too long");
4312 if (VECTORP (keytran_next
))
4313 bcopy (XVECTOR (keytran_next
)->contents
,
4314 keybuf
+ keytran_start
,
4315 (t
- keytran_start
) * sizeof (keybuf
[0]));
4316 else if (STRINGP (keytran_next
))
4320 for (i
= 0; i
< len
; i
++)
4321 XFASTINT (keybuf
[keytran_start
+ i
])
4322 = XSTRING (keytran_next
)->data
[i
];
4326 keytran_start
= keytran_end
= t
;
4327 keytran_map
= Vkey_translation_map
;
4329 goto replay_sequence
;
4332 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4334 /* If we no longer have a bound suffix, try a new positions for
4336 if (NILP (keytran_map
))
4338 keytran_end
= ++keytran_start
;
4339 keytran_map
= Vkey_translation_map
;
4345 read_key_sequence_cmd
= (first_binding
< nmaps
4346 ? defs
[first_binding
]
4350 unread_switch_frame
= delayed_switch_frame
;
4351 unbind_to (count
, Qnil
);
4353 /* Occasionally we fabricate events, perhaps by expanding something
4354 according to function-key-map, or by adding a prefix symbol to a
4355 mouse click in the scroll bar or modeline. In this cases, return
4356 the entire generated key sequence, even if we hit an unbound
4357 prefix or a definition before the end. This means that you will
4358 be able to push back the event properly, and also means that
4359 read-key-sequence will always return a logical unit.
4362 for (; t
< mock_input
; t
++)
4364 echo_char (keybuf
[t
]);
4365 add_command_key (keybuf
[t
]);
4371 #if 0 /* This doc string is too long for some compilers.
4372 This commented-out definition serves for DOC. */
4373 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4374 "Read a sequence of keystrokes and return as a string or vector.\n\
4375 The sequence is sufficient to specify a non-prefix command in the\n\
4376 current local and global maps.\n\
4378 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4379 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4380 as a continuation of the previous key.\n\
4382 A C-g typed while in this function is treated like any other character,\n\
4383 and `quit-flag' is not set.\n\
4385 If the key sequence starts with a mouse click, then the sequence is read\n\
4386 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4387 of the selected window as normal.\n\
4389 `read-key-sequence' drops unbound button-down events, since you normally\n\
4390 only care about the click or drag events which follow them. If a drag\n\
4391 or multi-click event is unbound, but the corresponding click event would\n\
4392 be bound, `read-key-sequence' turns the event into a click event at the\n\
4393 drag's starting position. This means that you don't have to distinguish\n\
4394 between click and drag, double, or triple events unless you want to.\n\
4396 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4397 lines separating windows, and scroll bars with imaginary keys\n\
4398 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4400 If the user switches frames in the middle of a key sequence, the\n\
4401 frame-switch event is put off until after the current key sequence.\n\
4403 `read-key-sequence' checks `function-key-map' for function key\n\
4404 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4405 `function-key-map' for more details.")
4406 (prompt
, continue_echo
)
4409 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4411 (prompt
, continue_echo
)
4412 Lisp_Object prompt
, continue_echo
;
4414 Lisp_Object keybuf
[30];
4416 struct gcpro gcpro1
, gcpro2
;
4419 CHECK_STRING (prompt
, 0);
4422 bzero (keybuf
, sizeof keybuf
);
4424 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4426 if (NILP (continue_echo
))
4427 this_command_key_count
= 0;
4429 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
4430 NILP (prompt
) ? 0 : XSTRING (prompt
)->data
);
4438 return make_event_array (i
, keybuf
);
4441 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4442 "Execute CMD as an editor command.\n\
4443 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4444 Optional second arg RECORD-FLAG non-nil\n\
4445 means unconditionally put this command in `command-history'.\n\
4446 Otherwise, that is done only if an arg is read using the minibuffer.")
4448 Lisp_Object cmd
, record
;
4450 register Lisp_Object final
;
4451 register Lisp_Object tem
;
4452 Lisp_Object prefixarg
;
4453 struct backtrace backtrace
;
4454 extern int debug_on_next_call
;
4456 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4457 Vcurrent_prefix_arg
= prefixarg
;
4458 debug_on_next_call
= 0;
4460 if (XTYPE (cmd
) == Lisp_Symbol
)
4462 tem
= Fget (cmd
, Qdisabled
);
4464 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4469 final
= Findirect_function (cmd
);
4471 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4472 do_autoload (final
, cmd
);
4477 if (XTYPE (final
) == Lisp_String
4478 || XTYPE (final
) == Lisp_Vector
)
4480 /* If requested, place the macro in the command history. For
4481 other sorts of commands, call-interactively takes care of
4485 = Fcons (Fcons (Qexecute_kbd_macro
,
4486 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4489 return Fexecute_kbd_macro (final
, prefixarg
);
4491 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4492 || XTYPE (final
) == Lisp_Compiled
)
4494 backtrace
.next
= backtrace_list
;
4495 backtrace_list
= &backtrace
;
4496 backtrace
.function
= &Qcall_interactively
;
4497 backtrace
.args
= &cmd
;
4498 backtrace
.nargs
= 1;
4499 backtrace
.evalargs
= 0;
4501 tem
= Fcall_interactively (cmd
, record
);
4503 backtrace_list
= backtrace
.next
;
4509 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4511 "Read function name, then read its arguments and call it.")
4513 Lisp_Object prefixarg
;
4515 Lisp_Object function
;
4517 Lisp_Object saved_keys
;
4518 struct gcpro gcpro1
;
4520 saved_keys
= Fthis_command_keys ();
4522 GCPRO1 (saved_keys
);
4524 if (EQ (prefixarg
, Qminus
))
4526 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4527 strcpy (buf
, "C-u ");
4528 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4529 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4530 else if (XTYPE (prefixarg
) == Lisp_Int
)
4531 sprintf (buf
, "%d ", XINT (prefixarg
));
4533 /* This isn't strictly correct if execute-extended-command
4534 is bound to anything else. Perhaps it should use
4535 this_command_keys? */
4536 strcat (buf
, "M-x ");
4538 /* Prompt with buf, and then read a string, completing from and
4539 restricting to the set of all defined commands. Don't provide
4540 any initial input. The last Qnil says not to perform a
4541 peculiar hack on the initial input. */
4542 function
= Fcompleting_read (build_string (buf
),
4543 Vobarray
, Qcommandp
,
4546 /* Set this_command_keys to the concatenation of saved_keys and
4547 function, followed by a RET. */
4549 struct Lisp_String
*str
;
4553 this_command_key_count
= 0;
4555 str
= XSTRING (saved_keys
);
4556 for (i
= 0; i
< str
->size
; i
++)
4558 XFASTINT (tem
) = str
->data
[i
];
4559 add_command_key (tem
);
4562 str
= XSTRING (function
);
4563 for (i
= 0; i
< str
->size
; i
++)
4565 XFASTINT (tem
) = str
->data
[i
];
4566 add_command_key (tem
);
4569 XFASTINT (tem
) = '\015';
4570 add_command_key (tem
);
4575 function
= Fintern (function
, Qnil
);
4576 Vprefix_arg
= prefixarg
;
4577 this_command
= function
;
4579 return Fcommand_execute (function
, Qt
);
4583 detect_input_pending ()
4586 get_input_pending (&input_pending
);
4588 return input_pending
;
4591 /* This is called in some cases before a possible quit.
4592 It cases the next call to detect_input_pending to recompute input_pending.
4593 So calling this function unnecessarily can't do any harm. */
4594 clear_input_pending ()
4599 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4600 "T if command input is currently available with no waiting.\n\
4601 Actually, the value is nil only if we can be sure that no input is available.")
4604 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4607 return detect_input_pending () ? Qt
: Qnil
;
4610 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4611 "Return vector of last 100 events, not counting those from keyboard macros.")
4614 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4617 if (total_keys
< NUM_RECENT_KEYS
)
4618 return Fvector (total_keys
, keys
);
4621 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4622 bcopy (keys
+ recent_keys_index
,
4623 XVECTOR (val
)->contents
,
4624 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4626 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4627 recent_keys_index
* sizeof (Lisp_Object
));
4632 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4633 "Return the key sequence that invoked this command.\n\
4634 The value is a string or a vector.")
4637 return make_event_array (this_command_key_count
,
4638 XVECTOR (this_command_keys
)->contents
);
4641 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4642 "Return the current depth in recursive edits.")
4646 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4650 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4651 "FOpen dribble file: ",
4652 "Start writing all keyboard characters to a dribble file called FILE.\n\
4653 If FILE is nil, close any open dribble file.")
4664 file
= Fexpand_file_name (file
, Qnil
);
4665 dribble
= fopen (XSTRING (file
)->data
, "w");
4670 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4671 "Discard the contents of the terminal input buffer.\n\
4672 Also cancel any kbd macro being defined.")
4675 defining_kbd_macro
= 0;
4676 update_mode_lines
++;
4678 unread_command_events
= Qnil
;
4679 unread_command_char
= -1;
4681 discard_tty_input ();
4683 /* Without the cast, GCC complains that this assignment loses the
4684 volatile qualifier of kbd_store_ptr. Is there anything wrong
4686 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4687 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4693 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4694 "Stop Emacs and return to superior process. You can resume later.\n\
4695 On systems that don't have job control, run a subshell instead.\n\n\
4696 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4697 to be read as terminal input by Emacs's parent, after suspension.\n\
4699 Before suspending, call the functions in `suspend-hook' with no args.\n\
4700 If any of them returns nil, don't call the rest and don't suspend.\n\
4701 Otherwise, suspend normally and after resumption run the normal hook\n\
4702 `suspend-resume-hook' if that is bound and non-nil.\n\
4704 Some operating systems cannot stop the Emacs process and resume it later.\n\
4705 On such systems, Emacs starts a subshell instead of suspending.")
4707 Lisp_Object stuffstring
;
4710 int count
= specpdl_ptr
- specpdl
;
4711 int old_height
, old_width
;
4713 struct gcpro gcpro1
, gcpro2
;
4714 extern init_sys_modes ();
4716 if (!NILP (stuffstring
))
4717 CHECK_STRING (stuffstring
, 0);
4719 /* Run the functions in suspend-hook. */
4720 if (!NILP (Vrun_hooks
))
4721 call1 (Vrun_hooks
, intern ("suspend-hook"));
4723 GCPRO1 (stuffstring
);
4724 get_frame_size (&old_width
, &old_height
);
4726 /* sys_suspend can get an error if it tries to fork a subshell
4727 and the system resources aren't available for that. */
4728 record_unwind_protect (init_sys_modes
, 0);
4729 stuff_buffered_input (stuffstring
);
4731 unbind_to (count
, Qnil
);
4733 /* Check if terminal/window size has changed.
4734 Note that this is not useful when we are running directly
4735 with a window system; but suspend should be disabled in that case. */
4736 get_frame_size (&width
, &height
);
4737 if (width
!= old_width
|| height
!= old_height
)
4738 change_frame_size (selected_frame
, height
, width
, 0, 0);
4740 /* Run suspend-resume-hook. */
4741 if (!NILP (Vrun_hooks
))
4742 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4748 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4749 Then in any case stuff anything Emacs has read ahead and not used. */
4751 stuff_buffered_input (stuffstring
)
4752 Lisp_Object stuffstring
;
4754 register unsigned char *p
;
4756 /* stuff_char works only in BSD, versions 4.2 and up. */
4759 if (XTYPE (stuffstring
) == Lisp_String
)
4763 p
= XSTRING (stuffstring
)->data
;
4764 count
= XSTRING (stuffstring
)->size
;
4769 /* Anything we have read ahead, put back for the shell to read. */
4770 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4772 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4773 kbd_fetch_ptr
= kbd_buffer
;
4774 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4775 stuff_char (XINT (kbd_fetch_ptr
->code
));
4776 kbd_fetch_ptr
->kind
= no_event
;
4777 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4784 #endif /* BSD and not BSD4_1 */
4787 set_waiting_for_input (time_to_clear
)
4788 EMACS_TIME
*time_to_clear
;
4790 input_available_clear_time
= time_to_clear
;
4792 /* Tell interrupt_signal to throw back to read_char, */
4793 waiting_for_input
= 1;
4795 /* If interrupt_signal was called before and buffered a C-g,
4796 make it run again now, to avoid timing error. */
4797 if (!NILP (Vquit_flag
))
4798 quit_throw_to_read_char ();
4800 /* If alarm has gone off already, echo now. */
4808 clear_waiting_for_input ()
4810 /* Tell interrupt_signal not to throw back to read_char, */
4811 waiting_for_input
= 0;
4812 input_available_clear_time
= 0;
4815 /* This routine is called at interrupt level in response to C-G.
4816 If interrupt_input, this is the handler for SIGINT.
4817 Otherwise, it is called from kbd_buffer_store_event,
4818 in handling SIGIO or SIGTINT.
4820 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
4821 immediately throw back to read_char.
4823 Otherwise it sets the Lisp variable quit-flag not-nil.
4824 This causes eval to throw, when it gets a chance.
4825 If quit-flag is already non-nil, it stops the job right away. */
4831 /* Must preserve main program's value of errno. */
4832 int old_errno
= errno
;
4835 /* USG systems forget handlers when they are used;
4836 must reestablish each time */
4837 signal (SIGINT
, interrupt_signal
);
4838 signal (SIGQUIT
, interrupt_signal
);
4843 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
4848 #ifdef SIGTSTP /* Support possible in later USG versions */
4850 * On systems which can suspend the current process and return to the original
4851 * shell, this command causes the user to end up back at the shell.
4852 * The "Auto-save" and "Abort" questions are not asked until
4853 * the user elects to return to emacs, at which point he can save the current
4854 * job and either dump core or continue.
4859 if (sys_suspend () == -1)
4861 printf ("Not running as a subprocess;\n");
4862 printf ("you can continue or abort.\n");
4865 /* Perhaps should really fork an inferior shell?
4866 But that would not provide any way to get back
4867 to the original shell, ever. */
4868 printf ("No support for stopping a process on this operating system;\n");
4869 printf ("you can continue or abort.\n");
4870 #endif /* not VMS */
4871 #endif /* not SIGTSTP */
4872 printf ("Auto-save? (y or n) ");
4874 if (((c
= getchar ()) & ~040) == 'Y')
4876 Fdo_auto_save (Qt
, Qnil
);
4877 printf ("Auto-save done\n");
4879 while (c
!= '\n') c
= getchar ();
4881 printf ("Abort (and enter debugger)? (y or n) ");
4883 printf ("Abort (and dump core)? (y or n) ");
4884 #endif /* not VMS */
4886 if (((c
= getchar ()) & ~040) == 'Y')
4888 while (c
!= '\n') c
= getchar ();
4889 printf ("Continuing...\n");
4895 /* If executing a function that wants to be interrupted out of
4896 and the user has not deferred quitting by binding `inhibit-quit'
4897 then quit right away. */
4898 if (immediate_quit
&& NILP (Vinhibit_quit
))
4902 Fsignal (Qquit
, Qnil
);
4905 /* Else request quit when it's safe */
4909 if (waiting_for_input
&& !echoing
)
4910 quit_throw_to_read_char ();
4915 /* Handle a C-g by making read_char return C-g. */
4917 quit_throw_to_read_char ()
4919 quit_error_check ();
4921 /* Prevent another signal from doing this before we finish. */
4922 clear_waiting_for_input ();
4925 unread_command_events
= Qnil
;
4926 unread_command_char
= -1;
4928 #ifdef POLL_FOR_INPUT
4929 /* May be > 1 if in recursive minibuffer. */
4930 if (poll_suppress_count
== 0)
4934 _longjmp (getcjmp
, 1);
4937 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
4938 "Set mode of reading keyboard input.\n\
4939 First arg INTERRUPT non-nil means use input interrupts;\n\
4940 nil means use CBREAK mode.\n\
4941 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
4942 (no effect except in CBREAK mode).\n\
4943 Third arg META t means accept 8-bit input (for a Meta key).\n\
4944 META nil means ignore the top bit, on the assumption it is parity.\n\
4945 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
4946 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
4947 See also `current-input-mode'.")
4948 (interrupt
, flow
, meta
, quit
)
4949 Lisp_Object interrupt
, flow
, meta
, quit
;
4952 && (XTYPE (quit
) != Lisp_Int
4953 || XINT (quit
) < 0 || XINT (quit
) > 0400))
4954 error ("set-input-mode: QUIT must be an ASCII character");
4956 #ifdef POLL_FOR_INPUT
4962 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4963 #ifdef NO_SOCK_SIGIO
4964 if (read_socket_hook
)
4965 interrupt_input
= 0; /* No interrupts if reading from a socket. */
4967 #endif /* NO_SOCK_SIGIO */
4968 interrupt_input
= !NILP (interrupt
);
4969 #else /* not SIGIO */
4970 interrupt_input
= 0;
4971 #endif /* not SIGIO */
4972 /* Our VMS input only works by interrupts, as of now. */
4974 interrupt_input
= 1;
4976 flow_control
= !NILP (flow
);
4979 else if (EQ (meta
, Qt
))
4984 /* Don't let this value be out of range. */
4985 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
4989 #ifdef POLL_FOR_INPUT
4990 poll_suppress_count
= 1;
4996 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
4997 "Return information about the way Emacs currently reads keyboard input.\n\
4998 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
4999 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5000 nil, Emacs is using CBREAK mode.\n\
5001 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5002 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5003 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5004 META nil means ignoring the top bit, on the assumption it is parity.\n\
5005 META is neither t nor nil if accepting 8-bit input and using\n\
5006 all 8 bits as the character code.\n\
5007 QUIT is the character Emacs currently uses to quit.\n\
5008 The elements of this list correspond to the arguments of\n\
5014 val
[0] = interrupt_input
? Qt
: Qnil
;
5015 val
[1] = flow_control
? Qt
: Qnil
;
5016 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5017 XFASTINT (val
[3]) = quit_char
;
5019 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5025 /* This is correct before outermost invocation of the editor loop */
5026 command_loop_level
= -1;
5028 quit_char
= Ctl ('g');
5029 unread_command_events
= Qnil
;
5030 unread_command_char
= -1;
5032 recent_keys_index
= 0;
5033 kbd_fetch_ptr
= kbd_buffer
;
5034 kbd_store_ptr
= kbd_buffer
;
5035 do_mouse_tracking
= 0;
5039 /* This means that command_loop_1 won't try to select anything the first
5041 internal_last_event_frame
= Qnil
;
5042 Vlast_event_frame
= internal_last_event_frame
;
5045 /* If we're running a dumped Emacs, we need to clear out
5046 kbd_buffer_frame_or_window, in case some events got into it
5049 If we're running an undumped Emacs, it hasn't been initialized by
5050 syms_of_keyboard yet. */
5052 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5054 if (!noninteractive
)
5056 signal (SIGINT
, interrupt_signal
);
5057 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5058 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5059 SIGQUIT and we can't tell which one it will give us. */
5060 signal (SIGQUIT
, interrupt_signal
);
5061 #endif /* HAVE_TERMIO */
5062 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5064 signal (SIGIO
, input_available_signal
);
5068 /* Use interrupt input by default, if it works and noninterrupt input
5069 has deficiencies. */
5071 #ifdef INTERRUPT_INPUT
5072 interrupt_input
= 1;
5074 interrupt_input
= 0;
5077 /* Our VMS input only works by interrupts, as of now. */
5079 interrupt_input
= 1;
5085 if (keyboard_init_hook
)
5086 (*keyboard_init_hook
) ();
5088 #ifdef POLL_FOR_INPUT
5089 poll_suppress_count
= 1;
5094 /* This type's only use is in syms_of_keyboard, to initialize the
5095 event header symbols and put properties on them. */
5102 struct event_head head_table
[] = {
5103 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5104 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5105 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5110 Qdisabled_command_hook
= intern ("disabled-command-hook");
5111 staticpro (&Qdisabled_command_hook
);
5113 Qself_insert_command
= intern ("self-insert-command");
5114 staticpro (&Qself_insert_command
);
5116 Qforward_char
= intern ("forward-char");
5117 staticpro (&Qforward_char
);
5119 Qbackward_char
= intern ("backward-char");
5120 staticpro (&Qbackward_char
);
5122 Qdisabled
= intern ("disabled");
5123 staticpro (&Qdisabled
);
5125 Qundefined
= intern ("undefined");
5126 staticpro (&Qundefined
);
5128 Qpre_command_hook
= intern ("pre-command-hook");
5129 staticpro (&Qpre_command_hook
);
5131 Qpost_command_hook
= intern ("post-command-hook");
5132 staticpro (&Qpost_command_hook
);
5134 Qfunction_key
= intern ("function-key");
5135 staticpro (&Qfunction_key
);
5136 Qmouse_click
= intern ("mouse-click");
5137 staticpro (&Qmouse_click
);
5139 Qmenu_enable
= intern ("menu-enable");
5140 staticpro (&Qmenu_enable
);
5142 Qmode_line
= intern ("mode-line");
5143 staticpro (&Qmode_line
);
5144 Qvertical_line
= intern ("vertical-line");
5145 staticpro (&Qvertical_line
);
5146 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5147 staticpro (&Qvertical_scroll_bar
);
5148 Qmenu_bar
= intern ("menu-bar");
5149 staticpro (&Qmenu_bar
);
5151 Qabove_handle
= intern ("above-handle");
5152 staticpro (&Qabove_handle
);
5153 Qhandle
= intern ("handle");
5154 staticpro (&Qhandle
);
5155 Qbelow_handle
= intern ("below-handle");
5156 staticpro (&Qbelow_handle
);
5158 Qevent_kind
= intern ("event-kind");
5159 staticpro (&Qevent_kind
);
5160 Qevent_symbol_elements
= intern ("event-symbol-elements");
5161 staticpro (&Qevent_symbol_elements
);
5162 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5163 staticpro (&Qevent_symbol_element_mask
);
5164 Qmodifier_cache
= intern ("modifier-cache");
5165 staticpro (&Qmodifier_cache
);
5167 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5168 staticpro (&Qrecompute_lucid_menubar
);
5169 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5170 staticpro (&Qactivate_menubar_hook
);
5173 struct event_head
*p
;
5175 for (p
= head_table
;
5176 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5179 *p
->var
= intern (p
->name
);
5181 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5182 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5186 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5187 staticpro (&button_down_location
);
5191 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5193 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5194 for (i
= 0; i
< len
; i
++)
5195 if (modifier_names
[i
])
5196 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5197 staticpro (&modifier_symbols
);
5200 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5201 staticpro (&recent_keys
);
5203 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5204 staticpro (&this_command_keys
);
5206 kbd_buffer_frame_or_window
5207 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5208 staticpro (&kbd_buffer_frame_or_window
);
5210 func_key_syms
= Qnil
;
5211 staticpro (&func_key_syms
);
5214 staticpro (&mouse_syms
);
5216 unread_switch_frame
= Qnil
;
5217 staticpro (&unread_switch_frame
);
5219 defsubr (&Sread_key_sequence
);
5220 defsubr (&Srecursive_edit
);
5221 defsubr (&Strack_mouse
);
5222 defsubr (&Sinput_pending_p
);
5223 defsubr (&Scommand_execute
);
5224 defsubr (&Srecent_keys
);
5225 defsubr (&Sthis_command_keys
);
5226 defsubr (&Ssuspend_emacs
);
5227 defsubr (&Sabort_recursive_edit
);
5228 defsubr (&Sexit_recursive_edit
);
5229 defsubr (&Srecursion_depth
);
5230 defsubr (&Stop_level
);
5231 defsubr (&Sdiscard_input
);
5232 defsubr (&Sopen_dribble_file
);
5233 defsubr (&Sset_input_mode
);
5234 defsubr (&Scurrent_input_mode
);
5235 defsubr (&Sexecute_extended_command
);
5237 DEFVAR_LISP ("last-command-char", &last_command_char
,
5238 "Last input event that was part of a command.");
5240 DEFVAR_LISP ("last-command-event", &last_command_char
,
5241 "Last input event that was part of a command.");
5243 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5244 "Last input event in a command, except for mouse menu events.\n\
5245 Mouse menus give back keys that don't look like mouse events;\n\
5246 this variable holds the actual mouse event that led to the menu,\n\
5247 so that you can determine whether the command was run by mouse or not.");
5249 DEFVAR_LISP ("last-input-char", &last_input_char
,
5250 "Last input event.");
5252 DEFVAR_LISP ("last-input-event", &last_input_char
,
5253 "Last input event.");
5255 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5256 "List of objects to be read as next command input events.");
5258 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5259 "If not -1, an object to be read as next command input event.");
5261 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5262 "Meta-prefix character code. Meta-foo as command input\n\
5263 turns into this character followed by foo.");
5264 XSET (meta_prefix_char
, Lisp_Int
, 033);
5266 DEFVAR_LISP ("last-command", &last_command
,
5267 "The last command executed. Normally a symbol with a function definition,\n\
5268 but can be whatever was found in the keymap, or whatever the variable\n\
5269 `this-command' was set to by that command.");
5270 last_command
= Qnil
;
5272 DEFVAR_LISP ("this-command", &this_command
,
5273 "The command now being executed.\n\
5274 The command can set this variable; whatever is put here\n\
5275 will be in `last-command' during the following command.");
5276 this_command
= Qnil
;
5278 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5279 "*Number of keyboard input characters between auto-saves.\n\
5280 Zero means disable autosaving due to number of characters typed.");
5281 auto_save_interval
= 300;
5283 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5284 "*Number of seconds idle time before auto-save.\n\
5285 Zero or nil means disable auto-saving due to idleness.\n\
5286 After auto-saving due to this many seconds of idle time,\n\
5287 Emacs also does a garbage collection if that seems to be warranted.");
5288 XFASTINT (Vauto_save_timeout
) = 30;
5290 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5291 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5292 echo_keystrokes
= 1;
5294 DEFVAR_INT ("polling-period", &polling_period
,
5295 "*Interval between polling for input during Lisp execution.\n\
5296 The reason for polling is to make C-g work to stop a running program.\n\
5297 Polling is needed only when using X windows and SIGIO does not work.\n\
5298 Polling is automatically disabled in all other cases.");
5301 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5302 "*Maximum time between mouse clicks to make a double-click.\n\
5303 Measured in milliseconds. nil means disable double-click recognition;\n\
5304 t means double-clicks have no time limit and are detected\n\
5305 by position only.");
5306 Vdouble_click_time
= make_number (500);
5308 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5309 "*Number of complete keys read from the keyboard so far.");
5313 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5314 "*The frame in which the most recently read event occurred.\n\
5315 If the last event came from a keyboard macro, this is set to `macro'.");
5316 Vlast_event_frame
= Qnil
;
5319 DEFVAR_LISP ("help-char", &Vhelp_char
,
5320 "Character to recognize as meaning Help.\n\
5321 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5322 If the value of `help-form' is nil, this char can be read normally.");
5323 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5325 DEFVAR_LISP ("help-form", &Vhelp_form
,
5326 "Form to execute when character `help-char' is read.\n\
5327 If the form returns a string, that string is displayed.\n\
5328 If `help-form' is nil, the help char is not recognized.");
5331 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5332 "Command to run when `help-char' character follows a prefix key.\n\
5333 This command is used only when there is no actual binding\n\
5334 for that character after that prefix key.");
5335 Vprefix_help_command
= Qnil
;
5337 DEFVAR_LISP ("top-level", &Vtop_level
,
5338 "Form to evaluate when Emacs starts up.\n\
5339 Useful to set before you dump a modified Emacs.");
5342 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5343 "String used as translate table for keyboard input, or nil.\n\
5344 Each character is looked up in this string and the contents used instead.\n\
5345 If string is of length N, character codes N and up are untranslated.");
5346 Vkeyboard_translate_table
= Qnil
;
5348 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5349 "Keymap of key translations that can override keymaps.\n\
5350 This keymap works like `function-key-map', but comes after that,\n\
5351 and applies even for keys that have ordinary bindings.");
5352 Vkey_translation_map
= Qnil
;
5354 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5355 "Non-nil means prompt with menus when appropriate.\n\
5356 This is done when reading from a keymap that has a prompt string,\n\
5357 for elements that have prompt strings.\n\
5358 The menu is displayed on the screen\n\
5359 if X menus were enabled at configuration\n\
5360 time and the previous event was a mouse click prefix key.\n\
5361 Otherwise, menu prompting uses the echo area.");
5364 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5365 "Character to see next line of menu prompt.\n\
5366 Type this character while in a menu prompt to rotate around the lines of it.");
5367 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5369 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5370 "A mask of additional modifier keys to use with every keyboard character.\n\
5371 Emacs applies the modifiers of the character stored here to each keyboard\n\
5372 character it reads. For example, after evaluating the expression\n\
5373 (setq extra-keyboard-modifiers ?\C-x)\n\
5374 all input characters will have the control modifier applied to them.\n\
5376 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5377 not count as a control character; rather, it counts as a character\n\
5378 with no modifiers; thus, setting extra_keyboard_modifiers to zero\n\
5379 cancels any modification.");
5380 extra_keyboard_modifiers
= 0;
5382 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5383 "If an editing command sets this to t, deactivate the mark afterward.\n\
5384 The command loop sets this to nil before each command,\n\
5385 and tests the value when the command returns.\n\
5386 Buffer modification stores t in this variable.");
5387 Vdeactivate_mark
= Qnil
;
5389 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5390 "Normal hook run before each command is executed.");
5391 Vpre_command_hook
= Qnil
;
5393 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5394 "Normal hook run after each command is executed.");
5395 Vpost_command_hook
= Qnil
;
5397 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5398 "t means menu bar, specified Lucid style, needs to be recomputed.");
5399 Vlucid_menu_bar_dirty_flag
= Qnil
;
5401 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5402 "List of menu bar items to move to the end of the menu bar.\n\
5403 The elements of the list are event types that may have menu bar bindings.");
5404 Vmenu_bar_final_items
= Qnil
;
5409 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5410 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5411 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5412 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5413 initial_define_key (meta_map
, 'x', "execute-extended-command");