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