]> code.delx.au - gnu-emacs/blobdiff - src/doc.c
The following changes consolidate some of the gui-independent
[gnu-emacs] / src / doc.c
index 2cff57bb81d445dfb42fc72bad54b0dac4513d58..3a53dc5174eb954c3bc4a355839483a13cbf27e0 100644 (file)
--- a/src/doc.c
+++ b/src/doc.c
@@ -40,12 +40,15 @@ Boston, MA 02111-1307, USA.  */
 #include "buffer.h"
 #include "keyboard.h"
 #include "charset.h"
 #include "buffer.h"
 #include "keyboard.h"
 #include "charset.h"
+#include "keymap.h"
 
 
-Lisp_Object Vdoc_file_name, Vhelp_manyarg_func_alist;
+#ifdef HAVE_INDEX
+extern char *index P_ ((const char *, int));
+#endif
 
 
-Lisp_Object Qfunction_documentation;
+Lisp_Object Vdoc_file_name;
 
 
-extern char *index ();
+Lisp_Object Qfunction_documentation;
 
 extern Lisp_Object Voverriding_local_map;
 
 
 extern Lisp_Object Voverriding_local_map;
 
@@ -78,6 +81,7 @@ static char *get_doc_string_buffer;
 static int get_doc_string_buffer_size;
 
 static unsigned char *read_bytecode_pointer;
 static int get_doc_string_buffer_size;
 
 static unsigned char *read_bytecode_pointer;
+Lisp_Object Fsnarf_documentation P_ ((Lisp_Object));
 
 /* readchar in lread.c calls back here to fetch the next byte.
    If UNREADFLAG is 1, we unread a byte.  */
 
 /* readchar in lread.c calls back here to fetch the next byte.
    If UNREADFLAG is 1, we unread a byte.  */
@@ -102,6 +106,10 @@ read_bytecode_char (unreadflag)
    (A negative integer is used for user variables, so we can distinguish
    them without actually fetching the doc string.)
 
    (A negative integer is used for user variables, so we can distinguish
    them without actually fetching the doc string.)
 
+   If the location does not point to the beginning of a docstring
+   (e.g. because the file has been modified and the location is stale),
+   return nil.
+
    If UNIBYTE is nonzero, always make a unibyte string.
 
    If DEFINITION is nonzero, assume this is for reading
    If UNIBYTE is nonzero, always make a unibyte string.
 
    If DEFINITION is nonzero, assume this is for reading
@@ -131,36 +139,37 @@ get_doc_string (filepos, unibyte, definition)
     {
       file = XCAR (filepos);
       position = XINT (XCDR (filepos));
     {
       file = XCAR (filepos);
       position = XINT (XCDR (filepos));
-      if (position < 0)
-       position = - position;
     }
   else
     return Qnil;
 
     }
   else
     return Qnil;
 
+  if (position < 0)
+    position = - position;
+
   if (!STRINGP (Vdoc_directory))
     return Qnil;
 
   if (!STRINGP (file))
     return Qnil;
   if (!STRINGP (Vdoc_directory))
     return Qnil;
 
   if (!STRINGP (file))
     return Qnil;
-    
+
   /* Put the file name in NAME as a C string.
      If it is relative, combine it with Vdoc_directory.  */
 
   tem = Ffile_name_absolute_p (file);
   if (NILP (tem))
     {
   /* Put the file name in NAME as a C string.
      If it is relative, combine it with Vdoc_directory.  */
 
   tem = Ffile_name_absolute_p (file);
   if (NILP (tem))
     {
-      minsize = XSTRING (Vdoc_directory)->size;
+      minsize = SCHARS (Vdoc_directory);
       /* sizeof ("../etc/") == 8 */
       if (minsize < 8)
        minsize = 8;
       /* sizeof ("../etc/") == 8 */
       if (minsize < 8)
        minsize = 8;
-      name = (char *) alloca (minsize + XSTRING (file)->size + 8);
-      strcpy (name, XSTRING (Vdoc_directory)->data);
-      strcat (name, XSTRING (file)->data);
+      name = (char *) alloca (minsize + SCHARS (file) + 8);
+      strcpy (name, SDATA (Vdoc_directory));
+      strcat (name, SDATA (file));
       munge_doc_file_name (name);
     }
   else
     {
       munge_doc_file_name (name);
     }
   else
     {
-      name = (char *) XSTRING (file)->data;
+      name = (char *) SDATA (file);
     }
 
   fd = emacs_open (name, O_RDONLY, 0);
     }
 
   fd = emacs_open (name, O_RDONLY, 0);
