X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-lib.scm;h=a033186067d998e51af075c695b9ce2fcaae7ec3;hb=25be0aa5e4481df77568b99357764f5b1ff46ceb;hp=2ee6e7a9cf557d1c17685808ed035ed8cd0b9a22;hpb=fdb66b65c89bf9e98da8975999815228d5f0449e;p=lilypond.git diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm index 2ee6e7a9cf..a033186067 100644 --- a/scm/documentation-lib.scm +++ b/scm/documentation-lib.scm @@ -1,115 +1,221 @@ -;;; -;;; documentation-lib.scm -- Assorted Functions for generated documentation -;;; -;;; source file of the GNU LilyPond music typesetter -;;; -;;; (c) 2000 Han-Wen Nienhuys -;;; Jan Nieuwenhuizen - -(define (uniqued-alist alist acc) - (if (null? alist) acc - (if (assoc (caar alist) acc) - (uniqued-alist (cdr alist) acc) - (uniqued-alist (cdr alist) (cons (car alist) acc) - )))) +;;;; This file is part of LilyPond, the GNU music typesetter. +;;;; +;;;; Copyright (C) 2000--2011 Han-Wen Nienhuys +;;;; Jan Nieuwenhuizen +;;;; +;;;; 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 . + +(use-modules (oop goops) + (srfi srfi-13) + (srfi srfi-1)) + +(define-class () + (appendix #:init-value #f #:accessor appendix? #:init-keyword #:appendix) + (children #:init-value '() #:accessor node-children #:init-keyword #:children) + (text #:init-value "" #:accessor node-text #:init-keyword #:text) + (name #:init-value "" #:accessor node-name #:init-keyword #:name) + (description #:init-value "" #:accessor node-desc #:init-keyword #:desc)) + +(define (menu-entry x) + (cons + (node-name x) + (node-desc x))) + +(define* (dump-node node port level) + (display + (string-append + "\n@node " + (if (= level 0) "Top" (node-name node)) + "\n" + (if (appendix? node) + (texi-appendix-section-command level) + (texi-section-command level)) + " " + (node-name node) + "\n\n" + (node-text node) + "\n\n" + (if (pair? (node-children node)) + (texi-menu + (map (lambda (x) (menu-entry x)) + (node-children node))) + "")) + port) + (map (lambda (x) (dump-node x port (+ 1 level))) + (node-children node))) + +(define (processing name) + (ly:basic-progress (_ "Processing ~S...") name)) (define (self-evaluating? x) (or (number? x) (string? x) (procedure? x) (boolean? x))) (define (texify x) x) -;; (let* -;; ((x1 (regexp-substitute/global #f "\([^@]\){" x 'pre "\1@{" 'post)) -;; ((x2 (regexp-substitute/global #f "\([^@]\){" x 'pre "\1@{" 'post)) -;; ((x3 (regexp-substitute/global #f "\([^@]\)@" x 'pre "\1@@" 'post)) -;; ) -;; x2)) - -(define (scm->string val) - (string-append - (if (self-evaluating? val) "" "'") - (texify - (call-with-output-string (lambda (port) (display val port)))) - )) -(define (node name) - (string-append - "\n@html" - "\n
" - "\n@end html" - "\n@node " name ",,,")) - -(define section-alist - '( - ;; Hmm, texinfo doesn't have ``part'' - (0 . "@top") - (1 . "@unnumbered") - (2 . "@unnumberedsec") - (3 . "@unnumberedsubsec") - (4 . "@unnumberedsubsubsec") - (5 . "@unnumberedsubsubsec") - )) - -(define (section level name) - (string-append "\n" (cdr (assoc level section-alist)) " " name "\n")) - -(define (description-list items-alist) +(define (scm->texi x) + (string-append "@code{" (texify (scm->string x)) "}")) + + + +(define (texi-section-command level) + (assoc-get level '( + ;; Hmm, texinfo doesn't have ``part'' + (0 . "@top") + (1 . "@chapter") + (2 . "@section") + (3 . "@subsection") + (4 . "@unnumberedsubsubsec") + (5 . "@unnumberedsubsubsec")))) + +(define (texi-appendix-section-command level) + (assoc-get level '((0 . "@top") + (1 . "@appendix") + (2 . "@appendixsec") + (3 . "@appendixsubsec") + (4 . "@appendixsubsubsec") + (5 . "@appendixsubsubsec")))) + +(define (one-item->texi label-desc-pair) + "Document one (LABEL . DESC); return empty string if LABEL is empty string." + (if (eq? (car label-desc-pair) "") + "" + (string-append "\n@item " (car label-desc-pair) "\n" (cdr label-desc-pair)))) + + +(define (description-list->texi items-alist quote?) + "Document ITEMS-ALIST in a table; entries contain (item-label . +string-to-use). If QUOTE? is #t, embed table in a @quotation environment." (string-append - "\n@table @samp\n" - (apply string-append - (map (lambda (x) (string-append "\n@item " (car x) "\n" (cdr x))) - items-alist)) - "\n@end table\n")) + "\n" + (if quote? "@quotation\n" "") + "@table @asis\n" + (apply string-append (map one-item->texi items-alist)) + "\n" + "@end table\n" + (if quote? "@end quotation\n" ""))) (define (texi-menu items-alist) - (string-append - "\n@menu" - (apply string-append - (map (lambda (x) (string-append "\n* " (car x) ":: " (cdr x))) - items-alist)) - "\n@end menu\n" - ;; Menus don't appear in html, so we make a list ourselves - "\n@ifhtml\n" - (description-list (map (lambda (x) (cons (reffy (car x)) (cdr x))) - items-alist)) - "\n@end ifhtml\n")) - - -(define (texi-node-menu name items-alist) - (string-append - (node name) - (section 1 name) - (texi-menu items-alist))) + "Generate what is between @menu and @end menu." + (let ((maxwid + (apply max (map (lambda (x) (string-length (car x))) items-alist)))) -(define (texi-file-head name file-name items-alist) + (string-append + "\n@menu" + (apply string-append + (map (lambda (x) + (string-append + (string-pad-right + (string-append "\n* " (car x) ":: ") + (+ maxwid 8)) + (cdr x))) + items-alist)) + "\n@end menu\n" + ;; Menus don't appear in html, so we make a list ourselves + "\n@ignore\n" + "\n@ifhtml\n" + (description-list->texi (map (lambda (x) (cons (ref-ify (car x)) (cdr x))) + items-alist) + #t) + "\n@end ifhtml\n" + "\n@end ignore\n"))) + +(define (texi-file-head name file-name top) (string-append - "\input texinfo @c -*-texinfo-*-\n" - "@settitle " name + "\\input texinfo @c -*-texinfo-*-" "\n@setfilename " file-name ".info" - (node "Top") - "\n@top" - (section 1 name) - (texi-menu items-alist))) + "\n@settitle " name + "\n@dircategory LilyPond" + "\n@direntry" + ;; prepend GNU for dir, must be unique + "\n* GNU " name ": (" file-name "). " name "." + "\n@end direntry\n" + "@documentlanguage en\n" + "@documentencoding utf-8\n")) (define (context-name name) - (string-append "Context " name)) + name) (define (engraver-name name) name) -(define (element-name name) - (string-append "Element " name)) +(define (grob-name name) + (if (symbol? name) + (symbol->string name) + name)) -(define (reffy x) +(define (interface-name name) + name) + +(define (ref-ify x) + "Return @ref{X}. If mapping ref-ify to a list that needs to be sorted, + sort the list first." (string-append "@ref{" x "}")) -(define (human-listify l) +(define (human-listify lst) + "Produce a textual enumeration from LST, a list of strings" + (cond - ((null? l) "none") - ((null? (cdr l)) (car l)) - ((null? (cddr l)) (string-append (car l) " and " (cadr l))) - (else (string-append (car l) ", " (human-listify (cdr l)))) - )) + ((null? lst) "none") + ((null? (cdr lst)) (car lst)) + ((null? (cddr lst)) (string-append (car lst) " and " (cadr lst))) + (else (string-append (car lst) ", " (human-listify (cdr lst)))))) (define (writing-wip x) - (display (string-append "\nWriting " x " ... ") (current-error-port))) + (ly:message (_ "Writing ~S...") x)) + +(define (identifierstring (car a)) + (symbol->string (car b)))) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; property stuff. + +(define (verify-type-name where sym type) + (if (eq? type #f) + (ly:error (_ "cannot find description for property `~S' (~S)") + sym + where)) + (type-name type)) + +(define (property->texi where sym . rest) + "Document SYM for WHERE (which can be translation, backend, music), +with init values from ALIST (1st optional argument) +" + (let* ((name (symbol->string sym)) + (alist (if (pair? rest) (car rest) '())) + (type?-name (string->symbol + (string-append (symbol->string where) "-type?"))) + (doc-name (string->symbol + (string-append (symbol->string where) "-doc"))) + (type (object-property sym type?-name)) + (typename (verify-type-name where sym type)) + (desc (object-property sym doc-name)) + (init-value (assoc-get sym alist))) + + (if (eq? desc #f) + (ly:error (_ "cannot find description for property ~S (~S)") sym where)) + + (cons + (string-append "@code{" name "} " + "(" typename ")" + (if init-value + (string-append + ":\n\n" + (scm->texi init-value) + "\n\n") + "")) + desc))) +