callint.c 29.5 KB
Newer Older
Michael I. Bushnell's avatar
Michael I. Bushnell committed
1
/* Call a Lisp function interactively.
2 3
   Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002,
                 2003, 2004, 2005, 2006, 2007  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
9
the Free Software Foundation; either version 3, 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
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, 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
#include "window.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
extern Lisp_Object Qcursor_in_echo_area;
37
extern Lisp_Object Qfile_directory_p;
38

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
extern Lisp_Object Vhistory_length;
44
extern Lisp_Object Vthis_original_command, real_this_command;
45

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, Qprogn, Qif, Qwhen;
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
/* String for the prompt text used in Fcall_interactively.  */
static Lisp_Object callint_message;
Richard M. Stallman's avatar
Richard M. Stallman committed
63

Michael I. Bushnell's avatar
Michael I. Bushnell committed
64 65
/* ARGSUSED */
DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
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 92 93 94 95 96 97
       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.
98
G -- Possibly nonexistent file name, defaulting to just directory name.
99 100 101 102 103 104
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.
Richard M. Stallman's avatar
Richard M. Stallman committed
105
N -- Numeric prefix arg, or if none, do like code `n'.
106 107 108 109 110
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.
111
U -- Mouse up event discarded by a previous k or K argument.
112 113 114 115 116 117 118 119 120 121 122 123
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
    }
  return exp;
}

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

static void
164 165
check_mark (for_region)
     int for_region;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
166
{
167 168
  Lisp_Object tem;
  tem = Fmarker_buffer (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
169
  if (NILP (tem) || (XBUFFER (tem) != current_buffer))
170 171
    error (for_region ? "The mark is not set now, so there is no region"
	   : "The mark is not set now");
172 173
  if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
      && NILP (current_buffer->mark_active))
Kim F. Storm's avatar
Kim F. Storm committed
174
    xsignal0 (Qmark_inactive);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
175 176
}

Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179 180 181 182 183 184
/* If the list of args INPUT 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.

   This function doesn't return a value because it modifies elements
   of VALUES to do its job.  */

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
static void
fix_command (input, values)
     Lisp_Object input, values;
{
  if (CONSP (input))
    {
      Lisp_Object car;

      car = XCAR (input);
      /* Skip through certain special forms.  */
      while (EQ (car, Qlet) || EQ (car, Qletx)
	     || EQ (car, Qsave_excursion)
	     || EQ (car, Qprogn))
	{
	  while (CONSP (XCDR (input)))
	    input = XCDR (input);
	  input = XCAR (input);
	  if (!CONSP (input))
	    break;
	  car = XCAR (input);
	}
      if (EQ (car, Qlist))
	{
	  Lisp_Object intail, valtail;
	  for (intail = Fcdr (input), valtail = values;
	       CONSP (valtail);
Stefan Monnier's avatar
Stefan Monnier committed
211
	       intail = Fcdr (intail), valtail = XCDR (valtail))
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
	    {
	      Lisp_Object elt;
	      elt = Fcar (intail);
	      if (CONSP (elt))
		{
		  Lisp_Object presflag, carelt;
		  carelt = Fcar (elt);
		  /* If it is (if X Y), look at Y.  */
		  if (EQ (carelt, Qif)
		      && EQ (Fnthcdr (make_number (3), elt), Qnil))
		    elt = Fnth (make_number (2), elt);
		  /* If it is (when ... Y), look at Y.  */
		  else if (EQ (carelt, Qwhen))
		    {
		      while (CONSP (XCDR (elt)))
			elt = XCDR (elt);
		      elt = Fcar (elt);
		    }

		  /* If the function call we're looking at
		     is a special preserved one, copy the
		     whole expression for this argument.  */
		  if (CONSP (elt))
		    {
		      presflag = Fmemq (Fcar (elt), preserved_fns);
		      if (!NILP (presflag))
			Fsetcar (valtail, Fcar (intail));
		    }
		}
	    }
	}
    }
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
245

246
DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
247 248 249 250 251 252 253 254 255 256
       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.
257

258
Optional third arg KEYS, if given, specifies the sequence of events to
259 260 261
supply, as a vector, if the command inquires which events were used to
invoke it.  If KEYS is omitted or nil, the return value of
`this-command-keys-vector' is used.  */)
262
     (function, record_flag, keys)
