项目最近需要在windows平台上运行,我花了几周时间将linux服务器移植到windows平台,目前已能正常运行。然而,新的需求出现了,考虑到代码结构和组织在两个平台上是分开的,为了能够同步维护两边的代码,我们需要一个跨平台的项目编译解决方案。经过调研,我们选择了cmake工具。本文将详细介绍使用cmake进行生产项目的一些基础知识。
一、CMake简介 您可能听说过多种Make工具,例如gnu Make、qt的qmake、微软的MS nmake、BSD Make(pmake)、Makepp等。这些工具遵循不同的规范和标准,所执行的Makefile格式也各不相同。这给跨平台软件的编译带来了挑战:为了在不同平台上编译,必须为每种标准编写Makefile,这无疑是一项繁琐的工作。
CMake正是在此背景下应运而生的工具:它允许开发者编写一种平台无关的CMakeLists.txt文件来定制整个编译流程,然后根据目标用户的平台生成所需的本地化Makefile和工程文件,如linux的Makefile或Windows的visual studio工程。从而实现“一次编写,到处运行”的目标。
1、Linux安装CMake 在Linux上,可以直接使用yum -y install cmake进行安装,默认安装的版本是CMake 2.8.12。
如果需要使用CMake的最新版本,可以访问CMake官方网站(https://www.php.cn/link/6943317304e0f076bc8f12dc02c48e9b。
建议直接使用yum安装,或者从官方网站下载cmake-3.12.0-rc2-Linux-x86_64.tar.gz。
2、Windows安装CMake 在Windows上安装CMake,可以直接从CMake官方网站的下载页面获取,官方提供了msi安装版本和源代码,还提供了一些预编译的版本。
建议在Windows上使用安装版本,也可以下载预编译的版本cmake-3.12.0-rc2-win64-x64.zip,但需要手动设置环境变量。
Windows上既有命令行版本也有GUI版本,具体使用哪种版本取决于您的习惯。
设置环境变量的方法为:我的电脑->属性->高级系统设置->环境变量,然后将CMake的路径添加到path环境变量中。
二、CMake初体验 在本节中,我们假设已经有一个项目,并编写好了CMake的配置文件CMakeLists.txt。
1、Windows使用cmake-gui生成项目
如图所示,在source code处选择CMakeLists.txt文件所在的路径,然后在binaries中选择项目生成的地址,点击configure,选择已安装的编译器(如vs2015)。
然后点击生成,在binaries目录中就会生成Visual Studio的工程文件,打开工程文件即可开始编译。
2、Windows使用cmake生成项目 首先配置好环境变量,然后打开Windows命令行工具,进入项目目录(CMakeLists.txt所在目录),新建一个build文件夹(因为CMake会生成许多中间文件,因此新建一个文件夹,以便需要清理时直接删除build文件夹)。
然后执行cmake ../
在build目录中就会生成Visual Studio的项目文件,Windows上默认生成的是Visual Studio项目。如果需要生成其他编译器的Makefile,则需要使用-G指定编译器,如下:
cmake -G “MinGW Makefiles” ../
可以使用cmake –help查看可用的编译器名称。
生成项目工程文件或Makefile后,就可以使用相应的编译器来编译项目了。
3、Linux使用cmake生成项目 在Linux上使用CMake生成项目与上述第2小节类似。
在CMakeLists.txt所在目录新建build目录,在build目录中执行:
cmake ../
就会在build目录中生成Makefile文件,然后可以继续执行make编译项目。
4、CMake常用指令 cmake [] (
cmake [(-D=
cmake –build
cmake -E
cmake –find-package …
三、CMake配置文件语法 1、指定CMake最低版本 cmake_minimum_required (VERSION 2.6)
2、设置项目名称 project (LearnCMake)
3、创建可执行程序工程(exe) add_executable函数用于创建一个可执行程序工程。
add_executable(
如下所示:
add_executable(FirstExecutable hello_world.cpp)
也可以添加多个源文件到工程中,如下:
add_executable(FirstExecutable main.cpp app_util.h app_util.cpp)
4、创建库文件工程(a/so/lib/dll) add_library函数用于创建一个库文件工程。
add_library(
如下所示:
add_library(SecondLibrary second_library.cpp)
与add_executable类似,也可以添加多个源文件。
add_library(SecondLibrary test.cpp app_util.h app_util.cpp)
默认生成的是静态库,也可以显式设置库的类型为静态库、动态库或模块。BUILD_SHARED_LIBS也可以控制编译生成的库类型。
add_library(SecondLibrary SHARED second_library.cpp)
5、set设置变量 前两节的add_library和add_executable可以添加多个源文件,但文件多了之后可能会占用很长的行,因此我们可以使用set函数进行变量赋值,然后在调用add_library和add_executable生成项目。
如下所示,效果与前面的示例相同。
set(AppUtilSrcs app_util.h app_util.cpp)
add_executable(FirstExecutable main.cpp ${AppUtilSrcs})
add_library(FirstLibrary test.cpp ${AppUtilSrcs})
使用set函数,还可以对变量值进行累加,如下AppUtilSrcs就代表3个文件了:
set(AppUtilSrcs app_util.h app_util.cpp)
set(AppUtilSrcs ${AppUtilSrcs} b.cpp)
除了文件名定义,set还用于变量定义
set(CMAKE_CXX_FLAGS_RELEASE “${CMAKE_CXX_FLAGS_RELEASE} /MT”)
6、代码控制 如果一个项目很大,文件数以千计,那么一个一个文件添加就太麻烦了,因此CMake使用aux_source_directory函数来添加目录到工程中。
如下所示,将目录下所有文件赋值给第一个变量,然后将这个变量加到工程中。
aux_source_directory(“./pbase/src” pbase_lib_src_files)
add_library(pbase ${pbase_lib_src_files})
除了添加文件目录外,我们经常还需要包含第三方库(头文件、库文件)等需求,添加头文件目录功能如下:
include_directories函数用于添加头文件包含目录。
include_directories(“../thirdparty/googletest/googletest/include”)
link_directories函数用于添加需要链接文件的库目录。
link_directories(“../thirdparty/googletest/googletest/lib”)
link_libraries函数用于添加需要连接的库文件。
link_libraries(“protobuf.so”)
链接目标文件和库文件,使用target_link_libraries函数,这里的目标文件是指通过add_executable()和add_library()指令生成的已创建目标文件。
target_link_libraries(test lua mysql)
从编译文件列表中排除文件,可以使用CMake提供的list的REMOVE_ITEM功能来实现。
aux_source_directory(src lua_src)
list(REMOVE_ITEM lua_src “src/lua.c” “src/luac.c”)
7、添加编译选项 CMake使用add_compile_options函数来添加编译选项,示例如下:
add_compile_options(-std=gnu99)
CMake使用add_definitions函数为源文件的编译添加由-D定义的标志,示例如下:
add_definitions(-O3 -g -W -Wall -Wno-deprecated -Woverloaded-virtual -Wwrite-strings -D__WUR= -D_REENTRANT -D_FILE_OFFSET_BITS=64 -DTIXML_USE_STL)
注意,这两个选项都是针对所有平台、编译器,因此需要谨慎使用,最好使用if来进行流程处理。
8、添加其他的CMakeLists.txt 一个CMakeLists.txt里面的target如果要链接其他CMakeLists.txt中的target,可以使用add_subdirectory函数,如下所示:
add_subdirectory(“../thirdparty/googletest/googletest/” gtest)
target_link_libraries(gtest)
9、find_package find_package为外部工程加载设置。
find_package(
QUIET选项将会禁掉包没有被发现时的警告信息。REQUIRED选项表示如果没有找到包,CMake的过程会终止,并输出警告信息。
find_package可以根据CMake内置的.cmake脚本查找相应的库模块,调用find_package成功后,会有相应的变量“生成”有效。
例如,调用find_package(Qt5Widgets)后,返回的变量Qt5Widgets_FOUND和Qt5Widgets_INCLUDE_DIRS就会生效。然后就可以在CMakeLists.txt中使用上述变量了。
10、条件、循环控制 If else结构
if(condition) elseif(condition) else() endif()
for循环
foreach(loop_var arg1 arg2 ...) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... endforeach(loop_var)
while循环
while(condition) COMMAND1(ARGS ...) COMMAND2(ARGS ...) ... endwhile(condition)
11、Install指令 Install指令用于定义安装规则,安装的内容可以包括目标二进制、动态库、静态库以及文件、目录、脚本等。
参数中的TARGETS后面跟的就是我们通过ADD_EXECUTABLE或ADD_LIBRARY定义的目标文件,可能是可执行二进制、动态库、静态库。
目标类型也就相对应的有三种,ARCHIVE特指静态库,LIBRARY特指动态库,RUNTIME特指可执行目标二进制。
INSTALL(TARGETS targets... [[ARCHIVE|LIBRARY|RUNTIME] [DESTINATION <dir>] [PERMISSIONS permissions...] [CONFIGURATIONS [Debug|Release|...]] [COMPONENT <component>] [OPTIONAL] ] [...])
示例如下:
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目录
特别注意的是,您不需要关心TARGETS具体生成的路径,只需要写上TARGETS名称就可以了。
我的博客即将搬运同步至php中文网+社区,邀请大家一同入驻:https://www.php.cn/link/9fe06b33ea459f011178ef3156ff09c7