scm/music-functions.scm

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