scm/document-markup.scm

   1 ;;;; document-markup.scm -- part of generated backend documentation
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8 (define (doc-markup-function func)
   9   (let*
  10       ((doc-str  (procedure-documentation func) )
  11        (f-name (symbol->string (procedure-name  func)))
  12        (c-name (regexp-substitute/global #f "-markup$" f-name  'pre "" 'post))
  13        (sig (object-property func 'markup-signature))
  14        (arg-names
  15         (map symbol->string
  16              (cddr (cadr (procedure-source func)))))
  17
  18        (sig-type-names (map type-name sig))
  19        (signature (zip arg-names  sig-type-names))
  20        (signature-str
  21         (string-join
  22          (map (lambda (x) (string-append
  23                            "@var{" (car x) "} ("  (cadr x) ")" ))
  24               (zip arg-names  sig-type-names))
  25          " " )))
  26
  27
  28
  29   (string-append
  30    "\n\n@item @code{\\" c-name "} " signature-str
  31
  32    "\n@findex " f-name "\n"
  33    "\n@cindex " c-name "\n"
  34
  35    (if (string? doc-str)
  36        doc-str
  37        "")
  38   )))
  39
  40 (define (markup-function<? a b)
  41   (string<? (symbol->string (procedure-name a)) (symbol->string (procedure-name b))))
  42
  43 (define (markup-doc-string)
  44   (string-append
  45
  46          "@table @asis"
  47          (apply string-append
  48
  49                 (map doc-markup-function
  50                      (sort markup-function-list markup-function<?) ) )
  51          "\n@end table"
  52
  53          ))
  54
  55 (define (markup-doc-node)
  56   (make <texi-node>
  57     #:name "Markup functions"
  58     #:desc "Definitions of the markup functions."
  59     #:text (markup-doc-string)))