keyboard.c 340 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
                 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4
                 2005, 2006 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

23
#include <config.h>
24
#include <signal.h>
Jim Blandy's avatar
Jim Blandy committed
25 26 27 28 29 30
#include <stdio.h>
#include "termchar.h"
#include "termopts.h"
#include "lisp.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
#ifdef HAVE_GTK_AND_PTHREAD
#include <pthread.h>
#endif
52 53 54 55
#ifdef MSDOS
#include "msdos.h"
#include <time.h>
#else /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
56 57 58
#ifndef VMS
#include <sys/ioctl.h>
#endif
59
#endif /* not MSDOS */
Jim Blandy's avatar
Jim Blandy committed
60

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

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

69 70 71 72
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif

73 74 75 76 77
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

78 79 80 81
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

82
#ifdef MAC_OS
83 84 85
#include "macterm.h"
#endif

86
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
87
extern int errno;
88
#endif
Jim Blandy's avatar
Jim Blandy committed
89

90 91 92
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
93
int interrupt_input_blocked;
94 95 96

/* Nonzero means an input interrupt has arrived
   during the current critical section.  */
97
int interrupt_input_pending;
98 99


100 101
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
102

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

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

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

132 133 134 135
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
136
int single_kboard;
137
#else
138
KBOARD the_only_kboard;
139
#endif
140

Jim Blandy's avatar
Jim Blandy committed
141
/* Non-nil disable property on a command means
142 143
   do not execute it; call disabled-command-function's value instead.  */
Lisp_Object Qdisabled, Qdisabled_command_function;
Jim Blandy's avatar
Jim Blandy committed
144 145 146 147

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

150 151 152 153 154 155 156
/* 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
157

158 159 160 161
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
int this_command_key_count_reset;

162 163 164 165 166 167
/* 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							\
168
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
169 170 171 172 173 174 175 176 177
  {									\
    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;							\
  }

178 179 180 181
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

182 183 184 185 186
/* 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
187 188
extern int minbuf_level;

189 190
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
191 192
extern struct backtrace *backtrace_list;

193 194 195 196 197
/* 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;

198 199 200 201 202
/* 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
203
/* Nonzero means do menu prompting.  */
204

Jim Blandy's avatar
Jim Blandy committed
205 206 207
static int menu_prompting;

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

Jim Blandy's avatar
Jim Blandy committed
209 210 211
static Lisp_Object menu_prompt_more_char;

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

Jim Blandy's avatar
Jim Blandy committed
213 214 215 216 217 218
static jmp_buf getcjmp;

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

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

220
int echoing;
Jim Blandy's avatar
Jim Blandy committed
221

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

227 228 229 230
/* 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.  */
231

232
struct kboard *echo_kboard;
233

234 235 236
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

237
Lisp_Object echo_message_buffer;
238

239 240 241
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

242
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
243 244
int immediate_quit;

245 246 247
/* The user's hook function for outputting an error message.  */
Lisp_Object Vcommand_error_function;

248 249 250
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
251
/* Character to recognize as the help char.  */
252
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
253

Karl Heuer's avatar
Karl Heuer committed
254 255 256
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
257 258 259
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

260 261 262
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

263 264
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
265

266 267 268 269 270 271
/* 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;

272 273 274 275
/* 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
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
/* 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;

297 298 299
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

300 301 302
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

303 304 305 306
/* 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
307 308 309 310
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
311
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
312 313 314 315

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

316 317 318 319
/* 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
320 321 322
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

326 327 328 329 330 331 332 333
/* 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;

334
/* If not -1, an event to be read as subsequent command input.  */
335
EMACS_INT unread_command_char;
336

337 338
/* 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
339
   next command input, after any unread_command_events.
340 341 342 343 344

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

346
/* A mask of extra modifier bits to put into every keyboard char.  */
347
EMACS_INT extra_keyboard_modifiers;
348

Jim Blandy's avatar
Jim Blandy committed
349 350 351 352 353 354 355 356
/* 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;

357
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
358 359 360
static Lisp_Object Vauto_save_timeout;

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

363
/* Total number of times read_char has returned, outside of macros.  */
364
EMACS_INT num_nonmacro_input_events;
365

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

369
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
370

371
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375

int last_auto_save;

/* The command being executed by the command loop.
376 377
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
378 379 380 381
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
382

383 384 385 386
/* 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;

387
/* The value of point when the last command was started.  */
388 389
int last_point_position;

390 391 392
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

393 394 395
/* The window that was selected when the last command was started.  */
Lisp_Object last_point_position_window;

