CMake中add_definitions/add_compile

CMake中add_definitions/add_compile_definitions的使用

news2024/9/21 14:29:40

CMake中的add_definitions命令用于在源文件的编译中添加-D定义标志，其格式如下：

add_definitions(-DFOO -DBAR ...)

将当前目录中的target的定义添加到编译器命令行(compiler command line)中,无论是在调用此命令之前还是之后添加的,还是之后添加的子目录中的target的定义。这个命令可以用来添加任何标志(flag),但它的目的是添加预处理器定义(preprocessor definitions)。
注意：此命令已被其它命令所取代：
(1).使用add_compile_definitions命令添加预处理定义。
(2).使用include_directories命令添加包含目录(include directories)。
(3).使用add_compile_options命令添加其它选项。
以-D或/D开头的看起来像预处理定义的标志会自动添加到当前目录的COMPILE_DEFINITIONS目录属性中。出于向后兼容性的原因，具有非平凡值(non-trivial values)的定义可以保留在标志集中，而不是转换。

add_definitions(-DSAMPLE_ADD)
add_definitions(-DSAMPLE_ADD_VALUE=10)

include_directories(include)
add_library(add STATIC source/add.cpp)
add_executable(main samples/sample_add.cpp)
target_link_libraries(main add)

CMake中的add_compile_definitions命令用于将预处理器定义添加到源文件的编译中，其格式如下：

add_compile_definitions(<definition> ...)

将预处理器定义添加到编译器命令行。
预处理程序定义将添加到当前CMakeLists文件的COMPILE_DEFINITIONS目录属性中。它们也被添加到当前CMakeLists文件中每个target的COMPILE_DEFINITIONS target属性中。
定义使用语法VAR或VAR=value指定。不支持函数样式定义(function-style definitions)。CMake将自动为本机构建系统正确地转义该值(注意，CMake语言语法可能需要转义以指定某些值)。
add_compile_definitions命令的参数可以使用语法$<...>的"生成器表达式"。

add_compile_definitions(SAMPLE_ADD)
add_compile_definitions(SAMPLE_ADD_VALUE=10)

include_directories(include)
add_library(add STATIC source/add.cpp)
add_executable(main samples/sample_add.cpp)
target_link_libraries(main add)

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

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[@]}; do
		echo "  $0 ${param}"
	done

	exit -1
}

if [ $# != 1 ]; then
	usage
fi

flag=0
for param in ${params[@]}; do
	if [ $1 == ${param} ]; then
		flag=1
		break
	fi
done

if [ ${flag} == 0 ]; then
	echo "Error: parameter \"$1\" is not supported"
	usage
	exit -1
fi

if [[ ! -d "build" ]]; then
	mkdir build
	cd build
else
	cd build
fi

echo "==== 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_add_definitions.cmake内容为上面的所有测试代码段

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

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

#include <iostream>
#include <add.hpp>

int main()
{
#ifdef SAMPLE_ADD
    fprintf(stdout, "**** defined SAMPLE_ADD ****\n");
#endif
#if SAMPLE_ADD_VALUE == 10
    fprintf(stdout, "#### defined SAMPLE_ADD_VALUE 10 ####\n");
#endif

    int a = 2, b = 3;
    fprintf(stdout, "%d+%d=%d\n", a, b, add(a,b));
    return 0;
}

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