callint.c 28.3 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, 2002
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;
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 177
}


178
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
179 180 181 182 183 184 185 186 187 188 189 190 191
       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)
192
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
193 194 195 196 197 198
{
  Lisp_Object *args, *visargs;
  unsigned char **argstrings;
  Lisp_Object fun;
  Lisp_Object funcar;
  Lisp_Object specs;
199
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
200
  Lisp_Object teml;
Richard M. Stallman's avatar
Richard M. Stallman committed
201
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
202
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
203

204 205
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
206
  int next_event;
207

Michael I. Bushnell's avatar
Michael I. Bushnell committed
208 209 210
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
211 212 213 214

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
217 218 219 220 221 222
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
223
  int key_count;
224
  int record_then_fail = 0;
225 226 227 228 229

  if (NILP (keys))
    keys = this_command_keys, key_count = this_command_key_count;
  else
    {
230
      CHECK_VECTOR (keys);
231 232
      key_count = XVECTOR (keys)->size;
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
233

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

Jim Blandy's avatar
Jim Blandy committed
237
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
238

239
  if (SYMBOLP (function))
240
    enable = Fget (function, Qenable_recursive_minibuffers);
241 242
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
243

Jim Blandy's avatar
Jim Blandy committed
244
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
245 246 247

  specs = Qnil;
  string = 0;
248 249 250 251
  /* 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
252 253 254 255 256

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

257
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
258 259 260 261 262
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
263
	  function = wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
264 265 266
	  goto retry;
	}
    }
267
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
268
    {
Roland McGrath's avatar
Roland McGrath committed
269
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
270 271 272 273 274
	goto lose;
      specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
    }
  else if (!CONSP (fun))
    goto lose;
275
  else if (funcar = XCAR (fun), EQ (funcar, Qautoload))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
276 277 278 279 280 281 282 283
    {
      GCPRO2 (function, prefix_arg);
      do_autoload (fun, function);
      UNGCPRO;
      goto retry;
    }
  else if (EQ (funcar, Qlambda))
    {
284
      specs = Fassq (Qinteractive, Fcdr (XCDR (fun)));
Jim Blandy's avatar
Jim Blandy committed
285
      if (NILP (specs))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
286
	goto lose;
287
      filter_specs = Fnth (make_number (1), specs);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
288 289 290 291 292
      specs = Fcar (Fcdr (specs));
    }
  else
    goto lose;

293
  /* If either SPECS or STRING is set to a string, use it.  */
294
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
295 296 297
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
298 299 300
      string = (unsigned char *) alloca (SBYTES (specs) + 1);
      bcopy (SDATA (specs), string,
	     SBYTES (specs) + 1);
Jim Blandy's avatar
Jim Blandy committed
301
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
302 303
  else if (string == 0)
    {
304
      Lisp_Object input;
305
      i = num_input_events;
306 307
      input = specs;
      /* Compute the arg values using the user's expression.  */
308
      GCPRO2 (input, filter_specs);
309
      specs = Feval (specs);
310
      UNGCPRO;
311
      if (i != num_input_events || !NILP (record_flag))
312 313 314 315 316 317 318 319 320 321
	{
	  /* 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.  */
322
	  if (CONSP (input))
323
	    {
324
	      car = XCAR (input);
325 326
	      /* Skip through certain special forms.  */
	      while (EQ (car, Qlet) || EQ (car, Qletx)
327 328
		     || EQ (car, Qsave_excursion)
		     || EQ (car, Qprogn))
329
		{
330 331 332
		  while (CONSP (XCDR (input)))
		    input = XCDR (input);
		  input = XCAR (input);
333 334
		  if (!CONSP (input))
		    break;
335
		  car = XCAR (input);
336 337 338 339 340 341 342
		}
	      if (EQ (car, Qlist))
		{
		  Lisp_Object intail, valtail;
		  for (intail = Fcdr (input), valtail = values;
		       CONSP (valtail);
		       intail = Fcdr (intail), valtail = Fcdr (valtail))
343
		    {
344 345 346 347 348 349 350 351 352
		      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));
			}
353 354 355 356 357
		    }
		}
	    }
	  Vcommand_history
	    = Fcons (Fcons (function, values), Vcommand_history);
358 359

	  /* Don't keep command history around forever.  */
360
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
361 362 363
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
364
		XSETCDR (teml, Qnil);
365
	    }
