2023年7月26日发(作者:)
cmake语法⼿册及教程⼀,cmake 变量引⽤的⽅式:前⾯我们已经提到了,使⽤${}进⾏变量的引⽤。在 IF 等语句中,是直接使⽤变量名⽽不通过${}取值⼆,cmake ⾃定义变量的⽅式:主要有隐式定义和显式定义两种,前⾯举了⼀个隐式定义的例⼦,就是 PROJECT 指令,他会隐式的定义
三,cmake 常⽤变量:1,CMAKE_BINARY_DIR PROJECT_BINARY_DIR
6,CMAKE_CURRENT_LIST_LINE输出这个变量所在的⾏ 7,CMAKE_MODULE_PATH这个变量⽤来定义⾃⼰的 cmake 模块所在的路径。如果你的⼯程⽐较复杂,有可能会⾃⼰编写⼀些 cmake 模块,这些 cmake 模块是随你的⼯程发布的,为了让 cmake 在处理 时找到这些模块,你需要通过 SET 指令,将⾃⼰的 cmake 模块路径设置⼀下。⽐如SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)这时候你就可以通过 INCLUDE 指令来调⽤⾃⼰的模块了。8,EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH分别⽤来重新定义最终结果的存放⽬录,前⾯我们已经提到了这两个变量。9,PROJECT_NAME返回通过 PROJECT 指令定义的项⽬名称。
四,cmake 调⽤环境变量的⽅式使⽤$ENV{NAME}指令就可以调⽤系统的环境变量了。⽐如MESSAGE(STATUS “HOME dir: $ENV{HOME}”)设置环境变量的⽅式是:SET(ENV{变量名} 值)1,CMAKE_INCLUDE_CURRENT_DIR⾃动添加 CMAKE_CURRENT_BINARY_DIR 和 CMAKE_CURRENT_SOURCE_DIR 到当前处理的 。相当于在每个 加⼊:INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR}${CMAKE_CURRENT_SOURCE_DIR})2,CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE将⼯程提供的头⽂件⽬录始终⾄于系统头⽂件⽬录的前⾯,当你定义的头⽂件确实跟系统发⽣冲突时可以提供⼀些帮助。3,CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH 我们在上⼀节已经提及。五,系统信息1,CMAKE_MAJOR_VERSION,CMAKE 主版本号,⽐如 2.4.6 中的 22,CMAKE_MINOR_VERSION,CMAKE 次版本号,⽐如 2.4.6 中的 43,CMAKE_PATCH_VERSION,CMAKE 补丁等级,⽐如 2.4.6 中的 64,CMAKE_SYSTEM,系统名称,⽐如 Linux-2.6.225,CMAKE_SYSTEM_NAME,不包含版本的系统名,⽐如 Linux6,CMAKE_SYSTEM_VERSION,系统版本,⽐如 2.6.227,CMAKE_SYSTEM_PROCESSOR,处理器名称,⽐如 i686.8,UNIX,在所有的类 UNIX 平台为 TRUE,包括 OS X 和 cygwin9,WIN32,在所有的 win32 平台为 TRUE,包括 cygwin六,主要的开关选项:1,CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS,⽤来控制 IF ELSE 语句的书写⽅式,在下⼀节语法部分会讲到。2,BUILD_SHARED_LIBS这个开关⽤来控制默认的库编译⽅式,如果不进⾏设置,使⽤ ADD_LIBRARY 并没有指定库类型的情况下,默认编译⽣成的库都是静态库。如果 SET(BUILD_SHARED_LIBS ON)后,默认⽣成的为动态库。3,CMAKE_C_FLAGS设置 C 编译选项,也可以通过指令 ADD_DEFINITIONS()添加。4,CMAKE_CXX_FLAGS设置 C++编译选项,也可以通过指令 ADD_DEFINITIONS()添加。⼩结:本章介绍了⼀些较常⽤的 cmake 变量,这些变量仅仅是所有 cmake 变量的很少⼀部分,⽬前 cmake 的英⽂⽂档也是⽐较缺乏的,如果需要了解更多的 cmake 变量,更好的⽅式是阅读⼀些成功项⽬的 cmake ⼯程⽂件,⽐如 KDE4 的代码。
⼋,cmake 常⽤指令前⾯我们讲到了 cmake 常⽤的变量,相信“cmake 即编程”的感觉会越来越明显,⽆论如何,我们仍然可以看到 cmake ⽐ autotools 要简单很多。接下来我们就要集中的看⼀看cmake 所提供的常⽤指令。在前⾯的章节我们已经讨论了很多指令的⽤法,如PROJECT,ADD_EXECUTABLE,INSTALL,ADD_SUBDIRECTORY,SUBDIRS,INCLUDE_DIRECTORIES,LINK_DIRECTORIES,TARGET_LINK_LIBRARIES,SET 等。本节会引⼊更多的 cmake 指令,为了编写的⽅便,我们将按照 cmake man page 的顺序来介绍各种指令,不再推荐使⽤的指令将不再介绍,INSTALL 系列指令在安装部分已经做了⾮常详细的说明,本节也不在提及。(你可以将本章理解成选择性翻译,但是会加⼊更多的个⼈理解)⼀,基本指令1,ADD_DEFINITIONS向 C/C++编译器添加-D 定义,⽐如:ADD_DEFINITIONS(-DENABLE_DEBUG -DABC),参数之间⽤空格分割。如果你的代码中定义了#ifdef ENABLE_DEBUG #endif,这个代码块就会⽣效。如果要添加其他的编译器开关,可以通过 CMAKE_C_FLAGS 变量和 CMAKE_CXX_FLAGS 变量设置。2,ADD_DEPENDENCIES定义 target 依赖的其他 target,确保在编译本 target 之前,其他的 target 已经被构建。ADD_DEPENDENCIES(target-name depend-target1 depend-target2 ...)3,ADD_EXECUTABLE、ADD_LIBRARY、ADD_SUBDIRECTORY 前⾯已经介绍过了,这⾥不再罗唆。4,ADD_TEST 与 ENABLE_TESTING 指令。ENABLE_TESTING 指令⽤来控制 Makefile 是否构建 test ⽬标,涉及⼯程所有⽬录。语法很简单,没有任何参数,ENABLE_TESTING(),⼀般情况这个指令放在⼯程的主 中.ADD_TEST 指令的语法是:ADD_TEST(testname Exename arg1 arg2 ...)testname 是⾃定义的 test 名称,Exename 可以是构建的⽬标⽂件也可以是外部脚本等等。后⾯连接传递给可执⾏⽂件的参数。如果没有在同⼀个 中打开ENABLE_TESTING()指令,任何 ADD_TEST 都是⽆效的。⽐如我们前⾯的 Helloworld 例⼦,可以在⼯程主 中添加ADD_TEST(mytest ${PROJECT_BINARY_DIR}/bin/main)ENABLE_TESTING()⽣成 Makefile 后,就可以运⾏ make test 来执⾏测试了。5,AUX_SOURCE_DIRECTORY基本语法是:AUX_SOURCE_DIRECTORY(dir VARIABLE)作⽤是发现⼀个⽬录下所有的源代码⽂件并将列表存储在⼀个变量中,这个指令临时被⽤来⾃动构建源⽂件列表。因为⽬前 cmake 还不能⾃动发现新添加的源⽂件。⽐如AUX_SOURCE_DIRECTORY(. SRC_LIST)ADD_EXECUTABLE(main ${SRC_LIST})你也可以通过后⾯提到的 FOREACH 指令来处理这个 LIST6,CMAKE_MINIMUM_REQUIRED其语法为 CMAKE_MINIMUM_REQUIRED(VERSION versionNumber [FATAL_ERROR])⽐如 CMAKE_MINIMUM_REQUIRED(VERSION 2.5 FATAL_ERROR)如果 cmake 版本⼩与 2.5,则出现严重错误,整个过程中⽌。7,EXEC_PROGRAM在 处理过程中执⾏命令,并不会在⽣成的 Makefile 中执⾏。具体语法为:EXEC_PROGRAM(Executable [directory in which to run] [ARGS
四,控制指令:1,IF 指令,基本语法为: IF(expression_r_r) # THEN section. COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ELSE(expression_r_r) # ELSE section. COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ENDIF(expression_r_r)另外⼀个指令是 ELSEIF,总体把握⼀个原则,凡是出现 IF 的地⽅⼀定要有对应的ENDIF.出现 ELSEIF 的地⽅,ENDIF 是可选的。表达式的使⽤⽅法如下:IF(var),如果变量不是:空,0,N, NO, OFF, FALSE, NOTFOUND 或_NOTFOUND 时,表达式为真。IF(NOT var ),与上述条件相反。IF(var1 AND var2),当两个变量都为真是为真。IF(var1 OR var2),当两个变量其中⼀个为真时为真。IF(COMMAND cmd),当给定的 cmd 确实是命令并可以调⽤是为真。IF(EXISTS dir)或者 IF(EXISTS file),当⽬录名或者⽂件名存在时为真。IF(file1 IS_NEWER_THAN file2),当 file1 ⽐ file2 新,或者 file1/file2 其中有⼀个不存在时为真,⽂件名请使⽤完整路径。IF(IS_DIRECTORY dirname),当 dirname 是⽬录时,为真。IF(variable MATCHES regex)IF(string MATCHES regex)当给定的变量或者字符串能够匹配正则表达式 regex 时为真。⽐如:IF("hello" MATCHES "ell")MESSAGE("true")ENDIF("hello" MATCHES "ell")IF(variable LESS number)IF(string LESS number)IF(variable GREATER number)IF(string GREATER number)IF(variable EQUAL number)IF(string EQUAL number)数字⽐较表达式IF(variable STRLESS string)IF(string STRLESS string)IF(variable STRGREATER string)IF(string STRGREATER string)IF(variable STREQUAL string)IF(string STREQUAL string)按照字母序的排列进⾏⽐较.IF(DEFINED variable),如果变量被定义,为真。⼀个⼩例⼦,⽤来判断平台差异:IF(WIN32) MESSAGE(STATUS “This is windows.”) #作⼀些 Windows 相关的操作ELSE(WIN32) MESSAGE(STATUS “This is not windows”) #作⼀些⾮ Windows 相关的操作ENDIF(WIN32)上述代码⽤来控制在不同的平台进⾏不同的控制,但是,阅读起来却并不是那么舒服,ELSE(WIN32)之类的语句很容易引起歧义。这就⽤到了我们在“常⽤变量”⼀节提到的 CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS 开关。可以 SET(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS ON)这时候就可以写成:IF(WIN32)ELSE()ENDIF()如果配合 ELSEIF 使⽤,可能的写法是这样:IF(WIN32)#do something related to WIN32ELSEIF(UNIX)#do something related to UNIXELSEIF(APPLE)#do something related to APPLEENDIF(WIN32)2,WHILEWHILE 指令的语法是: WHILE(condition) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ENDWHILE(condition)其真假判断条件可以参考 IF 指令。3,FOREACHFOREACH 指令的使⽤⽅法有三种形式:1,列表 FOREACH(loop_var arg1 arg2 ...) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... ENDFOREACH(loop_var)像我们前⾯使⽤的 AUX_SOURCE_DIRECTORY 的例⼦AUX_SOURCE_DIRECTORY(. SRC_LIST)FOREACH(F ${SRC_LIST}) MESSAGE(${F})ENDFOREACH(F)2,范围FOREACH(loop_var RANGE total)ENDFOREACH(loop_var)从 0 到 total 以1为步进举例如下:FOREACH(VAR RANGE 10)MESSAGE(${VAR})ENDFOREACH(VAR)最终得到的输出是:3,范围和步进FOREACH(loop_var RANGE start stop [step])ENDFOREACH(loop_var)从 start 开始到 stop 结束,以 step 为步进,举例如下FOREACH(A RANGE 5 15 3)MESSAGE(${A})ENDFOREACH(A)最终得到的结果是:581114这个指令需要注意的是,知道遇到 ENDFOREACH 指令,整个语句块才会得到真正的执⾏。⼩结:本⼩节基本涵盖了常⽤的 cmake 指令,包括基本指令、查找指令、安装指令以及控制语句等,特别需要注意的是,在控制语句条件中使⽤变量,不能⽤${}引⽤,⽽是直接应⽤变量名。
掌握了以上的各种控制指令,你应该完全可以通过 cmake 管理复杂的程序了,下⼀节,我们将介绍⼀个⽐较复杂的例⼦,通过他来演⽰本章的⼀些指令,并介绍模块的概念。九,复杂的例⼦:模块的使⽤和⾃定义模块你现在还会觉得 cmake 简单吗?本章我们将着重介绍系统预定义的 Find 模块的使⽤以及⾃⼰编写 Find 模块,系统中提供了其他各种模块,⼀般情况需要使⽤ INCLUDE 指令显式的调⽤,FIND_PACKAGE 指令是⼀个特例,可以直接调⽤预定义的模块.其实使⽤纯粹依靠 cmake 本⾝提供的基本指令来管理⼯程是⼀件⾮常复杂的事情,所以,cmake 设计成了可扩展的架构,可以通过编写⼀些通⽤的模块来扩展 cmake.在本章,我们准备⾸先介绍⼀下 cmake 提供的 FindCURL 模块的使⽤。然后,基于我们前⾯的 libhello 共享库,编写⼀个 模块.如果
发布者:admin,转转请注明出处:http://www.yc00.com/web/1690363465a338216.html
评论列表(0条)