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.13.29"
  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-music-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    (make-music 'SequentialMusic 'void #t))
  46
  47 addQuote =
  48 #(define-music-function (parser location name music) (string? ly:music?)
  49    (_i "Define @var{music} as a quotable music expression named
  50 @var{name}")
  51    (add-quotable parser name music)
  52    (make-music 'SequentialMusic 'void #t))
  53
  54 %% keep these two together
  55 afterGraceFraction = #(cons 6 8)
  56 afterGrace =
  57 #(define-music-function (parser location main grace) (ly:music? ly:music?)
  58    (_i "Create @var{grace} note(s) after a @var{main} music expression.")
  59    (let ((main-length (ly:music-length main))
  60          (fraction  (ly:parser-lookup parser 'afterGraceFraction)))
  61      (make-simultaneous-music
  62       (list
  63        main
  64        (make-sequential-music
  65         (list
  66
  67          (make-music 'SkipMusic
  68                      'duration (ly:make-duration
  69                                 0 0
  70                                 (* (ly:moment-main-numerator main-length)
  71                                    (car fraction))
  72                                 (* (ly:moment-main-denominator main-length)
  73                                    (cdr fraction))))
  74          (make-music 'GraceMusic
  75                      'element grace)))))))
  76
  77
  78 %% music identifiers not allowed at top-level,
  79 %% so this is a music-function instead.
  80 allowPageTurn =
  81 #(define-music-function (location parser) ()
  82    (_i "Allow a page turn. May be used at toplevel (ie between scores or
  83 markups), or inside a score.")
  84    (make-music 'EventChord
  85                'page-marker #t
  86                'page-turn-permission 'allow
  87                'elements (list (make-music 'PageTurnEvent
  88                                            'break-permission 'allow))))
  89
  90 applyContext =
  91 #(define-music-function (parser location proc) (procedure?)
  92    (_i "Modify context properties with Scheme procedure @var{proc}.")
  93    (make-music 'ApplyContext
  94                'procedure proc))
  95
  96 applyMusic =
  97 #(define-music-function (parser location func music) (procedure? ly:music?)
  98    (_i"Apply procedure @var{func} to @var{music}.")
  99    (func music))
 100
 101 applyOutput =
 102 #(define-music-function (parser location ctx proc) (symbol? procedure?)
 103    (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
 104    (make-music 'ApplyOutputEvent
 105                'procedure proc
 106                'context-type ctx))
 107
 108 appoggiatura =
 109 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
 110    (_i "Create an appoggiatura from @var{music}"))
 111
 112 % for regression testing purposes.
 113 assertBeamQuant =
 114 #(define-music-function (parser location l r) (pair? pair?)
 115    (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
 116    (make-grob-property-override 'Beam 'positions
 117                                 (ly:make-simple-closure
 118                                  (ly:make-simple-closure
 119                                   (append
 120                                    (list chain-grob-member-functions `(,cons 0 0))
 121                                    (check-quant-callbacks l r))))))
 122
 123 % for regression testing purposes.
 124 assertBeamSlope =
 125 #(define-music-function (parser location comp) (procedure?)
 126    (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
 127    (make-grob-property-override 'Beam 'positions
 128                                 (ly:make-simple-closure
 129                                  (ly:make-simple-closure
 130                                   (append
 131                                    (list chain-grob-member-functions `(,cons 0 0))
 132                                    (check-slope-callbacks comp))))))
 133
 134 autochange =
 135 #(define-music-function (parser location music) (ly:music?)
 136    (_i "Make voices that switch between staves automatically")
 137    (make-autochange-music parser music))
 138
 139
 140
 141 balloonGrobText =
 142 #(define-music-function (parser location grob-name offset text)
 143    (symbol? number-pair? markup?)
 144    (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
 145  (use like @code{\\once})")
 146    (make-music 'AnnotateOutputEvent
 147                'symbol grob-name
 148                'X-offset (car offset)
 149                'Y-offset (cdr offset)
 150                'text text))
 151
 152 balloonText =
 153 #(define-music-function (parser location offset text) (number-pair? markup?)
 154    (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
 155    (make-music 'AnnotateOutputEvent
 156                'X-offset (car offset)
 157                'Y-offset (cdr offset)
 158                'text text))
 159
 160 bar =
 161 #(define-music-function (parser location type) (string?)
 162    (_i "Insert a bar line of type @var{type}")
 163    (context-spec-music
 164     (make-property-set 'whichBar type)
 165     'Timing))
 166
 167 barNumberCheck =
 168 #(define-music-function (parser location n) (integer?)
 169    (_i "Print a warning if the current bar number is not @var{n}.")
 170    (make-music 'ApplyContext
 171                'procedure
 172                (lambda (c)
 173                  (let ((cbn (ly:context-property c 'currentBarNumber)))
 174                    (if (and  (number? cbn) (not (= cbn n)))
 175                        (ly:input-message location
 176                                          "Barcheck failed got ~a expect ~a"
 177                                          cbn n))))))
 178
 179 bendAfter =
 180 #(define-music-function (parser location delta) (real?)
 181    (_i "Create a fall or doit of pitch interval @var{delta}.")
 182    (make-music 'BendAfterEvent
 183                'delta-step delta))
 184
 185 bookOutputName =
 186 #(define-music-function (parser location newfilename) (string?)
 187    (_i "Direct output for the current book block to @var{newfilename}.")
 188    (set! book-filename newfilename)
 189    (make-music 'SequentialMusic 'void #t))
 190
 191 bookOutputSuffix =
 192 #(define-music-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    (make-music 'SequentialMusic 'void #t))
 197
 198 %% \breathe is defined as a music function rather than an event identifier to
 199 %% ensure it gets useful input location information: as an event identifier,
 200 %% it would have to be wrapped in an EventChord to prevent it from being
 201 %% treated as a post_event by the parser
 202 breathe =
 203 #(define-music-function (parser location) ()
 204    (_i "Insert a breath mark.")
 205    (make-music 'BreathingEvent))
 206
 207
 208
 209 clef =
 210 #(define-music-function (parser location type) (string?)
 211    (_i "Set the current clef to @var{type}.")
 212    (make-clef-set type))
 213
 214
 215 compoundMeter =
 216 #(define-music-function (parser location args) (pair?)
 217   (_i "Create compound time signatures. The argument is a Scheme list of
 218 lists. Each list describes one fraction, with the last entry being the
 219 denominator, while the first entries describe the summands in the
 220 enumerator. If the time signature consists of just one fraction,
 221 the list can be given directly, i.e. not as a list containing a single list.
 222 For example, a time signature of (3+1)/8 + 2/4 would be created as
 223 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
 224 as @code{\\compoundMeter #'((3 2 8))} or shorter
 225 @code{\\compoundMeter #'(3 2 8)}.")
 226   (let* ((mlen (calculate-compound-measure-length args))
 227          (beat (calculate-compound-base-beat args))
 228          (beatGrouping (calculate-compound-beat-grouping args))
 229          (timesig (cons (ly:moment-main-numerator mlen)
 230                         (ly:moment-main-denominator mlen))))
 231   #{
 232     \once \override Staff.TimeSignature #'stencil = #(lambda (grob)
 233                 (grob-interpret-markup grob (format-compound-time $args)))
 234     \set Timing.timeSignatureFraction = $timesig
 235     \set Timing.baseMoment = $beat
 236     \set Timing.beatStructure = $beatGrouping
 237     \set Timing.beamExceptions = #'()
 238     \set Timing.measureLength = $mlen
 239   #} ))
 240
 241
 242 cueClef =
 243 #(define-music-function (parser location type) (string?)
 244   (_i "Set the current cue clef to @var{type}.")
 245   (make-cue-clef-set type))
 246 cueClefUnset =
 247 #(define-music-function (parser location) ()
 248   (_i "Unset the current cue clef.")
 249   (make-cue-clef-unset))
 250
 251 cueDuring =
 252 #(define-music-function
 253    (parser location what dir main-music) (string? ly:dir? ly:music?)
 254    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 255 in a CueVoice oriented by @var{dir}.")
 256    (make-music 'QuoteMusic
 257                'element main-music
 258                'quoted-context-type 'Voice
 259                'quoted-context-id "cue"
 260                'quoted-music-name what
 261                'quoted-voice-direction dir))
 262
 263 cueDuringWithClef =
 264 #(define-music-function
 265    (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
 266    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 267 in a CueVoice oriented by @var{dir}.")
 268    (make-music 'QuoteMusic
 269                'element main-music
 270                'quoted-context-type 'Voice
 271                'quoted-context-id "cue"
 272                'quoted-music-name what
 273                'quoted-music-clef clef
 274                'quoted-voice-direction dir))
 275
 276
 277
 278 displayLilyMusic =
 279 #(define-music-function (parser location music) (ly:music?)
 280    (_i "Display the LilyPond input representation of @var{music}
 281 to the console.")
 282    (newline)
 283    (display-lily-music music parser)
 284    music)
 285
 286 displayMusic =
 287 #(define-music-function (parser location music) (ly:music?)
 288    (_i "Display the internal representation of @var{music} to the console.")
 289    (newline)
 290    (display-scheme-music music)
 291    music)
 292
 293
 294
 295 endSpanners =
 296 #(define-music-function (parser location music) (ly:music?)
 297    (_i "Terminate the next spanner prematurely after exactly one note
 298 without the need of a specific end spanner.")
 299    (if (eq? (ly:music-property music 'name) 'EventChord)
 300        (let* ((elts (ly:music-property music 'elements))
 301               (start-span-evs (filter (lambda (ev)
 302                                         (and (music-has-type ev 'span-event)
 303                                              (equal? (ly:music-property ev 'span-direction)
 304                                                      START)))
 305                                       elts))
 306               (stop-span-evs
 307                (map (lambda (m)
 308                       (let ((c (music-clone m)))
 309                         (set! (ly:music-property c 'span-direction) STOP)
 310                         c))
 311                     start-span-evs))
 312               (end-ev-chord (make-music 'EventChord
 313                                         'elements stop-span-evs))
 314               (total (make-music 'SequentialMusic
 315                                  'elements (list music
 316                                                  end-ev-chord))))
 317          total)
 318
 319        (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a" music))))
 320
 321
 322
 323 featherDurations=
 324 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
 325    (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
 326    (let ((orig-duration (ly:music-length argument))
 327          (multiplier (ly:make-moment 1 1)))
 328
 329      (music-map
 330       (lambda (mus)
 331         (if (and (eq? (ly:music-property mus 'name) 'EventChord)
 332                  (< 0 (ly:moment-main-denominator (ly:music-length mus))))
 333             (begin
 334               (ly:music-compress mus multiplier)
 335               (set! multiplier (ly:moment-mul factor multiplier))))
 336         mus)
 337       argument)
 338
 339      (ly:music-compress
 340       argument
 341       (ly:moment-div orig-duration (ly:music-length argument)))
 342
 343      argument))
 344
 345
 346
 347 grace =
 348 #(def-grace-function startGraceMusic stopGraceMusic
 349    (_i "Insert @var{music} as grace notes."))
 350
 351 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
 352   (let* ((fret (number->string fret))
 353          (pitch (fret->pitch fret)))
 354         (make-sequential-music
 355          (list
 356           #{
 357             \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label $fret)
 358           #}
 359           (make-harmonic
 360             (calc-harmonic-pitch pitch music))
 361           #{
 362             \revert TabNoteHead #'stencil
 363           #}))))
 364
 365 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
 366   (let ((pitch (ratio->pitch ratio))
 367         (fret (ratio->fret ratio)))
 368        (make-sequential-music
 369         (list
 370          #{
 371            \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label $fret)
 372          #}
 373          (make-harmonic
 374            (calc-harmonic-pitch pitch music))
 375          #{
 376             \revert TabNoteHead #'stencil
 377          #}))))
 378
 379 instrumentSwitch =
 380 #(define-music-function
 381    (parser location name) (string?)
 382    (_i "Switch instrument to @var{name}, which must be predefined with
 383 @code{\\addInstrumentDefinition}.")
 384    (let* ((handle (assoc name instrument-definitions))
 385           (instrument-def (if handle (cdr handle) '())))
 386
 387      (if (not handle)
 388          (ly:input-message location "No such instrument: ~a" name))
 389      (context-spec-music
 390       (make-music 'SimultaneousMusic
 391                   'elements
 392                   (map (lambda (kv)
 393                          (make-property-set
 394                           (car kv)
 395                           (cdr kv)))
 396                        instrument-def))
 397       'Staff)))
 398
 399
 400
 401 keepWithTag =
 402 #(define-music-function (parser location tag music) (symbol? ly:music?)
 403    (_i "Include only elements of @var{music} that are tagged with @var{tag}.")
 404    (music-filter
 405     (lambda (m)
 406       (let* ((tags (ly:music-property m 'tags))
 407              (res (memq tag tags)))
 408         (or
 409          (eq? tags '())
 410          res)))
 411     music))
 412
 413 killCues =
 414 #(define-music-function (parser location music) (ly:music?)
 415    (_i "Remove cue notes from @var{music}.")
 416    (music-map
 417     (lambda (mus)
 418       (if (and (string? (ly:music-property mus 'quoted-music-name))
 419                (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
 420           (ly:music-property mus 'element)
 421           mus))
 422     music))
 423
 424
 425
 426 label =
 427 #(define-music-function (parser location label) (symbol?)
 428    (_i "Create @var{label} as a bookmarking label.")
 429    (make-music 'EventChord
 430                'page-marker #t
 431                'page-label label
 432                'elements (list (make-music 'LabelEvent
 433                                            'page-label label))))
 434
 435
 436 language =
 437 #(define-music-function (parser location language) (string?)
 438    (_i "Set note names for language @var{language}.")
 439    (note-names-language parser language)
 440    (make-music 'Music 'void #t))
 441
 442 languageSaveAndChange =
 443 #(define-music-function (parser location language) (string?)
 444   (_i "Store the previous pitchnames alist, and set a new one.")
 445   (set! previous-pitchnames pitchnames)
 446   (note-names-language parser language)
 447   (make-music 'Music 'void #t))
 448
 449 languageRestore =
 450 #(define-music-function (parser location) ()
 451    (_i "Restore a previously-saved pitchnames alist.")
 452    (if previous-pitchnames
 453        (begin
 454         (set! pitchnames previous-pitchnames)
 455         (ly:parser-set-note-names parser pitchnames))
 456       (ly:warning (_ "No other language was defined previously. Ignoring.")))
 457    (make-music 'Music 'void #t))
 458
 459
 460 makeClusters =
 461 #(define-music-function (parser location arg) (ly:music?)
 462    (_i "Display chords in @var{arg} as clusters.")
 463    (music-map note-to-cluster arg))
 464
 465 musicMap =
 466 #(define-music-function (parser location proc mus) (procedure? ly:music?)
 467    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 468    (music-map proc mus))
 469
 470
 471
 472 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 473 %% because music identifiers are not allowed at top-level.
 474 noPageBreak =
 475 #(define-music-function (location parser) ()
 476    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 477 markups), or inside a score.")
 478    (make-music 'EventChord
 479                'page-marker #t
 480                'page-break-permission 'forbid
 481                'elements (list (make-music 'PageBreakEvent
 482                                            'break-permission '()))))
 483
 484 noPageTurn =
 485 #(define-music-function (location parser) ()
 486    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 487 markups), or inside a score.")
 488    (make-music 'EventChord
 489                'page-marker #t
 490                'page-turn-permission 'forbid
 491                'elements (list (make-music 'PageTurnEvent
 492                                            'break-permission '()))))
 493
 494
 495
 496 octaveCheck =
 497 #(define-music-function (parser location pitch-note) (ly:music?)
 498    (_i "Octave check.")
 499    (make-music 'RelativeOctaveCheck
 500                'pitch (pitch-of-note pitch-note)))
 501
 502 ottava =
 503 #(define-music-function (parser location octave) (integer?)
 504    (_i "Set the octavation.")
 505    (make-music 'OttavaMusic
 506                'ottava-number octave))
 507
 508 overrideTimeSignatureSettings =
 509 #(define-music-function
 510    (parser location time-signature base-moment beat-structure beam-exceptions)
 511    (pair? pair? cheap-list? cheap-list?)
 512
 513    (_i "Override @code{timeSignatureSettings}
 514 for time signatures of @var{time-signature} to have settings
 515 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 516
 517    ;; TODO -- add warning if largest value of grouping is
 518    ;;       greater than time-signature.
 519   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 520     (override-time-signature-setting time-signature setting)))
 521
 522 overrideProperty =
 523 #(define-music-function (parser location name property value)
 524    (string? symbol? scheme?)
 525
 526    (_i "Set @var{property} to @var{value} in all grobs named @var{name}.
 527 The @var{name} argument is a string of the form @code{\"Context.GrobName\"}
 528 or @code{\"GrobName\"}.")
 529
 530    (let ((name-components (string-split name #\.))
 531          (context-name 'Bottom)
 532          (grob-name #f))
 533
 534      (if (> 2 (length name-components))
 535          (set! grob-name (string->symbol (car name-components)))
 536          (begin
 537            (set! grob-name (string->symbol (list-ref name-components 1)))
 538            (set! context-name (string->symbol (list-ref name-components 0)))))
 539
 540      (make-music 'ApplyOutputEvent
 541                  'context-type context-name
 542                  'procedure
 543                  (lambda (grob orig-context context)
 544                    (if (equal?
 545                         (cdr (assoc 'name (ly:grob-property grob 'meta)))
 546                         grob-name)
 547                        (set! (ly:grob-property grob property) value))))))
 548
 549
 550
 551 %% pageBreak and pageTurn are music functions (iso music indentifiers),
 552 %% because music identifiers are not allowed at top-level.
 553 pageBreak =
 554 #(define-music-function (location parser) ()
 555    (_i "Force 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                'line-break-permission 'force
 560                'page-break-permission 'force
 561                'elements (list (make-music 'LineBreakEvent
 562                                            'break-permission 'force)
 563                                (make-music 'PageBreakEvent
 564                                            'break-permission 'force))))
 565
 566 pageTurn =
 567 #(define-music-function (location parser) ()
 568    (_i "Force a page turn between two scores or top-level markups.")
 569    (make-music 'EventChord
 570                'page-marker #t
 571                'line-break-permission 'force
 572                'page-break-permission 'force
 573                'page-turn-permission 'force
 574                'elements (list (make-music 'LineBreakEvent
 575                                            'break-permission 'force)
 576                                (make-music 'PageBreakEvent
 577                                            'break-permission 'force)
 578                                (make-music 'PageTurnEvent
 579                                            'break-permission 'force))))
 580
 581 parallelMusic =
 582 #(define-music-function (parser location voice-ids music) (list? ly:music?)
 583    (_i "Define parallel music sequences, separated by '|' (bar check signs),
 584 and assign them to the identifiers provided in @var{voice-ids}.
 585
 586 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
 587
 588 @var{music}: a music sequence, containing BarChecks as limiting expressions.
 589
 590 Example:
 591
 592 @verbatim
 593   \\parallelMusic #'(A B C) {
 594     c c | d d | e e |
 595     d d | e e | f f |
 596   }
 597 <==>
 598   A = { c c | d d | }
 599   B = { d d | e e | }
 600   C = { e e | f f | }
 601 @end verbatim
 602 ")
 603    (let* ((voices (apply circular-list (make-list (length voice-ids) (list))))
 604           (current-voices voices)
 605           (current-sequence (list)))
 606      ;;
 607      ;; utilities
 608      (define (push-music m)
 609        "Push the music expression into the current sequence"
 610        (set! current-sequence (cons m current-sequence)))
 611      (define (change-voice)
 612        "Stores the previously built sequence into the current voice and
 613        change to the following voice."
 614        (list-set! current-voices 0 (cons (make-music 'SequentialMusic
 615                                                      'elements (reverse! current-sequence))
 616                                          (car current-voices)))
 617        (set! current-sequence (list))
 618        (set! current-voices (cdr current-voices)))
 619      (define (bar-check? m)
 620        "Checks whether m is a bar check."
 621        (eq? (ly:music-property m 'name) 'BarCheck))
 622      (define (music-origin music)
 623        "Recursively search an origin location stored in music."
 624        (cond ((null? music) #f)
 625              ((not (null? (ly:music-property music 'origin)))
 626               (ly:music-property music 'origin))
 627              (else (or (music-origin (ly:music-property music 'element))
 628                        (let ((origins (remove not (map music-origin
 629                                                        (ly:music-property music 'elements)))))
 630                          (and (not (null? origins)) (car origins)))))))
 631      ;;
 632      ;; first, split the music and fill in voices
 633      (map-in-order (lambda (m)
 634                      (push-music m)
 635                      (if (bar-check? m) (change-voice)))
 636                    (ly:music-property music 'elements))
 637      (if (not (null? current-sequence)) (change-voice))
 638      ;; un-circularize `voices' and reorder the voices
 639      (set! voices (map-in-order (lambda (dummy seqs)
 640                                   (reverse! seqs))
 641                                 voice-ids voices))
 642      ;;
 643      ;; set origin location of each sequence in each voice
 644      ;; for better type error tracking
 645      (for-each (lambda (voice)
 646                  (for-each (lambda (seq)
 647                              (set! (ly:music-property seq 'origin)
 648                                    (or (music-origin seq) location)))
 649                            voice))
 650                voices)
 651      ;;
 652      ;; check sequence length
 653      (apply for-each (lambda* (#:rest seqs)
 654                               (let ((moment-reference (ly:music-length (car seqs))))
 655                                 (for-each (lambda (seq moment)
 656                                             (if (not (equal? moment moment-reference))
 657                                                 (ly:music-message seq
 658                                                                   "Bars in parallel music don't have the same length")))
 659                                           seqs (map-in-order ly:music-length seqs))))
 660             voices)
 661      ;;
 662      ;; bind voice identifiers to the voices
 663      (map (lambda (voice-id voice)
 664             (ly:parser-define! parser voice-id
 665                                (make-music 'SequentialMusic
 666                                            'origin location
 667                                            'elements voice)))
 668           voice-ids voices))
 669    ;; Return an empty sequence.  This function is actually a "void" function.
 670    (make-music 'SequentialMusic 'void #t))
 671
 672 parenthesize =
 673 #(define-music-function (parser loc arg) (ly:music?)
 674    (_i "Tag @var{arg} to be parenthesized.")
 675
 676    (if (memq 'event-chord (ly:music-property arg 'types))
 677        ;; arg is an EventChord -> set the parenthesize property
 678        ;; on all child notes and rests
 679        (map
 680         (lambda (ev)
 681           (if (or (memq 'note-event (ly:music-property ev 'types))
 682                   (memq 'rest-event (ly:music-property ev 'types)))
 683               (set! (ly:music-property ev 'parenthesize) #t)))
 684         (ly:music-property arg 'elements))
 685        ;; No chord, simply set property for this expression:
 686        (set! (ly:music-property arg 'parenthesize) #t))
 687    arg)
 688
 689 partcombine =
 690 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 691    (_i "Take the music in @var{part1} and @var{part2} and typeset so
 692 that they share a staff.")
 693    (make-part-combine-music parser
 694                             (list part1 part2)))
 695
 696 partcombineForce =
 697 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
 698    (_i "Override the part-combiner.")
 699    (make-music 'EventChord
 700                'elements (list (make-music 'PartCombineForceEvent
 701                                            'forced-type type
 702                                            'once once))))
 703 partcombineApart = \partcombineForce #'apart ##f
 704 partcombineApartOnce = \partcombineForce #'apart ##t
 705 partcombineChords = \partcombineForce #'chords ##f
 706 partcombineChordsOnce = \partcombineForce #'chords ##t
 707 partcombineUnisono = \partcombineForce #'unisono ##f
 708 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
 709 partcombineSoloI = \partcombineForce #'solo1 ##f
 710 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
 711 partcombineSoloII = \partcombineForce #'solo2 ##f
 712 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
 713 partcombineAutomatic = \partcombineForce ##f ##f
 714 partcombineAutomaticOnce = \partcombineForce ##f ##t
 715
 716
 717 pitchedTrill =
 718 #(define-music-function
 719    (parser location main-note secondary-note)
 720    (ly:music? ly:music?)
 721    (_i "Print a trill with @var{main-note} as the main note of the trill and
 722 print @var{secondary-note} as a stemless note head in parentheses.")
 723    (let* ((get-notes (lambda (ev-chord)
 724                        (filter
 725                         (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
 726                         (ly:music-property ev-chord 'elements))))
 727           (sec-note-events (get-notes secondary-note))
 728           (trill-events (filter (lambda (m) (music-has-type m 'trill-span-event))
 729                                 (ly:music-property main-note 'elements))))
 730
 731      (if (pair? sec-note-events)
 732          (begin
 733            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
 734                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
 735
 736              (if (ly:pitch? trill-pitch)
 737                  (for-each (lambda (m)
 738                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
 739                  (begin
 740                    (ly:warning (_ "Second argument of \\pitchedTrill should be single note: "))
 741                    (display sec-note-events)))
 742
 743              (if (eq? forced #t)
 744                  (for-each (lambda (m)
 745                              (ly:music-set-property! m 'force-accidental forced))
 746                            trill-events)))))
 747      main-note))
 748
 749 quoteDuring =
 750 #(define-music-function (parser location what main-music) (string? ly:music?)
 751    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
 752 of the quoted voice, as specified in an @code{\\addQuote} command.
 753 @var{main-music} is used to indicate the length of music to be quoted;
 754 usually contains spacers or multi-measure rests.")
 755    (make-music 'QuoteMusic
 756                'element main-music
 757                'quoted-music-name what))
 758
 759 removeWithTag =
 760 #(define-music-function (parser location tag music) (symbol? ly:music?)
 761    (_i "Remove elements of @var{music} that are tagged with @var{tag}.")
 762    (music-filter
 763     (lambda (m)
 764       (let* ((tags (ly:music-property m 'tags))
 765              (res (memq tag tags)))
 766         (not res)))
 767     music))
 768
 769 resetRelativeOctave =
 770 #(define-music-function (parser location reference-note) (ly:music?)
 771    (_i "Set the octave inside a \\relative section.")
 772
 773    (let* ((notes (ly:music-property reference-note 'elements))
 774           (pitch (ly:music-property (car notes) 'pitch)))
 775
 776      (set! (ly:music-property reference-note 'elements) '())
 777      (set! (ly:music-property reference-note 'to-relative-callback)
 778            (lambda (music last-pitch)
 779              pitch))
 780
 781      reference-note))
 782
 783 revertTimeSignatureSettings =
 784 #(define-music-function
 785    (parser location time-signature)
 786    (pair?)
 787
 788    (_i "Revert @code{timeSignatureSettings}
 789 for time signatures of @var{time-signature}.")
 790    (revert-time-signature-setting time-signature))
 791
 792 rightHandFinger =
 793 #(define-music-function (parser location finger) (number-or-string?)
 794    (_i "Apply @var{finger} as a fingering indication.")
 795
 796    (apply make-music
 797           (append
 798            (list
 799             'StrokeFingerEvent
 800             'origin location)
 801            (if  (string? finger)
 802                 (list 'text finger)
 803                 (list 'digit finger)))))
 804
 805
 806
 807 scaleDurations =
 808 #(define-music-function (parser location fraction music)
 809    (number-pair? ly:music?)
 810    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
 811    (ly:music-compress music
 812                       (ly:make-moment (car fraction) (cdr fraction))))
 813
 814 shiftDurations =
 815 #(define-music-function (parser location dur dots arg)
 816    (integer? integer? ly:music?)
 817    (_i "Scale @var{arg} up by a factor of @var{2^dur*(2-(1/2)^dots)}.")
 818
 819    (music-map
 820     (lambda (x)
 821       (shift-one-duration-log x dur dots)) arg))
 822
 823 spacingTweaks =
 824 #(define-music-function (parser location parameters) (list?)
 825    (_i "Set the system stretch, by reading the 'system-stretch property of
 826 the `parameters' assoc list.")
 827    #{
 828      \overrideProperty #"Score.NonMusicalPaperColumn"
 829      #'line-break-system-details
 830      #$(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
 831              (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
 832    #})
 833
 834 styledNoteHeads =
 835 #(define-music-function (parser location style heads music)
 836    (symbol? list-or-symbol? ly:music?)
 837    (_i "Set @var{heads} in @var{music} to @var{style}.")
 838    (style-note-heads heads style music))
 839
 840
 841
 842 tabChordRepetition =
 843 #(define-music-function (parser location) ()
 844    (_i "Include the string information in a chord repetition.")
 845    (ly:parser-set-repetition-function parser tab-repeat-chord)
 846    (make-music 'SequentialMusic 'void #t))
 847
 848 tag =
 849 #(define-music-function (parser location tag arg) (symbol? ly:music?)
 850
 851    (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
 852
 853    (set!
 854     (ly:music-property arg 'tags)
 855     (cons tag
 856           (ly:music-property arg 'tags)))
 857    arg)
 858
 859 transposedCueDuring =
 860 #(define-music-function
 861    (parser location what dir pitch-note main-music)
 862    (string? ly:dir? ly:music? ly:music?)
 863
 864    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
 865 using the transposition defined by @var{pitch-note}.  This happens
 866 simultaneously with @var{main-music}, which is usually a rest.  The
 867 argument @var{dir} determines whether the cue notes should be notated
 868 as a first or second voice.")
 869
 870    (make-music 'QuoteMusic
 871                'element main-music
 872                'quoted-context-type 'Voice
 873                'quoted-context-id "cue"
 874                'quoted-music-name what
 875                'quoted-voice-direction dir
 876                'quoted-transposition (pitch-of-note pitch-note)))
 877
 878 transposition =
 879 #(define-music-function (parser location pitch-note) (ly:music?)
 880    (_i "Set instrument transposition")
 881
 882    (context-spec-music
 883     (make-property-set 'instrumentTransposition
 884                        (ly:pitch-negate (pitch-of-note pitch-note)))
 885     'Staff))
 886
 887 tweak =
 888 #(define-music-function (parser location sym val arg)
 889    (symbol? scheme? ly:music?)
 890    (_i "Add @code{sym . val} to the @code{tweaks} property of @var{arg}.")
 891
 892    (if (equal? (object-property sym 'backend-type?) #f)
 893        (begin
 894          (ly:warning (_ "cannot find property type-check for ~a") sym)
 895          (ly:warning (_ "doing assignment anyway"))))
 896    (set!
 897     (ly:music-property arg 'tweaks)
 898     (acons sym val
 899            (ly:music-property arg 'tweaks)))
 900    arg)
 901
 902
 903
 904 unfoldRepeats =
 905 #(define-music-function (parser location music) (ly:music?)
 906    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
 907 @code{\\repeat percent} commands in @var{music} to be interpreted
 908 as @code{\\repeat unfold}.")
 909    (unfold-repeats music))
 910
 911
 912
 913 withMusicProperty =
 914 #(define-music-function (parser location sym val music)
 915    (symbol? scheme? ly:music?)
 916    (_i "Set @var{sym} to @var{val} in @var{music}.")
 917
 918    (set! (ly:music-property music sym) val)
 919    music)