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--2015 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.17.11"
  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 absolute =
  35 #(define-music-function (parser location music)
  36    (ly:music?)
  37    (_i "Make @var{music} absolute.  This does not actually change the
  38 music itself but rather hides it from surrounding @code{\\relative}
  39 commands.")
  40    (make-music 'RelativeOctaveMusic 'element music))
  41
  42 acciaccatura =
  43 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
  44    (_i "Create an acciaccatura from the following music expression"))
  45
  46 %% keep these two together
  47 instrument-definitions = #'()
  48 addInstrumentDefinition =
  49 #(define-void-function
  50    (parser location name lst) (string? list?)
  51    (_i "Create instrument @var{name} with properties @var{list}.")
  52    (set! instrument-definitions (acons name lst instrument-definitions)))
  53
  54 addQuote =
  55 #(define-void-function (parser location name music) (string? ly:music?)
  56    (_i "Define @var{music} as a quotable music expression named
  57 @var{name}")
  58    (add-quotable parser name music))
  59
  60 %% keep these two together
  61 afterGraceFraction = #(cons 6 8)
  62 afterGrace =
  63 #(define-music-function (parser location main grace) (ly:music? ly:music?)
  64    (_i "Create @var{grace} note(s) after a @var{main} music expression.")
  65    (let ((main-length (ly:music-length main))
  66          (fraction  (ly:parser-lookup parser 'afterGraceFraction)))
  67      (make-simultaneous-music
  68       (list
  69        main
  70        (make-sequential-music
  71         (list
  72
  73          (make-music 'SkipMusic
  74                      'duration (ly:make-duration
  75                                 0 0
  76                                 (* (ly:moment-main-numerator main-length)
  77                                    (car fraction))
  78                                 (* (ly:moment-main-denominator main-length)
  79                                    (cdr fraction))))
  80          (make-music 'GraceMusic
  81                      'element grace)))))))
  82
  83
  84 %% music identifiers not allowed at top-level,
  85 %% so this is a music-function instead.
  86 allowPageTurn =
  87 #(define-music-function (location parser) ()
  88    (_i "Allow a page turn. May be used at toplevel (ie between scores or
  89 markups), or inside a score.")
  90    (make-music 'EventChord
  91                'page-marker #t
  92                'page-turn-permission 'allow
  93                'elements (list (make-music 'PageTurnEvent
  94                                            'break-permission 'allow))))
  95
  96 alterBroken =
  97 #(define-music-function (parser location property arg item)
  98   (symbol-list-or-symbol? list? symbol-list-or-music?)
  99   (_i "Override @var{property} for pieces of broken spanner @var{item}
 100 with values @var{arg}.  @var{item} may either be music in the form of
 101 a starting spanner event, or a symbol list in the form
 102 @samp{Context.Grob} or just @samp{Grob}.  Iff @var{item} is in the
 103 form of a spanner event, @var{property} may also have the form
 104 @samp{Grob.property} for specifying a directed tweak.")
 105   (if (ly:music? item)
 106       (if (eq? (ly:music-property item 'span-direction) START)
 107           #{ \tweak #property #(value-for-spanner-piece arg) #item #}
 108           (begin
 109             (ly:music-warning item (_ "not a spanner"))
 110             item))
 111       (let* ((p (check-grob-path item parser location
 112                                  #:default 'Bottom
 113                                  #:min 2
 114                                  #:max 2))
 115              (name (and p (second p)))
 116              (description
 117               (and name (assoc-get name all-grob-descriptions))))
 118         (if (and description
 119                  (member 'spanner-interface
 120                          (assoc-get 'interfaces
 121                                     (assoc-get 'meta description))))
 122             #{
 123               \override #item . #property =
 124               #(value-for-spanner-piece arg)
 125             #}
 126             (begin
 127               (ly:input-warning location (_ "not a spanner name, `~a'") name)
 128               (make-music 'Music))))))
 129
 130 appendToTag =
 131 #(define-music-function (parser location tag more music)
 132    (symbol? ly:music? ly:music?)
 133    (_i "Append @var{more} to the @code{elements} of all music
 134 expressions in @var{music} that are tagged with @var{tag}.")
 135    (music-map (lambda (m)
 136                 (if (memq tag (ly:music-property m 'tags))
 137                     (set! (ly:music-property m 'elements)
 138                           (append (ly:music-property m 'elements)
 139                                   (list more))))
 140                 m)
 141               music))
 142
 143 applyContext =
 144 #(define-music-function (parser location proc) (procedure?)
 145    (_i "Modify context properties with Scheme procedure @var{proc}.")
 146    (make-music 'ApplyContext
 147                'procedure proc))
 148
 149 applyMusic =
 150 #(define-music-function (parser location func music) (procedure? ly:music?)
 151    (_i"Apply procedure @var{func} to @var{music}.")
 152    (func music))
 153
 154 applyOutput =
 155 #(define-music-function (parser location ctx proc) (symbol? procedure?)
 156    (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
 157    (make-music 'ApplyOutputEvent
 158                'procedure proc
 159                'context-type ctx))
 160
 161 appoggiatura =
 162 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
 163    (_i "Create an appoggiatura from @var{music}"))
 164
 165 % for regression testing purposes.
 166 assertBeamQuant =
 167 #(define-music-function (parser location l r) (pair? pair?)
 168    (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
 169    (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
 170
 171 % for regression testing purposes.
 172 assertBeamSlope =
 173 #(define-music-function (parser location comp) (procedure?)
 174    (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
 175    (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
 176
 177 autochange =
 178 #(define-music-function (parser location music) (ly:music?)
 179    (_i "Make voices that switch between staves automatically")
 180    (make-autochange-music parser music))
 181
 182
 183
 184 balloonGrobText =
 185 #(define-music-function (parser location grob-name offset text)
 186    (symbol? number-pair? markup?)
 187    (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
 188  (use like @code{\\once})")
 189    (make-event-chord
 190     (list
 191      (make-music 'AnnotateOutputEvent
 192                  'symbol grob-name
 193                  'X-offset (car offset)
 194                  'Y-offset (cdr offset)
 195                  'text text))))
 196
 197 balloonText =
 198 #(define-event-function (parser location offset text) (number-pair? markup?)
 199    (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
 200    (make-music 'AnnotateOutputEvent
 201                'X-offset (car offset)
 202                'Y-offset (cdr offset)
 203                'text text))
 204
 205 bar =
 206 #(define-music-function (parser location type) (string?)
 207    (_i "Insert a bar line of type @var{type}")
 208    (context-spec-music
 209     (make-property-set 'whichBar type)
 210     'Timing))
 211
 212 barNumberCheck =
 213 #(define-music-function (parser location n) (integer?)
 214    (_i "Print a warning if the current bar number is not @var{n}.")
 215    (make-music 'ApplyContext
 216                'procedure
 217                (lambda (c)
 218                  (let ((cbn (ly:context-property c 'currentBarNumber)))
 219                    (if (and  (number? cbn) (not (= cbn n)))
 220                        (ly:input-warning location
 221                                          "Barcheck failed got ~a expect ~a"
 222                                          cbn n))))))
 223
 224 beamExceptions =
 225 #(define-scheme-function (parser location music) (ly:music?)
 226    (_i "Extract a value suitable for setting
 227 @code{Timing.beamExceptions} from the given pattern with explicit
 228 beams in @var{music}.  A bar check @code{|} has to be used between
 229 bars of patterns in order to reset the timing.")
 230    (extract-beam-exceptions music))
 231
 232 bendAfter =
 233 #(define-event-function (parser location delta) (real?)
 234    (_i "Create a fall or doit of pitch interval @var{delta}.")
 235    (make-music 'BendAfterEvent
 236                'delta-step delta))
 237
 238 bookOutputName =
 239 #(define-void-function (parser location newfilename) (string?)
 240    (_i "Direct output for the current book block to @var{newfilename}.")
 241    (set! (paper-variable parser #f 'output-filename) newfilename))
 242
 243 bookOutputSuffix =
 244 #(define-void-function (parser location newsuffix) (string?)
 245    (_i "Set the output filename suffix for the current book block to
 246 @var{newsuffix}.")
 247    (set! (paper-variable parser #f 'output-suffix) newsuffix))
 248
 249 %% \breathe is defined as a music function rather than an event identifier to
 250 %% ensure it gets useful input location information: as an event identifier,
 251 %% it would have to be wrapped in an EventChord to prevent it from being
 252 %% treated as a post_event by the parser
 253 breathe =
 254 #(define-music-function (parser location) ()
 255    (_i "Insert a breath mark.")
 256    (make-music 'BreathingEvent))
 257
 258 clef =
 259 #(define-music-function (parser location type) (string?)
 260    (_i "Set the current clef to @var{type}.")
 261    (make-clef-set type))
 262
 263
 264 compoundMeter =
 265 #(define-music-function (parser location args) (pair?)
 266   (_i "Create compound time signatures. The argument is a Scheme list of
 267 lists. Each list describes one fraction, with the last entry being the
 268 denominator, while the first entries describe the summands in the
 269 enumerator. If the time signature consists of just one fraction,
 270 the list can be given directly, i.e. not as a list containing a single list.
 271 For example, a time signature of (3+1)/8 + 2/4 would be created as
 272 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
 273 as @code{\\compoundMeter #'((3 2 8))} or shorter
 274 @code{\\compoundMeter #'(3 2 8)}.")
 275   (let* ((mlen (calculate-compound-measure-length args))
 276          (beat (calculate-compound-base-beat args))
 277          (beatGrouping (calculate-compound-beat-grouping args))
 278          (timesig (cons (ly:moment-main-numerator mlen)
 279                         (ly:moment-main-denominator mlen))))
 280   #{
 281     \once \override Timing.TimeSignature.stencil = #(lambda (grob)
 282       (grob-interpret-markup grob (make-compound-meter-markup args)))
 283     \set Timing.timeSignatureFraction = #timesig
 284     \set Timing.baseMoment = #beat
 285     \set Timing.beatStructure = #beatGrouping
 286     \set Timing.beamExceptions = #'()
 287     \set Timing.measureLength = #mlen
 288   #} ))
 289
 290 compressMMRests =
 291 #(define-music-function (parser location music) (ly:music?)
 292   (_i "Remove the empty bars created by multi-measure rests,
 293 leaving just the first bar containing the MM rest itself.")
 294    (music-map
 295     (lambda (m)
 296       (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
 297           #{ \once \set Score.skipBars = ##t #m #}
 298           #{ #m #} ))
 299     music))
 300
 301 crossStaff =
 302 #(define-music-function (parser location notes) (ly:music?)
 303   (_i "Create cross-staff stems")
 304   #{
 305   \temporary \override Stem.cross-staff = #cross-staff-connect
 306   \temporary \override Flag.style = #'no-flag
 307   #notes
 308   \revert Stem.cross-staff
 309   \revert Flag.style
 310 #})
 311
 312 cueClef =
 313 #(define-music-function (parser location type) (string?)
 314   (_i "Set the current cue clef to @var{type}.")
 315   (make-cue-clef-set type))
 316
 317 cueClefUnset =
 318 #(define-music-function (parser location) ()
 319   (_i "Unset the current cue clef.")
 320   (make-cue-clef-unset))
 321
 322 cueDuring =
 323 #(define-music-function
 324    (parser location what dir main-music) (string? ly:dir? ly:music?)
 325    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 326 in a CueVoice oriented by @var{dir}.")
 327    (make-music 'QuoteMusic
 328                'element main-music
 329                'quoted-context-type 'CueVoice
 330                'quoted-context-id "cue"
 331                'quoted-music-name what
 332                'quoted-voice-direction dir))
 333
 334 cueDuringWithClef =
 335 #(define-music-function
 336    (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
 337    (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
 338 in a CueVoice oriented by @var{dir}.")
 339    (make-music 'QuoteMusic
 340                'element main-music
 341                'quoted-context-type 'CueVoice
 342                'quoted-context-id "cue"
 343                'quoted-music-name what
 344                'quoted-music-clef clef
 345                'quoted-voice-direction dir))
 346
 347
 348
 349 displayLilyMusic =
 350 #(define-music-function (parser location port music) ((output-port?) ly:music?)
 351    (_i "Display the LilyPond input representation of @var{music}
 352 to @var{port}, defaulting to the console.")
 353    (let ((port (or port (current-output-port))))
 354      (newline port)
 355      (display-lily-music music parser port))
 356    music)
 357
 358 displayMusic =
 359 #(define-music-function (parser location port music) ((output-port?) ly:music?)
 360    (_i "Display the internal representation of @var{music} to
 361 @var{port}, default to the console.")
 362    (let ((port (or port (current-output-port))))
 363      (newline port)
 364      (display-scheme-music music port))
 365    music)
 366
 367 displayScheme =
 368 #(define-scheme-function (parser location port expr) ((output-port?) scheme?)
 369    (_i "Display the internal representation of @var{expr} to
 370 @var{port}, default to the console.")
 371    (let ((port (or port (current-output-port))))
 372      (newline port)
 373      (display-scheme-music expr port))
 374    expr)
 375
 376
 377
 378 endSpanners =
 379 #(define-music-function (parser location music) (ly:music?)
 380    (_i "Terminate the next spanner prematurely after exactly one note
 381 without the need of a specific end spanner.")
 382    (let* ((start-span-evs (filter (lambda (ev)
 383                                     (equal? (ly:music-property ev 'span-direction)
 384                                             START))
 385                                   (extract-typed-music music 'span-event)))
 386           (stop-span-evs
 387            (map (lambda (m)
 388                   (music-clone m 'span-direction STOP))
 389                 start-span-evs))
 390           (end-ev-chord (make-music 'EventChord
 391                                     'elements stop-span-evs))
 392           (total (make-music 'SequentialMusic
 393                              'elements (list music
 394                                              end-ev-chord))))
 395      total))
 396
 397 eventChords =
 398 #(define-music-function (parser location music) (ly:music?)
 399    (_i "Compatibility function wrapping @code{EventChord} around
 400 isolated rhythmic events occuring since version 2.15.28, after
 401 expanding repeat chords @samp{q}.")
 402    (event-chord-wrap! music parser))
 403
 404 featherDurations=
 405 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
 406    (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
 407    (let ((orig-duration (ly:music-length argument))
 408          (multiplier (ly:make-moment 1 1)))
 409
 410      (for-each
 411       (lambda (mus)
 412         (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
 413             (begin
 414               (ly:music-compress mus multiplier)
 415               (set! multiplier (ly:moment-mul factor multiplier)))))
 416       (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
 417      (ly:music-compress
 418       argument
 419       (ly:moment-div orig-duration (ly:music-length argument)))
 420
 421      argument))
 422
 423 finger =
 424 #(define-event-function (parser location finger) (number-or-markup?)
 425    (_i "Apply @var{finger} as a fingering indication.")
 426
 427    (make-music
 428             'FingeringEvent
 429             (if (number? finger) 'digit 'text)
 430             finger))
 431
 432 footnote =
 433 #(define-music-function (parser location mark offset footnote item)
 434    ((markup?) number-pair? markup? symbol-list-or-music?)
 435    (_i "Make the markup @var{footnote} a footnote on @var{item}.  The
 436 footnote is marked with a markup @var{mark} moved by @var{offset} with
 437 respect to the marked music.
 438
 439 If @var{mark} is not given or specified as @var{\\default}, it is
 440 replaced by an automatically generated sequence number.  If @var{item}
 441 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
 442 grobs of that type will be marked at the current time step in the
 443 given context (default @code{Bottom}).
 444
 445 If @var{item} is music, the music will get a footnote attached to a
 446 grob immediately attached to the event, like @var{\\tweak} does.  For
 447 attaching a footnote to an @emph{indirectly} caused grob, write
 448 @code{\\single\\footnote}, use @var{item} to specify the grob, and
 449 follow it with the music to annotate.
 450
 451 Like with @code{\\tweak}, if you use a footnote on a following
 452 post-event, the @code{\\footnote} command itself needs to be attached
 453 to the preceding note or rest as a post-event with @code{-}.")
 454    (let ((mus (make-music
 455                'FootnoteEvent
 456                'X-offset (car offset)
 457                'Y-offset (cdr offset)
 458                'automatically-numbered (not mark)
 459                'text (or mark (make-null-markup))
 460                'footnote-text footnote)))
 461      #{ \once \tweak footnote-music #mus #item #}))
 462
 463 grace =
 464 #(def-grace-function startGraceMusic stopGraceMusic
 465    (_i "Insert @var{music} as grace notes."))
 466
 467 grobdescriptions =
 468 #(define-scheme-function (parser location descriptions) (list?)
 469    (_i "Create a context modification from @var{descriptions}, a list
 470 in the format of @code{all-grob-descriptions}.")
 471    (ly:make-context-mod
 472     (map (lambda (p)
 473            (list 'assign (car p) (ly:make-grob-properties (cdr p))))
 474          descriptions)))
 475
 476 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
 477   (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 478 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
 479   #{
 480     \set harmonicDots = ##t
 481     \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
 482     \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
 483     \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 484                                             (ly:note-head::print grob))
 485     #(make-harmonic
 486        (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
 487     \unset harmonicDots
 488     \revert TabNoteHead.stencil
 489     \revert NoteHead.Y-extent
 490     \revert NoteHead.stencil
 491   #})
 492
 493 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
 494     (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
 495 harmonics played on a fretted instrument by touching the strings at the point
 496 given through @var{ratio}.")
 497   #{
 498     \set harmonicDots = ##t
 499     \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
 500     \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
 501                                        (lambda (grob start end)
 502                                                (ly:grob::stencil-height grob)))
 503     \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
 504                                             (ly:note-head::print grob))
 505     #(make-harmonic
 506       (calc-harmonic-pitch (ratio->pitch ratio) music))
 507     \unset harmonicDots
 508     \revert TabNoteHead.stencil
 509     \revert NoteHead.Y-extent
 510     \revert NoteHead.stencil
 511   #})
 512
 513 hide =
 514 #(define-music-function (parser location item) (symbol-list-or-music?)
 515    (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
 516 making it invisible while still retaining its dimensions.
 517
 518 If @var{item} is a symbol list of form @code{GrobName} or
 519 @code{Context.GrobName}, the result is an override for the grob name
 520 specified by it.  If @var{item} is a music expression, the result is
 521 the same music expression with an appropriate tweak applied to it.")
 522    #{ \tweak transparent ##t #item #})
 523
 524 inStaffSegno =
 525 #(define-music-function (parser location) ()
 526    (_i "Put the segno variant 'varsegno' at this position into the staff,
 527 compatible with the repeat command.")
 528    (make-music 'ApplyContext
 529                'procedure
 530                (lambda (ctx)
 531                  (let ((score-ctx (ly:context-find ctx 'Score)))
 532                    (if (ly:context? score-ctx)
 533                      (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
 534                        (if (eq? (memq 'segno-display old-rc) #f)
 535                          (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
 536
 537 instrumentSwitch =
 538 #(define-music-function
 539    (parser location name) (string?)
 540    (_i "Switch instrument to @var{name}, which must be predefined with
 541 @code{\\addInstrumentDefinition}.")
 542    (let* ((handle (assoc name instrument-definitions))
 543           (instrument-def (if handle (cdr handle) '())))
 544
 545      (if (not handle)
 546          (ly:input-warning location "No such instrument: ~a" name))
 547      (context-spec-music
 548       (make-music 'SimultaneousMusic
 549                   'elements
 550                   (map (lambda (kv)
 551                          (make-property-set
 552                           (car kv)
 553                           (cdr kv)))
 554                        instrument-def))
 555       'Staff)))
 556
 557
 558
 559 keepWithTag =
 560 #(define-music-function (parser location tags music)
 561    (symbol-list-or-symbol? ly:music?)
 562    (_i "Include only elements of @var{music} that are tagged with one
 563 of the tags in @var{tags}.  @var{tags} may be either a single symbol
 564 or a list of symbols.
 565
 566 Each tag may be declared as a member of at most one tag group (defined
 567 with @code{\\tagGroup}).  If none of a @var{music} element's tags
 568 share a tag group with one of the specified @var{tags}, the element is
 569 retained.")
 570    (music-filter
 571     (tags-keep-predicate tags)
 572     music))
 573
 574 key =
 575 #(define-music-function (parser location tonic pitch-alist)
 576    ((ly:pitch? '()) (list? '()))
 577    (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
 578 If both are null, just generate @code{KeyChangeEvent}.")
 579    (cond ((null? tonic) (make-music 'KeyChangeEvent))
 580          ((null? pitch-alist)
 581           (ly:parser-error parser (_ "second argument must be pitch list")
 582                            location)
 583           (make-music 'SequentialMusic 'void #t))
 584          (else
 585           (ly:music-transpose
 586            (make-music 'KeyChangeEvent
 587                 'tonic (ly:make-pitch 0 0 0)
 588                 'pitch-alist pitch-alist)
 589            tonic))))
 590
 591 killCues =
 592 #(define-music-function (parser location music) (ly:music?)
 593    (_i "Remove cue notes from @var{music}.")
 594    (music-map
 595     (lambda (mus)
 596       (if (and (string? (ly:music-property mus 'quoted-music-name))
 597                (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
 598           (ly:music-property mus 'element)
 599           mus))
 600     music))
 601
 602
 603
 604 label =
 605 #(define-music-function (parser location label) (symbol?)
 606    (_i "Create @var{label} as a bookmarking label.")
 607    (make-music 'EventChord
 608                'page-marker #t
 609                'page-label label
 610                'elements (list (make-music 'LabelEvent
 611                                            'page-label label))))
 612
 613
 614 language =
 615 #(define-void-function (parser location language) (string?)
 616    (_i "Set note names for language @var{language}.")
 617    (note-names-language parser language))
 618
 619 languageSaveAndChange =
 620 #(define-void-function (parser location language) (string?)
 621   (_i "Store the previous pitchnames alist, and set a new one.")
 622   (set! previous-pitchnames pitchnames)
 623   (note-names-language parser language))
 624
 625 languageRestore =
 626 #(define-void-function (parser location) ()
 627    (_i "Restore a previously-saved pitchnames alist.")
 628    (if previous-pitchnames
 629        (begin
 630         (set! pitchnames previous-pitchnames)
 631         (ly:parser-set-note-names parser pitchnames))
 632       (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
 633
 634
 635 magnifyMusic =
 636 #(define-music-function (parser location mag music) (positive? ly:music?)
 637    (_i "Magnify the notation of @var{music} without changing the
 638 staff-size, using @var{mag} as a size factor.  Stems, beams,
 639 slurs, ties, and horizontal spacing are adjusted automatically.")
 640
 641    ;; these props are NOT allowed to shrink below default size
 642    (define unshrinkable-props
 643      '(
 644        ;; stems
 645        (Stem thickness)
 646
 647        ;; slurs
 648        (Slur line-thickness)
 649        (Slur thickness)
 650        (PhrasingSlur line-thickness)
 651        (PhrasingSlur thickness)
 652
 653        ;; ties
 654        (Tie line-thickness)
 655        (Tie thickness)
 656        (LaissezVibrerTie line-thickness)
 657        (LaissezVibrerTie thickness)
 658        (RepeatTie line-thickness)
 659        (RepeatTie thickness)
 660        ))
 661
 662    ;; these props ARE allowed to shrink below default size
 663    (define shrinkable-props
 664      (let ((baseline-skip-props
 665              (find-named-props 'baseline-skip all-grob-descriptions))
 666            (word-space-props
 667              (find-named-props 'word-space all-grob-descriptions)))
 668        (append
 669          baseline-skip-props
 670          word-space-props
 671          '(
 672            ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
 673            ;; override at the 'Score level
 674            ;(SpacingSpanner spacing-increment)
 675
 676            ;; lengths and heights
 677            (Beam length-fraction)
 678            (Stem length-fraction)
 679            (Stem beamlet-default-length)
 680            (Stem double-stem-separation)
 681            (Slur height-limit)
 682            (Slur minimum-length)
 683            (PhrasingSlur height-limit)
 684            (PhrasingSlur minimum-length)
 685
 686            ;; Beam.beam-thickness is dealt with separately below
 687            ))))
 688    #{
 689      \context Bottom {
 690        %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
 691        %\newSpacingSection
 692        #(scale-fontSize 'magnifyMusic mag)
 693        #(scale-props    'magnifyMusic mag #f unshrinkable-props)
 694        #(scale-props    'magnifyMusic mag #t shrinkable-props)
 695        #(scale-beam-thickness mag)
 696
 697        #music
 698
 699        %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
 700        %\newSpacingSection
 701        %% reverse engineer the former fontSize value instead of using \unset
 702        #(revert-fontSize 'magnifyMusic mag)
 703        #(revert-props    'magnifyMusic mag (append unshrinkable-props
 704                                                    shrinkable-props
 705                                                    '((Beam beam-thickness))))
 706      }
 707    #})
 708
 709 magnifyStaff =
 710 #(define-music-function (parser location mag) (positive?)
 711    (_i "Change the size of the staff, adjusting notation size and
 712 horizontal spacing automatically, using @var{mag} as a size factor.")
 713
 714    ;; these props are NOT allowed to shrink below default size
 715    (define unshrinkable-props
 716      '((StaffSymbol thickness)))
 717
 718    ;; these props ARE allowed to shrink below default size
 719    (define shrinkable-props
 720      (let* ((baseline-skip-props
 721               (find-named-props 'baseline-skip all-grob-descriptions))
 722             (word-space-props
 723               (find-named-props 'word-space all-grob-descriptions))
 724             (space-alist-props
 725               (find-named-props 'space-alist all-grob-descriptions)))
 726        (append
 727          baseline-skip-props
 728          word-space-props
 729          space-alist-props
 730          '(
 731            ;; override at the 'Score level
 732            (SpacingSpanner spacing-increment)
 733
 734            (StaffSymbol staff-space)
 735            (BarLine kern)
 736            (BarLine segno-kern)
 737            (BarLine hair-thickness)
 738            (BarLine thick-thickness)
 739            (Stem beamlet-default-length)
 740            (Stem double-stem-separation)
 741            ))))
 742
 743    #{
 744      \stopStaff
 745
 746      %% revert settings from last time
 747      %% (but only if \magnifyStaff has already been used
 748      %% and the staff magnification is changing)
 749      #(revert-fontSize 'magnifyStaff mag)
 750      #(revert-props    'magnifyStaff mag (append unshrinkable-props
 751                                                  shrinkable-props))
 752
 753      %% scale settings
 754      %% (but only if staff magnification is changing
 755      %% and does not equal 1)
 756      #(scale-fontSize 'magnifyStaff mag)
 757      #(scale-props    'magnifyStaff mag #f unshrinkable-props)
 758      #(scale-props    'magnifyStaff mag #t shrinkable-props)
 759
 760      %% this might cause problems until Issue 3990 is fixed
 761      \newSpacingSection
 762
 763      \startStaff
 764      \set Staff.magnifyStaffValue = #mag
 765    #})
 766
 767 makeClusters =
 768 #(define-music-function (parser location arg) (ly:music?)
 769    (_i "Display chords in @var{arg} as clusters.")
 770    (music-map note-to-cluster arg))
 771
 772 modalInversion =
 773 #(define-music-function (parser location around to scale music)
 774     (ly:pitch? ly:pitch? ly:music? ly:music?)
 775     (_i "Invert @var{music} about @var{around} using @var{scale} and
 776 transpose from @var{around} to @var{to}.")
 777     (let ((inverter (make-modal-inverter around to scale)))
 778       (change-pitches music inverter)
 779       music))
 780
 781 modalTranspose =
 782 #(define-music-function (parser location from to scale music)
 783     (ly:pitch? ly:pitch? ly:music? ly:music?)
 784     (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
 785 using @var{scale}.")
 786     (let ((transposer (make-modal-transposer from to scale)))
 787       (change-pitches music transposer)
 788       music))
 789
 790 inversion =
 791 #(define-music-function
 792    (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
 793    (_i "Invert @var{music} about @var{around} and
 794 transpose from @var{around} to @var{to}.")
 795    (music-invert around to music))
 796
 797 mark =
 798 #(define-music-function
 799    (parser location label) ((scheme? '()))
 800   "Make the music for the \\mark command."
 801   (let* ((set (and (integer? label)
 802                    (context-spec-music (make-property-set 'rehearsalMark label)
 803                                       'Score)))
 804          (ev (make-music 'MarkEvent
 805                          'origin location)))
 806
 807     (if set
 808         (make-sequential-music (list set ev))
 809         (begin
 810           (set! (ly:music-property ev 'label) label)
 811           ev))))
 812
 813 musicMap =
 814 #(define-music-function (parser location proc mus) (procedure? ly:music?)
 815    (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
 816    (music-map proc mus))
 817
 818 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
 819 %% because music identifiers are not allowed at top-level.
 820 noPageBreak =
 821 #(define-music-function (location parser) ()
 822    (_i "Forbid a page break.  May be used at toplevel (i.e., between scores or
 823 markups), or inside a score.")
 824    (make-music 'EventChord
 825                'page-marker #t
 826                'page-break-permission 'forbid
 827                'elements (list (make-music 'PageBreakEvent
 828                                            'break-permission '()))))
 829
 830 noPageTurn =
 831 #(define-music-function (location parser) ()
 832    (_i "Forbid a page turn.  May be used at toplevel (i.e., between scores or
 833 markups), or inside a score.")
 834    (make-music 'EventChord
 835                'page-marker #t
 836                'page-turn-permission 'forbid
 837                'elements (list (make-music 'PageTurnEvent
 838                                            'break-permission '()))))
 839
 840
 841
 842 octaveCheck =
 843 #(define-music-function (parser location pitch) (ly:pitch?)
 844    (_i "Octave check.")
 845    (make-music 'RelativeOctaveCheck
 846                'pitch pitch))
 847
 848 offset =
 849 #(define-music-function (parser location property offsets item)
 850   (symbol-list-or-symbol? scheme? symbol-list-or-music?)
 851    (_i "Offset the default value of @var{property} of @var{item} by
 852 @var{offsets}.  If @var{item} is a string, the result is
 853 @code{\\override} for the specified grob type.  If @var{item} is
 854 a music expression, the result is the same music expression with an
 855 appropriate tweak applied.")
 856   (if (ly:music? item)
 857       ; In case of a tweak, grob property path is Grob.property
 858       (let ((prop-path (check-grob-path
 859                          (if (symbol? property)
 860                              (list property)
 861                              property)
 862                          parser location
 863                          #:start 1 #:default #t #:min 2 #:max 2)))
 864         (if prop-path
 865             ; If the head of the grob property path is a symbol--i.e.,
 866             ; a grob name, produce a directed tweak.  Otherwise, create
 867             ; an ordinary tweak.
 868             (if (symbol? (car prop-path))
 869                 #{
 870                   \tweak #prop-path #(offsetter (second prop-path) offsets) #item
 871                 #}
 872                 #{
 873                   \tweak #(second prop-path) #(offsetter (second prop-path) offsets) #item
 874                 #})
 875             item))
 876       ; In case of an override, grob property path is Context.Grob.property.
 877       (let ((prop-path (check-grob-path
 878                          (append item
 879                                  (if (symbol? property)
 880                                      (list property)
 881                                      property))
 882                          parser location
 883                          #:default 'Bottom #:min 3 #:max 3)))
 884         (if prop-path
 885             #{
 886               \override #prop-path = #(offsetter (third prop-path) offsets)
 887             #}
 888             (make-music 'Music)))))
 889
 890 omit =
 891 #(define-music-function (parser location item) (symbol-list-or-music?)
 892    (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
 893 effectively omitting it without taking up space.
 894
 895 If @var{item} is a symbol list of form @code{GrobName} or
 896 @code{Context.GrobName}, the result is an override for the grob name
 897 specified by it.  If @var{item} is a music expression, the result is
 898 the same music expression with an appropriate tweak applied to it.")
 899    #{ \tweak stencil ##f #item #})
 900
 901 once =
 902 #(define-music-function (parser location music) (ly:music?)
 903    (_i "Set @code{once} to @code{#t} on all layout instruction events
 904 in @var{music}.  This will complain about music with an actual
 905 duration.  As a special exception, if @var{music} contains
 906 @samp{tweaks} it will be silently ignored in order to allow for
 907 @code{\\once \\tweak} to work as both one-time override and proper
 908 tweak.")
 909    (if (not (pair? (ly:music-property music 'tweaks)))
 910        (for-some-music
 911         (lambda (m)
 912           (cond ((music-is-of-type? m 'layout-instruction-event)
 913                  (set! (ly:music-property m 'once) #t)
 914                  #t)
 915                 ((ly:duration? (ly:music-property m 'duration))
 916                  (ly:music-warning m (_ "Cannot apply \\once to timed music"))
 917                  #t)
 918                 (else #f)))
 919         music))
 920    music)
 921
 922 ottava =
 923 #(define-music-function (parser location octave) (integer?)
 924    (_i "Set the octavation.")
 925    (make-music 'OttavaMusic
 926                'ottava-number octave))
 927
 928 overrideTimeSignatureSettings =
 929 #(define-music-function
 930    (parser location time-signature base-moment beat-structure beam-exceptions)
 931    (fraction? fraction? list? list?)
 932
 933    (_i "Override @code{timeSignatureSettings}
 934 for time signatures of @var{time-signature} to have settings
 935 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
 936
 937    ;; TODO -- add warning if largest value of grouping is
 938    ;;       greater than time-signature.
 939   (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
 940     (override-time-signature-setting time-signature setting)))
 941
 942 overrideProperty =
 943 #(define-music-function (parser location grob-property-path value)
 944    (symbol-list? scheme?)
 945
 946    (_i "Set the grob property specified by @var{grob-property-path} to
 947 @var{value}.  @var{grob-property-path} is a symbol list of the form
 948 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
 949 with subproperties given as well.")
 950    (let ((p (check-grob-path grob-property-path parser location
 951                              #:default 'Bottom
 952                              #:min 3)))
 953      (if p
 954          (make-music 'ApplyOutputEvent
 955                      'context-type (first p)
 956                      'procedure
 957                      (lambda (grob orig-context context)
 958                        (if (equal?
 959                             (cdr (assoc 'name (ly:grob-property grob 'meta)))
 960                             (second p))
 961                            (ly:grob-set-nested-property!
 962                             grob (cddr p) value))))
 963          (make-music 'Music))))
 964
 965
 966
 967
 968
 969
 970 %% pageBreak and pageTurn are music functions (iso music indentifiers),
 971 %% because music identifiers are not allowed at top-level.
 972 pageBreak =
 973 #(define-music-function (location parser) ()
 974    (_i "Force a page break.  May be used at toplevel (i.e., between scores or
 975 markups), or inside a score.")
 976    (make-music 'EventChord
 977                'page-marker #t
 978                'line-break-permission 'force
 979                'page-break-permission 'force
 980                'elements (list (make-music 'LineBreakEvent
 981                                            'break-permission 'force)
 982                                (make-music 'PageBreakEvent
 983                                            'break-permission 'force))))
 984
 985 pageTurn =
 986 #(define-music-function (location parser) ()
 987    (_i "Force a page turn between two scores or top-level markups.")
 988    (make-music 'EventChord
 989                'page-marker #t
 990                'line-break-permission 'force
 991                'page-break-permission 'force
 992                'page-turn-permission 'force
 993                'elements (list (make-music 'LineBreakEvent
 994                                            'break-permission 'force)
 995                                (make-music 'PageBreakEvent
 996                                            'break-permission 'force)
 997                                (make-music 'PageTurnEvent
 998                                            'break-permission 'force))))
 999
1000 parallelMusic =
1001 #(define-void-function (parser location voice-ids music) (list? ly:music?)
1002    (_i "Define parallel music sequences, separated by '|' (bar check signs),
1003 and assign them to the identifiers provided in @var{voice-ids}.
1004
1005 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1006
1007 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1008
1009 Example:
1010
1011 @verbatim
1012   \\parallelMusic #'(A B C) {
1013     c c | d d | e e |
1014     d d | e e | f f |
1015   }
1016 <==>
1017   A = { c c | d d | }
1018   B = { d d | e e | }
1019   C = { e e | f f | }
1020 @end verbatim
1021 ")
1022    (define voice-count (length voice-ids))
1023    (define (bar-check? m)
1024      "Checks whether m is a bar check."
1025      (eq? (ly:music-property m 'name) 'BarCheck))
1026    (define (recurse-and-split-list lst)
1027      "Return either a list of music lists split along barchecks, or @code{#f}."
1028      (if (any bar-check? lst)
1029          (let* ((voices (apply circular-list (make-list voice-count '())))
1030                 (current-voices voices)
1031                 (current-sequence '()))
1032            ;;
1033            ;; utilities
1034            (define (push-music m)
1035              "Push the music expression into the current sequence"
1036              (set! current-sequence (cons m current-sequence)))
1037            (define (change-voice)
1038              "Store the previously built sequence into the current voice and
1039 change to the following voice."
1040              (set-car! current-voices
1041                        (cons (reverse! current-sequence)
1042                              (car current-voices)))
1043              (set! current-sequence '())
1044              (set! current-voices (cdr current-voices)))
1045            (for-each (lambda (m)
1046                        (let ((split? (recurse-and-split m)))
1047                          (if split?
1048                              (for-each
1049                               (lambda (m)
1050                                 (push-music m)
1051                                 (change-voice))
1052                               split?)
1053                              (begin
1054                                (push-music m)
1055                                (if (bar-check? m) (change-voice))))))
1056                      lst)
1057            (if (pair? current-sequence) (change-voice))
1058            ;; un-circularize `voices' and reorder the voices
1059            (set! voices (map reverse!
1060                              (list-head voices voice-count)))
1061            ;; check sequence length
1062            (apply for-each (lambda seqs
1063                              (define (seq-len seq)
1064                                (reduce ly:moment-add
1065                                        (ly:make-moment 0)
1066                                        (map ly:music-length seq)))
1067                              (let ((moment-reference (seq-len (car seqs))))
1068                                (for-each (lambda (seq)
1069                                            (if (not (equal? (seq-len seq)
1070                                                             moment-reference))
1071                                                (ly:music-warning
1072                                                 (if (pair? seq)
1073                                                     (last seq)
1074                                                     (caar seqs))
1075                                                 (_ "Bars in parallel music don't have the same length"))))
1076                                          seqs)))
1077                   voices)
1078            (map concatenate! voices))
1079          (let ((deeper (map recurse-and-split lst)))
1080            (and (any pair? deeper)
1081                 (apply zip (map
1082                             (lambda (m split)
1083                               (or split
1084                                   (ly:music-deep-copy (make-list voice-count m))))
1085                             lst deeper))))))
1086    (define (recurse-and-split music)
1087      "This returns either a list of music split along barchecks, or
1088 @code{#f}."
1089      (let* ((elt (ly:music-property music 'element))
1090             (elts (ly:music-property music 'elements))
1091             (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1092             (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1093        (and (or split-elt split-elts)
1094             (map
1095              (lambda (e es)
1096                (apply music-clone music
1097                       (append
1098                        ;; reassigning the origin of the parent only
1099                        ;; makes sense if the first expression in the
1100                        ;; result is from a distributed origin
1101                        (let ((origin
1102                               (if (ly:music? elt)
1103                                   (and (ly:music? e) (ly:music-property e 'origin #f))
1104                                   (and (pair? es) (ly:music-property (car es) 'origin #f)))))
1105                          (if origin (list 'origin origin) '()))
1106                        (if (ly:music? e) (list 'element e) '())
1107                        (if (pair? es) (list 'elements es) '()))))
1108              (or split-elt (circular-list #f))
1109              (or split-elts (circular-list #f))))))
1110    (let ((voices (recurse-and-split music)))
1111      (if voices
1112          ;;
1113          ;; bind voice identifiers to the voices
1114          (for-each (lambda (voice-id voice)
1115                      (ly:parser-define! parser voice-id voice))
1116                    voice-ids voices)
1117          (ly:music-warning music
1118                            (_ "ignoring parallel music without barchecks")))))
1119
1120 parenthesize =
1121 #(define-music-function (parser loc arg) (ly:music?)
1122    (_i "Tag @var{arg} to be parenthesized.")
1123
1124    (if (memq 'event-chord (ly:music-property arg 'types))
1125        ;; arg is an EventChord -> set the parenthesize property
1126        ;; on all child notes and rests
1127        (for-each
1128         (lambda (ev)
1129           (if (or (memq 'note-event (ly:music-property ev 'types))
1130                   (memq 'rest-event (ly:music-property ev 'types)))
1131               (set! (ly:music-property ev 'parenthesize) #t)))
1132         (ly:music-property arg 'elements))
1133        ;; No chord, simply set property for this expression:
1134        (set! (ly:music-property arg 'parenthesize) #t))
1135    arg)
1136
1137 #(define (make-directed-part-combine-music
1138           parser direction chord-range part1 part2
1139           one-context-settings
1140           two-context-settings
1141           shared-context-settings)
1142
1143    (let ((pc-music (make-part-combine-music
1144                      parser (list part1 part2) direction chord-range)))
1145      #{ \context Staff <<
1146           \context Voice = "one" \with #one-context-settings {}
1147           \context Voice = "two" \with #two-context-settings {}
1148           \context Voice = "shared" \with #shared-context-settings {}
1149           #pc-music
1150           #(make-part-combine-marks
1151             default-part-combine-mark-state-machine
1152             (ly:music-property pc-music 'split-list))
1153         >> #} ))
1154
1155 partcombine =
1156 #(define-music-function (parser location chord-range part1 part2)
1157    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1158    (_i "Take the music in @var{part1} and @var{part2} and return
1159 a music expression containing simultaneous voices, where @var{part1}
1160 and @var{part2} are combined into one voice where appropriate.
1161 Optional @var{chord-range} sets the distance in steps between notes
1162 that may be combined into a chord or unison.")
1163    (make-directed-part-combine-music parser #f chord-range part1 part2
1164     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1165     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1166     #{ #} ))
1167
1168 partcombineUp =
1169 #(define-music-function (parser location chord-range part1 part2)
1170    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1171    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1172 that they share a staff with stems directed upward.")
1173    (make-directed-part-combine-music parser UP chord-range part1 part2
1174     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1175     #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1176     #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1177
1178 partcombineDown =
1179 #(define-music-function (parser location chord-range part1 part2)
1180    ((number-pair? '(0 . 8)) ly:music? ly:music?)
1181    (_i "Take the music in @var{part1} and @var{part2} and typeset so
1182 that they share a staff with stems directed downward.")
1183    (make-directed-part-combine-music parser DOWN chord-range part1 part2
1184     #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1185     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1186     #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1187
1188 partcombineForce =
1189 #(define-music-function (location parser type once) (boolean-or-symbol? boolean?)
1190    (_i "Override the part-combiner.")
1191    (make-music 'EventChord
1192                'elements (list (make-music 'PartCombineForceEvent
1193                                            'forced-type type
1194                                            'once once))))
1195 partcombineApart = \partcombineForce #'apart ##f
1196 partcombineApartOnce = \partcombineForce #'apart ##t
1197 partcombineChords = \partcombineForce #'chords ##f
1198 partcombineChordsOnce = \partcombineForce #'chords ##t
1199 partcombineUnisono = \partcombineForce #'unisono ##f
1200 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1201 partcombineSoloI = \partcombineForce #'solo1 ##f
1202 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1203 partcombineSoloII = \partcombineForce #'solo2 ##f
1204 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1205 partcombineAutomatic = \partcombineForce ##f ##f
1206 partcombineAutomaticOnce = \partcombineForce ##f ##t
1207
1208 partial =
1209 #(define-music-function (parser location dur) (ly:duration?)
1210   (_i "Make a partial measure.")
1211
1212   ;; We use `descend-to-context' here instead of `context-spec-music' to
1213   ;; ensure \partial still works if the Timing_translator is moved
1214     (descend-to-context
1215      (context-spec-music (make-music 'PartialSet
1216                                      'origin location
1217                                      'duration dur)
1218                          'Timing)
1219      'Score))
1220
1221 pitchedTrill =
1222 #(define-music-function
1223    (parser location main-note secondary-note)
1224    (ly:music? ly:music?)
1225    (_i "Print a trill with @var{main-note} as the main note of the trill and
1226 print @var{secondary-note} as a stemless note head in parentheses.")
1227    (let* ((get-notes (lambda (ev-chord)
1228                        (extract-named-music ev-chord 'NoteEvent)))
1229           (sec-note-events (get-notes secondary-note))
1230           (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1231      (if (pair? sec-note-events)
1232          (begin
1233            (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1234                   (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1235
1236              (if (ly:pitch? trill-pitch)
1237                  (for-each (lambda (m)
1238                              (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1239                  (begin
1240                    (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
1241                    (display sec-note-events)))
1242
1243              (if (eq? forced #t)
1244                  (for-each (lambda (m)
1245                              (ly:music-set-property! m 'force-accidental forced))
1246                            trill-events)))))
1247      main-note))
1248
1249 pushToTag =
1250 #(define-music-function (parser location tag more music)
1251    (symbol? ly:music? ly:music?)
1252    (_i "Add @var{more} to the front of @code{elements} of all music
1253 expressions in @var{music} that are tagged with @var{tag}.")
1254    (music-map (lambda (m)
1255                 (if (memq tag (ly:music-property m 'tags))
1256                     (set! (ly:music-property m 'elements)
1257                           (cons more (ly:music-property m 'elements))))
1258                 m)
1259               music))
1260
1261 quoteDuring =
1262 #(define-music-function (parser location what main-music) (string? ly:music?)
1263    (_i "Indicate a section of music to be quoted.  @var{what} indicates the name
1264 of the quoted voice, as specified in an @code{\\addQuote} command.
1265 @var{main-music} is used to indicate the length of music to be quoted;
1266 usually contains spacers or multi-measure rests.")
1267    (make-music 'QuoteMusic
1268                'element main-music
1269                'quoted-music-name what))
1270
1271 relative =
1272 #(define-music-function (parser location pitch music)
1273    ((ly:pitch?) ly:music?)
1274    (_i "Make @var{music} relative to @var{pitch}.  If @var{pitch} is
1275 omitted, the first note in @var{music} is given in absolute pitch.")
1276    ;; When \relative has no clear decision (can only happen with
1277    ;; scales with an even number of steps), it goes down (see
1278    ;; pitch.cc).  The following formula puts out f for both the normal
1279    ;; 7-step scale as well as for a "shortened" scale missing the
1280    ;; final b.  In either case, a first note of c will end up as c,
1281    ;; namely pitch (-1, 0, 0).
1282    (ly:make-music-relative! music
1283                             (or pitch
1284                                 (ly:make-pitch
1285                                  -1
1286                                  (quotient
1287                                   ;; size of current scale:
1288                                   (ly:pitch-steps (ly:make-pitch 1 0))
1289                                   2))))
1290    (make-music 'RelativeOctaveMusic
1291                'element music))
1292
1293 removeWithTag =
1294 #(define-music-function (parser location tags music)
1295    (symbol-list-or-symbol? ly:music?)
1296    (_i "Remove elements of @var{music} that are tagged with one of the
1297 tags in @var{tags}.  @var{tags} may be either a single symbol or a list
1298 of symbols.")
1299    (music-filter
1300     (tags-remove-predicate tags)
1301     music))
1302
1303 resetRelativeOctave =
1304 #(define-music-function (parser location pitch) (ly:pitch?)
1305    (_i "Set the octave inside a \\relative section.")
1306
1307    (make-music 'SequentialMusic
1308                'to-relative-callback
1309                (lambda (music last-pitch) pitch)))
1310
1311 retrograde =
1312 #(define-music-function (parser location music)
1313     (ly:music?)
1314     (_i "Return @var{music} in reverse order.")
1315     (retrograde-music music))
1316
1317 revertTimeSignatureSettings =
1318 #(define-music-function
1319    (parser location time-signature)
1320    (pair?)
1321
1322    (_i "Revert @code{timeSignatureSettings}
1323 for time signatures of @var{time-signature}.")
1324    (revert-time-signature-setting time-signature))
1325
1326 rightHandFinger =
1327 #(define-event-function (parser location finger) (number-or-markup?)
1328    (_i "Apply @var{finger} as a fingering indication.")
1329
1330    (make-music
1331             'StrokeFingerEvent
1332             (if (number? finger) 'digit 'text)
1333             finger))
1334
1335 scaleDurations =
1336 #(define-music-function (parser location fraction music)
1337    (fraction? ly:music?)
1338    (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1339    (ly:music-compress music
1340                       (ly:make-moment (car fraction) (cdr fraction))))
1341
1342 settingsFrom =
1343 #(define-scheme-function (parser location ctx music)
1344    ((symbol?) ly:music?)
1345    (_i "Take the layout instruction events from @var{music}, optionally
1346 restricted to those applying to context type @var{ctx}, and return
1347 a context modification duplicating their effect.")
1348    (let ((mods (ly:make-context-mod)))
1349      (define (musicop m)
1350        (if (music-is-of-type? m 'layout-instruction-event)
1351            (ly:add-context-mod
1352             mods
1353             (case (ly:music-property m 'name)
1354               ((PropertySet)
1355                (list 'assign
1356                      (ly:music-property m 'symbol)
1357                      (ly:music-property m 'value)))
1358               ((PropertyUnset)
1359                (list 'unset
1360                      (ly:music-property m 'symbol)))
1361               ((OverrideProperty)
1362                (cons* 'push
1363                       (ly:music-property m 'symbol)
1364                       (ly:music-property m 'grob-value)
1365                       (cond
1366                        ((ly:music-property m 'grob-property #f) => list)
1367                        (else
1368                         (ly:music-property m 'grob-property-path)))))
1369               ((RevertProperty)
1370                (cons* 'pop
1371                       (ly:music-property m 'symbol)
1372                       (cond
1373                        ((ly:music-property m 'grob-property #f) => list)
1374                        (else
1375                         (ly:music-property m 'grob-property-path)))))))
1376            (case (ly:music-property m 'name)
1377              ((ApplyContext)
1378               (ly:add-context-mod mods
1379                                   (list 'apply
1380                                         (ly:music-property m 'procedure))))
1381              ((ContextSpeccedMusic)
1382               (if (or (not ctx)
1383                       (eq? ctx (ly:music-property m 'context-type)))
1384                   (musicop (ly:music-property m 'element))))
1385              (else
1386               (let ((callback (ly:music-property m 'elements-callback)))
1387                 (if (procedure? callback)
1388                     (for-each musicop (callback m))))))))
1389      (musicop music)
1390      mods))
1391
1392 shape =
1393 #(define-music-function (parser location offsets item)
1394    (list? symbol-list-or-music?)
1395    (_i "Offset control-points of @var{item} by @var{offsets}.  The
1396 argument is a list of number pairs or list of such lists.  Each
1397 element of a pair represents an offset to one of the coordinates of a
1398 control-point.  If @var{item} is a string, the result is
1399 @code{\\once\\override} for the specified grob type.  If @var{item} is
1400 a music expression, the result is the same music expression with an
1401 appropriate tweak applied.")
1402    (define (shape-curve grob)
1403      (let* ((orig (ly:grob-original grob))
1404             (siblings (if (ly:spanner? grob)
1405                           (ly:spanner-broken-into orig) '()))
1406             (total-found (length siblings))
1407             (function (assoc-get 'control-points
1408                                  (reverse (ly:grob-basic-properties grob))))
1409             (coords (function grob)))
1410
1411        (define (offset-control-points offsets)
1412          (if (null? offsets)
1413              coords
1414              (map
1415                (lambda (x y) (coord-translate x y))
1416                coords offsets)))
1417
1418        (define (helper sibs offs)
1419          (if (pair? offs)
1420              (if (eq? (car sibs) grob)
1421                  (offset-control-points (car offs))
1422                  (helper (cdr sibs) (cdr offs)))
1423              coords))
1424
1425        ;; we work with lists of lists
1426        (if (or (null? offsets)
1427                (not (list? (car offsets))))
1428            (set! offsets (list offsets)))
1429
1430        (if (>= total-found 2)
1431            (helper siblings offsets)
1432            (offset-control-points (car offsets)))))
1433    #{ \once \tweak control-points #shape-curve #item #})
1434
1435 shiftDurations =
1436 #(define-music-function (parser location dur dots arg)
1437    (integer? integer? ly:music?)
1438    (_i "Change the duration of @var{arg} by adding @var{dur} to the
1439 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1440
1441    (shift-duration-log arg dur dots))
1442
1443 single =
1444 #(define-music-function (parser location overrides music)
1445    (ly:music? ly:music?)
1446    (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1447 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1448    (set! (ly:music-property music 'tweaks)
1449          (fold-some-music
1450           (lambda (m) (eq? (ly:music-property m 'name)
1451                            'OverrideProperty))
1452           (lambda (m tweaks)
1453             (let ((p (cond
1454                       ((ly:music-property m 'grob-property #f) => list)
1455                       (else
1456                        (ly:music-property m 'grob-property-path)))))
1457               (acons (cons (ly:music-property m 'symbol) ;grob name
1458                            (if (pair? (cdr p))
1459                                p ;grob property path
1460                                (car p))) ;grob property
1461                      (ly:music-property m 'grob-value)
1462                      tweaks)))
1463           (ly:music-property music 'tweaks)
1464           overrides))
1465    music)
1466
1467 skip =
1468 #(define-music-function (parser location dur) (ly:duration?)
1469   (_i "Skip forward by @var{dur}.")
1470   (make-music 'SkipMusic
1471               'duration dur))
1472
1473
1474 slashedGrace =
1475 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1476    (_i "Create slashed graces (slashes through stems, but no slur) from
1477 the following music expression"))
1478
1479 spacingTweaks =
1480 #(define-music-function (parser location parameters) (list?)
1481    (_i "Set the system stretch, by reading the 'system-stretch property of
1482 the `parameters' assoc list.")
1483    #{
1484      \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1485      #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1486              (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1487    #})
1488
1489 styledNoteHeads =
1490 #(define-music-function (parser location style heads music)
1491    (symbol? symbol-list-or-symbol? ly:music?)
1492    (_i "Set @var{heads} in @var{music} to @var{style}.")
1493    (style-note-heads heads style music))
1494
1495 tag =
1496 #(define-music-function (parser location tags music) (symbol-list-or-symbol? ly:music?)
1497    (_i "Tag the following @var{music} with @var{tags} and return the
1498 result, by adding the single symbol or symbol list @var{tags} to the
1499 @code{tags} property of @var{music}.")
1500
1501    (set!
1502     (ly:music-property music 'tags)
1503     ((if (symbol? tags) cons append)
1504      tags
1505      (ly:music-property music 'tags)))
1506    music)
1507
1508 tagGroup =
1509 #(define-void-function (parser location tags) (symbol-list?)
1510    (_i "Define a tag group comprising the symbols in the symbol list
1511 @var{tags}.  Tag groups must not overlap.")
1512    (let ((err (define-tag-group tags)))
1513      (if err (ly:parser-error parser err location))))
1514
1515 temporary =
1516 #(define-music-function (parser location music)
1517    (ly:music?)
1518    (_i "Make any @code{\\override} in @var{music} replace an existing
1519 grob property value only temporarily, restoring the old value when a
1520 corresponding @code{\\revert} is executed.  This is achieved by
1521 clearing the @samp{pop-first} property normally set on
1522 @code{\\override}s.
1523
1524 An @code{\\override}/@/@code{\\revert} sequence created by using
1525 @code{\\temporary} and @code{\\undo} on the same music containing
1526 overrides will cancel out perfectly or cause a@tie{}warning.
1527
1528 Non-property-related music is ignored, warnings are generated for any
1529 property-changing music that isn't an @code{\\override}.")
1530    (define warned #f)
1531    (for-some-music
1532     (lambda (m)
1533       (and (or (music-is-of-type? m 'layout-instruction-event)
1534                (music-is-of-type? m 'context-specification)
1535                (music-is-of-type? m 'apply-context)
1536                (music-is-of-type? m 'time-signature-music))
1537            (case (ly:music-property m 'name)
1538              ((OverrideProperty)
1539               (if (ly:music-property m 'pop-first #f)
1540                   (set! (ly:music-property m 'pop-first) '()))
1541               (if (ly:music-property m 'once #f)
1542                   (set! (ly:music-property m 'once) '()))
1543               #t)
1544              ((ContextSpeccedMusic)
1545               #f)
1546              (else
1547               (if (not warned)
1548                   (begin
1549                     (ly:input-warning location (_ "Cannot make ~a revertible")
1550                                       (ly:music-property m 'name))
1551                     (set! warned #t)))
1552               #t))))
1553     music)
1554    music)
1555
1556 time =
1557 #(define-music-function (parser location beat-structure fraction)
1558    ((number-list? '()) fraction?)
1559    (_i "Set @var{fraction} as time signature, with optional
1560 number list @var{beat-structure} before it.")
1561   (make-music 'TimeSignatureMusic
1562               'numerator (car fraction)
1563               'denominator (cdr fraction)
1564               'beat-structure beat-structure))
1565
1566 times =
1567 #(define-music-function (parser location fraction music)
1568    (fraction? ly:music?)
1569    (_i "Scale @var{music} in time by @var{fraction}.")
1570   (make-music 'TimeScaledMusic
1571               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1572               'numerator (car fraction)
1573               'denominator (cdr fraction)))
1574
1575 transpose =
1576 #(define-music-function
1577    (parser location from to music)
1578    (ly:pitch? ly:pitch? ly:music?)
1579
1580    (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1581    (make-music 'TransposedMusic
1582                'element (ly:music-transpose music (ly:pitch-diff to from))))
1583
1584 transposedCueDuring =
1585 #(define-music-function
1586    (parser location what dir pitch main-music)
1587    (string? ly:dir? ly:pitch? ly:music?)
1588
1589    (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1590 using the transposition defined by @var{pitch}.  This happens
1591 simultaneously with @var{main-music}, which is usually a rest.  The
1592 argument @var{dir} determines whether the cue notes should be notated
1593 as a first or second voice.")
1594
1595    (make-music 'QuoteMusic
1596                'element main-music
1597                'quoted-context-type 'CueVoice
1598                'quoted-context-id "cue"
1599                'quoted-music-name what
1600                'quoted-voice-direction dir
1601                ;; following is inverse of instrumentTransposition for
1602                ;; historical reasons
1603                'quoted-transposition pitch))
1604
1605 transposition =
1606 #(define-music-function (parser location pitch) (ly:pitch?)
1607    (_i "Set instrument transposition")
1608
1609    (context-spec-music
1610     (make-property-set 'instrumentTransposition pitch)
1611     'Staff))
1612
1613 tuplet =
1614 #(define-music-function (parser location ratio tuplet-span music)
1615    (fraction? (ly:duration? '()) ly:music?)
1616    (_i "Scale the given @var{music} to tuplets.  @var{ratio} is a
1617 fraction that specifies how many notes are played in place of the
1618 nominal value: it will be @samp{3/2} for triplets, namely three notes
1619 being played in place of two.  If the optional duration
1620 @var{tuplet-span} is specified, it is used instead of
1621 @code{tupletSpannerDuration} for grouping the tuplets.
1622 For example,
1623 @example
1624 \\tuplet 3/2 4 @{ c8 c c c c c @}
1625 @end example
1626 will result in two groups of three tuplets, each group lasting for a
1627 quarter note.")
1628    (make-music 'TimeScaledMusic
1629                'element (ly:music-compress
1630                          music
1631                          (ly:make-moment (cdr ratio) (car ratio)))
1632                'numerator (cdr ratio)
1633                'denominator (car ratio)
1634                'duration tuplet-span))
1635
1636 tupletSpan =
1637 #(define-music-function (parser location tuplet-span)
1638    ((ly:duration?))
1639    (_i "Set @code{tupletSpannerDuration}, the length into which
1640 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1641 own will group its tuplets, to the duration @var{tuplet-span}.  To
1642 revert to the default of not subdividing the contents of a @code{\\tuplet}
1643 command without explicit @samp{tuplet-span}, use
1644 @example
1645 \\tupletSpan \\default
1646 @end example
1647 ")
1648    (if tuplet-span
1649        #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1650        #{ \unset tupletSpannerDuration #}))
1651
1652 tweak =
1653 #(define-music-function (parser location prop value item)
1654    (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1655    (_i "Add a tweak to the following @var{item}, usually music.
1656 Layout objects created by @var{item} get their property @var{prop}
1657 set to @var{value}.  If @var{prop} has the form @samp{Grob.property}, like with
1658 @example
1659 \\tweak Accidental.color #red cis'
1660 @end example
1661 an indirectly created grob (@samp{Accidental} is caused by
1662 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1663 are affected.
1664
1665 As a special case, @var{item} may be a symbol list specifying a grob
1666 path, in which case @code{\\override} is called on it instead of
1667 creating tweaked music.  This is mainly useful when using
1668 @code{\\tweak} as as a component for building other functions.
1669
1670 If this use case would call for @code{\\once \\override} rather than a
1671 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1672 convenient.
1673
1674 @var{prop} can contain additional elements in which case a nested
1675 property (inside of an alist) is tweaked.")
1676    (if (ly:music? item)
1677        (let ((p (check-grob-path prop parser location
1678                                  #:start 1
1679                                  #:default #t
1680                                  #:min 2)))
1681          (if p
1682              (set! (ly:music-property item 'tweaks)
1683                    (acons (cond ((pair? (cddr p)) p)
1684                                 ((symbol? (car p))
1685                                  (cons (car p) (cadr p)))
1686                                 (else (cadr p)))
1687                           value
1688                           (ly:music-property item 'tweaks))))
1689          item)
1690        ;; We could just throw this at \override and let it sort this
1691        ;; out on its own, but this way we should get better error
1692        ;; diagnostics.
1693        (let ((p (check-grob-path
1694                  (append item (if (symbol? prop) (list prop) prop))
1695                  parser location
1696                  #:default 'Bottom #:min 3)))
1697          (if p
1698              #{ \override #p = #value #}
1699              (make-music 'Music)))))
1700
1701 undo =
1702 #(define-music-function (parser location music)
1703    (ly:music?)
1704    (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1705 @code{\\revert} and @code{\\unset}, respectively.  Any reverts and
1706 unsets already in @var{music} cause a warning.  Non-property-related music is ignored.")
1707    (define warned #f)
1708    (let loop
1709        ((music music))
1710      (let
1711          ((lst
1712            (fold-some-music
1713             (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1714                             (music-is-of-type? m 'context-specification)
1715                             (music-is-of-type? m 'apply-context)
1716                             (music-is-of-type? m 'time-signature-music)))
1717             (lambda (m overrides)
1718               (case (ly:music-property m 'name)
1719                 ((OverrideProperty)
1720                  (cons
1721                   (make-music 'RevertProperty
1722                               'symbol (ly:music-property m 'symbol)
1723                               'grob-property-path
1724                               (cond
1725                                ((ly:music-property m 'grob-property #f) => list)
1726                                (else
1727                                 (ly:music-property m 'grob-property-path))))
1728                   overrides))
1729                 ((PropertySet)
1730                  (cons
1731                   (make-music 'PropertyUnset
1732                               'symbol (ly:music-property m 'symbol))
1733                   overrides))
1734                 ((ContextSpeccedMusic)
1735                  (cons
1736                   (make-music 'ContextSpeccedMusic
1737                               'element (loop (ly:music-property m 'element))
1738                               'context-type (ly:music-property m 'context-type))
1739                   overrides))
1740                 (else
1741                  (if (not warned)
1742                      (begin
1743                        (ly:input-warning location (_ "Cannot revert ~a")
1744                                          (ly:music-property m 'name))
1745                        (set! warned #t)))
1746                  overrides)))
1747             '()
1748             music)))
1749        (cond
1750         ((null? lst) (make-music 'Music))
1751         ((null? (cdr lst)) (car lst))
1752         (else (make-sequential-music lst))))))
1753
1754 unfoldRepeats =
1755 #(define-music-function (parser location music) (ly:music?)
1756    (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1757 @code{\\repeat percent} commands in @var{music} to be interpreted
1758 as @code{\\repeat unfold}.")
1759    (unfold-repeats music))
1760
1761 void =
1762 #(define-void-function (parser location arg) (scheme?)
1763    (_i "Accept a scheme argument, return a void expression.
1764 Use this if you want to have a scheme expression evaluated
1765 because of its side-effects, but its value ignored."))
1766
1767 withMusicProperty =
1768 #(define-music-function (parser location sym val music)
1769    (symbol? scheme? ly:music?)
1770    (_i "Set @var{sym} to @var{val} in @var{music}.")
1771
1772    (set! (ly:music-property music sym) val)
1773    music)