1 ;;;; document-translation.scm -- Functions for engraver documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2000--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 (define (engraver-makes-grob? name-symbol grav)
10 (memq name-symbol (assoc 'grobs-created (ly:translator-description grav)))
13 (define (engraver-accepts-music-type? name-symbol grav)
14 (memq name-symbol (assoc 'events-accepted (ly:translator-description grav)))
18 (define (engraver-accepts-music-types? types grav)
22 (engraver-accepts-music-type? (car types) grav)
23 (engraver-accepts-music-types? (cdr types) grav)))
26 (define (engraver-doc-string engraver in-which-contexts)
28 (propsr (cdr (assoc 'properties-read (ly:translator-description engraver))))
29 (propsw (cdr (assoc 'properties-written (ly:translator-description engraver))))
30 (accepted (cdr (assoc 'events-accepted (ly:translator-description engraver))))
31 (name-sym (ly:translator-name engraver))
32 (name-str (symbol->string name-sym))
33 (desc (cdr (assoc 'description (ly:translator-description engraver))))
34 (grobs (engraver-grobs engraver))
42 "Music types accepted:\n\n"
55 (description-list->texi
56 (map (lambda (x) (property->texi 'translation x '())) propsr)))
63 (description-list->texi
64 (map (lambda (x) (property->texi 'translation x '())) propsw))))
68 "This engraver creates the following layout objects: \n "
69 (human-listify (map ref-ify (uniq-list (sort grobs string<? ))))
77 ((layout-alist (ly:output-description $defaultlayout))
78 (context-description-alist (map cdr layout-alist))
84 ((context (cdr (assoc 'context-name x)))
85 (group (assq-ref x 'group-type))
90 (cdr (assoc 'consists x))
95 (if (member name-sym consists)
98 context-description-alist))))
100 "@code{" name-str "} is part of contexts: "
101 (human-listify (map ref-ify
103 (map symbol->string contexts) string<?)))))
110 ;; First level Engraver description
111 (define (engraver-doc grav)
113 #:name (symbol->string (ly:translator-name grav))
114 #:text (engraver-doc-string grav #t)
117 ;; Second level, part of Context description
118 (define name->engraver-table (make-vector 61 '()))
121 (hash-set! name->engraver-table (ly:translator-name x) x))
122 (ly:get-all-translators))
124 (define (find-engraver-by-name name)
126 (hash-ref name->engraver-table name #f))
128 (define (document-engraver-by-name name)
132 (eg (find-engraver-by-name name ))
135 (cons (string-append "@code{" (ref-ify (symbol->string name)) "}")
136 (engraver-doc-string eg #f)
140 (define (document-property-operation op)
151 (if (null? (cddr body))
155 "grob-property @code{"
156 (symbol->string (cadr body))
157 "} in @ref{" (symbol->string sym)
159 (if (not (null? (cddr body)))
160 (string-append " to @code{" (scm->texi (cadr (cdr body))) "}" )
166 ((equal? (object-property sym 'is-grob?) #t) "")
167 ((equal? (car op) 'assign)
169 "@item Set translator property @code{"
170 (symbol->string (car body))
172 (scm->texi (cadr body))
180 (define (context-doc context-desc)
183 (name-sym (cdr (assoc 'context-name context-desc)))
184 (name (symbol->string name-sym))
185 (aliases (map symbol->string (cdr (assoc 'aliases context-desc))))
186 (desc-handle (assoc 'description context-desc))
187 (desc (if (and (pair? desc-handle) (string? (cdr desc-handle)))
188 (cdr desc-handle) "(not documented)"))
190 (accepts (cdr (assoc 'accepts context-desc)))
191 (group (assq-ref context-desc 'group-type))
194 (if group (list group)
196 (cdr (assoc 'consists context-desc))
198 (props (cdr (assoc 'property-ops context-desc)))
199 (grobs (context-grobs context-desc))
200 (grob-refs (map (lambda (x) (ref-ify x)) grobs)) )
208 (string-append "\n\n This context is also known as: \n\n"
209 (human-listify aliases))
211 "\n\nThis context creates the following layout objects: \n\n"
212 (human-listify (uniq-list (sort grob-refs string<? )))
216 "\n\nThis context sets the following properties:\n"
218 (apply string-append (map document-property-operation props))
225 "\n\nThis context is a `bottom' context; it can not contain other contexts."
228 name " can contain \n"
229 (human-listify (map ref-ify (map symbol->string accepts)))))
231 "\n\nThis context is built from the following engravers: "
232 (description-list->texi
233 (map document-engraver-by-name consists))
236 (define (engraver-grobs grav)
237 (let* ((eg (if (symbol? grav)
238 (find-engraver-by-name grav)
242 (map symbol->string (cdr (assoc 'grobs-created (ly:translator-description eg)))))
245 (define (context-grobs context-desc)
247 (group (assq-ref context-desc 'group-type))
252 (cdr (assoc 'consists context-desc))
255 (map engraver-grobs consists))
262 (define (all-contexts-doc)
265 (sort (ly:output-description $defaultlayout)
266 (lambda (x y) (symbol<? (car x) (car y)))))
267 (names (sort (map symbol->string (map car layout-alist)) string<?))
268 (contexts (map cdr layout-alist))
273 #:desc "Complete descriptions of all contexts"
275 (map context-doc contexts)
280 (define all-engravers-list (ly:get-all-translators))
281 (set! all-engravers-list
282 (sort all-engravers-list
283 (lambda (a b) (string<? (symbol->string (ly:translator-name a))
284 (symbol->string (ly:translator-name b))))))
286 (define (all-engravers-doc)
289 #:desc "All separate engravers"
290 #:text "See @usermanref{Modifying context plug-ins}."
292 (map engraver-doc all-engravers-list)))
294 (define (translation-properties-doc-string lst)
296 ((ps (sort (map symbol->string lst) string<?))
297 (sortedsyms (map string->symbol ps))
300 (lambda (x) (property->texi 'translation x '()))
302 (texi (description-list->texi propdescs)))
307 (define (translation-doc-node)
310 #:desc "From music to layout"
316 #:name "Tunable context properties"
317 #:desc "All tunable context properties"
318 #:text (translation-properties-doc-string
319 all-user-translation-properties))
322 #:name "Internal context properties"
323 #:desc "All internal context properties"
324 #:text (translation-properties-doc-string
325 all-internal-translation-properties))