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