@@ -172,7 +181,7 @@ get_doc_string (filepos, unibyte, definition)
          /* Preparing to dump; DOC file is probably not installed.
             So check in ../etc. */
          strcpy (name, "../etc/");
          /* Preparing to dump; DOC file is probably not installed.
             So check in ../etc. */
          strcpy (name, "../etc/");
-         strcat (name, XSTRING (file)->data);
+         strcat (name, SDATA (file));
          munge_doc_file_name (name);
 
          fd = emacs_open (name, O_RDONLY, 0);
          munge_doc_file_name (name);
 
          fd = emacs_open (name, O_RDONLY, 0);
@@ -183,7 +192,9 @@ get_doc_string (filepos, unibyte, definition)
     }
 
   /* Seek only to beginning of disk block.  */
     }
 
   /* Seek only to beginning of disk block.  */
-  offset = position % (8 * 1024);
+  /* Make sure we read at least 1024 bytes before `position'
+     so we can check the leading text for consistency.  */
+  offset = min (position, max (1024, position % (8 * 1024)));
   if (0 > lseek (fd, position - offset, 0))
     {
       emacs_close (fd);
   if (0 > lseek (fd, position - offset, 0))
     {
       emacs_close (fd);
@@ -228,9 +239,9 @@ get_doc_string (filepos, unibyte, definition)
       if (!nread)
        break;
       if (p == get_doc_string_buffer)
       if (!nread)
        break;
       if (p == get_doc_string_buffer)
-       p1 = index (p + offset, '\037');
+       p1 = (char *) index (p + offset, '\037');
       else
       else
-       p1 = index (p, '\037');
+       p1 = (char *) index (p, '\037');
       if (p1)
        {
          *p1 = 0;
       if (p1)
        {
          *p1 = 0;
@@ -241,6 +252,30 @@ get_doc_string (filepos, unibyte, definition)
     }
   emacs_close (fd);
 
     }
   emacs_close (fd);
 
+  /* Sanity checking.  */
+  if (CONSP (filepos))
+    {
+      int test = 1;
+      if (get_doc_string_buffer[offset - test++] != ' ')
+       return Qnil;
+      while (get_doc_string_buffer[offset - test] >= '0'
+            && get_doc_string_buffer[offset - test] <= '9')
+       test++;
+      if (get_doc_string_buffer[offset - test++] != '@'
+         || get_doc_string_buffer[offset - test] != '#')
+       return Qnil;
+    }
+  else
+    {
+      int test = 1;
+      if (get_doc_string_buffer[offset - test++] != '\n')
+       return Qnil;
+      while (get_doc_string_buffer[offset - test] > ' ')
+       test++;
+      if (get_doc_string_buffer[offset - test] != '\037')
+       return Qnil;
+    }
+
   /* Scan the text and perform quoting with ^A (char code 1).
      ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_.  */
   from = get_doc_string_buffer + offset;
   /* Scan the text and perform quoting with ^A (char code 1).
      ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_.  */
   from = get_doc_string_buffer + offset;
@@ -300,22 +335,52 @@ read_doc_string (filepos)
   return get_doc_string (filepos, 0, 1);
 }
 
   return get_doc_string (filepos, 0, 1);
 }
 
