callint.c 24.8 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2
   Copyright (C) 1985, 1986, 1993, 1994, 1995 Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
9 10 11 12 13 14 15 16 17
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
Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
33 34 35 36
Lisp_Object Qcall_interactively;
Lisp_Object Vcommand_history;

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

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

43 44
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

45
Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion;
46 47 48 49
static Lisp_Object preserved_fns;

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

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

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
57 58 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
/* 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\
88 89 90
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
91 92
f -- Existing file name.\n\
F -- Possibly nonexistent file name.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
93 94
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
95 96
m -- Value of mark as number.  Does not do I/O.\n\
n -- Number read using minibuffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
97
N -- Raw prefix arg, or if none, do like code `n'.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
98 99 100 101 102 103 104 105 106 107 108
p -- Prefix arg converted to number.  Does not do I/O.\n\
P -- Prefix arg in raw form.  Does not do I/O.\n\
r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.\n\
s -- Any string.\n\
S -- Any symbol.\n\
v -- Variable name: symbol that is user-variable-p.\n\
x -- Lisp expression read but not evaluated.\n\
X -- Lisp expression read and evaluated.\n\
In addition, if the string begins with `*'\n\
 then an error is signaled if the buffer is read-only.\n\
 This happens before reading any arguments.\n\
Jim Blandy's avatar
Jim Blandy committed
109 110 111 112 113
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
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129

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


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

191 192
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
193
  int next_event;
194

Michael I. Bushnell's avatar
Michael I. Bushnell committed
195 196 197
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
198 199 200 201

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
204 205 206 207 208 209
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
210 211 212 213 214 215 216 217 218
  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
219

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

Jim Blandy's avatar
Jim Blandy committed
223
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
224

225
  if (SYMBOLP (function))
226
    enable = Fget (function, Qenable_recursive_minibuffers);
Richard M. Stallman's avatar
Richard M. Stallman committed
227

Jim Blandy's avatar
Jim Blandy committed
228
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
229 230 231 232 233 234 235 236

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

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

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

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

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

372
	  event = XVECTOR (keys)->contents[next_event];
Jim Blandy's avatar
Jim Blandy committed
373
	  if (EVENT_HAS_PARAMETERS (event)
374
	      && (event = XCONS (event)->cdr, CONSP (event))
375
	      && (event = XCONS (event)->car, CONSP (event))
Karl Heuer's avatar
Karl Heuer committed
376
	      && (event = XCONS (event)->car, WINDOWP (event)))
377
	    {
Karl Heuer's avatar
Karl Heuer committed
378
	      if (MINI_WINDOW_P (XWINDOW (event))
379
		  && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
380
		error ("Attempt to select inactive minibuffer window");
381 382 383 384 385

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

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

  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
425 426 427
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
428
  tem = string;
429
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
430 431 432 433 434 435 436 437 438 439 440
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
      tem1 = index (prompt1, '\n');
      if (tem1) *tem1 = 0;
      /* Fill argstrings with a vector of C strings
	 corresponding to the Lisp strings in visargs.  */
      for (j = 1; j < i; j++)
	argstrings[j]
	  = EQ (visargs[j], Qnil)
	    ? (unsigned char *) ""
Jim Blandy's avatar
Jim Blandy committed
441
	      : XSTRING (visargs[j])->data;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
442

443 444 445 446 447 448 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,
			       j - 1, argstrings + 1);
	  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
458 459 460 461

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
462
	  visargs[i] = Fcompleting_read (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
463 464 465 466 467 468 469 470 471
					 Vobarray, Qfboundp, Qt, Qnil, Qnil);
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'b':   		/* Name of existing buffer */
	  args[i] = Fcurrent_buffer ();
	  if (EQ (selected_window, minibuf_window))
472
	    args[i] = Fother_buffer (args[i], Qnil);
473
	  args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
474 475 476
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
477
	  args[i] = Fread_buffer (build_string (callint_message),
478 479
				  Fother_buffer (Fcurrent_buffer (), Qnil),
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
480 481 482
	  break;

        case 'c':		/* Character */
483 484 485 486
	  /* Use message_nolog rather than message1_nolog here,
	     so that nothing bad happens if callint_message is changed
	     within Fread_char (by a timer, for example).  */
	  message_nolog ("%s", callint_message);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
487
	  args[i] = Fread_char ();
488
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
489 490 491 492 493 494
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
495
	  visargs[i] = Fcompleting_read (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
496 497 498 499 500 501 502
					 Vobarray, Qcommandp, Qt, Qnil, Qnil);
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = visargs[i];
	  args[i] = Fintern (teml, Qnil);
	  break;

	case 'd':		/* Value of point.  Does not do I/O.  */
503 504
	  Fset_marker (point_marker, make_number (PT), Qnil);
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
505 506 507 508 509
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
510
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
Michael I. Bushnell's avatar
Michael I. Bushnell committed
511 512 513 514
				     current_buffer->directory, Qlambda, Qnil);
	  break;

	case 'f':		/* Existing file name. */
