callint.c 25.8 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 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
9 10 11 12 13 14 15 16 17 18 19 20
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21
#include <config.h>
Michael I. Bushnell's avatar
Michael I. Bushnell committed
22 23 24
#include "lisp.h"
#include "buffer.h"
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
25
#include "keyboard.h"
Michael I. Bushnell's avatar
Michael I. Bushnell committed
26 27 28 29 30
#include "window.h"
#include "mocklisp.h"

extern char *index ();

31
int current_prefix_partial;
32
Lisp_Object Vprefix_arg, Vcurrent_prefix_arg, Qminus, Qplus;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
33 34 35 36
Lisp_Object Qcall_interactively;
Lisp_Object Vcommand_history;

Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
Richard M. Stallman's avatar
Richard M. Stallman committed
37
Lisp_Object Qenable_recursive_minibuffers;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
38

39 40 41 42
/* Non-nil means treat the mark as active
   even if mark_active is 0.  */
Lisp_Object Vmark_even_if_inactive;

43 44
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

45
Lisp_Object Qlist;
46 47 48 49
static Lisp_Object preserved_fns;

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

51 52 53 54 55 56 57

void
clear_prefix_arg ()
{
  Vprefix_arg = Qnil;
  if (!current_prefix_partial)
    {
Karl Heuer's avatar
Karl Heuer committed
58 59 60 61
      current_kboard->prefix_factor = Qnil;
      current_kboard->prefix_value = Qnil;
      current_kboard->prefix_sign = 1;
      current_kboard->prefix_partial = 0;
62 63 64 65 66 67
    }
}

void
finalize_prefix_arg ()
{
Karl Heuer's avatar
Karl Heuer committed
68 69 70 71 72 73
  if (!NILP (current_kboard->prefix_factor))
    Vprefix_arg = Fcons (current_kboard->prefix_factor, Qnil);
  else if (NILP (current_kboard->prefix_value))
    Vprefix_arg = (current_kboard->prefix_sign > 0 ? Qnil : Qminus);
  else if (current_kboard->prefix_sign > 0)
    Vprefix_arg = current_kboard->prefix_value;
74
  else
Karl Heuer's avatar
Karl Heuer committed
75 76
    XSETINT (Vprefix_arg, -XINT (current_kboard->prefix_value));
  current_kboard->prefix_partial = 0;
77 78 79 80 81 82 83 84 85 86 87 88 89 90
}

static void
describe_prefix_arg ()
{
  if (INTEGERP (Vprefix_arg))
    message ("Arg: %d", Vprefix_arg);
  else if (CONSP (Vprefix_arg))
    message ("Arg: [%d]", XCONS (Vprefix_arg)->car);
  else if (EQ (Vprefix_arg, Qminus))
    message ("Arg: -");
}


