(Finteractive_form): Declare.
[bpt/emacs.git] / src / callint.c
CommitLineData
ec28a64d 1/* Call a Lisp function interactively.
f1321dc3 2 Copyright (C) 1985, 86, 93, 94, 95, 1997, 2000, 02, 2003
4f895918 3 Free Software Foundation, Inc.
ec28a64d
MB
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
dbc4e1c1 9the Free Software Foundation; either version 2, or (at your option)
ec28a64d
MB
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
ec28a64d
MB
21
22
18160b98 23#include <config.h>
fdb82f93 24
ec28a64d
MB
25#include "lisp.h"
26#include "buffer.h"
27#include "commands.h"
760cbdd3 28#include "keyboard.h"
ec28a64d 29#include "window.h"
8feddab4 30#include "keymap.h"
ec28a64d 31
8892f40b
GM
32#ifdef HAVE_INDEX
33extern char *index P_ ((const char *, int));
a847af86 34#endif
ec28a64d 35
c631c234 36extern Lisp_Object Qcursor_in_echo_area;
93ed5f9d 37extern Lisp_Object Qfile_directory_p;
c631c234 38
1e0c5826 39Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
ec28a64d
MB
40Lisp_Object Qcall_interactively;
41Lisp_Object Vcommand_history;
42
225c2157 43extern Lisp_Object Vhistory_length;
0605dd79 44extern Lisp_Object Vthis_original_command, real_this_command;
225c2157 45
ec28a64d 46Lisp_Object Vcommand_debug_status, Qcommand_debug_status;
52614803 47Lisp_Object Qenable_recursive_minibuffers;
ec28a64d 48
9f315aeb
RS
49/* Non-nil means treat the mark as active
50 even if mark_active is 0. */
51Lisp_Object Vmark_even_if_inactive;
52
ef2515c0
RS
53Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;
54
120d0a23 55Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qprogn, Qif, Qwhen;
824977b6
RS
56static Lisp_Object preserved_fns;
57
58/* Marker used within call-interactively to refer to point. */
59static Lisp_Object point_marker;
03e130d5 60
df31bc64
RS
61/* Buffer for the prompt text used in Fcall_interactively. */
62static char *callint_message;
63
64/* Allocated length of that buffer. */
65static int callint_message_size;
1cf9cfc6 66
ec28a64d
MB
67/* ARGSUSED */
68DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
fdb82f93
PJ
69 doc: /* Specify a way of parsing arguments for interactive use of a function.
70For example, write
71 (defun foo (arg) "Doc string" (interactive "p") ...use arg...)
72to make ARG be the prefix argument when `foo' is called as a command.
73The "call" to `interactive' is actually a declaration rather than a function;
74 it tells `call-interactively' how to read arguments
75 to pass to the function.
76When actually called, `interactive' just returns nil.
77
78The argument of `interactive' is usually a string containing a code letter
79 followed by a prompt. (Some code letters do not use I/O to get
80 the argument and do not need prompts.) To prompt for multiple arguments,
81 give a code letter, its prompt, a newline, and another code letter, etc.
82 Prompts are passed to format, and may use % escapes to print the
83 arguments that have already been read.
84If the argument is not a string, it is evaluated to get a list of
85 arguments to pass to the function.
86Just `(interactive)' means pass no args when calling interactively.
87
88Code letters available are:
89a -- Function name: symbol with a function definition.
90b -- Name of existing buffer.
91B -- Name of buffer, possibly nonexistent.
92c -- Character (no input method is used).
93C -- Command name: symbol with interactive function definition.
94d -- Value of point as number. Does not do I/O.
95D -- Directory name.
96e -- Parametrized event (i.e., one that's a list) that invoked this command.
97 If used more than once, the Nth `e' returns the Nth parameterized event.
98 This skips events that are integers or symbols.
99f -- Existing file name.
100F -- Possibly nonexistent file name.
101i -- Ignored, i.e. always nil. Does not do I/O.
102k -- Key sequence (downcase the last event if needed to get a definition).
103K -- Key sequence to be redefined (do not downcase the last event).
104m -- Value of mark as number. Does not do I/O.
105M -- Any string. Inherits the current input method.
106n -- Number read using minibuffer.
107N -- Raw prefix arg, or if none, do like code `n'.
108p -- Prefix arg converted to number. Does not do I/O.
109P -- Prefix arg in raw form. Does not do I/O.
110r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O.
111s -- Any string. Does not inherit the current input method.
112S -- Any symbol.
113v -- Variable name: symbol that is user-variable-p.
114x -- Lisp expression read but not evaluated.
115X -- Lisp expression read and evaluated.
116z -- Coding system.
117Z -- Coding system, nil if no prefix arg.
118In addition, if the string begins with `*'
119 then an error is signaled if the buffer is read-only.
120 This happens before reading any arguments.
121If the string begins with `@', then Emacs searches the key sequence
122 which invoked the command for its first mouse click (or any other
123 event which specifies a window), and selects that window before
124 reading any arguments. You may use both `@' and `*'; they are
84cc45a7
PJ
125 processed in the order that they appear.
126usage: (interactive ARGS) */)
fdb82f93 127 (args)
ec28a64d
MB
128 Lisp_Object args;
129{
130 return Qnil;
131}
132
133/* Quotify EXP: if EXP is constant, return it.
134 If EXP is not constant, return (quote EXP). */
135Lisp_Object
136quotify_arg (exp)
137 register Lisp_Object exp;
138{
6e54b3de 139 if (!INTEGERP (exp) && !STRINGP (exp)
265a9e55 140 && !NILP (exp) && !EQ (exp, Qt))
ec28a64d
MB
141 return Fcons (Qquote, Fcons (exp, Qnil));
142
143 return exp;
144}
145
146/* Modify EXP by quotifying each element (except the first). */
147Lisp_Object
148quotify_args (exp)
149 Lisp_Object exp;
150{
151 register Lisp_Object tail;
7539e11f
KR
152 Lisp_Object next;
153 for (tail = exp; CONSP (tail); tail = next)
ec28a64d 154 {
7539e11f 155 next = XCDR (tail);
f3fbd155 156 XSETCAR (tail, quotify_arg (XCAR (tail)));
ec28a64d
MB
157 }
158 return exp;
159}
160
161char *callint_argfuns[]
162 = {"", "point", "mark", "region-beginning", "region-end"};
163
164static void
f203cf07
RS
165check_mark (for_region)
166 int for_region;
ec28a64d 167{
86c1cf23
KH
168 Lisp_Object tem;
169 tem = Fmarker_buffer (current_buffer->mark);
265a9e55 170 if (NILP (tem) || (XBUFFER (tem) != current_buffer))
f203cf07
RS
171 error (for_region ? "The mark is not set now, so there is no region"
172 : "The mark is not set now");
6497d2d8
RM
173 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
174 && NILP (current_buffer->mark_active))
175 Fsignal (Qmark_inactive, Qnil);
ec28a64d
MB
176}
177
64ea14d3
RS
178/* If the list of args INPUT was produced with an explicit call to
179 `list', look for elements that were computed with
180 (region-beginning) or (region-end), and put those expressions into
181 VALUES instead of the present values.
182
183 This function doesn't return a value because it modifies elements
184 of VALUES to do its job. */
185
d1135afc
JB
186static void
187fix_command (input, values)
188 Lisp_Object input, values;
189{
d1135afc
JB
190 if (CONSP (input))
191 {
192 Lisp_Object car;
193
194 car = XCAR (input);
195 /* Skip through certain special forms. */
196 while (EQ (car, Qlet) || EQ (car, Qletx)
197 || EQ (car, Qsave_excursion)
198 || EQ (car, Qprogn))
199 {
200 while (CONSP (XCDR (input)))
201 input = XCDR (input);
202 input = XCAR (input);
203 if (!CONSP (input))
204 break;
205 car = XCAR (input);
206 }
207 if (EQ (car, Qlist))
208 {
209 Lisp_Object intail, valtail;
210 for (intail = Fcdr (input), valtail = values;
211 CONSP (valtail);
212 intail = Fcdr (intail), valtail = Fcdr (valtail))
213 {
214 Lisp_Object elt;
215 elt = Fcar (intail);
216 if (CONSP (elt))
217 {
218 Lisp_Object presflag, carelt;
219 carelt = Fcar (elt);
220 /* If it is (if X Y), look at Y. */
221 if (EQ (carelt, Qif)
222 && EQ (Fnthcdr (make_number (3), elt), Qnil))
223 elt = Fnth (make_number (2), elt);
224 /* If it is (when ... Y), look at Y. */
225 else if (EQ (carelt, Qwhen))
226 {
227 while (CONSP (XCDR (elt)))
228 elt = XCDR (elt);
229 elt = Fcar (elt);
230 }
231
232 /* If the function call we're looking at
233 is a special preserved one, copy the
234 whole expression for this argument. */
235 if (CONSP (elt))
236 {
237 presflag = Fmemq (Fcar (elt), preserved_fns);
238 if (!NILP (presflag))
239 Fsetcar (valtail, Fcar (intail));
240 }
241 }
242 }
243 }
244 }
245}
ec28a64d 246
d455db8e 247DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
fdb82f93
PJ
248 doc: /* Call FUNCTION, reading args according to its interactive calling specs.
249Return the value FUNCTION returns.
250The function contains a specification of how to do the argument reading.
251In the case of user-defined functions, this is specified by placing a call
252to the function `interactive' at the top level of the function body.
253See `interactive'.
254
255Optional second arg RECORD-FLAG non-nil
256means unconditionally put this command in the command-history.
257Otherwise, this is done only if an arg is read using the minibuffer.
258Optional third arg KEYS, if given, specifies the sequence of events to
259supply if the command inquires which events were used to invoke it. */)
260 (function, record_flag, keys)
7868a977 261 Lisp_Object function, record_flag, keys;
ec28a64d
MB
262{
263 Lisp_Object *args, *visargs;
264 unsigned char **argstrings;
265 Lisp_Object fun;
266 Lisp_Object funcar;
267 Lisp_Object specs;
079e479f 268 Lisp_Object filter_specs;
ec28a64d 269 Lisp_Object teml;
52614803 270 Lisp_Object enable;
aed13378 271 int speccount = SPECPDL_INDEX ();
ec28a64d 272
bc78232c
JB
273 /* The index of the next element of this_command_keys to examine for
274 the 'e' interactive code. */
dbc4e1c1 275 int next_event;
bc78232c 276
ec28a64d
MB
277 Lisp_Object prefix_arg;
278 unsigned char *string;
279 unsigned char *tem;
63007de2
JB
280
281 /* If varies[i] > 0, the i'th argument shouldn't just have its value
282 in this call quoted in the command history. It should be
283 recorded as a call to the function named callint_argfuns[varies[i]]. */
ec28a64d 284 int *varies;
63007de2 285
ec28a64d
MB
286 register int i, j;
287 int count, foo;
ec28a64d
MB
288 char prompt1[100];
289 char *tem1;
290 int arg_from_tty = 0;
291 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
d455db8e 292 int key_count;
09c886dc 293 int record_then_fail = 0;
d455db8e 294
0605dd79
RS
295 Lisp_Object save_this_command, save_last_command;
296 Lisp_Object save_this_original_command, save_real_this_command;
297
298 save_this_command = Vthis_command;
299 save_this_original_command = Vthis_original_command;
300 save_real_this_command = real_this_command;
301 save_last_command = current_kboard->Vlast_command;
302
d455db8e
RS
303 if (NILP (keys))
304 keys = this_command_keys, key_count = this_command_key_count;
305 else
306 {
b7826503 307 CHECK_VECTOR (keys);
d455db8e
RS
308 key_count = XVECTOR (keys)->size;
309 }
ec28a64d 310
e5d77022 311 /* Save this now, since use of minibuffer will clobber it. */
8c917bf2 312 prefix_arg = Vcurrent_prefix_arg;
ec28a64d 313
46947372 314 retry:
ec28a64d 315
6e54b3de 316 if (SYMBOLP (function))
afa4c0f3 317 enable = Fget (function, Qenable_recursive_minibuffers);
4f895918
GM
318 else
319 enable = Qnil;
52614803 320
ffd56f97 321 fun = indirect_function (function);
ec28a64d
MB
322
323 specs = Qnil;
324 string = 0;
079e479f
RS
325 /* The idea of FILTER_SPECS is to provide away to
326 specify how to represent the arguments in command history.
327 The feature is not fully implemented. */
328 filter_specs = Qnil;
ec28a64d
MB
329
330 /* Decode the kind of function. Either handle it and return,
331 or go to `lose' if not interactive, or go to `retry'
332 to specify a different function, or set either STRING or SPECS. */
333
6e54b3de 334 if (SUBRP (fun))
ec28a64d
MB
335 {
336 string = (unsigned char *) XSUBR (fun)->prompt;
337 if (!string)
338 {
339 lose:
b37902c8 340 function = wrong_type_argument (Qcommandp, function);
ec28a64d
MB
341 goto retry;
342 }
ec28a64d 343 }
6e54b3de 344 else if (COMPILEDP (fun))
ec28a64d 345 {
f9b4aacf 346 if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_INTERACTIVE)
ec28a64d
MB
347 goto lose;
348 specs = XVECTOR (fun)->contents[COMPILED_INTERACTIVE];
349 }
350 else if (!CONSP (fun))
351 goto lose;
01e85d61 352 else if (funcar = XCAR (fun), EQ (funcar, Qautoload))
ec28a64d
MB
353 {
354 GCPRO2 (function, prefix_arg);
355 do_autoload (fun, function);
356 UNGCPRO;
357 goto retry;
358 }
359 else if (EQ (funcar, Qlambda))
360 {
01e85d61 361 specs = Fassq (Qinteractive, Fcdr (XCDR (fun)));
265a9e55 362 if (NILP (specs))
ec28a64d 363 goto lose;
079e479f 364 filter_specs = Fnth (make_number (1), specs);
ec28a64d
MB
365 specs = Fcar (Fcdr (specs));
366 }
ec28a64d
MB
367 else
368 goto lose;
369
09c886dc 370 /* If either SPECS or STRING is set to a string, use it. */
6e54b3de 371 if (STRINGP (specs))
46947372
JB
372 {
373 /* Make a copy of string so that if a GC relocates specs,
374 `string' will still be valid. */
d5db4077
KR
375 string = (unsigned char *) alloca (SBYTES (specs) + 1);
376 bcopy (SDATA (specs), string,
377 SBYTES (specs) + 1);
46947372 378 }
ec28a64d
MB
379 else if (string == 0)
380 {
03e130d5 381 Lisp_Object input;
91a6ba78 382 i = num_input_events;
03e130d5
RS
383 input = specs;
384 /* Compute the arg values using the user's expression. */
079e479f 385 GCPRO2 (input, filter_specs);
6bc1abf2 386 specs = Feval (specs);
079e479f 387 UNGCPRO;
91a6ba78 388 if (i != num_input_events || !NILP (record_flag))
03e130d5
RS
389 {
390 /* We should record this command on the command history. */
f1321dc3 391 Lisp_Object values;
03e130d5
RS
392 /* Make a copy of the list of values, for the command history,
393 and turn them into things we can eval. */
394 values = quotify_args (Fcopy_sequence (specs));
120d0a23 395 fix_command (input, values);
03e130d5
RS
396 Vcommand_history
397 = Fcons (Fcons (function, values), Vcommand_history);
225c2157
RS
398
399 /* Don't keep command history around forever. */
b9f0b172 400 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
225c2157
RS
401 {
402 teml = Fnthcdr (Vhistory_length, Vcommand_history);
403 if (CONSP (teml))
f3fbd155 404 XSETCDR (teml, Qnil);
225c2157 405 }
03e130d5 406 }
0605dd79
RS
407
408 Vthis_command = save_this_command;
409 Vthis_original_command = save_this_original_command;
410 real_this_command= save_real_this_command;
411 current_kboard->Vlast_command = save_last_command;
412
652e2240 413 single_kboard_state ();
ec28a64d
MB
414 return apply1 (function, specs);
415 }
416
417 /* Here if function specifies a string to control parsing the defaults */
418
dbc4e1c1 419 /* Set next_event to point to the first event with parameters. */
d455db8e
RS
420 for (next_event = 0; next_event < key_count; next_event++)
421 if (EVENT_HAS_PARAMETERS (XVECTOR (keys)->contents[next_event]))
dbc4e1c1 422 break;
09c886dc 423
42bb2790 424 /* Handle special starting chars `*' and `@'. Also `-'. */
e92d107b 425 /* Note that `+' is reserved for user extensions. */
ec28a64d
MB
426 while (1)
427 {
fb775602 428 if (*string == '+')
e92d107b
RS
429 error ("`+' is not used in `interactive' for ordinary commands");
430 else if (*string == '*')
ec28a64d
MB
431 {
432 string++;
265a9e55 433 if (!NILP (current_buffer->read_only))
09c886dc
RS
434 {
435 if (!NILP (record_flag))
436 {
437 unsigned char *p = string;
438 while (*p)
439 {
440 if (! (*p == 'r' || *p == 'p' || *p == 'P'
441 || *p == '\n'))
442 Fbarf_if_buffer_read_only ();
443 p++;
444 }
445 record_then_fail = 1;
446 }
447 else
448 Fbarf_if_buffer_read_only ();
449 }
ec28a64d 450 }
42bb2790
RS
451 /* Ignore this for semi-compatibility with Lucid. */
452 else if (*string == '-')
453 string++;
ec28a64d
MB
454 else if (*string == '@')
455 {
86c1cf23 456 Lisp_Object event;
dbc4e1c1 457
170d3006
AS
458 event = (next_event < key_count
459 ? XVECTOR (keys)->contents[next_event]
460 : Qnil);
dbc4e1c1 461 if (EVENT_HAS_PARAMETERS (event)
70949dac
KR
462 && (event = XCDR (event), CONSP (event))
463 && (event = XCAR (event), CONSP (event))
464 && (event = XCAR (event), WINDOWP (event)))
d1fa2e8a 465 {
d68807fc 466 if (MINI_WINDOW_P (XWINDOW (event))
42bb2790 467 && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
d1fa2e8a 468 error ("Attempt to select inactive minibuffer window");
ef2515c0
RS
469
470 /* If the current buffer wants to clean up, let it. */
471 if (!NILP (Vmouse_leave_buffer_hook))
472 call1 (Vrun_hooks, Qmouse_leave_buffer_hook);
473
f1321dc3 474 Fselect_window (event, Qnil);
d1fa2e8a 475 }
ec28a64d 476 string++;
ec28a64d
MB
477 }
478 else break;
479 }
480
481 /* Count the number of arguments the interactive spec would have
482 us give to the function. */
483 tem = string;
484 for (j = 0; *tem; j++)
485 {
486 /* 'r' specifications ("point and mark as 2 numeric args")
487 produce *two* arguments. */
488 if (*tem == 'r') j++;
489 tem = (unsigned char *) index (tem, '\n');
490 if (tem)
491 tem++;
492 else
493 tem = (unsigned char *) "";
494 }
6bc1abf2 495 count = j;
ec28a64d
MB
496
497 args = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
498 visargs = (Lisp_Object *) alloca ((count + 1) * sizeof (Lisp_Object));
499 argstrings = (unsigned char **) alloca ((count + 1) * sizeof (char *));
500 varies = (int *) alloca ((count + 1) * sizeof (int));
501
502 for (i = 0; i < (count + 1); i++)
503 {
504 args[i] = Qnil;
505 visargs[i] = Qnil;
506 varies[i] = 0;
507 }
508
509 GCPRO4 (prefix_arg, function, *args, *visargs);
510 gcpro3.nvars = (count + 1);
511 gcpro4.nvars = (count + 1);
512
52614803
RS
513 if (!NILP (enable))
514 specbind (Qenable_recursive_minibuffers, Qt);
515
ec28a64d 516 tem = string;
6bc1abf2 517 for (i = 1; *tem; i++)
ec28a64d
MB
518 {
519 strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
520 prompt1[sizeof prompt1 - 1] = 0;
a847af86 521 tem1 = (char *) index (prompt1, '\n');
ec28a64d
MB
522 if (tem1) *tem1 = 0;
523 /* Fill argstrings with a vector of C strings
524 corresponding to the Lisp strings in visargs. */
525 for (j = 1; j < i; j++)
526 argstrings[j]
dc330139
RS
527 = (EQ (visargs[j], Qnil)
528 ? (unsigned char *) ""
d5db4077 529 : SDATA (visargs[j]));
ec28a64d 530
df31bc64
RS
531 /* Process the format-string in prompt1, putting the output
532 into callint_message. Make callint_message bigger if necessary.
533 We don't use a buffer on the stack, because the contents
534 need to stay stable for a while. */
535 while (1)
536 {
537 int nchars = doprnt (callint_message, callint_message_size,
538 prompt1, (char *)0,
dc330139 539 j - 1, (char **) argstrings + 1);
c2b736ca 540 if (nchars < callint_message_size - 1)
df31bc64
RS
541 break;
542 callint_message_size *= 2;
543 callint_message
544 = (char *) xrealloc (callint_message, callint_message_size);
545 }
ec28a64d
MB
546
547 switch (*tem)
548 {
549 case 'a': /* Symbol defined as a function */
df31bc64 550 visargs[i] = Fcompleting_read (build_string (callint_message),
ff9cd111 551 Vobarray, Qfboundp, Qt,
93fb51ae 552 Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
553 /* Passing args[i] directly stimulates compiler bug */
554 teml = visargs[i];
555 args[i] = Fintern (teml, Qnil);
556 break;
557
558 case 'b': /* Name of existing buffer */
559 args[i] = Fcurrent_buffer ();
560 if (EQ (selected_window, minibuf_window))
34c5d0ed 561 args[i] = Fother_buffer (args[i], Qnil, Qnil);
df31bc64 562 args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
ec28a64d
MB
563 break;
564
565 case 'B': /* Name of buffer, possibly nonexistent */
df31bc64 566 args[i] = Fread_buffer (build_string (callint_message),
34c5d0ed 567 Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
9262fcb6 568 Qnil);
ec28a64d
MB
569 break;
570
571 case 'c': /* Character */
562e4a4f 572 args[i] = Fread_char (build_string (callint_message), Qnil);
453ed650 573 message1_nolog ((char *) 0);
ec28a64d
MB
574 /* Passing args[i] directly stimulates compiler bug */
575 teml = args[i];
576 visargs[i] = Fchar_to_string (teml);
577 break;
578
579 case 'C': /* Command: symbol with interactive function */
df31bc64 580 visargs[i] = Fcompleting_read (build_string (callint_message),
ff9cd111 581 Vobarray, Qcommandp,
93fb51ae 582 Qt, Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
583 /* Passing args[i] directly stimulates compiler bug */
584 teml = visargs[i];
585 args[i] = Fintern (teml, Qnil);
586 break;
587
588 case 'd': /* Value of point. Does not do I/O. */
dc330139 589 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
824977b6 590 args[i] = point_marker;
ec28a64d
MB
591 /* visargs[i] = Qnil; */
592 varies[i] = 1;
593 break;
594
ec28a64d 595 case 'D': /* Directory name. */
df31bc64 596 args[i] = Fread_file_name (build_string (callint_message), Qnil,
93ed5f9d
KS
597 current_buffer->directory, Qlambda, Qnil,
598 Qfile_directory_p);
ec28a64d
MB
599 break;
600
601 case 'f': /* Existing file name. */
df31bc64 602 args[i] = Fread_file_name (build_string (callint_message),
93ed5f9d 603 Qnil, Qnil, Qlambda, Qnil, Qnil);
ec28a64d
MB
604 break;
605
606 case 'F': /* Possibly nonexistent file name. */
df31bc64 607 args[i] = Fread_file_name (build_string (callint_message),
93ed5f9d 608 Qnil, Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
609 break;
610
40b2421c
KH
611 case 'i': /* Ignore an argument -- Does not do I/O */
612 varies[i] = -1;
613 break;
614
1989e7bc 615 case 'k': /* Key sequence. */
c631c234 616 {
aed13378 617 int speccount1 = SPECPDL_INDEX ();
c631c234
RS
618 specbind (Qcursor_in_echo_area, Qt);
619 args[i] = Fread_key_sequence (build_string (callint_message),
ad4ac475 620 Qnil, Qnil, Qnil, Qnil);
c631c234
RS
621 unbind_to (speccount1, Qnil);
622 teml = args[i];
623 visargs[i] = Fkey_description (teml);
cdfac812
RS
624
625 /* If the key sequence ends with a down-event,
626 discard the following up-event. */
627 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
628 if (CONSP (teml))
70949dac 629 teml = XCAR (teml);
cdfac812
RS
630 if (SYMBOLP (teml))
631 {
632 Lisp_Object tem2;
633
634 teml = Fget (teml, intern ("event-symbol-elements"));
4b27f17c
AS
635 /* Ignore first element, which is the base key. */
636 tem2 = Fmemq (intern ("down"), Fcdr (teml));
cdfac812 637 if (! NILP (tem2))
7a983715 638 Fread_event (Qnil, Qnil);
cdfac812 639 }
c631c234 640 }
1989e7bc
RS
641 break;
642
643 case 'K': /* Key sequence to be defined. */
c631c234 644 {
aed13378 645 int speccount1 = SPECPDL_INDEX ();
c631c234
RS
646 specbind (Qcursor_in_echo_area, Qt);
647 args[i] = Fread_key_sequence (build_string (callint_message),
ad4ac475 648 Qnil, Qt, Qnil, Qnil);
c631c234
RS
649 teml = args[i];
650 visargs[i] = Fkey_description (teml);
651 unbind_to (speccount1, Qnil);
cdfac812
RS
652
653 /* If the key sequence ends with a down-event,
654 discard the following up-event. */
655 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
656 if (CONSP (teml))
70949dac 657 teml = XCAR (teml);
cdfac812
RS
658 if (SYMBOLP (teml))
659 {
660 Lisp_Object tem2;
661
662 teml = Fget (teml, intern ("event-symbol-elements"));
4b27f17c
AS
663 /* Ignore first element, which is the base key. */
664 tem2 = Fmemq (intern ("down"), Fcdr (teml));
cdfac812 665 if (! NILP (tem2))
7a983715 666 Fread_event (Qnil, Qnil);
cdfac812 667 }
c631c234 668 }
ec28a64d
MB
669 break;
670
bc78232c 671 case 'e': /* The invoking event. */
d455db8e 672 if (next_event >= key_count)
bc78232c 673 error ("%s must be bound to an event with parameters",
6e54b3de 674 (SYMBOLP (function)
d5db4077 675 ? (char *) SDATA (SYMBOL_NAME (function))
bc78232c 676 : "command"));
d455db8e 677 args[i] = XVECTOR (keys)->contents[next_event++];
e5d77022 678 varies[i] = -1;
dbc4e1c1
JB
679
680 /* Find the next parameterized event. */
d455db8e 681 while (next_event < key_count
dbc4e1c1 682 && ! (EVENT_HAS_PARAMETERS
d455db8e 683 (XVECTOR (keys)->contents[next_event])))
dbc4e1c1
JB
684 next_event++;
685
63007de2
JB
686 break;
687
ec28a64d 688 case 'm': /* Value of mark. Does not do I/O. */
f203cf07 689 check_mark (0);
ec28a64d 690 /* visargs[i] = Qnil; */
824977b6 691 args[i] = current_buffer->mark;
ec28a64d
MB
692 varies[i] = 2;
693 break;
694
93fb51ae
KH
695 case 'M': /* String read via minibuffer with
696 inheriting the current input method. */
697 args[i] = Fread_string (build_string (callint_message),
698 Qnil, Qnil, Qnil, Qt);
699 break;
700
ec28a64d 701 case 'N': /* Prefix arg, else number from minibuffer */
265a9e55 702 if (!NILP (prefix_arg))
ec28a64d
MB
703 goto have_prefix_arg;
704 case 'n': /* Read number from minibuffer. */
f0490a0b
RS
705 {
706 int first = 1;
707 do
708 {
709 Lisp_Object tem;
710 if (! first)
711 {
712 message ("Please enter a number.");
56fe6fc0 713 sit_for (1, 0, 0, 0, 0);
f0490a0b
RS
714 }
715 first = 0;
716
717 tem = Fread_from_minibuffer (build_string (callint_message),
93fb51ae
KH
718 Qnil, Qnil, Qnil, Qnil, Qnil,
719 Qnil);
d5db4077 720 if (! STRINGP (tem) || SCHARS (tem) == 0)
f0490a0b
RS
721 args[i] = Qnil;
722 else
723 args[i] = Fread (tem);
724 }
725 while (! NUMBERP (args[i]));
726 }
ec28a64d
MB
727 visargs[i] = last_minibuf_string;
728 break;
729
730 case 'P': /* Prefix arg in raw form. Does no I/O. */
ec28a64d
MB
731 args[i] = prefix_arg;
732 /* visargs[i] = Qnil; */
733 varies[i] = -1;
734 break;
735
736 case 'p': /* Prefix arg converted to number. No I/O. */
71eda2d5 737 have_prefix_arg:
ec28a64d
MB
738 args[i] = Fprefix_numeric_value (prefix_arg);
739 /* visargs[i] = Qnil; */
740 varies[i] = -1;
741 break;
742
743 case 'r': /* Region, point and mark as 2 args. */
f203cf07 744 check_mark (1);
dc330139 745 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
ec28a64d
MB
746 /* visargs[i+1] = Qnil; */
747 foo = marker_position (current_buffer->mark);
748 /* visargs[i] = Qnil; */
6ec8bbd2 749 args[i] = PT < foo ? point_marker : current_buffer->mark;
ec28a64d 750 varies[i] = 3;
6ec8bbd2 751 args[++i] = PT > foo ? point_marker : current_buffer->mark;
ec28a64d
MB
752 varies[i] = 4;
753 break;
754
93fb51ae
KH
755 case 's': /* String read via minibuffer without
756 inheriting the current input method. */
55c4d99f 757 args[i] = Fread_string (build_string (callint_message),
93fb51ae 758 Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
759 break;
760
761 case 'S': /* Any symbol. */
df31bc64 762 visargs[i] = Fread_string (build_string (callint_message),
93fb51ae 763 Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
764 /* Passing args[i] directly stimulates compiler bug */
765 teml = visargs[i];
766 args[i] = Fintern (teml, Qnil);
767 break;
768
769 case 'v': /* Variable name: symbol that is
770 user-variable-p. */
ff9cd111 771 args[i] = Fread_variable (build_string (callint_message), Qnil);
ec28a64d
MB
772 visargs[i] = last_minibuf_string;
773 break;
774
775 case 'x': /* Lisp expression read but not evaluated */
df31bc64 776 args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
ec28a64d
MB
777 visargs[i] = last_minibuf_string;
778 break;
779
780 case 'X': /* Lisp expression read and evaluated */
df31bc64 781 args[i] = Feval_minibuffer (build_string (callint_message), Qnil);
ec28a64d
MB
782 visargs[i] = last_minibuf_string;
783 break;
784
40b2421c
KH
785 case 'Z': /* Coding-system symbol, or ignore the
786 argument if no prefix */
787 if (NILP (prefix_arg))
788 {
789 args[i] = Qnil;
790 varies[i] = -1;
791 }
177c0ea7 792 else
40b2421c
KH
793 {
794 args[i]
795 = Fread_non_nil_coding_system (build_string (callint_message));
796 visargs[i] = last_minibuf_string;
797 }
798 break;
799
800 case 'z': /* Coding-system symbol or nil */
024d8713 801 args[i] = Fread_coding_system (build_string (callint_message), Qnil);
40b2421c
KH
802 visargs[i] = last_minibuf_string;
803 break;
804
e92d107b
RS
805 /* We have a case for `+' so we get an error
806 if anyone tries to define one here. */
807 case '+':
ec28a64d 808 default:
e92d107b 809 error ("Invalid control letter `%c' (%03o) in interactive calling string",
ec28a64d
MB
810 *tem, *tem);
811 }
812
813 if (varies[i] == 0)
814 arg_from_tty = 1;
815
6e54b3de 816 if (NILP (visargs[i]) && STRINGP (args[i]))
ec28a64d
MB
817 visargs[i] = args[i];
818
819 tem = (unsigned char *) index (tem, '\n');
820 if (tem) tem++;
821 else tem = (unsigned char *) "";
822 }
52614803 823 unbind_to (speccount, Qnil);
ec28a64d
MB
824
825 QUIT;
826
827 args[0] = function;
828
7868a977 829 if (arg_from_tty || !NILP (record_flag))
ec28a64d
MB
830 {
831 visargs[0] = function;
63007de2 832 for (i = 1; i < count + 1; i++)
824977b6
RS
833 {
834 if (varies[i] > 0)
835 visargs[i] = Fcons (intern (callint_argfuns[varies[i]]), Qnil);
836 else
837 visargs[i] = quotify_arg (args[i]);
838 }
ec28a64d
MB
839 Vcommand_history = Fcons (Flist (count + 1, visargs),
840 Vcommand_history);
225c2157 841 /* Don't keep command history around forever. */
b9f0b172 842 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
225c2157
RS
843 {
844 teml = Fnthcdr (Vhistory_length, Vcommand_history);
845 if (CONSP (teml))
f3fbd155 846 XSETCDR (teml, Qnil);
225c2157 847 }
ec28a64d
MB
848 }
849
824977b6
RS
850 /* If we used a marker to hold point, mark, or an end of the region,
851 temporarily, convert it to an integer now. */
f4c8ded2 852 for (i = 1; i <= count; i++)
824977b6
RS
853 if (varies[i] >= 1 && varies[i] <= 4)
854 XSETINT (args[i], marker_position (args[i]));
855
09c886dc
RS
856 if (record_then_fail)
857 Fbarf_if_buffer_read_only ();
858
0605dd79
RS
859 Vthis_command = save_this_command;
860 Vthis_original_command = save_this_original_command;
861 real_this_command= save_real_this_command;
862 current_kboard->Vlast_command = save_last_command;
863
652e2240 864 single_kboard_state ();
ebfbe249 865
ec28a64d
MB
866 {
867 Lisp_Object val;
ec28a64d
MB
868 specbind (Qcommand_debug_status, Qnil);
869
870 val = Ffuncall (count + 1, args);
871 UNGCPRO;
872 return unbind_to (speccount, val);
873 }
177c0ea7 874}
ec28a64d
MB
875
876DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
fdb82f93
PJ
877 1, 1, 0,
878 doc: /* Return numeric meaning of raw prefix argument RAW.
879A raw prefix argument is what you get from `(interactive "P")'.
880Its numeric meaning is what you would get from `(interactive "p")'. */)
881 (raw)
ec28a64d
MB
882 Lisp_Object raw;
883{
884 Lisp_Object val;
177c0ea7 885
265a9e55 886 if (NILP (raw))
acab6442 887 XSETFASTINT (val, 1);
fd5285f3 888 else if (EQ (raw, Qminus))
ec28a64d 889 XSETINT (val, -1);
70949dac
KR
890 else if (CONSP (raw) && INTEGERP (XCAR (raw)))
891 XSETINT (val, XINT (XCAR (raw)));
6e54b3de 892 else if (INTEGERP (raw))
ec28a64d
MB
893 val = raw;
894 else
acab6442 895 XSETFASTINT (val, 1);
ec28a64d
MB
896
897 return val;
898}
899
dfcf069d 900void
ec28a64d
MB
901syms_of_callint ()
902{
824977b6
RS
903 point_marker = Fmake_marker ();
904 staticpro (&point_marker);
905
03e130d5
RS
906 preserved_fns = Fcons (intern ("region-beginning"),
907 Fcons (intern ("region-end"),
908 Fcons (intern ("point"),
909 Fcons (intern ("mark"), Qnil))));
910 staticpro (&preserved_fns);
911
912 Qlist = intern ("list");
913 staticpro (&Qlist);
8450690a
RS
914 Qlet = intern ("let");
915 staticpro (&Qlet);
120d0a23
RS
916 Qif = intern ("if");
917 staticpro (&Qif);
918 Qwhen = intern ("when");
919 staticpro (&Qwhen);
8450690a
RS
920 Qletx = intern ("let*");
921 staticpro (&Qletx);
922 Qsave_excursion = intern ("save-excursion");
923 staticpro (&Qsave_excursion);
079e479f
RS
924 Qprogn = intern ("progn");
925 staticpro (&Qprogn);
03e130d5 926
ec28a64d
MB
927 Qminus = intern ("-");
928 staticpro (&Qminus);
929
fdb4a38c
RS
930 Qplus = intern ("+");
931 staticpro (&Qplus);
932
ec28a64d
MB
933 Qcall_interactively = intern ("call-interactively");
934 staticpro (&Qcall_interactively);
935
936 Qcommand_debug_status = intern ("command-debug-status");
937 staticpro (&Qcommand_debug_status);
938
52614803
RS
939 Qenable_recursive_minibuffers = intern ("enable-recursive-minibuffers");
940 staticpro (&Qenable_recursive_minibuffers);
941
ef2515c0
RS
942 Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
943 staticpro (&Qmouse_leave_buffer_hook);
944
df31bc64
RS
945 callint_message_size = 100;
946 callint_message = (char *) xmalloc (callint_message_size);
947
948
1e0c5826 949 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
fdb82f93
PJ
950 doc: /* The value of the prefix argument for the next editing command.
951It may be a number, or the symbol `-' for just a minus sign as arg,
952or a list whose car is a number for just one or more C-u's
953or nil if no argument has been specified.
954
955You cannot examine this variable to find the argument for this command
956since it has been set to nil by the time you can look.
957Instead, you should use the variable `current-prefix-arg', although
958normally commands can get this prefix argument with (interactive "P"). */);
8c917bf2 959
fe3fbdcc 960 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
fdb82f93
PJ
961 doc: /* The value of the prefix argument for the previous editing command.
962See `prefix-arg' for the meaning of the value. */);
fe3fbdcc 963
8c917bf2 964 DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
fdb82f93
PJ
965 doc: /* The value of the prefix argument for this editing command.
966It may be a number, or the symbol `-' for just a minus sign as arg,
967or a list whose car is a number for just one or more C-u's
968or nil if no argument has been specified.
969This is what `(interactive \"P\")' returns. */);
8c917bf2
KH
970 Vcurrent_prefix_arg = Qnil;
971
ec28a64d 972 DEFVAR_LISP ("command-history", &Vcommand_history,
fdb82f93
PJ
973 doc: /* List of recent commands that read arguments from terminal.
974Each command is represented as a form to evaluate. */);
ec28a64d
MB
975 Vcommand_history = Qnil;
976
977 DEFVAR_LISP ("command-debug-status", &Vcommand_debug_status,
fdb82f93
PJ
978 doc: /* Debugging status of current interactive command.
979Bound each time `call-interactively' is called;
980may be set by the debugger as a reminder for itself. */);
ec28a64d
MB
981 Vcommand_debug_status = Qnil;
982
2ad6c959 983 DEFVAR_LISP ("mark-even-if-inactive", &Vmark_even_if_inactive,
fdb82f93
PJ
984 doc: /* *Non-nil means you can use the mark even when inactive.
985This option makes a difference in Transient Mark mode.
986When the option is non-nil, deactivation of the mark
987turns off region highlighting, but commands that use the mark
988behave as if the mark were still active. */);
9f315aeb
RS
989 Vmark_even_if_inactive = Qnil;
990
ef2515c0 991 DEFVAR_LISP ("mouse-leave-buffer-hook", &Vmouse_leave_buffer_hook,
fdb82f93
PJ
992 doc: /* Hook to run when about to switch windows with a mouse command.
993Its purpose is to give temporary modes such as Isearch mode
994a way to turn themselves off when a mouse command switches windows. */);
ef2515c0
RS
995 Vmouse_leave_buffer_hook = Qnil;
996
ec28a64d
MB
997 defsubr (&Sinteractive);
998 defsubr (&Scall_interactively);
999 defsubr (&Sprefix_numeric_value);
1000}
ab5796a9
MB
1001
1002/* arch-tag: a3a7cad7-bcac-42ce-916e-1bd2546ebf37
1003 (do not change this comment) */