keyboard.c 336 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2
   Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99,2000,01,02,03
3
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
#include <config.h>
23
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
24
#include <stdio.h>
25
#include "lisp.h"
26
#include "systty.h" /* This must be included befor termchar.h. */
Jim Blandy's avatar
Jim Blandy committed
27 28 29 30
#include "termchar.h"
#include "termopts.h"
#include "termhooks.h"
#include "macros.h"
31
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
32
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
33 34 35
#include "window.h"
#include "commands.h"
#include "buffer.h"
36
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
37
#include "disptab.h"
38
#include "dispextern.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
39
#include "syntax.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
40
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
41
#include "keymap.h"
42
#include "blockinput.h"
43
#include "puresize.h"
44 45
#include "systime.h"
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
46 47 48
#include <setjmp.h>
#include <errno.h>

49 50 51 52
#ifdef MSDOS
#include "msdos.h"
#include <time.h>
#else /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
53 54 55
#ifndef VMS
#include <sys/ioctl.h>
#endif
56
#endif /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
57

Jim Blandy's avatar
Jim Blandy committed
58 59
#include "syssignal.h"

60 61 62 63 64
#include <sys/types.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

65 66 67 68 69
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

70 71 72 73
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

74
#ifdef MAC_OS
75 76 77
#include "macterm.h"
#endif

78
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
79
extern int errno;
80
#endif
Jim Blandy's avatar
Jim Blandy committed
81

82 83 84
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
85
int interrupt_input_blocked;
86 87 88

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
89
int interrupt_input_pending;
90 91


92
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
93
/* Make all keyboard buffers much bigger when using X windows.  */
94 95
#ifdef MAC_OS8
/* But not too big (local data > 32K error) if on Mac OS Classic.  */
96 97
#define KBD_BUFFER_SIZE 512
#else
Jim Blandy's avatar
Jim Blandy committed
98
#define KBD_BUFFER_SIZE 4096
99
#endif
Jim Blandy's avatar
Jim Blandy committed
100
#else	/* No X-windows, character input */
101
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
102 103
#endif	/* No X-windows */

Gerd Moellmann's avatar
Gerd Moellmann committed
104 105
#define abs(x)		((x) >= 0 ? (x) : -(x))

Jim Blandy's avatar
Jim Blandy committed
106 107 108 109 110 111 112 113 114 115 116 117 118
/* Following definition copied from eval.c */

struct backtrace
  {
    struct backtrace *next;
    Lisp_Object *function;
    Lisp_Object *args;	/* Points to vector of args. */
    int nargs;		/* length of vector.  If nargs is UNEVALLED,
			   args points to slot holding list of
			   unevalled args */
    char evalargs;
  };

119 120 121 122
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
123
int single_kboard;
124
#else
125
KBOARD the_only_kboard;
126
#endif
127

Jim Blandy's avatar
Jim Blandy committed
128 129
/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
130
Lisp_Object Qdisabled, Qdisabled_command_hook;
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134

#define NUM_RECENT_KEYS (100)
int recent_keys_index;	/* Index for storing next element into recent_keys */
int total_keys;		/* Total number of elements stored into recent_keys */
135
Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
Jim Blandy's avatar
Jim Blandy committed
136

137 138 139 140 141 142 143
/* Vector holding the key sequence that invoked the current command.
   It is reused for each command, and it may be longer than the current
   sequence; this_command_key_count indicates how many elements
   actually mean something.
   It's easier to staticpro a single Lisp_Object than an array.  */
Lisp_Object this_command_keys;
int this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
144

145 146 147 148
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
int this_command_key_count_reset;

149 150 151 152 153 154
/* This vector is used as a buffer to record the events that were actually read
   by read_key_sequence.  */
Lisp_Object raw_keybuf;
int raw_keybuf_count;

#define GROW_RAW_KEYBUF							\
155
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
156 157 158 159 160 161 162 163 164
  {									\
    int newsize = 2 * XVECTOR (raw_keybuf)->size;			\
    Lisp_Object new;							\
    new = Fmake_vector (make_number (newsize), Qnil);			\
    bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents,	\
	   raw_keybuf_count * sizeof (Lisp_Object));			\
    raw_keybuf = new;							\
  }

165 166 167 168
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

169 170 171 172 173
/* Record values of this_command_key_count and echo_length ()
   before this command was read.  */
static int before_command_key_count;
static int before_command_echo_length;

