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