keyboard.c 366 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,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007 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 3, 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
#include <stdio.h>
26
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
27 28
#include "termchar.h"
#include "termopts.h"
29
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
30 31
#include "termhooks.h"
#include "macros.h"
32
#include "keyboard.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 62
#include "syssignal.h"

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

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

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

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

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

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

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

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

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


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

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

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

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

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

141
#define NUM_RECENT_KEYS (300)
Jim Blandy's avatar
Jim Blandy committed
142 143
int recent_keys_index;	/* Index for storing next element into recent_keys */
int total_keys;		/* Total number of elements stored into recent_keys */
144
Lisp_Object recent_keys; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
Jim Blandy's avatar
Jim Blandy committed
145

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

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

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

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

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

185 186
extern int message_enable_multibyte;

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

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

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

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

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

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

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

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

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

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

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

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

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

228
struct kboard *echo_kboard;
229

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

233
Lisp_Object echo_message_buffer;
234

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

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

241 242 243
/* The user's hook function for outputting an error message.  */
Lisp_Object Vcommand_error_function;

244 245 246
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
247
/* Character to recognize as the help char.  */
248
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
249

Karl Heuer's avatar
Karl Heuer committed
250 251 252
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
253 254 255
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

256 257 258
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

259 260
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
261

262 263 264 265 266 267
/* 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;

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

293 294 295
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

296 297 298
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

299 300 301 302
/* 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
303 304 305 306
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
307
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311

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

312 313 314 315
/* 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
316 317 318
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

322 323 324 325 326 327 328 329
/* 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;

330
/* If not -1, an event to be read as subsequent command input.  */
331
EMACS_INT unread_command_char;
332

333 334
/* 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
335
   next command input, after any unread_command_events.
336 337 338 339 340

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

342
/* A mask of extra modifier bits to put into every keyboard char.  */
343
EMACS_INT extra_keyboard_modifiers;
344

Jim Blandy's avatar
Jim Blandy committed
345 346 347 348 349 350 351 352
/* 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;

353
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
354 355 356
static Lisp_Object Vauto_save_timeout;

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

359
/* Total number of times read_char has returned, outside of macros.  */
360
EMACS_INT num_nonmacro_input_events;
361

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

365
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
366

367
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
368 369 370 371

int last_auto_save;

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

379 380 381 382
/* 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;

383
/* The value of point when the last command was started.  */
384 385
int last_point_position;

386 387 388
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

389 390 391
/* The window that was selected when the last command was started.  */
Lisp_Object last_point_position_window;

392 393 394 395 396 397 398 399 400 401 402 403
/* 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
404 405
/* 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
406 407 408 409 410
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
411
Lisp_Object Qundefined;
412
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417

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

418 419 420
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

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

424 425 426 427
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

428 429 430 431
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

432 433 434
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

435 436 437 438 439
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

440
Lisp_Object Qecho_area_clear_hook;
441

442
/* Hooks to run before and after each command.  */
443 444
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
445
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
446

447 448 449
/* Parent keymap of terminal-local function-key-map instances.  */
Lisp_Object Vfunction_key_map;

450
/* Parent keymap of terminal-local key-translation-map instances.  */
451
Lisp_Object Vkey_translation_map;
452

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

461 462 463
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
464 465 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;

extern char *pending_malloc_warning;

472
/* Circular buffer for pre-read keyboard input.  */
473

474 475 476 477
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.
478
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
479 480 481 482 483 484
   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].  */
485
static struct input_event * volatile kbd_store_ptr;
486 487 488 489

