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 ;; TODO: Allow entering more complex classes, by taking unions.
  76 (define-public (ly:make-event-class leaf)
  77  (hashq-ref ancestor-lookup leaf))
  78
  79 (define-public (ly:in-event-class? ev cl)
  80   "Does event @var{ev} belong to event class @var{cl}?"
  81   (memq cl (ly:make-event-class (ly:event-property ev 'class))))
  82
  83 ;; does this exist in guile already?
  84 (define (map-tree f t)
  85   (cond
  86    ((list? t)
  87     (map (lambda (x) (map-tree f x)) t))
  88    ((pair? t)
  89     (cons (map-tree f (car t)) (map-tree f (cdr t))))
  90    (else (f t))))
  91
  92 ;; expand each non-leaf subtree to (root . children), recursively
  93 (define (expand-event-tree root)
  94   (let ((children (assq root event-classes)))
  95     (if children
  96         (cons root (map expand-event-tree (cdr children)))
  97         root)))
  98
  99 ;; All leaf event classes that no translator listens to
 100 ;; directly.  Avoids printing a warning.
 101 (define unlistened-music-event-classes
 102   '(harmonic-event line-break-event page-break-event page-turn-event label-event
 103                    solo-one-event solo-two-event skip-event unisono-event
 104                    part-combine-force-event break-dynamic-span-event))
 105
 106 ;; produce neater representation of music event tree.
 107 ;; TODO: switch to this representation for the event-classes list?
 108 (define music-event-tree (expand-event-tree 'music-event))
 109 (define (sort-tree t)
 110   (define (stringify el)
 111               (if (symbol? el)
 112                   (symbol->string el)
 113                   (symbol->string (first el))))
 114   (if (list? t)
 115       (sort (map (lambda (el)
 116                    (if (list? el)
 117                        (cons (car el) (sort-tree (cdr el)))
 118                        el))
 119                  t)
 120             (lambda (a b) (string<? (stringify a) (stringify b))))
 121       t))
 122
 123 ;;(use-modules (ice-9 pretty-print))
 124 ;;(pretty-print (cons (car music-event-tree) (sort-tree (cdr music-event-tree))))
 125
 126 ;; check that the music event tree corresponds well with the set of
 127 ;; available translators; print warnings otherwise.
 128 (map-tree (lambda (sym)
 129             (if (and (symbol? sym)
 130                      (not (ly:is-listened-event-class sym))
 131                      (not (assq sym event-classes))
 132                      (not (memq sym unlistened-music-event-classes)))
 133                 (ly:programming-error (_ "event class ~A seems to be unused") sym)))
 134           music-event-tree)
 135
 136 (map (lambda (sym)
 137        (if (not (pair? (ly:make-event-class sym)))
 138            ;; should be programming-error
 139            (ly:error (_ "translator listens to nonexisting event class ~A") sym)))
 140      (ly:get-listened-event-classes))
 141
 142 (defmacro-public make-stream-event (expr)
 143   (Stream_event::undump (primitive-eval (list 'quasiquote expr))))
 144
 145 (define* (simplify e)
 146   (cond
 147    ;; Special case for lists reduces stack consumption.
 148    ((list? e) (map simplify e))
 149    ((pair? e) (cons (simplify (car e))
 150                     (simplify (cdr e))))
 151    ((ly:stream-event? e)
 152     (list 'unquote (list 'make-stream-event (simplify (Stream_event::dump e)))))
 153    ((ly:music? e)
 154     (list 'unquote (music->make-music e)))
 155    ((ly:moment? e)
 156     (list 'unquote `(ly:make-moment
 157                      ,(ly:moment-main-numerator e)
 158                      ,(ly:moment-main-denominator e)
 159                      . ,(if (eq? 0 (ly:moment-grace-numerator e))
 160                             '()
 161                             (list (ly:moment-grace-numerator e)
 162                                   (ly:moment-grace-denominator e))))))
 163    ((ly:duration? e)
 164     (list 'unquote `(ly:make-duration
 165                      ,(ly:duration-log e)
 166                      ,(ly:duration-dot-count e)
 167                      ,(car (ly:duration-factor e))
 168                      ,(cdr (ly:duration-factor e)))))
 169    ((ly:pitch? e)
 170     (list 'unquote `(ly:make-pitch
 171                      ,(ly:pitch-octave e)
 172                      ,(ly:pitch-notename e)
 173                      ,(ly:pitch-alteration e))))
 174    ((ly:input-location? e)
 175     (list 'unquote '(ly:dummy-input-location)))
 176    (#t e)))
 177
 178 (define-public (ly:simplify-scheme e)
 179   (list 'quasiquote (simplify e)))