1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
|
"""
Generate address space c++ code from xml file specification
"""
import sys
from copy import copy
import xml.etree.ElementTree as ET
# from IPython import embed
NeedOverride = []
NeedConstructor = []#["RelativePathElement", "ReadValueId", "OpenSecureChannelParameters", "UserIdentityToken", "RequestHeader", "ResponseHeader", "ReadParameters", "UserIdentityToken", "BrowseDescription", "ReferenceDescription", "CreateSubscriptionParameters", "PublishResult", "NotificationMessage", "SetPublishingModeParameters"]
IgnoredEnums = []#["IdType", "NodeIdType"]
#we want to implement som struct by hand, to make better interface or simply because they are too complicated
IgnoredStructs = []#["NodeId", "ExpandedNodeId", "Variant", "QualifiedName", "DataValue", "LocalizedText"]#, "ExtensionObject"]
#by default we split requests and respons in header and parameters, but some are so simple we do not split them
NoSplitStruct = ["GetEndpointsResponse", "CloseSessionRequest", "AddNodesResponse", "DeleteNodesResponse", "BrowseResponse", "HistoryReadResponse", "HistoryUpdateResponse", "RegisterServerResponse", "CloseSecureChannelRequest", "CloseSecureChannelResponse", "CloseSessionRequest", "CloseSessionResponse", "UnregisterNodesResponse", "MonitoredItemModifyRequest", "MonitoredItemsCreateRequest", "ReadResponse", "WriteResponse", "TranslateBrowsePathsToNodeIdsResponse", "DeleteSubscriptionsResponse", "DeleteMonitoredItemsResponse", "CreateMonitoredItemsResponse", "ServiceFault", "AddReferencesResponse", "ModifyMonitoredItemsResponse", "RepublishResponse", "CallResponse", "FindServersResponse", "RegisterServerRequest", "RegisterServer2Response"]
#structs that end with Request or Response but are not
NotRequest = ["MonitoredItemCreateRequest", "MonitoredItemModifyRequest", "CallMethodRequest"]
OverrideTypes = {}#AttributeId": "AttributeID", "ResultMask": "BrowseResultMask", "NodeClassMask": "NodeClass", "AccessLevel": "VariableAccessLevel", "UserAccessLevel": "VariableAccessLevel", "NotificationData": "NotificationData"}
OverrideNames = {}#{"RequestHeader": "Header", "ResponseHeader": "Header", "StatusCode": "Status", "NodesToRead": "AttributesToRead"} # "MonitoringMode": "Mode",, "NotificationMessage": "Notification", "NodeIdType": "Type"}
#some object are defined in extensionobjects in spec but seems not to be in reality
#in addition to this list all request and response and descriptions will not inherit
#NoInherit = ["RequestHeader", "ResponseHeader", "ChannelSecurityToken", "UserTokenPolicy", "SignatureData", "BrowseResult", "ReadValueId", "WriteValue", "BrowsePath", "BrowsePathTarget", "RelativePath", "RelativePathElement", "BrowsePathResult"]#, "ApplicationDescription", "EndpointDescription"
class Bit(object):
def __init__(self):
self.name = None
self.idx = None
self.container = None
self.length = 1
def __str__(self):
return "(Bit: {0}, container:{1}, idx:{2})".format(self.name, self.container, self.idx)
__repr__ = __str__
class Struct(object):
def __init__(self):
self.name = None
self.basetype = None
self.doc = ""
self.fields = []
self.bits = {}
self.needconstructor = None
self.needoverride = False
self.children = []
self.parents = []
self.extensionobject = False #used for struct which are not pure extension objects
def get_field(self, name):
for f in self.fields:
if f.name == name:
return f
raise Exception("field not found: " + name)
def __str__(self):
return "Struct {0}:{1}".format(self.name, self.basetype)
__repr__ = __str__
class Field(object):
def __init__(self):
self.name = None
self.uatype = None
self.length = None
self.sourcetype = None
self.switchfield = None
self.switchvalue = None
self.bitlength = 1
def __str__(self):
return "Field {0}({1})".format(self.name, self.uatype)
__repr__ = __str__
def is_native_type(self):
if self.uatype in ("Char", "SByte", "Int16", "Int32", "Int64", "UInt16", "UInt32", "UInt64", "Boolean", "Double", "Float", "Byte", "String", "CharArray", "ByteString", "DateTime"):
return True
return False
class Enum(object):
def __init__(self):
self.name = None
self.uatype = None
self.values = []
self.doc = ""
def get_ctype(self):
return "uint{0}_t".format(self.uatype)
class EnumValue(object):
def __init__(self):
self.name = None
self.value = None
class Model(object):
def __init__(self):
self.structs = []
self.enums = []
self.struct_list = []
self.enum_list = []
def get_struct(self, name):
for struct in self.structs:
if name == struct.name:
return struct
raise Exception("No struct named: " + str(name))
def get_enum(self, name):
for s in self.enums:
if name == s.name:
return s
raise Exception("No enum named: " + str(name))
def reorder_structs(model):
types = IgnoredStructs + IgnoredEnums + ["Bit", "Char", "CharArray", "Guid", "SByte", "Int16", "Int32", "Int64", "UInt16", "UInt32", "UInt64", "DateTime", "Boolean", "Double", "Float", "ByteString", "Byte", "StatusCode", "DiagnosticInfo", "String", "AttributeID"] + [enum.name for enum in model.enums] + ["VariableAccessLevel"]
waiting = {}
newstructs = []
for s in model.structs:
types.append(s.name)
s.waitingfor = []
ok = True
for f in s.fields:
if f.uatype not in types:
if f.uatype in waiting.keys():
waiting[f.uatype].append(s)
s.waitingfor.append(f.uatype)
else:
waiting[f.uatype] = [s]
s.waitingfor.append(f.uatype)
ok = False
if ok:
newstructs.append(s)
waitings = waiting.pop(s.name, None)
if waitings:
for s2 in waitings:
s2.waitingfor.remove(s.name)
if not s2.waitingfor:
newstructs.append(s2)
if len(model.structs) != len(newstructs):
print("Error while reordering structs, some structs could not be reinserted, had {0} structs, we now have {1} structs".format(len(model.structs), len(newstructs)))
s1 = set(model.structs)
s2 = set(newstructs)
rest = s1 -s2
print("Variant" in types)
for s in s1-s2:
print("{0} is waiting for: {1}".format(s, s.waitingfor))
#print(s1 -s2)
#print(waiting)
model.structs = newstructs
def override_types(model):
for struct in model.structs:
for field in struct.fields:
if field.name in OverrideTypes.keys():
field.uatype = OverrideTypes[field.name]
def remove_duplicates(model):
for struct in model.structs:
fields = []
names = []
for field in struct.fields:
if field.name not in names:
names.append(field.name)
fields.append(field)
struct.fields = fields
def add_encoding_field(model):
for struct in model.structs:
newfields = []
container = None
idx = 0
for field in struct.fields:
if field.uatype in ("UInt6", "NodeIdType"):
container = field.name
b = Bit()
b.name = field.name
b.idx = 0
b.container = container
b.length = 6
idx = b.length
struct.bits[b.name] = b
if field.uatype == "Bit":
if not container or idx > 7:
container = "Encoding"
idx = 0
f = Field()
f.sourcetype = field.sourcetype
f.name = "Encoding"
f.uatype = "Byte"
newfields.append(f)
b = Bit()
b.name = field.name
b.idx = idx
b.container = container
b.length = field.bitlength
idx += field.bitlength
struct.bits[b.name] = b
else:
newfields.append(field)
struct.fields = newfields
def remove_vector_length(model):
for struct in model.structs:
new = []
for field in struct.fields:
if not field.name.startswith("NoOf") and field.name != "Length":
new.append(field)
struct.fields = new
def remove_body_length(model):
for struct in model.structs:
new = []
for field in struct.fields:
if not field.name == "BodyLength":
new.append(field)
struct.fields = new
def remove_duplicate_types(model):
for struct in model.structs:
for field in struct.fields:
if field.uatype == "CharArray":
field.uatype = "String"
#def remove_extensionobject_fields(model):
#for obj in model.structs:
#if obj.name.endswith("Request") or obj.name.endswith("Response"):
#obj.fields = [el for el in obj.fields if el.name not in ("TypeId", "Body", "Encoding")]
def split_requests(model):
structs = []
for struct in model.structs:
structtype = None
if struct.name.endswith("Request") and not struct.name in NotRequest:
structtype = "Request"
elif struct.name.endswith("Response") or struct.name == "ServiceFault":
structtype = "Response"
if structtype:
#for field in struct.fields:
#if field.name == "Encoding":
#struct.fields.remove(field)
#break
#for field in struct.fields:
#if field.name == "BodyLength":
#struct.fields.remove(field)
#break
struct.needconstructor = True
field = Field()
field.name = "TypeId"
field.uatype = "NodeId"
struct.fields.insert(0, field)
if structtype and not struct.name in NoSplitStruct:
paramstruct = Struct()
if structtype == "Request":
basename = struct.name.replace("Request", "") + "Parameters"
paramstruct.name = basename
else:
basename = struct.name.replace("Response", "") + "Result"
paramstruct.name = basename
paramstruct.fields = struct.fields[2:]
paramstruct.bits = struct.bits
struct.fields = struct.fields[:2]
#struct.bits = {}
structs.append(paramstruct)
typeid = Field()
typeid.name = "Parameters"
typeid.uatype = paramstruct.name
struct.fields.append(typeid)
structs.append(struct)
model.structs = structs
class Parser(object):
def __init__(self, path):
self.path = path
self.model = None
def parse(self):
print("Parsing: ", self.path)
self.model = Model()
tree = ET.parse(self.path)
root = tree.getroot()
self.add_extension_object()
self.add_data_type_definition()
for child in root:
tag = child.tag[40:]
if tag == "StructuredType":
struct = self.parse_struct(child)
if struct.name != "ExtensionObject":
self.model.structs.append(struct)
self.model.struct_list.append(struct.name)
elif tag == "EnumeratedType":
enum = self.parse_enum(child)
self.model.enums.append(enum)
self.model.enum_list.append(enum.name)
#else:
#print("Not implemented node type: " + tag + "\n")
return self.model
def add_extension_object(self):
obj = Struct()
obj.name = "ExtensionObject"
f = Field()
f.name = "TypeId"
f.uatype = "NodeId"
obj.fields.append(f)
f = Field()
f.name = "BinaryBody"
f.uatype = "Bit"
obj.fields.append(f)
f = Field()
f.name = "XmlBody"
f.uatype = "Bit"
obj.fields.append(f)
f = Field()
f.name = "Body"
f.uatype = "ByteString"
f.switchfield = "BinaryBody"
obj.fields.append(f)
self.model.struct_list.append(obj.name)
self.model.structs.append(obj)
def add_data_type_definition(self):
obj = Struct()
obj.name = "DataTypeDefinition"
self.model.struct_list.append(obj.name)
self.model.structs.append(obj)
def parse_struct(self, child):
tag = child.tag[40:]
struct = Struct()
for key, val in child.attrib.items():
if key == "Name":
struct.name = val
elif key == "BaseType":
if ":" in val:
prefix, val = val.split(":")
struct.basetype = val
tmp = struct
while tmp.basetype:
struct.parents.append(tmp.basetype)
tmp = self.model.get_struct(tmp.basetype)
else:
print("Error unknown key: ", key)
for el in child:
tag = el.tag[40:]
if tag == "Field":
field = Field()
for key, val in el.attrib.items():
if key == "Name":
field.name = val
elif key == "TypeName":
field.uatype = val.split(":")[1]
elif key == "LengthField":
field.length = val
elif key == "SourceType":
field.sourcetype = val
elif key == "SwitchField":
field.switchfield = val
elif key == "SwitchValue":
field.switchvalue = val
elif key == "Length":
field.bitlength = int(val)
else:
print("Unknown field item: ", struct.name, key)
struct.fields.append(field)
elif tag == "Documentation":
struct.doc = el.text
else:
print("Unknown tag: ", tag)
return struct
def parse_enum(self, child):
tag = child.tag[40:]
enum = Enum()
for k, v in child.items():
if k == "Name":
enum.name = v
elif k == "LengthInBits":
enum.uatype = "UInt" + v
else:
print("Unknown attr for enum: ", k)
for el in child:
tag = el.tag[40:]
if tag == "EnumeratedValue":
ev = EnumValue()
for k, v in el.attrib.items():
if k == "Name":
ev.name = v
elif k == "Value":
ev.value = v
else:
print("Unknown field attrib: ", k)
enum.values.append(ev)
elif tag == "Documentation":
enum.doc = el.text
else:
print("Unknown enum tag: ", tag)
return enum
#"def reorder_extobjects(model):
#ext = model.get_struct("ExtensionObject")
#print(ext)
#typeid = ext.fields[4]
#ext.fields.remove(typeid)
#ext.fields.insert(0, typeid)
def add_basetype_members(model):
for struct in model.structs:
if not struct.basetype:
continue
emptystruct = False
if len(struct.fields) == 0:
emptystruct = True
if struct.basetype in ("ExtensionObject"):
struct.basetype = None
continue
base = model.get_struct(struct.basetype)
#if struct.basetype == "ExtensionObject" and len(struct.fields) != 0:
#if struct.basetype == "ExtensionObject" and len(struct.fields) != 0:
#if struc
#for f in base.fields:
#if f.name == "TypeId":
#f2 = copy(f)
#f2.switchfield = None
#struct.fields.insert(0, f2)
#break
#continue
for name, bit in base.bits.items():
struct.bits[name] = bit
for idx, field in enumerate(base.fields):
field = copy(field)
if field.name == "Body" and not emptystruct:
#print("Field is names Body", struct.name, field.name)
struct.extensionobject = True
field.name = "BodyLength"
field.uatype = "Int32"
field.length = None
field.switchfield = None
#print("Field is names Body 2", struct.name, field.name)
#HACK EXTENSIONOBJECT
#if base.name == "ExtensionObject":
#continue
#if field.uatype == "Bit":
#continue
#if field.name == "Body":
#continue
#if field.name == "TypeId":
#field.switchfield = None
#END HACK
if not field.sourcetype:
field.sourcetype = base.name
struct.fields.insert(idx, field)
def fix_names(model):
for s in model.enums:
for f in s.values:
if f.name == "None":
f.name = "None_"
|