1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
101 /* Non-nil disable property on a command means
102 do not execute it; call disabled-command-function's value instead. */
103 Lisp_Object Qdisabled
, Qdisabled_command_function
;
105 #define NUM_RECENT_KEYS (300)
106 int recent_keys_index
; /* Index for storing next element into recent_keys */
107 int total_keys
; /* Total number of elements stored into recent_keys */
108 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
110 /* Vector holding the key sequence that invoked the current command.
111 It is reused for each command, and it may be longer than the current
112 sequence; this_command_key_count indicates how many elements
113 actually mean something.
114 It's easier to staticpro a single Lisp_Object than an array. */
115 Lisp_Object this_command_keys
;
116 int this_command_key_count
;
118 /* 1 after calling Freset_this_command_lengths.
120 int this_command_key_count_reset
;
122 /* This vector is used as a buffer to record the events that were actually read
123 by read_key_sequence. */
124 Lisp_Object raw_keybuf
;
125 int raw_keybuf_count
;
127 #define GROW_RAW_KEYBUF \
128 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
129 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
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
;
140 /* For longjmp to where kbd input is being done. */
142 static jmp_buf getcjmp
;
144 /* True while doing kbd input. */
145 int waiting_for_input
;
147 /* True while displaying for echoing. Delays C-g throwing. */
151 /* Non-null means we can start echoing at the next input pause even
152 though there is something in the echo area. */
154 static struct kboard
*ok_to_echo_at_next_pause
;
156 /* The kboard last echoing, or null for none. Reset to 0 in
157 cancel_echoing. If non-null, and a current echo area message
158 exists, and echo_message_buffer is eq to the current message
159 buffer, we know that the message comes from echo_kboard. */
161 struct kboard
*echo_kboard
;
163 /* The buffer used for echoing. Set in echo_now, reset in
166 Lisp_Object echo_message_buffer
;
168 /* Nonzero means C-g should cause immediate error-signal. */
171 /* Character that causes a quit. Normally C-g.
173 If we are running on an ordinary terminal, this must be an ordinary
174 ASCII char, since we want to make it our interrupt character.
176 If we are not running on an ordinary terminal, it still needs to be
177 an ordinary ASCII char. This character needs to be recognized in
178 the input interrupt handler. At this point, the keystroke is
179 represented as a struct input_event, while the desired quit
180 character is specified as a lispy event. The mapping from struct
181 input_events to lispy events cannot run in an interrupt handler,
182 and the reverse mapping is difficult for anything but ASCII
185 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
189 /* Current depth in recursive edits. */
190 int command_loop_level
;
192 /* If not Qnil, this is a switch-frame event which we decided to put
193 off until the end of a key sequence. This should be read as the
194 next command input, after any unread_command_events.
196 read_key_sequence uses this to delay switch-frame events until the
197 end of the key sequence; Fread_char uses it to put off switch-frame
198 events until a non-ASCII event is acceptable as input. */
199 Lisp_Object unread_switch_frame
;
201 /* Last size recorded for a current buffer which is not a minibuffer. */
202 static EMACS_INT last_non_minibuf_size
;
204 /* Total number of times read_char has returned. */
205 int num_input_events
;
207 /* Value of num_nonmacro_input_events as of last auto save. */
211 /* This is like Vthis_command, except that commands never set it. */
212 Lisp_Object real_this_command
;
214 /* The value of point when the last command was started. */
215 EMACS_INT last_point_position
;
217 /* The buffer that was current when the last command was started. */
218 Lisp_Object last_point_position_buffer
;
220 /* The window that was selected when the last command was started. */
221 Lisp_Object last_point_position_window
;
223 /* The frame in which the last input event occurred, or Qmacro if the
224 last event came from a macro. We use this to determine when to
225 generate switch-frame events. This may be cleared by functions
226 like Fselect_frame, to make sure that a switch-frame event is
227 generated by the next character. */
228 Lisp_Object internal_last_event_frame
;
230 /* The timestamp of the last input event we received from the X server.
231 X Windows wants this for selection ownership. */
232 unsigned long last_event_timestamp
;
234 Lisp_Object Qx_set_selection
, QPRIMARY
, Qhandle_switch_frame
;
236 Lisp_Object Qself_insert_command
;
237 Lisp_Object Qforward_char
;
238 Lisp_Object Qbackward_char
;
239 Lisp_Object Qundefined
;
240 Lisp_Object Qtimer_event_handler
;
242 /* read_key_sequence stores here the command definition of the
243 key sequence that it reads. */
244 Lisp_Object read_key_sequence_cmd
;
246 Lisp_Object Qinput_method_function
;
248 Lisp_Object Qdeactivate_mark
;
250 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
252 Lisp_Object Qecho_area_clear_hook
;
254 /* Hooks to run before and after each command. */
255 Lisp_Object Qpre_command_hook
;
256 Lisp_Object Qpost_command_hook
;
257 Lisp_Object Qcommand_hook_internal
;
259 Lisp_Object Qdeferred_action_function
;
261 Lisp_Object Qinput_method_exit_on_first_char
;
262 Lisp_Object Qinput_method_use_echo_area
;
264 /* File in which we write all commands we read. */
267 /* Nonzero if input is available. */
270 /* Circular buffer for pre-read keyboard input. */
272 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
274 /* Pointer to next available character in kbd_buffer.
275 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
276 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
277 next available char is in kbd_buffer[0]. */
278 static struct input_event
*kbd_fetch_ptr
;
280 /* Pointer to next place to store character in kbd_buffer. This
281 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
282 character should go in kbd_buffer[0]. */
283 static struct input_event
* volatile kbd_store_ptr
;
285 /* The above pair of variables forms a "queue empty" flag. When we
286 enqueue a non-hook event, we increment kbd_store_ptr. When we
287 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
288 there is input available if the two pointers are not equal.
290 Why not just have a flag set and cleared by the enqueuing and
291 dequeuing functions? Such a flag could be screwed up by interrupts
292 at inopportune times. */
294 /* Symbols to head events. */
295 Lisp_Object Qmouse_movement
;
296 Lisp_Object Qscroll_bar_movement
;
297 Lisp_Object Qswitch_frame
;
298 Lisp_Object Qdelete_frame
;
299 Lisp_Object Qiconify_frame
;
300 Lisp_Object Qmake_frame_visible
;
301 Lisp_Object Qselect_window
;
302 Lisp_Object Qhelp_echo
;
304 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
305 Lisp_Object Qmouse_fixup_help_message
;
308 /* Symbols to denote kinds of events. */
309 Lisp_Object Qfunction_key
;
310 Lisp_Object Qmouse_click
;
311 #if defined (WINDOWSNT)
312 Lisp_Object Qlanguage_change
;
314 Lisp_Object Qdrag_n_drop
;
315 Lisp_Object Qsave_session
;
317 Lisp_Object Qdbus_event
;
319 Lisp_Object Qxwidget_event
;
320 Lisp_Object Qconfig_changed_event
;
322 /* Lisp_Object Qmouse_movement; - also an event header */
324 /* Properties of event headers. */
325 Lisp_Object Qevent_kind
;
326 Lisp_Object Qevent_symbol_elements
;
328 /* menu and tool bar item parts */
329 Lisp_Object Qmenu_enable
;
330 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
331 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
, QCvert_only
;
333 /* An event header symbol HEAD may have a property named
334 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
335 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
336 mask of modifiers applied to it. If present, this is used to help
337 speed up parse_modifiers. */
338 Lisp_Object Qevent_symbol_element_mask
;
340 /* An unmodified event header BASE may have a property named
341 Qmodifier_cache, which is an alist mapping modifier masks onto
342 modified versions of BASE. If present, this helps speed up
344 Lisp_Object Qmodifier_cache
;
346 /* Symbols to use for parts of windows. */
347 Lisp_Object Qmode_line
;
348 Lisp_Object Qvertical_line
;
349 Lisp_Object Qvertical_scroll_bar
;
350 Lisp_Object Qmenu_bar
;
352 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
353 Lisp_Object
Fthis_command_keys (void);
354 Lisp_Object Qextended_command_history
;
355 EMACS_TIME
timer_check (int do_it_now
);
357 static void record_menu_key (Lisp_Object c
);
358 static int echo_length (void);
360 Lisp_Object Qpolling_period
;
362 /* Incremented whenever a timer is run. */
365 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
367 EMACS_TIME
*input_available_clear_time
;
369 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
370 Default is 1 if INTERRUPT_INPUT is defined. */
373 /* Nonzero while interrupts are temporarily deferred during redisplay. */
374 int interrupts_deferred
;
376 /* Allow m- file to inhibit use of FIONREAD. */
377 #ifdef BROKEN_FIONREAD
381 /* We are unable to use interrupts if FIONREAD is not available,
382 so flush SIGIO so we won't try. */
383 #if !defined (FIONREAD)
389 /* If we support a window system, turn on the code to poll periodically
390 to detect C-g. It isn't actually used when doing interrupt input. */
391 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
392 #define POLL_FOR_INPUT
395 /* The time when Emacs started being idle. */
397 static EMACS_TIME timer_idleness_start_time
;
399 /* After Emacs stops being idle, this saves the last value
400 of timer_idleness_start_time from when it was idle. */
402 static EMACS_TIME timer_last_idleness_start_time
;
405 /* Global variable declarations. */
407 /* Flags for readable_events. */
408 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
409 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
410 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
412 /* Function for init_keyboard to call with no args (if nonzero). */
413 void (*keyboard_init_hook
) (void);
415 static int read_avail_input (int);
416 static void get_input_pending (int *, int);
417 static int readable_events (int);
418 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
420 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
422 static Lisp_Object
make_lispy_event (struct input_event
*);
423 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
424 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
425 enum scroll_bar_part
,
426 Lisp_Object
, Lisp_Object
,
429 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
430 Lisp_Object
, const char *const *,
431 Lisp_Object
*, unsigned);
432 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
433 static void save_getcjmp (jmp_buf);
434 static void restore_getcjmp (jmp_buf);
435 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
436 static void clear_event (struct input_event
*);
437 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
438 static SIGTYPE
interrupt_signal (int signalnum
);
440 static SIGTYPE
input_available_signal (int signo
);
442 static void handle_interrupt (void);
443 static void timer_start_idle (void);
444 static void timer_stop_idle (void);
445 static void timer_resume_idle (void);
446 static SIGTYPE
handle_user_signal (int);
447 static char *find_user_signal_name (int);
448 static int store_user_signal_events (void);
451 /* Add C to the echo string, if echoing is going on.
452 C can be a character, which is printed prettily ("M-C-x" and all that
453 jazz), or a symbol, whose name is printed. */
456 echo_char (Lisp_Object c
)
458 if (current_kboard
->immediate_echo
)
460 int size
= KEY_DESCRIPTION_SIZE
+ 100;
461 char *buffer
= (char *) alloca (size
);
463 Lisp_Object echo_string
;
465 echo_string
= current_kboard
->echo_string
;
467 /* If someone has passed us a composite event, use its head symbol. */
472 ptr
= push_key_description (XINT (c
), ptr
, 1);
474 else if (SYMBOLP (c
))
476 Lisp_Object name
= SYMBOL_NAME (c
);
477 int nbytes
= SBYTES (name
);
479 if (size
- (ptr
- buffer
) < nbytes
)
481 int offset
= ptr
- buffer
;
482 size
= max (2 * size
, size
+ nbytes
);
483 buffer
= (char *) alloca (size
);
484 ptr
= buffer
+ offset
;
487 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
488 STRING_MULTIBYTE (name
), 1);
491 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
494 const char *text
= " (Type ? for further options)";
495 int len
= strlen (text
);
497 if (size
- (ptr
- buffer
) < len
)
499 int offset
= ptr
- buffer
;
501 buffer
= (char *) alloca (size
);
502 ptr
= buffer
+ offset
;
505 memcpy (ptr
, text
, len
);
509 /* Replace a dash from echo_dash with a space, otherwise
510 add a space at the end as a separator between keys. */
511 if (STRINGP (echo_string
)
512 && SCHARS (echo_string
) > 1)
514 Lisp_Object last_char
, prev_char
, idx
;
516 idx
= make_number (SCHARS (echo_string
) - 2);
517 prev_char
= Faref (echo_string
, idx
);
519 idx
= make_number (SCHARS (echo_string
) - 1);
520 last_char
= Faref (echo_string
, idx
);
522 /* We test PREV_CHAR to make sure this isn't the echoing
524 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
525 Faset (echo_string
, idx
, make_number (' '));
527 echo_string
= concat2 (echo_string
, build_string (" "));
529 else if (STRINGP (echo_string
))
530 echo_string
= concat2 (echo_string
, build_string (" "));
532 current_kboard
->echo_string
533 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
539 /* Temporarily add a dash to the end of the echo string if it's not
540 empty, so that it serves as a mini-prompt for the very next character. */
545 /* Do nothing if not echoing at all. */
546 if (NILP (current_kboard
->echo_string
))
549 if (this_command_key_count
== 0)
552 if (!current_kboard
->immediate_echo
553 && SCHARS (current_kboard
->echo_string
) == 0)
556 /* Do nothing if we just printed a prompt. */
557 if (current_kboard
->echo_after_prompt
558 == SCHARS (current_kboard
->echo_string
))
561 /* Do nothing if we have already put a dash at the end. */
562 if (SCHARS (current_kboard
->echo_string
) > 1)
564 Lisp_Object last_char
, prev_char
, idx
;
566 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
567 prev_char
= Faref (current_kboard
->echo_string
, idx
);
569 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
570 last_char
= Faref (current_kboard
->echo_string
, idx
);
572 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
576 /* Put a dash at the end of the buffer temporarily,
577 but make it go away when the next character is added. */
578 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
583 /* Display the current echo string, and begin echoing if not already
589 if (!current_kboard
->immediate_echo
)
592 current_kboard
->immediate_echo
= 1;
594 for (i
= 0; i
< this_command_key_count
; i
++)
598 /* Set before_command_echo_length to the value that would
599 have been saved before the start of this subcommand in
600 command_loop_1, if we had already been echoing then. */
601 if (i
== this_single_command_key_start
)
602 before_command_echo_length
= echo_length ();
604 c
= XVECTOR (this_command_keys
)->contents
[i
];
605 if (! (EVENT_HAS_PARAMETERS (c
)
606 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
610 /* Set before_command_echo_length to the value that would
611 have been saved before the start of this subcommand in
612 command_loop_1, if we had already been echoing then. */
613 if (this_command_key_count
== this_single_command_key_start
)
614 before_command_echo_length
= echo_length ();
616 /* Put a dash at the end to invite the user to type more. */
621 message3_nolog (current_kboard
->echo_string
,
622 SBYTES (current_kboard
->echo_string
),
623 STRING_MULTIBYTE (current_kboard
->echo_string
));
626 /* Record in what buffer we echoed, and from which kboard. */
627 echo_message_buffer
= echo_area_buffer
[0];
628 echo_kboard
= current_kboard
;
630 if (waiting_for_input
&& !NILP (Vquit_flag
))
631 quit_throw_to_read_char ();
634 /* Turn off echoing, for the start of a new command. */
637 cancel_echoing (void)
639 current_kboard
->immediate_echo
= 0;
640 current_kboard
->echo_after_prompt
= -1;
641 current_kboard
->echo_string
= Qnil
;
642 ok_to_echo_at_next_pause
= NULL
;
644 echo_message_buffer
= Qnil
;
647 /* Return the length of the current echo string. */
652 return (STRINGP (current_kboard
->echo_string
)
653 ? SCHARS (current_kboard
->echo_string
)
657 /* Truncate the current echo message to its first LEN chars.
658 This and echo_char get used by read_key_sequence when the user
659 switches frames while entering a key sequence. */
662 echo_truncate (EMACS_INT nchars
)
664 if (STRINGP (current_kboard
->echo_string
))
665 current_kboard
->echo_string
666 = Fsubstring (current_kboard
->echo_string
,
667 make_number (0), make_number (nchars
));
668 truncate_echo_area (nchars
);
672 /* Functions for manipulating this_command_keys. */
674 add_command_key (Lisp_Object key
)
676 #if 0 /* Not needed after we made Freset_this_command_lengths
677 do the job immediately. */
678 /* If reset-this-command-length was called recently, obey it now.
679 See the doc string of that function for an explanation of why. */
680 if (before_command_restore_flag
)
682 this_command_key_count
= before_command_key_count_1
;
683 if (this_command_key_count
< this_single_command_key_start
)
684 this_single_command_key_start
= this_command_key_count
;
685 echo_truncate (before_command_echo_length_1
);
686 before_command_restore_flag
= 0;
690 if (this_command_key_count
>= ASIZE (this_command_keys
))
691 this_command_keys
= larger_vector (this_command_keys
,
692 2 * ASIZE (this_command_keys
),
695 ASET (this_command_keys
, this_command_key_count
, key
);
696 ++this_command_key_count
;
701 recursive_edit_1 (void)
703 int count
= SPECPDL_INDEX ();
706 if (command_loop_level
> 0)
708 specbind (Qstandard_output
, Qt
);
709 specbind (Qstandard_input
, Qt
);
712 #ifdef HAVE_WINDOW_SYSTEM
713 /* The command loop has started an hourglass timer, so we have to
714 cancel it here, otherwise it will fire because the recursive edit
715 can take some time. Do not check for display_hourglass_p here,
716 because it could already be nil. */
720 /* This function may have been called from a debugger called from
721 within redisplay, for instance by Edebugging a function called
722 from fontification-functions. We want to allow redisplay in
723 the debugging session.
725 The recursive edit is left with a `(throw exit ...)'. The `exit'
726 tag is not caught anywhere in redisplay, i.e. when we leave the
727 recursive edit, the original redisplay leading to the recursive
728 edit will be unwound. The outcome should therefore be safe. */
729 specbind (Qinhibit_redisplay
, Qnil
);
732 val
= command_loop ();
734 Fsignal (Qquit
, Qnil
);
735 /* Handle throw from read_minibuf when using minibuffer
736 while it's active but we're in another window. */
738 xsignal1 (Qerror
, val
);
740 return unbind_to (count
, Qnil
);
743 /* When an auto-save happens, record the "time", and don't do again soon. */
746 record_auto_save (void)
748 last_auto_save
= num_nonmacro_input_events
;
751 /* Make an auto save happen as soon as possible at command level. */
754 force_auto_save_soon (void)
756 last_auto_save
= - auto_save_interval
- 1;
758 record_asynch_buffer_change ();
761 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
762 doc
: /* Invoke the editor command loop recursively.
763 To get out of the recursive edit, a command can do `(throw 'exit nil)';
764 that tells this function to return.
765 Alternatively, `(throw 'exit t)' makes this function signal an error.
766 This function is called by the editor initialization to begin editing. */)
769 int count
= SPECPDL_INDEX ();
772 /* If we enter while input is blocked, don't lock up here.
773 This may happen through the debugger during redisplay. */
777 command_loop_level
++;
778 update_mode_lines
= 1;
780 if (command_loop_level
781 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
782 buffer
= Fcurrent_buffer ();
786 /* If we leave recursive_edit_1 below with a `throw' for instance,
787 like it is done in the splash screen display, we have to
788 make sure that we restore single_kboard as command_loop_1
789 would have done if it were left normally. */
790 if (command_loop_level
> 0)
791 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
792 record_unwind_protect (recursive_edit_unwind
, buffer
);
795 return unbind_to (count
, Qnil
);
799 recursive_edit_unwind (Lisp_Object buffer
)
801 if (BUFFERP (buffer
))
802 Fset_buffer (buffer
);
804 command_loop_level
--;
805 update_mode_lines
= 1;
810 #if 0 /* These two functions are now replaced with
811 temporarily_switch_to_single_kboard. */
815 #if 0 /* Theory: if there's anything in Vunread_command_events,
816 it will right away be read by read_key_sequence,
817 and then if we do switch KBOARDS, it will go into the side
818 queue then. So we don't need to do anything special here -- rms. */
819 if (CONSP (Vunread_command_events
))
821 current_kboard
->kbd_queue
822 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
823 current_kboard
->kbd_queue_has_data
= 1;
825 Vunread_command_events
= Qnil
;
830 /* Switch to the single-kboard state, making current_kboard
831 the only KBOARD from which further input is accepted. */
834 single_kboard_state ()
840 /* If we're in single_kboard state for kboard KBOARD,
844 not_single_kboard_state (KBOARD
*kboard
)
846 if (kboard
== current_kboard
)
850 /* Maintain a stack of kboards, so other parts of Emacs
851 can switch temporarily to the kboard of a given frame
852 and then revert to the previous status. */
857 struct kboard_stack
*next
;
860 static struct kboard_stack
*kboard_stack
;
863 push_kboard (struct kboard
*k
)
865 struct kboard_stack
*p
866 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
868 p
->next
= kboard_stack
;
869 p
->kboard
= current_kboard
;
879 struct kboard_stack
*p
= kboard_stack
;
881 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
883 if (t
->kboard
== p
->kboard
)
885 current_kboard
= p
->kboard
;
892 /* The terminal we remembered has been deleted. */
893 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
896 kboard_stack
= p
->next
;
900 /* Switch to single_kboard mode, making current_kboard the only KBOARD
901 from which further input is accepted. If F is non-nil, set its
902 KBOARD as the current keyboard.
904 This function uses record_unwind_protect to return to the previous
907 If Emacs is already in single_kboard mode, and F's keyboard is
908 locked, then this function will throw an errow. */
911 temporarily_switch_to_single_kboard (struct frame
*f
)
913 int was_locked
= single_kboard
;
916 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
917 /* We can not switch keyboards while in single_kboard mode.
918 In rare cases, Lisp code may call `recursive-edit' (or
919 `read-minibuffer' or `y-or-n-p') after it switched to a
920 locked frame. For example, this is likely to happen
921 when server.el connects to a new terminal while Emacs is in
922 single_kboard mode. It is best to throw an error instead
923 of presenting the user with a frozen screen. */
924 error ("Terminal %d is locked, cannot read from it",
925 FRAME_TERMINAL (f
)->id
);
927 /* This call is unnecessary, but helps
928 `restore_kboard_configuration' discover if somebody changed
929 `current_kboard' behind our back. */
930 push_kboard (current_kboard
);
933 current_kboard
= FRAME_KBOARD (f
);
935 record_unwind_protect (restore_kboard_configuration
,
936 (was_locked
? Qt
: Qnil
));
939 #if 0 /* This function is not needed anymore. */
941 record_single_kboard_state ()
944 push_kboard (current_kboard
);
945 record_unwind_protect (restore_kboard_configuration
,
946 (single_kboard
? Qt
: Qnil
));
951 restore_kboard_configuration (Lisp_Object was_locked
)
953 if (NILP (was_locked
))
957 struct kboard
*prev
= current_kboard
;
960 /* The pop should not change the kboard. */
961 if (single_kboard
&& current_kboard
!= prev
)
968 /* Handle errors that are not handled at inner levels
969 by printing an error message and returning to the editor command loop. */
972 cmd_error (Lisp_Object data
)
974 Lisp_Object old_level
, old_length
;
977 #ifdef HAVE_WINDOW_SYSTEM
978 if (display_hourglass_p
)
982 if (!NILP (executing_kbd_macro
))
984 if (executing_kbd_macro_iterations
== 1)
985 sprintf (macroerror
, "After 1 kbd macro iteration: ");
987 sprintf (macroerror
, "After %d kbd macro iterations: ",
988 executing_kbd_macro_iterations
);
993 Vstandard_output
= Qt
;
994 Vstandard_input
= Qt
;
995 Vexecuting_kbd_macro
= Qnil
;
996 executing_kbd_macro
= Qnil
;
997 current_kboard
->Vprefix_arg
= Qnil
;
998 current_kboard
->Vlast_prefix_arg
= Qnil
;
1001 /* Avoid unquittable loop if data contains a circular list. */
1002 old_level
= Vprint_level
;
1003 old_length
= Vprint_length
;
1004 XSETFASTINT (Vprint_level
, 10);
1005 XSETFASTINT (Vprint_length
, 10);
1006 cmd_error_internal (data
, macroerror
);
1007 Vprint_level
= old_level
;
1008 Vprint_length
= old_length
;
1012 Vinhibit_quit
= Qnil
;
1013 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1014 if (command_loop_level
== 0 && minibuf_level
== 0)
1015 any_kboard_state ();
1018 return make_number (0);
1021 /* Take actions on handling an error. DATA is the data that describes
1024 CONTEXT is a C-string containing ASCII characters only which
1025 describes the context in which the error happened. If we need to
1026 generalize CONTEXT to allow multibyte characters, make it a Lisp
1030 cmd_error_internal (Lisp_Object data
, const char *context
)
1032 struct frame
*sf
= SELECTED_FRAME ();
1034 /* The immediate context is not interesting for Quits,
1035 since they are asyncronous. */
1036 if (EQ (XCAR (data
), Qquit
))
1037 Vsignaling_function
= Qnil
;
1042 /* Use user's specified output function if any. */
1043 if (!NILP (Vcommand_error_function
))
1044 call3 (Vcommand_error_function
, data
,
1045 context
? build_string (context
) : empty_unibyte_string
,
1046 Vsignaling_function
);
1047 /* If the window system or terminal frame hasn't been initialized
1048 yet, or we're not interactive, write the message to stderr and exit. */
1049 else if (!sf
->glyphs_initialized_p
1050 /* The initial frame is a special non-displaying frame. It
1051 will be current in daemon mode when there are no frames
1052 to display, and in non-daemon mode before the real frame
1053 has finished initializing. If an error is thrown in the
1054 latter case while creating the frame, then the frame
1055 will never be displayed, so the safest thing to do is
1056 write to stderr and quit. In daemon mode, there are
1057 many other potential errors that do not prevent frames
1058 from being created, so continuing as normal is better in
1060 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1063 print_error_message (data
, Qexternal_debugging_output
,
1064 context
, Vsignaling_function
);
1065 Fterpri (Qexternal_debugging_output
);
1066 Fkill_emacs (make_number (-1));
1070 clear_message (1, 0);
1072 message_log_maybe_newline ();
1075 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1078 Vsignaling_function
= Qnil
;
1081 Lisp_Object
command_loop_1 (void);
1082 Lisp_Object
command_loop_2 (Lisp_Object
);
1083 Lisp_Object
top_level_1 (Lisp_Object
);
1085 /* Entry to editor-command-loop.
1086 This level has the catches for exiting/returning to editor command loop.
1087 It returns nil to exit recursive edit, t to abort it. */
1092 if (command_loop_level
> 0 || minibuf_level
> 0)
1095 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1096 executing_kbd_macro
= Qnil
;
1102 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1103 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1104 /* Reset single_kboard in case top-level set it while
1105 evaluating an -f option, or we are stuck there for some
1107 any_kboard_state ();
1109 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1110 executing_kbd_macro
= Qnil
;
1112 /* End of file in -batch run causes exit here. */
1118 /* Here we catch errors in execution of commands within the
1119 editing loop, and reenter the editing loop.
1120 When there is an error, cmd_error runs and returns a non-nil
1121 value to us. A value of nil means that command_loop_1 itself
1122 returned due to end of file (or end of kbd macro). */
1125 command_loop_2 (Lisp_Object ignore
)
1127 register Lisp_Object val
;
1130 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1131 while (!NILP (val
));
1139 return Feval (Vtop_level
);
1143 top_level_1 (Lisp_Object ignore
)
1145 /* On entry to the outer level, run the startup file */
1146 if (!NILP (Vtop_level
))
1147 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1148 else if (!NILP (Vpurify_flag
))
1149 message ("Bare impure Emacs (standard Lisp code not loaded)");
1151 message ("Bare Emacs (standard Lisp code not loaded)");
1155 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1156 doc
: /* Exit all recursive editing levels.
1157 This also exits all active minibuffers. */)
1160 #ifdef HAVE_WINDOW_SYSTEM
1161 if (display_hourglass_p
)
1162 cancel_hourglass ();
1165 /* Unblock input if we enter with input blocked. This may happen if
1166 redisplay traps e.g. during tool-bar update with input blocked. */
1167 while (INPUT_BLOCKED_P
)
1170 Fthrow (Qtop_level
, Qnil
);
1173 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1174 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1177 if (command_loop_level
> 0 || minibuf_level
> 0)
1178 Fthrow (Qexit
, Qnil
);
1180 error ("No recursive edit is in progress");
1183 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1184 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1187 if (command_loop_level
> 0 || minibuf_level
> 0)
1190 error ("No recursive edit is in progress");
1193 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1195 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1196 of this function. */
1199 tracking_off (Lisp_Object old_value
)
1201 do_mouse_tracking
= old_value
;
1202 if (NILP (old_value
))
1204 /* Redisplay may have been preempted because there was input
1205 available, and it assumes it will be called again after the
1206 input has been processed. If the only input available was
1207 the sort that we have just disabled, then we need to call
1209 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1211 redisplay_preserve_echo_area (6);
1212 get_input_pending (&input_pending
,
1213 READABLE_EVENTS_DO_TIMERS_NOW
);
1219 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1220 doc
: /* Evaluate BODY with mouse movement events enabled.
1221 Within a `track-mouse' form, mouse motion generates input events that
1222 you can read with `read-event'.
1223 Normally, mouse motion is ignored.
1224 usage: (track-mouse BODY...) */)
1227 int count
= SPECPDL_INDEX ();
1230 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1232 do_mouse_tracking
= Qt
;
1234 val
= Fprogn (args
);
1235 return unbind_to (count
, val
);
1238 /* If mouse has moved on some frame, return one of those frames.
1242 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1243 after resizing the tool-bar window. */
1245 int ignore_mouse_drag_p
;
1248 some_mouse_moved (void)
1250 Lisp_Object tail
, frame
;
1252 if (ignore_mouse_drag_p
)
1254 /* ignore_mouse_drag_p = 0; */
1258 FOR_EACH_FRAME (tail
, frame
)
1260 if (XFRAME (frame
)->mouse_moved
)
1261 return XFRAME (frame
);
1267 #endif /* HAVE_MOUSE || HAVE_GPM */
1269 /* This is the actual command reading loop,
1270 sans error-handling encapsulation. */
1272 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1274 void safe_run_hooks (Lisp_Object
);
1275 static void adjust_point_for_property (EMACS_INT
, int);
1277 /* Cancel hourglass from protect_unwind.
1279 #ifdef HAVE_WINDOW_SYSTEM
1281 cancel_hourglass_unwind (Lisp_Object arg
)
1283 cancel_hourglass ();
1288 /* FIXME: This is wrong rather than test window-system, we should call
1289 a new set-selection, which will then dispatch to x-set-selection, or
1290 tty-set-selection, or w32-set-selection, ... */
1291 EXFUN (Fwindow_system
, 1);
1294 command_loop_1 (void)
1297 Lisp_Object keybuf
[30];
1299 int prev_modiff
= 0;
1300 struct buffer
*prev_buffer
= NULL
;
1301 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1302 int was_locked
= single_kboard
;
1304 int already_adjusted
= 0;
1306 current_kboard
->Vprefix_arg
= Qnil
;
1307 current_kboard
->Vlast_prefix_arg
= Qnil
;
1308 Vdeactivate_mark
= Qnil
;
1309 waiting_for_input
= 0;
1312 this_command_key_count
= 0;
1313 this_command_key_count_reset
= 0;
1314 this_single_command_key_start
= 0;
1316 if (NILP (Vmemory_full
))
1318 /* Make sure this hook runs after commands that get errors and
1319 throw to top level. */
1320 /* Note that the value cell will never directly contain nil
1321 if the symbol is a local variable. */
1322 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1323 safe_run_hooks (Qpost_command_hook
);
1325 /* If displaying a message, resize the echo area window to fit
1326 that message's size exactly. */
1327 if (!NILP (echo_area_buffer
[0]))
1328 resize_echo_area_exactly ();
1330 if (!NILP (Vdeferred_action_list
))
1331 safe_run_hooks (Qdeferred_action_function
);
1334 /* Do this after running Vpost_command_hook, for consistency. */
1335 current_kboard
->Vlast_command
= Vthis_command
;
1336 current_kboard
->Vreal_last_command
= real_this_command
;
1337 if (!CONSP (last_command_event
))
1338 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1342 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1345 /* Make sure the current window's buffer is selected. */
1346 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1347 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1349 /* Display any malloc warning that just came out. Use while because
1350 displaying one warning can cause another. */
1352 while (pending_malloc_warning
)
1353 display_malloc_warning ();
1355 Vdeactivate_mark
= Qnil
;
1357 /* If minibuffer on and echo area in use,
1358 wait a short time and redraw minibuffer. */
1361 && !NILP (echo_area_buffer
[0])
1362 && EQ (minibuf_window
, echo_area_window
)
1363 && NUMBERP (Vminibuffer_message_timeout
))
1365 /* Bind inhibit-quit to t so that C-g gets read in
1366 rather than quitting back to the minibuffer. */
1367 int count
= SPECPDL_INDEX ();
1368 specbind (Qinhibit_quit
, Qt
);
1370 sit_for (Vminibuffer_message_timeout
, 0, 2);
1372 /* Clear the echo area. */
1374 safe_run_hooks (Qecho_area_clear_hook
);
1376 unbind_to (count
, Qnil
);
1378 /* If a C-g came in before, treat it as input now. */
1379 if (!NILP (Vquit_flag
))
1382 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1387 /* Select the frame that the last event came from. Usually,
1388 switch-frame events will take care of this, but if some lisp
1389 code swallows a switch-frame event, we'll fix things up here.
1390 Is this a good idea? */
1391 if (FRAMEP (internal_last_event_frame
)
1392 && !EQ (internal_last_event_frame
, selected_frame
))
1393 Fselect_frame (internal_last_event_frame
, Qnil
);
1395 /* If it has changed current-menubar from previous value,
1396 really recompute the menubar from the value. */
1397 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1398 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1399 call0 (Qrecompute_lucid_menubar
);
1401 before_command_key_count
= this_command_key_count
;
1402 before_command_echo_length
= echo_length ();
1404 Vthis_command
= Qnil
;
1405 real_this_command
= Qnil
;
1406 Vthis_original_command
= Qnil
;
1407 Vthis_command_keys_shift_translated
= Qnil
;
1409 /* Read next key sequence; i gets its length. */
1410 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1413 /* A filter may have run while we were reading the input. */
1414 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1416 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1417 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1421 /* Now we have read a key sequence of length I,
1422 or else I is 0 and we found end of file. */
1424 if (i
== 0) /* End of file -- happens only in */
1425 return Qnil
; /* a kbd macro, at the end. */
1426 /* -1 means read_key_sequence got a menu that was rejected.
1427 Just loop around and read another command. */
1431 this_command_key_count
= 0;
1432 this_command_key_count_reset
= 0;
1433 this_single_command_key_start
= 0;
1437 last_command_event
= keybuf
[i
- 1];
1439 /* If the previous command tried to force a specific window-start,
1440 forget about that, in case this command moves point far away
1441 from that position. But also throw away beg_unchanged and
1442 end_unchanged information in that case, so that redisplay will
1443 update the whole window properly. */
1444 if (!NILP (XWINDOW (selected_window
)->force_start
))
1447 XWINDOW (selected_window
)->force_start
= Qnil
;
1448 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1449 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1452 cmd
= read_key_sequence_cmd
;
1453 if (!NILP (Vexecuting_kbd_macro
))
1455 if (!NILP (Vquit_flag
))
1457 Vexecuting_kbd_macro
= Qt
;
1458 QUIT
; /* Make some noise. */
1459 /* Will return since macro now empty. */
1463 /* Do redisplay processing after this command except in special
1464 cases identified below. */
1465 prev_buffer
= current_buffer
;
1466 prev_modiff
= MODIFF
;
1467 last_point_position
= PT
;
1468 last_point_position_window
= selected_window
;
1469 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1471 /* By default, we adjust point to a boundary of a region that
1472 has such a property that should be treated intangible
1473 (e.g. composition, display). But, some commands will set
1474 this variable differently. */
1475 Vdisable_point_adjustment
= Qnil
;
1477 /* Process filters and timers may have messed with deactivate-mark.
1478 reset it before we execute the command. */
1479 Vdeactivate_mark
= Qnil
;
1481 /* Remap command through active keymaps */
1482 Vthis_original_command
= cmd
;
1486 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1490 /* Execute the command. */
1492 Vthis_command
= cmd
;
1493 real_this_command
= cmd
;
1494 /* Note that the value cell will never directly contain nil
1495 if the symbol is a local variable. */
1496 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1497 safe_run_hooks (Qpre_command_hook
);
1499 already_adjusted
= 0;
1501 if (NILP (Vthis_command
))
1503 /* nil means key is undefined. */
1504 Lisp_Object keys
= Fvector (i
, keybuf
);
1505 keys
= Fkey_description (keys
, Qnil
);
1507 message_with_string ("%s is undefined", keys
, 0);
1508 current_kboard
->defining_kbd_macro
= Qnil
;
1509 update_mode_lines
= 1;
1510 current_kboard
->Vprefix_arg
= Qnil
;
1514 /* Here for a command that isn't executed directly */
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 int scount
= SPECPDL_INDEX ();
1519 if (display_hourglass_p
1520 && NILP (Vexecuting_kbd_macro
))
1522 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1527 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1529 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1531 #ifdef HAVE_WINDOW_SYSTEM
1532 /* Do not check display_hourglass_p here, because
1533 Fcommand_execute could change it, but we should cancel
1534 hourglass cursor anyway.
1535 But don't cancel the hourglass within a macro
1536 just because a command in the macro finishes. */
1537 if (NILP (Vexecuting_kbd_macro
))
1538 unbind_to (scount
, Qnil
);
1541 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1543 /* Note that the value cell will never directly contain nil
1544 if the symbol is a local variable. */
1545 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1546 safe_run_hooks (Qpost_command_hook
);
1548 /* If displaying a message, resize the echo area window to fit
1549 that message's size exactly. */
1550 if (!NILP (echo_area_buffer
[0]))
1551 resize_echo_area_exactly ();
1553 if (!NILP (Vdeferred_action_list
))
1554 safe_run_hooks (Qdeferred_action_function
);
1556 /* If there is a prefix argument,
1557 1) We don't want Vlast_command to be ``universal-argument''
1558 (that would be dumb), so don't set Vlast_command,
1559 2) we want to leave echoing on so that the prefix will be
1560 echoed as part of this key sequence, so don't call
1562 3) we want to leave this_command_key_count non-zero, so that
1563 read_char will realize that it is re-reading a character, and
1564 not echo it a second time.
1566 If the command didn't actually create a prefix arg,
1567 but is merely a frame event that is transparent to prefix args,
1568 then the above doesn't apply. */
1569 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1571 current_kboard
->Vlast_command
= Vthis_command
;
1572 current_kboard
->Vreal_last_command
= real_this_command
;
1573 if (!CONSP (last_command_event
))
1574 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1576 this_command_key_count
= 0;
1577 this_command_key_count_reset
= 0;
1578 this_single_command_key_start
= 0;
1581 if (!NILP (current_buffer
->mark_active
)
1582 && !NILP (Vrun_hooks
))
1584 /* In Emacs 22, setting transient-mark-mode to `only' was a
1585 way of turning it on for just one command. This usage is
1586 obsolete, but support it anyway. */
1587 if (EQ (Vtransient_mark_mode
, Qidentity
))
1588 Vtransient_mark_mode
= Qnil
;
1589 else if (EQ (Vtransient_mark_mode
, Qonly
))
1590 Vtransient_mark_mode
= Qidentity
;
1592 if (!NILP (Vdeactivate_mark
))
1593 /* If `select-active-regions' is non-nil, this call to
1594 `deactivate-mark' also sets the PRIMARY selection. */
1595 call0 (Qdeactivate_mark
);
1598 /* Even if not deactivating the mark, set PRIMARY if
1599 `select-active-regions' is non-nil. */
1600 if (!NILP (Fwindow_system (Qnil
))
1601 /* Even if mark_active is non-nil, the actual buffer
1602 marker may not have been set yet (Bug#7044). */
1603 && XMARKER (current_buffer
->mark
)->buffer
1604 && (EQ (Vselect_active_regions
, Qonly
)
1605 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1606 : (!NILP (Vselect_active_regions
)
1607 && !NILP (Vtransient_mark_mode
)))
1608 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1611 XINT (Fmarker_position (current_buffer
->mark
));
1614 call2 (Qx_set_selection
, QPRIMARY
,
1615 make_buffer_string (beg
, end
, 0));
1617 call2 (Qx_set_selection
, QPRIMARY
,
1618 make_buffer_string (end
, beg
, 0));
1619 /* Don't set empty selections. */
1622 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1623 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1626 Vsaved_region_selection
= Qnil
;
1631 if (current_buffer
== prev_buffer
1632 && last_point_position
!= PT
1633 && NILP (Vdisable_point_adjustment
)
1634 && NILP (Vglobal_disable_point_adjustment
))
1636 if (last_point_position
> BEGV
1637 && last_point_position
< ZV
1638 && (composition_adjust_point (last_point_position
,
1639 last_point_position
)
1640 != last_point_position
))
1641 /* The last point was temporarily set within a grapheme
1642 cluster to prevent automatic composition. To recover
1643 the automatic composition, we must update the
1645 windows_or_buffers_changed
++;
1646 if (!already_adjusted
)
1647 adjust_point_for_property (last_point_position
,
1648 MODIFF
!= prev_modiff
);
1651 /* Install chars successfully executed in kbd macro. */
1653 if (!NILP (current_kboard
->defining_kbd_macro
)
1654 && NILP (current_kboard
->Vprefix_arg
))
1655 finalize_kbd_macro_chars ();
1656 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1658 any_kboard_state ();
1663 /* Adjust point to a boundary of a region that has such a property
1664 that should be treated intangible. For the moment, we check
1665 `composition', `display' and `invisible' properties.
1666 LAST_PT is the last position of point. */
1669 adjust_point_for_property (EMACS_INT last_pt
, int modified
)
1672 Lisp_Object val
, overlay
, tmp
;
1673 /* When called after buffer modification, we should temporarily
1674 suppress the point adjustment for automatic composition so that a
1675 user can keep inserting another character at point or keep
1676 deleting characters around point. */
1677 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1678 EMACS_INT orig_pt
= PT
;
1680 /* FIXME: cycling is probably not necessary because these properties
1681 can't be usefully combined anyway. */
1682 while (check_composition
|| check_display
|| check_invisible
)
1684 /* FIXME: check `intangible'. */
1685 if (check_composition
1686 && PT
> BEGV
&& PT
< ZV
1687 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1690 check_display
= check_invisible
= 1;
1692 check_composition
= 0;
1694 && PT
> BEGV
&& PT
< ZV
1695 && !NILP (val
= get_char_property_and_overlay
1696 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1697 && display_prop_intangible_p (val
)
1698 && (!OVERLAYP (overlay
)
1699 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1700 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1701 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1702 && (beg
< PT
/* && end > PT <- It's always the case. */
1703 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1706 SET_PT (PT
< last_pt
1707 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1709 check_composition
= check_invisible
= 1;
1712 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1714 int inv
, ellipsis
= 0;
1717 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1720 /* FIXME: We should stop if we find a spot between
1721 two runs of `invisible' where inserted text would
1722 be visible. This is important when we have two
1723 invisible boundaries that enclose an area: if the
1724 area is empty, we need this test in order to make
1725 it possible to place point in the middle rather
1726 than skip both boundaries. However, this code
1727 also stops anywhere in a non-sticky text-property,
1728 which breaks (e.g.) Org mode. */
1729 && (val
= get_pos_property (make_number (end
),
1731 TEXT_PROP_MEANS_INVISIBLE (val
))
1733 && !NILP (val
= get_char_property_and_overlay
1734 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1735 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1737 ellipsis
= ellipsis
|| inv
> 1
1738 || (OVERLAYP (overlay
)
1739 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1740 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1741 tmp
= Fnext_single_char_property_change
1742 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1743 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1747 && (val
= get_pos_property (make_number (beg
),
1749 TEXT_PROP_MEANS_INVISIBLE (val
))
1751 && !NILP (val
= get_char_property_and_overlay
1752 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1753 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1755 ellipsis
= ellipsis
|| inv
> 1
1756 || (OVERLAYP (overlay
)
1757 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1758 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1759 tmp
= Fprevious_single_char_property_change
1760 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1761 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1764 /* Move away from the inside area. */
1765 if (beg
< PT
&& end
> PT
)
1767 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1768 /* We haven't moved yet (so we don't need to fear
1769 infinite-looping) and we were outside the range
1770 before (so either end of the range still corresponds
1771 to a move in the right direction): pretend we moved
1772 less than we actually did, so that we still have
1773 more freedom below in choosing which end of the range
1775 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1776 /* We either have moved already or the last point
1777 was already in the range: we don't get to choose
1778 which end of the range we have to go to. */
1779 : (PT
< last_pt
? beg
: end
));
1780 check_composition
= check_display
= 1;
1782 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1783 the point to something other than its argument, due to
1784 point-motion hooks, intangibility, etc. */
1785 xassert (PT
== beg
|| PT
== end
);
1788 /* Pretend the area doesn't exist if the buffer is not
1790 if (!modified
&& !ellipsis
&& beg
< end
)
1792 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1793 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1794 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1795 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1796 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1797 /* We've already moved as far as we can. Trying to go
1798 to the other end would mean moving backwards and thus
1799 could lead to an infinite loop. */
1801 else if (val
= get_pos_property (make_number (PT
),
1803 TEXT_PROP_MEANS_INVISIBLE (val
)
1804 && (val
= get_pos_property
1805 (make_number (PT
== beg
? end
: beg
),
1807 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1808 (check_composition
= check_display
= 1,
1809 SET_PT (PT
== beg
? end
: beg
));
1812 check_invisible
= 0;
1816 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1819 safe_run_hooks_1 (void)
1821 if (NILP (Vrun_hooks
))
1823 return call1 (Vrun_hooks
, Vinhibit_quit
);
1826 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1829 safe_run_hooks_error (Lisp_Object data
)
1831 Lisp_Object args
[3];
1832 args
[0] = build_string ("Error in %s: %s");
1833 args
[1] = Vinhibit_quit
;
1836 return Fset (Vinhibit_quit
, Qnil
);
1839 /* If we get an error while running the hook, cause the hook variable
1840 to be nil. Also inhibit quits, so that C-g won't cause the hook
1841 to mysteriously evaporate. */
1844 safe_run_hooks (Lisp_Object hook
)
1846 int count
= SPECPDL_INDEX ();
1847 specbind (Qinhibit_quit
, hook
);
1849 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1851 unbind_to (count
, Qnil
);
1855 /* Nonzero means polling for input is temporarily suppressed. */
1857 int poll_suppress_count
;
1859 /* Asynchronous timer for polling. */
1861 struct atimer
*poll_timer
;
1864 #ifdef POLL_FOR_INPUT
1866 /* Poll for input, so that we catch a C-g if it comes in. This
1867 function is called from x_make_frame_visible, see comment
1871 poll_for_input_1 (void)
1873 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1874 doing anything dangerous. */
1878 if (interrupt_input_blocked
== 0
1879 && !waiting_for_input
)
1880 read_avail_input (0);
1886 /* Timer callback function for poll_timer. TIMER is equal to
1890 poll_for_input (struct atimer
*timer
)
1892 if (poll_suppress_count
== 0)
1895 interrupt_input_pending
= 1;
1896 pending_signals
= 1;
1898 poll_for_input_1 ();
1903 #endif /* POLL_FOR_INPUT */
1905 /* Begin signals to poll for input, if they are appropriate.
1906 This function is called unconditionally from various places. */
1909 start_polling (void)
1911 #ifdef POLL_FOR_INPUT
1912 /* XXX This condition was (read_socket_hook && !interrupt_input),
1913 but read_socket_hook is not global anymore. Let's pretend that
1915 if (!interrupt_input
)
1917 /* Turn alarm handling on unconditionally. It might have
1918 been turned off in process.c. */
1919 turn_on_atimers (1);
1921 /* If poll timer doesn't exist, are we need one with
1922 a different interval, start a new one. */
1923 if (poll_timer
== NULL
1924 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1926 EMACS_TIME interval
;
1929 cancel_atimer (poll_timer
);
1931 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1932 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1933 poll_for_input
, NULL
);
1936 /* Let the timer's callback function poll for input
1937 if this becomes zero. */
1938 --poll_suppress_count
;
1943 /* Nonzero if we are using polling to handle input asynchronously. */
1946 input_polling_used (void)
1948 #ifdef POLL_FOR_INPUT
1949 /* XXX This condition was (read_socket_hook && !interrupt_input),
1950 but read_socket_hook is not global anymore. Let's pretend that
1952 return !interrupt_input
;
1958 /* Turn off polling. */
1963 #ifdef POLL_FOR_INPUT
1964 /* XXX This condition was (read_socket_hook && !interrupt_input),
1965 but read_socket_hook is not global anymore. Let's pretend that
1967 if (!interrupt_input
)
1968 ++poll_suppress_count
;
1972 /* Set the value of poll_suppress_count to COUNT
1973 and start or stop polling accordingly. */
1976 set_poll_suppress_count (int count
)
1978 #ifdef POLL_FOR_INPUT
1979 if (count
== 0 && poll_suppress_count
!= 0)
1981 poll_suppress_count
= 1;
1984 else if (count
!= 0 && poll_suppress_count
== 0)
1988 poll_suppress_count
= count
;
1992 /* Bind polling_period to a value at least N.
1993 But don't decrease it. */
1996 bind_polling_period (int n
)
1998 #ifdef POLL_FOR_INPUT
1999 int new = polling_period
;
2004 stop_other_atimers (poll_timer
);
2006 specbind (Qpolling_period
, make_number (new));
2007 /* Start a new alarm with the new period. */
2012 /* Apply the control modifier to CHARACTER. */
2015 make_ctrl_char (int c
)
2017 /* Save the upper bits here. */
2018 int upper
= c
& ~0177;
2020 if (! ASCII_BYTE_P (c
))
2021 return c
|= ctrl_modifier
;
2025 /* Everything in the columns containing the upper-case letters
2026 denotes a control character. */
2027 if (c
>= 0100 && c
< 0140)
2031 /* Set the shift modifier for a control char
2032 made from a shifted letter. But only for letters! */
2033 if (oc
>= 'A' && oc
<= 'Z')
2034 c
|= shift_modifier
;
2037 /* The lower-case letters denote control characters too. */
2038 else if (c
>= 'a' && c
<= 'z')
2041 /* Include the bits for control and shift
2042 only if the basic ASCII code can't indicate them. */
2046 /* Replace the high bits. */
2047 c
|= (upper
& ~ctrl_modifier
);
2052 /* Display the help-echo property of the character after the mouse pointer.
2053 Either show it in the echo area, or call show-help-function to display
2054 it by other means (maybe in a tooltip).
2056 If HELP is nil, that means clear the previous help echo.
2058 If HELP is a string, display that string. If HELP is a function,
2059 call it with OBJECT and POS as arguments; the function should
2060 return a help string or nil for none. For all other types of HELP,
2061 evaluate it to obtain a string.
2063 WINDOW is the window in which the help was generated, if any.
2064 It is nil if not in a window.
2066 If OBJECT is a buffer, POS is the position in the buffer where the
2067 `help-echo' text property was found.
2069 If OBJECT is an overlay, that overlay has a `help-echo' property,
2070 and POS is the position in the overlay's buffer under the mouse.
2072 If OBJECT is a string (an overlay string or a string displayed with
2073 the `display' property). POS is the position in that string under
2076 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2077 echo overwrites a keystroke echo currently displayed in the echo
2080 Note: this function may only be called with HELP nil or a string
2081 from X code running asynchronously. */
2084 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2085 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2087 if (!NILP (help
) && !STRINGP (help
))
2089 if (FUNCTIONP (help
))
2091 Lisp_Object args
[4];
2096 help
= safe_call (4, args
);
2099 help
= safe_eval (help
);
2101 if (!STRINGP (help
))
2105 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2106 if (!noninteractive
&& STRINGP (help
))
2108 /* The mouse-fixup-help-message Lisp function can call
2109 mouse_position_hook, which resets the mouse_moved flags.
2110 This causes trouble if we are trying to read a mouse motion
2111 event (i.e., if we are inside a `track-mouse' form), so we
2112 restore the mouse_moved flag. */
2113 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2114 help
= call1 (Qmouse_fixup_help_message
, help
);
2120 if (STRINGP (help
) || NILP (help
))
2122 if (!NILP (Vshow_help_function
))
2123 call1 (Vshow_help_function
, help
);
2124 help_echo_showing_p
= STRINGP (help
);
2130 /* Input of single characters from keyboard */
2132 Lisp_Object
print_help (Lisp_Object object
);
2133 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2134 struct timeval
*end_time
);
2135 static void record_char (Lisp_Object c
);
2137 static Lisp_Object help_form_saved_window_configs
;
2139 read_char_help_form_unwind (Lisp_Object arg
)
2141 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2142 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2143 if (!NILP (window_config
))
2144 Fset_window_configuration (window_config
);
2148 #define STOP_POLLING \
2149 do { if (! polling_stopped_here) stop_polling (); \
2150 polling_stopped_here = 1; } while (0)
2152 #define RESUME_POLLING \
2153 do { if (polling_stopped_here) start_polling (); \
2154 polling_stopped_here = 0; } while (0)
2156 /* read a character from the keyboard; call the redisplay if needed */
2157 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2158 -1 means do not do redisplay, but do do autosaving.
2161 /* The arguments MAPS and NMAPS are for menu prompting.
2162 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2164 PREV_EVENT is the previous input event, or nil if we are reading
2165 the first event of a key sequence (or not reading a key sequence).
2166 If PREV_EVENT is t, that is a "magic" value that says
2167 not to run input methods, but in other respects to act as if
2168 not reading a key sequence.
2170 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2171 if we used a mouse menu to read the input, or zero otherwise. If
2172 USED_MOUSE_MENU is null, we don't dereference it.
2174 Value is -2 when we find input on another keyboard. A second call
2175 to read_char will read it.
2177 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2178 specifying the maximum time to wait until. If no input arrives by
2179 that time, stop waiting and return nil.
2181 Value is t if we showed a menu and the user rejected it. */
2184 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2185 int *used_mouse_menu
, struct timeval
*end_time
)
2187 volatile Lisp_Object c
;
2188 int count
, jmpcount
;
2189 jmp_buf local_getcjmp
;
2191 volatile int key_already_recorded
= 0;
2192 Lisp_Object tem
, save
;
2193 volatile Lisp_Object previous_echo_area_message
;
2194 volatile Lisp_Object also_record
;
2195 volatile int reread
;
2196 struct gcpro gcpro1
, gcpro2
;
2197 int polling_stopped_here
= 0;
2198 struct kboard
*orig_kboard
= current_kboard
;
2202 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2203 before_command_key_count
= this_command_key_count
;
2204 before_command_echo_length
= echo_length ();
2207 previous_echo_area_message
= Qnil
;
2209 GCPRO2 (c
, previous_echo_area_message
);
2214 if (CONSP (Vunread_post_input_method_events
))
2216 c
= XCAR (Vunread_post_input_method_events
);
2217 Vunread_post_input_method_events
2218 = XCDR (Vunread_post_input_method_events
);
2220 /* Undo what read_char_x_menu_prompt did when it unread
2221 additional keys returned by Fx_popup_menu. */
2223 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2231 if (unread_command_char
!= -1)
2233 XSETINT (c
, unread_command_char
);
2234 unread_command_char
= -1;
2240 if (CONSP (Vunread_command_events
))
2242 int was_disabled
= 0;
2244 c
= XCAR (Vunread_command_events
);
2245 Vunread_command_events
= XCDR (Vunread_command_events
);
2249 /* Undo what sit-for did when it unread additional keys
2250 inside universal-argument. */
2253 && EQ (XCAR (c
), Qt
))
2259 /* Undo what read_char_x_menu_prompt did when it unread
2260 additional keys returned by Fx_popup_menu. */
2262 && EQ (XCDR (c
), Qdisabled
)
2263 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2269 /* If the queued event is something that used the mouse,
2270 set used_mouse_menu accordingly. */
2272 /* Also check was_disabled so last-nonmenu-event won't return
2273 a bad value when submenus are involved. (Bug#447) */
2274 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2275 *used_mouse_menu
= 1;
2277 goto reread_for_input_method
;
2280 if (CONSP (Vunread_input_method_events
))
2282 c
= XCAR (Vunread_input_method_events
);
2283 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2285 /* Undo what read_char_x_menu_prompt did when it unread
2286 additional keys returned by Fx_popup_menu. */
2288 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2292 goto reread_for_input_method
;
2295 this_command_key_count_reset
= 0;
2297 if (!NILP (Vexecuting_kbd_macro
))
2299 /* We set this to Qmacro; since that's not a frame, nobody will
2300 try to switch frames on us, and the selected window will
2303 Since this event came from a macro, it would be misleading to
2304 leave internal_last_event_frame set to wherever the last
2305 real event came from. Normally, a switch-frame event selects
2306 internal_last_event_frame after each command is read, but
2307 events read from a macro should never cause a new frame to be
2309 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2311 /* Exit the macro if we are at the end.
2312 Also, some things replace the macro with t
2313 to force an early exit. */
2314 if (EQ (Vexecuting_kbd_macro
, Qt
)
2315 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2321 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2322 if (STRINGP (Vexecuting_kbd_macro
)
2323 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2324 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2326 executing_kbd_macro_index
++;
2331 if (!NILP (unread_switch_frame
))
2333 c
= unread_switch_frame
;
2334 unread_switch_frame
= Qnil
;
2336 /* This event should make it into this_command_keys, and get echoed
2337 again, so we do not set `reread'. */
2341 /* if redisplay was requested */
2342 if (commandflag
>= 0)
2344 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2346 /* If there is pending input, process any events which are not
2347 user-visible, such as X selection_request events. */
2349 || detect_input_pending_run_timers (0))
2350 swallow_events (0); /* may clear input_pending */
2352 /* Redisplay if no pending input. */
2353 while (!input_pending
)
2355 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2356 redisplay_preserve_echo_area (5);
2361 /* Normal case: no input arrived during redisplay. */
2364 /* Input arrived and pre-empted redisplay.
2365 Process any events which are not user-visible. */
2367 /* If that cleared input_pending, try again to redisplay. */
2370 /* Prevent the redisplay we just did
2371 from messing up echoing of the input after the prompt. */
2372 if (commandflag
== 0 && echo_current
)
2373 echo_message_buffer
= echo_area_buffer
[0];
2377 /* Message turns off echoing unless more keystrokes turn it on again.
2379 The code in 20.x for the condition was
2381 1. echo_area_glyphs && *echo_area_glyphs
2382 2. && echo_area_glyphs != current_kboard->echobuf
2383 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2385 (1) means there's a current message displayed
2387 (2) means it's not the message from echoing from the current
2390 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2391 is set to a non-null value. This is done in read_char and it is
2392 set to echo_area_glyphs after a call to echo_char. That means
2393 ok_to_echo_at_next_pause is either null or
2394 current_kboard->echobuf with the appropriate current_kboard at
2397 So, condition (3) means in clear text ok_to_echo_at_next_pause
2398 must be either null, or the current message isn't from echoing at
2399 all, or it's from echoing from a different kboard than the
2402 if (/* There currently is something in the echo area. */
2403 !NILP (echo_area_buffer
[0])
2404 && (/* And it's either not from echoing. */
2405 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2406 /* Or it's an echo from a different kboard. */
2407 || echo_kboard
!= current_kboard
2408 /* Or we explicitly allow overwriting whatever there is. */
2409 || ok_to_echo_at_next_pause
== NULL
))
2414 /* Try reading a character via menu prompting in the minibuf.
2415 Try this before the sit-for, because the sit-for
2416 would do the wrong thing if we are supposed to do
2417 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2418 after a mouse event so don't try a minibuf menu. */
2420 if (nmaps
> 0 && INTERACTIVE
2421 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2422 /* Don't bring up a menu if we already have another event. */
2423 && NILP (Vunread_command_events
)
2424 && unread_command_char
< 0
2425 && !detect_input_pending_run_timers (0))
2427 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2429 if (INTEGERP (c
) && XINT (c
) == -2)
2430 return c
; /* wrong_kboard_jmpbuf */
2434 key_already_recorded
= 1;
2439 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2440 We will do that below, temporarily for short sections of code,
2441 when appropriate. local_getcjmp must be in effect
2442 around any call to sit_for or kbd_buffer_get_event;
2443 it *must not* be in effect when we call redisplay. */
2445 jmpcount
= SPECPDL_INDEX ();
2446 if (_setjmp (local_getcjmp
))
2448 /* Handle quits while reading the keyboard. */
2449 /* We must have saved the outer value of getcjmp here,
2450 so restore it now. */
2451 restore_getcjmp (save_jump
);
2452 unbind_to (jmpcount
, Qnil
);
2453 XSETINT (c
, quit_char
);
2454 internal_last_event_frame
= selected_frame
;
2455 Vlast_event_frame
= internal_last_event_frame
;
2456 /* If we report the quit char as an event,
2457 don't do so more than once. */
2458 if (!NILP (Vinhibit_quit
))
2462 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2463 if (kb
!= current_kboard
)
2465 Lisp_Object link
= kb
->kbd_queue
;
2466 /* We shouldn't get here if we were in single-kboard mode! */
2471 while (CONSP (XCDR (link
)))
2473 if (!NILP (XCDR (link
)))
2477 kb
->kbd_queue
= Fcons (c
, Qnil
);
2479 XSETCDR (link
, Fcons (c
, Qnil
));
2480 kb
->kbd_queue_has_data
= 1;
2481 current_kboard
= kb
;
2482 /* This is going to exit from read_char
2483 so we had better get rid of this frame's stuff. */
2485 return make_number (-2); /* wrong_kboard_jmpbuf */
2491 /* Start idle timers if no time limit is supplied. We don't do it
2492 if a time limit is supplied to avoid an infinite recursion in the
2493 situation where an idle timer calls `sit-for'. */
2496 timer_start_idle ();
2498 /* If in middle of key sequence and minibuffer not active,
2499 start echoing if enough time elapses. */
2501 if (minibuf_level
== 0
2503 && !current_kboard
->immediate_echo
2504 && this_command_key_count
> 0
2506 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2507 && NILP (Fzerop (Vecho_keystrokes
))
2508 && (/* No message. */
2509 NILP (echo_area_buffer
[0])
2510 /* Or empty message. */
2511 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2512 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2513 /* Or already echoing from same kboard. */
2514 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2515 /* Or not echoing before and echoing allowed. */
2516 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2518 /* After a mouse event, start echoing right away.
2519 This is because we are probably about to display a menu,
2520 and we don't want to delay before doing so. */
2521 if (EVENT_HAS_PARAMETERS (prev_event
))
2527 save_getcjmp (save_jump
);
2528 restore_getcjmp (local_getcjmp
);
2529 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2530 restore_getcjmp (save_jump
);
2532 && ! CONSP (Vunread_command_events
))
2537 /* Maybe auto save due to number of keystrokes. */
2539 if (commandflag
!= 0
2540 && auto_save_interval
> 0
2541 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2542 && !detect_input_pending_run_timers (0))
2544 Fdo_auto_save (Qnil
, Qnil
);
2545 /* Hooks can actually change some buffers in auto save. */
2549 /* Try reading using an X menu.
2550 This is never confused with reading using the minibuf
2551 because the recursive call of read_char in read_char_minibuf_menu_prompt
2552 does not pass on any keymaps. */
2554 if (nmaps
> 0 && INTERACTIVE
2555 && !NILP (prev_event
)
2556 && EVENT_HAS_PARAMETERS (prev_event
)
2557 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2558 && !EQ (XCAR (prev_event
), Qtool_bar
)
2559 /* Don't bring up a menu if we already have another event. */
2560 && NILP (Vunread_command_events
)
2561 && unread_command_char
< 0)
2563 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2565 /* Now that we have read an event, Emacs is not idle. */
2572 /* Maybe autosave and/or garbage collect due to idleness. */
2574 if (INTERACTIVE
&& NILP (c
))
2577 EMACS_INT buffer_size
;
2579 /* Slow down auto saves logarithmically in size of current buffer,
2580 and garbage collect while we're at it. */
2581 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2582 last_non_minibuf_size
= Z
- BEG
;
2583 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2585 while (buffer_size
> 64)
2586 delay_level
++, buffer_size
-= buffer_size
>> 2;
2587 if (delay_level
< 4) delay_level
= 4;
2588 /* delay_level is 4 for files under around 50k, 7 at 100k,
2589 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2591 /* Auto save if enough time goes by without input. */
2592 if (commandflag
!= 0
2593 && num_nonmacro_input_events
> last_auto_save
2594 && INTEGERP (Vauto_save_timeout
)
2595 && XINT (Vauto_save_timeout
) > 0)
2598 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2600 save_getcjmp (save_jump
);
2601 restore_getcjmp (local_getcjmp
);
2602 tem0
= sit_for (make_number (timeout
), 1, 1);
2603 restore_getcjmp (save_jump
);
2606 && ! CONSP (Vunread_command_events
))
2608 Fdo_auto_save (Qnil
, Qnil
);
2610 /* If we have auto-saved and there is still no input
2611 available, garbage collect if there has been enough
2612 consing going on to make it worthwhile. */
2613 if (!detect_input_pending_run_timers (0)
2614 && consing_since_gc
> gc_cons_threshold
/ 2)
2615 Fgarbage_collect ();
2622 /* Notify the caller if an autosave hook, or a timer, sentinel or
2623 filter in the sit_for calls above have changed the current
2624 kboard. This could happen if they use the minibuffer or start a
2625 recursive edit, like the fancy splash screen in server.el's
2626 filter. If this longjmp wasn't here, read_key_sequence would
2627 interpret the next key sequence using the wrong translation
2628 tables and function keymaps. */
2629 if (NILP (c
) && current_kboard
!= orig_kboard
)
2632 return make_number (-2); /* wrong_kboard_jmpbuf */
2635 /* If this has become non-nil here, it has been set by a timer
2636 or sentinel or filter. */
2637 if (CONSP (Vunread_command_events
))
2639 c
= XCAR (Vunread_command_events
);
2640 Vunread_command_events
= XCDR (Vunread_command_events
);
2643 /* Read something from current KBOARD's side queue, if possible. */
2647 if (current_kboard
->kbd_queue_has_data
)
2649 if (!CONSP (current_kboard
->kbd_queue
))
2651 c
= XCAR (current_kboard
->kbd_queue
);
2652 current_kboard
->kbd_queue
2653 = XCDR (current_kboard
->kbd_queue
);
2654 if (NILP (current_kboard
->kbd_queue
))
2655 current_kboard
->kbd_queue_has_data
= 0;
2656 input_pending
= readable_events (0);
2657 if (EVENT_HAS_PARAMETERS (c
)
2658 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2659 internal_last_event_frame
= XCAR (XCDR (c
));
2660 Vlast_event_frame
= internal_last_event_frame
;
2664 /* If current_kboard's side queue is empty check the other kboards.
2665 If one of them has data that we have not yet seen here,
2666 switch to it and process the data waiting for it.
2668 Note: if the events queued up for another kboard
2669 have already been seen here, and therefore are not a complete command,
2670 the kbd_queue_has_data field is 0, so we skip that kboard here.
2671 That's to avoid an infinite loop switching between kboards here. */
2672 if (NILP (c
) && !single_kboard
)
2675 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2676 if (kb
->kbd_queue_has_data
)
2678 current_kboard
= kb
;
2679 /* This is going to exit from read_char
2680 so we had better get rid of this frame's stuff. */
2682 return make_number (-2); /* wrong_kboard_jmpbuf */
2690 /* Finally, we read from the main queue,
2691 and if that gives us something we can't use yet, we put it on the
2692 appropriate side queue and try again. */
2701 EMACS_GET_TIME (now
);
2702 if (EMACS_TIME_GE (now
, *end_time
))
2706 /* Actually read a character, waiting if necessary. */
2707 save_getcjmp (save_jump
);
2708 restore_getcjmp (local_getcjmp
);
2710 timer_start_idle ();
2711 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2712 restore_getcjmp (save_jump
);
2714 if (! NILP (c
) && (kb
!= current_kboard
))
2716 Lisp_Object link
= kb
->kbd_queue
;
2719 while (CONSP (XCDR (link
)))
2721 if (!NILP (XCDR (link
)))
2725 kb
->kbd_queue
= Fcons (c
, Qnil
);
2727 XSETCDR (link
, Fcons (c
, Qnil
));
2728 kb
->kbd_queue_has_data
= 1;
2732 current_kboard
= kb
;
2733 /* This is going to exit from read_char
2734 so we had better get rid of this frame's stuff. */
2736 return make_number (-2);
2740 /* Terminate Emacs in batch mode if at eof. */
2741 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2742 Fkill_emacs (make_number (1));
2746 /* Add in any extra modifiers, where appropriate. */
2747 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2748 || ((extra_keyboard_modifiers
& 0177) < ' '
2749 && (extra_keyboard_modifiers
& 0177) != 0))
2750 XSETINT (c
, make_ctrl_char (XINT (c
)));
2752 /* Transfer any other modifier bits directly from
2753 extra_keyboard_modifiers to c. Ignore the actual character code
2754 in the low 16 bits of extra_keyboard_modifiers. */
2755 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2766 if (commandflag
>= 0
2767 && !input_pending
&& !detect_input_pending_run_timers (0))
2775 /* Buffer switch events are only for internal wakeups
2776 so don't show them to the user.
2777 Also, don't record a key if we already did. */
2778 if (BUFFERP (c
) || key_already_recorded
)
2781 /* Process special events within read_char
2782 and loop around to read another event. */
2785 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2790 struct buffer
*prev_buffer
= current_buffer
;
2791 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2792 int was_locked
= single_kboard
;
2793 int count
= SPECPDL_INDEX ();
2794 record_single_kboard_state ();
2797 last_input_event
= c
;
2798 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2800 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2801 /* We stopped being idle for this event; undo that. This
2802 prevents automatic window selection (under
2803 mouse_autoselect_window from acting as a real input event, for
2804 example banishing the mouse under mouse-avoidance-mode. */
2805 timer_resume_idle ();
2807 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2808 /* Resume allowing input from any kboard, if that was true before. */
2810 any_kboard_state ();
2811 unbind_to (count
, Qnil
);
2814 if (current_buffer
!= prev_buffer
)
2816 /* The command may have changed the keymaps. Pretend there
2817 is input in another keyboard and return. This will
2818 recalculate keymaps. */
2819 c
= make_number (-2);
2826 /* Handle things that only apply to characters. */
2829 /* If kbd_buffer_get_event gave us an EOF, return that. */
2833 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
2834 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2835 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
2836 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2837 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
2841 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
2842 /* nil in keyboard-translate-table means no translation. */
2848 /* If this event is a mouse click in the menu bar,
2849 return just menu-bar for now. Modify the mouse click event
2850 so we won't do this twice, then queue it up. */
2851 if (EVENT_HAS_PARAMETERS (c
)
2853 && CONSP (EVENT_START (c
))
2854 && CONSP (XCDR (EVENT_START (c
))))
2858 posn
= POSN_POSN (EVENT_START (c
));
2859 /* Handle menu-bar events:
2860 insert the dummy prefix event `menu-bar'. */
2861 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2863 /* Change menu-bar to (menu-bar) as the event "position". */
2864 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2867 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2872 /* Store these characters into recent_keys, the dribble file if any,
2873 and the keyboard macro being defined, if any. */
2875 if (! NILP (also_record
))
2876 record_char (also_record
);
2878 /* Wipe the echo area.
2879 But first, if we are about to use an input method,
2880 save the echo area contents for it to refer to. */
2882 && ! NILP (Vinput_method_function
)
2883 && (unsigned) XINT (c
) >= ' '
2884 && (unsigned) XINT (c
) != 127
2885 && (unsigned) XINT (c
) < 256)
2887 previous_echo_area_message
= Fcurrent_message ();
2888 Vinput_method_previous_message
= previous_echo_area_message
;
2891 /* Now wipe the echo area, except for help events which do their
2892 own stuff with the echo area. */
2894 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2895 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2897 if (!NILP (echo_area_buffer
[0]))
2898 safe_run_hooks (Qecho_area_clear_hook
);
2899 clear_message (1, 0);
2902 reread_for_input_method
:
2904 /* Pass this to the input method, if appropriate. */
2906 && ! NILP (Vinput_method_function
)
2907 /* Don't run the input method within a key sequence,
2908 after the first event of the key sequence. */
2909 && NILP (prev_event
)
2910 && (unsigned) XINT (c
) >= ' '
2911 && (unsigned) XINT (c
) != 127
2912 && (unsigned) XINT (c
) < 256)
2915 int key_count
, key_count_reset
;
2916 struct gcpro gcpro1
;
2917 int count
= SPECPDL_INDEX ();
2919 /* Save the echo status. */
2920 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2921 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2922 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
2923 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2926 if (before_command_restore_flag
)
2928 this_command_key_count
= before_command_key_count_1
;
2929 if (this_command_key_count
< this_single_command_key_start
)
2930 this_single_command_key_start
= this_command_key_count
;
2931 echo_truncate (before_command_echo_length_1
);
2932 before_command_restore_flag
= 0;
2936 /* Save the this_command_keys status. */
2937 key_count
= this_command_key_count
;
2938 key_count_reset
= this_command_key_count_reset
;
2941 keys
= Fcopy_sequence (this_command_keys
);
2946 /* Clear out this_command_keys. */
2947 this_command_key_count
= 0;
2948 this_command_key_count_reset
= 0;
2950 /* Now wipe the echo area. */
2951 if (!NILP (echo_area_buffer
[0]))
2952 safe_run_hooks (Qecho_area_clear_hook
);
2953 clear_message (1, 0);
2956 /* If we are not reading a key sequence,
2957 never use the echo area. */
2960 specbind (Qinput_method_use_echo_area
, Qt
);
2963 /* Call the input method. */
2964 tem
= call1 (Vinput_method_function
, c
);
2966 tem
= unbind_to (count
, tem
);
2968 /* Restore the saved echoing state
2969 and this_command_keys state. */
2970 this_command_key_count
= key_count
;
2971 this_command_key_count_reset
= key_count_reset
;
2973 this_command_keys
= keys
;
2976 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2977 current_kboard
->echo_string
= saved_echo_string
;
2978 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2979 if (saved_immediate_echo
)
2984 /* The input method can return no events. */
2987 /* Bring back the previous message, if any. */
2988 if (! NILP (previous_echo_area_message
))
2989 message_with_string ("%s", previous_echo_area_message
, 0);
2992 /* It returned one event or more. */
2994 Vunread_post_input_method_events
2995 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3000 /* Display help if not echoing. */
3001 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3003 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3004 Lisp_Object help
, object
, position
, window
, tem
;
3006 tem
= Fcdr (XCDR (c
));
3009 window
= Fcar (tem
);
3011 object
= Fcar (tem
);
3013 position
= Fcar (tem
);
3015 show_help_echo (help
, window
, object
, position
, 0);
3017 /* We stopped being idle for this event; undo that. */
3019 timer_resume_idle ();
3023 if ((! reread
|| this_command_key_count
== 0
3024 || this_command_key_count_reset
)
3028 /* Don't echo mouse motion events. */
3029 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3030 && NILP (Fzerop (Vecho_keystrokes
))
3031 && ! (EVENT_HAS_PARAMETERS (c
)
3032 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3035 if (! NILP (also_record
))
3036 echo_char (also_record
);
3037 /* Once we reread a character, echoing can happen
3038 the next time we pause to read a new one. */
3039 ok_to_echo_at_next_pause
= current_kboard
;
3042 /* Record this character as part of the current key. */
3043 add_command_key (c
);
3044 if (! NILP (also_record
))
3045 add_command_key (also_record
);
3048 last_input_event
= c
;
3051 /* Process the help character specially if enabled */
3052 if (!NILP (Vhelp_form
) && help_char_p (c
))
3055 count
= SPECPDL_INDEX ();
3057 help_form_saved_window_configs
3058 = Fcons (Fcurrent_window_configuration (Qnil
),
3059 help_form_saved_window_configs
);
3060 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3062 tem0
= Feval (Vhelp_form
);
3064 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3069 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3070 if (EVENT_HAS_PARAMETERS (c
)
3071 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3072 XSETCAR (help_form_saved_window_configs
, Qnil
);
3074 while (BUFFERP (c
));
3075 /* Remove the help from the frame */
3076 unbind_to (count
, Qnil
);
3079 if (EQ (c
, make_number (040)))
3083 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3084 while (BUFFERP (c
));
3093 /* Record a key that came from a mouse menu.
3094 Record it for echoing, for this-command-keys, and so on. */
3097 record_menu_key (Lisp_Object c
)
3099 /* Wipe the echo area. */
3100 clear_message (1, 0);
3105 before_command_key_count
= this_command_key_count
;
3106 before_command_echo_length
= echo_length ();
3109 /* Don't echo mouse motion events. */
3110 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3111 && NILP (Fzerop (Vecho_keystrokes
)))
3115 /* Once we reread a character, echoing can happen
3116 the next time we pause to read a new one. */
3117 ok_to_echo_at_next_pause
= 0;
3120 /* Record this character as part of the current key. */
3121 add_command_key (c
);
3123 /* Re-reading in the middle of a command */
3124 last_input_event
= c
;
3128 /* Return 1 if should recognize C as "the help character". */
3131 help_char_p (Lisp_Object c
)
3135 if (EQ (c
, Vhelp_char
))
3137 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3138 if (EQ (c
, XCAR (tail
)))
3143 /* Record the input event C in various ways. */
3146 record_char (Lisp_Object c
)
3150 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3152 /* To avoid filling recent_keys with help-echo and mouse-movement
3153 events, we filter out repeated help-echo events, only store the
3154 first and last in a series of mouse-movement events, and don't
3155 store repeated help-echo events which are only separated by
3156 mouse-movement events. */
3158 Lisp_Object ev1
, ev2
, ev3
;
3161 if ((ix1
= recent_keys_index
- 1) < 0)
3162 ix1
= NUM_RECENT_KEYS
- 1;
3163 ev1
= AREF (recent_keys
, ix1
);
3165 if ((ix2
= ix1
- 1) < 0)
3166 ix2
= NUM_RECENT_KEYS
- 1;
3167 ev2
= AREF (recent_keys
, ix2
);
3169 if ((ix3
= ix2
- 1) < 0)
3170 ix3
= NUM_RECENT_KEYS
- 1;
3171 ev3
= AREF (recent_keys
, ix3
);
3173 if (EQ (XCAR (c
), Qhelp_echo
))
3175 /* Don't record `help-echo' in recent_keys unless it shows some help
3176 message, and a different help than the previously recorded
3178 Lisp_Object help
, last_help
;
3180 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3181 if (!STRINGP (help
))
3183 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3184 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3186 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3187 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3188 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3190 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3191 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3192 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3193 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3196 else if (EQ (XCAR (c
), Qmouse_movement
))
3198 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3199 So additional mouse movement events replace the last element. */
3200 Lisp_Object last_window
, window
;
3202 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3203 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3204 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3205 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3206 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3208 ASET (recent_keys
, ix1
, c
);
3214 store_kbd_macro_char (c
);
3219 ASET (recent_keys
, recent_keys_index
, c
);
3220 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3221 recent_keys_index
= 0;
3223 else if (recorded
< 0)
3225 /* We need to remove one or two events from recent_keys.
3226 To do this, we simply put nil at those events and move the
3227 recent_keys_index backwards over those events. Usually,
3228 users will never see those nil events, as they will be
3229 overwritten by the command keys entered to see recent_keys
3232 while (recorded
++ < 0 && total_keys
> 0)
3234 if (total_keys
< NUM_RECENT_KEYS
)
3236 if (--recent_keys_index
< 0)
3237 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3238 ASET (recent_keys
, recent_keys_index
, Qnil
);
3242 num_nonmacro_input_events
++;
3244 /* Write c to the dribble file. If c is a lispy event, write
3245 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3246 If you, dear reader, have a better idea, you've got the source. :-) */
3252 if (XUINT (c
) < 0x100)
3253 putc (XINT (c
), dribble
);
3255 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3259 Lisp_Object dribblee
;
3261 /* If it's a structured event, take the event header. */
3262 dribblee
= EVENT_HEAD (c
);
3264 if (SYMBOLP (dribblee
))
3266 putc ('<', dribble
);
3267 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3268 SBYTES (SYMBOL_NAME (dribblee
)),
3270 putc ('>', dribble
);
3280 print_help (Lisp_Object object
)
3282 struct buffer
*old
= current_buffer
;
3283 Fprinc (object
, Qnil
);
3284 set_buffer_internal (XBUFFER (Vstandard_output
));
3285 call0 (intern ("help-mode"));
3286 set_buffer_internal (old
);
3290 /* Copy out or in the info on where C-g should throw to.
3291 This is used when running Lisp code from within get_char,
3292 in case get_char is called recursively.
3293 See read_process_output. */
3296 save_getcjmp (jmp_buf temp
)
3298 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3302 restore_getcjmp (jmp_buf temp
)
3304 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3307 /* Low level keyboard/mouse input.
3308 kbd_buffer_store_event places events in kbd_buffer, and
3309 kbd_buffer_get_event retrieves them. */
3311 /* Return true if there are any events in the queue that read-char
3312 would return. If this returns false, a read-char would block. */
3314 readable_events (int flags
)
3316 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3319 /* If the buffer contains only FOCUS_IN_EVENT events, and
3320 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3321 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3323 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3324 #ifdef USE_TOOLKIT_SCROLL_BARS
3325 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3329 struct input_event
*event
;
3331 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3338 #ifdef USE_TOOLKIT_SCROLL_BARS
3339 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3341 event
->kind
== FOCUS_IN_EVENT
)
3342 #ifdef USE_TOOLKIT_SCROLL_BARS
3343 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3344 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3345 && event
->part
== scroll_bar_handle
3346 && event
->modifiers
== 0)
3351 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3354 while (event
!= kbd_store_ptr
);
3360 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3361 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3362 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3367 if (current_kboard
->kbd_queue_has_data
)
3373 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3374 if (kb
->kbd_queue_has_data
)
3380 /* Set this for debugging, to have a way to get out */
3384 event_to_kboard (struct input_event
*event
)
3387 frame
= event
->frame_or_window
;
3389 frame
= XCAR (frame
);
3390 else if (WINDOWP (frame
))
3391 frame
= WINDOW_FRAME (XWINDOW (frame
));
3393 /* There are still some events that don't set this field.
3394 For now, just ignore the problem.
3395 Also ignore dead frames here. */
3396 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3399 return FRAME_KBOARD (XFRAME (frame
));
3403 /* Return the number of slots occupied in kbd_buffer. */
3406 kbd_buffer_nr_stored (void)
3408 return kbd_fetch_ptr
== kbd_store_ptr
3410 : (kbd_fetch_ptr
< kbd_store_ptr
3411 ? kbd_store_ptr
- kbd_fetch_ptr
3412 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3413 + (kbd_store_ptr
- kbd_buffer
)));
3415 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3418 kbd_buffer_store_event (register struct input_event
*event
)
3420 kbd_buffer_store_event_hold (event
, 0);
3423 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3425 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3426 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3427 Else, if EVENT is a quit event, store the quit event
3428 in HOLD_QUIT, and return (thus ignoring further events).
3430 This is used in read_avail_input to postpone the processing
3431 of the quit event until all subsequent input events have been
3432 parsed (and discarded).
3436 kbd_buffer_store_event_hold (register struct input_event
*event
,
3437 struct input_event
*hold_quit
)
3439 if (event
->kind
== NO_EVENT
)
3442 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3445 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3447 register int c
= event
->code
& 0377;
3449 if (event
->modifiers
& ctrl_modifier
)
3450 c
= make_ctrl_char (c
);
3452 c
|= (event
->modifiers
3453 & (meta_modifier
| alt_modifier
3454 | hyper_modifier
| super_modifier
));
3458 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3459 struct input_event
*sp
;
3461 if (single_kboard
&& kb
!= current_kboard
)
3464 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3465 Fcons (make_number (c
), Qnil
));
3466 kb
->kbd_queue_has_data
= 1;
3467 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3469 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3472 if (event_to_kboard (sp
) == kb
)
3474 sp
->kind
= NO_EVENT
;
3475 sp
->frame_or_window
= Qnil
;
3484 memcpy (hold_quit
, event
, sizeof (*event
));
3488 /* If this results in a quit_char being returned to Emacs as
3489 input, set Vlast_event_frame properly. If this doesn't
3490 get returned to Emacs as an event, the next event read
3491 will set Vlast_event_frame again, so this is safe to do. */
3495 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3497 focus
= event
->frame_or_window
;
3498 internal_last_event_frame
= focus
;
3499 Vlast_event_frame
= focus
;
3502 last_event_timestamp
= event
->timestamp
;
3503 handle_interrupt ();
3507 if (c
&& c
== stop_character
)
3513 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3514 Just ignore the second one. */
3515 else if (event
->kind
== BUFFER_SWITCH_EVENT
3516 && kbd_fetch_ptr
!= kbd_store_ptr
3517 && ((kbd_store_ptr
== kbd_buffer
3518 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3519 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3522 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3523 kbd_store_ptr
= kbd_buffer
;
3525 /* Don't let the very last slot in the buffer become full,
3526 since that would make the two pointers equal,
3527 and that is indistinguishable from an empty buffer.
3528 Discard the event if it would fill the last slot. */
3529 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3531 *kbd_store_ptr
= *event
;
3534 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3536 /* Don't read keyboard input until we have processed kbd_buffer.
3537 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3538 hold_keyboard_input ();
3540 if (!noninteractive
)
3541 signal (SIGIO
, SIG_IGN
);
3545 #endif /* subprocesses */
3548 /* If we're inside while-no-input, and this event qualifies
3549 as input, set quit-flag to cause an interrupt. */
3550 if (!NILP (Vthrow_on_input
)
3551 && event
->kind
!= FOCUS_IN_EVENT
3552 && event
->kind
!= HELP_EVENT
3553 && event
->kind
!= DEICONIFY_EVENT
)
3555 Vquit_flag
= Vthrow_on_input
;
3556 /* If we're inside a function that wants immediate quits,
3558 if (immediate_quit
&& NILP (Vinhibit_quit
))
3568 /* Put an input event back in the head of the event queue. */
3571 kbd_buffer_unget_event (register struct input_event
*event
)
3573 if (kbd_fetch_ptr
== kbd_buffer
)
3574 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3576 /* Don't let the very last slot in the buffer become full, */
3577 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3580 *kbd_fetch_ptr
= *event
;
3585 /* Generate a HELP_EVENT input_event and store it in the keyboard
3588 HELP is the help form.
3590 FRAME and WINDOW are the frame and window where the help is
3591 generated. OBJECT is the Lisp object where the help was found (a
3592 buffer, a string, an overlay, or nil if neither from a string nor
3593 from a buffer). POS is the position within OBJECT where the help
3597 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3598 Lisp_Object object
, EMACS_INT pos
)
3600 struct input_event event
;
3604 event
.kind
= HELP_EVENT
;
3605 event
.frame_or_window
= frame
;
3607 event
.x
= WINDOWP (window
) ? window
: frame
;
3610 kbd_buffer_store_event (&event
);
3614 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3617 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3619 struct input_event event
;
3621 event
.kind
= HELP_EVENT
;
3622 event
.frame_or_window
= frame
;
3627 kbd_buffer_store_event (&event
);
3631 /* Discard any mouse events in the event buffer by setting them to
3634 discard_mouse_events (void)
3636 struct input_event
*sp
;
3637 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3639 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3642 if (sp
->kind
== MOUSE_CLICK_EVENT
3643 || sp
->kind
== WHEEL_EVENT
3644 || sp
->kind
== HORIZ_WHEEL_EVENT
3646 || sp
->kind
== GPM_CLICK_EVENT
3648 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3650 sp
->kind
= NO_EVENT
;
3656 /* Return non-zero if there are any real events waiting in the event
3657 buffer, not counting `NO_EVENT's.
3659 If DISCARD is non-zero, discard NO_EVENT events at the front of
3660 the input queue, possibly leaving the input queue empty if there
3661 are no real input events. */
3664 kbd_buffer_events_waiting (int discard
)
3666 struct input_event
*sp
;
3668 for (sp
= kbd_fetch_ptr
;
3669 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3672 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3679 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3683 /* Clear input event EVENT. */
3686 clear_event (struct input_event
*event
)
3688 event
->kind
= NO_EVENT
;
3692 /* Read one event from the event buffer, waiting if necessary.
3693 The value is a Lisp object representing the event.
3694 The value is nil for an event that should be ignored,
3695 or that was handled here.
3696 We always read and discard one event. */
3699 kbd_buffer_get_event (KBOARD
**kbp
,
3700 int *used_mouse_menu
,
3701 struct timeval
*end_time
)
3707 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3709 /* Start reading input again, we have processed enough so we can
3710 accept new events again. */
3711 unhold_keyboard_input ();
3713 if (!noninteractive
)
3714 signal (SIGIO
, input_available_signal
);
3718 #endif /* subprocesses */
3721 /* In case we are running as a daemon, only do this before
3722 detaching from the terminal. */
3723 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3727 *kbp
= current_kboard
;
3731 /* Wait until there is input available. */
3734 /* Break loop if there's an unread command event. Needed in
3735 moused window autoselection which uses a timer to insert such
3737 if (CONSP (Vunread_command_events
))
3740 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3742 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3743 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3747 /* If the quit flag is set, then read_char will return
3748 quit_char, so that counts as "available input." */
3749 if (!NILP (Vquit_flag
))
3750 quit_throw_to_read_char ();
3752 /* One way or another, wait until input is available; then, if
3753 interrupt handlers have not read it, read it now. */
3755 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3759 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3761 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3762 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3767 EMACS_TIME duration
;
3768 EMACS_GET_TIME (duration
);
3769 if (EMACS_TIME_GE (duration
, *end_time
))
3770 return Qnil
; /* finished waiting */
3773 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3774 wait_reading_process_output (EMACS_SECS (duration
),
3775 EMACS_USECS (duration
),
3776 -1, 1, Qnil
, NULL
, 0);
3780 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3782 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3783 /* Pass 1 for EXPECT since we just waited to have input. */
3784 read_avail_input (1);
3787 if (CONSP (Vunread_command_events
))
3790 first
= XCAR (Vunread_command_events
);
3791 Vunread_command_events
= XCDR (Vunread_command_events
);
3792 *kbp
= current_kboard
;
3796 /* At this point, we know that there is a readable event available
3797 somewhere. If the event queue is empty, then there must be a
3798 mouse movement enabled and available. */
3799 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3801 struct input_event
*event
;
3803 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3807 last_event_timestamp
= event
->timestamp
;
3809 *kbp
= event_to_kboard (event
);
3811 *kbp
= current_kboard
; /* Better than returning null ptr? */
3815 /* These two kinds of events get special handling
3816 and don't actually appear to the command loop.
3817 We return nil for them. */
3818 if (event
->kind
== SELECTION_REQUEST_EVENT
3819 || event
->kind
== SELECTION_CLEAR_EVENT
)
3822 struct input_event copy
;
3824 /* Remove it from the buffer before processing it,
3825 since otherwise swallow_events will see it
3826 and process it again. */
3828 kbd_fetch_ptr
= event
+ 1;
3829 input_pending
= readable_events (0);
3830 x_handle_selection_event (©
);
3832 /* We're getting selection request events, but we don't have
3838 #if defined (HAVE_NS)
3839 else if (event
->kind
== NS_TEXT_EVENT
)
3841 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3842 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3844 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3845 kbd_fetch_ptr
= event
+ 1;
3846 if (used_mouse_menu
)
3847 *used_mouse_menu
= 1;
3851 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3852 || defined (HAVE_NS)
3853 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3855 /* Make an event (delete-frame (FRAME)). */
3856 obj
= Fcons (event
->frame_or_window
, Qnil
);
3857 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3858 kbd_fetch_ptr
= event
+ 1;
3861 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3862 || defined (HAVE_NS)
3863 else if (event
->kind
== ICONIFY_EVENT
)
3865 /* Make an event (iconify-frame (FRAME)). */
3866 obj
= Fcons (event
->frame_or_window
, Qnil
);
3867 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3868 kbd_fetch_ptr
= event
+ 1;
3870 else if (event
->kind
== DEICONIFY_EVENT
)
3872 /* Make an event (make-frame-visible (FRAME)). */
3873 obj
= Fcons (event
->frame_or_window
, Qnil
);
3874 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3875 kbd_fetch_ptr
= event
+ 1;
3878 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3880 /* The value doesn't matter here; only the type is tested. */
3881 XSETBUFFER (obj
, current_buffer
);
3882 kbd_fetch_ptr
= event
+ 1;
3884 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3885 || defined(HAVE_NS) || defined (USE_GTK)
3886 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3888 kbd_fetch_ptr
= event
+ 1;
3889 input_pending
= readable_events (0);
3890 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3891 x_activate_menubar (XFRAME (event
->frame_or_window
));
3894 #if defined (WINDOWSNT)
3895 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3897 /* Make an event (language-change (FRAME CHARSET LCID)). */
3898 obj
= Fcons (event
->frame_or_window
, Qnil
);
3899 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3900 kbd_fetch_ptr
= event
+ 1;
3903 else if (event
->kind
== SAVE_SESSION_EVENT
)
3905 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3906 kbd_fetch_ptr
= event
+ 1;
3908 /* Just discard these, by returning nil.
3909 With MULTI_KBOARD, these events are used as placeholders
3910 when we need to randomly delete events from the queue.
3911 (They shouldn't otherwise be found in the buffer,
3912 but on some machines it appears they do show up
3913 even without MULTI_KBOARD.) */
3914 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3915 mouse events during a popup-menu call. */
3916 else if (event
->kind
== NO_EVENT
)
3917 kbd_fetch_ptr
= event
+ 1;
3918 else if (event
->kind
== HELP_EVENT
)
3920 Lisp_Object object
, position
, help
, frame
, window
;
3922 frame
= event
->frame_or_window
;
3923 object
= event
->arg
;
3924 position
= make_number (event
->code
);
3927 clear_event (event
);
3929 kbd_fetch_ptr
= event
+ 1;
3930 if (!WINDOWP (window
))
3932 obj
= Fcons (Qhelp_echo
,
3933 list5 (frame
, help
, window
, object
, position
));
3935 else if (event
->kind
== FOCUS_IN_EVENT
)
3937 /* Notification of a FocusIn event. The frame receiving the
3938 focus is in event->frame_or_window. Generate a
3939 switch-frame event if necessary. */
3940 Lisp_Object frame
, focus
;
3942 frame
= event
->frame_or_window
;
3943 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3947 if (!EQ (frame
, internal_last_event_frame
)
3948 && !EQ (frame
, selected_frame
))
3949 obj
= make_lispy_switch_frame (frame
);
3950 internal_last_event_frame
= frame
;
3951 kbd_fetch_ptr
= event
+ 1;
3954 else if (event
->kind
== DBUS_EVENT
)
3956 obj
= make_lispy_event (event
);
3957 kbd_fetch_ptr
= event
+ 1;
3960 else if (event
->kind
== CONFIG_CHANGED_EVENT
|| event
->kind
== XWIDGET_EVENT
)
3962 obj
= make_lispy_event (event
);
3963 kbd_fetch_ptr
= event
+ 1;
3967 /* If this event is on a different frame, return a switch-frame this
3968 time, and leave the event in the queue for next time. */
3972 frame
= event
->frame_or_window
;
3974 frame
= XCAR (frame
);
3975 else if (WINDOWP (frame
))
3976 frame
= WINDOW_FRAME (XWINDOW (frame
));
3978 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3982 if (! EQ (frame
, internal_last_event_frame
)
3983 && !EQ (frame
, selected_frame
))
3984 obj
= make_lispy_switch_frame (frame
);
3985 internal_last_event_frame
= frame
;
3987 /* If we didn't decide to make a switch-frame event, go ahead
3988 and build a real event from the queue entry. */
3992 obj
= make_lispy_event (event
);
3994 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3995 || defined(HAVE_NS) || defined (USE_GTK)
3996 /* If this was a menu selection, then set the flag to inhibit
3997 writing to last_nonmenu_event. Don't do this if the event
3998 we're returning is (menu-bar), though; that indicates the
3999 beginning of the menu sequence, and we might as well leave
4000 that as the `event with parameters' for this selection. */
4002 && !EQ (event
->frame_or_window
, event
->arg
)
4003 && (event
->kind
== MENU_BAR_EVENT
4004 || event
->kind
== TOOL_BAR_EVENT
))
4005 *used_mouse_menu
= 1;
4008 /* certain system events are non-key events */
4010 && event
->kind
== NS_NONKEY_EVENT
)
4011 *used_mouse_menu
= 1;
4014 /* Wipe out this event, to catch bugs. */
4015 clear_event (event
);
4016 kbd_fetch_ptr
= event
+ 1;
4020 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4021 /* Try generating a mouse motion event. */
4022 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4024 FRAME_PTR f
= some_mouse_moved ();
4025 Lisp_Object bar_window
;
4026 enum scroll_bar_part part
;
4030 *kbp
= current_kboard
;
4031 /* Note that this uses F to determine which terminal to look at.
4032 If there is no valid info, it does not store anything
4033 so x remains nil. */
4036 /* XXX Can f or mouse_position_hook be NULL here? */
4037 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4038 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4039 &part
, &x
, &y
, &time
);
4043 /* Decide if we should generate a switch-frame event. Don't
4044 generate switch-frame events for motion outside of all Emacs
4050 frame
= FRAME_FOCUS_FRAME (f
);
4052 XSETFRAME (frame
, f
);
4054 if (! EQ (frame
, internal_last_event_frame
)
4055 && !EQ (frame
, selected_frame
))
4056 obj
= make_lispy_switch_frame (frame
);
4057 internal_last_event_frame
= frame
;
4060 /* If we didn't decide to make a switch-frame event, go ahead and
4061 return a mouse-motion event. */
4062 if (!NILP (x
) && NILP (obj
))
4063 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4065 #endif /* HAVE_MOUSE || HAVE GPM */
4067 /* We were promised by the above while loop that there was
4068 something for us to read! */
4071 input_pending
= readable_events (0);
4073 Vlast_event_frame
= internal_last_event_frame
;
4078 /* Process any events that are not user-visible,
4079 then return, without reading any user-visible events. */
4082 swallow_events (int do_display
)
4086 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4088 struct input_event
*event
;
4090 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4094 last_event_timestamp
= event
->timestamp
;
4096 /* These two kinds of events get special handling
4097 and don't actually appear to the command loop. */
4098 if (event
->kind
== SELECTION_REQUEST_EVENT
4099 || event
->kind
== SELECTION_CLEAR_EVENT
)
4102 struct input_event copy
;
4104 /* Remove it from the buffer before processing it,
4105 since otherwise swallow_events called recursively could see it
4106 and process it again. */
4108 kbd_fetch_ptr
= event
+ 1;
4109 input_pending
= readable_events (0);
4110 x_handle_selection_event (©
);
4112 /* We're getting selection request events, but we don't have
4121 old_timers_run
= timers_run
;
4122 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4124 if (timers_run
!= old_timers_run
&& do_display
)
4125 redisplay_preserve_echo_area (7);
4128 /* Record the start of when Emacs is idle,
4129 for the sake of running idle-time timers. */
4132 timer_start_idle (void)
4136 /* If we are already in the idle state, do nothing. */
4137 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4140 EMACS_GET_TIME (timer_idleness_start_time
);
4142 timer_last_idleness_start_time
= timer_idleness_start_time
;
4144 /* Mark all idle-time timers as once again candidates for running. */
4145 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4149 timer
= XCAR (timers
);
4151 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4153 XVECTOR (timer
)->contents
[0] = Qnil
;
4157 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4160 timer_stop_idle (void)
4162 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4165 /* Resume idle timer from last idle start time. */
4168 timer_resume_idle (void)
4170 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4173 timer_idleness_start_time
= timer_last_idleness_start_time
;
4176 /* This is only for debugging. */
4177 struct input_event last_timer_event
;
4179 /* List of elisp functions to call, delayed because they were generated in
4180 a context where Elisp could not be safely run (e.g. redisplay, signal,
4181 ...). Each element has the form (FUN . ARGS). */
4182 Lisp_Object pending_funcalls
;
4184 /* Check whether a timer has fired. To prevent larger problems we simply
4185 disregard elements that are not proper timers. Do not make a circular
4186 timer list for the time being.
4188 Returns the time to wait until the next timer fires. If a
4189 timer is triggering now, return zero.
4190 If no timer is active, return -1.
4192 If a timer is ripe, we run it, with quitting turned off.
4193 In that case we return 0 to indicate that a new timer_check_2 call
4197 timer_check_2 (void)
4199 EMACS_TIME nexttime
;
4200 EMACS_TIME now
, idleness_now
;
4201 Lisp_Object timers
, idle_timers
, chosen_timer
;
4202 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4204 EMACS_SET_SECS (nexttime
, -1);
4205 EMACS_SET_USECS (nexttime
, -1);
4207 /* Always consider the ordinary timers. */
4208 timers
= Vtimer_list
;
4209 /* Consider the idle timers only if Emacs is idle. */
4210 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4211 idle_timers
= Vtimer_idle_list
;
4214 chosen_timer
= Qnil
;
4215 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4217 /* First run the code that was delayed. */
4218 while (CONSP (pending_funcalls
))
4220 Lisp_Object funcall
= XCAR (pending_funcalls
);
4221 pending_funcalls
= XCDR (pending_funcalls
);
4222 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4225 if (CONSP (timers
) || CONSP (idle_timers
))
4227 EMACS_GET_TIME (now
);
4228 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4229 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4232 while (CONSP (timers
) || CONSP (idle_timers
))
4234 Lisp_Object
*vector
;
4235 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4236 EMACS_TIME timer_time
, idle_timer_time
;
4237 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4239 /* Skip past invalid timers and timers already handled. */
4242 timer
= XCAR (timers
);
4243 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4245 timers
= XCDR (timers
);
4248 vector
= XVECTOR (timer
)->contents
;
4250 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4251 || !INTEGERP (vector
[3])
4252 || ! NILP (vector
[0]))
4254 timers
= XCDR (timers
);
4258 if (!NILP (idle_timers
))
4260 timer
= XCAR (idle_timers
);
4261 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4263 idle_timers
= XCDR (idle_timers
);
4266 vector
= XVECTOR (timer
)->contents
;
4268 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4269 || !INTEGERP (vector
[3])
4270 || ! NILP (vector
[0]))
4272 idle_timers
= XCDR (idle_timers
);
4277 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4278 based on the next ordinary timer.
4279 TIMER_DIFFERENCE is the distance in time from NOW to when
4280 this timer becomes ripe (negative if it's already ripe). */
4283 timer
= XCAR (timers
);
4284 vector
= XVECTOR (timer
)->contents
;
4285 EMACS_SET_SECS (timer_time
,
4286 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4287 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4288 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4291 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4292 based on the next idle timer. */
4293 if (!NILP (idle_timers
))
4295 idle_timer
= XCAR (idle_timers
);
4296 vector
= XVECTOR (idle_timer
)->contents
;
4297 EMACS_SET_SECS (idle_timer_time
,
4298 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4299 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4300 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4303 /* Decide which timer is the next timer,
4304 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4305 Also step down the list where we found that timer. */
4307 if (! NILP (timers
) && ! NILP (idle_timers
))
4310 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4311 if (EMACS_TIME_NEG_P (temp
))
4313 chosen_timer
= timer
;
4314 timers
= XCDR (timers
);
4315 difference
= timer_difference
;
4319 chosen_timer
= idle_timer
;
4320 idle_timers
= XCDR (idle_timers
);
4321 difference
= idle_timer_difference
;
4324 else if (! NILP (timers
))
4326 chosen_timer
= timer
;
4327 timers
= XCDR (timers
);
4328 difference
= timer_difference
;
4332 chosen_timer
= idle_timer
;
4333 idle_timers
= XCDR (idle_timers
);
4334 difference
= idle_timer_difference
;
4336 vector
= XVECTOR (chosen_timer
)->contents
;
4338 /* If timer is ripe, run it if it hasn't been run. */
4339 if (EMACS_TIME_NEG_P (difference
)
4340 || (EMACS_SECS (difference
) == 0
4341 && EMACS_USECS (difference
) == 0))
4343 if (NILP (vector
[0]))
4345 int count
= SPECPDL_INDEX ();
4346 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4348 /* Mark the timer as triggered to prevent problems if the lisp
4349 code fails to reschedule it right. */
4352 specbind (Qinhibit_quit
, Qt
);
4354 call1 (Qtimer_event_handler
, chosen_timer
);
4355 Vdeactivate_mark
= old_deactivate_mark
;
4357 unbind_to (count
, Qnil
);
4359 /* Since we have handled the event,
4360 we don't need to tell the caller to wake up and do it. */
4361 /* But the caller must still wait for the next timer, so
4362 return 0 to indicate that. */
4365 EMACS_SET_SECS (nexttime
, 0);
4366 EMACS_SET_USECS (nexttime
, 0);
4369 /* When we encounter a timer that is still waiting,
4370 return the amount of time to wait before it is ripe. */
4377 /* No timers are pending in the future. */
4378 /* Return 0 if we generated an event, and -1 if not. */
4384 /* Check whether a timer has fired. To prevent larger problems we simply
4385 disregard elements that are not proper timers. Do not make a circular
4386 timer list for the time being.
4388 Returns the time to wait until the next timer fires.
4389 If no timer is active, return -1.
4391 As long as any timer is ripe, we run it.
4393 DO_IT_NOW is now ignored. It used to mean that we should
4394 run the timer directly instead of queueing a timer-event.
4395 Now we always run timers directly. */
4398 timer_check (int do_it_now
)
4400 EMACS_TIME nexttime
;
4404 nexttime
= timer_check_2 ();
4406 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4411 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4412 doc
: /* Return the current length of Emacs idleness, or nil.
4413 The value when Emacs is idle is a list of three integers. The first has
4414 the most significant 16 bits of the seconds, while the second has the least
4415 significant 16 bits. The third integer gives the microsecond count.
4417 The value when Emacs is not idle is nil.
4419 The microsecond count is zero on systems that do not provide
4420 resolution finer than a second. */)
4423 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4425 EMACS_TIME now
, idleness_now
;
4427 EMACS_GET_TIME (now
);
4428 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4430 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4431 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4432 make_number (EMACS_USECS (idleness_now
)));
4438 /* Caches for modify_event_symbol. */
4439 static Lisp_Object accent_key_syms
;
4440 static Lisp_Object func_key_syms
;
4441 static Lisp_Object mouse_syms
;
4442 static Lisp_Object wheel_syms
;
4443 static Lisp_Object drag_n_drop_syms
;
4445 /* This is a list of keysym codes for special "accent" characters.
4446 It parallels lispy_accent_keys. */
4448 static const int lispy_accent_codes
[] =
4450 #ifdef XK_dead_circumflex
4455 #ifdef XK_dead_grave
4460 #ifdef XK_dead_tilde
4465 #ifdef XK_dead_diaeresis
4470 #ifdef XK_dead_macron
4475 #ifdef XK_dead_degree
4480 #ifdef XK_dead_acute
4485 #ifdef XK_dead_cedilla
4490 #ifdef XK_dead_breve
4495 #ifdef XK_dead_ogonek
4500 #ifdef XK_dead_caron
4505 #ifdef XK_dead_doubleacute
4506 XK_dead_doubleacute
,
4510 #ifdef XK_dead_abovedot
4515 #ifdef XK_dead_abovering
4525 #ifdef XK_dead_belowdot
4530 #ifdef XK_dead_voiced_sound
4531 XK_dead_voiced_sound
,
4535 #ifdef XK_dead_semivoiced_sound
4536 XK_dead_semivoiced_sound
,
4552 /* This is a list of Lisp names for special "accent" characters.
4553 It parallels lispy_accent_codes. */
4555 static const char *const lispy_accent_keys
[] =
4573 "dead-voiced-sound",
4574 "dead-semivoiced-sound",
4580 #define FUNCTION_KEY_OFFSET 0x0
4582 const char *const lispy_function_keys
[] =
4586 0, /* VK_LBUTTON 0x01 */
4587 0, /* VK_RBUTTON 0x02 */
4588 "cancel", /* VK_CANCEL 0x03 */
4589 0, /* VK_MBUTTON 0x04 */
4591 0, 0, 0, /* 0x05 .. 0x07 */
4593 "backspace", /* VK_BACK 0x08 */
4594 "tab", /* VK_TAB 0x09 */
4596 0, 0, /* 0x0A .. 0x0B */
4598 "clear", /* VK_CLEAR 0x0C */
4599 "return", /* VK_RETURN 0x0D */
4601 0, 0, /* 0x0E .. 0x0F */
4603 0, /* VK_SHIFT 0x10 */
4604 0, /* VK_CONTROL 0x11 */
4605 0, /* VK_MENU 0x12 */
4606 "pause", /* VK_PAUSE 0x13 */
4607 "capslock", /* VK_CAPITAL 0x14 */
4608 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4610 "junja", /* VK_JUNJA 0x17 */
4611 "final", /* VK_FINAL 0x18 */
4612 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4614 "escape", /* VK_ESCAPE 0x1B */
4615 "convert", /* VK_CONVERT 0x1C */
4616 "non-convert", /* VK_NONCONVERT 0x1D */
4617 "accept", /* VK_ACCEPT 0x1E */
4618 "mode-change", /* VK_MODECHANGE 0x1F */
4619 0, /* VK_SPACE 0x20 */
4620 "prior", /* VK_PRIOR 0x21 */
4621 "next", /* VK_NEXT 0x22 */
4622 "end", /* VK_END 0x23 */
4623 "home", /* VK_HOME 0x24 */
4624 "left", /* VK_LEFT 0x25 */
4625 "up", /* VK_UP 0x26 */
4626 "right", /* VK_RIGHT 0x27 */
4627 "down", /* VK_DOWN 0x28 */
4628 "select", /* VK_SELECT 0x29 */
4629 "print", /* VK_PRINT 0x2A */
4630 "execute", /* VK_EXECUTE 0x2B */
4631 "snapshot", /* VK_SNAPSHOT 0x2C */
4632 "insert", /* VK_INSERT 0x2D */
4633 "delete", /* VK_DELETE 0x2E */
4634 "help", /* VK_HELP 0x2F */
4636 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4638 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4640 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4642 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4644 0, 0, 0, 0, 0, 0, 0, 0, 0,
4645 0, 0, 0, 0, 0, 0, 0, 0, 0,
4646 0, 0, 0, 0, 0, 0, 0, 0,
4648 "lwindow", /* VK_LWIN 0x5B */
4649 "rwindow", /* VK_RWIN 0x5C */
4650 "apps", /* VK_APPS 0x5D */
4653 "kp-0", /* VK_NUMPAD0 0x60 */
4654 "kp-1", /* VK_NUMPAD1 0x61 */
4655 "kp-2", /* VK_NUMPAD2 0x62 */
4656 "kp-3", /* VK_NUMPAD3 0x63 */
4657 "kp-4", /* VK_NUMPAD4 0x64 */
4658 "kp-5", /* VK_NUMPAD5 0x65 */
4659 "kp-6", /* VK_NUMPAD6 0x66 */
4660 "kp-7", /* VK_NUMPAD7 0x67 */
4661 "kp-8", /* VK_NUMPAD8 0x68 */
4662 "kp-9", /* VK_NUMPAD9 0x69 */
4663 "kp-multiply", /* VK_MULTIPLY 0x6A */
4664 "kp-add", /* VK_ADD 0x6B */
4665 "kp-separator", /* VK_SEPARATOR 0x6C */
4666 "kp-subtract", /* VK_SUBTRACT 0x6D */
4667 "kp-decimal", /* VK_DECIMAL 0x6E */
4668 "kp-divide", /* VK_DIVIDE 0x6F */
4669 "f1", /* VK_F1 0x70 */
4670 "f2", /* VK_F2 0x71 */
4671 "f3", /* VK_F3 0x72 */
4672 "f4", /* VK_F4 0x73 */
4673 "f5", /* VK_F5 0x74 */
4674 "f6", /* VK_F6 0x75 */
4675 "f7", /* VK_F7 0x76 */
4676 "f8", /* VK_F8 0x77 */
4677 "f9", /* VK_F9 0x78 */
4678 "f10", /* VK_F10 0x79 */
4679 "f11", /* VK_F11 0x7A */
4680 "f12", /* VK_F12 0x7B */
4681 "f13", /* VK_F13 0x7C */
4682 "f14", /* VK_F14 0x7D */
4683 "f15", /* VK_F15 0x7E */
4684 "f16", /* VK_F16 0x7F */
4685 "f17", /* VK_F17 0x80 */
4686 "f18", /* VK_F18 0x81 */
4687 "f19", /* VK_F19 0x82 */
4688 "f20", /* VK_F20 0x83 */
4689 "f21", /* VK_F21 0x84 */
4690 "f22", /* VK_F22 0x85 */
4691 "f23", /* VK_F23 0x86 */
4692 "f24", /* VK_F24 0x87 */
4694 0, 0, 0, 0, /* 0x88 .. 0x8B */
4695 0, 0, 0, 0, /* 0x8C .. 0x8F */
4697 "kp-numlock", /* VK_NUMLOCK 0x90 */
4698 "scroll", /* VK_SCROLL 0x91 */
4699 /* Not sure where the following block comes from.
4700 Windows headers have NEC and Fujitsu specific keys in
4701 this block, but nothing generic. */
4702 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4703 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4704 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4705 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4706 "kp-end", /* VK_NUMPAD_END 0x96 */
4707 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4708 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4709 "kp-up", /* VK_NUMPAD_UP 0x99 */
4710 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4711 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4712 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4713 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4715 0, 0, /* 0x9E .. 0x9F */
4718 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4719 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4720 * No other API or message will distinguish left and right keys this way.
4725 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4726 to enable them selectively, and gives access to a few more functions.
4727 See lispy_multimedia_keys below. */
4728 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4729 0, 0, 0, /* 0xAD .. 0xAF Volume */
4730 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4731 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4733 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4734 0, 0, 0, 0, 0, 0, 0, 0, 0,
4736 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4737 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4738 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4741 "ax", /* VK_OEM_AX 0xE1 */
4742 0, /* VK_OEM_102 0xE2 */
4743 "ico-help", /* VK_ICO_HELP 0xE3 */
4744 "ico-00", /* VK_ICO_00 0xE4 */
4745 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4746 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4747 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4749 "reset", /* VK_OEM_RESET 0xE9 */
4750 "jump", /* VK_OEM_JUMP 0xEA */
4751 "oem-pa1", /* VK_OEM_PA1 0xEB */
4752 "oem-pa2", /* VK_OEM_PA2 0xEC */
4753 "oem-pa3", /* VK_OEM_PA3 0xED */
4754 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4755 "cusel", /* VK_OEM_CUSEL 0xEF */
4756 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4757 "finish", /* VK_OEM_FINISH 0xF1 */
4758 "copy", /* VK_OEM_COPY 0xF2 */
4759 "auto", /* VK_OEM_AUTO 0xF3 */
4760 "enlw", /* VK_OEM_ENLW 0xF4 */
4761 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4762 "attn", /* VK_ATTN 0xF6 */
4763 "crsel", /* VK_CRSEL 0xF7 */
4764 "exsel", /* VK_EXSEL 0xF8 */
4765 "ereof", /* VK_EREOF 0xF9 */
4766 "play", /* VK_PLAY 0xFA */
4767 "zoom", /* VK_ZOOM 0xFB */
4768 "noname", /* VK_NONAME 0xFC */
4769 "pa1", /* VK_PA1 0xFD */
4770 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4774 /* Some of these duplicate the "Media keys" on newer keyboards,
4775 but they are delivered to the application in a different way. */
4776 static const char *const lispy_multimedia_keys
[] =
4784 "browser-favorites",
4821 "toggle-dictate-command",
4827 "media-fast-forward",
4830 "media-channel-down"
4833 #else /* not HAVE_NTGUI */
4835 /* This should be dealt with in XTread_socket now, and that doesn't
4836 depend on the client system having the Kana syms defined. See also
4837 the XK_kana_A case below. */
4840 static const char *const lispy_kana_keys
[] =
4842 /* X Keysym value */
4843 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4844 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4845 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4846 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4847 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4848 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4849 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4850 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4851 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4852 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4853 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4854 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4855 "kana-i", "kana-u", "kana-e", "kana-o",
4856 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4857 "prolongedsound", "kana-A", "kana-I", "kana-U",
4858 "kana-E", "kana-O", "kana-KA", "kana-KI",
4859 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4860 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4861 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4862 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4863 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4864 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4865 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4866 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4867 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4868 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4869 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4872 #endif /* XK_kana_A */
4875 #define FUNCTION_KEY_OFFSET 0xff00
4877 /* You'll notice that this table is arranged to be conveniently
4878 indexed by X Windows keysym values. */
4879 static const char *const lispy_function_keys
[] =
4881 /* X Keysym value */
4883 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4884 "backspace", "tab", "linefeed", "clear",
4886 0, 0, 0, "pause", /* 0xff10...1f */
4887 0, 0, 0, 0, 0, 0, 0, "escape",
4889 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4890 "romaji", "hiragana", "katakana", "hiragana-katakana",
4891 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4892 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4893 "eisu-toggle", /* 0xff30...3f */
4894 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4895 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4897 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4898 "down", "prior", "next", "end",
4899 "begin", 0, 0, 0, 0, 0, 0, 0,
4900 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4911 "break", /* 0xff6b */
4914 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4915 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4916 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4917 0, 0, 0, 0, 0, 0, 0, 0,
4918 "kp-tab", /* 0xff89 */
4920 "kp-enter", /* 0xff8d */
4922 "kp-f1", /* 0xff91 */
4926 "kp-home", /* 0xff95 */
4931 "kp-prior", /* kp-page-up */
4932 "kp-next", /* kp-page-down */
4938 0, 0, 0, 0, 0, 0, 0, 0, 0,
4939 "kp-multiply", /* 0xffaa */
4944 "kp-divide", /* 0xffaf */
4945 "kp-0", /* 0xffb0 */
4946 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4949 "kp-equal", /* 0xffbd */
4950 "f1", /* 0xffbe */ /* IsFunctionKey */
4952 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4953 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4954 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4955 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4956 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4957 0, 0, 0, 0, 0, 0, 0, 0,
4958 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4959 0, 0, 0, 0, 0, 0, 0, "delete"
4962 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4963 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4965 static const char *const iso_lispy_function_keys
[] =
4967 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4968 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4969 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4970 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4971 "iso-lefttab", /* 0xfe20 */
4972 "iso-move-line-up", "iso-move-line-down",
4973 "iso-partial-line-up", "iso-partial-line-down",
4974 "iso-partial-space-left", "iso-partial-space-right",
4975 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4976 "iso-release-margin-left", "iso-release-margin-right",
4977 "iso-release-both-margins",
4978 "iso-fast-cursor-left", "iso-fast-cursor-right",
4979 "iso-fast-cursor-up", "iso-fast-cursor-down",
4980 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4981 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4984 #endif /* not HAVE_NTGUI */
4986 Lisp_Object Vlispy_mouse_stem
;
4988 static const char *const lispy_wheel_names
[] =
4990 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
4993 /* drag-n-drop events are generated when a set of selected files are
4994 dragged from another application and dropped onto an Emacs window. */
4995 static const char *const lispy_drag_n_drop_names
[] =
5000 /* Scroll bar parts. */
5001 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5002 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5003 Lisp_Object Qtop
, Qratio
;
5005 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5006 static Lisp_Object
*const scroll_bar_parts
[] = {
5007 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5008 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5011 /* A vector, indexed by button number, giving the down-going location
5012 of currently depressed buttons, both scroll bar and non-scroll bar.
5014 The elements have the form
5015 (BUTTON-NUMBER MODIFIER-MASK . REST)
5016 where REST is the cdr of a position as it would be reported in the event.
5018 The make_lispy_event function stores positions here to tell the
5019 difference between click and drag events, and to store the starting
5020 location to be included in drag events. */
5022 static Lisp_Object button_down_location
;
5024 /* Information about the most recent up-going button event: Which
5025 button, what location, and what time. */
5027 static int last_mouse_button
;
5028 static int last_mouse_x
;
5029 static int last_mouse_y
;
5030 static unsigned long button_down_time
;
5032 /* The number of clicks in this multiple-click. */
5034 int double_click_count
;
5036 /* X and Y are frame-relative coordinates for a click or wheel event.
5037 Return a Lisp-style event list. */
5040 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5043 enum window_part part
;
5044 Lisp_Object posn
= Qnil
;
5045 Lisp_Object extra_info
= Qnil
;
5046 /* Coordinate pixel positions to return. */
5047 int xret
= 0, yret
= 0;
5048 /* The window under frame pixel coordinates (x,y) */
5049 Lisp_Object window
= f
5050 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5053 if (WINDOWP (window
))
5055 /* It's a click in window window at frame coordinates (x,y) */
5056 struct window
*w
= XWINDOW (window
);
5057 Lisp_Object string_info
= Qnil
;
5058 EMACS_INT textpos
= -1;
5059 int col
= -1, row
= -1;
5060 int dx
= -1, dy
= -1;
5061 int width
= -1, height
= -1;
5062 Lisp_Object object
= Qnil
;
5064 /* Pixel coordinates relative to the window corner. */
5065 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5066 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5068 /* For text area clicks, return X, Y relative to the corner of
5069 this text area. Note that dX, dY etc are set below, by
5070 buffer_posn_from_coords. */
5071 if (part
== ON_TEXT
)
5073 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5074 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5076 /* For mode line and header line clicks, return X, Y relative to
5077 the left window edge. Use mode_line_string to look for a
5078 string on the click position. */
5079 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5084 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5085 /* Note that mode_line_string takes COL, ROW as pixels and
5086 converts them to characters. */
5089 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5090 &object
, &dx
, &dy
, &width
, &height
);
5091 if (STRINGP (string
))
5092 string_info
= Fcons (string
, make_number (charpos
));
5093 textpos
= (w
== XWINDOW (selected_window
)
5094 && current_buffer
== XBUFFER (w
->buffer
))
5095 ? PT
: XMARKER (w
->pointm
)->charpos
;
5100 /* For fringes and margins, Y is relative to the area's (and the
5101 window's) top edge, while X is meaningless. */
5102 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5107 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5110 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5111 &object
, &dx
, &dy
, &width
, &height
);
5112 if (STRINGP (string
))
5113 string_info
= Fcons (string
, make_number (charpos
));
5114 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5116 else if (part
== ON_LEFT_FRINGE
)
5118 posn
= Qleft_fringe
;
5121 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5122 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5123 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5125 else if (part
== ON_RIGHT_FRINGE
)
5127 posn
= Qright_fringe
;
5130 - window_box_width (w
, LEFT_MARGIN_AREA
)
5131 - window_box_width (w
, TEXT_AREA
)
5132 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5133 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5135 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5137 else if (part
== ON_VERTICAL_BORDER
)
5139 posn
= Qvertical_line
;
5144 /* Nothing special for part == ON_SCROLL_BAR. */
5146 /* For clicks in the text area, fringes, or margins, call
5147 buffer_posn_from_coords to extract TEXTPOS, the buffer
5148 position nearest to the click. */
5151 Lisp_Object string2
, object2
= Qnil
;
5152 struct display_pos p
;
5154 int width2
, height2
;
5155 /* The pixel X coordinate passed to buffer_posn_from_coords
5156 is the X coordinate relative to the text area for
5157 text-area and right-margin clicks, zero otherwise. */
5159 = (part
== ON_TEXT
) ? xret
5160 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5161 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5165 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5166 &object2
, &dx2
, &dy2
,
5168 textpos
= CHARPOS (p
.pos
);
5169 if (col
< 0) col
= x2
;
5170 if (row
< 0) row
= y2
;
5171 if (dx
< 0) dx
= dx2
;
5172 if (dy
< 0) dy
= dy2
;
5173 if (width
< 0) width
= width2
;
5174 if (height
< 0) height
= height2
;
5178 posn
= make_number (textpos
);
5179 if (STRINGP (string2
))
5180 string_info
= Fcons (string2
,
5181 make_number (CHARPOS (p
.string_pos
)));
5187 #ifdef HAVE_WINDOW_SYSTEM
5188 if (IMAGEP (object
))
5190 Lisp_Object image_map
, hotspot
;
5191 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5193 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5195 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5196 posn
= XCAR (hotspot
);
5203 Fcons (make_number (dx
), make_number (dy
)),
5204 Fcons (make_number (width
), make_number (height
)));
5207 extra_info
= Fcons (string_info
,
5208 Fcons (make_number (textpos
),
5209 Fcons (Fcons (make_number (col
),
5214 XSETFRAME (window
, f
);
5218 return Fcons (window
,
5220 Fcons (Fcons (make_number (xret
),
5221 make_number (yret
)),
5222 Fcons (make_number (time
),
5226 /* Given a struct input_event, build the lisp event which represents
5227 it. If EVENT is 0, build a mouse movement event from the mouse
5228 movement buffer, which should have a movement event in it.
5230 Note that events must be passed to this function in the order they
5231 are received; this function stores the location of button presses
5232 in order to build drag events when the button is released. */
5235 make_lispy_event (struct input_event
*event
)
5239 switch (SWITCH_ENUM_CAST (event
->kind
))
5241 /* A simple keystroke. */
5242 case ASCII_KEYSTROKE_EVENT
:
5243 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5245 Lisp_Object lispy_c
;
5246 EMACS_INT c
= event
->code
;
5247 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5250 eassert (c
== event
->code
);
5251 /* Turn ASCII characters into control characters
5253 if (event
->modifiers
& ctrl_modifier
)
5255 c
= make_ctrl_char (c
);
5256 event
->modifiers
&= ~ctrl_modifier
;
5260 /* Add in the other modifier bits. The shift key was taken care
5261 of by the X code. */
5262 c
|= (event
->modifiers
5263 & (meta_modifier
| alt_modifier
5264 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5265 /* Distinguish Shift-SPC from SPC. */
5266 if ((event
->code
) == 040
5267 && event
->modifiers
& shift_modifier
)
5268 c
|= shift_modifier
;
5269 button_down_time
= 0;
5270 XSETFASTINT (lispy_c
, c
);
5275 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5276 except that they are non-key events (last-nonmenu-event is nil). */
5277 case NS_NONKEY_EVENT
:
5280 /* A function key. The symbol may need to have modifier prefixes
5282 case NON_ASCII_KEYSTROKE_EVENT
:
5283 button_down_time
= 0;
5285 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5286 if (event
->code
== lispy_accent_codes
[i
])
5287 return modify_event_symbol (i
,
5289 Qfunction_key
, Qnil
,
5290 lispy_accent_keys
, &accent_key_syms
,
5291 (sizeof (lispy_accent_keys
)
5292 / sizeof (lispy_accent_keys
[0])));
5296 if (event
->code
>= 0x400 && event
->code
< 0x500)
5297 return modify_event_symbol (event
->code
- 0x400,
5298 event
->modifiers
& ~shift_modifier
,
5299 Qfunction_key
, Qnil
,
5300 lispy_kana_keys
, &func_key_syms
,
5301 (sizeof (lispy_kana_keys
)
5302 / sizeof (lispy_kana_keys
[0])));
5303 #endif /* XK_kana_A */
5306 #ifdef ISO_FUNCTION_KEY_OFFSET
5307 if (event
->code
< FUNCTION_KEY_OFFSET
5308 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5309 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5311 Qfunction_key
, Qnil
,
5312 iso_lispy_function_keys
, &func_key_syms
,
5313 (sizeof (iso_lispy_function_keys
)
5314 / sizeof (iso_lispy_function_keys
[0])));
5317 /* Handle system-specific or unknown keysyms. */
5318 if (event
->code
& (1 << 28)
5319 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5320 || (event
->code
- FUNCTION_KEY_OFFSET
5321 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5322 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5324 /* We need to use an alist rather than a vector as the cache
5325 since we can't make a vector long enuf. */
5326 if (NILP (current_kboard
->system_key_syms
))
5327 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5328 return modify_event_symbol (event
->code
,
5331 current_kboard
->Vsystem_key_alist
,
5332 0, ¤t_kboard
->system_key_syms
,
5336 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5338 Qfunction_key
, Qnil
,
5339 lispy_function_keys
, &func_key_syms
,
5340 (sizeof (lispy_function_keys
)
5341 / sizeof (lispy_function_keys
[0])));
5344 case MULTIMEDIA_KEY_EVENT
:
5345 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5346 / sizeof (lispy_multimedia_keys
[0]))
5347 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5349 return modify_event_symbol (event
->code
, event
->modifiers
,
5350 Qfunction_key
, Qnil
,
5351 lispy_multimedia_keys
, &func_key_syms
,
5352 (sizeof (lispy_multimedia_keys
)
5353 / sizeof (lispy_multimedia_keys
[0])));
5359 /* A mouse click. Figure out where it is, decide whether it's
5360 a press, click or drag, and build the appropriate structure. */
5361 case MOUSE_CLICK_EVENT
:
5362 #ifndef USE_TOOLKIT_SCROLL_BARS
5363 case SCROLL_BAR_CLICK_EVENT
:
5366 int button
= event
->code
;
5368 Lisp_Object position
;
5369 Lisp_Object
*start_pos_ptr
;
5370 Lisp_Object start_pos
;
5374 /* Build the position as appropriate for this mouse click. */
5375 if (event
->kind
== MOUSE_CLICK_EVENT
)
5377 struct frame
*f
= XFRAME (event
->frame_or_window
);
5378 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5382 /* Ignore mouse events that were made on frame that
5383 have been deleted. */
5384 if (! FRAME_LIVE_P (f
))
5387 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5388 /* EVENT->x and EVENT->y are frame-relative pixel
5389 coordinates at this place. Under old redisplay, COLUMN
5390 and ROW are set to frame relative glyph coordinates
5391 which are then used to determine whether this click is
5392 in a menu (non-toolkit version). */
5393 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5394 &column
, &row
, NULL
, 1);
5396 /* In the non-toolkit version, clicks on the menu bar
5397 are ordinary button events in the event buffer.
5398 Distinguish them, and invoke the menu.
5400 (In the toolkit version, the toolkit handles the menu bar
5401 and Emacs doesn't know about it until after the user
5402 makes a selection.) */
5403 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5404 && (event
->modifiers
& down_modifier
))
5406 Lisp_Object items
, item
;
5410 /* Find the menu bar item under `column'. */
5412 items
= FRAME_MENU_BAR_ITEMS (f
);
5413 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5415 Lisp_Object pos
, string
;
5416 string
= AREF (items
, i
+ 1);
5417 pos
= AREF (items
, i
+ 3);
5420 if (column
>= XINT (pos
)
5421 && column
< XINT (pos
) + SCHARS (string
))
5423 item
= AREF (items
, i
);
5428 /* ELisp manual 2.4b says (x y) are window relative but
5429 code says they are frame-relative. */
5431 = Fcons (event
->frame_or_window
,
5433 Fcons (Fcons (event
->x
, event
->y
),
5434 Fcons (make_number (event
->timestamp
),
5437 return Fcons (item
, Fcons (position
, Qnil
));
5439 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5441 position
= make_lispy_position (f
, event
->x
, event
->y
,
5444 #ifndef USE_TOOLKIT_SCROLL_BARS
5447 /* It's a scrollbar click. */
5449 Lisp_Object portion_whole
;
5452 window
= event
->frame_or_window
;
5453 portion_whole
= Fcons (event
->x
, event
->y
);
5454 part
= *scroll_bar_parts
[(int) event
->part
];
5458 Fcons (Qvertical_scroll_bar
,
5459 Fcons (portion_whole
,
5460 Fcons (make_number (event
->timestamp
),
5461 Fcons (part
, Qnil
)))));
5463 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5465 if (button
>= ASIZE (button_down_location
))
5467 button_down_location
= larger_vector (button_down_location
,
5469 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5472 start_pos_ptr
= &AREF (button_down_location
, button
);
5473 start_pos
= *start_pos_ptr
;
5474 *start_pos_ptr
= Qnil
;
5477 /* On window-system frames, use the value of
5478 double-click-fuzz as is. On other frames, interpret it
5479 as a multiple of 1/8 characters. */
5483 if (WINDOWP (event
->frame_or_window
))
5484 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5485 else if (FRAMEP (event
->frame_or_window
))
5486 f
= XFRAME (event
->frame_or_window
);
5490 if (FRAME_WINDOW_P (f
))
5491 fuzz
= double_click_fuzz
;
5493 fuzz
= double_click_fuzz
/ 8;
5495 is_double
= (button
== last_mouse_button
5496 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5497 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5498 && button_down_time
!= 0
5499 && (EQ (Vdouble_click_time
, Qt
)
5500 || (INTEGERP (Vdouble_click_time
)
5501 && ((int)(event
->timestamp
- button_down_time
)
5502 < XINT (Vdouble_click_time
)))));
5505 last_mouse_button
= button
;
5506 last_mouse_x
= XINT (event
->x
);
5507 last_mouse_y
= XINT (event
->y
);
5509 /* If this is a button press, squirrel away the location, so
5510 we can decide later whether it was a click or a drag. */
5511 if (event
->modifiers
& down_modifier
)
5515 double_click_count
++;
5516 event
->modifiers
|= ((double_click_count
> 2)
5521 double_click_count
= 1;
5522 button_down_time
= event
->timestamp
;
5523 *start_pos_ptr
= Fcopy_alist (position
);
5524 ignore_mouse_drag_p
= 0;
5527 /* Now we're releasing a button - check the co-ordinates to
5528 see if this was a click or a drag. */
5529 else if (event
->modifiers
& up_modifier
)
5531 /* If we did not see a down before this up, ignore the up.
5532 Probably this happened because the down event chose a
5533 menu item. It would be an annoyance to treat the
5534 release of the button that chose the menu item as a
5537 if (!CONSP (start_pos
))
5540 event
->modifiers
&= ~up_modifier
;
5543 Lisp_Object new_down
, down
;
5544 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5546 /* The third element of every position
5547 should be the (x,y) pair. */
5548 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5549 new_down
= Fcar (Fcdr (Fcdr (position
)));
5552 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5554 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5555 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5558 if (ignore_mouse_drag_p
)
5560 event
->modifiers
|= click_modifier
;
5561 ignore_mouse_drag_p
= 0;
5563 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5564 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5565 /* Maybe the mouse has moved a lot, caused scrolling, and
5566 eventually ended up at the same screen position (but
5567 not buffer position) in which case it is a drag, not
5569 /* FIXME: OTOH if the buffer position has changed
5570 because of a timer or process filter rather than
5571 because of mouse movement, it should be considered as
5572 a click. But mouse-drag-region completely ignores
5573 this case and it hasn't caused any real problem, so
5574 it's probably OK to ignore it as well. */
5575 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5576 /* Mouse hasn't moved (much). */
5577 event
->modifiers
|= click_modifier
;
5580 button_down_time
= 0;
5581 event
->modifiers
|= drag_modifier
;
5584 /* Don't check is_double; treat this as multiple
5585 if the down-event was multiple. */
5586 if (double_click_count
> 1)
5587 event
->modifiers
|= ((double_click_count
> 2)
5593 /* Every mouse event should either have the down_modifier or
5594 the up_modifier set. */
5598 /* Get the symbol we should use for the mouse click. */
5601 head
= modify_event_symbol (button
,
5603 Qmouse_click
, Vlispy_mouse_stem
,
5606 XVECTOR (mouse_syms
)->size
);
5607 if (event
->modifiers
& drag_modifier
)
5612 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5615 Fcons (make_number (double_click_count
),
5625 case HORIZ_WHEEL_EVENT
:
5627 Lisp_Object position
;
5630 /* Build the position as appropriate for this mouse click. */
5631 struct frame
*f
= XFRAME (event
->frame_or_window
);
5633 /* Ignore wheel events that were made on frame that have been
5635 if (! FRAME_LIVE_P (f
))
5638 position
= make_lispy_position (f
, event
->x
, event
->y
,
5641 /* Set double or triple modifiers to indicate the wheel speed. */
5643 /* On window-system frames, use the value of
5644 double-click-fuzz as is. On other frames, interpret it
5645 as a multiple of 1/8 characters. */
5651 if (WINDOWP (event
->frame_or_window
))
5652 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5653 else if (FRAMEP (event
->frame_or_window
))
5654 f
= XFRAME (event
->frame_or_window
);
5658 fuzz
= FRAME_WINDOW_P (f
)
5659 ? double_click_fuzz
: double_click_fuzz
/ 8;
5661 if (event
->modifiers
& up_modifier
)
5663 /* Emit a wheel-up event. */
5664 event
->modifiers
&= ~up_modifier
;
5667 else if (event
->modifiers
& down_modifier
)
5669 /* Emit a wheel-down event. */
5670 event
->modifiers
&= ~down_modifier
;
5674 /* Every wheel event should either have the down_modifier or
5675 the up_modifier set. */
5678 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5681 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5682 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5683 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5684 && button_down_time
!= 0
5685 && (EQ (Vdouble_click_time
, Qt
)
5686 || (INTEGERP (Vdouble_click_time
)
5687 && ((int)(event
->timestamp
- button_down_time
)
5688 < XINT (Vdouble_click_time
)))));
5691 double_click_count
++;
5692 event
->modifiers
|= ((double_click_count
> 2)
5698 double_click_count
= 1;
5699 event
->modifiers
|= click_modifier
;
5702 button_down_time
= event
->timestamp
;
5703 /* Use a negative value to distinguish wheel from mouse button. */
5704 last_mouse_button
= - (1 + symbol_num
);
5705 last_mouse_x
= XINT (event
->x
);
5706 last_mouse_y
= XINT (event
->y
);
5708 /* Get the symbol we should use for the wheel event. */
5709 head
= modify_event_symbol (symbol_num
,
5715 ASIZE (wheel_syms
));
5718 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5721 Fcons (make_number (double_click_count
),
5730 #ifdef USE_TOOLKIT_SCROLL_BARS
5732 /* We don't have down and up events if using toolkit scroll bars,
5733 so make this always a click event. Store in the `part' of
5734 the Lisp event a symbol which maps to the following actions:
5736 `above_handle' page up
5737 `below_handle' page down
5741 `bottom' bottom of buffer
5742 `handle' thumb has been dragged.
5743 `end-scroll' end of interaction with scroll bar
5745 The incoming input_event contains in its `part' member an
5746 index of type `enum scroll_bar_part' which we can use as an
5747 index in scroll_bar_parts to get the appropriate symbol. */
5749 case SCROLL_BAR_CLICK_EVENT
:
5751 Lisp_Object position
, head
, window
, portion_whole
, part
;
5753 window
= event
->frame_or_window
;
5754 portion_whole
= Fcons (event
->x
, event
->y
);
5755 part
= *scroll_bar_parts
[(int) event
->part
];
5759 Fcons (Qvertical_scroll_bar
,
5760 Fcons (portion_whole
,
5761 Fcons (make_number (event
->timestamp
),
5762 Fcons (part
, Qnil
)))));
5764 /* Always treat scroll bar events as clicks. */
5765 event
->modifiers
|= click_modifier
;
5766 event
->modifiers
&= ~up_modifier
;
5768 if (event
->code
>= ASIZE (mouse_syms
))
5769 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5771 /* Get the symbol we should use for the mouse click. */
5772 head
= modify_event_symbol (event
->code
,
5777 XVECTOR (mouse_syms
)->size
);
5778 return Fcons (head
, Fcons (position
, Qnil
));
5781 #endif /* USE_TOOLKIT_SCROLL_BARS */
5783 case DRAG_N_DROP_EVENT
:
5786 Lisp_Object head
, position
;
5789 f
= XFRAME (event
->frame_or_window
);
5792 /* Ignore mouse events that were made on frames that
5793 have been deleted. */
5794 if (! FRAME_LIVE_P (f
))
5797 position
= make_lispy_position (f
, event
->x
, event
->y
,
5800 head
= modify_event_symbol (0, event
->modifiers
,
5802 lispy_drag_n_drop_names
,
5803 &drag_n_drop_syms
, 1);
5809 #endif /* HAVE_MOUSE */
5811 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5812 || defined(HAVE_NS) || defined (USE_GTK)
5813 case MENU_BAR_EVENT
:
5814 if (EQ (event
->arg
, event
->frame_or_window
))
5815 /* This is the prefix key. We translate this to
5816 `(menu_bar)' because the code in keyboard.c for menu
5817 events, which we use, relies on this. */
5818 return Fcons (Qmenu_bar
, Qnil
);
5822 case SELECT_WINDOW_EVENT
:
5823 /* Make an event (select-window (WINDOW)). */
5824 return Fcons (Qselect_window
,
5825 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5828 case TOOL_BAR_EVENT
:
5829 if (EQ (event
->arg
, event
->frame_or_window
))
5830 /* This is the prefix key. We translate this to
5831 `(tool_bar)' because the code in keyboard.c for tool bar
5832 events, which we use, relies on this. */
5833 return Fcons (Qtool_bar
, Qnil
);
5834 else if (SYMBOLP (event
->arg
))
5835 return apply_modifiers (event
->modifiers
, event
->arg
);
5840 case USER_SIGNAL_EVENT
:
5841 /* A user signal. */
5843 char *name
= find_user_signal_name (event
->code
);
5846 return intern (name
);
5849 case SAVE_SESSION_EVENT
:
5850 return Qsave_session
;
5855 return Fcons (Qdbus_event
, event
->arg
);
5857 #endif /* HAVE_DBUS */
5860 printf("cool, an xwidget event arrived in make_lispy_event!\n");
5861 return Fcons (Qxwidget_event
,event
->arg
);
5864 case CONFIG_CHANGED_EVENT
:
5865 return Fcons (Qconfig_changed_event
,
5867 Fcons (event
->frame_or_window
, Qnil
)));
5869 case GPM_CLICK_EVENT
:
5871 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5872 Lisp_Object head
, position
;
5873 Lisp_Object
*start_pos_ptr
;
5874 Lisp_Object start_pos
;
5875 int button
= event
->code
;
5877 if (button
>= ASIZE (button_down_location
))
5879 button_down_location
= larger_vector (button_down_location
,
5881 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5884 start_pos_ptr
= &AREF (button_down_location
, button
);
5885 start_pos
= *start_pos_ptr
;
5887 position
= make_lispy_position (f
, event
->x
, event
->y
,
5890 if (event
->modifiers
& down_modifier
)
5891 *start_pos_ptr
= Fcopy_alist (position
);
5892 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5894 if (!CONSP (start_pos
))
5896 event
->modifiers
&= ~up_modifier
;
5899 head
= modify_event_symbol (button
,
5901 Qmouse_click
, Vlispy_mouse_stem
,
5904 XVECTOR (mouse_syms
)->size
);
5906 if (event
->modifiers
& drag_modifier
)
5911 else if (event
->modifiers
& double_modifier
)
5914 Fcons (make_number (2),
5916 else if (event
->modifiers
& triple_modifier
)
5919 Fcons (make_number (3),
5926 #endif /* HAVE_GPM */
5928 /* The 'kind' field of the event is something we don't recognize. */
5934 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
5937 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5938 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
5940 /* Is it a scroll bar movement? */
5941 if (frame
&& ! NILP (bar_window
))
5943 Lisp_Object part_sym
;
5945 part_sym
= *scroll_bar_parts
[(int) part
];
5946 return Fcons (Qscroll_bar_movement
,
5947 Fcons (list5 (bar_window
,
5948 Qvertical_scroll_bar
,
5954 /* Or is it an ordinary mouse movement? */
5957 Lisp_Object position
;
5958 position
= make_lispy_position (frame
, x
, y
, time
);
5959 return list2 (Qmouse_movement
, position
);
5963 #endif /* HAVE_MOUSE || HAVE GPM */
5965 /* Construct a switch frame event. */
5967 make_lispy_switch_frame (Lisp_Object frame
)
5969 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5972 /* Manipulating modifiers. */
5974 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5976 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5977 SYMBOL's name of the end of the modifiers; the string from this
5978 position is the unmodified symbol name.
5980 This doesn't use any caches. */
5983 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
5989 CHECK_SYMBOL (symbol
);
5992 name
= SYMBOL_NAME (symbol
);
5994 for (i
= 0; i
+2 <= SBYTES (name
); )
5996 int this_mod_end
= 0;
5999 /* See if the name continues with a modifier word.
6000 Check that the word appears, but don't check what follows it.
6001 Set this_mod and this_mod_end to record what we find. */
6003 switch (SREF (name
, i
))
6005 #define SINGLE_LETTER_MOD(BIT) \
6006 (this_mod_end = i + 1, this_mod = BIT)
6009 SINGLE_LETTER_MOD (alt_modifier
);
6013 SINGLE_LETTER_MOD (ctrl_modifier
);
6017 SINGLE_LETTER_MOD (hyper_modifier
);
6021 SINGLE_LETTER_MOD (meta_modifier
);
6025 SINGLE_LETTER_MOD (shift_modifier
);
6029 SINGLE_LETTER_MOD (super_modifier
);
6032 #undef SINGLE_LETTER_MOD
6034 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6035 if (i + LEN + 1 <= SBYTES (name) \
6036 && ! strncmp (SSDATA (name) + i, NAME, LEN)) \
6038 this_mod_end = i + LEN; \
6043 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6044 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6045 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6049 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6051 #undef MULTI_LETTER_MOD
6055 /* If we found no modifier, stop looking for them. */
6056 if (this_mod_end
== 0)
6059 /* Check there is a dash after the modifier, so that it
6060 really is a modifier. */
6061 if (this_mod_end
>= SBYTES (name
)
6062 || SREF (name
, this_mod_end
) != '-')
6065 /* This modifier is real; look for another. */
6066 modifiers
|= this_mod
;
6067 i
= this_mod_end
+ 1;
6070 /* Should we include the `click' modifier? */
6071 if (! (modifiers
& (down_modifier
| drag_modifier
6072 | double_modifier
| triple_modifier
))
6073 && i
+ 7 == SBYTES (name
)
6074 && strncmp (SSDATA (name
) + i
, "mouse-", 6) == 0
6075 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6076 modifiers
|= click_modifier
;
6078 if (! (modifiers
& (double_modifier
| triple_modifier
))
6079 && i
+ 6 < SBYTES (name
)
6080 && strncmp (SSDATA (name
) + i
, "wheel-", 6) == 0)
6081 modifiers
|= click_modifier
;
6089 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6090 prepended to the string BASE[0..BASE_LEN-1].
6091 This doesn't use any caches. */
6093 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6095 /* Since BASE could contain nulls, we can't use intern here; we have
6096 to use Fintern, which expects a genuine Lisp_String, and keeps a
6099 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6105 /* Only the event queue may use the `up' modifier; it should always
6106 be turned into a click or drag event before presented to lisp code. */
6107 if (modifiers
& up_modifier
)
6110 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6111 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6112 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6113 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6114 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6115 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6116 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6117 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6118 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6119 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6120 /* The click modifier is denoted by the absence of other modifiers. */
6124 mod_len
= p
- new_mods
;
6128 Lisp_Object new_name
;
6130 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6131 mod_len
+ base_len_byte
);
6132 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6133 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6135 return Fintern (new_name
, Qnil
);
6140 static const char *const modifier_names
[] =
6142 "up", "down", "drag", "click", "double", "triple", 0, 0,
6143 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6144 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6146 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6148 static Lisp_Object modifier_symbols
;
6150 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6152 lispy_modifier_list (int modifiers
)
6154 Lisp_Object modifier_list
;
6157 modifier_list
= Qnil
;
6158 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6159 if (modifiers
& (1<<i
))
6160 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6163 return modifier_list
;
6167 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6168 where UNMODIFIED is the unmodified form of SYMBOL,
6169 MASK is the set of modifiers present in SYMBOL's name.
6170 This is similar to parse_modifiers_uncached, but uses the cache in
6171 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6172 Qevent_symbol_elements property. */
6174 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6177 parse_modifiers (Lisp_Object symbol
)
6179 Lisp_Object elements
;
6181 if (INTEGERP (symbol
))
6182 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6183 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6185 else if (!SYMBOLP (symbol
))
6188 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6189 if (CONSP (elements
))
6194 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6195 Lisp_Object unmodified
;
6198 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6199 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6202 if (modifiers
& ~INTMASK
)
6204 XSETFASTINT (mask
, modifiers
);
6205 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6207 /* Cache the parsing results on SYMBOL. */
6208 Fput (symbol
, Qevent_symbol_element_mask
,
6210 Fput (symbol
, Qevent_symbol_elements
,
6211 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6213 /* Since we know that SYMBOL is modifiers applied to unmodified,
6214 it would be nice to put that in unmodified's cache.
6215 But we can't, since we're not sure that parse_modifiers is
6222 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6223 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6224 doc
: /* Parse the event symbol. For internal use. */)
6225 (Lisp_Object symbol
)
6227 /* Fill the cache if needed. */
6228 parse_modifiers (symbol
);
6229 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6230 and use the Lispier representation stored on Qevent_symbol_elements
6232 return Fget (symbol
, Qevent_symbol_elements
);
6235 /* Apply the modifiers MODIFIERS to the symbol BASE.
6236 BASE must be unmodified.
6238 This is like apply_modifiers_uncached, but uses BASE's
6239 Qmodifier_cache property, if present. It also builds
6240 Qevent_symbol_elements properties, since it has that info anyway.
6242 apply_modifiers copies the value of BASE's Qevent_kind property to
6243 the modified symbol. */
6245 apply_modifiers (int modifiers
, Lisp_Object base
)
6247 Lisp_Object cache
, index
, entry
, new_symbol
;
6249 /* Mask out upper bits. We don't know where this value's been. */
6250 modifiers
&= INTMASK
;
6252 if (INTEGERP (base
))
6253 return make_number (XINT (base
) | modifiers
);
6255 /* The click modifier never figures into cache indices. */
6256 cache
= Fget (base
, Qmodifier_cache
);
6257 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6258 entry
= assq_no_quit (index
, cache
);
6261 new_symbol
= XCDR (entry
);
6264 /* We have to create the symbol ourselves. */
6265 new_symbol
= apply_modifiers_uncached (modifiers
,
6266 SSDATA (SYMBOL_NAME (base
)),
6267 SCHARS (SYMBOL_NAME (base
)),
6268 SBYTES (SYMBOL_NAME (base
)));
6270 /* Add the new symbol to the base's cache. */
6271 entry
= Fcons (index
, new_symbol
);
6272 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6274 /* We have the parsing info now for free, so we could add it to
6276 XSETFASTINT (index, modifiers);
6277 Fput (new_symbol, Qevent_symbol_element_mask,
6278 Fcons (base, Fcons (index, Qnil)));
6279 Fput (new_symbol, Qevent_symbol_elements,
6280 Fcons (base, lispy_modifier_list (modifiers)));
6281 Sadly, this is only correct if `base' is indeed a base event,
6282 which is not necessarily the case. -stef */
6285 /* Make sure this symbol is of the same kind as BASE.
6287 You'd think we could just set this once and for all when we
6288 intern the symbol above, but reorder_modifiers may call us when
6289 BASE's property isn't set right; we can't assume that just
6290 because it has a Qmodifier_cache property it must have its
6291 Qevent_kind set right as well. */
6292 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6296 kind
= Fget (base
, Qevent_kind
);
6298 Fput (new_symbol
, Qevent_kind
, kind
);
6305 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6306 return a symbol with the modifiers placed in the canonical order.
6307 Canonical order is alphabetical, except for down and drag, which
6308 always come last. The 'click' modifier is never written out.
6310 Fdefine_key calls this to make sure that (for example) C-M-foo
6311 and M-C-foo end up being equivalent in the keymap. */
6314 reorder_modifiers (Lisp_Object symbol
)
6316 /* It's hopefully okay to write the code this way, since everything
6317 will soon be in caches, and no consing will be done at all. */
6320 parsed
= parse_modifiers (symbol
);
6321 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6326 /* For handling events, we often want to produce a symbol whose name
6327 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6328 to some base, like the name of a function key or mouse button.
6329 modify_event_symbol produces symbols of this sort.
6331 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6332 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6335 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6336 into symbol names, or a string specifying a name stem used to
6337 construct a symbol name or the form `STEM-N', where N is the decimal
6338 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6339 non-nil; otherwise NAME_TABLE is used.
6341 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6342 persist between calls to modify_event_symbol that it can use to
6343 store a cache of the symbols it's generated for this NAME_TABLE
6344 before. The object stored there may be a vector or an alist.
6346 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6348 MODIFIERS is a set of modifier bits (as given in struct input_events)
6349 whose prefixes should be applied to the symbol name.
6351 SYMBOL_KIND is the value to be placed in the event_kind property of
6352 the returned symbol.
6354 The symbols we create are supposed to have an
6355 `event-symbol-elements' property, which lists the modifiers present
6356 in the symbol's name. */
6359 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6360 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6361 Lisp_Object
*symbol_table
, unsigned int table_size
)
6364 Lisp_Object symbol_int
;
6366 /* Get rid of the "vendor-specific" bit here. */
6367 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6369 /* Is this a request for a valid symbol? */
6370 if (symbol_num
< 0 || symbol_num
>= table_size
)
6373 if (CONSP (*symbol_table
))
6374 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6376 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6377 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6378 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6379 we've never used that symbol before. */
6382 if (! VECTORP (*symbol_table
)
6383 || XVECTOR (*symbol_table
)->size
!= table_size
)
6387 XSETFASTINT (size
, table_size
);
6388 *symbol_table
= Fmake_vector (size
, Qnil
);
6391 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6394 /* Have we already used this symbol before? */
6397 /* No; let's create it. */
6398 if (CONSP (name_alist_or_stem
))
6399 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6400 else if (STRINGP (name_alist_or_stem
))
6402 int len
= SBYTES (name_alist_or_stem
);
6403 char *buf
= (char *) alloca (len
+ 50);
6404 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6405 (long) XINT (symbol_int
) + 1);
6406 value
= intern (buf
);
6408 else if (name_table
!= 0 && name_table
[symbol_num
])
6409 value
= intern (name_table
[symbol_num
]);
6411 #ifdef HAVE_WINDOW_SYSTEM
6414 char *name
= x_get_keysym_name (symbol_num
);
6416 value
= intern (name
);
6423 sprintf (buf
, "key-%ld", (long)symbol_num
);
6424 value
= intern (buf
);
6427 if (CONSP (*symbol_table
))
6428 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6430 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6432 /* Fill in the cache entries for this symbol; this also
6433 builds the Qevent_symbol_elements property, which the user
6435 apply_modifiers (modifiers
& click_modifier
, value
);
6436 Fput (value
, Qevent_kind
, symbol_kind
);
6439 /* Apply modifiers to that symbol. */
6440 return apply_modifiers (modifiers
, value
);
6443 /* Convert a list that represents an event type,
6444 such as (ctrl meta backspace), into the usual representation of that
6445 event type as a number or a symbol. */
6447 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6448 doc
: /* Convert the event description list EVENT-DESC to an event type.
6449 EVENT-DESC should contain one base event type (a character or symbol)
6450 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6451 drag, down, double or triple). The base must be last.
6452 The return value is an event type (a character or symbol) which
6453 has the same base event type and all the specified modifiers. */)
6454 (Lisp_Object event_desc
)
6462 while (CONSP (rest
))
6470 /* Given a symbol, see if it is a modifier name. */
6471 if (SYMBOLP (elt
) && CONSP (rest
))
6472 this = parse_solitary_modifier (elt
);
6476 else if (!NILP (base
))
6477 error ("Two bases given in one event");
6483 /* Let the symbol A refer to the character A. */
6484 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6485 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6487 if (INTEGERP (base
))
6489 /* Turn (shift a) into A. */
6490 if ((modifiers
& shift_modifier
) != 0
6491 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6493 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6494 modifiers
&= ~shift_modifier
;
6497 /* Turn (control a) into C-a. */
6498 if (modifiers
& ctrl_modifier
)
6499 return make_number ((modifiers
& ~ctrl_modifier
)
6500 | make_ctrl_char (XINT (base
)));
6502 return make_number (modifiers
| XINT (base
));
6504 else if (SYMBOLP (base
))
6505 return apply_modifiers (modifiers
, base
);
6508 error ("Invalid base event");
6513 /* Try to recognize SYMBOL as a modifier name.
6514 Return the modifier flag bit, or 0 if not recognized. */
6517 parse_solitary_modifier (Lisp_Object symbol
)
6519 Lisp_Object name
= SYMBOL_NAME (symbol
);
6521 switch (SREF (name
, 0))
6523 #define SINGLE_LETTER_MOD(BIT) \
6524 if (SBYTES (name) == 1) \
6527 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6528 if (LEN == SBYTES (name) \
6529 && ! strncmp (SDATA (name), NAME, LEN)) \
6533 SINGLE_LETTER_MOD (alt_modifier
);
6537 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6541 SINGLE_LETTER_MOD (ctrl_modifier
);
6545 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6546 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6550 SINGLE_LETTER_MOD (hyper_modifier
);
6554 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6558 SINGLE_LETTER_MOD (meta_modifier
);
6562 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6566 SINGLE_LETTER_MOD (shift_modifier
);
6570 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6571 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6572 SINGLE_LETTER_MOD (super_modifier
);
6576 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6577 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6578 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6582 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6585 #undef SINGLE_LETTER_MOD
6586 #undef MULTI_LETTER_MOD
6592 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6593 Such a list is not valid as an event,
6594 but it can be a Lucid-style event type list. */
6597 lucid_event_type_list_p (Lisp_Object object
)
6601 if (! CONSP (object
))
6604 if (EQ (XCAR (object
), Qhelp_echo
)
6605 || EQ (XCAR (object
), Qvertical_line
)
6606 || EQ (XCAR (object
), Qmode_line
)
6607 || EQ (XCAR (object
), Qheader_line
))
6610 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6614 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6621 /* Store into *addr a value nonzero if terminal input chars are available.
6622 Serves the purpose of ioctl (0, FIONREAD, addr)
6623 but works even if FIONREAD does not exist.
6624 (In fact, this may actually read some input.)
6626 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6627 timer events that are ripe.
6628 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6629 events (FOCUS_IN_EVENT).
6630 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6631 movements and toolkit scroll bar thumb drags. */
6634 get_input_pending (int *addr
, int flags
)
6636 /* First of all, have we already counted some input? */
6637 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6639 /* If input is being read as it arrives, and we have none, there is none. */
6640 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6643 /* Try to read some input and see how much we get. */
6645 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6648 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6651 gobble_input (int expected
)
6654 if (interrupt_input
)
6657 mask
= sigblock (sigmask (SIGIO
));
6658 read_avail_input (expected
);
6662 #ifdef POLL_FOR_INPUT
6663 /* XXX This condition was (read_socket_hook && !interrupt_input),
6664 but read_socket_hook is not global anymore. Let's pretend that
6666 if (!interrupt_input
&& poll_suppress_count
== 0)
6669 mask
= sigblock (sigmask (SIGALRM
));
6670 read_avail_input (expected
);
6676 read_avail_input (expected
);
6679 /* Put a BUFFER_SWITCH_EVENT in the buffer
6680 so that read_key_sequence will notice the new current buffer. */
6683 record_asynch_buffer_change (void)
6685 struct input_event event
;
6689 event
.kind
= BUFFER_SWITCH_EVENT
;
6690 event
.frame_or_window
= Qnil
;
6693 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6694 The purpose of the event is to make read_key_sequence look up the
6695 keymaps again. If we aren't in read_key_sequence, we don't need one,
6696 and the event could cause trouble by messing up (input-pending-p).
6697 Note: Fwaiting_for_user_input_p always returns nil when async
6698 subprocesses aren't supported. */
6699 tem
= Fwaiting_for_user_input_p ();
6703 /* Make sure no interrupt happens while storing the event. */
6705 if (interrupt_input
)
6708 mask
= sigblock (sigmask (SIGIO
));
6709 kbd_buffer_store_event (&event
);
6716 kbd_buffer_store_event (&event
);
6721 /* Read any terminal input already buffered up by the system
6722 into the kbd_buffer, but do not wait.
6724 EXPECTED should be nonzero if the caller knows there is some input.
6726 Returns the number of keyboard chars read, or -1 meaning
6727 this is a bad time to try to read input. */
6730 read_avail_input (int expected
)
6736 /* Store pending user signal events, if any. */
6737 if (store_user_signal_events ())
6740 /* Loop through the available terminals, and call their input hooks. */
6744 struct terminal
*next
= t
->next_terminal
;
6746 if (t
->read_socket_hook
)
6749 struct input_event hold_quit
;
6751 EVENT_INIT (hold_quit
);
6752 hold_quit
.kind
= NO_EVENT
;
6754 /* No need for FIONREAD or fcntl; just say don't wait. */
6755 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6761 if (nr
== -1) /* Not OK to read input now. */
6765 else if (nr
== -2) /* Non-transient error. */
6767 /* The terminal device terminated; it should be closed. */
6769 /* Kill Emacs if this was our last terminal. */
6770 if (!terminal_list
->next_terminal
)
6771 /* Formerly simply reported no input, but that
6772 sometimes led to a failure of Emacs to terminate.
6773 SIGHUP seems appropriate if we can't reach the
6775 /* ??? Is it really right to send the signal just to
6776 this process rather than to the whole process
6777 group? Perhaps on systems with FIONREAD Emacs is
6778 alone in its group. */
6779 kill (getpid (), SIGHUP
);
6781 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6784 XSETTERMINAL (tmp
, t
);
6785 Fdelete_terminal (tmp
, Qnoelisp
);
6789 if (hold_quit
.kind
!= NO_EVENT
)
6790 kbd_buffer_store_event (&hold_quit
);
6799 frame_make_pointer_visible ();
6805 decode_keyboard_code (struct tty_display_info
*tty
,
6806 struct coding_system
*coding
,
6807 unsigned char *buf
, int nbytes
)
6809 unsigned char *src
= buf
;
6810 const unsigned char *p
;
6815 if (tty
->meta_key
!= 2)
6816 for (i
= 0; i
< nbytes
; i
++)
6818 if (coding
->carryover_bytes
> 0)
6820 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6821 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6822 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6823 nbytes
+= coding
->carryover_bytes
;
6825 coding
->destination
= alloca (nbytes
* 4);
6826 coding
->dst_bytes
= nbytes
* 4;
6827 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6828 if (coding
->produced_char
== 0)
6830 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6832 struct input_event buf
;
6835 buf
.code
= STRING_CHAR_ADVANCE (p
);
6836 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
6837 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6838 /* See the comment in tty_read_avail_input. */
6839 buf
.frame_or_window
= tty
->top_frame
;
6841 kbd_buffer_store_event (&buf
);
6845 /* This is the tty way of reading available input.
6847 Note that each terminal device has its own `struct terminal' object,
6848 and so this function is called once for each individual termcap
6849 terminal. The first parameter indicates which terminal to read from. */
6852 tty_read_avail_input (struct terminal
*terminal
,
6854 struct input_event
*hold_quit
)
6856 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6857 the kbd_buffer can really hold. That may prevent loss
6858 of characters on some systems when input is stuffed at us. */
6859 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6861 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6864 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6866 if (kbd_on_hold_p () || buffer_free
<= 0)
6868 #endif /* subprocesses */
6870 if (!terminal
->name
) /* Don't read from a dead terminal. */
6873 if (terminal
->type
!= output_termcap
6874 && terminal
->type
!= output_msdos_raw
)
6877 /* XXX I think the following code should be moved to separate hook
6878 functions in system-dependent files. */
6881 #else /* not WINDOWSNT */
6882 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6886 return 0; /* The terminal is suspended. */
6889 n_to_read
= dos_keysns ();
6893 cbuf
[0] = dos_keyread ();
6896 #else /* not MSDOS */
6901 struct input_event hold_quit
;
6902 int gpm
, fd
= gpm_fd
;
6904 EVENT_INIT (hold_quit
);
6905 hold_quit
.kind
= NO_EVENT
;
6907 /* gpm==1 if event received.
6908 gpm==0 if the GPM daemon has closed the connection, in which case
6909 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6910 we save it in `fd' so close_gpm can remove it from the
6912 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6913 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6914 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
6917 /* Presumably the GPM daemon has closed the connection. */
6919 if (hold_quit
.kind
!= NO_EVENT
)
6920 kbd_buffer_store_event (&hold_quit
);
6924 #endif /* HAVE_GPM */
6926 /* Determine how many characters we should *try* to read. */
6928 /* Find out how much input is available. */
6929 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6931 if (! noninteractive
)
6932 return -2; /* Close this terminal. */
6938 if (n_to_read
> sizeof cbuf
)
6939 n_to_read
= sizeof cbuf
;
6940 #else /* no FIONREAD */
6941 #if defined (USG) || defined(CYGWIN)
6942 /* Read some input if available, but don't wait. */
6943 n_to_read
= sizeof cbuf
;
6944 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6951 /* Don't read more than we can store. */
6952 if (n_to_read
> buffer_free
)
6953 n_to_read
= buffer_free
;
6954 #endif /* subprocesses */
6956 /* Now read; for one reason or another, this will not block.
6957 NREAD is set to the number of chars read. */
6960 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6961 /* POSIX infers that processes which are not in the session leader's
6962 process group won't get SIGHUP's at logout time. BSDI adheres to
6963 this part standard and returns -1 from read (0) with errno==EIO
6964 when the control tty is taken away.
6965 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6966 if (nread
== -1 && errno
== EIO
)
6967 return -2; /* Close this terminal. */
6968 #if defined (AIX) && defined (_BSD)
6969 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6970 This looks incorrect, but it isn't, because _BSD causes
6971 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6972 and that causes a value other than 0 when there is no input. */
6974 return -2; /* Close this terminal. */
6978 /* We used to retry the read if it was interrupted.
6979 But this does the wrong thing when O_NDELAY causes
6980 an EAGAIN error. Does anybody know of a situation
6981 where a retry is actually needed? */
6983 nread
< 0 && (errno
== EAGAIN
6997 #if defined (USG) || defined (CYGWIN)
6998 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6999 #endif /* USG or CYGWIN */
7000 #endif /* no FIONREAD */
7005 #endif /* not MSDOS */
7006 #endif /* not WINDOWSNT */
7008 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7009 & CODING_REQUIRE_DECODING_MASK
)
7011 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7014 /* Decode the key sequence except for those with meta
7016 for (i
= from
= 0; ; i
++)
7017 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7019 struct input_event buf
;
7021 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7026 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7027 buf
.modifiers
= meta_modifier
;
7028 buf
.code
= cbuf
[i
] & ~0x80;
7029 /* See the comment below. */
7030 buf
.frame_or_window
= tty
->top_frame
;
7032 kbd_buffer_store_event (&buf
);
7038 for (i
= 0; i
< nread
; i
++)
7040 struct input_event buf
;
7042 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7044 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7045 buf
.modifiers
= meta_modifier
;
7046 if (tty
->meta_key
!= 2)
7050 /* Set the frame corresponding to the active tty. Note that the
7051 value of selected_frame is not reliable here, redisplay tends
7052 to temporarily change it. */
7053 buf
.frame_or_window
= tty
->top_frame
;
7056 kbd_buffer_store_event (&buf
);
7057 /* Don't look at input that follows a C-g too closely.
7058 This reduces lossage due to autorepeat on C-g. */
7059 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7060 && buf
.code
== quit_char
)
7068 handle_async_input (void)
7070 interrupt_input_pending
= 0;
7072 pending_signals
= pending_atimers
;
7074 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7075 doing anything dangerous. */
7082 nread
= read_avail_input (1);
7083 /* -1 means it's not ok to read the input now.
7084 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7085 0 means there was no keyboard input available. */
7095 process_pending_signals (void)
7097 if (interrupt_input_pending
)
7098 handle_async_input ();
7099 do_pending_atimers ();
7102 #ifdef SIGIO /* for entire page */
7103 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7106 input_available_signal (int signo
)
7108 /* Must preserve main program's value of errno. */
7109 int old_errno
= errno
;
7110 SIGNAL_THREAD_CHECK (signo
);
7113 interrupt_input_pending
= 1;
7114 pending_signals
= 1;
7117 if (input_available_clear_time
)
7118 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7121 handle_async_input ();
7128 /* Send ourselves a SIGIO.
7130 This function exists so that the UNBLOCK_INPUT macro in
7131 blockinput.h can have some way to take care of input we put off
7132 dealing with, without assuming that every file which uses
7133 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7135 reinvoke_input_signal (void)
7138 handle_async_input ();
7144 /* User signal events. */
7146 struct user_signal_info
7148 /* Signal number. */
7151 /* Name of the signal. */
7154 /* Number of pending signals. */
7157 struct user_signal_info
*next
;
7160 /* List of user signals. */
7161 static struct user_signal_info
*user_signals
= NULL
;
7164 add_user_signal (int sig
, const char *name
)
7166 struct user_signal_info
*p
;
7168 for (p
= user_signals
; p
; p
= p
->next
)
7170 /* Already added. */
7173 p
= xmalloc (sizeof (struct user_signal_info
));
7175 p
->name
= xstrdup (name
);
7177 p
->next
= user_signals
;
7180 signal (sig
, handle_user_signal
);
7184 handle_user_signal (int sig
)
7186 int old_errno
= errno
;
7187 struct user_signal_info
*p
;
7189 SIGNAL_THREAD_CHECK (sig
);
7191 for (p
= user_signals
; p
; p
= p
->next
)
7196 if (interrupt_input
)
7197 kill (getpid (), SIGIO
);
7201 /* Tell wait_reading_process_output that it needs to wake
7202 up and look around. */
7203 if (input_available_clear_time
)
7204 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7213 find_user_signal_name (int sig
)
7215 struct user_signal_info
*p
;
7217 for (p
= user_signals
; p
; p
= p
->next
)
7225 store_user_signal_events (void)
7227 struct user_signal_info
*p
;
7228 struct input_event buf
;
7231 for (p
= user_signals
; p
; p
= p
->next
)
7232 if (p
->npending
> 0)
7238 memset (&buf
, 0, sizeof buf
);
7239 buf
.kind
= USER_SIGNAL_EVENT
;
7240 buf
.frame_or_window
= selected_frame
;
7242 nstored
+= p
->npending
;
7244 mask
= sigblock (sigmask (p
->sig
));
7248 kbd_buffer_store_event (&buf
);
7251 while (p
->npending
> 0);
7259 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7260 static Lisp_Object menu_bar_one_keymap_changed_items
;
7262 /* These variables hold the vector under construction within
7263 menu_bar_items and its subroutines, and the current index
7264 for storing into that vector. */
7265 static Lisp_Object menu_bar_items_vector
;
7266 static int menu_bar_items_index
;
7269 static const char* separator_names
[] = {
7274 "single-dashed-line",
7275 "double-dashed-line",
7277 "shadow-etched-out",
7278 "shadow-etched-in-dash",
7279 "shadow-etched-out-dash",
7280 "shadow-double-etched-in",
7281 "shadow-double-etched-out",
7282 "shadow-double-etched-in-dash",
7283 "shadow-double-etched-out-dash",
7287 /* Return non-zero if LABEL specifies a separator. */
7290 menu_separator_name_p (const char *label
)
7294 else if (strlen (label
) > 3
7295 && strncmp (label
, "--", 2) == 0
7300 for (i
= 0; separator_names
[i
]; ++i
)
7301 if (strcmp (label
, separator_names
[i
]) == 0)
7306 /* It's a separator if it contains only dashes. */
7307 while (*label
== '-')
7309 return (*label
== 0);
7316 /* Return a vector of menu items for a menu bar, appropriate
7317 to the current buffer. Each item has three elements in the vector:
7320 OLD is an old vector we can optionally reuse, or nil. */
7323 menu_bar_items (Lisp_Object old
)
7325 /* The number of keymaps we're scanning right now, and the number of
7326 keymaps we have allocated space for. */
7329 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7330 in the current keymaps, or nil where it is not a prefix. */
7333 Lisp_Object def
, tail
;
7342 /* In order to build the menus, we need to call the keymap
7343 accessors. They all call QUIT. But this function is called
7344 during redisplay, during which a quit is fatal. So inhibit
7345 quitting while building the menus.
7346 We do this instead of specbind because (1) errors will clear it anyway
7347 and (2) this avoids risk of specpdl overflow. */
7348 oquit
= Vinhibit_quit
;
7352 menu_bar_items_vector
= old
;
7354 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7355 menu_bar_items_index
= 0;
7357 /* Build our list of keymaps.
7358 If we recognize a function key and replace its escape sequence in
7359 keybuf with its symbol, or if the sequence starts with a mouse
7360 click and we need to switch buffers, we jump back here to rebuild
7361 the initial keymaps from the current buffer. */
7365 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7366 if (!NILP (Voverriding_local_map_menu_flag
))
7368 /* Yes, use them (if non-nil) as well as the global map. */
7369 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7371 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7372 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7373 if (!NILP (Voverriding_local_map
))
7374 maps
[nmaps
++] = Voverriding_local_map
;
7378 /* No, so use major and minor mode keymaps and keymap property.
7379 Note that menu-bar bindings in the local-map and keymap
7380 properties may not work reliable, as they are only
7381 recognized when the menu-bar (or mode-line) is updated,
7382 which does not normally happen after every command. */
7385 nminor
= current_minor_maps (NULL
, &tmaps
);
7386 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7388 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7389 maps
[nmaps
++] = tem
;
7390 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7392 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7394 maps
[nmaps
++] = current_global_map
;
7397 /* Look up in each map the dummy prefix key `menu-bar'. */
7401 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7402 if (!NILP (maps
[mapno
]))
7404 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7408 menu_bar_one_keymap_changed_items
= Qnil
;
7409 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7413 /* Move to the end those items that should be at the end. */
7415 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7418 int end
= menu_bar_items_index
;
7420 for (i
= 0; i
< end
; i
+= 4)
7421 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7423 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7424 /* Move the item at index I to the end,
7425 shifting all the others forward. */
7426 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7427 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7428 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7429 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7431 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7432 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7433 (end
- i
- 4) * sizeof (Lisp_Object
));
7434 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7435 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7436 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7437 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7442 /* Add nil, nil, nil, nil at the end. */
7443 i
= menu_bar_items_index
;
7444 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7445 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7446 /* Add this item. */
7447 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7448 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7449 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7450 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7451 menu_bar_items_index
= i
;
7453 Vinhibit_quit
= oquit
;
7454 return menu_bar_items_vector
;
7457 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7458 If there's already an item for KEY, add this DEF to it. */
7460 Lisp_Object item_properties
;
7463 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7465 struct gcpro gcpro1
;
7469 if (EQ (item
, Qundefined
))
7471 /* If a map has an explicit `undefined' as definition,
7472 discard any previously made menu bar item. */
7474 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7475 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7477 if (menu_bar_items_index
> i
+ 4)
7478 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7479 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7480 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7481 menu_bar_items_index
-= 4;
7485 /* If this keymap has already contributed to this KEY,
7486 don't contribute to it a second time. */
7487 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7488 if (!NILP (tem
) || NILP (item
))
7491 menu_bar_one_keymap_changed_items
7492 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7494 /* We add to menu_bar_one_keymap_changed_items before doing the
7495 parse_menu_item, so that if it turns out it wasn't a menu item,
7496 it still correctly hides any further menu item. */
7498 i
= parse_menu_item (item
, 1);
7503 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7505 /* Find any existing item for this KEY. */
7506 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7507 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7510 /* If we did not find this KEY, add it at the end. */
7511 if (i
== menu_bar_items_index
)
7513 /* If vector is too small, get a bigger one. */
7514 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7515 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7516 /* Add this item. */
7517 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7518 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7519 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7520 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7521 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7522 menu_bar_items_index
= i
;
7524 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7528 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7529 /* If the new and the old items are not both keymaps,
7530 the lookup will only find `item'. */
7531 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7532 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7536 /* This is used as the handler when calling menu_item_eval_property. */
7538 menu_item_eval_property_1 (Lisp_Object arg
)
7540 /* If we got a quit from within the menu computation,
7541 quit all the way out of it. This takes care of C-] in the debugger. */
7542 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7543 Fsignal (Qquit
, Qnil
);
7548 /* Evaluate an expression and return the result (or nil if something
7549 went wrong). Used to evaluate dynamic parts of menu items. */
7551 menu_item_eval_property (Lisp_Object sexpr
)
7553 int count
= SPECPDL_INDEX ();
7555 specbind (Qinhibit_redisplay
, Qt
);
7556 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7557 menu_item_eval_property_1
);
7558 return unbind_to (count
, val
);
7561 /* This function parses a menu item and leaves the result in the
7562 vector item_properties.
7563 ITEM is a key binding, a possible menu item.
7564 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7566 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7567 parse_menu_item returns true if the item is a menu item and false
7571 parse_menu_item (Lisp_Object item
, int inmenubar
)
7573 Lisp_Object def
, tem
, item_string
, start
;
7575 Lisp_Object keyhint
;
7584 /* Create item_properties vector if necessary. */
7585 if (NILP (item_properties
))
7587 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7589 /* Initialize optional entries. */
7590 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7591 ASET (item_properties
, i
, Qnil
);
7592 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7594 /* Save the item here to protect it from GC. */
7595 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7597 item_string
= XCAR (item
);
7601 if (STRINGP (item_string
))
7603 /* Old format menu item. */
7604 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7606 /* Maybe help string. */
7607 if (CONSP (item
) && STRINGP (XCAR (item
)))
7609 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7614 /* Maybe an obsolete key binding cache. */
7615 if (CONSP (item
) && CONSP (XCAR (item
))
7616 && (NILP (XCAR (XCAR (item
)))
7617 || VECTORP (XCAR (XCAR (item
)))))
7620 /* This is the real definition--the function to run. */
7621 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7623 /* Get enable property, if any. */
7626 tem
= Fget (item
, Qmenu_enable
);
7627 if (!NILP (Venable_disabled_menus_and_buttons
))
7628 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7629 else if (!NILP (tem
))
7630 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7633 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7635 /* New format menu item. */
7636 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7637 start
= XCDR (item
);
7640 /* We have a real binding. */
7641 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7643 item
= XCDR (start
);
7644 /* Is there an obsolete cache list with key equivalences. */
7645 if (CONSP (item
) && CONSP (XCAR (item
)))
7648 /* Parse properties. */
7649 while (CONSP (item
) && CONSP (XCDR (item
)))
7654 if (EQ (tem
, QCenable
))
7656 if (!NILP (Venable_disabled_menus_and_buttons
))
7657 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7659 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7661 else if (EQ (tem
, QCvisible
))
7663 /* If got a visible property and that evaluates to nil
7664 then ignore this item. */
7665 tem
= menu_item_eval_property (XCAR (item
));
7669 else if (EQ (tem
, QChelp
))
7670 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7671 else if (EQ (tem
, QCfilter
))
7673 else if (EQ (tem
, QCkey_sequence
))
7676 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7677 /* Be GC protected. Set keyhint to item instead of tem. */
7680 else if (EQ (tem
, QCkeys
))
7683 if (CONSP (tem
) || STRINGP (tem
))
7684 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7686 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7691 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7693 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7695 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7701 else if (inmenubar
|| !NILP (start
))
7705 return 0; /* not a menu item */
7707 /* If item string is not a string, evaluate it to get string.
7708 If we don't get a string, skip this item. */
7709 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7710 if (!(STRINGP (item_string
)))
7712 item_string
= menu_item_eval_property (item_string
);
7713 if (!STRINGP (item_string
))
7715 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7718 /* If got a filter apply it on definition. */
7719 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7722 def
= menu_item_eval_property (list2 (XCAR (filter
),
7723 list2 (Qquote
, def
)));
7725 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7728 /* Enable or disable selection of item. */
7729 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7732 tem
= menu_item_eval_property (tem
);
7733 if (inmenubar
&& NILP (tem
))
7734 return 0; /* Ignore disabled items in menu bar. */
7735 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7738 /* If we got no definition, this item is just unselectable text which
7739 is OK in a submenu but not in the menubar. */
7741 return (inmenubar
? 0 : 1);
7743 /* See if this is a separate pane or a submenu. */
7744 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7745 tem
= get_keymap (def
, 0, 1);
7746 /* For a subkeymap, just record its details and exit. */
7749 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7750 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7754 /* At the top level in the menu bar, do likewise for commands also.
7755 The menu bar does not display equivalent key bindings anyway.
7756 ITEM_PROPERTY_DEF is already set up properly. */
7760 { /* This is a command. See if there is an equivalent key binding. */
7761 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7763 /* The previous code preferred :key-sequence to :keys, so we
7764 preserve this behavior. */
7765 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7766 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7769 Lisp_Object prefix
= keyeq
;
7770 Lisp_Object keys
= Qnil
;
7774 def
= XCAR (prefix
);
7775 prefix
= XCDR (prefix
);
7778 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7780 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7782 keys
= XCAR (keyhint
);
7783 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7785 /* We have a suggested key. Is it bound to the command? */
7788 /* If the command is an alias for another
7789 (such as lmenu.el set it up), check if the
7790 original command matches the cached command. */
7791 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7796 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7800 tem
= Fkey_description (keys
, Qnil
);
7803 if (STRINGP (XCAR (prefix
)))
7804 tem
= concat2 (XCAR (prefix
), tem
);
7805 if (STRINGP (XCDR (prefix
)))
7806 tem
= concat2 (tem
, XCDR (prefix
));
7808 keyeq
= concat2 (build_string (" "), tem
);
7809 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7815 /* If we have an equivalent key binding, use that. */
7816 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7819 /* Include this when menu help is implemented.
7820 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7821 if (!(NILP (tem) || STRINGP (tem)))
7823 tem = menu_item_eval_property (tem);
7826 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7830 /* Handle radio buttons or toggle boxes. */
7831 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7833 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7834 menu_item_eval_property (tem
));
7841 /***********************************************************************
7843 ***********************************************************************/
7845 /* A vector holding tool bar items while they are parsed in function
7846 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7849 static Lisp_Object tool_bar_items_vector
;
7851 /* A vector holding the result of parse_tool_bar_item. Layout is like
7852 the one for a single item in tool_bar_items_vector. */
7854 static Lisp_Object tool_bar_item_properties
;
7856 /* Next free index in tool_bar_items_vector. */
7858 static int ntool_bar_items
;
7860 /* The symbols `:image' and `:rtl'. */
7862 Lisp_Object QCimage
;
7865 /* Function prototypes. */
7867 static void init_tool_bar_items (Lisp_Object
);
7868 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7869 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7870 static void append_tool_bar_item (void);
7873 /* Return a vector of tool bar items for keymaps currently in effect.
7874 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7875 tool bar items found. */
7878 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7887 /* In order to build the menus, we need to call the keymap
7888 accessors. They all call QUIT. But this function is called
7889 during redisplay, during which a quit is fatal. So inhibit
7890 quitting while building the menus. We do this instead of
7891 specbind because (1) errors will clear it anyway and (2) this
7892 avoids risk of specpdl overflow. */
7893 oquit
= Vinhibit_quit
;
7896 /* Initialize tool_bar_items_vector and protect it from GC. */
7897 init_tool_bar_items (reuse
);
7899 /* Build list of keymaps in maps. Set nmaps to the number of maps
7902 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7903 if (!NILP (Voverriding_local_map_menu_flag
))
7905 /* Yes, use them (if non-nil) as well as the global map. */
7906 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7908 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7909 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7910 if (!NILP (Voverriding_local_map
))
7911 maps
[nmaps
++] = Voverriding_local_map
;
7915 /* No, so use major and minor mode keymaps and keymap property.
7916 Note that tool-bar bindings in the local-map and keymap
7917 properties may not work reliable, as they are only
7918 recognized when the tool-bar (or mode-line) is updated,
7919 which does not normally happen after every command. */
7922 nminor
= current_minor_maps (NULL
, &tmaps
);
7923 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7925 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7926 maps
[nmaps
++] = tem
;
7927 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7929 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7932 /* Add global keymap at the end. */
7933 maps
[nmaps
++] = current_global_map
;
7935 /* Process maps in reverse order and look up in each map the prefix
7937 for (i
= nmaps
- 1; i
>= 0; --i
)
7938 if (!NILP (maps
[i
]))
7942 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7944 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7947 Vinhibit_quit
= oquit
;
7948 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7949 return tool_bar_items_vector
;
7953 /* Process the definition of KEY which is DEF. */
7956 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7959 struct gcpro gcpro1
, gcpro2
;
7961 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7965 if (EQ (def
, Qundefined
))
7967 /* If a map has an explicit `undefined' as definition,
7968 discard any previously made item. */
7969 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7971 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7973 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7975 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7976 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7977 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7978 * sizeof (Lisp_Object
)));
7979 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7984 else if (parse_tool_bar_item (key
, def
))
7985 /* Append a new tool bar item to tool_bar_items_vector. Accept
7986 more than one definition for the same key. */
7987 append_tool_bar_item ();
7993 /* Parse a tool bar item specification ITEM for key KEY and return the
7994 result in tool_bar_item_properties. Value is zero if ITEM is
7997 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7999 CAPTION is the caption of the item, If it's not a string, it is
8000 evaluated to get a string.
8002 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8003 as binding are currently ignored.
8005 The following properties are recognized:
8009 FORM is evaluated and specifies whether the tool bar item is
8010 enabled or disabled.
8014 FORM is evaluated and specifies whether the tool bar item is visible.
8016 - `:filter FUNCTION'
8018 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8019 result is stored as the new binding.
8021 - `:button (TYPE SELECTED)'
8023 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8024 and specifies whether the button is selected (pressed) or not.
8028 IMAGES is either a single image specification or a vector of four
8029 image specifications. See enum tool_bar_item_images.
8031 - `:help HELP-STRING'.
8033 Gives a help string to display for the tool bar item.
8035 - `:label LABEL-STRING'.
8037 A text label to show with the tool bar button if labels are enabled. */
8040 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8042 /* Access slot with index IDX of vector tool_bar_item_properties. */
8043 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8045 Lisp_Object filter
= Qnil
;
8046 Lisp_Object caption
;
8047 int i
, have_label
= 0;
8049 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8050 Rule out items that aren't lists, don't start with
8051 `menu-item' or whose rest following `tool-bar-item' is not a
8056 /* As an exception, allow old-style menu separators. */
8057 if (STRINGP (XCAR (item
)))
8058 item
= Fcons (XCAR (item
), Qnil
);
8059 else if (!EQ (XCAR (item
), Qmenu_item
)
8060 || (item
= XCDR (item
), !CONSP (item
)))
8063 /* Create tool_bar_item_properties vector if necessary. Reset it to
8065 if (VECTORP (tool_bar_item_properties
))
8067 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8071 tool_bar_item_properties
8072 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8075 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8076 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8078 /* Get the caption of the item. If the caption is not a string,
8079 evaluate it to get a string. If we don't get a string, skip this
8081 caption
= XCAR (item
);
8082 if (!STRINGP (caption
))
8084 caption
= menu_item_eval_property (caption
);
8085 if (!STRINGP (caption
))
8088 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8090 /* If the rest following the caption is not a list, the menu item is
8091 either a separator, or invalid. */
8095 if (menu_separator_name_p (SSDATA (caption
)))
8097 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8098 #if !defined (USE_GTK) && !defined (HAVE_NS)
8099 /* If we use build_desired_tool_bar_string to render the
8100 tool bar, the separator is rendered as an image. */
8101 PROP (TOOL_BAR_ITEM_IMAGES
)
8102 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8103 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8104 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8105 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8112 /* Store the binding. */
8113 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8116 /* Ignore cached key binding, if any. */
8117 if (CONSP (item
) && CONSP (XCAR (item
)))
8120 /* Process the rest of the properties. */
8121 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8123 Lisp_Object key
, value
;
8126 value
= XCAR (XCDR (item
));
8128 if (EQ (key
, QCenable
))
8130 /* `:enable FORM'. */
8131 if (!NILP (Venable_disabled_menus_and_buttons
))
8132 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8134 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8136 else if (EQ (key
, QCvisible
))
8138 /* `:visible FORM'. If got a visible property and that
8139 evaluates to nil then ignore this item. */
8140 if (NILP (menu_item_eval_property (value
)))
8143 else if (EQ (key
, QChelp
))
8144 /* `:help HELP-STRING'. */
8145 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8146 else if (EQ (key
, QCvert_only
))
8147 /* `:vert-only t/nil'. */
8148 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8149 else if (EQ (key
, QClabel
))
8151 const char *bad_label
= "!!?GARBLED ITEM?!!";
8152 /* `:label LABEL-STRING'. */
8153 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8155 : make_string (bad_label
, strlen (bad_label
));
8158 else if (EQ (key
, QCfilter
))
8159 /* ':filter FORM'. */
8161 else if (EQ (key
, QCbutton
) && CONSP (value
))
8163 /* `:button (TYPE . SELECTED)'. */
8164 Lisp_Object type
, selected
;
8166 type
= XCAR (value
);
8167 selected
= XCDR (value
);
8168 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8170 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8171 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8174 else if (EQ (key
, QCimage
)
8176 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8177 /* Value is either a single image specification or a vector
8178 of 4 such specifications for the different button states. */
8179 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8180 else if (EQ (key
, Qrtl
))
8182 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8188 /* Try to make one from caption and key. */
8189 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8190 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8191 const char *label
= SYMBOLP (key
) ? SSDATA (SYMBOL_NAME (key
)) : "";
8192 const char *caption
= STRINGP (capt
) ? SSDATA (capt
) : "";
8193 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8194 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8195 Lisp_Object new_lbl
;
8196 size_t caption_len
= strlen (caption
);
8198 if (caption_len
<= max_lbl
&& caption
[0] != '\0')
8200 strcpy (buf
, caption
);
8201 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8203 buf
[caption_len
] = '\0';
8204 label
= caption
= buf
;
8207 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8211 strcpy (buf
, label
);
8213 for (i
= 0; buf
[i
] != '\0'; ++i
)
8222 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8223 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8224 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8226 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8230 /* If got a filter apply it on binding. */
8232 PROP (TOOL_BAR_ITEM_BINDING
)
8233 = menu_item_eval_property (list2 (filter
,
8235 PROP (TOOL_BAR_ITEM_BINDING
))));
8237 /* See if the binding is a keymap. Give up if it is. */
8238 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8241 /* Enable or disable selection of item. */
8242 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8243 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8244 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8246 /* Handle radio buttons or toggle boxes. */
8247 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8248 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8249 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8257 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8258 that can be reused. */
8261 init_tool_bar_items (Lisp_Object reuse
)
8263 if (VECTORP (reuse
))
8264 tool_bar_items_vector
= reuse
;
8266 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8267 ntool_bar_items
= 0;
8271 /* Append parsed tool bar item properties from
8272 tool_bar_item_properties */
8275 append_tool_bar_item (void)
8277 Lisp_Object
*to
, *from
;
8279 /* Enlarge tool_bar_items_vector if necessary. */
8280 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8281 >= XVECTOR (tool_bar_items_vector
)->size
)
8282 tool_bar_items_vector
8283 = larger_vector (tool_bar_items_vector
,
8284 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8286 /* Append entries from tool_bar_item_properties to the end of
8287 tool_bar_items_vector. */
8288 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8289 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8290 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8291 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8298 /* Read a character using menus based on maps in the array MAPS.
8299 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8300 Return t if we displayed a menu but the user rejected it.
8302 PREV_EVENT is the previous input event, or nil if we are reading
8303 the first event of a key sequence.
8305 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8306 if we used a mouse menu to read the input, or zero otherwise. If
8307 USED_MOUSE_MENU is null, we don't dereference it.
8309 The prompting is done based on the prompt-string of the map
8310 and the strings associated with various map elements.
8312 This can be done with X menus or with menus put in the minibuf.
8313 These are done in different ways, depending on how the input will be read.
8314 Menus using X are done after auto-saving in read-char, getting the input
8315 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8316 and do auto-saving in the inner call of read_char. */
8319 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8320 int *used_mouse_menu
)
8324 if (used_mouse_menu
)
8325 *used_mouse_menu
= 0;
8327 /* Use local over global Menu maps */
8329 if (! menu_prompting
)
8332 /* Optionally disregard all but the global map. */
8333 if (inhibit_local_menu_bar_menus
)
8335 maps
+= (nmaps
- 1);
8340 /* If we got to this point via a mouse click,
8341 use a real menu for mouse selection. */
8342 if (EVENT_HAS_PARAMETERS (prev_event
)
8343 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8344 && !EQ (XCAR (prev_event
), Qtool_bar
))
8346 /* Display the menu and get the selection. */
8347 Lisp_Object
*realmaps
8348 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8352 /* Use the maps that are not nil. */
8353 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8354 if (!NILP (maps
[mapno
]))
8355 realmaps
[nmaps1
++] = maps
[mapno
];
8357 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8362 record_menu_key (XCAR (value
));
8364 /* If we got multiple events, unread all but
8366 There is no way to prevent those unread events
8367 from showing up later in last_nonmenu_event.
8368 So turn symbol and integer events into lists,
8369 to indicate that they came from a mouse menu,
8370 so that when present in last_nonmenu_event
8371 they won't confuse things. */
8372 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8374 record_menu_key (XCAR (tem
));
8375 if (SYMBOLP (XCAR (tem
))
8376 || INTEGERP (XCAR (tem
)))
8377 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8380 /* If we got more than one event, put all but the first
8381 onto this list to be read later.
8382 Return just the first event now. */
8383 Vunread_command_events
8384 = nconc2 (XCDR (value
), Vunread_command_events
);
8385 value
= XCAR (value
);
8387 else if (NILP (value
))
8389 if (used_mouse_menu
)
8390 *used_mouse_menu
= 1;
8393 #endif /* HAVE_MENUS */
8397 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8398 We make this bigger when necessary, and never free it. */
8399 static char *read_char_minibuf_menu_text
;
8400 /* Size of that buffer. */
8401 static int read_char_minibuf_menu_width
;
8404 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8407 register Lisp_Object name
;
8409 /* FIXME: Use the minibuffer's frame width. */
8410 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8413 Lisp_Object rest
, vector
;
8419 if (! menu_prompting
)
8422 /* Get the menu name from the first map that has one (a prompt string). */
8423 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8425 name
= Fkeymap_prompt (maps
[mapno
]);
8430 /* If we don't have any menus, just read a character normally. */
8431 if (!STRINGP (name
))
8434 /* Make sure we have a big enough buffer for the menu text. */
8435 width
= max (width
, SBYTES (name
));
8436 if (read_char_minibuf_menu_text
== 0)
8438 read_char_minibuf_menu_width
= width
+ 4;
8439 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8441 else if (width
+ 4 > read_char_minibuf_menu_width
)
8443 read_char_minibuf_menu_width
= width
+ 4;
8444 read_char_minibuf_menu_text
8445 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8447 menu
= read_char_minibuf_menu_text
;
8449 /* Prompt string always starts with map's prompt, and a space. */
8450 strcpy (menu
, SSDATA (name
));
8451 nlength
= SBYTES (name
);
8452 menu
[nlength
++] = ':';
8453 menu
[nlength
++] = ' ';
8456 /* Start prompting at start of first map. */
8460 /* Present the documented bindings, a line at a time. */
8467 Lisp_Object orig_defn_macro
;
8469 /* Loop over elements of map. */
8474 /* If reached end of map, start at beginning of next map. */
8478 /* At end of last map, wrap around to first map if just starting,
8479 or end this line if already have something on it. */
8483 if (notfirst
|| nobindings
) break;
8488 /* Look at the next element of the map. */
8490 elt
= XVECTOR (vector
)->contents
[idx
];
8492 elt
= Fcar_safe (rest
);
8494 if (idx
< 0 && VECTORP (elt
))
8496 /* If we found a dense table in the keymap,
8497 advanced past it, but start scanning its contents. */
8498 rest
= Fcdr_safe (rest
);
8504 /* An ordinary element. */
8505 Lisp_Object event
, tem
;
8509 event
= Fcar_safe (elt
); /* alist */
8510 elt
= Fcdr_safe (elt
);
8514 XSETINT (event
, idx
); /* vector */
8517 /* Ignore the element if it has no prompt string. */
8518 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8520 /* 1 if the char to type matches the string. */
8522 Lisp_Object upcased_event
, downcased_event
;
8523 Lisp_Object desc
= Qnil
;
8525 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8527 upcased_event
= Fupcase (event
);
8528 downcased_event
= Fdowncase (event
);
8529 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8530 || XINT (downcased_event
) == SREF (s
, 0));
8532 desc
= Fsingle_key_description (event
, Qnil
);
8534 #if 0 /* It is redundant to list the equivalent key bindings because
8535 the prefix is what the user has already typed. */
8537 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8539 /* Insert equivalent keybinding. */
8540 s
= concat2 (s
, tem
);
8543 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8544 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8546 /* Insert button prefix. */
8547 Lisp_Object selected
8548 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8549 if (EQ (tem
, QCradio
))
8550 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8552 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8553 s
= concat2 (tem
, s
);
8557 /* If we have room for the prompt string, add it to this line.
8558 If this is the first on the line, always add it. */
8559 if ((SCHARS (s
) + i
+ 2
8560 + (char_matches
? 0 : SCHARS (desc
) + 3))
8566 /* Punctuate between strings. */
8569 strcpy (menu
+ i
, ", ");
8575 /* If the char to type doesn't match the string's
8576 first char, explicitly show what char to type. */
8579 /* Add as much of string as fits. */
8580 thiswidth
= SCHARS (desc
);
8581 if (thiswidth
+ i
> width
)
8582 thiswidth
= width
- i
;
8583 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8585 strcpy (menu
+ i
, " = ");
8589 /* Add as much of string as fits. */
8590 thiswidth
= SCHARS (s
);
8591 if (thiswidth
+ i
> width
)
8592 thiswidth
= width
- i
;
8593 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8599 /* If this element does not fit, end the line now,
8600 and save the element for the next line. */
8601 strcpy (menu
+ i
, "...");
8606 /* Move past this element. */
8607 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8608 /* Handle reaching end of dense table. */
8613 rest
= Fcdr_safe (rest
);
8617 /* Prompt with that and read response. */
8618 message2_nolog (menu
, strlen (menu
),
8619 ! NILP (current_buffer
->enable_multibyte_characters
));
8621 /* Make believe its not a keyboard macro in case the help char
8622 is pressed. Help characters are not recorded because menu prompting
8623 is not used on replay.
8625 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8626 current_kboard
->defining_kbd_macro
= Qnil
;
8628 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8629 while (BUFFERP (obj
));
8630 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8632 if (!INTEGERP (obj
))
8634 else if (XINT (obj
) == -2)
8639 if (! EQ (obj
, menu_prompt_more_char
)
8640 && (!INTEGERP (menu_prompt_more_char
)
8641 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8643 if (!NILP (current_kboard
->defining_kbd_macro
))
8644 store_kbd_macro_char (obj
);
8647 /* Help char - go round again */
8651 /* Reading key sequences. */
8653 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8654 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8655 keymap, or nil otherwise. Return the index of the first keymap in
8656 which KEY has any binding, or NMAPS if no map has a binding.
8658 If KEY is a meta ASCII character, treat it like meta-prefix-char
8659 followed by the corresponding non-meta character. Keymaps in
8660 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8663 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8666 NEXT may be the same array as CURRENT. */
8669 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8672 int i
, first_binding
;
8674 first_binding
= nmaps
;
8675 for (i
= nmaps
- 1; i
>= 0; i
--)
8677 if (! NILP (current
[i
]))
8679 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8680 if (! NILP (defs
[i
]))
8687 /* Given the set of bindings we've found, produce the next set of maps. */
8688 if (first_binding
< nmaps
)
8689 for (i
= 0; i
< nmaps
; i
++)
8690 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8692 return first_binding
;
8695 /* Structure used to keep track of partial application of key remapping
8696 such as Vfunction_key_map and Vkey_translation_map. */
8697 typedef struct keyremap
8699 /* This is the map originally specified for this use. */
8701 /* This is a submap reached by looking up, in PARENT,
8702 the events from START to END. */
8704 /* Positions [START, END) in the key sequence buffer
8705 are the key that we have scanned so far.
8706 Those events are the ones that we will replace
8707 if PAREHT maps them into a key sequence. */
8711 /* Lookup KEY in MAP.
8712 MAP is a keymap mapping keys to key vectors or functions.
8713 If the mapping is a function and DO_FUNCTION is non-zero, then
8714 the function is called with PROMPT as parameter and its return
8715 value is used as the return value of this function (after checking
8716 that it is indeed a vector). */
8719 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8724 next
= access_keymap (map
, key
, 1, 0, 1);
8726 /* Handle symbol with autoload definition. */
8727 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8728 && CONSP (XSYMBOL (next
)->function
)
8729 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8730 do_autoload (XSYMBOL (next
)->function
, next
);
8732 /* Handle a symbol whose function definition is a keymap
8734 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8735 && (ARRAYP (XSYMBOL (next
)->function
)
8736 || KEYMAPP (XSYMBOL (next
)->function
)))
8737 next
= XSYMBOL (next
)->function
;
8739 /* If the keymap gives a function, not an
8740 array, then call the function with one arg and use
8741 its value instead. */
8742 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8747 next
= call1 (next
, prompt
);
8748 /* If the function returned something invalid,
8749 barf--don't ignore it.
8750 (To ignore it safely, we would need to gcpro a bunch of
8751 other variables.) */
8752 if (! (VECTORP (next
) || STRINGP (next
)))
8753 error ("Function %s returns invalid key sequence", tem
);
8758 /* Do one step of the key remapping used for function-key-map and
8759 key-translation-map:
8760 KEYBUF is the buffer holding the input events.
8761 BUFSIZE is its maximum size.
8762 FKEY is a pointer to the keyremap structure to use.
8763 INPUT is the index of the last element in KEYBUF.
8764 DOIT if non-zero says that the remapping can actually take place.
8765 DIFF is used to return the number of keys added/removed by the remapping.
8766 PARENT is the root of the keymap.
8767 PROMPT is the prompt to use if the remapping happens through a function.
8768 The return value is non-zero if the remapping actually took place. */
8771 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8772 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8774 Lisp_Object next
, key
;
8776 key
= keybuf
[fkey
->end
++];
8778 if (KEYMAPP (fkey
->parent
))
8779 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8783 /* If keybuf[fkey->start..fkey->end] is bound in the
8784 map and we're in a position to do the key remapping, replace it with
8785 the binding and restart with fkey->start at the end. */
8786 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8788 int len
= XFASTINT (Flength (next
));
8791 *diff
= len
- (fkey
->end
- fkey
->start
);
8793 if (input
+ *diff
>= bufsize
)
8794 error ("Key sequence too long");
8796 /* Shift the keys that follow fkey->end. */
8798 for (i
= fkey
->end
; i
< input
; i
++)
8799 keybuf
[i
+ *diff
] = keybuf
[i
];
8801 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8802 keybuf
[i
+ *diff
] = keybuf
[i
];
8803 /* Overwrite the old keys with the new ones. */
8804 for (i
= 0; i
< len
; i
++)
8805 keybuf
[fkey
->start
+ i
]
8806 = Faref (next
, make_number (i
));
8808 fkey
->start
= fkey
->end
+= *diff
;
8809 fkey
->map
= fkey
->parent
;
8814 fkey
->map
= get_keymap (next
, 0, 1);
8816 /* If we no longer have a bound suffix, try a new position for
8818 if (!CONSP (fkey
->map
))
8820 fkey
->end
= ++fkey
->start
;
8821 fkey
->map
= fkey
->parent
;
8826 /* Read a sequence of keys that ends with a non prefix character,
8827 storing it in KEYBUF, a buffer of size BUFSIZE.
8829 Return the length of the key sequence stored.
8830 Return -1 if the user rejected a command menu.
8832 Echo starting immediately unless `prompt' is 0.
8834 Where a key sequence ends depends on the currently active keymaps.
8835 These include any minor mode keymaps active in the current buffer,
8836 the current buffer's local map, and the global map.
8838 If a key sequence has no other bindings, we check Vfunction_key_map
8839 to see if some trailing subsequence might be the beginning of a
8840 function key's sequence. If so, we try to read the whole function
8841 key, and substitute its symbolic name into the key sequence.
8843 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8844 `double-' events into similar click events, if that would make them
8845 bound. We try to turn `triple-' events first into `double-' events,
8848 If we get a mouse click in a mode line, vertical divider, or other
8849 non-text area, we treat the click as if it were prefixed by the
8850 symbol denoting that area - `mode-line', `vertical-line', or
8853 If the sequence starts with a mouse click, we read the key sequence
8854 with respect to the buffer clicked on, not the current buffer.
8856 If the user switches frames in the midst of a key sequence, we put
8857 off the switch-frame event until later; the next call to
8858 read_char will return it.
8860 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8861 from the selected window's buffer. */
8864 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8865 int dont_downcase_last
, int can_return_switch_frame
,
8866 int fix_current_buffer
)
8868 Lisp_Object from_string
;
8869 int count
= SPECPDL_INDEX ();
8871 /* How many keys there are in the current key sequence. */
8874 /* The length of the echo buffer when we started reading, and
8875 the length of this_command_keys when we started reading. */
8879 /* The number of keymaps we're scanning right now, and the number of
8880 keymaps we have allocated space for. */
8882 int nmaps_allocated
= 0;
8884 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8885 the current keymaps. */
8886 Lisp_Object
*defs
= NULL
;
8888 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8889 in the current keymaps, or nil where it is not a prefix. */
8890 Lisp_Object
*submaps
= NULL
;
8892 /* The local map to start out with at start of key sequence. */
8893 Lisp_Object orig_local_map
;
8895 /* The map from the `keymap' property to start out with at start of
8897 Lisp_Object orig_keymap
;
8899 /* 1 if we have already considered switching to the local-map property
8900 of the place where a mouse click occurred. */
8901 int localized_local_map
= 0;
8903 /* The index in submaps[] of the first keymap that has a binding for
8904 this key sequence. In other words, the lowest i such that
8905 submaps[i] is non-nil. */
8907 /* Index of the first key that has no binding.
8908 It is useless to try fkey.start larger than that. */
8911 /* If t < mock_input, then KEYBUF[t] should be read as the next
8914 We use this to recover after recognizing a function key. Once we
8915 realize that a suffix of the current key sequence is actually a
8916 function key's escape sequence, we replace the suffix with the
8917 function key's binding from Vfunction_key_map. Now keybuf
8918 contains a new and different key sequence, so the echo area,
8919 this_command_keys, and the submaps and defs arrays are wrong. In
8920 this situation, we set mock_input to t, set t to 0, and jump to
8921 restart_sequence; the loop will read keys from keybuf up until
8922 mock_input, thus rebuilding the state; and then it will resume
8923 reading characters from the keyboard. */
8926 /* If the sequence is unbound in submaps[], then
8927 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8928 and fkey.map is its binding.
8930 These might be > t, indicating that all function key scanning
8931 should hold off until t reaches them. We do this when we've just
8932 recognized a function key, to avoid searching for the function
8933 key's again in Vfunction_key_map. */
8936 /* Likewise, for key_translation_map and input-decode-map. */
8937 keyremap keytran
, indec
;
8939 /* Non-zero if we are trying to map a key by changing an upper-case
8940 letter to lower case, or a shifted function key to an unshifted
8942 int shift_translated
= 0;
8944 /* If we receive a `switch-frame' or `select-window' event in the middle of
8945 a key sequence, we put it off for later.
8946 While we're reading, we keep the event here. */
8947 Lisp_Object delayed_switch_frame
;
8949 /* See the comment below... */
8950 #if defined (GOBBLE_FIRST_EVENT)
8951 Lisp_Object first_event
;
8954 Lisp_Object original_uppercase
;
8955 int original_uppercase_position
= -1;
8957 /* Gets around Microsoft compiler limitations. */
8960 struct buffer
*starting_buffer
;
8962 /* List of events for which a fake prefix key has been generated. */
8963 Lisp_Object fake_prefixed_keys
= Qnil
;
8965 #if defined (GOBBLE_FIRST_EVENT)
8969 struct gcpro gcpro1
;
8971 GCPRO1 (fake_prefixed_keys
);
8972 raw_keybuf_count
= 0;
8974 last_nonmenu_event
= Qnil
;
8976 delayed_switch_frame
= Qnil
;
8982 /* Install the string STR as the beginning of the string of
8983 echoing, so that it serves as a prompt for the next
8985 current_kboard
->echo_string
= prompt
;
8986 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8989 else if (cursor_in_echo_area
8990 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8991 && NILP (Fzerop (Vecho_keystrokes
)))
8992 /* This doesn't put in a dash if the echo buffer is empty, so
8993 you don't always see a dash hanging out in the minibuffer. */
8997 /* Record the initial state of the echo area and this_command_keys;
8998 we will need to restore them if we replay a key sequence. */
9000 echo_start
= echo_length ();
9001 keys_start
= this_command_key_count
;
9002 this_single_command_key_start
= keys_start
;
9004 #if defined (GOBBLE_FIRST_EVENT)
9005 /* This doesn't quite work, because some of the things that read_char
9006 does cannot safely be bypassed. It seems too risky to try to make
9009 /* Read the first char of the sequence specially, before setting
9010 up any keymaps, in case a filter runs and switches buffers on us. */
9011 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9013 #endif /* GOBBLE_FIRST_EVENT */
9015 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9016 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9019 /* We jump here when we need to reinitialize fkey and keytran; this
9020 happens if we switch keyboards between rescans. */
9021 replay_entire_sequence
:
9023 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9024 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9025 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9026 indec
.start
= indec
.end
= 0;
9027 fkey
.start
= fkey
.end
= 0;
9028 keytran
.start
= keytran
.end
= 0;
9030 /* We jump here when the key sequence has been thoroughly changed, and
9031 we need to rescan it starting from the beginning. When we jump here,
9032 keybuf[0..mock_input] holds the sequence we should reread. */
9035 starting_buffer
= current_buffer
;
9036 first_unbound
= bufsize
+ 1;
9038 /* Build our list of keymaps.
9039 If we recognize a function key and replace its escape sequence in
9040 keybuf with its symbol, or if the sequence starts with a mouse
9041 click and we need to switch buffers, we jump back here to rebuild
9042 the initial keymaps from the current buffer. */
9045 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9047 if (2 > nmaps_allocated
)
9049 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9050 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9051 nmaps_allocated
= 2;
9053 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9055 else if (!NILP (Voverriding_local_map
))
9057 if (2 > nmaps_allocated
)
9059 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9060 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9061 nmaps_allocated
= 2;
9063 submaps
[nmaps
++] = Voverriding_local_map
;
9071 nminor
= current_minor_maps (0, &maps
);
9072 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9074 if (total
> nmaps_allocated
)
9076 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9077 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9078 nmaps_allocated
= total
;
9081 if (!NILP (orig_keymap
))
9082 submaps
[nmaps
++] = orig_keymap
;
9084 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9088 submaps
[nmaps
++] = orig_local_map
;
9090 submaps
[nmaps
++] = current_global_map
;
9092 /* Find an accurate initial value for first_binding. */
9093 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9094 if (! NILP (submaps
[first_binding
]))
9097 /* Start from the beginning in keybuf. */
9100 /* These are no-ops the first time through, but if we restart, they
9101 revert the echo area and this_command_keys to their original state. */
9102 this_command_key_count
= keys_start
;
9103 if (INTERACTIVE
&& t
< mock_input
)
9104 echo_truncate (echo_start
);
9106 /* If the best binding for the current key sequence is a keymap, or
9107 we may be looking at a function key's escape sequence, keep on
9109 while (first_binding
< nmaps
9110 /* Keep reading as long as there's a prefix binding. */
9111 ? !NILP (submaps
[first_binding
])
9112 /* Don't return in the middle of a possible function key sequence,
9113 if the only bindings we found were via case conversion.
9114 Thus, if ESC O a has a function-key-map translation
9115 and ESC o has a binding, don't return after ESC O,
9116 so that we can translate ESC O plus the next character. */
9117 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9120 int used_mouse_menu
= 0;
9122 /* Where the last real key started. If we need to throw away a
9123 key that has expanded into more than one element of keybuf
9124 (say, a mouse click on the mode line which is being treated
9125 as [mode-line (mouse-...)], then we backtrack to this point
9127 int last_real_key_start
;
9129 /* These variables are analogous to echo_start and keys_start;
9130 while those allow us to restart the entire key sequence,
9131 echo_local_start and keys_local_start allow us to throw away
9133 int echo_local_start
, keys_local_start
, local_first_binding
;
9135 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9136 eassert (indec
.start
<= indec
.end
);
9137 eassert (fkey
.start
<= fkey
.end
);
9138 eassert (keytran
.start
<= keytran
.end
);
9139 /* key-translation-map is applied *after* function-key-map
9140 which is itself applied *after* input-decode-map. */
9141 eassert (fkey
.end
<= indec
.start
);
9142 eassert (keytran
.end
<= fkey
.start
);
9144 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9145 first_unbound
< keytran
.start
)
9146 { /* The prefix upto first_unbound has no binding and has
9147 no translation left to do either, so we know it's unbound.
9148 If we don't stop now, we risk staying here indefinitely
9149 (if the user keeps entering fkey or keytran prefixes
9150 like C-c ESC ESC ESC ESC ...) */
9152 for (i
= first_unbound
+ 1; i
< t
; i
++)
9153 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9154 mock_input
= t
- first_unbound
- 1;
9155 indec
.end
= indec
.start
-= first_unbound
+ 1;
9156 indec
.map
= indec
.parent
;
9157 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9158 fkey
.map
= fkey
.parent
;
9159 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9160 keytran
.map
= keytran
.parent
;
9161 goto replay_sequence
;
9165 error ("Key sequence too long");
9168 echo_local_start
= echo_length ();
9169 keys_local_start
= this_command_key_count
;
9170 local_first_binding
= first_binding
;
9173 /* These are no-ops, unless we throw away a keystroke below and
9174 jumped back up to replay_key; in that case, these restore the
9175 variables to their original state, allowing us to replay the
9177 if (INTERACTIVE
&& t
< mock_input
)
9178 echo_truncate (echo_local_start
);
9179 this_command_key_count
= keys_local_start
;
9180 first_binding
= local_first_binding
;
9182 /* By default, assume each event is "real". */
9183 last_real_key_start
= t
;
9185 /* Does mock_input indicate that we are re-reading a key sequence? */
9189 add_command_key (key
);
9190 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9191 && NILP (Fzerop (Vecho_keystrokes
)))
9195 /* If not, we should actually read a character. */
9199 KBOARD
*interrupted_kboard
= current_kboard
;
9200 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9201 key
= read_char (NILP (prompt
), nmaps
,
9202 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9203 &used_mouse_menu
, NULL
);
9204 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9205 /* When switching to a new tty (with a new keyboard),
9206 read_char returns the new buffer, rather than -2
9207 (Bug#5095). This is because `terminal-init-xterm'
9208 calls read-char, which eats the wrong_kboard_jmpbuf
9209 return. Any better way to fix this? -- cyd */
9210 || (interrupted_kboard
!= current_kboard
))
9215 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9216 if (k
== interrupted_kboard
)
9221 /* Don't touch interrupted_kboard when it's been
9223 delayed_switch_frame
= Qnil
;
9224 goto replay_entire_sequence
;
9227 if (!NILP (delayed_switch_frame
))
9229 interrupted_kboard
->kbd_queue
9230 = Fcons (delayed_switch_frame
,
9231 interrupted_kboard
->kbd_queue
);
9232 delayed_switch_frame
= Qnil
;
9236 interrupted_kboard
->kbd_queue
9237 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9239 /* If the side queue is non-empty, ensure it begins with a
9240 switch-frame, so we'll replay it in the right context. */
9241 if (CONSP (interrupted_kboard
->kbd_queue
)
9242 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9243 !(EVENT_HAS_PARAMETERS (key
)
9244 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9248 XSETFRAME (frame
, interrupted_frame
);
9249 interrupted_kboard
->kbd_queue
9250 = Fcons (make_lispy_switch_frame (frame
),
9251 interrupted_kboard
->kbd_queue
);
9254 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9255 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9256 goto replay_entire_sequence
;
9260 /* read_char returns t when it shows a menu and the user rejects it.
9264 unbind_to (count
, Qnil
);
9269 /* read_char returns -1 at the end of a macro.
9270 Emacs 18 handles this by returning immediately with a
9271 zero, so that's what we'll do. */
9272 if (INTEGERP (key
) && XINT (key
) == -1)
9275 /* The Microsoft C compiler can't handle the goto that
9281 /* If the current buffer has been changed from under us, the
9282 keymap may have changed, so replay the sequence. */
9285 timer_resume_idle ();
9288 /* Reset the current buffer from the selected window
9289 in case something changed the former and not the latter.
9290 This is to be more consistent with the behavior
9291 of the command_loop_1. */
9292 if (fix_current_buffer
)
9294 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9296 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9297 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9300 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9301 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9302 goto replay_sequence
;
9305 /* If we have a quit that was typed in another frame, and
9306 quit_throw_to_read_char switched buffers,
9307 replay to get the right keymap. */
9309 && XINT (key
) == quit_char
9310 && current_buffer
!= starting_buffer
)
9313 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9317 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9318 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9319 goto replay_sequence
;
9324 if (EVENT_HAS_PARAMETERS (key
)
9325 /* Either a `switch-frame' or a `select-window' event. */
9326 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9328 /* If we're at the beginning of a key sequence, and the caller
9329 says it's okay, go ahead and return this event. If we're
9330 in the midst of a key sequence, delay it until the end. */
9331 if (t
> 0 || !can_return_switch_frame
)
9333 delayed_switch_frame
= key
;
9339 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9343 /* Clicks in non-text areas get prefixed by the symbol
9344 in their CHAR-ADDRESS field. For example, a click on
9345 the mode line is prefixed by the symbol `mode-line'.
9347 Furthermore, key sequences beginning with mouse clicks
9348 are read using the keymaps of the buffer clicked on, not
9349 the current buffer. So we may have to switch the buffer
9352 When we turn one event into two events, we must make sure
9353 that neither of the two looks like the original--so that,
9354 if we replay the events, they won't be expanded again.
9355 If not for this, such reexpansion could happen either here
9356 or when user programs play with this-command-keys. */
9357 if (EVENT_HAS_PARAMETERS (key
))
9362 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9363 if (EQ (kind
, Qmouse_click
))
9365 Lisp_Object window
, posn
;
9367 window
= POSN_WINDOW (EVENT_START (key
));
9368 posn
= POSN_POSN (EVENT_START (key
));
9371 || (!NILP (fake_prefixed_keys
)
9372 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9374 /* We're looking a second time at an event for which
9375 we generated a fake prefix key. Set
9376 last_real_key_start appropriately. */
9378 last_real_key_start
= t
- 1;
9381 /* Key sequences beginning with mouse clicks are
9382 read using the keymaps in the buffer clicked on,
9383 not the current buffer. If we're at the
9384 beginning of a key sequence, switch buffers. */
9385 if (last_real_key_start
== 0
9387 && BUFFERP (XWINDOW (window
)->buffer
)
9388 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9390 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9394 /* Arrange to go back to the original buffer once we're
9395 done reading the key sequence. Note that we can't
9396 use save_excursion_{save,restore} here, because they
9397 save point as well as the current buffer; we don't
9398 want to save point, because redisplay may change it,
9399 to accommodate a Fset_window_start or something. We
9400 don't want to do this at the top of the function,
9401 because we may get input from a subprocess which
9402 wants to change the selected window and stuff (say,
9404 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9406 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9408 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9409 orig_local_map
= get_local_map (PT
, current_buffer
,
9411 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9412 goto replay_sequence
;
9415 /* For a mouse click, get the local text-property keymap
9416 of the place clicked on, rather than point. */
9417 if (last_real_key_start
== 0
9418 && CONSP (XCDR (key
))
9419 && ! localized_local_map
)
9421 Lisp_Object map_here
, start
, pos
;
9423 localized_local_map
= 1;
9424 start
= EVENT_START (key
);
9426 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9428 pos
= POSN_BUFFER_POSN (start
);
9430 && XINT (pos
) >= BEGV
9431 && XINT (pos
) <= ZV
)
9433 map_here
= get_local_map (XINT (pos
),
9434 current_buffer
, Qlocal_map
);
9435 if (!EQ (map_here
, orig_local_map
))
9437 orig_local_map
= map_here
;
9438 ++localized_local_map
;
9441 map_here
= get_local_map (XINT (pos
),
9442 current_buffer
, Qkeymap
);
9443 if (!EQ (map_here
, orig_keymap
))
9445 orig_keymap
= map_here
;
9446 ++localized_local_map
;
9449 if (localized_local_map
> 1)
9454 goto replay_sequence
;
9460 /* Expand mode-line and scroll-bar events into two events:
9461 use posn as a fake prefix key. */
9463 && (NILP (fake_prefixed_keys
)
9464 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9466 if (t
+ 1 >= bufsize
)
9467 error ("Key sequence too long");
9470 keybuf
[t
+ 1] = key
;
9473 /* Record that a fake prefix key has been generated
9474 for KEY. Don't modify the event; this would
9475 prevent proper action when the event is pushed
9476 back into unread-command-events. */
9477 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9479 /* If on a mode line string with a local keymap,
9480 reconsider the key sequence with that keymap. */
9481 if (string
= POSN_STRING (EVENT_START (key
)),
9482 (CONSP (string
) && STRINGP (XCAR (string
))))
9484 Lisp_Object pos
, map
, map2
;
9486 pos
= XCDR (string
);
9487 string
= XCAR (string
);
9489 && XINT (pos
) < SCHARS (string
))
9491 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9493 orig_local_map
= map
;
9494 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9497 if (!NILP (map
) || !NILP (map2
))
9498 goto replay_sequence
;
9504 else if (NILP (from_string
)
9505 && (string
= POSN_STRING (EVENT_START (key
)),
9506 (CONSP (string
) && STRINGP (XCAR (string
)))))
9508 /* For a click on a string, i.e. overlay string or a
9509 string displayed via the `display' property,
9510 consider `local-map' and `keymap' properties of
9512 Lisp_Object pos
, map
, map2
;
9514 pos
= XCDR (string
);
9515 string
= XCAR (string
);
9517 && XINT (pos
) < SCHARS (string
))
9519 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9521 orig_local_map
= map
;
9522 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9526 if (!NILP (map
) || !NILP (map2
))
9528 from_string
= string
;
9531 goto replay_sequence
;
9536 else if (CONSP (XCDR (key
))
9537 && CONSP (EVENT_START (key
))
9538 && CONSP (XCDR (EVENT_START (key
))))
9542 posn
= POSN_POSN (EVENT_START (key
));
9543 /* Handle menu-bar events:
9544 insert the dummy prefix event `menu-bar'. */
9545 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9547 if (t
+ 1 >= bufsize
)
9548 error ("Key sequence too long");
9552 /* Zap the position in key, so we know that we've
9553 expanded it, and don't try to do so again. */
9554 POSN_SET_POSN (EVENT_START (key
),
9555 Fcons (posn
, Qnil
));
9558 goto replay_sequence
;
9560 else if (CONSP (posn
))
9562 /* We're looking at the second event of a
9563 sequence which we expanded before. Set
9564 last_real_key_start appropriately. */
9565 if (last_real_key_start
== t
&& t
> 0)
9566 last_real_key_start
= t
- 1;
9571 /* We have finally decided that KEY is something we might want
9573 first_binding
= (follow_key (key
,
9574 nmaps
- first_binding
,
9575 submaps
+ first_binding
,
9576 defs
+ first_binding
,
9577 submaps
+ first_binding
)
9580 /* If KEY wasn't bound, we'll try some fallbacks. */
9581 if (first_binding
< nmaps
)
9582 /* This is needed for the following scenario:
9583 event 0: a down-event that gets dropped by calling replay_key.
9584 event 1: some normal prefix like C-h.
9585 After event 0, first_unbound is 0, after event 1 indec.start,
9586 fkey.start, and keytran.start are all 1, so when we see that
9587 C-h is bound, we need to update first_unbound. */
9588 first_unbound
= max (t
+ 1, first_unbound
);
9593 /* Remember the position to put an upper bound on indec.start. */
9594 first_unbound
= min (t
, first_unbound
);
9596 head
= EVENT_HEAD (key
);
9597 if (help_char_p (head
) && t
> 0)
9599 read_key_sequence_cmd
= Vprefix_help_command
;
9601 last_nonmenu_event
= key
;
9602 /* The Microsoft C compiler can't handle the goto that
9610 Lisp_Object breakdown
;
9613 breakdown
= parse_modifiers (head
);
9614 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9615 /* Attempt to reduce an unbound mouse event to a simpler
9616 event that is bound:
9617 Drags reduce to clicks.
9618 Double-clicks reduce to clicks.
9619 Triple-clicks reduce to double-clicks, then to clicks.
9620 Down-clicks are eliminated.
9621 Double-downs reduce to downs, then are eliminated.
9622 Triple-downs reduce to double-downs, then to downs,
9623 then are eliminated. */
9624 if (modifiers
& (down_modifier
| drag_modifier
9625 | double_modifier
| triple_modifier
))
9627 while (modifiers
& (down_modifier
| drag_modifier
9628 | double_modifier
| triple_modifier
))
9630 Lisp_Object new_head
, new_click
;
9631 if (modifiers
& triple_modifier
)
9632 modifiers
^= (double_modifier
| triple_modifier
);
9633 else if (modifiers
& double_modifier
)
9634 modifiers
&= ~double_modifier
;
9635 else if (modifiers
& drag_modifier
)
9636 modifiers
&= ~drag_modifier
;
9639 /* Dispose of this `down' event by simply jumping
9640 back to replay_key, to get another event.
9642 Note that if this event came from mock input,
9643 then just jumping back to replay_key will just
9644 hand it to us again. So we have to wipe out any
9647 We could delete keybuf[t] and shift everything
9648 after that to the left by one spot, but we'd also
9649 have to fix up any variable that points into
9650 keybuf, and shifting isn't really necessary
9653 Adding prefixes for non-textual mouse clicks
9654 creates two characters of mock input, and both
9655 must be thrown away. If we're only looking at
9656 the prefix now, we can just jump back to
9657 replay_key. On the other hand, if we've already
9658 processed the prefix, and now the actual click
9659 itself is giving us trouble, then we've lost the
9660 state of the keymaps we want to backtrack to, and
9661 we need to replay the whole sequence to rebuild
9664 Beyond that, only function key expansion could
9665 create more than two keys, but that should never
9666 generate mouse events, so it's okay to zero
9667 mock_input in that case too.
9669 FIXME: The above paragraph seems just plain
9670 wrong, if you consider things like
9671 xterm-mouse-mode. -stef
9673 Isn't this just the most wonderful code ever? */
9675 /* If mock_input > t + 1, the above simplification
9676 will actually end up dropping keys on the floor.
9677 This is probably OK for now, but even
9678 if mock_input <= t + 1, we need to adjust indec,
9680 Typical case [header-line down-mouse-N]:
9681 mock_input = 2, t = 1, fkey.end = 1,
9682 last_real_key_start = 0. */
9683 if (indec
.end
> last_real_key_start
)
9685 indec
.end
= indec
.start
9686 = min (last_real_key_start
, indec
.start
);
9687 indec
.map
= indec
.parent
;
9688 if (fkey
.end
> last_real_key_start
)
9690 fkey
.end
= fkey
.start
9691 = min (last_real_key_start
, fkey
.start
);
9692 fkey
.map
= fkey
.parent
;
9693 if (keytran
.end
> last_real_key_start
)
9695 keytran
.end
= keytran
.start
9696 = min (last_real_key_start
, keytran
.start
);
9697 keytran
.map
= keytran
.parent
;
9701 if (t
== last_real_key_start
)
9708 mock_input
= last_real_key_start
;
9709 goto replay_sequence
;
9714 = apply_modifiers (modifiers
, XCAR (breakdown
));
9716 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9718 /* Look for a binding for this new key. follow_key
9719 promises that it didn't munge submaps the
9720 last time we called it, since key was unbound. */
9722 = (follow_key (new_click
,
9723 nmaps
- local_first_binding
,
9724 submaps
+ local_first_binding
,
9725 defs
+ local_first_binding
,
9726 submaps
+ local_first_binding
)
9727 + local_first_binding
);
9729 /* If that click is bound, go for it. */
9730 if (first_binding
< nmaps
)
9735 /* Otherwise, we'll leave key set to the drag event. */
9742 /* Normally, last_nonmenu_event gets the previous key we read.
9743 But when a mouse popup menu is being used,
9744 we don't update last_nonmenu_event; it continues to hold the mouse
9745 event that preceded the first level of menu. */
9746 if (!used_mouse_menu
)
9747 last_nonmenu_event
= key
;
9749 /* Record what part of this_command_keys is the current key sequence. */
9750 this_single_command_key_start
= this_command_key_count
- t
;
9752 /* Look for this sequence in input-decode-map.
9753 Scan from indec.end until we find a bound suffix. */
9754 while (indec
.end
< t
)
9756 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9759 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9760 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9765 mock_input
= diff
+ max (t
, mock_input
);
9766 goto replay_sequence
;
9770 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9771 && indec
.start
>= t
)
9772 /* There is a binding and it's not a prefix.
9773 (and it doesn't have any input-decode-map translation pending).
9774 There is thus no function-key in this sequence.
9775 Moving fkey.start is important in this case to allow keytran.start
9776 to go over the sequence before we return (since we keep the
9777 invariant that keytran.end <= fkey.start). */
9780 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9783 /* If the sequence is unbound, see if we can hang a function key
9784 off the end of it. */
9785 /* Continue scan from fkey.end until we find a bound suffix. */
9786 while (fkey
.end
< indec
.start
)
9788 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9791 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9792 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9793 max (t
, mock_input
),
9794 /* If there's a binding (i.e.
9795 first_binding >= nmaps) we don't want
9796 to apply this function-key-mapping. */
9797 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9802 mock_input
= diff
+ max (t
, mock_input
);
9803 /* Adjust the input-decode-map counters. */
9805 indec
.start
+= diff
;
9807 goto replay_sequence
;
9811 /* Look for this sequence in key-translation-map.
9812 Scan from keytran.end until we find a bound suffix. */
9813 while (keytran
.end
< fkey
.start
)
9815 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9818 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9819 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9824 mock_input
= diff
+ max (t
, mock_input
);
9825 /* Adjust the function-key-map and input-decode-map counters. */
9827 indec
.start
+= diff
;
9831 goto replay_sequence
;
9835 /* If KEY is not defined in any of the keymaps,
9836 and cannot be part of a function key or translation,
9837 and is an upper case letter
9838 use the corresponding lower-case letter instead. */
9839 if (first_binding
>= nmaps
9840 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9842 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9843 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9844 || (XINT (key
) & shift_modifier
)))
9846 Lisp_Object new_key
;
9848 original_uppercase
= key
;
9849 original_uppercase_position
= t
- 1;
9851 if (XINT (key
) & shift_modifier
)
9852 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9854 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9855 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9857 /* We have to do this unconditionally, regardless of whether
9858 the lower-case char is defined in the keymaps, because they
9859 might get translated through function-key-map. */
9860 keybuf
[t
- 1] = new_key
;
9861 mock_input
= max (t
, mock_input
);
9862 shift_translated
= 1;
9864 goto replay_sequence
;
9866 /* If KEY is not defined in any of the keymaps,
9867 and cannot be part of a function key or translation,
9868 and is a shifted function key,
9869 use the corresponding unshifted function key instead. */
9870 if (first_binding
>= nmaps
9871 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9873 Lisp_Object breakdown
= parse_modifiers (key
);
9875 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9877 if (modifiers
& shift_modifier
9878 /* Treat uppercase keys as shifted. */
9880 && (KEY_TO_CHAR (key
)
9881 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9882 && UPPERCASEP (KEY_TO_CHAR (key
))))
9885 = (modifiers
& shift_modifier
9886 ? apply_modifiers (modifiers
& ~shift_modifier
,
9888 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
9890 original_uppercase
= key
;
9891 original_uppercase_position
= t
- 1;
9893 /* We have to do this unconditionally, regardless of whether
9894 the lower-case char is defined in the keymaps, because they
9895 might get translated through function-key-map. */
9896 keybuf
[t
- 1] = new_key
;
9897 mock_input
= max (t
, mock_input
);
9898 /* Reset fkey (and consequently keytran) to apply
9899 function-key-map on the result, so that S-backspace is
9900 correctly mapped to DEL (via backspace). OTOH,
9901 input-decode-map doesn't need to go through it again. */
9902 fkey
.start
= fkey
.end
= 0;
9903 keytran
.start
= keytran
.end
= 0;
9904 shift_translated
= 1;
9906 goto replay_sequence
;
9911 read_key_sequence_cmd
= (first_binding
< nmaps
9912 ? defs
[first_binding
]
9915 unread_switch_frame
= delayed_switch_frame
;
9916 unbind_to (count
, Qnil
);
9918 /* Don't downcase the last character if the caller says don't.
9919 Don't downcase it if the result is undefined, either. */
9920 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9922 && t
- 1 == original_uppercase_position
)
9924 keybuf
[t
- 1] = original_uppercase
;
9925 shift_translated
= 0;
9928 if (shift_translated
)
9929 Vthis_command_keys_shift_translated
= Qt
;
9931 /* Occasionally we fabricate events, perhaps by expanding something
9932 according to function-key-map, or by adding a prefix symbol to a
9933 mouse click in the scroll bar or modeline. In this cases, return
9934 the entire generated key sequence, even if we hit an unbound
9935 prefix or a definition before the end. This means that you will
9936 be able to push back the event properly, and also means that
9937 read-key-sequence will always return a logical unit.
9940 for (; t
< mock_input
; t
++)
9942 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9943 && NILP (Fzerop (Vecho_keystrokes
)))
9944 echo_char (keybuf
[t
]);
9945 add_command_key (keybuf
[t
]);
9952 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9953 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9954 The sequence is sufficient to specify a non-prefix command in the
9955 current local and global maps.
9957 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9958 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9959 as a continuation of the previous key.
9961 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9962 convert the last event to lower case. (Normally any upper case event
9963 is converted to lower case if the original event is undefined and the lower
9964 case equivalent is defined.) A non-nil value is appropriate for reading
9965 a key sequence to be defined.
9967 A C-g typed while in this function is treated like any other character,
9968 and `quit-flag' is not set.
9970 If the key sequence starts with a mouse click, then the sequence is read
9971 using the keymaps of the buffer of the window clicked in, not the buffer
9972 of the selected window as normal.
9974 `read-key-sequence' drops unbound button-down events, since you normally
9975 only care about the click or drag events which follow them. If a drag
9976 or multi-click event is unbound, but the corresponding click event would
9977 be bound, `read-key-sequence' turns the event into a click event at the
9978 drag's starting position. This means that you don't have to distinguish
9979 between click and drag, double, or triple events unless you want to.
9981 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9982 lines separating windows, and scroll bars with imaginary keys
9983 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9985 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9986 function will process a switch-frame event if the user switches frames
9987 before typing anything. If the user switches frames in the middle of a
9988 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9989 is nil, then the event will be put off until after the current key sequence.
9991 `read-key-sequence' checks `function-key-map' for function key
9992 sequences, where they wouldn't conflict with ordinary bindings. See
9993 `function-key-map' for more details.
9995 The optional fifth argument COMMAND-LOOP, if non-nil, means
9996 that this key sequence is being read by something that will
9997 read commands one after another. It should be nil if the caller
9998 will read just one key sequence. */)
9999 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10001 Lisp_Object keybuf
[30];
10003 struct gcpro gcpro1
;
10004 int count
= SPECPDL_INDEX ();
10006 if (!NILP (prompt
))
10007 CHECK_STRING (prompt
);
10010 specbind (Qinput_method_exit_on_first_char
,
10011 (NILP (command_loop
) ? Qt
: Qnil
));
10012 specbind (Qinput_method_use_echo_area
,
10013 (NILP (command_loop
) ? Qt
: Qnil
));
10015 memset (keybuf
, 0, sizeof keybuf
);
10016 GCPRO1 (keybuf
[0]);
10017 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10019 if (NILP (continue_echo
))
10021 this_command_key_count
= 0;
10022 this_command_key_count_reset
= 0;
10023 this_single_command_key_start
= 0;
10026 #ifdef HAVE_WINDOW_SYSTEM
10027 if (display_hourglass_p
)
10028 cancel_hourglass ();
10031 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10032 prompt
, ! NILP (dont_downcase_last
),
10033 ! NILP (can_return_switch_frame
), 0);
10035 #if 0 /* The following is fine for code reading a key sequence and
10036 then proceeding with a lenghty computation, but it's not good
10037 for code reading keys in a loop, like an input method. */
10038 #ifdef HAVE_WINDOW_SYSTEM
10039 if (display_hourglass_p
)
10040 start_hourglass ();
10050 return unbind_to (count
, make_event_array (i
, keybuf
));
10053 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10054 Sread_key_sequence_vector
, 1, 5, 0,
10055 doc
: /* Like `read-key-sequence' but always return a vector. */)
10056 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10058 Lisp_Object keybuf
[30];
10060 struct gcpro gcpro1
;
10061 int count
= SPECPDL_INDEX ();
10063 if (!NILP (prompt
))
10064 CHECK_STRING (prompt
);
10067 specbind (Qinput_method_exit_on_first_char
,
10068 (NILP (command_loop
) ? Qt
: Qnil
));
10069 specbind (Qinput_method_use_echo_area
,
10070 (NILP (command_loop
) ? Qt
: Qnil
));
10072 memset (keybuf
, 0, sizeof keybuf
);
10073 GCPRO1 (keybuf
[0]);
10074 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10076 if (NILP (continue_echo
))
10078 this_command_key_count
= 0;
10079 this_command_key_count_reset
= 0;
10080 this_single_command_key_start
= 0;
10083 #ifdef HAVE_WINDOW_SYSTEM
10084 if (display_hourglass_p
)
10085 cancel_hourglass ();
10088 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10089 prompt
, ! NILP (dont_downcase_last
),
10090 ! NILP (can_return_switch_frame
), 0);
10092 #ifdef HAVE_WINDOW_SYSTEM
10093 if (display_hourglass_p
)
10094 start_hourglass ();
10103 return unbind_to (count
, Fvector (i
, keybuf
));
10106 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10107 doc
: /* Execute CMD as an editor command.
10108 CMD must be a symbol that satisfies the `commandp' predicate.
10109 Optional second arg RECORD-FLAG non-nil
10110 means unconditionally put this command in `command-history'.
10111 Otherwise, that is done only if an arg is read using the minibuffer.
10112 The argument KEYS specifies the value to use instead of (this-command-keys)
10113 when reading the arguments; if it is nil, (this-command-keys) is used.
10114 The argument SPECIAL, if non-nil, means that this command is executing
10115 a special event, so ignore the prefix argument and don't clear it. */)
10116 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10118 register Lisp_Object final
;
10119 register Lisp_Object tem
;
10120 Lisp_Object prefixarg
;
10122 debug_on_next_call
= 0;
10124 if (NILP (special
))
10126 prefixarg
= current_kboard
->Vprefix_arg
;
10127 Vcurrent_prefix_arg
= prefixarg
;
10128 current_kboard
->Vprefix_arg
= Qnil
;
10135 tem
= Fget (cmd
, Qdisabled
);
10136 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10138 tem
= Fsymbol_value (Qdisabled_command_function
);
10140 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10146 final
= Findirect_function (cmd
, Qnil
);
10148 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10150 struct gcpro gcpro1
, gcpro2
;
10152 GCPRO2 (cmd
, prefixarg
);
10153 do_autoload (final
, cmd
);
10160 if (STRINGP (final
) || VECTORP (final
))
10162 /* If requested, place the macro in the command history. For
10163 other sorts of commands, call-interactively takes care of
10165 if (!NILP (record_flag
))
10168 = Fcons (Fcons (Qexecute_kbd_macro
,
10169 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10172 /* Don't keep command history around forever. */
10173 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10175 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10177 XSETCDR (tem
, Qnil
);
10181 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10184 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10185 /* Don't call Fcall_interactively directly because we want to make
10186 sure the backtrace has an entry for `call-interactively'.
10187 For the same reason, pass `cmd' rather than `final'. */
10188 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10195 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10197 doc
: /* Read function name, then read its arguments and call it.
10199 To pass a numeric argument to the command you are invoking with, specify
10200 the numeric argument to this command.
10202 Noninteractively, the argument PREFIXARG is the prefix argument to
10203 give to the command you invoke, if it asks for an argument. */)
10204 (Lisp_Object prefixarg
)
10206 Lisp_Object function
;
10207 EMACS_INT saved_last_point_position
;
10208 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10209 Lisp_Object bindings
, value
;
10210 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10211 #ifdef HAVE_WINDOW_SYSTEM
10212 /* The call to Fcompleting_read will start and cancel the hourglass,
10213 but if the hourglass was already scheduled, this means that no
10214 hourglass will be shown for the actual M-x command itself.
10215 So we restart it if it is already scheduled. Note that checking
10216 hourglass_shown_p is not enough, normally the hourglass is not shown,
10217 just scheduled to be shown. */
10218 int hstarted
= hourglass_started ();
10221 saved_keys
= Fvector (this_command_key_count
,
10222 XVECTOR (this_command_keys
)->contents
);
10223 saved_last_point_position_buffer
= last_point_position_buffer
;
10224 saved_last_point_position
= last_point_position
;
10225 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10227 function
= call0 (intern ("read-extended-command"));
10229 #ifdef HAVE_WINDOW_SYSTEM
10230 if (hstarted
) start_hourglass ();
10233 if (STRINGP (function
) && SCHARS (function
) == 0)
10234 error ("No command name given");
10236 /* Set this_command_keys to the concatenation of saved_keys and
10237 function, followed by a RET. */
10242 this_command_key_count
= 0;
10243 this_command_key_count_reset
= 0;
10244 this_single_command_key_start
= 0;
10246 keys
= XVECTOR (saved_keys
)->contents
;
10247 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10248 add_command_key (keys
[i
]);
10250 for (i
= 0; i
< SCHARS (function
); i
++)
10251 add_command_key (Faref (function
, make_number (i
)));
10253 add_command_key (make_number ('\015'));
10256 last_point_position
= saved_last_point_position
;
10257 last_point_position_buffer
= saved_last_point_position_buffer
;
10261 function
= Fintern (function
, Qnil
);
10262 current_kboard
->Vprefix_arg
= prefixarg
;
10263 Vthis_command
= function
;
10264 real_this_command
= function
;
10266 /* If enabled, show which key runs this command. */
10267 if (!NILP (Vsuggest_key_bindings
)
10268 && NILP (Vexecuting_kbd_macro
)
10269 && SYMBOLP (function
))
10270 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10276 GCPRO3 (bindings
, value
, function
);
10277 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10279 /* If the command has a key binding, print it now. */
10280 if (!NILP (bindings
)
10281 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10284 /* But first wait, and skip the message if there is input. */
10285 Lisp_Object waited
;
10287 /* If this command displayed something in the echo area;
10288 wait a few seconds, then display our suggestion message. */
10289 if (NILP (echo_area_buffer
[0]))
10290 waited
= sit_for (make_number (0), 0, 2);
10291 else if (NUMBERP (Vsuggest_key_bindings
))
10292 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10294 waited
= sit_for (make_number (2), 0, 2);
10296 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10298 Lisp_Object binding
;
10300 int message_p
= push_message ();
10301 int count
= SPECPDL_INDEX ();
10303 record_unwind_protect (pop_message_unwind
, Qnil
);
10304 binding
= Fkey_description (bindings
, Qnil
);
10307 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10310 sprintf (newmessage
, "You can run the command `%s' with %s",
10311 SDATA (SYMBOL_NAME (function
)),
10313 message2_nolog (newmessage
,
10314 strlen (newmessage
),
10315 STRING_MULTIBYTE (binding
));
10316 if (NUMBERP (Vsuggest_key_bindings
))
10317 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10319 waited
= sit_for (make_number (2), 0, 2);
10321 if (!NILP (waited
) && message_p
)
10322 restore_message ();
10324 unbind_to (count
, Qnil
);
10328 RETURN_UNGCPRO (value
);
10332 /* Return nonzero if input events are pending. */
10335 detect_input_pending (void)
10337 if (!input_pending
)
10338 get_input_pending (&input_pending
, 0);
10340 return input_pending
;
10343 /* Return nonzero if input events other than mouse movements are
10347 detect_input_pending_ignore_squeezables (void)
10349 if (!input_pending
)
10350 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10352 return input_pending
;
10355 /* Return nonzero if input events are pending, and run any pending timers. */
10358 detect_input_pending_run_timers (int do_display
)
10360 int old_timers_run
= timers_run
;
10362 if (!input_pending
)
10363 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10365 if (old_timers_run
!= timers_run
&& do_display
)
10367 redisplay_preserve_echo_area (8);
10368 /* The following fixes a bug when using lazy-lock with
10369 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10370 from an idle timer function. The symptom of the bug is that
10371 the cursor sometimes doesn't become visible until the next X
10372 event is processed. --gerd. */
10374 Lisp_Object tail
, frame
;
10375 FOR_EACH_FRAME (tail
, frame
)
10376 if (FRAME_RIF (XFRAME (frame
)))
10377 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10381 return input_pending
;
10384 /* This is called in some cases before a possible quit.
10385 It cases the next call to detect_input_pending to recompute input_pending.
10386 So calling this function unnecessarily can't do any harm. */
10389 clear_input_pending (void)
10394 /* Return nonzero if there are pending requeued events.
10395 This isn't used yet. The hope is to make wait_reading_process_output
10396 call it, and return if it runs Lisp code that unreads something.
10397 The problem is, kbd_buffer_get_event needs to be fixed to know what
10398 to do in that case. It isn't trivial. */
10401 requeued_events_pending_p (void)
10403 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10407 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10408 doc
: /* Return t if command input is currently available with no wait.
10409 Actually, the value is nil only if we can be sure that no input is available;
10410 if there is a doubt, the value is t. */)
10413 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10414 || !NILP (Vunread_post_input_method_events
)
10415 || !NILP (Vunread_input_method_events
))
10418 get_input_pending (&input_pending
,
10419 READABLE_EVENTS_DO_TIMERS_NOW
10420 | READABLE_EVENTS_FILTER_EVENTS
);
10421 return input_pending
> 0 ? Qt
: Qnil
;
10424 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10425 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10428 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10431 if (total_keys
< NUM_RECENT_KEYS
)
10432 return Fvector (total_keys
, keys
);
10435 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10436 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10437 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10438 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10439 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10444 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10445 doc
: /* Return the key sequence that invoked this command.
10446 However, if the command has called `read-key-sequence', it returns
10447 the last key sequence that has been read.
10448 The value is a string or a vector.
10450 See also `this-command-keys-vector'. */)
10453 return make_event_array (this_command_key_count
,
10454 XVECTOR (this_command_keys
)->contents
);
10457 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10458 doc
: /* Return the key sequence that invoked this command, as a vector.
10459 However, if the command has called `read-key-sequence', it returns
10460 the last key sequence that has been read.
10462 See also `this-command-keys'. */)
10465 return Fvector (this_command_key_count
,
10466 XVECTOR (this_command_keys
)->contents
);
10469 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10470 Sthis_single_command_keys
, 0, 0, 0,
10471 doc
: /* Return the key sequence that invoked this command.
10472 More generally, it returns the last key sequence read, either by
10473 the command loop or by `read-key-sequence'.
10474 Unlike `this-command-keys', this function's value
10475 does not include prefix arguments.
10476 The value is always a vector. */)
10479 return Fvector (this_command_key_count
10480 - this_single_command_key_start
,
10481 (XVECTOR (this_command_keys
)->contents
10482 + this_single_command_key_start
));
10485 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10486 Sthis_single_command_raw_keys
, 0, 0, 0,
10487 doc
: /* Return the raw events that were read for this command.
10488 More generally, it returns the last key sequence read, either by
10489 the command loop or by `read-key-sequence'.
10490 Unlike `this-single-command-keys', this function's value
10491 shows the events before all translations (except for input methods).
10492 The value is always a vector. */)
10495 return Fvector (raw_keybuf_count
,
10496 (XVECTOR (raw_keybuf
)->contents
));
10499 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10500 Sreset_this_command_lengths
, 0, 0, 0,
10501 doc
: /* Make the unread events replace the last command and echo.
10502 Used in `universal-argument-other-key'.
10504 `universal-argument-other-key' rereads the event just typed.
10505 It then gets translated through `function-key-map'.
10506 The translated event has to replace the real events,
10507 both in the value of (this-command-keys) and in echoing.
10508 To achieve this, `universal-argument-other-key' calls
10509 `reset-this-command-lengths', which discards the record of reading
10510 these events the first time. */)
10513 this_command_key_count
= before_command_key_count
;
10514 if (this_command_key_count
< this_single_command_key_start
)
10515 this_single_command_key_start
= this_command_key_count
;
10517 echo_truncate (before_command_echo_length
);
10519 /* Cause whatever we put into unread-command-events
10520 to echo as if it were being freshly read from the keyboard. */
10521 this_command_key_count_reset
= 1;
10526 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10527 Sclear_this_command_keys
, 0, 1, 0,
10528 doc
: /* Clear out the vector that `this-command-keys' returns.
10529 Also clear the record of the last 100 events, unless optional arg
10530 KEEP-RECORD is non-nil. */)
10531 (Lisp_Object keep_record
)
10535 this_command_key_count
= 0;
10536 this_command_key_count_reset
= 0;
10538 if (NILP (keep_record
))
10540 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10541 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10543 recent_keys_index
= 0;
10548 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10549 doc
: /* Return the current depth in recursive edits. */)
10553 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10557 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10558 "FOpen dribble file: ",
10559 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10560 If FILE is nil, close any open dribble file. */)
10572 file
= Fexpand_file_name (file
, Qnil
);
10573 dribble
= fopen (SSDATA (file
), "w");
10575 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10580 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10581 doc
: /* Discard the contents of the terminal input buffer.
10582 Also end any kbd macro being defined. */)
10585 if (!NILP (current_kboard
->defining_kbd_macro
))
10587 /* Discard the last command from the macro. */
10588 Fcancel_kbd_macro_events ();
10592 update_mode_lines
++;
10594 Vunread_command_events
= Qnil
;
10595 unread_command_char
= -1;
10597 discard_tty_input ();
10599 kbd_fetch_ptr
= kbd_store_ptr
;
10605 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10606 doc
: /* Stop Emacs and return to superior process. You can resume later.
10607 If `cannot-suspend' is non-nil, or if the system doesn't support job
10608 control, run a subshell instead.
10610 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10611 to be read as terminal input by Emacs's parent, after suspension.
10613 Before suspending, run the normal hook `suspend-hook'.
10614 After resumption run the normal hook `suspend-resume-hook'.
10616 Some operating systems cannot stop the Emacs process and resume it later.
10617 On such systems, Emacs starts a subshell instead of suspending. */)
10618 (Lisp_Object stuffstring
)
10620 int count
= SPECPDL_INDEX ();
10621 int old_height
, old_width
;
10623 struct gcpro gcpro1
;
10625 if (tty_list
&& tty_list
->next
)
10626 error ("There are other tty frames open; close them before suspending Emacs");
10628 if (!NILP (stuffstring
))
10629 CHECK_STRING (stuffstring
);
10631 /* Run the functions in suspend-hook. */
10632 if (!NILP (Vrun_hooks
))
10633 call1 (Vrun_hooks
, intern ("suspend-hook"));
10635 GCPRO1 (stuffstring
);
10636 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10637 reset_all_sys_modes ();
10638 /* sys_suspend can get an error if it tries to fork a subshell
10639 and the system resources aren't available for that. */
10640 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10642 stuff_buffered_input (stuffstring
);
10643 if (cannot_suspend
)
10647 unbind_to (count
, Qnil
);
10649 /* Check if terminal/window size has changed.
10650 Note that this is not useful when we are running directly
10651 with a window system; but suspend should be disabled in that case. */
10652 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10653 if (width
!= old_width
|| height
!= old_height
)
10654 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10656 /* Run suspend-resume-hook. */
10657 if (!NILP (Vrun_hooks
))
10658 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10664 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10665 Then in any case stuff anything Emacs has read ahead and not used. */
10668 stuff_buffered_input (Lisp_Object stuffstring
)
10670 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10671 register unsigned char *p
;
10673 if (STRINGP (stuffstring
))
10675 register EMACS_INT count
;
10677 p
= SDATA (stuffstring
);
10678 count
= SBYTES (stuffstring
);
10679 while (count
-- > 0)
10684 /* Anything we have read ahead, put back for the shell to read. */
10685 /* ?? What should this do when we have multiple keyboards??
10686 Should we ignore anything that was typed in at the "wrong" kboard?
10688 rms: we should stuff everything back into the kboard
10690 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10693 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10694 kbd_fetch_ptr
= kbd_buffer
;
10695 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10696 stuff_char (kbd_fetch_ptr
->code
);
10698 clear_event (kbd_fetch_ptr
);
10702 #endif /* SIGTSTP */
10706 set_waiting_for_input (struct timeval
*time_to_clear
)
10708 input_available_clear_time
= time_to_clear
;
10710 /* Tell handle_interrupt to throw back to read_char, */
10711 waiting_for_input
= 1;
10713 /* If handle_interrupt was called before and buffered a C-g,
10714 make it run again now, to avoid timing error. */
10715 if (!NILP (Vquit_flag
))
10716 quit_throw_to_read_char ();
10720 clear_waiting_for_input (void)
10722 /* Tell handle_interrupt not to throw back to read_char, */
10723 waiting_for_input
= 0;
10724 input_available_clear_time
= 0;
10727 /* The SIGINT handler.
10729 If we have a frame on the controlling tty, we assume that the
10730 SIGINT was generated by C-g, so we call handle_interrupt.
10731 Otherwise, the handler kills Emacs. */
10734 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10735 /* compilers complain in signal calls. */
10737 /* Must preserve main program's value of errno. */
10738 int old_errno
= errno
;
10739 struct terminal
*terminal
;
10741 SIGNAL_THREAD_CHECK (signalnum
);
10743 /* See if we have an active terminal on our controlling tty. */
10744 terminal
= get_named_tty ("/dev/tty");
10747 /* If there are no frames there, let's pretend that we are a
10748 well-behaving UN*X program and quit. */
10749 Fkill_emacs (Qnil
);
10753 /* Otherwise, the SIGINT was probably generated by C-g. */
10755 /* Set internal_last_event_frame to the top frame of the
10756 controlling tty, if we have a frame there. We disable the
10757 interrupt key on secondary ttys, so the SIGINT must have come
10758 from the controlling tty. */
10759 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10761 handle_interrupt ();
10767 /* This routine is called at interrupt level in response to C-g.
10769 It is called from the SIGINT handler or kbd_buffer_store_event.
10771 If `waiting_for_input' is non zero, then unless `echoing' is
10772 nonzero, immediately throw back to read_char.
10774 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10775 eval to throw, when it gets a chance. If quit-flag is already
10776 non-nil, it stops the job right away. */
10779 handle_interrupt (void)
10785 /* XXX This code needs to be revised for multi-tty support. */
10786 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10788 /* If SIGINT isn't blocked, don't let us be interrupted by
10789 another SIGINT, it might be harmful due to non-reentrancy
10790 in I/O functions. */
10791 sigblock (sigmask (SIGINT
));
10794 reset_all_sys_modes ();
10796 #ifdef SIGTSTP /* Support possible in later USG versions */
10798 * On systems which can suspend the current process and return to the original
10799 * shell, this command causes the user to end up back at the shell.
10800 * The "Auto-save" and "Abort" questions are not asked until
10801 * the user elects to return to emacs, at which point he can save the current
10802 * job and either dump core or continue.
10806 /* Perhaps should really fork an inferior shell?
10807 But that would not provide any way to get back
10808 to the original shell, ever. */
10809 printf ("No support for stopping a process on this operating system;\n");
10810 printf ("you can continue or abort.\n");
10811 #endif /* not SIGTSTP */
10813 /* We must remain inside the screen area when the internal terminal
10814 is used. Note that [Enter] is not echoed by dos. */
10815 cursor_to (SELECTED_FRAME (), 0, 0);
10817 /* It doesn't work to autosave while GC is in progress;
10818 the code used for auto-saving doesn't cope with the mark bit. */
10819 if (!gc_in_progress
)
10821 printf ("Auto-save? (y or n) ");
10823 if (((c
= getchar ()) & ~040) == 'Y')
10825 Fdo_auto_save (Qt
, Qnil
);
10827 printf ("\r\nAuto-save done");
10828 #else /* not MSDOS */
10829 printf ("Auto-save done\n");
10830 #endif /* not MSDOS */
10832 while (c
!= '\n') c
= getchar ();
10836 /* During GC, it must be safe to reenable quitting again. */
10837 Vinhibit_quit
= Qnil
;
10840 #endif /* not MSDOS */
10841 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10842 printf ("but will instead do a real quit after garbage collection ends\r\n");
10847 printf ("\r\nAbort? (y or n) ");
10848 #else /* not MSDOS */
10849 printf ("Abort (and dump core)? (y or n) ");
10850 #endif /* not MSDOS */
10852 if (((c
= getchar ()) & ~040) == 'Y')
10854 while (c
!= '\n') c
= getchar ();
10856 printf ("\r\nContinuing...\r\n");
10857 #else /* not MSDOS */
10858 printf ("Continuing...\n");
10859 #endif /* not MSDOS */
10861 init_all_sys_modes ();
10866 /* If executing a function that wants to be interrupted out of
10867 and the user has not deferred quitting by binding `inhibit-quit'
10868 then quit right away. */
10869 if (immediate_quit
&& NILP (Vinhibit_quit
))
10871 struct gl_state_s saved
;
10872 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10874 immediate_quit
= 0;
10877 GCPRO4 (saved
.object
, saved
.global_code
,
10878 saved
.current_syntax_table
, saved
.old_prop
);
10879 Fsignal (Qquit
, Qnil
);
10880 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10885 /* Else request quit when it's safe */
10889 /* TODO: The longjmp in this call throws the NS event loop integration off,
10890 and it seems to do fine without this. Probably some attention
10891 needs to be paid to the setting of waiting_for_input in
10892 wait_reading_process_output() under HAVE_NS because of the call
10893 to ns_select there (needed because otherwise events aren't picked up
10894 outside of polling since we don't get SIGIO like X and we don't have a
10895 separate event loop thread like W32. */
10897 if (waiting_for_input
&& !echoing
)
10898 quit_throw_to_read_char ();
10902 /* Handle a C-g by making read_char return C-g. */
10905 quit_throw_to_read_char (void)
10908 /* Prevent another signal from doing this before we finish. */
10909 clear_waiting_for_input ();
10912 Vunread_command_events
= Qnil
;
10913 unread_command_char
= -1;
10915 #if 0 /* Currently, sit_for is called from read_char without turning
10916 off polling. And that can call set_waiting_for_input.
10917 It seems to be harmless. */
10918 #ifdef POLL_FOR_INPUT
10919 /* May be > 1 if in recursive minibuffer. */
10920 if (poll_suppress_count
== 0)
10924 if (FRAMEP (internal_last_event_frame
)
10925 && !EQ (internal_last_event_frame
, selected_frame
))
10926 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10929 _longjmp (getcjmp
, 1);
10932 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10933 doc
: /* Set interrupt mode of reading keyboard input.
10934 If INTERRUPT is non-nil, Emacs will use input interrupts;
10935 otherwise Emacs uses CBREAK mode.
10937 See also `current-input-mode'. */)
10938 (Lisp_Object interrupt
)
10940 int new_interrupt_input
;
10942 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10943 #ifdef HAVE_X_WINDOWS
10944 if (x_display_list
!= NULL
)
10946 /* When using X, don't give the user a real choice,
10947 because we haven't implemented the mechanisms to support it. */
10948 new_interrupt_input
= 1;
10951 #endif /* HAVE_X_WINDOWS */
10952 new_interrupt_input
= !NILP (interrupt
);
10953 #else /* not SIGIO */
10954 new_interrupt_input
= 0;
10955 #endif /* not SIGIO */
10957 if (new_interrupt_input
!= interrupt_input
)
10959 #ifdef POLL_FOR_INPUT
10963 /* this causes startup screen to be restored and messes with the mouse */
10964 reset_all_sys_modes ();
10965 interrupt_input
= new_interrupt_input
;
10966 init_all_sys_modes ();
10968 interrupt_input
= new_interrupt_input
;
10971 #ifdef POLL_FOR_INPUT
10972 poll_suppress_count
= 1;
10979 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10980 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10981 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10982 C-q in key sequences.
10984 This setting only has an effect on tty terminals and only when
10985 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10987 See also `current-input-mode'. */)
10988 (Lisp_Object flow
, Lisp_Object terminal
)
10990 struct terminal
*t
= get_terminal (terminal
, 1);
10991 struct tty_display_info
*tty
;
10992 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10994 tty
= t
->display_info
.tty
;
10996 if (tty
->flow_control
!= !NILP (flow
))
10999 /* this causes startup screen to be restored and messes with the mouse */
11000 reset_sys_modes (tty
);
11003 tty
->flow_control
= !NILP (flow
);
11006 init_sys_modes (tty
);
11012 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11013 doc
: /* Enable or disable 8-bit input on TERMINAL.
11014 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11015 bit as the Meta modifier.
11017 If META is nil, Emacs will ignore the top bit, on the assumption it is
11020 Otherwise, Emacs will accept and pass through 8-bit input without
11021 specially interpreting the top bit.
11023 This setting only has an effect on tty terminal devices.
11025 Optional parameter TERMINAL specifies the tty terminal device to use.
11026 It may be a terminal object, a frame, or nil for the terminal used by
11027 the currently selected frame.
11029 See also `current-input-mode'. */)
11030 (Lisp_Object meta
, Lisp_Object terminal
)
11032 struct terminal
*t
= get_terminal (terminal
, 1);
11033 struct tty_display_info
*tty
;
11036 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11038 tty
= t
->display_info
.tty
;
11042 else if (EQ (meta
, Qt
))
11047 if (tty
->meta_key
!= new_meta
)
11050 /* this causes startup screen to be restored and messes with the mouse */
11051 reset_sys_modes (tty
);
11054 tty
->meta_key
= new_meta
;
11057 init_sys_modes (tty
);
11063 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11064 doc
: /* Specify character used for quitting.
11065 QUIT must be an ASCII character.
11067 This function only has an effect on the controlling tty of the Emacs
11070 See also `current-input-mode'. */)
11073 struct terminal
*t
= get_named_tty ("/dev/tty");
11074 struct tty_display_info
*tty
;
11075 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11077 tty
= t
->display_info
.tty
;
11079 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11080 error ("QUIT must be an ASCII character");
11083 /* this causes startup screen to be restored and messes with the mouse */
11084 reset_sys_modes (tty
);
11087 /* Don't let this value be out of range. */
11088 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11091 init_sys_modes (tty
);
11097 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11098 doc
: /* Set mode of reading keyboard input.
11099 First arg INTERRUPT non-nil means use input interrupts;
11100 nil means use CBREAK mode.
11101 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11102 (no effect except in CBREAK mode).
11103 Third arg META t means accept 8-bit input (for a Meta key).
11104 META nil means ignore the top bit, on the assumption it is parity.
11105 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11106 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11107 See also `current-input-mode'. */)
11108 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11110 Fset_input_interrupt_mode (interrupt
);
11111 Fset_output_flow_control (flow
, Qnil
);
11112 Fset_input_meta_mode (meta
, Qnil
);
11114 Fset_quit_char (quit
);
11118 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11119 doc
: /* Return information about the way Emacs currently reads keyboard input.
11120 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11121 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11122 nil, Emacs is using CBREAK mode.
11123 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11124 terminal; this does not apply if Emacs uses interrupt-driven input.
11125 META is t if accepting 8-bit input with 8th bit as Meta flag.
11126 META nil means ignoring the top bit, on the assumption it is parity.
11127 META is neither t nor nil if accepting 8-bit input and using
11128 all 8 bits as the character code.
11129 QUIT is the character Emacs currently uses to quit.
11130 The elements of this list correspond to the arguments of
11131 `set-input-mode'. */)
11134 Lisp_Object val
[4];
11135 struct frame
*sf
= XFRAME (selected_frame
);
11137 val
[0] = interrupt_input
? Qt
: Qnil
;
11138 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11140 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11141 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11143 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11150 XSETFASTINT (val
[3], quit_char
);
11152 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11155 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11156 doc
: /* Return position information for pixel coordinates X and Y.
11157 By default, X and Y are relative to text area of the selected window.
11158 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11159 If optional fourth arg WHOLE is non-nil, X is relative to the left
11160 edge of the window.
11162 The return value is similar to a mouse click position:
11163 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11164 IMAGE (DX . DY) (WIDTH . HEIGHT))
11165 The `posn-' functions access elements of such lists. */)
11166 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11171 if (NILP (frame_or_window
))
11172 frame_or_window
= selected_window
;
11174 if (WINDOWP (frame_or_window
))
11178 CHECK_LIVE_WINDOW (frame_or_window
);
11180 w
= XWINDOW (frame_or_window
);
11181 XSETINT (x
, (XINT (x
)
11182 + WINDOW_LEFT_EDGE_X (w
)
11184 ? window_box_left_offset (w
, TEXT_AREA
)
11186 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11187 frame_or_window
= w
->frame
;
11190 CHECK_LIVE_FRAME (frame_or_window
);
11192 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11195 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11196 doc
: /* Return position information for buffer POS in WINDOW.
11197 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11199 Return nil if position is not visible in window. Otherwise,
11200 the return value is similar to that returned by `event-start' for
11201 a mouse click at the upper left corner of the glyph corresponding
11202 to the given buffer position:
11203 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11204 IMAGE (DX . DY) (WIDTH . HEIGHT))
11205 The `posn-' functions access elements of such lists. */)
11206 (Lisp_Object pos
, Lisp_Object window
)
11211 window
= selected_window
;
11213 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11216 Lisp_Object x
= XCAR (tem
);
11217 Lisp_Object y
= XCAR (XCDR (tem
));
11219 /* Point invisible due to hscrolling? */
11222 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11230 * Set up a new kboard object with reasonable initial values.
11233 init_kboard (KBOARD
*kb
)
11235 kb
->Voverriding_terminal_local_map
= Qnil
;
11236 kb
->Vlast_command
= Qnil
;
11237 kb
->Vreal_last_command
= Qnil
;
11238 kb
->Vkeyboard_translate_table
= Qnil
;
11239 kb
->Vlast_repeatable_command
= Qnil
;
11240 kb
->Vprefix_arg
= Qnil
;
11241 kb
->Vlast_prefix_arg
= Qnil
;
11242 kb
->kbd_queue
= Qnil
;
11243 kb
->kbd_queue_has_data
= 0;
11244 kb
->immediate_echo
= 0;
11245 kb
->echo_string
= Qnil
;
11246 kb
->echo_after_prompt
= -1;
11247 kb
->kbd_macro_buffer
= 0;
11248 kb
->kbd_macro_bufsize
= 0;
11249 kb
->defining_kbd_macro
= Qnil
;
11250 kb
->Vlast_kbd_macro
= Qnil
;
11251 kb
->reference_count
= 0;
11252 kb
->Vsystem_key_alist
= Qnil
;
11253 kb
->system_key_syms
= Qnil
;
11254 kb
->Vwindow_system
= Qt
; /* Unset. */
11255 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11256 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11257 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11258 kb
->Vdefault_minibuffer_frame
= Qnil
;
11262 * Destroy the contents of a kboard object, but not the object itself.
11263 * We use this just before deleting it, or if we're going to initialize
11264 * it a second time.
11267 wipe_kboard (KBOARD
*kb
)
11269 xfree (kb
->kbd_macro_buffer
);
11272 /* Free KB and memory referenced from it. */
11275 delete_kboard (KBOARD
*kb
)
11279 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11282 *kbp
= kb
->next_kboard
;
11284 /* Prevent a dangling reference to KB. */
11285 if (kb
== current_kboard
11286 && FRAMEP (selected_frame
)
11287 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11289 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11291 if (current_kboard
== kb
)
11300 init_keyboard (void)
11302 /* This is correct before outermost invocation of the editor loop */
11303 command_loop_level
= -1;
11304 immediate_quit
= 0;
11305 quit_char
= Ctl ('g');
11306 Vunread_command_events
= Qnil
;
11307 unread_command_char
= -1;
11308 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11310 recent_keys_index
= 0;
11311 kbd_fetch_ptr
= kbd_buffer
;
11312 kbd_store_ptr
= kbd_buffer
;
11313 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11314 do_mouse_tracking
= Qnil
;
11317 interrupt_input_blocked
= 0;
11318 interrupt_input_pending
= 0;
11320 pending_signals
= 0;
11323 /* This means that command_loop_1 won't try to select anything the first
11325 internal_last_event_frame
= Qnil
;
11326 Vlast_event_frame
= internal_last_event_frame
;
11328 current_kboard
= initial_kboard
;
11329 /* Re-initialize the keyboard again. */
11330 wipe_kboard (current_kboard
);
11331 init_kboard (current_kboard
);
11332 /* A value of nil for Vwindow_system normally means a tty, but we also use
11333 it for the initial terminal since there is no window system there. */
11334 current_kboard
->Vwindow_system
= Qnil
;
11336 if (!noninteractive
)
11338 /* Before multi-tty support, these handlers used to be installed
11339 only if the current session was a tty session. Now an Emacs
11340 session may have multiple display types, so we always handle
11341 SIGINT. There is special code in interrupt_signal to exit
11342 Emacs on SIGINT when there are no termcap frames on the
11343 controlling terminal. */
11344 signal (SIGINT
, interrupt_signal
);
11346 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11347 SIGQUIT and we can't tell which one it will give us. */
11348 signal (SIGQUIT
, interrupt_signal
);
11349 #endif /* not DOS_NT */
11351 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11353 if (!noninteractive
)
11354 signal (SIGIO
, input_available_signal
);
11357 /* Use interrupt input by default, if it works and noninterrupt input
11358 has deficiencies. */
11360 #ifdef INTERRUPT_INPUT
11361 interrupt_input
= 1;
11363 interrupt_input
= 0;
11369 if (keyboard_init_hook
)
11370 (*keyboard_init_hook
) ();
11372 #ifdef POLL_FOR_INPUT
11374 poll_suppress_count
= 1;
11379 /* This type's only use is in syms_of_keyboard, to initialize the
11380 event header symbols and put properties on them. */
11381 struct event_head
{
11387 static const struct event_head head_table
[] = {
11388 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11389 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11390 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11391 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11392 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11393 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11394 /* `select-window' should be handled just like `switch-frame'
11395 in read_key_sequence. */
11396 {&Qselect_window
, "select-window", &Qswitch_frame
}
11400 syms_of_keyboard (void)
11402 pending_funcalls
= Qnil
;
11403 staticpro (&pending_funcalls
);
11405 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11406 staticpro (&Vlispy_mouse_stem
);
11409 QCimage
= intern_c_string (":image");
11410 staticpro (&QCimage
);
11412 staticpro (&Qhelp_echo
);
11413 Qhelp_echo
= intern_c_string ("help-echo");
11416 Qrtl
= intern_c_string (":rtl");
11418 staticpro (&item_properties
);
11419 item_properties
= Qnil
;
11421 staticpro (&tool_bar_item_properties
);
11422 tool_bar_item_properties
= Qnil
;
11423 staticpro (&tool_bar_items_vector
);
11424 tool_bar_items_vector
= Qnil
;
11426 staticpro (&real_this_command
);
11427 real_this_command
= Qnil
;
11429 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11430 staticpro (&Qtimer_event_handler
);
11432 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11433 staticpro (&Qdisabled_command_function
);
11435 Qself_insert_command
= intern_c_string ("self-insert-command");
11436 staticpro (&Qself_insert_command
);
11438 Qforward_char
= intern_c_string ("forward-char");
11439 staticpro (&Qforward_char
);
11441 Qbackward_char
= intern_c_string ("backward-char");
11442 staticpro (&Qbackward_char
);
11444 Qdisabled
= intern_c_string ("disabled");
11445 staticpro (&Qdisabled
);
11447 Qundefined
= intern_c_string ("undefined");
11448 staticpro (&Qundefined
);
11450 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11451 staticpro (&Qpre_command_hook
);
11453 Qpost_command_hook
= intern_c_string ("post-command-hook");
11454 staticpro (&Qpost_command_hook
);
11456 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11457 staticpro (&Qdeferred_action_function
);
11459 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11460 staticpro (&Qcommand_hook_internal
);
11462 Qfunction_key
= intern_c_string ("function-key");
11463 staticpro (&Qfunction_key
);
11464 Qmouse_click
= intern_c_string ("mouse-click");
11465 staticpro (&Qmouse_click
);
11466 #if defined (WINDOWSNT)
11467 Qlanguage_change
= intern_c_string ("language-change");
11468 staticpro (&Qlanguage_change
);
11470 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11471 staticpro (&Qdrag_n_drop
);
11473 Qsave_session
= intern_c_string ("save-session");
11474 staticpro (&Qsave_session
);
11477 Qdbus_event
= intern_c_string ("dbus-event");
11478 staticpro (&Qdbus_event
);
11481 Qxwidget_event
= intern ("xwidget-event");
11482 staticpro (&Qxwidget_event
);
11485 Qmenu_enable
= intern ("menu-enable");
11486 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11487 staticpro (&Qconfig_changed_event
);
11489 Qmenu_enable
= intern_c_string ("menu-enable");
11490 staticpro (&Qmenu_enable
);
11491 QCenable
= intern_c_string (":enable");
11492 staticpro (&QCenable
);
11493 QCvisible
= intern_c_string (":visible");
11494 staticpro (&QCvisible
);
11495 QChelp
= intern_c_string (":help");
11496 staticpro (&QChelp
);
11497 QCfilter
= intern_c_string (":filter");
11498 staticpro (&QCfilter
);
11499 QCbutton
= intern_c_string (":button");
11500 staticpro (&QCbutton
);
11501 QCkeys
= intern_c_string (":keys");
11502 staticpro (&QCkeys
);
11503 QCkey_sequence
= intern_c_string (":key-sequence");
11504 staticpro (&QCkey_sequence
);
11505 QCtoggle
= intern_c_string (":toggle");
11506 staticpro (&QCtoggle
);
11507 QCradio
= intern_c_string (":radio");
11508 staticpro (&QCradio
);
11509 QClabel
= intern_c_string (":label");
11510 staticpro (&QClabel
);
11511 QCvert_only
= intern_c_string (":vert-only");
11512 staticpro (&QCvert_only
);
11514 Qmode_line
= intern_c_string ("mode-line");
11515 staticpro (&Qmode_line
);
11516 Qvertical_line
= intern_c_string ("vertical-line");
11517 staticpro (&Qvertical_line
);
11518 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11519 staticpro (&Qvertical_scroll_bar
);
11520 Qmenu_bar
= intern_c_string ("menu-bar");
11521 staticpro (&Qmenu_bar
);
11523 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11524 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11525 staticpro (&Qmouse_fixup_help_message
);
11528 Qabove_handle
= intern_c_string ("above-handle");
11529 staticpro (&Qabove_handle
);
11530 Qhandle
= intern_c_string ("handle");
11531 staticpro (&Qhandle
);
11532 Qbelow_handle
= intern_c_string ("below-handle");
11533 staticpro (&Qbelow_handle
);
11534 Qup
= intern_c_string ("up");
11536 Qdown
= intern_c_string ("down");
11537 staticpro (&Qdown
);
11538 Qtop
= intern_c_string ("top");
11540 Qbottom
= intern_c_string ("bottom");
11541 staticpro (&Qbottom
);
11542 Qend_scroll
= intern_c_string ("end-scroll");
11543 staticpro (&Qend_scroll
);
11544 Qratio
= intern_c_string ("ratio");
11545 staticpro (&Qratio
);
11547 Qevent_kind
= intern_c_string ("event-kind");
11548 staticpro (&Qevent_kind
);
11549 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11550 staticpro (&Qevent_symbol_elements
);
11551 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11552 staticpro (&Qevent_symbol_element_mask
);
11553 Qmodifier_cache
= intern_c_string ("modifier-cache");
11554 staticpro (&Qmodifier_cache
);
11556 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11557 staticpro (&Qrecompute_lucid_menubar
);
11558 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11559 staticpro (&Qactivate_menubar_hook
);
11561 Qpolling_period
= intern_c_string ("polling-period");
11562 staticpro (&Qpolling_period
);
11564 Qinput_method_function
= intern_c_string ("input-method-function");
11565 staticpro (&Qinput_method_function
);
11567 Qx_set_selection
= intern_c_string ("x-set-selection");
11568 staticpro (&Qx_set_selection
);
11569 QPRIMARY
= intern_c_string ("PRIMARY");
11570 staticpro (&QPRIMARY
);
11571 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11572 staticpro (&Qhandle_switch_frame
);
11574 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11575 staticpro (&Qinput_method_exit_on_first_char
);
11576 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11577 staticpro (&Qinput_method_use_echo_area
);
11579 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11580 Fset (Qinput_method_use_echo_area
, Qnil
);
11582 last_point_position_buffer
= Qnil
;
11583 last_point_position_window
= Qnil
;
11586 const struct event_head
*p
;
11588 for (p
= head_table
;
11589 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11592 *p
->var
= intern_c_string (p
->name
);
11593 staticpro (p
->var
);
11594 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11595 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11599 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11600 staticpro (&button_down_location
);
11601 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11602 staticpro (&mouse_syms
);
11603 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11604 / sizeof (lispy_wheel_names
[0])),
11606 staticpro (&wheel_syms
);
11610 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11612 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11613 for (i
= 0; i
< len
; i
++)
11614 if (modifier_names
[i
])
11615 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11616 staticpro (&modifier_symbols
);
11619 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11620 staticpro (&recent_keys
);
11622 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11623 staticpro (&this_command_keys
);
11625 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11626 staticpro (&raw_keybuf
);
11628 Qextended_command_history
= intern_c_string ("extended-command-history");
11629 Fset (Qextended_command_history
, Qnil
);
11630 staticpro (&Qextended_command_history
);
11632 accent_key_syms
= Qnil
;
11633 staticpro (&accent_key_syms
);
11635 func_key_syms
= Qnil
;
11636 staticpro (&func_key_syms
);
11638 drag_n_drop_syms
= Qnil
;
11639 staticpro (&drag_n_drop_syms
);
11641 unread_switch_frame
= Qnil
;
11642 staticpro (&unread_switch_frame
);
11644 internal_last_event_frame
= Qnil
;
11645 staticpro (&internal_last_event_frame
);
11647 read_key_sequence_cmd
= Qnil
;
11648 staticpro (&read_key_sequence_cmd
);
11650 menu_bar_one_keymap_changed_items
= Qnil
;
11651 staticpro (&menu_bar_one_keymap_changed_items
);
11653 menu_bar_items_vector
= Qnil
;
11654 staticpro (&menu_bar_items_vector
);
11656 help_form_saved_window_configs
= Qnil
;
11657 staticpro (&help_form_saved_window_configs
);
11659 defsubr (&Scurrent_idle_time
);
11660 defsubr (&Sevent_symbol_parse_modifiers
);
11661 defsubr (&Sevent_convert_list
);
11662 defsubr (&Sread_key_sequence
);
11663 defsubr (&Sread_key_sequence_vector
);
11664 defsubr (&Srecursive_edit
);
11665 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11666 defsubr (&Strack_mouse
);
11668 defsubr (&Sinput_pending_p
);
11669 defsubr (&Scommand_execute
);
11670 defsubr (&Srecent_keys
);
11671 defsubr (&Sthis_command_keys
);
11672 defsubr (&Sthis_command_keys_vector
);
11673 defsubr (&Sthis_single_command_keys
);
11674 defsubr (&Sthis_single_command_raw_keys
);
11675 defsubr (&Sreset_this_command_lengths
);
11676 defsubr (&Sclear_this_command_keys
);
11677 defsubr (&Ssuspend_emacs
);
11678 defsubr (&Sabort_recursive_edit
);
11679 defsubr (&Sexit_recursive_edit
);
11680 defsubr (&Srecursion_depth
);
11681 defsubr (&Stop_level
);
11682 defsubr (&Sdiscard_input
);
11683 defsubr (&Sopen_dribble_file
);
11684 defsubr (&Sset_input_interrupt_mode
);
11685 defsubr (&Sset_output_flow_control
);
11686 defsubr (&Sset_input_meta_mode
);
11687 defsubr (&Sset_quit_char
);
11688 defsubr (&Sset_input_mode
);
11689 defsubr (&Scurrent_input_mode
);
11690 defsubr (&Sexecute_extended_command
);
11691 defsubr (&Sposn_at_point
);
11692 defsubr (&Sposn_at_x_y
);
11694 DEFVAR_LISP ("last-command-event", last_command_event
,
11695 doc
: /* Last input event that was part of a command. */);
11697 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11698 doc
: /* Last input event in a command, except for mouse menu events.
11699 Mouse menus give back keys that don't look like mouse events;
11700 this variable holds the actual mouse event that led to the menu,
11701 so that you can determine whether the command was run by mouse or not. */);
11703 DEFVAR_LISP ("last-input-event", last_input_event
,
11704 doc
: /* Last input event. */);
11706 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11707 doc
: /* List of events to be read as the command input.
11708 These events are processed first, before actual keyboard input.
11709 Events read from this list are not normally added to `this-command-keys',
11710 as they will already have been added once as they were read for the first time.
11711 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11712 Vunread_command_events
= Qnil
;
11714 DEFVAR_INT ("unread-command-char", unread_command_char
,
11715 doc
: /* If not -1, an object to be read as next command input event. */);
11717 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11718 doc
: /* List of events to be processed as input by input methods.
11719 These events are processed before `unread-command-events'
11720 and actual keyboard input, but are not given to `input-method-function'. */);
11721 Vunread_post_input_method_events
= Qnil
;
11723 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11724 doc
: /* List of events to be processed as input by input methods.
11725 These events are processed after `unread-command-events', but
11726 before actual keyboard input.
11727 If there's an active input method, the events are given to
11728 `input-method-function'. */);
11729 Vunread_input_method_events
= Qnil
;
11731 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11732 doc
: /* Meta-prefix character code.
11733 Meta-foo as command input turns into this character followed by foo. */);
11734 XSETINT (meta_prefix_char
, 033);
11736 DEFVAR_KBOARD ("last-command", Vlast_command
,
11737 doc
: /* The last command executed.
11738 Normally a symbol with a function definition, but can be whatever was found
11739 in the keymap, or whatever the variable `this-command' was set to by that
11742 The value `mode-exit' is special; it means that the previous command
11743 read an event that told it to exit, and it did so and unread that event.
11744 In other words, the present command is the event that made the previous
11747 The value `kill-region' is special; it means that the previous command
11748 was a kill command.
11750 `last-command' has a separate binding for each terminal device.
11751 See Info node `(elisp)Multiple Terminals'. */);
11753 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11754 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11756 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11757 doc
: /* Last command that may be repeated.
11758 The last command executed that was not bound to an input event.
11759 This is the command `repeat' will try to repeat. */);
11761 DEFVAR_LISP ("this-command", Vthis_command
,
11762 doc
: /* The command now being executed.
11763 The command can set this variable; whatever is put here
11764 will be in `last-command' during the following command. */);
11765 Vthis_command
= Qnil
;
11767 DEFVAR_LISP ("this-command-keys-shift-translated",
11768 Vthis_command_keys_shift_translated
,
11769 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11770 Shift-translation occurs when there is no binding for the key sequence
11771 as entered, but a binding was found by changing an upper-case letter
11772 to lower-case, or a shifted function key to an unshifted one. */);
11773 Vthis_command_keys_shift_translated
= Qnil
;
11775 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11776 doc
: /* The command bound to the current key sequence before remapping.
11777 It equals `this-command' if the original command was not remapped through
11778 any of the active keymaps. Otherwise, the value of `this-command' is the
11779 result of looking up the original command in the active keymaps. */);
11780 Vthis_original_command
= Qnil
;
11782 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11783 doc
: /* *Number of input events between auto-saves.
11784 Zero means disable autosaving due to number of characters typed. */);
11785 auto_save_interval
= 300;
11787 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11788 doc
: /* *Number of seconds idle time before auto-save.
11789 Zero or nil means disable auto-saving due to idleness.
11790 After auto-saving due to this many seconds of idle time,
11791 Emacs also does a garbage collection if that seems to be warranted. */);
11792 XSETFASTINT (Vauto_save_timeout
, 30);
11794 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11795 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11796 The value may be integer or floating point. */);
11797 Vecho_keystrokes
= make_number (1);
11799 DEFVAR_INT ("polling-period", polling_period
,
11800 doc
: /* *Interval between polling for input during Lisp execution.
11801 The reason for polling is to make C-g work to stop a running program.
11802 Polling is needed only when using X windows and SIGIO does not work.
11803 Polling is automatically disabled in all other cases. */);
11804 polling_period
= 2;
11806 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11807 doc
: /* *Maximum time between mouse clicks to make a double-click.
11808 Measured in milliseconds. The value nil means disable double-click
11809 recognition; t means double-clicks have no time limit and are detected
11810 by position only. */);
11811 Vdouble_click_time
= make_number (500);
11813 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11814 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11815 On window-system frames, value is the number of pixels the mouse may have
11816 moved horizontally or vertically between two clicks to make a double-click.
11817 On non window-system frames, value is interpreted in units of 1/8 characters
11820 This variable is also the threshold for motion of the mouse
11821 to count as a drag. */);
11822 double_click_fuzz
= 3;
11824 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11825 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11826 inhibit_local_menu_bar_menus
= 0;
11828 DEFVAR_INT ("num-input-keys", num_input_keys
,
11829 doc
: /* Number of complete key sequences read as input so far.
11830 This includes key sequences read from keyboard macros.
11831 The number is effectively the number of interactive command invocations. */);
11832 num_input_keys
= 0;
11834 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11835 doc
: /* Number of input events read from the keyboard so far.
11836 This does not include events generated by keyboard macros. */);
11837 num_nonmacro_input_events
= 0;
11839 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11840 doc
: /* The frame in which the most recently read event occurred.
11841 If the last event came from a keyboard macro, this is set to `macro'. */);
11842 Vlast_event_frame
= Qnil
;
11844 /* This variable is set up in sysdep.c. */
11845 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11846 doc
: /* The ERASE character as set by the user with stty. */);
11848 DEFVAR_LISP ("help-char", Vhelp_char
,
11849 doc
: /* Character to recognize as meaning Help.
11850 When it is read, do `(eval help-form)', and display result if it's a string.
11851 If the value of `help-form' is nil, this char can be read normally. */);
11852 XSETINT (Vhelp_char
, Ctl ('H'));
11854 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11855 doc
: /* List of input events to recognize as meaning Help.
11856 These work just like the value of `help-char' (see that). */);
11857 Vhelp_event_list
= Qnil
;
11859 DEFVAR_LISP ("help-form", Vhelp_form
,
11860 doc
: /* Form to execute when character `help-char' is read.
11861 If the form returns a string, that string is displayed.
11862 If `help-form' is nil, the help char is not recognized. */);
11865 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11866 doc
: /* Command to run when `help-char' character follows a prefix key.
11867 This command is used only when there is no actual binding
11868 for that character after that prefix key. */);
11869 Vprefix_help_command
= Qnil
;
11871 DEFVAR_LISP ("top-level", Vtop_level
,
11872 doc
: /* Form to evaluate when Emacs starts up.
11873 Useful to set before you dump a modified Emacs. */);
11876 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11877 doc
: /* Translate table for local keyboard input, or nil.
11878 If non-nil, the value should be a char-table. Each character read
11879 from the keyboard is looked up in this char-table. If the value found
11880 there is non-nil, then it is used instead of the actual input character.
11882 The value can also be a string or vector, but this is considered obsolete.
11883 If it is a string or vector of length N, character codes N and up are left
11884 untranslated. In a vector, an element which is nil means "no translation".
11886 This is applied to the characters supplied to input methods, not their
11887 output. See also `translation-table-for-input'.
11889 This variable has a separate binding for each terminal.
11890 See Info node `(elisp)Multiple Terminals'. */);
11892 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11893 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11894 \(Even if the operating system has support for stopping a process.\) */);
11895 cannot_suspend
= 0;
11897 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11898 doc
: /* Non-nil means prompt with menus when appropriate.
11899 This is done when reading from a keymap that has a prompt string,
11900 for elements that have prompt strings.
11901 The menu is displayed on the screen
11902 if X menus were enabled at configuration
11903 time and the previous event was a mouse click prefix key.
11904 Otherwise, menu prompting uses the echo area. */);
11905 menu_prompting
= 1;
11907 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11908 doc
: /* Character to see next line of menu prompt.
11909 Type this character while in a menu prompt to rotate around the lines of it. */);
11910 XSETINT (menu_prompt_more_char
, ' ');
11912 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11913 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11914 Emacs applies the modifiers of the character stored here to each keyboard
11915 character it reads. For example, after evaluating the expression
11916 (setq extra-keyboard-modifiers ?\\C-x)
11917 all input characters will have the control modifier applied to them.
11919 Note that the character ?\\C-@, equivalent to the integer zero, does
11920 not count as a control character; rather, it counts as a character
11921 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11922 cancels any modification. */);
11923 extra_keyboard_modifiers
= 0;
11925 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11926 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11927 The command loop sets this to nil before each command,
11928 and tests the value when the command returns.
11929 Buffer modification stores t in this variable. */);
11930 Vdeactivate_mark
= Qnil
;
11931 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
11932 staticpro (&Qdeactivate_mark
);
11934 DEFVAR_LISP ("command-hook-internal", Vcommand_hook_internal
,
11935 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
11936 Vcommand_hook_internal
= Qnil
;
11938 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11939 doc
: /* Normal hook run before each command is executed.
11940 If an unhandled error happens in running this hook,
11941 the hook value is set to nil, since otherwise the error
11942 might happen repeatedly and make Emacs nonfunctional. */);
11943 Vpre_command_hook
= Qnil
;
11945 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11946 doc
: /* Normal hook run after each command is executed.
11947 If an unhandled error happens in running this hook,
11948 the hook value is set to nil, since otherwise the error
11949 might happen repeatedly and make Emacs nonfunctional. */);
11950 Vpost_command_hook
= Qnil
;
11953 DEFVAR_LISP ("echo-area-clear-hook", ...,
11954 doc
: /* Normal hook run when clearing the echo area. */);
11956 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
11957 staticpro (&Qecho_area_clear_hook
);
11958 Fset (Qecho_area_clear_hook
, Qnil
);
11960 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11961 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11962 Vlucid_menu_bar_dirty_flag
= Qnil
;
11964 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11965 doc
: /* List of menu bar items to move to the end of the menu bar.
11966 The elements of the list are event types that may have menu bar bindings. */);
11967 Vmenu_bar_final_items
= Qnil
;
11969 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11970 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11971 This is used internally by graphical displays that do not render
11972 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11973 Vtool_bar_separator_image_expression
= Qnil
;
11975 DEFVAR_KBOARD ("overriding-terminal-local-map",
11976 Voverriding_terminal_local_map
,
11977 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11978 If this variable is non-nil, it is used as a keymap instead of the
11979 buffer's local map, and the minor mode keymaps and text property keymaps.
11980 It also replaces `overriding-local-map'.
11982 This variable is intended to let commands such as `universal-argument'
11983 set up a different keymap for reading the next command.
11985 `overriding-terminal-local-map' has a separate binding for each
11987 See Info node `(elisp)Multiple Terminals'. */);
11989 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11990 doc
: /* Keymap that overrides all other local keymaps.
11991 If this variable is non-nil, it is used as a keymap--replacing the
11992 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11993 Voverriding_local_map
= Qnil
;
11995 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11996 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11997 Otherwise, the menu bar continues to reflect the buffer's local map
11998 and the minor mode maps regardless of `overriding-local-map'. */);
11999 Voverriding_local_map_menu_flag
= Qnil
;
12001 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
12002 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12003 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12005 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12006 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12008 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12009 doc
: /* Alist of system-specific X windows key symbols.
12010 Each element should have the form (N . SYMBOL) where N is the
12011 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12012 and SYMBOL is its name.
12014 `system-key-alist' has a separate binding for each terminal device.
12015 See Info node `(elisp)Multiple Terminals'. */);
12017 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12018 doc
: /* Keymap that translates key sequences to key sequences during input.
12019 This is used mainly for mapping key sequences into some preferred
12020 key events (symbols).
12022 The `read-key-sequence' function replaces any subsequence bound by
12023 `local-function-key-map' with its binding. More precisely, when the
12024 active keymaps have no binding for the current key sequence but
12025 `local-function-key-map' binds a suffix of the sequence to a vector or
12026 string, `read-key-sequence' replaces the matching suffix with its
12027 binding, and continues with the new sequence.
12029 If the binding is a function, it is called with one argument (the prompt)
12030 and its return value (a key sequence) is used.
12032 The events that come from bindings in `local-function-key-map' are not
12033 themselves looked up in `local-function-key-map'.
12035 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12036 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12037 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12038 typing `ESC O P x' would return [f1 x].
12040 `local-function-key-map' has a separate binding for each terminal
12041 device. See Info node `(elisp)Multiple Terminals'. If you need to
12042 define a binding on all terminals, change `function-key-map'
12043 instead. Initially, `local-function-key-map' is an empty keymap that
12044 has `function-key-map' as its parent on all terminal devices. */);
12046 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12047 doc
: /* Keymap that decodes input escape sequences.
12048 This is used mainly for mapping ASCII function key sequences into
12049 real Emacs function key events (symbols).
12051 The `read-key-sequence' function replaces any subsequence bound by
12052 `input-decode-map' with its binding. Contrary to `function-key-map',
12053 this map applies its rebinding regardless of the presence of an ordinary
12054 binding. So it is more like `key-translation-map' except that it applies
12055 before `function-key-map' rather than after.
12057 If the binding is a function, it is called with one argument (the prompt)
12058 and its return value (a key sequence) is used.
12060 The events that come from bindings in `input-decode-map' are not
12061 themselves looked up in `input-decode-map'.
12063 This variable is keyboard-local. */);
12065 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12066 doc
: /* The parent keymap of all `local-function-key-map' instances.
12067 Function key definitions that apply to all terminal devices should go
12068 here. If a mapping is defined in both the current
12069 `local-function-key-map' binding and this variable, then the local
12070 definition will take precendence. */);
12071 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12073 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12074 doc
: /* Keymap of key translations that can override keymaps.
12075 This keymap works like `function-key-map', but comes after that,
12076 and its non-prefix bindings override ordinary bindings.
12077 Another difference is that it is global rather than keyboard-local. */);
12078 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12080 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12081 doc
: /* List of deferred actions to be performed at a later time.
12082 The precise format isn't relevant here; we just check whether it is nil. */);
12083 Vdeferred_action_list
= Qnil
;
12085 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12086 doc
: /* Function to call to handle deferred actions, after each command.
12087 This function is called with no arguments after each command
12088 whenever `deferred-action-list' is non-nil. */);
12089 Vdeferred_action_function
= Qnil
;
12091 DEFVAR_LISP ("suggest-key-bindings", Vsuggest_key_bindings
,
12092 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12093 The value can be a length of time to show the message for.
12094 If the value is non-nil and not a number, we wait 2 seconds. */);
12095 Vsuggest_key_bindings
= Qt
;
12097 DEFVAR_LISP ("timer-list", Vtimer_list
,
12098 doc
: /* List of active absolute time timers in order of increasing time. */);
12099 Vtimer_list
= Qnil
;
12101 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12102 doc
: /* List of active idle-time timers in order of increasing time. */);
12103 Vtimer_idle_list
= Qnil
;
12105 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12106 doc
: /* If non-nil, the function that implements the current input method.
12107 It's called with one argument, a printing character that was just read.
12108 \(That means a character with code 040...0176.)
12109 Typically this function uses `read-event' to read additional events.
12110 When it does so, it should first bind `input-method-function' to nil
12111 so it will not be called recursively.
12113 The function should return a list of zero or more events
12114 to be used as input. If it wants to put back some events
12115 to be reconsidered, separately, by the input method,
12116 it can add them to the beginning of `unread-command-events'.
12118 The input method function can find in `input-method-previous-message'
12119 the previous echo area message.
12121 The input method function should refer to the variables
12122 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12123 for guidance on what to do. */);
12124 Vinput_method_function
= Qnil
;
12126 DEFVAR_LISP ("input-method-previous-message",
12127 Vinput_method_previous_message
,
12128 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12129 This variable exists because `read-event' clears the echo area
12130 before running the input method. It is nil if there was no message. */);
12131 Vinput_method_previous_message
= Qnil
;
12133 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12134 doc
: /* If non-nil, the function that implements the display of help.
12135 It's called with one argument, the help string to display. */);
12136 Vshow_help_function
= Qnil
;
12138 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12139 doc
: /* If non-nil, suppress point adjustment after executing a command.
12141 After a command is executed, if point is moved into a region that has
12142 special properties (e.g. composition, display), we adjust point to
12143 the boundary of the region. But, when a command sets this variable to
12144 non-nil, we suppress the point adjustment.
12146 This variable is set to nil before reading a command, and is checked
12147 just after executing the command. */);
12148 Vdisable_point_adjustment
= Qnil
;
12150 DEFVAR_LISP ("global-disable-point-adjustment",
12151 Vglobal_disable_point_adjustment
,
12152 doc
: /* *If non-nil, always suppress point adjustment.
12154 The default value is nil, in which case, point adjustment are
12155 suppressed only after special commands that set
12156 `disable-point-adjustment' (which see) to non-nil. */);
12157 Vglobal_disable_point_adjustment
= Qnil
;
12159 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12160 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12161 If the value is not a number, such messages don't time out. */);
12162 Vminibuffer_message_timeout
= make_number (2);
12164 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12165 doc
: /* If non-nil, any keyboard input throws to this symbol.
12166 The value of that variable is passed to `quit-flag' and later causes a
12167 peculiar kind of quitting. */);
12168 Vthrow_on_input
= Qnil
;
12170 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12171 doc
: /* If non-nil, function to output error messages.
12172 The arguments are the error data, a list of the form
12173 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12174 such as just as `condition-case' would bind its variable to,
12175 the context (a string which normally goes at the start of the message),
12176 and the Lisp function within which the error was signaled. */);
12177 Vcommand_error_function
= Qnil
;
12179 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12180 Venable_disabled_menus_and_buttons
,
12181 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12183 Help functions bind this to allow help on disabled menu items
12184 and tool-bar buttons. */);
12185 Venable_disabled_menus_and_buttons
= Qnil
;
12187 DEFVAR_LISP ("select-active-regions",
12188 Vselect_active_regions
,
12189 doc
: /* If non-nil, an active region automatically sets the primary selection.
12190 If the value is `only', only temporarily active regions (usually made
12191 by mouse-dragging or shift-selection) set the window selection.
12193 This takes effect only when Transient Mark mode is enabled. */);
12194 Vselect_active_regions
= Qt
;
12196 DEFVAR_LISP ("saved-region-selection",
12197 Vsaved_region_selection
,
12198 doc
: /* Contents of active region prior to buffer modification.
12199 If `select-active-regions' is non-nil, Emacs sets this to the
12200 text in the region before modifying the buffer. The next
12201 `deactivate-mark' call uses this to set the window selection. */);
12202 Vsaved_region_selection
= Qnil
;
12204 /* Create the initial keyboard. */
12205 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12206 init_kboard (initial_kboard
);
12207 /* Vwindow_system is left at t for now. */
12208 initial_kboard
->next_kboard
= all_kboards
;
12209 all_kboards
= initial_kboard
;
12213 keys_of_keyboard (void)
12215 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12216 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12217 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12218 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12219 initial_define_key (meta_map
, 'x', "execute-extended-command");
12221 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12222 "handle-delete-frame");
12223 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12224 "ns-put-working-text");
12225 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12226 "ns-unput-working-text");
12227 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12228 current-prefix-arg, as is done in `handle-switch-frame'.
12229 But `handle-switch-frame is not run from the special-map.
12230 Commands from that map are run in a special way that automatically
12231 preserves the prefix-arg. Restoring the prefix arg here is not just
12232 redundant but harmful:
12234 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12235 - after the first prompt, the exit-minibuffer-hook is run which may
12236 iconify a frame and thus push a `iconify-frame' event.
12237 - after running exit-minibuffer-hook, current-prefix-arg is
12238 restored to the non-nil value it had before the prompt.
12239 - we enter the second prompt.
12240 current-prefix-arg is non-nil, prefix-arg is nil.
12241 - before running the first real event, we run the special iconify-frame
12242 event, but we pass the `special' arg to execute-command so
12243 current-prefix-arg and prefix-arg are left untouched.
12244 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12245 - the next key event will have a spuriously non-nil current-prefix-arg. */
12246 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12248 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12250 /* Handling it at such a low-level causes read_key_sequence to get
12251 * confused because it doesn't realize that the current_buffer was
12252 * changed by read_char.
12254 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12255 * "handle-select-window"); */
12256 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12257 "handle-save-session");
12260 /* Define a special event which is raised for dbus callback
12262 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12263 "dbus-handle-event");
12266 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12270 /* Mark the pointers in the kboard objects.
12271 Called by the Fgarbage_collector. */
12273 mark_kboards (void)
12277 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12279 if (kb
->kbd_macro_buffer
)
12280 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12282 mark_object (kb
->Voverriding_terminal_local_map
);
12283 mark_object (kb
->Vlast_command
);
12284 mark_object (kb
->Vreal_last_command
);
12285 mark_object (kb
->Vkeyboard_translate_table
);
12286 mark_object (kb
->Vlast_repeatable_command
);
12287 mark_object (kb
->Vprefix_arg
);
12288 mark_object (kb
->Vlast_prefix_arg
);
12289 mark_object (kb
->kbd_queue
);
12290 mark_object (kb
->defining_kbd_macro
);
12291 mark_object (kb
->Vlast_kbd_macro
);
12292 mark_object (kb
->Vsystem_key_alist
);
12293 mark_object (kb
->system_key_syms
);
12294 mark_object (kb
->Vwindow_system
);
12295 mark_object (kb
->Vinput_decode_map
);
12296 mark_object (kb
->Vlocal_function_key_map
);
12297 mark_object (kb
->Vdefault_minibuffer_frame
);
12298 mark_object (kb
->echo_string
);
12301 struct input_event
*event
;
12302 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12304 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12305 event
= kbd_buffer
;
12306 if (event
->kind
!= SELECTION_REQUEST_EVENT
12307 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12309 mark_object (event
->x
);
12310 mark_object (event
->y
);
12312 mark_object (event
->frame_or_window
);
12313 mark_object (event
->arg
);