X-Git-Url: https://git.yukkurigames.com/?p=python-bulletml.git;a=blobdiff_plain;f=bulletml%2Fparser.py;h=51e15add66b82eac1e0d60671301c5b0e0b37dc2;hp=edb9d29e4c544bae3506e1681cbe25141a78c1db;hb=e753939f30c6c07a68363c7819acf8c0e57a6951;hpb=ba81e7d74da58dc8dfa47949502d2a2759c84309

diff --git a/bulletml/parser.py b/bulletml/parser.py
index edb9d29..51e15ad 100644
--- a/bulletml/parser.py
+++ b/bulletml/parser.py
@@ -1,6 +1,10 @@
 """BulletML parser.
 
-http://www.asahi-net.or.jp/~cs8k-cyu/bulletml/index_e.html
+This is based on the format described at
+http://www.asahi-net.or.jp/~cs8k-cyu/bulletml/bulletml_ref_e.html.
+
+Unless you are adding support for new tags, the only class you should
+care about in here is BulletML.
 """
 
 from __future__ import division
@@ -10,13 +14,19 @@ import math
 from xml.etree.ElementTree import ElementTree
 
 try:
-    from cStringIO import StringIO
+    from io import StringIO
 except ImportError:
-    from StringIO import StringIO
+    try:
+        from cStringIO import StringIO
+    except ImportError:
+        from StringIO import StringIO
 
 from bulletml.errors import Error
 from bulletml.expr import NumberDef, INumberDef
 
+
+__all_ = ["ParseError", "BulletML"]
+
 class ParseError(Error):
     """Raised when an error occurs parsing the XML structure."""
     pass
@@ -31,11 +41,11 @@ def realtag(element):
 class ParamList(object):
     """List of parameter definitions."""
 
-    def __init__(self, params=[]):
+    def __init__(self, params=()):
         self.params = list(params)
 
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         return cls([NumberDef(subelem.text) for subelem in element
                     if realtag(subelem) == "param"])
@@ -57,8 +67,15 @@ class Direction(object):
         self.type = type
         self.value = value
 
+    def __getstate__(self):
+        return [('type', self.type), ('value', self.value.expr)]
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(state["type"], NumberDef(state["value"]))
+
     @classmethod
-    def FromElement(cls, doc, element, default="absolute"):
+    def FromXML(cls, doc, element, default="absolute"):
         """Construct using an ElementTree-style element."""
         return cls(element.get("type", default), NumberDef(element.text))
 
@@ -76,13 +93,23 @@ class ChangeDirection(object):
         self.term = term
         self.direction = direction
 
+    def __getstate__(self):
+        return [('frames', self.term.expr),
+                ('type', self.direction.type),
+                ('value', self.direction.value.expr)]
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(INumberDef(state["frames"]),
+                      Direction(state["type"], NumberDef(state["value"])))
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         for subelem in element.getchildren():
             tag = realtag(subelem)
             if tag == "direction":
-                direction = Direction.FromElement(doc, subelem)
+                direction = Direction.FromXML(doc, subelem)
             elif tag == "term":
                 term = INumberDef(subelem.text)
         try:
@@ -108,8 +135,15 @@ class Speed(object):
         self.type = type
         self.value = value
 
+    def __getstate__(self):
+        return [('type', self.type), ('value', self.value.expr)]
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(state["type"], NumberDef(state["value"]))
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         return cls(element.get("type", "absolute"), NumberDef(element.text))
 
@@ -126,13 +160,23 @@ class ChangeSpeed(object):
         self.term = term
         self.speed = speed
 
+    def __getstate__(self):
+        return [('frames', self.term.expr),
+                ('type', self.speed.type),
+                ('value', self.speed.value.expr)]
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(INumberDef(state["frames"]),
+                      Speed(state["type"], NumberDef(state["value"])))
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         for subelem in element.getchildren():
             tag = realtag(subelem)
             if tag == "speed":
