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