scm/music-functions.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   4 ;;;;                 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5 ;;;;
   6 ;;;; LilyPond is free software: you can redistribute it and/or modify
   7 ;;;; it under the terms of the GNU General Public License as published by
   8 ;;;; the Free Software Foundation, either version 3 of the License, or
   9 ;;;; (at your option) any later version.
  10 ;;;;
  11 ;;;; LilyPond is distributed in the hope that it will be useful,
  12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;;;; GNU General Public License for more details.
  15 ;;;;
  16 ;;;; You should have received a copy of the GNU General Public License
  17 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 ;; for define-safe-public when byte-compiling using Guile V2
  20 (use-modules (scm safe-utility-defs))
  21
  22 (use-modules (ice-9 optargs))
  23 (use-modules (srfi srfi-11))
  24
  25 ;;; ly:music-property with setter
  26 ;;; (ly:music-property my-music 'elements)
  27 ;;;   ==> the 'elements property
  28 ;;; (set! (ly:music-property my-music 'elements) value)
  29 ;;;   ==> set the 'elements property and return it
  30 (define-public ly:music-property
  31   (make-procedure-with-setter ly:music-property
  32                               ly:music-set-property!))
  33
  34 (define-safe-public (music-is-of-type? mus type)
  35   "Does @code{mus} belong to the music class @code{type}?"
  36   (memq type (ly:music-property mus 'types)))
  37
  38 ;; TODO move this
  39 (define-public ly:grob-property
  40   (make-procedure-with-setter ly:grob-property
  41                               ly:grob-set-property!))
  42
  43 (define-public ly:grob-object
  44   (make-procedure-with-setter ly:grob-object
  45                               ly:grob-set-object!))
  46
  47 (define-public ly:grob-parent
  48   (make-procedure-with-setter ly:grob-parent
  49                               ly:grob-set-parent!))
  50
  51 (define-public ly:prob-property
  52   (make-procedure-with-setter ly:prob-property
  53                               ly:prob-set-property!))
  54
  55 (define-public ly:context-property
  56   (make-procedure-with-setter ly:context-property
  57                               ly:context-set-property!))
  58
  59 (define-public (music-map function music)
  60   "Apply @var{function} to @var{music} and all of the music it contains.
  61
  62 First it recurses over the children, then the function is applied to
  63 @var{music}."
  64   (let ((es (ly:music-property music 'elements))
  65         (e (ly:music-property music 'element)))
  66     (if (pair? es)
  67         (set! (ly:music-property music 'elements)
  68               (map (lambda (y) (music-map function y)) es)))
  69     (if (ly:music? e)
  70         (set! (ly:music-property music 'element)
  71               (music-map function  e)))
  72     (function music)))
  73
  74 (define-public (music-filter pred? music)
  75   "Filter out music expressions that do not satisfy @var{pred?}."
  76
  77   (define (inner-music-filter pred? music)
  78     "Recursive function."
  79     (let* ((es (ly:music-property music 'elements))
  80            (e (ly:music-property music 'element))
  81            (as (ly:music-property music 'articulations))
  82            (filtered-as (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) as)))
  83            (filtered-e (if (ly:music? e)
  84                            (inner-music-filter pred? e)
  85                            e))
  86            (filtered-es (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) es))))
  87       (if (not (null? e))
  88           (set! (ly:music-property music 'element) filtered-e))
  89       (if (not (null? es))
  90           (set! (ly:music-property music 'elements) filtered-es))
  91       (if (not (null? as))
  92           (set! (ly:music-property music 'articulations) filtered-as))
  93       ;; if filtering emptied the expression, we remove it completely.
  94       (if (or (not (pred? music))
  95               (and (eq? filtered-es '()) (not (ly:music? e))
  96                    (or (not (eq? es '()))
  97                        (ly:music? e))))
  98           (set! music '()))
  99       music))
 100
 101   (set! music (inner-music-filter pred? music))
 102   (if (ly:music? music)
 103       music
 104       (make-music 'Music)))       ;must return music.
 105
 106 (define*-public (display-music music #:optional (port (current-output-port)))
 107   "Display music, not done with @code{music-map} for clarity of
 108 presentation."
 109   (display music port)
 110   (display ": { " port)
 111   (let ((es (ly:music-property music 'elements))
 112         (e (ly:music-property music 'element)))
 113     (display (ly:music-mutable-properties music) port)
 114     (if (pair? es)
 115         (begin (display "\nElements: {\n" port)
 116                (for-each (lambda (m) (display-music m port)) es)
 117                (display "}\n" port)))
 118     (if (ly:music? e)
 119         (begin
 120           (display "\nChild:" port)
 121           (display-music e port))))
 122   (display " }\n" port)
 123   music)
 124
 125 ;;;
 126 ;;; A scheme music pretty printer
 127 ;;;
 128 (define (markup-expression->make-markup markup-expression)
 129   "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression.
 130 For instance,
 131   \\markup \\bold \\italic hello
 132 ==>
 133   (markup #:line (#:bold (#:italic (#:simple \"hello\"))))"
 134   (define (proc->command-keyword proc)
 135     "Return a keyword, eg. `#:bold', from the `proc' function, eg. #<procedure bold-markup (layout props arg)>"
 136     (let ((cmd-markup (symbol->string (procedure-name proc))))
 137       (symbol->keyword (string->symbol (substring cmd-markup 0 (- (string-length cmd-markup)
 138                                                                   (string-length "-markup")))))))
 139   (define (transform-arg arg)
 140     (cond ((and (pair? arg) (markup? (car arg))) ;; a markup list
 141            (append-map inner-markup->make-markup arg))
 142           ((and (not (string? arg)) (markup? arg)) ;; a markup
 143            (inner-markup->make-markup arg))
 144           (else                                  ;; scheme arg
 145            (music->make-music arg))))
 146   (define (inner-markup->make-markup mrkup)
 147     (if (string? mrkup)
 148         `(#:simple ,mrkup)
 149         (let ((cmd (proc->command-keyword (car mrkup)))
 150               (args (map transform-arg (cdr mrkup))))
 151           `(,cmd ,@args))))
 152   ;; body:
 153   (if (string? markup-expression)
 154       markup-expression
 155       `(markup ,@(inner-markup->make-markup markup-expression))))
 156
 157 (define-public (music->make-music obj)
 158   "Generate an expression that, once evaluated, may return an object
 159 equivalent to @var{obj}, that is, for a music expression, a
 160 @code{(make-music ...)} form."
 161   (define (if-nonzero num)
 162     (if (zero? num) '() (list num)))
 163   (cond (;; markup expression
 164          (markup? obj)
 165          (markup-expression->make-markup obj))
 166         (;; music expression
 167          (ly:music? obj)
 168          `(make-music
 169            ',(ly:music-property obj 'name)
 170            ,@(append-map (lambda (prop)
 171                            `(',(car prop)
 172                              ,(music->make-music (cdr prop))))
 173                          (remove (lambda (prop)
 174                                    (eqv? (car prop) 'origin))
 175                                  (ly:music-mutable-properties obj)))))
 176         (;; moment
 177          (ly:moment? obj)
 178          `(ly:make-moment
 179            ,@(let ((main (ly:moment-main obj))
 180                    (grace (ly:moment-grace obj)))
 181                (cond ((zero? grace) (list main))
 182                      ((negative? grace) (list main grace))
 183                      (else ;;positive grace requires 4-arg form
 184                       (list (numerator main)
 185                             (denominator main)
 186                             (numerator grace)
 187                             (denominator grace)))))))
 188         (;; note duration
 189          (ly:duration? obj)
 190          `(ly:make-duration ,(ly:duration-log obj)
 191                             ,@(if (= (ly:duration-scale obj) 1)
 192                                   (if-nonzero (ly:duration-dot-count obj))
 193                                   (list (ly:duration-dot-count obj)
 194                                         (ly:duration-scale obj)))))
 195         (;; note pitch
 196          (ly:pitch? obj)
 197          `(ly:make-pitch ,(ly:pitch-octave obj)
 198                          ,(ly:pitch-notename obj)
 199                          ,@(if-nonzero (ly:pitch-alteration obj))))
 200         (;; scheme procedure
 201          (procedure? obj)
 202          (or (procedure-name obj) obj))
 203         (;; a symbol (avoid having an unquoted symbol)
 204          (symbol? obj)
 205          `',obj)
 206         (;; an empty list (avoid having an unquoted empty list)
 207          (null? obj)
 208          `'())
 209         (;; a proper list
 210          (list? obj)
 211          `(list ,@(map music->make-music obj)))
 212         (;; a pair
 213          (pair? obj)
 214          `(cons ,(music->make-music (car obj))
 215                 ,(music->make-music (cdr obj))))
 216         (else
 217          obj)))
 218
 219 (use-modules (ice-9 pretty-print))
 220 (define*-public (display-scheme-music obj #:optional (port (current-output-port)))
 221   "Displays `obj', typically a music expression, in a friendly fashion,
 222 which often can be read back in order to generate an equivalent expression."
 223   (pretty-print (music->make-music obj) port)
 224   (newline port))
 225
 226 ;;;
 227 ;;; Scheme music expression --> Lily-syntax-using string translator
 228 ;;;
 229 (use-modules (srfi srfi-39)
 230              (scm display-lily))
 231
 232 (define*-public (display-lily-music expr #:optional (port (current-output-port))
 233                                     #:key force-duration)
 234   "Display the music expression using LilyPond syntax"
 235   (memoize-clef-names supported-clefs)
 236   (parameterize ((*indent* 0)
 237                  (*omit-duration* #f))
 238                 (display (music->lily-string expr) port)
 239                 (newline port)))
 240
 241 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 242
 243 (define-public (shift-one-duration-log music shift dot)
 244   "Add @var{shift} to @code{duration-log} of @code{'duration} in
 245 @var{music} and optionally @var{dot} to any note encountered.
 246 The number of dots in the shifted music may not be less than zero."
 247   (let ((d (ly:music-property music 'duration)))
 248     (if (ly:duration? d)
 249         (let* ((cp (ly:duration-scale d))
 250                (nd (ly:make-duration
 251                     (+ shift (ly:duration-log d))
 252                     (max 0 (+ dot (ly:duration-dot-count d)))
 253                     cp)))
 254           (set! (ly:music-property music 'duration) nd)))
 255     ;clear cached length, since it's no longer valid
 256     (set! (ly:music-property music 'length) '())
 257     music))
 258
 259 (define-public (shift-duration-log music shift dot)
 260   (music-map (lambda (x) (shift-one-duration-log x shift dot))
 261              music))
 262
 263 (define-public (tremolo::get-music-list tremolo)
 264   "Given a tremolo repeat, return a list of music to engrave for it.
 265 This will be a stretched copy of its body, plus a TremoloEvent or
 266 TremoloSpanEvent.
 267
 268 This is called only by Chord_tremolo_iterator."
 269   (define (first-note-duration music)
 270     "Finds the duration of the first NoteEvent by searching
 271 depth-first through MUSIC."
 272     ;; NoteEvent or a non-expanded chord-repetition
 273     ;; We just take anything that actually sports an announced duration.
 274     (if (ly:duration? (ly:music-property music 'duration))
 275         (ly:music-property music 'duration)
 276         (let loop ((elts (if (ly:music? (ly:music-property music 'element))
 277                              (list (ly:music-property music 'element))
 278                              (ly:music-property music 'elements))))
 279           (and (pair? elts)
 280                (let ((dur (first-note-duration (car elts))))
 281                  (if (ly:duration? dur)
 282                      dur
 283                      (loop (cdr elts))))))))
 284   (let* ((times (ly:music-property tremolo 'repeat-count))
 285          (body (ly:music-property tremolo 'element))
 286          (children (if (music-is-of-type? body 'sequential-music)
 287                        ;; \repeat tremolo n { ... }
 288                        (count duration-of-note ; do not count empty <>
 289                               (extract-named-music body
 290                                                    '(EventChord NoteEvent)))
 291                        ;; \repeat tremolo n c4
 292                        1))
 293          (tremolo-type (if (positive? children)
 294                            (let* ((note-duration (first-note-duration body))
 295                                   (duration-log (if (ly:duration? note-duration)
 296                                                     (ly:duration-log note-duration)
 297                                                     1)))
 298                              (ash 1 duration-log))
 299                            '()))
 300          (stretched (ly:music-deep-copy body)))
 301     (if (positive? children)
 302         ;; # of dots is equal to the 1 in bitwise representation (minus 1)!
 303         (let* ((dots (1- (logcount (* times children))))
 304                ;; The remaining missing multiplier to scale the notes by
 305                ;; times * children
 306                (mult (/ (* times children (ash 1 dots)) (1- (ash 2 dots))))
 307                (shift (- (ly:intlog2 (floor mult)))))
 308           (if (not (and (integer? mult) (= (logcount mult) 1)))
 309               (ly:music-warning
 310                body
 311                (ly:format (_ "invalid tremolo repeat count: ~a") times)))
 312           ;; Make each note take the full duration
 313           (ly:music-compress stretched (ly:make-moment 1 children))
 314           ;; Adjust the displayed note durations
 315           (shift-duration-log stretched shift dots)))
 316     ;; Return the stretched body plus a tremolo event
 317     (if (= children 1)
 318         (list (make-music 'TremoloEvent
 319                           'repeat-count times
 320                           'tremolo-type tremolo-type
 321                           'origin (ly:music-property tremolo 'origin))
 322               stretched)
 323         (list (make-music 'TremoloSpanEvent
 324                           'span-direction START
 325                           'repeat-count times
 326                           'tremolo-type tremolo-type
 327                           'origin (ly:music-property tremolo 'origin))
 328               stretched
 329               (make-music 'TremoloSpanEvent
 330                           'span-direction STOP
 331                           'origin (ly:music-property tremolo 'origin))))))
 332
 333 (define-public (make-repeat name times main alts)
 334   "Create a repeat music expression, with all properties initialized
 335 properly."
 336   (let ((type (or (assoc-get name '(("volta" . VoltaRepeatedMusic)
 337                                     ("unfold" . UnfoldedRepeatedMusic)
 338                                     ("percent" . PercentRepeatedMusic)
 339                                     ("tremolo" . TremoloRepeatedMusic)))
 340                   (begin (ly:warning (_ "unknown repeat type `~S': must be volta, unfold, percent, or tremolo") name)
 341                          'VoltaRepeatedMusic)))
 342         (talts (if (< times (length alts))
 343                    (begin
 344                      (ly:warning (_ "More alternatives than repeats.  Junking excess alternatives"))
 345                      (take alts times))
 346                    alts)))
 347     (make-music type
 348                 'element main
 349                 'repeat-count (max times 1)
 350                 'elements talts)))
 351
 352 (define (calc-repeat-slash-count music)
 353   "Given the child-list @var{music} in @code{PercentRepeatMusic},
 354 calculate the number of slashes based on the durations.  Returns @code{0}
 355 if durations in @var{music} vary, allowing slash beats and double-percent
 356 beats to be distinguished."
 357   (let* ((durs (map duration-of-note
 358                     (extract-named-music music '(EventChord NoteEvent
 359                                                             RestEvent SkipEvent))))
 360          (first-dur (car durs)))
 361
 362     (if (every (lambda (d) (equal? d first-dur)) durs)
 363         (max (- (ly:duration-log first-dur) 2) 1)
 364         0)))
 365
 366 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 367 ;; clusters.
 368
 369 (define-public (note-to-cluster music)
 370   "Replace @code{NoteEvents} by @code{ClusterNoteEvents}."
 371   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 372       (make-music 'ClusterNoteEvent
 373                   'pitch (ly:music-property music 'pitch)
 374                   'duration (ly:music-property music 'duration))
 375       music))
 376
 377 (define-public (notes-to-clusters music)
 378   (music-map note-to-cluster music))
 379
 380 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 381 ;; repeats.
 382
 383 (define-public (unfold-repeats music)
 384   "Replace all repeats with unfolded repeats."
 385   (let ((es (ly:music-property music 'elements))
 386         (e (ly:music-property music 'element)))
 387     (if (music-is-of-type? music 'repeated-music)
 388         (set! music (make-music 'UnfoldedRepeatedMusic music)))
 389     (if (pair? es)
 390         (set! (ly:music-property music 'elements)
 391               (map unfold-repeats es)))
 392     (if (ly:music? e)
 393         (set! (ly:music-property music 'element)
 394               (unfold-repeats e)))
 395     music))
 396
 397 (define-public (unfold-repeats-fully music)
 398   "Unfolds repeats and expands the resulting @code{unfolded-repeated-music}."
 399   (map-some-music
 400    (lambda (m)
 401      (and (music-is-of-type? m 'unfolded-repeated-music)
 402           (make-sequential-music
 403            (ly:music-deep-copy (make-unfolded-set m)))))
 404    (unfold-repeats music)))
 405
 406 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 407 ;; property setting music objs.
 408
 409 (define-safe-public (check-grob-path path #:optional location
 410                                      #:key
 411                                      (start 0)
 412                                      default
 413                                      (min 1)
 414                                      max)
 415   "Check a grob path specification @var{path}, a symbol list (or a
 416 single symbol), for validity and possibly complete it.  Returns the
 417 completed specification, or @code{#f} if invalid.  If optional
 418 @var{parser} is given, a syntax error is raised in that case,
 419 optionally using @var{location}.  If an optional keyword argument
 420 @code{#:start @var{start}} is given, the parsing starts at the given
 421 index in the sequence @samp{Context.Grob.property.sub-property...},
 422 with the default of @samp{0} implying the full path.
 423
 424 If there is no valid first element of @var{path} fitting at the given
 425 path location, an optionally given @code{#:default @var{default}} is
 426 used as the respective element instead without checking it for
 427 validity at this position.
 428
 429 The resulting path after possibly prepending @var{default} can be
 430 constrained in length by optional arguments @code{#:min @var{min}} and
 431 @code{#:max @var{max}}, defaulting to @samp{1} and unlimited,
 432 respectively."
 433   (let ((path (if (symbol? path) (list path) path)))
 434     ;; A Guile 1.x bug specific to optargs precludes moving the
 435     ;; defines out of the let
 436     (define (unspecial? s)
 437       (not (or (object-property s 'is-grob?)
 438                (object-property s 'backend-type?))))
 439     (define (grob? s)
 440       (object-property s 'is-grob?))
 441     (define (property? s)
 442       (object-property s 'backend-type?))
 443     (define (check c p) (c p))
 444
 445     (let* ((checkers
 446             (and (< start 3)
 447                  (drop (list unspecial? grob? property?) start)))
 448            (res
 449             (cond
 450              ((null? path)
 451               ;; tricky.  Should we make use of the default when the
 452               ;; list is empty?  In most cases, this question should be
 453               ;; academical as an empty list can only be generated by
 454               ;; Scheme and is likely an error.  We consider this a case
 455               ;; of "no valid first element, and default given".
 456               ;; Usually, invalid use cases should be caught later using
 457               ;; the #:min argument, and if the user explicitly does not
 458               ;; catch this, we just follow through.
 459               (if default (list default) '()))
 460              ((not checkers)
 461               ;; no checkers, so we have a valid first element and just
 462               ;; take the path as-is.
 463               path)
 464              (default
 465                (if ((car checkers) (car path))
 466                    (and (every check (cdr checkers) (cdr path))
 467                         path)
 468                    (and (every check (cdr checkers) path)
 469                         (cons default path))))
 470              (else
 471               (and (every check checkers path)
 472                    path)))))
 473       (if (and res
 474                (if max (<= min (length res) max)
 475                    (<= min (length res))))
 476           res
 477           (begin
 478             (ly:parser-error
 479              (format #f (_ "bad grob property path ~a")
 480                      path)
 481              location)
 482             #f)))))
 483
 484 (define-public (make-grob-property-set grob gprop val)
 485   "Make a @code{Music} expression that sets @var{gprop} to @var{val} in
 486 @var{grob}.  Does a pop first, i.e., this is not an override."
 487   (make-music 'OverrideProperty
 488               'symbol grob
 489               'grob-property gprop
 490               'grob-value val
 491               'pop-first #t))
 492
 493 (define-public (make-grob-property-override grob gprop val)
 494   "Make a @code{Music} expression that overrides @var{gprop} to @var{val}
 495 in @var{grob}."
 496   (make-music 'OverrideProperty
 497               'symbol grob
 498               'grob-property gprop
 499               'grob-value val))
 500
 501 (define-public (make-grob-property-revert grob gprop)
 502   "Revert the grob property @var{gprop} for @var{grob}."
 503   (make-music 'RevertProperty
 504               'symbol grob
 505               'grob-property gprop))
 506
 507 (define direction-polyphonic-grobs
 508   '(AccidentalSuggestion
 509     DotColumn
 510     Dots
 511     Fingering
 512     LaissezVibrerTie
 513     LigatureBracket
 514     MultiMeasureRest
 515     PhrasingSlur
 516     RepeatTie
 517     Rest
 518     Script
 519     Slur
 520     Stem
 521     TextScript
 522     Tie
 523     TupletBracket
 524     TrillSpanner))
 525
 526 (define general-grace-settings
 527   `((Voice Stem font-size -3)
 528     (Voice Flag font-size -3)
 529     (Voice NoteHead font-size -3)
 530     (Voice TabNoteHead font-size -4)
 531     (Voice Dots font-size -3)
 532     (Voice Stem length-fraction 0.8)
 533     (Voice Stem no-stem-extend #t)
 534     (Voice Beam beam-thickness 0.384)
 535     (Voice Beam length-fraction 0.8)
 536     (Voice Accidental font-size -4)
 537     (Voice AccidentalCautionary font-size -4)
 538     (Voice Script font-size -3)
 539     (Voice Fingering font-size -8)
 540     (Voice StringNumber font-size -8)))
 541
 542 (define-public score-grace-settings
 543   (append
 544     `((Voice Stem direction ,UP)
 545       (Voice Slur direction ,DOWN))
 546     general-grace-settings))
 547
 548 (define-safe-public (make-voice-props-set n)
 549   (make-sequential-music
 550    (append
 551     (map (lambda (x) (make-grob-property-set x 'direction
 552                                              (if (odd? n) -1 1)))
 553          direction-polyphonic-grobs)
 554     (list
 555      (make-property-set 'graceSettings general-grace-settings)
 556      (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))))))
 557
 558 (define-safe-public (make-voice-props-override n)
 559   (make-sequential-music
 560    (append
 561     (map (lambda (x) (make-grob-property-override x 'direction
 562                                                   (if (odd? n) -1 1)))
 563          direction-polyphonic-grobs)
 564     (list
 565      (make-property-set 'graceSettings general-grace-settings)
 566      (make-grob-property-override 'NoteColumn 'horizontal-shift (quotient n 2))))))
 567
 568 (define-safe-public (make-voice-props-revert)
 569   (make-sequential-music
 570    (append
 571     (map (lambda (x) (make-grob-property-revert x 'direction))
 572          direction-polyphonic-grobs)
 573     (list (make-property-unset 'graceSettings)
 574           (make-grob-property-revert 'NoteColumn 'horizontal-shift)))))
 575
 576
 577 (define-safe-public (context-spec-music m context #:optional id)
 578   "Add \\context CONTEXT = ID to M."
 579   (let ((cm (make-music 'ContextSpeccedMusic
 580                         'element m
 581                         'context-type context)))
 582     (if (string? id)
 583         (set! (ly:music-property cm 'context-id) id))
 584     cm))
 585
 586 (define-public (descend-to-context m context)
 587   "Like @code{context-spec-music}, but only descending."
 588   (let ((cm (context-spec-music m context)))
 589     (ly:music-set-property! cm 'descend-only #t)
 590     cm))
 591
 592 (define-public (make-non-relative-music mus)
 593   (make-music 'UnrelativableMusic
 594               'element mus))
 595
 596 (define-public (make-apply-context func)
 597   (make-music 'ApplyContext
 598               'procedure func))
 599
 600 (define-public (make-sequential-music elts)
 601   (make-music 'SequentialMusic
 602               'elements elts))
 603
 604 (define-public (make-simultaneous-music elts)
 605   (make-music 'SimultaneousMusic
 606               'elements elts))
 607
 608 (define-safe-public (make-event-chord elts)
 609   (make-music 'EventChord
 610               'elements elts))
 611
 612 (define-public (make-skip-music dur)
 613   (make-music 'SkipMusic
 614               'duration dur))
 615
 616 (define-public (make-grace-music music)
 617   (make-music 'GraceMusic
 618               'element music))
 619
 620 ;;;;;;;;;;;;;;;;
 621
 622 ;; mmrest
 623 (define-public (make-multi-measure-rest duration location)
 624   (make-music 'MultiMeasureRestMusic
 625               'origin location
 626               'duration duration))
 627
 628 (define-public (make-property-set sym val)
 629   (make-music 'PropertySet
 630               'symbol sym
 631               'value val))
 632
 633 (define-public (make-property-unset sym)
 634   (make-music 'PropertyUnset
 635               'symbol sym))
 636
 637 (define-safe-public (make-articulation name . properties)
 638   (apply make-music 'ArticulationEvent
 639          'articulation-type name
 640          properties))
 641
 642 (define-public (make-lyric-event string duration)
 643   (make-music 'LyricEvent
 644               'duration duration
 645               'text string))
 646
 647 (define-safe-public (make-span-event type span-dir)
 648   (make-music type
 649               'span-direction span-dir))
 650
 651 (define-public (override-head-style heads style)
 652   "Override style for @var{heads} to @var{style}."
 653   (make-sequential-music
 654    (if (pair? heads)
 655        (map (lambda (h)
 656               (make-grob-property-override h 'style style))
 657             heads)
 658        (list (make-grob-property-override heads 'style style)))))
 659
 660 (define-public (revert-head-style heads)
 661   "Revert style for @var{heads}."
 662   (make-sequential-music
 663    (if (pair? heads)
 664        (map (lambda (h)
 665               (make-grob-property-revert h 'style))
 666             heads)
 667        (list (make-grob-property-revert heads 'style)))))
 668
 669 (define-public (style-note-heads heads style music)
 670   "Set @var{style} for all @var{heads} in @var{music}.  Works both
 671 inside of and outside of chord construct."
 672   ;; are we inside a <...>?
 673   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 674       ;; yes -> use a tweak
 675       (begin
 676         (set! (ly:music-property music 'tweaks)
 677               (acons 'style style (ly:music-property music 'tweaks)))
 678         music)
 679       ;; not in <...>, so use overrides
 680       (make-sequential-music
 681        (list
 682         (override-head-style heads style)
 683         music
 684         (revert-head-style heads)))))
 685
 686 (define-public (set-mus-properties! m alist)
 687   "Set all of @var{alist} as properties of @var{m}."
 688   (if (pair? alist)
 689       (begin
 690         (set! (ly:music-property m (caar alist)) (cdar alist))
 691         (set-mus-properties! m (cdr alist)))))
 692
 693 (define-public (music-separator? m)
 694   "Is @var{m} a separator?"
 695   (let ((ts (ly:music-property m 'types)))
 696     (memq 'separator ts)))
 697
 698 ;;; expanding repeat chords
 699 (define-public (copy-repeat-chord original-chord repeat-chord duration
 700                                   event-types)
 701   "Copies all events in @var{event-types} (be sure to include
 702 @code{rhythmic-events}) from @var{original-chord} over to
 703 @var{repeat-chord} with their articulations filtered as well.  Any
 704 duration is replaced with the specified @var{duration}."
 705   ;; First remove everything from event-types that can already be
 706   ;; found in the repeated chord.  We don't need to look for
 707   ;; articulations on individual events since they can't actually get
 708   ;; into a repeat chord given its input syntax.
 709
 710   (define (keep-element? m)
 711     (any (lambda (t) (music-is-of-type? m t))
 712          event-types))
 713   (define origin (ly:music-property repeat-chord 'origin #f))
 714   (define (set-origin! l)
 715     (if origin
 716         (for-each (lambda (m) (set! (ly:music-property m 'origin) origin)) l))
 717     l)
 718
 719   (for-each
 720    (lambda (field)
 721      (for-each (lambda (e)
 722                  (for-each (lambda (x)
 723                              (set! event-types (delq x event-types)))
 724                            (ly:music-property e 'types)))
 725                (ly:music-property repeat-chord field)))
 726    '(elements articulations))
 727
 728   ;; now treat the elements
 729   (set! (ly:music-property repeat-chord 'elements)
 730         (let ((elts
 731                (set-origin! (ly:music-deep-copy
 732                              (filter keep-element?
 733                                      (ly:music-property original-chord
 734                                                         'elements))))))
 735           (for-each
 736            (lambda (m)
 737              (let ((arts (ly:music-property m 'articulations)))
 738                (if (pair? arts)
 739                    (set! (ly:music-property m 'articulations)
 740                          (set-origin! (filter! keep-element? arts))))
 741                (if (ly:duration? (ly:music-property m 'duration))
 742                    (set! (ly:music-property m 'duration) duration))
 743                (if (ly:music-property m 'cautionary #f)
 744                    (set! (ly:music-property m 'cautionary) #f))
 745                (if (ly:music-property m 'force-accidental #f)
 746                    (set! (ly:music-property m 'force-accidental) #f))))
 747            elts)
 748           (append! elts (ly:music-property repeat-chord 'elements))))
 749   (let ((arts (filter keep-element?
 750                       (ly:music-property original-chord
 751                                          'articulations))))
 752     (if (pair? arts)
 753         (set! (ly:music-property repeat-chord 'articulations)
 754               (append!
 755                (set-origin! (ly:music-deep-copy arts))
 756                (ly:music-property repeat-chord 'articulations)))))
 757   repeat-chord)
 758
 759
 760 (define-public (expand-repeat-chords! event-types music)
 761   "Walks through @var{music} and fills repeated chords (notable by
 762 having a duration in @code{duration}) with the notes from their
 763 respective predecessor chord."
 764   (let loop ((music music) (last-chord #f))
 765     (if (music-is-of-type? music 'event-chord)
 766         (let ((chord-repeat (ly:music-property music 'duration)))
 767           (cond
 768            ((not (ly:duration? chord-repeat))
 769             (if (any (lambda (m) (ly:duration?
 770                                   (ly:music-property m 'duration)))
 771                      (ly:music-property music 'elements))
 772                 music
 773                 last-chord))
 774            (last-chord
 775             (set! (ly:music-property music 'duration) '())
 776             (copy-repeat-chord last-chord music chord-repeat event-types))
 777            (else
 778             (ly:music-warning music (_ "Bad chord repetition"))
 779             #f)))
 780         (let ((elt (ly:music-property music 'element)))
 781           (fold loop (if (ly:music? elt) (loop elt last-chord) last-chord)
 782                 (ly:music-property music 'elements)))))
 783   music)
 784
 785 ;;; This does _not_ copy any articulations.  Rationale: one main
 786 ;;; incentive for pitch-repeating durations is after ties, such that
 787 ;;; 4~2~8. can stand in for a 15/16 note in \partial 4 position.  In
 788 ;;; this use case, any repeated articulations will be a nuisance.
 789 ;;;
 790 ;;; String assignments in TabStaff might seem like a worthwhile
 791 ;;; exception, but they would be better tackled by the respective
 792 ;;; engravers themselves (see issue 3662).
 793 ;;;
 794 ;;; Repeating chords as well seems problematic for things like
 795 ;;; \score {
 796 ;;;   <<
 797 ;;;     \new Staff { c4 c c <c e> }
 798 ;;;     \new RhythmicStaff { 4 4 4 4 }
 799 ;;;   >>
 800 ;;; }
 801 ;;;
 802 ;;; However, because of MIDI it is not advisable to use RhythmicStaff
 803 ;;; without any initial pitch/drum-type.  For music functions taking
 804 ;;; pure rhythms as an argument, the running of expand-repeat-notes!
 805 ;;; at scorification time is irrelevant: at that point of time, the
 806 ;;; music function has already run.
 807
 808 (define-public (expand-repeat-notes! music)
 809   "Walks through @var{music} and gives pitchless notes (not having a
 810 pitch in code{pitch} or a drum type in @code{drum-type}) the pitch(es)
 811 from the predecessor note/chord if available."
 812   (let ((last-pitch #f))
 813     (map-some-music
 814      (lambda (m)
 815        (define (set-and-ret last)
 816          (set! last-pitch last)
 817          m)
 818        (cond
 819         ((music-is-of-type? m 'event-chord)
 820          (if (any (lambda (m) (music-is-of-type? m 'rhythmic-event))
 821                   (ly:music-property m 'elements))
 822              (set! last-pitch m))
 823          m)
 824         ((music-is-of-type? m 'note-event)
 825          (cond
 826           ((or (ly:music-property m 'pitch #f)
 827                (ly:music-property m 'drum-type #f))
 828            => set-and-ret)
 829           ;; ok, naked rhythm.  Go through the various cases of
 830           ;; last-pitch
 831           ;; nothing available: just keep as-is
 832           ((not last-pitch) m)
 833           ((ly:pitch? last-pitch)
 834            (set! (ly:music-property m 'pitch) last-pitch)
 835            m)
 836           ((symbol? last-pitch)
 837            (set! (ly:music-property m 'drum-type) last-pitch)
 838            m)
 839           ;; Ok, this is the big bad one: the reference is a chord.
 840           ;; For now, we use the repeat chord logic.  That's not
 841           ;; really efficient as cleaning out all articulations is
 842           ;; quite simpler than what copy-repeat-chord does.
 843           (else
 844            (copy-repeat-chord last-pitch
 845                               (make-music 'EventChord
 846                                           'elements
 847                                           (ly:music-property m 'articulations)
 848                                           'origin
 849                                           (ly:music-property m 'origin))
 850                               (ly:music-property m 'duration)
 851                               '(rhythmic-event)))))
 852         (else #f)))
 853      music)))
 854
 855 ;;; splitting chords into voices.
 856 (define (voicify-list lst number)
 857   "Make a list of Musics.
 858
 859 voicify-list :: [ [Music ] ] -> number -> [Music]
 860 LST is a list music-lists.
 861
 862 NUMBER is 0-base, i.e., Voice=1 (upstems) has number 0.
 863 "
 864   (if (null? lst)
 865       '()
 866       (cons (context-spec-music
 867              (make-sequential-music
 868               (list (make-voice-props-set number)
 869                     (make-simultaneous-music (car lst))))
 870              'Bottom  (number->string (1+ number)))
 871             (voicify-list (cdr lst) (1+ number)))))
 872
 873 (define (voicify-chord ch)
 874   "Split the parts of a chord into different Voices using separator"
 875   (let ((es (ly:music-property ch 'elements)))
 876     (set! (ly:music-property  ch 'elements)
 877           (voicify-list (split-list-by-separator es music-separator?) 0))
 878     ch))
 879
 880 (define-public (voicify-music m)
 881   "Recursively split chords that are separated with @code{\\\\}."
 882   (if (not (ly:music? m))
 883       (ly:error (_ "music expected: ~S") m))
 884   (let ((es (ly:music-property m 'elements))
 885         (e (ly:music-property m 'element)))
 886
 887     (if (pair? es)
 888         (set! (ly:music-property m 'elements) (map voicify-music es)))
 889     (if (ly:music? e)
 890         (set! (ly:music-property m 'element)  (voicify-music e)))
 891     (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
 892              (any music-separator? es))
 893         (set! m (context-spec-music (voicify-chord m) 'Staff)))
 894     m))
 895
 896 (define-public (empty-music)
 897   (make-music 'Music))
 898
 899 ;; Make a function that checks score element for being of a specific type.
 900 (define-public (make-type-checker symbol)
 901   (lambda (elt)
 902     (grob::has-interface elt symbol)))
 903
 904 (define ((outputproperty-compatibility func sym val) grob g-context ao-context)
 905   (if (func grob)
 906       (set! (ly:grob-property grob sym) val)))
 907 (export outputproperty-compatibility)
 908
 909
 910 (define ((set-output-property grob-name symbol val)  grob grob-c context)
 911   "Usage example:
 912 @code{\\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))}"
 913   (let ((meta (ly:grob-property grob 'meta)))
 914     (if (equal? (assoc-get 'name meta) grob-name)
 915         (set! (ly:grob-property grob symbol) val))))
 916 (export set-output-property)
 917
 918
 919 (define-public (skip->rest mus)
 920   "Replace @var{mus} by @code{RestEvent} of the same duration if it is a
 921 @code{SkipEvent}.  Useful for extracting parts from crowded scores."
 922
 923   (if  (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
 924        (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
 925        mus))
 926
 927
 928 (define-public (music-has-type music type)
 929   (memq type (ly:music-property music 'types)))
 930
 931 (define-public (music-clone music . music-properties)
 932   "Clone @var{music} and set properties according to
 933 @var{music-properties}, a list of alternating property symbols and
 934 values:
 935 @example\n(music-clone start-span 'span-direction STOP)
 936 @end example
 937 Only properties that are not overriden by @var{music-properties} are
 938 actually fully cloned."
 939   (let ((old-props (list-copy (ly:music-mutable-properties music)))
 940         (new-props '())
 941         (m (ly:make-music (ly:prob-immutable-properties music))))
 942     (define (set-props mus-props)
 943       (if (and (not (null? mus-props))
 944                (not (null? (cdr mus-props))))
 945           (begin
 946             (set! old-props (assq-remove! old-props (car mus-props)))
 947             (set! new-props
 948                   (assq-set! new-props
 949                              (car mus-props) (cadr mus-props)))
 950             (set-props (cddr mus-props)))))
 951     (set-props music-properties)
 952     (for-each
 953      (lambda (pair)
 954        (set! (ly:music-property m (car pair))
 955              (ly:music-deep-copy (cdr pair))))
 956      old-props)
 957     (for-each
 958      (lambda (pair)
 959        (set! (ly:music-property m (car pair)) (cdr pair)))
 960      new-props)
 961     m))
 962
 963 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 964 ;; warn for bare chords at start.
 965
 966 (define-public (ly:music-message music msg . rest)
 967   (let ((ip (ly:music-property music 'origin)))
 968     (if (ly:input-location? ip)
 969         (apply ly:input-message ip msg rest)
 970         (apply ly:message msg rest))))
 971
 972 (define-public (ly:music-warning music msg . rest)
 973   (let ((ip (ly:music-property music 'origin)))
 974     (if (ly:input-location? ip)
 975         (apply ly:input-warning ip msg rest)
 976         (apply ly:warning msg rest))))
 977
 978 (define-public (ly:event-warning event msg . rest)
 979   (let ((ip (ly:event-property event 'origin)))
 980     (if (ly:input-location? ip)
 981         (apply ly:input-warning ip msg rest)
 982         (apply ly:warning msg rest))))
 983
 984 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 985 ;;
 986 ;; setting stuff for grace context.
 987 ;;
 988
 989 (define (vector-extend v x)
 990   "Make a new vector consisting of V, with X added to the end."
 991   (let* ((n (vector-length v))
 992          (nv (make-vector (+ n 1) '())))
 993     (vector-move-left! v 0 n nv 0)
 994     (vector-set! nv n x)
 995     nv))
 996
 997 (define (vector-map f v)
 998   "Map F over V.  This function returns nothing."
 999   (do ((n (vector-length v))
1000        (i 0 (+ i 1)))
1001       ((>= i n))
1002     (f (vector-ref v i))))
1003
1004 (define (vector-reverse-map f v)
1005   "Map F over V, N to 0 order.  This function returns nothing."
1006   (do ((i (- (vector-length v) 1) (- i 1)))
1007       ((< i 0))
1008     (f (vector-ref v i))))
1009
1010 (define-public (add-grace-property context-name grob sym val)
1011   "Set @var{sym}=@var{val} for @var{grob} in @var{context-name}."
1012   (define (set-prop context)
1013     (let* ((where (or (ly:context-find context context-name) context))
1014            (current (ly:context-property where 'graceSettings))
1015            (new-settings (append current
1016                                  (list (list context-name grob sym val)))))
1017       (ly:context-set-property! where 'graceSettings new-settings)))
1018   (make-apply-context set-prop))
1019
1020 (define-public (remove-grace-property context-name grob sym)
1021   "Remove all @var{sym} for @var{grob} in @var{context-name}."
1022   (define (sym-grob-context? property sym grob context-name)
1023     (and (eq? (car property) context-name)
1024          (eq? (cadr property) grob)
1025          (eq? (caddr property) sym)))
1026   (define (delete-prop context)
1027     (let* ((where (or (ly:context-find context context-name) context))
1028            (current (ly:context-property where 'graceSettings))
1029            (prop-settings (filter
1030                            (lambda(x) (sym-grob-context? x sym grob context-name))
1031                            current))
1032            (new-settings current))
1033       (for-each (lambda(x)
1034                   (set! new-settings (delete x new-settings)))
1035                 prop-settings)
1036       (ly:context-set-property! where 'graceSettings new-settings)))
1037   (make-apply-context delete-prop))
1038
1039
1040 (defmacro-public def-grace-function (start stop . docstring)
1041   "Helper macro for defining grace music"
1042   `(define-music-function (music) (ly:music?)
1043      ,@docstring
1044      (make-music 'GraceMusic
1045                  'element (make-music 'SequentialMusic
1046                                       'elements (list (ly:music-deep-copy ,start)
1047                                                       music
1048                                                       (ly:music-deep-copy ,stop))))))
1049
1050 (defmacro-public define-syntax-function (type args signature . body)
1051   "Helper macro for `ly:make-music-function'.
1052 Syntax:
1053   (define-syntax-function result-type? (arg1 arg2 ...) (arg1-type arg2-type ...)
1054     ...function body...)
1055
1056 argX-type can take one of the forms @code{predicate?} for mandatory
1057 arguments satisfying the predicate, @code{(predicate?)} for optional
1058 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1059 value)}} for optional parameters with a specified default
1060 value (evaluated at definition time).  An optional parameter can be
1061 omitted in a call only when it can't get confused with a following
1062 parameter of different type.
1063
1064 @code{result-type?} can specify a default in the same manner as
1065 predicates, to be used in case of a type error in arguments or
1066 result."
1067
1068   (define (has-parser/location? arg where)
1069     (let loop ((arg arg))
1070       (if (list? arg)
1071           (any loop arg)
1072           (memq arg where))))
1073   (define (currying-lambda args doc-string? body)
1074     (if (and (pair? args)
1075              (pair? (car args)))
1076         (currying-lambda (car args) doc-string?
1077                          `((lambda ,(cdr args) ,@body)))
1078         (let* ((compatibility? (if (list? args)
1079                                    (= (length args) (+ 2 (length signature)))
1080                                    (and (pair? args) (pair? (cdr args))
1081                                         (eq? (car args) 'parser))))
1082                (realargs (if compatibility? (cddr args) args)))
1083           `(lambda ,realargs
1084              ,(format #f "~a\n~a" realargs (or doc-string? ""))
1085              ,@(if (and compatibility?
1086                         (has-parser/location? body (take args 2)))
1087                    `((let ((,(car args) (*parser*)) (,(cadr args) (*location*)))
1088                        ,@body))
1089                    body)))))
1090
1091   (let ((docstring
1092          (and (pair? body) (pair? (cdr body))
1093               (if (string? (car body))
1094                   (car body)
1095                   (and (pair? (car body))
1096                        (eq? '_i (caar body))
1097                        (pair? (cdar body))
1098                        (string? (cadar body))
1099                        (null? (cddar body))
1100                        (cadar body))))))
1101     ;; When the music function definition contains an i10n doc string,
1102     ;; (_i "doc string"), keep the literal string only
1103     `(ly:make-music-function
1104       (list ,@(map (lambda (pred)
1105                      (if (pair? pred)
1106                          `(cons ,(car pred)
1107                                 ,(and (pair? (cdr pred)) (cadr pred)))
1108                          pred))
1109                    (cons type signature)))
1110       ,(currying-lambda args docstring (if docstring (cdr body) body)))))
1111
1112 (defmacro-public define-music-function rest
1113   "Defining macro returning music functions.
1114 Syntax:
1115   (define-music-function (arg1 arg2 ...) (arg1-type? arg2-type? ...)
1116     ...function body...)
1117
1118 argX-type can take one of the forms @code{predicate?} for mandatory
1119 arguments satisfying the predicate, @code{(predicate?)} for optional
1120 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1121 value)}} for optional parameters with a specified default
1122 value (evaluated at definition time).  An optional parameter can be
1123 omitted in a call only when it can't get confused with a following
1124 parameter of different type.
1125
1126 Must return a music expression.  The @code{origin} is automatically
1127 set to the @code{location} parameter."
1128
1129   `(define-syntax-function (ly:music? (make-music 'Music 'void #t)) ,@rest))
1130
1131
1132 (defmacro-public define-scheme-function rest
1133   "Defining macro returning Scheme functions.
1134 Syntax:
1135   (define-scheme-function (arg1 arg2 ...) (arg1-type? arg2-type? ...)
1136     ...function body...)
1137
1138 argX-type can take one of the forms @code{predicate?} for mandatory
1139 arguments satisfying the predicate, @code{(predicate?)} for optional
1140 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1141 value)}} for optional parameters with a specified default
1142 value (evaluated at definition time).  An optional parameter can be
1143 omitted in a call only when it can't get confused with a following
1144 parameter of different type.
1145
1146 Can return arbitrary expressions.  If a music expression is returned,
1147 its @code{origin} is automatically set to the @code{location}
1148 parameter."
1149
1150   `(define-syntax-function scheme? ,@rest))
1151
1152 (defmacro-public define-void-function rest
1153   "This defines a Scheme function like @code{define-scheme-function} with
1154 void return value (i.e., what most Guile functions with `unspecified'
1155 value return).  Use this when defining functions for executing actions
1156 rather than returning values, to keep Lilypond from trying to interpret
1157 the return value."
1158   `(define-syntax-function (void? *unspecified*) ,@rest *unspecified*))
1159
1160 (defmacro-public define-event-function rest
1161   "Defining macro returning event functions.
1162 Syntax:
1163   (define-event-function (arg1 arg2 ...) (arg1-type? arg2-type? ...)
1164     ...function body...)
1165
1166 argX-type can take one of the forms @code{predicate?} for mandatory
1167 arguments satisfying the predicate, @code{(predicate?)} for optional
1168 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1169 value)}} for optional parameters with a specified default
1170 value (evaluated at definition time).  An optional parameter can be
1171 omitted in a call only when it can't get confused with a following
1172 parameter of different type.
1173
1174 Must return an event expression.  The @code{origin} is automatically
1175 set to the @code{location} parameter."
1176
1177   `(define-syntax-function (ly:event? (make-music 'Event 'void #t)) ,@rest))
1178
1179 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1180
1181 (define-public (cue-substitute quote-music)
1182   "Must happen after @code{quote-substitute}."
1183
1184   (if (vector? (ly:music-property quote-music 'quoted-events))
1185       (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
1186              (clef (ly:music-property quote-music 'quoted-music-clef #f))
1187              (main-voice (case dir ((1) 1) ((-1) 0) (else #f)))
1188              (cue-voice (and main-voice (- 1 main-voice)))
1189              (cue-type (ly:music-property quote-music 'quoted-context-type #f))
1190              (cue-id (ly:music-property quote-music 'quoted-context-id))
1191              (main-music (ly:music-property quote-music 'element))
1192              (return-value quote-music))
1193
1194         (if main-voice
1195             (set! (ly:music-property quote-music 'element)
1196                   (make-sequential-music
1197                    (list
1198                     (make-voice-props-override main-voice)
1199                     main-music
1200                     (make-voice-props-revert)))))
1201
1202         ;; if we have stem dirs, change both quoted and main music
1203         ;; to have opposite stems.
1204
1205         ;; cannot context-spec Quote-music, since context
1206         ;; for the quotes is determined in the iterator.
1207
1208         (make-sequential-music
1209          (delq! #f
1210                 (list
1211                  (and clef (make-cue-clef-set clef))
1212                  (and cue-type cue-voice
1213                       (context-spec-music
1214                        (make-voice-props-override cue-voice)
1215                        cue-type cue-id))
1216                  quote-music
1217                  (and cue-type cue-voice
1218                       (context-spec-music
1219                        (make-voice-props-revert)
1220                        cue-type cue-id))
1221                  (and clef (make-cue-clef-unset))))))
1222       quote-music))
1223
1224 (define ((quote-substitute quote-tab) music)
1225   (let* ((quoted-name (ly:music-property music 'quoted-music-name))
1226          (quoted-vector (and (string? quoted-name)
1227                              (hash-ref quote-tab quoted-name #f))))
1228
1229
1230     (if (string? quoted-name)
1231         (if (vector? quoted-vector)
1232             (begin
1233               (set! (ly:music-property music 'quoted-events) quoted-vector)
1234               (set! (ly:music-property music 'iterator-ctor)
1235                     ly:quote-iterator::constructor))
1236             (ly:music-warning music (ly:format (_ "cannot find quoted music: `~S'") quoted-name))))
1237     music))
1238 (export quote-substitute)
1239
1240
1241 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1242 ;; switch it on here, so parsing and init isn't checked (too slow!)
1243 ;;
1244 ;; automatic music transformations.
1245
1246 (define (switch-on-debugging m)
1247   (if (defined? 'set-debug-cell-accesses!)
1248       (set-debug-cell-accesses! 15000))
1249   m)
1250
1251 (define (music-check-error music)
1252   (define found #f)
1253   (define (signal m)
1254     (if (and (ly:music? m)
1255              (eq? (ly:music-property m 'error-found) #t))
1256         (set! found #t)))
1257
1258   (for-each signal (ly:music-property music 'elements))
1259   (signal (ly:music-property music 'element))
1260
1261   (if found
1262       (set! (ly:music-property music 'error-found) #t))
1263   music)
1264
1265 (define (precompute-music-length music)
1266   (set! (ly:music-property music 'length)
1267         (ly:music-length music))
1268   music)
1269
1270 (define-public (make-duration-of-length moment)
1271   "Make duration of the given @code{moment} length."
1272   (ly:make-duration 0 0
1273                     (ly:moment-main-numerator moment)
1274                     (ly:moment-main-denominator moment)))
1275
1276 (define (make-skipped moment bool)
1277   "Depending on BOOL, set or unset skipTypesetting,
1278 then make SkipMusic of the given MOMENT length, and
1279 then revert skipTypesetting."
1280   (make-sequential-music
1281    (list
1282     (context-spec-music (make-property-set 'skipTypesetting bool)
1283                         'Score)
1284     (make-music 'SkipMusic 'duration
1285                 (make-duration-of-length moment))
1286     (context-spec-music (make-property-set 'skipTypesetting (not bool))
1287                         'Score))))
1288
1289 (define (skip-as-needed music)
1290   "Replace MUSIC by
1291  << {  \\set skipTypesetting = ##f
1292  LENGTHOF(\\showFirstLength)
1293  \\set skipTypesetting = ##t
1294  LENGTHOF(\\showLastLength) }
1295  MUSIC >>
1296  if appropriate.
1297
1298  When only showFirstLength is set,
1299  the 'length property of the music is
1300  overridden to speed up compiling."
1301   (let*
1302       ((show-last (ly:parser-lookup 'showLastLength))
1303        (show-first (ly:parser-lookup 'showFirstLength))
1304        (show-last-length (and (ly:music? show-last)
1305                               (ly:music-length show-last)))
1306        (show-first-length (and (ly:music? show-first)
1307                                (ly:music-length show-first)))
1308        (orig-length (ly:music-length music)))
1309
1310     ;;FIXME: if using either showFirst- or showLastLength,
1311     ;; make sure that skipBars is not set.
1312
1313     (cond
1314
1315      ;; both properties may be set.
1316      ((and show-first-length show-last-length)
1317       (let
1318           ((skip-length (ly:moment-sub orig-length show-last-length)))
1319         (make-simultaneous-music
1320          (list
1321           (make-sequential-music
1322            (list
1323             (make-skipped skip-length #t)
1324             ;; let's draw a separator between the beginning and the end
1325             (context-spec-music (make-property-set 'whichBar "||")
1326                                 'Timing)))
1327           (make-skipped show-first-length #f)
1328           music))))
1329
1330      ;; we may only want to print the last length
1331      (show-last-length
1332       (let
1333           ((skip-length (ly:moment-sub orig-length show-last-length)))
1334         (make-simultaneous-music
1335          (list
1336           (make-skipped skip-length #t)
1337           music))))
1338
1339      ;; we may only want to print the beginning; in this case
1340      ;; only the first length will be processed (much faster).
1341      (show-first-length
1342       ;; the first length must not exceed the original length.
1343       (if (ly:moment<? show-first-length orig-length)
1344           (set! (ly:music-property music 'length)
1345                 show-first-length))
1346       music)
1347
1348      (else music))))
1349
1350
1351 (define-session-public toplevel-music-functions
1352   (list
1353    (lambda (music) (expand-repeat-chords!
1354                     (cons 'rhythmic-event
1355                           (ly:parser-lookup '$chord-repeat-events))
1356                     music))
1357    expand-repeat-notes!
1358    voicify-music
1359    (lambda (x) (music-map music-check-error x))
1360    (lambda (x) (music-map precompute-music-length x))
1361    (lambda (music)
1362      (music-map (quote-substitute (ly:parser-lookup 'musicQuotes))  music))
1363
1364    ;; switch-on-debugging
1365    (lambda (x) (music-map cue-substitute x))
1366
1367    skip-as-needed))
1368
1369 ;;;;;;;;;;
1370 ;;; general purpose music functions
1371
1372 (define (shift-octave pitch octave-shift)
1373   (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
1374   (ly:make-pitch
1375    (+ (ly:pitch-octave pitch) octave-shift)
1376    (ly:pitch-notename pitch)
1377    (ly:pitch-alteration pitch)))
1378
1379
1380 ;;;;;;;;;;;;;;;;;
1381 ;; lyrics
1382
1383 (define (apply-durations lyric-music durations)
1384   (define (apply-duration music)
1385     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
1386              (ly:duration?  (ly:music-property music 'duration)))
1387         (begin
1388           (set! (ly:music-property music 'duration) (car durations))
1389           (set! durations (cdr durations)))))
1390
1391   (music-map apply-duration lyric-music))
1392
1393
1394 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1395 ;; accidentals
1396
1397 (define (recent-enough? bar-number alteration-def laziness)
1398   (or (number? alteration-def)
1399       (equal? laziness #t)
1400       (<= bar-number (+ (cadr alteration-def) laziness))))
1401
1402 (define (accidental-invalid? alteration-def)
1403   "Checks an alteration entry for being invalid.
1404
1405 Non-key alterations are invalidated when tying into the next bar or
1406 when there is a clef change, since neither repetition nor cancellation
1407 can be omitted when the same note occurs again.
1408
1409 Returns @code{#f} or the reason for the invalidation, a symbol."
1410   (let* ((def (if (pair? alteration-def)
1411                   (car alteration-def)
1412                   alteration-def)))
1413     (and (symbol? def) def)))
1414
1415 (define (extract-alteration alteration-def)
1416   (cond ((number? alteration-def)
1417          alteration-def)
1418         ((pair? alteration-def)
1419          (car alteration-def))
1420         (else 0)))
1421
1422 (define (check-pitch-against-signature context pitch barnum laziness octaveness all-naturals)
1423   "Checks the need for an accidental and a @q{restore} accidental against
1424 @code{localAlterations} and @code{keyAlterations}.
1425 The @var{laziness} is the number of measures
1426 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1427 only cancel accidentals in the same measure; if @var{laziness} is three,
1428 we cancel accidentals up to three measures after they first appear.
1429 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1430 specifies whether accidentals should be canceled in different octaves.
1431 If @var{all-naturals} is ##t, notes that do not occur in @code{keyAlterations}
1432 also get an accidental."
1433   (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1434                               ((equal? octaveness 'same-octave) #f)
1435                               (else
1436                                (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1437                                (ly:warning (_ "Defaulting to 'any-octave."))
1438                                #t)))
1439          (key (ly:context-property context 'keyAlterations))
1440          (local (ly:context-property context 'localAlterations))
1441          (notename (ly:pitch-notename pitch))
1442          (octave (ly:pitch-octave pitch))
1443          (pitch-handle (cons octave notename))
1444          (need-restore #f)
1445          (need-accidental #f)
1446          (previous-alteration #f)
1447          (from-other-octaves #f)
1448          (from-same-octave (assoc-get pitch-handle local))
1449          (from-key-sig (or (assoc-get notename local)
1450
1451                            ;; If no notename match is found from localAlterations, we may have a custom
1452                            ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1453                            ;; instead of (pitch . alteration).  Since this type cannot coexist with entries in
1454                            ;; localAlterations, try extracting from keyAlterations instead.
1455                            (assoc-get pitch-handle key))))
1456
1457     ;; loop through localAlterations to search for a notename match from other octaves
1458     (let loop ((l local))
1459       (if (pair? l)
1460           (let ((entry (car l)))
1461             (if (and (pair? (car entry))
1462                      (= (cdar entry) notename))
1463                 (set! from-other-octaves (cdr entry))
1464                 (loop (cdr l))))))
1465
1466     ;; find previous alteration-def for comparison with pitch
1467     (cond
1468      ;; from same octave?
1469      ((and (not ignore-octave)
1470            from-same-octave
1471            (recent-enough? barnum from-same-octave laziness))
1472       (set! previous-alteration from-same-octave))
1473
1474      ;; from any octave?
1475      ((and ignore-octave
1476            from-other-octaves
1477            (recent-enough? barnum from-other-octaves laziness))
1478       (set! previous-alteration from-other-octaves))
1479
1480      ;; not recent enough, extract from key signature/local key signature
1481      (from-key-sig
1482       (set! previous-alteration from-key-sig)))
1483
1484     (if (accidental-invalid? previous-alteration)
1485         (set! need-accidental #t)
1486
1487         (let* ((prev-alt (extract-alteration previous-alteration))
1488                (this-alt (ly:pitch-alteration pitch)))
1489
1490           (if (or (and all-naturals (eq? #f previous-alteration)) (not (= this-alt prev-alt)))
1491               (begin
1492                 (set! need-accidental #t)
1493                 (if (and (not (= this-alt 0))
1494                          (and (< (abs this-alt) (abs prev-alt))
1495                               (> (* prev-alt this-alt) 0)))
1496                     (set! need-restore #t))))))
1497
1498     (cons need-restore need-accidental)))
1499
1500 (define ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1501   "Create an accidental rule that makes its decision based on the octave of
1502 the note and a laziness value.
1503
1504 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1505 defines whether the rule should respond to accidental changes in other
1506 octaves than the current.  @code{'same-octave} is the normal way to typeset
1507 accidentals -- an accidental is made if the alteration is different from the
1508 last active pitch in the same octave.  @code{'any-octave} looks at the last
1509 active pitch in any octave.
1510
1511 @var{laziness} states over how many bars an accidental should be remembered.
1512 @code{0}@tie{}is the default -- accidental lasts over 0@tie{}bar lines, that
1513 is, to the end of current measure.  A positive integer means that the
1514 accidental lasts over that many bar lines.  @w{@code{-1}} is `forget
1515 immediately', that is, only look at key signature.  @code{#t} is `forever'."
1516
1517   (check-pitch-against-signature context pitch barnum laziness octaveness #f))
1518 (export make-accidental-rule)
1519
1520 (define ((make-accidental-dodecaphonic-rule octaveness laziness) context pitch barnum measurepos)
1521   "Variation on function make-accidental-rule that creates an dodecaphonic
1522 accidental rule."
1523
1524   (check-pitch-against-signature context pitch barnum laziness octaveness #t))
1525 (export make-accidental-dodecaphonic-rule)
1526
1527 (define (key-entry-notename entry)
1528   "Return the pitch of an @var{entry} in @code{localAlterations}.
1529 The @samp{car} of the entry is either of the form @code{notename} or
1530 of the form @code{(octave . notename)}.  The latter form is used for special
1531 key signatures or to indicate an explicit accidental.
1532
1533 The @samp{cdr} of the entry is either a rational @code{alter} indicating
1534 a key signature alteration, or of the form
1535 @code{(alter . (barnum . measurepos))} indicating an alteration caused by
1536 an accidental in music."
1537   (if (pair? (car entry))
1538       (cdar entry)
1539       (car entry)))
1540
1541 (define (key-entry-octave entry)
1542   "Return the octave of an entry in @code{localAlterations}
1543 or @code{#f} if the entry does not have an octave.
1544 See @code{key-entry-notename} for details."
1545   (and (pair? (car entry)) (caar entry)))
1546
1547 (define (key-entry-bar-number entry)
1548   "Return the bar number of an entry in @code{localAlterations}
1549 or @code {#f} if the entry does not have a bar number.
1550 See @code{key-entry-notename} for details."
1551   (and (pair? (cdr entry)) (caddr entry)))
1552
1553 (define (key-entry-measure-position entry)
1554   "Return the measure position of an entry in @code{localAlterations}
1555 or @code {#f} if the entry does not have a measure position.
1556 See @code{key-entry-notename} for details."
1557   (and (pair? (cdr entry)) (cdddr entry)))
1558
1559 (define (key-entry-alteration entry)
1560   "Return the alteration of an entry in localAlterations
1561
1562 For convenience, returns @code{0} if entry is @code{#f}."
1563   (if entry
1564       (if (number? (cdr entry))
1565           (cdr entry)
1566           (cadr entry))
1567       0))
1568
1569 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1570   "Return the first entry in @var{keysig} that matches @var{pitch}
1571 by notename and octave.  Alteration is not considered.
1572 @var{accept-global} states whether key signature entries should be included.
1573 @var{accept-local} states whether local accidentals should be included.
1574 If no matching entry is found, @var{#f} is returned."
1575   (and (pair? keysig)
1576        (let* ((entry (car keysig))
1577               (entryoct (key-entry-octave entry))
1578               (entrynn (key-entry-notename entry))
1579               (nn (ly:pitch-notename pitch)))
1580          (if (and (equal? nn entrynn)
1581                   (or (not entryoct)
1582                       (= entryoct (ly:pitch-octave pitch)))
1583                   (if (key-entry-bar-number entry)
1584                       accept-local
1585                       accept-global))
1586              entry
1587              (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))))
1588
1589 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1590   "An accidental rule that typesets an accidental if it differs from the
1591 key signature @emph{and} does not directly follow a note on the same
1592 staff line.  This rule should not be used alone because it does neither
1593 look at bar lines nor different accidentals at the same note name."
1594   (let* ((keysig (ly:context-property context 'localAlterations))
1595          (entry (find-pitch-entry keysig pitch #t #t)))
1596     (if (not entry)
1597         (cons #f #f)
1598         (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1599                (key-acc (key-entry-alteration global-entry))
1600                (acc (ly:pitch-alteration pitch))
1601                (entrymp (key-entry-measure-position entry))
1602                (entrybn (key-entry-bar-number entry)))
1603           (cons #f (not (or (equal? acc key-acc)
1604                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1605
1606 (define-public (dodecaphonic-no-repeat-rule context pitch barnum measurepos)
1607   "An accidental rule that typesets an accidental before every
1608 note (just as in the dodecaphonic accidental style) @emph{except} if
1609 the note is immediately preceded by a note with the same pitch. This
1610 is a common accidental style in contemporary notation."
1611    (let* ((keysig (ly:context-property context 'localAlterations))
1612           (entry (find-pitch-entry keysig pitch #f #t)))
1613      (if (not entry)
1614          (cons #f #t)
1615          (let ((entrymp (key-entry-measure-position entry))
1616                (entrybn (key-entry-bar-number entry))
1617                (entryalt (key-entry-alteration entry))
1618                (alt (ly:pitch-alteration pitch)))
1619            (cons #t
1620                  (not (and (equal? entrybn barnum)
1621                            (or (equal? measurepos entrymp)
1622                                (ly:moment<? measurepos entrymp))
1623                            (equal? entryalt alt))))))))
1624
1625 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1626   "An accidental rule that typesets a cautionary accidental if it is
1627 included in the key signature @emph{and} does not directly follow a note
1628 on the same staff line."
1629   (let* ((keysig (ly:context-property context 'localAlterations))
1630          (entry (find-pitch-entry keysig pitch #t #t)))
1631     (if (not entry)
1632         (cons #f #f)
1633         (let* ((global-entry (find-pitch-entry keysig pitch #f #f))
1634                (key-acc (key-entry-alteration global-entry))
1635                (acc (ly:pitch-alteration pitch))
1636                (entrymp (key-entry-measure-position entry))
1637                (entrybn (key-entry-bar-number entry)))
1638           (cons #f (not (or (equal? acc key-acc)
1639                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1640
1641 (define-public (set-accidentals-properties extra-natural
1642                                            auto-accs auto-cauts
1643                                            context)
1644   (context-spec-music
1645    (make-sequential-music
1646     (append (if (boolean? extra-natural)
1647                 (list (make-property-set 'extraNatural extra-natural))
1648                 '())
1649             (list (make-property-set 'autoAccidentals auto-accs)
1650                   (make-property-set 'autoCautionaries auto-cauts))))
1651    context))
1652
1653 (define-public (set-accidental-style style . rest)
1654   "Set accidental style to @var{style}.  Optionally take a context
1655 argument, e.g. @code{'Staff} or @code{'Voice}.  The context defaults
1656 to @code{Staff}, except for piano styles, which use @code{GrandStaff}
1657 as a context."
1658   (let ((context (if (pair? rest)
1659                      (car rest) 'Staff))
1660         (pcontext (if (pair? rest)
1661                       (car rest) 'GrandStaff)))
1662     (cond
1663      ;; accidentals as they were common in the 18th century.
1664      ((equal? style 'default)
1665       (set-accidentals-properties #t
1666                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1667                                   '()
1668                                   context))
1669      ;; accidentals from one voice do NOT get canceled in other voices
1670      ((equal? style 'voice)
1671       (set-accidentals-properties #t
1672                                   `(Voice ,(make-accidental-rule 'same-octave 0))
1673                                   '()
1674                                   context))
1675      ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1676      ;; This includes all the default accidentals, but accidentals also needs canceling
1677      ;; in other octaves and in the next measure.
1678      ((equal? style 'modern)
1679       (set-accidentals-properties #f
1680                                   `(Staff ,(make-accidental-rule 'same-octave 0)
1681                                           ,(make-accidental-rule 'any-octave 0)
1682                                           ,(make-accidental-rule 'same-octave 1))
1683                                   '()
1684                                   context))
1685      ;; the accidentals that Stone adds to the old standard as cautionaries
1686      ((equal? style 'modern-cautionary)
1687       (set-accidentals-properties #f
1688                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1689                                   `(Staff ,(make-accidental-rule 'any-octave 0)
1690                                           ,(make-accidental-rule 'same-octave 1))
1691                                   context))
1692      ;; same as modern, but accidentals different from the key signature are always
1693      ;; typeset - unless they directly follow a note of the same pitch.
1694      ((equal? style 'neo-modern)
1695       (set-accidentals-properties #f
1696                                   `(Staff ,(make-accidental-rule 'same-octave 0)
1697                                           ,(make-accidental-rule 'any-octave 0)
1698                                           ,(make-accidental-rule 'same-octave 1)
1699                                           ,neo-modern-accidental-rule)
1700                                   '()
1701                                   context))
1702      ((equal? style 'neo-modern-cautionary)
1703       (set-accidentals-properties #f
1704                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1705                                   `(Staff ,(make-accidental-rule 'any-octave 0)
1706                                           ,(make-accidental-rule 'same-octave 1)
1707                                           ,neo-modern-accidental-rule)
1708                                   context))
1709      ((equal? style 'neo-modern-voice)
1710       (set-accidentals-properties #f
1711                                   `(Voice ,(make-accidental-rule 'same-octave 0)
1712                                           ,(make-accidental-rule 'any-octave 0)
1713                                           ,(make-accidental-rule 'same-octave 1)
1714                                           ,neo-modern-accidental-rule
1715                                           Staff ,(make-accidental-rule 'same-octave 0)
1716                                           ,(make-accidental-rule 'any-octave 0)
1717                                           ,(make-accidental-rule 'same-octave 1)
1718                                           ,neo-modern-accidental-rule)
1719                                   '()
1720                                   context))
1721      ((equal? style 'neo-modern-voice-cautionary)
1722       (set-accidentals-properties #f
1723                                   `(Voice ,(make-accidental-rule 'same-octave 0))
1724                                   `(Voice ,(make-accidental-rule 'any-octave 0)
1725                                           ,(make-accidental-rule 'same-octave 1)
1726                                           ,neo-modern-accidental-rule
1727                                           Staff ,(make-accidental-rule 'same-octave 0)
1728                                           ,(make-accidental-rule 'any-octave 0)
1729                                           ,(make-accidental-rule 'same-octave 1)
1730                                           ,neo-modern-accidental-rule)
1731                                   context))
1732      ;; Accidentals as they were common in dodecaphonic music with no tonality.
1733      ;; Each note gets one accidental.
1734      ((equal? style 'dodecaphonic)
1735       (set-accidentals-properties #f
1736                                   `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1737                                   '()
1738                                   context))
1739      ;; As in dodecaphonic style with the exception that immediately
1740      ;; repeated notes (in the same voice) don't get an accidental
1741      ((equal? style 'dodecaphonic-no-repeat)
1742       (set-accidentals-properties #f
1743                                   `(Staff ,dodecaphonic-no-repeat-rule)
1744                                   '()
1745                                   context))
1746      ;; Variety of the dodecaphonic style. Each note gets an accidental,
1747      ;; except notes that were already handled in the same measure.
1748      ((equal? style 'dodecaphonic-first)
1749       (set-accidentals-properties #f
1750                                   `(Staff ,(make-accidental-dodecaphonic-rule 'same-octave 0))
1751                                   '()
1752                                   context))
1753
1754      ;; Multivoice accidentals to be read both by musicians playing one voice
1755      ;; and musicians playing all voices.
1756      ;; Accidentals are typeset for each voice, but they ARE canceled across voices.
1757      ((equal? style 'modern-voice)
1758       (set-accidentals-properties  #f
1759                                    `(Voice ,(make-accidental-rule 'same-octave 0)
1760                                            ,(make-accidental-rule 'any-octave 0)
1761                                            ,(make-accidental-rule 'same-octave 1)
1762                                            Staff ,(make-accidental-rule 'same-octave 0)
1763                                            ,(make-accidental-rule 'any-octave 0)
1764                                            ,(make-accidental-rule 'same-octave 1))
1765                                    '()
1766                                    context))
1767      ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1768      ;; as cautionaries
1769      ((equal? style 'modern-voice-cautionary)
1770       (set-accidentals-properties #f
1771                                   `(Voice ,(make-accidental-rule 'same-octave 0))
1772                                   `(Voice ,(make-accidental-rule 'any-octave 0)
1773                                           ,(make-accidental-rule 'same-octave 1)
1774                                           Staff ,(make-accidental-rule 'same-octave 0)
1775                                           ,(make-accidental-rule 'any-octave 0)
1776                                           ,(make-accidental-rule 'same-octave 1))
1777                                   context))
1778      ;; stone's suggestions for accidentals on grand staff.
1779      ;; Accidentals are canceled across the staves in the same grand staff as well
1780      ((equal? style 'piano)
1781       (set-accidentals-properties #f
1782                                   `(Staff ,(make-accidental-rule 'same-octave 0)
1783                                           ,(make-accidental-rule 'any-octave 0)
1784                                           ,(make-accidental-rule 'same-octave 1)
1785                                           GrandStaff
1786                                           ,(make-accidental-rule 'any-octave 0)
1787                                           ,(make-accidental-rule 'same-octave 1))
1788                                   '()
1789                                   pcontext))
1790      ((equal? style 'piano-cautionary)
1791       (set-accidentals-properties #f
1792                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1793                                   `(Staff ,(make-accidental-rule 'any-octave 0)
1794                                           ,(make-accidental-rule 'same-octave 1)
1795                                           GrandStaff
1796                                           ,(make-accidental-rule 'any-octave 0)
1797                                           ,(make-accidental-rule 'same-octave 1))
1798                                   pcontext))
1799
1800      ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1801      ;; tones specified by the key signature.
1802      ((equal? style 'teaching)
1803       (set-accidentals-properties #f
1804                                   `(Staff ,(make-accidental-rule 'same-octave 0))
1805                                   `(Staff ,(make-accidental-rule 'same-octave 1)
1806                                           ,teaching-accidental-rule)
1807                                   context))
1808
1809      ;; do not set localAlterations when a note alterated differently from
1810      ;; localAlterations is found.
1811      ;; Causes accidentals to be printed at every note instead of
1812      ;; remembered for the duration of a measure.
1813      ;; accidentals not being remembered, causing accidentals always to
1814      ;; be typeset relative to the time signature
1815      ((equal? style 'forget)
1816       (set-accidentals-properties '()
1817                                   `(Staff ,(make-accidental-rule 'same-octave -1))
1818                                   '()
1819                                   context))
1820      ;; Do not reset the key at the start of a measure.  Accidentals will be
1821      ;; printed only once and are in effect until overridden, possibly many
1822      ;; measures later.
1823      ((equal? style 'no-reset)
1824       (set-accidentals-properties '()
1825                                   `(Staff ,(make-accidental-rule 'same-octave #t))
1826                                   '()
1827                                   context))
1828      (else
1829       (ly:warning (_ "unknown accidental style: ~S") style)
1830       (make-sequential-music '())))))
1831
1832 (define-public (invalidate-alterations context)
1833   "Invalidate alterations in @var{context}.
1834
1835 Elements of @code{'localAlterations} corresponding to local
1836 alterations of the key signature have the form
1837 @code{'((octave . notename) . (alter barnum . measurepos))}.
1838 Replace them with a version where @code{alter} is set to @code{'clef}
1839 to force a repetition of accidentals.
1840
1841 Entries that conform with the current key signature are not invalidated."
1842   (let* ((keysig (ly:context-property context 'keyAlterations)))
1843     (set! (ly:context-property context 'localAlterations)
1844           (map-in-order
1845            (lambda (entry)
1846              (let* ((localalt (key-entry-alteration entry)))
1847                (if (or (accidental-invalid? localalt)
1848                        (not (key-entry-bar-number entry))
1849                        (= localalt
1850                           (key-entry-alteration
1851                            (find-pitch-entry
1852                             keysig
1853                             (ly:make-pitch (key-entry-octave entry)
1854                                            (key-entry-notename entry)
1855                                            0)
1856                             #t #t))))
1857                    entry
1858                    (cons (car entry) (cons 'clef (cddr entry))))))
1859            (ly:context-property context 'localAlterations)))))
1860
1861 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1862
1863 (define-public (skip-of-length mus)
1864   "Create a skip of exactly the same length as @var{mus}."
1865   (let* ((skip
1866           (make-music
1867            'SkipEvent
1868            'duration (ly:make-duration 0 0))))
1869
1870     (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1871
1872 (define-public (mmrest-of-length mus)
1873   "Create a multi-measure rest of exactly the same length as @var{mus}."
1874
1875   (let* ((skip
1876           (make-multi-measure-rest
1877            (ly:make-duration 0 0) '())))
1878     (ly:music-compress skip (ly:music-length mus))
1879     skip))
1880
1881 (define-public (pitch-of-note event-chord)
1882   (let ((evs (filter (lambda (x)
1883                        (music-has-type x 'note-event))
1884                      (ly:music-property event-chord 'elements))))
1885
1886     (and (pair? evs)
1887          (ly:music-property (car evs) 'pitch))))
1888
1889 (define-public (duration-of-note event-chord)
1890   (cond
1891    ((pair? event-chord)
1892     (or (duration-of-note (car event-chord))
1893         (duration-of-note (cdr event-chord))))
1894    ((ly:music? event-chord)
1895     (let ((dur (ly:music-property event-chord 'duration)))
1896       (if (ly:duration? dur)
1897           dur
1898           (duration-of-note (ly:music-property event-chord 'elements)))))
1899    (else #f)))
1900
1901 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1902
1903 (define-public (map-some-music map? music)
1904   "Walk through @var{music}, transform all elements calling @var{map?}
1905 and only recurse if this returns @code{#f}.  @code{elements} or
1906 @code{articulations} that are not music expressions are discarded:
1907 this allows some amount of filtering.
1908
1909 @code{map-some-music} may overwrite the original @var{music}."
1910   (let loop ((music music))
1911     (or (map? music)
1912         (let ((elt (ly:music-property music 'element))
1913               (elts (ly:music-property music 'elements))
1914               (arts (ly:music-property music 'articulations)))
1915           (if (ly:music? elt)
1916               (set! (ly:music-property music 'element)
1917                     (loop elt)))
1918           (if (pair? elts)
1919               (set! (ly:music-property music 'elements)
1920                     (filter! ly:music? (map! loop elts))))
1921           (if (pair? arts)
1922               (set! (ly:music-property music 'articulations)
1923                     (filter! ly:music? (map! loop arts))))
1924           music))))
1925
1926 (define-public (for-some-music stop? music)
1927   "Walk through @var{music}, process all elements calling @var{stop?}
1928 and only recurse if this returns @code{#f}."
1929   (let loop ((music music))
1930     (if (not (stop? music))
1931         (let ((elt (ly:music-property music 'element)))
1932           (if (ly:music? elt)
1933               (loop elt))
1934           (for-each loop (ly:music-property music 'elements))
1935           (for-each loop (ly:music-property music 'articulations))))))
1936
1937 (define-public (fold-some-music pred? proc init music)
1938   "This works recursively on music like @code{fold} does on a list,
1939 calling @samp{(@var{pred?} music)} on every music element.  If
1940 @code{#f} is returned for an element, it is processed recursively
1941 with the same initial value of @samp{previous}, otherwise
1942 @samp{(@var{proc} music previous)} replaces @samp{previous}
1943 and no recursion happens.
1944 The top @var{music} is processed using @var{init} for @samp{previous}."
1945   (let loop ((music music) (previous init))
1946     (if (pred? music)
1947         (proc music previous)
1948         (fold loop
1949               (fold loop
1950                     (let ((elt (ly:music-property music 'element)))
1951                       (if (null? elt)
1952                           previous
1953                           (loop elt previous)))
1954                     (ly:music-property music 'elements))
1955               (ly:music-property music 'articulations)))))
1956
1957 (define-public (extract-music music pred?)
1958   "Return a flat list of all music matching @var{pred?} inside of
1959 @var{music}, not recursing into matches themselves."
1960   (reverse! (fold-some-music pred? cons '() music)))
1961
1962 (define-public (extract-named-music music music-name)
1963   "Return a flat list of all music named @var{music-name} (either a
1964 single event symbol or a list of alternatives) inside of @var{music},
1965 not recursing into matches themselves."
1966   (extract-music
1967    music
1968    (if (cheap-list? music-name)
1969        (lambda (m) (memq (ly:music-property m 'name) music-name))
1970        (lambda (m) (eq? (ly:music-property m 'name) music-name)))))
1971
1972 (define-public (extract-typed-music music type)
1973   "Return a flat list of all music with @var{type} (either a single
1974 type symbol or a list of alternatives) inside of @var{music}, not
1975 recursing into matches themselves."
1976   (extract-music
1977    music
1978    (if (cheap-list? type)
1979        (lambda (m)
1980          (any (lambda (t) (music-is-of-type? m t)) type))
1981        (lambda (m) (music-is-of-type? m type)))))
1982
1983 (define*-public (event-chord-wrap! music)
1984   "Wrap isolated rhythmic events and non-postevent events in
1985 @var{music} inside of an @code{EventChord}.  Chord repeats @samp{q}
1986 are expanded using the default settings of the parser."
1987   (map-some-music
1988    (lambda (m)
1989      (cond ((music-is-of-type? m 'event-chord)
1990             (if (pair? (ly:music-property m 'articulations))
1991                 (begin
1992                   (set! (ly:music-property m 'elements)
1993                         (append (ly:music-property m 'elements)
1994                                 (ly:music-property m 'articulations)))
1995                   (set! (ly:music-property m 'articulations) '())))
1996             m)
1997            ((music-is-of-type? m 'rhythmic-event)
1998             (let ((arts (ly:music-property m 'articulations)))
1999               (if (pair? arts)
2000                   (set! (ly:music-property m 'articulations) '()))
2001               (make-event-chord (cons m arts))))
2002            (else #f)))
2003    (expand-repeat-chords!
2004     (cons 'rhythmic-event
2005           (ly:parser-lookup '$chord-repeat-events))
2006     music)
2007    music))
2008
2009 (define-public (event-chord-notes event-chord)
2010   "Return a list of all notes from @var{event-chord}."
2011   (filter
2012    (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
2013    (ly:music-property event-chord 'elements)))
2014
2015 (define-public (event-chord-pitches event-chord)
2016   "Return a list of all pitches from @var{event-chord}."
2017   (map (lambda (x) (ly:music-property x 'pitch))
2018        (event-chord-notes event-chord)))
2019
2020 (define-public (event-chord-reduce music)
2021   "Reduces event chords in @var{music} to their first note event,
2022 retaining only the chord articulations.  Returns the modified music."
2023   (map-some-music
2024    (lambda (m)
2025      (and (music-is-of-type? m 'event-chord)
2026           (let*-values (((notes arts) (partition
2027                                        (lambda (mus)
2028                                          (music-is-of-type? mus 'rhythmic-event))
2029                                        (ly:music-property m 'elements)))
2030                         ((dur) (ly:music-property m 'duration))
2031                         ((full-arts) (append arts
2032                                              (ly:music-property m 'articulations)))
2033                         ((first-note) (and (pair? notes) (car notes))))
2034             (cond (first-note
2035                    (set! (ly:music-property first-note 'articulations)
2036                          full-arts)
2037                    first-note)
2038                   ((ly:duration? dur)
2039                    ;; A repeat chord. Produce an unpitched note.
2040                    (make-music 'NoteEvent
2041                                'duration dur
2042                                'articulations full-arts))
2043                   (else
2044                    (ly:music-error m (_ "Missing duration"))
2045                    (make-music 'NoteEvent
2046                                'duration (ly:make-duration 2 0 0)
2047                                'articulations full-arts))))))
2048    music))
2049
2050
2051 (defmacro-public make-relative (variables reference music)
2052   "The list of pitch or music variables in @var{variables} is used as
2053 a sequence for creating relativable music from @var{music}.
2054
2055 When the constructed music is used outside of @code{\\relative}, it
2056 just reflects plugging in the @var{variables} into @var{music}.
2057
2058 The action inside of @code{\\relative}, however, is determined by
2059 first relativizing the surrogate @var{reference} with the variables
2060 plugged in and then using the variables relativized as a side effect
2061 of relativizing @var{reference} for evaluating @var{music}.
2062
2063 Since pitches don't have the object identity required for tracing the
2064 effect of the reference call, they are replaced @emph{only} for the
2065 purpose of evaluating @var{reference} with simple pitched note events.
2066
2067 The surrogate @var{reference} expression has to be written with that
2068 in mind.  In addition, it must @emph{not} contain @emph{copies} of
2069 music that is supposed to be relativized but rather the
2070 @emph{originals}.  This @emph{includes} the pitch expressions.  As a
2071 rule, inside of @code{#@{@dots{}#@}} variables must @emph{only} be
2072 introduced using @code{#}, never via the copying construct @code{$}.
2073 The reference expression will usually just be a sequential or chord
2074 expression naming all variables in sequence, implying that following
2075 music will be relativized according to the resulting pitch of the last
2076 or first variable, respectively.
2077
2078 Since the usual purpose is to create more complex music from general
2079 arguments and since music expression parts must not occur more than
2080 once, one @emph{does} generally need to use copying operators in the
2081 @emph{replacement} expression @var{music} when using an argument more
2082 than once there.  Using an argument more than once in @var{reference},
2083 in contrast, does not make sense.
2084
2085 There is another fine point to mind: @var{music} must @emph{only}
2086 contain freshly constructed elements or copied constructs.  This will
2087 be the case anyway for regular LilyPond code inside of
2088 @code{#@{@dots{}#@}}, but any other elements (apart from the
2089 @var{variables} themselves which are already copied) must be created
2090 or copied as well.
2091
2092 The reason is that it is usually permitted to change music in-place as
2093 long as one does a @var{ly:music-deep-copy} on it, and such a copy of
2094 the whole resulting expression will @emph{not} be able to copy
2095 variables/values inside of closures where the information for
2096 relativization is being stored.
2097 "
2098
2099   ;; pitch and music generator might be stored instead in music
2100   ;; properties, and it might make sense to create a music type of its
2101   ;; own for this kind of construct rather than using
2102   ;; RelativeOctaveMusic
2103   (define ((make-relative::to-relative-callback variables music-call ref-call)
2104            music pitch)
2105     (let* ((ref-vars (map (lambda (v)
2106                             (if (ly:pitch? v)
2107                                 (make-music 'NoteEvent 'pitch v)
2108                                 (ly:music-deep-copy v)))
2109                           variables))
2110            (after-pitch (ly:make-music-relative! (apply ref-call ref-vars) pitch))
2111            (actual-vars (map (lambda (v r)
2112                                (if (ly:pitch? v)
2113                                    (ly:music-property r 'pitch)
2114                                    r))
2115                              variables ref-vars))
2116            (rel-music (apply music-call actual-vars)))
2117       (set! (ly:music-property music 'element) rel-music)
2118       after-pitch))
2119   `(make-music 'RelativeOctaveMusic
2120                'to-relative-callback
2121                (,make-relative::to-relative-callback
2122                 (list ,@variables)
2123                 (lambda ,variables ,music)
2124                 (lambda ,variables ,reference))
2125                'element ,music))
2126
2127 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2128 ;; The following functions are all associated with the crossStaff
2129 ;;  function
2130
2131 (define (close-enough? x y)
2132   "Values are close enough to ignore the difference"
2133   (< (abs (- x y)) 0.0001))
2134
2135 (define (extent-combine extents)
2136   "Combine a list of extents"
2137   (if (pair? (cdr extents))
2138       (interval-union (car extents) (extent-combine (cdr extents)))
2139       (car extents)))
2140
2141 (define ((stem-connectable? ref root) stem)
2142   "Check if the stem is connectable to the root"
2143   ;; The root is always connectable to itself
2144   (or (eq? root stem)
2145       (and
2146        ;; Horizontal positions of the stems must be almost the same
2147        (close-enough? (car (ly:grob-extent root ref X))
2148                       (car (ly:grob-extent stem ref X)))
2149        ;; The stem must be in the direction away from the root's notehead
2150        (positive? (* (ly:grob-property root 'direction)
2151                      (- (car (ly:grob-extent stem ref Y))
2152                         (car (ly:grob-extent root ref Y))))))))
2153
2154 (define (stem-span-stencil span)
2155   "Connect stems if we have at least one stem connectable to the root"
2156   (let* ((system (ly:grob-system span))
2157          (root (ly:grob-parent span X))
2158          (stems (filter (stem-connectable? system root)
2159                         (ly:grob-object span 'stems))))
2160     (if (<= 2 (length stems))
2161         (let* ((yextents (map (lambda (st)
2162                                 (ly:grob-extent st system Y)) stems))
2163                (yextent (extent-combine yextents))
2164                (layout (ly:grob-layout root))
2165                (blot (ly:output-def-lookup layout 'blot-diameter)))
2166           ;; Hide spanned stems
2167           (for-each (lambda (st)
2168                       (set! (ly:grob-property st 'stencil) #f))
2169                     stems)
2170           ;; Draw a nice looking stem with rounded corners
2171           (ly:round-filled-box (ly:grob-extent root root X) yextent blot))
2172         ;; Nothing to connect, don't draw the span
2173         #f)))
2174
2175 (define ((make-stem-span! stems trans) root)
2176   "Create a stem span as a child of the cross-staff stem (the root)"
2177   (let ((span (ly:engraver-make-grob trans 'Stem '())))
2178     (ly:grob-set-parent! span X root)
2179     (set! (ly:grob-object span 'stems) stems)
2180     ;; Suppress positioning, the stem code is confused by this weird stem
2181     (set! (ly:grob-property span 'X-offset) 0)
2182     (set! (ly:grob-property span 'stencil) stem-span-stencil)))
2183
2184 (define-public (cross-staff-connect stem)
2185   "Set cross-staff property of the stem to this function to connect it to
2186 other stems automatically"
2187   #t)
2188
2189 (define (stem-is-root? stem)
2190   "Check if automatic connecting of the stem was requested.  Stems connected
2191 to cross-staff beams are cross-staff, but they should not be connected to
2192 other stems just because of that."
2193   (eq? cross-staff-connect (ly:grob-property-data stem 'cross-staff)))
2194
2195 (define (make-stem-spans! ctx stems trans)
2196   "Create stem spans for cross-staff stems"
2197   ;; Cannot do extensive checks here, just make sure there are at least
2198   ;; two stems at this musical moment
2199   (if (<= 2 (length stems))
2200       (let ((roots (filter stem-is-root? stems)))
2201         (for-each (make-stem-span! stems trans) roots))))
2202
2203 (define-public (Span_stem_engraver ctx)
2204   "Connect cross-staff stems to the stems above in the system"
2205   (let ((stems '()))
2206     (make-engraver
2207      ;; Record all stems for the given moment
2208      (acknowledgers
2209       ((stem-interface trans grob source)
2210        (set! stems (cons grob stems))))
2211      ;; Process stems and reset the stem list to empty
2212      ((process-acknowledged trans)
2213       (make-stem-spans! ctx stems trans)
2214       (set! stems '())))))
2215
2216 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2217 ;; The following is used by the alterBroken function.
2218
2219 (define ((value-for-spanner-piece arg) grob)
2220   "Associate a piece of broken spanner @var{grob} with an element
2221 of list @var{arg}."
2222   (let* ((orig (ly:grob-original grob))
2223          (siblings (ly:spanner-broken-into orig)))
2224
2225     (define (helper sibs arg)
2226       (if (null? arg)
2227           arg
2228           (if (eq? (car sibs) grob)
2229               (car arg)
2230               (helper (cdr sibs) (cdr arg)))))
2231
2232     (if (>= (length siblings) 2)
2233         (helper siblings arg)
2234         (car arg))))
2235 (export value-for-spanner-piece)
2236
2237 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2238 ;; The following are used by the \offset function
2239
2240 (define (find-value-to-offset prop self alist)
2241   "Return the first value of the property @var{prop} in the property
2242 alist @var{alist} -- after having found @var{self}.  If @var{self} is
2243 not found, return the first value of @var{prop}."
2244   (let ((segment (member (cons prop self) alist)))
2245     (if (not segment)
2246         (assoc-get prop alist)
2247         (assoc-get prop (cdr segment)))))
2248
2249 (define (offset-multiple-types arg offsets)
2250   "Displace @var{arg} by @var{offsets} if @var{arg} is a number, a
2251 number pair, or a list of number pairs.  If @var{offsets} is an empty
2252 list or if there is a type-mismatch, @var{arg} will be returned."
2253   (cond
2254     ((and (number? arg) (number? offsets))
2255      (+ arg offsets))
2256     ((and (number-pair? arg)
2257           (or (number? offsets)
2258               (number-pair? offsets)))
2259      (coord-translate arg offsets))
2260     ((and (number-pair-list? arg) (number-pair-list? offsets))
2261      (map
2262        (lambda (x y) (coord-translate x y))
2263        arg offsets))
2264     (else arg)))
2265
2266 (define-public (offsetter property offsets)
2267   "Apply @var{offsets} to the default values of @var{property} of @var{grob}.
2268 Offsets are restricted to immutable properties and values of type @code{number},
2269 @code{number-pair}, or @code{number-pair-list}."
2270   (define (self grob)
2271     (let* ((immutable (ly:grob-basic-properties grob))
2272            ; We need to search the basic-properties alist for our property to
2273            ; obtain values to offset.  Our search is complicated by the fact that
2274            ; calling the music function `offset' as an override conses a pair to
2275            ; the head of the alist.  This pair must be discounted.  The closure it
2276            ; contains is named `self' so it can be easily recognized.  If `offset'
2277            ; is called as a tweak, the basic-property alist is unaffected.
2278            (target (find-value-to-offset property self immutable))
2279            ; if target is a procedure, we need to apply it to our grob to calculate
2280            ; values to offset.
2281            (vals
2282              (if (procedure? target)
2283                  (target grob)
2284                  target))
2285            (can-type-be-offset?
2286              (or (number? vals)
2287                  (number-pair? vals)
2288                  (number-pair-list? vals))))
2289
2290       (if can-type-be-offset?
2291           ; '(+inf.0 . -inf.0) would offset to itself.  This will be confusing to a
2292           ; user unaware of the default value of the property, so issue a warning.
2293           (if (equal? empty-interval vals)
2294               (ly:warning "default '~a of ~a is ~a and can't be offset"
2295                 property grob vals)
2296               (let* ((orig (ly:grob-original grob))
2297                      (siblings
2298                        (if (ly:spanner? grob)
2299                            (ly:spanner-broken-into orig)
2300                            '()))
2301                      (total-found (length siblings))
2302                      ; Since there is some flexibility in input syntax,
2303                      ; structure of `offsets' is normalized.
2304                      (offsets
2305                        (if (or (not (pair? offsets))
2306                                (number-pair? offsets)
2307                                (and (number-pair-list? offsets)
2308                                     (number-pair-list? vals)))
2309                            (list offsets)
2310                            offsets)))
2311
2312                 (define (helper sibs offs)
2313                   ; apply offsets to the siblings of broken spanners
2314                   (if (pair? offs)
2315                       (if (eq? (car sibs) grob)
2316                           (offset-multiple-types vals (car offs))
2317                           (helper (cdr sibs) (cdr offs)))
2318                       vals))
2319
2320                 (if (>= total-found 2)
2321                     (helper siblings offsets)
2322                     (offset-multiple-types vals (car offsets)))))
2323
2324               (begin
2325                 (ly:warning "the property '~a of ~a cannot be offset" property grob)
2326                 vals))))
2327     ; return the closure named `self'
2328     self)
2329
2330
2331 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2332 ;; \magnifyMusic and \magnifyStaff
2333
2334 ;; defined as a function instead of a list because the
2335 ;; all-grob-descriptions alist is not available yet
2336 (define-public (find-named-props prop-name grob-descriptions)
2337   "Used by @code{\\magnifyMusic} and @code{\\magnifyStaff}.  When
2338 @var{grob-descriptions} is equal to the @code{all-grob-descriptions}
2339 alist (defined in @file{scm/define-grobs.scm}), this will find all grobs
2340 that can have a value for the @var{prop-name} property, and return them
2341 as a list in the following format:
2342 @example
2343 '((grob prop-name)
2344   (grob prop-name)
2345   ...)
2346 @end example"
2347   (define (find-grobs-with-interface interface grob-descriptions)
2348     (define (has-this-interface? grob-desc)
2349       (let* ((meta (ly:assoc-get 'meta (cdr grob-desc)))
2350              (interfaces (ly:assoc-get 'interfaces meta '())))
2351         (memq interface interfaces)))
2352     (let* ((grob-descriptions-with-this-interface
2353              (filter has-this-interface? grob-descriptions))
2354            (grob-names-with-this-interface
2355              (map car grob-descriptions-with-this-interface)))
2356       grob-names-with-this-interface))
2357   (let* ((interface
2358            (case prop-name
2359              ((baseline-skip word-space) 'text-interface)
2360              ((space-alist)              'break-aligned-interface)
2361              (else (ly:programming-error
2362                      "find-named-props: no interface associated with ~s"
2363                      prop-name))))
2364          (grobs-with-this-prop
2365            (find-grobs-with-interface interface grob-descriptions)))
2366     (map (lambda (x) (list x prop-name))
2367          grobs-with-this-prop)))
2368
2369
2370 (define (magnifyStaff-is-set? context mag)
2371   (let* ((Staff (ly:context-find context 'Staff))
2372          (old-mag (ly:context-property Staff 'magnifyStaffValue)))
2373     (not (null? old-mag))))
2374
2375 (define (staff-magnification-is-changing? context mag)
2376   (let* ((Staff (ly:context-find context 'Staff))
2377          (old-mag (ly:context-property Staff 'magnifyStaffValue 1)))
2378     (not (= old-mag mag))))
2379
2380 (define-public (scale-fontSize func-name mag)
2381   "Used by @code{\\magnifyMusic} and @code{\\magnifyStaff}.  Look up the
2382 current @code{fontSize} in the appropriate context and scale it by the
2383 magnification factor @var{mag}.  @var{func-name} is either
2384 @code{'magnifyMusic} or @code{'magnifyStaff}."
2385   (make-apply-context
2386     (lambda (context)
2387       (if (or (eq? func-name 'magnifyMusic)
2388               ;; for \magnifyStaff, only scale the fontSize
2389               ;; if staff magnification is changing
2390               ;; and does not equal 1
2391               (and (staff-magnification-is-changing? context mag)
2392                    (not (= mag 1))))
2393         (let* ((where (case func-name
2394                         ((magnifyMusic) context)
2395                         ((magnifyStaff) (ly:context-find context 'Staff))))
2396                (fontSize (ly:context-property where 'fontSize 0))
2397                (new-fontSize (+ fontSize (magnification->font-size mag))))
2398           (ly:context-set-property! where 'fontSize new-fontSize))))))
2399
2400 (define-public (revert-fontSize func-name mag)
2401   "Used by @code{\\magnifyMusic} and @code{\\magnifyStaff}.  Calculate
2402 the previous @code{fontSize} value (before scaling) by factoring out the
2403 magnification factor @var{mag} (if @var{func-name} is
2404 @code{'magnifyMusic}), or by factoring out the context property
2405 @code{magnifyStaffValue} (if @var{func-name} is @code{'magnifyStaff}).
2406 Revert the @code{fontSize} in the appropriate context accordingly.
2407
2408 With @code{\\magnifyMusic}, the scaling is reverted after the music
2409 block it operates on.  @code{\\magnifyStaff} does not operate on a music
2410 block, so the scaling from a previous call (if there is one) is reverted
2411 before the new scaling takes effect."
2412   (make-apply-context
2413     (lambda (context)
2414       (if (or (eq? func-name 'magnifyMusic)
2415               ;; for \magnifyStaff...
2416               (and
2417                 ;; don't revert the user's fontSize choice
2418                 ;; the first time \magnifyStaff is called
2419                 (magnifyStaff-is-set? context mag)
2420                 ;; only revert the previous fontSize
2421                 ;; if staff magnification is changing
2422                 (staff-magnification-is-changing? context mag)))
2423         (let* ((where
2424                  (case func-name
2425                    ((magnifyMusic) context)
2426                    ((magnifyStaff) (ly:context-find context 'Staff))))
2427                (old-mag
2428                  (case func-name
2429                    ((magnifyMusic) mag)
2430                    ((magnifyStaff)
2431                     (ly:context-property where 'magnifyStaffValue 1))))
2432                (fontSize (ly:context-property where 'fontSize 0))
2433                (old-fontSize (- fontSize (magnification->font-size old-mag))))
2434           (ly:context-set-property! where 'fontSize old-fontSize))))))
2435
2436 (define-public (scale-props func-name mag allowed-to-shrink? props)
2437   "Used by @code{\\magnifyMusic} and @code{\\magnifyStaff}.  For each
2438 prop in @var{props}, find the current value of the requested prop, scale
2439 it by the magnification factor @var{mag}, and do the equivalent of a
2440 @code{\\temporary@tie{}\\override} with the new value in the appropriate
2441 context.  If @var{allowed-to-shrink?} is @code{#f}, don't let the new
2442 value be less than the current value.  @var{func-name} is either
2443 @code{'magnifyMusic} or @code{'magnifyStaff}.  The @var{props} list is
2444 formatted like:
2445 @example
2446 '((Stem thickness)
2447   (Slur line-thickness)
2448   ...)
2449 @end example"
2450   (make-apply-context
2451     (lambda (context)
2452       (define (scale-prop grob-prop-list)
2453         (let* ((grob (car grob-prop-list))
2454                (prop (cadr grob-prop-list))
2455                (where (if (eq? grob 'SpacingSpanner)
2456                         (ly:context-find context 'Score)
2457                         (case func-name
2458                           ((magnifyMusic) context)
2459                           ((magnifyStaff) (ly:context-find context 'Staff)))))
2460                (grob-def (ly:context-grob-definition where grob)))
2461           (if (eq? prop 'space-alist)
2462             (let* ((space-alist (ly:assoc-get prop grob-def))
2463                    (scale-spacing-tuple (lambda (x)
2464                                           (cons (car x)
2465                                                 (cons (cadr x)
2466                                                       (* mag (cddr x))))))
2467                    (scaled-tuples (if space-alist
2468                                       (map scale-spacing-tuple space-alist)
2469                                       '()))
2470                    (new-alist (append scaled-tuples space-alist)))
2471               (ly:context-pushpop-property where grob prop new-alist))
2472             (let* ((val (ly:assoc-get prop grob-def (case prop
2473                                                       ((baseline-skip) 3)
2474                                                       ((word-space)    0.6)
2475                                                       (else            1))))
2476                    (proc (lambda (x)
2477                            (if allowed-to-shrink?
2478                              (* x mag)
2479                              (* x (max 1 mag)))))
2480                    (new-val (if (number-pair? val)
2481                               (cons (proc (car val))
2482                                     (proc (cdr val)))
2483                               (proc val))))
2484               (ly:context-pushpop-property where grob prop new-val)))))
2485       (if (or (eq? func-name 'magnifyMusic)
2486               ;; for \magnifyStaff, only scale the properties
2487               ;; if staff magnification is changing
2488               ;; and does not equal 1
2489               (and (staff-magnification-is-changing? context mag)
2490                    (not (= mag 1))))
2491         (for-each scale-prop props)))))
2492
2493 (define-public (revert-props func-name mag props)
2494   "Used by @code{\\magnifyMusic} and @code{\\magnifyStaff}.  Revert each
2495 prop in @var{props} in the appropriate context.  @var{func-name} is
2496 either @code{'magnifyMusic} or @code{'magnifyStaff}.  The @var{props}
2497 list is formatted like:
2498 @example
2499 '((Stem thickness)
2500   (Slur line-thickness)
2501   ...)
2502 @end example"
2503   (make-apply-context
2504     (lambda (context)
2505       (define (revert-prop grob-prop-list)
2506         (let* ((grob (car grob-prop-list))
2507                (prop (cadr grob-prop-list))
2508                (where (if (eq? grob 'SpacingSpanner)
2509                         (ly:context-find context 'Score)
2510                         (case func-name
2511                           ((magnifyMusic) context)
2512                           ((magnifyStaff) (ly:context-find context 'Staff))))))
2513           (ly:context-pushpop-property where grob prop)))
2514       (if (or (eq? func-name 'magnifyMusic)
2515               ;; for \magnifyStaff...
2516               (and
2517                 ;; don't revert the user's property overrides
2518                 ;; the first time \magnifyStaff is called
2519                 (magnifyStaff-is-set? context mag)
2520                 ;; revert the overrides from the previous \magnifyStaff,
2521                 ;; but only if staff magnification is changing
2522                 (staff-magnification-is-changing? context mag)))
2523         (for-each revert-prop props)))))
2524
2525 ;; \magnifyMusic only
2526 (define-public (scale-beam-thickness mag)
2527   "Used by @code{\\magnifyMusic}.  Scaling @code{Beam.beam-thickness}
2528 exactly to the @var{mag} value will not work.  This uses two reference
2529 values for @code{beam-thickness} to determine an acceptable value when
2530 scaling, then does the equivalent of a
2531 @code{\\temporary@tie{}\\override} with the new value."
2532   (make-apply-context
2533     (lambda (context)
2534       (let* ((grob-def (ly:context-grob-definition context 'Beam))
2535              (val (ly:assoc-get 'beam-thickness grob-def 0.48))
2536              (ratio-to-default (/ val 0.48))
2537              ;; gives beam-thickness=0.48 when mag=1 (like default),
2538              ;; gives beam-thickness=0.35 when mag=0.63 (like CueVoice)
2539              (scaled-default (+ 119/925 (* mag 13/37)))
2540              (new-val (* scaled-default ratio-to-default)))
2541         (ly:context-pushpop-property context 'Beam 'beam-thickness new-val)))))
2542
2543 ;; tag management
2544 ;;
2545
2546 (define tag-groups (make-hash-table))
2547 (call-after-session (lambda () (hash-clear! tag-groups)))
2548
2549 (define-public (define-tag-group tags)
2550   "Define a tag-group consisting of the given @var{tags}, a@tie{}list
2551 of symbols.  Returns @code{#f} if successful, and an error message if
2552 there is a conflicting tag group definition."
2553   (cond ((not (symbol-list? tags)) (format #f (_ "not a symbol list: ~a") tags))
2554         ((any (lambda (tag) (hashq-ref tag-groups tag)) tags)
2555          => (lambda (group) (and (not (lset= eq? group tags))
2556                                  (format #f (_ "conflicting tag group ~a") group))))
2557         (else
2558          (for-each
2559           (lambda (elt) (hashq-set! tag-groups elt tags))
2560           tags)
2561          #f)))
2562
2563 (define-public (tag-group-get tag)
2564   "Return the tag group (as a list of symbols) that the given
2565 @var{tag} symbol belongs to, @code{#f} if none."
2566   (hashq-ref tag-groups tag))
2567
2568 (define-public (tags-remove-predicate tags)
2569   "Returns a predicate that returns @code{#f} for any music that is to
2570 be removed by @{\\removeWithTag} on the given symbol or list of
2571 symbols @var{tags}."
2572   (if (symbol? tags)
2573       (lambda (m)
2574         (not (memq tags (ly:music-property m 'tags))))
2575       (lambda (m)
2576         (not (any (lambda (t) (memq t tags))
2577                   (ly:music-property m 'tags))))))
2578
2579 (define-public (tags-keep-predicate tags)
2580   "Returns a predicate that returns @code{#f} for any music that is to
2581 be removed by @{\\keepWithTag} on the given symbol or list of symbols
2582 @var{tags}."
2583   (if (symbol? tags)
2584       (let ((group (tag-group-get tags)))
2585         (lambda (m)
2586           (let ((music-tags (ly:music-property m 'tags)))
2587             (or
2588              (null? music-tags) ; redundant but very frequent
2589              ;; We know of only one tag to keep.  Either we find it in
2590              ;; the music tags, or all music tags must be from a
2591              ;; different group
2592              (memq tags music-tags)
2593              (not (any (lambda (t) (eq? (tag-group-get t) group)) music-tags))))))
2594       (let ((groups (delete-duplicates (map tag-group-get tags) eq?)))
2595         (lambda (m)
2596           (let ((music-tags (ly:music-property m 'tags)))
2597             (or
2598              (null? music-tags) ; redundant but very frequent
2599              (any (lambda (t) (memq t tags)) music-tags)
2600              ;; if no tag matches, no tag group should match either
2601              (not (any (lambda (t) (memq (tag-group-get t) groups)) music-tags))))))))