+static int
+reread_doc_file (file)
+     Lisp_Object file;
+{
+#if 0
+  Lisp_Object reply, prompt[3];
+  struct gcpro gcpro1;
+  GCPRO1 (file);
+  prompt[0] = build_string ("File ");
+  prompt[1] = NILP (file) ? Vdoc_file_name : file;
+  prompt[2] = build_string (" is out of sync.  Reload? ");
+  reply = Fy_or_n_p (Fconcat (3, prompt));
+  UNGCPRO;
+  if (NILP (reply))
+    return 0;
+#endif
+
+  if (NILP (file))
+    Fsnarf_documentation (Vdoc_file_name);
+  else
+    Fload (file, Qt, Qt, Qt, Qnil);
+
+  return 1;
+}
+
 DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
 DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
-  "Return the documentation string of FUNCTION.\n\
-Unless a non-nil second argument RAW is given, the\n\
-string is passed through `substitute-command-keys'.")
-  (function, raw)
+       doc: /* Return the documentation string of FUNCTION.
+Unless a non-nil second argument RAW is given, the
+string is passed through `substitute-command-keys'.  */)
+     (function, raw)
      Lisp_Object function, raw;
 {
   Lisp_Object fun;
   Lisp_Object funcar;
   Lisp_Object tem, doc;
      Lisp_Object function, raw;
 {
   Lisp_Object fun;
   Lisp_Object funcar;
   Lisp_Object tem, doc;
+  int try_reload = 1;
+
+ documentation:
+
+  doc = Qnil;
 
   if (SYMBOLP (function)
       && (tem = Fget (function, Qfunction_documentation),
          !NILP (tem)))
     return Fdocumentation_property (function, Qfunction_documentation, raw);
 
   if (SYMBOLP (function)
       && (tem = Fget (function, Qfunction_documentation),
          !NILP (tem)))
     return Fdocumentation_property (function, Qfunction_documentation, raw);
-  
+
   fun = Findirect_function (function);
   if (SUBRP (fun))
     {
   fun = Findirect_function (function);
   if (SUBRP (fun))
     {
@@ -324,20 +389,17 @@ string is passed through `substitute-command-keys'.")
       else if ((EMACS_INT) XSUBR (fun)->doc >= 0)
        doc = build_string (XSUBR (fun)->doc);
       else
       else if ((EMACS_INT) XSUBR (fun)->doc >= 0)
        doc = build_string (XSUBR (fun)->doc);
       else
-       doc = get_doc_string (make_number (- (EMACS_INT) XSUBR (fun)->doc),
-                             0, 0);
-      if (! NILP (tem = Fassq (function, Vhelp_manyarg_func_alist)))
-       doc = concat3 (doc, build_string ("\n"), Fcdr (tem));
+       doc = make_number ((EMACS_INT) XSUBR (fun)->doc);
     }
   else if (COMPILEDP (fun))
     {
     }
   else if (COMPILEDP (fun))
     {
-      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING)
+      if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING)
        return Qnil;
        return Qnil;
-      tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
+      tem = AREF (fun, COMPILED_DOC_STRING);
       if (STRINGP (tem))
        doc = tem;
       else if (NATNUMP (tem) || CONSP (tem))
       if (STRINGP (tem))
        doc = tem;
       else if (NATNUMP (tem) || CONSP (tem))
-       doc = get_doc_string (tem, 0, 0);
+       doc = tem;
       else
        return Qnil;
     }
       else
        return Qnil;
     }
@@ -362,14 +424,12 @@ string is passed through `substitute-command-keys'.")
            doc = tem;
          /* Handle a doc reference--but these never come last
             in the function body, so reject them if they are last.  */
            doc = tem;
          /* Handle a doc reference--but these never come last
             in the function body, so reject them if they are last.  */
-         else if ((NATNUMP (tem) || CONSP (tem))
-                  && ! NILP (XCDR (tem1)))
-           doc = get_doc_string (tem, 0, 0);
+         else if ((NATNUMP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem))))
+                  && !NILP (XCDR (tem1)))
+           doc = tem;
          else
            return Qnil;
        }
          else
            return Qnil;
        }
-      else if (EQ (funcar, Qmocklisp))
-       return Qnil;
       else if (EQ (funcar, Qmacro))
        return Fdocumentation (Fcdr (fun), raw);
       else
       else if (EQ (funcar, Qmacro))
        return Fdocumentation (Fcdr (fun), raw);
       else
