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