callint.c 30.2 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2
   Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
3 4
                 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
5 6 7

This file is part of GNU Emacs.

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

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

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
20 21


22
#include <config.h>
23

Michael I. Bushnell's avatar
Michael I. Bushnell committed
24 25 26
#include "lisp.h"
#include "buffer.h"
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "keyboard.h"
Michael I. Bushnell's avatar
Michael I. Bushnell committed
28
#include "window.h"
Stefan Monnier's avatar
Stefan Monnier committed
29
#include "keymap.h"
Michael I. Bushnell's avatar
Michael I. Bushnell committed
30

Gerd Moellmann's avatar
Gerd Moellmann committed
31 32
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
33
#endif
Michael I. Bushnell's avatar
Michael I. Bushnell committed
34

35
extern Lisp_Object Qcursor_in_echo_area;
36
extern Lisp_Object Qfile_directory_p;
37
extern Lisp_Object Qonly;
38

39
Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
40 41 42
Lisp_Object Qcall_interactively;
Lisp_Object Vcommand_history;

43
extern Lisp_Object Vhistory_length;
44
extern Lisp_Object Vthis_original_command, real_this_command;
45

Michael I. Bushnell's avatar
Michael I. Bushnell committed
46
Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
Richard M. Stallman's avatar
Richard M. Stallman committed
47
Lisp_Object Qenable_recursive_minibuffers;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
48

49 50 51 52
/* Non-nil means treat the mark as active
   even if mark_active is 0.  */
Lisp_Object Vmark_even_if_inactive;

Chong Yidong's avatar
Chong Yidong committed
53 54
Lisp_Object Vshift_select_mode, Qhandle_shift_selection;

55 56
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

57
Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif, Qwhen;
58 59 60 61
static Lisp_Object preserved_fns;

/* Marker used within call-interactively to refer to point.  */
static Lisp_Object point_marker;
62

63 64
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
65

Michael I. Bushnell's avatar
Michael I. Bushnell committed
66 67
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
       doc: /* Specify a way of parsing arguments for interactive use of a function.
For example, write
  (defun foo (arg) "Doc string" (interactive "p") ...use arg...)
to make ARG be the prefix argument when `foo' is called as a command.
The "call" to `interactive' is actually a declaration rather than a function;
 it tells `call-interactively' how to read arguments
 to pass to the function.
When actually called, `interactive' just returns nil.

The argument of `interactive' is usually a string containing a code letter
 followed by a prompt.  (Some code letters do not use I/O to get
 the argument and do not need prompts.)  To prompt for multiple arguments,
 give a code letter, its prompt, a newline, and another code letter, etc.
 Prompts are passed to format, and may use % escapes to print the
 arguments that have already been read.
If the argument is not a string, it is evaluated to get a list of
 arguments to pass to the function.
Just `(interactive)' means pass no args when calling interactively.

Code letters available are:
a -- Function name: symbol with a function definition.
b -- Name of existing buffer.
B -- Name of buffer, possibly nonexistent.
c -- Character (no input method is used).
C -- Command name: symbol with interactive function definition.
d -- Value of point as number.  Does not do I/O.
D -- Directory name.
e -- Parametrized event (i.e., one that's a list) that invoked this command.
     If used more than once, the Nth `e' returns the Nth parameterized event.
     This skips events that are integers or symbols.
f -- Existing file name.
F -- Possibly nonexistent file name.
100
G -- Possibly nonexistent file name, defaulting to just directory name.
101 102 103 104 105 106
i -- Ignored, i.e. always nil.  Does not do I/O.
k -- Key sequence (downcase the last event if needed to get a definition).
K -- Key sequence to be redefined (do not downcase the last event).
m -- Value of mark as number.  Does not do I/O.
M -- Any string.  Inherits the current input method.
n -- Number read using minibuffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
107
N -- Numeric prefix arg, or if none, do like code `n'.
108 109 110 111 112
p -- Prefix arg converted to number.  Does not do I/O.
P -- Prefix arg in raw form.  Does not do I/O.
r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.
s -- Any string.  Does not inherit the current input method.
S -- Any symbol.
113
U -- Mouse up event discarded by a previous k or K argument.
114 115 116 117 118
v -- Variable name: symbol that is user-variable-p.
x -- Lisp expression read but not evaluated.
X -- Lisp expression read and evaluated.
z -- Coding system.
Z -- Coding system, nil if no prefix arg.
Chong Yidong's avatar
Chong Yidong committed
119 120 121 122 123 124 125 126 127 128

In addition, if the string begins with `*', an error is signaled if
  the buffer is read-only.
If the string begins with `@', Emacs searches the key sequence which
 invoked the command for its first mouse click (or any other event
 which specifies a window).
If the string begins with `^' and `shift-select-mode' is non-nil,
 Emacs first calls the function `handle-shift-select'.
You may use `@', `*', and `^' together.  They are processed in the
 order that they appear, before reading any arguments.
129
usage: (interactive ARGS)  */)
130
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
131 132 133 134 135 136 137 138 139 140 141
     Lisp_Object args;
{
  return Qnil;
}

