-;;; engraver-documentation-lib.scm -- Functions for engraver documentation
+;;; engraver-doumentation-lib.scm -- Functions for engraver documentation
;;;
;;; source file of the GNU LilyPond music typesetter
;;;
-;;; (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;; (c) 2000--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
;;; Jan Nieuwenhuizen <janneke@gnu.org>
-(eval-string (ly-gulp-file "translator-description.scm"))
;; alist of translater descriptions
(define (document-translator-property sym)
;; First level Engraver description and
;; second level Context description
-(define (document-engraver where engraver-descr)
+(define (document-engraver where engraver)
+
(let* (
(level (if (eq? where 'context) 3 2))
- (props (car (cdddr engraver-descr)))
- (name (car engraver-descr))
+ (propsr (cdr (assoc 'properties-read (ly-translator-description engraver))))
+ (propsw (cdr (assoc 'properties-written (ly-translator-description engraver))))
+ (name (ly-translator-name engraver))
(name-sym (string->symbol name))
- (desc (cadr engraver-descr))
- (objs (map symbol->string (caddr engraver-descr)))
+ (desc (cdr (assoc 'description (ly-translator-description engraver))))
+ (grobs (engraver-grobs engraver))
)
(string-append
(texi-section level (engraver-name name) (eq? where 'context))
desc
"\n\n"
- (if (null? props)
+ (if (null? propsr)
+ ""
+ (string-append
+ (texi-section (+ level 1) "Properties (read)" #f)
+ (description-list->texi
+ (map (lambda (x) (document-translator-property x)) propsr))))
+ (if (null? propsw)
""
(string-append
- (texi-section (+ level 1) "Properties" #f)
+ (texi-section (+ level 1) "Properties (write)" #f)
(description-list->texi
- (map (lambda (x) (document-translator-property x)) props))))
- (if (null? objs)
+ (map (lambda (x) (document-translator-property x)) propsw))))
+ (if (null? grobs)
""
(string-append
- "This engraver creates \n "
- (human-listify (map reffy (map grob-name objs)))
- " grobs.")
+ "This engraver creates the following grobs: \n "
+ (human-listify (map ref-ify (uniq-list (sort grobs string<? ))))
+ ".")
)
"\n\n"
(cdr (assoc 'consists x))
(cdr (assoc 'end-consists x)))))
- (if (member name-sym consists)
+ (if (member name consists)
(list context)
'())))
context-description-alist))))
(string-append
name " is part of contexts: "
- (human-listify (map reffy (map context-name contexts))))))))
+ (human-listify (map ref-ify (map context-name contexts))))))))
;; First level Engraver description
-(define (document-separate-engraver top description)
- (let ((name (car description)))
+(define (document-separate-engraver top grav)
+ (let ((name (ly-translator-name grav)))
(processing name)
(string-append
(node (engraver-name name))
- (document-engraver 'self description))))
+ (document-engraver 'self grav))))
;; Second level, part of Context description
+(define (find-engraver-by-name name list)
+ (if (null? list)
+ #f
+ (if (equal? name (ly-translator-name (car list)))
+ (car list)
+ (find-engraver-by-name name (cdr list)))))
+
(define (document-engraver-by-name name)
(let*
(
- (eg (assoc (string->symbol name) engraver-description-alist))
+ (eg (find-engraver-by-name name all-engravers-list))
)
(if (eq? eg #f)
(string-append "Engraver " name ", not documented.\n")
- (document-engraver 'context (cdr eg))
+ (document-engraver 'context eg)
)
))
+(define (document-property-operation op)
+ (let
+ ((tag (car op))
+ (body (cdr op))
+ (sym (cadr op))
+ )
+
+ (cond
+ ((equal? tag 'push)
+ (string-append
+ "@item "
+ (if (null? (cddr body))
+ "Revert "
+ "Set "
+ )
+ "grob-property "
+ (symbol->string (cadr body))
+ " in " (symbol->string sym)
+ (if (not (null? (cddr body)))
+ (string-append " to " (scm->texi (cadr (cdr body))))
+ )
+ "\n"
+ )
+
+ )
+ ((equal? (object-property sym 'is-grob?) #t) "")
+ ((equal? (car op) 'assign)
+ (string-append
+ "@item Set translator property "
+ (symbol->string (car body))
+ " to "
+ (scm->texi (cadr body))
+ "\n"
+ )
+ )
+ )
+ ))
+
+
+
(define (context-doc-string context-desc)
(let*
(
(cdr (assoc 'consists context-desc))
(cdr (assoc 'end-consists context-desc))
))
+ (props (cdr (assoc 'property-ops context-desc)))
+ (grobs (context-grobs context-desc))
+ (grob-refs (map (lambda (x) (ref-ify x)) grobs))
)
(string-append
desc
+ "\n\nThis context creates the following grobs: \n\n"
+ (human-listify (uniq-list (sort grob-refs string<? )))
+ "."
+ (if (pair? props)
+ (string-append
+ "\n\nThis context sets the following properties:\n"
+ "@itemize @bullet\n"
+ (apply string-append (map document-property-operation props))
+ "@end itemize\n"
+ )
+ ""
+ )
(if (null? accepts)
- "This context is a `bottom' context; it can not contain other contexts."
+ "\n\nThis context is a `bottom' context; it can not contain other contexts."
(string-append
+ "\n\nContext "
name " can contain \n"
- (human-listify (map reffy (map context-name accepts)))))
+ (human-listify (map ref-ify (map context-name accepts)))))
"\n\nThis context is built from the following engravers: "
(if no-copies
- (human-listify (map reffy (map engraver-name consists)))
+ (human-listify (map ref-ify (map engraver-name consists)))
(apply string-append
(map document-engraver-by-name consists))))))
+(define (engraver-grobs grav)
+ (let* (
+ (eg (if (string? grav)
+ (find-engraver-by-name grav all-engravers-list)
+ grav))
+
+ )
+
+ (if (eq? eg #f)
+ '()
+ (map symbol->string (cdr (assoc 'grobs-created (ly-translator-description eg))))
+ )
+ ))
+
+(define (context-grobs context-desc)
+ (let* (
+ (consists (append
+ (list (cdr (assoc 'group-type context-desc)))
+ (cdr (assoc 'consists context-desc))
+ (cdr (assoc 'end-consists context-desc))
+ ))
+ (grobs (apply append
+ (map engraver-grobs consists))
+ )
+ )
+ grobs
+ ))
+
;; First level Context description
(define (document-context top context-desc)
names))
doc)))
+(define all-engravers-list (ly-get-all-translators))
(define (document-all-engravers name)
- (let* ((descs (map cdr engraver-description-alist))
- (names (map symbol->string (map car engraver-description-alist)))
+ (let* ((gravs all-engravers-list)
+ (names (map ly-translator-name gravs))
(doc (apply string-append
(map (lambda (x) (document-separate-engraver name x))
- descs))))
+ gravs))))
(string-append
(texi-node-menu name (map (lambda (x) (cons (engraver-name x) ""))
names))
projects / lilypond.git / blobdiff