keyboard.c 324 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2
   Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99, 2000, 01, 02
3
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

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

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

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

65 66 67 68 69
/* This is to get the definitions of the XK_ symbols.  */
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

70 71 72 73
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

74
#ifdef MAC_OS
75 76 77
#include "macterm.h"
#endif

78
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
79
extern int errno;
80
#endif
Jim Blandy's avatar
Jim Blandy committed
81

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

/* Non-zero if interrupt input is blocked right now.  */
85
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 91


92 93
/* File descriptor to use for input.  */
extern int input_fd;
Jim Blandy's avatar
Jim Blandy committed
94

95
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
96
/* Make all keyboard buffers much bigger when using X windows.  */
97 98
#ifdef MAC_OS8
/* But not too big (local data > 32K error) if on Mac OS Classic.  */
99 100
#define KBD_BUFFER_SIZE 512
#else
Jim Blandy's avatar
Jim Blandy committed
101
#define KBD_BUFFER_SIZE 4096
102
#endif
Jim Blandy's avatar
Jim Blandy committed
103
#else	/* No X-windows, character input */
104
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
105 106
#endif	/* No X-windows */

Gerd Moellmann's avatar
Gerd Moellmann committed
107 108
#define abs(x)		((x) >= 0 ? (x) : -(x))

Jim Blandy's avatar
Jim Blandy committed
109 110 111 112 113 114 115 116 117 118 119 120 121
/* 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 124 125
#ifdef MULTI_KBOARD
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
126
int single_kboard;
127
#else
128
KBOARD the_only_kboard;
129
#endif
130

Jim Blandy's avatar
Jim Blandy committed
131 132
/* Non-nil disable property on a command means
   do not execute it; call disabled-command-hook's value instead.  */
133
Lisp_Object Qdisabled, Qdisabled_command_hook;
Jim Blandy's avatar
Jim Blandy committed
134 135 136 137

#define NUM_RECENT_KEYS (100)
int recent_keys_index;	/* Index for storing next element into recent_keys */
int total_keys;		/* Total number of elements stored into recent_keys */
138
Lisp_Object recent_keys; /* A vector, holding the last 100 keystrokes */
Jim Blandy's avatar
Jim Blandy committed
139

140 141 142 143 144 145 146
/* 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
147

148 149 150 151 152 153
/* 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							\
154
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
155 156 157 158 159 160 161 162 163
  {									\
    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;							\
  }

164 165 166 167
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

168 169 170 171 172 173 174 175 176 177 178 179
/* 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;
/* Values of before_command_key_count and before_command_echo_length
   saved by reset-this-command-lengths.  */
static int before_command_key_count_1;
static int before_command_echo_length_1;
/* Flag set by reset-this-command-lengths,
   saying to reset the lengths when add_command_key is called.  */
static int before_command_restore_flag;

Jim Blandy's avatar
Jim Blandy committed
180 181
extern int minbuf_level;

182 183
extern int message_enable_multibyte;

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

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

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

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

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

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

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

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

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

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

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

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

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

225
struct kboard *echo_kboard;
226

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

230
Lisp_Object echo_message_buffer;
231

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

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

238 239 240
/* The user's ERASE setting.  */
Lisp_Object Vtty_erase_char;

Jim Blandy's avatar
Jim Blandy committed
241
/* Character to recognize as the help char.  */
242
Lisp_Object Vhelp_char;
Jim Blandy's avatar
Jim Blandy committed
243

Karl Heuer's avatar
Karl Heuer committed
244 245 246
/* List of other event types to recognize as meaning "help".  */
Lisp_Object Vhelp_event_list;

Jim Blandy's avatar
Jim Blandy committed
247 248 249
/* Form to execute when help char is typed.  */
Lisp_Object Vhelp_form;

250 251 252
/* Command to run when the help character follows a prefix key.  */
Lisp_Object Vprefix_help_command;

253 254
/* List of items that should move to the end of the menu bar.  */
Lisp_Object Vmenu_bar_final_items;
255

256 257 258 259 260 261
/* 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;

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

287 288 289
/* If non-nil, this is a map that overrides all other local maps.  */
Lisp_Object Voverriding_local_map;

290 291 292
/* If non-nil, Voverriding_local_map applies to the menu bar.  */
Lisp_Object Voverriding_local_map_menu_flag;

