Changeset 13686

Timestamp:

11/01/11 20:57:30 (12 years ago)

Author:

Mark Evenson

Message:

Starting to grovel resonable Tex from the docstrings (unfinished).

File:

• trunk/abcl/doc/manual/grovel.lisp (modified) (4 diffs)

trunk/abcl/doc/manual/grovel.lisp

@@ -3 +3 @@
   (with-open-file (stream "java.tex" :direction :output)
     (loop :for symbol :being :each :external-symbol :of package 
-       :collecting (symbol-as-tex symbol))))
+       :doing (format stream "~&~A~%~%"(symbol-as-tex symbol)))))
 
 (asdf:load-system 'swank) ;; XXX Does this load the SWANK-BACKEND package as well
 
-(defun arglist-as-string (symbol)
-  (loop :for arg :in (arglist symbol)
-     :collecting (format nil "~A" (symbol-name arg))))
+(defun arglist-as-tex (symbol)
+  (handler-case 
+      (loop :for arg :in (arglist symbol)
+         :collecting
+         (format nil 
+                 (if (string= (subseq (symbol-name arg) 0 1) #\&)
+                     "\\~A"
+                     "~A")
+                 (string-downcase (symbol-name arg))))
+    (t (e) 
+      (progn (warn "Failed to form arglist for ~A: ~A" symbol e)
+             (list "")))))
+             
 
 (defvar *type-alist* 
@@ -15 +25 @@
     (:macro . "Macro")
     (:variable . "Variable")
+    (:class . "Class")
     (:generic-function . "Generic Function")))
 
 (defun symbol-as-tex (symbol)
   "Return the TeX representation of a SYMBOL as Tex."
-  (let (type documentation arglist doc)
+  (let (type documentation arglist doc symbol-name package-name)
     (when (setf doc (swank-backend:describe-symbol-for-emacs symbol))
         (cond 
@@ -25 +36 @@
            (setf type :function
                  documentation (second doc)
-                 arglist (arglist-as-string symbol)))
+                 arglist (format nil "~{~A~^ ~}" (arglist-as-tex symbol))))
           ((find :variable doc)
            (setf type :variable 
@@ -34 +45 @@
           ((find :generic-function doc)
            (setf type :generic-function
-                 documentation (second doc))))
-        (format nil "\\ref{~A:~A}~&--- ~A [\\textbf{~A}]: ~A"
+                 documentation (second doc)))
+          ((find :class doc)
+           (setf type :class
+                 documentation (second doc)))
+          (t 
+           (warn "Unknown type of documentation for symbol ~A: ~A"
+                 symbol doc)))
+        (setf symbol-name (string-downcase 
+                           symbol)
+              package-name (string-downcase 
+                            (package-name (find-package (symbol-package symbol)))))
+        (format nil "\\label{~A:~A}~&--- ~A: \\textbf{~A} [\\textbf{~A}] \\textit{~A}~%~%~A"
                 (symbol-name symbol)
-                (package-name (symbol-package symbol))
+                (package-name (find-package (symbol-package symbol)))
                 (cdr (assoc type *type-alist*))
-                (symbol-name symbol)
-                (package-name (symbol-package symbol))))))
+                symbol-name
+                package-name
+                (if arglist arglist "")
+                (if documentation documentation "")))))
+