1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2005--2010 Erik Sandberg <mandolaerik@gmail.com>
5 ;;;; LilyPond is free software: you can redistribute it and/or modify
6 ;;;; it under the terms of the GNU General Public License as published by
7 ;;;; the Free Software Foundation, either version 3 of the License, or
8 ;;;; (at your option) any later version.
10 ;;;; LilyPond is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;;;; GNU General Public License for more details.
15 ;;;; You should have received a copy of the GNU General Public License
16 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 (use-modules (srfi srfi-1))
21 ;; Event class hierarchy. Each line is on the form (Parent . (List of children))
23 '((() . (StreamEvent))
25 (RemoveContext ChangeParent Override Revert UnsetProperty
26 SetProperty music-event OldMusicEvent CreateContext Prepare
28 (music-event . (annotate-output-event
29 arpeggio-event breathing-event extender-event span-event
30 rhythmic-event dynamic-event break-event label-event percent-event
31 key-change-event string-number-event stroke-finger-event tie-event part-combine-event
32 beam-forbid-event script-event
33 tremolo-event bend-after-event fingering-event glissando-event
34 harmonic-event hyphen-event laissez-vibrer-event mark-event
35 multi-measure-text-event note-grouping-event
36 pes-or-flexa-event repeat-tie-event spacing-section-event
37 layout-instruction-event completize-extender-event break-span-event))
39 (layout-instruction-event . (apply-output-event))
40 (script-event . (articulation-event text-script-event))
41 (part-combine-event . (solo-one-event solo-two-event unisono-event))
42 (break-event . (line-break-event page-break-event page-turn-event))
43 (dynamic-event . (absolute-dynamic-event))
44 (span-event . (span-dynamic-event beam-event episema-event ligature-event
45 pedal-event phrasing-slur-event slur-event staff-span-event
46 text-span-event trill-span-event tremolo-span-event
48 (span-dynamic-event . (decrescendo-event crescendo-event))
49 (break-span-event . (break-dynamic-span-event))
50 (pedal-event . (sostenuto-event sustain-event una-corda-event))
51 (rhythmic-event . (lyric-event melodic-event multi-measure-rest-event
53 rest-event skip-event bass-figure-event))
54 (melodic-event . (cluster-note-event note-event))
56 (Announcement . (AnnounceNewContext))
59 ;; Maps event-class to a list of ancestors (inclusive)
60 (define ancestor-lookup (make-hash-table 11))
62 ;; Each class will be defined as
63 ;; (class parent grandparent .. )
64 ;; so that (eq? (cdr class) parent) holds.
69 (hashq-set! ancestor-lookup type
70 (cons type (hashq-ref ancestor-lookup (car rel) '()))))
74 ;; TODO: Allow entering more complex classes, by taking unions.
75 (define-public (ly:make-event-class leaf)
76 (hashq-ref ancestor-lookup leaf))
78 (define-public (ly:in-event-class? ev cl)
79 "Does event @var{ev} belong to event class @var{cl}?"
80 (memq cl (ly:make-event-class (ly:event-property ev 'class))))
82 ;; does this exist in guile already?
83 (define (map-tree f t)
86 (map (lambda (x) (map-tree f x)) t))
88 (cons (map-tree f (car t)) (map-tree f (cdr t))))
91 ;; expand each non-leaf subtree to (root . children), recursively
92 (define (expand-event-tree root)
93 (let ((children (assq root event-classes)))
95 (cons root (map expand-event-tree (cdr children)))
98 ;; All leaf event classes that no translator listens to
99 ;; directly. Avoids printing a warning.
100 (define unlistened-music-event-classes
101 '(harmonic-event line-break-event page-break-event page-turn-event label-event
102 solo-one-event solo-two-event skip-event unisono-event
103 break-dynamic-span-event))
105 ;; produce neater representation of music event tree.
106 ;; TODO: switch to this representation for the event-classes list?
107 (define music-event-tree (expand-event-tree 'music-event))
108 (define (sort-tree t)
109 (define (stringify el)
112 (symbol->string (first el))))
114 (sort (map (lambda (el)
116 (cons (car el) (sort-tree (cdr el)))
119 (lambda (a b) (string<? (stringify a) (stringify b))))
122 ;;(use-modules (ice-9 pretty-print))
123 ;;(pretty-print (cons (car music-event-tree) (sort-tree (cdr music-event-tree))))
125 ;; check that the music event tree corresponds well with the set of
126 ;; available translators; print warnings otherwise.
127 (map-tree (lambda (sym)
128 (if (and (symbol? sym)
129 (not (ly:is-listened-event-class sym))
130 (not (assq sym event-classes))
131 (not (memq sym unlistened-music-event-classes)))
132 (ly:programming-error (_ "event class ~A seems to be unused") sym)))
136 (if (not (pair? (ly:make-event-class sym)))
137 ;; should be programming-error
138 (ly:error (_ "translator listens to nonexisting event class ~A") sym)))
139 (ly:get-listened-event-classes))
141 (defmacro-public make-stream-event (expr)
142 (Stream_event::undump (primitive-eval (list 'quasiquote expr))))
144 (define* (simplify e)
146 ;; Special case for lists reduces stack consumption.
147 ((list? e) (map simplify e))
148 ((pair? e) (cons (simplify (car e))
150 ((ly:stream-event? e)
151 (list 'unquote (list 'make-stream-event (simplify (Stream_event::dump e)))))
153 (list 'unquote (music->make-music e)))
155 (list 'unquote `(ly:make-moment
156 ,(ly:moment-main-numerator e)
157 ,(ly:moment-main-denominator e)
158 . ,(if (eq? 0 (ly:moment-grace-numerator e))
160 (list (ly:moment-grace-numerator e)
161 (ly:moment-grace-denominator e))))))
163 (list 'unquote `(ly:make-duration
165 ,(ly:duration-dot-count e)
166 ,(car (ly:duration-factor e))
167 ,(cdr (ly:duration-factor e)))))
169 (list 'unquote `(ly:make-pitch
171 ,(ly:pitch-notename e)
172 ,(ly:pitch-alteration e))))
173 ((ly:input-location? e)
174 (list 'unquote '(ly:dummy-input-location)))
177 (define-public (ly:simplify-scheme e)
178 (list 'quasiquote (simplify e)))