keyboard.c 374 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, 2010 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 <setjmp.h>
25
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
26 27
#include "termchar.h"
#include "termopts.h"
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30
#include "termhooks.h"
#include "macros.h"
31
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34
#include "window.h"
#include "commands.h"
#include "buffer.h"
35
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
36
#include "disptab.h"
37
#include "dispextern.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
38
#include "syntax.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
39
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
40
#include "keymap.h"
41
#include "blockinput.h"
42
#include "puresize.h"
43 44
#include "systime.h"
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
45 46 47
#include <setjmp.h>
#include <errno.h>

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

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

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

65 66 67 68
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif

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

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

78 79 80 81
#ifdef HAVE_NS
#include "nsterm.h"
#endif

82 83 84
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
85
volatile int interrupt_input_blocked;
86 87 88

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

Chong Yidong's avatar
Chong Yidong committed
91 92 93 94 95
/* 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.  */
96
#ifdef SYNC_INPUT
Chong Yidong's avatar
Chong Yidong committed
97
int pending_signals;
98
#endif
Chong Yidong's avatar
Chong Yidong committed
99

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

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

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

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

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

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

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

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

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

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

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

151 152
extern int message_enable_multibyte;

153 154 155 156 157
/* 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
158
/* Nonzero means do menu prompting.  */
159

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

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

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

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

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

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

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

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

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

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

187
struct kboard *echo_kboard;
188

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

192
Lisp_Object echo_message_buffer;
193

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

int last_auto_save;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

400
Lisp_Object Qecho_area_clear_hook;
401

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

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

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

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

421 422 423
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

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

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

extern char *pending_malloc_warning;

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

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

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

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

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

471 472
extern Lisp_Object Qremap;

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

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

Jim Blandy's avatar
Jim Blandy committed
490 491 492 493
/* Lisp_Object Qmouse_movement; - also an event header */

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

496
/* menu item parts */
497
Lisp_Object Qmenu_enable;
498
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
499
Lisp_Object QCbutton, QCtoggle, QCradio, QClabel;
500
extern Lisp_Object Qmenu_item;
501

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

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

524 525
Lisp_Object recursive_edit_unwind (Lisp_Object buffer), command_loop (void);
Lisp_Object Fthis_command_keys (void);
526
Lisp_Object Qextended_command_history;
527
EMACS_TIME timer_check (int do_it_now);
Jim Blandy's avatar
Jim Blandy committed
528

529
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
530

531 532
static void record_menu_key (Lisp_Object c);
static int echo_length (void);
533

534 535
Lisp_Object Qpolling_period;

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

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

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

545 546
extern Lisp_Object Vprint_level, Vprint_length;

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

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

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

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

583 584 585
Lisp_Object Vdisable_point_adjustment;

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

587 588
Lisp_Object Vglobal_disable_point_adjustment;

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

static EMACS_TIME timer_idleness_start_time;

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

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

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

614 615 616 617 618 619 620 621
static int read_avail_input (int);
static void get_input_pending (int *, int);
static int readable_events (int);
static Lisp_Object read_char_x_menu_prompt (int, Lisp_Object *,
                                            Lisp_Object, int *);
static Lisp_Object read_char_minibuf_menu_prompt (int, int,
                                                  Lisp_Object *);
static Lisp_Object make_lispy_event (struct input_event *);
Nick Roberts's avatar
Nick Roberts committed
622
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
623 624 625 626
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
                                        unsigned long);
627
#endif
628 629 630 631 632 633 634 635 636 637
static Lisp_Object modify_event_symbol (int, unsigned, Lisp_Object,
                                        Lisp_Object, char **,
                                        Lisp_Object *, unsigned);
static Lisp_Object make_lispy_switch_frame (Lisp_Object);
static void save_getcjmp (jmp_buf);
static void restore_getcjmp (jmp_buf);
static Lisp_Object apply_modifiers (int, Lisp_Object);
static void clear_event (struct input_event *);
static Lisp_Object restore_kboard_configuration (Lisp_Object);
static SIGTYPE interrupt_signal (int signalnum);
638
static SIGTYPE input_available_signal (int signo);
639 640 641 642 643 644 645
static void handle_interrupt (void);
static void timer_start_idle (void);
static void timer_stop_idle (void);
static void timer_resume_idle (void);
static SIGTYPE handle_user_signal (int);
static char *find_user_signal_name (int);
static int store_user_signal_events (void);
Jim Blandy's avatar
Jim Blandy committed
646

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

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

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

679
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
680

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

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

693
	  if (size - (ptr - buffer) < nbytes)
694 695
	    {
	      int offset = ptr - buffer;
696
	      size = max (2 * size, size + nbytes);
697 698 699 700
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

701 702
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
703 704
	}

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

711 712 713 714 715 716 717 718 719 720
	  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
721 722
	}

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

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
732 733 734 735

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

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

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

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

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

763
  if (!current_kboard->immediate_echo
764
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
765
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
766

767
  /* Do nothing if we just printed a prompt.  */
768
  if (current_kboard->echo_after_prompt
769
      == SCHARS (current_kboard->echo_string))
770
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
771

772 773 774
  /* Do nothing if we have already put a dash at the end.  */
  if (SCHARS (current_kboard->echo_string) > 1)
    {
775
      Lisp_Object last_char, prev_char, idx;
776

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

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

783 784
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
785 786
    }

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

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

797
void
798
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
799
{
800
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
801 802
    {
      int i;
803
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
804 805

      for (i = 0; i < this_command_key_count; i++)
806 807
	{
	  Lisp_Object c;
808 809 810 811 812 813 814

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

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

      /* 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
828 829 830 831
      echo_dash ();
    }

  echoing = 1;
832
  message3_nolog (current_kboard->echo_string,
833
		  SBYTES (current_kboard->echo_string),
834
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
835 836
  echoing = 0;

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

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

static int
861
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
862
{
863
  return (STRINGP (current_kboard->echo_string)
864
	  ? SCHARS (current_kboard->echo_string)
865
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
866 867 868 869
}

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

static void
873
echo_truncate (int nchars)
874 875 876 877 878 879
{
  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
880 881 882 883 884
}


/* Functions for manipulating this_command_keys.  */
static void
885
add_command_key (Lisp_Object key)
Jim Blandy's avatar
Jim Blandy committed
886
{
887 888
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
889 890 891 892 893
  /* 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;
894 895
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
896 897 898
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
899
#endif
900

901 902 903 904
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
905

906
  ASET (this_command_keys, this_command_key_count, key);
907
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
908
}
909

Jim Blandy's avatar
Jim Blandy committed
910 911

Lisp_Object
912
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
913
{
Juanma Barranquero's avatar
Juanma Barranquero committed
914
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
915 916 917 918 919 920 921 922
  Lisp_Object val;

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

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

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

951
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
952 953 954
}

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

956
void
957