/usr/share/lilypond/2.14.2/scm/document-markup.scm is in lilypond-data 2.14.2-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | ;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
;;;;
;;;; LilyPond is free software: you can redistribute it and/or modify
;;;; it under the terms of the GNU General Public License as published by
;;;; the Free Software Foundation, either version 3 of the License, or
;;;; (at your option) any later version.
;;;;
;;;; LilyPond is distributed in the hope that it will be useful,
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;;; GNU General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU General Public License
;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
(define (doc-markup-function-properties func)
(let ((properties (hashq-ref markup-functions-properties func))
(prop-strings (list)))
(for-each (lambda (prop-spec)
(set! prop-strings
(if (list? prop-spec)
;; either (prop value) or (prop)
(cons (if (null? (cdr prop-spec))
(format #f "@item @code{~a}\n" (car prop-spec))
(format #f "@item @code{~a} (~a)\n"
(car prop-spec)
(let ((default (cadr prop-spec)))
(if (and (list? default)
(null? default))
"'()"
default))))
prop-strings)
;; a markup command: get its properties
;; FIXME: avoid cyclical references
(append (doc-markup-function-properties prop-spec)
prop-strings))))
(or properties (list)))
prop-strings))
(define (doc-markup-function func)
(let* ((doc-str (procedure-documentation func))
(f-name (symbol->string (procedure-name func)))
(c-name (regexp-substitute/global #f "-markup(-list)?$" f-name 'pre "" 'post))
(sig (object-property func 'markup-signature))
(arg-names (let ((arg-list (cadr (procedure-source func))))
(if (list? arg-list)
(map symbol->string (cddr arg-list))
(make-list (length sig) "arg"))))
(sig-type-names (map type-name sig))
(signature-str
(string-join
(map (lambda (x) (string-append
"@var{" (car x) "} (" (cadr x) ")" ))
(zip arg-names sig-type-names))
" " )))
(string-append
"\n\n@item @code{\\" c-name "} " signature-str
"\n@funindex \\" c-name "\n"
"\n@cindex \\" c-name "\n"
(if (string? doc-str)
doc-str
"")
(let ((prop-strings (doc-markup-function-properties func)))
(if (null? prop-strings)
"\n"
(string-append "\n\n\nUsed properties:\n@itemize\n"
(apply string-append prop-strings)
"@end itemize\n"))))))
(define (markup-function<? a b)
(ly:string-ci<? (symbol->string (procedure-name a)) (symbol->string (procedure-name b))))
(define (markup-category-doc-node category)
(let* ((category-string (symbol->string category))
(category-name (string-capitalize (regexp-substitute/global #f
"-" category-string 'pre " " 'post)))
(markup-functions (hash-fold (lambda (markup-function dummy functions)
(cons markup-function functions))
'()
(hashq-ref markup-functions-by-category
category))))
(make <texi-node>
#:appendix #t
#:name category-name
#:desc ""
#:text (string-append
"@table @asis"
(apply string-append
(map doc-markup-function
(sort markup-functions markup-function<?)))
"\n@end table"))))
(define (markup-doc-node)
(make <texi-node>
#:appendix #t
#:name "Text markup commands"
#:desc ""
#:text "The following commands can all be used inside @code{\\markup @{ @}}."
#:children (let* (;; when a new category is defined, update `ordered-categories'
(ordered-categories '(font align graphic music instrument-specific-markup other))
(raw-categories (hash-fold (lambda (category functions categories)
(cons category categories))
(list)
markup-functions-by-category))
(categories (append ordered-categories
(filter (lambda (cat)
(not (memq cat ordered-categories)))
raw-categories))))
(map markup-category-doc-node categories))))
(define (markup-list-doc-string)
(string-append
"@table @asis"
(apply string-append
(map doc-markup-function
(sort (hash-fold (lambda (markup-list-function dummy functions)
(cons markup-list-function functions))
'()
markup-list-functions)
markup-function<?)))
"\n@end table"))
|