@@ -381,6 +441,31 @@ string is passed through `substitute-command-keys'.")
       Fsignal (Qinvalid_function, Fcons (fun, Qnil));
     }
 
       Fsignal (Qinvalid_function, Fcons (fun, Qnil));
     }
 
+  /* If DOC is 0, it's typically because of a dumped file missing
+     from the DOC file (bug in src/Makefile.in).  */
+  if (EQ (doc, make_number (0)))
+    doc = Qnil;
+  if (INTEGERP (doc) || CONSP (doc))
+    {
+      Lisp_Object tem;
+      tem = get_doc_string (doc, 0, 0);
+      if (NILP (tem) && try_reload)
+       {
+         /* The file is newer, we need to reset the pointers.  */
+         struct gcpro gcpro1, gcpro2;
+         GCPRO2 (function, raw);
+         try_reload = reread_doc_file (Fcar_safe (doc));
+         UNGCPRO;
+         if (try_reload)
+           {
+             try_reload = 0;
+             goto documentation;
+           }
+       }
+      else
+       doc = tem;
+    }
+
   if (NILP (raw))
     doc = Fsubstitute_command_keys (doc);
   return doc;
   if (NILP (raw))
     doc = Fsubstitute_command_keys (doc);
   return doc;
@@ -388,27 +473,46 @@ string is passed through `substitute-command-keys'.")
 
 DEFUN ("documentation-property", Fdocumentation_property,
        Sdocumentation_property, 2, 3, 0,
 
 DEFUN ("documentation-property", Fdocumentation_property,
        Sdocumentation_property, 2, 3, 0,
-  "Return the documentation string that is SYMBOL's PROP property.\n\
-Third argument RAW omitted or nil means pass the result through\n\
-`substitute-command-keys' if it is a string.\n\
-\n\
-This is differs from `get' in that it can refer to strings stored in the\n\
-`etc/DOC' file; and that it evaluates documentation properties that\n\
-aren't strings.")
+       doc: /* Return the documentation string that is SYMBOL's PROP property.
+Third argument RAW omitted or nil means pass the result through
+`substitute-command-keys' if it is a string.
+
+This differs from `get' in that it can refer to strings stored in the
+`etc/DOC' file; and that it evaluates documentation properties that
+aren't strings.  */)
   (symbol, prop, raw)
      Lisp_Object symbol, prop, raw;
 {
   (symbol, prop, raw)
      Lisp_Object symbol, prop, raw;
 {
+  int try_reload = 1;
   Lisp_Object tem;
 
   Lisp_Object tem;
 
+ documentation_property:
+
   tem = Fget (symbol, prop);
   tem = Fget (symbol, prop);
-  if (INTEGERP (tem))
-    tem = get_doc_string (XINT (tem) > 0 ? tem : make_number (- XINT (tem)), 0, 0);
-  else if (CONSP (tem) && INTEGERP (XCDR (tem)))
-    tem = get_doc_string (tem, 0, 0);
+  if (EQ (tem, make_number (0)))
+    tem = Qnil;
+  if (INTEGERP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem))))
+    {
+      Lisp_Object doc = tem;
+      tem = get_doc_string (tem, 0, 0);
+      if (NILP (tem) && try_reload)
+       {
+         /* The file is newer, we need to reset the pointers.  */
+         struct gcpro gcpro1, gcpro2, gcpro3;
+         GCPRO3 (symbol, prop, raw);
+         try_reload = reread_doc_file (Fcar_safe (doc));
+         UNGCPRO;
+         if (try_reload)
+           {
+             try_reload = 0;
+             goto documentation_property;
+           }
+       }
+    }
   else if (!STRINGP (tem))
     /* Feval protects its argument.  */
     tem = Feval (tem);
   else if (!STRINGP (tem))
     /* Feval protects its argument.  */
     tem = Feval (tem);
-  
+
   if (NILP (raw) && STRINGP (tem))
     tem = Fsubstitute_command_keys (tem);
   return tem;
   if (NILP (raw) && STRINGP (tem))
     tem = Fsubstitute_command_keys (tem);
   return tem;