293 294 295 296
/* 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
297 298 299 300
/* Current depth in recursive edits.  */
int command_loop_level;

/* Total number of times command_loop has read a key sequence.  */
301
EMACS_INT num_input_keys;
Jim Blandy's avatar
Jim Blandy committed
302 303 304 305

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

306 307 308 309
/* 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
310 311 312
/* Last input character read for any purpose.  */
Lisp_Object last_input_char;

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

316 317 318 319 320 321 322 323
/* 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;

324
/* If not -1, an event to be read as subsequent command input.  */
325
EMACS_INT unread_command_char;
326

327 328
/* 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
329
   next command input, after any unread_command_events.
330 331 332 333 334

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

336
/* A mask of extra modifier bits to put into every keyboard char.  */
337
EMACS_INT extra_keyboard_modifiers;
338

Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344 345 346
/* 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;

347
/* Number of idle seconds before an auto-save and garbage collection.  */
Jim Blandy's avatar
Jim Blandy committed
348 349 350
static Lisp_Object Vauto_save_timeout;

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

353
/* Total number of times read_char has returned, outside of macros.  */
354
EMACS_INT num_nonmacro_input_events;
355

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

359
static EMACS_INT auto_save_interval;
Jim Blandy's avatar
Jim Blandy committed
360

361
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
362 363 364 365

int last_auto_save;

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

373 374 375 376
/* 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;

377 378 379
/* The value of point when the last command was executed.  */
int last_point_position;

380 381 382
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

383 384 385 386 387 388 389 390 391 392 393 394
/* 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
395 396
/* 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
397 398 399 400 401
unsigned long last_event_timestamp;

Lisp_Object Qself_insert_command;
Lisp_Object Qforward_char;
Lisp_Object Qbackward_char;
402
Lisp_Object Qundefined;
403
Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
404 405 406 407 408

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

409 410 411
/* Echo unfinished commands after this many seconds of pause.  */
Lisp_Object Vecho_keystrokes;

Jim Blandy's avatar
Jim Blandy committed
412 413 414 415 416 417 418 419 420
/* Form to evaluate (if non-nil) when Emacs is started.  */
Lisp_Object Vtop_level;

/* User-supplied string to translate input characters through.  */
Lisp_Object Vkeyboard_translate_table;

/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
extern Lisp_Object Vfunction_key_map;

421 422 423
/* Another keymap that maps key sequences into key sequences.
   This one takes precedence over ordinary definitions.  */
extern Lisp_Object Vkey_translation_map;
424

425 426 427 428
/* If non-nil, this implements the current input method.  */
Lisp_Object Vinput_method_function;
Lisp_Object Qinput_method_function;

429 430 431 432
/* When we call Vinput_method_function,
   this holds the echo area message that was just erased.  */
Lisp_Object Vinput_method_previous_message;

433 434 435
/* Non-nil means deactivate the mark at end of this command.  */
Lisp_Object Vdeactivate_mark;

436 437 438 439 440
/* Menu bar specified in Lucid Emacs fashion.  */

Lisp_Object Vlucid_menu_bar_dirty_flag;
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

441
Lisp_Object Qecho_area_clear_hook;
442

443
/* Hooks to run before and after each command.  */
444 445
Lisp_Object Qpre_command_hook, Vpre_command_hook;
Lisp_Object Qpost_command_hook, Vpost_command_hook;
446
Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
447 448 449 450
/* Hook run after a command if there's no more input soon.  */
Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;

/* Delay time in microseconds before running post-command-idle-hook.  */
451
EMACS_INT post_command_idle_delay;
452

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

461 462 463
Lisp_Object Qinput_method_exit_on_first_char;
Lisp_Object Qinput_method_use_echo_area;

Jim Blandy's avatar
Jim Blandy committed
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;

470 471 472
/* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
   keep 0200 bit in input chars.  0 to ignore the 0200 bit.  */

Jim Blandy's avatar
Jim Blandy committed
473 474
int meta_key;

475 476 477 478
/* Non-zero means force key bindings update in parse_menu_item.  */

int update_menu_bindings;

Jim Blandy's avatar
Jim Blandy committed
479 480
extern char *pending_malloc_warning;

481
/* Circular buffer for pre-read keyboard input.  */
482

483 484
static struct input_event kbd_buffer[KBD_BUFFER_SIZE];

