scm/document-identifiers.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2006--2011 Han-Wen Nienhuys <hanwen@lilypond.org>
   4 ;;;;
   5 ;;;; LilyPond is free software: you can redistribute it and/or modify
   6 ;;;; it under the terms of the GNU General Public License as published by
   7 ;;;; the Free Software Foundation, either version 3 of the License, or
   8 ;;;; (at your option) any later version.
   9 ;;;;
  10 ;;;; LilyPond is distributed in the hope that it will be useful,
  11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ;;;; GNU General Public License for more details.
  14 ;;;;
  15 ;;;; You should have received a copy of the GNU General Public License
  16 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 (use-modules (ice-9 format))
  19
  20 (define (document-music-function music-func-pair)
  21   (let*
  22       ((name-sym (car music-func-pair))
  23        (music-func (cdr music-func-pair))
  24        (func (ly:music-function-extract music-func))
  25        (arg-names
  26         (map symbol->string
  27              (cddr (cadr (procedure-source func)))))
  28        (doc (procedure-documentation func))
  29        (sign (object-property func 'music-function-signature))
  30        (type-names (map type-name sign))
  31        (signature-str
  32         (string-join
  33          (map (lambda (x) (format #f "@var{~a} (~a)"
  34                                   (car x)
  35                                   (cadr x)))
  36               (zip arg-names (cdr type-names))))))
  37     (format #f
  38      "@item @code{~a} (~a) ~a~a
  39 @funindex ~a
  40 ~a
  41 "
  42      name-sym (car type-names)
  43      (if (equal? "" signature-str) "" " - ") signature-str
  44      name-sym
  45      (if doc
  46          doc
  47          (begin
  48            (ly:warning "music function `~a' not documented." name-sym)
  49            "(undocumented; fixme)")))))
  50
  51
  52 (define (document-object obj-pair)
  53   (cond
  54    ((ly:music-function? (cdr obj-pair))
  55     (document-music-function obj-pair))
  56    (else
  57     #f)))
  58
  59 (define-public (identifiers-doc-string)
  60   (format #f
  61    "@table @asis
  62 ~a
  63 @end table
  64 "
  65    (string-join
  66     (filter
  67      identity
  68      (map
  69       document-object
  70       (sort
  71        (ly:module->alist (current-module))
  72        identifier<?)))
  73     "")))