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.15.18"
  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 acciaccatura =
  35 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
  36    (_i "Create an acciaccatura from the following music expression"))
  37
  38 %% keep these two together
  39 "instrument-definitions" = #'()
  40 addInstrumentDefinition =
  41 #(define-void-function
  42    (parser location name lst) (string? list?)
  43    (_i "Create instrument @var{name} with properties @var{list}.")
  44    (set! instrument-definitions (acons name lst instrument-definitions)))
  45
  46 addQuote =
  47 #(define-void-function (parser location name music) (string? ly:music?)
  48    (_i "Define @var{music} as a quotable music expression named
  49 @var{name}")
  50    (add-quotable parser name music))
  51
  52 %% keep these two together
  53 afterGraceFraction = #(cons 6 8)
  54 afterGrace =
  55 #(define-music-function (parser location main grace) (ly:music? ly:music?)
  56    (_i "Create @var{grace} note(s) after a @var{main} music expression.")
  57    (let ((main-length (ly:music-length main))
  58          (fraction  (ly:parser-lookup parser 'afterGraceFraction)))
  59      (make-simultaneous-music
  60       (list
  61        main
  62        (make-sequential-music
  63         (list
  64
  65          (make-music 'SkipMusic
  66                      'duration (ly:make-duration
  67                                 0 0
  68                                 (* (ly:moment-main-numerator main-length)
  69                                    (car fraction))
  70                                 (* (ly:moment-main-denominator main-length)
  71                                    (cdr fraction))))
  72          (make-music 'GraceMusic
  73                      'element grace)))))))
  74
  75
  76 %% music identifiers not allowed at top-level,
  77 %% so this is a music-function instead.
  78 allowPageTurn =
  79 #(define-music-function (location parser) ()
  80    (_i "Allow a page turn. May be used at toplevel (ie between scores or
  81 markups), or inside a score.")
  82    (make-music 'EventChord
  83                'page-marker #t
  84                'page-turn-permission 'allow
  85                'elements (list (make-music 'PageTurnEvent
  86                                            'break-permission 'allow))))
  87
  88 appendToTag =
  89 #(define-music-function (parser location tag more music)
  90    (symbol? ly:music? ly:music?)
  91    (_i "Append @var{more} to the @code{elements} of all music
  92 expressions in @var{music} that are tagged with @var{tag}.")
  93    (music-map (lambda (m)
  94                 (if (memq tag (ly:music-property m 'tags))
  95                     (set! (ly:music-property m 'elements)
  96                           (append (ly:music-property m 'elements)
  97                                   (list more))))
  98                 m)
  99               music))
 100
 101 applyContext =
 102 #(define-music-function (parser location proc) (procedure?)
 103    (_i "Modify context properties with Scheme procedure @var{proc}.")
 104    (make-music 'ApplyContext
 105                'procedure proc))
 106
 107 applyMusic =
 108 #(define-music-function (parser location func music) (procedure? ly:music?)
 109    (_i"Apply procedure @var{func} to @var{music}.")
 110    (func music))
 111
 112 applyOutput =
 113 #(define-music-function (parser location ctx proc) (symbol? procedure?)
 114    (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
 115    (make-music 'ApplyOutputEvent
 116                'procedure proc
 117                'context-type ctx))
 118
 119 appoggiatura =
 120 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
 121    (_i "Create an appoggiatura from @var{music}"))
 122
 123 % for regression testing purposes.
 124 assertBeamQuant =
 125 #(define-music-function (parser location l r) (pair? pair?)
 126    (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
 127    (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
 128
 129 % for regression testing purposes.
 130 assertBeamSlope =
 131 #(define-music-function (parser location comp) (procedure?)
 132    (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
 133    (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
 134
 135 autochange =
 136 #(define-music-function (parser location music) (ly:music?)
 137    (_i "Make voices that switch between staves automatically")
 138    (make-autochange-music parser music))
 139
 140
 141
 142 balloonGrobText =
 143 #(define-music-function (parser location grob-name offset text)
 144    (symbol? number-pair? markup?)
 145    (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
 146  (use like @code{\\once})")
 147    (make-music 'AnnotateOutputEvent
 148                'symbol grob-name
 149                'X-offset (car offset)
 150                'Y-offset (cdr offset)
 151                'text text))
 152
 153 balloonText =
 154 #(define-music-function (parser location offset text) (number-pair? markup?)
 155    (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
 156    (make-music 'AnnotateOutputEvent
 157                'X-offset (car offset)
 158                'Y-offset (cdr offset)
 159                'text text))
 160
 161 bar =
 162 #(define-music-function (parser location type) (string?)
 163    (_i "Insert a bar line of type @var{type}")
 164    (context-spec-music
 165     (make-property-set 'whichBar type)
 166     'Timing))
 167
 168 barNumberCheck =
 169 #(define-music-function (parser location n) (integer?)
 170    (_i "Print a warning if the current bar number is not @var{n}.")
 171    (make-music 'ApplyContext
 172                'procedure
 173                (lambda (c)
 174                  (let ((cbn (ly:context-property c 'currentBarNumber)))
 175                    (if (and  (number? cbn) (not (= cbn n)))
 176                        (ly:input-warning location
 177                                          "Barcheck failed got ~a expect ~a"
 178                                          cbn n))))))
 179
 180 bendAfter =
 181 #(define-event-function (parser location delta) (real?)
 182    (_i "Create a fall or doit of pitch interval @var{delta}.")
 183    (make-music 'BendAfterEvent
 184                'delta-step delta))
 185
 186 bookOutputName =
 187 #(define-void-function (parser location newfilename) (string?)
 188    (_i "Direct output for the current book block to @var{newfilename}.")
 189    (set! (paper-variable parser #f 'output-filename) newfilename))
 190
 191 bookOutputSuffix =
 192 #(define-void-function (parser location newsuffix) (string?)
 193    (_i "Set the output filename suffix for the current book block to
 194 @var{newsuffix}.")
 195    (set! (paper-variable parser #f 'output-suffix) newsuffix))
 196
 197 %% \breathe is defined as a music function rather than an event identifier to
 198 %% ensure it gets useful input location information: as an event identifier,
 199 %% it would have to be wrapped in an EventChord to prevent it from being
 200 %% treated as a post_event by the parser
 201 breathe =
 202 #(define-music-function (parser location) ()
 203    (_i "Insert a breath mark.")
 204    (make-music 'BreathingEvent))
 205
 206 clef =
 207 #(define-music-function (parser location type) (string?)
 208    (_i "Set the current clef to @var{type}.")
 209    (make-clef-set type))
 210
 211
 212 compoundMeter =
 213 #(define-music-function (parser location args) (pair?)
 214   (_i "Create compound time signatures. The argument is a Scheme list of
 215 lists. Each list describes one fraction, with the last entry being the
 216 denominator, while the first entries describe the summands in the
 217 enumerator. If the time signature consists of just one fraction,
 218 the list can be given directly, i.e. not as a list containing a single list.
 219 For example, a time signature of (3+1)/8 + 2/4 would be created as
 220 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
 221 as @code{\\compoundMeter #'((3 2 8))} or shorter
 222 @code{\\compoundMeter #'(3 2 8)}.")
 223   (let* ((mlen (calculate-compound-measure-length args))
 224          (beat (calculate-compound-base-beat args))
 225          (beatGrouping (calculate-compound-beat-grouping args))
 226          (timesig (cons (ly:moment-main-numerator mlen)
 227                         (ly:moment-main-denominator mlen))))
 228   #{
 229     \once \override Staff.TimeSignature #'stencil = #(lambda (grob)
 230                 (grob-interpret-markup grob (format-compound-time args)))
 231     \set Timing.timeSignatureFraction = $timesig
 232     \set Timing.baseMoment = $beat
 233     \set Timing.beatStructure = $beatGrouping
 234     \set Timing.beamExceptions = #'()
 235     \set Timing.measureLength = $mlen
 236   #} ))
 237
 238
 239 cueClef =
 240 #(define-music-function (parser location type) (string?)
 241   (_i "Set the current cue clef to @var{type}.")
 242   (make-cue-clef-set type))
 243 cueClefUnset =
 244 #(define-music-function (parser location) ()
 245   (_i "Unset the current cue clef.")
 246   (make-cue-clef-unset))
 247
 248 cueDuring =
 249 #(define-music-function
 250    (parser location what dir main-music) (string? ly:dir? ly:music?)
 251    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 252 in a CueVoice oriented by @var{dir}.")
 253    (make-music 'QuoteMusic
 254                'element main-music
 255                'quoted-context-type 'Voice
 256                'quoted-context-id "cue"
 257                'quoted-music-name what
 258                'quoted-voice-direction dir))
 259
 260 cueDuringWithClef =
 261 #(define-music-function
 262    (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
 263    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 264 in a CueVoice oriented by @var{dir}.")
 265    (make-music 'QuoteMusic
 266                'element main-music
 267                'quoted-context-type 'Voice
 268                'quoted-context-id "cue"
 269                'quoted-music-name what
 270                'quoted-music-clef clef
 271                'quoted-voice-direction dir))
 272
 273
 274
 275 displayLilyMusic =
 276 #(define-music-function (parser location music) (ly:music?)
 277    (_i "Display the LilyPond input representation of @var{music}
 278 to the console.")
 279    (newline)
 280    (display-lily-music music parser)
 281    music)
 282
 283 displayMusic =
 284 #(define-music-function (parser location music) (ly:music?)
 285    (_i "Display the internal representation of @var{music} to the console.")
 286    (newline)
 287    (display-scheme-music music)
 288    music)
 289
 290
 291
 292 endSpanners =
 293 #(define-music-function (parser location music) (ly:music?)
 294    (_i "Terminate the next spanner prematurely after exactly one note
 295 without the need of a specific end spanner.")
 296    (if (memq (ly:music-property music 'name) '(EventChord NoteEvent))
 297        (let* ((start-span-evs (filter (lambda (ev)
 298                                         (equal? (ly:music-property ev 'span-direction)
 299                                                 START))
 300                                       (extract-typed-music music 'span-event)))
 301               (stop-span-evs
 302                (map (lambda (m)
 303                       (let ((c (music-clone m)))
 304                         (set! (ly:music-property c 'span-direction) STOP)
 305                         c))
 306                     start-span-evs))
 307               (end-ev-chord (make-music 'EventChord
 308                                         'elements stop-span-evs))
 309               (total (make-music 'SequentialMusic
 310                                  'elements (list music
 311                                                  end-ev-chord))))
 312          total)
 313
 314        (begin
 315          (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a") music)
 316          music)))
 317
 318 eventChords =
 319 #(define-music-function (parser location music) (ly:music?)
 320    (_i "Compatibility function wrapping @code{EventChord} around
 321 isolated rhythmic events occuring since version 2.15.28, after
 322 expanding repeat chords @samp{q}.")
 323    (event-chord-wrap! music parser))
 324
 325 featherDurations=
 326 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
 327    (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
 328    (let ((orig-duration (ly:music-length argument))
 329          (multiplier (ly:make-moment 1 1)))
 330
 331      (for-each
 332       (lambda (mus)
 333         (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
 334             (begin
 335               (ly:music-compress mus multiplier)
 336               (set! multiplier (ly:moment-mul factor multiplier)))))
 337       (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
 338      (ly:music-compress
 339       argument
 340       (ly:moment-div orig-duration (ly:music-length argument)))
 341
 342      argument))
 343
 344 footnote =
 345 #(define-music-function (parser location mark offset grob-name footnote music)
 346    ((markup?) number-pair? (symbol?) markup? (ly:music?))
 347    (_i "Make the markup @var{footnote} a footnote on @var{music}.  The
 348 footnote is marked with a markup @var{mark} moved by @var{offset} with
 349 respect to the marked music.
 350
 351 If @var{mark} is not given or specified as @var{\\default}, it is
 352 replaced by an automatically generated sequence number.  If a symbol
 353 @var{grob-name} is specified, then grobs of that type will be marked
 354 if they have @var{music} as their ultimate cause; by default all grobs
 355 having @var{music} as their @emph{direct} cause will be marked,
 356 similar to the way @code{\\tweak} works.
 357
 358 If @var{music} is given as @code{\\default}, a footnote event
 359 affecting @emph{all} grobs matching @var{grob-name} at a given time
 360 step is generated.  This may be required for creating footnotes on
 361 time signatures, clefs, and other items not cooperating with
 362 @code{\\tweak}.
 363
 364 Like with @code{\\tweak}, if you use a footnote on a following
 365 post-event, the @code{\\footnote} command itself needs to be attached
 366 to the preceding note or rest as a post-event with @code{-}.")
 367    (let ((mus (make-music
 368                'FootnoteEvent
 369                'X-offset (car offset)
 370                'Y-offset (cdr offset)
 371                'automatically-numbered (not mark)
 372                'text (or mark (make-null-markup))
 373                'footnote-text footnote
 374                'symbol (or grob-name '()))))
 375      (if music
 376          (begin
 377            (set! (ly:music-property music 'tweaks)
 378                  (acons (if grob-name
 379                             (cons grob-name 'footnote-music)
 380                             'footnote-music)
 381                         mus
 382                         (ly:music-property music 'tweaks)))
 383            music)
 384          mus)))
 385
 386 grace =
 387 #(def-grace-function startGraceMusic stopGraceMusic
 388    (_i "Insert @var{music} as grace notes."))
 389
 390 grobdescriptions =
 391 #(define-scheme-function (parser location descriptions) (list?)
 392    (_i "Create a context modification from @var{descriptions}, a list
 393 in the format of @code{all-grob-descriptions}.")
 394    (ly:make-context-mod
 395     (map (lambda (p)
 396            (list 'assign (car p) (list (cdr p))))
 397          descriptions)))
 398
 399 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
 400   (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 401 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
 402   #{
 403     \set harmonicDots = ##t
 404     \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
 405     \override NoteHead #'Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
 406                                        (lambda (grob start end)
 407                                                (ly:grob::stencil-height grob)))
 408     \override NoteHead #'stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 409                                             (ly:note-head::print grob))
 410     $(make-harmonic
 411        (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
 412     \unset harmonicDots
 413     \revert TabNoteHead #'stencil
 414     \revert NoteHead #'Y-extent
 415     \revert NoteHead #'stencil
 416   #})
 417
 418 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
 419     (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 420 harmonics played on a fretted instrument by touching the strings at the point
 421 given through @var{ratio}.")
 422   #{
 423     \set harmonicDots = ##t
 424     \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
 425     \override NoteHead #'Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
 426                                        (lambda (grob start end)
 427                                                (ly:grob::stencil-height grob)))
 428     \override NoteHead #'stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 429                                             (ly:note-head::print grob))
 430     $(make-harmonic
 431       (calc-harmonic-pitch (ratio->pitch ratio) music))
 432     \unset harmonicDots
 433     \revert TabNoteHead #'stencil
 434     \revert NoteHead #'Y-extent
 435     \revert NoteHead #'stencil
 436   #})
 437
 438 instrumentSwitch =
 439 #(define-music-function
 440    (parser location name) (string?)
 441    (_i "Switch instrument to @var{name}, which must be predefined with
 442 @code{\\addInstrumentDefinition}.")
 443    (let* ((handle (assoc name instrument-definitions))
 444           (instrument-def (if handle (cdr handle) '())))
 445
 446      (if (not handle)
 447          (ly:input-warning location "No such instrument: ~a" name))
 448      (context-spec-music
 449       (make-music 'SimultaneousMusic
 450                   'elements
 451                   (map (lambda (kv)
 452                          (make-property-set
 453                           (car kv)
 454                           (cdr kv)))
 455                        instrument-def))
 456       'Staff)))
 457
 458
 459
 460 keepWithTag =
 461 #(define-music-function (parser location tag music) (symbol? ly:music?)
 462    (_i "Include only elements of @var{music} that are tagged with @var{tag}.")
 463    (music-filter
 464     (lambda (m)
 465       (let* ((tags (ly:music-property m 'tags))
 466              (res (memq tag tags)))
 467         (or
 468          (eq? tags '())
 469          res)))
 470     music))
 471
 472 key =
 473 #(define-music-function (parser location tonic pitch-alist)
 474    ((ly:pitch? '()) (list? '()))
 475    (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
 476 If both are null, just generate @code{KeyChangeEvent}.")
 477    (cond ((null? tonic) (make-music 'KeyChangeEvent))
 478          ((null? pitch-alist)
 479           (ly:parser-error parser (_ "second argument must be pitch list")
 480                            location)
 481           (make-music 'SequentialMusic 'void #t))
 482          (else
 483           (ly:music-transpose
 484            (make-music 'KeyChangeEvent
 485                 'tonic (ly:make-pitch 0 0 0)
 486                 'pitch-alist pitch-alist)
 487            tonic))))
 488
 489 killCues =
 490 #(define-music-function (parser location music) (ly:music?)
 491    (_i "Remove cue notes from @var{music}.")
 492    (music-map
 493     (lambda (mus)
 494       (if (and (string? (ly:music-property mus 'quoted-music-name))
 495                (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
 496           (ly:music-property mus 'element)
 497           mus))
 498     music))
 499
 500
 501
 502 label =
 503 #(define-music-function (parser location label) (symbol?)
 504    (_i "Create @var{label} as a bookmarking label.")
 505    (make-music 'EventChord
 506                'page-marker #t
 507                'page-label label
 508                'elements (list (make-music 'LabelEvent
 509                                            'page-label label))))
 510
 511
 512 language =
 513 #(define-void-function (parser location language) (string?)
 514    (_i "Set note names for language @var{language}.")
 515    (note-names-language parser language))
 516
 517 languageSaveAndChange =
 518 #(define-void-function (parser location language) (string?)
 519   (_i "Store the previous pitchnames alist, and set a new one.")
 520   (set! previous-pitchnames pitchnames)
 521   (note-names-language parser language))
 522
 523 languageRestore =
 524 #(define-void-function (parser location) ()
 525    (_i "Restore a previously-saved pitchnames alist.")
 526    (if previous-pitchnames
 527        (begin
 528         (set! pitchnames previous-pitchnames)
 529         (ly:parser-set-note-names parser pitchnames))
 530       (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
 531
 532
 533 makeClusters =
 534 #(define-music-function (parser location arg) (ly:music?)
 535    (_i "Display chords in @var{arg} as clusters.")
 536    (music-map note-to-cluster arg))
 537
 538 modalInversion =
 539 #(define-music-function (parser location around to scale music)
 540     (ly:pitch? ly:pitch? ly:music? ly:music?)
 541     (_i "Invert @var{music} about @var{around} using @var{scale} and
 542 transpose from @var{around} to @var{to}.")
 543     (let ((inverter (make-modal-inverter around to scale)))
 544       (change-pitches music inverter)
 545       music))
 546
 547 modalTranspose =
 548 #(define-music-function (parser location from to scale music)
 549     (ly:pitch? ly:pitch? ly:music? ly:music?)
 550     (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
 551 using @var{scale}.")
 552     (let ((transposer (make-modal-transposer from to scale)))
 553       (change-pitches music transposer)
 554       music))
 555
 556 inversion =
 557 #(define-music-function
 558    (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
 559    (_i "Invert @var{music} about @var{around} and
 560 transpose from @var{around} to @var{to}.")
 561    (music-invert around to music))
 562
 563 mark =
 564 #(define-music-function
 565    (parser location label) ((scheme? '()))
 566   "Make the music for the \\mark command."
 567   (let* ((set (and (integer? label)
 568                    (context-spec-music (make-property-set 'rehearsalMark label)
 569                                       'Score)))
 570          (ev (make-music 'MarkEvent
 571                          'origin location)))
 572
 573     (if set
 574         (make-sequential-music (list set ev))
 575         (begin
 576           (set! (ly:music-property ev 'label) label)
 577           ev))))
 578
 579 musicMap =
 580 #(define-music-function (parser location proc mus) (procedure? ly:music?)
 581    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 582    (music-map proc mus))
 583
 584 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 585 %% because music identifiers are not allowed at top-level.
 586 noPageBreak =
 587 #(define-music-function (location parser) ()
 588    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 589 markups), or inside a score.")
 590    (make-music 'EventChord
 591                'page-marker #t
 592                'page-break-permission 'forbid
 593                'elements (list (make-music 'PageBreakEvent
 594                                            'break-permission '()))))
 595
 596 noPageTurn =
 597 #(define-music-function (location parser) ()
 598    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 599 markups), or inside a score.")
 600    (make-music 'EventChord
 601                'page-marker #t
 602                'page-turn-permission 'forbid
 603                'elements (list (make-music 'PageTurnEvent
 604                                            'break-permission '()))))
 605
 606
 607
 608 octaveCheck =
 609 #(define-music-function (parser location pitch) (ly:pitch?)
 610    (_i "Octave check.")
 611    (make-music 'RelativeOctaveCheck
 612                'pitch pitch))
 613
 614 once =
 615 #(define-music-function (parser location music) (ly:music?)
 616    (_i "Set @code{once} to @code{#t} on all layout instruction events in @var{music}.")
 617    (music-map
 618     (lambda (m)
 619       (cond ((music-is-of-type? m 'layout-instruction-event)
 620              (set! (ly:music-property m 'once) #t))
 621             ((ly:duration? (ly:music-property m 'duration))
 622              (ly:music-warning m (_ "Cannot apply \\once to timed music"))))
 623       m)
 624     music))
 625
 626 ottava =
 627 #(define-music-function (parser location octave) (integer?)
 628    (_i "Set the octavation.")
 629    (make-music 'OttavaMusic
 630                'ottava-number octave))
 631
 632 overrideTimeSignatureSettings =
 633 #(define-music-function
 634    (parser location time-signature base-moment beat-structure beam-exceptions)
 635    (pair? pair? cheap-list? cheap-list?)
 636
 637    (_i "Override @code{timeSignatureSettings}
 638 for time signatures of @var{time-signature} to have settings
 639 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 640
 641    ;; TODO -- add warning if largest value of grouping is
 642    ;;       greater than time-signature.
 643   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 644     (override-time-signature-setting time-signature setting)))
 645
 646 overrideProperty =
 647 #(define-music-function (parser location name property value)
 648    (string? symbol? scheme?)
 649
 650    (_i "Set @var{property} to @var{value} in all grobs named @var{name}.
 651 The @var{name} argument is a string of the form @code{\"Context.GrobName\"}
 652 or @code{\"GrobName\"}.")
 653
 654    (let ((name-components (string-split name #\.))
 655          (context-name 'Bottom)
 656          (grob-name #f))
 657
 658      (if (> 2 (length name-components))
 659          (set! grob-name (string->symbol (car name-components)))
 660          (begin
 661            (set! grob-name (string->symbol (list-ref name-components 1)))
 662            (set! context-name (string->symbol (list-ref name-components 0)))))
 663
 664      (make-music 'ApplyOutputEvent
 665                  'context-type context-name
 666                  'procedure
 667                  (lambda (grob orig-context context)
 668                    (if (equal?
 669                         (cdr (assoc 'name (ly:grob-property grob 'meta)))
 670                         grob-name)
 671                        (set! (ly:grob-property grob property) value))))))
 672
 673
 674
 675 %% pageBreak and pageTurn are music functions (iso music indentifiers),
 676 %% because music identifiers are not allowed at top-level.
 677 pageBreak =
 678 #(define-music-function (location parser) ()
 679    (_i "Force a page break.  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                'line-break-permission 'force
 684                'page-break-permission 'force
 685                'elements (list (make-music 'LineBreakEvent
 686                                            'break-permission 'force)
 687                                (make-music 'PageBreakEvent
 688                                            'break-permission 'force))))
 689
 690 pageTurn =
 691 #(define-music-function (location parser) ()
 692    (_i "Force a page turn between two scores or top-level markups.")
 693    (make-music 'EventChord
 694                'page-marker #t
 695                'line-break-permission 'force
 696                'page-break-permission 'force
 697                'page-turn-permission 'force
 698                'elements (list (make-music 'LineBreakEvent
 699                                            'break-permission 'force)
 700                                (make-music 'PageBreakEvent
 701                                            'break-permission 'force)
 702                                (make-music 'PageTurnEvent
 703                                            'break-permission 'force))))
 704
 705 parallelMusic =
 706 #(define-void-function (parser location voice-ids music) (list? ly:music?)
 707    (_i "Define parallel music sequences, separated by '|' (bar check signs),
 708 and assign them to the identifiers provided in @var{voice-ids}.
 709
 710 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
 711
 712 @var{music}: a music sequence, containing BarChecks as limiting expressions.
 713
 714 Example:
 715
 716 @verbatim
 717   \\parallelMusic #'(A B C) {
 718     c c | d d | e e |
 719     d d | e e | f f |
 720   }
 721 <==>
 722   A = { c c | d d | }
 723   B = { d d | e e | }
 724   C = { e e | f f | }
 725 @end verbatim
 726 ")
 727    (let* ((voices (apply circular-list (make-list (length voice-ids) (list))))
 728           (current-voices voices)
 729           (current-sequence (list))
 730           (original music)
 731           (wrapper #f))
 732      ;;
 733      ;; utilities
 734      (define (push-music m)
 735        "Push the music expression into the current sequence"
 736        (set! current-sequence (cons m current-sequence)))
 737      (define (change-voice)
 738        "Stores the previously built sequence into the current voice and
 739        change to the following voice."
 740        (list-set! current-voices 0 (cons (make-music 'SequentialMusic
 741                                                      'elements (reverse! current-sequence))
 742                                          (car current-voices)))
 743        (set! current-sequence (list))
 744        (set! current-voices (cdr current-voices)))
 745      (define (bar-check? m)
 746        "Checks whether m is a bar check."
 747        (eq? (ly:music-property m 'name) 'BarCheck))
 748      (define (music-origin music)
 749        "Recursively search an origin location stored in music."
 750        (cond ((null? music) #f)
 751              ((not (null? (ly:music-property music 'origin)))
 752               (ly:music-property music 'origin))
 753              (else (or (music-origin (ly:music-property music 'element))
 754                        (let ((origins (remove not (map music-origin
 755                                                        (ly:music-property music 'elements)))))
 756                          (and (not (null? origins)) (car origins)))))))
 757      (while (music-is-of-type? music 'music-wrapper-music)
 758             (set! wrapper music)
 759             (set! music (ly:music-property wrapper 'element)))
 760      (if wrapper
 761          (set! (ly:music-property wrapper 'element)
 762                                   (make-music 'SequentialMusic
 763                                               'origin location))
 764          (set! original
 765                (make-music 'SequentialMusic
 766                            'origin location)))
 767      ;;
 768      ;; first, split the music and fill in voices
 769      ;; We flatten direct layers of SequentialMusic since they are
 770      ;; pretty much impossible to avoid when writing music functions.
 771      (let rec ((music music))
 772        (for-each (lambda (m)
 773                    (if (eq? (ly:music-property m 'name) 'SequentialMusic)
 774                        (rec m)
 775                        (begin
 776                          (push-music m)
 777                          (if (bar-check? m) (change-voice)))))
 778                  (ly:music-property music 'elements)))
 779      (if (not (null? current-sequence)) (change-voice))
 780      ;; un-circularize `voices' and reorder the voices
 781      (set! voices (map-in-order (lambda (dummy seqs)
 782                                   (reverse! seqs))
 783                                 voice-ids voices))
 784      ;;
 785      ;; set origin location of each sequence in each voice
 786      ;; for better type error tracking
 787      (for-each (lambda (voice)
 788                  (for-each (lambda (seq)
 789                              (set! (ly:music-property seq 'origin)
 790                                    (or (music-origin seq) location)))
 791                            voice))
 792                voices)
 793      ;;
 794      ;; check sequence length
 795      (apply for-each (lambda* (#:rest seqs)
 796                               (let ((moment-reference (ly:music-length (car seqs))))
 797                                 (for-each (lambda (seq moment)
 798                                             (if (not (equal? moment moment-reference))
 799                                                 (ly:music-warning seq
 800                                                                   "Bars in parallel music don't have the same length")))
 801                                           seqs (map-in-order ly:music-length seqs))))
 802             voices)
 803      ;;
 804      ;; bind voice identifiers to the voices
 805      (for-each (lambda (voice-id voice)
 806             (ly:parser-define! parser voice-id
 807                                (let ((v (ly:music-deep-copy original)))
 808                                  (set! (ly:music-property
 809                                         (car (extract-named-music
 810                                               v 'SequentialMusic))
 811                                         'elements) voice)
 812                                  v)))
 813           voice-ids voices)))
 814
 815 parenthesize =
 816 #(define-music-function (parser loc arg) (ly:music?)
 817    (_i "Tag @var{arg} to be parenthesized.")
 818
 819    (if (memq 'event-chord (ly:music-property arg 'types))
 820        ;; arg is an EventChord -> set the parenthesize property
 821        ;; on all child notes and rests
 822        (for-each
 823         (lambda (ev)
 824           (if (or (memq 'note-event (ly:music-property ev 'types))
 825                   (memq 'rest-event (ly:music-property ev 'types)))
 826               (set! (ly:music-property ev 'parenthesize) #t)))
 827         (ly:music-property arg 'elements))
 828        ;; No chord, simply set property for this expression:
 829        (set! (ly:music-property arg 'parenthesize) #t))
 830    arg)
 831
 832 partcombine =
 833 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 834    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 835 that they share a staff.")
 836    (make-part-combine-music parser
 837                             (list part1 part2) #f))
 838
 839 partcombineUp =
 840 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 841    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 842 that they share a staff with stems directed upward.")
 843    (make-part-combine-music parser
 844                             (list part1 part2) UP))
 845
 846 partcombineDown =
 847 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 848    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 849 that they share a staff with stems directed downward.")
 850    (make-part-combine-music parser
 851                             (list part1 part2) DOWN))
 852
 853 partcombineForce =
 854 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
 855    (_i "Override the part-combiner.")
 856    (make-music 'EventChord
 857                'elements (list (make-music 'PartCombineForceEvent
 858                                            'forced-type type
 859                                            'once once))))
 860 partcombineApart = \partcombineForce #'apart ##f
 861 partcombineApartOnce = \partcombineForce #'apart ##t
 862 partcombineChords = \partcombineForce #'chords ##f
 863 partcombineChordsOnce = \partcombineForce #'chords ##t
 864 partcombineUnisono = \partcombineForce #'unisono ##f
 865 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
 866 partcombineSoloI = \partcombineForce #'solo1 ##f
 867 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
 868 partcombineSoloII = \partcombineForce #'solo2 ##f
 869 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
 870 partcombineAutomatic = \partcombineForce ##f ##f
 871 partcombineAutomaticOnce = \partcombineForce ##f ##t
 872
 873 partial =
 874 #(define-music-function (parser location dur) (ly:duration?)
 875   (_i "Make a partial measure.")
 876
 877   ;; We use `descend-to-context' here instead of `context-spec-music' to
 878   ;; ensure \partial still works if the Timing_translator is moved
 879     (descend-to-context
 880      (context-spec-music (make-music 'PartialSet
 881                                      'origin location
 882                                      'partial-duration dur)
 883                          'Timing)
 884      'Score))
 885
 886 pitchedTrill =
 887 #(define-music-function
 888    (parser location main-note secondary-note)
 889    (ly:music? ly:music?)
 890    (_i "Print a trill with @var{main-note} as the main note of the trill and
 891 print @var{secondary-note} as a stemless note head in parentheses.")
 892    (let* ((get-notes (lambda (ev-chord)
 893                        (extract-named-music ev-chord 'NoteEvent)))
 894           (sec-note-events (get-notes secondary-note))
 895           (trill-events (extract-named-music main-note 'TrillSpanEvent)))
 896      (if (pair? sec-note-events)
 897          (begin
 898            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
 899                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
 900
 901              (if (ly:pitch? trill-pitch)
 902                  (for-each (lambda (m)
 903                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
 904                  (begin
 905                    (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
 906                    (display sec-note-events)))
 907
 908              (if (eq? forced #t)
 909                  (for-each (lambda (m)
 910                              (ly:music-set-property! m 'force-accidental forced))
 911                            trill-events)))))
 912      main-note))
 913
 914 pushToTag =
 915 #(define-music-function (parser location tag more music)
 916    (symbol? ly:music? ly:music?)
 917    (_i "Add @var{more} to the front of @code{elements} of all music
 918 expressions in @var{music} that are tagged with @var{tag}.")
 919    (music-map (lambda (m)
 920                 (if (memq tag (ly:music-property m 'tags))
 921                     (set! (ly:music-property m 'elements)
 922                           (cons more (ly:music-property m 'elements))))
 923                 m)
 924               music))
 925
 926 quoteDuring =
 927 #(define-music-function (parser location what main-music) (string? ly:music?)
 928    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
 929 of the quoted voice, as specified in an @code{\\addQuote} command.
 930 @var{main-music} is used to indicate the length of music to be quoted;
 931 usually contains spacers or multi-measure rests.")
 932    (make-music 'QuoteMusic
 933                'element main-music
 934                'quoted-music-name what))
 935
 936 relative =
 937 #(define-music-function (parser location pitch music)
 938    ((ly:pitch? (ly:make-pitch 0 0 0)) ly:music?)
 939    (_i "Make @var{music} relative to @var{pitch} (default @code{c'}).")
 940    (ly:make-music-relative! music pitch)
 941    (make-music 'RelativeOctaveMusic
 942                'element music))
 943
 944 removeWithTag =
 945 #(define-music-function (parser location tag music) (symbol? ly:music?)
 946    (_i "Remove elements of @var{music} that are tagged with @var{tag}.")
 947    (music-filter
 948     (lambda (m)
 949       (let* ((tags (ly:music-property m 'tags))
 950              (res (memq tag tags)))
 951         (not res)))
 952     music))
 953
 954 resetRelativeOctave =
 955 #(define-music-function (parser location pitch) (ly:pitch?)
 956    (_i "Set the octave inside a \\relative section.")
 957
 958    (make-music 'SequentialMusic
 959                'to-relative-callback
 960                (lambda (music last-pitch) pitch)))
 961
 962 retrograde =
 963 #(define-music-function (parser location music)
 964     (ly:music?)
 965     (_i "Return @var{music} in reverse order.")
 966     (retrograde-music music))
 967
 968 revertTimeSignatureSettings =
 969 #(define-music-function
 970    (parser location time-signature)
 971    (pair?)
 972
 973    (_i "Revert @code{timeSignatureSettings}
 974 for time signatures of @var{time-signature}.")
 975    (revert-time-signature-setting time-signature))
 976
 977 rightHandFinger =
 978 #(define-event-function (parser location finger) (number-or-string?)
 979    (_i "Apply @var{finger} as a fingering indication.")
 980
 981    (make-music
 982             'StrokeFingerEvent
 983             'origin location
 984             (if (string? finger) 'text 'digit)
 985             finger))
 986
 987 scaleDurations =
 988 #(define-music-function (parser location fraction music)
 989    (fraction? ly:music?)
 990    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
 991    (ly:music-compress music
 992                       (ly:make-moment (car fraction) (cdr fraction))))
 993
 994 settingsFrom =
 995 #(define-scheme-function (parser location ctx music)
 996    ((symbol?) ly:music?)
 997    (_i "Take the layout instruction events from @var{music}, optionally
 998 restricted to those applying to context type @var{ctx}, and return
 999 a context modification duplicating their effect.")
1000    (let ((mods (ly:make-context-mod)))
1001      (define (musicop m)
1002        (if (music-is-of-type? m 'layout-instruction-event)
1003            (ly:add-context-mod
1004             mods
1005             (case (ly:music-property m 'name)
1006               ((PropertySet)
1007                (list 'assign
1008                      (ly:music-property m 'symbol)
1009                      (ly:music-property m 'value)))
1010               ((PropertyUnset)
1011                (list 'unset
1012                      (ly:music-property m 'symbol)))
1013               ((OverrideProperty)
1014                (cons* 'push
1015                       (ly:music-property m 'symbol)
1016                       (ly:music-property m 'grob-value)
1017                       (ly:music-property m 'grob-property-path)))
1018               ((RevertProperty)
1019                (cons* 'pop
1020                       (ly:music-property m 'symbol)
1021                       (ly:music-property m 'grob-property-path)))))
1022            (case (ly:music-property m 'name)
1023              ((ApplyContext)
1024               (ly:add-context-mod mods
1025                                   (list 'apply
1026                                         (ly:music-property m 'procedure))))
1027              ((ContextSpeccedMusic)
1028               (if (or (not ctx)
1029                       (eq? ctx (ly:music-property m 'context-type)))
1030                   (musicop (ly:music-property m 'element))))
1031              (else
1032               (let ((callback (ly:music-property m 'elements-callback)))
1033                 (if (procedure? callback)
1034                     (for-each musicop (callback m))))))))
1035      (musicop music)
1036      mods))
1037
1038 shiftDurations =
1039 #(define-music-function (parser location dur dots arg)
1040    (integer? integer? ly:music?)
1041    (_i "Change the duration of @var{arg} by adding @var{dur} to the
1042 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1043
1044    (music-map
1045     (lambda (x)
1046       (shift-one-duration-log x dur dots)) arg))
1047
1048 skip =
1049 #(define-music-function (parser location dur) (ly:duration?)
1050   (_i "Skip forward by @var{dur}.")
1051   (make-music 'SkipMusic
1052               'duration dur))
1053
1054
1055 slashedGrace =
1056 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1057    (_i "Create slashed graces (slashes through stems, but no slur) from
1058 the following music expression"))
1059
1060 spacingTweaks =
1061 #(define-music-function (parser location parameters) (list?)
1062    (_i "Set the system stretch, by reading the 'system-stretch property of
1063 the `parameters' assoc list.")
1064    #{
1065      \overrideProperty #"Score.NonMusicalPaperColumn"
1066      #'line-break-system-details
1067      #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1068              (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1069    #})
1070
1071 styledNoteHeads =
1072 #(define-music-function (parser location style heads music)
1073    (symbol? list-or-symbol? ly:music?)
1074    (_i "Set @var{heads} in @var{music} to @var{style}.")
1075    (style-note-heads heads style music))
1076
1077 tag =
1078 #(define-music-function (parser location tag arg) (symbol? ly:music?)
1079
1080    (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
1081
1082    (set!
1083     (ly:music-property arg 'tags)
1084     (cons tag
1085           (ly:music-property arg 'tags)))
1086    arg)
1087
1088 time =
1089 #(define-music-function (parser location beat-structure fraction)
1090    ((number-list? '()) fraction?)
1091    (_i "Set @var{fraction} as time signature, with optional
1092 number list @var{beat-structure} before it.")
1093   (make-music 'TimeSignatureMusic
1094               'numerator (car fraction)
1095               'denominator (cdr fraction)
1096               'beat-structure beat-structure))
1097
1098 times =
1099 #(define-music-function (parser location fraction music)
1100    (fraction? ly:music?)
1101    (_i "Scale @var{music} in time by @var{fraction}.")
1102   (make-music 'TimeScaledMusic
1103               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1104               'numerator (car fraction)
1105               'denominator (cdr fraction)))
1106
1107 transpose =
1108 #(define-music-function
1109    (parser location from to music)
1110    (ly:pitch? ly:pitch? ly:music?)
1111
1112    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1113    (make-music 'TransposedMusic
1114                'element (ly:music-transpose music (ly:pitch-diff to from))))
1115
1116 transposedCueDuring =
1117 #(define-music-function
1118    (parser location what dir pitch main-music)
1119    (string? ly:dir? ly:pitch? ly:music?)
1120
1121    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1122 using the transposition defined by @var{pitch}.  This happens
1123 simultaneously with @var{main-music}, which is usually a rest.  The
1124 argument @var{dir} determines whether the cue notes should be notated
1125 as a first or second voice.")
1126
1127    (make-music 'QuoteMusic
1128                'element main-music
1129                'quoted-context-type 'Voice
1130                'quoted-context-id "cue"
1131                'quoted-music-name what
1132                'quoted-voice-direction dir
1133                'quoted-transposition pitch))
1134
1135 transposition =
1136 #(define-music-function (parser location pitch) (ly:pitch?)
1137    (_i "Set instrument transposition")
1138
1139    (context-spec-music
1140     (make-property-set 'instrumentTransposition
1141                        (ly:pitch-negate pitch))
1142     'Staff))
1143
1144 tweak =
1145 #(define-music-function (parser location grob prop value music)
1146    ((string?) symbol? scheme? ly:music?)
1147    (_i "Add a tweak to the following @var{music}.
1148 Layout objects created by @var{music} get their property @var{prop}
1149 set to @var{value}.  If @var{grob} is specified, like with
1150 @example
1151 \\tweak Accidental #'color #red cis'
1152 @end example
1153 an indirectly created grob (@samp{Accidental} is caused by
1154 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1155 are affected.")
1156    (if (not (object-property prop 'backend-type?))
1157        (begin
1158          (ly:input-warning location (_ "cannot find property type-check for ~a") prop)
1159          (ly:warning (_ "doing assignment anyway"))))
1160    (set!
1161     (ly:music-property music 'tweaks)
1162     (acons (if grob (cons (string->symbol grob) prop) prop)
1163            value
1164            (ly:music-property music 'tweaks)))
1165    music)
1166
1167 unfoldRepeats =
1168 #(define-music-function (parser location music) (ly:music?)
1169    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1170 @code{\\repeat percent} commands in @var{music} to be interpreted
1171 as @code{\\repeat unfold}.")
1172    (unfold-repeats music))
1173
1174 void =
1175 #(define-void-function (parser location arg) (scheme?)
1176    (_i "Accept a scheme argument, return a void expression.
1177 Use this if you want to have a scheme expression evaluated
1178 because of its side-effects, but its value ignored."))
1179
1180 withMusicProperty =
1181 #(define-music-function (parser location sym val music)
1182    (symbol? scheme? ly:music?)
1183    (_i "Set @var{sym} to @var{val} in @var{music}.")
1184
1185    (set! (ly:music-property music sym) val)
1186    music)