scm/to-xml.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2003--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   5 ;;;;
   6 ;;;; LilyPond is free software: you can redistribute it and/or modify
   7 ;;;; it under the terms of the GNU General Public License as published by
   8 ;;;; the Free Software Foundation, either version 3 of the License, or
   9 ;;;; (at your option) any later version.
  10 ;;;;
  11 ;;;; LilyPond is distributed in the hope that it will be useful,
  12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;;;; GNU General Public License for more details.
  15 ;;;;
  16 ;;;; You should have received a copy of the GNU General Public License
  17 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 (define-module (scm to-xml))
  20
  21 (use-modules (ice-9 regex)
  22              (srfi srfi-1)
  23              (lily)
  24              (oop goops))
  25
  26 "
  27 Todo: this is a quick hack; it makes more sense to define a GOOPS
  28 class of a documentnode (similar to how
  29 the documentation is generated.)
  30
  31 That is much cleaner: building the document, and dumping it to output
  32 is then separated.
  33
  34
  35    foo = \\score { ... }
  36
  37    #(as-xml foo)
  38
  39    <score>
  40      <music></music>
  41      <layoutoutput>
  42      </layoutoutput>
  43    </score>
  44 "
  45
  46 (define-class <xml-node> ()
  47   (name #:init-value "" #:accessor node-name #:init-keyword #:name)
  48   (value #:init-value "" #:accessor node-value #:init-keyword #:value)
  49   (attributes #:init-value '()
  50               #:accessor node-attributes
  51               #:init-keyword #:attributes)
  52   (children #:init-value '()
  53             #:accessor node-children
  54             #:init-keyword #:children))
  55
  56 (define node-names
  57   '((NoteEvent . note)
  58     (SequentialMusic . measure)
  59
  60     ;;ugh
  61     (pitch . pitch)
  62     (duration . duration)
  63     (octave . octave)
  64     (step . step)))
  65
  66 (define (musicxml-node->string node)
  67   (let ((xml-name (assoc-get (node-name node) node-names #f)))
  68     (string-append
  69      (if xml-name (open-tag xml-name '() '()) "")
  70      (if (equal? (node-value node) "")
  71          (string-append
  72           (if xml-name "\n" "")
  73           (string-concatenate (map musicxml-node->string (node-children node))))
  74          (node-value node))
  75      (if xml-name (close-tag xml-name) "")
  76      (if xml-name "\n" ""))))
  77
  78 (define (xml-node->string node)
  79   (string-append
  80    "\n"
  81    (open-tag (node-name node) (node-attributes node) '())
  82    (if (equal? (node-value node) "")
  83        (string-concatenate (map xml-node->string (node-children node)))
  84        (node-value node))
  85    "\n"
  86    (close-tag (node-name node))))
  87
  88 (define (musicxml-duration->xml-node d)
  89   (make <xml-node>
  90     #:name 'duration
  91     #:value (number->string (ash 1 (ly:duration-log d)))))
  92
  93 (define (duration->xml-node d)
  94   (make <xml-node>
  95     #:name 'duration
  96     ;; #:value (number->string (ash 1 (ly:duration-log d)))))
  97     #:attributes `((log . ,(ly:duration-log d))
  98                    (dots . ,(ly:duration-dot-count d))
  99                    (numer . ,(car (ly:duration-factor d)))
 100                    (denom . ,(cdr (ly:duration-factor d))))))
 101
 102 (define (pitch->xml-node p)
 103   (make <xml-node>
 104     #:name 'pitch
 105     #:attributes `((octave . ,(ly:pitch-octave p))
 106                    (notename . ,(ly:pitch-notename p))
 107                    (alteration . ,(ly:pitch-alteration p)))))
 108
 109 (define (music->xml-node music)
 110   (let* ((name (ly:music-property music 'name))
 111          (e (ly:music-property music 'element))
 112          (es (ly:music-property music 'elements))
 113          (mprops (ly:music-mutable-properties music))
 114          (d (ly:music-property music 'duration))
 115          (p (ly:music-property music 'pitch))
 116          (ignore-props '(origin elements duration pitch element)))
 117
 118     (make <xml-node>
 119       #:name name
 120       #:children
 121       (apply
 122        append
 123        (if (ly:pitch? p) (list (pitch->xml-node p)) '())
 124        (if (ly:duration? d) (list (duration->xml-node d)) '())
 125        (if (pair? es) (map music->xml-node es) '())
 126        (if (ly:music? e) (list (music->xml-node e)) '())
 127        '()))))
 128
 129 (define (dtd-header)
 130   (string-append
 131    "<?xml version=\"1.0\"?>
 132 <!DOCTYPE MUSIC ["
 133    preliminary-dtd
 134    "
 135 ]>
 136
 137 "))
 138
 139
 140 ;; as computed from input/trip.ly, by
 141 ;; http://www.pault.com/pault/dtdgenerator/
 142
 143 ;; must recompute with larger, more serious piece, and probably
 144 ;; manually add stuff
 145 (define preliminary-dtd
 146   "
 147 <!ELEMENT duration EMPTY >
 148 <!ATTLIST duration denom ( 1 | 3 | 5 ) #REQUIRED >
 149 <!ATTLIST duration dots ( 0 | 1 ) #REQUIRED >
 150 <!ATTLIST duration log ( 0 | 1 | 2 | 3 | 4 ) #REQUIRED >
 151 <!ATTLIST duration numer ( 1 | 4 ) #REQUIRED >
 152
 153 <!ELEMENT music ( duration | music | pitch )* >
 154 <!ATTLIST music articulation-type ( lheel | ltoe | marcato | rheel | rtoe | staccato | tenuto ) #IMPLIED >
 155 <!ATTLIST music change-to-id NMTOKEN #IMPLIED >
 156 <!ATTLIST music change-to-type NMTOKEN #IMPLIED >
 157 <!ATTLIST music context-id CDATA #IMPLIED >
 158 <!ATTLIST music context-type ( PianoStaff | Score | Staff | Timing | Voice ) #IMPLIED >
 159 <!ATTLIST music denominator NMTOKEN #IMPLIED >
 160 <!ATTLIST music direction ( 0 | 1 ) #IMPLIED >
 161 <!ATTLIST music force-accidental CDATA #IMPLIED >
 162 <!ATTLIST music grob-property NMTOKEN #IMPLIED >
 163 <!ATTLIST music grob-value CDATA #IMPLIED >
 164 <!ATTLIST music iterator-ctor CDATA #IMPLIED >
 165 <!ATTLIST music label NMTOKEN #IMPLIED >
 166 <!ATTLIST music last-pitch CDATA #IMPLIED >
 167 <!ATTLIST music numerator NMTOKEN #IMPLIED >
 168 <!ATTLIST music penalty NMTOKEN #IMPLIED >
 169 <!ATTLIST music pitch-alist CDATA #IMPLIED >
 170 <!ATTLIST music pop-first CDATA #IMPLIED >
 171 <!ATTLIST music repeat-count NMTOKEN #IMPLIED >
 172 <!ATTLIST music span-direction ( -1 | 1 ) #IMPLIED >
 173 <!ATTLIST music span-type NMTOKEN #IMPLIED >
 174 <!ATTLIST music symbol NMTOKEN #IMPLIED >
 175 <!ATTLIST music text NMTOKEN #IMPLIED >
 176 <!ATTLIST music text-type NMTOKEN #IMPLIED >
 177 <!ATTLIST music type NMTOKEN #REQUIRED >
 178 <!ATTLIST music value CDATA #IMPLIED >
 179
 180 <!ELEMENT pitch EMPTY >
 181 <!ATTLIST pitch alteration ( 0 | 1 ) #REQUIRED >
 182 <!ATTLIST pitch notename ( 0 | 1 | 2 | 3 | 4 | 5 | 6 ) #REQUIRED >
 183 <!ATTLIST pitch octave ( -1 | -2 | 0 | 1 ) #REQUIRED >")
 184
 185
 186 ;; should use macro
 187 (define (assert x)
 188   (if x
 189       #t
 190       (ly:error (_ "assertion failed: ~S") x)))
 191
 192 (define (re-sub re to string)
 193   (regexp-substitute/global #f re string 'pre to 'post))
 194
 195 (define (re-sub-alist string alist)
 196   (if (null? alist)
 197       string
 198       (re-sub (caar alist) (cdar alist)
 199               (re-sub-alist string (cdr alist)))))
 200
 201 (define xml-entities-alist
 202   '(("\"" . "&quot;")
 203     ("<" . "&lt;")
 204     (">" . "&gt;")
 205     ("'" . "&apos;")
 206     ("&" . "&amp;")))
 207
 208 (define (open-tag tag attrs exceptions)
 209   (define (candidate? x)
 210     (not (memq (car x) exceptions)))
 211
 212   (define (dump-attr sym-val)
 213     (let* ((sym (car sym-val))
 214            (val (cdr sym-val)))
 215
 216       (string-append
 217        "\n   "
 218        (symbol->string sym)
 219        "=\""
 220        (let ((s (call-with-output-string (lambda (port) (display val port)))))
 221          (re-sub-alist s xml-entities-alist))
 222        "\"")))
 223
 224   (string-append
 225    "<" (symbol->string tag)
 226    (string-concatenate (map dump-attr (filter candidate? attrs)))
 227    ">"))
 228
 229 (define (close-tag name)
 230   (string-append "</" (symbol->string name) ">"))
 231
 232 (define-public (music-to-xml music port)
 233   "Dump XML-ish stuff to @var{port}."
 234
 235   ;; dtd contains # -- This confuses tex during make doc.
 236   ;;
 237   ;;  (display (dtd-header) port)
 238
 239   (display (open-tag 'music '((type . score)) '()) port)
 240   (display (xml-node->string (music->xml-node music)) port)
 241   (display (close-tag 'music) port))
 242
 243 (define-public (music-to-musicxml music port)
 244   "Dump MusicXML-ish stuff to @var{port}."
 245
 246   ;; dtd contains # -- This confuses tex during make doc.
 247   ;;
 248   ;;  (display (dtd-header) port)
 249
 250   (define duration->xml-node musicxml-duration->xml-node)
 251
 252   (display (open-tag 'music '((type . score)) '()) port)
 253   (display (musicxml-node->string (music->xml-node music)) port)
 254   (display (close-tag 'music) port))