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