keyboard.c 370 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Keyboard and mouse input; editor command loop.
2 3

Copyright (C) 1985-1989, 1993-1997, 1999-2011  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

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

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

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

59 60
#include <sys/types.h>
#include <unistd.h>
61 62
#include <fcntl.h>

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

68 69 70 71
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

72 73 74 75
#ifdef HAVE_NS
#include "nsterm.h"
#endif

76 77 78
/* Variables for blockinput.h: */

/* Non-zero if interrupt input is blocked right now.  */
79
volatile int interrupt_input_blocked;
80 81 82

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

Chong Yidong's avatar
Chong Yidong committed
85 86 87 88 89
/* 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.  */
90
#ifdef SYNC_INPUT
Chong Yidong's avatar
Chong Yidong committed
91
int pending_signals;
92
#endif
Chong Yidong's avatar
Chong Yidong committed
93

94
#define KBD_BUFFER_SIZE 4096
Jim Blandy's avatar
Jim Blandy committed
95

96 97 98
KBOARD *initial_kboard;
KBOARD *current_kboard;
KBOARD *all_kboards;
99
int single_kboard;
100

Jim Blandy's avatar
Jim Blandy committed
101
/* Non-nil disable property on a command means
102
   do not execute it; call disabled-command-function's value instead.  */
103 104
Lisp_Object Qdisabled;
static Lisp_Object Qdisabled_command_function;
Jim Blandy's avatar
Jim Blandy committed
105

106
#define NUM_RECENT_KEYS (300)
Jim Blandy's avatar
Jim Blandy committed
107 108
int recent_keys_index;	/* Index for storing next element into recent_keys */
int total_keys;		/* Total number of elements stored into recent_keys */
109
Lisp_Object recent_keys; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
Jim Blandy's avatar
Jim Blandy committed
110

111 112 113 114 115 116 117
/* 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
118

119 120 121 122
/* 1 after calling Freset_this_command_lengths.
   Usually it is 0.  */
int this_command_key_count_reset;

123 124 125 126 127 128
/* 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							\
129
 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size)			\
130
   raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil)  \
131

132 133 134 135
/* Number of elements of this_command_keys
   that precede this key sequence.  */
int this_single_command_key_start;

136 137 138 139 140
/* 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
141
/* For longjmp to where kbd input is being done.  */
142

Jim Blandy's avatar
Jim Blandy committed
143 144 145 146 147 148
static jmp_buf getcjmp;

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

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

150
int echoing;
Jim Blandy's avatar
Jim Blandy committed
151

152 153 154 155 156
/* 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;

157 158 159 160
/* 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.  */
161

162
struct kboard *echo_kboard;
163

164 165 166
/* The buffer used for echoing.  Set in echo_now, reset in
   cancel_echoing.  */

167
Lisp_Object echo_message_buffer;
168

169
/* Nonzero means C-g should cause immediate error-signal.  */
Jim Blandy's avatar
Jim Blandy committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
int immediate_quit;

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

/* Current depth in recursive edits.  */
int command_loop_level;

193 194
/* 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
195
   next command input, after any unread_command_events.
196 197 198 199 200

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

Jim Blandy's avatar
Jim Blandy committed
202
/* Last size recorded for a current buffer which is not a minibuffer.  */
203
static EMACS_INT last_non_minibuf_size;
Jim Blandy's avatar
Jim Blandy committed
204

205 206
/* Total number of times read_char has returned, modulo SIZE_MAX + 1.  */
size_t num_input_events;
Jim Blandy's avatar
Jim Blandy committed
207

208
/* Value of num_nonmacro_input_events as of last auto save.  */
Jim Blandy's avatar
Jim Blandy committed
209 210 211

int last_auto_save;

212 213
/* This is like Vthis_command, except that commands never set it.  */
Lisp_Object real_this_command;
Jim Blandy's avatar
Jim Blandy committed
214

215
/* The value of point when the last command was started.  */
216
EMACS_INT last_point_position;
217

