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