]> code.delx.au - gnu-emacs/blobdiff - src/doc.c
*** empty log message ***
[gnu-emacs] / src / doc.c
index 255631d904b90669d3e300828edd75ef42fdddbe..e6914d2403881cc5a9213fe204789cd24e3a8898 100644 (file)
--- a/src/doc.c
+++ b/src/doc.c
@@ -1,5 +1,6 @@
 /* Record indices of function doc strings stored in a file.
-   Copyright (C) 1985, 86,93,94,95,97,98,99, 2000 Free Software Foundation, Inc.
+   Copyright (C) 1985, 86,93,94,95,97,98,99,2000,04
+             Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -24,7 +25,7 @@ Boston, MA 02111-1307, USA.  */
 #include <sys/types.h>
 #include <sys/file.h>  /* Must be after sys/types.h for USG and BSD4_1*/
 
-#ifdef USG5
+#ifdef HAVE_FCNTL_H
 #include <fcntl.h>
 #endif
 
@@ -151,25 +152,25 @@ get_doc_string (filepos, unibyte, definition)
 
   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))
     {
-      minsize = XSTRING (Vdoc_directory)->size;
+      minsize = SCHARS (Vdoc_directory);
       /* 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
     {
-      name = (char *) XSTRING (file)->data;
+      name = (char *) SDATA (file);
     }
 
   fd = emacs_open (name, O_RDONLY, 0);
@@ -181,7 +182,7 @@ get_doc_string (filepos, unibyte, definition)
          /* 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);
@@ -339,16 +340,18 @@ 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? ");
+  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);
@@ -373,12 +376,12 @@ string is passed through `substitute-command-keys'.  */)
  documentation:
 
   doc = Qnil;
-  
+
   if (SYMBOLP (function)
       && (tem = Fget (function, Qfunction_documentation),
          !NILP (tem)))
     return Fdocumentation_property (function, Qfunction_documentation, raw);
