CMake 使用简介

CMake 是一个跨平台的构建工具,可根据需要输出各种各样的 Makefile 或者 Project 文件。CMake 使用 CMakeLists.txt 来配置工程文件,开发者可以在这里集成 SDK 或者引用用于编译原生平台的库和配置,详情可参考 二次开发

从 v3.0 开始,Creator 已经集成了 CMake 的输出过程和基础编写,本篇文档主要介绍原生平台上 CMakeLists.txt 的使用规则以及一些简单的示例。

CMakeLists 的生成和使用

生成

当选择某个原生平台进行构建时,项目目录 native\engine 目录下会生成 当前构建的平台名称 文件夹(例如 android),以及 common 文件夹。CMake 在第一次运行时将会在这两个目录下分别生成 CMakeLists.txt 文件,作用各不相同:

  • 当前构建的平台名称 文件夹:CMakeLists.txt 主要用于配置对应的构建平台。以 Android 平台为例:

    folder2

  • common 文件夹:CMakeLists.txt 主要用于配置整个项目。

    folder2

CMakeLists.txt 的语法比较简单,由 命令注释空格 组成。其中命令是不区分大小写的,但命令中的参数和变量则是大小写敏感的。

使用

那如何利用 CMake 将项目编译成动态库提供给其他项目使用呢?简单来说就是先录入编译信息,然后 CMake 命令再根据 CMakeLists.txt 中的配置生成编译所需的 Makefile 文件。

下面我们以 Android 平台为例,具体看一下如何配置项目目录 native/engine/android 目录下的 CMakeLists.txt

# 设置 CMake 所需的最低版本。如果使用的 CMake 版本低于该版本,会提醒用户升级到该版本之后再执行 CMake
cmake_minimum_required(VERSION 3.8)

# 声明项目名称
option(APP_NAME "Project Name" "cmakeTest")

# 声明项目名称以及支持的编程语言,若不指定则默认支持所有编程语言,包括 C、C++ 和 JAVA 三种,分别用 C、CXX、JAVA 表示。
project(${APP_NAME} CXX)

# include 从文件或模块加载和运行 CMake 代码
include(${CMAKE_CURRENT_LIST_DIR}/../common/CMakeLists.txt)

# 定义一个新变量 LIB_NAME 并设置为 “cocos”
set(LIB_NAME cocos)

# 定义一个变量 PROJ_SOURCES
set(PROJ_SOURCES
    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/Game.h
    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/Game.cpp
    ${CMAKE_CURRENT_LIST_DIR}/jni/main.cpp
)

# 如果在该路径下不存在 jsb_module_register.cpp,则复制这个路径下的 jsb_module_register.cpp 文件到目标文件夹中
if(NOT EXISTS ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/jsb_module_register.cpp)
    file(COPY "${COCOS_X_PATH}/cocos/bindings/manual/jsb_module_register.cpp"
        DESTINATION ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/)
endif()

# 添加新 element 到 PROJ_SOURCES 中
list(APPEND PROJ_SOURCES
    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/jsb_module_register.cpp
)

# 动态库 PROJ_SOURCES 生成链接文件到 LIB_NAME 中
add_library(${LIB_NAME} SHARED ${PROJ_SOURCES})

# 将目标文件 LIB_NAME 与库文件 cocos2d_jni 进行链接
target_link_libraries(${LIB_NAME}
    "-Wl,--whole-archive" cocos2d_jni "-Wl,--no-whole-archive"
    cocos2d
)

# 将包含目录添加到目标文件夹。
target_include_directories(${LIB_NAME} PRIVATE
    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes
)

项目目录 native/engine/common 目录下的 CMakeLists.txt 文件的配置方法也是一致的,但是会多一些基础的配置。例如:

option(USE_SPINE                "Enable Spine"                      ON)

构建后生成的发布包目录(例如 build/android)下有一个 proj/cfg.cmake 文件,用于存放当前项目的一些配置。因为 CMakeLists.txt 中有对 cfg.cmake 文件进行引入,所以当 cfg.cmake 文件中的配置做了修改,便会同步到 CMakeLists.txt 中;若是相同的配置,则直接覆盖,以 cfg.cmake 文件中的为准。

从 3.6.2 开始,开发者可以在 native/engine/common/localCfg.cmake 中覆盖 cfg.cmake 中设置的选项, 而且 localCfg.cmake 会从 GIT 中忽略。

CMakeLists.txt

# 引入 cfg.cmake
include(${RES_DIR}/proj/cfg.CMake)

例如将编辑器主菜单 项目 -> 项目设置 -> 功能裁剪 中的 Spine 动画 去掉勾选:

project

则在再次构建时重新生成的 cfg.make 中就会将 USE_SPINE 设置为 OFF

code1

然后在编译时,CMake 便会根据配置(例如 CMakeLists.txt 以及 CMakeLists.txt 中引入的 cfg.make 等配置文件)生成 CMakeCache.txt 文件,该文件中包含了项目构建时 需要依赖的各种输入参数

