"""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
+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
class ParamList(object):
"""List of parameter definitions."""
- def __init__(self, params=[]):
+ def __init__(self, params=()):
self.params = list(params)
@classmethod
return cls([NumberDef(subelem.text) for subelem in element
if realtag(subelem) == "param"])
+ def __getstate__(self):
+ if self.params:
+ return dict(params=[param.expr for param in self.params])
+ else:
+ return {}
+
+ def __setstate__(self, state):
+ self.__init__(NumberDef(param) for param in state.get("params", []))
+
def __call__(self, params, rank):
return [param(params, rank) for param in self.params]
self.type = type
self.value = value
+ def __getstate__(self):
+ return dict(type=self.type, value=self.value.expr)
+
+ def __setstate__(self, state):
+ self.__init__(state["type"], NumberDef(state["value"]))
+
@classmethod
def FromElement(cls, doc, element, default="absolute"):
"""Construct using an ElementTree-style element."""
return cls(element.get("type", default), NumberDef(element.text))
def __call__(self, params, rank):
- return (self.value(params, rank), self.type)
+ return (math.radians(self.value(params, rank)), self.type)
def __repr__(self):
return "%s(%r, type=%r)" % (
self.term = term
self.direction = direction
+ def __getstate__(self):
+ return dict(frames=self.term.expr,
+ type=self.direction.type,
+ value=self.direction.value.expr)
+
+ def __setstate__(self, state):
+ self.__init__(INumberDef(state["frames"]),
+ Direction(state["type"], NumberDef(state["value"])))
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
self.type = type
self.value = value
+ def __getstate__(self):
+ return dict(type=self.type, value=self.value.expr)
+
+ def __setstate__(self, state):
+ self.__init__(state["type"], NumberDef(state["value"]))
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
self.term = term
self.speed = speed
+ def __getstate__(self):
+ return dict(frames=self.term.expr,
+ type=self.speed.type,
+ value=self.speed.value.expr)
+
+ def __setstate__(self, state):
+ self.__init__(INumberDef(state["frames"]),
+ Speed(state["type"], NumberDef(state["value"])))
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
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):
"""Construct using an ElementTree-style element."""
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 FromElement(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 FromElement(cls, doc, element):
+ """Construct using an ElementTree-style element."""
+ return cls(element.text)
+
class Vanish(object):
"""Make the owner disappear."""
def __init__(self, times, action):
self.times = times
self.action = action
+
+ def __getstate__(self):
+ return dict(times=self.times.expr, action=self.action)
+
+ def __setstate__(self, state):
+ self.__init__(INumberDef(state["times"]), state["action"])
@classmethod
def FromElement(cls, doc, element):
+ """Construct using an ElementTree-style element."""
for subelem in element.getchildren():
tag = realtag(subelem)
if tag == "times":
self.horizontal = horizontal
self.vertical = vertical
+ def __getstate__(self):
+ state = dict(frames=self.term.expr)
+ if self.horizontal:
+ state["horizontal"] = self.horizontal
+ if self.vertical:
+ state["vertical"] = self.vertical
+ return state
+
+ def __setstate__(self, state):
+ self.__init__(INumberDef(state["term"]), state.get("horizontal"),
+ state.get("vertical"))
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
self.speed = speed
self.actions = list(actions)
+ def __getstate__(self):
+ state = dict()
+ if self.direction:
+ state["direction"] = self.direction
+ if self.speed:
+ state["speed"] = self.speed
+ if self.actions:
+ state["actions"] = self.actions
+ return state
+
+ def __setstate__(self, state):
+ self.__init__(**state)
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
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 = dict(bullet=self.bullet)
+ if self.params.params:
+ state["params"] = self.params.__getstate__()
+ return state
+
+ def __setstate__(self, state):
+ bullet = state["bullet"]
+ params = [NumberDef(param) for param in state.get("params", [])]
+ self.__init__(bullet, params)
@classmethod
def FromElement(cls, doc, element):
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
+ FromElement classmethod, which take the BulletML instance and
+ ElementTree element as arguments.
+ """
# This is self-referential, so it's filled in later.
CONSTRUCTORS = dict()
def __init__(self, actions):
self.actions = list(actions)
+ def __getstate__(self):
+ return dict(actions=self.actions)
+
+ def __setstate__(self, state):
+ self.__init__(state)
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
self.action = action
self.params = params or ParamList()
+ def __getstate__(self):
+ state = dict(action=self.action)
+ if self.params.params:
+ state["params"] = self.params.__getstate__()
+ return state
+
+ def __setstate__(self, state):
+ action = state["action"]
+ params = [NumberDef(param) for param in state.get("params", [])]
+ self.__init__(action, params)
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
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 = dict(type=self.type)
+ if self.x:
+ state["x"] = self.x.expr
+ if self.y:
+ state["y"] = self.y.expr
+ return state
+
+ def __setstate__(self, state):
+ self.__init__(state["type"], state.get("x"), state.get("y"))
+
+ @classmethod
+ def FromElement(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):
+ try:
+ params = self.bullet.params
+ except AttributeError:
+ state = dict(bullet=self.bullet)
+ else:
+ if params.params:
+ state = dict(bullet=self.bullet)
+ else:
+ state = dict(bullet=self.bullet.bullet)
+ if self.direction:
+ state["direction"] = self.direction
+ if self.speed:
+ state["speed"] = self.speed
+ if self.offset:
+ state["offset"] = self.offset
+ return state
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
direction = None
speed = None
+ offset = None
for subelem in element.getchildren():
tag = realtag(subelem)
bullet = BulletDef.FromElement(doc, subelem)
elif tag == "bulletRef":
bullet = BulletRef.FromElement(doc, subelem)
-
+ elif tag == "offset":
+ offset = Offset.FromElement(doc, subelem)
try:
- fire = cls(bullet, direction, speed)
+ fire = cls(bullet, direction, speed, offset)
except UnboundLocalError as exc:
raise ParseError(str(exc))
else:
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)" % (
self.fire = fire
self.params = params or ParamList()
+ def __getstate__(self):
+ state = dict(fire=self.fire)
+ if self.params.params:
+ state["params"] = self.params.__getstate__()
+ return state
+
+ def __setstate__(self, state):
+ fire = state["fire"]
+ params = [NumberDef(param) for param in state.get("params", [])]
+ self.__init__(fire, params)
+
@classmethod
def FromElement(cls, doc, element):
"""Construct using an ElementTree-style element."""
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):
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 FromElement
+ classmethod, which take the BulletML instance and ElementTree
+ element as arguments.
+
"""
CONSTRUCTORS = dict(
fire=FireDef,
)
- def __init__(self, source):
- self.bullets = {}
- self.actions = {}
- self.fires = {}
+ def __init__(self, type="none", bullets=None, fires=None, actions=None):
+ self.type = type
+ self.bullets = {} if bullets is None else bullets
+ self.actions = {} if actions is None else actions
+ self.fires = {} if fires is None else fires
- self._bullet_refs = []
- self._action_refs = []
- self._fire_refs = []
+ def __getstate__(self):
+ return dict(type=self.type, actions=self.actions)
+
+ def __setstate__(self, state):
+ self.__init__(state["type"], state.get("actions"))
- if isinstance(source, (str, unicode)):
+ @classmethod
+ def FromDocument(cls, source):
+ """Return a BulletML instance based on a string or file-like."""
+ if not hasattr(source, 'read'):
source = StringIO(source)
tree = ElementTree()
root = tree.parse(source)
- self.type = root.get("type", "none")
+ self = cls(type=root.get("type", "none"))
+
+ self._bullet_refs = []
+ self._action_refs = []
+ self._fire_refs = []
for element in root.getchildren():
tag = realtag(element)
self.actions.pop(None, None)
self.fires.pop(None, None)
+ return self
+
@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):
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)