keyboard.c 372 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, 2008, 2009 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

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

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

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

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

64 65 66 67
#ifdef HAVE_FCNTL_H
#include <fcntl.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 78 79 80
#ifdef HAVE_NS
#include "nsterm.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
volatile 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

Chong Yidong's avatar
Chong Yidong committed
94 95 96 97 98 99 100
/* This var should be (interrupt_input_pending || pending_atimers).
   The QUIT macro checks this instead of interrupt_input_pending and
   pending_atimers separately, to reduce code size.  So, any code that
   changes interrupt_input_pending or pending_atimers should update
   this too.  */
int pending_signals;

101
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
102

103 104 105
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
106
int single_kboard;
107

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

112
#define NUM_RECENT_KEYS (300)
Jim Blandy's avatar
Jim Blandy committed
113 114
int recent_keys_index;	/* Index for storing next element into recent_keys */
int total_keys;		/* Total number of elements stored into recent_keys */
115
Lisp_Object recent_keys; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
Jim Blandy's avatar
Jim Blandy committed
116

117 118 119 120 121 122 123
/* 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
124

125 126 127 128
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
int this_command_key_count_reset;

129 130 131 132 133
/* 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;

134 135 136
/* Non-nil if the present key sequence was obtained by shift translation.  */
Lisp_Object Vthis_command_keys_shift_translated;

137
#define GROW_RAW_KEYBUF							\
138
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
139
   raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil)  \
140

141 142 143 144
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

145 146 147 148 149
/* 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
150 151
extern int minbuf_level;

152 153
extern int message_enable_multibyte;

154 155 156 157 158
/* If non-nil, the function that implements the display of help.
   It's called with one argument, the help string to display.  */

Lisp_Object Vshow_help_function;

Jim Blandy's avatar
Jim Blandy committed
159
/* Nonzero means do menu prompting.  */
160

Jim Blandy's avatar
Jim Blandy committed
161 162 163
static int menu_prompting;

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

Jim Blandy's avatar
Jim Blandy committed
165 166 167
static Lisp_Object menu_prompt_more_char;

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

Jim Blandy's avatar
Jim Blandy committed
169 170 171 172 173 174
static jmp_buf getcjmp;

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

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

176
int echoing;
Jim Blandy's avatar
Jim Blandy committed
177

178 179 180 181 182
/* 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;

183 184 185 186
/* 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.  */
187

188
struct kboard *echo_kboard;
189

190 191 192
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

193
Lisp_Object echo_message_buffer;
194

195 196 197
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

198
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
199 200
int immediate_quit;

201 202 203
/* The user's hook function for outputting an error message.  */
Lisp_Object Vcommand_error_function;

204 205 206
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
207
/* Character to recognize as the help char.  */
208
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
209

Karl Heuer's avatar
Karl Heuer committed
210 211 212
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
213 214 215
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

216 217 218
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

219 220
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
221

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

228 229 230 231
/* 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
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
/* 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;

253 254 255
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

256 257 258
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

259 260 261 262
/* 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
263 264 265 266
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
267
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
268

269 270
/* Last input event read as a command.  */
Lisp_Object last_command_event;
Jim Blandy's avatar
Jim Blandy committed
271

272 273 274 275
/* Last input character read as a command, not counting menus
   reached by the mouse.  */
Lisp_Object last_nonmenu_event;

276 277
/* Last input event read for any purpose.  */
Lisp_Object last_input_event;
Jim Blandy's avatar
Jim Blandy committed
278

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

282 283 284 285 286 287 288 289
/* 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;

290
/* If not -1, an event to be read as subsequent command input.  */
291
EMACS_INT unread_command_char;
292

293 294
/* 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
295
   next command input, after any unread_command_events.
296 297 298 299 300

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

302
/* A mask of extra modifier bits to put into every keyboard char.  */
303
EMACS_INT extra_keyboard_modifiers;
304

Jim Blandy's avatar
Jim Blandy committed
305 306 307 308 309 310 311 312
/* 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;

313
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
314 315 316
static Lisp_Object Vauto_save_timeout;

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

319
/* Total number of times read_char has returned, outside of macros.  */
320
EMACS_INT num_nonmacro_input_events;
321

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

325
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
326

327
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
328 329 330 331

int last_auto_save;

/* The command being executed by the command loop.
332 333
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
334 335 336 337
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
338

339 340 341 342
/* 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;

343
/* The value of point when the last command was started.  */
344 345
int last_point_position;

346 347 348
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

349 350 351
/* The window that was selected when the last command was started.  */
Lisp_Object last_point_position_window;

