Change doc-string comments to `new style' [w/`doc:' keyword].
[bpt/emacs.git] / src / cmds.c
index 77a4114..09362a7 100644 (file)
@@ -1,5 +1,5 @@
 /* Simple built-in editing commands.
-   Copyright (C) 1985, 93, 94, 95, 1996 Free Software Foundation, Inc.
+   Copyright (C) 1985, 93, 94, 95, 96, 97, 1998, 2001 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -27,6 +27,8 @@ Boston, MA 02111-1307, USA.  */
 #include "syntax.h"
 #include "window.h"
 #include "keyboard.h"
+#include "keymap.h"
+#include "dispextern.h"
 
 Lisp_Object Qkill_forward_chars, Qkill_backward_chars, Vblink_paren_function;
 
@@ -41,55 +43,26 @@ Lisp_Object Vself_insert_face_command;
 
 extern Lisp_Object Qface;
 \f
-/* Return buffer position which is N characters after `point'.  */
-int
-forward_point (n)
-     int n;
-{
-  int pos = PT, c;
-
-  if (!NILP (current_buffer->enable_multibyte_characters))
-    {
-      /* Simply adding N to `point' doesn't work because of multi-byte
-        form.  We had better not use INC_POS and DEC_POS because they
-        check the gap position every time.  But, for the moment, we
-        need working code.  */
-      if (n > 0)
-       {
-         while (pos < ZV && n--) INC_POS (pos);
-         if (pos < ZV) n++;
-       }
-      else
-       {
-         while (pos > BEGV && n++) DEC_POS (pos);
-         if (pos > BEGV) n--;
-       }
-    }
-  pos += n;
-
-  return pos;
-}
-
 DEFUN ("forward-point", Fforward_point, Sforward_point, 1, 1, 0,
-  "Return buffer position N characters after (before if N negative) point.")
-  (n)
+       doc: /* Return buffer position N characters after (before if N negative) point.  */)
+     (n)
      Lisp_Object n;
 {
-  CHECK_NUMBER (n, 0);
+  CHECK_NUMBER (n);
 
-  return make_number (forward_point (XINT (n)));
+  return make_number (PT + XINT (n));
 }
 
 DEFUN ("forward-char", Fforward_char, Sforward_char, 0, 1, "p",
-  "Move point right N characters (left if N is negative).\n\
-On reaching end of buffer, stop and signal error.")
-  (n)
+       doc: /* Move point right N characters (left if N is negative).
+On reaching end of buffer, stop and signal error.  */)
+     (n)
      Lisp_Object n;
 {
   if (NILP (n))
     XSETFASTINT (n, 1);
   else
-    CHECK_NUMBER (n, 0);
+    CHECK_NUMBER (n);
 
   /* This used to just set point to point + XINT (n), and then check
      to see if it was within boundaries.  But now that SET_PT can
@@ -97,7 +70,7 @@ On reaching end of buffer, stop and signal error.")
      hooks, etcetera), that's not a good approach.  So we validate the
      proposed position, then set point.  */
   {
-    int new_point = forward_point (XINT (n));
+    int new_point = PT + XINT (n);
 
     if (new_point < BEGV)
       {
@@ -117,87 +90,107 @@ On reaching end of buffer, stop and signal error.")
 }
 
 DEFUN ("backward-char", Fbackward_char, Sbackward_char, 0, 1, "p",
-  "Move point left N characters (right if N is negative).\n\
-On attempt to pass beginning or end of buffer, stop and signal error.")
-  (n)
+       doc: /* Move point left N characters (right if N is negative).
+On attempt to pass beginning or end of buffer, stop and signal error.  */)
+     (n)
      Lisp_Object n;
 {
   if (NILP (n))
     XSETFASTINT (n, 1);
   else
-    CHECK_NUMBER (n, 0);
+    CHECK_NUMBER (n);
 
   XSETINT (n, - XINT (n));
   return Fforward_char (n);
 }
 
 DEFUN ("forward-line", Fforward_line, Sforward_line, 0, 1, "p",
-  "Move N lines forward (backward if N is negative).\n\
-Precisely, if point is on line I, move to the start of line I + N.\n\
-If there isn't room, go as far as possible (no error).\n\
-Returns the count of lines left to move.  If moving forward,\n\
-that is N - number of lines moved; if backward, N + number moved.\n\
-With positive N, a non-empty line at the end counts as one line\n\
-  successfully moved (for the return value).")
-  (n)
+       doc: /* Move N lines forward (backward if N is negative).
+Precisely, if point is on line I, move to the start of line I + N.
+If there isn't room, go as far as possible (no error).
+Returns the count of lines left to move.  If moving forward,
+that is N - number of lines moved; if backward, N + number moved.
+With positive N, a non-empty line at the end counts as one line
+  successfully moved (for the return value).  */)
+     (n)
      Lisp_Object n;
 {
-  int pos2 = PT;
-  int pos;
-  int count, shortage, negp;
+  int opoint = PT, opoint_byte = PT_BYTE;
+  int pos, pos_byte;
+  int count, shortage;
 
   if (NILP (n))
     count = 1;
   else
     {
-      CHECK_NUMBER (n, 0);
+      CHECK_NUMBER (n);
       count = XINT (n);
     }
 
-  negp = count <= 0;
-  pos = scan_buffer ('\n', pos2, 0, count - negp, &shortage, 1);
+  if (count <= 0)
+    shortage = scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, count - 1, 1);
+  else
+    shortage = scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, count, 1);
+
+  /* Since scan_newline does TEMP_SET_PT_BOTH,
+     and we want to set PT "for real",
+     go back to the old point and then come back here.  */
+  pos = PT;
+  pos_byte = PT_BYTE;
+  TEMP_SET_PT_BOTH (opoint, opoint_byte);
+  SET_PT_BOTH (pos, pos_byte);
+
   if (shortage > 0
-      && (negp
+      && (count <= 0
          || (ZV > BEGV
-             && pos != pos2
-             && FETCH_BYTE (pos - 1) != '\n')))
+             && PT != opoint
+             && (FETCH_BYTE (PT_BYTE - 1) != '\n'))))
     shortage--;
