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