Use AREF and ASIZE.

[bpt/emacs.git] / src / doc.c

diff --git a/src/doc.c b/src/doc.c
index 937181e..be97690 100644 (file)
--- a/src/doc.c
+++ b/src/doc.c
@@ -1,11 +1,11 @@
 /* Record indices of function doc strings stored in a file.
 /* Record indices of function doc strings stored in a file.

-   Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
+   Copyright (C) 1985, 86,93,94,95,97,98,99, 2000 Free Software Foundation, Inc.

 
 This file is part of GNU Emacs.
 
 GNU Emacs is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This file is part of GNU Emacs.
 
 GNU Emacs is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

-the Free Software Foundation; either version 1, or (at your option)
+the Free Software Foundation; either version 2, or (at your option)

 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,


@@ -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
 
 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>
 
 
 #include <config.h>


@@ -38,9 +39,17 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #include "lisp.h"
 #include "buffer.h"
 #include "keyboard.h"
 #include "lisp.h"
 #include "buffer.h"
 #include "keyboard.h"

+#include "charset.h"
+#include "keymap.h"
+
+#ifdef HAVE_INDEX
+extern char *index P_ ((const char *, int));
+#endif

 
 Lisp_Object Vdoc_file_name;
 
 
 Lisp_Object Vdoc_file_name;
 

+Lisp_Object Qfunction_documentation;
+

 extern Lisp_Object Voverriding_local_map;
 
 /* For VMS versions with limited file name syntax,
 extern Lisp_Object Voverriding_local_map;
 
 /* For VMS versions with limited file name syntax,


@@ -67,31 +76,97 @@ munge_doc_file_name (name)
 #endif /* VMS */
 }
 
 #endif /* VMS */
 }
 

+/* Buffer used for reading from documentation file.  */
+static char *get_doc_string_buffer;
+static int get_doc_string_buffer_size;
+
+static unsigned char *read_bytecode_pointer;
+
+/* readchar in lread.c calls back here to fetch the next byte.
+   If UNREADFLAG is 1, we unread a byte.  */
+
+int
+read_bytecode_char (unreadflag)
+     int unreadflag;
+{
+  if (unreadflag)
+    {
+      read_bytecode_pointer--;
+      return 0;
+    }
+  return *read_bytecode_pointer++;
+}
+
+/* Extract a doc string from a file.  FILEPOS says where to get it.
+   If it is an integer, use that position in the standard DOC-... file.
+   If it is (FILE . INTEGER), use FILE as the file name
+   and INTEGER as the position in that file.
+   But if INTEGER is negative, make it positive.
+   (A negative integer is used for user variables, so we can distinguish
+   them without actually fetching the doc string.)
+
+   If UNIBYTE is nonzero, always make a unibyte string.
+
+   If DEFINITION is nonzero, assume this is for reading
+   a dynamic function definition; convert the bytestring
+   and the constants vector with appropriate byte handling,
+   and return a cons cell.  */
+

 Lisp_Object
 Lisp_Object