218 219 220
/* The buffer that was current when the last command was started.  */
Lisp_Object last_point_position_buffer;

221 222 223
/* The window that was selected when the last command was started.  */
Lisp_Object last_point_position_window;

224 225 226 227 228 229 230
/* 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;

Jim Blandy's avatar
Jim Blandy committed
231 232
/* 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
233 234
unsigned long last_event_timestamp;

235 236
static Lisp_Object Qx_set_selection, Qhandle_switch_frame;
Lisp_Object QPRIMARY;
237

238 239 240 241 242
static Lisp_Object Qself_insert_command;
static Lisp_Object Qforward_char;
static Lisp_Object Qbackward_char;
static Lisp_Object Qundefined;
static Lisp_Object Qtimer_event_handler;
Jim Blandy's avatar
Jim Blandy committed
243 244 245 246 247

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

248
static Lisp_Object Qinput_method_function;
249

250
static Lisp_Object Qdeactivate_mark;
251

252 253
Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;

254
static Lisp_Object Qecho_area_clear_hook;
255

256
/* Hooks to run before and after each command.  */
257 258
static Lisp_Object Qpre_command_hook;
static Lisp_Object Qpost_command_hook;
259

260
static Lisp_Object Qdeferred_action_function;
261

262 263
static Lisp_Object Qinput_method_exit_on_first_char;
static Lisp_Object Qinput_method_use_echo_area;
264

265
static Lisp_Object Qhelp_form_show;
266

Jim Blandy's avatar
Jim Blandy committed
267 268 269 270 271 272
/* File in which we write all commands we read.  */
FILE *dribble;

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

273
/* Circular buffer for pre-read keyboard input.  */
274

275 276 277 278
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.
279
   This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
280 281 282 283 284 285
   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].  */
286
static struct input_event * volatile kbd_store_ptr;
287 288 289 290

/* 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
291
   there is input available if the two pointers are not equal.
292 293 294 295 296

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

Jim Blandy's avatar
Jim Blandy committed
297
/* Symbols to head events.  */
298 299
static Lisp_Object Qmouse_movement;
static Lisp_Object Qscroll_bar_movement;
300
Lisp_Object Qswitch_frame;
301 302 303 304
static Lisp_Object Qdelete_frame;
static Lisp_Object Qiconify_frame;
static Lisp_Object Qmake_frame_visible;
static Lisp_Object Qselect_window;
305
Lisp_Object Qhelp_echo;
306

Nick Roberts's avatar
Nick Roberts committed
307
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
308
static Lisp_Object Qmouse_fixup_help_message;
309 310
#endif

Jim Blandy's avatar
Jim Blandy committed
311
/* Symbols to denote kinds of events.  */
312
static Lisp_Object Qfunction_key;
Jim Blandy's avatar
Jim Blandy committed
313
Lisp_Object Qmouse_click;
314
#if defined (WINDOWSNT)
315
Lisp_Object Qlanguage_change;
316
#endif
317 318
static Lisp_Object Qdrag_n_drop;
static Lisp_Object Qsave_session;
319
#ifdef HAVE_DBUS
320
static Lisp_Object Qdbus_event;
321
#endif
322
static Lisp_Object Qconfig_changed_event;
323

Jim Blandy's avatar
Jim Blandy committed
324 325 326 327
/* Lisp_Object Qmouse_movement; - also an event header */

/* Properties of event headers.  */
Lisp_Object Qevent_kind;
328
static Lisp_Object Qevent_symbol_elements;
Jim Blandy's avatar
Jim Blandy committed
329

330
/* menu and tool bar item parts */
331 332 333 334 335 336 337 338 339 340
static Lisp_Object Qmenu_enable;
static Lisp_Object QCenable, QCvisible, QChelp, QCkeys, QCkey_sequence;
Lisp_Object QCfilter;

/* Non-nil disable property on a command means
   do not execute it; call disabled-command-function's value instead.  */
