【個人收藏筆記】CMakeLists.txt 語法簡明教程


項目目錄

├── demo項目目錄
│ ├── CMakeLists.txt
│ ├── include目錄
│ │ ├── hello.h
│ ├── src 目錄
│ │ ├── hello.cpp
│ ├── lib目錄
│ ├── biuld目錄

CMAKE_MINIMUM_REQUIRED(VERSION 3.14)
#指定項目名稱
PROJECT(HELLO)

#將hello.cpp 賦值給SOURCE 變量
SET(SOURCE ${PROJECT_SOURCE_DIR}/src/hello.cpp)

#指定頭文件目錄
INCLUDE_DIRECTORIES(${PROJECT_SOURCE_DIR}/include)
#指定鏈接庫文件目錄
LINK_DIRECTORIES(${PROJECT_SOURCE_DIR}/lib)

#將hello.cpp生成可執行文件hello 
ADD_EXECUTABLE(hello ${SOURCE})

#指定hello 鏈接庫myprint
TARGET_LINK_LIBRARIES(hello myprint)

常用命令

1. 指定cmake的最小版本

# 最小版本爲2.8,可不寫
cmake_minimum_required(VERSION 2.8)

2. 設置項目名稱

# 非強制性命令,會引入兩個變量:demo_BINARY_DIR 、 demo_SOURCE_DIR
# 同時cmake自動定義兩個等價變量: PROJECT_BINARY_DIR 、 PROJECT_SOURCE_DIR
project(demo)

3. 設置編譯類型

add_executable(demo demo.cpp) # 生成可執行文件
add_library(common STATIC util.cpp) # 生成靜態庫
add_library(common SHARED util.cpp) # 生成動態庫或共享庫
  • 在 Linux 下是:
    demo
    libcommon.a
    libcommon.so
  • 在 Windows 下是:
    demo.exe
    common.lib
    common.dll

4. 指定編譯包含的源文件

4.1 明確指定包含哪些源文件

add_library(demo demo.cpp test.cpp util.cpp)

4.2 搜索所有的cpp文件

aux_source_directory(dir VAR)發現一個目錄下所有的源代碼文件並將列表存儲在一個變量中

aux_source_directory(. SRC_LIST) # 搜索當前目錄下的所有.cpp文件
add_library(demo ${SRC_LIST})

4.3 自定義搜索規則

file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
add_library(demo ${SRC_LIST})
# 或者
file(GLOB SRC_LIST "*.cpp")
file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
# 或者
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

5. 查找指定的庫文件

find_library(VAR name path)查找到指定的預編譯庫,並將它的路徑存儲在變量中。
默認的搜索路徑爲 cmake 包含的系統庫,因此如果是 NDK 的公共庫只需要指定庫的 name 即可。

find_library( # Sets the name of the path variable.
              log-lib
 
              # Specifies the name of the NDK library that
              # you want CMake to locate.
              log )

類似的命令還有 find_file()、find_path()、find_program()、find_package()。

6. 設置包含的目錄

include_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}
    ${CMAKE_CURRENT_BINARY_DIR}
    ${CMAKE_CURRENT_SOURCE_DIR}/include
)

Linux 下還可以通過如下方式設置包含的目錄:

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")

7. 設置鏈接庫搜索目錄

link_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}/libs
)

Linux 下還可以通過如下方式設置包含的目錄:

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")

8. 設置target需要鏈接的庫

target_link_libraries( # 目標庫
                       demo
 
                       # 目標庫需要鏈接的庫
                       # log-lib 是上面 find_library 指定的變量名
                       ${log-lib} )

在 Windows 下,系統會根據鏈接庫目錄,搜索xxx.lib 文件,Linux 下會搜索 xxx.so 或者 xxx.a 文件,如果都存在會優先鏈接動態庫(so 後綴)。

8.1 指定鏈接動態庫或靜態庫

target_link_libraries(demo libface.a) # 鏈接libface.a
target_link_libraries(demo libface.so) # 鏈接libface.so

8.2 指定全路徑

target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)

8.3 指定鏈接多個庫

target_link_libraries(demo
    ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
    boost_system.a
    boost_thread
    pthread)