code2

CMakeLists 常用编译指令

查找编译头文件

找到编译头文件,CMake 即可指定编译给定目标时要使用的包含目录或目标文件夹:

target_include_directories(<target> [SYSTEM] [BEFORE]
  <INTERFACE|PUBLIC|PRIVATE> [items1...]
  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

一般情况下,通过上述指令引用库路径便可作为外部依赖项引入到 CMake 中。例如:

# 将 Classes 头文件库路径添加到 LIB_NAME 中
target_include_directories(${LIB_NAME} PRIVATE
    ${CMAKE_CURRENT_LIST_DIR}/../common/Classes
)

更多内容可参考 CMake 官方文档 target_include_directories

生成 target(执行文件)

上述 查找编译头文件 指令中的 target 是通过 add_libraryadd_executableadd_custom_command 指令生成的执行文件。

  • 通过 add_library 指令生成

    add_library 指令将指定的源文件生成链接文件,然后添加到工程中。

      add_library(<name> [STATIC | SHARED | MODULE]
              [EXCLUDE_FROM_ALL]
              [source1] [source2 ...])
    
    • name:表示添加一个名为 的目标库,由命令中列出的源文件(source1、source2)构建而成,在项目中是全局唯一的。源文件若是在后续通过 target_sources() 指定,那么这里就可以忽略。

    • STATIC(静态库)、SHARED(动态库)、MODULE(模块库):用于指定要创建的库的类型。STATIC 库是对象文件的档案,用于连接其他目标。共享库是动态链接的,并在运行时加载。MODULE 库是插件,不被链接到其他目标中,但可以在运行时使用类似 dlopen 的功能动态加载。

      示例如下:

      add_library(${LIB_NAME} SHARED ${PROJ_SOURCES})
      

      更多内容详情请参考 CMake 官方文档 add_library

  • 通过 add_executable 指令生成

    add_executable 指令通过使用指定的源文件来生成目标可执行文件。

      add_executable(<name> [WIN32] [MACOSX_BUNDLE]
                     [EXCLUDE_FROM_ALL]
                     [source1] [source2 ...])
    
    • name:可执行目标文件的名称,在一个 CMake 工程中,这个名称必须全局唯一。
    • WIN32:用于在 Windows 中创建一个以 WinMain 为入口的可执行目标文件(通常入口函数为 main),该文件是一个 GUI 应用程序,而不是 控制台应用程序。在使用 WIN32 时,可执行目标的 WIN32_EXECUTABLE 会被置为 ON
    • MACOSX_BUNDLE:用于在 macOS 或者 iOS 中创建一个 GUI 可执行应用程序。在使用 MACOSX_BUNDLE 时,可执行目标的 MACOSX_BUNDLE 会被置为 ON
    • EXCLUDE_FROM_ALL:是否构建指定的可执行目标文件。当使用该项时,可执行目标文件不会被构建。
    • [source1] [source2 ...]:构建可执行目标文件所需要的源文件。也可以通过 target_sources() 继续为可执行目标文件添加源文件,需要注意的是在调用 target_sources 之前,可执行目标文件必须已经通过 add_executableadd_library 定义了。

      示例如下:

      add_executable(hello-world hello-world.cpp)
      

      更多内容详情请参考 CMake 官方文档 add_executable

  • 通过 add_custom_command 指令生成

    add_custom_command 指令用于添加自定义构建规则到生成的构建系统中,适用于以下两种情况:

    1. 添加自定义命令以生成输出文件

       add_custom_command(OUTPUT output1 [output2 ...]
                   COMMAND command1 [ARGS] [args1...]
                   [COMMAND command2 [ARGS] [args2...] ...]
                   [MAIN_DEPENDENCY depend]
                   [DEPENDS [depends...]]
                   [BYPRODUCTS [files...]]
                   [IMPLICIT_DEPENDS <lang1> depend1
                                       [<lang2> depend2] ...]
                   [WORKING_DIRECTORY dir]
                   [COMMENT comment]
                   [DEPFILE depfile]
                   [JOB_POOL job_pool]
                   [VERBATIM] [APPEND] [USES_TERMINAL]
                   [COMMAND_EXPAND_LISTS])
      

      部分参数含义如下:

      • OUTPUT:指定命令预期产生的输出文件。输出文件名称可以是 绝对路径 或者 相对路径(相对于当前的构建的源目录路径)。

      • COMMAND:指定在构建时执行的命令行。

        示例如下:

        add_custom_command(OUTPUT COPY_RES
              COMMAND ${CMAKE_COMMAND} -E copy_if_different ${abs} $<TARGET_FILE_DIR:${LIB_NAME}>/${filename}
          )
        

        注意

        1. 只有在相同的 CMakeLists.txt 中指定了所有依赖于其输出的目标时才有效。

        2. 不要同时在多个相互独立的目标文件中执行上述命令产生相同的文件,主要是为了防止冲突产生。

    2. 在某个目标(例如库或者可执行程序)的构建过程中添加额外执行的定制命令

       add_custom_command(TARGET <target>
                  PRE_BUILD | PRE_LINK | POST_BUILD
                  COMMAND command1 [ARGS] [args1...]
                  [COMMAND command2 [ARGS] [args2...] ...]
                  [BYPRODUCTS [files...]]
                  [WORKING_DIRECTORY dir]
                  [COMMENT comment]
                  [VERBATIM] [USES_TERMINAL]
                  [COMMAND_EXPAND_LISTS])
      

      部分参数含义如下:

      • TARGET:指定命令运行的目标

      • COMMAND:指定在构建时执行的命令行。

      若需要了解更多关于 add_custom_command 指令的内容,详情请参考 CMake 官方文档 add_custom_command

链接库文件

target_link_libraries 中库文件的顺序符合 gcc 链接顺序的规则,即被依赖的库放在依赖它的库的后面。

target_link_libraries(<target> [item1] [item2] [...]
                      [[debug|optimized|general] <item>] ...)

item 表示库文件没有后缀的名字。默认情况下,库依赖项是传递的。当这个目标链接到另一个目标时,链接到这个目标的库也会出现在另一个目标的连接线上。例如:

target_link_libraries(${LIB_NAME}
    "-Wl,--whole-archive" cocos2d_jni "-Wl,--no-whole-archive"
    cocos2d
)

更多内容可参考 CMake 官方文档 target_link_libraries

其他命令

  • 打印调试日志消息

      message(STATUS “my custom debug info”)
    
  • 操作文件命令

      file(COPY "${COCOS_X_PATH}/cocos/bindings/manual/jsb_module_register.cpp"
          DESTINATION ${CMAKE_CURRENT_LIST_DIR}/../common/Classes/)
    

    COPY 表示复制文件、目录以及符号链接到一个目标文件夹中。输入路径为相对于当前源码目录的路径。目标路径则是相对于当前的构建目录。

  • 从文件或模块加载和运行 CMake 代码

      include(${CMAKE_CURRENT_LIST_DIR}/../common/CMakeLists.txt)
    

CMakeLists 使用示例

Android.mk 是 Android 源码编译系统的 Makefile,用于编译系统中 C++ 的动态库、静态库、可执行文件和 apk 等。接下来通过将 腾讯云多媒体引擎 SDK 中的一个 Android.mk 改写成 CMakeLists.txt 做一个简单的示例。

Android.mk 中的代码如下:

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)
LOCAL_MODULE := Pre_GMESDK
LOCAL_SRC_FILES := ./$(TARGET_ARCH_ABI)/libgmesdk.so
include $(PREBUILT_SHARED_LIBRARY)

