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-beam-rule-time-signature-set num den '()))
 498
 499 ;;; Used for calls that include beat-grouping setting
 500 (define-public (set-time-signature num den . rest)
 501   "Set properties for time signature @var{num/den}.
 502 If @var{rest} is present, it is used to set
 503 @code{beatStructure}."
 504  (ly:export (apply make-beam-rule-time-signature-set
 505                     (list num den rest))))
 506
 507 (define-public (make-beam-rule-time-signature-set num den rest)
 508   "Implement settings for new time signature.  Can be
 509 called from either make-time-signature-set (used by \time
 510 in parser) or set-time-signature (called from scheme code
 511 included in .ly file)."
 512
 513   (let ((m (make-music 'ApplyContext)))
 514     (define (make-time-settings context)
 515       (let* ((fraction (cons num den))
 516              (time-signature-settings (ly:context-property context 'timeSignatureSettings))
 517              (my-base-fraction (base-fraction fraction time-signature-settings))
 518              (my-beat-structure (if (null? rest)
 519                                     (beat-structure my-base-fraction
 520                                                     fraction
 521                                                     time-signature-settings)
 522                                     (car rest)))
 523              (beaming-exception
 524                (beam-exceptions fraction time-signature-settings))
 525              (new-measure-length (ly:make-moment num den)))
 526          (ly:context-set-property! context 'timeSignatureFraction fraction)
 527          (ly:context-set-property!
 528            context 'baseMoment (fraction->moment my-base-fraction))
 529          (ly:context-set-property! context 'beatStructure my-beat-structure)
 530          (ly:context-set-property! context 'beamExceptions beaming-exception)
 531          (ly:context-set-property! context 'measureLength new-measure-length)))
 532      (set! (ly:music-property m 'procedure) make-time-settings)
 533      (descend-to-context
 534       (context-spec-music m 'Timing)
 535       'Score)))
 536
 537
 538 (define-public (make-mark-set label)
 539   "Make the music for the \\mark command."
 540   (let* ((set (if (integer? label)
 541                   (context-spec-music (make-property-set 'rehearsalMark label)
 542                                       'Score)
 543                   #f))
 544          (ev (make-music 'MarkEvent))
 545          (ch (make-event-chord (list ev))))
 546     (if set
 547         (make-sequential-music (list set ch))
 548         (begin
 549           (set! (ly:music-property ev 'label) label)
 550           ch))))
 551
 552 (define-safe-public (make-articulation name)
 553   (make-music 'ArticulationEvent
 554               'articulation-type name))
 555
 556 (define-public (make-lyric-event string duration)
 557   (make-music 'LyricEvent
 558               'duration duration
 559               'text string))
 560
 561 (define-safe-public (make-span-event type span-dir)
 562   (make-music type
 563               'span-direction span-dir))
 564
 565 (define-public (override-head-style heads style)
 566   "Override style for @var{heads} to @var{style}."
 567   (make-sequential-music
 568     (if (pair? heads)
 569         (map (lambda (h)
 570               (make-grob-property-override h 'style style))
 571          heads)
 572         (list (make-grob-property-override heads 'style style)))))
 573
 574 (define-public (revert-head-style heads)
 575   "Revert style for @var{heads}."
 576   (make-sequential-music
 577     (if (pair? heads)
 578         (map (lambda (h)
 579               (make-grob-property-revert h 'style))
 580          heads)
 581         (list (make-grob-property-revert heads 'style)))))
 582
 583 (define-public (style-note-heads heads style music)
 584  "Set @var{style} for all @var{heads} in @var{music}.  Works both
 585 inside of and outside of chord construct."
 586   ;; are we inside a <...>?
 587   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 588       ;; yes -> use a tweak
 589       (begin
 590         (set! (ly:music-property music 'tweaks)
 591               (acons 'style style (ly:music-property music 'tweaks)))
 592         music)
 593       ;; not in <...>, so use overrides
 594       (make-sequential-music
 595         (list
 596           (override-head-style heads style)
 597           music
 598           (revert-head-style heads)))))
 599
 600  (define-public (set-mus-properties! m alist)
 601   "Set all of ALIST as properties of M."
 602   (if (pair? alist)
 603       (begin
 604         (set! (ly:music-property m (caar alist)) (cdar alist))
 605         (set-mus-properties! m (cdr alist)))))
 606
 607 (define-public (music-separator? m)
 608   "Is M a separator?"
 609   (let ((ts (ly:music-property m 'types)))
 610     (memq 'separator ts)))
 611
 612 ;;; splitting chords into voices.
 613 (define (voicify-list lst number)
 614   "Make a list of Musics.
 615
 616    voicify-list :: [ [Music ] ] -> number -> [Music]
 617    LST is a list music-lists.
 618
 619    NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
 620 "
 621   (if (null? lst)
 622       '()
 623       (cons (context-spec-music
 624              (make-sequential-music
 625               (list (make-voice-props-set number)
 626                     (make-simultaneous-music (car lst))))
 627              'Bottom  (number->string (1+ number)))
 628             (voicify-list (cdr lst) (1+ number)))))
 629
 630 (define (voicify-chord ch)
 631   "Split the parts of a chord into different Voices using separator"
 632   (let ((es (ly:music-property ch 'elements)))
 633     (set! (ly:music-property  ch 'elements)
 634           (voicify-list (split-list-by-separator es music-separator?) 0))
 635     ch))
 636
 637 (define-public (voicify-music m)
 638   "Recursively split chords that are separated with \\ "
 639   (if (not (ly:music? m))
 640       (ly:error (_ "music expected: ~S") m))
 641   (let ((es (ly:music-property m 'elements))
 642         (e (ly:music-property m 'element)))
 643
 644     (if (pair? es)
 645         (set! (ly:music-property m 'elements) (map voicify-music es)))
 646     (if (ly:music? e)
 647         (set! (ly:music-property m 'element)  (voicify-music e)))
 648     (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
 649              (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
 650         (set! m (context-spec-music (voicify-chord m) 'Staff)))
 651     m))
 652
 653 (define-public (empty-music)
 654   (ly:export (make-music 'Music)))
 655
 656 ;; Make a function that checks score element for being of a specific type.
 657 (define-public (make-type-checker symbol)
 658   (lambda (elt)
 659     (grob::has-interface elt symbol)))
 660
 661 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
 662   (if (func grob)
 663       (set! (ly:grob-property grob sym) val)))
 664
 665
 666 (define-public ((set-output-property grob-name symbol val)  grob grob-c context)
 667   "Usage:
 668
 669 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
 670
 671 "
 672   (let ((meta (ly:grob-property grob 'meta)))
 673     (if (equal? (assoc-get 'name meta) grob-name)
 674         (set! (ly:grob-property grob symbol) val))))
 675
 676
 677 ;;
 678 (define-public (smart-bar-check n)
 679   "Make  a bar check that checks for a specific bar number.
 680 "
 681   (let ((m (make-music 'ApplyContext)))
 682     (define (checker tr)
 683       (let* ((bn (ly:context-property tr 'currentBarNumber)))
 684         (if (= bn n)
 685             #t
 686             (ly:error
 687              ;; FIXME: uncomprehensable message
 688              (_ "Bar check failed.  Expect to be at ~a, instead at ~a")
 689              n bn))))
 690     (set! (ly:music-property m 'procedure) checker)
 691     m))
 692
 693
 694 (define-public (skip->rest mus)
 695
 696   "Replace MUS by RestEvent of the same duration if it is a
 697 SkipEvent. Useful for extracting parts from crowded scores"
 698
 699   (if  (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
 700    (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
 701    mus))
 702
 703
 704 (define-public (music-has-type music type)
 705   (memq type (ly:music-property music 'types)))
 706
 707 (define-public (music-clone music)
 708   (define (alist->args alist acc)
 709     (if (null? alist)
 710         acc
 711         (alist->args (cdr alist)
 712                      (cons (caar alist) (cons (cdar alist) acc)))))
 713
 714   (apply
 715    make-music
 716    (ly:music-property music 'name)
 717    (alist->args (ly:music-mutable-properties music) '())))
 718
 719 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 720 ;; warn for bare chords at start.
 721
 722
 723 (define-public (ly:music-message music msg)
 724   (let ((ip (ly:music-property music 'origin)))
 725     (if (ly:input-location? ip)
 726         (ly:input-message ip msg)
 727         (ly:warning msg))))
 728
 729 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 730 ;;
 731 ;; setting stuff for grace context.
 732 ;;
 733
 734 (define (vector-extend v x)
 735   "Make a new vector consisting of V, with X added to the end."
 736   (let* ((n (vector-length v))
 737          (nv (make-vector (+ n 1) '())))
 738     (vector-move-left! v 0 n nv 0)
 739     (vector-set! nv n x)
 740     nv))
 741
 742 (define (vector-map f v)
 743   "Map  F over V. This function returns nothing."
 744   (do ((n (vector-length v))
 745        (i 0 (+ i 1)))
 746       ((>= i n))
 747     (f (vector-ref v i))))
 748
 749 (define (vector-reverse-map f v)
 750   "Map  F over V, N to 0 order. This function returns nothing."
 751   (do ((i (- (vector-length v) 1) (- i 1)))
 752       ((< i 0))
 753     (f (vector-ref v i))))
 754
 755 (define-public (add-grace-property context-name grob sym val)
 756   "Set SYM=VAL for GROB in CONTEXT-NAME. "
 757   (define (set-prop context)
 758     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 759            (current (ly:context-property where 'graceSettings))
 760            (new-settings (append current
 761                                  (list (list context-name grob sym val)))))
 762       (ly:context-set-property! where 'graceSettings new-settings)))
 763   (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
 764
 765 (define-public (remove-grace-property context-name grob sym)
 766   "Remove all SYM for GROB in CONTEXT-NAME. "
 767   (define (sym-grob-context? property sym grob context-name)
 768     (and (eq? (car property) context-name)
 769          (eq? (cadr property) grob)
 770          (eq? (caddr property) sym)))
 771   (define (delete-prop context)
 772     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 773            (current (ly:context-property where 'graceSettings))
 774            (prop-settings (filter
 775                             (lambda(x) (sym-grob-context? x sym grob context-name))
 776                             current))
 777            (new-settings current))
 778       (for-each (lambda(x)
 779                  (set! new-settings (delete x new-settings)))
 780                prop-settings)
 781       (ly:context-set-property! where 'graceSettings new-settings)))
 782   (ly:export (context-spec-music (make-apply-context delete-prop) 'Voice)))
 783
 784
 785
 786 (defmacro-public def-grace-function (start stop . docstring)
 787   "Helper macro for defining grace music"
 788   `(define-music-function (parser location music) (ly:music?)
 789      ,@docstring
 790      (make-music 'GraceMusic
 791                  'origin location
 792                  'element (make-music 'SequentialMusic
 793                                       'elements (list (ly:music-deep-copy ,start)
 794                                                       music
 795                                                       (ly:music-deep-copy ,stop))))))
 796
 797 (defmacro-public define-music-function (args signature . body)
 798   "Helper macro for `ly:make-music-function'.
 799 Syntax:
 800   (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
 801     ...function body...)
 802 "
 803 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
 804       ;; When the music function definition contains a i10n doc string,
 805       ;; (_i "doc string"), keep the literal string only
 806       (let ((docstring (cadar body))
 807             (body (cdr body)))
 808         `(ly:make-music-function (list ,@signature)
 809                                  (lambda (,@args)
 810                                    ,docstring
 811                                    ,@body)))
 812       `(ly:make-music-function (list ,@signature)
 813                                (lambda (,@args)
 814                                  ,@body))))
 815
 816
 817 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 818
 819 (define-public (cue-substitute quote-music)
 820   "Must happen after quote-substitute."
 821
 822   (if (vector? (ly:music-property quote-music 'quoted-events))
 823       (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
 824              (main-voice (if (eq? 1 dir) 1 0))
 825              (cue-voice (if (eq? 1 dir) 0 1))
 826              (main-music (ly:music-property quote-music 'element))
 827              (return-value quote-music))
 828
 829         (if (or (eq? 1 dir) (eq? -1 dir))
 830
 831             ;; if we have stem dirs, change both quoted and main music
 832             ;; to have opposite stems.
 833             (begin
 834               (set! return-value
 835
 836                     ;; cannot context-spec Quote-music, since context
 837                     ;; for the quotes is determined in the iterator.
 838                     (make-sequential-music
 839                      (list
 840                       (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue")
 841                       quote-music
 842                       (context-spec-music (make-voice-props-revert)  'CueVoice "cue"))))
 843               (set! main-music
 844                     (make-sequential-music
 845                      (list
 846                       (make-voice-props-set main-voice)
 847                       main-music
 848                       (make-voice-props-revert))))
 849               (set! (ly:music-property quote-music 'element) main-music)))
 850
 851         return-value)
 852       quote-music))
 853
 854 (define-public ((quote-substitute quote-tab) music)
 855   (let* ((quoted-name (ly:music-property music 'quoted-music-name))
 856          (quoted-vector (if (string? quoted-name)
 857                             (hash-ref quote-tab quoted-name #f)
 858                             #f)))
 859
 860
 861     (if (string? quoted-name)
 862         (if (vector? quoted-vector)
 863             (begin
 864               (set! (ly:music-property music 'quoted-events) quoted-vector)
 865               (set! (ly:music-property music 'iterator-ctor)
 866                     ly:quote-iterator::constructor))
 867             (ly:warning (_ "cannot find quoted music: `~S'") quoted-name)))
 868     music))
 869
 870
 871 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 872 ;; switch it on here, so parsing and init isn't checked (too slow!)
 873 ;;
 874 ;; automatic music transformations.
 875
 876 (define (switch-on-debugging m)
 877   (if (defined? 'set-debug-cell-accesses!)
 878       (set-debug-cell-accesses! 15000))
 879   m)
 880
 881 (define (music-check-error music)
 882   (define found #f)
 883   (define (signal m)
 884     (if (and (ly:music? m)
 885              (eq? (ly:music-property m 'error-found) #t))
 886         (set! found #t)))
 887
 888   (for-each signal (ly:music-property music 'elements))
 889   (signal (ly:music-property music 'element))
 890
 891   (if found
 892       (set! (ly:music-property music 'error-found) #t))
 893   music)
 894
 895 (define (precompute-music-length music)
 896   (set! (ly:music-property music 'length)
 897         (ly:music-length music))
 898   music)
 899
 900 (define-public (make-duration-of-length moment)
 901  "Make duration of the given MOMENT length."
 902  (ly:make-duration 0 0
 903   (ly:moment-main-numerator moment)
 904   (ly:moment-main-denominator moment)))
 905
 906 (define (skip-this moment)
 907  "set skipTypesetting, make SkipMusic of the given MOMENT length,
 908  and then unset skipTypesetting."
 909  (make-sequential-music
 910   (list
 911    (context-spec-music (make-property-set 'skipTypesetting #t)
 912     'Score)
 913    (make-music 'SkipMusic 'duration
 914     (make-duration-of-length moment))
 915    (context-spec-music (make-property-set 'skipTypesetting #f)
 916     'Score))))
 917
 918 (define (unskip-this moment)
 919  "unset skipTypesetting, make SkipMusic of the given MOMENT length,
 920  and then set skipTypesetting."
 921  (make-sequential-music
 922   (list
 923    (context-spec-music (make-property-set 'skipTypesetting #f)
 924     'Score)
 925    (make-music 'SkipMusic 'duration
 926     (make-duration-of-length moment))
 927    (context-spec-music (make-property-set 'skipTypesetting #t)
 928     'Score))))
 929
 930 (define (skip-as-needed music parser)
 931  "Replace MUSIC by
 932  << {  \\set skipTypesetting = ##f
 933  LENGTHOF(\\showFirstLength)
 934  \\set skipTypesetting = ##t
 935  LENGTHOF(\\showLastLength) }
 936  MUSIC >>
 937  if appropriate.
 938
 939  When only showFirstLength is set,
 940  the 'length property of the music is
 941  overridden to speed up compiling."
 942  (let*
 943   ((show-last (ly:parser-lookup parser 'showLastLength))
 944    (show-first (ly:parser-lookup parser 'showFirstLength)))
 945   (cond
 946
 947    ;; both properties may be set.
 948    ((and (ly:music? show-first) (ly:music? show-last))
 949     (let*
 950      ((orig-length (ly:music-length music))
 951       (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))
 952       (begin-length (ly:music-length show-first)))
 953      (make-simultaneous-music
 954       (list
 955        (make-sequential-music
 956         (list
 957          (skip-this skip-length)
 958          ;; let's draw a separator between the beginning and the end
 959          (context-spec-music (make-property-set 'whichBar "||")
 960           'Timing)))
 961        (unskip-this begin-length)
 962        music))))
 963
 964    ;; we may only want to print the last length
 965    ((ly:music? show-last)
 966     (let*
 967      ((orig-length (ly:music-length music))
 968       (skip-length (ly:moment-sub orig-length (ly:music-length show-last))))
 969      (make-simultaneous-music
 970       (list
 971        (skip-this skip-length)
 972        music))))
 973
 974    ;; we may only want to print the beginning; in this case
 975    ;; only the first length will be processed (much faster).
 976    ((ly:music? show-first)
 977     (let*
 978      ((orig-length (ly:music-length music))
 979       (begin-length (ly:music-length show-first)))
 980      ;; the first length must not exceed the original length.
 981      (if (ly:moment<? begin-length orig-length)
 982       (set! (ly:music-property music 'length)
 983        (ly:music-length show-first)))
 984      music))
 985
 986    (else music))))
 987
 988
 989 (define-public toplevel-music-functions
 990   (list
 991    (lambda (music parser) (voicify-music music))
 992    (lambda (x parser) (music-map music-check-error x))
 993    (lambda (x parser) (music-map precompute-music-length x))
 994    (lambda (music parser)
 995
 996      (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes))  music))
 997
 998    ;; switch-on-debugging
 999    (lambda (x parser) (music-map cue-substitute x))
1000
1001    (lambda (x parser)
1002      (skip-as-needed x parser)
1003    )))
1004
1005 ;;;;;;;;;;
1006 ;;; general purpose music functions
1007
1008 (define (shift-octave pitch octave-shift)
1009   (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
1010   (ly:make-pitch
1011      (+ (ly:pitch-octave pitch) octave-shift)
1012      (ly:pitch-notename pitch)
1013      (ly:pitch-alteration pitch)))
1014
1015
1016 ;;;;;;;;;;;;;;;;;
1017 ;; lyrics
1018
1019 (define (apply-durations lyric-music durations)
1020   (define (apply-duration music)
1021     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
1022              (ly:duration?  (ly:music-property music 'duration)))
1023         (begin
1024           (set! (ly:music-property music 'duration) (car durations))
1025           (set! durations (cdr durations)))))
1026
1027   (music-map apply-duration lyric-music))
1028
1029
1030 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1031 ;; accidentals
1032
1033 (define (recent-enough? bar-number alteration-def laziness)
1034   (if (or (number? alteration-def)
1035           (equal? laziness #t))
1036       #t
1037       (<= bar-number (+ (cadr alteration-def) laziness))))
1038
1039 (define (is-tied? alteration-def)
1040   (let* ((def (if (pair? alteration-def)
1041                  (car alteration-def)
1042                  alteration-def)))
1043
1044     (if (equal? def 'tied) #t #f)))
1045
1046 (define (extract-alteration alteration-def)
1047   (cond ((number? alteration-def)
1048          alteration-def)
1049         ((pair? alteration-def)
1050          (car alteration-def))
1051         (else 0)))
1052
1053 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1054   "Checks the need for an accidental and a @q{restore} accidental against
1055 @code{localKeySignature}. The @var{laziness} is the number of measures
1056 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1057 only cancel accidentals in the same measure; if @var{laziness} is three,
1058 we cancel accidentals up to three measures after they first appear.
1059 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1060 specifies whether accidentals should be canceled in different octaves."
1061   (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1062                               ((equal? octaveness 'same-octave) #f)
1063                               (else
1064                                (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1065                                (ly:warning (_ "Defaulting to 'any-octave."))
1066                                #t)))
1067          (key-sig (ly:context-property context 'keySignature))
1068          (local-key-sig (ly:context-property context 'localKeySignature))
1069          (notename (ly:pitch-notename pitch))
1070          (octave (ly:pitch-octave pitch))
1071          (pitch-handle (cons octave notename))
1072          (need-restore #f)
1073          (need-accidental #f)
1074          (previous-alteration #f)
1075          (from-other-octaves #f)
1076          (from-same-octave (assoc-get pitch-handle local-key-sig))
1077          (from-key-sig (assoc-get notename local-key-sig)))
1078
1079     ;; If no key signature match is found from localKeySignature, we may have a custom
1080     ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1081     ;; instead of (pitch . alteration).  Since this type cannot coexist with entries in
1082     ;; localKeySignature, try extracting from keySignature instead.
1083     (if (equal? from-key-sig #f)
1084         (set! from-key-sig (assoc-get pitch-handle key-sig)))
1085
1086     ;; loop through localKeySignature to search for a notename match from other octaves
1087     (let loop ((l local-key-sig))
1088       (if (pair? l)
1089           (let ((entry (car l)))
1090             (if (and (pair? (car entry))
1091                      (= (cdar entry) notename))
1092                 (set! from-other-octaves (cdr entry))
1093                 (loop (cdr l))))))
1094
1095     ;; find previous alteration-def for comparison with pitch
1096     (cond
1097      ;; from same octave?
1098      ((and (eq? ignore-octave #f)
1099            (not (equal? from-same-octave #f))
1100            (recent-enough? barnum from-same-octave laziness))
1101       (set! previous-alteration from-same-octave))
1102
1103      ;; from any octave?
1104      ((and (eq? ignore-octave #t)
1105            (not (equal? from-other-octaves #f))
1106            (recent-enough? barnum from-other-octaves laziness))
1107       (set! previous-alteration from-other-octaves))
1108
1109      ;; not recent enough, extract from key signature/local key signature
1110      ((not (equal? from-key-sig #f))
1111       (set! previous-alteration from-key-sig)))
1112
1113     (if (is-tied? previous-alteration)
1114         (set! need-accidental #t)
1115
1116         (let* ((prev-alt (extract-alteration previous-alteration))
1117                (this-alt (ly:pitch-alteration pitch)))
1118
1119           (if (not (= this-alt prev-alt))
1120               (begin
1121                 (set! need-accidental #t)
1122                 (if (and (not (= this-alt 0))
1123                          (or (< (abs this-alt) (abs prev-alt))
1124                              (< (* prev-alt this-alt) 0)))
1125                     (set! need-restore #t))))))
1126
1127     (cons need-restore need-accidental)))
1128
1129 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1130   "Creates an accidental rule that makes its decision based on the octave of the note
1131   and a laziness value.
1132   octaveness is either 'same-octave or 'any-octave and defines whether the rule should
1133   respond to accidental changes in other octaves than the current. 'same-octave is the
1134   normal way to typeset accidentals - an accidental is made if the alteration is different
1135   from the last active pitch in the same octave. 'any-octave looks at the last active pitch
1136   in any octave.
1137   laziness states over how many bars an accidental should be remembered.
1138   0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure.
1139   A positive integer means that the accidental lasts over that many bar lines.
1140   -1 is 'forget immediately', that is, only look at key signature.
1141   #t is forever."
1142   (check-pitch-against-signature context pitch barnum laziness octaveness))
1143
1144 (define (key-entry-notename entry)
1145   "Return the pitch of an entry in localKeySignature. The entry is either of the form
1146   '(notename . alter) or '((octave . notename) . (alter barnum . measurepos))."
1147   (if (number? (car entry))
1148       (car entry)
1149       (cdar entry)))
1150
1151 (define (key-entry-octave entry)
1152   "Return the octave of an entry in localKeySignature (or #f if the entry does not have
1153   an octave)."
1154   (and (pair? (car entry)) (caar entry)))
1155
1156 (define (key-entry-bar-number entry)
1157   "Return the bar number of an entry in localKeySignature (or #f if the entry does not
1158   have a bar number)."
1159   (and (pair? (car entry)) (caddr entry)))
1160
1161 (define (key-entry-measure-position entry)
1162   "Return the measure position of an entry in localKeySignature (or #f if the entry does
1163   not have a measure position)."
1164   (and (pair? (car entry)) (cdddr entry)))
1165
1166 (define (key-entry-alteration entry)
1167   "Return the alteration of an entry in localKeySignature."
1168   (if (number? (car entry))
1169       (cdr entry)
1170       (cadr entry)))
1171
1172 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1173   "Return the first entry in keysig that matches the pitch.
1174   accept-global states whether key signature entries should be included.
1175   accept-local states whether local accidentals should be included.
1176   if no matching entry is found, #f is returned."
1177   (if (pair? keysig)
1178       (let* ((entry (car keysig))
1179              (entryoct (key-entry-octave entry))
1180              (entrynn (key-entry-notename entry))
1181              (oct (ly:pitch-octave pitch))
1182              (nn (ly:pitch-notename pitch)))
1183         (if (and (equal? nn entrynn)
1184                  (or (and accept-global (equal? #f entryoct))
1185                      (and accept-local (equal? oct entryoct))))
1186             entry
1187             (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))
1188       #f))
1189
1190 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1191   "an accidental rule that typesets an accidental if it differs from the key signature
1192    AND does not directly follow a note on the same staff-line.
1193    This rule should not be used alone because it does neither look at bar lines
1194    nor different accidentals at the same notename"
1195   (let* ((keysig (ly:context-property context 'localKeySignature))
1196          (entry (find-pitch-entry keysig pitch #t #t)))
1197     (if (equal? #f entry)
1198         (cons #f #f)
1199         (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1200                (key-acc (if (equal? global-entry #f)
1201                             0
1202                             (key-entry-alteration global-entry)))
1203                (acc (ly:pitch-alteration pitch))
1204                (entrymp (key-entry-measure-position entry))
1205                (entrybn (key-entry-bar-number entry)))
1206           (cons #f (not (or (equal? acc key-acc)
1207                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1208
1209 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1210   "an accidental rule that typesets a cautionary accidental
1211   if it is included in the key signature AND does not directly follow
1212   a note on the same staff-line."
1213   (let* ((keysig (ly:context-property context 'localKeySignature))
1214          (entry (find-pitch-entry keysig pitch #t #t)))
1215     (if (equal? #f entry)
1216         (cons #f #f)
1217         (let* ((global-entry (find-pitch-entry keysig pitch #f #f))
1218                (key-acc (if (equal? global-entry #f)
1219                             0
1220                             (key-entry-alteration global-entry)))
1221                (acc (ly:pitch-alteration pitch))
1222                (entrymp (key-entry-measure-position entry))
1223                (entrybn (key-entry-bar-number entry)))
1224           (cons #f (not (or (equal? acc key-acc)
1225                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1226
1227 (define-public (set-accidentals-properties extra-natural
1228                                            auto-accs auto-cauts
1229                                            context)
1230   (context-spec-music
1231    (make-sequential-music
1232     (append (if (boolean? extra-natural)
1233                 (list (make-property-set 'extraNatural extra-natural))
1234                 '())
1235             (list (make-property-set 'autoAccidentals auto-accs)
1236                   (make-property-set 'autoCautionaries auto-cauts))))
1237    context))
1238
1239 (define-public (set-accidental-style style . rest)
1240   "Set accidental style to STYLE. Optionally takes a context argument,
1241 e.g. 'Staff or 'Voice. The context defaults to Staff, except for piano styles, which
1242 use GrandStaff as a context. "
1243   (let ((context (if (pair? rest)
1244                      (car rest) 'Staff))
1245         (pcontext (if (pair? rest)
1246                       (car rest) 'GrandStaff)))
1247     (ly:export
1248      (cond
1249       ;; accidentals as they were common in the 18th century.
1250       ((equal? style 'default)
1251        (set-accidentals-properties #t
1252                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1253                                    '()
1254                                    context))
1255       ;; accidentals from one voice do NOT get cancelled in other voices
1256       ((equal? style 'voice)
1257        (set-accidentals-properties #t
1258                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1259                                    '()
1260                                    context))
1261       ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1262       ;; This includes all the default accidentals, but accidentals also needs cancelling
1263       ;; in other octaves and in the next measure.
1264       ((equal? style 'modern)
1265        (set-accidentals-properties #f
1266                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1267                                            ,(make-accidental-rule 'any-octave 0)
1268                                            ,(make-accidental-rule 'same-octave 1))
1269                                    '()
1270                                    context))
1271       ;; the accidentals that Stone adds to the old standard as cautionaries
1272       ((equal? style 'modern-cautionary)
1273        (set-accidentals-properties #f
1274                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1275                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1276                                            ,(make-accidental-rule 'same-octave 1))
1277                                    context))
1278       ;; same as modern, but accidentals different from the key signature are always
1279       ;; typeset - unless they directly follow a note of the same pitch.
1280       ((equal? style 'neo-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                                            ,neo-modern-accidental-rule)
1286                                    '()
1287                                    context))
1288       ((equal? style 'neo-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                                            ,neo-modern-accidental-rule)
1294                                    context))
1295       ((equal? style 'neo-modern-voice)
1296        (set-accidentals-properties #f
1297                                    `(Voice ,(make-accidental-rule 'same-octave 0)
1298                                            ,(make-accidental-rule 'any-octave 0)
1299                                            ,(make-accidental-rule 'same-octave 1)
1300                                            ,neo-modern-accidental-rule
1301                                      Staff ,(make-accidental-rule 'same-octave 0)
1302                                            ,(make-accidental-rule 'any-octave 0)
1303                                            ,(make-accidental-rule 'same-octave 1)
1304                                       ,neo-modern-accidental-rule)
1305                                    '()
1306                                    context))
1307       ((equal? style 'neo-modern-voice-cautionary)
1308        (set-accidentals-properties #f
1309                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1310                                    `(Voice ,(make-accidental-rule 'any-octave 0)
1311                                            ,(make-accidental-rule 'same-octave 1)
1312                                            ,neo-modern-accidental-rule
1313                                      Staff ,(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                                    context))
1318       ;; Accidentals as they were common in dodecaphonic music with no tonality.
1319       ;; Each note gets one accidental.
1320       ((equal? style 'dodecaphonic)
1321        (set-accidentals-properties #f
1322                                    `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1323                                    '()
1324                                    context))
1325       ;; Multivoice accidentals to be read both by musicians playing one voice
1326       ;; and musicians playing all voices.
1327       ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
1328       ((equal? style 'modern-voice)
1329        (set-accidentals-properties  #f
1330                                     `(Voice ,(make-accidental-rule 'same-octave 0)
1331                                             ,(make-accidental-rule 'any-octave 0)
1332                                             ,(make-accidental-rule 'same-octave 1)
1333                                       Staff ,(make-accidental-rule 'same-octave 0)
1334                                             ,(make-accidental-rule 'any-octave 0)
1335                                             ,(make-accidental-rule 'same-octave 1))
1336                                     '()
1337                                     context))
1338       ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1339       ;; as cautionaries
1340       ((equal? style 'modern-voice-cautionary)
1341        (set-accidentals-properties #f
1342                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1343                                    `(Voice ,(make-accidental-rule 'any-octave 0)
1344                                            ,(make-accidental-rule 'same-octave 1)
1345                                      Staff ,(make-accidental-rule 'same-octave 0)
1346                                            ,(make-accidental-rule 'any-octave 0)
1347                                            ,(make-accidental-rule 'same-octave 1))
1348                                    context))
1349       ;; stone's suggestions for accidentals on grand staff.
1350       ;; Accidentals are cancelled across the staves in the same grand staff as well
1351       ((equal? style 'piano)
1352        (set-accidentals-properties #f
1353                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1354                                            ,(make-accidental-rule 'any-octave 0)
1355                                            ,(make-accidental-rule 'same-octave 1)
1356                                      GrandStaff
1357                                            ,(make-accidental-rule 'any-octave 0)
1358                                            ,(make-accidental-rule 'same-octave 1))
1359                                    '()
1360                                    pcontext))
1361       ((equal? style 'piano-cautionary)
1362        (set-accidentals-properties #f
1363                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1364                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1365                                            ,(make-accidental-rule 'same-octave 1)
1366                                      GrandStaff
1367                                            ,(make-accidental-rule 'any-octave 0)
1368                                            ,(make-accidental-rule 'same-octave 1))
1369                                    pcontext))
1370
1371       ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1372       ;; tones specified by the key signature.
1373        ((equal? style 'teaching)
1374        (set-accidentals-properties #f
1375                                     `(Staff ,(make-accidental-rule 'same-octave 0))
1376                                     `(Staff ,(make-accidental-rule 'same-octave 1)
1377                                            ,teaching-accidental-rule)
1378                                    context))
1379
1380       ;; do not set localKeySignature when a note alterated differently from
1381       ;; localKeySignature is found.
1382       ;; Causes accidentals to be printed at every note instead of
1383       ;; remembered for the duration of a measure.
1384       ;; accidentals not being remembered, causing accidentals always to
1385       ;; be typeset relative to the time signature
1386       ((equal? style 'forget)
1387        (set-accidentals-properties '()
1388                                    `(Staff ,(make-accidental-rule 'same-octave -1))
1389                                    '()
1390                                    context))
1391       ;; Do not reset the key at the start of a measure.  Accidentals will be
1392       ;; printed only once and are in effect until overridden, possibly many
1393       ;; measures later.
1394       ((equal? style 'no-reset)
1395        (set-accidentals-properties '()
1396                                    `(Staff ,(make-accidental-rule 'same-octave #t))
1397                                    '()
1398                                    context))
1399       (else
1400        (ly:warning (_ "unknown accidental style: ~S") style)
1401        (make-sequential-music '()))))))
1402
1403 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1404
1405 (define-public (skip-of-length mus)
1406   "Create a skip of exactly the same length as MUS."
1407   (let* ((skip
1408           (make-music
1409            'SkipEvent
1410            'duration (ly:make-duration 0 0))))
1411
1412     (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1413
1414 (define-public (mmrest-of-length mus)
1415   "Create a mmrest of exactly the same length as MUS."
1416
1417   (let* ((skip
1418           (make-multi-measure-rest
1419            (ly:make-duration 0 0) '())))
1420     (ly:music-compress skip (ly:music-length mus))
1421     skip))
1422
1423 (define-public (pitch-of-note event-chord)
1424
1425   (let*
1426       ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types)))
1427                     (ly:music-property event-chord 'elements))))
1428
1429     (if (pair? evs)
1430         (ly:music-property (car evs) 'pitch)
1431         #f)))
1432
1433 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1434
1435 (define-public (extract-named-music music music-name)
1436 "Return a flat list of all music named @code{music-name}
1437 from @code{music}."
1438    (let ((extracted-list
1439           (if (ly:music? music)
1440               (if (eq? (ly:music-property music 'name) music-name)
1441                   (list music)
1442                   (let ((elt (ly:music-property music 'element))
1443                         (elts (ly:music-property music 'elements)))
1444                     (if (ly:music? elt)
1445                         (extract-named-music elt music-name)
1446                         (if (null? elts)
1447                             '()
1448                             (map (lambda(x)
1449                                     (extract-named-music x music-name ))
1450                              elts)))))
1451               '())))
1452      (flatten-list extracted-list)))
1453
1454 (define-public (event-chord-notes event-chord)
1455 "Return a list of all notes from @{event-chord}."
1456   (filter
1457     (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1458     (ly:music-property event-chord 'elements)))
1459
1460 (define-public (event-chord-pitches event-chord)
1461 "Return a list of all pitches from @{event-chord}."
1462   (map (lambda (x) (ly:music-property x 'pitch))
1463        (event-chord-notes event-chord)))