本文使用的示例代码见1-简单开始cmake实践-CSDN博客。
假设,出于本教程的目的,我们决定不使用平台log和exp函数,而是希望生成一个预先计算值的表,以便在mysqrt函数中使用。在本节中,我们将创建表作为构建过程的一部分,然后将该表编译到我们的应用程序中。
首先,让我们删除MathFunctions/CMakeLists.txt中对日志和exp函数的检查。然后从mysqrt.cxx中删除对HAVE_LOG和HAVE_EXP的检查。同时,我们可以删除#include <cmath>。
在MathFunctions子目录中,有一个名为MakeTable的新源文件。已提供CXX生成表格。
检查完文件后,我们可以看到表是作为有效的c++代码生成的,并且输出文件名作为参数传入。
下一步是创建MathFunctions/MakeTable.cmake。然后,将适当的命令添加到文件中以构建MakeTable可执行文件,然后将其作为构建过程的一部分运行。需要几个命令来完成这个任务。
首先,为MakeTable添加一个可执行文件。
// MathFunctions/MakeTable.cmakeadd_executable(MakeTable MakeTable.cxx)
在创建可执行文件之后,我们使用target_link_libraries()将tutorial_compiler_flags添加到可执行文件中。
// MathFunctions/MakeTable.cmake
target_link_libraries(MakeTable PRIVATE tutorial_compiler_flags)
然后添加一个自定义命令,指定如何通过运行MakeTable生成Table.h。
// MathFunctions/MakeTable.cmake
add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Table.hCOMMAND MakeTable ${CMAKE_CURRENT_BINARY_DIR}/Table.hDEPENDS MakeTable)
解释:
-
OUTPUT
参数:- 指定了自定义命令生成的输出文件。在这个例子中,
${CMAKE_CURRENT_BINARY_DIR}/Table.h
是生成的输出文件的路径和名称。
- 指定了自定义命令生成的输出文件。在这个例子中,
-
COMMAND
参数:- 指定了实际的命令。在这里,命令是
MakeTable ${CMAKE_CURRENT_BINARY_DIR}/Table.h
。这意味着要在构建过程中执行MakeTable
程序,并将其输出写入${CMAKE_CURRENT_BINARY_DIR}/Table.h
文件中。
- 指定了实际的命令。在这里,命令是
-
DEPENDS
参数:- 指定了生成输出文件所依赖的其他文件或目标。在这里,指定了
MakeTable
,表明在执行命令之前,需要确保MakeTable
已经被构建或可执行。
- 指定了生成输出文件所依赖的其他文件或目标。在这里,指定了
总结:
通过 add_custom_command
,上述代码片段实现了以下功能:
- 在 CMake 构建过程中,定义了一个名为
Table.h
的自定义生成规则。 - 当构建过程需要
${CMAKE_CURRENT_BINARY_DIR}/Table.h
这个文件时,会执行MakeTable
程序来生成它。 - 确保在执行生成命令之前,会先构建
MakeTable
。
这种方法通常用于生成代码、复制文件或执行其他自定义构建任务,使得 CMake 的构建系统能够灵活地扩展和自定义。
接下来我们要让CMake知道这个mysqrt.cxx依赖于生成的文件Table.h。这是通过将生成的Table.h添加到SqrtLibrary库的源列表中来实现的。
// MathFunctions/CMakeLists.txt¶add_library(SqrtLibrary STATICmysqrt.cxx${CMAKE_CURRENT_BINARY_DIR}/Table.h)
我们还必须将当前二进制目录添加到包含目录列表中,以便可以找到Table.h并由mysqrt.cxx包含。
// MathFunctions/CMakeLists.txttarget_include_directories(SqrtLibrary PRIVATE${CMAKE_CURRENT_BINARY_DIR})# link SqrtLibrary to tutorial_compiler_flags
作为最后一步,我们需要包含MakeTable.cmake在MathFunctions/CMakeLists.txt的顶部。
// MathFunctions/CMakeLists.txt¶include(MakeTable.cmake)
现在让我们使用生成的表。首先,修改mysqrt.cxx以包括Tbale.h。接下来,我们可以重写mysqrt函数来使用这个表:
// MathFunctions/mysqrt.cxxdouble mysqrt(double x)
{if (x <= 0) {return 0;}// use the table to help find an initial valuedouble result = x;if (x >= 1 && x < 10) {std::cout << "Use the table to help find an initial value " << std::endl;result = sqrtTable[static_cast<int>(x)];}// do ten iterationsfor (int i = 0; i < 10; ++i) {if (result <= 0) {result = 0.1;}double delta = x - (result * result);result = result + 0.5 * delta / result;std::cout << "Computing sqrt of " << x << " to be " << result << std::endl;}return result;
}
}
}
当编译这个项目时,它将首先构建MakeTable可执行文件。然后,它将运行MakeTable以生成Table.h。最后,它将编译mysqrt.cxx,mysqrt.cxx包含了Table.h来生成MathFunctions库。
mkdir Step8_build
cd Step8_build
cmake ../Step8
cmake --build .
运行Tutorial可执行文件并验证它是否正在使用表。
./Tutorial 9