keyboard.c 310 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2 3
   Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000
     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 25 26 27 28 29
#include <stdio.h>
#include "termchar.h"
#include "termopts.h"
#include "lisp.h"
#include "termhooks.h"
#include "macros.h"
30
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34
#include "window.h"
#include "commands.h"
#include "buffer.h"
35
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
36
#include "disptab.h"
37
#include "dispextern.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
38
#include "syntax.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
39
#include "intervals.h"
40
#include "blockinput.h"
41
#include "puresize.h"
42 43
#include "systime.h"
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
44 45 46
#include <setjmp.h>
#include <errno.h>

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

Jim Blandy's avatar
Jim Blandy committed
56
#include "syssignal.h"
57
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
58

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

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

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

73 74 75
/* Include systime.h after xterm.h to avoid double inclusion of time.h. */
#include "systime.h"

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

80 81 82
/* Variables for blockinput.h: */

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

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


90 91
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
92

93
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
94
/* Make all keyboard buffers much bigger when using X windows.  */
95 96 97 98
#ifdef macintosh
/* But not too big (local data > 32K error) if on macintosh */
#define KBD_BUFFER_SIZE 512
#else
Jim Blandy's avatar
Jim Blandy committed
99
#define KBD_BUFFER_SIZE 4096
100
#endif
Jim Blandy's avatar
Jim Blandy committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
#else	/* No X-windows, character input */
#define KBD_BUFFER_SIZE 256
#endif	/* No X-windows */

/* 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;
  };

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

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

#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 */
134
Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
Jim Blandy's avatar
Jim Blandy committed
135

136 137 138 139 140 141 142
/* 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
143

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
/* 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							\
if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
  {									\
    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;							\
  }

160 161 162 163
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

164 165 166 167 168 169 170 171 172 173 174 175
/* 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;
/* Values of before_command_key_count and before_command_echo_length
   saved by reset-this-command-lengths.  */
static int before_command_key_count_1;
static int before_command_echo_length_1;
/* Flag set by reset-this-command-lengths,
   saying to reset the lengths when add_command_key is called.  */
static int before_command_restore_flag;

Jim Blandy's avatar
Jim Blandy committed
176 177
extern int minbuf_level;

178 179
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
180 181
extern struct backtrace *backtrace_list;

182 183 184 185 186
/* 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;

Jim Blandy's avatar
Jim Blandy committed
187 188 189 190 191 192 193 194 195 196 197 198 199
/* Nonzero means do menu prompting.  */
static int menu_prompting;

/* Character to see next line of menu prompt.  */
static Lisp_Object menu_prompt_more_char;

/* For longjmp to where kbd input is being done.  */
static jmp_buf getcjmp;

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

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

Jim Blandy's avatar
Jim Blandy committed
201 202
static int echoing;

203 204 205 206 207
/* 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;

208 209 210 211
/* 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.  */
212 213

static struct kboard *echo_kboard;
214

215 216 217 218 219
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

static Lisp_Object echo_message_buffer;

220 221 222
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

223
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
224 225
int immediate_quit;

226 227 228
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
229
/* Character to recognize as the help char.  */
230
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
231

Karl Heuer's avatar
Karl Heuer committed
232 233 234
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
235 236 237
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

238 239 240
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

241 242
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
243

244 245 246 247 248 249
/* 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;

Jim Blandy's avatar
Jim Blandy committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
/* 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;

271 272 273
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

274 275 276
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

277 278 279 280
/* 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
281 282 283 284 285 286 287 288 289
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
int num_input_keys;

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

290 291 292 293
/* 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
294 295 296
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

300 301 302 303 304 305 306 307
/* 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;

308 309 310
/* If not -1, an event to be read as subsequent command input.  */
int unread_command_char;

311 312
/* 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
313
   next command input, after any unread_command_events.
314 315 316 317 318

   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;
319

320 321 322
/* A mask of extra modifier bits to put into every keyboard char.  */
int extra_keyboard_modifiers;

Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327 328 329 330
/* 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;

331
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
332 333 334
static Lisp_Object Vauto_save_timeout;

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

337
/* Total number of times read_char has returned, outside of macros.  */
338
int num_nonmacro_input_events;
339

Jim Blandy's avatar
Jim Blandy committed
340 341 342 343 344
/* Auto-save automatically when this many characters have been typed
   since the last time.  */

static int auto_save_interval;

