changeset 1651:ef09501a0a9b

* doc.c (store_function_docstring): New function, made from part of Fsnarf_documentation, which handles docstrings for macros properly. (Fsnarf_documentation): Call store_function_docstring.
author Jim Blandy <jimb@redhat.com>
date Sun, 06 Dec 1992 22:16:26 +0000
parents 60a49bc9673a
children 93497cd89204
files src/doc.c
diffstat 1 files changed, 49 insertions(+), 34 deletions(-) [+]
line wrap: on
line diff
--- a/src/doc.c	Sun Dec 06 22:16:01 1992 +0000
+++ b/src/doc.c	Sun Dec 06 22:16:26 1992 +0000
@@ -202,6 +202,51 @@
   return tem;
 }
 
+/* Scanning the DOC files and placing docstring offsets into functions.  */
+
+static void
+store_function_docstring (fun, offset)
+     Lisp_Object fun;
+     int offset;
+{
+  fun = indirect_function (fun);
+
+  /* The type determines where the docstring is stored.  */
+
+  /* Lisp_Subrs have a slot for it.  */
+  if (XTYPE (fun) == Lisp_Subr)
+    XSUBR (fun)->doc = (char *) - offset;
+
+  /* If it's a lisp form, stick it in the form.  */
+  else if (CONSP (fun))
+    {
+      Lisp_Object tem;
+
+      tem = XCONS (fun)->car;
+      if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
+	{
+	  tem = Fcdr (Fcdr (fun));
+	  if (CONSP (tem) &&
+	      XTYPE (XCONS (tem)->car) == Lisp_Int)
+	    XFASTINT (XCONS (tem)->car) = offset;
+	}
+      else if (EQ (tem, Qmacro))
+	store_function_docstring (XCONS (fun)->cdr, offset);
+    }
+
+  /* Bytecode objects sometimes have slots for it.  */
+  else if (XTYPE (fun) == Lisp_Compiled)
+    {
+      /* 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)
+	abort ();
+
+      XFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING]) = offset;
+    }
+}
+
+
 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
   1, 1, 0,
   "Used during Emacs initialization, before dumping runnable Emacs,\n\
@@ -292,42 +337,12 @@
 				     * (end[1] == '*' ? -1 : 1)));
 		}
 
-	      /* Attach a docstring to a function?  The type determines where
-	         the docstring is stored.  */
+	      /* Attach a docstring to a function?  */
 	      else if (p[1] == 'F')
-		{
-		  fun = XSYMBOL (sym)->function;
-
-		  /* Lisp_Subrs have a slot for it.  */
-		  if (XTYPE (fun) == Lisp_Subr)
-		    XSUBR (fun)->doc = (char *) - (pos + end + 1 - buf);
+		store_function_docstring (sym, pos + end + 1 - buf);
 
-		  /* If it's a lisp form, stick it in the form.  */
-		  else if (CONSP (fun))
-		    {
-		      tem = XCONS (fun)->car;
-		      if (EQ (tem, Qlambda) || EQ (tem, Qautoload))
-			{
-			  tem = Fcdr (Fcdr (fun));
-			  if (CONSP (tem) &&
-			      XTYPE (XCONS (tem)->car) == Lisp_Int)
-			    XFASTINT (XCONS (tem)->car) = (pos + end + 1 - buf);
-			}
-		    }
-
-		  /* Bytecode objects sometimes have slots for it.  */
-		  else if (XTYPE (fun) == Lisp_Compiled)
-		    {
-		      /* 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)
-			abort ();
-
-		      XFASTINT (XVECTOR (fun)->contents[COMPILED_DOC_STRING])
-			= pos + end + 1 - buf;
-		    }
-		}
-	      else error ("DOC file invalid at position %d", pos);
+	      else
+		error ("DOC file invalid at position %d", pos);
 	    }
 	}
       pos += end - buf;