-  SET_PT (pos);
-  return make_number (negp ? - shortage : shortage);
+
+  return make_number (count <= 0 ? - shortage : shortage);
 }
 
-DEFUN ("beginning-of-line", Fbeginning_of_line, Sbeginning_of_line,
-  0, 1, "p",
-  "Move point to beginning of current line.\n\
-With argument N not nil or 1, move forward N - 1 lines first.\n\
-If scan reaches end of buffer, stop there without error.")
-  (n)
+DEFUN ("beginning-of-line", Fbeginning_of_line, Sbeginning_of_line, 0, 1, "p",
+       doc: /* Move point to beginning of current line.
+With argument N not nil or 1, move forward N - 1 lines first.
+If point reaches the beginning or end of buffer, it stops there.
+
+This command does not move point across a field boundary unless doing so
+would move beyond there to a different line; If N is nil or 1, and point
+starts at a field boundary, point does not move.  To ignore field
+boundaries, either bind `inhibit-field-text-motion' to t, or use the
+`forward-line' function instead.  For instance, `(forward-line 0)' does
+the same thing as `(beginning-of-line)', except that it ignores field
+boundaries.  */) 
+     (n)
      Lisp_Object n;
 {
   if (NILP (n))
     XSETFASTINT (n, 1);
   else
-    CHECK_NUMBER (n, 0);
+    CHECK_NUMBER (n);
 
   SET_PT (XINT (Fline_beginning_position (n)));
+  
   return Qnil;
 }
 
