Spaces:
Sleeping
Sleeping
File size: 9,085 Bytes
f65fe85 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
;;;; Copyright (C) 2000--2020 Han-Wen Nienhuys <[email protected]>
;;;; Jan Nieuwenhuizen <[email protected]>
;;;;
;;;; LilyPond is free software: you can redistribute it and/or modify
;;;; it under the terms of the GNU General Public License as published by
;;;; the Free Software Foundation, either version 3 of the License, or
;;;; (at your option) any later version.
;;;;
;;;; LilyPond is distributed in the hope that it will be useful,
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;;; GNU General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU General Public License
;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
(define (sort-grob-properties props)
;; force 'meta to the end of each prop-list
(let ((meta (assoc 'meta props)))
(append (sort (assoc-remove! props 'meta) ly:alist-ci<?)
(list meta))))
;; properly sort all properties and interfaces
;; within the all-grob-descriptions alist
(set! all-grob-descriptions
(map!
(lambda (grob-description)
(let* ((grob-key (car grob-description))
(props (assoc-ref all-grob-descriptions grob-key))
(meta (assoc-ref props 'meta))
(interfaces (assoc-ref meta 'interfaces))
(sorted-ifaces (sort interfaces ly:symbol-ci<?))
(new-meta (assoc-set! meta 'interfaces sorted-ifaces))
(new-props (assoc-set! props 'meta new-meta))
(sorted-props (sort-grob-properties new-props)))
(cons grob-key sorted-props)))
all-grob-descriptions))
;; sort all grobs in the all-grob-descriptions alist
(set! all-grob-descriptions (sort all-grob-descriptions ly:alist-ci<?))
(define (interface-doc-string interface grob-description)
(let* ((name (car interface))
(desc (cadr interface))
(props (caddr interface))
(docfunc (lambda (pr)
(property->texi
'backend pr grob-description)))
(iprops (filter (lambda (x) (object-property x 'backend-internal))
props))
(uprops (filter
(lambda (x) (not (object-property x 'backend-internal)))
props))
(user-propdocs (map docfunc uprops))
(internal-propdocs (map docfunc iprops)))
(string-append
desc
(if (pair? uprops)
(string-append
"\n\n@subsubheading User settable properties:\n"
(description-list->texi user-propdocs #t))
"")
(if (pair? iprops)
(string-append
"\n\n@subsubheading Internal properties:\n"
(description-list->texi internal-propdocs #t))
""))))
(define iface->grob-table (make-hash-table 61))
;; extract ifaces, and put grob into the hash table.
(for-each
(lambda (x)
(let* ((meta (assoc-get 'meta (cdr x)))
(ifaces (assoc-get 'interfaces meta)))
(for-each (lambda (iface)
(hashq-set!
iface->grob-table iface
(cons (car x)
(hashq-ref iface->grob-table iface '()))))
ifaces)))
all-grob-descriptions)
;; First level Interface description
(define (interface-doc interface)
(let* ((name (symbol->string (car interface)))
(interface-list (human-listify
(map ref-ify
(sort
(map symbol->string
(hashq-ref iface->grob-table
(car interface)
'()))
ly:string-ci<?)))))
(make <texi-node>
#:name name
#:text (string-append
(interface-doc-string (cdr interface) '())
"\n\n"
"This grob interface "
(if (equal? interface-list "none")
"is not used in any graphical object"
(string-append
"is used in the following graphical object(s): "
interface-list))
"."))))
(define (grob-alist->texi alist)
(let* ((uprops (filter (lambda (x) (not (object-property x 'backend-internal)))
(map car alist))))
(description-list->texi
(map (lambda (y) (property->texi 'backend y alist))
uprops)
#t)))
(define (grob-doc description)
"Given a property alist DESCRIPTION, make a documentation
node."
(let* ((meta (assoc-get 'meta description))
(name (assoc-get 'name meta))
;; (bla (display name))
(ifaces (map lookup-interface (assoc-get 'interfaces meta)))
(ifacedoc (map ref-ify
(sort
(map (lambda (iface)
(if (pair? iface)
(symbol->string (car iface))
(ly:error (_ "pair expected in doc ~s") name)))
ifaces)
ly:string-ci<?)))
(engravers (filter
(lambda (x) (engraver-makes-grob? name x))
all-engravers-list))
(namestr (symbol->string name))
(engraver-names (map symbol->string
(map ly:translator-name engravers)))
(engraver-list (human-listify
(map ref-ify
(map engraver-name engraver-names)))))
(make <texi-node>
#:name namestr
#:text
(string-append
namestr " objects "
(if (equal? engraver-list "none")
"are not created by any engraver"
(string-append
"are created by: "
engraver-list))
"."
"\n\nStandard settings:\n"
(grob-alist->texi description)
"\n\nThis object supports the following interface(s):\n"
(human-listify ifacedoc)
"."))))
(define (all-grobs-doc)
(make <texi-node>
#:name "All layout objects"
#:desc "Description and defaults for all graphical objects (grobs)."
#:children
(map (lambda (x) (grob-doc (cdr x))) all-grob-descriptions)))
(define interface-description-alist
(hash-fold
(lambda (key val prior)
(cons (cons key val) prior))
'() (ly:all-grob-interfaces)))
;; sort user-settable and internal props within each grob-interface
(set! interface-description-alist
(map! (lambda (iface-desc)
(let* ((key-name-docstr (list-head iface-desc 3))
(props (list-tail iface-desc 3))
(sorted-props (list (sort (car props) ly:symbol-ci<?))))
(append key-name-docstr sorted-props)))
interface-description-alist))
;; sort list of grob interfaces
(set! interface-description-alist
(sort interface-description-alist ly:alist-ci<?))
;;;;;;;;;; check for dangling backend properties.
(define (mark-interface-properties entry)
(for-each (lambda (x) (set-object-property! x 'iface-marked #t))
(caddr (cdr entry))))
(for-each mark-interface-properties interface-description-alist)
(define (check-dangling-properties prop)
(if (not (object-property prop 'iface-marked))
(ly:error (string-append "define-grob-properties.scm: "
(_ "cannot find interface for property: ~S")) prop)))
(for-each check-dangling-properties all-backend-properties)
;;;;;;;;;;;;;;;;
(define (lookup-interface name)
(let* ((entry (hashq-ref (ly:all-grob-interfaces) name #f)))
(if entry
entry
(ly:error (_ "unknown Grob interface: ~S") name))))
(define (all-interfaces-doc)
(make <texi-node>
#:name "Graphical Object Interfaces"
#:desc "Building blocks of graphical objects."
#:children
(map interface-doc interface-description-alist)))
(define (backend-properties-doc-string lst)
(let* ((ps (sort (map symbol->string lst) ly:string-ci<?))
(descs (map (lambda (prop)
(property->texi 'backend (string->symbol prop) '())) ps))
(texi (description-list->texi descs #f)))
texi))
;;(dump-node (grob-doc (cdadr all-grob-descriptions)) (current-output-port) 0 )
(define (backend-doc-node)
(make <texi-node>
#:name "Backend"
#:desc "Reference for the layout engine."
#:children
(list
(all-grobs-doc)
(all-interfaces-doc)
(make <texi-node>
#:name "User backend properties"
#:desc "All tunable properties in a big list."
#:text (backend-properties-doc-string all-user-grob-properties))
(make <texi-node>
#:name "Internal backend properties"
#:desc "All internal layout properties in a big list."
#:text (backend-properties-doc-string all-internal-grob-properties)))))
|