ly/music-functions-init.ly

   1 %%%% -*- Mode: Scheme -*-
   2
   3 %%%% This file is part of LilyPond, the GNU music typesetter.
   4 %%%%
   5 %%%% Copyright (C) 2003--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   6 %%%%                          Jan Nieuwenhuizen <janneke@gnu.org>
   7 %%%%
   8 %%%% LilyPond is free software: you can redistribute it and/or modify
   9 %%%% it under the terms of the GNU General Public License as published by
  10 %%%% the Free Software Foundation, either version 3 of the License, or
  11 %%%% (at your option) any later version.
  12 %%%%
  13 %%%% LilyPond is distributed in the hope that it will be useful,
  14 %%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 %%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 %%%% GNU General Public License for more details.
  17 %%%%
  18 %%%% You should have received a copy of the GNU General Public License
  19 %%%% along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 \version "2.19.22"
  22
  23
  24 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  25 %% this file is alphabetically sorted.
  26 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  27
  28 %% need SRFI-1 for filter; optargs for lambda*
  29 #(use-modules (srfi srfi-1)
  30               (ice-9 optargs))
  31
  32 %% TODO: using define-music-function in a .scm causes crash.
  33
  34 absolute =
  35 #(define-music-function (music)
  36    (ly:music?)
  37    (_i "Make @var{music} absolute.  This does not actually change the
  38 music itself but rather hides it from surrounding @code{\\relative}
  39 and @code{\\fixed} commands.")
  40    (make-music 'RelativeOctaveMusic 'element music))
  41
  42 acciaccatura =
  43 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
  44    (_i "Create an acciaccatura from the following music expression"))
  45
  46 %% keep these two together
  47 instrument-definitions = #'()
  48 addInstrumentDefinition =
  49 #(define-void-function
  50    (name lst) (string? list?)
  51    (_i "Create instrument @var{name} with properties @var{list}.")
  52    (set! instrument-definitions (acons name lst instrument-definitions)))
  53
  54 addQuote =
  55 #(define-void-function (name music) (string? ly:music?)
  56    (_i "Define @var{music} as a quotable music expression named
  57 @var{name}")
  58    (add-quotable name music))
  59
  60 %% keep these two together
  61 afterGraceFraction = #(cons 6 8)
  62 afterGrace =
  63 #(define-music-function (main grace) (ly:music? ly:music?)
  64    (_i "Create @var{grace} note(s) after a @var{main} music expression.")
  65    (let ((main-length (ly:music-length main))
  66          (fraction  (ly:parser-lookup 'afterGraceFraction)))
  67      (make-simultaneous-music
  68       (list
  69        main
  70        (make-sequential-music
  71         (list
  72
  73          (make-music 'SkipMusic
  74                      'duration (ly:make-duration
  75                                 0 0
  76                                 (* (ly:moment-main-numerator main-length)
  77                                    (car fraction))
  78                                 (* (ly:moment-main-denominator main-length)
  79                                    (cdr fraction))))
  80          (make-music 'GraceMusic
  81                      'element grace)))))))
  82
  83
  84 %% music identifiers not allowed at top-level,
  85 %% so this is a music-function instead.
  86 allowPageTurn =
  87 #(define-music-function () ()
  88    (_i "Allow a page turn. May be used at toplevel (ie between scores or
  89 markups), or inside a score.")
  90    (make-music 'EventChord
  91                'page-marker #t
  92                'page-turn-permission 'allow
  93                'elements (list (make-music 'PageTurnEvent
  94                                            'break-permission 'allow))))
  95
  96 alterBroken =
  97 #(define-music-function (property arg item)
  98   (symbol-list-or-symbol? list? symbol-list-or-music?)
  99   (_i "Override @var{property} for pieces of broken spanner @var{item}
 100 with values @var{arg}.  @var{item} may either be music in the form of
 101 a starting spanner event, or a symbol list in the form
 102 @samp{Context.Grob} or just @samp{Grob}.  Iff @var{item} is in the
 103 form of a spanner event, @var{property} may also have the form
 104 @samp{Grob.property} for specifying a directed tweak.")
 105   (if (ly:music? item)
 106       (if (eq? (ly:music-property item 'span-direction) START)
 107           (tweak property (value-for-spanner-piece arg) item)
 108           (begin
 109             (ly:music-warning item (_ "not a spanner"))
 110             item))
 111       (let* ((p (check-grob-path item (*location*)
 112                                  #:default 'Bottom
 113                                  #:min 2
 114                                  #:max 2))
 115              (name (and p (second p)))
 116              (description
 117               (and name (assoc-get name all-grob-descriptions))))
 118         (if (and description
 119                  (member 'spanner-interface
 120                          (assoc-get 'interfaces
 121                                     (assoc-get 'meta description))))
 122             (override (append item (if (symbol? property)
 123                                        (list property)
 124                                        property))
 125                       (value-for-spanner-piece arg))
 126             (begin
 127               (ly:input-warning (*location*) (_ "not a spanner name, `~a'") name)
 128               (make-music 'Music))))))
 129
 130 appendToTag =
 131 #(define-music-function (tag more music)
 132    (symbol? ly:music? ly:music?)
 133    (_i "Append @var{more} to the @code{elements} of all music
 134 expressions in @var{music} that are tagged with @var{tag}.")
 135    (music-map (lambda (m)
 136                 (if (memq tag (ly:music-property m 'tags))
 137                     (set! (ly:music-property m 'elements)
 138                           (append (ly:music-property m 'elements)
 139                                   (list more))))
 140                 m)
 141               music))
 142
 143 applyContext =
 144 #(define-music-function (proc) (procedure?)
 145    (_i "Modify context properties with Scheme procedure @var{proc}.")
 146    (make-music 'ApplyContext
 147                'procedure proc))
 148
 149 applyMusic =
 150 #(define-music-function (func music) (procedure? ly:music?)
 151    (_i"Apply procedure @var{func} to @var{music}.")
 152    (func music))
 153
 154 applyOutput =
 155 #(define-music-function (ctx proc) (symbol? procedure?)
 156    (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
 157    (make-music 'ApplyOutputEvent
 158                'procedure proc
 159                'context-type ctx))
 160
 161 appoggiatura =
 162 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
 163    (_i "Create an appoggiatura from @var{music}"))
 164
 165 % for regression testing purposes.
 166 assertBeamQuant =
 167 #(define-music-function (l r) (pair? pair?)
 168    (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
 169    (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
 170
 171 % for regression testing purposes.
 172 assertBeamSlope =
 173 #(define-music-function (comp) (procedure?)
 174    (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
 175    (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
 176
 177 autochange =
 178 #(define-music-function (music) (ly:music?)
 179    (_i "Make voices that switch between staves automatically")
 180    (let ;; keep the contexts alive for the full duration
 181        ((skip (make-skip-music (make-duration-of-length
 182                                 (ly:music-length music)))))
 183      #{
 184        <<
 185          \context Staff = "up" <<
 186            #(make-autochange-music music)
 187            \new Voice { #skip }
 188          >>
 189          \context Staff = "down" \with {
 190            clefGlyph = "clefs.F"
 191            clefPosition = 2
 192            middleCPosition = 6
 193            middleCClefPosition = 6
 194          } {
 195            \new Voice { #skip }
 196          }
 197        >>
 198      #} ))
 199
 200 balloonGrobText =
 201 #(define-music-function (grob-name offset text)
 202    (symbol? number-pair? markup?)
 203    (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
 204  (use like @code{\\once})")
 205    (make-event-chord
 206     (list
 207      (make-music 'AnnotateOutputEvent
 208                  'symbol grob-name
 209                  'X-offset (car offset)
 210                  'Y-offset (cdr offset)
 211                  'text text))))
 212
 213 balloonText =
 214 #(define-event-function (offset text) (number-pair? markup?)
 215    (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
 216    (make-music 'AnnotateOutputEvent
 217                'X-offset (car offset)
 218                'Y-offset (cdr offset)
 219                'text text))
 220
 221 bar =
 222 #(define-music-function (type) (string?)
 223    (_i "Insert a bar line of type @var{type}")
 224    (context-spec-music
 225     (make-property-set 'whichBar type)
 226     'Timing))
 227
 228 barNumberCheck =
 229 #(define-music-function (n) (integer?)
 230    (_i "Print a warning if the current bar number is not @var{n}.")
 231    (make-music 'ApplyContext
 232                'procedure
 233                (lambda (c)
 234                  (let ((cbn (ly:context-property c 'currentBarNumber)))
 235                    (if (and  (number? cbn) (not (= cbn n)))
 236                        (ly:input-warning (*location*)
 237                                          "Barcheck failed got ~a expect ~a"
 238                                          cbn n))))))
 239
 240 beamExceptions =
 241 #(define-scheme-function (music) (ly:music?)
 242    (_i "Extract a value suitable for setting
 243 @code{Timing.beamExceptions} from the given pattern with explicit
 244 beams in @var{music}.  A bar check @code{|} has to be used between
 245 bars of patterns in order to reset the timing.")
 246    (extract-beam-exceptions music))
 247
 248 bendAfter =
 249 #(define-event-function (delta) (real?)
 250    (_i "Create a fall or doit of pitch interval @var{delta}.")
 251    (make-music 'BendAfterEvent
 252                'delta-step delta))
 253
 254 bookOutputName =
 255 #(define-void-function (newfilename) (string?)
 256    (_i "Direct output for the current book block to @var{newfilename}.")
 257    (set! (paper-variable #f 'output-filename) newfilename))
 258
 259 bookOutputSuffix =
 260 #(define-void-function (newsuffix) (string?)
 261    (_i "Set the output filename suffix for the current book block to
 262 @var{newsuffix}.")
 263    (set! (paper-variable #f 'output-suffix) newsuffix))
 264
 265 %% \breathe is defined as a music function rather than an event identifier to
 266 %% ensure it gets useful input location information: as an event identifier,
 267 %% it would have to be wrapped in an EventChord to prevent it from being
 268 %% treated as a post_event by the parser
 269 breathe =
 270 #(define-music-function () ()
 271    (_i "Insert a breath mark.")
 272    (make-music 'BreathingEvent))
 273
 274 clef =
 275 #(define-music-function (type) (string?)
 276    (_i "Set the current clef to @var{type}.")
 277    (make-clef-set type))
 278
 279
 280 compoundMeter =
 281 #(define-music-function (args) (pair?)
 282   (_i "Create compound time signatures. The argument is a Scheme list of
 283 lists. Each list describes one fraction, with the last entry being the
 284 denominator, while the first entries describe the summands in the
 285 enumerator. If the time signature consists of just one fraction,
 286 the list can be given directly, i.e. not as a list containing a single list.
 287 For example, a time signature of (3+1)/8 + 2/4 would be created as
 288 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
 289 as @code{\\compoundMeter #'((3 2 8))} or shorter
 290 @code{\\compoundMeter #'(3 2 8)}.")
 291   (let* ((mlen (calculate-compound-measure-length args))
 292          (beat (calculate-compound-base-beat args))
 293          (beatGrouping (calculate-compound-beat-grouping args))
 294          (timesig (cons (ly:moment-main-numerator mlen)
 295                         (ly:moment-main-denominator mlen))))
 296   #{
 297     \once \override Timing.TimeSignature.stencil = #(lambda (grob)
 298       (grob-interpret-markup grob (make-compound-meter-markup args)))
 299     \set Timing.timeSignatureFraction = #timesig
 300     \set Timing.baseMoment = #beat
 301     \set Timing.beatStructure = #beatGrouping
 302     \set Timing.beamExceptions = #'()
 303     \set Timing.measureLength = #mlen
 304   #} ))
 305
 306 compressMMRests =
 307 #(define-music-function (music) (ly:music?)
 308   (_i "Remove the empty bars created by multi-measure rests,
 309 leaving just the first bar containing the MM rest itself.")
 310    (music-map
 311     (lambda (m)
 312       (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
 313           #{ \once \set Score.skipBars = ##t #m #}
 314           #{ #m #} ))
 315     music))
 316
 317 crossStaff =
 318 #(define-music-function (notes) (ly:music?)
 319   (_i "Create cross-staff stems")
 320   #{
 321   \temporary \override Stem.cross-staff = #cross-staff-connect
 322   \temporary \override Flag.style = #'no-flag
 323   #notes
 324   \revert Stem.cross-staff
 325   \revert Flag.style
 326 #})
 327
 328 cueClef =
 329 #(define-music-function (type) (string?)
 330   (_i "Set the current cue clef to @var{type}.")
 331   (make-cue-clef-set type))
 332
 333 cueClefUnset =
 334 #(define-music-function () ()
 335   (_i "Unset the current cue clef.")
 336   (make-cue-clef-unset))
 337
 338 cueDuring =
 339 #(define-music-function
 340    (what dir main-music) (string? ly:dir? ly:music?)
 341    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 342 in a CueVoice oriented by @var{dir}.")
 343    (make-music 'QuoteMusic
 344                'element main-music
 345                'quoted-context-type 'CueVoice
 346                'quoted-context-id "cue"
 347                'quoted-music-name what
 348                'quoted-voice-direction dir))
 349
 350 cueDuringWithClef =
 351 #(define-music-function
 352    (what dir clef main-music) (string? ly:dir? string? ly:music?)
 353    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 354 in a CueVoice oriented by @var{dir}.")
 355    (make-music 'QuoteMusic
 356                'element main-music
 357                'quoted-context-type 'CueVoice
 358                'quoted-context-id "cue"
 359                'quoted-music-name what
 360                'quoted-music-clef clef
 361                'quoted-voice-direction dir))
 362
 363
 364
 365 displayLilyMusic =
 366 #(define-music-function (port music) ((output-port?) ly:music?)
 367    (_i "Display the LilyPond input representation of @var{music}
 368 to @var{port}, defaulting to the console.")
 369    (let ((port (or port (current-output-port))))
 370      (newline port)
 371      (display-lily-music music port))
 372    music)
 373
 374 displayMusic =
 375 #(define-music-function (port music) ((output-port?) ly:music?)
 376    (_i "Display the internal representation of @var{music} to
 377 @var{port}, default to the console.")
 378    (let ((port (or port (current-output-port))))
 379      (newline port)
 380      (display-scheme-music music port))
 381    music)
 382
 383 displayScheme =
 384 #(define-scheme-function (port expr) ((output-port?) scheme?)
 385    (_i "Display the internal representation of @var{expr} to
 386 @var{port}, default to the console.")
 387    (let ((port (or port (current-output-port))))
 388      (newline port)
 389      (display-scheme-music expr port))
 390    expr)
 391
 392
 393
 394 endSpanners =
 395 #(define-music-function (music) (ly:music?)
 396    (_i "Terminate the next spanner prematurely after exactly one note
 397 without the need of a specific end spanner.")
 398    (let* ((start-span-evs (filter (lambda (ev)
 399                                     (equal? (ly:music-property ev 'span-direction)
 400                                             START))
 401                                   (extract-typed-music music 'span-event)))
 402           (stop-span-evs
 403            (map (lambda (m)
 404                   (music-clone m 'span-direction STOP))
 405                 start-span-evs))
 406           (end-ev-chord (make-music 'EventChord
 407                                     'elements stop-span-evs))
 408           (total (make-music 'SequentialMusic
 409                              'elements (list music
 410                                              end-ev-chord))))
 411      total))
 412
 413 eventChords =
 414 #(define-music-function (music) (ly:music?)
 415    (_i "Compatibility function wrapping @code{EventChord} around
 416 isolated rhythmic events occuring since version 2.15.28, after
 417 expanding repeat chords @samp{q}.")
 418    (event-chord-wrap! music))
 419
 420 featherDurations=
 421 #(define-music-function (factor argument) (ly:moment? ly:music?)
 422    (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
 423    (let ((orig-duration (ly:music-length argument))
 424          (multiplier (ly:make-moment 1 1)))
 425
 426      (for-each
 427       (lambda (mus)
 428         (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
 429             (begin
 430               (ly:music-compress mus multiplier)
 431               (set! multiplier (ly:moment-mul factor multiplier)))))
 432       (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
 433      (ly:music-compress
 434       argument
 435       (ly:moment-div orig-duration (ly:music-length argument)))
 436
 437      argument))
 438
 439 finger =
 440 #(define-event-function (finger) (number-or-markup?)
 441    (_i "Apply @var{finger} as a fingering indication.")
 442
 443    (make-music
 444             'FingeringEvent
 445             (if (number? finger) 'digit 'text)
 446             finger))
 447
 448 fixed =
 449 #(define-music-function (pitch music)
 450    (ly:pitch? ly:music?)
 451    (_i "Use the octave of @var{pitch} as the default octave for @var{music}.")
 452    (let ((octave-marks (1+ (ly:pitch-octave pitch))))
 453      (cond ((not (= 0 octave-marks))
 454             (ly:music-transpose music (ly:make-pitch octave-marks 0 0))
 455             ;;In order to leave unchanged the notes in any enclosed
 456             ;; \absolute or \fixed or \relative, make a cancelling shift
 457             (map (lambda (m)
 458                    (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0)))
 459                  (extract-named-music music 'RelativeOctaveMusic)))))
 460    (make-music 'RelativeOctaveMusic 'element music))
 461
 462 footnote =
 463 #(define-music-function (mark offset footnote item)
 464    ((markup?) number-pair? markup? symbol-list-or-music?)
 465    (_i "Make the markup @var{footnote} a footnote on @var{item}.  The
 466 footnote is marked with a markup @var{mark} moved by @var{offset} with
 467 respect to the marked music.
 468
 469 If @var{mark} is not given or specified as @var{\\default}, it is
 470 replaced by an automatically generated sequence number.  If @var{item}
 471 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
 472 grobs of that type will be marked at the current time step in the
 473 given context (default @code{Bottom}).
 474
 475 If @var{item} is music, the music will get a footnote attached to a
 476 grob immediately attached to the event, like @var{\\tweak} does.  For
 477 attaching a footnote to an @emph{indirectly} caused grob, write
 478 @code{\\single\\footnote}, use @var{item} to specify the grob, and
 479 follow it with the music to annotate.
 480
 481 Like with @code{\\tweak}, if you use a footnote on a following
 482 post-event, the @code{\\footnote} command itself needs to be attached
 483 to the preceding note or rest as a post-event with @code{-}.")
 484    (let ((mus (make-music
 485                'FootnoteEvent
 486                'X-offset (car offset)
 487                'Y-offset (cdr offset)
 488                'automatically-numbered (not mark)
 489                'text (or mark (make-null-markup))
 490                'footnote-text footnote)))
 491      (once (tweak 'footnote-music mus item))))
 492
 493 grace =
 494 #(def-grace-function startGraceMusic stopGraceMusic
 495    (_i "Insert @var{music} as grace notes."))
 496
 497 grobdescriptions =
 498 #(define-scheme-function (descriptions) (list?)
 499    (_i "Create a context modification from @var{descriptions}, a list
 500 in the format of @code{all-grob-descriptions}.")
 501    (ly:make-context-mod
 502     (map (lambda (p)
 503            (list 'assign (car p) (ly:make-grob-properties (cdr p))))
 504          descriptions)))
 505
 506 harmonicByFret = #(define-music-function (fret music) (number? ly:music?)
 507   (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 508 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
 509   #{
 510     \set harmonicDots = ##t
 511     \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
 512     \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
 513     \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 514                                             (ly:note-head::print grob))
 515     #(make-harmonic
 516        (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
 517     \unset harmonicDots
 518     \revert TabNoteHead.stencil
 519     \revert NoteHead.Y-extent
 520     \revert NoteHead.stencil
 521   #})
 522
 523 harmonicByRatio = #(define-music-function (ratio music) (number? ly:music?)
 524     (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 525 harmonics played on a fretted instrument by touching the strings at the point
 526 given through @var{ratio}.")
 527   #{
 528     \set harmonicDots = ##t
 529     \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
 530     \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height)
 531     \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 532                                             (ly:note-head::print grob))
 533     #(make-harmonic
 534       (calc-harmonic-pitch (ratio->pitch ratio) music))
 535     \unset harmonicDots
 536     \revert TabNoteHead.stencil
 537     \revert NoteHead.Y-extent
 538     \revert NoteHead.stencil
 539   #})
 540
 541 hide =
 542 #(define-music-function (item) (symbol-list-or-music?)
 543    (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
 544 making it invisible while still retaining its dimensions.
 545
 546 If @var{item} is a symbol list of form @code{GrobName} or
 547 @code{Context.GrobName}, the result is an override for the grob name
 548 specified by it.  If @var{item} is a music expression, the result is
 549 the same music expression with an appropriate tweak applied to it.")
 550    (tweak 'transparent #t item))
 551
 552 inStaffSegno =
 553 #(define-music-function () ()
 554    (_i "Put the segno variant 'varsegno' at this position into the staff,
 555 compatible with the repeat command.")
 556    (make-music 'ApplyContext
 557                'procedure
 558                (lambda (ctx)
 559                  (let ((score-ctx (ly:context-find ctx 'Score)))
 560                    (if (ly:context? score-ctx)
 561                      (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
 562                        (if (eq? (memq 'segno-display old-rc) #f)
 563                          (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
 564
 565 instrumentSwitch =
 566 #(define-music-function
 567    (name) (string?)
 568    (_i "Switch instrument to @var{name}, which must be predefined with
 569 @code{\\addInstrumentDefinition}.")
 570    (let* ((handle (assoc name instrument-definitions))
 571           (instrument-def (if handle (cdr handle) '())))
 572
 573      (if (not handle)
 574          (ly:input-warning (*location*) "No such instrument: ~a" name))
 575      (context-spec-music
 576       (make-music 'SimultaneousMusic
 577                   'elements
 578                   (map (lambda (kv)
 579                          (make-property-set
 580                           (car kv)
 581                           (cdr kv)))
 582                        instrument-def))
 583       'Staff)))
 584
 585
 586
 587 keepWithTag =
 588 #(define-music-function (tags music)
 589    (symbol-list-or-symbol? ly:music?)
 590    (_i "Include only elements of @var{music} that are tagged with one
 591 of the tags in @var{tags}.  @var{tags} may be either a single symbol
 592 or a list of symbols.
 593
 594 Each tag may be declared as a member of at most one tag group (defined
 595 with @code{\\tagGroup}).  If none of a @var{music} element's tags
 596 share a tag group with one of the specified @var{tags}, the element is
 597 retained.")
 598    (music-filter
 599     (tags-keep-predicate tags)
 600     music))
 601
 602 key =
 603 #(define-music-function (tonic pitch-alist)
 604    ((ly:pitch? '()) (list? '()))
 605    (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
 606 If both are null, just generate @code{KeyChangeEvent}.")
 607    (cond ((null? tonic) (make-music 'KeyChangeEvent))
 608          ((null? pitch-alist)
 609           (ly:parser-error (_ "second argument must be pitch list")
 610                            (*location*))
 611           (make-music 'SequentialMusic 'void #t))
 612          (else
 613           (ly:music-transpose
 614            (make-music 'KeyChangeEvent
 615                 'tonic (ly:make-pitch 0 0 0)
 616                 'pitch-alist pitch-alist)
 617            tonic))))
 618
 619 killCues =
 620 #(define-music-function (music) (ly:music?)
 621    (_i "Remove cue notes from @var{music}.")
 622    (music-map
 623     (lambda (mus)
 624       (if (and (string? (ly:music-property mus 'quoted-music-name))
 625                (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
 626           (ly:music-property mus 'element)
 627           mus))
 628     music))
 629
 630
 631
 632 label =
 633 #(define-music-function (label) (symbol?)
 634    (_i "Create @var{label} as a bookmarking label.")
 635    (make-music 'EventChord
 636                'page-marker #t
 637                'page-label label
 638                'elements (list (make-music 'LabelEvent
 639                                            'page-label label))))
 640
 641
 642 language =
 643 #(define-void-function (language) (string?)
 644    (_i "Set note names for language @var{language}.")
 645    (note-names-language language))
 646
 647 languageSaveAndChange =
 648 #(define-void-function (language) (string?)
 649   (_i "Store the previous pitchnames alist, and set a new one.")
 650   (set! previous-pitchnames pitchnames)
 651   (note-names-language language))
 652
 653 languageRestore =
 654 #(define-void-function () ()
 655    (_i "Restore a previously-saved pitchnames alist.")
 656    (if previous-pitchnames
 657        (begin
 658         (set! pitchnames previous-pitchnames)
 659         (ly:parser-set-note-names pitchnames))
 660       (ly:input-warning (*location*) (_ "No other language was defined previously. Ignoring."))))
 661
 662
 663 magnifyMusic =
 664 #(define-music-function (mag music) (positive? ly:music?)
 665    (_i "Magnify the notation of @var{music} without changing the
 666 staff-size, using @var{mag} as a size factor.  Stems, beams,
 667 slurs, ties, and horizontal spacing are adjusted automatically.")
 668
 669    ;; these props are NOT allowed to shrink below default size
 670    (define unshrinkable-props
 671      '(
 672        ;; stems
 673        (Stem thickness)
 674
 675        ;; slurs
 676        (Slur line-thickness)
 677        (Slur thickness)
 678        (PhrasingSlur line-thickness)
 679        (PhrasingSlur thickness)
 680
 681        ;; ties
 682        (Tie line-thickness)
 683        (Tie thickness)
 684        (LaissezVibrerTie line-thickness)
 685        (LaissezVibrerTie thickness)
 686        (RepeatTie line-thickness)
 687        (RepeatTie thickness)
 688        ))
 689
 690    ;; these props ARE allowed to shrink below default size
 691    (define shrinkable-props
 692      (let ((baseline-skip-props
 693              (find-named-props 'baseline-skip all-grob-descriptions))
 694            (word-space-props
 695              (find-named-props 'word-space all-grob-descriptions)))
 696        (append
 697          baseline-skip-props
 698          word-space-props
 699          '(
 700            ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
 701            ;; override at the 'Score level
 702            ;(SpacingSpanner spacing-increment)
 703
 704            ;; lengths and heights
 705            (Beam length-fraction)
 706            (Stem length-fraction)
 707            (Stem beamlet-default-length)
 708            (Stem double-stem-separation)
 709            (Slur height-limit)
 710            (Slur minimum-length)
 711            (PhrasingSlur height-limit)
 712            (PhrasingSlur minimum-length)
 713
 714            ;; Beam.beam-thickness is dealt with separately below
 715            ))))
 716    #{
 717      \context Bottom {
 718        %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
 719        %\newSpacingSection
 720        #(scale-fontSize 'magnifyMusic mag)
 721        #(scale-props    'magnifyMusic mag #f unshrinkable-props)
 722        #(scale-props    'magnifyMusic mag #t shrinkable-props)
 723        #(scale-beam-thickness mag)
 724
 725        #music
 726
 727        %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
 728        %\newSpacingSection
 729        %% reverse engineer the former fontSize value instead of using \unset
 730        #(revert-fontSize 'magnifyMusic mag)
 731        #(revert-props    'magnifyMusic mag (append unshrinkable-props
 732                                                    shrinkable-props
 733                                                    '((Beam beam-thickness))))
 734      }
 735    #})
 736
 737 magnifyStaff =
 738 #(define-music-function (mag) (positive?)
 739    (_i "Change the size of the staff, adjusting notation size and
 740 horizontal spacing automatically, using @var{mag} as a size factor.")
 741
 742    ;; these props are NOT allowed to shrink below default size
 743    (define unshrinkable-props
 744      '((StaffSymbol thickness)))
 745
 746    ;; these props ARE allowed to shrink below default size
 747    (define shrinkable-props
 748      (let* ((baseline-skip-props
 749               (find-named-props 'baseline-skip all-grob-descriptions))
 750             (word-space-props
 751               (find-named-props 'word-space all-grob-descriptions))
 752             (space-alist-props
 753               (find-named-props 'space-alist all-grob-descriptions)))
 754        (append
 755          baseline-skip-props
 756          word-space-props
 757          space-alist-props
 758          '(
 759            ;; override at the 'Score level
 760            (SpacingSpanner spacing-increment)
 761
 762            (StaffSymbol staff-space)
 763            (BarLine kern)
 764            (BarLine segno-kern)
 765            (BarLine hair-thickness)
 766            (BarLine thick-thickness)
 767            (Stem beamlet-default-length)
 768            (Stem double-stem-separation)
 769            ))))
 770
 771    #{
 772      \stopStaff
 773
 774      %% revert settings from last time
 775      %% (but only if \magnifyStaff has already been used
 776      %% and the staff magnification is changing)
 777      #(revert-fontSize 'magnifyStaff mag)
 778      #(revert-props    'magnifyStaff mag (append unshrinkable-props
 779                                                  shrinkable-props))
 780
 781      %% scale settings
 782      %% (but only if staff magnification is changing
 783      %% and does not equal 1)
 784      #(scale-fontSize 'magnifyStaff mag)
 785      #(scale-props    'magnifyStaff mag #f unshrinkable-props)
 786      #(scale-props    'magnifyStaff mag #t shrinkable-props)
 787
 788      %% this might cause problems until Issue 3990 is fixed
 789      \newSpacingSection
 790
 791      \startStaff
 792      \set Staff.magnifyStaffValue = #mag
 793    #})
 794
 795 makeClusters =
 796 #(define-music-function (arg) (ly:music?)
 797    (_i "Display chords in @var{arg} as clusters.")
 798    (music-map note-to-cluster arg))
 799
 800 modalInversion =
 801 #(define-music-function (around to scale music)
 802     (ly:pitch? ly:pitch? ly:music? ly:music?)
 803     (_i "Invert @var{music} about @var{around} using @var{scale} and
 804 transpose from @var{around} to @var{to}.")
 805     (let ((inverter (make-modal-inverter around to scale)))
 806       (change-pitches music inverter)
 807       music))
 808
 809 modalTranspose =
 810 #(define-music-function (from to scale music)
 811     (ly:pitch? ly:pitch? ly:music? ly:music?)
 812     (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
 813 using @var{scale}.")
 814     (let ((transposer (make-modal-transposer from to scale)))
 815       (change-pitches music transposer)
 816       music))
 817
 818 inversion =
 819 #(define-music-function
 820    (around to music) (ly:pitch? ly:pitch? ly:music?)
 821    (_i "Invert @var{music} about @var{around} and
 822 transpose from @var{around} to @var{to}.")
 823    (music-invert around to music))
 824
 825 mark =
 826 #(define-music-function
 827    (label) ((number-or-markup?))
 828   "Make the music for the \\mark command."
 829   (let* ((set (and (integer? label)
 830                    (context-spec-music (make-property-set 'rehearsalMark label)
 831                                       'Score)))
 832          (ev (make-music 'MarkEvent
 833                          'origin (*location*))))
 834
 835     (if set
 836         (make-sequential-music (list set ev))
 837         (begin
 838           (if label (set! (ly:music-property ev 'label) label))
 839           ev))))
 840
 841 musicMap =
 842 #(define-music-function (proc mus) (procedure? ly:music?)
 843    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 844    (music-map proc mus))
 845
 846 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 847 %% because music identifiers are not allowed at top-level.
 848 noPageBreak =
 849 #(define-music-function () ()
 850    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 851 markups), or inside a score.")
 852    (make-music 'EventChord
 853                'page-marker #t
 854                'page-break-permission 'forbid
 855                'elements (list (make-music 'PageBreakEvent
 856                                            'break-permission '()))))
 857
 858 noPageTurn =
 859 #(define-music-function () ()
 860    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 861 markups), or inside a score.")
 862    (make-music 'EventChord
 863                'page-marker #t
 864                'page-turn-permission 'forbid
 865                'elements (list (make-music 'PageTurnEvent
 866                                            'break-permission '()))))
 867
 868
 869
 870 octaveCheck =
 871 #(define-music-function (pitch) (ly:pitch?)
 872    (_i "Octave check.")
 873    (make-music 'RelativeOctaveCheck
 874                'pitch pitch))
 875
 876 offset =
 877 #(define-music-function (property offsets item)
 878   (symbol-list-or-symbol? scheme? symbol-list-or-music?)
 879    (_i "Offset the default value of @var{property} of @var{item} by
 880 @var{offsets}.  If @var{item} is a string, the result is
 881 @code{\\override} for the specified grob type.  If @var{item} is
 882 a music expression, the result is the same music expression with an
 883 appropriate tweak applied.")
 884   (if (ly:music? item)
 885       ; In case of a tweak, grob property path is Grob.property
 886       (let ((prop-path (check-grob-path
 887                          (if (symbol? property)
 888                              (list property)
 889                              property) (*location*)
 890                          #:start 1 #:default #t #:min 2 #:max 2)))
 891         (if prop-path
 892             ; If the head of the grob property path is a symbol--i.e.,
 893             ; a grob name, produce a directed tweak.  Otherwise, create
 894             ; an ordinary tweak.
 895             (if (symbol? (car prop-path))
 896                 (tweak prop-path (offsetter (second prop-path) offsets) item)
 897                 (tweak (second prop-path)
 898                        (offsetter (second prop-path) offsets)
 899                        item))
 900             item))
 901       ; In case of an override, grob property path is Context.Grob.property.
 902       (let ((prop-path (check-grob-path
 903                          (append item
 904                                  (if (symbol? property)
 905                                      (list property)
 906                                      property)) (*location*)
 907                          #:default 'Bottom #:min 3 #:max 3)))
 908         (if prop-path
 909             (override prop-path (offsetter (third prop-path) offsets))
 910             (make-music 'Music)))))
 911
 912 omit =
 913 #(define-music-function (item) (symbol-list-or-music?)
 914    (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
 915 effectively omitting it without taking up space.
 916
 917 If @var{item} is a symbol list of form @code{GrobName} or
 918 @code{Context.GrobName}, the result is an override for the grob name
 919 specified by it.  If @var{item} is a music expression, the result is
 920 the same music expression with an appropriate tweak applied to it.")
 921    (tweak 'stencil #f item))
 922
 923 once =
 924 #(define-music-function (music) (ly:music?)
 925    (_i "Set @code{once} to @code{#t} on all layout instruction events
 926 in @var{music}.  This will complain about music with an actual
 927 duration.  As a special exception, if @var{music} contains
 928 @samp{tweaks} it will be silently ignored in order to allow for
 929 @code{\\once \\tweak} to work as both one-time override and proper
 930 tweak.")
 931    (if (not (pair? (ly:music-property music 'tweaks)))
 932        (for-some-music
 933         (lambda (m)
 934           (cond ((music-is-of-type? m 'layout-instruction-event)
 935                  (set! (ly:music-property m 'once) #t)
 936                  #t)
 937                 ((ly:duration? (ly:music-property m 'duration))
 938                  (ly:music-warning m (_ "Cannot apply \\once to timed music"))
 939                  #t)
 940                 (else #f)))
 941         music))
 942    music)
 943
 944 ottava =
 945 #(define-music-function (octave) (integer?)
 946    (_i "Set the octavation.")
 947    (make-music 'OttavaMusic
 948                'ottava-number octave))
 949
 950 #(ly:expect-warning
 951   (ly:translate-cpp-warning-scheme "identifier name is a keyword: `%s'")
 952   "override")
 953 override =
 954 #(define-music-function (grob-property-path value)
 955    (symbol-list? scheme?)
 956    (_i "Set the grob property specified by @var{grob-property-path} to
 957 @var{value}.  @var{grob-property-path} is a symbol list of the form
 958 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
 959 with subproperties given as well.  Because @code{\\override} is a
 960 reserved word with special syntax in LilyPond input, this music
 961 function will generally only be accessible from Scheme.")
 962    (let ((p (check-grob-path grob-property-path (*location*)
 963                              #:default 'Bottom
 964                              #:min 3)))
 965      (if p
 966          (context-spec-music
 967           (make-music 'OverrideProperty
 968                       'symbol (cadr p)
 969                       'origin (*location*)
 970                       'grob-value value
 971                       'grob-property-path (cddr p)
 972                       'pop-first #t)
 973           (car p))
 974          (make-music 'Music))))
 975
 976
 977 overrideTimeSignatureSettings =
 978 #(define-music-function
 979    (time-signature base-moment beat-structure beam-exceptions)
 980    (fraction? fraction? list? list?)
 981
 982    (_i "Override @code{timeSignatureSettings}
 983 for time signatures of @var{time-signature} to have settings
 984 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 985
 986    ;; TODO -- add warning if largest value of grouping is
 987    ;;       greater than time-signature.
 988   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 989     (override-time-signature-setting time-signature setting)))
 990
 991 overrideProperty =
 992 #(define-music-function (grob-property-path value)
 993    (symbol-list? scheme?)
 994
 995    (_i "Set the grob property specified by @var{grob-property-path} to
 996 @var{value}.  @var{grob-property-path} is a symbol list of the form
 997 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
 998 with subproperties given as well.
 999
1000 As opposed to @code{\\override} which overrides the context-dependent
1001 defaults with which a grob is created, this command uses
1002 @code{Output_property_engraver} at the grob acknowledge stage.  This
1003 may be necessary for overriding values set after the initial grob
1004 creation.")
1005    (let ((p (check-grob-path grob-property-path (*location*)
1006                              #:default 'Bottom
1007                              #:min 3)))
1008      (if p
1009          (make-music 'ApplyOutputEvent
1010                      'context-type (first p)
1011                      'procedure
1012                      (lambda (grob orig-context context)
1013                        (if (equal?
1014                             (cdr (assoc 'name (ly:grob-property grob 'meta)))
1015                             (second p))
1016                            (ly:grob-set-nested-property!
1017                             grob (cddr p) value))))
1018          (make-music 'Music))))
1019
1020
1021
1022
1023
1024
1025 %% pageBreak and pageTurn are music functions (iso music indentifiers),
1026 %% because music identifiers are not allowed at top-level.
1027 pageBreak =
1028 #(define-music-function () ()
1029    (_i "Force a page break.  May be used at toplevel (i.e., between scores or
1030 markups), or inside a score.")
1031    (make-music 'EventChord
1032                'page-marker #t
1033                'line-break-permission 'force
1034                'page-break-permission 'force
1035                'elements (list (make-music 'LineBreakEvent
1036                                            'break-permission 'force)
1037                                (make-music 'PageBreakEvent
1038                                            'break-permission 'force))))
1039
1040 pageTurn =
1041 #(define-music-function () ()
1042    (_i "Force a page turn between two scores or top-level markups.")
1043    (make-music 'EventChord
1044                'page-marker #t
1045                'line-break-permission 'force
1046                'page-break-permission 'force
1047                'page-turn-permission 'force
1048                'elements (list (make-music 'LineBreakEvent
1049                                            'break-permission 'force)
1050                                (make-music 'PageBreakEvent
1051                                            'break-permission 'force)
1052                                (make-music 'PageTurnEvent
1053                                            'break-permission 'force))))
1054
1055 parallelMusic =
1056 #(define-void-function (voice-ids music) (list? ly:music?)
1057    (_i "Define parallel music sequences, separated by '|' (bar check signs),
1058 and assign them to the identifiers provided in @var{voice-ids}.
1059
1060 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1061
1062 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1063
1064 Example:
1065
1066 @verbatim
1067   \\parallelMusic #'(A B C) {
1068     c c | d d | e e |
1069     d d | e e | f f |
1070   }
1071 <==>
1072   A = { c c | d d | }
1073   B = { d d | e e | }
1074   C = { e e | f f | }
1075 @end verbatim
1076
1077 The last bar checks in a sequence are not copied to the result in
1078 order to facilitate ending the last entry at non-bar boundaries.
1079 ")
1080    (define voice-count (length voice-ids))
1081    (define (bar-check? m)
1082      "Checks whether m is a bar check."
1083      (eq? (ly:music-property m 'name) 'BarCheck))
1084    (define (recurse-and-split-list lst)
1085      "Return either a list of music lists split along barchecks, or @code{#f}."
1086      (if (any bar-check? lst)
1087          (let* ((voices (apply circular-list (make-list voice-count '())))
1088                 (current-voices voices)
1089                 (current-sequence '()))
1090            ;;
1091            ;; utilities
1092            (define (push-music m)
1093              "Push the music expression into the current sequence"
1094              (set! current-sequence (cons m current-sequence)))
1095            (define (change-voice)
1096              "Store the previously built sequence into the current voice and
1097 change to the following voice."
1098              (set-car! current-voices
1099                        (cons current-sequence
1100                              (car current-voices)))
1101              (set! current-sequence '())
1102              (set! current-voices (cdr current-voices)))
1103            (for-each (lambda (m)
1104                        (let ((split? (recurse-and-split m)))
1105                          (if split?
1106                              (for-each
1107                               (lambda (m)
1108                                 (push-music m)
1109                                 (change-voice))
1110                               split?)
1111                              (begin
1112                                (push-music m)
1113                                (if (bar-check? m) (change-voice))))))
1114                      lst)
1115            (if (pair? current-sequence) (change-voice))
1116            ;; Un-circularize voices
1117            (set! voices (list-head voices voice-count))
1118
1119            ;; Remove trailing bar checks to facilitate ending a
1120            ;; sequence on a non-bar, reverse partial sequences and sequences
1121            (set! voices (map!
1122                          (lambda (l)
1123                            (map! reverse!
1124                                  (reverse!
1125                                   (if (and (pair? l) (pair? (car l))
1126                                            (bar-check? (caar l)))
1127                                       (cons (cdar l) (cdr l))
1128                                       l))))
1129                          voices))
1130
1131            ;; check sequence length
1132            (apply for-each (lambda seqs
1133                              (define (seq-len seq)
1134                                (reduce ly:moment-add
1135                                        (ly:make-moment 0)
1136                                        (map ly:music-length seq)))
1137                              (let ((moment-reference (seq-len (car seqs))))
1138                                (for-each (lambda (seq)
1139                                            (if (not (equal? (seq-len seq)
1140                                                             moment-reference))
1141                                                (ly:music-warning
1142                                                 (if (pair? seq)
1143                                                     (last seq)
1144                                                     (caar seqs))
1145                                                 (_ "Bars in parallel music don't have the same length"))))
1146                                          seqs)))
1147                   voices)
1148            (map concatenate! voices))
1149          (let ((deeper (map recurse-and-split lst)))
1150            (and (any pair? deeper)
1151                 (apply zip (map
1152                             (lambda (m split)
1153                               (or split
1154                                   (ly:music-deep-copy (make-list voice-count m))))
1155                             lst deeper))))))
1156    (define (recurse-and-split music)
1157      "This returns either a list of music split along barchecks, or
1158 @code{#f}."
1159      (let* ((elt (ly:music-property music 'element))
1160             (elts (ly:music-property music 'elements))
1161             (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1162             (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1163        (and (or split-elt split-elts)
1164             (map
1165              (lambda (e es)
1166                (let ((m (ly:music-deep-copy music
1167                        ;;; reassigning the origin of the parent only
1168                        ;;; makes sense if the first expression in the
1169                        ;;; result is from a distributed origin
1170                                             (or (and (ly:music? e) e)
1171                                                 (and (pair? es) (car es))))))
1172                  (if (ly:music? e)
1173                      (set! (ly:music-property m 'element) e))
1174                  (if (pair? es)
1175                      (set! (ly:music-property m 'elements) es))
1176                  m))
1177              (or split-elt (circular-list #f))
1178              (or split-elts (circular-list #f))))))
1179    (let ((voices (recurse-and-split music)))
1180      (if voices
1181          ;;
1182          ;; bind voice identifiers to the voices
1183          (for-each (lambda (voice-id voice)
1184                      (ly:parser-define! voice-id voice))
1185                    voice-ids voices)
1186          (ly:music-warning music
1187                            (_ "ignoring parallel music without barchecks")))))
1188
1189 parenthesize =
1190 #(define-music-function (arg) (ly:music?)
1191    (_i "Tag @var{arg} to be parenthesized.")
1192
1193    (if (memq 'event-chord (ly:music-property arg 'types))
1194        ;; arg is an EventChord -> set the parenthesize property
1195        ;; on all child notes and rests
1196        (for-each
1197         (lambda (ev)
1198           (if (or (memq 'note-event (ly:music-property ev 'types))
1199                   (memq 'rest-event (ly:music-property ev 'types)))
1200               (set! (ly:music-property ev 'parenthesize) #t)))
1201         (ly:music-property arg 'elements))
1202        ;; No chord, simply set property for this expression:
1203        (set! (ly:music-property arg 'parenthesize) #t))
1204    arg)
1205
1206 #(define (make-directed-part-combine-music direction chord-range part1 part2
1207           one-context-settings
1208           two-context-settings
1209           shared-context-settings)
1210
1211    (let* ((pc-music (make-music 'PartCombineMusic))
1212           (m1 (context-spec-music (make-non-relative-music part1) 'Voice "one"))
1213           (m2 (context-spec-music (make-non-relative-music part2) 'Voice "two"))
1214           (listener (ly:parser-lookup 'partCombineListener))
1215           (evs2 (recording-group-emulate m2 listener))
1216           (evs1 (recording-group-emulate m1 listener))
1217           (split-list
1218            (if (and (assoc "one" evs1) (assoc "two" evs2))
1219                (determine-split-list (reverse! (assoc-get "one" evs1) '())
1220                                      (reverse! (assoc-get "two" evs2) '())
1221                                      chord-range)
1222                '()))
1223           (L1 (ly:music-length part1))
1224           (L2 (ly:music-length part2))
1225           ;; keep the contexts alive for the full duration
1226           (skip (make-skip-music (make-duration-of-length
1227                                   (if (ly:moment<? L1 L2) L2 L1)))))
1228
1229      (set! (ly:music-property pc-music 'elements)
1230            (list (make-music
1231                   'PartCombinePartMusic
1232                   'element m1
1233                   'context-change-list
1234                   (make-part-combine-context-changes
1235                    default-part-combine-context-change-state-machine-one
1236                    split-list))
1237                  (make-music
1238                   'PartCombinePartMusic
1239                   'element m2
1240                   'context-change-list
1241                   (make-part-combine-context-changes
1242                    default-part-combine-context-change-state-machine-two
1243                    split-list))))
1244
1245      (set! (ly:music-property pc-music 'direction) direction)
1246
1247      #{ \context Staff <<
1248           \context Voice = "one" \with #one-context-settings { #skip }
1249           \context Voice = "two" \with #two-context-settings { #skip }
1250           \context Voice = "shared" \with #shared-context-settings { #skip }
1251           \context Voice = "solo" { #skip }
1252           \context NullVoice = "null" { #skip }
1253           #pc-music
1254           #(make-part-combine-marks
1255             default-part-combine-mark-state-machine split-list)
1256         >> #} ))
1257
1258 partcombine =
1259 #(define-music-function (chord-range part1 part2)
1260    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1261    (_i "Take the music in @var{part1} and @var{part2} and return
1262 a music expression containing simultaneous voices, where @var{part1}
1263 and @var{part2} are combined into one voice where appropriate.
1264 Optional @var{chord-range} sets the distance in steps between notes
1265 that may be combined into a chord or unison.")
1266    (make-directed-part-combine-music #f chord-range part1 part2
1267     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1268     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1269     #{ #} ))
1270
1271 partcombineUp =
1272 #(define-music-function (chord-range part1 part2)
1273    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1274    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1275 that they share a staff with stems directed upward.")
1276    (make-directed-part-combine-music UP chord-range part1 part2
1277     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1278     #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1279     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1280
1281 partcombineDown =
1282 #(define-music-function (chord-range part1 part2)
1283    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1284    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1285 that they share a staff with stems directed downward.")
1286    (make-directed-part-combine-music DOWN chord-range part1 part2
1287     #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1288     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1289     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1290
1291 partcombineForce =
1292 #(define-music-function (type once) (boolean-or-symbol? boolean?)
1293    (_i "Override the part-combiner.")
1294    (make-music 'EventChord
1295                'elements (list (make-music 'PartCombineForceEvent
1296                                            'forced-type type
1297                                            'once once))))
1298 partcombineApart = \partcombineForce #'apart ##f
1299 partcombineApartOnce = \partcombineForce #'apart ##t
1300 partcombineChords = \partcombineForce #'chords ##f
1301 partcombineChordsOnce = \partcombineForce #'chords ##t
1302 partcombineUnisono = \partcombineForce #'unisono ##f
1303 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1304 partcombineSoloI = \partcombineForce #'solo1 ##f
1305 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1306 partcombineSoloII = \partcombineForce #'solo2 ##f
1307 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1308 partcombineAutomatic = \partcombineForce ##f ##f
1309 partcombineAutomaticOnce = \partcombineForce ##f ##t
1310
1311 partial =
1312 #(define-music-function (dur) (ly:duration?)
1313   (_i "Make a partial measure.")
1314
1315   ;; We use `descend-to-context' here instead of `context-spec-music' to
1316   ;; ensure \partial still works if the Timing_translator is moved
1317     (descend-to-context
1318      (context-spec-music (make-music 'PartialSet
1319                                      'origin (*location*)
1320                                      'duration dur)
1321                          'Timing)
1322      'Score))
1323
1324 pitchedTrill =
1325 #(define-music-function
1326    (main-note secondary-note)
1327    (ly:music? ly:music?)
1328    (_i "Print a trill with @var{main-note} as the main note of the trill and
1329 print @var{secondary-note} as a stemless note head in parentheses.")
1330    (let* ((get-notes (lambda (ev-chord)
1331                        (extract-named-music ev-chord 'NoteEvent)))
1332           (sec-note-events (get-notes secondary-note))
1333           (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1334      (if (pair? sec-note-events)
1335          (begin
1336            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1337                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1338
1339              (if (ly:pitch? trill-pitch)
1340                  (for-each (lambda (m)
1341                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1342                  (begin
1343                    (ly:input-warning (*location*) (_ "Second argument of \\pitchedTrill should be single note: "))
1344                    (display sec-note-events)))
1345
1346              (if (eq? forced #t)
1347                  (for-each (lambda (m)
1348                              (ly:music-set-property! m 'force-accidental forced))
1349                            trill-events)))))
1350      main-note))
1351
1352 pushToTag =
1353 #(define-music-function (tag more music)
1354    (symbol? ly:music? ly:music?)
1355    (_i "Add @var{more} to the front of @code{elements} of all music
1356 expressions in @var{music} that are tagged with @var{tag}.")
1357    (music-map (lambda (m)
1358                 (if (memq tag (ly:music-property m 'tags))
1359                     (set! (ly:music-property m 'elements)
1360                           (cons more (ly:music-property m 'elements))))
1361                 m)
1362               music))
1363
1364 quoteDuring =
1365 #(define-music-function (what main-music) (string? ly:music?)
1366    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
1367 of the quoted voice, as specified in an @code{\\addQuote} command.
1368 @var{main-music} is used to indicate the length of music to be quoted;
1369 usually contains spacers or multi-measure rests.")
1370    (make-music 'QuoteMusic
1371                'element main-music
1372                'quoted-music-name what))
1373
1374 #(ly:expect-warning
1375   (ly:translate-cpp-warning-scheme "identifier name is a keyword: `%s'")
1376   "revert")
1377 revert =
1378 #(define-music-function (grob-property-path)
1379    (symbol-list?)
1380    (_i "Revert the grob property specified by @var{grob-property-path} to
1381 its previous value.  @var{grob-property-path} is a symbol list of the form
1382 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1383 with subproperties given as well.  Because @code{\\revert} is a
1384 reserved word with special syntax in LilyPond input, this music
1385 function will generally only be accessible from Scheme.")
1386    (let ((p (check-grob-path grob-property-path (*location*)
1387                              #:default 'Bottom
1388                              #:min 3)))
1389      (if p
1390          (context-spec-music
1391           (make-music 'RevertProperty
1392                       'symbol (cadr p)
1393                       'origin (*location*)
1394                       'grob-property-path (cddr p))
1395           (car p))
1396          (make-music 'Music))))
1397
1398
1399 relative =
1400 #(define-music-function (pitch music)
1401    ((ly:pitch?) ly:music?)
1402    (_i "Make @var{music} relative to @var{pitch}.  If @var{pitch} is
1403 omitted, the first note in @var{music} is given in absolute pitch.")
1404    ;; When \relative has no clear decision (can only happen with
1405    ;; scales with an even number of steps), it goes down (see
1406    ;; pitch.cc).  The following formula puts out f for both the normal
1407    ;; 7-step scale as well as for a "shortened" scale missing the
1408    ;; final b.  In either case, a first note of c will end up as c,
1409    ;; namely pitch (-1, 0, 0).
1410    (ly:make-music-relative! music
1411                             (or pitch
1412                                 (ly:make-pitch
1413                                  -1
1414                                  (quotient
1415                                   ;; size of current scale:
1416                                   (ly:pitch-steps (ly:make-pitch 1 0))
1417                                   2))))
1418    (make-music 'RelativeOctaveMusic
1419                'element music))
1420
1421 removeWithTag =
1422 #(define-music-function (tags music)
1423    (symbol-list-or-symbol? ly:music?)
1424    (_i "Remove elements of @var{music} that are tagged with one of the
1425 tags in @var{tags}.  @var{tags} may be either a single symbol or a list
1426 of symbols.")
1427    (music-filter
1428     (tags-remove-predicate tags)
1429     music))
1430
1431 resetRelativeOctave =
1432 #(define-music-function (pitch) (ly:pitch?)
1433    (_i "Set the octave inside a \\relative section.")
1434
1435    (make-music 'SequentialMusic
1436                'to-relative-callback
1437                (lambda (music last-pitch) pitch)))
1438
1439 retrograde =
1440 #(define-music-function (music)
1441     (ly:music?)
1442     (_i "Return @var{music} in reverse order.")
1443     (retrograde-music music))
1444
1445 revertTimeSignatureSettings =
1446 #(define-music-function
1447    (time-signature)
1448    (pair?)
1449
1450    (_i "Revert @code{timeSignatureSettings}
1451 for time signatures of @var{time-signature}.")
1452    (revert-time-signature-setting time-signature))
1453
1454 rightHandFinger =
1455 #(define-event-function (finger) (number-or-markup?)
1456    (_i "Apply @var{finger} as a fingering indication.")
1457
1458    (make-music
1459             'StrokeFingerEvent
1460             (if (number? finger) 'digit 'text)
1461             finger))
1462
1463 scaleDurations =
1464 #(define-music-function (fraction music)
1465    (fraction? ly:music?)
1466    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1467    (ly:music-compress music
1468                       (ly:make-moment (car fraction) (cdr fraction))))
1469
1470 settingsFrom =
1471 #(define-scheme-function (ctx music)
1472    ((symbol?) ly:music?)
1473    (_i "Take the layout instruction events from @var{music}, optionally
1474 restricted to those applying to context type @var{ctx}, and return
1475 a context modification duplicating their effect.")
1476    (let ((mods (ly:make-context-mod)))
1477      (define (musicop m)
1478        (if (music-is-of-type? m 'layout-instruction-event)
1479            (ly:add-context-mod
1480             mods
1481             (case (ly:music-property m 'name)
1482               ((PropertySet)
1483                (list 'assign
1484                      (ly:music-property m 'symbol)
1485                      (ly:music-property m 'value)))
1486               ((PropertyUnset)
1487                (list 'unset
1488                      (ly:music-property m 'symbol)))
1489               ((OverrideProperty)
1490                (cons* 'push
1491                       (ly:music-property m 'symbol)
1492                       (ly:music-property m 'grob-value)
1493                       (cond
1494                        ((ly:music-property m 'grob-property #f) => list)
1495                        (else
1496                         (ly:music-property m 'grob-property-path)))))
1497               ((RevertProperty)
1498                (cons* 'pop
1499                       (ly:music-property m 'symbol)
1500                       (cond
1501                        ((ly:music-property m 'grob-property #f) => list)
1502                        (else
1503                         (ly:music-property m 'grob-property-path)))))))
1504            (case (ly:music-property m 'name)
1505              ((ApplyContext)
1506               (ly:add-context-mod mods
1507                                   (list 'apply
1508                                         (ly:music-property m 'procedure))))
1509              ((ContextSpeccedMusic)
1510               (if (or (not ctx)
1511                       (eq? ctx (ly:music-property m 'context-type)))
1512                   (musicop (ly:music-property m 'element))))
1513              (else
1514               (let ((callback (ly:music-property m 'elements-callback)))
1515                 (if (procedure? callback)
1516                     (for-each musicop (callback m))))))))
1517      (musicop music)
1518      mods))
1519
1520 shape =
1521 #(define-music-function (offsets item)
1522    (list? symbol-list-or-music?)
1523    (_i "Offset control-points of @var{item} by @var{offsets}.  The
1524 argument is a list of number pairs or list of such lists.  Each
1525 element of a pair represents an offset to one of the coordinates of a
1526 control-point.  If @var{item} is a string, the result is
1527 @code{\\once\\override} for the specified grob type.  If @var{item} is
1528 a music expression, the result is the same music expression with an
1529 appropriate tweak applied.")
1530    (define (shape-curve grob)
1531      (let* ((orig (ly:grob-original grob))
1532             (siblings (if (ly:spanner? grob)
1533                           (ly:spanner-broken-into orig) '()))
1534             (total-found (length siblings))
1535             (function (assoc-get 'control-points
1536                                  (reverse (ly:grob-basic-properties grob))))
1537             (coords (function grob)))
1538
1539        (define (offset-control-points offsets)
1540          (if (null? offsets)
1541              coords
1542              (map
1543                (lambda (x y) (coord-translate x y))
1544                coords offsets)))
1545
1546        (define (helper sibs offs)
1547          (if (pair? offs)
1548              (if (eq? (car sibs) grob)
1549                  (offset-control-points (car offs))
1550                  (helper (cdr sibs) (cdr offs)))
1551              coords))
1552
1553        ;; we work with lists of lists
1554        (if (or (null? offsets)
1555                (not (list? (car offsets))))
1556            (set! offsets (list offsets)))
1557
1558        (if (>= total-found 2)
1559            (helper siblings offsets)
1560            (offset-control-points (car offsets)))))
1561    (once (tweak 'control-points shape-curve item)))
1562
1563 shiftDurations =
1564 #(define-music-function (dur dots arg)
1565    (integer? integer? ly:music?)
1566    (_i "Change the duration of @var{arg} by adding @var{dur} to the
1567 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1568
1569    (shift-duration-log arg dur dots))
1570
1571 single =
1572 #(define-music-function (overrides music)
1573    (ly:music? ly:music?)
1574    (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1575 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1576    (set! (ly:music-property music 'tweaks)
1577          (fold-some-music
1578           (lambda (m) (eq? (ly:music-property m 'name)
1579                            'OverrideProperty))
1580           (lambda (m tweaks)
1581             (let ((p (cond
1582                       ((ly:music-property m 'grob-property #f) => list)
1583                       (else
1584                        (ly:music-property m 'grob-property-path)))))
1585               (acons (cons (ly:music-property m 'symbol) ;grob name
1586                            (if (pair? (cdr p))
1587                                p ;grob property path
1588                                (car p))) ;grob property
1589                      (ly:music-property m 'grob-value)
1590                      tweaks)))
1591           (ly:music-property music 'tweaks)
1592           overrides))
1593    music)
1594
1595 skip =
1596 #(define-music-function (dur) (ly:duration?)
1597   (_i "Skip forward by @var{dur}.")
1598   (make-music 'SkipMusic
1599               'duration dur))
1600
1601
1602 slashedGrace =
1603 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1604    (_i "Create slashed graces (slashes through stems, but no slur) from
1605 the following music expression"))
1606
1607 spacingTweaks =
1608 #(define-music-function (parameters) (list?)
1609    (_i "Set the system stretch, by reading the 'system-stretch property of
1610 the `parameters' assoc list.")
1611    (overrideProperty
1612     '(Score NonMusicalPaperColumn line-break-system-details)
1613     (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1614           (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))))
1615
1616 styledNoteHeads =
1617 #(define-music-function (style heads music)
1618    (symbol? symbol-list-or-symbol? ly:music?)
1619    (_i "Set @var{heads} in @var{music} to @var{style}.")
1620    (style-note-heads heads style music))
1621
1622 tag =
1623 #(define-music-function (tags music) (symbol-list-or-symbol? ly:music?)
1624    (_i "Tag the following @var{music} with @var{tags} and return the
1625 result, by adding the single symbol or symbol list @var{tags} to the
1626 @code{tags} property of @var{music}.")
1627
1628    (set!
1629     (ly:music-property music 'tags)
1630     ((if (symbol? tags) cons append)
1631      tags
1632      (ly:music-property music 'tags)))
1633    music)
1634
1635 tagGroup =
1636 #(define-void-function (tags) (symbol-list?)
1637    (_i "Define a tag group comprising the symbols in the symbol list
1638 @var{tags}.  Tag groups must not overlap.")
1639    (let ((err (define-tag-group tags)))
1640      (if err (ly:parser-error err (*location*)))))
1641
1642 temporary =
1643 #(define-music-function (music)
1644    (ly:music?)
1645    (_i "Make any @code{\\override} in @var{music} replace an existing
1646 grob property value only temporarily, restoring the old value when a
1647 corresponding @code{\\revert} is executed.  This is achieved by
1648 clearing the @samp{pop-first} property normally set on
1649 @code{\\override}s.
1650
1651 An @code{\\override}/@/@code{\\revert} sequence created by using
1652 @code{\\temporary} and @code{\\undo} on the same music containing
1653 overrides will cancel out perfectly or cause a@tie{}warning.
1654
1655 Non-property-related music is ignored, warnings are generated for any
1656 property-changing music that isn't an @code{\\override}.")
1657    (define warned #f)
1658    (for-some-music
1659     (lambda (m)
1660       (and (or (music-is-of-type? m 'layout-instruction-event)
1661                (music-is-of-type? m 'context-specification)
1662                (music-is-of-type? m 'apply-context)
1663                (music-is-of-type? m 'time-signature-music))
1664            (case (ly:music-property m 'name)
1665              ((OverrideProperty)
1666               (if (ly:music-property m 'pop-first #f)
1667                   (set! (ly:music-property m 'pop-first) '()))
1668               (if (ly:music-property m 'once #f)
1669                   (set! (ly:music-property m 'once) '()))
1670               #t)
1671              ((ContextSpeccedMusic)
1672               #f)
1673              (else
1674               (if (not warned)
1675                   (begin
1676                     (ly:input-warning (*location*) (_ "Cannot make ~a revertible")
1677                                       (ly:music-property m 'name))
1678                     (set! warned #t)))
1679               #t))))
1680     music)
1681    music)
1682
1683 time =
1684 #(define-music-function (beat-structure fraction)
1685    ((number-list? '()) fraction?)
1686    (_i "Set @var{fraction} as time signature, with optional
1687 number list @var{beat-structure} before it.")
1688   (make-music 'TimeSignatureMusic
1689               'numerator (car fraction)
1690               'denominator (cdr fraction)
1691               'beat-structure beat-structure))
1692
1693 times =
1694 #(define-music-function (fraction music)
1695    (fraction? ly:music?)
1696    (_i "Scale @var{music} in time by @var{fraction}.")
1697   (make-music 'TimeScaledMusic
1698               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1699               'numerator (car fraction)
1700               'denominator (cdr fraction)))
1701
1702 transpose =
1703 #(define-music-function
1704    (from to music)
1705    (ly:pitch? ly:pitch? ly:music?)
1706
1707    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1708    (make-music 'TransposedMusic
1709                'element (ly:music-transpose music (ly:pitch-diff to from))))
1710
1711 transposedCueDuring =
1712 #(define-music-function
1713    (what dir pitch main-music)
1714    (string? ly:dir? ly:pitch? ly:music?)
1715
1716    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1717 using the transposition defined by @var{pitch}.  This happens
1718 simultaneously with @var{main-music}, which is usually a rest.  The
1719 argument @var{dir} determines whether the cue notes should be notated
1720 as a first or second voice.")
1721
1722    (make-music 'QuoteMusic
1723                'element main-music
1724                'quoted-context-type 'CueVoice
1725                'quoted-context-id "cue"
1726                'quoted-music-name what
1727                'quoted-voice-direction dir
1728                ;; following is inverse of instrumentTransposition for
1729                ;; historical reasons
1730                'quoted-transposition pitch))
1731
1732 transposition =
1733 #(define-music-function (pitch) (ly:pitch?)
1734    (_i "Set instrument transposition")
1735
1736    (context-spec-music
1737     (make-property-set 'instrumentTransposition pitch)
1738     'Staff))
1739
1740 tuplet =
1741 #(define-music-function (ratio tuplet-span music)
1742    (fraction? (ly:duration? '()) ly:music?)
1743    (_i "Scale the given @var{music} to tuplets.  @var{ratio} is a
1744 fraction that specifies how many notes are played in place of the
1745 nominal value: it will be @samp{3/2} for triplets, namely three notes
1746 being played in place of two.  If the optional duration
1747 @var{tuplet-span} is specified, it is used instead of
1748 @code{tupletSpannerDuration} for grouping the tuplets.
1749 For example,
1750 @example
1751 \\tuplet 3/2 4 @{ c8 c c c c c @}
1752 @end example
1753 will result in two groups of three tuplets, each group lasting for a
1754 quarter note.")
1755    (make-music 'TimeScaledMusic
1756                'element (ly:music-compress
1757                          music
1758                          (ly:make-moment (cdr ratio) (car ratio)))
1759                'numerator (cdr ratio)
1760                'denominator (car ratio)
1761                'duration tuplet-span))
1762
1763 tupletSpan =
1764 #(define-music-function (tuplet-span)
1765    ((ly:duration?))
1766    (_i "Set @code{tupletSpannerDuration}, the length into which
1767 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1768 own will group its tuplets, to the duration @var{tuplet-span}.  To
1769 revert to the default of not subdividing the contents of a @code{\\tuplet}
1770 command without explicit @samp{tuplet-span}, use
1771 @example
1772 \\tupletSpan \\default
1773 @end example
1774 ")
1775    (if tuplet-span
1776        #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1777        #{ \unset tupletSpannerDuration #}))
1778
1779 tweak =
1780 #(define-music-function (prop value item)
1781    (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1782    (_i "Add a tweak to the following @var{item}, usually music.
1783 Layout objects created by @var{item} get their property @var{prop}
1784 set to @var{value}.  If @var{prop} has the form @samp{Grob.property}, like with
1785 @example
1786 \\tweak Accidental.color #red cis'
1787 @end example
1788 an indirectly created grob (@samp{Accidental} is caused by
1789 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1790 are affected.
1791
1792 As a special case, @var{item} may be a symbol list specifying a grob
1793 path, in which case @code{\\override} is called on it instead of
1794 creating tweaked music.  This is mainly useful when using
1795 @code{\\tweak} as as a component for building other functions.
1796
1797 If this use case would call for @code{\\once \\override} rather than a
1798 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1799 convenient.
1800
1801 @var{prop} can contain additional elements in which case a nested
1802 property (inside of an alist) is tweaked.")
1803    (if (ly:music? item)
1804        (let ((p (check-grob-path prop (*location*)
1805                                  #:start 1
1806                                  #:default #t
1807                                  #:min 2)))
1808          (if p
1809              (set! (ly:music-property item 'tweaks)
1810                    (acons (cond ((pair? (cddr p)) p)
1811                                 ((symbol? (car p))
1812                                  (cons (car p) (cadr p)))
1813                                 (else (cadr p)))
1814                           value
1815                           (ly:music-property item 'tweaks))))
1816          item)
1817        (override (append item (if (symbol? prop) (list prop) prop)) value)))
1818
1819 undo =
1820 #(define-music-function (music)
1821    (ly:music?)
1822    (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1823 @code{\\revert} and @code{\\unset}, respectively.  Any reverts and
1824 unsets already in @var{music} cause a warning.  Non-property-related music is ignored.")
1825    (define warned #f)
1826    (let loop
1827        ((music music))
1828      (let
1829          ((lst
1830            (fold-some-music
1831             (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1832                             (music-is-of-type? m 'context-specification)
1833                             (music-is-of-type? m 'apply-context)
1834                             (music-is-of-type? m 'time-signature-music)))
1835             (lambda (m overrides)
1836               (case (ly:music-property m 'name)
1837                 ((OverrideProperty)
1838                  (cons
1839                   (make-music 'RevertProperty
1840                               'symbol (ly:music-property m 'symbol)
1841                               'grob-property-path
1842                               (cond
1843                                ((ly:music-property m 'grob-property #f) => list)
1844                                (else
1845                                 (ly:music-property m 'grob-property-path))))
1846                   overrides))
1847                 ((PropertySet)
1848                  (cons
1849                   (make-music 'PropertyUnset
1850                               'symbol (ly:music-property m 'symbol))
1851                   overrides))
1852                 ((ContextSpeccedMusic)
1853                  (cons
1854                   (make-music 'ContextSpeccedMusic
1855                               'element (loop (ly:music-property m 'element))
1856                               'context-type (ly:music-property m 'context-type))
1857                   overrides))
1858                 (else
1859                  (if (not warned)
1860                      (begin
1861                        (ly:input-warning (*location*) (_ "Cannot revert ~a")
1862                                          (ly:music-property m 'name))
1863                        (set! warned #t)))
1864                  overrides)))
1865             '()
1866             music)))
1867        (cond
1868         ((null? lst) (make-music 'Music))
1869         ((null? (cdr lst)) (car lst))
1870         (else (make-sequential-music lst))))))
1871
1872 unfoldRepeats =
1873 #(define-music-function (music) (ly:music?)
1874    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1875 @code{\\repeat percent} commands in @var{music} to be interpreted
1876 as @code{\\repeat unfold}.")
1877    (unfold-repeats music))
1878
1879 void =
1880 #(define-void-function (arg) (scheme?)
1881    (_i "Accept a scheme argument, return a void expression.
1882 Use this if you want to have a scheme expression evaluated
1883 because of its side-effects, but its value ignored."))
1884
1885 withMusicProperty =
1886 #(define-music-function (sym val music)
1887    (symbol? scheme? ly:music?)
1888    (_i "Set @var{sym} to @var{val} in @var{music}.")
1889
1890    (set! (ly:music-property music sym) val)
1891    music)