scm/lily-library.scm

   1 ;;;;
   2 ;;;; lily-library.scm -- utilities
   3 ;;;;
   4 ;;;;  source file of the GNU LilyPond music typesetter
   5 ;;;;
   6 ;;;; (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   7 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
   8
   9
  10 (define-public X 0)
  11 (define-public Y 1)
  12 (define-safe-public START -1)
  13 (define-safe-public STOP 1)
  14 (define-public LEFT -1)
  15 (define-public RIGHT 1)
  16 (define-public UP 1)
  17 (define-public DOWN -1)
  18 (define-public CENTER 0)
  19
  20 (define-safe-public DOUBLE-FLAT -4)
  21 (define-safe-public THREE-Q-FLAT -3)
  22 (define-safe-public FLAT -2)
  23 (define-safe-public SEMI-FLAT -1)
  24 (define-safe-public NATURAL 0)
  25 (define-safe-public SEMI-SHARP 1)
  26 (define-safe-public SHARP 2)
  27 (define-safe-public THREE-Q-SHARP 3)
  28 (define-safe-public DOUBLE-SHARP 4)
  29 (define-safe-public SEMI-TONE 2)
  30
  31 (define-public ZERO-MOMENT (ly:make-moment 0 1))
  32
  33 (define-public (moment-min a b)
  34   (if (ly:moment<? a b) a b))
  35
  36 (define-public (average x . lst)
  37   (/ (+ x (apply + lst)) (1+ (length lst))))
  38
  39 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  40 ;; lily specific variables.
  41
  42 (define-public default-script-alist '())
  43
  44
  45 ;; parser stuff.
  46 (define-public (print-music-as-book parser music)
  47   (let* ((head (ly:parser-lookup parser '$defaultheader))
  48          (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
  49                              head (scorify-music music parser))))
  50     (print-book-with-defaults parser book)))
  51
  52 (define-public (print-score-as-book parser score)
  53   (let* ((head (ly:parser-lookup parser '$defaultheader))
  54          (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
  55                              head score)))
  56     (print-book-with-defaults parser book)))
  57
  58 (define-public (print-score parser score)
  59   (let* ((head (ly:parser-lookup parser '$defaultheader))
  60          (book (ly:make-book (ly:parser-lookup parser '$defaultpaper)
  61                              head score)))
  62     (ly:parser-print-score parser book)))
  63
  64 (define-public (collect-scores-for-book parser score)
  65   (ly:parser-define!
  66    parser 'toplevel-scores
  67    (cons score (ly:parser-lookup parser 'toplevel-scores))))
  68
  69
  70 (define-public (scorify-music music parser)
  71
  72   (for-each (lambda (func)
  73               (set! music (func music parser)))
  74             toplevel-music-functions)
  75
  76   (ly:make-score music))
  77
  78 (define-public (collect-music-for-book parser music)
  79   ;; discard music if its 'void property is true.
  80   (let ((void-music (ly:music-property music 'void)))
  81     (if (or (null? void-music) (not void-music))
  82         (collect-scores-for-book parser (scorify-music music parser)))))
  83
  84
  85 (define-public (print-book-with-defaults parser book)
  86   (let*
  87       ((paper (ly:parser-lookup parser '$defaultpaper))
  88        (layout (ly:parser-lookup parser '$defaultlayout))
  89        (count (ly:parser-lookup parser 'output-count))
  90        (base (ly:parser-output-name parser)))
  91
  92     (if (not (integer? count))
  93         (set! count 0))
  94
  95     (if (> count 0)
  96         (set! base (format #f "~a-~a" base count)))
  97
  98     (ly:parser-define! parser 'output-count (1+ count))
  99     (ly:book-process book paper layout base)
 100     ))
 101
 102 (define-public (print-score-with-defaults parser score)
 103   (let*
 104       ((paper (ly:parser-lookup parser '$defaultpaper))
 105        (layout (ly:parser-lookup parser '$defaultlayout))
 106        (header (ly:parser-lookup parser '$defaultheader))
 107        (count (ly:parser-lookup parser 'output-count))
 108        (base (ly:parser-output-name parser)))
 109
 110     (if (not (integer? count))
 111         (set! count 0))
 112
 113     (if (> count 0)
 114         (set! base (format #f "~a-~a" base count)))
 115
 116     (ly:parser-define! parser 'output-count (1+ count))
 117     (ly:score-process score header paper layout base)
 118     ))
 119
 120
 121 ;;;;;;;;;;;;;;;;
 122 ;; alist
 123 (define-public assoc-get ly:assoc-get)
 124
 125 (define-public (uniqued-alist alist acc)
 126   (if (null? alist) acc
 127       (if (assoc (caar alist) acc)
 128           (uniqued-alist (cdr alist) acc)
 129           (uniqued-alist (cdr alist) (cons (car alist) acc)))))
 130
 131 (define-public (alist<? x y)
 132   (string<? (symbol->string (car x))
 133             (symbol->string (car y))))
 134
 135 (define-public (chain-assoc x alist-list)
 136   (if (null? alist-list)
 137       #f
 138       (let* ((handle (assoc x (car alist-list))))
 139         (if (pair? handle)
 140             handle
 141             (chain-assoc x (cdr alist-list))))))
 142
 143 (define-public (chain-assoc-get x alist-list . default)
 144   "Return ALIST entry for X. Return DEFAULT (optional, else #f) if not
 145 found."
 146
 147   (define (helper x alist-list default)
 148     (if (null? alist-list)
 149         default
 150         (let* ((handle (assoc x (car alist-list))))
 151           (if (pair? handle)
 152               (cdr handle)
 153               (helper x (cdr alist-list) default)))))
 154
 155   (helper x alist-list
 156           (if (pair? default) (car default) #f)))
 157
 158 (define (map-alist-vals func list)
 159   "map FUNC over the vals of  LIST, leaving the keys."
 160   (if (null?  list)
 161       '()
 162       (cons (cons  (caar list) (func (cdar list)))
 163             (map-alist-vals func (cdr list)))))
 164
 165 (define (map-alist-keys func list)
 166   "map FUNC over the keys of an alist LIST, leaving the vals. "
 167   (if (null?  list)
 168       '()
 169       (cons (cons (func (caar list)) (cdar list))
 170             (map-alist-keys func (cdr list)))))
 171
 172 (define-public (first-member members lst)
 173   "Return first successful MEMBER of member from MEMBERS in LST."
 174   (if (null? members)
 175       #f
 176       (let ((m (member (car members) lst)))
 177         (if m m (first-member (cdr members) lst)))))
 178
 179 (define-public (first-assoc keys lst)
 180   "Return first successful ASSOC of key from KEYS in LST."
 181   (if (null? keys)
 182       #f
 183       (let ((k (assoc (car keys) lst)))
 184         (if k k (first-assoc (cdr keys) lst)))))
 185
 186 (define-public (flatten-alist alist)
 187   (if (null? alist)
 188       '()
 189       (cons (caar alist)
 190             (cons (cdar alist)
 191                   (flatten-alist (cdr alist))))))
 192
 193 ;;;;;;;;;;;;;;;;
 194 ;; vector
 195 (define-public (vector-for-each proc vec)
 196   (do
 197       ((i 0 (1+ i)))
 198       ((>= i (vector-length vec)) vec)
 199     (vector-set! vec i (proc (vector-ref vec i)))))
 200
 201 ;;;;;;;;;;;;;;;;
 202 ;; hash
 203
 204 (if (not (defined? 'hash-table?)) ;; guile 1.6 compat
 205     (begin
 206       (define hash-table? vector?)
 207       (define-public (hash-for-each proc tab)
 208         (hash-fold (lambda (k v prior)
 209                      (proc k v)
 210                      #f)
 211                    #f
 212                    tab))
 213       (define-public (hash-table->alist t)
 214         "Convert table t to list"
 215         (apply append (vector->list t))))
 216
 217     ;; native hashtabs.
 218     (begin
 219       (define-public (hash-table->alist t)
 220         (hash-fold (lambda (k v acc) (acons  k v  acc))
 221                    '() t))))
 222
 223 ;; todo: code dup with C++.
 224 (define-safe-public (alist->hash-table lst)
 225   "Convert alist to table"
 226   (let ((m (make-hash-table (length lst))))
 227     (map (lambda (k-v) (hashq-set! m (car k-v) (cdr k-v))) lst)
 228     m))
 229
 230 ;;;;;;;;;;;;;;;;
 231 ;; list
 232
 233 (define (split-list lst n)
 234   "Split LST in N equal sized parts"
 235
 236   (define (helper todo acc-vector k)
 237     (if (null? todo)
 238         acc-vector
 239         (begin
 240           (if (< k 0)
 241               (set! k (+ n k)))
 242
 243           (vector-set! acc-vector k (cons (car todo) (vector-ref acc-vector k)))
 244           (helper (cdr todo) acc-vector (1- k)))))
 245
 246   (helper lst (make-vector n '()) (1- n)))
 247
 248 (define (list-element-index lst x)
 249   (define (helper todo k)
 250     (cond
 251      ((null? todo) #f)
 252      ((equal? (car todo) x) k)
 253      (else
 254       (helper (cdr todo) (1+ k)))))
 255
 256   (helper lst 0))
 257
 258 (define-public (list-join lst intermediate)
 259   "put INTERMEDIATE  between all elts of LST."
 260
 261   (fold-right
 262    (lambda (elem prev)
 263             (if (pair? prev)
 264                 (cons  elem (cons intermediate prev))
 265                 (list elem)))
 266           '() lst))
 267
 268 (define-public (filtered-map proc lst)
 269   (filter
 270    (lambda (x) x)
 271    (map proc lst)))
 272
 273
 274 (define (flatten-list lst)
 275   "Unnest LST"
 276   (if (null? lst)
 277       '()
 278       (if (pair? (car lst))
 279           (append (flatten-list (car lst)) (flatten-list  (cdr lst)))
 280           (cons (car lst) (flatten-list (cdr lst))))))
 281
 282 (define (list-minus a b)
 283   "Return list of elements in A that are not in B."
 284   (lset-difference eq? a b))
 285
 286 ;; TODO: use the srfi-1 partition function.
 287 (define-public (uniq-list lst)
 288
 289   "Uniq LST, assuming that it is sorted"
 290   (define (helper acc lst)
 291     (if (null? lst)
 292         acc
 293         (if (null? (cdr lst))
 294             (cons (car lst) acc)
 295             (if (equal? (car lst) (cadr lst))
 296                 (helper acc (cdr lst))
 297                 (helper (cons (car lst) acc)  (cdr lst))))))
 298   (reverse! (helper '() lst) '()))
 299
 300 (define (split-at-predicate predicate lst)
 301  "Split LST = (a_1 a_2 ... a_k b_1 ... b_k)
 302   into L1 = (a_1 ... a_k ) and L2 =(b_1 .. b_k)
 303   Such that (PREDICATE a_i a_{i+1}) and not (PREDICATE a_k b_1).
 304   L1 is copied, L2 not.
 305
 306   (split-at-predicate (lambda (x y) (= (- y x) 2)) '(1 3 5 9 11) (cons '() '()))"
 307  ;; " Emacs is broken
 308
 309  (define (inner-split predicate lst acc)
 310    (cond
 311     ((null? lst) acc)
 312     ((null? (cdr lst))
 313      (set-car! acc (cons (car lst) (car acc)))
 314      acc)
 315     ((predicate (car lst) (cadr lst))
 316      (set-car! acc (cons (car lst) (car acc)))
 317      (inner-split predicate (cdr lst) acc))
 318     (else
 319      (set-car! acc (cons (car lst) (car acc)))
 320      (set-cdr! acc (cdr lst))
 321      acc)))
 322
 323  (let* ((c (cons '() '())))
 324    (inner-split predicate lst  c)
 325    (set-car! c (reverse! (car c)))
 326    c))
 327
 328 (define-public (split-list-by-separator lst sep?)
 329    "(display (split-list-by-separator '(a b c / d e f / g) (lambda (x) (equal? x '/))))
 330    =>
 331    ((a b c) (d e f) (g))
 332   "
 333    ;; " Emacs is broken
 334    (define (split-one sep?  lst acc)
 335      "Split off the first parts before separator and return both parts."
 336      (if (null? lst)
 337          (cons acc '())
 338          (if (sep? (car lst))
 339              (cons acc (cdr lst))
 340              (split-one sep? (cdr lst) (cons (car lst) acc)))))
 341
 342    (if (null? lst)
 343        '()
 344        (let* ((c (split-one sep? lst '())))
 345          (cons (reverse! (car c) '()) (split-list-by-separator (cdr c) sep?)))))
 346
 347 (define-public (offset-add a b)
 348   (cons (+ (car a) (car b))
 349         (+ (cdr a) (cdr b))))
 350
 351 (define-public (offset-flip-y o)
 352   (cons (car o) (- (cdr o))))
 353
 354 (define-public (offset-scale o scale)
 355   (cons (* (car o) scale)
 356         (* (cdr o) scale)))
 357
 358 (define-public (ly:list->offsets accum coords)
 359   (if (null? coords)
 360       accum
 361       (cons (cons (car coords) (cadr coords))
 362             (ly:list->offsets accum (cddr coords)))))
 363
 364 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 365 ;; numbers
 366
 367 (if (not (defined? 'nan?)) ;; guile 1.6 compat
 368     (define-public (nan? x) (not (or (< 0.0 x)
 369                                      (> 0.0 x)
 370                                      (= 0.0 x)))))
 371
 372 (if (not (defined? 'inf?))
 373     (define-public (inf? x) (= (/ 1.0 x) 0.0)))
 374
 375 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 376 ;; intervals
 377
 378 (define-public (interval-length x)
 379   "Length of the number-pair X, when an interval"
 380   (max 0 (- (cdr x) (car x))))
 381
 382 (define-public interval-start car)
 383 (define-public (ordered-cons a b)
 384   (cons (min a b)
 385         (max a b)))
 386
 387 (define-public interval-end cdr)
 388
 389 (define-public (interval-index interval dir)
 390   "Interpolate INTERVAL between between left (DIR=-1) and right (DIR=+1)"
 391
 392   (* (+  (interval-start interval) (interval-end interval)
 393          (* dir (- (interval-end interval) (interval-start interval))))
 394      0.5))
 395
 396 (define-public (interval-center x)
 397   "Center the number-pair X, when an interval"
 398   (if (interval-empty? x)
 399       0.0
 400       (/ (+ (car x) (cdr x)) 2)))
 401
 402 (define-public interval-start car)
 403 (define-public interval-end cdr)
 404 (define-public (interval-translate iv amount)
 405   (cons (+ amount (car iv))
 406         (+ amount (cdr iv))))
 407
 408 (define (other-axis a)
 409   (remainder (+ a 1) 2))
 410
 411 (define-public (interval-widen iv amount)
 412    (cons (- (car iv) amount)
 413          (+ (cdr iv) amount)))
 414
 415
 416 (define-public (interval-empty? iv)
 417    (> (car iv) (cdr iv)))
 418
 419 (define-public (interval-union i1 i2)
 420    (cons (min (car i1) (car i2))
 421          (max (cdr i1) (cdr i2))))
 422
 423 (define-public (interval-sane? i)
 424   (not (or  (nan? (car i))
 425             (inf? (car i))
 426             (nan? (cdr i))
 427             (inf? (cdr i))
 428             (> (car i) (cdr i)))))
 429
 430
 431 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 432 ;;
 433
 434
 435 (define-public (string-encode-integer i)
 436   (cond
 437    ((= i  0) "o")
 438    ((< i 0)   (string-append "n" (string-encode-integer (- i))))
 439    (else (string-append
 440           (make-string 1 (integer->char (+ 65 (modulo i 26))))
 441           (string-encode-integer (quotient i 26))))))
 442
 443 (define-public (ly:numbers->string lst)
 444   (string-join (map ly:number->string lst) " "))
 445
 446 (define (number->octal-string x)
 447   (let* ((n (inexact->exact x))
 448          (n64 (quotient n 64))
 449          (n8 (quotient (- n (* n64 64)) 8)))
 450     (string-append
 451      (number->string n64)
 452      (number->string n8)
 453      (number->string (remainder (- n (+ (* n64 64) (* n8 8))) 8)))))
 454
 455 (define-public (ly:inexact->string x radix)
 456   (let ((n (inexact->exact x)))
 457     (number->string n radix)))
 458
 459 (define-public (ly:number-pair->string c)
 460   (string-append (ly:number->string (car c)) " "
 461                  (ly:number->string (cdr c))))
 462
 463
 464 (define-public (write-me message x)
 465   "Return X.  Display MESSAGE and write X.  Handy for debugging,
 466 possibly turned off."
 467   (display message) (write x) (newline) x)
 468 ;;  x)
 469
 470 (define-public (stderr string . rest)
 471   (apply format (cons (current-error-port) (cons string rest)))
 472   (force-output (current-error-port)))
 473
 474 (define-public (debugf string . rest)
 475   (if #f
 476       (apply stderr (cons string rest))))
 477
 478 (define (index-cell cell dir)
 479   (if (equal? dir 1)
 480       (cdr cell)
 481       (car cell)))
 482
 483 (define (cons-map f x)
 484   "map F to contents of X"
 485   (cons (f (car x)) (f (cdr x))))
 486
 487 (define-public (list-insert-separator lst between)
 488   "Create new list, inserting BETWEEN between elements of LIST"
 489   (define (conc x y )
 490     (if (eq? y #f)
 491         (list x)
 492         (cons x  (cons between y))))
 493   (fold-right conc #f lst))
 494
 495 (define-public (string-regexp-substitute a b str)
 496   (regexp-substitute/global #f a str 'pre b 'post))
 497
 498 (define (regexp-split str regex)
 499   (define matches '())
 500   (define end-of-prev-match 0)
 501   (define (notice match)
 502
 503     (set! matches (cons (substring (match:string match)
 504                                    end-of-prev-match
 505                                    (match:start match))
 506                         matches))
 507     (set! end-of-prev-match (match:end match)))
 508
 509   (regexp-substitute/global #f regex str notice 'post)
 510
 511   (if (< end-of-prev-match (string-length str))
 512       (set!
 513        matches
 514        (cons (substring str end-of-prev-match (string-length str)) matches)))
 515
 516    (reverse matches))
 517
 518 ;;;;;;;;;;;;;;;;
 519 ; other
 520 (define (sign x)
 521   (if (= x 0)
 522       0
 523       (if (< x 0) -1 1)))
 524
 525 (define-public (car< a b) (< (car a) (car b)))
 526
 527 (define-public (symbol<? lst r)
 528   (string<? (symbol->string lst) (symbol->string r)))
 529
 530 (define-public (symbol-key<? lst r)
 531   (string<? (symbol->string (car lst)) (symbol->string (car r))))
 532
 533 ;;
 534 ;; don't confuse users with #<procedure .. > syntax.
 535 ;;
 536 (define-public (scm->string val)
 537   (if (and (procedure? val) (symbol? (procedure-name val)))
 538       (symbol->string (procedure-name val))
 539       (string-append
 540        (if (self-evaluating? val) "" "'")
 541        (call-with-output-string (lambda (port) (display val port))))))
 542
 543 (define-public (!= lst r)
 544   (not (= lst r)))
 545
 546 (define-public lily-unit->bigpoint-factor
 547   (cond
 548    ((equal? (ly:unit) "mm") (/ 72.0 25.4))
 549    ((equal? (ly:unit) "pt") (/ 72.0 72.27))
 550    (else (ly:error (_ "unknown unit: ~S") (ly:unit)))))
 551
 552 (define-public lily-unit->mm-factor
 553   (* 25.4 (/ lily-unit->bigpoint-factor 72)))
 554
 555 ;;; FONT may be font smob, or pango font string...
 556 (define-public (font-name-style font)
 557       ;; FIXME: ughr, (ly:font-name) sometimes also has Style appended.
 558       (let* ((font-name (ly:font-name font))
 559              (full-name (if font-name font-name (ly:font-file-name font)))
 560              (name-style (string-split full-name #\-)))
 561         ;; FIXME: ughr, barf: feta-alphabet is actually emmentaler
 562         (if (string-prefix? "feta-alphabet" full-name)
 563             (list "emmentaler"
 564                   (substring  full-name (string-length "feta-alphabet")))
 565             (if (not (null? (cdr name-style)))
 566             name-style
 567             (append name-style '("Regular"))))))
 568
 569 (define-public (modified-font-metric-font-scaling font)
 570   (let* ((designsize (ly:font-design-size font))
 571          (magnification (* (ly:font-magnification font)))
 572          (scaling (* magnification designsize)))
 573     (debugf "scaling:~S\n" scaling)
 574     (debugf "magnification:~S\n" magnification)
 575     (debugf "design:~S\n" designsize)
 576     scaling))
 577
 578 (define-public (version-not-seen-message input-file-name)
 579   (ly:message
 580    (string-append
 581     input-file-name ": 0: " (_ "warning: ")
 582    (format #f
 583            (_ "no \\version statement found, please add~afor future compatibility")
 584            (format #f "\n\n\\version ~s\n\n" (lilypond-version))))))
 585
 586 (define-public (old-relative-not-used-message input-file-name)
 587   (ly:message
 588    (string-append
 589     input-file-name ": 0: " (_ "warning: ")
 590     (_ "old relative compatibility not used"))))