/* 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
Glenn Morris's avatar
Glenn Morris committed
490
   there is input available if the two pointers are not equal.
491 492 493 494 495

   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
496
/* If this flag is non-nil, we check mouse_moved to see when the
497 498
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
499
Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
500 501 502

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
503
Lisp_Object Qscroll_bar_movement;
504
Lisp_Object Qswitch_frame;
505
Lisp_Object Qdelete_frame;
506 507
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
Pavel Janík's avatar
Pavel Janík committed
508
Lisp_Object Qselect_window;
509
Lisp_Object Qhelp_echo;
510

Nick Roberts's avatar
Nick Roberts committed
511
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
512 513 514
Lisp_Object Qmouse_fixup_help_message;
#endif

Jim Blandy's avatar
Jim Blandy committed
515 516 517
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
518
#if defined (WINDOWSNT) || defined (MAC_OS)
519
Lisp_Object Qlanguage_change;
520
#endif
521
Lisp_Object Qdrag_n_drop;
522
Lisp_Object Qsave_session;
523 524 525
#ifdef MAC_OS
Lisp_Object Qmac_apple_event;
#endif
526

Jim Blandy's avatar
Jim Blandy committed
527 528 529 530
/* Lisp_Object Qmouse_movement; - also an event header */

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

533 534
/* menu item parts */
Lisp_Object Qmenu_alias;
535
Lisp_Object Qmenu_enable;
536 537
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
538 539
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
540

541 542 543 544 545 546 547 548 549 550 551 552 553
/* 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;

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

563 564
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
565
Lisp_Object Qextended_command_history;
566
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
567

568
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
569

570 571
extern char *x_get_keysym_name ();

572
static void record_menu_key ();
573
static int echo_length ();
574

575 576
Lisp_Object Qpolling_period;

577
/* List of absolute timers.  Appears in order of next scheduled event.  */
578 579
Lisp_Object Vtimer_list;

580 581 582
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

583 584 585
/* Incremented whenever a timer is run.  */
int timers_run;

586 587
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
588 589 590
/* 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
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

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

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

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

/* We are unable to use interrupts if FIONREAD is not available,
   so flush SIGIO so we won't try.  */
Steven Tamm's avatar
Steven Tamm committed
606
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611
#ifdef SIGIO
#undef SIGIO
#endif
#endif

612
/* If we support a window system, turn on the code to poll periodically
613
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
614
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
615 616
#define POLL_FOR_INPUT
#endif
617 618 619 620

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

624 625 626
Lisp_Object Vdisable_point_adjustment;

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

628 629
Lisp_Object Vglobal_disable_point_adjustment;

630 631 632 633
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

634 635 636 637 638
/* 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;

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

647 648 649 650 651
/* 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
652 653 654
/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

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

693 694 695 696
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;

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

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

727
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
728

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

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

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

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

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

759 760 761 762 763 764 765 766 767 768
	  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
769 770
	}

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

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
780 781 782 783

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

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

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

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

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

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

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

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

820 821 822
  /* Do nothing if we have already put a dash at the end.  */
  if (SCHARS (current_kboard->echo_string) > 1)
    {
823
      Lisp_Object last_char, prev_char, idx;
824

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

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

831 832
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
833 834
    }

Jim Blandy's avatar
Jim Blandy committed
835 836
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
837 838
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
839
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
840 841 842 843 844
}

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

845
void
846
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
847
{
848
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
849 850
    {
      int i;
851
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
852 853

      for (i = 0; i < this_command_key_count; i++)
854 855
	{
	  Lisp_Object c;
856 857 858 859 860 861 862

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

863 864 865 866 867
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
868 869 870 871 872 873 874 875

      /* 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
876 877 878 879
      echo_dash ();
    }

  echoing = 1;
880
  message3_nolog (current_kboard->echo_string,
881
		  SBYTES (current_kboard->echo_string),
882
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
883 884
  echoing = 0;

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

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

static int
echo_length ()
{
911
  return (STRINGP (current_kboard->echo_string)
912
	  ? SCHARS (current_kboard->echo_string)
913
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
914 915 916 917
}

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

static void
921 922 923 924 925 926 927 928
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
929 930 931 932 933 934 935 936
}

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

951 952 953 954
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
955

956 957
  AREF (this_command_keys, this_command_key_count) = key;
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
958
}
959

Jim Blandy's avatar
Jim Blandy committed
960 961 962 963

Lisp_Object
recursive_edit_1 ()
{
Juanma Barranquero's avatar
Juanma Barranquero committed
964
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
965 966 967 968 969 970 971 972
  Lisp_Object val;

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

973
#ifdef HAVE_X_WINDOWS
974
  /* The command loop has started an hourglass timer, so we have to
975
     cancel it here, otherwise it will fire because the recursive edit
976 977
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */