CMake教程（八）：添加定制命令和生成的文件

news2024/12/25 1:59:48

本篇继续 CMake 官网教程的第八篇教程，所用材料是 Step8 目录下的源代码。

本篇教程主要讲解如何通过 CMake 生成一个头文件，该头文件当中包含了 1 到 10 的平方根表格，然后在程序的其它部分包含这个生成的头文件。

出于教学的目的，我们现在不打算使用标准库的 log 和 exp 函数。打算使用 mysqrt 函数提前生成一个预计算的表格。本节，我们创建这个表格并将其作为构建过程的一部分，然后将表格编译进程序当中。

首先，在 MathFunctions/CMakeLists.txt 文件中移除对 log 和 exp 函数的检查。接着，在 mysqrt.cxx 文件中移除对 HAVE_LOG 和 HAVE_EXP 的检查。同时，删除 #include <cmath>。

在 MathFunctions 子目录下，MakeTable.cxx 文件用于生成表格。

第一步是在 MathFunctions 子目录下创建 MakeTable.cmake 文件，然后该文件的内容如下：

# 首先生成MakeTable可执行文件
add_executable(MakeTable MakeTable.cxx)
target_link_libraries(MakeTable PRIVATE tutorial_compiler_flags)
# 添加 command 以生成源代码
# OUTPUT后面的参数指明了生成的文件名以及所在的目录
add_custom_command(
  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Table.h
  COMMAND MakeTable ${CMAKE_CURRENT_BINARY_DIR}/Table.h
  DEPENDS MakeTable
  )

第二步是修改 MathFunctions/CMakeLists.txt 文件。
● 需要让 CMake 知道 mysqrt.cxx 依赖于生成的文件 Table.h：

add_library(SqrtLibrary STATIC
              mysqrt.cxx
              ${CMAKE_CURRENT_BINARY_DIR}/Table.h
              )

● 还需要将当前二进制目录添加到 include 目录的列表中，这样 mysqrt.cxx 文件就能够找到 Table.h 文件。

  target_include_directories(SqrtLibrary PRIVATE
                             ${CMAKE_CURRENT_BINARY_DIR}
                             )

● 最后，需要包含 MakeTable.cmake：
在这里插入图片描述

最后一步，修改 mysqrt.cxx 文件，该文件的全部内容如下：

// #include "MathFunctions.h"
#include "mysqrt.h"
// 包含头文件
#include "Table.h"
#include <cmath>
#include <iostream>

namespace mathfunctions {
namespace detail {
// a hack square root calculation using simple operations
double mysqrt(double x)
{
  if (x <= 0) {
    return 0;
  }

  // if we have both log and exp then use them
#if defined(HAVE_LOG) && defined(HAVE_EXP)
  double result = std::exp(std::log(x) * 0.5);
  std::cout << "Computing sqrt of " << x << " to be " << result
            << " using log and exp" << std::endl;
#else

  // use the table to help find an initial value
  double 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 iterations
  for (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;
  }
#endif
  return result;
}
}
}