generate_datatypes.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609
  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",
  38. "FindServersResponse", "SetPublishingModeResponse", "SubscriptionAcknowledgement", "NotificationMessage",
  39. "ExtensionObject", "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 (("{.typeName = \"" + self.name[3:] + "\", ") if typeintrospection else "{") + ".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. (".memberName = (char*)0, " if typeintrospection else "") + \
  110. ".padding = offsetof(UA_String, data) - sizeof(UA_Int32), .isArray = UA_TRUE }}, " + \
  111. ".typeIndex = %s }" % (outname.upper() + "_" + self.name[3:].upper())
  112. if self.name == "UA_QualifiedName":
  113. return (("{.typeName = \"" + self.name[3:] + "\", ") if typeintrospection else "{") + ".typeId = " + typeid + \
  114. ".memSize = sizeof(UA_QualifiedName), " + \
  115. ".namespaceZero = UA_TRUE, .fixedSize = UA_FALSE, .zeroCopyable = UA_FALSE, " + \
  116. ".membersSize = 2, .members = {" + \
  117. "\n\t{.memberTypeIndex = UA_TYPES_UINT16, .namespaceZero = UA_TRUE, " + \
  118. (".memberName = (char*)0, " if typeintrospection else "") + \
  119. ".padding = 0, .isArray = UA_FALSE }," + \
  120. "\n\t{.memberTypeIndex = UA_TYPES_STRING, .namespaceZero = UA_TRUE, " + \
  121. (".memberName = (char*)0, " if typeintrospection else "") + \
  122. ".padding = offsetof(UA_QualifiedName, name) - sizeof(UA_UInt16), .isArray = UA_FALSE }},\n" + \
  123. ".typeIndex = UA_TYPES_QUALIFIEDNAME }"
  124. return (("{.typeName = \"" + self.name[3:] + "\", ") if typeintrospection else "{") + ".typeId = " + typeid + \
  125. ".memSize = sizeof(" + self.name + "), " + \
  126. ".namespaceZero = UA_TRUE, " + \
  127. ".fixedSize = " + ("UA_TRUE" if self.fixed_size() else "UA_FALSE") + \
  128. ", .zeroCopyable = " + ("UA_TRUE" if self.zero_copy() else "UA_FALSE") + \
  129. ", .membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_" + self.name[3:].upper() + "," + \
  130. (".memberName = (char*)0, " if typeintrospection else "") + \
  131. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, " + \
  132. ".typeIndex = %s }" % (outname.upper() + "_" + self.name[3:].upper())
  133. class EnumerationType(object):
  134. def __init__(self, name, description = "", elements = OrderedDict()):
  135. self.name = name
  136. self.description = description
  137. self.elements = elements # maps a name to an integer value
  138. def append_enum(name, value):
  139. self.elements[name] = value
  140. def fixed_size(self):
  141. return True
  142. def mem_size(self):
  143. return 4
  144. def zero_copy(self):
  145. return True
  146. def typedef_c(self):
  147. if sys.version_info[0] < 3:
  148. values = self.elements.iteritems()
  149. else:
  150. values = self.elements.items()
  151. return "typedef enum { \n " + \
  152. ",\n ".join(map(lambda kv : kv[0].upper() + " = " + kv[1], values)) + \
  153. "\n} " + self.name + ";"
  154. def typelayout_c(self, namespace_0, description, outname):
  155. if description == None:
  156. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  157. else:
  158. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  159. return "{.typeId = " + typeid + \
  160. ".memSize = sizeof(" + self.name + "), " +\
  161. ".namespaceZero = UA_TRUE, " + \
  162. ".fixedSize = UA_TRUE, .zeroCopyable = UA_TRUE, " + \
  163. ".membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_INT32," + \
  164. (".memberName = (char*)0, " if typeintrospection else "") + \
  165. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, .typeIndex = UA_TYPES_INT32 }"
  166. def functions_c(self, typeTableName):
  167. return '''static UA_INLINE %s * %s_new(void) { %s *v = (%s*)UA_Int32_new(); return v; }
  168. static UA_INLINE void %s_init(%s *p) { UA_Int32_init((UA_Int32*)p); }
  169. static UA_INLINE void %s_delete(%s *p) { UA_Int32_delete((UA_Int32*)p); }
  170. static UA_INLINE void %s_deleteMembers(%s *p) { }
  171. 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))
  172. def encoding_h(self, typeTableName):
  173. 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); }
  174. 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))
  175. class OpaqueType(object):
  176. def __init__(self, name, description = ""):
  177. self.name = name
  178. self.description = description
  179. def fixed_size(self):
  180. return False
  181. def zero_copy(self):
  182. return False
  183. def typedef_c(self):
  184. return "typedef UA_ByteString " + self.name + ";"
  185. def typelayout_c(self, namespace_0, description, outname):
  186. if description == None:
  187. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  188. else:
  189. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  190. return (("{.typeName = \"" + self.name[3:] + "\", ") if typeintrospection else "{") + ".typeId = " + typeid + \
  191. ".memSize = sizeof(" + self.name + "), .fixedSize = UA_FALSE, .zeroCopyable = UA_FALSE, " + \
  192. ".namespaceZero = UA_TRUE, .membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_BYTESTRING," + \
  193. (".memberName = (char*)0, " if typeintrospection else "") + \
  194. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, .typeIndex = UA_TYPES_BYTESTRING }"
  195. def functions_c(self, typeTableName):
  196. return '''static UA_INLINE %s * %s_new(void) { %s *v = (%s*)UA_ByteString_new(); return v; }
  197. static UA_INLINE void %s_init(%s *p) { UA_ByteString_init((UA_ByteString*)p); }
  198. static UA_INLINE void %s_delete(%s *p) { UA_ByteString_delete((UA_ByteString*)p); }
  199. static UA_INLINE void %s_deleteMembers(%s *p) { }
  200. 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))
  201. def encoding_h(self, typeTableName):
  202. 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); }
  203. 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))
  204. class StructMember(object):
  205. def __init__(self, name, memberType, isArray):
  206. self.name = name
  207. self.memberType = memberType
  208. self.isArray = isArray
  209. class StructType(object):
  210. def __init__(self, name, description, members = OrderedDict()):
  211. self.name = name
  212. self.description = description
  213. self.members = members # maps a name to a member definition
  214. def fixed_size(self):
  215. for m in self.members.values():
  216. if m.isArray or not m.memberType.fixed_size():
  217. return False
  218. return True
  219. def mem_size(self):
  220. total = 0
  221. for m in self.members.values():
  222. if m.isArray:
  223. raise Exception("Arrays have no fixed size!")
  224. else:
  225. total += m.memberType.mem_size()
  226. return total
  227. def zero_copy(self):
  228. for m in self.members.values():
  229. if m.isArray or not m.memberType.zero_copy():
  230. return False
  231. return True
  232. def typedef_c(self):
  233. if len(self.members) == 0:
  234. return "typedef void * " + self.name + ";"
  235. returnstr = "typedef struct {\n"
  236. if sys.version_info[0] < 3:
  237. values = self.members.iteritems()
  238. else:
  239. values = self.members.items()
  240. for name, member in values:
  241. if member.isArray:
  242. returnstr += " UA_Int32 " + name + "Size;\n"
  243. returnstr += " " + member.memberType.name + " *" +name + ";\n"
  244. else:
  245. returnstr += " " + member.memberType.name + " " +name + ";\n"
  246. return returnstr + "} " + self.name + ";"
  247. def typelayout_c(self, namespace_0, description, outname):
  248. if description == None:
  249. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  250. else:
  251. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  252. layout = (("{.typeName = \"" + self.name[3:] + "\", ") if typeintrospection else "{") + ".typeId = " + typeid + \
  253. ".memSize = sizeof(" + self.name + "), "+ \
  254. ".namespaceZero = " + ("UA_TRUE" if namespace_0 else "UA_FALSE") + \
  255. ", .fixedSize = " + ("UA_TRUE" if self.fixed_size() else "UA_FALSE") + \
  256. ", .zeroCopyable = " + ("sizeof(" + self.name + ") == " + str(self.mem_size()) if self.zero_copy() \
  257. else "UA_FALSE") + \
  258. ", .typeIndex = " + outname.upper() + "_" + self.name[3:].upper() + \
  259. ", .membersSize = " + str(len(self.members)) + ","
  260. if len(self.members) > 0:
  261. layout += "\n\t.members={"
  262. for index, member in enumerate(self.members.values()):
  263. layout += "\n\t{" + \
  264. ((".memberName = \"" + member.name[0].upper() + member.name[1:] + "\", ") if typeintrospection else "") + \
  265. ".memberTypeIndex = " + ("UA_TYPES_" + member.memberType.name[3:].upper() if args.namespace_id == 0 or member.memberType.name in existing_types else \
  266. outname.upper() + "_" + member.memberType.name[3:].upper()) + ", " + \
  267. ".namespaceZero = "+ \
  268. ("UA_TRUE, " if args.namespace_id == 0 or member.memberType.name in existing_types else "UA_FALSE, ") + \
  269. ".padding = "
  270. before_endpos = "0"
  271. thispos = "offsetof(%s, %s)" % (self.name, member.name)
  272. if index > 0:
  273. if sys.version_info[0] < 3:
  274. before = self.members.values()[index-1]
  275. else:
  276. before = list(self.members.values())[index-1]
  277. before_endpos = "(offsetof(%s, %s)" % (self.name, before.name)
  278. if before.isArray:
  279. before_endpos += " + sizeof(void*))"
  280. else:
  281. before_endpos += " + sizeof(%s))" % before.memberType.name
  282. if member.isArray:
  283. # the first two bytes are padding for the length index, the last three for the pointer
  284. length_pos = "offsetof(%s, %sSize)" % (self.name, member.name)
  285. if index != 0:
  286. layout += "((%s - %s) << 3) + " % (length_pos, before_endpos)
  287. layout += "(%s - sizeof(UA_Int32) - %s)" % (thispos, length_pos)
  288. else:
  289. layout += "%s - %s" % (thispos, before_endpos)
  290. layout += ", .isArray = " + ("UA_TRUE" if member.isArray else "UA_FALSE") + " }, "
  291. layout += "}"
  292. return layout + "}"
  293. def functions_c(self, typeTableName):
  294. return '''static UA_INLINE void %s_init(%s *p) { UA_init(p, %s); }
  295. static UA_INLINE void %s_delete(%s *p) { UA_delete(p, %s); }
  296. static UA_INLINE void %s_deleteMembers(%s *p) { UA_deleteMembers(p, %s); }
  297. static UA_INLINE %s * %s_new(void) { return (%s *) UA_new(%s); }
  298. static UA_INLINE UA_StatusCode %s_copy(const %s *src, %s *dst) { return UA_copy(src, dst, %s); }''' % \
  299. tuple( list(itertools.chain(*itertools.repeat([self.name, self.name, "&"+typeTableName+"[" + typeTableName + "_" + self.name[3:].upper()+"]"], 3)))
  300. + list(itertools.chain(*itertools.repeat([self.name, self.name, self.name, "&"+typeTableName+"[" + typeTableName + "_" + self.name[3:].upper()+"]"], 2))) )
  301. def encoding_h(self, typeTableName):
  302. return '''static UA_INLINE UA_StatusCode %s_encodeBinary(const %s *src, UA_ByteString *dst, size_t *offset) { return UA_encodeBinary(src, %s, dst, offset); }
  303. static UA_INLINE UA_StatusCode %s_decodeBinary(const UA_ByteString *src, size_t *offset, %s *dst) { return UA_decodeBinary(src, offset, dst, %s); }''' % \
  304. tuple(list(itertools.chain(*itertools.repeat([self.name, self.name, "&"+typeTableName+"[" + typeTableName + "_" + self.name[3:].upper()+"]"], 2))))
  305. def parseTypeDefinitions(xmlDescription, existing_types = OrderedDict()):
  306. '''Returns an ordered dict that maps names to types. The order is such that
  307. every type depends only on known types. '''
  308. ns = {"opc": "http://opcfoundation.org/BinarySchema/"}
  309. tree = etree.parse(xmlDescription)
  310. typeSnippets = tree.xpath("/opc:TypeDictionary/*[not(self::opc:Import)]", namespaces=ns)
  311. types = OrderedDict(existing_types.items())
  312. # types we do not want to autogenerate
  313. def skipType(name):
  314. if name in builtin_types:
  315. return True
  316. if name in excluded_types:
  317. return True
  318. if outname == "ua_types" and not name[3:] in minimal_types:
  319. return True
  320. if "Test" in name: # skip all test types
  321. return True
  322. if re.search("NodeId$", name) != None:
  323. return True
  324. return False
  325. def stripTypename(tn):
  326. return tn[tn.find(":")+1:]
  327. def camlCase2CCase(item):
  328. "Member names begin with a lower case character"
  329. return item[:1].lower() + item[1:] if item else ''
  330. def typeReady(element):
  331. "Do we have the member types yet?"
  332. for child in element:
  333. if child.tag == "{http://opcfoundation.org/BinarySchema/}Field":
  334. if stripTypename(child.get("TypeName")) not in types:
  335. return False
  336. return True
  337. def parseEnumeration(typeXml):
  338. name = "UA_" + typeXml.get("Name")
  339. description = ""
  340. elements = OrderedDict()
  341. for child in typeXml:
  342. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  343. description = child.text
  344. if child.tag == "{http://opcfoundation.org/BinarySchema/}EnumeratedValue":
  345. elements[name + "_" + child.get("Name")] = child.get("Value")
  346. return EnumerationType(name, description, elements)
  347. def parseOpaque(typeXml):
  348. name = "UA_" + typeXml.get("Name")
  349. description = ""
  350. for child in typeXml:
  351. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  352. description = child.text
  353. return OpaqueType(name, description)
  354. def parseStructured(typeXml):
  355. "Returns None if we miss member descriptions"
  356. name = "UA_" + typeXml.get("Name")
  357. description = ""
  358. for child in typeXml:
  359. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  360. description = child.text
  361. # ignore lengthfields, just tag the array-members as an array
  362. lengthfields = []
  363. for child in typeXml:
  364. if child.get("LengthField"):
  365. lengthfields.append(child.get("LengthField"))
  366. members = OrderedDict()
  367. for child in typeXml:
  368. if not child.tag == "{http://opcfoundation.org/BinarySchema/}Field":
  369. continue
  370. if child.get("Name") in lengthfields:
  371. continue
  372. memberTypeName = "UA_" + stripTypename(child.get("TypeName"))
  373. if not memberTypeName in types:
  374. return None
  375. memberType = types[memberTypeName]
  376. memberName = camlCase2CCase(child.get("Name"))
  377. isArray = True if child.get("LengthField") else False
  378. members[memberName] = StructMember(memberName, memberType, isArray)
  379. return StructType(name, description, members)
  380. finished = False
  381. while(not finished):
  382. finished = True
  383. for typeXml in typeSnippets:
  384. name = "UA_" + typeXml.get("Name")
  385. if name in types or skipType(name):
  386. continue
  387. if typeXml.tag == "{http://opcfoundation.org/BinarySchema/}EnumeratedType":
  388. t = parseEnumeration(typeXml)
  389. types[t.name] = t
  390. elif typeXml.tag == "{http://opcfoundation.org/BinarySchema/}OpaqueType":
  391. t = parseOpaque(typeXml)
  392. types[t.name] = t
  393. elif typeXml.tag == "{http://opcfoundation.org/BinarySchema/}StructuredType":
  394. t = parseStructured(typeXml)
  395. if t == None:
  396. finished = False
  397. else:
  398. types[t.name] = t
  399. # remove the existing types
  400. for k in existing_types.keys():
  401. types.pop(k)
  402. return types
  403. parser = argparse.ArgumentParser()
  404. parser.add_argument('--ns0-types-xml', nargs=1, help='xml-definition of the ns0 types that are assumed to already exist')
  405. parser.add_argument('--enable-subscription-types', nargs=1, help='Generate datatypes necessary for Montoring and Subscriptions.')
  406. parser.add_argument('--typedescriptions', nargs=1, help='csv file with type descriptions')
  407. parser.add_argument('--typeintrospection', help='add the type and member names to the idatatype structures', action='store_true')
  408. parser.add_argument('namespace_id', type=int, help='the id of the target namespace')
  409. parser.add_argument('types_xml', help='path/to/Opc.Ua.Types.bsd')
  410. parser.add_argument('outfile', help='output file w/o extension')
  411. args = parser.parse_args()
  412. outname = args.outfile.split("/")[-1]
  413. inname = args.types_xml.split("/")[-1]
  414. typeintrospection = args.typeintrospection
  415. existing_types = OrderedDict()
  416. if args.enable_subscription_types:
  417. minimal_types = minimal_types + subscription_types
  418. if args.namespace_id == 0 or args.ns0_types_xml:
  419. existing_types = OrderedDict([(t, BuiltinType(t)) for t in builtin_types])
  420. if args.ns0_types_xml:
  421. if sys.version_info[0] < 3:
  422. OrderedDict(existing_types.items() + parseTypeDefinitions(args.ns0_types_xml[0], existing_types).items())
  423. else:
  424. OrderedDict(list(existing_types.items()) + list(parseTypeDefinitions(args.ns0_types_xml[0], existing_types).items()))
  425. types = parseTypeDefinitions(args.types_xml, existing_types)
  426. if args.namespace_id == 0:
  427. if sys.version_info[0] < 3:
  428. types = OrderedDict(existing_types.items() + types.items())
  429. else:
  430. types = OrderedDict(list(existing_types.items()) + list(types.items()))
  431. typedescriptions = {}
  432. if args.typedescriptions:
  433. typedescriptions = parseTypeDescriptions(args.typedescriptions, args.namespace_id)
  434. fh = open(args.outfile + "_generated.h",'w')
  435. fe = open(args.outfile + "_generated_encoding_binary.h",'w')
  436. fc = open(args.outfile + "_generated.c",'w')
  437. def printh(string):
  438. print(string, end='\n', file=fh)
  439. def printe(string):
  440. print(string, end='\n', file=fe)
  441. def printc(string):
  442. print(string, end='\n', file=fc)
  443. printh('''/**
  444. * @file ''' + outname + '''_generated.h
  445. *
  446. * @brief Autogenerated data types
  447. *
  448. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  449. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  450. */
  451. #ifndef ''' + outname.upper() + '''_GENERATED_H_
  452. #define ''' + outname.upper() + '''_GENERATED_H_
  453. #ifdef __cplusplus
  454. extern "C" {
  455. #endif
  456. #include "ua_types.h"
  457. #ifdef UA_INTERNAL
  458. #include "ua_types_encoding_binary.h"
  459. #endif'''
  460. + ('\n#include "ua_types_generated.h"\n' if args.namespace_id != 0 else '') + '''
  461. /**
  462. * @ingroup types
  463. *
  464. * @defgroup ''' + outname + '''_generated Autogenerated ''' + outname + ''' Types
  465. *
  466. * @brief Data structures that are autogenerated from an XML-Schema.
  467. *
  468. * @{
  469. */
  470. ''')
  471. printh("#define " + outname.upper() + "_COUNT %s\n" % (str(len(types))))
  472. printh("extern UA_EXPORT const UA_DataType *" + outname.upper() + ";\n")
  473. i = 0
  474. if sys.version_info[0] < 3:
  475. values = types.itervalues()
  476. else:
  477. values = types.values()
  478. for t in values:
  479. if type(t) != BuiltinType:
  480. printh("")
  481. if t.description != "":
  482. printh("/** @brief " + t.description + " */")
  483. printh(t.typedef_c())
  484. printh("#define " + outname.upper() + "_" + t.name[3:].upper() + " " + str(i))
  485. if type(t) != BuiltinType:
  486. printh(t.functions_c(outname.upper()))
  487. i += 1
  488. printh('''
  489. /// @} /* end of group */\n
  490. #ifdef __cplusplus
  491. } // extern "C"
  492. #endif\n
  493. #endif /* %s_GENERATED_H_ */''' % outname.upper())
  494. printe('''/**
  495. * @file ''' + outname + '''_generated_encoding_binary.h
  496. *
  497. * @brief Binary encoding for autogenerated data types
  498. *
  499. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  500. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  501. */\n
  502. #include "ua_types_encoding_binary.h"
  503. #include "''' + outname + '''_generated.h"''')
  504. printc('''/**
  505. * @file ''' + outname + '''_generated.c
  506. *
  507. * @brief Autogenerated data types
  508. *
  509. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  510. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  511. */\n
  512. #include "stddef.h"
  513. #include "ua_types.h"
  514. #include "''' + outname + '''_generated.h"\n
  515. const UA_DataType *''' + outname.upper() + ''' = (UA_DataType[]){''')
  516. if sys.version_info[0] < 3:
  517. values = types.itervalues()
  518. else:
  519. values = types.values()
  520. for t in values:
  521. printc("")
  522. printc("/* " + t.name + " */")
  523. if args.typedescriptions:
  524. td = typedescriptions[t.name]
  525. else:
  526. td = None
  527. printc(t.typelayout_c(args.namespace_id == 0, td, outname) + ",")
  528. if not type(t) == BuiltinType:
  529. printe("")
  530. printe("/* " + t.name + " */")
  531. printe(t.encoding_h(outname.upper()))
  532. printc("};\n")
  533. # if args.typedescriptions:
  534. # printc('const UA_UInt32 *' + outname.upper() + '_IDS = (UA_UInt32[]){')
  535. # for t in types.itervalues():
  536. # print(str(typedescriptions[t.name].nodeid) + ", ", end='', file=fc)
  537. # printc("};")
  538. fh.close()
  539. fe.close()
  540. fc.close()