CMake

Sapphire Suite's CMake tools.

How to use

Include CMake directory to include all cmake files:

add_subdirectory(CMake)

or include single function file:

include(CMake/SA_TargetSources.cmake)

Documentations

SA_ConfigureProject

Helper macro to configure a cmake project to match Sapphire Suite's requirements. Must be called after project() cmake function.

SA_ConfigureProject(<project>)

SA_ConfigureTarget

Helper function to configure a cmake target to match Sapphire Suite's requirements. Should be called after add_library or add_executable target.

SA_ConfigureProject(<target> LINK <link_opt>)

Default values: <link_opt> = PUBLIC

SA_FetchGoogleBenchmark

Helper function to clone Google benchmark repository in ThirdParty/ folder at config time.

SA_FetchGoogleBenchmark()

SA_FetchGoogleTest

Helper function to clone Google Test repository in ThirdParty/ folder at config time.

SA_FetchGoogleTest()

SA_FetchModule

Helper function to clone a module from Sapphire Suite and add it to ThirdParty/SA/ folder at config time. Automatically init git submodules.

SA_FetchModule(<module_name>)

SA_SetIntrinsicsFlags

Helper function to enable intrinsics compilation flags for a target.

SA_SetIntrinsicsFlags(<target> LINK <link_opt>)

Default values: <link_opt> = PUBLIC

SA_SetRTTIFlags

Helper function to enable RTTI compilation flags for a target.

SA_SetRTTIFlags(<target> LINK <link_opt> TOGGLE <on_off>)

Default values: <link_opt> = PUBLIC <on_off> = ON

SA_TargetSouces

Helper functions to add public and/or private sources and include directories to a target.

SA_TargetSources(<target> PUBLIC_SRC_DIR <public_src_dir> PUBLIC_INCL_DIR <public_include_dir> PRIVATE_SRC_DIR <private_src_dir>)
SA_TargetPublicSources(<target> SRC_DIR <public_src_dir> INCL_DIR <public_include_dir>)
SA_TargetPrivateSources(<target> SRC_DIR <private_src_dir>)
SA_TargetInterfaceSources(<target> SRC_DIR <public_src_dir> INCL_DIR <public_include_dir>)

Default values: <public_src_dir> = "Include/SA/<module_name>" <public_include_dir> = "Include" <private_src_dir> = "Source/SA/<module_name>"

Authors

Maxime "mrouffet" ROUFFET - main developer ([email protected])