1 %%%% -*- Mode: Scheme -*-
3 %%%% This file is part of LilyPond, the GNU music typesetter.
5 %%%% Copyright (C) 2003--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 %%%% Jan Nieuwenhuizen <janneke@gnu.org>
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.
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.
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/>.
24 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25 %% this file is alphabetically sorted.
26 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28 %% need SRFI-1 for filter; optargs for lambda*
29 #(use-modules (srfi srfi-1)
32 %% TODO: using define-music-function in a .scm causes crash.
35 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
36 (_i "Create an acciaccatura from the following music expression"))
38 %% keep these two together
39 "instrument-definitions" = #'()
40 addInstrumentDefinition =
41 #(define-void-function
42 (parser location name lst) (string? list?)
43 (_i "Create instrument @var{name} with properties @var{list}.")
44 (set! instrument-definitions (acons name lst instrument-definitions)))
47 #(define-void-function (parser location name music) (string? ly:music?)
48 (_i "Define @var{music} as a quotable music expression named
50 (add-quotable parser name music))
52 %% keep these two together
53 afterGraceFraction = #(cons 6 8)
55 #(define-music-function (parser location main grace) (ly:music? ly:music?)
56 (_i "Create @var{grace} note(s) after a @var{main} music expression.")
57 (let ((main-length (ly:music-length main))
58 (fraction (ly:parser-lookup parser 'afterGraceFraction)))
59 (make-simultaneous-music
62 (make-sequential-music
65 (make-music 'SkipMusic
66 'duration (ly:make-duration
68 (* (ly:moment-main-numerator main-length)
70 (* (ly:moment-main-denominator main-length)
72 (make-music 'GraceMusic
76 %% music identifiers not allowed at top-level,
77 %% so this is a music-function instead.
79 #(define-music-function (location parser) ()
80 (_i "Allow a page turn. May be used at toplevel (ie between scores or
81 markups), or inside a score.")
82 (make-music 'EventChord
84 'page-turn-permission 'allow
85 'elements (list (make-music 'PageTurnEvent
86 'break-permission 'allow))))
89 #(define-music-function (parser location tag more music)
90 (symbol? ly:music? ly:music?)
91 (_i "Append @var{more} to the @code{elements} of all music
92 expressions in @var{music} that are tagged with @var{tag}.")
93 (music-map (lambda (m)
94 (if (memq tag (ly:music-property m 'tags))
95 (set! (ly:music-property m 'elements)
96 (append (ly:music-property m 'elements)
102 #(define-music-function (parser location proc) (procedure?)
103 (_i "Modify context properties with Scheme procedure @var{proc}.")
104 (make-music 'ApplyContext
108 #(define-music-function (parser location func music) (procedure? ly:music?)
109 (_i"Apply procedure @var{func} to @var{music}.")
113 #(define-music-function (parser location ctx proc) (symbol? procedure?)
114 (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
115 (make-music 'ApplyOutputEvent
120 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
121 (_i "Create an appoggiatura from @var{music}"))
123 % for regression testing purposes.
125 #(define-music-function (parser location l r) (pair? pair?)
126 (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
127 (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
129 % for regression testing purposes.
131 #(define-music-function (parser location comp) (procedure?)
132 (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
133 (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
136 #(define-music-function (parser location music) (ly:music?)
137 (_i "Make voices that switch between staves automatically")
138 (make-autochange-music parser music))
143 #(define-music-function (parser location grob-name offset text)
144 (symbol? number-pair? markup?)
145 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
146 (use like @code{\\once})")
147 (make-music 'AnnotateOutputEvent
149 'X-offset (car offset)
150 'Y-offset (cdr offset)
154 #(define-music-function (parser location offset text) (number-pair? markup?)
155 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
156 (make-music 'AnnotateOutputEvent
157 'X-offset (car offset)
158 'Y-offset (cdr offset)
162 #(define-music-function (parser location type) (string?)
163 (_i "Insert a bar line of type @var{type}")
165 (make-property-set 'whichBar type)
169 #(define-music-function (parser location n) (integer?)
170 (_i "Print a warning if the current bar number is not @var{n}.")
171 (make-music 'ApplyContext
174 (let ((cbn (ly:context-property c 'currentBarNumber)))
175 (if (and (number? cbn) (not (= cbn n)))
176 (ly:input-warning location
177 "Barcheck failed got ~a expect ~a"
181 #(define-music-function (parser location delta) (real?)
182 (_i "Create a fall or doit of pitch interval @var{delta}.")
183 (make-music 'BendAfterEvent
187 #(define-void-function (parser location newfilename) (string?)
188 (_i "Direct output for the current book block to @var{newfilename}.")
189 (set! book-filename newfilename))
192 #(define-void-function (parser location newsuffix) (string?)
193 (_i "Set the output filename suffix for the current book block to
195 (set! book-output-suffix newsuffix))
197 %% \breathe is defined as a music function rather than an event identifier to
198 %% ensure it gets useful input location information: as an event identifier,
199 %% it would have to be wrapped in an EventChord to prevent it from being
200 %% treated as a post_event by the parser
202 #(define-music-function (parser location) ()
203 (_i "Insert a breath mark.")
204 (make-music 'BreathingEvent))
207 #(define-music-function (parser location type) (string?)
208 (_i "Set the current clef to @var{type}.")
209 (make-clef-set type))
213 #(define-music-function (parser location args) (pair?)
214 (_i "Create compound time signatures. The argument is a Scheme list of
215 lists. Each list describes one fraction, with the last entry being the
216 denominator, while the first entries describe the summands in the
217 enumerator. If the time signature consists of just one fraction,
218 the list can be given directly, i.e. not as a list containing a single list.
219 For example, a time signature of (3+1)/8 + 2/4 would be created as
220 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
221 as @code{\\compoundMeter #'((3 2 8))} or shorter
222 @code{\\compoundMeter #'(3 2 8)}.")
223 (let* ((mlen (calculate-compound-measure-length args))
224 (beat (calculate-compound-base-beat args))
225 (beatGrouping (calculate-compound-beat-grouping args))
226 (timesig (cons (ly:moment-main-numerator mlen)
227 (ly:moment-main-denominator mlen))))
229 \once \override Staff.TimeSignature #'stencil = #(lambda (grob)
230 (grob-interpret-markup grob (format-compound-time $args)))
231 \set Timing.timeSignatureFraction = $timesig
232 \set Timing.baseMoment = $beat
233 \set Timing.beatStructure = $beatGrouping
234 \set Timing.beamExceptions = #'()
235 \set Timing.measureLength = $mlen
240 #(define-music-function (parser location type) (string?)
241 (_i "Set the current cue clef to @var{type}.")
242 (make-cue-clef-set type))
244 #(define-music-function (parser location) ()
245 (_i "Unset the current cue clef.")
246 (make-cue-clef-unset))
249 #(define-music-function
250 (parser location what dir main-music) (string? ly:dir? ly:music?)
251 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
252 in a CueVoice oriented by @var{dir}.")
253 (make-music 'QuoteMusic
255 'quoted-context-type 'Voice
256 'quoted-context-id "cue"
257 'quoted-music-name what
258 'quoted-voice-direction dir))
261 #(define-music-function
262 (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
263 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
264 in a CueVoice oriented by @var{dir}.")
265 (make-music 'QuoteMusic
267 'quoted-context-type 'Voice
268 'quoted-context-id "cue"
269 'quoted-music-name what
270 'quoted-music-clef clef
271 'quoted-voice-direction dir))
276 #(define-music-function (parser location music) (ly:music?)
277 (_i "Display the LilyPond input representation of @var{music}
280 (display-lily-music music parser)
284 #(define-music-function (parser location music) (ly:music?)
285 (_i "Display the internal representation of @var{music} to the console.")
287 (display-scheme-music music)
293 #(define-music-function (parser location music) (ly:music?)
294 (_i "Terminate the next spanner prematurely after exactly one note
295 without the need of a specific end spanner.")
296 (if (eq? (ly:music-property music 'name) 'EventChord)
297 (let* ((elts (ly:music-property music 'elements))
298 (start-span-evs (filter (lambda (ev)
299 (and (music-has-type ev 'span-event)
300 (equal? (ly:music-property ev 'span-direction)
305 (let ((c (music-clone m)))
306 (set! (ly:music-property c 'span-direction) STOP)
309 (end-ev-chord (make-music 'EventChord
310 'elements stop-span-evs))
311 (total (make-music 'SequentialMusic
312 'elements (list music
317 (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a" music))
323 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
324 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
325 (let ((orig-duration (ly:music-length argument))
326 (multiplier (ly:make-moment 1 1)))
330 (if (and (eq? (ly:music-property mus 'name) 'EventChord)
331 (< 0 (ly:moment-main-denominator (ly:music-length mus))))
333 (ly:music-compress mus multiplier)
334 (set! multiplier (ly:moment-mul factor multiplier))))
340 (ly:moment-div orig-duration (ly:music-length argument)))
345 #(define-music-function (parser location grob-name offset text footnote)
346 (symbol? number-pair? markup? markup?)
347 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset},
348 with @var{text} referring to @var{footnote} (use like @code{\\once})")
349 (make-music 'FootnoteEvent
350 'automatically-numbered #f
352 'X-offset (car offset)
353 'Y-offset (cdr offset)
355 'footnote-text footnote))
358 #(define-music-function (parser location grob-name offset footnote)
359 (symbol? number-pair? markup?)
360 (_i "Footnote @var{grob-name} with the text in @var{footnote}
361 allowing for the footnote to be automatically numbered such that
362 the number appears at @var{offset}. Note that, for this to take effect,
363 auto-numbering must be turned on in the paper block. Otherwise, no
364 number will appear. Use like @code{\\once})")
365 (make-music 'FootnoteEvent
366 'automatically-numbered #t
368 'X-offset (car offset)
369 'Y-offset (cdr offset)
370 'text (make-null-markup)
371 'footnote-text footnote))
375 #(define-music-function (parser location offset text footnote)
376 (number-pair? markup? markup?)
377 (_i "Attach @var{text} at @var{offset} with @var{text} referring
378 to @var{footnote} (use like @code{\\tweak})")
379 (make-music 'FootnoteEvent
380 'automatically-numbered #f
381 'X-offset (car offset)
382 'Y-offset (cdr offset)
384 'footnote-text footnote))
387 #(define-music-function (parser location offset footnote)
388 (number-pair? markup?)
389 (_i "Footnote the item after which this comes with the text in
390 @var{footnote} allowing for the footnote to be automatically numbered
391 such that the number appears at @var{offset}. Note that, for this to
392 take effect, auto-numbering must be turned on in the paper block.
393 Otherwise, no number will appear. Use like @code{\\tweak})")
394 (make-music 'FootnoteEvent
395 'automatically-numbered #t
396 'X-offset (car offset)
397 'Y-offset (cdr offset)
398 'text (make-null-markup)
399 'footnote-text footnote))
402 #(def-grace-function startGraceMusic stopGraceMusic
403 (_i "Insert @var{music} as grace notes."))
405 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
406 (_i "Convert @var{music} into harmonics; the resulting notes resemble
407 harmonics played on a fretted instrument by touching the strings above @var{fret}.")
408 (let* ((fret (number->string fret))
409 (pitch (fret->pitch fret)))
410 (make-sequential-music
413 \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label $fret)
416 (calc-harmonic-pitch pitch music))
418 \revert TabNoteHead #'stencil
421 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
422 (_i "Convert @var{music} into harmonics; the resulting notes resemble
423 harmonics played on a fretted instrument by touching the strings above the point
424 given through @var{ratio}.")
425 (let ((pitch (ratio->pitch ratio))
426 (fret (ratio->fret ratio)))
427 (make-sequential-music
430 \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label $fret)
433 (calc-harmonic-pitch pitch music))
435 \revert TabNoteHead #'stencil
439 #(define-music-function
440 (parser location name) (string?)
441 (_i "Switch instrument to @var{name}, which must be predefined with
442 @code{\\addInstrumentDefinition}.")
443 (let* ((handle (assoc name instrument-definitions))
444 (instrument-def (if handle (cdr handle) '())))
447 (ly:input-warning location "No such instrument: ~a" name))
449 (make-music 'SimultaneousMusic
461 #(define-music-function (parser location tag music) (symbol? ly:music?)
462 (_i "Include only elements of @var{music} that are tagged with @var{tag}.")
465 (let* ((tags (ly:music-property m 'tags))
466 (res (memq tag tags)))
473 #(define-music-function (parser location music) (ly:music?)
474 (_i "Remove cue notes from @var{music}.")
477 (if (and (string? (ly:music-property mus 'quoted-music-name))
478 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
479 (ly:music-property mus 'element)
486 #(define-music-function (parser location label) (symbol?)
487 (_i "Create @var{label} as a bookmarking label.")
488 (make-music 'EventChord
491 'elements (list (make-music 'LabelEvent
492 'page-label label))))
496 #(define-void-function (parser location language) (string?)
497 (_i "Set note names for language @var{language}.")
498 (note-names-language parser language))
500 languageSaveAndChange =
501 #(define-void-function (parser location language) (string?)
502 (_i "Store the previous pitchnames alist, and set a new one.")
503 (set! previous-pitchnames pitchnames)
504 (note-names-language parser language))
507 #(define-void-function (parser location) ()
508 (_i "Restore a previously-saved pitchnames alist.")
509 (if previous-pitchnames
511 (set! pitchnames previous-pitchnames)
512 (ly:parser-set-note-names parser pitchnames))
513 (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
517 #(define-music-function (parser location arg) (ly:music?)
518 (_i "Display chords in @var{arg} as clusters.")
519 (music-map note-to-cluster arg))
522 #(define-music-function (parser location around to scale music)
523 (ly:pitch? ly:pitch? ly:music? ly:music?)
524 (_i "Invert @var{music} about @var{around} using @var{scale} and
525 transpose from @var{around} to @var{to}.")
526 (let ((inverter (make-modal-inverter around to scale)))
527 (change-pitches music inverter)
531 #(define-music-function (parser location from to scale music)
532 (ly:pitch? ly:pitch? ly:music? ly:music?)
533 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
535 (let ((transposer (make-modal-transposer from to scale)))
536 (change-pitches music transposer)
540 #(define-music-function
541 (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
542 (_i "Invert @var{music} about @var{around} and
543 transpose from @var{around} to @var{to}.")
544 (music-invert around to music))
547 #(define-music-function (parser location proc mus) (procedure? ly:music?)
548 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
549 (music-map proc mus))
551 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
552 %% because music identifiers are not allowed at top-level.
554 #(define-music-function (location parser) ()
555 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
556 markups), or inside a score.")
557 (make-music 'EventChord
559 'page-break-permission 'forbid
560 'elements (list (make-music 'PageBreakEvent
561 'break-permission '()))))
564 #(define-music-function (location parser) ()
565 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
566 markups), or inside a score.")
567 (make-music 'EventChord
569 'page-turn-permission 'forbid
570 'elements (list (make-music 'PageTurnEvent
571 'break-permission '()))))
576 #(define-music-function (parser location pitch) (ly:pitch?)
578 (make-music 'RelativeOctaveCheck
582 #(define-music-function (parser location music) (ly:music?)
583 (_i "Set @code{once} to @code{#t} on all layout instruction events in @var{music}.")
586 (cond ((music-is-of-type? m 'layout-instruction-event)
587 (set! (ly:music-property m 'once) #t))
588 ((ly:duration? (ly:music-property m 'duration))
589 (ly:music-warning m (_ "Cannot apply \\once to timed music"))))
594 #(define-music-function (parser location octave) (integer?)
595 (_i "Set the octavation.")
596 (make-music 'OttavaMusic
597 'ottava-number octave))
599 overrideTimeSignatureSettings =
600 #(define-music-function
601 (parser location time-signature base-moment beat-structure beam-exceptions)
602 (pair? pair? cheap-list? cheap-list?)
604 (_i "Override @code{timeSignatureSettings}
605 for time signatures of @var{time-signature} to have settings
606 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
608 ;; TODO -- add warning if largest value of grouping is
609 ;; greater than time-signature.
610 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
611 (override-time-signature-setting time-signature setting)))
614 #(define-music-function (parser location name property value)
615 (string? symbol? scheme?)
617 (_i "Set @var{property} to @var{value} in all grobs named @var{name}.
618 The @var{name} argument is a string of the form @code{\"Context.GrobName\"}
619 or @code{\"GrobName\"}.")
621 (let ((name-components (string-split name #\.))
622 (context-name 'Bottom)
625 (if (> 2 (length name-components))
626 (set! grob-name (string->symbol (car name-components)))
628 (set! grob-name (string->symbol (list-ref name-components 1)))
629 (set! context-name (string->symbol (list-ref name-components 0)))))
631 (make-music 'ApplyOutputEvent
632 'context-type context-name
634 (lambda (grob orig-context context)
636 (cdr (assoc 'name (ly:grob-property grob 'meta)))
638 (set! (ly:grob-property grob property) value))))))
642 %% pageBreak and pageTurn are music functions (iso music indentifiers),
643 %% because music identifiers are not allowed at top-level.
645 #(define-music-function (location parser) ()
646 (_i "Force a page break. May be used at toplevel (i.e., between scores or
647 markups), or inside a score.")
648 (make-music 'EventChord
650 'line-break-permission 'force
651 'page-break-permission 'force
652 'elements (list (make-music 'LineBreakEvent
653 'break-permission 'force)
654 (make-music 'PageBreakEvent
655 'break-permission 'force))))
658 #(define-music-function (location parser) ()
659 (_i "Force a page turn between two scores or top-level markups.")
660 (make-music 'EventChord
662 'line-break-permission 'force
663 'page-break-permission 'force
664 'page-turn-permission 'force
665 'elements (list (make-music 'LineBreakEvent
666 'break-permission 'force)
667 (make-music 'PageBreakEvent
668 'break-permission 'force)
669 (make-music 'PageTurnEvent
670 'break-permission 'force))))
673 #(define-void-function (parser location voice-ids music) (list? ly:music?)
674 (_i "Define parallel music sequences, separated by '|' (bar check signs),
675 and assign them to the identifiers provided in @var{voice-ids}.
677 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
679 @var{music}: a music sequence, containing BarChecks as limiting expressions.
684 \\parallelMusic #'(A B C) {
694 (let* ((voices (apply circular-list (make-list (length voice-ids) (list))))
695 (current-voices voices)
696 (current-sequence (list)))
699 (define (push-music m)
700 "Push the music expression into the current sequence"
701 (set! current-sequence (cons m current-sequence)))
702 (define (change-voice)
703 "Stores the previously built sequence into the current voice and
704 change to the following voice."
705 (list-set! current-voices 0 (cons (make-music 'SequentialMusic
706 'elements (reverse! current-sequence))
707 (car current-voices)))
708 (set! current-sequence (list))
709 (set! current-voices (cdr current-voices)))
710 (define (bar-check? m)
711 "Checks whether m is a bar check."
712 (eq? (ly:music-property m 'name) 'BarCheck))
713 (define (music-origin music)
714 "Recursively search an origin location stored in music."
715 (cond ((null? music) #f)
716 ((not (null? (ly:music-property music 'origin)))
717 (ly:music-property music 'origin))
718 (else (or (music-origin (ly:music-property music 'element))
719 (let ((origins (remove not (map music-origin
720 (ly:music-property music 'elements)))))
721 (and (not (null? origins)) (car origins)))))))
723 ;; first, split the music and fill in voices
724 (for-each (lambda (m)
726 (if (bar-check? m) (change-voice)))
727 (ly:music-property music 'elements))
728 (if (not (null? current-sequence)) (change-voice))
729 ;; un-circularize `voices' and reorder the voices
730 (set! voices (map-in-order (lambda (dummy seqs)
734 ;; set origin location of each sequence in each voice
735 ;; for better type error tracking
736 (for-each (lambda (voice)
737 (for-each (lambda (seq)
738 (set! (ly:music-property seq 'origin)
739 (or (music-origin seq) location)))
743 ;; check sequence length
744 (apply for-each (lambda* (#:rest seqs)
745 (let ((moment-reference (ly:music-length (car seqs))))
746 (for-each (lambda (seq moment)
747 (if (not (equal? moment moment-reference))
748 (ly:music-warning seq
749 "Bars in parallel music don't have the same length")))
750 seqs (map-in-order ly:music-length seqs))))
753 ;; bind voice identifiers to the voices
754 (for-each (lambda (voice-id voice)
755 (ly:parser-define! parser voice-id
756 (make-music 'SequentialMusic
762 #(define-music-function (parser loc arg) (ly:music?)
763 (_i "Tag @var{arg} to be parenthesized.")
765 (if (memq 'event-chord (ly:music-property arg 'types))
766 ;; arg is an EventChord -> set the parenthesize property
767 ;; on all child notes and rests
770 (if (or (memq 'note-event (ly:music-property ev 'types))
771 (memq 'rest-event (ly:music-property ev 'types)))
772 (set! (ly:music-property ev 'parenthesize) #t)))
773 (ly:music-property arg 'elements))
774 ;; No chord, simply set property for this expression:
775 (set! (ly:music-property arg 'parenthesize) #t))
779 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
780 (_i "Take the music in @var{part1} and @var{part2} and typeset so
781 that they share a staff.")
782 (make-part-combine-music parser
783 (list part1 part2) #f))
786 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
787 (_i "Take the music in @var{part1} and @var{part2} and typeset so
788 that they share a staff with stems directed upward.")
789 (make-part-combine-music parser
790 (list part1 part2) UP))
793 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
794 (_i "Take the music in @var{part1} and @var{part2} and typeset so
795 that they share a staff with stems directed downward.")
796 (make-part-combine-music parser
797 (list part1 part2) DOWN))
800 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
801 (_i "Override the part-combiner.")
802 (make-music 'EventChord
803 'elements (list (make-music 'PartCombineForceEvent
806 partcombineApart = \partcombineForce #'apart ##f
807 partcombineApartOnce = \partcombineForce #'apart ##t
808 partcombineChords = \partcombineForce #'chords ##f
809 partcombineChordsOnce = \partcombineForce #'chords ##t
810 partcombineUnisono = \partcombineForce #'unisono ##f
811 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
812 partcombineSoloI = \partcombineForce #'solo1 ##f
813 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
814 partcombineSoloII = \partcombineForce #'solo2 ##f
815 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
816 partcombineAutomatic = \partcombineForce ##f ##f
817 partcombineAutomaticOnce = \partcombineForce ##f ##t
820 #(define-music-function (parser location dur) (ly:duration?)
821 (_i "Make a partial measure.")
823 ;; We use `descend-to-context' here instead of `context-spec-music' to
824 ;; ensure \partial still works if the Timing_translator is moved
826 (context-spec-music (make-music 'PartialSet
828 'partial-duration dur)
833 #(define-music-function
834 (parser location main-note secondary-note)
835 (ly:music? ly:music?)
836 (_i "Print a trill with @var{main-note} as the main note of the trill and
837 print @var{secondary-note} as a stemless note head in parentheses.")
838 (let* ((get-notes (lambda (ev-chord)
840 (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
841 (ly:music-property ev-chord 'elements))))
842 (sec-note-events (get-notes secondary-note))
843 (trill-events (filter (lambda (m) (music-has-type m 'trill-span-event))
844 (ly:music-property main-note 'elements))))
846 (if (pair? sec-note-events)
848 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
849 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
851 (if (ly:pitch? trill-pitch)
852 (for-each (lambda (m)
853 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
855 (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
856 (display sec-note-events)))
859 (for-each (lambda (m)
860 (ly:music-set-property! m 'force-accidental forced))
865 #(define-music-function (parser location tag more music)
866 (symbol? ly:music? ly:music?)
867 (_i "Add @var{more} to the front of @code{elements} of all music
868 expressions in @var{music} that are tagged with @var{tag}.")
869 (music-map (lambda (m)
870 (if (memq tag (ly:music-property m 'tags))
871 (set! (ly:music-property m 'elements)
872 (cons more (ly:music-property m 'elements))))
877 #(define-music-function (parser location what main-music) (string? ly:music?)
878 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
879 of the quoted voice, as specified in an @code{\\addQuote} command.
880 @var{main-music} is used to indicate the length of music to be quoted;
881 usually contains spacers or multi-measure rests.")
882 (make-music 'QuoteMusic
884 'quoted-music-name what))
887 #(define-music-function (parser location pitch music)
888 ((ly:pitch? (ly:make-pitch 0 0 0)) ly:music?)
889 (_i "Make @var{music} relative to @var{pitch} (default @code{c'}).")
890 (ly:make-music-relative! music pitch)
891 (make-music 'RelativeOctaveMusic
895 #(define-music-function (parser location tag music) (symbol? ly:music?)
896 (_i "Remove elements of @var{music} that are tagged with @var{tag}.")
899 (let* ((tags (ly:music-property m 'tags))
900 (res (memq tag tags)))
904 resetRelativeOctave =
905 #(define-music-function (parser location pitch) (ly:pitch?)
906 (_i "Set the octave inside a \\relative section.")
908 (make-music 'SequentialMusic
909 'to-relative-callback
910 (lambda (music last-pitch) pitch)))
913 #(define-music-function (parser location music)
915 (_i "Return @var{music} in reverse order.")
916 (retrograde-music music))
918 revertTimeSignatureSettings =
919 #(define-music-function
920 (parser location time-signature)
923 (_i "Revert @code{timeSignatureSettings}
924 for time signatures of @var{time-signature}.")
925 (revert-time-signature-setting time-signature))
928 #(define-music-function (parser location finger) (number-or-string?)
929 (_i "Apply @var{finger} as a fingering indication.")
934 (if (string? finger) 'text 'digit)
938 #(define-music-function (parser location fraction music)
939 (fraction? ly:music?)
940 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
941 (ly:music-compress music
942 (ly:make-moment (car fraction) (cdr fraction))))
945 #(define-music-function (parser location dur dots arg)
946 (integer? integer? ly:music?)
947 (_i "Scale @var{arg} up by a factor of 2^@var{dur}*(2-(1/2)^@var{dots}).")
951 (shift-one-duration-log x dur dots)) arg))
954 #(define-music-function (parser location dur) (ly:duration?)
955 (_i "Skip forward by @var{dur}.")
956 (make-music 'SkipMusic
961 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
962 (_i "Create slashed graces (slashes through stems, but no slur) from
963 the following music expression"))
966 #(define-music-function (parser location parameters) (list?)
967 (_i "Set the system stretch, by reading the 'system-stretch property of
968 the `parameters' assoc list.")
970 \overrideProperty #"Score.NonMusicalPaperColumn"
971 #'line-break-system-details
972 #$(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
973 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
977 #(define-music-function (parser location style heads music)
978 (symbol? list-or-symbol? ly:music?)
979 (_i "Set @var{heads} in @var{music} to @var{style}.")
980 (style-note-heads heads style music))
985 #(define-music-function (parser location) ()
986 (_i "Include the string information in a chord repetition.")
987 (ly:parser-set-repetition-function parser tab-repeat-chord)
988 (make-music 'SequentialMusic 'void #t))
991 #(define-music-function (parser location tag arg) (symbol? ly:music?)
993 (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
996 (ly:music-property arg 'tags)
998 (ly:music-property arg 'tags)))
1002 #(define-music-function
1003 (parser location from to music)
1004 (ly:pitch? ly:pitch? ly:music?)
1006 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1007 (make-music 'TransposedMusic
1008 'element (ly:music-transpose music (ly:pitch-diff to from))))
1010 transposedCueDuring =
1011 #(define-music-function
1012 (parser location what dir pitch main-music)
1013 (string? ly:dir? ly:pitch? ly:music?)
1015 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1016 using the transposition defined by @var{pitch}. This happens
1017 simultaneously with @var{main-music}, which is usually a rest. The
1018 argument @var{dir} determines whether the cue notes should be notated
1019 as a first or second voice.")
1021 (make-music 'QuoteMusic
1023 'quoted-context-type 'Voice
1024 'quoted-context-id "cue"
1025 'quoted-music-name what
1026 'quoted-voice-direction dir
1027 'quoted-transposition pitch))
1030 #(define-music-function (parser location pitch) (ly:pitch?)
1031 (_i "Set instrument transposition")
1034 (make-property-set 'instrumentTransposition
1035 (ly:pitch-negate pitch))
1039 #(define-music-function (parser location sym val arg)
1040 (symbol? scheme? ly:music?)
1041 (_i "Add @code{sym . val} to the @code{tweaks} property of @var{arg}.")
1043 (if (equal? (object-property sym 'backend-type?) #f)
1045 (ly:input-warning location (_ "cannot find property type-check for ~a") sym)
1046 (ly:warning (_ "doing assignment anyway"))))
1048 (ly:music-property arg 'tweaks)
1050 (ly:music-property arg 'tweaks)))
1056 #(define-music-function (parser location music) (ly:music?)
1057 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1058 @code{\\repeat percent} commands in @var{music} to be interpreted
1059 as @code{\\repeat unfold}.")
1060 (unfold-repeats music))
1063 #(define-void-function (parser location arg) (scheme?)
1064 (_i "Accept a scheme argument, return a void expression.
1065 Use this if you want to have a scheme expression evaluated
1066 because of its side-effects, but its value ignored."))
1070 #(define-music-function (parser location sym val music)
1071 (symbol? scheme? ly:music?)
1072 (_i "Set @var{sym} to @var{val} in @var{music}.")
1074 (set! (ly:music-property music sym) val)