scm/music-functions.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
   4 ;;;;                 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5 ;;;;
   6 ;;;; LilyPond is free software: you can redistribute it and/or modify
   7 ;;;; it under the terms of the GNU General Public License as published by
   8 ;;;; the Free Software Foundation, either version 3 of the License, or
   9 ;;;; (at your option) any later version.
  10 ;;;;
  11 ;;;; LilyPond is distributed in the hope that it will be useful,
  12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;;;; GNU General Public License for more details.
  15 ;;;;
  16 ;;;; You should have received a copy of the GNU General Public License
  17 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 ;; for define-safe-public when byte-compiling using Guile V2
  20 (use-modules (scm safe-utility-defs))
  21
  22 (use-modules (ice-9 optargs))
  23
  24 ;;; ly:music-property with setter
  25 ;;; (ly:music-property my-music 'elements)
  26 ;;;   ==> the 'elements property
  27 ;;; (set! (ly:music-property my-music 'elements) value)
  28 ;;;   ==> set the 'elements property and return it
  29 (define-public ly:music-property
  30   (make-procedure-with-setter ly:music-property
  31                               ly:music-set-property!))
  32
  33 (define-safe-public (music-is-of-type? mus type)
  34   "Does @code{mus} belong to the music class @code{type}?"
  35   (memq type (ly:music-property mus 'types)))
  36
  37 ;; TODO move this
  38 (define-public ly:grob-property
  39   (make-procedure-with-setter ly:grob-property
  40                               ly:grob-set-property!))
  41
  42 (define-public ly:grob-object
  43   (make-procedure-with-setter ly:grob-object
  44                               ly:grob-set-object!))
  45
  46 (define-public ly:grob-parent
  47   (make-procedure-with-setter ly:grob-parent
  48                               ly:grob-set-parent!))
  49
  50 (define-public ly:prob-property
  51   (make-procedure-with-setter ly:prob-property
  52                               ly:prob-set-property!))
  53
  54 (define-public ly:context-property
  55   (make-procedure-with-setter ly:context-property
  56                               ly:context-set-property!))
  57
  58 (define-public (music-map function music)
  59   "Apply @var{function} to @var{music} and all of the music it contains.
  60
  61 First it recurses over the children, then the function is applied to
  62 @var{music}."
  63   (let ((es (ly:music-property music 'elements))
  64         (e (ly:music-property music 'element)))
  65     (if (pair? es)
  66         (set! (ly:music-property music 'elements)
  67               (map (lambda (y) (music-map function y)) es)))
  68     (if (ly:music? e)
  69         (set! (ly:music-property music 'element)
  70               (music-map function  e)))
  71     (function music)))
  72
  73 (define-public (music-filter pred? music)
  74   "Filter out music expressions that do not satisfy @var{pred?}."
  75
  76   (define (inner-music-filter pred? music)
  77     "Recursive function."
  78     (let* ((es (ly:music-property music 'elements))
  79            (e (ly:music-property music 'element))
  80            (as (ly:music-property music 'articulations))
  81            (filtered-as (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) as)))
  82            (filtered-e (if (ly:music? e)
  83                            (inner-music-filter pred? e)
  84                            e))
  85            (filtered-es (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) es))))
  86       (if (not (null? e))
  87           (set! (ly:music-property music 'element) filtered-e))
  88       (if (not (null? es))
  89           (set! (ly:music-property music 'elements) filtered-es))
  90       (if (not (null? as))
  91           (set! (ly:music-property music 'articulations) filtered-as))
  92       ;; if filtering emptied the expression, we remove it completely.
  93       (if (or (not (pred? music))
  94               (and (eq? filtered-es '()) (not (ly:music? e))
  95                    (or (not (eq? es '()))
  96                        (ly:music? e))))
  97           (set! music '()))
  98       music))
  99
 100   (set! music (inner-music-filter pred? music))
 101   (if (ly:music? music)
 102       music
 103       (make-music 'Music)))       ;must return music.
 104
 105 (define*-public (display-music music #:optional (port (current-output-port)))
 106   "Display music, not done with @code{music-map} for clarity of
 107 presentation."
 108   (display music port)
 109   (display ": { " port)
 110   (let ((es (ly:music-property music 'elements))
 111         (e (ly:music-property music 'element)))
 112     (display (ly:music-mutable-properties music) port)
 113     (if (pair? es)
 114         (begin (display "\nElements: {\n" port)
 115                (for-each (lambda (m) (display-music m port)) es)
 116                (display "}\n" port)))
 117     (if (ly:music? e)
 118         (begin
 119           (display "\nChild:" port)
 120           (display-music e port))))
 121   (display " }\n" port)
 122   music)
 123
 124 ;;;
 125 ;;; A scheme music pretty printer
 126 ;;;
 127 (define (markup-expression->make-markup markup-expression)
 128   "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression.
 129 For instance,
 130   \\markup \\bold \\italic hello
 131 ==>
 132   (markup #:line (#:bold (#:italic (#:simple \"hello\"))))"
 133   (define (proc->command-keyword proc)
 134     "Return a keyword, eg. `#:bold', from the `proc' function, eg. #<procedure bold-markup (layout props arg)>"
 135     (let ((cmd-markup (symbol->string (procedure-name proc))))
 136       (symbol->keyword (string->symbol (substring cmd-markup 0 (- (string-length cmd-markup)
 137                                                                   (string-length "-markup")))))))
 138   (define (transform-arg arg)
 139     (cond ((and (pair? arg) (markup? (car arg))) ;; a markup list
 140            (apply append (map inner-markup->make-markup arg)))
 141           ((and (not (string? arg)) (markup? arg)) ;; a markup
 142            (inner-markup->make-markup arg))
 143           (else                                  ;; scheme arg
 144            (music->make-music arg))))
 145   (define (inner-markup->make-markup mrkup)
 146     (if (string? mrkup)
 147         `(#:simple ,mrkup)
 148         (let ((cmd (proc->command-keyword (car mrkup)))
 149               (args (map transform-arg (cdr mrkup))))
 150           `(,cmd ,@args))))
 151   ;; body:
 152   (if (string? markup-expression)
 153       markup-expression
 154       `(markup ,@(inner-markup->make-markup markup-expression))))
 155
 156 (define-public (music->make-music obj)
 157   "Generate an expression that, once evaluated, may return an object
 158 equivalent to @var{obj}, that is, for a music expression, a
 159 @code{(make-music ...)} form."
 160   (cond (;; markup expression
 161          (markup? obj)
 162          (markup-expression->make-markup obj))
 163         (;; music expression
 164          (ly:music? obj)
 165          `(make-music
 166            ',(ly:music-property obj 'name)
 167            ,@(apply append (map (lambda (prop)
 168                                   `(',(car prop)
 169                                     ,(music->make-music (cdr prop))))
 170                                 (remove (lambda (prop)
 171                                           (eqv? (car prop) 'origin))
 172                                         (ly:music-mutable-properties obj))))))
 173         (;; moment
 174          (ly:moment? obj)
 175          `(ly:make-moment ,(ly:moment-main-numerator obj)
 176                           ,(ly:moment-main-denominator obj)
 177                           ,(ly:moment-grace-numerator obj)
 178                           ,(ly:moment-grace-denominator obj)))
 179         (;; note duration
 180          (ly:duration? obj)
 181          `(ly:make-duration ,(ly:duration-log obj)
 182                             ,(ly:duration-dot-count obj)
 183                             ,(ly:duration-scale obj)))
 184         (;; note pitch
 185          (ly:pitch? obj)
 186          `(ly:make-pitch ,(ly:pitch-octave obj)
 187                          ,(ly:pitch-notename obj)
 188                          ,(ly:pitch-alteration obj)))
 189         (;; scheme procedure
 190          (procedure? obj)
 191          (or (procedure-name obj) obj))
 192         (;; a symbol (avoid having an unquoted symbol)
 193          (symbol? obj)
 194          `',obj)
 195         (;; an empty list (avoid having an unquoted empty list)
 196          (null? obj)
 197          `'())
 198         (;; a proper list
 199          (list? obj)
 200          `(list ,@(map music->make-music obj)))
 201         (;; a pair
 202          (pair? obj)
 203          `(cons ,(music->make-music (car obj))
 204                 ,(music->make-music (cdr obj))))
 205         (else
 206          obj)))
 207
 208 (use-modules (ice-9 pretty-print))
 209 (define*-public (display-scheme-music obj #:optional (port (current-output-port)))
 210   "Displays `obj', typically a music expression, in a friendly fashion,
 211 which often can be read back in order to generate an equivalent expression."
 212   (pretty-print (music->make-music obj) port)
 213   (newline port))
 214
 215 ;;;
 216 ;;; Scheme music expression --> Lily-syntax-using string translator
 217 ;;;
 218 (use-modules (srfi srfi-39)
 219              (scm display-lily))
 220
 221 (define*-public (display-lily-music expr parser #:optional (port (current-output-port))
 222                                     #:key force-duration)
 223   "Display the music expression using LilyPond syntax"
 224   (memoize-clef-names supported-clefs)
 225   (parameterize ((*indent* 0)
 226                  (*previous-duration* (ly:make-duration 2))
 227                  (*force-duration* force-duration))
 228                 (display (music->lily-string expr parser) port)
 229                 (newline port)))
 230
 231 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 232
 233 (define-public (shift-one-duration-log music shift dot)
 234   "Add @var{shift} to @code{duration-log} of @code{'duration} in
 235 @var{music} and optionally @var{dot} to any note encountered.
 236 The number of dots in the shifted music may not be less than zero."
 237   (let ((d (ly:music-property music 'duration)))
 238     (if (ly:duration? d)
 239         (let* ((cp (ly:duration-scale d))
 240                (nd (ly:make-duration
 241                     (+ shift (ly:duration-log d))
 242                     (max 0 (+ dot (ly:duration-dot-count d)))
 243                     cp)))
 244           (set! (ly:music-property music 'duration) nd)))
 245     music))
 246
 247 (define-public (shift-duration-log music shift dot)
 248   (music-map (lambda (x) (shift-one-duration-log x shift dot))
 249              music))
 250
 251 (define-public (make-repeat name times main alts)
 252   "Create a repeat music expression, with all properties initialized
 253 properly."
 254   (define (first-note-duration music)
 255     "Finds the duration of the first NoteEvent by searching depth-first
 256 through MUSIC."
 257     ;; NoteEvent or a non-expanded chord-repetition
 258     ;; We just take anything that actually sports an announced duration.
 259     (if (ly:duration? (ly:music-property music 'duration))
 260         (ly:music-property music 'duration)
 261         (let loop ((elts (if (ly:music? (ly:music-property music 'element))
 262                              (list (ly:music-property music 'element))
 263                              (ly:music-property music 'elements))))
 264           (and (pair? elts)
 265                (let ((dur (first-note-duration (car elts))))
 266                  (if (ly:duration? dur)
 267                      dur
 268                      (loop (cdr elts))))))))
 269
 270   (let ((talts (if (< times (length alts))
 271                    (begin
 272                      (ly:warning (_ "More alternatives than repeats.  Junking excess alternatives"))
 273                      (take alts times))
 274                    alts))
 275         (r (make-repeated-music name)))
 276     (set! (ly:music-property r 'element) main)
 277     (set! (ly:music-property r 'repeat-count) (max times 1))
 278     (set! (ly:music-property r 'elements) talts)
 279     (if (and (equal? name "tremolo")
 280              (pair? (extract-named-music main '(EventChord NoteEvent))))
 281         ;; This works for single-note and multi-note tremolos!
 282         (let* ((children (if (music-is-of-type? main 'sequential-music)
 283                              ;; \repeat tremolo n { ... }
 284                              (length (extract-named-music main '(EventChord
 285                                                                  NoteEvent)))
 286                              ;; \repeat tremolo n c4
 287                              1))
 288                ;; # of dots is equal to the 1 in bitwise representation (minus 1)!
 289                (dots (1- (logcount (* times children))))
 290                ;; The remaining missing multiplicator to scale the notes by
 291                ;; times * children
 292                (mult (/ (* times children (ash 1 dots)) (1- (ash 2 dots))))
 293                (shift (- (ly:intlog2 (floor mult))))
 294                (note-duration (first-note-duration r))
 295                (duration-log (if (ly:duration? note-duration)
 296                                  (ly:duration-log note-duration)
 297                                  1))
 298                (tremolo-type (ash 1 duration-log)))
 299           (set! (ly:music-property r 'tremolo-type) tremolo-type)
 300           (if (not (and (integer? mult) (= (logcount mult) 1)))
 301               (ly:music-warning
 302                main
 303                (ly:format (_ "invalid tremolo repeat count: ~a") times)))
 304           ;; Adjust the time of the notes
 305           (ly:music-compress r (ly:make-moment 1 children))
 306           ;; Adjust the displayed note durations
 307           (shift-duration-log r shift dots))
 308         r)))
 309
 310 (define (calc-repeat-slash-count music)
 311   "Given the child-list @var{music} in @code{PercentRepeatMusic},
 312 calculate the number of slashes based on the durations.  Returns @code{0}
 313 if durations in @var{music} vary, allowing slash beats and double-percent
 314 beats to be distinguished."
 315   (let* ((durs (map duration-of-note
 316                     (extract-named-music music '(EventChord NoteEvent
 317                                                             RestEvent SkipEvent))))
 318          (first-dur (car durs)))
 319
 320     (if (every (lambda (d) (equal? d first-dur)) durs)
 321         (max (- (ly:duration-log first-dur) 2) 1)
 322         0)))
 323
 324 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 325 ;; clusters.
 326
 327 (define-public (note-to-cluster music)
 328   "Replace @code{NoteEvents} by @code{ClusterNoteEvents}."
 329   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 330       (make-music 'ClusterNoteEvent
 331                   'pitch (ly:music-property music 'pitch)
 332                   'duration (ly:music-property music 'duration))
 333       music))
 334
 335 (define-public (notes-to-clusters music)
 336   (music-map note-to-cluster music))
 337
 338 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 339 ;; repeats.
 340
 341 (define-public (unfold-repeats music)
 342   "Replace all repeats with unfolded repeats."
 343
 344   (let ((es (ly:music-property music 'elements))
 345         (e (ly:music-property music 'element)))
 346
 347     (if (music-is-of-type? music 'repeated-music)
 348         (let* ((props (ly:music-mutable-properties music))
 349                (old-name (ly:music-property music 'name))
 350                (flattened (flatten-alist props)))
 351           (set! music (apply make-music (cons 'UnfoldedRepeatedMusic
 352                                               flattened)))
 353
 354           (if (and (equal? old-name 'TremoloRepeatedMusic)
 355                    (pair? (extract-named-music e '(EventChord NoteEvent))))
 356               ;; This works for single-note and multi-note tremolos!
 357               (let* ((children (if (music-is-of-type? e 'sequential-music)
 358                                    ;; \repeat tremolo n { ... }
 359                                    (length (extract-named-music e '(EventChord
 360                                                                     NoteEvent)))
 361                                    ;; \repeat tremolo n c4
 362                                    1))
 363                      (times (ly:music-property music 'repeat-count))
 364
 365                      ;; # of dots is equal to the 1 in bitwise representation (minus 1)!
 366                      (dots (1- (logcount (* times children))))
 367                      ;; The remaining missing multiplicator to scale the notes by
 368                      ;; times * children
 369                      (mult (/ (* times children (ash 1 dots)) (1- (ash 2 dots))))
 370                      (shift (- (ly:intlog2 (floor mult)))))
 371
 372                 ;; Adjust the time of the notes
 373                 (ly:music-compress music (ly:make-moment children 1))
 374                 ;; Adjust the displayed note durations
 375                 (shift-duration-log music (- shift) (- dots))))))
 376
 377     (if (pair? es)
 378         (set! (ly:music-property music 'elements)
 379               (map unfold-repeats es)))
 380     (if (ly:music? e)
 381         (set! (ly:music-property music 'element)
 382               (unfold-repeats e)))
 383     music))
 384
 385 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 386 ;; property setting music objs.
 387
 388 (define-safe-public (check-grob-path path #:optional parser location
 389                                      #:key
 390                                      (start 0)
 391                                      default
 392                                      (min 1)
 393                                      max)
 394   "Check a grob path specification @var{path}, a symbol list (or a
 395 single symbol), for validity and possibly complete it.  Returns the
 396 completed specification, or @code{#f} if invalid.  If optional
 397 @var{parser} is given, a syntax error is raised in that case,
 398 optionally using @var{location}.  If an optional keyword argument
 399 @code{#:start @var{start}} is given, the parsing starts at the given
 400 index in the sequence @samp{Context.Grob.property.sub-property...},
 401 with the default of @samp{0} implying the full path.
 402
 403 If there is no valid first element of @var{path} fitting at the given
 404 path location, an optionally given @code{#:default @var{default}} is
 405 used as the respective element instead without checking it for
 406 validity at this position.
 407
 408 The resulting path after possibly prepending @var{default} can be
 409 constrained in length by optional arguments @code{#:min @var{min}} and
 410 @code{#:max @var{max}}, defaulting to @samp{1} and unlimited,
 411 respectively."
 412   (let ((path (if (symbol? path) (list path) path)))
 413     ;; A Guile 1.x bug specific to optargs precludes moving the
 414     ;; defines out of the let
 415     (define (unspecial? s)
 416       (not (or (object-property s 'is-grob?)
 417                (object-property s 'backend-type?))))
 418     (define (grob? s)
 419       (object-property s 'is-grob?))
 420     (define (property? s)
 421       (object-property s 'backend-type?))
 422     (define (check c p) (c p))
 423
 424     (let* ((checkers
 425             (and (< start 3)
 426                  (drop (list unspecial? grob? property?) start)))
 427            (res
 428             (cond
 429              ((null? path)
 430               ;; tricky.  Should we make use of the default when the
 431               ;; list is empty?  In most cases, this question should be
 432               ;; academical as an empty list can only be generated by
 433               ;; Scheme and is likely an error.  We consider this a case
 434               ;; of "no valid first element, and default given".
 435               ;; Usually, invalid use cases should be caught later using
 436               ;; the #:min argument, and if the user explicitly does not
 437               ;; catch this, we just follow through.
 438               (if default (list default) '()))
 439              ((not checkers)
 440               ;; no checkers, so we have a valid first element and just
 441               ;; take the path as-is.
 442               path)
 443              (default
 444                (if ((car checkers) (car path))
 445                    (and (every check (cdr checkers) (cdr path))
 446                         path)
 447                    (and (every check (cdr checkers) path)
 448                         (cons default path))))
 449              (else
 450               (and (every check checkers path)
 451                    path)))))
 452       (if (and res
 453                (if max (<= min (length res) max)
 454                    (<= min (length res))))
 455           res
 456           (begin
 457             (if parser
 458                 (ly:parser-error parser
 459                                  (format #f (_ "bad grob property path ~a")
 460                                          path)
 461                                  location))
 462             #f)))))
 463
 464 (define-public (make-grob-property-set grob gprop val)
 465   "Make a @code{Music} expression that sets @var{gprop} to @var{val} in
 466 @var{grob}.  Does a pop first, i.e., this is not an override."
 467   (make-music 'OverrideProperty
 468               'symbol grob
 469               'grob-property gprop
 470               'grob-value val
 471               'pop-first #t))
 472
 473 (define-public (make-grob-property-override grob gprop val)
 474   "Make a @code{Music} expression that overrides @var{gprop} to @var{val}
 475 in @var{grob}."
 476   (make-music 'OverrideProperty
 477               'symbol grob
 478               'grob-property gprop
 479               'grob-value val))
 480
 481 (define-public (make-grob-property-revert grob gprop)
 482   "Revert the grob property @var{gprop} for @var{grob}."
 483   (make-music 'RevertProperty
 484               'symbol grob
 485               'grob-property gprop))
 486
 487 (define direction-polyphonic-grobs
 488   '(AccidentalSuggestion
 489     DotColumn
 490     Dots
 491     Fingering
 492     LaissezVibrerTie
 493     LigatureBracket
 494     MultiMeasureRest
 495     PhrasingSlur
 496     RepeatTie
 497     Rest
 498     Script
 499     Slur
 500     Stem
 501     TextScript
 502     Tie
 503     TupletBracket
 504     TrillSpanner))
 505
 506 (define-safe-public (make-voice-props-set n)
 507   (make-sequential-music
 508    (append
 509     (map (lambda (x) (make-grob-property-set x 'direction
 510                                              (if (odd? n) -1 1)))
 511          direction-polyphonic-grobs)
 512     (list
 513      (make-property-set 'graceSettings
 514                         ;; TODO: take this from voicedGraceSettings or similar.
 515                         '((Voice Stem font-size -3)
 516                           (Voice Flag font-size -3)
 517                           (Voice NoteHead font-size -3)
 518                           (Voice TabNoteHead font-size -4)
 519                           (Voice Dots font-size -3)
 520                           (Voice Stem length-fraction 0.8)
 521                           (Voice Stem no-stem-extend #t)
 522                           (Voice Beam beam-thickness 0.384)
 523                           (Voice Beam length-fraction 0.8)
 524                           (Voice Accidental font-size -4)
 525                           (Voice AccidentalCautionary font-size -4)
 526                           (Voice Script font-size -3)
 527                           (Voice Fingering font-size -8)
 528                           (Voice StringNumber font-size -8)))
 529
 530      (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))))))
 531
 532
 533 (define-safe-public (make-voice-props-override n)
 534   (make-sequential-music
 535    (append
 536     (map (lambda (x) (make-grob-property-override x 'direction
 537                                                   (if (odd? n) -1 1)))
 538          direction-polyphonic-grobs)
 539     (list
 540      (make-property-set 'graceSettings
 541                         ;; TODO: take this from voicedGraceSettings or similar.
 542                         '((Voice Stem font-size -3)
 543                           (Voice Flag font-size -3)
 544                           (Voice NoteHead font-size -3)
 545                           (Voice TabNoteHead font-size -4)
 546                           (Voice Dots font-size -3)
 547                           (Voice Stem length-fraction 0.8)
 548                           (Voice Stem no-stem-extend #t)
 549                           (Voice Beam beam-thickness 0.384)
 550                           (Voice Beam length-fraction 0.8)
 551                           (Voice Accidental font-size -4)
 552                           (Voice AccidentalCautionary font-size -4)
 553                           (Voice Script font-size -3)
 554                           (Voice Fingering font-size -8)
 555                           (Voice StringNumber font-size -8)))
 556
 557      (make-grob-property-override 'NoteColumn 'horizontal-shift (quotient n 2))
 558      (make-grob-property-override 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
 559
 560 (define-safe-public (make-voice-props-revert)
 561   (make-sequential-music
 562    (append
 563     (map (lambda (x) (make-grob-property-revert x 'direction))
 564          direction-polyphonic-grobs)
 565     (list (make-property-unset 'graceSettings)
 566           (make-grob-property-revert 'NoteColumn 'horizontal-shift)
 567           (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
 568
 569
 570 (define-safe-public (context-spec-music m context #:optional id)
 571   "Add \\context CONTEXT = ID to M."
 572   (let ((cm (make-music 'ContextSpeccedMusic
 573                         'element m
 574                         'context-type context)))
 575     (if (string? id)
 576         (set! (ly:music-property cm 'context-id) id))
 577     cm))
 578
 579 (define-public (descend-to-context m context)
 580   "Like @code{context-spec-music}, but only descending."
 581   (let ((cm (context-spec-music m context)))
 582     (ly:music-set-property! cm 'descend-only #t)
 583     cm))
 584
 585 (define-public (make-non-relative-music mus)
 586   (make-music 'UnrelativableMusic
 587               'element mus))
 588
 589 (define-public (make-apply-context func)
 590   (make-music 'ApplyContext
 591               'procedure func))
 592
 593 (define-public (make-sequential-music elts)
 594   (make-music 'SequentialMusic
 595               'elements elts))
 596
 597 (define-public (make-simultaneous-music elts)
 598   (make-music 'SimultaneousMusic
 599               'elements elts))
 600
 601 (define-safe-public (make-event-chord elts)
 602   (make-music 'EventChord
 603               'elements elts))
 604
 605 (define-public (make-skip-music dur)
 606   (make-music 'SkipMusic
 607               'duration dur))
 608
 609 (define-public (make-grace-music music)
 610   (make-music 'GraceMusic
 611               'element music))
 612
 613 ;;;;;;;;;;;;;;;;
 614
 615 ;; mmrest
 616 (define-public (make-multi-measure-rest duration location)
 617   (make-music 'MultiMeasureRestMusic
 618               'origin location
 619               'duration duration))
 620
 621 (define-public (make-property-set sym val)
 622   (make-music 'PropertySet
 623               'symbol sym
 624               'value val))
 625
 626 (define-public (make-property-unset sym)
 627   (make-music 'PropertyUnset
 628               'symbol sym))
 629
 630 (define-safe-public (make-articulation name)
 631   (make-music 'ArticulationEvent
 632               'articulation-type name))
 633
 634 (define-public (make-lyric-event string duration)
 635   (make-music 'LyricEvent
 636               'duration duration
 637               'text string))
 638
 639 (define-safe-public (make-span-event type span-dir)
 640   (make-music type
 641               'span-direction span-dir))
 642
 643 (define-public (override-head-style heads style)
 644   "Override style for @var{heads} to @var{style}."
 645   (make-sequential-music
 646    (if (pair? heads)
 647        (map (lambda (h)
 648               (make-grob-property-override h 'style style))
 649             heads)
 650        (list (make-grob-property-override heads 'style style)))))
 651
 652 (define-public (revert-head-style heads)
 653   "Revert style for @var{heads}."
 654   (make-sequential-music
 655    (if (pair? heads)
 656        (map (lambda (h)
 657               (make-grob-property-revert h 'style))
 658             heads)
 659        (list (make-grob-property-revert heads 'style)))))
 660
 661 (define-public (style-note-heads heads style music)
 662   "Set @var{style} for all @var{heads} in @var{music}.  Works both
 663 inside of and outside of chord construct."
 664   ;; are we inside a <...>?
 665   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 666       ;; yes -> use a tweak
 667       (begin
 668         (set! (ly:music-property music 'tweaks)
 669               (acons 'style style (ly:music-property music 'tweaks)))
 670         music)
 671       ;; not in <...>, so use overrides
 672       (make-sequential-music
 673        (list
 674         (override-head-style heads style)
 675         music
 676         (revert-head-style heads)))))
 677
 678 (define-public (set-mus-properties! m alist)
 679   "Set all of @var{alist} as properties of @var{m}."
 680   (if (pair? alist)
 681       (begin
 682         (set! (ly:music-property m (caar alist)) (cdar alist))
 683         (set-mus-properties! m (cdr alist)))))
 684
 685 (define-public (music-separator? m)
 686   "Is @var{m} a separator?"
 687   (let ((ts (ly:music-property m 'types)))
 688     (memq 'separator ts)))
 689
 690 ;;; expanding repeat chords
 691 (define-public (copy-repeat-chord original-chord repeat-chord duration
 692                                   event-types)
 693   "Copies all events in @var{event-types} (be sure to include
 694 @code{rhythmic-events}) from @var{original-chord} over to
 695 @var{repeat-chord} with their articulations filtered as well.  Any
 696 duration is replaced with the specified @var{duration}."
 697   ;; First remove everything from event-types that can already be
 698   ;; found in the repeated chord.  We don't need to look for
 699   ;; articulations on individual events since they can't actually get
 700   ;; into a repeat chord given its input syntax.
 701
 702   (define (keep-element? m)
 703     (any (lambda (t) (music-is-of-type? m t))
 704          event-types))
 705   (define origin (ly:music-property repeat-chord 'origin #f))
 706   (define (set-origin! l)
 707     (if origin
 708         (for-each (lambda (m) (set! (ly:music-property m 'origin) origin)) l))
 709     l)
 710
 711   (for-each
 712    (lambda (field)
 713      (for-each (lambda (e)
 714                  (for-each (lambda (x)
 715                              (set! event-types (delq x event-types)))
 716                            (ly:music-property e 'types)))
 717                (ly:music-property repeat-chord field)))
 718    '(elements articulations))
 719
 720   ;; now treat the elements
 721   (set! (ly:music-property repeat-chord 'elements)
 722         (let ((elts
 723                (set-origin! (ly:music-deep-copy
 724                              (filter keep-element?
 725                                      (ly:music-property original-chord
 726                                                         'elements))))))
 727           (for-each
 728            (lambda (m)
 729              (let ((arts (ly:music-property m 'articulations)))
 730                (if (pair? arts)
 731                    (set! (ly:music-property m 'articulations)
 732                          (set-origin! (filter! keep-element? arts))))
 733                (if (ly:duration? (ly:music-property m 'duration))
 734                    (set! (ly:music-property m 'duration) duration))))
 735            elts)
 736           (append! elts (ly:music-property repeat-chord 'elements))))
 737   (let ((arts (filter keep-element?
 738                       (ly:music-property original-chord
 739                                          'articulations))))
 740     (if (pair? arts)
 741         (set! (ly:music-property repeat-chord 'articulations)
 742               (append!
 743                (set-origin! (ly:music-deep-copy arts))
 744                (ly:music-property repeat-chord 'articulations))))))
 745
 746
 747 (define-public (expand-repeat-chords! event-types music)
 748   "Walks through @var{music} and fills repeated chords (notable by
 749 having a duration in @code{duration}) with the notes from their
 750 respective predecessor chord."
 751   (let loop ((music music) (last-chord #f))
 752     (if (music-is-of-type? music 'event-chord)
 753         (let ((chord-repeat (ly:music-property music 'duration)))
 754           (cond
 755            ((not (ly:duration? chord-repeat))
 756             (if (any (lambda (m) (ly:duration?
 757                                   (ly:music-property m 'duration)))
 758                      (ly:music-property music 'elements))
 759                 music
 760                 last-chord))
 761            (last-chord
 762             (set! (ly:music-property music 'duration) '())
 763             (copy-repeat-chord last-chord music chord-repeat event-types)
 764             music)
 765            (else
 766             (ly:music-warning music (_ "Bad chord repetition"))
 767             #f)))
 768         (let ((elt (ly:music-property music 'element)))
 769           (fold loop (if (ly:music? elt) (loop elt last-chord) last-chord)
 770                 (ly:music-property music 'elements)))))
 771   music)
 772
 773 ;;; splitting chords into voices.
 774 (define (voicify-list lst number)
 775   "Make a list of Musics.
 776
 777 voicify-list :: [ [Music ] ] -> number -> [Music]
 778 LST is a list music-lists.
 779
 780 NUMBER is 0-base, i.e., Voice=1 (upstems) has number 0.
 781 "
 782   (if (null? lst)
 783       '()
 784       (cons (context-spec-music
 785              (make-sequential-music
 786               (list (make-voice-props-set number)
 787                     (make-simultaneous-music (car lst))))
 788              'Bottom  (number->string (1+ number)))
 789             (voicify-list (cdr lst) (1+ number)))))
 790
 791 (define (voicify-chord ch)
 792   "Split the parts of a chord into different Voices using separator"
 793   (let ((es (ly:music-property ch 'elements)))
 794     (set! (ly:music-property  ch 'elements)
 795           (voicify-list (split-list-by-separator es music-separator?) 0))
 796     ch))
 797
 798 (define-public (voicify-music m)
 799   "Recursively split chords that are separated with @code{\\\\}."
 800   (if (not (ly:music? m))
 801       (ly:error (_ "music expected: ~S") m))
 802   (let ((es (ly:music-property m 'elements))
 803         (e (ly:music-property m 'element)))
 804
 805     (if (pair? es)
 806         (set! (ly:music-property m 'elements) (map voicify-music es)))
 807     (if (ly:music? e)
 808         (set! (ly:music-property m 'element)  (voicify-music e)))
 809     (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
 810              (any music-separator? es))
 811         (set! m (context-spec-music (voicify-chord m) 'Staff)))
 812     m))
 813
 814 (define-public (empty-music)
 815   (make-music 'Music))
 816
 817 ;; Make a function that checks score element for being of a specific type.
 818 (define-public (make-type-checker symbol)
 819   (lambda (elt)
 820     (grob::has-interface elt symbol)))
 821
 822 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
 823   (if (func grob)
 824       (set! (ly:grob-property grob sym) val)))
 825
 826
 827 (define-public ((set-output-property grob-name symbol val)  grob grob-c context)
 828   "Usage example:
 829 @code{\\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))}"
 830   (let ((meta (ly:grob-property grob 'meta)))
 831     (if (equal? (assoc-get 'name meta) grob-name)
 832         (set! (ly:grob-property grob symbol) val))))
 833
 834
 835 (define-public (skip->rest mus)
 836   "Replace @var{mus} by @code{RestEvent} of the same duration if it is a
 837 @code{SkipEvent}.  Useful for extracting parts from crowded scores."
 838
 839   (if  (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
 840        (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
 841        mus))
 842
 843
 844 (define-public (music-has-type music type)
 845   (memq type (ly:music-property music 'types)))
 846
 847 (define-public (music-clone music . music-properties)
 848   "Clone @var{music} and set properties according to
 849 @var{music-properties}, a list of alternating property symbols and
 850 values:
 851 @example\n(music-clone start-span 'span-direction STOP)
 852 @end example
 853 Only properties that are not overriden by @var{music-properties} are
 854 actually fully cloned."
 855   (let ((old-props (list-copy (ly:music-mutable-properties music)))
 856         (new-props '())
 857         (m (ly:make-music (ly:prob-immutable-properties music))))
 858     (define (set-props mus-props)
 859       (if (and (not (null? mus-props))
 860                (not (null? (cdr mus-props))))
 861           (begin
 862             (set! old-props (assq-remove! old-props (car mus-props)))
 863             (set! new-props
 864                   (assq-set! new-props
 865                              (car mus-props) (cadr mus-props)))
 866             (set-props (cddr mus-props)))))
 867     (set-props music-properties)
 868     (for-each
 869      (lambda (pair)
 870        (set! (ly:music-property m (car pair))
 871              (ly:music-deep-copy (cdr pair))))
 872      old-props)
 873     (for-each
 874      (lambda (pair)
 875        (set! (ly:music-property m (car pair)) (cdr pair)))
 876      new-props)
 877     m))
 878
 879 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 880 ;; warn for bare chords at start.
 881
 882 (define-public (ly:music-message music msg . rest)
 883   (let ((ip (ly:music-property music 'origin)))
 884     (if (ly:input-location? ip)
 885         (apply ly:input-message ip msg rest)
 886         (apply ly:message msg rest))))
 887
 888 (define-public (ly:music-warning music msg . rest)
 889   (let ((ip (ly:music-property music 'origin)))
 890     (if (ly:input-location? ip)
 891         (apply ly:input-warning ip msg rest)
 892         (apply ly:warning msg rest))))
 893
 894 (define-public (ly:event-warning event msg . rest)
 895   (let ((ip (ly:event-property event 'origin)))
 896     (if (ly:input-location? ip)
 897         (apply ly:input-warning ip msg rest)
 898         (apply ly:warning msg rest))))
 899
 900 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 901 ;;
 902 ;; setting stuff for grace context.
 903 ;;
 904
 905 (define (vector-extend v x)
 906   "Make a new vector consisting of V, with X added to the end."
 907   (let* ((n (vector-length v))
 908          (nv (make-vector (+ n 1) '())))
 909     (vector-move-left! v 0 n nv 0)
 910     (vector-set! nv n x)
 911     nv))
 912
 913 (define (vector-map f v)
 914   "Map F over V.  This function returns nothing."
 915   (do ((n (vector-length v))
 916        (i 0 (+ i 1)))
 917       ((>= i n))
 918     (f (vector-ref v i))))
 919
 920 (define (vector-reverse-map f v)
 921   "Map F over V, N to 0 order.  This function returns nothing."
 922   (do ((i (- (vector-length v) 1) (- i 1)))
 923       ((< i 0))
 924     (f (vector-ref v i))))
 925
 926 (define-public (add-grace-property context-name grob sym val)
 927   "Set @var{sym}=@var{val} for @var{grob} in @var{context-name}."
 928   (define (set-prop context)
 929     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 930            (current (ly:context-property where 'graceSettings))
 931            (new-settings (append current
 932                                  (list (list context-name grob sym val)))))
 933       (ly:context-set-property! where 'graceSettings new-settings)))
 934   (context-spec-music (make-apply-context set-prop) 'Voice))
 935
 936 (define-public (remove-grace-property context-name grob sym)
 937   "Remove all @var{sym} for @var{grob} in @var{context-name}."
 938   (define (sym-grob-context? property sym grob context-name)
 939     (and (eq? (car property) context-name)
 940          (eq? (cadr property) grob)
 941          (eq? (caddr property) sym)))
 942   (define (delete-prop context)
 943     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 944            (current (ly:context-property where 'graceSettings))
 945            (prop-settings (filter
 946                            (lambda(x) (sym-grob-context? x sym grob context-name))
 947                            current))
 948            (new-settings current))
 949       (for-each (lambda(x)
 950                   (set! new-settings (delete x new-settings)))
 951                 prop-settings)
 952       (ly:context-set-property! where 'graceSettings new-settings)))
 953   (context-spec-music (make-apply-context delete-prop) 'Voice))
 954
 955
 956
 957 (defmacro-public def-grace-function (start stop . docstring)
 958   "Helper macro for defining grace music"
 959   `(define-music-function (parser location music) (ly:music?)
 960      ,@docstring
 961      (make-music 'GraceMusic
 962                  'origin location
 963                  'element (make-music 'SequentialMusic
 964                                       'elements (list (ly:music-deep-copy ,start)
 965                                                       music
 966                                                       (ly:music-deep-copy ,stop))))))
 967
 968 (defmacro-public define-syntax-function (type args signature . body)
 969   "Helper macro for `ly:make-music-function'.
 970 Syntax:
 971   (define-syntax-function result-type? (parser location arg1 arg2 ...) (arg1-type arg2-type ...)
 972     ...function body...)
 973
 974 argX-type can take one of the forms @code{predicate?} for mandatory
 975 arguments satisfying the predicate, @code{(predicate?)} for optional
 976 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
 977 value)}} for optional parameters with a specified default
 978 value (evaluated at definition time).  An optional parameter can be
 979 omitted in a call only when it can't get confused with a following
 980 parameter of different type.
 981
 982 Predicates with syntactical significance are @code{ly:pitch?},
 983 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
 984 predicates require the parameter to be entered as Scheme expression.
 985
 986 @code{result-type?} can specify a default in the same manner as
 987 predicates, to be used in case of a type error in arguments or
 988 result."
 989
 990   (set! signature (map (lambda (pred)
 991                          (if (pair? pred)
 992                              `(cons ,(car pred)
 993                                     ,(and (pair? (cdr pred)) (cadr pred)))
 994                              pred))
 995                        (cons type signature)))
 996   (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
 997       ;; When the music function definition contains a i10n doc string,
 998       ;; (_i "doc string"), keep the literal string only
 999       (let ((docstring (cadar body))
1000             (body (cdr body)))
1001         `(ly:make-music-function (list ,@signature)
1002                                  (lambda ,args
1003                                    ,docstring
1004                                    ,@body)))
1005       `(ly:make-music-function (list ,@signature)
1006                                (lambda ,args
1007                                  ,@body))))
1008
1009 (defmacro-public define-music-function rest
1010   "Defining macro returning music functions.
1011 Syntax:
1012   (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1013     ...function body...)
1014
1015 argX-type can take one of the forms @code{predicate?} for mandatory
1016 arguments satisfying the predicate, @code{(predicate?)} for optional
1017 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1018 value)}} for optional parameters with a specified default
1019 value (evaluated at definition time).  An optional parameter can be
1020 omitted in a call only when it can't get confused with a following
1021 parameter of different type.
1022
1023 Predicates with syntactical significance are @code{ly:pitch?},
1024 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
1025 predicates require the parameter to be entered as Scheme expression.
1026
1027 Must return a music expression.  The @code{origin} is automatically
1028 set to the @code{location} parameter."
1029
1030   `(define-syntax-function (ly:music? (make-music 'Music 'void #t)) ,@rest))
1031
1032
1033 (defmacro-public define-scheme-function rest
1034   "Defining macro returning Scheme functions.
1035 Syntax:
1036   (define-scheme-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1037     ...function body...)
1038
1039 argX-type can take one of the forms @code{predicate?} for mandatory
1040 arguments satisfying the predicate, @code{(predicate?)} for optional
1041 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1042 value)}} for optional parameters with a specified default
1043 value (evaluated at definition time).  An optional parameter can be
1044 omitted in a call only when it can't get confused with a following
1045 parameter of different type.
1046
1047 Predicates with syntactical significance are @code{ly:pitch?},
1048 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
1049 predicates require the parameter to be entered as Scheme expression.
1050
1051 Can return arbitrary expressions.  If a music expression is returned,
1052 its @code{origin} is automatically set to the @code{location}
1053 parameter."
1054
1055   `(define-syntax-function scheme? ,@rest))
1056
1057 (defmacro-public define-void-function rest
1058   "This defines a Scheme function like @code{define-scheme-function} with
1059 void return value (i.e., what most Guile functions with `unspecified'
1060 value return).  Use this when defining functions for executing actions
1061 rather than returning values, to keep Lilypond from trying to interpret
1062 the return value."
1063   `(define-syntax-function (void? *unspecified*) ,@rest *unspecified*))
1064
1065 (defmacro-public define-event-function rest
1066   "Defining macro returning event functions.
1067 Syntax:
1068   (define-event-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1069     ...function body...)
1070
1071 argX-type can take one of the forms @code{predicate?} for mandatory
1072 arguments satisfying the predicate, @code{(predicate?)} for optional
1073 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1074 value)}} for optional parameters with a specified default
1075 value (evaluated at definition time).  An optional parameter can be
1076 omitted in a call only when it can't get confused with a following
1077 parameter of different type.
1078
1079 Predicates with syntactical significance are @code{ly:pitch?},
1080 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
1081 predicates require the parameter to be entered as Scheme expression.
1082
1083 Must return an event expression.  The @code{origin} is automatically
1084 set to the @code{location} parameter."
1085
1086   `(define-syntax-function (ly:event? (make-music 'Event 'void #t)) ,@rest))
1087
1088 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1089
1090 (define-public (cue-substitute quote-music)
1091   "Must happen after @code{quote-substitute}."
1092
1093   (if (vector? (ly:music-property quote-music 'quoted-events))
1094       (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
1095              (clef (ly:music-property quote-music 'quoted-music-clef #f))
1096              (main-voice (case dir ((1) 1) ((-1) 0) (else #f)))
1097              (cue-voice (and main-voice (- 1 main-voice)))
1098              (cue-type (ly:music-property quote-music 'quoted-context-type #f))
1099              (cue-id (ly:music-property quote-music 'quoted-context-id))
1100              (main-music (ly:music-property quote-music 'element))
1101              (return-value quote-music))
1102
1103         (if main-voice
1104             (set! (ly:music-property quote-music 'element)
1105                   (make-sequential-music
1106                    (list
1107                     (make-voice-props-override main-voice)
1108                     main-music
1109                     (make-voice-props-revert)))))
1110
1111         ;; if we have stem dirs, change both quoted and main music
1112         ;; to have opposite stems.
1113
1114         ;; cannot context-spec Quote-music, since context
1115         ;; for the quotes is determined in the iterator.
1116
1117         (make-sequential-music
1118          (delq! #f
1119                 (list
1120                  (and clef (make-cue-clef-set clef))
1121                  (and cue-type cue-voice
1122                       (context-spec-music
1123                        (make-voice-props-override cue-voice)
1124                        cue-type cue-id))
1125                  quote-music
1126                  (and cue-type cue-voice
1127                       (context-spec-music
1128                        (make-voice-props-revert)
1129                        cue-type cue-id))
1130                  (and clef (make-cue-clef-unset))))))
1131       quote-music))
1132
1133 (define-public ((quote-substitute quote-tab) music)
1134   (let* ((quoted-name (ly:music-property music 'quoted-music-name))
1135          (quoted-vector (and (string? quoted-name)
1136                              (hash-ref quote-tab quoted-name #f))))
1137
1138
1139     (if (string? quoted-name)
1140         (if (vector? quoted-vector)
1141             (begin
1142               (set! (ly:music-property music 'quoted-events) quoted-vector)
1143               (set! (ly:music-property music 'iterator-ctor)
1144                     ly:quote-iterator::constructor))
1145             (ly:music-warning music (ly:format (_ "cannot find quoted music: `~S'") quoted-name))))
1146     music))
1147
1148
1149 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1150 ;; switch it on here, so parsing and init isn't checked (too slow!)
1151 ;;
1152 ;; automatic music transformations.
1153
1154 (define (switch-on-debugging m)
1155   (if (defined? 'set-debug-cell-accesses!)
1156       (set-debug-cell-accesses! 15000))
1157   m)
1158
1159 (define (music-check-error music)
1160   (define found #f)
1161   (define (signal m)
1162     (if (and (ly:music? m)
1163              (eq? (ly:music-property m 'error-found) #t))
1164         (set! found #t)))
1165
1166   (for-each signal (ly:music-property music 'elements))
1167   (signal (ly:music-property music 'element))
1168
1169   (if found
1170       (set! (ly:music-property music 'error-found) #t))
1171   music)
1172
1173 (define (precompute-music-length music)
1174   (set! (ly:music-property music 'length)
1175         (ly:music-length music))
1176   music)
1177
1178 (define-public (make-duration-of-length moment)
1179   "Make duration of the given @code{moment} length."
1180   (ly:make-duration 0 0
1181                     (ly:moment-main-numerator moment)
1182                     (ly:moment-main-denominator moment)))
1183
1184 (define (make-skipped moment bool)
1185   "Depending on BOOL, set or unset skipTypesetting,
1186 then make SkipMusic of the given MOMENT length, and
1187 then revert skipTypesetting."
1188   (make-sequential-music
1189    (list
1190     (context-spec-music (make-property-set 'skipTypesetting bool)
1191                         'Score)
1192     (make-music 'SkipMusic 'duration
1193                 (make-duration-of-length moment))
1194     (context-spec-music (make-property-set 'skipTypesetting (not bool))
1195                         'Score))))
1196
1197 (define (skip-as-needed music parser)
1198   "Replace MUSIC by
1199  << {  \\set skipTypesetting = ##f
1200  LENGTHOF(\\showFirstLength)
1201  \\set skipTypesetting = ##t
1202  LENGTHOF(\\showLastLength) }
1203  MUSIC >>
1204  if appropriate.
1205
1206  When only showFirstLength is set,
1207  the 'length property of the music is
1208  overridden to speed up compiling."
1209   (let*
1210       ((show-last (ly:parser-lookup parser 'showLastLength))
1211        (show-first (ly:parser-lookup parser 'showFirstLength))
1212        (show-last-length (and (ly:music? show-last)
1213                               (ly:music-length show-last)))
1214        (show-first-length (and (ly:music? show-first)
1215                                (ly:music-length show-first)))
1216        (orig-length (ly:music-length music)))
1217
1218     ;;FIXME: if using either showFirst- or showLastLength,
1219     ;; make sure that skipBars is not set.
1220
1221     (cond
1222
1223      ;; both properties may be set.
1224      ((and show-first-length show-last-length)
1225       (let
1226           ((skip-length (ly:moment-sub orig-length show-last-length)))
1227         (make-simultaneous-music
1228          (list
1229           (make-sequential-music
1230            (list
1231             (make-skipped skip-length #t)
1232             ;; let's draw a separator between the beginning and the end
1233             (context-spec-music (make-property-set 'whichBar "||")
1234                                 'Timing)))
1235           (make-skipped show-first-length #f)
1236           music))))
1237
1238      ;; we may only want to print the last length
1239      (show-last-length
1240       (let
1241           ((skip-length (ly:moment-sub orig-length show-last-length)))
1242         (make-simultaneous-music
1243          (list
1244           (make-skipped skip-length #t)
1245           music))))
1246
1247      ;; we may only want to print the beginning; in this case
1248      ;; only the first length will be processed (much faster).
1249      (show-first-length
1250       ;; the first length must not exceed the original length.
1251       (if (ly:moment<? show-first-length orig-length)
1252           (set! (ly:music-property music 'length)
1253                 show-first-length))
1254       music)
1255
1256      (else music))))
1257
1258
1259 (define-public toplevel-music-functions
1260   (list
1261    (lambda (music parser) (expand-repeat-chords!
1262                            (cons 'rhythmic-event
1263                                  (ly:parser-lookup parser '$chord-repeat-events))
1264                            music))
1265    (lambda (music parser) (voicify-music music))
1266    (lambda (x parser) (music-map music-check-error x))
1267    (lambda (x parser) (music-map precompute-music-length x))
1268    (lambda (music parser)
1269
1270      (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes))  music))
1271
1272    ;; switch-on-debugging
1273    (lambda (x parser) (music-map cue-substitute x))
1274
1275    (lambda (x parser)
1276      (skip-as-needed x parser)
1277      )))
1278
1279 ;;;;;;;;;;
1280 ;;; general purpose music functions
1281
1282 (define (shift-octave pitch octave-shift)
1283   (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
1284   (ly:make-pitch
1285    (+ (ly:pitch-octave pitch) octave-shift)
1286    (ly:pitch-notename pitch)
1287    (ly:pitch-alteration pitch)))
1288
1289
1290 ;;;;;;;;;;;;;;;;;
1291 ;; lyrics
1292
1293 (define (apply-durations lyric-music durations)
1294   (define (apply-duration music)
1295     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
1296              (ly:duration?  (ly:music-property music 'duration)))
1297         (begin
1298           (set! (ly:music-property music 'duration) (car durations))
1299           (set! durations (cdr durations)))))
1300
1301   (music-map apply-duration lyric-music))
1302
1303
1304 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1305 ;; accidentals
1306
1307 (define (recent-enough? bar-number alteration-def laziness)
1308   (or (number? alteration-def)
1309       (equal? laziness #t)
1310       (<= bar-number (+ (cadr alteration-def) laziness))))
1311
1312 (define (accidental-invalid? alteration-def)
1313   "Checks an alteration entry for being invalid.
1314
1315 Non-key alterations are invalidated when tying into the next bar or
1316 when there is a clef change, since neither repetition nor cancellation
1317 can be omitted when the same note occurs again.
1318
1319 Returns @code{#f} or the reason for the invalidation, a symbol."
1320   (let* ((def (if (pair? alteration-def)
1321                   (car alteration-def)
1322                   alteration-def)))
1323     (and (symbol? def) def)))
1324
1325 (define (extract-alteration alteration-def)
1326   (cond ((number? alteration-def)
1327          alteration-def)
1328         ((pair? alteration-def)
1329          (car alteration-def))
1330         (else 0)))
1331
1332 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1333   "Checks the need for an accidental and a @q{restore} accidental against
1334 @code{localKeySignature}.  The @var{laziness} is the number of measures
1335 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1336 only cancel accidentals in the same measure; if @var{laziness} is three,
1337 we cancel accidentals up to three measures after they first appear.
1338 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1339 specifies whether accidentals should be canceled in different octaves."
1340   (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1341                               ((equal? octaveness 'same-octave) #f)
1342                               (else
1343                                (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1344                                (ly:warning (_ "Defaulting to 'any-octave."))
1345                                #t)))
1346          (key-sig (ly:context-property context 'keySignature))
1347          (local-key-sig (ly:context-property context 'localKeySignature))
1348          (notename (ly:pitch-notename pitch))
1349          (octave (ly:pitch-octave pitch))
1350          (pitch-handle (cons octave notename))
1351          (need-restore #f)
1352          (need-accidental #f)
1353          (previous-alteration #f)
1354          (from-other-octaves #f)
1355          (from-same-octave (assoc-get pitch-handle local-key-sig))
1356          (from-key-sig (or (assoc-get notename local-key-sig)
1357
1358                            ;; If no key signature match is found from localKeySignature, we may have a custom
1359                            ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1360                            ;; instead of (pitch . alteration).  Since this type cannot coexist with entries in
1361                            ;; localKeySignature, try extracting from keySignature instead.
1362                            (assoc-get pitch-handle key-sig))))
1363
1364     ;; loop through localKeySignature to search for a notename match from other octaves
1365     (let loop ((l local-key-sig))
1366       (if (pair? l)
1367           (let ((entry (car l)))
1368             (if (and (pair? (car entry))
1369                      (= (cdar entry) notename))
1370                 (set! from-other-octaves (cdr entry))
1371                 (loop (cdr l))))))
1372
1373     ;; find previous alteration-def for comparison with pitch
1374     (cond
1375      ;; from same octave?
1376      ((and (not ignore-octave)
1377            from-same-octave
1378            (recent-enough? barnum from-same-octave laziness))
1379       (set! previous-alteration from-same-octave))
1380
1381      ;; from any octave?
1382      ((and ignore-octave
1383            from-other-octaves
1384            (recent-enough? barnum from-other-octaves laziness))
1385       (set! previous-alteration from-other-octaves))
1386
1387      ;; not recent enough, extract from key signature/local key signature
1388      (from-key-sig
1389       (set! previous-alteration from-key-sig)))
1390
1391     (if (accidental-invalid? previous-alteration)
1392         (set! need-accidental #t)
1393
1394         (let* ((prev-alt (extract-alteration previous-alteration))
1395                (this-alt (ly:pitch-alteration pitch)))
1396
1397           (if (not (= this-alt prev-alt))
1398               (begin
1399                 (set! need-accidental #t)
1400                 (if (and (not (= this-alt 0))
1401                          (and (< (abs this-alt) (abs prev-alt))
1402                               (> (* prev-alt this-alt) 0)))
1403                     (set! need-restore #t))))))
1404
1405     (cons need-restore need-accidental)))
1406
1407 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1408   "Create an accidental rule that makes its decision based on the octave of
1409 the note and a laziness value.
1410
1411 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1412 defines whether the rule should respond to accidental changes in other
1413 octaves than the current.  @code{'same-octave} is the normal way to typeset
1414 accidentals -- an accidental is made if the alteration is different from the
1415 last active pitch in the same octave.  @code{'any-octave} looks at the last
1416 active pitch in any octave.
1417
1418 @var{laziness} states over how many bars an accidental should be remembered.
1419 @code{0}@tie{}is the default -- accidental lasts over 0@tie{}bar lines, that
1420 is, to the end of current measure.  A positive integer means that the
1421 accidental lasts over that many bar lines.  @w{@code{-1}} is `forget
1422 immediately', that is, only look at key signature.  @code{#t} is `forever'."
1423
1424   (check-pitch-against-signature context pitch barnum laziness octaveness))
1425
1426 (define (key-entry-notename entry)
1427   "Return the pitch of an @var{entry} in @code{localKeySignature}.
1428 The @samp{car} of the entry is either of the form @code{notename} or
1429 of the form @code{(octave . notename)}.  The latter form is used for special
1430 key signatures or to indicate an explicit accidental.
1431
1432 The @samp{cdr} of the entry is either a rational @code{alter} indicating
1433 a key signature alteration, or of the form
1434 @code{(alter . (barnum . measurepos))} indicating an alteration caused by
1435 an accidental in music."
1436   (if (pair? (car entry))
1437       (cdar entry)
1438       (car entry)))
1439
1440 (define (key-entry-octave entry)
1441   "Return the octave of an entry in @code{localKeySignature}
1442 or @code{#f} if the entry does not have an octave.
1443 See @code{key-entry-notename} for details."
1444   (and (pair? (car entry)) (caar entry)))
1445
1446 (define (key-entry-bar-number entry)
1447   "Return the bar number of an entry in @code{localKeySignature}
1448 or @code {#f} if the entry does not have a bar number.
1449 See @code{key-entry-notename} for details."
1450   (and (pair? (cdr entry)) (caddr entry)))
1451
1452 (define (key-entry-measure-position entry)
1453   "Return the measure position of an entry in @code{localKeySignature}
1454 or @code {#f} if the entry does not have a measure position.
1455 See @code{key-entry-notename} for details."
1456   (and (pair? (cdr entry)) (cdddr entry)))
1457
1458 (define (key-entry-alteration entry)
1459   "Return the alteration of an entry in localKeySignature.
1460
1461 For convenience, returns @code{0} if entry is @code{#f}."
1462   (if entry
1463       (if (number? (cdr entry))
1464           (cdr entry)
1465           (cadr entry))
1466       0))
1467
1468 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1469   "Return the first entry in @var{keysig} that matches @var{pitch}.
1470 @var{accept-global} states whether key signature entries should be included.
1471 @var{accept-local} states whether local accidentals should be included.
1472 If no matching entry is found, @var{#f} is returned."
1473   (and (pair? keysig)
1474        (let* ((entry (car keysig))
1475               (entryoct (key-entry-octave entry))
1476               (entrynn (key-entry-notename entry))
1477               (nn (ly:pitch-notename pitch)))
1478          (if (and (equal? nn entrynn)
1479                   (or (not entryoct)
1480                       (= entryoct (ly:pitch-octave pitch)))
1481                   (if (key-entry-bar-number entry)
1482                       accept-local
1483                       accept-global))
1484              entry
1485              (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))))
1486
1487 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1488   "An accidental rule that typesets an accidental if it differs from the
1489 key signature @emph{and} does not directly follow a note on the same
1490 staff line.  This rule should not be used alone because it does neither
1491 look at bar lines nor different accidentals at the same note name."
1492   (let* ((keysig (ly:context-property context 'localKeySignature))
1493          (entry (find-pitch-entry keysig pitch #t #t)))
1494     (if (not entry)
1495         (cons #f #f)
1496         (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1497                (key-acc (key-entry-alteration global-entry))
1498                (acc (ly:pitch-alteration pitch))
1499                (entrymp (key-entry-measure-position entry))
1500                (entrybn (key-entry-bar-number entry)))
1501           (cons #f (not (or (equal? acc key-acc)
1502                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1503
1504 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1505   "An accidental rule that typesets a cautionary accidental if it is
1506 included in the key signature @emph{and} does not directly follow a note
1507 on the same staff line."
1508   (let* ((keysig (ly:context-property context 'localKeySignature))
1509          (entry (find-pitch-entry keysig pitch #t #t)))
1510     (if (not entry)
1511         (cons #f #f)
1512         (let* ((entrymp (key-entry-measure-position entry))
1513                (entrybn (key-entry-bar-number entry)))
1514           (cons #f (not (and (equal? entrybn barnum) (equal? entrymp measurepos))))))))
1515
1516 (define-public (set-accidentals-properties extra-natural
1517                                            auto-accs auto-cauts
1518                                            context)
1519   (context-spec-music
1520    (make-sequential-music
1521     (append (if (boolean? extra-natural)
1522                 (list (make-property-set 'extraNatural extra-natural))
1523                 '())
1524             (list (make-property-set 'autoAccidentals auto-accs)
1525                   (make-property-set 'autoCautionaries auto-cauts))))
1526    context))
1527
1528 (define-public (set-accidental-style style . rest)
1529   "Set accidental style to @var{style}.  Optionally take a context
1530 argument, e.g. @code{'Staff} or @code{'Voice}.  The context defaults
1531 to @code{Staff}, except for piano styles, which use @code{GrandStaff}
1532 as a context."
1533   (let ((context (if (pair? rest)
1534                      (car rest) 'Staff))
1535         (pcontext (if (pair? rest)
1536                       (car rest) 'GrandStaff)))
1537     (cond
1538      ;; accidentals as they were common in the 18th century.
1539      ((equal? style 'default)
1540       (set-accidentals-properties #t
1541                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1542                                   '()
1543                                   context))
1544      ;; accidentals from one voice do NOT get canceled in other voices
1545      ((equal? style 'voice)
1546       (set-accidentals-properties #t
1547                                   `(Voice ,(make-accidental-rule 'same-octave 0))
1548                                   '()
1549                                   context))
1550      ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1551      ;; This includes all the default accidentals, but accidentals also needs canceling
1552      ;; in other octaves and in the next measure.
1553      ((equal? style 'modern)
1554       (set-accidentals-properties #f
1555                                   `(Staff ,(make-accidental-rule 'same-octave 0)
1556                                           ,(make-accidental-rule 'any-octave 0)
1557                                           ,(make-accidental-rule 'same-octave 1))
1558                                   '()
1559                                   context))
1560      ;; the accidentals that Stone adds to the old standard as cautionaries
1561      ((equal? style 'modern-cautionary)
1562       (set-accidentals-properties #f
1563                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1564                                   `(Staff ,(make-accidental-rule 'any-octave 0)
1565                                           ,(make-accidental-rule 'same-octave 1))
1566                                   context))
1567      ;; same as modern, but accidentals different from the key signature are always
1568      ;; typeset - unless they directly follow a note of the same pitch.
1569      ((equal? style 'neo-modern)
1570       (set-accidentals-properties #f
1571                                   `(Staff ,(make-accidental-rule 'same-octave 0)
1572                                           ,(make-accidental-rule 'any-octave 0)
1573                                           ,(make-accidental-rule 'same-octave 1)
1574                                           ,neo-modern-accidental-rule)
1575                                   '()
1576                                   context))
1577      ((equal? style 'neo-modern-cautionary)
1578       (set-accidentals-properties #f
1579                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1580                                   `(Staff ,(make-accidental-rule 'any-octave 0)
1581                                           ,(make-accidental-rule 'same-octave 1)
1582                                           ,neo-modern-accidental-rule)
1583                                   context))
1584      ((equal? style 'neo-modern-voice)
1585       (set-accidentals-properties #f
1586                                   `(Voice ,(make-accidental-rule 'same-octave 0)
1587                                           ,(make-accidental-rule 'any-octave 0)
1588                                           ,(make-accidental-rule 'same-octave 1)
1589                                           ,neo-modern-accidental-rule
1590                                           Staff ,(make-accidental-rule 'same-octave 0)
1591                                           ,(make-accidental-rule 'any-octave 0)
1592                                           ,(make-accidental-rule 'same-octave 1)
1593                                           ,neo-modern-accidental-rule)
1594                                   '()
1595                                   context))
1596      ((equal? style 'neo-modern-voice-cautionary)
1597       (set-accidentals-properties #f
1598                                   `(Voice ,(make-accidental-rule 'same-octave 0))
1599                                   `(Voice ,(make-accidental-rule 'any-octave 0)
1600                                           ,(make-accidental-rule 'same-octave 1)
1601                                           ,neo-modern-accidental-rule
1602                                           Staff ,(make-accidental-rule 'same-octave 0)
1603                                           ,(make-accidental-rule 'any-octave 0)
1604                                           ,(make-accidental-rule 'same-octave 1)
1605                                           ,neo-modern-accidental-rule)
1606                                   context))
1607      ;; Accidentals as they were common in dodecaphonic music with no tonality.
1608      ;; Each note gets one accidental.
1609      ((equal? style 'dodecaphonic)
1610       (set-accidentals-properties #f
1611                                   `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1612                                   '()
1613                                   context))
1614      ;; Multivoice accidentals to be read both by musicians playing one voice
1615      ;; and musicians playing all voices.
1616      ;; Accidentals are typeset for each voice, but they ARE canceled across voices.
1617      ((equal? style 'modern-voice)
1618       (set-accidentals-properties  #f
1619                                    `(Voice ,(make-accidental-rule 'same-octave 0)
1620                                            ,(make-accidental-rule 'any-octave 0)
1621                                            ,(make-accidental-rule 'same-octave 1)
1622                                            Staff ,(make-accidental-rule 'same-octave 0)
1623                                            ,(make-accidental-rule 'any-octave 0)
1624                                            ,(make-accidental-rule 'same-octave 1))
1625                                    '()
1626                                    context))
1627      ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1628      ;; as cautionaries
1629      ((equal? style 'modern-voice-cautionary)
1630       (set-accidentals-properties #f
1631                                   `(Voice ,(make-accidental-rule 'same-octave 0))
1632                                   `(Voice ,(make-accidental-rule 'any-octave 0)
1633                                           ,(make-accidental-rule 'same-octave 1)
1634                                           Staff ,(make-accidental-rule 'same-octave 0)
1635                                           ,(make-accidental-rule 'any-octave 0)
1636                                           ,(make-accidental-rule 'same-octave 1))
1637                                   context))
1638      ;; stone's suggestions for accidentals on grand staff.
1639      ;; Accidentals are canceled across the staves in the same grand staff as well
1640      ((equal? style 'piano)
1641       (set-accidentals-properties #f
1642                                   `(Staff ,(make-accidental-rule 'same-octave 0)
1643                                           ,(make-accidental-rule 'any-octave 0)
1644                                           ,(make-accidental-rule 'same-octave 1)
1645                                           GrandStaff
1646                                           ,(make-accidental-rule 'any-octave 0)
1647                                           ,(make-accidental-rule 'same-octave 1))
1648                                   '()
1649                                   pcontext))
1650      ((equal? style 'piano-cautionary)
1651       (set-accidentals-properties #f
1652                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1653                                   `(Staff ,(make-accidental-rule 'any-octave 0)
1654                                           ,(make-accidental-rule 'same-octave 1)
1655                                           GrandStaff
1656                                           ,(make-accidental-rule 'any-octave 0)
1657                                           ,(make-accidental-rule 'same-octave 1))
1658                                   pcontext))
1659
1660      ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1661      ;; tones specified by the key signature.
1662      ((equal? style 'teaching)
1663       (set-accidentals-properties #f
1664                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1665                                   `(Staff ,(make-accidental-rule 'same-octave 1)
1666                                           ,teaching-accidental-rule)
1667                                   context))
1668
1669      ;; do not set localKeySignature when a note alterated differently from
1670      ;; localKeySignature is found.
1671      ;; Causes accidentals to be printed at every note instead of
1672      ;; remembered for the duration of a measure.
1673      ;; accidentals not being remembered, causing accidentals always to
1674      ;; be typeset relative to the time signature
1675      ((equal? style 'forget)
1676       (set-accidentals-properties '()
1677                                   `(Staff ,(make-accidental-rule 'same-octave -1))
1678                                   '()
1679                                   context))
1680      ;; Do not reset the key at the start of a measure.  Accidentals will be
1681      ;; printed only once and are in effect until overridden, possibly many
1682      ;; measures later.
1683      ((equal? style 'no-reset)
1684       (set-accidentals-properties '()
1685                                   `(Staff ,(make-accidental-rule 'same-octave #t))
1686                                   '()
1687                                   context))
1688      (else
1689       (ly:warning (_ "unknown accidental style: ~S") style)
1690       (make-sequential-music '())))))
1691
1692 (define-public (invalidate-alterations context)
1693   "Invalidate alterations in @var{context}.
1694
1695 Elements of @code{'localKeySignature} corresponding to local
1696 alterations of the key signature have the form
1697 @code{'((octave . notename) . (alter barnum . measurepos))}.
1698 Replace them with a version where @code{alter} is set to @code{'clef}
1699 to force a repetition of accidentals.
1700
1701 Entries that conform with the current key signature are not invalidated."
1702   (let* ((keysig (ly:context-property context 'keySignature)))
1703     (set! (ly:context-property context 'localKeySignature)
1704           (map-in-order
1705            (lambda (entry)
1706              (let* ((localalt (key-entry-alteration entry)))
1707                (if (or (accidental-invalid? localalt)
1708                        (not (key-entry-bar-number entry))
1709                        (= localalt
1710                           (key-entry-alteration
1711                            (find-pitch-entry
1712                             keysig
1713                             (ly:make-pitch (key-entry-octave entry)
1714                                            (key-entry-notename entry)
1715                                            0)
1716                             #t #t))))
1717                    entry
1718                    (cons (car entry) (cons 'clef (cddr entry))))))
1719            (ly:context-property context 'localKeySignature)))))
1720
1721 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1722
1723 (define-public (skip-of-length mus)
1724   "Create a skip of exactly the same length as @var{mus}."
1725   (let* ((skip
1726           (make-music
1727            'SkipEvent
1728            'duration (ly:make-duration 0 0))))
1729
1730     (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1731
1732 (define-public (mmrest-of-length mus)
1733   "Create a multi-measure rest of exactly the same length as @var{mus}."
1734
1735   (let* ((skip
1736           (make-multi-measure-rest
1737            (ly:make-duration 0 0) '())))
1738     (ly:music-compress skip (ly:music-length mus))
1739     skip))
1740
1741 (define-public (pitch-of-note event-chord)
1742   (let ((evs (filter (lambda (x)
1743                        (music-has-type x 'note-event))
1744                      (ly:music-property event-chord 'elements))))
1745
1746     (and (pair? evs)
1747          (ly:music-property (car evs) 'pitch))))
1748
1749 (define-public (duration-of-note event-chord)
1750   (cond
1751    ((pair? event-chord)
1752     (or (duration-of-note (car event-chord))
1753         (duration-of-note (cdr event-chord))))
1754    ((ly:music? event-chord)
1755     (let ((dur (ly:music-property event-chord 'duration)))
1756       (if (ly:duration? dur)
1757           dur
1758           (duration-of-note (ly:music-property event-chord 'elements)))))
1759    (else #f)))
1760
1761 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1762
1763 (define-public (map-some-music map? music)
1764   "Walk through @var{music}, transform all elements calling @var{map?}
1765 and only recurse if this returns @code{#f}.  @code{elements} or
1766 @code{articulations} that are not music expressions are discarded:
1767 this allows some amount of filtering.
1768
1769 @code{map-some-music} may overwrite the original @var{music}."
1770   (let loop ((music music))
1771     (or (map? music)
1772         (let ((elt (ly:music-property music 'element))
1773               (elts (ly:music-property music 'elements))
1774               (arts (ly:music-property music 'articulations)))
1775           (if (ly:music? elt)
1776               (set! (ly:music-property music 'element)
1777                     (loop elt)))
1778           (if (pair? elts)
1779               (set! (ly:music-property music 'elements)
1780                     (filter! ly:music? (map! loop elts))))
1781           (if (pair? arts)
1782               (set! (ly:music-property music 'articulations)
1783                     (filter! ly:music? (map! loop arts))))
1784           music))))
1785
1786 (define-public (for-some-music stop? music)
1787   "Walk through @var{music}, process all elements calling @var{stop?}
1788 and only recurse if this returns @code{#f}."
1789   (let loop ((music music))
1790     (if (not (stop? music))
1791         (let ((elt (ly:music-property music 'element)))
1792           (if (ly:music? elt)
1793               (loop elt))
1794           (for-each loop (ly:music-property music 'elements))
1795           (for-each loop (ly:music-property music 'articulations))))))
1796
1797 (define-public (fold-some-music pred? proc init music)
1798   "This works recursively on music like @code{fold} does on a list,
1799 calling @samp{(@var{pred?} music)} on every music element.  If
1800 @code{#f} is returned for an element, it is processed recursively
1801 with the same initial value of @samp{previous}, otherwise
1802 @samp{(@var{proc} music previous)} replaces @samp{previous}
1803 and no recursion happens.
1804 The top @var{music} is processed using @var{init} for @samp{previous}."
1805   (let loop ((music music) (previous init))
1806     (if (pred? music)
1807         (proc music previous)
1808         (fold loop
1809               (fold loop
1810                     (let ((elt (ly:music-property music 'element)))
1811                       (if (null? elt)
1812                           previous
1813                           (loop elt previous)))
1814                     (ly:music-property music 'elements))
1815               (ly:music-property music 'articulations)))))
1816
1817 (define-public (extract-music music pred?)
1818   "Return a flat list of all music matching @var{pred?} inside of
1819 @var{music}, not recursing into matches themselves."
1820   (reverse! (fold-some-music pred? cons '() music)))
1821
1822 (define-public (extract-named-music music music-name)
1823   "Return a flat list of all music named @var{music-name} (either a
1824 single event symbol or a list of alternatives) inside of @var{music},
1825 not recursing into matches themselves."
1826   (extract-music
1827    music
1828    (if (cheap-list? music-name)
1829        (lambda (m) (memq (ly:music-property m 'name) music-name))
1830        (lambda (m) (eq? (ly:music-property m 'name) music-name)))))
1831
1832 (define-public (extract-typed-music music type)
1833   "Return a flat list of all music with @var{type} (either a single
1834 type symbol or a list of alternatives) inside of @var{music}, not
1835 recursing into matches themselves."
1836   (extract-music
1837    music
1838    (if (cheap-list? type)
1839        (lambda (m)
1840          (any (lambda (t) (music-is-of-type? m t)) type))
1841        (lambda (m) (music-is-of-type? m type)))))
1842
1843 (define*-public (event-chord-wrap! music #:optional parser)
1844   "Wrap isolated rhythmic events and non-postevent events in
1845 @var{music} inside of an @code{EventChord}.  If the optional
1846 @var{parser} argument is given, chord repeats @samp{q} are expanded
1847 using the default settings.  Otherwise, you need to cater for them
1848 yourself."
1849   (map-some-music
1850    (lambda (m)
1851      (cond ((music-is-of-type? m 'event-chord)
1852             (if (pair? (ly:music-property m 'articulations))
1853                 (begin
1854                   (set! (ly:music-property m 'elements)
1855                         (append (ly:music-property m 'elements)
1856                                 (ly:music-property m 'articulations)))
1857                   (set! (ly:music-property m 'articulations) '())))
1858             m)
1859            ((music-is-of-type? m 'rhythmic-event)
1860             (let ((arts (ly:music-property m 'articulations)))
1861               (if (pair? arts)
1862                   (set! (ly:music-property m 'articulations) '()))
1863               (make-event-chord (cons m arts))))
1864            (else #f)))
1865    (if parser
1866        (expand-repeat-chords!
1867         (cons 'rhythmic-event
1868               (ly:parser-lookup parser '$chord-repeat-events))
1869         music)
1870        music)))
1871
1872 (define-public (event-chord-notes event-chord)
1873   "Return a list of all notes from @var{event-chord}."
1874   (filter
1875    (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1876    (ly:music-property event-chord 'elements)))
1877
1878 (define-public (event-chord-pitches event-chord)
1879   "Return a list of all pitches from @var{event-chord}."
1880   (map (lambda (x) (ly:music-property x 'pitch))
1881        (event-chord-notes event-chord)))
1882
1883 (defmacro-public make-relative (pitches last-pitch music)
1884   "The list of pitch-carrying variables in @var{pitches} is used as a
1885 sequence for creating relativable music from @var{music}.
1886 The variables in @var{pitches} are, when considered inside of
1887 @code{\\relative}, all considered to be specifications to the preceding
1888 variable.  The first variable is relative to the preceding musical
1889 context, and @var{last-pitch} specifies the pitch passed as relative
1890 base onto the following musical context."
1891
1892   ;; pitch and music generator might be stored instead in music
1893   ;; properties, and it might make sense to create a music type of its
1894   ;; own for this kind of construct rather than using
1895   ;; RelativeOctaveMusic
1896   (define ((make-relative::to-relative-callback pitches p->m p->p) music pitch)
1897     (let* ((chord (make-event-chord
1898                    (map
1899                     (lambda (p)
1900                       (make-music 'NoteEvent
1901                                   'pitch p))
1902                     pitches)))
1903            (pitchout (begin
1904                        (ly:make-music-relative! chord pitch)
1905                        (event-chord-pitches chord))))
1906       (set! (ly:music-property music 'element)
1907             (apply p->m pitchout))
1908       (apply p->p pitchout)))
1909   `(make-music 'RelativeOctaveMusic
1910                'to-relative-callback
1911                (,make-relative::to-relative-callback
1912                 (list ,@pitches)
1913                 (lambda ,pitches ,music)
1914                 (lambda ,pitches ,last-pitch))
1915                'element ,music))
1916
1917 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1918 ;; The following functions are all associated with the crossStaff
1919 ;;  function
1920
1921 (define (close-enough? x y)
1922   "Values are close enough to ignore the difference"
1923   (< (abs (- x y)) 0.0001))
1924
1925 (define (extent-combine extents)
1926   "Combine a list of extents"
1927   (if (pair? (cdr extents))
1928       (interval-union (car extents) (extent-combine (cdr extents)))
1929       (car extents)))
1930
1931 (define ((stem-connectable? ref root) stem)
1932   "Check if the stem is connectable to the root"
1933   ;; The root is always connectable to itself
1934   (or (eq? root stem)
1935       (and
1936        ;; Horizontal positions of the stems must be almost the same
1937        (close-enough? (car (ly:grob-extent root ref X))
1938                       (car (ly:grob-extent stem ref X)))
1939        ;; The stem must be in the direction away from the root's notehead
1940        (positive? (* (ly:grob-property root 'direction)
1941                      (- (car (ly:grob-extent stem ref Y))
1942                         (car (ly:grob-extent root ref Y))))))))
1943
1944 (define (stem-span-stencil span)
1945   "Connect stems if we have at least one stem connectable to the root"
1946   (let* ((system (ly:grob-system span))
1947          (root (ly:grob-parent span X))
1948          (stems (filter (stem-connectable? system root)
1949                         (ly:grob-object span 'stems))))
1950     (if (<= 2 (length stems))
1951         (let* ((yextents (map (lambda (st)
1952                                 (ly:grob-extent st system Y)) stems))
1953                (yextent (extent-combine yextents))
1954                (layout (ly:grob-layout root))
1955                (blot (ly:output-def-lookup layout 'blot-diameter)))
1956           ;; Hide spanned stems
1957           (map (lambda (st)
1958                  (set! (ly:grob-property st 'stencil) #f))
1959                stems)
1960           ;; Draw a nice looking stem with rounded corners
1961           (ly:round-filled-box (ly:grob-extent root root X) yextent blot))
1962         ;; Nothing to connect, don't draw the span
1963         #f)))
1964
1965 (define ((make-stem-span! stems trans) root)
1966   "Create a stem span as a child of the cross-staff stem (the root)"
1967   (let ((span (ly:engraver-make-grob trans 'Stem '())))
1968     (ly:grob-set-parent! span X root)
1969     (set! (ly:grob-object span 'stems) stems)
1970     ;; Suppress positioning, the stem code is confused by this weird stem
1971     (set! (ly:grob-property span 'X-offset) 0)
1972     (set! (ly:grob-property span 'stencil) stem-span-stencil)))
1973
1974 (define-public (cross-staff-connect stem)
1975   "Set cross-staff property of the stem to this function to connect it to
1976 other stems automatically"
1977   #t)
1978
1979 (define (stem-is-root? stem)
1980   "Check if automatic connecting of the stem was requested.  Stems connected
1981 to cross-staff beams are cross-staff, but they should not be connected to
1982 other stems just because of that."
1983   (eq? cross-staff-connect (ly:grob-property-data stem 'cross-staff)))
1984
1985 (define (make-stem-spans! ctx stems trans)
1986   "Create stem spans for cross-staff stems"
1987   ;; Cannot do extensive checks here, just make sure there are at least
1988   ;; two stems at this musical moment
1989   (if (<= 2 (length stems))
1990       (let ((roots (filter stem-is-root? stems)))
1991         (map (make-stem-span! stems trans) roots))))
1992
1993 (define-public (Span_stem_engraver ctx)
1994   "Connect cross-staff stems to the stems above in the system"
1995   (let ((stems '()))
1996     (make-engraver
1997      ;; Record all stems for the given moment
1998      (acknowledgers
1999       ((stem-interface trans grob source)
2000        (set! stems (cons grob stems))))
2001      ;; Process stems and reset the stem list to empty
2002      ((process-acknowledged trans)
2003       (make-stem-spans! ctx stems trans)
2004       (set! stems '())))))
2005
2006 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2007 ;; The following is used by the alterBroken function.
2008
2009 (define-public ((value-for-spanner-piece arg) grob)
2010   "Associate a piece of broken spanner @var{grob} with an element
2011 of list @var{arg}."
2012   (let* ((orig (ly:grob-original grob))
2013          (siblings (ly:spanner-broken-into orig)))
2014
2015     (define (helper sibs arg)
2016       (if (null? arg)
2017           arg
2018           (if (eq? (car sibs) grob)
2019               (car arg)
2020               (helper (cdr sibs) (cdr arg)))))
2021
2022     (if (>= (length siblings) 2)
2023         (helper siblings arg)
2024         (car arg))))
2025
2026 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2027 ;; measure counter
2028
2029 (define (measure-counter-stencil grob)
2030   "Print a number for a measure count.  The number is centered using
2031 the extents of @code{BreakAlignment} grobs associated with
2032 @code{NonMusicalPaperColumn} grobs.  In the case of an unbroken measure, these
2033 columns are the left and right bounds of a @code{MeasureCounter} spanner.
2034 Broken measures are numbered in parentheses."
2035   (let* ((orig (ly:grob-original grob))
2036          (siblings (ly:spanner-broken-into orig)) ; have we been split?
2037          (bounds (ly:grob-array->list (ly:grob-object grob 'columns)))
2038          (refp (ly:grob-system grob))
2039          ;; we use the first and/or last NonMusicalPaperColumn grob(s) of
2040          ;; a system in the event that a MeasureCounter spanner is broken
2041          (all-cols (ly:grob-array->list (ly:grob-object refp 'columns)))
2042          (all-cols
2043           (filter
2044            (lambda (col) (eq? #t (ly:grob-property col 'non-musical)))
2045            all-cols))
2046          (left-bound
2047           (if (or (null? siblings) ; spanner is unbroken
2048                   (eq? grob (car siblings))) ; or the first piece
2049               (car bounds)
2050               (car all-cols)))
2051          (right-bound
2052           (if (or (null? siblings)
2053                   (eq? grob (car (reverse siblings))))
2054               (car (reverse bounds))
2055               (car (reverse all-cols))))
2056          (elts-L (ly:grob-array->list (ly:grob-object left-bound 'elements)))
2057          (elts-R (ly:grob-array->list (ly:grob-object right-bound 'elements)))
2058          (break-alignment-L
2059           (filter
2060            (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2061            elts-L))
2062          (break-alignment-R
2063           (filter
2064            (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2065            elts-R))
2066          (break-alignment-L-ext (ly:grob-extent (car break-alignment-L) refp X))
2067          (break-alignment-R-ext (ly:grob-extent (car break-alignment-R) refp X))
2068          (num (markup (number->string (ly:grob-property grob 'count-from))))
2069          (num
2070           (if (or (null? siblings)
2071                   (eq? grob (car siblings)))
2072               num
2073               (make-parenthesize-markup num)))
2074          (num (grob-interpret-markup grob num))
2075          (num (ly:stencil-aligned-to num X (ly:grob-property grob 'self-alignment-X)))
2076          (num
2077           (ly:stencil-translate-axis
2078            num
2079            (+ (interval-length break-alignment-L-ext)
2080               (* 0.5
2081                  (- (car break-alignment-R-ext)
2082                     (cdr break-alignment-L-ext))))
2083            X)))
2084     num))