CMake中target_compile_definitions的使用

CMake中的target_compile_definitions命令用于向target添加编译定义，其格式如下：

target_compile_definitions(<target><INTERFACE|PUBLIC|PRIVATE> [items1...][<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

指定在编译给定的<target>时要使用的编译定义。命名的<target>必须由诸如add_executable或add_library之类的命令创建，并且不能为ALIAS target。
需要INTERFACE, PUBLIC和PRIVATE关键字来指定以下参数(following arguments)的作用域(scope).PRIVATE和PUBLIC项将填充<target>的COMPILE_DEFINITIONS属性。PUBLIC和INTERFACE项将填充<target>的INTERFACE_COMPILE_DEFINITIONS属性。以下参数指定编译定义。重复调用相同的<target>会按调用顺序追加项。
允许在IMPORTED target上设置INTERFACE项。
target_compile_definitions的参数可以使用语法为$<...>的"生成器表达式"。
项(item)上的任何前导-D都将被删除。忽略空项(Empty items are ignored).
定义可以选择有值。
注意：许多编译器将-DFOO等同于-DFOO=1，但是其它工具可能无法在所有情况下都识别出此情况(例如IntelliSense)。

include_directories(include)
add_library(add STATIC source/add.cpp)
add_executable(main samples/sample_add.cpp)
target_link_libraries(main add)target_compile_definitions(main PUBLIC SAMPLE_ADD)
target_compile_definitions(main PRIVATE SAMPLE_ADD_VALUE=10)# 以下各项都是等效的
target_compile_definitions(main PUBLIC FOO)
target_compile_definitions(main PUBLIC -DFOO)  # -D removed
target_compile_definitions(main PUBLIC "" FOO) # "" ignored
target_compile_definitions(main PUBLIC -D FOO) # -D becomes "", then ignored

执行测试代码需要多个文件：

build.sh内容如下：

#! /bin/bash# supported input parameters(cmake commands)
params=(function macro cmake_parse_arguments \find_library find_path find_file find_program find_package \cmake_policy cmake_minimum_required project include \string list set foreach message option if while return \math file configure_file \include_directories add_executable add_library target_link_libraries install \target_sources add_custom_command add_custom_target \add_subdirectory aux_source_directory \set_property set_target_properties define_property \add_definitions target_compile_definitions)usage()
{echo "Error: $0 needs to have an input parameter"echo "supported input parameters:"for param in ${params[@]}; doecho "  $0 ${param}"doneexit -1
}if [ $# != 1 ]; thenusage
fiflag=0
for param in ${params[@]}; doif [ $1 == ${param} ]; thenflag=1breakfi
doneif [ ${flag} == 0 ]; thenecho "Error: parameter \"$1\" is not supported"usageexit -1
fiif [[ ! -d "build" ]]; thenmkdir buildcd build
elsecd build
fiecho "==== test $1 ===="# test_set.cmake: cmake -DTEST_CMAKE_FEATURE=$1 --log-level=verbose ..
# test_option.cmake: cmake -DTEST_CMAKE_FEATURE=$1 -DBUILD_PYTORCH=ON ..
cmake -DTEST_CMAKE_FEATURE=$1 ..
# It can be executed directly on the terminal, no need to execute build.sh, for example: cmake -P test_set.cmake
make
# make install # only used in cmake files with install command

主CMakeLists.txt内容如下：

cmake_minimum_required(VERSION 3.22)
project(cmake_feature_usage)message("#### current cmake version: ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}.${CMAKE_PATCH_VERSION}")
include(test_${TEST_CMAKE_FEATURE}.cmake)
message("==== test finish ====")

test_target_compile_definitions.cmake内容为上面的所有测试代码段

另外还包括三个目录：include,source,samples,它们都是非常简单的实现，仅用于测试，如下：

其中samples/sample_add.cpp内容如下：

#include <iostream>
#include <add.hpp>int main()
{
#ifdef SAMPLE_ADDfprintf(stdout, "**** defined SAMPLE_ADD ****\n");
#endif
#if SAMPLE_ADD_VALUE == 10fprintf(stdout, "#### defined SAMPLE_ADD_VALUE 10 ####\n");
#endifint a = 2, b = 3;fprintf(stdout, "%d+%d=%d\n", a, b, add(a,b));return 0;
}

可能的执行结果如下图所示:

GitHub： https://github.com/fengbingchun/Linux_Code_Test

CMake中target_compile_definitions的使用相关推荐

CMake中target_compile_features的使用
CMake中的target_compile_features命令用向target添加预期的编译器功能(compiler features),其格式如下: target_compile_features ...
CMake中link_directories/target_link_directories的使用
CMake中的link_directories命令用于添加目录使链接器能在其查找库(add directories in which the linker will look for librarie ...
CMake中find_package的使用
CMake中的命令find_package用于查找指定的package. find_package支持两种主要的搜索方法:注意:<PackageName>是区分大小写的 (1) ...
CMake中add_compile_options/target_compile_options的使用
CMake中的add_compile_options命令用于向源文件的编译添加选项,其格式如下: add_compile_options(<option> ...) 将选项添加到COMPI ...
CMake中add_definitions/add_compile_definitions的使用
CMake中的add_definitions命令用于在源文件的编译中添加-D定义标志,其格式如下: add_definitions(-DFOO -DBAR ...) 将当前目录中的target的定义添 ...
CMake中define_property的使用
CMake中的define_property命令用于定义和记录自定义属性,其格式如下: define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE ...
coverage 覆盖多个测试文件时_奇技淫巧[2]：cmake中添加lcov代码覆盖测试
奇技淫巧[2]:cmake中添加lcov代码覆盖测试 1 目的为CMake工程的test添加lcov代码覆盖性测试 2 要点添加lcov支持的方法应该有很多,比较方便的有: (1)利用脚本基于文件 ...
CMake 中的 PUBLIC，PRIVATE，INTERFACE
一.概述 CMake中经常会使用 target_**() 相关命令,target_**() 命令支持通过 PUBLIC,PRIVATE 和 INTERFACE 关键字来控制传播.本文主要介绍下这三个关 ...
cmake中的变量和命令的大小写
1 cmake中要特别注意命令和变量的大小写 2 cmake的内置命令是不区分大小写的 3 cmake内置变量是区分大小写的,或者干脆就说,cmake的所有变量都是区分大小写的这就是变量和命令的不同 ...

CMake中target_compile_definitions的使用

CMake中target_compile_definitions的使用相关推荐

最新文章

热门文章