396 397 398 399 400 401 402 403 404 405 406 407
/* 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
408 409
/* 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
410 411 412 413 414
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
415
Lisp_Object Qundefined;
416
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420 421

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

422 423 424
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

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

428
/* User-supplied table to translate input characters.  */
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433
Lisp_Object Vkeyboard_translate_table;

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

434 435 436
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
437

438 439 440 441
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

442 443 444 445
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

446 447 448
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

449 450 451 452 453
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

454
Lisp_Object Qecho_area_clear_hook;
455

456
/* Hooks to run before and after each command.  */
457 458
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
459
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
460

461 462 463 464 465 466
/* 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;
467
Lisp_Object Qdeferred_action_function;
468

469 470 471
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
472 473 474 475 476 477
/* File in which we write all commands we read.  */
FILE *dribble;

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

478 479 480
/* 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
481 482 483 484
int meta_key;

extern char *pending_malloc_warning;

485
/* Circular buffer for pre-read keyboard input.  */
486

487 488 489 490
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.
491
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
492 493 494 495 496 497
   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].  */
498
static struct input_event * volatile kbd_store_ptr;
499 500 501 502 503 504 505 506 507 508

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

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

524 525 526 527
#ifdef HAVE_MOUSE
Lisp_Object Qmouse_fixup_help_message;
#endif

Jim Blandy's avatar
Jim Blandy committed
528 529 530
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
531
#if defined (WINDOWSNT) || defined (MAC_OS)
532
Lisp_Object Qlanguage_change;
533
#endif
534
Lisp_Object Qdrag_n_drop;
535
Lisp_Object Qsave_session;
536 537 538
#ifdef MAC_OS
Lisp_Object Qmac_apple_event;
#endif
539

Jim Blandy's avatar
Jim Blandy committed
540 541 542 543
/* Lisp_Object Qmouse_movement; - also an event header */

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

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

554 555 556 557 558 559 560 561 562 563 564 565 566
/* 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;

567
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
568
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
569
Lisp_Object Qvertical_line;
570
Lisp_Object Qvertical_scroll_bar;
571
Lisp_Object Qmenu_bar;
572
extern Lisp_Object Qleft_margin, Qright_margin;
573
extern Lisp_Object Qleft_fringe, Qright_fringe;
574
extern Lisp_Object QCmap;
575

576 577
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
578
Lisp_Object Qextended_command_history;
579
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
580

581
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
582

583 584
extern char *x_get_keysym_name ();

585
static void record_menu_key ();
586
static int echo_length ();
587

588 589
Lisp_Object Qpolling_period;

590
/* List of absolute timers.  Appears in order of next scheduled event.  */
591 592
Lisp_Object Vtimer_list;

593 594 595
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

596 597 598
/* Incremented whenever a timer is run.  */
int timers_run;

599 600
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
601 602 603
/* 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
604 605 606 607 608 609 610 611

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

612
/* Nonzero means use ^S/^Q for flow control.  */
Jim Blandy's avatar
Jim Blandy committed
613 614 615 616 617 618 619 620 621
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
622
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
623 624 625 626 627
#ifdef SIGIO
#undef SIGIO
#endif
#endif

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

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

640 641 642
Lisp_Object Vdisable_point_adjustment;

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

644 645
Lisp_Object Vglobal_disable_point_adjustment;

646 647 648 649
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

650 651 652 653 654
/* 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;

655 656 657 658 659
/* If non-nil, events produced by disabled menu items and tool-bar
   buttons are not ignored.  Help functions bind this to allow help on
   those items and buttons.  */
Lisp_Object Venable_disabled_menus_and_buttons;

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

