# -*- coding: utf-8 -*- #utilities to help disassemble pokémon crystal import sys, os, inspect, md5, json from copy import copy, deepcopy import subprocess from new import classobj import random #for IntervalMap from bisect import bisect_left, bisect_right from itertools import izip #for testing all this crap try: import unittest2 as unittest except ImportError: import unittest # Check for things we need in unittest. if not hasattr(unittest.TestCase, 'setUpClass'): print "The unittest2 module or Python 2.7 is required to run this script." sys.exit(1) if not hasattr(json, "dumps"): json.dumps = json.write # New versions of json don't have read anymore. if not hasattr(json, "read"): json.read = json.loads spacing = "\t" #table of pointers to map groups #each map group contains some number of map headers map_group_pointer_table = 0x94000 map_group_count = 26 map_group_offsets = [] map_header_byte_size = 9 second_map_header_byte_size = 12 #event segment sizes warp_byte_size = 5 trigger_byte_size = 8 signpost_byte_size = 5 people_event_byte_size = 13 #a message to show with NotImplementedErrors bryan_message = "bryan hasn't got to this yet" max_texts = 3 text_count = 0 texts = [] #these appear outside of quotes (see pokered/extras/pretty_map_headers.py) #this doesn't do anything but is still used in TextScript constant_abbreviation_bytes = {} # Import the characters from its module. from chars import chars, jap_chars class Size(): """a simple way to track whether or not a size includes the first value or not, like for whether or not the size of a command in a script also includes the command byte or not""" def __init__(self, size, inclusive=False): self.inclusive = inclusive if inclusive: size = size-1 self.size = size def inclusive(self): return self.size + 1 def exclusive(self): return self.size class IntervalMap(object): """ This class maps a set of intervals to a set of values. >>> i = IntervalMap() >>> i[0:5] = "hello world" >>> i[6:10] = "hello cruel world" >>> print i[4] "hello world" """ def __init__(self): """initializes an empty IntervalMap""" self._bounds = [] self._items = [] self._upperitem = None def __setitem__(self, _slice, _value): """sets an interval mapping""" assert isinstance(_slice, slice), 'The key must be a slice object' if _slice.start is None: start_point = -1 else: start_point = bisect_left(self._bounds, _slice.start) if _slice.stop is None: end_point = -1 else: end_point = bisect_left(self._bounds, _slice.stop) if start_point>=0: if start_point < len(self._bounds) and self._bounds[start_point]<_slice.start: start_point += 1 if end_point>=0: self._bounds[start_point:end_point] = [_slice.start, _slice.stop] if start_point < len(self._items): self._items[start_point:end_point] = [self._items[start_point], _value] else: self._items[start_point:end_point] = [self._upperitem, _value] else: self._bounds[start_point:] = [_slice.start] if start_point < len(self._items): self._items[start_point:] = [self._items[start_point], _value] else: self._items[start_point:] = [self._upperitem] self._upperitem = _value else: if end_point>=0: self._bounds[:end_point] = [_slice.stop] self._items[:end_point] = [_value] else: self._bounds[:] = [] self._items[:] = [] self._upperitem = _value def __getitem__(self,_point): """gets a value from the mapping""" assert not isinstance(_point, slice), 'The key cannot be a slice object' index = bisect_right(self._bounds, _point) if index < len(self._bounds): return self._items[index] else: return self._upperitem def items(self): """returns an iterator with each item being ((low_bound, high_bound), value) these items are returned in order""" previous_bound = None for (b, v) in izip(self._bounds, self._items): if v is not None: yield (previous_bound, b), v previous_bound = b if self._upperitem is not None: yield (previous_bound, None), self._upperitem def values(self): """returns an iterator with each item being a stored value the items are returned in order""" for v in self._items: if v is not None: yield v if self._upperitem is not None: yield self._upperitem def __repr__(self): s = [] for b,v in self.items(): if v is not None: s.append('[%r, %r] => %r'%( b[0], b[1], v )) return '{'+', '.join(s)+'}' # ---- script_parse_table explanation ---- # This is an IntervalMap that keeps track of previously parsed scripts, texts # and other objects. Anything that has a location in the ROM should be mapped # to an interval (a range of addresses) in this structure. Each object that is # assigned to an interval should implement attributes or methods like: # ATTRIBUTE/METHOD EXPLANATION # label what the heck to call the object # address where it begins # to_asm() spit out asm (not including label) #keys are intervals "500..555" of byte addresses for each script #last byte is not inclusive(?) really? according to who?? #this is how to make sure scripts are not recalculated script_parse_table = IntervalMap() def is_script_already_parsed_at(address): """looks up whether or not a script is parsed at a certain address""" if script_parse_table[address] == None: return False return True def script_parse_table_pretty_printer(): """helpful debugging output""" for each in script_parse_table.items(): print each def map_name_cleaner(input): """generate a valid asm label for a given map name""" return input.replace(":", "").\ replace("(", "").\ replace(")", "").\ replace("'", "").\ replace("/", "").\ replace(",", "").\ replace(".", "").\ replace("Pokémon Center", "PokeCenter").\ replace(" ", "") class RomStr(str): """simple wrapper to prevent a giant rom from being shown on screen""" def length(self): """len(self)""" return len(self) def __repr__(self): return "RomStr(too long)" def interval(self, offset, length, strings=True, debug=True): """returns hex values for the rom starting at offset until offset+length""" returnable = [] for byte in self[offset:offset+length]: if strings: returnable.append(hex(ord(byte))) else: returnable.append(ord(byte)) return returnable def until(self, offset, byte, strings=True, debug=False): """returns hex values from rom starting at offset until the given byte""" return self.interval(offset, self.find(chr(byte), offset) - offset, strings=strings) rom = RomStr(None) def direct_load_rom(filename="../baserom.gbc"): """loads bytes into memory""" global rom file_handler = open(filename, "rb") rom = RomStr(file_handler.read()) file_handler.close() return rom def load_rom(filename="../baserom.gbc"): """checks that the loaded rom matches the path and then loads the rom if necessary.""" global rom if rom != RomStr(None) and rom != None: return rom if not isinstance(rom, RomStr): return direct_load_rom(filename=filename) elif os.lstat(filename).st_size != len(rom): return direct_load_rom(filename) class AsmList(list): """simple wrapper to prevent all asm lines from being shown on screen""" def length(self): """len(self)""" return len(self) def __repr__(self): return "AsmList(too long)" def load_asm(filename="../main.asm"): """loads the asm source code into memory""" global asm asm = open(filename, "r").read().split("\n") asm = AsmList(asm) return asm def grouper(some_list, count=2): """splits a list into sublists given: [1, 2, 3, 4] returns: [[1, 2], [3, 4]]""" return [some_list[i:i+count] for i in range(0, len(some_list), count)] def is_valid_address(address): """is_valid_rom_address""" if address == None: return False if type(address) == str: address = int(address, 16) if 0 <= address <= 2097152: return True else: return False def rom_interval(offset, length, strings=True, debug=True): """returns hex values for the rom starting at offset until offset+length""" global rom return rom.interval(offset, length, strings=strings, debug=debug) def rom_until(offset, byte, strings=True, debug=True): """returns hex values from rom starting at offset until the given byte""" global rom return rom.until(offset, byte, strings=strings, debug=debug) def how_many_until(byte, starting): index = rom.find(byte, starting) return index - starting def load_map_group_offsets(): """reads the map group table for the list of pointers""" global map_group_pointer_table, map_group_count, map_group_offsets global rom map_group_offsets = [] #otherwise this method can only be used once data = rom_interval(map_group_pointer_table, map_group_count*2, strings=False) data = grouper(data) for pointer_parts in data: pointer = pointer_parts[0] + (pointer_parts[1] << 8) offset = pointer - 0x4000 + map_group_pointer_table map_group_offsets.append(offset) return map_group_offsets def calculate_bank(address): """you are too lazy to divide on your own?""" if type(address) == str: address = int(address, 16) if 0x4000 <= address <= 0x7FFF: raise Exception, "bank 1 does not exist" return int(address) / 0x4000 def calculate_pointer(short_pointer, bank=None): """calculates the full address given a 4-byte pointer and bank byte""" short_pointer = int(short_pointer) if 0x4000 <= short_pointer <= 0x7fff: short_pointer -= 0x4000 bank = int(bank) else: bank = 0 pointer = short_pointer + (bank * 0x4000) return pointer def calculate_pointer_from_bytes_at(address, bank=False): """calculates a pointer from 2 bytes at a location or 3-byte pointer [bank][2-byte pointer] if bank=True""" if bank == True: bank = ord(rom[address]) address += 1 elif bank == False or bank == None: bank = calculate_bank(address) elif bank == "reverse" or bank == "reversed": bank = ord(rom[address+2]) elif type(bank) == int: pass else: raise Exception, "bad bank given to calculate_pointer_from_bytes_at" byte1 = ord(rom[address]) byte2 = ord(rom[address+1]) temp = byte1 + (byte2 << 8) if temp == 0: return None return calculate_pointer(temp, bank) def clean_up_long_info(long_info): """cleans up some data from parse_script_engine_script_at formatting issues""" long_info = str(long_info) #get rid of the first newline if long_info[0] == "\n": long_info = long_info[1:] #get rid of the last newline and any leftover space if long_info.count("\n") > 0: if long_info[long_info.rindex("\n")+1:].isspace(): long_info = long_info[:long_info.rindex("\n")] #remove spaces+hash from the front of each line new_lines = [] for line in long_info.split("\n"): line = line.strip() if line[0] == "#": line = line[1:] new_lines.append(line) long_info = "\n".join(new_lines) return long_info def command_debug_information(command_byte=None, map_group=None, map_id=None, address=0, info=None, long_info=None, pksv_name=None): "used to help debug in parse_script_engine_script_at" info1 = "parsing command byte " + hex(command_byte) + " for map " + \ str(map_group) + "." + str(map_id) + " at " + hex(address) info1 += " pksv: " + str(pksv_name) #info1 += " info: " + str(info) #info1 += " long_info: " + long_info return info1 class NewTextScript: """ A text is a sequence of bytes (and sometimes commands). It's not the same thing as a Script. The bytes are translated into characters based on the lookup table (see chars.py). The in-text commands are for including values from RAM, playing sound, etc. see: http://hax.iimarck.us/files/scriptingcodes_eng.htm#InText """ base_label = "UnknownText_" def __init__(self, address, map_group=None, map_id=None, debug=True, label=None): self.address = address self.map_group, self.map_id, self.debug = map_group, map_id, debug self.dependencies = [] self.commands = [] if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.parse() def get_dependencies(self, recompute=False, global_dependencies=set()): global_dependencies.update(self.dependencies) return self.dependencies def parse(self): global text_command_classes, script_parse_table raise NotImplementedError, bryan_message def to_asm(self): pass all_texts = [] class TextScript: "a text is a sequence of commands different from a script-engine script" base_label = "UnknownText_" def __init__(self, address, map_group=None, map_id=None, debug=True, show=True, force=False, label=None): self.address = address self.map_group, self.map_id, self.debug, self.show, self.force = map_group, map_id, debug, show, force if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.dependencies = [] self.parse_text_at(address) @staticmethod def find_addresses(): """returns a list of text pointers useful for testing parse_text_engine_script_at Note that this list is not exhaustive. There are some texts that are only pointed to from some script that a current script just points to. So find_all_text_pointers_in_script_engine_script will have to recursively follow through each script to find those. .. it does this now :) """ addresses = set() #for each map group for map_group in map_names: #for each map id for map_id in map_names[map_group]: #skip the offset key if map_id == "offset": continue #dump this into smap smap = map_names[map_group][map_id] #signposts signposts = smap["signposts"] #for each signpost for signpost in signposts: if signpost["func"] in [0, 1, 2, 3, 4]: #dump this into script script = signpost["script"] elif signpost["func"] in [05, 06]: script = signpost["script"] else: continue #skip signposts with no bytes if len(script) == 0: continue #find all text pointers in script texts = find_all_text_pointers_in_script_engine_script(script, smap["event_bank"]) #dump these addresses in addresses.update(texts) #xy triggers xy_triggers = smap["xy_triggers"] #for each xy trigger for xy_trigger in xy_triggers: #dump this into script script = xy_trigger["script"] #find all text pointers in script texts = find_all_text_pointers_in_script_engine_script(script, smap["event_bank"]) #dump these addresses in addresses.update(texts) #trigger scripts triggers = smap["trigger_scripts"] #for each trigger for (i, trigger) in triggers.items(): #dump this into script script = trigger["script"] #find all text pointers in script texts = find_all_text_pointers_in_script_engine_script(script, calculate_bank(trigger["address"])) #dump these addresses in addresses.update(texts) #callback scripts callbacks = smap["callback_scripts"] #for each callback for (k, callback) in callbacks.items(): #dump this into script script = callback["script"] #find all text pointers in script texts = find_all_text_pointers_in_script_engine_script(script, calculate_bank(callback["address"])) #dump these addresses in addresses.update(texts) #people-events events = smap["people_events"] #for each event for event in events: if event["event_type"] == "script": #dump this into script script = event["script"] #find all text pointers in script texts = find_all_text_pointers_in_script_engine_script(script, smap["event_bank"]) #dump these addresses in addresses.update(texts) if event["event_type"] == "trainer": trainer_data = event["trainer_data"] addresses.update([trainer_data["text_when_seen_ptr"]]) addresses.update([trainer_data["text_when_trainer_beaten_ptr"]]) trainer_bank = calculate_bank(event["trainer_data_address"]) script1 = trainer_data["script_talk_again"] texts1 = find_all_text_pointers_in_script_engine_script(script1, trainer_bank) addresses.update(texts1) script2 = trainer_data["script_when_lost"] texts2 = find_all_text_pointers_in_script_engine_script(script2, trainer_bank) addresses.update(texts2) return addresses def parse_text_at(self, address): """parses a text-engine script ("in-text scripts") http://hax.iimarck.us/files/scriptingcodes_eng.htm#InText This is presently very broken. see parse_text_at2, parse_text_at, and process_00_subcommands """ global rom, text_count, max_texts, texts, script_parse_table if rom == None: direct_load_rom() if address == None: return "not a script" map_group, map_id, debug, show, force = self.map_group, self.map_id, self.debug, self.show, self.force commands = {} if is_script_already_parsed_at(address) and not force: print "text is already parsed at this location: " + hex(address) raise Exception, "text is already parsed, what's going on ?" return script_parse_table[address] total_text_commands = 0 command_counter = 0 original_address = address offset = address end = False script_parse_table[original_address:original_address+1] = "incomplete text" while not end: address = offset command = {} command_byte = ord(rom[address]) if debug: print "TextScript.parse_script_at has encountered a command byte " + hex(command_byte) + " at " + hex(address) end_address = address + 1 if command_byte == 0: #read until $57, $50 or $58 jump57 = how_many_until(chr(0x57), offset) jump50 = how_many_until(chr(0x50), offset) jump58 = how_many_until(chr(0x58), offset) #whichever command comes first jump = min([jump57, jump50, jump58]) end_address = offset + jump #we want the address before $57 lines = process_00_subcommands(offset+1, end_address, debug=debug) if show and debug: text = parse_text_at2(offset+1, end_address-offset+1, debug=debug) print text command = {"type": command_byte, "start_address": offset, "end_address": end_address, "size": jump, "lines": lines, } offset += jump elif command_byte == 0x17: #TX_FAR [pointer][bank] pointer_byte1 = ord(rom[offset+1]) pointer_byte2 = ord(rom[offset+2]) pointer_bank = ord(rom[offset+3]) pointer = (pointer_byte1 + (pointer_byte2 << 8)) pointer = extract_maps.calculate_pointer(pointer, pointer_bank) text = TextScript(pointer, map_group=self.map_group, map_id=self.amp_id, debug=self.debug, \ show=self.debug, force=self.debug, label="Target"+self.label.name) self.dependencies.append(text) command = {"type": command_byte, "start_address": offset, "end_address": offset + 3, #last byte belonging to this command "pointer": pointer, #parameter "text": text, } offset += 3 + 1 elif command_byte == 0x50 or command_byte == 0x57 or command_byte == 0x58: #end text command = {"type": command_byte, "start_address": offset, "end_address": offset, } #this byte simply indicates to end the script end = True #this byte simply indicates to end the script if command_byte == 0x50 and ord(rom[offset+1]) == 0x50: #$50$50 means end completely end = True commands[command_counter+1] = command #also save the next byte, before we quit commands[command_counter+1]["start_address"] += 1 commands[command_counter+1]["end_address"] += 1 add_command_byte_to_totals(command_byte) elif command_byte == 0x50: #only end if we started with $0 if len(commands.keys()) > 0: if commands[0]["type"] == 0x0: end = True elif command_byte == 0x57 or command_byte == 0x58: #end completely end = True offset += 1 #go past this 0x50 elif command_byte == 0x1: #01 = text from RAM. [01][2-byte pointer] size = 3 #total size, including the command byte pointer_byte1 = ord(rom[offset+1]) pointer_byte2 = ord(rom[offset+2]) command = {"type": command_byte, "start_address": offset+1, "end_address": offset+2, #last byte belonging to this command "pointer": [pointer_byte1, pointer_byte2], #RAM pointer } #view near these bytes #subsection = rom[offset:offset+size+1] #peak ahead #for x in subsection: # print hex(ord(x)) #print "--" offset += 2 + 1 #go to the next byte #use this to look at the surrounding bytes if debug: print "next command is: " + hex(ord(rom[offset])) + " ... we are at command number: " + str(command_counter) + " near " + hex(offset) + " on map_id=" + str(map_id) elif command_byte == 0x7: #07 = shift texts 1 row above (2nd line becomes 1st line); address for next text = 2nd line. [07] size = 1 command = {"type": command_byte, "start_address": offset, "end_address": offset, } offset += 1 elif command_byte == 0x3: #03 = set new address in RAM for text. [03][2-byte RAM address] size = 3 command = {"type": command_byte, "start_address": offset, "end_address": offset+2} offset += size elif command_byte == 0x4: #draw box #04 = draw box. [04][2-Byte pointer][height Y][width X] size = 5 #including the command command = { "type": command_byte, "start_address": offset, "end_address": offset + size, "pointer_bytes": [ord(rom[offset+1]), ord(rom[offset+2])], "y": ord(rom[offset+3]), "x": ord(rom[offset+4]), } offset += size + 1 elif command_byte == 0x5: #05 = write text starting at 2nd line of text-box. [05][text][ending command] #read until $57, $50 or $58 jump57 = how_many_until(chr(0x57), offset) jump50 = how_many_until(chr(0x50), offset) jump58 = how_many_until(chr(0x58), offset) #whichever command comes first jump = min([jump57, jump50, jump58]) end_address = offset + jump #we want the address before $57 lines = process_00_subcommands(offset+1, end_address, debug=debug) if show and debug: text = parse_text_at2(offset+1, end_address-offset+1, debug=debug) print text command = {"type": command_byte, "start_address": offset, "end_address": end_address, "size": jump, "lines": lines, } offset = end_address + 1 elif command_byte == 0x6: #06 = wait for keypress A or B (put blinking arrow in textbox). [06] command = {"type": command_byte, "start_address": offset, "end_address": offset} offset += 1 elif command_byte == 0x7: #07 = shift texts 1 row above (2nd line becomes 1st line); address for next text = 2nd line. [07] command = {"type": command_byte, "start_address": offset, "end_address": offset} offset += 1 elif command_byte == 0x8: #08 = asm until whenever command = {"type": command_byte, "start_address": offset, "end_address": offset} offset += 1 end = True elif command_byte == 0x9: #09 = write hex-to-dec number from RAM to textbox [09][2-byte RAM address][byte bbbbcccc] # bbbb = how many bytes to read (read number is big-endian) # cccc = how many digits display (decimal) #(note: max of decimal digits is 7,i.e. max number correctly displayable is 9999999) ram_address_byte1 = ord(rom[offset+1]) ram_address_byte2 = ord(rom[offset+2]) read_byte = ord(rom[offset+3]) command = { "type": command_byte, "address": [ram_address_byte1, ram_address_byte2], "read_byte": read_byte, #split this up when we make a macro for this } offset += 4 else: #if len(commands) > 0: # print "Unknown text command " + hex(command_byte) + " at " + hex(offset) + ", script began with " + hex(commands[0]["type"]) if debug: print "Unknown text command at " + hex(offset) + " - command: " + hex(ord(rom[offset])) + " on map_id=" + str(map_id) #end at the first unknown command end = True commands[command_counter] = command command_counter += 1 total_text_commands += len(commands) text_count += 1 #if text_count >= max_texts: # sys.exit() self.commands = commands self.last_address = offset script_parse_table[original_address:offset] = self all_texts.append(self) self.size = self.byte_count = self.last_address - original_address return commands def get_dependencies(self, recompute=False, global_dependencies=set()): #if recompute: # raise NotImplementedError, bryan_message global_dependencies.update(self.dependencies) return self.dependencies def to_asm(self, label=None): address = self.address start_address = address if label == None: label = self.label.name #using deepcopy because otherwise additional @s get appended each time #like to the end of the text for TextScript(0x5cf3a) commands = deepcopy(self.commands) #apparently this isn't important anymore? needs_to_begin_with_0 = True #start with zero please byte_count = 0 #where we store all output output = "" had_text_end_byte = False had_text_end_byte_57_58 = False had_db_last = False xspacing = "" #reset this pretty fast.. first_line = True #for each command.. for this_command in commands.keys(): if not "lines" in commands[this_command].keys(): command = commands[this_command] if not "type" in command.keys(): print "ERROR in command: " + str(command) continue #dunno what to do here? if command["type"] == 0x1: #TX_RAM p1 = command["pointer"][0] p2 = command["pointer"][1] #remember to account for big endian -> little endian output += "\n" + xspacing + "TX_RAM $%.2x%.2x" %(p2, p1) byte_count += 3 had_db_last = False elif command["type"] == 0x17: #TX_FAR #p1 = command["pointer"][0] #p2 = command["pointer"][1] output += "\n" + xspacing + "TX_FAR _" + label + " ; " + hex(command["pointer"]) byte_count += 4 #$17, bank, address word had_db_last = False elif command["type"] == 0x9: #TX_RAM_HEX2DEC #address, read_byte output += "\n" + xspacing + "TX_NUM $%.2x%.2x, $%.2x" % (command["address"][1], command["address"][0], command["read_byte"]) had_db_last = False byte_count += 4 elif command["type"] == 0x50 and not had_text_end_byte: #had_text_end_byte helps us avoid repeating $50s if had_db_last: output += ", $50" else: output += "\n" + xspacing + "db $50" byte_count += 1 had_db_last = True elif command["type"] in [0x57, 0x58] and not had_text_end_byte_57_58: if had_db_last: output += ", $%.2x" % (command["type"]) else: output += "\n" + xspacing + "db $%.2x" % (command["type"]) byte_count += 1 had_db_last = True elif command["type"] in [0x57, 0x58] and had_text_end_byte_57_58: pass #this is ok elif command["type"] == 0x50 and had_text_end_byte: pass #this is also ok elif command["type"] == 0x0b: if had_db_last: output += ", $0b" else: output += "\n" + xspacing + "db $0B" byte_count += 1 had_db_last = True elif command["type"] == 0x11: if had_db_last: output += ", $11" else: output += "\n" + xspacing + "db $11" byte_count += 1 had_db_last = True elif command["type"] == 0x6: #wait for keypress if had_db_last: output += ", $6" else: output += "\n" + xspacing + "db $6" byte_count += 1 had_db_last = True else: print "ERROR in command: " + hex(command["type"]) had_db_last = False #everything else is for $0s, really continue lines = commands[this_command]["lines"] #reset this in case we have non-$0s later had_db_last = False #add the ending byte to the last line- always seems $57 #this should already be in there, but it's not because of a bug in the text parser lines[len(lines.keys())-1].append(commands[len(commands.keys())-1]["type"]) first = True #first byte for line_id in lines: line = lines[line_id] output += xspacing + "db " if first and needs_to_begin_with_0: output += "$0, " first = False byte_count += 1 quotes_open = False first_byte = True was_byte = False for byte in line: if byte == 0x50: had_text_end_byte = True #don't repeat it if byte in [0x58, 0x57]: had_text_end_byte_57_58 = True if byte in chars: if not quotes_open and not first_byte: #start text output += ", \"" quotes_open = True first_byte = False if not quotes_open and first_byte: #start text output += "\"" quotes_open = True output += chars[byte] elif byte in constant_abbreviation_bytes: if quotes_open: output += "\"" quotes_open = False if not first_byte: output += ", " output += constant_abbreviation_bytes[byte] else: if quotes_open: output += "\"" quotes_open = False #if you want the ending byte on the last line #if not (byte == 0x57 or byte == 0x50 or byte == 0x58): if not first_byte: output += ", " output += "$" + hex(byte)[2:] was_byte = True #add a comma unless it's the end of the line #if byte_count+1 != len(line): # output += ", " first_byte = False byte_count += 1 #close final quotes if quotes_open: output += "\"" quotes_open = False output += "\n" #include_newline = "\n" #if len(output)!=0 and output[-1] == "\n": # include_newline = "" #output += include_newline + "; " + hex(start_address) + " + " + str(byte_count) + " bytes = " + hex(start_address + byte_count) if len(output) > 0 and output[-1] == "\n": output = output[:-1] self.size = self.byte_count = byte_count return output def parse_text_engine_script_at(address, map_group=None, map_id=None, debug=True, show=True, force=False): """parses a text-engine script ("in-text scripts") http://hax.iimarck.us/files/scriptingcodes_eng.htm#InText see parse_text_at2, parse_text_at, and process_00_subcommands """ if is_script_already_parsed_at(address) and not force: return script_parse_table[address] return TextScript(address, map_group=map_group, map_id=map_id, debug=debug, show=show, force=force) def find_text_addresses(): """returns a list of text pointers useful for testing parse_text_engine_script_at""" return TextScript.find_addresses() class EncodedText: """a sequence of bytes that, when decoded, represent readable text based on the chars table from preprocessor.py and other places""" base_label = "UnknownRawText_" def __init__(self, address, bank=None, map_group=None, map_id=None, debug=True, label=None): self.address = address if bank: self.bank = bank else: self.bank = calculate_bank(address) self.map_group, self.map_id, self.debug = map_group, map_id, debug if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.parse() script_parse_table[self.address : self.last_address] = self def get_dependencies(self, recompute=False, global_dependencies=set()): return [] def parse(self): offset = self.address #read until $57, $50 or $58 jump57 = how_many_until(chr(0x57), offset) jump50 = how_many_until(chr(0x50), offset) jump58 = how_many_until(chr(0x58), offset) #whichever command comes first jump = min([jump57, jump50, jump58]) end_address = offset + jump #we want the address before $57 text = parse_text_at2(offset, end_address-offset, debug=self.debug) self.text = text self.last_address = self.end_address = end_address def to_asm(self): return "\""+self.text+"\"" @staticmethod def process_00_subcommands(start_address, end_address, debug=True): """split this text up into multiple lines based on subcommands ending each line""" if debug: print "process_00_subcommands(" + hex(start_address) + ", " + hex(end_address) + ")" lines = {} subsection = rom[start_address:end_address] line_count = 0 current_line = [] for pbyte in subsection: byte = ord(pbyte) current_line.append(byte) if byte == 0x4f or byte == 0x51 or byte == 0x55: lines[line_count] = current_line current_line = [] line_count += 1 #don't forget the last line lines[line_count] = current_line line_count += 1 return lines @staticmethod def from_bytes(bytes, debug=True, japanese=False): """assembles a string based on bytes looked up in the chars table""" line = "" if japanese: charset = jap_chars else: charset = chars for byte in bytes: if type(byte) != int: byte = ord(byte) if byte in charset.keys(): line += charset[byte] elif debug: print "byte not known: " + hex(byte) return line @staticmethod def parse_text_at(address, count=10, debug=True, japanese=False): """returns a string of text from an address this does not handle text commands""" output = "" commands = process_00_subcommands(address, address+count, debug=debug) for (line_id, line) in commands.items(): output += parse_text_from_bytes(line, debug=debug, japanese=japanese) output += "\n" texts.append([address, output]) return output def process_00_subcommands(start_address, end_address, debug=True): """split this text up into multiple lines based on subcommands ending each line""" return EncodedText.process_00_subcommands(start_address, end_address, debug=debug) def parse_text_from_bytes(bytes, debug=True, japanese=False): """assembles a string based on bytes looked up in the chars table""" return EncodedText.from_bytes(bytes, debug=debug, japanese=japanese) def parse_text_at(address, count=10, debug=True): """returns a list of bytes from an address see parse_text_at2 for pretty printing""" return parse_text_from_bytes(rom_interval(address, count, strings=False), debug=debug) def parse_text_at2(address, count=10, debug=True, japanese=False): """returns a string of text from an address this does not handle text commands""" return EncodedText.parse_text_at(address, count, debug=debug, japanese=japanese) def parse_text_at3(address, map_group=None, map_id=None, debug=False): deh = script_parse_table[address] if deh: return deh else: return TextScript(address, map_group=map_group, map_id=map_id, debug=debug) def rom_text_at(address, count=10): """prints out raw text from the ROM like for 0x112110""" return "".join([chr(x) for x in rom_interval(address, count, strings=False)]) def get_map_constant_label(map_group=None, map_id=None): """returns PALLET_TOWN for some map group/id pair""" if map_group == None: raise Exception, "need map_group" if map_id == None: raise Exception, "need map_id" global map_internal_ids for (id, each) in map_internal_ids.items(): if each["map_group"] == map_group and each["map_id"] == map_id: return each["label"] return None def get_map_constant_label_by_id(global_id): """returns a map constant label for a particular map id""" global map_internal_ids return map_internal_ids[global_id]["label"] def get_id_for_map_constant_label(label): """returns some global id for a given map constant label PALLET_TOWN = 1, for instance.""" global map_internal_ids for (id, each) in map_internal_ids.items(): if each["label"] == label: return id return None def generate_map_constant_labels(): """generates the global for this script mapping ids to map groups/ids/labels""" global map_internal_ids map_internal_ids = {} i = 0 for map_group in map_names.keys(): for map_id in map_names[map_group].keys(): if map_id == "offset": continue cmap = map_names[map_group][map_id] name = cmap["name"] name = name.replace("Pokémon Center", "PokeCenter").\ replace(" ", "_").\ replace("-", "_").\ replace("é", "e") constant_label = map_name_cleaner(name).upper() map_internal_ids[i] = {"label": constant_label, "map_id": map_id, "map_group": map_group} i += 1 return map_internal_ids #see generate_map_constant_labels() later def generate_map_constants(): """generates content for constants.asm this will generate two macros: GROUP and MAP""" global map_internal_ids if map_internal_ids == None or map_internal_ids == {}: generate_map_constant_labels() globals, groups, maps = "", "", "" for (id, each) in map_internal_ids.items(): label = each["label"].replace("-", "_").replace("é", "e").upper() groups += "GROUP_"+ label + " EQU $%.2x" % (each["map_group"]) groups += "\n" maps += "MAP_"+ label + " EQU $%.2x" % (each["map_id"]) maps += "\n" globals += label + " EQU $%.2x" % (id) globals += "\n" #for multi-byte constants: #print each["label"] + " EQUS \"$%.2x,$%.2x\"" % (each["map_group"], each["map_id"]) print globals print groups print maps from pokemon_constants import pokemon_constants def get_pokemon_constant_by_id(id): if id == 0: return None return pokemon_constants[id] def parse_script_asm_at(*args, **kwargs): #XXX TODO return None from item_constants import item_constants def find_item_label_by_id(id): if id in item_constants.keys(): return item_constants[id] else: return None def generate_item_constants(): """make a list of items to put in constants.asm""" output = "" for (id, item) in item_constants.items(): val = ("$%.2x"%id).upper() while len(item)<13: item+= " " output += item + " EQU " + val + "\n" return output def find_all_text_pointers_in_script_engine_script(script, bank=None, debug=False): """returns a list of text pointers based on each script-engine script command""" #TODO: recursively follow any jumps in the script if script == None: return [] addresses = set() for (k, command) in enumerate(script.commands): if debug: print "command is: " + str(command) if command.id == 0x4B: addresses.add(command.params[0].parsed_address) elif command.id == 0x4C: addresses.add(command.params[0].parsed_address) elif command.id == 0x51: addresses.add(command.params[0].parsed_address) elif command.id == 0x53: addresses.add(command.params[0].parsed_address) elif command.id == 0x64: addresses.add(command.params[0].parsed_address) addresses.add(command.params[1].parsed_address) return addresses def translate_command_byte(crystal=None, gold=None): """takes a command byte from either crystal or gold returns the command byte in the other (non-given) game The new commands are values 0x52 and 0x9F. This means: Crystal's 0x00–0x51 correspond to Gold's 0x00–0x51 Crystal's 0x53–0x9E correspond to Gold's 0x52–0x9D Crystal's 0xA0–0xA5 correspond to Gold's 0x9E–0xA3 see: http://www.pokecommunity.com/showpost.php?p=4347261 """ if crystal != None: #convert to gold if crystal <= 0x51: return crystal if crystal == 0x52: return None if 0x53 <= crystal <= 0x9E: return crystal-1 if crystal == 0x9F: return None if 0xA0 <= crystal <= 0xA5: return crystal-2 if crystal > 0xA5: raise Exception, "dunno yet if crystal has new insertions after crystal:0xA5 (gold:0xA3)" elif gold != None: #convert to crystal if gold <= 0x51: return gold if 0x52 <= gold <= 0x9D: return gold+1 if 0x9E <= gold <= 0xA3: return gold+2 if gold > 0xA3: raise Exception, "dunno yet if crystal has new insertions after gold:0xA3 (crystal:0xA5)" else: raise Exception, "translate_command_byte needs either a crystal or gold command" from pksv import pksv_gs, pksv_crystal, pksv_crystal_unknowns,\ pksv_crystal_more_enders class SingleByteParam(): """or SingleByte(CommandParam)""" size = 1 should_be_decimal = False byte_type = "db" def __init__(self, *args, **kwargs): for (key, value) in kwargs.items(): setattr(self, key, value) #check address if not hasattr(self, "address"): raise Exception, "an address is a requirement" elif self.address == None: raise Exception, "address must not be None" elif not is_valid_address(self.address): raise Exception, "address must be valid" #check size if not hasattr(self, "size") or self.size == None: raise Exception, "size is probably 1?" #parse bytes from ROM self.parse() def parse(self): self.byte = ord(rom[self.address]) def get_dependencies(self, recompute=False, global_dependencies=set()): return [] def to_asm(self): if not self.should_be_decimal: return hex(self.byte).replace("0x", "$") else: return str(self.byte) class DollarSignByte(SingleByteParam): def to_asm(self): return hex(self.byte).replace("0x", "$") HexByte=DollarSignByte class ItemLabelByte(DollarSignByte): def to_asm(self): label = find_item_label_by_id(self.byte) if label: return label elif not label: return DollarSignByte.to_asm(self) class DecimalParam(SingleByteParam): should_be_decimal = True class MultiByteParam(): """or MultiByte(CommandParam)""" size = 2 should_be_decimal = False byte_type = "dw" def __init__(self, *args, **kwargs): self.prefix = "$" #default.. feel free to set 0x in kwargs for (key, value) in kwargs.items(): setattr(self, key, value) #check address if not hasattr(self, "address") or self.address == None: raise Exception, "an address is a requirement" elif not is_valid_address(self.address): raise Exception, "address must be valid" #check size if not hasattr(self, "size") or self.size == None: raise Exception, "don't know how many bytes to read (size)" self.parse() def parse(self): self.bytes = rom_interval(self.address, self.size, strings=False) self.parsed_number = self.bytes[0] + (self.bytes[1] << 8) if hasattr(self, "bank"): self.parsed_address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) else: self.parsed_address = calculate_pointer_from_bytes_at(self.address, bank=None) def get_dependencies(self, recompute=False, global_dependencies=set()): return [] #you won't actually use this to_asm because it's too generic #def to_asm(self): return ", ".join([(self.prefix+"%.2x")%x for x in self.bytes]) def to_asm(self): if not self.should_be_decimal: return self.prefix+"".join([("%.2x")%x for x in reversed(self.bytes)]) elif self.should_be_decimal: decimal = int("0x"+"".join([("%.2x")%x for x in reversed(self.bytes)]), 16) return str(decimal) class PointerLabelParam(MultiByteParam): #default size is 2 bytes default_size = 2 size = 2 #default is to not parse out a bank bank = False force = False debug = False def __init__(self, *args, **kwargs): self.dependencies = None #bank can be overriden if "bank" in kwargs.keys(): if kwargs["bank"] != False and kwargs["bank"] != None and kwargs["bank"] in [True, "reverse"]: #not +=1 because child classes set size=3 already self.size = self.default_size + 1 self.given_bank = kwargs["bank"] #if kwargs["bank"] not in [None, False, True, "reverse"]: # raise Exception, "bank cannot be: " + str(kwargs["bank"]) if self.size > 3: raise Exception, "param size is too large" #continue instantiation.. self.bank will be set down the road MultiByteParam.__init__(self, *args, **kwargs) def parse(self): self.parsed_address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) MultiByteParam.parse(self) def get_dependencies(self, recompute=False, global_dependencies=set()): dependencies = [] if self.parsed_address == self.address: return dependencies if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies thing = script_parse_table[self.parsed_address] if thing and thing.address == self.parsed_address and not (thing is self): #if self.debug: # print "parsed address is: " + hex(self.parsed_address) + " with label: " + thing.label.name + " of type: " + str(thing.__class__) dependencies.append(thing) if not thing in global_dependencies: global_dependencies.add(thing) more = thing.get_dependencies(recompute=recompute, global_dependencies=global_dependencies) dependencies.extend(more) self.dependencies = dependencies return dependencies def to_asm(self): bank = self.bank #we pass bank= for whether or not to include a bank byte when reading #.. it's not related to caddress caddress = calculate_pointer_from_bytes_at(self.address, bank=self.bank) label = get_label_for(caddress) pointer_part = label #use the label, if it is found #check that the label actually points to the right place result = script_parse_table[caddress] if result != None and hasattr(result, "label"): if result.label.name != label: label = None elif result.address != caddress: label = None elif result != None: label = None #setup output bytes if the label was not found if not label: #pointer_part = (", ".join([(self.prefix+"%.2x")%x for x in reversed(self.bytes[1:])])) pointer_part = self.prefix+("%.2x"%self.bytes[1])+("%.2x"%self.bytes[0]) #bank positioning matters! if bank == True or bank == "reverse": #bank, pointer #possibly use BANK(LABEL) if we know the bank if not label: bank_part = ((self.prefix+"%.2x")%bank) else: bank_part = "BANK("+label+")" #return the asm based on the order the bytes were specified to be in if bank == "reverse": #pointer, bank return pointer_part+", "+bank_part elif bank == True: #bank, pointer return bank_part+", "+pointer_part else: raise Exception, "this should never happen" raise Exception, "this should never happen" #this next one will either return the label or the raw bytes elif bank == False or bank == None: #pointer return pointer_part #this could be the same as label else: #raise Exception, "this should never happen" return pointer_part #probably in the same bank ? raise Exception, "this should never happen" class PointerLabelBeforeBank(PointerLabelParam): bank = True #bank appears first, see calculate_pointer_from_bytes_at size = 3 class PointerLabelAfterBank(PointerLabelParam): bank = "reverse" #bank appears last, see calculate_pointer_from_bytes_at size = 3 class ScriptPointerLabelParam(PointerLabelParam): pass class ScriptPointerLabelBeforeBank(PointerLabelBeforeBank): pass class ScriptPointerLabelAfterBank(PointerLabelAfterBank): pass def _parse_script_pointer_bytes(self): PointerLabelParam.parse(self) print "_parse_script_pointer_bytes - calculating the pointer located at " + hex(self.address) address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) if address != None and address > 0x4000: print "_parse_script_pointer_bytes - the pointer is: " + hex(address) self.script = parse_script_engine_script_at(address, debug=self.debug, force=self.force, map_group=self.map_group, map_id=self.map_id) ScriptPointerLabelParam.parse = _parse_script_pointer_bytes ScriptPointerLabelBeforeBank.parse = _parse_script_pointer_bytes ScriptPointerLabelAfterBank.parse = _parse_script_pointer_bytes class PointerLabelToScriptPointer(PointerLabelParam): def parse(self): PointerLabelParam.parse(self) address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) address2 = calculate_pointer_from_bytes_at(address, bank="reverse") #maybe not "reverse"? self.script = parse_script_engine_script_at(address2, origin=False, map_group=self.map_group, map_id=self.map_id, force=self.force, debug=self.debug) class AsmPointerParam(PointerLabelBeforeBank): def parse(self): PointerLabelBeforeBank.parse(self) address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) #3-byte pointer self.asm = parse_script_asm_at(address, map_group=self.map_group, map_id=self.map_id, force=self.force, debug=self.debug) #might end in some specific way? class PointerToAsmPointerParam(PointerLabelParam): def parse(self): PointerLabelParam.parse(self) address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) #2-byte pointer address2 = calculate_pointer_from_bytes_at(address, bank="reverse") #maybe not "reverse"? self.asm = parse_script_asm_at(address, map_group=self.map_group, map_id=self.map_id, force=self.force, debug=self.debug) #might end in some specific way? class RAMAddressParam(MultiByteParam): def to_asm(self): address = calculate_pointer_from_bytes_at(self.address, bank=False) label = get_ram_label(address) if label: return label else: return "$"+"".join(["%.2x"%x for x in reversed(self.bytes)])+"" class MoneyByteParam(MultiByteParam): size = 3 max_value = 0x0F423F should_be_decimal = True def parse(self): MultiByteParam.parse(self) # in the rom as xxyyzz self.x = self.bytes[2] self.y = self.bytes[1] self.z = self.bytes[0] def to_asm(self): return str(self.x + (self.y << 8) + (self.z << 16)) #this is used by the preprocessor @staticmethod def from_asm(value): #max is 0F423F #z = 0x0F ; y = 0x42 ; x = 0x3F #999999 = x + (y << 8) + (z << 16) value = int(value) x = (value & 0x0000FF) y = (value & 0x00FF00) >> 8 z = (value & 0xFF0000) >> 16 return str(x) + "\ndb "+str(y)+"\ndb "+str(z) class CoinByteParam(MultiByteParam): size = 2 max_value = 0x270F should_be_decimal = True class MapGroupParam(SingleByteParam): def to_asm(self): map_id = ord(rom[self.address+1]) map_constant_label = get_map_constant_label(map_id=map_id, map_group=self.byte) #like PALLET_TOWN if map_constant_label == None: return str(self.byte) #else: return "GROUP("+map_constant_label+")" else: return "GROUP_"+map_constant_label class MapIdParam(SingleByteParam): def parse(self): SingleByteParam.parse(self) self.map_group = ord(rom[self.address-1]) def to_asm(self): map_group = ord(rom[self.address-1]) map_constant_label = get_map_constant_label(map_id=self.byte, map_group=map_group) if map_constant_label == None: return str(self.byte) #else: return "MAP("+map_constant_label+")" else: return "MAP_"+map_constant_label class MapGroupIdParam(MultiByteParam): def parse(self): MultiByteParam.parse(self) self.map_group = self.bytes[0] self.map_id = self.bytes[1] def to_asm(self): map_group = self.map_group map_id = self.map_id label = get_map_constant_label(map_group=map_group, map_id=map_id) return label class PokemonParam(SingleByteParam): def to_asm(self): pokemon_constant = get_pokemon_constant_by_id(self.byte) if pokemon_constant: return pokemon_constant else: return str(self.byte) class PointerParamToItemAndLetter(MultiByteParam): #[2F][2byte pointer to item no + 0x20 bytes letter text] #raise NotImplementedError, bryan_message pass class TrainerIdParam(SingleByteParam): #raise NotImplementedError, bryan_message pass class TrainerGroupParam(SingleByteParam): #raise NotImplementedError, bryan_message pass class MenuDataPointerParam(PointerLabelParam): #read menu data at the target site #raise NotImplementedError, bryan_message pass class RawTextPointerLabelParam(PointerLabelParam): #not sure if these are always to a text script or raw text? def parse(self): PointerLabelParam.parse(self) #bank = calculate_bank(self.address) address = calculate_pointer_from_bytes_at(self.address, bank=False) self.calculated_address = address #self.text = parse_text_at3(address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) #self.text = TextScript(address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.text = parse_text_engine_script_at(address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) def get_dependencies(self, recompute=False, global_dependencies=set()): global_dependencies.add(self.text) return [self.text] class TextPointerLabelParam(PointerLabelParam): """this is a pointer to a text script""" bank = False text = None def parse(self): PointerLabelParam.parse(self) address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) if address != None and address != 0: self.text = parse_text_engine_script_at(address, map_group=self.map_group, map_id=self.map_id, force=self.force, debug=self.debug) if not self.text: self.text = script_parse_table[address] def get_dependencies(self, recompute=False, global_dependencies=set()): if self.text: global_dependencies.add(self.text) return [self.text] else: return [] class MovementPointerLabelParam(PointerLabelParam): pass class MapDataPointerParam(PointerLabelParam): pass class Command: """ Note: when dumping to asm, anything in script_parse_table that directly inherits Command should not be .to_asm()'d. """ #use this when the "byte id" doesn't matter #.. for example, a non-script command doesn't use the "byte id" override_byte_check = False base_label = "UnseenLabel_" def __init__(self, address=None, *pargs, **kwargs): """params: address - where the command starts force - whether or not to force the script to be parsed (default False) debug - are we in debug mode? default False map_group map_id """ defaults = {"force": False, "debug": False, "map_group": None, "map_id": None} if not is_valid_address(address): raise Exception, "address is invalid" #set up some variables self.address = address self.last_address = None #setup the label based on base_label if available label = self.base_label + hex(self.address) self.label = Label(name=label, address=address, object=self) #params are where this command's byte parameters are stored self.params = {} self.dependencies = None #override default settings defaults.update(kwargs) #set everything for (key, value) in defaults.items(): setattr(self, key, value) #but also store these kwargs self.args = defaults #start parsing this command's parameter bytes self.parse() def get_dependencies(self, recompute=False, global_dependencies=set()): dependencies = [] if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies for (key, param) in self.params.items(): if hasattr(param, "get_dependencies") and param != self: deps = param.get_dependencies(recompute=recompute, global_dependencies=global_dependencies) if deps != None and not self in deps: dependencies.extend(deps) self.dependencies = dependencies return dependencies def to_asm(self): #start with the rgbasm macro name for this command output = "" #if len(self.macro_name) > 0 and self.macro_name[0].isdigit(): # output += "_" output += self.macro_name #return if there are no params if len(self.param_types.keys()) == 0: return output #first one will have no prefixing comma first = True #start reading the bytes after the command byte if not self.override_byte_check: current_address = self.address+1 else: current_address = self.address #output = self.macro_name + ", ".join([param.to_asm() for (key, param) in self.params.items()]) #add each param for (key, param) in self.params.items(): name = param.name #the first param shouldn't have ", " prefixed if first: output += " " first = False #but all other params should else: output += ", " #now add the asm-compatible param string output += param.to_asm() current_address += param.size #for param_type in self.param_types: # name = param_type["name"] # klass = param_type["klass"] # #create an instance of this type # #tell it to begin parsing at this latest byte # obj = klass(address=current_address) # #the first param shouldn't have ", " prefixed # if first: first = False # #but all other params should # else: output += ", " # #now add the asm-compatible param string # output += obj.to_asm() # current_address += obj.size return output def parse(self): #id, size (inclusive), param_types #param_type = {"name": each[1], "class": each[0]} if not self.override_byte_check: current_address = self.address+1 else: current_address = self.address byte = ord(rom[self.address]) if not self.override_byte_check and (not byte == self.id): raise Exception, "byte ("+hex(byte)+") != self.id ("+hex(self.id)+")" i = 0 for (key, param_type) in self.param_types.items(): name = param_type["name"] klass = param_type["class"] #make an instance of this class, like SingleByteParam() #or ItemLabelByte.. by making an instance, obj.parse() is called obj = klass(address=current_address, name=name, **self.args) #save this for later self.params[i] = obj #increment our counters current_address += obj.size i += 1 self.last_address = current_address return True class GivePoke(Command): id = 0x2D macro_name = "givepoke" size = 4 #minimum end = False param_types = { 0: {"name": "pokemon", "class": PokemonParam}, 1: {"name": "level", "class": SingleByteParam}, 2: {"name": "item", "class": ItemLabelByte}, 3: {"name": "trainer", "class": SingleByteParam}, 4: {"name": "trainer_name_pointer", "class": MultiByteParam}, #should probably use TextLabelParam 5: {"name": "pkmn_nickname", "class": MultiByteParam}, #XXX TextLabelParam ? } def parse(self): self.params = {} byte = ord(rom[self.address]) if not byte == self.id: raise Exception, "this should never happen" current_address = self.address+1 i = 0 self.size = 1 for (key, param_type) in self.param_types.items(): #stop executing after the 4th byte unless it == 0x1 if i == 4: print "self.params[3].byte is: " + str(self.params[3].byte) if i == 4 and self.params[3].byte != 1: break name = param_type["name"] klass = param_type["class"] #make an instance of this class, like SingleByteParam() #or ItemLabelByte.. by making an instance, obj.parse() is called obj = klass(address=current_address, name=name) #save this for later self.params[i] = obj #increment our counters current_address += obj.size self.size += obj.size i += 1 self.last_address = current_address return True class DataByteWordMacro(Command): """ Only used by the preprocessor. """ id = None macro_name = "dbw" size = 3 override_byte_check = True param_types = { 0: {"name": "db value", "class": DecimalParam}, 1: {"name": "dw value", "class": PointerLabelParam}, } def __init__(self): pass def parse(self): pass def to_asm(self): pass class TextCommand(Command): # an individual text command will not end it end = False # this is only used for e.g. macros that don't appear as a byte in the ROM override_byte_check = False # in the case of text/asm commands, size is unknown until after parsing size = None params = [] # most text commands won't have any dependencies # .. except for that one that points to another location for text # get_dependencies on Command will look at the values of params #def get_dependencies(self, recompute=False, global_dependencies=set()): # return [] class MainText(TextCommand): "Write text. Structure: [00][Text][0x50 (ends code)]" id = 0x0 macro_name = "do_text" def parse(self): offset = self.address # read until $50, $57 or $58 (not sure about $58...) jump57 = how_many_until(chr(0x57), offset) jump50 = how_many_until(chr(0x50), offset) jump58 = how_many_until(chr(0x58), offset) # pick whichever one comes first jump = min([jump57, jump50, jump58]) # if $57 appears first then this command is the last in this text script if jump == jump57: self.end = True # we want the address after the $57 # ("last_address" is misnamed everywhere) end_address = offset + 1 + jump self.last_address = self.end_address = end_address # read the text bytes into a structure self.bytes = rom_interval(offset + 1, jump, strings=False) self.size = jump + 1 def to_asm(self): if self.size < 2 or len(self.bytes) < 1: raise Exception, "$0 text command can't end itself with no follow-on bytes" output = "db $0" # db $0, $57 or db $0, $50 or w/e if self.size == 2 and len(self.bytes) == 1: output += ", $%.2x" % (self.bytes[0]) return output # whether or not quotes are open in_quotes = False # whether or not to print "db " next new_line = False for byte in self.bytes: if byte in [0x4f, 0x51, 0x55]: pass elif byte in [0x50, ]: pass # TODO return output class WriteTextFromRAM(TextCommand): """ Write text from ram. Structure: [01][Ram address (2byte)] For valid ram addresses see Glossary. This enables use of variable text strings. """ id = 0x1 macro_name = "text_from_ram" size = 3 class WriteNumberFromRAM(TextCommand): """ 02 = Write number from ram. Structure: [02][Ram address (2byte)][Byte] Byte: Bit5:Bit6:Bit7 1: 1: 1 = PokéDollar| Don’t write zeros 0: 1: 1 = Don’t write zeros 0: 0: 1 = Spaces instead of zeros 0: 0: 0 = Write zeros 0: 1: 0 = Write zeros 1: 0: 0 = PokéDollar 1: 1: 0 = PokéDollar 1: 0: 1 = Spaces instead of zeros| PokéDollar Number of figures = Byte AND 0x1F *2 No Hex --> Dec Conversio """ id = 0x2 macro_name = "number_from_ram" size = 4 class SetWriteRAMLocation(TextCommand): "Define new ram address to write to. Structure: [03][Ram address (2byte)]" id = 0x3 macro_name = "store_at" size = 3 class ShowBoxWithValueAt(TextCommand): "04 = Write a box. Structure: [04][Ram address (2byte)][Y][X]" id = 0x4 macro_name = "text_box" size = 5 class Populate2ndLineOfTextBoxWithRAMContents(TextCommand): "05 = New ram address to write to becomes 2nd line of a text box. Structure: [05]" id = 0x5 macro_name = "text_dunno1" size = 1 class ShowArrowsAndButtonWait(TextCommand): "06 = Wait for key down + show arrows. Structure: [06]" id = 0x6 macro_name = "waitbutton" size = 1 class Populate2ndLine(TextCommand): """ 07 = New ram address to write to becomes 2nd line of a text box Textbox + show arrows. Structure: [07] """ id = 0x7 macro_name = "text_dunno2" size = 1 class TextInlineAsm(TextCommand): "08 = After the code an ASM script starts. Structure: [08][Script]" id = 0x8 macro_name = "start_asm" end = True class WriteDecimalNumberFromRAM(TextCommand): """ 09 = Write number from rom/ram in decimal. Structure: [09][Ram address/Pointer (2byte)][Byte] Byte: Is split: 1. 4 bits = Number of bytes to load. 0 = 3, 1 = 1, 2 = 2 2. 4 bits = Number of figures of displayed number 0 = Don’t care 1 = Don’t care >=2 = Number """ id = 0x9 macro_name = "deciram" size = 4 class InterpretDataStream(TextCommand): """ 0A = Interpret Data stream. Structure: [0A] see: http://hax.iimarck.us/files/scriptingcodes_eng.htm#Marke88 """ id = 0xA macro_name = "interpret_data" size = 1 class Play0thSound(TextCommand): "0B = Play sound 0x0000. Structure: [0B]" id = 0xB sound_num = 0 macro_name = "sound0" size = 1 class LimitedIntrepretDataStream(TextCommand): """ 0C = Interpret Data stream. Structure: [0C][Number of codes to interpret] For every interpretation there is a“…“ written """ id = 0xC macro_name = "limited_interpret_data" size = 2 class WaitForKeyDownDisplayArrow(ShowArrowsAndButtonWait): """ 0D = Wait for key down display arrow. Structure: [0D] """ id = 0xD macro_name = "waitbutton2" size = 1 class Play9thSound(Play0thSound): id = 0xE sound_num = 9 macro_name = "sound0x09" size = 1 class Play1stSound(Play0thSound): id = 0xF sound_num = 1 macro_name = "sound0x0F" size = 1 class Play2ndSound(Play0thSound): id = 0x10 sound_num = 2 macro_name = "sound0x02" size = 1 class Play10thSound(Play0thSound): id = 0x11 sound_num = 10 macro_name = "sound0x0A" size = 1 class Play45thSound(Play0thSound): id = 0x12 sound_num = 0x2D macro_name = "sound0x2D" size = 1 class Play44thSound(Play0thSound): id = 0x13 sound_num = 0x2C macro_name = "sound0x2C" size = 1 class DisplayByteFromRAMAt(TextCommand): """ 14 = Display MEMORY. Structure: [14][Byte] Byte: 00 = MEMORY1 01 = MEMORY2 02 = MEMORY 04 = TEMPMEMORY2 05 = TEMPMEMORY1 """ id = 0x14 macro_name = "show_byte_at" size = 2 class WriteCurrentDay(TextCommand): "15 = Write current day. Structure: [15]" id = 0x15 macro_name = "current_day" size = 1 class TextJump(TextCommand): "16 = 3byte pointer to new text follows. Structure: [16][2byte pointer][bank]" id = 0x16 macro_name = "text_jump" size = 4 #byte: [name, [param1 name, param1 type], [param2 name, param2 type], ...] #0x9E: ["verbosegiveitem", ["item", ItemLabelByte], ["quantity", SingleByteParam]], pksv_crystal_more = { 0x00: ["2call", ["pointer", ScriptPointerLabelParam]], 0x01: ["3call", ["pointer", ScriptPointerLabelBeforeBank]], 0x02: ["2ptcall", ["pointer", PointerLabelToScriptPointer]], 0x03: ["2jump", ["pointer", ScriptPointerLabelParam]], 0x04: ["3jump", ["pointer", ScriptPointerLabelBeforeBank]], 0x05: ["2ptjump", ["pointer", PointerLabelToScriptPointer]], 0x06: ["if equal", ["byte", SingleByteParam], ["pointer", ScriptPointerLabelParam]], 0x07: ["if not equal", ["byte", SingleByteParam], ["pointer", ScriptPointerLabelParam]], 0x08: ["iffalse", ["pointer", ScriptPointerLabelParam]], 0x09: ["iftrue", ["pointer", ScriptPointerLabelParam]], 0x0A: ["if less than", ["byte", SingleByteParam], ["pointer", ScriptPointerLabelParam]], 0x0B: ["if greater than", ["byte", SingleByteParam], ["pointer", ScriptPointerLabelParam]], 0x0C: ["jumpstd", ["predefined_script", MultiByteParam]], 0x0D: ["callstd", ["predefined_script", MultiByteParam]], 0x0E: ["3callasm", ["asm", AsmPointerParam]], 0x0F: ["special", ["predefined_script", MultiByteParam]], 0x10: ["2ptcallasm", ["asm", PointerToAsmPointerParam]], #should map_group/map_id be dealt with in some special way in the asm? 0x11: ["checkmaptriggers", ["map_group", SingleByteParam], ["map_id", SingleByteParam]], 0x12: ["domaptrigger", ["map_group", MapGroupParam], ["map_id", MapIdParam], ["trigger_id", SingleByteParam]], 0x13: ["checktriggers"], 0x14: ["dotrigger", ["trigger_id", SingleByteParam]], 0x15: ["writebyte", ["value", SingleByteParam]], 0x16: ["addvar", ["value", SingleByteParam]], 0x17: ["random", ["input", SingleByteParam]], 0x18: ["checkver"], 0x19: ["copybytetovar", ["address", RAMAddressParam]], 0x1A: ["copyvartobyte", ["address", RAMAddressParam]], 0x1B: ["loadvar", ["address", RAMAddressParam], ["value", SingleByteParam]], 0x1C: ["checkcode", ["variable_id", SingleByteParam]], 0x1D: ["writevarcode", ["variable_id", SingleByteParam]], 0x1E: ["writecode", ["variable_id", SingleByteParam], ["value", SingleByteParam]], 0x1F: ["giveitem", ["item", ItemLabelByte], ["quantity", SingleByteParam]], 0x20: ["takeitem", ["item", ItemLabelByte], ["quantity", DecimalParam]], 0x21: ["checkitem", ["item", ItemLabelByte]], 0x22: ["givemoney", ["account", SingleByteParam], ["money", MoneyByteParam]], 0x23: ["takemoney", ["account", SingleByteParam], ["money", MoneyByteParam]], 0x24: ["checkmoney", ["account", SingleByteParam], ["money", MoneyByteParam]], 0x25: ["givecoins", ["coins", CoinByteParam]], 0x26: ["takecoins", ["coins", CoinByteParam]], 0x27: ["checkcoins", ["coins", CoinByteParam]], #0x28-0x2A not from pksv 0x28: ["addcellnum", ["person", SingleByteParam]], 0x29: ["delcellnum", ["person", SingleByteParam]], 0x2A: ["checkcellnum", ["person", SingleByteParam]], #back on track... 0x2B: ["checktime", ["time", SingleByteParam]], 0x2C: ["checkpoke", ["pkmn", PokemonParam]], #0x2D: ["givepoke", ], .... see GivePoke class 0x2E: ["giveegg", ["pkmn", PokemonParam], ["level", DecimalParam]], 0x2F: ["givepokeitem", ["pointer", PointerParamToItemAndLetter]], 0x30: ["checkpokeitem", ["pointer", PointerParamToItemAndLetter]], #not pksv 0x31: ["checkbit1", ["bit_number", MultiByteParam]], 0x32: ["clearbit1", ["bit_number", MultiByteParam]], 0x33: ["setbit1", ["bit_number", MultiByteParam]], 0x34: ["checkbit2", ["bit_number", MultiByteParam]], 0x35: ["clearbit2", ["bit_number", MultiByteParam]], 0x36: ["setbit2", ["bit_number", MultiByteParam]], 0x37: ["wildoff"], 0x38: ["wildon"], 0x39: ["xycompare", ["pointer", MultiByteParam]], 0x3A: ["warpmod", ["warp_id", SingleByteParam], ["map_group", MapGroupParam], ["map_id", MapIdParam]], 0x3B: ["blackoutmod", ["map_group", MapGroupParam], ["map_id", MapIdParam]], 0x3C: ["warp", ["map_group", MapGroupParam], ["map_id", MapIdParam], ["x", SingleByteParam], ["y", SingleByteParam]], 0x3D: ["readmoney", ["account", SingleByteParam], ["memory", SingleByteParam]], #not pksv 0x3E: ["readcoins", ["memory", SingleByteParam]], #not pksv 0x3F: ["RAM2MEM", ["memory", SingleByteParam]], #not pksv 0x40: ["pokenamemem", ["pokemon", PokemonParam], ["memory", SingleByteParam]], #not pksv 0x41: ["itemtotext", ["item", ItemLabelByte], ["memory", SingleByteParam]], 0x42: ["mapnametotext", ["memory", SingleByteParam]], #not pksv 0x43: ["trainertotext", ["trainer_id", TrainerIdParam], ["trainer_group", TrainerGroupParam], ["memory", SingleByteParam]], 0x44: ["stringtotext", ["text_pointer", RawTextPointerLabelParam], ["memory", SingleByteParam]], 0x45: ["itemnotify"], 0x46: ["pocketisfull"], 0x47: ["loadfont"], 0x48: ["refreshscreen", ["dummy", SingleByteParam]], 0x49: ["loadmovesprites"], 0x4A: ["loadbytec1ce", ["byte", SingleByteParam]], #not pksv 0x4B: ["3writetext", ["text_pointer", PointerLabelBeforeBank]], 0x4C: ["2writetext", ["text_pointer", RawTextPointerLabelParam]], 0x4D: ["repeattext", ["byte", SingleByteParam], ["byte", SingleByteParam]], #not pksv 0x4E: ["yesorno"], 0x4F: ["loadmenudata", ["data", MenuDataPointerParam]], 0x50: ["writebackup"], 0x51: ["jumptextfaceplayer", ["text_pointer", RawTextPointerLabelParam]], 0x53: ["jumptext", ["text_pointer", RawTextPointerLabelParam]], 0x54: ["closetext"], 0x55: ["keeptextopen"], 0x56: ["pokepic", ["pokemon", PokemonParam]], 0x57: ["pokepicyesorno"], 0x58: ["interpretmenu"], 0x59: ["interpretmenu2"], #not pksv 0x5A: ["loadpikachudata"], 0x5B: ["battlecheck"], 0x5C: ["loadtrainerdata"], #back to pksv.. 0x5D: ["loadpokedata", ["pokemon", PokemonParam], ["level", DecimalParam]], 0x5E: ["loadtrainer", ["trainer_group", TrainerGroupParam], ["trainer_id", TrainerIdParam]], 0x5F: ["startbattle"], 0x60: ["returnafterbattle"], 0x61: ["catchtutorial", ["byte", SingleByteParam]], #not pksv 0x62: ["trainertext", ["which_text", SingleByteParam]], 0x63: ["trainerstatus", ["action", SingleByteParam]], #back to pksv.. 0x64: ["winlosstext", ["win_text_pointer", TextPointerLabelParam], ["loss_text_pointer", TextPointerLabelParam]], 0x65: ["scripttalkafter"], #not pksv 0x66: ["talkaftercancel"], 0x67: ["talkaftercheck"], 0x68: ["setlasttalked", ["person", SingleByteParam]], 0x69: ["applymovement", ["person", SingleByteParam], ["data", MovementPointerLabelParam]], 0x6A: ["applymovement2", ["data", MovementPointerLabelParam]], #not pksv 0x6B: ["faceplayer"], 0x6C: ["faceperson", ["person1", SingleByteParam], ["person2", SingleByteParam]], 0x6D: ["variablesprite", ["byte", SingleByteParam], ["sprite", SingleByteParam]], 0x6E: ["disappear", ["person", SingleByteParam]], #hideperson 0x6F: ["appear", ["person", SingleByteParam]], #showperson 0x70: ["follow", ["person2", SingleByteParam], ["person1", SingleByteParam]], 0x71: ["stopfollow"], 0x72: ["moveperson", ["person", SingleByteParam], ["x", SingleByteParam], ["y", SingleByteParam]], 0x73: ["writepersonxy", ["person", SingleByteParam]], #not pksv 0x74: ["loademote", ["bubble", SingleByteParam]], 0x75: ["showemote", ["bubble", SingleByteParam], ["person", SingleByteParam], ["time", DecimalParam]], 0x76: ["spriteface", ["person", SingleByteParam], ["facing", SingleByteParam]], 0x77: ["follownotexact", ["person2", SingleByteParam], ["person1", SingleByteParam]], 0x78: ["earthquake", ["param", DecimalParam]], 0x79: ["changemap", ["map_data_pointer", MapDataPointerParam]], 0x7A: ["changeblock", ["x", SingleByteParam], ["y", SingleByteParam], ["block", SingleByteParam]], 0x7B: ["reloadmap"], 0x7C: ["reloadmappart"], 0x7D: ["writecmdqueue", ["queue_pointer", MultiByteParam]], 0x7E: ["delcmdqueue", ["byte", SingleByteParam]], 0x7F: ["playmusic", ["music_pointer", MultiByteParam]], 0x80: ["playrammusic"], 0x81: ["musicfadeout", ["music", MultiByteParam], ["fadetime", SingleByteParam]], 0x82: ["playmapmusic"], 0x83: ["reloadmapmusic"], 0x84: ["cry", ["cry_id", SingleByteParam], ["wtf", SingleByteParam]], #XXX maybe it should use PokemonParam 0x85: ["playsound", ["sound_pointer", MultiByteParam]], 0x86: ["waitbutton"], 0x87: ["warpsound"], 0x88: ["specialsound"], 0x89: ["passtoengine", ["data_pointer", PointerLabelBeforeBank]], 0x8A: ["newloadmap", ["which_method", SingleByteParam]], 0x8B: ["pause", ["length", DecimalParam]], 0x8C: ["deactivatefacing", ["time", SingleByteParam]], 0x8D: ["priorityjump", ["pointer", ScriptPointerLabelParam]], 0x8E: ["warpcheck"], 0x8F: ["ptpriorityjump", ["pointer", ScriptPointerLabelParam]], 0x90: ["return"], 0x91: ["end"], 0x92: ["reloadandreturn"], 0x93: ["resetfuncs"], 0x94: ["pokemart", ["dialog_id", SingleByteParam], ["mart_id", MultiByteParam]], #maybe it should be a pokemark constant id/label? 0x95: ["elevator", ["floor_list_pointer", PointerLabelParam]], 0x96: ["trade", ["trade_id", SingleByteParam]], 0x97: ["askforphonenumber", ["number", SingleByteParam]], 0x98: ["phonecall", ["caller_name", RawTextPointerLabelParam]], 0x99: ["hangup"], 0x9A: ["describedecoration", ["byte", SingleByteParam]], 0x9B: ["fruittree", ["tree_id", SingleByteParam]], 0x9C: ["specialphonecall", ["call_id", SingleByteParam], ["wtf", SingleByteParam]], 0x9D: ["checkphonecall"], 0x9E: ["verbosegiveitem", ["item", ItemLabelByte], ["quantity", DecimalParam]], 0x9F: ["verbosegiveitem2", ["item", ItemLabelByte]], 0xA0: ["loadwilddata", ["map_group", MapGroupParam], ["map_id", MapIdParam]], 0xA1: ["halloffame"], 0xA2: ["credits"], 0xA3: ["warpfacing", ["facing", SingleByteParam], ["map_group", MapGroupParam], ["map_id", MapIdParam], ["x", SingleByteParam], ["y", SingleByteParam]], 0xA4: ["storetext", ["pointer", PointerLabelBeforeBank], ["memory", SingleByteParam]], 0xA5: ["displaylocation", ["id", SingleByteParam]], 0xA8: ["unknown0xa8", ["unknown", SingleByteParam]], 0xB2: ["unknown0xb2", ["unknown", SingleByteParam]], 0xCC: ["unknown0xcc"], } def create_command_classes(debug=False): """creates some classes for each command byte""" #don't forget to add any manually created script command classes #.. except for Warp, Signpost and some others that aren't found in scripts klasses = [GivePoke] for (byte, cmd) in pksv_crystal_more.items(): cmd_name = cmd[0].replace(" ", "_") params = {"id": byte, "size": 1, "end": byte in pksv_crystal_more_enders, "macro_name": cmd_name} params["param_types"] = {} if len(cmd) > 1: param_types = cmd[1:] for (i, each) in enumerate(param_types): thing = {"name": each[0], "class": each[1]} params["param_types"][i] = thing if debug: print "each is: " + str(each) print "thing[class] is: " + str(thing["class"]) params["size"] += thing["class"].size klass_name = cmd_name+"Command" klass = classobj(klass_name, (Command,), params) globals()[klass_name] = klass klasses.append(klass) #later an individual klass will be instantiated to handle something return klasses command_classes = create_command_classes() def generate_macros(filename="../script_macros.asm"): """generates all macros based on commands this is dumped into script_macros.asm""" output = "; This file is generated by generate_macros.\n" for command in command_classes: output += "\n" #if command.macro_name[0].isdigit(): # output += "_" output += command.macro_name + ": MACRO\n" output += spacing + "db $%.2x\n"%(command.id) current_param = 1 for (index, each) in command.param_types.items(): if issubclass(each["class"], SingleByteParam): output += spacing + "db \\" + str(current_param) + "\n" elif issubclass(each["class"], MultiByteParam): output += spacing + "dw \\" + str(current_param) + "\n" current_param += 1 output += spacing + "ENDM\n" fh = open(filename, "w") fh.write(output) fh.close() return output #use this to keep track of commands without pksv names pksv_no_names = {} def pretty_print_pksv_no_names(): """just some nice debugging output use this to keep track of commands without pksv names pksv_no_names is created in parse_script_engine_script_at""" for (command_byte, addresses) in pksv_no_names.items(): if command_byte in pksv_crystal_unknowns: continue print hex(command_byte) + " appearing in these scripts: " for address in addresses: print " " + hex(address) recursive_scripts = set([]) def rec_parse_script_engine_script_at(address, origin=None, debug=True): """this is called in parse_script_engine_script_at for recursion when this works it should be flipped back to using the regular parser.""" recursive_scripts.add((address, origin)) return parse_script_engine_script_at(address, origin=origin, debug=debug) def find_broken_recursive_scripts(output=False, debug=True): """well.. these at least have a chance of maybe being broken?""" for r in list(recursive_scripts): script = {} length = "not counted here" if is_script_already_parsed_at(r[0]): script = script_parse_table[r[0]] length = str(len(script)) if len(script) > 20 or script == {}: print "******************* begin" print "script at " + hex(r[0]) + " from main script " + hex(r[1]) + " with length: " + length if output: parse_script_engine_script_at(r[0], force=True, debug=True) print "==================== end" stop_points = [0x1aafa2, 0x9f58f, #battle tower 0x9f62f, #battle tower ] class Script: base_label = "UnknownScript_" def __init__(self, *args, **kwargs): self.address = None self.commands = None if len(kwargs) == 0 and len(args) == 0: raise Exception, "Script.__init__ must be given some arguments" #first positional argument is address if len(args) == 1: address = args[0] if type(address) == str: address = int(address, 16) elif type(address) != int: raise Exception, "address must be an integer or string" self.address = address elif len(args) > 1: raise Exception, "don't know what to do with second (or later) positional arguments" self.dependencies = None if "label" in kwargs.keys(): label = kwargs["label"] else: label = None if not label: label = self.base_label + hex(self.address) self.label = Label(name=label, address=address, object=self) #parse the script at the address if "use_old_parse" in kwargs.keys() and kwargs["use_old_parse"] == True: self.old_parse(**kwargs) else: self.parse(self.address, **kwargs) def pksv_list(self): """shows a list of pksv names for each command in the script""" items = [] if type(self.commands) == dict: for (id, command) in self.commands.items(): if command["type"] in pksv_crystal: items.append(pksv_crystal[command["type"]]) else: items.append(hex(command["type"])) else: for command in self.commands: items.append(command.macro_name) return items def to_pksv(self): """returns a string of pksv command names""" pksv = self.pksv_list() output = "script starting at: "+hex(self.address)+" .. " first = True for item in pksv: item = str(item) if first: output += item first = False else: output += ", "+item return output def show_pksv(self): """prints a list of pksv command names in this script""" print self.to_pksv() def parse(self, start_address, force=False, map_group=None, map_id=None, force_top=True, origin=True, debug=False): """parses a script using the Command classes as an alternative to the old method using hard-coded commands force_top just means 'force the main script to get parsed, but not any subscripts' """ global command_classes, rom, script_parse_table current_address = start_address print "Script.parse address="+hex(self.address) +" map_group="+str(map_group)+" map_id="+str(map_id) if start_address in stop_points and force == False: print "script parsing is stopping at stop_point=" + hex(start_address) + " at map_group="+str(map_group)+" map_id="+str(map_id) return None if start_address < 0x4000 and start_address not in [0x26ef, 0x114, 0x1108]: print "address is less than 0x4000.. address is: " + hex(start_address) sys.exit(1) if is_script_already_parsed_at(start_address) and not force and not force_top: raise Exception, "this script has already been parsed before, please use that instance ("+hex(start_address)+")" # load up the rom if it hasn't been loaded already load_rom() # in the event that the script parsing fails.. it would be nice to leave evidence script_parse_table[start_address:start_address+1] = "incomplete parse_script_with_command_classes" # start with a blank script commands = [] # use this to control the while loop end = False # for each command found.. while not end: # get the current scripting byte cur_byte = ord(rom[current_address]) # reset the command class (last command was probably different) scripting_command_class = None # match the command id byte to a scripting command class like GivePoke for class_ in command_classes: if class_.id == cur_byte: scripting_command_class = class_ # no matching command found (not implemented yet)- just end this script # NOTE: might be better to raise an exception and end the program? if scripting_command_class == None: print "parsing script; current_address is: " + hex(current_address) current_address += 1 asm_output = "\n".join([command.to_asm() for command in commands]) end = True continue # maybe the program should exit with failure instead? #raise Exception, "no command found? id: " + hex(cur_byte) + " at " + hex(current_address) + " asm is:\n" + asm_output # create an instance of the command class and let it parse its parameter bytes #print "about to parse command(script@"+hex(start_address)+"): " + str(scripting_command_class.macro_name) cls = scripting_command_class(address=current_address, force=force, map_group=map_group, map_id=map_id) #if self.debug: # print cls.to_asm() # store it in this script object commands.append(cls) # certain commands will end the scripting engine end = cls.end # skip past the command's parameter bytes to go to the next command #current_address = cls.last_address + 1 current_address += cls.size # last byte belonging to script is last byte of last command, # or the last byte of the last command's last parameter self.last_address = current_address # store the script in the global table/map thing script_parse_table[start_address:current_address] = self asm_output = "\n".join([command.to_asm() for command in commands]) print "--------------\n"+asm_output # store the script self.commands = commands return commands def get_dependencies(self, recompute=False, global_dependencies=set()): if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies dependencies = [] for command in self.commands: deps = command.get_dependencies(recompute=recompute, global_dependencies=global_dependencies) dependencies.extend(deps) self.dependencies = dependencies return dependencies def to_asm(self): asm_output = "".join([command.to_asm()+"\n" for command in self.commands]) if asm_output[-1] == "\n": asm_output = asm_output[:-1] return asm_output def old_parse(self, *args, **kwargs): """included from old_parse_scripts""" from old_parse_scripts import old_parse Script.old_parse = old_parse def parse_script_engine_script_at(address, map_group=None, map_id=None, force=False, debug=True, origin=True): if is_script_already_parsed_at(address) and not force: return script_parse_table[address] return Script(address, map_group=map_group, map_id=map_id, force=force, debug=debug, origin=origin) def compare_script_parsing_methods(address): """ compares the parsed scripts using the new method and the old method The new method is Script.parse, the old method is Script.old_parse. There are likely to be problems with the new script parser, the one that uses the command classes to parse bytes. To look for these problems, you can compare the output of one parsing method to the output of the other. When there's a difference, there is something worth correcting. Probably by each command's "macro_name" attribute. """ load_rom() separator = "################ compare_script_parsing_methods" #first do it the old way print separator print "parsing the script at " + hex(address) + " using the old method" oldscript = Script(address, debug=True, force=True, origin=True, use_old_parse=True) #and now the old way print separator print "parsing the script at " + hex(address) + " using the new method" newscript = Script(address, debug=True, force=True, origin=True) #let the comparison begin.. errors = 0 print separator + " COMPARISON RESULTS" if not len(oldscript.commands.keys()) == len(newscript.commands): print "the two scripts don't have the same number of commands" errors += 1 for (id, oldcommand) in oldscript.commands.items(): newcommand = newscript.commands[id] oldcommand_pksv_name = pksv_crystal[oldcommand["type"]].replace(" ", "_") if oldcommand["start_address"] != newcommand.address: print "the two addresses (command id="+str(id)+") do not match old="+hex(oldcommand["start_address"]) + " new="+hex(newcommand.address) errors += 1 if oldcommand_pksv_name != newcommand.macro_name: print "the two commands (id="+str(id)+") do not have the same name old="+oldcommand_pksv_name+" new="+newcommand.macro_name errors += 1 print "total comparison errors: " + str(errors) return oldscript, newscript class Warp(Command): """only used outside of scripts""" size = warp_byte_size macro_name = "warp_def" param_types = { 0: {"name": "y", "class": HexByte}, 1: {"name": "x", "class": HexByte}, 2: {"name": "warp_to", "class": DecimalParam}, 3: {"name": "map_bank", "class": MapGroupParam}, 4: {"name": "map_id", "class": MapIdParam}, } override_byte_check = True def __init__(self, *args, **kwargs): self.id = kwargs["id"] script_parse_table[kwargs["address"] : kwargs["address"] + self.size] = self Command.__init__(self, *args, **kwargs) def get_dependencies(self, recompute=False, global_dependencies=set()): return [] all_warps = [] def parse_warps(address, warp_count, bank=None, map_group=None, map_id=None, debug=True): warps = [] current_address = address for each in range(warp_count): warp = Warp(address=current_address, id=each, bank=bank, map_group=map_group, map_id=map_id, debug=debug) current_address += warp_byte_size warps.append(warp) all_warps.extend(warps) return warps def old_parse_warp_bytes(some_bytes, debug=True): """parse some number of warps from the data""" assert len(some_bytes) % warp_byte_size == 0, "wrong number of bytes" warps = [] for bytes in grouper(some_bytes, count=warp_byte_size): y = int(bytes[0], 16) x = int(bytes[1], 16) warp_to = int(bytes[2], 16) map_group = int(bytes[3], 16) map_id = int(bytes[4], 16) warps.append({ "y": y, "x": x, "warp_to": warp_to, "map_group": map_group, "map_id": map_id, }) return warps class XYTrigger(Command): size = trigger_byte_size macro_name = "xy_trigger" param_types = { 0: {"name": "number", "class": DecimalParam}, 1: {"name": "y", "class": HexByte}, 2: {"name": "x", "class": HexByte}, 3: {"name": "unknown1", "class": SingleByteParam}, 4: {"name": "script", "class": ScriptPointerLabelParam}, 5: {"name": "unknown2", "class": SingleByteParam}, 6: {"name": "unknown3", "class": SingleByteParam}, } override_byte_check = True def __init__(self, *args, **kwargs): self.id = kwargs["id"] self.dependencies = None Command.__init__(self, *args, **kwargs) def get_dependencies(self, recompute=False, global_dependencies=set()): dependencies = [] if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies thing = script_parse_table[self.params[4].parsed_address] if thing and thing != self.params[4]: dependencies.append(thing) global_dependencies.add(thing) self.dependencies = dependencies return dependencies all_xy_triggers = [] def parse_xy_triggers(address, trigger_count, bank=None, map_group=None, map_id=None, debug=True): xy_triggers = [] current_address = address for each in range(trigger_count): xy_trigger = XYTrigger(address=current_address, id=each, bank=bank, map_group=map_group, map_id=map_id, debug=debug) current_address += trigger_byte_size xy_triggers.append(xy_trigger) all_xy_triggers.extend(xy_triggers) return xy_triggers def old_parse_xy_trigger_bytes(some_bytes, bank=None, map_group=None, map_id=None, debug=True): """parse some number of triggers from the data""" assert len(some_bytes) % trigger_byte_size == 0, "wrong number of bytes" triggers = [] for bytes in grouper(some_bytes, count=trigger_byte_size): trigger_number = int(bytes[0], 16) y = int(bytes[1], 16) x = int(bytes[2], 16) unknown1 = int(bytes[3], 16) #XXX probably 00? script_ptr_byte1 = int(bytes[4], 16) script_ptr_byte2 = int(bytes[5], 16) script_ptr = script_ptr_byte1 + (script_ptr_byte2 << 8) script_address = None script = None if bank: script_address = calculate_pointer(script_ptr, bank) print "******* parsing xy trigger byte scripts... x=" + str(x) + " y=" + str(y) script = parse_script_engine_script_at(script_address, map_group=map_group, map_id=map_id) triggers.append({ "trigger_number": trigger_number, "y": y, "x": x, "unknown1": unknown1, #probably 00 "script_ptr": script_ptr, "script_pointer": {"1": script_ptr_byte1, "2": script_ptr_byte2}, "script_address": script_address, "script": script, }) return triggers class ItemFragment(Command): """used by ItemFragmentParam and PeopleEvent (for items placed on a map)""" size = 2 macro_name = "item_frag" base_label = "ItemFragment_" override_byte_check = True param_types = { 0: {"name": "item", "class": ItemLabelByte}, 1: {"name": "quantity", "class": DecimalParam}, } def __init__(self, address=None, bank=None, map_group=None, map_id=None, debug=False, label=None): assert is_valid_address(address), "PeopleEvent must be given a valid address" self.address = address self.last_address = address + self.size self.bank = bank if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.map_group = map_group self.map_id = map_id self.debug = debug self.params = {} self.dependencies = None self.args = {"debug": debug, "map_group": map_group, "map_id": map_id, "bank": bank} script_parse_table[self.address : self.last_address] = self self.parse() class ItemFragmentParam(PointerLabelParam): """used by PeopleEvent""" def parse(self): PointerLabelParam.parse(self) address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) self.calculated_address = address itemfrag = ItemFragment(address=address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.itemfrag = itemfrag def get_dependencies(self, recompute=False, global_dependencies=set()): if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies self.dependencies = [self.itemfrag].extend(self.itemfrag.get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) global_dependencies.add(self.itemfrag) return self.dependencies class TrainerFragment(Command): """used by TrainerFragmentParam and PeopleEvent for trainer data Maybe this shouldn't be a Command. The output might sprawl over multiple lines, and maybe it should be commented in to_asm? [Bit no. (2byte)][Trainer group][Trainer] [2byte pointer to Text when seen] [2byte pointer to text when trainer beaten] [2byte pointer to script when lost (0000=Blackout)] [2byte pointer to script if won/talked to again] The bit number tell the game later on if the trainer has been beaten already (bit = 1) or not (bit = 0). All Bit number of BitTable1. 03 = Nothing 04 = Nothing 05 = Nothing 06 = Nothing """ size = 12 macro_name = "trainer_def" base_label = "Trainer_" override_byte_check = True param_types = { 0: {"name": "bit_number", "class": MultiByteParam}, 1: {"name": "trainer_group", "class": TrainerGroupParam}, 2: {"name": "trainer_id", "class": TrainerIdParam}, 3: {"name": "text_when_seen", "class": TextPointerLabelParam}, 4: {"name": "text_when_trainer_beaten", "class": TextPointerLabelParam}, 5: {"name": "script_when_lost", "class": ScriptPointerLabelParam}, 6: {"name": "script_talk_again", "class": ScriptPointerLabelParam}, } def __init__(self, *args, **kwargs): address = kwargs["address"] print "TrainerFragment address=" + hex(address) self.address = address self.last_address = self.address + self.size if not is_valid_address(address) or address in [0x26ef]: self.include_in_asm = False return script_parse_table[self.address : self.last_address] = self self.dependencies = None Command.__init__(self, *args, **kwargs) def get_dependencies(self, recompute=False, global_dependencies=set()): deps = [] if not is_valid_address(self.address): return deps if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies #deps.append(self.params[3]) deps.extend(self.params[3].get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) #deps.append(self.params[4]) deps.extend(self.params[4].get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) #deps.append(self.params[5]) deps.extend(self.params[5].get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) #deps.append(self.params[6]) deps.extend(self.params[6].get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) self.dependencies = deps return deps def to_asm(self): xspacing = "" output = "" output += xspacing + "; bit/flag number\n" output += xspacing + "dw $%.2x"%(self.params[0].parsed_number) output += "\n\n"+xspacing+"; trainer group && trainer id\n" output += xspacing + "db %d, %d" % (self.params[1].byte, self.params[2].byte) output += "\n\n"+xspacing+"; text when seen\n" output += xspacing + "dw " + self.params[3].to_asm() output += "\n\n"+xspacing+"; text when trainer beaten\n" output += xspacing + "dw " + self.params[4].to_asm() output += "\n\n"+xspacing+"; script when lost\n" output += xspacing + "dw " + self.params[5].to_asm() output += "\n\n"+xspacing+"; script when talk again\n" output += xspacing + "dw " + self.params[6].to_asm() return output class TrainerFragmentParam(PointerLabelParam): """used by PeopleEvent to point to trainer data""" def parse(self): address = calculate_pointer_from_bytes_at(self.address, bank=self.bank) self.calculated_address = address if address == 0x26ef: self.trainerfrag = None else: trainerfrag = TrainerFragment(address=address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.trainerfrag = trainerfrag PointerLabelParam.parse(self) def get_dependencies(self, recompute=False, global_dependencies=set()): deps = [] if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies if self.trainerfrag: global_dependencies.add(self.trainerfrag) deps.append(self.trainerfrag) deps.extend(self.trainerfrag.get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) self.dependencies = deps return deps class PeopleEvent(Command): size = people_event_byte_size macro_name = "person_event" base_label = "PeopleEvent_" override_byte_check = True param_types = { 0: {"name": "picture", "class": HexByte}, 1: {"name": "y from top+4", "class": DecimalParam}, 2: {"name": "x from top+4", "class": DecimalParam}, 3: {"name": "facing", "class": HexByte}, 4: {"name": "movement", "class": HexByte}, 5: {"name": "clock_hour", "class": DecimalParam}, 6: {"name": "clock_daytime", "class": DecimalParam}, 7: {"name": "color_function", "class": HexByte}, 8: {"name": "sight_range", "class": DecimalParam}, 9: {"name": "pointer", "class": PointerLabelParam}, #or ScriptPointerLabelParam or ItemLabelParam 10: {"name": "BitTable1 bit number", "class": MultiByteParam}, } def xto_asm(self): output = "\n; person-event\n; picture, y, x, facing, movement, clock_hour, clock_daytime, color_function, sight_range\n" output += "db $%.2x, %d, %d, $%.2x, $%.2x, %d, %d, $%.2x, %d\n" % (self.params[0].byte, self.params[1].byte, self.params[2].byte, self.params[3].byte, self.params[4].byte, self.params[5].byte, self.params[6].byte, self.params[7].byte, self.params[8].byte) output += "; pointer\ndw %s\n" % (self.params[9].to_asm()) output += "; BitTable1 bit number\ndw %s" % (self.params[10].to_asm()) return output def __init__(self, address, id, bank=None, map_group=None, map_id=None, debug=False, label=None, force=False): assert is_valid_address(address), "PeopleEvent must be given a valid address" self.address = address self.last_address = address + people_event_byte_size self.id = id self.bank = bank if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.map_group = map_group self.map_id = map_id self.debug = debug self.force = force self.params = {} self.dependencies = None #PeopleEvent should probably not be in the global script_parse_table #script_parse_table[self.address : self.last_address] = self self.parse() def parse(self): address = self.address bank = self.bank color_function_byte = None lower_bits = None higher_bits = None is_regular_script = None is_give_item = None is_trainer = None self.params = {} current_address = self.address i = 0 self.size = 1 color_function_byte = None for (key, param_type) in self.param_types.items(): if i == 9: if is_give_item: name = "item_fragment_pointer" klass = ItemFragmentParam elif is_regular_script: name = "script_pointer" klass = ScriptPointerLabelParam elif is_trainer: name = "trainer" #klass = MultiByteParam klass = TrainerFragmentParam else: name = "unknown" klass = MultiByteParam else: name = param_type["name"] klass = param_type["class"] obj = klass(address=current_address, name=name, debug=self.debug, force=self.force, map_group=self.map_group, map_id=self.map_id, bank=self.bank) self.params[i] = obj if i == 7: color_function_byte = ord(rom[current_address]) lower_bits = color_function_byte & 0xF higher_bits = color_function_byte >> 4 is_regular_script = lower_bits == 00 is_give_item = lower_bits == 01 is_trainer = lower_bits == 02 current_address += obj.size self.size += obj.size i += 1 self.last_address = current_address self.is_trainer = is_trainer self.is_give_item = is_give_item self.is_regular_script = is_regular_script self.y = self.params[1].byte self.x = self.params[2].byte self.facing = self.params[3].byte self.movement = self.params[4].byte self.clock_hour = self.params[5].byte self.clock_daytime = self.params[6].byte self.color_function = self.params[7].byte self.sight_range = self.params[8].byte self.pointer = self.params[9].bytes self.bit_number = self.params[10].bytes return True all_people_events = [] def parse_people_events(address, people_event_count, bank=None, map_group=None, map_id=None, debug=False, force=False): #people_event_byte_size people_events = [] current_address = address id = 0 for each in range(people_event_count): pevent = PeopleEvent(address=current_address, id=id, bank=bank, map_group=map_group, map_id=map_id, debug=debug, force=force) current_address += people_event_byte_size people_events.append(pevent) id += 1 all_people_events.extend(people_events) return people_events def old_parse_people_event_bytes(some_bytes, address=None, map_group=None, map_id=None, debug=True): """parse some number of people-events from the data see http://hax.iimarck.us/files/scriptingcodes_eng.htm#Scripthdr For example, map 1.1 (group 1 map 1) has four person-events. 37 05 07 06 00 FF FF 00 00 02 40 FF FF 3B 08 0C 05 01 FF FF 00 00 05 40 FF FF 3A 07 06 06 00 FF FF A0 00 08 40 FF FF 29 05 0B 06 00 FF FF 00 00 0B 40 FF FF """ assert len(some_bytes) % people_event_byte_size == 0, "wrong number of bytes" #address is not actually required for this function to work... bank = None if address: bank = calculate_bank(address) people_events = [] for bytes in grouper(some_bytes, count=people_event_byte_size): pict = int(bytes[0], 16) y = int(bytes[1], 16) #y from top + 4 x = int(bytes[2], 16) #x from left + 4 face = int(bytes[3], 16) #0-4 for regular, 6-9 for static facing move = int(bytes[4], 16) clock_time_byte1 = int(bytes[5], 16) clock_time_byte2 = int(bytes[6], 16) color_function_byte = int(bytes[7], 16) #Color|Function trainer_sight_range = int(bytes[8], 16) lower_bits = color_function_byte & 0xF #lower_bits_high = lower_bits >> 2 #lower_bits_low = lower_bits & 3 higher_bits = color_function_byte >> 4 #higher_bits_high = higher_bits >> 2 #higher_bits_low = higher_bits & 3 is_regular_script = lower_bits == 00 #pointer points to script is_give_item = lower_bits == 01 #pointer points to [Item no.][Amount] is_trainer = lower_bits == 02 #pointer points to trainer header #goldmap called these next two bytes "text_block" and "text_bank"? script_pointer_byte1 = int(bytes[9], 16) script_pointer_byte2 = int(bytes[10], 16) script_pointer = script_pointer_byte1 + (script_pointer_byte2 << 8) #calculate the full address by assuming it's in the current bank #but what if it's not in the same bank? extra_portion = {} if bank: ptr_address = calculate_pointer(script_pointer, bank) if is_regular_script: print "parsing a person-script at x=" + str(x-4) + " y=" + str(y-4) + " address="+hex(ptr_address) script = parse_script_engine_script_at(ptr_address, map_group=map_group, map_id=map_id) extra_portion = { "script_address": ptr_address, "script": script, "event_type": "script", } if is_give_item: print "... not parsing give item event... [item id][quantity]" extra_portion = { "event_type": "give_item", "give_item_data_address": ptr_address, "item_id": ord(rom[ptr_address]), "item_qty": ord(rom[ptr_address+1]), } if is_trainer: print "parsing a trainer (person-event) at x=" + str(x) + " y=" + str(y) parsed_trainer = parse_trainer_header_at(ptr_address, map_group=map_group, map_id=map_id) extra_portion = { "event_type": "trainer", "trainer_data_address": ptr_address, "trainer_data": parsed_trainer, } #XXX not sure what's going on here #bit no. of bit table 1 (hidden if set) #note: FFFF for none when_byte = int(bytes[11], 16) hide = int(bytes[12], 16) bit_number_of_bit_table1_byte2 = int(bytes[11], 16) bit_number_of_bit_table1_byte1 = int(bytes[12], 16) bit_number_of_bit_table1 = bit_number_of_bit_table1_byte1 + (bit_number_of_bit_table1_byte2 << 8) people_event = { "pict": pict, "y": y, #y from top + 4 "x": x, #x from left + 4 "face": face, #0-4 for regular, 6-9 for static facing "move": move, "clock_time": {"1": clock_time_byte1, "2": clock_time_byte2}, #clock/time setting byte 1 "color_function_byte": color_function_byte, #Color|Function "trainer_sight_range": trainer_sight_range, #trainer range of sight "script_pointer": {"1": script_pointer_byte1, "2": script_pointer_byte2}, #"text_block": text_block, #script pointer byte 1 #"text_bank": text_bank, #script pointer byte 2 "when_byte": when_byte, #bit no. of bit table 1 (hidden if set) "hide": hide, #note: FFFF for none "is_trainer": is_trainer, "is_regular_script": is_regular_script, "is_give_item": is_give_item, } people_event.update(extra_portion) people_events.append(people_event) return people_events class SignpostRemoteBase: def __init__(self, address, bank=None, map_group=None, map_id=None, signpost=None, debug=False, label=None): self.address = address self.last_address = address + self.size script_parse_table[self.address : self.last_address] = self self.bank = bank self.map_group = map_group self.map_id = map_id self.signpost = signpost self.debug = debug self.params = [] if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.dependencies = None self.parse() def get_dependencies(self, recompute=False, global_dependencies=set()): dependencies = [] if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies for p in self.params: deps = p.get_dependencies(recompute=recompute, global_dependencies=global_dependencies) dependencies.extend(deps) self.dependencies = dependencies return dependencies def to_asm(self): """very similar to Command.to_asm""" if len(self.params) == 0: return "" output = ", ".join([p.to_asm() for p in self.params]) return output class SignpostRemoteScriptChunk(SignpostRemoteBase): """ a signpost might point to [Bit-Nr. (2byte)][2byte pointer to script] """ base_label = "SignpostRemoteScript_" size = 4 def parse(self): address = self.address bank = self.bank #bit_table_byte1 = ord(rom[address]) #bit_table_byte2 = ord(rom[address+1]) bit_table = MultiByteParam(address=address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.params.append(bit_table) #script_address = calculate_pointer_from_bytes_at(address+2, bank=bank) #script = parse_script_engine_script_at(script_address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) script_param = ScriptPointerLabelParam(address=address+2, map_group=self.map_group, map_id=self.map_id, debug=self.debug, force=False) self.params.append(script_param) self.script = script_param.script self.signpost.remote_script = self.script #self.bit_table_bytes = [bit_table_byte1, bit_table_byte2] #self.script_address = script_address #self.script = script class SignpostRemoteItemChunk(SignpostRemoteBase): """ a signpost might point to [Bit-Nr. (2byte)][Item no.] """ base_label = "SignpostRemoteItem_" size = 3 def parse(self): address = self.address bank = self.bank bit_table = MultiByteParam(address=address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.params.append(bit_table) item = ItemLabelByte(address=address+2) self.params.append(item) self.item = item class SignpostRemoteUnknownChunk(SignpostRemoteBase): """ a signpost might point to [Bit-Nr. (2byte)][??] """ base_label = "SignpostRemoteUnknown_" size = 3 def parse(self): address = self.address bank = self.bank bit_table = MultiByteParam(address=address, bank=self.bank, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.params.append(bit_table) byte = SingleByteParam(address=address+2) self.params.append(byte) #this could potentially extend Command #see how class Warp does this class Signpost(Command): """parse some number of signposts from the data [Y position][X position][Function][Script pointer (2byte)] functions: 00 Sign can be read from all directions script pointer to: script 01 Sign can only be read from below script pointer to: script 02 Sign can only be read from above script pointer to: script 03 Sign can only be read from right script pointer to: script 04 Sign can only be read from left script pointer to: script 05 If bit of BitTable1 is set then pointer is interpreted script pointer to: [Bit-Nr. (2byte)][2byte pointer to script] 06 If bit of BitTable1 is not set then pointer is interpreted script pointer to: [Bit-Nr. (2byte)][2byte pointer to script] 07 If bit of BitTable1 is set then item is given script pointer to: [Bit-Nr. (2byte)][Item no.] 08 No Action script pointer to: [Bit-Nr. (2byte)][??] """ size = 5 macro_name = "signpost" override_byte_check = True #preprocessor uses this param_types = { 0: {"name": "y", "class": DecimalParam}, 1: {"name": "x", "class": DecimalParam}, 2: {"name": "function", "class": HexByte}, 3: {"name": "pointer", "class": PointerLabelParam}, } def __init__(self, address, id, bank=None, map_group=None, map_id=None, debug=True, label=None): self.address = address self.id = id if label == None: label = "UnknownSignpost_"+str(map_group)+"Map"+str(map_id)+"_"+hex(address) self.label = Label(name=label, address=address, object=self) self.map_group = map_group self.map_id = map_id self.debug = debug self.bank = bank self.last_address = self.address + self.size self.y, self.x, self.func = None, None, None #Signpost should probably not be in the globals #script_parse_table[self.address : self.last_address] = self self.remotes = [] self.params = [] self.dependencies = None self.parse() def parse(self): """parse just one signpost""" address = self.address bank = self.bank self.last_address = self.address + self.size bytes = rom_interval(self.address, self.size) #, signpost_byte_size) self.y = int(bytes[0], 16) self.x = int(bytes[1], 16) self.func = int(bytes[2], 16) y, x, func = self.y, self.x, self.func #y self.params.append(DecimalParam(address=address, bank=self.bank, map_group=self.map_group, map_id=self.map_id, debug=self.debug)) #x self.params.append(DecimalParam(address=address+1, bank=self.bank, map_group=self.map_group, map_id=self.map_id, debug=self.debug)) #func self.params.append(HexByte(address=address+2, bank=self.bank, map_group=self.map_group, map_id=self.map_id, debug=self.debug)) output = "******* parsing signpost "+str(self.id)+" at: " output += "x="+str(x)+" y="+str(y)+" on map_group=" output += str(self.map_group)+" map_id="+str(self.map_id) if func in [0, 1, 2, 3, 4]: #signpost's script pointer points to a script script_ptr_byte1 = int(bytes[3], 16) script_ptr_byte2 = int(bytes[4], 16) script_pointer = script_ptr_byte1 + (script_ptr_byte2 << 8) script_address = calculate_pointer(script_pointer, bank) output += " script@"+hex(script_address) print output param = ScriptPointerLabelParam(address=self.address+3, map_group=self.map_group, map_id=self.map_id, debug=self.debug, force=False) self.params.append(param) #self.script_address = script_address #self.script = script elif func in [5, 6]: #signpost's script pointer points to [Bit-Nr. (2byte)][2byte pointer to script] ptr_byte1 = int(bytes[3], 16) ptr_byte2 = int(bytes[4], 16) pointer = ptr_byte1 + (ptr_byte2 << 8) address = calculate_pointer(pointer, bank) bit_table_byte1 = ord(rom[address]) bit_table_byte2 = ord(rom[address+1]) script_ptr_byte1 = ord(rom[address+2]) script_ptr_byte2 = ord(rom[address+3]) script_address = calculate_pointer_from_bytes_at(address+2, bank=bank) output += " remote_chunk@"+hex(address)+" remote_script@"+hex(script_address) print output r1 = SignpostRemoteScriptChunk(address, signpost=self, \ bank=self.bank, map_group=self.map_group, map_id=self.map_id, \ debug=self.debug) self.remotes.append(r1) mb = PointerLabelParam(address=address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.params.append(mb) elif func == 7: #signpost's script pointer points to [Bit-Nr. (2byte)][Item no.] ptr_byte1 = int(bytes[3], 16) ptr_byte2 = int(bytes[4], 16) pointer = ptr_byte1 + (ptr_byte2 << 8) address = calculate_pointer(pointer, bank) item_id = ord(rom[address+2]) output += " item_id="+str(item_id) print output r1 = SignpostRemoteItemChunk(address, signpost=self, \ bank=self.bank, map_group=self.map_group, map_id=self.map_id, \ debug=self.debug) self.remotes.append(r1) mb = PointerLabelParam(address=address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.params.append(mb) #bit_table_byte1 = ord(rom[address]) #bit_table_byte2 = ord(rom[address+1]) #self.bit_table_bytes = [bit_table_byte1, bit_table_byte2] #self.item_id = item_id elif func == 8: #signpost's script pointer points to [Bit-Nr. (2byte)][??] ptr_byte1 = int(bytes[3], 16) ptr_byte2 = int(bytes[4], 16) pointer = ptr_byte1 + (ptr_byte2 << 8) address = calculate_pointer(pointer, bank) output += " remote unknown chunk at="+hex(address) print output r1 = SignpostRemoteUnknownChunk(address, signpost=self, \ bank=self.bank, map_group=self.map_group, map_id=self.map_id, \ debug=self.debug) self.remotes.append(r1) mb = PointerLabelParam(address=address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.params.append(mb) else: raise Exception, "unknown signpost type byte="+hex(func) + " signpost@"+hex(self.address) def get_dependencies(self, recompute=False, global_dependencies=set()): dependencies = [] if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies for p in self.params: dependencies.extend(p.get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) self.dependencies = dependencies return dependencies def to_asm(self): output = self.macro_name + " " if self.params == []: raise Exception, "signpost has no params?" output += ", ".join([p.to_asm() for p in self.params]) return output all_signposts = [] def parse_signposts(address, signpost_count, bank=None, map_group=None, map_id=None, debug=True): if bank == None: raise Exception, "signposts need to know their bank" signposts = [] current_address = address id = 0 for each in range(signpost_count): signpost = Signpost(current_address, id, bank=bank, map_group=map_group, map_id=map_id, debug=debug) current_address += signpost_byte_size #i think ?? signposts.append(signpost) id += 1 all_signposts.extend(signposts) return signposts def old_parse_signpost_bytes(some_bytes, bank=None, map_group=None, map_id=None, debug=True): assert len(some_bytes) % signpost_byte_size == 0, "wrong number of bytes" signposts = [] for bytes in grouper(some_bytes, count=signpost_byte_size): y = int(bytes[0], 16) x = int(bytes[1], 16) func = int(bytes[2], 16) additional = {} if func in [0, 1, 2, 3, 4]: print "******* parsing signpost script.. signpost is at: x=" + str(x) + " y=" + str(y) script_ptr_byte1 = int(bytes[3], 16) script_ptr_byte2 = int(bytes[4], 16) script_pointer = script_ptr_byte1 + (script_ptr_byte2 << 8) script_address = None script = None script_address = calculate_pointer(script_pointer, bank) script = parse_script_engine_script_at(script_address, map_group=map_group, map_id=map_id) additional = { "script_ptr": script_pointer, "script_pointer": {"1": script_ptr_byte1, "2": script_ptr_byte2}, "script_address": script_address, "script": script, } elif func in [5, 6]: print "******* parsing signpost script.. signpost is at: x=" + str(x) + " y=" + str(y) ptr_byte1 = int(bytes[3], 16) ptr_byte2 = int(bytes[4], 16) pointer = ptr_byte1 + (ptr_byte2 << 8) address = calculate_pointer(pointer, bank) bit_table_byte1 = ord(rom[address]) bit_table_byte2 = ord(rom[address+1]) script_ptr_byte1 = ord(rom[address+2]) script_ptr_byte2 = ord(rom[address+3]) script_address = calculate_pointer_from_bytes_at(address+2, bank=bank) script = parse_script_engine_script_at(script_address, map_group=map_group, map_id=map_id) additional = { "bit_table_bytes": {"1": bit_table_byte1, "2": bit_table_byte2}, "script_ptr": script_ptr_byte1 + (script_ptr_byte2 << 8), "script_pointer": {"1": script_ptr_byte1, "2": script_ptr_byte2}, "script_address": script_address, "script": script, } else: print ".. type 7 or 8 signpost not parsed yet." spost = { "y": y, "x": x, "func": func, } spost.update(additional) signposts.append(spost) return signposts class MapHeader: base_label = "MapHeader_" def __init__(self, address, map_group=None, map_id=None, debug=True, label=None, bank=0x25): print "creating a MapHeader at "+hex(address)+" map_group="+str(map_group)+" map_id="+str(map_id) self.address = address self.map_group = map_group self.map_id = map_id self.bank = bank self.debug = debug self.dependencies = None if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.last_address = address + 9 script_parse_table[address : self.last_address] = self self.parse() def parse(self): address = self.address print "parsing a MapHeader at " + hex(address) self.bank = HexByte(address=address) self.tileset = HexByte(address=address+1) self.permission = DecimalParam(address=address+2) self.second_map_header_address = calculate_pointer(ord(rom[address+3])+(ord(rom[address+4])<<8), self.bank.byte) #TODO: is the bank really supposed to be 0x25 all the time ?? self.second_map_header = SecondMapHeader(self.second_map_header_address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) all_second_map_headers.append(self.second_map_header) self.location_on_world_map = HexByte(address=address+5) self.music = HexByte(address=address+6) self.time_of_day = DecimalParam(address=address+7) self.fishing_group = DecimalParam(address=address+8) def get_dependencies(self, recompute=False, global_dependencies=set()): if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies dependencies = [self.second_map_header] global_dependencies.add(self.second_map_header) dependencies.append(self.second_map_header.get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) self.dependencies = dependencies return dependencies def to_asm(self): output = "; bank, tileset, permission\n" output += "db " + ", ".join([self.bank.to_asm(), self.tileset.to_asm(), self.permission.to_asm()]) output += "\n\n; second map header\n" output += "dw " + PointerLabelParam(address=self.address+3).to_asm() #TODO: should we include bank=self.bank.byte ?? output += "\n\n; location on world map, music, time of day, fishing group\n" output += "db " + ", ".join([self.location_on_world_map.to_asm(), self.music.to_asm(), self.time_of_day.to_asm(), self.fishing_group.to_asm()]) return output all_map_headers = [] def parse_map_header_at(address, map_group=None, map_id=None, debug=True): """parses an arbitrary map header at some address""" print "parsing a map header at: " + hex(address) map_header = MapHeader(address, map_group=map_group, map_id=map_id, debug=debug) all_map_headers.append(map_header) return map_header def old_parse_map_header_at(address, map_group=None, map_id=None, debug=True): """parses an arbitrary map header at some address""" print "parsing a map header at: " + hex(address) bytes = rom_interval(address, map_header_byte_size, strings=False, debug=debug) bank = bytes[0] tileset = bytes[1] permission = bytes[2] second_map_header_address = calculate_pointer(bytes[3] + (bytes[4] << 8), 0x25) location_on_world_map = bytes[5] #pokégear world map location music = bytes[6] time_of_day = bytes[7] fishing_group = bytes[8] map_header = { "bank": bank, "tileset": tileset, "permission": permission, #map type? "second_map_header_pointer": {"1": bytes[3], "2": bytes[4]}, "second_map_header_address": second_map_header_address, "location_on_world_map": location_on_world_map, #area "music": music, "time_of_day": time_of_day, "fishing": fishing_group, } print "second map header address is: " + hex(second_map_header_address) map_header["second_map_header"] = old_parse_second_map_header_at(second_map_header_address, debug=debug) event_header_address = map_header["second_map_header"]["event_address"] script_header_address = map_header["second_map_header"]["script_address"] #maybe event_header and script_header should be put under map_header["second_map_header"] map_header["event_header"] = old_parse_map_event_header_at(event_header_address, map_group=map_group, map_id=map_id, debug=debug) map_header["script_header"] = old_parse_map_script_header_at(script_header_address, map_group=map_group, map_id=map_id, debug=debug) return map_header class SecondMapHeader: base_label = "SecondMapHeader_" def __init__(self, address, map_group=None, map_id=None, debug=True, bank=None, label=None): print "creating a SecondMapHeader at " + hex(address) self.address = address self.map_group = map_group self.map_id = map_id self.debug = debug self.bank = bank self.dependencies = None if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.last_address = address+12 #i think it's always a static size? script_parse_table[address : self.last_address] = self self.parse() def parse(self): address = self.address bytes = rom_interval(address, second_map_header_byte_size, strings=False) self.border_block = HexByte(address=address) self.height = DecimalParam(address=address+1) self.width = DecimalParam(address=address+2) #TODO: process blockdata ? #bank appears first ###self.blockdata_address = PointerLabelBeforeBank(address+3) self.blockdata_address = calculate_pointer_from_bytes_at(address+3, bank=True) self.blockdata = MapBlockData(self.blockdata_address, map_group=self.map_group, map_id=self.map_id, debug=self.debug, width=self.width, height=self.height) #bank appears first #TODO: process MapScriptHeader ###self.script_address = PointerLabelBeforeBank(address+6) self.script_header_address = calculate_pointer_from_bytes_at(address+6, bank=True) self.script_header = MapScriptHeader(self.script_header_address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) all_map_script_headers.append(self.script_header) self.event_bank = ord(rom[address+6]) self.event_header_address = calculate_pointer_from_bytes_at(address+9, bank=ord(rom[address+6])) self.event_header = MapEventHeader(self.event_header_address, map_group=self.map_group, map_id=self.map_id, debug=self.debug) self.connections = DecimalParam(address=address+11) all_map_event_headers.append(self.event_header) #border_block = bytes[0] #height = bytes[1] #width = bytes[2] #blockdata_bank = bytes[3] #blockdata_pointer = bytes[4] + (bytes[5] << 8) #blockdata_address = calculate_pointer(blockdata_pointer, blockdata_bank) #script_bank = bytes[6] #script_pointer = bytes[7] + (bytes[8] << 8) #script_address = calculate_pointer(script_pointer, script_bank) #event_bank = script_bank #event_pointer = bytes[9] + (bytes[10] << 8) #event_address = calculate_pointer(event_pointer, event_bank) #connections = bytes[11] #### #self.bordere_block = border_block #self.height = height #self.width = width #self.blockdata_bank = blockdata_bank #self.blockdata_pointer = blockdata_pointer #self.blockdata_address = blockdata_address #self.script_bank = script_bank #self.script_pointer = script_pointer #self.script_address = script_address #self.event_bank = event_bank #self.event_pointer = event_pointer #self.event_address = event_address #self.connections = connections return True def get_dependencies(self, recompute=False, global_dependencies=set()): if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies dependencies = [self.script_header, self.event_header, self.blockdata] global_dependencies.update(dependencies) dependencies.append(self.script_header.get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) dependencies.append(self.event_header.get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) self.dependencies = dependencies return dependencies def to_asm(self): output = "; border block\n" output += "db " + self.border_block.to_asm() + "\n\n" output += "; height, width\n" output += "db " + self.height.to_asm() + ", " + self.width.to_asm() + "\n\n" output += "; blockdata (bank-then-pointer)\n" thing = ScriptPointerLabelBeforeBank(address=self.address+3, map_group=self.map_group, map_id=self.map_id, debug=self.debug).to_asm() output += "dbw " + thing.split(", ")[0] + ", "+thing.split(", ")[1] + "\n\n" output += "; script header (bank-then-pointer)\n" thing = ScriptPointerLabelBeforeBank(address=self.address+6, map_group=self.map_group, map_id=self.map_id, debug=self.debug).to_asm() output += "dbw " + thing.split(", ")[0] + ", " + thing.split(", ")[1] + "\n\n" output += "; map event header (bank-then-pointer)\n" output += "dw " + PointerLabelParam(address=self.address+9, bank=self.event_bank, map_group=self.map_group, map_id=self.map_id, debug=self.debug).to_asm() + "\n\n" output += "; connections\n" output += "db " + self.connections.to_asm() return output all_second_map_headers = [] def parse_second_map_header_at(address, map_group=None, map_id=None, debug=True): """each map has a second map header""" smh = SecondMapHeader(address, map_group=map_group, map_id=map_id, debug=debug) all_second_map_headers.append(smh) return smh def old_parse_second_map_header_at(address, map_group=None, map_id=None, debug=True): """each map has a second map header""" bytes = rom_interval(address, second_map_header_byte_size, strings=False) border_block = bytes[0] height = bytes[1] width = bytes[2] blockdata_bank = bytes[3] blockdata_pointer = bytes[4] + (bytes[5] << 8) blockdata_address = calculate_pointer(blockdata_pointer, blockdata_bank) script_bank = bytes[6] script_pointer = bytes[7] + (bytes[8] << 8) script_address = calculate_pointer(script_pointer, script_bank) event_bank = script_bank event_pointer = bytes[9] + (bytes[10] << 8) event_address = calculate_pointer(event_pointer, event_bank) connections = bytes[11] return { "border_block": border_block, "height": height, "width": width, "blockdata_bank": blockdata_bank, "blockdata_pointer": {"1": bytes[4], "2": bytes[5]}, "blockdata_address": blockdata_address, "script_bank": script_bank, "script_pointer": {"1": bytes[7], "2": bytes[8]}, "script_address": script_address, "event_bank": event_bank, "event_pointer": {"1": bytes[9], "2": bytes[10]}, "event_address": event_address, "connections": connections, } class MapBlockData: base_label = "MapBlockData_" maps_path = os.path.realpath(os.path.join(os.path.realpath("."), "../maps")) def __init__(self, address, map_group=None, map_id=None, debug=True, bank=None, label=None, width=None, height=None): self.address = address self.map_group = map_group self.map_id = map_id self.map_name = map_names[map_group][map_id]["label"] self.map_path = os.path.join(self.maps_path, self.map_name + ".blk") self.debug = debug self.bank = bank if width and height: self.width = width self.height = height else: raise Exception, "MapBlockData needs to know the width/height of its map" if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.last_address = self.address + (self.width.byte * self.height.byte) script_parse_table[address : self.last_address] = self self.parse() def save_to_file(self): #check if the file exists already map_path = self.map_path if not os.path.exists(self.maps_path): os.mkdir(self.maps_path) if not os.path.exists(map_path): #dump to file #bytes = rom_interval(self.address, self.width.byte*self.height.byte, strings=True) bytes = rom[self.address : self.address + self.width.byte*self.height.byte] file_handler = open(map_path, "w") file_handler.write(bytes) file_handler.close() def parse(self): self.save_to_file() def to_asm(self): return "INCBIN \"maps/"+self.map_name+".blk\"" class MapEventHeader: base_label = "MapEventHeader_" def __init__(self, address, map_group=None, map_id=None, debug=True, bank=None, label=None): print "making a MapEventHeader at "+hex(address)+" map_group="+str(map_group)+" map_id="+str(map_id) self.address = address self.map_group = map_group self.map_id = map_id self.debug = debug self.bank = bank self.dependencies = None if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.parse() script_parse_table[address : self.last_address] = self def parse(self): map_group, map_id, debug = self.map_group, self.map_id, self.debug address = self.address bank = calculate_bank(self.address) #or use self.bank print "event header address is: " + hex(address) filler1 = ord(rom[address]) filler2 = ord(rom[address+1]) self.fillers = [filler1, filler2] #warps warp_count = ord(rom[address+2]) warp_byte_count = warp_byte_size * warp_count after_warps = address + 3 + warp_byte_count warps = parse_warps(address+3, warp_count, bank=bank, map_group=map_group, map_id=map_id, debug=debug) self.warp_count = warp_count self.warps = warps #triggers (based on xy location) xy_trigger_count = ord(rom[after_warps]) trigger_byte_count = trigger_byte_size * xy_trigger_count xy_triggers = parse_xy_triggers(after_warps+1, xy_trigger_count, bank=bank, map_group=map_group, map_id=map_id, debug=debug) after_triggers = after_warps + 1 + trigger_byte_count self.xy_trigger_count = xy_trigger_count self.xy_triggers = xy_triggers #signposts signpost_count = ord(rom[after_triggers]) signpost_byte_count = signpost_byte_size * signpost_count #signposts = rom_interval(after_triggers+1, signpost_byte_count) signposts = parse_signposts(after_triggers+1, signpost_count, bank=bank, map_group=map_group, map_id=map_id, debug=debug) after_signposts = after_triggers + 1 + signpost_byte_count self.signpost_count = signpost_count self.signposts = signposts #people events people_event_count = ord(rom[after_signposts]) people_event_byte_count = people_event_byte_size * people_event_count #people_events_bytes = rom_interval(after_signposts+1, people_event_byte_count) #people_events = parse_people_event_bytes(people_events_bytes, address=after_signposts+1, map_group=map_group, map_id=map_id) people_events = parse_people_events(after_signposts+1, people_event_count, bank=calculate_bank(after_signposts+2), map_group=map_group, map_id=map_id, debug=debug) self.people_event_count = people_event_count self.people_events = people_events if people_event_count > 0: self.last_address = people_events[-1].last_address else: self.last_address = after_signposts+1 return True def get_dependencies(self, recompute=False, global_dependencies=set()): if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies bases = [] bases += self.people_events bases += self.signposts bases += self.xy_triggers bases += self.warps dependencies = [] for p in bases: dependencies.extend(p.get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) self.dependencies = dependencies return dependencies def to_asm(self): xspacing = "" #was =spacing output = "; filler\n" output += "db %d, %d\n\n" % (self.fillers[0], self.fillers[1]) output += xspacing + "; warps\n" output += xspacing + "db %d"%(self.warp_count) if len(self.warps) > 0: output += "\n" output += "\n".join([xspacing+warp.to_asm() for warp in self.warps]) output += "\n\n" output += xspacing + "; xy triggers\n" output += xspacing + "db %d"%(self.xy_trigger_count) if len(self.xy_triggers) > 0: output += "\n" output += "\n".join([xspacing+xy_trigger.to_asm() for xy_trigger in self.xy_triggers]) output += "\n\n" output += xspacing + "; signposts\n" output += xspacing + "db %d"%(self.signpost_count) if len(self.signposts) > 0: output += "\n" output += "\n".join([xspacing+signpost.to_asm() for signpost in self.signposts]) output += "\n\n" output += xspacing + "; people-events\n" output += xspacing + "db %d"%(self.people_event_count) if len(self.people_events) > 0: output += "\n" for people_event in self.people_events: output += xspacing output += people_event.to_asm() output += "\n" if output[-1] == "\n": output = output[:-1] return output all_map_event_headers = [] def parse_map_event_header_at(address, map_group=None, map_id=None, debug=True, bank=None): """parse crystal map event header byte structure thing""" ev = MapEventHeader(address, map_group=map_group, map_id=map_id, debug=debug, bank=bank) all_map_event_headers.append(ev) return ev def old_parse_map_event_header_at(address, map_group=None, map_id=None, debug=True): """parse crystal map event header byte structure thing""" returnable = {} bank = calculate_bank(address) print "event header address is: " + hex(address) filler1 = ord(rom[address]) filler2 = ord(rom[address+1]) returnable.update({"1": filler1, "2": filler2}) #warps warp_count = ord(rom[address+2]) warp_byte_count = warp_byte_size * warp_count warps = rom_interval(address+3, warp_byte_count) after_warps = address + 3 + warp_byte_count returnable.update({"warp_count": warp_count, "warps": old_parse_warp_bytes(warps)}) #triggers (based on xy location) trigger_count = ord(rom[after_warps]) trigger_byte_count = trigger_byte_size * trigger_count triggers = rom_interval(after_warps+1, trigger_byte_count) after_triggers = after_warps + 1 + trigger_byte_count returnable.update({"xy_trigger_count": trigger_count, "xy_triggers": old_parse_xy_trigger_bytes(triggers, bank=bank, map_group=map_group, map_id=map_id)}) #signposts signpost_count = ord(rom[after_triggers]) signpost_byte_count = signpost_byte_size * signpost_count signposts = rom_interval(after_triggers+1, signpost_byte_count) after_signposts = after_triggers + 1 + signpost_byte_count returnable.update({"signpost_count": signpost_count, "signposts": old_parse_signpost_bytes(signposts, bank=bank, map_group=map_group, map_id=map_id)}) #people events people_event_count = ord(rom[after_signposts]) people_event_byte_count = people_event_byte_size * people_event_count people_events_bytes = rom_interval(after_signposts+1, people_event_byte_count) people_events = old_parse_people_event_bytes(people_events_bytes, address=after_signposts+1, map_group=map_group, map_id=map_id) returnable.update({"people_event_count": people_event_count, "people_events": people_events}) return returnable class MapScriptHeader: """parses a script header This structure allows the game to have e.g. one-time only events on a map or first enter events or permanent changes to the map or permanent script calls. This header a combination of a trigger script section and a callback script section. I don't know if these 'trigger scripts' are the same as the others referenced in the map event header, so this might need to be renamed very soon. The scripts in MapEventHeader are called XYTrigger. trigger scripts: [[Number1 of pointers] Number1 * [2byte pointer to script][00][00]] callback scripts: [[Number2 of pointers] Number2 * [hook number][2byte pointer to script]] hook byte choices: 01 - map data has already been loaded to ram, tileset and sprites still missing map change (3rd step) loading (2nd step) map connection (3rd step) after battle (1st step) 02 - map data, tileset and sprites are all loaded map change (5th step) 03 - neither map data not tilesets nor sprites are loaded map change (2nd step) loading (1st step) map connection (2nd step) 04 - map data and tileset loaded, sprites still missing map change (4th step) loading (3rd step) sprite reload (1st step) map connection (4th step) after battle (2nd step) 05 - neither map data not tilesets nor sprites are loaded map change (1st step) map connection (1st step) When certain events occur, the call backs will be called in this order (same info as above): map change: 05, 03, 01, 04, 02 loading: 03, 01, 04 sprite reload: 04 map connection: 05, 03, 01, 04 note that #2 is not called (unlike "map change") after battle: 01, 04 """ base_label = "MapScriptHeader_" def __init__(self, address, map_group=None, map_id=None, debug=True, bank=None, label=None): print "creating a MapScriptHeader at " + hex(address) + " map_group="+str(map_group)+" map_id="+str(map_id) self.address = address self.map_group = map_group self.map_id = map_id self.debug = debug self.bank = bank self.dependencies = None if not label: label = self.base_label + hex(address) self.label = Label(name=label, address=address, object=self) self.parse() script_parse_table[address : self.last_address] = self def parse(self): address = self.address map_group = self.map_group map_id = self.map_id debug = self.debug #[[Number1 of pointers] Number1 * [2byte pointer to script][00][00]] self.trigger_count = ord(rom[address]) self.triggers = [] ptr_line_size = 4 groups = grouper(rom_interval(address+1, self.trigger_count * ptr_line_size, strings=False), count=ptr_line_size) current_address = address+1 for (index, trigger_bytes) in enumerate(groups): print "parsing a map trigger script at "+hex(current_address)+" map_group="+str(map_group)+" map_id="+str(map_id) script = ScriptPointerLabelParam(address=current_address, map_group=map_group, map_id=map_id, debug=debug) extra_bytes = MultiByteParam(address=current_address+2, map_group=map_group, map_id=map_id, debug=debug) self.triggers.append([script, extra_bytes]) current_address += ptr_line_size current_address = address + (self.trigger_count * ptr_line_size) + 1 #[[Number2 of pointers] Number2 * [hook number][2byte pointer to script]] callback_ptr_line_size = 3 self.callback_count = DecimalParam(address=current_address) self.callback_count = self.callback_count.byte current_address += 1 self.callbacks = [] for index in range(self.callback_count): print "parsing a callback script at "+hex(current_address)+" map_group="+str(map_group)+" map_id="+str(map_id) hook_byte = HexByte(address=current_address) callback = ScriptPointerLabelParam(address=current_address+1, map_group=map_group, map_id=map_id, debug=debug) self.callbacks.append({"hook": hook_byte, "callback": callback}) current_address += 3 #i think? self.last_address = current_address print "done parsing a MapScriptHeader map_group="+str(map_group)+" map_id="+str(map_id) return True def get_dependencies(self, recompute=False, global_dependencies=set()): if self.dependencies != None and not recompute: global_dependencies.update(self.dependencies) return self.dependencies dependencies = [] for p in list(self.triggers): #dependencies.append(p[0]) dependencies.extend(p[0].get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) for callback in self.callbacks: dependencies.append(callback["callback"]) global_dependencies.add(callback["callback"]) dependencies.extend(callback["callback"].get_dependencies(recompute=recompute, global_dependencies=global_dependencies)) self.dependencies = dependencies return dependencies def to_asm(self): output = "" output += "; trigger count\n" output += "db %d\n"%self.trigger_count if len(self.triggers) > 0: output += "\n; triggers\n" output += "\n".join([str("dw "+p[0].to_asm()+", "+p[1].to_asm()) for p in self.triggers]) output += "\n" output += "\n; callback count\n" output += "db %d"%self.callback_count if len(self.callbacks) > 0: output += "\n\n; callbacks\n\n" output += "\n\n".join(["dbw "+str(p["hook"].byte)+", "+p["callback"].to_asm() for p in self.callbacks]) return output all_map_script_headers = [] def parse_map_script_header_at(address, map_group=None, map_id=None, debug=True): evv = MapScriptHeader(address, map_group=map_group, map_id=map_id, debug=debug) all_map_script_headers.append(evv) return evv def old_parse_map_script_header_at(address, map_group=None, map_id=None, debug=True): print "starting to parse the map's script header.." #[[Number1 of pointers] Number1 * [2byte pointer to script][00][00]] ptr_line_size = 4 #[2byte pointer to script][00][00] trigger_ptr_cnt = ord(rom[address]) trigger_pointers = grouper(rom_interval(address+1, trigger_ptr_cnt * ptr_line_size, strings=False), count=ptr_line_size) triggers = {} for index, trigger_pointer in enumerate(trigger_pointers): print "parsing a trigger header..." byte1 = trigger_pointer[0] byte2 = trigger_pointer[1] ptr = byte1 + (byte2 << 8) trigger_address = calculate_pointer(ptr, calculate_bank(address)) trigger_script = parse_script_engine_script_at(trigger_address, map_group=map_group, map_id=map_id) triggers[index] = { "script": trigger_script, "address": trigger_address, "pointer": {"1": byte1, "2": byte2}, } #bump ahead in the byte stream address += trigger_ptr_cnt * ptr_line_size + 1 #[[Number2 of pointers] Number2 * [hook number][2byte pointer to script]] callback_ptr_line_size = 3 callback_ptr_cnt = ord(rom[address]) callback_ptrs = grouper(rom_interval(address+1, callback_ptr_cnt * callback_ptr_line_size, strings=False), count=callback_ptr_line_size) callback_pointers = {} callbacks = {} for index, callback_line in enumerate(callback_ptrs): print "parsing a callback header..." hook_byte = callback_line[0] #1, 2, 3, 4, 5 callback_byte1 = callback_line[1] callback_byte2 = callback_line[2] callback_ptr = callback_byte1 + (callback_byte2 << 8) callback_address = calculate_pointer(callback_ptr, calculate_bank(address)) callback_script = parse_script_engine_script_at(callback_address) callback_pointers[len(callback_pointers.keys())] = [hook_byte, callback_ptr] callbacks[index] = { "script": callback_script, "address": callback_address, "pointer": {"1": callback_byte1, "2": callback_byte2}, } #XXX do these triggers/callbacks call asm or script engine scripts? return { #"trigger_ptr_cnt": trigger_ptr_cnt, "trigger_pointers": trigger_pointers, #"callback_ptr_cnt": callback_ptr_cnt, #"callback_ptr_scripts": callback_ptrs, "callback_pointers": callback_pointers, "trigger_scripts": triggers, "callback_scripts": callbacks, } def old_parse_trainer_header_at(address, map_group=None, map_id=None, debug=True): bank = calculate_bank(address) bytes = rom_interval(address, 12, strings=False) bit_number = bytes[0] + (bytes[1] << 8) trainer_group = bytes[2] trainer_id = bytes[3] text_when_seen_ptr = calculate_pointer_from_bytes_at(address+4, bank=bank) text_when_seen = parse_text_engine_script_at(text_when_seen_ptr, map_group=map_group, map_id=map_id, debug=debug) text_when_trainer_beaten_ptr = calculate_pointer_from_bytes_at(address+6, bank=bank) text_when_trainer_beaten = parse_text_engine_script_at(text_when_trainer_beaten_ptr, map_group=map_group, map_id=map_id, debug=debug) if [ord(rom[address+8]), ord(rom[address+9])] == [0, 0]: script_when_lost_ptr = 0 script_when_lost = None else: print "parsing script-when-lost" script_when_lost_ptr = calculate_pointer_from_bytes_at(address+8, bank=bank) script_when_lost = None silver_avoids = [0xfa53] if script_when_lost_ptr > 0x4000 and not script_when_lost_ptr in silver_avoids: script_when_lost = parse_script_engine_script_at(script_when_lost_ptr, map_group=map_group, map_id=map_id, debug=debug) print "parsing script-talk-again" #or is this a text? script_talk_again_ptr = calculate_pointer_from_bytes_at(address+10, bank=bank) script_talk_again = None if script_talk_again_ptr > 0x4000: script_talk_again = parse_script_engine_script_at(script_talk_again_ptr, map_group=map_group, map_id=map_id, debug=debug) return { "bit_number": bit_number, "trainer_group": trainer_group, "trainer_id": trainer_id, "text_when_seen_ptr": text_when_seen_ptr, "text_when_seen": text_when_seen, "text_when_trainer_beaten_ptr": text_when_trainer_beaten_ptr, "text_when_trainer_beaten": text_when_trainer_beaten, "script_when_lost_ptr": script_when_lost_ptr, "script_when_lost": script_when_lost, "script_talk_again_ptr": script_talk_again_ptr, "script_talk_again": script_talk_again, } def old_parse_people_event_bytes(some_bytes, address=None, map_group=None, map_id=None, debug=True): """parse some number of people-events from the data see PeopleEvent see http://hax.iimarck.us/files/scriptingcodes_eng.htm#Scripthdr For example, map 1.1 (group 1 map 1) has four person-events. 37 05 07 06 00 FF FF 00 00 02 40 FF FF 3B 08 0C 05 01 FF FF 00 00 05 40 FF FF 3A 07 06 06 00 FF FF A0 00 08 40 FF FF 29 05 0B 06 00 FF FF 00 00 0B 40 FF FF max of 14 people per map? """ assert len(some_bytes) % people_event_byte_size == 0, "wrong number of bytes" #address is not actually required for this function to work... bank = None if address: bank = calculate_bank(address) people_events = [] for bytes in grouper(some_bytes, count=people_event_byte_size): pict = int(bytes[0], 16) y = int(bytes[1], 16) #y from top + 4 x = int(bytes[2], 16) #x from left + 4 face = int(bytes[3], 16) #0-4 for regular, 6-9 for static facing move = int(bytes[4], 16) clock_time_byte1 = int(bytes[5], 16) clock_time_byte2 = int(bytes[6], 16) color_function_byte = int(bytes[7], 16) #Color|Function trainer_sight_range = int(bytes[8], 16) lower_bits = color_function_byte & 0xF #lower_bits_high = lower_bits >> 2 #lower_bits_low = lower_bits & 3 higher_bits = color_function_byte >> 4 #higher_bits_high = higher_bits >> 2 #higher_bits_low = higher_bits & 3 is_regular_script = lower_bits == 00 #pointer points to script is_give_item = lower_bits == 01 #pointer points to [Item no.][Amount] is_trainer = lower_bits == 02 #pointer points to trainer header #goldmap called these next two bytes "text_block" and "text_bank"? script_pointer_byte1 = int(bytes[9], 16) script_pointer_byte2 = int(bytes[10], 16) script_pointer = script_pointer_byte1 + (script_pointer_byte2 << 8) #calculate the full address by assuming it's in the current bank #but what if it's not in the same bank? extra_portion = {} if bank: ptr_address = calculate_pointer(script_pointer, bank) if is_regular_script: print "parsing a person-script at x=" + str(x-4) + " y=" + str(y-4) + " address="+hex(ptr_address) script = parse_script_engine_script_at(ptr_address, map_group=map_group, map_id=map_id) extra_portion = { "script_address": ptr_address, "script": script, "event_type": "script", } if is_give_item: print "... not parsing give item event... [item id][quantity]" extra_portion = { "event_type": "give_item", "give_item_data_address": ptr_address, "item_id": ord(rom[ptr_address]), "item_qty": ord(rom[ptr_address+1]), } if is_trainer: print "parsing a trainer (person-event) at x=" + str(x) + " y=" + str(y) parsed_trainer = old_parse_trainer_header_at(ptr_address, map_group=map_group, map_id=map_id) extra_portion = { "event_type": "trainer", "trainer_data_address": ptr_address, "trainer_data": parsed_trainer, } #XXX not sure what's going on here #bit no. of bit table 1 (hidden if set) #note: FFFF for none when_byte = int(bytes[11], 16) hide = int(bytes[12], 16) bit_number_of_bit_table1_byte2 = int(bytes[11], 16) bit_number_of_bit_table1_byte1 = int(bytes[12], 16) bit_number_of_bit_table1 = bit_number_of_bit_table1_byte1 + (bit_number_of_bit_table1_byte2 << 8) people_event = { "pict": pict, "y": y, #y from top + 4 "x": x, #x from left + 4 "face": face, #0-4 for regular, 6-9 for static facing "move": move, "clock_time": {"1": clock_time_byte1, "2": clock_time_byte2}, #clock/time setting byte 1 "color_function_byte": color_function_byte, #Color|Function "trainer_sight_range": trainer_sight_range, #trainer range of sight "script_pointer": {"1": script_pointer_byte1, "2": script_pointer_byte2}, #"text_block": text_block, #script pointer byte 1 #"text_bank": text_bank, #script pointer byte 2 "when_byte": when_byte, #bit no. of bit table 1 (hidden if set) "hide": hide, #note: FFFF for none "is_trainer": is_trainer, "is_regular_script": is_regular_script, "is_give_item": is_give_item, } people_event.update(extra_portion) people_events.append(people_event) return people_events def parse_map_header_by_id(*args, **kwargs): """convenience function to parse a specific map""" map_group, map_id = None, None if "map_group" in kwargs.keys(): map_group = kwargs["map_group"] if "map_id" in kwargs.keys(): map_id = kwargs["map_id"] if (map_group == None and map_id != None) or \ (map_group != None and map_id == None): raise Exception, "map_group and map_id must both be provided" elif map_group == None and map_id == None and len(args) == 0: raise Exception, "must be given an argument" elif len(args) == 1 and type(args[0]) == str: map_group = int(args[0].split(".")[0]) map_id = int(args[0].split(".")[1]) else: raise Exception, "dunno what to do with input" offset = map_names[map_group]["offset"] map_header_offset = offset + ((map_id - 1) * map_header_byte_size) return parse_map_header_at(map_header_offset, map_group=map_group, map_id=map_id) def parse_all_map_headers(debug=True): """calls parse_map_header_at for each map in each map group""" global map_names if not map_names[1].has_key("offset"): raise Exception, "dunno what to do - map_names should have groups with pre-calculated offsets by now" for group_id, group_data in map_names.items(): offset = group_data["offset"] #we only care about the maps #del group_data["offset"] for map_id, map_data in group_data.items(): if map_id == "offset": continue #skip the "offset" address for this map group if debug: print "map_group is: " + str(group_id) + " map_id is: " + str(map_id) map_header_offset = offset + ((map_id - 1) * map_header_byte_size) map_names[group_id][map_id]["header_offset"] = map_header_offset new_parsed_map = parse_map_header_at(map_header_offset, map_group=group_id, map_id=map_id, debug=debug) map_names[group_id][map_id]["header_new"] = new_parsed_map old_parsed_map = old_parse_map_header_at(map_header_offset, map_group=group_id, map_id=map_id, debug=debug) map_names[group_id][map_id]["header_old"] = old_parsed_map #map names with no labels will be generated at the end of the structure map_names = { 1: { 0x1: {"name": "Olivine Pokémon Center 1F", "label": "OlivinePokeCenter1F"}, 0x2: {"name": "Olivine Gym"}, 0x3: {"name": "Olivine Voltorb House"}, 0x4: {"name": "Olivine House Beta"}, 0x5: {"name": "Olivine Punishment Speech House"}, 0x6: {"name": "Olivine Good Rod House"}, 0x7: {"name": "Olivine Cafe"}, 0x8: {"name": "Olivine Mart"}, 0x9: {"name": "Route 38 Ecruteak Gate"}, 0xA: {"name": "Route 39 Barn"}, 0xB: {"name": "Route 39 Farmhouse"}, 0xC: {"name": "Route 38"}, 0xD: {"name": "Route 39"}, 0xE: {"name": "Olivine City"}, }, 2: { 0x1: {"name": "Mahogany Red Gyarados Speech House"}, 0x2: {"name": "Mahogany Gym"}, 0x3: {"name": "Mahogany Pokémon Center 1F", "label": "MahoganyPokeCenter1F"}, 0x4: {"name": "Route 42 Ecruteak Gate"}, 0x5: {"name": "Route 42"}, 0x6: {"name": "Route 44"}, 0x7: {"name": "Mahogany Town"}, }, 3: { 0x1: {"name": "Sprout Tower 1F"}, 0x2: {"name": "Sprout Tower 2F"}, 0x3: {"name": "Sprout Tower 3F"}, 0x4: {"name": "Tin Tower 1F"}, 0x5: {"name": "Tin Tower 2F"}, 0x6: {"name": "Tin Tower 3F"}, 0x7: {"name": "Tin Tower 4F"}, 0x8: {"name": "Tin Tower 5F"}, 0x9: {"name": "Tin Tower 6F"}, 0xA: {"name": "Tin Tower 7F"}, 0xB: {"name": "Tin Tower 8F"}, 0xC: {"name": "Tin Tower 9F"}, 0xD: {"name": "Burned Tower 1F"}, 0xE: {"name": "Burned Tower B1F"}, 0xF: {"name": "National Park"}, 0x10: {"name": "National Park Bug Contest"}, 0x11: {"name": "Radio Tower 1F"}, 0x12: {"name": "Radio Tower 2F"}, 0x13: {"name": "Radio Tower 3F"}, 0x14: {"name": "Radio Tower 4F"}, 0x15: {"name": "Radio Tower 5F"}, 0x16: {"name": "Ruins of Alph Outside"}, 0x17: {"name": "Ruins of Alph Ho-oh Chamber"}, 0x18: {"name": "Ruins of Alph Kabuto Chamber"}, 0x19: {"name": "Ruins of Alph Omanyte Chamber"}, 0x1A: {"name": "Ruins of Alph Aerodactyl Chamber"}, 0x1B: {"name": "Ruins of Alph Inner Chamber"}, 0x1C: {"name": "Ruins of Alph Research Center"}, 0x1D: {"name": "Ruins of Alph Ho-oh Item Room"}, 0x1E: {"name": "Ruins of Alph Kabuto Item Room"}, 0x1F: {"name": "Ruins of Alph Omanyte Item Room"}, 0x20: {"name": "Ruins of Alph Aerodactyl Item Room"}, 0x21: {"name": "Ruins of Alph Ho-Oh Word Room"}, 0x22: {"name": "Ruins of Alph Kabuto Word Room"}, 0x23: {"name": "Ruins of Alph Omanyte Word Room"}, 0x24: {"name": "Ruins of Alph Aerodactyl Word Room"}, 0x25: {"name": "Union Cave 1F"}, 0x26: {"name": "Union Cave B1F"}, 0x27: {"name": "Union Cave B2F"}, 0x28: {"name": "Slowpoke Well B1F"}, 0x29: {"name": "Slowpoke Well B2F"}, 0x2A: {"name": "Olivine Lighthouse 1F"}, 0x2B: {"name": "Olivine Lighthouse 2F"}, 0x2C: {"name": "Olivine Lighthouse 3F"}, 0x2D: {"name": "Olivine Lighthouse 4F"}, 0x2E: {"name": "Olivine Lighthouse 5F"}, 0x2F: {"name": "Olivine Lighthouse 6F"}, 0x30: {"name": "Mahogany Mart 1F"}, 0x31: {"name": "Team Rocket Base B1F"}, 0x32: {"name": "Team Rocket Base B2F"}, 0x33: {"name": "Team Rocket Base B3F"}, 0x34: {"name": "Ilex Forest"}, 0x35: {"name": "Warehouse Entrance"}, 0x36: {"name": "Underground Path Switch Room Entrances"}, 0x37: {"name": "Goldenrod Dept Store B1F"}, 0x38: {"name": "Underground Warehouse"}, 0x39: {"name": "Mount Mortar 1F Outside"}, 0x3A: {"name": "Mount Mortar 1F Inside"}, 0x3B: {"name": "Mount Mortar 2F Inside"}, 0x3C: {"name": "Mount Mortar B1F"}, 0x3D: {"name": "Ice Path 1F"}, 0x3E: {"name": "Ice Path B1F"}, 0x3F: {"name": "Ice Path B2F Mahogany Side"}, 0x40: {"name": "Ice Path B2F Blackthorn Side"}, 0x41: {"name": "Ice Path B3F"}, 0x42: {"name": "Whirl Island NW"}, 0x43: {"name": "Whirl Island NE"}, 0x44: {"name": "Whirl Island SW"}, 0x45: {"name": "Whirl Island Cave"}, 0x46: {"name": "Whirl Island SE"}, 0x47: {"name": "Whirl Island B1F"}, 0x48: {"name": "Whirl Island B2F"}, 0x49: {"name": "Whirl Island Lugia Chamber"}, 0x4A: {"name": "Silver Cave Room 1"}, 0x4B: {"name": "Silver Cave Room 2"}, 0x4C: {"name": "Silver Cave Room 3"}, 0x4D: {"name": "Silver Cave Item Rooms"}, 0x4E: {"name": "Dark Cave Violet Entrance"}, 0x4F: {"name": "Dark Cave Blackthorn Entrance"}, 0x50: {"name": "Dragon's Den 1F"}, 0x51: {"name": "Dragon's Den B1F"}, 0x52: {"name": "Dragon Shrine"}, 0x53: {"name": "Tohjo Falls"}, 0x54: {"name": "Diglett's Cave"}, 0x55: {"name": "Mount Moon"}, 0x56: {"name": "Underground"}, 0x57: {"name": "Rock Tunnel 1F"}, 0x58: {"name": "Rock Tunnel B1F"}, 0x59: {"name": "Safari Zone Fuchsia Gate Beta"}, 0x5A: {"name": "Safari Zone Beta"}, 0x5B: {"name": "Victory Road"}, }, 4: { 0x1: {"name": "Ecruteak House"}, #passage to Tin Tower 0x2: {"name": "Wise Trio's Room"}, 0x3: {"name": "Ecruteak Pokémon Center 1F", "label": "EcruteakPokeCenter1F"}, 0x4: {"name": "Ecruteak Lugia Speech House"}, 0x5: {"name": "Dance Theatre"}, 0x6: {"name": "Ecruteak Mart"}, 0x7: {"name": "Ecruteak Gym"}, 0x8: {"name": "Ecruteak Itemfinder House"}, 0x9: {"name": "Ecruteak City"}, }, 5: { 0x1: {"name": "Blackthorn Gym 1F"}, 0x2: {"name": "Blackthorn Gym 2F"}, 0x3: {"name": "Blackthorn Dragon Speech House"}, 0x4: {"name": "Blackthorn Dodrio Trade House"}, 0x5: {"name": "Blackthorn Mart"}, 0x6: {"name": "Blackthorn Pokémon Center 1F", "label": "BlackthornPokeCenter1F"}, 0x7: {"name": "Move Deleter's House"}, 0x8: {"name": "Route 45"}, 0x9: {"name": "Route 46"}, 0xA: {"name": "Blackthorn City"}, }, 6: { 0x1: {"name": "Cinnabar Pokémon Center 1F", "label": "CinnabarPokeCenter1F"}, 0x2: {"name": "Cinnabar Pokémon Center 2F Beta", "label": "CinnabarPokeCenter2FBeta"}, 0x3: {"name": "Route 19 - Fuchsia Gate"}, 0x4: {"name": "Seafoam Gym"}, 0x5: {"name": "Route 19"}, 0x6: {"name": "Route 20"}, 0x7: {"name": "Route 21"}, 0x8: {"name": "Cinnabar Island"}, }, 7: { 0x1: {"name": "Cerulean Gym Badge Speech House"}, 0x2: {"name": "Cerulean Police Station"}, 0x3: {"name": "Cerulean Trade Speech House"}, 0x4: {"name": "Cerulean Pokémon Center 1F", "label": "CeruleanPokeCenter1F"}, 0x5: {"name": "Cerulean Pokémon Center 2F Beta", "label": "CeruleanPokeCenter2FBeta"}, 0x6: {"name": "Cerulean Gym"}, 0x7: {"name": "Cerulean Mart"}, 0x8: {"name": "Route 10 Pokémon Center 1F", "label": "Route10PokeCenter1F"}, 0x9: {"name": "Route 10 Pokémon Center 2F Beta", "label": "Route10PokeCenter2FBeta"}, 0xA: {"name": "Power Plant"}, 0xB: {"name": "Bill's House"}, 0xC: {"name": "Route 4"}, 0xD: {"name": "Route 9"}, 0xE: {"name": "Route 10"}, 0xF: {"name": "Route 24"}, 0x10: {"name": "Route 25"}, 0x11: {"name": "Cerulean City"}, }, 8: { 0x1: {"name": "Azalea Pokémon Center 1F", "label": "AzaleaPokeCenter1F"}, 0x2: {"name": "Charcoal Kiln"}, 0x3: {"name": "Azalea Mart"}, 0x4: {"name": "Kurt's House"}, 0x5: {"name": "Azalea Gym"}, 0x6: {"name": "Route 33"}, 0x7: {"name": "Azalea Town"}, }, 9: { 0x1: {"name": "Lake of Rage Hidden Power House"}, 0x2: {"name": "Lake of Rage Magikarp House"}, 0x3: {"name": "Route 43 Mahogany Gate"}, 0x4: {"name": "Route 43 Gate"}, 0x5: {"name": "Route 43"}, 0x6: {"name": "Lake of Rage"}, }, 10: { 0x1: {"name": "Route 32"}, 0x2: {"name": "Route 35"}, 0x3: {"name": "Route 36"}, 0x4: {"name": "Route 37"}, 0x5: {"name": "Violet City"}, 0x6: {"name": "Violet Mart"}, 0x7: {"name": "Violet Gym"}, 0x8: {"name": "Earl's Pokémon Academy", "label": "EarlsPokemonAcademy"}, 0x9: {"name": "Violet Nickname Speech House"}, 0xA: {"name": "Violet Pokémon Center 1F", "label": "VioletPokeCenter1F"}, 0xB: {"name": "Violet Onix Trade House"}, 0xC: {"name": "Route 32 Ruins of Alph Gate"}, 0xD: {"name": "Route 32 Pokémon Center 1F", "label": "Route32PokeCenter1F"}, 0xE: {"name": "Route 35 Goldenrod gate"}, 0xF: {"name": "Route 35 National Park gate"}, 0x10: {"name": "Route 36 Ruins of Alph gate"}, 0x11: {"name": "Route 36 National Park gate"}, }, 11: { 0x1: {"name": "Route 34"}, 0x2: {"name": "Goldenrod City"}, 0x3: {"name": "Goldenrod Gym"}, 0x4: {"name": "Goldenrod Bike Shop"}, 0x5: {"name": "Goldenrod Happiness Rater"}, 0x6: {"name": "Goldenrod Bill's House"}, 0x7: {"name": "Goldenrod Magnet Train Station"}, 0x8: {"name": "Goldenrod Flower Shop"}, 0x9: {"name": "Goldenrod PP Speech House"}, 0xA: {"name": "Goldenrod Name Rater's House"}, 0xB: {"name": "Goldenrod Dept Store 1F"}, 0xC: {"name": "Goldenrod Dept Store 2F"}, 0xD: {"name": "Goldenrod Dept Store 3F"}, 0xE: {"name": "Goldenrod Dept Store 4F"}, 0xF: {"name": "Goldenrod Dept Store 5F"}, 0x10: {"name": "Goldenrod Dept Store 6F"}, 0x11: {"name": "Goldenrod Dept Store Elevator"}, 0x12: {"name": "Goldenrod Dept Store Roof"}, 0x13: {"name": "Goldenrod Game Corner"}, 0x14: {"name": "Goldenrod Pokémon Center 1F", "label": "GoldenrodPokeCenter1F"}, 0x15: {"name": "Goldenrod PokéCom Center 2F Mobile", "label": "GoldenrodPokeComCenter2FMobile"}, 0x16: {"name": "Ilex Forest Azalea Gate"}, 0x17: {"name": "Route 34 Ilex Forest Gate"}, 0x18: {"name": "Day Care"}, }, 12: { 0x1: {"name": "Route 6"}, 0x2: {"name": "Route 11"}, 0x3: {"name": "Vermilion City"}, 0x4: {"name": "Vermilion House Fishing Speech House"}, 0x5: {"name": "Vermilion Pokémon Center 1F", "label": "VermilionPokeCenter1F"}, 0x6: {"name": "Vermilion Pokémon Center 2F Beta", "label": "VermilionPokeCenter2FBeta"}, 0x7: {"name": "Pokémon Fan Club"}, 0x8: {"name": "Vermilion Magnet Train Speech House"}, 0x9: {"name": "Vermilion Mart"}, 0xA: {"name": "Vermilion House Diglett's Cave Speech House"}, 0xB: {"name": "Vermilion Gym"}, 0xC: {"name": "Route 6 Saffron Gate"}, 0xD: {"name": "Route 6 Underground Entrance"}, }, 13: { 0x1: {"name": "Route 1"}, 0x2: {"name": "Pallet Town"}, 0x3: {"name": "Red's House 1F"}, 0x4: {"name": "Red's House 2F"}, 0x5: {"name": "Blue's House"}, 0x6: {"name": "Oak's Lab"}, }, 14: { 0x1: {"name": "Route 3"}, 0x2: {"name": "Pewter City"}, 0x3: {"name": "Pewter Nidoran Speech House"}, 0x4: {"name": "Pewter Gym"}, 0x5: {"name": "Pewter Mart"}, 0x6: {"name": "Pewter Pokémon Center 1F", "label": "PewterPokeCenter1F"}, 0x7: {"name": "Pewter Pokémon Center 2F Beta", "label": "PewterPokeCEnter2FBeta"}, 0x8: {"name": "Pewter Snooze Speech House"}, }, 15: { 0x1: {"name": "Olivine Port"}, 0x2: {"name": "Vermilion Port"}, 0x3: {"name": "Fast Ship 1F"}, 0x4: {"name": "Fast Ship Cabins NNW, NNE, NE", "label": "FastShipCabins_NNW_NNE_NE"}, 0x5: {"name": "Fast Ship Cabins SW, SSW, NW", "label": "FastShipCabins_SW_SSW_NW"}, 0x6: {"name": "Fast Ship Cabins SE, SSE, Captain's Cabin", "label": "FastShipCabins_SE_SSE_CaptainsCabin"}, 0x7: {"name": "Fast Ship B1F"}, 0x8: {"name": "Olivine Port Passage"}, 0x9: {"name": "Vermilion Port Passage"}, 0xA: {"name": "Mount Moon Square"}, 0xB: {"name": "Mount Moon Gift Shop"}, 0xC: {"name": "Tin Tower Roof"}, }, 16: { 0x1: {"name": "Route 23"}, 0x2: {"name": "Indigo Plateau Pokémon Center 1F", "label": "IndigoPlateauPokeCenter1F"}, 0x3: {"name": "Will's Room"}, 0x4: {"name": "Koga's Room"}, 0x5: {"name": "Bruno's Room"}, 0x6: {"name": "Karen's Room"}, 0x7: {"name": "Lance's Room"}, 0x8: {"name": "Hall of Fame", "label": "HallOfFame"}, }, 17: { 0x1: {"name": "Route 13"}, 0x2: {"name": "Route 14"}, 0x3: {"name": "Route 15"}, 0x4: {"name": "Route 18"}, 0x5: {"name": "Fuchsia City"}, 0x6: {"name": "Fuchsia Mart"}, 0x7: {"name": "Safari Zone Main Office"}, 0x8: {"name": "Fuchsia Gym"}, 0x9: {"name": "Fuchsia Bill Speech House"}, 0xA: {"name": "Fuchsia Pokémon Center 1F", "label": "FuchsiaPokeCenter1F"}, 0xB: {"name": "Fuchsia Pokémon Center 2F Beta", "label": "FuchsiaPokeCenter2FBeta"}, 0xC: {"name": "Safari Zone Warden's Home"}, 0xD: {"name": "Route 15 Fuchsia Gate"}, }, 18: { 0x1: {"name": "Route 8"}, 0x2: {"name": "Route 12"}, 0x3: {"name": "Route 10"}, 0x4: {"name": "Lavender Town"}, 0x5: {"name": "Lavender Pokémon Center 1F", "label": "LavenderPokeCenter1F"}, 0x6: {"name": "Lavender Pokémon Center 2F Beta", "label": "LavenderPokeCenter2FBeta"}, 0x7: {"name": "Mr. Fuji's House"}, 0x8: {"name": "Lavender Town Speech House"}, 0x9: {"name": "Lavender Name Rater"}, 0xA: {"name": "Lavender Mart"}, 0xB: {"name": "Soul House"}, 0xC: {"name": "Lav Radio Tower 1F"}, 0xD: {"name": "Route 8 Saffron Gate"}, 0xE: {"name": "Route 12 Super Rod House"}, }, 19: { 0x1: {"name": "Route 28"}, 0x2: {"name": "Silver Cave Outside"}, 0x3: {"name": "Silver Cave Pokémon Center 1F", "label": "SilverCavePokeCenter1F"}, 0x4: {"name": "Route 28 Famous Speech House"}, }, 20: { 0x1: {"name": "Pokémon Center 2F", "label": "PokeCenter2F"}, 0x2: {"name": "Trade Center"}, 0x3: {"name": "Colosseum"}, 0x4: {"name": "Time Capsule"}, 0x5: {"name": "Mobile Trade Room Mobile"}, 0x6: {"name": "Mobile Battle Room"}, }, 21: { 0x1: {"name": "Route 7"}, 0x2: {"name": "Route 16"}, 0x3: {"name": "Route 17"}, 0x4: {"name": "Celadon City"}, 0x5: {"name": "Celadon Dept Store 1F"}, 0x6: {"name": "Celadon Dept Store 2F"}, 0x7: {"name": "Celadon Dept Store 3F"}, 0x8: {"name": "Celadon Dept Store 4F"}, 0x9: {"name": "Celadon Dept Store 5F"}, 0xA: {"name": "Celadon Dept Store 6F"}, 0xB: {"name": "Celadon Dept Store Elevator"}, 0xC: {"name": "Celadon Mansion 1F"}, 0xD: {"name": "Celadon Mansion 2F"}, 0xE: {"name": "Celadon Mansion 3F"}, 0xF: {"name": "Celadon Mansion Roof"}, 0x10: {"name": "Celadon Mansion Roof House"}, 0x11: {"name": "Celadon Pokémon Center 1F", "label": "CeladonPokeCenter1F"}, 0x12: {"name": "Celadon Pokémon Center 2F Beta", "label": "CeladonPokeCenter2FBeta"}, 0x13: {"name": "Celadon Game Corner"}, 0x14: {"name": "Celadon Game Corner Prize Room"}, 0x15: {"name": "Celadon Gym"}, 0x16: {"name": "Celadon Cafe"}, 0x17: {"name": "Route 16 Fuchsia Speech House"}, 0x18: {"name": "Route 16 Gate"}, 0x19: {"name": "Route 7 Saffron Gate"}, 0x1A: {"name": "Route 17 18 Gate"}, }, 22: { 0x1: {"name": "Route 40"}, 0x2: {"name": "Route 41"}, 0x3: {"name": "Cianwood City"}, 0x4: {"name": "Mania's House"}, 0x5: {"name": "Cianwood Gym"}, 0x6: {"name": "Cianwood Pokémon Center 1F", "label": "CianwoodPokeCenter1F"}, 0x7: {"name": "Cianwood Pharmacy"}, 0x8: {"name": "Cianwood City Photo Studio"}, 0x9: {"name": "Cianwood Lugia Speech House"}, 0xA: {"name": "Poke Seer's House"}, 0xB: {"name": "Battle Tower 1F"}, 0xC: {"name": "Battle Tower Battle Room"}, 0xD: {"name": "Battle Tower Elevator"}, 0xE: {"name": "Battle Tower Hallway"}, 0xF: {"name": "Route 40 Battle Tower Gate"}, 0x10: {"name": "Battle Tower Outside"}, }, 23: { 0x1: {"name": "Route 2"}, 0x2: {"name": "Route 22"}, 0x3: {"name": "Viridian City"}, 0x4: {"name": "Viridian Gym"}, 0x5: {"name": "Viridian Nickname Speech House"}, 0x6: {"name": "Trainer House 1F"}, 0x7: {"name": "Trainer House B1F"}, 0x8: {"name": "Viridian Mart"}, 0x9: {"name": "Viridian Pokémon Center 1F", "label": "ViridianPokeCenter1F"}, 0xA: {"name": "Viridian Pokémon Center 2F Beta", "label": "ViridianPokeCenter2FBeta"}, 0xB: {"name": "Route 2 Nugget Speech House"}, 0xC: {"name": "Route 2 Gate"}, 0xD: {"name": "Victory Road Gate"}, }, 24: { 0x1: {"name": "Route 26"}, 0x2: {"name": "Route 27"}, 0x3: {"name": "Route 29"}, 0x4: {"name": "New Bark Town"}, 0x5: {"name": "Elm's Lab"}, 0x6: {"name": "Kris's House 1F"}, 0x7: {"name": "Kris's House 2F"}, 0x8: {"name": "Kris's Neighbor's House"}, 0x9: {"name": "Elm's House"}, 0xA: {"name": "Route 26 Heal Speech House"}, 0xB: {"name": "Route 26 Day of Week Siblings House"}, 0xC: {"name": "Route 27 Sandstorm House"}, 0xD: {"name": "Route 29 46 Gate"}, }, 25: { 0x1: {"name": "Route 5"}, 0x2: {"name": "Saffron City"}, 0x3: {"name": "Fighting Dojo"}, 0x4: {"name": "Saffron Gym"}, 0x5: {"name": "Saffron Mart"}, 0x6: {"name": "Saffron Pokémon Center 1F", "label": "SaffronPokeCenter1F"}, 0x7: {"name": "Saffron Pokémon Center 2F Beta", "label": "SaffronPokeCenter2FBeta"}, 0x8: {"name": "Mr. Psychic's House"}, 0x9: {"name": "Saffron Train Station"}, 0xA: {"name": "Silph Co. 1F"}, 0xB: {"name": "Copycat's House 1F"}, 0xC: {"name": "Copycat's House 2F"}, 0xD: {"name": "Route 5 Underground Entrance"}, 0xE: {"name": "Route 5 Saffron City Gate"}, 0xF: {"name": "Route 5 Cleanse Tag Speech House"}, }, 26: { 0x1: {"name": "Route 30"}, 0x2: {"name": "Route 31"}, 0x3: {"name": "Cherrygrove City"}, 0x4: {"name": "Cherrygrove Mart"}, 0x5: {"name": "Cherrygrove Pokémon Center 1F", "label": "CherrygrovePokeCenter1F"}, 0x6: {"name": "Cherrygrove Gym Speech House"}, 0x7: {"name": "Guide Gent's House"}, 0x8: {"name": "Cherrygrove Evolution Speech House"}, 0x9: {"name": "Route 30 Berry Speech House"}, 0xA: {"name": "Mr. Pokémon's House"}, 0xB: {"name": "Route 31 Violet Gate"}, }, } #generate labels for each map name for map_group_id in map_names.keys(): map_group = map_names[map_group_id] for map_id in map_group.keys(): #skip if we maybe already have the 'offset' label set in this map group if map_id == "offset": continue #skip if we provided a pre-set value for the map's label if map_group[map_id].has_key("label"): continue #convience alias map_data = map_group[map_id] #clean up the map name to be an asm label cleaned_name = map_name_cleaner(map_data["name"]) #set the value in the original dictionary map_names[map_group_id][map_id]["label"] = cleaned_name #generate map constants (like 1=PALLET_TOWN) generate_map_constant_labels() #### asm utilities #### #these are pulled in from pokered/extras/analyze_incbins.py #store each line of source code here asm = None #store each incbin line separately incbin_lines = [] #storage for processed incbin lines processed_incbins = {} def to_asm(some_object): """shows an object's asm with a label and an ending comment showing the next byte address""" if isinstance(some_object, int): some_object = script_parse_table[some_object] #add one to the last_address to show where the next byte is in the file last_address = some_object.last_address #create a line like "label: ; 0x10101" asm = some_object.label.name + ": ; " + hex(some_object.address) + "\n" #now add the inner/actual asm #asm += spacing + some_object.to_asm().replace("\n", "\n"+spacing).replace("\n"+spacing+"\n"+spacing, "\n\n"+spacing) asmr = some_object.to_asm() asmr = asmr.replace("\n", "\n"+spacing) asmr = asmr.replace("\n"+spacing+"\n", "\n\n"+spacing) asmr = asmr.replace("\n\n"+spacing+spacing, "\n\n"+spacing) asm += spacing + asmr #show the address of the next byte below this asm += "\n; " + hex(last_address) return asm def flattener(x): "flattens a list of sublists into just one list (generator)" try: it = iter(x) except TypeError: yield x else: for i in it: for j in flattener(i): yield j def flatten(x): "flattens a list of sublists into just one list" return list(flattener(x)) def get_dependencies_for(some_object, recompute=False, global_dependencies=set()): """ calculates which labels need to be satisfied for an object to be inserted into the asm and compile successfully. You could also choose to not insert labels into the asm, but then you're losing out on the main value of having asm in the first place. """ try: if isinstance(some_object, int): some_object = script_parse_table[some_object] if some_object.dependencies != None and not recompute: global_dependencies.update(some_object.dependencies) else: some_object.get_dependencies(recompute=recompute, global_dependencies=global_dependencies) return global_dependencies except RuntimeError, e: #1552, 1291, 2075, 1552, 1291... print "some_object is: " + str(some_object) print "class type: " + str(some_object.__class__) print "label name: " + str(some_object.label.name) print "address: " + str(some_object.address) print "asm is: \n\n" + to_asm(some_object) raise e def isolate_incbins(): "find each incbin line" global incbin_lines, asm incbin_lines = [] for line in asm: if line == "": continue if line.count(" ") == len(line): continue #clean up whitespace at beginning of line while line[0] == " ": line = line[1:] if line[0:6] == "INCBIN" and "baserom.gbc" in line: incbin_lines.append(line) return incbin_lines def process_incbins(): "parse incbin lines into memory" global asm, incbin_lines, processed_incbins #load asm if it isn't ready yet if asm == [] or asm == None: load_asm() #get a list of incbins if that hasn't happened yet if incbin_lines == [] or incbin_lines == None: isolate_incbins() #reset the global that this function creates processed_incbins = {} #for each incbin.. for incbin in incbin_lines: #reset this entry processed_incbin = {} #get the line number from the global asm line list line_number = asm.index(incbin) #forget about all the leading characters partial_start = incbin[21:] start = partial_start.split(",")[0].replace("$", "0x") start = eval(start) start_hex = hex(start).replace("0x", "$") partial_interval = incbin[21:].split(",")[1] partial_interval = partial_interval.replace(";", "#") partial_interval = partial_interval.replace("$", "0x").replace("0xx", "0x") interval = eval(partial_interval) interval_hex = hex(interval).replace("0x", "$").replace("x", "") end = start + interval end_hex = hex(end).replace("0x", "$") processed_incbin = {"line_number": line_number, "line": incbin, "start": start, "interval": interval, "end": end, } #don't add this incbin if the interval is 0 if interval != 0: processed_incbins[line_number] = processed_incbin return processed_incbins def reset_incbins(): "reset asm before inserting another diff" global asm, incbin_lines, processed_incbins asm = None incbin_lines = [] processed_incbins = {} load_asm() isolate_incbins() process_incbins() def find_incbin_to_replace_for(address, debug=False, rom_file="../baserom.gbc"): """returns a line number for which incbin to edit if you were to insert bytes into main.asm""" if type(address) == str: address = int(address, 16) if not (0 <= address <= os.lstat(rom_file).st_size): raise IndexError, "address is out of bounds" for incbin_key in processed_incbins.keys(): incbin = processed_incbins[incbin_key] start = incbin["start"] end = incbin["end"] if debug: print "start is: " + str(start) print "end is: " + str(end) print "address is: " + str(type(address)) print "checking.... " + hex(start) + " <= " + hex(address) + " <= " + hex(end) if start <= address <= end: return incbin_key return None def split_incbin_line_into_three(line, start_address, byte_count, rom_file="../baserom.gbc"): """ splits an incbin line into three pieces. you can replace the middle one with the new content of length bytecount start_address: where you want to start inserting bytes byte_count: how many bytes you will be inserting """ if type(start_address) == str: start_address = int(start_address, 16) if not (0 <= start_address <= os.lstat(rom_file).st_size): raise IndexError, "start_address is out of bounds" if len(processed_incbins) == 0: raise Exception, "processed_incbins must be populated" original_incbin = processed_incbins[line] start = original_incbin["start"] end = original_incbin["end"] #start, end1, end2 (to be printed as start, end1 - end2) if start_address - start > 0: first = (start, start_address, start) else: first = (None) #skip this one because we're not including anything #this is the one you will replace with whatever content second = (start_address, byte_count) third = (start_address + byte_count, end - (start_address + byte_count)) output = "" if first: output += "INCBIN \"baserom.gbc\",$" + hex(first[0])[2:] + ",$" + hex(first[1])[2:] + " - $" + hex(first[2])[2:] + "\n" output += "INCBIN \"baserom.gbc\",$" + hex(second[0])[2:] + "," + str(byte_count) + "\n" output += "INCBIN \"baserom.gbc\",$" + hex(third[0])[2:] + ",$" + hex(third[1])[2:] #no newline return output def generate_diff_insert(line_number, newline, debug=False): """generates a diff between the old main.asm and the new main.asm note: requires python2.7 i think? b/c of subprocess.check_output""" global asm original = "\n".join(line for line in asm) newfile = deepcopy(asm) newfile[line_number] = newline #possibly inserting multiple lines newfile = "\n".join(line for line in newfile) #make sure there's a newline at the end of the file if newfile[-1] != "\n": newfile += "\n" original_filename = "ejroqjfoad.temp" newfile_filename = "fjiqefo.temp" original_fh = open(original_filename, "w") original_fh.write(original) original_fh.close() newfile_fh = open(newfile_filename, "w") newfile_fh.write(newfile) newfile_fh.close() try: from subprocess import CalledProcessError except ImportError: CalledProcessError = None try: diffcontent = subprocess.check_output("diff -u ../main.asm " + newfile_filename, shell=True) except (AttributeError, CalledProcessError): p = subprocess.Popen(["diff", "-u", "../main.asm", newfile_filename], stdout=subprocess.PIPE, stderr=subprocess.PIPE) out, err = p.communicate() diffcontent = out os.system("rm " + original_filename) os.system("rm " + newfile_filename) if debug: print diffcontent return diffcontent def apply_diff(diff, try_fixing=True, do_compile=True): print "... Applying diff." #write the diff to a file fh = open("temp.patch", "w") fh.write(diff) fh.close() #apply the patch os.system("cp ../main.asm ../main1.asm") os.system("patch ../main.asm temp.patch") #remove the patch os.system("rm temp.patch") #confirm it's working if do_compile: try: subprocess.check_call("cd ../; make clean; make", shell=True) return True except Exception, exc: if try_fixing: os.system("mv ../main1.asm ../main.asm") return False class AsmLine: #TODO: parse label lines def __init__(self, line, bank=None): self.line = line self.bank = bank def to_asm(self): return self.line class Incbin: def __init__(self, line, bank=None, debug=False): self.line = line self.bank = bank self.replace_me = False self.debug = debug self.parse() def parse(self): incbin = self.line partial_start = incbin[21:] start = partial_start.split(",")[0].replace("$", "0x") if self.debug: print "Incbin.parse -- line is: " + self.line print "Incbin.parse -- partial_start is: " + partial_start print "Incbin.parse -- start is: " + start try: start = eval(start) except Exception, e: raise Exception, "problem with evaluating interval range" start_hex = hex(start).replace("0x", "$") partial_interval = incbin[21:].split(",")[1] partial_interval = partial_interval.replace(";", "#") partial_interval = partial_interval.replace("$", "0x").replace("0xx", "0x") interval = eval(partial_interval) interval_hex = hex(interval).replace("0x", "$").replace("x", "") end = start + interval end_hex = hex(end).replace("0x", "$") self.address = start self.start_address = start self.end_address = end self.last_address = end self.interval = interval def to_asm(self): if self.interval > 0: return self.line else: return "" def split(self, start_address, byte_count): """splits this incbin into three separate incbins""" if start_address < self.start_address or start_address > self.end_address: raise Exception, "this incbin doesn't handle this address" incbins = [] if self.debug: print "splitting an incbin ("+self.line+") into three at "+hex(start_address)+" for "+str(byte_count)+" bytes" #start, end1, end2 (to be printed as start, end1 - end2) if (start_address - self.start_address) > 0: first = (self.start_address, start_address, self.start_address) incbins.append(Incbin("INCBIN \"baserom.gbc\",$%.2x,$%.2x - $%.2x" % (first[0], first[1], first[2]))) if self.debug: print " " + incbins[0].line else: #skip this one because we're not including anything first = None #this is the one you will replace with whatever content second = (start_address, byte_count) incbins.append(Incbin("INCBIN \"baserom.gbc\",$%.2x,$%.2x" % (start_address, byte_count))) incbins[-1].replace_me = True if self.debug: print " " + incbins[-1].line if (self.last_address - (start_address + byte_count)) > 0: third = (start_address + byte_count, self.last_address - (start_address + byte_count)) incbins.append(Incbin("INCBIN \"baserom.gbc\",$%.2x,$%.2x" % (third[0], third[1]))) if self.debug: print " " + incbins[-1].line return incbins class AsmSection: def __init__(self, line): self.bank_id = None self.line = line self.parse() def parse(self): line = self.line bank_id = int(line.split("\"")[1].split("bank")[1], 16) self.bank_id = bank_id start_address = bank_id * 0x4000 end_address = (bank_id * 0x4000) + 0x4000 - 1 self.address = self.start_address = start_address self.last_address = None self.end_address = None #this entity doesn't actually take up this space.. #although it could be argued that lines should exist under this object #self.address = self.start_address = start_address #self.last_address = self.end_address = end_address def to_asm(self): return self.line new_asm = None def load_asm2(filename="../main.asm", force=False): """loads the asm source code into memory""" global new_asm if new_asm == None or force: new_asm = Asm(filename=filename) return new_asm class Asm: """controls the overall asm output""" def __init__(self, filename="../main.asm", debug=True): self.parts = [] self.labels = [] self.filename = filename self.debug = debug self.load_and_parse() def load_and_parse(self): self.parts = [] asm = open(self.filename, "r").read().split("\n") asm_list = AsmList(asm) bank = 0 for line in asm_list: if line[0:6] == "INCBIN" or line[1:6] == "INCBIN": thing = Incbin(line, bank=bank) elif line[0:7] == "SECTION": thing = AsmSection(line) bank = thing.bank_id else: thing = AsmLine(line, bank=bank) label = get_label_from_line(line) if label: laddress = get_address_from_line_comment(line) thing.label = Label(name=label, address=laddress, object=thing, add_to_globals=False) self.labels.append(thing.label) self.parts.append(thing) def is_label_name_in_file(self, label_name): for llabel in self.labels: if llabel.name == label_name: return llabel return False def does_address_have_label(self, address): """ Checks if an address has a label. """ # either something will directly have the address # or- it's possibel that no label was given # or there will be an Incbin that covers the range for part in self.parts: if isinstance(part, Incbin) and part.start_address <= address <= part.end_address: return False elif hasattr(part, "address") and part.address == address and hasattr(part, "label"): return part.label return None def insert(self, new_object): if isinstance(new_object, ScriptPointerLabelParam): # its' probably being injected in some get_dependencies() somewhere print "don't know why ScriptPointerLabelParam is getting to this point?" return start_address = new_object.address #first some validation if not hasattr(new_object, "address"): print "object needs to have an address property: " + str(new_object) return debugmsg = "object is " + new_object.label.name + " type="+str(new_object.__class__)+" new_object="+str(new_object) debugmsg += " label = " + new_object.label.name debugmsg += " start_address="+hex(start_address)#+" end_address="+hex(end_address) if not hasattr(new_object, "last_address"): print debugmsg raise Exception, "object needs to have a last_address property" end_address = new_object.last_address debugmsg += " last_address="+hex(end_address) #check if the object is already inserted if new_object in self.parts: print "object was previously inserted ("+str(new_object)+")" return #check by label if self.is_label_name_in_file(new_object.label.name): print "object was previously inserted ("+str(new_object)+") by label: "+new_object.label.name return #check by address #if self.does_address_have_label(new_object.address): # print "object's address is already used ("+str(new_object)+") at "+hex(new_object.address)+" label="+new_object.label.name # return if self.debug: print debugmsg del debugmsg if (end_address < start_address) or ((end_address - start_address) < 0): if not self.debug: print "object is new_object="+str(new_object) print "start_address="+hex(start_address)+" end_address="+hex(end_address) if hasattr(new_object, "to_asm"): print to_asm(new_object) raise Exception, "Asm.insert was given an object with a bad address range" # 1) find which object needs to be replaced # or # 2) find which object goes after it found = False for object in list(self.parts): #skip objects without a defined interval (like a comment line) if not hasattr(object, "address") or not hasattr(object, "last_address"): continue #skip an AsmSection if isinstance(object, AsmSection): continue #replace an incbin with three incbins, replace middle incbin with whatever elif isinstance(object, Incbin) and (object.address <= start_address < object.last_address): #split up the incbin into three segments incbins = object.split(start_address, end_address - start_address) #figure out which incbin to replace with the new object if incbins[0].replace_me: index = 0 else: #assume incbins[1].replace_me (the middle one) index = 1 #replace that index with the new_object incbins[index] = new_object #insert these incbins into self.parts gindex = self.parts.index(object) self.parts = self.parts[:gindex] + incbins + self.parts[gindex:] self.parts.remove(object) found = True break #insert before the current object elif object.address > end_address: #insert_before = index of object index = self.parts.index(object) self.parts.insert(index, new_object) found = True break if not found: raise Exception, "unable to insert object into Asm" self.labels.append(new_object.label) return True def insert_single_with_dependencies(self, object0): global_dependencies = set([object0]) poopbutt = get_dependencies_for(object0, global_dependencies=global_dependencies, recompute=False) objects = global_dependencies objects.update(poopbutt) new_objects = copy(objects) for object in objects: if hasattr(object, "dependencies") and object.dependencies == None: new_objects.update(object.get_dependencies()) for object in new_objects: if isinstance(object, ScriptPointerLabelParam): continue #if object in self.parts: # if self.debug: # print "already inserted -- object.__class__="+str(object.__class__)+" object is: "+str(object)+\ # " for object.__class__="+str(object0.__class__)+" object="+str(object0) # continue if self.debug: print " object is: " + str(object) self.insert(object) #just some old debugging #if object.label.name == "UnknownText_0x60128": # raise Exception, "debugging..." #elif object.label.name == "UnknownScript_0x60011": # raise Exception, "debugging.. dependencies are: " + str(object.dependencies) + " versus: " + str(object.get_dependencies()) def insert_multiple_with_dependencies(self, objects): for object in objects: self.insert_single_with_dependencies(object) def insert_all(self, limit=100): count = 0 for each in script_parse_table.items(): if count == limit: break object = each[1] if type(object) == str: continue self.insert_single_with_dependencies(object) count += 1 def insert_and_dump(self, limit=100, filename="output.txt"): self.insert_all(limit=limit) self.dump(filename=filename) def dump(self, filename="output.txt"): fh = open(filename, "w") newlines_before_next_obj_requested = 0 newlines_before_next_obj_given = 0 current_requested_newlines_before = 0 current_requested_newlines_after = 0 previous_requested_newlines_before = 0 previous_requested_newlines_after = 0 written_newlines = 0 write_something = False first = True last = None for each in self.parts: asm = "" previous_requested_newlines_after = current_requested_newlines_after current_requested_newlines_before = current_requested_newlines_after write_something = True if (isinstance(each, str) and each == "") or (isinstance(each, AsmLine) and each.line == ""): current_requested_newlines_before = 0 if current_requested_newlines_after < 2: current_requested_newlines_after += 1 write_something = False elif (isinstance(each, str) and each != "") or (isinstance(each, AsmLine) and each.line != ""): if isinstance(each, AsmLine): asm = each.to_asm() elif isinstance(each, str): asm = each current_requested_newlines_before = 0 current_requested_newlines_after = 1 elif isinstance(each, AsmSection) or isinstance(each, Incbin) or hasattr(each, "to_asm"): if isinstance(each, AsmSection) or isinstance(each, Incbin): asm = each.to_asm() else: asm = to_asm(each) current_requested_newlines_before = 2 current_requested_newlines_after = 2 else: raise Exception, "dunno what to do with("+str(each)+") in Asm.parts" if write_something: if not first: newlines_before = max([current_requested_newlines_before, previous_requested_newlines_after]) while written_newlines < newlines_before: fh.write("\n") written_newlines += 1 else: first = False fh.write(asm) written_newlines = 0 last = each #make sure the file ends with a newline fh.write("\n") def index(seq, f): """return the index of the first item in seq where f(item) == True.""" return next((i for i in xrange(len(seq)) if f(seq[i])), None) def analyze_intervals(): """find the largest baserom.gbc intervals""" global asm, processed_incbins if asm == None: load_asm() if processed_incbins == {}: isolate_incbins() process_incbins() results = [] ordered_keys = sorted(processed_incbins, key=lambda entry: processed_incbins[entry]["interval"]) ordered_keys.reverse() for key in ordered_keys: results.append(processed_incbins[key]) return results all_labels = [] def write_all_labels(all_labels, filename="labels.json"): fh = open(filename, "w") fh.write(json.dumps(all_labels)) fh.close() return True #TODO: implement get_ram_label #wram.asm integration would be nice def get_ram_label(address): """not implemented yet.. supposed to get a label for a particular RAM location like W_PARTYPOKE1HP""" return None def get_label_for(address): """returns a label assigned to a particular address""" global all_labels if address == None: return None if type(address) != int: raise Exception, "get_label_for requires an integer address, got: " + str(type(address)) #the old way for thing in all_labels: if thing["address"] == address: return thing["label"] #the new way obj = script_parse_table[address] if obj: if hasattr(obj, "label"): return obj.label.name else: return "AlreadyParsedNoDefaultUnknownLabel_" + hex(address) #return "NotYetParsed_"+hex(address) if address > 0x7FFF: value = 0x4000 + (address % 0x4000) return "$%.2x"%(value) else: return "$%.2x"%(address) def remove_quoted_text(line): """get rid of content inside quotes and also removes the quotes from the input string""" while line.count("\"") % 2 == 0 and line.count("\"") > 0: first = line.find("\"") second = line.find("\"", first+1) line = line[0:first] + line[second+1:] while line.count("\'") % 2 == 0 and line.count("'") > 0: first = line.find("\'") second = line.find("\'", first+1) line = line[0:first] + line[second+1:] return line # all_new_labels is a temporary replacement for all_labels, # at least until the two approaches are merged in the code base. all_new_labels = [] class Label: """ Every object in script_parse_table is given a label. This label is simply a way to keep track of what objects have been previously written to file. """ def __init__(self, name=None, address=None, line_number=None, object=None, is_in_file=None, address_is_in_file=None, add_to_globals=True): assert name!=None, "need a name" assert address!=None, "need an address" assert is_valid_address(address), "address must be valid" self.name = name self.address = address self.object = object # label might not be in the file yet self.line_number = line_number # -- These were some old attempts to check whether the label # -- was already in use. They work, but the other method is # -- better. # # check if the label is in the file already #self.is_in_file = is_in_file #if is_in_file == None: # self.old_check_is_in_file() # # check if the address of this label is already in use #self.address_is_in_file = address_is_in_file #if address_is_in_file == None: # self.old_check_address_is_in_file() self.is_in_file = is_in_file #if is_in_file == None and add_to_globals: # self.check_is_in_file() self.address_is_in_file = address_is_in_file #if address_is_in_file == None and add_to_globals: # self.check_address_is_in_file() if add_to_globals: all_new_labels.append(self) def check_is_in_file(self): """ This method checks if the label appears in the file based on the entries to the Asm.parts list. """ #assert new_asm != None, "new_asm should be an instance of Asm" load_asm2() is_in_file = new_asm.is_label_name_in_file(self.name) self.is_in_file = is_in_file return is_in_file def check_address_is_in_file(self): """ Checks if the address is in use by another label. """ load_asm2() self.address_is_in_file = new_asm.does_address_have_label(self.address) return self.address_is_in_file def get_line_number_from_raw_file(self): """ Reads the asm file to figure out the line number. Note that this label might not be in the file yet, like if this is a newly generated label. However, if crystal.py has been run before and manipulated main.asm, then it is possible that this label is already in the file. """ lineno = old_is_label_in_asm(self.name) if lineno: self.line_number = lineno self.is_in_file = True return lineno else: self.line_number = None self.is_in_file = False return None def old_check_is_in_file(self): """ Reads the asm file to figure out if this label is already inserted or not. """ self.get_line_number_from_raw_file() return self.is_in_file def old_check_address_is_in_file(self): """ Checks whether or not the address of the object is already in the file. This might happen if the label name is different but the address is the same. Another scenario is that the label is already used, but at a different address. This method works by looking at the INCBINs. When there is an INCBIN that covers this address in the file, then there is no label at this address yet (or there is, but we can easily add another label in front of the incbin or something), and when there is no INCBIN that has this address, then we know that something is already using this address. """ if processed_incbins == {}: process_incbins() incbin = find_incbin_to_replace_for(self.address) if incbin == None: return True else: return False def line_has_comment_address(line, returnable={}, bank=None): """checks that a given line has a comment with a valid address, and returns the address in the object. Note: bank is required if you have a 4-letter-or-less address, because otherwise there is no way to figure out which bank is curretly being scanned.""" #first set the bank/offset to nada returnable["bank"] = None returnable["offset"] = None returnable["address"] = None #only valid characters are 0-9A-F valid = [str(x) for x in range(0,10)] + [chr(x) for x in range(97, 102+1)] #check if there is a comment in this line if ";" not in line: return False #first throw away anything in quotes if (line.count("\"") % 2 == 0 and line.count("\"")!=0) \ or (line.count("\'") % 2 == 0 and line.count("\'")!=0): line = remove_quoted_text(line) #check if there is still a comment in this line after quotes removed if ";" not in line: return False #but even if there's a semicolon there must be later text if line[-1] == ";": return False #and just a space doesn't count if line[-2:] == "; ": return False #and multiple whitespace doesn't count either line = line.rstrip(" ").lstrip(" ") if line[-1] == ";": return False #there must be more content after the semicolon if len(line)-1 == line.find(";"): return False #split it up into the main comment part comment = line[line.find(";")+1:] #don't want no leading whitespace comment = comment.lstrip(" ").rstrip(" ") #split up multi-token comments into single tokens token = comment if " " in comment: #use the first token in the comment token = comment.split(" ")[0] if token in ["0x", "$", "x", ":"]: return False offset = None #process a token with a A:B format if ":" in token: #3:3F0A, $3:$3F0A, 0x3:0x3F0A, 3:3F0A #split up the token bank_piece = token.split(":")[0].lower() offset_piece = token.split(":")[1].lower() #filter out blanks/duds if bank_piece in ["$", "0x", "x"] \ or offset_piece in ["$", "0x", "x"]: return False #they can't have both "$" and "x" if "$" in bank_piece and "x" in bank_piece: return False if "$" in offset_piece and "x" in offset_piece: return False #process the bank piece if "$" in bank_piece: bank_piece = bank_piece.replace("$", "0x") #check characters for validity? for c in bank_piece.replace("x", ""): if c not in valid: return False bank = int(bank_piece, 16) #process the offset piece if "$" in offset_piece: offset_piece = offset_piece.replace("$", "0x") #check characters for validity? for c in offset_piece.replace("x", ""): if c not in valid: return False offset = int(offset_piece, 16) #filter out blanks/duds elif token in ["$", "0x", "x"]: return False #can't have both "$" and "x" in the number elif "$" in token and "x" in token: return False elif "x" in token and not "0x" in token: #it should be 0x return False elif "$" in token and not "x" in token: token = token.replace("$", "0x") offset = int(token, 16) elif "0x" in token and not "$" in token: offset = int(token, 16) else: #might just be "1" at this point token = token.lower() #check if there are bad characters for c in token: if c not in valid: return False offset = int(token, 16) if offset == None and bank == None: return False if bank == None: bank = calculate_bank(offset) returnable["bank"] = bank returnable["offset"] = offset returnable["address"] = calculate_pointer(offset, bank=bank) return True def line_has_label(line): """returns True if the line has an asm label""" if not isinstance(line, str): raise Exception, "can't check this type of object" line = line.rstrip(" ").lstrip(" ") line = remove_quoted_text(line) if ";" in line: line = line.split(";")[0] if 0 <= len(line) <= 1: return False if ":" not in line: return False if line[0] == ";": return False if line[0] == "\"": return False if "::" in line: return False return True def get_address_from_line_comment(line, bank=None): """ wrapper for line_has_comment_address """ returnable = {} result = line_has_comment_address(line, returnable=returnable, bank=bank) if not result: return False return returnable["address"] def get_label_from_line(line): """returns the label from the line""" #check if the line has a label if not line_has_label(line): return None #split up the line label = line.split(":")[0] return label def old_is_label_in_asm(label): """ Returns the line number or returns None if the label is not in the file. This is an "old" method because it looks directly at the list of lines rather than reading a globally shared instance of the Asm class. """ # line numbering begins at 1 in vim i = 1 # check if any line starts with this label for line in asm: if line_has_label(line): thislabel = get_label_from_line(line) if thislabel == label: return i i += 1 return False def find_labels_without_addresses(): """scans the asm source and finds labels that are unmarked""" without_addresses = [] for (line_number, line) in enumerate(asm): if line_has_label(line): label = get_label_from_line(line) if not line_has_comment_address(line): without_addresses.append({"line_number": line_number, "line": line, "label": label}) return without_addresses label_errors = "" def get_labels_between(start_line_id, end_line_id, bank): labels = [] #label = { # "line_number": 15, # "bank": 32, # "label": "PalletTownText1", # "offset": 0x5315, # "address": 0x75315, #} if asm == None: load_asm() sublines = asm[start_line_id : end_line_id + 1] for (current_line_offset, line) in enumerate(sublines): #skip lines without labels if not line_has_label(line): continue #reset some variables line_id = start_line_id + current_line_offset line_label = get_label_from_line(line) address = None offset = None #setup a place to store return values from line_has_comment_address returnable = {} #get the address from the comment has_comment = line_has_comment_address(line, returnable=returnable, bank=bank) #skip this line if it has no address in the comment if not has_comment: continue #parse data from line_has_comment_address address = returnable["address"] bank = returnable["bank"] offset = returnable["offset"] #dump all this info into a single structure label = { "line_number": line_id, "bank": bank, "label": line_label, "offset": offset, "address": address, } #store this structure labels.append(label) return labels def scan_for_predefined_labels(debug=False): """looks through the asm file for labels at specific addresses, this relies on the label having its address after. ex: ViridianCity_h: ; 0x18357 to 0x18384 (45 bytes) (bank=6) (id=1) PalletTownText1: ; 4F96 0x18f96 ViridianCityText1: ; 0x19102 It would be more productive to use rgbasm to spit out all label addresses, but faster to write this script. rgbasm would be able to grab all label addresses better than this script.. """ global all_labels all_labels = [] bank_intervals = {} #figure out line numbers for each bank for bank_id in range(0x7F+1): abbreviation = ("%.x" % (bank_id)).upper() abbreviation_next = ("%.x" % (bank_id+1)).upper() if bank_id == 0: abbreviation = "0" abbreviation_next = "1" #calculate the start/stop line numbers for this bank start_line_id = index(asm, lambda line: "\"bank" + abbreviation + "\"" in line) if bank_id != 0x7F: end_line_id = index(asm, lambda line: "\"bank" + abbreviation_next + "\"" in line) end_line_id += 1 else: end_line_id = len(asm) - 1 if debug: output = "bank" + abbreviation + " starts at " output += str(start_line_id) output += " to " output += str(end_line_id) print output #store the start/stop line number for this bank bank_intervals[bank_id] = {"start": start_line_id, "end": end_line_id,} #for each bank.. for bank_id in bank_intervals.keys(): #get the start/stop line number bank_data = bank_intervals[bank_id] start_line_id = bank_data["start"] end_line_id = bank_data["end"] #get all labels between these two lines labels = get_labels_between(start_line_id, end_line_id, bank_id) #bank_intervals[bank_id]["labels"] = labels all_labels.extend(labels) write_all_labels(all_labels) return all_labels #### generic testing #### class TestCram(unittest.TestCase): "this is where i cram all of my unit tests together" @classmethod def setUpClass(cls): global rom cls.rom = direct_load_rom() rom = cls.rom @classmethod def tearDownClass(cls): del cls.rom def test_generic_useless(self): "do i know how to write a test?" self.assertEqual(1, 1) def test_map_name_cleaner(self): name = "hello world" cleaned_name = map_name_cleaner(name) self.assertNotEqual(name, cleaned_name) self.failUnless(" " not in cleaned_name) name = "Some Random Pokémon Center" cleaned_name = map_name_cleaner(name) self.assertNotEqual(name, cleaned_name) self.failIf(" " in cleaned_name) self.failIf("é" in cleaned_name) def test_grouper(self): data = range(0, 10) groups = grouper(data, count=2) self.assertEquals(len(groups), 5) data = range(0, 20) groups = grouper(data, count=2) self.assertEquals(len(groups), 10) self.assertNotEqual(data, groups) self.assertNotEqual(len(data), len(groups)) def test_direct_load_rom(self): rom = self.rom self.assertEqual(len(rom), 2097152) self.failUnless(isinstance(rom, RomStr)) def test_load_rom(self): global rom rom = None load_rom() self.failIf(rom == None) rom = RomStr(None) load_rom() self.failIf(rom == RomStr(None)) def test_load_asm(self): asm = load_asm() joined_lines = "\n".join(asm) self.failUnless("SECTION" in joined_lines) self.failUnless("bank" in joined_lines) self.failUnless(isinstance(asm, AsmList)) def test_rom_file_existence(self): "ROM file must exist" self.failUnless("baserom.gbc" in os.listdir("../")) def test_rom_md5(self): "ROM file must have the correct md5 sum" rom = self.rom correct = "9f2922b235a5eeb78d65594e82ef5dde" md5sum = md5.md5(rom).hexdigest() self.assertEqual(md5sum, correct) def test_bizarre_http_presence(self): rom_segment = self.rom[0x112116:0x112116+8] self.assertEqual(rom_segment, "HTTP/1.0") def test_rom_interval(self): address = 0x100 interval = 10 correct_strings = ['0x0', '0xc3', '0x6e', '0x1', '0xce', '0xed', '0x66', '0x66', '0xcc', '0xd'] byte_strings = rom_interval(address, interval, strings=True) self.assertEqual(byte_strings, correct_strings) correct_ints = [0, 195, 110, 1, 206, 237, 102, 102, 204, 13] ints = rom_interval(address, interval, strings=False) self.assertEqual(ints, correct_ints) def test_rom_until(self): address = 0x1337 byte = 0x13 bytes = rom_until(address, byte, strings=True) self.failUnless(len(bytes) == 3) self.failUnless(bytes[0] == '0xd5') bytes = rom_until(address, byte, strings=False) self.failUnless(len(bytes) == 3) self.failUnless(bytes[0] == 0xd5) def test_how_many_until(self): how_many = how_many_until(chr(0x13), 0x1337) self.assertEqual(how_many, 3) def test_calculate_bank(self): self.failUnless(calculate_bank(0x8000) == 2) self.failUnless(calculate_bank("0x9000") == 2) self.failUnless(calculate_bank(0) == 0) for address in [0x4000, 0x5000, 0x6000, 0x7000]: self.assertRaises(Exception, calculate_bank, address) def test_calculate_pointer(self): #for offset <= 0x4000 self.assertEqual(calculate_pointer(0x0000), 0x0000) self.assertEqual(calculate_pointer(0x3FFF), 0x3FFF) #for 0x4000 <= offset <= 0x7FFFF self.assertEqual(calculate_pointer(0x430F, bank=5), 0x1430F) #for offset >= 0x7FFF self.assertEqual(calculate_pointer(0x8FFF, bank=6), calculate_pointer(0x8FFF, bank=7)) def test_calculate_pointer_from_bytes_at(self): addr1 = calculate_pointer_from_bytes_at(0x100, bank=False) self.assertEqual(addr1, 0xc300) addr2 = calculate_pointer_from_bytes_at(0x100, bank=True) self.assertEqual(addr2, 0x2ec3) def test_rom_text_at(self): self.assertEquals(rom_text_at(0x112116, 8), "HTTP/1.0") def test_translate_command_byte(self): self.failUnless(translate_command_byte(crystal=0x0) == 0x0) self.failUnless(translate_command_byte(crystal=0x10) == 0x10) self.failUnless(translate_command_byte(crystal=0x40) == 0x40) self.failUnless(translate_command_byte(gold=0x0) == 0x0) self.failUnless(translate_command_byte(gold=0x10) == 0x10) self.failUnless(translate_command_byte(gold=0x40) == 0x40) self.assertEqual(translate_command_byte(gold=0x0), translate_command_byte(crystal=0x0)) self.failUnless(translate_command_byte(gold=0x52) == 0x53) self.failUnless(translate_command_byte(gold=0x53) == 0x54) self.failUnless(translate_command_byte(crystal=0x53) == 0x52) self.failUnless(translate_command_byte(crystal=0x52) == None) self.assertRaises(Exception, translate_command_byte, None, gold=0xA4) def test_pksv_integrity(self): "does pksv_gs look okay?" self.assertEqual(pksv_gs[0x00], "2call") self.assertEqual(pksv_gs[0x2D], "givepoke") self.assertEqual(pksv_gs[0x85], "waitbutton") self.assertEqual(pksv_crystal[0x00], "2call") self.assertEqual(pksv_crystal[0x86], "waitbutton") self.assertEqual(pksv_crystal[0xA2], "credits") def test_chars_integrity(self): self.assertEqual(chars[0x80], "A") self.assertEqual(chars[0xA0], "a") self.assertEqual(chars[0xF0], "¥") self.assertEqual(jap_chars[0x44], "ぱ") def test_map_names_integrity(self): def map_name(map_group, map_id): return map_names[map_group][map_id]["name"] self.assertEqual(map_name(2, 7), "Mahogany Town") self.assertEqual(map_name(3, 0x34), "Ilex Forest") self.assertEqual(map_name(7, 0x11), "Cerulean City") def test_load_map_group_offsets(self): addresses = load_map_group_offsets() self.assertEqual(len(addresses), 26, msg="there should be 26 map groups") addresses = load_map_group_offsets() self.assertEqual(len(addresses), 26, msg="there should still be 26 map groups") self.assertIn(0x94034, addresses) for address in addresses: self.assertGreaterEqual(address, 0x4000) self.failIf(0x4000 <= address <= 0x7FFF) self.failIf(address <= 0x4000) def test_index(self): self.assertTrue(index([1,2,3,4], lambda f: True) == 0) self.assertTrue(index([1,2,3,4], lambda f: f==3) == 2) def test_get_pokemon_constant_by_id(self): x = get_pokemon_constant_by_id self.assertEqual(x(1), "BULBASAUR") self.assertEqual(x(151), "MEW") self.assertEqual(x(250), "HO_OH") def test_find_item_label_by_id(self): x = find_item_label_by_id self.assertEqual(x(249), "HM_07") self.assertEqual(x(173), "BERRY") self.assertEqual(x(45), None) def test_generate_item_constants(self): x = generate_item_constants r = x() self.failUnless("HM_07" in r) self.failUnless("EQU" in r) def test_get_label_for(self): global all_labels temp = copy(all_labels) #this is basd on the format defined in get_labels_between all_labels = [{"label": "poop", "address": 0x5, "offset": 0x5, "bank": 0, "line_number": 2 }] self.assertEqual(get_label_for(5), "poop") all_labels = temp def test_generate_map_constant_labels(self): ids = generate_map_constant_labels() self.assertEqual(ids[0]["label"], "OLIVINE_POKECENTER_1F") self.assertEqual(ids[1]["label"], "OLIVINE_GYM") def test_get_id_for_map_constant_label(self): global map_internal_ids map_internal_ids = generate_map_constant_labels() self.assertEqual(get_id_for_map_constant_label("OLIVINE_GYM"), 1) self.assertEqual(get_id_for_map_constant_label("OLIVINE_POKECENTER_1F"), 0) def test_get_map_constant_label_by_id(self): global map_internal_ids map_internal_ids = generate_map_constant_labels() self.assertEqual(get_map_constant_label_by_id(0), "OLIVINE_POKECENTER_1F") self.assertEqual(get_map_constant_label_by_id(1), "OLIVINE_GYM") def test_is_valid_address(self): self.assertTrue(is_valid_address(0)) self.assertTrue(is_valid_address(1)) self.assertTrue(is_valid_address(10)) self.assertTrue(is_valid_address(100)) self.assertTrue(is_valid_address(1000)) self.assertTrue(is_valid_address(10000)) self.assertFalse(is_valid_address(2097153)) self.assertFalse(is_valid_address(2098000)) addresses = [random.randrange(0,2097153) for i in range(0, 9+1)] for address in addresses: self.assertTrue(is_valid_address(address)) class TestIntervalMap(unittest.TestCase): def test_intervals(self): i = IntervalMap() first = "hello world" second = "testing 123" i[0:5] = first i[5:10] = second self.assertEqual(i[0], first) self.assertEqual(i[1], first) self.assertNotEqual(i[5], first) self.assertEqual(i[6], second) i[3:10] = second self.assertEqual(i[3], second) self.assertNotEqual(i[4], first) def test_items(self): i = IntervalMap() first = "hello world" second = "testing 123" i[0:5] = first i[5:10] = second results = list(i.items()) self.failUnless(len(results) == 2) self.assertEqual(results[0], ((0, 5), "hello world")) self.assertEqual(results[1], ((5, 10), "testing 123")) class TestRomStr(unittest.TestCase): """RomStr is a class that should act exactly like str() except that it never shows the contents of it string unless explicitly forced""" sample_text = "hello world!" sample = None def setUp(self): if self.sample == None: self.__class__.sample = RomStr(self.sample_text) def test_equals(self): "check if RomStr() == str()" self.assertEquals(self.sample_text, self.sample) def test_not_equal(self): "check if RomStr('a') != RomStr('b')" self.assertNotEqual(RomStr('a'), RomStr('b')) def test_appending(self): "check if RomStr()+'a'==str()+'a'" self.assertEquals(self.sample_text+'a', self.sample+'a') def test_conversion(self): "check if RomStr() -> str() works" self.assertEquals(str(self.sample), self.sample_text) def test_inheritance(self): self.failUnless(issubclass(RomStr, str)) def test_length(self): self.assertEquals(len(self.sample_text), len(self.sample)) self.assertEquals(len(self.sample_text), self.sample.length()) self.assertEquals(len(self.sample), self.sample.length()) def test_rom_interval(self): global rom load_rom() address = 0x100 interval = 10 correct_strings = ['0x0', '0xc3', '0x6e', '0x1', '0xce', '0xed', '0x66', '0x66', '0xcc', '0xd'] byte_strings = rom.interval(address, interval, strings=True) self.assertEqual(byte_strings, correct_strings) correct_ints = [0, 195, 110, 1, 206, 237, 102, 102, 204, 13] ints = rom.interval(address, interval, strings=False) self.assertEqual(ints, correct_ints) def test_rom_until(self): global rom load_rom() address = 0x1337 byte = 0x13 bytes = rom.until(address, byte, strings=True) self.failUnless(len(bytes) == 3) self.failUnless(bytes[0] == '0xd5') bytes = rom.until(address, byte, strings=False) self.failUnless(len(bytes) == 3) self.failUnless(bytes[0] == 0xd5) class TestAsmList(unittest.TestCase): """AsmList is a class that should act exactly like list() except that it never shows the contents of its list unless explicitly forced""" def test_equals(self): base = [1,2,3] asm = AsmList(base) self.assertEquals(base, asm) self.assertEquals(asm, base) self.assertEquals(base, list(asm)) def test_inheritance(self): self.failUnless(issubclass(AsmList, list)) def test_length(self): base = range(0, 10) asm = AsmList(base) self.assertEquals(len(base), len(asm)) self.assertEquals(len(base), asm.length()) self.assertEquals(len(base), len(list(asm))) self.assertEquals(len(asm), asm.length()) def test_remove_quoted_text(self): x = remove_quoted_text self.assertEqual(x("hello world"), "hello world") self.assertEqual(x("hello \"world\""), "hello ") input = 'hello world "testing 123"' self.assertNotEqual(x(input), input) input = "hello world 'testing 123'" self.assertNotEqual(x(input), input) self.failIf("testing" in x(input)) def test_line_has_comment_address(self): x = line_has_comment_address self.assertFalse(x("")) self.assertFalse(x(";")) self.assertFalse(x(";;;")) self.assertFalse(x(":;")) self.assertFalse(x(":;:")) self.assertFalse(x(";:")) self.assertFalse(x(" ")) self.assertFalse(x("".join(" " * 5))) self.assertFalse(x("".join(" " * 10))) self.assertFalse(x("hello world")) self.assertFalse(x("hello_world")) self.assertFalse(x("hello_world:")) self.assertFalse(x("hello_world:;")) self.assertFalse(x("hello_world: ;")) self.assertFalse(x("hello_world: ; ")) self.assertFalse(x("hello_world: ;" + "".join(" " * 5))) self.assertFalse(x("hello_world: ;" + "".join(" " * 10))) self.assertTrue(x(";1")) self.assertTrue(x(";F")) self.assertTrue(x(";$00FF")) self.assertTrue(x(";0x00FF")) self.assertTrue(x("; 0x00FF")) self.assertTrue(x(";$3:$300")) self.assertTrue(x(";0x3:$300")) self.assertTrue(x(";$3:0x300")) self.assertTrue(x(";3:300")) self.assertTrue(x(";3:FFAA")) self.assertFalse(x('hello world "how are you today;0x1"')) self.assertTrue(x('hello world "how are you today:0x1";1')) returnable = {} self.assertTrue(x("hello_world: ; 0x4050", returnable=returnable, bank=5)) self.assertTrue(returnable["address"] == 0x14050) def test_line_has_label(self): x = line_has_label self.assertTrue(x("hi:")) self.assertTrue(x("Hello: ")) self.assertTrue(x("MyLabel: ; test xyz")) self.assertFalse(x(":")) self.assertFalse(x(";HelloWorld:")) self.assertFalse(x("::::")) self.assertFalse(x(":;:;:;:::")) def test_get_label_from_line(self): x = get_label_from_line self.assertEqual(x("HelloWorld: "), "HelloWorld") self.assertEqual(x("HiWorld:"), "HiWorld") self.assertEqual(x("HiWorld"), None) def test_find_labels_without_addresses(self): global asm asm = ["hello_world: ; 0x1", "hello_world2: ;"] labels = find_labels_without_addresses() self.failUnless(labels[0]["label"] == "hello_world2") asm = ["hello world: ;1", "hello_world: ;2"] labels = find_labels_without_addresses() self.failUnless(len(labels) == 0) asm = None def test_get_labels_between(self): global asm x = get_labels_between#(start_line_id, end_line_id, bank) asm = ["HelloWorld: ;1", "hi:", "no label on this line", ] labels = x(0, 2, 0x12) self.assertEqual(len(labels), 1) self.assertEqual(labels[0]["label"], "HelloWorld") del asm def test_scan_for_predefined_labels(self): #label keys: line_number, bank, label, offset, address load_asm() all_labels = scan_for_predefined_labels() label_names = [x["label"] for x in all_labels] self.assertIn("GetFarByte", label_names) self.assertIn("AddNTimes", label_names) self.assertIn("CheckShininess", label_names) def test_write_all_labels(self): """dumping json into a file""" filename = "test_labels.json" #remove the current file if os.path.exists(filename): os.system("rm " + filename) #make up some labels labels = [] #fake label 1 label = {"line_number": 5, "bank": 0, "label": "SomeLabel", "address": 0x10} labels.append(label) #fake label 2 label = {"line_number": 15, "bank": 2, "label": "SomeOtherLabel", "address": 0x9F0A} labels.append(label) #dump to file write_all_labels(labels, filename=filename) #open the file and read the contents file_handler = open(filename, "r") contents = file_handler.read() file_handler.close() #parse into json obj = json.read(contents) #begin testing self.assertEqual(len(obj), len(labels)) self.assertEqual(len(obj), 2) self.assertEqual(obj, labels) def test_isolate_incbins(self): global asm asm = ["123", "456", "789", "abc", "def", "ghi", 'INCBIN "baserom.gbc",$12DA,$12F8 - $12DA', "jkl", 'INCBIN "baserom.gbc",$137A,$13D0 - $137A'] lines = isolate_incbins() self.assertIn(asm[6], lines) self.assertIn(asm[8], lines) for line in lines: self.assertIn("baserom", line) def test_process_incbins(self): global incbin_lines, processed_incbins, asm incbin_lines = ['INCBIN "baserom.gbc",$12DA,$12F8 - $12DA', 'INCBIN "baserom.gbc",$137A,$13D0 - $137A'] asm = copy(incbin_lines) asm.insert(1, "some other random line") processed_incbins = process_incbins() self.assertEqual(len(processed_incbins), len(incbin_lines)) self.assertEqual(processed_incbins[0]["line"], incbin_lines[0]) self.assertEqual(processed_incbins[2]["line"], incbin_lines[1]) def test_reset_incbins(self): global asm, incbin_lines, processed_incbins #temporarily override the functions global load_asm, isolate_incbins, process_incbins temp1, temp2, temp3 = load_asm, isolate_incbins, process_incbins def load_asm(): pass def isolate_incbins(): pass def process_incbins(): pass #call reset reset_incbins() #check the results self.assertTrue(asm == [] or asm == None) self.assertTrue(incbin_lines == []) self.assertTrue(processed_incbins == {}) #reset the original functions load_asm, isolate_incbins, process_incbins = temp1, temp2, temp3 def test_find_incbin_to_replace_for(self): global asm, incbin_lines, processed_incbins asm = ['first line', 'second line', 'third line', 'INCBIN "baserom.gbc",$90,$200 - $90', 'fifth line', 'last line'] isolate_incbins() process_incbins() line_num = find_incbin_to_replace_for(0x100) #must be the 4th line (the INBIN line) self.assertEqual(line_num, 3) def test_split_incbin_line_into_three(self): global asm, incbin_lines, processed_incbins asm = ['first line', 'second line', 'third line', 'INCBIN "baserom.gbc",$90,$200 - $90', 'fifth line', 'last line'] isolate_incbins() process_incbins() content = split_incbin_line_into_three(3, 0x100, 10) #must end up with three INCBINs in output self.failUnless(content.count("INCBIN") == 3) def test_analyze_intervals(self): global asm, incbin_lines, processed_incbins asm, incbin_lines, processed_incbins = None, [], {} asm = ['first line', 'second line', 'third line', 'INCBIN "baserom.gbc",$90,$200 - $90', 'fifth line', 'last line', 'INCBIN "baserom.gbc",$33F,$4000 - $33F'] isolate_incbins() process_incbins() largest = analyze_intervals() self.assertEqual(largest[0]["line_number"], 6) self.assertEqual(largest[0]["line"], asm[6]) self.assertEqual(largest[1]["line_number"], 3) self.assertEqual(largest[1]["line"], asm[3]) def test_generate_diff_insert(self): global asm asm = ['first line', 'second line', 'third line', 'INCBIN "baserom.gbc",$90,$200 - $90', 'fifth line', 'last line', 'INCBIN "baserom.gbc",$33F,$4000 - $33F'] diff = generate_diff_insert(0, "the real first line", debug=False) self.assertIn("the real first line", diff) self.assertIn("INCBIN", diff) self.assertNotIn("No newline at end of file", diff) self.assertIn("+"+asm[1], diff) class TestMapParsing(unittest.TestCase): def test_parse_all_map_headers(self): global parse_map_header_at, old_parse_map_header_at, counter counter = 0 for k in map_names.keys(): if "offset" not in map_names[k].keys(): map_names[k]["offset"] = 0 temp = parse_map_header_at temp2 = old_parse_map_header_at def parse_map_header_at(address, map_group=None, map_id=None, debug=False): global counter counter += 1 return {} old_parse_map_header_at = parse_map_header_at parse_all_map_headers(debug=False) #parse_all_map_headers is currently doing it 2x #because of the new/old map header parsing routines self.assertEqual(counter, 388 * 2) parse_map_header_at = temp old_parse_map_header_at = temp2 class TestTextScript(unittest.TestCase): """for testing 'in-script' commands, etc.""" #def test_to_asm(self): # pass #or raise NotImplementedError, bryan_message #def test_find_addresses(self): # pass #or raise NotImplementedError, bryan_message #def test_parse_text_at(self): # pass #or raise NotImplementedError, bryan_message class TestEncodedText(unittest.TestCase): """for testing chars-table encoded text chunks""" def test_process_00_subcommands(self): g = process_00_subcommands(0x197186, 0x197186+601, debug=False) self.assertEqual(len(g), 42) self.assertEqual(len(g[0]), 13) self.assertEqual(g[1], [184, 174, 180, 211, 164, 127, 20, 231, 81]) def test_parse_text_at2(self): oakspeech = parse_text_at2(0x197186, 601, debug=False) self.assertIn("encyclopedia", oakspeech) self.assertIn("researcher", oakspeech) self.assertIn("dependable", oakspeech) def test_parse_text_engine_script_at(self): p = parse_text_engine_script_at(0x197185, debug=False) self.assertEqual(len(p.commands), 2) self.assertEqual(len(p.commands[0]["lines"]), 41) #don't really care about these other two def test_parse_text_from_bytes(self): pass def test_parse_text_at(self): pass class TestScript(unittest.TestCase): """for testing parse_script_engine_script_at and script parsing in general. Script should be a class.""" #def test_parse_script_engine_script_at(self): # pass #or raise NotImplementedError, bryan_message def test_find_all_text_pointers_in_script_engine_script(self): address = 0x197637 #0x197634 script = parse_script_engine_script_at(address, debug=False) bank = calculate_bank(address) r = find_all_text_pointers_in_script_engine_script(script, bank=bank, debug=False) results = list(r) self.assertIn(0x197661, results) class TestLabel(unittest.TestCase): def test_label_making(self): line_number = 2 address = 0xf0c0 label_name = "poop" l = Label(name=label_name, address=address, line_number=line_number) self.failUnless(hasattr(l, "name")) self.failUnless(hasattr(l, "address")) self.failUnless(hasattr(l, "line_number")) self.failIf(isinstance(l.address, str)) self.failIf(isinstance(l.line_number, str)) self.failUnless(isinstance(l.name, str)) self.assertEqual(l.line_number, line_number) self.assertEqual(l.name, label_name) self.assertEqual(l.address, address) class TestByteParams(unittest.TestCase): @classmethod def setUpClass(cls): load_rom() cls.address = 10 cls.sbp = SingleByteParam(address=cls.address) @classmethod def tearDownClass(cls): del cls.sbp def test__init__(self): self.assertEqual(self.sbp.size, 1) self.assertEqual(self.sbp.address, self.address) def test_parse(self): self.sbp.parse() self.assertEqual(str(self.sbp.byte), str(45)) def test_to_asm(self): self.assertEqual(self.sbp.to_asm(), "$2d") self.sbp.should_be_decimal = True self.assertEqual(self.sbp.to_asm(), str(45)) #HexByte and DollarSignByte are the same now def test_HexByte_to_asm(self): h = HexByte(address=10) a = h.to_asm() self.assertEqual(a, "$2d") def test_DollarSignByte_to_asm(self): d = DollarSignByte(address=10) a = d.to_asm() self.assertEqual(a, "$2d") def test_ItemLabelByte_to_asm(self): i = ItemLabelByte(address=433) self.assertEqual(i.byte, 54) self.assertEqual(i.to_asm(), "COIN_CASE") self.assertEqual(ItemLabelByte(address=10).to_asm(), "$2d") def test_DecimalParam_to_asm(self): d = DecimalParam(address=10) x = d.to_asm() self.assertEqual(x, str(0x2d)) class TestMultiByteParam(unittest.TestCase): def setup_for(self, somecls, byte_size=2, address=443, **kwargs): self.cls = somecls(address=address, size=byte_size, **kwargs) self.assertEqual(self.cls.address, address) self.assertEqual(self.cls.bytes, rom_interval(address, byte_size, strings=False)) self.assertEqual(self.cls.size, byte_size) def test_two_byte_param(self): self.setup_for(MultiByteParam, byte_size=2) self.assertEqual(self.cls.to_asm(), "$f0c0") def test_three_byte_param(self): self.setup_for(MultiByteParam, byte_size=3) def test_PointerLabelParam_no_bank(self): self.setup_for(PointerLabelParam, bank=None) #assuming no label at this location.. self.assertEqual(self.cls.to_asm(), "$f0c0") global all_labels #hm.. maybe all_labels should be using a class? all_labels = [{"label": "poop", "address": 0xf0c0, "offset": 0xf0c0, "bank": 0, "line_number": 2 }] self.assertEqual(self.cls.to_asm(), "poop") class TestPostParsing: #(unittest.TestCase): """tests that must be run after parsing all maps""" @classmethod def setUpClass(cls): run_main() def test_signpost_counts(self): self.assertEqual(len(map_names[1][1]["signposts"]), 0) self.assertEqual(len(map_names[1][2]["signposts"]), 2) self.assertEqual(len(map_names[10][5]["signposts"]), 7) def test_warp_counts(self): self.assertEqual(map_names[10][5]["warp_count"], 9) self.assertEqual(map_names[18][5]["warp_count"], 3) self.assertEqual(map_names[15][1]["warp_count"], 2) def test_map_sizes(self): self.assertEqual(map_names[15][1]["height"], 18) self.assertEqual(map_names[15][1]["width"], 10) self.assertEqual(map_names[7][1]["height"], 4) self.assertEqual(map_names[7][1]["width"], 4) def test_map_connection_counts(self): self.assertEqual(map_names[7][1]["connections"], 0) self.assertEqual(map_names[10][1]["connections"], 12) self.assertEqual(map_names[10][2]["connections"], 12) self.assertEqual(map_names[11][1]["connections"], 9) #or 13? def test_second_map_header_address(self): self.assertEqual(map_names[11][1]["second_map_header_address"], 0x9509c) self.assertEqual(map_names[1][5]["second_map_header_address"], 0x95bd0) def test_event_address(self): self.assertEqual(map_names[17][5]["event_address"], 0x194d67) self.assertEqual(map_names[23][3]["event_address"], 0x1a9ec9) def test_people_event_counts(self): self.assertEqual(len(map_names[23][3]["people_events"]), 4) self.assertEqual(len(map_names[10][3]["people_events"]), 9) class TestMetaTesting(unittest.TestCase): """test whether or not i am finding at least some of the tests in this file""" tests = None def setUp(self): if self.tests == None: self.__class__.tests = assemble_test_cases() def test_assemble_test_cases_count(self): "does assemble_test_cases find some tests?" self.failUnless(len(self.tests) > 0) def test_assemble_test_cases_inclusion(self): "is this class found by assemble_test_cases?" #i guess it would have to be for this to be running? self.failUnless(self.__class__ in self.tests) def test_assemble_test_cases_others(self): "test other inclusions for assemble_test_cases" self.failUnless(TestRomStr in self.tests) self.failUnless(TestCram in self.tests) def test_check_has_test(self): self.failUnless(check_has_test("beaver", ["test_beaver"])) self.failUnless(check_has_test("beaver", ["test_beaver_2"])) self.failIf(check_has_test("beaver_1", ["test_beaver"])) def test_find_untested_methods(self): untested = find_untested_methods() #the return type must be an iterable self.failUnless(hasattr(untested, "__iter__")) #.. basically, a list self.failUnless(isinstance(untested, list)) def test_find_untested_methods_method(self): """create a function and see if it is found""" #setup a function in the global namespace global some_random_test_method #define the method def some_random_test_method(): pass #first make sure it is in the global scope members = inspect.getmembers(sys.modules[__name__], inspect.isfunction) func_names = [functuple[0] for functuple in members] self.assertIn("some_random_test_method", func_names) #test whether or not it is found by find_untested_methods untested = find_untested_methods() self.assertIn("some_random_test_method", untested) #remove the test method from the global namespace del some_random_test_method def test_load_tests(self): loader = unittest.TestLoader() suite = load_tests(loader, None, None) suite._tests[0]._testMethodName membership_test = lambda member: \ inspect.isclass(member) and issubclass(member, unittest.TestCase) tests = inspect.getmembers(sys.modules[__name__], membership_test) classes = [x[1] for x in tests] for test in suite._tests: self.assertIn(test.__class__, classes) def test_report_untested(self): untested = find_untested_methods() output = report_untested() if len(untested) > 0: self.assertIn("NOT TESTED", output) for name in untested: self.assertIn(name, output) elif len(untested) == 0: self.assertNotIn("NOT TESTED", output) def assemble_test_cases(): """finds classes that inherit from unittest.TestCase because i am too lazy to remember to add them to a global list of tests for the suite runner""" classes = [] clsmembers = inspect.getmembers(sys.modules[__name__], inspect.isclass) for (name, some_class) in clsmembers: if issubclass(some_class, unittest.TestCase): classes.append(some_class) return classes def load_tests(loader, tests, pattern): suite = unittest.TestSuite() for test_class in assemble_test_cases(): tests = loader.loadTestsFromTestCase(test_class) suite.addTests(tests) return suite def check_has_test(func_name, tested_names): """checks if there is a test dedicated to this function""" if "test_"+func_name in tested_names: return True for name in tested_names: if "test_"+func_name in name: return True return False def find_untested_methods(): """finds all untested functions in this module by searching for method names in test case method names.""" untested = [] avoid_funcs = ["main", "run_tests", "run_main", "copy", "deepcopy"] test_funcs = [] #get a list of all classes in this module classes = inspect.getmembers(sys.modules[__name__], inspect.isclass) #for each class.. for (name, klass) in classes: #only look at those that have tests if issubclass(klass, unittest.TestCase): #look at this class' methods funcs = inspect.getmembers(klass, inspect.ismethod) #for each method.. for (name2, func) in funcs: #store the ones that begin with test_ if "test_" in name2 and name2[0:5] == "test_": test_funcs.append([name2, func]) #assemble a list of all test method names (test_x, test_y, ..) tested_names = [funcz[0] for funcz in test_funcs] #now get a list of all functions in this module funcs = inspect.getmembers(sys.modules[__name__], inspect.isfunction) #for each function.. for (name, func) in funcs: #we don't care about some of these if name in avoid_funcs: continue #skip functions beginning with _ if name[0] == "_": continue #check if this function has a test named after it has_test = check_has_test(name, tested_names) if not has_test: untested.append(name) return untested def report_untested(): untested = find_untested_methods() output = "NOT TESTED: [" first = True for name in untested: if first: output += name first = False else: output += ", "+name output += "]\n" output += "total untested: " + str(len(untested)) return output #### ways to run this file #### def run_tests(): #rather than unittest.main() loader = unittest.TestLoader() suite = load_tests(loader, None, None) unittest.TextTestRunner(verbosity=2).run(suite) print report_untested() def run_main(): #read the rom and figure out the offsets for maps direct_load_rom() load_map_group_offsets() #add the offsets into our map structure, why not (johto maps only) [map_names[map_group_id+1].update({"offset": offset}) for map_group_id, offset in enumerate(map_group_offsets)] #parse map header bytes for each map parse_all_map_headers() #just a helpful alias main=run_main #when you run the file.. do unit tests if __name__ == "__main__": run_tests() #when you load the module.. parse everything elif __name__ == "crystal": pass #run_main()