2 ;;; engraver-doumentation-lib.scm -- Functions for engraver documentation
4 ;;; source file of the GNU LilyPond music typesetter
6 ;;; (c) 2000--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 ;;; Jan Nieuwenhuizen <janneke@gnu.org>
10 (define (engraver-makes-grob? name-symbol grav)
11 (memq name-symbol (assoc 'grobs-created (ly-translator-description grav)))
14 (define (engraver-accepts-music-type? name-symbol grav)
15 (memq name-symbol (assoc 'events-accepted (ly-translator-description grav)))
19 (define (engraver-accepts-music-types? types grav)
23 (engraver-accepts-music-type? (car types) grav)
24 (engraver-accepts-music-types? (cdr types) grav)))
27 (define (engraver-doc-string engraver)
29 (propsr (cdr (assoc 'properties-read (ly-translator-description engraver))))
30 (propsw (cdr (assoc 'properties-written (ly-translator-description engraver))))
31 (accepted (cdr (assoc 'events-accepted (ly-translator-description engraver))))
32 (name (ly-translator-name engraver))
33 (name-sym (string->symbol name))
34 (desc (cdr (assoc 'description (ly-translator-description engraver))))
35 (grobs (engraver-grobs engraver))
43 "Music types accepted:\n\n"
56 (description-list->texi
57 (map (lambda (x) (document-property x 'translation #f)) propsr)))
64 (description-list->texi
65 (map (lambda (x) (document-property x 'translation #f)) propsw))))
69 "This engraver creates the following grobs: \n "
70 (human-listify (map ref-ify (uniq-list (sort grobs string<? ))))
76 (let* ((paper-alist (My_lily_parser::paper_description))
77 (context-description-alist (map cdr paper-alist))
81 (let ((context (cdr (assoc 'type-name x)))
83 (list (cdr (assoc 'group-type x)))
84 (cdr (assoc 'consists x))
85 (cdr (assoc 'end-consists x)))))
87 (if (member name consists)
90 context-description-alist))))
92 name " is part of contexts: "
93 (human-listify (map ref-ify (map context-name contexts))))))))
98 ;; First level Engraver description
99 (define (engraver-doc grav)
101 #:name (ly-translator-name grav)
102 #:text (engraver-doc-string grav)
105 ;; Second level, part of Context description
107 (define name->engraver-table (make-vector 61 '()))
110 (hash-set! name->engraver-table (ly-translator-name x) x))
111 (ly-get-all-translators))
113 (define (find-engraver-by-name name)
114 (hash-ref name->engraver-table name #f))
116 (define (document-engraver-by-name name)
119 (eg (find-engraver-by-name name ))
123 (string-append "Engraver " name ", not documented.\n")
124 (engraver-doc-string eg)
128 (define (document-property-operation op)
139 (if (null? (cddr body))
144 (symbol->string (cadr body))
145 " in " (symbol->string sym)
146 (if (not (null? (cddr body)))
147 (string-append " to " (scm->texi (cadr (cdr body))))
153 ((equal? (object-property sym 'is-grob?) #t) "")
154 ((equal? (car op) 'assign)
156 "@item Set translator property "
157 (symbol->string (car body))
159 (scm->texi (cadr body))
167 (define (context-doc context-desc)
170 (name (cdr (assoc 'type-name context-desc)))
171 (desc-handle (assoc (string->symbol name) context-description-alist))
172 (desc (if (pair? desc-handle) (cdr desc-handle) ""))
174 (accepts (cdr (assoc 'accepts context-desc)))
176 (list (cdr (assoc 'group-type context-desc)))
177 (cdr (assoc 'consists context-desc))
178 (cdr (assoc 'end-consists context-desc))
180 (props (cdr (assoc 'property-ops context-desc)))
181 (grobs (context-grobs context-desc))
182 (grob-refs (map (lambda (x) (ref-ify x)) grobs))
189 "\n\nThis context creates the following grobs: \n\n"
190 (human-listify (uniq-list (sort grob-refs string<? )))
194 "\n\nThis context sets the following properties:\n"
196 (apply string-append (map document-property-operation props))
203 "\n\nThis context is a `bottom' context; it can not contain other contexts."
206 name " can contain \n"
207 (human-listify (map ref-ify (map context-name accepts)))))
209 "\n\nThis context is built from the following engravers: "
211 (map document-engraver-by-name consists)))
214 (define (engraver-grobs grav)
216 (eg (if (string? grav)
217 (find-engraver-by-name grav)
224 (map symbol->string (cdr (assoc 'grobs-created (ly-translator-description eg))))
228 (define (context-grobs context-desc)
231 (list (cdr (assoc 'group-type context-desc)))
232 (cdr (assoc 'consists context-desc))
233 (cdr (assoc 'end-consists context-desc))
236 (map engraver-grobs consists))
242 (define (symbol<? l r)
243 (string<? (symbol->string l) (symbol->string r)))
245 (define (all-contexts-doc)
248 (sort (My_lily_parser::paper_description)
249 (lambda (x y) (symbol<? (car x) (car y)))))
250 (names (sort (map symbol->string (map car paper-alist)) string<?))
251 (contexts (map cdr paper-alist))
256 #:desc "Complete descriptions of all contexts"
258 (map context-doc contexts)
263 (define all-engravers-list (ly-get-all-translators))
264 (set! all-engravers-list
265 (sort all-engravers-list
266 (lambda (a b) (string<? (ly-translator-name a)
267 (ly-translator-name b)))))
269 (define (all-engravers-doc)
272 #:desc "All separate engravers"
274 (map engraver-doc all-engravers-list)))
276 (define (all-translation-properties-doc)
280 (ps (sort (map symbol->string all-translation-properties) string<?))
281 (sortedsyms (map string->symbol ps))
284 (lambda (x) (document-property x 'translation #f))
286 (texi (description-list->texi propdescs))
290 #:name "Translation properties"
291 #:desc "All translation properties"
296 ;(dump-node (all-contexts-doc) (current-output-port) 0 )
298 (define (translation-doc-node)
301 #:desc "From music to layout"
306 (all-translation-properties-doc)