generate_datatypes.py 32 KB

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