Michael I. Bushnell's avatar
Michael I. Bushnell committed
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
/* This comment supplies the doc string for interactive,
   for make-docfile to see.  We cannot put this in the real DEFUN
   due to limits in the Unix cpp.

DEFUN ("interactive", Ffoo, Sfoo, 0, 0, 0,
 "Specify a way of parsing arguments for interactive use of a function.\n\
For example, write\n\
  (defun foo (arg) \"Doc string\" (interactive \"p\") ...use arg...)\n\
to make ARG be the prefix argument when `foo' is called as a command.\n\
The \"call\" to `interactive' is actually a declaration rather than a function;\n\
 it tells `call-interactively' how to read arguments\n\
 to pass to the function.\n\
When actually called, `interactive' just returns nil.\n\
\n\
The argument of `interactive' is usually a string containing a code letter\n\
 followed by a prompt.  (Some code letters do not use I/O to get\n\
 the argument and do not need prompts.)  To prompt for multiple arguments,\n\
 give a code letter, its prompt, a newline, and another code letter, etc.\n\
 Prompts are passed to format, and may use % escapes to print the\n\
 arguments that have already been read.\n\
If the argument is not a string, it is evaluated to get a list of\n\
 arguments to pass to the function.\n\
Just `(interactive)' means pass no args when calling interactively.\n\
\nCode letters available are:\n\
a -- Function name: symbol with a function definition.\n\
b -- Name of existing buffer.\n\
B -- Name of buffer, possibly nonexistent.\n\
c -- Character.\n\
C -- Command name: symbol with interactive function definition.\n\
d -- Value of point as number.  Does not do I/O.\n\
D -- Directory name.\n\
122 123 124
e -- Parametrized event (i.e., one that's a list) that invoked this command.\n\
     If used more than once, the Nth `e' returns the Nth parameterized event.\n\
     This skips events that are integers or symbols.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
125 126
f -- Existing file name.\n\
F -- Possibly nonexistent file name.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
127 128
k -- Key sequence (downcase the last event if needed to get a definition).\n\
K -- Key sequence to be redefined (do not downcase the last event).\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
129 130
m -- Value of mark as number.  Does not do I/O.\n\
n -- Number read using minibuffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
131
N -- Raw prefix arg, or if none, do like code `n'.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
132 133 134 135 136 137 138 139 140 141 142
p -- Prefix arg converted to number.  Does not do I/O.\n\
P -- Prefix arg in raw form.  Does not do I/O.\n\
r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.\n\
s -- Any string.\n\
S -- Any symbol.\n\
v -- Variable name: symbol that is user-variable-p.\n\
x -- Lisp expression read but not evaluated.\n\
X -- Lisp expression read and evaluated.\n\
In addition, if the string begins with `*'\n\
 then an error is signaled if the buffer is read-only.\n\
 This happens before reading any arguments.\n\
Jim Blandy's avatar
Jim Blandy committed
143 144 145 146 147
If the string begins with `@', then Emacs searches the key sequence\n\
 which invoked the command for its first mouse click (or any other\n\
 event which specifies a window), and selects that window before\n\
 reading any arguments.  You may use both `@' and `*'; they are\n\
 processed in the order that they appear." */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163

/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
  0 /* See immediately above */)
  (args)
     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;
{
164
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
165
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    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;
  register struct Lisp_Cons *ptr;
  for (tail = exp; CONSP (tail); tail = ptr->cdr)
    {
      ptr = XCONS (tail);
      ptr->car = quotify_arg (ptr->car);
    }
  return exp;
}

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

static void
check_mark ()
{
192 193
  Lisp_Object tem;
  tem = Fmarker_buffer (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
194
  if (NILP (tem) || (XBUFFER (tem) != current_buffer))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
195
    error ("The mark is not set now");
196 197 198
  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
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
}


DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 2, 0,
  "Call FUNCTION, reading args according to its interactive calling specs.\n\
The function contains a specification of how to do the argument reading.\n\
In the case of user-defined functions, this is specified by placing a call\n\
to the function `interactive' at the top level of the function body.\n\
See `interactive'.\n\
\n\
Optional second arg RECORD-FLAG non-nil\n\
means unconditionally put this command in the command-history.\n\
Otherwise, this is done only if an arg is read using the minibuffer.")
  (function, record)
     Lisp_Object function, record;
{
  Lisp_Object *args, *visargs;
  unsigned char **argstrings;
  Lisp_Object fun;
  Lisp_Object funcar;
  Lisp_Object specs;
  Lisp_Object teml;
Richard M. Stallman's avatar
Richard M. Stallman committed
221 222
  Lisp_Object enable;
  int speccount = specpdl_ptr - specpdl;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
223

224 225
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
226
  int next_event;
227

Michael I. Bushnell's avatar
Michael I. Bushnell committed
228 229 230
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
231 232 233 234

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
237 238 239 240 241 242 243 244
  register int i, j;
  int count, foo;
  char prompt[100];
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

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

Jim Blandy's avatar
Jim Blandy committed
248
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
249

250
  if (SYMBOLP (function))
251
    enable = Fget (function, Qenable_recursive_minibuffers);
Richard M. Stallman's avatar
Richard M. Stallman committed
252

Jim Blandy's avatar
Jim Blandy committed
253
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
254 255 256 257 258 259 260 261

  specs = Qnil;
  string = 0;

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

262
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
263 264 265 266 267
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
268
	  function = wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
269 270
	  goto retry;
	}