Jim Blandy's avatar
Jim Blandy committed
174 175
extern int minbuf_level;

176 177
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
178 179
extern struct backtrace *backtrace_list;

180 181 182 183 184
/* If non-nil, the function that implements the display of help.
   It's called with one argument, the help string to display.  */

Lisp_Object Vshow_help_function;

185 186 187 188 189
/* If a string, the message displayed before displaying a help-echo
   in the echo area.  */

Lisp_Object Vpre_help_message;

Jim Blandy's avatar
Jim Blandy committed
190
/* Nonzero means do menu prompting.  */
191

Jim Blandy's avatar
Jim Blandy committed
192 193 194
static int menu_prompting;

/* Character to see next line of menu prompt.  */
195

Jim Blandy's avatar
Jim Blandy committed
196 197 198
static Lisp_Object menu_prompt_more_char;

/* For longjmp to where kbd input is being done.  */
199

Jim Blandy's avatar
Jim Blandy committed
200 201 202 203 204 205
static jmp_buf getcjmp;

/* True while doing kbd input.  */
int waiting_for_input;

/* True while displaying for echoing.   Delays C-g throwing.  */
206

207
int echoing;
Jim Blandy's avatar
Jim Blandy committed
208

209 210 211 212 213
/* Non-null means we can start echoing at the next input pause even
   though there is something in the echo area.  */

static struct kboard *ok_to_echo_at_next_pause;

214 215 216 217
/* The kboard last echoing, or null for none.  Reset to 0 in
   cancel_echoing.  If non-null, and a current echo area message
   exists, and echo_message_buffer is eq to the current message
   buffer, we know that the message comes from echo_kboard.  */
218

219
struct kboard *echo_kboard;
220

221 222 223
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

224
Lisp_Object echo_message_buffer;
225

226 227 228
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

229
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
230 231
int immediate_quit;

232 233 234
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
235
/* Character to recognize as the help char.  */
236
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
237

Karl Heuer's avatar
Karl Heuer committed
238 239 240
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
241 242 243
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

244 245 246
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

247 248
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
249

250 251 252 253 254 255
/* Non-nil means show the equivalent key-binding for
   any M-x command that has one.
   The value can be a length of time to show the message for.
   If the value is non-nil and not a number, we wait 2 seconds.  */
Lisp_Object Vsuggest_key_bindings;

256 257 258 259
/* How long to display an echo-area message when the minibuffer is active.
   If the value is not a number, such messages don't time out.  */
Lisp_Object Vminibuffer_message_timeout;

Jim Blandy's avatar
Jim Blandy committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
/* Character that causes a quit.  Normally C-g.

   If we are running on an ordinary terminal, this must be an ordinary
   ASCII char, since we want to make it our interrupt character.

   If we are not running on an ordinary terminal, it still needs to be
   an ordinary ASCII char.  This character needs to be recognized in
   the input interrupt handler.  At this point, the keystroke is
   represented as a struct input_event, while the desired quit
   character is specified as a lispy event.  The mapping from struct
   input_events to lispy events cannot run in an interrupt handler,
   and the reverse mapping is difficult for anything but ASCII
   keystrokes.

   FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
   ASCII character.  */
int quit_char;

extern Lisp_Object current_global_map;
extern int minibuf_level;

281 282 283
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

284 285 286
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

287 288 289 290
/* Keymap that defines special misc events that should
   be processed immediately at a low level.  */
Lisp_Object Vspecial_event_map;

Jim Blandy's avatar
Jim Blandy committed
291 292 293 294
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
295
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
296 297 298 299

/* Last input character read as a command.  */
Lisp_Object last_command_char;

300 301 302 303
/* Last input character read as a command, not counting menus
   reached by the mouse.  */
Lisp_Object last_nonmenu_event;

Jim Blandy's avatar
Jim Blandy committed
304 305 306
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

Jim Blandy's avatar
Jim Blandy committed
307
/* If not Qnil, a list of objects to be read as subsequent command input.  */
308
Lisp_Object Vunread_command_events;
Jim Blandy's avatar
Jim Blandy committed
309

310 311 312 313 314 315 316 317
/* If not Qnil, a list of objects to be read as subsequent command input
   including input method processing.  */
Lisp_Object Vunread_input_method_events;

/* If not Qnil, a list of objects to be read as subsequent command input
   but NOT including input method processing.  */
Lisp_Object Vunread_post_input_method_events;