@@ -440,7 +544,7 @@ store_function_docstring (fun, offset)
        {
          tem = Fcdr (Fcdr (fun));
          if (CONSP (tem) && INTEGERP (XCAR (tem)))
        {
          tem = Fcdr (Fcdr (fun));
          if (CONSP (tem) && INTEGERP (XCAR (tem)))
-           XSETFASTINT (XCAR (tem), offset);
+           XSETCARFASTINT (tem, offset);
        }
       else if (EQ (tem, Qmacro))
        store_function_docstring (XCDR (fun), offset);
        }
       else if (EQ (tem, Qmacro))
        store_function_docstring (XCDR (fun), offset);
@@ -451,21 +555,22 @@ store_function_docstring (fun, offset)
     {
       /* This bytecode object must have a slot for the
         docstring, since we've found a docstring for it.  */
     {
       /* This bytecode object must have a slot for the
         docstring, since we've found a docstring for it.  */
-      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING)
-       XSETFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING], offset);
+      if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING)
+       XSETFASTINT (AREF (fun, COMPILED_DOC_STRING), offset);
     }
 }
 
 
 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
     }
 }
 
 
 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
-  1, 1, 0,
-  "Used during Emacs initialization, before dumping runnable Emacs,\n\
-to find pointers to doc strings stored in `etc/DOC...' and\n\
-record them in function definitions.\n\
-One arg, FILENAME, a string which does not include a directory.\n\
-The file is found in `../etc' now; found in the `data-directory'\n\
-when doc strings are referred to later in the dumped Emacs.")
-  (filename)
+       1, 1, 0,
+       doc: /* Used during Emacs initialization to scan the `etc/DOC...' file.
+This searches the `etc/DOC...' file for doc strings and
+records them in function and variable definitions.
+The function takes one argument, FILENAME, a string;
+it specifies the file name (without a directory) of the DOC file.
+That file is found in `../etc' now; later, when the dumped Emacs is run,
+the same file name is found in the `data-directory'.  */)
+     (filename)
      Lisp_Object filename;
 {
   int fd;
      Lisp_Object filename;
 {
   int fd;
@@ -473,27 +578,29 @@ when doc strings are referred to later in the dumped Emacs.")
   register int filled;
   register int pos;
   register char *p, *end;
   register int filled;
   register int pos;
   register char *p, *end;
-  Lisp_Object sym, fun, tem;
+  Lisp_Object sym;
   char *name;
   char *name;
-  extern char *index ();
-
-#ifndef CANNOT_DUMP
-  if (NILP (Vpurify_flag))
-    error ("Snarf-documentation can only be called in an undumped Emacs");
-#endif
 
 
-  CHECK_STRING (filename, 0);
+  CHECK_STRING (filename);
 
 
+  if
 #ifndef CANNOT_DUMP
 #ifndef CANNOT_DUMP
-  name = (char *) alloca (XSTRING (filename)->size + 14);
-  strcpy (name, "../etc/");
+    (!NILP (Vpurify_flag))
 #else /* CANNOT_DUMP */
 #else /* CANNOT_DUMP */
-  CHECK_STRING (Vdoc_directory, 0);
-  name = (char *) alloca (XSTRING (filename)->size +
-                         XSTRING (Vdoc_directory)->size + 1);
-  strcpy (name, XSTRING (Vdoc_directory)->data);
+      (0)
 #endif /* CANNOT_DUMP */
 #endif /* CANNOT_DUMP */
-  strcat (name, XSTRING (filename)->data);     /*** Add this line ***/
+    {
+      name = (char *) alloca (SCHARS (filename) + 14);
+      strcpy (name, "../etc/");
+    }
+  else
+    {
+      CHECK_STRING (Vdoc_directory);
+      name = (char *) alloca (SCHARS (filename)
+                         + SCHARS (Vdoc_directory) + 1);
+      strcpy (name, SDATA (Vdoc_directory));
+    }
+  strcat (name, SDATA (filename));     /*** Add this line ***/
 #ifdef VMS
 #ifndef VMS4_4
   /* For VMS versions with limited file name syntax,
 #ifdef VMS
 #ifndef VMS4_4
   /* For VMS versions with limited file name syntax,
@@ -532,7 +639,7 @@ when doc strings are referred to later in the dumped Emacs.")
       /* p points to ^_Ffunctionname\n or ^_Vvarname\n.  */
       if (p != end)
        {
       /* p points to ^_Ffunctionname\n or ^_Vvarname\n.  */
       if (p != end)
        {
-         end = index (p, '\n');
+         end = (char *) index (p, '\n');
          sym = oblookup (Vobarray, p + 2,
                          multibyte_chars_in_text (p + 2, end - p - 2),
                          end - p - 2);
          sym = oblookup (Vobarray, p + 2,
                          multibyte_chars_in_text (p + 2, end - p - 2),
                          end - p - 2);
@@ -566,18 +673,18 @@ when doc strings are referred to later in the dumped Emacs.")
 }
 \f
 DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
 }
 \f
 DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
-  Ssubstitute_command_keys, 1, 1, 0,
-  "Substitute key descriptions for command names in STRING.\n\
-Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\
-replaced by either:  a keystroke sequence that will invoke COMMAND,\n\
-or \"M-x COMMAND\" if COMMAND is not on any keys.\n\
-Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\
-\(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\
-Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\
-as the keymap for future \\=\\[COMMAND] substrings.\n\
-\\=\\= quotes the following character and is discarded;\n\
-thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
-  (string)
+       Ssubstitute_command_keys, 1, 1, 0,
+       doc: /* Substitute key descriptions for command names in STRING.
+Return a new string which is STRING with substrings of the form \\=\\[COMMAND]
+replaced by either:  a keystroke sequence that will invoke COMMAND,
+or "M-x COMMAND" if COMMAND is not on any keys.
+Substrings of the form \\=\\{MAPVAR} are replaced by summaries
+\(made by describe-bindings) of the value of MAPVAR, taken as a keymap.
+Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
+as the keymap for future \\=\\[COMMAND] substrings.
+\\=\\= quotes the following character and is discarded;
+thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.  */)
+     (string)
      Lisp_Object string;
 {
   unsigned char *buf;
      Lisp_Object string;
 {
   unsigned char *buf;
@@ -586,7 +693,6 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
   register unsigned char *bufp;
   int idx;
   int bsize;
   register unsigned char *bufp;
   int idx;
   int bsize;
-  unsigned char *new;
   Lisp_Object tem;
   Lisp_Object keymap;
   unsigned char *start;
   Lisp_Object tem;
   Lisp_Object keymap;
   unsigned char *start;
@@ -599,7 +705,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
   if (NILP (string))
     return Qnil;
 
   if (NILP (string))
     return Qnil;
 
-  CHECK_STRING (string, 0);
+  CHECK_STRING (string);
   tem = Qnil;
   keymap = Qnil;
   name = Qnil;
   tem = Qnil;
   keymap = Qnil;
   name = Qnil;
@@ -616,11 +722,11 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
   if (NILP (keymap))
     keymap = Voverriding_local_map;
 
   if (NILP (keymap))
     keymap = Voverriding_local_map;
 
-  bsize = STRING_BYTES (XSTRING (string));
+  bsize = SBYTES (string);
   bufp = buf = (unsigned char *) xmalloc (bsize);
 
   bufp = buf = (unsigned char *) xmalloc (bsize);
 
-  strp = (unsigned char *) XSTRING (string)->data;
-  while (strp < XSTRING (string)->data + STRING_BYTES (XSTRING (string)))
+  strp = (unsigned char *) SDATA (string);
+  while (strp < SDATA (string) + SBYTES (string))
     {
       if (strp[0] == '\\' && strp[1] == '=')
        {
     {
       if (strp[0] == '\\' && strp[1] == '=')
        {
@@ -631,7 +737,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          if (multibyte)
            {
              int len;
          if (multibyte)
            {
              int len;
-             int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
+             int maxlen = SDATA (string) + SBYTES (string) - strp;
 
              STRING_CHAR_AND_LENGTH (strp, maxlen, len);
              if (len == 1)
 
              STRING_CHAR_AND_LENGTH (strp, maxlen, len);
              if (len == 1)
@@ -653,10 +759,10 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          changed = 1;
          strp += 2;            /* skip \[ */
          start = strp;
          changed = 1;
          strp += 2;            /* skip \[ */
          start = strp;
-         start_idx = start - XSTRING (string)->data;
+         start_idx = start - SDATA (string);
 
 
-         while ((strp - (unsigned char *) XSTRING (string)->data
-                 < STRING_BYTES (XSTRING (string)))
+         while ((strp - (unsigned char *) SDATA (string)
+                 < SBYTES (string))
                 && *strp != ']')
            strp++;
          length_byte = strp - start;
                 && *strp != ']')
            strp++;
          length_byte = strp - start;
@@ -664,14 +770,14 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          strp++;               /* skip ] */
 
          /* Save STRP in IDX.  */
          strp++;               /* skip ] */
 
          /* Save STRP in IDX.  */
-         idx = strp - (unsigned char *) XSTRING (string)->data;
+         idx = strp - (unsigned char *) SDATA (string);
          tem = Fintern (make_string (start, length_byte), Qnil);
 
          /* Note the Fwhere_is_internal can GC, so we have to take
             relocation of string contents into account.  */
          tem = Fintern (make_string (start, length_byte), Qnil);
 
          /* Note the Fwhere_is_internal can GC, so we have to take
             relocation of string contents into account.  */
-         tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
-         strp = XSTRING (string)->data + idx;
-         start = XSTRING (string)->data + start_idx;
+         tem = Fwhere_is_internal (tem, keymap, Qt, Qnil, Qnil);
+         strp = SDATA (string) + idx;
+         start = SDATA (string) + start_idx;
 
          /* Disregard menu bar bindings; it is positively annoying to
             mention them when there's no menu bar, and it isn't terribly
 
          /* Disregard menu bar bindings; it is positively annoying to
             mention them when there's no menu bar, and it isn't terribly
@@ -685,9 +791,9 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
 
          if (NILP (tem))       /* but not on any keys */
            {
 
          if (NILP (tem))       /* but not on any keys */
            {
-             new = (unsigned char *) xrealloc (buf, bsize += 4);
-             bufp += new - buf;
-             buf = new;
+             int offset = bufp - buf;
+             buf = (unsigned char *) xrealloc (buf, bsize += 4);
+             bufp = buf + offset;
              bcopy ("M-x ", bufp, 4);
              bufp += 4;
              nchars += 4;
              bcopy ("M-x ", bufp, 4);
              bufp += 4;
              nchars += 4;
@@ -713,10 +819,10 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          changed = 1;
          strp += 2;            /* skip \{ or \< */
          start = strp;
          changed = 1;
          strp += 2;            /* skip \{ or \< */
          start = strp;
-         start_idx = start - XSTRING (string)->data;
+         start_idx = start - SDATA (string);
 
 
-         while ((strp - (unsigned char *) XSTRING (string)->data
-                 < XSTRING (string)->size)
+         while ((strp - (unsigned char *) SDATA (string)
+                 < SCHARS (string))
                 && *strp != '}' && *strp != '>')
            strp++;
 
                 && *strp != '}' && *strp != '>')
            strp++;
 
@@ -724,7 +830,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          strp++;                       /* skip } or > */
 
          /* Save STRP in IDX.  */
          strp++;                       /* skip } or > */
 
          /* Save STRP in IDX.  */
-         idx = strp - (unsigned char *) XSTRING (string)->data;
+         idx = strp - (unsigned char *) SDATA (string);
 
          /* Get the value of the keymap in TEM, or nil if undefined.
             Do this while still in the user's current buffer
 
          /* Get the value of the keymap in TEM, or nil if undefined.
             Do this while still in the user's current buffer
@@ -736,10 +842,10 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
              tem = Fsymbol_value (name);
              if (! NILP (tem))
                {
              tem = Fsymbol_value (name);
              if (! NILP (tem))
                {
-                 tem = get_keymap_1 (tem, 0, 1);
-                 /* Note that get_keymap_1 can GC.  */
-                 strp = XSTRING (string)->data + idx;
-                 start = XSTRING (string)->data + start_idx;
+                 tem = get_keymap (tem, 0, 1);
+                 /* Note that get_keymap can GC.  */
+                 strp = SDATA (string) + idx;
+                 start = SDATA (string) + start_idx;
                }
            }
 
                }
            }
 
@@ -752,8 +858,8 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
              name = Fsymbol_name (name);
              insert_string ("\nUses keymap \"");
              insert_from_string (name, 0, 0,
              name = Fsymbol_name (name);
              insert_string ("\nUses keymap \"");
              insert_from_string (name, 0, 0,
-                                 XSTRING (name)->size,
-                                 STRING_BYTES (XSTRING (name)), 1);
+                                 SCHARS (name),
+                                 SBYTES (name), 1);
              insert_string ("\", which is not currently defined.\n");
              if (start[-1] == '<') keymap = Qnil;
            }
              insert_string ("\", which is not currently defined.\n");
              if (start[-1] == '<') keymap = Qnil;
            }
@@ -766,25 +872,27 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          set_buffer_internal (oldbuf);
 
        subst_string:
          set_buffer_internal (oldbuf);
 
        subst_string:
-         start = XSTRING (tem)->data;
-         length = XSTRING (tem)->size;
-         length_byte = STRING_BYTES (XSTRING (tem));
+         start = SDATA (tem);
+         length = SCHARS (tem);
+         length_byte = SBYTES (tem);
        subst:
        subst:
-         new = (unsigned char *) xrealloc (buf, bsize += length_byte);
-         bufp += new - buf;
-         buf = new;
-         bcopy (start, bufp, length_byte);
-         bufp += length_byte;
-         nchars += length;
-         /* Check STRING again in case gc relocated it.  */
-         strp = (unsigned char *) XSTRING (string)->data + idx;
+         {
+           int offset = bufp - buf;
+           buf = (unsigned char *) xrealloc (buf, bsize += length_byte);
+           bufp = buf + offset;
+           bcopy (start, bufp, length_byte);
+           bufp += length_byte;
+           nchars += length;
+           /* Check STRING again in case gc relocated it.  */
+           strp = (unsigned char *) SDATA (string) + idx;
+         }
        }
       else if (! multibyte)            /* just copy other chars */
        *bufp++ = *strp++, nchars++;
       else
        {
          int len;
        }
       else if (! multibyte)            /* just copy other chars */
        *bufp++ = *strp++, nchars++;
       else
        {
          int len;
-         int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
+         int maxlen = SDATA (string) + SBYTES (string) - strp;
 
          STRING_CHAR_AND_LENGTH (strp, maxlen, len);
          if (len == 1)
 
          STRING_CHAR_AND_LENGTH (strp, maxlen, len);
          if (len == 1)
@@ -810,16 +918,10 @@ syms_of_doc ()
 {
   Qfunction_documentation = intern ("function-documentation");
   staticpro (&Qfunction_documentation);
 {
   Qfunction_documentation = intern ("function-documentation");
   staticpro (&Qfunction_documentation);
-  
+
   DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name,
   DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name,
-    "Name of file containing documentation strings of built-in symbols.");
+              doc: /* Name of file containing documentation strings of built-in symbols.  */);
   Vdoc_file_name = Qnil;
   Vdoc_file_name = Qnil;
-  DEFVAR_LISP ("help-manyarg-func-alist", &Vhelp_manyarg_func_alist,
-    "Alist of primitive functions and descriptions of their arg lists.\n\
-All special forms and primitives which effectively have &rest args\n\
-should have an entry here so that `documentation' can provide their\n\
-arg list.");
-  Vhelp_manyarg_func_alist = Qnil;
 
   defsubr (&Sdocumentation);
   defsubr (&Sdocumentation_property);
 
   defsubr (&Sdocumentation);
   defsubr (&Sdocumentation_property);