include $(CLEAR_VARS)
LOCAL_MODULE := Pre_TRAE
LOCAL_SRC_FILES := ./$(TARGET_ARCH_ABI)/libtraeimp.so
include $(PREBUILT_SHARED_LIBRARY)

include $(CLEAR_VARS)
LOCAL_MODULE := Pre_PTT
LOCAL_SRC_FILES := ./$(TARGET_ARCH_ABI)/libsilk.so
include $(PREBUILT_SHARED_LIBRARY)

include $(CLEAR_VARS)
LOCAL_MODULE := Pre_MP3
LOCAL_SRC_FILES := ./$(TARGET_ARCH_ABI)/libgmecodec.so
include $(PREBUILT_SHARED_LIBRARY)

其中有一个 LOCAL_PATH 变量,表示源文件在开发树中的位置。构建系统提供的宏函数 my-dir 将返回当前目录(Android.mk 文件本身所在的目录)的路径:

LOCAL_PATH := $(call my-dir)

对应在 CMakeLists.txt 则表示为:

set(LOCAL_PATH ${CMAKE_CURRENT_SOURCE_DIR}/..)

Android.mk 中以下部分的代码:

include $(CLEAR_VARS)
LOCAL_MODULE := Pre_GMESDK
LOCAL_SRC_FILES := ./$(TARGET_ARCH_ABI)/libgmesdk.so
include $(PREBUILT_SHARED_LIBRARY)

对应在 CMakeLists.txt 中则表示为:

add_library(Pre_GMESDK SHARED IMPORTED GLObal)
set_target_properties(Pre_GMESDK PROPERTIES
  IMPORTED_LOCATION ./${ANDROID_ABI}/libgmesdk.so
)

结语

CMake 的指令和用法还有很多,欢迎大家去探寻和学习,本篇文档只是做了简单的示例,开发者可针对自身的实际情况,对自己的工作流进行定制。未来 Cocos Creator 也会将 CMake 更多的功能集成到编辑器的 构建发布 面板中,方便使用。

更多关于 CMake 语法和接口的详细内容,请参考 CMake 官方文档

results matching ""

    No results matching ""