callint.c 30.5 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, 2002, 2003,
3
                 2004, 2005, 2006 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
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, 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
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;

53 54
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

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

/* Allocated length of that buffer.  */
static int callint_message_size;
66

Michael I. Bushnell's avatar
Michael I. Bushnell committed
67 68
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
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
       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.
101
G -- Possibly nonexistent file name, defaulting to just directory name.
102 103 104 105 106 107 108 109 110 111 112 113
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.
114
U -- Mouse up event discarded by a previous k or K argument.
115 116 117 118 119 120 121 122 123 124 125 126
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
127 128
 processed in the order that they appear.
usage: (interactive ARGS)  */)
129
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
130 131 132 133 134 135 136 137 138 139 140
     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;
{
141
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
142
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
143 144 145 146 147 148 149 150 151 152 153
    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;
154 155
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
156
    {
157
      next = XCDR (tail);
158
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
159 160 161 162 163 164 165 166
    }
  return exp;
}

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
180 181 182 183 184 185 186 187
/* 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.  */

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
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
214
	       intail = Fcdr (intail), valtail = XCDR (valtail))
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 245 246 247
	    {
	      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
248

249
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
250 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.
Optional third arg KEYS, if given, specifies the sequence of events to
261 262
supply if the command inquires which events were used to invoke it.
If KEYS is omitted or nil, the return value of `this-command-keys' is used.  */)
263
     (function, record_flag, keys)
264
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
265 266 267 268 269
{
  Lisp_Object *args, *visargs;
  unsigned char **argstrings;
  Lisp_Object fun;
  Lisp_Object specs;
270
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
271
  Lisp_Object teml;
272
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
273
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
274
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
275

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

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

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

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

298 299 300 301 302 303 304 305
  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;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
322
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
323 324 325

  specs = Qnil;
  string = 0;
326 327 328 329
  /* 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
330

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
334
  /* Decode the kind of function.  Either handle it and return,
335
     or go to `lose' if not interactive, or set either STRING or SPECS.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
336

337
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
338 339 340 341 342
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
343
	  wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
344 345
	}
    }
346
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
347
    {
Roland McGrath's avatar
Roland McGrath committed
348
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
349 350 351
	goto lose;
      specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
    }
352
  else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
353
    {
354
      Lisp_Object form;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
355
      GCPRO2 (function, prefix_arg);
356
      form = Finteractive_form (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
357
      UNGCPRO;
358 359 360
      if (CONSP (form))
	specs = filter_specs = Fcar (XCDR (form));
      else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
361 362 363
	goto lose;
    }

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

	  /* Don't keep command history around forever.  */
394
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
395 396 397
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
398
		XSETCDR (teml, Qnil);
399
	    }
400
	}
401 402 403 404 405 406

      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;

407
      single_kboard_state ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
408 409 410 411 412
      return apply1 (function, specs);
    }

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

Jim Blandy's avatar
Jim Blandy committed
413
  /* Set next_event to point to the first event with parameters.  */
414 415
  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
416
      break;
417

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

452 453 454
	  event = (next_event < key_count
		   ? XVECTOR (keys)->contents[next_event]
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
455
	  if (EVENT_HAS_PARAMETERS (event)
456 457 458
	      && (tem = XCDR (event), CONSP (tem))
	      && (tem = XCAR (tem), CONSP (tem))
	      && (tem = XCAR (tem), WINDOWP (tem)))
459
	    {
460 461
	      if (MINI_WINDOW_P (XWINDOW (tem))
		  && ! (minibuf_level > 0 && EQ (tem, minibuf_window)))
462
		error ("Attempt to select inactive minibuffer window");
463 464 465 466 467

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

468
	      Fselect_window (tem, Qnil);
469
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
	  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 *) "";
    }
489
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
490 491 492 493 494 495 496 497 498 499 500 501 502

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

503
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
504 505 506
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
507 508 509
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
510
  tem = string;
511
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
512 513 514
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
515
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
516 517 518 519 520
      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]