-                speed = Speed.FromElement(doc, subelem)
+                speed = Speed.FromXML(doc, subelem)
             elif tag == "term":
                 term = INumberDef(subelem.text)
         try:
@@ -153,8 +197,14 @@ class Wait(object):
     def __init__(self, frames):
         self.frames = frames
 
+    def __getstate__(self):
+        return dict(frames=self.frames.expr)
+
+    def __setstate__(self, state):
+        self.__init__(INumberDef(state["frames"]))
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         return cls(INumberDef(element.text))
 
@@ -164,6 +214,40 @@ class Wait(object):
     def __repr__(self):
         return "%s(%r)" % (type(self).__name__, self.frames)
 
+class Tag(object):
+    """Set a bullet tag."""
+
+    def __init__(self, tag):
+        self.tag = tag
+
+    def __getstate__(self):
+        return dict(tag=self.tag)
+
+    def __setstate__(self, state):
+        self.__init__(state["tag"])
+
+    @classmethod
+    def FromXML(cls, doc, element):
+        """Construct using an ElementTree-style element."""
+        return cls(element.text)
+
+class Untag(object):
+    """Unset a bullet tag."""
+
+    def __init__(self, tag):
+        self.tag = tag
+        
+    def __getstate__(self):
+        return dict(tag=self.tag)
+
+    def __setstate__(self, state):
+        self.__init__(state["tag"])
+
+    @classmethod
+    def FromXML(cls, doc, element):
+        """Construct using an ElementTree-style element."""
+        return cls(element.text)
+
 class Vanish(object):
     """Make the owner disappear."""
 
@@ -171,7 +255,7 @@ class Vanish(object):
         pass
 
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         return cls()
 
@@ -184,18 +268,25 @@ class Repeat(object):
     def __init__(self, times, action):
         self.times = times
         self.action = action
+
+    def __getstate__(self):
+        return [('times', self.times.expr), ('action', self.action)]
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(INumberDef(state["times"]), state["action"])
     
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         for subelem in element.getchildren():
             tag = realtag(subelem)
             if tag == "times":
                 times = INumberDef(subelem.text)
             elif tag == "action":
-                action = ActionDef.FromElement(doc, subelem)
+                action = ActionDef.FromXML(doc, subelem)
             elif tag == "actionRef":
-                action = ActionRef.FromElement(doc, subelem)
+                action = ActionRef.FromXML(doc, subelem)
         try:
             return cls(times, action)
         except UnboundLocalError as exc:
@@ -218,8 +309,21 @@ class Accel(object):
         self.horizontal = horizontal
         self.vertical = vertical
 
+    def __getstate__(self):
+        state = [('frames', self.term.expr)]
+        if self.horizontal:
+            state.append(('horizontal', self.horizontal))
+        if self.vertical:
+            state.append(('vertical', self.vertical))
+        return state
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(INumberDef(state["frames"]), state.get("horizontal"),
+                      state.get("vertical"))
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         horizontal = None
         vertical = None
@@ -229,9 +333,9 @@ class Accel(object):
             if tag == "term":
                 term = INumberDef(subelem.text)
             elif tag == "horizontal":
-                horizontal = Speed.FromElement(doc, subelem)
+                horizontal = Speed.FromXML(doc, subelem)
             elif tag == "vertical":
-                vertical = Speed.FromElement(doc, subelem)
+                vertical = Speed.FromXML(doc, subelem)
 
         try:
             return cls(term, horizontal, vertical)
@@ -259,8 +363,22 @@ class BulletDef(object):
         self.speed = speed
         self.actions = list(actions)
 
+    def __getstate__(self):
+        state = []
+        if self.direction:
+            state.append(("direction", self.direction))
+        if self.speed:
+            state.append(("speed", self.speed))
+        if self.actions:
+            state.append(("actions", self.actions))
+        return state
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(**state)
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         actions = []
         speed = None
@@ -268,13 +386,13 @@ class BulletDef(object):
         for subelem in element.getchildren():
             tag = realtag(subelem)
             if tag == "direction":
