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     PhrasingSlur
 495     RepeatTie
 496     Rest
 497     Script
 498     Slur
 499     Stem
 500     TextScript
 501     Tie
 502     TupletBracket
 503     TrillSpanner))
 504
 505 (define-safe-public (make-voice-props-set n)
 506   (make-sequential-music
 507    (append
 508     (map (lambda (x) (make-grob-property-set x 'direction
 509                                                   (if (odd? n) -1 1)))
 510          direction-polyphonic-grobs)
 511     (list
 512      (make-property-set 'graceSettings
 513                         ;; TODO: take this from voicedGraceSettings or similar.
 514                         '((Voice Stem font-size -3)
 515                           (Voice Flag font-size -3)
 516                           (Voice NoteHead font-size -3)
 517                           (Voice TabNoteHead font-size -4)
 518                           (Voice Dots font-size -3)
 519                           (Voice Stem length-fraction 0.8)
 520                           (Voice Stem no-stem-extend #t)
 521                           (Voice Beam beam-thickness 0.384)
 522                           (Voice Beam length-fraction 0.8)
 523                           (Voice Accidental font-size -4)
 524                           (Voice AccidentalCautionary font-size -4)
 525                           (Voice Script font-size -3)
 526                           (Voice Fingering font-size -8)
 527                           (Voice StringNumber font-size -8)))
 528
 529      (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
 530      (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
 531
 532 (define-safe-public (make-voice-props-override n)
 533   (make-sequential-music
 534    (append
 535     (map (lambda (x) (make-grob-property-override x 'direction
 536                                                   (if (odd? n) -1 1)))
 537          direction-polyphonic-grobs)
 538     (list
 539      (make-property-set 'graceSettings
 540                         ;; TODO: take this from voicedGraceSettings or similar.
 541                         '((Voice Stem font-size -3)
 542                           (Voice Flag font-size -3)
 543                           (Voice NoteHead font-size -3)
 544                           (Voice TabNoteHead font-size -4)
 545                           (Voice Dots font-size -3)
 546                           (Voice Stem length-fraction 0.8)
 547                           (Voice Stem no-stem-extend #t)
 548                           (Voice Beam beam-thickness 0.384)
 549                           (Voice Beam length-fraction 0.8)
 550                           (Voice Accidental font-size -4)
 551                           (Voice AccidentalCautionary font-size -4)
 552                           (Voice Script font-size -3)
 553                           (Voice Fingering font-size -8)
 554                           (Voice StringNumber font-size -8)))
 555
 556      (make-grob-property-override 'NoteColumn 'horizontal-shift (quotient n 2))
 557      (make-grob-property-override 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
 558
 559 (define-safe-public (make-voice-props-revert)
 560   (make-sequential-music
 561    (append
 562     (map (lambda (x) (make-grob-property-revert x 'direction))
 563          direction-polyphonic-grobs)
 564     (list (make-property-unset 'graceSettings)
 565           (make-grob-property-revert 'NoteColumn 'horizontal-shift)
 566           (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
 567
 568
 569 (define-safe-public (context-spec-music m context #:optional id)
 570   "Add \\context CONTEXT = ID to M."
 571   (let ((cm (make-music 'ContextSpeccedMusic
 572                         'element m
 573                         'context-type context)))
 574     (if (string? id)
 575         (set! (ly:music-property cm 'context-id) id))
 576     cm))
 577
 578 (define-public (descend-to-context m context)
 579   "Like @code{context-spec-music}, but only descending."
 580   (let ((cm (context-spec-music m context)))
 581     (ly:music-set-property! cm 'descend-only #t)
 582     cm))
 583
 584 (define-public (make-non-relative-music mus)
 585   (make-music 'UnrelativableMusic
 586               'element mus))
 587
 588 (define-public (make-apply-context func)
 589   (make-music 'ApplyContext
 590               'procedure func))
 591
 592 (define-public (make-sequential-music elts)
 593   (make-music 'SequentialMusic
 594               'elements elts))
 595
 596 (define-public (make-simultaneous-music elts)
 597   (make-music 'SimultaneousMusic
 598               'elements elts))
 599
 600 (define-safe-public (make-event-chord elts)
 601   (make-music 'EventChord
 602               'elements elts))
 603
 604 (define-public (make-skip-music dur)
 605   (make-music 'SkipMusic
 606               'duration dur))
 607
 608 (define-public (make-grace-music music)
 609   (make-music 'GraceMusic
 610               'element music))
 611
 612 ;;;;;;;;;;;;;;;;
 613
 614 ;; mmrest
 615 (define-public (make-multi-measure-rest duration location)
 616   (make-music 'MultiMeasureRestMusic
 617               'origin location
 618               'duration duration))
 619
 620 (define-public (make-property-set sym val)
 621   (make-music 'PropertySet
 622               'symbol sym
 623               'value val))
 624
 625 (define-public (make-property-unset sym)
 626   (make-music 'PropertyUnset
 627               'symbol sym))
 628
 629 (define-safe-public (make-articulation name)
 630   (make-music 'ArticulationEvent
 631               'articulation-type name))
 632
 633 (define-public (make-lyric-event string duration)
 634   (make-music 'LyricEvent
 635               'duration duration
 636               'text string))
 637
 638 (define-safe-public (make-span-event type span-dir)
 639   (make-music type
 640               'span-direction span-dir))
 641
 642 (define-public (override-head-style heads style)
 643   "Override style for @var{heads} to @var{style}."
 644   (make-sequential-music
 645     (if (pair? heads)
 646         (map (lambda (h)
 647               (make-grob-property-override h 'style style))
 648          heads)
 649         (list (make-grob-property-override heads 'style style)))))
 650
 651 (define-public (revert-head-style heads)
 652   "Revert style for @var{heads}."
 653   (make-sequential-music
 654     (if (pair? heads)
 655         (map (lambda (h)
 656               (make-grob-property-revert h 'style))
 657          heads)
 658         (list (make-grob-property-revert heads 'style)))))
 659
 660 (define-public (style-note-heads heads style music)
 661  "Set @var{style} for all @var{heads} in @var{music}.  Works both
 662 inside of and outside of chord construct."
 663   ;; are we inside a <...>?
 664   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 665       ;; yes -> use a tweak
 666       (begin
 667         (set! (ly:music-property music 'tweaks)
 668               (acons 'style style (ly:music-property music 'tweaks)))
 669         music)
 670       ;; not in <...>, so use overrides
 671       (make-sequential-music
 672         (list
 673           (override-head-style heads style)
 674           music
 675           (revert-head-style heads)))))
 676
 677  (define-public (set-mus-properties! m alist)
 678   "Set all of @var{alist} as properties of @var{m}."
 679   (if (pair? alist)
 680       (begin
 681         (set! (ly:music-property m (caar alist)) (cdar alist))
 682         (set-mus-properties! m (cdr alist)))))
 683
 684 (define-public (music-separator? m)
 685   "Is @var{m} a separator?"
 686   (let ((ts (ly:music-property m 'types)))
 687     (memq 'separator ts)))
 688
 689 ;;; expanding repeat chords
 690 (define-public (copy-repeat-chord original-chord repeat-chord duration
 691                                   event-types)
 692   "Copies all events in @var{event-types} (be sure to include
 693 @code{rhythmic-events}) from @var{original-chord} over to
 694 @var{repeat-chord} with their articulations filtered as well.  Any
 695 duration is replaced with the specified @var{duration}."
 696   ;; First remove everything from event-types that can already be
 697   ;; found in the repeated chord.  We don't need to look for
 698   ;; articulations on individual events since they can't actually get
 699   ;; into a repeat chord given its input syntax.
 700
 701   (define (keep-element? m)
 702     (any (lambda (t) (music-is-of-type? m t))
 703          event-types))
 704   (define origin (ly:music-property repeat-chord 'origin #f))
 705   (define (set-origin! l)
 706     (if origin
 707         (for-each (lambda (m) (set! (ly:music-property m 'origin) origin)) l))
 708     l)
 709
 710   (for-each
 711    (lambda (field)
 712      (for-each (lambda (e)
 713                  (for-each (lambda (x)
 714                              (set! event-types (delq x event-types)))
 715                            (ly:music-property e 'types)))
 716                (ly:music-property repeat-chord field)))
 717    '(elements articulations))
 718
 719   ;; now treat the elements
 720   (set! (ly:music-property repeat-chord 'elements)
 721         (let ((elts
 722                (set-origin! (ly:music-deep-copy
 723                              (filter keep-element?
 724                                      (ly:music-property original-chord
 725                                                         'elements))))))
 726           (for-each
 727            (lambda (m)
 728              (let ((arts (ly:music-property m 'articulations)))
 729                (if (pair? arts)
 730                    (set! (ly:music-property m 'articulations)
 731                          (set-origin! (filter! keep-element? arts))))
 732                (if (ly:duration? (ly:music-property m 'duration))
 733                    (set! (ly:music-property m 'duration) duration))))
 734            elts)
 735           (append! elts (ly:music-property repeat-chord 'elements))))
 736   (let ((arts (filter keep-element?
 737                       (ly:music-property original-chord
 738                                          'articulations))))
 739     (if (pair? arts)
 740         (set! (ly:music-property repeat-chord 'articulations)
 741               (append!
 742                (set-origin! (ly:music-deep-copy arts))
 743                (ly:music-property repeat-chord 'articulations))))))
 744
 745
 746 (define-public (expand-repeat-chords! event-types music)
 747   "Walks through @var{music} and fills repeated chords (notable by
 748 having a duration in @code{duration}) with the notes from their
 749 respective predecessor chord."
 750   (let loop ((music music) (last-chord #f))
 751     (if (music-is-of-type? music 'event-chord)
 752         (let ((chord-repeat (ly:music-property music 'duration)))
 753           (cond
 754            ((not (ly:duration? chord-repeat))
 755             (if (any (lambda (m) (ly:duration?
 756                                   (ly:music-property m 'duration)))
 757                      (ly:music-property music 'elements))
 758                 music
 759                 last-chord))
 760            (last-chord
 761             (set! (ly:music-property music 'duration) '())
 762             (copy-repeat-chord last-chord music chord-repeat event-types)
 763             music)
 764            (else
 765             (ly:music-warning music (_ "Bad chord repetition"))
 766             #f)))
 767         (let ((elt (ly:music-property music 'element)))
 768           (fold loop (if (ly:music? elt) (loop elt last-chord) last-chord)
 769                 (ly:music-property music 'elements)))))
 770   music)
 771
 772 ;;; splitting chords into voices.
 773 (define (voicify-list lst number)
 774   "Make a list of Musics.
 775
 776 voicify-list :: [ [Music ] ] -> number -> [Music]
 777 LST is a list music-lists.
 778
 779 NUMBER is 0-base, i.e., Voice=1 (upstems) has number 0.
 780 "
 781   (if (null? lst)
 782       '()
 783       (cons (context-spec-music
 784              (make-sequential-music
 785               (list (make-voice-props-set number)
 786                     (make-simultaneous-music (car lst))))
 787              'Bottom  (number->string (1+ number)))
 788             (voicify-list (cdr lst) (1+ number)))))
 789
 790 (define (voicify-chord ch)
 791   "Split the parts of a chord into different Voices using separator"
 792   (let ((es (ly:music-property ch 'elements)))
 793     (set! (ly:music-property  ch 'elements)
 794           (voicify-list (split-list-by-separator es music-separator?) 0))
 795     ch))
 796
 797 (define-public (voicify-music m)
 798   "Recursively split chords that are separated with @code{\\\\}."
 799   (if (not (ly:music? m))
 800       (ly:error (_ "music expected: ~S") m))
 801   (let ((es (ly:music-property m 'elements))
 802         (e (ly:music-property m 'element)))
 803
 804     (if (pair? es)
 805         (set! (ly:music-property m 'elements) (map voicify-music es)))
 806     (if (ly:music? e)
 807         (set! (ly:music-property m 'element)  (voicify-music e)))
 808     (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
 809              (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
 810         (set! m (context-spec-music (voicify-chord m) 'Staff)))
 811     m))
 812
 813 (define-public (empty-music)
 814   (make-music 'Music))
 815
 816 ;; Make a function that checks score element for being of a specific type.
 817 (define-public (make-type-checker symbol)
 818   (lambda (elt)
 819     (grob::has-interface elt symbol)))
 820
 821 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
 822   (if (func grob)
 823       (set! (ly:grob-property grob sym) val)))
 824
 825
 826 (define-public ((set-output-property grob-name symbol val)  grob grob-c context)
 827   "Usage example:
 828 @code{\\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))}"
 829   (let ((meta (ly:grob-property grob 'meta)))
 830     (if (equal? (assoc-get 'name meta) grob-name)
 831         (set! (ly:grob-property grob symbol) val))))
 832
 833
 834 (define-public (skip->rest mus)
 835   "Replace @var{mus} by @code{RestEvent} of the same duration if it is a
 836 @code{SkipEvent}.  Useful for extracting parts from crowded scores."
 837
 838   (if  (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
 839    (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
 840    mus))
 841
 842
 843 (define-public (music-has-type music type)
 844   (memq type (ly:music-property music 'types)))
 845
 846 (define-public (music-clone music . music-properties)
 847   "Clone @var{music} and set properties according to
 848 @var{music-properties}, a list of alternating property symbols and
 849 values:
 850 @example\n(music-clone start-span 'span-direction STOP)
 851 @end example
 852 Only properties that are not overriden by @var{music-properties} are
 853 actually fully cloned."
 854   (let ((old-props (list-copy (ly:music-mutable-properties music)))
 855         (new-props '())
 856         (m (ly:make-music (ly:prob-immutable-properties music))))
 857     (define (set-props mus-props)
 858       (if (and (not (null? mus-props))
 859                (not (null? (cdr mus-props))))
 860           (begin
 861             (set! old-props (assq-remove! old-props (car mus-props)))
 862             (set! new-props
 863                   (assq-set! new-props
 864                              (car mus-props) (cadr mus-props)))
 865             (set-props (cddr mus-props)))))
 866     (set-props music-properties)
 867     (for-each
 868      (lambda (pair)
 869        (set! (ly:music-property m (car pair))
 870              (ly:music-deep-copy (cdr pair))))
 871      old-props)
 872     (for-each
 873      (lambda (pair)
 874        (set! (ly:music-property m (car pair)) (cdr pair)))
 875      new-props)
 876     m))
 877
 878 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 879 ;; warn for bare chords at start.
 880
 881 (define-public (ly:music-message music msg)
 882   (let ((ip (ly:music-property music 'origin)))
 883     (if (ly:input-location? ip)
 884         (ly:input-message ip msg)
 885         (ly:message msg))))
 886
 887 (define-public (ly:music-warning music msg)
 888   (let ((ip (ly:music-property music 'origin)))
 889     (if (ly:input-location? ip)
 890         (ly:input-warning ip msg)
 891         (ly:warning msg))))
 892
 893 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 894 ;;
 895 ;; setting stuff for grace context.
 896 ;;
 897
 898 (define (vector-extend v x)
 899   "Make a new vector consisting of V, with X added to the end."
 900   (let* ((n (vector-length v))
 901          (nv (make-vector (+ n 1) '())))
 902     (vector-move-left! v 0 n nv 0)
 903     (vector-set! nv n x)
 904     nv))
 905
 906 (define (vector-map f v)
 907   "Map F over V.  This function returns nothing."
 908   (do ((n (vector-length v))
 909        (i 0 (+ i 1)))
 910       ((>= i n))
 911     (f (vector-ref v i))))
 912
 913 (define (vector-reverse-map f v)
 914   "Map F over V, N to 0 order.  This function returns nothing."
 915   (do ((i (- (vector-length v) 1) (- i 1)))
 916       ((< i 0))
 917     (f (vector-ref v i))))
 918
 919 (define-public (add-grace-property context-name grob sym val)
 920   "Set @var{sym}=@var{val} for @var{grob} in @var{context-name}."
 921   (define (set-prop context)
 922     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 923            (current (ly:context-property where 'graceSettings))
 924            (new-settings (append current
 925                                  (list (list context-name grob sym val)))))
 926       (ly:context-set-property! where 'graceSettings new-settings)))
 927   (context-spec-music (make-apply-context set-prop) 'Voice))
 928
 929 (define-public (remove-grace-property context-name grob sym)
 930   "Remove all @var{sym} for @var{grob} in @var{context-name}."
 931   (define (sym-grob-context? property sym grob context-name)
 932     (and (eq? (car property) context-name)
 933          (eq? (cadr property) grob)
 934          (eq? (caddr property) sym)))
 935   (define (delete-prop context)
 936     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 937            (current (ly:context-property where 'graceSettings))
 938            (prop-settings (filter
 939                             (lambda(x) (sym-grob-context? x sym grob context-name))
 940                             current))
 941            (new-settings current))
 942       (for-each (lambda(x)
 943                  (set! new-settings (delete x new-settings)))
 944                prop-settings)
 945       (ly:context-set-property! where 'graceSettings new-settings)))
 946   (context-spec-music (make-apply-context delete-prop) 'Voice))
 947
 948
 949
 950 (defmacro-public def-grace-function (start stop . docstring)
 951   "Helper macro for defining grace music"
 952   `(define-music-function (parser location music) (ly:music?)
 953      ,@docstring
 954      (make-music 'GraceMusic
 955                  'origin location
 956                  'element (make-music 'SequentialMusic
 957                                       'elements (list (ly:music-deep-copy ,start)
 958                                                       music
 959                                                       (ly:music-deep-copy ,stop))))))
 960
 961 (defmacro-public define-syntax-function (type args signature . body)
 962   "Helper macro for `ly:make-music-function'.
 963 Syntax:
 964   (define-syntax-function result-type? (parser location arg1 arg2 ...) (arg1-type arg2-type ...)
 965     ...function body...)
 966
 967 argX-type can take one of the forms @code{predicate?} for mandatory
 968 arguments satisfying the predicate, @code{(predicate?)} for optional
 969 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
 970 value)}} for optional parameters with a specified default
 971 value (evaluated at definition time).  An optional parameter can be
 972 omitted in a call only when it can't get confused with a following
 973 parameter of different type.
 974
 975 Predicates with syntactical significance are @code{ly:pitch?},
 976 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
 977 predicates require the parameter to be entered as Scheme expression.
 978
 979 @code{result-type?} can specify a default in the same manner as
 980 predicates, to be used in case of a type error in arguments or
 981 result."
 982
 983   (set! signature (map (lambda (pred)
 984                          (if (pair? pred)
 985                              `(cons ,(car pred)
 986                                     ,(and (pair? (cdr pred)) (cadr pred)))
 987                              pred))
 988                        (cons type signature)))
 989   (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
 990       ;; When the music function definition contains a i10n doc string,
 991       ;; (_i "doc string"), keep the literal string only
 992       (let ((docstring (cadar body))
 993             (body (cdr body)))
 994         `(ly:make-music-function (list ,@signature)
 995                                  (lambda ,args
 996                                    ,docstring
 997                                    ,@body)))
 998       `(ly:make-music-function (list ,@signature)
 999                                (lambda ,args
1000                                  ,@body))))
1001
1002 (defmacro-public define-music-function rest
1003   "Defining macro returning music functions.
1004 Syntax:
1005   (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1006     ...function body...)
1007
1008 argX-type can take one of the forms @code{predicate?} for mandatory
1009 arguments satisfying the predicate, @code{(predicate?)} for optional
1010 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1011 value)}} for optional parameters with a specified default
1012 value (evaluated at definition time).  An optional parameter can be
1013 omitted in a call only when it can't get confused with a following
1014 parameter of different type.
1015
1016 Predicates with syntactical significance are @code{ly:pitch?},
1017 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
1018 predicates require the parameter to be entered as Scheme expression.
1019
1020 Must return a music expression.  The @code{origin} is automatically
1021 set to the @code{location} parameter."
1022
1023   `(define-syntax-function (ly:music? (make-music 'Music 'void #t)) ,@rest))
1024
1025
1026 (defmacro-public define-scheme-function rest
1027   "Defining macro returning Scheme functions.
1028 Syntax:
1029   (define-scheme-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1030     ...function body...)
1031
1032 argX-type can take one of the forms @code{predicate?} for mandatory
1033 arguments satisfying the predicate, @code{(predicate?)} for optional
1034 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1035 value)}} for optional parameters with a specified default
1036 value (evaluated at definition time).  An optional parameter can be
1037 omitted in a call only when it can't get confused with a following
1038 parameter of different type.
1039
1040 Predicates with syntactical significance are @code{ly:pitch?},
1041 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
1042 predicates require the parameter to be entered as Scheme expression.
1043
1044 Can return arbitrary expressions.  If a music expression is returned,
1045 its @code{origin} is automatically set to the @code{location}
1046 parameter."
1047
1048   `(define-syntax-function scheme? ,@rest))
1049
1050 (defmacro-public define-void-function rest
1051   "This defines a Scheme function like @code{define-scheme-function} with
1052 void return value (i.e., what most Guile functions with `unspecified'
1053 value return).  Use this when defining functions for executing actions
1054 rather than returning values, to keep Lilypond from trying to interpret
1055 the return value."
1056   `(define-syntax-function (void? *unspecified*) ,@rest *unspecified*))
1057
1058 (defmacro-public define-event-function rest
1059   "Defining macro returning event functions.
1060 Syntax:
1061   (define-event-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1062     ...function body...)
1063
1064 argX-type can take one of the forms @code{predicate?} for mandatory
1065 arguments satisfying the predicate, @code{(predicate?)} for optional
1066 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1067 value)}} for optional parameters with a specified default
1068 value (evaluated at definition time).  An optional parameter can be
1069 omitted in a call only when it can't get confused with a following
1070 parameter of different type.
1071
1072 Predicates with syntactical significance are @code{ly:pitch?},
1073 @code{ly:duration?}, @code{ly:music?}, @code{markup?}.  Other
1074 predicates require the parameter to be entered as Scheme expression.
1075
1076 Must return an event expression.  The @code{origin} is automatically
1077 set to the @code{location} parameter."
1078
1079   `(define-syntax-function (ly:event? (make-music 'Event 'void #t)) ,@rest))
1080
1081 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1082
1083 (define-public (cue-substitute quote-music)
1084   "Must happen after @code{quote-substitute}."
1085
1086   (if (vector? (ly:music-property quote-music 'quoted-events))
1087       (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
1088              (clef (ly:music-property quote-music 'quoted-music-clef #f))
1089              (main-voice (case dir ((1) 1) ((-1) 0) (else #f)))
1090              (cue-voice (and main-voice (- 1 main-voice)))
1091              (main-music (ly:music-property quote-music 'element))
1092              (return-value quote-music))
1093
1094         (if main-voice
1095             (set! (ly:music-property quote-music 'element)
1096                   (make-sequential-music
1097                    (list
1098                     (make-voice-props-override main-voice)
1099                     main-music
1100                     (make-voice-props-revert)))))
1101
1102         ;; if we have stem dirs, change both quoted and main music
1103         ;; to have opposite stems.
1104
1105         ;; cannot context-spec Quote-music, since context
1106         ;; for the quotes is determined in the iterator.
1107
1108         (make-sequential-music
1109          (delq! #f
1110                 (list
1111                  (and clef (make-cue-clef-set clef))
1112
1113                  ;; Need to establish CueVoice context even in #CENTER case
1114                  (context-spec-music
1115                   (if cue-voice
1116                       (make-voice-props-override cue-voice)
1117                       (make-music 'Music))
1118                   'CueVoice "cue")
1119                  quote-music
1120                  (and cue-voice
1121                       (context-spec-music
1122                        (make-voice-props-revert) 'CueVoice "cue"))
1123                  (and clef (make-cue-clef-unset))))))
1124       quote-music))
1125
1126 (define-public ((quote-substitute quote-tab) music)
1127   (let* ((quoted-name (ly:music-property music 'quoted-music-name))
1128          (quoted-vector (and (string? quoted-name)
1129                              (hash-ref quote-tab quoted-name #f))))
1130
1131
1132     (if (string? quoted-name)
1133         (if (vector? quoted-vector)
1134             (begin
1135               (set! (ly:music-property music 'quoted-events) quoted-vector)
1136               (set! (ly:music-property music 'iterator-ctor)
1137                     ly:quote-iterator::constructor))
1138             (ly:music-warning music (ly:format (_ "cannot find quoted music: `~S'") quoted-name))))
1139     music))
1140
1141
1142 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1143 ;; switch it on here, so parsing and init isn't checked (too slow!)
1144 ;;
1145 ;; automatic music transformations.
1146
1147 (define (switch-on-debugging m)
1148   (if (defined? 'set-debug-cell-accesses!)
1149       (set-debug-cell-accesses! 15000))
1150   m)
1151
1152 (define (music-check-error music)
1153   (define found #f)
1154   (define (signal m)
1155     (if (and (ly:music? m)
1156              (eq? (ly:music-property m 'error-found) #t))
1157         (set! found #t)))
1158
1159   (for-each signal (ly:music-property music 'elements))
1160   (signal (ly:music-property music 'element))
1161
1162   (if found
1163       (set! (ly:music-property music 'error-found) #t))
1164   music)
1165
1166 (define (precompute-music-length music)
1167   (set! (ly:music-property music 'length)
1168         (ly:music-length music))
1169   music)
1170
1171 (define-public (make-duration-of-length moment)
1172  "Make duration of the given @code{moment} length."
1173  (ly:make-duration 0 0
1174   (ly:moment-main-numerator moment)
1175   (ly:moment-main-denominator moment)))
1176
1177 (define (make-skipped moment bool)
1178  "Depending on BOOL, set or unset skipTypesetting,
1179 then make SkipMusic of the given MOMENT length, and
1180 then revert skipTypesetting."
1181  (make-sequential-music
1182   (list
1183    (context-spec-music (make-property-set 'skipTypesetting bool)
1184     'Score)
1185    (make-music 'SkipMusic 'duration
1186     (make-duration-of-length moment))
1187    (context-spec-music (make-property-set 'skipTypesetting (not bool))
1188     'Score))))
1189
1190 (define (skip-as-needed music parser)
1191   "Replace MUSIC by
1192  << {  \\set skipTypesetting = ##f
1193  LENGTHOF(\\showFirstLength)
1194  \\set skipTypesetting = ##t
1195  LENGTHOF(\\showLastLength) }
1196  MUSIC >>
1197  if appropriate.
1198
1199  When only showFirstLength is set,
1200  the 'length property of the music is
1201  overridden to speed up compiling."
1202   (let*
1203       ((show-last (ly:parser-lookup parser 'showLastLength))
1204        (show-first (ly:parser-lookup parser 'showFirstLength))
1205        (show-last-length (and (ly:music? show-last)
1206                               (ly:music-length show-last)))
1207        (show-first-length (and (ly:music? show-first)
1208                                (ly:music-length show-first)))
1209        (orig-length (ly:music-length music)))
1210
1211     ;;FIXME: if using either showFirst- or showLastLength,
1212     ;; make sure that skipBars is not set.
1213
1214     (cond
1215
1216      ;; both properties may be set.
1217      ((and show-first-length show-last-length)
1218       (let
1219           ((skip-length (ly:moment-sub orig-length show-last-length)))
1220         (make-simultaneous-music
1221          (list
1222           (make-sequential-music
1223            (list
1224             (make-skipped skip-length #t)
1225             ;; let's draw a separator between the beginning and the end
1226             (context-spec-music (make-property-set 'whichBar "||")
1227                                 'Timing)))
1228           (make-skipped show-first-length #f)
1229           music))))
1230
1231      ;; we may only want to print the last length
1232      (show-last-length
1233       (let
1234           ((skip-length (ly:moment-sub orig-length show-last-length)))
1235         (make-simultaneous-music
1236          (list
1237           (make-skipped skip-length #t)
1238           music))))
1239
1240      ;; we may only want to print the beginning; in this case
1241      ;; only the first length will be processed (much faster).
1242      (show-first-length
1243       ;; the first length must not exceed the original length.
1244       (if (ly:moment<? show-first-length orig-length)
1245           (set! (ly:music-property music 'length)
1246                 show-first-length))
1247       music)
1248
1249      (else music))))
1250
1251
1252 (define-public toplevel-music-functions
1253   (list
1254    (lambda (music parser) (expand-repeat-chords!
1255                            (cons 'rhythmic-event
1256                                  (ly:parser-lookup parser '$chord-repeat-events))
1257                            music))
1258    (lambda (music parser) (voicify-music music))
1259    (lambda (x parser) (music-map music-check-error x))
1260    (lambda (x parser) (music-map precompute-music-length x))
1261    (lambda (music parser)
1262
1263      (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes))  music))
1264
1265    ;; switch-on-debugging
1266    (lambda (x parser) (music-map cue-substitute x))
1267
1268    (lambda (x parser)
1269      (skip-as-needed x parser)
1270    )))
1271
1272 ;;;;;;;;;;
1273 ;;; general purpose music functions
1274
1275 (define (shift-octave pitch octave-shift)
1276   (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
1277   (ly:make-pitch
1278      (+ (ly:pitch-octave pitch) octave-shift)
1279      (ly:pitch-notename pitch)
1280      (ly:pitch-alteration pitch)))
1281
1282
1283 ;;;;;;;;;;;;;;;;;
1284 ;; lyrics
1285
1286 (define (apply-durations lyric-music durations)
1287   (define (apply-duration music)
1288     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
1289              (ly:duration?  (ly:music-property music 'duration)))
1290         (begin
1291           (set! (ly:music-property music 'duration) (car durations))
1292           (set! durations (cdr durations)))))
1293
1294   (music-map apply-duration lyric-music))
1295
1296
1297 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1298 ;; accidentals
1299
1300 (define (recent-enough? bar-number alteration-def laziness)
1301   (or (number? alteration-def)
1302       (equal? laziness #t)
1303       (<= bar-number (+ (cadr alteration-def) laziness))))
1304
1305 (define (accidental-invalid? alteration-def)
1306   "Checks an alteration entry for being invalid.
1307
1308 Non-key alterations are invalidated when tying into the next bar or
1309 when there is a clef change, since neither repetition nor cancellation
1310 can be omitted when the same note occurs again.
1311
1312 Returns @code{#f} or the reason for the invalidation, a symbol."
1313   (let* ((def (if (pair? alteration-def)
1314                   (car alteration-def)
1315                   alteration-def)))
1316     (and (symbol? def) def)))
1317
1318 (define (extract-alteration alteration-def)
1319   (cond ((number? alteration-def)
1320          alteration-def)
1321         ((pair? alteration-def)
1322          (car alteration-def))
1323         (else 0)))
1324
1325 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1326   "Checks the need for an accidental and a @q{restore} accidental against
1327 @code{localKeySignature}.  The @var{laziness} is the number of measures
1328 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1329 only cancel accidentals in the same measure; if @var{laziness} is three,
1330 we cancel accidentals up to three measures after they first appear.
1331 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1332 specifies whether accidentals should be canceled in different octaves."
1333   (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1334                               ((equal? octaveness 'same-octave) #f)
1335                               (else
1336                                (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1337                                (ly:warning (_ "Defaulting to 'any-octave."))
1338                                #t)))
1339          (key-sig (ly:context-property context 'keySignature))
1340          (local-key-sig (ly:context-property context 'localKeySignature))
1341          (notename (ly:pitch-notename pitch))
1342          (octave (ly:pitch-octave pitch))
1343          (pitch-handle (cons octave notename))
1344          (need-restore #f)
1345          (need-accidental #f)
1346          (previous-alteration #f)
1347          (from-other-octaves #f)
1348          (from-same-octave (assoc-get pitch-handle local-key-sig))
1349          (from-key-sig (or (assoc-get notename local-key-sig)
1350
1351     ;; If no key signature match is found from localKeySignature, we may have a custom
1352     ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1353     ;; instead of (pitch . alteration).  Since this type cannot coexist with entries in
1354     ;; localKeySignature, try extracting from keySignature instead.
1355                            (assoc-get pitch-handle key-sig))))
1356
1357     ;; loop through localKeySignature to search for a notename match from other octaves
1358     (let loop ((l local-key-sig))
1359       (if (pair? l)
1360           (let ((entry (car l)))
1361             (if (and (pair? (car entry))
1362                      (= (cdar entry) notename))
1363                 (set! from-other-octaves (cdr entry))
1364                 (loop (cdr l))))))
1365
1366     ;; find previous alteration-def for comparison with pitch
1367     (cond
1368      ;; from same octave?
1369      ((and (not ignore-octave)
1370            from-same-octave
1371            (recent-enough? barnum from-same-octave laziness))
1372       (set! previous-alteration from-same-octave))
1373
1374      ;; from any octave?
1375      ((and ignore-octave
1376            from-other-octaves
1377            (recent-enough? barnum from-other-octaves laziness))
1378       (set! previous-alteration from-other-octaves))
1379
1380      ;; not recent enough, extract from key signature/local key signature
1381      (from-key-sig
1382       (set! previous-alteration from-key-sig)))
1383
1384     (if (accidental-invalid? previous-alteration)
1385         (set! need-accidental #t)
1386
1387         (let* ((prev-alt (extract-alteration previous-alteration))
1388                (this-alt (ly:pitch-alteration pitch)))
1389
1390           (if (not (= this-alt prev-alt))
1391               (begin
1392                 (set! need-accidental #t)
1393                 (if (and (not (= this-alt 0))
1394                          (and (< (abs this-alt) (abs prev-alt))
1395                              (> (* prev-alt this-alt) 0)))
1396                     (set! need-restore #t))))))
1397
1398     (cons need-restore need-accidental)))
1399
1400 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1401   "Create an accidental rule that makes its decision based on the octave of
1402 the note and a laziness value.
1403
1404 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1405 defines whether the rule should respond to accidental changes in other
1406 octaves than the current.  @code{'same-octave} is the normal way to typeset
1407 accidentals -- an accidental is made if the alteration is different from the
1408 last active pitch in the same octave.  @code{'any-octave} looks at the last
1409 active pitch in any octave.
1410
1411 @var{laziness} states over how many bars an accidental should be remembered.
1412 @code{0}@tie{}is the default -- accidental lasts over 0@tie{}bar lines, that
1413 is, to the end of current measure.  A positive integer means that the
1414 accidental lasts over that many bar lines.  @w{@code{-1}} is `forget
1415 immediately', that is, only look at key signature.  @code{#t} is `forever'."
1416
1417   (check-pitch-against-signature context pitch barnum laziness octaveness))
1418
1419 (define (key-entry-notename entry)
1420   "Return the pitch of an @var{entry} in @code{localKeySignature}.
1421 The @samp{car} of the entry is either of the form @code{notename} or
1422 of the form @code{(octave . notename)}.  The latter form is used for special
1423 key signatures or to indicate an explicit accidental.
1424
1425 The @samp{cdr} of the entry is either a rational @code{alter} indicating
1426 a key signature alteration, or of the form
1427 @code{(alter . (barnum . measurepos))} indicating an alteration caused by
1428 an accidental in music."
1429   (if (pair? (car entry))
1430       (cdar entry)
1431       (car entry)))
1432
1433 (define (key-entry-octave entry)
1434   "Return the octave of an entry in @code{localKeySignature}
1435 or @code{#f} if the entry does not have an octave.
1436 See @code{key-entry-notename} for details."
1437   (and (pair? (car entry)) (caar entry)))
1438
1439 (define (key-entry-bar-number entry)
1440   "Return the bar number of an entry in @code{localKeySignature}
1441 or @code {#f} if the entry does not have a bar number.
1442 See @code{key-entry-notename} for details."
1443   (and (pair? (cdr entry)) (caddr entry)))
1444
1445 (define (key-entry-measure-position entry)
1446   "Return the measure position of an entry in @code{localKeySignature}
1447 or @code {#f} if the entry does not have a measure position.
1448 See @code{key-entry-notename} for details."
1449   (and (pair? (cdr entry)) (cdddr entry)))
1450
1451 (define (key-entry-alteration entry)
1452   "Return the alteration of an entry in localKeySignature.
1453
1454 For convenience, returns @code{0} if entry is @code{#f}."
1455   (if entry
1456       (if (number? (cdr entry))
1457           (cdr entry)
1458           (cadr entry))
1459       0))
1460
1461 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1462   "Return the first entry in @var{keysig} that matches @var{pitch}.
1463 @var{accept-global} states whether key signature entries should be included.
1464 @var{accept-local} states whether local accidentals should be included.
1465 If no matching entry is found, @var{#f} is returned."
1466   (and (pair? keysig)
1467        (let* ((entry (car keysig))
1468               (entryoct (key-entry-octave entry))
1469               (entrynn (key-entry-notename entry))
1470               (nn (ly:pitch-notename pitch)))
1471          (if (and (equal? nn entrynn)
1472                   (or (not entryoct)
1473                       (= entryoct (ly:pitch-octave pitch)))
1474                   (if (key-entry-bar-number entry)
1475                       accept-local
1476                       accept-global))
1477              entry
1478              (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))))
1479
1480 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1481   "An accidental rule that typesets an accidental if it differs from the
1482 key signature @emph{and} does not directly follow a note on the same
1483 staff line.  This rule should not be used alone because it does neither
1484 look at bar lines nor different accidentals at the same note name."
1485   (let* ((keysig (ly:context-property context 'localKeySignature))
1486          (entry (find-pitch-entry keysig pitch #t #t)))
1487     (if (not entry)
1488         (cons #f #f)
1489         (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1490                (key-acc (key-entry-alteration global-entry))
1491                (acc (ly:pitch-alteration pitch))
1492                (entrymp (key-entry-measure-position entry))
1493                (entrybn (key-entry-bar-number entry)))
1494           (cons #f (not (or (equal? acc key-acc)
1495                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1496
1497 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1498   "An accidental rule that typesets a cautionary accidental if it is
1499 included in the key signature @emph{and} does not directly follow a note
1500 on the same staff line."
1501   (let* ((keysig (ly:context-property context 'localKeySignature))
1502          (entry (find-pitch-entry keysig pitch #t #t)))
1503     (if (not entry)
1504         (cons #f #f)
1505         (let* ((entrymp (key-entry-measure-position entry))
1506                (entrybn (key-entry-bar-number entry)))
1507           (cons #f (not (and (equal? entrybn barnum) (equal? entrymp measurepos))))))))
1508
1509 (define-public (set-accidentals-properties extra-natural
1510                                            auto-accs auto-cauts
1511                                            context)
1512   (context-spec-music
1513    (make-sequential-music
1514     (append (if (boolean? extra-natural)
1515                 (list (make-property-set 'extraNatural extra-natural))
1516                 '())
1517             (list (make-property-set 'autoAccidentals auto-accs)
1518                   (make-property-set 'autoCautionaries auto-cauts))))
1519    context))
1520
1521 (define-public (set-accidental-style style . rest)
1522   "Set accidental style to @var{style}.  Optionally take a context
1523 argument, e.g. @code{'Staff} or @code{'Voice}.  The context defaults
1524 to @code{Staff}, except for piano styles, which use @code{GrandStaff}
1525 as a context."
1526   (let ((context (if (pair? rest)
1527                      (car rest) 'Staff))
1528         (pcontext (if (pair? rest)
1529                       (car rest) 'GrandStaff)))
1530     (cond
1531       ;; accidentals as they were common in the 18th century.
1532       ((equal? style 'default)
1533        (set-accidentals-properties #t
1534                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1535                                    '()
1536                                    context))
1537       ;; accidentals from one voice do NOT get canceled in other voices
1538       ((equal? style 'voice)
1539        (set-accidentals-properties #t
1540                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1541                                    '()
1542                                    context))
1543       ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1544       ;; This includes all the default accidentals, but accidentals also needs canceling
1545       ;; in other octaves and in the next measure.
1546       ((equal? style 'modern)
1547        (set-accidentals-properties #f
1548                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1549                                            ,(make-accidental-rule 'any-octave 0)
1550                                            ,(make-accidental-rule 'same-octave 1))
1551                                    '()
1552                                    context))
1553       ;; the accidentals that Stone adds to the old standard as cautionaries
1554       ((equal? style 'modern-cautionary)
1555        (set-accidentals-properties #f
1556                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1557                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1558                                            ,(make-accidental-rule 'same-octave 1))
1559                                    context))
1560       ;; same as modern, but accidentals different from the key signature are always
1561       ;; typeset - unless they directly follow a note of the same pitch.
1562       ((equal? style 'neo-modern)
1563        (set-accidentals-properties #f
1564                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1565                                            ,(make-accidental-rule 'any-octave 0)
1566                                            ,(make-accidental-rule 'same-octave 1)
1567                                            ,neo-modern-accidental-rule)
1568                                    '()
1569                                    context))
1570       ((equal? style 'neo-modern-cautionary)
1571        (set-accidentals-properties #f
1572                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1573                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1574                                            ,(make-accidental-rule 'same-octave 1)
1575                                            ,neo-modern-accidental-rule)
1576                                    context))
1577       ((equal? style 'neo-modern-voice)
1578        (set-accidentals-properties #f
1579                                    `(Voice ,(make-accidental-rule 'same-octave 0)
1580                                            ,(make-accidental-rule 'any-octave 0)
1581                                            ,(make-accidental-rule 'same-octave 1)
1582                                            ,neo-modern-accidental-rule
1583                                      Staff ,(make-accidental-rule 'same-octave 0)
1584                                            ,(make-accidental-rule 'any-octave 0)
1585                                            ,(make-accidental-rule 'same-octave 1)
1586                                       ,neo-modern-accidental-rule)
1587                                    '()
1588                                    context))
1589       ((equal? style 'neo-modern-voice-cautionary)
1590        (set-accidentals-properties #f
1591                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1592                                    `(Voice ,(make-accidental-rule 'any-octave 0)
1593                                            ,(make-accidental-rule 'same-octave 1)
1594                                            ,neo-modern-accidental-rule
1595                                      Staff ,(make-accidental-rule 'same-octave 0)
1596                                            ,(make-accidental-rule 'any-octave 0)
1597                                            ,(make-accidental-rule 'same-octave 1)
1598                                            ,neo-modern-accidental-rule)
1599                                    context))
1600       ;; Accidentals as they were common in dodecaphonic music with no tonality.
1601       ;; Each note gets one accidental.
1602       ((equal? style 'dodecaphonic)
1603        (set-accidentals-properties #f
1604                                    `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1605                                    '()
1606                                    context))
1607       ;; Multivoice accidentals to be read both by musicians playing one voice
1608       ;; and musicians playing all voices.
1609       ;; Accidentals are typeset for each voice, but they ARE canceled across voices.
1610       ((equal? style 'modern-voice)
1611        (set-accidentals-properties  #f
1612                                     `(Voice ,(make-accidental-rule 'same-octave 0)
1613                                             ,(make-accidental-rule 'any-octave 0)
1614                                             ,(make-accidental-rule 'same-octave 1)
1615                                       Staff ,(make-accidental-rule 'same-octave 0)
1616                                             ,(make-accidental-rule 'any-octave 0)
1617                                             ,(make-accidental-rule 'same-octave 1))
1618                                     '()
1619                                     context))
1620       ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1621       ;; as cautionaries
1622       ((equal? style 'modern-voice-cautionary)
1623        (set-accidentals-properties #f
1624                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1625                                    `(Voice ,(make-accidental-rule 'any-octave 0)
1626                                            ,(make-accidental-rule 'same-octave 1)
1627                                      Staff ,(make-accidental-rule 'same-octave 0)
1628                                            ,(make-accidental-rule 'any-octave 0)
1629                                            ,(make-accidental-rule 'same-octave 1))
1630                                    context))
1631       ;; stone's suggestions for accidentals on grand staff.
1632       ;; Accidentals are canceled across the staves in the same grand staff as well
1633       ((equal? style 'piano)
1634        (set-accidentals-properties #f
1635                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1636                                            ,(make-accidental-rule 'any-octave 0)
1637                                            ,(make-accidental-rule 'same-octave 1)
1638                                      GrandStaff
1639                                            ,(make-accidental-rule 'any-octave 0)
1640                                            ,(make-accidental-rule 'same-octave 1))
1641                                    '()
1642                                    pcontext))
1643       ((equal? style 'piano-cautionary)
1644        (set-accidentals-properties #f
1645                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1646                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1647                                            ,(make-accidental-rule 'same-octave 1)
1648                                      GrandStaff
1649                                            ,(make-accidental-rule 'any-octave 0)
1650                                            ,(make-accidental-rule 'same-octave 1))
1651                                    pcontext))
1652
1653       ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1654       ;; tones specified by the key signature.
1655        ((equal? style 'teaching)
1656        (set-accidentals-properties #f
1657                                     `(Staff ,(make-accidental-rule 'same-octave 0))
1658                                     `(Staff ,(make-accidental-rule 'same-octave 1)
1659                                            ,teaching-accidental-rule)
1660                                    context))
1661
1662       ;; do not set localKeySignature when a note alterated differently from
1663       ;; localKeySignature is found.
1664       ;; Causes accidentals to be printed at every note instead of
1665       ;; remembered for the duration of a measure.
1666       ;; accidentals not being remembered, causing accidentals always to
1667       ;; be typeset relative to the time signature
1668       ((equal? style 'forget)
1669        (set-accidentals-properties '()
1670                                    `(Staff ,(make-accidental-rule 'same-octave -1))
1671                                    '()
1672                                    context))
1673       ;; Do not reset the key at the start of a measure.  Accidentals will be
1674       ;; printed only once and are in effect until overridden, possibly many
1675       ;; measures later.
1676       ((equal? style 'no-reset)
1677        (set-accidentals-properties '()
1678                                    `(Staff ,(make-accidental-rule 'same-octave #t))
1679                                    '()
1680                                    context))
1681       (else
1682        (ly:warning (_ "unknown accidental style: ~S") style)
1683        (make-sequential-music '())))))
1684
1685 (define-public (invalidate-alterations context)
1686   "Invalidate alterations in @var{context}.
1687
1688 Elements of @code{'localKeySignature} corresponding to local
1689 alterations of the key signature have the form
1690 @code{'((octave . notename) . (alter barnum . measurepos))}.
1691 Replace them with a version where @code{alter} is set to @code{'clef}
1692 to force a repetition of accidentals.
1693
1694 Entries that conform with the current key signature are not invalidated."
1695   (let* ((keysig (ly:context-property context 'keySignature)))
1696     (set! (ly:context-property context 'localKeySignature)
1697           (map-in-order
1698            (lambda (entry)
1699              (let* ((localalt (key-entry-alteration entry)))
1700                (if (or (accidental-invalid? localalt)
1701                        (not (key-entry-bar-number entry))
1702                        (= localalt
1703                           (key-entry-alteration
1704                            (find-pitch-entry
1705                             keysig
1706                             (ly:make-pitch (key-entry-octave entry)
1707                                            (key-entry-notename entry)
1708                                            0)
1709                             #t #t))))
1710                    entry
1711                    (cons (car entry) (cons 'clef (cddr entry))))))
1712            (ly:context-property context 'localKeySignature)))))
1713
1714 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1715
1716 (define-public (skip-of-length mus)
1717   "Create a skip of exactly the same length as @var{mus}."
1718   (let* ((skip
1719           (make-music
1720            'SkipEvent
1721            'duration (ly:make-duration 0 0))))
1722
1723     (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1724
1725 (define-public (mmrest-of-length mus)
1726   "Create a multi-measure rest of exactly the same length as @var{mus}."
1727
1728   (let* ((skip
1729           (make-multi-measure-rest
1730            (ly:make-duration 0 0) '())))
1731     (ly:music-compress skip (ly:music-length mus))
1732     skip))
1733
1734 (define-public (pitch-of-note event-chord)
1735   (let ((evs (filter (lambda (x)
1736                        (music-has-type x 'note-event))
1737                      (ly:music-property event-chord 'elements))))
1738
1739     (and (pair? evs)
1740          (ly:music-property (car evs) 'pitch))))
1741
1742 (define-public (duration-of-note event-chord)
1743   (cond
1744    ((pair? event-chord)
1745     (or (duration-of-note (car event-chord))
1746         (duration-of-note (cdr event-chord))))
1747    ((ly:music? event-chord)
1748     (let ((dur (ly:music-property event-chord 'duration)))
1749       (if (ly:duration? dur)
1750           dur
1751           (duration-of-note (ly:music-property event-chord 'elements)))))
1752    (else #f)))
1753
1754 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1755
1756 (define-public (map-some-music map? music)
1757   "Walk through @var{music}, transform all elements calling @var{map?}
1758 and only recurse if this returns @code{#f}."
1759   (let loop ((music music))
1760     (or (map? music)
1761         (let ((elt (ly:music-property music 'element))
1762               (elts (ly:music-property music 'elements))
1763               (arts (ly:music-property music 'articulations)))
1764           (if (ly:music? elt)
1765               (set! (ly:music-property music 'element)
1766                     (loop elt)))
1767           (if (pair? elts)
1768               (set! (ly:music-property music 'elements)
1769                     (map loop elts)))
1770           (if (pair? arts)
1771               (set! (ly:music-property music 'articulations)
1772                     (map loop arts)))
1773           music))))
1774
1775 (define-public (for-some-music stop? music)
1776   "Walk through @var{music}, process all elements calling @var{stop?}
1777 and only recurse if this returns @code{#f}."
1778   (let loop ((music music))
1779     (if (not (stop? music))
1780         (let ((elt (ly:music-property music 'element)))
1781           (if (ly:music? elt)
1782               (loop elt))
1783           (for-each loop (ly:music-property music 'elements))
1784           (for-each loop (ly:music-property music 'articulations))))))
1785
1786 (define-public (fold-some-music pred? proc init music)
1787   "This works recursively on music like @code{fold} does on a list,
1788 calling @samp{(@var{pred?} music)} on every music element.  If
1789 @code{#f} is returned for an element, it is processed recursively
1790 with the same initial value of @samp{previous}, otherwise
1791 @samp{(@var{proc} music previous)} replaces @samp{previous}
1792 and no recursion happens.
1793 The top @var{music} is processed using @var{init} for @samp{previous}."
1794   (let loop ((music music) (previous init))
1795     (if (pred? music)
1796         (proc music previous)
1797         (fold loop
1798               (fold loop
1799                     (let ((elt (ly:music-property music 'element)))
1800                       (if (null? elt)
1801                           previous
1802                           (loop elt previous)))
1803                     (ly:music-property music 'elements))
1804               (ly:music-property music 'articulations)))))
1805
1806 (define-public (extract-music music pred?)
1807   "Return a flat list of all music matching @var{pred?} inside of
1808 @var{music}, not recursing into matches themselves."
1809   (reverse! (fold-some-music pred? cons '() music)))
1810
1811 (define-public (extract-named-music music music-name)
1812   "Return a flat list of all music named @var{music-name} (either a
1813 single event symbol or a list of alternatives) inside of @var{music},
1814 not recursing into matches themselves."
1815   (extract-music
1816    music
1817    (if (cheap-list? music-name)
1818        (lambda (m) (memq (ly:music-property m 'name) music-name))
1819        (lambda (m) (eq? (ly:music-property m 'name) music-name)))))
1820
1821 (define-public (extract-typed-music music type)
1822   "Return a flat list of all music with @var{type} (either a single
1823 type symbol or a list of alternatives) inside of @var{music}, not
1824 recursing into matches themselves."
1825   (extract-music
1826    music
1827    (if (cheap-list? type)
1828        (lambda (m)
1829          (any (lambda (t) (music-is-of-type? m t)) type))
1830        (lambda (m) (music-is-of-type? m type)))))
1831
1832 (define*-public (event-chord-wrap! music #:optional parser)
1833   "Wrap isolated rhythmic events and non-postevent events in
1834 @var{music} inside of an @code{EventChord}.  If the optional
1835 @var{parser} argument is given, chord repeats @samp{q} are expanded
1836 using the default settings.  Otherwise, you need to cater for them
1837 yourself."
1838   (map-some-music
1839    (lambda (m)
1840      (cond ((music-is-of-type? m 'event-chord)
1841             (if (pair? (ly:music-property m 'articulations))
1842                 (begin
1843                   (set! (ly:music-property m 'elements)
1844                         (append (ly:music-property m 'elements)
1845                                 (ly:music-property m 'articulations)))
1846                   (set! (ly:music-property m 'articulations) '())))
1847             m)
1848            ((music-is-of-type? m 'rhythmic-event)
1849             (let ((arts (ly:music-property m 'articulations)))
1850               (if (pair? arts)
1851                   (set! (ly:music-property m 'articulations) '()))
1852               (make-event-chord (cons m arts))))
1853            (else #f)))
1854    (if parser
1855        (expand-repeat-chords!
1856         (cons 'rhythmic-event
1857               (ly:parser-lookup parser '$chord-repeat-events))
1858         music)
1859        music)))
1860
1861 (define-public (event-chord-notes event-chord)
1862   "Return a list of all notes from @var{event-chord}."
1863   (filter
1864     (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1865     (ly:music-property event-chord 'elements)))
1866
1867 (define-public (event-chord-pitches event-chord)
1868   "Return a list of all pitches from @var{event-chord}."
1869   (map (lambda (x) (ly:music-property x 'pitch))
1870        (event-chord-notes event-chord)))
1871
1872 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1873 ; The following functions are all associated with the crossStaff
1874 ;  function
1875
1876 (define (close-enough? x y)
1877   "Values are close enough to ignore the difference"
1878    (< (abs (- x y)) 0.0001))
1879
1880 (define (extent-combine extents)
1881   "Combine a list of extents"
1882   (if (pair? (cdr extents))
1883       (interval-union (car extents) (extent-combine (cdr extents)))
1884       (car extents)))
1885
1886 (define ((stem-connectable? ref root) stem)
1887   "Check if the stem is connectable to the root"
1888   ; The root is always connectable to itself
1889   (or (eq? root stem)
1890       (and
1891       ; Horizontal positions of the stems must be almost the same
1892         (close-enough? (car (ly:grob-extent root ref X))
1893           (car (ly:grob-extent stem ref X)))
1894         ; The stem must be in the direction away from the root's notehead
1895         (positive? (* (ly:grob-property root 'direction)
1896                      (- (car (ly:grob-extent stem ref Y))
1897                        (car (ly:grob-extent root ref Y))))))))
1898
1899 (define (stem-span-stencil span)
1900   "Connect stems if we have at least one stem connectable to the root"
1901   (let* ((system (ly:grob-system span))
1902           (root (ly:grob-parent span X))
1903           (stems (filter (stem-connectable? system root)
1904                          (ly:grob-object span 'stems))))
1905      (if (<= 2 (length stems))
1906          (let* ((yextents (map (lambda (st)
1907                                  (ly:grob-extent st system Y)) stems))
1908                 (yextent (extent-combine yextents))
1909                 (layout (ly:grob-layout root))
1910                 (blot (ly:output-def-lookup layout 'blot-diameter)))
1911            ; Hide spanned stems
1912            (map (lambda (st)
1913                   (set! (ly:grob-property st 'transparent) #t))
1914              stems)
1915            ; Draw a nice looking stem with rounded corners
1916            (ly:round-filled-box (ly:grob-extent root root X) yextent blot))
1917          ; Nothing to connect, don't draw the span
1918          #f)))
1919
1920 (define ((make-stem-span! stems trans) root)
1921   "Create a stem span as a child of the cross-staff stem (the root)"
1922   (let ((span (ly:engraver-make-grob trans 'Stem '())))
1923     (ly:grob-set-parent! span X root)
1924     (set! (ly:grob-object span 'stems) stems)
1925     ; Suppress positioning, the stem code is confused by this weird stem
1926     (set! (ly:grob-property span 'X-offset) 0)
1927     (set! (ly:grob-property span 'stencil) stem-span-stencil)))
1928
1929 (define-public (cross-staff-connect stem)
1930   "Set cross-staff property of the stem to this function to connect it to
1931 other stems automatically"
1932    #t)
1933
1934 (define (stem-is-root? stem)
1935   "Check if automatic connecting of the stem was requested.  Stems connected
1936 to cross-staff beams are cross-staff, but they should not be connected to
1937 other stems just because of that."
1938   (eq? cross-staff-connect (ly:grob-property-data stem 'cross-staff)))
1939
1940 (define (make-stem-spans! ctx stems trans)
1941   "Create stem spans for cross-staff stems"
1942   ; Cannot do extensive checks here, just make sure there are at least
1943   ; two stems at this musical moment
1944   (if (<= 2 (length stems))
1945     (let ((roots (filter stem-is-root? stems)))
1946     (map (make-stem-span! stems trans) roots))))
1947
1948 (define-public (Span_stem_engraver ctx)
1949   "Connect cross-staff stems to the stems above in the system"
1950   (let ((stems '()))
1951     (make-engraver
1952       ; Record all stems for the given moment
1953       (acknowledgers
1954         ((stem-interface trans grob source)
1955         (set! stems (cons grob stems))))
1956       ; Process stems and reset the stem list to empty
1957       ((process-acknowledged trans)
1958         (make-stem-spans! ctx stems trans)
1959         (set! stems '())))))
1960
1961 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1962 ;; The following is used by the alterBroken function.
1963
1964 (define-public ((value-for-spanner-piece arg) grob)
1965   "Associate a piece of broken spanner @var{grob} with an element
1966 of list @var{arg}."
1967   (let* ((orig (ly:grob-original grob))
1968          (siblings (ly:spanner-broken-into orig)))
1969
1970    (define (helper sibs arg)
1971      (if (null? arg)
1972          arg
1973          (if (eq? (car sibs) grob)
1974              (car arg)
1975              (helper (cdr sibs) (cdr arg)))))
1976
1977    (if (>= (length siblings) 2)
1978        (helper siblings arg)
1979        (car arg))))
1980
1981 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1982 ;; measure counter
1983
1984 (define (measure-counter-stencil grob)
1985   "Print a number for a measure count.  The number is centered using
1986 the extents of @code{BreakAlignment} grobs associated with
1987 @code{NonMusicalPaperColumn} grobs.  In the case of an unbroken measure, these
1988 columns are the left and right bounds of a @code{MeasureCounter} spanner.
1989 Broken measures are numbered in parentheses."
1990   (let* ((orig (ly:grob-original grob))
1991          (siblings (ly:spanner-broken-into orig)) ; have we been split?
1992          (bounds (ly:grob-array->list (ly:grob-object grob 'columns)))
1993          (refp (ly:grob-system grob))
1994          ; we use the first and/or last NonMusicalPaperColumn grob(s) of
1995          ; a system in the event that a MeasureCounter spanner is broken
1996          (all-cols (ly:grob-array->list (ly:grob-object refp 'columns)))
1997          (all-cols
1998            (filter
1999              (lambda (col) (eq? #t (ly:grob-property col 'non-musical)))
2000              all-cols))
2001          (left-bound
2002            (if (or (null? siblings) ; spanner is unbroken
2003                    (eq? grob (car siblings))) ; or the first piece
2004                (car bounds)
2005                (car all-cols)))
2006          (right-bound
2007            (if (or (null? siblings)
2008                    (eq? grob (car (reverse siblings))))
2009                (car (reverse bounds))
2010                (car (reverse all-cols))))
2011          (elts-L (ly:grob-array->list (ly:grob-object left-bound 'elements)))
2012          (elts-R (ly:grob-array->list (ly:grob-object right-bound 'elements)))
2013          (break-alignment-L
2014            (filter
2015              (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2016              elts-L))
2017          (break-alignment-R
2018            (filter
2019              (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2020              elts-R))
2021          (break-alignment-L-ext (ly:grob-extent (car break-alignment-L) refp X))
2022          (break-alignment-R-ext (ly:grob-extent (car break-alignment-R) refp X))
2023          (num (markup (number->string (ly:grob-property grob 'count-from))))
2024          (num
2025            (if (or (null? siblings)
2026                    (eq? grob (car siblings)))
2027                num
2028                (make-parenthesize-markup num)))
2029          (num (grob-interpret-markup grob num))
2030          (num (ly:stencil-aligned-to num X (ly:grob-property grob 'self-alignment-X)))
2031          (num
2032            (ly:stencil-translate-axis
2033              num
2034              (+ (interval-length break-alignment-L-ext)
2035                 (* 0.5
2036                    (- (car break-alignment-R-ext)
2037                       (cdr break-alignment-L-ext))))
2038              X)))
2039     num))