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,04
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 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"
Stefan Monnier's avatar
Stefan Monnier committed
40
#include "keymap.h"
41
#include "blockinput.h"
42
#include "puresize.h"
43 44
#include "systime.h"
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
45 46 47
#include <setjmp.h>
#include <errno.h>

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

Jim Blandy's avatar
Jim Blandy committed
60
#include "syssignal.h"
61
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
62

63 64 65 66 67
#include <sys/types.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

68 69 70 71 72
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

73 74 75 76
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

77
#ifdef MAC_OS
78 79 80
#include "macterm.h"
#endif

81
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
82
extern int errno;
83
#endif
Jim Blandy's avatar
Jim Blandy committed
84

85 86 87
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
88
int interrupt_input_blocked;
89 90 91

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
92
int interrupt_input_pending;
93 94


95 96
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
97

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

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

Jim Blandy's avatar
Jim Blandy committed
112 113 114 115 116 117 118 119 120 121 122
/* 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;
123 124
    /* Nonzero means call value of debugger when done with this operation. */
    char debug_on_exit;
Jim Blandy's avatar
Jim Blandy committed
125 126
  };

127 128 129 130
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
131
int single_kboard;
132
#else
133
KBOARD the_only_kboard;
134
#endif
135

Jim Blandy's avatar
Jim Blandy committed
136
/* Non-nil disable property on a command means
137 138
   do not execute it; call disabled-command-function's value instead.  */
Lisp_Object Qdisabled, Qdisabled_command_function;
Jim Blandy's avatar
Jim Blandy committed
139 140 141 142

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

145 146 147 148 149 150 151
/* 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
152

153 154 155 156
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
int this_command_key_count_reset;

157 158 159 160 161 162
/* 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							\
163
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
164 165 166 167 168 169 170 171 172
  {									\
    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;							\
  }

173 174 175 176
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

177 178 179 180 181
/* 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
182 183
extern int minbuf_level;

184 185
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
186 187
extern struct backtrace *backtrace_list;

188 189 190 191 192
/* 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;

193 194 195 196 197
/* 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
198
/* Nonzero means do menu prompting.  */
199

Jim Blandy's avatar
Jim Blandy committed
200 201 202
static int menu_prompting;

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

Jim Blandy's avatar
Jim Blandy committed
204 205 206
static Lisp_Object menu_prompt_more_char;

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

Jim Blandy's avatar
Jim Blandy committed
208 209 210 211 212 213
static jmp_buf getcjmp;

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

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

215
int echoing;
Jim Blandy's avatar
Jim Blandy committed
216

217 218 219 220 221
/* 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;

222 223 224 225
/* 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.  */
226

227
struct kboard *echo_kboard;
228

229 230 231
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

232
Lisp_Object echo_message_buffer;
233

234 235 236
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

237
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
238 239
int immediate_quit;

240 241 242
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
243
/* Character to recognize as the help char.  */
244
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
245

Karl Heuer's avatar
Karl Heuer committed
246 247 248
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
249 250 251
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

252 253 254
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

255 256
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
257

258 259 260 261 262 263
/* 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;

264 265 266 267
/* 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
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
/* 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;

289 290 291
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

292 293 294
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

295 296 297 298
/* 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
299 300 301 302
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
303
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
304 305 306 307

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

308 309 310 311
/* 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
312 313 314
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

318 319 320 321 322 323 324 325
/* 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;

326
/* If not -1, an event to be read as subsequent command input.  */
327
EMACS_INT unread_command_char;
328

329 330
/* 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
331
   next command input, after any unread_command_events.
332 333 334 335 336

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

338
/* A mask of extra modifier bits to put into every keyboard char.  */
339
EMACS_INT extra_keyboard_modifiers;
340

Jim Blandy's avatar
Jim Blandy committed
341 342 343 344 345 346 347 348
/* 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;

349
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
350 351 352
static Lisp_Object Vauto_save_timeout;

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

355
/* Total number of times read_char has returned, outside of macros.  */
356
EMACS_INT num_nonmacro_input_events;
357

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

361
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
362

363
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367

int last_auto_save;

/* The command being executed by the command loop.
368 369
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
370 371 372 373
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
374

375 376 377 378
/* 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;

379 380 381
/* The value of point when the last command was executed.  */
int last_point_position;

382 383 384
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

385 386 387 388 389 390 391 392 393 394 395 396
/* 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
397 398
/* 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
399 400 401 402 403
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
404
Lisp_Object Qundefined;
405
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410

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

411 412 413
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

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

417
/* User-supplied table to translate input characters.  */
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422
Lisp_Object Vkeyboard_translate_table;

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

423 424 425
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
426

427 428 429 430
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

431 432 433 434
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

435 436 437
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

438 439 440 441 442
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

443
Lisp_Object Qecho_area_clear_hook;
444

445
/* Hooks to run before and after each command.  */
446 447
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
448
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
449 450 451 452
/* 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.  */
453
EMACS_INT post_command_idle_delay;
454

455 456 457 458 459 460
/* 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;
461
Lisp_Object Qdeferred_action_function;
462

463 464 465
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
466 467 468 469 470 471
/* File in which we write all commands we read.  */
FILE *dribble;

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