-                direction = Direction.FromElement(doc, subelem)
+                direction = Direction.FromXML(doc, subelem)
             elif tag == "speed":
-                speed = Speed.FromElement(doc, subelem)
+                speed = Speed.FromXML(doc, subelem)
             elif tag == "action":
-                actions.append(ActionDef.FromElement(doc, subelem))
+                actions.append(ActionDef.FromXML(doc, subelem))
             elif tag == "actionRef":
-                actions.append(ActionRef.FromElement(doc, subelem))
+                actions.append(ActionRef.FromXML(doc, subelem))
         dfn = cls(actions, direction, speed)
         doc.bullets[element.get("label")] = dfn
         return dfn
@@ -295,12 +413,26 @@ class BulletRef(object):
 
     def __init__(self, bullet, params=None):
         self.bullet = bullet
-        self.params = params or ParamList()
+        self.params = ParamList() if params is None else params
+
+    def __getstate__(self):
+        state = []
+        if self.params.params:
+            params = [param.expr for param in self.params.params]
+            state.append(("params", params))
+        state.append(('bullet', self.bullet))
+        return state
+
+    def __setstate__(self, state):
+        state = dict(state)
+        bullet = state["bullet"]
+        params = [NumberDef(param) for param in state.get("params", [])]
+        self.__init__(bullet, ParamList(params))
 
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
-        bullet = cls(element.get("label"), ParamList.FromElement(doc, element))
+        bullet = cls(element.get("label"), ParamList.FromXML(doc, element))
         doc._bullet_refs.append(bullet)
         return bullet
 
@@ -312,7 +444,13 @@ class BulletRef(object):
             type(self).__name__, self.params, self.bullet)
 
 class ActionDef(object):
-    """Action definition."""
+    """Action definition.
+
+    To support parsing new actions, add tags to
+    ActionDef.CONSTRUCTORS. It maps tag names to classes with a
+    FromXML classmethod, which take the BulletML instance and
+    ElementTree element as arguments.
+    """
 
     # This is self-referential, so it's filled in later.
     CONSTRUCTORS = dict()
@@ -320,8 +458,15 @@ class ActionDef(object):
     def __init__(self, actions):
         self.actions = list(actions)
 
+    def __getstate__(self):
+        return dict(actions=self.actions)
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(state["actions"])
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         actions = []
         for subelem in element.getchildren():
@@ -331,7 +476,7 @@ class ActionDef(object):
             except KeyError:
                 continue
             else:
-                actions.append(ctr.FromElement(doc, subelem))
+                actions.append(ctr.FromXML(doc, subelem))
         dfn = cls(actions)
         doc.actions[element.get("label")] = dfn
         return dfn
@@ -349,10 +494,24 @@ class ActionRef(object):
         self.action = action
         self.params = params or ParamList()
 
+    def __getstate__(self):
+        state = []
+        if self.params.params:
+            params = [param.expr for param in self.params.params]
+            state.append(("params", params))
+        state.append(('action', self.action))
+        return state
+
+    def __setstate__(self, state):
+        state = dict(state)
+        action = state["action"]
+        params = [NumberDef(param) for param in state.get("params", [])]
+        self.__init__(action, ParamList(params))
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
-        action = cls(element.get("label"), ParamList.FromElement(doc, element))
+        action = cls(element.get("label"), ParamList.FromXML(doc, element))
         doc._action_refs.append(action)
         return action
 
@@ -363,33 +522,102 @@ class ActionRef(object):
         return "%s(params=%r, action=%r)" % (
             type(self).__name__, self.params, self.action)
 