271
      if ((EMACS_INT) string == 1)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
272 273 274
	/* Let SPECS (which is nil) be used as the args.  */
	string = 0;
    }
275
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
276
    {
Roland McGrath's avatar
Roland McGrath committed
277
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
	goto lose;
      specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
    }
  else if (!CONSP (fun))
    goto lose;
  else if (funcar = Fcar (fun), EQ (funcar, Qautoload))
    {
      GCPRO2 (function, prefix_arg);
      do_autoload (fun, function);
      UNGCPRO;
      goto retry;
    }
  else if (EQ (funcar, Qlambda))
    {
      specs = Fassq (Qinteractive, Fcdr (Fcdr (fun)));
Jim Blandy's avatar
Jim Blandy committed
293
      if (NILP (specs))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
294 295 296 297
	goto lose;
      specs = Fcar (Fcdr (specs));
    }
  else if (EQ (funcar, Qmocklisp))
298
    {
299
      single_kboard_state ();
300 301
      return ml_apply (fun, Qinteractive);
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
302 303 304
  else
    goto lose;

Jim Blandy's avatar
Jim Blandy committed
305
  /* If either specs or string is set to a string, use it.  */
306
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
307 308 309
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
Jim Blandy's avatar
Jim Blandy committed
310
      string = (unsigned char *) alloca (XSTRING (specs)->size + 1);
Jim Blandy's avatar
Jim Blandy committed
311 312
      bcopy (XSTRING (specs)->data, string, XSTRING (specs)->size + 1);
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
313 314
  else if (string == 0)
    {
315
      Lisp_Object input;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
316
      i = num_input_chars;
317 318
      input = specs;
      /* Compute the arg values using the user's expression.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
319
      specs = Feval (specs);
Jim Blandy's avatar
Jim Blandy committed
320
      if (i != num_input_chars || !NILP (record))
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
	{
	  /* We should record this command on the command history.  */
	  Lisp_Object values, car;
	  /* 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));
	  /* If the list of args 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.  */
	  car = Fcar (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;
		      presflag = Fmemq (Fcar (elt), preserved_fns);
		      if (!NILP (presflag))
			Fsetcar (valtail, Fcar (intail));
		    }
		}
	    }
	  Vcommand_history
	    = Fcons (Fcons (function, values), Vcommand_history);
	}
353
      single_kboard_state ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
354 355 356 357 358
      return apply1 (function, specs);
    }

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

Jim Blandy's avatar
Jim Blandy committed
359 360 361 362 363 364
  /* Set next_event to point to the first event with parameters.  */
  for (next_event = 0; next_event < this_command_key_count; next_event++)
    if (EVENT_HAS_PARAMETERS
	(XVECTOR (this_command_keys)->contents[next_event]))
      break;
  
365
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
366
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
367 368
  while (1)
    {
369
      if (*string == '+')
370 371
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
372 373
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
374
	  if (!NILP (current_buffer->read_only))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
375 376
	    Fbarf_if_buffer_read_only ();
	}
