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