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