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,
4
                 2005, 2006, 2007, 2008 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 "character.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
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
99

100 101 102 103
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
104
int single_kboard;
105
#else
106
KBOARD the_only_kboard;
107
#endif
108

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

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

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

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

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

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

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

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

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

153 154
extern int message_enable_multibyte;

155 156 157 158 159
/* 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;

160 161 162 163 164
/* 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
165
/* Nonzero means do menu prompting.  */
166

Jim Blandy's avatar
Jim Blandy committed
167 168 169
static int menu_prompting;

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

Jim Blandy's avatar
Jim Blandy committed
171 172 173
static Lisp_Object menu_prompt_more_char;

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

Jim Blandy's avatar
Jim Blandy committed
175 176 177 178 179 180
static jmp_buf getcjmp;

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

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

182
int echoing;
Jim Blandy's avatar
Jim Blandy committed
183

184 185 186 187 188
/* 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;

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

194
struct kboard *echo_kboard;
195

196 197 198
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

199
Lisp_Object echo_message_buffer;
200

201 202 203
/* Nonzero means disregard local maps for the menu bar.  */
static int inhibit_local_menu_bar_menus;

204
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
205 206
int immediate_quit;

207 208 209
/* The user's hook function for outputting an error message.  */
Lisp_Object Vcommand_error_function;

210 211 212
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
213
/* Character to recognize as the help char.  */
214
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
215

Karl Heuer's avatar
Karl Heuer committed
216 217 218
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
219 220 221
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

222 223 224
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

225 226
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
227

228 229 230 231 232 233
/* 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;

234 235 236 237
/* 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
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
/* 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;

259 260 261
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

262 263 264
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

265 266 267 268
/* 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
269 270 271 272
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
273
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
274 275 276 277

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

278 279 280 281
/* 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
282 283 284
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

288 289 290 291 292 293 294 295
/* 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;

296
/* If not -1, an event to be read as subsequent command input.  */
297
EMACS_INT unread_command_char;
298

299 300
/* 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
301
   next command input, after any unread_command_events.
302 303 304 305 306

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

308
/* A mask of extra modifier bits to put into every keyboard char.  */
309
EMACS_INT extra_keyboard_modifiers;
310

Jim Blandy's avatar
Jim Blandy committed
311 312 313 314 315 316 317 318
/* 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;

319
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
320 321 322
static Lisp_Object Vauto_save_timeout;

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

325
/* Total number of times read_char has returned, outside of macros.  */
326
EMACS_INT num_nonmacro_input_events;
327

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

331
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
332

333
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
334 335 336 337

int last_auto_save;

/* The command being executed by the command loop.
338 339
   Commands may set this, and the value set will be copied into
   current_kboard->Vlast_command instead of the actual command.  */
340 341 342 343
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
344

345 346 347 348
/* 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;

349
/* The value of point when the last command was started.  */
350 351
int last_point_position;

352 353 354
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

355 356 357
/* The window that was selected when the last command was started.  */
Lisp_Object last_point_position_window;

358 359 360 361 362 363 364 365 366 367 368 369
/* 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
370 371
/* 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
372 373 374 375 376
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
377
Lisp_Object Qundefined;
378
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382 383

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

384 385 386
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

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

390 391 392 393
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

394 395 396 397
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

398 399 400
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

401 402 403 404 405
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

406
Lisp_Object Qecho_area_clear_hook;
407

408
/* Hooks to run before and after each command.  */
409 410
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
411
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
412

413 414 415
/* Parent keymap of terminal-local function-key-map instances.  */
Lisp_Object Vfunction_key_map;

416
/* Keymap of key translations that can override keymaps.  */
417
Lisp_Object Vkey_translation_map;
418

419 420 421 422 423 424
/* 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;
425
Lisp_Object Qdeferred_action_function;
426

427 428 429
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
430 431 432 433 434 435 436 437
/* File in which we write all commands we read.  */
FILE *dribble;

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

extern char *pending_malloc_warning;

438
/* Circular buffer for pre-read keyboard input.  */
439

440 441 442 443
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.
444
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
445 446 447 448 449 450
   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].  */
