2 ;;;; lily-library.scm -- utilities
4 ;;;; source file of the GNU LilyPond music typesetter
6 ;;;; (c) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
7 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
9 ; for take, drop, take-while, list-index, and find-tail:
10 (use-modules (srfi srfi-1))
12 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
17 (define-safe-public START -1)
18 (define-safe-public STOP 1)
19 (define-public LEFT -1)
20 (define-public RIGHT 1)
22 (define-public DOWN -1)
23 (define-public CENTER 0)
25 (define-safe-public DOUBLE-FLAT-QTS -4)
26 (define-safe-public THREE-Q-FLAT-QTS -3)
27 (define-safe-public FLAT-QTS -2)
28 (define-safe-public SEMI-FLAT-QTS -1)
29 (define-safe-public NATURAL-QTS 0)
30 (define-safe-public SEMI-SHARP-QTS 1)
31 (define-safe-public SHARP-QTS 2)
32 (define-safe-public THREE-Q-SHARP-QTS 3)
33 (define-safe-public DOUBLE-SHARP-QTS 4)
34 (define-safe-public SEMI-TONE-QTS 2)
36 (define-safe-public DOUBLE-FLAT -1)
37 (define-safe-public THREE-Q-FLAT -3/4)
38 (define-safe-public FLAT -1/2)
39 (define-safe-public SEMI-FLAT -1/4)
40 (define-safe-public NATURAL 0)
41 (define-safe-public SEMI-SHARP 1/4)
42 (define-safe-public SHARP 1/2)
43 (define-safe-public THREE-Q-SHARP 3/4)
44 (define-safe-public DOUBLE-SHARP 1)
45 (define-safe-public SEMI-TONE 1/2)
47 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
50 (define-public ZERO-MOMENT (ly:make-moment 0 1))
52 (define-public (moment-min a b)
53 (if (ly:moment<? a b) a b))
55 (define-public (moment<=? a b)
59 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
61 (define-public (average x . lst)
62 (/ (+ x (apply + lst)) (1+ (length lst))))
64 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
65 ;; parser <-> output hooks.
67 (define-public (collect-bookpart-for-book parser book-part)
68 "Toplevel book-part handler"
69 (define (add-bookpart book-part)
71 parser 'toplevel-bookparts
72 (cons book-part (ly:parser-lookup parser 'toplevel-bookparts))))
73 ;; If toplevel scores have been found before this \bookpart,
74 ;; add them first to a dedicated bookpart
75 (if (pair? (ly:parser-lookup parser 'toplevel-scores))
77 (add-bookpart (ly:make-book-part
78 (ly:parser-lookup parser 'toplevel-scores)))
79 (ly:parser-define! parser 'toplevel-scores (list))))
80 (add-bookpart book-part))
82 (define-public (collect-scores-for-book parser score)
84 parser 'toplevel-scores
85 (cons score (ly:parser-lookup parser 'toplevel-scores))))
87 (define-public (collect-music-aux score-handler parser music)
88 (define (music-property symbol)
89 (let ((value (ly:music-property music symbol)))
90 (if (not (null? value))
93 (cond ((music-property 'page-marker)
94 ;; a page marker: set page break/turn permissions or label
96 (let ((label (music-property 'page-label)))
98 (score-handler (ly:make-page-label-marker label))))
99 (for-each (lambda (symbol)
100 (let ((permission (music-property symbol)))
101 (if (symbol? permission)
103 (ly:make-page-permission-marker symbol
104 (if (eqv? 'forbid permission)
107 (list 'line-break-permission 'page-break-permission
108 'page-turn-permission))))
109 ((not (music-property 'void))
110 ;; a regular music expression: make a score with this music
111 ;; void music is discarded
112 (score-handler (scorify-music music parser)))))
114 (define-public (collect-music-for-book parser music)
115 "Top-level music handler"
116 (collect-music-aux (lambda (score)
117 (collect-scores-for-book parser score))
121 (define-public (collect-book-music-for-book parser book music)
123 (collect-music-aux (lambda (score)
124 (ly:book-add-score! book score))
128 (define-public (scorify-music music parser)
131 (for-each (lambda (func)
132 (set! music (func music parser)))
133 toplevel-music-functions)
135 (ly:make-score music))
138 (define (get-outfile-name parser base)
139 (let* ((output-suffix (ly:parser-lookup parser 'output-suffix))
140 (counter-alist (ly:parser-lookup parser 'counter-alist))
141 (output-count (assoc-get output-suffix counter-alist 0))
143 ;; Allow all ASCII alphanumerics, including accents
144 (if (string? output-suffix)
145 (set! result (format "~a-~a"
146 base (string-regexp-substitute
147 "[^-[:alnum:]]" "_" output-suffix))))
149 ;; assoc-get call will always have returned a number
150 (if (> output-count 0)
151 (set! result (format #f "~a-~a" result output-count)))
154 parser 'counter-alist
155 (assoc-set! counter-alist output-suffix (1+ output-count)))
158 (define (print-book-with parser book process-procedure)
159 (let* ((paper (ly:parser-lookup parser '$defaultpaper))
160 (layout (ly:parser-lookup parser '$defaultlayout))
161 (count (ly:parser-lookup parser 'output-count))
162 (base (ly:parser-output-name parser))
163 (outfile-name (get-outfile-name parser base)))
165 (process-procedure book paper layout outfile-name)))
167 (define-public (print-book-with-defaults parser book)
168 (print-book-with parser book ly:book-process))
170 (define-public (print-book-with-defaults-as-systems parser book)
171 (print-book-with parser book ly:book-process-to-systems))
176 (define-public assoc-get ly:assoc-get)
178 (define-public (uniqued-alist alist acc)
179 (if (null? alist) acc
180 (if (assoc (caar alist) acc)
181 (uniqued-alist (cdr alist) acc)
182 (uniqued-alist (cdr alist) (cons (car alist) acc)))))
184 (define-public (alist<? x y)
185 (string<? (symbol->string (car x))
186 (symbol->string (car y))))
188 (define-public (chain-assoc-get x alist-list . default)
189 "Return ALIST entry for X. Return DEFAULT (optional, else #f) if not
192 (define (helper x alist-list default)
193 (if (null? alist-list)
195 (let* ((handle (assoc x (car alist-list))))
198 (helper x (cdr alist-list) default)))))
201 (if (pair? default) (car default) #f)))
203 (define (map-alist-vals func list)
204 "map FUNC over the vals of LIST, leaving the keys."
207 (cons (cons (caar list) (func (cdar list)))
208 (map-alist-vals func (cdr list)))))
210 (define (map-alist-keys func list)
211 "map FUNC over the keys of an alist LIST, leaving the vals. "
214 (cons (cons (func (caar list)) (cdar list))
215 (map-alist-keys func (cdr list)))))
217 (define-public (first-member members lst)
218 "Return first successful MEMBER of member from MEMBERS in LST."
221 (let ((m (member (car members) lst)))
222 (if m m (first-member (cdr members) lst)))))
224 (define-public (first-assoc keys lst)
225 "Return first successful ASSOC of key from KEYS in LST."
228 (let ((k (assoc (car keys) lst)))
229 (if k k (first-assoc (cdr keys) lst)))))
231 (define-public (flatten-alist alist)
236 (flatten-alist (cdr alist))))))
241 (define-public (vector-for-each proc vec)
244 ((>= i (vector-length vec)) vec)
245 (vector-set! vec i (proc (vector-ref vec i)))))
250 (define-public (hash-table->alist t)
251 (hash-fold (lambda (k v acc) (acons k v acc))
254 ;; todo: code dup with C++.
255 (define-safe-public (alist->hash-table lst)
256 "Convert alist to table"
257 (let ((m (make-hash-table (length lst))))
258 (map (lambda (k-v) (hashq-set! m (car k-v) (cdr k-v))) lst)
264 (define (functional-or . rest)
267 (apply functional-and (cdr rest)))
270 (define (functional-and . rest)
273 (apply functional-and (cdr rest)))
276 (define (split-list lst n)
277 "Split LST in N equal sized parts"
279 (define (helper todo acc-vector k)
286 (vector-set! acc-vector k (cons (car todo) (vector-ref acc-vector k)))
287 (helper (cdr todo) acc-vector (1- k)))))
289 (helper lst (make-vector n '()) (1- n)))
291 (define (list-element-index lst x)
292 (define (helper todo k)
295 ((equal? (car todo) x) k)
297 (helper (cdr todo) (1+ k)))))
301 (define-public (count-list lst)
302 "Given lst (E1 E2 .. ) return ((E1 . 1) (E2 . 2) ... ) "
304 (define (helper l acc count)
306 (helper (cdr l) (cons (cons (car l) count) acc) (1+ count))
310 (reverse (helper lst '() 1)))
312 (define-public (list-join lst intermediate)
313 "put INTERMEDIATE between all elts of LST."
318 (cons elem (cons intermediate prev))
322 (define-public (filtered-map proc lst)
328 (define (flatten-list lst)
332 (if (pair? (car lst))
333 (append (flatten-list (car lst)) (flatten-list (cdr lst)))
334 (cons (car lst) (flatten-list (cdr lst))))))
336 (define (list-minus a b)
337 "Return list of elements in A that are not in B."
338 (lset-difference eq? a b))
340 (define-public (uniq-list lst)
341 "Uniq LST, assuming that it is sorted. Uses equal? for comparisons."
344 (fold (lambda (x acc)
347 (if (equal? x (car acc))
352 (define (split-at-predicate pred lst)
353 "Split LST into two lists at the first element that returns #f for
354 (PRED previous_element element). Return the two parts as a pair.
355 Example: (split-at-predicate < '(1 2 3 2 1)) ==> ((1 2 3) . (2 1))"
358 (let ((i (list-index pred (cdr lst) lst)))
360 (cons (take lst (1+ i)) (drop lst (1+ i)))
363 (define-public (split-list-by-separator lst pred)
364 "Split LST at each element that satisfies PRED, and return the parts
365 (with the separators removed) as a list of lists. Example:
366 (split-list-by-separator '(a 0 b c 1 d) number?) ==> ((a) (b c) (d))"
367 (let loop ((result '()) (lst lst))
368 (if (and lst (not (null? lst)))
371 (list (take-while (lambda (x) (not (pred x))) lst)))
372 (let ((tail (find-tail pred lst)))
373 (if tail (cdr tail) #f)))
376 (define-public (offset-add a b)
377 (cons (+ (car a) (car b))
378 (+ (cdr a) (cdr b))))
380 (define-public (offset-flip-y o)
381 (cons (car o) (- (cdr o))))
383 (define-public (offset-scale o scale)
384 (cons (* (car o) scale)
387 (define-public (ly:list->offsets accum coords)
390 (cons (cons (car coords) (cadr coords))
391 (ly:list->offsets accum (cddr coords)))))
393 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
396 (if (not (defined? 'nan?)) ;; guile 1.6 compat
397 (define-public (nan? x) (not (or (< 0.0 x)
401 (if (not (defined? 'inf?))
402 (define-public (inf? x) (= (/ 1.0 x) 0.0)))
404 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
407 (define-public empty-interval '(+inf.0 . -inf.0))
409 (define-public (symmetric-interval expr)
410 (cons (- expr) expr))
412 (define-public (interval-length x)
413 "Length of the number-pair X, when an interval"
414 (max 0 (- (cdr x) (car x))))
416 (define-public (ordered-cons a b)
420 (define-public (interval-bound interval dir)
421 ((if (= dir RIGHT) cdr car) interval))
423 (define-public (interval-index interval dir)
424 "Interpolate INTERVAL between between left (DIR=-1) and right (DIR=+1)"
426 (* (+ (interval-start interval) (interval-end interval)
427 (* dir (- (interval-end interval) (interval-start interval))))
430 (define-public (interval-center x)
431 "Center the number-pair X, when an interval"
432 (if (interval-empty? x)
434 (/ (+ (car x) (cdr x)) 2)))
436 (define-public interval-start car)
438 (define-public interval-end cdr)
440 (define-public (interval-translate iv amount)
441 (cons (+ amount (car iv))
442 (+ amount (cdr iv))))
444 (define (other-axis a)
445 (remainder (+ a 1) 2))
447 (define-public (interval-widen iv amount)
448 (cons (- (car iv) amount)
449 (+ (cdr iv) amount)))
451 (define-public (interval-empty? iv)
452 (> (car iv) (cdr iv)))
454 (define-public (interval-union i1 i2)
455 (cons (min (car i1) (car i2))
456 (max (cdr i1) (cdr i2))))
458 (define-public (interval-sane? i)
459 (not (or (nan? (car i))
463 (> (car i) (cdr i)))))
465 (define-public (add-point interval p)
466 (cons (min (interval-start interval) p)
467 (max (interval-end interval) p)))
469 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
472 (define-public (string-endswith s suffix)
473 (equal? suffix (substring s
474 (max 0 (- (string-length s) (string-length suffix)))
477 (define-public (string-startswith s prefix)
478 (equal? prefix (substring s 0 (min (string-length s) (string-length prefix)))))
480 (define-public (string-encode-integer i)
483 ((< i 0) (string-append "n" (string-encode-integer (- i))))
485 (make-string 1 (integer->char (+ 65 (modulo i 26))))
486 (string-encode-integer (quotient i 26))))))
488 (define (number->octal-string x)
489 (let* ((n (inexact->exact x))
490 (n64 (quotient n 64))
491 (n8 (quotient (- n (* n64 64)) 8)))
495 (number->string (remainder (- n (+ (* n64 64) (* n8 8))) 8)))))
497 (define-public (ly:inexact->string x radix)
498 (let ((n (inexact->exact x)))
499 (number->string n radix)))
501 (define-public (ly:number-pair->string c)
502 (string-append (ly:number->string (car c)) " "
503 (ly:number->string (cdr c))))
505 (define-public (dir-basename file . rest)
506 "Strip suffixes in REST, but leave directory component for FILE."
507 (define (inverse-basename x y) (basename y x))
508 (simple-format #f "~a/~a" (dirname file)
509 (fold inverse-basename file rest)))
511 (define-public (write-me message x)
512 "Return X. Display MESSAGE and write X. Handy for debugging,
513 possibly turned off."
514 (display message) (write x) (newline) x)
517 (define-public (stderr string . rest)
518 (apply format (cons (current-error-port) (cons string rest)))
519 (force-output (current-error-port)))
521 (define-public (debugf string . rest)
523 (apply stderr (cons string rest))))
525 (define (index-cell cell dir)
530 (define (cons-map f x)
531 "map F to contents of X"
532 (cons (f (car x)) (f (cdr x))))
534 (define-public (list-insert-separator lst between)
535 "Create new list, inserting BETWEEN between elements of LIST"
539 (cons x (cons between y))))
540 (fold-right conc #f lst))
542 (define-public (string-regexp-substitute a b str)
543 (regexp-substitute/global #f a str 'pre b 'post))
545 (define (regexp-split str regex)
547 (define end-of-prev-match 0)
548 (define (notice match)
550 (set! matches (cons (substring (match:string match)
554 (set! end-of-prev-match (match:end match)))
556 (regexp-substitute/global #f regex str notice 'post)
558 (if (< end-of-prev-match (string-length str))
561 (cons (substring str end-of-prev-match (string-length str)) matches)))
573 (define-public (binary-search start end getter target-val)
574 (_i "Find the index between @var{start} and @var{end} (an integer)
575 which will produce the closest match to @var{target-val} when
576 applied to function @var{getter}.")
579 (let* ((compare (quotient (+ start end) 2))
580 (get-val (getter compare)))
582 ((< target-val get-val)
583 (set! end (1- compare)))
584 ((< get-val target-val)
585 (set! start (1+ compare))))
586 (binary-search start end getter target-val))))
588 (define-public (car< a b)
591 (define-public (symbol<? lst r)
592 (string<? (symbol->string lst) (symbol->string r)))
594 (define-public (symbol-key<? lst r)
595 (string<? (symbol->string (car lst)) (symbol->string (car r))))
598 ;; don't confuse users with #<procedure .. > syntax.
600 (define-public (scm->string val)
601 (if (and (procedure? val)
602 (symbol? (procedure-name val)))
603 (symbol->string (procedure-name val))
605 (if (self-evaluating? val)
610 (call-with-output-string (lambda (port) (display val port)))
615 (define-public (!= lst r)
618 (define-public lily-unit->bigpoint-factor
620 ((equal? (ly:unit) "mm") (/ 72.0 25.4))
621 ((equal? (ly:unit) "pt") (/ 72.0 72.27))
622 (else (ly:error (_ "unknown unit: ~S") (ly:unit)))))
624 (define-public lily-unit->mm-factor
625 (* 25.4 (/ lily-unit->bigpoint-factor 72)))
627 ;;; FONT may be font smob, or pango font string...
628 (define-public (font-name-style font)
629 ;; FIXME: ughr, barf: feta-alphabet is actually emmentaler
630 (if (and (string? font)
631 (string-prefix? "feta-alphabet" font))
632 (string-append "emmentaler"
635 (string-length "feta-alphabet")
636 (string-length font)))
637 (let* ((font-name (ly:font-name font))
638 (full-name (if font-name font-name (ly:font-file-name font))))
639 (if (string-prefix? "Aybabtu" full-name)
641 (string-downcase full-name)))))
643 (define-public (modified-font-metric-font-scaling font)
644 (let* ((designsize (ly:font-design-size font))
645 (magnification (* (ly:font-magnification font)))
646 (scaling (* magnification designsize)))
647 (debugf "scaling:~S\n" scaling)
648 (debugf "magnification:~S\n" magnification)
649 (debugf "design:~S\n" designsize)
652 (define-public (version-not-seen-message input-file-name)
658 (_ "no \\version statement found, please add~afor future compatibility")
659 (format #f "\n\n\\version ~s\n\n" (lilypond-version)))))
661 (define-public (old-relative-not-used-message input-file-name)
666 (_ "old relative compatibility not used")))