callint.c 27.9 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
#include "window.h"
#include "mocklisp.h"

30 31 32 33 34 35 36
#ifdef HAVE_STRING_H
#include <string.h>
#endif

#ifdef HAVE_STRINGS_H
#include <strings.h>
#endif
Michael I. Bushnell's avatar
Michael I. Bushnell committed
37

38 39
extern Lisp_Object Qcursor_in_echo_area;

40
Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
41 42 43
Lisp_Object Qcall_interactively;
Lisp_Object Vcommand_history;

44 45
extern Lisp_Object Vhistory_length;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
46
Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
Richard M. Stallman's avatar
Richard M. Stallman committed
47
Lisp_Object Qenable_recursive_minibuffers;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
48

49 50 51 52
/* Non-nil means treat the mark as active
   even if mark_active is 0.  */
Lisp_Object Vmark_even_if_inactive;

53 54
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

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

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
67 68 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
/* 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\
94
c -- Character (no input method is used).\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
95 96 97
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\
98 99 100
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
101 102
f -- Existing file name.\n\
F -- Possibly nonexistent file name.\n\
103
i -- Ignored, i.e. always nil.  Does not do I/O.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
104 105
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
106
m -- Value of mark as number.  Does not do I/O.\n\
107
M -- Any string.  Inherits the current input method.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
108
n -- Number read using minibuffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
109
N -- Raw prefix arg, or if none, do like code `n'.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
110 111 112
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\
113
s -- Any string.  Does not inherit the current input method.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
114 115 116 117
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\
118 119
z -- Coding system.\n\
Z -- Coding system, nil if no prefix arg.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
120 121 122
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
123 124 125 126 127
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
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143

/* 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;
{
144
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
145
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
146 147 148 149 150 151 152 153 154 155 156
    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;
157 158
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
159
    {
160 161
      next = XCDR (tail);
      XCAR (tail) = quotify_arg (XCAR (tail));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
162 163 164 165 166 167 168 169 170 171
    }
  return exp;
}

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

static void
check_mark ()
{
172 173
  Lisp_Object tem;
  tem = Fmarker_buffer (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
174
  if (NILP (tem) || (XBUFFER (tem) != current_buffer))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
175
    error ("The mark is not set now");
176 177 178
  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
179 180 181
}


182
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
Michael I. Bushnell's avatar
Michael I. Bushnell committed
183
  "Call FUNCTION, reading args according to its interactive calling specs.\n\
184
Return the value FUNCTION returns.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
185 186 187 188 189 190 191
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\
Dave Love's avatar
Dave Love committed
192 193 194
Otherwise, this is done only if an arg is read using the minibuffer.\n\
Optional third arg KEYS, if given, specifies the sequence of events to\n\
supply if the command inquires which events were used to invoke it.")
195 196
  (function, record_flag, keys)
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
197 198 199 200 201 202 203
{
  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
204 205
  Lisp_Object enable;
  int speccount = specpdl_ptr - specpdl;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
206

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
211 212 213
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
214 215 216 217

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
220 221 222 223 224 225
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
226 227 228 229 230 231 232 233 234
  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
235

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

Jim Blandy's avatar
Jim Blandy committed
239
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
240

241
  if (SYMBOLP (function))
242
    enable = Fget (function, Qenable_recursive_minibuffers);
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 248 249 250 251 252

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

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

Jim Blandy's avatar
Jim Blandy committed
296
  /* If either specs or string is set to a string, use it.  */
297
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
298 299 300
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
301 302 303
      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