345
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349

int last_auto_save;

/* The command being executed by the command loop.
350 351
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
352 353 354 355
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
356

357 358 359
/* The value of point when the last command was executed.  */
int last_point_position;

360 361 362
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

363 364 365 366 367 368 369 370 371 372 373 374
/* 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
375 376
/* 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
377 378 379 380 381
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
382
Lisp_Object Qundefined;
383
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388

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

389 390 391
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

Jim Blandy's avatar
Jim Blandy committed
392 393 394 395 396 397 398 399 400
/* Form to evaluate (if non-nil) when Emacs is started.  */
Lisp_Object Vtop_level;

/* User-supplied string to translate input characters through.  */
Lisp_Object Vkeyboard_translate_table;

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

401 402 403
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
404

405 406 407 408
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

409 410 411 412
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

413 414 415
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

416 417 418 419 420
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

421 422
Lisp_Object Qecho_area_clear_hook;

423
/* Hooks to run before and after each command.  */
424 425
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
426
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
427 428 429 430 431
/* 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.  */
int post_command_idle_delay;
432

433 434 435 436 437 438
/* 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;
439
Lisp_Object Qdeferred_action_function;
440

441 442 443
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
444 445 446 447 448 449
/* File in which we write all commands we read.  */
FILE *dribble;

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

450 451 452
/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
   keep 0200 bit in input chars.  0 to ignore the 0200 bit.  */

Jim Blandy's avatar
Jim Blandy committed
453 454
int meta_key;

455 456 457 458
/* Non-zero means force key bindings update in parse_menu_item.  */

int update_menu_bindings;

Jim Blandy's avatar
Jim Blandy committed
459 460
extern char *pending_malloc_warning;

461
/* Circular buffer for pre-read keyboard input.  */
462

463 464
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

465
/* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483

   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.

484 485 486
   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.
487 488

   If kbd_buffer[i].kind != no_event, then
489 490 491 492 493

   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;
494 495 496 497 498 499 500 501 502 503

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
   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].  */
504
static struct input_event * volatile kbd_store_ptr;
505 506 507 508 509 510 511 512 513 514

/* 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
515
/* If this flag is non-nil, we check mouse_moved to see when the
516 517 518
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
static Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
519 520 521

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
522
Lisp_Object Qscroll_bar_movement;
523
Lisp_Object Qswitch_frame;
524
Lisp_Object Qdelete_frame;
525 526
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
527
Lisp_Object Qhelp_echo;
528

Jim Blandy's avatar
Jim Blandy committed
529 530 531
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
532 533
#ifdef WINDOWSNT
Lisp_Object Qmouse_wheel;
534
Lisp_Object Qlanguage_change;
535
#endif
536
Lisp_Object Qdrag_n_drop;
Jim Blandy's avatar
Jim Blandy committed
537 538 539 540
/* Lisp_Object Qmouse_movement; - also an event header */

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

543 544
/* menu item parts */
Lisp_Object Qmenu_alias;
545
Lisp_Object Qmenu_enable;
546 547
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
548 549
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
550

551 552 553 554 555 556 557 558 559 560 561 562 563
/* 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;

564
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
565
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
566
Lisp_Object Qvertical_line;
567
Lisp_Object Qvertical_scroll_bar;
568 569
Lisp_Object Qmenu_bar;

570 571
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
572
Lisp_Object Qextended_command_history;
573
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
574

575 576
extern Lisp_Object Vhistory_length;

577 578
extern char *x_get_keysym_name ();

579 580
static void record_menu_key ();

581 582
Lisp_Object Qpolling_period;

583
/* List of absolute timers.  Appears in order of next scheduled event.  */
584 585
Lisp_Object Vtimer_list;

586 587 588
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

589 590 591
/* Incremented whenever a timer is run.  */
int timers_run;

592 593
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
594 595 596
/* 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
597 598 599 600 601 602 603 604

/* 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;

605
/* Nonzero means use ^S/^Q for flow control.  */
Jim Blandy's avatar
Jim Blandy committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
int flow_control;

/* 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

621
/* If we support a window system, turn on the code to poll periodically
622
   to detect C-g.  It isn't actually used when doing interrupt input.  */
623
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
624 625
#define POLL_FOR_INPUT
#endif
626 627 628 629 630 631

/* 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
   valiable to non-nil, we suppress this point adjustment.  This
   variable is set to nil before reading a command.  */
