pokehacks/pokecrystal-board
0
0
Fork 0
mirror of https://gitlab.com/xCrystal/pokecrystal-board.git synced 2024-09-09 09:51:34 -07:00
Code Issues Packages Projects Releases Wiki Activity

refactor all labels to be Label instances

Browse Source
This commit is contained in:
Bryan Bishop 2012-04-26 18:41:13 -05:00
parent ea2daf05ee
commit ddbfc016c1
1 changed files with 80 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

131
extras/crystal.py
View File

@ -393,7 +393,7 @@ class TextScript:
self.map_group, self.map_id, self.debug, self.show, self.force = map_group, map_id, debug, show, force self.map_group, self.map_id, self.debug, self.show, self.force = map_group, map_id, debug, show, force
if not label: if not label:
label = self.base_label + hex(address) label = self.base_label + hex(address)
self.label = label self.label = Label(name=label, address=address, object=self)
self.dependencies = [] self.dependencies = []
self.parse_text_at(address) self.parse_text_at(address)
@ -720,7 +720,7 @@ class TextScript:
def to_asm(self, label=None): def to_asm(self, label=None):
address = self.address address = self.address
start_address = address start_address = address
if label == None: label = self.label if label == None: label = self.label.name
commands = self.commands commands = self.commands
#apparently this isn't important anymore? #apparently this isn't important anymore?
needs_to_begin_with_0 = True needs_to_begin_with_0 = True
@ -912,7 +912,7 @@ class EncodedText:
self.map_group, self.map_id, self.debug = map_group, map_id, debug self.map_group, self.map_id, self.debug = map_group, map_id, debug
if not label: if not label:
label = self.base_label + hex(address) label = self.base_label + hex(address)
self.label = label self.label = Label(name=label, address=address, object=self)
self.parse() self.parse()
script_parse_table[self.address : self.last_address] = self script_parse_table[self.address : self.last_address] = self
@ -1280,7 +1280,7 @@ class PointerLabelParam(MultiByteParam):
thing = script_parse_table[self.parsed_address] thing = script_parse_table[self.parsed_address]
if thing and thing.address == self.parsed_address and not (thing is self): if thing and thing.address == self.parsed_address and not (thing is self):
if self.debug: if self.debug:
print "parsed address is: " + hex(self.parsed_address) + " with label: " + thing.label + " of type: " + str(thing.__class__) print "parsed address is: " + hex(self.parsed_address) + " with label: " + thing.label.name + " of type: " + str(thing.__class__)
dependencies.append(thing) dependencies.append(thing)
dependencies.extend(thing.get_dependencies()) dependencies.extend(thing.get_dependencies())
return dependencies return dependencies
@ -1296,7 +1296,7 @@ class PointerLabelParam(MultiByteParam):
#check that the label actually points to the right place #check that the label actually points to the right place
result = script_parse_table[caddress] result = script_parse_table[caddress]
if result != None and hasattr(result, "label"): if result != None and hasattr(result, "label"):
if result.label != label: if result.label.name != label:
label = None label = None
elif result.address != caddress: elif result.address != caddress:
label = None label = None
@ -1504,6 +1504,7 @@ class Command:
#use this when the "byte id" doesn't matter #use this when the "byte id" doesn't matter
#.. for example, a non-script command doesn't use the "byte id" #.. for example, a non-script command doesn't use the "byte id"
override_byte_check = False override_byte_check = False
base_label = "UnseenLabel_"
def __init__(self, address=None, *pargs, **kwargs): def __init__(self, address=None, *pargs, **kwargs):
"""params: """params:
@ -1520,8 +1521,8 @@ class Command:
self.address = address self.address = address
self.last_address = None self.last_address = None
#setup the label based on base_label if available #setup the label based on base_label if available
if hasattr(self, "base_label"): label = self.base_label + hex(self.address)
self.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 #params are where this command's byte parameters are stored
self.params = {} self.params = {}
#override default settings #override default settings
@ -1940,6 +1941,7 @@ stop_points = [0x1aafa2,
0x9f62f, #battle tower 0x9f62f, #battle tower
] ]
class Script: class Script:
base_label = "UnknownScript_"
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
self.address = None self.address = None
self.commands = None self.commands = None
@ -1955,7 +1957,13 @@ class Script:
self.address = address self.address = address
elif len(args) > 1: elif len(args) > 1:
raise Exception, "don't know what to do with second (or later) positional arguments" raise Exception, "don't know what to do with second (or later) positional arguments"
self.label = "UnknownScript_"+hex(self.address) 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 #parse the script at the address
if "use_old_parse" in kwargs.keys() and kwargs["use_old_parse"] == True: if "use_old_parse" in kwargs.keys() and kwargs["use_old_parse"] == True:
self.old_parse(**kwargs) self.old_parse(**kwargs)
@ -2246,8 +2254,9 @@ class ItemFragment(Command):
self.address = address self.address = address
self.last_address = address + self.size self.last_address = address + self.size
self.bank = bank self.bank = bank
if label: self.label = label if not label:
else: self.label = self.base_label + hex(address) label = self.base_label + hex(address)
self.label = Label(name=label, address=address, object=self)
self.map_group = map_group self.map_group = map_group
self.map_id = map_id self.map_id = map_id
self.debug = debug self.debug = debug
@ -2401,8 +2410,9 @@ class PeopleEvent(Command):
self.last_address = address + people_event_byte_size self.last_address = address + people_event_byte_size
self.id = id self.id = id
self.bank = bank self.bank = bank
if label: self.label = label if not label:
else: self.label = self.base_label + hex(address) label = self.base_label + hex(address)
self.label = Label(name=label, address=address, object=self)
self.map_group = map_group self.map_group = map_group
self.map_id = map_id self.map_id = map_id
self.debug = debug self.debug = debug
@ -2615,9 +2625,9 @@ class SignpostRemoteBase:
self.signpost = signpost self.signpost = signpost
self.debug = debug self.debug = debug
self.params = [] self.params = []
if label == None: if not label:
self.label = self.base_label + hex(self.address) label = self.base_label + hex(address)
else: self.label = label self.label = Label(name=label, address=address, object=self)
self.parse() self.parse()
def get_dependencies(self): def get_dependencies(self):
@ -2742,9 +2752,8 @@ class Signpost(Command):
self.address = address self.address = address
self.id = id self.id = id
if label == None: if label == None:
self.label = "UnknownSignpost_"+str(map_group)+"Map"+str(map_id)+"_"+hex(address) label = "UnknownSignpost_"+str(map_group)+"Map"+str(map_id)+"_"+hex(address)
else: self.label = Label(name=label, address=address, object=self)
self.label = label
self.map_group = map_group self.map_group = map_group
self.map_id = map_id self.map_id = map_id
self.debug = debug self.debug = debug
@ -2958,9 +2967,8 @@ class MapHeader:
self.bank = bank self.bank = bank
self.debug = debug self.debug = debug
if not label: if not label:
self.label = self.base_label + hex(address) label = self.base_label + hex(address)
else: self.label = Label(name=label, address=address, object=self)
self.label = label
self.last_address = address + 9 self.last_address = address + 9
script_parse_table[address : self.last_address] = self script_parse_table[address : self.last_address] = self
self.parse() self.parse()
@ -3048,8 +3056,8 @@ class SecondMapHeader:
self.debug = debug self.debug = debug
self.bank = bank self.bank = bank
if not label: if not label:
self.label = self.base_label + hex(address) label = self.base_label + hex(address)
else: self.label = label self.label = Label(name=label, address=address, object=self)
self.last_address = address+12 self.last_address = address+12
#i think it's always a static size? #i think it's always a static size?
script_parse_table[address : self.last_address] = self script_parse_table[address : self.last_address] = self
@ -3193,10 +3201,9 @@ class MapBlockData:
self.height = height self.height = height
else: else:
raise Exception, "MapBlockData needs to know the width/height of its map" raise Exception, "MapBlockData needs to know the width/height of its map"
if label: if not label:
self.label = label label = self.base_label + hex(address)
else: self.label = Label(name=label, address=address, object=self)
self.label = self.base_label + hex(address)
self.last_address = self.address + (self.width.byte * self.height.byte) self.last_address = self.address + (self.width.byte * self.height.byte)
script_parse_table[address : self.last_address] = self script_parse_table[address : self.last_address] = self
self.parse() self.parse()
@ -3231,10 +3238,9 @@ class MapEventHeader:
self.map_id = map_id self.map_id = map_id
self.debug = debug self.debug = debug
self.bank = bank self.bank = bank
if label: if not label:
self.label = label label = self.base_label + hex(address)
else: self.label = Label(name=label, address=address, object=self)
self.label = self.base_label + hex(address)
self.parse() self.parse()
script_parse_table[address : self.last_address] = self script_parse_table[address : self.last_address] = self
@ -3450,10 +3456,9 @@ class MapScriptHeader:
self.map_id = map_id self.map_id = map_id
self.debug = debug self.debug = debug
self.bank = bank self.bank = bank
if label: if not label:
self.label = label label = self.base_label + hex(address)
else: self.label = Label(name=label, address=address, object=self)
self.label = self.base_label + hex(address)
self.parse() self.parse()
script_parse_table[address : self.last_address] = self script_parse_table[address : self.last_address] = self
@ -4297,7 +4302,7 @@ def to_asm(some_object):
#add one to the last_address to show where the next byte is in the file #add one to the last_address to show where the next byte is in the file
last_address = some_object.last_address last_address = some_object.last_address
#create a line like "label: ; 0x10101" #create a line like "label: ; 0x10101"
asm = some_object.label + ": ; " + hex(some_object.address) + "\n" asm = some_object.label.name + ": ; " + hex(some_object.address) + "\n"
#now add the inner/actual asm #now add the inner/actual asm
#asm += spacing + some_object.to_asm().replace("\n", "\n"+spacing).replace("\n"+spacing+"\n"+spacing, "\n\n"+spacing) #asm += spacing + some_object.to_asm().replace("\n", "\n"+spacing).replace("\n"+spacing+"\n"+spacing, "\n\n"+spacing)
asmr = some_object.to_asm() asmr = some_object.to_asm()
@ -4646,7 +4651,7 @@ class Asm:
"""controls the overall asm output""" """controls the overall asm output"""
def __init__(self, filename="../main.asm", debug=True): def __init__(self, filename="../main.asm", debug=True):
self.parts = [] self.parts = []
self.label_names = [] self.labels = []
self.filename = filename self.filename = filename
self.debug = debug self.debug = debug
self.load_and_parse() self.load_and_parse()
@ -4665,10 +4670,15 @@ class Asm:
thing = AsmLine(line, bank=bank) thing = AsmLine(line, bank=bank)
label = get_label_from_line(line) label = get_label_from_line(line)
if label: if label:
self.label_names.append(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) self.parts.append(thing)
def is_label_name_in_file(self, label_name): def is_label_name_in_file(self, label_name):
return label_name in self.label_names for llabel in self.labels:
if llabel.name == label_name:
return llabel
return False
def does_address_have_label(self, address): def does_address_have_label(self, address):
""" Checks if an address has a label. """ Checks if an address has a label.
""" """
@ -4676,26 +4686,34 @@ class Asm:
# or- it's possibel that no label was given # or- it's possibel that no label was given
# or there will be an Incbin that covers the range # or there will be an Incbin that covers the range
for part in self.parts: for part in self.parts:
if issubtype(part, Incbin) and part.start_address <= address <= part.end_address: if isinstance(part, Incbin) and part.start_address <= address <= part.end_address:
return False return False
elif part.address == address and hasattr(part, "label"): elif hasattr(part, "address") and part.address == address and hasattr(part, "label"):
return part.label return part.label
return None return None
def insert(self, new_object): def insert(self, new_object):
#if isinstance(new_object, TextScript): #first some validation
# print "ignoring TextScript object-- these seem very broken?"
# return
if not hasattr(new_object, "address"): if not hasattr(new_object, "address"):
print "object needs to have an address property: " + str(new_object) print "object needs to have an address property: " + str(new_object)
return return
if not hasattr(new_object, "last_address"): if not hasattr(new_object, "last_address"):
print "object needs to have a last_address property: " + str(new_object) print "object needs to have a last_address property: " + str(new_object)
return return
#check if the object is already inserted #check if the object is already inserted
if new_object in self.parts: if new_object in self.parts:
print "object was previously inserted ("+str(new_object)+")" print "object was previously inserted ("+str(new_object)+")"
return 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
start_address = new_object.address start_address = new_object.address
end_address = new_object.last_address end_address = new_object.last_address
if self.debug: if self.debug:
@ -4708,6 +4726,7 @@ class Asm:
if hasattr(new_object, "to_asm"): if hasattr(new_object, "to_asm"):
print to_asm(new_object) print to_asm(new_object)
raise Exception, "Asm.insert was given an object with a bad address range" raise Exception, "Asm.insert was given an object with a bad address range"
# 1) find which object needs to be replaced # 1) find which object needs to be replaced
# or # or
# 2) find which object goes after it # 2) find which object goes after it
@ -4745,7 +4764,7 @@ class Asm:
break break
if not found: if not found:
raise Exception, "unable to insert object into Asm" raise Exception, "unable to insert object into Asm"
self.label_names.append(self.label.name) self.labels.append(new_object.label)
return True return True
def insert_single_with_dependencies(self, object0): def insert_single_with_dependencies(self, object0):
objects = get_dependencies_for(object0) + [object0] objects = get_dependencies_for(object0) + [object0]
@ -4907,7 +4926,7 @@ class Label:
This label is simply a way to keep track of what objects have This label is simply a way to keep track of what objects have
been previously written to file. 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): 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 name!=None, "need a name"
assert address!=None, "need an address" assert address!=None, "need an address"
assert is_valid_address(address), "address must be valid" assert is_valid_address(address), "address must be valid"
@ -4934,14 +4953,15 @@ class Label:
# self.old_check_address_is_in_file() # self.old_check_address_is_in_file()
self.is_in_file = is_in_file self.is_in_file = is_in_file
if is_in_file == None: #if is_in_file == None and add_to_globals:
self.check_is_in_file() # self.check_is_in_file()
self.address_is_in_file = address_is_in_file self.address_is_in_file = address_is_in_file
if address_is_in_file == None: #if address_is_in_file == None and add_to_globals:
self.check_address_is_in_file() # self.check_address_is_in_file()
all_new_labels.append(self) if add_to_globals:
all_new_labels.append(self)
def check_is_in_file(self): def check_is_in_file(self):
""" This method checks if the label appears in the file """ This method checks if the label appears in the file
@ -5135,6 +5155,15 @@ def line_has_label(line):
return False return False
return True 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): def get_label_from_line(line):
"""returns the label from the line""" """returns the label from the line"""
#check if the line has a label #check if the line has a label