485
/* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503

   The interrupt-level event handlers will never enqueue an event on a
   frame which is not in Vframe_list, and once an event is dequeued,
   internal_last_event_frame or the event itself points to the frame.
   So that's all fine.

   But while the event is sitting in the queue, it's completely
   unprotected.  Suppose the user types one command which will run for
   a while and then delete a frame, and then types another event at
   the frame that will be deleted, before the command gets around to
   it.  Suppose there are no references to this frame elsewhere in
   Emacs, and a GC occurs before the second event is dequeued.  Now we
   have an event referring to a freed frame, which will crash Emacs
   when it is dequeued.

   Similar things happen when an event on a scroll bar is enqueued; the
   window may be deleted while the event is in the queue.

504 505 506
   So, we use this vector to protect the Lisp_Objects in the event
   queue.  That way, they'll be dequeued as dead frames or windows,
   but still valid Lisp objects.
507

Pavel Janík's avatar
Pavel Janík committed
508
   If kbd_buffer[i].kind != NO_EVENT, then
509 510 511 512 513

   AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
   AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg.  */

static Lisp_Object kbd_buffer_gcpro;
514 515 516

/* Pointer to next available character in kbd_buffer.
   If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
517
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
518 519 520 521 522 523
   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].  */
524
static struct input_event * volatile kbd_store_ptr;
525 526 527 528 529 530 531 532 533 534

/* 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
   there is input available iff the two pointers are not equal.

   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
535
/* If this flag is non-nil, we check mouse_moved to see when the
536 537
   mouse moves, and motion events will appear in the input stream.
   Otherwise, mouse motion is ignored.  */
538
Lisp_Object do_mouse_tracking;
Jim Blandy's avatar
Jim Blandy committed
539 540 541

/* Symbols to head events.  */
Lisp_Object Qmouse_movement;
542
Lisp_Object Qscroll_bar_movement;
543
Lisp_Object Qswitch_frame;
544
Lisp_Object Qdelete_frame;
545 546
Lisp_Object Qiconify_frame;
Lisp_Object Qmake_frame_visible;
Pavel Janík's avatar
Pavel Janík committed
547
Lisp_Object Qselect_window;
548
Lisp_Object Qhelp_echo;
549

Jim Blandy's avatar
Jim Blandy committed
550 551 552
/* Symbols to denote kinds of events.  */
Lisp_Object Qfunction_key;
Lisp_Object Qmouse_click;
553 554
#ifdef WINDOWSNT
Lisp_Object Qmouse_wheel;
555
Lisp_Object Qlanguage_change;
556
#endif
557
Lisp_Object Qdrag_n_drop;
558 559
Lisp_Object Qsave_session;

Jim Blandy's avatar
Jim Blandy committed
560 561 562 563
/* Lisp_Object Qmouse_movement; - also an event header */

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

566 567
/* menu item parts */
Lisp_Object Qmenu_alias;
568
Lisp_Object Qmenu_enable;
569 570
Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
Lisp_Object QCbutton, QCtoggle, QCradio;
571 572
extern Lisp_Object Vdefine_key_rebound_commands;
extern Lisp_Object Qmenu_item;
573

574 575 576 577 578 579 580 581 582 583 584 585 586
/* 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;

587
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
588
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
589
Lisp_Object Qvertical_line;
590
Lisp_Object Qvertical_scroll_bar;
591
Lisp_Object Qmenu_bar;
592
extern Lisp_Object Qleft_margin, Qright_margin;
593

594 595
Lisp_Object recursive_edit_unwind (), command_loop ();
Lisp_Object Fthis_command_keys ();
596
Lisp_Object Qextended_command_history;
597
EMACS_TIME timer_check ();
Jim Blandy's avatar
Jim Blandy committed
598

599 600
extern Lisp_Object Vhistory_length;

601 602
extern char *x_get_keysym_name ();

603 604
static void record_menu_key ();

605 606
Lisp_Object Qpolling_period;

607
/* List of absolute timers.  Appears in order of next scheduled event.  */
608 609
Lisp_Object Vtimer_list;

610 611 612
/* List of idle time timers.  Appears in order of next scheduled event.  */
Lisp_Object Vtimer_idle_list;

613 614 615
/* Incremented whenever a timer is run.  */
int timers_run;

616 617
extern Lisp_Object Vprint_level, Vprint_length;

