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