callint.c 29.1 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2
   Copyright (C) 1985, 86, 93, 94, 95, 1997, 2000, 02, 2003
3
   Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell 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
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Michael I. Bushnell's avatar
Michael I. Bushnell 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.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
21 22


23
#include <config.h>
24

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

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

36
extern Lisp_Object Qcursor_in_echo_area;
37
extern Lisp_Object Qfile_directory_p;
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 44
extern Lisp_Object Vhistory_length;

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

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

52 53
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

54
Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif, Qwhen;
55 56 57 58
static Lisp_Object preserved_fns;

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

60 61 62 63 64
/* Buffer for the prompt text used in Fcall_interactively.  */
static char *callint_message;

/* Allocated length of that buffer.  */
static int callint_message_size;
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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
       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.
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.
N -- Raw prefix arg, or if none, do like code `n'.
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.
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.
In addition, if the string begins with `*'
 then an error is signaled if the buffer is read-only.
 This happens before reading any arguments.
If the string begins with `@', then Emacs searches the key sequence
 which invoked the command for its first mouse click (or any other
 event which specifies a window), and selects that window before
 reading any arguments.  You may use both `@' and `*'; they are
124 125
 processed in the order that they appear.
usage: (interactive ARGS)  */)
126
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
127 128 129 130 131 132 133 134 135 136 137
     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;
{
138
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
139
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
140 141 142 143 144 145 146 147 148 149 150
    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;
151 152
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
153
    {
154
      next = XCDR (tail);
155
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
156 157 158 159 160 161 162 163
    }
  return exp;
}

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179 180 181 182 183 184
/* 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.  */

185 186 187 188 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 215 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
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);
	       intail = Fcdr (intail), valtail = Fcdr (valtail))
	    {
	      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
245

246
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
247 248 249 250 251 252 253 254 255 256 257 258 259
       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.
Optional third arg KEYS, if given, specifies the sequence of events to
supply if the command inquires which events were used to invoke it.  */)
     (function, record_flag, keys)
260
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
261 262 263 264 265 266
{
  Lisp_Object *args, *visargs;
  unsigned char **argstrings;
  Lisp_Object fun;
  Lisp_Object funcar;
  Lisp_Object specs;
267
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
268
  Lisp_Object teml;
Richard M. Stallman's avatar
Richard M. Stallman committed
269
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
270
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
271

272 273
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
274
  int next_event;
275

Michael I. Bushnell's avatar
Michael I. Bushnell committed
276 277 278
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
279 280 281 282

  /* 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
283
  int *varies;
Jim Blandy's avatar
Jim Blandy committed
284

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

  if (NILP (keys))
    keys = this_command_keys, key_count = this_command_key_count;
  else
    {
298
      CHECK_VECTOR (keys);
299 300
      key_count = XVECTOR (keys)->size;
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
301

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

Jim Blandy's avatar
Jim Blandy committed
305
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
306

307
  if (SYMBOLP (function))
308
    enable = Fget (function, Qenable_recursive_minibuffers);
309 310
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
311

Jim Blandy's avatar
Jim Blandy committed
312
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
313 314 315

  specs = Qnil;
  string = 0;
316 317 318 319
  /* 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
320 321 322 323 324

  /* Decode the kind of function.  Either handle it and return,
     or go to `lose' if not interactive, or go to `retry'
     to specify a different function, or set either STRING or SPECS.  */

325
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
326 327 328 329 330
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
331
	  function = wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
332 333 334
	  goto retry;
	}
    }
335
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
336
    {
Roland McGrath's avatar
Roland McGrath committed
337
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
338 339 340 341 342
	goto lose;
      specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
    }
  else if (!CONSP (fun))
    goto lose;
343
  else if (funcar = XCAR (fun), EQ (funcar, Qautoload))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
344 345 346 347 348 349 350 351
    {
      GCPRO2 (function, prefix_arg);
      do_autoload (fun, function);
      UNGCPRO;
      goto retry;
    }
  else if (EQ (funcar, Qlambda))
    {
352
      specs = Fassq (Qinteractive, Fcdr (XCDR (fun)));
Jim Blandy's avatar
Jim Blandy committed
353
      if (NILP (specs))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
354
	goto lose;
355
      filter_specs = Fnth (make_number (1), specs);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
356 357 358 359 360
      specs = Fcar (Fcdr (specs));
    }
  else
    goto lose;

361
  /* If either SPECS or STRING is set to a string, use it.  */
362
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
363 364 365
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
366 367 368
      string = (unsigned char *) alloca (SBYTES (specs) + 1);
      bcopy (SDATA (specs), string,
	     SBYTES (specs) + 1);