-get_doc_string (filepos)
-     long filepos;
+get_doc_string (filepos, unibyte, definition)
+     Lisp_Object filepos;
+     int unibyte, definition;

 {
 {

-  char buf[512 * 32 + 1];
+  char *from, *to;

   register int fd;
   register char *name;
   register char *p, *p1;
   register int fd;
   register char *name;
   register char *p, *p1;

-  register int count;

   int minsize;
   int minsize;

-  extern char *index ();
+  int offset, position;
+  Lisp_Object file, tem;

 
 

-  if (!STRINGP (Vdoc_directory) || !STRINGP (Vdoc_file_name))
+  if (INTEGERP (filepos))
+    {
+      file = Vdoc_file_name;
+      position = XINT (filepos);
+    }
+  else if (CONSP (filepos))
+    {
+      file = XCAR (filepos);
+      position = XINT (XCDR (filepos));
+      if (position < 0)
+       position = - position;
+    }
+  else

     return Qnil;
 
     return Qnil;
 

-  minsize = XSTRING (Vdoc_directory)->size;
-  /* sizeof ("../etc/") == 8 */
-  if (minsize < 8)
-    minsize = 8;
-  name = (char *) alloca (minsize + XSTRING (Vdoc_file_name)->size + 8);
-  strcpy (name, XSTRING (Vdoc_directory)->data);
-  strcat (name, XSTRING (Vdoc_file_name)->data);
-  munge_doc_file_name (name);
+  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.  */

 
 

-  fd = open (name, O_RDONLY, 0);
+  tem = Ffile_name_absolute_p (file);
+  if (NILP (tem))
+    {
+      minsize = XSTRING (Vdoc_directory)->size;
+      /* 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);
+      munge_doc_file_name (name);
+    }
+  else
+    {
+      name = (char *) XSTRING (file)->data;
+    }
+
+  fd = emacs_open (name, O_RDONLY, 0);

   if (fd < 0)
     {
 #ifndef CANNOT_DUMP
   if (fd < 0)
     {
 #ifndef CANNOT_DUMP


@@ -100,140 +175,245 @@ get_doc_string (filepos)
          /* 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 (Vdoc_file_name)->data);
+         strcat (name, XSTRING (file)->data);

          munge_doc_file_name (name);
 
          munge_doc_file_name (name);
 

-         fd = open (name, O_RDONLY, 0);
+         fd = emacs_open (name, O_RDONLY, 0);

        }
 #endif
        }
 #endif

-

       if (fd < 0)
        error ("Cannot open doc string file \"%s\"", name);
     }
 
       if (fd < 0)
        error ("Cannot open doc string file \"%s\"", name);
     }
 

-  if (0 > lseek (fd, filepos, 0))
+  /* Seek only to beginning of disk block.  */
+  offset = position % (8 * 1024);
+  if (0 > lseek (fd, position - offset, 0))

     {
     {

-      close (fd);
+      emacs_close (fd);

       error ("Position %ld out of range in doc string file \"%s\"",
       error ("Position %ld out of range in doc string file \"%s\"",

-            filepos, name);
+            position, name);

     }
     }

-  p = buf;
-  while (p != buf + sizeof buf - 1)
+
+  /* Read the doc string into get_doc_string_buffer.
+     P points beyond the data just read.  */
+
+  p = get_doc_string_buffer;
+  while (1)

     {
     {

-      count = read (fd, p, 512);
-      p[count] = 0;
-      if (!count)
+      int space_left = (get_doc_string_buffer_size
+                       - (p - get_doc_string_buffer));
+      int nread;
+
+      /* Allocate or grow the buffer if we need to.  */
+      if (space_left == 0)
+       {
+         int in_buffer = p - get_doc_string_buffer;
+         get_doc_string_buffer_size += 16 * 1024;
+         get_doc_string_buffer
+           = (char *) xrealloc (get_doc_string_buffer,
+                                get_doc_string_buffer_size + 1);
+         p = get_doc_string_buffer + in_buffer;
+         space_left = (get_doc_string_buffer_size
+                       - (p - get_doc_string_buffer));
+       }
+
+      /* Read a disk block at a time.
+         If we read the same block last time, maybe skip this?  */
+      if (space_left > 1024 * 8)
+       space_left = 1024 * 8;
+      nread = emacs_read (fd, p, space_left);
+      if (nread < 0)
+       {
+         emacs_close (fd);
+         error ("Read error on documentation file");
+       }
+      p[nread] = 0;
+      if (!nread)

        break;
        break;

-      p1 = index (p, '\037');
+      if (p == get_doc_string_buffer)
+       p1 = (char *) index (p + offset, '\037');
+      else
+       p1 = (char *) index (p, '\037');

       if (p1)
        {
          *p1 = 0;
          p = p1;
          break;
        }
       if (p1)
        {
          *p1 = 0;
          p = p1;
          break;
        }

-      p += count;
+      p += nread;
+    }
+  emacs_close (fd);
+
+  /* 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;
+  to = get_doc_string_buffer + offset;
+  while (from != p)
+    {
+      if (*from == 1)
+       {
+         int c;
+
+         from++;
+         c = *from++;
+         if (c == 1)
+           *to++ = c;
+         else if (c == '0')
+           *to++ = 0;
+         else if (c == '_')
+           *to++ = 037;
+         else
+           error ("Invalid data in documentation file -- ^A followed by code 0%o", c);
+       }
+      else
+       *to++ = *from++;
+    }
+
+  /* If DEFINITION, read from this buffer
+     the same way we would read bytes from a file.  */
+  if (definition)
+    {
+      read_bytecode_pointer = get_doc_string_buffer + offset;
+      return Fread (Qlambda);
+    }
+
+  if (unibyte)
+    return make_unibyte_string (get_doc_string_buffer + offset,
+                               to - (get_doc_string_buffer + offset));
+  else
+    {
+      /* Let the data determine whether the string is multibyte,
+        even if Emacs is running in --unibyte mode.  */
+      int nchars = multibyte_chars_in_text (get_doc_string_buffer + offset,
+                                           to - (get_doc_string_buffer + offset));
+      return make_string_from_bytes (get_doc_string_buffer + offset,
+                                    nchars,
+                                    to - (get_doc_string_buffer + offset));

     }
     }

-  close (fd);
-  return make_string (buf, p - buf);
+}
+
+/* Get a string from position FILEPOS and pass it through the Lisp reader.
+   We use this for fetching the bytecode string and constants vector
+   of a compiled function from the .elc file.  */
+
+Lisp_Object
+read_doc_string (filepos)
+     Lisp_Object filepos;
+{
+  return get_doc_string (filepos, 0, 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 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;
 

+  doc = Qnil;
+  
+  if (SYMBOLP (function)
+      && (tem = Fget (function, Qfunction_documentation),
+         !NILP (tem)))
+    return Fdocumentation_property (function, Qfunction_documentation, raw);
+  

   fun = Findirect_function (function);
   fun = Findirect_function (function);

-
-  switch (XTYPE (fun))
+  if (SUBRP (fun))

     {
     {

-    case Lisp_Subr:
-      if (XSUBR (fun)->doc == 0) return Qnil;
-      if ((EMACS_INT) XSUBR (fun)->doc >= 0)
+      if (XSUBR (fun)->doc == 0)
+       return Qnil;
+      else if ((EMACS_INT) XSUBR (fun)->doc >= 0)

        doc = build_string (XSUBR (fun)->doc);
       else
        doc = build_string (XSUBR (fun)->doc);
       else

-       doc = get_doc_string (- (EMACS_INT) XSUBR (fun)->doc);
-      break;
-      
-    case Lisp_Compiled:
-      if (XVECTOR (fun)->size <= COMPILED_DOC_STRING)
+       doc = get_doc_string (make_number (- (EMACS_INT) XSUBR (fun)->doc),
+                             0, 0);
+    }
+  else if (COMPILEDP (fun))
+    {
+      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) <= COMPILED_DOC_STRING)

        return Qnil;
       tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
       if (STRINGP (tem))
        doc = tem;
        return Qnil;
       tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
       if (STRINGP (tem))
        doc = tem;

-      else if (INTEGERP (tem) && XINT (tem) >= 0)
-       doc = get_doc_string (XFASTINT (tem));
+      else if (NATNUMP (tem) || CONSP (tem))
+       doc = get_doc_string (tem, 0, 0);

       else
        return Qnil;
       else
        return Qnil;

-      break;
-
-    case Lisp_String:
-    case Lisp_Vector:
+    }
+  else if (STRINGP (fun) || VECTORP (fun))
+    {

       return build_string ("Keyboard macro.");
       return build_string ("Keyboard macro.");

-
-    case Lisp_Cons:
+    }
+  else if (CONSP (fun))
+    {

       funcar = Fcar (fun);
       if (!SYMBOLP (funcar))
        return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
       else if (EQ (funcar, Qkeymap))
       funcar = Fcar (fun);
       if (!SYMBOLP (funcar))
        return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
       else if (EQ (funcar, Qkeymap))

-       return build_string ("Prefix command (definition is a keymap associating keystrokes with\n\
-subcommands.)");
+       return build_string ("Prefix command (definition is a keymap associating keystrokes with commands).");

       else if (EQ (funcar, Qlambda)
               || EQ (funcar, Qautoload))
        {
       else if (EQ (funcar, Qlambda)
               || EQ (funcar, Qautoload))
        {

-         tem = Fcar (Fcdr (Fcdr (fun)));
+         Lisp_Object tem1;
+         tem1 = Fcdr (Fcdr (fun));
+         tem = Fcar (tem1);

          if (STRINGP (tem))
            doc = tem;
          if (STRINGP (tem))
            doc = tem;

-         else if (INTEGERP (tem) && XINT (tem) >= 0)
-           doc = get_doc_string (XFASTINT (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
            return Qnil;
          else
            return Qnil;

-
-         break;

        }
       else if (EQ (funcar, Qmocklisp))
        return Qnil;
       else if (EQ (funcar, Qmacro))
        return Fdocumentation (Fcdr (fun), raw);
        }
       else if (EQ (funcar, Qmocklisp))
        return Qnil;
       else if (EQ (funcar, Qmacro))
        return Fdocumentation (Fcdr (fun), raw);

-
-      /* Fall through to the default to report an error.  */
-
-    default:
-      return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
+      else
+       goto oops;

     }
     }

-
-  if (NILP (raw))
+  else

     {
     {

-      struct gcpro gcpro1;
-
-      GCPRO1 (doc);
-      doc = Fsubstitute_command_keys (doc);
-      UNGCPRO;
+    oops:
+      Fsignal (Qinvalid_function, Fcons (fun, Qnil));

     }
     }

+
+  if (NILP (raw))
+    doc = Fsubstitute_command_keys (doc);

   return doc;
 }
 
   return doc;
 }
 

-DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 3, 0,
-  "Return the documentation string that is SYMBOL's PROP property.\n\
-This is like `get', but it can refer to strings stored in the\n\
-`etc/DOC' file; and if the value is a string, it is passed through\n\
-`substitute-command-keys'.  A non-nil third argument avoids this\n\
-translation.")
-  (sym, prop, raw)
-     Lisp_Object sym, prop, raw;
+DEFUN ("documentation-property", Fdocumentation_property,
+       Sdocumentation_property, 2, 3, 0,
+       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;

 {
 {

-  register Lisp_Object tem;
+  Lisp_Object tem;

 
 

-  tem = Fget (sym, prop);
+  tem = Fget (symbol, prop);

   if (INTEGERP (tem))
   if (INTEGERP (tem))

-    tem = get_doc_string (XINT (tem) > 0 ? XINT (tem) : - XINT (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);
+  else if (!STRINGP (tem))
+    /* Feval protects its argument.  */
+    tem = Feval (tem);
+  

   if (NILP (raw) && STRINGP (tem))
   if (NILP (raw) && STRINGP (tem))

-    return Fsubstitute_command_keys (tem);
+    tem = Fsubstitute_command_keys (tem);

   return tem;
 }
 \f
   return tem;
 }
 \f


@@ -242,7 +422,8 @@ translation.")
 static void
 store_function_docstring (fun, offset)
      Lisp_Object fun;
 static void
 store_function_docstring (fun, offset)
      Lisp_Object fun;

-     int offset;
+     /* Use EMACS_INT because we get this from pointer subtraction.  */
+     EMACS_INT offset;

 {
   fun = indirect_function (fun);
 
 {
   fun = indirect_function (fun);
 


@@ -257,15 +438,15 @@ store_function_docstring (fun, offset)
     {
       Lisp_Object tem;
 
     {
       Lisp_Object tem;
 

-      tem = XCONS (fun)->car;
+      tem = XCAR (fun);

       if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
        {
          tem = Fcdr (Fcdr (fun));
       if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
        {
          tem = Fcdr (Fcdr (fun));

-         if (CONSP (tem) && INTEGERP (XCONS (tem)->car))
-           XFASTINT (XCONS (tem)->car) = offset;
+         if (CONSP (tem) && INTEGERP (XCAR (tem)))
+           XSETCARFASTINT (tem, offset);

        }
       else if (EQ (tem, Qmacro))
        }
       else if (EQ (tem, Qmacro))

-       store_function_docstring (XCONS (fun)->cdr, offset);
+       store_function_docstring (XCDR (fun), offset);

     }
 
   /* Bytecode objects sometimes have slots for it.  */
     }
 
   /* Bytecode objects sometimes have slots for it.  */


@@ -273,21 +454,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 > COMPILED_DOC_STRING)
-       XFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING]) = offset;
+      if ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING)
+       XSETFASTINT (XVECTOR (fun)->contents[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;


@@ -295,24 +477,23 @@ 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
 
 
 #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);

 
 #ifndef CANNOT_DUMP
   name = (char *) alloca (XSTRING (filename)->size + 14);
   strcpy (name, "../etc/");
 #else /* CANNOT_DUMP */
 
 #ifndef CANNOT_DUMP
   name = (char *) alloca (XSTRING (filename)->size + 14);
   strcpy (name, "../etc/");
 #else /* CANNOT_DUMP */

-  CHECK_STRING (Vdoc_directory, 0);
-  name = (char *) alloca (XSTRING (filename)->size +
-                         XSTRING (Vdoc_directory)->size + 1);
+  CHECK_STRING (Vdoc_directory);
+  name = (char *) alloca (XSTRING (filename)->size
+                         + XSTRING (Vdoc_directory)->size + 1);

   strcpy (name, XSTRING (Vdoc_directory)->data);
 #endif /* CANNOT_DUMP */
   strcat (name, XSTRING (filename)->data);     /*** Add this line ***/
   strcpy (name, XSTRING (Vdoc_directory)->data);
 #endif /* CANNOT_DUMP */
   strcat (name, XSTRING (filename)->data);     /*** Add this line ***/


@@ -333,7 +514,7 @@ when doc strings are referred to later in the dumped Emacs.")
 #endif /* VMS4_4 */
 #endif /* VMS */
 
 #endif /* VMS4_4 */
 #endif /* VMS */
 

-  fd = open (name, O_RDONLY, 0);
+  fd = emacs_open (name, O_RDONLY, 0);

   if (fd < 0)
     report_file_error ("Opening doc string file",
                       Fcons (build_string (name), Qnil));
   if (fd < 0)
     report_file_error ("Opening doc string file",
                       Fcons (build_string (name), Qnil));


@@ -343,7 +524,7 @@ when doc strings are referred to later in the dumped Emacs.")
   while (1)
     {
       if (filled < 512)
   while (1)
     {
       if (filled < 512)

-       filled += read (fd, &buf[filled], sizeof buf - 1 - filled);
+       filled += emacs_read (fd, &buf[filled], sizeof buf - 1 - filled);

       if (!filled)
        break;
 
       if (!filled)
        break;
 


@@ -354,8 +535,10 @@ 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');
-         sym = oblookup (Vobarray, p + 2, end - p - 2);
+         end = (char *) index (p, '\n');
+         sym = oblookup (Vobarray, p + 2,
+                         multibyte_chars_in_text (p + 2, end - p - 2),
+                         end - p - 2);

          if (SYMBOLP (sym))
            {
              /* Attach a docstring to a variable?  */
          if (SYMBOLP (sym))
            {
              /* Attach a docstring to a variable?  */


@@ -381,24 +564,24 @@ when doc strings are referred to later in the dumped Emacs.")
       filled -= end - buf;
       bcopy (end, buf, filled);
     }
       filled -= end - buf;
       bcopy (end, buf, filled);
     }

-  close (fd);
+  emacs_close (fd);

   return Qnil;
 }
 \f
 DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
   return Qnil;
 }
 \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.")
-  (str)
-     Lisp_Object str;
+       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;
   int changed = 0;
 {
   unsigned char *buf;
   int changed = 0;


@@ -406,62 +589,91 @@ 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;

-  int length;
+  int length, length_byte;

   Lisp_Object name;
   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
   Lisp_Object name;
   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

+  int multibyte;
+  int nchars;

 
 

-  if (NILP (str))
+  if (NILP (string))

     return Qnil;
 
     return Qnil;
 

-  CHECK_STRING (str, 0);
+  CHECK_STRING (string);

   tem = Qnil;
   keymap = Qnil;
   name = Qnil;
   tem = Qnil;
   keymap = Qnil;
   name = Qnil;

-  GCPRO4 (str, tem, keymap, name);
+  GCPRO4 (string, tem, keymap, name);
+
+  multibyte = STRING_MULTIBYTE (string);
+  nchars = 0;

 
   /* KEYMAP is either nil (which means search all the active keymaps)
      or a specified local map (which means search just that and the
      global map).  If non-nil, it might come from Voverriding_local_map,
 
   /* KEYMAP is either nil (which means search all the active keymaps)
      or a specified local map (which means search just that and the
      global map).  If non-nil, it might come from Voverriding_local_map,

-     or from a \\<mapname> construct in STR itself..  */
-  keymap = Voverriding_local_map;
+     or from a \\<mapname> construct in STRING itself..  */
+  keymap = current_kboard->Voverriding_terminal_local_map;
+  if (NILP (keymap))
+    keymap = Voverriding_local_map;

 
 

-  bsize = XSTRING (str)->size;
+  bsize = STRING_BYTES (XSTRING (string));

   bufp = buf = (unsigned char *) xmalloc (bsize);
 
   bufp = buf = (unsigned char *) xmalloc (bsize);
 

-  strp = (unsigned char *) XSTRING (str)->data;
-  while (strp < (unsigned char *) XSTRING (str)->data + XSTRING (str)->size)
+  strp = (unsigned char *) XSTRING (string)->data;
+  while (strp < XSTRING (string)->data + STRING_BYTES (XSTRING (string)))

     {
       if (strp[0] == '\\' && strp[1] == '=')
        {
          /* \= quotes the next character;
             thus, to put in \[ without its special meaning, use \=\[.  */
          changed = 1;
     {
       if (strp[0] == '\\' && strp[1] == '=')
        {
          /* \= quotes the next character;
             thus, to put in \[ without its special meaning, use \=\[.  */
          changed = 1;

-         *bufp++ = strp[2];
-         strp += 3;
+         strp += 2;
+         if (multibyte)
+           {
+             int len;
+             int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
+
+             STRING_CHAR_AND_LENGTH (strp, maxlen, len);
+             if (len == 1)
+               *bufp = *strp;
+             else
+               bcopy (strp, bufp, len);
+             strp += len;
+             bufp += len;
+             nchars++;
+           }
+         else
+           *bufp++ = *strp++, nchars++;

        }
       else if (strp[0] == '\\' && strp[1] == '[')
        {
          Lisp_Object firstkey;
        }
       else if (strp[0] == '\\' && strp[1] == '[')
        {
          Lisp_Object firstkey;

+         int start_idx;

 
          changed = 1;
          strp += 2;            /* skip \[ */
          start = strp;
 
          changed = 1;
          strp += 2;            /* skip \[ */
          start = strp;

+         start_idx = start - XSTRING (string)->data;

 
 

-         while ((strp - (unsigned char *) XSTRING (str)->data
-                 < XSTRING (str)->size)
+         while ((strp - (unsigned char *) XSTRING (string)->data
+                 < STRING_BYTES (XSTRING (string)))

                 && *strp != ']')
            strp++;
                 && *strp != ']')
            strp++;

-         length = strp - start;
+         length_byte = strp - start;
+

          strp++;               /* skip ] */
 
          /* Save STRP in IDX.  */
          strp++;               /* skip ] */
 
          /* Save STRP in IDX.  */

-         idx = strp - (unsigned char *) XSTRING (str)->data;
-         tem = Fintern (make_string (start, length), Qnil);
+         idx = strp - (unsigned char *) XSTRING (string)->data;
+         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);
          tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);

+         strp = XSTRING (string)->data + idx;
+         start = XSTRING (string)->data + 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


@@ -475,11 +687,16 @@ 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;
              bcopy ("M-x ", bufp, 4);
              bufp += 4;

+             nchars += 4;
+             if (multibyte)
+               length = multibyte_chars_in_text (start, length_byte);
+             else
+               length = length_byte;

              goto subst;
            }
          else
              goto subst;
            }
          else


@@ -493,31 +710,39 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
       else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<'))
        {
          struct buffer *oldbuf;
       else if (strp[0] == '\\' && (strp[1] == '{' || strp[1] == '<'))
        {
          struct buffer *oldbuf;

+         int start_idx;

 
          changed = 1;
          strp += 2;            /* skip \{ or \< */
          start = strp;
 
          changed = 1;
          strp += 2;            /* skip \{ or \< */
          start = strp;

+         start_idx = start - XSTRING (string)->data;

 
 

-         while ((strp - (unsigned char *) XSTRING (str)->data
-                 < XSTRING (str)->size)
+         while ((strp - (unsigned char *) XSTRING (string)->data
+                 < XSTRING (string)->size)

                 && *strp != '}' && *strp != '>')
            strp++;
                 && *strp != '}' && *strp != '>')
            strp++;

-         length = strp - start;
+
+         length_byte = strp - start;

          strp++;                       /* skip } or > */
 
          /* Save STRP in IDX.  */
          strp++;                       /* skip } or > */
 
          /* Save STRP in IDX.  */

-         idx = strp - (unsigned char *) XSTRING (str)->data;
+         idx = strp - (unsigned char *) XSTRING (string)->data;

 
          /* Get the value of the keymap in TEM, or nil if undefined.
             Do this while still in the user's current buffer
             in case it is a local variable.  */
 
          /* Get the value of the keymap in TEM, or nil if undefined.
             Do this while still in the user's current buffer
             in case it is a local variable.  */

-         name = Fintern (make_string (start, length), Qnil);
+         name = Fintern (make_string (start, length_byte), Qnil);

          tem = Fboundp (name);
          if (! NILP (tem))
            {
              tem = Fsymbol_value (name);
              if (! NILP (tem))
          tem = Fboundp (name);
          if (! NILP (tem))
            {
              tem = Fsymbol_value (name);
              if (! NILP (tem))

-               tem = get_keymap_1 (tem, 0, 1);
+               {
+                 tem = get_keymap (tem, 0, 1);
+                 /* Note that get_keymap can GC.  */
+                 strp = XSTRING (string)->data + idx;
+                 start = XSTRING (string)->data + start_idx;
+               }

            }
 
          /* Now switch to a temp buffer.  */
            }
 
          /* Now switch to a temp buffer.  */


@@ -528,14 +753,16 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
            {
              name = Fsymbol_name (name);
              insert_string ("\nUses keymap \"");
            {
              name = Fsymbol_name (name);
              insert_string ("\nUses keymap \"");

-             insert_from_string (name, 0, XSTRING (name)->size, 1);
+             insert_from_string (name, 0, 0,
+                                 XSTRING (name)->size,
+                                 STRING_BYTES (XSTRING (name)), 1);

              insert_string ("\", which is not currently defined.\n");
              if (start[-1] == '<') keymap = Qnil;
            }
          else if (start[-1] == '<')
            keymap = tem;
          else
              insert_string ("\", which is not currently defined.\n");
              if (start[-1] == '<') keymap = Qnil;
            }
          else if (start[-1] == '<')
            keymap = tem;
          else

-           describe_map_tree (tem, 1, Qnil, Qnil, 0, 1);
+           describe_map_tree (tem, 1, Qnil, Qnil, (char *)0, 1, 0, 0);

          tem = Fbuffer_string ();
          Ferase_buffer ();
          set_buffer_internal (oldbuf);
          tem = Fbuffer_string ();
          Ferase_buffer ();
          set_buffer_internal (oldbuf);


@@ -543,31 +770,53 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
        subst_string:
          start = XSTRING (tem)->data;
          length = XSTRING (tem)->size;
        subst_string:
          start = XSTRING (tem)->data;
          length = XSTRING (tem)->size;

+         length_byte = STRING_BYTES (XSTRING (tem));

        subst:
        subst:

-         new = (unsigned char *) xrealloc (buf, bsize += length);
-         bufp += new - buf;
-         buf = new;
-         bcopy (start, bufp, length);
-         bufp += length;
-         /* Check STR again in case gc relocated it.  */
-         strp = (unsigned char *) XSTRING (str)->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 *) XSTRING (string)->data + idx;
+         }
+       }
+      else if (! multibyte)            /* just copy other chars */
+       *bufp++ = *strp++, nchars++;
+      else
+       {
+         int len;
+         int maxlen = XSTRING (string)->data + STRING_BYTES (XSTRING (string)) - strp;
+
+         STRING_CHAR_AND_LENGTH (strp, maxlen, len);
+         if (len == 1)
+           *bufp = *strp;
+         else
+           bcopy (strp, bufp, len);
+         strp += len;
+         bufp += len;
+         nchars++;

        }
        }

-      else                     /* just copy other chars */
-       *bufp++ = *strp++;

     }
 
   if (changed)                 /* don't bother if nothing substituted */
     }
 
   if (changed)                 /* don't bother if nothing substituted */

-    tem = make_string (buf, bufp - buf);
+    tem = make_string_from_bytes (buf, nchars, bufp - buf);

   else
   else

-    tem = str;
+    tem = string;

   xfree (buf);
   RETURN_UNGCPRO (tem);
 }
 \f
   xfree (buf);
   RETURN_UNGCPRO (tem);
 }
 \f

+void

 syms_of_doc ()
 {
 syms_of_doc ()
 {

+  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;
 
   defsubr (&Sdocumentation);
   Vdoc_file_name = Qnil;
 
   defsubr (&Sdocumentation);