(Fcall_interactively): Bind cursor-in-echo-area to t for `k' and `K'.
[bpt/emacs.git] / src / callint.c
index 724e37f..5cedc44 100644 (file)
@@ -15,7 +15,8 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with GNU Emacs; see the file COPYING.  If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
 
 
 #include <config.h>
@@ -28,8 +29,9 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 
 extern char *index ();
 
-int current_prefix_partial;
-Lisp_Object Vprefix_arg, Vcurrent_prefix_arg, Qminus, Qplus;
+extern Lisp_Object Qcursor_in_echo_area;
+
+Lisp_Object Vcurrent_prefix_arg, Qminus, Qplus;
 Lisp_Object Qcall_interactively;
 Lisp_Object Vcommand_history;
 
@@ -42,51 +44,17 @@ Lisp_Object Vmark_even_if_inactive;
 
 Lisp_Object Vmouse_leave_buffer_hook, Qmouse_leave_buffer_hook;
 
-Lisp_Object Qlist;
+Lisp_Object Qlist, Qlet, Qletx, Qsave_excursion;
 static Lisp_Object preserved_fns;
 
 /* Marker used within call-interactively to refer to point.  */
 static Lisp_Object point_marker;
 
+/* Buffer for the prompt text used in Fcall_interactively.  */
+static char *callint_message;
 
-void
-clear_prefix_arg ()
-{
-  Vprefix_arg = Qnil;
-  if (!current_prefix_partial)
-    {
-      current_kboard->prefix_factor = Qnil;
-      current_kboard->prefix_value = Qnil;
-      current_kboard->prefix_sign = 1;
-      current_kboard->prefix_partial = 0;
-    }
-}
-
-void
-finalize_prefix_arg ()
-{
-  if (!NILP (current_kboard->prefix_factor))
-    Vprefix_arg = Fcons (current_kboard->prefix_factor, Qnil);
-  else if (NILP (current_kboard->prefix_value))
-    Vprefix_arg = (current_kboard->prefix_sign > 0 ? Qnil : Qminus);
-  else if (current_kboard->prefix_sign > 0)
-    Vprefix_arg = current_kboard->prefix_value;
-  else
-    XSETINT (Vprefix_arg, -XINT (current_kboard->prefix_value));
-  current_kboard->prefix_partial = 0;
-}
-
-static void
-describe_prefix_arg ()
-{
-  if (INTEGERP (Vprefix_arg))
-    message ("Arg: %d", Vprefix_arg);
-  else if (CONSP (Vprefix_arg))
-    message ("Arg: [%d]", XCONS (Vprefix_arg)->car);
-  else if (EQ (Vprefix_arg, Qminus))
-    message ("Arg: -");
-}
-
+/* Allocated length of that buffer.  */
+static int callint_message_size;
 
 /* This comment supplies the doc string for interactive,
    for make-docfile to see.  We cannot put this in the real DEFUN
@@ -199,8 +167,9 @@ check_mark ()
 }
 
 
-DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 2, 0,
+DEFUN ("call-interactively", Fcall_interactively, Scall_interactively, 1, 3, 0,
   "Call FUNCTION, reading args according to its interactive calling specs.\n\
+Return the value FUNCTION returns.\n\
 The function contains a specification of how to do the argument reading.\n\
 In the case of user-defined functions, this is specified by placing a call\n\
 to the function `interactive' at the top level of the function body.\n\
@@ -209,8 +178,8 @@ See `interactive'.\n\
 Optional second arg RECORD-FLAG non-nil\n\
 means unconditionally put this command in the command-history.\n\
 Otherwise, this is done only if an arg is read using the minibuffer.")
-  (function, record)
-     Lisp_Object function, record;
+  (function, record_flag, keys)
+     Lisp_Object function, record_flag, keys;
 {
   Lisp_Object *args, *visargs;
   unsigned char **argstrings;
@@ -236,11 +205,19 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
 
   register int i, j;
   int count, foo;
-  char prompt[100];
   char prompt1[100];
   char *tem1;
   int arg_from_tty = 0;
   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
+  int key_count;
+
+  if (NILP (keys))
+    keys = this_command_keys, key_count = this_command_key_count;
+  else
+    {
+      CHECK_VECTOR (keys, 3);
+      key_count = XVECTOR (keys)->size;
+    }
 
   /* Save this now, since use of minibuffer will clobber it. */
   prefix_arg = Vcurrent_prefix_arg;