+class Offset(object):
+    """Provide an offset to a bullet's initial position."""
+
+    VALID_TYPES = ["relative", "absolute"]
+
+    def __init__(self, type, x, y):
+        if type not in self.VALID_TYPES:
+            raise ValueError("invalid type %r" % type)
+        self.type = type
+        self.x = x
+        self.y = y
+
+    def __getstate__(self):
+        state = [('type', self.type)]
+        if self.x:
+            state.append(('x', self.x.expr))
+        if self.y:
+            state.append(('y', self.y.expr))
+        return state
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(state["type"], state.get("x"), state.get("y"))
+
+    @classmethod
+    def FromXML(cls, doc, element):
+        """Construct using an ElementTree-style element."""
+        type = element.get("type", "relative")
+        x = None
+        y = None
+        for subelem in element:
+            tag = realtag(subelem)
+            if tag == "x":
+                x = NumberDef(subelem.text)
+            elif tag == "y":
+                y = NumberDef(subelem.text)
+        return cls(type, x, y)
+
+    def __call__(self, params, rank):
+        return (self.x(params, rank) if self.x else 0,
+                self.y(params, rank) if self.y else 0)
+
 class FireDef(object):
     """Fire definition (creates a bullet)."""
 
-    def __init__(self, bullet, direction=None, speed=None):
+    def __init__(self, bullet, direction=None, speed=None, offset=None):
         self.bullet = bullet
         self.direction = direction
         self.speed = speed
+        self.offset = offset
+
+    def __getstate__(self):
+        state = []
+        if self.direction:
+            state.append(("direction", self.direction))
+        if self.speed:
+            state.append(("speed", self.speed))
+        if self.offset:
+            state.append(("offset", self.offset))
+        try:
+            params = self.bullet.params
+        except AttributeError:
+            state = dict(bullet=self.bullet)
+        else:
+            if params.params:
+                state.append(('bullet', self.bullet))
+            else:
+                # Strip out empty BulletRefs.
+                state.append(('bullet', self.bullet.bullet))
+        return state
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(**state)
 
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
         direction = None
         speed = None
+        offset = None
 
         for subelem in element.getchildren():
             tag = realtag(subelem)
             if tag == "direction":
-                direction = Direction.FromElement(doc, subelem, "aim")
+                direction = Direction.FromXML(doc, subelem, "aim")
             elif tag == "speed":
-                speed = Speed.FromElement(doc, subelem)
+                speed = Speed.FromXML(doc, subelem)
             elif tag == "bullet":
-                bullet = BulletDef.FromElement(doc, subelem)
+                bullet = BulletDef.FromXML(doc, subelem)
             elif tag == "bulletRef":
-                bullet = BulletRef.FromElement(doc, subelem)
-
+                bullet = BulletRef.FromXML(doc, subelem)
+            elif tag == "offset":
+                offset = Offset.FromXML(doc, subelem)
         try:
-            fire = cls(bullet, direction, speed)
+            fire = cls(bullet, direction, speed, offset)
         except UnboundLocalError as exc:
             raise ParseError(str(exc))
         else:
@@ -402,7 +630,7 @@ class FireDef(object):
             direction = self.direction(params, rank)
         if self.speed:
             speed = self.speed(params, rank)
