1 ;;;; document-translation.scm -- Functions for engraver documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 (define (engraver-makes-grob? name-symbol grav)
9 (memq name-symbol (assoc 'grobs-created (ly:translator-description grav))))
11 (define (engraver-accepts-music-type? name-symbol grav)
12 (memq name-symbol (assoc 'events-accepted (ly:translator-description grav))))
14 (define (engraver-accepts-music-types? types grav)
18 (engraver-accepts-music-type? (car types) grav)
19 (engraver-accepts-music-types? (cdr types) grav))))
21 (define (engraver-doc-string engraver in-which-contexts)
22 (let* ((propsr (cdr (assoc 'properties-read (ly:translator-description engraver))))
23 (propsw (cdr (assoc 'properties-written (ly:translator-description engraver))))
24 (accepted (cdr (assoc 'events-accepted (ly:translator-description engraver))))
25 (name-sym (ly:translator-name engraver))
26 (name-str (symbol->string name-sym))
27 (desc (cdr (assoc 'description (ly:translator-description engraver))))
28 (grobs (engraver-grobs engraver)))
35 "Music types accepted:\n\n"
47 (description-list->texi
48 (map (lambda (x) (property->texi 'translation x '())) propsr)))
55 (description-list->texi
56 (map (lambda (x) (property->texi 'translation x '())) propsw))))
60 "\n\nThis engraver creates the following layout objects:\n\n"
61 (human-listify (map ref-ify (uniq-list (sort grobs string<?))))
67 (let* ((layout-alist (ly:output-description $defaultlayout))
68 (context-description-alist (map cdr layout-alist))
73 (let* ((context (cdr (assoc 'context-name x)))
74 (group (assq-ref x 'group-type))
79 (cdr (assoc 'consists x)))))
80 (if (member name-sym consists)
83 context-description-alist))))
85 "@code{" name-str "} is part of contexts: "
86 (human-listify (map ref-ify
88 (map symbol->string contexts) string<?)))))
91 ;; First level Engraver description
92 (define (engraver-doc grav)
94 #:name (symbol->string (ly:translator-name grav))
95 #:text (engraver-doc-string grav #t)))
97 ;; Second level, part of Context description
98 (define name->engraver-table (make-vector 61 '()))
101 (hash-set! name->engraver-table (ly:translator-name x) x))
102 (ly:get-all-translators))
104 (define (find-engraver-by-name name)
106 (hash-ref name->engraver-table name #f))
108 (define (document-engraver-by-name name)
111 (let* ((eg (find-engraver-by-name name)))
113 (cons (string-append "@code{" (ref-ify (symbol->string name)) "}")
114 (engraver-doc-string eg #f))))
116 (define (document-property-operation op)
118 (context-sym (cadr op))
130 (format "grob-property @code{~a} "
131 (string-join (map symbol->string path) " "))
132 (format "in @ref{~a} to ~a."
133 context-sym (scm->texi value))
135 ((equal? (object-property context-sym 'is-grob?) #t) "")
136 ((equal? tag 'assign)
137 (format "@item Set translator property @code{~a} to ~a.\n"
139 (scm->texi (car args))))
143 (define (context-doc context-desc)
144 (let* ((name-sym (cdr (assoc 'context-name context-desc)))
145 (name (symbol->string name-sym))
146 (aliases (map symbol->string (cdr (assoc 'aliases context-desc))))
147 (desc-handle (assoc 'description context-desc))
148 (desc (if (and (pair? desc-handle) (string? (cdr desc-handle)))
149 (cdr desc-handle) "(not documented)"))
151 (accepts (cdr (assoc 'accepts context-desc)))
152 (consists (cdr (assoc 'consists context-desc)))
153 (props (cdr (assoc 'property-ops context-desc)))
154 (grobs (context-grobs context-desc))
155 (grob-refs (map (lambda (x) (ref-ify x)) grobs)))
164 "\n\nThis context also accepts commands for the following context(s):\n\n"
165 (human-listify aliases)
169 "\n\nThis context creates the following layout objects:\n\n"
170 (human-listify (uniq-list (sort grob-refs string<?)))
173 (if (and (pair? props) (not (null? props)))
174 (let ((str (apply string-append (map document-property-operation
176 (if (string-null? str)
179 "\n\nThis context sets the following properties:\n\n"
186 "\n\nThis context is a `bottom' context; it cannot contain other contexts."
191 (human-listify (map ref-ify (map symbol->string accepts)))
197 "\n\nThis context is built from the following engravers:"
198 (description-list->texi (map document-engraver-by-name consists))))))))
200 (define (engraver-grobs grav)
201 (let* ((eg (if (symbol? grav)
202 (find-engraver-by-name grav)
206 (map symbol->string (cdr (assoc 'grobs-created (ly:translator-description eg)))))))
208 (define (context-grobs context-desc)
209 (let* ((group (assq-ref context-desc 'group-type))
214 (cdr (assoc 'consists context-desc))))
216 (map engraver-grobs consists))))
219 (define (all-contexts-doc)
221 (sort (ly:output-description $defaultlayout)
222 (lambda (x y) (symbol<? (car x) (car y)))))
223 (names (sort (map symbol->string (map car layout-alist)) string<?))
224 (contexts (map cdr layout-alist)))
228 #:desc "Complete descriptions of all contexts."
230 (map context-doc contexts))))
232 (define all-engravers-list (ly:get-all-translators))
233 (set! all-engravers-list
234 (sort all-engravers-list
235 (lambda (a b) (string<? (symbol->string (ly:translator-name a))
236 (symbol->string (ly:translator-name b))))))
238 (define (all-engravers-doc)
241 #:desc "All separate engravers."
242 #:text "See @ruser{Modifying context plug-ins}."
244 (map engraver-doc all-engravers-list)))
246 (define (translation-properties-doc-string lst)
247 (let* ((ps (sort (map symbol->string lst) string<?))
248 (sortedsyms (map string->symbol ps))
251 (lambda (x) (property->texi 'translation x '()))
253 (texi (description-list->texi propdescs)))
256 (define (translation-doc-node)
259 #:desc "From music to layout."
265 #:name "Tunable context properties"
266 #:desc "All tunable context properties."
267 #:text (translation-properties-doc-string
268 all-user-translation-properties))
271 #:name "Internal context properties"
272 #:desc "All internal context properties."
273 #:text (translation-properties-doc-string
274 all-internal-translation-properties)))))