377 378 379
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
380 381
      else if (*string == '@')
	{
382
	  Lisp_Object event;
Jim Blandy's avatar
Jim Blandy committed
383

384
	  event = XVECTOR (this_command_keys)->contents[next_event];
Jim Blandy's avatar
Jim Blandy committed
385
	  if (EVENT_HAS_PARAMETERS (event)
386 387 388
	      && (event = XCONS (event)->car, CONSP (event))
	      && (event = XCONS (event)->car, CONSP (event))
	      && (event = XCONS (event)->car), WINDOWP (event))
389
	    {
Karl Heuer's avatar
Karl Heuer committed
390
	      if (MINI_WINDOW_P (XWINDOW (event))
391
		  && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
392
		error ("Attempt to select inactive minibuffer window");
393 394 395 396 397

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

398 399
	      Fselect_window (event);
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
	  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 *) "";
    }
  count = j;

  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
437 438 439
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
440
  tem = string;
Jim Blandy's avatar
Jim Blandy committed
441
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
442 443 444 445 446 447 448 449 450 451 452
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
      tem1 = index (prompt1, '\n');
      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]
	  = EQ (visargs[j], Qnil)
	    ? (unsigned char *) ""
Jim Blandy's avatar
Jim Blandy committed
453
	      : XSTRING (visargs[j])->data;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469

      doprnt (prompt, sizeof prompt, prompt1, 0, j - 1, argstrings + 1);

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
	  visargs[i] = Fcompleting_read (build_string (prompt),
					 Vobarray, Qfboundp, Qt, Qnil, Qnil);
	  /* 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))
470
	    args[i] = Fother_buffer (args[i], Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
471 472 473 474 475
	  args[i] = Fread_buffer (build_string (prompt), args[i], Qt);
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
	  args[i] = Fread_buffer (build_string (prompt),
476 477
				  Fother_buffer (Fcurrent_buffer (), Qnil),
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
	  break;

        case 'c':		/* Character */
	  message1 (prompt);
	  args[i] = Fread_char ();
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
	  visargs[i] = Fcompleting_read (build_string (prompt),
					 Vobarray, Qcommandp, Qt, Qnil, Qnil);
	  /* 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.  */
497 498
	  Fset_marker (point_marker, make_number (PT), Qnil);
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
	  args[i] = Fread_file_name (build_string (prompt), Qnil,
				     current_buffer->directory, Qlambda, Qnil);
	  break;

	case 'f':		/* Existing file name. */
	  args[i] = Fread_file_name (build_string (prompt),
				     Qnil, Qnil, Qlambda, Qnil);
	  break;

	case 'F':		/* Possibly nonexistent file name. */
	  args[i] = Fread_file_name (build_string (prompt),
				     Qnil, Qnil, Qnil, Qnil);
	  break;

518
	case 'k':		/* Key sequence. */
519
	  args[i] = Fread_key_sequence (build_string (prompt), Qnil, Qnil, Qnil);
520 521 522 523 524
	  teml = args[i];
	  visargs[i] = Fkey_description (teml);
	  break;

	case 'K':		/* Key sequence to be defined. */