521 522
	  = (EQ (visargs[j], Qnil)
	     ? (unsigned char *) ""
523
	     : SDATA (visargs[j]));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
524

525 526 527 528 529 530 531 532
      /* 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,
533
			       j - 1, (char **) argstrings + 1);
534
	  if (nchars < callint_message_size - 1)
535 536 537 538 539
	    break;
	  callint_message_size *= 2;
	  callint_message
	    = (char *) xrealloc (callint_message, callint_message_size);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
540 541 542 543

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
544
	  visargs[i] = Fcompleting_read (build_string (callint_message),
545
					 Vobarray, Qfboundp, Qt,
546
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
547 548 549 550 551 552 553 554
	  /* 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))
555
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
556
	  args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
557 558 559
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
560
	  args[i] = Fread_buffer (build_string (callint_message),
561
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
562
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
563 564 565
	  break;

        case 'c':		/* Character */
566
	  args[i] = Fread_char (build_string (callint_message), Qnil);
567
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
568 569 570 571 572 573
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
574
	  visargs[i] = Fcompleting_read (build_string (callint_message),
575
					 Vobarray, Qcommandp,
576
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
577 578 579 580 581 582
	  /* 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.  */
583
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
584
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
585 586 587 588 589
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
590
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
591 592
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
593 594 595
	  break;

	case 'f':		/* Existing file name. */
596
	  args[i] = Fread_file_name (build_string (callint_message),
597
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
598 599 600
	  break;

	case 'F':		/* Possibly nonexistent file name. */
601
	  args[i] = Fread_file_name (build_string (callint_message),
602
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
603 604
	  break;

605 606 607 608 609 610
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
	  args[i] = Fread_file_name (build_string (callint_message),
				     Qnil, Qnil, Qnil, build_string (""), Qnil);
	  break;

611 612 613 614
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

615
	case 'k':		/* Key sequence. */
616
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
617
	    int speccount1 = SPECPDL_INDEX ();
618 619
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
620
					  Qnil, Qnil, Qnil, Qnil);
621 622
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
623
	    visargs[i] = Fkey_description (teml, Qnil);
624 625 626 627 628

	    /* 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))
629
	      teml = XCAR (teml);
630 631 632 633 634
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
635 636
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
637
		if (! NILP (tem2))
638
		  up_event = Fread_event (Qnil, Qnil);
639
	      }
640
	  }
641 642 643
	  break;

	case 'K':		/* Key sequence to be defined. */
644
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
645
	    int speccount1 = SPECPDL_INDEX ();
646 647
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
648
					  Qnil, Qt, Qnil, Qnil);
649
	    teml = args[i];
650
	    visargs[i] = Fkey_description (teml, Qnil);
651
	    unbind_to (speccount1, Qnil);
652 653 654 655 656

	    /* 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))
657
	      teml = XCAR (teml);
658 659 660 661 662
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
663 664
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
665
		if (! NILP (tem2))
666
		  up_event = Fread_event (Qnil, Qnil);
667
	      }
668
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
669 670
	  break;

671 672 673 674 675 676 677 678 679 680
	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;

681
	case 'e':		/* The invoking event.  */
682
	  if (next_event >= key_count)
683
	    error ("%s must be bound to an event with parameters",
684
		   (SYMBOLP (function)
685
		    ? (char *) SDATA (SYMBOL_NAME (function))
686
		    : "command"));
687
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
688
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
689 690

	  /* Find the next parameterized event.  */
691
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
692
		 && ! (EVENT_HAS_PARAMETERS
693
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
694 695
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
696 697
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
698
	case 'm':		/* Value of mark.  Does not do I/O.  */
699
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
700
	  /* visargs[i] = Qnil; */
701
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
702 703 704
	  varies[i] = 2;
	  break;

705 706 707 708 709 710
	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
711
	case 'N':		/* Prefix arg, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
712
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
713 714
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
715 716 717 718 719
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
720
		if (! first)
721 722
		  {
		    message ("Please enter a number.");
723
		    sit_for (make_number (1), 0, 0);
724 725 726 727
		  }
		first = 0;

		tem = Fread_from_minibuffer (build_string (callint_message),
728
					     Qnil, Qnil, Qnil, Qnil, Qnil,
729
					     Qnil);
730
		if (! STRINGP (tem) || SCHARS (tem) == 0)
731 732 733 734 735 736
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
737 738 739 740 741 742 743 744 745 746
	  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. */
747
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
748 749 750 751 752 753
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
754
	  check_mark (1);
755
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
756 757 758
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
759
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
760
	  varies[i] = 3;
761
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
762 763 764
	  varies[i] = 4;
	  break;

765 766
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
767
	  args[i] = Fread_string (build_string (callint_message),
768
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
769 770 771
	  break;

	case 'S':		/* Any symbol.  */
772
	  visargs[i] = Fread_string (build_string (callint_message),
773
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
774 775 776 777 778 779 780
	  /* 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. */
781
	  args[i] = Fread_variable (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
782 783 784 785
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
786
	  args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
787 788 789 790
	  visargs[i] = last_minibuf_string;
	  break;

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

795 796 797 798 799 800 801
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
802
	  else
803 804 805 806 807 808 809 810
	    {
	      args[i]
		= Fread_non_nil_coding_system (build_string (callint_message));
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
811
	  args[i] = Fread_coding_system (build_string (callint_message), Qnil);
812 813 814
	  visargs[i] = last_minibuf_string;
	  break;

815 816 817
	  /* 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
818
	default:
819
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
820 821 822 823 824 825
		 *tem, *tem);
	}

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

826
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
827 828 829 830 831 832
	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
833
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
834 835 836 837 838

  QUIT;

  args[0] = function;

839
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
840 841
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
842
      for (i = 1; i < count + 1; i++)
843 844 845 846 847 848
	{
	  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
849 850
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
851
      /* Don't keep command history around forever.  */
852
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
853 854 855
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
856
	    XSETCDR (teml, Qnil);
857
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
858 859
    }

860 861
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
862
  for (i = 1; i <= count; i++)
863 864 865
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

866 867 868
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

869 870 871 872 873
  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;

874
  single_kboard_state ();
875

Michael I. Bushnell's avatar
Michael I. Bushnell committed
876 877 878 879 880 881 882 883
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

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

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
887 888 889 890 891
       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
892 893 894
     Lisp_Object raw;
{
  Lisp_Object val;
895

Jim Blandy's avatar
Jim Blandy committed
896
  if (NILP (raw))
897
    XSETFASTINT (val, 1);
898
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
899
    XSETINT (val, -1);
900 901
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
902
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
903 904
    val = raw;
  else
905
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
906 907 908 909

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
910
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
911 912
syms_of_callint ()
{
913 914 915
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

916 917 918 919 920 921 922 923
  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);
924 925
  Qlet = intern ("let");
  staticpro (&Qlet);
926 927 928 929
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
930 931 932 933
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
934 935
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
936

Michael I. Bushnell's avatar
Michael I. Bushnell committed
937 938 939
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
940 941 942
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
943 944 945 946 947 948
  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
949 950 951
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

952 953 954
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

955 956 957 958
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


959
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
960 961 962 963 964 965 966 967 968
		 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").  */);
969

970
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
971 972
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
973

974
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
975 976 977 978 979
	       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.  */);
980 981
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
982
  DEFVAR_LISP ("command-history", &Vcommand_history,
983 984
	       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
985 986 987
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
988 989 990
	       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
991 992
  Vcommand_debug_status = Qnil;

993
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
994 995 996 997 998
	       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.  */);
999 1000
  Vmark_even_if_inactive = Qnil;

1001
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
1002 1003 1004
	       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.  */);
1005 1006
  Vmouse_leave_buffer_hook = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
1007 1008 1009 1010
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}
Miles Bader's avatar
Miles Bader committed
1011 1012 1013

/* arch-tag: a3a7cad7-bcac-42ce-916e-1bd2546ebf37
   (do not change this comment) */