-        return direction, speed, actions
+        return direction, speed, actions, self.offset
 
     def __repr__(self):
         return "%s(direction=%r, speed=%r, bullet=%r)" % (
@@ -415,15 +643,28 @@ class FireRef(object):
         self.fire = fire
         self.params = params or ParamList()
 
+    def __getstate__(self):
+        state = []
+        if self.params.params:
+            params = [param.expr for param in self.params.params]
+            state.append(("params", params))
+        state.append(('fire', self.fire))
+        return state
+
+    def __setstate__(self, state):
+        state = dict(state)
+        fire = state["fire"]
+        params = [NumberDef(param) for param in state.get("params", [])]
+        self.__init__(fire, ParamList(params))
+
     @classmethod
-    def FromElement(cls, doc, element):
+    def FromXML(cls, doc, element):
         """Construct using an ElementTree-style element."""
-        fired = cls(element.get("label"), ParamList.FromElement(doc, element))
+        fired = cls(element.get("label"), ParamList.FromXML(doc, element))
         doc._fire_refs.append(fired)
         return fired
 
     def __call__(self, params, rank):
-        """Generate a Bullet from the FireDef and params."""
         return self.fire(self.params(params, rank), rank)
 
     def __repr__(self):
@@ -435,6 +676,12 @@ class BulletML(object):
 
     A BulletML document is a collection of bullets, actions, and
     firings, as well as a base game type.
+
+    You can add tags to the BulletML.CONSTRUCTORS dictionary to extend
+    its parsing. It maps tag names to classes with a FromXML
+    classmethod, which take the BulletML instance and ElementTree
+    element as arguments.
+    
     """
 
     CONSTRUCTORS = dict(
@@ -443,15 +690,23 @@ class BulletML(object):
         fire=FireDef,
         )
 
-    def __init__(self, type="none", bullets={}, fires={}, actions={}):
+    def __init__(self, type="none", bullets=None, fires=None, actions=None):
         self.type = type
-        self.bullets = {}
-        self.actions = {}
-        self.fires = {}
+        self.bullets = {} if bullets is None else bullets
+        self.actions = {} if actions is None else actions
+        self.fires = {} if fires is None else fires
+
+    def __getstate__(self):
+        return [('type', self.type), ('actions', self.actions)]
+
+    def __setstate__(self, state):
+        state = dict(state)
+        self.__init__(state["type"], actions=state.get("actions"))
 
     @classmethod
-    def FromDocument(cls, source):
-        if isinstance(source, (str, unicode)):
+    def FromXML(cls, source):
+        """Return a BulletML instance based on XML."""
+        if not hasattr(source, 'read'):
             source = StringIO(source)
 
         tree = ElementTree()
@@ -466,7 +721,7 @@ class BulletML(object):
         for element in root.getchildren():
             tag = realtag(element)
             if tag in self.CONSTRUCTORS:
-                self.CONSTRUCTORS[tag].FromElement(self, element)
+                self.CONSTRUCTORS[tag].FromXML(self, element)
 
         try:
             for ref in self._bullet_refs:
@@ -488,10 +743,43 @@ class BulletML(object):
 
         return self
 
+    @classmethod
+    def FromYAML(cls, source):
+        """Create a BulletML instance based on YAML."""
+
+        # Late import to avoid a circular dependency.
+        try:
+            import bulletml.bulletyaml
+            import yaml
+        except ImportError:
+            raise ParseError("PyYAML is not available")
+        else:
+            try:
+                return yaml.load(source)
+            except Exception, exc:
+                raise ParseError(str(exc))
+
+    @classmethod
+    def FromDocument(cls, source):
+        """Create a BulletML instance based on a seekable file or string.
+
+        This attempts to autodetect if the stream is XML or YAML.
+        """
+        if not hasattr(source, 'read'):
+            source = StringIO(source)
+        start = source.read(1)
+        source.seek(0)
+        if start == "<":
+            return cls.FromXML(source)
+        elif start == "!" or start == "#":
+            return cls.FromYAML(source)
+        else:
+            raise ParseError("unknown initial character %r" % start)
+
     @property
     def top(self):
         """Get a list of all top-level actions."""
-        return [dfn for name, dfn in self.actions.iteritems()
+        return [dfn for name, dfn in self.actions.items()
                 if name and name.startswith("top")]
 
     def __repr__(self):
@@ -500,13 +788,15 @@ class BulletML(object):
             self.fires)
 
 ActionDef.CONSTRUCTORS = dict(
-        repeat=Repeat,
-        fire=FireDef,
-        fireRef=FireRef,
-        changeSpeed=ChangeSpeed,
-        changeDirection=ChangeDirection,
-        accel=Accel,
-        wait=Wait,
-        vanish=Vanish,
-        action=ActionDef,
-        actionRef=ActionRef)
+    repeat=Repeat,
+    fire=FireDef,
+    fireRef=FireRef,
+    changeSpeed=ChangeSpeed,
+    changeDirection=ChangeDirection,
+    accel=Accel,
+    wait=Wait,
+    vanish=Vanish,
+    tag=Tag,
+    untag=Untag,
+    action=ActionDef,
+    actionRef=ActionRef)