ddnet/datasrc/datatypes.py

436 lines
12 KiB
Python
Raw Normal View History

GlobalIdCounter = 0
def GetID():
global GlobalIdCounter
GlobalIdCounter += 1
return GlobalIdCounter
def GetUID():
2022-07-07 11:55:23 +00:00
return f"x{int(GetID())}"
2010-05-29 07:25:38 +00:00
def FixCasing(Str):
NewStr = ""
NextUpperCase = True
for c in Str:
if NextUpperCase:
NextUpperCase = False
NewStr += c.upper()
else:
if c == "_":
NextUpperCase = True
else:
NewStr += c.lower()
return NewStr
2020-12-02 14:22:26 +00:00
def FormatName(typ, name):
if "*" in typ:
2010-05-29 07:25:38 +00:00
return "m_p" + FixCasing(name)
2020-12-02 14:22:26 +00:00
if "[]" in typ:
2010-05-29 07:25:38 +00:00
return "m_a" + FixCasing(name)
return "m_" + FixCasing(name)
class BaseType:
def __init__(self, type_name):
self._type_name = type_name
self._target_name = "INVALID"
self._id = GetID() # this is used to remember what order the members have in structures etc
2020-12-02 14:22:26 +00:00
def Identifyer(self):
return "x"+str(self._id)
def TargetName(self):
return self._target_name
def TypeName(self):
return self._type_name
def ID(self):
return self._id
def EmitDeclaration(self, name):
2022-07-07 11:55:23 +00:00
return [f"{self.TypeName()} {FormatName(self.TypeName(), name)};"]
def EmitPreDefinition(self, target_name):
self._target_name = target_name
return []
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
return []
class MemberType:
def __init__(self, name, var):
self.name = name
self.var = var
class Struct(BaseType):
def __init__(self, type_name):
BaseType.__init__(self, type_name)
def Members(self):
def sorter(a):
return a.var.ID()
m = []
for name in self.__dict__:
if name[0] == "_":
continue
m += [MemberType(name, self.__dict__[name])]
2020-12-02 14:22:26 +00:00
m.sort(key = sorter)
return m
2020-12-02 14:22:26 +00:00
def EmitTypeDeclaration(self, _name):
lines = []
lines += ["struct " + self.TypeName()]
lines += ["{"]
for member in self.Members():
lines += ["\t"+l for l in member.var.EmitDeclaration(member.name)]
lines += ["};"]
return lines
def EmitPreDefinition(self, target_name):
BaseType.EmitPreDefinition(self, target_name)
lines = []
for member in self.Members():
lines += member.var.EmitPreDefinition(target_name+"."+member.name)
return lines
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
lines = ["/* %s */ {" % self.TargetName()]
for member in self.Members():
lines += ["\t" + " ".join(member.var.EmitDefinition("")) + ","]
lines += ["}"]
return lines
class Array(BaseType):
2020-12-02 14:22:26 +00:00
def __init__(self, typ):
BaseType.__init__(self, typ.TypeName())
self.type = typ
self.items = []
def Add(self, instance):
if instance.TypeName() != self.type.TypeName():
2020-12-02 14:22:26 +00:00
raise "bah"
self.items += [instance]
def EmitDeclaration(self, name):
2022-07-07 11:55:23 +00:00
return [f"int m_Num{FixCasing(name)};",
f"{self.TypeName()} *{FormatName('[]', name)};"]
def EmitPreDefinition(self, target_name):
BaseType.EmitPreDefinition(self, target_name)
lines = []
i = 0
for item in self.items:
2022-07-07 11:55:23 +00:00
lines += item.EmitPreDefinition(f"{self.Identifyer()}[{int(i)}]")
i += 1
2020-12-02 14:22:26 +00:00
if self.items:
2008-09-01 17:30:20 +00:00
lines += ["static %s %s[] = {"%(self.TypeName(), self.Identifyer())]
for item in self.items:
itemlines = item.EmitDefinition("")
lines += ["\t" + " ".join(itemlines).replace("\t", " ") + ","]
lines += ["};"]
else:
2022-07-07 11:55:23 +00:00
lines += [f"static {self.TypeName()} *{self.Identifyer()} = 0;"]
return lines
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
return [str(len(self.items))+","+self.Identifyer()]
# Basic Types
class Int(BaseType):
def __init__(self, value):
BaseType.__init__(self, "int")
self.value = value
def Set(self, value):
self.value = value
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
2022-07-07 11:55:23 +00:00
return [f"{int(self.value)}"]
#return ["%d /* %s */"%(self.value, self._target_name)]
class Float(BaseType):
def __init__(self, value):
BaseType.__init__(self, "float")
self.value = value
def Set(self, value):
self.value = value
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
2022-07-07 11:55:23 +00:00
return [f"{self.value:f}f"]
#return ["%d /* %s */"%(self.value, self._target_name)]
class String(BaseType):
def __init__(self, value):
BaseType.__init__(self, "const char*")
self.value = value
def Set(self, value):
self.value = value
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
return ['"'+self.value+'"']
class Pointer(BaseType):
2020-12-02 14:22:26 +00:00
def __init__(self, typ, target):
2022-07-07 11:55:23 +00:00
BaseType.__init__(self, f"{typ().TypeName()}*")
self.target = target
def Set(self, target):
self.target = target
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
return ["&"+self.target.TargetName()]
class TextureHandle(BaseType):
def __init__(self):
BaseType.__init__(self, "IGraphics::CTextureHandle")
2020-12-02 14:22:26 +00:00
def EmitDefinition(self, _name):
return ["IGraphics::CTextureHandle()"]
# helper functions
def EmitTypeDeclaration(root):
for l in root().EmitTypeDeclaration(""):
print(l)
def EmitDefinition(root, name):
for l in root.EmitPreDefinition(name):
print(l)
2022-07-07 11:55:23 +00:00
print(f"{root.TypeName()} {name} = ")
for l in root.EmitDefinition(name):
print(l)
print(";")
# Network stuff after this
2008-04-27 05:59:38 +00:00
class Object:
pass
2008-10-19 16:50:57 +00:00
class Enum:
2008-04-27 05:59:38 +00:00
def __init__(self, name, values):
self.name = name
self.values = values
2008-10-19 16:50:57 +00:00
class Flags:
2008-08-27 15:51:09 +00:00
def __init__(self, name, values):
self.name = name
self.values = values
2008-04-27 05:59:38 +00:00
class NetObject:
2019-06-13 22:24:50 +00:00
def __init__(self, name, variables, ex=None, validate_size=True):
2008-04-27 05:59:38 +00:00
l = name.split(":")
2010-05-29 07:25:38 +00:00
self.name = l[0]
2008-04-27 05:59:38 +00:00
self.base = ""
if len(l) > 1:
self.base = l[1]
2022-07-07 11:55:23 +00:00
self.base_struct_name = f"CNetObj_{self.base}"
self.struct_name = f"CNetObj_{self.name}"
self.enum_name = f"NETOBJTYPE_{self.name.upper()}"
2008-04-27 05:59:38 +00:00
self.variables = variables
self.ex = ex
2019-06-13 22:24:50 +00:00
self.validate_size = validate_size
2008-04-27 05:59:38 +00:00
def emit_declaration(self):
lines = []
2008-04-27 05:59:38 +00:00
if self.base:
2022-07-07 11:55:23 +00:00
lines += [f"struct {self.struct_name} : public {self.base_struct_name}", "{"]
2008-04-27 05:59:38 +00:00
else:
2022-07-07 11:55:23 +00:00
lines += [f"struct {self.struct_name}", "{"]
2008-04-27 05:59:38 +00:00
for v in self.variables:
lines += ["\t"+line for line in v.emit_declaration()]
lines += ["};"]
return lines
def emit_uncompressed_unpack_and_validate(self, base_item):
lines = []
2022-07-07 11:55:23 +00:00
lines += [f"case {self.enum_name}:"]
2008-04-27 05:59:38 +00:00
lines += ["{"]
2022-07-07 11:55:23 +00:00
lines += [f"\t{self.struct_name} *pData = ({self.struct_name} *)m_aUnpackedData;"]
unpack_lines = []
variables = []
if base_item:
variables += base_item.variables
variables += self.variables
for v in variables:
if not self.validate_size and v.default is None:
raise ValueError(f"{v.name} in {self.name} has no default value. Member variables that do not have a default value cannot be used in a structure whose size is not validated.")
unpack_lines += ["\t"+line for line in v.emit_uncompressed_unpack_obj()]
for v in variables:
unpack_lines += ["\t"+line for line in v.emit_validate_obj()]
if len(unpack_lines) > 0:
lines += unpack_lines
else:
lines += ["\t(void)pData;"]
lines += ["} break;"]
2008-04-27 05:59:38 +00:00
return lines
2008-04-27 05:59:38 +00:00
class NetEvent(NetObject):
def __init__(self, name, variables, ex=None):
NetObject.__init__(self, name, variables, ex=ex)
2022-07-07 11:55:23 +00:00
self.base_struct_name = f"CNetEvent_{self.base}"
self.struct_name = f"CNetEvent_{self.name}"
self.enum_name = f"NETEVENTTYPE_{self.name.upper()}"
2008-04-27 05:59:38 +00:00
class NetMessage(NetObject):
def __init__(self, name, variables, ex=None, teehistorian=True):
NetObject.__init__(self, name, variables, ex=ex)
2022-07-07 11:55:23 +00:00
self.base_struct_name = f"CNetMsg_{self.base}"
self.struct_name = f"CNetMsg_{self.name}"
self.enum_name = f"NETMSGTYPE_{self.name.upper()}"
self.teehistorian = teehistorian
def emit_unpack_msg(self):
lines = []
2022-07-07 11:55:23 +00:00
lines += [f"case {self.enum_name}:"]
lines += ["{"]
2022-07-07 11:55:23 +00:00
lines += [f"\t{self.struct_name} *pData = ({self.struct_name} *)m_aUnpackedData;"]
unpack_lines = []
for v in self.variables:
unpack_lines += ["\t"+line for line in v.emit_unpack_msg()]
for v in self.variables:
unpack_lines += ["\t"+line for line in v.emit_unpack_msg_check()]
if len(unpack_lines) > 0:
lines += unpack_lines
else:
lines += ["\t(void)pData;"]
2010-05-29 07:25:38 +00:00
lines += ["} break;"]
return lines
def emit_declaration(self):
extra = []
2010-05-29 07:25:38 +00:00
extra += ["\tint MsgID() const { return %s; }" % self.enum_name]
extra += ["\t"]
extra += ["\tbool Pack(CMsgPacker *pPacker) const"]
extra += ["\t{"]
2010-05-29 07:25:38 +00:00
#extra += ["\t\tmsg_pack_start(%s, flags);"%self.enum_name]
for v in self.variables:
extra += ["\t\t"+line for line in v.emit_pack()]
2010-05-29 07:25:38 +00:00
extra += ["\t\treturn pPacker->Error() != 0;"]
extra += ["\t}"]
lines = NetObject.emit_declaration(self)
lines = lines[:-1] + extra + lines[-1:]
return lines
class NetObjectEx(NetObject):
2019-06-13 22:24:50 +00:00
def __init__(self, name, ex, variables, validate_size=True):
NetObject.__init__(self, name, variables, ex=ex, validate_size=validate_size)
class NetEventEx(NetEvent):
def __init__(self, name, ex, variables):
NetEvent.__init__(self, name, variables, ex=ex)
class NetMessageEx(NetMessage):
def __init__(self, name, ex, variables, teehistorian=True):
NetMessage.__init__(self, name, variables, ex=ex)
2008-04-27 05:59:38 +00:00
class NetVariable:
def __init__(self, name, default=None):
2008-04-27 05:59:38 +00:00
self.name = name
self.default = None if default is None else str(default)
2008-04-27 05:59:38 +00:00
def emit_declaration(self):
return []
def emit_validate_obj(self):
return []
def emit_uncompressed_unpack_obj(self):
2008-04-27 05:59:38 +00:00
return []
def emit_pack(self):
return []
def emit_unpack_msg(self):
return []
def emit_unpack_msg_check(self):
return []
2008-04-27 05:59:38 +00:00
class NetString(NetVariable):
def emit_declaration(self):
2022-07-07 11:55:23 +00:00
return [f"const char *{self.name};"]
def emit_uncompressed_unpack_obj(self):
return self.emit_unpack_msg()
def emit_unpack_msg(self):
2022-07-07 11:55:23 +00:00
return [f"pData->{self.name} = pUnpacker->GetString();"]
def emit_pack(self):
2022-07-07 11:55:23 +00:00
return [f"pPacker->AddString({self.name}, -1);"]
2008-04-27 05:59:38 +00:00
2014-01-08 17:21:07 +00:00
class NetStringHalfStrict(NetVariable):
def emit_declaration(self):
2022-07-07 11:55:23 +00:00
return [f"const char *{self.name};"]
def emit_uncompressed_unpack_obj(self):
return self.emit_unpack_msg()
def emit_unpack_msg(self):
2022-07-07 11:55:23 +00:00
return [f"pData->{self.name} = pUnpacker->GetString(CUnpacker::SANITIZE_CC);"]
2014-01-08 17:21:07 +00:00
def emit_pack(self):
2022-07-07 11:55:23 +00:00
return [f"pPacker->AddString({self.name}, -1);"]
2014-01-08 17:21:07 +00:00
class NetStringStrict(NetVariable):
def emit_declaration(self):
2022-07-07 11:55:23 +00:00
return [f"const char *{self.name};"]
def emit_uncompressed_unpack_obj(self):
return self.emit_unpack_msg()
def emit_unpack_msg(self):
2022-07-07 11:55:23 +00:00
return [f"pData->{self.name} = pUnpacker->GetString(CUnpacker::SANITIZE_CC|CUnpacker::SKIP_START_WHITESPACES);"]
def emit_pack(self):
2022-07-07 11:55:23 +00:00
return [f"pPacker->AddString({self.name}, -1);"]
2008-04-27 05:59:38 +00:00
class NetIntAny(NetVariable):
def emit_declaration(self):
2022-07-07 11:55:23 +00:00
return [f"int {self.name};"]
def emit_uncompressed_unpack_obj(self):
if self.default is None:
2022-07-07 11:55:23 +00:00
return [f"pData->{self.name} = pUnpacker->GetUncompressedInt();"]
return [f"pData->{self.name} = pUnpacker->GetUncompressedIntOrDefault({self.default});"]
def emit_unpack_msg(self):
if self.default is None:
2022-07-07 11:55:23 +00:00
return [f"pData->{self.name} = pUnpacker->GetInt();"]
return [f"pData->{self.name} = pUnpacker->GetIntOrDefault({self.default});"]
def emit_pack(self):
2022-07-07 11:55:23 +00:00
return [f"pPacker->AddInt({self.name});"]
2008-04-27 05:59:38 +00:00
class NetIntRange(NetIntAny):
def __init__(self, name, min_val, max_val, default=None):
NetIntAny.__init__(self,name,default=default)
2020-12-02 14:22:26 +00:00
self.min = str(min_val)
self.max = str(max_val)
def emit_validate_obj(self):
2022-07-07 11:55:23 +00:00
return [f"pData->{self.name} = ClampInt(\"{self.name}\", pData->{self.name}, {self.min}, {self.max});"]
def emit_unpack_msg_check(self):
return ["if(pData->%s < %s || pData->%s > %s) { m_pMsgFailedOn = \"%s\"; break; }" % (self.name, self.min, self.name, self.max, self.name)]
2008-04-27 05:59:38 +00:00
class NetBool(NetIntRange):
def __init__(self, name, default=None):
default = None if default is None else int(default)
NetIntRange.__init__(self,name,0,1,default=default)
2008-04-27 05:59:38 +00:00
2014-09-12 10:13:46 +00:00
class NetTick(NetIntAny):
def __init__(self, name, default=None):
NetIntAny.__init__(self,name,default=default)
2022-02-12 21:41:16 +00:00
class NetArray(NetVariable):
def __init__(self, var, size):
NetVariable.__init__(self,var.name,var.default)
2022-02-12 21:41:16 +00:00
self.base_name = var.name
self.var = var
self.size = size
2022-07-07 11:55:23 +00:00
self.name = self.base_name + f"[{int(self.size)}]"
2022-02-12 21:41:16 +00:00
def emit_declaration(self):
self.var.name = self.name
return self.var.emit_declaration()
def emit_uncompressed_unpack_obj(self):
lines = []
for i in range(self.size):
2022-07-07 11:55:23 +00:00
self.var.name = self.base_name + f"[{int(i)}]"
lines += self.var.emit_uncompressed_unpack_obj()
return lines
def emit_validate_obj(self):
2022-02-12 21:41:16 +00:00
lines = []
for i in range(self.size):
2022-07-07 11:55:23 +00:00
self.var.name = self.base_name + f"[{int(i)}]"
lines += self.var.emit_validate_obj()
2022-02-12 21:41:16 +00:00
return lines
def emit_unpack_msg(self):
2022-02-12 21:41:16 +00:00
lines = []
for i in range(self.size):
2022-07-07 11:55:23 +00:00
self.var.name = self.base_name + f"[{int(i)}]"
lines += self.var.emit_unpack_msg()
2022-02-12 21:41:16 +00:00
return lines
def emit_pack(self):
lines = []
for i in range(self.size):
2022-07-07 11:55:23 +00:00
self.var.name = self.base_name + f"[{int(i)}]"
2022-02-12 21:41:16 +00:00
lines += self.var.emit_pack()
return lines
def emit_unpack_msg_check(self):
2022-02-12 21:41:16 +00:00
lines = []
for i in range(self.size):
2022-07-07 11:55:23 +00:00
self.var.name = self.base_name + f"[{int(i)}]"
lines += self.var.emit_unpack_msg_check()
2022-02-12 21:41:16 +00:00
return lines