263
     Lisp_Object function, record_flag, keys;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
264 265 266 267
{
  Lisp_Object *args, *visargs;
  Lisp_Object fun;
  Lisp_Object specs;
268
  Lisp_Object filter_specs;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
269
  Lisp_Object teml;
270
  Lisp_Object up_event;
Richard M. Stallman's avatar
Richard M. Stallman committed
271
  Lisp_Object enable;
Juanma Barranquero's avatar
Juanma Barranquero committed
272
  int speccount = SPECPDL_INDEX ();
Michael I. Bushnell's avatar
Michael I. Bushnell committed
273

274 275
  /* The index of the next element of this_command_keys to examine for
     the 'e' interactive code.  */
Jim Blandy's avatar
Jim Blandy committed
276
  int next_event;
277

Michael I. Bushnell's avatar
Michael I. Bushnell committed
278 279 280
  Lisp_Object prefix_arg;
  unsigned char *string;
  unsigned char *tem;
Jim Blandy's avatar
Jim Blandy committed
281 282 283 284

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

Michael I. Bushnell's avatar
Michael I. Bushnell committed
287 288 289 290 291
  register int i, j;
  int count, foo;
  char prompt1[100];
  char *tem1;
  int arg_from_tty = 0;
292
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
293
  int key_count;
294
  int record_then_fail = 0;
295

296 297 298 299 300 301 302 303
  Lisp_Object save_this_command, save_last_command;
  Lisp_Object save_this_original_command, save_real_this_command;

  save_this_command = Vthis_command;
  save_this_original_command = Vthis_original_command;
  save_real_this_command = real_this_command;
  save_last_command = current_kboard->Vlast_command;

304 305 306 307
  if (NILP (keys))
    keys = this_command_keys, key_count = this_command_key_count;
  else
    {
308
      CHECK_VECTOR (keys);
309 310
      key_count = XVECTOR (keys)->size;
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
311

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

315
  if (SYMBOLP (function))
316
    enable = Fget (function, Qenable_recursive_minibuffers);
317 318
  else
    enable = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
319

Jim Blandy's avatar
Jim Blandy committed
320
  fun = indirect_function (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
321 322 323

  specs = Qnil;
  string = 0;
324 325 326 327
  /* The idea of FILTER_SPECS is to provide away to
     specify how to represent the arguments in command history.
     The feature is not fully implemented.  */
  filter_specs = Qnil;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
328

329 330 331
  /* If k or K discard an up-event, save it here so it can be retrieved with U */
  up_event = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
332
  /* Decode the kind of function.  Either handle it and return,
333
     or go to `lose' if not interactive, or set either STRING or SPECS.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
334

335
  if (SUBRP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
336 337 338 339 340
    {
      string = (unsigned char *) XSUBR (fun)->prompt;
      if (!string)
	{
	lose:
341
	  wrong_type_argument (Qcommandp, function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
342 343
	}
    }
344
  else if (COMPILEDP (fun))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
345
    {
Roland McGrath's avatar
Roland McGrath committed
346
      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
347 348 349
	goto lose;
      specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
    }
350
  else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
351
    {
352
      Lisp_Object form;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
353
      GCPRO2 (function, prefix_arg);
354
      form = Finteractive_form (function);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
355
      UNGCPRO;
356 357 358
      if (CONSP (form))
	specs = filter_specs = Fcar (XCDR (form));
      else
Michael I. Bushnell's avatar
Michael I. Bushnell committed
359 360 361
	goto lose;
    }

362
  /* If either SPECS or STRING is set to a string, use it.  */
363
  if (STRINGP (specs))
Jim Blandy's avatar
Jim Blandy committed
364 365 366
    {
      /* Make a copy of string so that if a GC relocates specs,
	 `string' will still be valid.  */
367 368 369
      string = (unsigned char *) alloca (SBYTES (specs) + 1);
      bcopy (SDATA (specs), string,
	     SBYTES (specs) + 1);
Jim Blandy's avatar
Jim Blandy committed
370
    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
371 372
  else if (string == 0)
    {
373
      Lisp_Object input;
374
      i = num_input_events;
375 376
      input = specs;
      /* Compute the arg values using the user's expression.  */
377
      GCPRO2 (input, filter_specs);
378
      specs = Feval (specs);
379
      UNGCPRO;
380
      if (i != num_input_events || !NILP (record_flag))
381 382
	{
	  /* We should record this command on the command history.  */
383
	  Lisp_Object values;
384 385 386
	  /* 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));
387
	  fix_command (input, values);
388 389
	  Vcommand_history
	    = Fcons (Fcons (function, values), Vcommand_history);
390 391

	  /* Don't keep command history around forever.  */
392
	  if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
393 394 395
	    {
	      teml = Fnthcdr (Vhistory_length, Vcommand_history);
	      if (CONSP (teml))
396
		XSETCDR (teml, Qnil);
397
	    }
398
	}
399 400 401 402 403 404

      Vthis_command = save_this_command;
      Vthis_original_command = save_this_original_command;
      real_this_command= save_real_this_command;
      current_kboard->Vlast_command = save_last_command;

405 406
      temporarily_switch_to_single_kboard (NULL);
      return unbind_to (speccount, apply1 (function, specs));
Michael I. Bushnell's avatar
Michael I. Bushnell committed
407 408 409 410
    }

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

Jim Blandy's avatar
Jim Blandy committed
411
  /* Set next_event to point to the first event with parameters.  */
412 413
  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
414
      break;
415

416
  /* Handle special starting chars `*' and `@'.  Also `-'.  */
417
  /* Note that `+' is reserved for user extensions.  */
Michael I. Bushnell's avatar
Michael I. Bushnell committed
418 419
  while (1)
    {
420
      if (*string == '+')
421 422
	error ("`+' is not used in `interactive' for ordinary commands");
      else if (*string == '*')
Michael I. Bushnell's avatar
Michael I. Bushnell committed
423 424
	{
	  string++;
Jim Blandy's avatar
Jim Blandy committed
425
	  if (!NILP (current_buffer->read_only))
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
	    {
	      if (!NILP (record_flag))
		{
		  unsigned char *p = string;
		  while (*p)
		    {
		      if (! (*p == 'r' || *p == 'p' || *p == 'P'
			     || *p == '\n'))
			Fbarf_if_buffer_read_only ();
		      p++;
		    }
		  record_then_fail = 1;
		}
	      else
		Fbarf_if_buffer_read_only ();
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
442
	}
443 444 445
      /* Ignore this for semi-compatibility with Lucid.  */
      else if (*string == '-')
	string++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
446 447
      else if (*string == '@')
	{
448
	  Lisp_Object event, tem;
Jim Blandy's avatar
Jim Blandy committed
449

450 451 452
	  event = (next_event < key_count
		   ? XVECTOR (keys)->contents[next_event]
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
453
	  if (EVENT_HAS_PARAMETERS (event)
454 455 456
	      && (tem = XCDR (event), CONSP (tem))
	      && (tem = XCAR (tem), CONSP (tem))
	      && (tem = XCAR (tem), WINDOWP (tem)))
457
	    {
458 459
	      if (MINI_WINDOW_P (XWINDOW (tem))
		  && ! (minibuf_level > 0 && EQ (tem, minibuf_window)))
460
		error ("Attempt to select inactive minibuffer window");
461 462 463 464 465

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

466
	      Fselect_window (tem, Qnil);
467
	    }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
468 469 470 471 472 473 474 475
	  string++;
	}
      else break;
    }

  /* Count the number of arguments the interactive spec would have
     us give to the function.  */
  tem = string;
476
  for (j = 0; *tem;)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
477 478 479
    {
      /* 'r' specifications ("point and mark as 2 numeric args")
	 produce *two* arguments.  */
480 481 482 483
      if (*tem == 'r')
	j += 2;
      else
	j++;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
484 485
      tem = (unsigned char *) index (tem, '\n');
      if (tem)
486
	++tem;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
487
      else
488
	break;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
489
    }
490
  count = j;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
491 492 493 494 495 496 497 498 499 500 501 502

  args = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
  visargs = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
  varies = (int *) alloca ((count + 1) * sizeof (int));

  for (i = 0; i < (count + 1); i++)
    {
      args[i] = Qnil;
      visargs[i] = Qnil;
      varies[i] = 0;
    }

503
  GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
504 505 506
  gcpro3.nvars = (count + 1);
  gcpro4.nvars = (count + 1);

Richard M. Stallman's avatar
Richard M. Stallman committed
507 508 509
  if (!NILP (enable))
    specbind (Qenable_recursive_minibuffers, Qt);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
510
  tem = string;
511
  for (i = 1; *tem; i++)
Michael I. Bushnell's avatar
Michael I. Bushnell committed
512 513 514
    {
      strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
      prompt1[sizeof prompt1 - 1] = 0;
515
      tem1 = (char *) index (prompt1, '\n');
Michael I. Bushnell's avatar
Michael I. Bushnell committed
516
      if (tem1) *tem1 = 0;
517 518 519 520 521 522

      visargs[0] = build_string (prompt1);
      if (index (prompt1, '%'))
	callint_message = Fformat (i, visargs);
      else
	callint_message = visargs[0];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
523 524 525 526

      switch (*tem)
	{
	case 'a':		/* Symbol defined as a function */
527
	  visargs[i] = Fcompleting_read (callint_message,
528
					 Vobarray, Qfboundp, Qt,
529
					 Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
530 531 532 533 534 535 536 537
	  /* 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))
538
	    args[i] = Fother_buffer (args[i], Qnil, Qnil);
539
	  args[i] = Fread_buffer (callint_message, args[i], Qt);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
540 541 542
	  break;

	case 'B':		/* Name of buffer, possibly nonexistent */
543
	  args[i] = Fread_buffer (callint_message,
544
				  Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
545
				  Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
546 547 548
	  break;

        case 'c':		/* Character */
549
	  args[i] = Fread_char (callint_message, Qnil, Qnil);
550
	  message1_nolog ((char *) 0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
551 552 553 554 555 556
	  /* Passing args[i] directly stimulates compiler bug */
	  teml = args[i];
	  visargs[i] = Fchar_to_string (teml);
	  break;

	case 'C':		/* Command: symbol with interactive function */
557
	  visargs[i] = Fcompleting_read (callint_message,
558
					 Vobarray, Qcommandp,
559
					 Qt, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
560 561 562 563 564 565
	  /* 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.  */
566
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
567
	  args[i] = point_marker;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
568 569 570 571 572
	  /* visargs[i] = Qnil; */
	  varies[i] = 1;
	  break;

	case 'D':		/* Directory name. */
573
	  args[i] = Fread_file_name (callint_message, Qnil,
574 575
				     current_buffer->directory, Qlambda, Qnil,
				     Qfile_directory_p);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
576 577 578
	  break;

	case 'f':		/* Existing file name. */
579
	  args[i] = Fread_file_name (callint_message,
580
				     Qnil, Qnil, Qlambda, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
581 582 583
	  break;

	case 'F':		/* Possibly nonexistent file name. */
584
	  args[i] = Fread_file_name (callint_message,
585
				     Qnil, Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
586 587
	  break;

588 589
	case 'G':		/* Possibly nonexistent file name,
				   default to directory alone. */
590
	  args[i] = Fread_file_name (callint_message,
591
				     Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
592 593
	  break;

594 595 596 597
	case 'i':		/* Ignore an argument -- Does not do I/O */
	  varies[i] = -1;
	  break;

598
	case 'k':		/* Key sequence. */
599
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
600
	    int speccount1 = SPECPDL_INDEX ();
601
	    specbind (Qcursor_in_echo_area, Qt);
602
	    args[i] = Fread_key_sequence (callint_message,
603
					  Qnil, Qnil, Qnil, Qnil);
604 605
	    unbind_to (speccount1, Qnil);
	    teml = args[i];
606
	    visargs[i] = Fkey_description (teml, Qnil);
607 608 609 610 611

	    /* 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))
612
	      teml = XCAR (teml);
613 614 615 616 617
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
618 619
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
620
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
621
		  up_event = Fread_event (Qnil, Qnil, Qnil);
622
	      }
623
	  }
624 625 626
	  break;

	case 'K':		/* Key sequence to be defined. */
627
	  {
Juanma Barranquero's avatar
Juanma Barranquero committed
628
	    int speccount1 = SPECPDL_INDEX ();
629
	    specbind (Qcursor_in_echo_area, Qt);
630
	    args[i] = Fread_key_sequence (callint_message,
631
					  Qnil, Qt, Qnil, Qnil);
632
	    teml = args[i];
633
	    visargs[i] = Fkey_description (teml, Qnil);
634
	    unbind_to (speccount1, Qnil);
635 636 637 638 639

	    /* 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))
640
	      teml = XCAR (teml);
641 642 643 644 645
	    if (SYMBOLP (teml))
	      {
		Lisp_Object tem2;

		teml = Fget (teml, intern ("event-symbol-elements"));
646 647
		/* Ignore first element, which is the base key.  */
		tem2 = Fmemq (intern ("down"), Fcdr (teml));
648
		if (! NILP (tem2))
Chong Yidong's avatar
Chong Yidong committed
649
		  up_event = Fread_event (Qnil, Qnil, Qnil);
650
	      }
651
	  }
Michael I. Bushnell's avatar
Michael I. Bushnell committed
652 653
	  break;

654 655 656 657 658 659 660 661 662 663
	case 'U':		/* Up event from last k or K */
	  if (!NILP (up_event))
	    {
	      args[i] = Fmake_vector (make_number (1), up_event);
	      up_event = Qnil;
	      teml = args[i];
	      visargs[i] = Fkey_description (teml, Qnil);
	    }
	  break;

664
	case 'e':		/* The invoking event.  */
665
	  if (next_event >= key_count)
666
	    error ("%s must be bound to an event with parameters",
667
		   (SYMBOLP (function)
668
		    ? (char *) SDATA (SYMBOL_NAME (function))
669
		    : "command"));
670
	  args[i] = XVECTOR (keys)->contents[next_event++];
Jim Blandy's avatar
Jim Blandy committed
671
	  varies[i] = -1;
Jim Blandy's avatar
Jim Blandy committed
672 673

	  /* Find the next parameterized event.  */
674
	  while (next_event < key_count
Jim Blandy's avatar
Jim Blandy committed
675
		 && ! (EVENT_HAS_PARAMETERS
676
		       (XVECTOR (keys)->contents[next_event])))
Jim Blandy's avatar
Jim Blandy committed
677 678
	    next_event++;

Jim Blandy's avatar
Jim Blandy committed
679 680
	  break;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
681
	case 'm':		/* Value of mark.  Does not do I/O.  */
682
	  check_mark (0);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
683
	  /* visargs[i] = Qnil; */
684
	  args[i] = current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
685 686 687
	  varies[i] = 2;
	  break;

688 689
	case 'M':		/* String read via minibuffer with
				   inheriting the current input method.  */
690
	  args[i] = Fread_string (callint_message,
691 692 693
				  Qnil, Qnil, Qnil, Qt);
	  break;

Richard M. Stallman's avatar
Richard M. Stallman committed
694
	case 'N':		/* Prefix arg as number, else number from minibuffer */
Jim Blandy's avatar
Jim Blandy committed
695
	  if (!NILP (prefix_arg))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
696 697
	    goto have_prefix_arg;
	case 'n':		/* Read number from minibuffer.  */
698 699 700 701 702
	  {
	    int first = 1;
	    do
	      {
		Lisp_Object tem;
703
		if (! first)
704 705
		  {
		    message ("Please enter a number.");
706
		    sit_for (make_number (1), 0, 0);
707 708 709
		  }
		first = 0;

710
		tem = Fread_from_minibuffer (callint_message,
711
					     Qnil, Qnil, Qnil, Qnil, Qnil,
712
					     Qnil);
713
		if (! STRINGP (tem) || SCHARS (tem) == 0)
714 715 716 717 718 719
		  args[i] = Qnil;
		else
		  args[i] = Fread (tem);
	      }
	    while (! NUMBERP (args[i]));
	  }
720
	  visargs[i] = args[i];
Michael I. Bushnell's avatar
Michael I. Bushnell committed
721 722 723 724 725 726 727 728 729
	  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. */
730
	have_prefix_arg:
Michael I. Bushnell's avatar
Michael I. Bushnell committed
731 732 733 734 735 736
	  args[i] = Fprefix_numeric_value (prefix_arg);
	  /* visargs[i] = Qnil; */
	  varies[i] = -1;
	  break;

	case 'r':		/* Region, point and mark as 2 args. */
737
	  check_mark (1);
738
	  set_marker_both (point_marker, Qnil, PT, PT_BYTE);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
739 740 741
	  /* visargs[i+1] = Qnil; */
	  foo = marker_position (current_buffer->mark);
	  /* visargs[i] = Qnil; */
742
	  args[i] = PT < foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
743
	  varies[i] = 3;
744
	  args[++i] = PT > foo ? point_marker : current_buffer->mark;
Michael I. Bushnell's avatar
Michael I. Bushnell committed
745 746 747
	  varies[i] = 4;
	  break;

748 749
	case 's':		/* String read via minibuffer without
				   inheriting the current input method.  */
750
	  args[i] = Fread_string (callint_message,
751
				  Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
752 753 754
	  break;

	case 'S':		/* Any symbol.  */
755
	  visargs[i] = Fread_string (callint_message,
756
				     Qnil, Qnil, Qnil, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
757 758 759 760 761 762 763
	  /* 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. */
764
	  args[i] = Fread_variable (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
765 766 767 768
	  visargs[i] = last_minibuf_string;
	  break;

	case 'x':		/* Lisp expression read but not evaluated */
769
	  args[i] = Fread_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
770 771 772 773
	  visargs[i] = last_minibuf_string;
	  break;

	case 'X':		/* Lisp expression read and evaluated */
774
	  args[i] = Feval_minibuffer (callint_message, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
775 776 777
	  visargs[i] = last_minibuf_string;
 	  break;

778 779 780 781 782 783 784
	case 'Z':		/* Coding-system symbol, or ignore the
				   argument if no prefix */
	  if (NILP (prefix_arg))
	    {
	      args[i] = Qnil;
	      varies[i] = -1;
	    }
785
	  else
786 787
	    {
	      args[i]
788
		= Fread_non_nil_coding_system (callint_message);
789 790 791 792 793
	      visargs[i] = last_minibuf_string;
	    }
	  break;

	case 'z':		/* Coding-system symbol or nil */
794
	  args[i] = Fread_coding_system (callint_message, Qnil);
795 796 797
	  visargs[i] = last_minibuf_string;
	  break;

798 799 800
	  /* 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
801
	default:
802
	  error ("Invalid control letter `%c' (%03o) in interactive calling string",
Michael I. Bushnell's avatar
Michael I. Bushnell committed
803 804 805 806 807 808
		 *tem, *tem);
	}

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

809
      if (NILP (visargs[i]) && STRINGP (args[i]))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
810 811 812 813 814 815
	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
816
  unbind_to (speccount, Qnil);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
817 818 819 820 821

  QUIT;

  args[0] = function;

822
  if (arg_from_tty || !NILP (record_flag))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
823 824
    {
      visargs[0] = function;
Jim Blandy's avatar
Jim Blandy committed
825
      for (i = 1; i < count + 1; i++)
826 827 828 829 830 831
	{
	  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
832 833
      Vcommand_history = Fcons (Flist (count + 1, visargs),
				Vcommand_history);
834
      /* Don't keep command history around forever.  */
835
      if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
836 837 838
	{
	  teml = Fnthcdr (Vhistory_length, Vcommand_history);
	  if (CONSP (teml))
839
	    XSETCDR (teml, Qnil);
840
	}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
841 842
    }

843 844
  /* If we used a marker to hold point, mark, or an end of the region,
     temporarily, convert it to an integer now.  */
845
  for (i = 1; i <= count; i++)
846 847 848
    if (varies[i] >= 1 && varies[i] <= 4)
      XSETINT (args[i], marker_position (args[i]));

849 850 851
  if (record_then_fail)
    Fbarf_if_buffer_read_only ();

852 853 854 855 856
  Vthis_command = save_this_command;
  Vthis_original_command = save_this_original_command;
  real_this_command= save_real_this_command;
  current_kboard->Vlast_command = save_last_command;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
857 858 859 860
  {
    Lisp_Object val;
    specbind (Qcommand_debug_status, Qnil);

861
    temporarily_switch_to_single_kboard (NULL);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
862 863 864 865
    val = Ffuncall (count + 1, args);
    UNGCPRO;
    return unbind_to (speccount, val);
  }
866
}
Michael I. Bushnell's avatar
Michael I. Bushnell committed
867 868

DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
869 870 871 872 873
       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
874 875 876
     Lisp_Object raw;
{
  Lisp_Object val;
877

Jim Blandy's avatar
Jim Blandy committed
878
  if (NILP (raw))
879
    XSETFASTINT (val, 1);
880
  else if (EQ (raw, Qminus))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
881
    XSETINT (val, -1);
882 883
  else if (CONSP (raw) && INTEGERP (XCAR (raw)))
    XSETINT (val, XINT (XCAR (raw)));
884
  else if (INTEGERP (raw))
Michael I. Bushnell's avatar
Michael I. Bushnell committed
885 886
    val = raw;
  else
887
    XSETFASTINT (val, 1);
Michael I. Bushnell's avatar
Michael I. Bushnell committed
888 889 890 891

  return val;
}

Andreas Schwab's avatar
Andreas Schwab committed
892
void
Michael I. Bushnell's avatar
Michael I. Bushnell committed
893 894
syms_of_callint ()
{
895 896 897
  point_marker = Fmake_marker ();
  staticpro (&point_marker);

898 899 900
  callint_message = Qnil;
  staticpro (&callint_message);

901 902 903 904 905 906 907 908
  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);
909 910
  Qlet = intern ("let");
  staticpro (&Qlet);
911 912 913 914
  Qif = intern ("if");
  staticpro (&Qif);
  Qwhen = intern ("when");
  staticpro (&Qwhen);
915 916 917 918
  Qletx = intern ("let*");
  staticpro (&Qletx);
  Qsave_excursion = intern ("save-excursion");
  staticpro (&Qsave_excursion);
919 920
  Qprogn = intern ("progn");
  staticpro (&Qprogn);
921

Michael I. Bushnell's avatar
Michael I. Bushnell committed
922 923 924
  Qminus = intern ("-");
  staticpro (&Qminus);

Richard M. Stallman's avatar
Richard M. Stallman committed
925 926 927
  Qplus = intern ("+");
  staticpro (&Qplus);

Michael I. Bushnell's avatar
Michael I. Bushnell committed
928 929 930 931 932 933
  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
934 935 936
  Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
  staticpro (&Qenable_recursive_minibuffers);

937 938 939
  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);

940
  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
941 942 943 944 945 946 947 948 949
		 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").  */);
950

951
  DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
952 953
		 doc: /* The value of the prefix argument for the previous editing command.
See `prefix-arg' for the meaning of the value.  */);
954

955
  DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
956 957 958 959 960
	       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.  */);
961 962
  Vcurrent_prefix_arg = Qnil;

Michael I. Bushnell's avatar
Michael I. Bushnell committed
963
  DEFVAR_LISP ("command-history", &Vcommand_history,
964 965
	       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
966 967 968
  Vcommand_history = Qnil;

  DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
969 970 971
	       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
972 973
  Vcommand_debug_status = Qnil;

974
  DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
975 976 977 978 979
	       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.  */);
980 981
  Vmark_even_if_inactive = Qnil;

982
  DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
983 984 985
	       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.  */);
986 987
  Vmouse_leave_buffer_hook = Qnil;