472 473 474
/* 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
475 476
int meta_key;

477 478 479 480
/* Non-zero means force key bindings update in parse_menu_item.  */

int update_menu_bindings;

Jim Blandy's avatar
Jim Blandy committed
481 482
extern char *pending_malloc_warning;

483
/* Circular buffer for pre-read keyboard input.  */
484

485 486 487 488
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
489
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
490 491 492 493 494 495
   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].  */
496
static struct input_event * volatile kbd_store_ptr;
497 498 499 500 501 502 503 504 505 506

/* 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
507
/* If this flag is non-nil, we check mouse_moved to see when the
508 509
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
510
Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
511 512 513

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
514
Lisp_Object Qscroll_bar_movement;
515
Lisp_Object Qswitch_frame;
516
Lisp_Object Qdelete_frame;
517 518
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
Pavel Janík's avatar
Pavel Janík committed
519
Lisp_Object Qselect_window;
520
Lisp_Object Qhelp_echo;
521

Jim Blandy's avatar
Jim Blandy committed
522 523 524
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
Andrew Choi's avatar
In src:  
Andrew Choi committed
525
#ifdef WINDOWSNT
526
Lisp_Object Qlanguage_change;
527
#endif
528
Lisp_Object Qdrag_n_drop;
529 530
Lisp_Object Qsave_session;

Jim Blandy's avatar
Jim Blandy committed
531 532 533 534
/* Lisp_Object Qmouse_movement; - also an event header */

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

537 538
/* menu item parts */
Lisp_Object Qmenu_alias;
539
Lisp_Object Qmenu_enable;
540 541
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
542 543
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
544

545 546 547 548 549 550 551 552 553 554 555 556 557
/* 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;

558
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
559
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
560
Lisp_Object Qvertical_line;
561
Lisp_Object Qvertical_scroll_bar;
562
Lisp_Object Qmenu_bar;
563
extern Lisp_Object Qleft_margin, Qright_margin;
564
extern Lisp_Object Qleft_fringe, Qright_fringe;
565
extern Lisp_Object QCmap;
566

567 568
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
569
Lisp_Object Qextended_command_history;
570
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
571

572
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
573

574 575
extern char *x_get_keysym_name ();

576
static void record_menu_key ();
577
static int echo_length ();
578

579 580
Lisp_Object Qpolling_period;

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

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

587 588 589
/* Incremented whenever a timer is run.  */
int timers_run;

590 591
extern Lisp_Object Vprint_level, Vprint_length;

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

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

603
/* Nonzero means use ^S/^Q for flow control.  */
Jim Blandy's avatar
Jim Blandy committed
604 605 606 607 608 609 610 611 612
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.  */
Steven Tamm's avatar
Steven Tamm committed
613
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
614 615 616 617 618
#ifdef SIGIO
#undef SIGIO
#endif
#endif

619
/* If we support a window system, turn on the code to poll periodically
620
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
621
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
622 623
#define POLL_FOR_INPUT
#endif
624 625 626 627

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

631 632 633
Lisp_Object Vdisable_point_adjustment;

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

635 636
Lisp_Object Vglobal_disable_point_adjustment;

637 638 639 640
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

641 642 643 644 645
/* 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
646 647 648

/* Global variable declarations.  */

649 650 651 652 653
/* Flags for readable_events.  */
#define READABLE_EVENTS_DO_TIMERS_NOW		(1 << 0)
#define READABLE_EVENTS_FILTER_EVENTS		(1 << 1)
#define READABLE_EVENTS_IGNORE_SQUEEZABLES	(1 << 2)

Jim Blandy's avatar
Jim Blandy committed
654 655 656
/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

657 658 659 660 661
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 *));
662
static Lisp_Object read_char_x_menu_prompt ();
663 664 665
static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
						      Lisp_Object *));
static Lisp_Object make_lispy_event P_ ((struct input_event *));
666
#ifdef HAVE_MOUSE
667 668 669 670
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
671
#endif
672 673 674 675 676
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));
677
static int parse_solitary_modifier ();
678
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
679
static void save_getcjmp ();
680
static void restore_getcjmp P_ ((jmp_buf));
681
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
682
static void clear_event P_ ((struct input_event *));
683
static void any_kboard_state P_ ((void));
684
static SIGTYPE interrupt_signal P_ ((int signalnum));
685 686 687
static void timer_start_idle P_ ((void));
static void timer_stop_idle P_ ((void));
static void timer_resume_idle P_ ((void));
Jim Blandy's avatar
Jim Blandy committed
688

689 690 691 692
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;

693 694
extern Lisp_Object Qidentity, Qonly;