304
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
305 306
  else if (string == 0)
    {
307
      Lisp_Object input;
308
      i = num_input_events;
309 310
      input = specs;
      /* Compute the arg values using the user's expression.  */
311
      specs = Feval (specs);
312
      if (i != num_input_events || !NILP (record_flag))
313 314 315 316 317 318 319 320 321 322
	{
	  /* 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.  */
323
	  if (CONSP (input))
324
	    {
325
	      car = XCAR (input);
326 327 328
	      /* Skip through certain special forms.  */
	      while (EQ (car, Qlet) || EQ (car, Qletx)
		     || EQ (car, Qsave_excursion))
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 360 361 362 363

	  /* Don't keep command history around forever.  */
	  if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
364
		XCDR (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 377
      break;
  
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))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
388 389
	    Fbarf_if_buffer_read_only ();
	}
390 391 392
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
393 394
      else if (*string == '@')
	{
395
	  Lisp_Object event;
Jim Blandy's avatar
Jim Blandy committed
396

397
	  event = XVECTOR (keys)->contents[next_event];
Jim Blandy's avatar
Jim Blandy committed
398
	  if (EVENT_HAS_PARAMETERS (event)
399 400 401
	      && (event = XCDR (event), CONSP (event))
	      && (event = XCAR (event), CONSP (event))
	      && (event = XCAR (event), WINDOWP (event)))
402
	    {
Karl Heuer's avatar
Karl Heuer committed
403
	      if (MINI_WINDOW_P (XWINDOW (event))
404
		  && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
405
		error ("Attempt to select inactive minibuffer window");
406 407 408 409 410

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

411 412
	      Fselect_window (event);
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
	  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 *) "";
    }
432
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449

  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
450 451 452
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
453
  tem = string;
454
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
455 456 457
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
458
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
459 460 461 462 463
      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]
464 465 466
	  = (EQ (visargs[j], Qnil)
	     ? (unsigned char *) ""
	     : XSTRING (visargs[j])->data);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
467

468 469 470 471 472 473 474 475
      /* 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,
476
			       j - 1, (char **) argstrings + 1);
477 478 479 480 481 482
	  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
483 484 485 486

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
487
	  visargs[i] = Fcompleting_read (build_string (callint_message),
488
					 Vobarray, Qfboundp, Qt,
489
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
490 491 492 493 494 495 496 497
	  /* 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))
498
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
499
	  args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
500 501 502
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
503
	  args[i] = Fread_buffer (build_string (callint_message),
504
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
505
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
506 507 508
	  break;

        case 'c':		/* Character */
509
	  args[i] = Fread_char (build_string (callint_message), Qnil);
510
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
511 512 513 514 515 516
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
517
	  visargs[i] = Fcompleting_read (build_string (callint_message),
518
					 Vobarray, Qcommandp,
519
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
520 521 522 523 524 525
	  /* 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.  */
526
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
527
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
528 529 530 531 532
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
533
	  args[i] = Fread_file_name (build_string (callint_message), Qnil,
Michael I. Bushnell's avatar
Michael I. Bushnell committed
534 535 536 537
				     current_buffer->directory, Qlambda, Qnil);
	  break;

	case 'f':		/* Existing file name. */
538
	  args[i] = Fread_file_name (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
539 540 541 542
				     Qnil, Qnil, Qlambda, Qnil);
	  break;

	case 'F':		/* Possibly nonexistent file name. */
543
	  args[i] = Fread_file_name (build_string (callint_message),
Michael I. Bushnell's avatar
Michael I. Bushnell committed
544 545 546
				     Qnil, Qnil, Qnil, Qnil);
	  break;

547 548 549 550
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

551
	case 'k':		/* Key sequence. */
552 553 554 555
	  {
	    int speccount1 = specpdl_ptr - specpdl;
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
556
					  Qnil, Qnil, Qnil, Qnil);
557 558 559
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
	    visargs[i] = Fkey_description (teml);
560 561 562 563 564

	    /* 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))
565
	      teml = XCAR (teml);
566 567 568 569 570
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
571 572
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
573
		if (! NILP (tem2))
574
		  Fread_event (Qnil, Qnil);
575
	      }
576
	  }
577 578 579
	  break;

	case 'K':		/* Key sequence to be defined. */
580 581 582 583
	  {
	    int speccount1 = specpdl_ptr - specpdl;
	    specbind (Qcursor_in_echo_area, Qt);
	    args[i] = Fread_key_sequence (build_string (callint_message),
584
					  Qnil, Qt, Qnil, Qnil);
585 586 587
	    teml = args[i];
	    visargs[i] = Fkey_description (teml);
	    unbind_to (speccount1, Qnil);
588 589 590 591 592

	    /* 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))
593
	      teml = XCAR (teml);
594 595 596 597 598
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
599 600
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
601
		if (! NILP (tem2))
602
		  Fread_event (Qnil, Qnil);
603
	      }
604
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
605 606
	  break;

607
	case 'e':		/* The invoking event.  */
608
	  if (next_event >= key_count)
609
	    error ("%s must be bound to an event with parameters",
610
		   (SYMBOLP (function)
Jim Blandy's avatar
Jim Blandy committed
611
		    ? (char *) XSYMBOL (function)->name->data
612
		    : "command"));
613
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
614
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
615 616

	  /* Find the next parameterized event.  */
617
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
618
		 && ! (EVENT_HAS_PARAMETERS
619
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
620 621
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
622 623
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
624 625 626
	case 'm':		/* Value of mark.  Does not do I/O.  */
	  check_mark ();
	  /* visargs[i] = Qnil; */
627
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
628 629 630
	  varies[i] = 2;
	  break;

631 632 633 634 635 636
	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
637
	case 'N':		/* Prefix arg, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
638
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
639 640
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
641 642 643 644 645 646 647 648
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
		if (!  first)
		  {
		    message ("Please enter a number.");
649
		    sit_for (1, 0, 0, 0, 0);
650 651 652 653
		  }
		first = 0;

		tem = Fread_from_minibuffer (build_string (callint_message),
654 655
					     Qnil, Qnil, Qnil, Qnil, Qnil,
					     Qnil);
656 657 658 659 660 661 662
		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
663 664 665 666 667 668 669 670 671 672
	  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. */
673
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
674 675 676 677 678 679 680
	  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 ();
681
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
682 683 684
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
685
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
686
	  varies[i] = 3;
687
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
688 689 690
	  varies[i] = 4;
	  break;

691 692
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
693
	  args[i] = Fread_string (build_string (callint_message),
694
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
695 696 697
	  break;

	case 'S':		/* Any symbol.  */
698
	  visargs[i] = Fread_string (build_string (callint_message),
699
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
700 701 702 703 704 705 706
	  /* 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. */
707
	  args[i] = Fread_variable (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
708 709 710 711
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
712
	  args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
713 714 715 716
	  visargs[i] = last_minibuf_string;
	  break;

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

721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
	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 */
737
	  args[i] = Fread_coding_system (build_string (callint_message), Qnil);
738 739 740
	  visargs[i] = last_minibuf_string;
	  break;

741 742 743
	  /* 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
744
	default:
745
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
746 747 748 749 750 751
		 *tem, *tem);
	}

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

752
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
753 754 755 756 757 758
	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
759
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
760 761 762 763 764

  QUIT;

  args[0] = function;

765
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
766 767
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
768
      for (i = 1; i < count + 1; i++)
769 770 771 772 773 774
	{
	  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
775 776
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
777 778 779 780 781
      /* Don't keep command history around forever.  */
      if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
782
	    XCDR (teml) = Qnil;
783
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
784 785
    }

786 787
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
788
  for (i = 1; i <= count; i++)
789 790 791
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

792
  single_kboard_state ();
793

Michael I. Bushnell's avatar
Michael I. Bushnell committed
794 795 796 797 798 799 800 801 802 803 804 805
  {
    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,
806
  "Return numeric meaning of raw prefix argument RAW.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
807 808 809 810 811 812 813
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
814
  if (NILP (raw))
815
    XSETFASTINT (val, 1);
816
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
817
    XSETINT (val, -1);
818 819
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
820
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
821 822
    val = raw;
  else
823
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
824 825 826 827

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
828
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
829 830
syms_of_callint ()
{
831 832 833
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

834 835 836 837 838 839 840 841
  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);
842 843 844 845 846 847
  Qlet = intern ("let");
  staticpro (&Qlet);
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
848

Michael I. Bushnell's avatar
Michael I. Bushnell committed
849 850 851
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
852 853 854
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
855 856 857 858 859 860
  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
861 862 863
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

864 865 866
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

867 868 869 870
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


871
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
872 873 874 875 876 877 878 879 880 881
    "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\").");

882 883 884 885
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
    "The value of the prefix argument for the previous editing command.\n\
See `prefix-arg' for the meaning of the value.");

886 887 888 889 890 891 892 893
  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
894 895 896 897 898 899 900 901 902 903 904
  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;

905
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
906 907 908 909 910 911 912
    "*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;

913 914 915 916 917 918
  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
919 920 921 922
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}