352 353 354 355 356 357 358 359 360 361 362 363
/* 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
364 365
/* 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
366 367 368 369 370
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
371
Lisp_Object Qundefined;
372
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
373 374 375 376 377

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

378 379 380
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

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

384 385 386 387
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

388 389 390 391
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

392 393
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;
Stefan Monnier's avatar
Stefan Monnier committed
394
Lisp_Object Qdeactivate_mark;
395

396 397 398 399 400
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

401
Lisp_Object Qecho_area_clear_hook;
402

403
/* Hooks to run before and after each command.  */
404 405
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
406
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
407

408 409 410
/* Parent keymap of terminal-local function-key-map instances.  */
Lisp_Object Vfunction_key_map;

411
/* Keymap of key translations that can override keymaps.  */
412
Lisp_Object Vkey_translation_map;
413

414 415 416 417 418 419
/* 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;
420
Lisp_Object Qdeferred_action_function;
421

422 423 424
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
425 426 427 428 429 430 431 432
/* File in which we write all commands we read.  */
FILE *dribble;

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

extern char *pending_malloc_warning;

433
/* Circular buffer for pre-read keyboard input.  */
434

435 436 437 438
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.
439
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
440 441 442 443 444 445
   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].  */
446
static struct input_event * volatile kbd_store_ptr;
447 448 449 450

/* 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
451
   there is input available if the two pointers are not equal.
452 453 454 455 456

   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
457
/* If this flag is non-nil, we check mouse_moved to see when the
458 459
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
460
Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
461 462 463

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
464
Lisp_Object Qscroll_bar_movement;
465
Lisp_Object Qswitch_frame;
466
Lisp_Object Qdelete_frame;
467 468
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
Pavel Janík's avatar
Pavel Janík committed
469
Lisp_Object Qselect_window;
470
Lisp_Object Qhelp_echo;
471

Nick Roberts's avatar
Nick Roberts committed
472
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
473 474 475
Lisp_Object Qmouse_fixup_help_message;
#endif

Jim Blandy's avatar
Jim Blandy committed
476 477 478
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
479
#if defined (WINDOWSNT)
480
Lisp_Object Qlanguage_change;
481
#endif
482
Lisp_Object Qdrag_n_drop;
483
Lisp_Object Qsave_session;
484 485 486
#ifdef HAVE_DBUS
Lisp_Object Qdbus_event;
#endif
Jim Blandy's avatar
Jim Blandy committed
487 488 489 490
/* Lisp_Object Qmouse_movement; - also an event header */

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

493 494
/* menu item parts */
Lisp_Object Qmenu_alias;
495
Lisp_Object Qmenu_enable;
496 497
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
498 499
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
500

501 502 503 504 505 506 507 508 509 510 511 512 513
/* 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;

514
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
515
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
516
Lisp_Object Qvertical_line;
517
Lisp_Object Qvertical_scroll_bar;
518
Lisp_Object Qmenu_bar;
519
extern Lisp_Object Qleft_margin, Qright_margin;
Kenichi Handa's avatar
Kenichi Handa committed
520 521
extern Lisp_Object Qleft_fringe, Qright_fringe;
extern Lisp_Object QCmap;
522

523 524
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
525
Lisp_Object Qextended_command_history;
526
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
527

528
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
529

530 531
extern char *x_get_keysym_name ();

532
static void record_menu_key ();
533
static int echo_length ();
534

535 536
Lisp_Object Qpolling_period;

537
/* List of absolute timers.  Appears in order of next scheduled event.  */
538 539
Lisp_Object Vtimer_list;

540 541 542
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

543 544 545
/* Incremented whenever a timer is run.  */
int timers_run;

546 547
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
548 549 550
/* 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
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

/* 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
566
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
567 568 569 570 571
#ifdef SIGIO
#undef SIGIO
#endif
#endif

572
/* If we support a window system, turn on the code to poll periodically
573
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
574
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
575 576
#define POLL_FOR_INPUT
#endif
577 578 579 580

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

584 585 586
Lisp_Object Vdisable_point_adjustment;

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

588 589
Lisp_Object Vglobal_disable_point_adjustment;

590 591 592 593
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

594 595 596 597 598
/* 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;

599 600 601 602 603
/* 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
604 605 606

/* Global variable declarations.  */

