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--2012 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 bendAfter =
 225 #(define-event-function (parser location delta) (real?)
 226    (_i "Create a fall or doit of pitch interval @var{delta}.")
 227    (make-music 'BendAfterEvent
 228                'delta-step delta))
 229
 230 bookOutputName =
 231 #(define-void-function (parser location newfilename) (string?)
 232    (_i "Direct output for the current book block to @var{newfilename}.")
 233    (set! (paper-variable parser #f 'output-filename) newfilename))
 234
 235 bookOutputSuffix =
 236 #(define-void-function (parser location newsuffix) (string?)
 237    (_i "Set the output filename suffix for the current book block to
 238 @var{newsuffix}.")
 239    (set! (paper-variable parser #f 'output-suffix) newsuffix))
 240
 241 %% \breathe is defined as a music function rather than an event identifier to
 242 %% ensure it gets useful input location information: as an event identifier,
 243 %% it would have to be wrapped in an EventChord to prevent it from being
 244 %% treated as a post_event by the parser
 245 breathe =
 246 #(define-music-function (parser location) ()
 247    (_i "Insert a breath mark.")
 248    (make-music 'BreathingEvent))
 249
 250 clef =
 251 #(define-music-function (parser location type) (string?)
 252    (_i "Set the current clef to @var{type}.")
 253    (make-clef-set type))
 254
 255
 256 compoundMeter =
 257 #(define-music-function (parser location args) (pair?)
 258   (_i "Create compound time signatures. The argument is a Scheme list of
 259 lists. Each list describes one fraction, with the last entry being the
 260 denominator, while the first entries describe the summands in the
 261 enumerator. If the time signature consists of just one fraction,
 262 the list can be given directly, i.e. not as a list containing a single list.
 263 For example, a time signature of (3+1)/8 + 2/4 would be created as
 264 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
 265 as @code{\\compoundMeter #'((3 2 8))} or shorter
 266 @code{\\compoundMeter #'(3 2 8)}.")
 267   (let* ((mlen (calculate-compound-measure-length args))
 268          (beat (calculate-compound-base-beat args))
 269          (beatGrouping (calculate-compound-beat-grouping args))
 270          (timesig (cons (ly:moment-main-numerator mlen)
 271                         (ly:moment-main-denominator mlen))))
 272   #{
 273     \once \override Staff.TimeSignature.stencil = #(lambda (grob)
 274       (grob-interpret-markup grob (format-compound-time args)))
 275     \set Timing.timeSignatureFraction = #timesig
 276     \set Timing.baseMoment = #beat
 277     \set Timing.beatStructure = #beatGrouping
 278     \set Timing.beamExceptions = #'()
 279     \set Timing.measureLength = #mlen
 280   #} ))
 281
 282 crossStaff =
 283 #(define-music-function (parser location notes) (ly:music?)
 284   (_i "Create cross-staff stems")
 285   #{
 286   \temporary \override Stem.cross-staff = #cross-staff-connect
 287   \temporary \override Flag.style = #'no-flag
 288   #notes
 289   \revert Stem.cross-staff
 290   \revert Flag.style
 291 #})
 292
 293 cueClef =
 294 #(define-music-function (parser location type) (string?)
 295   (_i "Set the current cue clef to @var{type}.")
 296   (make-cue-clef-set type))
 297
 298 cueClefUnset =
 299 #(define-music-function (parser location) ()
 300   (_i "Unset the current cue clef.")
 301   (make-cue-clef-unset))
 302
 303 cueDuring =
 304 #(define-music-function
 305    (parser location what dir main-music) (string? ly:dir? ly:music?)
 306    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 307 in a CueVoice oriented by @var{dir}.")
 308    (make-music 'QuoteMusic
 309                'element main-music
 310                'quoted-context-type 'CueVoice
 311                'quoted-context-id "cue"
 312                'quoted-music-name what
 313                'quoted-voice-direction dir))
 314
 315 cueDuringWithClef =
 316 #(define-music-function
 317    (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
 318    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 319 in a CueVoice oriented by @var{dir}.")
 320    (make-music 'QuoteMusic
 321                'element main-music
 322                'quoted-context-type 'CueVoice
 323                'quoted-context-id "cue"
 324                'quoted-music-name what
 325                'quoted-music-clef clef
 326                'quoted-voice-direction dir))
 327
 328
 329
 330 displayLilyMusic =
 331 #(define-music-function (parser location music) (ly:music?)
 332    (_i "Display the LilyPond input representation of @var{music}
 333 to the console.")
 334    (newline)
 335    (display-lily-music music parser)
 336    music)
 337
 338 displayMusic =
 339 #(define-music-function (parser location music) (ly:music?)
 340    (_i "Display the internal representation of @var{music} to the console.")
 341    (newline)
 342    (display-scheme-music music)
 343    music)
 344
 345 displayScheme =
 346 #(define-scheme-function (parser location expr) (scheme?)
 347    (_i "Display the internal representation of @var{expr} to the console.")
 348    (newline)
 349    (display-scheme-music expr)
 350    expr)
 351
 352
 353
 354 endSpanners =
 355 #(define-music-function (parser location music) (ly:music?)
 356    (_i "Terminate the next spanner prematurely after exactly one note
 357 without the need of a specific end spanner.")
 358    (let* ((start-span-evs (filter (lambda (ev)
 359                                     (equal? (ly:music-property ev 'span-direction)
 360                                             START))
 361                                   (extract-typed-music music 'span-event)))
 362           (stop-span-evs
 363            (map (lambda (m)
 364                   (music-clone m 'span-direction STOP))
 365                 start-span-evs))
 366           (end-ev-chord (make-music 'EventChord
 367                                     'elements stop-span-evs))
 368           (total (make-music 'SequentialMusic
 369                              'elements (list music
 370                                              end-ev-chord))))
 371      total))
 372
 373 eventChords =
 374 #(define-music-function (parser location music) (ly:music?)
 375    (_i "Compatibility function wrapping @code{EventChord} around
 376 isolated rhythmic events occuring since version 2.15.28, after
 377 expanding repeat chords @samp{q}.")
 378    (event-chord-wrap! music parser))
 379
 380 featherDurations=
 381 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
 382    (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
 383    (let ((orig-duration (ly:music-length argument))
 384          (multiplier (ly:make-moment 1 1)))
 385
 386      (for-each
 387       (lambda (mus)
 388         (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
 389             (begin
 390               (ly:music-compress mus multiplier)
 391               (set! multiplier (ly:moment-mul factor multiplier)))))
 392       (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
 393      (ly:music-compress
 394       argument
 395       (ly:moment-div orig-duration (ly:music-length argument)))
 396
 397      argument))
 398
 399 finger =
 400 #(define-event-function (parser location finger) (number-or-markup?)
 401    (_i "Apply @var{finger} as a fingering indication.")
 402
 403    (make-music
 404             'FingeringEvent
 405             (if (number? finger) 'digit 'text)
 406             finger))
 407
 408 footnote =
 409 #(define-music-function (parser location mark offset footnote item)
 410    ((markup?) number-pair? markup? symbol-list-or-music?)
 411    (_i "Make the markup @var{footnote} a footnote on @var{item}.  The
 412 footnote is marked with a markup @var{mark} moved by @var{offset} with
 413 respect to the marked music.
 414
 415 If @var{mark} is not given or specified as @var{\\default}, it is
 416 replaced by an automatically generated sequence number.  If @var{item}
 417 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
 418 grobs of that type will be marked at the current time step in the
 419 given context (default @code{Bottom}).
 420
 421 If @var{item} is music, the music will get a footnote attached to a
 422 grob immediately attached to the event, like @var{\\tweak} does.  For
 423 attaching a footnote to an @emph{indirectly} caused grob, write
 424 @code{\\single\\footnote}, use @var{item} to specify the grob, and
 425 follow it with the music to annotate.
 426
 427 Like with @code{\\tweak}, if you use a footnote on a following
 428 post-event, the @code{\\footnote} command itself needs to be attached
 429 to the preceding note or rest as a post-event with @code{-}.")
 430    (let ((mus (make-music
 431                'FootnoteEvent
 432                'X-offset (car offset)
 433                'Y-offset (cdr offset)
 434                'automatically-numbered (not mark)
 435                'text (or mark (make-null-markup))
 436                'footnote-text footnote)))
 437      #{ \tweak footnote-music #mus #item #}))
 438
 439 grace =
 440 #(def-grace-function startGraceMusic stopGraceMusic
 441    (_i "Insert @var{music} as grace notes."))
 442
 443 grobdescriptions =
 444 #(define-scheme-function (parser location descriptions) (list?)
 445    (_i "Create a context modification from @var{descriptions}, a list
 446 in the format of @code{all-grob-descriptions}.")
 447    (ly:make-context-mod
 448     (map (lambda (p)
 449            (list 'assign (car p) (list (cdr p))))
 450          descriptions)))
 451
 452 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
 453   (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 454 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
 455   #{
 456     \set harmonicDots = ##t
 457     \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
 458     \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
 459     \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 460                                             (ly:note-head::print grob))
 461     #(make-harmonic
 462        (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
 463     \unset harmonicDots
 464     \revert TabNoteHead.stencil
 465     \revert NoteHead.Y-extent
 466     \revert NoteHead.stencil
 467   #})
 468
 469 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
 470     (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 471 harmonics played on a fretted instrument by touching the strings at the point
 472 given through @var{ratio}.")
 473   #{
 474     \set harmonicDots = ##t
 475     \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
 476     \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
 477                                        (lambda (grob start end)
 478                                                (ly:grob::stencil-height grob)))
 479     \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 480                                             (ly:note-head::print grob))
 481     #(make-harmonic
 482       (calc-harmonic-pitch (ratio->pitch ratio) music))
 483     \unset harmonicDots
 484     \revert TabNoteHead.stencil
 485     \revert NoteHead.Y-extent
 486     \revert NoteHead.stencil
 487   #})
 488
 489 hide =
 490 #(define-music-function (parser location item) (symbol-list-or-music?)
 491    (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
 492 making it invisible while still retaining its dimensions.
 493
 494 If @var{item} is a symbol list of form @code{GrobName} or
 495 @code{Context.GrobName}, the result is an override for the grob name
 496 specified by it.  If @var{item} is a music expression, the result is
 497 the same music expression with an appropriate tweak applied to it.")
 498    (if (ly:music? item)
 499        #{ \tweak transparent ##t #item #}
 500        #{ \override #item . transparent = ##t #}))
 501
 502 inStaffSegno =
 503 #(define-music-function (parser location) ()
 504    (_i "Put the segno variant 'varsegno' at this position into the staff,
 505 compatible with the repeat command.")
 506    (make-music 'ApplyContext
 507                'procedure
 508                (lambda (ctx)
 509                  (let ((score-ctx (ly:context-find ctx 'Score)))
 510                    (if (ly:context? score-ctx)
 511                      (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
 512                        (if (eq? (memq 'segno-display old-rc) #f)
 513                          (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
 514
 515 instrumentSwitch =
 516 #(define-music-function
 517    (parser location name) (string?)
 518    (_i "Switch instrument to @var{name}, which must be predefined with
 519 @code{\\addInstrumentDefinition}.")
 520    (let* ((handle (assoc name instrument-definitions))
 521           (instrument-def (if handle (cdr handle) '())))
 522
 523      (if (not handle)
 524          (ly:input-warning location "No such instrument: ~a" name))
 525      (context-spec-music
 526       (make-music 'SimultaneousMusic
 527                   'elements
 528                   (map (lambda (kv)
 529                          (make-property-set
 530                           (car kv)
 531                           (cdr kv)))
 532                        instrument-def))
 533       'Staff)))
 534
 535
 536
 537 keepWithTag =
 538 #(define-music-function (parser location tag music)
 539    (symbol-list-or-symbol? ly:music?)
 540    (_i "Include only elements of @var{music} that are either untagged
 541 or tagged with one of the tags in @var{tag}.  @var{tag} may be either
 542 a single symbol or a list of symbols.")
 543    (music-filter
 544     (if (symbol? tag)
 545         (lambda (m)
 546           (let ((music-tags (ly:music-property m 'tags)))
 547             (or (null? music-tags)
 548                 (memq tag music-tags))))
 549         (lambda (m)
 550           (let ((music-tags (ly:music-property m 'tags)))
 551             (or (null? music-tags)
 552                 (any (lambda (t) (memq t music-tags)) tag)))))
 553     music))
 554
 555 key =
 556 #(define-music-function (parser location tonic pitch-alist)
 557    ((ly:pitch? '()) (list? '()))
 558    (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
 559 If both are null, just generate @code{KeyChangeEvent}.")
 560    (cond ((null? tonic) (make-music 'KeyChangeEvent))
 561          ((null? pitch-alist)
 562           (ly:parser-error parser (_ "second argument must be pitch list")
 563                            location)
 564           (make-music 'SequentialMusic 'void #t))
 565          (else
 566           (ly:music-transpose
 567            (make-music 'KeyChangeEvent
 568                 'tonic (ly:make-pitch 0 0 0)
 569                 'pitch-alist pitch-alist)
 570            tonic))))
 571
 572 killCues =
 573 #(define-music-function (parser location music) (ly:music?)
 574    (_i "Remove cue notes from @var{music}.")
 575    (music-map
 576     (lambda (mus)
 577       (if (and (string? (ly:music-property mus 'quoted-music-name))
 578                (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
 579           (ly:music-property mus 'element)
 580           mus))
 581     music))
 582
 583
 584
 585 label =
 586 #(define-music-function (parser location label) (symbol?)
 587    (_i "Create @var{label} as a bookmarking label.")
 588    (make-music 'EventChord
 589                'page-marker #t
 590                'page-label label
 591                'elements (list (make-music 'LabelEvent
 592                                            'page-label label))))
 593
 594
 595 language =
 596 #(define-void-function (parser location language) (string?)
 597    (_i "Set note names for language @var{language}.")
 598    (note-names-language parser language))
 599
 600 languageSaveAndChange =
 601 #(define-void-function (parser location language) (string?)
 602   (_i "Store the previous pitchnames alist, and set a new one.")
 603   (set! previous-pitchnames pitchnames)
 604   (note-names-language parser language))
 605
 606 languageRestore =
 607 #(define-void-function (parser location) ()
 608    (_i "Restore a previously-saved pitchnames alist.")
 609    (if previous-pitchnames
 610        (begin
 611         (set! pitchnames previous-pitchnames)
 612         (ly:parser-set-note-names parser pitchnames))
 613       (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
 614
 615
 616 makeClusters =
 617 #(define-music-function (parser location arg) (ly:music?)
 618    (_i "Display chords in @var{arg} as clusters.")
 619    (music-map note-to-cluster arg))
 620
 621 modalInversion =
 622 #(define-music-function (parser location around to scale music)
 623     (ly:pitch? ly:pitch? ly:music? ly:music?)
 624     (_i "Invert @var{music} about @var{around} using @var{scale} and
 625 transpose from @var{around} to @var{to}.")
 626     (let ((inverter (make-modal-inverter around to scale)))
 627       (change-pitches music inverter)
 628       music))
 629
 630 modalTranspose =
 631 #(define-music-function (parser location from to scale music)
 632     (ly:pitch? ly:pitch? ly:music? ly:music?)
 633     (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
 634 using @var{scale}.")
 635     (let ((transposer (make-modal-transposer from to scale)))
 636       (change-pitches music transposer)
 637       music))
 638
 639 inversion =
 640 #(define-music-function
 641    (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
 642    (_i "Invert @var{music} about @var{around} and
 643 transpose from @var{around} to @var{to}.")
 644    (music-invert around to music))
 645
 646 mark =
 647 #(define-music-function
 648    (parser location label) ((scheme? '()))
 649   "Make the music for the \\mark command."
 650   (let* ((set (and (integer? label)
 651                    (context-spec-music (make-property-set 'rehearsalMark label)
 652                                       'Score)))
 653          (ev (make-music 'MarkEvent
 654                          'origin location)))
 655
 656     (if set
 657         (make-sequential-music (list set ev))
 658         (begin
 659           (set! (ly:music-property ev 'label) label)
 660           ev))))
 661
 662 musicMap =
 663 #(define-music-function (parser location proc mus) (procedure? ly:music?)
 664    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 665    (music-map proc mus))
 666
 667 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 668 %% because music identifiers are not allowed at top-level.
 669 noPageBreak =
 670 #(define-music-function (location parser) ()
 671    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 672 markups), or inside a score.")
 673    (make-music 'EventChord
 674                'page-marker #t
 675                'page-break-permission 'forbid
 676                'elements (list (make-music 'PageBreakEvent
 677                                            'break-permission '()))))
 678
 679 noPageTurn =
 680 #(define-music-function (location parser) ()
 681    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 682 markups), or inside a score.")
 683    (make-music 'EventChord
 684                'page-marker #t
 685                'page-turn-permission 'forbid
 686                'elements (list (make-music 'PageTurnEvent
 687                                            'break-permission '()))))
 688
 689
 690
 691 octaveCheck =
 692 #(define-music-function (parser location pitch) (ly:pitch?)
 693    (_i "Octave check.")
 694    (make-music 'RelativeOctaveCheck
 695                'pitch pitch))
 696
 697 omit =
 698 #(define-music-function (parser location item) (symbol-list-or-music?)
 699    (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
 700 effectively omitting it without taking up space.
 701
 702 If @var{item} is a symbol list of form @code{GrobName} or
 703 @code{Context.GrobName}, the result is an override for the grob name
 704 specified by it.  If @var{item} is a music expression, the result is
 705 the same music expression with an appropriate tweak applied to it.")
 706    (if (ly:music? item)
 707        #{ \tweak stencil ##f #item #}
 708        #{ \override #item . stencil = ##f #}))
 709
 710 once =
 711 #(define-music-function (parser location music) (ly:music?)
 712    (_i "Set @code{once} to @code{#t} on all layout instruction events in @var{music}.")
 713    (music-map
 714     (lambda (m)
 715       (cond ((music-is-of-type? m 'layout-instruction-event)
 716              (set! (ly:music-property m 'once) #t))
 717             ((ly:duration? (ly:music-property m 'duration))
 718              (ly:music-warning m (_ "Cannot apply \\once to timed music"))))
 719       m)
 720     music))
 721
 722 ottava =
 723 #(define-music-function (parser location octave) (integer?)
 724    (_i "Set the octavation.")
 725    (make-music 'OttavaMusic
 726                'ottava-number octave))
 727
 728 overrideTimeSignatureSettings =
 729 #(define-music-function
 730    (parser location time-signature base-moment beat-structure beam-exceptions)
 731    (fraction? fraction? list? list?)
 732
 733    (_i "Override @code{timeSignatureSettings}
 734 for time signatures of @var{time-signature} to have settings
 735 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 736
 737    ;; TODO -- add warning if largest value of grouping is
 738    ;;       greater than time-signature.
 739   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 740     (override-time-signature-setting time-signature setting)))
 741
 742 overrideProperty =
 743 #(define-music-function (parser location grob-property-path value)
 744    (symbol-list? scheme?)
 745
 746    (_i "Set the grob property specified by @var{grob-property-path} to
 747 @var{value}.  @var{grob-property-path} is a symbol list of the form
 748 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
 749 with subproperties given as well.")
 750    (let ((p (check-grob-path grob-property-path parser location
 751                              #:default 'Bottom
 752                              #:min 3)))
 753      (if p
 754          (make-music 'ApplyOutputEvent
 755                      'context-type (first p)
 756                      'procedure
 757                      (lambda (grob orig-context context)
 758                        (if (equal?
 759                             (cdr (assoc 'name (ly:grob-property grob 'meta)))
 760                             (second p))
 761                            (ly:grob-set-nested-property!
 762                             grob (cddr p) value))))
 763          (make-music 'Music))))
 764
 765
 766
 767
 768
 769
 770 %% pageBreak and pageTurn are music functions (iso music indentifiers),
 771 %% because music identifiers are not allowed at top-level.
 772 pageBreak =
 773 #(define-music-function (location parser) ()
 774    (_i "Force a page break.  May be used at toplevel (i.e., between scores or
 775 markups), or inside a score.")
 776    (make-music 'EventChord
 777                'page-marker #t
 778                'line-break-permission 'force
 779                'page-break-permission 'force
 780                'elements (list (make-music 'LineBreakEvent
 781                                            'break-permission 'force)
 782                                (make-music 'PageBreakEvent
 783                                            'break-permission 'force))))
 784
 785 pageTurn =
 786 #(define-music-function (location parser) ()
 787    (_i "Force a page turn between two scores or top-level markups.")
 788    (make-music 'EventChord
 789                'page-marker #t
 790                'line-break-permission 'force
 791                'page-break-permission 'force
 792                'page-turn-permission 'force
 793                'elements (list (make-music 'LineBreakEvent
 794                                            'break-permission 'force)
 795                                (make-music 'PageBreakEvent
 796                                            'break-permission 'force)
 797                                (make-music 'PageTurnEvent
 798                                            'break-permission 'force))))
 799
 800 parallelMusic =
 801 #(define-void-function (parser location voice-ids music) (list? ly:music?)
 802    (_i "Define parallel music sequences, separated by '|' (bar check signs),
 803 and assign them to the identifiers provided in @var{voice-ids}.
 804
 805 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
 806
 807 @var{music}: a music sequence, containing BarChecks as limiting expressions.
 808
 809 Example:
 810
 811 @verbatim
 812   \\parallelMusic #'(A B C) {
 813     c c | d d | e e |
 814     d d | e e | f f |
 815   }
 816 <==>
 817   A = { c c | d d | }
 818   B = { d d | e e | }
 819   C = { e e | f f | }
 820 @end verbatim
 821 ")
 822    (define (bar-check? m)
 823      "Checks whether m is a bar check."
 824      (eq? (ly:music-property m 'name) 'BarCheck))
 825    (define (recurse-and-split music)
 826      "This returns either a list of music split along barchecks, or
 827 @code{#f}."
 828      (let ((elt (ly:music-property music 'element))
 829            (elts (ly:music-property music 'elements)))
 830        (cond ((ly:music? elt)
 831               (let ((lst (recurse-and-split elt)))
 832                 (and lst
 833                      (map
 834                       (lambda (x)
 835                         (let ((res (music-clone music 'element x)))
 836                           (if (ly:input-location?
 837                                (ly:music-property x 'origin))
 838                               (set! (ly:music-property res 'origin)
 839                                     (ly:music-property x 'origin)))
 840                           res))
 841                       lst))))
 842              ((any bar-check? elts)
 843               (let* ((voices (apply circular-list
 844                                     (make-list (length voice-ids)
 845                                                '())))
 846                      (current-voices voices)
 847                      (current-sequence '()))
 848                 ;;
 849                 ;; utilities
 850                 (define (push-music m)
 851                   "Push the music expression into the current sequence"
 852                   (set! current-sequence (cons m current-sequence)))
 853                 (define (change-voice)
 854                   "Stores the previously built sequence into the current voice and
 855        change to the following voice."
 856                   (set-car! current-voices
 857                             (cons (reverse! current-sequence)
 858                                   (car current-voices)))
 859                   (set! current-sequence '())
 860                   (set! current-voices (cdr current-voices)))
 861                 (for-each (lambda (m)
 862                             (let ((split? (recurse-and-split m)))
 863                               (if split?
 864                                   (for-each
 865                                    (lambda (m)
 866                                      (push-music m)
 867                                      (change-voice))
 868                                    split?)
 869                                   (begin
 870                                     (push-music m)
 871                                     (if (bar-check? m) (change-voice))))))
 872                           elts)
 873                 (if (pair? current-sequence) (change-voice))
 874                 ;; un-circularize `voices' and reorder the voices
 875
 876                 (set! voices (map reverse!
 877                                   (list-head voices (length voice-ids))))
 878
 879                 ;; check sequence length
 880                 (apply for-each (lambda seqs
 881                                   (define (seq-len seq)
 882                                     (reduce ly:moment-add
 883                                             (ly:make-moment 0)
 884                                             (map ly:music-length seq)))
 885                                   (let ((moment-reference (seq-len (car seqs))))
 886                                     (for-each (lambda (seq)
 887                                                 (if (not (equal? (seq-len seq)
 888                                                                  moment-reference))
 889                                                     (ly:music-warning
 890                                                      (if (pair? seq)
 891                                                          (last seq)
 892                                                          (caar seqs))
 893                                                      (_ "Bars in parallel music don't have the same length"))))
 894                                               seqs)))
 895                        voices)
 896                 (map
 897                  (lambda (lst)
 898                    (set! lst (concatenate! lst))
 899                    (let ((res (music-clone music 'elements lst)))
 900                      (if (and (pair? lst)
 901                               (ly:input-location? (ly:music-property
 902                                                    (car lst)
 903                                                    'origin)))
 904                          (set! (ly:music-property res 'origin)
 905                                (ly:music-property (car lst) 'origin)))
 906                      res))
 907                  voices)))
 908              (else #f))))
 909    (let ((voices (recurse-and-split music)))
 910      (if voices
 911          ;;
 912          ;; bind voice identifiers to the voices
 913          (for-each (lambda (voice-id voice)
 914                      (ly:parser-define! parser voice-id voice))
 915           voice-ids voices)
 916          (ly:music-warning music
 917                            (_ "ignoring parallel music without barchecks")))))
 918
 919 parenthesize =
 920 #(define-music-function (parser loc arg) (ly:music?)
 921    (_i "Tag @var{arg} to be parenthesized.")
 922
 923    (if (memq 'event-chord (ly:music-property arg 'types))
 924        ;; arg is an EventChord -> set the parenthesize property
 925        ;; on all child notes and rests
 926        (for-each
 927         (lambda (ev)
 928           (if (or (memq 'note-event (ly:music-property ev 'types))
 929                   (memq 'rest-event (ly:music-property ev 'types)))
 930               (set! (ly:music-property ev 'parenthesize) #t)))
 931         (ly:music-property arg 'elements))
 932        ;; No chord, simply set property for this expression:
 933        (set! (ly:music-property arg 'parenthesize) #t))
 934    arg)
 935
 936 partcombine =
 937 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 938    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 939 that they share a staff.")
 940    (make-part-combine-music parser
 941                             (list part1 part2) #f))
 942
 943 partcombineUp =
 944 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 945    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 946 that they share a staff with stems directed upward.")
 947    (make-part-combine-music parser
 948                             (list part1 part2) UP))
 949
 950 partcombineDown =
 951 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 952    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 953 that they share a staff with stems directed downward.")
 954    (make-part-combine-music parser
 955                             (list part1 part2) DOWN))
 956
 957 partcombineForce =
 958 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
 959    (_i "Override the part-combiner.")
 960    (make-music 'EventChord
 961                'elements (list (make-music 'PartCombineForceEvent
 962                                            'forced-type type
 963                                            'once once))))
 964 partcombineApart = \partcombineForce #'apart ##f
 965 partcombineApartOnce = \partcombineForce #'apart ##t
 966 partcombineChords = \partcombineForce #'chords ##f
 967 partcombineChordsOnce = \partcombineForce #'chords ##t
 968 partcombineUnisono = \partcombineForce #'unisono ##f
 969 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
 970 partcombineSoloI = \partcombineForce #'solo1 ##f
 971 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
 972 partcombineSoloII = \partcombineForce #'solo2 ##f
 973 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
 974 partcombineAutomatic = \partcombineForce ##f ##f
 975 partcombineAutomaticOnce = \partcombineForce ##f ##t
 976
 977 partial =
 978 #(define-music-function (parser location dur) (ly:duration?)
 979   (_i "Make a partial measure.")
 980
 981   ;; We use `descend-to-context' here instead of `context-spec-music' to
 982   ;; ensure \partial still works if the Timing_translator is moved
 983     (descend-to-context
 984      (context-spec-music (make-music 'PartialSet
 985                                      'origin location
 986                                      'duration dur)
 987                          'Timing)
 988      'Score))
 989
 990 pitchedTrill =
 991 #(define-music-function
 992    (parser location main-note secondary-note)
 993    (ly:music? ly:music?)
 994    (_i "Print a trill with @var{main-note} as the main note of the trill and
 995 print @var{secondary-note} as a stemless note head in parentheses.")
 996    (let* ((get-notes (lambda (ev-chord)
 997                        (extract-named-music ev-chord 'NoteEvent)))
 998           (sec-note-events (get-notes secondary-note))
 999           (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1000      (if (pair? sec-note-events)
1001          (begin
1002            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1003                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1004
1005              (if (ly:pitch? trill-pitch)
1006                  (for-each (lambda (m)
1007                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1008                  (begin
1009                    (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
1010                    (display sec-note-events)))
1011
1012              (if (eq? forced #t)
1013                  (for-each (lambda (m)
1014                              (ly:music-set-property! m 'force-accidental forced))
1015                            trill-events)))))
1016      main-note))
1017
1018 pushToTag =
1019 #(define-music-function (parser location tag more music)
1020    (symbol? ly:music? ly:music?)
1021    (_i "Add @var{more} to the front of @code{elements} of all music
1022 expressions in @var{music} that are tagged with @var{tag}.")
1023    (music-map (lambda (m)
1024                 (if (memq tag (ly:music-property m 'tags))
1025                     (set! (ly:music-property m 'elements)
1026                           (cons more (ly:music-property m 'elements))))
1027                 m)
1028               music))
1029
1030 quoteDuring =
1031 #(define-music-function (parser location what main-music) (string? ly:music?)
1032    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
1033 of the quoted voice, as specified in an @code{\\addQuote} command.
1034 @var{main-music} is used to indicate the length of music to be quoted;
1035 usually contains spacers or multi-measure rests.")
1036    (make-music 'QuoteMusic
1037                'element main-music
1038                'quoted-music-name what))
1039
1040 relative =
1041 #(define-music-function (parser location pitch music)
1042    ((ly:pitch?) ly:music?)
1043    (_i "Make @var{music} relative to @var{pitch}.  If @var{pitch} is
1044 omitted, the first note in @var{music} is given in absolute pitch.")
1045    ;; When \relative has no clear decision (can only happen with
1046    ;; scales with an even number of steps), it goes down (see
1047    ;; pitch.cc).  The following formula puts out f for both the normal
1048    ;; 7-step scale as well as for a "shortened" scale missing the
1049    ;; final b.  In either case, a first note of c will end up as c,
1050    ;; namely pitch (-1, 0, 0).
1051    (ly:make-music-relative! music
1052                             (or pitch
1053                                 (ly:make-pitch
1054                                  -1
1055                                  (quotient
1056                                   ;; size of current scale:
1057                                   (ly:pitch-steps (ly:make-pitch 1 0))
1058                                   2))))
1059    (make-music 'RelativeOctaveMusic
1060                'element music))
1061
1062 removeWithTag =
1063 #(define-music-function (parser location tag music)
1064    (symbol-list-or-symbol? ly:music?)
1065    (_i "Remove elements of @var{music} that are tagged with one of the
1066 tags in @var{tag}.  @var{tag} may be either a single symbol or a list
1067 of symbols.")
1068    (music-filter
1069     (if (symbol? tag)
1070         (lambda (m)
1071           (not (memq tag (ly:music-property m 'tags))))
1072         (lambda (m)
1073           (let ((music-tags (ly:music-property m 'tags)))
1074             (or (null? music-tags)
1075                 (not (any (lambda (t) (memq t music-tags)) tag))))))
1076     music))
1077
1078 resetRelativeOctave =
1079 #(define-music-function (parser location pitch) (ly:pitch?)
1080    (_i "Set the octave inside a \\relative section.")
1081
1082    (make-music 'SequentialMusic
1083                'to-relative-callback
1084                (lambda (music last-pitch) pitch)))
1085
1086 retrograde =
1087 #(define-music-function (parser location music)
1088     (ly:music?)
1089     (_i "Return @var{music} in reverse order.")
1090     (retrograde-music music))
1091
1092 revertTimeSignatureSettings =
1093 #(define-music-function
1094    (parser location time-signature)
1095    (pair?)
1096
1097    (_i "Revert @code{timeSignatureSettings}
1098 for time signatures of @var{time-signature}.")
1099    (revert-time-signature-setting time-signature))
1100
1101 rightHandFinger =
1102 #(define-event-function (parser location finger) (number-or-markup?)
1103    (_i "Apply @var{finger} as a fingering indication.")
1104
1105    (make-music
1106             'StrokeFingerEvent
1107             (if (number? finger) 'digit 'text)
1108             finger))
1109
1110 scaleDurations =
1111 #(define-music-function (parser location fraction music)
1112    (fraction? ly:music?)
1113    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1114    (ly:music-compress music
1115                       (ly:make-moment (car fraction) (cdr fraction))))
1116
1117 settingsFrom =
1118 #(define-scheme-function (parser location ctx music)
1119    ((symbol?) ly:music?)
1120    (_i "Take the layout instruction events from @var{music}, optionally
1121 restricted to those applying to context type @var{ctx}, and return
1122 a context modification duplicating their effect.")
1123    (let ((mods (ly:make-context-mod)))
1124      (define (musicop m)
1125        (if (music-is-of-type? m 'layout-instruction-event)
1126            (ly:add-context-mod
1127             mods
1128             (case (ly:music-property m 'name)
1129               ((PropertySet)
1130                (list 'assign
1131                      (ly:music-property m 'symbol)
1132                      (ly:music-property m 'value)))
1133               ((PropertyUnset)
1134                (list 'unset
1135                      (ly:music-property m 'symbol)))
1136               ((OverrideProperty)
1137                (cons* 'push
1138                       (ly:music-property m 'symbol)
1139                       (ly:music-property m 'grob-value)
1140                       (cond
1141                        ((ly:music-property m 'grob-property #f) => list)
1142                        (else
1143                         (ly:music-property m 'grob-property-path)))))
1144               ((RevertProperty)
1145                (cons* 'pop
1146                       (ly:music-property m 'symbol)
1147                       (cond
1148                        ((ly:music-property m 'grob-property #f) => list)
1149                        (else
1150                         (ly:music-property m 'grob-property-path)))))))
1151            (case (ly:music-property m 'name)
1152              ((ApplyContext)
1153               (ly:add-context-mod mods
1154                                   (list 'apply
1155                                         (ly:music-property m 'procedure))))
1156              ((ContextSpeccedMusic)
1157               (if (or (not ctx)
1158                       (eq? ctx (ly:music-property m 'context-type)))
1159                   (musicop (ly:music-property m 'element))))
1160              (else
1161               (let ((callback (ly:music-property m 'elements-callback)))
1162                 (if (procedure? callback)
1163                     (for-each musicop (callback m))))))))
1164      (musicop music)
1165      mods))
1166
1167 shape =
1168 #(define-music-function (parser location offsets item)
1169    (list? symbol-list-or-music?)
1170    (_i "Offset control-points of @var{item} by @var{offsets}.  The
1171 argument is a list of number pairs or list of such lists.  Each
1172 element of a pair represents an offset to one of the coordinates of a
1173 control-point.  If @var{item} is a string, the result is
1174 @code{\\once\\override} for the specified grob type.  If @var{item} is
1175 a music expression, the result is the same music expression with an
1176 appropriate tweak applied.")
1177    (define (shape-curve grob)
1178      (let* ((orig (ly:grob-original grob))
1179             (siblings (if (ly:spanner? grob)
1180                           (ly:spanner-broken-into orig) '()))
1181             (total-found (length siblings))
1182             (function (assoc-get 'control-points
1183                                  (reverse (ly:grob-basic-properties grob))))
1184             (coords (function grob)))
1185
1186        (define (offset-control-points offsets)
1187          (if (null? offsets)
1188              coords
1189              (map
1190                (lambda (x y) (coord-translate x y))
1191                coords offsets)))
1192
1193        (define (helper sibs offs)
1194          (if (pair? offs)
1195              (if (eq? (car sibs) grob)
1196                  (offset-control-points (car offs))
1197                  (helper (cdr sibs) (cdr offs)))
1198              coords))
1199
1200        ;; we work with lists of lists
1201        (if (or (null? offsets)
1202                (not (list? (car offsets))))
1203            (set! offsets (list offsets)))
1204
1205        (if (>= total-found 2)
1206            (helper siblings offsets)
1207            (offset-control-points (car offsets)))))
1208    #{ \tweak control-points #shape-curve #item #})
1209
1210 shiftDurations =
1211 #(define-music-function (parser location dur dots arg)
1212    (integer? integer? ly:music?)
1213    (_i "Change the duration of @var{arg} by adding @var{dur} to the
1214 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1215
1216    (music-map
1217     (lambda (x)
1218       (shift-one-duration-log x dur dots)) arg))
1219
1220 single =
1221 #(define-music-function (parser location overrides music)
1222    (ly:music? ly:music?)
1223    (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1224 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1225    (set! (ly:music-property music 'tweaks)
1226          (fold-some-music
1227           (lambda (m) (eq? (ly:music-property m 'name)
1228                            'OverrideProperty))
1229           (lambda (m tweaks)
1230             (let ((p (cond
1231                       ((ly:music-property m 'grob-property #f) => list)
1232                       (else
1233                        (ly:music-property m 'grob-property-path)))))
1234               (acons (cons (ly:music-property m 'symbol) ;grob name
1235                            (if (pair? (cdr p))
1236                                p ;grob property path
1237                                (car p))) ;grob property
1238                      (ly:music-property m 'grob-value)
1239                      tweaks)))
1240           (ly:music-property music 'tweaks)
1241           overrides))
1242    music)
1243
1244 skip =
1245 #(define-music-function (parser location dur) (ly:duration?)
1246   (_i "Skip forward by @var{dur}.")
1247   (make-music 'SkipMusic
1248               'duration dur))
1249
1250
1251 slashedGrace =
1252 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1253    (_i "Create slashed graces (slashes through stems, but no slur) from
1254 the following music expression"))
1255
1256 spacingTweaks =
1257 #(define-music-function (parser location parameters) (list?)
1258    (_i "Set the system stretch, by reading the 'system-stretch property of
1259 the `parameters' assoc list.")
1260    #{
1261      \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1262      #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1263              (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1264    #})
1265
1266 styledNoteHeads =
1267 #(define-music-function (parser location style heads music)
1268    (symbol? symbol-list-or-symbol? ly:music?)
1269    (_i "Set @var{heads} in @var{music} to @var{style}.")
1270    (style-note-heads heads style music))
1271
1272 tag =
1273 #(define-music-function (parser location tag music) (symbol-list-or-symbol? ly:music?)
1274    (_i "Tag the following @var{music} with @var{tag} and return the
1275 result, by adding the single symbol or symbol list @var{tag} to the
1276 @code{tags} property of @var{music}.")
1277
1278    (set!
1279     (ly:music-property music 'tags)
1280     ((if (symbol? tag) cons append)
1281      tag
1282      (ly:music-property music 'tags)))
1283    music)
1284
1285 temporary =
1286 #(define-music-function (parser location music)
1287    (ly:music?)
1288    (_i "Make any @code{\\override} in @var{music} replace an existing
1289 grob property value only temporarily, restoring the old value when a
1290 corresponding @code{\\revert} is executed.  This is achieved by
1291 clearing the @samp{pop-first} property normally set on
1292 @code{\\override}s.
1293
1294 An @code{\\override}/@/@code{\\revert} sequence created by using
1295 @code{\\temporary} and @code{\\undo} on the same music containing
1296 overrides will cancel out perfectly or cause a@tie{}warning.
1297
1298 Non-property-related music is ignored, warnings are generated for any
1299 property-changing music that isn't an @code{\\override}.")
1300    (define warned #f)
1301    (for-some-music
1302     (lambda (m)
1303       (and (or (music-is-of-type? m 'layout-instruction-event)
1304                (music-is-of-type? m 'context-specification)
1305                (music-is-of-type? m 'apply-context)
1306                (music-is-of-type? m 'time-signature-music))
1307            (case (ly:music-property m 'name)
1308              ((OverrideProperty)
1309               (if (ly:music-property m 'pop-first #f)
1310                   (set! (ly:music-property m 'pop-first) '()))
1311               (if (ly:music-property m 'once #f)
1312                   (set! (ly:music-property m 'once) '()))
1313               #t)
1314              ((ContextSpeccedMusic)
1315               #f)
1316              (else
1317               (if (not warned)
1318                   (begin
1319                     (ly:input-warning location (_ "Cannot make ~a revertible")
1320                                       (ly:music-property m 'name))
1321                     (set! warned #t)))
1322               #t))))
1323     music)
1324    music)
1325
1326 time =
1327 #(define-music-function (parser location beat-structure fraction)
1328    ((number-list? '()) fraction?)
1329    (_i "Set @var{fraction} as time signature, with optional
1330 number list @var{beat-structure} before it.")
1331   (make-music 'TimeSignatureMusic
1332               'numerator (car fraction)
1333               'denominator (cdr fraction)
1334               'beat-structure beat-structure))
1335
1336 times =
1337 #(define-music-function (parser location fraction music)
1338    (fraction? ly:music?)
1339    (_i "Scale @var{music} in time by @var{fraction}.")
1340   (make-music 'TimeScaledMusic
1341               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1342               'numerator (car fraction)
1343               'denominator (cdr fraction)))
1344
1345 transpose =
1346 #(define-music-function
1347    (parser location from to music)
1348    (ly:pitch? ly:pitch? ly:music?)
1349
1350    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1351    (make-music 'TransposedMusic
1352                'element (ly:music-transpose music (ly:pitch-diff to from))))
1353
1354 transposedCueDuring =
1355 #(define-music-function
1356    (parser location what dir pitch main-music)
1357    (string? ly:dir? ly:pitch? ly:music?)
1358
1359    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1360 using the transposition defined by @var{pitch}.  This happens
1361 simultaneously with @var{main-music}, which is usually a rest.  The
1362 argument @var{dir} determines whether the cue notes should be notated
1363 as a first or second voice.")
1364
1365    (make-music 'QuoteMusic
1366                'element main-music
1367                'quoted-context-type 'CueVoice
1368                'quoted-context-id "cue"
1369                'quoted-music-name what
1370                'quoted-voice-direction dir
1371                ;; following is inverse of instrumentTransposition for
1372                ;; historical reasons
1373                'quoted-transposition pitch))
1374
1375 transposition =
1376 #(define-music-function (parser location pitch) (ly:pitch?)
1377    (_i "Set instrument transposition")
1378
1379    (context-spec-music
1380     (make-property-set 'instrumentTransposition pitch)
1381     'Staff))
1382
1383 tuplet =
1384 #(define-music-function (parser location ratio tuplet-span music)
1385    (fraction? (ly:duration? '()) ly:music?)
1386    (_i "Scale the given @var{music} to tuplets.  @var{ratio} is a
1387 fraction that specifies how many notes are played in place of the
1388 nominal value: it will be @samp{3/2} for triplets, namely three notes
1389 being played in place of two.  If the optional duration
1390 @var{tuplet-span} is specified, it is used instead of
1391 @code{tupletSpannerDuration} for grouping the tuplets.
1392 For example,
1393 @example
1394 \\tuplet 3/2 4 @{ c8 c c c c c @}
1395 @end example
1396 will result in two groups of three tuplets, each group lasting for a
1397 quarter note.")
1398    (make-music 'TimeScaledMusic
1399                'element (ly:music-compress
1400                          music
1401                          (ly:make-moment (cdr ratio) (car ratio)))
1402                'numerator (cdr ratio)
1403                'denominator (car ratio)
1404                'duration tuplet-span))
1405
1406 tupletSpan =
1407 #(define-music-function (parser location tuplet-span)
1408    ((ly:duration?))
1409    (_i "Set @code{tupletSpannerDuration}, the length into which
1410 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1411 own will group its tuplets, to the duration @var{tuplet-span}.  To
1412 revert to the default of not subdividing the contents of a @code{\\tuplet}
1413 command without explicit @samp{tuplet-span}, use
1414 @example
1415 \\tupletSpan \\default
1416 @end example
1417 ")
1418    (if tuplet-span
1419        #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1420        #{ \unset tupletSpannerDuration #}))
1421
1422 tweak =
1423 #(define-music-function (parser location prop value item)
1424    (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1425    (_i "Add a tweak to the following @var{item}, usually music.
1426 Layout objects created by @var{item} get their property @var{prop}
1427 set to @var{value}.  If @var{prop} has the form @samp{Grob.property}, like with
1428 @example
1429 \\tweak Accidental.color #red cis'
1430 @end example
1431 an indirectly created grob (@samp{Accidental} is caused by
1432 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1433 are affected.
1434
1435 As a special case, @var{item} may be a symbol list specifying a grob
1436 path, in which case @code{\\once\\override} is called on it instead of
1437 creating tweaked music.  This is mainly useful when using
1438 @code{\\tweak} as as a component for building other functions.
1439
1440 @var{prop} can contain additional elements in which case a nested
1441 property (inside of an alist) is tweaked.")
1442    (if (ly:music? item)
1443        (let ((p (check-grob-path prop parser location
1444                                  #:start 1
1445                                  #:default #t
1446                                  #:min 2)))
1447          (if p
1448              (set! (ly:music-property item 'tweaks)
1449                    (acons (cond ((pair? (cddr p)) p)
1450                                 ((symbol? (car p))
1451                                  (cons (car p) (cadr p)))
1452                                 (else (cadr p)))
1453                           value
1454                           (ly:music-property item 'tweaks))))
1455          item)
1456        ;; We could just throw this at \override and let it sort this
1457        ;; out on its own, but this way we should get better error
1458        ;; diagnostics.
1459        (let ((a (check-grob-path item parser location
1460                                  #:default 'Bottom #:min 2 #:max 2))
1461              (b (check-grob-path prop parser location
1462                                  #:start 2)))
1463          (if (and a b)
1464              #{ \once\override #(append a b) = #value #}
1465              (make-music 'Music)))))
1466
1467 undo =
1468 #(define-music-function (parser location music)
1469    (ly:music?)
1470    (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1471 @code{\\revert} and @code{\\unset}, respectively.  Any reverts and
1472 unsets already in @var{music} cause a warning.  Non-property-related music is ignored.")
1473    (define warned #f)
1474    (let loop
1475        ((music music))
1476      (let
1477          ((lst
1478            (fold-some-music
1479             (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1480                             (music-is-of-type? m 'context-specification)
1481                             (music-is-of-type? m 'apply-context)
1482                             (music-is-of-type? m 'time-signature-music)))
1483             (lambda (m overrides)
1484               (case (ly:music-property m 'name)
1485                 ((OverrideProperty)
1486                  (cons
1487                   (make-music 'RevertProperty
1488                               'symbol (ly:music-property m 'symbol)
1489                               'grob-property-path
1490                               (cond
1491                                ((ly:music-property m 'grob-property #f) => list)
1492                                (else
1493                                 (ly:music-property m 'grob-property-path))))
1494                   overrides))
1495                 ((PropertySet)
1496                  (cons
1497                   (make-music 'PropertyUnset
1498                               'symbol (ly:music-property m 'symbol))
1499                   overrides))
1500                 ((ContextSpeccedMusic)
1501                  (cons
1502                   (make-music 'ContextSpeccedMusic
1503                               'element (loop (ly:music-property m 'element))
1504                               'context-type (ly:music-property m 'context-type))
1505                   overrides))
1506                 (else
1507                  (if (not warned)
1508                      (begin
1509                        (ly:input-warning location (_ "Cannot revert ~a")
1510                                          (ly:music-property m 'name))
1511                        (set! warned #t)))
1512                  overrides)))
1513             '()
1514             music)))
1515        (cond
1516         ((null? lst) (make-music 'Music))
1517         ((null? (cdr lst)) (car lst))
1518         (else (make-sequential-music lst))))))
1519
1520 unfoldRepeats =
1521 #(define-music-function (parser location music) (ly:music?)
1522    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1523 @code{\\repeat percent} commands in @var{music} to be interpreted
1524 as @code{\\repeat unfold}.")
1525    (unfold-repeats music))
1526
1527 void =
1528 #(define-void-function (parser location arg) (scheme?)
1529    (_i "Accept a scheme argument, return a void expression.
1530 Use this if you want to have a scheme expression evaluated
1531 because of its side-effects, but its value ignored."))
1532
1533 withMusicProperty =
1534 #(define-music-function (parser location sym val music)
1535    (symbol? scheme? ly:music?)
1536    (_i "Set @var{sym} to @var{val} in @var{music}.")
1537
1538    (set! (ly:music-property music sym) val)
1539    music)