632

633 634 635
Lisp_Object Vdisable_point_adjustment;

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

637 638
Lisp_Object Vglobal_disable_point_adjustment;

Jim Blandy's avatar
Jim Blandy committed
639 640 641 642 643 644

/* Global variable declarations.  */

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

645 646 647 648 649
static int read_avail_input P_ ((int));
static void get_input_pending P_ ((int *, int));
static int readable_events P_ ((int));
static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
						Lisp_Object, int *));
650
static Lisp_Object read_char_x_menu_prompt ();
651 652 653
static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
						      Lisp_Object *));
static Lisp_Object make_lispy_event P_ ((struct input_event *));
654
#ifdef HAVE_MOUSE
655 656 657 658
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
659
#endif
660 661 662 663 664
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));
665
static int parse_solitary_modifier ();
666
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
667
static void save_getcjmp ();
668
static void restore_getcjmp P_ ((jmp_buf));
669
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
670
static void clear_event P_ ((struct input_event *));
Jim Blandy's avatar
Jim Blandy committed
671

672 673 674 675
/* 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
676 677 678 679 680 681 682
#define	min(a,b)	((a)<(b)?(a):(b))
#define	max(a,b)	((a)>(b)?(a):(b))

/* 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
683
void
Jim Blandy's avatar
Jim Blandy committed
684 685 686 687
echo_prompt (str)
     char *str;
{
  int len = strlen (str);
688

689 690
  if (len > ECHOBUFSIZE - 4)
    len = ECHOBUFSIZE - 4;
691 692 693
  bcopy (str, current_kboard->echobuf, len);
  current_kboard->echoptr = current_kboard->echobuf + len;
  *current_kboard->echoptr = '\0';
Jim Blandy's avatar
Jim Blandy committed
694

695
  current_kboard->echo_after_prompt = len;
696

697
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
698 699
}

700
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
701 702 703
   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
704
void
Jim Blandy's avatar
Jim Blandy committed
705 706 707 708 709
echo_char (c)
     Lisp_Object c;
{
  extern char *push_key_description ();

710
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
711
    {
712
      char *ptr = current_kboard->echoptr;
713

714
      if (ptr != current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
715 716 717
	*ptr++ = ' ';

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

720
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
721
	{
722 723
	  if (ptr - current_kboard->echobuf
	      > ECHOBUFSIZE - KEY_DESCRIPTION_SIZE)
Jim Blandy's avatar
Jim Blandy committed
724 725
	    return;

726
	  ptr = push_key_description (XINT (c), ptr);
Jim Blandy's avatar
Jim Blandy committed
727
	}
728
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
729 730
	{
	  struct Lisp_String *name = XSYMBOL (c)->name;
731
	  if ((ptr - current_kboard->echobuf) + STRING_BYTES (name) + 4
732
	      > ECHOBUFSIZE)
Jim Blandy's avatar
Jim Blandy committed
733
	    return;
734 735
	  bcopy (name->data, ptr, STRING_BYTES (name));
	  ptr += STRING_BYTES (name);
Jim Blandy's avatar
Jim Blandy committed
736 737
	}

738
      if (current_kboard->echoptr == current_kboard->echobuf
Karl Heuer's avatar
Karl Heuer committed
739
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
740 741 742 743 744 745
	{
	  strcpy (ptr, " (Type ? for further options)");
	  ptr += strlen (ptr);
	}

      *ptr = 0;
746
      current_kboard->echoptr = ptr;
Jim Blandy's avatar
Jim Blandy committed
747

748
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
749 750 751 752 753 754
    }
}

/* 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
755
void
Jim Blandy's avatar
Jim Blandy committed
756 757
echo_dash ()
{
758 759
  if (!current_kboard->immediate_echo
      && current_kboard->echoptr == current_kboard->echobuf)
Jim Blandy's avatar
Jim Blandy committed
760
    return;
761
  /* Do nothing if we just printed a prompt.  */
762 763
  if (current_kboard->echo_after_prompt
      == current_kboard->echoptr - current_kboard->echobuf)
764
    return;
765
  /* Do nothing if not echoing at all.  */
766
  if (current_kboard->echoptr == 0)
767
    return;
Jim Blandy's avatar
Jim Blandy committed
768 769 770

  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
771 772
  current_kboard->echoptr[0] = '-';
  current_kboard->echoptr[1] = 0;
