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