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 . rest)
883 (let ((ip (ly:music-property music 'origin)))
884 (if (ly:input-location? ip)
885 (apply ly:input-message ip msg rest)
886 (apply ly:message msg rest))))
888 (define-public (ly:music-warning music msg . rest)
889 (let ((ip (ly:music-property music 'origin)))
890 (if (ly:input-location? ip)
891 (apply ly:input-warning ip msg rest)
892 (apply ly:warning msg rest))))
894 (define-public (ly:event-warning event msg . rest)
895 (let ((ip (ly:event-property event 'origin)))
896 (if (ly:input-location? ip)
897 (apply ly:input-warning ip msg rest)
898 (apply ly:warning msg rest))))
900 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
902 ;; setting stuff for grace context.
905 (define (vector-extend v x)
906 "Make a new vector consisting of V, with X added to the end."
907 (let* ((n (vector-length v))
908 (nv (make-vector (+ n 1) '())))
909 (vector-move-left! v 0 n nv 0)
913 (define (vector-map f v)
914 "Map F over V. This function returns nothing."
915 (do ((n (vector-length v))
918 (f (vector-ref v i))))
920 (define (vector-reverse-map f v)
921 "Map F over V, N to 0 order. This function returns nothing."
922 (do ((i (- (vector-length v) 1) (- i 1)))
924 (f (vector-ref v i))))
926 (define-public (add-grace-property context-name grob sym val)
927 "Set @var{sym}=@var{val} for @var{grob} in @var{context-name}."
928 (define (set-prop context)
929 (let* ((where (ly:context-property-where-defined context 'graceSettings))
930 (current (ly:context-property where 'graceSettings))
931 (new-settings (append current
932 (list (list context-name grob sym val)))))
933 (ly:context-set-property! where 'graceSettings new-settings)))
934 (context-spec-music (make-apply-context set-prop) 'Voice))
936 (define-public (remove-grace-property context-name grob sym)
937 "Remove all @var{sym} for @var{grob} in @var{context-name}."
938 (define (sym-grob-context? property sym grob context-name)
939 (and (eq? (car property) context-name)
940 (eq? (cadr property) grob)
941 (eq? (caddr property) sym)))
942 (define (delete-prop context)
943 (let* ((where (ly:context-property-where-defined context 'graceSettings))
944 (current (ly:context-property where 'graceSettings))
945 (prop-settings (filter
946 (lambda(x) (sym-grob-context? x sym grob context-name))
948 (new-settings current))
950 (set! new-settings (delete x new-settings)))
952 (ly:context-set-property! where 'graceSettings new-settings)))
953 (context-spec-music (make-apply-context delete-prop) 'Voice))
957 (defmacro-public def-grace-function (start stop . docstring)
958 "Helper macro for defining grace music"
959 `(define-music-function (parser location music) (ly:music?)
961 (make-music 'GraceMusic
963 'element (make-music 'SequentialMusic
964 'elements (list (ly:music-deep-copy ,start)
966 (ly:music-deep-copy ,stop))))))
968 (defmacro-public define-syntax-function (type args signature . body)
969 "Helper macro for `ly:make-music-function'.
971 (define-syntax-function result-type? (parser location arg1 arg2 ...) (arg1-type arg2-type ...)
974 argX-type can take one of the forms @code{predicate?} for mandatory
975 arguments satisfying the predicate, @code{(predicate?)} for optional
976 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
977 value)}} for optional parameters with a specified default
978 value (evaluated at definition time). An optional parameter can be
979 omitted in a call only when it can't get confused with a following
980 parameter of different type.
982 Predicates with syntactical significance are @code{ly:pitch?},
983 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
984 predicates require the parameter to be entered as Scheme expression.
986 @code{result-type?} can specify a default in the same manner as
987 predicates, to be used in case of a type error in arguments or
990 (set! signature (map (lambda (pred)
993 ,(and (pair? (cdr pred)) (cadr pred)))
995 (cons type signature)))
996 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
997 ;; When the music function definition contains a i10n doc string,
998 ;; (_i "doc string"), keep the literal string only
999 (let ((docstring (cadar body))
1001 `(ly:make-music-function (list ,@signature)
1005 `(ly:make-music-function (list ,@signature)
1009 (defmacro-public define-music-function rest
1010 "Defining macro returning music functions.
1012 (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1013 ...function body...)
1015 argX-type can take one of the forms @code{predicate?} for mandatory
1016 arguments satisfying the predicate, @code{(predicate?)} for optional
1017 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1018 value)}} for optional parameters with a specified default
1019 value (evaluated at definition time). An optional parameter can be
1020 omitted in a call only when it can't get confused with a following
1021 parameter of different type.
1023 Predicates with syntactical significance are @code{ly:pitch?},
1024 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
1025 predicates require the parameter to be entered as Scheme expression.
1027 Must return a music expression. The @code{origin} is automatically
1028 set to the @code{location} parameter."
1030 `(define-syntax-function (ly:music? (make-music 'Music 'void #t)) ,@rest))
1033 (defmacro-public define-scheme-function rest
1034 "Defining macro returning Scheme functions.
1036 (define-scheme-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1037 ...function body...)
1039 argX-type can take one of the forms @code{predicate?} for mandatory
1040 arguments satisfying the predicate, @code{(predicate?)} for optional
1041 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1042 value)}} for optional parameters with a specified default
1043 value (evaluated at definition time). An optional parameter can be
1044 omitted in a call only when it can't get confused with a following
1045 parameter of different type.
1047 Predicates with syntactical significance are @code{ly:pitch?},
1048 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
1049 predicates require the parameter to be entered as Scheme expression.
1051 Can return arbitrary expressions. If a music expression is returned,
1052 its @code{origin} is automatically set to the @code{location}
1055 `(define-syntax-function scheme? ,@rest))
1057 (defmacro-public define-void-function rest
1058 "This defines a Scheme function like @code{define-scheme-function} with
1059 void return value (i.e., what most Guile functions with `unspecified'
1060 value return). Use this when defining functions for executing actions
1061 rather than returning values, to keep Lilypond from trying to interpret
1063 `(define-syntax-function (void? *unspecified*) ,@rest *unspecified*))
1065 (defmacro-public define-event-function rest
1066 "Defining macro returning event functions.
1068 (define-event-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
1069 ...function body...)
1071 argX-type can take one of the forms @code{predicate?} for mandatory
1072 arguments satisfying the predicate, @code{(predicate?)} for optional
1073 parameters of that type defaulting to @code{#f}, @code{@w{(predicate?
1074 value)}} for optional parameters with a specified default
1075 value (evaluated at definition time). An optional parameter can be
1076 omitted in a call only when it can't get confused with a following
1077 parameter of different type.
1079 Predicates with syntactical significance are @code{ly:pitch?},
1080 @code{ly:duration?}, @code{ly:music?}, @code{markup?}. Other
1081 predicates require the parameter to be entered as Scheme expression.
1083 Must return an event expression. The @code{origin} is automatically
1084 set to the @code{location} parameter."
1086 `(define-syntax-function (ly:event? (make-music 'Event 'void #t)) ,@rest))
1088 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1090 (define-public (cue-substitute quote-music)
1091 "Must happen after @code{quote-substitute}."
1093 (if (vector? (ly:music-property quote-music 'quoted-events))
1094 (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
1095 (clef (ly:music-property quote-music 'quoted-music-clef #f))
1096 (main-voice (case dir ((1) 1) ((-1) 0) (else #f)))
1097 (cue-voice (and main-voice (- 1 main-voice)))
1098 (cue-type (ly:music-property quote-music 'quoted-context-type #f))
1099 (cue-id (ly:music-property quote-music 'quoted-context-id))
1100 (main-music (ly:music-property quote-music 'element))
1101 (return-value quote-music))
1104 (set! (ly:music-property quote-music 'element)
1105 (make-sequential-music
1107 (make-voice-props-override main-voice)
1109 (make-voice-props-revert)))))
1111 ;; if we have stem dirs, change both quoted and main music
1112 ;; to have opposite stems.
1114 ;; cannot context-spec Quote-music, since context
1115 ;; for the quotes is determined in the iterator.
1117 (make-sequential-music
1120 (and clef (make-cue-clef-set clef))
1121 (and cue-type cue-voice
1123 (make-voice-props-override cue-voice)
1126 (and cue-type cue-voice
1128 (make-voice-props-revert)
1130 (and clef (make-cue-clef-unset))))))
1133 (define-public ((quote-substitute quote-tab) music)
1134 (let* ((quoted-name (ly:music-property music 'quoted-music-name))
1135 (quoted-vector (and (string? quoted-name)
1136 (hash-ref quote-tab quoted-name #f))))
1139 (if (string? quoted-name)
1140 (if (vector? quoted-vector)
1142 (set! (ly:music-property music 'quoted-events) quoted-vector)
1143 (set! (ly:music-property music 'iterator-ctor)
1144 ly:quote-iterator::constructor))
1145 (ly:music-warning music (ly:format (_ "cannot find quoted music: `~S'") quoted-name))))
1149 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1150 ;; switch it on here, so parsing and init isn't checked (too slow!)
1152 ;; automatic music transformations.
1154 (define (switch-on-debugging m)
1155 (if (defined? 'set-debug-cell-accesses!)
1156 (set-debug-cell-accesses! 15000))
1159 (define (music-check-error music)
1162 (if (and (ly:music? m)
1163 (eq? (ly:music-property m 'error-found) #t))
1166 (for-each signal (ly:music-property music 'elements))
1167 (signal (ly:music-property music 'element))
1170 (set! (ly:music-property music 'error-found) #t))
1173 (define (precompute-music-length music)
1174 (set! (ly:music-property music 'length)
1175 (ly:music-length music))
1178 (define-public (make-duration-of-length moment)
1179 "Make duration of the given @code{moment} length."
1180 (ly:make-duration 0 0
1181 (ly:moment-main-numerator moment)
1182 (ly:moment-main-denominator moment)))
1184 (define (make-skipped moment bool)
1185 "Depending on BOOL, set or unset skipTypesetting,
1186 then make SkipMusic of the given MOMENT length, and
1187 then revert skipTypesetting."
1188 (make-sequential-music
1190 (context-spec-music (make-property-set 'skipTypesetting bool)
1192 (make-music 'SkipMusic 'duration
1193 (make-duration-of-length moment))
1194 (context-spec-music (make-property-set 'skipTypesetting (not bool))
1197 (define (skip-as-needed music parser)
1199 << { \\set skipTypesetting = ##f
1200 LENGTHOF(\\showFirstLength)
1201 \\set skipTypesetting = ##t
1202 LENGTHOF(\\showLastLength) }
1206 When only showFirstLength is set,
1207 the 'length property of the music is
1208 overridden to speed up compiling."
1210 ((show-last (ly:parser-lookup parser 'showLastLength))
1211 (show-first (ly:parser-lookup parser 'showFirstLength))
1212 (show-last-length (and (ly:music? show-last)
1213 (ly:music-length show-last)))
1214 (show-first-length (and (ly:music? show-first)
1215 (ly:music-length show-first)))
1216 (orig-length (ly:music-length music)))
1218 ;;FIXME: if using either showFirst- or showLastLength,
1219 ;; make sure that skipBars is not set.
1223 ;; both properties may be set.
1224 ((and show-first-length show-last-length)
1226 ((skip-length (ly:moment-sub orig-length show-last-length)))
1227 (make-simultaneous-music
1229 (make-sequential-music
1231 (make-skipped skip-length #t)
1232 ;; let's draw a separator between the beginning and the end
1233 (context-spec-music (make-property-set 'whichBar "||")
1235 (make-skipped show-first-length #f)
1238 ;; we may only want to print the last length
1241 ((skip-length (ly:moment-sub orig-length show-last-length)))
1242 (make-simultaneous-music
1244 (make-skipped skip-length #t)
1247 ;; we may only want to print the beginning; in this case
1248 ;; only the first length will be processed (much faster).
1250 ;; the first length must not exceed the original length.
1251 (if (ly:moment<? show-first-length orig-length)
1252 (set! (ly:music-property music 'length)
1259 (define-public toplevel-music-functions
1261 (lambda (music parser) (expand-repeat-chords!
1262 (cons 'rhythmic-event
1263 (ly:parser-lookup parser '$chord-repeat-events))
1265 (lambda (music parser) (voicify-music music))
1266 (lambda (x parser) (music-map music-check-error x))
1267 (lambda (x parser) (music-map precompute-music-length x))
1268 (lambda (music parser)
1270 (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes)) music))
1272 ;; switch-on-debugging
1273 (lambda (x parser) (music-map cue-substitute x))
1276 (skip-as-needed x parser)
1280 ;;; general purpose music functions
1282 (define (shift-octave pitch octave-shift)
1283 (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
1285 (+ (ly:pitch-octave pitch) octave-shift)
1286 (ly:pitch-notename pitch)
1287 (ly:pitch-alteration pitch)))
1293 (define (apply-durations lyric-music durations)
1294 (define (apply-duration music)
1295 (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
1296 (ly:duration? (ly:music-property music 'duration)))
1298 (set! (ly:music-property music 'duration) (car durations))
1299 (set! durations (cdr durations)))))
1301 (music-map apply-duration lyric-music))
1304 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1307 (define (recent-enough? bar-number alteration-def laziness)
1308 (or (number? alteration-def)
1309 (equal? laziness #t)
1310 (<= bar-number (+ (cadr alteration-def) laziness))))
1312 (define (accidental-invalid? alteration-def)
1313 "Checks an alteration entry for being invalid.
1315 Non-key alterations are invalidated when tying into the next bar or
1316 when there is a clef change, since neither repetition nor cancellation
1317 can be omitted when the same note occurs again.
1319 Returns @code{#f} or the reason for the invalidation, a symbol."
1320 (let* ((def (if (pair? alteration-def)
1321 (car alteration-def)
1323 (and (symbol? def) def)))
1325 (define (extract-alteration alteration-def)
1326 (cond ((number? alteration-def)
1328 ((pair? alteration-def)
1329 (car alteration-def))
1332 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1333 "Checks the need for an accidental and a @q{restore} accidental against
1334 @code{localKeySignature}. The @var{laziness} is the number of measures
1335 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1336 only cancel accidentals in the same measure; if @var{laziness} is three,
1337 we cancel accidentals up to three measures after they first appear.
1338 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1339 specifies whether accidentals should be canceled in different octaves."
1340 (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1341 ((equal? octaveness 'same-octave) #f)
1343 (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1344 (ly:warning (_ "Defaulting to 'any-octave."))
1346 (key-sig (ly:context-property context 'keySignature))
1347 (local-key-sig (ly:context-property context 'localKeySignature))
1348 (notename (ly:pitch-notename pitch))
1349 (octave (ly:pitch-octave pitch))
1350 (pitch-handle (cons octave notename))
1352 (need-accidental #f)
1353 (previous-alteration #f)
1354 (from-other-octaves #f)
1355 (from-same-octave (assoc-get pitch-handle local-key-sig))
1356 (from-key-sig (or (assoc-get notename local-key-sig)
1358 ;; If no key signature match is found from localKeySignature, we may have a custom
1359 ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1360 ;; instead of (pitch . alteration). Since this type cannot coexist with entries in
1361 ;; localKeySignature, try extracting from keySignature instead.
1362 (assoc-get pitch-handle key-sig))))
1364 ;; loop through localKeySignature to search for a notename match from other octaves
1365 (let loop ((l local-key-sig))
1367 (let ((entry (car l)))
1368 (if (and (pair? (car entry))
1369 (= (cdar entry) notename))
1370 (set! from-other-octaves (cdr entry))
1373 ;; find previous alteration-def for comparison with pitch
1375 ;; from same octave?
1376 ((and (not ignore-octave)
1378 (recent-enough? barnum from-same-octave laziness))
1379 (set! previous-alteration from-same-octave))
1384 (recent-enough? barnum from-other-octaves laziness))
1385 (set! previous-alteration from-other-octaves))
1387 ;; not recent enough, extract from key signature/local key signature
1389 (set! previous-alteration from-key-sig)))
1391 (if (accidental-invalid? previous-alteration)
1392 (set! need-accidental #t)
1394 (let* ((prev-alt (extract-alteration previous-alteration))
1395 (this-alt (ly:pitch-alteration pitch)))
1397 (if (not (= this-alt prev-alt))
1399 (set! need-accidental #t)
1400 (if (and (not (= this-alt 0))
1401 (and (< (abs this-alt) (abs prev-alt))
1402 (> (* prev-alt this-alt) 0)))
1403 (set! need-restore #t))))))
1405 (cons need-restore need-accidental)))
1407 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1408 "Create an accidental rule that makes its decision based on the octave of
1409 the note and a laziness value.
1411 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1412 defines whether the rule should respond to accidental changes in other
1413 octaves than the current. @code{'same-octave} is the normal way to typeset
1414 accidentals -- an accidental is made if the alteration is different from the
1415 last active pitch in the same octave. @code{'any-octave} looks at the last
1416 active pitch in any octave.
1418 @var{laziness} states over how many bars an accidental should be remembered.
1419 @code{0}@tie{}is the default -- accidental lasts over 0@tie{}bar lines, that
1420 is, to the end of current measure. A positive integer means that the
1421 accidental lasts over that many bar lines. @w{@code{-1}} is `forget
1422 immediately', that is, only look at key signature. @code{#t} is `forever'."
1424 (check-pitch-against-signature context pitch barnum laziness octaveness))
1426 (define (key-entry-notename entry)
1427 "Return the pitch of an @var{entry} in @code{localKeySignature}.
1428 The @samp{car} of the entry is either of the form @code{notename} or
1429 of the form @code{(octave . notename)}. The latter form is used for special
1430 key signatures or to indicate an explicit accidental.
1432 The @samp{cdr} of the entry is either a rational @code{alter} indicating
1433 a key signature alteration, or of the form
1434 @code{(alter . (barnum . measurepos))} indicating an alteration caused by
1435 an accidental in music."
1436 (if (pair? (car entry))
1440 (define (key-entry-octave entry)
1441 "Return the octave of an entry in @code{localKeySignature}
1442 or @code{#f} if the entry does not have an octave.
1443 See @code{key-entry-notename} for details."
1444 (and (pair? (car entry)) (caar entry)))
1446 (define (key-entry-bar-number entry)
1447 "Return the bar number of an entry in @code{localKeySignature}
1448 or @code {#f} if the entry does not have a bar number.
1449 See @code{key-entry-notename} for details."
1450 (and (pair? (cdr entry)) (caddr entry)))
1452 (define (key-entry-measure-position entry)
1453 "Return the measure position of an entry in @code{localKeySignature}
1454 or @code {#f} if the entry does not have a measure position.
1455 See @code{key-entry-notename} for details."
1456 (and (pair? (cdr entry)) (cdddr entry)))
1458 (define (key-entry-alteration entry)
1459 "Return the alteration of an entry in localKeySignature.
1461 For convenience, returns @code{0} if entry is @code{#f}."
1463 (if (number? (cdr entry))
1468 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1469 "Return the first entry in @var{keysig} that matches @var{pitch}.
1470 @var{accept-global} states whether key signature entries should be included.
1471 @var{accept-local} states whether local accidentals should be included.
1472 If no matching entry is found, @var{#f} is returned."
1474 (let* ((entry (car keysig))
1475 (entryoct (key-entry-octave entry))
1476 (entrynn (key-entry-notename entry))
1477 (nn (ly:pitch-notename pitch)))
1478 (if (and (equal? nn entrynn)
1480 (= entryoct (ly:pitch-octave pitch)))
1481 (if (key-entry-bar-number entry)
1485 (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))))
1487 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1488 "An accidental rule that typesets an accidental if it differs from the
1489 key signature @emph{and} does not directly follow a note on the same
1490 staff line. This rule should not be used alone because it does neither
1491 look at bar lines nor different accidentals at the same note name."
1492 (let* ((keysig (ly:context-property context 'localKeySignature))
1493 (entry (find-pitch-entry keysig pitch #t #t)))
1496 (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1497 (key-acc (key-entry-alteration global-entry))
1498 (acc (ly:pitch-alteration pitch))
1499 (entrymp (key-entry-measure-position entry))
1500 (entrybn (key-entry-bar-number entry)))
1501 (cons #f (not (or (equal? acc key-acc)
1502 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1504 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1505 "An accidental rule that typesets a cautionary accidental if it is
1506 included in the key signature @emph{and} does not directly follow a note
1507 on the same staff line."
1508 (let* ((keysig (ly:context-property context 'localKeySignature))
1509 (entry (find-pitch-entry keysig pitch #t #t)))
1512 (let* ((entrymp (key-entry-measure-position entry))
1513 (entrybn (key-entry-bar-number entry)))
1514 (cons #f (not (and (equal? entrybn barnum) (equal? entrymp measurepos))))))))
1516 (define-public (set-accidentals-properties extra-natural
1517 auto-accs auto-cauts
1520 (make-sequential-music
1521 (append (if (boolean? extra-natural)
1522 (list (make-property-set 'extraNatural extra-natural))
1524 (list (make-property-set 'autoAccidentals auto-accs)
1525 (make-property-set 'autoCautionaries auto-cauts))))
1528 (define-public (set-accidental-style style . rest)
1529 "Set accidental style to @var{style}. Optionally take a context
1530 argument, e.g. @code{'Staff} or @code{'Voice}. The context defaults
1531 to @code{Staff}, except for piano styles, which use @code{GrandStaff}
1533 (let ((context (if (pair? rest)
1535 (pcontext (if (pair? rest)
1536 (car rest) 'GrandStaff)))
1538 ;; accidentals as they were common in the 18th century.
1539 ((equal? style 'default)
1540 (set-accidentals-properties #t
1541 `(Staff ,(make-accidental-rule 'same-octave 0))
1544 ;; accidentals from one voice do NOT get canceled in other voices
1545 ((equal? style 'voice)
1546 (set-accidentals-properties #t
1547 `(Voice ,(make-accidental-rule 'same-octave 0))
1550 ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1551 ;; This includes all the default accidentals, but accidentals also needs canceling
1552 ;; in other octaves and in the next measure.
1553 ((equal? style 'modern)
1554 (set-accidentals-properties #f
1555 `(Staff ,(make-accidental-rule 'same-octave 0)
1556 ,(make-accidental-rule 'any-octave 0)
1557 ,(make-accidental-rule 'same-octave 1))
1560 ;; the accidentals that Stone adds to the old standard as cautionaries
1561 ((equal? style 'modern-cautionary)
1562 (set-accidentals-properties #f
1563 `(Staff ,(make-accidental-rule 'same-octave 0))
1564 `(Staff ,(make-accidental-rule 'any-octave 0)
1565 ,(make-accidental-rule 'same-octave 1))
1567 ;; same as modern, but accidentals different from the key signature are always
1568 ;; typeset - unless they directly follow a note of the same pitch.
1569 ((equal? style 'neo-modern)
1570 (set-accidentals-properties #f
1571 `(Staff ,(make-accidental-rule 'same-octave 0)
1572 ,(make-accidental-rule 'any-octave 0)
1573 ,(make-accidental-rule 'same-octave 1)
1574 ,neo-modern-accidental-rule)
1577 ((equal? style 'neo-modern-cautionary)
1578 (set-accidentals-properties #f
1579 `(Staff ,(make-accidental-rule 'same-octave 0))
1580 `(Staff ,(make-accidental-rule 'any-octave 0)
1581 ,(make-accidental-rule 'same-octave 1)
1582 ,neo-modern-accidental-rule)
1584 ((equal? style 'neo-modern-voice)
1585 (set-accidentals-properties #f
1586 `(Voice ,(make-accidental-rule 'same-octave 0)
1587 ,(make-accidental-rule 'any-octave 0)
1588 ,(make-accidental-rule 'same-octave 1)
1589 ,neo-modern-accidental-rule
1590 Staff ,(make-accidental-rule 'same-octave 0)
1591 ,(make-accidental-rule 'any-octave 0)
1592 ,(make-accidental-rule 'same-octave 1)
1593 ,neo-modern-accidental-rule)
1596 ((equal? style 'neo-modern-voice-cautionary)
1597 (set-accidentals-properties #f
1598 `(Voice ,(make-accidental-rule 'same-octave 0))
1599 `(Voice ,(make-accidental-rule 'any-octave 0)
1600 ,(make-accidental-rule 'same-octave 1)
1601 ,neo-modern-accidental-rule
1602 Staff ,(make-accidental-rule 'same-octave 0)
1603 ,(make-accidental-rule 'any-octave 0)
1604 ,(make-accidental-rule 'same-octave 1)
1605 ,neo-modern-accidental-rule)
1607 ;; Accidentals as they were common in dodecaphonic music with no tonality.
1608 ;; Each note gets one accidental.
1609 ((equal? style 'dodecaphonic)
1610 (set-accidentals-properties #f
1611 `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1614 ;; Multivoice accidentals to be read both by musicians playing one voice
1615 ;; and musicians playing all voices.
1616 ;; Accidentals are typeset for each voice, but they ARE canceled across voices.
1617 ((equal? style 'modern-voice)
1618 (set-accidentals-properties #f
1619 `(Voice ,(make-accidental-rule 'same-octave 0)
1620 ,(make-accidental-rule 'any-octave 0)
1621 ,(make-accidental-rule 'same-octave 1)
1622 Staff ,(make-accidental-rule 'same-octave 0)
1623 ,(make-accidental-rule 'any-octave 0)
1624 ,(make-accidental-rule 'same-octave 1))
1627 ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1629 ((equal? style 'modern-voice-cautionary)
1630 (set-accidentals-properties #f
1631 `(Voice ,(make-accidental-rule 'same-octave 0))
1632 `(Voice ,(make-accidental-rule 'any-octave 0)
1633 ,(make-accidental-rule 'same-octave 1)
1634 Staff ,(make-accidental-rule 'same-octave 0)
1635 ,(make-accidental-rule 'any-octave 0)
1636 ,(make-accidental-rule 'same-octave 1))
1638 ;; stone's suggestions for accidentals on grand staff.
1639 ;; Accidentals are canceled across the staves in the same grand staff as well
1640 ((equal? style 'piano)
1641 (set-accidentals-properties #f
1642 `(Staff ,(make-accidental-rule 'same-octave 0)
1643 ,(make-accidental-rule 'any-octave 0)
1644 ,(make-accidental-rule 'same-octave 1)
1646 ,(make-accidental-rule 'any-octave 0)
1647 ,(make-accidental-rule 'same-octave 1))
1650 ((equal? style 'piano-cautionary)
1651 (set-accidentals-properties #f
1652 `(Staff ,(make-accidental-rule 'same-octave 0))
1653 `(Staff ,(make-accidental-rule 'any-octave 0)
1654 ,(make-accidental-rule 'same-octave 1)
1656 ,(make-accidental-rule 'any-octave 0)
1657 ,(make-accidental-rule 'same-octave 1))
1660 ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1661 ;; tones specified by the key signature.
1662 ((equal? style 'teaching)
1663 (set-accidentals-properties #f
1664 `(Staff ,(make-accidental-rule 'same-octave 0))
1665 `(Staff ,(make-accidental-rule 'same-octave 1)
1666 ,teaching-accidental-rule)
1669 ;; do not set localKeySignature when a note alterated differently from
1670 ;; localKeySignature is found.
1671 ;; Causes accidentals to be printed at every note instead of
1672 ;; remembered for the duration of a measure.
1673 ;; accidentals not being remembered, causing accidentals always to
1674 ;; be typeset relative to the time signature
1675 ((equal? style 'forget)
1676 (set-accidentals-properties '()
1677 `(Staff ,(make-accidental-rule 'same-octave -1))
1680 ;; Do not reset the key at the start of a measure. Accidentals will be
1681 ;; printed only once and are in effect until overridden, possibly many
1683 ((equal? style 'no-reset)
1684 (set-accidentals-properties '()
1685 `(Staff ,(make-accidental-rule 'same-octave #t))
1689 (ly:warning (_ "unknown accidental style: ~S") style)
1690 (make-sequential-music '())))))
1692 (define-public (invalidate-alterations context)
1693 "Invalidate alterations in @var{context}.
1695 Elements of @code{'localKeySignature} corresponding to local
1696 alterations of the key signature have the form
1697 @code{'((octave . notename) . (alter barnum . measurepos))}.
1698 Replace them with a version where @code{alter} is set to @code{'clef}
1699 to force a repetition of accidentals.
1701 Entries that conform with the current key signature are not invalidated."
1702 (let* ((keysig (ly:context-property context 'keySignature)))
1703 (set! (ly:context-property context 'localKeySignature)
1706 (let* ((localalt (key-entry-alteration entry)))
1707 (if (or (accidental-invalid? localalt)
1708 (not (key-entry-bar-number entry))
1710 (key-entry-alteration
1713 (ly:make-pitch (key-entry-octave entry)
1714 (key-entry-notename entry)
1718 (cons (car entry) (cons 'clef (cddr entry))))))
1719 (ly:context-property context 'localKeySignature)))))
1721 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1723 (define-public (skip-of-length mus)
1724 "Create a skip of exactly the same length as @var{mus}."
1728 'duration (ly:make-duration 0 0))))
1730 (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1732 (define-public (mmrest-of-length mus)
1733 "Create a multi-measure rest of exactly the same length as @var{mus}."
1736 (make-multi-measure-rest
1737 (ly:make-duration 0 0) '())))
1738 (ly:music-compress skip (ly:music-length mus))
1741 (define-public (pitch-of-note event-chord)
1742 (let ((evs (filter (lambda (x)
1743 (music-has-type x 'note-event))
1744 (ly:music-property event-chord 'elements))))
1747 (ly:music-property (car evs) 'pitch))))
1749 (define-public (duration-of-note event-chord)
1751 ((pair? event-chord)
1752 (or (duration-of-note (car event-chord))
1753 (duration-of-note (cdr event-chord))))
1754 ((ly:music? event-chord)
1755 (let ((dur (ly:music-property event-chord 'duration)))
1756 (if (ly:duration? dur)
1758 (duration-of-note (ly:music-property event-chord 'elements)))))
1761 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1763 (define-public (map-some-music map? music)
1764 "Walk through @var{music}, transform all elements calling @var{map?}
1765 and only recurse if this returns @code{#f}. @code{elements} or
1766 @code{articulations} that are not music expressions are discarded:
1767 this allows some amount of filtering.
1769 @code{map-some-music} may overwrite the original @var{music}."
1770 (let loop ((music music))
1772 (let ((elt (ly:music-property music 'element))
1773 (elts (ly:music-property music 'elements))
1774 (arts (ly:music-property music 'articulations)))
1776 (set! (ly:music-property music 'element)
1779 (set! (ly:music-property music 'elements)
1780 (filter! ly:music? (map! loop elts))))
1782 (set! (ly:music-property music 'articulations)
1783 (filter! ly:music? (map! loop arts))))
1786 (define-public (for-some-music stop? music)
1787 "Walk through @var{music}, process all elements calling @var{stop?}
1788 and only recurse if this returns @code{#f}."
1789 (let loop ((music music))
1790 (if (not (stop? music))
1791 (let ((elt (ly:music-property music 'element)))
1794 (for-each loop (ly:music-property music 'elements))
1795 (for-each loop (ly:music-property music 'articulations))))))
1797 (define-public (fold-some-music pred? proc init music)
1798 "This works recursively on music like @code{fold} does on a list,
1799 calling @samp{(@var{pred?} music)} on every music element. If
1800 @code{#f} is returned for an element, it is processed recursively
1801 with the same initial value of @samp{previous}, otherwise
1802 @samp{(@var{proc} music previous)} replaces @samp{previous}
1803 and no recursion happens.
1804 The top @var{music} is processed using @var{init} for @samp{previous}."
1805 (let loop ((music music) (previous init))
1807 (proc music previous)
1810 (let ((elt (ly:music-property music 'element)))
1813 (loop elt previous)))
1814 (ly:music-property music 'elements))
1815 (ly:music-property music 'articulations)))))
1817 (define-public (extract-music music pred?)
1818 "Return a flat list of all music matching @var{pred?} inside of
1819 @var{music}, not recursing into matches themselves."
1820 (reverse! (fold-some-music pred? cons '() music)))
1822 (define-public (extract-named-music music music-name)
1823 "Return a flat list of all music named @var{music-name} (either a
1824 single event symbol or a list of alternatives) inside of @var{music},
1825 not recursing into matches themselves."
1828 (if (cheap-list? music-name)
1829 (lambda (m) (memq (ly:music-property m 'name) music-name))
1830 (lambda (m) (eq? (ly:music-property m 'name) music-name)))))
1832 (define-public (extract-typed-music music type)
1833 "Return a flat list of all music with @var{type} (either a single
1834 type symbol or a list of alternatives) inside of @var{music}, not
1835 recursing into matches themselves."
1838 (if (cheap-list? type)
1840 (any (lambda (t) (music-is-of-type? m t)) type))
1841 (lambda (m) (music-is-of-type? m type)))))
1843 (define*-public (event-chord-wrap! music #:optional parser)
1844 "Wrap isolated rhythmic events and non-postevent events in
1845 @var{music} inside of an @code{EventChord}. If the optional
1846 @var{parser} argument is given, chord repeats @samp{q} are expanded
1847 using the default settings. Otherwise, you need to cater for them
1851 (cond ((music-is-of-type? m 'event-chord)
1852 (if (pair? (ly:music-property m 'articulations))
1854 (set! (ly:music-property m 'elements)
1855 (append (ly:music-property m 'elements)
1856 (ly:music-property m 'articulations)))
1857 (set! (ly:music-property m 'articulations) '())))
1859 ((music-is-of-type? m 'rhythmic-event)
1860 (let ((arts (ly:music-property m 'articulations)))
1862 (set! (ly:music-property m 'articulations) '()))
1863 (make-event-chord (cons m arts))))
1866 (expand-repeat-chords!
1867 (cons 'rhythmic-event
1868 (ly:parser-lookup parser '$chord-repeat-events))
1872 (define-public (event-chord-notes event-chord)
1873 "Return a list of all notes from @var{event-chord}."
1875 (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1876 (ly:music-property event-chord 'elements)))
1878 (define-public (event-chord-pitches event-chord)
1879 "Return a list of all pitches from @var{event-chord}."
1880 (map (lambda (x) (ly:music-property x 'pitch))
1881 (event-chord-notes event-chord)))
1883 (defmacro-public make-relative (pitches last-pitch music)
1884 "The list of pitch-carrying variables in @var{pitches} is used as a
1885 sequence for creating relativable music from @var{music}.
1886 The variables in @var{pitches} are, when considered inside of
1887 @code{\\relative}, all considered to be specifications to the preceding
1888 variable. The first variable is relative to the preceding musical
1889 context, and @var{last-pitch} specifies the pitch passed as relative
1890 base onto the following musical context."
1892 ;; pitch and music generator might be stored instead in music
1893 ;; properties, and it might make sense to create a music type of its
1894 ;; own for this kind of construct rather than using
1895 ;; RelativeOctaveMusic
1896 (define ((make-relative::to-relative-callback pitches p->m p->p) music pitch)
1897 (let* ((chord (make-event-chord
1900 (make-music 'NoteEvent
1904 (ly:make-music-relative! chord pitch)
1905 (event-chord-pitches chord))))
1906 (set! (ly:music-property music 'element)
1907 (apply p->m pitchout))
1908 (apply p->p pitchout)))
1909 `(make-music 'RelativeOctaveMusic
1910 'to-relative-callback
1911 (,make-relative::to-relative-callback
1913 (lambda ,pitches ,music)
1914 (lambda ,pitches ,last-pitch))
1917 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1918 ;; The following functions are all associated with the crossStaff
1921 (define (close-enough? x y)
1922 "Values are close enough to ignore the difference"
1923 (< (abs (- x y)) 0.0001))
1925 (define (extent-combine extents)
1926 "Combine a list of extents"
1927 (if (pair? (cdr extents))
1928 (interval-union (car extents) (extent-combine (cdr extents)))
1931 (define ((stem-connectable? ref root) stem)
1932 "Check if the stem is connectable to the root"
1933 ;; The root is always connectable to itself
1936 ;; Horizontal positions of the stems must be almost the same
1937 (close-enough? (car (ly:grob-extent root ref X))
1938 (car (ly:grob-extent stem ref X)))
1939 ;; The stem must be in the direction away from the root's notehead
1940 (positive? (* (ly:grob-property root 'direction)
1941 (- (car (ly:grob-extent stem ref Y))
1942 (car (ly:grob-extent root ref Y))))))))
1944 (define (stem-span-stencil span)
1945 "Connect stems if we have at least one stem connectable to the root"
1946 (let* ((system (ly:grob-system span))
1947 (root (ly:grob-parent span X))
1948 (stems (filter (stem-connectable? system root)
1949 (ly:grob-object span 'stems))))
1950 (if (<= 2 (length stems))
1951 (let* ((yextents (map (lambda (st)
1952 (ly:grob-extent st system Y)) stems))
1953 (yextent (extent-combine yextents))
1954 (layout (ly:grob-layout root))
1955 (blot (ly:output-def-lookup layout 'blot-diameter)))
1956 ;; Hide spanned stems
1958 (set! (ly:grob-property st 'stencil) #f))
1960 ;; Draw a nice looking stem with rounded corners
1961 (ly:round-filled-box (ly:grob-extent root root X) yextent blot))
1962 ;; Nothing to connect, don't draw the span
1965 (define ((make-stem-span! stems trans) root)
1966 "Create a stem span as a child of the cross-staff stem (the root)"
1967 (let ((span (ly:engraver-make-grob trans 'Stem '())))
1968 (ly:grob-set-parent! span X root)
1969 (set! (ly:grob-object span 'stems) stems)
1970 ;; Suppress positioning, the stem code is confused by this weird stem
1971 (set! (ly:grob-property span 'X-offset) 0)
1972 (set! (ly:grob-property span 'stencil) stem-span-stencil)))
1974 (define-public (cross-staff-connect stem)
1975 "Set cross-staff property of the stem to this function to connect it to
1976 other stems automatically"
1979 (define (stem-is-root? stem)
1980 "Check if automatic connecting of the stem was requested. Stems connected
1981 to cross-staff beams are cross-staff, but they should not be connected to
1982 other stems just because of that."
1983 (eq? cross-staff-connect (ly:grob-property-data stem 'cross-staff)))
1985 (define (make-stem-spans! ctx stems trans)
1986 "Create stem spans for cross-staff stems"
1987 ;; Cannot do extensive checks here, just make sure there are at least
1988 ;; two stems at this musical moment
1989 (if (<= 2 (length stems))
1990 (let ((roots (filter stem-is-root? stems)))
1991 (map (make-stem-span! stems trans) roots))))
1993 (define-public (Span_stem_engraver ctx)
1994 "Connect cross-staff stems to the stems above in the system"
1997 ;; Record all stems for the given moment
1999 ((stem-interface trans grob source)
2000 (set! stems (cons grob stems))))
2001 ;; Process stems and reset the stem list to empty
2002 ((process-acknowledged trans)
2003 (make-stem-spans! ctx stems trans)
2004 (set! stems '())))))
2006 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2007 ;; The following is used by the alterBroken function.
2009 (define-public ((value-for-spanner-piece arg) grob)
2010 "Associate a piece of broken spanner @var{grob} with an element
2012 (let* ((orig (ly:grob-original grob))
2013 (siblings (ly:spanner-broken-into orig)))
2015 (define (helper sibs arg)
2018 (if (eq? (car sibs) grob)
2020 (helper (cdr sibs) (cdr arg)))))
2022 (if (>= (length siblings) 2)
2023 (helper siblings arg)
2026 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2029 (define (measure-counter-stencil grob)
2030 "Print a number for a measure count. The number is centered using
2031 the extents of @code{BreakAlignment} grobs associated with
2032 @code{NonMusicalPaperColumn} grobs. In the case of an unbroken measure, these
2033 columns are the left and right bounds of a @code{MeasureCounter} spanner.
2034 Broken measures are numbered in parentheses."
2035 (let* ((orig (ly:grob-original grob))
2036 (siblings (ly:spanner-broken-into orig)) ; have we been split?
2037 (bounds (ly:grob-array->list (ly:grob-object grob 'columns)))
2038 (refp (ly:grob-system grob))
2039 ;; we use the first and/or last NonMusicalPaperColumn grob(s) of
2040 ;; a system in the event that a MeasureCounter spanner is broken
2041 (all-cols (ly:grob-array->list (ly:grob-object refp 'columns)))
2044 (lambda (col) (eq? #t (ly:grob-property col 'non-musical)))
2047 (if (or (null? siblings) ; spanner is unbroken
2048 (eq? grob (car siblings))) ; or the first piece
2052 (if (or (null? siblings)
2053 (eq? grob (car (reverse siblings))))
2054 (car (reverse bounds))
2055 (car (reverse all-cols))))
2056 (elts-L (ly:grob-array->list (ly:grob-object left-bound 'elements)))
2057 (elts-R (ly:grob-array->list (ly:grob-object right-bound 'elements)))
2060 (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2064 (lambda (elt) (grob::has-interface elt 'break-alignment-interface))
2066 (break-alignment-L-ext (ly:grob-extent (car break-alignment-L) refp X))
2067 (break-alignment-R-ext (ly:grob-extent (car break-alignment-R) refp X))
2068 (num (markup (number->string (ly:grob-property grob 'count-from))))
2070 (if (or (null? siblings)
2071 (eq? grob (car siblings)))
2073 (make-parenthesize-markup num)))
2074 (num (grob-interpret-markup grob num))
2075 (num (ly:stencil-aligned-to num X (ly:grob-property grob 'self-alignment-X)))
2077 (ly:stencil-translate-axis
2079 (+ (interval-length break-alignment-L-ext)
2081 (- (car break-alignment-R-ext)
2082 (cdr break-alignment-L-ext))))