Jim Blandy's avatar
Jim Blandy committed
773

774
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
775 776 777 778 779
}

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

780
void
781
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
782
{
783
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
784 785
    {
      int i;
786
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
787 788

      for (i = 0; i < this_command_key_count; i++)
789 790 791 792 793 794 795
	{
	  Lisp_Object c;
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
Jim Blandy's avatar
Jim Blandy committed
796 797 798 799
      echo_dash ();
    }

  echoing = 1;
800 801
  message2_nolog (current_kboard->echobuf, strlen (current_kboard->echobuf),
		  ! NILP (current_buffer->enable_multibyte_characters));
Jim Blandy's avatar
Jim Blandy committed
802 803
  echoing = 0;

804 805 806 807
  /* 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
808 809 810 811 812 813
  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
814
void
Jim Blandy's avatar
Jim Blandy committed
815 816
cancel_echoing ()
{
817 818 819
  current_kboard->immediate_echo = 0;
  current_kboard->echoptr = current_kboard->echobuf;
  current_kboard->echo_after_prompt = -1;
820 821 822
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
823 824 825 826 827 828 829
}

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

static int
echo_length ()
{
830
  return current_kboard->echoptr - current_kboard->echobuf;
Jim Blandy's avatar
Jim Blandy committed
831 832 833 834
}

/* 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
835
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
836 837 838 839 840

static void
echo_truncate (len)
     int len;
{
841 842
  current_kboard->echobuf[len] = '\0';
  current_kboard->echoptr = current_kboard->echobuf + len;
843
  truncate_echo_area (len);
Jim Blandy's avatar
Jim Blandy committed
844 845 846 847 848 849 850 851
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
852 853
  int size = XVECTOR (this_command_keys)->size;

854 855 856 857 858
  /* 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;
859 860
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
861 862 863 864
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }

865
  if (this_command_key_count >= size)
Jim Blandy's avatar
Jim Blandy committed
866
    {
867
      Lisp_Object new_keys;
868

869
      new_keys = Fmake_vector (make_number (size * 2), Qnil);
870 871
      bcopy (XVECTOR (this_command_keys)->contents,
	     XVECTOR (new_keys)->contents,
872
	     size * sizeof (Lisp_Object));
873 874

      this_command_keys = new_keys;
Jim Blandy's avatar
Jim Blandy committed
875
    }
876 877

  XVECTOR (this_command_keys)->contents[this_command_key_count++] = key;
Jim Blandy's avatar
Jim Blandy committed
878 879 880 881 882 883 884 885 886 887 888 889 890 891
}

Lisp_Object
recursive_edit_1 ()
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object val;

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

892 893 894 895 896 897 898 899
#ifdef HAVE_X_WINDOWS
  /* The command loop has started a busy-cursor timer, so we have to
     cancel it here, otherwise it will fire because the recursive edit
     can take some time.  */
  if (display_busy_cursor_p)
    cancel_busy_cursor ();
#endif

Jim Blandy's avatar
Jim Blandy committed
900 901 902
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
903 904 905 906
  /* 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
907

908
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
909 910 911
}

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

913
void
Jim Blandy's avatar
Jim Blandy committed
914 915
record_auto_save ()
{
916
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
917
}
918 919 920

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

Andreas Schwab's avatar
Andreas Schwab committed
921
void
922 923 924
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
925 926

  record_asynch_buffer_change ();
927
}
Jim Blandy's avatar
Jim Blandy committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
  "Invoke the editor command loop recursively.\n\
To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
that tells this function to return.\n\
Alternately, `(throw 'exit t)' makes this function signal an error.\n\
This function is called by the editor initialization to begin editing.")
  ()
{
  int count = specpdl_ptr - specpdl;

  command_loop_level++;
  update_mode_lines = 1;

942 943 944 945 946 947 948 949 950 951 952 953
  /* 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
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
  record_unwind_protect (recursive_edit_unwind,
			 (command_loop_level
			  && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
			 ? Fcurrent_buffer ()
			 : Qnil);
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
recursive_edit_unwind (buffer)
     Lisp_Object buffer;
{
  if (!NILP (buffer))
    Fset_buffer (buffer);

  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}

Karl Heuer's avatar
Karl Heuer committed
975
static void
976
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
977
{
978 979 980 981 982
#ifdef MULTI_KBOARD
#if 0 /* Theory: if there's anything in Vunread_command_events,
	 it will right away be read by read_key_sequence,
	 and then if we do switch KBOARDS, it will go into the side
	 queue then.  So we don't need to do anything special here -- rms.  */
Karl Heuer's avatar
Karl Heuer committed
983
  if (CONSP (Vunread_command_events))
984
    {
985 986 987
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;
988
    }
Karl Heuer's avatar
Karl Heuer committed
989
  Vunread_command_events = Qnil;
990 991 992
#endif
  single_kboard = 0;
#endif
Karl Heuer's avatar
Karl Heuer committed
993
}
994 995 996 997 998 999 1000 1001 1002

/* Switch to the single-kboard state, making current_kboard
   the only KBOARD from which further input is accepted.  */

void
single_kboard_state ()
{
#ifdef MULTI_KBOARD
  single_kboard = 1;
Karl Heuer's avatar
Karl Heuer committed
1003
#endif
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
}

/* Maintain a stack of kboards, so other parts of Emacs
   can switch temporarily to the kboard of a given frame
   and then revert to the previous status.  */

struct kboard_stack
{
  KBOARD *kboard;
  struct kboard_stack *next;
};

static struct kboard_stack *kboard_stack;

void
push_frame_kboard (f)
     FRAME_PTR f;
{
1022
#ifdef MULTI_KBOARD
1023 1024 1025 1026 1027 1028 1029 1030
  struct kboard_stack *p
    = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));

  p->next = kboard_stack;
  p->kboard = current_kboard;
  kboard_stack = p;

  current_kboard = FRAME_KBOARD (f);