Lisp_Object QCtoggle, QCradio;
static Lisp_Object QCbutton, QClabel;

static Lisp_Object QCvert_only;
341

342 343 344 345 346 347 348 349 350 351 352
/* 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.  */
353
static Lisp_Object Qmodifier_cache;
354

355
/* Symbols to use for parts of windows.  */
Jim Blandy's avatar
Jim Blandy committed
356
Lisp_Object Qmode_line;
Jim Blandy's avatar
Jim Blandy committed
357
Lisp_Object Qvertical_line;
358
static Lisp_Object Qvertical_scroll_bar;
359 360
Lisp_Object Qmenu_bar;

361
Lisp_Object recursive_edit_unwind (Lisp_Object buffer), command_loop (void);
362
static Lisp_Object Qextended_command_history;
363
EMACS_TIME timer_check (void);
Jim Blandy's avatar
Jim Blandy committed
364

365 366
static void record_menu_key (Lisp_Object c);
static int echo_length (void);
367

368
static Lisp_Object Qpolling_period;
369

370 371 372
/* Incremented whenever a timer is run.  */
int timers_run;

Jim Blandy's avatar
Jim Blandy committed
373 374 375
/* 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
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390

/* 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
391
#if !defined (FIONREAD)
Jim Blandy's avatar
Jim Blandy committed
392 393 394 395 396
#ifdef SIGIO
#undef SIGIO
#endif
#endif

397
/* If we support a window system, turn on the code to poll periodically
398
   to detect C-g.  It isn't actually used when doing interrupt input.  */
Andrew Choi's avatar
In src:  
Andrew Choi committed
399
#if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
Jim Blandy's avatar
Jim Blandy committed
400 401
#define POLL_FOR_INPUT
#endif
402

403 404 405 406
/* The time when Emacs started being idle.  */

static EMACS_TIME timer_idleness_start_time;

407 408 409 410 411
/* 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
412 413 414

/* Global variable declarations.  */

415 416 417 418 419
/* 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
420
/* Function for init_keyboard to call with no args (if nonzero).  */
421
void (*keyboard_init_hook) (void);
Jim Blandy's avatar
Jim Blandy committed
422

423 424 425 426 427 428 429 430
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
431
#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
432 433 434 435
static Lisp_Object make_lispy_movement (struct frame *, Lisp_Object,
                                        enum scroll_bar_part,
                                        Lisp_Object, Lisp_Object,
                                        unsigned long);
436
#endif
437
static Lisp_Object modify_event_symbol (EMACS_INT, unsigned, Lisp_Object,
438
                                        Lisp_Object, const char *const *,
439 440 441 442 443 444 445
                                        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);
446
static void interrupt_signal (int signalnum);
447
#ifdef SIGIO
448
static void input_available_signal (int signo);
449
#endif
450
INFUN (Fcommand_execute, 4);
451 452 453 454
static void handle_interrupt (void);
static void timer_start_idle (void);
static void timer_stop_idle (void);
static void timer_resume_idle (void);
455
static void handle_user_signal (int);
456 457
static char *find_user_signal_name (int);
static int store_user_signal_events (void);
Jim Blandy's avatar
Jim Blandy committed
458

459

460
/* Add C to the echo string, if echoing is going on.
Jim Blandy's avatar
Jim Blandy committed
461 462 463
   C can be a character, which is printed prettily ("M-C-x" and all that
   jazz), or a symbol, whose name is printed.  */

