1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
4 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 ;; for define-safe-public when byte-compiling using Guile V2
20 (use-modules (scm safe-utility-defs))
22 (use-modules (ice-9 optargs))
24 ;;; ly:music-property with setter
25 ;;; (ly:music-property my-music 'elements)
26 ;;; ==> the 'elements property
27 ;;; (set! (ly:music-property my-music 'elements) value)
28 ;;; ==> set the 'elements property and return it
29 (define-public ly:music-property
30 (make-procedure-with-setter ly:music-property
31 ly:music-set-property!))
33 (define-safe-public (music-is-of-type? mus type)
34 "Does @code{mus} belong to the music class @code{type}?"
35 (memq type (ly:music-property mus 'types)))
38 (define-public ly:grob-property
39 (make-procedure-with-setter ly:grob-property
40 ly:grob-set-property!))
42 (define-public ly:grob-object
43 (make-procedure-with-setter ly:grob-object
46 (define-public ly:grob-parent
47 (make-procedure-with-setter ly:grob-parent
50 (define-public ly:prob-property
51 (make-procedure-with-setter ly:prob-property
52 ly:prob-set-property!))
54 (define-public ly:context-property
55 (make-procedure-with-setter ly:context-property
56 ly:context-set-property!))
58 (define-public (music-map function music)
59 "Apply @var{function} to @var{music} and all of the music it contains.
61 First it recurses over the children, then the function is applied to
63 (let ((es (ly:music-property music 'elements))
64 (e (ly:music-property music 'element)))
66 (set! (ly:music-property music 'elements)
67 (map (lambda (y) (music-map function y)) es)))
69 (set! (ly:music-property music 'element)
70 (music-map function e)))
73 (define-public (music-filter pred? music)
74 "Filter out music expressions that do not satisfy @var{pred?}."
76 (define (inner-music-filter pred? music)
78 (let* ((es (ly:music-property music 'elements))
79 (e (ly:music-property music 'element))
80 (as (ly:music-property music 'articulations))
81 (filtered-as (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) as)))
82 (filtered-e (if (ly:music? e)
83 (inner-music-filter pred? e)
85 (filtered-es (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) es))))
87 (set! (ly:music-property music 'element) filtered-e))
89 (set! (ly:music-property music 'elements) filtered-es))
91 (set! (ly:music-property music 'articulations) filtered-as))
92 ;; if filtering emptied the expression, we remove it completely.
93 (if (or (not (pred? music))
94 (and (eq? filtered-es '()) (not (ly:music? e))
95 (or (not (eq? es '()))
100 (set! music (inner-music-filter pred? music))
101 (if (ly:music? music)
103 (make-music 'Music))) ;must return music.
105 (define*-public (display-music music #:optional (port (current-output-port)))
106 "Display music, not done with @code{music-map} for clarity of
109 (display ": { " port)
110 (let ((es (ly:music-property music 'elements))
111 (e (ly:music-property music 'element)))
112 (display (ly:music-mutable-properties music) port)
114 (begin (display "\nElements: {\n" port)
115 (for-each (lambda (m) (display-music m port)) es)
116 (display "}\n" port)))
119 (display "\nChild:" port)
120 (display-music e port))))
121 (display " }\n" port)
125 ;;; A scheme music pretty printer
127 (define (markup-expression->make-markup markup-expression)
128 "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression.
130 \\markup \\bold \\italic hello
132 (markup #:line (#:bold (#:italic (#:simple \"hello\"))))"
133 (define (proc->command-keyword proc)
134 "Return a keyword, eg. `#:bold', from the `proc' function, eg. #<procedure bold-markup (layout props arg)>"
135 (let ((cmd-markup (symbol->string (procedure-name proc))))
136 (symbol->keyword (string->symbol (substring cmd-markup 0 (- (string-length cmd-markup)
137 (string-length "-markup")))))))
138 (define (transform-arg arg)
139 (cond ((and (pair? arg) (markup? (car arg))) ;; a markup list
140 (apply append (map inner-markup->make-markup arg)))
141 ((and (not (string? arg)) (markup? arg)) ;; a markup
142 (inner-markup->make-markup arg))
144 (music->make-music arg))))
145 (define (inner-markup->make-markup mrkup)
148 (let ((cmd (proc->command-keyword (car mrkup)))
149 (args (map transform-arg (cdr mrkup))))
152 (if (string? markup-expression)
154 `(markup ,@(inner-markup->make-markup markup-expression))))
156 (define-public (music->make-music obj)
157 "Generate an expression that, once evaluated, may return an object
158 equivalent to @var{obj}, that is, for a music expression, a
159 @code{(make-music ...)} form."
160 (cond (;; markup expression
162 (markup-expression->make-markup obj))
166 ',(ly:music-property obj 'name)
167 ,@(apply append (map (lambda (prop)
169 ,(music->make-music (cdr prop))))
170 (remove (lambda (prop)
171 (eqv? (car prop) 'origin))
172 (ly:music-mutable-properties obj))))))
175 `(ly:make-moment ,(ly:moment-main-numerator obj)
176 ,(ly:moment-main-denominator obj)
177 ,(ly:moment-grace-numerator obj)
178 ,(ly:moment-grace-denominator obj)))
181 `(ly:make-duration ,(ly:duration-log obj)
182 ,(ly:duration-dot-count obj)
183 ,(ly:duration-scale obj)))
186 `(ly:make-pitch ,(ly:pitch-octave obj)
187 ,(ly:pitch-notename obj)
188 ,(ly:pitch-alteration obj)))
191 (or (procedure-name obj) obj))
192 (;; a symbol (avoid having an unquoted symbol)
195 (;; an empty list (avoid having an unquoted empty list)
200 `(list ,@(map music->make-music obj)))
203 `(cons ,(music->make-music (car obj))
204 ,(music->make-music (cdr obj))))
208 (use-modules (ice-9 pretty-print))
209 (define*-public (display-scheme-music obj #:optional (port (current-output-port)))
210 "Displays `obj', typically a music expression, in a friendly fashion,
211 which often can be read back in order to generate an equivalent expression."
212 (pretty-print (music->make-music obj) port)
216 ;;; Scheme music expression --> Lily-syntax-using string translator
218 (use-modules (srfi srfi-39)
221 (define*-public (display-lily-music expr parser #:optional (port (current-output-port))
222 #:key force-duration)
223 "Display the music expression using LilyPond syntax"
224 (memoize-clef-names supported-clefs)
225 (parameterize ((*indent* 0)
226 (*previous-duration* (ly:make-duration 2))
227 (*force-duration* force-duration))
228 (display (music->lily-string expr parser) port)
231 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
233 (define-public (shift-one-duration-log music shift dot)
234 "Add @var{shift} to @code{duration-log} of @code{'duration} in
235 @var{music} and optionally @var{dot} to any note encountered.
236 The number of dots in the shifted music may not be less than zero."
237 (let ((d (ly:music-property music 'duration)))
239 (let* ((cp (ly:duration-scale d))
240 (nd (ly:make-duration
241 (+ shift (ly:duration-log d))
242 (max 0 (+ dot (ly:duration-dot-count d)))
244 (set! (ly:music-property music 'duration) nd)))
247 (define-public (shift-duration-log music shift dot)
248 (music-map (lambda (x) (shift-one-duration-log x shift dot))
251 (define-public (make-repeat name times main alts)
252 "Create a repeat music expression, with all properties initialized
254 (define (first-note-duration music)
255 "Finds the duration of the first NoteEvent by searching depth-first
257 ;; NoteEvent or a non-expanded chord-repetition
258 ;; We just take anything that actually sports an announced duration.
259 (if (ly:duration? (ly:music-property music 'duration))
260 (ly:music-property music 'duration)
261 (let loop ((elts (if (ly:music? (ly:music-property music 'element))
262 (list (ly:music-property music 'element))
263 (ly:music-property music 'elements))))
265 (let ((dur (first-note-duration (car elts))))
266 (if (ly:duration? dur)
268 (loop (cdr elts))))))))
270 (let ((talts (if (< times (length alts))
272 (ly:warning (_ "More alternatives than repeats. Junking excess alternatives"))
275 (r (make-repeated-music name)))
276 (set! (ly:music-property r 'element) main)
277 (set! (ly:music-property r 'repeat-count) (max times 1))
278 (set! (ly:music-property r 'elements) talts)
279 (if (and (equal? name "tremolo")
280 (pair? (extract-named-music main '(EventChord NoteEvent))))
281 ;; This works for single-note and multi-note tremolos!
282 (let* ((children (if (music-is-of-type? main 'sequential-music)
283 ;; \repeat tremolo n { ... }
284 (length (extract-named-music main '(EventChord
286 ;; \repeat tremolo n c4
288 ;; # of dots is equal to the 1 in bitwise representation (minus 1)!
289 (dots (1- (logcount (* times children))))
290 ;; The remaining missing multiplicator to scale the notes by
292 (mult (/ (* times children (ash 1 dots)) (1- (ash 2 dots))))
293 (shift (- (ly:intlog2 (floor mult))))
294 (note-duration (first-note-duration r))
295 (duration-log (if (ly:duration? note-duration)
296 (ly:duration-log note-duration)
298 (tremolo-type (ash 1 duration-log)))
299 (set! (ly:music-property r 'tremolo-type) tremolo-type)
300 (if (not (and (integer? mult) (= (logcount mult) 1)))
303 (ly:format (_ "invalid tremolo repeat count: ~a") times)))
304 ;; Adjust the time of the notes
305 (ly:music-compress r (ly:make-moment 1 children))
306 ;; Adjust the displayed note durations
307 (shift-duration-log r shift dots))
310 (define (calc-repeat-slash-count music)
311 "Given the child-list @var{music} in @code{PercentRepeatMusic},
312 calculate the number of slashes based on the durations. Returns @code{0}
313 if durations in @var{music} vary, allowing slash beats and double-percent
314 beats to be distinguished."
315 (let* ((durs (map duration-of-note
316 (extract-named-music music '(EventChord NoteEvent
317 RestEvent SkipEvent))))
318 (first-dur (car durs)))
320 (if (every (lambda (d) (equal? d first-dur)) durs)
321 (max (- (ly:duration-log first-dur) 2) 1)
324 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
327 (define-public (note-to-cluster music)
328 "Replace @code{NoteEvents} by @code{ClusterNoteEvents}."
329 (if (eq? (ly:music-property music 'name) 'NoteEvent)
330 (make-music 'ClusterNoteEvent
331 'pitch (ly:music-property music 'pitch)
332 'duration (ly:music-property music 'duration))
335 (define-public (notes-to-clusters music)
336 (music-map note-to-cluster music))
338 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
341 (define-public (unfold-repeats music)
342 "Replace all repeats with unfolded repeats."
344 (let ((es (ly:music-property music 'elements))
345 (e (ly:music-property music 'element)))
347 (if (music-is-of-type? music 'repeated-music)
348 (let* ((props (ly:music-mutable-properties music))
349 (old-name (ly:music-property music 'name))
350 (flattened (flatten-alist props)))
351 (set! music (apply make-music (cons 'UnfoldedRepeatedMusic
354 (if (and (equal? old-name 'TremoloRepeatedMusic)
355 (pair? (extract-named-music e '(EventChord NoteEvent))))
356 ;; This works for single-note and multi-note tremolos!
357 (let* ((children (if (music-is-of-type? e 'sequential-music)
358 ;; \repeat tremolo n { ... }
359 (length (extract-named-music e '(EventChord
361 ;; \repeat tremolo n c4
363 (times (ly:music-property music 'repeat-count))
365 ;; # of dots is equal to the 1 in bitwise representation (minus 1)!
366 (dots (1- (logcount (* times children))))
367 ;; The remaining missing multiplicator to scale the notes by
369 (mult (/ (* times children (ash 1 dots)) (1- (ash 2 dots))))
370 (shift (- (ly:intlog2 (floor mult)))))
372 ;; Adjust the time of the notes
373 (ly:music-compress music (ly:make-moment children 1))
374 ;; Adjust the displayed note durations
375 (shift-duration-log music (- shift) (- dots))))))
378 (set! (ly:music-property music 'elements)
379 (map unfold-repeats es)))
381 (set! (ly:music-property music 'element)
385 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
386 ;; property setting music objs.
388 (define-safe-public (check-grob-path path #:optional parser location
394 "Check a grob path specification @var{path}, a symbol list (or a
395 single symbol), for validity and possibly complete it. Returns the
396 completed specification, or @code{#f} if invalid. If optional
397 @var{parser} is given, a syntax error is raised in that case,
398 optionally using @var{location}. If an optional keyword argument
399 @code{#:start @var{start}} is given, the parsing starts at the given
400 index in the sequence @samp{Context.Grob.property.sub-property...},
401 with the default of @samp{0} implying the full path.
403 If there is no valid first element of @var{path} fitting at the given
404 path location, an optionally given @code{#:default @var{default}} is
405 used as the respective element instead without checking it for
406 validity at this position.
408 The resulting path after possibly prepending @var{default} can be
409 constrained in length by optional arguments @code{#:min @var{min}} and
410 @code{#:max @var{max}}, defaulting to @samp{1} and unlimited,
412 (let ((path (if (symbol? path) (list path) path)))
413 ;; A Guile 1.x bug specific to optargs precludes moving the
414 ;; defines out of the let
415 (define (unspecial? s)
416 (not (or (object-property s 'is-grob?)
417 (object-property s 'backend-type?))))
419 (object-property s 'is-grob?))
420 (define (property? s)
421 (object-property s 'backend-type?))
422 (define (check c p) (c p))
426 (drop (list unspecial? grob? property?) start)))
430 ;; tricky. Should we make use of the default when the
431 ;; list is empty? In most cases, this question should be
432 ;; academical as an empty list can only be generated by
433 ;; Scheme and is likely an error. We consider this a case
434 ;; of "no valid first element, and default given".
435 ;; Usually, invalid use cases should be caught later using
436 ;; the #:min argument, and if the user explicitly does not
437 ;; catch this, we just follow through.
438 (if default (list default) '()))
440 ;; no checkers, so we have a valid first element and just
441 ;; take the path as-is.
444 (if ((car checkers) (car path))
445 (and (every check (cdr checkers) (cdr path))
447 (and (every check (cdr checkers) path)
448 (cons default path))))
450 (and (every check checkers path)
453 (if max (<= min (length res) max)
454 (<= min (length res))))
458 (ly:parser-error parser
459 (format #f (_ "bad grob property path ~a")
464 (define-public (make-grob-property-set grob gprop val)
465 "Make a @code{Music} expression that sets @var{gprop} to @var{val} in
466 @var{grob}. Does a pop first, i.e., this is not an override."
467 (make-music 'OverrideProperty
473 (define-public (make-grob-property-override grob gprop val)
474 "Make a @code{Music} expression that overrides @var{gprop} to @var{val}
476 (make-music 'OverrideProperty
481 (define-public (make-grob-property-revert grob gprop)
482 "Revert the grob property @var{gprop} for @var{grob}."
483 (make-music 'RevertProperty
485 'grob-property gprop))
487 (define direction-polyphonic-grobs
488 '(AccidentalSuggestion
506 (define-safe-public (make-voice-props-set n)
507 (make-sequential-music
509 (map (lambda (x) (make-grob-property-set x 'direction
511 direction-polyphonic-grobs)
513 (make-property-set 'graceSettings
514 ;; TODO: take this from voicedGraceSettings or similar.
515 '((Voice Stem font-size -3)
516 (Voice Flag font-size -3)
517 (Voice NoteHead font-size -3)
518 (Voice TabNoteHead font-size -4)
519 (Voice Dots font-size -3)
520 (Voice Stem length-fraction 0.8)
521 (Voice Stem no-stem-extend #t)
522 (Voice Beam beam-thickness 0.384)
523 (Voice Beam length-fraction 0.8)
524 (Voice Accidental font-size -4)
525 (Voice AccidentalCautionary font-size -4)
526 (Voice Script font-size -3)
527 (Voice Fingering font-size -8)
528 (Voice StringNumber font-size -8)))
530 (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))))))
533 (define-safe-public (make-voice-props-override n)
534 (make-sequential-music
536 (map (lambda (x) (make-grob-property-override x 'direction
538 direction-polyphonic-grobs)
540 (make-property-set 'graceSettings
541 ;; TODO: take this from voicedGraceSettings or similar.
542 '((Voice Stem font-size -3)
543 (Voice Flag font-size -3)
544 (Voice NoteHead font-size -3)
545 (Voice TabNoteHead font-size -4)
546 (Voice Dots font-size -3)
547 (Voice Stem length-fraction 0.8)
548 (Voice Stem no-stem-extend #t)
549 (Voice Beam beam-thickness 0.384)
550 (Voice Beam length-fraction 0.8)
551 (Voice Accidental font-size -4)
552 (Voice AccidentalCautionary font-size -4)
553 (Voice Script font-size -3)
554 (Voice Fingering font-size -8)
555 (Voice StringNumber font-size -8)))
557 (make-grob-property-override 'NoteColumn 'horizontal-shift (quotient n 2))
558 (make-grob-property-override 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
560 (define-safe-public (make-voice-props-revert)
561 (make-sequential-music
563 (map (lambda (x) (make-grob-property-revert x 'direction))
564 direction-polyphonic-grobs)
565 (list (make-property-unset 'graceSettings)
566 (make-grob-property-revert 'NoteColumn 'horizontal-shift)
567 (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
570 (define-safe-public (context-spec-music m context #:optional id)
571 "Add \\context CONTEXT = ID to M."
572 (let ((cm (make-music 'ContextSpeccedMusic
574 'context-type context)))
576 (set! (ly:music-property cm 'context-id) id))
579 (define-public (descend-to-context m context)
580 "Like @code{context-spec-music}, but only descending."
581 (let ((cm (context-spec-music m context)))
582 (ly:music-set-property! cm 'descend-only #t)
585 (define-public (make-non-relative-music mus)
586 (make-music 'UnrelativableMusic
589 (define-public (make-apply-context func)
590 (make-music 'ApplyContext
593 (define-public (make-sequential-music elts)
594 (make-music 'SequentialMusic
597 (define-public (make-simultaneous-music elts)
598 (make-music 'SimultaneousMusic
601 (define-safe-public (make-event-chord elts)
602 (make-music 'EventChord
605 (define-public (make-skip-music dur)
606 (make-music 'SkipMusic
609 (define-public (make-grace-music music)
610 (make-music 'GraceMusic
616 (define-public (make-multi-measure-rest duration location)
617 (make-music 'MultiMeasureRestMusic
621 (define-public (make-property-set sym val)
622 (make-music 'PropertySet
626 (define-public (make-property-unset sym)
627 (make-music 'PropertyUnset
630 (define-safe-public (make-articulation name)
631 (make-music 'ArticulationEvent
632 'articulation-type name))
634 (define-public (make-lyric-event string duration)
635 (make-music 'LyricEvent
639 (define-safe-public (make-span-event type span-dir)
641 'span-direction span-dir))
643 (define-public (override-head-style heads style)
644 "Override style for @var{heads} to @var{style}."
645 (make-sequential-music
648 (make-grob-property-override h 'style style))
650 (list (make-grob-property-override heads 'style style)))))
652 (define-public (revert-head-style heads)
653 "Revert style for @var{heads}."
654 (make-sequential-music
657 (make-grob-property-revert h 'style))
659 (list (make-grob-property-revert heads 'style)))))
661 (define-public (style-note-heads heads style music)
662 "Set @var{style} for all @var{heads} in @var{music}. Works both
663 inside of and outside of chord construct."
664 ;; are we inside a <...>?
665 (if (eq? (ly:music-property music 'name) 'NoteEvent)
666 ;; yes -> use a tweak
668 (set! (ly:music-property music 'tweaks)
669 (acons 'style style (ly:music-property music 'tweaks)))
671 ;; not in <...>, so use overrides
672 (make-sequential-music
674 (override-head-style heads style)
676 (revert-head-style heads)))))
678 (define-public (set-mus-properties! m alist)
679 "Set all of @var{alist} as properties of @var{m}."
682 (set! (ly:music-property m (caar alist)) (cdar alist))
683 (set-mus-properties! m (cdr alist)))))
685 (define-public (music-separator? m)
686 "Is @var{m} a separator?"
687 (let ((ts (ly:music-property m 'types)))
688 (memq 'separator ts)))
690 ;;; expanding repeat chords
691 (define-public (copy-repeat-chord original-chord repeat-chord duration
693 "Copies all events in @var{event-types} (be sure to include
694 @code{rhythmic-events}) from @var{original-chord} over to
695 @var{repeat-chord} with their articulations filtered as well. Any
696 duration is replaced with the specified @var{duration}."
697 ;; First remove everything from event-types that can already be
698 ;; found in the repeated chord. We don't need to look for
699 ;; articulations on individual events since they can't actually get
700 ;; into a repeat chord given its input syntax.
702 (define (keep-element? m)
703 (any (lambda (t) (music-is-of-type? m t))
705 (define origin (ly:music-property repeat-chord 'origin #f))
706 (define (set-origin! l)
708 (for-each (lambda (m) (set! (ly:music-property m 'origin) origin)) l))
713 (for-each (lambda (e)
714 (for-each (lambda (x)
715 (set! event-types (delq x event-types)))
716 (ly:music-property e 'types)))
717 (ly:music-property repeat-chord field)))
718 '(elements articulations))
720 ;; now treat the elements
721 (set! (ly:music-property repeat-chord 'elements)
723 (set-origin! (ly:music-deep-copy
724 (filter keep-element?
725 (ly:music-property original-chord
729 (let ((arts (ly:music-property m 'articulations)))
731 (set! (ly:music-property m 'articulations)
732 (set-origin! (filter! keep-element? arts))))
733 (if (ly:duration? (ly:music-property m 'duration))
734 (set! (ly:music-property m 'duration) duration))))
736 (append! elts (ly:music-property repeat-chord 'elements))))
737 (let ((arts (filter keep-element?
738 (ly:music-property original-chord
741 (set! (ly:music-property repeat-chord 'articulations)
743 (set-origin! (ly:music-deep-copy arts))
744 (ly:music-property repeat-chord 'articulations))))))
747 (define-public (expand-repeat-chords! event-types music)
748 "Walks through @var{music} and fills repeated chords (notable by
749 having a duration in @code{duration}) with the notes from their
750 respective predecessor chord."
751 (let loop ((music music) (last-chord #f))
752 (if (music-is-of-type? music 'event-chord)
753 (let ((chord-repeat (ly:music-property music 'duration)))
755 ((not (ly:duration? chord-repeat))
756 (if (any (lambda (m) (ly:duration?
757 (ly:music-property m 'duration)))
758 (ly:music-property music 'elements))
762 (set! (ly:music-property music 'duration) '())
763 (copy-repeat-chord last-chord music chord-repeat event-types)
766 (ly:music-warning music (_ "Bad chord repetition"))
768 (let ((elt (ly:music-property music 'element)))
769 (fold loop (if (ly:music? elt) (loop elt last-chord) last-chord)
770 (ly:music-property music 'elements)))))
773 ;;; splitting chords into voices.
774 (define (voicify-list lst number)
775 "Make a list of Musics.
777 voicify-list :: [ [Music ] ] -> number -> [Music]
778 LST is a list music-lists.
780 NUMBER is 0-base, i.e., Voice=1 (upstems) has number 0.
784 (cons (context-spec-music
785 (make-sequential-music
786 (list (make-voice-props-set number)
787 (make-simultaneous-music (car lst))))
788 'Bottom (number->string (1+ number)))
789 (voicify-list (cdr lst) (1+ number)))))
791 (define (voicify-chord ch)
792 "Split the parts of a chord into different Voices using separator"
793 (let ((es (ly:music-property ch 'elements)))
794 (set! (ly:music-property ch 'elements)
795 (voicify-list (split-list-by-separator es music-separator?) 0))
798 (define-public (voicify-music m)
799 "Recursively split chords that are separated with @code{\\\\}."
800 (if (not (ly:music? m))
801 (ly:error (_ "music expected: ~S") m))
802 (let ((es (ly:music-property m 'elements))
803 (e (ly:music-property m 'element)))
806 (set! (ly:music-property m 'elements) (map voicify-music es)))
808 (set! (ly:music-property m 'element) (voicify-music e)))
809 (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
810 (any music-separator? es))
811 (set! m (context-spec-music (voicify-chord m) 'Staff)))
814 (define-public (empty-music)
817 ;; Make a function that checks score element for being of a specific type.
818 (define-public (make-type-checker symbol)
820 (grob::has-interface elt symbol)))
822 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
824 (set! (ly:grob-property grob sym) val)))
827 (define-public ((set-output-property grob-name symbol val) grob grob-c context)
829 @code{\\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))}"
830 (let ((meta (ly:grob-property grob 'meta)))
831 (if (equal? (assoc-get 'name meta) grob-name)
832 (set! (ly:grob-property grob symbol) val))))
835 (define-public (skip->rest mus)
836 "Replace @var{mus} by @code{RestEvent} of the same duration if it is a
837 @code{SkipEvent}. Useful for extracting parts from crowded scores."
839 (if (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
840 (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
844 (define-public (music-has-type music type)
845 (memq type (ly:music-property music 'types)))
847 (define-public (music-clone music . music-properties)
848 "Clone @var{music} and set properties according to
849 @var{music-properties}, a list of alternating property symbols and
851 @example\n(music-clone start-span 'span-direction STOP)
853 Only properties that are not overriden by @var{music-properties} are
854 actually fully cloned."
855 (let ((old-props (list-copy (ly:music-mutable-properties music)))
857 (m (ly:make-music (ly:prob-immutable-properties music))))
858 (define (set-props mus-props)
859 (if (and (not (null? mus-props))
860 (not (null? (cdr mus-props))))
862 (set! old-props (assq-remove! old-props (car mus-props)))
865 (car mus-props) (cadr mus-props)))
866 (set-props (cddr mus-props)))))
867 (set-props music-properties)
870 (set! (ly:music-property m (car pair))
871 (ly:music-deep-copy (cdr pair))))
875 (set! (ly:music-property m (car pair)) (cdr pair)))
879 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
880 ;; warn for bare chords at start.
882 (define-public (ly:music-message music msg)
883 (let ((ip (ly:music-property music 'origin)))
884 (if (ly:input-location? ip)
885 (ly:input-message ip msg)
888 (define-public (ly:music-warning music msg)
889 (let ((ip (ly:music-property music 'origin)))
890 (if (ly:input-location? ip)
891 (ly:input-warning ip msg)
894 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
896 ;; setting stuff for grace context.
899 (define (vector-extend v x)
900 "Make a new vector consisting of V, with X added to the end."
901 (let* ((n (vector-length v))
902 (nv (make-vector (+ n 1) '())))
903 (vector-move-left! v 0 n nv 0)
907 (define (vector-map f v)
908 "Map F over V. This function returns nothing."
909 (do ((n (vector-length v))
912 (f (vector-ref v i))))
914 (define (vector-reverse-map f v)
915 "Map F over V, N to 0 order. This function returns nothing."
916 (do ((i (- (vector-length v) 1) (- i 1)))
918 (f (vector-ref v i))))
920 (define-public (add-grace-property context-name grob sym val)
921 "Set @var{sym}=@var{val} for @var{grob} in @var{context-name}."
922 (define (set-prop context)
923 (let* ((where (ly:context-property-where-defined context 'graceSettings))
924 (current (ly:context-property where 'graceSettings))
925 (new-settings (append current
926 (list (list context-name grob sym val)))))
927 (ly:context-set-property! where 'graceSettings new-settings)))
928 (context-spec-music (make-apply-context set-prop) 'Voice))
930 (define-public (remove-grace-property context-name grob sym)
931 "Remove all @var{sym} for @var{grob} in @var{context-name}."
932 (define (sym-grob-context? property sym grob context-name)
933 (and (eq? (car property) context-name)
934 (eq? (cadr property) grob)
935 (eq? (caddr property) sym)))
936 (define (delete-prop context)
937 (let* ((where (ly:context-property-where-defined context 'graceSettings))
938 (current (ly:context-property where 'graceSettings))
939 (prop-settings (filter
940 (lambda(x) (sym-grob-context? x sym grob context-name))
942 (new-settings current))
944 (set! new-settings (delete x new-settings)))
946 (ly:context-set-property! where 'graceSettings new-settings)))
947 (context-spec-music (make-apply-context delete-prop) 'Voice))
951 (defmacro-public def-grace-function (start stop . docstring)
952 "Helper macro for defining grace music"
953 `(define-music-function (parser location music) (ly:music?)
955 (make-music 'GraceMusic
957 'element (make-music 'SequentialMusic
958 'elements (list (ly:music-deep-copy ,start)
960 (ly:music-deep-copy ,stop))))))
962 (defmacro-public define-syntax-function (type args signature . body)
963 "Helper macro for `ly:make-music-function'.
965 (define-syntax-function result-type? (parser location arg1 arg2 ...) (arg1-type arg2-type ...)
968 argX-type can take one of the forms @code{predicate?} for mandatory
969 arguments satisfying the predicate, @code{(predicate?)} for optional
970 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
971 value)}} for optional parameters with a specified default
972 value (evaluated at definition time). An optional parameter can be
973 omitted in a call only when it can't get confused with a following
974 parameter of different type.
976 Predicates with syntactical significance are @code{ly:pitch?},
977 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
978 predicates require the parameter to be entered as Scheme expression.
980 @code{result-type?} can specify a default in the same manner as
981 predicates, to be used in case of a type error in arguments or
984 (set! signature (map (lambda (pred)
987 ,(and (pair? (cdr pred)) (cadr pred)))
989 (cons type signature)))
990 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
991 ;; When the music function definition contains a i10n doc string,
992 ;; (_i "doc string"), keep the literal string only
993 (let ((docstring (cadar body))
995 `(ly:make-music-function (list ,@signature)
999 `(ly:make-music-function (list ,@signature)
1003 (defmacro-public define-music-function rest
1004 "Defining macro returning music functions.
1006 (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1007 ...function body...)
1009 argX-type can take one of the forms @code{predicate?} for mandatory
1010 arguments satisfying the predicate, @code{(predicate?)} for optional
1011 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1012 value)}} for optional parameters with a specified default
1013 value (evaluated at definition time). An optional parameter can be
1014 omitted in a call only when it can't get confused with a following
1015 parameter of different type.
1017 Predicates with syntactical significance are @code{ly:pitch?},
1018 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
1019 predicates require the parameter to be entered as Scheme expression.
1021 Must return a music expression. The @code{origin} is automatically
1022 set to the @code{location} parameter."
1024 `(define-syntax-function (ly:music? (make-music 'Music 'void #t)) ,@rest))
1027 (defmacro-public define-scheme-function rest
1028 "Defining macro returning Scheme functions.
1030 (define-scheme-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1031 ...function body...)
1033 argX-type can take one of the forms @code{predicate?} for mandatory
1034 arguments satisfying the predicate, @code{(predicate?)} for optional
1035 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1036 value)}} for optional parameters with a specified default
1037 value (evaluated at definition time). An optional parameter can be
1038 omitted in a call only when it can't get confused with a following
1039 parameter of different type.
1041 Predicates with syntactical significance are @code{ly:pitch?},
1042 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
1043 predicates require the parameter to be entered as Scheme expression.
1045 Can return arbitrary expressions. If a music expression is returned,
1046 its @code{origin} is automatically set to the @code{location}
1049 `(define-syntax-function scheme? ,@rest))
1051 (defmacro-public define-void-function rest
1052 "This defines a Scheme function like @code{define-scheme-function} with
1053 void return value (i.e., what most Guile functions with `unspecified'
1054 value return). Use this when defining functions for executing actions
1055 rather than returning values, to keep Lilypond from trying to interpret
1057 `(define-syntax-function (void? *unspecified*) ,@rest *unspecified*))
1059 (defmacro-public define-event-function rest
1060 "Defining macro returning event functions.
1062 (define-event-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1063 ...function body...)
1065 argX-type can take one of the forms @code{predicate?} for mandatory
1066 arguments satisfying the predicate, @code{(predicate?)} for optional
1067 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1068 value)}} for optional parameters with a specified default
1069 value (evaluated at definition time). An optional parameter can be
1070 omitted in a call only when it can't get confused with a following
1071 parameter of different type.
1073 Predicates with syntactical significance are @code{ly:pitch?},
1074 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
1075 predicates require the parameter to be entered as Scheme expression.
1077 Must return an event expression. The @code{origin} is automatically
1078 set to the @code{location} parameter."
1080 `(define-syntax-function (ly:event? (make-music 'Event 'void #t)) ,@rest))
1082 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1084 (define-public (cue-substitute quote-music)
1085 "Must happen after @code{quote-substitute}."
1087 (if (vector? (ly:music-property quote-music 'quoted-events))
1088 (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
1089 (clef (ly:music-property quote-music 'quoted-music-clef #f))
1090 (main-voice (case dir ((1) 1) ((-1) 0) (else #f)))
1091 (cue-voice (and main-voice (- 1 main-voice)))
1092 (main-music (ly:music-property quote-music 'element))
1093 (return-value quote-music))
1096 (set! (ly:music-property quote-music 'element)
1097 (make-sequential-music
1099 (make-voice-props-override main-voice)
1101 (make-voice-props-revert)))))
1103 ;; if we have stem dirs, change both quoted and main music
1104 ;; to have opposite stems.
1106 ;; cannot context-spec Quote-music, since context
1107 ;; for the quotes is determined in the iterator.
1109 (make-sequential-music
1112 (and clef (make-cue-clef-set clef))
1114 ;; Need to establish CueVoice context even in #CENTER case
1117 (make-voice-props-override cue-voice)
1118 (make-music 'Music))
1123 (make-voice-props-revert) 'CueVoice "cue"))
1124 (and clef (make-cue-clef-unset))))))
1127 (define-public ((quote-substitute quote-tab) music)
1128 (let* ((quoted-name (ly:music-property music 'quoted-music-name))
1129 (quoted-vector (and (string? quoted-name)
1130 (hash-ref quote-tab quoted-name #f))))
1133 (if (string? quoted-name)
1134 (if (vector? quoted-vector)
1136 (set! (ly:music-property music 'quoted-events) quoted-vector)
1137 (set! (ly:music-property music 'iterator-ctor)
1138 ly:quote-iterator::constructor))
1139 (ly:music-warning music (ly:format (_ "cannot find quoted music: `~S'") quoted-name))))
1143 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1144 ;; switch it on here, so parsing and init isn't checked (too slow!)
1146 ;; automatic music transformations.
1148 (define (switch-on-debugging m)
1149 (if (defined? 'set-debug-cell-accesses!)
1150 (set-debug-cell-accesses! 15000))
1153 (define (music-check-error music)
1156 (if (and (ly:music? m)
1157 (eq? (ly:music-property m 'error-found) #t))
1160 (for-each signal (ly:music-property music 'elements))
1161 (signal (ly:music-property music 'element))
1164 (set! (ly:music-property music 'error-found) #t))
1167 (define (precompute-music-length music)
1168 (set! (ly:music-property music 'length)
1169 (ly:music-length music))
1172 (define-public (make-duration-of-length moment)
1173 "Make duration of the given @code{moment} length."
1174 (ly:make-duration 0 0
1175 (ly:moment-main-numerator moment)
1176 (ly:moment-main-denominator moment)))
1178 (define (make-skipped moment bool)
1179 "Depending on BOOL, set or unset skipTypesetting,
1180 then make SkipMusic of the given MOMENT length, and
1181 then revert skipTypesetting."
1182 (make-sequential-music
1184 (context-spec-music (make-property-set 'skipTypesetting bool)
1186 (make-music 'SkipMusic 'duration
1187 (make-duration-of-length moment))
1188 (context-spec-music (make-property-set 'skipTypesetting (not bool))
1191 (define (skip-as-needed music parser)
1193 << { \\set skipTypesetting = ##f
1194 LENGTHOF(\\showFirstLength)
1195 \\set skipTypesetting = ##t
1196 LENGTHOF(\\showLastLength) }
1200 When only showFirstLength is set,
1201 the 'length property of the music is
1202 overridden to speed up compiling."
1204 ((show-last (ly:parser-lookup parser 'showLastLength))
1205 (show-first (ly:parser-lookup parser 'showFirstLength))
1206 (show-last-length (and (ly:music? show-last)
1207 (ly:music-length show-last)))
1208 (show-first-length (and (ly:music? show-first)
1209 (ly:music-length show-first)))
1210 (orig-length (ly:music-length music)))
1212 ;;FIXME: if using either showFirst- or showLastLength,
1213 ;; make sure that skipBars is not set.
1217 ;; both properties may be set.
1218 ((and show-first-length show-last-length)
1220 ((skip-length (ly:moment-sub orig-length show-last-length)))
1221 (make-simultaneous-music
1223 (make-sequential-music
1225 (make-skipped skip-length #t)
1226 ;; let's draw a separator between the beginning and the end
1227 (context-spec-music (make-property-set 'whichBar "||")
1229 (make-skipped show-first-length #f)
1232 ;; we may only want to print the last length
1235 ((skip-length (ly:moment-sub orig-length show-last-length)))
1236 (make-simultaneous-music
1238 (make-skipped skip-length #t)
1241 ;; we may only want to print the beginning; in this case
1242 ;; only the first length will be processed (much faster).
1244 ;; the first length must not exceed the original length.
1245 (if (ly:moment<? show-first-length orig-length)
1246 (set! (ly:music-property music 'length)
1253 (define-public toplevel-music-functions
1255 (lambda (music parser) (expand-repeat-chords!
1256 (cons 'rhythmic-event
1257 (ly:parser-lookup parser '$chord-repeat-events))
1259 (lambda (music parser) (voicify-music music))
1260 (lambda (x parser) (music-map music-check-error x))
1261 (lambda (x parser) (music-map precompute-music-length x))
1262 (lambda (music parser)
1264 (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes)) music))
1266 ;; switch-on-debugging
1267 (lambda (x parser) (music-map cue-substitute x))
1270 (skip-as-needed x parser)
1274 ;;; general purpose music functions
1276 (define (shift-octave pitch octave-shift)
1277 (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
1279 (+ (ly:pitch-octave pitch) octave-shift)
1280 (ly:pitch-notename pitch)
1281 (ly:pitch-alteration pitch)))
1287 (define (apply-durations lyric-music durations)
1288 (define (apply-duration music)
1289 (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
1290 (ly:duration? (ly:music-property music 'duration)))
1292 (set! (ly:music-property music 'duration) (car durations))
1293 (set! durations (cdr durations)))))
1295 (music-map apply-duration lyric-music))
1298 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1301 (define (recent-enough? bar-number alteration-def laziness)
1302 (or (number? alteration-def)
1303 (equal? laziness #t)
1304 (<= bar-number (+ (cadr alteration-def) laziness))))
1306 (define (accidental-invalid? alteration-def)
1307 "Checks an alteration entry for being invalid.
1309 Non-key alterations are invalidated when tying into the next bar or
1310 when there is a clef change, since neither repetition nor cancellation
1311 can be omitted when the same note occurs again.
1313 Returns @code{#f} or the reason for the invalidation, a symbol."
1314 (let* ((def (if (pair? alteration-def)
1315 (car alteration-def)
1317 (and (symbol? def) def)))
1319 (define (extract-alteration alteration-def)
1320 (cond ((number? alteration-def)
1322 ((pair? alteration-def)
1323 (car alteration-def))
1326 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1327 "Checks the need for an accidental and a @q{restore} accidental against
1328 @code{localKeySignature}. The @var{laziness} is the number of measures
1329 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1330 only cancel accidentals in the same measure; if @var{laziness} is three,
1331 we cancel accidentals up to three measures after they first appear.
1332 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1333 specifies whether accidentals should be canceled in different octaves."
1334 (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1335 ((equal? octaveness 'same-octave) #f)
1337 (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1338 (ly:warning (_ "Defaulting to 'any-octave."))
1340 (key-sig (ly:context-property context 'keySignature))
1341 (local-key-sig (ly:context-property context 'localKeySignature))
1342 (notename (ly:pitch-notename pitch))
1343 (octave (ly:pitch-octave pitch))
1344 (pitch-handle (cons octave notename))
1346 (need-accidental #f)
1347 (previous-alteration #f)
1348 (from-other-octaves #f)
1349 (from-same-octave (assoc-get pitch-handle local-key-sig))
1350 (from-key-sig (or (assoc-get notename local-key-sig)
1352 ;; If no key signature match is found from localKeySignature, we may have a custom
1353 ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1354 ;; instead of (pitch . alteration). Since this type cannot coexist with entries in
1355 ;; localKeySignature, try extracting from keySignature instead.
1356 (assoc-get pitch-handle key-sig))))
1358 ;; loop through localKeySignature to search for a notename match from other octaves
1359 (let loop ((l local-key-sig))
1361 (let ((entry (car l)))
1362 (if (and (pair? (car entry))
1363 (= (cdar entry) notename))
1364 (set! from-other-octaves (cdr entry))
1367 ;; find previous alteration-def for comparison with pitch
1369 ;; from same octave?
1370 ((and (not ignore-octave)
1372 (recent-enough? barnum from-same-octave laziness))
1373 (set! previous-alteration from-same-octave))
1378 (recent-enough? barnum from-other-octaves laziness))
1379 (set! previous-alteration from-other-octaves))
1381 ;; not recent enough, extract from key signature/local key signature
1383 (set! previous-alteration from-key-sig)))
1385 (if (accidental-invalid? previous-alteration)
1386 (set! need-accidental #t)
1388 (let* ((prev-alt (extract-alteration previous-alteration))
1389 (this-alt (ly:pitch-alteration pitch)))
1391 (if (not (= this-alt prev-alt))
1393 (set! need-accidental #t)
1394 (if (and (not (= this-alt 0))
1395 (and (< (abs this-alt) (abs prev-alt))
1396 (> (* prev-alt this-alt) 0)))
1397 (set! need-restore #t))))))
1399 (cons need-restore need-accidental)))
1401 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1402 "Create an accidental rule that makes its decision based on the octave of
1403 the note and a laziness value.
1405 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1406 defines whether the rule should respond to accidental changes in other
1407 octaves than the current. @code{'same-octave} is the normal way to typeset
1408 accidentals -- an accidental is made if the alteration is different from the
1409 last active pitch in the same octave. @code{'any-octave} looks at the last
1410 active pitch in any octave.
1412 @var{laziness} states over how many bars an accidental should be remembered.
1413 @code{0}@tie{}is the default -- accidental lasts over 0@tie{}bar lines, that
1414 is, to the end of current measure. A positive integer means that the
1415 accidental lasts over that many bar lines. @w{@code{-1}} is `forget
1416 immediately', that is, only look at key signature. @code{#t} is `forever'."
1418 (check-pitch-against-signature context pitch barnum laziness octaveness))
1420 (define (key-entry-notename entry)
1421 "Return the pitch of an @var{entry} in @code{localKeySignature}.
1422 The @samp{car} of the entry is either of the form @code{notename} or
1423 of the form @code{(octave . notename)}. The latter form is used for special
1424 key signatures or to indicate an explicit accidental.
1426 The @samp{cdr} of the entry is either a rational @code{alter} indicating
1427 a key signature alteration, or of the form
1428 @code{(alter . (barnum . measurepos))} indicating an alteration caused by
1429 an accidental in music."
1430 (if (pair? (car entry))
1434 (define (key-entry-octave entry)
1435 "Return the octave of an entry in @code{localKeySignature}
1436 or @code{#f} if the entry does not have an octave.
1437 See @code{key-entry-notename} for details."
1438 (and (pair? (car entry)) (caar entry)))
1440 (define (key-entry-bar-number entry)
1441 "Return the bar number of an entry in @code{localKeySignature}
1442 or @code {#f} if the entry does not have a bar number.
1443 See @code{key-entry-notename} for details."
1444 (and (pair? (cdr entry)) (caddr entry)))
1446 (define (key-entry-measure-position entry)
1447 "Return the measure position of an entry in @code{localKeySignature}
1448 or @code {#f} if the entry does not have a measure position.
1449 See @code{key-entry-notename} for details."
1450 (and (pair? (cdr entry)) (cdddr entry)))
1452 (define (key-entry-alteration entry)
1453 "Return the alteration of an entry in localKeySignature.
1455 For convenience, returns @code{0} if entry is @code{#f}."
1457 (if (number? (cdr entry))
1462 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1463 "Return the first entry in @var{keysig} that matches @var{pitch}.
1464 @var{accept-global} states whether key signature entries should be included.
1465 @var{accept-local} states whether local accidentals should be included.
1466 If no matching entry is found, @var{#f} is returned."
1468 (let* ((entry (car keysig))
1469 (entryoct (key-entry-octave entry))
1470 (entrynn (key-entry-notename entry))
1471 (nn (ly:pitch-notename pitch)))
1472 (if (and (equal? nn entrynn)
1474 (= entryoct (ly:pitch-octave pitch)))
1475 (if (key-entry-bar-number entry)
1479 (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))))
1481 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1482 "An accidental rule that typesets an accidental if it differs from the
1483 key signature @emph{and} does not directly follow a note on the same
1484 staff line. This rule should not be used alone because it does neither
1485 look at bar lines nor different accidentals at the same note name."
1486 (let* ((keysig (ly:context-property context 'localKeySignature))
1487 (entry (find-pitch-entry keysig pitch #t #t)))
1490 (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1491 (key-acc (key-entry-alteration global-entry))
1492 (acc (ly:pitch-alteration pitch))
1493 (entrymp (key-entry-measure-position entry))
1494 (entrybn (key-entry-bar-number entry)))
1495 (cons #f (not (or (equal? acc key-acc)
1496 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1498 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1499 "An accidental rule that typesets a cautionary accidental if it is
1500 included in the key signature @emph{and} does not directly follow a note
1501 on the same staff line."
1502 (let* ((keysig (ly:context-property context 'localKeySignature))
1503 (entry (find-pitch-entry keysig pitch #t #t)))
1506 (let* ((entrymp (key-entry-measure-position entry))
1507 (entrybn (key-entry-bar-number entry)))
1508 (cons #f (not (and (equal? entrybn barnum) (equal? entrymp measurepos))))))))
1510 (define-public (set-accidentals-properties extra-natural
1511 auto-accs auto-cauts
1514 (make-sequential-music
1515 (append (if (boolean? extra-natural)
1516 (list (make-property-set 'extraNatural extra-natural))
1518 (list (make-property-set 'autoAccidentals auto-accs)
1519 (make-property-set 'autoCautionaries auto-cauts))))
1522 (define-public (set-accidental-style style . rest)
1523 "Set accidental style to @var{style}. Optionally take a context
1524 argument, e.g. @code{'Staff} or @code{'Voice}. The context defaults
1525 to @code{Staff}, except for piano styles, which use @code{GrandStaff}
1527 (let ((context (if (pair? rest)
1529 (pcontext (if (pair? rest)
1530 (car rest) 'GrandStaff)))
1532 ;; accidentals as they were common in the 18th century.
1533 ((equal? style 'default)
1534 (set-accidentals-properties #t
1535 `(Staff ,(make-accidental-rule 'same-octave 0))
1538 ;; accidentals from one voice do NOT get canceled in other voices
1539 ((equal? style 'voice)
1540 (set-accidentals-properties #t
1541 `(Voice ,(make-accidental-rule 'same-octave 0))
1544 ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1545 ;; This includes all the default accidentals, but accidentals also needs canceling
1546 ;; in other octaves and in the next measure.
1547 ((equal? style 'modern)
1548 (set-accidentals-properties #f
1549 `(Staff ,(make-accidental-rule 'same-octave 0)
1550 ,(make-accidental-rule 'any-octave 0)
1551 ,(make-accidental-rule 'same-octave 1))
1554 ;; the accidentals that Stone adds to the old standard as cautionaries
1555 ((equal? style 'modern-cautionary)
1556 (set-accidentals-properties #f
1557 `(Staff ,(make-accidental-rule 'same-octave 0))
1558 `(Staff ,(make-accidental-rule 'any-octave 0)
1559 ,(make-accidental-rule 'same-octave 1))
1561 ;; same as modern, but accidentals different from the key signature are always
1562 ;; typeset - unless they directly follow a note of the same pitch.
1563 ((equal? style 'neo-modern)
1564 (set-accidentals-properties #f
1565 `(Staff ,(make-accidental-rule 'same-octave 0)
1566 ,(make-accidental-rule 'any-octave 0)
1567 ,(make-accidental-rule 'same-octave 1)
1568 ,neo-modern-accidental-rule)
1571 ((equal? style 'neo-modern-cautionary)
1572 (set-accidentals-properties #f
1573 `(Staff ,(make-accidental-rule 'same-octave 0))
1574 `(Staff ,(make-accidental-rule 'any-octave 0)
1575 ,(make-accidental-rule 'same-octave 1)
1576 ,neo-modern-accidental-rule)
1578 ((equal? style 'neo-modern-voice)
1579 (set-accidentals-properties #f
1580 `(Voice ,(make-accidental-rule 'same-octave 0)
1581 ,(make-accidental-rule 'any-octave 0)
1582 ,(make-accidental-rule 'same-octave 1)
1583 ,neo-modern-accidental-rule
1584 Staff ,(make-accidental-rule 'same-octave 0)
1585 ,(make-accidental-rule 'any-octave 0)
1586 ,(make-accidental-rule 'same-octave 1)
1587 ,neo-modern-accidental-rule)
1590 ((equal? style 'neo-modern-voice-cautionary)
1591 (set-accidentals-properties #f
1592 `(Voice ,(make-accidental-rule 'same-octave 0))
1593 `(Voice ,(make-accidental-rule 'any-octave 0)
1594 ,(make-accidental-rule 'same-octave 1)
1595 ,neo-modern-accidental-rule
1596 Staff ,(make-accidental-rule 'same-octave 0)
1597 ,(make-accidental-rule 'any-octave 0)
1598 ,(make-accidental-rule 'same-octave 1)
1599 ,neo-modern-accidental-rule)
1601 ;; Accidentals as they were common in dodecaphonic music with no tonality.
1602 ;; Each note gets one accidental.
1603 ((equal? style 'dodecaphonic)
1604 (set-accidentals-properties #f
1605 `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1608 ;; Multivoice accidentals to be read both by musicians playing one voice
1609 ;; and musicians playing all voices.
1610 ;; Accidentals are typeset for each voice, but they ARE canceled across voices.
1611 ((equal? style 'modern-voice)
1612 (set-accidentals-properties #f
1613 `(Voice ,(make-accidental-rule 'same-octave 0)
1614 ,(make-accidental-rule 'any-octave 0)
1615 ,(make-accidental-rule 'same-octave 1)
1616 Staff ,(make-accidental-rule 'same-octave 0)
1617 ,(make-accidental-rule 'any-octave 0)
1618 ,(make-accidental-rule 'same-octave 1))
1621 ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1623 ((equal? style 'modern-voice-cautionary)
1624 (set-accidentals-properties #f
1625 `(Voice ,(make-accidental-rule 'same-octave 0))
1626 `(Voice ,(make-accidental-rule 'any-octave 0)
1627 ,(make-accidental-rule 'same-octave 1)
1628 Staff ,(make-accidental-rule 'same-octave 0)
1629 ,(make-accidental-rule 'any-octave 0)
1630 ,(make-accidental-rule 'same-octave 1))
1632 ;; stone's suggestions for accidentals on grand staff.
1633 ;; Accidentals are canceled across the staves in the same grand staff as well
1634 ((equal? style 'piano)
1635 (set-accidentals-properties #f
1636 `(Staff ,(make-accidental-rule 'same-octave 0)
1637 ,(make-accidental-rule 'any-octave 0)
1638 ,(make-accidental-rule 'same-octave 1)
1640 ,(make-accidental-rule 'any-octave 0)
1641 ,(make-accidental-rule 'same-octave 1))
1644 ((equal? style 'piano-cautionary)
1645 (set-accidentals-properties #f
1646 `(Staff ,(make-accidental-rule 'same-octave 0))
1647 `(Staff ,(make-accidental-rule 'any-octave 0)
1648 ,(make-accidental-rule 'same-octave 1)
1650 ,(make-accidental-rule 'any-octave 0)
1651 ,(make-accidental-rule 'same-octave 1))
1654 ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1655 ;; tones specified by the key signature.
1656 ((equal? style 'teaching)
1657 (set-accidentals-properties #f
1658 `(Staff ,(make-accidental-rule 'same-octave 0))
1659 `(Staff ,(make-accidental-rule 'same-octave 1)
1660 ,teaching-accidental-rule)
1663 ;; do not set localKeySignature when a note alterated differently from
1664 ;; localKeySignature is found.
1665 ;; Causes accidentals to be printed at every note instead of
1666 ;; remembered for the duration of a measure.
1667 ;; accidentals not being remembered, causing accidentals always to
1668 ;; be typeset relative to the time signature
1669 ((equal? style 'forget)
1670 (set-accidentals-properties '()
1671 `(Staff ,(make-accidental-rule 'same-octave -1))
1674 ;; Do not reset the key at the start of a measure. Accidentals will be
1675 ;; printed only once and are in effect until overridden, possibly many
1677 ((equal? style 'no-reset)
1678 (set-accidentals-properties '()
1679 `(Staff ,(make-accidental-rule 'same-octave #t))
1683 (ly:warning (_ "unknown accidental style: ~S") style)
1684 (make-sequential-music '())))))
1686 (define-public (invalidate-alterations context)
1687 "Invalidate alterations in @var{context}.
1689 Elements of @code{'localKeySignature} corresponding to local
1690 alterations of the key signature have the form
1691 @code{'((octave . notename) . (alter barnum . measurepos))}.
1692 Replace them with a version where @code{alter} is set to @code{'clef}
1693 to force a repetition of accidentals.
1695 Entries that conform with the current key signature are not invalidated."
1696 (let* ((keysig (ly:context-property context 'keySignature)))
1697 (set! (ly:context-property context 'localKeySignature)
1700 (let* ((localalt (key-entry-alteration entry)))
1701 (if (or (accidental-invalid? localalt)
1702 (not (key-entry-bar-number entry))
1704 (key-entry-alteration
1707 (ly:make-pitch (key-entry-octave entry)
1708 (key-entry-notename entry)
1712 (cons (car entry) (cons 'clef (cddr entry))))))
1713 (ly:context-property context 'localKeySignature)))))
1715 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1717 (define-public (skip-of-length mus)
1718 "Create a skip of exactly the same length as @var{mus}."
1722 'duration (ly:make-duration 0 0))))
1724 (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1726 (define-public (mmrest-of-length mus)
1727 "Create a multi-measure rest of exactly the same length as @var{mus}."
1730 (make-multi-measure-rest
1731 (ly:make-duration 0 0) '())))
1732 (ly:music-compress skip (ly:music-length mus))
1735 (define-public (pitch-of-note event-chord)
1736 (let ((evs (filter (lambda (x)
1737 (music-has-type x 'note-event))
1738 (ly:music-property event-chord 'elements))))
1741 (ly:music-property (car evs) 'pitch))))
1743 (define-public (duration-of-note event-chord)
1745 ((pair? event-chord)
1746 (or (duration-of-note (car event-chord))
1747 (duration-of-note (cdr event-chord))))
1748 ((ly:music? event-chord)
1749 (let ((dur (ly:music-property event-chord 'duration)))
1750 (if (ly:duration? dur)
1752 (duration-of-note (ly:music-property event-chord 'elements)))))
1755 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1757 (define-public (map-some-music map? music)
1758 "Walk through @var{music}, transform all elements calling @var{map?}
1759 and only recurse if this returns @code{#f}."
1760 (let loop ((music music))
1762 (let ((elt (ly:music-property music 'element))
1763 (elts (ly:music-property music 'elements))
1764 (arts (ly:music-property music 'articulations)))
1766 (set! (ly:music-property music 'element)
1769 (set! (ly:music-property music 'elements)
1772 (set! (ly:music-property music 'articulations)
1776 (define-public (for-some-music stop? music)
1777 "Walk through @var{music}, process all elements calling @var{stop?}
1778 and only recurse if this returns @code{#f}."
1779 (let loop ((music music))
1780 (if (not (stop? music))
1781 (let ((elt (ly:music-property music 'element)))
1784 (for-each loop (ly:music-property music 'elements))
1785 (for-each loop (ly:music-property music 'articulations))))))
1787 (define-public (fold-some-music pred? proc init music)
1788 "This works recursively on music like @code{fold} does on a list,
1789 calling @samp{(@var{pred?} music)} on every music element. If
1790 @code{#f} is returned for an element, it is processed recursively
1791 with the same initial value of @samp{previous}, otherwise
1792 @samp{(@var{proc} music previous)} replaces @samp{previous}
1793 and no recursion happens.
1794 The top @var{music} is processed using @var{init} for @samp{previous}."
1795 (let loop ((music music) (previous init))
1797 (proc music previous)
1800 (let ((elt (ly:music-property music 'element)))
1803 (loop elt previous)))
1804 (ly:music-property music 'elements))
1805 (ly:music-property music 'articulations)))))
1807 (define-public (extract-music music pred?)
1808 "Return a flat list of all music matching @var{pred?} inside of
1809 @var{music}, not recursing into matches themselves."
1810 (reverse! (fold-some-music pred? cons '() music)))
1812 (define-public (extract-named-music music music-name)
1813 "Return a flat list of all music named @var{music-name} (either a
1814 single event symbol or a list of alternatives) inside of @var{music},
1815 not recursing into matches themselves."
1818 (if (cheap-list? music-name)
1819 (lambda (m) (memq (ly:music-property m 'name) music-name))
1820 (lambda (m) (eq? (ly:music-property m 'name) music-name)))))
1822 (define-public (extract-typed-music music type)
1823 "Return a flat list of all music with @var{type} (either a single
1824 type symbol or a list of alternatives) inside of @var{music}, not
1825 recursing into matches themselves."
1828 (if (cheap-list? type)
1830 (any (lambda (t) (music-is-of-type? m t)) type))
1831 (lambda (m) (music-is-of-type? m type)))))
1833 (define*-public (event-chord-wrap! music #:optional parser)
1834 "Wrap isolated rhythmic events and non-postevent events in
1835 @var{music} inside of an @code{EventChord}. If the optional
1836 @var{parser} argument is given, chord repeats @samp{q} are expanded
1837 using the default settings. Otherwise, you need to cater for them
1841 (cond ((music-is-of-type? m 'event-chord)
1842 (if (pair? (ly:music-property m 'articulations))
1844 (set! (ly:music-property m 'elements)
1845 (append (ly:music-property m 'elements)
1846 (ly:music-property m 'articulations)))
1847 (set! (ly:music-property m 'articulations) '())))
1849 ((music-is-of-type? m 'rhythmic-event)
1850 (let ((arts (ly:music-property m 'articulations)))
1852 (set! (ly:music-property m 'articulations) '()))
1853 (make-event-chord (cons m arts))))
1856 (expand-repeat-chords!
1857 (cons 'rhythmic-event
1858 (ly:parser-lookup parser '$chord-repeat-events))
1862 (define-public (event-chord-notes event-chord)
1863 "Return a list of all notes from @var{event-chord}."
1865 (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1866 (ly:music-property event-chord 'elements)))
1868 (define-public (event-chord-pitches event-chord)
1869 "Return a list of all pitches from @var{event-chord}."
1870 (map (lambda (x) (ly:music-property x 'pitch))
1871 (event-chord-notes event-chord)))
1873 (defmacro-public make-relative (pitches last-pitch music)
1874 "The list of pitch-carrying variables in @var{pitches} is used as a
1875 sequence for creating relativable music from @var{music}.
1876 The variables in @var{pitches} are, when considered inside of
1877 @code{\\relative}, all considered to be specifications to the preceding
1878 variable. The first variable is relative to the preceding musical
1879 context, and @var{last-pitch} specifies the pitch passed as relative
1880 base onto the following musical context."
1882 ;; pitch and music generator might be stored instead in music
1883 ;; properties, and it might make sense to create a music type of its
1884 ;; own for this kind of construct rather than using
1885 ;; RelativeOctaveMusic
1886 (define ((make-relative::to-relative-callback pitches p->m p->p) music pitch)
1887 (let* ((chord (make-event-chord
1890 (make-music 'NoteEvent
1894 (ly:make-music-relative! chord pitch)
1895 (event-chord-pitches chord))))
1896 (set! (ly:music-property music 'element)
1897 (apply p->m pitchout))
1898 (apply p->p pitchout)))
1899 `(make-music 'RelativeOctaveMusic
1900 'to-relative-callback
1901 (,make-relative::to-relative-callback
1903 (lambda ,pitches ,music)
1904 (lambda ,pitches ,last-pitch))
1907 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1908 ;; The following functions are all associated with the crossStaff
1911 (define (close-enough? x y)
1912 "Values are close enough to ignore the difference"
1913 (< (abs (- x y)) 0.0001))
1915 (define (extent-combine extents)
1916 "Combine a list of extents"
1917 (if (pair? (cdr extents))
1918 (interval-union (car extents) (extent-combine (cdr extents)))
1921 (define ((stem-connectable? ref root) stem)
1922 "Check if the stem is connectable to the root"
1923 ;; The root is always connectable to itself
1926 ;; Horizontal positions of the stems must be almost the same
1927 (close-enough? (car (ly:grob-extent root ref X))
1928 (car (ly:grob-extent stem ref X)))
1929 ;; The stem must be in the direction away from the root's notehead
1930 (positive? (* (ly:grob-property root 'direction)
1931 (- (car (ly:grob-extent stem ref Y))
1932 (car (ly:grob-extent root ref Y))))))))
1934 (define (stem-span-stencil span)
1935 "Connect stems if we have at least one stem connectable to the root"
1936 (let* ((system (ly:grob-system span))
1937 (root (ly:grob-parent span X))
1938 (stems (filter (stem-connectable? system root)
1939 (ly:grob-object span 'stems))))
1940 (if (<= 2 (length stems))
1941 (let* ((yextents (map (lambda (st)
1942 (ly:grob-extent st system Y)) stems))
1943 (yextent (extent-combine yextents))
1944 (layout (ly:grob-layout root))
1945 (blot (ly:output-def-lookup layout 'blot-diameter)))
1946 ;; Hide spanned stems
1948 (set! (ly:grob-property st 'stencil) #f))
1950 ;; Draw a nice looking stem with rounded corners
1951 (ly:round-filled-box (ly:grob-extent root root X) yextent blot))
1952 ;; Nothing to connect, don't draw the span
1955 (define ((make-stem-span! stems trans) root)
1956 "Create a stem span as a child of the cross-staff stem (the root)"
1957 (let ((span (ly:engraver-make-grob trans 'Stem '())))
1958 (ly:grob-set-parent! span X root)
1959 (set! (ly:grob-object span 'stems) stems)
1960 ;; Suppress positioning, the stem code is confused by this weird stem
1961 (set! (ly:grob-property span 'X-offset) 0)
1962 (set! (ly:grob-property span 'stencil) stem-span-stencil)))
1964 (define-public (cross-staff-connect stem)
1965 "Set cross-staff property of the stem to this function to connect it to
1966 other stems automatically"
1969 (define (stem-is-root? stem)
1970 "Check if automatic connecting of the stem was requested. Stems connected
1971 to cross-staff beams are cross-staff, but they should not be connected to
1972 other stems just because of that."
1973 (eq? cross-staff-connect (ly:grob-property-data stem 'cross-staff)))
1975 (define (make-stem-spans! ctx stems trans)
1976 "Create stem spans for cross-staff stems"
1977 ;; Cannot do extensive checks here, just make sure there are at least
1978 ;; two stems at this musical moment
1979 (if (<= 2 (length stems))
1980 (let ((roots (filter stem-is-root? stems)))
1981 (map (make-stem-span! stems trans) roots))))
1983 (define-public (Span_stem_engraver ctx)
1984 "Connect cross-staff stems to the stems above in the system"
1987 ;; Record all stems for the given moment
1989 ((stem-interface trans grob source)
1990 (set! stems (cons grob stems))))
1991 ;; Process stems and reset the stem list to empty
1992 ((process-acknowledged trans)
1993 (make-stem-spans! ctx stems trans)
1994 (set! stems '())))))
1996 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1997 ;; The following is used by the alterBroken function.
1999 (define-public ((value-for-spanner-piece arg) grob)
2000 "Associate a piece of broken spanner @var{grob} with an element
2002 (let* ((orig (ly:grob-original grob))
2003 (siblings (ly:spanner-broken-into orig)))
2005 (define (helper sibs arg)
2008 (if (eq? (car sibs) grob)
2010 (helper (cdr sibs) (cdr arg)))))
2012 (if (>= (length siblings) 2)
2013 (helper siblings arg)
2016 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2019 (define (measure-counter-stencil grob)
2020 "Print a number for a measure count. The number is centered using
2021 the extents of @code{BreakAlignment} grobs associated with
2022 @code{NonMusicalPaperColumn} grobs. In the case of an unbroken measure, these
2023 columns are the left and right bounds of a @code{MeasureCounter} spanner.
2024 Broken measures are numbered in parentheses."
2025 (let* ((orig (ly:grob-original grob))
2026 (siblings (ly:spanner-broken-into orig)) ; have we been split?
2027 (bounds (ly:grob-array->list (ly:grob-object grob 'columns)))
2028 (refp (ly:grob-system grob))
2029 ;; we use the first and/or last NonMusicalPaperColumn grob(s) of
2030 ;; a system in the event that a MeasureCounter spanner is broken
2031 (all-cols (ly:grob-array->list (ly:grob-object refp 'columns)))
2034 (lambda (col) (eq? #t (ly:grob-property col 'non-musical)))
2037 (if (or (null? siblings) ; spanner is unbroken
2038 (eq? grob (car siblings))) ; or the first piece
2042 (if (or (null? siblings)
2043 (eq? grob (car (reverse siblings))))
2044 (car (reverse bounds))
2045 (car (reverse all-cols))))
2046 (elts-L (ly:grob-array->list (ly:grob-object left-bound 'elements)))
2047 (elts-R (ly:grob-array->list (ly:grob-object right-bound 'elements)))
2050 (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2054 (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2056 (break-alignment-L-ext (ly:grob-extent (car break-alignment-L) refp X))
2057 (break-alignment-R-ext (ly:grob-extent (car break-alignment-R) refp X))
2058 (num (markup (number->string (ly:grob-property grob 'count-from))))
2060 (if (or (null? siblings)
2061 (eq? grob (car siblings)))
2063 (make-parenthesize-markup num)))
2064 (num (grob-interpret-markup grob num))
2065 (num (ly:stencil-aligned-to num X (ly:grob-property grob 'self-alignment-X)))
2067 (ly:stencil-translate-axis
2069 (+ (interval-length break-alignment-L-ext)
2071 (- (car break-alignment-R-ext)
2072 (cdr break-alignment-L-ext))))