-DEFUN ("end-of-line", Fend_of_line, Send_of_line,
-  0, 1, "p",
-  "Move point to end of current line.\n\
-With argument N not nil or 1, move forward N - 1 lines first.\n\
-If scan reaches end of buffer, stop there without error.")
-  (n)
+DEFUN ("end-of-line", Fend_of_line, Send_of_line, 0, 1, "p",
+       doc: /* Move point to end of current line.
+With argument N not nil or 1, move forward N - 1 lines first.
+If point reaches the beginning or end of buffer, it stops there.
+
+This command does not move point across a field boundary unless doing so
+would move beyond there to a different line; if N is nil or 1, and
+point starts at a field boundary, point does not move.  To ignore field
+boundaries bind `inhibit-field-text-motion' to t.  */)
+     (n)
      Lisp_Object n;
 {
-  register int pos;
-  register int stop;
-
   if (NILP (n))
     XSETFASTINT (n, 1);
   else
-    CHECK_NUMBER (n, 0);
+    CHECK_NUMBER (n);
 
   SET_PT (XINT (Fline_end_position (n)));
 
@@ -205,18 +198,18 @@ If scan reaches end of buffer, stop there without error.")
 }
 
 DEFUN ("delete-char", Fdelete_char, Sdelete_char, 1, 2, "p\nP",
-  "Delete the following N characters (previous if N is negative).\n\
-Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
-Interactively, N is the prefix arg, and KILLFLAG is set if\n\
-N was explicitly specified.")
-  (n, killflag)
+       doc: /* Delete the following N characters (previous if N is negative).
+Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
+Interactively, N is the prefix arg, and KILLFLAG is set if
+N was explicitly specified.  */)
+     (n, killflag)
      Lisp_Object n, killflag;
 {
   int pos;
 
-  CHECK_NUMBER (n, 0);
+  CHECK_NUMBER (n);
 
-  pos = forward_point (XINT (n));
+  pos = PT + XINT (n);
   if (NILP (killflag))
     {
       if (XINT (n) < 0)
@@ -242,28 +235,29 @@ N was explicitly specified.")
 }
 
 DEFUN ("delete-backward-char", Fdelete_backward_char, Sdelete_backward_char,
-  1, 2, "p\nP",
-  "Delete the previous N characters (following if N is negative).\n\
-Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).\n\
-Interactively, N is the prefix arg, and KILLFLAG is set if\n\
-N was explicitly specified.")
-  (n, killflag)
+       1, 2, "p\nP",
+       doc: /* Delete the previous N characters (following if N is negative).
+Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
+Interactively, N is the prefix arg, and KILLFLAG is set if
+N was explicitly specified.  */)
+     (n, killflag)
      Lisp_Object n, killflag;
 {
   Lisp_Object value;
   int deleted_special = 0;
-  int pos, i;
+  int pos, pos_byte, i;
 
-  CHECK_NUMBER (n, 0);
+  CHECK_NUMBER (n);
 
   /* See if we are about to delete a tab or newline backwards.  */
   pos = PT;
-  for (i = 0; i < XINT (n) && pos > BEGV; i++)
+  pos_byte = PT_BYTE;
+  for (i = 0; i < XINT (n) && pos_byte > BEGV_BYTE; i++)
     {
       int c;
 
-      DEC_POS (pos);
-      c = FETCH_BYTE (pos);
+      DEC_BOTH (pos, pos_byte);
+      c = FETCH_BYTE (pos_byte);
       if (c == '\t' || c == '\n')
        {
          deleted_special = 1;
@@ -276,14 +270,15 @@ N was explicitly specified.")
   if (XINT (n) > 0
       && ! NILP (current_buffer->overwrite_mode)
       && ! deleted_special
-      && ! (PT == ZV || FETCH_BYTE (PT) == '\n'))
+      && ! (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n'))
     {
       int column = current_column ();
 
       value = Fdelete_char (make_number (-XINT (n)), killflag);
       i = column - current_column ();
-      Finsert_char (make_number (' '), i);
-      SET_PT (PT - i);
+      Finsert_char (make_number (' '), make_number (i), Qnil);
+      /* Whitespace chars are ASCII chars, so we can simply subtract.  */
+      SET_PT_BOTH (PT - i, PT_BYTE - i);
     }
   else
     value = Fdelete_char (make_number (-XINT (n)), killflag);
@@ -292,34 +287,43 @@ N was explicitly specified.")
 }
 
 DEFUN ("self-insert-command", Fself_insert_command, Sself_insert_command, 1, 1, "p",
-  "Insert the character you type.\n\
-Whichever character you type to run this command is inserted.")
-  (n)
+       doc: /* Insert the character you type.
+Whichever character you type to run this command is inserted.  */)
+     (n)
      Lisp_Object n;
 {
-  CHECK_NUMBER (n, 0);
+  int character = XINT (last_command_char);
+
+  CHECK_NUMBER (n);
 
   /* Barf if the key that invoked this was not a character.  */
   if (!INTEGERP (last_command_char))
     bitch_at_user ();
   else if (XINT (n) >= 2 && NILP (current_buffer->overwrite_mode))
     {
+      int modified_char = character;
+      /* Add the offset to the character, for Finsert_char.
+        We pass internal_self_insert the unmodified character
+        because it itself does this offsetting.  */
+      if (! NILP (current_buffer->enable_multibyte_characters))
+       modified_char = unibyte_char_to_multibyte (modified_char);
+
       XSETFASTINT (n, XFASTINT (n) - 2);
       /* The first one might want to expand an abbrev.  */
-      internal_self_insert (XINT (last_command_char), 1);
+      internal_self_insert (character, 1);
       /* The bulk of the copies of this char can be inserted simply.
         We don't have to handle a user-specified face specially
         because it will get inherited from the first char inserted.  */
-      Finsert_char (last_command_char, n, Qt);
+      Finsert_char (make_number (modified_char), n, Qt);
       /* The last one might want to auto-fill.  */
-      internal_self_insert (XINT (last_command_char), 0);
+      internal_self_insert (character, 0);
     }
   else
     while (XINT (n) > 0)
       {
        /* Ok since old and new vals both nonneg */
        XSETFASTINT (n, XFASTINT (n) - 1);
-       internal_self_insert (XINT (last_command_char), XFASTINT (n) != 0);
+       internal_self_insert (character, XFASTINT (n) != 0);
       }
 
   return Qnil;
@@ -332,6 +336,7 @@ Whichever character you type to run this command is inserted.")
    return 0.  A value of 1 indicates this *might* not have been simple.
    A value of 2 means this did things that call for an undo boundary.  */
 
+int
 internal_self_insert (c, noautofill)
      int c;
      int noautofill;
@@ -340,23 +345,35 @@ internal_self_insert (c, noautofill)
   int hairy = 0;
   Lisp_Object tem;
   register enum syntaxcode synt;
-  Lisp_Object overwrite;
+  Lisp_Object overwrite, string;
   /* Length of multi-byte form of C.  */
   int len;
   /* Working buffer and pointer for multi-byte form of C.  */
-  unsigned char workbuf[4], *str;
+  unsigned char str[MAX_MULTIBYTE_LENGTH];
+  int chars_to_delete = 0;
+  int spaces_to_insert = 0;
 
   overwrite = current_buffer->overwrite_mode;
-  if (!NILP (Vbefore_change_function) || !NILP (Vafter_change_function)
-      || !NILP (Vbefore_change_functions) || !NILP (Vafter_change_functions))
+  if (!NILP (Vbefore_change_functions) || !NILP (Vafter_change_functions))
     hairy = 1;
 
   /* At first, get multi-byte form of C in STR.  */
   if (!NILP (current_buffer->enable_multibyte_characters))
-    len = CHAR_STRING (c, workbuf, str);
+    {
+      c = unibyte_char_to_multibyte (c);
+      len = CHAR_STRING (c, str);
+      if (len == 1)
+       /* If C has modifier bits, this makes C an appropriate
+           one-byte char.  */
+       c = *str;
+    }
   else
-    workbuf[0] = c, str = workbuf, len = 1;
-
+    {
+      str[0] = (SINGLE_BYTE_CHAR_P (c)
+               ? c
+               : multibyte_char_to_unibyte (c, Qnil));
+      len = 1;
+    }
   if (!NILP (overwrite)
       && PT < ZV)
     {
@@ -369,50 +386,53 @@ internal_self_insert (c, noautofill)
         we fill columns with spaces, if C is wider than C2, we delete
         C2 and several characters following C2.  */
 
-      /* A code at `point'.  Since this is checked only against
-         NEWLINE and TAB, we don't need a character code but only the
-         first byte of multi-byte form.  */
-      unsigned char c2 = FETCH_BYTE (PT);
-      /* A column the cursor should be placed at after this insertion.
+      /* This is the character after point.  */
+      int c2 = FETCH_CHAR (PT_BYTE);
+
+      /* Column the cursor should be placed at after this insertion.
          The correct value should be calculated only when necessary.  */
       int target_clm = 0;
 
-      /* Overwriting in binary-mode always substitute C2 by C.  But,
-        overwriting in textual-mode does this substitution in the
-        case that C is not NEWLINE and C2 is not NEWLINE nor TAB.  If
-        C2 is TAB, the substitution is done only when C2 is currently
-        expanded to 0 column, or more than 20 columns, or more than
-        the width of C.  */
+      /* Overwriting in binary-mode always replaces C2 by C.
+        Overwriting in textual-mode doesn't always do that.
+        It inserts newlines in the usual way,
+        and inserts any character at end of line
+        or before a tab if it doesn't use the whole width of the tab.  */
       if (EQ (overwrite, Qoverwrite_mode_binary)
          || (c != '\n'
              && c2 != '\n'
-             && (target_clm = current_column() + WIDTH_BY_CHAR_HEAD (str[0]),
-                 (c2 != '\t'
-                  || XINT (current_buffer->tab_width) <= 0
-                  || XFASTINT (current_buffer->tab_width) > 20
-                  || !(target_clm % XFASTINT (current_buffer->tab_width))))))
+             && ! (c2 == '\t'
+                   && XINT (current_buffer->tab_width) > 0
+                   && XFASTINT (current_buffer->tab_width) < 20
+                   && (target_clm = (current_column () 
+                                     + XINT (Fchar_width (make_number (c)))),
+                       target_clm % XFASTINT (current_buffer->tab_width)))))
        {
+         int pos = PT;
+         int pos_byte = PT_BYTE;
+
          if (target_clm == 0)
-           del_range (PT, forward_point (1));
+           chars_to_delete = 1;
          else
            {
-             int pos = point;
              /* The actual cursor position after the trial of moving
                 to column TARGET_CLM.  It is greater than TARGET_CLM
                 if the TARGET_CLM is middle of multi-column
                 character.  In that case, the new point is set after
                 that character.  */
-             int actual_clm = XFASTINT (Fmove_to_column (target_clm));
+             int actual_clm
+               = XFASTINT (Fmove_to_column (make_number (target_clm), Qnil));
+
+             chars_to_delete = PT - pos;
 
-             del_range (pos, PT);
              if (actual_clm > target_clm)
                {
-                 /* We deleted too many columns.  Let's fill columns
+                 /* We will delete too many columns.  Let's fill columns
                     by spaces so that the remaining text won't move.  */
-                 insert("        ",  actual_clm - target_clm);
-                 SET_PT (pos);
+                 spaces_to_insert = actual_clm - target_clm;
                }
            }
+         SET_PT_BOTH (pos, pos_byte);
          hairy = 2;
        }
       hairy = 2;
@@ -427,7 +447,7 @@ internal_self_insert (c, noautofill)
 
       sym = Fexpand_abbrev ();
 
-      /* If we expanded an abbrev which has only a hook,
+      /* If we expanded an abbrev which has a hook,
         and the hook has a non-nil `no-self-insert' property,
         return right away--don't really self-insert.  */
       if (! NILP (sym) && ! NILP (XSYMBOL (sym)->function)
@@ -442,39 +462,52 @@ internal_self_insert (c, noautofill)
       if (MODIFF != modiff)
        hairy = 2;
     }
-  if ((c == ' ' || c == '\n')
+
+  if (chars_to_delete)
+    {
+      string = make_string_from_bytes (str, 1, len);
+      if (spaces_to_insert)
+       {
+         tem = Fmake_string (make_number (spaces_to_insert),
+                             make_number (' '));
+         string = concat2 (tem, string);
+       }
+
+      replace_range (PT, PT + chars_to_delete, string, 1, 1, 1);
+      Fforward_char (make_number (1 + spaces_to_insert));
+    }
+  else
+    insert_and_inherit (str, len);
+
+  if ((CHAR_TABLE_P (Vauto_fill_chars)
+       ? !NILP (CHAR_TABLE_REF (Vauto_fill_chars, c))
+       : (c == ' ' || c == '\n'))
       && !noautofill
       && !NILP (current_buffer->auto_fill_function))
     {
       Lisp_Object tem;
 
-      insert_and_inherit (str, len);
       if (c == '\n')
-       /* After inserting a newline, move to previous line and fill */
-       /* that.  Must have the newline in place already so filling and */
-       /* justification, if any, know where the end is going to be. */
-       SET_PT (PT - 1);
+       /* After inserting a newline, move to previous line and fill
+          that.  Must have the newline in place already so filling and
+          justification, if any, know where the end is going to be.  */
+       SET_PT_BOTH (PT - 1, PT_BYTE - 1);
       tem = call0 (current_buffer->auto_fill_function);
       if (c == '\n')
-       SET_PT (PT + 1);
+       SET_PT_BOTH (PT + 1, PT_BYTE + 1);
       if (!NILP (tem))
        hairy = 2;
     }
-  else
-    insert_and_inherit (str, len);
 
-#ifdef HAVE_FACES
   /* If previous command specified a face to use, use it.  */
   if (!NILP (Vself_insert_face)
       && EQ (current_kboard->Vlast_command, Vself_insert_face_command))
     {
-      Lisp_Object before, after;
-      XSETINT (before, PT - len);
-      XSETINT (after, PT);
-      Fput_text_property (before, after, Qface, Vself_insert_face, Qnil);
+      Fput_text_property (make_number (PT - 1), make_number (PT),
+                         Qface, Vself_insert_face, Qnil);
       Vself_insert_face = Qnil;
     }
-#endif
+
   synt = SYNTAX (c);
   if ((synt == Sclose || synt == Smath)
       && !NILP (Vblink_paren_function) && INTERACTIVE
@@ -488,6 +521,7 @@ internal_self_insert (c, noautofill)
 \f
 /* module initialization */
 
+void
 syms_of_cmds ()
 {
   Qkill_backward_chars = intern ("kill-backward-chars");
@@ -500,18 +534,18 @@ syms_of_cmds ()
   staticpro (&Qoverwrite_mode_binary);
 
   DEFVAR_LISP ("self-insert-face", &Vself_insert_face,
-    "If non-nil, set the face of the next self-inserting character to this.\n\
-See also `self-insert-face-command'.");
+              doc: /* If non-nil, set the face of the next self-inserting character to this.
+See also `self-insert-face-command'.  */);
   Vself_insert_face = Qnil;
 
   DEFVAR_LISP ("self-insert-face-command", &Vself_insert_face_command,
-    "This is the command that set up `self-insert-face'.\n\
-If `last-command' does not equal this value, we ignore `self-insert-face'.");
+              doc: /* This is the command that set up `self-insert-face'.
+If `last-command' does not equal this value, we ignore `self-insert-face'.  */);
   Vself_insert_face_command = Qnil;
 
   DEFVAR_LISP ("blink-paren-function", &Vblink_paren_function,
-    "Function called, if non-nil, whenever a close parenthesis is inserted.\n\
-More precisely, a char with closeparen syntax is self-inserted.");
+              doc: /* Function called, if non-nil, whenever a close parenthesis is inserted.
+More precisely, a char with closeparen syntax is self-inserted.  */);
   Vblink_paren_function = Qnil;
 
   defsubr (&Sforward_point);
@@ -527,6 +561,7 @@ More precisely, a char with closeparen syntax is self-inserted.");
   defsubr (&Sself_insert_command);
 }
 
+void
 keys_of_cmds ()
 {
   int n;