Jim Blandy's avatar
Jim Blandy committed
695 696 697 698
/* 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
699
void
Jim Blandy's avatar
Jim Blandy committed
700
echo_prompt (str)
701
     Lisp_Object str;
Jim Blandy's avatar
Jim Blandy committed
702
{
703
  current_kboard->echo_string = str;
704
  current_kboard->echo_after_prompt = SCHARS (str);
705
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
706 707
}

708
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
709 710 711
   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
712
void
Jim Blandy's avatar
Jim Blandy committed
713 714 715
echo_char (c)
     Lisp_Object c;
{
716
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
717
    {
718 719 720 721
      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
722

723
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
724

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

728
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
729
	{
730
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
731
	}
732
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
733
	{
734 735
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
736

737
	  if (size - (ptr - buffer) < nbytes)
738 739
	    {
	      int offset = ptr - buffer;
740
	      size = max (2 * size, size + nbytes);
741 742 743 744
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

745 746
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
747 748
	}

749
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
750
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
751
	{
752 753
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
754

755 756 757 758 759 760 761 762 763 764
	  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
765 766
	}

767 768
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
769
      if (STRINGP (echo_string)
770
	  && SCHARS (echo_string) > 1)
771
	{
772 773 774 775
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
776 777 778 779

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

780 781 782
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
783 784 785 786
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
787 788 789

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

791
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
792 793 794 795 796 797
    }
}

/* 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
798
void
Jim Blandy's avatar
Jim Blandy committed
799 800
echo_dash ()
{
801 802 803 804
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

805
  if (!current_kboard->immediate_echo
806
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
807
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
808

809
  /* Do nothing if we just printed a prompt.  */
810
  if (current_kboard->echo_after_prompt
811
      == SCHARS (current_kboard->echo_string))
812
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
813

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
  /* Do nothing if we have already put a dash at the end.  */
  if (SCHARS (current_kboard->echo_string) > 1)
    {
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (current_kboard->echo_string) - 2);
	  prev_char = Faref (current_kboard->echo_string, idx);

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

	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	    return;
    }

Jim Blandy's avatar
Jim Blandy committed
829 830
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
831 832
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
833
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
834 835 836 837 838
}

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

839
void
840
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
841
{
842
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
843 844
    {
      int i;
845
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
846 847

      for (i = 0; i < this_command_key_count; i++)
848 849
	{
	  Lisp_Object c;
850 851 852 853 854 855 856

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

857 858 859 860 861
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
862 863 864 865 866 867 868 869

      /* 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
870 871 872 873
      echo_dash ();
    }

  echoing = 1;
874
  message3_nolog (current_kboard->echo_string,
875
		  SBYTES (current_kboard->echo_string),
876
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
877 878
  echoing = 0;

879 880 881 882
  /* 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
883 884 885 886 887 888
  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
889
void
Jim Blandy's avatar
Jim Blandy committed
890 891
cancel_echoing ()
{
892 893
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
894
  current_kboard->echo_string = Qnil;
895 896 897
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
898 899 900 901 902 903 904
}

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

static int
echo_length ()
{
905
  return (STRINGP (current_kboard->echo_string)
906
	  ? SCHARS (current_kboard->echo_string)
907
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
908 909 910 911
}

/* 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
912
   switches frames while entering a key sequence.  */
Jim Blandy's avatar
Jim Blandy committed
913 914

static void
915 916 917 918 919 920 921 922
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
923 924 925 926 927 928 929 930
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
931 932
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
933 934 935 936 937
  /* 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;
938 939
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
940 941 942
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
943
#endif
944

945 946 947 948
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
949

950 951
  AREF (this_command_keys, this_command_key_count) = key;
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
952
}
953

Jim Blandy's avatar
Jim Blandy committed
954 955 956 957

Lisp_Object
recursive_edit_1 ()
{
Juanma Barranquero's avatar
Juanma Barranquero committed
958
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962 963 964 965 966
  Lisp_Object val;

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

967
#ifdef HAVE_X_WINDOWS
968
  /* The command loop has started an hourglass timer, so we have to
969
     cancel it here, otherwise it will fire because the recursive edit
970 971
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
972
    cancel_hourglass ();
973 974
#endif

975 976 977 978 979 980 981 982 983 984 985 986
  /* 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
987 988 989
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
990 991 992 993
  /* 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
994

995
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
996 997 998
}

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

1000
void
Jim Blandy's avatar
Jim Blandy committed
1001 1002
record_auto_save ()
{
1003
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
1004
}
1005 1006 1007

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

Andreas Schwab's avatar
Andreas Schwab committed
1008
void
1009 1010 1011
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
1012 1013

  record_asynch_buffer_change ();
1014
}
Jim Blandy's avatar
Jim Blandy committed
1015 1016

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
1017 1018 1019 1020 1021 1022
       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
1023
{
Juanma Barranquero's avatar
Juanma Barranquero committed
1024
  int count = SPECPDL_INDEX ();
1025
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1026

1027 1028 1029 1030 1031
  /* If we enter while input is blocked, don't lock up here.
     This may happen through the debugger during redisplay.  */
  if (INPUT_BLOCKED_P)
    return Qnil;

Jim Blandy's avatar
Jim Blandy committed
1032 1033 1034
  command_loop_level++;
  update_mode_lines = 1;

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
  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
1045
  record_unwind_protect (recursive_edit_unwind,
1046 1047
			 Fcons (buffer, single_kboard ? Qt : Qnil));

Jim Blandy's avatar
Jim Blandy committed
1048 1049 1050 1051 1052
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object