318
/* If not -1, an event to be read as subsequent command input.  */
319
EMACS_INT unread_command_char;
320

321 322
/* If not Qnil, this is a switch-frame event which we decided to put
   off until the end of a key sequence.  This should be read as the
Jim Blandy's avatar
Jim Blandy committed
323
   next command input, after any unread_command_events.
324 325 326 327 328

   read_key_sequence uses this to delay switch-frame events until the
   end of the key sequence; Fread_char uses it to put off switch-frame
   events until a non-ASCII event is acceptable as input.  */
Lisp_Object unread_switch_frame;
329

330
/* A mask of extra modifier bits to put into every keyboard char.  */
331
EMACS_INT extra_keyboard_modifiers;
332

Jim Blandy's avatar
Jim Blandy committed
333 334 335 336 337 338 339 340
/* Char to use as prefix when a meta character is typed in.
   This is bound on entry to minibuffer in case ESC is changed there.  */

Lisp_Object meta_prefix_char;

/* Last size recorded for a current buffer which is not a minibuffer.  */
static int last_non_minibuf_size;

341
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
342 343 344
static Lisp_Object Vauto_save_timeout;

/* Total number of times read_char has returned.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
345
int num_input_events;
Jim Blandy's avatar
Jim Blandy committed
346

347
/* Total number of times read_char has returned, outside of macros.  */
348
EMACS_INT num_nonmacro_input_events;
349

Jim Blandy's avatar
Jim Blandy committed
350 351 352
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

353
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
354

355
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
356 357 358 359

int last_auto_save;

/* The command being executed by the command loop.
360 361
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
362 363 364 365
Lisp_Object Vthis_command;

/* This is like Vthis_command, except that commands never set it.  */
Lisp_Object real_this_command;
Jim Blandy's avatar
Jim Blandy committed
366

367 368 369 370
/* If the lookup of the command returns a binding, the original
   command is stored in this-original-command.  It is nil otherwise.  */
Lisp_Object Vthis_original_command;

371 372 373
/* The value of point when the last command was executed.  */
int last_point_position;

374 375 376
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

377 378 379 380 381 382 383 384 385 386 387 388
/* The frame in which the last input event occurred, or Qmacro if the
   last event came from a macro.  We use this to determine when to
   generate switch-frame events.  This may be cleared by functions
   like Fselect_frame, to make sure that a switch-frame event is
   generated by the next character.  */
Lisp_Object internal_last_event_frame;

/* A user-visible version of the above, intended to allow users to
   figure out where the last event came from, if the event doesn't
   carry that information itself (i.e. if it was a character).  */
Lisp_Object Vlast_event_frame;

Jim Blandy's avatar
Jim Blandy committed
389 390
/* The timestamp of the last input event we received from the X server.
   X Windows wants this for selection ownership.  */
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394 395
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
396
Lisp_Object Qundefined;
397
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
398 399 400 401 402

/* read_key_sequence stores here the command definition of the
   key sequence that it reads.  */
Lisp_Object read_key_sequence_cmd;

403 404 405
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

Jim Blandy's avatar
Jim Blandy committed
406 407 408
/* Form to evaluate (if non-nil) when Emacs is started.  */
Lisp_Object Vtop_level;

409
/* User-supplied table to translate input characters.  */
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414
Lisp_Object Vkeyboard_translate_table;

/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
extern Lisp_Object Vfunction_key_map;

415 416 417
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
418

419 420 421 422
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

423 424 425 426
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

427 428 429
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

430 431 432 433 434
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

435
Lisp_Object Qecho_area_clear_hook;
436

437
/* Hooks to run before and after each command.  */
438 439
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
440
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
441 442 443 444
/* Hook run after a command if there's no more input soon.  */
Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;

/* Delay time in microseconds before running post-command-idle-hook.  */
445
EMACS_INT post_command_idle_delay;
446

447 448 449 450 451 452
/* List of deferred actions to be performed at a later time.
   The precise format isn't relevant here; we just check whether it is nil.  */
Lisp_Object Vdeferred_action_list;

/* Function to call to handle deferred actions, when there are any.  */
Lisp_Object Vdeferred_action_function;
453
Lisp_Object Qdeferred_action_function;
454

455 456 457
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463
/* File in which we write all commands we read.  */
FILE *dribble;

/* Nonzero if input is available.  */
int input_pending;

