*** empty log message ***

[gnu-emacs] / src / doc.c

diff --git a/src/doc.c b/src/doc.c
index 98585f89b2e77e2ebc0cfc27603e44e9209cc396..6dceb587fcb15374cf49076277bc453601281554 100644 (file)
--- a/src/doc.c
+++ b/src/doc.c
@@ -1,5 +1,5 @@
 /* Record indices of function doc strings stored in a file.
-   Copyright (C) 1985, 1986 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -101,41 +101,40 @@ get_doc_string (filepos)
   return make_string (buf, p - buf);
 }
 
-DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 1, 0,
-  "Return the documentation string of FUNCTION.")
-  (fun1)
-     Lisp_Object fun1;
+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)
+     Lisp_Object function, raw;
 {
   Lisp_Object fun;
   Lisp_Object funcar;
-  Lisp_Object tem;
+  Lisp_Object tem, doc;
 
-  fun = fun1;
-  while (XTYPE (fun) == Lisp_Symbol)
-    {
-      QUIT;
-      fun = Fsymbol_function (fun);
-    }
+  fun = Findirect_function (function);
 
   switch (XTYPE (fun))
     {
     case Lisp_Subr:
       if (XSUBR (fun)->doc == 0) return Qnil;
       if ((int) XSUBR (fun)->doc >= 0)
-       return Fsubstitute_command_keys (build_string (XSUBR (fun)->doc));
+       doc = build_string (XSUBR (fun)->doc);
       else
-       return
-         Fsubstitute_command_keys (get_doc_string (- (int) XSUBR (fun)->doc));
+       doc = get_doc_string (- (int) XSUBR (fun)->doc);
+      break;
       
     case Lisp_Compiled:
       if (XVECTOR (fun)->size <= COMPILED_DOC_STRING)
        return Qnil;
       tem = XVECTOR (fun)->contents[COMPILED_DOC_STRING];
       if (XTYPE (tem) == Lisp_String)
-       return Fsubstitute_command_keys (tem);
-      if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
-       return Fsubstitute_command_keys (get_doc_string (XFASTINT (tem)));
-      return Qnil;
+       doc = tem;
+      else if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
+       doc = get_doc_string (XFASTINT (tem));
+      else
+       return Qnil;
+      break;
 
     case Lisp_String:
     case Lisp_Vector:
@@ -145,45 +144,53 @@ DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 1, 0,
       funcar = Fcar (fun);
       if (XTYPE (funcar) != Lisp_Symbol)
        return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
-      if (XSYMBOL (funcar) == XSYMBOL (Qkeymap))
+      else if (EQ (funcar, Qkeymap))
        return build_string ("Prefix command (definition is a keymap associating keystrokes with\n\
 subcommands.)");
-      if (XSYMBOL (funcar) == XSYMBOL (Qlambda)
-         || XSYMBOL (funcar) == XSYMBOL (Qautoload))
+      else if (EQ (funcar, Qlambda)
+              || EQ (funcar, Qautoload))
        {
          tem = Fcar (Fcdr (Fcdr (fun)));
          if (XTYPE (tem) == Lisp_String)
-           return Fsubstitute_command_keys (tem);
-         if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
-           return Fsubstitute_command_keys (get_doc_string (XFASTINT (tem)));
-         return Qnil;
+           doc = tem;
+         else if (XTYPE (tem) == Lisp_Int && XINT (tem) >= 0)
+           doc = get_doc_string (XFASTINT (tem));
+         else
+           return Qnil;
+
+         break;
        }
-      if (XSYMBOL (funcar) == XSYMBOL (Qmocklisp))
+      else if (EQ (funcar, Qmocklisp))
        return Qnil;
-      if (XSYMBOL (funcar) == XSYMBOL (Qmacro))
-       return Fdocumentation (Fcdr (fun));
+      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));
     }
+
+  if (NILP (raw))
+    doc = Fsubstitute_command_keys (doc);
+  return doc;
 }
 
-DEFUN ("documentation-property", Fdocumentation_property, 
-       Sdocumentation_property, 2, 2, 0,
+DEFUN ("documentation-property", Fdocumentation_property, Sdocumentation_property, 2, 2, 0,
   "Return the documentation string that is SYMBOL's PROP property.\n\
-This differs from using `get' only in that it can refer to strings\n\
-stored in the `share-lib/DOC' file.")
-  (sym, prop)
-     Lisp_Object sym, prop;
+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;
 {
   register Lisp_Object tem;
 
   tem = Fget (sym, prop);
   if (XTYPE (tem) == Lisp_Int)
     tem = get_doc_string (XINT (tem) > 0 ? XINT (tem) : - XINT (tem));
-  if (XTYPE (tem) == Lisp_String)
+  if (NILP (raw) && XTYPE (tem) == Lisp_String)
     return Fsubstitute_command_keys (tem);
   return tem;
 }
@@ -191,10 +198,10 @@ stored in the `share-lib/DOC' file.")
 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 `share-lib/DOC...' and\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 `../share-lib' now; found in the `data-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)
      Lisp_Object filename;
@@ -212,7 +219,7 @@ when doc strings are referred to later in the dumped Emacs.")
 
 #ifndef CANNOT_DUMP
   name = (char *) alloca (XSTRING (filename)->size + 14);
-  strcpy (name, "../share-lib/");
+  strcpy (name, "../etc/");
 #else /* CANNOT_DUMP */
   CHECK_STRING (Vdata_directory, 0);
   name = (char *) alloca (XSTRING (filename)->size +