]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/lily-library.scm
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / scm / lily-library.scm
index 29e3f476fc5ee9541e8de187ab37037b00da6693..d178c6926c80d7a6c1d1b6c9e9c1d8cb3dcf16b9 100644 (file)
@@ -1,37 +1,41 @@
+;;;;
 ;;;; lily-library.scm -- utilities
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c)  1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
 
 
 (define-public X 0)
 (define-public Y 1)
-(define-public START -1)
-(define-public STOP 1)
+(define-safe-public START -1)
+(define-safe-public STOP 1)
 (define-public LEFT -1)
 (define-public RIGHT 1)
 (define-public UP 1)
 (define-public DOWN -1)
 (define-public CENTER 0)
 
-(define-public DOUBLE-FLAT -4)
-(define-public THREE-Q-FLAT -3)
-(define-public FLAT -2)
-(define-public SEMI-FLAT -1)
-(define-public NATURAL 0)
-(define-public SEMI-SHARP 1)
-(define-public SHARP 2)
-(define-public THREE-Q-SHARP 3)
-(define-public DOUBLE-SHARP 4)
-(define-public SEMI-TONE 2)
+(define-safe-public DOUBLE-FLAT -4)
+(define-safe-public THREE-Q-FLAT -3)
+(define-safe-public FLAT -2)
+(define-safe-public SEMI-FLAT -1)
+(define-safe-public NATURAL 0)
+(define-safe-public SEMI-SHARP 1)
+(define-safe-public SHARP 2)
+(define-safe-public THREE-Q-SHARP 3)
+(define-safe-public DOUBLE-SHARP 4)
+(define-safe-public SEMI-TONE 2)
 
 (define-public ZERO-MOMENT (ly:make-moment 0 1)) 
 
 (define-public (moment-min a b)
   (if (ly:moment<? a b) a b))
 