464 465 466 467
/* Non-zero means force key bindings update in parse_menu_item.  */

int update_menu_bindings;

Jim Blandy's avatar
Jim Blandy committed
468 469
extern char *pending_malloc_warning;

470
/* Circular buffer for pre-read keyboard input.  */
471

472 473
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

474
/* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492

   The interrupt-level event handlers will never enqueue an event on a
   frame which is not in Vframe_list, and once an event is dequeued,
   internal_last_event_frame or the event itself points to the frame.
   So that's all fine.

   But while the event is sitting in the queue, it's completely
   unprotected.  Suppose the user types one command which will run for
   a while and then delete a frame, and then types another event at
   the frame that will be deleted, before the command gets around to
   it.  Suppose there are no references to this frame elsewhere in
   Emacs, and a GC occurs before the second event is dequeued.  Now we
   have an event referring to a freed frame, which will crash Emacs
   when it is dequeued.

   Similar things happen when an event on a scroll bar is enqueued; the
   window may be deleted while the event is in the queue.

493 494 495
   So, we use this vector to protect the Lisp_Objects in the event
   queue.  That way, they'll be dequeued as dead frames or windows,
   but still valid Lisp objects.
496

Pavel Janík's avatar
Pavel Janík committed
497
   If kbd_buffer[i].kind != NO_EVENT, then
498 499 500 501 502

   AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
   AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg.  */

static Lisp_Object kbd_buffer_gcpro;
503 504 505

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
506
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
507 508 509 510 511 512
   next available char is in kbd_buffer[0].  */
static struct input_event *kbd_fetch_ptr;

/* Pointer to next place to store character in kbd_buffer.  This
   may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
   character should go in kbd_buffer[0].  */
513
static struct input_event * volatile kbd_store_ptr;
514 515 516 517 518 519 520 521 522 523

/* The above pair of variables forms a "queue empty" flag.  When we
   enqueue a non-hook event, we increment kbd_store_ptr.  When we
   dequeue a non-hook event, we increment kbd_fetch_ptr.  We say that
   there is input available iff the two pointers are not equal.

   Why not just have a flag set and cleared by the enqueuing and
   dequeuing functions?  Such a flag could be screwed up by interrupts
   at inopportune times.  */

Karl Heuer's avatar
Karl Heuer committed
524
/* If this flag is non-nil, we check mouse_moved to see when the
525 526
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
527
Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
528 529 530

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
531
Lisp_Object Qscroll_bar_movement;
532
Lisp_Object Qswitch_frame;
533
Lisp_Object Qdelete_frame;
534 535
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
Pavel Janík's avatar
Pavel Janík committed
536
Lisp_Object Qselect_window;
537
Lisp_Object Qhelp_echo;
538

Jim Blandy's avatar
Jim Blandy committed
539 540 541
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
Andrew Choi's avatar
In src:  
Andrew Choi committed
542
#ifdef WINDOWSNT
543
Lisp_Object Qlanguage_change;
544
#endif
545
Lisp_Object Qdrag_n_drop;
546 547
Lisp_Object Qsave_session;

Jim Blandy's avatar
Jim Blandy committed
548 549 550 551
/* Lisp_Object Qmouse_movement; - also an event header */

/* Properties of event headers.  */
Lisp_Object Qevent_kind;
552
Lisp_Object Qevent_symbol_elements;
Jim Blandy's avatar
Jim Blandy committed
553

554 555
/* menu item parts */
Lisp_Object Qmenu_alias;
556
Lisp_Object Qmenu_enable;
557 558
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
559 560
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
561

562 563 564 565 566 567 568 569 570 571 572 573 574
/* An event header symbol HEAD may have a property named
   Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
   BASE is the base, unmodified version of HEAD, and MODIFIERS is the
   mask of modifiers applied to it.  If present, this is used to help
   speed up parse_modifiers.  */
Lisp_Object Qevent_symbol_element_mask;

/* An unmodified event header BASE may have a property named
   Qmodifier_cache, which is an alist mapping modifier masks onto
   modified versions of BASE.  If present, this helps speed up
   apply_modifiers.  */
Lisp_Object Qmodifier_cache;

575
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
576
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
577
Lisp_Object Qvertical_line;
578
Lisp_Object Qvertical_scroll_bar;
579
Lisp_Object Qmenu_bar;
580
extern Lisp_Object Qleft_margin, Qright_margin;
581
extern Lisp_Object Qleft_fringe, Qright_fringe;
582
extern Lisp_Object QCmap;
583

