Add SubSpell handling

Author: beheh

README.md

@@ -49,6 +49,8 @@ This is the default dispatch lookup:
 * `Options`: `handle_options`
 * `Option`: `handle_option`
 * `SendOption`: `handle_send_option`
+* `ResetGame`: `handle_reset_game`
+* `SubSpell`: `handle_sub_spell`
 
 All of the methods in the dispatch dict should be implemented.
 

hslog/export.py

@@ -28,6 +28,7 @@ def get_dispatch_dict(self):
 			packets.Option: self.handle_option,
 			packets.SendOption: self.handle_send_option,
 			packets.ResetGame: self.handle_reset_game,
+			packets.SubSpell: self.handle_sub_spell,
 		}
 
 	def export(self):
@@ -91,6 +92,9 @@ def handle_send_option(self, packet):
 	def handle_reset_game(self, packet):
 		pass
 
+	def handle_sub_spell(self, packet):
+		pass
+
 
 class EntityTreeExporter(BaseExporter):
 	game_class = Game

hslog/packets.py

@@ -248,3 +248,25 @@ def __init__(self, ts, option, suboption, target, position):
 class ResetGame(Packet):
 	def __init__(self, ts):
 		self.ts = ts
+
+
+class SubSpell(Packet):
+	power_type = PowerType.SUB_SPELL_START
+
+	def __init__(self, ts, spell_prefab_guid, source, target_count):
+		self.ts = ts
+		self.spell_prefab_guid = spell_prefab_guid
+		self.source = source
+		self.target_count = target_count
+		self.ended = False
+		self.source = None
+		self.targets = []
+		self.packets = []
+
+	def __repr__(self):
+		return "%s(spell_prefab_guid=%r, source=%r)" % (
+			self.__class__.__name__, self.spell_prefab_guid, self.source
+		)
+
+	def end(self):
+		self.ended = True

hslog/parser.py

@@ -146,6 +146,26 @@ def handle_data(self, ts, data):
 			idx, entity = sre.groups()
 			entity = self.parse_entity_or_player(entity)
 			self._metadata_node.info.append(entity)
+		elif opcode == "Source":
+			sre = tokens.SUB_SPELL_START_SOURCE_RE.match(data)
+			if not sre:
+				raise RegexParsingError(data)
+			entity, = sre.groups()
+			entity = self.parse_entity_or_player(entity)
+			if not isinstance(self.current_block, packets.SubSpell):
+				logging.warning("SubSpell Source outside of SUB_SPELL: %r", data)
+				return
+			self.current_block.source = entity
+		elif opcode.startswith("Targets["):
+			sre = tokens.SUB_SPELL_START_TARGETS_RE.match(data)
+			if not sre:
+				raise RegexParsingError(data)
+			idx, entity = sre.groups()
+			entity = self.parse_entity_or_player(entity)
+			if not isinstance(self.current_block, packets.SubSpell):
+				logging.warning("SubSpell Target outside of SUB_SPELL: %r", data)
+				return
+			self.current_block.targets.append(entity)
 		else:
 			raise NotImplementedError(data)
 
@@ -211,6 +231,10 @@ def handle_power(self, ts, opcode, data):
 			regex, callback = tokens.META_DATA_RE, self.meta_data
 		elif opcode == "RESET_GAME":
 			regex, callback = tokens.RESET_GAME_RE, self.reset_game
+		elif opcode == "SUB_SPELL_START":
+			regex, callback = tokens.SUB_SPELL_START_RE, self.sub_spell_start
+		elif opcode == "SUB_SPELL_END":
+			regex, callback = tokens.SUB_SPELL_END_RE, self.sub_spell_end
 		else:
 			raise NotImplementedError(data)
 
@@ -337,6 +361,25 @@ def reset_game(self, ts):
 		self.register_packet(packet)
 		return packet
 
+	def sub_spell_start(self, ts, spell_prefab_guid, source, target_count):
+		id = int(source)
+		target_count = int(target_count)
+
+		sub_spell = packets.SubSpell(ts, spell_prefab_guid, id, target_count)
+		sub_spell.parent = self.current_block
+		self.register_packet(sub_spell)
+		self.current_block = sub_spell
+		return sub_spell
+
+	def sub_spell_end(self, ts):
+		if not self.current_block.parent:
+			logging.warning("[%s] Orphaned SUB_SPELL_END detected", ts)
+			return self.current_block
+		self.current_block.end()
+		sub_spell = self.current_block
+		self.current_block = self.current_block.parent
+		return sub_spell
+
 
 class OptionsHandler:
 	def __init__(self):

hslog/tokens.py

@@ -34,10 +34,14 @@
 TAG_CHANGE_RE = re.compile(r"TAG_CHANGE Entity=%s tag=(\w+) value=(\w+) ?(%s)?" % (_E, DEF_CHANGE))
 META_DATA_RE = re.compile(r"META_DATA - Meta=(\w+) Data=%s InfoCount=(\d+)" % _E)
 RESET_GAME_RE = re.compile(r"RESET_GAME$")
