1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2005--2012 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))
26 ChangeParent Override Revert UnsetProperty SetProperty
27 music-event OldMusicEvent CreateContext Prepare
29 (music-event . (annotate-output-event
30 footnote-event arpeggio-event breathing-event
31 extender-event span-event rhythmic-event dynamic-event
32 break-event label-event percent-event key-change-event
33 string-number-event stroke-finger-event tie-event
34 part-combine-event part-combine-force-event
35 beam-forbid-event script-event tempo-change-event
36 tremolo-event bend-after-event fingering-event
37 glissando-event harmonic-event hyphen-event
38 laissez-vibrer-event mark-event multi-measure-text-event
39 note-grouping-event pes-or-flexa-event repeat-tie-event
40 spacing-section-event layout-instruction-event
41 completize-extender-event break-span-event alternative-event))
43 (layout-instruction-event . (apply-output-event))
44 (script-event . (articulation-event text-script-event))
45 (part-combine-event . (solo-one-event solo-two-event unisono-event))
46 (break-event . (line-break-event page-break-event page-turn-event))
47 (dynamic-event . (absolute-dynamic-event))
48 (span-event . (span-dynamic-event
49 beam-event episema-event ligature-event
50 measure-counter-event pedal-event
51 phrasing-slur-event slur-event
52 staff-span-event text-span-event
53 trill-span-event tremolo-span-event
55 (span-dynamic-event . (decrescendo-event crescendo-event))
56 (break-span-event . (break-dynamic-span-event))
57 (pedal-event . (sostenuto-event sustain-event una-corda-event))
58 (rhythmic-event . (lyric-event
59 melodic-event multi-measure-rest-event
60 double-percent-event percent-event
61 repeat-slash-event rest-event
62 skip-event bass-figure-event))
63 (melodic-event . (cluster-note-event note-event))
65 (Announcement . (AnnounceNewContext))
68 (define-public (event-class-cons class parent classlist)
69 (let ((lineage (assq parent classlist)))
72 (if (not (null? parent))
73 (ly:warning (_ "unknown parent class `~a'") parent))
76 (acons class lineage classlist)
77 (fold (lambda (elt alist)
78 (acons elt lineage alist))
81 (define all-event-classes
82 (fold (lambda (elt classlist)
83 (event-class-cons (cdr elt) (car elt) classlist))
86 ;; Maps event-class to a list of ancestors (inclusive)
87 (define ancestor-lookup (make-hash-table (length all-event-classes)))
89 (define (ancestor-lookup-initialize)
90 (hash-clear! ancestor-lookup)
91 (for-each (lambda (ent) (hashq-set! ancestor-lookup (car ent) ent))
94 (ancestor-lookup-initialize)
95 (call-after-session ancestor-lookup-initialize)
97 ;; Each class will be defined as
98 ;; (class parent grandparent .. )
99 ;; so that (eq? (cdr class) parent) holds.
101 (define-public (define-event-class class parent)
102 "Defines a new event @code{class} derived from @code{parent}, a
103 previously defined event class."
104 (let ((parentclass (ly:make-event-class parent)))
106 ((ly:make-event-class class)
107 (ly:error (_ "Cannot redefine event class `~S'") class))
109 (ly:error (_ "Undefined parent event class `~S'" parentclass)))
111 (hashq-set! ancestor-lookup
113 (cons class parentclass))))
116 ;; TODO: Allow entering more complex classes, by taking unions.
117 (define-public (ly:make-event-class leaf)
118 (hashq-ref ancestor-lookup leaf))
120 (define-public (ly:in-event-class? ev cl)
121 "Does event @var{ev} belong to event class @var{cl}?"
122 (memq cl (ly:event-property ev 'class)))
124 ;; does this exist in guile already?
125 (define (map-tree f t)
128 (map (lambda (x) (map-tree f x)) t))
130 (cons (map-tree f (car t)) (map-tree f (cdr t))))
133 ;; expand each non-leaf subtree to (root . children), recursively
134 (define (expand-event-tree root)
135 (let ((children (assq root event-classes)))
137 (cons root (map expand-event-tree (cdr children)))
140 ;; produce neater representation of music event tree.
141 ;; TODO: switch to this representation for the event-classes list?
142 (define music-event-tree (expand-event-tree 'music-event))
143 (define (sort-tree t)
144 (define (stringify el)
147 (symbol->string (first el))))
149 (sort (map (lambda (el)
151 (cons (car el) (sort-tree (cdr el)))
154 (lambda (a b) (string<? (stringify a) (stringify b))))
157 ;;(use-modules (ice-9 pretty-print))
158 ;;(pretty-print (cons (car music-event-tree) (sort-tree (cdr music-event-tree))))
160 (defmacro-public make-stream-event (expr)
161 (Stream_event::undump (primitive-eval (list 'quasiquote expr))))
163 (define* (simplify e)
165 ;; Special case for lists reduces stack consumption.
166 ((list? e) (map simplify e))
167 ((pair? e) (cons (simplify (car e))
169 ((ly:stream-event? e)
170 (list 'unquote (list 'make-stream-event (simplify (Stream_event::dump e)))))
172 (list 'unquote (music->make-music e)))
174 (list 'unquote `(ly:make-moment
175 ,(ly:moment-main-numerator e)
176 ,(ly:moment-main-denominator e)
177 . ,(if (zero? (ly:moment-grace-numerator e))
179 (list (ly:moment-grace-numerator e)
180 (ly:moment-grace-denominator e))))))
182 (list 'unquote `(ly:make-duration
184 ,(ly:duration-dot-count e)
185 ,(ly:duration-scale))))
187 (list 'unquote `(ly:make-pitch
189 ,(ly:pitch-notename e)
190 ,(ly:pitch-alteration e))))
191 ((ly:input-location? e)
192 (list 'unquote '(ly:dummy-input-location)))
195 (define-public (ly:simplify-scheme e)
196 (list 'quasiquote (simplify e)))