macros_public.cmake 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532
  1. # --------------- Generate NodeIDs header ---------------------
  2. #
  3. # Generates header file from .csv which contains defines for every
  4. # node id to be used instead of numeric node ids.
  5. #
  6. # The resulting files will be put into OUTPUT_DIR with the names:
  7. # - NAME.h
  8. #
  9. #
  10. # The following arguments are accepted:
  11. # Options:
  12. #
  13. # Arguments taking one value:
  14. #
  15. # NAME Full name of the generated files, e.g. di_nodeids
  16. # TARGET_SUFFIX Suffix for the resulting target. e.g. ids-di
  17. # [TARGET_PREFIX] Optional prefix for the resulting target. Default `open62541-generator`
  18. # ID_PREFIX Prefix for the generated node ID defines, e.g. NS_DI
  19. # [OUTPUT_DIR] Optional target directory for the generated files. Default is '${PROJECT_BINARY_DIR}/src_generated'
  20. # FILE_CSV Path to the .csv file containing the node ids, e.g. 'OpcUaDiModel.csv'
  21. #
  22. function(ua_generate_nodeid_header)
  23. set(options )
  24. set(oneValueArgs NAME ID_PREFIX OUTPUT_DIR FILE_CSV TARGET_SUFFIX TARGET_PREFIX)
  25. set(multiValueArgs )
  26. cmake_parse_arguments(UA_GEN_ID "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
  27. if(NOT UA_GEN_ID_TARGET_SUFFIX OR "${UA_GEN_ID_TARGET_SUFFIX}" STREQUAL "")
  28. message(FATAL_ERROR "ua_generate_nodeid_header function requires a value for the TARGET_SUFFIX argument")
  29. endif()
  30. # Set default value for output dir
  31. if(NOT UA_GEN_ID_OUTPUT_DIR OR "${UA_GEN_ID_OUTPUT_DIR}" STREQUAL "")
  32. set(UA_GEN_ID_OUTPUT_DIR ${PROJECT_BINARY_DIR}/src_generated/open62541)
  33. endif()
  34. # Set default target prefix
  35. if(NOT UA_GEN_ID_TARGET_PREFIX OR "${UA_GEN_ID_TARGET_PREFIX}" STREQUAL "")
  36. set(UA_GEN_ID_TARGET_PREFIX "open62541-generator")
  37. endif()
  38. # Replace dash with underscore to make valid c literal
  39. string(REPLACE "-" "_" UA_GEN_ID_NAME ${UA_GEN_ID_NAME})
  40. add_custom_target(${UA_GEN_ID_TARGET_PREFIX}-${UA_GEN_ID_TARGET_SUFFIX} DEPENDS
  41. ${UA_GEN_ID_OUTPUT_DIR}/${UA_GEN_ID_NAME}.h
  42. )
  43. # Make sure that the output directory exists
  44. if(NOT EXISTS ${UA_GEN_ID_OUTPUT_DIR})
  45. file(MAKE_DIRECTORY ${UA_GEN_ID_OUTPUT_DIR})
  46. endif()
  47. # Header containing defines for all NodeIds
  48. add_custom_command(OUTPUT ${UA_GEN_ID_OUTPUT_DIR}/${UA_GEN_ID_NAME}.h
  49. PRE_BUILD
  50. COMMAND ${PYTHON_EXECUTABLE} ${open62541_TOOLS_DIR}/generate_nodeid_header.py
  51. ${UA_GEN_ID_FILE_CSV} ${UA_GEN_ID_OUTPUT_DIR}/${UA_GEN_ID_NAME} ${UA_GEN_ID_ID_PREFIX}
  52. DEPENDS ${open62541_TOOLS_DIR}/generate_nodeid_header.py
  53. ${UA_GEN_ID_FILE_CSV})
  54. endfunction()
  55. # --------------- Generate Datatypes ---------------------
  56. #
  57. # Generates Datatype definition based on the .csv and .bsd files of a nodeset.
  58. # The result of the generation will be C Code which can be compiled with the rest of the stack.
  59. # Some nodesets come with custom datatypes. These datatype structures first need to be
  60. # generated so that the nodeset can use these types.
  61. #
  62. # The resulting files will be put into OUTPUT_DIR with the names:
  63. # - NAME_generated.c
  64. # - NAME_generated.h
  65. # - NAME_generated_encoding_binary.h
  66. # - NAME_generated_handling.h
  67. #
  68. # The cmake resulting cmake target will be named like this:
  69. # open62541-generator-${TARGET_SUFFIX}
  70. #
  71. # The following arguments are accepted:
  72. # Options:
  73. #
  74. # [BUILTIN] Optional argument. If given, then builtin types will be generated.
  75. # [INTERNAL] Optional argument. If given, then the given types file is seen as internal file (e.g. does not require a .csv)
  76. #
  77. # Arguments taking one value:
  78. #
  79. # NAME Full name of the generated files, e.g. ua_types_di
  80. # TARGET_SUFFIX Suffix for the resulting target. e.g. types-di
  81. # [TARGET_PREFIX] Optional prefix for the resulting target. Default `open62541-generator`
  82. # NAMESPACE_IDX Namespace index of the nodeset, when it is loaded into the server. This index
  83. # is used for the node ids withing the types array and is currently not determined automatically.
  84. # Make sure that it matches the namespace index in the server.
  85. # [OUTPUT_DIR] Optional target directory for the generated files. Default is '${PROJECT_BINARY_DIR}/src_generated'
  86. # FILE_CSV Path to the .csv file containing the node ids, e.g. 'OpcUaDiModel.csv'
  87. #
  88. # Arguments taking multiple values:
  89. #
  90. # FILES_BSD Path to the .bsd file containing the type definitions, e.g. 'Opc.Ua.Di.Types.bsd'. Multiple files can be
  91. # passed which will all combined to one resulting code.
  92. # [FILES_SELECTED] Optional path to a simple text file which contains a list of types which should be included in the generation.
  93. # The file should contain one type per line. Multiple files can be passed to this argument.
  94. #
  95. #
  96. function(ua_generate_datatypes)
  97. set(options BUILTIN INTERNAL)
  98. set(oneValueArgs NAME TARGET_SUFFIX TARGET_PREFIX NAMESPACE_IDX OUTPUT_DIR FILE_CSV)
  99. set(multiValueArgs FILES_BSD FILES_SELECTED)
  100. cmake_parse_arguments(UA_GEN_DT "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
  101. if(NOT DEFINED open62541_TOOLS_DIR)
  102. message(FATAL_ERROR "open62541_TOOLS_DIR must point to the open62541 tools directory")
  103. endif()
  104. # ------ Argument checking -----
  105. if(NOT DEFINED UA_GEN_DT_NAMESPACE_IDX AND NOT "${UA_GEN_DT_NAMESPACE_IDX}" STREQUAL "0")
  106. message(FATAL_ERROR "ua_generate_datatype function requires a value for the NAMESPACE_IDX argument")
  107. endif()
  108. if(NOT UA_GEN_DT_NAME OR "${UA_GEN_DT_NAME}" STREQUAL "")
  109. message(FATAL_ERROR "ua_generate_datatype function requires a value for the NAME argument")
  110. endif()
  111. if(NOT UA_GEN_DT_TARGET_SUFFIX OR "${UA_GEN_DT_TARGET_SUFFIX}" STREQUAL "")
  112. message(FATAL_ERROR "ua_generate_datatype function requires a value for the TARGET_SUFFIX argument")
  113. endif()
  114. if(NOT UA_GEN_DT_FILE_CSV OR "${UA_GEN_DT_FILE_CSV}" STREQUAL "")
  115. message(FATAL_ERROR "ua_generate_datatype function requires a value for the FILE_CSV argument")
  116. endif()
  117. if(NOT UA_GEN_DT_FILES_BSD OR "${UA_GEN_DT_FILES_BSD}" STREQUAL "")
  118. message(FATAL_ERROR "ua_generate_datatype function requires a value for the FILES_BSD argument")
  119. endif()
  120. # Set default value for output dir
  121. if(NOT UA_GEN_DT_OUTPUT_DIR OR "${UA_GEN_DT_OUTPUT_DIR}" STREQUAL "")
  122. set(UA_GEN_DT_OUTPUT_DIR ${PROJECT_BINARY_DIR}/src_generated/open62541)
  123. endif()
  124. # Set default target prefix
  125. if(NOT UA_GEN_DT_TARGET_PREFIX OR "${UA_GEN_DT_TARGET_PREFIX}" STREQUAL "")
  126. set(UA_GEN_DT_TARGET_PREFIX "open62541-generator")
  127. endif()
  128. # ------ Add custom command and target -----
  129. set(UA_GEN_DT_NO_BUILTIN "--no-builtin")
  130. if (UA_GEN_DT_BUILTIN)
  131. set(UA_GEN_DT_NO_BUILTIN "")
  132. endif()
  133. set(UA_GEN_DT_INTERNAL_ARG "")
  134. if (UA_GEN_DT_INTERNAL)
  135. set(UA_GEN_DT_INTERNAL_ARG "--internal")
  136. endif()
  137. set(SELECTED_TYPES_TMP "")
  138. foreach(f ${UA_GEN_DT_FILES_SELECTED})
  139. set(SELECTED_TYPES_TMP ${SELECTED_TYPES_TMP} "--selected-types=${f}")
  140. endforeach()
  141. set(BSD_FILES_TMP "")
  142. foreach(f ${UA_GEN_DT_FILES_BSD})
  143. set(BSD_FILES_TMP ${BSD_FILES_TMP} "--type-bsd=${f}")
  144. endforeach()
  145. # Make sure that the output directory exists
  146. if(NOT EXISTS ${UA_GEN_DT_OUTPUT_DIR})
  147. file(MAKE_DIRECTORY ${UA_GEN_DT_OUTPUT_DIR})
  148. endif()
  149. # Replace dash with underscore to make valid c literal
  150. string(REPLACE "-" "_" UA_GEN_DT_NAME ${UA_GEN_DT_NAME})
  151. add_custom_command(OUTPUT ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated.c
  152. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated.h
  153. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated_handling.h
  154. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated_encoding_binary.h
  155. PRE_BUILD
  156. COMMAND ${PYTHON_EXECUTABLE} ${open62541_TOOLS_DIR}/generate_datatypes.py
  157. --namespace=${UA_GEN_DT_NAMESPACE_IDX}
  158. ${SELECTED_TYPES_TMP}
  159. ${BSD_FILES_TMP}
  160. --type-csv=${UA_GEN_DT_FILE_CSV}
  161. ${UA_GEN_DT_NO_BUILTIN}
  162. ${UA_GEN_DT_INTERNAL_ARG}
  163. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}
  164. DEPENDS ${open62541_TOOLS_DIR}/generate_datatypes.py
  165. ${UA_GEN_DT_FILES_BSD}
  166. ${UA_GEN_DT_FILE_CSV}
  167. ${UA_GEN_DT_FILES_SELECTED})
  168. add_custom_target(${UA_GEN_DT_TARGET_PREFIX}-${UA_GEN_DT_TARGET_SUFFIX} DEPENDS
  169. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated.c
  170. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated.h
  171. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated_handling.h
  172. ${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated_encoding_binary.h
  173. )
  174. string(TOUPPER "${UA_GEN_DT_NAME}" GEN_NAME_UPPER)
  175. set(UA_${GEN_NAME_UPPER}_SOURCES "${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated.c" CACHE INTERNAL "${UA_GEN_DT_NAME} source files")
  176. set(UA_${GEN_NAME_UPPER}_HEADERS "${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated.h;${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated_handling.h;${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated_encoding_binary.h"
  177. CACHE INTERNAL "${UA_GEN_DT_NAME} header files")
  178. if(UA_COMPILE_AS_CXX)
  179. set_source_files_properties(${UA_GEN_DT_OUTPUT_DIR}/${UA_GEN_DT_NAME}_generated.c PROPERTIES LANGUAGE CXX)
  180. endif()
  181. endfunction()
  182. # --------------- Generate Nodeset ---------------------
  183. #
  184. # Generates C code for the given NodeSet2.xml file.
  185. # This C code can be used to initialize the server.
  186. #
  187. # The resulting files will be put into OUTPUT_DIR with the names:
  188. # - ua_namespace_NAME.c
  189. # - ua_namespace_NAME.h
  190. #
  191. # The resulting cmake target will be named like this:
  192. # open62541-generator-ns-${NAME}
  193. #
  194. # The following arguments are accepted:
  195. # Options:
  196. #
  197. # [INTERNAL] Optional argument. If given, then the generated node set code will use internal headers.
  198. #
  199. # Arguments taking one value:
  200. #
  201. # NAME Name of the nodeset, e.g. 'di'
  202. # [TYPES_ARRAY] Optional name of the types array containing the custom datatypes of this node set.
  203. # [OUTPUT_DIR] Optional target directory for the generated files. Default is '${PROJECT_BINARY_DIR}/src_generated'
  204. # [IGNORE] Optional file containing a list of node ids which should be ignored. The file should have one id per line.
  205. # [TARGET_PREFIX] Optional prefix for the resulting target. Default `open62541-generator`
  206. #
  207. # Arguments taking multiple values:
  208. #
  209. # FILE Path to the NodeSet2.xml file. Multiple values can be passed. These nodesets will be combined into one output.
  210. # [DEPENDS_TYPES] Optional list of types array which match with the DEPENDS_NS node sets. e.g. 'UA_TYPES;UA_TYPES_DI'
  211. # [DEPENDS_NS] Optional list of NodeSet2.xml files which are a dependency of this node set.
  212. # [DEPENDS_TARGET] Optional list of CMake targets this nodeset depends on.
  213. #
  214. #
  215. function(ua_generate_nodeset)
  216. set(options INTERNAL )
  217. set(oneValueArgs NAME TYPES_ARRAY OUTPUT_DIR IGNORE TARGET_PREFIX)
  218. set(multiValueArgs FILE DEPENDS_TYPES DEPENDS_NS DEPENDS_TARGET)
  219. cmake_parse_arguments(UA_GEN_NS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
  220. if(NOT DEFINED open62541_TOOLS_DIR)
  221. message(FATAL_ERROR "open62541_TOOLS_DIR must point to the open62541 tools directory")
  222. endif()
  223. # ------ Argument checking -----
  224. if(NOT UA_GEN_NS_NAME OR "${UA_GEN_NS_NAME}" STREQUAL "")
  225. message(FATAL_ERROR "ua_generate_nodeset function requires a value for the NAME argument")
  226. endif()
  227. if(NOT UA_GEN_NS_FILE OR "${UA_GEN_NS_FILE}" STREQUAL "")
  228. message(FATAL_ERROR "ua_generate_nodeset function requires a value for the FILE argument")
  229. endif()
  230. # Set default value for output dir
  231. if(NOT UA_GEN_NS_OUTPUT_DIR OR "${UA_GEN_NS_OUTPUT_DIR}" STREQUAL "")
  232. set(UA_GEN_NS_OUTPUT_DIR ${PROJECT_BINARY_DIR}/src_generated/open62541)
  233. endif()
  234. # Set default target prefix
  235. if(NOT UA_GEN_NS_TARGET_PREFIX OR "${UA_GEN_NS_TARGET_PREFIX}" STREQUAL "")
  236. set(UA_GEN_NS_TARGET_PREFIX "open62541-generator")
  237. endif()
  238. # ------ Add custom command and target -----
  239. set(GEN_INTERNAL_HEADERS "")
  240. if (UA_GEN_NS_INTERNAL)
  241. set(GEN_INTERNAL_HEADERS "--internal-headers")
  242. endif()
  243. set(GEN_NS0 "")
  244. set(TARGET_SUFFIX "ns-${UA_GEN_NS_NAME}")
  245. set(FILE_SUFFIX "_${UA_GEN_NS_NAME}_generated")
  246. string(REPLACE "-" "_" FILE_SUFFIX ${FILE_SUFFIX})
  247. if ("${UA_GEN_NS_NAME}" STREQUAL "ns0")
  248. set(TARGET_SUFFIX "namespace")
  249. set(FILE_SUFFIX "0_generated")
  250. endif()
  251. set(GEN_IGNORE "")
  252. if (UA_GEN_NS_IGNORE)
  253. set(GEN_IGNORE "--ignore=${UA_GEN_NS_IGNORE}")
  254. endif()
  255. set(TYPES_ARRAY_LIST "")
  256. foreach(f ${UA_GEN_NS_DEPENDS_TYPES})
  257. # Replace dash with underscore to make valid c literal
  258. string(REPLACE "-" "_" TYPE_ARRAY ${f})
  259. set(TYPES_ARRAY_LIST ${TYPES_ARRAY_LIST} "--types-array=${TYPE_ARRAY}")
  260. endforeach()
  261. if(UA_GEN_NS_TYPES_ARRAY)
  262. # Replace dash with underscore to make valid c literal
  263. string(REPLACE "-" "_" TYPE_ARRAY ${UA_GEN_NS_TYPES_ARRAY})
  264. set(TYPES_ARRAY_LIST ${TYPES_ARRAY_LIST} "--types-array=${TYPE_ARRAY}")
  265. endif()
  266. set(DEPENDS_FILE_LIST "")
  267. foreach(f ${UA_GEN_NS_DEPENDS_NS})
  268. set(DEPENDS_FILE_LIST ${DEPENDS_FILE_LIST} "--existing=${f}")
  269. endforeach()
  270. set(FILE_LIST "")
  271. foreach(f ${UA_GEN_NS_FILE})
  272. set(FILE_LIST ${FILE_LIST} "--xml=${f}")
  273. endforeach()
  274. # Make sure that the output directory exists
  275. if(NOT EXISTS ${UA_GEN_NS_OUTPUT_DIR})
  276. file(MAKE_DIRECTORY ${UA_GEN_NS_OUTPUT_DIR})
  277. endif()
  278. add_custom_command(OUTPUT ${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}.c
  279. ${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}.h
  280. PRE_BUILD
  281. COMMAND ${PYTHON_EXECUTABLE} ${open62541_TOOLS_DIR}/nodeset_compiler/nodeset_compiler.py
  282. ${GEN_INTERNAL_HEADERS}
  283. ${GEN_NS0}
  284. ${GEN_BIN_SIZE}
  285. ${GEN_IGNORE}
  286. ${TYPES_ARRAY_LIST}
  287. ${DEPENDS_FILE_LIST}
  288. ${FILE_LIST}
  289. ${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}
  290. DEPENDS
  291. ${open62541_TOOLS_DIR}/nodeset_compiler/nodeset_compiler.py
  292. ${open62541_TOOLS_DIR}/nodeset_compiler/nodes.py
  293. ${open62541_TOOLS_DIR}/nodeset_compiler/nodeset.py
  294. ${open62541_TOOLS_DIR}/nodeset_compiler/datatypes.py
  295. ${open62541_TOOLS_DIR}/nodeset_compiler/backend_open62541.py
  296. ${open62541_TOOLS_DIR}/nodeset_compiler/backend_open62541_nodes.py
  297. ${open62541_TOOLS_DIR}/nodeset_compiler/backend_open62541_datatypes.py
  298. ${UA_GEN_NS_FILE}
  299. ${UA_GEN_NS_DEPENDS_NS}
  300. )
  301. add_custom_target(${UA_GEN_NS_TARGET_PREFIX}-${TARGET_SUFFIX}
  302. DEPENDS
  303. ${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}.c
  304. ${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}.h)
  305. if (UA_GEN_NS_DEPENDS_TARGET)
  306. add_dependencies(${UA_GEN_NS_TARGET_PREFIX}-${TARGET_SUFFIX} ${UA_GEN_NS_DEPENDS_TARGET})
  307. endif()
  308. if(UA_COMPILE_AS_CXX)
  309. set_source_files_properties(${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}.c PROPERTIES LANGUAGE CXX)
  310. endif()
  311. string(REPLACE "-" "_" UA_GEN_NS_NAME ${UA_GEN_NS_NAME})
  312. string(TOUPPER "${UA_GEN_NS_NAME}" GEN_NAME_UPPER)
  313. set_property(GLOBAL PROPERTY "UA_GEN_NS_DEPENDS_FILE_${UA_GEN_NS_NAME}" ${UA_GEN_NS_DEPENDS_NS} ${UA_GEN_NS_FILE})
  314. set_property(GLOBAL PROPERTY "UA_GEN_NS_DEPENDS_TYPES_${UA_GEN_NS_NAME}" ${UA_GEN_NS_DEPENDS_TYPES} ${UA_GEN_NS_TYPES_ARRAY})
  315. set(UA_NODESET_${GEN_NAME_UPPER}_SOURCES "${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}.c" CACHE INTERNAL "UA_NODESET_${GEN_NAME_UPPER} source files")
  316. set(UA_NODESET_${GEN_NAME_UPPER}_HEADERS "${UA_GEN_NS_OUTPUT_DIR}/namespace${FILE_SUFFIX}.h" CACHE INTERNAL "UA_NODESET_${GEN_NAME_UPPER} header files")
  317. set(UA_NODESET_${GEN_NAME_UPPER}_TARGET "${UA_GEN_NS_TARGET_PREFIX}-${TARGET_SUFFIX}" CACHE INTERNAL "UA_NODESET_${GEN_NAME_UPPER} target")
  318. endfunction()
  319. # --------------- Generate Nodeset and Datatypes ---------------------
  320. #
  321. # Generates C code for the given NodeSet2.xml and Datatype file.
  322. # This C code can be used to initialize the server.
  323. #
  324. # This is a combination of the ua_generate_datatypes, ua_generate_nodeset, and
  325. # ua_generate_nodeid_header macros.
  326. # This function can also be used to just create a nodeset without datatypes by
  327. # omitting the CSV, BSD, and NAMESPACE_IDX parameter.
  328. # If only one of the previous parameters is given, all of them are required.
  329. #
  330. # It is possible to define dependencies of nodesets by using the DEPENDS argument.
  331. # E.g. the PLCOpen nodeset depends on the 'di' nodeset. Thus it is enough to just
  332. # pass 'DEPENDS di' to the function. The 'di' nodeset then first needs to be generated
  333. # with this function or with the ua_generate_nodeset function.
  334. #
  335. # The resulting cmake target will be named like this:
  336. # open62541-generator-ns-${NAME}
  337. #
  338. # The following arguments are accepted:
  339. #
  340. # Options:
  341. #
  342. # INTERNAL Include internal headers. Required if custom datatypes are added.
  343. #
  344. # Arguments taking one value:
  345. #
  346. # NAME Short name of the nodeset. E.g. 'di'
  347. # FILE_NS Path to the NodeSet2.xml file. Multiple values can be passed. These nodesets will be combined into one output.
  348. #
  349. # [FILE_CSV] Optional path to the .csv file containing the node ids, e.g. 'OpcUaDiModel.csv'
  350. # [FILE_BSD] Optional path to the .bsd file containing the type definitions, e.g. 'Opc.Ua.Di.Types.bsd'. Multiple files can be
  351. # passed which will all combined to one resulting code.
  352. # [NAMESPACE_IDX] Optional namespace index of the nodeset, when it is loaded into the server. This parameter is mandatory if FILE_CSV
  353. # or FILE_BSD is set. See ua_generate_datatypes function.
  354. # [TARGET_PREFIX] Optional prefix for the resulting targets. Default `open62541-generator`
  355. #
  356. # Arguments taking multiple values:
  357. # [DEPENDS] Optional list of nodeset names on which this nodeset depends. These names must match any name from a previous
  358. # call to this funtion. E.g. 'di' if you are generating the 'plcopen' nodeset
  359. #
  360. #
  361. function(ua_generate_nodeset_and_datatypes)
  362. set(options INTERNAL)
  363. set(oneValueArgs NAME FILE_NS FILE_CSV FILE_BSD NAMESPACE_IDX OUTPUT_DIR TARGET_PREFIX)
  364. set(multiValueArgs DEPENDS)
  365. cmake_parse_arguments(UA_GEN "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
  366. if(NOT DEFINED open62541_TOOLS_DIR)
  367. message(FATAL_ERROR "open62541_TOOLS_DIR must point to the open62541 tools directory")
  368. endif()
  369. if(NOT DEFINED open62541_NODESET_DIR)
  370. message(FATAL_ERROR "open62541_NODESET_DIR must point to the open62541/deps/ua-nodeset directory")
  371. endif()
  372. # ------ Argument checking -----
  373. if(NOT UA_GEN_NAME OR "${UA_GEN_NAME}" STREQUAL "")
  374. message(FATAL_ERROR "ua_generate_nodeset_and_datatypes function requires a value for the NAME argument")
  375. endif()
  376. string(TOUPPER "${UA_GEN_NAME}" GEN_NAME_UPPER)
  377. if(NOT UA_GEN_FILE_NS OR "${UA_GEN_FILE_NS}" STREQUAL "")
  378. message(FATAL_ERROR "ua_generate_nodeset_and_datatypes function requires a value for the FILE_NS argument")
  379. endif()
  380. if((NOT UA_GEN_FILE_CSV OR "${UA_GEN_FILE_CSV}" STREQUAL "") AND
  381. (NOT "${UA_GEN_FILE_BSD}" STREQUAL "" OR
  382. NOT "${UA_GEN_NAMESPACE_IDX}" STREQUAL ""))
  383. message(FATAL_ERROR "ua_generate_nodeset_and_datatypes function requires FILE_CSV argument if any of FILE_BSD or NAMESPACE_IDX are set")
  384. endif()
  385. if((NOT UA_GEN_FILE_BSD OR "${UA_GEN_FILE_BSD}" STREQUAL "") AND
  386. (NOT "${UA_GEN_FILE_CSV}" STREQUAL "" OR
  387. NOT "${UA_GEN_NAMESPACE_IDX}" STREQUAL ""))
  388. message(FATAL_ERROR "ua_generate_nodeset_and_datatypes function requires FILE_BSD argument if any of FILE_CSV or NAMESPACE_IDX are set")
  389. endif()
  390. if(NOT UA_GEN_NAMESPACE_IDX OR "${UA_GEN_NAMESPACE_IDX}" STREQUAL "" AND
  391. (NOT "${UA_GEN_FILE_CSV}" STREQUAL "" OR
  392. NOT "${UA_GEN_FILE_BSD}" STREQUAL ""))
  393. message(FATAL_ERROR "ua_generate_nodeset_and_datatypes function requires NAMESPACE_IDX argument if any of FILE_CSV or FILE_BSD are set")
  394. endif()
  395. # Set default value for output dir
  396. if(NOT UA_GEN_OUTPUT_DIR OR "${UA_GEN_OUTPUT_DIR}" STREQUAL "")
  397. set(UA_GEN_OUTPUT_DIR ${PROJECT_BINARY_DIR}/src_generated/open62541)
  398. endif()
  399. # Set default target prefix
  400. if(NOT UA_GEN_TARGET_PREFIX OR "${UA_GEN_TARGET_PREFIX}" STREQUAL "")
  401. set(UA_GEN_TARGET_PREFIX "open62541-generator")
  402. endif()
  403. set(NODESET_DEPENDS_TARGET "")
  404. set(NODESET_TYPES_ARRAY "UA_TYPES")
  405. if(NOT "${UA_GEN_FILE_BSD}" STREQUAL "")
  406. # Generate Datatypes for nodeset
  407. ua_generate_datatypes(
  408. NAME "types_${UA_GEN_NAME}"
  409. TARGET_PREFIX "${UA_GEN_TARGET_PREFIX}"
  410. TARGET_SUFFIX "types-${UA_GEN_NAME}"
  411. NAMESPACE_IDX ${UA_GEN_NAMESPACE_IDX}
  412. FILE_CSV "${UA_GEN_FILE_CSV}"
  413. FILES_BSD "${UA_GEN_FILE_BSD}"
  414. OUTPUT_DIR "${UA_GEN_OUTPUT_DIR}"
  415. )
  416. set(NODESET_DEPENDS_TARGET "${UA_GEN_TARGET_PREFIX}-types-${UA_GEN_NAME}")
  417. set(NODESET_TYPES_ARRAY "UA_TYPES_${GEN_NAME_UPPER}")
  418. ua_generate_nodeid_header(
  419. NAME "${UA_GEN_NAME}_nodeids"
  420. ID_PREFIX "${GEN_NAME_UPPER}"
  421. FILE_CSV "${UA_GEN_FILE_CSV}"
  422. OUTPUT_DIR "${UA_GEN_OUTPUT_DIR}"
  423. TARGET_PREFIX "${UA_GEN_TARGET_PREFIX}"
  424. TARGET_SUFFIX "ids-${UA_GEN_NAME}"
  425. )
  426. set(NODESET_DEPENDS_TARGET ${NODESET_DEPENDS_TARGET} "${UA_GEN_TARGET_PREFIX}-ids-${UA_GEN_NAME}")
  427. endif()
  428. # Create a list of nodesets on which this nodeset depends on
  429. if (NOT UA_GEN_DEPENDS OR "${UA_GEN_DEPENDS}" STREQUAL "" )
  430. set(NODESET_DEPENDS "${open62541_NODESET_DIR}/Schema/Opc.Ua.NodeSet2.xml")
  431. set(TYPES_DEPENDS "UA_TYPES")
  432. else()
  433. foreach(f ${UA_GEN_DEPENDS})
  434. if(EXISTS ${f})
  435. set(NODESET_DEPENDS ${NODESET_DEPENDS} "${f}")
  436. else()
  437. string(REPLACE "-" "_" DEPENDS_NAME "${f}")
  438. get_property(DEPENDS_FILE GLOBAL PROPERTY "UA_GEN_NS_DEPENDS_FILE_${DEPENDS_NAME}")
  439. if(NOT DEPENDS_FILE OR "${DEPENDS_FILE}" STREQUAL "")
  440. message(FATAL_ERROR "Nodeset dependency ${f} needs to be generated before ${UA_GEN_NAME}")
  441. endif()
  442. set(NODESET_DEPENDS ${NODESET_DEPENDS} "${DEPENDS_FILE}")
  443. get_property(DEPENDS_TYPES GLOBAL PROPERTY "UA_GEN_NS_DEPENDS_TYPES_${DEPENDS_NAME}")
  444. set(TYPES_DEPENDS ${TYPES_DEPENDS} "${DEPENDS_TYPES}")
  445. set(NODESET_DEPENDS_TARGET ${NODESET_DEPENDS_TARGET} "${UA_GEN_TARGET_PREFIX}-ns-${f}")
  446. endif()
  447. endforeach()
  448. endif()
  449. set(NODESET_INTERNAL "")
  450. if (${UA_GEN_INTERNAL})
  451. set(NODESET_INTERNAL "INTERNAL")
  452. endif()
  453. ua_generate_nodeset(
  454. NAME "${UA_GEN_NAME}"
  455. FILE "${UA_GEN_FILE_NS}"
  456. TYPES_ARRAY "${NODESET_TYPES_ARRAY}"
  457. ${NODESET_INTERNAL}
  458. DEPENDS_TYPES ${TYPES_DEPENDS}
  459. DEPENDS_NS ${NODESET_DEPENDS}
  460. DEPENDS_TARGET ${NODESET_DEPENDS_TARGET}
  461. OUTPUT_DIR "${UA_GEN_OUTPUT_DIR}"
  462. TARGET_PREFIX "${UA_GEN_TARGET_PREFIX}"
  463. )
  464. endfunction()