451
static struct input_event * volatile kbd_store_ptr;
452 453 454 455

/* 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
456
   there is input available if the two pointers are not equal.
457 458 459 460 461

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

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
469
Lisp_Object Qscroll_bar_movement;
470
Lisp_Object Qswitch_frame;
471
Lisp_Object Qdelete_frame;
472 473
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
Pavel Janík's avatar
Pavel Janík committed
474
Lisp_Object Qselect_window;
475
Lisp_Object Qhelp_echo;
476

Nick Roberts's avatar
Nick Roberts committed
477
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 479 480
Lisp_Object Qmouse_fixup_help_message;
#endif

Jim Blandy's avatar
Jim Blandy committed
481 482 483
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
484
#if defined (WINDOWSNT) || defined (MAC_OS)
485
Lisp_Object Qlanguage_change;
486
#endif
487
Lisp_Object Qdrag_n_drop;
488
Lisp_Object Qsave_session;
489 490 491
#ifdef MAC_OS
Lisp_Object Qmac_apple_event;
#endif
492 493 494
#ifdef HAVE_DBUS
Lisp_Object Qdbus_event;
#endif
Jim Blandy's avatar
Jim Blandy committed
495 496 497 498
/* Lisp_Object Qmouse_movement; - also an event header */

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

501 502
/* menu item parts */
Lisp_Object Qmenu_alias;
503
Lisp_Object Qmenu_enable;
504 505
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
506 507
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
508

509 510 511 512 513 514 515 516 517 518 519 520 521
/* 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;

522
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
523
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
524
Lisp_Object Qvertical_line;
525
Lisp_Object Qvertical_scroll_bar;
526
Lisp_Object Qmenu_bar;
527
extern Lisp_Object Qleft_margin, Qright_margin;
Kenichi Handa's avatar
Kenichi Handa committed
528 529
extern Lisp_Object Qleft_fringe, Qright_fringe;
extern Lisp_Object QCmap;
530

531 532
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
533
Lisp_Object Qextended_command_history;
534
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
535

536
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
537

538 539
extern char *x_get_keysym_name ();

540
static void record_menu_key ();
541
static int echo_length ();
542

543 544
Lisp_Object Qpolling_period;

545
/* List of absolute timers.  Appears in order of next scheduled event.  */
546 547
Lisp_Object Vtimer_list;

548 549 550
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

551 552 553
/* Incremented whenever a timer is run.  */
int timers_run;

554 555
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
556 557 558
/* 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
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573

/* 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
574
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
575 576 577 578 579
#ifdef SIGIO
#undef SIGIO
#endif
#endif

580
/* If we support a window system, turn on the code to poll periodically
581
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
582
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
583 584
#define POLL_FOR_INPUT
#endif
585 586 587 588

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

592 593 594
Lisp_Object Vdisable_point_adjustment;

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

596 597
Lisp_Object Vglobal_disable_point_adjustment;

598 599 600 601
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

602 603 604 605 606
/* 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;

607 608 609 610 611
/* 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
612 613 614

/* Global variable declarations.  */

