]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/document-backend.scm
Update from Ralph, thanks!
[lilypond.git] / scm / document-backend.scm
index 8a828b4a8cd44d78e4cb52474e15d8191cebc053..610f7c094a44ea30ec566c9aa623ee8c4af94af2 100644 (file)
@@ -2,7 +2,7 @@
 ;;;;
 ;;;; source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c)  2000--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
 
 (define (interface-doc-string interface grob-description)
         (docfunc (lambda (pr)
                    (property->texi
                     'backend pr grob-description)))
-        (iprops (filter (lambda (x) (object-property x 'backend-internal) ) props))
-        (uprops (filter (lambda (x) (not (object-property x 'backend-internal)) ) props))
+        (iprops (filter (lambda (x) (object-property x 'backend-internal))
+                        props))
+        (uprops (filter
+                 (lambda (x) (not (object-property x 'backend-internal)))
+                 props))
         (user-propdocs (map docfunc uprops))
         (internal-propdocs (map docfunc iprops)))
 
@@ -28,7 +31,7 @@
 
      (if (pair? iprops)
         (string-append
-         "\n\n@unnumberedsubsubsec Internal properties: \n"
+         "\n\n@unnumberedsubsubsec Internal properties:\n"
          (description-list->texi internal-propdocs))
         ""))))
 
              (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<?)))))))
+                         (hashq-ref iface->grob-table (car interface) '()))
+                    string<?)))
+             "."))))
 
 (define (grob-alist->texi alist)
   (let* ((uprops (filter (lambda (x) (not (object-property x 'backend-internal)))
@@ -85,7 +88,7 @@ node."
         (ifacedoc (map (lambda (iface)
                          (if (pair? iface)
                              (ref-ify (symbol->string (car iface)))
-                             (error (format "Error making doc of ~s" name))))
+                             (ly:error (_ "pair expected in doc ~s") name)))
                        (reverse ifaces)))
         (engravers (filter
                     (lambda (x) (engraver-makes-grob? name x)) all-engravers-list))
@@ -107,7 +110,7 @@ node."
 (define (all-grobs-doc)
   (make <texi-node>
     #:name "All layout objects"
-    #:desc "Description and defaults for all Grobs"
+    #:desc "Description and defaults for all graphical objects (grobs)."
     #:children
     (map (lambda (x) (grob-doc (cdr x)))  all-grob-descriptions)))
 
@@ -121,28 +124,30 @@ node."
 
 ;;;;;;;;;; check for dangling backend properties.
 (define (mark-interface-properties entry)
-  (map (lambda (x) (set-object-property! x  'iface-marked #t)) (caddr (cdr entry))))
+  (map (lambda (x) (set-object-property! x 'iface-marked #t))
+       (caddr (cdr entry))))
 
 (map mark-interface-properties interface-description-alist)
 
 (define (check-dangling-properties prop)
   (if (not (object-property prop 'iface-marked))
-      (error  "\ndefine-grob-properties.scm: Can't find interface for property:" prop)))
+      (ly:error (string-append "define-grob-properties.scm: "
+               (_ "cannot find interface for property: ~S")) prop)))
 
 (map check-dangling-properties all-backend-properties)
 
 ;;;;;;;;;;;;;;;;
 
 (define (lookup-interface name)
-  (let* ((entry (hashq-ref (ly:all-grob-interfaces) name '() )))
-    (if (equal? entry #f)
-       (error "Unknown interface" name))
-    entry))
+  (let* ((entry (hashq-ref (ly:all-grob-interfaces) name #f)))
+    (if entry
+       entry
+       (ly:error (_ "unknown Grob interface: ~S") name))))
 
 (define (all-interfaces-doc)
   (make <texi-node>
     #:name "Graphical Object Interfaces"
-    #:desc "Building blocks of graphical objects"
+    #:desc "Building blocks of graphical objects."
     #:children
     (map interface-doc interface-description-alist)))
 
@@ -157,16 +162,16 @@ node."
 (define (backend-doc-node)
   (make <texi-node>
     #:name "Backend"
-    #:desc "Reference for the layout engine"
+    #:desc "Reference for the layout engine."
     #:children
     (list
      (all-grobs-doc)
      (all-interfaces-doc)
      (make <texi-node>
        #:name "User backend properties"
-       #:desc "All tunable properties in a big list"
+       #:desc "All tunable properties in a big list."
        #:text (backend-properties-doc-string all-user-grob-properties))
      (make <texi-node>
        #:name "Internal backend properties"
-       #:desc "All internal layout properties in a big list"
+       #:desc "All internal layout properties in a big list."
        #:text (backend-properties-doc-string all-internal-grob-properties)))))