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