-;;;
-;;; documentation-lib.scm -- Assorted Functions for generated documentation
-;;;
-;;; source file of the GNU LilyPond music typesetter
-;;;
-;;; (c) 2000--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-;;; Jan Nieuwenhuizen <janneke@gnu.org>
+;;;;
+;;;; documentation-lib.scm -- Assorted Functions for generated documentation
+;;;;
+;;;; source file of the GNU LilyPond music typesetter
+;;;;
+;;;; (c) 2000--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; Jan Nieuwenhuizen <janneke@gnu.org>
(use-modules (oop goops)
(srfi srfi-13)
- (srfi srfi-1)
- )
+ (srfi srfi-1))
(define-class <texi-node> ()
(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)
- )
+ (description #:init-value "" #:accessor node-desc #:init-keyword #:desc))
(define (menu-entry x)
(cons
(node-name x)
- (node-desc x))
- )
+ (node-desc x)))
(define (dump-node node port level)
(display
"\n\n"
(if (pair? (node-children node))
(texi-menu
- (map (lambda (x) (menu-entry x) )
+ (map (lambda (x) (menu-entry x))
(node-children node)))
- ""))
+ ""))
port)
(map (lambda (x) (dump-node x port (+ 1 level)))
- (node-children node))
- )
+ (node-children node)))
(define (processing name)
- (display (string-append "\nProcessing " name " ... ") (current-error-port)))
+ (ly:message (_ "Processing ~S...") name))
(define (self-evaluating? x)
(or (number? x) (string? x) (procedure? x) (boolean? x)))
x)
(define (scm->texi x)
- (string-append "@code{" (texify (scm->string x)) "}")
- )
+ (string-append "@code{" (texify (scm->string x)) "}"))
-;;
-;; don't confuse users with #<procedure .. > syntax.
-;;
-(define (scm->string val)
- (if (and (procedure? val) (symbol? (procedure-name val)))
- (symbol->string (procedure-name val))
- (string-append
- (if (self-evaluating? val) "" "'")
- (call-with-output-string (lambda (port) (display val port)))
- )))
-
(define (texi-section-command level)
(cdr (assoc level '(
- ;; Hmm, texinfo doesn't have ``part''
- (0 . "@top")
- (1 . "@unnumbered")
- (2 . "@unnumberedsec")
- (3 . "@unnumberedsubsec")
- (4 . "@unnumberedsubsubsec")
- (5 . "@unnumberedsubsubsec")
- ))))
+ ;; Hmm, texinfo doesn't have ``part''
+ (0 . "@top")
+ (1 . "@unnumbered")
+ (2 . "@unnumberedsec")
+ (3 . "@unnumberedsubsec")
+ (4 . "@unnumberedsubsubsec")
+ (5 . "@unnumberedsubsubsec")))))
(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))
- ))
+ (string-append "\n@item " (car label-desc-pair) "\n" (cdr label-desc-pair))))
(define (description-list->texi items-alist)
(define (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)))
- )
-
-
+ (let ((maxwid
+ (apply max (map (lambda (x) (string-length (car x))) 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))
- "\n@end ifhtml\n"
- "\n@end ignore\n")))
-
-
-
+ (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))
+ "\n@end ifhtml\n"
+ "\n@end ignore\n")))
(define (texi-file-head name file-name top)
(string-append
"\n@direntry"
;; prepend GNU for dir, must be unique
"\n* GNU " name ": (" file-name "). " name "."
- "\n@end direntry"
- ))
-
+ "\n@end direntry\n"
+ "@documentlanguage en\n"
+ "@documentencoding utf-8\n"))
(define (context-name name)
name)
"Add ref to X"
(string-append "@ref{" x "}"))
-(define (human-listify l)
- "Produce a textual enumeration from L, a list of strings"
+(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))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(type (object-property sym type?-name))
(typename (type-name type))
(desc (object-property sym doc-name))
- (handle (assoc sym alist))
- )
+ (handle (assoc sym alist)))
(if (eq? desc #f)
- (error "No description for property ~S" sym))
-
+ (ly:error (_ "can't find description for property ~S (~S)") sym where))
+
(cons
(string-append "@code{" name "} "
"(" typename ")"
":\n\n"
(scm->texi (cdr handle))
"\n\n")
- "")
-
-
- )
- desc)
-
- ))
+ ""))
+ desc)))
projects / lilypond.git / blobdiff