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--2005 Han-Wen Nienhuys <hanwen@cs.uu.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            "This engraver creates the following layout objects: \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         (body (cdr op))
 119         (sym (cadr op)))
 120
 121     (cond
 122      ((equal?  tag 'push)
 123       (string-append
 124        "@item "
 125        (if (null? (cddr body))
 126            "Revert "
 127            "Set ")
 128        "grob-property @code{"
 129        (symbol->string (cadr body))
 130        "} in @ref{" (symbol->string sym)
 131        "}"
 132        (if (not (null? (cddr body)))
 133            (string-append " to @code{" (scm->texi (cadr (cdr body))) "}" ))
 134        "\n"))
 135      ((equal? (object-property sym 'is-grob?) #t) "")
 136      ((equal? (car op) 'assign)
 137       (string-append
 138        "@item Set translator property @code{"
 139        (symbol->string (car body))
 140        "} to @code{"
 141        (scm->texi (cadr body))
 142        "}\n")))))
 143
 144 (define (context-doc context-desc)
 145   (let* ((name-sym (cdr (assoc 'context-name context-desc)))
 146          (name (symbol->string name-sym))
 147          (aliases (map symbol->string (cdr (assoc 'aliases context-desc))))
 148          (desc-handle (assoc 'description context-desc))
 149          (desc (if (and  (pair? desc-handle) (string? (cdr desc-handle)))
 150                    (cdr desc-handle) "(not documented)"))
 151
 152          (accepts (cdr (assoc 'accepts context-desc)))
 153          (consists (cdr (assoc 'consists context-desc)))
 154          (props (cdr (assoc 'property-ops context-desc)))
 155          (grobs  (context-grobs context-desc))
 156          (grob-refs (map (lambda (x) (ref-ify x)) grobs)))
 157
 158     (make <texi-node>
 159       #:name name
 160       #:text
 161       (string-append
 162        desc
 163        (if (pair? aliases)
 164            (string-append "\n\n This context is also known as: \n\n"
 165                           (human-listify aliases))
 166            "")
 167        "\n\nThis context creates the following layout objects: \n\n"
 168        (human-listify (uniq-list (sort grob-refs string<? )))
 169        "."
 170        (if (pair? props)
 171            (string-append
 172             "\n\nThis context sets the following properties:\n"
 173             "@itemize @bullet\n"
 174             (apply string-append (map document-property-operation props))
 175             "@end itemize\n")
 176            "")
 177
 178        (if (null? accepts)
 179            "\n\nThis context is a `bottom' context; it can not contain other contexts."
 180            (string-append
 181             "\n\nContext "
 182             name " can contain \n"
 183             (human-listify (map ref-ify (map symbol->string accepts)))))
 184
 185        "\n\nThis context is built from the following engravers: "
 186        (description-list->texi
 187         (map document-engraver-by-name consists))))))
 188
 189 (define (engraver-grobs grav)
 190   (let* ((eg (if (symbol? grav)
 191                  (find-engraver-by-name grav)
 192                  grav)))
 193     (if (eq? eg #f)
 194         '()
 195         (map symbol->string (cdr (assoc 'grobs-created (ly:translator-description eg)))))))
 196
 197 (define (context-grobs context-desc)
 198   (let* ((group (assq-ref context-desc 'group-type))
 199          (consists (append
 200                     (if group
 201                         (list group)
 202                         '())
 203                     (cdr (assoc 'consists context-desc))))
 204          (grobs  (apply append
 205                         (map engraver-grobs consists))))
 206     grobs))
 207
 208 (define (all-contexts-doc)
 209   (let* ((layout-alist
 210           (sort (ly:output-description $defaultlayout)
 211                 (lambda (x y) (symbol<? (car x) (car y)))))
 212          (names (sort (map symbol->string (map car layout-alist)) string<?))
 213          (contexts (map cdr layout-alist)))
 214
 215     (make <texi-node>
 216       #:name "Contexts"
 217       #:desc "Complete descriptions of all contexts"
 218       #:children
 219       (map context-doc contexts))))
 220
 221 (define all-engravers-list  (ly:get-all-translators))
 222 (set! all-engravers-list
 223       (sort all-engravers-list
 224             (lambda (a b) (string<? (symbol->string (ly:translator-name a))
 225                                     (symbol->string (ly:translator-name b))))))
 226
 227 (define (all-engravers-doc)
 228   (make <texi-node>
 229     #:name "Engravers"
 230     #:desc "All separate engravers"
 231     #:text "See @usermanref{Modifying context plug-ins}."
 232     #:children
 233     (map engraver-doc all-engravers-list)))
 234
 235 (define (translation-properties-doc-string lst)
 236   (let* ((ps (sort (map symbol->string lst) string<?))
 237          (sortedsyms (map string->symbol ps))
 238          (propdescs
 239           (map
 240            (lambda (x) (property->texi 'translation  x '()))
 241            sortedsyms))
 242          (texi (description-list->texi propdescs)))
 243     texi))
 244
 245 (define (translation-doc-node)
 246   (make <texi-node>
 247     #:name "Translation"
 248     #:desc "From music to layout"
 249     #:children
 250     (list
 251      (all-contexts-doc)
 252      (all-engravers-doc)
 253      (make <texi-node>
 254        #:name "Tunable context properties"
 255        #:desc "All tunable context properties"
 256        #:text (translation-properties-doc-string
 257                all-user-translation-properties))
 258
 259      (make <texi-node>
 260        #:name "Internal context properties"
 261        #:desc "All internal context properties"
 262        #:text (translation-properties-doc-string
 263                all-internal-translation-properties)))))