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