5.1 使用平台无关的文件操作

NOTE:此示例代码可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-5/recipe-01 中找到，其中包含一个C++例子。该示例在CMake 3.5版(或更高版本)中是有效的，并且已经在GNU/Linux、macOS和Windows上进行过测试。

有些项目构建时，可能需要与平台的文件系统进行交互。也就是检查文件是否存在、创建新文件来存储临时信息、创建或提取打包文件等等。使用CMake不仅能够在不同的平台上生成构建系统，还能够在不复杂的逻辑情况下，进行文件操作，从而独立于操作系统。本示例将展示，如何以可移植的方式下载库文件。

准备工作

我们将展示如何提取Eigen库文件，并使用提取的源文件编译我们的项目。这个示例中，将重用第3章第7节的线性代数例子linear-algebra.cpp，用来检测外部库和程序、检测特征库。这里，假设已经包含Eigen库文件，已在项目构建前下载。

具体实施

项目需要解压缩Eigen打包文件，并相应地为目标设置包含目录:

  1. 首先，使能C++11项目:

    1. cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
    3. project(recipe-01 LANGUAGES CXX)
    5. set(CMAKE_CXX_STANDARD 11)
    6. set(CMAKE_CXX_EXTENSIONS OFF)
    7. set(CMAKE_CXX_STANDARD_REQUIRED ON)

  2. 我们将自定义目标添加到构建系统中，自定义目标将提取构建目录中的库文件:

    1. add_custom_target(unpack-eigen
    2.   ALL
    3.   COMMAND
    4.       ${CMAKE_COMMAND} -E tar xzf ${CMAKE_CURRENT_SOURCE_DIR}/eigen-eigen-5a0156e40feb.tar.gz
    5.   COMMAND
    6.       ${CMAKE_COMMAND} -E rename eigen-eigen-5a0156e40feb eigen-3.3.4
    7.   WORKING_DIRECTORY
    8.       ${CMAKE_CURRENT_BINARY_DIR}
    9.   COMMENT
    10.       "Unpacking Eigen3 in ${CMAKE_CURRENT_BINARY_DIR}/eigen-3.3.4"
    11.   )

  3. 为源文件添加了一个可执行目标:

    1. add_executable(linear-algebra linear-algebra.cpp)

  4. 由于源文件的编译依赖于Eigen头文件，需要显式地指定可执行目标对自定义目标的依赖关系:

    1. add_dependencies(linear-algebra unpack-eigen)

  5. 最后，指定包含哪些目录:

    1. target_include_directories(linear-algebra
    2.   PRIVATE
    3.       ${CMAKE_CURRENT_BINARY_DIR}/eigen-3.3.4
    4.   )

工作原理

细看add_custom_target这个命令：

  1. add_custom_target(unpack-eigen
  2.   ALL
  3.   COMMAND
  4.       ${CMAKE_COMMAND} -E tar xzf ${CMAKE_CURRENT_SOURCE_DIR}/eigen-eigen-5a0156e40feb.tar.gz
  5.   COMMAND
  6.       ${CMAKE_COMMAND} -E rename eigen-eigen-5a0156e40feb eigen-3.3.4
  7.   WORKING_DIRECTORY
  8.       ${CMAKE_CURRENT_BINARY_DIR}
  9.   COMMENT
  10.       "Unpacking Eigen3 in ${CMAKE_CURRENT_BINARY_DIR}/eigen-3.3.4"
  11.   )

构建系统中引入了一个名为unpack-eigen的目标。因为我们传递了ALL参数，目标将始终被执行。COMMAND参数指定要执行哪些命令。本例中，我们希望提取存档并将提取的目录重命名为egan -3.3.4，通过以下两个命令实现:

  1. ${CMAKE_COMMAND} -E tar xzf ${CMAKE_CURRENT_SOURCE_DIR}/eigen-eigen-
  2. 5a0156e40feb.tar.gz
  3. ${CMAKE_COMMAND} -E rename eigen-eigen-5a0156e40feb eigen-3.3.4

注意，使用-E标志调用CMake命令本身来执行实际的工作。对于许多常见操作，CMake实现了一个对所有操作系统都通用的接口，这使得构建系统独立于特定的平台。add_custom_target命令中的下一个参数是工作目录。我们的示例中，它对应于构建目录：CMAKE_CURRENT_BINARY_DIR。最后一个参数COMMENT，用于指定CMake在执行自定义目标时输出什么样的消息。

更多信息

构建过程中必须执行一系列没有输出的命令时，可以使用add_custom_target命令。正如我们在本示例中所示，可以将自定义目标指定为项目中其他目标的依赖项。此外，自定义目标还可以依赖于其他目标。

使用-E标志可以以与操作系统无关的方式，运行许多公共操作。运行cmake -E或cmake -E help可以获得特定操作系统的完整列表。例如，这是Linux系统上命令的摘要:

  1. Usage: cmake -E <command> [arguments...]
  2. Available commands:
  3.   capabilities              - Report capabilities built into cmake in JSON format
  4.   chdir dir cmd [args...]   - run command in a given directory
  5.   compare_files file1 file2 - check if file1 is same as file2
  6.   copy <file>... destination  - copy files to destination (either file or directory)
  7.   copy_directory <dir>... destination   - copy content of <dir>... directories to 'destination' directory
  8.   copy_if_different <file>... destination  - copy files if it has changed
  9.   echo [<string>...]        - displays arguments as text
  10.   echo_append [<string>...] - displays arguments as text but no new line
  11.   env [--unset=NAME]... [NAME=VALUE]... COMMAND [ARG]...
  12.                             - run command in a modified environment
  13.   environment               - display the current environment
  14.   make_directory <dir>...   - create parent and <dir> directories
  15.   md5sum <file>...          - create MD5 checksum of files
  16.   sha1sum <file>...         - create SHA1 checksum of files
  17.   sha224sum <file>...       - create SHA224 checksum of files
  18.   sha256sum <file>...       - create SHA256 checksum of files
  19.   sha384sum <file>...       - create SHA384 checksum of files
  20.   sha512sum <file>...       - create SHA512 checksum of files
  21.   remove [-f] <file>...     - remove the file(s), use -f to force it
  22.   remove_directory dir      - remove a directory and its contents
  23.   rename oldname newname    - rename a file or directory (on one volume)
  24.   server                    - start cmake in server mode
  25.   sleep <number>...         - sleep for given number of seconds
  26.   tar [cxt][vf][zjJ] file.tar [file/dir1 file/dir2 ...]
  27.                             - create or extract a tar or zip archive
  28.   time command [args...]    - run command and display elapsed time
  29.   touch file                - touch a file.
  30.   touch_nocreate file       - touch a file but do not create it.
  31. Available on UNIX only:
  32.   create_symlink old new    - create a symbolic link new -> old