scm/document-translation.scm

   1 ;;;; document-translation.scm -- Functions for engraver documentation
   2 ;;;;
   3 ;;;; source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8 (define (engraver-makes-grob? name-symbol grav)
   9   (memq name-symbol (assoc 'grobs-created (ly:translator-description grav))))
  10
  11 (define (engraver-accepts-music-type? name-symbol grav)
  12   (memq name-symbol (assoc 'events-accepted (ly:translator-description grav))))
  13
  14 (define (engraver-accepts-music-types? types grav)
  15   (if (null? types)
  16       #f
  17       (or
  18        (engraver-accepts-music-type? (car types) grav)
  19        (engraver-accepts-music-types? (cdr types) grav))))
  20
  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)))
  29
  30     (string-append
  31      desc
  32      "\n\n"
  33      (if (pair? accepted)
  34          (string-append
  35           "Music types accepted:\n\n"
  36           (human-listify
  37            (map (lambda (x)
  38                   (string-append
  39                    "@ref{"
  40                    (symbol->string x)
  41                    "}")) accepted)))
  42          "")
  43      "\n\n"
  44      (if (pair? propsr)
  45          (string-append
  46           "Properties (read)"
  47           (description-list->texi
  48            (map (lambda (x) (property->texi 'translation x '())) propsr)))
  49          "")
  50
  51      (if (null? propsw)
  52          ""
  53          (string-append
  54           "Properties (write)"
  55           (description-list->texi
  56            (map (lambda (x) (property->texi 'translation x '())) propsw))))
  57      (if  (null? grobs)
  58           ""
  59           (string-append
  60            "\n\nThis engraver creates the following layout objects:\n\n"
  61            (human-listify (map ref-ify (uniq-list (sort grobs string<?))))
  62            "."))
  63
  64      "\n\n"
  65
  66      (if in-which-contexts
  67          (let* ((layout-alist (ly:output-description $defaultlayout))
  68                 (context-description-alist (map cdr layout-alist))
  69                 (contexts
  70                  (apply append
  71                         (map
  72                          (lambda (x)
  73                            (let* ((context (cdr (assoc 'context-name x)))
  74                                   (group (assq-ref x 'group-type))
  75                                   (consists (append
  76                                              (if group
  77                                                  (list group)
  78                                                  '())
  79                                              (cdr (assoc 'consists x)))))
  80                              (if (member name-sym consists)
  81                                  (list context)
  82                                  '())))
  83                          context-description-alist))))
  84            (string-append
  85             "@code{" name-str "} is part of contexts: "
  86             (human-listify (map ref-ify
  87                                 (sort
  88                                  (map symbol->string contexts) string<?)))))
  89          ""))))
  90
  91 ;; First level Engraver description
  92 (define (engraver-doc grav)
  93   (make <texi-node>
  94     #:name (symbol->string (ly:translator-name grav))
  95     #:text (engraver-doc-string grav #t)))
  96
  97 ;; Second level, part of Context description
  98 (define name->engraver-table (make-vector 61 '()))
  99 (map
 100  (lambda (x)
 101    (hash-set! name->engraver-table (ly:translator-name x) x))
 102  (ly:get-all-translators))
 103
 104 (define (find-engraver-by-name name)
 105   "NAME is a symbol."
 106   (hash-ref name->engraver-table name #f))
 107
 108 (define (document-engraver-by-name name)
 109   "NAME is a symbol."
 110
 111   (let* ((eg (find-engraver-by-name name)))
 112
 113     (cons (string-append "@code{" (ref-ify (symbol->string name)) "}")
 114           (engraver-doc-string eg #f))))
 115
 116 (define (document-property-operation op)
 117   (let ((tag (car op))
 118         (context-sym (cadr op))
 119         (args (cddr op))
 120         )
 121
 122     (cond
 123      ((equal?  tag 'push)
 124       (let*
 125           ((value (car args))
 126            (path (cdr args)))
 127
 128       (string-append
 129        "@item Set "
 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))
 134        "\n")))
 135      ((equal? (object-property context-sym 'is-grob?) #t) "")
 136      ((equal? tag 'assign)
 137       (format "@item Set translator property @code{~a} to ~a.\n"
 138               context-sym
 139               (scm->texi (car args))))
 140      )))
 141
 142
 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)"))
 150
 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)))
 156
 157     (make <texi-node>
 158       #:name name
 159       #:text
 160       (string-append
 161        desc
 162        (if (pair? aliases)
 163            (string-append
 164             "\n\nThis context also accepts commands for the following context(s):\n\n"
 165             (human-listify aliases)
 166             ".")
 167            "")
 168
 169        "\n\nThis context creates the following layout objects:\n\n"
 170        (human-listify (uniq-list (sort grob-refs string<?)))
 171        "."
 172
 173        (if (and (pair? props) (not (null? props)))
 174            (let ((str (apply string-append (map document-property-operation
 175                                                 props))))
 176              (if (string-null? str)
 177                  ""
 178                  (string-append
 179                   "\n\nThis context sets the following properties:\n\n"
 180                   "@itemize @bullet\n"
 181                   str
 182                   "@end itemize\n")))
 183            "")
 184
 185        (if (null? accepts)
 186            "\n\nThis context is a `bottom' context; it cannot contain other contexts."
 187            (string-append
 188             "\n\nContext "
 189             name
 190             " can contain\n"
 191             (human-listify (map ref-ify (map symbol->string accepts)))
 192             "."))
 193
 194        (if (null? consists)
 195            ""
 196            (string-append
 197             "\n\nThis context is built from the following engravers:"
 198             (description-list->texi (map document-engraver-by-name consists))))))))
 199
 200 (define (engraver-grobs grav)
 201   (let* ((eg (if (symbol? grav)
 202                  (find-engraver-by-name grav)
 203                  grav)))
 204     (if (eq? eg #f)
 205         '()
 206         (map symbol->string (cdr (assoc 'grobs-created (ly:translator-description eg)))))))
 207
 208 (define (context-grobs context-desc)
 209   (let* ((group (assq-ref context-desc 'group-type))
 210          (consists (append
 211                     (if group
 212                         (list group)
 213                         '())
 214                     (cdr (assoc 'consists context-desc))))
 215          (grobs  (apply append
 216                         (map engraver-grobs consists))))
 217     grobs))
 218
 219 (define (all-contexts-doc)
 220   (let* ((layout-alist
 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)))
 225
 226     (make <texi-node>
 227       #:name "Contexts"
 228       #:desc "Complete descriptions of all contexts."
 229       #:children
 230       (map context-doc contexts))))
 231
 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))))))
 237
 238 (define (all-engravers-doc)
 239   (make <texi-node>
 240     #:name "Engravers"
 241     #:desc "All separate engravers."
 242     #:text "See @ruser{Modifying context plug-ins}."
 243     #:children
 244     (map engraver-doc all-engravers-list)))
 245
 246 (define (translation-properties-doc-string lst)
 247   (let* ((ps (sort (map symbol->string lst) string<?))
 248          (sortedsyms (map string->symbol ps))
 249          (propdescs
 250           (map
 251            (lambda (x) (property->texi 'translation  x '()))
 252            sortedsyms))
 253          (texi (description-list->texi propdescs)))
 254     texi))
 255
 256 (define (translation-doc-node)
 257   (make <texi-node>
 258     #:name "Translation"
 259     #:desc "From music to layout."
 260     #:children
 261     (list
 262      (all-contexts-doc)
 263      (all-engravers-doc)
 264      (make <texi-node>
 265        #:name "Tunable context properties"
 266        #:desc "All tunable context properties."
 267        #:text (translation-properties-doc-string
 268                all-user-translation-properties))
 269
 270      (make <texi-node>
 271        #:name "Internal context properties"
 272        #:desc "All internal context properties."
 273        #:text (translation-properties-doc-string
 274                all-internal-translation-properties)))))