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.25"
  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 absolute =
  33 #(define-music-function (music)
  34    (ly:music?)
  35    (_i "Make @var{music} absolute.  This does not actually change the
  36 music itself but rather hides it from surrounding @code{\\relative}
  37 and @code{\\fixed} commands.")
  38    (make-music 'RelativeOctaveMusic 'element music))
  39
  40 acciaccatura =
  41 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
  42    (_i "Create an acciaccatura from the following music expression"))
  43
  44 %% keep these two together
  45 instrument-definitions = #'()
  46 addInstrumentDefinition =
  47 #(define-void-function
  48    (name lst) (string? list?)
  49    (_i "Create instrument @var{name} with properties @var{list}.")
  50    (set! instrument-definitions (acons name lst instrument-definitions)))
  51
  52 addQuote =
  53 #(define-void-function (name music) (string? ly:music?)
  54    (_i "Define @var{music} as a quotable music expression named
  55 @var{name}")
  56    (add-quotable name music))
  57
  58 %% keep these two together
  59 afterGraceFraction = 3/4
  60 afterGrace =
  61 #(define-music-function (fraction main grace) ((fraction?) ly:music? ly:music?)
  62    (_i "Create @var{grace} note(s) after a @var{main} music expression.
  63
  64 The musical position of the grace expression is after a
  65 given fraction of the main note's duration has passed.  If
  66 @var{fraction} is not specified as first argument, it is taken from
  67 @code{afterGraceFraction} which has a default value of @code{3/4}.")
  68    (let ((main-length (ly:music-length main))
  69          (fraction (or fraction (ly:parser-lookup 'afterGraceFraction))))
  70      (descend-to-context
  71       (make-simultaneous-music
  72        (list
  73         main
  74         (make-sequential-music
  75          (list
  76           (make-music 'SkipMusic
  77                       'duration (ly:make-duration
  78                                  0 0
  79                                  (* (ly:moment-main main-length)
  80                                     (/ (car fraction) (cdr fraction)))))
  81           (make-music 'GraceMusic
  82                       'element grace)))))
  83       'Bottom)))
  84
  85
  86 %% music identifiers not allowed at top-level,
  87 %% so this is a music-function instead.
  88 allowPageTurn =
  89 #(define-music-function () ()
  90    (_i "Allow a page turn. May be used at toplevel (ie between scores or
  91 markups), or inside a score.")
  92    (make-music 'EventChord
  93                'page-marker #t
  94                'page-turn-permission 'allow
  95                'elements (list (make-music 'PageTurnEvent
  96                                            'break-permission 'allow))))
  97
  98 alterBroken =
  99 #(define-music-function (property arg item)
 100   (key-list-or-symbol? list? key-list-or-music?)
 101   (_i "Override @var{property} for pieces of broken spanner @var{item}
 102 with values @var{arg}.  @var{item} may either be music in the form of
 103 a starting spanner event, or a symbol list in the form
 104 @samp{Context.Grob} or just @samp{Grob}.  Iff @var{item} is in the
 105 form of a spanner event, @var{property} may also have the form
 106 @samp{Grob.property} for specifying a directed tweak.")
 107   (if (ly:music? item)
 108       (if (or (eqv? (ly:music-property item 'span-direction) START)
 109               (music-is-of-type? item 'tie-event))
 110           (tweak property (value-for-spanner-piece arg) item)
 111           (begin
 112             (ly:music-warning item (_ "not a spanner"))
 113             item))
 114       (let* ((p (check-grob-path item (*location*)
 115                                  #:default 'Bottom
 116                                  #:min 2
 117                                  #:max 2))
 118              (name (and p (second p)))
 119              (description
 120               (and name (assoc-get name all-grob-descriptions))))
 121         (if (and description
 122                  (member 'spanner-interface
 123                          (assoc-get 'interfaces
 124                                     (assoc-get 'meta description))))
 125             (propertyOverride (append item (if (symbol? property)
 126                                        (list property)
 127                                        property))
 128                       (value-for-spanner-piece arg))
 129             (begin
 130               (ly:input-warning (*location*) (_ "not a spanner name, `~a'") name)
 131               (make-music 'Music))))))
 132
 133 appendToTag =
 134 #(define-music-function (tag more music)
 135    (symbol? ly:music? ly:music?)
 136    (_i "Append @var{more} to the @code{elements} of all music
 137 expressions in @var{music} that are tagged with @var{tag}.")
 138    (music-map (lambda (m)
 139                 (if (memq tag (ly:music-property m 'tags))
 140                     (set! (ly:music-property m 'elements)
 141                           (append (ly:music-property m 'elements)
 142                                   (list more))))
 143                 m)
 144               music))
 145
 146 applyContext =
 147 #(define-music-function (proc) (procedure?)
 148    (_i "Modify context properties with Scheme procedure @var{proc}.")
 149    (make-music 'ApplyContext
 150                'procedure proc))
 151
 152 applyMusic =
 153 #(define-music-function (func music) (procedure? ly:music?)
 154    (_i"Apply procedure @var{func} to @var{music}.")
 155    (func music))
 156
 157 applyOutput =
 158 #(define-music-function (target proc) (symbol-list-or-symbol? procedure?)
 159    (_i "Apply function @code{proc} to every layout object matched by
 160 @var{target} which takes the form @code{Context} or @code{Context.Grob}.")
 161    (let ((p (check-grob-path target (*location*) #:max 2)))
 162      (if p
 163          (make-music 'ApplyOutputEvent
 164                      'procedure proc
 165                      'context-type (car p)
 166                      (if (pair? (cdr p))
 167                          (list (cons 'symbol (cadr p)))
 168                          '()))
 169          (make-music 'Music))))
 170
 171 appoggiatura =
 172 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
 173    (_i "Create an appoggiatura from @var{music}"))
 174
 175 % for regression testing purposes.
 176 assertBeamQuant =
 177 #(define-music-function (l r) (pair? pair?)
 178    (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
 179    (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
 180
 181 % for regression testing purposes.
 182 assertBeamSlope =
 183 #(define-music-function (comp) (procedure?)
 184    (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
 185    (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
 186
 187 autochange =
 188 #(define-music-function (pitch clef-1 clef-2 music)
 189   ((ly:pitch? (ly:make-pitch 0 0)) (ly:context-mod?)(ly:context-mod?) ly:music?)
 190   (_i "Make voices that switch between staves automatically.  As an option the
 191 pitch where to switch staves may be specified.  The clefs for the staves are
 192 optional as well.  Setting clefs  works only for implicitly instantiated
 193 staves.")
 194   (let ;; keep the contexts alive for the full duration
 195        ((skip (make-duration-of-length (ly:music-length music)))
 196         (clef-1 (or clef-1 #{ \with { \clef "treble" } #}))
 197         (clef-2 (or clef-2 #{ \with { \clef "bass" } #})))
 198     (make-simultaneous-music
 199      (list
 200       (descend-to-context (make-autochange-music pitch music) 'Staff
 201                           "up" clef-1)
 202       (context-spec-music (make-skip-music skip) 'Staff
 203                           "up" clef-1)
 204       (context-spec-music (make-skip-music skip) 'Staff
 205                           "down" clef-2)))))
 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 (propertyTweak '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    (propertyTweak '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 (label) ((number-or-markup?))
 834    "Make the music for the \\mark command."
 835    (if label
 836        (make-music 'MarkEvent 'label label)
 837        (make-music 'MarkEvent)))
 838
 839 markupMap =
 840 #(define-music-function (path markupfun music)
 841    (symbol-list-or-symbol? markup-function? ly:music?)
 842    (_i "This applies the given markup function @var{markupfun} to all markup
 843 music properties matching @var{path} in @var{music}.
 844
 845 For example,
 846 @example
 847 \\new Voice @{ g'2 c'' @}
 848 \\addlyrics @{
 849   \\markupMap LyricEvent.text
 850              \\markup \\with-color #red \\etc
 851              @{ Oh yes! @}
 852 @}
 853 @end example
 854 ")
 855    (let* ((p (check-music-path path (*location*)))
 856           (name (and p (car p)))
 857           (prop (and p (cadr p))))
 858      (if p
 859          (for-some-music
 860           (lambda (m)
 861             (if (or (not name) (eq? (ly:music-property m 'name) name))
 862                 (let ((text (ly:music-property m prop)))
 863                   (if (markup? text)
 864                       (set! (ly:music-property m prop)
 865                             (list markupfun text)))))
 866             #f)
 867           music)))
 868    music)
 869
 870 musicMap =
 871 #(define-music-function (proc mus) (procedure? ly:music?)
 872    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 873    (music-map proc mus))
 874
 875 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 876 %% because music identifiers are not allowed at top-level.
 877 noPageBreak =
 878 #(define-music-function () ()
 879    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 880 markups), or inside a score.")
 881    (make-music 'EventChord
 882                'page-marker #t
 883                'page-break-permission 'forbid
 884                'elements (list (make-music 'PageBreakEvent
 885                                            'break-permission '()))))
 886
 887 noPageTurn =
 888 #(define-music-function () ()
 889    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 890 markups), or inside a score.")
 891    (make-music 'EventChord
 892                'page-marker #t
 893                'page-turn-permission 'forbid
 894                'elements (list (make-music 'PageTurnEvent
 895                                            'break-permission '()))))
 896
 897
 898
 899 octaveCheck =
 900 #(define-music-function (pitch) (ly:pitch?)
 901    (_i "Octave check.")
 902    (make-music 'RelativeOctaveCheck
 903                'pitch pitch))
 904
 905 offset =
 906 #(define-music-function (property offsets item)
 907   (symbol-list-or-symbol? scheme? key-list-or-music?)
 908    (_i "Offset the default value of @var{property} of @var{item} by
 909 @var{offsets}.  If @var{item} is a string, the result is
 910 @code{\\override} for the specified grob type.  If @var{item} is
 911 a music expression, the result is the same music expression with an
 912 appropriate tweak applied.")
 913   (if (ly:music? item)
 914       ; In case of a tweak, grob property path is Grob.property
 915       (let ((prop-path (check-grob-path
 916                          (if (symbol? property)
 917                              (list property)
 918                              property) (*location*)
 919                          #:start 1 #:default #t #:min 2 #:max 2)))
 920         (if prop-path
 921             ; If the head of the grob property path is a symbol--i.e.,
 922             ; a grob name, produce a directed tweak.  Otherwise, create
 923             ; an ordinary tweak.
 924             (if (symbol? (car prop-path))
 925                 (tweak prop-path (offsetter (second prop-path) offsets) item)
 926                 (tweak (second prop-path)
 927                        (offsetter (second prop-path) offsets)
 928                        item))
 929             item))
 930       ; In case of an override, grob property path is Context.Grob.property.
 931       (let ((prop-path (check-grob-path
 932                          (append item
 933                                  (if (symbol? property)
 934                                      (list property)
 935                                      property)) (*location*)
 936                          #:default 'Bottom #:min 3 #:max 3)))
 937         (if prop-path
 938             (propertyOverride prop-path (offsetter (third prop-path) offsets))
 939             (make-music 'Music)))))
 940
 941 omit =
 942 #(define-music-function (item) (symbol-list-or-music?)
 943    (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
 944 effectively omitting it without taking up space.
 945
 946 If @var{item} is a symbol list of form @code{GrobName} or
 947 @code{Context.GrobName}, the result is an override for the grob name
 948 specified by it.  If @var{item} is a music expression, the result is
 949 the same music expression with an appropriate tweak applied to it.")
 950    (propertyTweak 'stencil #f item))
 951
 952 once =
 953 #(define-music-function (music) (ly:music?)
 954    (_i "Set @code{once} to @code{#t} on all layout instruction events
 955 in @var{music}.  This will complain about music with an actual
 956 duration.  As a special exception, if @var{music} contains
 957 @samp{tweaks} it will be silently ignored in order to allow for
 958 @code{\\once \\propertyTweak} to work as both one-time override and proper
 959 tweak.")
 960    (if (not (pair? (ly:music-property music 'tweaks)))
 961        (for-some-music
 962         (lambda (m)
 963           (cond ((music-is-of-type? m 'layout-instruction-event)
 964                  (set! (ly:music-property m 'once) #t)
 965                  #t)
 966                 ((ly:duration? (ly:music-property m 'duration))
 967                  (ly:music-warning m (_ "Cannot apply \\once to timed music"))
 968                  #t)
 969                 (else #f)))
 970         music))
 971    music)
 972
 973 ottava =
 974 #(define-music-function (octave) (integer?)
 975    (_i "Set the octavation.")
 976    (make-music 'OttavaMusic
 977                'ottava-number octave))
 978
 979 overrideTimeSignatureSettings =
 980 #(define-music-function
 981    (time-signature base-moment beat-structure beam-exceptions)
 982    (fraction? fraction? list? list?)
 983
 984    (_i "Override @code{timeSignatureSettings}
 985 for time signatures of @var{time-signature} to have settings
 986 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 987
 988    ;; TODO -- add warning if largest value of grouping is
 989    ;;       greater than time-signature.
 990   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 991     (override-time-signature-setting time-signature setting)))
 992
 993 overrideProperty =
 994 #(define-music-function (grob-property-path value)
 995    (key-list? scheme?)
 996
 997    (_i "Set the grob property specified by @var{grob-property-path} to
 998 @var{value}.  @var{grob-property-path} is a symbol list of the form
 999 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1000 with subproperties given as well.
1001
1002 As opposed to @code{\\override} which overrides the context-dependent
1003 defaults with which a grob is created, this command uses
1004 @code{Output_property_engraver} at the grob acknowledge stage.  This
1005 may be necessary for overriding values set after the initial grob
1006 creation.")
1007    (let ((p (check-grob-path grob-property-path (*location*)
1008                              #:default 'Bottom
1009                              #:min 3)))
1010      (if p
1011          (make-music 'ApplyOutputEvent
1012                      'context-type (first p)
1013                      'symbol (second p)
1014                      'procedure
1015                      (lambda (grob orig-context context)
1016                        (ly:grob-set-nested-property! grob (cddr p) value)))
1017          (make-music 'Music))))
1018
1019
1020
1021
1022
1023
1024 %% pageBreak and pageTurn are music functions (iso music indentifiers),
1025 %% because music identifiers are not allowed at top-level.
1026 pageBreak =
1027 #(define-music-function () ()
1028    (_i "Force a page break.  May be used at toplevel (i.e., between scores or
1029 markups), or inside a score.")
1030    (make-music 'EventChord
1031                'page-marker #t
1032                'line-break-permission 'force
1033                'page-break-permission 'force
1034                'elements (list (make-music 'LineBreakEvent
1035                                            'break-permission 'force)
1036                                (make-music 'PageBreakEvent
1037                                            'break-permission 'force))))
1038
1039 pageTurn =
1040 #(define-music-function () ()
1041    (_i "Force a page turn between two scores or top-level markups.")
1042    (make-music 'EventChord
1043                'page-marker #t
1044                'line-break-permission 'force
1045                'page-break-permission 'force
1046                'page-turn-permission 'force
1047                'elements (list (make-music 'LineBreakEvent
1048                                            'break-permission 'force)
1049                                (make-music 'PageBreakEvent
1050                                            'break-permission 'force)
1051                                (make-music 'PageTurnEvent
1052                                            'break-permission 'force))))
1053
1054 parallelMusic =
1055 #(define-void-function (voice-ids music) (list? ly:music?)
1056    (_i "Define parallel music sequences, separated by '|' (bar check signs),
1057 and assign them to the identifiers provided in @var{voice-ids}.
1058
1059 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1060
1061 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1062
1063 Example:
1064
1065 @verbatim
1066   \\parallelMusic #'(A B C) {
1067     c c | d d | e e |
1068     d d | e e | f f |
1069   }
1070 <==>
1071   A = { c c | d d }
1072   B = { d d | e e }
1073   C = { e e | f f }
1074 @end verbatim
1075
1076 The last bar checks in a sequence are not copied to the result in
1077 order to facilitate ending the last entry at non-bar boundaries.
1078 ")
1079    (define voice-count (length voice-ids))
1080    (define (bar-check? m)
1081      "Checks whether m is a bar check."
1082      (eq? (ly:music-property m 'name) 'BarCheck))
1083    (define (recurse-and-split-list lst)
1084      "Return either a list of music lists split along barchecks, or @code{#f}."
1085      (if (any bar-check? lst)
1086          (let* ((voices (apply circular-list (make-list voice-count '())))
1087                 (current-voices voices)
1088                 (current-sequence '()))
1089            ;;
1090            ;; utilities
1091            (define (push-music m)
1092              "Push the music expression into the current sequence"
1093              (set! current-sequence (cons m current-sequence)))
1094            (define (change-voice)
1095              "Store the previously built sequence into the current voice and
1096 change to the following voice."
1097              (set-car! current-voices
1098                        (cons current-sequence
1099                              (car current-voices)))
1100              (set! current-sequence '())
1101              (set! current-voices (cdr current-voices)))
1102            (for-each (lambda (m)
1103                        (let ((split? (recurse-and-split m)))
1104                          (if split?
1105                              (for-each
1106                               (lambda (m)
1107                                 (push-music m)
1108                                 (change-voice))
1109                               split?)
1110                              (begin
1111                                (push-music m)
1112                                (if (bar-check? m) (change-voice))))))
1113                      lst)
1114            (if (pair? current-sequence) (change-voice))
1115            ;; Un-circularize voices
1116            (set! voices (list-head voices voice-count))
1117
1118            ;; Remove trailing bar checks to facilitate ending a
1119            ;; sequence on a non-bar, reverse partial sequences and sequences
1120            (set! voices (map!
1121                          (lambda (l)
1122                            (map! reverse!
1123                                  (reverse!
1124                                   (if (and (pair? l) (pair? (car l))
1125                                            (bar-check? (caar l)))
1126                                       (cons (cdar l) (cdr l))
1127                                       l))))
1128                          voices))
1129
1130            ;; check sequence length
1131            (apply for-each (lambda seqs
1132                              (define (seq-len seq)
1133                                (reduce ly:moment-add
1134                                        (ly:make-moment 0)
1135                                        (map ly:music-length seq)))
1136                              (let ((moment-reference (seq-len (car seqs))))
1137                                (for-each (lambda (seq)
1138                                            (if (not (equal? (seq-len seq)
1139                                                             moment-reference))
1140                                                (ly:music-warning
1141                                                 (if (pair? seq)
1142                                                     (last seq)
1143                                                     (caar seqs))
1144                                                 (_ "Bars in parallel music don't have the same length"))))
1145                                          seqs)))
1146                   voices)
1147            (map concatenate! voices))
1148          (let ((deeper (map recurse-and-split lst)))
1149            (and (any pair? deeper)
1150                 (apply zip (map
1151                             (lambda (m split)
1152                               (or split
1153                                   (ly:music-deep-copy (make-list voice-count m))))
1154                             lst deeper))))))
1155    (define (recurse-and-split music)
1156      "This returns either a list of music split along barchecks, or
1157 @code{#f}."
1158      (let* ((elt (ly:music-property music 'element))
1159             (elts (ly:music-property music 'elements))
1160             (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1161             (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1162        (and (or split-elt split-elts)
1163             (map
1164              (lambda (e es)
1165                (let ((m (ly:music-deep-copy music
1166                        ;;; reassigning the origin of the parent only
1167                        ;;; makes sense if the first expression in the
1168                        ;;; result is from a distributed origin
1169                                             (or (and (ly:music? e) e)
1170                                                 (and (pair? es) (car es))))))
1171                  (if (ly:music? e)
1172                      (set! (ly:music-property m 'element) e))
1173                  (if (pair? es)
1174                      (set! (ly:music-property m 'elements) es))
1175                  m))
1176              (or split-elt (circular-list #f))
1177              (or split-elts (circular-list #f))))))
1178    (let ((voices (recurse-and-split music)))
1179      (if voices
1180          ;;
1181          ;; bind voice identifiers to the voices
1182          (for-each (lambda (voice-id voice)
1183                      (ly:parser-define! voice-id voice))
1184                    voice-ids voices)
1185          (ly:music-warning music
1186                            (_ "ignoring parallel music without barchecks")))))
1187
1188 parenthesize =
1189 #(define-music-function (arg) (ly:music?)
1190    (_i "Tag @var{arg} to be parenthesized.")
1191
1192    (if (memq 'event-chord (ly:music-property arg 'types))
1193        ;; arg is an EventChord -> set the parenthesize property
1194        ;; on all child notes and rests
1195        (for-each
1196         (lambda (ev)
1197           (if (or (memq 'note-event (ly:music-property ev 'types))
1198                   (memq 'rest-event (ly:music-property ev 'types)))
1199               (set! (ly:music-property ev 'parenthesize) #t)))
1200         (ly:music-property arg 'elements))
1201        ;; No chord, simply set property for this expression:
1202        (set! (ly:music-property arg 'parenthesize) #t))
1203    arg)
1204
1205 #(define (make-directed-part-combine-music direction chord-range part1 part2
1206           one-context-settings
1207           two-context-settings
1208           shared-context-settings)
1209
1210    (let* ((pc-music (make-music 'PartCombineMusic))
1211           (m1 (context-spec-music (make-non-relative-music part1) 'Voice "one"))
1212           (m2 (context-spec-music (make-non-relative-music part2) 'Voice "two"))
1213           (listener (ly:parser-lookup 'partCombineListener))
1214           (evs2 (recording-group-emulate m2 listener))
1215           (evs1 (recording-group-emulate m1 listener))
1216           (split-list
1217            (if (and (assoc "one" evs1) (assoc "two" evs2))
1218                (determine-split-list (reverse! (assoc-get "one" evs1) '())
1219                                      (reverse! (assoc-get "two" evs2) '())
1220                                      chord-range)
1221                '()))
1222           (L1 (ly:music-length part1))
1223           (L2 (ly:music-length part2))
1224           ;; keep the contexts alive for the full duration
1225           (skip (make-skip-music (make-duration-of-length
1226                                   (if (ly:moment<? L1 L2) L2 L1)))))
1227
1228      (set! (ly:music-property pc-music 'elements)
1229            (list (make-music
1230                   'PartCombinePartMusic
1231                   'element m1
1232                   'context-change-list
1233                   (make-part-combine-context-changes
1234                    default-part-combine-context-change-state-machine-one
1235                    split-list))
1236                  (make-music
1237                   'PartCombinePartMusic
1238                   'element m2
1239                   'context-change-list
1240                   (make-part-combine-context-changes
1241                    default-part-combine-context-change-state-machine-two
1242                    split-list))))
1243
1244      (set! (ly:music-property pc-music 'direction) direction)
1245
1246      #{ \context Staff <<
1247           \context Voice = "one" \with #one-context-settings { #skip }
1248           \context Voice = "two" \with #two-context-settings { #skip }
1249           \context Voice = "shared" \with #shared-context-settings { #skip }
1250           \context Voice = "solo" { #skip }
1251           \context NullVoice = "null" { #skip }
1252           #pc-music
1253           #(make-part-combine-marks
1254             default-part-combine-mark-state-machine split-list)
1255         >> #} ))
1256
1257 partcombine =
1258 #(define-music-function (chord-range part1 part2)
1259    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1260    (_i "Take the music in @var{part1} and @var{part2} and return
1261 a music expression containing simultaneous voices, where @var{part1}
1262 and @var{part2} are combined into one voice where appropriate.
1263 Optional @var{chord-range} sets the distance in steps between notes
1264 that may be combined into a chord or unison.")
1265    (make-directed-part-combine-music #f chord-range part1 part2
1266     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1267     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1268     #{ #} ))
1269
1270 partcombineUp =
1271 #(define-music-function (chord-range part1 part2)
1272    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1273    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1274 that they share a staff with stems directed upward.")
1275    (make-directed-part-combine-music UP chord-range part1 part2
1276     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1277     #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1278     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1279
1280 partcombineDown =
1281 #(define-music-function (chord-range part1 part2)
1282    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1283    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1284 that they share a staff with stems directed downward.")
1285    (make-directed-part-combine-music DOWN chord-range part1 part2
1286     #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1287     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1288     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1289
1290 %% Part combine forcing to be found in ly/property-init.ly
1291
1292 partial =
1293 #(define-music-function (dur) (ly:duration?)
1294   (_i "Make a partial measure.")
1295
1296   ;; We use `descend-to-context' here instead of `context-spec-music' to
1297   ;; ensure \partial still works if the Timing_translator is moved
1298     (descend-to-context
1299      (context-spec-music (make-music 'PartialSet
1300                                      'origin (*location*)
1301                                      'duration dur)
1302                          'Timing)
1303      'Score))
1304
1305 pitchedTrill =
1306 #(define-music-function
1307    (main-note secondary-note)
1308    (ly:music? ly:music?)
1309    (_i "Print a trill with @var{main-note} as the main note of the trill and
1310 print @var{secondary-note} as a stemless note head in parentheses.")
1311    (let* ((get-notes (lambda (ev-chord)
1312                        (extract-named-music ev-chord 'NoteEvent)))
1313           (sec-note-events (get-notes secondary-note))
1314           (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1315      (if (pair? sec-note-events)
1316          (begin
1317            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1318                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1319
1320              (if (ly:pitch? trill-pitch)
1321                  (for-each (lambda (m)
1322                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1323                  (begin
1324                    (ly:input-warning (*location*) (_ "Second argument of \\pitchedTrill should be single note: "))
1325                    (display sec-note-events)))
1326
1327              (if (eq? forced #t)
1328                  (for-each (lambda (m)
1329                              (ly:music-set-property! m 'force-accidental forced))
1330                            trill-events)))))
1331      main-note))
1332
1333 propertyOverride =
1334 #(define-music-function (grob-property-path value)
1335    (key-list? scheme?)
1336    (_i "Set the grob property specified by @var{grob-property-path} to
1337 @var{value}.  @var{grob-property-path} is a symbol list of the form
1338 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1339 with subproperties given as well.  This music function is mostly intended
1340 for use from Scheme as a substitute for the built-in @code{\\override}
1341 command.")
1342    (let ((p (check-grob-path grob-property-path (*location*)
1343                              #:default 'Bottom
1344                              #:min 3)))
1345      (if p
1346          (context-spec-music
1347           (make-music 'OverrideProperty
1348                       'symbol (cadr p)
1349                       'origin (*location*)
1350                       'grob-value value
1351                       'grob-property-path (cddr p)
1352                       'pop-first #t)
1353           (car p))
1354          (make-music 'Music))))
1355
1356 propertyRevert =
1357 #(define-music-function (grob-property-path)
1358    (key-list?)
1359    (_i "Revert the grob property specified by @var{grob-property-path} to
1360 its previous value.  @var{grob-property-path} is a symbol list of the form
1361 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1362 with subproperties given as well.  This music function is mostly intended
1363 for use from Scheme as a substitute for the built-in @code{\\revert}
1364 command.")
1365    (let ((p (check-grob-path grob-property-path (*location*)
1366                              #:default 'Bottom
1367                              #:min 3)))
1368      (if p
1369          (context-spec-music
1370           (make-music 'RevertProperty
1371                       'symbol (cadr p)
1372                       'origin (*location*)
1373                       'grob-property-path (cddr p))
1374           (car p))
1375          (make-music 'Music))))
1376
1377 propertySet =
1378 #(define-music-function (property-path value)
1379    (symbol-list-or-symbol? scheme?)
1380    (_i "Set the context property specified by @var{property-path} to
1381 @var{value}.  This music function is mostly intended for use from
1382 Scheme as a substitute for the built-in @code{\\set} command.")
1383    (let ((p (check-context-path property-path (*location*))))
1384      (if p
1385          (context-spec-music
1386           (make-music 'PropertySet
1387                       'symbol (cadr p)
1388                       'value value
1389                       'origin (*location*))
1390           (car p))
1391          (make-music 'Music))))
1392
1393 propertyTweak =
1394 #(define-music-function (prop value item)
1395    (key-list-or-symbol? scheme? key-list-or-music?)
1396    (_i "Add a tweak to the following @var{item}, usually music.
1397 This generally behaves like @code{\\tweak} but will turn into an
1398 @code{\\override} when @var{item} is a symbol list.
1399
1400 In that case, @var{item} specifies the grob path to override.  This is
1401 mainly useful when using @code{\\propertyTweak} as as a component for
1402 building other functions like @code{\\omit}.  It is not the default
1403 behavior for @code{\\tweak} since many input strings in
1404 @code{\\lyricmode} can serve equally as music or as symbols which
1405 causes surprising behavior when tweaking lyrics using the less
1406 specific semantics of @code{\\propertyTweak}.
1407
1408 @var{prop} can contain additional elements in which case a nested
1409 property (inside of an alist) is tweaked.")
1410    ;; Why not instead make the parser treat strings preferably as
1411    ;; music in lyrics mode rather than as symbol?  Because then
1412    ;;
1413    ;; \tweak text "whatever" mylyrics
1414    ;;
1415    ;; will try putting a lyric event with text "whatever" in the text
1416    ;; property of lyrics.  So we want expressions allowing both
1417    ;; strings and lyrics to deliver strings: more complex conversions
1418    ;; should only be attempted when the simple uses don't match the
1419    ;; given predicate.
1420    (if (ly:music? item)
1421        (if (music-is-of-type? item 'context-specification)
1422            ;; This is essentially dealing with the case
1423            ;; \propertyTweak color #red \propertyTweak font-size #3 NoteHead
1424            ;; namely when stacked tweaks end in a symbol list
1425            ;; rather than a music expression.
1426            ;;
1427            ;; We have a tweak here to convert into an override,
1428            ;; so we need to know the grob to apply it to.  That's
1429            ;; easy if we have a directed tweak, and otherwise we
1430            ;; need to find the symbol in the expression itself.
1431            (let* ((p (check-grob-path prop (*location*)
1432                                       #:start 1
1433                                       #:default #t
1434                                       #:min 2))
1435                   (elt (ly:music-property item 'element))
1436                   (seq (if (music-is-of-type? elt 'sequential-music)
1437                            elt
1438                            (make-sequential-music (list elt))))
1439                   (elts (ly:music-property seq 'elements))
1440                   (symbol (if (symbol? (car p))
1441                               (car p)
1442                               (and (pair? elts)
1443                                    (ly:music-property (car elts)
1444                                                       'symbol)))))
1445              (if (symbol? symbol)
1446                  (begin
1447                    (set! (ly:music-property seq 'elements)
1448                          (cons (make-music 'OverrideProperty
1449                                            'symbol symbol
1450                                            'grob-property-path (cdr p)
1451                                            'pop-first #t
1452                                            'grob-value value
1453                                            'origin (*location*))
1454                                elts))
1455                    (set! (ly:music-property item 'element) seq))
1456                  (begin
1457                    (ly:parser-error (_ "Cannot \\propertyTweak")
1458                                     (*location*))
1459                    (ly:music-message item (_ "untweakable"))))
1460              item)
1461            (tweak prop value item))
1462        (propertyOverride (append item (if (symbol? prop) (list prop) prop))
1463                          value)))
1464
1465 propertyUnset =
1466 #(define-music-function (property-path)
1467    (symbol-list-or-symbol?)
1468    (_i "Unset the context property specified by @var{property-path}.
1469 This music function is mostly intended for use from Scheme as a
1470 substitute for the built-in @code{\\unset} command.")
1471    (let ((p (check-context-path property-path (*location*))))
1472      (if p
1473          (context-spec-music
1474           (make-music 'PropertyUnset
1475                       'symbol (cadr p)
1476                       'origin (*location*))
1477           (car p))
1478          (make-music 'Music))))
1479
1480 pushToTag =
1481 #(define-music-function (tag more music)
1482    (symbol? ly:music? ly:music?)
1483    (_i "Add @var{more} to the front of @code{elements} of all music
1484 expressions in @var{music} that are tagged with @var{tag}.")
1485    (music-map (lambda (m)
1486                 (if (memq tag (ly:music-property m 'tags))
1487                     (set! (ly:music-property m 'elements)
1488                           (cons more (ly:music-property m 'elements))))
1489                 m)
1490               music))
1491
1492 quoteDuring =
1493 #(define-music-function (what main-music) (string? ly:music?)
1494    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
1495 of the quoted voice, as specified in an @code{\\addQuote} command.
1496 @var{main-music} is used to indicate the length of music to be quoted;
1497 usually contains spacers or multi-measure rests.")
1498    (make-music 'QuoteMusic
1499                'element main-music
1500                'quoted-music-name what))
1501
1502 reduceChords =
1503 #(define-music-function (music) (ly:music?)
1504    (_i "Reduce chords contained in @var{music} to single notes,
1505 intended mainly for reusing music in RhythmicStaff.  Does not
1506 reduce parallel music.")
1507    (event-chord-reduce music))
1508
1509 relative =
1510 #(define-music-function (pitch music)
1511    ((ly:pitch?) ly:music?)
1512    (_i "Make @var{music} relative to @var{pitch}.  If @var{pitch} is
1513 omitted, the first note in @var{music} is given in absolute pitch.")
1514    ;; When \relative has no clear decision (can only happen with
1515    ;; scales with an even number of steps), it goes down (see
1516    ;; pitch.cc).  The following formula puts out f for both the normal
1517    ;; 7-step scale as well as for a "shortened" scale missing the
1518    ;; final b.  In either case, a first note of c will end up as c,
1519    ;; namely pitch (-1, 0, 0).
1520    (ly:make-music-relative! music
1521                             (or pitch
1522                                 (ly:make-pitch
1523                                  -1
1524                                  (quotient
1525                                   ;; size of current scale:
1526                                   (ly:pitch-steps (ly:make-pitch 1 0))
1527                                   2))))
1528    (make-music 'RelativeOctaveMusic
1529                'element music))
1530
1531 removeWithTag =
1532 #(define-music-function (tags music)
1533    (symbol-list-or-symbol? ly:music?)
1534    (_i "Remove elements of @var{music} that are tagged with one of the
1535 tags in @var{tags}.  @var{tags} may be either a single symbol or a list
1536 of symbols.")
1537    (music-filter
1538     (tags-remove-predicate tags)
1539     music))
1540
1541 resetRelativeOctave =
1542 #(define-music-function (pitch) (ly:pitch?)
1543    (_i "Set the octave inside a \\relative section.")
1544
1545    (make-music 'SequentialMusic
1546                'to-relative-callback
1547                (lambda (music last-pitch) pitch)))
1548
1549 retrograde =
1550 #(define-music-function (music)
1551     (ly:music?)
1552     (_i "Return @var{music} in reverse order.")
1553     (retrograde-music
1554      (expand-repeat-notes!
1555       (expand-repeat-chords!
1556        (cons 'rhythmic-event
1557              (ly:parser-lookup '$chord-repeat-events))
1558        music))))
1559
1560 revertTimeSignatureSettings =
1561 #(define-music-function
1562    (time-signature)
1563    (pair?)
1564
1565    (_i "Revert @code{timeSignatureSettings}
1566 for time signatures of @var{time-signature}.")
1567    (revert-time-signature-setting time-signature))
1568
1569 rightHandFinger =
1570 #(define-event-function (finger) (number-or-markup?)
1571    (_i "Apply @var{finger} as a fingering indication.")
1572
1573    (make-music
1574             'StrokeFingerEvent
1575             (if (number? finger) 'digit 'text)
1576             finger))
1577
1578 scaleDurations =
1579 #(define-music-function (fraction music)
1580    (fraction? ly:music?)
1581    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1582    (ly:music-compress music
1583                       (ly:make-moment (car fraction) (cdr fraction))))
1584
1585 settingsFrom =
1586 #(define-scheme-function (ctx music)
1587    ((symbol?) ly:music?)
1588    (_i "Take the layout instruction events from @var{music}, optionally
1589 restricted to those applying to context type @var{ctx}, and return
1590 a context modification duplicating their effect.")
1591    (let ((mods (ly:make-context-mod)))
1592      (define (musicop m)
1593        (if (music-is-of-type? m 'layout-instruction-event)
1594            (ly:add-context-mod
1595             mods
1596             (case (ly:music-property m 'name)
1597               ((PropertySet)
1598                (list 'assign
1599                      (ly:music-property m 'symbol)
1600                      (ly:music-property m 'value)))
1601               ((PropertyUnset)
1602                (list 'unset
1603                      (ly:music-property m 'symbol)))
1604               ((OverrideProperty)
1605                (cons* 'push
1606                       (ly:music-property m 'symbol)
1607                       (ly:music-property m 'grob-value)
1608                       (cond
1609                        ((ly:music-property m 'grob-property #f) => list)
1610                        (else
1611                         (ly:music-property m 'grob-property-path)))))
1612               ((RevertProperty)
1613                (cons* 'pop
1614                       (ly:music-property m 'symbol)
1615                       (cond
1616                        ((ly:music-property m 'grob-property #f) => list)
1617                        (else
1618                         (ly:music-property m 'grob-property-path)))))))
1619            (case (ly:music-property m 'name)
1620              ((ApplyContext)
1621               (ly:add-context-mod mods
1622                                   (list 'apply
1623                                         (ly:music-property m 'procedure))))
1624              ((ContextSpeccedMusic)
1625               (if (or (not ctx)
1626                       (eq? ctx (ly:music-property m 'context-type)))
1627                   (musicop (ly:music-property m 'element))))
1628              (else
1629               (let ((callback (ly:music-property m 'elements-callback)))
1630                 (if (procedure? callback)
1631                     (for-each musicop (callback m))))))))
1632      (musicop music)
1633      mods))
1634
1635 shape =
1636 #(define-music-function (offsets item)
1637    (list? key-list-or-music?)
1638    (_i "Offset control-points of @var{item} by @var{offsets}.  The
1639 argument is a list of number pairs or list of such lists.  Each
1640 element of a pair represents an offset to one of the coordinates of a
1641 control-point.  If @var{item} is a string, the result is
1642 @code{\\once\\override} for the specified grob type.  If @var{item} is
1643 a music expression, the result is the same music expression with an
1644 appropriate tweak applied.")
1645    (define (shape-curve grob coords)
1646      (let* ((orig (ly:grob-original grob))
1647             (siblings (if (ly:spanner? grob)
1648                           (ly:spanner-broken-into orig) '()))
1649             (total-found (length siblings)))
1650        (define (offset-control-points offsets)
1651          (if (null? offsets)
1652              coords
1653              (map coord-translate coords offsets)))
1654
1655        (define (helper sibs offs)
1656          (if (pair? offs)
1657              (if (eq? (car sibs) grob)
1658                  (offset-control-points (car offs))
1659                  (helper (cdr sibs) (cdr offs)))
1660              coords))
1661
1662        ;; we work with lists of lists
1663        (if (or (null? offsets)
1664                (not (list? (car offsets))))
1665            (set! offsets (list offsets)))
1666
1667        (if (>= total-found 2)
1668            (helper siblings offsets)
1669            (offset-control-points (car offsets)))))
1670    (once (propertyTweak 'control-points
1671                         (grob-transformer 'control-points shape-curve)
1672                         item)))
1673
1674 shiftDurations =
1675 #(define-music-function (dur dots arg)
1676    (integer? integer? ly:music?)
1677    (_i "Change the duration of @var{arg} by adding @var{dur} to the
1678 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1679
1680    (shift-duration-log arg dur dots))
1681
1682 single =
1683 #(define-music-function (overrides music)
1684    (ly:music? ly:music?)
1685    (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1686 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1687    (set! (ly:music-property music 'tweaks)
1688          (fold-some-music
1689           (lambda (m) (eq? (ly:music-property m 'name)
1690                            'OverrideProperty))
1691           (lambda (m tweaks)
1692             (let ((p (cond
1693                       ((ly:music-property m 'grob-property #f) => list)
1694                       (else
1695                        (ly:music-property m 'grob-property-path)))))
1696               (acons (cons (ly:music-property m 'symbol) ;grob name
1697                            (if (pair? (cdr p))
1698                                p ;grob property path
1699                                (car p))) ;grob property
1700                      (ly:music-property m 'grob-value)
1701                      tweaks)))
1702           (ly:music-property music 'tweaks)
1703           overrides))
1704    music)
1705
1706 skip =
1707 #(define-music-function (dur) (ly:duration?)
1708   (_i "Skip forward by @var{dur}.")
1709   (make-music 'SkipMusic
1710               'duration dur))
1711
1712
1713 slashedGrace =
1714 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1715    (_i "Create slashed graces (slashes through stems, but no slur) from
1716 the following music expression"))
1717
1718 spacingTweaks =
1719 #(define-music-function (parameters) (list?)
1720    (_i "Set the system stretch, by reading the 'system-stretch property of
1721 the `parameters' assoc list.")
1722    (overrideProperty
1723     '(Score NonMusicalPaperColumn line-break-system-details)
1724     (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1725           (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))))
1726
1727 styledNoteHeads =
1728 #(define-music-function (style heads music)
1729    (symbol? symbol-list-or-symbol? ly:music?)
1730    (_i "Set @var{heads} in @var{music} to @var{style}.")
1731    (style-note-heads heads style music))
1732
1733 tag =
1734 #(define-music-function (tags music) (symbol-list-or-symbol? ly:music?)
1735    (_i "Tag the following @var{music} with @var{tags} and return the
1736 result, by adding the single symbol or symbol list @var{tags} to the
1737 @code{tags} property of @var{music}.")
1738
1739    (set!
1740     (ly:music-property music 'tags)
1741     ((if (symbol? tags) cons append)
1742      tags
1743      (ly:music-property music 'tags)))
1744    music)
1745
1746 tagGroup =
1747 #(define-void-function (tags) (symbol-list?)
1748    (_i "Define a tag group comprising the symbols in the symbol list
1749 @var{tags}.  Tag groups must not overlap.")
1750    (let ((err (define-tag-group tags)))
1751      (if err (ly:parser-error err (*location*)))))
1752
1753 temporary =
1754 #(define-music-function (music)
1755    (ly:music?)
1756    (_i "Make any @code{\\override} in @var{music} replace an existing
1757 grob property value only temporarily, restoring the old value when a
1758 corresponding @code{\\revert} is executed.  This is achieved by
1759 clearing the @samp{pop-first} property normally set on
1760 @code{\\override}s.
1761
1762 An @code{\\override}/@/@code{\\revert} sequence created by using
1763 @code{\\temporary} and @code{\\undo} on the same music containing
1764 overrides will cancel out perfectly or cause a@tie{}warning.
1765
1766 Non-property-related music is ignored, warnings are generated for any
1767 property-changing music that isn't an @code{\\override}.")
1768    (define warned #f)
1769    (for-some-music
1770     (lambda (m)
1771       (and (or (music-is-of-type? m 'layout-instruction-event)
1772                (music-is-of-type? m 'context-specification)
1773                (music-is-of-type? m 'apply-context)
1774                (music-is-of-type? m 'time-signature-music))
1775            (case (ly:music-property m 'name)
1776              ((OverrideProperty)
1777               (if (ly:music-property m 'pop-first #f)
1778                   (set! (ly:music-property m 'pop-first) '()))
1779               (if (ly:music-property m 'once #f)
1780                   (set! (ly:music-property m 'once) '()))
1781               #t)
1782              ((ContextSpeccedMusic)
1783               #f)
1784              (else
1785               (if (not warned)
1786                   (begin
1787                     (ly:input-warning (*location*) (_ "Cannot make ~a revertible")
1788                                       (ly:music-property m 'name))
1789                     (set! warned #t)))
1790               #t))))
1791     music)
1792    music)
1793
1794 time =
1795 #(define-music-function (beat-structure fraction)
1796    ((number-list? '()) fraction?)
1797    (_i "Set @var{fraction} as time signature, with optional
1798 number list @var{beat-structure} before it.")
1799   (make-music 'TimeSignatureMusic
1800               'numerator (car fraction)
1801               'denominator (cdr fraction)
1802               'beat-structure beat-structure))
1803
1804 times =
1805 #(define-music-function (fraction music)
1806    (fraction? ly:music?)
1807    (_i "Scale @var{music} in time by @var{fraction}.")
1808   (make-music 'TimeScaledMusic
1809               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1810               'numerator (car fraction)
1811               'denominator (cdr fraction)))
1812
1813 transpose =
1814 #(define-music-function
1815    (from to music)
1816    (ly:pitch? ly:pitch? ly:music?)
1817
1818    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1819    (make-music 'TransposedMusic
1820                'element (ly:music-transpose music (ly:pitch-diff to from))))
1821
1822 transposedCueDuring =
1823 #(define-music-function
1824    (what dir pitch main-music)
1825    (string? ly:dir? ly:pitch? ly:music?)
1826
1827    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1828 using the transposition defined by @var{pitch}.  This happens
1829 simultaneously with @var{main-music}, which is usually a rest.  The
1830 argument @var{dir} determines whether the cue notes should be notated
1831 as a first or second voice.")
1832
1833    (make-music 'QuoteMusic
1834                'element main-music
1835                'quoted-context-type 'CueVoice
1836                'quoted-context-id "cue"
1837                'quoted-music-name what
1838                'quoted-voice-direction dir
1839                ;; following is inverse of instrumentTransposition for
1840                ;; historical reasons
1841                'quoted-transposition pitch))
1842
1843 transposition =
1844 #(define-music-function (pitch) (ly:pitch?)
1845    (_i "Set instrument transposition")
1846
1847    (context-spec-music
1848     (make-property-set 'instrumentTransposition pitch)
1849     'Staff))
1850
1851 tuplet =
1852 #(define-music-function (ratio tuplet-span music)
1853    (fraction? (ly:duration? '()) ly:music?)
1854    (_i "Scale the given @var{music} to tuplets.  @var{ratio} is a
1855 fraction that specifies how many notes are played in place of the
1856 nominal value: it will be @samp{3/2} for triplets, namely three notes
1857 being played in place of two.  If the optional duration
1858 @var{tuplet-span} is specified, it is used instead of
1859 @code{tupletSpannerDuration} for grouping the tuplets.
1860 For example,
1861 @example
1862 \\tuplet 3/2 4 @{ c8 c c c c c @}
1863 @end example
1864 will result in two groups of three tuplets, each group lasting for a
1865 quarter note.")
1866    (make-music 'TimeScaledMusic
1867                'element (ly:music-compress
1868                          music
1869                          (ly:make-moment (cdr ratio) (car ratio)))
1870                'numerator (cdr ratio)
1871                'denominator (car ratio)
1872                'duration tuplet-span))
1873
1874 tupletSpan =
1875 #(define-music-function (tuplet-span)
1876    ((ly:duration?))
1877    (_i "Set @code{tupletSpannerDuration}, the length into which
1878 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1879 own will group its tuplets, to the duration @var{tuplet-span}.  To
1880 revert to the default of not subdividing the contents of a @code{\\tuplet}
1881 command without explicit @samp{tuplet-span}, use
1882 @example
1883 \\tupletSpan \\default
1884 @end example
1885 ")
1886    (if tuplet-span
1887        #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1888        #{ \unset tupletSpannerDuration #}))
1889
1890 tweak =
1891 #(define-music-function (prop value music)
1892    (key-list-or-symbol? scheme? ly:music?)
1893    (_i "Add a tweak to the following @var{music}.
1894 Layout objects created by @var{music} get their property @var{prop}
1895 set to @var{value}.  If @var{prop} has the form @samp{Grob.property}, like with
1896 @example
1897 \\tweak Accidental.color #red cis'
1898 @end example
1899 an indirectly created grob (@samp{Accidental} is caused by
1900 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1901 are affected.
1902
1903 @var{prop} can contain additional elements in which case a nested
1904 property (inside of an alist) is tweaked.")
1905    (let ((p (check-grob-path prop (*location*)
1906                              #:start 1
1907                              #:default #t
1908                              #:min 2)))
1909      (cond ((not p))
1910            ;; p now contains at least two elements.  The first
1911            ;; element is #t when no grob has been explicitly
1912            ;; specified, otherwise it is a grob name.
1913            (else
1914             (set! (ly:music-property music 'tweaks)
1915                   (acons (cond ((pair? (cddr p)) p)
1916                                ((symbol? (car p))
1917                                 (cons (car p) (cadr p)))
1918                                (else (cadr p)))
1919                          value
1920                          (ly:music-property music 'tweaks)))))
1921      music))
1922
1923
1924 undo =
1925 #(define-music-function (music)
1926    (ly:music?)
1927    (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1928 @code{\\revert} and @code{\\unset}, respectively.  Any reverts and
1929 unsets already in @var{music} cause a warning.  Non-property-related music is ignored.")
1930    (define warned #f)
1931    (let loop
1932        ((music music))
1933      (let
1934          ((lst
1935            (fold-some-music
1936             (music-type-predicate '(layout-instruction-event
1937                                     context-specification
1938                                     apply-context
1939                                     time-signature-music))
1940             (lambda (m overrides)
1941               (case (ly:music-property m 'name)
1942                 ((OverrideProperty)
1943                  (cons
1944                   (make-music 'RevertProperty
1945                               'symbol (ly:music-property m 'symbol)
1946                               'grob-property-path
1947                               (cond
1948                                ((ly:music-property m 'grob-property #f) => list)
1949                                (else
1950                                 (ly:music-property m 'grob-property-path))))
1951                   overrides))
1952                 ((PropertySet)
1953                  (cons
1954                   (make-music 'PropertyUnset
1955                               'symbol (ly:music-property m 'symbol))
1956                   overrides))
1957                 ((ContextSpeccedMusic)
1958                  (cons
1959                   (make-music 'ContextSpeccedMusic
1960                               'element (loop (ly:music-property m 'element))
1961                               'context-type (ly:music-property m 'context-type))
1962                   overrides))
1963                 (else
1964                  (if (not warned)
1965                      (begin
1966                        (ly:input-warning (*location*) (_ "Cannot revert ~a")
1967                                          (ly:music-property m 'name))
1968                        (set! warned #t)))
1969                  overrides)))
1970             '()
1971             music)))
1972        (cond
1973         ((null? lst) (make-music 'Music))
1974         ((null? (cdr lst)) (car lst))
1975         (else (make-sequential-music lst))))))
1976
1977 unfoldRepeats =
1978 #(define-music-function (types music)
1979    ((symbol-list-or-symbol? '()) ly:music?)
1980    (_i "Force @code{\\repeat volta}, @code{\\repeat tremolo} or
1981 @code{\\repeat percent} commands in @var{music} to be interpreted
1982 as @code{\\repeat unfold}, if specified in the optional symbol-list @var{types}.
1983 The default for @var{types} is an empty list, which will force any of those
1984 commands in @var{music} to be interpreted as @code{\\repeat unfold}.  Possible
1985 entries are @code{volta}, @code{tremolo} or @code{percent}.  Multiple entries
1986 are possible.")
1987    (unfold-repeats types music))
1988
1989 voices =
1990 #(define-music-function (ids music) (key-list? ly:music?)
1991    (_i "Take the given key list of numbers (indicating the use of
1992 @samp{\\voiceOne}@dots{}) or symbols (indicating voice names,
1993 typically converted from strings by argument list processing)
1994 and assign the following @code{\\\\}-separated music to
1995 contexts according to that list.  Named rather than numbered
1996 contexts can be used for continuing one voice (for the sake of
1997 spanners and lyrics), usually requiring a @code{\\voiceOne}-style
1998 override at the beginning of the passage and a @code{\\oneVoice}
1999 override at its end.
2000
2001 The default
2002 @example
2003 << @dots{} \\\\ @dots{} \\\\ @dots{} >>
2004 @end example
2005 construct would correspond to
2006 @example
2007 \\voices 1,2,3 << @dots{} \\\\ @dots{} \\\\ @dots{} >>
2008 @end example")
2009    (voicify-music music ids))
2010
2011 void =
2012 #(define-void-function (arg) (scheme?)
2013    (_i "Accept a scheme argument, return a void expression.
2014 Use this if you want to have a scheme expression evaluated
2015 because of its side-effects, but its value ignored."))
2016
2017 withMusicProperty =
2018 #(define-music-function (sym val music)
2019    (symbol? scheme? ly:music?)
2020    (_i "Set @var{sym} to @var{val} in @var{music}.")
2021
2022    (set! (ly:music-property music sym) val)
2023    music)