/* Quotify EXP: if EXP is constant, return it.
   If EXP is not constant, return (quote EXP).  */
Lisp_Object
quotify_arg (exp)
     register Lisp_Object exp;
{
142
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
143
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
144 145 146 147 148 149 150 151 152 153 154
    return Fcons (Qquote, Fcons (exp, Qnil));

  return exp;
}

/* Modify EXP by quotifying each element (except the first).  */
Lisp_Object
quotify_args (exp)
     Lisp_Object exp;
{
  register Lisp_Object tail;
155 156
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
157
    {
158
      next = XCDR (tail);
159
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
160 161 162 163 164 165 166 167
    }
  return exp;
}

char *callint_argfuns[]
    = {"", "point", "mark", "region-beginning", "region-end"};

static void
168 169
check_mark (for_region)
     int for_region;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
170
{
171 172
  Lisp_Object tem;
  tem = Fmarker_buffer (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
173
  if (NILP (tem) || (XBUFFER (tem) != current_buffer))
174 175
    error (for_region ? "The mark is not set now, so there is no region"
	   : "The mark is not set now");
176 177
  if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
      && NILP (current_buffer->mark_active))
Kim F. Storm's avatar
Kim F. Storm committed
178
    xsignal0 (Qmark_inactive);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
179 180
}

Richard M. Stallman's avatar
Richard M. Stallman committed
181 182 183 184 185 186 187 188
/* If the list of args INPUT was produced with an explicit call to
   `list', look for elements that were computed with
   (region-beginning) or (region-end), and put those expressions into
   VALUES instead of the present values.

   This function doesn't return a value because it modifies elements
   of VALUES to do its job.  */

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
static void
fix_command (input, values)
     Lisp_Object input, values;
{
  if (CONSP (input))
    {
      Lisp_Object car;

      car = XCAR (input);
      /* Skip through certain special forms.  */
      while (EQ (car, Qlet) || EQ (car, Qletx)
	     || EQ (car, Qsave_excursion)
	     || EQ (car, Qprogn))
	{
	  while (CONSP (XCDR (input)))
	    input = XCDR (input);
	  input = XCAR (input);
	  if (!CONSP (input))
	    break;
	  car = XCAR (input);
	}
      if (EQ (car, Qlist))
	{
	  Lisp_Object intail, valtail;
	  for (intail = Fcdr (input), valtail = values;
	       CONSP (valtail);
Stefan Monnier's avatar
Stefan Monnier committed
215
	       intail = Fcdr (intail), valtail = XCDR (valtail))
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
	    {
	      Lisp_Object elt;
	      elt = Fcar (intail);
	      if (CONSP (elt))
		{
		  Lisp_Object presflag, carelt;
		  carelt = Fcar (elt);
		  /* If it is (if X Y), look at Y.  */
		  if (EQ (carelt, Qif)
		      && EQ (Fnthcdr (make_number (3), elt), Qnil))
		    elt = Fnth (make_number (2), elt);
		  /* If it is (when ... Y), look at Y.  */
		  else if (EQ (carelt, Qwhen))
		    {
		      while (CONSP (XCDR (elt)))
			elt = XCDR (elt);
		      elt = Fcar (elt);
		    }

		  /* If the function call we're looking at
		     is a special preserved one, copy the
		     whole expression for this argument.  */
		  if (CONSP (elt))
		    {
		      presflag = Fmemq (Fcar (elt), preserved_fns);
		      if (!NILP (presflag))
			Fsetcar (valtail, Fcar (intail));
		    }
		}
	    }
	}
    }
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
249

250
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
251 252 253 254 255 256 257 258 259 260
       doc: /* Call FUNCTION, reading args according to its interactive calling specs.
Return the value FUNCTION returns.
The function contains a specification of how to do the argument reading.
In the case of user-defined functions, this is specified by placing a call
to the function `interactive' at the top level of the function body.
See `interactive'.

Optional second arg RECORD-FLAG non-nil
means unconditionally put this command in the command-history.
Otherwise, this is done only if an arg is read using the minibuffer.
261

262
Optional third arg KEYS, if given, specifies the sequence of events to
263 264 265
supply, as a vector, if the command inquires which events were used to
invoke it.  If KEYS is omitted or nil, the return value of
`this-command-keys-vector' is used.  */)
266
     (function, record_flag, keys)
