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