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 ();
405 Lisp_Object Qextended_command_history
;
407 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
409 EMACS_TIME
*input_available_clear_time
;
411 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
412 Default is 1 if INTERRUPT_INPUT is defined. */
415 /* Nonzero while interrupts are temporarily deferred during redisplay. */
416 int interrupts_deferred
;
418 /* nonzero means use ^S/^Q for flow control. */
421 /* Allow m- file to inhibit use of FIONREAD. */
422 #ifdef BROKEN_FIONREAD
426 /* We are unable to use interrupts if FIONREAD is not available,
427 so flush SIGIO so we won't try. */
434 /* If we support X Windows, turn on the code to poll periodically
435 to detect C-g. It isn't actually used when doing interrupt input. */
436 #ifdef HAVE_X_WINDOWS
437 #define POLL_FOR_INPUT
440 /* Global variable declarations. */
442 /* Function for init_keyboard to call with no args (if nonzero). */
443 void (*keyboard_init_hook
) ();
445 static int read_avail_input ();
446 static void get_input_pending ();
447 static int readable_events ();
448 static Lisp_Object
read_char_menu_prompt ();
449 static Lisp_Object
make_lispy_event ();
450 static Lisp_Object
make_lispy_movement ();
451 static Lisp_Object
modify_event_symbol ();
452 static Lisp_Object
make_lispy_switch_frame ();
454 /* > 0 if we are to echo keystrokes. */
455 static int echo_keystrokes
;
457 /* Nonzero means echo each character as typed. */
458 static int immediate_echo
;
460 /* The text we're echoing in the modeline - partial key sequences,
461 usually. '\0'-terminated. This really shouldn't have a fixed size. */
462 static char echobuf
[300];
464 /* Where to append more text to echobuf if we want to. */
465 static char *echoptr
;
467 #define min(a,b) ((a)<(b)?(a):(b))
468 #define max(a,b) ((a)>(b)?(a):(b))
470 /* Install the string STR as the beginning of the string of echoing,
471 so that it serves as a prompt for the next character.
472 Also start echoing. */
477 int len
= strlen (str
);
478 if (len
> sizeof echobuf
- 4)
479 len
= sizeof echobuf
- 4;
480 bcopy (str
, echobuf
, len
);
481 echoptr
= echobuf
+ len
;
487 /* Add C to the echo string, if echoing is going on.
488 C can be a character, which is printed prettily ("M-C-x" and all that
489 jazz), or a symbol, whose name is printed. */
494 extern char *push_key_description ();
503 /* If someone has passed us a composite event, use its head symbol. */
506 if (XTYPE (c
) == Lisp_Int
)
508 if (ptr
- echobuf
> sizeof echobuf
- 6)
511 ptr
= push_key_description (XINT (c
), ptr
);
513 else if (XTYPE (c
) == Lisp_Symbol
)
515 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
516 if (((ptr
- echobuf
) + name
->size
+ 4) > sizeof echobuf
)
518 bcopy (name
->data
, ptr
, name
->size
);
522 if (echoptr
== echobuf
&& EQ (c
, Vhelp_char
))
524 strcpy (ptr
, " (Type ? for further options)");
535 /* Temporarily add a dash to the end of the echo string if it's not
536 empty, so that it serves as a mini-prompt for the very next character. */
540 if (!immediate_echo
&& echoptr
== echobuf
)
542 /* Do nothing if not echoing at all. */
546 /* Put a dash at the end of the buffer temporarily,
547 but make it go away when the next character is added. */
554 /* Display the current echo string, and begin echoing if not already
564 for (i
= 0; i
< this_command_key_count
; i
++)
565 echo_char (XVECTOR (this_command_keys
)->contents
[i
]);
573 if (waiting_for_input
&& !NILP (Vquit_flag
))
574 quit_throw_to_read_char ();
577 /* Turn off echoing, for the start of a new command. */
585 /* Return the length of the current echo string. */
590 return echoptr
- echobuf
;
593 /* Truncate the current echo message to its first LEN chars.
594 This and echo_char get used by read_key_sequence when the user
595 switches frames while entering a key sequence. */
602 echoptr
= echobuf
+ len
;
606 /* Functions for manipulating this_command_keys. */
608 add_command_key (key
)
611 int size
= XVECTOR (this_command_keys
)->size
;
613 if (this_command_key_count
>= size
)
615 Lisp_Object new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
617 bcopy (XVECTOR (this_command_keys
)->contents
,
618 XVECTOR (new_keys
)->contents
,
619 size
* sizeof (Lisp_Object
));
621 this_command_keys
= new_keys
;
624 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
630 int count
= specpdl_ptr
- specpdl
;
633 if (command_loop_level
> 0)
635 specbind (Qstandard_output
, Qt
);
636 specbind (Qstandard_input
, Qt
);
639 val
= command_loop ();
641 Fsignal (Qquit
, Qnil
);
643 return unbind_to (count
, Qnil
);
646 /* When an auto-save happens, record the "time", and don't do again soon. */
649 last_auto_save
= num_nonmacro_input_chars
;
652 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
653 "Invoke the editor command loop recursively.\n\
654 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
655 that tells this function to return.\n\
656 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
657 This function is called by the editor initialization to begin editing.")
660 int count
= specpdl_ptr
- specpdl
;
663 command_loop_level
++;
664 update_mode_lines
= 1;
666 record_unwind_protect (recursive_edit_unwind
,
668 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
672 return unbind_to (count
, Qnil
);
676 recursive_edit_unwind (buffer
)
680 Fset_buffer (buffer
);
682 command_loop_level
--;
683 update_mode_lines
= 1;
691 Lisp_Object errmsg
, tail
, errname
, file_error
;
698 Vstandard_output
= Qt
;
699 Vstandard_input
= Qt
;
700 Vexecuting_macro
= Qnil
;
701 echo_area_glyphs
= 0;
703 /* If the window system or terminal frame hasn't been initialized
704 yet, or we're not interactive, it's best to dump this message out
705 to stderr and exit. */
706 if (! FRAME_MESSAGE_BUF (selected_frame
)
708 stream
= Qexternal_debugging_output
;
716 errname
= Fcar (data
);
718 if (EQ (errname
, Qerror
))
721 if (!CONSP (data
)) data
= Qnil
;
722 errmsg
= Fcar (data
);
727 errmsg
= Fget (errname
, Qerror_message
);
728 file_error
= Fmemq (Qfile_error
,
729 Fget (errname
, Qerror_conditions
));
732 /* Print an error message including the data items.
733 This is done by printing it into a scratch buffer
734 and then making a copy of the text in the buffer. */
736 if (!CONSP (data
)) data
= Qnil
;
740 /* For file-error, make error message by concatenating
741 all the data items. They are all strings. */
742 if (!NILP (file_error
) && !NILP (tail
))
743 errmsg
= XCONS (tail
)->car
, tail
= XCONS (tail
)->cdr
;
745 if (XTYPE (errmsg
) == Lisp_String
)
746 Fprinc (errmsg
, stream
);
748 write_string_1 ("peculiar error", -1, stream
);
750 for (i
= 0; CONSP (tail
); tail
= Fcdr (tail
), i
++)
752 write_string_1 (i
? ", " : ": ", 2, stream
);
753 if (!NILP (file_error
))
754 Fprinc (Fcar (tail
), stream
);
756 Fprin1 (Fcar (tail
), stream
);
760 /* If the window system or terminal frame hasn't been initialized
761 yet, or we're in -batch mode, this error should cause Emacs to exit. */
762 if (! FRAME_MESSAGE_BUF (selected_frame
)
766 Fkill_emacs (make_number (-1));
771 Vinhibit_quit
= Qnil
;
772 return make_number (0);
775 Lisp_Object
command_loop_1 ();
776 Lisp_Object
command_loop_2 ();
777 Lisp_Object
top_level_1 ();
779 /* Entry to editor-command-loop.
780 This level has the catches for exiting/returning to editor command loop.
781 It returns nil to exit recursive edit, t to abort it. */
786 if (command_loop_level
> 0 || minibuf_level
> 0)
788 return internal_catch (Qexit
, command_loop_2
, Qnil
);
793 internal_catch (Qtop_level
, top_level_1
, Qnil
);
794 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
796 /* End of file in -batch run causes exit here. */
802 /* Here we catch errors in execution of commands within the
803 editing loop, and reenter the editing loop.
804 When there is an error, cmd_error runs and returns a non-nil
805 value to us. A value of nil means that cmd_loop_1 itself
806 returned due to end of file (or end of kbd macro). */
811 register Lisp_Object val
;
814 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
823 return Feval (Vtop_level
);
829 /* On entry to the outer level, run the startup file */
830 if (!NILP (Vtop_level
))
831 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
832 else if (!NILP (Vpurify_flag
))
833 message ("Bare impure Emacs (standard Lisp code not loaded)");
835 message ("Bare Emacs (standard Lisp code not loaded)");
839 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
840 "Exit all recursive editing levels.")
843 Fthrow (Qtop_level
, Qnil
);
846 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
847 "Exit from the innermost recursive edit or minibuffer.")
850 if (command_loop_level
> 0 || minibuf_level
> 0)
851 Fthrow (Qexit
, Qnil
);
853 error ("No recursive edit is in progress");
856 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
857 "Abort the command that requested this recursive edit or minibuffer input.")
860 if (command_loop_level
> 0 || minibuf_level
> 0)
863 error ("No recursive edit is in progress");
866 /* This is the actual command reading loop,
867 sans error-handling encapsulation. */
869 Lisp_Object
Fcommand_execute ();
870 static int read_key_sequence ();
875 Lisp_Object cmd
, tem
;
878 Lisp_Object keybuf
[30];
883 struct buffer
*prev_buffer
;
886 Vdeactivate_mark
= Qnil
;
887 waiting_for_input
= 0;
890 /* Don't clear out last_command at the beginning of a macro. */
891 if (XTYPE (Vexecuting_macro
) != Lisp_String
)
896 this_command_key_count
= 0;
898 /* Make sure this hook runs after commands that get errors and
899 throw to top level. */
900 if (!NILP (Vpost_command_hook
))
901 call1 (Vrun_hooks
, Qpost_command_hook
);
905 /* Install chars successfully executed in kbd macro. */
907 if (defining_kbd_macro
&& NILP (Vprefix_arg
))
908 finalize_kbd_macro_chars ();
910 /* Make sure the current window's buffer is selected. */
911 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
912 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
914 /* Display any malloc warning that just came out. Use while because
915 displaying one warning can cause another. */
917 while (pending_malloc_warning
)
918 display_malloc_warning ();
922 Vdeactivate_mark
= Qnil
;
924 /* If minibuffer on and echo area in use,
925 wait 2 sec and redraw minibuffer. */
927 if (minibuf_level
&& echo_area_glyphs
)
929 /* Bind inhibit-quit to t so that C-g gets read in
930 rather than quitting back to the minibuffer. */
931 int count
= specpdl_ptr
- specpdl
;
932 specbind (Qinhibit_quit
, Qt
);
933 Fsit_for (make_number (2), Qnil
, Qnil
);
934 unbind_to (count
, Qnil
);
936 echo_area_glyphs
= 0;
938 if (!NILP (Vquit_flag
))
941 unread_command_events
= Fcons (make_number (quit_char
), Qnil
);
946 alloca (0); /* Cause a garbage collection now */
947 /* Since we can free the most stuff here. */
948 #endif /* C_ALLOCA */
952 /* Select the frame that the last event came from. Usually,
953 switch-frame events will take care of this, but if some lisp
954 code swallows a switch-frame event, we'll fix things up here.
955 Is this a good idea? */
956 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
957 && XFRAME (internal_last_event_frame
) != selected_frame
)
958 Fselect_frame (internal_last_event_frame
, Qnil
);
961 /* If it has changed current-menubar from previous value,
962 really recompute the menubar from the value. */
963 if (! NILP (Vlucid_menu_bar_dirty_flag
)
964 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
965 call0 (Qrecompute_lucid_menubar
);
967 #if 0 /* This is done in xdisp.c now. */
969 for (tem
= Vframe_list
; CONSP (tem
); tem
= XCONS (tem
)->cdr
)
971 struct frame
*f
= XFRAME (XCONS (tem
)->car
);
972 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
974 /* If the user has switched buffers or windows, we need to
975 recompute to reflect the new bindings. But we'll
976 recompute when update_mode_lines is set too; that means
977 that people can use force-mode-line-update to request
978 that the menu bar be recomputed. The adverse effect on
979 the rest of the redisplay algorithm is about the same as
980 windows_or_buffers_changed anyway. */
981 if (windows_or_buffers_changed
983 || (XFASTINT (w
->last_modified
) < MODIFF
984 && (XFASTINT (w
->last_modified
)
985 <= XBUFFER (w
->buffer
)->save_modified
)))
987 struct buffer
*prev
= current_buffer
;
988 current_buffer
= XBUFFER (w
->buffer
);
989 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items ();
990 current_buffer
= prev
;
993 #endif /* MULTI_FRAME */
996 /* Read next key sequence; i gets its length. */
997 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])), Qnil
);
1001 /* Now we have read a key sequence of length I,
1002 or else I is 0 and we found end of file. */
1004 if (i
== 0) /* End of file -- happens only in */
1005 return Qnil
; /* a kbd macro, at the end. */
1006 /* -1 means read_key_sequence got a menu that was rejected.
1007 Just loop around and read another command. */
1011 this_command_key_count
= 0;
1015 last_command_char
= keybuf
[i
- 1];
1017 /* If the previous command tried to force a specific window-start,
1018 forget about that, in case this command moves point far away
1019 from that position. */
1020 XWINDOW (selected_window
)->force_start
= Qnil
;
1022 cmd
= read_key_sequence_cmd
;
1023 if (!NILP (Vexecuting_macro
))
1025 if (!NILP (Vquit_flag
))
1027 Vexecuting_macro
= Qt
;
1028 QUIT
; /* Make some noise. */
1029 /* Will return since macro now empty. */
1033 /* Do redisplay processing after this command except in special
1034 cases identified below that set no_redisplay to 1. */
1037 prev_buffer
= current_buffer
;
1038 prev_modiff
= MODIFF
;
1040 /* Execute the command. */
1043 if (!NILP (Vpre_command_hook
))
1044 call1 (Vrun_hooks
, Qpre_command_hook
);
1046 if (NILP (this_command
))
1048 /* nil means key is undefined. */
1050 defining_kbd_macro
= 0;
1051 update_mode_lines
= 1;
1057 if (NILP (Vprefix_arg
) && ! no_direct
)
1059 /* Recognize some common commands in common situations and
1060 do them directly. */
1061 if (EQ (this_command
, Qforward_char
) && point
< ZV
)
1063 struct Lisp_Vector
*dp
1064 = window_display_table (XWINDOW (selected_window
));
1065 lose
= FETCH_CHAR (point
);
1068 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1069 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1070 : (lose
>= 0x20 && lose
< 0x7f))
1071 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1073 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1075 && !windows_or_buffers_changed
1076 && EQ (current_buffer
->selective_display
, Qnil
)
1077 && !detect_input_pending ()
1078 && NILP (Vexecuting_macro
))
1079 no_redisplay
= direct_output_forward_char (1);
1082 else if (EQ (this_command
, Qbackward_char
) && point
> BEGV
)
1084 struct Lisp_Vector
*dp
1085 = window_display_table (XWINDOW (selected_window
));
1087 lose
= FETCH_CHAR (point
);
1089 ? (XTYPE (DISP_CHAR_VECTOR (dp
, lose
)) != Lisp_Vector
1090 && XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1)
1091 : (lose
>= 0x20 && lose
< 0x7f))
1092 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1094 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1096 && !windows_or_buffers_changed
1097 && EQ (current_buffer
->selective_display
, Qnil
)
1098 && !detect_input_pending ()
1099 && NILP (Vexecuting_macro
))
1100 no_redisplay
= direct_output_forward_char (-1);
1103 else if (EQ (this_command
, Qself_insert_command
)
1104 /* Try this optimization only on ascii keystrokes. */
1105 && XTYPE (last_command_char
) == Lisp_Int
)
1107 unsigned char c
= XINT (last_command_char
);
1109 if (NILP (Vexecuting_macro
) &&
1110 !EQ (minibuf_window
, selected_window
))
1112 if (!nonundocount
|| nonundocount
>= 20)
1119 lose
= (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1121 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1123 || MODIFF
<= current_buffer
->save_modified
1124 || windows_or_buffers_changed
1125 || !EQ (current_buffer
->selective_display
, Qnil
)
1126 || detect_input_pending ()
1127 || !NILP (Vexecuting_macro
);
1128 if (internal_self_insert (c
, 0))
1134 (point
== ZV
|| FETCH_CHAR (point
) == '\n'))
1136 struct Lisp_Vector
*dp
1137 = window_display_table (XWINDOW (selected_window
));
1142 Lisp_Object obj
= DISP_CHAR_VECTOR (dp
, lose
);
1144 if (XTYPE (obj
) == Lisp_Vector
1145 && XVECTOR (obj
)->size
== 1
1146 && (XTYPE (obj
= XVECTOR (obj
)->contents
[0])
1149 direct_output_for_insert (XINT (obj
));
1153 if (lose
>= 0x20 && lose
<= 0x7e)
1154 no_redisplay
= direct_output_for_insert (lose
);
1161 /* Here for a command that isn't executed directly */
1164 if (NILP (Vprefix_arg
))
1166 Fcommand_execute (this_command
, Qnil
);
1171 if (!NILP (Vpost_command_hook
))
1172 call1 (Vrun_hooks
, Qpost_command_hook
);
1174 /* If there is a prefix argument,
1175 1) We don't want last_command to be ``universal-argument''
1176 (that would be dumb), so don't set last_command,
1177 2) we want to leave echoing on so that the prefix will be
1178 echoed as part of this key sequence, so don't call
1180 3) we want to leave this_command_key_count non-zero, so that
1181 read_char will realize that it is re-reading a character, and
1182 not echo it a second time. */
1183 if (NILP (Vprefix_arg
))
1185 last_command
= this_command
;
1187 this_command_key_count
= 0;
1190 if (!NILP (current_buffer
->mark_active
))
1192 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1194 current_buffer
->mark_active
= Qnil
;
1195 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1197 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1198 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1203 /* Number of seconds between polling for input. */
1206 /* Nonzero means polling for input is temporarily suppressed. */
1207 int poll_suppress_count
;
1209 #ifdef POLL_FOR_INPUT
1210 int polling_for_input
;
1212 /* Handle an alarm once each second and read pending input
1213 so as to handle a C-g if it comces in. */
1216 input_poll_signal ()
1218 if (interrupt_input_blocked
== 0
1219 && !waiting_for_input
)
1220 read_avail_input (0);
1221 signal (SIGALRM
, input_poll_signal
);
1222 alarm (polling_period
);
1227 /* Begin signals to poll for input, if they are appropriate.
1228 This function is called unconditionally from various places. */
1232 #ifdef POLL_FOR_INPUT
1233 if (read_socket_hook
&& !interrupt_input
)
1235 poll_suppress_count
--;
1236 if (poll_suppress_count
== 0)
1238 signal (SIGALRM
, input_poll_signal
);
1239 polling_for_input
= 1;
1240 alarm (polling_period
);
1246 /* Turn off polling. */
1250 #ifdef POLL_FOR_INPUT
1251 if (read_socket_hook
&& !interrupt_input
)
1253 if (poll_suppress_count
== 0)
1255 polling_for_input
= 0;
1258 poll_suppress_count
++;
1263 /* Set the value of poll_suppress_count to COUNT
1264 and start or stop polling accordingly. */
1267 set_poll_suppress_count (count
)
1270 #ifdef POLL_FOR_INPUT
1271 if (count
== 0 && poll_suppress_count
!= 0)
1273 poll_suppress_count
= 1;
1276 else if (count
!= 0 && poll_suppress_count
== 0)
1280 poll_suppress_count
= count
;
1284 /* Applying the control modifier to CHARACTER. */
1289 /* Save the upper bits here. */
1290 int upper
= c
& ~0177;
1294 /* Everything in the columns containing the upper-case letters
1295 denotes a control character. */
1296 if (c
>= 0100 && c
< 0140)
1300 /* Set the shift modifier for a control char
1301 made from a shifted letter. But only for letters! */
1302 if (oc
>= 'A' && oc
<= 'Z')
1303 c
|= shift_modifier
;
1306 /* The lower-case letters denote control characters too. */
1307 else if (c
>= 'a' && c
<= 'z')
1310 /* Include the bits for control and shift
1311 only if the basic ASCII code can't indicate them. */
1315 /* Replace the high bits. */
1316 c
|= (upper
& ~ctrl_modifier
);
1323 /* Input of single characters from keyboard */
1325 Lisp_Object
print_help ();
1326 static Lisp_Object
kbd_buffer_get_event ();
1328 /* read a character from the keyboard; call the redisplay if needed */
1329 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1330 -1 means do not do redisplay, but do do autosaving.
1333 /* The arguments MAPS and NMAPS are for menu prompting.
1334 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1336 PREV_EVENT is the previous input event, or nil if we are reading
1337 the first event of a key sequence.
1339 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
1340 if we used a mouse menu to read the input, or zero otherwise. If
1341 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
1343 Value is t if we showed a menu and the user rejected it. */
1346 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1350 Lisp_Object prev_event
;
1351 int *used_mouse_menu
;
1353 register Lisp_Object c
;
1357 if (CONSP (unread_command_events
))
1359 c
= XCONS (unread_command_events
)->car
;
1360 unread_command_events
= XCONS (unread_command_events
)->cdr
;
1362 if (this_command_key_count
== 0)
1368 if (unread_command_char
!= -1)
1370 XSET (c
, Lisp_Int
, unread_command_char
);
1371 unread_command_char
= -1;
1373 if (this_command_key_count
== 0)
1379 if (!NILP (Vexecuting_macro
))
1382 /* We set this to Qmacro; since that's not a frame, nobody will
1383 try to switch frames on us, and the selected window will
1386 Since this event came from a macro, it would be misleading to
1387 leave internal_last_event_frame set to wherever the last
1388 real event came from. Normally, a switch-frame event selects
1389 internal_last_event_frame after each command is read, but
1390 events read from a macro should never cause a new frame to be
1392 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1395 /* Exit the macro if we are at the end.
1396 Also, some things replace the macro with t
1397 to force an early exit. */
1398 if (EQ (Vexecuting_macro
, Qt
)
1399 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1401 XSET (c
, Lisp_Int
, -1);
1405 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1406 if (XTYPE (Vexecuting_macro
) == Lisp_String
1407 && (XINT (c
) & 0x80))
1408 XFASTINT (c
) = CHAR_META
| (XINT (c
) & ~0x80);
1410 executing_macro_index
++;
1415 if (!NILP (unread_switch_frame
))
1417 c
= unread_switch_frame
;
1418 unread_switch_frame
= Qnil
;
1420 /* This event should make it into this_command_keys, and get echoed
1421 again, so we go to reread_first, rather than reread. */
1425 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1426 prepare_menu_bars ();
1428 /* Save outer setjmp data, in case called recursively. */
1429 save_getcjmp (save_jump
);
1433 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1436 if (_setjmp (getcjmp
))
1438 XSET (c
, Lisp_Int
, quit_char
);
1440 XSET (internal_last_event_frame
, Lisp_Frame
, selected_frame
);
1441 Vlast_event_frame
= internal_last_event_frame
;
1443 /* If we report the quit char as an event,
1444 don't do so more than once. */
1445 if (!NILP (Vinhibit_quit
))
1451 /* Message turns off echoing unless more keystrokes turn it on again. */
1452 if (echo_area_glyphs
&& *echo_area_glyphs
&& echo_area_glyphs
!= echobuf
)
1455 /* If already echoing, continue. */
1458 /* If in middle of key sequence and minibuffer not active,
1459 start echoing if enough time elapses. */
1460 if (minibuf_level
== 0 && !immediate_echo
&& this_command_key_count
> 0
1462 && echo_keystrokes
> 0
1463 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0))
1467 /* After a mouse event, start echoing right away.
1468 This is because we are probably about to display a menu,
1469 and we don't want to delay before doing so. */
1470 if (EVENT_HAS_PARAMETERS (prev_event
))
1474 tem0
= sit_for (echo_keystrokes
, 0, 1, 1);
1480 /* Maybe auto save due to number of keystrokes or idle time. */
1482 if (commandflag
!= 0
1483 && auto_save_interval
> 0
1484 && num_nonmacro_input_chars
- last_auto_save
> max (auto_save_interval
, 20)
1485 && !detect_input_pending ())
1488 save_getcjmp (temp
);
1489 Fdo_auto_save (Qnil
, Qnil
);
1490 restore_getcjmp (temp
);
1493 /* Try reading a character via menu prompting.
1494 Try this before the sit-for, because the sit-for
1495 would do the wrong thing if we are supposed to do
1498 if (INTERACTIVE
&& !NILP (prev_event
))
1499 c
= read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1501 /* Slow down auto saves logarithmically in size of current buffer,
1502 and garbage collect while we're at it. */
1503 if (INTERACTIVE
&& NILP (c
))
1505 int delay_level
, buffer_size
;
1507 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1508 last_non_minibuf_size
= Z
- BEG
;
1509 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1511 while (buffer_size
> 64)
1512 delay_level
++, buffer_size
-= buffer_size
>> 2;
1513 if (delay_level
< 4) delay_level
= 4;
1514 /* delay_level is 4 for files under around 50k, 7 at 100k,
1515 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
1517 /* Auto save if enough time goes by without input. */
1518 if (commandflag
!= 0
1519 && num_nonmacro_input_chars
> last_auto_save
1520 && XTYPE (Vauto_save_timeout
) == Lisp_Int
1521 && XINT (Vauto_save_timeout
) > 0)
1524 int delay
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
1525 tem0
= sit_for (delay
, 0, 1, 1);
1529 save_getcjmp (temp
);
1530 Fdo_auto_save (Qnil
, Qnil
);
1531 restore_getcjmp (temp
);
1533 /* If we have auto-saved and there is still no input
1534 available, garbage collect if there has been enough
1535 consing going on to make it worthwhile. */
1536 if (!detect_input_pending ()
1537 && consing_since_gc
> gc_cons_threshold
/ 2)
1539 Fgarbage_collect ();
1540 /* prepare_menu_bars isn't safe here, but it should
1541 also be unnecessary. */
1548 /* Actually read a character, waiting if necessary. */
1551 c
= kbd_buffer_get_event ();
1554 if (commandflag
>= 0 && !input_pending
&& !detect_input_pending ())
1558 /* Terminate Emacs in batch mode if at eof. */
1559 if (noninteractive
&& XTYPE (c
) == Lisp_Int
&& XINT (c
) < 0)
1560 Fkill_emacs (make_number (1));
1562 if (XTYPE (c
) == Lisp_Int
)
1564 /* Add in any extra modifiers, where appropriate. */
1565 if ((extra_keyboard_modifiers
& CHAR_CTL
)
1566 || ((extra_keyboard_modifiers
& 0177) < ' '
1567 && (extra_keyboard_modifiers
& 0177) != 0))
1568 XSETINT (c
, make_ctrl_char (XINT (c
)));
1570 /* Transfer any other modifier bits directly from
1571 extra_keyboard_modifiers to c. Ignore the actual character code
1572 in the low 16 bits of extra_keyboard_modifiers. */
1573 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
1578 restore_getcjmp (save_jump
);
1582 echo_area_glyphs
= 0;
1584 /* Handle things that only apply to characters. */
1585 if (XTYPE (c
) == Lisp_Int
)
1587 /* If kbd_buffer_get_event gave us an EOF, return that. */
1591 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
1592 && XSTRING (Vkeyboard_translate_table
)->size
> XFASTINT (c
))
1593 XSETINT (c
, XSTRING (Vkeyboard_translate_table
)->data
[XFASTINT (c
)]);
1597 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
1598 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1599 recent_keys_index
= 0;
1601 /* Write c to the dribble file. If c is a lispy event, write
1602 the event's symbol to the dribble file, in <brackets>. Bleaugh.
1603 If you, dear reader, have a better idea, you've got the source. :-) */
1606 if (XTYPE (c
) == Lisp_Int
)
1607 putc (XINT (c
), dribble
);
1610 Lisp_Object dribblee
= c
;
1612 /* If it's a structured event, take the event header. */
1613 dribblee
= EVENT_HEAD (dribblee
);
1615 if (XTYPE (dribblee
) == Lisp_Symbol
)
1617 putc ('<', dribble
);
1618 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
1619 XSYMBOL (dribblee
)->name
->size
,
1621 putc ('>', dribble
);
1628 store_kbd_macro_char (c
);
1630 num_nonmacro_input_chars
++;
1635 /* Record this character as part of the current key.
1636 Don't record mouse motion; it should never matter. */
1637 if (! (EVENT_HAS_PARAMETERS (c
)
1638 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
1641 add_command_key (c
);
1644 /* Re-reading in the middle of a command */
1646 last_input_char
= c
;
1649 /* Process the help character specially if enabled */
1650 if (EQ (c
, Vhelp_char
) && !NILP (Vhelp_form
))
1653 count
= specpdl_ptr
- specpdl
;
1655 record_unwind_protect (Fset_window_configuration
,
1656 Fcurrent_window_configuration (Qnil
));
1658 tem0
= Feval (Vhelp_form
);
1659 if (XTYPE (tem0
) == Lisp_String
)
1660 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
1663 c
= read_char (0, 0, 0, Qnil
, 0);
1664 /* Remove the help from the frame */
1665 unbind_to (count
, Qnil
);
1666 prepare_menu_bars ();
1668 if (EQ (c
, make_number (040)))
1671 c
= read_char (0, 0, 0, Qnil
, 0);
1682 Fprinc (object
, Qnil
);
1686 /* Copy out or in the info on where C-g should throw to.
1687 This is used when running Lisp code from within get_char,
1688 in case get_char is called recursively.
1689 See read_process_output. */
1694 bcopy (getcjmp
, temp
, sizeof getcjmp
);
1697 restore_getcjmp (temp
)
1700 bcopy (temp
, getcjmp
, sizeof getcjmp
);
1704 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1705 of this function. */
1707 tracking_off (old_value
)
1708 Lisp_Object old_value
;
1710 if (! XFASTINT (old_value
))
1712 do_mouse_tracking
= 0;
1714 /* Redisplay may have been preempted because there was input
1715 available, and it assumes it will be called again after the
1716 input has been processed. If the only input available was
1717 the sort that we have just disabled, then we need to call
1719 if (!readable_events ())
1721 prepare_menu_bars ();
1722 redisplay_preserve_echo_area ();
1723 get_input_pending (&input_pending
);
1728 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1729 "Evaluate BODY with mouse movement events enabled.\n\
1730 Within a `track-mouse' form, mouse motion generates input events that\n\
1731 you can read with `read-event'.\n\
1732 Normally, mouse motion is ignored.")
1736 int count
= specpdl_ptr
- specpdl
;
1739 XSET (val
, Lisp_Int
, do_mouse_tracking
);
1740 record_unwind_protect (tracking_off
, val
);
1742 do_mouse_tracking
= 1;
1744 val
= Fprogn (args
);
1745 return unbind_to (count
, val
);
1748 /* Low level keyboard/mouse input.
1749 kbd_buffer_store_event places events in kbd_buffer, and
1750 kbd_buffer_get_event retrieves them.
1751 mouse_moved indicates when the mouse has moved again, and
1752 *mouse_position_hook provides the mouse position. */
1754 /* Return true iff there are any events in the queue that read-char
1755 would return. If this returns false, a read-char would block. */
1759 return ! EVENT_QUEUES_EMPTY
;
1762 /* Set this for debugging, to have a way to get out */
1765 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
1768 kbd_buffer_store_event (event
)
1769 register struct input_event
*event
;
1771 if (event
->kind
== no_event
)
1774 if (event
->kind
== ascii_keystroke
)
1776 register int c
= event
->code
& 0377;
1778 if (event
->modifiers
& ctrl_modifier
)
1779 c
= make_ctrl_char (c
);
1781 c
|= (event
->modifiers
1782 & (meta_modifier
| alt_modifier
1783 | hyper_modifier
| super_modifier
));
1787 extern SIGTYPE
interrupt_signal ();
1790 /* If this results in a quit_char being returned to Emacs as
1791 input, set Vlast_event_frame properly. If this doesn't
1792 get returned to Emacs as an event, the next event read
1793 will set Vlast_event_frame again, so this is safe to do. */
1796 = FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
1799 internal_last_event_frame
= event
->frame_or_window
;
1801 internal_last_event_frame
= focus
;
1802 Vlast_event_frame
= internal_last_event_frame
;
1806 last_event_timestamp
= event
->timestamp
;
1807 interrupt_signal ();
1811 if (c
&& c
== stop_character
)
1818 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
1819 kbd_store_ptr
= kbd_buffer
;
1821 /* Don't let the very last slot in the buffer become full,
1822 since that would make the two pointers equal,
1823 and that is indistinguishable from an empty buffer.
1824 Discard the event if it would fill the last slot. */
1825 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
1827 kbd_store_ptr
->kind
= event
->kind
;
1828 if (event
->kind
== selection_request_event
)
1830 /* We must not use the ordinary copying code for this case,
1831 since `part' is an enum and copying it might not copy enough
1833 bcopy (event
, kbd_store_ptr
, sizeof (*event
));
1837 kbd_store_ptr
->code
= event
->code
;
1838 kbd_store_ptr
->part
= event
->part
;
1839 kbd_store_ptr
->frame_or_window
= event
->frame_or_window
;
1840 kbd_store_ptr
->modifiers
= event
->modifiers
;
1841 kbd_store_ptr
->x
= event
->x
;
1842 kbd_store_ptr
->y
= event
->y
;
1843 kbd_store_ptr
->timestamp
= event
->timestamp
;
1845 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
1847 = event
->frame_or_window
);
1853 /* Read one event from the event buffer, waiting if necessary.
1854 The value is a Lisp object representing the event.
1855 The value is nil for an event that should be ignored,
1856 or that was handled here.
1857 We always read and discard one event. */
1860 kbd_buffer_get_event ()
1868 XSET (obj
, Lisp_Int
, c
);
1872 /* Wait until there is input available. */
1875 if (!EVENT_QUEUES_EMPTY
)
1878 /* If the quit flag is set, then read_char will return
1879 quit_char, so that counts as "available input." */
1880 if (!NILP (Vquit_flag
))
1881 quit_throw_to_read_char ();
1883 /* One way or another, wait until input is available; then, if
1884 interrupt handlers have not read it, read it now. */
1887 wait_for_kbd_input ();
1889 /* Note SIGIO has been undef'd if FIONREAD is missing. */
1893 if (EVENT_QUEUES_EMPTY
)
1895 Lisp_Object minus_one
;
1897 XSET (minus_one
, Lisp_Int
, -1);
1898 wait_reading_process_input (0, 0, minus_one
, 1);
1900 if (!interrupt_input
&& EVENT_QUEUES_EMPTY
)
1902 read_avail_input (0);
1905 #endif /* not VMS */
1908 /* At this point, we know that there is a readable event available
1909 somewhere. If the event queue is empty, then there must be a
1910 mouse movement enabled and available. */
1911 if (kbd_fetch_ptr
!= kbd_store_ptr
)
1913 struct input_event
*event
;
1915 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
1919 last_event_timestamp
= event
->timestamp
;
1923 /* These two kinds of events get special handling
1924 and don't actually appear to the command loop.
1925 We return nil for them. */
1926 if (event
->kind
== selection_request_event
)
1929 x_handle_selection_request (event
);
1930 kbd_fetch_ptr
= event
+ 1;
1932 /* We're getting selection request events, but we don't have
1938 else if (event
->kind
== selection_clear_event
)
1941 x_handle_selection_clear (event
);
1942 kbd_fetch_ptr
= event
+ 1;
1944 /* We're getting selection request events, but we don't have
1950 else if (event
->kind
== delete_window_event
)
1952 Lisp_Object tail
, frame
;
1955 /* If the user destroys the only frame, Emacs should exit.
1956 Count visible frames and iconified frames. */
1957 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1959 frame
= XCONS (tail
)->car
;
1960 if (XTYPE (frame
) != Lisp_Frame
|| EQ (frame
, event
->frame_or_window
))
1963 if (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
))
1968 kill (getpid (), SIGHUP
);
1970 Fdelete_frame (event
->frame_or_window
, Qt
);
1971 kbd_fetch_ptr
= event
+ 1;
1974 /* Just discard these, by returning nil.
1975 (They shouldn't be found in the buffer,
1976 but on some machines it appears they do show up.) */
1977 else if (event
->kind
== no_event
)
1978 kbd_fetch_ptr
= event
+ 1;
1980 /* If this event is on a different frame, return a switch-frame this
1981 time, and leave the event in the queue for next time. */
1985 Lisp_Object frame
= event
->frame_or_window
;
1988 if (XTYPE (frame
) == Lisp_Window
)
1989 frame
= WINDOW_FRAME (XWINDOW (frame
));
1991 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
1995 if (! EQ (frame
, internal_last_event_frame
)
1996 && XFRAME (frame
) != selected_frame
)
1997 obj
= make_lispy_switch_frame (frame
);
1998 internal_last_event_frame
= frame
;
1999 #endif /* MULTI_FRAME */
2001 /* If we didn't decide to make a switch-frame event, go ahead
2002 and build a real event from the queue entry. */
2006 obj
= make_lispy_event (event
);
2008 /* Wipe out this event, to catch bugs. */
2009 event
->kind
= no_event
;
2010 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
]
2013 kbd_fetch_ptr
= event
+ 1;
2017 /* Try generating a mouse motion event. */
2018 else if (do_mouse_tracking
&& mouse_moved
)
2021 Lisp_Object bar_window
;
2022 enum scroll_bar_part part
;
2026 (*mouse_position_hook
) (&f
, &bar_window
, &part
, &x
, &y
, &time
);
2031 /* Decide if we should generate a switch-frame event. Don't
2032 generate switch-frame events for motion outside of all Emacs
2036 Lisp_Object frame
= FRAME_FOCUS_FRAME (f
);
2039 XSET (frame
, Lisp_Frame
, f
);
2041 if (! EQ (frame
, internal_last_event_frame
)
2042 && XFRAME (frame
) != selected_frame
)
2043 obj
= make_lispy_switch_frame (frame
);
2044 internal_last_event_frame
= frame
;
2048 /* If we didn't decide to make a switch-frame event, go ahead and
2049 return a mouse-motion event. */
2051 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2054 /* We were promised by the above while loop that there was
2055 something for us to read! */
2058 input_pending
= readable_events ();
2061 Vlast_event_frame
= internal_last_event_frame
;
2067 /* Process any events that are not user-visible,
2068 then return, without reading any user-visible events. */
2073 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2075 struct input_event
*event
;
2077 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2081 last_event_timestamp
= event
->timestamp
;
2083 /* These two kinds of events get special handling
2084 and don't actually appear to the command loop. */
2085 if (event
->kind
== selection_request_event
)
2088 x_handle_selection_request (event
);
2089 kbd_fetch_ptr
= event
+ 1;
2091 /* We're getting selection request events, but we don't have
2097 else if (event
->kind
== selection_clear_event
)
2100 x_handle_selection_clear (event
);
2101 kbd_fetch_ptr
= event
+ 1;
2103 /* We're getting selection request events, but we don't have
2112 get_input_pending (&input_pending
);
2115 /* Caches for modify_event_symbol. */
2116 static Lisp_Object accent_key_syms
;
2117 static Lisp_Object func_key_syms
;
2118 static Lisp_Object mouse_syms
;
2120 /* This is a list of keysym codes for special "accent" characters.
2121 It parallels lispy_accent_keys. */
2123 static int lispy_accent_codes
[] =
2136 XK_dead_doubleacute
,
2140 /* This is a list of Lisp names for special "accent" characters.
2141 It parallels lispy_accent_codes. */
2143 static char *lispy_accent_keys
[] =
2160 /* You'll notice that this table is arranged to be conveniently
2161 indexed by X Windows keysym values. */
2162 static char *lispy_function_keys
[] =
2164 /* X Keysym value */
2166 "remove", 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
2174 0, 0, 0, /* 0xff10 */
2176 0, 0, 0, 0, 0, 0, 0,
2179 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
2180 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
2181 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
2183 "home", /* 0xff50 */ /* IsCursorKey */
2194 "select", /* 0xff60 */ /* IsMiscFunctionKey */
2205 "break", /* 0xff6b */
2207 /* Here are some keys found mostly on HP keyboards. The X event
2208 handling code will strip bit 29, which flags vendor-specific
2210 "reset", /* 0x1000ff6c */
2219 "kp-backtab", /* 0x1000ff75 */
2221 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
2222 "kp-space", /* 0xff80 */ /* IsKeypadKey */
2223 0, 0, 0, 0, 0, 0, 0, 0,
2224 "kp-tab", /* 0xff89 */
2226 "kp-enter", /* 0xff8d */
2228 "kp-f1", /* 0xff91 */
2233 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2234 "kp-multiply", /* 0xffaa */
2239 "kp-divide", /* 0xffaf */
2240 "kp-0", /* 0xffb0 */
2241 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
2244 "kp-equal", /* 0xffbd */
2245 "f1", /* 0xffbe */ /* IsFunctionKey */
2247 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
2248 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
2249 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
2250 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
2251 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
2252 0, 0, 0, 0, 0, 0, 0, 0,
2253 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
2254 0, 0, 0, 0, 0, 0, 0, "delete"
2257 static char *lispy_mouse_names
[] =
2259 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
2262 /* Scroll bar parts. */
2263 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
2265 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
2266 Lisp_Object
*scroll_bar_parts
[] = {
2267 &Qabove_handle
, &Qhandle
, &Qbelow_handle
2271 /* A vector, indexed by button number, giving the down-going location
2272 of currently depressed buttons, both scroll bar and non-scroll bar.
2274 The elements have the form
2275 (BUTTON-NUMBER MODIFIER-MASK . REST)
2276 where REST is the cdr of a position as it would be reported in the event.
2278 The make_lispy_event function stores positions here to tell the
2279 difference between click and drag events, and to store the starting
2280 location to be included in drag events. */
2282 static Lisp_Object button_down_location
;
2284 /* Information about the most recent up-going button event: Which
2285 button, what location, and what time. */
2287 static int last_mouse_button
;
2288 static int last_mouse_x
;
2289 static int last_mouse_y
;
2290 static unsigned long button_down_time
;
2292 /* The maximum time between clicks to make a double-click,
2293 or Qnil to disable double-click detection,
2294 or Qt for no time limit. */
2295 Lisp_Object Vdouble_click_time
;
2297 /* The number of clicks in this multiple-click. */
2299 int double_click_count
;
2301 /* Given a struct input_event, build the lisp event which represents
2302 it. If EVENT is 0, build a mouse movement event from the mouse
2303 movement buffer, which should have a movement event in it.
2305 Note that events must be passed to this function in the order they
2306 are received; this function stores the location of button presses
2307 in order to build drag events when the button is released. */
2310 make_lispy_event (event
)
2311 struct input_event
*event
;
2313 #ifdef SWITCH_ENUM_BUG
2314 switch ((int) event
->kind
)
2316 switch (event
->kind
)
2319 /* A simple keystroke. */
2320 case ascii_keystroke
:
2322 int c
= event
->code
& 0377;
2323 /* Turn ASCII characters into control characters
2325 if (event
->modifiers
& ctrl_modifier
)
2326 c
= make_ctrl_char (c
);
2328 /* Add in the other modifier bits. We took care of ctrl_modifier
2329 just above, and the shift key was taken care of by the X code,
2330 and applied to control characters by make_ctrl_char. */
2331 c
|= (event
->modifiers
2332 & (meta_modifier
| alt_modifier
2333 | hyper_modifier
| super_modifier
));
2334 button_down_time
= 0;
2338 /* A function key. The symbol may need to have modifier prefixes
2340 case non_ascii_keystroke
:
2341 button_down_time
= 0;
2343 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
2344 if (event
->code
== lispy_accent_codes
[i
])
2345 return modify_event_symbol (i
,
2348 lispy_accent_keys
, &accent_key_syms
,
2349 (sizeof (lispy_accent_keys
)
2350 / sizeof (lispy_accent_keys
[0])));
2352 return modify_event_symbol (event
->code
- 0xff00,
2355 lispy_function_keys
, &func_key_syms
,
2356 (sizeof (lispy_function_keys
)
2357 / sizeof (lispy_function_keys
[0])));
2360 /* A mouse click. Figure out where it is, decide whether it's
2361 a press, click or drag, and build the appropriate structure. */
2363 case scroll_bar_click
:
2365 int button
= event
->code
;
2367 Lisp_Object position
;
2368 Lisp_Object
*start_pos_ptr
;
2369 Lisp_Object start_pos
;
2371 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
2374 /* Build the position as appropriate for this mouse click. */
2375 if (event
->kind
== mouse_click
)
2378 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
2380 = window_from_coordinates (f
, XINT (event
->x
), XINT (event
->y
),
2384 if (XINT (event
->y
) < FRAME_MENU_BAR_LINES (f
))
2388 items
= FRAME_MENU_BAR_ITEMS (f
);
2389 for (; CONSP (items
); items
= XCONS (items
)->cdr
)
2391 Lisp_Object pos
, string
;
2392 pos
= Fcdr (Fcdr (Fcar (items
)));
2393 string
= Fcar (Fcdr (Fcar (items
)));
2394 if (XINT (event
->x
) >= XINT (pos
)
2395 && XINT (event
->x
) < XINT (pos
) + XSTRING (string
)->size
)
2399 = Fcons (event
->frame_or_window
,
2401 Fcons (Fcons (event
->x
, event
->y
),
2402 Fcons (make_number (event
->timestamp
),
2406 return Fcons (Fcar (Fcar (items
)),
2407 Fcons (position
, Qnil
));
2409 return Fcons (Qnil
, Fcons (position
, Qnil
));
2411 else if (XTYPE (window
) != Lisp_Window
)
2416 (XINT (event
->x
) - XINT (XWINDOW (window
)->left
)));
2418 (XINT (event
->y
) - XINT (XWINDOW (window
)->top
)));
2423 posn
= Qvertical_line
;
2425 XSET (posn
, Lisp_Int
,
2426 buffer_posn_from_coords (XWINDOW (window
),
2434 Fcons (Fcons (event
->x
, event
->y
),
2435 Fcons (make_number (event
->timestamp
),
2440 Lisp_Object window
= event
->frame_or_window
;
2441 Lisp_Object portion_whole
= Fcons (event
->x
, event
->y
);
2442 Lisp_Object part
= *scroll_bar_parts
[(int) event
->part
];
2446 Fcons (Qvertical_scroll_bar
,
2447 Fcons (portion_whole
,
2448 Fcons (make_number (event
->timestamp
),
2453 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
2455 start_pos
= *start_pos_ptr
;
2456 *start_pos_ptr
= Qnil
;
2458 is_double
= (button
== last_mouse_button
2459 && XINT (event
->x
) == last_mouse_x
2460 && XINT (event
->y
) == last_mouse_y
2461 && button_down_time
!= 0
2462 && (EQ (Vdouble_click_time
, Qt
)
2463 || (INTEGERP (Vdouble_click_time
)
2464 && ((int)(event
->timestamp
- button_down_time
)
2465 < XINT (Vdouble_click_time
)))));
2466 last_mouse_button
= button
;
2467 last_mouse_x
= XINT (event
->x
);
2468 last_mouse_y
= XINT (event
->y
);
2470 /* If this is a button press, squirrel away the location, so
2471 we can decide later whether it was a click or a drag. */
2472 if (event
->modifiers
& down_modifier
)
2476 double_click_count
++;
2477 event
->modifiers
|= ((double_click_count
> 2)
2482 double_click_count
= 1;
2483 button_down_time
= event
->timestamp
;
2484 *start_pos_ptr
= Fcopy_alist (position
);
2487 /* Now we're releasing a button - check the co-ordinates to
2488 see if this was a click or a drag. */
2489 else if (event
->modifiers
& up_modifier
)
2491 /* If we did not see a down before this up,
2492 ignore the up. Probably this happened because
2493 the down event chose a menu item.
2494 It would be an annoyance to treat the release
2495 of the button that chose the menu item
2496 as a separate event. */
2498 if (XTYPE (start_pos
) != Lisp_Cons
)
2501 event
->modifiers
&= ~up_modifier
;
2502 #if 0 /* Formerly we treated an up with no down as a click event. */
2503 if (XTYPE (start_pos
) != Lisp_Cons
)
2504 event
->modifiers
|= click_modifier
;
2508 /* The third element of every position should be the (x,y)
2510 Lisp_Object down
= Fnth (make_number (2), start_pos
);
2512 if (EQ (event
->x
, XCONS (down
)->car
)
2513 && EQ (event
->y
, XCONS (down
)->cdr
))
2515 if (is_double
&& double_click_count
> 1)
2516 event
->modifiers
|= ((double_click_count
> 2)
2520 event
->modifiers
|= click_modifier
;
2524 button_down_time
= 0;
2525 event
->modifiers
|= drag_modifier
;
2530 /* Every mouse event should either have the down_modifier or
2531 the up_modifier set. */
2535 /* Get the symbol we should use for the mouse click. */
2537 = modify_event_symbol (button
,
2540 lispy_mouse_names
, &mouse_syms
,
2541 (sizeof (lispy_mouse_names
)
2542 / sizeof (lispy_mouse_names
[0])));
2544 if (event
->modifiers
& drag_modifier
)
2549 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
2552 Fcons (make_number (double_click_count
),
2561 /* The 'kind' field of the event is something we don't recognize. */
2568 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
2570 Lisp_Object bar_window
;
2571 enum scroll_bar_part part
;
2575 /* Is it a scroll bar movement? */
2576 if (frame
&& ! NILP (bar_window
))
2578 Lisp_Object part_sym
= *scroll_bar_parts
[(int) part
];
2580 return Fcons (Qscroll_bar_movement
,
2581 (Fcons (Fcons (bar_window
,
2582 Fcons (Qvertical_scroll_bar
,
2583 Fcons (Fcons (x
, y
),
2584 Fcons (make_number (time
),
2590 /* Or is it an ordinary mouse movement? */
2594 Lisp_Object window
=
2596 ? window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
)
2600 if (XTYPE (window
) == Lisp_Window
)
2602 XSETINT (x
, XINT (x
) - XINT (XWINDOW (window
)->left
));
2603 XSETINT (y
, XINT (y
) - XINT (XWINDOW (window
)->top
));
2608 posn
= Qvertical_line
;
2610 XSET (posn
, Lisp_Int
,
2611 buffer_posn_from_coords (XWINDOW (window
),
2612 XINT (x
), XINT (y
)));
2614 else if (frame
!= 0)
2616 XSET (window
, Lisp_Frame
, frame
);
2627 return Fcons (Qmouse_movement
,
2628 Fcons (Fcons (window
,
2630 Fcons (Fcons (x
, y
),
2631 Fcons (make_number (time
),
2637 /* Construct a switch frame event. */
2639 make_lispy_switch_frame (frame
)
2642 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
2645 /* Manipulating modifiers. */
2647 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
2649 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
2650 SYMBOL's name of the end of the modifiers; the string from this
2651 position is the unmodified symbol name.
2653 This doesn't use any caches. */
2655 parse_modifiers_uncached (symbol
, modifier_end
)
2659 struct Lisp_String
*name
;
2663 CHECK_SYMBOL (symbol
, 1);
2666 name
= XSYMBOL (symbol
)->name
;
2669 for (i
= 0; i
+2 <= name
->size
; )
2670 switch (name
->data
[i
])
2672 #define SINGLE_LETTER_MOD(bit) \
2673 if (name->data[i+1] != '-') \
2674 goto no_more_modifiers; \
2679 SINGLE_LETTER_MOD (alt_modifier
);
2683 SINGLE_LETTER_MOD (ctrl_modifier
);
2687 SINGLE_LETTER_MOD (hyper_modifier
);
2691 SINGLE_LETTER_MOD (meta_modifier
);
2695 SINGLE_LETTER_MOD (shift_modifier
);
2699 SINGLE_LETTER_MOD (super_modifier
);
2703 if (i
+ 5 > name
->size
)
2704 goto no_more_modifiers
;
2705 if (! strncmp (name
->data
+ i
, "drag-", 5))
2707 modifiers
|= drag_modifier
;
2710 else if (! strncmp (name
->data
+ i
, "down-", 5))
2712 modifiers
|= down_modifier
;
2715 else if (i
+ 7 <= name
->size
2716 && ! strncmp (name
->data
+ i
, "double-", 7))
2718 modifiers
|= double_modifier
;
2722 goto no_more_modifiers
;
2726 if (i
+ 7 > name
->size
)
2727 goto no_more_modifiers
;
2728 if (! strncmp (name
->data
+ i
, "triple-", 7))
2730 modifiers
|= triple_modifier
;
2734 goto no_more_modifiers
;
2738 goto no_more_modifiers
;
2740 #undef SINGLE_LETTER_MOD
2744 /* Should we include the `click' modifier? */
2745 if (! (modifiers
& (down_modifier
| drag_modifier
2746 | double_modifier
| triple_modifier
))
2747 && i
+ 7 == name
->size
2748 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
2749 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
2750 modifiers
|= click_modifier
;
2759 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
2760 prepended to the string BASE[0..BASE_LEN-1].
2761 This doesn't use any caches. */
2763 apply_modifiers_uncached (modifiers
, base
, base_len
)
2768 /* Since BASE could contain nulls, we can't use intern here; we have
2769 to use Fintern, which expects a genuine Lisp_String, and keeps a
2772 (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
2778 /* Only the event queue may use the `up' modifier; it should always
2779 be turned into a click or drag event before presented to lisp code. */
2780 if (modifiers
& up_modifier
)
2783 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
2784 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
2785 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
2786 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
2787 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
2788 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
2789 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
2790 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
2791 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
2792 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
2793 /* The click modifier is denoted by the absence of other modifiers. */
2797 mod_len
= p
- new_mods
;
2801 Lisp_Object new_name
= make_uninit_string (mod_len
+ base_len
);
2803 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
2804 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len
);
2806 return Fintern (new_name
, Qnil
);
2811 static char *modifier_names
[] =
2813 "up", "down", "drag", "click", "double", "triple", 0, 0,
2814 0, 0, 0, 0, 0, 0, 0, 0,
2815 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
2817 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
2819 static Lisp_Object modifier_symbols
;
2821 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
2823 lispy_modifier_list (modifiers
)
2826 Lisp_Object modifier_list
;
2829 modifier_list
= Qnil
;
2830 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
2831 if (modifiers
& (1<<i
))
2832 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
2835 return modifier_list
;
2839 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
2840 where UNMODIFIED is the unmodified form of SYMBOL,
2841 MASK is the set of modifiers present in SYMBOL's name.
2842 This is similar to parse_modifiers_uncached, but uses the cache in
2843 SYMBOL's Qevent_symbol_element_mask property, and maintains the
2844 Qevent_symbol_elements property. */
2846 parse_modifiers (symbol
)
2849 Lisp_Object elements
= Fget (symbol
, Qevent_symbol_element_mask
);
2851 if (CONSP (elements
))
2856 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
2857 Lisp_Object unmodified
2858 = Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
2859 XSYMBOL (symbol
)->name
->size
- end
),
2863 if (modifiers
& ~((1<<VALBITS
) - 1))
2865 XFASTINT (mask
) = modifiers
;
2866 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
2868 /* Cache the parsing results on SYMBOL. */
2869 Fput (symbol
, Qevent_symbol_element_mask
,
2871 Fput (symbol
, Qevent_symbol_elements
,
2872 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
2874 /* Since we know that SYMBOL is modifiers applied to unmodified,
2875 it would be nice to put that in unmodified's cache.
2876 But we can't, since we're not sure that parse_modifiers is
2883 /* Apply the modifiers MODIFIERS to the symbol BASE.
2884 BASE must be unmodified.
2886 This is like apply_modifiers_uncached, but uses BASE's
2887 Qmodifier_cache property, if present. It also builds
2888 Qevent_symbol_elements properties, since it has that info anyway.
2890 apply_modifiers copies the value of BASE's Qevent_kind property to
2891 the modified symbol. */
2893 apply_modifiers (modifiers
, base
)
2897 Lisp_Object cache
, index
, entry
, new_symbol
;
2899 /* Mask out upper bits. We don't know where this value's been. */
2900 modifiers
&= (1<<VALBITS
) - 1;
2902 /* The click modifier never figures into cache indices. */
2903 cache
= Fget (base
, Qmodifier_cache
);
2904 XFASTINT (index
) = (modifiers
& ~click_modifier
);
2905 entry
= Fassq (index
, cache
);
2908 new_symbol
= XCONS (entry
)->cdr
;
2911 /* We have to create the symbol ourselves. */
2912 new_symbol
= apply_modifiers_uncached (modifiers
,
2913 XSYMBOL (base
)->name
->data
,
2914 XSYMBOL (base
)->name
->size
);
2916 /* Add the new symbol to the base's cache. */
2917 entry
= Fcons (index
, new_symbol
);
2918 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
2920 /* We have the parsing info now for free, so add it to the caches. */
2921 XFASTINT (index
) = modifiers
;
2922 Fput (new_symbol
, Qevent_symbol_element_mask
,
2923 Fcons (base
, Fcons (index
, Qnil
)));
2924 Fput (new_symbol
, Qevent_symbol_elements
,
2925 Fcons (base
, lispy_modifier_list (modifiers
)));
2928 /* Make sure this symbol is of the same kind as BASE.
2930 You'd think we could just set this once and for all when we
2931 intern the symbol above, but reorder_modifiers may call us when
2932 BASE's property isn't set right; we can't assume that just
2933 because it has a Qmodifier_cache property it must have its
2934 Qevent_kind set right as well. */
2935 if (NILP (Fget (new_symbol
, Qevent_kind
)))
2937 Lisp_Object kind
= Fget (base
, Qevent_kind
);
2940 Fput (new_symbol
, Qevent_kind
, kind
);
2947 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
2948 return a symbol with the modifiers placed in the canonical order.
2949 Canonical order is alphabetical, except for down and drag, which
2950 always come last. The 'click' modifier is never written out.
2952 Fdefine_key calls this to make sure that (for example) C-M-foo
2953 and M-C-foo end up being equivalent in the keymap. */
2956 reorder_modifiers (symbol
)
2959 /* It's hopefully okay to write the code this way, since everything
2960 will soon be in caches, and no consing will be done at all. */
2961 Lisp_Object parsed
= parse_modifiers (symbol
);
2963 return apply_modifiers (XCONS (XCONS (parsed
)->cdr
)->car
,
2964 XCONS (parsed
)->car
);
2968 /* For handling events, we often want to produce a symbol whose name
2969 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
2970 to some base, like the name of a function key or mouse button.
2971 modify_event_symbol produces symbols of this sort.
2973 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
2974 is the name of the i'th symbol. TABLE_SIZE is the number of elements
2977 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
2978 persist between calls to modify_event_symbol that it can use to
2979 store a cache of the symbols it's generated for this NAME_TABLE
2982 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
2984 MODIFIERS is a set of modifier bits (as given in struct input_events)
2985 whose prefixes should be applied to the symbol name.
2987 SYMBOL_KIND is the value to be placed in the event_kind property of
2988 the returned symbol.
2990 The symbols we create are supposed to have an
2991 `event-symbol-elements' property, which lists the modifiers present
2992 in the symbol's name. */
2995 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_table
,
2996 symbol_table
, table_size
)
2999 Lisp_Object symbol_kind
;
3001 Lisp_Object
*symbol_table
;
3006 /* Is this a request for a valid symbol? */
3007 if (symbol_num
< 0 || symbol_num
>= table_size
)
3010 /* If *symbol_table doesn't seem to be initialized properly, fix that.
3011 *symbol_table should be a lisp vector TABLE_SIZE elements long,
3012 where the Nth element is the symbol for NAME_TABLE[N], or nil if
3013 we've never used that symbol before. */
3014 if (XTYPE (*symbol_table
) != Lisp_Vector
3015 || XVECTOR (*symbol_table
)->size
!= table_size
)
3019 XFASTINT (size
) = table_size
;
3020 *symbol_table
= Fmake_vector (size
, Qnil
);
3023 slot
= & XVECTOR (*symbol_table
)->contents
[symbol_num
];
3025 /* Have we already used this symbol before? */
3028 /* No; let's create it. */
3029 if (name_table
[symbol_num
])
3030 *slot
= intern (name_table
[symbol_num
]);
3034 sprintf (buf
, "key-%d", symbol_num
);
3035 *slot
= intern (buf
);
3038 /* Fill in the cache entries for this symbol; this also
3039 builds the Qevent_symbol_elements property, which the user
3041 apply_modifiers (modifiers
& click_modifier
, *slot
);
3042 Fput (*slot
, Qevent_kind
, symbol_kind
);
3045 /* Apply modifiers to that symbol. */
3046 return apply_modifiers (modifiers
, *slot
);
3050 /* Store into *addr a value nonzero if terminal input chars are available.
3051 Serves the purpose of ioctl (0, FIONREAD, addr)
3052 but works even if FIONREAD does not exist.
3053 (In fact, this may actually read some input.) */
3056 get_input_pending (addr
)
3059 /* First of all, have we already counted some input? */
3060 *addr
= !NILP (Vquit_flag
) || readable_events ();
3062 /* If input is being read as it arrives, and we have none, there is none. */
3063 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
3066 /* Try to read some input and see how much we get. */
3068 *addr
= !NILP (Vquit_flag
) || readable_events ();
3071 /* Interface to read_avail_input, blocking SIGIO if necessary. */
3074 gobble_input (expected
)
3079 if (interrupt_input
)
3082 mask
= sigblockx (SIGIO
);
3083 read_avail_input (expected
);
3088 read_avail_input (expected
);
3094 /* Read any terminal input already buffered up by the system
3095 into the kbd_buffer, but do not wait.
3097 EXPECTED should be nonzero if the caller knows there is some input.
3099 Except on VMS, all input is read by this function.
3100 If interrupt_input is nonzero, this function MUST be called
3101 only when SIGIO is blocked.
3103 Returns the number of keyboard chars read, or -1 meaning
3104 this is a bad time to try to read input. */
3107 read_avail_input (expected
)
3110 struct input_event buf
[KBD_BUFFER_SIZE
];
3114 if (read_socket_hook
)
3115 /* No need for FIONREAD or fcntl; just say don't wait. */
3116 nread
= (*read_socket_hook
) (0, buf
, KBD_BUFFER_SIZE
, expected
, expected
);
3119 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
3120 the kbd_buffer can really hold. That may prevent loss
3121 of characters on some systems when input is stuffed at us. */
3122 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
3125 /* Find out how much input is available. */
3126 if (ioctl (0, FIONREAD
, &nread
) < 0)
3127 /* Formerly simply reported no input, but that sometimes led to
3128 a failure of Emacs to terminate.
3129 SIGHUP seems appropriate if we can't reach the terminal. */
3130 /* ??? Is it really right to send the signal just to this process
3131 rather than to the whole process group?
3132 Perhaps on systems with FIONREAD Emacs is alone in its group. */
3133 kill (getpid (), SIGHUP
);
3136 if (nread
> sizeof cbuf
)
3137 nread
= sizeof cbuf
;
3138 #else /* no FIONREAD */
3139 #if defined(USG) || defined(DGUX)
3140 /* Read some input if available, but don't wait. */
3141 nread
= sizeof cbuf
;
3142 fcntl (fileno (stdin
), F_SETFL
, O_NDELAY
);
3148 /* Now read; for one reason or another, this will not block. */
3151 nread
= read (fileno (stdin
), cbuf
, nread
);
3153 /* The kernel sometimes fails to deliver SIGHUP for ptys.
3154 This looks incorrect, but it isn't, because _BSD causes
3155 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
3156 and that causes a value other than 0 when there is no input. */
3160 /* This code is wrong, but at least it gets the right results.
3161 Fix it for 19.23. */
3162 /* Retry the read if it is interrupted. */
3164 || ! (errno
== EAGAIN
|| errno
== EFAULT
3174 fcntl (fileno (stdin
), F_SETFL
, 0);
3176 #endif /* no FIONREAD */
3177 for (i
= 0; i
< nread
; i
++)
3179 buf
[i
].kind
= ascii_keystroke
;
3180 buf
[i
].modifiers
= 0;
3181 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
3182 buf
[i
].modifiers
= meta_modifier
;
3186 XSET (buf
[i
].code
, Lisp_Int
, cbuf
[i
]);
3188 XSET (buf
[i
].frame_or_window
, Lisp_Frame
, selected_frame
);
3190 buf
[i
].frame_or_window
= Qnil
;
3195 /* Scan the chars for C-g and store them in kbd_buffer. */
3196 for (i
= 0; i
< nread
; i
++)
3198 kbd_buffer_store_event (&buf
[i
]);
3199 /* Don't look at input that follows a C-g too closely.
3200 This reduces lossage due to autorepeat on C-g. */
3201 if (buf
[i
].kind
== ascii_keystroke
3202 && XINT(buf
[i
].code
) == quit_char
)
3208 #endif /* not VMS */
3210 #ifdef SIGIO /* for entire page */
3211 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3214 input_available_signal (signo
)
3217 /* Must preserve main program's value of errno. */
3218 int old_errno
= errno
;
3220 extern int select_alarmed
;
3224 /* USG systems forget handlers when they are used;
3225 must reestablish each time */
3226 signal (signo
, input_available_signal
);
3233 if (input_available_clear_time
)
3234 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
3239 nread
= read_avail_input (1);
3240 /* -1 means it's not ok to read the input now.
3241 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
3242 0 means there was no keyboard input available. */
3247 select_alarmed
= 1; /* Force the select emulator back to life */
3258 /* Send ourselves a SIGIO.
3260 This function exists so that the UNBLOCK_INPUT macro in
3261 blockinput.h can have some way to take care of input we put off
3262 dealing with, without assuming that every file which uses
3263 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
3265 reinvoke_input_signal ()
3274 /* Return the prompt-string of a sparse keymap.
3275 This is the first element which is a string.
3276 Return nil if there is none. */
3284 register Lisp_Object tem
;
3286 if (XTYPE (tem
) == Lisp_String
)
3293 static Lisp_Object
menu_bar_item ();
3294 static Lisp_Object
menu_bar_one_keymap ();
3296 /* Return a list of menu items for a menu bar, appropriate
3297 to the current buffer.
3298 The elements have the form (KEY STRING . nil). */
3303 /* The number of keymaps we're scanning right now, and the number of
3304 keymaps we have allocated space for. */
3307 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3308 in the current keymaps, or nil where it is not a prefix. */
3311 Lisp_Object def
, tem
, tail
;
3318 /* In order to build the menus, we need to call the keymap
3319 accessors. They all call QUIT. But this function is called
3320 during redisplay, during which a quit is fatal. So inhibit
3321 quitting while building the menus.
3322 We do this instead of specbind because (1) errors will clear it anyway
3323 and (2) this avoids risk of specpdl overflow. */
3324 oquit
= Vinhibit_quit
;
3327 /* Build our list of keymaps.
3328 If we recognize a function key and replace its escape sequence in
3329 keybuf with its symbol, or if the sequence starts with a mouse
3330 click and we need to switch buffers, we jump back here to rebuild
3331 the initial keymaps from the current buffer. */
3335 nmaps
= current_minor_maps (0, &tmaps
) + 2;
3336 maps
= (Lisp_Object
*) alloca (nmaps
* sizeof (maps
[0]));
3337 bcopy (tmaps
, maps
, (nmaps
- 2) * sizeof (maps
[0]));
3338 #ifdef USE_TEXT_PROPERTIES
3339 maps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3341 maps
[nmaps
-2] = current_buffer
->keymap
;
3343 maps
[nmaps
-1] = current_global_map
;
3346 /* Look up in each map the dummy prefix key `menu-bar'. */
3350 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
3352 if (! NILP (maps
[mapno
]))
3353 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0));
3357 tem
= Fkeymapp (def
);
3359 result
= menu_bar_one_keymap (def
, result
);
3362 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
3366 elt
= Fassq (XCONS (tail
)->car
, result
);
3368 result
= Fcons (elt
, Fdelq (elt
, result
));
3371 result
= Fnreverse (result
);
3372 Vinhibit_quit
= oquit
;
3376 /* Scan one map KEYMAP, accumulating any menu items it defines
3377 that have not yet been seen in RESULT. Return the updated RESULT. */
3380 menu_bar_one_keymap (keymap
, result
)
3381 Lisp_Object keymap
, result
;
3383 Lisp_Object tail
, item
, key
, binding
, item_string
, table
;
3385 /* Loop over all keymap entries that have menu strings. */
3386 for (tail
= keymap
; XTYPE (tail
) == Lisp_Cons
; tail
= XCONS (tail
)->cdr
)
3388 item
= XCONS (tail
)->car
;
3389 if (XTYPE (item
) == Lisp_Cons
)
3391 key
= XCONS (item
)->car
;
3392 binding
= XCONS (item
)->cdr
;
3393 if (XTYPE (binding
) == Lisp_Cons
)
3395 item_string
= XCONS (binding
)->car
;
3396 if (XTYPE (item_string
) == Lisp_String
)
3397 result
= menu_bar_item (key
, item_string
,
3398 Fcdr (binding
), result
);
3400 else if (EQ (binding
, Qundefined
))
3401 result
= menu_bar_item (key
, item_string
,
3404 else if (XTYPE (item
) == Lisp_Vector
)
3406 /* Loop over the char values represented in the vector. */
3407 int len
= XVECTOR (item
)->size
;
3409 for (c
= 0; c
< len
; c
++)
3411 Lisp_Object character
;
3412 XFASTINT (character
) = c
;
3413 binding
= XVECTOR (item
)->contents
[c
];
3414 if (XTYPE (binding
) == Lisp_Cons
)
3416 item_string
= XCONS (binding
)->car
;
3417 if (XTYPE (item_string
) == Lisp_String
)
3418 result
= menu_bar_item (key
, item_string
,
3419 Fcdr (binding
), result
);
3421 else if (EQ (binding
, Qundefined
))
3422 result
= menu_bar_item (key
, item_string
,
3432 menu_bar_item (key
, item_string
, def
, result
)
3433 Lisp_Object key
, item_string
, def
, result
;
3436 Lisp_Object enabled
;
3438 if (EQ (def
, Qundefined
))
3440 /* If a map has an explicit nil as definition,
3441 discard any previously made menu bar item. */
3442 tem
= Fassq (key
, result
);
3443 return Fdelq (tem
, result
);
3446 /* See if this entry is enabled. */
3449 if (XTYPE (def
) == Lisp_Symbol
)
3451 /* No property, or nil, means enable.
3452 Otherwise, enable if value is not nil. */
3453 tem
= Fget (def
, Qmenu_enable
);
3455 enabled
= Feval (tem
);
3458 /* Add an entry for this key and string
3459 if there is none yet. */
3460 tem
= Fassq (key
, result
);
3461 if (!NILP (enabled
) && NILP (tem
))
3462 result
= Fcons (Fcons (key
, Fcons (item_string
, Qnil
)), result
);
3467 /* Read a character using menus based on maps in the array MAPS.
3468 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
3469 Return t if we displayed a menu but the user rejected it.
3471 PREV_EVENT is the previous input event, or nil if we are reading
3472 the first event of a key sequence.
3474 If USED_MOUSE_MENU is non-zero, then we set *USED_MOUSE_MENU to 1
3475 if we used a mouse menu to read the input, or zero otherwise. If
3476 USED_MOUSE_MENU is zero, *USED_MOUSE_MENU is left alone.
3478 The prompting is done based on the prompt-string of the map
3479 and the strings associated with various map elements. */
3482 read_char_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
3485 Lisp_Object prev_event
;
3486 int *used_mouse_menu
;
3489 register Lisp_Object name
;
3491 int width
= FRAME_WIDTH (selected_frame
) - 4;
3492 char *menu
= (char *) alloca (width
+ 4);
3494 Lisp_Object rest
, vector
;
3496 if (used_mouse_menu
)
3497 *used_mouse_menu
= 0;
3499 /* Use local over global Menu maps */
3501 if (! menu_prompting
)
3504 /* Get the menu name from the first map that has one (a prompt string). */
3505 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3507 name
= map_prompt (maps
[mapno
]);
3512 /* If we don't have any menus, just read a character normally. */
3516 #ifdef HAVE_X_WINDOWS
3518 /* If we got to this point via a mouse click,
3519 use a real menu for mouse selection. */
3520 if (EVENT_HAS_PARAMETERS (prev_event
))
3522 /* Display the menu and get the selection. */
3523 Lisp_Object
*realmaps
3524 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
3528 /* Use the maps that are not nil. */
3529 for (mapno
= 0; mapno
< nmaps
; mapno
++)
3530 if (!NILP (maps
[mapno
]))
3531 realmaps
[nmaps1
++] = maps
[mapno
];
3533 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
3536 /* If we got more than one event, put all but the first
3537 onto this list to be read later.
3538 Return just the first event now. */
3539 unread_command_events
3540 = nconc2 (XCONS (value
)->cdr
, unread_command_events
);
3541 value
= XCONS (value
)->car
;
3545 if (used_mouse_menu
)
3546 *used_mouse_menu
= 1;
3549 #endif /* HAVE_X_MENU */
3550 #endif /* HAVE_X_WINDOWS */
3552 /* Prompt string always starts with map's prompt, and a space. */
3553 strcpy (menu
, XSTRING (name
)->data
);
3554 nlength
= XSTRING (name
)->size
;
3555 menu
[nlength
++] = ':';
3556 menu
[nlength
++] = ' ';
3559 /* Start prompting at start of first map. */
3563 /* Present the documented bindings, a line at a time. */
3571 /* Loop over elements of map. */
3576 /* If reached end of map, start at beginning of next map. */
3580 /* At end of last map, wrap around to first map if just starting,
3581 or end this line if already have something on it. */
3592 /* Look at the next element of the map. */
3594 elt
= XVECTOR (vector
)->contents
[idx
];
3596 elt
= Fcar_safe (rest
);
3598 if (idx
< 0 && XTYPE (elt
) == Lisp_Vector
)
3600 /* If we found a dense table in the keymap,
3601 advanced past it, but start scanning its contents. */
3602 rest
= Fcdr_safe (rest
);
3608 /* An ordinary element. */
3609 s
= Fcar_safe (Fcdr_safe (elt
));
3610 if (XTYPE (s
) != Lisp_String
)
3611 /* Ignore the element if it has no prompt string. */
3613 /* If we have room for the prompt string, add it to this line.
3614 If this is the first on the line, always add it. */
3615 else if (XSTRING (s
)->size
+ i
< width
3620 /* Punctuate between strings. */
3623 strcpy (menu
+ i
, ", ");
3628 /* Add as much of string as fits. */
3629 thiswidth
= XSTRING (s
)->size
;
3630 if (thiswidth
+ i
> width
)
3631 thiswidth
= width
- i
;
3632 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
3637 /* If this element does not fit, end the line now,
3638 and save the element for the next line. */
3639 strcpy (menu
+ i
, "...");
3643 /* Move past this element. */
3644 if (idx
>= 0 && idx
+ 1 >= XVECTOR (rest
)->size
)
3645 /* Handle reaching end of dense table. */
3650 rest
= Fcdr_safe (rest
);
3654 /* Prompt with that and read response. */
3656 obj
= read_char (1, 0, 0, Qnil
, 0);
3658 if (XTYPE (obj
) != Lisp_Int
)
3663 if (! EQ (obj
, menu_prompt_more_char
)
3664 && (XTYPE (menu_prompt_more_char
) != Lisp_Int
3665 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
3670 /* Reading key sequences. */
3672 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
3673 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
3674 keymap, or nil otherwise. Return the index of the first keymap in
3675 which KEY has any binding, or NMAPS if no map has a binding.
3677 If KEY is a meta ASCII character, treat it like meta-prefix-char
3678 followed by the corresponding non-meta character. Keymaps in
3679 CURRENT with non-prefix bindings for meta-prefix-char become nil in
3682 When KEY is not defined in any of the keymaps, if it is an upper
3683 case letter and there are bindings for the corresponding lower-case
3684 letter, return the bindings for the lower-case letter.
3685 We store 1 in *CASE_CONVERTED in this case.
3686 Otherwise, we don't change *CASE_CONVERTED.
3688 If KEY has no bindings in any of the CURRENT maps, NEXT is left
3691 NEXT may == CURRENT. */
3694 follow_key (key
, nmaps
, current
, defs
, next
, case_converted
)
3696 Lisp_Object
*current
, *defs
, *next
;
3698 int *case_converted
;
3700 int i
, first_binding
;
3702 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
3703 followed by the corresponding non-meta character. */
3704 if (XTYPE (key
) == Lisp_Int
&& (XINT (key
) & CHAR_META
))
3706 for (i
= 0; i
< nmaps
; i
++)
3707 if (! NILP (current
[i
]))
3710 get_keyelt (access_keymap (current
[i
], meta_prefix_char
, 1, 0));
3712 /* Note that since we pass the resulting bindings through
3713 get_keymap_1, non-prefix bindings for meta-prefix-char
3715 next
[i
] = get_keymap_1 (next
[i
], 0, 1);
3721 XSET (key
, Lisp_Int
, XFASTINT (key
) & ~CHAR_META
);
3724 first_binding
= nmaps
;
3725 for (i
= nmaps
- 1; i
>= 0; i
--)
3727 if (! NILP (current
[i
]))
3729 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3730 if (! NILP (defs
[i
]))
3737 /* When KEY is not defined in any of the keymaps, if it is an upper
3738 case letter and there are bindings for the corresponding
3739 lower-case letter, return the bindings for the lower-case letter. */
3740 if (first_binding
== nmaps
3741 && XTYPE (key
) == Lisp_Int
3742 && ((((XINT (key
) & 0x3ffff)
3743 < XSTRING (current_buffer
->downcase_table
)->size
)
3744 && UPPERCASEP (XINT (key
) & 0x3ffff))
3745 || (XINT (key
) & shift_modifier
)))
3747 if (XINT (key
) & shift_modifier
)
3748 XSETINT (key
, XINT (key
) & ~shift_modifier
);
3750 XSETINT (key
, (DOWNCASE (XINT (key
) & 0x3ffff)
3751 | (XINT (key
) & ~0x3ffff)));
3753 first_binding
= nmaps
;
3754 for (i
= nmaps
- 1; i
>= 0; i
--)
3756 if (! NILP (current
[i
]))
3758 defs
[i
] = get_keyelt (access_keymap (current
[i
], key
, 1, 0));
3759 if (! NILP (defs
[i
]))
3765 if (first_binding
!= nmaps
)
3766 *case_converted
= 1;
3769 /* Given the set of bindings we've found, produce the next set of maps. */
3770 if (first_binding
< nmaps
)
3771 for (i
= 0; i
< nmaps
; i
++)
3772 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
3774 return first_binding
;
3777 /* Read a sequence of keys that ends with a non prefix character,
3778 storing it in KEYBUF, a buffer of size BUFSIZE.
3780 Return the length of the key sequence stored.
3781 Return -1 if the user rejected a command menu.
3783 Echo starting immediately unless `prompt' is 0.
3785 Where a key sequence ends depends on the currently active keymaps.
3786 These include any minor mode keymaps active in the current buffer,
3787 the current buffer's local map, and the global map.
3789 If a key sequence has no other bindings, we check Vfunction_key_map
3790 to see if some trailing subsequence might be the beginning of a
3791 function key's sequence. If so, we try to read the whole function
3792 key, and substitute its symbolic name into the key sequence.
3794 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
3795 `double-' events into similar click events, if that would make them
3796 bound. We try to turn `triple-' events first into `double-' events,
3799 If we get a mouse click in a mode line, vertical divider, or other
3800 non-text area, we treat the click as if it were prefixed by the
3801 symbol denoting that area - `mode-line', `vertical-line', or
3804 If the sequence starts with a mouse click, we read the key sequence
3805 with respect to the buffer clicked on, not the current buffer.
3807 If the user switches frames in the midst of a key sequence, we put
3808 off the switch-frame event until later; the next call to
3809 read_char will return it. */
3812 read_key_sequence (keybuf
, bufsize
, prompt
)
3813 Lisp_Object
*keybuf
;
3817 int count
= specpdl_ptr
- specpdl
;
3819 /* How many keys there are in the current key sequence. */
3822 /* The length of the echo buffer when we started reading, and
3823 the length of this_command_keys when we started reading. */
3827 /* The number of keymaps we're scanning right now, and the number of
3828 keymaps we have allocated space for. */
3830 int nmaps_allocated
= 0;
3832 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
3833 the current keymaps. */
3836 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
3837 in the current keymaps, or nil where it is not a prefix. */
3838 Lisp_Object
*submaps
;
3840 /* The index in defs[] of the first keymap that has a binding for
3841 this key sequence. In other words, the lowest i such that
3842 defs[i] is non-nil. */
3845 /* If t < mock_input, then KEYBUF[t] should be read as the next
3848 We use this to recover after recognizing a function key. Once we
3849 realize that a suffix of the current key sequence is actually a
3850 function key's escape sequence, we replace the suffix with the
3851 function key's binding from Vfunction_key_map. Now keybuf
3852 contains a new and different key sequence, so the echo area,
3853 this_command_keys, and the submaps and defs arrays are wrong. In
3854 this situation, we set mock_input to t, set t to 0, and jump to
3855 restart_sequence; the loop will read keys from keybuf up until
3856 mock_input, thus rebuilding the state; and then it will resume
3857 reading characters from the keyboard. */
3860 /* If the sequence is unbound in submaps[], then
3861 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
3862 and fkey_map is its binding.
3864 These might be > t, indicating that all function key scanning
3865 should hold off until t reaches them. We do this when we've just
3866 recognized a function key, to avoid searching for the function
3867 key's again in Vfunction_key_map. */
3868 int fkey_start
= 0, fkey_end
= 0;
3869 Lisp_Object fkey_map
;
3871 /* Likewise, for key_translation_map. */
3872 int keytran_start
= 0, keytran_end
= 0;
3873 Lisp_Object keytran_map
;
3875 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
3876 we put it off for later. While we're reading, we keep the event here. */
3877 Lisp_Object delayed_switch_frame
;
3879 /* See the comment below... */
3880 #if defined (GOBBLE_FIRST_EVENT)
3881 Lisp_Object first_event
;
3884 struct buffer
*starting_buffer
;
3886 /* Nonzero if we found the binding for one of the chars
3887 in this key sequence by downcasing it. */
3888 int case_converted
= 0;
3890 /* Nonzero if we seem to have got the beginning of a binding
3891 in function_key_map. */
3892 int function_key_possible
= 0;
3896 last_nonmenu_event
= Qnil
;
3898 delayed_switch_frame
= Qnil
;
3899 fkey_map
= Vfunction_key_map
;
3900 keytran_map
= Vkey_translation_map
;
3902 /* If there is no function-key-map, turn off function key scanning. */
3903 if (NILP (Fkeymapp (Vfunction_key_map
)))
3904 fkey_start
= fkey_end
= bufsize
+ 1;
3906 /* If there is no key-translation-map, turn off scanning. */
3907 if (NILP (Fkeymapp (Vkey_translation_map
)))
3908 keytran_start
= keytran_end
= bufsize
+ 1;
3913 echo_prompt (XSTRING (prompt
)->data
);
3914 else if (cursor_in_echo_area
)
3915 /* This doesn't put in a dash if the echo buffer is empty, so
3916 you don't always see a dash hanging out in the minibuffer. */
3920 /* Record the initial state of the echo area and this_command_keys;
3921 we will need to restore them if we replay a key sequence. */
3923 echo_start
= echo_length ();
3924 keys_start
= this_command_key_count
;
3926 #if defined (GOBBLE_FIRST_EVENT)
3927 /* This doesn't quite work, because some of the things that read_char
3928 does cannot safely be bypassed. It seems too risky to try to make
3931 /* Read the first char of the sequence specially, before setting
3932 up any keymaps, in case a filter runs and switches buffers on us. */
3933 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
3935 #endif /* GOBBLE_FIRST_EVENT */
3937 /* We jump here when the key sequence has been thoroughly changed, and
3938 we need to rescan it starting from the beginning. When we jump here,
3939 keybuf[0..mock_input] holds the sequence we should reread. */
3942 starting_buffer
= current_buffer
;
3944 function_key_possible
= 0;
3946 /* Build our list of keymaps.
3947 If we recognize a function key and replace its escape sequence in
3948 keybuf with its symbol, or if the sequence starts with a mouse
3949 click and we need to switch buffers, we jump back here to rebuild
3950 the initial keymaps from the current buffer. */
3954 nmaps
= current_minor_maps (0, &maps
) + 2;
3955 if (nmaps
> nmaps_allocated
)
3957 submaps
= (Lisp_Object
*) alloca (nmaps
* sizeof (submaps
[0]));
3958 defs
= (Lisp_Object
*) alloca (nmaps
* sizeof (defs
[0]));
3959 nmaps_allocated
= nmaps
;
3961 bcopy (maps
, submaps
, (nmaps
- 2) * sizeof (submaps
[0]));
3962 #ifdef USE_TEXT_PROPERTIES
3963 submaps
[nmaps
-2] = get_local_map (PT
, current_buffer
);
3965 submaps
[nmaps
-2] = current_buffer
->keymap
;
3967 submaps
[nmaps
-1] = current_global_map
;
3970 /* Find an accurate initial value for first_binding. */
3971 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
3972 if (! NILP (submaps
[first_binding
]))
3975 /* Start from the beginning in keybuf. */
3978 /* These are no-ops the first time through, but if we restart, they
3979 revert the echo area and this_command_keys to their original state. */
3980 this_command_key_count
= keys_start
;
3982 echo_truncate (echo_start
);
3984 /* If the best binding for the current key sequence is a keymap, or
3985 we may be looking at a function key's escape sequence, keep on
3987 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
3988 || (first_binding
>= nmaps
3990 /* mock input is never part of a function key's sequence. */
3991 && mock_input
<= fkey_start
)
3992 || (first_binding
>= nmaps
3993 && keytran_start
< t
3994 /* mock input is never part of a function key's sequence. */
3995 && mock_input
<= keytran_start
)
3996 /* Don't return in the middle of a possible function key sequence,
3997 if the only bindings we found were via case conversion.
3998 Thus, if ESC O a has a function-key-map translation
3999 and ESC o has a binding, don't return after ESC O,
4000 so that we can translate ESC O plus the next character. */
4001 || (function_key_possible
&& case_converted
))
4004 int used_mouse_menu
= 0;
4006 /* Where the last real key started. If we need to throw away a
4007 key that has expanded into more than one element of keybuf
4008 (say, a mouse click on the mode line which is being treated
4009 as [mode-line (mouse-...)], then we backtrack to this point
4011 int last_real_key_start
;
4013 /* These variables are analogous to echo_start and keys_start;
4014 while those allow us to restart the entire key sequence,
4015 echo_local_start and keys_local_start allow us to throw away
4017 int echo_local_start
, keys_local_start
, local_first_binding
;
4020 error ("key sequence too long");
4023 echo_local_start
= echo_length ();
4024 keys_local_start
= this_command_key_count
;
4025 local_first_binding
= first_binding
;
4028 /* These are no-ops, unless we throw away a keystroke below and
4029 jumped back up to replay_key; in that case, these restore the
4030 variables to their original state, allowing us to replay the
4033 echo_truncate (echo_local_start
);
4034 this_command_key_count
= keys_local_start
;
4035 first_binding
= local_first_binding
;
4037 /* By default, assume each event is "real". */
4038 last_real_key_start
= t
;
4040 /* Does mock_input indicate that we are re-reading a key sequence? */
4044 add_command_key (key
);
4048 /* If not, we should actually read a character. */
4051 struct buffer
*buf
= current_buffer
;
4053 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
4056 /* read_char returns t when it shows a menu and the user rejects it.
4061 /* read_char returns -1 at the end of a macro.
4062 Emacs 18 handles this by returning immediately with a
4063 zero, so that's what we'll do. */
4064 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) == -1)
4070 /* If we have a quit that was typed in another frame, and
4071 quit_throw_to_read_char switched buffers,
4072 replay to get the right keymap. */
4073 if (EQ (key
, quit_char
) && current_buffer
!= starting_buffer
)
4078 goto replay_sequence
;
4084 /* Clicks in non-text areas get prefixed by the symbol
4085 in their CHAR-ADDRESS field. For example, a click on
4086 the mode line is prefixed by the symbol `mode-line'.
4088 Furthermore, key sequences beginning with mouse clicks
4089 are read using the keymaps of the buffer clicked on, not
4090 the current buffer. So we may have to switch the buffer
4093 When we turn one event into two events, we must make sure
4094 that neither of the two looks like the original--so that,
4095 if we replay the events, they won't be expanded again.
4096 If not for this, such reexpansion could happen either here
4097 or when user programs play with this-command-keys. */
4098 if (EVENT_HAS_PARAMETERS (key
))
4100 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
4102 if (EQ (kind
, Qmouse_click
))
4104 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
4105 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4107 if (XTYPE (posn
) == Lisp_Cons
)
4109 /* We're looking at the second event of a
4110 sequence which we expanded before. Set
4111 last_real_key_start appropriately. */
4113 last_real_key_start
= t
- 1;
4116 /* Key sequences beginning with mouse clicks are
4117 read using the keymaps in the buffer clicked on,
4118 not the current buffer. If we're at the
4119 beginning of a key sequence, switch buffers. */
4120 if (last_real_key_start
== 0
4121 && XTYPE (window
) == Lisp_Window
4122 && XTYPE (XWINDOW (window
)->buffer
) == Lisp_Buffer
4123 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
4128 /* Arrange to go back to the original buffer once we're
4129 done reading the key sequence. Note that we can't
4130 use save_excursion_{save,restore} here, because they
4131 save point as well as the current buffer; we don't
4132 want to save point, because redisplay may change it,
4133 to accommodate a Fset_window_start or something. We
4134 don't want to do this at the top of the function,
4135 because we may get input from a subprocess which
4136 wants to change the selected window and stuff (say,
4138 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
4140 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
4141 goto replay_sequence
;
4143 else if (XTYPE (posn
) == Lisp_Symbol
)
4145 /* Expand mode-line and scroll-bar events into two events:
4146 use posn as a fake prefix key. */
4148 if (t
+ 1 >= bufsize
)
4149 error ("key sequence too long");
4154 /* Zap the position in key, so we know that we've
4155 expanded it, and don't try to do so again. */
4156 POSN_BUFFER_POSN (EVENT_START (key
))
4157 = Fcons (posn
, Qnil
);
4161 else if (EQ (kind
, Qswitch_frame
))
4163 /* If we're at the beginning of a key sequence, go
4164 ahead and return this event. If we're in the
4165 midst of a key sequence, delay it until the end. */
4168 delayed_switch_frame
= key
;
4174 Lisp_Object posn
= POSN_BUFFER_POSN (EVENT_START (key
));
4176 /* Handle menu-bar events:
4177 insert the dummy prefix event `menu-bar'. */
4178 if (EQ (posn
, Qmenu_bar
))
4180 if (t
+ 1 >= bufsize
)
4181 error ("key sequence too long");
4182 /* Run the Lucid hook. */
4183 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
4184 /* If it has changed current-menubar from previous value,
4185 really recompute the menubar from the value. */
4186 if (! NILP (Vlucid_menu_bar_dirty_flag
))
4187 call0 (Qrecompute_lucid_menubar
);
4191 /* Zap the position in key, so we know that we've
4192 expanded it, and don't try to do so again. */
4193 POSN_BUFFER_POSN (EVENT_START (key
))
4194 = Fcons (posn
, Qnil
);
4197 goto replay_sequence
;
4199 else if (XTYPE (posn
) == Lisp_Cons
)
4201 /* We're looking at the second event of a
4202 sequence which we expanded before. Set
4203 last_real_key_start appropriately. */
4204 if (last_real_key_start
== t
&& t
> 0)
4205 last_real_key_start
= t
- 1;
4210 /* We have finally decided that KEY is something we might want
4212 first_binding
= (follow_key (key
,
4213 nmaps
- first_binding
,
4214 submaps
+ first_binding
,
4215 defs
+ first_binding
,
4216 submaps
+ first_binding
,
4220 /* If KEY wasn't bound, we'll try some fallbacks. */
4221 if (first_binding
>= nmaps
)
4223 Lisp_Object head
= EVENT_HEAD (key
);
4225 if (EQ (head
, Vhelp_char
))
4227 read_key_sequence_cmd
= Vprefix_help_command
;
4229 last_nonmenu_event
= key
;
4233 if (XTYPE (head
) == Lisp_Symbol
)
4235 Lisp_Object breakdown
= parse_modifiers (head
);
4236 int modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
4238 /* Attempt to reduce an unbound mouse event to a simpler
4239 event that is bound:
4240 Drags reduce to clicks.
4241 Double-clicks reduce to clicks.
4242 Triple-clicks reduce to double-clicks, then to clicks.
4243 Down-clicks are eliminated.
4244 Double-downs reduce to downs, then are eliminated.
4245 Triple-downs reduce to double-downs, then to downs,
4246 then are eliminated. */
4247 if (modifiers
& (down_modifier
| drag_modifier
4248 | double_modifier
| triple_modifier
))
4250 while (modifiers
& (down_modifier
| drag_modifier
4251 | double_modifier
| triple_modifier
))
4253 Lisp_Object new_head
, new_click
;
4254 if (modifiers
& triple_modifier
)
4255 modifiers
^= (double_modifier
| triple_modifier
);
4256 else if (modifiers
& (drag_modifier
| double_modifier
))
4257 modifiers
&= ~(drag_modifier
| double_modifier
);
4260 /* Dispose of this `down' event by simply jumping
4261 back to replay_key, to get another event.
4263 Note that if this event came from mock input,
4264 then just jumping back to replay_key will just
4265 hand it to us again. So we have to wipe out any
4268 We could delete keybuf[t] and shift everything
4269 after that to the left by one spot, but we'd also
4270 have to fix up any variable that points into
4271 keybuf, and shifting isn't really necessary
4274 Adding prefixes for non-textual mouse clicks
4275 creates two characters of mock input, and both
4276 must be thrown away. If we're only looking at
4277 the prefix now, we can just jump back to
4278 replay_key. On the other hand, if we've already
4279 processed the prefix, and now the actual click
4280 itself is giving us trouble, then we've lost the
4281 state of the keymaps we want to backtrack to, and
4282 we need to replay the whole sequence to rebuild
4285 Beyond that, only function key expansion could
4286 create more than two keys, but that should never
4287 generate mouse events, so it's okay to zero
4288 mock_input in that case too.
4290 Isn't this just the most wonderful code ever? */
4291 if (t
== last_real_key_start
)
4298 mock_input
= last_real_key_start
;
4299 goto replay_sequence
;
4304 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
4306 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
4308 /* Look for a binding for this new key. follow_key
4309 promises that it didn't munge submaps the
4310 last time we called it, since key was unbound. */
4312 = (follow_key (new_click
,
4313 nmaps
- local_first_binding
,
4314 submaps
+ local_first_binding
,
4315 defs
+ local_first_binding
,
4316 submaps
+ local_first_binding
,
4318 + local_first_binding
);
4320 /* If that click is bound, go for it. */
4321 if (first_binding
< nmaps
)
4326 /* Otherwise, we'll leave key set to the drag event. */
4333 /* Normally, last_nonmenu_event gets the previous key we read.
4334 But when a mouse popup menu is being used,
4335 we don't update last_nonmenu_event; it continues to hold the mouse
4336 event that preceded the first level of menu. */
4337 if (!used_mouse_menu
)
4338 last_nonmenu_event
= key
;
4340 /* If the sequence is unbound, see if we can hang a function key
4341 off the end of it. We only want to scan real keyboard input
4342 for function key sequences, so if mock_input says that we're
4343 re-reading old events, don't examine it. */
4344 if ((first_binding
>= nmaps
|| case_converted
)
4347 Lisp_Object fkey_next
;
4349 /* Continue scan from fkey_end until we find a bound suffix.
4350 If we fail, increment fkey_start
4351 and start fkey_end from there. */
4352 while (fkey_end
< t
)
4356 key
= keybuf
[fkey_end
++];
4357 /* Look up meta-characters by prefixing them
4358 with meta_prefix_char. I hate this. */
4359 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4364 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0)),
4366 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4369 fkey_next
= fkey_map
;
4372 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0));
4374 /* If the function key map gives a function, not an
4375 array, then call the function with no args and use
4376 its value instead. */
4377 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
4380 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4384 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
4385 fkey_next
= call1 (fkey_next
, prompt
);
4387 /* If the function returned something invalid,
4388 barf--don't ignore it.
4389 (To ignore it safely, we would need to gcpro a bunch of
4390 other variables.) */
4391 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
4392 error ("Function in function-key-map returns invalid key sequence");
4395 function_key_possible
= ! NILP (fkey_next
);
4397 /* If keybuf[fkey_start..fkey_end] is bound in the
4398 function key map and it's a suffix of the current
4399 sequence (i.e. fkey_end == t), replace it with
4400 the binding and restart with fkey_start at the end. */
4401 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
4404 int len
= XFASTINT (Flength (fkey_next
));
4406 t
= fkey_start
+ len
;
4408 error ("key sequence too long");
4410 if (VECTORP (fkey_next
))
4411 bcopy (XVECTOR (fkey_next
)->contents
,
4412 keybuf
+ fkey_start
,
4413 (t
- fkey_start
) * sizeof (keybuf
[0]));
4414 else if (STRINGP (fkey_next
))
4418 for (i
= 0; i
< len
; i
++)
4419 XFASTINT (keybuf
[fkey_start
+ i
])
4420 = XSTRING (fkey_next
)->data
[i
];
4424 fkey_start
= fkey_end
= t
;
4425 fkey_map
= Vfunction_key_map
;
4427 goto replay_sequence
;
4430 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
4432 /* If we no longer have a bound suffix, try a new positions for
4434 if (NILP (fkey_map
))
4436 fkey_end
= ++fkey_start
;
4437 fkey_map
= Vfunction_key_map
;
4438 function_key_possible
= 0;
4443 /* Look for this sequence in key-translation-map. */
4445 Lisp_Object keytran_next
;
4447 /* Scan from keytran_end until we find a bound suffix. */
4448 while (keytran_end
< t
)
4452 key
= keybuf
[keytran_end
++];
4453 /* Look up meta-characters by prefixing them
4454 with meta_prefix_char. I hate this. */
4455 if (XTYPE (key
) == Lisp_Int
&& XINT (key
) & meta_modifier
)
4460 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0)),
4462 XFASTINT (key
) = XFASTINT (key
) & ~meta_modifier
;
4465 keytran_next
= keytran_map
;
4468 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0));
4470 /* If the key translation map gives a function, not an
4471 array, then call the function with no args and use
4472 its value instead. */
4473 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
4474 && keytran_end
== t
)
4476 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4480 GCPRO3 (keytran_map
, keytran_map
, delayed_switch_frame
);
4481 keytran_next
= call1 (keytran_next
, prompt
);
4483 /* If the function returned something invalid,
4484 barf--don't ignore it.
4485 (To ignore it safely, we would need to gcpro a bunch of
4486 other variables.) */
4487 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
4488 error ("Function in function-key-map returns invalid key sequence");
4491 /* If keybuf[keytran_start..keytran_end] is bound in the
4492 key translation map and it's a suffix of the current
4493 sequence (i.e. keytran_end == t), replace it with
4494 the binding and restart with keytran_start at the end. */
4495 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
4496 && keytran_end
== t
)
4498 int len
= XFASTINT (Flength (keytran_next
));
4500 t
= keytran_start
+ len
;
4502 error ("key sequence too long");
4504 if (VECTORP (keytran_next
))
4505 bcopy (XVECTOR (keytran_next
)->contents
,
4506 keybuf
+ keytran_start
,
4507 (t
- keytran_start
) * sizeof (keybuf
[0]));
4508 else if (STRINGP (keytran_next
))
4512 for (i
= 0; i
< len
; i
++)
4513 XFASTINT (keybuf
[keytran_start
+ i
])
4514 = XSTRING (keytran_next
)->data
[i
];
4518 keytran_start
= keytran_end
= t
;
4519 keytran_map
= Vkey_translation_map
;
4521 goto replay_sequence
;
4524 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
4526 /* If we no longer have a bound suffix, try a new positions for
4528 if (NILP (keytran_map
))
4530 keytran_end
= ++keytran_start
;
4531 keytran_map
= Vkey_translation_map
;
4537 read_key_sequence_cmd
= (first_binding
< nmaps
4538 ? defs
[first_binding
]
4542 unread_switch_frame
= delayed_switch_frame
;
4543 unbind_to (count
, Qnil
);
4545 /* Occasionally we fabricate events, perhaps by expanding something
4546 according to function-key-map, or by adding a prefix symbol to a
4547 mouse click in the scroll bar or modeline. In this cases, return
4548 the entire generated key sequence, even if we hit an unbound
4549 prefix or a definition before the end. This means that you will
4550 be able to push back the event properly, and also means that
4551 read-key-sequence will always return a logical unit.
4554 for (; t
< mock_input
; t
++)
4556 echo_char (keybuf
[t
]);
4557 add_command_key (keybuf
[t
]);
4563 #if 0 /* This doc string is too long for some compilers.
4564 This commented-out definition serves for DOC. */
4565 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4566 "Read a sequence of keystrokes and return as a string or vector.\n\
4567 The sequence is sufficient to specify a non-prefix command in the\n\
4568 current local and global maps.\n\
4570 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
4571 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
4572 as a continuation of the previous key.\n\
4574 A C-g typed while in this function is treated like any other character,\n\
4575 and `quit-flag' is not set.\n\
4577 If the key sequence starts with a mouse click, then the sequence is read\n\
4578 using the keymaps of the buffer of the window clicked in, not the buffer\n\
4579 of the selected window as normal.\n\
4581 `read-key-sequence' drops unbound button-down events, since you normally\n\
4582 only care about the click or drag events which follow them. If a drag\n\
4583 or multi-click event is unbound, but the corresponding click event would\n\
4584 be bound, `read-key-sequence' turns the event into a click event at the\n\
4585 drag's starting position. This means that you don't have to distinguish\n\
4586 between click and drag, double, or triple events unless you want to.\n\
4588 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
4589 lines separating windows, and scroll bars with imaginary keys\n\
4590 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
4592 If the user switches frames in the middle of a key sequence, the\n\
4593 frame-switch event is put off until after the current key sequence.\n\
4595 `read-key-sequence' checks `function-key-map' for function key\n\
4596 sequences, where they wouldn't conflict with ordinary bindings. See\n\
4597 `function-key-map' for more details.")
4598 (prompt
, continue_echo
)
4601 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 2, 0,
4603 (prompt
, continue_echo
)
4604 Lisp_Object prompt
, continue_echo
;
4606 Lisp_Object keybuf
[30];
4608 struct gcpro gcpro1
, gcpro2
;
4611 CHECK_STRING (prompt
, 0);
4614 bzero (keybuf
, sizeof keybuf
);
4616 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
4618 if (NILP (continue_echo
))
4619 this_command_key_count
= 0;
4621 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])), prompt
);
4629 return make_event_array (i
, keybuf
);
4632 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 2, 0,
4633 "Execute CMD as an editor command.\n\
4634 CMD must be a symbol that satisfies the `commandp' predicate.\n\
4635 Optional second arg RECORD-FLAG non-nil\n\
4636 means unconditionally put this command in `command-history'.\n\
4637 Otherwise, that is done only if an arg is read using the minibuffer.")
4639 Lisp_Object cmd
, record
;
4641 register Lisp_Object final
;
4642 register Lisp_Object tem
;
4643 Lisp_Object prefixarg
;
4644 struct backtrace backtrace
;
4645 extern int debug_on_next_call
;
4647 prefixarg
= Vprefix_arg
, Vprefix_arg
= Qnil
;
4648 Vcurrent_prefix_arg
= prefixarg
;
4649 debug_on_next_call
= 0;
4651 if (XTYPE (cmd
) == Lisp_Symbol
)
4653 tem
= Fget (cmd
, Qdisabled
);
4655 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
4660 final
= Findirect_function (cmd
);
4662 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
4663 do_autoload (final
, cmd
);
4668 if (XTYPE (final
) == Lisp_String
4669 || XTYPE (final
) == Lisp_Vector
)
4671 /* If requested, place the macro in the command history. For
4672 other sorts of commands, call-interactively takes care of
4676 = Fcons (Fcons (Qexecute_kbd_macro
,
4677 Fcons (final
, Fcons (prefixarg
, Qnil
))),
4680 return Fexecute_kbd_macro (final
, prefixarg
);
4682 if (CONSP (final
) || XTYPE (final
) == Lisp_Subr
4683 || XTYPE (final
) == Lisp_Compiled
)
4685 backtrace
.next
= backtrace_list
;
4686 backtrace_list
= &backtrace
;
4687 backtrace
.function
= &Qcall_interactively
;
4688 backtrace
.args
= &cmd
;
4689 backtrace
.nargs
= 1;
4690 backtrace
.evalargs
= 0;
4692 tem
= Fcall_interactively (cmd
, record
);
4694 backtrace_list
= backtrace
.next
;
4700 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
4702 "Read function name, then read its arguments and call it.")
4704 Lisp_Object prefixarg
;
4706 Lisp_Object function
;
4708 Lisp_Object saved_keys
;
4709 struct gcpro gcpro1
;
4711 saved_keys
= Fthis_command_keys ();
4713 GCPRO1 (saved_keys
);
4715 if (EQ (prefixarg
, Qminus
))
4717 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
4718 strcpy (buf
, "C-u ");
4719 else if (CONSP (prefixarg
) && XTYPE (XCONS (prefixarg
)->car
) == Lisp_Int
)
4720 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
4721 else if (XTYPE (prefixarg
) == Lisp_Int
)
4722 sprintf (buf
, "%d ", XINT (prefixarg
));
4724 /* This isn't strictly correct if execute-extended-command
4725 is bound to anything else. Perhaps it should use
4726 this_command_keys? */
4727 strcat (buf
, "M-x ");
4729 /* Prompt with buf, and then read a string, completing from and
4730 restricting to the set of all defined commands. Don't provide
4731 any initial input. Save the command read on the extended-command
4733 function
= Fcompleting_read (build_string (buf
),
4734 Vobarray
, Qcommandp
,
4735 Qt
, Qnil
, Qextended_command_history
);
4737 /* Set this_command_keys to the concatenation of saved_keys and
4738 function, followed by a RET. */
4740 struct Lisp_String
*str
;
4744 this_command_key_count
= 0;
4746 str
= XSTRING (saved_keys
);
4747 for (i
= 0; i
< str
->size
; i
++)
4749 XFASTINT (tem
) = str
->data
[i
];
4750 add_command_key (tem
);
4753 str
= XSTRING (function
);
4754 for (i
= 0; i
< str
->size
; i
++)
4756 XFASTINT (tem
) = str
->data
[i
];
4757 add_command_key (tem
);
4760 XFASTINT (tem
) = '\015';
4761 add_command_key (tem
);
4766 function
= Fintern (function
, Qnil
);
4767 Vprefix_arg
= prefixarg
;
4768 this_command
= function
;
4770 return Fcommand_execute (function
, Qt
);
4774 detect_input_pending ()
4777 get_input_pending (&input_pending
);
4779 return input_pending
;
4782 /* This is called in some cases before a possible quit.
4783 It cases the next call to detect_input_pending to recompute input_pending.
4784 So calling this function unnecessarily can't do any harm. */
4785 clear_input_pending ()
4790 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
4791 "T if command input is currently available with no waiting.\n\
4792 Actually, the value is nil only if we can be sure that no input is available.")
4795 if (!NILP (unread_command_events
) || unread_command_char
!= -1)
4798 return detect_input_pending () ? Qt
: Qnil
;
4801 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
4802 "Return vector of last 100 events, not counting those from keyboard macros.")
4805 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
4808 if (total_keys
< NUM_RECENT_KEYS
)
4809 return Fvector (total_keys
, keys
);
4812 val
= Fvector (NUM_RECENT_KEYS
, keys
);
4813 bcopy (keys
+ recent_keys_index
,
4814 XVECTOR (val
)->contents
,
4815 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
4817 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
4818 recent_keys_index
* sizeof (Lisp_Object
));
4823 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
4824 "Return the key sequence that invoked this command.\n\
4825 The value is a string or a vector.")
4828 return make_event_array (this_command_key_count
,
4829 XVECTOR (this_command_keys
)->contents
);
4832 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
4833 "Return the current depth in recursive edits.")
4837 XFASTINT (temp
) = command_loop_level
+ minibuf_level
;
4841 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
4842 "FOpen dribble file: ",
4843 "Start writing all keyboard characters to a dribble file called FILE.\n\
4844 If FILE is nil, close any open dribble file.")
4855 file
= Fexpand_file_name (file
, Qnil
);
4856 dribble
= fopen (XSTRING (file
)->data
, "w");
4861 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
4862 "Discard the contents of the terminal input buffer.\n\
4863 Also cancel any kbd macro being defined.")
4866 defining_kbd_macro
= 0;
4867 update_mode_lines
++;
4869 unread_command_events
= Qnil
;
4870 unread_command_char
= -1;
4872 discard_tty_input ();
4874 /* Without the cast, GCC complains that this assignment loses the
4875 volatile qualifier of kbd_store_ptr. Is there anything wrong
4877 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
4878 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
4884 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
4885 "Stop Emacs and return to superior process. You can resume later.\n\
4886 On systems that don't have job control, run a subshell instead.\n\n\
4887 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
4888 to be read as terminal input by Emacs's parent, after suspension.\n\
4890 Before suspending, call the functions in `suspend-hook' with no args.\n\
4891 If any of them returns nil, don't call the rest and don't suspend.\n\
4892 Otherwise, suspend normally and after resumption run the normal hook\n\
4893 `suspend-resume-hook' if that is bound and non-nil.\n\
4895 Some operating systems cannot stop the Emacs process and resume it later.\n\
4896 On such systems, Emacs starts a subshell instead of suspending.")
4898 Lisp_Object stuffstring
;
4901 int count
= specpdl_ptr
- specpdl
;
4902 int old_height
, old_width
;
4904 struct gcpro gcpro1
, gcpro2
;
4905 extern init_sys_modes ();
4907 if (!NILP (stuffstring
))
4908 CHECK_STRING (stuffstring
, 0);
4910 /* Run the functions in suspend-hook. */
4911 if (!NILP (Vrun_hooks
))
4912 call1 (Vrun_hooks
, intern ("suspend-hook"));
4914 GCPRO1 (stuffstring
);
4915 get_frame_size (&old_width
, &old_height
);
4917 /* sys_suspend can get an error if it tries to fork a subshell
4918 and the system resources aren't available for that. */
4919 record_unwind_protect (init_sys_modes
, 0);
4920 stuff_buffered_input (stuffstring
);
4922 unbind_to (count
, Qnil
);
4924 /* Check if terminal/window size has changed.
4925 Note that this is not useful when we are running directly
4926 with a window system; but suspend should be disabled in that case. */
4927 get_frame_size (&width
, &height
);
4928 if (width
!= old_width
|| height
!= old_height
)
4929 change_frame_size (selected_frame
, height
, width
, 0, 0);
4931 /* Run suspend-resume-hook. */
4932 if (!NILP (Vrun_hooks
))
4933 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
4939 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
4940 Then in any case stuff anything Emacs has read ahead and not used. */
4942 stuff_buffered_input (stuffstring
)
4943 Lisp_Object stuffstring
;
4945 register unsigned char *p
;
4947 /* stuff_char works only in BSD, versions 4.2 and up. */
4950 if (XTYPE (stuffstring
) == Lisp_String
)
4954 p
= XSTRING (stuffstring
)->data
;
4955 count
= XSTRING (stuffstring
)->size
;
4960 /* Anything we have read ahead, put back for the shell to read. */
4961 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4963 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4964 kbd_fetch_ptr
= kbd_buffer
;
4965 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
4966 stuff_char (kbd_fetch_ptr
->code
);
4967 kbd_fetch_ptr
->kind
= no_event
;
4968 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
4975 #endif /* BSD and not BSD4_1 */
4978 set_waiting_for_input (time_to_clear
)
4979 EMACS_TIME
*time_to_clear
;
4981 input_available_clear_time
= time_to_clear
;
4983 /* Tell interrupt_signal to throw back to read_char, */
4984 waiting_for_input
= 1;
4986 /* If interrupt_signal was called before and buffered a C-g,
4987 make it run again now, to avoid timing error. */
4988 if (!NILP (Vquit_flag
))
4989 quit_throw_to_read_char ();
4992 clear_waiting_for_input ()
4994 /* Tell interrupt_signal not to throw back to read_char, */
4995 waiting_for_input
= 0;
4996 input_available_clear_time
= 0;
4999 /* This routine is called at interrupt level in response to C-G.
5000 If interrupt_input, this is the handler for SIGINT.
5001 Otherwise, it is called from kbd_buffer_store_event,
5002 in handling SIGIO or SIGTINT.
5004 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
5005 immediately throw back to read_char.
5007 Otherwise it sets the Lisp variable quit-flag not-nil.
5008 This causes eval to throw, when it gets a chance.
5009 If quit-flag is already non-nil, it stops the job right away. */
5015 /* Must preserve main program's value of errno. */
5016 int old_errno
= errno
;
5019 /* USG systems forget handlers when they are used;
5020 must reestablish each time */
5021 signal (SIGINT
, interrupt_signal
);
5022 signal (SIGQUIT
, interrupt_signal
);
5027 if (!NILP (Vquit_flag
) && FRAME_TERMCAP_P (selected_frame
))
5032 #ifdef SIGTSTP /* Support possible in later USG versions */
5034 * On systems which can suspend the current process and return to the original
5035 * shell, this command causes the user to end up back at the shell.
5036 * The "Auto-save" and "Abort" questions are not asked until
5037 * the user elects to return to emacs, at which point he can save the current
5038 * job and either dump core or continue.
5043 if (sys_suspend () == -1)
5045 printf ("Not running as a subprocess;\n");
5046 printf ("you can continue or abort.\n");
5049 /* Perhaps should really fork an inferior shell?
5050 But that would not provide any way to get back
5051 to the original shell, ever. */
5052 printf ("No support for stopping a process on this operating system;\n");
5053 printf ("you can continue or abort.\n");
5054 #endif /* not VMS */
5055 #endif /* not SIGTSTP */
5056 printf ("Auto-save? (y or n) ");
5058 if (((c
= getchar ()) & ~040) == 'Y')
5060 Fdo_auto_save (Qt
, Qnil
);
5061 printf ("Auto-save done\n");
5063 while (c
!= '\n') c
= getchar ();
5065 printf ("Abort (and enter debugger)? (y or n) ");
5067 printf ("Abort (and dump core)? (y or n) ");
5068 #endif /* not VMS */
5070 if (((c
= getchar ()) & ~040) == 'Y')
5072 while (c
!= '\n') c
= getchar ();
5073 printf ("Continuing...\n");
5079 /* If executing a function that wants to be interrupted out of
5080 and the user has not deferred quitting by binding `inhibit-quit'
5081 then quit right away. */
5082 if (immediate_quit
&& NILP (Vinhibit_quit
))
5086 Fsignal (Qquit
, Qnil
);
5089 /* Else request quit when it's safe */
5093 if (waiting_for_input
&& !echoing
)
5094 quit_throw_to_read_char ();
5099 /* Handle a C-g by making read_char return C-g. */
5101 quit_throw_to_read_char ()
5103 quit_error_check ();
5105 /* Prevent another signal from doing this before we finish. */
5106 clear_waiting_for_input ();
5109 unread_command_events
= Qnil
;
5110 unread_command_char
= -1;
5112 #ifdef POLL_FOR_INPUT
5113 /* May be > 1 if in recursive minibuffer. */
5114 if (poll_suppress_count
== 0)
5118 if (XTYPE (internal_last_event_frame
) == Lisp_Frame
5119 && XFRAME (internal_last_event_frame
) != selected_frame
)
5120 Fhandle_switch_frame (make_lispy_switch_frame (internal_last_event_frame
));
5123 _longjmp (getcjmp
, 1);
5126 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
5127 "Set mode of reading keyboard input.\n\
5128 First arg INTERRUPT non-nil means use input interrupts;\n\
5129 nil means use CBREAK mode.\n\
5130 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
5131 (no effect except in CBREAK mode).\n\
5132 Third arg META t means accept 8-bit input (for a Meta key).\n\
5133 META nil means ignore the top bit, on the assumption it is parity.\n\
5134 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
5135 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
5136 See also `current-input-mode'.")
5137 (interrupt
, flow
, meta
, quit
)
5138 Lisp_Object interrupt
, flow
, meta
, quit
;
5141 && (XTYPE (quit
) != Lisp_Int
5142 || XINT (quit
) < 0 || XINT (quit
) > 0400))
5143 error ("set-input-mode: QUIT must be an ASCII character");
5145 #ifdef POLL_FOR_INPUT
5151 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5152 #ifdef NO_SOCK_SIGIO
5153 if (read_socket_hook
)
5154 interrupt_input
= 0; /* No interrupts if reading from a socket. */
5156 #endif /* NO_SOCK_SIGIO */
5157 interrupt_input
= !NILP (interrupt
);
5158 #else /* not SIGIO */
5159 interrupt_input
= 0;
5160 #endif /* not SIGIO */
5161 /* Our VMS input only works by interrupts, as of now. */
5163 interrupt_input
= 1;
5165 flow_control
= !NILP (flow
);
5168 else if (EQ (meta
, Qt
))
5173 /* Don't let this value be out of range. */
5174 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
5178 #ifdef POLL_FOR_INPUT
5179 poll_suppress_count
= 1;
5185 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
5186 "Return information about the way Emacs currently reads keyboard input.\n\
5187 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
5188 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
5189 nil, Emacs is using CBREAK mode.\n\
5190 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
5191 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
5192 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
5193 META nil means ignoring the top bit, on the assumption it is parity.\n\
5194 META is neither t nor nil if accepting 8-bit input and using\n\
5195 all 8 bits as the character code.\n\
5196 QUIT is the character Emacs currently uses to quit.\n\
5197 The elements of this list correspond to the arguments of\n\
5203 val
[0] = interrupt_input
? Qt
: Qnil
;
5204 val
[1] = flow_control
? Qt
: Qnil
;
5205 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
5206 XFASTINT (val
[3]) = quit_char
;
5208 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
5214 /* This is correct before outermost invocation of the editor loop */
5215 command_loop_level
= -1;
5217 quit_char
= Ctl ('g');
5218 unread_command_events
= Qnil
;
5219 unread_command_char
= -1;
5221 recent_keys_index
= 0;
5222 kbd_fetch_ptr
= kbd_buffer
;
5223 kbd_store_ptr
= kbd_buffer
;
5224 do_mouse_tracking
= 0;
5228 /* This means that command_loop_1 won't try to select anything the first
5230 internal_last_event_frame
= Qnil
;
5231 Vlast_event_frame
= internal_last_event_frame
;
5234 /* If we're running a dumped Emacs, we need to clear out
5235 kbd_buffer_frame_or_window, in case some events got into it
5238 If we're running an undumped Emacs, it hasn't been initialized by
5239 syms_of_keyboard yet. */
5241 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
5243 if (!noninteractive
)
5245 signal (SIGINT
, interrupt_signal
);
5246 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
5247 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
5248 SIGQUIT and we can't tell which one it will give us. */
5249 signal (SIGQUIT
, interrupt_signal
);
5250 #endif /* HAVE_TERMIO */
5251 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5253 signal (SIGIO
, input_available_signal
);
5257 /* Use interrupt input by default, if it works and noninterrupt input
5258 has deficiencies. */
5260 #ifdef INTERRUPT_INPUT
5261 interrupt_input
= 1;
5263 interrupt_input
= 0;
5266 /* Our VMS input only works by interrupts, as of now. */
5268 interrupt_input
= 1;
5274 if (keyboard_init_hook
)
5275 (*keyboard_init_hook
) ();
5277 #ifdef POLL_FOR_INPUT
5278 poll_suppress_count
= 1;
5283 /* This type's only use is in syms_of_keyboard, to initialize the
5284 event header symbols and put properties on them. */
5291 struct event_head head_table
[] = {
5292 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
5293 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
5294 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
5299 Qdisabled_command_hook
= intern ("disabled-command-hook");
5300 staticpro (&Qdisabled_command_hook
);
5302 Qself_insert_command
= intern ("self-insert-command");
5303 staticpro (&Qself_insert_command
);
5305 Qforward_char
= intern ("forward-char");
5306 staticpro (&Qforward_char
);
5308 Qbackward_char
= intern ("backward-char");
5309 staticpro (&Qbackward_char
);
5311 Qdisabled
= intern ("disabled");
5312 staticpro (&Qdisabled
);
5314 Qundefined
= intern ("undefined");
5315 staticpro (&Qundefined
);
5317 Qpre_command_hook
= intern ("pre-command-hook");
5318 staticpro (&Qpre_command_hook
);
5320 Qpost_command_hook
= intern ("post-command-hook");
5321 staticpro (&Qpost_command_hook
);
5323 Qfunction_key
= intern ("function-key");
5324 staticpro (&Qfunction_key
);
5325 Qmouse_click
= intern ("mouse-click");
5326 staticpro (&Qmouse_click
);
5328 Qmenu_enable
= intern ("menu-enable");
5329 staticpro (&Qmenu_enable
);
5331 Qmode_line
= intern ("mode-line");
5332 staticpro (&Qmode_line
);
5333 Qvertical_line
= intern ("vertical-line");
5334 staticpro (&Qvertical_line
);
5335 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
5336 staticpro (&Qvertical_scroll_bar
);
5337 Qmenu_bar
= intern ("menu-bar");
5338 staticpro (&Qmenu_bar
);
5340 Qabove_handle
= intern ("above-handle");
5341 staticpro (&Qabove_handle
);
5342 Qhandle
= intern ("handle");
5343 staticpro (&Qhandle
);
5344 Qbelow_handle
= intern ("below-handle");
5345 staticpro (&Qbelow_handle
);
5347 Qevent_kind
= intern ("event-kind");
5348 staticpro (&Qevent_kind
);
5349 Qevent_symbol_elements
= intern ("event-symbol-elements");
5350 staticpro (&Qevent_symbol_elements
);
5351 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
5352 staticpro (&Qevent_symbol_element_mask
);
5353 Qmodifier_cache
= intern ("modifier-cache");
5354 staticpro (&Qmodifier_cache
);
5356 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
5357 staticpro (&Qrecompute_lucid_menubar
);
5358 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
5359 staticpro (&Qactivate_menubar_hook
);
5362 struct event_head
*p
;
5364 for (p
= head_table
;
5365 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
5368 *p
->var
= intern (p
->name
);
5370 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
5371 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
5375 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
5376 staticpro (&button_down_location
);
5380 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
5382 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
5383 for (i
= 0; i
< len
; i
++)
5384 if (modifier_names
[i
])
5385 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
5386 staticpro (&modifier_symbols
);
5389 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
5390 staticpro (&recent_keys
);
5392 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
5393 staticpro (&this_command_keys
);
5395 Qextended_command_history
= intern ("extended-command-history");
5396 Fset (Qextended_command_history
, Qnil
);
5397 staticpro (&Qextended_command_history
);
5399 kbd_buffer_frame_or_window
5400 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
5401 staticpro (&kbd_buffer_frame_or_window
);
5403 func_key_syms
= Qnil
;
5404 staticpro (&func_key_syms
);
5407 staticpro (&mouse_syms
);
5409 unread_switch_frame
= Qnil
;
5410 staticpro (&unread_switch_frame
);
5412 defsubr (&Sread_key_sequence
);
5413 defsubr (&Srecursive_edit
);
5414 defsubr (&Strack_mouse
);
5415 defsubr (&Sinput_pending_p
);
5416 defsubr (&Scommand_execute
);
5417 defsubr (&Srecent_keys
);
5418 defsubr (&Sthis_command_keys
);
5419 defsubr (&Ssuspend_emacs
);
5420 defsubr (&Sabort_recursive_edit
);
5421 defsubr (&Sexit_recursive_edit
);
5422 defsubr (&Srecursion_depth
);
5423 defsubr (&Stop_level
);
5424 defsubr (&Sdiscard_input
);
5425 defsubr (&Sopen_dribble_file
);
5426 defsubr (&Sset_input_mode
);
5427 defsubr (&Scurrent_input_mode
);
5428 defsubr (&Sexecute_extended_command
);
5430 DEFVAR_LISP ("last-command-char", &last_command_char
,
5431 "Last input event that was part of a command.");
5433 DEFVAR_LISP ("last-command-event", &last_command_char
,
5434 "Last input event that was part of a command.");
5436 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
5437 "Last input event in a command, except for mouse menu events.\n\
5438 Mouse menus give back keys that don't look like mouse events;\n\
5439 this variable holds the actual mouse event that led to the menu,\n\
5440 so that you can determine whether the command was run by mouse or not.");
5442 DEFVAR_LISP ("last-input-char", &last_input_char
,
5443 "Last input event.");
5445 DEFVAR_LISP ("last-input-event", &last_input_char
,
5446 "Last input event.");
5448 DEFVAR_LISP ("unread-command-events", &unread_command_events
,
5449 "List of objects to be read as next command input events.");
5451 DEFVAR_INT ("unread-command-char", &unread_command_char
,
5452 "If not -1, an object to be read as next command input event.");
5454 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
5455 "Meta-prefix character code. Meta-foo as command input\n\
5456 turns into this character followed by foo.");
5457 XSET (meta_prefix_char
, Lisp_Int
, 033);
5459 DEFVAR_LISP ("last-command", &last_command
,
5460 "The last command executed. Normally a symbol with a function definition,\n\
5461 but can be whatever was found in the keymap, or whatever the variable\n\
5462 `this-command' was set to by that command.");
5463 last_command
= Qnil
;
5465 DEFVAR_LISP ("this-command", &this_command
,
5466 "The command now being executed.\n\
5467 The command can set this variable; whatever is put here\n\
5468 will be in `last-command' during the following command.");
5469 this_command
= Qnil
;
5471 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
5472 "*Number of keyboard input characters between auto-saves.\n\
5473 Zero means disable autosaving due to number of characters typed.");
5474 auto_save_interval
= 300;
5476 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
5477 "*Number of seconds idle time before auto-save.\n\
5478 Zero or nil means disable auto-saving due to idleness.\n\
5479 After auto-saving due to this many seconds of idle time,\n\
5480 Emacs also does a garbage collection if that seems to be warranted.");
5481 XFASTINT (Vauto_save_timeout
) = 30;
5483 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
5484 "*Nonzero means echo unfinished commands after this many seconds of pause.");
5485 echo_keystrokes
= 1;
5487 DEFVAR_INT ("polling-period", &polling_period
,
5488 "*Interval between polling for input during Lisp execution.\n\
5489 The reason for polling is to make C-g work to stop a running program.\n\
5490 Polling is needed only when using X windows and SIGIO does not work.\n\
5491 Polling is automatically disabled in all other cases.");
5494 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
5495 "*Maximum time between mouse clicks to make a double-click.\n\
5496 Measured in milliseconds. nil means disable double-click recognition;\n\
5497 t means double-clicks have no time limit and are detected\n\
5498 by position only.");
5499 Vdouble_click_time
= make_number (500);
5501 DEFVAR_INT ("num-input-keys", &num_input_keys
,
5502 "*Number of complete keys read from the keyboard so far.");
5506 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
5507 "*The frame in which the most recently read event occurred.\n\
5508 If the last event came from a keyboard macro, this is set to `macro'.");
5509 Vlast_event_frame
= Qnil
;
5512 DEFVAR_LISP ("help-char", &Vhelp_char
,
5513 "Character to recognize as meaning Help.\n\
5514 When it is read, do `(eval help-form)', and display result if it's a string.\n\
5515 If the value of `help-form' is nil, this char can be read normally.");
5516 XSET (Vhelp_char
, Lisp_Int
, Ctl ('H'));
5518 DEFVAR_LISP ("help-form", &Vhelp_form
,
5519 "Form to execute when character `help-char' is read.\n\
5520 If the form returns a string, that string is displayed.\n\
5521 If `help-form' is nil, the help char is not recognized.");
5524 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
5525 "Command to run when `help-char' character follows a prefix key.\n\
5526 This command is used only when there is no actual binding\n\
5527 for that character after that prefix key.");
5528 Vprefix_help_command
= Qnil
;
5530 DEFVAR_LISP ("top-level", &Vtop_level
,
5531 "Form to evaluate when Emacs starts up.\n\
5532 Useful to set before you dump a modified Emacs.");
5535 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
5536 "String used as translate table for keyboard input, or nil.\n\
5537 Each character is looked up in this string and the contents used instead.\n\
5538 If string is of length N, character codes N and up are untranslated.");
5539 Vkeyboard_translate_table
= Qnil
;
5541 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
5542 "Keymap of key translations that can override keymaps.\n\
5543 This keymap works like `function-key-map', but comes after that,\n\
5544 and applies even for keys that have ordinary bindings.");
5545 Vkey_translation_map
= Qnil
;
5547 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
5548 "Non-nil means prompt with menus when appropriate.\n\
5549 This is done when reading from a keymap that has a prompt string,\n\
5550 for elements that have prompt strings.\n\
5551 The menu is displayed on the screen\n\
5552 if X menus were enabled at configuration\n\
5553 time and the previous event was a mouse click prefix key.\n\
5554 Otherwise, menu prompting uses the echo area.");
5557 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
5558 "Character to see next line of menu prompt.\n\
5559 Type this character while in a menu prompt to rotate around the lines of it.");
5560 XSET (menu_prompt_more_char
, Lisp_Int
, ' ');
5562 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
5563 "A mask of additional modifier keys to use with every keyboard character.\n\
5564 Emacs applies the modifiers of the character stored here to each keyboard\n\
5565 character it reads. For example, after evaluating the expression\n\
5566 (setq extra-keyboard-modifiers ?\C-x)\n\
5567 all input characters will have the control modifier applied to them.\n\
5569 Note that the character ?\C-@, equivalent to the integer zero, does\n\
5570 not count as a control character; rather, it counts as a character\n\
5571 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
5572 cancels any modification.");
5573 extra_keyboard_modifiers
= 0;
5575 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
5576 "If an editing command sets this to t, deactivate the mark afterward.\n\
5577 The command loop sets this to nil before each command,\n\
5578 and tests the value when the command returns.\n\
5579 Buffer modification stores t in this variable.");
5580 Vdeactivate_mark
= Qnil
;
5582 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
5583 "Normal hook run before each command is executed.");
5584 Vpre_command_hook
= Qnil
;
5586 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
5587 "Normal hook run after each command is executed.");
5588 Vpost_command_hook
= Qnil
;
5590 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
5591 "t means menu bar, specified Lucid style, needs to be recomputed.");
5592 Vlucid_menu_bar_dirty_flag
= Qnil
;
5594 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
5595 "List of menu bar items to move to the end of the menu bar.\n\
5596 The elements of the list are event types that may have menu bar bindings.");
5597 Vmenu_bar_final_items
= Qnil
;
5599 DEFVAR_BOOL ("track-mouse", &do_mouse_tracking
,
5600 "*Non-nil means generate motion events for mouse motion.");
5605 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
5606 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
5607 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
5608 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
5609 initial_define_key (meta_map
, 'x', "execute-extended-command");