-  
+
   fun = Findirect_function (function);
   if (SUBRP (fun))
     {
@@ -441,8 +444,8 @@ string is passed through `substitute-command-keys'.  */)
 
   /* If DOC is 0, it's typically because of a dumped file missing
      from the DOC file (bug in src/Makefile.in).  */
-  if (EQ (tem, make_number (0)))
-      tem = Qnil;
+  if (EQ (doc, make_number (0)))
+    doc = Qnil;
   if (INTEGERP (doc) || CONSP (doc))
     {
       Lisp_Object tem;
@@ -485,10 +488,10 @@ aren't strings.  */)
   Lisp_Object tem;
 
  documentation_property:
-  
+
   tem = Fget (symbol, prop);
   if (EQ (tem, make_number (0)))
-      tem = Qnil;
+    tem = Qnil;
   if (INTEGERP (tem) || (CONSP (tem) && INTEGERP (XCDR (tem))))
     {
       Lisp_Object doc = tem;
@@ -510,7 +513,7 @@ aren't strings.  */)
   else if (!STRINGP (tem))
     /* Feval protects its argument.  */
     tem = Feval (tem);
-  
+
   if (NILP (raw) && STRINGP (tem))
     tem = Fsubstitute_command_keys (tem);
   return tem;
@@ -567,7 +570,7 @@ 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'.  */)
+the same file name is found in the `doc-directory'.  */)
      (filename)
      Lisp_Object filename;
 {
@@ -588,17 +591,17 @@ the same file name is found in the `data-directory'.  */)
       (0)
 #endif /* CANNOT_DUMP */
     {
-      name = (char *) alloca (XSTRING (filename)->size + 14);
+      name = (char *) alloca (SCHARS (filename) + 14);
       strcpy (name, "../etc/");
     }
   else
     {
       CHECK_STRING (Vdoc_directory);
-      name = (char *) alloca (XSTRING (filename)->size
-                         + XSTRING (Vdoc_directory)->size + 1);
-      strcpy (name, XSTRING (Vdoc_directory)->data);
+      name = (char *) alloca (SCHARS (filename)
+                         + SCHARS (Vdoc_directory) + 1);
+      strcpy (name, SDATA (Vdoc_directory));
     }
-  strcat (name, XSTRING (filename)->data);     /*** Add this line ***/
+  strcat (name, SDATA (filename));     /*** Add this line ***/
 #ifdef VMS
 #ifndef VMS4_4
   /* For VMS versions with limited file name syntax,
@@ -610,8 +613,7 @@ the same file name is found in the `data-directory'.  */)
        *p = '_';
       p++;
     }
-#endif /* not VMS4_4 */
-#ifdef VMS4_4
+#else /* VMS4_4 */
   strcpy (name, sys_translate_unix (name));
 #endif /* VMS4_4 */
 #endif /* VMS */
@@ -658,6 +660,9 @@ the same file name is found in the `data-directory'.  */)
              else if (p[1] == 'F')
                store_function_docstring (sym, pos + end + 1 - buf);
 
+             else if (p[1] == 'S')
+               ; /* Just a source file name boundary marker.  Ignore it.  */
+
              else
                error ("DOC file invalid at position %d", pos);
            }
@@ -720,11 +725,11 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
   if (NILP (keymap))
     keymap = Voverriding_local_map;
 
-  bsize = STRING_BYTES (XSTRING (string));
+  bsize = SBYTES (string);
   bufp = buf = (unsigned char *) xmalloc (bsize);
 
-  strp = (unsigned char *) XSTRING (string)->data;
-  while (strp < XSTRING (string)->data + STRING_BYTES (XSTRING (string)))
+  strp = SDATA (string);
+  while (strp < SDATA (string) + SBYTES (string))
     {
       if (strp[0] == '\\' && strp[1] == '=')
        {
@@ -735,7 +740,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          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)
@@ -757,10 +762,10 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          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 - SDATA (string)
+                 < SBYTES (string))
                 && *strp != ']')
            strp++;
          length_byte = strp - start;
@@ -768,14 +773,18 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          strp++;               /* skip ] */
 
          /* Save STRP in IDX.  */
-         idx = strp - (unsigned char *) XSTRING (string)->data;
+         idx = strp - SDATA (string);
          tem = Fintern (make_string (start, length_byte), Qnil);
 
+         /* Ignore remappings unless there are no ordinary bindings. */
+         tem = Fwhere_is_internal (tem, keymap, Qt, Qnil, Qt);
+         if (NILP (tem))
+           tem = Fwhere_is_internal (tem, keymap, Qt, Qnil, 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, Qnil);
-         strp = XSTRING (string)->data + idx;
-         start = XSTRING (string)->data + start_idx;
+         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
@@ -803,7 +812,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
            }
          else
            {                   /* function is on a key */
-             tem = Fkey_description (tem);
+             tem = Fkey_description (tem, Qnil);
              goto subst_string;
            }
        }
@@ -817,10 +826,9 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          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 - SDATA (string) < SBYTES (string))
                 && *strp != '}' && *strp != '>')
            strp++;
 
@@ -828,7 +836,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          strp++;                       /* skip } or > */
 
          /* Save STRP in IDX.  */
-         idx = strp - (unsigned char *) XSTRING (string)->data;
+         idx = strp - SDATA (string);
 
          /* Get the value of the keymap in TEM, or nil if undefined.
             Do this while still in the user's current buffer
@@ -842,8 +850,8 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
                {
                  tem = get_keymap (tem, 0, 1);
                  /* Note that get_keymap can GC.  */
-                 strp = XSTRING (string)->data + idx;
-                 start = XSTRING (string)->data + start_idx;
+                 strp = SDATA (string) + idx;
+                 start = SDATA (string) + start_idx;
                }
            }
 
@@ -856,8 +864,8 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
              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;
            }
@@ -870,9 +878,9 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
          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:
          {
            int offset = bufp - buf;
@@ -882,7 +890,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
            bufp += length_byte;
            nchars += length;
            /* Check STRING again in case gc relocated it.  */
-           strp = (unsigned char *) XSTRING (string)->data + idx;
+           strp = (unsigned char *) SDATA (string) + idx;
          }
        }
       else if (! multibyte)            /* just copy other chars */
@@ -890,7 +898,7 @@ thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ int
       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)
@@ -916,7 +924,7 @@ syms_of_doc ()
 {
   Qfunction_documentation = intern ("function-documentation");
   staticpro (&Qfunction_documentation);
-  
+
   DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name,
               doc: /* Name of file containing documentation strings of built-in symbols.  */);
   Vdoc_file_name = Qnil;
@@ -926,3 +934,6 @@ syms_of_doc ()
   defsubr (&Ssnarf_documentation);
   defsubr (&Ssubstitute_command_keys);
 }
+
+/* arch-tag: 56281d4d-6949-43e2-be2e-f6517de744ba
+   (do not change this comment) */