9. 設置變量

9.1 set直接設置變量的值

set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})

9.2 set追加設置變量的值

set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp)
add_executable(demo ${SRC_LIST})

9.3 list追加或刪除變量的值

set(SRC_LIST main.cpp)
list(APPEND SRC_LIST test.cpp)
list(REMOVE_ITEM SRC_LIST main.cpp)
add_executable(demo ${SRC_LIST})

10. 條件控制

10.1 if…elseif…else…endif

邏輯判斷和比較:

  • if (expression):expression 不爲空(0,N,NO,OFF,FALSE,NOTFOUND)時爲真
  • if (not exp):與上面相反
  • 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 dir):當 dir 是目錄時爲真
  • if (DEFINED var):如果變量被定義爲真
  • if (var MATCHES regex):給定的變量或者字符串能夠匹配正則表達式 regex 時爲真,此處 var 可以用 var 名,也可以用 ${var}
  • if (string MATCHES regex)

數字比較:

  • if (variable LESS number):LESS 小於
  • if (string LESS number)
  • if (variable GREATER number):GREATER 大於
  • if (string GREATER number)
  • if (variable EQUAL number):EQUAL 等於
  • 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(MSVC)
    set(LINK_LIBS common)
else()
    set(boost_thread boost_log.a boost_system.a)
endif()
target_link_libraries(demo ${LINK_LIBS})
# 或者
if(UNIX)
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fpermissive -g")
else()
    add_definitions(-D_SCL_SECURE_NO_WARNINGS
    D_CRT_SECURE_NO_WARNINGS
    -D_WIN32_WINNT=0x601
    -D_WINSOCK_DEPRECATED_NO_WARNINGS)
endif()
 
if(${CMAKE_BUILD_TYPE} MATCHES "debug")
    ...
else()
    ...
endif()

10.2 while…endwhile

while(condition)
    ...
endwhile()

10.3 foreach…endforeach

foreach(loop_var RANGE start stop [step])
    ...
endforeach(loop_var)

start 表示起始數,stop 表示終止數,step 表示步長,示例:

foreach(i RANGE 1 9 2)
    message(${i})
endforeach(i)
# 輸出:13579

11.打印消息

message(${PROJECT_SOURCE_DIR})
message("build with debug mode")
message(WARNING "this is warnning message")
message(FATAL_ERROR "this build has many error") # FATAL_ERROR 會導致編譯失敗

12.包含其他cmake文件

include(./common.cmake) # 指定包含文件的全路徑
include(def) # 在搜索路徑中搜索def.cmake文件
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 設置include的搜索路徑

常用變量

1. 預定義變量

  • PROJECT_SOURCE_DIR:工程的根目錄
  • PROJECT_BINARY_DIR:運行 cmake 命令的目錄,通常是 ${PROJECT_SOURCE_DIR}/build
  • PROJECT_NAME:返回通過 project 命令定義的項目名稱
  • CMAKE_CURRENT_SOURCE_DIR:當前處理的 CMakeLists.txt 所在的路徑
  • CMAKE_CURRENT_BINARY_DIR:target 編譯目錄
  • CMAKE_CURRENT_LIST_DIR:CMakeLists.txt 的完整路徑
  • CMAKE_CURRENT_LIST_LINE:當前所在的行
  • CMAKE_MODULE_PATH:定義自己的 cmake 模塊所在的路徑,SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake),然後可以用INCLUDE命令來調用自己的模塊
  • EXECUTABLE_OUTPUT_PATH:重新定義目標二進制可執行文件的存放位置
  • LIBRARY_OUTPUT_PATH:重新定義目標鏈接庫文件的存放位置

2. 環境變量

  • 使用環境變量

     $ENV{Name}
    
  • 寫入環境變量

     set(ENV{Name} value) # 這裏沒有“$”符號
    

3. 系統變量

  • ­CMAKE_MAJOR_VERSION:cmake 主版本號,比如 3.4.1 中的 3
  • ­CMAKE_MINOR_VERSION:cmake 次版本號,比如 3.4.1 中的 4
  • ­CMAKE_PATCH_VERSION:cmake 補丁等級,比如 3.4.1 中的 1
  • ­CMAKE_SYSTEM:系統名稱,比如 Linux-­2.6.22
  • ­CMAKE_SYSTEM_NAME:不包含版本的系統名,比如 Linux
  • ­CMAKE_SYSTEM_VERSION:系統版本,比如 2.6.22
  • ­CMAKE_SYSTEM_PROCESSOR:處理器名稱,比如 i686
  • ­UNIX:在所有的類 UNIX 平臺下該值爲 TRUE,包括 OS X 和 cygwin
  • ­WIN32:在所有的 win32 平臺下該值爲 TRUE,包括 cygwin

4.主要開關選項

  • ­BUILD_SHARED_LIBS:這個開關用來控制默認的庫編譯方式,如果不進行設置,使用 add_library 又沒有指定庫類型的情況下,默認編譯生成的庫都是靜態庫。如果 set(BUILD_SHARED_LIBS ON) 後,默認生成的爲動態庫
  • ­CMAKE_C_FLAGS:設置 C 編譯選項,也可以通過指令 add_definitions() 添加
  • ­CMAKE_CXX_FLAGS:設置 C++ 編譯選項,也可以通過指令 add_definitions()添加

項目實例

1. 簡單項目(單個源文件)

  • main.c

    #include <stdio.h>
    int main() {
        printf("Hello World!\n");
        return 0;
    }
    
  • CMakeLists.txt

    project(HELLO)
    add_executable(hello main.c)
    

注意:命名必須是 CMakeLists.txt,注意大小寫和不要漏字母

  • 編譯和運行
    在項目目錄下新建一個build文件夾,依次執行:
    cd build
    cmake ..
    

爲什麼要新建一個 build 文件夾?
一般我們採用 cmake 的 out-of-source 方式來構建(即生成的中間產物和源代碼分離),這樣做可以讓生成的文件和源文件不會弄混,且目錄結構看起來也會清晰明瞭。所以推薦使用這種方式,至於這個文件夾的命名並無限制,我們習慣命名爲 build。

2. 複雜項目(多個目錄,多個源文件)

在這裏插入圖片描述

  • demo 根目錄下的 CMakeLists.txt 文件如下:

    cmake_minimum_required (VERSION 2.8)
    project(demo)
    aux_source_directory(. DIR_SRCS)
    # 添加math子目錄
    add_subdirectory(math)
    # 指定生成目標
    add_executable(demo ${DIR_SRCS})
    # 添加鏈接庫
    target_link_libraries(demo MathFunctions)
    
  • math 目錄下的 CMakeLists.txt 文件如下:

    aux_source_directory(. DIR_LIB_SRCS)
    # 生成鏈接庫
    add_library(MathFunctions ${DIR_LIB_SRCS})
    

3. 自定義編譯選項

cmake 允許爲項目增加編譯選項,從而可以根據用戶的環境和需求選擇最合適的編譯方案。

例如,可以將 MathFunctions 庫設爲一個可選的庫,如果該選項爲 ON ,就使用該庫定義的數學函數來進行運算,否則就調用標準庫中的數學函數庫。

修改根目錄下的 CMakeLists.txt 文件如下:

# CMake 最低版本號要求
cmake_minimum_required (VERSION 2.8)
# 項目信息
project (Demo)
# 加入一個配置頭文件,用於處理 CMake 對源碼的設置
configure_file (
    "${PROJECT_SOURCE_DIR}/config.h.in"
    "${PROJECT_BINARY_DIR}/config.h"
    )
# 是否使用自己的 MathFunctions 庫
option (USE_MYMATH
        "Use provided math implementation" ON)
# 是否加入 MathFunctions 庫
if (USE_MYMATH)
    include_directories ("${PROJECT_SOURCE_DIR}/math")
    add_subdirectory (math)
    set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif (USE_MYMATH)
# 查找當前目錄下的所有源文件
# 並將名稱保存到 DIR_SRCS 變量
aux_source_directory(. DIR_SRCS)
# 指定生成目標
add_executable(Demo ${DIR_SRCS})
target_link_libraries (Demo ${EXTRA_LIBS})
  • configure_file 命令用於加入一個配置頭文件 config.h ,這個文件由 cmake 從 config.h.in 生成,通過這樣的機制,將可以通過預定義一些參數和變量來控制代碼的生成。
  • option 命令添加了一個 USE_MYMATH 選項,並且默認值爲 ON 。根據 USE_MYMATH 變量的值來決定是否使用我們自己編寫的 MathFunctions 庫。

修改 main.cc 文件,讓其根據 USE_MYMATH 的預定義值來決定是否調用標準庫還是MathFunctions 庫:

#include "config.h"
#ifdef USE_MYMATH
    #include "math/MathFunctions.h"
#else
    #include <math.h>
#endif
 
int main(int argc, char *argv[])
{
    if (argc < 3){
        printf("Usage: %s base exponent \n", argv[0]);
        return 1;
    }
    double base = atof(argv[1]);
    int exponent = atoi(argv[2]);
 
#ifdef USE_MYMATH
    printf("Now we use our own Math library. \n");
    double result = power(base, exponent);
#else
    printf("Now we use the standard library. \n");
    double result = pow(base, exponent);
#endif
    printf("%g ^ %d is %g\n", base, exponent, result);
    return 0;
}

編寫config.h.in文件:
注意 main.cc 的第一行,這裏引用了一個 config.h 文件,這個文件預定義了 USE_MYMATH 的值。但我們並不直接編寫這個文件,爲了方便從 CMakeLists.txt 中導入配置,我們編寫一個 config.h.in 文件,內容如下:

#cmakedefine USE_MYMATH

這樣 cmake 會自動根據 CMakeLists.txt 配置文件中的設置自動生成 config.h 文件。

4. ROS功能包自動生成的CMakeLists.txt模板

cmake_minimum_required(VERSION 3.0.2)
project(orocos_test)

# add_compile_options(-std=c++11)

find_package(catkin REQUIRED COMPONENTS
  roscpp
)

#通過CMake的約定可以找到系統依賴關係
# find_package(Boost REQUIRED COMPONENTS system)


## 如果包有setup.py,則取消註釋。這個宏確保安裝其中聲明的模塊和全局腳本
# catkin_python_setup()

################################################
## 聲明ROS消息、服務和操作 ##
################################################

## 在'msg'文件夾中生成消息
# add_message_files(
#   FILES
#   Message1.msg
#   Message2.msg
# )

## 在'srv'文件夾中生成服務
# add_service_files(
#   FILES
#   Service1.srv
#   Service2.srv
# )

## 在'action'文件夾中生成動作服務器
# add_action_files(
#   FILES
#   Action1.action
#   Action2.action
# )

## 使用此處列出的任何依賴項生成添加的消息和服務
# generate_messages(
#   DEPENDENCIES
#   std_msgs  # 或其他含有msg的package
# )

################################################
## 聲明  ROS dynamic reconfigure parameters   ##
################################################

## 要在這個包中聲明和構建動態重新配置參數,請遵循以下步驟:
## * In the file package.xml:
##   * add a build_depend and a exec_depend tag for "dynamic_reconfigure"
## * In this file (CMakeLists.txt):
##   * add "dynamic_reconfigure" to find_package(catkin REQUIRED COMPONENTS ...)
##   * uncomment the "generate_dynamic_reconfigure_options" section below and list every .cfg file to be processed

## 在“cfg”文件夾中生成動態重新配置參數
# generate_dynamic_reconfigure_options(
#   cfg/DynReconf1.cfg
#   cfg/DynReconf2.cfg
# )

###################################
## catkin specific configuration ##
###################################
## catkin_package宏爲你的包生成cmake配置文件
## 聲明要傳遞給相關項目的內容
## INCLUDE_DIRS: 如果包包含頭文件,則取消註釋
## LIBRARIES: 在此項目中創建的依賴項目也需要的庫
## CATKIN_DEPENDS: 依賴於catkin_packages的項目也需要
## DEPENDS: 此項目的系統依賴,依賴項目也需要
catkin_package(
#  INCLUDE_DIRS include
#  LIBRARIES orocos_test
#  CATKIN_DEPENDS orocos_kdl
#  DEPENDS system_lib
)

###########
## Build ##
###########

## 指定頭文件的其他位置
## 您的包位置應該列在其他位置之前
include_directories(
# include
  ${catkin_INCLUDE_DIRS}
)

## 聲明一個C++ library
# add_library(${PROJECT_NAME}
#   src/${PROJECT_NAME}/orocos_test.cpp
# )

## 添加庫的cmake目標依賴關係
## 例如,代碼可能需要在庫生成之前生成
## 從消息生成或動態重新配置
# add_dependencies(${PROJECT_NAME} ${${PROJECT_NAME}_EXPORTED_TARGETS} ${catkin_EXPORTED_TARGETS})

## 聲明一個c++可執行文件
## 使用catkin_make,所有包都在單個CMake上下文中構建
## 推薦的前綴確保包之間的目標名稱不會衝突
# add_executable(${PROJECT_NAME}_node src/orocos_test_node.cpp)

## 重命名c++可執行文件沒有前綴
## 上面推薦的前綴會導致長目標名稱,下面爲方便用戶使用而將目標重命名爲短版本。 "rosrun someones_pkg node" instead of "rosrun someones_pkg someones_pkg_node"
# set_target_properties(${PROJECT_NAME}_node PROPERTIES OUTPUT_NAME node PREFIX "")

## 添加可執行文件的cmake目標依賴項,就像上面的庫一樣
# add_dependencies(${PROJECT_NAME}_node ${${PROJECT_NAME}_EXPORTED_TARGETS} ${catkin_EXPORTED_TARGETS})

## 指定要鏈接庫或可執行目標的庫
# target_link_libraries(${PROJECT_NAME}_node
#   ${catkin_LIBRARIES}
# )

#############
## Install ##
#############

# 所有安裝目標都應該使用 catkin DESTINATION variables

## 將可執行腳本(Python等)標記爲安裝,而不是setup.py, 你可以選擇目標:
# catkin_install_python(PROGRAMS
#   scripts/my_python_script
#   DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION}
# )

## 標記要安裝的可執行文件
# install(TARGETS ${PROJECT_NAME}_node
#   RUNTIME DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION}
# )

## 用於安裝的標記庫
# install(TARGETS ${PROJECT_NAME}
#   ARCHIVE DESTINATION ${CATKIN_PACKAGE_LIB_DESTINATION}
#   LIBRARY DESTINATION ${CATKIN_PACKAGE_LIB_DESTINATION}
#   RUNTIME DESTINATION ${CATKIN_GLOBAL_BIN_DESTINATION}
# )

## 標記cpp頭文件進行安裝
# install(DIRECTORY include/${PROJECT_NAME}/
#   DESTINATION ${CATKIN_PACKAGE_INCLUDE_DESTINATION}
#   FILES_MATCHING PATTERN "*.h"
#   PATTERN ".svn" EXCLUDE
# )

## 標記其他需要安裝的文件(例如launch和bag文件等)
# install(FILES
#   # myfile1
#   # myfile2
#   DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION}
# )

#############
## Testing ##
#############

## 添加基於gtest的cpp測試目標和鏈接庫
# catkin_add_gtest(${PROJECT_NAME}-test test/test_orocos_test.cpp)
# if(TARGET ${PROJECT_NAME}-test)
#   target_link_libraries(${PROJECT_NAME}-test ${PROJECT_NAME})
# endif()

## 添加要由python nosetests運行的文件夾
# catkin_add_nosetests(test)

幾個重要的編譯配置項:

  • include_directories:用於設置頭文件的相對路徑,全局路徑默認是功能包的所在目錄
  • add_executable:用於設置需要編譯的代碼和生成的可執行文件
  • target_link_libraries:用於設置鏈接庫,通過該選項可以配置執行文件鏈接的庫文件
  • add_dependencies:用於設置依賴項

版權聲明:本文爲CSDN博主「阿飛__」的原創文章,遵循CC 4.0 BY-SA版權協議,轉載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/afei__/article/details/81201039

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章