Jim Blandy's avatar
Jim Blandy committed
369
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
370 371
  else if (string == 0)
    {
372
      Lisp_Object input;
373
      i = num_input_events;
374 375
      input = specs;
      /* Compute the arg values using the user's expression.  */
376
      GCPRO2 (input, filter_specs);
377
      specs = Feval (specs);
378
      UNGCPRO;
379
      if (i != num_input_events || !NILP (record_flag))
380 381
	{
	  /* We should record this command on the command history.  */
382
	  Lisp_Object values;
383 384 385
	  /* 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));
386
	  fix_command (input, values);
387 388
	  Vcommand_history
	    = Fcons (Fcons (function, values), Vcommand_history);
389 390

	  /* Don't keep command history around forever.  */
391
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
392 393 394
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
395
		XSETCDR (teml, Qnil);
396
	    }
397
	}
398
      single_kboard_state ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
399 400 401 402 403
      return apply1 (function, specs);
    }

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

Jim Blandy's avatar
Jim Blandy committed
404
  /* Set next_event to point to the first event with parameters.  */
405 406
  for (next_event = 0; next_event < key_count; next_event++)
    if (EVENT_HAS_PARAMETERS (XVECTOR (keys)->contents[next_event]))
Jim Blandy's avatar
Jim Blandy committed
407
      break;
408

