-;;;; backend-documentation-lib.scm -- Functions for backend documentation
+;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; source file of the GNU LilyPond music typesetter
-;;;;
-;;;; (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 2000--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 (sort-grob-properties x)
+ ;; force 'meta to the end of each prop-list
+ (let ((meta (assoc 'meta x)))
+ (append (sort (assoc-remove! x 'meta) ly:alist-ci<?)
+ (list meta))))
+
+;; properly sort all grobs, properties, and interfaces
+;; within the all-grob-descriptions alist
+(map
+ (lambda (x)
+ (let* ((props (assoc-ref all-grob-descriptions (car x)))
+ (meta (assoc-ref props 'meta))
+ (interfaces (assoc-ref meta 'interfaces)))
+ (set! all-grob-descriptions
+ (sort (assoc-set! all-grob-descriptions (car x)
+ (sort-grob-properties
+ (assoc-set! props 'meta
+ (assoc-set! meta 'interfaces
+ (sort interfaces ly:symbol-ci<?)))))
+ ly:alist-ci<?))))
+ all-grob-descriptions)
(define (interface-doc-string interface grob-description)
(let* ((name (car interface))
(desc (cadr interface))
- (props (sort (caddr interface) symbol<?))
+ (props (caddr interface))
(docfunc (lambda (pr)
(property->texi
'backend pr grob-description)))
(if (pair? uprops)
(string-append
- "\n\n@unnumberedsubsubsec User settable properties:\n"
- (description-list->texi user-propdocs))
+ "\n\n@subsubheading User settable properties:\n"
+ (description-list->texi user-propdocs #t))
"")
(if (pair? iprops)
(string-append
- "\n\n@unnumberedsubsubsec Internal properties:\n"
- (description-list->texi internal-propdocs))
+ "\n\n@subsubheading Internal properties:\n"
+ (description-list->texi internal-propdocs #t))
""))))
-(define iface->grob-table (make-vector 61 '()))
+(define iface->grob-table (make-hash-table 61))
;; extract ifaces, and put grob into the hash table.
(map
(lambda (x)
- (let* ((metah (assoc 'meta (cdr x)))
- (meta (cdr metah))
- (ifaces (cdr (assoc 'interfaces meta))))
+ (let* ((meta (assoc-get 'meta (cdr x)))
+ (ifaces (assoc-get 'interfaces meta)))
(map (lambda (iface)
(hashq-set!
;; First level Interface description
(define (interface-doc interface)
- (let ((name (symbol->string (car interface))))
+ (let* ((name (symbol->string (car interface)))
+ (interface-list (human-listify
+ (map ref-ify
+ (sort
+ (map symbol->string
+ (hashq-ref iface->grob-table
+ (car interface)
+ '()))
+ ly:string-ci<?)))))
(make <texi-node>
#:name name
#:text (string-append
(interface-doc-string (cdr interface) '())
"\n\n"
- "This grob interface is used in the following graphical objects: "
-
- (human-listify
- (map ref-ify
- (sort
- (map symbol->string
- (hashq-ref iface->grob-table (car interface) '()))
- string<?)))))))
+ "This grob interface "
+ (if (equal? interface-list "none")
+ "is not used in any graphical object"
+ (string-append
+ "is used in the following graphical object(s): "
+ interface-list))
+ "."))))
(define (grob-alist->texi alist)
(let* ((uprops (filter (lambda (x) (not (object-property x 'backend-internal)))
(description-list->texi
(map (lambda (y) (property->texi 'backend y alist))
- uprops))))
+ uprops)
+ #t)))
(define (grob-doc description)
"Given a property alist DESCRIPTION, make a documentation
node."
- (let* ((metah (assoc 'meta description))
- (meta (cdr metah))
- (name (cdr (assoc 'name meta)))
+ (let* ((meta (assoc-get 'meta description))
+ (name (assoc-get 'name meta))
;; (bla (display name))
- (ifaces (map lookup-interface (cdr (assoc 'interfaces meta))))
- (ifacedoc (map (lambda (iface)
- (if (pair? iface)
- (ref-ify (symbol->string (car iface)))
- (ly:error (_ "pair expected in doc ~s") name)))
- (reverse ifaces)))
+ (ifaces (map lookup-interface (assoc-get 'interfaces meta)))
+ (ifacedoc (map ref-ify
+ (sort
+ (map (lambda (iface)
+ (if (pair? iface)
+ (symbol->string (car iface))
+ (ly:error (_ "pair expected in doc ~s") name)))
+ ifaces)
+ ly:string-ci<?)))
(engravers (filter
- (lambda (x) (engraver-makes-grob? name x)) all-engravers-list))
+ (lambda (x) (engraver-makes-grob? name x))
+ all-engravers-list))
(namestr (symbol->string name))
- (engraver-names (map symbol->string (map ly:translator-name engravers))))
+ (engraver-names (map symbol->string
+ (map ly:translator-name engravers)))
+ (engraver-list (human-listify
+ (map ref-ify
+ (map engraver-name engraver-names)))))
(make <texi-node>
#:name namestr
#:text
(string-append
- namestr " objects are created by: "
- (human-listify (map ref-ify
- (map engraver-name engraver-names)))
- "\n\nStandard settings: \n\n"
+ namestr " objects "
+ (if (equal? engraver-list "none")
+ "are not created by any engraver"
+ (string-append
+ "are created by: "
+ engraver-list))
+ "."
+
+ "\n\nStandard settings:\n\n"
(grob-alist->texi description)
- "\n\nThis object supports the following interfaces: \n"
- (human-listify ifacedoc)))))
+ "\n\nThis object supports the following interface(s):\n"
+ (human-listify ifacedoc)
+ "."))))
(define (all-grobs-doc)
(make <texi-node>
(cons (cons key val) prior))
'() (ly:all-grob-interfaces)))
-(set! interface-description-alist (sort interface-description-alist alist<?))
+(set! interface-description-alist
+ (sort interface-description-alist ly:alist-ci<?))
;;;;;;;;;; check for dangling backend properties.
(define (mark-interface-properties entry)
(map interface-doc interface-description-alist)))
(define (backend-properties-doc-string lst)
- (let* ((ps (sort (map symbol->string lst) string<?))
+ (let* ((ps (sort (map symbol->string lst) ly:string-ci<?))
(descs (map (lambda (prop)
(property->texi 'backend (string->symbol prop) '())) ps))
- (texi (description-list->texi descs)))
+ (texi (description-list->texi descs #f)))
texi))
;;(dump-node (grob-doc (cdadr all-grob-descriptions)) (current-output-port) 0 )