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