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