607 608 609 610 611
/* 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
612 613 614
/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

615 616 617 618 619
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 *));
620
static Lisp_Object read_char_x_menu_prompt ();
621 622 623
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
624
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
625 626 627 628
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
629
#endif
630 631 632 633 634
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 void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
635
static void save_getcjmp ();
636
static void restore_getcjmp P_ ((jmp_buf));
637
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
638
static void clear_event P_ ((struct input_event *));
639
static Lisp_Object restore_kboard_configuration P_ ((Lisp_Object));
640
static SIGTYPE interrupt_signal P_ ((int signalnum));
641
static void handle_interrupt P_ ((void));
642 643 644
static void timer_start_idle P_ ((void));
static void timer_stop_idle P_ ((void));
static void timer_resume_idle P_ ((void));
645 646 647
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
648

649 650 651
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;
652 653

extern Lisp_Object Qidentity, Qonly;
654

Jim Blandy's avatar
Jim Blandy committed
655 656 657 658
/* 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
659
void
Jim Blandy's avatar
Jim Blandy committed
660
echo_prompt (str)
661
     Lisp_Object str;
Jim Blandy's avatar
Jim Blandy committed
662
{
663
  current_kboard->echo_string = str;
664
  current_kboard->echo_after_prompt = SCHARS (str);
665
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
666 667
}

668
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
669 670 671
   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
672
void
Jim Blandy's avatar
Jim Blandy committed
673 674 675
echo_char (c)
     Lisp_Object c;
{
676
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
677
    {
678 679 680 681
      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
682

683
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
684

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

688
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
689
	{
690
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
691
	}
692
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
693
	{
694 695
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
696

697
	  if (size - (ptr - buffer) < nbytes)
698 699
	    {
	      int offset = ptr - buffer;
700
	      size = max (2 * size, size + nbytes);
701 702 703 704
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

705 706
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
707 708
	}

709
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
710
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
711
	{
712 713
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
714

715 716 717 718 719 720 721 722 723 724
	  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
725 726
	}

727 728
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
729
      if (STRINGP (echo_string)
730
	  && SCHARS (echo_string) > 1)
731
	{
732 733 734 735
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
736 737 738 739

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

740 741 742
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
743 744 745 746
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
747 748
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
749 750 751

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

753
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
754 755 756 757 758 759
    }
}

/* 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
760
void
Jim Blandy's avatar
Jim Blandy committed
761 762
echo_dash ()
{
763 764 765 766
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

767
  if (!current_kboard->immediate_echo
768
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
769
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
770

771
  /* Do nothing if we just printed a prompt.  */
772
  if (current_kboard->echo_after_prompt
773
      == SCHARS (current_kboard->echo_string))
774
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
775

776 777 778
  /* Do nothing if we have already put a dash at the end.  */
  if (SCHARS (current_kboard->echo_string) > 1)
    {
779
      Lisp_Object last_char, prev_char, idx;
780

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

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

787 788
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
789 790
    }

Jim Blandy's avatar
Jim Blandy committed
791 792
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
793 794
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
795
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
796 797 798 799 800
}

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

801
void
802
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
803
{
804
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
805 806
    {
      int i;
807
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
808 809

      for (i = 0; i < this_command_key_count; i++)
810 811
	{
	  Lisp_Object c;
812 813 814 815 816 817 818

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

819 820 821 822 823
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
824 825 826 827 828 829 830 831

      /* 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
832 833 834 835
      echo_dash ();
    }

  echoing = 1;
836
  message3_nolog (current_kboard->echo_string,
837
		  SBYTES (current_kboard->echo_string),
838
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
839 840
  echoing = 0;

841 842 843 844
  /* 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
845 846 847 848 849 850
  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
851
void
Jim Blandy's avatar
Jim Blandy committed
852 853
cancel_echoing ()
{
854 855
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
856
  current_kboard->echo_string = Qnil;
857 858 859
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
860 861 862 863 864 865 866
}

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

static int
echo_length ()
{
867
  return (STRINGP (current_kboard->echo_string)
868
	  ? SCHARS (current_kboard->echo_string)
869
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873
}

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

static void
877 878 879 880 881 882 883 884
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
885 886 887 888 889 890 891 892
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
893 894
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
895 896 897 898 899
  /* 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;
900 901
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
902 903 904
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
905
#endif
906

907 908 909 910
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
911

912
  ASET (this_command_keys, this_command_key_count, key);
913
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
914
}
915

Jim Blandy's avatar
Jim Blandy committed
916 917 918 919

Lisp_Object
recursive_edit_1 ()
{
Juanma Barranquero's avatar
Juanma Barranquero committed
920
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
921 922 923 924 925 926 927 928
  Lisp_Object val;

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

929
#ifdef HAVE_WINDOW_SYSTEM
930
  /* The command loop has started an hourglass timer, so we have to
931
     cancel it here, otherwise it will fire because the recursive edit
932 933
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
934
    cancel_hourglass ();
935 936
#endif

937 938 939 940 941 942 943 944 945 946 947 948
  /* 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
949 950 951
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
952 953 954
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
955
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
956

957
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
958 959 960
}

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

962
void
Jim Blandy's avatar
Jim Blandy committed
963 964
record_auto_save ()
{
965
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
966
}