663 664 665 666 667
/* 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
668 669 670
/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

671 672 673 674 675
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 *));
676
static Lisp_Object read_char_x_menu_prompt ();
677 678 679
static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
						      Lisp_Object *));
static Lisp_Object make_lispy_event P_ ((struct input_event *));
680
#ifdef HAVE_MOUSE
681 682 683 684
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
685
#endif
686 687 688 689 690
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));
691
static int parse_solitary_modifier ();
692
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
693
static void save_getcjmp ();
694
static void restore_getcjmp P_ ((jmp_buf));
695
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
696
static void clear_event P_ ((struct input_event *));
697
static void any_kboard_state P_ ((void));
698
static SIGTYPE interrupt_signal P_ ((int signalnum));
699 700 701
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
702

703 704 705 706
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;

707 708
extern Lisp_Object Qidentity, Qonly;

Jim Blandy's avatar
Jim Blandy committed
709 710 711 712
/* 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
713
void
Jim Blandy's avatar
Jim Blandy committed
714
echo_prompt (str)
715
     Lisp_Object str;
Jim Blandy's avatar
Jim Blandy committed
716
{
717
  current_kboard->echo_string = str;
718
  current_kboard->echo_after_prompt = SCHARS (str);
719
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
720 721
}

722
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
723 724 725
   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
726
void
Jim Blandy's avatar
Jim Blandy committed
727 728 729
echo_char (c)
     Lisp_Object c;
{
730
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
731
    {
732 733 734 735
      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
736

737
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
738

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

742
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
743
	{
744
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
745
	}
746
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
747
	{
748 749
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
750

751
	  if (size - (ptr - buffer) < nbytes)
752 753
	    {
	      int offset = ptr - buffer;
754
	      size = max (2 * size, size + nbytes);
755 756 757 758
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

759 760
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
761 762
	}

763
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
764
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
765
	{
766 767
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
768

769 770 771 772 773 774 775 776 777 778
	  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
779 780
	}

781 782
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
783
      if (STRINGP (echo_string)
784
	  && SCHARS (echo_string) > 1)
785
	{
786 787 788 789
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
790 791 792 793

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

794 795 796
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
797 798 799 800
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
801 802
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
803 804 805

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

807
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
808 809 810 811 812 813
    }
}

/* 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
814
void
Jim Blandy's avatar
Jim Blandy committed
815 816
echo_dash ()
{
817 818 819 820
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

821
  if (!current_kboard->immediate_echo
822
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
823
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
824

825
  /* Do nothing if we just printed a prompt.  */
826
  if (current_kboard->echo_after_prompt
827
      == SCHARS (current_kboard->echo_string))
828
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
829

830 831 832
  /* Do nothing if we have already put a dash at the end.  */
  if (SCHARS (current_kboard->echo_string) > 1)
    {
833
      Lisp_Object last_char, prev_char, idx;
834

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

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

841 842
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
843 844
    }

Jim Blandy's avatar
Jim Blandy committed
845 846
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
847 848
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
849
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
850 851 852 853 854
}

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

855
void
856
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
857
{
858
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
859 860
    {
      int i;
861
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
862 863

      for (i = 0; i < this_command_key_count; i++)
864 865
	{
	  Lisp_Object c;
866 867 868 869 870 871 872

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

873 874 875 876 877
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
878 879 880 881 882 883 884 885

      /* 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
886 887 888 889
      echo_dash ();
    }

  echoing = 1;
890
  message3_nolog (current_kboard->echo_string,
891
		  SBYTES (current_kboard->echo_string),
892
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
893 894
  echoing = 0;

895 896 897 898
  /* 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
899 900 901 902 903 904
  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
905
void
Jim Blandy's avatar
Jim Blandy committed
906 907
cancel_echoing ()
{
908 909
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
910
  current_kboard->echo_string = Qnil;
911 912 913
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
914 915 916 917 918 919 920
}

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

static int
echo_length ()
{
921
  return (STRINGP (current_kboard->echo_string)
922
	  ? SCHARS (current_kboard->echo_string)
923
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
924 925 926 927
}

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

static void
931 932 933 934 935 936 937 938
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
939 940 941 942 943 944 945 946
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
947 948
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
949 950 951 952 953
  /* 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;
954 955
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
956 957 958
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
959
#endif
960

961 962 963 964
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
965

966 967
  AREF (this_command_keys, this_command_key_count) = key;
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
968
}
969

Jim Blandy's avatar
Jim Blandy committed
970 971 972 973

Lisp_Object
recursive_edit_1 ()
{
Juanma Barranquero's avatar
Juanma Barranquero committed
974
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978 979 980 981 982
  Lisp_Object val;

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

983
#ifdef HAVE_X_WINDOWS
984
  /* The command loop has started an hourglass timer, so we have to
985
     cancel it here, otherwise it will fire because the recursive edit
986 987
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
988
    cancel_hourglass ();
989 990
#endif

991 992 993 994 995 996 997 998 999 1000 1001 1002
  /* 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
1003 1004 1005
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
1006 1007 1008 1009
  /* 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
1010

1011
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014
}

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

1016
void
Jim Blandy's avatar
Jim Blandy committed
1017 1018
record_auto_save ()
{
1019
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
1020
}
1021 1022 1023

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

Andreas Schwab's avatar
Andreas Schwab committed
1024
void
1025 1026 1027
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
1028 1029

  record_asynch_buffer_change ();
1030
}
Jim Blandy's avatar
Jim Blandy committed
1031 1032

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
1033 1034 1035
       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.
Juanma Barranquero's avatar