+(define-public (average x . lst)
+  (/ (+ x (apply + lst)) (1+ (length lst))))
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;; lily specific variables.
 
 
 ;; parser stuff.
 (define-public (print-music-as-book parser music)
-  (let* ((head  (ly:parser-lookup parser '$globalheader))
-        (book (ly:make-book (ly:parser-lookup parser $defaultpaper)
-                            head score)))
-    (ly:parser-print-book parser book)))
+  (let* ((head (ly:parser-lookup parser '$defaultheader))
+        (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
+                            head (scorify-music music parser))))
+    (print-book-with-defaults parser book)))
 
 (define-public (print-score-as-book parser score)
-  (let*
-      ((head  (ly:parser-lookup parser '$globalheader))
-       (book (ly:make-book (ly:parser-lookup parser $defaultpaper)
-                          head score)))
-    (ly:parser-print-book parser book)))
+  (let* ((head (ly:parser-lookup parser '$defaultheader))
+        (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
+                            head score)))
+    (print-book-with-defaults parser book)))
 
 (define-public (print-score parser score)
-  (let* ((head  (ly:parser-lookup parser '$globalheader))
-        (book (ly:make-book (ly:parser-lookup parser $defaultpaper)
+  (let* ((head (ly:parser-lookup parser '$defaultheader))
+        (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
                             head score)))
     (ly:parser-print-score parser book)))
                
-(define-public (collect-scores-for-book  parser score)
+(define-public (collect-scores-for-book parser score)
+  (ly:parser-define!
+   parser 'toplevel-scores
+   (cons score (ly:parser-lookup parser 'toplevel-scores))))
+
+
+(define-public (scorify-music music parser)
+  
+  (for-each (lambda (func)
+             (set! music (func music parser)))
+           toplevel-music-functions)
+
+  (ly:make-score music))
+
+(define-public (collect-music-for-book parser music)
+  ;; discard music if its 'void property is true.
+  (let ((void-music (ly:music-property music 'void)))
+    (if (or (null? void-music) (not void-music))
+        (collect-scores-for-book parser (scorify-music music parser)))))
+
+
+(define-public (print-book-with-defaults parser book)
   (let*
-      ((oldval (ly:parser-lookup parser 'toplevel-scores)))
-    (ly:parser-define parser 'toplevel-scores (cons score oldval))
+      ((paper (ly:parser-lookup parser '$defaultpaper))
+       (layout (ly:parser-lookup parser '$defaultlayout))
+       (count (ly:parser-lookup parser 'output-count))
+       (base (ly:parser-output-name parser)))
+
+    (if (not (integer? count))
+       (set! count 0))
+
+    (if (> count 0)
+       (set! base (format #f "~a-~a" base count)))
+
+    (ly:parser-define! parser 'output-count (1+ count))
+    (ly:book-process book paper layout base)
     ))
 
-(define-public (collect-music-for-book parser music)
-  (collect-scores-for-book parser (ly:music-scorify music parser)))
+(define-public (print-score-with-defaults parser score)
+  (let*
+      ((paper (ly:parser-lookup parser '$defaultpaper))
+       (layout (ly:parser-lookup parser '$defaultlayout))
+       (header (ly:parser-lookup parser '$defaultheader))
+       (count (ly:parser-lookup parser 'output-count))
+       (base (ly:parser-output-name parser)))
+
+    (if (not (integer? count))
+       (set! count 0))
+
+    (if (> count 0)
+       (set! base (format #f "~a-~a" base count)))
+
+    (ly:parser-define! parser 'output-count (1+ count))
+    (ly:score-process score header paper layout base)
+    ))
 
 
-  
 ;;;;;;;;;;;;;;;;
-; alist
+;; alist
 (define-public assoc-get ly:assoc-get)
 
 (define-public (uniqued-alist alist acc)
@@ -111,63 +160,72 @@ found."
   (if (null?  list)
       '()
       (cons (cons  (caar list) (func (cdar list)))
-           (map-alist-vals func (cdr list)))
-      ))
+           (map-alist-vals func (cdr list)))))
 
 (define (map-alist-keys func list)
   "map FUNC over the keys of an alist LIST, leaving the vals. "
   (if (null?  list)
       '()
       (cons (cons (func (caar list)) (cdar list))
-           (map-alist-keys func (cdr list)))
-      ))
+           (map-alist-keys func (cdr list)))))
+
+(define-public (first-member members lst)
+  "Return first successful MEMBER of member from MEMBERS in LST."
+  (if (null? members)
+      #f
+      (let ((m (member (car members) lst)))
+       (if m m (first-member (cdr members) lst)))))
+
+(define-public (first-assoc keys lst)
+  "Return first successful ASSOC of key from KEYS in LST."
+  (if (null? keys)
+      #f
+      (let ((k (assoc (car keys) lst)))
+       (if k k (first-assoc (cdr keys) lst)))))
+
+(define-public (flatten-alist alist)
+  (if (null? alist)
+      '()
+      (cons (caar alist)
+           (cons (cdar alist)
+                 (flatten-alist (cdr alist))))))
+
 ;;;;;;;;;;;;;;;;
 ;; vector
 (define-public (vector-for-each proc vec)
   (do
       ((i 0 (1+ i)))
       ((>= i (vector-length vec)) vec)
-    
-    (vector-set! vec i
-                (proc (vector-ref vec i)))))
+    (vector-set! vec i (proc (vector-ref vec i)))))
 
 ;;;;;;;;;;;;;;;;
 ;; hash
 
-(if (not (defined? 'hash-table?))      ; guile 1.6 compat
+(if (not (defined? 'hash-table?)) ;; guile 1.6 compat
     (begin
       (define hash-table? vector?)
-
+      (define-public (hash-for-each proc tab)
+       (hash-fold (lambda (k v prior)
+                    (proc k v)
+                    #f)
+                  #f
+                  tab))
       (define-public (hash-table->alist t)
        "Convert table t to list"
-       (apply append
-              (vector->list t)
-              )))
+       (apply append (vector->list t))))
 
     ;; native hashtabs.
     (begin
       (define-public (hash-table->alist t)
-
        (hash-fold (lambda (k v acc) (acons  k v  acc))
-                  '() t)
-       )
-      ))
+                  '() t))))
 
 ;; todo: code dup with C++. 
-(define-public (alist->hash-table l)
+(define-safe-public (alist->hash-table lst)
   "Convert alist to table"
-  (let
-      ((m (make-hash-table (length l))))
-
-    (map (lambda (k-v)
-          (hashq-set! m (car k-v) (cdr k-v)))
-        l)
-
+  (let ((m (make-hash-table (length lst))))
+    (map (lambda (k-v) (hashq-set! m (car k-v) (cdr k-v))) lst)
     m))
-       
-
-
 
 ;;;;;;;;;;;;;;;;
 ; list
@@ -178,114 +236,159 @@ found."
       '()
       (if (pair? (car lst))
          (append (flatten-list (car lst)) (flatten-list  (cdr lst)))
-         (cons (car lst) (flatten-list (cdr lst))))
-  ))
+         (cons (car lst) (flatten-list (cdr lst))))))
 
 (define (list-minus a b)
   "Return list of elements in A that are not in B."
   (lset-difference eq? a b))
 
-
 ;; TODO: use the srfi-1 partition function.
-(define-public (uniq-list l)
+(define-public (uniq-list lst)
   
-  "Uniq LIST, assuming that it is sorted"
-  (define (helper acc l) 
-    (if (null? l)
+  "Uniq LST, assuming that it is sorted"
+  (define (helper acc lst
+    (if (null? lst)
        acc
-       (if (null? (cdr l))
-           (cons (car l) acc)
-           (if (equal? (car l) (cadr l))
-               (helper acc (cdr l))
-               (helper (cons (car l) acc)  (cdr l)))
-           )))
-  (reverse! (helper '() l) '()))
+       (if (null? (cdr lst))
+           (cons (car lst) acc)
+           (if (equal? (car lst) (cadr lst))
+               (helper acc (cdr lst))
+               (helper (cons (car lst) acc)  (cdr lst))))))
+  (reverse! (helper '() lst) '()))
+
+(define (split-at-predicate predicate lst)
+ "Split LST = (a_1 a_2 ... a_k b_1 ... b_k)
+  into L1 = (a_1 ... a_k ) and L2 =(b_1 .. b_k) 
+  Such that (PREDICATE a_i a_{i+1}) and not (PREDICATE a_k b_1).
+  L1 is copied, L2 not.
+
+  (split-at-predicate (lambda (x y) (= (- y x) 2)) '(1 3 5 9 11) (cons '() '()))"
+ ;; " Emacs is broken
+
+ (define (inner-split predicate lst acc)
+   (cond
+    ((null? lst) acc)
+    ((null? (cdr lst))
+     (set-car! acc (cons (car lst) (car acc)))
+     acc)
+    ((predicate (car lst) (cadr lst))
+     (set-car! acc (cons (car lst) (car acc)))
+     (inner-split predicate (cdr lst) acc))
+    (else
+     (set-car! acc (cons (car lst) (car acc)))
+     (set-cdr! acc (cdr lst))
+     acc)))
+ (let* ((c (cons '() '())))
+   (inner-split predicate lst  c)
+   (set-car! c (reverse! (car c)))
+   c))
+
+(define-public (split-list lst sep?)
+   "(display (split-list '(a b c / d e f / g) (lambda (x) (equal? x '/))))
+   =>
+   ((a b c) (d e f) (g))
+  "
+   ;; " Emacs is broken
+   (define (split-one sep?  lst acc)
+     "Split off the first parts before separator and return both parts."
+     (if (null? lst)
+        (cons acc '())
+        (if (sep? (car lst))
+            (cons acc (cdr lst))
+            (split-one sep? (cdr lst) (cons (car lst) acc)))))
+   
+   (if (null? lst)
+       '()
+       (let* ((c (split-one sep? lst '())))
+        (cons (reverse! (car c) '()) (split-list (cdr c) sep?)))))
 
+(define-public (offset-add a b)
+  (cons (+ (car a) (car b))
+       (+ (cdr a) (cdr b)))) 
 
-(define (split-at-predicate predicate l)
- "Split L = (a_1 a_2 ... a_k b_1 ... b_k)
-into L1 = (a_1 ... a_k ) and L2 =(b_1 .. b_k) 
-Such that (PREDICATE a_i a_{i+1}) and not (PREDICATE a_k b_1).
-L1 is copied, L2 not.
+(define-public (offset-flip-y o)
+  (cons (car o) (- (cdr o))))
 
-(split-at-predicate (lambda (x y) (= (- y x) 2))  '(1 3 5 9 11) (cons '() '()))"
-;; "
+(define-public (offset-scale o scale)
+  (cons (* (car o) scale)
+       (* (cdr o) scale)))
 
-;; KUT EMACS MODE.
+(define-public (ly:list->offsets accum coords)
+  (if (null? coords)
+      accum
+      (cons (cons (car coords) (cadr coords))
+           (ly:list->offsets accum (cddr coords)))))
 
-  (define (inner-split predicate l acc)
-  (cond
-   ((null? l) acc)
-   ((null? (cdr l))
-    (set-car! acc (cons (car l) (car acc)))
-    acc)
-   ((predicate (car l) (cadr l))
-    (set-car! acc (cons (car l) (car acc)))
-    (inner-split predicate (cdr l) acc))
-   (else
-    (set-car! acc (cons (car l) (car acc)))
-    (set-cdr! acc (cdr l))
-    acc)
-
-  ))
- (let*
-    ((c (cons '() '()))
-     )
-  (inner-split predicate l  c)
-  (set-car! c (reverse! (car c))) 
-  c)
-)
-
-
-(define-public (split-list l sep?)
-"
-(display (split-list '(a b c / d e f / g) (lambda (x) (equal? x '/))) )
-=>
-((a b c) (d e f) (g))
-
-"
-;; " KUT EMACS.
-
-(define (split-one sep?  l acc)
-  "Split off the first parts before separator and return both parts."
-  (if (null? l)
-      (cons acc '())
-      (if (sep? (car l))
-         (cons acc (cdr l))
-         (split-one sep? (cdr l) (cons (car l) acc))
-         )
-      ))
-
-(if (null? l)
-    '()
-    (let* ((c (split-one sep? l '())))
-      (cons (reverse! (car c) '()) (split-list (cdr c) sep?))
-      )))
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; numbers
 
+(if (not (defined? 'nan?)) ;; guile 1.6 compat
+    (define-public (nan? x) (not (or (< 0.0 x)
+                                    (> 0.0 x)
+                                    (= 0.0 x)))))
 
-(define-public (offset-add a b)
-  (cons (+ (car a) (car b))
-       (+ (cdr a) (cdr b)))) 
+(if (not (defined? 'inf?))
+    (define-public (inf? x) (= (/ 1.0 x) 0.0)))
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; intervals
 
 (define-public (interval-length x)
   "Length of the number-pair X, when an interval"
-  (max 0 (- (cdr x) (car x)))
-  )
+  (max 0 (- (cdr x) (car x))))
+
 (define-public interval-start car)
+(define-public (ordered-cons a b)
+  (cons (min a b)
+       (max a b)))
+
 (define-public interval-end cdr)
 
+(define-public (interval-index interval dir)
+  "Interpolate INTERVAL between between left (DIR=-1) and right (DIR=+1)"
+  
+  (* (+  (interval-start interval) (interval-end interval)
+        (* dir (- (interval-end interval) (interval-start interval))))
+     0.5))
+
+(define-public (interval-center x)
+  "Center the number-pair X, when an interval"
+  (if (interval-empty? x)
+      0.0
+      (/ (+ (car x) (cdr x)) 2)))
+
+(define-public interval-start car)
+(define-public interval-end cdr)
+(define-public (interval-translate iv amount)
+  (cons (+ amount (car iv))
+       (+ amount (cdr iv))))
+
 (define (other-axis a)
   (remainder (+ a 1) 2))
-  
 
 (define-public (interval-widen iv amount)
    (cons (- (car iv) amount)
          (+ (cdr iv) amount)))
 
+
+(define-public (interval-empty? iv)
+   (> (car iv) (cdr iv)))
+
 (define-public (interval-union i1 i2)
    (cons (min (car i1) (car i2))
         (max (cdr i1) (cdr i2))))
 
+(define-public (interval-sane? i)
+  (not (or  (nan? (car i))
+           (inf? (car i))
+           (nan? (cdr i))
+           (inf? (cdr i)))))
+
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+
 
 (define-public (write-me message x)
   "Return X.  Display MESSAGE and write X.  Handy for debugging,
@@ -293,6 +396,14 @@ possibly turned off."
   (display message) (write x) (newline) x)
 ;;  x)
 
+(define-public (stderr string . rest)
+  (apply format (cons (current-error-port) (cons string rest)))
+  (force-output (current-error-port)))
+
+(define-public (debugf string . rest)
+  (if #f
+      (apply stderr (cons string rest))))
+
 (define (index-cell cell dir)
   (if (equal? dir 1)
       (cdr cell)
@@ -302,16 +413,37 @@ possibly turned off."
   "map F to contents of X"
   (cons (f (car x)) (f (cdr x))))
 
-
 (define-public (list-insert-separator lst between)
   "Create new list, inserting BETWEEN between elements of LIST"
   (define (conc x y )
     (if (eq? y #f)
        (list x)
-       (cons x  (cons between y))
-       ))
+       (cons x  (cons between y))))
   (fold-right conc #f lst))
 
+(define-public (string-regexp-substitute a b str)
+  (regexp-substitute/global #f a str 'pre b 'post)) 
+
+(define (regexp-split str regex)
+  (define matches '())
+  (define end-of-prev-match 0)
+  (define (notice match)
+
+    (set! matches (cons (substring (match:string match)
+                                  end-of-prev-match
+                                  (match:start match))
+                       matches))
+    (set! end-of-prev-match (match:end match)))
+
+  (regexp-substitute/global #f regex str notice 'post)
+
+  (if (< end-of-prev-match (string-length str))
+      (set!
+       matches
+       (cons (substring str end-of-prev-match (string-length str)) matches)))
+
+   (reverse matches))
+
 ;;;;;;;;;;;;;;;;
 ; other
 (define (sign x)
@@ -319,47 +451,67 @@ possibly turned off."
       0
       (if (< x 0) -1 1)))
 
-(define-public (symbol<? l r)
-  (string<? (symbol->string l) (symbol->string r)))
+(define-public (symbol<? lst r)
+  (string<? (symbol->string lst) (symbol->string r)))
+
+(define-public (symbol-key<? lst r)
+  (string<? (symbol->string (car lst)) (symbol->string (car r))))
 
-(define-public (!= l r)
-  (not (= l r)))
+;;
+;; don't confuse users with #<procedure .. > syntax. 
+;; 
+(define-public (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-public (!= lst r)
+  (not (= lst r)))
 
-(define-public scale-to-unit
+(define-public lily-unit->bigpoint-factor
   (cond
    ((equal? (ly:unit) "mm") (/ 72.0 25.4))
    ((equal? (ly:unit) "pt") (/ 72.0 72.27))
-   (else (error "unknown unit" (ly:unit)))))
-
-;;; font
-(define-public (font-family font)
-  (let ((name (ly:font-name font)))
-    (if name
-       (regexp-substitute/global #f "^GNU-(.*)-[.0-9]*$" name 'pre 1 'post)
-       (begin
-         ;;(stderr "font-name: ~S\n" (ly:font-name font))
-         ;;(stderr "font-file-name: ~S\n" (ly:font-file-name font))
-         (ly:font-file-name font)))))
-
-(define-public (char->unicode-index font char)
-  ;;  (format (current-error-port) "UNICODE:~S:~S:~S\n"
-  ;;   font (ly:font-encoding font) (char->integer char))
-  ;; (force-output (current-error-port))
-  (+ (case (ly:font-encoding font)
-       ((fetaMusic) (- #xe000 #x20))
-       ((fetaBraces) (- #xe000 #x40))
-       ((fetaBraces) (- #xe000 #x40))
-       ;;(else 0))
-       ;; FIXME: bigcheese says FontSpecific
-       (else (if (string=? (font-family font) "bigcheese20")
-                ;;#xf000 0)))
-                ;; FIXME: hmm, why does name_to_index not return actual
-                ;; unicode mapping?
-
-                ;; ugh, we must know which font from bigcheese;
-                ;; feta-proper starts at 0xefc
-                ;; but we cannot display feta-nummer or feta-din characters
-                ;; this way
-                #xe0fc 0)))
-     (char->integer char)))
+   (else (ly:error (_ "unknown unit: ~S") (ly:unit)))))
+
+(define-public lily-unit->mm-factor
+  (* 25.4 (/ lily-unit->bigpoint-factor 72)))
+
+;;; FONT may be font smob, or pango font string...
+(define-public (font-name-style font)
+      ;; FIXME: ughr, (ly:font-name) sometimes also has Style appended.
+      (let* ((font-name (ly:font-name font))
+            (full-name (if font-name font-name (ly:font-file-name font)))
+            (name-style (string-split full-name #\-)))
+       ;; FIXME: ughr, barf: feta-alphabet is actually emmentaler
+       (if (string-prefix? "feta-alphabet" full-name)
+           (list "emmentaler"
+                 (substring  full-name (string-length "feta-alphabet")))
+           (if (not (null? (cdr name-style)))
+           name-style
+           (append name-style '("Regular"))))))
+
+(define-public (modified-font-metric-font-scaling font)
+  (let* ((designsize (ly:font-design-size font))
+        (magnification (* (ly:font-magnification font)))
+        (scaling (* magnification designsize)))
+    (debugf "scaling:~S\n" scaling)
+    (debugf "magnification:~S\n" magnification)
+    (debugf "design:~S\n" designsize)
+    scaling))
+
+(define-public (version-not-seen-message input-file-name)
+  (ly:message
+   (string-append
+    input-file-name ": 0: " (_ "warning: ")
+   (format #f
+          (_ "no \\version statement found, please add~afor future compatibility")
+          (format #f "\n\n\\version ~s\n\n" (lilypond-version))))))
+
+(define-public (old-relative-not-used-message input-file-name)
+  (ly:message
+   (string-append
+    input-file-name ": 0: " (_ "warning: ")
+    (_ "old relative compatibility not used"))))