callint.c 26.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 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
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
20 21


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

extern char *index ();

32 33
extern Lisp_Object Qcursor_in_echo_area;

34
Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
35 36 37 38
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
39
Lisp_Object Qenable_recursive_minibuffers;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
40

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

45 46
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

47
Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion;
48 49 50 51
static Lisp_Object preserved_fns;

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

53 54 55 56 57
/* Buffer for the prompt text used in Fcall_interactively.  */
static char *callint_message;

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
/* 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\
90 91 92
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
93 94
f -- Existing file name.\n\
F -- Possibly nonexistent file name.\n\
95
i -- Ignored, i.e. always nil.  Does not do I/O.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
96 97
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
98
m -- Value of mark as number.  Does not do I/O.\n\
99
M -- Any string.  Inherits the current input method.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
100
n -- Number read using minibuffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
101
N -- Raw prefix arg, or if none, do like code `n'.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
102 103 104
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\
105
s -- Any string.  Does not inherit the current input method.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
106 107 108 109
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\
110 111
z -- Coding system.\n\
Z -- Coding system, nil if no prefix arg.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
112 113 114
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
115 116 117 118 119
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
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

/* 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;
{
136
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
137
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
    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 ()
{
164 165
  Lisp_Object tem;
  tem = Fmarker_buffer (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
166
  if (NILP (tem) || (XBUFFER (tem) != current_buffer))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
167
    error ("The mark is not set now");
168 169 170
  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
171 172 173
}


174
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
Michael I. Bushnell's avatar
Michael I. Bushnell committed
175
  "Call FUNCTION, reading args according to its interactive calling specs.\n\
176
Return the value FUNCTION returns.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
177 178 179 180 181 182 183
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\
184
Otherwise, this is done only if an arg is read using the minibuffer.")
185 186
  (function, record_flag, keys)
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
187 188 189 190 191 192 193
{
  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
194 195
  Lisp_Object enable;
  int speccount = specpdl_ptr - specpdl;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
196

197 198
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
199
  int next_event;
200

Michael I. Bushnell's avatar
Michael I. Bushnell committed
201 202 203
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
204 205 206 207

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
210 211 212 213 214 215
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
216 217 218 219 220 221 222 223 224
  int key_count;

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

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

Jim Blandy's avatar
Jim Blandy committed
229
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
230

231
  if (SYMBOLP (function))
232
    enable = Fget (function, Qenable_recursive_minibuffers);
Richard M. Stallman's avatar
Richard M. Stallman committed
233

Jim Blandy's avatar
Jim Blandy committed
234
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
235 236 237 238 239 240 241 242

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

243
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
244 245 246 247 248
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
249
	  function = wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
250 251
	  goto retry;
	}
252
      if ((EMACS_INT) string == 1)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
253 254 255
	/* Let SPECS (which is nil) be used as the args.  */
	string = 0;
    }
256
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
257
    {
Roland McGrath's avatar
Roland McGrath committed
258
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
	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
274
      if (NILP (specs))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
275 276 277 278
	goto lose;
      specs = Fcar (Fcdr (specs));
    }
  else if (EQ (funcar, Qmocklisp))
