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 killCues =
 473 #(define-music-function (parser location music) (ly:music?)
 474    (_i "Remove cue notes from @var{music}.")
 475    (music-map
 476     (lambda (mus)
 477       (if (and (string? (ly:music-property mus 'quoted-music-name))
 478                (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
 479           (ly:music-property mus 'element)
 480           mus))
 481     music))
 482
 483
 484
 485 label =
 486 #(define-music-function (parser location label) (symbol?)
 487    (_i "Create @var{label} as a bookmarking label.")
 488    (make-music 'EventChord
 489                'page-marker #t
 490                'page-label label
 491                'elements (list (make-music 'LabelEvent
 492                                            'page-label label))))
 493
 494
 495 language =
 496 #(define-void-function (parser location language) (string?)
 497    (_i "Set note names for language @var{language}.")
 498    (note-names-language parser language))
 499
 500 languageSaveAndChange =
 501 #(define-void-function (parser location language) (string?)
 502   (_i "Store the previous pitchnames alist, and set a new one.")
 503   (set! previous-pitchnames pitchnames)
 504   (note-names-language parser language))
 505
 506 languageRestore =
 507 #(define-void-function (parser location) ()
 508    (_i "Restore a previously-saved pitchnames alist.")
 509    (if previous-pitchnames
 510        (begin
 511         (set! pitchnames previous-pitchnames)
 512         (ly:parser-set-note-names parser pitchnames))
 513       (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
 514
 515
 516 makeClusters =
 517 #(define-music-function (parser location arg) (ly:music?)
 518    (_i "Display chords in @var{arg} as clusters.")
 519    (music-map note-to-cluster arg))
 520
 521 modalInversion =
 522 #(define-music-function (parser location around to scale music)
 523     (ly:pitch? ly:pitch? ly:music? ly:music?)
 524     (_i "Invert @var{music} about @var{around} using @var{scale} and
 525 transpose from @var{around} to @var{to}.")
 526     (let ((inverter (make-modal-inverter around to scale)))
 527       (change-pitches music inverter)
 528       music))
 529
 530 modalTranspose =
 531 #(define-music-function (parser location from to scale music)
 532     (ly:pitch? ly:pitch? ly:music? ly:music?)
 533     (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
 534 using @var{scale}.")
 535     (let ((transposer (make-modal-transposer from to scale)))
 536       (change-pitches music transposer)
 537       music))
 538
 539 inversion =
 540 #(define-music-function
 541    (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
 542    (_i "Invert @var{music} about @var{around} and
 543 transpose from @var{around} to @var{to}.")
 544    (music-invert around to music))
 545
 546 musicMap =
 547 #(define-music-function (parser location proc mus) (procedure? ly:music?)
 548    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 549    (music-map proc mus))
 550
 551 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 552 %% because music identifiers are not allowed at top-level.
 553 noPageBreak =
 554 #(define-music-function (location parser) ()
 555    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 556 markups), or inside a score.")
 557    (make-music 'EventChord
 558                'page-marker #t
 559                'page-break-permission 'forbid
 560                'elements (list (make-music 'PageBreakEvent
 561                                            'break-permission '()))))
 562
 563 noPageTurn =
 564 #(define-music-function (location parser) ()
 565    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 566 markups), or inside a score.")
 567    (make-music 'EventChord
 568                'page-marker #t
 569                'page-turn-permission 'forbid
 570                'elements (list (make-music 'PageTurnEvent
 571                                            'break-permission '()))))
 572
 573
 574
 575 octaveCheck =
 576 #(define-music-function (parser location pitch) (ly:pitch?)
 577    (_i "Octave check.")
 578    (make-music 'RelativeOctaveCheck
 579                'pitch pitch))
 580
 581 ottava =
 582 #(define-music-function (parser location octave) (integer?)
 583    (_i "Set the octavation.")
 584    (make-music 'OttavaMusic
 585                'ottava-number octave))
 586
 587 overrideTimeSignatureSettings =
 588 #(define-music-function
 589    (parser location time-signature base-moment beat-structure beam-exceptions)
 590    (pair? pair? cheap-list? cheap-list?)
 591
 592    (_i "Override @code{timeSignatureSettings}
 593 for time signatures of @var{time-signature} to have settings
 594 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 595
 596    ;; TODO -- add warning if largest value of grouping is
 597    ;;       greater than time-signature.
 598   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 599     (override-time-signature-setting time-signature setting)))
 600
 601 overrideProperty =
 602 #(define-music-function (parser location name property value)
 603    (string? symbol? scheme?)
 604
 605    (_i "Set @var{property} to @var{value} in all grobs named @var{name}.
 606 The @var{name} argument is a string of the form @code{\"Context.GrobName\"}
 607 or @code{\"GrobName\"}.")
 608
 609    (let ((name-components (string-split name #\.))
 610          (context-name 'Bottom)
 611          (grob-name #f))
 612
 613      (if (> 2 (length name-components))
 614          (set! grob-name (string->symbol (car name-components)))
 615          (begin
 616            (set! grob-name (string->symbol (list-ref name-components 1)))
 617            (set! context-name (string->symbol (list-ref name-components 0)))))
 618
 619      (make-music 'ApplyOutputEvent
 620                  'context-type context-name
 621                  'procedure
 622                  (lambda (grob orig-context context)
 623                    (if (equal?
 624                         (cdr (assoc 'name (ly:grob-property grob 'meta)))
 625                         grob-name)
 626                        (set! (ly:grob-property grob property) value))))))
 627
 628
 629
 630 %% pageBreak and pageTurn are music functions (iso music indentifiers),
 631 %% because music identifiers are not allowed at top-level.
 632 pageBreak =
 633 #(define-music-function (location parser) ()
 634    (_i "Force a page break.  May be used at toplevel (i.e., between scores or
 635 markups), or inside a score.")
 636    (make-music 'EventChord
 637                'page-marker #t
 638                'line-break-permission 'force
 639                'page-break-permission 'force
 640                'elements (list (make-music 'LineBreakEvent
 641                                            'break-permission 'force)
 642                                (make-music 'PageBreakEvent
 643                                            'break-permission 'force))))
 644
 645 pageTurn =
 646 #(define-music-function (location parser) ()
 647    (_i "Force a page turn between two scores or top-level markups.")
 648    (make-music 'EventChord
 649                'page-marker #t
 650                'line-break-permission 'force
 651                'page-break-permission 'force
 652                'page-turn-permission 'force
 653                'elements (list (make-music 'LineBreakEvent
 654                                            'break-permission 'force)
 655                                (make-music 'PageBreakEvent
 656                                            'break-permission 'force)
 657                                (make-music 'PageTurnEvent
 658                                            'break-permission 'force))))
 659
 660 parallelMusic =
 661 #(define-void-function (parser location voice-ids music) (list? ly:music?)
 662    (_i "Define parallel music sequences, separated by '|' (bar check signs),
 663 and assign them to the identifiers provided in @var{voice-ids}.
 664
 665 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
 666
 667 @var{music}: a music sequence, containing BarChecks as limiting expressions.
 668
 669 Example:
 670
 671 @verbatim
 672   \\parallelMusic #'(A B C) {
 673     c c | d d | e e |
 674     d d | e e | f f |
 675   }
 676 <==>
 677   A = { c c | d d | }
 678   B = { d d | e e | }
 679   C = { e e | f f | }
 680 @end verbatim
 681 ")
 682    (let* ((voices (apply circular-list (make-list (length voice-ids) (list))))
 683           (current-voices voices)
 684           (current-sequence (list)))
 685      ;;
 686      ;; utilities
 687      (define (push-music m)
 688        "Push the music expression into the current sequence"
 689        (set! current-sequence (cons m current-sequence)))
 690      (define (change-voice)
 691        "Stores the previously built sequence into the current voice and
 692        change to the following voice."
 693        (list-set! current-voices 0 (cons (make-music 'SequentialMusic
 694                                                      'elements (reverse! current-sequence))
 695                                          (car current-voices)))
 696        (set! current-sequence (list))
 697        (set! current-voices (cdr current-voices)))
 698      (define (bar-check? m)
 699        "Checks whether m is a bar check."
 700        (eq? (ly:music-property m 'name) 'BarCheck))
 701      (define (music-origin music)
 702        "Recursively search an origin location stored in music."
 703        (cond ((null? music) #f)
 704              ((not (null? (ly:music-property music 'origin)))
 705               (ly:music-property music 'origin))
 706              (else (or (music-origin (ly:music-property music 'element))
 707                        (let ((origins (remove not (map music-origin
 708                                                        (ly:music-property music 'elements)))))
 709                          (and (not (null? origins)) (car origins)))))))
 710      ;;
 711      ;; first, split the music and fill in voices
 712      (for-each (lambda (m)
 713                      (push-music m)
 714                      (if (bar-check? m) (change-voice)))
 715                    (ly:music-property music 'elements))
 716      (if (not (null? current-sequence)) (change-voice))
 717      ;; un-circularize `voices' and reorder the voices
 718      (set! voices (map-in-order (lambda (dummy seqs)
 719                                   (reverse! seqs))
 720                                 voice-ids voices))
 721      ;;
 722      ;; set origin location of each sequence in each voice
 723      ;; for better type error tracking
 724      (for-each (lambda (voice)
 725                  (for-each (lambda (seq)
 726                              (set! (ly:music-property seq 'origin)
 727                                    (or (music-origin seq) location)))
 728                            voice))
 729                voices)
 730      ;;
 731      ;; check sequence length
 732      (apply for-each (lambda* (#:rest seqs)
 733                               (let ((moment-reference (ly:music-length (car seqs))))
 734                                 (for-each (lambda (seq moment)
 735                                             (if (not (equal? moment moment-reference))
 736                                                 (ly:music-warning seq
 737                                                                   "Bars in parallel music don't have the same length")))
 738                                           seqs (map-in-order ly:music-length seqs))))
 739             voices)
 740      ;;
 741      ;; bind voice identifiers to the voices
 742      (for-each (lambda (voice-id voice)
 743             (ly:parser-define! parser voice-id
 744                                (make-music 'SequentialMusic
 745                                            'origin location
 746                                            'elements voice)))
 747           voice-ids voices)))
 748
 749 parenthesize =
 750 #(define-music-function (parser loc arg) (ly:music?)
 751    (_i "Tag @var{arg} to be parenthesized.")
 752
 753    (if (memq 'event-chord (ly:music-property arg 'types))
 754        ;; arg is an EventChord -> set the parenthesize property
 755        ;; on all child notes and rests
 756        (for-each
 757         (lambda (ev)
 758           (if (or (memq 'note-event (ly:music-property ev 'types))
 759                   (memq 'rest-event (ly:music-property ev 'types)))
 760               (set! (ly:music-property ev 'parenthesize) #t)))
 761         (ly:music-property arg 'elements))
 762        ;; No chord, simply set property for this expression:
 763        (set! (ly:music-property arg 'parenthesize) #t))
 764    arg)
 765
 766 partcombine =
 767 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 768    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 769 that they share a staff.")
 770    (make-part-combine-music parser
 771                             (list part1 part2) #f))
 772
 773 partcombineUp =
 774 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 775    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 776 that they share a staff with stems directed upward.")
 777    (make-part-combine-music parser
 778                             (list part1 part2) UP))
 779
 780 partcombineDown =
 781 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 782    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 783 that they share a staff with stems directed downward.")
 784    (make-part-combine-music parser
 785                             (list part1 part2) DOWN))
 786
 787 partcombineForce =
 788 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
 789    (_i "Override the part-combiner.")
 790    (make-music 'EventChord
 791                'elements (list (make-music 'PartCombineForceEvent
 792                                            'forced-type type
 793                                            'once once))))
 794 partcombineApart = \partcombineForce #'apart ##f
 795 partcombineApartOnce = \partcombineForce #'apart ##t
 796 partcombineChords = \partcombineForce #'chords ##f
 797 partcombineChordsOnce = \partcombineForce #'chords ##t
 798 partcombineUnisono = \partcombineForce #'unisono ##f
 799 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
 800 partcombineSoloI = \partcombineForce #'solo1 ##f
 801 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
 802 partcombineSoloII = \partcombineForce #'solo2 ##f
 803 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
 804 partcombineAutomatic = \partcombineForce ##f ##f
 805 partcombineAutomaticOnce = \partcombineForce ##f ##t
 806
 807 partial =
 808 #(define-music-function (parser location dur) (ly:duration?)
 809   (_i "Make a partial measure.")
 810
 811   ;; We use `descend-to-context' here instead of `context-spec-music' to
 812   ;; ensure \partial still works if the Timing_translator is moved
 813     (descend-to-context
 814      (context-spec-music (make-music 'PartialSet
 815                                      'origin location
 816                                      'partial-duration dur)
 817                          'Timing)
 818      'Score))
 819
 820 pitchedTrill =
 821 #(define-music-function
 822    (parser location main-note secondary-note)
 823    (ly:music? ly:music?)
 824    (_i "Print a trill with @var{main-note} as the main note of the trill and
 825 print @var{secondary-note} as a stemless note head in parentheses.")
 826    (let* ((get-notes (lambda (ev-chord)
 827                        (filter
 828                         (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
 829                         (ly:music-property ev-chord 'elements))))
 830           (sec-note-events (get-notes secondary-note))
 831           (trill-events (filter (lambda (m) (music-has-type m 'trill-span-event))
 832                                 (ly:music-property main-note 'elements))))
 833
 834      (if (pair? sec-note-events)
 835          (begin
 836            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
 837                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
 838
 839              (if (ly:pitch? trill-pitch)
 840                  (for-each (lambda (m)
 841                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
 842                  (begin
 843                    (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
 844                    (display sec-note-events)))
 845
 846              (if (eq? forced #t)
 847                  (for-each (lambda (m)
 848                              (ly:music-set-property! m 'force-accidental forced))
 849                            trill-events)))))
 850      main-note))
 851
 852 pushToTag =
 853 #(define-music-function (parser location tag more music)
 854    (symbol? ly:music? ly:music?)
 855    (_i "Add @var{more} to the front of @code{elements} of all music
 856 expressions in @var{music} that are tagged with @var{tag}.")
 857    (music-map (lambda (m)
 858                 (if (memq tag (ly:music-property m 'tags))
 859                     (set! (ly:music-property m 'elements)
 860                           (cons more (ly:music-property m 'elements))))
 861                 m)
 862               music))
 863
 864 quoteDuring =
 865 #(define-music-function (parser location what main-music) (string? ly:music?)
 866    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
 867 of the quoted voice, as specified in an @code{\\addQuote} command.
 868 @var{main-music} is used to indicate the length of music to be quoted;
 869 usually contains spacers or multi-measure rests.")
 870    (make-music 'QuoteMusic
 871                'element main-music
 872                'quoted-music-name what))
 873
 874 relative =
 875 #(define-music-function (parser location pitch music)
 876    ((ly:pitch? (ly:make-pitch 0 0 0)) ly:music?)
 877    (_i "Make @var{music} relative to @var{pitch} (default @code{c'}).")
 878    (ly:make-music-relative! music pitch)
 879    (make-music 'RelativeOctaveMusic
 880                'element music))
 881
 882 removeWithTag =
 883 #(define-music-function (parser location tag music) (symbol? ly:music?)
 884    (_i "Remove elements of @var{music} that are tagged with @var{tag}.")
 885    (music-filter
 886     (lambda (m)
 887       (let* ((tags (ly:music-property m 'tags))
 888              (res (memq tag tags)))
 889         (not res)))
 890     music))
 891
 892 resetRelativeOctave =
 893 #(define-music-function (parser location pitch) (ly:pitch?)
 894    (_i "Set the octave inside a \\relative section.")
 895
 896    (make-music 'SequentialMusic
 897                'to-relative-callback
 898                (lambda (music last-pitch) pitch)))
 899
 900 retrograde =
 901 #(define-music-function (parser location music)
 902     (ly:music?)
 903     (_i "Return @var{music} in reverse order.")
 904     (retrograde-music music))
 905
 906 revertTimeSignatureSettings =
 907 #(define-music-function
 908    (parser location time-signature)
 909    (pair?)
 910
 911    (_i "Revert @code{timeSignatureSettings}
 912 for time signatures of @var{time-signature}.")
 913    (revert-time-signature-setting time-signature))
 914
 915 rightHandFinger =
 916 #(define-music-function (parser location finger) (number-or-string?)
 917    (_i "Apply @var{finger} as a fingering indication.")
 918
 919    (make-music
 920             'StrokeFingerEvent
 921             'origin location
 922             (if (string? finger) 'text 'digit)
 923             finger))
 924
 925 scaleDurations =
 926 #(define-music-function (parser location fraction music)
 927    (number-pair? ly:music?)
 928    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
 929    (ly:music-compress music
 930                       (ly:make-moment (car fraction) (cdr fraction))))
 931
 932 shiftDurations =
 933 #(define-music-function (parser location dur dots arg)
 934    (integer? integer? ly:music?)
 935    (_i "Scale @var{arg} up by a factor of 2^@var{dur}*(2-(1/2)^@var{dots}).")
 936
 937    (music-map
 938     (lambda (x)
 939       (shift-one-duration-log x dur dots)) arg))
 940
 941 skip =
 942 #(define-music-function (parser location dur) (ly:duration?)
 943   (_i "Skip forward by @var{dur}.")
 944   (make-music 'SkipMusic
 945               'duration dur))
 946
 947
 948 slashedGrace =
 949 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
 950    (_i "Create slashed graces (slashes through stems, but no slur) from
 951 the following music expression"))
 952
 953 spacingTweaks =
 954 #(define-music-function (parser location parameters) (list?)
 955    (_i "Set the system stretch, by reading the 'system-stretch property of
 956 the `parameters' assoc list.")
 957    #{
 958      \overrideProperty #"Score.NonMusicalPaperColumn"
 959      #'line-break-system-details
 960      #$(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
 961              (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
 962    #})
 963
 964 styledNoteHeads =
 965 #(define-music-function (parser location style heads music)
 966    (symbol? list-or-symbol? ly:music?)
 967    (_i "Set @var{heads} in @var{music} to @var{style}.")
 968    (style-note-heads heads style music))
 969
 970
 971
 972 tabChordRepetition =
 973 #(define-music-function (parser location) ()
 974    (_i "Include the string information in a chord repetition.")
 975    (ly:parser-set-repetition-function parser tab-repeat-chord)
 976    (make-music 'SequentialMusic 'void #t))
 977
 978 tag =
 979 #(define-music-function (parser location tag arg) (symbol? ly:music?)
 980
 981    (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
 982
 983    (set!
 984     (ly:music-property arg 'tags)
 985     (cons tag
 986           (ly:music-property arg 'tags)))
 987    arg)
 988
 989 transpose =
 990 #(define-music-function
 991    (parser location from to music)
 992    (ly:pitch? ly:pitch? ly:music?)
 993
 994    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
 995    (make-music 'TransposedMusic
 996                'element (ly:music-transpose music (ly:pitch-diff to from))))
 997
 998 transposedCueDuring =
 999 #(define-music-function
1000    (parser location what dir pitch main-music)
1001    (string? ly:dir? ly:pitch? ly:music?)
1002
1003    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1004 using the transposition defined by @var{pitch}.  This happens
1005 simultaneously with @var{main-music}, which is usually a rest.  The
1006 argument @var{dir} determines whether the cue notes should be notated
1007 as a first or second voice.")
1008
1009    (make-music 'QuoteMusic
1010                'element main-music
1011                'quoted-context-type 'Voice
1012                'quoted-context-id "cue"
1013                'quoted-music-name what
1014                'quoted-voice-direction dir
1015                'quoted-transposition pitch))
1016
1017 transposition =
1018 #(define-music-function (parser location pitch) (ly:pitch?)
1019    (_i "Set instrument transposition")
1020
1021    (context-spec-music
1022     (make-property-set 'instrumentTransposition
1023                        (ly:pitch-negate pitch))
1024     'Staff))
1025
1026 tweak =
1027 #(define-music-function (parser location sym val arg)
1028    (symbol? scheme? ly:music?)
1029    (_i "Add @code{sym . val} to the @code{tweaks} property of @var{arg}.")
1030
1031    (if (equal? (object-property sym 'backend-type?) #f)
1032        (begin
1033          (ly:input-warning location (_ "cannot find property type-check for ~a") sym)
1034          (ly:warning (_ "doing assignment anyway"))))
1035    (set!
1036     (ly:music-property arg 'tweaks)
1037     (acons sym val
1038            (ly:music-property arg 'tweaks)))
1039    arg)
1040
1041
1042
1043 unfoldRepeats =
1044 #(define-music-function (parser location music) (ly:music?)
1045    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1046 @code{\\repeat percent} commands in @var{music} to be interpreted
1047 as @code{\\repeat unfold}.")
1048    (unfold-repeats music))
1049
1050 void =
1051 #(define-void-function (parser location arg) (scheme?)
1052    (_i "Accept a scheme argument, return a void expression.
1053 Use this if you want to have a scheme expression evaluated
1054 because of its side-effects, but its value ignored."))
1055
1056
1057 withMusicProperty =
1058 #(define-music-function (parser location sym val music)
1059    (symbol? scheme? ly:music?)
1060    (_i "Set @var{sym} to @var{val} in @var{music}.")
1061
1062    (set! (ly:music-property music sym) val)
1063    music)