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