1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Allow config.h to undefine symbols found here. */
29 #include "termhooks.h"
37 #include "dispextern.h"
40 #include "intervals.h"
41 #include "blockinput.h"
51 #include <sys/ioctl.h>
53 #endif /* not MSDOS */
55 #include "syssignal.h"
58 /* This is to get the definitions of the XK_ symbols. */
65 #endif /* HAVE_NTGUI */
67 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
72 /* Variables for blockinput.h: */
74 /* Non-zero if interrupt input is blocked right now. */
75 int interrupt_input_blocked
;
77 /* Nonzero means an input interrupt has arrived
78 during the current critical section. */
79 int interrupt_input_pending
;
82 /* File descriptor to use for input. */
85 #ifdef HAVE_WINDOW_SYSTEM
86 /* Make all keyboard buffers much bigger when using X windows. */
87 #define KBD_BUFFER_SIZE 4096
88 #else /* No X-windows, character input */
89 #define KBD_BUFFER_SIZE 256
90 #endif /* No X-windows */
92 /* Following definition copied from eval.c */
96 struct backtrace
*next
;
97 Lisp_Object
*function
;
98 Lisp_Object
*args
; /* Points to vector of args. */
99 int nargs
; /* length of vector. If nargs is UNEVALLED,
100 args points to slot holding list of
106 KBOARD
*initial_kboard
;
107 KBOARD
*current_kboard
;
111 KBOARD the_only_kboard
;
114 /* Non-nil disable property on a command means
115 do not execute it; call disabled-command-hook's value instead. */
116 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
118 #define NUM_RECENT_KEYS (100)
119 int recent_keys_index
; /* Index for storing next element into recent_keys */
120 int total_keys
; /* Total number of elements stored into recent_keys */
121 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
123 /* Vector holding the key sequence that invoked the current command.
124 It is reused for each command, and it may be longer than the current
125 sequence; this_command_key_count indicates how many elements
126 actually mean something.
127 It's easier to staticpro a single Lisp_Object than an array. */
128 Lisp_Object this_command_keys
;
129 int this_command_key_count
;
131 /* Number of elements of this_command_keys
132 that precede this key sequence. */
133 int this_single_command_key_start
;
135 /* Record values of this_command_key_count and echo_length ()
136 before this command was read. */
137 static int before_command_key_count
;
138 static int before_command_echo_length
;
139 /* Values of before_command_key_count and before_command_echo_length
140 saved by reset-this-command-lengths. */
141 static int before_command_key_count_1
;
142 static int before_command_echo_length_1
;
143 /* Flag set by reset-this-command-lengths,
144 saying to reset the lengths when add_command_key is called. */
145 static int before_command_restore_flag
;
147 extern int minbuf_level
;
149 extern int message_enable_multibyte
;
151 extern struct backtrace
*backtrace_list
;
153 /* Nonzero means do menu prompting. */
154 static int menu_prompting
;
156 /* Character to see next line of menu prompt. */
157 static Lisp_Object menu_prompt_more_char
;
159 /* For longjmp to where kbd input is being done. */
160 static jmp_buf getcjmp
;
162 /* True while doing kbd input. */
163 int waiting_for_input
;
165 /* True while displaying for echoing. Delays C-g throwing. */
168 /* True means we can start echoing at the next input pause
169 even though there is something in the echo area. */
170 static char *ok_to_echo_at_next_pause
;
172 /* Nonzero means disregard local maps for the menu bar. */
173 static int inhibit_local_menu_bar_menus
;
175 /* Nonzero means C-g should cause immediate error-signal. */
178 /* The user's ERASE setting. */
179 Lisp_Object Vtty_erase_char
;
181 /* Character to recognize as the help char. */
182 Lisp_Object Vhelp_char
;
184 /* List of other event types to recognize as meaning "help". */
185 Lisp_Object Vhelp_event_list
;
187 /* Form to execute when help char is typed. */
188 Lisp_Object Vhelp_form
;
190 /* Command to run when the help character follows a prefix key. */
191 Lisp_Object Vprefix_help_command
;
193 /* List of items that should move to the end of the menu bar. */
194 Lisp_Object Vmenu_bar_final_items
;
196 /* Non-nil means show the equivalent key-binding for
197 any M-x command that has one.
198 The value can be a length of time to show the message for.
199 If the value is non-nil and not a number, we wait 2 seconds. */
200 Lisp_Object Vsuggest_key_bindings
;
202 /* Character that causes a quit. Normally C-g.
204 If we are running on an ordinary terminal, this must be an ordinary
205 ASCII char, since we want to make it our interrupt character.
207 If we are not running on an ordinary terminal, it still needs to be
208 an ordinary ASCII char. This character needs to be recognized in
209 the input interrupt handler. At this point, the keystroke is
210 represented as a struct input_event, while the desired quit
211 character is specified as a lispy event. The mapping from struct
212 input_events to lispy events cannot run in an interrupt handler,
213 and the reverse mapping is difficult for anything but ASCII
216 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
220 extern Lisp_Object current_global_map
;
221 extern int minibuf_level
;
223 /* If non-nil, this is a map that overrides all other local maps. */
224 Lisp_Object Voverriding_local_map
;
226 /* If non-nil, Voverriding_local_map applies to the menu bar. */
227 Lisp_Object Voverriding_local_map_menu_flag
;
229 /* Keymap that defines special misc events that should
230 be processed immediately at a low level. */
231 Lisp_Object Vspecial_event_map
;
233 /* Current depth in recursive edits. */
234 int command_loop_level
;
236 /* Total number of times command_loop has read a key sequence. */
239 /* Last input character read as a command. */
240 Lisp_Object last_command_char
;
242 /* Last input character read as a command, not counting menus
243 reached by the mouse. */
244 Lisp_Object last_nonmenu_event
;
246 /* Last input character read for any purpose. */
247 Lisp_Object last_input_char
;
249 /* If not Qnil, a list of objects to be read as subsequent command input. */
250 Lisp_Object Vunread_command_events
;
252 /* If not -1, an event to be read as subsequent command input. */
253 int unread_command_char
;
255 /* If not Qnil, this is a switch-frame event which we decided to put
256 off until the end of a key sequence. This should be read as the
257 next command input, after any unread_command_events.
259 read_key_sequence uses this to delay switch-frame events until the
260 end of the key sequence; Fread_char uses it to put off switch-frame
261 events until a non-ASCII event is acceptable as input. */
262 Lisp_Object unread_switch_frame
;
264 /* A mask of extra modifier bits to put into every keyboard char. */
265 int extra_keyboard_modifiers
;
267 /* Char to use as prefix when a meta character is typed in.
268 This is bound on entry to minibuffer in case ESC is changed there. */
270 Lisp_Object meta_prefix_char
;
272 /* Last size recorded for a current buffer which is not a minibuffer. */
273 static int last_non_minibuf_size
;
275 /* Number of idle seconds before an auto-save and garbage collection. */
276 static Lisp_Object Vauto_save_timeout
;
278 /* Total number of times read_char has returned. */
279 int num_input_events
;
281 /* Total number of times read_char has returned, outside of macros. */
282 int num_nonmacro_input_events
;
284 /* Auto-save automatically when this many characters have been typed
285 since the last time. */
287 static int auto_save_interval
;
289 /* Value of num_nonmacro_input_events as of last auto save. */
293 /* The command being executed by the command loop.
294 Commands may set this, and the value set will be copied into
295 current_kboard->Vlast_command instead of the actual command. */
296 Lisp_Object this_command
;
298 /* The value of point when the last command was executed. */
299 int last_point_position
;
301 /* The buffer that was current when the last command was started. */
302 Lisp_Object last_point_position_buffer
;
304 /* The frame in which the last input event occurred, or Qmacro if the
305 last event came from a macro. We use this to determine when to
306 generate switch-frame events. This may be cleared by functions
307 like Fselect_frame, to make sure that a switch-frame event is
308 generated by the next character. */
309 Lisp_Object internal_last_event_frame
;
311 /* A user-visible version of the above, intended to allow users to
312 figure out where the last event came from, if the event doesn't
313 carry that information itself (i.e. if it was a character). */
314 Lisp_Object Vlast_event_frame
;
316 /* The timestamp of the last input event we received from the X server.
317 X Windows wants this for selection ownership. */
318 unsigned long last_event_timestamp
;
320 Lisp_Object Qself_insert_command
;
321 Lisp_Object Qforward_char
;
322 Lisp_Object Qbackward_char
;
323 Lisp_Object Qundefined
;
324 Lisp_Object Qtimer_event_handler
;
326 /* read_key_sequence stores here the command definition of the
327 key sequence that it reads. */
328 Lisp_Object read_key_sequence_cmd
;
330 /* Form to evaluate (if non-nil) when Emacs is started. */
331 Lisp_Object Vtop_level
;
333 /* User-supplied string to translate input characters through. */
334 Lisp_Object Vkeyboard_translate_table
;
336 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
337 extern Lisp_Object Vfunction_key_map
;
339 /* Another keymap that maps key sequences into key sequences.
340 This one takes precedence over ordinary definitions. */
341 extern Lisp_Object Vkey_translation_map
;
343 /* Non-nil means deactivate the mark at end of this command. */
344 Lisp_Object Vdeactivate_mark
;
346 /* Menu bar specified in Lucid Emacs fashion. */
348 Lisp_Object Vlucid_menu_bar_dirty_flag
;
349 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
351 Lisp_Object Qecho_area_clear_hook
;
353 /* Hooks to run before and after each command. */
354 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
355 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
356 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
357 /* Hook run after a command if there's no more input soon. */
358 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
360 /* Delay time in microseconds before running post-command-idle-hook. */
361 int post_command_idle_delay
;
363 /* List of deferred actions to be performed at a later time.
364 The precise format isn't relevant here; we just check whether it is nil. */
365 Lisp_Object Vdeferred_action_list
;
367 /* Function to call to handle deferred actions, when there are any. */
368 Lisp_Object Vdeferred_action_function
;
369 Lisp_Object Qdeferred_action_function
;
371 /* File in which we write all commands we read. */
374 /* Nonzero if input is available. */
377 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
378 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
382 extern char *pending_malloc_warning
;
384 /* Circular buffer for pre-read keyboard input. */
385 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
387 /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.
389 The interrupt-level event handlers will never enqueue an event on a
390 frame which is not in Vframe_list, and once an event is dequeued,
391 internal_last_event_frame or the event itself points to the frame.
394 But while the event is sitting in the queue, it's completely
395 unprotected. Suppose the user types one command which will run for
396 a while and then delete a frame, and then types another event at
397 the frame that will be deleted, before the command gets around to
398 it. Suppose there are no references to this frame elsewhere in
399 Emacs, and a GC occurs before the second event is dequeued. Now we
400 have an event referring to a freed frame, which will crash Emacs
403 Similar things happen when an event on a scroll bar is enqueued; the
404 window may be deleted while the event is in the queue.
406 So, we use this vector to protect the frame_or_window field in the
407 event queue. That way, they'll be dequeued as dead frames or
408 windows, but still valid lisp objects.
410 If kbd_buffer[i].kind != no_event, then
411 (XVECTOR (kbd_buffer_frame_or_window)->contents[i]
412 == kbd_buffer[i].frame_or_window. */
413 static Lisp_Object kbd_buffer_frame_or_window
;
415 /* Pointer to next available character in kbd_buffer.
416 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
417 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
418 next available char is in kbd_buffer[0]. */
419 static struct input_event
*kbd_fetch_ptr
;
421 /* Pointer to next place to store character in kbd_buffer. This
422 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
423 character should go in kbd_buffer[0]. */
424 static volatile struct input_event
*kbd_store_ptr
;
426 /* The above pair of variables forms a "queue empty" flag. When we
427 enqueue a non-hook event, we increment kbd_store_ptr. When we
428 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
429 there is input available iff the two pointers are not equal.
431 Why not just have a flag set and cleared by the enqueuing and
432 dequeuing functions? Such a flag could be screwed up by interrupts
433 at inopportune times. */
435 /* If this flag is non-nil, we check mouse_moved to see when the
436 mouse moves, and motion events will appear in the input stream.
437 Otherwise, mouse motion is ignored. */
438 static Lisp_Object do_mouse_tracking
;
440 /* Symbols to head events. */
441 Lisp_Object Qmouse_movement
;
442 Lisp_Object Qscroll_bar_movement
;
443 Lisp_Object Qswitch_frame
;
444 Lisp_Object Qdelete_frame
;
445 Lisp_Object Qiconify_frame
;
446 Lisp_Object Qmake_frame_visible
;
448 /* Symbols to denote kinds of events. */
449 Lisp_Object Qfunction_key
;
450 Lisp_Object Qmouse_click
;
452 Lisp_Object Qmouse_wheel
;
454 Lisp_Object Qdrag_n_drop
;
455 /* Lisp_Object Qmouse_movement; - also an event header */
457 /* Properties of event headers. */
458 Lisp_Object Qevent_kind
;
459 Lisp_Object Qevent_symbol_elements
;
461 /* menu item parts */
462 Lisp_Object Qmenu_alias
;
463 Lisp_Object Qmenu_enable
;
464 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
465 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
466 extern Lisp_Object Vdefine_key_rebound_commands
;
467 extern Lisp_Object Qmenu_item
;
469 /* An event header symbol HEAD may have a property named
470 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
471 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
472 mask of modifiers applied to it. If present, this is used to help
473 speed up parse_modifiers. */
474 Lisp_Object Qevent_symbol_element_mask
;
476 /* An unmodified event header BASE may have a property named
477 Qmodifier_cache, which is an alist mapping modifier masks onto
478 modified versions of BASE. If present, this helps speed up
480 Lisp_Object Qmodifier_cache
;
482 /* Symbols to use for parts of windows. */
483 Lisp_Object Qmode_line
;
484 Lisp_Object Qvertical_line
;
485 Lisp_Object Qvertical_scroll_bar
;
486 Lisp_Object Qmenu_bar
;
488 Lisp_Object
recursive_edit_unwind (), command_loop ();
489 Lisp_Object
Fthis_command_keys ();
490 Lisp_Object Qextended_command_history
;
491 EMACS_TIME
timer_check ();
493 extern Lisp_Object Vhistory_length
;
495 extern char *x_get_keysym_name ();
497 static void record_menu_key ();
499 Lisp_Object Qpolling_period
;
501 /* List of absolute timers. Appears in order of next scheduled event. */
502 Lisp_Object Vtimer_list
;
504 /* List of idle time timers. Appears in order of next scheduled event. */
505 Lisp_Object Vtimer_idle_list
;
507 /* Incremented whenever a timer is run. */
510 extern Lisp_Object Vprint_level
, Vprint_length
;
512 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
514 EMACS_TIME
*input_available_clear_time
;
516 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
517 Default is 1 if INTERRUPT_INPUT is defined. */
520 /* Nonzero while interrupts are temporarily deferred during redisplay. */
521 int interrupts_deferred
;
523 /* Nonzero means use ^S/^Q for flow control. */
526 /* Allow m- file to inhibit use of FIONREAD. */
527 #ifdef BROKEN_FIONREAD
531 /* We are unable to use interrupts if FIONREAD is not available,
532 so flush SIGIO so we won't try. */
539 /* If we support a window system, turn on the code to poll periodically
540 to detect C-g. It isn't actually used when doing interrupt input. */
541 #ifdef HAVE_WINDOW_SYSTEM
542 #define POLL_FOR_INPUT
545 /* Global variable declarations. */
547 /* Function for init_keyboard to call with no args (if nonzero). */
548 void (*keyboard_init_hook
) ();
550 static int read_avail_input ();
551 static void get_input_pending ();
552 static int readable_events ();
553 static Lisp_Object
read_char_x_menu_prompt ();
554 static Lisp_Object
read_char_minibuf_menu_prompt ();
555 static Lisp_Object
make_lispy_event ();
557 static Lisp_Object
make_lispy_movement ();
559 static Lisp_Object
modify_event_symbol ();
560 static Lisp_Object
make_lispy_switch_frame ();
561 static int parse_solitary_modifier ();
562 static void save_getcjmp ();
563 static void restore_getcjmp ();
565 /* > 0 if we are to echo keystrokes. */
566 static int echo_keystrokes
;
568 /* Nonzero means don't try to suspend even if the operating system seems
570 static int cannot_suspend
;
572 #define min(a,b) ((a)<(b)?(a):(b))
573 #define max(a,b) ((a)>(b)?(a):(b))
575 /* Install the string STR as the beginning of the string of echoing,
576 so that it serves as a prompt for the next character.
577 Also start echoing. */
583 int len
= strlen (str
);
585 if (len
> ECHOBUFSIZE
- 4)
586 len
= ECHOBUFSIZE
- 4;
587 bcopy (str
, current_kboard
->echobuf
, len
);
588 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
589 *current_kboard
->echoptr
= '\0';
591 current_kboard
->echo_after_prompt
= len
;
596 /* Add C to the echo string, if echoing is going on.
597 C can be a character, which is printed prettily ("M-C-x" and all that
598 jazz), or a symbol, whose name is printed. */
604 extern char *push_key_description ();
606 if (current_kboard
->immediate_echo
)
608 char *ptr
= current_kboard
->echoptr
;
610 if (ptr
!= current_kboard
->echobuf
)
613 /* If someone has passed us a composite event, use its head symbol. */
618 if (ptr
- current_kboard
->echobuf
> ECHOBUFSIZE
- 6)
621 ptr
= push_key_description (XINT (c
), ptr
);
623 else if (SYMBOLP (c
))
625 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
626 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
629 bcopy (name
->data
, ptr
, STRING_BYTES (name
));
630 ptr
+= STRING_BYTES (name
);
633 if (current_kboard
->echoptr
== current_kboard
->echobuf
636 strcpy (ptr
, " (Type ? for further options)");
641 current_kboard
->echoptr
= ptr
;
647 /* Temporarily add a dash to the end of the echo string if it's not
648 empty, so that it serves as a mini-prompt for the very next character. */
653 if (!current_kboard
->immediate_echo
654 && current_kboard
->echoptr
== current_kboard
->echobuf
)
656 /* Do nothing if we just printed a prompt. */
657 if (current_kboard
->echo_after_prompt
658 == current_kboard
->echoptr
- current_kboard
->echobuf
)
660 /* Do nothing if not echoing at all. */
661 if (current_kboard
->echoptr
== 0)
664 /* Put a dash at the end of the buffer temporarily,
665 but make it go away when the next character is added. */
666 current_kboard
->echoptr
[0] = '-';
667 current_kboard
->echoptr
[1] = 0;
672 /* Display the current echo string, and begin echoing if not already
678 if (!current_kboard
->immediate_echo
)
681 current_kboard
->immediate_echo
= 1;
683 for (i
= 0; i
< this_command_key_count
; i
++)
686 c
= XVECTOR (this_command_keys
)->contents
[i
];
687 if (! (EVENT_HAS_PARAMETERS (c
)
688 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
695 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
696 ! NILP (current_buffer
->enable_multibyte_characters
));
700 if (waiting_for_input
&& !NILP (Vquit_flag
))
701 quit_throw_to_read_char ();
704 /* Turn off echoing, for the start of a new command. */
709 current_kboard
->immediate_echo
= 0;
710 current_kboard
->echoptr
= current_kboard
->echobuf
;
711 current_kboard
->echo_after_prompt
= -1;
712 ok_to_echo_at_next_pause
= 0;
715 /* Return the length of the current echo string. */
720 return current_kboard
->echoptr
- current_kboard
->echobuf
;
723 /* Truncate the current echo message to its first LEN chars.
724 This and echo_char get used by read_key_sequence when the user
725 switches frames while entering a key sequence. */
731 current_kboard
->echobuf
[len
] = '\0';
732 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
733 truncate_echo_area (len
);
737 /* Functions for manipulating this_command_keys. */
739 add_command_key (key
)
742 int size
= XVECTOR (this_command_keys
)->size
;
744 /* If reset-this-command-length was called recently, obey it now.
745 See the doc string of that function for an explanation of why. */
746 if (before_command_restore_flag
)
748 this_command_key_count
= before_command_key_count_1
;
749 if (this_command_key_count
< this_single_command_key_start
)
750 this_single_command_key_start
= this_command_key_count
;
751 echo_truncate (before_command_echo_length_1
);
752 before_command_restore_flag
= 0;
755 if (this_command_key_count
>= size
)
757 Lisp_Object new_keys
;
759 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
760 bcopy (XVECTOR (this_command_keys
)->contents
,
761 XVECTOR (new_keys
)->contents
,
762 size
* sizeof (Lisp_Object
));
764 this_command_keys
= new_keys
;
767 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
773 int count
= specpdl_ptr
- specpdl
;
776 if (command_loop_level
> 0)
778 specbind (Qstandard_output
, Qt
);
779 specbind (Qstandard_input
, Qt
);
782 val
= command_loop ();
784 Fsignal (Qquit
, Qnil
);
785 /* Handle throw from read_minibuf when using minibuffer
786 while it's active but we're in another window. */
788 Fsignal (Qerror
, Fcons (val
, Qnil
));
790 return unbind_to (count
, Qnil
);
793 /* When an auto-save happens, record the "time", and don't do again soon. */
798 last_auto_save
= num_nonmacro_input_events
;
801 /* Make an auto save happen as soon as possible at command level. */
804 force_auto_save_soon ()
806 last_auto_save
= - auto_save_interval
- 1;
808 record_asynch_buffer_change ();
811 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
812 "Invoke the editor command loop recursively.\n\
813 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
814 that tells this function to return.\n\
815 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
816 This function is called by the editor initialization to begin editing.")
819 int count
= specpdl_ptr
- specpdl
;
822 command_loop_level
++;
823 update_mode_lines
= 1;
825 record_unwind_protect (recursive_edit_unwind
,
827 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
831 return unbind_to (count
, Qnil
);
835 recursive_edit_unwind (buffer
)
839 Fset_buffer (buffer
);
841 command_loop_level
--;
842 update_mode_lines
= 1;
850 #if 0 /* Theory: if there's anything in Vunread_command_events,
851 it will right away be read by read_key_sequence,
852 and then if we do switch KBOARDS, it will go into the side
853 queue then. So we don't need to do anything special here -- rms. */
854 if (CONSP (Vunread_command_events
))
856 current_kboard
->kbd_queue
857 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
858 current_kboard
->kbd_queue_has_data
= 1;
860 Vunread_command_events
= Qnil
;
866 /* Switch to the single-kboard state, making current_kboard
867 the only KBOARD from which further input is accepted. */
870 single_kboard_state ()
877 /* Maintain a stack of kboards, so other parts of Emacs
878 can switch temporarily to the kboard of a given frame
879 and then revert to the previous status. */
884 struct kboard_stack
*next
;
887 static struct kboard_stack
*kboard_stack
;
890 push_frame_kboard (f
)
894 struct kboard_stack
*p
895 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
897 p
->next
= kboard_stack
;
898 p
->kboard
= current_kboard
;
901 current_kboard
= FRAME_KBOARD (f
);
909 struct kboard_stack
*p
= kboard_stack
;
910 current_kboard
= p
->kboard
;
911 kboard_stack
= p
->next
;
916 /* Handle errors that are not handled at inner levels
917 by printing an error message and returning to the editor command loop. */
923 Lisp_Object old_level
, old_length
;
926 if (!NILP (executing_macro
))
928 if (executing_macro_iterations
== 1)
929 sprintf (macroerror
, "After 1 kbd macro iteration: ");
931 sprintf (macroerror
, "After %d kbd macro iterations: ",
932 executing_macro_iterations
);
937 Vstandard_output
= Qt
;
938 Vstandard_input
= Qt
;
939 Vexecuting_macro
= Qnil
;
940 executing_macro
= Qnil
;
941 current_kboard
->Vprefix_arg
= Qnil
;
944 /* Avoid unquittable loop if data contains a circular list. */
945 old_level
= Vprint_level
;
946 old_length
= Vprint_length
;
947 XSETFASTINT (Vprint_level
, 10);
948 XSETFASTINT (Vprint_length
, 10);
949 cmd_error_internal (data
, macroerror
);
950 Vprint_level
= old_level
;
951 Vprint_length
= old_length
;
955 Vinhibit_quit
= Qnil
;
960 return make_number (0);
963 /* Take actions on handling an error. DATA is the data that describes
966 CONTEXT is a C-string containing ASCII characters only which
967 describes the context in which the error happened. If we need to
968 generalize CONTEXT to allow multibyte characters, make it a Lisp
972 cmd_error_internal (data
, context
)
980 echo_area_glyphs
= 0;
982 /* If the window system or terminal frame hasn't been initialized
983 yet, or we're not interactive, it's best to dump this message out
984 to stderr and exit. */
985 if (! FRAME_MESSAGE_BUF (selected_frame
)
987 stream
= Qexternal_debugging_output
;
996 write_string_1 (context
, -1, stream
);
998 print_error_message (data
, stream
);
1000 /* If the window system or terminal frame hasn't been initialized
1001 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1002 if (! FRAME_MESSAGE_BUF (selected_frame
)
1006 Fkill_emacs (make_number (-1));
1010 Lisp_Object
command_loop_1 ();
1011 Lisp_Object
command_loop_2 ();
1012 Lisp_Object
top_level_1 ();
1014 /* Entry to editor-command-loop.
1015 This level has the catches for exiting/returning to editor command loop.
1016 It returns nil to exit recursive edit, t to abort it. */
1021 if (command_loop_level
> 0 || minibuf_level
> 0)
1023 return internal_catch (Qexit
, command_loop_2
, Qnil
);
1028 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1029 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1031 /* End of file in -batch run causes exit here. */
1037 /* Here we catch errors in execution of commands within the
1038 editing loop, and reenter the editing loop.
1039 When there is an error, cmd_error runs and returns a non-nil
1040 value to us. A value of nil means that cmd_loop_1 itself
1041 returned due to end of file (or end of kbd macro). */
1046 register Lisp_Object val
;
1049 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1050 while (!NILP (val
));
1058 return Feval (Vtop_level
);
1064 /* On entry to the outer level, run the startup file */
1065 if (!NILP (Vtop_level
))
1066 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1067 else if (!NILP (Vpurify_flag
))
1068 message ("Bare impure Emacs (standard Lisp code not loaded)");
1070 message ("Bare Emacs (standard Lisp code not loaded)");
1074 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1075 "Exit all recursive editing levels.")
1078 Fthrow (Qtop_level
, Qnil
);
1081 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1082 "Exit from the innermost recursive edit or minibuffer.")
1085 if (command_loop_level
> 0 || minibuf_level
> 0)
1086 Fthrow (Qexit
, Qnil
);
1088 error ("No recursive edit is in progress");
1091 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1092 "Abort the command that requested this recursive edit or minibuffer input.")
1095 if (command_loop_level
> 0 || minibuf_level
> 0)
1098 error ("No recursive edit is in progress");
1101 /* This is the actual command reading loop,
1102 sans error-handling encapsulation. */
1104 Lisp_Object
Fcommand_execute ();
1105 static int read_key_sequence ();
1106 void safe_run_hooks ();
1111 Lisp_Object cmd
, tem
;
1114 Lisp_Object keybuf
[30];
1119 struct buffer
*prev_buffer
;
1121 int was_locked
= single_kboard
;
1124 current_kboard
->Vprefix_arg
= Qnil
;
1125 Vdeactivate_mark
= Qnil
;
1126 waiting_for_input
= 0;
1131 this_command_key_count
= 0;
1132 this_single_command_key_start
= 0;
1134 /* Make sure this hook runs after commands that get errors and
1135 throw to top level. */
1136 /* Note that the value cell will never directly contain nil
1137 if the symbol is a local variable. */
1138 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1139 safe_run_hooks (Qpost_command_hook
);
1141 if (!NILP (Vdeferred_action_list
))
1142 call0 (Vdeferred_action_function
);
1144 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1146 if (NILP (Vunread_command_events
)
1147 && NILP (Vexecuting_macro
)
1148 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1149 safe_run_hooks (Qpost_command_idle_hook
);
1152 /* Do this after running Vpost_command_hook, for consistency. */
1153 current_kboard
->Vlast_command
= this_command
;
1157 /* Make sure the current window's buffer is selected. */
1158 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1159 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1161 /* Display any malloc warning that just came out. Use while because
1162 displaying one warning can cause another. */
1164 while (pending_malloc_warning
)
1165 display_malloc_warning ();
1169 Vdeactivate_mark
= Qnil
;
1171 /* If minibuffer on and echo area in use,
1172 wait 2 sec and redraw minibuffer. */
1174 if (minibuf_level
&& echo_area_glyphs
1175 && EQ (minibuf_window
, echo_area_window
))
1177 /* Bind inhibit-quit to t so that C-g gets read in
1178 rather than quitting back to the minibuffer. */
1179 int count
= specpdl_ptr
- specpdl
;
1180 specbind (Qinhibit_quit
, Qt
);
1182 Fsit_for (make_number (2), Qnil
, Qnil
);
1183 /* Clear the echo area. */
1185 safe_run_hooks (Qecho_area_clear_hook
);
1187 unbind_to (count
, Qnil
);
1189 /* If a C-g came in before, treat it as input now. */
1190 if (!NILP (Vquit_flag
))
1193 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1198 alloca (0); /* Cause a garbage collection now */
1199 /* Since we can free the most stuff here. */
1200 #endif /* C_ALLOCA */
1203 /* Select the frame that the last event came from. Usually,
1204 switch-frame events will take care of this, but if some lisp
1205 code swallows a switch-frame event, we'll fix things up here.
1206 Is this a good idea? */
1207 if (FRAMEP (internal_last_event_frame
)
1208 && XFRAME (internal_last_event_frame
) != selected_frame
)
1209 Fselect_frame (internal_last_event_frame
, Qnil
);
1211 /* If it has changed current-menubar from previous value,
1212 really recompute the menubar from the value. */
1213 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1214 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1215 call0 (Qrecompute_lucid_menubar
);
1217 before_command_key_count
= this_command_key_count
;
1218 before_command_echo_length
= echo_length ();
1220 this_command
= Qnil
;
1222 /* Read next key sequence; i gets its length. */
1223 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1226 /* A filter may have run while we were reading the input. */
1227 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1228 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1232 /* Now we have read a key sequence of length I,
1233 or else I is 0 and we found end of file. */
1235 if (i
== 0) /* End of file -- happens only in */
1236 return Qnil
; /* a kbd macro, at the end. */
1237 /* -1 means read_key_sequence got a menu that was rejected.
1238 Just loop around and read another command. */
1242 this_command_key_count
= 0;
1243 this_single_command_key_start
= 0;
1247 last_command_char
= keybuf
[i
- 1];
1249 /* If the previous command tried to force a specific window-start,
1250 forget about that, in case this command moves point far away
1251 from that position. But also throw away beg_unchanged and
1252 end_unchanged information in that case, so that redisplay will
1253 update the whole window properly. */
1254 if (!NILP (XWINDOW (selected_window
)->force_start
))
1256 XWINDOW (selected_window
)->force_start
= Qnil
;
1257 beg_unchanged
= end_unchanged
= 0;
1260 cmd
= read_key_sequence_cmd
;
1261 if (!NILP (Vexecuting_macro
))
1263 if (!NILP (Vquit_flag
))
1265 Vexecuting_macro
= Qt
;
1266 QUIT
; /* Make some noise. */
1267 /* Will return since macro now empty. */
1271 /* Do redisplay processing after this command except in special
1272 cases identified below that set no_redisplay to 1.
1273 (actually, there's currently no way to prevent the redisplay,
1274 and no_redisplay is ignored.
1275 Perhaps someday we will really implement it.) */
1278 prev_buffer
= current_buffer
;
1279 prev_modiff
= MODIFF
;
1280 last_point_position
= PT
;
1281 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1283 /* Execute the command. */
1286 /* Note that the value cell will never directly contain nil
1287 if the symbol is a local variable. */
1288 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1289 safe_run_hooks (Qpre_command_hook
);
1291 if (NILP (this_command
))
1293 /* nil means key is undefined. */
1295 current_kboard
->defining_kbd_macro
= Qnil
;
1296 update_mode_lines
= 1;
1297 current_kboard
->Vprefix_arg
= Qnil
;
1301 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1303 /* Recognize some common commands in common situations and
1304 do them directly. */
1305 if (EQ (this_command
, Qforward_char
) && PT
< ZV
)
1307 struct Lisp_Char_Table
*dp
1308 = window_display_table (XWINDOW (selected_window
));
1309 lose
= FETCH_BYTE (PT_BYTE
);
1312 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1313 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1314 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1315 && (lose
>= 0x20 && lose
< 0x7f)))
1316 : (lose
>= 0x20 && lose
< 0x7f))
1317 /* To extract the case of continuation on
1318 wide-column characters. */
1319 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1320 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1322 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1324 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1326 && !windows_or_buffers_changed
1327 && EQ (current_buffer
->selective_display
, Qnil
)
1328 && !detect_input_pending ()
1329 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1330 && NILP (Vexecuting_macro
))
1331 no_redisplay
= direct_output_forward_char (1);
1334 else if (EQ (this_command
, Qbackward_char
) && PT
> BEGV
)
1336 struct Lisp_Char_Table
*dp
1337 = window_display_table (XWINDOW (selected_window
));
1339 lose
= FETCH_BYTE (PT_BYTE
);
1341 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1342 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1343 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1344 && (lose
>= 0x20 && lose
< 0x7f)))
1345 : (lose
>= 0x20 && lose
< 0x7f))
1346 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1348 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1350 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1352 && !windows_or_buffers_changed
1353 && EQ (current_buffer
->selective_display
, Qnil
)
1354 && !detect_input_pending ()
1355 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1356 && NILP (Vexecuting_macro
))
1357 no_redisplay
= direct_output_forward_char (-1);
1360 else if (EQ (this_command
, Qself_insert_command
)
1361 /* Try this optimization only on ascii keystrokes. */
1362 && INTEGERP (last_command_char
))
1364 unsigned int c
= XINT (last_command_char
);
1367 if (NILP (Vexecuting_macro
)
1368 && !EQ (minibuf_window
, selected_window
))
1370 if (!nonundocount
|| nonundocount
>= 20)
1377 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1379 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1381 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1383 || MODIFF
<= SAVE_MODIFF
1384 || windows_or_buffers_changed
1385 || !EQ (current_buffer
->selective_display
, Qnil
)
1386 || detect_input_pending ()
1387 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1388 || !NILP (Vexecuting_macro
));
1389 value
= internal_self_insert (c
, 0);
1396 && (PT
== ZV
|| FETCH_BYTE (PT_BYTE
) == '\n'))
1398 struct Lisp_Char_Table
*dp
1399 = window_display_table (XWINDOW (selected_window
));
1402 /* Add the offset to the character, for Finsert_char.
1403 We pass internal_self_insert the unmodified character
1404 because it itself does this offsetting. */
1405 if (! NILP (current_buffer
->enable_multibyte_characters
))
1406 lose
= unibyte_char_to_multibyte (lose
);
1412 obj
= DISP_CHAR_VECTOR (dp
, lose
);
1415 /* Do it only for char codes
1416 that by default display as themselves. */
1417 if (lose
>= 0x20 && lose
<= 0x7e)
1418 no_redisplay
= direct_output_for_insert (lose
);
1420 else if (VECTORP (obj
)
1421 && XVECTOR (obj
)->size
== 1
1422 && (obj
= XVECTOR (obj
)->contents
[0],
1424 /* Insist face not specified in glyph. */
1425 && (XINT (obj
) & ((-1) << 8)) == 0)
1427 = direct_output_for_insert (XINT (obj
));
1431 if (lose
>= 0x20 && lose
<= 0x7e)
1432 no_redisplay
= direct_output_for_insert (lose
);
1439 /* Here for a command that isn't executed directly */
1442 if (NILP (current_kboard
->Vprefix_arg
))
1444 Fcommand_execute (this_command
, Qnil
, Qnil
, Qnil
);
1449 /* Note that the value cell will never directly contain nil
1450 if the symbol is a local variable. */
1451 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1452 safe_run_hooks (Qpost_command_hook
);
1454 if (!NILP (Vdeferred_action_list
))
1455 safe_run_hooks (Qdeferred_action_function
);
1457 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1459 if (NILP (Vunread_command_events
)
1460 && NILP (Vexecuting_macro
)
1461 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1462 safe_run_hooks (Qpost_command_idle_hook
);
1465 /* If there is a prefix argument,
1466 1) We don't want Vlast_command to be ``universal-argument''
1467 (that would be dumb), so don't set Vlast_command,
1468 2) we want to leave echoing on so that the prefix will be
1469 echoed as part of this key sequence, so don't call
1471 3) we want to leave this_command_key_count non-zero, so that
1472 read_char will realize that it is re-reading a character, and
1473 not echo it a second time.
1475 If the command didn't actually create a prefix arg,
1476 but is merely a frame event that is transparent to prefix args,
1477 then the above doesn't apply. */
1478 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1480 current_kboard
->Vlast_command
= this_command
;
1482 this_command_key_count
= 0;
1483 this_single_command_key_start
= 0;
1486 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1488 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1490 current_buffer
->mark_active
= Qnil
;
1491 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1493 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1494 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1498 /* Install chars successfully executed in kbd macro. */
1500 if (!NILP (current_kboard
->defining_kbd_macro
)
1501 && NILP (current_kboard
->Vprefix_arg
))
1502 finalize_kbd_macro_chars ();
1506 any_kboard_state ();
1511 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1514 safe_run_hooks_1 (hook
)
1517 return call1 (Vrun_hooks
, Vinhibit_quit
);
1520 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1523 safe_run_hooks_error (data
)
1526 Fset (Vinhibit_quit
, Qnil
);
1529 /* If we get an error while running the hook, cause the hook variable
1530 to be nil. Also inhibit quits, so that C-g won't cause the hook
1531 to mysteriously evaporate. */
1534 safe_run_hooks (hook
)
1538 int count
= specpdl_ptr
- specpdl
;
1539 specbind (Qinhibit_quit
, hook
);
1541 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1543 unbind_to (count
, Qnil
);
1546 /* Number of seconds between polling for input. */
1549 /* Nonzero means polling for input is temporarily suppressed. */
1550 int poll_suppress_count
;
1552 /* Nonzero if polling_for_input is actually being used. */
1553 int polling_for_input
;
1555 #ifdef POLL_FOR_INPUT
1557 /* Handle an alarm once each second and read pending input
1558 so as to handle a C-g if it comces in. */
1561 input_poll_signal (signalnum
) /* If we don't have an argument, */
1562 int signalnum
; /* some compilers complain in signal calls. */
1564 /* This causes the call to start_polling at the end
1565 to do its job. It also arranges for a quit or error
1566 from within read_avail_input to resume polling. */
1567 poll_suppress_count
++;
1568 if (interrupt_input_blocked
== 0
1569 && !waiting_for_input
)
1570 read_avail_input (0);
1571 /* Turn on the SIGALRM handler and request another alarm. */
1577 /* Begin signals to poll for input, if they are appropriate.
1578 This function is called unconditionally from various places. */
1583 #ifdef POLL_FOR_INPUT
1584 if (read_socket_hook
&& !interrupt_input
)
1586 poll_suppress_count
--;
1587 if (poll_suppress_count
== 0)
1589 signal (SIGALRM
, input_poll_signal
);
1590 polling_for_input
= 1;
1591 alarm (polling_period
);
1597 /* Nonzero if we are using polling to handle input asynchronously. */
1600 input_polling_used ()
1602 #ifdef POLL_FOR_INPUT
1603 return read_socket_hook
&& !interrupt_input
;
1609 /* Turn off polling. */
1614 #ifdef POLL_FOR_INPUT
1615 if (read_socket_hook
&& !interrupt_input
)
1617 if (poll_suppress_count
== 0)
1619 polling_for_input
= 0;
1622 poll_suppress_count
++;
1627 /* Set the value of poll_suppress_count to COUNT
1628 and start or stop polling accordingly. */
1631 set_poll_suppress_count (count
)
1634 #ifdef POLL_FOR_INPUT
1635 if (count
== 0 && poll_suppress_count
!= 0)
1637 poll_suppress_count
= 1;
1640 else if (count
!= 0 && poll_suppress_count
== 0)
1644 poll_suppress_count
= count
;
1648 /* Bind polling_period to a value at least N.
1649 But don't decrease it. */
1652 bind_polling_period (n
)
1655 #ifdef POLL_FOR_INPUT
1656 int new = polling_period
;
1662 specbind (Qpolling_period
, make_number (new));
1663 /* Start a new alarm with the new period. */
1668 /* Apply the control modifier to CHARACTER. */
1674 /* Save the upper bits here. */
1675 int upper
= c
& ~0177;
1679 /* Everything in the columns containing the upper-case letters
1680 denotes a control character. */
1681 if (c
>= 0100 && c
< 0140)
1685 /* Set the shift modifier for a control char
1686 made from a shifted letter. But only for letters! */
1687 if (oc
>= 'A' && oc
<= 'Z')
1688 c
|= shift_modifier
;
1691 /* The lower-case letters denote control characters too. */
1692 else if (c
>= 'a' && c
<= 'z')
1695 /* Include the bits for control and shift
1696 only if the basic ASCII code can't indicate them. */
1700 /* Replace the high bits. */
1701 c
|= (upper
& ~ctrl_modifier
);
1708 /* Input of single characters from keyboard */
1710 Lisp_Object
print_help ();
1711 static Lisp_Object
kbd_buffer_get_event ();
1712 static void record_char ();
1715 static jmp_buf wrong_kboard_jmpbuf
;
1718 /* read a character from the keyboard; call the redisplay if needed */
1719 /* commandflag 0 means do not do auto-saving, but do do redisplay.
1720 -1 means do not do redisplay, but do do autosaving.
1723 /* The arguments MAPS and NMAPS are for menu prompting.
1724 MAPS is an array of keymaps; NMAPS is the length of MAPS.
1726 PREV_EVENT is the previous input event, or nil if we are reading
1727 the first event of a key sequence.
1729 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
1730 if we used a mouse menu to read the input, or zero otherwise. If
1731 USED_MOUSE_MENU is null, we don't dereference it.
1733 Value is t if we showed a menu and the user rejected it. */
1736 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
1740 Lisp_Object prev_event
;
1741 int *used_mouse_menu
;
1745 jmp_buf local_getcjmp
;
1747 int key_already_recorded
= 0;
1748 Lisp_Object tem
, save
;
1749 Lisp_Object also_record
;
1750 struct gcpro gcpro1
;
1754 before_command_key_count
= this_command_key_count
;
1755 before_command_echo_length
= echo_length ();
1762 if (CONSP (Vunread_command_events
))
1764 c
= XCONS (Vunread_command_events
)->car
;
1765 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
1767 /* Undo what read_char_x_menu_prompt did when it unread
1768 additional keys returned by Fx_popup_menu. */
1770 && (SYMBOLP (XCONS (c
)->car
) || INTEGERP (XCONS (c
)->car
))
1771 && NILP (XCONS (c
)->cdr
))
1774 if (this_command_key_count
== 0)
1780 if (unread_command_char
!= -1)
1782 XSETINT (c
, unread_command_char
);
1783 unread_command_char
= -1;
1785 if (this_command_key_count
== 0)
1791 /* If there is no function key translated before
1792 reset-this-command-lengths takes effect, forget about it. */
1793 before_command_restore_flag
= 0;
1795 if (!NILP (Vexecuting_macro
))
1797 /* We set this to Qmacro; since that's not a frame, nobody will
1798 try to switch frames on us, and the selected window will
1801 Since this event came from a macro, it would be misleading to
1802 leave internal_last_event_frame set to wherever the last
1803 real event came from. Normally, a switch-frame event selects
1804 internal_last_event_frame after each command is read, but
1805 events read from a macro should never cause a new frame to be
1807 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
1809 /* Exit the macro if we are at the end.
1810 Also, some things replace the macro with t
1811 to force an early exit. */
1812 if (EQ (Vexecuting_macro
, Qt
)
1813 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
1819 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
1820 if (STRINGP (Vexecuting_macro
)
1821 && (XINT (c
) & 0x80))
1822 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
1824 executing_macro_index
++;
1829 if (!NILP (unread_switch_frame
))
1831 c
= unread_switch_frame
;
1832 unread_switch_frame
= Qnil
;
1834 /* This event should make it into this_command_keys, and get echoed
1835 again, so we go to reread_first, rather than reread. */
1839 if (commandflag
>= 0)
1842 || detect_input_pending_run_timers (0))
1849 /* Message turns off echoing unless more keystrokes turn it on again. */
1850 if (echo_area_glyphs
&& *echo_area_glyphs
1851 && echo_area_glyphs
!= current_kboard
->echobuf
1852 && ok_to_echo_at_next_pause
!= echo_area_glyphs
)
1855 /* If already echoing, continue. */
1858 /* Try reading a character via menu prompting in the minibuf.
1859 Try this before the sit-for, because the sit-for
1860 would do the wrong thing if we are supposed to do
1861 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
1862 after a mouse event so don't try a minibuf menu. */
1864 if (nmaps
> 0 && INTERACTIVE
1865 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
1866 /* Don't bring up a menu if we already have another event. */
1867 && NILP (Vunread_command_events
)
1868 && unread_command_char
< 0
1869 && !detect_input_pending_run_timers (0))
1871 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
1874 key_already_recorded
= 1;
1879 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
1880 We will do that below, temporarily for short sections of code,
1881 when appropriate. local_getcjmp must be in effect
1882 around any call to sit_for or kbd_buffer_get_event;
1883 it *must not* be in effect when we call redisplay. */
1885 if (_setjmp (local_getcjmp
))
1887 XSETINT (c
, quit_char
);
1888 XSETFRAME (internal_last_event_frame
, selected_frame
);
1889 Vlast_event_frame
= internal_last_event_frame
;
1890 /* If we report the quit char as an event,
1891 don't do so more than once. */
1892 if (!NILP (Vinhibit_quit
))
1897 KBOARD
*kb
= FRAME_KBOARD (selected_frame
);
1898 if (kb
!= current_kboard
)
1900 Lisp_Object
*tailp
= &kb
->kbd_queue
;
1901 /* We shouldn't get here if we were in single-kboard mode! */
1904 while (CONSP (*tailp
))
1905 tailp
= &XCONS (*tailp
)->cdr
;
1908 *tailp
= Fcons (c
, Qnil
);
1909 kb
->kbd_queue_has_data
= 1;
1910 current_kboard
= kb
;
1911 /* This is going to exit from read_char
1912 so we had better get rid of this frame's stuff. */
1914 longjmp (wrong_kboard_jmpbuf
, 1);
1921 timer_start_idle ();
1923 /* If in middle of key sequence and minibuffer not active,
1924 start echoing if enough time elapses. */
1926 if (minibuf_level
== 0 && !current_kboard
->immediate_echo
1927 && this_command_key_count
> 0
1929 && echo_keystrokes
> 0
1930 && (echo_area_glyphs
== 0 || *echo_area_glyphs
== 0
1931 || ok_to_echo_at_next_pause
== echo_area_glyphs
))
1935 /* After a mouse event, start echoing right away.
1936 This is because we are probably about to display a menu,
1937 and we don't want to delay before doing so. */
1938 if (EVENT_HAS_PARAMETERS (prev_event
))
1942 save_getcjmp (save_jump
);
1943 restore_getcjmp (local_getcjmp
);
1944 tem0
= sit_for (echo_keystrokes
, 0, 1, 1, 0);
1945 restore_getcjmp (save_jump
);
1947 && ! CONSP (Vunread_command_events
))
1952 /* Maybe auto save due to number of keystrokes. */
1954 if (commandflag
!= 0
1955 && auto_save_interval
> 0
1956 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
1957 && !detect_input_pending_run_timers (0))
1959 Fdo_auto_save (Qnil
, Qnil
);
1960 /* Hooks can actually change some buffers in auto save. */
1964 /* Try reading using an X menu.
1965 This is never confused with reading using the minibuf
1966 because the recursive call of read_char in read_char_minibuf_menu_prompt
1967 does not pass on any keymaps. */
1969 if (nmaps
> 0 && INTERACTIVE
1970 && !NILP (prev_event
)
1971 && EVENT_HAS_PARAMETERS (prev_event
)
1972 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
)
1973 /* Don't bring up a menu if we already have another event. */
1974 && NILP (Vunread_command_events
)
1975 && unread_command_char
< 0)
1977 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
1979 /* Now that we have read an event, Emacs is not idle. */
1985 /* Maybe autosave and/or garbage collect due to idleness. */
1987 if (INTERACTIVE
&& NILP (c
))
1989 int delay_level
, buffer_size
;
1991 /* Slow down auto saves logarithmically in size of current buffer,
1992 and garbage collect while we're at it. */
1993 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
1994 last_non_minibuf_size
= Z
- BEG
;
1995 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
1997 while (buffer_size
> 64)
1998 delay_level
++, buffer_size
-= buffer_size
>> 2;
1999 if (delay_level
< 4) delay_level
= 4;
2000 /* delay_level is 4 for files under around 50k, 7 at 100k,
2001 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2003 /* Auto save if enough time goes by without input. */
2004 if (commandflag
!= 0
2005 && num_nonmacro_input_events
> last_auto_save
2006 && INTEGERP (Vauto_save_timeout
)
2007 && XINT (Vauto_save_timeout
) > 0)
2011 save_getcjmp (save_jump
);
2012 restore_getcjmp (local_getcjmp
);
2013 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2015 restore_getcjmp (save_jump
);
2018 && ! CONSP (Vunread_command_events
))
2020 Fdo_auto_save (Qnil
, Qnil
);
2022 /* If we have auto-saved and there is still no input
2023 available, garbage collect if there has been enough
2024 consing going on to make it worthwhile. */
2025 if (!detect_input_pending_run_timers (0)
2026 && consing_since_gc
> gc_cons_threshold
/ 2)
2027 Fgarbage_collect ();
2034 /* If this has become non-nil here, it has been set by a timer
2035 or sentinel or filter. */
2036 if (CONSP (Vunread_command_events
))
2038 c
= XCONS (Vunread_command_events
)->car
;
2039 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2042 /* Read something from current KBOARD's side queue, if possible. */
2046 if (current_kboard
->kbd_queue_has_data
)
2048 if (!CONSP (current_kboard
->kbd_queue
))
2050 c
= XCONS (current_kboard
->kbd_queue
)->car
;
2051 current_kboard
->kbd_queue
2052 = XCONS (current_kboard
->kbd_queue
)->cdr
;
2053 if (NILP (current_kboard
->kbd_queue
))
2054 current_kboard
->kbd_queue_has_data
= 0;
2055 input_pending
= readable_events (0);
2056 if (EVENT_HAS_PARAMETERS (c
)
2057 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2058 internal_last_event_frame
= XCONS (XCONS (c
)->cdr
)->car
;
2059 Vlast_event_frame
= internal_last_event_frame
;
2064 /* If current_kboard's side queue is empty check the other kboards.
2065 If one of them has data that we have not yet seen here,
2066 switch to it and process the data waiting for it.
2068 Note: if the events queued up for another kboard
2069 have already been seen here, and therefore are not a complete command,
2070 the kbd_queue_has_data field is 0, so we skip that kboard here.
2071 That's to avoid an infinite loop switching between kboards here. */
2072 if (NILP (c
) && !single_kboard
)
2075 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2076 if (kb
->kbd_queue_has_data
)
2078 current_kboard
= kb
;
2079 /* This is going to exit from read_char
2080 so we had better get rid of this frame's stuff. */
2082 longjmp (wrong_kboard_jmpbuf
, 1);
2091 /* Finally, we read from the main queue,
2092 and if that gives us something we can't use yet, we put it on the
2093 appropriate side queue and try again. */
2099 /* Actually read a character, waiting if necessary. */
2100 save_getcjmp (save_jump
);
2101 restore_getcjmp (local_getcjmp
);
2102 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2103 restore_getcjmp (save_jump
);
2106 if (! NILP (c
) && (kb
!= current_kboard
))
2108 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2109 while (CONSP (*tailp
))
2110 tailp
= &XCONS (*tailp
)->cdr
;
2113 *tailp
= Fcons (c
, Qnil
);
2114 kb
->kbd_queue_has_data
= 1;
2118 current_kboard
= kb
;
2119 /* This is going to exit from read_char
2120 so we had better get rid of this frame's stuff. */
2122 longjmp (wrong_kboard_jmpbuf
, 1);
2127 /* Terminate Emacs in batch mode if at eof. */
2128 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2129 Fkill_emacs (make_number (1));
2133 /* Add in any extra modifiers, where appropriate. */
2134 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2135 || ((extra_keyboard_modifiers
& 0177) < ' '
2136 && (extra_keyboard_modifiers
& 0177) != 0))
2137 XSETINT (c
, make_ctrl_char (XINT (c
)));
2139 /* Transfer any other modifier bits directly from
2140 extra_keyboard_modifiers to c. Ignore the actual character code
2141 in the low 16 bits of extra_keyboard_modifiers. */
2142 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2153 if (commandflag
>= 0
2154 && !input_pending
&& !detect_input_pending_run_timers (0))
2162 /* Buffer switch events are only for internal wakeups
2163 so don't show them to the user.
2164 Also, don't record a key if we already did. */
2165 if (BUFFERP (c
) || key_already_recorded
)
2168 /* Process special events within read_char
2169 and loop around to read another event. */
2172 tem
= get_keyelt (access_keymap (get_keymap_1 (Vspecial_event_map
, 0, 0),
2178 int was_locked
= single_kboard
;
2180 last_input_char
= c
;
2181 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2183 /* Resume allowing input from any kboard, if that was true before. */
2185 any_kboard_state ();
2190 /* Wipe the echo area. */
2191 if (echo_area_glyphs
)
2192 safe_run_hooks (Qecho_area_clear_hook
);
2193 echo_area_glyphs
= 0;
2195 /* Handle things that only apply to characters. */
2198 /* If kbd_buffer_get_event gave us an EOF, return that. */
2202 if ((STRINGP (Vkeyboard_translate_table
)
2203 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2204 || (VECTORP (Vkeyboard_translate_table
)
2205 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2206 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2207 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2210 d
= Faref (Vkeyboard_translate_table
, c
);
2211 /* nil in keyboard-translate-table means no translation. */
2217 /* If this event is a mouse click in the menu bar,
2218 return just menu-bar for now. Modify the mouse click event
2219 so we won't do this twice, then queue it up. */
2220 if (EVENT_HAS_PARAMETERS (c
)
2221 && CONSP (XCONS (c
)->cdr
)
2222 && CONSP (EVENT_START (c
))
2223 && CONSP (XCONS (EVENT_START (c
))->cdr
))
2227 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2228 /* Handle menu-bar events:
2229 insert the dummy prefix event `menu-bar'. */
2230 if (EQ (posn
, Qmenu_bar
))
2232 /* Change menu-bar to (menu-bar) as the event "position". */
2233 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2236 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2242 if (! NILP (also_record
))
2243 record_char (also_record
);
2248 before_command_key_count
= this_command_key_count
;
2249 before_command_echo_length
= echo_length ();
2251 /* Don't echo mouse motion events. */
2253 && ! (EVENT_HAS_PARAMETERS (c
)
2254 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2257 if (! NILP (also_record
))
2258 echo_char (also_record
);
2259 /* Once we reread a character, echoing can happen
2260 the next time we pause to read a new one. */
2261 ok_to_echo_at_next_pause
= echo_area_glyphs
;
2264 /* Record this character as part of the current key. */
2265 add_command_key (c
);
2266 if (! NILP (also_record
))
2267 add_command_key (also_record
);
2269 /* Re-reading in the middle of a command */
2271 last_input_char
= c
;
2274 /* Process the help character specially if enabled */
2275 if (!NILP (Vhelp_form
) && help_char_p (c
))
2278 count
= specpdl_ptr
- specpdl
;
2280 record_unwind_protect (Fset_window_configuration
,
2281 Fcurrent_window_configuration (Qnil
));
2283 tem0
= Feval (Vhelp_form
);
2285 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2289 c
= read_char (0, 0, 0, Qnil
, 0);
2290 while (BUFFERP (c
));
2291 /* Remove the help from the frame */
2292 unbind_to (count
, Qnil
);
2295 if (EQ (c
, make_number (040)))
2299 c
= read_char (0, 0, 0, Qnil
, 0);
2300 while (BUFFERP (c
));
2307 /* Record a key that came from a mouse menu.
2308 Record it for echoing, for this-command-keys, and so on. */
2314 /* Wipe the echo area. */
2315 echo_area_glyphs
= 0;
2319 before_command_key_count
= this_command_key_count
;
2320 before_command_echo_length
= echo_length ();
2322 /* Don't echo mouse motion events. */
2323 if (echo_keystrokes
)
2327 /* Once we reread a character, echoing can happen
2328 the next time we pause to read a new one. */
2329 ok_to_echo_at_next_pause
= 0;
2332 /* Record this character as part of the current key. */
2333 add_command_key (c
);
2335 /* Re-reading in the middle of a command */
2336 last_input_char
= c
;
2340 /* Return 1 if should recognize C as "the help character". */
2348 if (EQ (c
, Vhelp_char
))
2350 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2351 if (EQ (c
, XCONS (tail
)->car
))
2356 /* Record the input event C in various ways. */
2363 XVECTOR (recent_keys
)->contents
[recent_keys_index
] = c
;
2364 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2365 recent_keys_index
= 0;
2367 /* Write c to the dribble file. If c is a lispy event, write
2368 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2369 If you, dear reader, have a better idea, you've got the source. :-) */
2374 if (XUINT (c
) < 0x100)
2375 putc (XINT (c
), dribble
);
2377 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2381 Lisp_Object dribblee
;
2383 /* If it's a structured event, take the event header. */
2384 dribblee
= EVENT_HEAD (c
);
2386 if (SYMBOLP (dribblee
))
2388 putc ('<', dribble
);
2389 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2390 STRING_BYTES (XSYMBOL (dribblee
)->name
),
2392 putc ('>', dribble
);
2399 store_kbd_macro_char (c
);
2401 num_nonmacro_input_events
++;
2408 struct buffer
*old
= current_buffer
;
2409 Fprinc (object
, Qnil
);
2410 set_buffer_internal (XBUFFER (Vstandard_output
));
2411 call0 (intern ("help-mode"));
2412 set_buffer_internal (old
);
2416 /* Copy out or in the info on where C-g should throw to.
2417 This is used when running Lisp code from within get_char,
2418 in case get_char is called recursively.
2419 See read_process_output. */
2425 bcopy (getcjmp
, temp
, sizeof getcjmp
);
2429 restore_getcjmp (temp
)
2432 bcopy (temp
, getcjmp
, sizeof getcjmp
);
2437 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
2438 of this function. */
2441 tracking_off (old_value
)
2442 Lisp_Object old_value
;
2444 do_mouse_tracking
= old_value
;
2445 if (NILP (old_value
))
2447 /* Redisplay may have been preempted because there was input
2448 available, and it assumes it will be called again after the
2449 input has been processed. If the only input available was
2450 the sort that we have just disabled, then we need to call
2452 if (!readable_events (1))
2454 redisplay_preserve_echo_area ();
2455 get_input_pending (&input_pending
, 1);
2460 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
2461 "Evaluate BODY with mouse movement events enabled.\n\
2462 Within a `track-mouse' form, mouse motion generates input events that\n\
2463 you can read with `read-event'.\n\
2464 Normally, mouse motion is ignored.")
2468 int count
= specpdl_ptr
- specpdl
;
2471 record_unwind_protect (tracking_off
, do_mouse_tracking
);
2473 do_mouse_tracking
= Qt
;
2475 val
= Fprogn (args
);
2476 return unbind_to (count
, val
);
2479 /* If mouse has moved on some frame, return one of those frames.
2480 Return 0 otherwise. */
2485 Lisp_Object tail
, frame
;
2487 FOR_EACH_FRAME (tail
, frame
)
2489 if (XFRAME (frame
)->mouse_moved
)
2490 return XFRAME (frame
);
2496 #endif /* HAVE_MOUSE */
2498 /* Low level keyboard/mouse input.
2499 kbd_buffer_store_event places events in kbd_buffer, and
2500 kbd_buffer_get_event retrieves them. */
2502 /* Return true iff there are any events in the queue that read-char
2503 would return. If this returns false, a read-char would block. */
2505 readable_events (do_timers_now
)
2509 timer_check (do_timers_now
);
2511 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2514 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2519 if (current_kboard
->kbd_queue_has_data
)
2525 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2526 if (kb
->kbd_queue_has_data
)
2532 /* Set this for debugging, to have a way to get out */
2537 event_to_kboard (event
)
2538 struct input_event
*event
;
2541 frame
= event
->frame_or_window
;
2543 frame
= XCONS (frame
)->car
;
2544 else if (WINDOWP (frame
))
2545 frame
= WINDOW_FRAME (XWINDOW (frame
));
2547 /* There are still some events that don't set this field.
2548 For now, just ignore the problem.
2549 Also ignore dead frames here. */
2550 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
2553 return FRAME_KBOARD (XFRAME (frame
));
2557 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
2560 kbd_buffer_store_event (event
)
2561 register struct input_event
*event
;
2563 if (event
->kind
== no_event
)
2566 if (event
->kind
== ascii_keystroke
)
2568 register int c
= event
->code
& 0377;
2570 if (event
->modifiers
& ctrl_modifier
)
2571 c
= make_ctrl_char (c
);
2573 c
|= (event
->modifiers
2574 & (meta_modifier
| alt_modifier
2575 | hyper_modifier
| super_modifier
));
2579 extern SIGTYPE
interrupt_signal ();
2582 struct input_event
*sp
;
2585 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
2586 kb
!= current_kboard
))
2589 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
2590 Fcons (make_number (c
), Qnil
));
2591 kb
->kbd_queue_has_data
= 1;
2592 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2594 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2597 if (event_to_kboard (sp
) == kb
)
2599 sp
->kind
= no_event
;
2600 sp
->frame_or_window
= Qnil
;
2607 /* If this results in a quit_char being returned to Emacs as
2608 input, set Vlast_event_frame properly. If this doesn't
2609 get returned to Emacs as an event, the next event read
2610 will set Vlast_event_frame again, so this is safe to do. */
2614 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
2616 focus
= event
->frame_or_window
;
2617 internal_last_event_frame
= focus
;
2618 Vlast_event_frame
= focus
;
2621 last_event_timestamp
= event
->timestamp
;
2622 interrupt_signal ();
2626 if (c
&& c
== stop_character
)
2632 /* Don't insert two buffer_switch_event's in a row.
2633 Just ignore the second one. */
2634 else if (event
->kind
== buffer_switch_event
2635 && kbd_fetch_ptr
!= kbd_store_ptr
2636 && kbd_store_ptr
->kind
== buffer_switch_event
)
2639 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
2640 kbd_store_ptr
= kbd_buffer
;
2642 /* Don't let the very last slot in the buffer become full,
2643 since that would make the two pointers equal,
2644 and that is indistinguishable from an empty buffer.
2645 Discard the event if it would fill the last slot. */
2646 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
2648 volatile struct input_event
*sp
= kbd_store_ptr
;
2649 sp
->kind
= event
->kind
;
2650 if (event
->kind
== selection_request_event
)
2652 /* We must not use the ordinary copying code for this case,
2653 since `part' is an enum and copying it might not copy enough
2655 bcopy (event
, (char *) sp
, sizeof (*event
));
2659 sp
->code
= event
->code
;
2660 sp
->part
= event
->part
;
2661 sp
->frame_or_window
= event
->frame_or_window
;
2662 sp
->modifiers
= event
->modifiers
;
2665 sp
->timestamp
= event
->timestamp
;
2667 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_store_ptr
2669 = event
->frame_or_window
);
2675 /* Discard any mouse events in the event buffer by setting them to
2678 discard_mouse_events ()
2680 struct input_event
*sp
;
2681 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
2683 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
2686 if (sp
->kind
== mouse_click
2688 || sp
->kind
== w32_scroll_bar_click
2690 || sp
->kind
== scroll_bar_click
)
2692 sp
->kind
= no_event
;
2697 /* Read one event from the event buffer, waiting if necessary.
2698 The value is a Lisp object representing the event.
2699 The value is nil for an event that should be ignored,
2700 or that was handled here.
2701 We always read and discard one event. */
2704 kbd_buffer_get_event (kbp
, used_mouse_menu
)
2706 int *used_mouse_menu
;
2710 EMACS_TIME next_timer_delay
;
2716 *kbp
= current_kboard
;
2720 /* Wait until there is input available. */
2723 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2726 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2730 /* If the quit flag is set, then read_char will return
2731 quit_char, so that counts as "available input." */
2732 if (!NILP (Vquit_flag
))
2733 quit_throw_to_read_char ();
2735 /* One way or another, wait until input is available; then, if
2736 interrupt handlers have not read it, read it now. */
2739 wait_for_kbd_input ();
2741 /* Note SIGIO has been undef'd if FIONREAD is missing. */
2745 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2748 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2752 Lisp_Object minus_one
;
2754 XSETINT (minus_one
, -1);
2755 wait_reading_process_input (0, 0, minus_one
, 1);
2757 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
2758 /* Pass 1 for EXPECT since we just waited to have input. */
2759 read_avail_input (1);
2761 #endif /* not VMS */
2764 if (CONSP (Vunread_command_events
))
2767 first
= XCONS (Vunread_command_events
)->car
;
2768 Vunread_command_events
= XCONS (Vunread_command_events
)->cdr
;
2769 *kbp
= current_kboard
;
2773 /* At this point, we know that there is a readable event available
2774 somewhere. If the event queue is empty, then there must be a
2775 mouse movement enabled and available. */
2776 if (kbd_fetch_ptr
!= kbd_store_ptr
)
2778 struct input_event
*event
;
2780 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
2784 last_event_timestamp
= event
->timestamp
;
2787 *kbp
= event_to_kboard (event
);
2789 *kbp
= current_kboard
; /* Better than returning null ptr? */
2791 *kbp
= &the_only_kboard
;
2796 /* These two kinds of events get special handling
2797 and don't actually appear to the command loop.
2798 We return nil for them. */
2799 if (event
->kind
== selection_request_event
)
2802 struct input_event copy
;
2804 /* Remove it from the buffer before processing it,
2805 since otherwise swallow_events will see it
2806 and process it again. */
2808 kbd_fetch_ptr
= event
+ 1;
2809 input_pending
= readable_events (0);
2810 x_handle_selection_request (©
);
2812 /* We're getting selection request events, but we don't have
2818 else if (event
->kind
== selection_clear_event
)
2821 struct input_event copy
;
2823 /* Remove it from the buffer before processing it. */
2825 kbd_fetch_ptr
= event
+ 1;
2826 input_pending
= readable_events (0);
2827 x_handle_selection_clear (©
);
2829 /* We're getting selection request events, but we don't have
2834 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
2835 else if (event
->kind
== delete_window_event
)
2837 /* Make an event (delete-frame (FRAME)). */
2838 obj
= Fcons (event
->frame_or_window
, Qnil
);
2839 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
2840 kbd_fetch_ptr
= event
+ 1;
2842 else if (event
->kind
== iconify_event
)
2844 /* Make an event (iconify-frame (FRAME)). */
2845 obj
= Fcons (event
->frame_or_window
, Qnil
);
2846 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
2847 kbd_fetch_ptr
= event
+ 1;
2849 else if (event
->kind
== deiconify_event
)
2851 /* Make an event (make-frame-visible (FRAME)). */
2852 obj
= Fcons (event
->frame_or_window
, Qnil
);
2853 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
2854 kbd_fetch_ptr
= event
+ 1;
2857 else if (event
->kind
== buffer_switch_event
)
2859 /* The value doesn't matter here; only the type is tested. */
2860 XSETBUFFER (obj
, current_buffer
);
2861 kbd_fetch_ptr
= event
+ 1;
2863 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2864 else if (event
->kind
== menu_bar_activate_event
)
2866 kbd_fetch_ptr
= event
+ 1;
2867 input_pending
= readable_events (0);
2868 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
2869 x_activate_menubar (XFRAME (event
->frame_or_window
));
2872 /* Just discard these, by returning nil.
2873 With MULTI_KBOARD, these events are used as placeholders
2874 when we need to randomly delete events from the queue.
2875 (They shouldn't otherwise be found in the buffer,
2876 but on some machines it appears they do show up
2877 even without MULTI_KBOARD.) */
2878 /* On Windows NT/9X, no_event is used to delete extraneous
2879 mouse events during a popup-menu call. */
2880 else if (event
->kind
== no_event
)
2881 kbd_fetch_ptr
= event
+ 1;
2883 /* If this event is on a different frame, return a switch-frame this
2884 time, and leave the event in the queue for next time. */
2890 frame
= event
->frame_or_window
;
2892 frame
= XCONS (frame
)->car
;
2893 else if (WINDOWP (frame
))
2894 frame
= WINDOW_FRAME (XWINDOW (frame
));
2896 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
2900 if (! EQ (frame
, internal_last_event_frame
)
2901 && XFRAME (frame
) != selected_frame
)
2902 obj
= make_lispy_switch_frame (frame
);
2903 internal_last_event_frame
= frame
;
2905 /* If we didn't decide to make a switch-frame event, go ahead
2906 and build a real event from the queue entry. */
2910 obj
= make_lispy_event (event
);
2911 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2912 /* If this was a menu selection, then set the flag to inhibit
2913 writing to last_nonmenu_event. Don't do this if the event
2914 we're returning is (menu-bar), though; that indicates the
2915 beginning of the menu sequence, and we might as well leave
2916 that as the `event with parameters' for this selection. */
2917 if (event
->kind
== menu_bar_event
2918 && !(CONSP (obj
) && EQ (XCONS (obj
)->car
, Qmenu_bar
))
2920 *used_mouse_menu
= 1;
2923 /* Wipe out this event, to catch bugs. */
2924 event
->kind
= no_event
;
2925 XVECTOR (kbd_buffer_frame_or_window
)->contents
[event
- kbd_buffer
] = Qnil
;
2927 kbd_fetch_ptr
= event
+ 1;
2932 /* Try generating a mouse motion event. */
2933 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
2935 FRAME_PTR f
= some_mouse_moved ();
2936 Lisp_Object bar_window
;
2937 enum scroll_bar_part part
;
2941 *kbp
= current_kboard
;
2942 /* Note that this uses F to determine which display to look at.
2943 If there is no valid info, it does not store anything
2944 so x remains nil. */
2946 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
2950 /* Decide if we should generate a switch-frame event. Don't
2951 generate switch-frame events for motion outside of all Emacs
2957 frame
= FRAME_FOCUS_FRAME (f
);
2959 XSETFRAME (frame
, f
);
2961 if (! EQ (frame
, internal_last_event_frame
)
2962 && XFRAME (frame
) != selected_frame
)
2963 obj
= make_lispy_switch_frame (frame
);
2964 internal_last_event_frame
= frame
;
2967 /* If we didn't decide to make a switch-frame event, go ahead and
2968 return a mouse-motion event. */
2969 if (!NILP (x
) && NILP (obj
))
2970 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
2972 #endif /* HAVE_MOUSE */
2974 /* We were promised by the above while loop that there was
2975 something for us to read! */
2978 input_pending
= readable_events (0);
2980 Vlast_event_frame
= internal_last_event_frame
;
2985 /* Process any events that are not user-visible,
2986 then return, without reading any user-visible events. */
2989 swallow_events (do_display
)
2994 while (kbd_fetch_ptr
!= kbd_store_ptr
)
2996 struct input_event
*event
;
2998 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3002 last_event_timestamp
= event
->timestamp
;
3004 /* These two kinds of events get special handling
3005 and don't actually appear to the command loop. */
3006 if (event
->kind
== selection_request_event
)
3009 struct input_event copy
;
3011 /* Remove it from the buffer before processing it,
3012 since otherwise swallow_events called recursively could see it
3013 and process it again. */
3015 kbd_fetch_ptr
= event
+ 1;
3016 input_pending
= readable_events (0);
3017 x_handle_selection_request (©
);
3019 /* We're getting selection request events, but we don't have
3025 else if (event
->kind
== selection_clear_event
)
3028 struct input_event copy
;
3030 /* Remove it from the buffer before processing it, */
3033 kbd_fetch_ptr
= event
+ 1;
3034 input_pending
= readable_events (0);
3035 x_handle_selection_clear (©
);
3037 /* We're getting selection request events, but we don't have
3046 old_timers_run
= timers_run
;
3047 get_input_pending (&input_pending
, 1);
3049 if (timers_run
!= old_timers_run
&& do_display
)
3050 redisplay_preserve_echo_area ();
3053 static EMACS_TIME timer_idleness_start_time
;
3055 /* Record the start of when Emacs is idle,
3056 for the sake of running idle-time timers. */
3063 /* If we are already in the idle state, do nothing. */
3064 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3067 EMACS_GET_TIME (timer_idleness_start_time
);
3069 /* Mark all idle-time timers as once again candidates for running. */
3070 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCONS (timers
)->cdr
)
3074 timer
= XCONS (timers
)->car
;
3076 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3078 XVECTOR (timer
)->contents
[0] = Qnil
;
3082 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3087 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3090 /* This is only for debugging. */
3091 struct input_event last_timer_event
;
3093 /* Check whether a timer has fired. To prevent larger problems we simply
3094 disregard elements that are not proper timers. Do not make a circular
3095 timer list for the time being.
3097 Returns the number of seconds to wait until the next timer fires. If a
3098 timer is triggering now, return zero seconds.
3099 If no timer is active, return -1 seconds.
3101 If a timer is ripe, we run it, with quitting turned off.
3103 DO_IT_NOW is now ignored. It used to mean that we should
3104 run the timer directly instead of queueing a timer-event.
3105 Now we always run timers directly. */
3108 timer_check (do_it_now
)
3111 EMACS_TIME nexttime
;
3112 EMACS_TIME now
, idleness_now
;
3113 Lisp_Object timers
, idle_timers
, chosen_timer
;
3114 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3116 EMACS_SET_SECS (nexttime
, -1);
3117 EMACS_SET_USECS (nexttime
, -1);
3119 /* Always consider the ordinary timers. */
3120 timers
= Vtimer_list
;
3121 /* Consider the idle timers only if Emacs is idle. */
3122 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3123 idle_timers
= Vtimer_idle_list
;
3126 chosen_timer
= Qnil
;
3127 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3129 if (CONSP (timers
) || CONSP (idle_timers
))
3131 EMACS_GET_TIME (now
);
3132 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3133 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3136 while (CONSP (timers
) || CONSP (idle_timers
))
3138 int triggertime
= EMACS_SECS (now
);
3139 Lisp_Object
*vector
;
3140 Lisp_Object timer
, idle_timer
;
3141 EMACS_TIME timer_time
, idle_timer_time
;
3142 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3144 /* Skip past invalid timers and timers already handled. */
3147 timer
= XCONS (timers
)->car
;
3148 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3150 timers
= XCONS (timers
)->cdr
;
3153 vector
= XVECTOR (timer
)->contents
;
3155 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3156 || !INTEGERP (vector
[3])
3157 || ! NILP (vector
[0]))
3159 timers
= XCONS (timers
)->cdr
;
3163 if (!NILP (idle_timers
))
3165 timer
= XCONS (idle_timers
)->car
;
3166 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3168 idle_timers
= XCONS (idle_timers
)->cdr
;
3171 vector
= XVECTOR (timer
)->contents
;
3173 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3174 || !INTEGERP (vector
[3])
3175 || ! NILP (vector
[0]))
3177 idle_timers
= XCONS (idle_timers
)->cdr
;
3182 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3183 based on the next ordinary timer.
3184 TIMER_DIFFERENCE is the distance in time from NOW to when
3185 this timer becomes ripe (negative if it's already ripe). */
3188 timer
= XCONS (timers
)->car
;
3189 vector
= XVECTOR (timer
)->contents
;
3190 EMACS_SET_SECS (timer_time
,
3191 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3192 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3193 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3196 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3197 based on the next idle timer. */
3198 if (!NILP (idle_timers
))
3200 idle_timer
= XCONS (idle_timers
)->car
;
3201 vector
= XVECTOR (idle_timer
)->contents
;
3202 EMACS_SET_SECS (idle_timer_time
,
3203 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3204 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3205 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3208 /* Decide which timer is the next timer,
3209 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3210 Also step down the list where we found that timer. */
3212 if (! NILP (timers
) && ! NILP (idle_timers
))
3215 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3216 if (EMACS_TIME_NEG_P (temp
))
3218 chosen_timer
= timer
;
3219 timers
= XCONS (timers
)->cdr
;
3220 difference
= timer_difference
;
3224 chosen_timer
= idle_timer
;
3225 idle_timers
= XCONS (idle_timers
)->cdr
;
3226 difference
= idle_timer_difference
;
3229 else if (! NILP (timers
))
3231 chosen_timer
= timer
;
3232 timers
= XCONS (timers
)->cdr
;
3233 difference
= timer_difference
;
3237 chosen_timer
= idle_timer
;
3238 idle_timers
= XCONS (idle_timers
)->cdr
;
3239 difference
= idle_timer_difference
;
3241 vector
= XVECTOR (chosen_timer
)->contents
;
3243 /* If timer is rupe, run it if it hasn't been run. */
3244 if (EMACS_TIME_NEG_P (difference
)
3245 || (EMACS_SECS (difference
) == 0
3246 && EMACS_USECS (difference
) == 0))
3248 if (NILP (vector
[0]))
3251 int was_locked
= single_kboard
;
3252 int count
= specpdl_ptr
- specpdl
;
3254 /* Mark the timer as triggered to prevent problems if the lisp
3255 code fails to reschedule it right. */
3258 specbind (Qinhibit_quit
, Qt
);
3260 call1 (Qtimer_event_handler
, chosen_timer
);
3263 unbind_to (count
, Qnil
);
3265 /* Resume allowing input from any kboard, if that was true before. */
3267 any_kboard_state ();
3269 /* Since we have handled the event,
3270 we don't need to tell the caller to wake up and do it. */
3274 /* When we encounter a timer that is still waiting,
3275 return the amount of time to wait before it is ripe. */
3282 /* No timers are pending in the future. */
3283 /* Return 0 if we generated an event, and -1 if not. */
3288 /* Caches for modify_event_symbol. */
3289 static Lisp_Object accent_key_syms
;
3290 static Lisp_Object func_key_syms
;
3291 static Lisp_Object mouse_syms
;
3293 static Lisp_Object mouse_wheel_syms
;
3295 static Lisp_Object drag_n_drop_syms
;
3297 /* This is a list of keysym codes for special "accent" characters.
3298 It parallels lispy_accent_keys. */
3300 static int lispy_accent_codes
[] =
3302 #ifdef XK_dead_circumflex
3307 #ifdef XK_dead_grave
3312 #ifdef XK_dead_tilde
3317 #ifdef XK_dead_diaeresis
3322 #ifdef XK_dead_macron
3327 #ifdef XK_dead_degree
3332 #ifdef XK_dead_acute
3337 #ifdef XK_dead_cedilla
3342 #ifdef XK_dead_breve
3347 #ifdef XK_dead_ogonek
3352 #ifdef XK_dead_caron
3357 #ifdef XK_dead_doubleacute
3358 XK_dead_doubleacute
,
3362 #ifdef XK_dead_abovedot
3369 /* This is a list of Lisp names for special "accent" characters.
3370 It parallels lispy_accent_codes. */
3372 static char *lispy_accent_keys
[] =
3390 #define FUNCTION_KEY_OFFSET 0x0
3392 char *lispy_function_keys
[] =
3396 0, /* VK_LBUTTON 0x01 */
3397 0, /* VK_RBUTTON 0x02 */
3398 "cancel", /* VK_CANCEL 0x03 */
3399 0, /* VK_MBUTTON 0x04 */
3401 0, 0, 0, /* 0x05 .. 0x07 */
3403 "backspace", /* VK_BACK 0x08 */
3404 "tab", /* VK_TAB 0x09 */
3406 0, 0, /* 0x0A .. 0x0B */
3408 "clear", /* VK_CLEAR 0x0C */
3409 "return", /* VK_RETURN 0x0D */
3411 0, 0, /* 0x0E .. 0x0F */
3413 "shift", /* VK_SHIFT 0x10 */
3414 "control", /* VK_CONTROL 0x11 */
3415 "menu", /* VK_MENU 0x12 */
3416 "pause", /* VK_PAUSE 0x13 */
3417 "capital", /* VK_CAPITAL 0x14 */
3419 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
3421 0, /* VK_ESCAPE 0x1B */
3423 0, 0, 0, 0, /* 0x1C .. 0x1F */
3425 0, /* VK_SPACE 0x20 */
3426 "prior", /* VK_PRIOR 0x21 */
3427 "next", /* VK_NEXT 0x22 */
3428 "end", /* VK_END 0x23 */
3429 "home", /* VK_HOME 0x24 */
3430 "left", /* VK_LEFT 0x25 */
3431 "up", /* VK_UP 0x26 */
3432 "right", /* VK_RIGHT 0x27 */
3433 "down", /* VK_DOWN 0x28 */
3434 "select", /* VK_SELECT 0x29 */
3435 "print", /* VK_PRINT 0x2A */
3436 "execute", /* VK_EXECUTE 0x2B */
3437 "snapshot", /* VK_SNAPSHOT 0x2C */
3438 "insert", /* VK_INSERT 0x2D */
3439 "delete", /* VK_DELETE 0x2E */
3440 "help", /* VK_HELP 0x2F */
3442 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
3444 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3446 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
3448 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
3450 0, 0, 0, 0, 0, 0, 0, 0, 0,
3451 0, 0, 0, 0, 0, 0, 0, 0, 0,
3452 0, 0, 0, 0, 0, 0, 0, 0,
3454 "lwindow", /* VK_LWIN 0x5B */
3455 "rwindow", /* VK_RWIN 0x5C */
3456 "apps", /* VK_APPS 0x5D */
3458 0, 0, /* 0x5E .. 0x5F */
3460 "kp-0", /* VK_NUMPAD0 0x60 */
3461 "kp-1", /* VK_NUMPAD1 0x61 */
3462 "kp-2", /* VK_NUMPAD2 0x62 */
3463 "kp-3", /* VK_NUMPAD3 0x63 */
3464 "kp-4", /* VK_NUMPAD4 0x64 */
3465 "kp-5", /* VK_NUMPAD5 0x65 */
3466 "kp-6", /* VK_NUMPAD6 0x66 */
3467 "kp-7", /* VK_NUMPAD7 0x67 */
3468 "kp-8", /* VK_NUMPAD8 0x68 */
3469 "kp-9", /* VK_NUMPAD9 0x69 */
3470 "kp-multiply", /* VK_MULTIPLY 0x6A */
3471 "kp-add", /* VK_ADD 0x6B */
3472 "kp-separator", /* VK_SEPARATOR 0x6C */
3473 "kp-subtract", /* VK_SUBTRACT 0x6D */
3474 "kp-decimal", /* VK_DECIMAL 0x6E */
3475 "kp-divide", /* VK_DIVIDE 0x6F */
3476 "f1", /* VK_F1 0x70 */
3477 "f2", /* VK_F2 0x71 */
3478 "f3", /* VK_F3 0x72 */
3479 "f4", /* VK_F4 0x73 */
3480 "f5", /* VK_F5 0x74 */
3481 "f6", /* VK_F6 0x75 */
3482 "f7", /* VK_F7 0x76 */
3483 "f8", /* VK_F8 0x77 */
3484 "f9", /* VK_F9 0x78 */
3485 "f10", /* VK_F10 0x79 */
3486 "f11", /* VK_F11 0x7A */
3487 "f12", /* VK_F12 0x7B */
3488 "f13", /* VK_F13 0x7C */
3489 "f14", /* VK_F14 0x7D */
3490 "f15", /* VK_F15 0x7E */
3491 "f16", /* VK_F16 0x7F */
3492 "f17", /* VK_F17 0x80 */
3493 "f18", /* VK_F18 0x81 */
3494 "f19", /* VK_F19 0x82 */
3495 "f20", /* VK_F20 0x83 */
3496 "f21", /* VK_F21 0x84 */
3497 "f22", /* VK_F22 0x85 */
3498 "f23", /* VK_F23 0x86 */
3499 "f24", /* VK_F24 0x87 */
3501 0, 0, 0, 0, /* 0x88 .. 0x8B */
3502 0, 0, 0, 0, /* 0x8C .. 0x8F */
3504 "kp-numlock", /* VK_NUMLOCK 0x90 */
3505 "scroll", /* VK_SCROLL 0x91 */
3507 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
3508 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
3509 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
3510 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
3511 "kp-end", /* VK_NUMPAD_END 0x96 */
3512 "kp-home", /* VK_NUMPAD_HOME 0x97 */
3513 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
3514 "kp-up", /* VK_NUMPAD_UP 0x99 */
3515 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
3516 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
3517 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
3518 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
3520 0, 0, /* 0x9E .. 0x9F */
3523 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
3524 * Used only as parameters to GetAsyncKeyState and GetKeyState.
3525 * No other API or message will distinguish left and right keys this way.
3529 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3530 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3531 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3532 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3533 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3539 "attn", /* VK_ATTN 0xF6 */
3540 "crsel", /* VK_CRSEL 0xF7 */
3541 "exsel", /* VK_EXSEL 0xF8 */
3542 "ereof", /* VK_EREOF 0xF9 */
3543 "play", /* VK_PLAY 0xFA */
3544 "zoom", /* VK_ZOOM 0xFB */
3545 "noname", /* VK_NONAME 0xFC */
3546 "pa1", /* VK_PA1 0xFD */
3547 "oem_clear", /* VK_OEM_CLEAR 0xFE */
3550 #else /* not HAVE_NTGUI */
3553 static char *lispy_kana_keys
[] =
3555 /* X Keysym value */
3556 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
3557 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
3558 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
3559 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
3560 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
3561 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
3562 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
3563 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
3564 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
3565 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
3566 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
3567 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
3568 "kana-i", "kana-u", "kana-e", "kana-o",
3569 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
3570 "prolongedsound", "kana-A", "kana-I", "kana-U",
3571 "kana-E", "kana-O", "kana-KA", "kana-KI",
3572 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
3573 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
3574 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
3575 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
3576 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
3577 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
3578 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
3579 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
3580 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
3581 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
3582 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
3583 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
3585 #endif /* XK_kana_A */
3587 #define FUNCTION_KEY_OFFSET 0xff00
3589 /* You'll notice that this table is arranged to be conveniently
3590 indexed by X Windows keysym values. */
3591 static char *lispy_function_keys
[] =
3593 /* X Keysym value */
3595 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00 */
3603 0, 0, 0, /* 0xff10 */
3605 0, 0, 0, 0, 0, 0, 0,
3608 0, "kanji", "muhenkan",
3609 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff20...2f */
3610 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff30...3f */
3611 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
3613 "home", /* 0xff50 */ /* IsCursorKey */
3624 "select", /* 0xff60 */ /* IsMiscFunctionKey */
3635 "break", /* 0xff6b */
3637 0, 0, 0, 0, 0, 0, 0, 0, "backtab", 0,
3639 0, 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff7f */
3640 "kp-space", /* 0xff80 */ /* IsKeypadKey */
3641 0, 0, 0, 0, 0, 0, 0, 0,
3642 "kp-tab", /* 0xff89 */
3644 "kp-enter", /* 0xff8d */
3646 "kp-f1", /* 0xff91 */
3650 "kp-home", /* 0xff95 */
3655 "kp-prior", /* kp-page-up */
3656 "kp-next", /* kp-page-down */
3662 0, 0, 0, 0, 0, 0, 0, 0, 0,
3663 "kp-multiply", /* 0xffaa */
3668 "kp-divide", /* 0xffaf */
3669 "kp-0", /* 0xffb0 */
3670 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
3673 "kp-equal", /* 0xffbd */
3674 "f1", /* 0xffbe */ /* IsFunctionKey */
3676 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
3677 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
3678 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
3679 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
3680 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
3681 0, 0, 0, 0, 0, 0, 0, 0,
3682 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
3683 0, 0, 0, 0, 0, 0, 0, "delete"
3686 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
3687 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
3689 static char *iso_lispy_function_keys
[] =
3691 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
3692 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
3693 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
3694 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
3695 "iso-lefttab", /* 0xfe20 */
3696 "iso-move-line-up", "iso-move-line-down",
3697 "iso-partial-line-up", "iso-partial-line-down",
3698 "iso-partial-space-left", "iso-partial-space-right",
3699 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
3700 "iso-release-margin-left", "iso-release-margin-right",
3701 "iso-release-both-margins",
3702 "iso-fast-cursor-left", "iso-fast-cursor-right",
3703 "iso-fast-cursor-up", "iso-fast-cursor-down",
3704 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
3705 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
3708 #endif /* not HAVE_NTGUI */
3710 static char *lispy_mouse_names
[] =
3712 "mouse-1", "mouse-2", "mouse-3", "mouse-4", "mouse-5"
3716 /* mouse-wheel events are generated by the wheel on devices such as
3717 the MS Intellimouse. The wheel sits in between the left and right
3718 mouse buttons, and is typically used to scroll or zoom the window
3719 underneath the pointer. mouse-wheel events specify the object on
3720 which they operate, and a delta corresponding to the amount and
3721 direction that the wheel is rotated. Clicking the mouse-wheel
3722 generates a mouse-2 event. */
3723 static char *lispy_mouse_wheel_names
[] =
3728 #endif /* WINDOWSNT */
3730 /* drag-n-drop events are generated when a set of selected files are
3731 dragged from another application and dropped onto an Emacs window. */
3732 static char *lispy_drag_n_drop_names
[] =
3737 /* Scroll bar parts. */
3738 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
3739 Lisp_Object Qup
, Qdown
;
3741 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
3742 Lisp_Object
*scroll_bar_parts
[] = {
3743 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
3748 /* A vector, indexed by button number, giving the down-going location
3749 of currently depressed buttons, both scroll bar and non-scroll bar.
3751 The elements have the form
3752 (BUTTON-NUMBER MODIFIER-MASK . REST)
3753 where REST is the cdr of a position as it would be reported in the event.
3755 The make_lispy_event function stores positions here to tell the
3756 difference between click and drag events, and to store the starting
3757 location to be included in drag events. */
3759 static Lisp_Object button_down_location
;
3761 /* Information about the most recent up-going button event: Which
3762 button, what location, and what time. */
3764 static int last_mouse_button
;
3765 static int last_mouse_x
;
3766 static int last_mouse_y
;
3767 static unsigned long button_down_time
;
3769 /* The maximum time between clicks to make a double-click,
3770 or Qnil to disable double-click detection,
3771 or Qt for no time limit. */
3772 Lisp_Object Vdouble_click_time
;
3774 /* The number of clicks in this multiple-click. */
3776 int double_click_count
;
3778 /* Given a struct input_event, build the lisp event which represents
3779 it. If EVENT is 0, build a mouse movement event from the mouse
3780 movement buffer, which should have a movement event in it.
3782 Note that events must be passed to this function in the order they
3783 are received; this function stores the location of button presses
3784 in order to build drag events when the button is released. */
3787 make_lispy_event (event
)
3788 struct input_event
*event
;
3792 switch (SWITCH_ENUM_CAST (event
->kind
))
3794 /* A simple keystroke. */
3795 case ascii_keystroke
:
3797 Lisp_Object lispy_c
;
3798 int c
= event
->code
& 0377;
3799 /* Turn ASCII characters into control characters
3801 if (event
->modifiers
& ctrl_modifier
)
3802 c
= make_ctrl_char (c
);
3804 /* Add in the other modifier bits. We took care of ctrl_modifier
3805 just above, and the shift key was taken care of by the X code,
3806 and applied to control characters by make_ctrl_char. */
3807 c
|= (event
->modifiers
3808 & (meta_modifier
| alt_modifier
3809 | hyper_modifier
| super_modifier
));
3810 /* Distinguish Shift-SPC from SPC. */
3811 if ((event
->code
& 0377) == 040
3812 && event
->modifiers
& shift_modifier
)
3813 c
|= shift_modifier
;
3814 button_down_time
= 0;
3815 XSETFASTINT (lispy_c
, c
);
3819 /* A function key. The symbol may need to have modifier prefixes
3821 case non_ascii_keystroke
:
3822 button_down_time
= 0;
3824 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
3825 if (event
->code
== lispy_accent_codes
[i
])
3826 return modify_event_symbol (i
,
3828 Qfunction_key
, Qnil
,
3829 lispy_accent_keys
, &accent_key_syms
,
3830 (sizeof (lispy_accent_keys
)
3831 / sizeof (lispy_accent_keys
[0])));
3833 /* Handle system-specific keysyms. */
3834 if (event
->code
& (1 << 28))
3836 /* We need to use an alist rather than a vector as the cache
3837 since we can't make a vector long enuf. */
3838 if (NILP (current_kboard
->system_key_syms
))
3839 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
3840 return modify_event_symbol (event
->code
,
3843 current_kboard
->Vsystem_key_alist
,
3844 0, ¤t_kboard
->system_key_syms
,
3849 if (event
->code
>= 0x400 && event
->code
< 0x500)
3850 return modify_event_symbol (event
->code
- 0x400,
3851 event
->modifiers
& ~shift_modifier
,
3852 Qfunction_key
, Qnil
,
3853 lispy_kana_keys
, &func_key_syms
,
3854 (sizeof (lispy_kana_keys
)
3855 / sizeof (lispy_kana_keys
[0])));
3856 #endif /* XK_kana_A */
3858 #ifdef ISO_FUNCTION_KEY_OFFSET
3859 if (event
->code
< FUNCTION_KEY_OFFSET
3860 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
3861 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
3863 Qfunction_key
, Qnil
,
3864 iso_lispy_function_keys
, &func_key_syms
,
3865 (sizeof (iso_lispy_function_keys
)
3866 / sizeof (iso_lispy_function_keys
[0])));
3869 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
3871 Qfunction_key
, Qnil
,
3872 lispy_function_keys
, &func_key_syms
,
3873 (sizeof (lispy_function_keys
)
3874 / sizeof (lispy_function_keys
[0])));
3877 /* A mouse click. Figure out where it is, decide whether it's
3878 a press, click or drag, and build the appropriate structure. */
3880 case scroll_bar_click
:
3882 int button
= event
->code
;
3884 Lisp_Object position
;
3885 Lisp_Object
*start_pos_ptr
;
3886 Lisp_Object start_pos
;
3888 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
3891 /* Build the position as appropriate for this mouse click. */
3892 if (event
->kind
== mouse_click
)
3895 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
3900 /* Ignore mouse events that were made on frame that
3901 have been deleted. */
3902 if (! FRAME_LIVE_P (f
))
3905 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
3906 &column
, &row
, NULL
, 1);
3908 #ifndef USE_X_TOOLKIT
3909 /* In the non-toolkit version, clicks on the menu bar
3910 are ordinary button events in the event buffer.
3911 Distinguish them, and invoke the menu.
3913 (In the toolkit version, the toolkit handles the menu bar
3914 and Emacs doesn't know about it until after the user
3915 makes a selection.) */
3916 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
3917 && (event
->modifiers
& down_modifier
))
3919 Lisp_Object items
, item
;
3924 /* Activate the menu bar on the down event. If the
3925 up event comes in before the menu code can deal with it,
3927 if (! (event
->modifiers
& down_modifier
))
3932 items
= FRAME_MENU_BAR_ITEMS (f
);
3933 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
3935 Lisp_Object pos
, string
;
3936 string
= XVECTOR (items
)->contents
[i
+ 1];
3937 pos
= XVECTOR (items
)->contents
[i
+ 3];
3940 if (column
>= XINT (pos
)
3941 && column
< XINT (pos
) + XSTRING (string
)->size
)
3943 item
= XVECTOR (items
)->contents
[i
];
3949 = Fcons (event
->frame_or_window
,
3951 Fcons (Fcons (event
->x
, event
->y
),
3952 Fcons (make_number (event
->timestamp
),
3955 return Fcons (item
, Fcons (position
, Qnil
));
3957 #endif /* not USE_X_TOOLKIT */
3959 window
= window_from_coordinates (f
, column
, row
, &part
);
3961 if (!WINDOWP (window
))
3963 window
= event
->frame_or_window
;
3968 int pixcolumn
, pixrow
;
3969 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
3970 row
-= XINT (XWINDOW (window
)->top
);
3971 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
3972 XSETINT (event
->x
, pixcolumn
);
3973 XSETINT (event
->y
, pixrow
);
3978 posn
= Qvertical_line
;
3981 buffer_posn_from_coords (XWINDOW (window
),
3988 Fcons (Fcons (event
->x
, event
->y
),
3989 Fcons (make_number (event
->timestamp
),
3995 Lisp_Object portion_whole
;
3998 window
= event
->frame_or_window
;
3999 portion_whole
= Fcons (event
->x
, event
->y
);
4000 part
= *scroll_bar_parts
[(int) event
->part
];
4004 Fcons (Qvertical_scroll_bar
,
4005 Fcons (portion_whole
,
4006 Fcons (make_number (event
->timestamp
),
4007 Fcons (part
, Qnil
)))));
4010 start_pos_ptr
= &XVECTOR (button_down_location
)->contents
[button
];
4012 start_pos
= *start_pos_ptr
;
4013 *start_pos_ptr
= Qnil
;
4015 is_double
= (button
== last_mouse_button
4016 && XINT (event
->x
) == last_mouse_x
4017 && XINT (event
->y
) == last_mouse_y
4018 && button_down_time
!= 0
4019 && (EQ (Vdouble_click_time
, Qt
)
4020 || (INTEGERP (Vdouble_click_time
)
4021 && ((int)(event
->timestamp
- button_down_time
)
4022 < XINT (Vdouble_click_time
)))));
4023 last_mouse_button
= button
;
4024 last_mouse_x
= XINT (event
->x
);
4025 last_mouse_y
= XINT (event
->y
);
4027 /* If this is a button press, squirrel away the location, so
4028 we can decide later whether it was a click or a drag. */
4029 if (event
->modifiers
& down_modifier
)
4033 double_click_count
++;
4034 event
->modifiers
|= ((double_click_count
> 2)
4039 double_click_count
= 1;
4040 button_down_time
= event
->timestamp
;
4041 *start_pos_ptr
= Fcopy_alist (position
);
4044 /* Now we're releasing a button - check the co-ordinates to
4045 see if this was a click or a drag. */
4046 else if (event
->modifiers
& up_modifier
)
4048 /* If we did not see a down before this up,
4049 ignore the up. Probably this happened because
4050 the down event chose a menu item.
4051 It would be an annoyance to treat the release
4052 of the button that chose the menu item
4053 as a separate event. */
4055 if (!CONSP (start_pos
))
4058 event
->modifiers
&= ~up_modifier
;
4059 #if 0 /* Formerly we treated an up with no down as a click event. */
4060 if (!CONSP (start_pos
))
4061 event
->modifiers
|= click_modifier
;
4065 /* The third element of every position should be the (x,y)
4069 down
= Fnth (make_number (2), start_pos
);
4070 if (EQ (event
->x
, XCONS (down
)->car
)
4071 && EQ (event
->y
, XCONS (down
)->cdr
))
4073 event
->modifiers
|= click_modifier
;
4077 button_down_time
= 0;
4078 event
->modifiers
|= drag_modifier
;
4080 /* Don't check is_double; treat this as multiple
4081 if the down-event was multiple. */
4082 if (double_click_count
> 1)
4083 event
->modifiers
|= ((double_click_count
> 2)
4089 /* Every mouse event should either have the down_modifier or
4090 the up_modifier set. */
4094 /* Get the symbol we should use for the mouse click. */
4097 head
= modify_event_symbol (button
,
4100 lispy_mouse_names
, &mouse_syms
,
4101 (sizeof (lispy_mouse_names
)
4102 / sizeof (lispy_mouse_names
[0])));
4103 if (event
->modifiers
& drag_modifier
)
4108 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4111 Fcons (make_number (double_click_count
),
4121 case w32_scroll_bar_click
:
4123 int button
= event
->code
;
4125 Lisp_Object position
;
4126 Lisp_Object
*start_pos_ptr
;
4127 Lisp_Object start_pos
;
4129 if (button
< 0 || button
>= NUM_MOUSE_BUTTONS
)
4134 Lisp_Object portion_whole
;
4137 window
= event
->frame_or_window
;
4138 portion_whole
= Fcons (event
->x
, event
->y
);
4139 part
= *scroll_bar_parts
[(int) event
->part
];
4143 Fcons (Qvertical_scroll_bar
,
4144 Fcons (portion_whole
,
4145 Fcons (make_number (event
->timestamp
),
4146 Fcons (part
, Qnil
)))));
4149 /* Always treat W32 scroll bar events as clicks. */
4150 event
->modifiers
|= click_modifier
;
4153 /* Get the symbol we should use for the mouse click. */
4156 head
= modify_event_symbol (button
,
4159 lispy_mouse_names
, &mouse_syms
,
4160 (sizeof (lispy_mouse_names
)
4161 / sizeof (lispy_mouse_names
[0])));
4170 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4173 Lisp_Object head
, position
;
4176 /* Ignore mouse events that were made on frame that
4177 have been deleted. */
4178 if (! FRAME_LIVE_P (f
))
4180 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4181 &column
, &row
, NULL
, 1);
4182 window
= window_from_coordinates (f
, column
, row
, &part
);
4184 if (!WINDOWP (window
))
4186 window
= event
->frame_or_window
;
4191 int pixcolumn
, pixrow
;
4192 column
-= XINT (XWINDOW (window
)->left
);
4193 row
-= XINT (XWINDOW (window
)->top
);
4194 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4195 XSETINT (event
->x
, pixcolumn
);
4196 XSETINT (event
->y
, pixrow
);
4201 posn
= Qvertical_line
;
4204 buffer_posn_from_coords (XWINDOW (window
),
4209 Lisp_Object head
, position
;
4214 Fcons (Fcons (event
->x
, event
->y
),
4215 Fcons (make_number (event
->timestamp
),
4218 head
= modify_event_symbol (0, event
->modifiers
,
4220 lispy_mouse_wheel_names
,
4221 &mouse_wheel_syms
, 1);
4224 Fcons (make_number (event
->code
),
4228 #endif /* WINDOWSNT */
4236 Lisp_Object head
, position
;
4240 /* The frame_or_window field should be a cons of the frame in
4241 which the event occurred and a list of the filenames
4243 if (! CONSP (event
->frame_or_window
))
4246 f
= XFRAME (XCONS (event
->frame_or_window
)->car
);
4247 files
= XCONS (event
->frame_or_window
)->cdr
;
4249 /* Ignore mouse events that were made on frames that
4250 have been deleted. */
4251 if (! FRAME_LIVE_P (f
))
4253 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4254 &column
, &row
, NULL
, 1);
4255 window
= window_from_coordinates (f
, column
, row
, &part
);
4257 if (!WINDOWP (window
))
4259 window
= XCONS (event
->frame_or_window
)->car
;
4264 int pixcolumn
, pixrow
;
4265 column
-= XINT (XWINDOW (window
)->left
);
4266 row
-= XINT (XWINDOW (window
)->top
);
4267 glyph_to_pixel_coords (f
, column
, row
, &pixcolumn
, &pixrow
);
4268 XSETINT (event
->x
, pixcolumn
);
4269 XSETINT (event
->y
, pixrow
);
4274 posn
= Qvertical_line
;
4277 buffer_posn_from_coords (XWINDOW (window
),
4282 Lisp_Object head
, position
;
4287 Fcons (Fcons (event
->x
, event
->y
),
4288 Fcons (make_number (event
->timestamp
),
4291 head
= modify_event_symbol (0, event
->modifiers
,
4293 lispy_drag_n_drop_names
,
4294 &drag_n_drop_syms
, 1);
4301 #endif /* HAVE_MOUSE */
4303 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
4304 case menu_bar_event
:
4305 /* The event value is in the cdr of the frame_or_window slot. */
4306 if (!CONSP (event
->frame_or_window
))
4308 return XCONS (event
->frame_or_window
)->cdr
;
4311 /* The 'kind' field of the event is something we don't recognize. */
4320 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
4322 Lisp_Object bar_window
;
4323 enum scroll_bar_part part
;
4327 /* Is it a scroll bar movement? */
4328 if (frame
&& ! NILP (bar_window
))
4330 Lisp_Object part_sym
;
4332 part_sym
= *scroll_bar_parts
[(int) part
];
4333 return Fcons (Qscroll_bar_movement
,
4334 (Fcons (Fcons (bar_window
,
4335 Fcons (Qvertical_scroll_bar
,
4336 Fcons (Fcons (x
, y
),
4337 Fcons (make_number (time
),
4343 /* Or is it an ordinary mouse movement? */
4353 /* It's in a frame; which window on that frame? */
4354 pixel_to_glyph_coords (frame
, XINT (x
), XINT (y
), &column
, &row
,
4356 window
= window_from_coordinates (frame
, column
, row
, &area
);
4361 if (WINDOWP (window
))
4363 int pixcolumn
, pixrow
;
4364 column
-= WINDOW_LEFT_MARGIN (XWINDOW (window
));
4365 row
-= XINT (XWINDOW (window
)->top
);
4366 glyph_to_pixel_coords (frame
, column
, row
, &pixcolumn
, &pixrow
);
4367 XSETINT (x
, pixcolumn
);
4368 XSETINT (y
, pixrow
);
4373 posn
= Qvertical_line
;
4376 buffer_posn_from_coords (XWINDOW (window
), column
, row
));
4378 else if (frame
!= 0)
4380 XSETFRAME (window
, frame
);
4391 return Fcons (Qmouse_movement
,
4392 Fcons (Fcons (window
,
4394 Fcons (Fcons (x
, y
),
4395 Fcons (make_number (time
),
4401 #endif /* HAVE_MOUSE */
4403 /* Construct a switch frame event. */
4405 make_lispy_switch_frame (frame
)
4408 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
4411 /* Manipulating modifiers. */
4413 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
4415 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
4416 SYMBOL's name of the end of the modifiers; the string from this
4417 position is the unmodified symbol name.
4419 This doesn't use any caches. */
4422 parse_modifiers_uncached (symbol
, modifier_end
)
4426 struct Lisp_String
*name
;
4430 CHECK_SYMBOL (symbol
, 1);
4433 name
= XSYMBOL (symbol
)->name
;
4435 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
4437 int this_mod_end
= 0;
4440 /* See if the name continues with a modifier word.
4441 Check that the word appears, but don't check what follows it.
4442 Set this_mod and this_mod_end to record what we find. */
4444 switch (name
->data
[i
])
4446 #define SINGLE_LETTER_MOD(BIT) \
4447 (this_mod_end = i + 1, this_mod = BIT)
4450 SINGLE_LETTER_MOD (alt_modifier
);
4454 SINGLE_LETTER_MOD (ctrl_modifier
);
4458 SINGLE_LETTER_MOD (hyper_modifier
);
4462 SINGLE_LETTER_MOD (meta_modifier
);
4466 SINGLE_LETTER_MOD (shift_modifier
);
4470 SINGLE_LETTER_MOD (super_modifier
);
4473 #undef SINGLE_LETTER_MOD
4476 /* If we found no modifier, stop looking for them. */
4477 if (this_mod_end
== 0)
4480 /* Check there is a dash after the modifier, so that it
4481 really is a modifier. */
4482 if (this_mod_end
>= STRING_BYTES (name
)
4483 || name
->data
[this_mod_end
] != '-')
4486 /* This modifier is real; look for another. */
4487 modifiers
|= this_mod
;
4488 i
= this_mod_end
+ 1;
4491 /* Should we include the `click' modifier? */
4492 if (! (modifiers
& (down_modifier
| drag_modifier
4493 | double_modifier
| triple_modifier
))
4494 && i
+ 7 == STRING_BYTES (name
)
4495 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
4496 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
4497 modifiers
|= click_modifier
;
4505 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
4506 prepended to the string BASE[0..BASE_LEN-1].
4507 This doesn't use any caches. */
4509 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
4512 int base_len
, base_len_byte
;
4514 /* Since BASE could contain nulls, we can't use intern here; we have
4515 to use Fintern, which expects a genuine Lisp_String, and keeps a
4518 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
4524 /* Only the event queue may use the `up' modifier; it should always
4525 be turned into a click or drag event before presented to lisp code. */
4526 if (modifiers
& up_modifier
)
4529 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
4530 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
4531 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
4532 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
4533 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
4534 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
4535 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
4536 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
4537 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
4538 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
4539 /* The click modifier is denoted by the absence of other modifiers. */
4543 mod_len
= p
- new_mods
;
4547 Lisp_Object new_name
;
4549 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
4550 mod_len
+ base_len_byte
);
4551 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
4552 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
4554 return Fintern (new_name
, Qnil
);
4559 static char *modifier_names
[] =
4561 "up", "down", "drag", "click", "double", "triple", 0, 0,
4562 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4563 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
4565 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
4567 static Lisp_Object modifier_symbols
;
4569 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
4571 lispy_modifier_list (modifiers
)
4574 Lisp_Object modifier_list
;
4577 modifier_list
= Qnil
;
4578 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
4579 if (modifiers
& (1<<i
))
4580 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
4583 return modifier_list
;
4587 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
4588 where UNMODIFIED is the unmodified form of SYMBOL,
4589 MASK is the set of modifiers present in SYMBOL's name.
4590 This is similar to parse_modifiers_uncached, but uses the cache in
4591 SYMBOL's Qevent_symbol_element_mask property, and maintains the
4592 Qevent_symbol_elements property. */
4595 parse_modifiers (symbol
)
4598 Lisp_Object elements
;
4600 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
4601 if (CONSP (elements
))
4606 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
4607 Lisp_Object unmodified
;
4610 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
4611 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
4614 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
4616 XSETFASTINT (mask
, modifiers
);
4617 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
4619 /* Cache the parsing results on SYMBOL. */
4620 Fput (symbol
, Qevent_symbol_element_mask
,
4622 Fput (symbol
, Qevent_symbol_elements
,
4623 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
4625 /* Since we know that SYMBOL is modifiers applied to unmodified,
4626 it would be nice to put that in unmodified's cache.
4627 But we can't, since we're not sure that parse_modifiers is
4634 /* Apply the modifiers MODIFIERS to the symbol BASE.
4635 BASE must be unmodified.
4637 This is like apply_modifiers_uncached, but uses BASE's
4638 Qmodifier_cache property, if present. It also builds
4639 Qevent_symbol_elements properties, since it has that info anyway.
4641 apply_modifiers copies the value of BASE's Qevent_kind property to
4642 the modified symbol. */
4644 apply_modifiers (modifiers
, base
)
4648 Lisp_Object cache
, index
, entry
, new_symbol
;
4650 /* Mask out upper bits. We don't know where this value's been. */
4651 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
4653 /* The click modifier never figures into cache indices. */
4654 cache
= Fget (base
, Qmodifier_cache
);
4655 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
4656 entry
= assq_no_quit (index
, cache
);
4659 new_symbol
= XCONS (entry
)->cdr
;
4662 /* We have to create the symbol ourselves. */
4663 new_symbol
= apply_modifiers_uncached (modifiers
,
4664 XSYMBOL (base
)->name
->data
,
4665 XSYMBOL (base
)->name
->size
,
4666 STRING_BYTES (XSYMBOL (base
)->name
));
4668 /* Add the new symbol to the base's cache. */
4669 entry
= Fcons (index
, new_symbol
);
4670 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
4672 /* We have the parsing info now for free, so add it to the caches. */
4673 XSETFASTINT (index
, modifiers
);
4674 Fput (new_symbol
, Qevent_symbol_element_mask
,
4675 Fcons (base
, Fcons (index
, Qnil
)));
4676 Fput (new_symbol
, Qevent_symbol_elements
,
4677 Fcons (base
, lispy_modifier_list (modifiers
)));
4680 /* Make sure this symbol is of the same kind as BASE.
4682 You'd think we could just set this once and for all when we
4683 intern the symbol above, but reorder_modifiers may call us when
4684 BASE's property isn't set right; we can't assume that just
4685 because it has a Qmodifier_cache property it must have its
4686 Qevent_kind set right as well. */
4687 if (NILP (Fget (new_symbol
, Qevent_kind
)))
4691 kind
= Fget (base
, Qevent_kind
);
4693 Fput (new_symbol
, Qevent_kind
, kind
);
4700 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
4701 return a symbol with the modifiers placed in the canonical order.
4702 Canonical order is alphabetical, except for down and drag, which
4703 always come last. The 'click' modifier is never written out.
4705 Fdefine_key calls this to make sure that (for example) C-M-foo
4706 and M-C-foo end up being equivalent in the keymap. */
4709 reorder_modifiers (symbol
)
4712 /* It's hopefully okay to write the code this way, since everything
4713 will soon be in caches, and no consing will be done at all. */
4716 parsed
= parse_modifiers (symbol
);
4717 return apply_modifiers ((int) XINT (XCONS (XCONS (parsed
)->cdr
)->car
),
4718 XCONS (parsed
)->car
);
4722 /* For handling events, we often want to produce a symbol whose name
4723 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
4724 to some base, like the name of a function key or mouse button.
4725 modify_event_symbol produces symbols of this sort.
4727 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
4728 is the name of the i'th symbol. TABLE_SIZE is the number of elements
4731 Alternatively, NAME_ALIST is an alist mapping codes into symbol names.
4732 NAME_ALIST is used if it is non-nil; otherwise NAME_TABLE is used.
4734 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
4735 persist between calls to modify_event_symbol that it can use to
4736 store a cache of the symbols it's generated for this NAME_TABLE
4737 before. The object stored there may be a vector or an alist.
4739 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
4741 MODIFIERS is a set of modifier bits (as given in struct input_events)
4742 whose prefixes should be applied to the symbol name.
4744 SYMBOL_KIND is the value to be placed in the event_kind property of
4745 the returned symbol.
4747 The symbols we create are supposed to have an
4748 `event-symbol-elements' property, which lists the modifiers present
4749 in the symbol's name. */
4752 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist
,
4753 name_table
, symbol_table
, table_size
)
4756 Lisp_Object symbol_kind
;
4757 Lisp_Object name_alist
;
4759 Lisp_Object
*symbol_table
;
4760 unsigned int table_size
;
4763 Lisp_Object symbol_int
;
4765 /* Get rid of the "vendor-specific" bit here. */
4766 XSETINT (symbol_int
, symbol_num
& 0xffffff);
4768 /* Is this a request for a valid symbol? */
4769 if (symbol_num
< 0 || symbol_num
>= table_size
)
4772 if (CONSP (*symbol_table
))
4773 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
4775 /* If *symbol_table doesn't seem to be initialized properly, fix that.
4776 *symbol_table should be a lisp vector TABLE_SIZE elements long,
4777 where the Nth element is the symbol for NAME_TABLE[N], or nil if
4778 we've never used that symbol before. */
4781 if (! VECTORP (*symbol_table
)
4782 || XVECTOR (*symbol_table
)->size
!= table_size
)
4786 XSETFASTINT (size
, table_size
);
4787 *symbol_table
= Fmake_vector (size
, Qnil
);
4790 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
4793 /* Have we already used this symbol before? */
4796 /* No; let's create it. */
4797 if (!NILP (name_alist
))
4798 value
= Fcdr_safe (Fassq (symbol_int
, name_alist
));
4799 else if (name_table
!= 0 && name_table
[symbol_num
])
4800 value
= intern (name_table
[symbol_num
]);
4802 #ifdef HAVE_WINDOW_SYSTEM
4805 char *name
= x_get_keysym_name (symbol_num
);
4807 value
= intern (name
);
4814 sprintf (buf
, "key-%d", symbol_num
);
4815 value
= intern (buf
);
4818 if (CONSP (*symbol_table
))
4819 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
4821 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
4823 /* Fill in the cache entries for this symbol; this also
4824 builds the Qevent_symbol_elements property, which the user
4826 apply_modifiers (modifiers
& click_modifier
, value
);
4827 Fput (value
, Qevent_kind
, symbol_kind
);
4830 /* Apply modifiers to that symbol. */
4831 return apply_modifiers (modifiers
, value
);
4834 /* Convert a list that represents an event type,
4835 such as (ctrl meta backspace), into the usual representation of that
4836 event type as a number or a symbol. */
4838 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
4839 "Convert the event description list EVENT-DESC to an event type.\n\
4840 EVENT-DESC should contain one base event type (a character or symbol)\n\
4841 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
4842 drag, down, double or triple). The base must be last.\n\
4843 The return value is an event type (a character or symbol) which\n\
4844 has the same base event type and all the specified modifiers.")
4846 Lisp_Object event_desc
;
4854 while (CONSP (rest
))
4859 elt
= XCONS (rest
)->car
;
4860 rest
= XCONS (rest
)->cdr
;
4862 /* Given a symbol, see if it is a modifier name. */
4863 if (SYMBOLP (elt
) && CONSP (rest
))
4864 this = parse_solitary_modifier (elt
);
4868 else if (!NILP (base
))
4869 error ("Two bases given in one event");
4875 /* Let the symbol A refer to the character A. */
4876 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
4877 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
4879 if (INTEGERP (base
))
4881 /* Turn (shift a) into A. */
4882 if ((modifiers
& shift_modifier
) != 0
4883 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
4885 XSETINT (base
, XINT (base
) - ('a' - 'A'));
4886 modifiers
&= ~shift_modifier
;
4889 /* Turn (control a) into C-a. */
4890 if (modifiers
& ctrl_modifier
)
4891 return make_number ((modifiers
& ~ctrl_modifier
)
4892 | make_ctrl_char (XINT (base
)));
4894 return make_number (modifiers
| XINT (base
));
4896 else if (SYMBOLP (base
))
4897 return apply_modifiers (modifiers
, base
);
4899 error ("Invalid base event");
4902 /* Try to recognize SYMBOL as a modifier name.
4903 Return the modifier flag bit, or 0 if not recognized. */
4906 parse_solitary_modifier (symbol
)
4909 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
4911 switch (name
->data
[0])
4913 #define SINGLE_LETTER_MOD(BIT) \
4914 if (STRING_BYTES (name) == 1) \
4917 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
4918 if (LEN == STRING_BYTES (name) \
4919 && ! strncmp (name->data, NAME, LEN)) \
4923 SINGLE_LETTER_MOD (alt_modifier
);
4927 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
4931 SINGLE_LETTER_MOD (ctrl_modifier
);
4935 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
4936 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
4940 SINGLE_LETTER_MOD (hyper_modifier
);
4944 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
4948 SINGLE_LETTER_MOD (meta_modifier
);
4952 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
4956 SINGLE_LETTER_MOD (shift_modifier
);
4960 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
4961 MULTI_LETTER_MOD (super_modifier
, "super", 5);
4962 SINGLE_LETTER_MOD (super_modifier
);
4966 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
4967 MULTI_LETTER_MOD (down_modifier
, "down", 4);
4968 MULTI_LETTER_MOD (double_modifier
, "double", 6);
4972 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
4975 #undef SINGLE_LETTER_MOD
4976 #undef MULTI_LETTER_MOD
4982 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
4983 Such a list is not valid as an event,
4984 but it can be a Lucid-style event type list. */
4987 lucid_event_type_list_p (object
)
4992 if (! CONSP (object
))
4995 for (tail
= object
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
4998 elt
= XCONS (tail
)->car
;
4999 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5006 /* Store into *addr a value nonzero if terminal input chars are available.
5007 Serves the purpose of ioctl (0, FIONREAD, addr)
5008 but works even if FIONREAD does not exist.
5009 (In fact, this may actually read some input.)
5011 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5014 get_input_pending (addr
, do_timers_now
)
5018 /* First of all, have we already counted some input? */
5019 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5021 /* If input is being read as it arrives, and we have none, there is none. */
5022 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5025 /* Try to read some input and see how much we get. */
5027 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5030 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5033 gobble_input (expected
)
5038 if (interrupt_input
)
5041 mask
= sigblock (sigmask (SIGIO
));
5042 read_avail_input (expected
);
5046 #ifdef POLL_FOR_INPUT
5047 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5050 mask
= sigblock (sigmask (SIGALRM
));
5051 read_avail_input (expected
);
5057 read_avail_input (expected
);
5061 /* Put a buffer_switch_event in the buffer
5062 so that read_key_sequence will notice the new current buffer. */
5065 record_asynch_buffer_change ()
5067 struct input_event event
;
5070 event
.kind
= buffer_switch_event
;
5071 event
.frame_or_window
= Qnil
;
5074 /* We don't need a buffer-switch event unless Emacs is waiting for input.
5075 The purpose of the event is to make read_key_sequence look up the
5076 keymaps again. If we aren't in read_key_sequence, we don't need one,
5077 and the event could cause trouble by messing up (input-pending-p). */
5078 tem
= Fwaiting_for_user_input_p ();
5082 /* We never need these events if we have no asynchronous subprocesses. */
5086 /* Make sure no interrupt happens while storing the event. */
5088 if (interrupt_input
)
5091 mask
= sigblock (sigmask (SIGIO
));
5092 kbd_buffer_store_event (&event
);
5099 kbd_buffer_store_event (&event
);
5106 /* Read any terminal input already buffered up by the system
5107 into the kbd_buffer, but do not wait.
5109 EXPECTED should be nonzero if the caller knows there is some input.
5111 Except on VMS, all input is read by this function.
5112 If interrupt_input is nonzero, this function MUST be called
5113 only when SIGIO is blocked.
5115 Returns the number of keyboard chars read, or -1 meaning
5116 this is a bad time to try to read input. */
5119 read_avail_input (expected
)
5122 struct input_event buf
[KBD_BUFFER_SIZE
];
5126 if (read_socket_hook
)
5127 /* No need for FIONREAD or fcntl; just say don't wait. */
5128 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
5131 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
5132 the kbd_buffer can really hold. That may prevent loss
5133 of characters on some systems when input is stuffed at us. */
5134 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
5137 /* Determine how many characters we should *try* to read. */
5140 #else /* not WINDOWSNT */
5142 n_to_read
= dos_keysns ();
5145 #else /* not MSDOS */
5147 /* Find out how much input is available. */
5148 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
5149 /* Formerly simply reported no input, but that sometimes led to
5150 a failure of Emacs to terminate.
5151 SIGHUP seems appropriate if we can't reach the terminal. */
5152 /* ??? Is it really right to send the signal just to this process
5153 rather than to the whole process group?
5154 Perhaps on systems with FIONREAD Emacs is alone in its group. */
5155 kill (getpid (), SIGHUP
);
5158 if (n_to_read
> sizeof cbuf
)
5159 n_to_read
= sizeof cbuf
;
5160 #else /* no FIONREAD */
5161 #if defined (USG) || defined (DGUX)
5162 /* Read some input if available, but don't wait. */
5163 n_to_read
= sizeof cbuf
;
5164 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
5169 #endif /* not MSDOS */
5170 #endif /* not WINDOWSNT */
5172 /* Now read; for one reason or another, this will not block.
5173 NREAD is set to the number of chars read. */
5177 cbuf
[0] = dos_keyread ();
5180 nread
= read (input_fd
, cbuf
, n_to_read
);
5182 /* POSIX infers that processes which are not in the session leader's
5183 process group won't get SIGHUP's at logout time. BSDI adheres to
5184 this part standard and returns -1 from read (0) with errno==EIO
5185 when the control tty is taken away.
5186 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
5187 if (nread
== -1 && errno
== EIO
)
5189 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
5190 /* The kernel sometimes fails to deliver SIGHUP for ptys.
5191 This looks incorrect, but it isn't, because _BSD causes
5192 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
5193 and that causes a value other than 0 when there is no input. */
5199 /* We used to retry the read if it was interrupted.
5200 But this does the wrong thing when O_NDELAY causes
5201 an EAGAIN error. Does anybody know of a situation
5202 where a retry is actually needed? */
5204 nread
< 0 && (errno
== EAGAIN
5218 #if defined (USG) || defined (DGUX)
5219 fcntl (input_fd
, F_SETFL
, 0);
5220 #endif /* USG or DGUX */
5221 #endif /* no FIONREAD */
5222 for (i
= 0; i
< nread
; i
++)
5224 buf
[i
].kind
= ascii_keystroke
;
5225 buf
[i
].modifiers
= 0;
5226 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
5227 buf
[i
].modifiers
= meta_modifier
;
5231 buf
[i
].code
= cbuf
[i
];
5232 XSETFRAME (buf
[i
].frame_or_window
, selected_frame
);
5236 /* Scan the chars for C-g and store them in kbd_buffer. */
5237 for (i
= 0; i
< nread
; i
++)
5239 kbd_buffer_store_event (&buf
[i
]);
5240 /* Don't look at input that follows a C-g too closely.
5241 This reduces lossage due to autorepeat on C-g. */
5242 if (buf
[i
].kind
== ascii_keystroke
5243 && buf
[i
].code
== quit_char
)
5249 #endif /* not VMS */
5251 #ifdef SIGIO /* for entire page */
5252 /* Note SIGIO has been undef'd if FIONREAD is missing. */
5255 input_available_signal (signo
)
5258 /* Must preserve main program's value of errno. */
5259 int old_errno
= errno
;
5261 extern int select_alarmed
;
5264 #if defined (USG) && !defined (POSIX_SIGNALS)
5265 /* USG systems forget handlers when they are used;
5266 must reestablish each time */
5267 signal (signo
, input_available_signal
);
5274 if (input_available_clear_time
)
5275 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
5280 nread
= read_avail_input (1);
5281 /* -1 means it's not ok to read the input now.
5282 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
5283 0 means there was no keyboard input available. */
5288 select_alarmed
= 1; /* Force the select emulator back to life */
5299 /* Send ourselves a SIGIO.
5301 This function exists so that the UNBLOCK_INPUT macro in
5302 blockinput.h can have some way to take care of input we put off
5303 dealing with, without assuming that every file which uses
5304 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
5306 reinvoke_input_signal ()
5309 kill (getpid (), SIGIO
);
5315 /* Return the prompt-string of a sparse keymap.
5316 This is the first element which is a string.
5317 Return nil if there is none. */
5325 register Lisp_Object tem
;
5334 static void menu_bar_item ();
5335 static void menu_bar_one_keymap ();
5337 /* These variables hold the vector under construction within
5338 menu_bar_items and its subroutines, and the current index
5339 for storing into that vector. */
5340 static Lisp_Object menu_bar_items_vector
;
5341 static int menu_bar_items_index
;
5343 /* Return a vector of menu items for a menu bar, appropriate
5344 to the current buffer. Each item has three elements in the vector:
5347 OLD is an old vector we can optionally reuse, or nil. */
5350 menu_bar_items (old
)
5353 /* The number of keymaps we're scanning right now, and the number of
5354 keymaps we have allocated space for. */
5357 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
5358 in the current keymaps, or nil where it is not a prefix. */
5361 Lisp_Object def
, tem
, tail
;
5370 struct gcpro gcpro1
;
5372 /* In order to build the menus, we need to call the keymap
5373 accessors. They all call QUIT. But this function is called
5374 during redisplay, during which a quit is fatal. So inhibit
5375 quitting while building the menus.
5376 We do this instead of specbind because (1) errors will clear it anyway
5377 and (2) this avoids risk of specpdl overflow. */
5378 oquit
= Vinhibit_quit
;
5382 menu_bar_items_vector
= old
;
5384 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
5385 menu_bar_items_index
= 0;
5387 GCPRO1 (menu_bar_items_vector
);
5389 /* Build our list of keymaps.
5390 If we recognize a function key and replace its escape sequence in
5391 keybuf with its symbol, or if the sequence starts with a mouse
5392 click and we need to switch buffers, we jump back here to rebuild
5393 the initial keymaps from the current buffer. */
5397 /* Should overriding-terminal-local-map and overriding-local-map apply? */
5398 if (!NILP (Voverriding_local_map_menu_flag
))
5400 /* Yes, use them (if non-nil) as well as the global map. */
5401 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
5403 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
5404 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
5405 if (!NILP (Voverriding_local_map
))
5406 maps
[nmaps
++] = Voverriding_local_map
;
5410 /* No, so use major and minor mode keymaps. */
5411 nmaps
= current_minor_maps (NULL
, &tmaps
);
5412 maps
= (Lisp_Object
*) alloca ((nmaps
+ 2) * sizeof (maps
[0]));
5413 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
5414 #ifdef USE_TEXT_PROPERTIES
5415 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
5417 maps
[nmaps
++] = current_buffer
->keymap
;
5420 maps
[nmaps
++] = current_global_map
;
5423 /* Look up in each map the dummy prefix key `menu-bar'. */
5427 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
5429 if (! NILP (maps
[mapno
]))
5430 def
= get_keyelt (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0), 0);
5434 tem
= Fkeymapp (def
);
5436 menu_bar_one_keymap (def
);
5439 /* Move to the end those items that should be at the end. */
5441 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5444 int end
= menu_bar_items_index
;
5446 for (i
= 0; i
< end
; i
+= 4)
5447 if (EQ (XCONS (tail
)->car
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5449 Lisp_Object tem0
, tem1
, tem2
, tem3
;
5450 /* Move the item at index I to the end,
5451 shifting all the others forward. */
5452 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
5453 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
5454 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5455 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
5457 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5458 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5459 (end
- i
- 4) * sizeof (Lisp_Object
));
5460 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
5461 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
5462 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
5463 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
5468 /* Add nil, nil, nil, nil at the end. */
5469 i
= menu_bar_items_index
;
5470 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5473 int newsize
= 2 * i
;
5474 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5475 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5476 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5477 menu_bar_items_vector
= tem
;
5479 /* Add this item. */
5480 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5481 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5482 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5483 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
5484 menu_bar_items_index
= i
;
5486 Vinhibit_quit
= oquit
;
5488 return menu_bar_items_vector
;
5491 /* Scan one map KEYMAP, accumulating any menu items it defines
5492 in menu_bar_items_vector. */
5495 menu_bar_one_keymap (keymap
)
5498 Lisp_Object tail
, item
, table
;
5500 /* Loop over all keymap entries that have menu strings. */
5501 for (tail
= keymap
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
5503 item
= XCONS (tail
)->car
;
5505 menu_bar_item (XCONS (item
)->car
, XCONS (item
)->cdr
);
5506 else if (VECTORP (item
))
5508 /* Loop over the char values represented in the vector. */
5509 int len
= XVECTOR (item
)->size
;
5511 for (c
= 0; c
< len
; c
++)
5513 Lisp_Object character
;
5514 XSETFASTINT (character
, c
);
5515 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
5521 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
5522 If there's already an item for KEY, add this DEF to it. */
5524 Lisp_Object item_properties
;
5527 menu_bar_item (key
, item
)
5528 Lisp_Object key
, item
;
5530 struct gcpro gcpro1
;
5533 if (EQ (item
, Qundefined
))
5535 /* If a map has an explicit `undefined' as definition,
5536 discard any previously made menu bar item. */
5538 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5539 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5541 if (menu_bar_items_index
> i
+ 4)
5542 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
5543 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
5544 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
5545 menu_bar_items_index
-= 4;
5549 /* If there's no definition for this key yet,
5550 just ignore `undefined'. */
5554 GCPRO1 (key
); /* Is this necessary? */
5555 i
= parse_menu_item (item
, 0, 1);
5560 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5562 /* Find any existing item for this KEY. */
5563 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
5564 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
5567 /* If we did not find this KEY, add it at the end. */
5568 if (i
== menu_bar_items_index
)
5570 /* If vector is too small, get a bigger one. */
5571 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
5574 int newsize
= 2 * i
;
5575 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
5576 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
5577 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
5578 menu_bar_items_vector
= tem
;
5581 /* Add this item. */
5582 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
5583 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
5584 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5585 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
5586 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
5587 menu_bar_items_index
= i
;
5589 /* We did find an item for this KEY. Add ITEM to its list of maps. */
5593 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
5594 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
5598 /* This is used as the handler when calling menu_item_eval_property. */
5600 menu_item_eval_property_1 (arg
)
5603 /* If we got a quit from within the menu computation,
5604 quit all the way out of it. This takes care of C-] in the debugger. */
5605 if (CONSP (arg
) && EQ (XCONS (arg
)->car
, Qquit
))
5606 Fsignal (Qquit
, Qnil
);
5611 /* Evaluate an expression and return the result (or nil if something
5612 went wrong). Used to evaluate dynamic parts of menu items. */
5614 menu_item_eval_property (sexpr
)
5618 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
5619 menu_item_eval_property_1
);
5623 /* This function parses a menu item and leaves the result in the
5624 vector item_properties.
5625 ITEM is a key binding, a possible menu item.
5626 If NOTREAL is nonzero, only check for equivalent key bindings, don't
5627 evaluate dynamic expressions in the menu item.
5628 INMENUBAR is > 0 when this is considered for an entry in a menu bar
5630 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
5631 parse_menu_item returns true if the item is a menu item and false
5635 parse_menu_item (item
, notreal
, inmenubar
)
5637 int notreal
, inmenubar
;
5639 Lisp_Object def
, tem
, item_string
, start
, type
;
5641 Lisp_Object cachelist
;
5643 Lisp_Object keyhint
;
5645 struct gcpro gcpro1
, gcpro2
, gcpro3
;
5665 /* Create item_properties vector if necessary. */
5666 if (NILP (item_properties
))
5668 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
5670 /* Initialize optional entries. */
5671 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
5672 XVECTOR (item_properties
)->contents
[i
] = Qnil
;
5673 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = Qt
;
5675 /* Save the item here to protect it from GC. */
5676 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ITEM
] = item
;
5678 item_string
= XCONS (item
)->car
;
5681 item
= XCONS (item
)->cdr
;
5682 if (STRINGP (item_string
))
5684 /* Old format menu item. */
5685 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
5687 /* Maybe help string. */
5688 if (CONSP (item
) && STRINGP (XCONS (item
)->car
))
5690 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5691 = XCONS (item
)->car
;
5693 item
= XCONS (item
)->cdr
;
5696 /* Maybee key binding cache. */
5697 if (CONSP (item
) && CONSP (XCONS (item
)->car
)
5698 && (NILP (XCONS (XCONS (item
)->car
)->car
)
5699 || VECTORP (XCONS (XCONS (item
)->car
)->car
)))
5701 cachelist
= XCONS (item
)->car
;
5702 item
= XCONS (item
)->cdr
;
5705 /* This is the real definition--the function to run. */
5706 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = item
;
5708 /* Get enable property, if any. */
5711 tem
= Fget (item
, Qmenu_enable
);
5713 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
5716 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
5718 /* New format menu item. */
5719 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
]
5720 = XCONS (item
)->car
;
5721 start
= XCONS (item
)->cdr
;
5724 /* We have a real binding. */
5725 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
]
5726 = XCONS (start
)->car
;
5728 item
= XCONS (start
)->cdr
;
5729 /* Is there a cache list with key equivalences. */
5730 if (CONSP (item
) && CONSP (XCONS (item
)->car
))
5732 cachelist
= XCONS (item
)->car
;
5733 item
= XCONS (item
)->cdr
;
5736 /* Parse properties. */
5737 while (CONSP (item
) && CONSP (XCONS (item
)->cdr
))
5739 tem
= XCONS (item
)->car
;
5740 item
= XCONS (item
)->cdr
;
5742 if (EQ (tem
, QCenable
))
5743 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
]
5744 = XCONS (item
)->car
;
5745 else if (EQ (tem
, QCvisible
) && !notreal
)
5747 /* If got a visible property and that evaluates to nil
5748 then ignore this item. */
5749 tem
= menu_item_eval_property (XCONS (item
)->car
);
5753 else if (EQ (tem
, QChelp
))
5754 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]
5755 = XCONS (item
)->car
;
5756 else if (EQ (tem
, QCfilter
))
5758 else if (EQ (tem
, QCkey_sequence
))
5760 tem
= XCONS (item
)->car
;
5761 if (NILP (cachelist
)
5762 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
5763 /* Be GC protected. Set keyhint to item instead of tem. */
5766 else if (EQ (tem
, QCkeys
))
5768 tem
= XCONS (item
)->car
;
5769 if (CONSP (tem
) || STRINGP (tem
) && NILP (cachelist
))
5770 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
]
5773 else if (EQ (tem
, QCbutton
) && CONSP (XCONS (item
)->car
))
5776 tem
= XCONS (item
)->car
;
5777 type
= XCONS (tem
)->car
;
5778 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
5780 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
5782 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
]
5786 item
= XCONS (item
)->cdr
;
5789 else if (inmenubar
|| !NILP (start
))
5795 /* If item string is not a string, evaluate it to get string.
5796 If we don't get a string, skip this item. */
5797 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5798 if (!(STRINGP (item_string
) || notreal
))
5800 item_string
= menu_item_eval_property (item_string
);
5801 if (!STRINGP (item_string
))
5803 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
] = item_string
;
5806 /* If got a filter apply it on definition. */
5807 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5810 def
= menu_item_eval_property (Fcons (XCONS (filter
)->car
,
5811 Fcons (def
, Qnil
)));
5812 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = def
;
5815 /* If we got no definition, this item is just unselectable text which
5816 is OK in a submenu but not in the menubar. */
5817 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
5821 return (inmenubar
? 0 : 1);
5824 /* Enable or disable selection of item. */
5825 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
];
5831 tem
= menu_item_eval_property (tem
);
5832 if (inmenubar
&& NILP (tem
))
5833 RET0
; /* Ignore disabled items in menu bar. */
5834 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
] = tem
;
5837 /* See if this is a separate pane or a submenu. */
5838 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5839 tem
= get_keymap_1 (def
, 0, 1);
5842 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_MAP
] = tem
;
5843 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
] = tem
;
5848 RET0
; /* Entries in menu bar must be submenus. */
5850 /* This is a command. See if there is an equivalent key binding. */
5851 if (NILP (cachelist
))
5853 /* We have to create a cachelist. */
5854 CHECK_IMPURE (start
);
5855 XCONS (start
)->cdr
= Fcons (Fcons (Qnil
, Qnil
), XCONS (start
)->cdr
);
5856 cachelist
= XCONS (XCONS (start
)->cdr
)->car
;
5858 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
5859 if (!NILP (keyhint
))
5861 XCONS (cachelist
)->car
= XCONS (keyhint
)->car
;
5864 else if (STRINGP (tem
))
5866 XCONS (cachelist
)->cdr
= Fsubstitute_command_keys (tem
);
5867 XCONS (cachelist
)->car
= Qt
;
5870 tem
= XCONS (cachelist
)->car
;
5877 tem
= Fkey_binding (tem
, Qnil
);
5879 prefix
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
5882 def
= XCONS (prefix
)->car
;
5883 prefix
= XCONS (prefix
)->cdr
;
5886 def
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
5888 if (NILP (XCONS (cachelist
)->car
)) /* Have no saved key. */
5890 if (newcache
/* Always check first time. */
5891 /* Should we check everything when precomputing key
5894 /* If something had no key binding before, don't recheck it
5895 because that is too slow--except if we have a list of
5896 rebound commands in Vdefine_key_rebound_commands, do
5897 recheck any command that appears in that list. */
5898 || (CONSP (Vdefine_key_rebound_commands
)
5899 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
5902 /* We had a saved key. Is it still bound to the command? */
5905 /* If the command is an alias for another
5906 (such as lmenu.el set it up), check if the
5907 original command matches the cached command. */
5908 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
)))
5909 chkcache
= 1; /* Need to recompute key binding. */
5913 /* Recompute equivalent key binding. If the command is an alias
5914 for another (such as lmenu.el set it up), see if the original
5915 command name has equivalent keys. Otherwise look up the
5916 specified command itself. We don't try both, because that
5917 makes lmenu menus slow. */
5918 if (SYMBOLP (def
) && SYMBOLP (XSYMBOL (def
)->function
)
5919 && ! NILP (Fget (def
, Qmenu_alias
)))
5920 def
= XSYMBOL (def
)->function
;
5921 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
5922 XCONS (cachelist
)->car
= tem
;
5925 XCONS (cachelist
)->cdr
= Qnil
;
5929 else if (!NILP (keyhint
) && !NILP (XCONS (cachelist
)->car
))
5931 tem
= XCONS (cachelist
)->car
;
5935 newcache
= chkcache
;
5938 tem
= Fkey_description (tem
);
5941 if (STRINGP (XCONS (prefix
)->car
))
5942 tem
= concat2 (XCONS (prefix
)->car
, tem
);
5943 if (STRINGP (XCONS (prefix
)->cdr
))
5944 tem
= concat2 (tem
, XCONS (prefix
)->cdr
);
5946 XCONS (cachelist
)->cdr
= tem
;
5950 tem
= XCONS (cachelist
)->cdr
;
5951 if (newcache
&& !NILP (tem
))
5953 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
5954 XCONS (cachelist
)->cdr
= tem
;
5957 /* If we only want to precompute equivalent key bindings, stop here. */
5964 /* If we have an equivalent key binding, use that. */
5965 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
]
5966 = XCONS (cachelist
)->cdr
;
5968 /* Include this when menu help is implemented.
5969 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
5970 if (!(NILP (tem) || STRINGP (tem)))
5972 tem = menu_item_eval_property (tem);
5975 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
5979 /* Handle radio buttons or toggle boxes. */
5980 tem
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
5982 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
]
5983 = menu_item_eval_property (tem
);
5989 /* Read a character using menus based on maps in the array MAPS.
5990 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
5991 Return t if we displayed a menu but the user rejected it.
5993 PREV_EVENT is the previous input event, or nil if we are reading
5994 the first event of a key sequence.
5996 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
5997 if we used a mouse menu to read the input, or zero otherwise. If
5998 USED_MOUSE_MENU is null, we don't dereference it.
6000 The prompting is done based on the prompt-string of the map
6001 and the strings associated with various map elements.
6003 This can be done with X menus or with menus put in the minibuf.
6004 These are done in different ways, depending on how the input will be read.
6005 Menus using X are done after auto-saving in read-char, getting the input
6006 event from Fx_popup_menu; menus using the minibuf use read_char recursively
6007 and do auto-saving in the inner call of read_char. */
6010 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
6013 Lisp_Object prev_event
;
6014 int *used_mouse_menu
;
6017 register Lisp_Object name
;
6018 Lisp_Object rest
, vector
;
6020 if (used_mouse_menu
)
6021 *used_mouse_menu
= 0;
6023 /* Use local over global Menu maps */
6025 if (! menu_prompting
)
6028 /* Optionally disregard all but the global map. */
6029 if (inhibit_local_menu_bar_menus
)
6031 maps
+= (nmaps
- 1);
6035 /* Get the menu name from the first map that has one (a prompt string). */
6036 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6038 name
= map_prompt (maps
[mapno
]);
6043 /* If we don't have any menus, just read a character normally. */
6048 /* If we got to this point via a mouse click,
6049 use a real menu for mouse selection. */
6050 if (EVENT_HAS_PARAMETERS (prev_event
)
6051 && !EQ (XCONS (prev_event
)->car
, Qmenu_bar
))
6053 /* Display the menu and get the selection. */
6054 Lisp_Object
*realmaps
6055 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
6059 /* Use the maps that are not nil. */
6060 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6061 if (!NILP (maps
[mapno
]))
6062 realmaps
[nmaps1
++] = maps
[mapno
];
6064 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
6069 record_menu_key (XCONS (value
)->car
);
6071 /* If we got multiple events, unread all but
6073 There is no way to prevent those unread events
6074 from showing up later in last_nonmenu_event.
6075 So turn symbol and integer events into lists,
6076 to indicate that they came from a mouse menu,
6077 so that when present in last_nonmenu_event
6078 they won't confuse things. */
6079 for (tem
= XCONS (value
)->cdr
; !NILP (tem
);
6080 tem
= XCONS (tem
)->cdr
)
6082 record_menu_key (XCONS (tem
)->car
);
6083 if (SYMBOLP (XCONS (tem
)->car
)
6084 || INTEGERP (XCONS (tem
)->car
))
6086 = Fcons (XCONS (tem
)->car
, Qnil
);
6089 /* If we got more than one event, put all but the first
6090 onto this list to be read later.
6091 Return just the first event now. */
6092 Vunread_command_events
6093 = nconc2 (XCONS (value
)->cdr
, Vunread_command_events
);
6094 value
= XCONS (value
)->car
;
6096 else if (NILP (value
))
6098 if (used_mouse_menu
)
6099 *used_mouse_menu
= 1;
6102 #endif /* HAVE_MENUS */
6106 /* Buffer in use so far for the minibuf prompts for menu keymaps.
6107 We make this bigger when necessary, and never free it. */
6108 static char *read_char_minibuf_menu_text
;
6109 /* Size of that buffer. */
6110 static int read_char_minibuf_menu_width
;
6113 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
6119 register Lisp_Object name
;
6121 int width
= FRAME_WIDTH (selected_frame
) - 4;
6124 Lisp_Object rest
, vector
;
6127 if (! menu_prompting
)
6130 /* Make sure we have a big enough buffer for the menu text. */
6131 if (read_char_minibuf_menu_text
== 0)
6133 read_char_minibuf_menu_width
= width
+ 4;
6134 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
6136 else if (width
+ 4 > read_char_minibuf_menu_width
)
6138 read_char_minibuf_menu_width
= width
+ 4;
6139 read_char_minibuf_menu_text
6140 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
6142 menu
= read_char_minibuf_menu_text
;
6144 /* Get the menu name from the first map that has one (a prompt string). */
6145 for (mapno
= 0; mapno
< nmaps
; mapno
++)
6147 name
= map_prompt (maps
[mapno
]);
6152 /* If we don't have any menus, just read a character normally. */
6156 /* Prompt string always starts with map's prompt, and a space. */
6157 strcpy (menu
, XSTRING (name
)->data
);
6158 nlength
= STRING_BYTES (XSTRING (name
));
6159 menu
[nlength
++] = ':';
6160 menu
[nlength
++] = ' ';
6163 /* Start prompting at start of first map. */
6167 /* Present the documented bindings, a line at a time. */
6174 Lisp_Object orig_defn_macro
;
6176 /* Loop over elements of map. */
6181 /* If reached end of map, start at beginning of next map. */
6185 /* At end of last map, wrap around to first map if just starting,
6186 or end this line if already have something on it. */
6190 if (notfirst
|| nobindings
) break;
6195 /* Look at the next element of the map. */
6197 elt
= XVECTOR (vector
)->contents
[idx
];
6199 elt
= Fcar_safe (rest
);
6201 if (idx
< 0 && VECTORP (elt
))
6203 /* If we found a dense table in the keymap,
6204 advanced past it, but start scanning its contents. */
6205 rest
= Fcdr_safe (rest
);
6211 /* An ordinary element. */
6212 Lisp_Object event
, tem
;
6216 event
= Fcar_safe (elt
); /* alist */
6217 elt
= Fcdr_safe (elt
);
6221 XSETINT (event
, idx
); /* vector */
6224 /* Ignore the element if it has no prompt string. */
6225 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
6227 /* 1 if the char to type matches the string. */
6229 Lisp_Object upcased_event
, downcased_event
;
6232 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6234 upcased_event
= Fupcase (event
);
6235 downcased_event
= Fdowncase (event
);
6236 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
6237 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
6239 desc
= Fsingle_key_description (event
);
6242 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
6244 /* Insert equivalent keybinding. */
6245 s
= concat2 (s
, tem
);
6248 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
6249 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
6251 /* Insert button prefix. */
6252 Lisp_Object selected
6253 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
6254 if (EQ (tem
, QCradio
))
6255 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
6257 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
6258 s
= concat2 (tem
, s
);
6262 /* If we have room for the prompt string, add it to this line.
6263 If this is the first on the line, always add it. */
6264 if ((XSTRING (s
)->size
+ i
+ 2
6265 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
6271 /* Punctuate between strings. */
6274 strcpy (menu
+ i
, ", ");
6280 /* If the char to type doesn't match the string's
6281 first char, explicitly show what char to type. */
6284 /* Add as much of string as fits. */
6285 thiswidth
= XSTRING (desc
)->size
;
6286 if (thiswidth
+ i
> width
)
6287 thiswidth
= width
- i
;
6288 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
6290 strcpy (menu
+ i
, " = ");
6294 /* Add as much of string as fits. */
6295 thiswidth
= XSTRING (s
)->size
;
6296 if (thiswidth
+ i
> width
)
6297 thiswidth
= width
- i
;
6298 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
6304 /* If this element does not fit, end the line now,
6305 and save the element for the next line. */
6306 strcpy (menu
+ i
, "...");
6311 /* Move past this element. */
6312 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
6313 /* Handle reaching end of dense table. */
6318 rest
= Fcdr_safe (rest
);
6322 /* Prompt with that and read response. */
6323 message2_nolog (menu
, strlen (menu
),
6324 ! NILP (current_buffer
->enable_multibyte_characters
));
6326 /* Make believe its not a keyboard macro in case the help char
6327 is pressed. Help characters are not recorded because menu prompting
6328 is not used on replay.
6330 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
6331 current_kboard
->defining_kbd_macro
= Qnil
;
6333 obj
= read_char (commandflag
, 0, 0, Qnil
, 0);
6334 while (BUFFERP (obj
));
6335 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
6337 if (!INTEGERP (obj
))
6342 if (! EQ (obj
, menu_prompt_more_char
)
6343 && (!INTEGERP (menu_prompt_more_char
)
6344 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
6346 if (!NILP (current_kboard
->defining_kbd_macro
))
6347 store_kbd_macro_char (obj
);
6350 /* Help char - go round again */
6354 /* Reading key sequences. */
6356 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
6357 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
6358 keymap, or nil otherwise. Return the index of the first keymap in
6359 which KEY has any binding, or NMAPS if no map has a binding.
6361 If KEY is a meta ASCII character, treat it like meta-prefix-char
6362 followed by the corresponding non-meta character. Keymaps in
6363 CURRENT with non-prefix bindings for meta-prefix-char become nil in
6366 If KEY has no bindings in any of the CURRENT maps, NEXT is left
6369 NEXT may be the same array as CURRENT. */
6372 follow_key (key
, nmaps
, current
, defs
, next
)
6374 Lisp_Object
*current
, *defs
, *next
;
6377 int i
, first_binding
;
6380 /* If KEY is a meta ASCII character, treat it like meta-prefix-char
6381 followed by the corresponding non-meta character.
6382 Put the results into DEFS, since we are going to alter that anyway.
6383 Do not alter CURRENT or NEXT. */
6384 if (INTEGERP (key
) && (XINT (key
) & CHAR_META
))
6386 for (i
= 0; i
< nmaps
; i
++)
6387 if (! NILP (current
[i
]))
6390 def
= get_keyelt (access_keymap (current
[i
],
6391 meta_prefix_char
, 1, 0), 0);
6393 /* Note that since we pass the resulting bindings through
6394 get_keymap_1, non-prefix bindings for meta-prefix-char
6396 defs
[i
] = get_keymap_1 (def
, 0, 1);
6402 XSETINT (key
, XFASTINT (key
) & ~CHAR_META
);
6405 first_binding
= nmaps
;
6406 for (i
= nmaps
- 1; i
>= 0; i
--)
6408 if (! NILP (current
[i
]))
6416 defs
[i
] = get_keyelt (access_keymap (map
, key
, 1, 0), 0);
6417 if (! NILP (defs
[i
]))
6424 /* Given the set of bindings we've found, produce the next set of maps. */
6425 if (first_binding
< nmaps
)
6426 for (i
= 0; i
< nmaps
; i
++)
6427 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap_1 (defs
[i
], 0, 1);
6429 return first_binding
;
6432 /* Read a sequence of keys that ends with a non prefix character,
6433 storing it in KEYBUF, a buffer of size BUFSIZE.
6435 Return the length of the key sequence stored.
6436 Return -1 if the user rejected a command menu.
6438 Echo starting immediately unless `prompt' is 0.
6440 Where a key sequence ends depends on the currently active keymaps.
6441 These include any minor mode keymaps active in the current buffer,
6442 the current buffer's local map, and the global map.
6444 If a key sequence has no other bindings, we check Vfunction_key_map
6445 to see if some trailing subsequence might be the beginning of a
6446 function key's sequence. If so, we try to read the whole function
6447 key, and substitute its symbolic name into the key sequence.
6449 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
6450 `double-' events into similar click events, if that would make them
6451 bound. We try to turn `triple-' events first into `double-' events,
6454 If we get a mouse click in a mode line, vertical divider, or other
6455 non-text area, we treat the click as if it were prefixed by the
6456 symbol denoting that area - `mode-line', `vertical-line', or
6459 If the sequence starts with a mouse click, we read the key sequence
6460 with respect to the buffer clicked on, not the current buffer.
6462 If the user switches frames in the midst of a key sequence, we put
6463 off the switch-frame event until later; the next call to
6464 read_char will return it.
6466 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
6467 from the selected window's buffer. */
6470 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
6471 can_return_switch_frame
, fix_current_buffer
)
6472 Lisp_Object
*keybuf
;
6475 int dont_downcase_last
;
6476 int can_return_switch_frame
;
6477 int fix_current_buffer
;
6479 int count
= specpdl_ptr
- specpdl
;
6481 /* How many keys there are in the current key sequence. */
6484 /* The length of the echo buffer when we started reading, and
6485 the length of this_command_keys when we started reading. */
6489 /* The number of keymaps we're scanning right now, and the number of
6490 keymaps we have allocated space for. */
6492 int nmaps_allocated
= 0;
6494 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
6495 the current keymaps. */
6498 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6499 in the current keymaps, or nil where it is not a prefix. */
6500 Lisp_Object
*submaps
;
6502 /* The local map to start out with at start of key sequence. */
6503 Lisp_Object orig_local_map
;
6505 /* 1 if we have already considered switching to the local-map property
6506 of the place where a mouse click occurred. */
6507 int localized_local_map
= 0;
6509 /* The index in defs[] of the first keymap that has a binding for
6510 this key sequence. In other words, the lowest i such that
6511 defs[i] is non-nil. */
6514 /* If t < mock_input, then KEYBUF[t] should be read as the next
6517 We use this to recover after recognizing a function key. Once we
6518 realize that a suffix of the current key sequence is actually a
6519 function key's escape sequence, we replace the suffix with the
6520 function key's binding from Vfunction_key_map. Now keybuf
6521 contains a new and different key sequence, so the echo area,
6522 this_command_keys, and the submaps and defs arrays are wrong. In
6523 this situation, we set mock_input to t, set t to 0, and jump to
6524 restart_sequence; the loop will read keys from keybuf up until
6525 mock_input, thus rebuilding the state; and then it will resume
6526 reading characters from the keyboard. */
6529 /* If the sequence is unbound in submaps[], then
6530 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
6531 and fkey_map is its binding.
6533 These might be > t, indicating that all function key scanning
6534 should hold off until t reaches them. We do this when we've just
6535 recognized a function key, to avoid searching for the function
6536 key's again in Vfunction_key_map. */
6537 int fkey_start
= 0, fkey_end
= 0;
6538 Lisp_Object fkey_map
;
6540 /* Likewise, for key_translation_map. */
6541 int keytran_start
= 0, keytran_end
= 0;
6542 Lisp_Object keytran_map
;
6544 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
6545 we put it off for later. While we're reading, we keep the event here. */
6546 Lisp_Object delayed_switch_frame
;
6548 /* See the comment below... */
6549 #if defined (GOBBLE_FIRST_EVENT)
6550 Lisp_Object first_event
;
6553 Lisp_Object original_uppercase
;
6554 int original_uppercase_position
= -1;
6556 /* Gets around Microsoft compiler limitations. */
6559 struct buffer
*starting_buffer
;
6561 /* Nonzero if we seem to have got the beginning of a binding
6562 in function_key_map. */
6563 int function_key_possible
= 0;
6564 int key_translation_possible
= 0;
6566 /* Save the status of key translation before each step,
6567 so that we can restore this after downcasing. */
6568 Lisp_Object prev_fkey_map
;
6569 int prev_fkey_start
;
6572 Lisp_Object prev_keytran_map
;
6573 int prev_keytran_start
;
6574 int prev_keytran_end
;
6578 last_nonmenu_event
= Qnil
;
6580 delayed_switch_frame
= Qnil
;
6581 fkey_map
= Vfunction_key_map
;
6582 keytran_map
= Vkey_translation_map
;
6584 /* If there is no function-key-map, turn off function key scanning. */
6585 if (NILP (Fkeymapp (Vfunction_key_map
)))
6586 fkey_start
= fkey_end
= bufsize
+ 1;
6588 /* If there is no key-translation-map, turn off scanning. */
6589 if (NILP (Fkeymapp (Vkey_translation_map
)))
6590 keytran_start
= keytran_end
= bufsize
+ 1;
6595 echo_prompt (XSTRING (prompt
)->data
);
6596 else if (cursor_in_echo_area
&& echo_keystrokes
)
6597 /* This doesn't put in a dash if the echo buffer is empty, so
6598 you don't always see a dash hanging out in the minibuffer. */
6602 /* Record the initial state of the echo area and this_command_keys;
6603 we will need to restore them if we replay a key sequence. */
6605 echo_start
= echo_length ();
6606 keys_start
= this_command_key_count
;
6607 this_single_command_key_start
= keys_start
;
6609 #if defined (GOBBLE_FIRST_EVENT)
6610 /* This doesn't quite work, because some of the things that read_char
6611 does cannot safely be bypassed. It seems too risky to try to make
6614 /* Read the first char of the sequence specially, before setting
6615 up any keymaps, in case a filter runs and switches buffers on us. */
6616 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
6618 #endif /* GOBBLE_FIRST_EVENT */
6620 orig_local_map
= get_local_map (PT
, current_buffer
);
6622 /* We jump here when the key sequence has been thoroughly changed, and
6623 we need to rescan it starting from the beginning. When we jump here,
6624 keybuf[0..mock_input] holds the sequence we should reread. */
6627 starting_buffer
= current_buffer
;
6628 function_key_possible
= 0;
6629 key_translation_possible
= 0;
6631 /* Build our list of keymaps.
6632 If we recognize a function key and replace its escape sequence in
6633 keybuf with its symbol, or if the sequence starts with a mouse
6634 click and we need to switch buffers, we jump back here to rebuild
6635 the initial keymaps from the current buffer. */
6639 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
6640 || !NILP (Voverriding_local_map
))
6642 if (3 > nmaps_allocated
)
6644 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
6645 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
6646 nmaps_allocated
= 3;
6649 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6650 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6651 if (!NILP (Voverriding_local_map
))
6652 submaps
[nmaps
++] = Voverriding_local_map
;
6656 nmaps
= current_minor_maps (0, &maps
);
6657 if (nmaps
+ 2 > nmaps_allocated
)
6659 submaps
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (submaps
[0]));
6660 defs
= (Lisp_Object
*) alloca ((nmaps
+2) * sizeof (defs
[0]));
6661 nmaps_allocated
= nmaps
+ 2;
6663 bcopy (maps
, submaps
, nmaps
* sizeof (submaps
[0]));
6664 #ifdef USE_TEXT_PROPERTIES
6665 submaps
[nmaps
++] = orig_local_map
;
6667 submaps
[nmaps
++] = current_buffer
->keymap
;
6670 submaps
[nmaps
++] = current_global_map
;
6673 /* Find an accurate initial value for first_binding. */
6674 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
6675 if (! NILP (submaps
[first_binding
]))
6678 /* Start from the beginning in keybuf. */
6681 /* These are no-ops the first time through, but if we restart, they
6682 revert the echo area and this_command_keys to their original state. */
6683 this_command_key_count
= keys_start
;
6684 if (INTERACTIVE
&& t
< mock_input
)
6685 echo_truncate (echo_start
);
6687 /* If the best binding for the current key sequence is a keymap, or
6688 we may be looking at a function key's escape sequence, keep on
6690 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
6691 || (first_binding
>= nmaps
6693 /* mock input is never part of a function key's sequence. */
6694 && mock_input
<= fkey_start
)
6695 || (first_binding
>= nmaps
6696 && keytran_start
< t
&& key_translation_possible
)
6697 /* Don't return in the middle of a possible function key sequence,
6698 if the only bindings we found were via case conversion.
6699 Thus, if ESC O a has a function-key-map translation
6700 and ESC o has a binding, don't return after ESC O,
6701 so that we can translate ESC O plus the next character. */
6705 int used_mouse_menu
= 0;
6707 /* Where the last real key started. If we need to throw away a
6708 key that has expanded into more than one element of keybuf
6709 (say, a mouse click on the mode line which is being treated
6710 as [mode-line (mouse-...)], then we backtrack to this point
6712 int last_real_key_start
;
6714 /* These variables are analogous to echo_start and keys_start;
6715 while those allow us to restart the entire key sequence,
6716 echo_local_start and keys_local_start allow us to throw away
6718 int echo_local_start
, keys_local_start
, local_first_binding
;
6721 error ("Key sequence too long");
6724 echo_local_start
= echo_length ();
6725 keys_local_start
= this_command_key_count
;
6726 local_first_binding
= first_binding
;
6729 /* These are no-ops, unless we throw away a keystroke below and
6730 jumped back up to replay_key; in that case, these restore the
6731 variables to their original state, allowing us to replay the
6733 if (INTERACTIVE
&& t
< mock_input
)
6734 echo_truncate (echo_local_start
);
6735 this_command_key_count
= keys_local_start
;
6736 first_binding
= local_first_binding
;
6738 /* By default, assume each event is "real". */
6739 last_real_key_start
= t
;
6741 /* Does mock_input indicate that we are re-reading a key sequence? */
6745 add_command_key (key
);
6746 if (echo_keystrokes
)
6750 /* If not, we should actually read a character. */
6753 struct buffer
*buf
= current_buffer
;
6757 KBOARD
*interrupted_kboard
= current_kboard
;
6758 struct frame
*interrupted_frame
= selected_frame
;
6759 if (setjmp (wrong_kboard_jmpbuf
))
6761 if (!NILP (delayed_switch_frame
))
6763 interrupted_kboard
->kbd_queue
6764 = Fcons (delayed_switch_frame
,
6765 interrupted_kboard
->kbd_queue
);
6766 delayed_switch_frame
= Qnil
;
6769 interrupted_kboard
->kbd_queue
6770 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
6772 /* If the side queue is non-empty, ensure it begins with a
6773 switch-frame, so we'll replay it in the right context. */
6774 if (CONSP (interrupted_kboard
->kbd_queue
)
6775 && (key
= XCONS (interrupted_kboard
->kbd_queue
)->car
,
6776 !(EVENT_HAS_PARAMETERS (key
)
6777 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
6781 XSETFRAME (frame
, interrupted_frame
);
6782 interrupted_kboard
->kbd_queue
6783 = Fcons (make_lispy_switch_frame (frame
),
6784 interrupted_kboard
->kbd_queue
);
6787 orig_local_map
= get_local_map (PT
, current_buffer
);
6788 goto replay_sequence
;
6791 key
= read_char (NILP (prompt
), nmaps
, submaps
, last_nonmenu_event
,
6795 /* read_char returns t when it shows a menu and the user rejects it.
6800 /* read_char returns -1 at the end of a macro.
6801 Emacs 18 handles this by returning immediately with a
6802 zero, so that's what we'll do. */
6803 if (INTEGERP (key
) && XINT (key
) == -1)
6806 /* The Microsoft C compiler can't handle the goto that
6812 /* If the current buffer has been changed from under us, the
6813 keymap may have changed, so replay the sequence. */
6817 /* Reset the current buffer from the selected window
6818 in case something changed the former and not the latter.
6819 This is to be more consistent with the behavior
6820 of the command_loop_1. */
6821 if (fix_current_buffer
)
6822 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
6823 Fset_buffer (XWINDOW (selected_window
)->buffer
);
6825 orig_local_map
= get_local_map (PT
, current_buffer
);
6826 goto replay_sequence
;
6829 /* If we have a quit that was typed in another frame, and
6830 quit_throw_to_read_char switched buffers,
6831 replay to get the right keymap. */
6832 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
6837 orig_local_map
= get_local_map (PT
, current_buffer
);
6838 goto replay_sequence
;
6844 /* Clicks in non-text areas get prefixed by the symbol
6845 in their CHAR-ADDRESS field. For example, a click on
6846 the mode line is prefixed by the symbol `mode-line'.
6848 Furthermore, key sequences beginning with mouse clicks
6849 are read using the keymaps of the buffer clicked on, not
6850 the current buffer. So we may have to switch the buffer
6853 When we turn one event into two events, we must make sure
6854 that neither of the two looks like the original--so that,
6855 if we replay the events, they won't be expanded again.
6856 If not for this, such reexpansion could happen either here
6857 or when user programs play with this-command-keys. */
6858 if (EVENT_HAS_PARAMETERS (key
))
6862 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
6863 if (EQ (kind
, Qmouse_click
))
6865 Lisp_Object window
, posn
;
6867 window
= POSN_WINDOW (EVENT_START (key
));
6868 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6871 /* We're looking at the second event of a
6872 sequence which we expanded before. Set
6873 last_real_key_start appropriately. */
6875 last_real_key_start
= t
- 1;
6878 /* Key sequences beginning with mouse clicks are
6879 read using the keymaps in the buffer clicked on,
6880 not the current buffer. If we're at the
6881 beginning of a key sequence, switch buffers. */
6882 if (last_real_key_start
== 0
6884 && BUFFERP (XWINDOW (window
)->buffer
)
6885 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
6890 /* Arrange to go back to the original buffer once we're
6891 done reading the key sequence. Note that we can't
6892 use save_excursion_{save,restore} here, because they
6893 save point as well as the current buffer; we don't
6894 want to save point, because redisplay may change it,
6895 to accommodate a Fset_window_start or something. We
6896 don't want to do this at the top of the function,
6897 because we may get input from a subprocess which
6898 wants to change the selected window and stuff (say,
6900 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
6902 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
6903 orig_local_map
= get_local_map (PT
, current_buffer
);
6904 goto replay_sequence
;
6906 /* For a mouse click, get the local text-property keymap
6907 of the place clicked on, rather than point. */
6908 if (last_real_key_start
== 0 && CONSP (XCONS (key
)->cdr
)
6909 && ! localized_local_map
)
6911 Lisp_Object map_here
, start
, pos
;
6913 localized_local_map
= 1;
6914 start
= EVENT_START (key
);
6915 if (CONSP (start
) && CONSP (XCONS (start
)->cdr
))
6917 pos
= POSN_BUFFER_POSN (start
);
6919 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
6921 map_here
= get_local_map (XINT (pos
), current_buffer
);
6922 if (!EQ (map_here
, orig_local_map
))
6924 orig_local_map
= map_here
;
6928 goto replay_sequence
;
6934 /* Expand mode-line and scroll-bar events into two events:
6935 use posn as a fake prefix key. */
6938 if (t
+ 1 >= bufsize
)
6939 error ("Key sequence too long");
6944 /* Zap the position in key, so we know that we've
6945 expanded it, and don't try to do so again. */
6946 POSN_BUFFER_POSN (EVENT_START (key
))
6947 = Fcons (posn
, Qnil
);
6951 else if (EQ (kind
, Qswitch_frame
))
6953 /* If we're at the beginning of a key sequence, and the caller
6954 says it's okay, go ahead and return this event. If we're
6955 in the midst of a key sequence, delay it until the end. */
6956 if (t
> 0 || !can_return_switch_frame
)
6958 delayed_switch_frame
= key
;
6962 else if (CONSP (XCONS (key
)->cdr
)
6963 && CONSP (EVENT_START (key
))
6964 && CONSP (XCONS (EVENT_START (key
))->cdr
))
6968 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
6969 /* Handle menu-bar events:
6970 insert the dummy prefix event `menu-bar'. */
6971 if (EQ (posn
, Qmenu_bar
))
6973 if (t
+ 1 >= bufsize
)
6974 error ("Key sequence too long");
6978 /* Zap the position in key, so we know that we've
6979 expanded it, and don't try to do so again. */
6980 POSN_BUFFER_POSN (EVENT_START (key
))
6981 = Fcons (posn
, Qnil
);
6984 goto replay_sequence
;
6986 else if (CONSP (posn
))
6988 /* We're looking at the second event of a
6989 sequence which we expanded before. Set
6990 last_real_key_start appropriately. */
6991 if (last_real_key_start
== t
&& t
> 0)
6992 last_real_key_start
= t
- 1;
6997 /* We have finally decided that KEY is something we might want
6999 first_binding
= (follow_key (key
,
7000 nmaps
- first_binding
,
7001 submaps
+ first_binding
,
7002 defs
+ first_binding
,
7003 submaps
+ first_binding
)
7006 /* If KEY wasn't bound, we'll try some fallbacks. */
7007 if (first_binding
>= nmaps
)
7011 head
= EVENT_HEAD (key
);
7012 if (help_char_p (head
) && t
> 0)
7014 read_key_sequence_cmd
= Vprefix_help_command
;
7016 last_nonmenu_event
= key
;
7017 /* The Microsoft C compiler can't handle the goto that
7025 Lisp_Object breakdown
;
7028 breakdown
= parse_modifiers (head
);
7029 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7030 /* Attempt to reduce an unbound mouse event to a simpler
7031 event that is bound:
7032 Drags reduce to clicks.
7033 Double-clicks reduce to clicks.
7034 Triple-clicks reduce to double-clicks, then to clicks.
7035 Down-clicks are eliminated.
7036 Double-downs reduce to downs, then are eliminated.
7037 Triple-downs reduce to double-downs, then to downs,
7038 then are eliminated. */
7039 if (modifiers
& (down_modifier
| drag_modifier
7040 | double_modifier
| triple_modifier
))
7042 while (modifiers
& (down_modifier
| drag_modifier
7043 | double_modifier
| triple_modifier
))
7045 Lisp_Object new_head
, new_click
;
7046 if (modifiers
& triple_modifier
)
7047 modifiers
^= (double_modifier
| triple_modifier
);
7048 else if (modifiers
& double_modifier
)
7049 modifiers
&= ~double_modifier
;
7050 else if (modifiers
& drag_modifier
)
7051 modifiers
&= ~drag_modifier
;
7054 /* Dispose of this `down' event by simply jumping
7055 back to replay_key, to get another event.
7057 Note that if this event came from mock input,
7058 then just jumping back to replay_key will just
7059 hand it to us again. So we have to wipe out any
7062 We could delete keybuf[t] and shift everything
7063 after that to the left by one spot, but we'd also
7064 have to fix up any variable that points into
7065 keybuf, and shifting isn't really necessary
7068 Adding prefixes for non-textual mouse clicks
7069 creates two characters of mock input, and both
7070 must be thrown away. If we're only looking at
7071 the prefix now, we can just jump back to
7072 replay_key. On the other hand, if we've already
7073 processed the prefix, and now the actual click
7074 itself is giving us trouble, then we've lost the
7075 state of the keymaps we want to backtrack to, and
7076 we need to replay the whole sequence to rebuild
7079 Beyond that, only function key expansion could
7080 create more than two keys, but that should never
7081 generate mouse events, so it's okay to zero
7082 mock_input in that case too.
7084 Isn't this just the most wonderful code ever? */
7085 if (t
== last_real_key_start
)
7092 mock_input
= last_real_key_start
;
7093 goto replay_sequence
;
7098 = apply_modifiers (modifiers
, XCONS (breakdown
)->car
);
7100 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
7102 /* Look for a binding for this new key. follow_key
7103 promises that it didn't munge submaps the
7104 last time we called it, since key was unbound. */
7106 = (follow_key (new_click
,
7107 nmaps
- local_first_binding
,
7108 submaps
+ local_first_binding
,
7109 defs
+ local_first_binding
,
7110 submaps
+ local_first_binding
)
7111 + local_first_binding
);
7113 /* If that click is bound, go for it. */
7114 if (first_binding
< nmaps
)
7119 /* Otherwise, we'll leave key set to the drag event. */
7126 /* Normally, last_nonmenu_event gets the previous key we read.
7127 But when a mouse popup menu is being used,
7128 we don't update last_nonmenu_event; it continues to hold the mouse
7129 event that preceded the first level of menu. */
7130 if (!used_mouse_menu
)
7131 last_nonmenu_event
= key
;
7133 /* Record what part of this_command_keys is the current key sequence. */
7134 this_single_command_key_start
= this_command_key_count
- t
;
7136 prev_fkey_map
= fkey_map
;
7137 prev_fkey_start
= fkey_start
;
7138 prev_fkey_end
= fkey_end
;
7140 prev_keytran_map
= keytran_map
;
7141 prev_keytran_start
= keytran_start
;
7142 prev_keytran_end
= keytran_end
;
7144 /* If the sequence is unbound, see if we can hang a function key
7145 off the end of it. We only want to scan real keyboard input
7146 for function key sequences, so if mock_input says that we're
7147 re-reading old events, don't examine it. */
7148 if (first_binding
>= nmaps
7151 Lisp_Object fkey_next
;
7153 /* Continue scan from fkey_end until we find a bound suffix.
7154 If we fail, increment fkey_start
7155 and start fkey_end from there. */
7156 while (fkey_end
< t
)
7160 key
= keybuf
[fkey_end
++];
7161 /* Look up meta-characters by prefixing them
7162 with meta_prefix_char. I hate this. */
7163 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7168 (access_keymap (fkey_map
, meta_prefix_char
, 1, 0), 0),
7170 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7173 fkey_next
= fkey_map
;
7176 = get_keyelt (access_keymap (fkey_next
, key
, 1, 0), 0);
7178 #if 0 /* I didn't turn this on, because it might cause trouble
7179 for the mapping of return into C-m and tab into C-i. */
7180 /* Optionally don't map function keys into other things.
7181 This enables the user to redefine kp- keys easily. */
7182 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
7186 /* If the function key map gives a function, not an
7187 array, then call the function with no args and use
7188 its value instead. */
7189 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
7192 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7196 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7197 fkey_next
= call1 (fkey_next
, prompt
);
7199 /* If the function returned something invalid,
7200 barf--don't ignore it.
7201 (To ignore it safely, we would need to gcpro a bunch of
7202 other variables.) */
7203 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
7204 error ("Function in key-translation-map returns invalid key sequence");
7207 function_key_possible
= ! NILP (fkey_next
);
7209 /* If keybuf[fkey_start..fkey_end] is bound in the
7210 function key map and it's a suffix of the current
7211 sequence (i.e. fkey_end == t), replace it with
7212 the binding and restart with fkey_start at the end. */
7213 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
7216 int len
= XFASTINT (Flength (fkey_next
));
7218 t
= fkey_start
+ len
;
7220 error ("Key sequence too long");
7222 if (VECTORP (fkey_next
))
7223 bcopy (XVECTOR (fkey_next
)->contents
,
7224 keybuf
+ fkey_start
,
7225 (t
- fkey_start
) * sizeof (keybuf
[0]));
7226 else if (STRINGP (fkey_next
))
7230 for (i
= 0; i
< len
; i
++)
7231 XSETFASTINT (keybuf
[fkey_start
+ i
],
7232 XSTRING (fkey_next
)->data
[i
]);
7236 fkey_start
= fkey_end
= t
;
7237 fkey_map
= Vfunction_key_map
;
7239 /* Do pass the results through key-translation-map. */
7240 keytran_start
= keytran_end
= 0;
7241 keytran_map
= Vkey_translation_map
;
7243 goto replay_sequence
;
7246 fkey_map
= get_keymap_1 (fkey_next
, 0, 1);
7248 /* If we no longer have a bound suffix, try a new positions for
7250 if (NILP (fkey_map
))
7252 fkey_end
= ++fkey_start
;
7253 fkey_map
= Vfunction_key_map
;
7254 function_key_possible
= 0;
7259 /* Look for this sequence in key-translation-map. */
7261 Lisp_Object keytran_next
;
7263 /* Scan from keytran_end until we find a bound suffix. */
7264 while (keytran_end
< t
)
7268 key
= keybuf
[keytran_end
++];
7269 /* Look up meta-characters by prefixing them
7270 with meta_prefix_char. I hate this. */
7271 if (INTEGERP (key
) && XINT (key
) & meta_modifier
)
7276 (access_keymap (keytran_map
, meta_prefix_char
, 1, 0), 0),
7278 XSETFASTINT (key
, XFASTINT (key
) & ~meta_modifier
);
7281 keytran_next
= keytran_map
;
7284 = get_keyelt (access_keymap (keytran_next
, key
, 1, 0), 0);
7286 /* If the key translation map gives a function, not an
7287 array, then call the function with no args and use
7288 its value instead. */
7289 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
7290 && keytran_end
== t
)
7292 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7296 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
7297 keytran_next
= call1 (keytran_next
, prompt
);
7299 /* If the function returned something invalid,
7300 barf--don't ignore it.
7301 (To ignore it safely, we would need to gcpro a bunch of
7302 other variables.) */
7303 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
7304 error ("Function in key-translation-map returns invalid key sequence");
7307 key_translation_possible
= ! NILP (keytran_next
);
7309 /* If keybuf[keytran_start..keytran_end] is bound in the
7310 key translation map and it's a suffix of the current
7311 sequence (i.e. keytran_end == t), replace it with
7312 the binding and restart with keytran_start at the end. */
7313 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
7314 && keytran_end
== t
)
7316 int len
= XFASTINT (Flength (keytran_next
));
7318 t
= keytran_start
+ len
;
7320 error ("Key sequence too long");
7322 if (VECTORP (keytran_next
))
7323 bcopy (XVECTOR (keytran_next
)->contents
,
7324 keybuf
+ keytran_start
,
7325 (t
- keytran_start
) * sizeof (keybuf
[0]));
7326 else if (STRINGP (keytran_next
))
7330 for (i
= 0; i
< len
; i
++)
7331 XSETFASTINT (keybuf
[keytran_start
+ i
],
7332 XSTRING (keytran_next
)->data
[i
]);
7336 keytran_start
= keytran_end
= t
;
7337 keytran_map
= Vkey_translation_map
;
7339 /* Don't pass the results of key-translation-map
7340 through function-key-map. */
7341 fkey_start
= fkey_end
= t
;
7342 fkey_map
= Vkey_translation_map
;
7344 goto replay_sequence
;
7347 keytran_map
= get_keymap_1 (keytran_next
, 0, 1);
7349 /* If we no longer have a bound suffix, try a new positions for
7351 if (NILP (keytran_map
))
7353 keytran_end
= ++keytran_start
;
7354 keytran_map
= Vkey_translation_map
;
7355 key_translation_possible
= 0;
7360 /* If KEY is not defined in any of the keymaps,
7361 and cannot be part of a function key or translation,
7362 and is an upper case letter
7363 use the corresponding lower-case letter instead. */
7364 if (first_binding
== nmaps
&& ! function_key_possible
7365 && ! key_translation_possible
7367 && ((((XINT (key
) & 0x3ffff)
7368 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
7369 && UPPERCASEP (XINT (key
) & 0x3ffff))
7370 || (XINT (key
) & shift_modifier
)))
7372 Lisp_Object new_key
;
7374 original_uppercase
= key
;
7375 original_uppercase_position
= t
- 1;
7377 if (XINT (key
) & shift_modifier
)
7378 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
7380 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
7381 | (XINT (key
) & ~0x3ffff)));
7383 /* We have to do this unconditionally, regardless of whether
7384 the lower-case char is defined in the keymaps, because they
7385 might get translated through function-key-map. */
7386 keybuf
[t
- 1] = new_key
;
7389 fkey_map
= prev_fkey_map
;
7390 fkey_start
= prev_fkey_start
;
7391 fkey_end
= prev_fkey_end
;
7393 keytran_map
= prev_keytran_map
;
7394 keytran_start
= prev_keytran_start
;
7395 keytran_end
= prev_keytran_end
;
7397 goto replay_sequence
;
7399 /* If KEY is not defined in any of the keymaps,
7400 and cannot be part of a function key or translation,
7401 and is a shifted function key,
7402 use the corresponding unshifted function key instead. */
7403 if (first_binding
== nmaps
&& ! function_key_possible
7404 && ! key_translation_possible
7407 Lisp_Object breakdown
;
7410 breakdown
= parse_modifiers (key
);
7411 modifiers
= XINT (XCONS (XCONS (breakdown
)->cdr
)->car
);
7412 if (modifiers
& shift_modifier
)
7414 Lisp_Object new_key
;
7416 original_uppercase
= key
;
7417 original_uppercase_position
= t
- 1;
7419 modifiers
&= ~shift_modifier
;
7420 new_key
= apply_modifiers (modifiers
,
7421 XCONS (breakdown
)->car
);
7423 keybuf
[t
- 1] = new_key
;
7426 fkey_map
= prev_fkey_map
;
7427 fkey_start
= prev_fkey_start
;
7428 fkey_end
= prev_fkey_end
;
7430 keytran_map
= prev_keytran_map
;
7431 keytran_start
= prev_keytran_start
;
7432 keytran_end
= prev_keytran_end
;
7434 goto replay_sequence
;
7440 read_key_sequence_cmd
= (first_binding
< nmaps
7441 ? defs
[first_binding
]
7444 unread_switch_frame
= delayed_switch_frame
;
7445 unbind_to (count
, Qnil
);
7447 /* Don't downcase the last character if the caller says don't.
7448 Don't downcase it if the result is undefined, either. */
7449 if ((dont_downcase_last
|| first_binding
>= nmaps
)
7450 && t
- 1 == original_uppercase_position
)
7451 keybuf
[t
- 1] = original_uppercase
;
7453 /* Occasionally we fabricate events, perhaps by expanding something
7454 according to function-key-map, or by adding a prefix symbol to a
7455 mouse click in the scroll bar or modeline. In this cases, return
7456 the entire generated key sequence, even if we hit an unbound
7457 prefix or a definition before the end. This means that you will
7458 be able to push back the event properly, and also means that
7459 read-key-sequence will always return a logical unit.
7462 for (; t
< mock_input
; t
++)
7464 if (echo_keystrokes
)
7465 echo_char (keybuf
[t
]);
7466 add_command_key (keybuf
[t
]);
7472 #if 0 /* This doc string is too long for some compilers.
7473 This commented-out definition serves for DOC. */
7474 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7475 "Read a sequence of keystrokes and return as a string or vector.\n\
7476 The sequence is sufficient to specify a non-prefix command in the\n\
7477 current local and global maps.\n\
7479 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
7480 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
7481 as a continuation of the previous key.\n\
7483 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
7484 convert the last event to lower case. (Normally any upper case event\n\
7485 is converted to lower case if the original event is undefined and the lower\n\
7486 case equivalent is defined.) A non-nil value is appropriate for reading\n\
7487 a key sequence to be defined.\n\
7489 A C-g typed while in this function is treated like any other character,\n\
7490 and `quit-flag' is not set.\n\
7492 If the key sequence starts with a mouse click, then the sequence is read\n\
7493 using the keymaps of the buffer of the window clicked in, not the buffer\n\
7494 of the selected window as normal.\n\
7496 `read-key-sequence' drops unbound button-down events, since you normally\n\
7497 only care about the click or drag events which follow them. If a drag\n\
7498 or multi-click event is unbound, but the corresponding click event would\n\
7499 be bound, `read-key-sequence' turns the event into a click event at the\n\
7500 drag's starting position. This means that you don't have to distinguish\n\
7501 between click and drag, double, or triple events unless you want to.\n\
7503 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
7504 lines separating windows, and scroll bars with imaginary keys\n\
7505 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
7507 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
7508 function will process a switch-frame event if the user switches frames\n\
7509 before typing anything. If the user switches frames in the middle of a\n\
7510 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
7511 is nil, then the event will be put off until after the current key sequence.\n\
7513 `read-key-sequence' checks `function-key-map' for function key\n\
7514 sequences, where they wouldn't conflict with ordinary bindings. See\n\
7515 `function-key-map' for more details.")
7516 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7519 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
7521 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7522 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7523 Lisp_Object can_return_switch_frame
;
7525 Lisp_Object keybuf
[30];
7527 struct gcpro gcpro1
, gcpro2
;
7530 CHECK_STRING (prompt
, 0);
7533 bzero (keybuf
, sizeof keybuf
);
7535 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7537 if (NILP (continue_echo
))
7539 this_command_key_count
= 0;
7540 this_single_command_key_start
= 0;
7543 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7544 prompt
, ! NILP (dont_downcase_last
),
7545 ! NILP (can_return_switch_frame
), 0);
7553 return make_event_array (i
, keybuf
);
7556 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
7557 Sread_key_sequence_vector
, 1, 4, 0,
7558 "Like `read-key-sequence' but always return a vector.")
7559 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
)
7560 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
7561 Lisp_Object can_return_switch_frame
;
7563 Lisp_Object keybuf
[30];
7565 struct gcpro gcpro1
, gcpro2
;
7568 CHECK_STRING (prompt
, 0);
7571 bzero (keybuf
, sizeof keybuf
);
7573 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
7575 if (NILP (continue_echo
))
7577 this_command_key_count
= 0;
7578 this_single_command_key_start
= 0;
7581 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
7582 prompt
, ! NILP (dont_downcase_last
),
7583 ! NILP (can_return_switch_frame
), 0);
7591 return Fvector (i
, keybuf
);
7594 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
7595 "Execute CMD as an editor command.\n\
7596 CMD must be a symbol that satisfies the `commandp' predicate.\n\
7597 Optional second arg RECORD-FLAG non-nil\n\
7598 means unconditionally put this command in `command-history'.\n\
7599 Otherwise, that is done only if an arg is read using the minibuffer.\n\
7600 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
7601 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
7602 The argument SPECIAL, if non-nil, means that this command is executing\n\
7603 a special event, so ignore the prefix argument and don't clear it.")
7604 (cmd
, record_flag
, keys
, special
)
7605 Lisp_Object cmd
, record_flag
, keys
, special
;
7607 register Lisp_Object final
;
7608 register Lisp_Object tem
;
7609 Lisp_Object prefixarg
;
7610 struct backtrace backtrace
;
7611 extern int debug_on_next_call
;
7613 debug_on_next_call
= 0;
7617 prefixarg
= current_kboard
->Vprefix_arg
;
7618 Vcurrent_prefix_arg
= prefixarg
;
7619 current_kboard
->Vprefix_arg
= Qnil
;
7626 tem
= Fget (cmd
, Qdisabled
);
7627 if (!NILP (tem
) && !NILP (Vrun_hooks
))
7629 tem
= Fsymbol_value (Qdisabled_command_hook
);
7631 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
7637 final
= Findirect_function (cmd
);
7639 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
7641 struct gcpro gcpro1
, gcpro2
;
7643 GCPRO2 (cmd
, prefixarg
);
7644 do_autoload (final
, cmd
);
7651 if (STRINGP (final
) || VECTORP (final
))
7653 /* If requested, place the macro in the command history. For
7654 other sorts of commands, call-interactively takes care of
7656 if (!NILP (record_flag
))
7659 = Fcons (Fcons (Qexecute_kbd_macro
,
7660 Fcons (final
, Fcons (prefixarg
, Qnil
))),
7663 /* Don't keep command history around forever. */
7664 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
7666 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
7668 XCONS (tem
)->cdr
= Qnil
;
7672 return Fexecute_kbd_macro (final
, prefixarg
);
7675 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
7677 backtrace
.next
= backtrace_list
;
7678 backtrace_list
= &backtrace
;
7679 backtrace
.function
= &Qcall_interactively
;
7680 backtrace
.args
= &cmd
;
7681 backtrace
.nargs
= 1;
7682 backtrace
.evalargs
= 0;
7684 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
7686 backtrace_list
= backtrace
.next
;
7692 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
7694 "Read function name, then read its arguments and call it.")
7696 Lisp_Object prefixarg
;
7698 Lisp_Object function
;
7700 Lisp_Object saved_keys
;
7701 Lisp_Object bindings
, value
;
7702 struct gcpro gcpro1
, gcpro2
;
7704 saved_keys
= Fvector (this_command_key_count
,
7705 XVECTOR (this_command_keys
)->contents
);
7707 GCPRO2 (saved_keys
, prefixarg
);
7709 if (EQ (prefixarg
, Qminus
))
7711 else if (CONSP (prefixarg
) && XINT (XCONS (prefixarg
)->car
) == 4)
7712 strcpy (buf
, "C-u ");
7713 else if (CONSP (prefixarg
) && INTEGERP (XCONS (prefixarg
)->car
))
7715 if (sizeof (int) == sizeof (EMACS_INT
))
7716 sprintf (buf
, "%d ", XINT (XCONS (prefixarg
)->car
));
7717 else if (sizeof (long) == sizeof (EMACS_INT
))
7718 sprintf (buf
, "%ld ", XINT (XCONS (prefixarg
)->car
));
7722 else if (INTEGERP (prefixarg
))
7724 if (sizeof (int) == sizeof (EMACS_INT
))
7725 sprintf (buf
, "%d ", XINT (prefixarg
));
7726 else if (sizeof (long) == sizeof (EMACS_INT
))
7727 sprintf (buf
, "%ld ", XINT (prefixarg
));
7732 /* This isn't strictly correct if execute-extended-command
7733 is bound to anything else. Perhaps it should use
7734 this_command_keys? */
7735 strcat (buf
, "M-x ");
7737 /* Prompt with buf, and then read a string, completing from and
7738 restricting to the set of all defined commands. Don't provide
7739 any initial input. Save the command read on the extended-command
7741 function
= Fcompleting_read (build_string (buf
),
7742 Vobarray
, Qcommandp
,
7743 Qt
, Qnil
, Qextended_command_history
, Qnil
,
7746 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
7747 error ("No command name given");
7749 /* Set this_command_keys to the concatenation of saved_keys and
7750 function, followed by a RET. */
7752 struct Lisp_String
*str
;
7756 this_command_key_count
= 0;
7757 this_single_command_key_start
= 0;
7759 keys
= XVECTOR (saved_keys
)->contents
;
7760 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
7761 add_command_key (keys
[i
]);
7763 str
= XSTRING (function
);
7764 for (i
= 0; i
< str
->size
; i
++)
7765 add_command_key (Faref (function
, make_number (i
)));
7767 add_command_key (make_number ('\015'));
7772 function
= Fintern (function
, Qnil
);
7773 current_kboard
->Vprefix_arg
= prefixarg
;
7774 this_command
= function
;
7776 /* If enabled, show which key runs this command. */
7777 if (!NILP (Vsuggest_key_bindings
)
7778 && NILP (Vexecuting_macro
)
7779 && SYMBOLP (function
))
7780 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
7786 GCPRO2 (bindings
, value
);
7787 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
7789 /* If the command has a key binding, print it now. */
7790 if (!NILP (bindings
)
7791 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
7794 /* But first wait, and skip the message if there is input. */
7795 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7796 ? Vsuggest_key_bindings
: make_number (2)),
7798 && ! CONSP (Vunread_command_events
))
7800 Lisp_Object binding
;
7802 char *oldmessage
= echo_area_glyphs
;
7803 int oldmessage_len
= echo_area_glyphs_length
;
7804 int oldmultibyte
= message_enable_multibyte
;
7806 binding
= Fkey_description (bindings
);
7809 = (char *) alloca (XSYMBOL (function
)->name
->size
7810 + STRING_BYTES (XSTRING (binding
))
7812 sprintf (newmessage
, "You can run the command `%s' with %s",
7813 XSYMBOL (function
)->name
->data
,
7814 XSTRING (binding
)->data
);
7815 message2_nolog (newmessage
,
7816 strlen (newmessage
),
7817 STRING_MULTIBYTE (binding
));
7818 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
7819 ? Vsuggest_key_bindings
: make_number (2)),
7821 message2_nolog (oldmessage
, oldmessage_len
, oldmultibyte
);
7825 RETURN_UNGCPRO (value
);
7828 /* Find the set of keymaps now active.
7829 Store into *MAPS_P a vector holding the various maps
7830 and return the number of them. The vector was malloc'd
7831 and the caller should free it. */
7834 current_active_maps (maps_p
)
7835 Lisp_Object
**maps_p
;
7837 Lisp_Object
*tmaps
, *maps
;
7840 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7841 if (!NILP (Voverriding_local_map_menu_flag
))
7843 /* Yes, use them (if non-nil) as well as the global map. */
7844 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
7846 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7847 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7848 if (!NILP (Voverriding_local_map
))
7849 maps
[nmaps
++] = Voverriding_local_map
;
7853 /* No, so use major and minor mode keymaps. */
7854 nmaps
= current_minor_maps (NULL
, &tmaps
);
7855 maps
= (Lisp_Object
*) xmalloc ((nmaps
+ 2) * sizeof (maps
[0]));
7856 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7857 #ifdef USE_TEXT_PROPERTIES
7858 maps
[nmaps
++] = get_local_map (PT
, current_buffer
);
7860 maps
[nmaps
++] = current_buffer
->keymap
;
7863 maps
[nmaps
++] = current_global_map
;
7869 /* Return nonzero if input events are pending. */
7872 detect_input_pending ()
7875 get_input_pending (&input_pending
, 0);
7877 return input_pending
;
7880 /* Return nonzero if input events are pending, and run any pending timers. */
7883 detect_input_pending_run_timers (do_display
)
7886 int old_timers_run
= timers_run
;
7889 get_input_pending (&input_pending
, 1);
7891 if (old_timers_run
!= timers_run
&& do_display
)
7892 redisplay_preserve_echo_area ();
7894 return input_pending
;
7897 /* This is called in some cases before a possible quit.
7898 It cases the next call to detect_input_pending to recompute input_pending.
7899 So calling this function unnecessarily can't do any harm. */
7902 clear_input_pending ()
7907 /* Return nonzero if there are pending requeued events.
7908 This isn't used yet. The hope is to make wait_reading_process_input
7909 call it, and return return if it runs Lisp code that unreads something.
7910 The problem is, kbd_buffer_get_event needs to be fixed to know what
7911 to do in that case. It isn't trivial. */
7914 requeued_events_pending_p ()
7916 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
7920 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
7921 "T if command input is currently available with no waiting.\n\
7922 Actually, the value is nil only if we can be sure that no input is available.")
7925 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
7928 get_input_pending (&input_pending
, 1);
7929 return input_pending
> 0 ? Qt
: Qnil
;
7932 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
7933 "Return vector of last 100 events, not counting those from keyboard macros.")
7936 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
7939 if (total_keys
< NUM_RECENT_KEYS
)
7940 return Fvector (total_keys
, keys
);
7943 val
= Fvector (NUM_RECENT_KEYS
, keys
);
7944 bcopy (keys
+ recent_keys_index
,
7945 XVECTOR (val
)->contents
,
7946 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
7948 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
7949 recent_keys_index
* sizeof (Lisp_Object
));
7954 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
7955 "Return the key sequence that invoked this command.\n\
7956 The value is a string or a vector.")
7959 return make_event_array (this_command_key_count
,
7960 XVECTOR (this_command_keys
)->contents
);
7963 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
7964 "Return the key sequence that invoked this command, as a vector.")
7967 return Fvector (this_command_key_count
,
7968 XVECTOR (this_command_keys
)->contents
);
7971 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
7972 Sthis_single_command_keys
, 0, 0, 0,
7973 "Return the key sequence that invoked this command.\n\
7974 Unlike `this-command-keys', this function's value\n\
7975 does not include prefix arguments.\n\
7976 The value is always a vector.")
7979 return Fvector (this_command_key_count
7980 - this_single_command_key_start
,
7981 (XVECTOR (this_command_keys
)->contents
7982 + this_single_command_key_start
));
7985 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
7986 Sreset_this_command_lengths
, 0, 0, 0,
7987 "Used for complicated reasons in `universal-argument-other-key'.\n\
7989 `universal-argument-other-key' rereads the event just typed.\n\
7990 It then gets translated through `function-key-map'.\n\
7991 The translated event gets included in the echo area and in\n\
7992 the value of `this-command-keys' in addition to the raw original event.\n\
7993 That is not right.\n\
7995 Calling this function directs the translated event to replace\n\
7996 the original event, so that only one version of the event actually\n\
7997 appears in the echo area and in the value of `this-command-keys.'.")
8000 before_command_restore_flag
= 1;
8001 before_command_key_count_1
= before_command_key_count
;
8002 before_command_echo_length_1
= before_command_echo_length
;
8005 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
8006 "Return the current depth in recursive edits.")
8010 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
8014 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
8015 "FOpen dribble file: ",
8016 "Start writing all keyboard characters to a dribble file called FILE.\n\
8017 If FILE is nil, close any open dribble file.")
8028 file
= Fexpand_file_name (file
, Qnil
);
8029 dribble
= fopen (XSTRING (file
)->data
, "w");
8031 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
8036 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
8037 "Discard the contents of the terminal input buffer.\n\
8038 Also cancel any kbd macro being defined.")
8041 current_kboard
->defining_kbd_macro
= Qnil
;
8042 update_mode_lines
++;
8044 Vunread_command_events
= Qnil
;
8045 unread_command_char
= -1;
8047 discard_tty_input ();
8049 /* Without the cast, GCC complains that this assignment loses the
8050 volatile qualifier of kbd_store_ptr. Is there anything wrong
8052 kbd_fetch_ptr
= (struct input_event
*) kbd_store_ptr
;
8053 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8059 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
8060 "Stop Emacs and return to superior process. You can resume later.\n\
8061 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
8062 control, run a subshell instead.\n\n\
8063 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
8064 to be read as terminal input by Emacs's parent, after suspension.\n\
8066 Before suspending, run the normal hook `suspend-hook'.\n\
8067 After resumption run the normal hook `suspend-resume-hook'.\n\
8069 Some operating systems cannot stop the Emacs process and resume it later.\n\
8070 On such systems, Emacs starts a subshell instead of suspending.")
8072 Lisp_Object stuffstring
;
8075 int count
= specpdl_ptr
- specpdl
;
8076 int old_height
, old_width
;
8078 struct gcpro gcpro1
, gcpro2
;
8080 if (!NILP (stuffstring
))
8081 CHECK_STRING (stuffstring
, 0);
8083 /* Run the functions in suspend-hook. */
8084 if (!NILP (Vrun_hooks
))
8085 call1 (Vrun_hooks
, intern ("suspend-hook"));
8087 GCPRO1 (stuffstring
);
8088 get_frame_size (&old_width
, &old_height
);
8090 /* sys_suspend can get an error if it tries to fork a subshell
8091 and the system resources aren't available for that. */
8092 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
8094 stuff_buffered_input (stuffstring
);
8099 unbind_to (count
, Qnil
);
8101 /* Check if terminal/window size has changed.
8102 Note that this is not useful when we are running directly
8103 with a window system; but suspend should be disabled in that case. */
8104 get_frame_size (&width
, &height
);
8105 if (width
!= old_width
|| height
!= old_height
)
8106 change_frame_size (selected_frame
, height
, width
, 0, 0);
8108 /* Run suspend-resume-hook. */
8109 if (!NILP (Vrun_hooks
))
8110 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
8116 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
8117 Then in any case stuff anything Emacs has read ahead and not used. */
8120 stuff_buffered_input (stuffstring
)
8121 Lisp_Object stuffstring
;
8123 /* stuff_char works only in BSD, versions 4.2 and up. */
8126 register unsigned char *p
;
8128 if (STRINGP (stuffstring
))
8132 p
= XSTRING (stuffstring
)->data
;
8133 count
= STRING_BYTES (XSTRING (stuffstring
));
8138 /* Anything we have read ahead, put back for the shell to read. */
8139 /* ?? What should this do when we have multiple keyboards??
8140 Should we ignore anything that was typed in at the "wrong" kboard? */
8141 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
8143 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
8144 kbd_fetch_ptr
= kbd_buffer
;
8145 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
8146 stuff_char (kbd_fetch_ptr
->code
);
8147 kbd_fetch_ptr
->kind
= no_event
;
8148 (XVECTOR (kbd_buffer_frame_or_window
)->contents
[kbd_fetch_ptr
8154 #endif /* BSD_SYSTEM and not BSD4_1 */
8158 set_waiting_for_input (time_to_clear
)
8159 EMACS_TIME
*time_to_clear
;
8161 input_available_clear_time
= time_to_clear
;
8163 /* Tell interrupt_signal to throw back to read_char, */
8164 waiting_for_input
= 1;
8166 /* If interrupt_signal was called before and buffered a C-g,
8167 make it run again now, to avoid timing error. */
8168 if (!NILP (Vquit_flag
))
8169 quit_throw_to_read_char ();
8173 clear_waiting_for_input ()
8175 /* Tell interrupt_signal not to throw back to read_char, */
8176 waiting_for_input
= 0;
8177 input_available_clear_time
= 0;
8180 /* This routine is called at interrupt level in response to C-G.
8181 If interrupt_input, this is the handler for SIGINT.
8182 Otherwise, it is called from kbd_buffer_store_event,
8183 in handling SIGIO or SIGTINT.
8185 If `waiting_for_input' is non zero, then unless `echoing' is nonzero,
8186 immediately throw back to read_char.
8188 Otherwise it sets the Lisp variable quit-flag not-nil.
8189 This causes eval to throw, when it gets a chance.
8190 If quit-flag is already non-nil, it stops the job right away. */
8193 interrupt_signal (signalnum
) /* If we don't have an argument, */
8194 int signalnum
; /* some compilers complain in signal calls. */
8197 /* Must preserve main program's value of errno. */
8198 int old_errno
= errno
;
8200 #if defined (USG) && !defined (POSIX_SIGNALS)
8201 if (!read_socket_hook
&& NILP (Vwindow_system
))
8203 /* USG systems forget handlers when they are used;
8204 must reestablish each time */
8205 signal (SIGINT
, interrupt_signal
);
8206 signal (SIGQUIT
, interrupt_signal
);
8212 if (!NILP (Vquit_flag
)
8213 && (FRAME_TERMCAP_P (selected_frame
) || FRAME_MSDOS_P (selected_frame
)))
8215 /* If SIGINT isn't blocked, don't let us be interrupted by
8216 another SIGINT, it might be harmful due to non-reentrancy
8217 in I/O functions. */
8218 sigblock (sigmask (SIGINT
));
8223 #ifdef SIGTSTP /* Support possible in later USG versions */
8225 * On systems which can suspend the current process and return to the original
8226 * shell, this command causes the user to end up back at the shell.
8227 * The "Auto-save" and "Abort" questions are not asked until
8228 * the user elects to return to emacs, at which point he can save the current
8229 * job and either dump core or continue.
8234 if (sys_suspend () == -1)
8236 printf ("Not running as a subprocess;\n");
8237 printf ("you can continue or abort.\n");
8240 /* Perhaps should really fork an inferior shell?
8241 But that would not provide any way to get back
8242 to the original shell, ever. */
8243 printf ("No support for stopping a process on this operating system;\n");
8244 printf ("you can continue or abort.\n");
8245 #endif /* not VMS */
8246 #endif /* not SIGTSTP */
8248 /* We must remain inside the screen area when the internal terminal
8249 is used. Note that [Enter] is not echoed by dos. */
8252 /* It doesn't work to autosave while GC is in progress;
8253 the code used for auto-saving doesn't cope with the mark bit. */
8254 if (!gc_in_progress
)
8256 printf ("Auto-save? (y or n) ");
8258 if (((c
= getchar ()) & ~040) == 'Y')
8260 Fdo_auto_save (Qt
, Qnil
);
8262 printf ("\r\nAuto-save done");
8263 #else /* not MSDOS */
8264 printf ("Auto-save done\n");
8265 #endif /* not MSDOS */
8267 while (c
!= '\n') c
= getchar ();
8271 /* During GC, it must be safe to reenable quitting again. */
8272 Vinhibit_quit
= Qnil
;
8275 #endif /* not MSDOS */
8276 printf ("Garbage collection in progress; cannot auto-save now\r\n");
8277 printf ("but will instead do a real quit after garbage collection ends\r\n");
8282 printf ("\r\nAbort? (y or n) ");
8283 #else /* not MSDOS */
8285 printf ("Abort (and enter debugger)? (y or n) ");
8287 printf ("Abort (and dump core)? (y or n) ");
8288 #endif /* not VMS */
8289 #endif /* not MSDOS */
8291 if (((c
= getchar ()) & ~040) == 'Y')
8293 while (c
!= '\n') c
= getchar ();
8295 printf ("\r\nContinuing...\r\n");
8296 #else /* not MSDOS */
8297 printf ("Continuing...\n");
8298 #endif /* not MSDOS */
8305 /* If executing a function that wants to be interrupted out of
8306 and the user has not deferred quitting by binding `inhibit-quit'
8307 then quit right away. */
8308 if (immediate_quit
&& NILP (Vinhibit_quit
))
8310 struct gl_state_s saved
;
8311 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8316 GCPRO4 (saved
.object
, saved
.global_code
,
8317 saved
.current_syntax_table
, saved
.old_prop
);
8318 Fsignal (Qquit
, Qnil
);
8323 /* Else request quit when it's safe */
8327 if (waiting_for_input
&& !echoing
)
8328 quit_throw_to_read_char ();
8333 /* Handle a C-g by making read_char return C-g. */
8336 quit_throw_to_read_char ()
8338 quit_error_check ();
8340 /* Prevent another signal from doing this before we finish. */
8341 clear_waiting_for_input ();
8344 Vunread_command_events
= Qnil
;
8345 unread_command_char
= -1;
8347 #if 0 /* Currently, sit_for is called from read_char without turning
8348 off polling. And that can call set_waiting_for_input.
8349 It seems to be harmless. */
8350 #ifdef POLL_FOR_INPUT
8351 /* May be > 1 if in recursive minibuffer. */
8352 if (poll_suppress_count
== 0)
8356 if (FRAMEP (internal_last_event_frame
)
8357 && XFRAME (internal_last_event_frame
) != selected_frame
)
8358 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
8361 _longjmp (getcjmp
, 1);
8364 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
8365 "Set mode of reading keyboard input.\n\
8366 First arg INTERRUPT non-nil means use input interrupts;\n\
8367 nil means use CBREAK mode.\n\
8368 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
8369 (no effect except in CBREAK mode).\n\
8370 Third arg META t means accept 8-bit input (for a Meta key).\n\
8371 META nil means ignore the top bit, on the assumption it is parity.\n\
8372 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
8373 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
8374 See also `current-input-mode'.")
8375 (interrupt
, flow
, meta
, quit
)
8376 Lisp_Object interrupt
, flow
, meta
, quit
;
8379 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
8380 error ("set-input-mode: QUIT must be an ASCII character");
8382 #ifdef POLL_FOR_INPUT
8387 /* this causes startup screen to be restored and messes with the mouse */
8392 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8393 if (read_socket_hook
)
8395 /* When using X, don't give the user a real choice,
8396 because we haven't implemented the mechanisms to support it. */
8397 #ifdef NO_SOCK_SIGIO
8398 interrupt_input
= 0;
8399 #else /* not NO_SOCK_SIGIO */
8400 interrupt_input
= 1;
8401 #endif /* NO_SOCK_SIGIO */
8404 interrupt_input
= !NILP (interrupt
);
8405 #else /* not SIGIO */
8406 interrupt_input
= 0;
8407 #endif /* not SIGIO */
8409 /* Our VMS input only works by interrupts, as of now. */
8411 interrupt_input
= 1;
8414 flow_control
= !NILP (flow
);
8417 else if (EQ (meta
, Qt
))
8422 /* Don't let this value be out of range. */
8423 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
8429 #ifdef POLL_FOR_INPUT
8430 poll_suppress_count
= 1;
8436 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
8437 "Return information about the way Emacs currently reads keyboard input.\n\
8438 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
8439 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
8440 nil, Emacs is using CBREAK mode.\n\
8441 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
8442 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
8443 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
8444 META nil means ignoring the top bit, on the assumption it is parity.\n\
8445 META is neither t nor nil if accepting 8-bit input and using\n\
8446 all 8 bits as the character code.\n\
8447 QUIT is the character Emacs currently uses to quit.\n\
8448 The elements of this list correspond to the arguments of\n\
8454 val
[0] = interrupt_input
? Qt
: Qnil
;
8455 val
[1] = flow_control
? Qt
: Qnil
;
8456 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
8457 XSETFASTINT (val
[3], quit_char
);
8459 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
8464 * Set up a new kboard object with reasonable initial values.
8470 kb
->Voverriding_terminal_local_map
= Qnil
;
8471 kb
->Vlast_command
= Qnil
;
8472 kb
->Vprefix_arg
= Qnil
;
8473 kb
->kbd_queue
= Qnil
;
8474 kb
->kbd_queue_has_data
= 0;
8475 kb
->immediate_echo
= 0;
8476 kb
->echoptr
= kb
->echobuf
;
8477 kb
->echo_after_prompt
= -1;
8478 kb
->kbd_macro_buffer
= 0;
8479 kb
->kbd_macro_bufsize
= 0;
8480 kb
->defining_kbd_macro
= Qnil
;
8481 kb
->Vlast_kbd_macro
= Qnil
;
8482 kb
->reference_count
= 0;
8483 kb
->Vsystem_key_alist
= Qnil
;
8484 kb
->system_key_syms
= Qnil
;
8485 kb
->Vdefault_minibuffer_frame
= Qnil
;
8489 * Destroy the contents of a kboard object, but not the object itself.
8490 * We use this just before deleting it, or if we're going to initialize
8497 if (kb
->kbd_macro_buffer
)
8498 xfree (kb
->kbd_macro_buffer
);
8507 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
8510 *kbp
= kb
->next_kboard
;
8519 /* This is correct before outermost invocation of the editor loop */
8520 command_loop_level
= -1;
8522 quit_char
= Ctl ('g');
8523 Vunread_command_events
= Qnil
;
8524 unread_command_char
= -1;
8525 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
8527 recent_keys_index
= 0;
8528 kbd_fetch_ptr
= kbd_buffer
;
8529 kbd_store_ptr
= kbd_buffer
;
8530 kbd_buffer_frame_or_window
8531 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8533 do_mouse_tracking
= Qnil
;
8537 /* This means that command_loop_1 won't try to select anything the first
8539 internal_last_event_frame
= Qnil
;
8540 Vlast_event_frame
= internal_last_event_frame
;
8543 current_kboard
= initial_kboard
;
8545 wipe_kboard (current_kboard
);
8546 init_kboard (current_kboard
);
8549 Ffillarray (kbd_buffer_frame_or_window
, Qnil
);
8551 kbd_buffer_frame_or_window
8552 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8553 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
8555 signal (SIGINT
, interrupt_signal
);
8556 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
8557 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
8558 SIGQUIT and we can't tell which one it will give us. */
8559 signal (SIGQUIT
, interrupt_signal
);
8560 #endif /* HAVE_TERMIO */
8562 /* Note SIGIO has been undef'd if FIONREAD is missing. */
8564 if (!noninteractive
)
8565 signal (SIGIO
, input_available_signal
);
8568 /* Use interrupt input by default, if it works and noninterrupt input
8569 has deficiencies. */
8571 #ifdef INTERRUPT_INPUT
8572 interrupt_input
= 1;
8574 interrupt_input
= 0;
8577 /* Our VMS input only works by interrupts, as of now. */
8579 interrupt_input
= 1;
8585 if (keyboard_init_hook
)
8586 (*keyboard_init_hook
) ();
8588 #ifdef POLL_FOR_INPUT
8589 poll_suppress_count
= 1;
8594 /* This type's only use is in syms_of_keyboard, to initialize the
8595 event header symbols and put properties on them. */
8602 struct event_head head_table
[] = {
8603 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
8604 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
8605 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
8606 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
8607 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
8608 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
8614 staticpro (&item_properties
);
8615 item_properties
= Qnil
;
8617 Qtimer_event_handler
= intern ("timer-event-handler");
8618 staticpro (&Qtimer_event_handler
);
8620 Qdisabled_command_hook
= intern ("disabled-command-hook");
8621 staticpro (&Qdisabled_command_hook
);
8623 Qself_insert_command
= intern ("self-insert-command");
8624 staticpro (&Qself_insert_command
);
8626 Qforward_char
= intern ("forward-char");
8627 staticpro (&Qforward_char
);
8629 Qbackward_char
= intern ("backward-char");
8630 staticpro (&Qbackward_char
);
8632 Qdisabled
= intern ("disabled");
8633 staticpro (&Qdisabled
);
8635 Qundefined
= intern ("undefined");
8636 staticpro (&Qundefined
);
8638 Qpre_command_hook
= intern ("pre-command-hook");
8639 staticpro (&Qpre_command_hook
);
8641 Qpost_command_hook
= intern ("post-command-hook");
8642 staticpro (&Qpost_command_hook
);
8644 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
8645 staticpro (&Qpost_command_idle_hook
);
8647 Qdeferred_action_function
= intern ("deferred-action-function");
8648 staticpro (&Qdeferred_action_function
);
8650 Qcommand_hook_internal
= intern ("command-hook-internal");
8651 staticpro (&Qcommand_hook_internal
);
8653 Qfunction_key
= intern ("function-key");
8654 staticpro (&Qfunction_key
);
8655 Qmouse_click
= intern ("mouse-click");
8656 staticpro (&Qmouse_click
);
8658 Qmouse_wheel
= intern ("mouse-wheel");
8659 staticpro (&Qmouse_wheel
);
8661 Qdrag_n_drop
= intern ("drag-n-drop");
8662 staticpro (&Qdrag_n_drop
);
8664 Qmenu_enable
= intern ("menu-enable");
8665 staticpro (&Qmenu_enable
);
8666 Qmenu_alias
= intern ("menu-alias");
8667 staticpro (&Qmenu_alias
);
8668 QCenable
= intern (":enable");
8669 staticpro (&QCenable
);
8670 QCvisible
= intern (":visible");
8671 staticpro (&QCvisible
);
8672 QCfilter
= intern (":filter");
8673 staticpro (&QCfilter
);
8674 QCbutton
= intern (":button");
8675 staticpro (&QCbutton
);
8676 QCkeys
= intern (":keys");
8677 staticpro (&QCkeys
);
8678 QCkey_sequence
= intern (":key-sequence");
8679 staticpro (&QCkey_sequence
);
8680 QCtoggle
= intern (":toggle");
8681 staticpro (&QCtoggle
);
8682 QCradio
= intern (":radio");
8683 staticpro (&QCradio
);
8685 Qmode_line
= intern ("mode-line");
8686 staticpro (&Qmode_line
);
8687 Qvertical_line
= intern ("vertical-line");
8688 staticpro (&Qvertical_line
);
8689 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
8690 staticpro (&Qvertical_scroll_bar
);
8691 Qmenu_bar
= intern ("menu-bar");
8692 staticpro (&Qmenu_bar
);
8694 Qabove_handle
= intern ("above-handle");
8695 staticpro (&Qabove_handle
);
8696 Qhandle
= intern ("handle");
8697 staticpro (&Qhandle
);
8698 Qbelow_handle
= intern ("below-handle");
8699 staticpro (&Qbelow_handle
);
8700 Qup
= intern ("up");
8702 Qdown
= intern ("down");
8705 Qevent_kind
= intern ("event-kind");
8706 staticpro (&Qevent_kind
);
8707 Qevent_symbol_elements
= intern ("event-symbol-elements");
8708 staticpro (&Qevent_symbol_elements
);
8709 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
8710 staticpro (&Qevent_symbol_element_mask
);
8711 Qmodifier_cache
= intern ("modifier-cache");
8712 staticpro (&Qmodifier_cache
);
8714 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
8715 staticpro (&Qrecompute_lucid_menubar
);
8716 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
8717 staticpro (&Qactivate_menubar_hook
);
8719 Qpolling_period
= intern ("polling-period");
8720 staticpro (&Qpolling_period
);
8723 struct event_head
*p
;
8725 for (p
= head_table
;
8726 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
8729 *p
->var
= intern (p
->name
);
8731 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
8732 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
8736 button_down_location
= Fmake_vector (make_number (NUM_MOUSE_BUTTONS
), Qnil
);
8737 staticpro (&button_down_location
);
8741 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
8743 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
8744 for (i
= 0; i
< len
; i
++)
8745 if (modifier_names
[i
])
8746 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
8747 staticpro (&modifier_symbols
);
8750 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
8751 staticpro (&recent_keys
);
8753 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
8754 staticpro (&this_command_keys
);
8756 Qextended_command_history
= intern ("extended-command-history");
8757 Fset (Qextended_command_history
, Qnil
);
8758 staticpro (&Qextended_command_history
);
8760 kbd_buffer_frame_or_window
8761 = Fmake_vector (make_number (KBD_BUFFER_SIZE
), Qnil
);
8762 staticpro (&kbd_buffer_frame_or_window
);
8764 accent_key_syms
= Qnil
;
8765 staticpro (&accent_key_syms
);
8767 func_key_syms
= Qnil
;
8768 staticpro (&func_key_syms
);
8771 staticpro (&mouse_syms
);
8774 mouse_wheel_syms
= Qnil
;
8775 staticpro (&mouse_wheel_syms
);
8777 drag_n_drop_syms
= Qnil
;
8778 staticpro (&drag_n_drop_syms
);
8781 unread_switch_frame
= Qnil
;
8782 staticpro (&unread_switch_frame
);
8784 internal_last_event_frame
= Qnil
;
8785 staticpro (&internal_last_event_frame
);
8787 read_key_sequence_cmd
= Qnil
;
8788 staticpro (&read_key_sequence_cmd
);
8790 defsubr (&Sevent_convert_list
);
8791 defsubr (&Sread_key_sequence
);
8792 defsubr (&Sread_key_sequence_vector
);
8793 defsubr (&Srecursive_edit
);
8795 defsubr (&Strack_mouse
);
8797 defsubr (&Sinput_pending_p
);
8798 defsubr (&Scommand_execute
);
8799 defsubr (&Srecent_keys
);
8800 defsubr (&Sthis_command_keys
);
8801 defsubr (&Sthis_command_keys_vector
);
8802 defsubr (&Sthis_single_command_keys
);
8803 defsubr (&Sreset_this_command_lengths
);
8804 defsubr (&Ssuspend_emacs
);
8805 defsubr (&Sabort_recursive_edit
);
8806 defsubr (&Sexit_recursive_edit
);
8807 defsubr (&Srecursion_depth
);
8808 defsubr (&Stop_level
);
8809 defsubr (&Sdiscard_input
);
8810 defsubr (&Sopen_dribble_file
);
8811 defsubr (&Sset_input_mode
);
8812 defsubr (&Scurrent_input_mode
);
8813 defsubr (&Sexecute_extended_command
);
8815 DEFVAR_LISP ("last-command-char", &last_command_char
,
8816 "Last input event that was part of a command.");
8818 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
8819 "Last input event that was part of a command.");
8821 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
8822 "Last input event in a command, except for mouse menu events.\n\
8823 Mouse menus give back keys that don't look like mouse events;\n\
8824 this variable holds the actual mouse event that led to the menu,\n\
8825 so that you can determine whether the command was run by mouse or not.");
8827 DEFVAR_LISP ("last-input-char", &last_input_char
,
8828 "Last input event.");
8830 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
8831 "Last input event.");
8833 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
8834 "List of objects to be read as next command input events.");
8836 DEFVAR_INT ("unread-command-char", &unread_command_char
,
8837 "If not -1, an object to be read as next command input event.");
8839 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
8840 "Meta-prefix character code. Meta-foo as command input\n\
8841 turns into this character followed by foo.");
8842 XSETINT (meta_prefix_char
, 033);
8844 DEFVAR_KBOARD ("last-command", Vlast_command
,
8845 "The last command executed. Normally a symbol with a function definition,\n\
8846 but can be whatever was found in the keymap, or whatever the variable\n\
8847 `this-command' was set to by that command.\n\
8849 The value `mode-exit' is special; it means that the previous command\n\
8850 read an event that told it to exit, and it did so and unread that event.\n\
8851 In other words, the present command is the event that made the previous\n\
8854 The value `kill-region' is special; it means that the previous command\n\
8855 was a kill command.");
8857 DEFVAR_LISP ("this-command", &this_command
,
8858 "The command now being executed.\n\
8859 The command can set this variable; whatever is put here\n\
8860 will be in `last-command' during the following command.");
8861 this_command
= Qnil
;
8863 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
8864 "*Number of keyboard input characters between auto-saves.\n\
8865 Zero means disable autosaving due to number of characters typed.");
8866 auto_save_interval
= 300;
8868 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
8869 "*Number of seconds idle time before auto-save.\n\
8870 Zero or nil means disable auto-saving due to idleness.\n\
8871 After auto-saving due to this many seconds of idle time,\n\
8872 Emacs also does a garbage collection if that seems to be warranted.");
8873 XSETFASTINT (Vauto_save_timeout
, 30);
8875 DEFVAR_INT ("echo-keystrokes", &echo_keystrokes
,
8876 "*Nonzero means echo unfinished commands after this many seconds of pause.");
8877 echo_keystrokes
= 1;
8879 DEFVAR_INT ("polling-period", &polling_period
,
8880 "*Interval between polling for input during Lisp execution.\n\
8881 The reason for polling is to make C-g work to stop a running program.\n\
8882 Polling is needed only when using X windows and SIGIO does not work.\n\
8883 Polling is automatically disabled in all other cases.");
8886 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
8887 "*Maximum time between mouse clicks to make a double-click.\n\
8888 Measured in milliseconds. nil means disable double-click recognition;\n\
8889 t means double-clicks have no time limit and are detected\n\
8890 by position only.");
8891 Vdouble_click_time
= make_number (500);
8893 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
8894 "*Non-nil means inhibit local map menu bar menus.");
8895 inhibit_local_menu_bar_menus
= 0;
8897 DEFVAR_INT ("num-input-keys", &num_input_keys
,
8898 "Number of complete key sequences read as input so far.\n\
8899 This includes key sequences read from keyboard macros.\n\
8900 The number is effectively the number of interactive command invocations.");
8903 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
8904 "Number of input events read from the keyboard so far.\n\
8905 This does not include events generated by keyboard macros.");
8906 num_nonmacro_input_events
= 0;
8908 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
8909 "The frame in which the most recently read event occurred.\n\
8910 If the last event came from a keyboard macro, this is set to `macro'.");
8911 Vlast_event_frame
= Qnil
;
8913 /* This variable is set up in sysdep.c. */
8914 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
8915 "The ERASE character as set by the user with stty.");
8917 DEFVAR_LISP ("help-char", &Vhelp_char
,
8918 "Character to recognize as meaning Help.\n\
8919 When it is read, do `(eval help-form)', and display result if it's a string.\n\
8920 If the value of `help-form' is nil, this char can be read normally.");
8921 XSETINT (Vhelp_char
, Ctl ('H'));
8923 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
8924 "List of input events to recognize as meaning Help.\n\
8925 These work just like the value of `help-char' (see that).");
8926 Vhelp_event_list
= Qnil
;
8928 DEFVAR_LISP ("help-form", &Vhelp_form
,
8929 "Form to execute when character `help-char' is read.\n\
8930 If the form returns a string, that string is displayed.\n\
8931 If `help-form' is nil, the help char is not recognized.");
8934 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
8935 "Command to run when `help-char' character follows a prefix key.\n\
8936 This command is used only when there is no actual binding\n\
8937 for that character after that prefix key.");
8938 Vprefix_help_command
= Qnil
;
8940 DEFVAR_LISP ("top-level", &Vtop_level
,
8941 "Form to evaluate when Emacs starts up.\n\
8942 Useful to set before you dump a modified Emacs.");
8945 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
8946 "Translate table for keyboard input, or nil.\n\
8947 Each character is looked up in this string and the contents used instead.\n\
8948 The value may be a string, a vector, or a char-table.\n\
8949 If it is a string or vector of length N,\n\
8950 character codes N and up are untranslated.\n\
8951 In a vector or a char-table, an element which is nil means \"no translation\".");
8952 Vkeyboard_translate_table
= Qnil
;
8954 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
8955 "Non-nil means to always spawn a subshell instead of suspending,\n\
8956 even if the operating system has support for stopping a process.");
8959 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
8960 "Non-nil means prompt with menus when appropriate.\n\
8961 This is done when reading from a keymap that has a prompt string,\n\
8962 for elements that have prompt strings.\n\
8963 The menu is displayed on the screen\n\
8964 if X menus were enabled at configuration\n\
8965 time and the previous event was a mouse click prefix key.\n\
8966 Otherwise, menu prompting uses the echo area.");
8969 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
8970 "Character to see next line of menu prompt.\n\
8971 Type this character while in a menu prompt to rotate around the lines of it.");
8972 XSETINT (menu_prompt_more_char
, ' ');
8974 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
8975 "A mask of additional modifier keys to use with every keyboard character.\n\
8976 Emacs applies the modifiers of the character stored here to each keyboard\n\
8977 character it reads. For example, after evaluating the expression\n\
8978 (setq extra-keyboard-modifiers ?\\C-x)\n\
8979 all input characters will have the control modifier applied to them.\n\
8981 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
8982 not count as a control character; rather, it counts as a character\n\
8983 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
8984 cancels any modification.");
8985 extra_keyboard_modifiers
= 0;
8987 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
8988 "If an editing command sets this to t, deactivate the mark afterward.\n\
8989 The command loop sets this to nil before each command,\n\
8990 and tests the value when the command returns.\n\
8991 Buffer modification stores t in this variable.");
8992 Vdeactivate_mark
= Qnil
;
8994 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
8995 "Temporary storage of pre-command-hook or post-command-hook.");
8996 Vcommand_hook_internal
= Qnil
;
8998 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
8999 "Normal hook run before each command is executed.\n\
9000 Errors running the hook are caught and ignored.");
9001 Vpre_command_hook
= Qnil
;
9003 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
9004 "Normal hook run after each command is executed.\n\
9005 Errors running the hook are caught and ignored.");
9006 Vpost_command_hook
= Qnil
;
9008 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
9009 "Normal hook run after each command is executed, if idle.\n\
9010 Errors running the hook are caught and ignored.\n\
9011 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
9012 Vpost_command_idle_hook
= Qnil
;
9014 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
9015 "Delay time before running `post-command-idle-hook'.\n\
9016 This is measured in microseconds.");
9017 post_command_idle_delay
= 100000;
9020 DEFVAR_LISP ("echo-area-clear-hook", ...,
9021 "Normal hook run when clearing the echo area.");
9023 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
9024 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
9026 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
9027 "t means menu bar, specified Lucid style, needs to be recomputed.");
9028 Vlucid_menu_bar_dirty_flag
= Qnil
;
9030 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
9031 "List of menu bar items to move to the end of the menu bar.\n\
9032 The elements of the list are event types that may have menu bar bindings.");
9033 Vmenu_bar_final_items
= Qnil
;
9035 DEFVAR_KBOARD ("overriding-terminal-local-map",
9036 Voverriding_terminal_local_map
,
9037 "Per-terminal keymap that overrides all other local keymaps.\n\
9038 If this variable is non-nil, it is used as a keymap instead of the\n\
9039 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
9040 This variable is intended to let commands such as `universal-argumemnt'\n\
9041 set up a different keymap for reading the next command.");
9043 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
9044 "Keymap that overrides all other local keymaps.\n\
9045 If this variable is non-nil, it is used as a keymap instead of the\n\
9046 buffer's local map, and the minor mode keymaps and text property keymaps.");
9047 Voverriding_local_map
= Qnil
;
9049 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
9050 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
9051 Otherwise, the menu bar continues to reflect the buffer's local map\n\
9052 and the minor mode maps regardless of `overriding-local-map'.");
9053 Voverriding_local_map_menu_flag
= Qnil
;
9055 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
9056 "Keymap defining bindings for special events to execute at low level.");
9057 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
9059 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
9060 "*Non-nil means generate motion events for mouse motion.");
9062 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
9063 "Alist of system-specific X windows key symbols.\n\
9064 Each element should have the form (N . SYMBOL) where N is the\n\
9065 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
9066 and SYMBOL is its name.");
9068 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
9069 "List of deferred actions to be performed at a later time.\n\
9070 The precise format isn't relevant here; we just check whether it is nil.");
9071 Vdeferred_action_list
= Qnil
;
9073 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
9074 "Function to call to handle deferred actions, after each command.\n\
9075 This function is called with no arguments after each command\n\
9076 whenever `deferred-action-list' is non-nil.");
9077 Vdeferred_action_function
= Qnil
;
9079 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
9080 "Non-nil means show the equivalent key-binding when M-x command has one.\n\
9081 The value can be a length of time to show the message for.\n\
9082 If the value is non-nil and not a number, we wait 2 seconds.");
9083 Vsuggest_key_bindings
= Qt
;
9085 DEFVAR_LISP ("timer-list", &Vtimer_list
,
9086 "List of active absolute time timers in order of increasing time");
9089 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
9090 "List of active idle-time timers in order of increasing time");
9091 Vtimer_idle_list
= Qnil
;
9097 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
9098 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
9099 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
9100 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
9101 initial_define_key (meta_map
, 'x', "execute-extended-command");
9103 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
9104 "handle-delete-frame");
9105 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
9107 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",