从Target 角度看 CMake （四）自己开发Find＜PackageName＞.cmake

        模块的开发者通常不提供 Find<PackageName>.cmake，这样的文件通常是cmake 内置的，如果引用者找不到对应模块的 Find<PackageName>.cmake 也找不到 <PackageName>Config.cmake 则要自己开发的Find<PackageName>.cmake 了。

        Find<PackageName>.cmake 的功能就是按照 find_package 传进来的参数来查找对应的module, 并判断版本是否满足要求，以及是否包含了全部的模块等等。

参数

         严格意义上讲，本模块使用的参数并不完全来自 Find<PackageName>.cmake 调用时传入的参数，而是还包括环境变量、全局变量、cmake 命令行选项等。

1. 环境变量：通过$ENV{<环境变量名>} 来得到环境变量的值;
2. CMake 内部变量：可以通过 if DEFINED <变量名> 来判断此变量是否已经定义;

        当环境变量与CMake 内部变量定义了同样的内容时，CMake 内部变量的代行级应高于环境变量的优先级，可参考以下代码进行设置：

if (NOT DEFINED CALC_INCLUDE_DIRS)
  if (NOT DEFINED ENV{CALC_INCLUDE_DIRS})
    message(FATAL_ERROR "CALC_INCLUDE_DIRS not defined.")
  else()
    set(CAL_INCLUDE_DIRS $ENV{CAL_INCLUDE_DIRS})
  endif()
endif()

        每次在调用 find_package 时，cmake 会为里面的参数生成如下格式的参数，以便在Find<PackageName>.cmake 中使用:

<PackageName>_Find_<VAR>

        <PackageName>是 find_package 中指定的名称，<VAR>则对应find_package中的变量名。如：BOOST_FIND_VERSION 就是find_package 中要求的版本号，而要列出find_package中要求的所有组件，则可以使用以下方法： 

#列出 find_package 中要求的组件

foreach(_comp IN LISTS <PackageName>_FIND_COMPONENTS)
    message(${_comp})
endforeach()

find_program

        除了设置cmake变量与环境变量以外，还有一种方法可以找到模块的位置，对于有可执行文件或连接库的模块，可以先在PATH 路径中查找对应的可执行文件，再根据可执行文件的位置反推其它文件的位置。可以通过以下命令找到python 的位置，并由此推断出其它python 相关文件的位置。

find_program(PYTHON NAMES python)
if (NOT PYTHON_NOTFOUND)
    message("PYTHON PATH:${PYTHON}")
endif()

查找文件

        当查找路径设置要之后，就可以查找指定的文件是否存在。以下是判断calc 模块下的 add.h 是否存在的例子：

if (NOT EXISTS "${CALC_INCLUDE_DIRS}/add.h)
    message(FATAL_ERROR "CALC_INCLUDE_DIRS defined, but there isn't add.h in the folder!")
endif()

设置变量与属性

判断版本与组件信息是否匹配

        这一步并不需要自己开发，只要设置好变量，然后调用 FindPackageHandleStandardArgs 即可。以下是一个简单的的例子。

include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(CALC
  REQUIRED_VARS
    CALC_INCLUDE_DIRS
    CALC_LINK_DIRS
  VERSION_VAR
    CALC_VERSION
)

        在上面的例子中，find_package_handle_standard_args 会检查CALC_INCLUDE_DIRS 与 CALC_LINK_DIRS 是否已经设置，并比较 CALC_VERSION 与 CALC_FIND_VERSION 的值是否满足要求，执行成功则会设置 <PackageName>_FOUND 

        我刚开始用这个函数的时候，有点儿小迷惑，CALC_INCLUDE_DIRS 与 CALC_LINK_DIRS 都是我自己在主程序中设置的变量，为什么这里还要判断一下，后来才明白，CALC_INCLUDE_DIRS 与 CALC_LINK_DIRS 的来源可能不只是cmake 程序，也可能来源于环境变量或根据CALC_ROOT 推导而来，所以它们是输出，至于与输入一至，则是巧合。