callint.c 27.5 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>
24

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

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

37 38
extern Lisp_Object Qcursor_in_echo_area;

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

43 44
extern Lisp_Object Vhistory_length;

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

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

52 53
Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;

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

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

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

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
66 67
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
       doc: /* Specify a way of parsing arguments for interactive use of a function.
For example, write
  (defun foo (arg) "Doc string" (interactive "p") ...use arg...)
to make ARG be the prefix argument when `foo' is called as a command.
The "call" to `interactive' is actually a declaration rather than a function;
 it tells `call-interactively' how to read arguments
 to pass to the function.
When actually called, `interactive' just returns nil.

The argument of `interactive' is usually a string containing a code letter
 followed by a prompt.  (Some code letters do not use I/O to get
 the argument and do not need prompts.)  To prompt for multiple arguments,
 give a code letter, its prompt, a newline, and another code letter, etc.
 Prompts are passed to format, and may use % escapes to print the
 arguments that have already been read.
If the argument is not a string, it is evaluated to get a list of
 arguments to pass to the function.
Just `(interactive)' means pass no args when calling interactively.

Code letters available are:
a -- Function name: symbol with a function definition.
b -- Name of existing buffer.
B -- Name of buffer, possibly nonexistent.
c -- Character (no input method is used).
C -- Command name: symbol with interactive function definition.
d -- Value of point as number.  Does not do I/O.
D -- Directory name.
e -- Parametrized event (i.e., one that's a list) that invoked this command.
     If used more than once, the Nth `e' returns the Nth parameterized event.
     This skips events that are integers or symbols.
f -- Existing file name.
F -- Possibly nonexistent file name.
i -- Ignored, i.e. always nil.  Does not do I/O.
k -- Key sequence (downcase the last event if needed to get a definition).
K -- Key sequence to be redefined (do not downcase the last event).
m -- Value of mark as number.  Does not do I/O.
M -- Any string.  Inherits the current input method.
n -- Number read using minibuffer.
N -- Raw prefix arg, or if none, do like code `n'.
p -- Prefix arg converted to number.  Does not do I/O.
P -- Prefix arg in raw form.  Does not do I/O.
r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.
s -- Any string.  Does not inherit the current input method.
S -- Any symbol.
v -- Variable name: symbol that is user-variable-p.
x -- Lisp expression read but not evaluated.
X -- Lisp expression read and evaluated.
z -- Coding system.
Z -- Coding system, nil if no prefix arg.
In addition, if the string begins with `*'
 then an error is signaled if the buffer is read-only.
 This happens before reading any arguments.
If the string begins with `@', then Emacs searches the key sequence
 which invoked the command for its first mouse click (or any other
 event which specifies a window), and selects that window before
 reading any arguments.  You may use both `@' and `*'; they are
124 125
 processed in the order that they appear.
usage: (interactive ARGS)  */)
126
     (args)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
127 128 129 130 131 132 133 134 135 136 137
     Lisp_Object args;
{
  return Qnil;
}

/* Quotify EXP: if EXP is constant, return it.
   If EXP is not constant, return (quote EXP).  */
Lisp_Object
quotify_arg (exp)
     register Lisp_Object exp;
{
138
  if (!INTEGERP (exp) && !STRINGP (exp)
Jim Blandy's avatar
Jim Blandy committed
139
      && !NILP (exp) && !EQ (exp, Qt))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
140 141 142 143 144 145 146 147 148 149 150
    return Fcons (Qquote, Fcons (exp, Qnil));

  return exp;
}

/* Modify EXP by quotifying each element (except the first).  */
Lisp_Object
quotify_args (exp)
     Lisp_Object exp;
{
  register Lisp_Object tail;
151 152
  Lisp_Object next;
  for (tail = exp; CONSP (tail); tail = next)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
153
    {
154
      next = XCDR (tail);
155
      XSETCAR (tail, quotify_arg (XCAR (tail)));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
156 157 158 159 160 161 162 163 164 165
    }
  return exp;
}

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

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


