scm/define-event-classes.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2005--2012 Erik Sandberg <mandolaerik@gmail.com>
   4 ;;;;
   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.
   9 ;;;;
  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.
  14 ;;;;
  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/>.
  17
  18
  19 (use-modules (srfi srfi-1))
  20
  21 ;; Event class hierarchy. Each line is on the form (Parent . (List of children))
  22 (define event-classes
  23   '((() . (StreamEvent))
  24     (StreamEvent .
  25                  (RemoveContext ChangeParent Override Revert UnsetProperty
  26                                 SetProperty music-event OldMusicEvent CreateContext Prepare
  27                                 OneTimeStep Finish))
  28     (music-event . (annotate-output-event footnote-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
  32       part-combine-event part-combine-force-event
  33       beam-forbid-event script-event tempo-change-event
  34       tremolo-event bend-after-event fingering-event glissando-event
  35       harmonic-event hyphen-event laissez-vibrer-event mark-event
  36       multi-measure-text-event note-grouping-event
  37       pes-or-flexa-event repeat-tie-event spacing-section-event
  38       layout-instruction-event completize-extender-event break-span-event
  39       alternative-event))
  40
  41     (layout-instruction-event . (apply-output-event))
  42     (script-event . (articulation-event text-script-event))
  43     (part-combine-event . (solo-one-event solo-two-event unisono-event))
  44     (break-event . (line-break-event page-break-event page-turn-event))
  45     (dynamic-event . (absolute-dynamic-event))
  46     (span-event . (span-dynamic-event beam-event episema-event ligature-event
  47                          pedal-event phrasing-slur-event slur-event staff-span-event
  48                          text-span-event trill-span-event tremolo-span-event
  49                          tuplet-span-event))
  50     (span-dynamic-event . (decrescendo-event crescendo-event))
  51     (break-span-event . (break-dynamic-span-event))
  52     (pedal-event . (sostenuto-event sustain-event una-corda-event))
  53     (rhythmic-event . (lyric-event melodic-event multi-measure-rest-event
  54                                    double-percent-event percent-event
  55                                    repeat-slash-event rest-event
  56                                    skip-event bass-figure-event))
  57     (melodic-event . (cluster-note-event note-event))
  58     (() . (Announcement))
  59     (Announcement . (AnnounceNewContext))
  60     ))
  61
  62 (define-public (event-class-cons class parent classlist)
  63   (let ((lineage (assq parent classlist)))
  64     (if (not lineage)
  65         (begin
  66           (if (not (null? parent))
  67               (ly:warning (_ "unknown parent class `~a'") parent))
  68           (set! lineage '())))
  69     (if (symbol? class)
  70         (acons class lineage classlist)
  71         (fold (lambda (elt alist)
  72                 (acons elt lineage alist))
  73               classlist class))))
  74
  75 (define all-event-classes
  76   (fold (lambda (elt classlist)
  77           (event-class-cons (cdr elt) (car elt) classlist))
  78         '() event-classes))
  79
  80 ;; Maps event-class to a list of ancestors (inclusive)
  81 (define-public ancestor-lookup
  82   (let ((h (make-hash-table (length all-event-classes))))
  83     (for-each (lambda (ent) (hashq-set! h (car ent) ent))
  84               all-event-classes)
  85     h))
  86
  87
  88 ;; Each class will be defined as
  89 ;; (class parent grandparent .. )
  90 ;; so that (eq? (cdr class) parent) holds.
  91
  92 (define-public (define-event-class leaf heritage)
  93   (cond
  94    ((not (eq? leaf (car heritage)))
  95     (ly:warning (_ "All classes must be the last in their matrilineal line.")))
  96    ((not (equal? (cdr heritage)
  97                  (list-head (hashq-ref ancestor-lookup (cadr heritage) '())
  98                             (length (cdr heritage)))))
  99     (ly:warning (_ "All classes must have a well-defined pedigree in the existing class hierarchy.")))
 100    (else (hashq-set! ancestor-lookup
 101                      leaf
 102                      (cons leaf
 103                            (hashq-ref ancestor-lookup
 104                                       (cadr heritage)
 105                                       '())))))
 106   *unspecified*)
 107
 108 ;; TODO: Allow entering more complex classes, by taking unions.
 109 (define-public (ly:make-event-class leaf)
 110  (hashq-ref ancestor-lookup leaf))
 111
 112 (define-public (ly:in-event-class? ev cl)
 113   "Does event @var{ev} belong to event class @var{cl}?"
 114   (memq cl (ly:event-property ev 'class)))
 115
 116 ;; does this exist in guile already?
 117 (define (map-tree f t)
 118   (cond
 119    ((list? t)
 120     (map (lambda (x) (map-tree f x)) t))
 121    ((pair? t)
 122     (cons (map-tree f (car t)) (map-tree f (cdr t))))
 123    (else (f t))))
 124
 125 ;; expand each non-leaf subtree to (root . children), recursively
 126 (define (expand-event-tree root)
 127   (let ((children (assq root event-classes)))
 128     (if children
 129         (cons root (map expand-event-tree (cdr children)))
 130         root)))
 131
 132 ;; All leaf event classes that no translator listens to
 133 ;; directly.  Avoids printing a warning.
 134 (define unlistened-music-event-classes
 135   '(harmonic-event line-break-event page-break-event page-turn-event label-event
 136                    solo-one-event solo-two-event skip-event unisono-event
 137                    part-combine-force-event break-dynamic-span-event
 138                    stroke-finger-event))
 139
 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)
 145               (if (symbol? el)
 146                   (symbol->string el)
 147                   (symbol->string (first el))))
 148   (if (list? t)
 149       (sort (map (lambda (el)
 150                    (if (list? el)
 151                        (cons (car el) (sort-tree (cdr el)))
 152                        el))
 153                  t)
 154             (lambda (a b) (string<? (stringify a) (stringify b))))
 155       t))
 156
 157 ;;(use-modules (ice-9 pretty-print))
 158 ;;(pretty-print (cons (car music-event-tree) (sort-tree (cdr music-event-tree))))
 159
 160 ;; check that the music event tree corresponds well with the set of
 161 ;; available translators; print warnings otherwise.
 162 (map-tree (lambda (sym)
 163             (if (and (symbol? sym)
 164                      (not (ly:is-listened-event-class sym))
 165                      (not (assq sym event-classes))
 166                      (not (memq sym unlistened-music-event-classes)))
 167                 (ly:programming-error (_ "event class ~A seems to be unused") sym)))
 168           music-event-tree)
 169
 170 (map (lambda (sym)
 171        (if (not (pair? (ly:make-event-class sym)))
 172            ;; should be programming-error
 173            (ly:error (_ "translator listens to nonexisting event class ~A") sym)))
 174      (ly:get-listened-event-classes))
 175
 176 (defmacro-public make-stream-event (expr)
 177   (Stream_event::undump (primitive-eval (list 'quasiquote expr))))
 178
 179 (define* (simplify e)
 180   (cond
 181    ;; Special case for lists reduces stack consumption.
 182    ((list? e) (map simplify e))
 183    ((pair? e) (cons (simplify (car e))
 184                     (simplify (cdr e))))
 185    ((ly:stream-event? e)
 186     (list 'unquote (list 'make-stream-event (simplify (Stream_event::dump e)))))
 187    ((ly:music? e)
 188     (list 'unquote (music->make-music e)))
 189    ((ly:moment? e)
 190     (list 'unquote `(ly:make-moment
 191                      ,(ly:moment-main-numerator e)
 192                      ,(ly:moment-main-denominator e)
 193                      . ,(if (eq? 0 (ly:moment-grace-numerator e))
 194                             '()
 195                             (list (ly:moment-grace-numerator e)
 196                                   (ly:moment-grace-denominator e))))))
 197    ((ly:duration? e)
 198     (list 'unquote `(ly:make-duration
 199                      ,(ly:duration-log e)
 200                      ,(ly:duration-dot-count e)
 201                      ,(car (ly:duration-factor e))
 202                      ,(cdr (ly:duration-factor e)))))
 203    ((ly:pitch? e)
 204     (list 'unquote `(ly:make-pitch
 205                      ,(ly:pitch-octave e)
 206                      ,(ly:pitch-notename e)
 207                      ,(ly:pitch-alteration e))))
 208    ((ly:input-location? e)
 209     (list 'unquote '(ly:dummy-input-location)))
 210    (#t e)))
 211
 212 (define-public (ly:simplify-scheme e)
 213   (list 'quasiquote (simplify e)))