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