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, 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"
45
#include "process.h"
Jim Blandy's avatar
Jim Blandy committed
46 47
#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
/* 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;

249 250 251
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

252 253 254
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

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

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

265 266
/* Last input event read as a command.  */
Lisp_Object last_command_event;
Jim Blandy's avatar
Jim Blandy committed
267

268 269 270 271
/* Last input character read as a command, not counting menus
   reached by the mouse.  */
Lisp_Object last_nonmenu_event;

272 273
/* Last input event read for any purpose.  */
Lisp_Object last_input_event;
Jim Blandy's avatar
Jim Blandy committed
274

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

278 279 280 281 282 283 284 285
/* 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;

286
/* If not -1, an event to be read as subsequent command input.  */
287
EMACS_INT unread_command_char;
288

289 290
/* 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
291
   next command input, after any unread_command_events.
292 293 294 295 296

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

298
/* A mask of extra modifier bits to put into every keyboard char.  */
299
EMACS_INT extra_keyboard_modifiers;
300

Jim Blandy's avatar
Jim Blandy committed
301 302 303 304 305 306 307 308
/* 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;

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

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

315
/* Total number of times read_char has returned, outside of macros.  */
316
EMACS_INT num_nonmacro_input_events;
317

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

321
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
322

323
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327

int last_auto_save;

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

335 336 337 338
/* 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;

339
/* The value of point when the last command was started.  */
340 341
int last_point_position;

342 343 344
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

345 346 347
/* The window that was selected when the last command was started.  */
Lisp_Object last_point_position_window;

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

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
367
Lisp_Object Qundefined;
368
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
369 370 371 372 373

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

374 375 376
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

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

380 381 382 383
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

384 385 386 387
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

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

392 393 394 395 396
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

397
Lisp_Object Qecho_area_clear_hook;
398

399
/* Hooks to run before and after each command.  */
400 401
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
402
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
403

404 405 406
/* Parent keymap of terminal-local function-key-map instances.  */
Lisp_Object Vfunction_key_map;

407
/* Keymap of key translations that can override keymaps.  */
408
Lisp_Object Vkey_translation_map;
409

410 411 412 413 414 415
/* 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;
416
Lisp_Object Qdeferred_action_function;
417

418 419 420
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

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

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

extern char *pending_malloc_warning;

429
/* Circular buffer for pre-read keyboard input.  */
430

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

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

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

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

Nick Roberts's avatar
Nick Roberts committed
468
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
469 470 471
Lisp_Object Qmouse_fixup_help_message;
#endif

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

Jim Blandy's avatar
Jim Blandy committed
485 486 487 488
/* Lisp_Object Qmouse_movement; - also an event header */

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

491
/* menu item parts */
492
Lisp_Object Qmenu_enable;
493
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
494
Lisp_Object QCbutton, QCtoggle, QCradio, QClabel;
495

496 497 498 499 500 501 502 503 504 505 506 507 508
/* 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;

509
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
510
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
511
Lisp_Object Qvertical_line;
512
Lisp_Object Qvertical_scroll_bar;
513 514
Lisp_Object Qmenu_bar;

515 516
Lisp_Object recursive_edit_unwind (Lisp_Object buffer), command_loop (void);
Lisp_Object Fthis_command_keys (void);
517
Lisp_Object Qextended_command_history;
518
EMACS_TIME timer_check (int do_it_now);
Jim Blandy's avatar
Jim Blandy committed
519

520 521
static void record_menu_key (Lisp_Object c);
static int echo_length (void);
522

523 524
Lisp_Object Qpolling_period;

525
/* List of absolute timers.  Appears in order of next scheduled event.  */
526 527
Lisp_Object Vtimer_list;

528 529 530
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

531 532 533
/* Incremented whenever a timer is run.  */
int timers_run;

Jim Blandy's avatar
Jim Blandy committed
534 535 536
/* 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
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551

/* 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
552
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
553 554 555 556 557
#ifdef SIGIO
#undef SIGIO
#endif
#endif

558
/* If we support a window system, turn on the code to poll periodically
559
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
560
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
561 562
#define POLL_FOR_INPUT
#endif
563 564 565 566

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

570 571 572
Lisp_Object Vdisable_point_adjustment;

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

574 575
Lisp_Object Vglobal_disable_point_adjustment;

576 577 578 579
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

580 581 582 583 584
/* 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;

585 586 587 588 589
/* 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
590 591 592

/* Global variable declarations.  */

593 594 595 596 597
/* 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
598
/* Function for init_keyboard to call with no args (if nonzero).  */
599
void (*keyboard_init_hook) (void);
Jim Blandy's avatar
Jim Blandy committed
600

601 602 603 604 605 606 607 608
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
609
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
610 611 612 613
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
                                        unsigned long);
614
#endif
615
static Lisp_Object modify_event_symbol (int, unsigned, Lisp_Object,
616
                                        Lisp_Object, const char **,
617 618 619 620 621 622 623 624
                                        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);
