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--2011 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.14.0"
  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-music-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! book-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! book-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 (eq? (ly:music-property music 'name) 'EventChord)
 297        (let* ((elts (ly:music-property music 'elements))
 298               (start-span-evs (filter (lambda (ev)
 299                                         (and (music-has-type ev 'span-event)
 300                                              (equal? (ly:music-property ev 'span-direction)
 301                                                      START)))
 302                                       elts))
 303               (stop-span-evs
 304                (map (lambda (m)
 305                       (let ((c (music-clone m)))
 306                         (set! (ly:music-property c 'span-direction) STOP)
 307                         c))
 308                     start-span-evs))
 309               (end-ev-chord (make-music 'EventChord
 310                                         'elements stop-span-evs))
 311               (total (make-music 'SequentialMusic
 312                                  'elements (list music
 313                                                  end-ev-chord))))
 314          total)
 315
 316        (begin
 317          (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a" music))
 318          music)))
 319
 320
 321
 322 featherDurations=
 323 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
 324    (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
 325    (let ((orig-duration (ly:music-length argument))
 326          (multiplier (ly:make-moment 1 1)))
 327
 328      (music-map
 329       (lambda (mus)
 330         (if (and (eq? (ly:music-property mus 'name) 'EventChord)
 331                  (< 0 (ly:moment-main-denominator (ly:music-length mus))))
 332             (begin
 333               (ly:music-compress mus multiplier)
 334               (set! multiplier (ly:moment-mul factor multiplier))))
 335         mus)
 336       argument)
 337
 338      (ly:music-compress
 339       argument
 340       (ly:moment-div orig-duration (ly:music-length argument)))
 341
 342      argument))
 343
 344 footnoteGrob =
 345 #(define-music-function (parser location grob-name offset text footnote)
 346    (symbol? number-pair? markup? markup?)
 347    (_i "Attach @var{text} to @var{grob-name} at offset @var{offset},
 348 with @var{text} referring to @var{footnote} (use like @code{\\once})")
 349    (make-music 'FootnoteEvent
 350                'automatically-numbered #f
 351                'symbol grob-name
 352                'X-offset (car offset)
 353                'Y-offset (cdr offset)
 354                'text text
 355                'footnote-text footnote))
 356
 357 autoFootnoteGrob =
 358 #(define-music-function (parser location grob-name offset footnote)
 359    (symbol? number-pair? markup?)
 360    (_i "Footnote @var{grob-name} with the text in @var{footnote}
 361 allowing for the footnote to be automatically numbered such that
 362 the number appears at @var{offset}.  Note that, for this to take effect,
 363 auto-numbering must be turned on in the paper block.  Otherwise, no
 364 number will appear.  Use like @code{\\once})")
 365    (make-music 'FootnoteEvent
 366                'automatically-numbered #t
 367                'symbol grob-name
 368                'X-offset (car offset)
 369                'Y-offset (cdr offset)
 370                'text (make-null-markup)
 371                'footnote-text footnote))
 372
 373
 374 footnote =
 375 #(define-music-function (parser location offset text footnote)
 376    (number-pair? markup? markup?)
 377    (_i "Attach @var{text} at @var{offset} with @var{text} referring
 378 to @var{footnote} (use like @code{\\tweak})")
 379    (make-music 'FootnoteEvent
 380                'automatically-numbered #f
 381                'X-offset (car offset)
 382                'Y-offset (cdr offset)
 383                'text text
 384                'footnote-text footnote))
 385
 386 autoFootnote =
 387 #(define-music-function (parser location offset footnote)
 388    (number-pair? markup?)
 389    (_i "Footnote the item after which this comes with the text in
 390 @var{footnote} allowing for the footnote to be automatically numbered
 391 such that the number appears at @var{offset}.  Note that, for this to
 392 take effect, auto-numbering must be turned on in the paper block.
 393 Otherwise, no number will appear.  Use like @code{\\tweak})")
 394    (make-music 'FootnoteEvent
 395                'automatically-numbered #t
 396                'X-offset (car offset)
 397                'Y-offset (cdr offset)
 398                'text (make-null-markup)
 399                'footnote-text footnote))
 400
 401 grace =
 402 #(def-grace-function startGraceMusic stopGraceMusic
 403    (_i "Insert @var{music} as grace notes."))
 404
 405 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
 406   (_i "Convert @var{music} into harmonics; the resulting notes resemble
 407 harmonics played on a fretted instrument by touching the strings above @var{fret}.")
 408   (let* ((fret (number->string fret))
 409          (pitch (fret->pitch fret)))
 410         (make-sequential-music
 411          (list
 412           #{
 413             \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label $fret)
 414           #}
 415           (make-harmonic
 416             (calc-harmonic-pitch pitch music))
 417           #{
 418             \revert TabNoteHead #'stencil
 419           #}))))
 420
 421 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
 422     (_i "Convert @var{music} into harmonics; the resulting notes resemble
 423 harmonics played on a fretted instrument by touching the strings above the point
 424 given through @var{ratio}.")
 425   (let ((pitch (ratio->pitch ratio))
 426         (fret (ratio->fret ratio)))
 427        (make-sequential-music
 428         (list
 429          #{
 430            \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label $fret)
 431          #}
 432          (make-harmonic
 433            (calc-harmonic-pitch pitch music))
 434          #{
 435             \revert TabNoteHead #'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      ;;
 731      ;; utilities
 732      (define (push-music m)
 733        "Push the music expression into the current sequence"
 734        (set! current-sequence (cons m current-sequence)))
 735      (define (change-voice)
 736        "Stores the previously built sequence into the current voice and
 737        change to the following voice."
 738        (list-set! current-voices 0 (cons (make-music 'SequentialMusic
 739                                                      'elements (reverse! current-sequence))
 740                                          (car current-voices)))
 741        (set! current-sequence (list))
 742        (set! current-voices (cdr current-voices)))
 743      (define (bar-check? m)
 744        "Checks whether m is a bar check."
 745        (eq? (ly:music-property m 'name) 'BarCheck))
 746      (define (music-origin music)
 747        "Recursively search an origin location stored in music."
 748        (cond ((null? music) #f)
 749              ((not (null? (ly:music-property music 'origin)))
 750               (ly:music-property music 'origin))
 751              (else (or (music-origin (ly:music-property music 'element))
 752                        (let ((origins (remove not (map music-origin
 753                                                        (ly:music-property music 'elements)))))
 754                          (and (not (null? origins)) (car origins)))))))
 755      ;;
 756      ;; first, split the music and fill in voices
 757      (for-each (lambda (m)
 758                      (push-music m)
 759                      (if (bar-check? m) (change-voice)))
 760                    (ly:music-property music 'elements))
 761      (if (not (null? current-sequence)) (change-voice))
 762      ;; un-circularize `voices' and reorder the voices
 763      (set! voices (map-in-order (lambda (dummy seqs)
 764                                   (reverse! seqs))
 765                                 voice-ids voices))
 766      ;;
 767      ;; set origin location of each sequence in each voice
 768      ;; for better type error tracking
 769      (for-each (lambda (voice)
 770                  (for-each (lambda (seq)
 771                              (set! (ly:music-property seq 'origin)
 772                                    (or (music-origin seq) location)))
 773                            voice))
 774                voices)
 775      ;;
 776      ;; check sequence length
 777      (apply for-each (lambda* (#:rest seqs)
 778                               (let ((moment-reference (ly:music-length (car seqs))))
 779                                 (for-each (lambda (seq moment)
 780                                             (if (not (equal? moment moment-reference))
 781                                                 (ly:music-warning seq
 782                                                                   "Bars in parallel music don't have the same length")))
 783                                           seqs (map-in-order ly:music-length seqs))))
 784             voices)
 785      ;;
 786      ;; bind voice identifiers to the voices
 787      (for-each (lambda (voice-id voice)
 788             (ly:parser-define! parser voice-id
 789                                (make-music 'SequentialMusic
 790                                            'origin location
 791                                            'elements voice)))
 792           voice-ids voices)))
 793
 794 parenthesize =
 795 #(define-music-function (parser loc arg) (ly:music?)
 796    (_i "Tag @var{arg} to be parenthesized.")
 797
 798    (if (memq 'event-chord (ly:music-property arg 'types))
 799        ;; arg is an EventChord -> set the parenthesize property
 800        ;; on all child notes and rests
 801        (for-each
 802         (lambda (ev)
 803           (if (or (memq 'note-event (ly:music-property ev 'types))
 804                   (memq 'rest-event (ly:music-property ev 'types)))
 805               (set! (ly:music-property ev 'parenthesize) #t)))
 806         (ly:music-property arg 'elements))
 807        ;; No chord, simply set property for this expression:
 808        (set! (ly:music-property arg 'parenthesize) #t))
 809    arg)
 810
 811 partcombine =
 812 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 813    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 814 that they share a staff.")
 815    (make-part-combine-music parser
 816                             (list part1 part2) #f))
 817
 818 partcombineUp =
 819 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 820    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 821 that they share a staff with stems directed upward.")
 822    (make-part-combine-music parser
 823                             (list part1 part2) UP))
 824
 825 partcombineDown =
 826 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 827    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 828 that they share a staff with stems directed downward.")
 829    (make-part-combine-music parser
 830                             (list part1 part2) DOWN))
 831
 832 partcombineForce =
 833 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
 834    (_i "Override the part-combiner.")
 835    (make-music 'EventChord
 836                'elements (list (make-music 'PartCombineForceEvent
 837                                            'forced-type type
 838                                            'once once))))
 839 partcombineApart = \partcombineForce #'apart ##f
 840 partcombineApartOnce = \partcombineForce #'apart ##t
 841 partcombineChords = \partcombineForce #'chords ##f
 842 partcombineChordsOnce = \partcombineForce #'chords ##t
 843 partcombineUnisono = \partcombineForce #'unisono ##f
 844 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
 845 partcombineSoloI = \partcombineForce #'solo1 ##f
 846 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
 847 partcombineSoloII = \partcombineForce #'solo2 ##f
 848 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
 849 partcombineAutomatic = \partcombineForce ##f ##f
 850 partcombineAutomaticOnce = \partcombineForce ##f ##t
 851
 852 partial =
 853 #(define-music-function (parser location dur) (ly:duration?)
 854   (_i "Make a partial measure.")
 855
 856   ;; We use `descend-to-context' here instead of `context-spec-music' to
 857   ;; ensure \partial still works if the Timing_translator is moved
 858     (descend-to-context
 859      (context-spec-music (make-music 'PartialSet
 860                                      'origin location
 861                                      'partial-duration dur)
 862                          'Timing)
 863      'Score))
 864
 865 pitchedTrill =
 866 #(define-music-function
 867    (parser location main-note secondary-note)
 868    (ly:music? ly:music?)
 869    (_i "Print a trill with @var{main-note} as the main note of the trill and
 870 print @var{secondary-note} as a stemless note head in parentheses.")
 871    (let* ((get-notes (lambda (ev-chord)
 872                        (filter
 873                         (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
 874                         (ly:music-property ev-chord 'elements))))
 875           (sec-note-events (get-notes secondary-note))
 876           (trill-events (filter (lambda (m) (music-has-type m 'trill-span-event))
 877                                 (ly:music-property main-note 'elements))))
 878
 879      (if (pair? sec-note-events)
 880          (begin
 881            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
 882                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
 883
 884              (if (ly:pitch? trill-pitch)
 885                  (for-each (lambda (m)
 886                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
 887                  (begin
 888                    (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
 889                    (display sec-note-events)))
 890
 891              (if (eq? forced #t)
 892                  (for-each (lambda (m)
 893                              (ly:music-set-property! m 'force-accidental forced))
 894                            trill-events)))))
 895      main-note))
 896
 897 pushToTag =
 898 #(define-music-function (parser location tag more music)
 899    (symbol? ly:music? ly:music?)
 900    (_i "Add @var{more} to the front of @code{elements} of all music
 901 expressions in @var{music} that are tagged with @var{tag}.")
 902    (music-map (lambda (m)
 903                 (if (memq tag (ly:music-property m 'tags))
 904                     (set! (ly:music-property m 'elements)
 905                           (cons more (ly:music-property m 'elements))))
 906                 m)
 907               music))
 908
 909 quoteDuring =
 910 #(define-music-function (parser location what main-music) (string? ly:music?)
 911    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
 912 of the quoted voice, as specified in an @code{\\addQuote} command.
 913 @var{main-music} is used to indicate the length of music to be quoted;
 914 usually contains spacers or multi-measure rests.")
 915    (make-music 'QuoteMusic
 916                'element main-music
 917                'quoted-music-name what))
 918
 919 relative =
 920 #(define-music-function (parser location pitch music)
 921    ((ly:pitch? (ly:make-pitch 0 0 0)) ly:music?)
 922    (_i "Make @var{music} relative to @var{pitch} (default @code{c'}).")
 923    (ly:make-music-relative! music pitch)
 924    (make-music 'RelativeOctaveMusic
 925                'element music))
 926
 927 removeWithTag =
 928 #(define-music-function (parser location tag music) (symbol? ly:music?)
 929    (_i "Remove elements of @var{music} that are tagged with @var{tag}.")
 930    (music-filter
 931     (lambda (m)
 932       (let* ((tags (ly:music-property m 'tags))
 933              (res (memq tag tags)))
 934         (not res)))
 935     music))
 936
 937 resetRelativeOctave =
 938 #(define-music-function (parser location pitch) (ly:pitch?)
 939    (_i "Set the octave inside a \\relative section.")
 940
 941    (make-music 'SequentialMusic
 942                'to-relative-callback
 943                (lambda (music last-pitch) pitch)))
 944
 945 retrograde =
 946 #(define-music-function (parser location music)
 947     (ly:music?)
 948     (_i "Return @var{music} in reverse order.")
 949     (retrograde-music music))
 950
 951 revertTimeSignatureSettings =
 952 #(define-music-function
 953    (parser location time-signature)
 954    (pair?)
 955
 956    (_i "Revert @code{timeSignatureSettings}
 957 for time signatures of @var{time-signature}.")
 958    (revert-time-signature-setting time-signature))
 959
 960 rightHandFinger =
 961 #(define-music-function (parser location finger) (number-or-string?)
 962    (_i "Apply @var{finger} as a fingering indication.")
 963
 964    (make-music
 965             'StrokeFingerEvent
 966             'origin location
 967             (if (string? finger) 'text 'digit)
 968             finger))
 969
 970 scaleDurations =
 971 #(define-music-function (parser location fraction music)
 972    (fraction? ly:music?)
 973    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
 974    (ly:music-compress music
 975                       (ly:make-moment (car fraction) (cdr fraction))))
 976
 977 shiftDurations =
 978 #(define-music-function (parser location dur dots arg)
 979    (integer? integer? ly:music?)
 980    (_i "Scale @var{arg} up by a factor of 2^@var{dur}*(2-(1/2)^@var{dots}).")
 981
 982    (music-map
 983     (lambda (x)
 984       (shift-one-duration-log x dur dots)) arg))
 985
 986 skip =
 987 #(define-music-function (parser location dur) (ly:duration?)
 988   (_i "Skip forward by @var{dur}.")
 989   (make-music 'SkipMusic
 990               'duration dur))
 991
 992
 993 slashedGrace =
 994 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
 995    (_i "Create slashed graces (slashes through stems, but no slur) from
 996 the following music expression"))
 997
 998 spacingTweaks =
 999 #(define-music-function (parser location parameters) (list?)
1000    (_i "Set the system stretch, by reading the 'system-stretch property of
1001 the `parameters' assoc list.")
1002    #{
1003      \overrideProperty #"Score.NonMusicalPaperColumn"
1004      #'line-break-system-details
1005      #$(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1006              (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1007    #})
1008
1009 styledNoteHeads =
1010 #(define-music-function (parser location style heads music)
1011    (symbol? list-or-symbol? ly:music?)
1012    (_i "Set @var{heads} in @var{music} to @var{style}.")
1013    (style-note-heads heads style music))
1014
1015
1016
1017 tabChordRepetition =
1018 #(define-music-function (parser location) ()
1019    (_i "Include the string information in a chord repetition.")
1020    (ly:parser-set-repetition-function parser tab-repeat-chord)
1021    (make-music 'SequentialMusic 'void #t))
1022
1023 tag =
1024 #(define-music-function (parser location tag arg) (symbol? ly:music?)
1025
1026    (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
1027
1028    (set!
1029     (ly:music-property arg 'tags)
1030     (cons tag
1031           (ly:music-property arg 'tags)))
1032    arg)
1033
1034 time =
1035 #(define-music-function (parser location fraction) (fraction?)
1036    (_i "Set @var{fraction} as time signature.")
1037    (make-time-signature-set (car fraction) (cdr fraction)))
1038
1039 times =
1040 #(define-music-function (parser location fraction music)
1041    (fraction? ly:music?)
1042    (_i "Scale @var{music} in time by @var{fraction}.")
1043   (make-music 'TimeScaledMusic
1044               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1045               'numerator (car fraction)
1046               'denominator (cdr fraction)))
1047
1048 transpose =
1049 #(define-music-function
1050    (parser location from to music)
1051    (ly:pitch? ly:pitch? ly:music?)
1052
1053    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1054    (make-music 'TransposedMusic
1055                'element (ly:music-transpose music (ly:pitch-diff to from))))
1056
1057 transposedCueDuring =
1058 #(define-music-function
1059    (parser location what dir pitch main-music)
1060    (string? ly:dir? ly:pitch? ly:music?)
1061
1062    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1063 using the transposition defined by @var{pitch}.  This happens
1064 simultaneously with @var{main-music}, which is usually a rest.  The
1065 argument @var{dir} determines whether the cue notes should be notated
1066 as a first or second voice.")
1067
1068    (make-music 'QuoteMusic
1069                'element main-music
1070                'quoted-context-type 'Voice
1071                'quoted-context-id "cue"
1072                'quoted-music-name what
1073                'quoted-voice-direction dir
1074                'quoted-transposition pitch))
1075
1076 transposition =
1077 #(define-music-function (parser location pitch) (ly:pitch?)
1078    (_i "Set instrument transposition")
1079
1080    (context-spec-music
1081     (make-property-set 'instrumentTransposition
1082                        (ly:pitch-negate pitch))
1083     'Staff))
1084
1085 tweak =
1086 #(define-music-function (parser location sym val arg)
1087    (symbol? scheme? ly:music?)
1088    (_i "Add @code{sym . val} to the @code{tweaks} property of @var{arg}.")
1089
1090    (if (equal? (object-property sym 'backend-type?) #f)
1091        (begin
1092          (ly:input-warning location (_ "cannot find property type-check for ~a") sym)
1093          (ly:warning (_ "doing assignment anyway"))))
1094    (set!
1095     (ly:music-property arg 'tweaks)
1096     (acons sym val
1097            (ly:music-property arg 'tweaks)))
1098    arg)
1099
1100
1101
1102 unfoldRepeats =
1103 #(define-music-function (parser location music) (ly:music?)
1104    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1105 @code{\\repeat percent} commands in @var{music} to be interpreted
1106 as @code{\\repeat unfold}.")
1107    (unfold-repeats music))
1108
1109 void =
1110 #(define-void-function (parser location arg) (scheme?)
1111    (_i "Accept a scheme argument, return a void expression.
1112 Use this if you want to have a scheme expression evaluated
1113 because of its side-effects, but its value ignored."))
1114
1115
1116 withMusicProperty =
1117 #(define-music-function (parser location sym val music)
1118    (symbol? scheme? ly:music?)
1119    (_i "Set @var{sym} to @var{val} in @var{music}.")
1120
1121    (set! (ly:music-property music sym) val)
1122    music)