PICMake （版本 1.2）

1. PICMake简介

1.1. PICMake是神马？

你还在学CMake的过程中毫无头绪吗？你还在为复杂程序库依赖发愁吗？你是否觉得原生CMake的编写冗余而低效？那就快来学习和使用PICMake吧！只需要一行，无论是可执行，动态库还是静态库，轻松搞定！同时高效支持多目标，复杂库的编译安装，从此告别大量冗余CMake代码，专注开发核心应用程序，编译不再愁！ 例如下面是使用PICMake编译一个依赖OpenGL的可执行文件，只需要一行！（第一行是加载PICMake，好吧，如果也要算那就是两行）：

include(PICMake)
pi_add_target(demo BIN src main.cpp REQUIRED OpenGL)

从此告别一堆罗嗦的find_package和其他冗余代码！

那么如何做到的呢？这一切的秘密都在PICMake.cmake这一个文件中哦,稍微啃一啃这个代码，绝对瞬间提高你对CMake的认识水平哦～好啦好啦，源码我们留给大家自己去深究，小编先给大家介绍PICMake的使用吧！

注释： 由于CMake仍然有很多弹性，不够统一的风格可能导致相互之间的支持较差，因此导致用户的工作量增大。 可以认为PICMake其实是规定了一个使用CMake的标准,当用户按照此标准来使用CMake时，可以大大简化工作流程。PICMake目前主要针对Linux下的C++工程，目前主要集成了CV领域的常用库支持，我们将持续对其进行改进更新，也欢迎更多开发者提出更多的意见！

1.2. PICMake的安装

好啦好啦，安装PICMake与使用CMake的过程完全一致，相信编译过CMake项目的娃子们一定不会陌生（嘿嘿～～），同时我们也建议大家使用下面的习惯来编译CMake项目哦：

mkdir build
cd build
cmake ..
make
sudo make install

实际上，PICMake本身核心只有一个文件，那就是cmake目录下面的那个，用户可以直接将它放在自己的项目中！为了让大家了解到PICMake的使用方式，我们把项目本身设计成了一个cmake工程，工程本身就是一个使用的例子哦～ 对于安装后的PICMake，可使用sudo make uninstall 进行卸载，不要问我卸载是在哪里支持的，这是PICMake的秘密～～

1.3. 目录结构

PICMake的目录结构如下：

+- PICMake
++- CMakeLists          -- PICMake安装文件与库示例
++- README.md           -- PICMake介绍文件
++- cmake               -- cmake相关
+++- PICMake.cmake.in   -- 安装支持文件
+++- PICMake.cmake      -- PICMake的主体文档
+++- CMake.md           -- CMake学习文档
+++- learn              -- 辅助学习的文件夹
+++- Find*.cmake        -- 依赖包寻找脚本
++- src                 -- 库框架示例
++- examples            -- 使用示例

2. PICMake的使用介绍

2.1. 使用PICMake编译简单可执行和库文件

新的PICMake支持自动生成CMakeList.txt文件啦，如下项目只需要一行命令自动生成：

picmake -m shared -src showImage.cpp -require OpenCV

在前面我们已经简单提到，使用PICMake只需要一行即可完成可执行和库编译，而实际上我们建议在加上固定的两行，标准的写法应该如下(例子详见examples/0_simple_app)：

cmake_minimum_required(VERSION 2.8)     # 添加原因： 新版本的cmake规定第一行应该声明版本需求
include(PICMake)                        # 加载PICMake支持，也可以直接include(cmake/PICMake.cmake)
pi_add_target(simple_library SHARED showImage.cpp REQUIRED OpenCV)# 编译依赖OpenCV的简单库
pi_report_target()                      # 添加原因： PICMake建议加上用于报告最终将被编译的目标

可以看到添加的两行基本上是比较固定的，第一行是CMake的规定，最后一行是用于报告将会被编译的目标文件。 这里用到的一个核心函数是pi_add_target,其用法是:

pi_add_target(<name> <BIN/STATIC/SHARED> <src1/dir1　...>
　　　　　　　　 [MODULES module1 ...]
　　　　　　　　 [REQUIRED module1 ...]
　　　　　　　　 [DEPENDENCY target1 ...])

第一个参数是目标名称，第二个参数是编译目标类型，第三个参数是要添加的源文件或文件夹，MODULES代表的是非必须第三方库列表，程序里可通过#ifdef HAS_QT宏选择性编译相关代码，REQUIRED代表必须的第三方库列表, DEPENDENCY代表当前目标所依赖的target。

2.2. 使用PICMake编译多个目标并安装

对于较大一些的工程，往往包含多个目标和库，同时可能包含需要安装的目标，而本项目本身就展示了这样一个工程的PICMake写法（详见本工程"CMakeLists.txt")：

cmake_minimum_required(VERSION 2.6)
project(PICMake)
include(${CMAKE_CURRENT_LIST_DIR}/cmake/PICMake.cmake)# Use PICMake

if(FALSE) # Tree style
  add_subdirectory(src)
else()  # All in one
  pi_add_target(StaticLibDemo STATIC src/StaticLibDemo) # 静态库示例
  pi_add_target(SharedLibDemo SHARED src/SharedLibDemo) # 动态库示例
  pi_add_target(AppDemo BIN src/AppDemo DEPENDENCY StaticLibDemo SharedLibDemo REQUIRED OpenCV) # 依赖前两个库的可执行文件
  pi_add_target(ConditionalApp BIN src/ConditionalApp MODULES PIL Qt System REQUIRED OpenCV) #条件编译示例
endif()

pi_install(CMAKE ${PROJECT_SOURCE_DIR}/cmake/PICMake.cmake.in)# 安装文件示例，其中自动支持卸载
pi_report_target()

这里添加了一个pi_install函数，其详细用法为：

pi_install([HEADERS header1/dir1 ...]
　　　　　　 [TARGETS target1 ...]
　　　　　　 [CMAKE cmake_config]
　　　　　　 [BIN_DESTINATION dir]
　　　　　　 [LIB_DESTINATION dir]
　　　　　　 [HEADER_DESTINATION dir])

2.3. 编写PICMake支持的FindPackage.cmake

对于MODULES和REQUIRED中设定的每一个PACKAGE，PICMake都会调用find_package函数去寻找对应的FindPackge.cmake文档。其中FindPackage.cmake文档需要去寻找PACKAGE的头文件路径和库文件模块。 下表列出了FindPackage的主要输入变量：

对于指令find_package(PIL 1.1.0 REQUIRED base cv）， PIL_FIND_NAME即为PIL， PIL_FIND_VERSION为1.1.0， 其中PIL_FIND_VERSION_MAJOR为1, PIL_FIND_VERSION_MINOR为1, PIL_FIND_VERSION_PATCH为0， PIL_FIND_COMPONENTS为base和cv。 下表列出了FindPackage.cmake中需要给定的一些参数：

其详细实现可参考FindPIL.cmake。

3. 内建函数和宏

4. CMake附录

4.1. CMake常用变量

4.2. CMake常用命令

find_package(<package> [version] [EXACT] [QUIET] [MODULE]
             [REQUIRED] [[COMPONENTS] [components...]]
             [OPTIONAL_COMPONENTS components...]
             [NO_POLICY_SCOPE])
             
set_property(<GLOBAL                            |
              DIRECTORY [dir]                   |
              TARGET    [target1 [target2 ...]] |
              SOURCE    [src1 [src2 ...]]       |
              TEST      [test1 [test2 ...]]     |
              CACHE     [entry1 [entry2 ...]]>
             [APPEND] [APPEND_STRING]
             PROPERTY <name> [value1 [value2 ...]])

get_property(<variable>
             <GLOBAL             |
              DIRECTORY [dir]    |
              TARGET    <target> |
              SOURCE    <source> |
              TEST      <test>   |
              CACHE     <entry>  |
              VARIABLE>
             PROPERTY <name>
             [SET | DEFINED | BRIEF_DOCS | FULL_DOCS])
             
add_subdirectory(source_dir [binary_dir]
                 [EXCLUDE_FROM_ALL])

4.3. CMake常用语法

4.3.1. 基本语法

• set(Foo a b c)
• set(Foo "a b c")
• $ENV{VAR}
• set(ENV{VAR} /home}

4.3.2. if(TRUE|FALSE) ... elseif() ... else() ... endif()

True if the constant is 1, ON, YES, TRUE, Y, or a non-zero number. False if the constant is 0, OFF, NO, FALSE, N, IGNORE, NOTFOUND, the empty string, or ends in the suffix -NOTFOUND. Named boolean constants are case-insensitive. If the argument is not one of these constants, it is treated as a variable.

判断表达式中常用的指令:

4.3.3. foreach(VAR a b c) ... endforeach()

4.3.4. macro(MACRO_FUNCTION_NAME [PARAMETERS]) ... endmacro()

4.3.5. function(FUNCTION_NAME PARAMETERS) ... return() ... endfunction()

函数可以返回，可以用 return()命令返回。如果要从函数中返回值，只能通过参数返回：

#定义函数 get_lib从给定的目录查找指定的库，并把它传回到参数 lib_FILE中

function(get_lib lib_FILE lib_NAME lib_PATH)
       #message("lib_name:""${lib_NAME}")
       set(__LIB "__LIB-NOTFOUND")
       #message("__LIB:""${__LIB}")

       find_library(__LIB ${lib_NAME} ${lib_PATH})

       if(__LIB STREQUAL "__LIB-NOTFOUND")
              message("don't find ${lib_NAME} librarys in ${lib_PATH}")
              return()
       endif()

       #message("__LIB:""${__LIB}")
       set(${lib_FILE} ${__LIB}PARENT_SCOPE)
endfunction(get_lib)

set命令中 PARENT_SCOPE表示传递给函数调用者所拥有的变量