release: 1.3.104

[lilypond.git] / scm / generate-documentation.scm

diff --git a/scm/generate-documentation.scm b/scm/generate-documentation.scm
index 345e4da4ed853b8c2d4c37e6b763cb4b2e468f7a..d53207fabaa679bf720f6ca821aa7a32251eed7b 100644 (file)
--- a/scm/generate-documentation.scm
+++ b/scm/generate-documentation.scm
@@ -1,111 +1,46 @@
 
+;;; generate-documentation.scm -- Generate documentation
+;;;
+;;; source file of the GNU LilyPond music typesetter
+;;; 
+;;; (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;; Jan Nieuwenhuizen <janneke@gnu.org>
 
-(define (uniqued-alist  alist acc)
-  (if (null? alist) acc
-      (if (assoc (caar alist) acc)
-         (uniqued-alist (cdr alist) acc)
-         (uniqued-alist (cdr alist) (cons (car alist) acc)
-  ))))
+;;; File entry point for generated documentation
 
+;;; Running LilyPond on this file generates the documentation
 
-;;; TODO
 
-(define (wordwrap string)
-  ""
-  )
-  
-
-(define (self-evaluating? x)
-  (or (number? x) (string? x))
-  )
-      
-(define (type-name  predicate)
-  (cond
-   ((eq? predicate dir?) "direction")
-   ((eq? predicate ly-element?) "graphic element")
-   ((eq? predicate pair?) "pair")
-   ((eq? predicate integer?) "integer")
-   ((eq? predicate list?) "list")
-   ((eq? predicate symbol?) "symbol")
-   ((eq? predicate string?) "string")
-   ((eq? predicate boolean?) "string")   
-   ((eq? predicate number?) "number")
-   ((eq? predicate procedure?) "procedure") 
-   (else "(unknown)")
-  ))
-
-(define (scm->string val)
-  (string-append
-   (if (self-evaluating? val) "" "'")
-   (call-with-output-string (lambda (port) (display val port)))
-  ))
-
-(define (document-property prop desc)
-  (let ((handle (assoc (car prop) desc)))
-    (string-append
-     "\n" (symbol->string (car prop)) " (" (type-name (cadr prop)) ") -- "
-     (caddr prop)
-     "\ndefault value:  "
-     (if (pair? handle)
-        (scm->string (cdr handle))
-        "not set"
-        )
-     "\n"
-  )
-  ))
 
+;; We use ly-gulp because these files live in
 ;;
-;; todo: setup ifaces differently.
+;;     PATH=$LILYPONDPREFIX/scm:<datadir>/scm
 ;;
-(define (document-element description)
-  (let* ((metah (assoc 'meta description))
-        (meta (if (pair? metah)
-                  (cdr metah)
-                  '((properties . ()) (name . "huh?"))
-                  ))
-        
-        (name (cdr (assoc 'name meta)))
-;       (iface-descs (cdr (assoc 'interface-descriptions meta)))
-        (propdesc (cdr (assoc 'properties meta)))
-        (docs (map (lambda (x) (document-property x description))
-                   (uniqued-alist propdesc '())))
-        )
-
-    (string-append
-     "\n-------------------------\n"
-     name "\n"
-     "-------------------------\n"
-     "INTERFACES\n"
-     "(todo)\n"
-     ; (apply string-append iface-descs)
-     "-------------------------\n"
-     "PROPERTIES:\n"
-     (apply string-append docs)
-    )
-  ))
-
-
-(define (document-elements elts)
-  (string-append
-   (map (lambda (x) (display (car x)) (document-element (cdr x)))
-       elts
-       )
-   ))
-
-(define (test-module )
-  (display
-   (list
-  (scm->string '(1 2 abc))
-  (scm->string +)
-  (type-name number?)
-  (uniqued-alist '((a . 1 ) (a . 1)) '() )
-  )))
-
-
-; (define b (cdr (assoc 'Beam all-element-descriptions)))
-;(display b)
-
-; (display (document-element  b))
-
-(display (document-elements all-element-descriptions))
-
+(eval-string (ly-gulp-file "documentation-lib.scm"))
+(eval-string (ly-gulp-file "engraver-documentation-lib.scm"))
+(eval-string (ly-gulp-file "backend-documentation-lib.scm"))
+
+(let* ((doc (string-append
+           (document-paper "LilyPond interpretation contexts")
+           (document-all-engravers "LilyPond engravers")
+           (document-all-elements "LilyPond backend")))
+       (name "lilypond-internals")
+       (outname (string-append name ".texi"))
+       (out (open-output-file outname)))
+    
+  (writing-wip outname)
+  (display 
+   (string-append
+    (texi-file-head
+     
+     ;; we can't use (dir) and top if we're included by lilypond.tely
+     "LilyPond internals" name "(lilypond.info)"
+     '(("LilyPond interpretation contexts" . "Hierarchy and grouping of Engravers")
+       ("LilyPond engravers" . "Engravers create Elements")
+       ("LilyPond backend" . "Detailed description of all Elements")))
+     
+    doc
+    "\n@bye")
+    out))
+
+(newline (current-error-port))