component.cmake 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624
  1. #
  2. # Internal function for retrieving component properties from a component target.
  3. #
  4. function(__component_get_property var component_target property)
  5. get_property(val TARGET ${component_target} PROPERTY ${property})
  6. set(${var} "${val}" PARENT_SCOPE)
  7. endfunction()
  8. #
  9. # Internal function for setting component properties on a component target. As with build properties,
  10. # set properties are also keeped track of.
  11. #
  12. function(__component_set_property component_target property val)
  13. cmake_parse_arguments(_ "APPEND" "" "" ${ARGN})
  14. if(__APPEND)
  15. set_property(TARGET ${component_target} APPEND PROPERTY ${property} "${val}")
  16. else()
  17. set_property(TARGET ${component_target} PROPERTY ${property} "${val}")
  18. endif()
  19. # Keep track of set component properties
  20. __component_get_property(properties ${component_target} __COMPONENT_PROPERTIES)
  21. if(NOT property IN_LIST properties)
  22. __component_set_property(${component_target} __COMPONENT_PROPERTIES ${property} APPEND)
  23. endif()
  24. endfunction()
  25. #
  26. # Given a component name or alias, get the corresponding component target.
  27. #
  28. function(__component_get_target var name_or_alias)
  29. # Look at previously resolved names or aliases
  30. idf_build_get_property(component_names_resolved __COMPONENT_NAMES_RESOLVED)
  31. list(FIND component_names_resolved ${name_or_alias} result)
  32. if(NOT result EQUAL -1)
  33. # If it has been resolved before, return that value. The index is the same
  34. # as in __COMPONENT_NAMES_RESOLVED as these are parallel lists.
  35. idf_build_get_property(component_targets_resolved __COMPONENT_TARGETS_RESOLVED)
  36. list(GET component_targets_resolved ${result} target)
  37. set(${var} ${target} PARENT_SCOPE)
  38. return()
  39. endif()
  40. idf_build_get_property(component_targets __COMPONENT_TARGETS)
  41. # Assume first that the paramters is an alias.
  42. string(REPLACE "::" "_" name_or_alias "${name_or_alias}")
  43. set(component_target ___${name_or_alias})
  44. if(component_target IN_LIST component_targets)
  45. set(${var} ${component_target} PARENT_SCOPE)
  46. set(target ${component_target})
  47. else() # assumption is wrong, try to look for it manually
  48. unset(target)
  49. foreach(component_target ${component_targets})
  50. __component_get_property(_component_name ${component_target} COMPONENT_NAME)
  51. if(name_or_alias STREQUAL _component_name)
  52. set(target ${component_target})
  53. break()
  54. endif()
  55. endforeach()
  56. set(${var} ${target} PARENT_SCOPE)
  57. endif()
  58. # Save the resolved name or alias
  59. if(target)
  60. idf_build_set_property(__COMPONENT_NAMES_RESOLVED ${name_or_alias} APPEND)
  61. idf_build_set_property(__COMPONENT_TARGETS_RESOLVED ${target} APPEND)
  62. endif()
  63. endfunction()
  64. #
  65. # Called during component registration, sets basic properties of the current component.
  66. #
  67. macro(__component_set_properties)
  68. __component_get_property(type ${component_target} COMPONENT_TYPE)
  69. # Fill in the rest of component property
  70. __component_set_property(${component_target} SRCS "${sources}")
  71. __component_set_property(${component_target} INCLUDE_DIRS "${__INCLUDE_DIRS}")
  72. if(type STREQUAL LIBRARY)
  73. __component_set_property(${component_target} PRIV_INCLUDE_DIRS "${__PRIV_INCLUDE_DIRS}")
  74. endif()
  75. __component_set_property(${component_target} LDFRAGMENTS "${__LDFRAGMENTS}")
  76. __component_set_property(${component_target} EMBED_FILES "${__EMBED_FILES}")
  77. __component_set_property(${component_target} EMBED_TXTFILES "${__EMBED_TXTFILES}")
  78. __component_set_property(${component_target} REQUIRED_IDF_TARGETS "${__REQUIRED_IDF_TARGETS}")
  79. endmacro()
  80. #
  81. # Perform a quick check if given component dir satisfies basic requirements.
  82. #
  83. function(__component_dir_quick_check var component_dir)
  84. set(res 1)
  85. get_filename_component(abs_dir ${component_dir} ABSOLUTE)
  86. # Check this is really a directory and that a CMakeLists.txt file for this component exists
  87. # - warn and skip anything which isn't valid looking (probably cruft)
  88. if(NOT IS_DIRECTORY "${abs_dir}")
  89. message(STATUS "Unexpected file in components directory: ${abs_dir}")
  90. set(res 0)
  91. endif()
  92. get_filename_component(base_dir ${abs_dir} NAME)
  93. string(SUBSTRING "${base_dir}" 0 1 first_char)
  94. if(NOT first_char STREQUAL ".")
  95. if(NOT EXISTS "${abs_dir}/CMakeLists.txt")
  96. message(STATUS "Component directory ${abs_dir} does not contain a CMakeLists.txt file. "
  97. "No component will be added")
  98. set(res 0)
  99. endif()
  100. else()
  101. set(res 0) # quietly ignore dot-folders
  102. endif()
  103. set(${var} ${res} PARENT_SCOPE)
  104. endfunction()
  105. #
  106. # Write a CMake file containing all component and their properties. This is possible because each component
  107. # keeps a list of all its properties.
  108. #
  109. function(__component_write_properties output_file)
  110. idf_build_get_property(component_targets __COMPONENT_TARGETS)
  111. foreach(component_target ${component_targets})
  112. __component_get_property(component_properties ${component_target} __COMPONENT_PROPERTIES)
  113. foreach(property ${component_properties})
  114. __component_get_property(val ${component_target} ${property})
  115. set(component_properties_text
  116. "${component_properties_text}\nset(__component_${component_target}_${property} ${val})")
  117. endforeach()
  118. file(WRITE ${output_file} "${component_properties_text}")
  119. endforeach()
  120. endfunction()
  121. #
  122. # Add a component to process in the build. The components are keeped tracked of in property
  123. # __COMPONENT_TARGETS in component target form.
  124. #
  125. function(__component_add component_dir prefix)
  126. # For each component, two entities are created: a component target and a component library. The
  127. # component library is created during component registration (the actual static/interface library).
  128. # On the other hand, component targets are created early in the build
  129. # (during adding component as this function suggests).
  130. # This is so that we still have a target to attach properties to up until the component registration.
  131. # Plus, interface libraries have limitations on the types of properties that can be set on them,
  132. # so later in the build, these component targets actually contain the properties meant for the
  133. # corresponding component library.
  134. idf_build_get_property(component_targets __COMPONENT_TARGETS)
  135. get_filename_component(abs_dir ${component_dir} ABSOLUTE)
  136. get_filename_component(base_dir ${abs_dir} NAME)
  137. if(NOT EXISTS "${abs_dir}/CMakeLists.txt")
  138. message(FATAL_ERROR "Directory '${component_dir}' does not contain a component.")
  139. endif()
  140. set(component_name ${base_dir})
  141. # The component target has three underscores as a prefix. The corresponding component library
  142. # only has two.
  143. set(component_target ___${prefix}_${component_name})
  144. # If a component of the same name has not been added before If it has been added
  145. # before just override the properties. As a side effect, components added later
  146. # 'override' components added earlier.
  147. if(NOT component_target IN_LIST component_targets)
  148. if(NOT TARGET ${component_target})
  149. add_library(${component_target} STATIC IMPORTED)
  150. endif()
  151. idf_build_set_property(__COMPONENT_TARGETS ${component_target} APPEND)
  152. else()
  153. __component_get_property(dir ${component_target} COMPONENT_DIR)
  154. __component_set_property(${component_target} COMPONENT_OVERRIDEN_DIR ${dir})
  155. endif()
  156. set(component_lib __${prefix}_${component_name})
  157. set(component_dir ${abs_dir})
  158. set(component_alias ${prefix}::${component_name}) # The 'alias' of the component library,
  159. # used to refer to the component outside
  160. # the build system. Users can use this name
  161. # to resolve ambiguity with component names
  162. # and to link IDF components to external targets.
  163. # Set the basic properties of the component
  164. __component_set_property(${component_target} COMPONENT_LIB ${component_lib})
  165. __component_set_property(${component_target} COMPONENT_NAME ${component_name})
  166. __component_set_property(${component_target} COMPONENT_DIR ${component_dir})
  167. __component_set_property(${component_target} COMPONENT_ALIAS ${component_alias})
  168. __component_set_property(${component_target} __PREFIX ${prefix})
  169. # Set Kconfig related properties on the component
  170. __kconfig_component_init(${component_target})
  171. endfunction()
  172. #
  173. # Given a component directory, get the requirements by expanding it early. The expansion is performed
  174. # using a separate CMake script (the expansion is performed in a separate instance of CMake in scripting mode).
  175. #
  176. function(__component_get_requirements)
  177. idf_build_get_property(idf_path IDF_PATH)
  178. idf_build_get_property(build_dir BUILD_DIR)
  179. set(build_properties_file ${build_dir}/build_properties.temp.cmake)
  180. set(component_properties_file ${build_dir}/component_properties.temp.cmake)
  181. set(component_requires_file ${build_dir}/component_requires.temp.cmake)
  182. __build_write_properties(${build_properties_file})
  183. __component_write_properties(${component_properties_file})
  184. execute_process(COMMAND "${CMAKE_COMMAND}"
  185. -D "ESP_PLATFORM=1"
  186. -D "BUILD_PROPERTIES_FILE=${build_properties_file}"
  187. -D "COMPONENT_PROPERTIES_FILE=${component_properties_file}"
  188. -D "COMPONENT_REQUIRES_FILE=${component_requires_file}"
  189. -P "${idf_path}/tools/cmake/scripts/component_get_requirements.cmake"
  190. RESULT_VARIABLE result
  191. ERROR_VARIABLE error)
  192. if(NOT result EQUAL 0)
  193. message(FATAL_ERROR "${error}")
  194. endif()
  195. idf_build_get_property(idf_component_manager IDF_COMPONENT_MANAGER)
  196. if(idf_component_manager AND idf_component_manager EQUAL "1")
  197. # Call for component manager once again to inject dependencies
  198. idf_build_get_property(python PYTHON)
  199. execute_process(COMMAND ${python}
  200. "-m"
  201. "idf_component_manager.prepare_components"
  202. "--project_dir=${project_dir}"
  203. "inject_requirements"
  204. "--idf_path=${idf_path}"
  205. "--build_dir=${build_dir}"
  206. "--component_requires_file=${component_requires_file}"
  207. RESULT_VARIABLE result
  208. ERROR_VARIABLE error)
  209. if(NOT result EQUAL 0)
  210. message(FATAL_ERROR "${error}")
  211. endif()
  212. endif()
  213. include(${component_requires_file})
  214. file(REMOVE ${build_properties_file})
  215. file(REMOVE ${component_properties_file})
  216. file(REMOVE ${component_requires_file})
  217. endfunction()
  218. # __component_add_sources, __component_check_target, __component_add_include_dirs
  219. #
  220. # Utility macros for component registration. Adds source files and checks target requirements,
  221. # and adds include directories respectively.
  222. macro(__component_add_sources sources)
  223. set(sources "")
  224. if(__SRCS)
  225. if(__SRC_DIRS)
  226. message(WARNING "SRCS and SRC_DIRS are both specified; ignoring SRC_DIRS.")
  227. endif()
  228. foreach(src ${__SRCS})
  229. get_filename_component(src "${src}" ABSOLUTE BASE_DIR ${COMPONENT_DIR})
  230. list(APPEND sources ${src})
  231. endforeach()
  232. else()
  233. if(__SRC_DIRS)
  234. foreach(dir ${__SRC_DIRS})
  235. get_filename_component(abs_dir ${dir} ABSOLUTE BASE_DIR ${COMPONENT_DIR})
  236. if(NOT IS_DIRECTORY ${abs_dir})
  237. message(FATAL_ERROR "SRC_DIRS entry '${dir}' does not exist.")
  238. endif()
  239. file(GLOB dir_sources "${abs_dir}/*.c" "${abs_dir}/*.cpp" "${abs_dir}/*.S")
  240. if(dir_sources)
  241. foreach(src ${dir_sources})
  242. get_filename_component(src "${src}" ABSOLUTE BASE_DIR ${COMPONENT_DIR})
  243. list(APPEND sources "${src}")
  244. endforeach()
  245. else()
  246. message(WARNING "No source files found for SRC_DIRS entry '${dir}'.")
  247. endif()
  248. endforeach()
  249. endif()
  250. if(__EXCLUDE_SRCS)
  251. foreach(src ${__EXCLUDE_SRCS})
  252. get_filename_component(src "${src}" ABSOLUTE)
  253. list(REMOVE_ITEM sources "${src}")
  254. endforeach()
  255. endif()
  256. endif()
  257. list(REMOVE_DUPLICATES sources)
  258. endmacro()
  259. macro(__component_add_include_dirs lib dirs type)
  260. foreach(dir ${dirs})
  261. get_filename_component(_dir ${dir} ABSOLUTE BASE_DIR ${CMAKE_CURRENT_LIST_DIR})
  262. if(NOT IS_DIRECTORY ${_dir})
  263. message(FATAL_ERROR "Include directory '${_dir}' is not a directory.")
  264. endif()
  265. target_include_directories(${lib} ${type} ${_dir})
  266. endforeach()
  267. endmacro()
  268. macro(__component_check_target)
  269. if(__REQUIRED_IDF_TARGETS)
  270. idf_build_get_property(idf_target IDF_TARGET)
  271. if(NOT idf_target IN_LIST __REQUIRED_IDF_TARGETS)
  272. message(FATAL_ERROR "Component ${COMPONENT_NAME} only supports targets: ${__REQUIRED_IDF_TARGETS}")
  273. endif()
  274. endif()
  275. endmacro()
  276. # __component_set_dependencies, __component_set_all_dependencies
  277. #
  278. # Links public and private requirements for the currently processed component
  279. macro(__component_set_dependencies reqs type)
  280. foreach(req ${reqs})
  281. if(req IN_LIST build_component_targets)
  282. __component_get_property(req_lib ${req} COMPONENT_LIB)
  283. if("${type}" STREQUAL "PRIVATE")
  284. set_property(TARGET ${component_lib} APPEND PROPERTY LINK_LIBRARIES ${req_lib})
  285. set_property(TARGET ${component_lib} APPEND PROPERTY INTERFACE_LINK_LIBRARIES $<LINK_ONLY:${req_lib}>)
  286. elseif("${type}" STREQUAL "PUBLIC")
  287. set_property(TARGET ${component_lib} APPEND PROPERTY LINK_LIBRARIES ${req_lib})
  288. set_property(TARGET ${component_lib} APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${req_lib})
  289. else() # INTERFACE
  290. set_property(TARGET ${component_lib} APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${req_lib})
  291. endif()
  292. endif()
  293. endforeach()
  294. endmacro()
  295. macro(__component_set_all_dependencies)
  296. __component_get_property(type ${component_target} COMPONENT_TYPE)
  297. idf_build_get_property(build_component_targets __BUILD_COMPONENT_TARGETS)
  298. if(NOT type STREQUAL CONFIG_ONLY)
  299. __component_get_property(reqs ${component_target} __REQUIRES)
  300. __component_set_dependencies("${reqs}" PUBLIC)
  301. __component_get_property(priv_reqs ${component_target} __PRIV_REQUIRES)
  302. __component_set_dependencies("${priv_reqs}" PRIVATE)
  303. else()
  304. __component_get_property(reqs ${component_target} __REQUIRES)
  305. __component_set_dependencies("${reqs}" INTERFACE)
  306. endif()
  307. endmacro()
  308. # idf_component_get_property
  309. #
  310. # @brief Retrieve the value of the specified component property
  311. #
  312. # @param[out] var the variable to store the value of the property in
  313. # @param[in] component the component name or alias to get the value of the property of
  314. # @param[in] property the property to get the value of
  315. #
  316. # @param[in, optional] GENERATOR_EXPRESSION (option) retrieve the generator expression for the property
  317. # instead of actual value
  318. function(idf_component_get_property var component property)
  319. cmake_parse_arguments(_ "GENERATOR_EXPRESSION" "" "" ${ARGN})
  320. __component_get_target(component_target ${component})
  321. if(__GENERATOR_EXPRESSION)
  322. set(val "$<TARGET_PROPERTY:${component_target},${property}>")
  323. else()
  324. __component_get_property(val ${component_target} ${property})
  325. endif()
  326. set(${var} "${val}" PARENT_SCOPE)
  327. endfunction()
  328. # idf_component_set_property
  329. #
  330. # @brief Set the value of the specified component property related. The property is
  331. # also added to the internal list of component properties if it isn't there already.
  332. #
  333. # @param[in] component component name or alias of the component to set the property of
  334. # @param[in] property the property to set the value of
  335. # @param[out] value value of the property to set to
  336. #
  337. # @param[in, optional] APPEND (option) append the value to the current value of the
  338. # property instead of replacing it
  339. function(idf_component_set_property component property val)
  340. cmake_parse_arguments(_ "APPEND" "" "" ${ARGN})
  341. __component_get_target(component_target ${component})
  342. if(__APPEND)
  343. __component_set_property(${component_target} ${property} "${val}" APPEND)
  344. else()
  345. __component_set_property(${component_target} ${property} "${val}")
  346. endif()
  347. endfunction()
  348. # idf_component_register
  349. #
  350. # @brief Register a component to the build, creating component library targets etc.
  351. #
  352. # @param[in, optional] SRCS (multivalue) list of source files for the component
  353. # @param[in, optional] SRC_DIRS (multivalue) list of source directories to look for source files
  354. # in (.c, .cpp. .S); ignored when SRCS is specified.
  355. # @param[in, optional] EXCLUDE_SRCS (multivalue) used to exclude source files for the specified
  356. # SRC_DIRS
  357. # @param[in, optional] INCLUDE_DIRS (multivalue) public include directories for the created component library
  358. # @param[in, optional] PRIV_INCLUDE_DIRS (multivalue) private include directories for the created component library
  359. # @param[in, optional] LDFRAGMENTS (multivalue) linker script fragments for the component
  360. # @param[in, optional] REQUIRES (multivalue) publicly required components in terms of usage requirements
  361. # @param[in, optional] PRIV_REQUIRES (multivalue) privately required components in terms of usage requirements
  362. # or components only needed for functions/values defined in its project_include.cmake
  363. # @param[in, optional] REQUIRED_IDF_TARGETS (multivalue) the list of IDF build targets that the component only supports
  364. # @param[in, optional] EMBED_FILES (multivalue) list of binary files to embed with the component
  365. # @param[in, optional] EMBED_TXTFILES (multivalue) list of text files to embed with the component
  366. # @param[in, optional] KCONFIG (single value) override the default Kconfig
  367. # @param[in, optional] KCONFIG_PROJBUILD (single value) override the default Kconfig
  368. function(idf_component_register)
  369. set(options)
  370. set(single_value KCONFIG KCONFIG_PROJBUILD)
  371. set(multi_value SRCS SRC_DIRS EXCLUDE_SRCS
  372. INCLUDE_DIRS PRIV_INCLUDE_DIRS LDFRAGMENTS REQUIRES
  373. PRIV_REQUIRES REQUIRED_IDF_TARGETS EMBED_FILES EMBED_TXTFILES)
  374. cmake_parse_arguments(_ "${options}" "${single_value}" "${multi_value}" ${ARGN})
  375. if(NOT __idf_component_context)
  376. message(FATAL_ERROR "Called idf_component_register from a non-component directory.")
  377. endif()
  378. __component_check_target()
  379. __component_add_sources(sources)
  380. # Add component manifest and lock files to list of dependencies
  381. set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${COMPONENT_DIR}/idf_component.yml")
  382. set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${COMPONENT_DIR}/dependencies.lock")
  383. # Create the final target for the component. This target is the target that is
  384. # visible outside the build system.
  385. __component_get_target(component_target ${COMPONENT_ALIAS})
  386. __component_get_property(component_lib ${component_target} COMPONENT_LIB)
  387. # Use generator expression so that users can append/override flags even after call to
  388. # idf_build_process
  389. idf_build_get_property(include_directories INCLUDE_DIRECTORIES GENERATOR_EXPRESSION)
  390. idf_build_get_property(compile_options COMPILE_OPTIONS GENERATOR_EXPRESSION)
  391. idf_build_get_property(c_compile_options C_COMPILE_OPTIONS GENERATOR_EXPRESSION)
  392. idf_build_get_property(cxx_compile_options CXX_COMPILE_OPTIONS GENERATOR_EXPRESSION)
  393. idf_build_get_property(common_reqs ___COMPONENT_REQUIRES_COMMON)
  394. include_directories("${include_directories}")
  395. add_compile_options("${compile_options}")
  396. add_c_compile_options("${c_compile_options}")
  397. add_cxx_compile_options("${cxx_compile_options}")
  398. # Unfortunately add_definitions() does not support generator expressions. A new command
  399. # add_compile_definition() does but is only available on CMake 3.12 or newer. This uses
  400. # add_compile_options(), which can add any option as the workaround.
  401. #
  402. # TODO: Use add_compile_definitions() once minimum supported version is 3.12 or newer.
  403. idf_build_get_property(compile_definitions COMPILE_DEFINITIONS GENERATOR_EXPRESSION)
  404. add_compile_options("${compile_definitions}")
  405. if(common_reqs) # check whether common_reqs exists, this may be the case in minimalistic host unit test builds
  406. list(REMOVE_ITEM common_reqs ${component_lib})
  407. endif()
  408. link_libraries(${common_reqs})
  409. idf_build_get_property(config_dir CONFIG_DIR)
  410. # The contents of 'sources' is from the __component_add_sources call
  411. if(sources OR __EMBED_FILES OR __EMBED_TXTFILES)
  412. add_library(${component_lib} STATIC ${sources})
  413. __component_set_property(${component_target} COMPONENT_TYPE LIBRARY)
  414. __component_add_include_dirs(${component_lib} "${__INCLUDE_DIRS}" PUBLIC)
  415. __component_add_include_dirs(${component_lib} "${__PRIV_INCLUDE_DIRS}" PRIVATE)
  416. __component_add_include_dirs(${component_lib} "${config_dir}" PUBLIC)
  417. set_target_properties(${component_lib} PROPERTIES OUTPUT_NAME ${COMPONENT_NAME} LINKER_LANGUAGE C)
  418. __ldgen_add_component(${component_lib})
  419. else()
  420. add_library(${component_lib} INTERFACE)
  421. __component_set_property(${component_target} COMPONENT_TYPE CONFIG_ONLY)
  422. __component_add_include_dirs(${component_lib} "${__INCLUDE_DIRS}" INTERFACE)
  423. __component_add_include_dirs(${component_lib} "${config_dir}" INTERFACE)
  424. endif()
  425. # Alias the static/interface library created for linking to external targets.
  426. # The alias is the <prefix>::<component name> name.
  427. __component_get_property(component_alias ${component_target} COMPONENT_ALIAS)
  428. add_library(${component_alias} ALIAS ${component_lib})
  429. # Perform other component processing, such as embedding binaries and processing linker
  430. # script fragments
  431. foreach(file ${__EMBED_FILES})
  432. target_add_binary_data(${component_lib} "${file}" "BINARY")
  433. endforeach()
  434. foreach(file ${__EMBED_TXTFILES})
  435. target_add_binary_data(${component_lib} "${file}" "TEXT")
  436. endforeach()
  437. if(__LDFRAGMENTS)
  438. __ldgen_add_fragment_files("${__LDFRAGMENTS}")
  439. endif()
  440. # Set dependencies
  441. __component_set_all_dependencies()
  442. # Make the COMPONENT_LIB variable available in the component CMakeLists.txt
  443. set(COMPONENT_LIB ${component_lib} PARENT_SCOPE)
  444. # COMPONENT_TARGET is deprecated but is made available with same function
  445. # as COMPONENT_LIB for compatibility.
  446. set(COMPONENT_TARGET ${component_lib} PARENT_SCOPE)
  447. __component_set_properties()
  448. endfunction()
  449. # idf_component_mock
  450. #
  451. # @brief Create mock component with CMock and register it to IDF build system.
  452. #
  453. # @param[in, optional] INCLUDE_DIRS (multivalue) list include directories which belong to the header files
  454. # provided in MOCK_HEADER_FILES. If any other include directories are necessary, they need
  455. # to be passed here, too.
  456. # @param[in, optional] MOCK_HEADER_FILES (multivalue) list of header files from which the mocks shall be generated.
  457. # @param[in, optional] REQUIRES (multivalue) any other components required by the mock component.
  458. #
  459. function(idf_component_mock)
  460. set(options)
  461. set(single_value)
  462. set(multi_value MOCK_HEADER_FILES INCLUDE_DIRS)
  463. cmake_parse_arguments(_ "${options}" "${single_value}" "${multi_value}" ${ARGN})
  464. list(APPEND __REQUIRES "cmock")
  465. set(MOCK_GENERATED_HEADERS "")
  466. set(MOCK_GENERATED_SRCS "")
  467. set(MOCK_FILES "")
  468. set(IDF_PATH $ENV{IDF_PATH})
  469. set(CMOCK_DIR "${IDF_PATH}/components/cmock/CMock")
  470. set(MOCK_GEN_DIR "${CMAKE_CURRENT_BINARY_DIR}")
  471. list(APPEND __INCLUDE_DIRS "${MOCK_GEN_DIR}/mocks")
  472. foreach(header_file ${__MOCK_HEADER_FILES})
  473. get_filename_component(file_without_dir ${header_file} NAME_WE)
  474. list(APPEND MOCK_GENERATED_HEADERS "${MOCK_GEN_DIR}/mocks/Mock${file_without_dir}.h")
  475. list(APPEND MOCK_GENERATED_SRCS "${MOCK_GEN_DIR}/mocks/Mock${file_without_dir}.c")
  476. endforeach()
  477. file(MAKE_DIRECTORY "${MOCK_GEN_DIR}/mocks")
  478. idf_component_register(SRCS "${MOCK_GENERATED_SRCS}"
  479. INCLUDE_DIRS ${__INCLUDE_DIRS}
  480. REQUIRES ${__REQUIRES})
  481. execute_process(COMMAND ${CMAKE_COMMAND} -E env "UNITY_DIR=${IDF_PATH}/components/unity/unity"
  482. ruby
  483. ${CMOCK_DIR}/lib/cmock.rb
  484. -o${CMAKE_CURRENT_SOURCE_DIR}/mock/mock_config.yaml
  485. ${__MOCK_HEADER_FILES}
  486. WORKING_DIRECTORY ${MOCK_GEN_DIR}
  487. RESULT_VARIABLE cmock_result)
  488. endfunction()
  489. #
  490. # Deprecated functions
  491. #
  492. # register_component
  493. #
  494. # Compatibility function for registering 3.xx style components.
  495. macro(register_component)
  496. spaces2list(COMPONENT_SRCS)
  497. spaces2list(COMPONENT_SRCDIRS)
  498. spaces2list(COMPONENT_ADD_INCLUDEDIRS)
  499. spaces2list(COMPONENT_PRIV_INCLUDEDIRS)
  500. spaces2list(COMPONENT_REQUIRES)
  501. spaces2list(COMPONENT_PRIV_REQUIRES)
  502. spaces2list(COMPONENT_ADD_LDFRAGMENTS)
  503. spaces2list(COMPONENT_EMBED_FILES)
  504. spaces2list(COMPONENT_EMBED_TXTFILES)
  505. spaces2list(COMPONENT_SRCEXCLUDE)
  506. idf_component_register(SRCS "${COMPONENT_SRCS}"
  507. SRC_DIRS "${COMPONENT_SRCDIRS}"
  508. INCLUDE_DIRS "${COMPONENT_ADD_INCLUDEDIRS}"
  509. PRIV_INCLUDE_DIRS "${COMPONENT_PRIV_INCLUDEDIRS}"
  510. REQUIRES "${COMPONENT_REQUIRES}"
  511. PRIV_REQUIRES "${COMPONENT_PRIV_REQUIRES}"
  512. LDFRAGMENTS "${COMPONENT_ADD_LDFRAGMENTS}"
  513. EMBED_FILES "${COMPONENT_EMBED_FILES}"
  514. EMBED_TXTFILES "${COMPONENT_EMBED_TXTFILES}"
  515. EXCLUDE_SRCS "${COMPONENT_SRCEXCLUDE}")
  516. endmacro()
  517. # require_idf_targets
  518. #
  519. # Compatibility function for requiring IDF build targets for 3.xx style components.
  520. function(require_idf_targets)
  521. set(__REQUIRED_IDF_TARGETS "${ARGN}")
  522. __component_check_target()
  523. endfunction()
  524. # register_config_only_component
  525. #
  526. # Compatibility function for registering 3.xx style config components.
  527. macro(register_config_only_component)
  528. register_component()
  529. endmacro()
  530. # component_compile_options
  531. #
  532. # Wrapper around target_compile_options that passes the component name
  533. function(component_compile_options)
  534. target_compile_options(${COMPONENT_LIB} PRIVATE ${ARGV})
  535. endfunction()
  536. # component_compile_definitions
  537. #
  538. # Wrapper around target_compile_definitions that passes the component name
  539. function(component_compile_definitions)
  540. target_compile_definitions(${COMPONENT_LIB} PRIVATE ${ARGV})
  541. endfunction()