X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocument-backend.scm;h=71ba5a274fa616c3bbf111fab909af2f0eab4657;hb=32a34dcef0c0041c6d62677487a380b5c8b85712;hp=8d7bb3bc25c001b99634efb1e47298ebd6843bf3;hpb=40b08aca291b101bcab28ce68088935a0ad07fe2;p=lilypond.git

diff --git a/scm/document-backend.scm b/scm/document-backend.scm
index 8d7bb3bc25..71ba5a274f 100644
--- a/scm/document-backend.scm
+++ b/scm/document-backend.scm
@@ -1,14 +1,47 @@
-;;;; 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--2012 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)))
@@ -35,13 +68,12 @@
 	  (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!
@@ -61,7 +93,7 @@
 				     (hashq-ref iface->grob-table
 						(car interface)
 						'()))
-				string<?)))))
+				ly:string-ci<?)))))
     (make <texi-node>
       #:name name
       #:text (string-append
@@ -88,16 +120,18 @@
   "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))
@@ -120,9 +154,9 @@ node."
 	    engraver-list))
        "."
 
-       "\n\nStandard settings: \n\n"
+       "\n\nStandard settings:\n\n"
        (grob-alist->texi description)
-       "\n\nThis object supports the following interface(s): \n"
+       "\n\nThis object supports the following interface(s):\n"
        (human-listify ifacedoc)
        "."))))
 
@@ -139,7 +173,8 @@ 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)
@@ -171,7 +206,7 @@ node."
     (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 #f)))