267
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
268 269 270
{
  Lisp_Object *args, *visargs;
  Lisp_Object specs;
271
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
272
  Lisp_Object teml;
273
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
274
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
275
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
276

277 278
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
279
  int next_event;
280

Michael I. Bushnell's avatar
Michael I. Bushnell committed
281 282 283
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287

  /* If varies[i] > 0, the i'th argument shouldn't just have its value
     in this call quoted in the command history.  It should be
     recorded as a call to the function named callint_argfuns[varies[i]].  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
288
  int *varies;
Jim Blandy's avatar
Jim Blandy committed
289

Michael I. Bushnell's avatar
Michael I. Bushnell committed
290 291 292 293 294
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
295
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
296
  int key_count;
297
  int record_then_fail = 0;
298

299 300 301 302 303 304 305 306
  Lisp_Object save_this_command, save_last_command;
  Lisp_Object save_this_original_command, save_real_this_command;

  save_this_command = Vthis_command;
  save_this_original_command = Vthis_original_command;
  save_real_this_command = real_this_command;
  save_last_command = current_kboard->Vlast_command;

307 308 309 310
  if (NILP (keys))
    keys = this_command_keys, key_count = this_command_key_count;
  else
    {
311
      CHECK_VECTOR (keys);
312 313
      key_count = XVECTOR (keys)->size;
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
314

Jim Blandy's avatar
Jim Blandy committed
315
  /* Save this now, since use of minibuffer will clobber it. */
316
  prefix_arg = Vcurrent_prefix_arg;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
317

318
  if (SYMBOLP (function))
319
    enable = Fget (function, Qenable_recursive_minibuffers);
320 321
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
322

Michael I. Bushnell's avatar
Michael I. Bushnell committed
323 324
  specs = Qnil;
  string = 0;
325 326 327 328
  /* The idea of FILTER_SPECS is to provide away to
     specify how to represent the arguments in command history.
     The feature is not fully implemented.  */
  filter_specs = Qnil;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
329

330 331 332
  /* If k or K discard an up-event, save it here so it can be retrieved with U */
  up_event = Qnil;

333
  /* Set SPECS to the interactive form, or barf if not interactive.  */
334 335 336 337 338 339 340 341 342 343
  {
    Lisp_Object form;
    GCPRO2 (function, prefix_arg);
    form = Finteractive_form (function);
    UNGCPRO;
    if (CONSP (form))
      specs = filter_specs = Fcar (XCDR (form));
    else
      wrong_type_argument (Qcommandp, function);
  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
344

345
  /* If SPECS is set to a string, use it as an interactive prompt.  */
346
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
347 348 349
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
350 351 352
      string = (unsigned char *) alloca (SBYTES (specs) + 1);
      bcopy (SDATA (specs), string,
	     SBYTES (specs) + 1);
Jim Blandy's avatar
Jim Blandy committed
353
    }
354
  else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
355
    {
356
      Lisp_Object input;
357
      i = num_input_events;
358 359
      input = specs;
      /* Compute the arg values using the user's expression.  */
360
      GCPRO2 (input, filter_specs);
361
      specs = Feval (specs);
362
      UNGCPRO;
363
      if (i != num_input_events || !NILP (record_flag))
364 365
	{
	  /* We should record this command on the command history.  */
366
	  Lisp_Object values;
367 368 369
	  /* Make a copy of the list of values, for the command history,
	     and turn them into things we can eval.  */
	  values = quotify_args (Fcopy_sequence (specs));
370
	  fix_command (input, values);
371 372
	  Vcommand_history
	    = Fcons (Fcons (function, values), Vcommand_history);
373 374

	  /* Don't keep command history around forever.  */
375
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
376 377 378
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
379
		XSETCDR (teml, Qnil);
380
	    }
381
	}
382 383 384 385 386 387

      Vthis_command = save_this_command;
      Vthis_original_command = save_this_original_command;
      real_this_command= save_real_this_command;
      current_kboard->Vlast_command = save_last_command;

388 389
      temporarily_switch_to_single_kboard (NULL);
      return unbind_to (speccount, apply1 (function, specs));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
390 391 392 393
    }

  /* Here if function specifies a string to control parsing the defaults */

