scm/documentation-lib.scm

   1 ;;;;
   2 ;;;; documentation-lib.scm -- Assorted Functions for generated documentation
   3 ;;;;
   4 ;;;; source file of the GNU LilyPond music typesetter
   5 ;;;;
   6 ;;;; (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   8
   9 (use-modules (oop goops)
  10              (srfi srfi-13)
  11              (srfi srfi-1))
  12
  13 (define-class <texi-node> ()
  14   (children #:init-value '() #:accessor node-children #:init-keyword #:children)
  15   (text #:init-value "" #:accessor node-text #:init-keyword #:text)
  16   (name #:init-value "" #:accessor node-name #:init-keyword #:name)
  17   (description #:init-value "" #:accessor node-desc #:init-keyword #:desc))
  18
  19 (define (menu-entry x)
  20   (cons
  21    (node-name x)
  22    (node-desc x)))
  23
  24 (define (dump-node node port level)
  25   (display
  26    (string-append
  27     "\n@node "
  28     (node-name node)
  29     "\n\n"
  30     (texi-section-command level) " "
  31     (node-name node)
  32     "\n\n"
  33     (node-text node)
  34     "\n\n"
  35     (if (pair? (node-children node))
  36         (texi-menu
  37          (map (lambda (x) (menu-entry x))
  38               (node-children node)))
  39         ""))
  40    port)
  41   (map (lambda (x) (dump-node x port (+ 1 level)))
  42        (node-children node)))
  43
  44 (define (processing name)
  45   (ly:message (_ "Processing ~S...") name))
  46
  47 (define (self-evaluating? x)
  48   (or (number? x) (string? x) (procedure? x) (boolean? x)))
  49
  50 (define (texify x)
  51   x)
  52
  53 (define (scm->texi x)
  54   (string-append "@code{" (texify (scm->string x)) "}"))
  55
  56
  57
  58 (define (texi-section-command level)
  59   (cdr (assoc level '(
  60                       ;; Hmm, texinfo doesn't have ``part''
  61                       (0 . "@top")
  62                       (1 . "@unnumbered")
  63                       (2 . "@unnumberedsec")
  64                       (3 . "@unnumberedsubsec")
  65                       (4 . "@unnumberedsubsubsec")
  66                       (5 . "@unnumberedsubsubsec")))))
  67
  68 (define (one-item->texi label-desc-pair)
  69   "Document one (LABEL . DESC); return empty string if LABEL is empty string.
  70 "
  71   (if (eq? (car label-desc-pair) "")
  72       ""
  73       (string-append "\n@item " (car label-desc-pair) "\n" (cdr label-desc-pair))))
  74
  75
  76 (define (description-list->texi items-alist)
  77   "Document ITEMS-ALIST in a table. entries contain (item-label
  78 . string-to-use)
  79 "
  80   (string-append
  81    "\n"
  82    "@quotation\n"
  83    "@table @asis\n"
  84    (apply string-append (map one-item->texi items-alist))
  85    "\n"
  86    "@end table\n"
  87    "@end quotation\n"))
  88
  89 (define (texi-menu items-alist)
  90   "Generate what is between @menu and @end menu."
  91   (let ((maxwid
  92          (apply max (map (lambda (x) (string-length (car x))) items-alist))))
  93
  94     (string-append
  95      "\n@menu"
  96      (apply string-append
  97             (map (lambda (x)
  98                    (string-append
  99                     (string-pad-right
 100                      (string-append "\n* " (car x) ":: ")
 101                      (+ maxwid 8))
 102                     (cdr x)))
 103                  items-alist))
 104      "\n@end menu\n"
 105      ;; Menus don't appear in html, so we make a list ourselves
 106      "\n@ignore\n"
 107      "\n@ifhtml\n"
 108      (description-list->texi (map (lambda (x) (cons (ref-ify (car x)) (cdr x)))
 109                                   items-alist))
 110      "\n@end ifhtml\n"
 111      "\n@end ignore\n")))
 112
 113 (define (texi-file-head name file-name top)
 114   (string-append
 115    "\\input texinfo @c -*-texinfo-*-"
 116    "\n@setfilename " file-name ".info"
 117    "\n@settitle " name
 118    "\n@dircategory LilyPond"
 119    "\n@direntry"
 120    ;; prepend GNU for dir, must be unique
 121    "\n* GNU " name ": (" file-name ").          " name "."
 122    "\n@end direntry\n"
 123    "@documentlanguage en\n"
 124    "@documentencoding utf-8\n"))
 125
 126 (define (context-name name)
 127   name)
 128
 129 (define (engraver-name name)
 130   name)
 131
 132 (define (grob-name name)
 133   (if (symbol? name)
 134       (symbol->string name)
 135       name))
 136
 137 (define (interface-name name)
 138   name)
 139
 140 (define (ref-ify x)
 141   "Add ref to X"
 142   (string-append "@ref{" x "}"))
 143
 144 (define (human-listify lst)
 145   "Produce a textual enumeration from LST, a list of strings"
 146
 147   (cond
 148    ((null? lst) "none")
 149    ((null? (cdr lst)) (car lst))
 150    ((null? (cddr lst)) (string-append (car lst) " and " (cadr lst)))
 151    (else (string-append (car lst) ", " (human-listify (cdr lst))))))
 152
 153 (define (writing-wip x)
 154   (ly:message (_ "Writing ~S...") x))
 155
 156
 157 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 158 ;; property  stuff.
 159
 160 (define (property->texi where sym . rest)
 161   "Document SYM for WHERE (which can be translation, backend, music),
 162 with init values from ALIST (1st optional argument)
 163 "
 164   (let* ((name (symbol->string sym))
 165          (alist (if (pair? rest) (car rest) '()))
 166          (type?-name (string->symbol
 167                       (string-append (symbol->string where) "-type?")))
 168          (doc-name (string->symbol
 169                     (string-append (symbol->string where) "-doc")))
 170          (type (object-property sym type?-name))
 171          (typename (type-name type))
 172          (desc (object-property sym doc-name))
 173          (handle (assoc sym alist)))
 174
 175     (if (eq? desc #f)
 176         (ly:error (_ "cannot find description for property ~S (~S)") sym where))
 177
 178     (cons
 179      (string-append "@code{" name "} "
 180                     "(" typename ")"
 181                     (if handle
 182                         (string-append
 183                          ":\n\n"
 184                          (scm->texi (cdr handle))
 185                          "\n\n")
 186                         ""))
 187      desc)))
 188