@@ -296,9 +273,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
     }
   else if (EQ (funcar, Qmocklisp))
     {
-#ifdef MULTI_KBOARD
-      kboard_locked = 1;
-#endif
+      single_kboard_state ();
       return ml_apply (fun, Qinteractive);
     }
   else
@@ -319,7 +294,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
       input = specs;
       /* Compute the arg values using the user's expression.  */
       specs = Feval (specs);
-      if (i != num_input_chars || !NILP (record))
+      if (i != num_input_chars || !NILP (record_flag))
        {
          /* We should record this command on the command history.  */
          Lisp_Object values, car;
@@ -330,47 +305,58 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
             look for elements that were computed with (region-beginning)
             or (region-end), and put those expressions into VALUES
             instead of the present values.  */
-         car = Fcar (input);
-         if (EQ (car, Qlist))
+         if (CONSP (input))
            {
-             Lisp_Object intail, valtail;
-             for (intail = Fcdr (input), valtail = values;
-                  CONSP (valtail);
-                  intail = Fcdr (intail), valtail = Fcdr (valtail))
+             car = XCONS (input)->car;
+             /* Skip through certain special forms.  */
+             while (EQ (car, Qlet) || EQ (car, Qletx)
+                    || EQ (car, Qsave_excursion))
                {
-                 Lisp_Object elt;
-                 elt = Fcar (intail);
-                 if (CONSP (elt))
+                 while (CONSP (XCONS (input)->cdr))
+                   input = XCONS (input)->cdr;
+                 input = XCONS (input)->car;
+                 if (!CONSP (input))
+                   break;
+                 car = XCONS (input)->car;
+               }
+             if (EQ (car, Qlist))
+               {
+                 Lisp_Object intail, valtail;
+                 for (intail = Fcdr (input), valtail = values;
+                      CONSP (valtail);
+                      intail = Fcdr (intail), valtail = Fcdr (valtail))
                    {
-                     Lisp_Object presflag;
-                     presflag = Fmemq (Fcar (elt), preserved_fns);
-                     if (!NILP (presflag))
-                       Fsetcar (valtail, Fcar (intail));
+                     Lisp_Object elt;
+                     elt = Fcar (intail);
+                     if (CONSP (elt))
+                       {
+                         Lisp_Object presflag;
+                         presflag = Fmemq (Fcar (elt), preserved_fns);
+                         if (!NILP (presflag))
+                           Fsetcar (valtail, Fcar (intail));
+                       }
                    }
                }
            }
          Vcommand_history
            = Fcons (Fcons (function, values), Vcommand_history);
        }
-#ifdef MULTI_KBOARD
-      kboard_locked = 1;
-#endif
+      single_kboard_state ();
       return apply1 (function, specs);
     }
 
   /* Here if function specifies a string to control parsing the defaults */
 
   /* Set next_event to point to the first event with parameters.  */
