* lisp/cedet/semantic/wisent/comp.el (wisent-defcontext): Move declarations
[emacs.git] / src / callint.c
blob9a4573c77be7e701e07c4fe3ff259cd1a5b33b86
1 /* Call a Lisp function interactively.
2 Copyright (C) 1985-1986, 1993-1995, 1997, 2000-2014 Free Software
3 Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
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"
31 Lisp_Object Qminus, Qplus;
32 static Lisp_Object Qfuncall_interactively;
33 static Lisp_Object Qcommand_debug_status;
34 static Lisp_Object Qenable_recursive_minibuffers;
36 static Lisp_Object Qhandle_shift_selection;
37 static Lisp_Object Qread_number;
39 Lisp_Object Qmouse_leave_buffer_hook;
41 static Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion, Qif;
42 Lisp_Object Qwhen, Qprogn;
43 static Lisp_Object preserved_fns;
45 /* Marker used within call-interactively to refer to point. */
46 static Lisp_Object point_marker;
48 /* String for the prompt text used in Fcall_interactively. */
49 static Lisp_Object callint_message;
51 /* ARGSUSED */
52 DEFUN ("interactive", Finteractive, Sinteractive, 0, UNEVALLED, 0,
53 doc: /* Specify a way of parsing arguments for interactive use of a function.
54 For 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.
58 The "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.
61 When actually called, `interactive' just returns nil.
63 Usually 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.
67 Prompts are passed to format, and may use % escapes to print the
68 arguments that have already been read.
69 If the argument is not a string, it is evaluated to get a list of
70 arguments to pass to the function.
71 Just `(interactive)' means pass no args when calling interactively.
73 Code letters available are:
74 a -- Function name: symbol with a function definition.
75 b -- Name of existing buffer.
76 B -- Name of buffer, possibly nonexistent.
77 c -- Character (no input method is used).
78 C -- Command name: symbol with interactive function definition.
79 d -- Value of point as number. Does not do I/O.
80 D -- Directory name.
81 e -- 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.
84 f -- Existing file name.
85 F -- Possibly nonexistent file name.
86 G -- Possibly nonexistent file name, defaulting to just directory name.
87 i -- Ignored, i.e. always nil. Does not do I/O.
88 k -- Key sequence (downcase the last event if needed to get a definition).
89 K -- Key sequence to be redefined (do not downcase the last event).
90 m -- Value of mark as number. Does not do I/O.
91 M -- Any string. Inherits the current input method.
92 n -- Number read using minibuffer.
93 N -- Numeric prefix arg, or if none, do like code `n'.
94 p -- Prefix arg converted to number. Does not do I/O.
95 P -- Prefix arg in raw form. Does not do I/O.
96 r -- Region: point and mark as 2 numeric args, smallest first. Does no I/O.
97 s -- Any string. Does not inherit the current input method.
98 S -- Any symbol.
99 U -- Mouse up event discarded by a previous k or K argument.
100 v -- Variable name: symbol that is `custom-variable-p'.
101 x -- Lisp expression read but not evaluated.
102 X -- Lisp expression read and evaluated.
103 z -- Coding system.
104 Z -- Coding system, nil if no prefix arg.
106 In addition, if the string begins with `*', an error is signaled if
107 the buffer is read-only.
108 If `@' 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.
112 If the string begins with `^' and `shift-select-mode' is non-nil,
113 Emacs first calls the function `handle-shift-selection'.
114 You may use `@', `*', and `^' together. They are processed in the
115 order that they appear, before reading any arguments.
116 usage: (interactive &optional ARGS) */)
117 (Lisp_Object args)
119 return Qnil;
122 /* Quotify EXP: if EXP is constant, return it.
123 If EXP is not constant, return (quote EXP). */
124 static Lisp_Object
125 quotify_arg (register Lisp_Object exp)
127 if (CONSP (exp)
128 || (SYMBOLP (exp)
129 && !NILP (exp) && !EQ (exp, Qt)))
130 return list2 (Qquote, exp);
132 return exp;
135 /* Modify EXP by quotifying each element (except the first). */
136 static Lisp_Object
137 quotify_args (Lisp_Object exp)
139 register Lisp_Object tail;
140 Lisp_Object next;
141 for (tail = exp; CONSP (tail); tail = next)
143 next = XCDR (tail);
144 XSETCAR (tail, quotify_arg (XCAR (tail)));
146 return exp;
149 static const char *callint_argfuns[]
150 = {"", "point", "mark", "region-beginning", "region-end"};
152 static void
153 check_mark (bool for_region)
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);
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.
170 This function doesn't return a value because it modifies elements
171 of VALUES to do its job. */
173 static void
174 fix_command (Lisp_Object input, Lisp_Object values)
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))
181 Lisp_Object car;
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))
189 while (CONSP (XCDR (input)))
190 input = XCDR (input);
191 input = XCAR (input);
192 if (!CONSP (input))
193 break;
194 car = XCAR (input);
196 if (EQ (car, Qlist))
198 Lisp_Object intail, valtail;
199 for (intail = Fcdr (input), valtail = values;
200 CONSP (valtail);
201 intail = Fcdr (intail), valtail = XCDR (valtail))
203 Lisp_Object elt;
204 elt = Fcar (intail);
205 if (CONSP (elt))
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))
216 while (CONSP (XCDR (elt)))
217 elt = XCDR (elt);
218 elt = Fcar (elt);
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))
226 presflag = Fmemq (Fcar (elt), preserved_fns);
227 if (!NILP (presflag))
228 Fsetcar (valtail, Fcar (intail));
236 /* Helper function to call `read-file-name' from C. */
238 static Lisp_Object
239 read_file_name (Lisp_Object default_filename, Lisp_Object mustmatch,
240 Lisp_Object initial, Lisp_Object predicate)
242 struct gcpro gcpro1;
243 Lisp_Object args[7];
245 GCPRO1 (default_filename);
246 args[0] = intern ("read-file-name");
247 args[1] = callint_message;
248 args[2] = Qnil;
249 args[3] = default_filename;
250 args[4] = mustmatch;
251 args[5] = initial;
252 args[6] = predicate;
253 RETURN_UNGCPRO (Ffuncall (7, args));
256 /* BEWARE: Calling this directly from C would defeat the purpose! */
257 DEFUN ("funcall-interactively", Ffuncall_interactively, Sfuncall_interactively,
258 1, MANY, 0, doc: /* Like `funcall' but marks the call as interactive.
259 I.e. arrange that within the called function `called-interactively-p' will
260 return non-nil.
261 usage: (funcall-interactively FUNCTION &rest ARGUMENTS) */)
262 (ptrdiff_t nargs, Lisp_Object *args)
264 ptrdiff_t speccount = SPECPDL_INDEX ();
265 temporarily_switch_to_single_kboard (NULL);
267 /* Nothing special to do here, all the work is inside
268 `called-interactively-p'. Which will look for us as a marker in the
269 backtrace. */
270 return unbind_to (speccount, Ffuncall (nargs, args));
273 DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
274 doc: /* Call FUNCTION, providing args according to its interactive calling specs.
275 Return the value FUNCTION returns.
276 The function contains a specification of how to do the argument reading.
277 In the case of user-defined functions, this is specified by placing a call
278 to the function `interactive' at the top level of the function body.
279 See `interactive'.
281 Optional second arg RECORD-FLAG non-nil
282 means unconditionally put this command in the command-history.
283 Otherwise, this is done only if an arg is read using the minibuffer.
285 Optional third arg KEYS, if given, specifies the sequence of events to
286 supply, as a vector, if the command inquires which events were used to
287 invoke it. If KEYS is omitted or nil, the return value of
288 `this-command-keys-vector' is used. */)
289 (Lisp_Object function, Lisp_Object record_flag, Lisp_Object keys)
291 /* `args' will contain the array of arguments to pass to the function.
292 `visargs' will contain the same list but in a nicer form, so that if we
293 pass it to `Fformat' it will be understandable to a human. */
294 Lisp_Object *args, *visargs;
295 Lisp_Object specs;
296 Lisp_Object filter_specs;
297 Lisp_Object teml;
298 Lisp_Object up_event;
299 Lisp_Object enable;
300 USE_SAFE_ALLOCA;
301 ptrdiff_t speccount = SPECPDL_INDEX ();
303 /* The index of the next element of this_command_keys to examine for
304 the 'e' interactive code. */
305 ptrdiff_t next_event;
307 Lisp_Object prefix_arg;
308 char *string;
309 const char *tem;
311 /* If varies[i] > 0, the i'th argument shouldn't just have its value
312 in this call quoted in the command history. It should be
313 recorded as a call to the function named callint_argfuns[varies[i]]. */
314 signed char *varies;
316 ptrdiff_t i, nargs;
317 ptrdiff_t mark;
318 bool arg_from_tty = 0;
319 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
320 ptrdiff_t key_count;
321 bool record_then_fail = 0;
323 Lisp_Object save_this_command, save_last_command;
324 Lisp_Object save_this_original_command, save_real_this_command;
326 save_this_command = Vthis_command;
327 save_this_original_command = Vthis_original_command;
328 save_real_this_command = Vreal_this_command;
329 save_last_command = KVAR (current_kboard, Vlast_command);
331 if (NILP (keys))
332 keys = this_command_keys, key_count = this_command_key_count;
333 else
335 CHECK_VECTOR (keys);
336 key_count = ASIZE (keys);
339 /* Save this now, since use of minibuffer will clobber it. */
340 prefix_arg = Vcurrent_prefix_arg;
342 if (SYMBOLP (function))
343 enable = Fget (function, Qenable_recursive_minibuffers);
344 else
345 enable = Qnil;
347 specs = Qnil;
348 string = 0;
349 /* The idea of FILTER_SPECS is to provide a way to
350 specify how to represent the arguments in command history.
351 The feature is not fully implemented. */
352 filter_specs = Qnil;
354 /* If k or K discard an up-event, save it here so it can be retrieved with
355 U. */
356 up_event = Qnil;
358 /* Set SPECS to the interactive form, or barf if not interactive. */
360 Lisp_Object form;
361 GCPRO2 (function, prefix_arg);
362 form = Finteractive_form (function);
363 UNGCPRO;
364 if (CONSP (form))
365 specs = filter_specs = Fcar (XCDR (form));
366 else
367 wrong_type_argument (Qcommandp, function);
370 /* If SPECS is not a string, invent one. */
371 if (! STRINGP (specs))
373 Lisp_Object input;
374 Lisp_Object funval = Findirect_function (function, Qt);
375 uintmax_t events = num_input_events;
376 input = specs;
377 /* Compute the arg values using the user's expression. */
378 GCPRO2 (input, filter_specs);
379 specs = Feval (specs,
380 CONSP (funval) && EQ (Qclosure, XCAR (funval))
381 ? CAR_SAFE (XCDR (funval)) : Qnil);
382 UNGCPRO;
383 if (events != num_input_events || !NILP (record_flag))
385 /* We should record this command on the command history. */
386 Lisp_Object values;
387 Lisp_Object this_cmd;
388 /* Make a copy of the list of values, for the command history,
389 and turn them into things we can eval. */
390 values = quotify_args (Fcopy_sequence (specs));
391 fix_command (input, values);
392 this_cmd = Fcons (function, values);
393 if (history_delete_duplicates)
394 Vcommand_history = Fdelete (this_cmd, Vcommand_history);
395 Vcommand_history = Fcons (this_cmd, Vcommand_history);
397 /* Don't keep command history around forever. */
398 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
400 teml = Fnthcdr (Vhistory_length, Vcommand_history);
401 if (CONSP (teml))
402 XSETCDR (teml, Qnil);
406 Vthis_command = save_this_command;
407 Vthis_original_command = save_this_original_command;
408 Vreal_this_command = save_real_this_command;
409 kset_last_command (current_kboard, save_last_command);
412 Lisp_Object args[3];
413 args[0] = Qfuncall_interactively;
414 args[1] = function;
415 args[2] = specs;
416 Lisp_Object result = unbind_to (speccount, Fapply (3, args));
417 SAFE_FREE ();
418 return result;
422 /* SPECS is set to a string; use it as an interactive prompt.
423 Copy it so that STRING will be valid even if a GC relocates SPECS. */
424 SAFE_ALLOCA_STRING (string, specs);
426 /* Here if function specifies a string to control parsing the defaults. */
428 /* Set next_event to point to the first event with parameters. */
429 for (next_event = 0; next_event < key_count; next_event++)
430 if (EVENT_HAS_PARAMETERS (AREF (keys, next_event)))
431 break;
433 /* Handle special starting chars `*' and `@'. Also `-'. */
434 /* Note that `+' is reserved for user extensions. */
435 while (1)
437 if (*string == '+')
438 error ("`+' is not used in `interactive' for ordinary commands");
439 else if (*string == '*')
441 string++;
442 if (!NILP (BVAR (current_buffer, read_only)))
444 if (!NILP (record_flag))
446 char *p = string;
447 while (*p)
449 if (! (*p == 'r' || *p == 'p' || *p == 'P'
450 || *p == '\n'))
451 Fbarf_if_buffer_read_only ();
452 p++;
454 record_then_fail = 1;
456 else
457 Fbarf_if_buffer_read_only ();
460 /* Ignore this for semi-compatibility with Lucid. */
461 else if (*string == '-')
462 string++;
463 else if (*string == '@')
465 Lisp_Object event, w;
467 event = (next_event < key_count
468 ? AREF (keys, next_event)
469 : Qnil);
470 if (EVENT_HAS_PARAMETERS (event)
471 && (w = XCDR (event), CONSP (w))
472 && (w = XCAR (w), CONSP (w))
473 && (w = XCAR (w), WINDOWP (w)))
475 if (MINI_WINDOW_P (XWINDOW (w))
476 && ! (minibuf_level > 0 && EQ (w, minibuf_window)))
477 error ("Attempt to select inactive minibuffer window");
479 /* If the current buffer wants to clean up, let it. */
480 Frun_hooks (1, &Qmouse_leave_buffer_hook);
482 Fselect_window (w, Qnil);
484 string++;
486 else if (*string == '^')
488 call0 (Qhandle_shift_selection);
489 string++;
491 else break;
494 /* Count the number of arguments, which is two (the function itself and
495 `funcall-interactively') plus the number of arguments the interactive spec
496 would have us give to the function. */
497 tem = string;
498 for (nargs = 2; *tem; )
500 /* 'r' specifications ("point and mark as 2 numeric args")
501 produce *two* arguments. */
502 if (*tem == 'r')
503 nargs += 2;
504 else
505 nargs++;
506 tem = strchr (tem, '\n');
507 if (tem)
508 ++tem;
509 else
510 break;
513 if (MOST_POSITIVE_FIXNUM < min (PTRDIFF_MAX, SIZE_MAX) / word_size
514 && MOST_POSITIVE_FIXNUM < nargs)
515 memory_full (SIZE_MAX);
517 /* Allocate them all at one go. This wastes a bit of memory, but
518 it's OK to trade space for speed. */
519 SAFE_NALLOCA (args, 3, nargs);
520 visargs = args + nargs;
521 varies = (signed char *) (visargs + nargs);
523 for (i = 0; i < nargs; i++)
525 args[i] = Qnil;
526 visargs[i] = Qnil;
527 varies[i] = 0;
530 GCPRO5 (prefix_arg, function, *args, *visargs, up_event);
531 gcpro3.nvars = nargs;
532 gcpro4.nvars = nargs;
534 if (!NILP (enable))
535 specbind (Qenable_recursive_minibuffers, Qt);
537 tem = string;
538 for (i = 2; *tem; i++)
540 visargs[1] = make_string (tem + 1, strcspn (tem + 1, "\n"));
541 if (strchr (SSDATA (visargs[1]), '%'))
542 callint_message = Fformat (i - 1, visargs + 1);
543 else
544 callint_message = visargs[1];
546 switch (*tem)
548 case 'a': /* Symbol defined as a function. */
549 visargs[i] = Fcompleting_read (callint_message,
550 Vobarray, Qfboundp, Qt,
551 Qnil, Qnil, Qnil, Qnil);
552 /* Passing args[i] directly stimulates compiler bug. */
553 teml = visargs[i];
554 args[i] = Fintern (teml, Qnil);
555 break;
557 case 'b': /* Name of existing buffer. */
558 args[i] = Fcurrent_buffer ();
559 if (EQ (selected_window, minibuf_window))
560 args[i] = Fother_buffer (args[i], Qnil, Qnil);
561 args[i] = Fread_buffer (callint_message, args[i], Qt);
562 break;
564 case 'B': /* Name of buffer, possibly nonexistent. */
565 args[i] = Fread_buffer (callint_message,
566 Fother_buffer (Fcurrent_buffer (), Qnil, Qnil),
567 Qnil);
568 break;
570 case 'c': /* Character. */
571 /* Prompt in `minibuffer-prompt' face. */
572 Fput_text_property (make_number (0),
573 make_number (SCHARS (callint_message)),
574 Qface, Qminibuffer_prompt, callint_message);
575 args[i] = Fread_char (callint_message, Qnil, Qnil);
576 message1_nolog (0);
577 /* Passing args[i] directly stimulates compiler bug. */
578 teml = args[i];
579 /* See bug#8479. */
580 if (! CHARACTERP (teml)) error ("Non-character input-event");
581 visargs[i] = Fchar_to_string (teml);
582 break;
584 case 'C': /* Command: symbol with interactive function. */
585 visargs[i] = Fcompleting_read (callint_message,
586 Vobarray, Qcommandp,
587 Qt, Qnil, Qnil, Qnil, Qnil);
588 /* Passing args[i] directly stimulates compiler bug. */
589 teml = visargs[i];
590 args[i] = Fintern (teml, Qnil);
591 break;
593 case 'd': /* Value of point. Does not do I/O. */
594 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
595 args[i] = point_marker;
596 /* visargs[i] = Qnil; */
597 varies[i] = 1;
598 break;
600 case 'D': /* Directory name. */
601 args[i] = read_file_name (BVAR (current_buffer, directory), Qlambda, Qnil,
602 Qfile_directory_p);
603 break;
605 case 'f': /* Existing file name. */
606 args[i] = read_file_name (Qnil, Qlambda, Qnil, Qnil);
607 break;
609 case 'F': /* Possibly nonexistent file name. */
610 args[i] = read_file_name (Qnil, Qnil, Qnil, Qnil);
611 break;
613 case 'G': /* Possibly nonexistent file name,
614 default to directory alone. */
615 args[i] = read_file_name (Qnil, Qnil, empty_unibyte_string, Qnil);
616 break;
618 case 'i': /* Ignore an argument -- Does not do I/O. */
619 varies[i] = -1;
620 break;
622 case 'k': /* Key sequence. */
624 ptrdiff_t speccount1 = SPECPDL_INDEX ();
625 specbind (Qcursor_in_echo_area, Qt);
626 /* Prompt in `minibuffer-prompt' face. */
627 Fput_text_property (make_number (0),
628 make_number (SCHARS (callint_message)),
629 Qface, Qminibuffer_prompt, callint_message);
630 args[i] = Fread_key_sequence (callint_message,
631 Qnil, Qnil, Qnil, Qnil);
632 unbind_to (speccount1, Qnil);
633 teml = args[i];
634 visargs[i] = Fkey_description (teml, Qnil);
636 /* If the key sequence ends with a down-event,
637 discard the following up-event. */
638 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
639 if (CONSP (teml))
640 teml = XCAR (teml);
641 if (SYMBOLP (teml))
643 Lisp_Object tem2;
645 teml = Fget (teml, intern ("event-symbol-elements"));
646 /* Ignore first element, which is the base key. */
647 tem2 = Fmemq (intern ("down"), Fcdr (teml));
648 if (! NILP (tem2))
649 up_event = Fread_event (Qnil, Qnil, Qnil);
652 break;
654 case 'K': /* Key sequence to be defined. */
656 ptrdiff_t speccount1 = SPECPDL_INDEX ();
657 specbind (Qcursor_in_echo_area, Qt);
658 /* Prompt in `minibuffer-prompt' face. */
659 Fput_text_property (make_number (0),
660 make_number (SCHARS (callint_message)),
661 Qface, Qminibuffer_prompt, callint_message);
662 args[i] = Fread_key_sequence_vector (callint_message,
663 Qnil, Qt, Qnil, Qnil);
664 teml = args[i];
665 visargs[i] = Fkey_description (teml, Qnil);
666 unbind_to (speccount1, Qnil);
668 /* If the key sequence ends with a down-event,
669 discard the following up-event. */
670 teml = Faref (args[i], make_number (XINT (Flength (args[i])) - 1));
671 if (CONSP (teml))
672 teml = XCAR (teml);
673 if (SYMBOLP (teml))
675 Lisp_Object tem2;
677 teml = Fget (teml, intern ("event-symbol-elements"));
678 /* Ignore first element, which is the base key. */
679 tem2 = Fmemq (intern ("down"), Fcdr (teml));
680 if (! NILP (tem2))
681 up_event = Fread_event (Qnil, Qnil, Qnil);
684 break;
686 case 'U': /* Up event from last k or K. */
687 if (!NILP (up_event))
689 args[i] = Fmake_vector (make_number (1), up_event);
690 up_event = Qnil;
691 teml = args[i];
692 visargs[i] = Fkey_description (teml, Qnil);
694 break;
696 case 'e': /* The invoking event. */
697 if (next_event >= key_count)
698 error ("%s must be bound to an event with parameters",
699 (SYMBOLP (function)
700 ? SSDATA (SYMBOL_NAME (function))
701 : "command"));
702 args[i] = AREF (keys, next_event);
703 next_event++;
704 varies[i] = -1;
706 /* Find the next parameterized event. */
707 while (next_event < key_count
708 && !(EVENT_HAS_PARAMETERS (AREF (keys, next_event))))
709 next_event++;
711 break;
713 case 'm': /* Value of mark. Does not do I/O. */
714 check_mark (0);
715 /* visargs[i] = Qnil; */
716 args[i] = BVAR (current_buffer, mark);
717 varies[i] = 2;
718 break;
720 case 'M': /* String read via minibuffer with
721 inheriting the current input method. */
722 args[i] = Fread_string (callint_message,
723 Qnil, Qnil, Qnil, Qt);
724 break;
726 case 'N': /* Prefix arg as number, else number from minibuffer. */
727 if (!NILP (prefix_arg))
728 goto have_prefix_arg;
729 case 'n': /* Read number from minibuffer. */
730 args[i] = call1 (Qread_number, callint_message);
731 /* Passing args[i] directly stimulates compiler bug. */
732 teml = args[i];
733 visargs[i] = Fnumber_to_string (teml);
734 break;
736 case 'P': /* Prefix arg in raw form. Does no I/O. */
737 args[i] = prefix_arg;
738 /* visargs[i] = Qnil; */
739 varies[i] = -1;
740 break;
742 case 'p': /* Prefix arg converted to number. No I/O. */
743 have_prefix_arg:
744 args[i] = Fprefix_numeric_value (prefix_arg);
745 /* visargs[i] = Qnil; */
746 varies[i] = -1;
747 break;
749 case 'r': /* Region, point and mark as 2 args. */
750 check_mark (1);
751 set_marker_both (point_marker, Qnil, PT, PT_BYTE);
752 /* visargs[i+1] = Qnil; */
753 mark = marker_position (BVAR (current_buffer, mark));
754 /* visargs[i] = Qnil; */
755 args[i] = PT < mark ? point_marker : BVAR (current_buffer, mark);
756 varies[i] = 3;
757 args[++i] = PT > mark ? point_marker : BVAR (current_buffer, mark);
758 varies[i] = 4;
759 break;
761 case 's': /* String read via minibuffer without
762 inheriting the current input method. */
763 args[i] = Fread_string (callint_message,
764 Qnil, Qnil, Qnil, Qnil);
765 break;
767 case 'S': /* Any symbol. */
768 visargs[i] = Fread_string (callint_message,
769 Qnil, Qnil, Qnil, Qnil);
770 /* Passing args[i] directly stimulates compiler bug. */
771 teml = visargs[i];
772 args[i] = Fintern (teml, Qnil);
773 break;
775 case 'v': /* Variable name: symbol that is
776 custom-variable-p. */
777 args[i] = Fread_variable (callint_message, Qnil);
778 visargs[i] = last_minibuf_string;
779 break;
781 case 'x': /* Lisp expression read but not evaluated. */
782 args[i] = call1 (intern ("read-minibuffer"), callint_message);
783 visargs[i] = last_minibuf_string;
784 break;
786 case 'X': /* Lisp expression read and evaluated. */
787 args[i] = call1 (intern ("eval-minibuffer"), callint_message);
788 visargs[i] = last_minibuf_string;
789 break;
791 case 'Z': /* Coding-system symbol, or ignore the
792 argument if no prefix. */
793 if (NILP (prefix_arg))
795 args[i] = Qnil;
796 varies[i] = -1;
798 else
800 args[i]
801 = Fread_non_nil_coding_system (callint_message);
802 visargs[i] = last_minibuf_string;
804 break;
806 case 'z': /* Coding-system symbol or nil. */
807 args[i] = Fread_coding_system (callint_message, Qnil);
808 visargs[i] = last_minibuf_string;
809 break;
811 /* We have a case for `+' so we get an error
812 if anyone tries to define one here. */
813 case '+':
814 default:
815 error ("Invalid control letter `%c' (#o%03o, #x%04x) in interactive calling string",
816 STRING_CHAR ((unsigned char *) tem),
817 (unsigned) STRING_CHAR ((unsigned char *) tem),
818 (unsigned) STRING_CHAR ((unsigned char *) tem));
821 if (varies[i] == 0)
822 arg_from_tty = 1;
824 if (NILP (visargs[i]) && STRINGP (args[i]))
825 visargs[i] = args[i];
827 tem = strchr (tem, '\n');
828 if (tem) tem++;
829 else tem = "";
831 unbind_to (speccount, Qnil);
833 QUIT;
835 args[0] = Qfuncall_interactively;
836 args[1] = function;
838 if (arg_from_tty || !NILP (record_flag))
840 /* We don't need `visargs' any more, so let's recycle it since we need
841 an array of just the same size. */
842 visargs[1] = function;
843 for (i = 2; i < nargs; i++)
845 if (varies[i] > 0)
846 visargs[i] = list1 (intern (callint_argfuns[varies[i]]));
847 else
848 visargs[i] = quotify_arg (args[i]);
850 Vcommand_history = Fcons (Flist (nargs - 1, visargs + 1),
851 Vcommand_history);
852 /* Don't keep command history around forever. */
853 if (INTEGERP (Vhistory_length) && XINT (Vhistory_length) > 0)
855 teml = Fnthcdr (Vhistory_length, Vcommand_history);
856 if (CONSP (teml))
857 XSETCDR (teml, Qnil);
861 /* If we used a marker to hold point, mark, or an end of the region,
862 temporarily, convert it to an integer now. */
863 for (i = 2; i < nargs; i++)
864 if (varies[i] >= 1 && varies[i] <= 4)
865 XSETINT (args[i], marker_position (args[i]));
867 if (record_then_fail)
868 Fbarf_if_buffer_read_only ();
870 Vthis_command = save_this_command;
871 Vthis_original_command = save_this_original_command;
872 Vreal_this_command = save_real_this_command;
873 kset_last_command (current_kboard, save_last_command);
876 Lisp_Object val = Ffuncall (nargs, args);
877 UNGCPRO;
878 val = unbind_to (speccount, val);
879 SAFE_FREE ();
880 return val;
884 DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
885 1, 1, 0,
886 doc: /* Return numeric meaning of raw prefix argument RAW.
887 A raw prefix argument is what you get from `(interactive "P")'.
888 Its numeric meaning is what you would get from `(interactive "p")'. */)
889 (Lisp_Object raw)
891 Lisp_Object val;
893 if (NILP (raw))
894 XSETFASTINT (val, 1);
895 else if (EQ (raw, Qminus))
896 XSETINT (val, -1);
897 else if (CONSP (raw) && INTEGERP (XCAR (raw)))
898 XSETINT (val, XINT (XCAR (raw)));
899 else if (INTEGERP (raw))
900 val = raw;
901 else
902 XSETFASTINT (val, 1);
904 return val;
907 void
908 syms_of_callint (void)
910 point_marker = Fmake_marker ();
911 staticpro (&point_marker);
913 callint_message = Qnil;
914 staticpro (&callint_message);
916 preserved_fns = listn (CONSTYPE_PURE, 4,
917 intern_c_string ("region-beginning"),
918 intern_c_string ("region-end"),
919 intern_c_string ("point"),
920 intern_c_string ("mark"));
922 DEFSYM (Qlist, "list");
923 DEFSYM (Qlet, "let");
924 DEFSYM (Qif, "if");
925 DEFSYM (Qwhen, "when");
926 DEFSYM (Qletx, "let*");
927 DEFSYM (Qsave_excursion, "save-excursion");
928 DEFSYM (Qprogn, "progn");
929 DEFSYM (Qminus, "-");
930 DEFSYM (Qplus, "+");
931 DEFSYM (Qhandle_shift_selection, "handle-shift-selection");
932 DEFSYM (Qread_number, "read-number");
933 DEFSYM (Qfuncall_interactively, "funcall-interactively");
934 DEFSYM (Qcommand_debug_status, "command-debug-status");
935 DEFSYM (Qenable_recursive_minibuffers, "enable-recursive-minibuffers");
936 DEFSYM (Qmouse_leave_buffer_hook, "mouse-leave-buffer-hook");
938 DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
939 doc: /* The value of the prefix argument for the next editing command.
940 It may be a number, or the symbol `-' for just a minus sign as arg,
941 or a list whose car is a number for just one or more C-u's
942 or nil if no argument has been specified.
944 You cannot examine this variable to find the argument for this command
945 since it has been set to nil by the time you can look.
946 Instead, you should use the variable `current-prefix-arg', although
947 normally commands can get this prefix argument with (interactive "P"). */);
949 DEFVAR_KBOARD ("last-prefix-arg", Vlast_prefix_arg,
950 doc: /* The value of the prefix argument for the previous editing command.
951 See `prefix-arg' for the meaning of the value. */);
953 DEFVAR_LISP ("current-prefix-arg", Vcurrent_prefix_arg,
954 doc: /* The value of the prefix argument for this editing command.
955 It may be a number, or the symbol `-' for just a minus sign as arg,
956 or a list whose car is a number for just one or more C-u's
957 or nil if no argument has been specified.
958 This is what `(interactive \"P\")' returns. */);
959 Vcurrent_prefix_arg = Qnil;
961 DEFVAR_LISP ("command-history", Vcommand_history,
962 doc: /* List of recent commands that read arguments from terminal.
963 Each command is represented as a form to evaluate.
965 Maximum length of the history list is determined by the value
966 of `history-length', which see. */);
967 Vcommand_history = Qnil;
969 DEFVAR_LISP ("command-debug-status", Vcommand_debug_status,
970 doc: /* Debugging status of current interactive command.
971 Bound each time `call-interactively' is called;
972 may be set by the debugger as a reminder for itself. */);
973 Vcommand_debug_status = Qnil;
975 DEFVAR_LISP ("mark-even-if-inactive", Vmark_even_if_inactive,
976 doc: /* Non-nil means you can use the mark even when inactive.
977 This option makes a difference in Transient Mark mode.
978 When the option is non-nil, deactivation of the mark
979 turns off region highlighting, but commands that use the mark
980 behave as if the mark were still active. */);
981 Vmark_even_if_inactive = Qt;
983 DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook,
984 doc: /* Hook to run when about to switch windows with a mouse command.
985 Its purpose is to give temporary modes such as Isearch mode
986 a way to turn themselves off when a mouse command switches windows. */);
987 Vmouse_leave_buffer_hook = Qnil;
989 defsubr (&Sinteractive);
990 defsubr (&Scall_interactively);
991 defsubr (&Sfuncall_interactively);
992 defsubr (&Sprefix_numeric_value);