515
	  args[i] = Fread_file_name (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
516 517 518 519
				     Qnil, Qnil, Qlambda, Qnil);
	  break;

	case 'F':		/* Possibly nonexistent file name. */
520
	  args[i] = Fread_file_name (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
521 522 523
				     Qnil, Qnil, Qnil, Qnil);
	  break;

524
	case 'k':		/* Key sequence. */
525 526
	  args[i] = Fread_key_sequence (build_string (callint_message),
					Qnil, Qnil, Qnil);
527 528 529 530 531
	  teml = args[i];
	  visargs[i] = Fkey_description (teml);
	  break;

	case 'K':		/* Key sequence to be defined. */
532 533
	  args[i] = Fread_key_sequence (build_string (callint_message),
					Qnil, Qt, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
534 535 536 537
	  teml = args[i];
	  visargs[i] = Fkey_description (teml);
	  break;

538
	case 'e':		/* The invoking event.  */
539
	  if (next_event >= key_count)
540
	    error ("%s must be bound to an event with parameters",
541
		   (SYMBOLP (function)
Jim Blandy's avatar
Jim Blandy committed
542
		    ? (char *) XSYMBOL (function)->name->data
543
		    : "command"));
544
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
545
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
546 547

	  /* Find the next parameterized event.  */
548
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
549
		 && ! (EVENT_HAS_PARAMETERS
550
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
551 552
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
553 554
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
555 556 557
	case 'm':		/* Value of mark.  Does not do I/O.  */
	  check_mark ();
	  /* visargs[i] = Qnil; */
558
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
559 560 561 562
	  varies[i] = 2;
	  break;

	case 'N':		/* Prefix arg, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
563
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
564 565
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
		if (!  first)
		  {
		    message ("Please enter a number.");
		    sit_for (1, 0, 0, 0);
		  }
		first = 0;

		tem = Fread_from_minibuffer (build_string (callint_message),
					     Qnil, Qnil, Qnil, Qnil);
		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
587 588 589 590 591 592 593 594 595 596
	  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. */
597
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
598 599 600 601 602 603 604
	  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 ();
605
	  Fset_marker (point_marker, make_number (PT), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
606 607 608
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
609
	  args[i] = point < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
610
	  varies[i] = 3;
611
	  args[++i] = point > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
612 613 614 615
	  varies[i] = 4;
	  break;

	case 's':		/* String read via minibuffer.  */
616
	  args[i] = Fread_string (build_string (callint_message), Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
617 618 619
	  break;

	case 'S':		/* Any symbol.  */
620 621
	  visargs[i] = Fread_string (build_string (callint_message),
				     Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
622 623 624 625 626 627 628
	  /* 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. */
629
	  args[i] = Fread_variable (build_string (callint_message));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
630 631 632 633
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
634
	  args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
635 636 637 638
	  visargs[i] = last_minibuf_string;
	  break;

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

643 644 645
	  /* 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
646
	default:
647
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
648 649 650 651 652 653
		 *tem, *tem);
	}

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

654
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
655 656 657 658 659 660
	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
661
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
662 663 664 665 666

  QUIT;

  args[0] = function;

667
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
668 669
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
670
      for (i = 1; i < count + 1; i++)
671 672 673 674 675 676
	{
	  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
677 678 679 680
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
    }

681 682
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
683
  for (i = 1; i <= count; i++)
684 685 686
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

687
  single_kboard_state ();
688

Michael I. Bushnell's avatar
Michael I. Bushnell committed
689 690 691 692 693 694 695 696 697 698 699 700
  {
    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,
701
  "Return numeric meaning of raw prefix argument RAW.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
702 703 704 705 706 707 708
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
709
  if (NILP (raw))
710
    XSETFASTINT (val, 1);
711
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
712
    XSETINT (val, -1);
713
  else if (CONSP (raw) && INTEGERP (XCONS (raw)->car))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
714
    XSETINT (val, XINT (XCONS (raw)->car));
715
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
716 717
    val = raw;
  else
718
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
719 720 721 722 723 724

  return val;
}

syms_of_callint ()
{
725 726 727
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

728 729 730 731 732 733 734 735
  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);
736 737 738 739 740 741
  Qlet = intern ("let");
  staticpro (&Qlet);
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
742

Michael I. Bushnell's avatar
Michael I. Bushnell committed
743 744 745
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
746 747 748
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
749 750 751 752 753 754
  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
755 756 757
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

758 759 760
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

761 762 763 764
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


765
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
    "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
784 785 786 787 788 789 790 791 792 793 794
  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;

795
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
796 797 798 799 800 801 802
    "*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;

803 804 805 806 807 808
  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
809 810 811 812
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}