625
#ifdef SIGIO
626
static SIGTYPE input_available_signal (int signo);
627
#endif
628 629 630 631 632 633 634
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
635

636 637 638
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;
639

640

Jim Blandy's avatar
Jim Blandy committed
641 642 643 644
/* 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
645
void
646
echo_prompt (Lisp_Object str)
Jim Blandy's avatar
Jim Blandy committed
647
{
648
  current_kboard->echo_string = str;
649
  current_kboard->echo_after_prompt = SCHARS (str);
650
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
651 652
}

653
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
654 655 656
   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
657
void
658
echo_char (Lisp_Object c)
Jim Blandy's avatar
Jim Blandy committed
659
{
660
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
661
    {
662 663 664 665
      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
666

667
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
668

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

672
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
673
	{
674
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
675
	}
676
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
677
	{
678 679
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
680

681
	  if (size - (ptr - buffer) < nbytes)
682 683
	    {
	      int offset = ptr - buffer;
684
	      size = max (2 * size, size + nbytes);
685 686 687 688
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

689 690
	  ptr += copy_text (SDATA (name), ptr, nbytes,
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
691 692
	}

693
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
694
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
695
	{
696 697
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
698

699 700 701 702 703 704 705 706
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

707
	  memcpy (ptr, text, len);
708
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
709 710
	}

711 712
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
713
      if (STRINGP (echo_string)
714
	  && SCHARS (echo_string) > 1)
715
	{
716 717 718 719
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
720 721 722 723

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

724 725 726
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
727 728 729 730
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
731 732
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
733 734 735

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

737
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
738 739 740 741 742 743
    }
}

/* 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
744
void
745
echo_dash (void)
Jim Blandy's avatar
Jim Blandy committed
746
{
747 748 749 750
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

751
  if (!current_kboard->immediate_echo
752
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
753
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
754

755
  /* Do nothing if we just printed a prompt.  */
756
  if (current_kboard->echo_after_prompt
757
      == SCHARS (current_kboard->echo_string))
758
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
759

760 761 762
  /* Do nothing if we have already put a dash at the end.  */
  if (SCHARS (current_kboard->echo_string) > 1)
    {
763
      Lisp_Object last_char, prev_char, idx;
764

765 766
      idx = make_number (SCHARS (current_kboard->echo_string) - 2);
      prev_char = Faref (current_kboard->echo_string, idx);
767

768 769
      idx = make_number (SCHARS (current_kboard->echo_string) - 1);
      last_char = Faref (current_kboard->echo_string, idx);
770

771 772
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
773 774
    }

Jim Blandy's avatar
Jim Blandy committed
775 776
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
777 778
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
779
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
780 781 782 783 784
}

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

785
void
786
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
787
{
788
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
789 790
    {
      int i;
791
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
792 793

      for (i = 0; i < this_command_key_count; i++)
794 795
	{
	  Lisp_Object c;
796 797 798 799 800 801 802

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

803 804 805 806 807
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
808 809 810 811 812 813 814 815

      /* 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
816 817 818 819
      echo_dash ();
    }

  echoing = 1;
820
  message3_nolog (current_kboard->echo_string,
821
		  SBYTES (current_kboard->echo_string),
822
		  STRING_MULTIBYTE (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
823 824
  echoing = 0;

825 826 827 828
  /* 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
829 830 831 832 833 834
  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
835
void
836
cancel_echoing (void)
Jim Blandy's avatar
Jim Blandy committed
837
{
838 839
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
840
  current_kboard->echo_string = Qnil;
841 842 843
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
844 845 846 847 848
}

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

static int
849
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
850
{
851
  return (STRINGP (current_kboard->echo_string)
852
	  ? SCHARS (current_kboard->echo_string)
853
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
854 855 856 857
}

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

static void
861
echo_truncate (int nchars)
862 863 864 865 866 867
{
  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
868 869 870 871 872
}


/* Functions for manipulating this_command_keys.  */
static void
873
add_command_key (Lisp_Object key)
Jim Blandy's avatar
Jim Blandy committed
874
{
875 876
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
877 878 879 880 881
  /* 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;
882 883
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
884 885 886
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
887
#endif
888

889 890 891 892
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
893

894
  ASET (this_command_keys, this_command_key_count, key);
895
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
896
}
897

Jim Blandy's avatar
Jim Blandy committed
898 899

Lisp_Object
900
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
901
{
Juanma Barranquero's avatar
Juanma Barranquero committed
902
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
903 904 905 906 907 908 909 910
  Lisp_Object val;

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

911
#ifdef HAVE_WINDOW_SYSTEM
912
  /* The command loop has started an hourglass timer, so we have to
913
     cancel it here, otherwise it will fire because the recursive edit
914 915
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
916
    cancel_hourglass ();
917 918
#endif

919 920 921 922 923 924 925 926 927 928 929 930
  /* 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
931 932 933
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
934 935 936
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
937
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
938

939
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
940 941 942
}

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

944
void
945
record_auto_save (void)
Jim Blandy's avatar
Jim Blandy committed
946
{
947
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed