CMAKE作为一个跨平台的编译工具,有很多优势,但由于需要手动写CMakeLists.txt文件,对工程人员的要求较高,使用起来也问题多多。
本文总结了一些在实际使用中碰到的问题以及解决方案。
cmake 使用模块添加依赖
很多情况下,项目倾向于直接使用第三方的cmake模块,以OpenCV为例,使用方式如下:
set(OpenCV_DIR "${PROJECT_SOURCE_DIR}/${CMAKE_SOURCE_DIR}/third_party/opencv")
find_package(OpenCV CONFIG REQUIRED)
# target_include_directories(${PROJECT_NAME} PRIVATE
${CMAKE_SOURCE_DIR}/third_party/opencv/include)
target_link_libraries(${PROJECT_NAME} PRIVATE
opencv_core opencv_imgproc opencv_imgcodecs
opencv_dnn opencv_highgui opencv_videoio)
这种方式的好处是,不用自己手动添加包含目录,也不用根据编译选项链接库文件,比如下面这样:
target_include_directories(${PROJECT_NAME} PRIVATE
${CMAKE_SOURCE_DIR}/src/Dependence/xxx/x64-windows/include)
target_link_libraries(${PROJECT_NAME} PRIVATE
debug ${CMAKE_SOURCE_DIR}/src/Dependence/xxx/x64-windows/debug/lib/xxx_d.lib #debug版本
optimized ${CMAKE_SOURCE_DIR}/src/Dependence/xxx/x64-windows/lib/xxx.lib) #其他版本
cmake 使用vcpkg安装的模块
CMAKE使用vcpkg安装的模块,可以方便地进行模块管理,仅需要在CMakeLists.txt做一些配置:
set(CMAKE_TOOLCHAIN_FILE ${VCPKG_ROOT})
此选项也可以通过命令行参数传入:
cmake ... -DCMAKE_TOOLCHAIN_FILE="%VCPKG_DIR%/scripts/buildsystems/vcpkg.cmake"
但是需要注意的是:
- 通过
vcpkg install
默认安装的是x86版本,而默认编译成x64版本,这样会出现错误:cmake找不到模块文件*config.cmake。解决方案是,在安装模块时,指定版本模块架构,比如:vcpkg install qt5:x64-windows
-
set(CMAKE_TOOLCHAIN_FILE ${VCPKG_ROOT})
必须放在顶层模块的CMakeLists.txt,否则无效
cmake 编译QT工程
CMAKE 对qt提供了很好的支持,编译QT的项目,一般有两件事情要做:
-
使用元编译器,QT SDK提供了三个编译器,分别是moc,uic,rcc,可以根据项目需要打开:
set(CMAKE_AUTOUIC ON) set(CMAKE_AUTOMOC ON) set(CMAKE_AUTORCC ON)
-
导入QT依赖
find_package(Qt5 COMPONENTS Core REQUIRED) target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Core)
依赖可以来源与vcpkg,也可以来源于其他地方的qt cmake模块,只需要指定
QT5_DIR
或者设置CMAKE_INSTALL_PREFIX
,比如:set(CMAKE_INSTALL_PREFIX ${VCPKG_ROOT})
值得注意的是,与
CMAKE_TOOLCHAIN_FILE
一样,CMAKE_INSTALL_PREFIX
的设置也必须放在顶层目录的CMakeLists.txt
cmake 结合vc使用
-
cmake生成vs工程,首先需要安装vs后,执行:
cmake ../
可以生成对用的vs工程文件,还可以通过
source_group
来指定vs中文件目录,比如:file(GLOB_RECURSE DBBuilder_SRC_HEADERS "../../third_party/jsoncpp/include/json.h" "../Common/*.h" "./*.h") source_group(HEADERS FILES ${DBBuilder_SRC_HEADERS}) #指定头文件folder名字为HEADERS file(GLOB_RECURSE DBBuilder_SRC_SOURCES "../../third_party/jsoncpp/jsoncpp.cpp" "../Common/*.cpp" "./*.cpp") source_group(SOURCES FILES ${DBBuilder_SRC_SOURCES}) #指定源文件folder名字为SOURCES add_executable(${PROJECT_NAME} ${DBBuilder_SRC_HEADERS} ${DBBuilder_SRC_SOURCES} )
-
使用vs环境编译cmake项目,需要借助nmake,首先生成nmake编译配置文件,然后调用nmake命令编译,基本命令如下:
cmake .. -G"NMake Makefiles" -DCMAKE_BUILD_TYPE=Release if %errorlevel% NEQ 0 ( echo "cmake failed" pause exit ) nmake if %errorlevel% NEQ 0 ( echo "nmake failed" pause exit )