callint.c 27.8 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2 3
   Copyright (C) 1985, 86, 93, 94, 95, 1997, 2000
   Free Software Foundation, Inc.
Michael I. Bushnell's avatar
Michael I. Bushnell committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
21 22


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

Gerd Moellmann's avatar
Gerd Moellmann committed
32 33
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
34
#endif
Michael I. Bushnell's avatar
Michael I. Bushnell committed
35

36 37
extern Lisp_Object Qcursor_in_echo_area;

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

42 43
extern Lisp_Object Vhistory_length;

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

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

51 52
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

53
Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion;
54 55 56 57
static Lisp_Object preserved_fns;

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

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

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

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

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

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

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


180
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
Michael I. Bushnell's avatar
Michael I. Bushnell committed
181
  "Call FUNCTION, reading args according to its interactive calling specs.\n\
182
Return the value FUNCTION returns.\n\
Michael I. Bushnell's avatar
Michael I. Bushnell committed
183 184 185 186 187 188 189
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
190 191 192
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.")
193 194
  (function, record_flag, keys)
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
195 196 197 198 199 200 201
{
  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
202 203
  Lisp_Object enable;
  int speccount = specpdl_ptr - specpdl;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
204

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
244
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
245 246 247 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 262
	  goto retry;
	}
    }
263
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
264
    {
Roland McGrath's avatar
Roland McGrath committed
265
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
266 267 268 269 270
	goto lose;
      specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
    }
  else if (!CONSP (fun))
    goto lose;
271
  else if (funcar = XCAR (fun), EQ (funcar, Qautoload))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
272 273 274 275 276 277 278 279
    {
      GCPRO2 (function, prefix_arg);
      do_autoload (fun, function);
      UNGCPRO;
      goto retry;
    }
  else if (EQ (funcar, Qlambda))
    {
280
      specs = Fassq (Qinteractive, Fcdr (XCDR (fun)));
Jim Blandy's avatar
Jim Blandy committed
281
      if (NILP (specs))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
282 283 284 285
	goto lose;
      specs = Fcar (Fcdr (specs));
    }
  else if (EQ (funcar, Qmocklisp))
286
    {
287
      single_kboard_state ();
288 289
      return ml_apply (fun, Qinteractive);
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
290 291 292
  else
    goto lose;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
370
  /* Set next_event to point to the first event with parameters.  */
371 372
  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
373 374
      break;
  
375
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
376
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
377 378
  while (1)
    {
379
      if (*string == '+')
380 381
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
382 383
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
384
	  if (!NILP (current_buffer->read_only))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
385 386
	    Fbarf_if_buffer_read_only ();
	}
387 388 389
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
390 391
      else if (*string == '@')
	{
392
	  Lisp_Object event;
Jim Blandy's avatar
Jim Blandy committed
393

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

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

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

  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
447 448 449
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

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

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

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

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

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

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

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

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

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

544 545 546 547
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
619 620
	  break;

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

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

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

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

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

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

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

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

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

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

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

  QUIT;

  args[0] = function;

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

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

789
  single_kboard_state ();
790

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

  return val;
}

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

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
846 847 848
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
849 850 851
  Qplus = intern ("+");
  staticpro (&Qplus);

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

861 862 863
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

864 865 866 867
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


868
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
869 870
    "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\
871
or a list whose car is a number for just one or more C-u's\n\
872 873 874 875 876 877 878
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\").");

879 880 881 882
  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.");

883 884 885
  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\
886
or a list whose car is a number for just one or more C-u's\n\
887 888 889 890
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
891 892 893 894 895 896 897 898 899 900 901
  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;

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

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