584 585
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
586
Lisp_Object Qextended_command_history;
587
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
588

589
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
590

591 592
extern char *x_get_keysym_name ();

593
static void record_menu_key ();
594
static int echo_length ();
595

596 597
Lisp_Object Qpolling_period;

598
/* List of absolute timers.  Appears in order of next scheduled event.  */
599 600
Lisp_Object Vtimer_list;

601 602 603
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

604 605 606
/* Incremented whenever a timer is run.  */
int timers_run;

607 608
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
609 610 611
/* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
   happens.  */
EMACS_TIME *input_available_clear_time;
Jim Blandy's avatar
Jim Blandy committed
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632

/* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
   Default is 1 if INTERRUPT_INPUT is defined.  */
int interrupt_input;

/* Nonzero while interrupts are temporarily deferred during redisplay.  */
int interrupts_deferred;

/* Allow m- file to inhibit use of FIONREAD.  */
#ifdef BROKEN_FIONREAD
#undef FIONREAD
#endif

/* We are unable to use interrupts if FIONREAD is not available,
   so flush SIGIO so we won't try.  */
#ifndef FIONREAD
#ifdef SIGIO
#undef SIGIO
#endif
#endif

633
/* If we support a window system, turn on the code to poll periodically
634
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
635
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
636 637
#define POLL_FOR_INPUT
#endif
638 639 640 641

/* After a command is executed, if point is moved into a region that
   has specific properties (e.g. composition, display), we adjust
   point to the boundary of the region.  But, if a command sets this
Pavel Janík's avatar
Pavel Janík committed
642
   variable to non-nil, we suppress this point adjustment.  This
643
   variable is set to nil before reading a command.  */
644

645 646 647
Lisp_Object Vdisable_point_adjustment;

/* If non-nil, always disable point adjustment.  */
648

649 650
Lisp_Object Vglobal_disable_point_adjustment;

651 652 653 654
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

655 656 657 658 659
/* After Emacs stops being idle, this saves the last value
   of timer_idleness_start_time from when it was idle.  */

static EMACS_TIME timer_last_idleness_start_time;

Jim Blandy's avatar
Jim Blandy committed
660 661 662 663 664 665

/* Global variable declarations.  */

/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

666 667
static int read_avail_input P_ ((int));
static void get_input_pending P_ ((int *, int));
668
static void get_filtered_input_pending P_ ((int *, int, int));
669
static int readable_events P_ ((int));
670
static int readable_filtered_events P_ ((int, int));
671 672
static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
						Lisp_Object, int *));
673
static Lisp_Object read_char_x_menu_prompt ();
674 675 676
static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
						      Lisp_Object *));
static Lisp_Object make_lispy_event P_ ((struct input_event *));
677
#ifdef HAVE_MOUSE
678 679 680 681
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
682
#endif
683 684 685 686 687
static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
					    Lisp_Object, char **,
					    Lisp_Object *, unsigned));
static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
static int parse_solitary_modifier P_ ((Lisp_Object));
688
static int parse_solitary_modifier ();
689
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
690
static void save_getcjmp ();
691
static void restore_getcjmp P_ ((jmp_buf));
692
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
693
static void clear_event P_ ((struct input_event *));
694
static void any_kboard_state P_ ((void));
695
static SIGTYPE interrupt_signal P_ ((int signalnum));
Jim Blandy's avatar
Jim Blandy committed
696

697 698 699 700
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;

Jim Blandy's avatar
Jim Blandy committed
701 702 703 704
/* Install the string STR as the beginning of the string of echoing,
   so that it serves as a prompt for the next character.
   Also start echoing.  */

Andreas Schwab's avatar
Andreas Schwab committed
705
void
Jim Blandy's avatar
Jim Blandy committed
706
echo_prompt (str)
707
     Lisp_Object str;
Jim Blandy's avatar
Jim Blandy committed
708
{
709
  current_kboard->echo_string = str;
710
  current_kboard->echo_after_prompt = SCHARS (str);
711
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
712 713
}

714
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
715 716 717
   C can be a character, which is printed prettily ("M-C-x" and all that
   jazz), or a symbol, whose name is printed.  */

