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