scm/music-functions.scm

   1 ;;;; music-functions.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
   6 ;;;;                 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 ;; (use-modules (ice-9 optargs))
   9
  10 ;;; ly:music-property with setter
  11 ;;; (ly:music-property my-music 'elements)
  12 ;;;   ==> the 'elements property
  13 ;;; (set! (ly:music-property my-music 'elements) value)
  14 ;;;   ==> set the 'elements property and return it
  15 (define-public ly:music-property
  16   (make-procedure-with-setter ly:music-property
  17                               ly:music-set-property!))
  18
  19 (define-safe-public (music-is-of-type? mus type)
  20   "Does @code{mus} belong to the music class @code{type}?"
  21   (memq type (ly:music-property mus 'types)))
  22
  23 ;; TODO move this
  24 (define-public ly:grob-property
  25   (make-procedure-with-setter ly:grob-property
  26                               ly:grob-set-property!))
  27
  28 (define-public ly:prob-property
  29   (make-procedure-with-setter ly:prob-property
  30                               ly:prob-set-property!))
  31
  32 (define-public (music-map function music)
  33   "Apply @var{function} to @var{music} and all of the music it contains.
  34
  35 First it recurses over the children, then the function is applied to MUSIC.
  36 "
  37   (let ((es (ly:music-property music 'elements))
  38         (e (ly:music-property music 'element)))
  39     (set! (ly:music-property music 'elements)
  40           (map (lambda (y) (music-map function y)) es))
  41     (if (ly:music? e)
  42         (set! (ly:music-property music 'element)
  43               (music-map function  e)))
  44     (function music)))
  45
  46 (define-public (music-filter pred? music)
  47   "Filter out music expressions that do not satisfy PRED."
  48
  49   (define (inner-music-filter pred? music)
  50     "Recursive function."
  51     (let* ((es (ly:music-property music 'elements))
  52            (e (ly:music-property music 'element))
  53            (as (ly:music-property music 'articulations))
  54            (filtered-as (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) as)))
  55            (filtered-e (if (ly:music? e)
  56                            (inner-music-filter pred? e)
  57                            e))
  58            (filtered-es (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) es))))
  59       (set! (ly:music-property music 'element) filtered-e)
  60       (set! (ly:music-property music 'elements) filtered-es)
  61       (set! (ly:music-property music 'articulations) filtered-as)
  62       ;; if filtering emptied the expression, we remove it completely.
  63       (if (or (not (pred? music))
  64               (and (eq? filtered-es '()) (not (ly:music? e))
  65                    (or (not (eq? es '()))
  66                        (ly:music? e))))
  67           (set! music '()))
  68       music))
  69
  70   (set! music (inner-music-filter pred? music))
  71   (if (ly:music? music)
  72       music
  73       (make-music 'Music)))       ;must return music.
  74
  75 (define-public (display-music music)
  76   "Display music, not done with music-map for clarity of presentation."
  77
  78   (display music)
  79   (display ": { ")
  80   (let ((es (ly:music-property music 'elements))
  81         (e (ly:music-property music 'element)))
  82     (display (ly:music-mutable-properties music))
  83     (if (pair? es)
  84         (begin (display "\nElements: {\n")
  85                (map display-music es)
  86                (display "}\n")))
  87     (if (ly:music? e)
  88         (begin
  89           (display "\nChild:")
  90           (display-music e))))
  91   (display " }\n")
  92   music)
  93
  94 ;;;
  95 ;;; A scheme music pretty printer
  96 ;;;
  97 (define (markup-expression->make-markup markup-expression)
  98   "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression.
  99 For instance,
 100   \\markup \\bold \\italic hello
 101 ==>
 102   (markup #:line (#:bold (#:italic (#:simple \"hello\"))))"
 103   (define (proc->command-keyword proc)
 104     "Return a keyword, eg. `#:bold', from the `proc' function, eg. #<procedure bold-markup (layout props arg)>"
 105     (let ((cmd-markup (symbol->string (procedure-name proc))))
 106       (symbol->keyword (string->symbol (substring cmd-markup 0 (- (string-length cmd-markup)
 107                                                                   (string-length "-markup")))))))
 108   (define (transform-arg arg)
 109     (cond ((and (pair? arg) (markup? (car arg))) ;; a markup list
 110            (apply append (map inner-markup->make-markup arg)))
 111           ((and (not (string? arg)) (markup? arg)) ;; a markup
 112            (inner-markup->make-markup arg))
 113           (else                                  ;; scheme arg
 114            arg)))
 115   (define (inner-markup->make-markup mrkup)
 116     (if (string? mrkup)
 117         `(#:simple ,mrkup)
 118         (let ((cmd (proc->command-keyword (car mrkup)))
 119               (args (map transform-arg (cdr mrkup))))
 120           `(,cmd ,@args))))
 121   ;; body:
 122   (if (string? markup-expression)
 123       markup-expression
 124       `(markup ,@(inner-markup->make-markup markup-expression))))
 125
 126 (define-public (music->make-music obj)
 127   "Generate a expression that, once evaluated, may return an object equivalent to `obj',
 128 that is, for a music expression, a (make-music ...) form."
 129   (cond (;; markup expression
 130          (markup? obj)
 131          (markup-expression->make-markup obj))
 132         (;; music expression
 133          (ly:music? obj)
 134          `(make-music
 135            ',(ly:music-property obj 'name)
 136            ,@(apply append (map (lambda (prop)
 137                                   `(',(car prop)
 138                                     ,(music->make-music (cdr prop))))
 139                                 (remove (lambda (prop)
 140                                           (eqv? (car prop) 'origin))
 141                                         (ly:music-mutable-properties obj))))))
 142         (;; moment
 143          (ly:moment? obj)
 144          `(ly:make-moment ,(ly:moment-main-numerator obj)
 145                           ,(ly:moment-main-denominator obj)
 146                           ,(ly:moment-grace-numerator obj)
 147                           ,(ly:moment-grace-denominator obj)))
 148         (;; note duration
 149          (ly:duration? obj)
 150          `(ly:make-duration ,(ly:duration-log obj)
 151                             ,(ly:duration-dot-count obj)
 152                             ,(car (ly:duration-factor obj))
 153                             ,(cdr (ly:duration-factor obj))))
 154         (;; note pitch
 155          (ly:pitch? obj)
 156          `(ly:make-pitch ,(ly:pitch-octave obj)
 157                          ,(ly:pitch-notename obj)
 158                          ,(ly:pitch-alteration obj)))
 159         (;; scheme procedure
 160          (procedure? obj)
 161          (or (procedure-name obj) obj))
 162         (;; a symbol (avoid having an unquoted symbol)
 163          (symbol? obj)
 164          `',obj)
 165         (;; an empty list (avoid having an unquoted empty list)
 166          (null? obj)
 167          `'())
 168         (;; a proper list
 169          (list? obj)
 170          `(list ,@(map music->make-music obj)))
 171         (;; a pair
 172          (pair? obj)
 173          `(cons ,(music->make-music (car obj))
 174                 ,(music->make-music (cdr obj))))
 175         (else
 176          obj)))
 177
 178 (use-modules (ice-9 pretty-print))
 179 (define*-public (display-scheme-music obj #:optional (port (current-output-port)))
 180   "Displays `obj', typically a music expression, in a friendly fashion,
 181 which often can be read back in order to generate an equivalent expression.
 182
 183 Returns `obj'.
 184 "
 185   (pretty-print (music->make-music obj) port)
 186   (newline)
 187   obj)
 188
 189 ;;;
 190 ;;; Scheme music expression --> Lily-syntax-using string translator
 191 ;;;
 192 (use-modules (srfi srfi-39)
 193              (scm display-lily))
 194
 195 (define*-public (display-lily-music expr parser #:key force-duration)
 196   "Display the music expression using LilyPond syntax"
 197   (memoize-clef-names supported-clefs)
 198   (parameterize ((*indent* 0)
 199                  (*previous-duration* (ly:make-duration 2))
 200                  (*force-duration* force-duration))
 201     (display (music->lily-string expr parser))
 202     (newline)))
 203
 204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 205
 206 (define-public (shift-one-duration-log music shift dot)
 207   "  add SHIFT to duration-log of 'duration in music and optionally
 208   a dot to any note encountered. This scales the music up by a factor
 209   2^shift * (2 - (1/2)^dot)"
 210   (let ((d (ly:music-property music 'duration)))
 211     (if (ly:duration? d)
 212         (let* ((cp (ly:duration-factor d))
 213                (nd (ly:make-duration (+ shift (ly:duration-log d))
 214                                      (+ dot (ly:duration-dot-count d))
 215                                      (car cp)
 216                                      (cdr cp))))
 217           (set! (ly:music-property music 'duration) nd)))
 218     music))
 219
 220 (define-public (shift-duration-log music shift dot)
 221   (music-map (lambda (x) (shift-one-duration-log x shift dot))
 222              music))
 223
 224 (define-public (make-repeat name times main alts)
 225   "create a repeat music expression, with all properties initialized properly"
 226   (let ((talts (if (< times (length alts))
 227                    (begin
 228                      (ly:warning (_ "More alternatives than repeats.  Junking excess alternatives"))
 229                      (take alts times))
 230                    alts))
 231         (r (make-repeated-music name)))
 232     (set! (ly:music-property r 'element) main)
 233     (set! (ly:music-property r 'repeat-count) (max times 1))
 234     (set! (ly:music-property r 'elements) talts)
 235     (if (equal? name "tremolo")
 236         (let* ((dots (1- (logcount times)))
 237                (mult (/ (* times (ash 1 dots)) (1- (ash 2 dots))))
 238                (shift (- (ly:intlog2 (floor mult)))))
 239           (if (not (integer?  mult))
 240               (ly:warning (_ "invalid tremolo repeat count: ~a") times))
 241           (if (memq 'sequential-music (ly:music-property main 'types))
 242               ;; \repeat "tremolo" { c4 d4 }
 243               (let ((children (length (ly:music-property main 'elements))))
 244
 245                 ;; fixme: should be more generic.
 246                 (if (and (not (= children 2))
 247                          (not (= children 1)))
 248                     (ly:warning (_ "expecting 2 elements for chord tremolo, found ~a") children))
 249                 (ly:music-compress r (ly:make-moment 1 children))
 250                 (shift-duration-log r
 251                                     (if (= children 2)  (1- shift) shift)
 252                                     dots))
 253               ;; \repeat "tremolo" c4
 254               (shift-duration-log r shift dots)))
 255         r)))
 256
 257 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 258 ;; clusters.
 259
 260 (define-public (note-to-cluster music)
 261   "Replace NoteEvents by ClusterNoteEvents."
 262   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 263       (make-music 'ClusterNoteEvent
 264                   'pitch (ly:music-property music 'pitch)
 265                   'duration (ly:music-property music 'duration))
 266       music))
 267
 268 (define-public (notes-to-clusters music)
 269   (music-map note-to-cluster music))
 270
 271 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 272 ;; repeats.
 273
 274 (define-public (unfold-repeats music)
 275   "
 276 This function replaces all repeats  with unfold repeats. "
 277
 278   (let ((es (ly:music-property music 'elements))
 279         (e  (ly:music-property music 'element))
 280         )
 281     (if (memq 'repeated-music (ly:music-property music 'types))
 282         (let*
 283             ((props (ly:music-mutable-properties music))
 284              (old-name (ly:music-property music 'name))
 285              (flattened  (flatten-alist props)))
 286
 287           (set! music (apply make-music (cons 'UnfoldedRepeatedMusic
 288                                               flattened)))
 289
 290           (if (equal? old-name 'TremoloRepeatedMusic)
 291               (let* ((seq-arg? (memq 'sequential-music
 292                                      (ly:music-property e 'types)))
 293                      (count  (ly:music-property music 'repeat-count))
 294                      (dot-shift (if (= 0 (remainder count 3))
 295                                     -1 0)))
 296
 297                 (if (= 0 -1)
 298                     (set! count (* 2 (quotient count 3))))
 299
 300                 (shift-duration-log music (+ (if seq-arg? 1 0)
 301                                              (ly:intlog2 count)) dot-shift)
 302
 303                 (if seq-arg?
 304                     (ly:music-compress e (ly:make-moment (length (ly:music-property
 305                                                                   e 'elements)) 1)))))))
 306
 307
 308     (if (pair? es)
 309         (set! (ly:music-property music 'elements)
 310               (map unfold-repeats es)))
 311     (if (ly:music? e)
 312         (set! (ly:music-property music 'element)
 313               (unfold-repeats e)))
 314     music))
 315
 316 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 317 ;; property setting music objs.
 318
 319 (define-public (make-grob-property-set grob gprop val)
 320   "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
 321 i.e.  this is not an override"
 322   (make-music 'OverrideProperty
 323               'symbol grob
 324               'grob-property gprop
 325               'grob-value val
 326               'pop-first #t))
 327
 328 (define-public (make-grob-property-override grob gprop val)
 329   "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
 330 i.e.  this is not an override"
 331   (make-music 'OverrideProperty
 332               'symbol grob
 333               'grob-property gprop
 334               'grob-value val))
 335
 336 (define-public (make-grob-property-revert grob gprop)
 337   "Revert the grob property GPROP for GROB."
 338   (make-music 'RevertProperty
 339               'symbol grob
 340               'grob-property gprop))
 341
 342 (define direction-polyphonic-grobs
 343   '(DotColumn
 344     Dots
 345     Fingering
 346     LaissezVibrerTie
 347     PhrasingSlur
 348     RepeatTie
 349     Rest
 350     Script
 351     Slur
 352     Stem
 353     TextScript
 354     Tie))
 355
 356 (define-safe-public (make-voice-props-set n)
 357   (make-sequential-music
 358    (append
 359     (map (lambda (x) (make-grob-property-set x 'direction
 360                                              (if (odd? n) -1 1)))
 361          direction-polyphonic-grobs)
 362     (list
 363      (make-property-set 'graceSettings
 364                         ;; TODO: take this from voicedGraceSettings or similar.
 365                         '((Voice Stem font-size -3)
 366                           (Voice NoteHead font-size -3)
 367                           (Voice Dots font-size -3)
 368                           (Voice Stem length-fraction 0.8)
 369                           (Voice Stem no-stem-extend #t)
 370                           (Voice Beam thickness 0.384)
 371                           (Voice Beam length-fraction 0.8)
 372                           (Voice Accidental font-size -4)))
 373
 374      (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
 375      (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
 376
 377 (define-safe-public (make-voice-props-revert)
 378   (make-sequential-music
 379    (append
 380     (map (lambda (x) (make-grob-property-revert x 'direction))
 381          direction-polyphonic-grobs)
 382     (list (make-property-unset 'graceSettings)
 383           (make-grob-property-revert 'NoteColumn 'horizontal-shift)
 384           (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
 385
 386
 387 (define-safe-public (context-spec-music m context #:optional id)
 388   "Add \\context CONTEXT = ID to M. "
 389   (let ((cm (make-music 'ContextSpeccedMusic
 390                         'element m
 391                         'context-type context)))
 392     (if (string? id)
 393         (set! (ly:music-property cm 'context-id) id))
 394     cm))
 395
 396 (define-public (descend-to-context m context)
 397   "Like context-spec-music, but only descending. "
 398   (let ((cm (context-spec-music m context)))
 399     (ly:music-set-property! cm 'descend-only #t)
 400     cm))
 401
 402 (define-public (make-non-relative-music mus)
 403   (make-music 'UnrelativableMusic
 404               'element mus))
 405
 406 (define-public (make-apply-context func)
 407   (make-music 'ApplyContext
 408               'procedure func))
 409
 410 (define-public (make-sequential-music elts)
 411   (make-music 'SequentialMusic
 412               'elements elts))
 413
 414 (define-public (make-simultaneous-music elts)
 415   (make-music 'SimultaneousMusic
 416               'elements elts))
 417
 418 (define-safe-public (make-event-chord elts)
 419   (make-music 'EventChord
 420               'elements elts))
 421
 422 (define-public (make-skip-music dur)
 423   (make-music 'SkipMusic
 424               'duration dur))
 425
 426 (define-public (make-grace-music music)
 427   (make-music 'GraceMusic
 428               'element music))
 429
 430 ;;;;;;;;;;;;;;;;
 431
 432 ;; mmrest
 433 (define-public (make-multi-measure-rest duration location)
 434   (make-music 'MultiMeasureRestMusic
 435               'origin location
 436               'duration duration))
 437
 438 (define-public (make-property-set sym val)
 439   (make-music 'PropertySet
 440               'symbol sym
 441               'value val))
 442
 443 (define-public (make-property-unset sym)
 444   (make-music 'PropertyUnset
 445               'symbol sym))
 446
 447 (define-public (make-ottava-set octavation)
 448   (let ((m (make-music 'ApplyContext)))
 449     (define (ottava-modify context)
 450       "Either reset middleCPosition to the stored original, or remember
 451 old middleCPosition, add OCTAVATION to middleCPosition, and set
 452 OTTAVATION to `8va', or whatever appropriate."
 453       (if (number? (ly:context-property  context 'middleCOffset))
 454           (let ((where (ly:context-property-where-defined context 'middleCOffset)))
 455             (ly:context-unset-property where 'middleCOffset)
 456             (ly:context-unset-property where 'ottavation)))
 457
 458       (let* ((offset (* -7 octavation))
 459              (string (cdr (assoc octavation '((2 . "15ma")
 460                                               (1 . "8va")
 461                                               (0 . #f)
 462                                               (-1 . "8vb")
 463                                               (-2 . "15mb"))))))
 464         (ly:context-set-property! context 'middleCOffset offset)
 465         (ly:context-set-property! context 'ottavation string)
 466         (ly:set-middle-C! context)))
 467     (set! (ly:music-property m 'procedure) ottava-modify)
 468     (context-spec-music m 'Staff)))
 469
 470 (define-public (set-octavation ottavation)
 471   (ly:export (make-ottava-set ottavation)))
 472
 473 (define-public (make-time-signature-set num den . rest)
 474   "Set properties for time signature NUM/DEN.  Rest can contain a list
 475 of beat groupings "
 476
 477   (define (standard-beat-grouping num den)
 478
 479     "Some standard subdivisions for time signatures."
 480     (let*
 481         ((key (cons num den))
 482          (entry (assoc key '(
 483                ; Simple time signatures
 484                (( 3 .  8) . (3))
 485                (( 4 .  8) . (2 2))
 486                ; Compound time signatures
 487                (( 6 .  4) . (3 3))
 488                (( 6 .  8) . (3 3))
 489                (( 6 . 16) . (3 3))
 490                (( 9 .  4) . (3 3 3))
 491                (( 9 .  8) . (3 3 3))
 492                (( 9 . 16) . (3 3 3))
 493                ((12 .  4) . (3 3 3 3))
 494                ((12 .  8) . (3 3 3 3))
 495                ((12 . 16) . (3 3 3 3))
 496                ; Some common irregular time signatures
 497                (( 5 .  8) . (3 2))
 498                (( 8 .  8) . (3 3 2))
 499                ))))
 500
 501       (if entry
 502           (cdr entry)
 503           '())))
 504
 505   (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den)))
 506          (beat (ly:make-moment 1 den))
 507          (len  (ly:make-moment num den))
 508          (set2 (make-property-set 'beatLength beat))
 509          (set3 (make-property-set 'measureLength len))
 510          (set4 (make-property-set 'beatGrouping (if (pair? rest)
 511                                                     (car rest)
 512                                                     (standard-beat-grouping num den))))
 513          (basic  (list set1 set2 set3 set4)))
 514     (descend-to-context
 515      (context-spec-music (make-sequential-music basic) 'Timing) 'Score)))
 516
 517 (define-public (make-mark-set label)
 518   "Make the music for the \\mark command."
 519   (let* ((set (if (integer? label)
 520                   (context-spec-music (make-property-set 'rehearsalMark label)
 521                                       'Score)
 522                   #f))
 523          (ev (make-music 'MarkEvent))
 524          (ch (make-event-chord (list ev))))
 525     (if set
 526         (make-sequential-music (list set ch))
 527         (begin
 528           (set! (ly:music-property ev 'label) label)
 529           ch))))
 530
 531 (define-public (set-time-signature num den . rest)
 532   (ly:export (apply make-time-signature-set `(,num ,den . ,rest))))
 533
 534 (define-safe-public (make-articulation name)
 535   (make-music 'ArticulationEvent
 536               'articulation-type name))
 537
 538 (define-public (make-lyric-event string duration)
 539   (make-music 'LyricEvent
 540               'duration duration
 541               'text string))
 542
 543 (define-safe-public (make-span-event type span-dir)
 544   (make-music type
 545               'span-direction span-dir))
 546
 547 (define-public (set-mus-properties! m alist)
 548   "Set all of ALIST as properties of M."
 549   (if (pair? alist)
 550       (begin
 551         (set! (ly:music-property m (caar alist)) (cdar alist))
 552         (set-mus-properties! m (cdr alist)))))
 553
 554 (define-public (music-separator? m)
 555   "Is M a separator?"
 556   (let ((ts (ly:music-property m 'types)))
 557     (memq 'separator ts)))
 558
 559 ;;; splitting chords into voices.
 560 (define (voicify-list lst number)
 561   "Make a list of Musics.
 562
 563    voicify-list :: [ [Music ] ] -> number -> [Music]
 564    LST is a list music-lists.
 565
 566    NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
 567 "
 568   (if (null? lst)
 569       '()
 570       (cons (context-spec-music
 571              (make-sequential-music
 572               (list (make-voice-props-set number)
 573                     (make-simultaneous-music (car lst))))
 574              'Voice  (number->string (1+ number)))
 575             (voicify-list (cdr lst) (1+ number)))))
 576
 577 (define (voicify-chord ch)
 578   "Split the parts of a chord into different Voices using separator"
 579   (let ((es (ly:music-property ch 'elements)))
 580     (set! (ly:music-property  ch 'elements)
 581           (voicify-list (split-list-by-separator es music-separator?) 0))
 582     ch))
 583
 584 (define-public (voicify-music m)
 585   "Recursively split chords that are separated with \\ "
 586   (if (not (ly:music? m))
 587       (ly:error (_ "music expected: ~S") m))
 588   (let ((es (ly:music-property m 'elements))
 589         (e (ly:music-property m 'element)))
 590
 591     (if (pair? es)
 592         (set! (ly:music-property m 'elements) (map voicify-music es)))
 593     (if (ly:music? e)
 594         (set! (ly:music-property m 'element)  (voicify-music e)))
 595     (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
 596              (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
 597         (set! m (context-spec-music (voicify-chord m) 'Staff)))
 598     m))
 599
 600 (define-public (empty-music)
 601   (ly:export (make-music 'Music)))
 602
 603 ;; Make a function that checks score element for being of a specific type.
 604 (define-public (make-type-checker symbol)
 605   (lambda (elt)
 606     ;;(display  symbol)
 607     ;;(eq? #t (ly:grob-property elt symbol))
 608     (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
 609
 610 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
 611   (if (func grob)
 612       (set! (ly:grob-property grob sym) val)))
 613
 614
 615 (define-public ((set-output-property grob-name symbol val)  grob grob-c context)
 616   "Usage:
 617
 618 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
 619
 620 "
 621   (let ((meta (ly:grob-property grob 'meta)))
 622     (if (equal?  (cdr (assoc 'name meta)) grob-name)
 623         (set! (ly:grob-property grob symbol) val))))
 624
 625
 626 ;;
 627 (define-public (smart-bar-check n)
 628   "Make  a bar check that checks for a specific bar number.
 629 "
 630   (let ((m (make-music 'ApplyContext)))
 631     (define (checker tr)
 632       (let* ((bn (ly:context-property tr 'currentBarNumber)))
 633         (if (= bn n)
 634             #t
 635             (ly:error
 636              ;; FIXME: uncomprehensable message
 637              (_ "Bar check failed.  Expect to be at ~a, instead at ~a")
 638              n bn))))
 639     (set! (ly:music-property m 'procedure) checker)
 640     m))
 641
 642
 643 (define-public (skip->rest mus)
 644
 645   "Replace MUS by RestEvent of the same duration if it is a
 646 SkipEvent. Useful for extracting parts from crowded scores"
 647
 648   (if  (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
 649    (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
 650    mus))
 651
 652
 653 (define-public (music-has-type music type)
 654   (memq type (ly:music-property music 'types)))
 655
 656 (define-public (music-clone music)
 657   (define (alist->args alist acc)
 658     (if (null? alist)
 659         acc
 660         (alist->args (cdr alist)
 661                      (cons (caar alist) (cons (cdar alist) acc)))))
 662
 663   (apply
 664    make-music
 665    (ly:music-property music 'name)
 666    (alist->args (ly:music-mutable-properties music) '())))
 667
 668 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 669 ;; warn for bare chords at start.
 670
 671
 672 (define-public (ly:music-message music msg)
 673   (let ((ip (ly:music-property music 'origin)))
 674     (if (ly:input-location? ip)
 675         (ly:input-message ip msg)
 676         (ly:warning msg))))
 677
 678 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 679 ;;
 680 ;; setting stuff for grace context.
 681 ;;
 682
 683 (define (vector-extend v x)
 684   "Make a new vector consisting of V, with X added to the end."
 685   (let* ((n (vector-length v))
 686          (nv (make-vector (+ n 1) '())))
 687     (vector-move-left! v 0 n nv 0)
 688     (vector-set! nv n x)
 689     nv))
 690
 691 (define (vector-map f v)
 692   "Map  F over V. This function returns nothing."
 693   (do ((n (vector-length v))
 694        (i 0 (+ i 1)))
 695       ((>= i n))
 696     (f (vector-ref v i))))
 697
 698 (define (vector-reverse-map f v)
 699   "Map  F over V, N to 0 order. This function returns nothing."
 700   (do ((i (- (vector-length v) 1) (- i 1)))
 701       ((< i 0))
 702     (f (vector-ref v i))))
 703
 704 (define-public (add-grace-property context-name grob sym val)
 705   "Set SYM=VAL for GROB in CONTEXT-NAME. "
 706   (define (set-prop context)
 707     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 708            (current (ly:context-property where 'graceSettings))
 709            (new-settings (append current
 710                                  (list (list context-name grob sym val)))))
 711       (ly:context-set-property! where 'graceSettings new-settings)))
 712   (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
 713
 714 (define-public (remove-grace-property context-name grob sym)
 715   "Remove all SYM for GROB in CONTEXT-NAME. "
 716   (define (sym-grob-context? property sym grob context-name)
 717     (and (eq? (car property) context-name)
 718          (eq? (cadr property) grob)
 719          (eq? (caddr property) sym)))
 720   (define (delete-prop context)
 721     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 722            (current (ly:context-property where 'graceSettings))
 723            (prop-settings (filter
 724                             (lambda(x) (sym-grob-context? x sym grob context-name))
 725                             current))
 726            (new-settings current))
 727       (for-each (lambda(x)
 728                  (set! new-settings (delete x new-settings)))
 729                prop-settings)
 730       (ly:context-set-property! where 'graceSettings new-settings)))
 731   (ly:export (context-spec-music (make-apply-context delete-prop) 'Voice)))
 732
 733
 734
 735 (defmacro-public def-grace-function (start stop . docstring)
 736   "Helper macro for defining grace music"
 737   `(define-music-function (parser location music) (ly:music?)
 738      ,@docstring
 739      (make-music 'GraceMusic
 740                  'origin location
 741                  'element (make-music 'SequentialMusic
 742                                       'elements (list (ly:music-deep-copy ,start)
 743                                                       music
 744                                                       (ly:music-deep-copy ,stop))))))
 745
 746 (defmacro-public define-music-function (args signature . body)
 747   "Helper macro for `ly:make-music-function'.
 748 Syntax:
 749   (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
 750     ...function body...)
 751 "
 752 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
 753       ;; When the music function definition contains a i10n doc string,
 754       ;; (_i "doc string"), keep the literal string only
 755       (let ((docstring (cadar body))
 756             (body (cdr body)))
 757         `(ly:make-music-function (list ,@signature)
 758                                  (lambda (,@args)
 759                                    ,docstring
 760                                    ,@body)))
 761       `(ly:make-music-function (list ,@signature)
 762                                (lambda (,@args)
 763                                  ,@body))))
 764
 765
 766 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 767
 768 (define-public (cue-substitute quote-music)
 769   "Must happen after quote-substitute."
 770
 771   (if (vector? (ly:music-property quote-music 'quoted-events))
 772       (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
 773              (main-voice (if (eq? 1 dir) 1 0))
 774              (cue-voice (if (eq? 1 dir) 0 1))
 775              (main-music (ly:music-property quote-music 'element))
 776              (return-value quote-music))
 777
 778         (if (or (eq? 1 dir) (eq? -1 dir))
 779
 780             ;; if we have stem dirs, change both quoted and main music
 781             ;; to have opposite stems.
 782             (begin
 783               (set! return-value
 784
 785                     ;; cannot context-spec Quote-music, since context
 786                     ;; for the quotes is determined in the iterator.
 787                     (make-sequential-music
 788                      (list
 789                       (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue")
 790                       quote-music
 791                       (context-spec-music (make-voice-props-revert)  'CueVoice "cue"))))
 792               (set! main-music
 793                     (make-sequential-music
 794                      (list
 795                       (make-voice-props-set main-voice)
 796                       main-music
 797                       (make-voice-props-revert))))
 798               (set! (ly:music-property quote-music 'element) main-music)))
 799
 800         return-value)
 801       quote-music))
 802
 803 (define-public ((quote-substitute quote-tab) music)
 804   (let* ((quoted-name (ly:music-property music 'quoted-music-name))
 805          (quoted-vector (if (string? quoted-name)
 806                             (hash-ref quote-tab quoted-name #f)
 807                             #f)))
 808
 809
 810     (if (string? quoted-name)
 811         (if (vector? quoted-vector)
 812             (begin
 813               (set! (ly:music-property music 'quoted-events) quoted-vector)
 814               (set! (ly:music-property music 'iterator-ctor)
 815                     ly:quote-iterator::constructor))
 816             (ly:warning (_ "cannot find quoted music: `~S'") quoted-name)))
 817     music))
 818
 819
 820 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 821 ;; switch it on here, so parsing and init isn't checked (too slow!)
 822 ;;
 823 ;; automatic music transformations.
 824
 825 (define (switch-on-debugging m)
 826   (if (defined? 'set-debug-cell-accesses!)
 827       (set-debug-cell-accesses! 15000))
 828   m)
 829
 830 (define (music-check-error music)
 831   (define found #f)
 832   (define (signal m)
 833     (if (and (ly:music? m)
 834              (eq? (ly:music-property m 'error-found) #t))
 835         (set! found #t)))
 836
 837   (for-each signal (ly:music-property music 'elements))
 838   (signal (ly:music-property music 'element))
 839
 840   (if found
 841       (set! (ly:music-property music 'error-found) #t))
 842   music)
 843
 844 (define (precompute-music-length music)
 845   (set! (ly:music-property music 'length)
 846         (ly:music-length music))
 847   music)
 848
 849 (define-public (make-duration-of-length moment)
 850  "Make duration of the given MOMENT length."
 851  (ly:make-duration 0 0
 852   (ly:moment-main-numerator moment)
 853   (ly:moment-main-denominator moment)))
 854
 855 (define (skip-this moment)
 856  "set skipTypesetting, make SkipMusic of the given MOMENT length,
 857  and then unset skipTypesetting."
 858  (make-sequential-music
 859   (list
 860    (context-spec-music (make-property-set 'skipTypesetting #t)
 861     'Score)
 862    (make-music 'SkipMusic 'duration
 863     (make-duration-of-length moment))
 864    (context-spec-music (make-property-set 'skipTypesetting #f)
 865     'Score))))
 866
 867 (define (unskip-this moment)
 868  "unset skipTypesetting, make SkipMusic of the given MOMENT length,
 869  and then set skipTypesetting."
 870  (make-sequential-music
 871   (list
 872    (context-spec-music (make-property-set 'skipTypesetting #f)
 873     'Score)
 874    (make-music 'SkipMusic 'duration
 875     (make-duration-of-length moment))
 876    (context-spec-music (make-property-set 'skipTypesetting #t)
 877     'Score))))
 878
 879 (define (skip-as-needed music parser)
 880  "Replace MUSIC by
 881  << {  \\set skipTypesetting = ##f
 882  LENGTHOF(\\showFirstLength)
 883  \\set skipTypesetting = ##t
 884  LENGTHOF(\\showLastLength) }
 885  MUSIC >>
 886  if appropriate.
 887
 888  When only showFirstLength is set,
 889  the 'length property of the music is
 890  overridden to speed up compiling."
 891  (let*
 892   ((show-last (ly:parser-lookup parser 'showLastLength))
 893    (show-first (ly:parser-lookup parser 'showFirstLength)))
 894   (cond
 895
 896    ;; both properties may be set.
 897    ((and (ly:music? show-first) (ly:music? show-last))
 898     (let*
 899      ((orig-length (ly:music-length music))
 900       (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))
 901       (begin-length (ly:music-length show-first)))
 902      (make-simultaneous-music
 903       (list
 904        (make-sequential-music
 905         (list
 906          (skip-this skip-length)
 907          ;; let's draw a separator between the beginning and the end
 908          (context-spec-music (make-property-set 'whichBar "||")
 909           'Timing)))
 910        (unskip-this begin-length)
 911        music))))
 912
 913    ;; we may only want to print the last length
 914    ((ly:music? show-last)
 915     (let*
 916      ((orig-length (ly:music-length music))
 917       (skip-length (ly:moment-sub orig-length (ly:music-length show-last))))
 918      (make-simultaneous-music
 919       (list
 920        (skip-this skip-length)
 921        music))))
 922
 923    ;; we may only want to print the beginning; in this case
 924    ;; only the first length will be processed (much faster).
 925    ((ly:music? show-first)
 926     (let*
 927      ((orig-length (ly:music-length music))
 928       (begin-length (ly:music-length show-first)))
 929      ;; the first length must not exceed the original length.
 930      (if (ly:moment<? begin-length orig-length)
 931       (set! (ly:music-property music 'length)
 932        (ly:music-length show-first)))
 933      music))
 934
 935    (else music))))
 936
 937
 938 (define-public toplevel-music-functions
 939   (list
 940    (lambda (music parser) (voicify-music music))
 941    (lambda (x parser) (music-map music-check-error x))
 942    (lambda (x parser) (music-map precompute-music-length x))
 943    (lambda (music parser)
 944
 945      (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes))  music))
 946
 947    ;; switch-on-debugging
 948    (lambda (x parser) (music-map cue-substitute x))
 949
 950    (lambda (x parser)
 951      (skip-as-needed x parser)
 952    )))
 953
 954 ;;;;;;;;;;
 955 ;;; general purpose music functions
 956
 957 (define (shift-octave pitch octave-shift)
 958   (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
 959   (ly:make-pitch
 960      (+ (ly:pitch-octave pitch) octave-shift)
 961      (ly:pitch-notename pitch)
 962      (ly:pitch-alteration pitch)))
 963
 964
 965 ;;;;;;;;;;;;;;;;;
 966 ;; lyrics
 967
 968 (define (apply-durations lyric-music durations)
 969   (define (apply-duration music)
 970     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
 971              (ly:duration?  (ly:music-property music 'duration)))
 972         (begin
 973           (set! (ly:music-property music 'duration) (car durations))
 974           (set! durations (cdr durations)))))
 975
 976   (music-map apply-duration lyric-music))
 977
 978
 979 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 980 ;; accidentals
 981
 982 (define (recent-enough? bar-number alteration-def laziness)
 983   (if (or (number? alteration-def)
 984           (equal? laziness #t))
 985       #t
 986       (<= bar-number (+ (cadr alteration-def) laziness))))
 987
 988 (define (is-tied? alteration-def)
 989   (let* ((def (if (pair? alteration-def)
 990                  (car alteration-def)
 991                  alteration-def)))
 992
 993     (if (equal? def 'tied) #t #f)))
 994
 995 (define (extract-alteration alteration-def)
 996   (cond ((number? alteration-def)
 997          alteration-def)
 998         ((pair? alteration-def)
 999          (car alteration-def))
1000         (else 0)))
1001
1002 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1003   "Checks the need for an accidental and a @q{restore} accidental against
1004 @code{localKeySignature}. The @var{laziness} is the number of measures
1005 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1006 only cancel accidentals in the same measure; if @var{laziness} is three,
1007 we cancel accidentals up to three measures after they first appear.
1008 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1009 specifies whether accidentals should be canceled in different octaves."
1010   (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1011                               ((equal? octaveness 'same-octave) #f)
1012                               (else
1013                                (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1014                                (ly:warning (_ "Defaulting to 'any-octave."))
1015                                #t)))
1016          (key-sig (ly:context-property context 'keySignature))
1017          (local-key-sig (ly:context-property context 'localKeySignature))
1018          (notename (ly:pitch-notename pitch))
1019          (octave (ly:pitch-octave pitch))
1020          (pitch-handle (cons octave notename))
1021          (need-restore #f)
1022          (need-accidental #f)
1023          (previous-alteration #f)
1024          (from-other-octaves #f)
1025          (from-same-octave (ly:assoc-get pitch-handle local-key-sig))
1026          (from-key-sig (ly:assoc-get notename local-key-sig)))
1027
1028     ;; If no key signature match is found from localKeySignature, we may have a custom
1029     ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1030     ;; instead of (pitch . alteration).  Since this type cannot coexist with entries in
1031     ;; localKeySignature, try extracting from keySignature instead.
1032     (if (equal? from-key-sig #f)
1033         (set! from-key-sig (ly:assoc-get pitch-handle key-sig)))
1034
1035     ;; loop through localKeySignature to search for a notename match from other octaves
1036     (let loop ((l local-key-sig))
1037       (if (pair? l)
1038           (let ((entry (car l)))
1039             (if (and (pair? (car entry))
1040                      (= (cdar entry) notename))
1041                 (set! from-other-octaves (cdr entry))
1042                 (loop (cdr l))))))
1043
1044     ;; find previous alteration-def for comparison with pitch
1045     (cond
1046      ;; from same octave?
1047      ((and (eq? ignore-octave #f)
1048            (not (equal? from-same-octave #f))
1049            (recent-enough? barnum from-same-octave laziness))
1050       (set! previous-alteration from-same-octave))
1051
1052      ;; from any octave?
1053      ((and (eq? ignore-octave #t)
1054            (not (equal? from-other-octaves #f))
1055            (recent-enough? barnum from-other-octaves laziness))
1056       (set! previous-alteration from-other-octaves))
1057
1058      ;; not recent enough, extract from key signature/local key signature
1059      ((not (equal? from-key-sig #f))
1060       (set! previous-alteration from-key-sig)))
1061
1062     (if (is-tied? previous-alteration)
1063         (set! need-accidental #t)
1064
1065         (let* ((prev-alt (extract-alteration previous-alteration))
1066                (this-alt (ly:pitch-alteration pitch)))
1067
1068           (if (not (= this-alt prev-alt))
1069               (begin
1070                 (set! need-accidental #t)
1071                 (if (and (not (= this-alt 0))
1072                          (or (< (abs this-alt) (abs prev-alt))
1073                              (< (* prev-alt this-alt) 0)))
1074                     (set! need-restore #t))))))
1075
1076     (cons need-restore need-accidental)))
1077
1078 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1079   "Creates an accidental rule that makes its decision based on the octave of the note
1080   and a laziness value.
1081   octaveness is either 'same-octave or 'any-octave and defines whether the rule should
1082   respond to accidental changes in other octaves than the current. 'same-octave is the
1083   normal way to typeset accidentals - an accidental is made if the alteration is different
1084   from the last active pitch in the same octave. 'any-octave looks at the last active pitch
1085   in any octave.
1086   laziness states over how many bars an accidental should be remembered.
1087   0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure.
1088   A positive integer means that the accidental lasts over that many bar lines.
1089   -1 is 'forget immediately', that is, only look at key signature.
1090   #t is forever."
1091   (check-pitch-against-signature context pitch barnum laziness octaveness))
1092
1093 (define (key-entry-notename entry)
1094   "Return the pitch of an entry in localKeySignature. The entry is either of the form
1095   '(notename . alter) or '((octave . notename) . (alter barnum . measurepos))."
1096   (if (number? (car entry))
1097       (car entry)
1098       (cdar entry)))
1099
1100 (define (key-entry-octave entry)
1101   "Return the octave of an entry in localKeySignature (or #f if the entry does not have
1102   an octave)."
1103   (and (pair? (car entry)) (caar entry)))
1104
1105 (define (key-entry-bar-number entry)
1106   "Return the bar number of an entry in localKeySignature (or #f if the entry does not
1107   have a bar number)."
1108   (and (pair? (car entry)) (caddr entry)))
1109
1110 (define (key-entry-measure-position entry)
1111   "Return the measure position of an entry in localKeySignature (or #f if the entry does
1112   not have a measure position)."
1113   (and (pair? (car entry)) (cdddr entry)))
1114
1115 (define (key-entry-alteration entry)
1116   "Return the alteration of an entry in localKeySignature."
1117   (if (number? (car entry))
1118       (cdr entry)
1119       (cadr entry)))
1120
1121 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1122   "Return the first entry in keysig that matches the pitch.
1123   accept-global states whether key signature entries should be included.
1124   accept-local states whether local accidentals should be included.
1125   if no matching entry is found, #f is returned."
1126   (if (pair? keysig)
1127       (let* ((entry (car keysig))
1128              (entryoct (key-entry-octave entry))
1129              (entrynn (key-entry-notename entry))
1130              (oct (ly:pitch-octave pitch))
1131              (nn (ly:pitch-notename pitch)))
1132         (if (and (equal? nn entrynn)
1133                  (or (and accept-global (equal? #f entryoct))
1134                      (and accept-local (equal? oct entryoct))))
1135             entry
1136             (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))
1137       #f))
1138
1139 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1140   "an accidental rule that typesets an accidental if it differs from the key signature
1141    AND does not directly follow a note on the same staff-line.
1142    This rule should not be used alone because it does neither look at bar lines
1143    nor different accidentals at the same notename"
1144   (let* ((keysig (ly:context-property context 'localKeySignature))
1145          (entry (find-pitch-entry keysig pitch #t #t)))
1146     (if (equal? #f entry)
1147         (cons #f #f)
1148         (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1149                (key-acc (if (equal? global-entry #f)
1150                             0
1151                             (key-entry-alteration global-entry)))
1152                (acc (ly:pitch-alteration pitch))
1153                (entrymp (key-entry-measure-position entry))
1154                (entrybn (key-entry-bar-number entry)))
1155           (cons #f (not (or (equal? acc key-acc)
1156                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1157
1158 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1159   "an accidental rule that typesets a cautionary accidental
1160   if it is included in the key signature AND does not directly follow
1161   a note on the same staff-line."
1162   (let* ((keysig (ly:context-property context 'localKeySignature))
1163          (entry (find-pitch-entry keysig pitch #t #t)))
1164     (if (equal? #f entry)
1165         (cons #f #f)
1166         (let* ((global-entry (find-pitch-entry keysig pitch #f #f))
1167                (key-acc (if (equal? global-entry #f)
1168                             0
1169                             (key-entry-alteration global-entry)))
1170                (acc (ly:pitch-alteration pitch))
1171                (entrymp (key-entry-measure-position entry))
1172                (entrybn (key-entry-bar-number entry)))
1173           (cons #f (not (or (equal? acc key-acc)
1174                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1175
1176 (define-public (set-accidentals-properties extra-natural
1177                                            auto-accs auto-cauts
1178                                            context)
1179   (context-spec-music
1180    (make-sequential-music
1181     (append (if (boolean? extra-natural)
1182                 (list (make-property-set 'extraNatural extra-natural))
1183                 '())
1184             (list (make-property-set 'autoAccidentals auto-accs)
1185                   (make-property-set 'autoCautionaries auto-cauts))))
1186    context))
1187
1188 (define-public (set-accidental-style style . rest)
1189   "Set accidental style to STYLE. Optionally takes a context argument,
1190 e.g. 'Staff or 'Voice. The context defaults to Staff, except for piano styles, which
1191 use GrandStaff as a context. "
1192   (let ((context (if (pair? rest)
1193                      (car rest) 'Staff))
1194         (pcontext (if (pair? rest)
1195                       (car rest) 'GrandStaff)))
1196     (ly:export
1197      (cond
1198       ;; accidentals as they were common in the 18th century.
1199       ((equal? style 'default)
1200        (set-accidentals-properties #t
1201                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1202                                    '()
1203                                    context))
1204       ;; accidentals from one voice do NOT get cancelled in other voices
1205       ((equal? style 'voice)
1206        (set-accidentals-properties #t
1207                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1208                                    '()
1209                                    context))
1210       ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1211       ;; This includes all the default accidentals, but accidentals also needs cancelling
1212       ;; in other octaves and in the next measure.
1213       ((equal? style 'modern)
1214        (set-accidentals-properties #f
1215                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1216                                            ,(make-accidental-rule 'any-octave 0)
1217                                            ,(make-accidental-rule 'same-octave 1))
1218                                    '()
1219                                    context))
1220       ;; the accidentals that Stone adds to the old standard as cautionaries
1221       ((equal? style 'modern-cautionary)
1222        (set-accidentals-properties #f
1223                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1224                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1225                                            ,(make-accidental-rule 'same-octave 1))
1226                                    context))
1227       ;; same as modern, but accidentals different from the key signature are always
1228       ;; typeset - unless they directly follow a note of the same pitch.
1229       ((equal? style 'neo-modern)
1230        (set-accidentals-properties #f
1231                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1232                                            ,(make-accidental-rule 'any-octave 0)
1233                                            ,(make-accidental-rule 'same-octave 1)
1234                                            ,neo-modern-accidental-rule)
1235                                    '()
1236                                    context))
1237       ((equal? style 'neo-modern-cautionary)
1238        (set-accidentals-properties #f
1239                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1240                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1241                                            ,(make-accidental-rule 'same-octave 1)
1242                                            ,neo-modern-accidental-rule)
1243                                    context))
1244       ;; Accidentals as they were common in dodecaphonic music with no tonality.
1245       ;; Each note gets one accidental.
1246       ((equal? style 'dodecaphonic)
1247        (set-accidentals-properties #f
1248                                    `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1249                                    '()
1250                                    context))
1251       ;; Multivoice accidentals to be read both by musicians playing one voice
1252       ;; and musicians playing all voices.
1253       ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
1254       ((equal? style 'modern-voice)
1255        (set-accidentals-properties  #f
1256                                     `(Voice ,(make-accidental-rule 'same-octave 0)
1257                                             ,(make-accidental-rule 'any-octave 0)
1258                                             ,(make-accidental-rule 'same-octave 1)
1259                                       Staff ,(make-accidental-rule 'same-octave 0)
1260                                             ,(make-accidental-rule 'any-octave 0)
1261                                             ,(make-accidental-rule 'same-octave 1))
1262                                     '()
1263                                     context))
1264       ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1265       ;; as cautionaries
1266       ((equal? style 'modern-voice-cautionary)
1267        (set-accidentals-properties #f
1268                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1269                                    `(Voice ,(make-accidental-rule 'any-octave 0)
1270                                            ,(make-accidental-rule 'same-octave 1)
1271                                      Staff ,(make-accidental-rule 'same-octave 0)
1272                                            ,(make-accidental-rule 'any-octave 0)
1273                                            ,(make-accidental-rule 'same-octave 1))
1274                                    context))
1275       ;; stone's suggestions for accidentals on grand staff.
1276       ;; Accidentals are cancelled across the staves in the same grand staff as well
1277       ((equal? style 'piano)
1278        (set-accidentals-properties #f
1279                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1280                                            ,(make-accidental-rule 'any-octave 0)
1281                                            ,(make-accidental-rule 'same-octave 1)
1282                                      GrandStaff
1283                                            ,(make-accidental-rule 'any-octave 0)
1284                                            ,(make-accidental-rule 'same-octave 1))
1285                                    '()
1286                                    pcontext))
1287       ((equal? style 'piano-cautionary)
1288        (set-accidentals-properties #f
1289                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1290                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1291                                            ,(make-accidental-rule 'same-octave 1)
1292                                      GrandStaff
1293                                            ,(make-accidental-rule 'any-octave 0)
1294                                            ,(make-accidental-rule 'same-octave 1))
1295                                    pcontext))
1296
1297       ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1298       ;; tones specified by the key signature.
1299        ((equal? style 'teaching)
1300        (set-accidentals-properties #f
1301                                     `(Staff ,(make-accidental-rule 'same-octave 0))
1302                                     `(Staff ,(make-accidental-rule 'same-octave 1)
1303                                            ,teaching-accidental-rule)
1304                                    context))
1305
1306       ;; do not set localKeySignature when a note alterated differently from
1307       ;; localKeySignature is found.
1308       ;; Causes accidentals to be printed at every note instead of
1309       ;; remembered for the duration of a measure.
1310       ;; accidentals not being remembered, causing accidentals always to
1311       ;; be typeset relative to the time signature
1312       ((equal? style 'forget)
1313        (set-accidentals-properties '()
1314                                    `(Staff ,(make-accidental-rule 'same-octave -1))
1315                                    '()
1316                                    context))
1317       ;; Do not reset the key at the start of a measure.  Accidentals will be
1318       ;; printed only once and are in effect until overridden, possibly many
1319       ;; measures later.
1320       ((equal? style 'no-reset)
1321        (set-accidentals-properties '()
1322                                    `(Staff ,(make-accidental-rule 'same-octave #t))
1323                                    '()
1324                                    context))
1325       (else
1326        (ly:warning (_ "unknown accidental style: ~S") style)
1327        (make-sequential-music '()))))))
1328
1329 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1330
1331 (define-public (skip-of-length mus)
1332   "Create a skip of exactly the same length as MUS."
1333   (let* ((skip
1334           (make-music
1335            'SkipEvent
1336            'duration (ly:make-duration 0 0))))
1337
1338     (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1339
1340 (define-public (mmrest-of-length mus)
1341   "Create a mmrest of exactly the same length as MUS."
1342
1343   (let* ((skip
1344           (make-multi-measure-rest
1345            (ly:make-duration 0 0) '())))
1346     (ly:music-compress skip (ly:music-length mus))
1347     skip))
1348
1349 (define-public (pitch-of-note event-chord)
1350
1351   (let*
1352       ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types)))
1353                     (ly:music-property event-chord 'elements))))
1354
1355     (if (pair? evs)
1356         (ly:music-property (car evs) 'pitch)
1357         #f)))
1358
1359 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1360
1361 (define-public (extract-named-music music music-name)
1362 "Return a flat list of all music named @code{music-name}
1363 from @code{music}."
1364    (let ((extracted-list
1365           (if (ly:music? music)
1366               (if (eq? (ly:music-property music 'name) music-name)
1367                   (list music)
1368                   (let ((elt (ly:music-property music 'element))
1369                         (elts (ly:music-property music 'elements)))
1370                     (if (ly:music? elt)
1371                         (extract-named-music elt music-name)
1372                         (if (null? elts)
1373                             '()
1374                             (map (lambda(x)
1375                                     (extract-named-music x music-name ))
1376                              elts)))))
1377               '())))
1378      (flatten-list extracted-list)))
1379
1380 (define-public (event-chord-notes event-chord)
1381 "Return a list of all notes from @{event-chord}."
1382   (filter
1383     (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1384     (ly:music-property event-chord 'elements)))
1385
1386 (define-public (event-chord-pitches event-chord)
1387 "Return a list of all pitches from @{event-chord}."
1388   (map (lambda (x) (ly:music-property x 'pitch))
1389        (event-chord-notes event-chord)))