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