* ccl.c (CCL_CODE_RANGE): Allow negative numbers. (Bug#8751)
[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.
81e -- Parametrized event (i.e., one that's a list) that invoked this command.
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.
108If the string begins with `@', Emacs searches the key sequence which
109 invoked the command for its first mouse click (or any other event
110 which specifies a window).
111If the string begins with `^' and `shift-select-mode' is non-nil,
2a4f8d3d 112 Emacs first calls the function `handle-shift-selection'.
9bdb1538
CY
113You may use `@', `*', and `^' together. They are processed in the
114 order that they appear, before reading any arguments.
d88bee5a 115usage: (interactive &optional ARGS) */)
5842a27b 116 (Lisp_Object args)
ec28a64d
MB
117{
118 return Qnil;
119}
120
121/* Quotify EXP: if EXP is constant, return it.
122 If EXP is not constant, return (quote EXP). */
b1349114 123static Lisp_Object
971de7fb 124quotify_arg (register Lisp_Object exp)
ec28a64d 125{
d032d5e7
SM
126 if (CONSP (exp)
127 || (SYMBOLP (exp)
128 && !NILP (exp) && !EQ (exp, Qt)))
ec28a64d
MB
129 return Fcons (Qquote, Fcons (exp, Qnil));
130
131 return exp;
132}
133
134/* Modify EXP by quotifying each element (except the first). */
b1349114 135static Lisp_Object
971de7fb 136quotify_args (Lisp_Object exp)
ec28a64d
MB
137{
138 register Lisp_Object tail;
7539e11f
KR
139 Lisp_Object next;
140 for (tail = exp; CONSP (tail); tail = next)
ec28a64d 141 {
7539e11f 142 next = XCDR (tail);
f3fbd155 143 XSETCAR (tail, quotify_arg (XCAR (tail)));
ec28a64d
MB
144 }
145 return exp;
146}
147
648801d1 148static const char *callint_argfuns[]
ec28a64d
MB
149 = {"", "point", "mark", "region-beginning", "region-end"};
150
151static void
971de7fb 152check_mark (int for_region)
ec28a64d 153{
86c1cf23 154 Lisp_Object tem;
4b4deea2 155 tem = Fmarker_buffer (BVAR (current_buffer, mark));
265a9e55 156 if (NILP (tem) || (XBUFFER (tem) != current_buffer))
f203cf07
RS
157 error (for_region ? "The mark is not set now, so there is no region"
158 : "The mark is not set now");
6497d2d8 159 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
4b4deea2 160 && NILP (BVAR (current_buffer, mark_active)))
f439241f 161 xsignal0 (Qmark_inactive);
ec28a64d
MB
162}
163
64ea14d3
RS
164/* If the list of args INPUT was produced with an explicit call to
165 `list', look for elements that were computed with
166 (region-beginning) or (region-end), and put those expressions into
167 VALUES instead of the present values.
168
169 This function doesn't return a value because it modifies elements
170 of VALUES to do its job. */
171
d1135afc 172static void
971de7fb 173fix_command (Lisp_Object input, Lisp_Object values)
d1135afc 174{
d032d5e7 175 /* FIXME: Instead of this ugly hack, we should provide a way for an
7200d79c
SM
176 interactive spec to return an expression/function that will re-build the
177 args without user intervention. */
d1135afc
JB
178 if (CONSP (input))
179 {
180 Lisp_Object car;
181
182 car = XCAR (input);
183 /* Skip through certain special forms. */
184 while (EQ (car, Qlet) || EQ (car, Qletx)
185 || EQ (car, Qsave_excursion)
186 || EQ (car, Qprogn))
187 {
188 while (CONSP (XCDR (input)))
189 input = XCDR (input);
190 input = XCAR (input);
191 if (!CONSP (input))
192 break;
193 car = XCAR (input);
194 }
195 if (EQ (car, Qlist))
196 {
197 Lisp_Object intail, valtail;
198 for (intail = Fcdr (input), valtail = values;
199 CONSP (valtail);
5dc05618 200 intail = Fcdr (intail), valtail = XCDR (valtail))
d1135afc
JB
201 {
202 Lisp_Object elt;
203 elt = Fcar (intail);
204 if (CONSP (elt))
205 {
206 Lisp_Object presflag, carelt;
207 carelt = Fcar (elt);
208 /* If it is (if X Y), look at Y. */
209 if (EQ (carelt, Qif)
210 && EQ (Fnthcdr (make_number (3), elt), Qnil))
211 elt = Fnth (make_number (2), elt);
212 /* If it is (when ... Y), look at Y. */
213 else if (EQ (carelt, Qwhen))
214 {
215 while (CONSP (XCDR (elt)))
216 elt = XCDR (elt);
217 elt = Fcar (elt);
218 }
219
220 /* If the function call we're looking at
221 is a special preserved one, copy the
222 whole expression for this argument. */
223 if (CONSP (elt))
224 {
225 presflag = Fmemq (Fcar (elt), preserved_fns);
226 if (!NILP (presflag))
227 Fsetcar (valtail, Fcar (intail));
228 }
229 }
230 }
231 }
232 }
233}
ec28a64d 234
d455db8e 235DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
fdb82f93
PJ
236 doc: /* Call FUNCTION, reading args according to its interactive calling specs.
237Return the value FUNCTION returns.
238The function contains a specification of how to do the argument reading.
239In the case of user-defined functions, this is specified by placing a call
240to the function `interactive' at the top level of the function body.
241See `interactive'.
242
243Optional second arg RECORD-FLAG non-nil
244means unconditionally put this command in the command-history.
245Otherwise, this is done only if an arg is read using the minibuffer.
2a95a27c 246
fdb82f93 247Optional third arg KEYS, if given, specifies the sequence of events to
2a95a27c
CY
248supply, as a vector, if the command inquires which events were used to
249invoke it. If KEYS is omitted or nil, the return value of
250`this-command-keys-vector' is used. */)
5842a27b 251 (Lisp_Object function, Lisp_Object record_flag, Lisp_Object keys)
ec28a64d
MB
252{
253 Lisp_Object *args, *visargs;
ec28a64d 254 Lisp_Object specs;
079e479f 255 Lisp_Object filter_specs;
ec28a64d 256 Lisp_Object teml;
39900c4e 257 Lisp_Object up_event;
52614803 258 Lisp_Object enable;
aed13378 259 int speccount = SPECPDL_INDEX ();
ec28a64d 260
bc78232c
JB
261 /* The index of the next element of this_command_keys to examine for
262 the 'e' interactive code. */
dbc4e1c1 263 int next_event;
bc78232c 264
ec28a64d 265 Lisp_Object prefix_arg;
a2db9982 266 char *string;
b0e80955 267 const char *tem;
63007de2
JB
268
269 /* If varies[i] > 0, the i'th argument shouldn't just have its value
270 in this call quoted in the command history. It should be
271 recorded as a call to the function named callint_argfuns[varies[i]]. */
ec28a64d 272 int *varies;
63007de2 273
becfa255
PE
274 register size_t i;
275 size_t 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);
91a6ba78 342 i = 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;
91a6ba78 350 if (i != 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
becfa255
PE
468 args = (Lisp_Object *) alloca (nargs * sizeof (Lisp_Object));
469 visargs = (Lisp_Object *) alloca (nargs * sizeof (Lisp_Object));
470 varies = (int *) alloca (nargs * sizeof (int));
ec28a64d 471
becfa255 472 for (i = 0; i < nargs; i++)
ec28a64d
MB
473 {
474 args[i] = Qnil;
475 visargs[i] = Qnil;
476 varies[i] = 0;
477 }
478
39900c4e 479 GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
becfa255
PE
480 gcpro3.nvars = nargs;
481 gcpro4.nvars = nargs;
ec28a64d 482
52614803
RS
483 if (!NILP (enable))
484 specbind (Qenable_recursive_minibuffers, Qt);
485
ec28a64d 486 tem = string;
6bc1abf2 487 for (i = 1; *tem; i++)
ec28a64d
MB
488 {
489 strncpy (prompt1, tem + 1, sizeof prompt1 - 1);
490 prompt1[sizeof prompt1 - 1] = 0;
8966b757 491 tem1 = strchr (prompt1, '\n');
ec28a64d 492 if (tem1) *tem1 = 0;
55b41ef5
CY
493
494 visargs[0] = build_string (prompt1);
8966b757 495 if (strchr (prompt1, '%'))
55b41ef5
CY
496 callint_message = Fformat (i, visargs);
497 else
498 callint_message = visargs[0];
ec28a64d
MB
499
500 switch (*tem)
501 {
502 case 'a': /* Symbol defined as a function */
55b41ef5 503 visargs[i] = Fcompleting_read (callint_message,
ff9cd111 504 Vobarray, Qfboundp, Qt,
93fb51ae 505 Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
506 /* Passing args[i] directly stimulates compiler bug */
507 teml = visargs[i];
508 args[i] = Fintern (teml, Qnil);
509 break;
510
511 case 'b': /* Name of existing buffer */
f03f8f2c
JL
512 args[i] = Fcurrent_buffer ();
513 if (EQ (selected_window, minibuf_window))
514 args[i] = Fother_buffer (args[i], Qnil, Qnil);
515 args[i] = Fread_buffer (callint_message, args[i], Qt);
516 break;
517
ec28a64d 518 case 'B': /* Name of buffer, possibly nonexistent */
f03f8f2c
JL
519 args[i] = Fread_buffer (callint_message,
520 Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
521 Qnil);
ec28a64d
MB
522 break;
523
524 case 'c': /* Character */
54b33868
MR
525 /* Prompt in `minibuffer-prompt' face. */
526 Fput_text_property (make_number (0),
527 make_number (SCHARS (callint_message)),
528 Qface, Qminibuffer_prompt, callint_message);
55b41ef5 529 args[i] = Fread_char (callint_message, Qnil, Qnil);
453ed650 530 message1_nolog ((char *) 0);
ec28a64d
MB
531 /* Passing args[i] directly stimulates compiler bug */
532 teml = args[i];
533 visargs[i] = Fchar_to_string (teml);
534 break;
535
536 case 'C': /* Command: symbol with interactive function */
55b41ef5 537 visargs[i] = Fcompleting_read (callint_message,
ff9cd111 538 Vobarray, Qcommandp,
93fb51ae 539 Qt, Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
540 /* Passing args[i] directly stimulates compiler bug */
541 teml = visargs[i];
542 args[i] = Fintern (teml, Qnil);
543 break;
544
545 case 'd': /* Value of point. Does not do I/O. */
dc330139 546 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
824977b6 547 args[i] = point_marker;
ec28a64d
MB
548 /* visargs[i] = Qnil; */
549 varies[i] = 1;
550 break;
551
ec28a64d 552 case 'D': /* Directory name. */
55b41ef5 553 args[i] = Fread_file_name (callint_message, Qnil,
4b4deea2 554 BVAR (current_buffer, directory), Qlambda, Qnil,
93ed5f9d 555 Qfile_directory_p);
ec28a64d
MB
556 break;
557
558 case 'f': /* Existing file name. */
55b41ef5 559 args[i] = Fread_file_name (callint_message,
93ed5f9d 560 Qnil, Qnil, Qlambda, Qnil, Qnil);
ec28a64d
MB
561 break;
562
563 case 'F': /* Possibly nonexistent file name. */
55b41ef5 564 args[i] = Fread_file_name (callint_message,
93ed5f9d 565 Qnil, Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
566 break;
567
75f9fbe8
RS
568 case 'G': /* Possibly nonexistent file name,
569 default to directory alone. */
55b41ef5 570 args[i] = Fread_file_name (callint_message,
977f6cfb 571 Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
75f9fbe8
RS
572 break;
573
40b2421c
KH
574 case 'i': /* Ignore an argument -- Does not do I/O */
575 varies[i] = -1;
576 break;
577
1989e7bc 578 case 'k': /* Key sequence. */
c631c234 579 {
aed13378 580 int speccount1 = SPECPDL_INDEX ();
c631c234 581 specbind (Qcursor_in_echo_area, Qt);
54b33868
MR
582 /* Prompt in `minibuffer-prompt' face. */
583 Fput_text_property (make_number (0),
584 make_number (SCHARS (callint_message)),
585 Qface, Qminibuffer_prompt, callint_message);
55b41ef5 586 args[i] = Fread_key_sequence (callint_message,
ad4ac475 587 Qnil, Qnil, Qnil, Qnil);
c631c234
RS
588 unbind_to (speccount1, Qnil);
589 teml = args[i];
a1bfe073 590 visargs[i] = Fkey_description (teml, Qnil);
cdfac812
RS
591
592 /* If the key sequence ends with a down-event,
593 discard the following up-event. */
594 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
595 if (CONSP (teml))
70949dac 596 teml = XCAR (teml);
cdfac812
RS
597 if (SYMBOLP (teml))
598 {
599 Lisp_Object tem2;
600
601 teml = Fget (teml, intern ("event-symbol-elements"));
4b27f17c
AS
602 /* Ignore first element, which is the base key. */
603 tem2 = Fmemq (intern ("down"), Fcdr (teml));
cdfac812 604 if (! NILP (tem2))
43811b4e 605 up_event = Fread_event (Qnil, Qnil, Qnil);
cdfac812 606 }
c631c234 607 }
1989e7bc
RS
608 break;
609
610 case 'K': /* Key sequence to be defined. */
c631c234 611 {
aed13378 612 int speccount1 = SPECPDL_INDEX ();
c631c234 613 specbind (Qcursor_in_echo_area, Qt);
54b33868
MR
614 /* Prompt in `minibuffer-prompt' face. */
615 Fput_text_property (make_number (0),
616 make_number (SCHARS (callint_message)),
617 Qface, Qminibuffer_prompt, callint_message);
55b41ef5 618 args[i] = Fread_key_sequence (callint_message,
ad4ac475 619 Qnil, Qt, Qnil, Qnil);
c631c234 620 teml = args[i];
a1bfe073 621 visargs[i] = Fkey_description (teml, Qnil);
c631c234 622 unbind_to (speccount1, Qnil);
cdfac812
RS
623
624 /* If the key sequence ends with a down-event,
625 discard the following up-event. */
626 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
627 if (CONSP (teml))
70949dac 628 teml = XCAR (teml);
cdfac812
RS
629 if (SYMBOLP (teml))
630 {
631 Lisp_Object tem2;
632
633 teml = Fget (teml, intern ("event-symbol-elements"));
4b27f17c
AS
634 /* Ignore first element, which is the base key. */
635 tem2 = Fmemq (intern ("down"), Fcdr (teml));
cdfac812 636 if (! NILP (tem2))
43811b4e 637 up_event = Fread_event (Qnil, Qnil, Qnil);
cdfac812 638 }
c631c234 639 }
ec28a64d
MB
640 break;
641
39900c4e
KS
642 case 'U': /* Up event from last k or K */
643 if (!NILP (up_event))
644 {
645 args[i] = Fmake_vector (make_number (1), up_event);
646 up_event = Qnil;
647 teml = args[i];
648 visargs[i] = Fkey_description (teml, Qnil);
649 }
650 break;
651
bc78232c 652 case 'e': /* The invoking event. */
d455db8e 653 if (next_event >= key_count)
bc78232c 654 error ("%s must be bound to an event with parameters",
6e54b3de 655 (SYMBOLP (function)
51b59d79 656 ? SSDATA (SYMBOL_NAME (function))
bc78232c 657 : "command"));
1b511542
SM
658 args[i] = AREF (keys, next_event);
659 next_event++;
e5d77022 660 varies[i] = -1;
dbc4e1c1
JB
661
662 /* Find the next parameterized event. */
d455db8e 663 while (next_event < key_count
1b511542 664 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
dbc4e1c1
JB
665 next_event++;
666
63007de2
JB
667 break;
668
ec28a64d 669 case 'm': /* Value of mark. Does not do I/O. */
f203cf07 670 check_mark (0);
ec28a64d 671 /* visargs[i] = Qnil; */
4b4deea2 672 args[i] = BVAR (current_buffer, mark);
ec28a64d
MB
673 varies[i] = 2;
674 break;
675
93fb51ae
KH
676 case 'M': /* String read via minibuffer with
677 inheriting the current input method. */
55b41ef5 678 args[i] = Fread_string (callint_message,
93fb51ae
KH
679 Qnil, Qnil, Qnil, Qt);
680 break;
681
425b457e 682 case 'N': /* Prefix arg as number, else number from minibuffer */
265a9e55 683 if (!NILP (prefix_arg))
ec28a64d
MB
684 goto have_prefix_arg;
685 case 'n': /* Read number from minibuffer. */
f0490a0b
RS
686 {
687 int first = 1;
688 do
689 {
a3e8cbda 690 Lisp_Object str;
e7c4e229 691 if (! first)
f0490a0b
RS
692 {
693 message ("Please enter a number.");
e7c4e229 694 sit_for (make_number (1), 0, 0);
f0490a0b
RS
695 }
696 first = 0;
697
a3e8cbda 698 str = Fread_from_minibuffer (callint_message,
93fb51ae 699 Qnil, Qnil, Qnil, Qnil, Qnil,
ae4c2a3b 700 Qnil);
a3e8cbda 701 if (! STRINGP (str) || SCHARS (str) == 0)
f0490a0b
RS
702 args[i] = Qnil;
703 else
a3e8cbda 704 args[i] = Fread (str);
f0490a0b
RS
705 }
706 while (! NUMBERP (args[i]));
707 }
55b41ef5 708 visargs[i] = args[i];
ec28a64d
MB
709 break;
710
711 case 'P': /* Prefix arg in raw form. Does no I/O. */
ec28a64d
MB
712 args[i] = prefix_arg;
713 /* visargs[i] = Qnil; */
714 varies[i] = -1;
715 break;
716
717 case 'p': /* Prefix arg converted to number. No I/O. */
71eda2d5 718 have_prefix_arg:
ec28a64d
MB
719 args[i] = Fprefix_numeric_value (prefix_arg);
720 /* visargs[i] = Qnil; */
721 varies[i] = -1;
722 break;
723
724 case 'r': /* Region, point and mark as 2 args. */
f203cf07 725 check_mark (1);
dc330139 726 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
ec28a64d 727 /* visargs[i+1] = Qnil; */
4b4deea2 728 foo = marker_position (BVAR (current_buffer, mark));
ec28a64d 729 /* visargs[i] = Qnil; */
4b4deea2 730 args[i] = PT < foo ? point_marker : BVAR (current_buffer, mark);
ec28a64d 731 varies[i] = 3;
4b4deea2 732 args[++i] = PT > foo ? point_marker : BVAR (current_buffer, mark);
ec28a64d
MB
733 varies[i] = 4;
734 break;
735
93fb51ae
KH
736 case 's': /* String read via minibuffer without
737 inheriting the current input method. */
55b41ef5 738 args[i] = Fread_string (callint_message,
93fb51ae 739 Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
740 break;
741
742 case 'S': /* Any symbol. */
55b41ef5 743 visargs[i] = Fread_string (callint_message,
93fb51ae 744 Qnil, Qnil, Qnil, Qnil);
ec28a64d
MB
745 /* Passing args[i] directly stimulates compiler bug */
746 teml = visargs[i];
747 args[i] = Fintern (teml, Qnil);
748 break;
749
750 case 'v': /* Variable name: symbol that is
751 user-variable-p. */
55b41ef5 752 args[i] = Fread_variable (callint_message, Qnil);
ec28a64d
MB
753 visargs[i] = last_minibuf_string;
754 break;
755
756 case 'x': /* Lisp expression read but not evaluated */
55b41ef5 757 args[i] = Fread_minibuffer (callint_message, Qnil);
ec28a64d
MB
758 visargs[i] = last_minibuf_string;
759 break;
760
761 case 'X': /* Lisp expression read and evaluated */
55b41ef5 762 args[i] = Feval_minibuffer (callint_message, Qnil);
ec28a64d
MB
763 visargs[i] = last_minibuf_string;
764 break;
765
40b2421c
KH
766 case 'Z': /* Coding-system symbol, or ignore the
767 argument if no prefix */
768 if (NILP (prefix_arg))
769 {
770 args[i] = Qnil;
771 varies[i] = -1;
772 }
177c0ea7 773 else
40b2421c
KH
774 {
775 args[i]
55b41ef5 776 = Fread_non_nil_coding_system (callint_message);
40b2421c
KH
777 visargs[i] = last_minibuf_string;
778 }
779 break;
780
781 case 'z': /* Coding-system symbol or nil */
55b41ef5 782 args[i] = Fread_coding_system (callint_message, Qnil);
40b2421c
KH
783 visargs[i] = last_minibuf_string;
784 break;
785
e92d107b
RS
786 /* We have a case for `+' so we get an error
787 if anyone tries to define one here. */
788 case '+':
ec28a64d 789 default:
e6c3da20
EZ
790 error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
791 STRING_CHAR ((unsigned char *) tem),
792 (unsigned) STRING_CHAR ((unsigned char *) tem),
793 (unsigned) STRING_CHAR ((unsigned char *) tem));
ec28a64d
MB
794 }
795
796 if (varies[i] == 0)
797 arg_from_tty = 1;
798
6e54b3de 799 if (NILP (visargs[i]) && STRINGP (args[i]))
ec28a64d
MB
800 visargs[i] = args[i];
801
a2db9982 802 tem = strchr (tem, '\n');
ec28a64d 803 if (tem) tem++;
a2db9982 804 else tem = "";
ec28a64d 805 }
52614803 806 unbind_to (speccount, Qnil);
ec28a64d
MB
807
808 QUIT;
809
810 args[0] = function;
811
7868a977 812 if (arg_from_tty || !NILP (record_flag))
ec28a64d
MB
813 {
814 visargs[0] = function;
becfa255 815 for (i = 1; i < nargs; i++)
824977b6
RS
816 {
817 if (varies[i] > 0)
818 visargs[i] = Fcons (intern (callint_argfuns[varies[i]]), Qnil);
819 else
820 visargs[i] = quotify_arg (args[i]);
821 }
becfa255 822 Vcommand_history = Fcons (Flist (nargs, visargs),
ec28a64d 823 Vcommand_history);
225c2157 824 /* Don't keep command history around forever. */
b9f0b172 825 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
225c2157
RS
826 {
827 teml = Fnthcdr (Vhistory_length, Vcommand_history);
828 if (CONSP (teml))
f3fbd155 829 XSETCDR (teml, Qnil);
225c2157 830 }
ec28a64d
MB
831 }
832
824977b6
RS
833 /* If we used a marker to hold point, mark, or an end of the region,
834 temporarily, convert it to an integer now. */
becfa255 835 for (i = 1; i < nargs; i++)
824977b6
RS
836 if (varies[i] >= 1 && varies[i] <= 4)
837 XSETINT (args[i], marker_position (args[i]));
838
09c886dc
RS
839 if (record_then_fail)
840 Fbarf_if_buffer_read_only ();
841
0605dd79
RS
842 Vthis_command = save_this_command;
843 Vthis_original_command = save_this_original_command;
844 real_this_command= save_real_this_command;
1344aad4 845 KVAR (current_kboard, Vlast_command) = save_last_command;
0605dd79 846
ec28a64d
MB
847 {
848 Lisp_Object val;
ec28a64d
MB
849 specbind (Qcommand_debug_status, Qnil);
850
b3e6f69c 851 temporarily_switch_to_single_kboard (NULL);
becfa255 852 val = Ffuncall (nargs, args);
ec28a64d
MB
853 UNGCPRO;
854 return unbind_to (speccount, val);
855 }
177c0ea7 856}
ec28a64d 857
a7ca3326 858DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
fdb82f93
PJ
859 1, 1, 0,
860 doc: /* Return numeric meaning of raw prefix argument RAW.
861A raw prefix argument is what you get from `(interactive "P")'.
862Its numeric meaning is what you would get from `(interactive "p")'. */)
5842a27b 863 (Lisp_Object raw)
ec28a64d
MB
864{
865 Lisp_Object val;
177c0ea7 866
265a9e55 867 if (NILP (raw))
acab6442 868 XSETFASTINT (val, 1);
fd5285f3 869 else if (EQ (raw, Qminus))
ec28a64d 870 XSETINT (val, -1);
70949dac
KR
871 else if (CONSP (raw) && INTEGERP (XCAR (raw)))
872 XSETINT (val, XINT (XCAR (raw)));
6e54b3de 873 else if (INTEGERP (raw))
ec28a64d
MB
874 val = raw;
875 else
acab6442 876 XSETFASTINT (val, 1);
ec28a64d
MB
877
878 return val;
879}
880
dfcf069d 881void
971de7fb 882syms_of_callint (void)
ec28a64d 883{
824977b6
RS
884 point_marker = Fmake_marker ();
885 staticpro (&point_marker);
886
55b41ef5
CY
887 callint_message = Qnil;
888 staticpro (&callint_message);
889
d67b4f80
DN
890 preserved_fns = pure_cons (intern_c_string ("region-beginning"),
891 pure_cons (intern_c_string ("region-end"),
892 pure_cons (intern_c_string ("point"),
893 pure_cons (intern_c_string ("mark"), Qnil))));
03e130d5 894
d67b4f80 895 Qlist = intern_c_string ("list");
03e130d5 896 staticpro (&Qlist);
d67b4f80 897 Qlet = intern_c_string ("let");
8450690a 898 staticpro (&Qlet);
d67b4f80 899 Qif = intern_c_string ("if");
120d0a23 900 staticpro (&Qif);
d67b4f80 901 Qwhen = intern_c_string ("when");
120d0a23 902 staticpro (&Qwhen);
d67b4f80 903 Qletx = intern_c_string ("let*");
8450690a 904 staticpro (&Qletx);
d67b4f80 905 Qsave_excursion = intern_c_string ("save-excursion");
8450690a 906 staticpro (&Qsave_excursion);
d67b4f80 907 Qprogn = intern_c_string ("progn");
079e479f 908 staticpro (&Qprogn);
03e130d5 909
d67b4f80 910 Qminus = intern_c_string ("-");
ec28a64d
MB
911 staticpro (&Qminus);
912
d67b4f80 913 Qplus = intern_c_string ("+");
fdb4a38c
RS
914 staticpro (&Qplus);
915
d67b4f80 916 Qhandle_shift_selection = intern_c_string ("handle-shift-selection");
9bdb1538
CY
917 staticpro (&Qhandle_shift_selection);
918
d67b4f80 919 Qcall_interactively = intern_c_string ("call-interactively");
ec28a64d
MB
920 staticpro (&Qcall_interactively);
921
d67b4f80 922 Qcommand_debug_status = intern_c_string ("command-debug-status");
ec28a64d
MB
923 staticpro (&Qcommand_debug_status);
924
d67b4f80 925 Qenable_recursive_minibuffers = intern_c_string ("enable-recursive-minibuffers");
52614803
RS
926 staticpro (&Qenable_recursive_minibuffers);
927
d67b4f80 928 Qmouse_leave_buffer_hook = intern_c_string ("mouse-leave-buffer-hook");
ef2515c0
RS
929 staticpro (&Qmouse_leave_buffer_hook);
930
1e0c5826 931 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
fdb82f93
PJ
932 doc: /* The value of the prefix argument for the next editing command.
933It may be a number, or the symbol `-' for just a minus sign as arg,
934or a list whose car is a number for just one or more C-u's
935or nil if no argument has been specified.
936
937You cannot examine this variable to find the argument for this command
938since it has been set to nil by the time you can look.
939Instead, you should use the variable `current-prefix-arg', although
940normally commands can get this prefix argument with (interactive "P"). */);
8c917bf2 941
fe3fbdcc 942 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
fdb82f93
PJ
943 doc: /* The value of the prefix argument for the previous editing command.
944See `prefix-arg' for the meaning of the value. */);
fe3fbdcc 945
29208e82 946 DEFVAR_LISP ("current-prefix-arg", Vcurrent_prefix_arg,
fdb82f93
PJ
947 doc: /* The value of the prefix argument for this editing command.
948It may be a number, or the symbol `-' for just a minus sign as arg,
949or a list whose car is a number for just one or more C-u's
950or nil if no argument has been specified.
951This is what `(interactive \"P\")' returns. */);
8c917bf2
KH
952 Vcurrent_prefix_arg = Qnil;
953
29208e82 954 DEFVAR_LISP ("command-history", Vcommand_history,
fdb82f93 955 doc: /* List of recent commands that read arguments from terminal.
b014713c
EZ
956Each command is represented as a form to evaluate.
957
958Maximum length of the history list is determined by the value
959of `history-length', which see. */);
ec28a64d
MB
960 Vcommand_history = Qnil;
961
29208e82 962 DEFVAR_LISP ("command-debug-status", Vcommand_debug_status,
fdb82f93
PJ
963 doc: /* Debugging status of current interactive command.
964Bound each time `call-interactively' is called;
965may be set by the debugger as a reminder for itself. */);
ec28a64d
MB
966 Vcommand_debug_status = Qnil;
967
29208e82 968 DEFVAR_LISP ("mark-even-if-inactive", Vmark_even_if_inactive,
fdb82f93
PJ
969 doc: /* *Non-nil means you can use the mark even when inactive.
970This option makes a difference in Transient Mark mode.
971When the option is non-nil, deactivation of the mark
972turns off region highlighting, but commands that use the mark
973behave as if the mark were still active. */);
a2b84f35 974 Vmark_even_if_inactive = Qt;
9f315aeb 975
29208e82 976 DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook,
fdb82f93
PJ
977 doc: /* Hook to run when about to switch windows with a mouse command.
978Its purpose is to give temporary modes such as Isearch mode
979a way to turn themselves off when a mouse command switches windows. */);
ef2515c0
RS
980 Vmouse_leave_buffer_hook = Qnil;
981
ec28a64d
MB
982 defsubr (&Sinteractive);
983 defsubr (&Scall_interactively);
984 defsubr (&Sprefix_numeric_value);
985}