CMake 实践 小结

网上已经有很多的CMake的总结也好博客也好。

全当个人的记录。如果有错误务必留言。

what is CMake？

一般来说就是一个自动生成makefile的工具。--脚本语言。

why learn it？

大型项目比较方便，也仅此而已。

How to learn it？

　　常用的语言变量：

<projectname>_BINARY_DIR  ==   PROJECT_BINARY_DIR  工程编译路径  /backup/cmake/t1/build

<projectname>_SOURCE_DIR ==  PROJECT_SOURCE_DIR 工程路径  /backup/cmake/t1

EXECUTABLE_OUTPUT_PATH                                                二进制文件的输出目录

LIBRARY_OUTPUT_PATH                                                        共享库目录

CMAKE_INSTALL_PREFIX                                                        install 安装目录的前缀

×.so　　　　　　　　　　　　　　　　　　　　　　　　　　 动态库

×.a　　　　　　　　　　　　　　　　　　　　　　　　　　   静态库

环境变量   CMAKE_INCLUDE_PATH                                          头文件的环境变量  命令INCLUDE_DIRECTORIES(${myHeader}) 替换方式之一

　　掌握常用的语言规则：

make VERBOSE=1

　　显示详细的编译过程

PROJECT(projectname [CXX] [C] [Java])

　　一般就是简单协议下工程的名字。因为默认支持所有语言。

SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

　　显示定义变量

MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] "message to display"...)

　　向终端输出信息

ADD_EXECUTABLE(hello ${SRC_LIST})

　　生成一个hello 的可执行文件

　　在哪里执行以上命令，就在哪里执行更改文件输出的指令

　　　　　SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

ADD_LIBRARY(libname
　　[SHARED|STATIC|MODULE]
　　[EXCLUDE_FROM_ALL]
　　source1 source2 ... sourceN)

　　常用指令例子

　　　　ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

　　　　ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

　　执行生成库的命令

cmake ..

　　在执行build上一层的CMakeList.txt
make

　　执行make

ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

　　这个指令用于向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制存放的位置。　

　　　　一般形式 ADD_SUBDIRECTORY(src bin)

INSTALL(TARGETS targets...
　　[[ARCHIVE|LIBRARY|RUNTIME]
　　[DESTINATION <dir>]
　　[PERMISSIONS permissions...]
　　[CONFIGURATIONS
　　[Debug|Release|...]]
　　[COMPONENT <component>]
　　[OPTIONAL]
　　] [...])

　　用于各个目录的安装 TARGETS== 目标二进制、动态库、静态库以及文件、目录、脚本等。

SET_TARGET_PROPERTIES(target1 target2 ...
　　PROPERTIES prop1 value1
　　prop2 value2 ...)

　　设置目标的性质 比如名称

INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

　　定义头文件的搜索目录（不在标准的库文件目录里面）

　　　　例子 ： INCLUDE_DIRECTORIES(/usr/include/hello)

TARGET_LINK_LIBRARIES(target library1
　　<debug | optimized> library2
　　...)

　　添加需要链接的共享库

　　TARGET_LINK_LIBRARIES(main libhello.a)

FIND_PACKAGE(<name> [major.minor] [QUIET] [NO_MODULE]
　　[[REQUIRED|COMPONENTS] [componets...]])　

　　查找文件包依赖似乎　

　　通过 SET(CMAKE_MODULE_PATH dir)将自己做的cmake 模块放入工程的某个目录
　　中供工程使用 这样就能找到FIND_PACKAGE包了似乎

指令是大小写无关的,参数和变量是大小写相关的。

一般选择外部构建，这样对源文件的改变最小。

需要为任何子目录建立一个 CMakeLists.txt。

前面我们已经提到了,使用${}进行变量的引用。在 IF 等语句中,是直接使用变量名而不通过${}取值。

　　简易例子：

INSTALL(TARGETS myrun mylib mystaticlib
　　RUNTIME DESTINATION bin
　　LIBRARY DESTINATION lib
　　ARCHIVE DESTINATION libstatic
　　)

　　可执行二进制 myrun 安装到${CMAKE_INSTALL_PREFIX}/bin 目录
　　动态库 libmylib 安装到${CMAKE_INSTALL_PREFIX}/lib 目录
　　静态库 libmystaticlib 安装到${CMAKE_INSTALL_PREFIX}/libstatic 目录

INSTALL(DIRECTORY icons scripts/ DESTINATION share/myprojPATTERN "CVS" EXCLUDE
　　PATTERN "scripts/*"
　　PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ
　　GROUP_EXECUTE GROUP_READ)

　　将 icons 目录安装到 <prefix>/share/myproj,将 scripts/中的内容安装到<prefix>/share/myproj
　　不包含目录名为 CVS 的目录,对于 scripts/* 文件指定权限为 OWNER_EXECUTE
　　OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ.

更改prefix的执行方式：

　　cmake -DCMAKE_INSTALL_PREFIX=/tmp/t2/usr ..

　　命令          中间变量                                               执行上级的CMakeLists.txt    
　　然后运行
　　make
　　make install

SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")

　　更改hello_static 的性质 名称 为 hello +++++

SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

加上这两条命令可以生成  libhello.so 和 libhello.a  同名静态库和动态库

　　文件的一般结构：

--PROJ                   工程目录

　　--build              编译目录

　　--doc               工程文档，相关资料

　　--src                源代码目录

　　--bin　　　　  二进制代码

　　--cmake          cmake 模块位置