Jim Blandy's avatar
Jim Blandy committed
394
  /* Set next_event to point to the first event with parameters.  */
395
  for (next_event = 0; next_event < key_count; next_event++)
396
    if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
Jim Blandy's avatar
Jim Blandy committed
397
      break;
398

399
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
400
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
401 402
  while (1)
    {
403
      if (*string == '+')
404 405
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
406 407
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
408
	  if (!NILP (current_buffer->read_only))
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
	    {
	      if (!NILP (record_flag))
		{
		  unsigned char *p = string;
		  while (*p)
		    {
		      if (! (*p == 'r' || *p == 'p' || *p == 'P'
			     || *p == '\n'))
			Fbarf_if_buffer_read_only ();
		      p++;
		    }
		  record_then_fail = 1;
		}
	      else
		Fbarf_if_buffer_read_only ();
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
425
	}
426 427 428
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
429 430
      else if (*string == '@')
	{
431
	  Lisp_Object event, tem;
Jim Blandy's avatar
Jim Blandy committed
432

433
	  event = (next_event < key_count
434
		   ? AREF (keys, next_event)
435
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
436
	  if (EVENT_HAS_PARAMETERS (event)
437 438 439
	      && (tem = XCDR (event), CONSP (tem))
	      && (tem = XCAR (tem), CONSP (tem))
	      && (tem = XCAR (tem), WINDOWP (tem)))
440
	    {
441 442
	      if (MINI_WINDOW_P (XWINDOW (tem))
		  && ! (minibuf_level > 0 && EQ (tem, minibuf_window)))
443
		error ("Attempt to select inactive minibuffer window");
444 445 446 447 448

	      /* If the current buffer wants to clean up, let it.  */
	      if (!NILP (Vmouse_leave_buffer_hook))
		call1 (Vrun_hooks, Qmouse_leave_buffer_hook);

449
	      Fselect_window (tem, Qnil);
450
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
451 452
	  string++;
	}
Chong Yidong's avatar
Chong Yidong committed
453 454 455
      else if (*string == '^')
	{
	  if (! NILP (Vshift_select_mode))
456 457 458 459 460 461 462
	    call1 (Qhandle_shift_selection, Qnil);
	  /* Even if shift-select-mode is off, temporarily active
	     regions could be set using the mouse, and should be
	     deactivated.  */
	  else if (CONSP (Vtransient_mark_mode)
		   && EQ (XCAR (Vtransient_mark_mode), Qonly))
	    call1 (Qhandle_shift_selection, Qt);
Chong Yidong's avatar
Chong Yidong committed
463 464
	  string++;
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
465 466 467 468 469 470
      else break;
    }

  /* Count the number of arguments the interactive spec would have
     us give to the function.  */
  tem = string;
471
  for (j = 0; *tem;)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
472 473 474
    {
      /* 'r' specifications ("point and mark as 2 numeric args")
	 produce *two* arguments.  */
475 476 477 478
      if (*tem == 'r')
	j += 2;
      else
	j++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
479 480
      tem = (unsigned char *) index (tem, '\n');
      if (tem)
481
	++tem;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
482
      else
483
	break;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
484
    }
485
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
486 487 488 489 490 491 492 493 494 495 496 497

  args = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
  visargs = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
  varies = (int *) alloca ((count + 1) * sizeof (int));

  for (i = 0; i < (count + 1); i++)
    {
      args[i] = Qnil;
      visargs[i] = Qnil;
      varies[i] = 0;
    }

498
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
499 500 501
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
502 503 504
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
505
  tem = string;
506
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
507 508 509
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
510
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
511
      if (tem1) *tem1 = 0;
512 513 514 515 516 517

      visargs[0] = build_string (prompt1);
      if (index (prompt1, '%'))
	callint_message = Fformat (i, visargs);
      else
	callint_message = visargs[0];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
518 519 520 521

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
522
	  visargs[i] = Fcompleting_read (callint_message,
523
					 Vobarray, Qfboundp, Qt,
524
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
525 526 527 528 529 530
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'b':   		/* Name of existing buffer */
531 532 533 534 535 536
	  args[i] = Fcurrent_buffer ();
	  if (EQ (selected_window, minibuf_window))
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
	  args[i] = Fread_buffer (callint_message, args[i], Qt);
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
537
	case 'B':		/* Name of buffer, possibly nonexistent */
538 539 540
	  args[i] = Fread_buffer (callint_message,
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
541 542 543
	  break;

        case 'c':		/* Character */
544
	  args[i] = Fread_char (callint_message, Qnil, Qnil);
545
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
546 547 548 549 550 551
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
552
	  visargs[i] = Fcompleting_read (callint_message,
553
					 Vobarray, Qcommandp,
554
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
555 556 557 558 559 560
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'd':		/* Value of point.  Does not do I/O.  */
561
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
562
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
563 564 565 566 567
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
568
	  args[i] = Fread_file_name (callint_message, Qnil,
569 570
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
571 572 573
	  break;

	case 'f':		/* Existing file name. */
574
	  args[i] = Fread_file_name (callint_message,
575
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
576 577 578
	  break;

	case 'F':		/* Possibly nonexistent file name. */
579
	  args[i] = Fread_file_name (callint_message,
580
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
581 582
	  break;

583 584
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
585
	  args[i] = Fread_file_name (callint_message,
586
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
587 588
	  break;

589 590 591 592
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

593
	case 'k':		/* Key sequence. */
594
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
595
	    int speccount1 = SPECPDL_INDEX ();
596
	    specbind (Qcursor_in_echo_area, Qt);
597
	    args[i] = Fread_key_sequence (callint_message,
598
					  Qnil, Qnil, Qnil, Qnil);
599 600
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
601
	    visargs[i] = Fkey_description (teml, Qnil);
602 603 604 605 606

	    /* If the key sequence ends with a down-event,
	       discard the following up-event.  */
	    teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
	    if (CONSP (teml))
607
	      teml = XCAR (teml);
608 609 610 611 612
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
613 614
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
615
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
616
		  up_event = Fread_event (Qnil, Qnil, Qnil);
617
	      }
618
	  }
619 620 621
	  break;

	case 'K':		/* Key sequence to be defined. */
622
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
623
	    int speccount1 = SPECPDL_INDEX ();
624
	    specbind (Qcursor_in_echo_area, Qt);
625
	    args[i] = Fread_key_sequence (callint_message,
626
					  Qnil, Qt, Qnil, Qnil);
627
	    teml = args[i];
628
	    visargs[i] = Fkey_description (teml, Qnil);
629
	    unbind_to (speccount1, Qnil);
630 631 632 633 634

	    /* If the key sequence ends with a down-event,
	       discard the following up-event.  */
	    teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
	    if (CONSP (teml))
635
	      teml = XCAR (teml);
636 637 638 639 640
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
641 642
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
643
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
644
		  up_event = Fread_event (Qnil, Qnil, Qnil);
645
	      }
646
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
647 648
	  break;

649 650 651 652 653 654 655 656 657 658
	case 'U':		/* Up event from last k or K */
	  if (!NILP (up_event))
	    {
	      args[i] = Fmake_vector (make_number (1), up_event);
	      up_event = Qnil;
	      teml = args[i];
	      visargs[i] = Fkey_description (teml, Qnil);
	    }
	  break;

659
	case 'e':		/* The invoking event.  */
660
	  if (next_event >= key_count)
661
	    error ("%s must be bound to an event with parameters",
662
		   (SYMBOLP (function)
663
		    ? (char *) SDATA (SYMBOL_NAME (function))
664
		    : "command"));
665 666
	  args[i] = AREF (keys, next_event);
	  next_event++;
Jim Blandy's avatar
Jim Blandy committed
667
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
668 669

	  /* Find the next parameterized event.  */
670
	  while (next_event < key_count
671
		 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
Jim Blandy's avatar
Jim Blandy committed
672 673
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
674 675
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
676
	case 'm':		/* Value of mark.  Does not do I/O.  */
677
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
678
	  /* visargs[i] = Qnil; */
679
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
680 681 682
	  varies[i] = 2;
	  break;

683 684
	case 'M':		/* String read via minibuffer with
				   inheriting the current input method.  */
685
	  args[i] = Fread_string (callint_message,
686 687 688
				  Qnil, Qnil, Qnil, Qt);
	  break;

Richard M. Stallman's avatar
Richard M. Stallman committed
689
	case 'N':		/* Prefix arg as number, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
690
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
691 692
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
693 694 695 696 697
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
698
		if (! first)
699 700
		  {
		    message ("Please enter a number.");
701
		    sit_for (make_number (1), 0, 0);
702 703 704
		  }
		first = 0;

705
		tem = Fread_from_minibuffer (callint_message,
706
					     Qnil, Qnil, Qnil, Qnil, Qnil,
707
					     Qnil);
708
		if (! STRINGP (tem) || SCHARS (tem) == 0)
709 710 711 712 713 714
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
715
	  visargs[i] = args[i];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
716 717 718 719 720 721 722 723 724
	  break;

	case 'P':		/* Prefix arg in raw form.  Does no I/O.  */
	  args[i] = prefix_arg;
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'p':		/* Prefix arg converted to number.  No I/O. */
725
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
726 727 728 729 730 731
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
732
	  check_mark (1);
733
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
734 735 736
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
737
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
738
	  varies[i] = 3;
739
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
740 741 742
	  varies[i] = 4;
	  break;

743 744
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
745
	  args[i] = Fread_string (callint_message,
746
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
747 748 749
	  break;

	case 'S':		/* Any symbol.  */
750
	  visargs[i] = Fread_string (callint_message,
751
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
752 753 754 755 756 757 758
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'v':		/* Variable name: symbol that is
				   user-variable-p. */
759
	  args[i] = Fread_variable (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
760 761 762 763
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
764
	  args[i] = Fread_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
765 766 767 768
	  visargs[i] = last_minibuf_string;
	  break;

	case 'X':		/* Lisp expression read and evaluated */
769
	  args[i] = Feval_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
770 771 772
	  visargs[i] = last_minibuf_string;
 	  break;

773 774 775 776 777 778 779
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
780
	  else
781 782
	    {
	      args[i]
783
		= Fread_non_nil_coding_system (callint_message);
784 785 786 787 788
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
789
	  args[i] = Fread_coding_system (callint_message, Qnil);
790 791 792
	  visargs[i] = last_minibuf_string;
	  break;

793 794 795
	  /* We have a case for `+' so we get an error
	     if anyone tries to define one here.  */
	case '+':
Michael I. Bushnell's avatar
Michael I. Bushnell committed
796
	default:
797
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
798 799 800 801 802 803
		 *tem, *tem);
	}

      if (varies[i] == 0)
	arg_from_tty = 1;

804
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
805 806 807 808 809 810
	visargs[i] = args[i];

      tem = (unsigned char *) index (tem, '\n');
      if (tem) tem++;
      else tem = (unsigned char *) "";
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
811
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
812 813 814 815 816

  QUIT;

  args[0] = function;

817
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
818 819
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
820
      for (i = 1; i < count + 1; i++)
821 822 823 824 825 826
	{
	  if (varies[i] > 0)
	    visargs[i] = Fcons (intern (callint_argfuns[varies[i]]), Qnil);
	  else
	    visargs[i] = quotify_arg (args[i]);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
827 828
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
829
      /* Don't keep command history around forever.  */
830
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
831 832 833
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
834
	    XSETCDR (teml, Qnil);
835
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
836 837
    }

838 839
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
840
  for (i = 1; i <= count; i++)
841 842 843
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

844 845 846
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

847 848 849 850 851
  Vthis_command = save_this_command;
  Vthis_original_command = save_this_original_command;
  real_this_command= save_real_this_command;
  current_kboard->Vlast_command = save_last_command;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
852 853 854 855
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

856
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
857 858 859 860
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
861
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
862 863

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
864 865 866 867 868
       1, 1, 0,
       doc: /* Return numeric meaning of raw prefix argument RAW.
A raw prefix argument is what you get from `(interactive "P")'.
Its numeric meaning is what you would get from `(interactive "p")'.  */)
     (raw)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
869 870 871
     Lisp_Object raw;
{
  Lisp_Object val;
872

Jim Blandy's avatar
Jim Blandy committed
873
  if (NILP (raw))
874
    XSETFASTINT (val, 1);
875
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
876
    XSETINT (val, -1);
877 878
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
879
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
880 881
    val = raw;
  else
882
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
883 884 885 886

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
887
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
888 889
syms_of_callint ()
{
890 891 892
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

893 894 895
  callint_message = Qnil;
  staticpro (&callint_message);

896 897 898 899 900 901 902 903
  preserved_fns = Fcons (intern ("region-beginning"),
			 Fcons (intern ("region-end"),
				Fcons (intern ("point"),
				       Fcons (intern ("mark"), Qnil))));
  staticpro (&preserved_fns);

  Qlist = intern ("list");
  staticpro (&Qlist);
904 905
  Qlet = intern ("let");
  staticpro (&Qlet);
906 907 908 909
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
910 911 912 913
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
914 915
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
916

Michael I. Bushnell's avatar
Michael I. Bushnell committed
917 918 919
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
920 921 922
  Qplus = intern ("+");
  staticpro (&Qplus);

Chong Yidong's avatar
Chong Yidong committed
923 924 925
  Qhandle_shift_selection = intern ("handle-shift-selection");
  staticpro (&Qhandle_shift_selection);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
926 927 928 929 930 931
  Qcall_interactively = intern ("call-interactively");
  staticpro (&Qcall_interactively);

  Qcommand_debug_status = intern ("command-debug-status");
  staticpro (&Qcommand_debug_status);

Richard M. Stallman's avatar
Richard M. Stallman committed
932 933 934
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

935 936 937
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

938
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
939 940 941 942 943 944 945 946 947
		 doc: /* The value of the prefix argument for the next editing command.
It may be a number, or the symbol `-' for just a minus sign as arg,
or a list whose car is a number for just one or more C-u's
or nil if no argument has been specified.

You cannot examine this variable to find the argument for this command
since it has been set to nil by the time you can look.
Instead, you should use the variable `current-prefix-arg', although
normally commands can get this prefix argument with (interactive "P").  */);
948

949
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
950 951
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
952

953
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
954 955 956 957 958
	       doc: /* The value of the prefix argument for this editing command.
It may be a number, or the symbol `-' for just a minus sign as arg,
or a list whose car is a number for just one or more C-u's
or nil if no argument has been specified.
This is what `(interactive \"P\")' returns.  */);
959 960
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
961
  DEFVAR_LISP ("command-history", &Vcommand_history,
962
	       doc: /* List of recent commands that read arguments from terminal.
963 964 965 966
Each command is represented as a form to evaluate.

Maximum length of the history list is determined by the value
of `history-length', which see.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
967 968 969
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
970 971 972
	       doc: /* Debugging status of current interactive command.
Bound each time `call-interactively' is called;
may be set by the debugger as a reminder for itself.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
973 974
  Vcommand_debug_status = Qnil;

975
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
976 977 978 979 980
	       doc: /* *Non-nil means you can use the mark even when inactive.
This option makes a difference in Transient Mark mode.
When the option is non-nil, deactivation of the mark
turns off region highlighting, but commands that use the mark
behave as if the mark were still active.  */);
981
  Vmark_even_if_inactive = Qt;
982

Chong Yidong's avatar
Chong Yidong committed
983 984 985 986 987 988 989 990 991 992 993 994 995 996
  DEFVAR_LISP ("shift-select-mode", &Vshift_select_mode,
	       doc: /* When non-nil, shifted motion keys activate the mark momentarily.

While the mark is activated in this way, any shift-translated point
motion key extends the region, and if Transient Mark mode was off, it
is temporarily turned on.  Furthermore, the mark will be deactivated
by any subsequent point motion key that was not shift-translated, or
by any action that normally deactivates the mark in Transient Mark
mode.

See `this-command-keys-shift-translated' for the meaning of
shift-translation.  */);
  Vshift_select_mode = Qt;

997
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
998 999 1000
	       doc: /* Hook to run when about to switch windows with a mouse command.
Its purpose is to give temporary modes such as Isearch mode
a way to turn themselves off when a mouse command switches windows.  */);
1001 1002