generate_datatypes.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600
  1. from __future__ import print_function
  2. import sys
  3. import time
  4. import platform
  5. import getpass
  6. from collections import OrderedDict
  7. import re
  8. from lxml import etree
  9. import itertools
  10. import argparse
  11. from pprint import pprint
  12. fixed_size = {"UA_Boolean": 1, "UA_SByte": 1, "UA_Byte": 1, "UA_Int16": 2, "UA_UInt16": 2,
  13. "UA_Int32": 4, "UA_UInt32": 4, "UA_Int64": 8, "UA_UInt64": 8, "UA_Float": 4,
  14. "UA_Double": 8, "UA_DateTime": 8, "UA_Guid": 16, "UA_StatusCode": 4}
  15. zero_copy = ["UA_Boolean", "UA_SByte", "UA_Byte", "UA_Int16", "UA_UInt16", "UA_Int32", "UA_UInt32",
  16. "UA_Int64", "UA_UInt64", "UA_Float", "UA_Double", "UA_DateTime", "UA_StatusCode"]
  17. # The order of the builtin-types is not as in the standard. We put all the
  18. # fixed_size types in the front, so they can be distinguished by a simple geq
  19. # comparison. That's ok, since we use the type-index only internally!!
  20. builtin_types = ["UA_Boolean", "UA_SByte", "UA_Byte", "UA_Int16", "UA_UInt16",
  21. "UA_Int32", "UA_UInt32", "UA_Int64", "UA_UInt64", "UA_Float",
  22. "UA_Double", "UA_String", "UA_DateTime", "UA_Guid", "UA_ByteString",
  23. "UA_XmlElement", "UA_NodeId", "UA_ExpandedNodeId", "UA_StatusCode",
  24. "UA_QualifiedName", "UA_LocalizedText", "UA_ExtensionObject", "UA_DataValue",
  25. "UA_Variant", "UA_DiagnosticInfo"]
  26. excluded_types = ["UA_NodeIdType", "UA_InstanceNode", "UA_TypeNode", "UA_Node", "UA_ObjectNode",
  27. "UA_ObjectTypeNode", "UA_VariableNode", "UA_VariableTypeNode", "UA_ReferenceTypeNode",
  28. "UA_MethodNode", "UA_ViewNode", "UA_DataTypeNode", "UA_ServerDiagnosticsSummaryDataType",
  29. "UA_SamplingIntervalDiagnosticsDataType", "UA_SessionSecurityDiagnosticsDataType",
  30. "UA_SubscriptionDiagnosticsDataType", "UA_SessionDiagnosticsDataType"]
  31. minimal_types = ["InvalidType", "Node", "NodeClass", "ReferenceNode", "ApplicationDescription", "ApplicationType",
  32. "ChannelSecurityToken", "OpenSecureChannelRequest", "OpenSecureChannelResponse",
  33. "CloseSecureChannelRequest", "CloseSecureChannelResponse", "RequestHeader", "ResponseHeader",
  34. "SecurityTokenRequestType", "MessageSecurityMode", "CloseSessionResponse", "CloseSessionRquest",
  35. "ActivateSessionRequest", "ActivateSessionResponse", "SignatureData", "SignedSoftwareCertificate",
  36. "CreateSessionResponse", "CreateSessionRequest", "EndpointDescription", "UserTokenPolicy", "UserTokenType",
  37. "GetEndpointsRequest", "GetEndpointsResponse", "PublishRequest", "PublishResponse", "FindServersRequest", "FindServersResponse",
  38. "SetPublishingModeResponse", "SubscriptionAcknowledgement", "NotificationMessage", "ExtensionObject",
  39. "Structure", "ReadRequest", "ReadResponse", "ReadValueId", "TimestampsToReturn", "WriteRequest",
  40. "WriteResponse", "WriteValue", "SetPublishingModeRequest", "CreateMonitoredItemsResponse",
  41. "MonitoredItemCreateResult", "CreateMonitoredItemsRequest", "MonitoredItemCreateRequest",
  42. "MonitoringMode", "MonitoringParameters", "TranslateBrowsePathsToNodeIdsRequest",
  43. "TranslateBrowsePathsToNodeIdsResponse", "BrowsePath", "BrowsePathResult", "RelativePath",
  44. "BrowsePathTarget", "RelativePathElement", "CreateSubscriptionRequest", "CreateSubscriptionResponse",
  45. "BrowseResponse", "BrowseResult", "ReferenceDescription", "BrowseRequest", "ViewDescription",
  46. "BrowseNextRequest", "BrowseNextResponse", "DeleteSubscriptionsRequest", "DeleteSubscriptionsResponse",
  47. "BrowseDescription", "BrowseDirection", "CloseSessionRequest", "AddNodesRequest", "AddNodesResponse",
  48. "AddNodesItem", "AddNodesResult", "DeleteNodesItem","AddReferencesRequest", "AddReferencesResponse",
  49. "AddReferencesItem","DeleteReferencesItem", "VariableNode", "MethodNode", "VariableTypeNode",
  50. "ViewNode", "ReferenceTypeNode", "BrowseResultMask", "ServerState", "ServerStatusDataType", "BuildInfo",
  51. "ObjectNode", "DataTypeNode", "ObjectTypeNode", "IdType", "VariableAttributes", "ObjectAttributes",
  52. "NodeAttributes","ReferenceTypeAttributes", "ViewAttributes", "ObjectTypeAttributes",
  53. "NodeAttributesMask","DeleteNodesItem", "DeleteNodesRequest", "DeleteNodesResponse",
  54. "DeleteReferencesItem", "DeleteReferencesRequest", "DeleteReferencesResponse",
  55. "RegisterNodesRequest", "RegisterNodesResponse", "UnregisterNodesRequest", "UnregisterNodesResponse",
  56. "UserIdentityToken", "UserNameIdentityToken", "AnonymousIdentityToken", "ServiceFault",
  57. "CallMethodRequest", "CallMethodResult", "CallResponse", "CallRequest", "Argument"]
  58. subscription_types = ["DeleteMonitoredItemsRequest", "DeleteMonitoredItemsResponse", "NotificationMessage",
  59. "MonitoredItemNotification", "DataChangeNotification", "ModifySubscriptionRequest",
  60. "ModifySubscriptionResponse"]
  61. class TypeDescription(object):
  62. def __init__(self, name, nodeid, namespaceid):
  63. self.name = name # without the UA_ prefix
  64. self.nodeid = nodeid
  65. self.namespaceid = namespaceid
  66. def parseTypeDescriptions(filename, namespaceid):
  67. definitions = {}
  68. f = open(filename[0])
  69. input_str = f.read()
  70. f.close()
  71. input_str = input_str.replace('\r','')
  72. rows = map(lambda x:tuple(x.split(',')), input_str.split('\n'))
  73. for index, row in enumerate(rows):
  74. if len(row) < 3:
  75. continue
  76. if row[2] != "DataType":
  77. continue
  78. if row[0] == "BaseDataType":
  79. definitions["UA_Variant"] = TypeDescription(row[0], row[1], namespaceid)
  80. elif row[0] == "Structure":
  81. definitions["UA_ExtensionObject"] = TypeDescription(row[0], row[1], namespaceid)
  82. else:
  83. definitions["UA_" + row[0]] = TypeDescription(row[0], row[1], namespaceid)
  84. return definitions
  85. class BuiltinType(object):
  86. "Generic type without members. Used for builtin types."
  87. def __init__(self, name, description = ""):
  88. self.name = name
  89. self.description = description
  90. def fixed_size(self):
  91. return self.name in fixed_size
  92. def mem_size(self):
  93. return fixed_size[self.name]
  94. def zero_copy(self):
  95. return self.name in zero_copy
  96. def typedef_c(self):
  97. pass
  98. def typelayout_c(self, namespace_0, description, outname):
  99. if description == None:
  100. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  101. else:
  102. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % \
  103. (description.namespaceid, description.nodeid)
  104. if self.name in ["UA_String", "UA_ByteString", "UA_XmlElement"]:
  105. return "{.typeId = " + typeid + \
  106. ".memSize = sizeof(" + self.name + "), " + \
  107. ".namespaceZero = UA_TRUE, .fixedSize = UA_FALSE, .zeroCopyable = UA_FALSE, " + \
  108. ".membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_BYTE, .namespaceZero = UA_TRUE, " + \
  109. ".padding = offsetof(UA_String, data) - sizeof(UA_Int32), .isArray = UA_TRUE }}, " + \
  110. ".typeIndex = %s }" % (outname.upper() + "_" + self.name[3:].upper())
  111. if self.name == "UA_QualifiedName":
  112. return "{.typeId = " + typeid + \
  113. ".memSize = sizeof(UA_QualifiedName), " + \
  114. ".namespaceZero = UA_TRUE, .fixedSize = UA_FALSE, .zeroCopyable = UA_FALSE, " + \
  115. ".membersSize = 2, .members = {" + \
  116. "\n\t{.memberTypeIndex = UA_TYPES_UINT16, .namespaceZero = UA_TRUE, " + \
  117. ".padding = 0, .isArray = UA_FALSE }," + \
  118. "\n\t{.memberTypeIndex = UA_TYPES_STRING, .namespaceZero = UA_TRUE, " + \
  119. ".padding = offsetof(UA_QualifiedName, name) - sizeof(UA_UInt16), .isArray = UA_FALSE }},\n" + \
  120. ".typeIndex = UA_TYPES_QUALIFIEDNAME }"
  121. return "{.typeId = " + typeid + \
  122. ".memSize = sizeof(" + self.name + "), " + \
  123. ".namespaceZero = UA_TRUE, " + \
  124. ".fixedSize = " + ("UA_TRUE" if self.fixed_size() else "UA_FALSE") + \
  125. ", .zeroCopyable = " + ("UA_TRUE" if self.zero_copy() else "UA_FALSE") + \
  126. ", .membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_" + self.name[3:].upper() + "," + \
  127. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, " + \
  128. ".typeIndex = %s }" % (outname.upper() + "_" + self.name[3:].upper())
  129. class EnumerationType(object):
  130. def __init__(self, name, description = "", elements = OrderedDict()):
  131. self.name = name
  132. self.description = description
  133. self.elements = elements # maps a name to an integer value
  134. def append_enum(name, value):
  135. self.elements[name] = value
  136. def fixed_size(self):
  137. return True
  138. def mem_size(self):
  139. return 4
  140. def zero_copy(self):
  141. return True
  142. def typedef_c(self):
  143. if sys.version_info[0] < 3:
  144. values = self.elements.iteritems()
  145. else:
  146. values = self.elements.items()
  147. return "typedef enum { \n " + \
  148. ",\n ".join(map(lambda kv : kv[0].upper() + " = " + kv[1], values)) + \
  149. "\n} " + self.name + ";"
  150. def typelayout_c(self, namespace_0, description, outname):
  151. if description == None:
  152. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  153. else:
  154. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  155. return "{.typeId = " + typeid + \
  156. ".memSize = sizeof(" + self.name + "), " +\
  157. ".namespaceZero = UA_TRUE, " + \
  158. ".fixedSize = UA_TRUE, .zeroCopyable = UA_TRUE, " + \
  159. ".membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_INT32," + \
  160. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, .typeIndex = UA_TYPES_INT32 }"
  161. def functions_c(self, typeTableName):
  162. return '''static UA_INLINE %s * %s_new(void) { %s *v = (%s*)UA_Int32_new(); return v; }
  163. static UA_INLINE void %s_init(%s *p) { UA_Int32_init((UA_Int32*)p); }
  164. static UA_INLINE void %s_delete(%s *p) { UA_Int32_delete((UA_Int32*)p); }
  165. static UA_INLINE void %s_deleteMembers(%s *p) { }
  166. static UA_INLINE UA_StatusCode %s_copy(const %s *src, %s *dst) { return UA_Int32_copy((const UA_Int32*)src, (UA_Int32*)dst); }''' % tuple(itertools.repeat(self.name, 13))
  167. def encoding_h(self, typeTableName):
  168. return '''static UA_INLINE UA_StatusCode %s_encodeBinary(const %s *src, UA_ByteString *dst, size_t *offset) { return UA_Int32_encodeBinary((const UA_Int32*)src, dst, offset); }
  169. static UA_INLINE UA_StatusCode %s_decodeBinary(const UA_ByteString *src, size_t *offset, %s *dst) { return UA_Int32_decodeBinary(src, offset, (UA_Int32*)dst); }''' % tuple(itertools.repeat(self.name, 4))
  170. class OpaqueType(object):
  171. def __init__(self, name, description = ""):
  172. self.name = name
  173. self.description = description
  174. def fixed_size(self):
  175. return False
  176. def zero_copy(self):
  177. return False
  178. def typedef_c(self):
  179. return "typedef UA_ByteString " + self.name + ";"
  180. def typelayout_c(self, namespace_0, description, outname):
  181. if description == None:
  182. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  183. else:
  184. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  185. return "{.typeId = " + typeid + \
  186. ".memSize = sizeof(" + self.name + "), .fixedSize = UA_FALSE, .zeroCopyable = UA_FALSE, " + \
  187. ".namespaceZero = UA_TRUE, .membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_BYTESTRING," + \
  188. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, .typeIndex = UA_TYPES_BYTESTRING }"
  189. def functions_c(self, typeTableName):
  190. return '''static UA_INLINE %s * %s_new(void) { %s *v = (%s*)UA_ByteString_new(); return v; }
  191. static UA_INLINE void %s_init(%s *p) { UA_ByteString_init((UA_ByteString*)p); }
  192. static UA_INLINE void %s_delete(%s *p) { UA_ByteString_delete((UA_ByteString*)p); }
  193. static UA_INLINE void %s_deleteMembers(%s *p) { }
  194. static UA_INLINE UA_StatusCode %s_copy(const %s *src, %s *dst) { return UA_ByteString_copy((const UA_ByteString*)src, (UA_ByteString*)dst); }''' % tuple(itertools.repeat(self.name, 13))
  195. def encoding_h(self, typeTableName):
  196. return '''static UA_INLINE UA_StatusCode %s_encodeBinary(const %s *src, UA_ByteString *dst, size_t *offset) { return UA_ByteString_encodeBinary((UA_ByteString*)src, dst, offset); }
  197. static UA_INLINE UA_StatusCode %s_decodeBinary(const UA_ByteString *src, size_t *offset, %s *dst) { return UA_ByteString_decodeBinary(src, offset, (UA_ByteString*)dst); }''' % tuple(itertools.repeat(self.name, 4))
  198. class StructMember(object):
  199. def __init__(self, name, memberType, isArray):
  200. self.name = name
  201. self.memberType = memberType
  202. self.isArray = isArray
  203. class StructType(object):
  204. def __init__(self, name, description, members = OrderedDict()):
  205. self.name = name
  206. self.description = description
  207. self.members = members # maps a name to a member definition
  208. def fixed_size(self):
  209. for m in self.members.values():
  210. if m.isArray or not m.memberType.fixed_size():
  211. return False
  212. return True
  213. def mem_size(self):
  214. total = 0
  215. for m in self.members.values():
  216. if m.isArray:
  217. raise Exception("Arrays have no fixed size!")
  218. else:
  219. total += m.memberType.mem_size()
  220. return total
  221. def zero_copy(self):
  222. for m in self.members.values():
  223. if m.isArray or not m.memberType.zero_copy():
  224. return False
  225. return True
  226. def typedef_c(self):
  227. if len(self.members) == 0:
  228. return "typedef void * " + self.name + ";"
  229. returnstr = "typedef struct {\n"
  230. if sys.version_info[0] < 3:
  231. values = self.members.iteritems()
  232. else:
  233. values = self.members.items()
  234. for name, member in values:
  235. if member.isArray:
  236. returnstr += " UA_Int32 " + name + "Size;\n"
  237. returnstr += " " + member.memberType.name + " *" +name + ";\n"
  238. else:
  239. returnstr += " " + member.memberType.name + " " +name + ";\n"
  240. return returnstr + "} " + self.name + ";"
  241. def typelayout_c(self, namespace_0, description, outname):
  242. if description == None:
  243. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  244. else:
  245. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  246. layout = "{.typeId = "+ typeid + \
  247. ".memSize = sizeof(" + self.name + "), "+ \
  248. ".namespaceZero = " + ("UA_TRUE" if namespace_0 else "UA_FALSE") + \
  249. ", .fixedSize = " + ("UA_TRUE" if self.fixed_size() else "UA_FALSE") + \
  250. ", .zeroCopyable = " + ("sizeof(" + self.name + ") == " + str(self.mem_size()) if self.zero_copy() \
  251. else "UA_FALSE") + \
  252. ", .typeIndex = " + outname.upper() + "_" + self.name[3:].upper() + \
  253. ", .membersSize = " + str(len(self.members)) + ","
  254. if len(self.members) > 0:
  255. layout += "\n\t.members={"
  256. for index, member in enumerate(self.members.values()):
  257. layout += "\n\t{" + \
  258. ".memberTypeIndex = " + ("UA_TYPES_" + member.memberType.name[3:].upper() if args.namespace_id == 0 or member.memberType.name in existing_types else \
  259. outname.upper() + "_" + member.memberType.name[3:].upper()) + ", " + \
  260. ".namespaceZero = "+ \
  261. ("UA_TRUE, " if args.namespace_id == 0 or member.memberType.name in existing_types else "UA_FALSE, ") + \
  262. ".padding = "
  263. before_endpos = "0"
  264. thispos = "offsetof(%s, %s)" % (self.name, member.name)
  265. if index > 0:
  266. if sys.version_info[0] < 3:
  267. before = self.members.values()[index-1]
  268. else:
  269. before = list(self.members.values())[index-1]
  270. before_endpos = "(offsetof(%s, %s)" % (self.name, before.name)
  271. if before.isArray:
  272. before_endpos += " + sizeof(void*))"
  273. else:
  274. before_endpos += " + sizeof(%s))" % before.memberType.name
  275. if member.isArray:
  276. # the first two bytes are padding for the length index, the last three for the pointer
  277. length_pos = "offsetof(%s, %sSize)" % (self.name, member.name)
  278. if index != 0:
  279. layout += "((%s - %s) << 3) + " % (length_pos, before_endpos)
  280. layout += "(%s - sizeof(UA_Int32) - %s)" % (thispos, length_pos)
  281. else:
  282. layout += "%s - %s" % (thispos, before_endpos)
  283. layout += ", .isArray = " + ("UA_TRUE" if member.isArray else "UA_FALSE") + " }, "
  284. layout += "}"
  285. return layout + "}"
  286. def functions_c(self, typeTableName):
  287. return '''static UA_INLINE %s * %s_new(void) { return UA_new(%s); }
  288. static UA_INLINE void %s_init(%s *p) { UA_init(p, %s); }
  289. static UA_INLINE void %s_delete(%s *p) { UA_delete(p, %s); }
  290. static UA_INLINE void %s_deleteMembers(%s *p) { UA_deleteMembers(p, %s); }
  291. static UA_INLINE UA_StatusCode %s_copy(const %s *src, %s *dst) { return UA_copy(src, dst, %s); }''' % \
  292. tuple(list(itertools.chain(*itertools.repeat([self.name, self.name, "&"+typeTableName+"[" + typeTableName + "_" + self.name[3:].upper()+"]"], 4)))
  293. + [self.name, self.name, self.name, "&"+typeTableName+"[" + typeTableName + "_" + self.name[3:].upper()+"]"])
  294. def encoding_h(self, typeTableName):
  295. return '''static UA_INLINE UA_StatusCode %s_encodeBinary(const %s *src, UA_ByteString *dst, size_t *offset) { return UA_encodeBinary(src, %s, dst, offset); }
  296. static UA_INLINE UA_StatusCode %s_decodeBinary(const UA_ByteString *src, size_t *offset, %s *dst) { return UA_decodeBinary(src, offset, dst, %s); }''' % \
  297. tuple(list(itertools.chain(*itertools.repeat([self.name, self.name, "&"+typeTableName+"[" + typeTableName + "_" + self.name[3:].upper()+"]"], 2))))
  298. def parseTypeDefinitions(xmlDescription, existing_types = OrderedDict()):
  299. '''Returns an ordered dict that maps names to types. The order is such that
  300. every type depends only on known types. '''
  301. ns = {"opc": "http://opcfoundation.org/BinarySchema/"}
  302. tree = etree.parse(xmlDescription)
  303. typeSnippets = tree.xpath("/opc:TypeDictionary/*[not(self::opc:Import)]", namespaces=ns)
  304. types = OrderedDict(existing_types.items())
  305. # types we do not want to autogenerate
  306. def skipType(name):
  307. if name in builtin_types:
  308. return True
  309. if name in excluded_types:
  310. return True
  311. if outname == "ua_types" and not name[3:] in minimal_types:
  312. return True
  313. if "Test" in name: # skip all test types
  314. return True
  315. if re.search("NodeId$", name) != None:
  316. return True
  317. return False
  318. def stripTypename(tn):
  319. return tn[tn.find(":")+1:]
  320. def camlCase2CCase(item):
  321. "Member names begin with a lower case character"
  322. return item[:1].lower() + item[1:] if item else ''
  323. def typeReady(element):
  324. "Do we have the member types yet?"
  325. for child in element:
  326. if child.tag == "{http://opcfoundation.org/BinarySchema/}Field":
  327. if stripTypename(child.get("TypeName")) not in types:
  328. return False
  329. return True
  330. def parseEnumeration(typeXml):
  331. name = "UA_" + typeXml.get("Name")
  332. description = ""
  333. elements = OrderedDict()
  334. for child in typeXml:
  335. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  336. description = child.text
  337. if child.tag == "{http://opcfoundation.org/BinarySchema/}EnumeratedValue":
  338. elements[name + "_" + child.get("Name")] = child.get("Value")
  339. return EnumerationType(name, description, elements)
  340. def parseOpaque(typeXml):
  341. name = "UA_" + typeXml.get("Name")
  342. description = ""
  343. for child in typeXml:
  344. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  345. description = child.text
  346. return OpaqueType(name, description)
  347. def parseStructured(typeXml):
  348. "Returns None if we miss member descriptions"
  349. name = "UA_" + typeXml.get("Name")
  350. description = ""
  351. for child in typeXml:
  352. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  353. description = child.text
  354. # ignore lengthfields, just tag the array-members as an array
  355. lengthfields = []
  356. for child in typeXml:
  357. if child.get("LengthField"):
  358. lengthfields.append(child.get("LengthField"))
  359. members = OrderedDict()
  360. for child in typeXml:
  361. if not child.tag == "{http://opcfoundation.org/BinarySchema/}Field":
  362. continue
  363. if child.get("Name") in lengthfields:
  364. continue
  365. memberTypeName = "UA_" + stripTypename(child.get("TypeName"))
  366. if not memberTypeName in types:
  367. return None
  368. memberType = types[memberTypeName]
  369. memberName = camlCase2CCase(child.get("Name"))
  370. isArray = True if child.get("LengthField") else False
  371. members[memberName] = StructMember(memberName, memberType, isArray)
  372. return StructType(name, description, members)
  373. finished = False
  374. while(not finished):
  375. finished = True
  376. for typeXml in typeSnippets:
  377. name = "UA_" + typeXml.get("Name")
  378. if name in types or skipType(name):
  379. continue
  380. if typeXml.tag == "{http://opcfoundation.org/BinarySchema/}EnumeratedType":
  381. t = parseEnumeration(typeXml)
  382. types[t.name] = t
  383. elif typeXml.tag == "{http://opcfoundation.org/BinarySchema/}OpaqueType":
  384. t = parseOpaque(typeXml)
  385. types[t.name] = t
  386. elif typeXml.tag == "{http://opcfoundation.org/BinarySchema/}StructuredType":
  387. t = parseStructured(typeXml)
  388. if t == None:
  389. finished = False
  390. else:
  391. types[t.name] = t
  392. # remove the existing types
  393. for k in existing_types.keys():
  394. types.pop(k)
  395. return types
  396. parser = argparse.ArgumentParser()
  397. parser.add_argument('--ns0-types-xml', nargs=1, help='xml-definition of the ns0 types that are assumed to already exist')
  398. parser.add_argument('--enable-subscription-types', nargs=1, help='Generate datatypes necessary for Montoring and Subscriptions.')
  399. parser.add_argument('--typedescriptions', nargs=1, help='csv file with type descriptions')
  400. parser.add_argument('namespace_id', type=int, help='the id of the target namespace')
  401. parser.add_argument('types_xml', help='path/to/Opc.Ua.Types.bsd')
  402. parser.add_argument('outfile', help='output file w/o extension')
  403. args = parser.parse_args()
  404. outname = args.outfile.split("/")[-1]
  405. inname = args.types_xml.split("/")[-1]
  406. existing_types = OrderedDict()
  407. if args.enable_subscription_types:
  408. minimal_types = minimal_types + subscription_types
  409. if args.namespace_id == 0 or args.ns0_types_xml:
  410. existing_types = OrderedDict([(t, BuiltinType(t)) for t in builtin_types])
  411. if args.ns0_types_xml:
  412. if sys.version_info[0] < 3:
  413. OrderedDict(existing_types.items() + parseTypeDefinitions(args.ns0_types_xml[0], existing_types).items())
  414. else:
  415. OrderedDict(list(existing_types.items()) + list(parseTypeDefinitions(args.ns0_types_xml[0], existing_types).items()))
  416. types = parseTypeDefinitions(args.types_xml, existing_types)
  417. if args.namespace_id == 0:
  418. if sys.version_info[0] < 3:
  419. types = OrderedDict(existing_types.items() + types.items())
  420. else:
  421. types = OrderedDict(list(existing_types.items()) + list(types.items()))
  422. typedescriptions = {}
  423. if args.typedescriptions:
  424. typedescriptions = parseTypeDescriptions(args.typedescriptions, args.namespace_id)
  425. fh = open(args.outfile + "_generated.h",'w')
  426. fe = open(args.outfile + "_generated_encoding_binary.h",'w')
  427. fc = open(args.outfile + "_generated.c",'w')
  428. def printh(string):
  429. print(string, end='\n', file=fh)
  430. def printe(string):
  431. print(string, end='\n', file=fe)
  432. def printc(string):
  433. print(string, end='\n', file=fc)
  434. printh('''/**
  435. * @file ''' + outname + '''_generated.h
  436. *
  437. * @brief Autogenerated data types
  438. *
  439. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  440. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  441. */
  442. #ifndef ''' + outname.upper() + '''_GENERATED_H_
  443. #define ''' + outname.upper() + '''_GENERATED_H_
  444. #ifdef __cplusplus
  445. extern "C" {
  446. #endif
  447. #include "ua_types.h"
  448. #ifdef UA_INTERNAL
  449. #include "ua_types_encoding_binary.h"
  450. #endif'''
  451. + ('\n#include "ua_types_generated.h"\n' if args.namespace_id != 0 else '') + '''
  452. /**
  453. * @ingroup types
  454. *
  455. * @defgroup ''' + outname + '''_generated Autogenerated ''' + outname + ''' Types
  456. *
  457. * @brief Data structures that are autogenerated from an XML-Schema.
  458. *
  459. * @{
  460. */
  461. ''')
  462. printh("#define " + outname.upper() + "_COUNT %s\n" % (str(len(types))))
  463. printh("extern UA_EXPORT const UA_DataType *" + outname.upper() + ";\n")
  464. i = 0
  465. if sys.version_info[0] < 3:
  466. values = types.itervalues()
  467. else:
  468. values = types.values()
  469. for t in values:
  470. if type(t) != BuiltinType:
  471. printh("")
  472. if t.description != "":
  473. printh("/** @brief " + t.description + " */")
  474. printh(t.typedef_c())
  475. printh("#define " + outname.upper() + "_" + t.name[3:].upper() + " " + str(i))
  476. if type(t) != BuiltinType:
  477. printh(t.functions_c(outname.upper()))
  478. i += 1
  479. printh('''
  480. /// @} /* end of group */\n
  481. #ifdef __cplusplus
  482. } // extern "C"
  483. #endif\n
  484. #endif /* %s_GENERATED_H_ */''' % outname.upper())
  485. printe('''/**
  486. * @file ''' + outname + '''_generated_encoding_binary.h
  487. *
  488. * @brief Binary encoding for autogenerated data types
  489. *
  490. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  491. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  492. */\n
  493. #include "ua_types_encoding_binary.h"
  494. #include "''' + outname + '''_generated.h"''')
  495. printc('''/**
  496. * @file ''' + outname + '''_generated.c
  497. *
  498. * @brief Autogenerated data types
  499. *
  500. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  501. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  502. */\n
  503. #include "stddef.h"
  504. #include "ua_types.h"
  505. #include "''' + outname + '''_generated.h"\n
  506. const UA_DataType *''' + outname.upper() + ''' = (UA_DataType[]){''')
  507. if sys.version_info[0] < 3:
  508. values = types.itervalues()
  509. else:
  510. values = types.values()
  511. for t in values:
  512. printc("")
  513. printc("/* " + t.name + " */")
  514. if args.typedescriptions:
  515. td = typedescriptions[t.name]
  516. else:
  517. td = None
  518. printc(t.typelayout_c(args.namespace_id == 0, td, outname) + ",")
  519. if not type(t) == BuiltinType:
  520. printe("")
  521. printe("/* " + t.name + " */")
  522. printe(t.encoding_h(outname.upper()))
  523. printc("};\n")
  524. # if args.typedescriptions:
  525. # printc('const UA_UInt32 *' + outname.upper() + '_IDS = (UA_UInt32[]){')
  526. # for t in types.itervalues():
  527. # print(str(typedescriptions[t.name].nodeid) + ", ", end='', file=fc)
  528. # printc("};")
  529. fh.close()
  530. fe.close()
  531. fc.close()