409
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
410
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
411 412
  while (1)
    {
413
      if (*string == '+')
414 415
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
416 417
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
418
	  if (!NILP (current_buffer->read_only))
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
	    {
	      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
435
	}
436 437 438
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
439 440
      else if (*string == '@')
	{
441
	  Lisp_Object event;
Jim Blandy's avatar
Jim Blandy committed
442

443 444 445
	  event = (next_event < key_count
		   ? XVECTOR (keys)->contents[next_event]
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
446
	  if (EVENT_HAS_PARAMETERS (event)
447 448 449
	      && (event = XCDR (event), CONSP (event))
	      && (event = XCAR (event), CONSP (event))
	      && (event = XCAR (event), WINDOWP (event)))
450
	    {
Karl Heuer's avatar
Karl Heuer committed
451
	      if (MINI_WINDOW_P (XWINDOW (event))
452
		  && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
453
		error ("Attempt to select inactive minibuffer window");
454 455 456 457 458

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

459
	      Fselect_window (event, Qnil);
460
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
	  string++;
	}
      else break;
    }

  /* Count the number of arguments the interactive spec would have
     us give to the function.  */
  tem = string;
  for (j = 0; *tem; j++)
    {
      /* 'r' specifications ("point and mark as 2 numeric args")
	 produce *two* arguments.  */
      if (*tem == 'r') j++;
      tem = (unsigned char *) index (tem, '\n');
      if (tem)
	tem++;
      else
	tem = (unsigned char *) "";
    }
480
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
481 482 483 484 485 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));
  argstrings = (unsigned char **) alloca ((count + 1) * sizeof (char *));
  varies = (int *) alloca ((count + 1) * sizeof (int));

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

  GCPRO4 (prefix_arg, function, *args, *visargs);
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
498 499 500
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
501
  tem = string;
502
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
503 504 505
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
506
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
507 508 509 510 511
      if (tem1) *tem1 = 0;
      /* Fill argstrings with a vector of C strings
	 corresponding to the Lisp strings in visargs.  */
      for (j = 1; j < i; j++)
	argstrings[j]
512 513
	  = (EQ (visargs[j], Qnil)
	     ? (unsigned char *) ""
514
	     : SDATA (visargs[j]));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
515

516 517 518 519 520 521 522 523
      /* Process the format-string in prompt1, putting the output
	 into callint_message.  Make callint_message bigger if necessary.
	 We don't use a buffer on the stack, because the contents
	 need to stay stable for a while.  */
      while (1)
	{
	  int nchars = doprnt (callint_message, callint_message_size,
			       prompt1, (char *)0,
524
			       j - 1, (char **) argstrings + 1);
525
	  if (nchars < callint_message_size - 1)
526 527 528 529 530
	    break;
	  callint_message_size *= 2;
	  callint_message
	    = (char *) xrealloc (callint_message, callint_message_size);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
531 532 533 534

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
535
	  visargs[i] = Fcompleting_read (build_string (callint_message),
536
					 Vobarray, Qfboundp, Qt,
537
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
538 539 540 541 542 543 544 545
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'b':   		/* Name of existing buffer */
	  args[i] = Fcurrent_buffer ();
	  if (EQ (selected_window, minibuf_window))
546
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
547
	  args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
548 549 550
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
551
	  args[i] = Fread_buffer (build_string (callint_message),
552
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
553
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
554 555 556
	  break;

        case 'c':		/* Character */
557
	  args[i] = Fread_char (build_string (callint_message), Qnil);
558
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
559 560 561 562 563 564
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
565
	  visargs[i] = Fcompleting_read (build_string (callint_message),
566
					 Vobarray, Qcommandp,
567
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
568 569 570 571 572 573
	  /* 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.  */
574
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
575
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
576 577 578 579 580
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
581
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
582 583
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
584 585 586
	  break;

	case 'f':		/* Existing file name. */
587
	  args[i] = Fread_file_name (build_string (callint_message),
588
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
589 590 591
	  break;

	case 'F':		/* Possibly nonexistent file name. */
592
	  args[i] = Fread_file_name (build_string (callint_message),
593
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
594 595
	  break;

596 597 598 599
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

600
	case 'k':		/* Key sequence. */
601
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
602
	    int speccount1 = SPECPDL_INDEX ();
603 604
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
605
					  Qnil, Qnil, Qnil, Qnil);
606 607 608
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
	    visargs[i] = Fkey_description (teml);
609 610 611 612 613

	    /* 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))
614
	      teml = XCAR (teml);
615 616 617 618 619
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
620 621
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
622
		if (! NILP (tem2))
623
		  Fread_event (Qnil, Qnil);
624
	      }
625
	  }
626 627 628
	  break;

	case 'K':		/* Key sequence to be defined. */
629
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
630
	    int speccount1 = SPECPDL_INDEX ();
631 632
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
633
					  Qnil, Qt, Qnil, Qnil);
634 635 636
	    teml = args[i];
	    visargs[i] = Fkey_description (teml);
	    unbind_to (speccount1, Qnil);
637 638 639 640 641

	    /* 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))
642
	      teml = XCAR (teml);
643 644 645 646 647
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
648 649
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
650
		if (! NILP (tem2))
651
		  Fread_event (Qnil, Qnil);
652
	      }
653
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
654 655
	  break;

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

	  /* Find the next parameterized event.  */
666
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
667
		 && ! (EVENT_HAS_PARAMETERS
668
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
669 670
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
671 672
	  break;

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

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

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

		tem = Fread_from_minibuffer (build_string (callint_message),
703 704
					     Qnil, Qnil, Qnil, Qnil, Qnil,
					     Qnil);
705
		if (! STRINGP (tem) || SCHARS (tem) == 0)
706 707 708 709 710 711
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
712 713 714 715 716 717 718 719 720 721
	  visargs[i] = last_minibuf_string;
	  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. */
722
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
723 724 725 726 727 728
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

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

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

	case 'S':		/* Any symbol.  */
747
	  visargs[i] = Fread_string (build_string (callint_message),
748
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
749 750 751 752 753 754 755
	  /* 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. */
756
	  args[i] = Fread_variable (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
757 758 759 760
	  visargs[i] = last_minibuf_string;
	  break;

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

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

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

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

790 791 792
	  /* 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
793
	default:
794
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
795 796 797 798 799 800
		 *tem, *tem);
	}

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

801
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
802 803 804 805 806 807
	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
808
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
809 810 811 812 813

  QUIT;

  args[0] = function;

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

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

841 842 843
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

844
  single_kboard_state ();
845

Michael I. Bushnell's avatar
Michael I. Bushnell committed
846 847 848 849 850 851 852 853
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
854
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
855 856

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
857 858 859 860 861
       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
862 863 864
     Lisp_Object raw;
{
  Lisp_Object val;
865

Jim Blandy's avatar
Jim Blandy committed
866
  if (NILP (raw))
867
    XSETFASTINT (val, 1);
868
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
869
    XSETINT (val, -1);
870 871
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
872
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
873 874
    val = raw;
  else
875
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
876 877 878 879

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
880
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
881 882
syms_of_callint ()
{
883 884 885
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

886 887 888 889 890 891 892 893
  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);
894 895
  Qlet = intern ("let");
  staticpro (&Qlet);
896 897 898 899
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
900 901 902 903
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
904 905
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
906

Michael I. Bushnell's avatar
Michael I. Bushnell committed
907 908 909
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
910 911 912
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
913 914 915 916 917 918
  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
919 920 921
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

922 923 924
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

925 926 927 928
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


929
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
930 931 932 933 934 935 936 937 938
		 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").  */);
939

940
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
941 942
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
943

944
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
945 946 947 948 949
	       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.  */);
950 951
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
952
  DEFVAR_LISP ("command-history", &Vcommand_history,
953 954
	       doc: /* List of recent commands that read arguments from terminal.
Each command is represented as a form to evaluate.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
955 956 957
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
958 959 960
	       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
961 962
  Vcommand_debug_status = Qnil;

963
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
964 965 966 967 968
	       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.  */);
969 970
  Vmark_even_if_inactive = Qnil;

971
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
972 973 974
	       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.  */);
975 976
  Vmouse_leave_buffer_hook = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
977 978 979 980
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}