-  for (next_event = 0; next_event < this_command_key_count; next_event++)
-    if (EVENT_HAS_PARAMETERS
-       (XVECTOR (this_command_keys)->contents[next_event]))
+  for (next_event = 0; next_event < key_count; next_event++)
+    if (EVENT_HAS_PARAMETERS (XVECTOR (keys)->contents[next_event]))
       break;
   
   /* Handle special starting chars `*' and `@'.  Also `-'.  */
   /* Note that `+' is reserved for user extensions.  */
   while (1)
     {
-      if (*string = '+')
+      if (*string == '+')
        error ("`+' is not used in `interactive' for ordinary commands");
       else if (*string == '*')
        {
@@ -385,11 +371,11 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
        {
          Lisp_Object event;
 
-         event = XVECTOR (this_command_keys)->contents[next_event];
+         event = XVECTOR (keys)->contents[next_event];
          if (EVENT_HAS_PARAMETERS (event)
+             && (event = XCONS (event)->cdr, CONSP (event))
              && (event = XCONS (event)->car, CONSP (event))
-             && (event = XCONS (event)->car, CONSP (event))
-             && (event = XCONS (event)->car), WINDOWP (event))
+             && (event = XCONS (event)->car, WINDOWP (event)))
            {
              if (MINI_WINDOW_P (XWINDOW (event))
                  && ! (minibuf_level > 0 && EQ (event, minibuf_window)))
@@ -456,12 +442,26 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
            ? (unsigned char *) ""
              : XSTRING (visargs[j])->data;
 
-      doprnt (prompt, sizeof prompt, prompt1, 0, j - 1, argstrings + 1);
+      /* Process the format-string in prompt1, putting the output
+        into callint_message.  Make callint_message bigger if necessary.
+        We don't use a buffer on the stack, because the contents
+        need to stay stable for a while.  */
+      while (1)
+       {
+         int nchars = doprnt (callint_message, callint_message_size,
+                              prompt1, (char *)0,
+                              j - 1, argstrings + 1);
+         if (nchars < callint_message_size)
+           break;
+         callint_message_size *= 2;
+         callint_message
+           = (char *) xrealloc (callint_message, callint_message_size);
+       }
 
       switch (*tem)
        {
        case 'a':               /* Symbol defined as a function */
-         visargs[i] = Fcompleting_read (build_string (prompt),
+         visargs[i] = Fcompleting_read (build_string (callint_message),
                                         Vobarray, Qfboundp, Qt, Qnil, Qnil);
          /* Passing args[i] directly stimulates compiler bug */
          teml = visargs[i];
@@ -472,25 +472,29 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
          args[i] = Fcurrent_buffer ();
          if (EQ (selected_window, minibuf_window))
            args[i] = Fother_buffer (args[i], Qnil);
-         args[i] = Fread_buffer (build_string (prompt), args[i], Qt);
+         args[i] = Fread_buffer (build_string (callint_message), args[i], Qt);
          break;
 
        case 'B':               /* Name of buffer, possibly nonexistent */
-         args[i] = Fread_buffer (build_string (prompt),
+         args[i] = Fread_buffer (build_string (callint_message),
                                  Fother_buffer (Fcurrent_buffer (), Qnil),
                                  Qnil);
          break;
 
         case 'c':              /* Character */
-         message1 (prompt);
+         /* Use message_nolog rather than message1_nolog here,
+            so that nothing bad happens if callint_message is changed
+            within Fread_char (by a timer, for example).  */
+         message_nolog ("%s", callint_message);
          args[i] = Fread_char ();
+         message1_nolog ((char *) 0);
          /* Passing args[i] directly stimulates compiler bug */
          teml = args[i];
          visargs[i] = Fchar_to_string (teml);
          break;
 
        case 'C':               /* Command: symbol with interactive function */
-         visargs[i] = Fcompleting_read (build_string (prompt),
+         visargs[i] = Fcompleting_read (build_string (callint_message),
                                         Vobarray, Qcommandp, Qt, Qnil, Qnil);
          /* Passing args[i] directly stimulates compiler bug */
          teml = visargs[i];
@@ -505,45 +509,57 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
          break;
 
        case 'D':               /* Directory name. */
-         args[i] = Fread_file_name (build_string (prompt), Qnil,
+         args[i] = Fread_file_name (build_string (callint_message), Qnil,
                                     current_buffer->directory, Qlambda, Qnil);
          break;
 
        case 'f':               /* Existing file name. */
-         args[i] = Fread_file_name (build_string (prompt),
+         args[i] = Fread_file_name (build_string (callint_message),
                                     Qnil, Qnil, Qlambda, Qnil);
          break;
 
        case 'F':               /* Possibly nonexistent file name. */
-         args[i] = Fread_file_name (build_string (prompt),
+         args[i] = Fread_file_name (build_string (callint_message),
                                     Qnil, Qnil, Qnil, Qnil);
          break;
 
        case 'k':               /* Key sequence. */
-         args[i] = Fread_key_sequence (build_string (prompt), Qnil, Qnil, Qnil);
-         teml = args[i];
-         visargs[i] = Fkey_description (teml);
+         {
+           int speccount1 = specpdl_ptr - specpdl;
+           specbind (Qcursor_in_echo_area, Qt);
+           args[i] = Fread_key_sequence (build_string (callint_message),
+                                         Qnil, Qnil, Qnil);
+           unbind_to (speccount1, Qnil);
+           teml = args[i];
+           visargs[i] = Fkey_description (teml);
+         }
          break;
 
        case 'K':               /* Key sequence to be defined. */
-         args[i] = Fread_key_sequence (build_string (prompt), Qnil, Qt, Qnil);
-         teml = args[i];
-         visargs[i] = Fkey_description (teml);
+         {
+           int speccount1 = specpdl_ptr - specpdl;
+           specbind (Qcursor_in_echo_area, Qt);
+           args[i] = Fread_key_sequence (build_string (callint_message),
+                                         Qnil, Qt, Qnil);
+           teml = args[i];
+           visargs[i] = Fkey_description (teml);
+           unbind_to (speccount1, Qnil);
+         }
          break;
 
        case 'e':               /* The invoking event.  */
-         if (next_event >= this_command_key_count)
+         if (next_event >= key_count)
            error ("%s must be bound to an event with parameters",
                   (SYMBOLP (function)
                    ? (char *) XSYMBOL (function)->name->data
                    : "command"));
-         args[i] = XVECTOR (this_command_keys)->contents[next_event++];
+         args[i] = XVECTOR (keys)->contents[next_event++];
          varies[i] = -1;
 
          /* Find the next parameterized event.  */
-         while (next_event < this_command_key_count
+         while (next_event < key_count
                 && ! (EVENT_HAS_PARAMETERS
-                      (XVECTOR (this_command_keys)->contents[next_event])))
+                      (XVECTOR (keys)->contents[next_event])))
            next_event++;
 
          break;
@@ -559,20 +575,38 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
          if (!NILP (prefix_arg))
            goto have_prefix_arg;
        case 'n':               /* Read number from minibuffer.  */
-         do
-           args[i] = Fread_minibuffer (build_string (prompt), Qnil);
-         while (! NUMBERP (args[i]));
+         {
+           int first = 1;
+           do
+             {
+               Lisp_Object tem;
+               if (!  first)
+                 {
+                   message ("Please enter a number.");
+                   sit_for (1, 0, 0, 0);
+                 }
+               first = 0;
+
+               tem = Fread_from_minibuffer (build_string (callint_message),
+                                            Qnil, Qnil, Qnil, Qnil);
+               if (! STRINGP (tem) || XSTRING (tem)->size == 0)
+                 args[i] = Qnil;
+               else
+                 args[i] = Fread (tem);
+             }
+           while (! NUMBERP (args[i]));
+         }
          visargs[i] = last_minibuf_string;
          break;
 
        case 'P':               /* Prefix arg in raw form.  Does no I/O.  */
-       have_prefix_arg:
          args[i] = prefix_arg;
          /* visargs[i] = Qnil; */
          varies[i] = -1;
          break;
 
        case 'p':               /* Prefix arg converted to number.  No I/O. */
+       have_prefix_arg:
          args[i] = Fprefix_numeric_value (prefix_arg);
          /* visargs[i] = Qnil; */
          varies[i] = -1;
@@ -584,18 +618,19 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
          /* visargs[i+1] = Qnil; */
          foo = marker_position (current_buffer->mark);
          /* visargs[i] = Qnil; */
-         args[i] = point < foo ? point_marker : current_buffer->mark;
+         args[i] = PT < foo ? point_marker : current_buffer->mark;
          varies[i] = 3;
-         args[++i] = point > foo ? point_marker : current_buffer->mark;
+         args[++i] = PT > foo ? point_marker : current_buffer->mark;
          varies[i] = 4;
          break;
 
        case 's':               /* String read via minibuffer.  */
-         args[i] = Fread_string (build_string (prompt), Qnil, Qnil);
+         args[i] = Fread_string (build_string (callint_message), Qnil, Qnil);
          break;
 
        case 'S':               /* Any symbol.  */
-         visargs[i] = Fread_string (build_string (prompt), Qnil, Qnil);
+         visargs[i] = Fread_string (build_string (callint_message),
+                                    Qnil, Qnil);
          /* Passing args[i] directly stimulates compiler bug */
          teml = visargs[i];
          args[i] = Fintern (teml, Qnil);
@@ -603,17 +638,17 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
 
        case 'v':               /* Variable name: symbol that is
                                   user-variable-p. */
-         args[i] = Fread_variable (build_string (prompt));
+         args[i] = Fread_variable (build_string (callint_message));
          visargs[i] = last_minibuf_string;
          break;
 
        case 'x':               /* Lisp expression read but not evaluated */
-         args[i] = Fread_minibuffer (build_string (prompt), Qnil);
+         args[i] = Fread_minibuffer (build_string (callint_message), Qnil);
          visargs[i] = last_minibuf_string;
          break;
 
        case 'X':               /* Lisp expression read and evaluated */
-         args[i] = Feval_minibuffer (build_string (prompt), Qnil);
+         args[i] = Feval_minibuffer (build_string (callint_message), Qnil);
          visargs[i] = last_minibuf_string;
          break;
 
@@ -641,7 +676,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
 
   args[0] = function;
 
-  if (arg_from_tty || !NILP (record))
+  if (arg_from_tty || !NILP (record_flag))
     {
       visargs[0] = function;
       for (i = 1; i < count + 1; i++)
@@ -661,9 +696,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
     if (varies[i] >= 1 && varies[i] <= 4)
       XSETINT (args[i], marker_position (args[i]));
 
-#ifdef MULTI_KBOARD
-  kboard_locked = 1;
-#endif
+  single_kboard_state ();
 
   {
     Lisp_Object val;
@@ -677,7 +710,7 @@ Otherwise, this is done only if an arg is read using the minibuffer.")
 
 DEFUN ("prefix-numeric-value", Fprefix_numeric_value, Sprefix_numeric_value,
   1, 1, 0,
-  "Return numeric meaning of raw prefix argument ARG.\n\
+  "Return numeric meaning of raw prefix argument RAW.\n\
 A raw prefix argument is what you get from `(interactive \"P\")'.\n\
 Its numeric meaning is what you would get from `(interactive \"p\")'.")
   (raw)
@@ -689,7 +722,7 @@ Its numeric meaning is what you would get from `(interactive \"p\")'.")
     XSETFASTINT (val, 1);
   else if (EQ (raw, Qminus))
     XSETINT (val, -1);
-  else if (CONSP (raw))
+  else if (CONSP (raw) && INTEGERP (XCONS (raw)->car))
     XSETINT (val, XINT (XCONS (raw)->car));
   else if (INTEGERP (raw))
     val = raw;
@@ -699,65 +732,6 @@ Its numeric meaning is what you would get from `(interactive \"p\")'.")
   return val;
 }
 
-DEFUN ("universal-argument", Funiversal_argument, Suniversal_argument, 0, 0, "",
-  "Begin a numeric argument for the following command.\n\
-Digits or minus sign following \\[universal-argument] make up the numeric argument.\n\
-\\[universal-argument] following the digits or minus sign ends the argument.\n\
-\\[universal-argument] without digits or minus sign provides 4 as argument.\n\
-Repeating \\[universal-argument] without digits or minus sign\n\
- multiplies the argument by 4 each time.")
-  ()
-{
-  if (!current_prefix_partial)
-    {
-      /* First C-u */
-      XSETFASTINT (current_kboard->prefix_factor, 4);
-      current_kboard->prefix_value = Qnil;
-      current_kboard->prefix_sign = 1;
-      current_kboard->prefix_partial = 1;
-    }
-  else if (!NILP (current_kboard->prefix_factor))
-    {
-      /* Subsequent C-u */
-      XSETINT (current_kboard->prefix_factor,
-              XINT (current_kboard->prefix_factor) * 4);
-      current_kboard->prefix_partial = 1;
-    }
-  else
-    {
-      /* Terminating C-u */
-      finalize_prefix_arg ();
-      describe_prefix_arg ();
-    }
-}
-
-DEFUN ("negative-argument", Fnegative_argument, Snegative_argument, 0, 0, "",
-  "Begin a negative numeric argument for the next command.\n\
-\\[universal-argument] following digits or minus sign ends the argument.")
-  ()
-{
-  current_kboard->prefix_factor = Qnil;
-  current_kboard->prefix_sign *= -1;
-  current_kboard->prefix_partial = 1;
-}
-
-DEFUN ("digit-argument", Fdigit_argument, Sdigit_argument, 0, 0, "",
-  "Part of the numeric argument for the next command.\n\
-\\[universal-argument] following digits or minus sign ends the argument.")
-  ()
-{
-  int c;
-  if (!(INTEGERP (last_command_char)
-       && (c = (XINT (last_command_char) & 0177)) >= '0' && c <= '9'))
-    error("digit-argument must be bound to a digit key");
-  current_kboard->prefix_factor = Qnil;
-  if (NILP (current_kboard->prefix_value))
-    XSETFASTINT (current_kboard->prefix_value, 0);
-  XSETINT (current_kboard->prefix_value,
-          XINT (current_kboard->prefix_value) * 10 + (c - '0'));
-  current_kboard->prefix_partial = 1;
-}
-
 syms_of_callint ()
 {
   point_marker = Fmake_marker ();
@@ -771,6 +745,12 @@ syms_of_callint ()
 
   Qlist = intern ("list");
   staticpro (&Qlist);
+  Qlet = intern ("let");
+  staticpro (&Qlet);
+  Qletx = intern ("let*");
+  staticpro (&Qletx);
+  Qsave_excursion = intern ("save-excursion");
+  staticpro (&Qsave_excursion);
 
   Qminus = intern ("-");
   staticpro (&Qminus);
@@ -790,7 +770,11 @@ syms_of_callint ()
   Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
   staticpro (&Qmouse_leave_buffer_hook);
 
-  DEFVAR_LISP ("prefix-arg", &Vprefix_arg,
+  callint_message_size = 100;
+  callint_message = (char *) xmalloc (callint_message_size);
+
+
+  DEFVAR_KBOARD ("prefix-arg", Vprefix_arg,
     "The value of the prefix argument for the next editing command.\n\
 It may be a number, or the symbol `-' for just a minus sign as arg,\n\
 or a list whose car is a number for just one or more C-U's\n\
@@ -800,7 +784,6 @@ You cannot examine this variable to find the argument for this command\n\
 since it has been set to nil by the time you can look.\n\
 Instead, you should use the variable `current-prefix-arg', although\n\
 normally commands can get this prefix argument with (interactive \"P\").");
-  Vprefix_arg = Qnil;
 
   DEFVAR_LISP ("current-prefix-arg", &Vcurrent_prefix_arg,
     "The value of the prefix argument for this editing command.\n\
@@ -838,7 +821,4 @@ a way to turn themselves off when a mouse command switches windows.");
   defsubr (&Sinteractive);
   defsubr (&Scall_interactively);
   defsubr (&Sprefix_numeric_value);
-  defsubr (&Suniversal_argument);
-  defsubr (&Snegative_argument);
-  defsubr (&Sdigit_argument);
 }