Action: Don't need the owner in the constructor. Factory function to create a child.
[python-bulletml.git] / bulletml / parser.py
index 9b2fbf8..c8bc990 100644 (file)
@@ -3,16 +3,22 @@
 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.
+Unless you are adding support for new actions, the only class you
+should care about in here is BulletML.
 """
 
 from __future__ import division
 
-import math
+from math import sin, cos, radians, pi as PI
 
 from xml.etree.ElementTree import ElementTree
 
+# Python 3 moved this for no really good reason.
+try:
+    from sys import intern
+except ImportError:
+    pass
+
 try:
     from io import StringIO
 except ImportError:
@@ -25,7 +31,9 @@ from bulletml.errors import Error
 from bulletml.expr import NumberDef, INumberDef
 
 
-__all_ = ["ParseError", "BulletML"]
+__all__ = ["ParseError", "BulletML"]
+
+PI_2 = PI * 2
 
 class ParseError(Error):
     """Raised when an error occurs parsing the XML structure."""
@@ -64,7 +72,7 @@ class Direction(object):
     def __init__(self, type, value):
         if type not in self.VALID_TYPES:
             raise ValueError("invalid type %r" % type)
-        self.type = type
+        self.type = intern(type)
         self.value = value
 
     def __getstate__(self):
@@ -80,7 +88,7 @@ class Direction(object):
         return cls(element.get("type", default), NumberDef(element.text))
 
     def __call__(self, params, rank):
-        return (math.radians(self.value(params, rank)), self.type)
+        return (radians(self.value(params, rank)), self.type)
 
     def __repr__(self):
         return "%s(%r, type=%r)" % (
@@ -117,8 +125,26 @@ class ChangeDirection(object):
         except UnboundLocalError as exc:
             raise ParseError(str(exc))
 
-    def __call__(self, params, rank):
-        return self.term(params, rank), self.direction(params, rank)
+    def __call__(self, owner, action, params, rank, created):
+        frames = self.term(params, rank)
+        direction, type = self.direction(params, rank)
+        action.direction_frames = frames
+        action.aiming = False
+        if type == "sequence":
+            action.direction = direction
+        else:
+            if type == "absolute":
+                direction -= owner.direction
+            elif type != "relative": # aim or default
+                action.aiming = True
+                direction += owner.aim - owner.direction
+
+            # Normalize to [-pi, pi).
+            direction = (direction + PI) % PI_2 - PI
+            if frames <= 0:
+                owner.direction += direction
+            else:
+                action.direction = direction / frames
 
     def __repr__(self):
         return "%s(term=%r, direction=%r)" % (
@@ -132,7 +158,7 @@ class Speed(object):
     def __init__(self, type, value):
         if type not in self.VALID_TYPES:
             raise ValueError("invalid type %r" % type)
-        self.type = type
+        self.type = intern(type)
         self.value = value
 
     def __getstate__(self):
@@ -184,8 +210,21 @@ class ChangeSpeed(object):
         except UnboundLocalError as exc:
             raise ParseError(str(exc))
 
-    def __call__(self, params, rank):
-        return self.term(params, rank), self.speed(params, rank)
+    def __call__(self, owner, action, params, rank, created):
+        frames = self.term(params, rank)
+        speed, type = self.speed(params, rank)
+        action.speed_frames = frames
+        if frames <= 0:
+            if type == "absolute":
+                owner.speed = speed
+            elif type == "relative":
+                owner.speed += speed
+        elif type == "sequence":
+            action.speed = speed
+        elif type == "relative":
+            action.speed = speed / frames
+        else:
+            action.speed = (speed - owner.speed) / frames
 
     def __repr__(self):
         return "%s(term=%r, speed=%r)" % (
@@ -208,8 +247,9 @@ class Wait(object):
         """Construct using an ElementTree-style element."""
         return cls(INumberDef(element.text))
 
-    def __call__(self, params, rank):
-        return self.frames(params, rank)
+    def __call__(self, owner, action, params, rank, created):
+        action.wait_frames = self.frames(params, rank)
+        return True
 
     def __repr__(self):
         return "%s(%r)" % (type(self).__name__, self.frames)
@@ -231,6 +271,9 @@ class Tag(object):
         """Construct using an ElementTree-style element."""
         return cls(element.text)
 
+    def __call__(self, owner, action, params, rank, created):
+        owner.tags.add(self.tag)
+
 class Untag(object):
     """Unset a bullet tag."""
 
@@ -248,6 +291,32 @@ class Untag(object):
         """Construct using an ElementTree-style element."""
         return cls(element.text)
 
+    def __call__(self, owner, action, params, rank, created):
+        try:
+            owner.tags.remove(self.tag)
+        except KeyError:
+            pass
+
+class Appearance(object):
+    """Set a bullet appearance."""
+
+    def __init__(self, appearance):
+        self.appearance = appearance
+
+    def __getstate__(self):
+        return dict(appearance=self.appearance)
+
+    def __setstate__(self, state):
+        self.__init__(state["appearance"])
+
+    @classmethod
+    def FromXML(cls, doc, element):
+        """Construct using an ElementTree-style element."""
+        return cls(element.text)
+
+    def __call__(self, owner, action, params, rank, created):
+        owner.apearance = self.appearance
+
 class Vanish(object):
     """Make the owner disappear."""
 
@@ -262,6 +331,10 @@ class Vanish(object):
     def __repr__(self):
         return "%s()" % (type(self).__name__)
 
+    def __call__(self, owner, action, params, rank, created):
+        owner.vanish()
+        return True
+
 class Repeat(object):
     """Repeat an action definition."""
 
@@ -292,12 +365,69 @@ class Repeat(object):
         except UnboundLocalError as exc:
             raise ParseError(str(exc))
 
-    def __call__(self, params, rank):
-        return self.times(params, rank), self.action(params, rank)
+    def __call__(self, owner, action, params, rank, created):
+        repeat = self.times(params, rank)
+        actions, params = self.action(params, rank)
+        child = action.Child(actions, params, rank, repeat)
+        owner.replace(action, child)
+        child.step(owner, created)
+        return True
 
     def __repr__(self):
         return "%s(%r, %r)" % (type(self).__name__, self.times, self.action)
 
+class If(object):
+    """Conditional actions."""
+
+    def __init__(self, cond, then, else_=None):
+        self.cond = cond
+        self.then = then
+        self.else_ = else_
+
+    def __getstate__(self):
+        if self.else_:
+            return [('cond', self.cond.expr),
+                    ('then', self.then),
+                    ('else', self.else_)]
+        else:
+            return [('cond', self.cond.expr), ('then', self.then)]
+
+    def __setstate__(self, state):
+        state = dict(state)
+        state["else_"] = state.pop("else", None)
+        state["cond"] = INumberDef(state["cond"])
+        self.__init__(**state)
+
+    @classmethod
+    def FromXML(cls, doc, element):
+        """Construct using an ElementTree-style element."""
+        else_ = None
+        for subelem in element.getchildren():
+            tag = realtag(subelem)
+            if tag == "cond":
+                cond = INumberDef(subelem.text)
+            elif tag == "then":
+                then = ActionDef.FromXML(doc, subelem)
+            elif tag == "else":
+                else_ = ActionDef.FromXML(doc, subelem)
+        try:
+            return cls(cond, then, else_)
+        except UnboundLocalError as exc:
+            raise ParseError(str(exc))
+
+    def __call__(self, owner, action, params, rank, created):
+        if self.cond(params, rank):
+            branch = self.then
+        else:
+            branch = self.else_
+
+        if branch:
+            actions, params = branch(params, rank)
+            child = action.Child(actions, params, rank)
+            owner.replace(action, child)
+            child.step(owner, created)
+            return True
+        
 class Accel(object):
     """Accelerate over some time."""
 
@@ -342,11 +472,37 @@ class Accel(object):
         except AttributeError:
             raise ParseError
 
-    def __call__(self, params, rank):
+    def __call__(self, owner, action, params, rank, created):
         frames = self.term(params, rank)
         horizontal = self.horizontal and self.horizontal(params, rank)
         vertical = self.vertical and self.vertical(params, rank)
-        return frames, horizontal, vertical
+        action.accel_frames = frames
+        if horizontal:
+            mx, type = horizontal
+            if frames <= 0:
+                if type == "absolute":
+                    owner.mx = mx
+                elif type == "relative":
+                    owner.mx += mx
+            elif type == "sequence":
+                action.mx = mx
+            elif type == "absolute":
+                action.mx = (mx - owner.mx) / frames
+            elif type == "relative":
+                action.mx = mx / frames
+        if vertical:
+            my, type = vertical
+            if frames <= 0:
+                if type == "absolute":
+                    owner.my = my
+                elif type == "relative":
+                    owner.my += my
+            elif type == "sequence":
+                action.my = my
+            elif type == "absolute":
+                action.my = (my - owner.my) / frames
+            elif type == "relative":
+                action.my = my / frames
 
     def __repr__(self):
         return "%s(%r, horizontal=%r, vertical=%r)" % (
@@ -355,13 +511,13 @@ class Accel(object):
 class BulletDef(object):
     """Bullet definition."""
 
-    direction = None
-    speed = None
-
-    def __init__(self, actions=[], direction=None, speed=None):
+    def __init__(self, actions=(), direction=None, speed=None, tags=(),
+                 appearance=None):
         self.direction = direction
         self.speed = speed
         self.actions = list(actions)
+        self.tags = set(tags)
+        self.appearance = appearance
 
     def __getstate__(self):
         state = []
@@ -371,6 +527,10 @@ class BulletDef(object):
             state.append(("speed", self.speed))
         if self.actions:
             state.append(("actions", self.actions))
+        if self.tags:
+            state.append(("tags", list(self.tags)))
+        if self.appearance:
+            state.append(("appearance", self.appearance))
         return state
 
     def __setstate__(self, state):
@@ -383,6 +543,7 @@ class BulletDef(object):
         actions = []
         speed = None
         direction = None
+        tags = set()
         for subelem in element.getchildren():
             tag = realtag(subelem)
             if tag == "direction":
@@ -393,7 +554,9 @@ class BulletDef(object):
                 actions.append(ActionDef.FromXML(doc, subelem))
             elif tag == "actionRef":
                 actions.append(ActionRef.FromXML(doc, subelem))
-        dfn = cls(actions, direction, speed)
+            elif tag == "tag":
+                tags.add(subelem.text)
+        dfn = cls(actions, direction, speed, tags)
         doc._bullets[element.get("label")] = dfn
         return dfn
 
@@ -402,6 +565,8 @@ class BulletDef(object):
         return (
             self.direction and self.direction(params, rank),
             self.speed and self.speed(params, rank),
+            self.tags,
+            self.appearance,
             actions)
 
     def __repr__(self):
@@ -530,7 +695,7 @@ class Offset(object):
     def __init__(self, type, x, y):
         if type not in self.VALID_TYPES:
             raise ValueError("invalid type %r" % type)
-        self.type = type
+        self.type = intern(type)
         self.x = x
         self.y = y
 
@@ -544,7 +709,9 @@ class Offset(object):
 
     def __setstate__(self, state):
         state = dict(state)
-        self.__init__(state["type"], state.get("x"), state.get("y"))
+        x = NumberDef(state["x"]) if "x" in state else None
+        y = NumberDef(state["y"]) if "y" in state else None
+        self.__init__(state["type"], x, y)
 
     @classmethod
     def FromXML(cls, doc, element):
@@ -567,11 +734,14 @@ class Offset(object):
 class FireDef(object):
     """Fire definition (creates a bullet)."""
 
-    def __init__(self, bullet, direction=None, speed=None, offset=None):
+    def __init__(self, bullet, direction=None, speed=None, offset=None,
+                 tags=(), appearance=None):
         self.bullet = bullet
         self.direction = direction
         self.speed = speed
         self.offset = offset
+        self.tags = set(tags)
+        self.appearance = appearance
 
     def __getstate__(self):
         state = []
@@ -581,6 +751,10 @@ class FireDef(object):
             state.append(("speed", self.speed))
         if self.offset:
             state.append(("offset", self.offset))
+        if self.tags:
+            state.append(("tags", list(self.tags)))
+        if self.appearance:
+            state.append(("appearance", self.appearance))
         try:
             params = self.bullet.params
         except AttributeError:
@@ -603,6 +777,8 @@ class FireDef(object):
         direction = None
         speed = None
         offset = None
+        tags = set()
+        appearance = None
 
         for subelem in element.getchildren():
             tag = realtag(subelem)
@@ -616,21 +792,74 @@ class FireDef(object):
                 bullet = BulletRef.FromXML(doc, subelem)
             elif tag == "offset":
                 offset = Offset.FromXML(doc, subelem)
+            elif tag == "tag":
+                tags.add(subelem.text)
+            elif tag == "appearance":
+                appearance = subelem.text
         try:
-            fire = cls(bullet, direction, speed, offset)
+            fire = cls(bullet, direction, speed, offset, tags, appearance)
         except UnboundLocalError as exc:
             raise ParseError(str(exc))
         else:
             doc._fires[element.get("label")] = fire
             return fire
 
-    def __call__(self, params, rank):
-        direction, speed, actions = self.bullet(params, rank)
+    def __call__(self, owner, action, params, rank, created):
+        direction, speed, tags, appearance, actions = self.bullet(params, rank)
         if self.direction:
             direction = self.direction(params, rank)
         if self.speed:
             speed = self.speed(params, rank)
-        return direction, speed, actions, self.offset
+        tags = tags.union(self.tags)
+        if self.appearance:
+            appearance = self.appearance
+
+        if direction:
+            direction, type = direction
+            if type == "aim" or type is None:
+                direction += owner.aim
+            elif type == "sequence":
+                direction += action.previous_fire_direction
+            elif type == "relative":
+                direction += owner.direction
+        else:
+            direction = owner.aim
+        action.previous_fire_direction = direction
+
+        if speed:
+            speed, type = speed
+            if type == "sequence":
+                speed += action.previous_fire_speed
+            elif type == "relative":
+                # The reference Noiz implementation uses
+                # prvFireSpeed here, but the standard is
+                # pretty clear -- "In case of the type is
+                # "relative", ... the speed is relative to the
+                # speed of this bullet."
+                speed += owner.speed
+        else:
+            speed = 1
+        action.previous_fire_speed = speed
+
+        x, y = owner.x, owner.y
+        if self.offset:
+            off_x, off_y = self.offset(params, rank)
+            if self.offset.type == "relative":
+                s = sin(direction)
+                c = cos(direction)
+                x += c * off_x + s * off_y
+                y += s * off_x - c * off_y
+            else:
+                x += off_x
+                y += off_y
+
+        if appearance is None:
+            appearance = owner.appearance
+        bullet = owner.__class__(
+            x=x, y=y, direction=direction, speed=speed,
+            target=owner.target, actions=actions, rank=rank,
+            appearance=appearance, tags=tags, Action=action.__class__)
+        created.append(bullet)
 
     def __repr__(self):
         return "%s(direction=%r, speed=%r, bullet=%r)" % (
@@ -664,8 +893,9 @@ class FireRef(object):
         doc._fire_refs.append(fired)
         return fired
 
-    def __call__(self, params, rank):
-        return self.fire(self.params(params, rank), rank)
+    def __call__(self, owner, action, params, rank, created):
+        params = self.params(params, rank)
+        return self.fire(owner, action, params, rank, created)
 
     def __repr__(self):
         return "%s(params=%r, fire=%r)" % (
@@ -691,7 +921,7 @@ class BulletML(object):
         )
 
     def __init__(self, type="none", actions=None):
-        self.type = type
+        self.type = intern(type)
         self.actions = [] if actions is None else actions
 
     def __getstate__(self):
@@ -710,41 +940,41 @@ class BulletML(object):
         tree = ElementTree()
         root = tree.parse(source)
 
-        self = cls(type=root.get("type", "none"))
+        doc = cls(type=root.get("type", "none"))
 
-        self._bullets = {}
-        self._actions = {}
-        self._fires = {}
-        self._bullet_refs = []
-        self._action_refs = []
-        self._fire_refs = []
+        doc._bullets = {}
+        doc._actions = {}
+        doc._fires = {}
+        doc._bullet_refs = []
+        doc._action_refs = []
+        doc._fire_refs = []
 
         for element in root.getchildren():
             tag = realtag(element)
-            if tag in self.CONSTRUCTORS:
-                self.CONSTRUCTORS[tag].FromXML(self, element)
+            if tag in doc.CONSTRUCTORS:
+                doc.CONSTRUCTORS[tag].FromXML(doc, element)
 
         try:
-            for ref in self._bullet_refs:
-                ref.bullet = self._bullets[ref.bullet]
-            for ref in self._fire_refs:
-                ref.fire = self._fires[ref.fire]
-            for ref in self._action_refs:
-                ref.action = self._actions[ref.action]
+            for ref in doc._bullet_refs:
+                ref.bullet = doc._bullets[ref.bullet]
+            for ref in doc._fire_refs:
+                ref.fire = doc._fires[ref.fire]
+            for ref in doc._action_refs:
+                ref.action = doc._actions[ref.action]
         except KeyError as exc:
             raise ParseError("unknown reference %s" % exc)
 
-        self.actions = [act for name, act in self._actions.items()
+        doc.actions = [act for name, act in doc._actions.items()
                         if name and name.startswith("top")]
 
-        del(self._bullet_refs)
-        del(self._action_refs)
-        del(self._fire_refs)
-        del(self._bullets)
-        del(self._actions)
-        del(self._fires)
+        del(doc._bullet_refs)
+        del(doc._action_refs)
+        del(doc._fire_refs)
+        del(doc._bullets)
+        del(doc._actions)
+        del(doc._fires)
         
-        return self
+        return doc
 
     @classmethod
     def FromYAML(cls, source):
@@ -759,7 +989,7 @@ class BulletML(object):
         else:
             try:
                 return yaml.load(source)
-            except Exception, exc:
+            except Exception as exc:
                 raise ParseError(str(exc))
 
     @classmethod
@@ -793,6 +1023,8 @@ ActionDef.CONSTRUCTORS = dict(
     wait=Wait,
     vanish=Vanish,
     tag=Tag,
+    appearance=Appearance,
     untag=Untag,
     action=ActionDef,
     actionRef=ActionRef)
+ActionDef.CONSTRUCTORS["if"] = If