X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocument-music.scm;h=bc9fa88ae1a01f1b7188fedda0972946e0feff61;hb=HEAD;hp=2e8c40f2f09ca579e61bee070e5c6b3b9981e004;hpb=5c0ced08ad28694ab16575c66d91068d1aa58ead;p=lilypond.git

diff --git a/scm/document-music.scm b/scm/document-music.scm
index 2e8c40f2f0..bc9fa88ae1 100644
--- a/scm/document-music.scm
+++ b/scm/document-music.scm
@@ -1,91 +1,119 @@
-;;;; document-markup.scm -- part of generated backend documentation
+;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;;  source file of the GNU LilyPond music typesetter
-;;;; 
-;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2015 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 (music-props-doc)
   (make <texi-node>
     #:name "Music properties"
-    #:desc "All music properties, including descriptions"
+    #:desc "All music properties, including descriptions."
     #:text
-    (let* ((ps (sort (map symbol->string all-music-properties) string<?))
-	   (descs (map (lambda (prop)
-			 (property->texi 'music (string->symbol prop)))
-		       ps))
-	   (texi (description-list->texi descs)))
+    (let* ((ps (sort (map symbol->string all-music-properties) ly:string-ci<?))
+           (descs (map (lambda (prop)
+                         (property->texi 'music (string->symbol prop)))
+                       ps))
+           (texi (description-list->texi descs #f)))
       texi)))
 
-(define music-types->names (make-vector 61 '()))
-(filter-map (lambda (entry)
-	      (let* ((class (ly:camel-case->lisp-identifier (car entry)))
-		     (classes (ly:make-event-class class)))
-		(if classes
-		    (map (lambda (cl)
-			   (hashq-set! music-types->names cl
-				       (cons (car entry)
-					     (hashq-ref music-types->names cl '()))))
-			 classes)
-		    #f)))
-	    
-	    music-descriptions)
+(define music-types->names (make-hash-table 61))
+
+(for-each (lambda (entry)
+            (let* ((class (ly:camel-case->lisp-identifier (car entry)))
+                   (classes (ly:make-event-class class)))
+              (if classes
+                  (for-each
+                   (lambda (cl)
+                     (hashq-set! music-types->names cl
+                                 (cons (car entry)
+                                       (hashq-ref music-types->names cl '()))))
+                   classes))))
+          music-descriptions)
 
 (define (strip-description x)
   (cons (symbol->string (car x))
-	""))
+        ""))
 
 (define (music-type-doc entry)
-  (make <texi-node>
-    #:name  (symbol->string (car entry))
-    #:text 
-    (string-append
-     "\nMusic event type @code{"
-     (symbol->string (car entry))
-     "} is in Music objects of type "
-     (human-listify
-      (sort
-       (map (lambda (x) (ref-ify (symbol->string x)))
-	    (cdr entry)) string<?))
-     "."
+  (let* ((accept-list (human-listify
+                       (map ref-ify
+                            (map symbol->string
+                                 (map ly:translator-name
+                                      (filter
+                                       (lambda (x)
+                                         (engraver-accepts-music-type? (car entry) x))
+                                       all-engravers-list)))))))
+    (make <texi-node>
+      #:name (symbol->string (car entry))
+      #:text
+      (string-append
+       "\nMusic event type @code{"
+       (symbol->string (car entry))
+       "} is in music objects of type "
+       (human-listify
+        (map ref-ify (sort (map symbol->string (cdr entry))
+                           ly:string-ci<?)))
+       "."
 
-     "\n\nAccepted by: "
-     (human-listify
-      (map ref-ify
-	   (map symbol->string
-		(map ly:translator-name
-		     (filter
-		      (lambda (x) (engraver-accepts-music-type? (car entry) x)) all-engravers-list)))))
-     "."
-     "\n\n")))
+       "\n\n"
+       (if (equal? accept-list "none")
+           "Not accepted by any engraver or performer"
+           (string-append
+            "Accepted by: "
+            accept-list))
+       "."))))
 
 (define (music-types-doc)
   (make <texi-node>
     #:name "Music classes"
-    #:children 
+    #:children
     (map music-type-doc
-	 (sort
-	  (hash-table->alist music-types->names) alist<?))))
+         (sort
+          (hash-table->alist music-types->names) ly:alist-ci<?))))
 
 (define (music-doc-str obj)
   (let* ((namesym  (car obj))
-	 (props (cdr obj))
-	 (class (ly:camel-case->lisp-identifier namesym))
-	 (classes (ly:make-event-class class))
-	 (event-texi (if classes
-			 (string-append
-			  "\n\nEvent classes:\n"
-			  (human-listify (map ref-ify (map symbol->string classes)))
-			  "."
+         (props (cdr obj))
+         (class (ly:camel-case->lisp-identifier namesym))
+         (classes (ly:make-event-class class))
+         (accept-list (if classes
+                          (human-listify
+                           (map ref-ify
+                                (map symbol->string
+                                     (map ly:translator-name
+                                          (filter
+                                           (lambda (x)
+                                             (engraver-accepts-music-types? classes x))
+                                           all-engravers-list)))))
+                          ""))
+         (event-texi (if classes
+                         (string-append
+                          "\n\nEvent classes:\n"
+                          (human-listify
+                           (map ref-ify (sort (map symbol->string classes)
+                                              ly:string-ci<?)))
+                          "."
 
-			  "\n\nAccepted by: "
-			  (human-listify
-			   (map ref-ify
-				(map symbol->string (map ly:translator-name
-							 (filter
-							  (lambda (x) (engraver-accepts-music-types? classes x)) all-engravers-list)))))
-			  ".")
-			 "")))
+                          "\n\n"
+                          (if (equal? accept-list "none")
+                              "Not accepted by any engraver or performer"
+                              (string-append
+                               "Accepted by: "
+                               accept-list))
+                          ".")
+                         "")))
 
     (string-append
      (object-property namesym 'music-description)
@@ -94,7 +122,8 @@
      (description-list->texi
       (map
        (lambda (x) (property->texi 'music x props))
-       (map car props))))))
+       (sort (map car props) ly:symbol-ci<?))
+      #t))))
 
 (define (music-object-doc obj)
   (make <texi-node>
@@ -111,7 +140,7 @@
 (define (music-doc-node)
   (make <texi-node>
     #:name "Music definitions"
-    #:desc "Definition of the Input data structures"
+    #:desc "Definition of the input data structures."
     #:children
     (list
      (music-expressions-doc)