Jim Blandy's avatar
Jim Blandy committed
618 619 620
/* 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
621 622 623 624 625 626 627 628

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

629
/* Nonzero means use ^S/^Q for flow control.  */
Jim Blandy's avatar
Jim Blandy committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
int flow_control;

/* 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.  */
#ifndef FIONREAD
#ifdef SIGIO
#undef SIGIO
#endif
#endif

645
/* If we support a window system, turn on the code to poll periodically
646
   to detect C-g.  It isn't actually used when doing interrupt input.  */
647
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
648 649
#define POLL_FOR_INPUT
#endif
650 651 652 653

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

657 658 659
Lisp_Object Vdisable_point_adjustment;

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

661 662
Lisp_Object Vglobal_disable_point_adjustment;

663 664 665 666
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

667 668 669 670 671
/* 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;

Jim Blandy's avatar
Jim Blandy committed
672 673 674 675 676 677

/* Global variable declarations.  */

/* Function for init_keyboard to call with no args (if nonzero).  */
void (*keyboard_init_hook) ();

678 679
static int read_avail_input P_ ((int));
static void get_input_pending P_ ((int *, int));
680
static void get_filtered_input_pending P_ ((int *, int, int));
681
static int readable_events P_ ((int));
682
static int readable_filtered_events P_ ((int, int));
683 684
static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
						Lisp_Object, int *));
685
static Lisp_Object read_char_x_menu_prompt ();
686 687 688
static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
						      Lisp_Object *));
static Lisp_Object make_lispy_event P_ ((struct input_event *));
689
#ifdef HAVE_MOUSE
690 691 692 693
static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
					    enum scroll_bar_part,
					    Lisp_Object, Lisp_Object,
					    unsigned long));
694
#endif
695 696 697 698 699
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));
700
static int parse_solitary_modifier ();
701
static void save_getcjmp P_ ((jmp_buf));
Andreas Schwab's avatar
Andreas Schwab committed
702
static void save_getcjmp ();
703
static void restore_getcjmp P_ ((jmp_buf));
704
static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
705
static void clear_event P_ ((struct input_event *));
706
static void any_kboard_state P_ ((void));
Jim Blandy's avatar
Jim Blandy committed
707

708 709 710 711
/* Nonzero means don't try to suspend even if the operating system seems
   to support it.  */
static int cannot_suspend;

Jim Blandy's avatar
Jim Blandy committed
712 713 714 715
/* 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
716
void
Jim Blandy's avatar
Jim Blandy committed
717
echo_prompt (str)
718
     Lisp_Object str;
Jim Blandy's avatar
Jim Blandy committed
719
{
720
  current_kboard->echo_string = str;
721
  current_kboard->echo_after_prompt = SCHARS (str);
722
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
723 724
}

725
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
726 727 728
   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
729
void
Jim Blandy's avatar
Jim Blandy committed
730 731 732
echo_char (c)
     Lisp_Object c;
{
733
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
734
    {
735 736 737 738
      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
739

740 741
      echo_string = current_kboard->echo_string;
      
Jim Blandy's avatar
Jim Blandy committed
742
      /* If someone has passed us a composite event, use its head symbol.  */
743
      c = EVENT_HEAD (c);
Jim Blandy's avatar
Jim Blandy committed
744

745
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
746
	{
747
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
748
	}
749
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
750
	{
751
	  struct Lisp_String *name = XSTRING (SYMBOL_NAME (c));
752
	  int nbytes = STRING_BYTES (name);
753
	  
754
	  if (size - (ptr - buffer) < nbytes)
755 756
	    {
	      int offset = ptr - buffer;
757
	      size = max (2 * size, size + nbytes);
758 759 760 761
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

762
	  ptr += copy_text (name->data, ptr, nbytes,
763
			    name->size_byte >= 0, 1);
Jim Blandy's avatar
Jim Blandy committed
764 765
	}

766
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
767
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
768
	{
769 770 771 772 773 774 775 776 777 778 779 780 781
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
	  
	  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
782 783
	}

784 785
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
786
      if (STRINGP (echo_string)
787 788 789 790 791 792 793 794 795 796 797 798
	  && SCHARS (echo_string) > 0)
	{
	  Lisp_Object last_char, idx;

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

	  if (XINT (last_char) == '-')
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
799 800 801

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

803
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
804 805 806 807 808 809
    }
}

