X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fmusic-functions.scm;fp=scm%2Fmusic-functions.scm;h=8d828db8694c2fdb3ac7c8b1cf7876715b128c15;hb=941dff9d2a67080e0dd8474f1e70f0c72ace6424;hp=8edb6586270efe444476505a5cd5871077147419;hpb=5a22d6233a39d3164e1ca043244794c268be4ad0;p=lilypond.git diff --git a/scm/music-functions.scm b/scm/music-functions.scm index 8edb658627..8d828db869 100644 --- a/scm/music-functions.scm +++ b/scm/music-functions.scm @@ -1,11 +1,22 @@ -;;;; music-functions.scm -- +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 1998--2009 Jan Nieuwenhuizen +;;;; Copyright (C) 1998--2011 Jan Nieuwenhuizen ;;;; Han-Wen Nienhuys +;;;; +;;;; LilyPond is free software: you can redistribute it and/or modify +;;;; it under the terms of the GNU General Public License as published by +;;;; the Free Software Foundation, either version 3 of the License, or +;;;; (at your option) any later version. +;;;; +;;;; LilyPond is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with LilyPond. If not, see . -;; (use-modules (ice-9 optargs)) +;; (use-modules (ice-9 optargs)) ;;; ly:music-property with setter ;;; (ly:music-property my-music 'elements) @@ -25,18 +36,30 @@ (make-procedure-with-setter ly:grob-property ly:grob-set-property!)) +(define-public ly:grob-object + (make-procedure-with-setter ly:grob-object + ly:grob-set-object!)) + +(define-public ly:grob-parent + (make-procedure-with-setter ly:grob-parent + ly:grob-set-parent!)) + (define-public ly:prob-property (make-procedure-with-setter ly:prob-property ly:prob-set-property!)) +(define-public ly:context-property + (make-procedure-with-setter ly:context-property + ly:context-set-property!)) + (define-public (music-map function music) "Apply @var{function} to @var{music} and all of the music it contains. -First it recurses over the children, then the function is applied to MUSIC. -" +First it recurses over the children, then the function is applied to +@var{music}." (let ((es (ly:music-property music 'elements)) (e (ly:music-property music 'element))) - (set! (ly:music-property music 'elements) + (set! (ly:music-property music 'elements) (map (lambda (y) (music-map function y)) es)) (if (ly:music? e) (set! (ly:music-property music 'element) @@ -44,8 +67,8 @@ First it recurses over the children, then the function is applied to MUSIC. (function music))) (define-public (music-filter pred? music) - "Filter out music expressions that do not satisfy PRED." - + "Filter out music expressions that do not satisfy @var{pred?}." + (define (inner-music-filter pred? music) "Recursive function." (let* ((es (ly:music-property music 'elements)) @@ -73,10 +96,11 @@ First it recurses over the children, then the function is applied to MUSIC. (make-music 'Music))) ;must return music. (define-public (display-music music) - "Display music, not done with music-map for clarity of presentation." + "Display music, not done with @code{music-map} for clarity of +presentation." (display music) - (display ": { ") + (display ": { ") (let ((es (ly:music-property music 'elements)) (e (ly:music-property music 'element))) (display (ly:music-mutable-properties music)) @@ -96,7 +120,7 @@ First it recurses over the children, then the function is applied to MUSIC. ;;; (define (markup-expression->make-markup markup-expression) "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression. -For instance, +For instance, \\markup \\bold \\italic hello ==> (markup #:line (#:bold (#:italic (#:simple \"hello\"))))" @@ -111,7 +135,7 @@ For instance, ((and (not (string? arg)) (markup? arg)) ;; a markup (inner-markup->make-markup arg)) (else ;; scheme arg - arg))) + (music->make-music arg)))) (define (inner-markup->make-markup mrkup) (if (string? mrkup) `(#:simple ,mrkup) @@ -124,14 +148,15 @@ For instance, `(markup ,@(inner-markup->make-markup markup-expression)))) (define-public (music->make-music obj) - "Generate a expression that, once evaluated, may return an object equivalent to `obj', -that is, for a music expression, a (make-music ...) form." + "Generate an expression that, once evaluated, may return an object +equivalent to @var{obj}, that is, for a music expression, a +@code{(make-music ...)} form." (cond (;; markup expression (markup? obj) (markup-expression->make-markup obj)) (;; music expression (ly:music? obj) - `(make-music + `(make-music ',(ly:music-property obj 'name) ,@(apply append (map (lambda (prop) `(',(car prop) @@ -170,7 +195,7 @@ that is, for a music expression, a (make-music ...) form." `(list ,@(map music->make-music obj))) (;; a pair (pair? obj) - `(cons ,(music->make-music (car obj)) + `(cons ,(music->make-music (car obj)) ,(music->make-music (cdr obj)))) (else obj))) @@ -204,9 +229,9 @@ Returns `obj'. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define-public (shift-one-duration-log music shift dot) - " add SHIFT to duration-log of 'duration in music and optionally - a dot to any note encountered. This scales the music up by a factor - 2^shift * (2 - (1/2)^dot)" + "Add @var{shift} to @code{duration-log} of @code{'duration} in +@var{music} and optionally @var{dot} to any note encountered. This +scales the music up by a factor `2^@var{shift} * (2 - (1/2)^@var{dot})'." (let ((d (ly:music-property music 'duration))) (if (ly:duration? d) (let* ((cp (ly:duration-factor d)) @@ -222,7 +247,8 @@ Returns `obj'. music)) (define-public (make-repeat name times main alts) - "create a repeat music expression, with all properties initialized properly" + "Create a repeat music expression, with all properties initialized +properly." (define (first-note-duration music) "Finds the duration of the first NoteEvent by searching depth-first through MUSIC." @@ -246,9 +272,20 @@ through MUSIC." (set! (ly:music-property r 'element) main) (set! (ly:music-property r 'repeat-count) (max times 1)) (set! (ly:music-property r 'elements) talts) - (if (equal? name "tremolo") - (let* ((dots (1- (logcount times))) - (mult (/ (* times (ash 1 dots)) (1- (ash 2 dots)))) + (if (and (equal? name "tremolo") + (or (pair? (ly:music-property main 'elements)) + (ly:music? (ly:music-property main 'element)))) + ;; This works for single-note and multi-note tremolos! + (let* ((children (if (music-is-of-type? main 'sequential-music) + ;; \repeat tremolo n { ... } + (length (extract-named-music main 'EventChord)) + ;; \repeat tremolo n c4 + 1)) + ;; # of dots is equal to the 1 in bitwise representation (minus 1)! + (dots (1- (logcount (* times children)))) + ;; The remaining missing multiplicator to scale the notes by + ;; times * children + (mult (/ (* times children (ash 1 dots)) (1- (ash 2 dots)))) (shift (- (ly:intlog2 (floor mult)))) (note-duration (first-note-duration r)) (duration-log (if (ly:duration? note-duration) @@ -258,27 +295,31 @@ through MUSIC." (set! (ly:music-property r 'tremolo-type) tremolo-type) (if (not (integer? mult)) (ly:warning (_ "invalid tremolo repeat count: ~a") times)) - (if (memq 'sequential-music (ly:music-property main 'types)) - ;; \repeat "tremolo" { c4 d4 } - (let ((children (length (ly:music-property main 'elements)))) - - ;; fixme: should be more generic. - (if (and (not (= children 2)) - (not (= children 1))) - (ly:warning (_ "expecting 2 elements for chord tremolo, found ~a") children)) - (ly:music-compress r (ly:make-moment 1 children)) - (shift-duration-log r - (if (= children 2) (1- shift) shift) - dots)) - ;; \repeat "tremolo" c4 - (shift-duration-log r shift dots))) + ;; Adjust the time of the notes + (ly:music-compress r (ly:make-moment 1 children)) + ;; Adjust the displayed note durations + (shift-duration-log r shift dots)) r))) +(define (calc-repeat-slash-count music) + "Given the child-list @var{music} in @code{PercentRepeatMusic}, +calculate the number of slashes based on the durations. Returns @code{0} +if durations in @var{music} vary, allowing slash beats and double-percent +beats to be distinguished." + (let* ((durs (map (lambda (elt) + (duration-of-note elt)) + (extract-named-music music 'EventChord))) + (first-dur (car durs))) + + (if (every (lambda (d) (equal? d first-dur)) durs) + (max (- (ly:duration-log first-dur) 2) 1) + 0))) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; clusters. (define-public (note-to-cluster music) - "Replace NoteEvents by ClusterNoteEvents." + "Replace @code{NoteEvents} by @code{ClusterNoteEvents}." (if (eq? (ly:music-property music 'name) 'NoteEvent) (make-music 'ClusterNoteEvent 'pitch (ly:music-property music 'pitch) @@ -292,39 +333,38 @@ through MUSIC." ;; repeats. (define-public (unfold-repeats music) - " -This function replaces all repeats with unfold repeats. " + "Replace all repeats with unfolded repeats." (let ((es (ly:music-property music 'elements)) - (e (ly:music-property music 'element)) - ) - (if (memq 'repeated-music (ly:music-property music 'types)) - (let* - ((props (ly:music-mutable-properties music)) - (old-name (ly:music-property music 'name)) - (flattened (flatten-alist props))) + (e (ly:music-property music 'element))) + (if (memq 'repeated-music (ly:music-property music 'types)) + (let* ((props (ly:music-mutable-properties music)) + (old-name (ly:music-property music 'name)) + (flattened (flatten-alist props))) (set! music (apply make-music (cons 'UnfoldedRepeatedMusic flattened))) (if (equal? old-name 'TremoloRepeatedMusic) (let* ((seq-arg? (memq 'sequential-music (ly:music-property e 'types))) - (count (ly:music-property music 'repeat-count)) + (count (ly:music-property music 'repeat-count)) (dot-shift (if (= 0 (remainder count 3)) - -1 0))) + -1 0)) + (child-count (if seq-arg? + (length (ly:music-property e 'elements)) + 0))) (if (= 0 -1) (set! count (* 2 (quotient count 3)))) - - (shift-duration-log music (+ (if seq-arg? 1 0) + + (shift-duration-log music (+ (if (= 2 child-count) + 1 0) (ly:intlog2 count)) dot-shift) - + (if seq-arg? - (ly:music-compress e (ly:make-moment (length (ly:music-property - e 'elements)) 1))))))) - - + (ly:music-compress e (ly:make-moment child-count 1))))))) + (if (pair? es) (set! (ly:music-property music 'elements) (map unfold-repeats es))) @@ -337,8 +377,8 @@ This function replaces all repeats with unfold repeats. " ;; property setting music objs. (define-public (make-grob-property-set grob gprop val) - "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first, -i.e. this is not an override" + "Make a @code{Music} expression that sets @var{gprop} to @var{val} in +@var{grob}. Does a pop first, i.e., this is not an override." (make-music 'OverrideProperty 'symbol grob 'grob-property gprop @@ -346,15 +386,15 @@ i.e. this is not an override" 'pop-first #t)) (define-public (make-grob-property-override grob gprop val) - "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first, -i.e. this is not an override" + "Make a @code{Music} expression that overrides @var{gprop} to @var{val} +in @var{grob}." (make-music 'OverrideProperty 'symbol grob 'grob-property gprop 'grob-value val)) (define-public (make-grob-property-revert grob gprop) - "Revert the grob property GPROP for GROB." + "Revert the grob property @var{gprop} for @var{grob}." (make-music 'RevertProperty 'symbol grob 'grob-property gprop)) @@ -384,15 +424,20 @@ i.e. this is not an override" ;; TODO: take this from voicedGraceSettings or similar. '((Voice Stem font-size -3) (Voice NoteHead font-size -3) + (Voice TabNoteHead font-size -4) (Voice Dots font-size -3) (Voice Stem length-fraction 0.8) (Voice Stem no-stem-extend #t) - (Voice Beam thickness 0.384) + (Voice Beam beam-thickness 0.384) (Voice Beam length-fraction 0.8) - (Voice Accidental font-size -4))) - + (Voice Accidental font-size -4) + (Voice AccidentalCautionary font-size -4) + (Voice Script font-size -3) + (Voice Fingering font-size -8) + (Voice StringNumber font-size -8))) + (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2)) - (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4)))))) + (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4)))))) (define-safe-public (make-voice-props-revert) (make-sequential-music @@ -405,7 +450,7 @@ i.e. this is not an override" (define-safe-public (context-spec-music m context #:optional id) - "Add \\context CONTEXT = ID to M. " + "Add \\context CONTEXT = ID to M." (let ((cm (make-music 'ContextSpeccedMusic 'element m 'context-type context))) @@ -414,7 +459,7 @@ i.e. this is not an override" cm)) (define-public (descend-to-context m context) - "Like context-spec-music, but only descending. " + "Like @code{context-spec-music}, but only descending." (let ((cm (context-spec-music m context))) (ly:music-set-property! cm 'descend-only #t) cm)) @@ -464,80 +509,23 @@ i.e. this is not an override" (make-music 'PropertyUnset 'symbol sym)) -(define-public (make-ottava-set octavation) - (let ((m (make-music 'ApplyContext))) - (define (ottava-modify context) - "Either reset middleCPosition to the stored original, or remember -old middleCPosition, add OCTAVATION to middleCPosition, and set -OTTAVATION to `8va', or whatever appropriate." - (if (number? (ly:context-property context 'middleCOffset)) - (let ((where (ly:context-property-where-defined context 'middleCOffset))) - (ly:context-unset-property where 'middleCOffset) - (ly:context-unset-property where 'ottavation))) - - (let* ((offset (* -7 octavation)) - (string (cdr (assoc octavation '((2 . "15ma") - (1 . "8va") - (0 . #f) - (-1 . "8vb") - (-2 . "15mb")))))) - (ly:context-set-property! context 'middleCOffset offset) - (ly:context-set-property! context 'ottavation string) - (ly:set-middle-C! context))) - (set! (ly:music-property m 'procedure) ottava-modify) - (context-spec-music m 'Staff))) - -(define-public (set-octavation ottavation) - (ly:export (make-ottava-set ottavation))) - -(define-public (make-time-signature-set num den . rest) - "Set properties for time signature NUM/DEN. Rest can contain a list -of beat groupings " - - (define (standard-beat-grouping num den) - - "Some standard subdivisions for time signatures." - (let* - ((key (cons num den)) - (entry (assoc key '(((6 . 8) . (3 3)) - ((5 . 8) . (3 2)) - ((9 . 8) . (3 3 3)) - ((12 . 8) . (3 3 3 3)) - ((8 . 8) . (3 3 2)) - )))) - - (if entry - (cdr entry) - '()))) - - (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den))) - (beat (ly:make-moment 1 den)) - (len (ly:make-moment num den)) - (set2 (make-property-set 'beatLength beat)) - (set3 (make-property-set 'measureLength len)) - (set4 (make-property-set 'beatGrouping (if (pair? rest) - (car rest) - (standard-beat-grouping num den)))) - (basic (list set1 set2 set3 set4))) - (descend-to-context - (context-spec-music (make-sequential-music basic) 'Timing) 'Score))) - -(define-public (make-mark-set label) - "Make the music for the \\mark command." - (let* ((set (if (integer? label) - (context-spec-music (make-property-set 'rehearsalMark label) - 'Score) - #f)) - (ev (make-music 'MarkEvent)) - (ch (make-event-chord (list ev)))) - (if set - (make-sequential-music (list set ch)) - (begin - (set! (ly:music-property ev 'label) label) - ch)))) +;;; Need to keep this definition for \time calls from parser +(define-public (make-time-signature-set num den) + "Set properties for time signature @var{num}/@var{den}." + (make-music 'TimeSignatureMusic + 'numerator num + 'denominator den + 'beat-structure '())) +;;; Used for calls that include beat-grouping setting (define-public (set-time-signature num den . rest) - (ly:export (apply make-time-signature-set `(,num ,den . ,rest)))) + "Set properties for time signature @var{num}/@var{den}. +If @var{rest} is present, it is used to set @code{beatStructure}." + (ly:export + (make-music 'TimeSignatureMusic + 'numerator num + 'denominator den + 'beat-structure (if (null? rest) rest (car rest))))) (define-safe-public (make-articulation name) (make-music 'ArticulationEvent @@ -552,15 +540,50 @@ of beat groupings " (make-music type 'span-direction span-dir)) -(define-public (set-mus-properties! m alist) - "Set all of ALIST as properties of M." +(define-public (override-head-style heads style) + "Override style for @var{heads} to @var{style}." + (make-sequential-music + (if (pair? heads) + (map (lambda (h) + (make-grob-property-override h 'style style)) + heads) + (list (make-grob-property-override heads 'style style))))) + +(define-public (revert-head-style heads) + "Revert style for @var{heads}." + (make-sequential-music + (if (pair? heads) + (map (lambda (h) + (make-grob-property-revert h 'style)) + heads) + (list (make-grob-property-revert heads 'style))))) + +(define-public (style-note-heads heads style music) + "Set @var{style} for all @var{heads} in @var{music}. Works both +inside of and outside of chord construct." + ;; are we inside a <...>? + (if (eq? (ly:music-property music 'name) 'NoteEvent) + ;; yes -> use a tweak + (begin + (set! (ly:music-property music 'tweaks) + (acons 'style style (ly:music-property music 'tweaks))) + music) + ;; not in <...>, so use overrides + (make-sequential-music + (list + (override-head-style heads style) + music + (revert-head-style heads))))) + + (define-public (set-mus-properties! m alist) + "Set all of @var{alist} as properties of @var{m}." (if (pair? alist) (begin (set! (ly:music-property m (caar alist)) (cdar alist)) (set-mus-properties! m (cdr alist))))) (define-public (music-separator? m) - "Is M a separator?" + "Is @var{m} a separator?" (let ((ts (ly:music-property m 'types))) (memq 'separator ts))) @@ -568,10 +591,10 @@ of beat groupings " (define (voicify-list lst number) "Make a list of Musics. - voicify-list :: [ [Music ] ] -> number -> [Music] - LST is a list music-lists. +voicify-list :: [ [Music ] ] -> number -> [Music] +LST is a list music-lists. - NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0. +NUMBER is 0-base, i.e., Voice=1 (upstems) has number 0. " (if (null? lst) '() @@ -579,7 +602,7 @@ of beat groupings " (make-sequential-music (list (make-voice-props-set number) (make-simultaneous-music (car lst)))) - 'Voice (number->string (1+ number))) + 'Bottom (number->string (1+ number))) (voicify-list (cdr lst) (1+ number))))) (define (voicify-chord ch) @@ -590,7 +613,7 @@ of beat groupings " ch)) (define-public (voicify-music m) - "Recursively split chords that are separated with \\ " + "Recursively split chords that are separated with @code{\\\\}." (if (not (ly:music? m)) (ly:error (_ "music expected: ~S") m)) (let ((es (ly:music-property m 'elements)) @@ -608,12 +631,10 @@ of beat groupings " (define-public (empty-music) (ly:export (make-music 'Music))) -;; Make a function that checks score element for being of a specific type. +;; Make a function that checks score element for being of a specific type. (define-public (make-type-checker symbol) (lambda (elt) - ;;(display symbol) - ;;(eq? #t (ly:grob-property elt symbol)) - (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces)))))) + (grob::has-interface elt symbol))) (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context) (if (func grob) @@ -621,25 +642,20 @@ of beat groupings " (define-public ((set-output-property grob-name symbol val) grob grob-c context) - "Usage: - -\\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1)) - -" + "Usage example: +@code{\\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))}" (let ((meta (ly:grob-property grob 'meta))) - (if (equal? (cdr (assoc 'name meta)) grob-name) + (if (equal? (assoc-get 'name meta) grob-name) (set! (ly:grob-property grob symbol) val)))) ;; (define-public (smart-bar-check n) - "Make a bar check that checks for a specific bar number. -" + "Make a bar check that checks for a specific bar number." (let ((m (make-music 'ApplyContext))) (define (checker tr) (let* ((bn (ly:context-property tr 'currentBarNumber))) - (if (= bn n) - #t + (or (= bn n) (ly:error ;; FIXME: uncomprehensable message (_ "Bar check failed. Expect to be at ~a, instead at ~a") @@ -649,9 +665,8 @@ of beat groupings " (define-public (skip->rest mus) - - "Replace MUS by RestEvent of the same duration if it is a -SkipEvent. Useful for extracting parts from crowded scores" + "Replace @var{mus} by @code{RestEvent} of the same duration if it is a +@code{SkipEvent}. Useful for extracting parts from crowded scores." (if (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic)) (make-music 'RestEvent 'duration (ly:music-property mus 'duration)) @@ -697,20 +712,20 @@ SkipEvent. Useful for extracting parts from crowded scores" nv)) (define (vector-map f v) - "Map F over V. This function returns nothing." + "Map F over V. This function returns nothing." (do ((n (vector-length v)) (i 0 (+ i 1))) ((>= i n)) (f (vector-ref v i)))) (define (vector-reverse-map f v) - "Map F over V, N to 0 order. This function returns nothing." + "Map F over V, N to 0 order. This function returns nothing." (do ((i (- (vector-length v) 1) (- i 1))) ((< i 0)) (f (vector-ref v i)))) (define-public (add-grace-property context-name grob sym val) - "Set SYM=VAL for GROB in CONTEXT-NAME. " + "Set @var{sym}=@var{val} for @var{grob} in @var{context-name}." (define (set-prop context) (let* ((where (ly:context-property-where-defined context 'graceSettings)) (current (ly:context-property where 'graceSettings)) @@ -720,7 +735,7 @@ SkipEvent. Useful for extracting parts from crowded scores" (ly:export (context-spec-music (make-apply-context set-prop) 'Voice))) (define-public (remove-grace-property context-name grob sym) - "Remove all SYM for GROB in CONTEXT-NAME. " + "Remove all @var{sym} for @var{grob} in @var{context-name}." (define (sym-grob-context? property sym grob context-name) (and (eq? (car property) context-name) (eq? (cadr property) grob) @@ -728,11 +743,11 @@ SkipEvent. Useful for extracting parts from crowded scores" (define (delete-prop context) (let* ((where (ly:context-property-where-defined context 'graceSettings)) (current (ly:context-property where 'graceSettings)) - (prop-settings (filter + (prop-settings (filter (lambda(x) (sym-grob-context? x sym grob context-name)) - current)) + current)) (new-settings current)) - (for-each (lambda(x) + (for-each (lambda(x) (set! new-settings (delete x new-settings))) prop-settings) (ly:context-set-property! where 'graceSettings new-settings))) @@ -774,29 +789,35 @@ Syntax: ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define-public (cue-substitute quote-music) - "Must happen after quote-substitute." - + "Must happen after @code{quote-substitute}." + (if (vector? (ly:music-property quote-music 'quoted-events)) (let* ((dir (ly:music-property quote-music 'quoted-voice-direction)) + (clef (ly:music-property quote-music 'quoted-music-clef)) (main-voice (if (eq? 1 dir) 1 0)) (cue-voice (if (eq? 1 dir) 0 1)) (main-music (ly:music-property quote-music 'element)) (return-value quote-music)) (if (or (eq? 1 dir) (eq? -1 dir)) - + ;; if we have stem dirs, change both quoted and main music ;; to have opposite stems. (begin (set! return-value - ;; cannot context-spec Quote-music, since context ;; for the quotes is determined in the iterator. (make-sequential-music (list + (if (null? clef) + (make-music 'Music) + (make-cue-clef-set clef)) (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue") quote-music - (context-spec-music (make-voice-props-revert) 'CueVoice "cue")))) + (context-spec-music (make-voice-props-revert) 'CueVoice "cue") + (if (null? clef) + (make-music 'Music) + (make-cue-clef-unset))))) (set! main-music (make-sequential-music (list @@ -810,11 +831,10 @@ Syntax: (define-public ((quote-substitute quote-tab) music) (let* ((quoted-name (ly:music-property music 'quoted-music-name)) - (quoted-vector (if (string? quoted-name) - (hash-ref quote-tab quoted-name #f) - #f))) + (quoted-vector (and (string? quoted-name) + (hash-ref quote-tab quoted-name #f)))) + - (if (string? quoted-name) (if (vector? quoted-vector) (begin @@ -841,7 +861,7 @@ Syntax: (if (and (ly:music? m) (eq? (ly:music-property m 'error-found) #t)) (set! found #t))) - + (for-each signal (ly:music-property music 'elements)) (signal (ly:music-property music 'element)) @@ -855,37 +875,26 @@ Syntax: music) (define-public (make-duration-of-length moment) - "Make duration of the given MOMENT length." + "Make duration of the given @code{moment} length." (ly:make-duration 0 0 (ly:moment-main-numerator moment) (ly:moment-main-denominator moment))) -(define (skip-this moment) - "set skipTypesetting, make SkipMusic of the given MOMENT length, - and then unset skipTypesetting." - (make-sequential-music - (list - (context-spec-music (make-property-set 'skipTypesetting #t) - 'Score) - (make-music 'SkipMusic 'duration - (make-duration-of-length moment)) - (context-spec-music (make-property-set 'skipTypesetting #f) - 'Score)))) - -(define (unskip-this moment) - "unset skipTypesetting, make SkipMusic of the given MOMENT length, - and then set skipTypesetting." +(define (make-skipped moment bool) + "Depending on BOOL, set or unset skipTypesetting, +then make SkipMusic of the given MOMENT length, and +then revert skipTypesetting." (make-sequential-music (list - (context-spec-music (make-property-set 'skipTypesetting #f) + (context-spec-music (make-property-set 'skipTypesetting bool) 'Score) (make-music 'SkipMusic 'duration (make-duration-of-length moment)) - (context-spec-music (make-property-set 'skipTypesetting #t) + (context-spec-music (make-property-set 'skipTypesetting (not bool)) 'Score)))) (define (skip-as-needed music parser) - "Replace MUSIC by + "Replace MUSIC by << { \\set skipTypesetting = ##f LENGTHOF(\\showFirstLength) \\set skipTypesetting = ##t @@ -896,51 +905,54 @@ Syntax: When only showFirstLength is set, the 'length property of the music is overridden to speed up compiling." - (let* - ((show-last (ly:parser-lookup parser 'showLastLength)) - (show-first (ly:parser-lookup parser 'showFirstLength))) - (cond - - ;; both properties may be set. - ((and (ly:music? show-first) (ly:music? show-last)) - (let* - ((orig-length (ly:music-length music)) - (skip-length (ly:moment-sub orig-length (ly:music-length show-last))) - (begin-length (ly:music-length show-first))) - (make-simultaneous-music - (list - (make-sequential-music - (list - (skip-this skip-length) - ;; let's draw a separator between the beginning and the end - (context-spec-music (make-property-set 'whichBar "||") - 'Timing))) - (unskip-this begin-length) - music)))) - - ;; we may only want to print the last length - ((ly:music? show-last) - (let* - ((orig-length (ly:music-length music)) - (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))) - (make-simultaneous-music - (list - (skip-this skip-length) - music)))) - - ;; we may only want to print the beginning; in this case - ;; only the first length will be processed (much faster). - ((ly:music? show-first) - (let* - ((orig-length (ly:music-length music)) - (begin-length (ly:music-length show-first))) - ;; the first length must not exceed the original length. - (if (ly:moment (* prev-alt this-alt) 0))) (set! need-restore #t)))))) (cons need-restore need-accidental))) (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos) - "Creates an accidental rule that makes its decision based on the octave of the note - and a laziness value. - octaveness is either 'same-octave or 'any-octave and defines whether the rule should - respond to accidental changes in other octaves than the current. 'same-octave is the - normal way to typeset accidentals - an accidental is made if the alteration is different - from the last active pitch in the same octave. 'any-octave looks at the last active pitch - in any octave. - laziness states over how many bars an accidental should be remembered. - 0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure. - A positive integer means that the accidental lasts over that many bar lines. - -1 is 'forget immediately', that is, only look at key signature. - #t is forever." + "Create an accidental rule that makes its decision based on the octave of +the note and a laziness value. + +@var{octaveness} is either @code{'same-octave} or @code{'any-octave} and +defines whether the rule should respond to accidental changes in other +octaves than the current. @code{'same-octave} is the normal way to typeset +accidentals -- an accidental is made if the alteration is different from the +last active pitch in the same octave. @code{'any-octave} looks at the last +active pitch in any octave. + +@var{laziness} states over how many bars an accidental should be remembered. +@code{0}@tie{}is the default -- accidental lasts over 0@tie{}bar lines, that +is, to the end of current measure. A positive integer means that the +accidental lasts over that many bar lines. @code{-1} is `forget +immediately', that is, only look at key signature. @code{#t} is `forever'." + (check-pitch-against-signature context pitch barnum laziness octaveness)) (define (key-entry-notename entry) - "Return the pitch of an entry in localKeySignature. The entry is either of the form + "Return the pitch of an entry in localKeySignature. The entry is either of the form '(notename . alter) or '((octave . notename) . (alter barnum . measurepos))." (if (number? (car entry)) (car entry) @@ -1121,42 +1141,43 @@ specifies whether accidentals should be canceled in different octaves." (and (pair? (car entry)) (cdddr entry))) (define (key-entry-alteration entry) - "Return the alteration of an entry in localKeySignature." - (if (number? (car entry)) - (cdr entry) - (cadr entry))) + "Return the alteration of an entry in localKeySignature. + +For convenience, returns @code{0} if entry is @code{#f}." + (if entry + (if (number? (car entry)) + (cdr entry) + (cadr entry)) + 0)) (define-public (find-pitch-entry keysig pitch accept-global accept-local) - "Return the first entry in keysig that matches the pitch. - accept-global states whether key signature entries should be included. - accept-local states whether local accidentals should be included. - if no matching entry is found, #f is returned." - (if (pair? keysig) - (let* ((entry (car keysig)) - (entryoct (key-entry-octave entry)) - (entrynn (key-entry-notename entry)) - (oct (ly:pitch-octave pitch)) - (nn (ly:pitch-notename pitch))) - (if (and (equal? nn entrynn) - (or (and accept-global (equal? #f entryoct)) - (and accept-local (equal? oct entryoct)))) - entry - (find-pitch-entry (cdr keysig) pitch accept-global accept-local))) - #f)) + "Return the first entry in @var{keysig} that matches @var{pitch}. +@var{accept-global} states whether key signature entries should be included. +@var{accept-local} states whether local accidentals should be included. +If no matching entry is found, @var{#f} is returned." + (and (pair? keysig) + (let* ((entry (car keysig)) + (entryoct (key-entry-octave entry)) + (entrynn (key-entry-notename entry)) + (oct (ly:pitch-octave pitch)) + (nn (ly:pitch-notename pitch))) + (if (and (equal? nn entrynn) + (or (and accept-global (not entryoct)) + (and accept-local (equal? oct entryoct)))) + entry + (find-pitch-entry (cdr keysig) pitch accept-global accept-local))))) (define-public (neo-modern-accidental-rule context pitch barnum measurepos) - "an accidental rule that typesets an accidental if it differs from the key signature - AND does not directly follow a note on the same staff-line. - This rule should not be used alone because it does neither look at bar lines - nor different accidentals at the same notename" + "An accidental rule that typesets an accidental if it differs from the +key signature @emph{and} does not directly follow a note on the same +staff line. This rule should not be used alone because it does neither +look at bar lines nor different accidentals at the same note name." (let* ((keysig (ly:context-property context 'localKeySignature)) (entry (find-pitch-entry keysig pitch #t #t))) - (if (equal? #f entry) + (if (not entry) (cons #f #f) (let* ((global-entry (find-pitch-entry keysig pitch #t #f)) - (key-acc (if (equal? global-entry #f) - 0 - (key-entry-alteration global-entry))) + (key-acc (key-entry-alteration global-entry)) (acc (ly:pitch-alteration pitch)) (entrymp (key-entry-measure-position entry)) (entrybn (key-entry-bar-number entry))) @@ -1164,17 +1185,15 @@ specifies whether accidentals should be canceled in different octaves." (and (equal? entrybn barnum) (equal? entrymp measurepos))))))))) (define-public (teaching-accidental-rule context pitch barnum measurepos) - "an accidental rule that typesets a cautionary accidental - if it is included in the key signature AND does not directly follow - a note on the same staff-line." + "An accidental rule that typesets a cautionary accidental if it is +included in the key signature @emph{and} does not directly follow a note +on the same staff line." (let* ((keysig (ly:context-property context 'localKeySignature)) (entry (find-pitch-entry keysig pitch #t #t))) - (if (equal? #f entry) + (if (not entry) (cons #f #f) (let* ((global-entry (find-pitch-entry keysig pitch #f #f)) - (key-acc (if (equal? global-entry #f) - 0 - (key-entry-alteration global-entry))) + (key-acc (key-entry-alteration global-entry)) (acc (ly:pitch-alteration pitch)) (entrymp (key-entry-measure-position entry)) (entrybn (key-entry-bar-number entry))) @@ -1194,9 +1213,10 @@ specifies whether accidentals should be canceled in different octaves." context)) (define-public (set-accidental-style style . rest) - "Set accidental style to STYLE. Optionally takes a context argument, -e.g. 'Staff or 'Voice. The context defaults to Staff, except for piano styles, which -use GrandStaff as a context. " + "Set accidental style to @var{style}. Optionally take a context +argument, e.g. @code{'Staff} or @code{'Voice}. The context defaults +to @code{Staff}, except for piano styles, which use @code{GrandStaff} +as a context." (let ((context (if (pair? rest) (car rest) 'Staff)) (pcontext (if (pair? rest) @@ -1249,6 +1269,29 @@ use GrandStaff as a context. " ,(make-accidental-rule 'same-octave 1) ,neo-modern-accidental-rule) context)) + ((equal? style 'neo-modern-voice) + (set-accidentals-properties #f + `(Voice ,(make-accidental-rule 'same-octave 0) + ,(make-accidental-rule 'any-octave 0) + ,(make-accidental-rule 'same-octave 1) + ,neo-modern-accidental-rule + Staff ,(make-accidental-rule 'same-octave 0) + ,(make-accidental-rule 'any-octave 0) + ,(make-accidental-rule 'same-octave 1) + ,neo-modern-accidental-rule) + '() + context)) + ((equal? style 'neo-modern-voice-cautionary) + (set-accidentals-properties #f + `(Voice ,(make-accidental-rule 'same-octave 0)) + `(Voice ,(make-accidental-rule 'any-octave 0) + ,(make-accidental-rule 'same-octave 1) + ,neo-modern-accidental-rule + Staff ,(make-accidental-rule 'same-octave 0) + ,(make-accidental-rule 'any-octave 0) + ,(make-accidental-rule 'same-octave 1) + ,neo-modern-accidental-rule) + context)) ;; Accidentals as they were common in dodecaphonic music with no tonality. ;; Each note gets one accidental. ((equal? style 'dodecaphonic) @@ -1303,14 +1346,14 @@ use GrandStaff as a context. " pcontext)) ;; same as modern, but cautionary accidentals are printed for all sharp or flat - ;; tones specified by the key signature. + ;; tones specified by the key signature. ((equal? style 'teaching) (set-accidentals-properties #f `(Staff ,(make-accidental-rule 'same-octave 0)) `(Staff ,(make-accidental-rule 'same-octave 1) ,teaching-accidental-rule) context)) - + ;; do not set localKeySignature when a note alterated differently from ;; localKeySignature is found. ;; Causes accidentals to be printed at every note instead of @@ -1334,10 +1377,40 @@ use GrandStaff as a context. " (ly:warning (_ "unknown accidental style: ~S") style) (make-sequential-music '())))))) +(define-public (invalidate-alterations context) + "Invalidate alterations in @var{context}. + +Elements of @code{'localKeySignature} corresponding to local +alterations of the key signature have the form +@code{'((octave . notename) . (alter barnum . measurepos))}. +Replace them with a version where @code{alter} is set to @code{'clef} +to force a repetition of accidentals. + +Entries that conform with the current key signature are not invalidated." + (let* ((keysig (ly:context-property context 'keySignature))) + (set! (ly:context-property context 'localKeySignature) + (map-in-order + (lambda (entry) + (let* ((localalt (key-entry-alteration entry)) + (localoct (key-entry-octave entry))) + (if (or (accidental-invalid? localalt) + (not localoct) + (= localalt + (key-entry-alteration + (find-pitch-entry + keysig + (ly:make-pitch localoct + (key-entry-notename entry) + 0) + #t #t)))) + entry + (cons (car entry) (cons 'clef (cddr entry)))))) + (ly:context-property context 'localKeySignature))))) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define-public (skip-of-length mus) - "Create a skip of exactly the same length as MUS." + "Create a skip of exactly the same length as @var{mus}." (let* ((skip (make-music 'SkipEvent @@ -1346,8 +1419,8 @@ use GrandStaff as a context. " (make-event-chord (list (ly:music-compress skip (ly:music-length mus)))))) (define-public (mmrest-of-length mus) - "Create a mmrest of exactly the same length as MUS." - + "Create a multi-measure rest of exactly the same length as @var{mus}." + (let* ((skip (make-multi-measure-rest (ly:make-duration 0 0) '()))) @@ -1355,20 +1428,25 @@ use GrandStaff as a context. " skip)) (define-public (pitch-of-note event-chord) + (let ((evs (filter (lambda (x) + (music-has-type x 'note-event)) + (ly:music-property event-chord 'elements)))) - (let* - ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types))) - (ly:music-property event-chord 'elements)))) + (and (pair? evs) + (ly:music-property (car evs) 'pitch)))) + +(define-public (duration-of-note event-chord) + (let ((evs (filter (lambda (x) + (music-has-type x 'rhythmic-event)) + (ly:music-property event-chord 'elements)))) + + (and (pair? evs) + (ly:music-property (car evs) 'duration)))) - (if (pair? evs) - (ly:music-property (car evs) 'pitch) - #f))) - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define-public (extract-named-music music music-name) -"Return a flat list of all music named @code{music-name} -from @code{music}." + "Return a flat list of all music named @var{music-name} from @var{music}." (let ((extracted-list (if (ly:music? music) (if (eq? (ly:music-property music 'name) music-name) @@ -1379,19 +1457,19 @@ from @code{music}." (extract-named-music elt music-name) (if (null? elts) '() - (map (lambda(x) + (map (lambda(x) (extract-named-music x music-name )) elts))))) '()))) (flatten-list extracted-list))) (define-public (event-chord-notes event-chord) -"Return a list of all notes from @{event-chord}." + "Return a list of all notes from @var{event-chord}." (filter (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name))) (ly:music-property event-chord 'elements))) (define-public (event-chord-pitches event-chord) -"Return a list of all pitches from @{event-chord}." + "Return a list of all pitches from @var{event-chord}." (map (lambda (x) (ly:music-property x 'pitch)) (event-chord-notes event-chord)))