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--2014 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 (ly:make-moment (ly:moment-main 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 Timing.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 magnifyMusic =
 636 #(define-music-function (parser location mag mus) (number? ly:music?)
 637    (_i "Magnify the notation of @var{mus} without changing the
 638 staff-size, using @var{mag} as a size factor.  Stems, beams, and
 639 horizontal spacing are adjusted automatically.")
 640    #{
 641      \set fontSize = #(magnification->font-size mag)
 642      % gives beam-thickness=0.48 when mag=1 (like default),
 643      % gives beam-thickness=0.35 when mag=0.63 (like CueVoice)
 644      \temporary \override Beam.beam-thickness = #(+ 119/925 (* mag 13/37))
 645      \temporary \override Beam.length-fraction = #mag
 646      \temporary \override Stem.length-fraction = #mag
 647      \temporary \override Stem.thickness = #(* 1.3 (max 1 mag))
 648      \temporary \override Score.SpacingSpanner.spacing-increment = #(* 1.2 mag)
 649      #mus
 650      \set fontSize = 0
 651      \revert Beam.beam-thickness
 652      \revert Beam.length-fraction
 653      \revert Stem.length-fraction
 654      \revert Stem.thickness
 655      \revert Score.SpacingSpanner.spacing-increment
 656    #})
 657
 658 makeClusters =
 659 #(define-music-function (parser location arg) (ly:music?)
 660    (_i "Display chords in @var{arg} as clusters.")
 661    (music-map note-to-cluster arg))
 662
 663 modalInversion =
 664 #(define-music-function (parser location around to scale music)
 665     (ly:pitch? ly:pitch? ly:music? ly:music?)
 666     (_i "Invert @var{music} about @var{around} using @var{scale} and
 667 transpose from @var{around} to @var{to}.")
 668     (let ((inverter (make-modal-inverter around to scale)))
 669       (change-pitches music inverter)
 670       music))
 671
 672 modalTranspose =
 673 #(define-music-function (parser location from to scale music)
 674     (ly:pitch? ly:pitch? ly:music? ly:music?)
 675     (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
 676 using @var{scale}.")
 677     (let ((transposer (make-modal-transposer from to scale)))
 678       (change-pitches music transposer)
 679       music))
 680
 681 inversion =
 682 #(define-music-function
 683    (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
 684    (_i "Invert @var{music} about @var{around} and
 685 transpose from @var{around} to @var{to}.")
 686    (music-invert around to music))
 687
 688 mark =
 689 #(define-music-function
 690    (parser location label) ((scheme? '()))
 691   "Make the music for the \\mark command."
 692   (let* ((set (and (integer? label)
 693                    (context-spec-music (make-property-set 'rehearsalMark label)
 694                                       'Score)))
 695          (ev (make-music 'MarkEvent
 696                          'origin location)))
 697
 698     (if set
 699         (make-sequential-music (list set ev))
 700         (begin
 701           (set! (ly:music-property ev 'label) label)
 702           ev))))
 703
 704 musicMap =
 705 #(define-music-function (parser location proc mus) (procedure? ly:music?)
 706    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 707    (music-map proc mus))
 708
 709 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 710 %% because music identifiers are not allowed at top-level.
 711 noPageBreak =
 712 #(define-music-function (location parser) ()
 713    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 714 markups), or inside a score.")
 715    (make-music 'EventChord
 716                'page-marker #t
 717                'page-break-permission 'forbid
 718                'elements (list (make-music 'PageBreakEvent
 719                                            'break-permission '()))))
 720
 721 noPageTurn =
 722 #(define-music-function (location parser) ()
 723    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 724 markups), or inside a score.")
 725    (make-music 'EventChord
 726                'page-marker #t
 727                'page-turn-permission 'forbid
 728                'elements (list (make-music 'PageTurnEvent
 729                                            'break-permission '()))))
 730
 731
 732
 733 octaveCheck =
 734 #(define-music-function (parser location pitch) (ly:pitch?)
 735    (_i "Octave check.")
 736    (make-music 'RelativeOctaveCheck
 737                'pitch pitch))
 738
 739 offset =
 740 #(define-music-function (parser location property offsets item)
 741   (symbol-list-or-symbol? scheme? symbol-list-or-music?)
 742    (_i "Offset the default value of @var{property} of @var{item} by
 743 @var{offsets}.  If @var{item} is a string, the result is
 744 @code{\\override} for the specified grob type.  If @var{item} is
 745 a music expression, the result is the same music expression with an
 746 appropriate tweak applied.")
 747   (if (ly:music? item)
 748       ; In case of a tweak, grob property path is Grob.property
 749       (let ((prop-path (check-grob-path
 750                          (if (symbol? property)
 751                              (list property)
 752                              property)
 753                          parser location
 754                          #:start 1 #:default #t #:min 2 #:max 2)))
 755         (if prop-path
 756             ; If the head of the grob property path is a symbol--i.e.,
 757             ; a grob name, produce a directed tweak.  Otherwise, create
 758             ; an ordinary tweak.
 759             (if (symbol? (car prop-path))
 760                 #{
 761                   \tweak #prop-path #(offsetter (second prop-path) offsets) #item
 762                 #}
 763                 #{
 764                   \tweak #(second prop-path) #(offsetter (second prop-path) offsets) #item
 765                 #})
 766             item))
 767       ; In case of an override, grob property path is Context.Grob.property.
 768       (let ((prop-path (check-grob-path
 769                          (append item
 770                                  (if (symbol? property)
 771                                      (list property)
 772                                      property))
 773                          parser location
 774                          #:default 'Bottom #:min 3 #:max 3)))
 775         (if prop-path
 776             #{
 777               \override #prop-path = #(offsetter (third prop-path) offsets)
 778             #}
 779             (make-music 'Music)))))
 780
 781 omit =
 782 #(define-music-function (parser location item) (symbol-list-or-music?)
 783    (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
 784 effectively omitting it without taking up space.
 785
 786 If @var{item} is a symbol list of form @code{GrobName} or
 787 @code{Context.GrobName}, the result is an override for the grob name
 788 specified by it.  If @var{item} is a music expression, the result is
 789 the same music expression with an appropriate tweak applied to it.")
 790    #{ \tweak stencil ##f #item #})
 791
 792 once =
 793 #(define-music-function (parser location music) (ly:music?)
 794    (_i "Set @code{once} to @code{#t} on all layout instruction events
 795 in @var{music}.  This will complain about music with an actual
 796 duration.  As a special exception, if @var{music} contains
 797 @samp{tweaks} it will be silently ignored in order to allow for
 798 @code{\\once \\tweak} to work as both one-time override and proper
 799 tweak.")
 800    (if (not (pair? (ly:music-property music 'tweaks)))
 801        (for-some-music
 802         (lambda (m)
 803           (cond ((music-is-of-type? m 'layout-instruction-event)
 804                  (set! (ly:music-property m 'once) #t)
 805                  #t)
 806                 ((ly:duration? (ly:music-property m 'duration))
 807                  (ly:music-warning m (_ "Cannot apply \\once to timed music"))
 808                  #t)
 809                 (else #f)))
 810         music))
 811    music)
 812
 813 ottava =
 814 #(define-music-function (parser location octave) (integer?)
 815    (_i "Set the octavation.")
 816    (make-music 'OttavaMusic
 817                'ottava-number octave))
 818
 819 overrideTimeSignatureSettings =
 820 #(define-music-function
 821    (parser location time-signature base-moment beat-structure beam-exceptions)
 822    (fraction? fraction? list? list?)
 823
 824    (_i "Override @code{timeSignatureSettings}
 825 for time signatures of @var{time-signature} to have settings
 826 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 827
 828    ;; TODO -- add warning if largest value of grouping is
 829    ;;       greater than time-signature.
 830   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 831     (override-time-signature-setting time-signature setting)))
 832
 833 overrideProperty =
 834 #(define-music-function (parser location grob-property-path value)
 835    (symbol-list? scheme?)
 836
 837    (_i "Set the grob property specified by @var{grob-property-path} to
 838 @var{value}.  @var{grob-property-path} is a symbol list of the form
 839 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
 840 with subproperties given as well.")
 841    (let ((p (check-grob-path grob-property-path parser location
 842                              #:default 'Bottom
 843                              #:min 3)))
 844      (if p
 845          (make-music 'ApplyOutputEvent
 846                      'context-type (first p)
 847                      'procedure
 848                      (lambda (grob orig-context context)
 849                        (if (equal?
 850                             (cdr (assoc 'name (ly:grob-property grob 'meta)))
 851                             (second p))
 852                            (ly:grob-set-nested-property!
 853                             grob (cddr p) value))))
 854          (make-music 'Music))))
 855
 856
 857
 858
 859
 860
 861 %% pageBreak and pageTurn are music functions (iso music indentifiers),
 862 %% because music identifiers are not allowed at top-level.
 863 pageBreak =
 864 #(define-music-function (location parser) ()
 865    (_i "Force a page break.  May be used at toplevel (i.e., between scores or
 866 markups), or inside a score.")
 867    (make-music 'EventChord
 868                'page-marker #t
 869                'line-break-permission 'force
 870                'page-break-permission 'force
 871                'elements (list (make-music 'LineBreakEvent
 872                                            'break-permission 'force)
 873                                (make-music 'PageBreakEvent
 874                                            'break-permission 'force))))
 875
 876 pageTurn =
 877 #(define-music-function (location parser) ()
 878    (_i "Force a page turn between two scores or top-level markups.")
 879    (make-music 'EventChord
 880                'page-marker #t
 881                'line-break-permission 'force
 882                'page-break-permission 'force
 883                'page-turn-permission 'force
 884                'elements (list (make-music 'LineBreakEvent
 885                                            'break-permission 'force)
 886                                (make-music 'PageBreakEvent
 887                                            'break-permission 'force)
 888                                (make-music 'PageTurnEvent
 889                                            'break-permission 'force))))
 890
 891 parallelMusic =
 892 #(define-void-function (parser location voice-ids music) (list? ly:music?)
 893    (_i "Define parallel music sequences, separated by '|' (bar check signs),
 894 and assign them to the identifiers provided in @var{voice-ids}.
 895
 896 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
 897
 898 @var{music}: a music sequence, containing BarChecks as limiting expressions.
 899
 900 Example:
 901
 902 @verbatim
 903   \\parallelMusic #'(A B C) {
 904     c c | d d | e e |
 905     d d | e e | f f |
 906   }
 907 <==>
 908   A = { c c | d d | }
 909   B = { d d | e e | }
 910   C = { e e | f f | }
 911 @end verbatim
 912 ")
 913    (define (bar-check? m)
 914      "Checks whether m is a bar check."
 915      (eq? (ly:music-property m 'name) 'BarCheck))
 916    (define (recurse-and-split music)
 917      "This returns either a list of music split along barchecks, or
 918 @code{#f}."
 919      (let ((elt (ly:music-property music 'element))
 920            (elts (ly:music-property music 'elements)))
 921        (cond ((ly:music? elt)
 922               (let ((lst (recurse-and-split elt)))
 923                 (and lst
 924                      (map
 925                       (lambda (x)
 926                         (let ((res (music-clone music 'element x)))
 927                           (if (ly:input-location?
 928                                (ly:music-property x 'origin))
 929                               (set! (ly:music-property res 'origin)
 930                                     (ly:music-property x 'origin)))
 931                           res))
 932                       lst))))
 933              ((any bar-check? elts)
 934               (let* ((voices (apply circular-list
 935                                     (make-list (length voice-ids)
 936                                                '())))
 937                      (current-voices voices)
 938                      (current-sequence '()))
 939                 ;;
 940                 ;; utilities
 941                 (define (push-music m)
 942                   "Push the music expression into the current sequence"
 943                   (set! current-sequence (cons m current-sequence)))
 944                 (define (change-voice)
 945                   "Stores the previously built sequence into the current voice and
 946        change to the following voice."
 947                   (set-car! current-voices
 948                             (cons (reverse! current-sequence)
 949                                   (car current-voices)))
 950                   (set! current-sequence '())
 951                   (set! current-voices (cdr current-voices)))
 952                 (for-each (lambda (m)
 953                             (let ((split? (recurse-and-split m)))
 954                               (if split?
 955                                   (for-each
 956                                    (lambda (m)
 957                                      (push-music m)
 958                                      (change-voice))
 959                                    split?)
 960                                   (begin
 961                                     (push-music m)
 962                                     (if (bar-check? m) (change-voice))))))
 963                           elts)
 964                 (if (pair? current-sequence) (change-voice))
 965                 ;; un-circularize `voices' and reorder the voices
 966
 967                 (set! voices (map reverse!
 968                                   (list-head voices (length voice-ids))))
 969
 970                 ;; check sequence length
 971                 (apply for-each (lambda seqs
 972                                   (define (seq-len seq)
 973                                     (reduce ly:moment-add
 974                                             (ly:make-moment 0)
 975                                             (map ly:music-length seq)))
 976                                   (let ((moment-reference (seq-len (car seqs))))
 977                                     (for-each (lambda (seq)
 978                                                 (if (not (equal? (seq-len seq)
 979                                                                  moment-reference))
 980                                                     (ly:music-warning
 981                                                      (if (pair? seq)
 982                                                          (last seq)
 983                                                          (caar seqs))
 984                                                      (_ "Bars in parallel music don't have the same length"))))
 985                                               seqs)))
 986                        voices)
 987                 (map
 988                  (lambda (lst)
 989                    (set! lst (concatenate! lst))
 990                    (let ((res (music-clone music 'elements lst)))
 991                      (if (and (pair? lst)
 992                               (ly:input-location? (ly:music-property
 993                                                    (car lst)
 994                                                    'origin)))
 995                          (set! (ly:music-property res 'origin)
 996                                (ly:music-property (car lst) 'origin)))
 997                      res))
 998                  voices)))
 999              (else #f))))
1000    (let ((voices (recurse-and-split music)))
1001      (if voices
1002          ;;
1003          ;; bind voice identifiers to the voices
1004          (for-each (lambda (voice-id voice)
1005                      (ly:parser-define! parser voice-id voice))
1006           voice-ids voices)
1007          (ly:music-warning music
1008                            (_ "ignoring parallel music without barchecks")))))
1009
1010 parenthesize =
1011 #(define-music-function (parser loc arg) (ly:music?)
1012    (_i "Tag @var{arg} to be parenthesized.")
1013
1014    (if (memq 'event-chord (ly:music-property arg 'types))
1015        ;; arg is an EventChord -> set the parenthesize property
1016        ;; on all child notes and rests
1017        (for-each
1018         (lambda (ev)
1019           (if (or (memq 'note-event (ly:music-property ev 'types))
1020                   (memq 'rest-event (ly:music-property ev 'types)))
1021               (set! (ly:music-property ev 'parenthesize) #t)))
1022         (ly:music-property arg 'elements))
1023        ;; No chord, simply set property for this expression:
1024        (set! (ly:music-property arg 'parenthesize) #t))
1025    arg)
1026
1027 partcombine =
1028 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
1029    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1030 that they share a staff.")
1031    (make-part-combine-music parser
1032                             (list part1 part2) #f))
1033
1034 partcombineUp =
1035 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
1036    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1037 that they share a staff with stems directed upward.")
1038    (make-part-combine-music parser
1039                             (list part1 part2) UP))
1040
1041 partcombineDown =
1042 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
1043    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1044 that they share a staff with stems directed downward.")
1045    (make-part-combine-music parser
1046                             (list part1 part2) DOWN))
1047
1048 partcombineForce =
1049 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
1050    (_i "Override the part-combiner.")
1051    (make-music 'EventChord
1052                'elements (list (make-music 'PartCombineForceEvent
1053                                            'forced-type type
1054                                            'once once))))
1055 partcombineApart = \partcombineForce #'apart ##f
1056 partcombineApartOnce = \partcombineForce #'apart ##t
1057 partcombineChords = \partcombineForce #'chords ##f
1058 partcombineChordsOnce = \partcombineForce #'chords ##t
1059 partcombineUnisono = \partcombineForce #'unisono ##f
1060 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1061 partcombineSoloI = \partcombineForce #'solo1 ##f
1062 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1063 partcombineSoloII = \partcombineForce #'solo2 ##f
1064 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1065 partcombineAutomatic = \partcombineForce ##f ##f
1066 partcombineAutomaticOnce = \partcombineForce ##f ##t
1067
1068 partial =
1069 #(define-music-function (parser location dur) (ly:duration?)
1070   (_i "Make a partial measure.")
1071
1072   ;; We use `descend-to-context' here instead of `context-spec-music' to
1073   ;; ensure \partial still works if the Timing_translator is moved
1074     (descend-to-context
1075      (context-spec-music (make-music 'PartialSet
1076                                      'origin location
1077                                      'duration dur)
1078                          'Timing)
1079      'Score))
1080
1081 pitchedTrill =
1082 #(define-music-function
1083    (parser location main-note secondary-note)
1084    (ly:music? ly:music?)
1085    (_i "Print a trill with @var{main-note} as the main note of the trill and
1086 print @var{secondary-note} as a stemless note head in parentheses.")
1087    (let* ((get-notes (lambda (ev-chord)
1088                        (extract-named-music ev-chord 'NoteEvent)))
1089           (sec-note-events (get-notes secondary-note))
1090           (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1091      (if (pair? sec-note-events)
1092          (begin
1093            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1094                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1095
1096              (if (ly:pitch? trill-pitch)
1097                  (for-each (lambda (m)
1098                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1099                  (begin
1100                    (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
1101                    (display sec-note-events)))
1102
1103              (if (eq? forced #t)
1104                  (for-each (lambda (m)
1105                              (ly:music-set-property! m 'force-accidental forced))
1106                            trill-events)))))
1107      main-note))
1108
1109 pushToTag =
1110 #(define-music-function (parser location tag more music)
1111    (symbol? ly:music? ly:music?)
1112    (_i "Add @var{more} to the front of @code{elements} of all music
1113 expressions in @var{music} that are tagged with @var{tag}.")
1114    (music-map (lambda (m)
1115                 (if (memq tag (ly:music-property m 'tags))
1116                     (set! (ly:music-property m 'elements)
1117                           (cons more (ly:music-property m 'elements))))
1118                 m)
1119               music))
1120
1121 quoteDuring =
1122 #(define-music-function (parser location what main-music) (string? ly:music?)
1123    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
1124 of the quoted voice, as specified in an @code{\\addQuote} command.
1125 @var{main-music} is used to indicate the length of music to be quoted;
1126 usually contains spacers or multi-measure rests.")
1127    (make-music 'QuoteMusic
1128                'element main-music
1129                'quoted-music-name what))
1130
1131 relative =
1132 #(define-music-function (parser location pitch music)
1133    ((ly:pitch?) ly:music?)
1134    (_i "Make @var{music} relative to @var{pitch}.  If @var{pitch} is
1135 omitted, the first note in @var{music} is given in absolute pitch.")
1136    ;; When \relative has no clear decision (can only happen with
1137    ;; scales with an even number of steps), it goes down (see
1138    ;; pitch.cc).  The following formula puts out f for both the normal
1139    ;; 7-step scale as well as for a "shortened" scale missing the
1140    ;; final b.  In either case, a first note of c will end up as c,
1141    ;; namely pitch (-1, 0, 0).
1142    (ly:make-music-relative! music
1143                             (or pitch
1144                                 (ly:make-pitch
1145                                  -1
1146                                  (quotient
1147                                   ;; size of current scale:
1148                                   (ly:pitch-steps (ly:make-pitch 1 0))
1149                                   2))))
1150    (make-music 'RelativeOctaveMusic
1151                'element music))
1152
1153 removeWithTag =
1154 #(define-music-function (parser location tag music)
1155    (symbol-list-or-symbol? ly:music?)
1156    (_i "Remove elements of @var{music} that are tagged with one of the
1157 tags in @var{tag}.  @var{tag} may be either a single symbol or a list
1158 of symbols.")
1159    (music-filter
1160     (if (symbol? tag)
1161         (lambda (m)
1162           (not (memq tag (ly:music-property m 'tags))))
1163         (lambda (m)
1164           (let ((music-tags (ly:music-property m 'tags)))
1165             (or (null? music-tags)
1166                 (not (any (lambda (t) (memq t music-tags)) tag))))))
1167     music))
1168
1169 resetRelativeOctave =
1170 #(define-music-function (parser location pitch) (ly:pitch?)
1171    (_i "Set the octave inside a \\relative section.")
1172
1173    (make-music 'SequentialMusic
1174                'to-relative-callback
1175                (lambda (music last-pitch) pitch)))
1176
1177 retrograde =
1178 #(define-music-function (parser location music)
1179     (ly:music?)
1180     (_i "Return @var{music} in reverse order.")
1181     (retrograde-music music))
1182
1183 revertTimeSignatureSettings =
1184 #(define-music-function
1185    (parser location time-signature)
1186    (pair?)
1187
1188    (_i "Revert @code{timeSignatureSettings}
1189 for time signatures of @var{time-signature}.")
1190    (revert-time-signature-setting time-signature))
1191
1192 rightHandFinger =
1193 #(define-event-function (parser location finger) (number-or-markup?)
1194    (_i "Apply @var{finger} as a fingering indication.")
1195
1196    (make-music
1197             'StrokeFingerEvent
1198             (if (number? finger) 'digit 'text)
1199             finger))
1200
1201 scaleDurations =
1202 #(define-music-function (parser location fraction music)
1203    (fraction? ly:music?)
1204    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1205    (ly:music-compress music
1206                       (ly:make-moment (car fraction) (cdr fraction))))
1207
1208 settingsFrom =
1209 #(define-scheme-function (parser location ctx music)
1210    ((symbol?) ly:music?)
1211    (_i "Take the layout instruction events from @var{music}, optionally
1212 restricted to those applying to context type @var{ctx}, and return
1213 a context modification duplicating their effect.")
1214    (let ((mods (ly:make-context-mod)))
1215      (define (musicop m)
1216        (if (music-is-of-type? m 'layout-instruction-event)
1217            (ly:add-context-mod
1218             mods
1219             (case (ly:music-property m 'name)
1220               ((PropertySet)
1221                (list 'assign
1222                      (ly:music-property m 'symbol)
1223                      (ly:music-property m 'value)))
1224               ((PropertyUnset)
1225                (list 'unset
1226                      (ly:music-property m 'symbol)))
1227               ((OverrideProperty)
1228                (cons* 'push
1229                       (ly:music-property m 'symbol)
1230                       (ly:music-property m 'grob-value)
1231                       (cond
1232                        ((ly:music-property m 'grob-property #f) => list)
1233                        (else
1234                         (ly:music-property m 'grob-property-path)))))
1235               ((RevertProperty)
1236                (cons* 'pop
1237                       (ly:music-property m 'symbol)
1238                       (cond
1239                        ((ly:music-property m 'grob-property #f) => list)
1240                        (else
1241                         (ly:music-property m 'grob-property-path)))))))
1242            (case (ly:music-property m 'name)
1243              ((ApplyContext)
1244               (ly:add-context-mod mods
1245                                   (list 'apply
1246                                         (ly:music-property m 'procedure))))
1247              ((ContextSpeccedMusic)
1248               (if (or (not ctx)
1249                       (eq? ctx (ly:music-property m 'context-type)))
1250                   (musicop (ly:music-property m 'element))))
1251              (else
1252               (let ((callback (ly:music-property m 'elements-callback)))
1253                 (if (procedure? callback)
1254                     (for-each musicop (callback m))))))))
1255      (musicop music)
1256      mods))
1257
1258 shape =
1259 #(define-music-function (parser location offsets item)
1260    (list? symbol-list-or-music?)
1261    (_i "Offset control-points of @var{item} by @var{offsets}.  The
1262 argument is a list of number pairs or list of such lists.  Each
1263 element of a pair represents an offset to one of the coordinates of a
1264 control-point.  If @var{item} is a string, the result is
1265 @code{\\once\\override} for the specified grob type.  If @var{item} is
1266 a music expression, the result is the same music expression with an
1267 appropriate tweak applied.")
1268    (define (shape-curve grob)
1269      (let* ((orig (ly:grob-original grob))
1270             (siblings (if (ly:spanner? grob)
1271                           (ly:spanner-broken-into orig) '()))
1272             (total-found (length siblings))
1273             (function (assoc-get 'control-points
1274                                  (reverse (ly:grob-basic-properties grob))))
1275             (coords (function grob)))
1276
1277        (define (offset-control-points offsets)
1278          (if (null? offsets)
1279              coords
1280              (map
1281                (lambda (x y) (coord-translate x y))
1282                coords offsets)))
1283
1284        (define (helper sibs offs)
1285          (if (pair? offs)
1286              (if (eq? (car sibs) grob)
1287                  (offset-control-points (car offs))
1288                  (helper (cdr sibs) (cdr offs)))
1289              coords))
1290
1291        ;; we work with lists of lists
1292        (if (or (null? offsets)
1293                (not (list? (car offsets))))
1294            (set! offsets (list offsets)))
1295
1296        (if (>= total-found 2)
1297            (helper siblings offsets)
1298            (offset-control-points (car offsets)))))
1299    #{ \once \tweak control-points #shape-curve #item #})
1300
1301 shiftDurations =
1302 #(define-music-function (parser location dur dots arg)
1303    (integer? integer? ly:music?)
1304    (_i "Change the duration of @var{arg} by adding @var{dur} to the
1305 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1306
1307    (shift-duration-log arg dur dots))
1308
1309 single =
1310 #(define-music-function (parser location overrides music)
1311    (ly:music? ly:music?)
1312    (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1313 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1314    (set! (ly:music-property music 'tweaks)
1315          (fold-some-music
1316           (lambda (m) (eq? (ly:music-property m 'name)
1317                            'OverrideProperty))
1318           (lambda (m tweaks)
1319             (let ((p (cond
1320                       ((ly:music-property m 'grob-property #f) => list)
1321                       (else
1322                        (ly:music-property m 'grob-property-path)))))
1323               (acons (cons (ly:music-property m 'symbol) ;grob name
1324                            (if (pair? (cdr p))
1325                                p ;grob property path
1326                                (car p))) ;grob property
1327                      (ly:music-property m 'grob-value)
1328                      tweaks)))
1329           (ly:music-property music 'tweaks)
1330           overrides))
1331    music)
1332
1333 skip =
1334 #(define-music-function (parser location dur) (ly:duration?)
1335   (_i "Skip forward by @var{dur}.")
1336   (make-music 'SkipMusic
1337               'duration dur))
1338
1339
1340 slashedGrace =
1341 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1342    (_i "Create slashed graces (slashes through stems, but no slur) from
1343 the following music expression"))
1344
1345 spacingTweaks =
1346 #(define-music-function (parser location parameters) (list?)
1347    (_i "Set the system stretch, by reading the 'system-stretch property of
1348 the `parameters' assoc list.")
1349    #{
1350      \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1351      #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1352              (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1353    #})
1354
1355 styledNoteHeads =
1356 #(define-music-function (parser location style heads music)
1357    (symbol? symbol-list-or-symbol? ly:music?)
1358    (_i "Set @var{heads} in @var{music} to @var{style}.")
1359    (style-note-heads heads style music))
1360
1361 tag =
1362 #(define-music-function (parser location tag music) (symbol-list-or-symbol? ly:music?)
1363    (_i "Tag the following @var{music} with @var{tag} and return the
1364 result, by adding the single symbol or symbol list @var{tag} to the
1365 @code{tags} property of @var{music}.")
1366
1367    (set!
1368     (ly:music-property music 'tags)
1369     ((if (symbol? tag) cons append)
1370      tag
1371      (ly:music-property music 'tags)))
1372    music)
1373
1374 temporary =
1375 #(define-music-function (parser location music)
1376    (ly:music?)
1377    (_i "Make any @code{\\override} in @var{music} replace an existing
1378 grob property value only temporarily, restoring the old value when a
1379 corresponding @code{\\revert} is executed.  This is achieved by
1380 clearing the @samp{pop-first} property normally set on
1381 @code{\\override}s.
1382
1383 An @code{\\override}/@/@code{\\revert} sequence created by using
1384 @code{\\temporary} and @code{\\undo} on the same music containing
1385 overrides will cancel out perfectly or cause a@tie{}warning.
1386
1387 Non-property-related music is ignored, warnings are generated for any
1388 property-changing music that isn't an @code{\\override}.")
1389    (define warned #f)
1390    (for-some-music
1391     (lambda (m)
1392       (and (or (music-is-of-type? m 'layout-instruction-event)
1393                (music-is-of-type? m 'context-specification)
1394                (music-is-of-type? m 'apply-context)
1395                (music-is-of-type? m 'time-signature-music))
1396            (case (ly:music-property m 'name)
1397              ((OverrideProperty)
1398               (if (ly:music-property m 'pop-first #f)
1399                   (set! (ly:music-property m 'pop-first) '()))
1400               (if (ly:music-property m 'once #f)
1401                   (set! (ly:music-property m 'once) '()))
1402               #t)
1403              ((ContextSpeccedMusic)
1404               #f)
1405              (else
1406               (if (not warned)
1407                   (begin
1408                     (ly:input-warning location (_ "Cannot make ~a revertible")
1409                                       (ly:music-property m 'name))
1410                     (set! warned #t)))
1411               #t))))
1412     music)
1413    music)
1414
1415 time =
1416 #(define-music-function (parser location beat-structure fraction)
1417    ((number-list? '()) fraction?)
1418    (_i "Set @var{fraction} as time signature, with optional
1419 number list @var{beat-structure} before it.")
1420   (make-music 'TimeSignatureMusic
1421               'numerator (car fraction)
1422               'denominator (cdr fraction)
1423               'beat-structure beat-structure))
1424
1425 times =
1426 #(define-music-function (parser location fraction music)
1427    (fraction? ly:music?)
1428    (_i "Scale @var{music} in time by @var{fraction}.")
1429   (make-music 'TimeScaledMusic
1430               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1431               'numerator (car fraction)
1432               'denominator (cdr fraction)))
1433
1434 transpose =
1435 #(define-music-function
1436    (parser location from to music)
1437    (ly:pitch? ly:pitch? ly:music?)
1438
1439    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1440    (make-music 'TransposedMusic
1441                'element (ly:music-transpose music (ly:pitch-diff to from))))
1442
1443 transposedCueDuring =
1444 #(define-music-function
1445    (parser location what dir pitch main-music)
1446    (string? ly:dir? ly:pitch? ly:music?)
1447
1448    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1449 using the transposition defined by @var{pitch}.  This happens
1450 simultaneously with @var{main-music}, which is usually a rest.  The
1451 argument @var{dir} determines whether the cue notes should be notated
1452 as a first or second voice.")
1453
1454    (make-music 'QuoteMusic
1455                'element main-music
1456                'quoted-context-type 'CueVoice
1457                'quoted-context-id "cue"
1458                'quoted-music-name what
1459                'quoted-voice-direction dir
1460                ;; following is inverse of instrumentTransposition for
1461                ;; historical reasons
1462                'quoted-transposition pitch))
1463
1464 transposition =
1465 #(define-music-function (parser location pitch) (ly:pitch?)
1466    (_i "Set instrument transposition")
1467
1468    (context-spec-music
1469     (make-property-set 'instrumentTransposition pitch)
1470     'Staff))
1471
1472 tuplet =
1473 #(define-music-function (parser location ratio tuplet-span music)
1474    (fraction? (ly:duration? '()) ly:music?)
1475    (_i "Scale the given @var{music} to tuplets.  @var{ratio} is a
1476 fraction that specifies how many notes are played in place of the
1477 nominal value: it will be @samp{3/2} for triplets, namely three notes
1478 being played in place of two.  If the optional duration
1479 @var{tuplet-span} is specified, it is used instead of
1480 @code{tupletSpannerDuration} for grouping the tuplets.
1481 For example,
1482 @example
1483 \\tuplet 3/2 4 @{ c8 c c c c c @}
1484 @end example
1485 will result in two groups of three tuplets, each group lasting for a
1486 quarter note.")
1487    (make-music 'TimeScaledMusic
1488                'element (ly:music-compress
1489                          music
1490                          (ly:make-moment (cdr ratio) (car ratio)))
1491                'numerator (cdr ratio)
1492                'denominator (car ratio)
1493                'duration tuplet-span))
1494
1495 tupletSpan =
1496 #(define-music-function (parser location tuplet-span)
1497    ((ly:duration?))
1498    (_i "Set @code{tupletSpannerDuration}, the length into which
1499 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1500 own will group its tuplets, to the duration @var{tuplet-span}.  To
1501 revert to the default of not subdividing the contents of a @code{\\tuplet}
1502 command without explicit @samp{tuplet-span}, use
1503 @example
1504 \\tupletSpan \\default
1505 @end example
1506 ")
1507    (if tuplet-span
1508        #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1509        #{ \unset tupletSpannerDuration #}))
1510
1511 tweak =
1512 #(define-music-function (parser location prop value item)
1513    (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1514    (_i "Add a tweak to the following @var{item}, usually music.
1515 Layout objects created by @var{item} get their property @var{prop}
1516 set to @var{value}.  If @var{prop} has the form @samp{Grob.property}, like with
1517 @example
1518 \\tweak Accidental.color #red cis'
1519 @end example
1520 an indirectly created grob (@samp{Accidental} is caused by
1521 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1522 are affected.
1523
1524 As a special case, @var{item} may be a symbol list specifying a grob
1525 path, in which case @code{\\override} is called on it instead of
1526 creating tweaked music.  This is mainly useful when using
1527 @code{\\tweak} as as a component for building other functions.
1528
1529 If this use case would call for @code{\\once \\override} rather than a
1530 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1531 convenient.
1532
1533 @var{prop} can contain additional elements in which case a nested
1534 property (inside of an alist) is tweaked.")
1535    (if (ly:music? item)
1536        (let ((p (check-grob-path prop parser location
1537                                  #:start 1
1538                                  #:default #t
1539                                  #:min 2)))
1540          (if p
1541              (set! (ly:music-property item 'tweaks)
1542                    (acons (cond ((pair? (cddr p)) p)
1543                                 ((symbol? (car p))
1544                                  (cons (car p) (cadr p)))
1545                                 (else (cadr p)))
1546                           value
1547                           (ly:music-property item 'tweaks))))
1548          item)
1549        ;; We could just throw this at \override and let it sort this
1550        ;; out on its own, but this way we should get better error
1551        ;; diagnostics.
1552        (let ((p (check-grob-path
1553                  (append item (if (symbol? prop) (list prop) prop))
1554                  parser location
1555                  #:default 'Bottom #:min 3)))
1556          (if p
1557              #{ \override #p = #value #}
1558              (make-music 'Music)))))
1559
1560 undo =
1561 #(define-music-function (parser location music)
1562    (ly:music?)
1563    (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1564 @code{\\revert} and @code{\\unset}, respectively.  Any reverts and
1565 unsets already in @var{music} cause a warning.  Non-property-related music is ignored.")
1566    (define warned #f)
1567    (let loop
1568        ((music music))
1569      (let
1570          ((lst
1571            (fold-some-music
1572             (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1573                             (music-is-of-type? m 'context-specification)
1574                             (music-is-of-type? m 'apply-context)
1575                             (music-is-of-type? m 'time-signature-music)))
1576             (lambda (m overrides)
1577               (case (ly:music-property m 'name)
1578                 ((OverrideProperty)
1579                  (cons
1580                   (make-music 'RevertProperty
1581                               'symbol (ly:music-property m 'symbol)
1582                               'grob-property-path
1583                               (cond
1584                                ((ly:music-property m 'grob-property #f) => list)
1585                                (else
1586                                 (ly:music-property m 'grob-property-path))))
1587                   overrides))
1588                 ((PropertySet)
1589                  (cons
1590                   (make-music 'PropertyUnset
1591                               'symbol (ly:music-property m 'symbol))
1592                   overrides))
1593                 ((ContextSpeccedMusic)
1594                  (cons
1595                   (make-music 'ContextSpeccedMusic
1596                               'element (loop (ly:music-property m 'element))
1597                               'context-type (ly:music-property m 'context-type))
1598                   overrides))
1599                 (else
1600                  (if (not warned)
1601                      (begin
1602                        (ly:input-warning location (_ "Cannot revert ~a")
1603                                          (ly:music-property m 'name))
1604                        (set! warned #t)))
1605                  overrides)))
1606             '()
1607             music)))
1608        (cond
1609         ((null? lst) (make-music 'Music))
1610         ((null? (cdr lst)) (car lst))
1611         (else (make-sequential-music lst))))))
1612
1613 unfoldRepeats =
1614 #(define-music-function (parser location music) (ly:music?)
1615    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1616 @code{\\repeat percent} commands in @var{music} to be interpreted
1617 as @code{\\repeat unfold}.")
1618    (unfold-repeats music))
1619
1620 void =
1621 #(define-void-function (parser location arg) (scheme?)
1622    (_i "Accept a scheme argument, return a void expression.
1623 Use this if you want to have a scheme expression evaluated
1624 because of its side-effects, but its value ignored."))
1625
1626 withMusicProperty =
1627 #(define-music-function (parser location sym val music)
1628    (symbol? scheme? ly:music?)
1629    (_i "Set @var{sym} to @var{val} in @var{music}.")
1630
1631    (set! (ly:music-property music sym) val)
1632    music)