615 616 617 618 619
/* 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
620 621 622
/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

623 624 625 626 627
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 *));
628
static Lisp_Object read_char_x_menu_prompt ();
629 630 631
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
632
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
633 634 635 636
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
637
#endif
638 639 640 641 642
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));
643
static int parse_solitary_modifier ();
644
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
645
static void save_getcjmp ();
646
static void restore_getcjmp P_ ((jmp_buf));
647
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
648
static void clear_event P_ ((struct input_event *));
649
#ifdef MULTI_KBOARD
650
static Lisp_Object restore_kboard_configuration P_ ((Lisp_Object));
651
#endif
652
static SIGTYPE interrupt_signal P_ ((int signalnum));
653
static void handle_interrupt P_ ((void));
654 655 656
static void timer_start_idle P_ ((void));
static void timer_stop_idle P_ ((void));
static void timer_resume_idle P_ ((void));
657 658 659
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
660

661 662 663
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;
664 665

extern Lisp_Object Qidentity, Qonly;
666

Jim Blandy's avatar
Jim Blandy committed
667 668 669 670
/* 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
671
void
Jim Blandy's avatar
Jim Blandy committed
672
echo_prompt (str)
673
     Lisp_Object str;
Jim Blandy's avatar
Jim Blandy committed
674
{
675
  current_kboard->echo_string = str;
676
  current_kboard->echo_after_prompt = SCHARS (str);
677
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
678 679
}

680
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
681 682 683
   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
684
void
Jim Blandy's avatar
Jim Blandy committed
685 686 687
echo_char (c)
     Lisp_Object c;
{
688
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
689
    {
690 691 692 693
      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
694

695
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
696

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

700
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
701
	{
702
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
703
	}
704
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
705
	{
706 707
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
708

709
	  if (size - (ptr - buffer) < nbytes)
710 711
	    {
	      int offset = ptr - buffer;
712
	      size = max (2 * size, size + nbytes);
713 714 715 716
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

717 718
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
719 720
	}

721
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
722
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
723
	{
724 725
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
726

727 728 729 730 731 732 733 734 735 736
	  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
737 738
	}

739 740
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
741
      if (STRINGP (echo_string)
742
	  && SCHARS (echo_string) > 1)
743
	{
744 745 746 747
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
748 749 750 751

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

752 753 754
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
755 756 757 758
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
759 760
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
761 762 763

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

765
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770 771
    }
}

/* 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
772
void
Jim Blandy's avatar
Jim Blandy committed
773 774
echo_dash ()
{
775 776 777 778
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

779
  if (!current_kboard->immediate_echo
780
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
781
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
782

783
  /* Do nothing if we just printed a prompt.  */
784
  if (current_kboard->echo_after_prompt
785
      == SCHARS (current_kboard->echo_string))
786
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
787

788 789 790
  /* Do nothing if we have already put a dash at the end.  */
  if (SCHARS (current_kboard->echo_string) > 1)
    {
791
      Lisp_Object last_char, prev_char, idx;
792

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

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

799 800
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
801 802
    }

Jim Blandy's avatar
Jim Blandy committed
803 804
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
805 806
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
807
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
808 809 810 811 812
}

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

813
void
814
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
815
{
816
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
817 818
    {
      int i;
819
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
820 821

      for (i = 0; i < this_command_key_count; i++)
822 823
	{
	  Lisp_Object c;
824 825 826 827 828 829 830

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

831 832 833 834 835
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
836 837 838 839 840 841 842 843

      /* 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
844 845 846 847
      echo_dash ();
    }

  echoing = 1;
848
  message3_nolog (current_kboard->echo_string,
849
		  SBYTES (current_kboard->echo_string),
850
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
851 852
  echoing = 0;

853 854 855 856
  /* 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
857 858 859 860 861 862
  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
863
void
Jim Blandy's avatar
Jim Blandy committed
864 865
cancel_echoing ()
{
866 867
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
868
  current_kboard->echo_string = Qnil;
869 870 871
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
872 873 874 875 876 877 878
}

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

static int
echo_length ()
{
879
  return (STRINGP (current_kboard->echo_string)
880
	  ? SCHARS (current_kboard->echo_string)
881
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
882 883 884 885
}

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

static void
889 890 891 892 893 894 895 896
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
897 898 899 900 901 902 903 904
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
905 906
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
907 908 909 910 911
  /* 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;
912 913
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
914 915 916
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
917
#endif
918

919 920 921 922
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
923

924
  ASET (this_command_keys, this_command_key_count, key);
925
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
926
}
927

Jim Blandy's avatar
Jim Blandy committed
928 929 930 931

Lisp_Object
recursive_edit_1 ()
{
Juanma Barranquero's avatar
Juanma Barranquero committed
932
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
933 934 935 936 937 938 939 940
  Lisp_Object val;

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

941
#ifdef HAVE_WINDOW_SYSTEM
942
  /* The command loop has started an hourglass timer, so we have to
943
     cancel it here, otherwise it will fire because the recursive edit
944 945
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
946
    cancel_hourglass ();
947 948
#endif

949 950 951 952 953 954 955 956 957 958 959 960
  /* 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
961 962 963
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
964 965 966
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
967
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
968

969
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
970 971 972
}

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