Remove nt/addsection.c and don't build addsection.exe.
[bpt/emacs.git] / src / callint.c
... / ...
CommitLineData
1/* Call a Lisp function interactively.
2 Copyright (C) 1985-1986, 1993-1995, 1997, 2000-2014 Free Software
3 Foundation, Inc.
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software: you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20
21#include <config.h>
22
23#include "lisp.h"
24#include "character.h"
25#include "buffer.h"
26#include "commands.h"
27#include "keyboard.h"
28#include "window.h"
29#include "keymap.h"
30
31Lisp_Object Qminus, Qplus;
32static Lisp_Object Qfuncall_interactively;
33static Lisp_Object Qcommand_debug_status;
34static Lisp_Object Qenable_recursive_minibuffers;
35
36static Lisp_Object Qhandle_shift_selection;
37static Lisp_Object Qread_number;
38
39Lisp_Object Qmouse_leave_buffer_hook;
40
41static Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qif;
42Lisp_Object Qwhen, Qprogn;
43static Lisp_Object preserved_fns;
44
45/* Marker used within call-interactively to refer to point. */
46static Lisp_Object point_marker;
47
48/* String for the prompt text used in Fcall_interactively. */
49static Lisp_Object callint_message;
50\f
51/* ARGSUSED */
52DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
53 doc: /* Specify a way of parsing arguments for interactive use of a function.
54For example, write
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.
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
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
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 -- Parameterized 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.
86G -- Possibly nonexistent file name, defaulting to just directory name.
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.
93N -- Numeric prefix arg, or if none, do like code `n'.
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.
99U -- Mouse up event discarded by a previous k or K argument.
100v -- Variable name: symbol that is `custom-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.
105
106In addition, if the string begins with `*', an error is signaled if
107 the buffer is read-only.
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.
112If the string begins with `^' and `shift-select-mode' is non-nil,
113 Emacs first calls the function `handle-shift-selection'.
114You may use `@', `*', and `^' together. They are processed in the
115 order that they appear, before reading any arguments.
116usage: (interactive &optional ARGS) */)
117 (Lisp_Object args)
118{
119 return Qnil;
120}
121
122/* Quotify EXP: if EXP is constant, return it.
123 If EXP is not constant, return (quote EXP). */
124static Lisp_Object
125quotify_arg (register Lisp_Object exp)
126{
127 if (CONSP (exp)
128 || (SYMBOLP (exp)
129 && !NILP (exp) && !EQ (exp, Qt)))
130 return list2 (Qquote, exp);
131
132 return exp;
133}
134
135/* Modify EXP by quotifying each element (except the first). */
136static Lisp_Object
137quotify_args (Lisp_Object exp)
138{
139 register Lisp_Object tail;
140 Lisp_Object next;
141 for (tail = exp; CONSP (tail); tail = next)
142 {
143 next = XCDR (tail);
144 XSETCAR (tail, quotify_arg (XCAR (tail)));
145 }
146 return exp;
147}
148
149static const char *callint_argfuns[]
150 = {"", "point", "mark", "region-beginning", "region-end"};
151
152static void
153check_mark (bool for_region)
154{
155 Lisp_Object tem;
156 tem = Fmarker_buffer (BVAR (current_buffer, mark));
157 if (NILP (tem) || (XBUFFER (tem) != current_buffer))
158 error (for_region ? "The mark is not set now, so there is no region"
159 : "The mark is not set now");
160 if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
161 && NILP (BVAR (current_buffer, mark_active)))
162 xsignal0 (Qmark_inactive);
163}
164
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
173static void
174fix_command (Lisp_Object input, Lisp_Object values)
175{
176 /* FIXME: Instead of this ugly hack, we should provide a way for an
177 interactive spec to return an expression/function that will re-build the
178 args without user intervention. */
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);
201 intail = Fcdr (intail), valtail = XCDR (valtail))
202 {
203 Lisp_Object elt;
204 elt = Fcar (intail);
205 if (CONSP (elt))
206 {
207 Lisp_Object presflag, carelt;
208 carelt = XCAR (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}
235
236/* BEWARE: Calling this directly from C would defeat the purpose! */
237DEFUN ("funcall-interactively", Ffuncall_interactively, Sfuncall_interactively,
238 1, MANY, 0, doc: /* Like `funcall' but marks the call as interactive.
239I.e. arrange that within the called function `called-interactively-p' will
240return non-nil. */)
241 (ptrdiff_t nargs, Lisp_Object *args)
242{
243 ptrdiff_t speccount = SPECPDL_INDEX ();
244 temporarily_switch_to_single_kboard (NULL);
245
246 /* Nothing special to do here, all the work is inside
247 `called-interactively-p'. Which will look for us as a marker in the
248 backtrace. */
249 return unbind_to (speccount, Ffuncall (nargs, args));
250}
251
252DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
253 doc: /* Call FUNCTION, providing args according to its interactive calling specs.
254Return the value FUNCTION returns.
255The function contains a specification of how to do the argument reading.
256In the case of user-defined functions, this is specified by placing a call
257to the function `interactive' at the top level of the function body.
258See `interactive'.
259
260Optional second arg RECORD-FLAG non-nil
261means unconditionally put this command in the command-history.
262Otherwise, this is done only if an arg is read using the minibuffer.
263
264Optional third arg KEYS, if given, specifies the sequence of events to
265supply, as a vector, if the command inquires which events were used to
266invoke it. If KEYS is omitted or nil, the return value of
267`this-command-keys-vector' is used. */)
268 (Lisp_Object function, Lisp_Object record_flag, Lisp_Object keys)
269{
270 /* `args' will contain the array of arguments to pass to the function.
271 `visargs' will contain the same list but in a nicer form, so that if we
272 pass it to `Fformat' it will be understandable to a human. */
273 Lisp_Object *args, *visargs;
274 Lisp_Object specs;
275 Lisp_Object filter_specs;
276 Lisp_Object teml;
277 Lisp_Object up_event;
278 Lisp_Object enable;
279 ptrdiff_t speccount = SPECPDL_INDEX ();
280
281 /* The index of the next element of this_command_keys to examine for
282 the 'e' interactive code. */
283 ptrdiff_t next_event;
284
285 Lisp_Object prefix_arg;
286 char *string;
287 const char *tem;
288
289 /* If varies[i] > 0, the i'th argument shouldn't just have its value
290 in this call quoted in the command history. It should be
291 recorded as a call to the function named callint_argfuns[varies[i]]. */
292 signed char *varies;
293
294 ptrdiff_t i, nargs;
295 ptrdiff_t mark;
296 bool arg_from_tty = 0;
297 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
298 ptrdiff_t key_count;
299 bool record_then_fail = 0;
300
301 Lisp_Object save_this_command, save_last_command;
302 Lisp_Object save_this_original_command, save_real_this_command;
303
304 save_this_command = Vthis_command;
305 save_this_original_command = Vthis_original_command;
306 save_real_this_command = Vreal_this_command;
307 save_last_command = KVAR (current_kboard, Vlast_command);
308
309 if (NILP (keys))
310 keys = this_command_keys, key_count = this_command_key_count;
311 else
312 {
313 CHECK_VECTOR (keys);
314 key_count = ASIZE (keys);
315 }
316
317 /* Save this now, since use of minibuffer will clobber it. */
318 prefix_arg = Vcurrent_prefix_arg;
319
320 if (SYMBOLP (function))
321 enable = Fget (function, Qenable_recursive_minibuffers);
322 else
323 enable = Qnil;
324
325 specs = Qnil;
326 string = 0;
327 /* The idea of FILTER_SPECS is to provide a way to
328 specify how to represent the arguments in command history.
329 The feature is not fully implemented. */
330 filter_specs = Qnil;
331
332 /* If k or K discard an up-event, save it here so it can be retrieved with
333 U. */
334 up_event = Qnil;
335
336 /* Set SPECS to the interactive form, or barf if not interactive. */
337 {
338 Lisp_Object form;
339 GCPRO2 (function, prefix_arg);
340 form = Finteractive_form (function);
341 UNGCPRO;
342 if (CONSP (form))
343 specs = filter_specs = Fcar (XCDR (form));
344 else
345 wrong_type_argument (Qcommandp, function);
346 }
347
348 /* If SPECS is set to a string, use it as an interactive prompt. */
349 if (STRINGP (specs))
350 /* Make a copy of string so that if a GC relocates specs,
351 `string' will still be valid. */
352 string = xlispstrdupa (specs);
353 else
354 {
355 Lisp_Object input;
356 Lisp_Object funval = Findirect_function (function, Qt);
357 uintmax_t events = num_input_events;
358 input = specs;
359 /* Compute the arg values using the user's expression. */
360 GCPRO2 (input, filter_specs);
361 specs = Feval (specs,
362 CONSP (funval) && EQ (Qclosure, XCAR (funval))
363 ? CAR_SAFE (XCDR (funval)) : Qnil);
364 UNGCPRO;
365 if (events != num_input_events || !NILP (record_flag))
366 {
367 /* We should record this command on the command history. */
368 Lisp_Object values;
369 Lisp_Object this_cmd;
370 /* Make a copy of the list of values, for the command history,
371 and turn them into things we can eval. */
372 values = quotify_args (Fcopy_sequence (specs));
373 fix_command (input, values);
374 this_cmd = Fcons (function, values);
375 if (history_delete_duplicates)
376 Vcommand_history = Fdelete (this_cmd, Vcommand_history);
377 Vcommand_history = Fcons (this_cmd, Vcommand_history);
378
379 /* Don't keep command history around forever. */
380 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
381 {
382 teml = Fnthcdr (Vhistory_length, Vcommand_history);
383 if (CONSP (teml))
384 XSETCDR (teml, Qnil);
385 }
386 }
387
388 Vthis_command = save_this_command;
389 Vthis_original_command = save_this_original_command;
390 Vreal_this_command = save_real_this_command;
391 kset_last_command (current_kboard, save_last_command);
392
393 {
394 Lisp_Object args[3];
395 args[0] = Qfuncall_interactively;
396 args[1] = function;
397 args[2] = specs;
398 return unbind_to (speccount, Fapply (3, args));
399 }
400 }
401
402 /* Here if function specifies a string to control parsing the defaults. */
403
404 /* Set next_event to point to the first event with parameters. */
405 for (next_event = 0; next_event < key_count; next_event++)
406 if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
407 break;
408
409 /* Handle special starting chars `*' and `@'. Also `-'. */
410 /* Note that `+' is reserved for user extensions. */
411 while (1)
412 {
413 if (*string == '+')
414 error ("`+' is not used in `interactive' for ordinary commands");
415 else if (*string == '*')
416 {
417 string++;
418 if (!NILP (BVAR (current_buffer, read_only)))
419 {
420 if (!NILP (record_flag))
421 {
422 char *p = string;
423 while (*p)
424 {
425 if (! (*p == 'r' || *p == 'p' || *p == 'P'
426 || *p == '\n'))
427 Fbarf_if_buffer_read_only ();
428 p++;
429 }
430 record_then_fail = 1;
431 }
432 else
433 Fbarf_if_buffer_read_only ();
434 }
435 }
436 /* Ignore this for semi-compatibility with Lucid. */
437 else if (*string == '-')
438 string++;
439 else if (*string == '@')
440 {
441 Lisp_Object event, w;
442
443 event = (next_event < key_count
444 ? AREF (keys, next_event)
445 : Qnil);
446 if (EVENT_HAS_PARAMETERS (event)
447 && (w = XCDR (event), CONSP (w))
448 && (w = XCAR (w), CONSP (w))
449 && (w = XCAR (w), WINDOWP (w)))
450 {
451 if (MINI_WINDOW_P (XWINDOW (w))
452 && ! (minibuf_level > 0 && EQ (w, minibuf_window)))
453 error ("Attempt to select inactive minibuffer window");
454
455 /* If the current buffer wants to clean up, let it. */
456 Frun_hooks (1, &Qmouse_leave_buffer_hook);
457
458 Fselect_window (w, Qnil);
459 }
460 string++;
461 }
462 else if (*string == '^')
463 {
464 call0 (Qhandle_shift_selection);
465 string++;
466 }
467 else break;
468 }
469
470 /* Count the number of arguments, which is two (the function itself and
471 `funcall-interactively') plus the number of arguments the interactive spec
472 would have us give to the function. */
473 tem = string;
474 for (nargs = 2; *tem; )
475 {
476 /* 'r' specifications ("point and mark as 2 numeric args")
477 produce *two* arguments. */
478 if (*tem == 'r')
479 nargs += 2;
480 else
481 nargs++;
482 tem = strchr (tem, '\n');
483 if (tem)
484 ++tem;
485 else
486 break;
487 }
488
489 if (min (MOST_POSITIVE_FIXNUM,
490 min (PTRDIFF_MAX, SIZE_MAX) / word_size)
491 < nargs)
492 memory_full (SIZE_MAX);
493
494 args = alloca (nargs * sizeof *args);
495 visargs = alloca (nargs * sizeof *visargs);
496 varies = alloca (nargs * sizeof *varies);
497
498 for (i = 0; i < nargs; i++)
499 {
500 args[i] = Qnil;
501 visargs[i] = Qnil;
502 varies[i] = 0;
503 }
504
505 GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
506 gcpro3.nvars = nargs;
507 gcpro4.nvars = nargs;
508
509 if (!NILP (enable))
510 specbind (Qenable_recursive_minibuffers, Qt);
511
512 tem = string;
513 for (i = 2; *tem; i++)
514 {
515 visargs[1] = make_string (tem + 1, strcspn (tem + 1, "\n"));
516 if (strchr (SSDATA (visargs[1]), '%'))
517 callint_message = Fformat (i, visargs);
518 else
519 callint_message = visargs[1];
520
521 switch (*tem)
522 {
523 case 'a': /* Symbol defined as a function. */
524 visargs[i] = Fcompleting_read (callint_message,
525 Vobarray, Qfboundp, Qt,
526 Qnil, Qnil, Qnil, Qnil);
527 /* Passing args[i] directly stimulates compiler bug. */
528 teml = visargs[i];
529 args[i] = Fintern (teml, Qnil);
530 break;
531
532 case 'b': /* Name of existing buffer. */
533 args[i] = Fcurrent_buffer ();
534 if (EQ (selected_window, minibuf_window))
535 args[i] = Fother_buffer (args[i], Qnil, Qnil);
536 args[i] = Fread_buffer (callint_message, args[i], Qt);
537 break;
538
539 case 'B': /* Name of buffer, possibly nonexistent. */
540 args[i] = Fread_buffer (callint_message,
541 Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
542 Qnil);
543 break;
544
545 case 'c': /* Character. */
546 /* Prompt in `minibuffer-prompt' face. */
547 Fput_text_property (make_number (0),
548 make_number (SCHARS (callint_message)),
549 Qface, Qminibuffer_prompt, callint_message);
550 args[i] = Fread_char (callint_message, Qnil, Qnil);
551 message1_nolog (0);
552 /* Passing args[i] directly stimulates compiler bug. */
553 teml = args[i];
554 /* See bug#8479. */
555 if (! CHARACTERP (teml)) error ("Non-character input-event");
556 visargs[i] = Fchar_to_string (teml);
557 break;
558
559 case 'C': /* Command: symbol with interactive function. */
560 visargs[i] = Fcompleting_read (callint_message,
561 Vobarray, Qcommandp,
562 Qt, Qnil, Qnil, Qnil, Qnil);
563 /* Passing args[i] directly stimulates compiler bug. */
564 teml = visargs[i];
565 args[i] = Fintern (teml, Qnil);
566 break;
567
568 case 'd': /* Value of point. Does not do I/O. */
569 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
570 args[i] = point_marker;
571 /* visargs[i] = Qnil; */
572 varies[i] = 1;
573 break;
574
575 case 'D': /* Directory name. */
576 args[i] = Fread_file_name (callint_message, Qnil,
577 BVAR (current_buffer, directory), Qlambda, Qnil,
578 Qfile_directory_p);
579 break;
580
581 case 'f': /* Existing file name. */
582 args[i] = Fread_file_name (callint_message,
583 Qnil, Qnil, Qlambda, Qnil, Qnil);
584 break;
585
586 case 'F': /* Possibly nonexistent file name. */
587 args[i] = Fread_file_name (callint_message,
588 Qnil, Qnil, Qnil, Qnil, Qnil);
589 break;
590
591 case 'G': /* Possibly nonexistent file name,
592 default to directory alone. */
593 args[i] = Fread_file_name (callint_message,
594 Qnil, Qnil, Qnil, empty_unibyte_string, Qnil);
595 break;
596
597 case 'i': /* Ignore an argument -- Does not do I/O. */
598 varies[i] = -1;
599 break;
600
601 case 'k': /* Key sequence. */
602 {
603 ptrdiff_t speccount1 = SPECPDL_INDEX ();
604 specbind (Qcursor_in_echo_area, Qt);
605 /* Prompt in `minibuffer-prompt' face. */
606 Fput_text_property (make_number (0),
607 make_number (SCHARS (callint_message)),
608 Qface, Qminibuffer_prompt, callint_message);
609 args[i] = Fread_key_sequence (callint_message,
610 Qnil, Qnil, Qnil, Qnil);
611 unbind_to (speccount1, Qnil);
612 teml = args[i];
613 visargs[i] = Fkey_description (teml, Qnil);
614
615 /* If the key sequence ends with a down-event,
616 discard the following up-event. */
617 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
618 if (CONSP (teml))
619 teml = XCAR (teml);
620 if (SYMBOLP (teml))
621 {
622 Lisp_Object tem2;
623
624 teml = Fget (teml, intern ("event-symbol-elements"));
625 /* Ignore first element, which is the base key. */
626 tem2 = Fmemq (intern ("down"), Fcdr (teml));
627 if (! NILP (tem2))
628 up_event = Fread_event (Qnil, Qnil, Qnil);
629 }
630 }
631 break;
632
633 case 'K': /* Key sequence to be defined. */
634 {
635 ptrdiff_t speccount1 = SPECPDL_INDEX ();
636 specbind (Qcursor_in_echo_area, Qt);
637 /* Prompt in `minibuffer-prompt' face. */
638 Fput_text_property (make_number (0),
639 make_number (SCHARS (callint_message)),
640 Qface, Qminibuffer_prompt, callint_message);
641 args[i] = Fread_key_sequence_vector (callint_message,
642 Qnil, Qt, Qnil, Qnil);
643 teml = args[i];
644 visargs[i] = Fkey_description (teml, Qnil);
645 unbind_to (speccount1, Qnil);
646
647 /* If the key sequence ends with a down-event,
648 discard the following up-event. */
649 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
650 if (CONSP (teml))
651 teml = XCAR (teml);
652 if (SYMBOLP (teml))
653 {
654 Lisp_Object tem2;
655
656 teml = Fget (teml, intern ("event-symbol-elements"));
657 /* Ignore first element, which is the base key. */
658 tem2 = Fmemq (intern ("down"), Fcdr (teml));
659 if (! NILP (tem2))
660 up_event = Fread_event (Qnil, Qnil, Qnil);
661 }
662 }
663 break;
664
665 case 'U': /* Up event from last k or K. */
666 if (!NILP (up_event))
667 {
668 args[i] = Fmake_vector (make_number (1), up_event);
669 up_event = Qnil;
670 teml = args[i];
671 visargs[i] = Fkey_description (teml, Qnil);
672 }
673 break;
674
675 case 'e': /* The invoking event. */
676 if (next_event >= key_count)
677 error ("%s must be bound to an event with parameters",
678 (SYMBOLP (function)
679 ? SSDATA (SYMBOL_NAME (function))
680 : "command"));
681 args[i] = AREF (keys, next_event);
682 next_event++;
683 varies[i] = -1;
684
685 /* Find the next parameterized event. */
686 while (next_event < key_count
687 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
688 next_event++;
689
690 break;
691
692 case 'm': /* Value of mark. Does not do I/O. */
693 check_mark (0);
694 /* visargs[i] = Qnil; */
695 args[i] = BVAR (current_buffer, mark);
696 varies[i] = 2;
697 break;
698
699 case 'M': /* String read via minibuffer with
700 inheriting the current input method. */
701 args[i] = Fread_string (callint_message,
702 Qnil, Qnil, Qnil, Qt);
703 break;
704
705 case 'N': /* Prefix arg as number, else number from minibuffer. */
706 if (!NILP (prefix_arg))
707 goto have_prefix_arg;
708 case 'n': /* Read number from minibuffer. */
709 args[i] = call1 (Qread_number, callint_message);
710 /* Passing args[i] directly stimulates compiler bug. */
711 teml = args[i];
712 visargs[i] = Fnumber_to_string (teml);
713 break;
714
715 case 'P': /* Prefix arg in raw form. Does no I/O. */
716 args[i] = prefix_arg;
717 /* visargs[i] = Qnil; */
718 varies[i] = -1;
719 break;
720
721 case 'p': /* Prefix arg converted to number. No I/O. */
722 have_prefix_arg:
723 args[i] = Fprefix_numeric_value (prefix_arg);
724 /* visargs[i] = Qnil; */
725 varies[i] = -1;
726 break;
727
728 case 'r': /* Region, point and mark as 2 args. */
729 check_mark (1);
730 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
731 /* visargs[i+1] = Qnil; */
732 mark = marker_position (BVAR (current_buffer, mark));
733 /* visargs[i] = Qnil; */
734 args[i] = PT < mark ? point_marker : BVAR (current_buffer, mark);
735 varies[i] = 3;
736 args[++i] = PT > mark ? point_marker : BVAR (current_buffer, mark);
737 varies[i] = 4;
738 break;
739
740 case 's': /* String read via minibuffer without
741 inheriting the current input method. */
742 args[i] = Fread_string (callint_message,
743 Qnil, Qnil, Qnil, Qnil);
744 break;
745
746 case 'S': /* Any symbol. */
747 visargs[i] = Fread_string (callint_message,
748 Qnil, Qnil, Qnil, Qnil);
749 /* Passing args[i] directly stimulates compiler bug. */
750 teml = visargs[i];
751 args[i] = Fintern (teml, Qnil);
752 break;
753
754 case 'v': /* Variable name: symbol that is
755 custom-variable-p. */
756 args[i] = Fread_variable (callint_message, Qnil);
757 visargs[i] = last_minibuf_string;
758 break;
759
760 case 'x': /* Lisp expression read but not evaluated. */
761 args[i] = call1 (intern ("read-minibuffer"), callint_message);
762 visargs[i] = last_minibuf_string;
763 break;
764
765 case 'X': /* Lisp expression read and evaluated. */
766 args[i] = call1 (intern ("eval-minibuffer"), callint_message);
767 visargs[i] = last_minibuf_string;
768 break;
769
770 case 'Z': /* Coding-system symbol, or ignore the
771 argument if no prefix. */
772 if (NILP (prefix_arg))
773 {
774 args[i] = Qnil;
775 varies[i] = -1;
776 }
777 else
778 {
779 args[i]
780 = Fread_non_nil_coding_system (callint_message);
781 visargs[i] = last_minibuf_string;
782 }
783 break;
784
785 case 'z': /* Coding-system symbol or nil. */
786 args[i] = Fread_coding_system (callint_message, Qnil);
787 visargs[i] = last_minibuf_string;
788 break;
789
790 /* We have a case for `+' so we get an error
791 if anyone tries to define one here. */
792 case '+':
793 default:
794 error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
795 STRING_CHAR ((unsigned char *) tem),
796 (unsigned) STRING_CHAR ((unsigned char *) tem),
797 (unsigned) STRING_CHAR ((unsigned char *) tem));
798 }
799
800 if (varies[i] == 0)
801 arg_from_tty = 1;
802
803 if (NILP (visargs[i]) && STRINGP (args[i]))
804 visargs[i] = args[i];
805
806 tem = strchr (tem, '\n');
807 if (tem) tem++;
808 else tem = "";
809 }
810 unbind_to (speccount, Qnil);
811
812 QUIT;
813
814 args[0] = Qfuncall_interactively;
815 args[1] = function;
816
817 if (arg_from_tty || !NILP (record_flag))
818 {
819 /* We don't need `visargs' any more, so let's recycle it since we need
820 an array of just the same size. */
821 visargs[1] = function;
822 for (i = 2; i < nargs; i++)
823 {
824 if (varies[i] > 0)
825 visargs[i] = list1 (intern (callint_argfuns[varies[i]]));
826 else
827 visargs[i] = quotify_arg (args[i]);
828 }
829 Vcommand_history = Fcons (Flist (nargs - 1, visargs + 1),
830 Vcommand_history);
831 /* Don't keep command history around forever. */
832 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
833 {
834 teml = Fnthcdr (Vhistory_length, Vcommand_history);
835 if (CONSP (teml))
836 XSETCDR (teml, Qnil);
837 }
838 }
839
840 /* If we used a marker to hold point, mark, or an end of the region,
841 temporarily, convert it to an integer now. */
842 for (i = 2; i < nargs; i++)
843 if (varies[i] >= 1 && varies[i] <= 4)
844 XSETINT (args[i], marker_position (args[i]));
845
846 if (record_then_fail)
847 Fbarf_if_buffer_read_only ();
848
849 Vthis_command = save_this_command;
850 Vthis_original_command = save_this_original_command;
851 Vreal_this_command = save_real_this_command;
852 kset_last_command (current_kboard, save_last_command);
853
854 {
855 Lisp_Object val = Ffuncall (nargs, args);
856 UNGCPRO;
857 return unbind_to (speccount, val);
858 }
859}
860
861DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
862 1, 1, 0,
863 doc: /* Return numeric meaning of raw prefix argument RAW.
864A raw prefix argument is what you get from `(interactive "P")'.
865Its numeric meaning is what you would get from `(interactive "p")'. */)
866 (Lisp_Object raw)
867{
868 Lisp_Object val;
869
870 if (NILP (raw))
871 XSETFASTINT (val, 1);
872 else if (EQ (raw, Qminus))
873 XSETINT (val, -1);
874 else if (CONSP (raw) && INTEGERP (XCAR (raw)))
875 XSETINT (val, XINT (XCAR (raw)));
876 else if (INTEGERP (raw))
877 val = raw;
878 else
879 XSETFASTINT (val, 1);
880
881 return val;
882}
883
884void
885syms_of_callint (void)
886{
887 point_marker = Fmake_marker ();
888 staticpro (&point_marker);
889
890 callint_message = Qnil;
891 staticpro (&callint_message);
892
893 preserved_fns = listn (CONSTYPE_PURE, 4,
894 intern_c_string ("region-beginning"),
895 intern_c_string ("region-end"),
896 intern_c_string ("point"),
897 intern_c_string ("mark"));
898
899 DEFSYM (Qlist, "list");
900 DEFSYM (Qlet, "let");
901 DEFSYM (Qif, "if");
902 DEFSYM (Qwhen, "when");
903 DEFSYM (Qletx, "let*");
904 DEFSYM (Qsave_excursion, "save-excursion");
905 DEFSYM (Qprogn, "progn");
906 DEFSYM (Qminus, "-");
907 DEFSYM (Qplus, "+");
908 DEFSYM (Qhandle_shift_selection, "handle-shift-selection");
909 DEFSYM (Qread_number, "read-number");
910 DEFSYM (Qfuncall_interactively, "funcall-interactively");
911 DEFSYM (Qcommand_debug_status, "command-debug-status");
912 DEFSYM (Qenable_recursive_minibuffers, "enable-recursive-minibuffers");
913 DEFSYM (Qmouse_leave_buffer_hook, "mouse-leave-buffer-hook");
914
915 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
916 doc: /* The value of the prefix argument for the next editing command.
917It may be a number, or the symbol `-' for just a minus sign as arg,
918or a list whose car is a number for just one or more C-u's
919or nil if no argument has been specified.
920
921You cannot examine this variable to find the argument for this command
922since it has been set to nil by the time you can look.
923Instead, you should use the variable `current-prefix-arg', although
924normally commands can get this prefix argument with (interactive "P"). */);
925
926 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
927 doc: /* The value of the prefix argument for the previous editing command.
928See `prefix-arg' for the meaning of the value. */);
929
930 DEFVAR_LISP ("current-prefix-arg", Vcurrent_prefix_arg,
931 doc: /* The value of the prefix argument for this editing command.
932It may be a number, or the symbol `-' for just a minus sign as arg,
933or a list whose car is a number for just one or more C-u's
934or nil if no argument has been specified.
935This is what `(interactive \"P\")' returns. */);
936 Vcurrent_prefix_arg = Qnil;
937
938 DEFVAR_LISP ("command-history", Vcommand_history,
939 doc: /* List of recent commands that read arguments from terminal.
940Each command is represented as a form to evaluate.
941
942Maximum length of the history list is determined by the value
943of `history-length', which see. */);
944 Vcommand_history = Qnil;
945
946 DEFVAR_LISP ("command-debug-status", Vcommand_debug_status,
947 doc: /* Debugging status of current interactive command.
948Bound each time `call-interactively' is called;
949may be set by the debugger as a reminder for itself. */);
950 Vcommand_debug_status = Qnil;
951
952 DEFVAR_LISP ("mark-even-if-inactive", Vmark_even_if_inactive,
953 doc: /* Non-nil means you can use the mark even when inactive.
954This option makes a difference in Transient Mark mode.
955When the option is non-nil, deactivation of the mark
956turns off region highlighting, but commands that use the mark
957behave as if the mark were still active. */);
958 Vmark_even_if_inactive = Qt;
959
960 DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook,
961 doc: /* Hook to run when about to switch windows with a mouse command.
962Its purpose is to give temporary modes such as Isearch mode
963a way to turn themselves off when a mouse command switches windows. */);
964 Vmouse_leave_buffer_hook = Qnil;
965
966 defsubr (&Sinteractive);
967 defsubr (&Scall_interactively);
968 defsubr (&Sfuncall_interactively);
969 defsubr (&Sprefix_numeric_value);
970}