Andreas Schwab's avatar
Andreas Schwab committed
718
void
Jim Blandy's avatar
Jim Blandy committed
719 720 721
echo_char (c)
     Lisp_Object c;
{
722
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
723
    {
724 725 726 727
      int size = KEY_DESCRIPTION_SIZE + 100;
      char *buffer = (char *) alloca (size);
      char *ptr = buffer;
      Lisp_Object echo_string;
Jim Blandy's avatar
Jim Blandy committed
728

729
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
730

Jim Blandy's avatar
Jim Blandy committed
731
      /* If someone has passed us a composite event, use its head symbol.  */
732
      c = EVENT_HEAD (c);
Jim Blandy's avatar
Jim Blandy committed
733

734
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
735
	{
736
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
737
	}
738
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
739
	{
740 741
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
742

743
	  if (size - (ptr - buffer) < nbytes)
744 745
	    {
	      int offset = ptr - buffer;
746
	      size = max (2 * size, size + nbytes);
747 748 749 750
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

751 752
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
753 754
	}

755
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
756
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
757
	{
758 759
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
760

761 762 763 764 765 766 767 768 769 770
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

	  bcopy (text, ptr, len);
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
771 772
	}

773 774
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
775
      if (STRINGP (echo_string)
776
	  && SCHARS (echo_string) > 1)
777
	{
778 779 780 781
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
782 783 784 785

	  idx = make_number (SCHARS (echo_string) - 1);
	  last_char = Faref (echo_string, idx);

786 787 788
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
789 790 791 792
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
793 794 795

      current_kboard->echo_string
	= concat2 (echo_string, make_string (buffer, ptr - buffer));
Jim Blandy's avatar
Jim Blandy committed
796

797
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
798 799 800 801 802 803
    }
}

/* Temporarily add a dash to the end of the echo string if it's not
   empty, so that it serves as a mini-prompt for the very next character.  */

Andreas Schwab's avatar
Andreas Schwab committed
804
void
Jim Blandy's avatar
Jim Blandy committed
805 806
echo_dash ()
{
807 808 809 810
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

811
  if (!current_kboard->immediate_echo
812
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
813
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
814

815
  /* Do nothing if we just printed a prompt.  */
816
  if (current_kboard->echo_after_prompt
817
      == SCHARS (current_kboard->echo_string))
818
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
819

Jim Blandy's avatar
Jim Blandy committed
820 821
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
822 823
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
824
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
825 826 827 828 829
}

/* Display the current echo string, and begin echoing if not already
   doing so.  */

830
void
831
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
832
{
833
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
834 835
    {
      int i;
836
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
837 838

      for (i = 0; i < this_command_key_count; i++)
839 840
	{
	  Lisp_Object c;
841 842 843 844 845 846 847

	  /* Set before_command_echo_length to the value that would
	     have been saved before the start of this subcommand in
	     command_loop_1, if we had already been echoing then.  */
	  if (i == this_single_command_key_start)
	    before_command_echo_length = echo_length ();

848 849 850 851 852
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
853 854 855 856 857 858 859 860

      /* Set before_command_echo_length to the value that would
	 have been saved before the start of this subcommand in
	 command_loop_1, if we had already been echoing then.  */
      if (this_command_key_count == this_single_command_key_start)
	before_command_echo_length = echo_length ();

      /* Put a dash at the end to invite the user to type more.  */
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864
      echo_dash ();
    }

  echoing = 1;
865
  message3_nolog (current_kboard->echo_string,
866
		  SBYTES (current_kboard->echo_string),
867
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
868 869
  echoing = 0;

870 871 872 873
  /* Record in what buffer we echoed, and from which kboard.  */
  echo_message_buffer = echo_area_buffer[0];
  echo_kboard = current_kboard;

Jim Blandy's avatar
Jim Blandy committed
874 875 876 877 878 879
  if (waiting_for_input && !NILP (Vquit_flag))
    quit_throw_to_read_char ();
}

/* Turn off echoing, for the start of a new command.  */

Andreas Schwab's avatar
Andreas Schwab committed
880
void
Jim Blandy's avatar
Jim Blandy committed
881 882
cancel_echoing ()
{
883 884
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
885
  current_kboard->echo_string = Qnil;
886 887 888
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
889 890 891 892 893 894 895
}

/* Return the length of the current echo string.  */

static int
echo_length ()
{
896
  return (STRINGP (current_kboard->echo_string)
897
	  ? SCHARS (current_kboard->echo_string)
898
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
899 900 901 902
}

/* Truncate the current echo message to its first LEN chars.
   This and echo_char get used by read_key_sequence when the user
Jim Blandy's avatar
Jim Blandy committed
903
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
904 905

static void
906 907 908 909 910 911 912 913
echo_truncate (nchars)
     int nchars;
{
  if (STRINGP (current_kboard->echo_string))
    current_kboard->echo_string
      = Fsubstring (current_kboard->echo_string,
		    make_number (0), make_number (nchars));
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
914 915 916 917 918 919 920 921
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
922 923
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
924 925 926 927 928
  /* If reset-this-command-length was called recently, obey it now.
     See the doc string of that function for an explanation of why.  */
  if (before_command_restore_flag)
    {
      this_command_key_count = before_command_key_count_1;
929 930
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
931 932 933
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
934
#endif
935

936 937 938 939
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
940

941 942
  AREF (this_command_keys, this_command_key_count) = key;
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
943
}
944

Jim Blandy's avatar
Jim Blandy committed
945 946 947 948

Lisp_Object
recursive_edit_1 ()
{
Juanma Barranquero's avatar
Juanma Barranquero committed
949
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
950 951 952 953 954 955 956 957
  Lisp_Object val;

  if (command_loop_level > 0)
    {
      specbind (Qstandard_output, Qt);
      specbind (Qstandard_input, Qt);
    }

958
#ifdef HAVE_X_WINDOWS
959
  /* The command loop has started an hourglass timer, so we have to
960
     cancel it here, otherwise it will fire because the recursive edit
961 962
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
963
    cancel_hourglass ();
964 965
#endif

966 967 968 969 970 971 972 973 974 975 976 977
  /* This function may have been called from a debugger called from
     within redisplay, for instance by Edebugging a function called
     from fontification-functions.  We want to allow redisplay in
     the debugging session.

     The recursive edit is left with a `(throw exit ...)'.  The `exit'
     tag is not caught anywhere in redisplay, i.e. when we leave the
     recursive edit, the original redisplay leading to the recursive
     edit will be unwound.  The outcome should therefore be safe.  */
  specbind (Qinhibit_redisplay, Qnil);
  redisplaying_p = 0;

Jim Blandy's avatar
Jim Blandy committed
978 979 980
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
981 982 983 984
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
    Fsignal (Qerror, Fcons (val, Qnil));
Jim Blandy's avatar
Jim Blandy committed
985

986
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
987 988 989
}

/* When an auto-save happens, record the "time", and don't do again soon.  */
990

991
void
Jim Blandy's avatar
Jim Blandy committed
992 993
record_auto_save ()
{
994
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
995
}
996 997 998

/* Make an auto save happen as soon as possible at command level.  */

Andreas Schwab's avatar
Andreas Schwab committed
999
void
1000 1001 1002
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
1003 1004

  record_asynch_buffer_change ();
1005
}
Jim Blandy's avatar
Jim Blandy committed
1006 1007

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
1008 1009 1010 1011 1012 1013
       doc: /* Invoke the editor command loop recursively.
To get out of the recursive edit, a command can do `(throw 'exit nil)';
that tells this function to return.
Alternately, `(throw 'exit t)' makes this function signal an error.
This function is called by the editor initialization to begin editing.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1014
{
Juanma Barranquero's avatar
Juanma Barranquero committed
1015
  int count = SPECPDL_INDEX ();
1016
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1017 1018 1019 1020

  command_loop_level++;
  update_mode_lines = 1;

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
  if (command_loop_level
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
    buffer = Fcurrent_buffer ();
  else
    buffer = Qnil;

  /* If we leave recursive_edit_1 below with a `throw' for instance,
     like it is done in the splash screen display, we have to
     make sure that we restore single_kboard as command_loop_1
     would have done if it were left normally.  */
Jim Blandy's avatar
Jim Blandy committed
1031
  record_unwind_protect (recursive_edit_unwind,
1032 1033
			 Fcons (buffer, single_kboard ? Qt : Qnil));

Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036 1037 1038
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
1039 1040
recursive_edit_unwind (info)
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
1041
{
1042 1043
  if (BUFFERP (XCAR (info)))
    Fset_buffer (XCAR (info));
Juanma Barranquero's avatar
Juanma Barranquero committed
1044

1045 1046 1047 1048
  if (NILP (XCDR (info)))
    any_kboard_state ();
  else
    single_kboard_state ();
Juanma Barranquero's avatar
Juanma Barranquero committed
1049