279
    {
280
      single_kboard_state ();
281 282
      return ml_apply (fun, Qinteractive);
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
283 284 285
  else
    goto lose;

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

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

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

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

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

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

  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
432 433 434
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
435
  tem = string;
436
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
437 438 439 440 441 442 443 444 445
    {
      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]
446 447 448
	  = (EQ (visargs[j], Qnil)
	     ? (unsigned char *) ""
	     : XSTRING (visargs[j])->data);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
449

450 451 452 453 454 455 456 457
      /* 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,
458
			       j - 1, (char **) argstrings + 1);
459 460 461 462 463 464
	  if (nchars < callint_message_size)
	    break;
	  callint_message_size *= 2;
	  callint_message
	    = (char *) xrealloc (callint_message, callint_message_size);
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
465 466 467 468

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

	case 'B':		/* Name of buffer, possibly nonexistent */
485
	  args[i] = Fread_buffer (build_string (callint_message),
486 487
				  Fother_buffer (Fcurrent_buffer (), Qnil),
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
488 489 490
	  break;

        case 'c':		/* Character */
491
	  /* Use message_with_string rather than message1_nolog here,
492 493
	     so that nothing bad happens if callint_message is changed
	     within Fread_char (by a timer, for example).  */
494
	  message_with_string ("%s", build_string (callint_message), 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
495
	  args[i] = Fread_char ();
496
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
497 498 499 500 501 502
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

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

	case 'D':		/* Directory name. */
519
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
Michael I. Bushnell's avatar
Michael I. Bushnell committed
520 521 522 523
				     current_buffer->directory, Qlambda, Qnil);
	  break;

	case 'f':		/* Existing file name. */
524
	  args[i] = Fread_file_name (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
525 526 527 528
				     Qnil, Qnil, Qlambda, Qnil);
	  break;

	case 'F':		/* Possibly nonexistent file name. */
529
	  args[i] = Fread_file_name (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
530 531 532
				     Qnil, Qnil, Qnil, Qnil);
	  break;

533 534 535 536
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

537
	case 'k':		/* Key sequence. */
538 539 540 541 542 543 544 545 546
	  {
	    int speccount1 = specpdl_ptr - specpdl;
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
					  Qnil, Qnil, Qnil);
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
	    visargs[i] = Fkey_description (teml);
	  }
547 548 549
	  break;

	case 'K':		/* Key sequence to be defined. */
550 551 552 553 554 555 556 557 558
	  {
	    int speccount1 = specpdl_ptr - specpdl;
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
					  Qnil, Qt, Qnil);
	    teml = args[i];
	    visargs[i] = Fkey_description (teml);
	    unbind_to (speccount1, Qnil);
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
559 560
	  break;

561
	case 'e':		/* The invoking event.  */
562
	  if (next_event >= key_count)
563
	    error ("%s must be bound to an event with parameters",
564
		   (SYMBOLP (function)
Jim Blandy's avatar
Jim Blandy committed
565
		    ? (char *) XSYMBOL (function)->name->data
566
		    : "command"));
567
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
568
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
569 570

	  /* Find the next parameterized event.  */
571
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
572
		 && ! (EVENT_HAS_PARAMETERS
573
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
574 575
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
576 577
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
578 579 580
	case 'm':		/* Value of mark.  Does not do I/O.  */
	  check_mark ();
	  /* visargs[i] = Qnil; */
581
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
582 583 584
	  varies[i] = 2;
	  break;

585 586 587 588 589 590
	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
591
	case 'N':		/* Prefix arg, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
592
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
593 594
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
595 596 597 598 599 600 601 602
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
		if (!  first)
		  {
		    message ("Please enter a number.");
603
		    sit_for (1, 0, 0, 0, 0);
604 605 606 607
		  }
		first = 0;

		tem = Fread_from_minibuffer (build_string (callint_message),
608 609
					     Qnil, Qnil, Qnil, Qnil, Qnil,
					     Qnil);
610 611 612 613 614 615 616
		if (! STRINGP (tem) || XSTRING (tem)->size == 0)
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
617 618 619 620 621 622 623 624 625 626
	  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. */
627
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
628 629 630 631 632 633 634
	  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 ();
635
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
636 637 638
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
639
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
640
	  varies[i] = 3;
641
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
642 643 644
	  varies[i] = 4;
	  break;

645 646
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
647
	  args[i] = Fread_string (build_string (callint_message),
648
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
649 650 651
	  break;

	case 'S':		/* Any symbol.  */
652
	  visargs[i] = Fread_string (build_string (callint_message),
653
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
654 655 656 657 658 659 660
	  /* 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. */
661
	  args[i] = Fread_variable (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
662 663 664 665
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
666
	  args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
667 668 669 670
	  visargs[i] = last_minibuf_string;
	  break;

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

675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
	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 */
691
	  args[i] = Fread_coding_system (build_string (callint_message), Qnil);
692 693 694
	  visargs[i] = last_minibuf_string;
	  break;

695 696 697
	  /* 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
698
	default:
699
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
700 701 702 703 704 705
		 *tem, *tem);
	}

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

706
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
707 708 709 710 711 712
	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
713
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
714 715 716 717 718

  QUIT;

  args[0] = function;

719
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
720 721
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
722
      for (i = 1; i < count + 1; i++)
723 724 725 726 727 728
	{
	  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
729 730 731 732
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
    }

733 734
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
735
  for (i = 1; i <= count; i++)
736 737 738
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

739
  single_kboard_state ();
740

Michael I. Bushnell's avatar
Michael I. Bushnell committed
741 742 743 744 745 746 747 748 749 750 751 752
  {
    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,
753
  "Return numeric meaning of raw prefix argument RAW.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
754 755 756 757 758 759 760
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
761
  if (NILP (raw))
762
    XSETFASTINT (val, 1);
763
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
764
    XSETINT (val, -1);
765
  else if (CONSP (raw) && INTEGERP (XCONS (raw)->car))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
766
    XSETINT (val, XINT (XCONS (raw)->car));
767
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
768 769
    val = raw;
  else
770
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
771 772 773 774 775 776

  return val;
}

syms_of_callint ()
{
777 778 779
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

780 781 782 783 784 785 786 787
  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);
788 789 790 791 792 793
  Qlet = intern ("let");
  staticpro (&Qlet);
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
794

Michael I. Bushnell's avatar
Michael I. Bushnell committed
795 796 797
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
798 799 800
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
801 802 803 804 805 806
  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
807 808 809
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

810 811 812
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

813 814 815 816
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


817
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
    "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\").");

  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
836 837 838 839 840 841 842 843 844 845 846
  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;

847
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
848 849 850 851 852 853 854
    "*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;

855 856 857 858 859 860
  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
861 862 863 864
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}