176
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
177 178 179 180 181 182 183 184 185 186 187 188 189
       doc: /* Call FUNCTION, reading args according to its interactive calling specs.
Return the value FUNCTION returns.
The function contains a specification of how to do the argument reading.
In the case of user-defined functions, this is specified by placing a call
to the function `interactive' at the top level of the function body.
See `interactive'.

Optional second arg RECORD-FLAG non-nil
means unconditionally put this command in the command-history.
Otherwise, this is done only if an arg is read using the minibuffer.
Optional third arg KEYS, if given, specifies the sequence of events to
supply if the command inquires which events were used to invoke it.  */)
     (function, record_flag, keys)
190
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
191 192 193 194 195 196 197
{
  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
198 199
  Lisp_Object enable;
  int speccount = specpdl_ptr - specpdl;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
200

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
205 206 207
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
208 209 210 211

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

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

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

Jim Blandy's avatar
Jim Blandy committed
233
 retry:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
234

235
  if (SYMBOLP (function))
236
    enable = Fget (function, Qenable_recursive_minibuffers);
237 238
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
239

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

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

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

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

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

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

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

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

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

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

  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
443 444 445
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

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

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

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

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

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

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

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

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

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

540 541 542 543
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

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

	    /* 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))
558
	      teml = XCAR (teml);
559 560 561 562 563
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
615 616
	  break;

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

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

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

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

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

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

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

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

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

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

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

  QUIT;

  args[0] = function;

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

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

785
  single_kboard_state ();
786

Michael I. Bushnell's avatar
Michael I. Bushnell committed
787 788 789 790 791 792 793 794 795 796 797
  {
    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,
798 799 800 801 802
       1, 1, 0,
       doc: /* Return numeric meaning of raw prefix argument RAW.
A raw prefix argument is what you get from `(interactive "P")'.
Its numeric meaning is what you would get from `(interactive "p")'.  */)
     (raw)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
803 804 805 806
     Lisp_Object raw;
{
  Lisp_Object val;
  
Jim Blandy's avatar
Jim Blandy committed
807
  if (NILP (raw))
808
    XSETFASTINT (val, 1);
809
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
810
    XSETINT (val, -1);
811 812
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
813
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
814 815
    val = raw;
  else
816
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
817 818 819 820

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
821
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
822 823
syms_of_callint ()
{
824 825 826
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
842 843 844
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
845 846 847
  Qplus = intern ("+");
  staticpro (&Qplus);

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

857 858 859
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

860 861 862 863
  callint_message_size = 100;
  callint_message = (char *) xmalloc (callint_message_size);


864
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
865 866 867 868 869 870 871 872 873
		 doc: /* The value of the prefix argument for the next editing command.
It may be a number, or the symbol `-' for just a minus sign as arg,
or a list whose car is a number for just one or more C-u's
or nil if no argument has been specified.

You cannot examine this variable to find the argument for this command
since it has been set to nil by the time you can look.
Instead, you should use the variable `current-prefix-arg', although
normally commands can get this prefix argument with (interactive "P").  */);
874

875
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
876 877
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
878

879
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
880 881 882 883 884
	       doc: /* The value of the prefix argument for this editing command.
It may be a number, or the symbol `-' for just a minus sign as arg,
or a list whose car is a number for just one or more C-u's
or nil if no argument has been specified.
This is what `(interactive \"P\")' returns.  */);
885 886
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
887
  DEFVAR_LISP ("command-history", &Vcommand_history,
888 889
	       doc: /* List of recent commands that read arguments from terminal.
Each command is represented as a form to evaluate.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
890 891 892
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
893 894 895
	       doc: /* Debugging status of current interactive command.
Bound each time `call-interactively' is called;
may be set by the debugger as a reminder for itself.  */);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
896 897
  Vcommand_debug_status = Qnil;

898
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
899 900 901 902 903
	       doc: /* *Non-nil means you can use the mark even when inactive.
This option makes a difference in Transient Mark mode.
When the option is non-nil, deactivation of the mark
turns off region highlighting, but commands that use the mark
behave as if the mark were still active.  */);
904 905
  Vmark_even_if_inactive = Qnil;

906
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
907 908 909
	       doc: /* Hook to run when about to switch windows with a mouse command.
Its purpose is to give temporary modes such as Isearch mode
a way to turn themselves off when a mouse command switches windows.  */);
910 911
  Vmouse_leave_buffer_hook = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
912 913 914 915
  defsubr (&Sinteractive);
  defsubr (&Scall_interactively);
  defsubr (&Sprefix_numeric_value);
}