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
  26                   ChangeParent Override Revert UnsetProperty SetProperty
  27                   music-event OldMusicEvent CreateContext Prepare
  28                   OneTimeStep Finish))
  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))
  42
  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
  54                    tuplet-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))
  64     (() . (Announcement))
  65     (Announcement . (AnnounceNewContext))
  66     ))
  67
  68 (define-public (event-class-cons class parent classlist)
  69   (let ((lineage (assq parent classlist)))
  70     (if (not lineage)
  71         (begin
  72           (if (not (null? parent))
  73               (ly:warning (_ "unknown parent class `~a'") parent))
  74           (set! lineage '())))
  75     (if (symbol? class)
  76         (acons class lineage classlist)
  77         (fold (lambda (elt alist)
  78                 (acons elt lineage alist))
  79               classlist class))))
  80
  81 (define all-event-classes
  82   (fold (lambda (elt classlist)
  83           (event-class-cons (cdr elt) (car elt) classlist))
  84         '() event-classes))
  85
  86 ;; Maps event-class to a list of ancestors (inclusive)
  87 (define-public ancestor-lookup
  88   (let ((h (make-hash-table (length all-event-classes))))
  89     (for-each (lambda (ent) (hashq-set! h (car ent) ent))
  90               all-event-classes)
  91     h))
  92
  93
  94 ;; Each class will be defined as
  95 ;; (class parent grandparent .. )
  96 ;; so that (eq? (cdr class) parent) holds.
  97
  98 (define-public (define-event-class leaf heritage)
  99   (cond
 100    ((not (eq? leaf (car heritage)))
 101     (ly:warning (_ "All classes must be the last in their matrilineal line.")))
 102    ((not (equal? (cdr heritage)
 103                  (list-head (hashq-ref ancestor-lookup (cadr heritage) '())
 104                             (length (cdr heritage)))))
 105     (ly:warning (_ "All classes must have a well-defined pedigree in the existing class hierarchy.")))
 106    (else (hashq-set! ancestor-lookup
 107                      leaf
 108                      (cons leaf
 109                            (hashq-ref ancestor-lookup
 110                                       (cadr heritage)
 111                                       '())))))
 112   *unspecified*)
 113
 114 ;; TODO: Allow entering more complex classes, by taking unions.
 115 (define-public (ly:make-event-class leaf)
 116   (hashq-ref ancestor-lookup leaf))
 117
 118 (define-public (ly:in-event-class? ev cl)
 119   "Does event @var{ev} belong to event class @var{cl}?"
 120   (memq cl (ly:event-property ev 'class)))
 121
 122 ;; does this exist in guile already?
 123 (define (map-tree f t)
 124   (cond
 125    ((list? t)
 126     (map (lambda (x) (map-tree f x)) t))
 127    ((pair? t)
 128     (cons (map-tree f (car t)) (map-tree f (cdr t))))
 129    (else (f t))))
 130
 131 ;; expand each non-leaf subtree to (root . children), recursively
 132 (define (expand-event-tree root)
 133   (let ((children (assq root event-classes)))
 134     (if children
 135         (cons root (map expand-event-tree (cdr children)))
 136         root)))
 137
 138 ;; produce neater representation of music event tree.
 139 ;; TODO: switch to this representation for the event-classes list?
 140 (define music-event-tree (expand-event-tree 'music-event))
 141 (define (sort-tree t)
 142   (define (stringify el)
 143     (if (symbol? el)
 144         (symbol->string el)
 145         (symbol->string (first el))))
 146   (if (list? t)
 147       (sort (map (lambda (el)
 148                    (if (list? el)
 149                        (cons (car el) (sort-tree (cdr el)))
 150                        el))
 151                  t)
 152             (lambda (a b) (string<? (stringify a) (stringify b))))
 153       t))
 154
 155 ;;(use-modules (ice-9 pretty-print))
 156 ;;(pretty-print (cons (car music-event-tree) (sort-tree (cdr music-event-tree))))
 157
 158 (defmacro-public make-stream-event (expr)
 159   (Stream_event::undump (primitive-eval (list 'quasiquote expr))))
 160
 161 (define* (simplify e)
 162   (cond
 163    ;; Special case for lists reduces stack consumption.
 164    ((list? e) (map simplify e))
 165    ((pair? e) (cons (simplify (car e))
 166                     (simplify (cdr e))))
 167    ((ly:stream-event? e)
 168     (list 'unquote (list 'make-stream-event (simplify (Stream_event::dump e)))))
 169    ((ly:music? e)
 170     (list 'unquote (music->make-music e)))
 171    ((ly:moment? e)
 172     (list 'unquote `(ly:make-moment
 173                      ,(ly:moment-main-numerator e)
 174                      ,(ly:moment-main-denominator e)
 175                      . ,(if (zero? (ly:moment-grace-numerator e))
 176                             '()
 177                             (list (ly:moment-grace-numerator e)
 178                                   (ly:moment-grace-denominator e))))))
 179    ((ly:duration? e)
 180     (list 'unquote `(ly:make-duration
 181                      ,(ly:duration-log e)
 182                      ,(ly:duration-dot-count e)
 183                      ,(ly:duration-scale))))
 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)))