/* 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
810
void
Jim Blandy's avatar
Jim Blandy committed
811 812
echo_dash ()
{
813 814 815 816
  /* Do nothing if not echoing at all.  */
  if (NILP (current_kboard->echo_string))
    return;

817
  if (!current_kboard->immediate_echo
818
      && SCHARS (current_kboard->echo_string) == 0)
Jim Blandy's avatar
Jim Blandy committed
819
    return;
820
      
821
  /* Do nothing if we just printed a prompt.  */
822
  if (current_kboard->echo_after_prompt
823
      == SCHARS (current_kboard->echo_string))
824
    return;
825
      
Jim Blandy's avatar
Jim Blandy committed
826 827
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
828 829
  current_kboard->echo_string = concat2 (current_kboard->echo_string,
					 build_string ("-"));
830
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
831 832 833 834 835
}

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

836
void
837
echo_now ()
Jim Blandy's avatar
Jim Blandy committed
838
{
839
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
840 841
    {
      int i;
842
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
843 844

      for (i = 0; i < this_command_key_count; i++)
845 846 847 848 849 850 851
	{
	  Lisp_Object c;
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
Jim Blandy's avatar
Jim Blandy committed
852 853 854 855
      echo_dash ();
    }

  echoing = 1;
856
  message3_nolog (current_kboard->echo_string,
857 858
		  SBYTES (current_kboard->echo_string),
		  SMBP (current_kboard->echo_string));
Jim Blandy's avatar
Jim Blandy committed
859 860
  echoing = 0;

861 862 863 864
  /* 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
865 866 867 868 869 870
  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
871
void
Jim Blandy's avatar
Jim Blandy committed
872 873
cancel_echoing ()
{
874 875
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
876
  current_kboard->echo_string = Qnil;
877 878 879
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883 884 885 886
}

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

static int
echo_length ()
{
887
  return (STRINGP (current_kboard->echo_string)
888
	  ? SCHARS (current_kboard->echo_string)
889
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
890 891 892 893
}

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

static void
897 898 899 900 901 902 903 904
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
905 906 907 908 909 910 911 912
}


/* Functions for manipulating this_command_keys.  */
static void
add_command_key (key)
     Lisp_Object key;
{
913 914 915 916 917
  /* 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;
918 919
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
920 921 922 923
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }

924 925 926 927
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
928

929 930
  AREF (this_command_keys, this_command_key_count) = key;
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
931
}
932

Jim Blandy's avatar
Jim Blandy committed
933 934 935 936 937 938 939 940 941 942 943 944 945

Lisp_Object
recursive_edit_1 ()
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object val;

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

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

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

974
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
975 976 977
}

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

979
void
Jim Blandy's avatar
Jim Blandy committed
980 981
record_auto_save ()
{
982
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
983
}
984 985 986

/* Make an auto save happen as soon as possible at command level.  */

Andreas Schwab's avatar
Andreas Schwab committed
987
void
988 989 990
force_auto_save_soon ()
{
  last_auto_save = - auto_save_interval - 1;
991 992

  record_asynch_buffer_change ();
993
}
Jim Blandy's avatar
Jim Blandy committed
994 995

DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
996 997 998 999 1000 1001
       doc: /* Invoke the editor command loop recursively.
To get out of the recursive edit, a command can do `(throw 'exit nil)';
that tells this function to return.
Alternately, `(throw 'exit t)' makes this function signal an error.
This function is called by the editor initialization to begin editing.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1002 1003
{
  int count = specpdl_ptr - specpdl;
1004
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1005 1006 1007 1008

  command_loop_level++;
  update_mode_lines = 1;

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
  if (command_loop_level
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
    buffer = Fcurrent_buffer ();
  else
    buffer = Qnil;

  /* If we leave recursive_edit_1 below with a `throw' for instance,
     like it is done in the splash screen display, we have to
     make sure that we restore single_kboard as command_loop_1
     would have done if it were left normally.  */
Jim Blandy's avatar
Jim Blandy committed
1019
  record_unwind_protect (recursive_edit_unwind,
1020 1021
			 Fcons (buffer, single_kboard ? Qt : Qnil));

Jim Blandy's avatar
Jim Blandy committed
1022 1023 1024 1025 1026
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
1027 1028
recursive_edit_unwind (info)
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
1029
{
1030 1031