2 ;;;; lily-library.scm -- utilities
4 ;;;; source file of the GNU LilyPond music typesetter
6 ;;;; (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
7 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
9 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
14 (define-safe-public START -1)
15 (define-safe-public STOP 1)
16 (define-public LEFT -1)
17 (define-public RIGHT 1)
19 (define-public DOWN -1)
20 (define-public CENTER 0)
22 (define-safe-public DOUBLE-FLAT-QTS -4)
23 (define-safe-public THREE-Q-FLAT-QTS -3)
24 (define-safe-public FLAT-QTS -2)
25 (define-safe-public SEMI-FLAT-QTS -1)
26 (define-safe-public NATURAL-QTS 0)
27 (define-safe-public SEMI-SHARP-QTS 1)
28 (define-safe-public SHARP-QTS 2)
29 (define-safe-public THREE-Q-SHARP-QTS 3)
30 (define-safe-public DOUBLE-SHARP-QTS 4)
31 (define-safe-public SEMI-TONE-QTS 2)
33 (define-safe-public DOUBLE-FLAT -1)
34 (define-safe-public THREE-Q-FLAT -3/4)
35 (define-safe-public FLAT -1/2)
36 (define-safe-public SEMI-FLAT -1/4)
37 (define-safe-public NATURAL 0)
38 (define-safe-public SEMI-SHARP 1/4)
39 (define-safe-public SHARP 1/2)
40 (define-safe-public THREE-Q-SHARP 3/4)
41 (define-safe-public DOUBLE-SHARP 1)
42 (define-safe-public SEMI-TONE 1/2)
44 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
47 (define-public ZERO-MOMENT (ly:make-moment 0 1))
49 (define-public (moment-min a b)
50 (if (ly:moment<? a b) a b))
53 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
55 (define-public (average x . lst)
56 (/ (+ x (apply + lst)) (1+ (length lst))))
58 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
59 ;; lily specific variables.
61 (define-public default-script-alist '())
64 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
65 ;; parser <-> output hooks.
68 (define-public (print-music-as-book parser music)
69 (let* ((head (ly:parser-lookup parser '$defaultheader))
70 (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
71 head (scorify-music music parser))))
72 (print-book-with-defaults parser book)))
74 (define-public (print-score-as-book parser score)
75 (let* ((head (ly:parser-lookup parser '$defaultheader))
76 (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
78 (print-book-with-defaults parser book)))
80 (define-public (print-score parser score)
81 (let* ((head (ly:parser-lookup parser '$defaultheader))
82 (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
84 (ly:parser-print-score parser book)))
86 (define-public (collect-scores-for-book parser score)
88 parser 'toplevel-scores
89 (cons score (ly:parser-lookup parser 'toplevel-scores))))
91 (define-public (scorify-music music parser)
93 (for-each (lambda (func)
94 (set! music (func music parser)))
95 toplevel-music-functions)
97 (ly:make-score music))
99 (define-public (collect-music-for-book parser music)
100 ;; discard music if its 'void property is true.
101 (let ((void-music (ly:music-property music 'void)))
102 (if (or (null? void-music) (not void-music))
103 (collect-scores-for-book parser (scorify-music music parser)))))
106 (define-public (print-book-with-defaults parser book)
108 ((paper (ly:parser-lookup parser '$defaultpaper))
109 (layout (ly:parser-lookup parser '$defaultlayout))
110 (count (ly:parser-lookup parser 'output-count))
111 (base (ly:parser-output-name parser)))
113 (if (not (integer? count))
117 (set! base (format #f "~a-~a" base count)))
119 (ly:parser-define! parser 'output-count (1+ count))
120 (ly:book-process book paper layout base)
123 (define-public (print-score-with-defaults parser score)
125 ((paper (ly:parser-lookup parser '$defaultpaper))
126 (count (ly:parser-lookup parser 'output-count))
127 (base (ly:parser-output-name parser)))
129 (if (not (integer? count))
133 (set! base (format #f "~a-~a" base count)))
135 (ly:parser-define! parser 'output-count (1+ count))
137 (if (not (ly:score-error? score))
139 ((header (ly:score-header score))
140 (output-defs (ly:score-output-defs score))
141 (layout-defs (filter (lambda (d) (eq? #t (ly:output-def-lookup d 'is-layout)))
143 (midi-defs (filter (lambda (d) (eq? #t (ly:output-def-lookup d 'is-midi)))
145 (music (ly:score-music score))
146 (layout-def (if (null? layout-defs)
148 (ly:parser-lookup parser '$defaultlayout))))
150 (if (not (module? header))
151 (set! header (ly:parser-lookup parser '$defaultheader)))
153 (ly:render-music-as-systems
154 music layout-def paper header base)
156 (if (pair? midi-defs)
157 (ly:performance-write (ly:format-output (ly:run-translator music (car midi-defs)))
158 (format #f "~a.midi" base)
170 (define-public assoc-get ly:assoc-get)
172 (define-public (uniqued-alist alist acc)
173 (if (null? alist) acc
174 (if (assoc (caar alist) acc)
175 (uniqued-alist (cdr alist) acc)
176 (uniqued-alist (cdr alist) (cons (car alist) acc)))))
178 (define-public (alist<? x y)
179 (string<? (symbol->string (car x))
180 (symbol->string (car y))))
182 (define-public (chain-assoc x alist-list)
183 (if (null? alist-list)
185 (let* ((handle (assoc x (car alist-list))))
188 (chain-assoc x (cdr alist-list))))))
190 (define-public (chain-assoc-get x alist-list . default)
191 "Return ALIST entry for X. Return DEFAULT (optional, else #f) if not
194 (define (helper x alist-list default)
195 (if (null? alist-list)
197 (let* ((handle (assoc x (car alist-list))))
200 (helper x (cdr alist-list) default)))))
203 (if (pair? default) (car default) #f)))
205 (define (map-alist-vals func list)
206 "map FUNC over the vals of LIST, leaving the keys."
209 (cons (cons (caar list) (func (cdar list)))
210 (map-alist-vals func (cdr list)))))
212 (define (map-alist-keys func list)
213 "map FUNC over the keys of an alist LIST, leaving the vals. "
216 (cons (cons (func (caar list)) (cdar list))
217 (map-alist-keys func (cdr list)))))
219 (define-public (first-member members lst)
220 "Return first successful MEMBER of member from MEMBERS in LST."
223 (let ((m (member (car members) lst)))
224 (if m m (first-member (cdr members) lst)))))
226 (define-public (first-assoc keys lst)
227 "Return first successful ASSOC of key from KEYS in LST."
230 (let ((k (assoc (car keys) lst)))
231 (if k k (first-assoc (cdr keys) lst)))))
233 (define-public (flatten-alist alist)
238 (flatten-alist (cdr alist))))))
243 (define-public (vector-for-each proc vec)
246 ((>= i (vector-length vec)) vec)
247 (vector-set! vec i (proc (vector-ref vec i)))))
252 (if (not (defined? 'hash-table?)) ;; guile 1.6 compat
254 (define hash-table? vector?)
255 (define-public (hash-for-each proc tab)
256 (hash-fold (lambda (k v prior)
261 (define-public (hash-table->alist t)
262 "Convert table t to list"
263 (apply append (vector->list t))))
267 (define-public (hash-table->alist t)
268 (hash-fold (lambda (k v acc) (acons k v acc))
271 ;; todo: code dup with C++.
272 (define-safe-public (alist->hash-table lst)
273 "Convert alist to table"
274 (let ((m (make-hash-table (length lst))))
275 (map (lambda (k-v) (hashq-set! m (car k-v) (cdr k-v))) lst)
281 (define (functional-or . rest)
284 (apply functional-and (cdr rest)))
287 (define (functional-and . rest)
290 (apply functional-and (cdr rest)))
293 (define (split-list lst n)
294 "Split LST in N equal sized parts"
296 (define (helper todo acc-vector k)
303 (vector-set! acc-vector k (cons (car todo) (vector-ref acc-vector k)))
304 (helper (cdr todo) acc-vector (1- k)))))
306 (helper lst (make-vector n '()) (1- n)))
308 (define (list-element-index lst x)
309 (define (helper todo k)
312 ((equal? (car todo) x) k)
314 (helper (cdr todo) (1+ k)))))
318 (define-public (count-list lst)
319 "Given lst (E1 E2 .. ) return ((E1 . 1) (E2 . 2) ... ) "
321 (define (helper l acc count)
323 (helper (cdr l) (cons (cons (car l) count) acc) (1+ count))
327 (reverse (helper lst '() 1)))
329 (define-public (list-join lst intermediate)
330 "put INTERMEDIATE between all elts of LST."
335 (cons elem (cons intermediate prev))
339 (define-public (filtered-map proc lst)
345 (define (flatten-list lst)
349 (if (pair? (car lst))
350 (append (flatten-list (car lst)) (flatten-list (cdr lst)))
351 (cons (car lst) (flatten-list (cdr lst))))))
353 (define (list-minus a b)
354 "Return list of elements in A that are not in B."
355 (lset-difference eq? a b))
357 (define-public (uniq-list lst)
358 "Uniq LST, assuming that it is sorted"
361 (fold (lambda (x acc)
364 (if (eq? x (car acc))
369 (define (split-at-predicate predicate lst)
370 "Split LST = (a_1 a_2 ... a_k b_1 ... b_k)
371 into L1 = (a_1 ... a_k ) and L2 =(b_1 .. b_k)
372 Such that (PREDICATE a_i a_{i+1}) and not (PREDICATE a_k b_1).
373 L1 is copied, L2 not.
375 (split-at-predicate (lambda (x y) (= (- y x) 2)) '(1 3 5 9 11) (cons '() '()))"
379 (define (inner-split predicate lst acc)
383 (set-car! acc (cons (car lst) (car acc)))
385 ((predicate (car lst) (cadr lst))
386 (set-car! acc (cons (car lst) (car acc)))
387 (inner-split predicate (cdr lst) acc))
389 (set-car! acc (cons (car lst) (car acc)))
390 (set-cdr! acc (cdr lst))
393 (let* ((c (cons '() '())))
394 (inner-split predicate lst c)
395 (set-car! c (reverse! (car c)))
398 (define-public (split-list-by-separator lst sep?)
399 "(display (split-list-by-separator '(a b c / d e f / g) (lambda (x) (equal? x '/))))
401 ((a b c) (d e f) (g))
404 (define (split-one sep? lst acc)
405 "Split off the first parts before separator and return both parts."
410 (split-one sep? (cdr lst) (cons (car lst) acc)))))
414 (let* ((c (split-one sep? lst '())))
415 (cons (reverse! (car c) '()) (split-list-by-separator (cdr c) sep?)))))
417 (define-public (offset-add a b)
418 (cons (+ (car a) (car b))
419 (+ (cdr a) (cdr b))))
421 (define-public (offset-flip-y o)
422 (cons (car o) (- (cdr o))))
424 (define-public (offset-scale o scale)
425 (cons (* (car o) scale)
428 (define-public (ly:list->offsets accum coords)
431 (cons (cons (car coords) (cadr coords))
432 (ly:list->offsets accum (cddr coords)))))
434 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
437 (if (not (defined? 'nan?)) ;; guile 1.6 compat
438 (define-public (nan? x) (not (or (< 0.0 x)
442 (if (not (defined? 'inf?))
443 (define-public (inf? x) (= (/ 1.0 x) 0.0)))
445 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
448 (define-public (interval-length x)
449 "Length of the number-pair X, when an interval"
450 (max 0 (- (cdr x) (car x))))
452 (define-public interval-start car)
453 (define-public (ordered-cons a b)
457 (define-public interval-end cdr)
459 (define-public (interval-index interval dir)
460 "Interpolate INTERVAL between between left (DIR=-1) and right (DIR=+1)"
462 (* (+ (interval-start interval) (interval-end interval)
463 (* dir (- (interval-end interval) (interval-start interval))))
466 (define-public (interval-center x)
467 "Center the number-pair X, when an interval"
468 (if (interval-empty? x)
470 (/ (+ (car x) (cdr x)) 2)))
472 (define-public interval-start car)
473 (define-public interval-end cdr)
474 (define-public (interval-translate iv amount)
475 (cons (+ amount (car iv))
476 (+ amount (cdr iv))))
478 (define (other-axis a)
479 (remainder (+ a 1) 2))
481 (define-public (interval-widen iv amount)
482 (cons (- (car iv) amount)
483 (+ (cdr iv) amount)))
486 (define-public (interval-empty? iv)
487 (> (car iv) (cdr iv)))
489 (define-public (interval-union i1 i2)
490 (cons (min (car i1) (car i2))
491 (max (cdr i1) (cdr i2))))
493 (define-public (interval-sane? i)
494 (not (or (nan? (car i))
498 (> (car i) (cdr i)))))
501 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
505 (define-public (string-encode-integer i)
508 ((< i 0) (string-append "n" (string-encode-integer (- i))))
510 (make-string 1 (integer->char (+ 65 (modulo i 26))))
511 (string-encode-integer (quotient i 26))))))
513 (define-public (ly:numbers->string lst)
514 (string-join (map ly:number->string lst) " "))
516 (define (number->octal-string x)
517 (let* ((n (inexact->exact x))
518 (n64 (quotient n 64))
519 (n8 (quotient (- n (* n64 64)) 8)))
523 (number->string (remainder (- n (+ (* n64 64) (* n8 8))) 8)))))
525 (define-public (ly:inexact->string x radix)
526 (let ((n (inexact->exact x)))
527 (number->string n radix)))
529 (define-public (ly:number-pair->string c)
530 (string-append (ly:number->string (car c)) " "
531 (ly:number->string (cdr c))))
534 (define-public (write-me message x)
535 "Return X. Display MESSAGE and write X. Handy for debugging,
536 possibly turned off."
537 (display message) (write x) (newline) x)
540 (define-public (stderr string . rest)
541 (apply format (cons (current-error-port) (cons string rest)))
542 (force-output (current-error-port)))
544 (define-public (debugf string . rest)
546 (apply stderr (cons string rest))))
548 (define (index-cell cell dir)
553 (define (cons-map f x)
554 "map F to contents of X"
555 (cons (f (car x)) (f (cdr x))))
557 (define-public (list-insert-separator lst between)
558 "Create new list, inserting BETWEEN between elements of LIST"
562 (cons x (cons between y))))
563 (fold-right conc #f lst))
565 (define-public (string-regexp-substitute a b str)
566 (regexp-substitute/global #f a str 'pre b 'post))
568 (define (regexp-split str regex)
570 (define end-of-prev-match 0)
571 (define (notice match)
573 (set! matches (cons (substring (match:string match)
577 (set! end-of-prev-match (match:end match)))
579 (regexp-substitute/global #f regex str notice 'post)
581 (if (< end-of-prev-match (string-length str))
584 (cons (substring str end-of-prev-match (string-length str)) matches)))
595 (define-public (car< a b) (< (car a) (car b)))
597 (define-public (symbol<? lst r)
598 (string<? (symbol->string lst) (symbol->string r)))
600 (define-public (symbol-key<? lst r)
601 (string<? (symbol->string (car lst)) (symbol->string (car r))))
604 ;; don't confuse users with #<procedure .. > syntax.
606 (define-public (scm->string val)
607 (if (and (procedure? val) (symbol? (procedure-name val)))
608 (symbol->string (procedure-name val))
610 (if (self-evaluating? val) "" "'")
611 (call-with-output-string (lambda (port) (display val port))))))
613 (define-public (!= lst r)
616 (define-public lily-unit->bigpoint-factor
618 ((equal? (ly:unit) "mm") (/ 72.0 25.4))
619 ((equal? (ly:unit) "pt") (/ 72.0 72.27))
620 (else (ly:error (_ "unknown unit: ~S") (ly:unit)))))
622 (define-public lily-unit->mm-factor
623 (* 25.4 (/ lily-unit->bigpoint-factor 72)))
625 ;;; FONT may be font smob, or pango font string...
626 (define-public (font-name-style font)
627 ;; FIXME: ughr, (ly:font-name) sometimes also has Style appended.
628 (let* ((font-name (ly:font-name font))
629 (full-name (if font-name font-name (ly:font-file-name font)))
630 (name-style (string-split full-name #\-)))
631 ;; FIXME: ughr, barf: feta-alphabet is actually emmentaler
632 (if (string-prefix? "feta-alphabet" full-name)
634 (substring full-name (string-length "feta-alphabet")))
635 (if (not (null? (cdr name-style)))
637 (append name-style '("Regular"))))))
639 (define-public (modified-font-metric-font-scaling font)
640 (let* ((designsize (ly:font-design-size font))
641 (magnification (* (ly:font-magnification font)))
642 (scaling (* magnification designsize)))
643 (debugf "scaling:~S\n" scaling)
644 (debugf "magnification:~S\n" magnification)
645 (debugf "design:~S\n" designsize)
648 (define-public (version-not-seen-message input-file-name)
651 input-file-name ": 0: " (_ "warning: ")
653 (_ "no \\version statement found, please add~afor future compatibility")
654 (format #f "\n\n\\version ~s\n\n" (lilypond-version))))))
656 (define-public (old-relative-not-used-message input-file-name)
659 input-file-name ": 0: " (_ "warning: ")
660 (_ "old relative compatibility not used"))))