Cmake命令之project介紹

  • 命令格式

    project(<PROJECT-NAME> [<language-name>...])

    project(<PROJECT-NAME>
    [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
    [DESCRIPTION <project-description-string>]
    [HOMEPAGE_URL <url-string>]
    [LANGUAGES <language-name>...])

    project命令用于指定cmake工程的名稱,實(shí)際上,它還可以指定cmake工程的版本號(VERSION關(guān)鍵字)、簡短的描述(DESCRIPTION關(guān)鍵字)、主頁URL(HOMEPAGE_URL關(guān)鍵字)和編譯工程使用的語言(LANGUAGES關(guān)鍵字)。

  • 命令解析

    下面根據(jù)關(guān)鍵字逐一解析project的用法。
    1. 基本用法:指定工程名稱。

    # CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    project (mytest)
    

    ??這樣就指定了當(dāng)前的工程名稱為mytest。實(shí)際上在調(diào)用project命令指定當(dāng)前工程名字的同時(shí),cmake內(nèi)部會(huì)為如下變量賦值:

    • PROJECT_NAME:將當(dāng)前工程的名稱賦值給PROJECT_NAME,對于本例子,就是${PROJECT_NAME}=mytest
    • PROJECT_SOURCE_DIR:當(dāng)前工程的源碼路徑。
    • <PROJECT-NAME>_SOURCE_DIR:指定工程的源碼路徑,這個(gè)變量和PROJECT_SOURCE_DIR的區(qū)別就是,<PROJECT-NAME>_SOURCE_DIR跟具體的工程名字關(guān)聯(lián)起來,若<PROJECT-NAME>就是當(dāng)前工程,則該變量和PROJECT_SOURCE_DIR相等。
    • PROJECT_BINARY_DIR:當(dāng)前工程的二進(jìn)制路徑。
    • <PROJECT-NAME>_BINARY_DIR:指定工程的二進(jìn)制路徑,這個(gè)變量和PROJECT_BINARY_DIR的區(qū)別就是,<PROJECT-NAME>_BINARY_DIR跟具體的工程名字關(guān)聯(lián)起來,若<PROJECT-NAME>就是當(dāng)前工程,則該變量和PROJECT_BINARY_DIR相等。
    • CMAKE_PROJECT_NAME:頂層工程的名稱。例如當(dāng)前調(diào)用的CMakeLists.txt位于頂層目錄(可以理解為使用cmake命令首次調(diào)用的那個(gè)CMakeLists.txt),那么工程名還會(huì)賦值給CMAKE_PROJECT_NAME。

    ??在舉例之前,我們先做如下約定:假設(shè)我們頂層目錄為test/,也就是cmake .命令是在該目錄下進(jìn)行調(diào)用。并且test/目錄下有一個(gè)子目錄,我們命名為sub_test。在test/目錄和test/sub_test/目錄下各建立一個(gè)CMakeLists.txt。在test/下的CMakeLists.txt文件即使頂層的文件。

    # test/CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    set (TOP_PROJECT_NAME "mytest") # 定義了變量TOP_PROJECT_NAME為"mytest"
    project (${TOP_PROJECT_NAME}) 
    
    message (">>> top PROJECT_NAME: ${PROJECT_NAME}")
    message (">>> top PROJECT_SOURCE_DIR: ${PROJECT_SOURCE_DIR}")
    message (">>> top <PROJECT_NAME>_SOURCE_DIR: ${${TOP_PROJECT_NAME}_SOURCE_DIR}") 
    message (">>> top PROJECT_BINARY_DIR: ${PROJECT_BINARY_DIR}")
    message (">>> top <PROJECT_NAME>_BINARY_DIR: ${${TOP_PROJECT_NAME}_BINARY_DIR}")
    message (">>> top CMAKE_PROJECT_NAME: ${CMAKE_PROJECT_NAME}")
    
    add_subdirectory (sub_test) # 調(diào)用sub_test下的CMakeList.txt進(jìn)行構(gòu)建
    
    # test/sub_test/CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    set (SUB_LEVEL_PROJECT_NAME "mysubtest") # 定義了變量SUB_LEVEL_PROJECT_NAME為"mysubtest"
    project (${SUB_LEVEL_PROJECT_NAME}) 
    
    message (">>>>>> sub PROJECT_NAME: ${PROJECT_NAME}")
    message (">>>>>> sub PROJECT_SOURCE_DIR: ${PROJECT_SOURCE_DIR}")
    message (">>>>>> sub <PROJECT_NAME>_SOURCE_DIR: ${${SUB_LEVEL_PROJECT_NAME}_SOURCE_DIR}") 
    message (">>>>>> sub <PROJECT_NAME>_SOURCE_DIR(top level): ${${TOP_PROJECT_NAME}_SOURCE_DIR}") 
    message (">>>>>> sub PROJECT_BINARY_DIR: ${PROJECT_BINARY_DIR}")
    message (">>>>>> sub <PROJECT_NAME>_BINARY_DIR: ${${SUB_LEVEL_PROJECT_NAME}_BINARY_DIR}")
    message (">>>>>> sub <PROJECT_NAME>_BINARY_DIR(top level): ${${TOP_PROJECT_NAME}_BINARY_DIR}")
    message (">>>>>> sub CMAKE_PROJECT_NAME: ${CMAKE_PROJECT_NAME}")
    

    test/下執(zhí)行cmake .,輸出如下:

    >>> top PROJECT_NAME: mytest
    >>> top PROJECT_SOURCE_DIR: test/
    >>> top <PROJECT_NAME>_SOURCE_DIR: test/
    >>> top PROJECT_BINARY_DIR: test/ 
    >>> top <PROJECT_NAME>_BINARY_DIR: test/
    >>> top CMAKE_PROJECT_NAME: mytest
    >>>>>> sub PROJECT_NAME: mysubtest
    >>>>>> sub PROJECT_SOURCE_DIR: test/sub_test
    >>>>>> sub <PROJECT_NAME>_SOURCE_DIR: test/sub_test
    >>>>>> sub <PROJECT_NAME>_SOURCE_DIR(top level): test/
    >>>>>> sub PROJECT_BINARY_DIR: test/sub_test
    >>>>>> sub <PROJECT_NAME>_BINARY_DIR: test/sub_test
    >>>>>> sub <PROJECT_NAME>_BINARY_DIR(top level): test/
    >>>>>> sub CMAKE_PROJECT_NAME: mytest
    

    ??因此可以看成帶CMAKE前綴的變量只屬于頂層的CMakeLists.txt工程,帶<PROJECT_NAME>為指定(特定)工程名的變量,其余的即為當(dāng)前正在構(gòu)建的工程變量,下面在講到project其他選項(xiàng)時(shí)也遵循該規(guī)則。

    2. VERSION選項(xiàng):指定工程的版本號。
    ??指定工程的版本號,格式為VERSION <version>,其中<version>為非負(fù)整數(shù)組成的一個(gè)點(diǎn)分版本號格式<major>[.<minor>[.<patch>[.<tweak>]]],例如1.2.3.4。基本用法如下:

      # CMakeLists.txt
      cmake_minimum_required (VERSION 3.10.2)
      project (mytest VERSION 1.2.3.4)
    

    同樣,當(dāng)project命令使用了VERSION選項(xiàng),如下變量會(huì)被相應(yīng)的賦值:

    • PROJECT_VERSION
    • <PROJECT-NAME>_VERSION
    • PROJECT_VERSION_MAJOR
    • <PROJECT-NAME>_VERSION_MAJOR
    • PROJECT_VERSION_MINOR
    • <PROJECT-NAME>_VERSION_MINOR
    • PROJECT_VERSION_PATCH
    • <PROJECT-NAME>_VERSION_PATCH
    • PROJECT_VERSION_TWEAK
    • <PROJECT-NAME>_VERSION_TWEAK
    • CMAKE_PROJECT_VERSION

    ??上述帶<PROJECT_NAME>的變量存儲的是指定工程名下版本號,不帶的表示當(dāng)前正在調(diào)用的工程的版本號。XXX_MAJOR、XXX_MINOR、XXX_PATCH、XXX_TWEAK分別與點(diǎn)分版本號<major>[.<minor>[.<patch>[.<tweak>]]]對應(yīng)。當(dāng)然,如果CMakeLists.txt位于頂層目錄,CMAKE_PROJECT_VERSION存儲的是頂層CMakeLists.txt中project命令指定的版本號,不會(huì)隨著調(diào)用工程的變化而變化。這些變量的使用與1中的工程名變量沒什么區(qū)別,可以仿照將上述變量打印出來看下,此處就不在贅述。

    3. DESCRIPTION選項(xiàng):對工程的文本描述。
    ??格式為DESCRIPTION <project-description-string>,其中<project-description-string>是一段描述,不建議太長。基本用法如下:

      # CMakeLists.txt
      cmake_minimum_required (VERSION 3.10.2)
      project (mytest DESCRIPTION “This is mytest project.”)
    

    ??同樣調(diào)用該選項(xiàng)的會(huì)對如下變量賦值,方式與前面的工程名和版本號類似,特別的,當(dāng)CMakeLists.txt位于頂層目錄,CMAKE_PROJECT_DESCRIPTION存儲的是頂層CMakeLists.txt中project命令指定的工程描述,不會(huì)隨著調(diào)用工程的變化而變化。

    • PROJECT_DESCRIPTION
    • <PROJECT-NAME>_DESCRIPTION
    • CMAKE_PROJECT_DESCRIPTION

    4. HOMEPAGE_URL選項(xiàng):指定工程的主頁URL。
    ??基本用法如下:

      # CMakeLists.txt
      cmake_minimum_required (VERSION 3.10.2)
      project (mytest HOMEPAGE_URL “https://www.XXX(示例).com”)
    

    ??同樣調(diào)用該選項(xiàng)的會(huì)對如下變量賦值,方式與前面的工程名和版本號類似,特別的,當(dāng)CMakeLists.txt位于頂層目錄,CMAKE_PROJECT_HOMEPAGE_URL存儲的是頂層CMakeLists.txt中project命令指定的工程主頁URL,不會(huì)隨著調(diào)用工程的變化而變化。

    • PROJECT_HOMEPAGE_URL
    • <PROJECT-NAME>_HOMEPAGE_URL
    • CMAKE_PROJECT_HOMEPAGE_URL

    5. LANGUAGES選項(xiàng):選擇構(gòu)建工程需要的編程語言。
    ??該選項(xiàng)可以有兩種調(diào)用方式:一種是直接跟在工程名后面,可以省略LANGUAGES關(guān)鍵字;另一種是跟在其他關(guān)鍵字(例如VERSION)后面,LANGUAGES關(guān)鍵字不能省略。

    # CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    project (mytest “CXX”)
    
    # CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    project (mytest VERSION 1.2.3.4 LANGUAGES “CXX”)
    

    ??該選項(xiàng)支持的語言包括C、CXX(例如C++)、CUDA、OBJC(例如Objective-C)、OBJCXX、Fortran、ASM。如果沒有指定LANGUAGES選項(xiàng),默認(rèn)使用的是CCXX。如果使用LANGUAGES NONE、或僅僅列出LANGUAGES關(guān)鍵字卻沒有指定具體的語言,那么表示不支持任何語言。如果需要使能ASM,把它放在列表的最后以便cmake能夠檢查其他語言(例如C語言)能否工作在匯編下。
    ??該命令的實(shí)質(zhì)是cmake會(huì)使用LANGUAGES后的語言選項(xiàng)來檢查CMAKE_XXX_COMPILER指定的編譯器是否存在,以便工程能正確的被構(gòu)建。
    ??例如:

    # CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    project (mytest LANGUAGES “CPP”)
    

    ??會(huì)提示

    No CMAKE_CPP_COMPILER could be found.
    
  • 更多細(xì)節(jié)

    1. project命令并非必不可少,如果沒有調(diào)用project命令,cmake仍然會(huì)生成一個(gè)默認(rèn)的工程名“Project”,以及工程名對應(yīng)的變量(例如PROJECT_NAME、CMAKE_PROJECT_NAME、PROJECT_SOURCE_DIR<PROJECT_NAME>_SOURCE_DIR、PROJECT_BINARY_DIR<PROJECT_NAME>_BINARY_DIR等)。但是VERSIONDESCRIPTION、HOMEPAGE_URL等選項(xiàng)對應(yīng)的變量不會(huì)被賦值(LANGUAGES例外,即使不指定,默認(rèn)語言為CCXX)。
    2. project命令需要放置在其他命令調(diào)用之前,在cmake_minimum_required(參考http://www.itdecent.cn/p/7535bff0e894
      )命令之后。
    3. 如果多次調(diào)用project命令,那么CMAKE_PROJECT_NAME、CMAKE_PROJECT_VERSION、CMAKE_PROJECT_DESCRIPTION、CMAKE_PROJECT_HOMEPAGE_URL等變量是以最近一次調(diào)用的project命令為準(zhǔn),例如:
    # test/CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    project (mytest)
    message (">>> top CMAKE_PROJECT_NAME: ${CMAKE_PROJECT_NAME}"
    project (mytest1)
    add_subdirectory (sub_test) # 調(diào)用sub_test下的CMakeList.txt進(jìn)行構(gòu)建
    project (mytest2)
    message (">>> top CMAKE_PROJECT_NAME: ${CMAKE_PROJECT_NAME}"
    
    # test/sub_test/CMakeLists.txt
    cmake_minimum_required (VERSION 3.10.2)
    project (mysubtest)
    message (">>>>>> sub CMAKE_PROJECT_NAME: ${CMAKE_PROJECT_NAME}"
    

    輸出為:

    >>> top CMAKE_PROJECT_NAME: mytest
    >>>>>> sub CMAKE_PROJECT_NAME: mytest1
    >>> top CMAKE_PROJECT_NAME: mytest2
    

?


附錄:參考資料

  1. https://cmake.org/cmake/help/latest/command/project.html
  2. https://cmake.org/cmake/help/latest/variable/CMAKE_PROJECT_NAME.html#variable:CMAKE_PROJECT_NAME
  3. https://cmake.org/cmake/help/latest/variable/CMAKE_PROJECT_VERSION.html#variable:CMAKE_PROJECT_VERSION
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容