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