keyboard.c 366 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
                 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

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

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

Jim Blandy's avatar
Jim Blandy committed
61 62
#include "syssignal.h"

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

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

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

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

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

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

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

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

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


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

/* Following definition copied from eval.c */

struct backtrace
  {
    struct backtrace *next;
    Lisp_Object *function;
    Lisp_Object *args;	/* Points to vector of args. */
    int nargs;		/* length of vector.  If nargs is UNEVALLED,
			   args points to slot holding list of
			   unevalled args */
    char evalargs;
122 123
    /* Nonzero means call value of debugger when done with this operation. */
    char debug_on_exit;
Jim Blandy's avatar
Jim Blandy committed
124 125
  };

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

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

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

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

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

156 157 158 159 160 161
/* This vector is used as a buffer to record the events that were actually read
   by read_key_sequence.  */
Lisp_Object raw_keybuf;
int raw_keybuf_count;

#define GROW_RAW_KEYBUF							\
162
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
163 164 165 166 167 168 169 170 171
  {									\
    int newsize = 2 * XVECTOR (raw_keybuf)->size;			\
    Lisp_Object new;							\
    new = Fmake_vector (make_number (newsize), Qnil);			\
    bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents,	\
	   raw_keybuf_count * sizeof (Lisp_Object));			\
    raw_keybuf = new;							\
  }

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

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

183 184
extern int message_enable_multibyte;

Jim Blandy's avatar
Jim Blandy committed
185 186
extern struct backtrace *backtrace_list;

187 188 189 190 191
/* 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;

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

Jim Blandy's avatar
Jim Blandy committed
199 200 201
static int menu_prompting;

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

Jim Blandy's avatar
Jim Blandy committed
203 204 205
static Lisp_Object menu_prompt_more_char;

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

Jim Blandy's avatar
Jim Blandy committed
207 208 209 210 211 212
static jmp_buf getcjmp;

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

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

214
int echoing;
Jim Blandy's avatar
Jim Blandy committed
215

216 217 218 219 220
/* 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;

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

226
struct kboard *echo_kboard;
227

228 229 230
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

231
Lisp_Object echo_message_buffer;
232

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

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

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

242 243 244
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

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

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

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

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

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

260 261 262 263 264 265
/* 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;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

363
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
364

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

int last_auto_save;

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

377 378 379 380
/* 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;

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

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

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

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

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

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

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

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

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

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

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

433 434 435 436 437
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

438
Lisp_Object Qecho_area_clear_hook;
439

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

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

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

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

459 460 461
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
462 463 464 465 466 467 468 469
/* File in which we write all commands we read.  */
FILE *dribble;

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

extern char *pending_malloc_warning;

470
/* Circular buffer for pre-read keyboard input.  */
471

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

/* 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
488
   there is input available if the two pointers are not equal.
489 490 491 492 493

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

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

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

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

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

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

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

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

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

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

566
extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
567

568 569
extern char *x_get_keysym_name ();

570
static void record_menu_key ();
571
static int echo_length ();
572

573 574
Lisp_Object Qpolling_period;

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

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

581 582 583
/* Incremented whenever a timer is run.  */
int timers_run;

584 585
extern Lisp_Object Vprint_level, Vprint_length;

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

/* 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
604
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
605 606 607 608 609
#ifdef SIGIO
#undef SIGIO
#endif
#endif

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

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

622 623 624
Lisp_Object Vdisable_point_adjustment;

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

626 627
Lisp_Object Vglobal_disable_point_adjustment;

628 629 630 631
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

632 633 634 635 636
/* 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;

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

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

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

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

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

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

725
      echo_string = current_kboard->echo_string;
Juanma Barranquero's avatar
Juanma Barranquero committed
726

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

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

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

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

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

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

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

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
778 779 780 781

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

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

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

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

/* 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
802
void
Jim Blandy's avatar
Jim Blandy committed
803 804
echo_dash ()
{
805 806 807 808
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

979 980