+SUB_SPELL_START_RE = re.compile(r"SUB_SPELL_START - SpellPrefabGUID=([\w:]+) Source=(\d+) TargetCount=(\d+)$")
+SUB_SPELL_END_RE = re.compile(r"SUB_SPELL_END$")
 
 # Message details
 TAG_VALUE_RE = re.compile(r"tag=(\w+) value=(\w+)")
 METADATA_INFO_RE = re.compile(r"Info\[(\d+)\] = %s" % _E)
+SUB_SPELL_START_SOURCE_RE = re.compile(r"Source = %s" % _E)
+SUB_SPELL_START_TARGETS_RE = re.compile(r"Targets\[(\d+)\] = %s" % _E)
 
 # Game
 GAME_PLAYER_META = re.compile(r"PlayerID=(\d+), PlayerName=(.*)")

tests/data.py

@@ -162,3 +162,16 @@
 D 14:43:59.9999997 GameState.DebugPrintPower() -     TAG_CHANGE Entity=[entityName=Malchezaar's Imp id=18 zone=HAND zonePos=3 cardId=KAR_089 player=1] tag=ZONE_POSITION value=2
 D 14:43:59.9999997 GameState.DebugPrintPower() -     TAG_CHANGE Entity=[entityName=Bonemare id=25 zone=HAND zonePos=2 cardId=ICC_705 player=1] tag=ZONE_POSITION value=0
 """.strip()
+
+SUB_SPELL_BLOCK = """
+D 23:58:17.9818688 GameState.DebugPrintPower() - BLOCK_START BlockType=PLAY Entity=[entityName=UNKNOWN ENTITY [cardType=INVALID] id=80 zone=HAND zonePos=4 cardId= player=2] EffectCardId= EffectIndex=0 Target=0 SubOption=-1 
+D 23:58:17.9828680 GameState.DebugPrintPower() -     BLOCK_START BlockType=POWER Entity=[entityName=UNKNOWN ENTITY [cardType=INVALID] id=80 zone=HAND zonePos=4 cardId= player=2] EffectCardId= EffectIndex=0 Target=0 SubOption=-1 
+D 23:58:17.9838675 GameState.DebugPrintPower() -         SUB_SPELL_START - SpellPrefabGUID=CannonBarrage_Missile_FX:e26b4681614e0964aa8ef7afebc560d1 Source=59 TargetCount=1
+D 23:58:17.9838675 GameState.DebugPrintPower() -                           Source = [entityName=Ol' Toomba id=59 zone=PLAY zonePos=0 cardId=DALA_BOSS_37h player=2]
+D 23:58:17.9838675 GameState.DebugPrintPower() -                           Targets[0] = [entityName=Don Han'Cho id=41 zone=PLAY zonePos=7 cardId=CFM_685 player=1]
+D 23:58:17.9838675 GameState.DebugPrintPower() -             META_DATA - Meta=HISTORY_TARGET Data=0 InfoCount=1
+D 23:58:17.9838675 GameState.DebugPrintPower() -                         Info[0] = [entityName=Don Han'Cho id=41 zone=PLAY zonePos=7 cardId=CFM_685 player=1]
+D 23:58:17.9838675 GameState.DebugPrintPower() -             TAG_CHANGE Entity=[entityName=Don Han'Cho id=41 zone=PLAY zonePos=7 cardId=CFM_685 player=1] tag=PREDAMAGE value=3 
+D 23:58:17.9838675 GameState.DebugPrintPower() -         SUB_SPELL_END
+D 23:58:17.9848671 GameState.DebugPrintPower() - BLOCK_END
+""".strip()

tests/test_main.py

@@ -14,8 +14,8 @@
 from hslog.parser import parse_entity_id, parse_initial_tag
 
 from .data import (
-	CONTROLLER_CHANGE, EMPTY_GAME, FULL_ENTITY, INITIAL_GAME,
-	INVALID_GAME, OPTIONS_WITH_ERRORS, UNROUNDABLE_TIMESTAMP
+	CONTROLLER_CHANGE, EMPTY_GAME, FULL_ENTITY, INITIAL_GAME, INVALID_GAME,
+	OPTIONS_WITH_ERRORS, SUB_SPELL_BLOCK, UNROUNDABLE_TIMESTAMP
 )
 
 
@@ -377,3 +377,24 @@ def test_reset_game():
 		"D 15:39:19.3190860 GameState.DebugPrintPower() -     RESET_GAME\n"
 	))
 	parser.flush()
+
+
+def test_sub_spell():
+	parser = LogParser()
+	parser.read(StringIO(INITIAL_GAME))
+
+	parser.read(StringIO(SUB_SPELL_BLOCK))
+	parser.flush()
+
+	packet_tree = parser.games[0]
+	play_block = packet_tree.packets[-1]
+	power_block = play_block.packets[0]
+	assert len(power_block.packets) == 1
+	sub_spell_packet = power_block.packets[0]
+
+	assert sub_spell_packet.spell_prefab_guid == (
+		"CannonBarrage_Missile_FX:e26b4681614e0964aa8ef7afebc560d1"
+	)
+	assert sub_spell_packet.source == 59
+	assert sub_spell_packet.target_count == 1
+	assert sub_spell_packet.targets == [41]