1031
#endif
1032 1033 1034 1035 1036
}

void
pop_frame_kboard ()
{
1037
#ifdef MULTI_KBOARD
1038 1039 1040 1041
  struct kboard_stack *p = kboard_stack;
  current_kboard = p->kboard;
  kboard_stack = p->next;
  xfree (p);
1042
#endif
1043 1044 1045 1046
}

/* Handle errors that are not handled at inner levels
   by printing an error message and returning to the editor command loop.  */
Karl Heuer's avatar
Karl Heuer committed
1047

Jim Blandy's avatar
Jim Blandy committed
1048 1049 1050
Lisp_Object
cmd_error (data)
     Lisp_Object data;
1051
{
1052
  Lisp_Object old_level, old_length;
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
  char macroerror[50];

  if (!NILP (executing_macro))
    {
      if (executing_macro_iterations == 1)
	sprintf (macroerror, "After 1 kbd macro iteration: ");
      else
	sprintf (macroerror, "After %d kbd macro iterations: ",
		 executing_macro_iterations);
    }
  else
    *macroerror = 0;
1065

1066 1067 1068
  Vstandard_output = Qt;
  Vstandard_input = Qt;
  Vexecuting_macro = Qnil;
1069
  executing_macro = Qnil;
1070
  current_kboard->Vprefix_arg = Qnil;
1071
  current_kboard->Vlast_prefix_arg = Qnil;
1072
  cancel_echoing ();
1073 1074 1075 1076

  /* Avoid unquittable loop if data contains a circular list.  */
  old_level = Vprint_level;
  old_length = Vprint_length;
1077 1078
  XSETFASTINT (Vprint_level, 10);
  XSETFASTINT (Vprint_length, 10);
1079
  cmd_error_internal (data, macroerror);
1080 1081
  Vprint_level = old_level;
  Vprint_length = old_length;
1082 1083 1084 1085

  Vquit_flag = Qnil;

  Vinhibit_quit = Qnil;
1086
#ifdef MULTI_KBOARD
1087
  any_kboard_state ();
1088
#endif
1089 1090 1091 1092

  return make_number (0);
}

1093 1094 1095 1096 1097 1098 1099 1100
/* Take actions on handling an error.  DATA is the data that describes
   the error.

   CONTEXT is a C-string containing ASCII characters only which
   describes the context in which the error happened.  If we need to
   generalize CONTEXT to allow multibyte characters, make it a Lisp
   string.  */

1101
void
1102 1103 1104
cmd_error_internal (data, context)
     Lisp_Object data;
     char *context;
Jim Blandy's avatar
Jim Blandy committed
1105 1106
{
  Lisp_Object stream;
1107
  int kill_emacs_p = 0;
1108
  struct frame *sf = SELECTED_FRAME ();
Jim Blandy's avatar
Jim Blandy committed