366
	}
367
      single_kboard_state ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
368 369 370 371 372
      return apply1 (function, specs);
    }

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

Jim Blandy's avatar
Jim Blandy committed
373
  /* Set next_event to point to the first event with parameters.  */
374 375
  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
376
      break;
377

378
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
379
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
380 381
  while (1)
    {
382
      if (*string == '+')
383 384
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
385 386
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
387
	  if (!NILP (current_buffer->read_only))
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
	    {
	      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
404
	}
405 406 407
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
408 409
      else if (*string == '@')
	{
410
	  Lisp_Object event;
Jim Blandy's avatar
Jim Blandy committed
411

412 413 414
	  event = (next_event < key_count
		   ? XVECTOR (keys)->contents[next_event]
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
415
	  if (EVENT_HAS_PARAMETERS (event)
416 417 418
	      && (event = XCDR (event), CONSP (event))
	      && (event = XCAR (event), CONSP (event))
	      && (event = XCAR (event), WINDOWP (event)))
419
	    {
Karl Heuer's avatar
Karl Heuer committed
420
	      if (MINI_WINDOW_P (XWINDOW (event))
421
		  && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
422
		error ("Attempt to select inactive minibuffer window");
423 424 425 426 427

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

428 429
	      Fselect_window (event);
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
	  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 *) "";
    }
449
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466

  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
467 468 469
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
470
  tem = string;
471
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
472 473 474
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
475
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
476 477 478 479 480
      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]
481 482
	  = (EQ (visargs[j], Qnil)
	     ? (unsigned char *) ""
483
	     : SDATA (visargs[j]));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
484

485 486 487 488 489 490 491 492
      /* 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,
493
			       j - 1, (char **) argstrings + 1);
494
	  if (nchars < callint_message_size - 1)
495 496 497 498 499
	    break;
	  callint_message_size *= 2;
	  callint_message
	    = (char *) xrealloc (callint_message, callint_message_size);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
500 501 502 503

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
504
	  visargs[i] = Fcompleting_read (build_string (callint_message),
505
					 Vobarray, Qfboundp, Qt,
506
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
507 508 509 510 511 512 513 514
	  /* 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))
515
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
516
	  args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
517 518 519
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
520
	  args[i] = Fread_buffer (build_string (callint_message),
521
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
522
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
523 524 525
	  break;

        case 'c':		/* Character */
526
	  args[i] = Fread_char (build_string (callint_message), Qnil);
527
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
528 529 530 531 532 533
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
534
	  visargs[i] = Fcompleting_read (build_string (callint_message),
535
					 Vobarray, Qcommandp,
536
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
537 538 539 540 541 542
	  /* 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.  */
543
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
544
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
545 546 547 548 549
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
550
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
551 552
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
553 554 555
	  break;

	case 'f':		/* Existing file name. */
556
	  args[i] = Fread_file_name (build_string (callint_message),
557
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
558 559 560
	  break;

	case 'F':		/* Possibly nonexistent file name. */
561
	  args[i] = Fread_file_name (build_string (callint_message),
562
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
563 564
	  break;

565 566 567 568
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

569
	case 'k':		/* Key sequence. */
570
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
571
	    int speccount1 = SPECPDL_INDEX ();
572 573
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
574
					  Qnil, Qnil, Qnil, Qnil);
575 576 577
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
	    visargs[i] = Fkey_description (teml);
578 579 580 581 582

	    /* 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))
583
	      teml = XCAR (teml);
584 585 586 587 588
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
589 590
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
591
		if (! NILP (tem2))
592
		  Fread_event (Qnil, Qnil);
593
	      }
594
	  }
595 596 597
	  break;

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

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

		teml = Fget (teml, intern ("event-symbol-elements"));
617 618
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
619
		if (! NILP (tem2))
620
		  Fread_event (Qnil, Qnil);
621
	      }
622
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
623 624
	  break;

625
	case 'e':		/* The invoking event.  */
626
	  if (next_event >= key_count)
627
	    error ("%s must be bound to an event with parameters",
628
		   (SYMBOLP (function)
629
		    ? (char *) SDATA (SYMBOL_NAME (function))
630
		    : "command"));
631
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
632
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
633 634

	  /* Find the next parameterized event.  */
635
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
636
		 && ! (EVENT_HAS_PARAMETERS
637
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
638 639
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
640 641
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
642
	case 'm':		/* Value of mark.  Does not do I/O.  */
643
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
644
	  /* visargs[i] = Qnil; */
645
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
646 647 648
	  varies[i] = 2;
	  break;

649 650 651 652 653 654
	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
655
	case 'N':		/* Prefix arg, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
656
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
657 658
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
659 660 661 662 663 664 665 666
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
		if (!  first)
		  {
		    message ("Please enter a number.");
667
		    sit_for (1, 0, 0, 0, 0);
668 669 670 671
		  }
		first = 0;

		tem = Fread_from_minibuffer (build_string (callint_message),
672 673
					     Qnil, Qnil, Qnil, Qnil, Qnil,
					     Qnil);
674
		if (! STRINGP (tem) || SCHARS (tem) == 0)
675 676 677 678 679 680
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
681 682 683 684 685 686 687 688 689 690
	  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. */
691
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
692 693 694 695 696 697
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
698
	  check_mark (1);
699
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
700 701 702
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
703
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
704
	  varies[i] = 3;
705
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
706 707 708
	  varies[i] = 4;
	  break;

709 710
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
711
	  args[i] = Fread_string (build_string (callint_message),
712
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
713 714 715
	  break;

	case 'S':		/* Any symbol.  */
716
	  visargs[i] = Fread_string (build_string (callint_message),
717
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
718 719 720 721 722 723 724
	  /* 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. */
725
	  args[i] = Fread_variable (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
726 727 728 729
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
730
	  args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
731 732 733 734
	  visargs[i] = last_minibuf_string;
	  break;

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

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
	  else 
	    {
	      args[i]
		= Fread_non_nil_coding_system (build_string (callint_message));
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
755
	  args[i] = Fread_coding_system (build_string (callint_message), Qnil);
756 757 758
	  visargs[i] = last_minibuf_string;
	  break;

759 760 761
	  /* 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
762
	default:
763
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
764 765 766 767 768 769
		 *tem, *tem);
	}

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

770
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
771 772 773 774 775 776
	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
777
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
778 779 780 781 782

  QUIT;

  args[0] = function;

783
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
784 785
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
786
      for (i = 1; i < count + 1; i++)
787 788 789 790 791 792
	{
	  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
793 794
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
795
      /* Don't keep command history around forever.  */
796
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
797 798 799
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
800
	    XSETCDR (teml, Qnil);
801
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
802 803
    }

804 805
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
806
  for (i = 1; i <= count; i++)
807 808 809
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

810 811 812
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

813
  single_kboard_state ();
814

Michael I. Bushnell's avatar
Michael I. Bushnell committed
815 816 817 818 819 820 821 822 823 824 825
  {
    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,
826 827 828 829 830
       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
831 832 833 834
     Lisp_Object raw;
{
  Lisp_Object val;
  
Jim Blandy's avatar
Jim Blandy committed
835
  if (NILP (raw))
836
    XSETFASTINT (val, 1);
837
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
838
    XSETINT (val, -1);
839 840
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
841
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
842 843
    val = raw;
  else
844
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
845 846 847 848

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
849
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
850 851
syms_of_callint ()
{
852 853 854
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

855 856 857 858 859 860 861 862
  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);
863 864 865 866 867 868
  Qlet = intern ("let");
  staticpro (&Qlet);
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
869 870
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
871

Michael I. Bushnell's avatar
Michael I. Bushnell committed
872 873 874
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
875 876 877
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
878 879 880 881 882 883
  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
884 885 886
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

887 888 889
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

890 891 892 893
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


894
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
895 896 897 898 899 900 901 902 903
		 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").  */);
904

905
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
906 907
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
908

909
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
910 911 912 913 914
	       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.  */);
915 916
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
917
  DEFVAR_LISP ("command-history", &Vcommand_history,
918 919
	       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
920 921 922
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
923 924 925
	       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
926 927
  Vcommand_debug_status = Qnil;

928
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
929 930 931 932 933
	       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.  */);
934 935
  Vmark_even_if_inactive = Qnil;

936
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
937 938 939
	       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.  */);
940 941
  Vmouse_leave_buffer_hook = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
942 943 944 945
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}