scm/define-event-classes.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2005--2010 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
  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
  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
  40     (layout-instruction-event . (apply-output-event))
  41     (script-event . (articulation-event text-script-event))
  42     (part-combine-event . (solo-one-event solo-two-event unisono-event))
  43     (break-event . (line-break-event page-break-event page-turn-event))
  44     (dynamic-event . (absolute-dynamic-event))
  45     (span-event . (span-dynamic-event beam-event episema-event ligature-event
  46                          pedal-event phrasing-slur-event slur-event staff-span-event
  47                          text-span-event trill-span-event tremolo-span-event
  48                          tuplet-span-event))
  49     (span-dynamic-event . (decrescendo-event crescendo-event))
  50     (break-span-event . (break-dynamic-span-event))
  51     (pedal-event . (sostenuto-event sustain-event una-corda-event))
  52     (rhythmic-event . (lyric-event melodic-event multi-measure-rest-event
  53                                    percent-event
  54                                    rest-event skip-event bass-figure-event))
  55     (melodic-event . (cluster-note-event note-event))
  56     (() . (Announcement))
  57     (Announcement . (AnnounceNewContext))
  58     ))
  59
  60 ;; Maps event-class to a list of ancestors (inclusive)
  61 (define ancestor-lookup (make-hash-table 11))
  62
  63 ;; Each class will be defined as
  64 ;; (class parent grandparent .. )
  65 ;; so that (eq? (cdr class) parent) holds.
  66 (for-each
  67  (lambda (rel)
  68    (for-each
  69     (lambda (type)
  70       (hashq-set! ancestor-lookup type
  71                   (cons type (hashq-ref ancestor-lookup (car rel) '()))))
  72     (cdr rel)))
  73  event-classes)
  74
  75 (define-public (define-event-class leaf heritage)
  76   (cond
  77    ((not (eq? leaf (car heritage)))
  78     (ly:warning (_ "All classes must be the last in their matrilineal line.")))
  79    ((not (equal? (cdr heritage)
  80                  (list-head (hashq-ref ancestor-lookup (cadr heritage) '())
  81                             (length (cdr heritage)))))
  82     (ly:warning (_ "All classes must have a well-defined pedigree in the existing class hierarchy.")))
  83    (else (hashq-set! ancestor-lookup
  84                      leaf
  85                      (cons leaf
  86                            (hashq-ref ancestor-lookup
  87                                       (cadr heritage)
  88                                       '()))))))
  89
  90 ;; TODO: Allow entering more complex classes, by taking unions.
  91 (define-public (ly:make-event-class leaf)
  92  (hashq-ref ancestor-lookup leaf))
  93
  94 (define-public (ly:in-event-class? ev cl)
  95   "Does event @var{ev} belong to event class @var{cl}?"
  96   (memq cl (ly:make-event-class (ly:event-property ev 'class))))
  97
  98 ;; does this exist in guile already?
  99 (define (map-tree f t)
 100   (cond
 101    ((list? t)
 102     (map (lambda (x) (map-tree f x)) t))
 103    ((pair? t)
 104     (cons (map-tree f (car t)) (map-tree f (cdr t))))
 105    (else (f t))))
 106
 107 ;; expand each non-leaf subtree to (root . children), recursively
 108 (define (expand-event-tree root)
 109   (let ((children (assq root event-classes)))
 110     (if children
 111         (cons root (map expand-event-tree (cdr children)))
 112         root)))
 113
 114 ;; All leaf event classes that no translator listens to
 115 ;; directly.  Avoids printing a warning.
 116 (define unlistened-music-event-classes
 117   '(harmonic-event line-break-event page-break-event page-turn-event label-event
 118                    solo-one-event solo-two-event skip-event unisono-event
 119                    part-combine-force-event break-dynamic-span-event))
 120
 121 ;; produce neater representation of music event tree.
 122 ;; TODO: switch to this representation for the event-classes list?
 123 (define music-event-tree (expand-event-tree 'music-event))
 124 (define (sort-tree t)
 125   (define (stringify el)
 126               (if (symbol? el)
 127                   (symbol->string el)
 128                   (symbol->string (first el))))
 129   (if (list? t)
 130       (sort (map (lambda (el)
 131                    (if (list? el)
 132                        (cons (car el) (sort-tree (cdr el)))
 133                        el))
 134                  t)
 135             (lambda (a b) (string<? (stringify a) (stringify b))))
 136       t))
 137
 138 ;;(use-modules (ice-9 pretty-print))
 139 ;;(pretty-print (cons (car music-event-tree) (sort-tree (cdr music-event-tree))))
 140
 141 ;; check that the music event tree corresponds well with the set of
 142 ;; available translators; print warnings otherwise.
 143 (map-tree (lambda (sym)
 144             (if (and (symbol? sym)
 145                      (not (ly:is-listened-event-class sym))
 146                      (not (assq sym event-classes))
 147                      (not (memq sym unlistened-music-event-classes)))
 148                 (ly:programming-error (_ "event class ~A seems to be unused") sym)))
 149           music-event-tree)
 150
 151 (map (lambda (sym)
 152        (if (not (pair? (ly:make-event-class sym)))
 153            ;; should be programming-error
 154            (ly:error (_ "translator listens to nonexisting event class ~A") sym)))
 155      (ly:get-listened-event-classes))
 156
 157 (defmacro-public make-stream-event (expr)
 158   (Stream_event::undump (primitive-eval (list 'quasiquote expr))))
 159
 160 (define* (simplify e)
 161   (cond
 162    ;; Special case for lists reduces stack consumption.
 163    ((list? e) (map simplify e))
 164    ((pair? e) (cons (simplify (car e))
 165                     (simplify (cdr e))))
 166    ((ly:stream-event? e)
 167     (list 'unquote (list 'make-stream-event (simplify (Stream_event::dump e)))))
 168    ((ly:music? e)
 169     (list 'unquote (music->make-music e)))
 170    ((ly:moment? e)
 171     (list 'unquote `(ly:make-moment
 172                      ,(ly:moment-main-numerator e)
 173                      ,(ly:moment-main-denominator e)
 174                      . ,(if (eq? 0 (ly:moment-grace-numerator e))
 175                             '()
 176                             (list (ly:moment-grace-numerator e)
 177                                   (ly:moment-grace-denominator e))))))
 178    ((ly:duration? e)
 179     (list 'unquote `(ly:make-duration
 180                      ,(ly:duration-log e)
 181                      ,(ly:duration-dot-count e)
 182                      ,(car (ly:duration-factor e))
 183                      ,(cdr (ly:duration-factor e)))))
 184    ((ly:pitch? e)
 185     (list 'unquote `(ly:make-pitch
 186                      ,(ly:pitch-octave e)
 187                      ,(ly:pitch-notename e)
 188                      ,(ly:pitch-alteration e))))
 189    ((ly:input-location? e)
 190     (list 'unquote '(ly:dummy-input-location)))
 191    (#t e)))
 192
 193 (define-public (ly:simplify-scheme e)
 194   (list 'quasiquote (simplify e)))