464
static void
465
echo_char (Lisp_Object c)
Jim Blandy's avatar
Jim Blandy committed
466
{
467
  if (current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
468
    {
469 470 471 472
      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
473

474
      echo_string = KVAR (current_kboard, echo_string);
Juanma Barranquero's avatar
Juanma Barranquero committed
475

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

479
      if (INTEGERP (c))
Jim Blandy's avatar
Jim Blandy committed
480
	{
481
	  ptr = push_key_description (XINT (c), ptr, 1);
Jim Blandy's avatar
Jim Blandy committed
482
	}
483
      else if (SYMBOLP (c))
Jim Blandy's avatar
Jim Blandy committed
484
	{
485 486
	  Lisp_Object name = SYMBOL_NAME (c);
	  int nbytes = SBYTES (name);
Juanma Barranquero's avatar
Juanma Barranquero committed
487

488
	  if (size - (ptr - buffer) < nbytes)
489 490
	    {
	      int offset = ptr - buffer;
491
	      size = max (2 * size, size + nbytes);
492 493 494 495
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

496
	  ptr += copy_text (SDATA (name), (unsigned char *) ptr, nbytes,
497
			    STRING_MULTIBYTE (name), 1);
Jim Blandy's avatar
Jim Blandy committed
498 499
	}

500
      if ((NILP (echo_string) || SCHARS (echo_string) == 0)
Karl Heuer's avatar
Karl Heuer committed
501
	  && help_char_p (c))
Jim Blandy's avatar
Jim Blandy committed
502
	{
503 504
	  const char *text = " (Type ? for further options)";
	  int len = strlen (text);
Juanma Barranquero's avatar
Juanma Barranquero committed
505

506 507 508 509 510 511 512 513
	  if (size - (ptr - buffer) < len)
	    {
	      int offset = ptr - buffer;
	      size += len;
	      buffer = (char *) alloca (size);
	      ptr = buffer + offset;
	    }

514
	  memcpy (ptr, text, len);
515
	  ptr += len;
Jim Blandy's avatar
Jim Blandy committed
516 517
	}

518 519
      /* Replace a dash from echo_dash with a space, otherwise
	 add a space at the end as a separator between keys.  */
520
      if (STRINGP (echo_string)
521
	  && SCHARS (echo_string) > 1)
522
	{
523 524 525 526
	  Lisp_Object last_char, prev_char, idx;

	  idx = make_number (SCHARS (echo_string) - 2);
	  prev_char = Faref (echo_string, idx);
527 528 529 530

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

531 532 533
	  /* We test PREV_CHAR to make sure this isn't the echoing
	     of a minus-sign.  */
	  if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
534 535 536 537
	    Faset (echo_string, idx, make_number (' '));
	  else
	    echo_string = concat2 (echo_string, build_string (" "));
	}
538 539
      else if (STRINGP (echo_string))
	echo_string = concat2 (echo_string, build_string (" "));
540

541
      KVAR (current_kboard, echo_string)
542
	= concat2 (echo_string, make_string (buffer, ptr - buffer));
Jim Blandy's avatar
Jim Blandy committed
543

544
      echo_now ();
Jim Blandy's avatar
Jim Blandy committed
545 546 547 548 549 550
    }
}

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

551
static void
552
echo_dash (void)
Jim Blandy's avatar
Jim Blandy committed
553
{
554
  /* Do nothing if not echoing at all.  */
555
  if (NILP (KVAR (current_kboard, echo_string)))
556 557
    return;

558 559 560
  if (this_command_key_count == 0)
    return;

561
  if (!current_kboard->immediate_echo
562
      && SCHARS (KVAR (current_kboard, echo_string)) == 0)
Jim Blandy's avatar
Jim Blandy committed
563
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
564

565
  /* Do nothing if we just printed a prompt.  */
566
  if (current_kboard->echo_after_prompt
567
      == SCHARS (KVAR (current_kboard, echo_string)))
568
    return;
Juanma Barranquero's avatar
Juanma Barranquero committed
569

570
  /* Do nothing if we have already put a dash at the end.  */
571
  if (SCHARS (KVAR (current_kboard, echo_string)) > 1)
572
    {
573
      Lisp_Object last_char, prev_char, idx;
574

575 576
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 2);
      prev_char = Faref (KVAR (current_kboard, echo_string), idx);
577

578 579
      idx = make_number (SCHARS (KVAR (current_kboard, echo_string)) - 1);
      last_char = Faref (KVAR (current_kboard, echo_string), idx);
580

581 582
      if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
	return;
583 584
    }

Jim Blandy's avatar
Jim Blandy committed
585 586
  /* Put a dash at the end of the buffer temporarily,
     but make it go away when the next character is added.  */
587
  KVAR (current_kboard, echo_string) = concat2 (KVAR (current_kboard, echo_string),
588
					 build_string ("-"));
589
  echo_now ();
Jim Blandy's avatar
Jim Blandy committed
590 591 592 593 594
}

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

595
void
596
echo_now (void)
Jim Blandy's avatar
Jim Blandy committed
597
{
598
  if (!current_kboard->immediate_echo)
Jim Blandy's avatar
Jim Blandy committed
599 600
    {
      int i;
601
      current_kboard->immediate_echo = 1;
Jim Blandy's avatar
Jim Blandy committed
602 603

      for (i = 0; i < this_command_key_count; i++)
604 605
	{
	  Lisp_Object c;
606 607 608 609 610 611 612

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

613 614 615 616 617
	  c = XVECTOR (this_command_keys)->contents[i];
	  if (! (EVENT_HAS_PARAMETERS (c)
		 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
	    echo_char (c);
	}
618 619 620 621 622 623 624 625

      /* 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
626 627 628 629
      echo_dash ();
    }

  echoing = 1;
630 631 632
  message3_nolog (KVAR (current_kboard, echo_string),
		  SBYTES (KVAR (current_kboard, echo_string)),
		  STRING_MULTIBYTE (KVAR (current_kboard, echo_string)));
Jim Blandy's avatar
Jim Blandy committed
633 634
  echoing = 0;

635 636 637 638
  /* 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
639 640 641 642 643 644
  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
645
void
646
cancel_echoing (void)
Jim Blandy's avatar
Jim Blandy committed
647
{
648 649
  current_kboard->immediate_echo = 0;
  current_kboard->echo_after_prompt = -1;
650
  KVAR (current_kboard, echo_string) = Qnil;
651 652 653
  ok_to_echo_at_next_pause = NULL;
  echo_kboard = NULL;
  echo_message_buffer = Qnil;
Jim Blandy's avatar
Jim Blandy committed
654 655 656 657 658
}

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

static int
659
echo_length (void)
Jim Blandy's avatar
Jim Blandy committed
660
{
661 662
  return (STRINGP (KVAR (current_kboard, echo_string))
	  ? SCHARS (KVAR (current_kboard, echo_string))
663
	  : 0);
Jim Blandy's avatar
Jim Blandy committed
664 665 666 667
}

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

static void
671
echo_truncate (EMACS_INT nchars)
672
{
673 674 675
  if (STRINGP (KVAR (current_kboard, echo_string)))
    KVAR (current_kboard, echo_string)
      = Fsubstring (KVAR (current_kboard, echo_string),
676 677
		    make_number (0), make_number (nchars));
  truncate_echo_area (nchars);
Jim Blandy's avatar
Jim Blandy committed
678 679 680 681 682
}


/* Functions for manipulating this_command_keys.  */
static void
683
add_command_key (Lisp_Object key)
Jim Blandy's avatar
Jim Blandy committed
684
{
685 686
#if 0 /* Not needed after we made Freset_this_command_lengths
	 do the job immediately.  */
687 688 689 690 691
  /* 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;
692 693
      if (this_command_key_count < this_single_command_key_start)
	this_single_command_key_start = this_command_key_count;
694 695 696
      echo_truncate (before_command_echo_length_1);
      before_command_restore_flag = 0;
    }
697
#endif
698

699 700 701 702
  if (this_command_key_count >= ASIZE (this_command_keys))
    this_command_keys = larger_vector (this_command_keys,
				       2 * ASIZE (this_command_keys),
				       Qnil);
703

704
  ASET (this_command_keys, this_command_key_count, key);
705
  ++this_command_key_count;
Jim Blandy's avatar
Jim Blandy committed
706
}
707

Jim Blandy's avatar
Jim Blandy committed
708 709

Lisp_Object
710
recursive_edit_1 (void)
Jim Blandy's avatar
Jim Blandy committed
711
{
Juanma Barranquero's avatar
Juanma Barranquero committed
712
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
713 714 715 716 717 718 719 720
  Lisp_Object val;

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

721
#ifdef HAVE_WINDOW_SYSTEM
722
  /* The command loop has started an hourglass timer, so we have to
723
     cancel it here, otherwise it will fire because the recursive edit
724 725
     can take some time.  Do not check for display_hourglass_p here,
     because it could already be nil.  */
726
    cancel_hourglass ();
727 728
#endif

729 730 731 732 733 734 735 736 737 738 739 740
  /* 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
741 742 743
  val = command_loop ();
  if (EQ (val, Qt))
    Fsignal (Qquit, Qnil);
744 745 746
  /* Handle throw from read_minibuf when using minibuffer
     while it's active but we're in another window.  */
  if (STRINGP (val))
747
    xsignal1 (Qerror, val);
Jim Blandy's avatar
Jim Blandy committed
748

749
  return unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
750 751 752
}

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

754
void
755
record_auto_save (void)
Jim Blandy's avatar
Jim Blandy committed
756
{
757
  last_auto_save = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
758
}
759 760 761

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

Andreas Schwab's avatar
Andreas Schwab committed
762
void
763
force_auto_save_soon (void)
764 765
{
  last_auto_save = - auto_save_interval - 1;
766 767

  record_asynch_buffer_change ();
768
}
Jim Blandy's avatar
Jim Blandy committed
769

770
DEFUE ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
771 772 773
       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.
774
Alternatively, `(throw 'exit t)' makes this function signal an error.
775
This function is called by the editor initialization to begin editing.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
776
  (void)
Jim Blandy's avatar
Jim Blandy committed
777
{
Juanma Barranquero's avatar
Juanma Barranquero committed
778
  int count = SPECPDL_INDEX ();
779
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
780

781 782 783 784 785
  /* If we enter while input is blocked, don't lock up here.
     This may happen through the debugger during redisplay.  */
  if (INPUT_BLOCKED_P)
    return Qnil;

Jim Blandy's avatar
Jim Blandy committed
786 787 788
  command_loop_level++;
  update_mode_lines = 1;

789 790 791 792 793 794 795 796 797 798
  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.  */
799 800
  if (command_loop_level > 0)
    temporarily_switch_to_single_kboard (SELECTED_FRAME ());
801
  record_unwind_protect (recursive_edit_unwind, buffer);
802

Jim Blandy's avatar
Jim Blandy committed
803 804 805 806 807
  recursive_edit_1 ();
  return unbind_to (count, Qnil);
}

Lisp_Object
808
recursive_edit_unwind (Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
809
{
810 811
  if (BUFFERP (buffer))
    Fset_buffer (buffer);
Juanma Barranquero's avatar
Juanma Barranquero committed
812

Jim Blandy's avatar
Jim Blandy committed
813 814 815 816
  command_loop_level--;
  update_mode_lines = 1;
  return Qnil;
}
817

Jim Blandy's avatar
Jim Blandy committed
818

819 820
#if 0  /* These two functions are now replaced with
          temporarily_switch_to_single_kboard. */
Karl Heuer's avatar
Karl Heuer committed
821
static void
822
any_kboard_state ()
Karl Heuer's avatar
Karl Heuer committed
823
{
824 825 826 827
#if 0 /* Theory: if there's anything in Vunread_command_events,
	 it will right away be read by read_key_sequence,
	 and then if we do switch KBOARDS, it will go into the side
	 queue then.  So we don't need to do anything special here -- rms.  */
Karl Heuer's avatar
Karl Heuer committed
828
  if (CONSP (Vunread_command_events))
829
    {
830 831 832
      current_kboard->kbd_queue
	= nconc2 (Vunread_command_events, current_kboard->kbd_queue);
      current_kboard->kbd_queue_has_data = 1;
833
    }
Karl Heuer's avatar
Karl Heuer committed
834
  Vunread_command_events = Qnil;
835 836
#endif
  single_kboard = 0;
Karl Heuer's avatar
Karl Heuer committed
837
}
838 839 840 841 842 843 844 845 846

/* Switch to the single-kboard state, making current_kboard
   the only KBOARD from which further input is accepted.  */

void
single_kboard_state ()
{
  single_kboard = 1;
}
847
#endif
848

849 850 851 852
/* If we're in single_kboard state for kboard KBOARD,
   get out of it.  */

void
853
not_single_kboard_state (KBOARD *kboard)
854 855 856 857 858
{
  if (kboard == current_kboard)
    single_kboard = 0;
}

859 860 861 862 863 864 865 866 867 868 869 870 871
/* Maintain a stack of kboards, so other parts of Emacs
   can switch temporarily to the kboard of a given frame
   and then revert to the previous status.  */

struct kboard_stack
{
  KBOARD *kboard;
  struct kboard_stack *next;
};

static struct kboard_stack *kboard_stack;

void
872
push_kboard (struct kboard *k)
873 874 875 876 877 878 879 880
{
  struct kboard_stack *p
    = (struct kboard_stack *) xmalloc (sizeof (struct kboard_stack));

  p->next = kboard_stack;
  p->kboard = current_kboard;
  kboard_stack = p;

881
  current_kboard = k;
882 883 884
}

void
885
pop_kboard (void)
886
{
887
  struct terminal *t;
888
  struct kboard_stack *p = kboard_stack;
889
  int found = 0;
890
  for (t = terminal_list; t; t = t->next_terminal)
891
    {
892
      if (t->kboard == p->kboard)
893 894
        {
          current_kboard = p->kboard;
895
          found = 1;
896 897 898
          break;
        }
    }
899
  if (!found)
900
    {
901
      /* The terminal we remembered has been deleted.  */
902
      current_kboard = FRAME_KBOARD (SELECTED_FRAME ());
903
      single_kboard = 0;
904
    }
905 906 907
  kboard_stack = p->next;
  xfree (p);
}
908

909 910 911 912 913 914 915 916 917
/* Switch to single_kboard mode, making current_kboard the only KBOARD
  from which further input is accepted.  If F is non-nil, set its
  KBOARD as the current keyboard.

  This function uses record_unwind_protect to return to the previous
  state later.

  If Emacs is already in single_kboard mode, and F's keyboard is
  locked, then this function will throw an errow.  */
918 919

void
920
temporarily_switch_to_single_kboard (struct frame *f)
921 922
{
  int was_locked = single_kboard;
923 924
  if (was_locked)
    {
925 926
      if (f != NULL && FRAME_KBOARD (f) != current_kboard)
        /* We can not switch keyboards while in single_kboard mode.
Karoly Lorentey's avatar
Karoly Lorentey committed
927 928 929 930 931 932
           In rare cases, Lisp code may call `recursive-edit' (or
           `read-minibuffer' or `y-or-n-p') after it switched to a
           locked frame.  For example, this is likely to happen
           when server.el connects to a new terminal while Emacs is in
           single_kboard mode.  It is best to throw an error instead
           of presenting the user with a frozen screen.  */
933 934
        error ("Terminal %d is locked, cannot read from it",
               FRAME_TERMINAL (f)->id);
935
      else
936 937 938
        /* This call is unnecessary, but helps
           `restore_kboard_configuration' discover if somebody changed
           `current_kboard' behind our back.  */
939 940
        push_kboard (current_kboard);
    }
941 942 943
  else if (f != NULL)
    current_kboard = FRAME_KBOARD (f);
  single_kboard = 1;
944 945 946 947
  record_unwind_protect (restore_kboard_configuration,
                         (was_locked ? Qt : Qnil));
}

948
#if 0 /* This function is not needed anymore.  */