525
	  args[i] = Fread_key_sequence (build_string (prompt), Qnil, Qt, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
526 527 528 529
	  teml = args[i];
	  visargs[i] = Fkey_description (teml);
	  break;

530 531 532
	case 'e':		/* The invoking event.  */
	  if (next_event >= this_command_key_count)
	    error ("%s must be bound to an event with parameters",
533
		   (SYMBOLP (function)
Jim Blandy's avatar
Jim Blandy committed
534
		    ? (char *) XSYMBOL (function)->name->data
535
		    : "command"));
536
	  args[i] = XVECTOR (this_command_keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
537
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
538 539 540 541 542 543 544

	  /* Find the next parameterized event.  */
	  while (next_event < this_command_key_count
		 && ! (EVENT_HAS_PARAMETERS
		       (XVECTOR (this_command_keys)->contents[next_event])))
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
545 546
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
547 548 549
	case 'm':		/* Value of mark.  Does not do I/O.  */
	  check_mark ();
	  /* visargs[i] = Qnil; */
550
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
551 552 553 554
	  varies[i] = 2;
	  break;

	case 'N':		/* Prefix arg, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
555
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
556 557 558 559
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
	  do
	    args[i] = Fread_minibuffer (build_string (prompt), Qnil);
Jim Blandy's avatar
Jim Blandy committed
560
	  while (! NUMBERP (args[i]));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
	  visargs[i] = last_minibuf_string;
	  break;

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

	case 'p':		/* Prefix arg converted to number.  No I/O. */
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
	  check_mark ();
579
	  Fset_marker (point_marker, make_number (PT), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
580 581 582
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
583
	  args[i] = point < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
584
	  varies[i] = 3;
585
	  args[++i] = point > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
586 587 588 589
	  varies[i] = 4;
	  break;

	case 's':		/* String read via minibuffer.  */
590
	  args[i] = Fread_string (build_string (prompt), Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
591 592 593
	  break;

	case 'S':		/* Any symbol.  */
594
	  visargs[i] = Fread_string (build_string (prompt), Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	  /* 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. */
	  args[i] = Fread_variable (build_string (prompt));
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
	  args[i] = Fread_minibuffer (build_string (prompt), Qnil);
	  visargs[i] = last_minibuf_string;
	  break;

	case 'X':		/* Lisp expression read and evaluated */
	  args[i] = Feval_minibuffer (build_string (prompt), Qnil);
	  visargs[i] = last_minibuf_string;
 	  break;

616 617 618
	  /* 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
619
	default:
620
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
621 622 623 624 625 626
		 *tem, *tem);
	}

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

627
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
628 629 630 631 632 633
	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
634
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
635 636 637 638 639

  QUIT;

  args[0] = function;

Jim Blandy's avatar
Jim Blandy committed
640
  if (arg_from_tty || !NILP (record))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
641 642
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
643
      for (i = 1; i < count + 1; i++)
644 645 646 647 648 649
	{
	  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
650 651 652 653
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
    }

654 655
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
656
  for (i = 1; i <= count; i++)
657 658 659
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

660
  single_kboard_state ();
661

Michael I. Bushnell's avatar
Michael I. Bushnell committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
}  

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
  1, 1, 0,
  "Return numeric meaning of raw prefix argument ARG.\n\
A raw prefix argument is what you get from `(interactive \"P\")'.\n\
Its numeric meaning is what you would get from `(interactive \"p\")'.")
  (raw)
     Lisp_Object raw;
{
  Lisp_Object val;
  
Jim Blandy's avatar
Jim Blandy committed
682
  if (NILP (raw))
683
    XSETFASTINT (val, 1);
684
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
685 686 687
    XSETINT (val, -1);
  else if (CONSP (raw))
    XSETINT (val, XINT (XCONS (raw)->car));
688
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
689 690
    val = raw;
  else
691
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
692 693 694 695

  return val;
}

696 697 698 699 700 701 702 703 704 705 706 707
DEFUN ("universal-argument", Funiversal_argument, Suniversal_argument, 0, 0, "",
  "Begin a numeric argument for the following command.\n\
Digits or minus sign following \\[universal-argument] make up the numeric argument.\n\
\\[universal-argument] following the digits or minus sign ends the argument.\n\
\\[universal-argument] without digits or minus sign provides 4 as argument.\n\
Repeating \\[universal-argument] without digits or minus sign\n\
 multiplies the argument by 4 each time.")
  ()
{
  if (!current_prefix_partial)
    {
      /* First C-u */
Karl Heuer's avatar
Karl Heuer committed
708 709 710 711
      XSETFASTINT (current_kboard->prefix_factor, 4);
      current_kboard->prefix_value = Qnil;
      current_kboard->prefix_sign = 1;
      current_kboard->prefix_partial = 1;
712
    }
Karl Heuer's avatar
Karl Heuer committed
713
  else if (!NILP (current_kboard->prefix_factor))
714 715
    {
      /* Subsequent C-u */
Karl Heuer's avatar
Karl Heuer committed
716 717 718
      XSETINT (current_kboard->prefix_factor,
	       XINT (current_kboard->prefix_factor) * 4);
      current_kboard->prefix_partial = 1;
719 720 721 722 723 724 725 726 727 728 729 730 731 732
    }
  else
    {
      /* Terminating C-u */
      finalize_prefix_arg ();
      describe_prefix_arg ();
    }
}

DEFUN ("negative-argument", Fnegative_argument, Snegative_argument, 0, 0, "",
  "Begin a negative numeric argument for the next command.\n\
\\[universal-argument] following digits or minus sign ends the argument.")
  ()
{
Karl Heuer's avatar
Karl Heuer committed
733 734 735
  current_kboard->prefix_factor = Qnil;
  current_kboard->prefix_sign *= -1;
  current_kboard->prefix_partial = 1;
736 737 738 739 740 741 742 743 744 745 746
}

DEFUN ("digit-argument", Fdigit_argument, Sdigit_argument, 0, 0, "",
  "Part of the numeric argument for the next command.\n\
\\[universal-argument] following digits or minus sign ends the argument.")
  ()
{
  int c;
  if (!(INTEGERP (last_command_char)
	&& (c = (XINT (last_command_char) & 0177)) >= '0' && c <= '9'))
    error("digit-argument must be bound to a digit key");
Karl Heuer's avatar
Karl Heuer committed
747 748 749 750 751 752
  current_kboard->prefix_factor = Qnil;
  if (NILP (current_kboard->prefix_value))
    XSETFASTINT (current_kboard->prefix_value, 0);
  XSETINT (current_kboard->prefix_value,
	   XINT (current_kboard->prefix_value) * 10 + (c - '0'));
  current_kboard->prefix_partial = 1;
753 754
}

Michael I. Bushnell's avatar
Michael I. Bushnell committed
755 756
syms_of_callint ()
{
757 758 759
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

760 761 762 763 764 765 766 767 768
  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);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
769 770 771
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
772 773 774
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
775 776 777 778 779 780
  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
781 782 783
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

784 785 786
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
  DEFVAR_LISP ("prefix-arg", &Vprefix_arg,
    "The value of the prefix argument for the next editing command.\n\
It may be a number, or the symbol `-' for just a minus sign as arg,\n\
or a list whose car is a number for just one or more C-U's\n\
or nil if no argument has been specified.\n\
\n\
You cannot examine this variable to find the argument for this command\n\
since it has been set to nil by the time you can look.\n\
Instead, you should use the variable `current-prefix-arg', although\n\
normally commands can get this prefix argument with (interactive \"P\").");
  Vprefix_arg = Qnil;

  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
    "The value of the prefix argument for this editing command.\n\
It may be a number, or the symbol `-' for just a minus sign as arg,\n\
or a list whose car is a number for just one or more C-U's\n\
or nil if no argument has been specified.\n\
This is what `(interactive \"P\")' returns.");
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
807 808 809 810 811 812 813 814 815 816 817
  DEFVAR_LISP ("command-history", &Vcommand_history,
    "List of recent commands that read arguments from terminal.\n\
Each command is represented as a form to evaluate.");
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
    "Debugging status of current interactive command.\n\
Bound each time `call-interactively' is called;\n\
may be set by the debugger as a reminder for itself.");
  Vcommand_debug_status = Qnil;

818
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
819 820 821 822 823 824 825
    "*Non-nil means you can use the mark even when inactive.\n\
This option makes a difference in Transient Mark mode.\n\
When the option is non-nil, deactivation of the mark\n\
turns off region highlighting, but commands that use the mark\n\
behave as if the mark were still active.");
  Vmark_even_if_inactive = Qnil;

826 827 828 829 830 831
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
    "Hook to run when about to switch windows with a mouse command.\n\
Its purpose is to give temporary modes such as Isearch mode\n\
a way to turn themselves off when a mouse command switches windows.");
  Vmouse_leave_buffer_hook = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
832 833 834
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
835 836 837
  defsubr (&Suniversal_argument);
  defsubr (&Snegative_argument);
  defsubr (&Sdigit_argument);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
838
}