标签 cmake 下的文章

CMake | CPack使用NSIS打包安装程序


描述

由于配置项比较多,所以单独起一篇文章来说打包的事情。所里的项目发布更新包都是手动压缩出来,其实是和不方便的。正常就应该是按照流水线形式处理,也方便以后在Jenkins等持续集成工具上打包封装。

示例代码

testLib.zip
Git 地址

实现代码

set(_install_path "bin")

install(TARGETS ${PROJECT_NAME} 
    RUNTIME 
    DESTINATION ${_install_path}                    # 指定安装目录
)

install(
    FILES                                           # 复制文件
    $<TARGET_FILE:testLib>                          # testLib库静态文件
    DESTINATION ${_install_path}                    # 指定文件复制目录
)

install(
    DIRECTORY                                       # 复制目录
    ${testLib_DIR}/../static/                       # 执行所需文件(注意:带最后一个是复制此目录下的文件,不带/则是复制static这个目录到目标目录)
    DESTINATION ${_install_path}                    # 指定复制目录
)

############################## 打包(会用到install) ##############################
include (InstallRequiredSystemLibraries)
set(CPACK_GENERATOR "NSIS")                         # 指定NSIS打包成EXE(或者ZIP、TG等)
set(CPACK_SYSTEM_NAME "win64")                      # 系统名
set(CPACK_PACKAGE_EXECUTABLES ${PROJECT_NAME} "测试软件")   # 可执行文件的名称和快捷方式标签
set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/static\\\\icon.ico")       # 安装包左上角图标(严格要求的bmp,后来处理了一下图片convert cion.bmp BMP3:cion2.bmp)
set(CPACK_PACKAGE_NAME "测试软件")                  # 设置安装包的包名,打好的包将会是<packagename>-<version>-<sys>.deb,如果不设置,默认是工程名
set(CPACK_PACKAGE_VERSION "1.0.0")                  # 设置版本号
SET(CPACK_PACKAGE_DESCRIPTION "这是一个测试软件 项目包")        # 设置description
SET(CPACK_PACKAGE_CONTACT "root@bug-maker.com")     # 设置联系方式
set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64")      # 设置架构
set(CPACK_DEBIAN_PACKAGE_NAME "测试软件")           # 设置程序名,就是程序安装后的名字
set(CPACK_DEBIAN_PACKAGE_MAINTAINER "猪在天上飞")   # 设置维护人
set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/static/License.txt")  # 设置安装界面的License

# set(CPACK_NSIS_CREATE_ICONS_EXTRA "CreateShortCut '$SMPROGRAMS\\\\$STARTMENU_FOLDER\\\\测试软件2.lnk' '$INSTDIR\\\\${_install_path}\\\\${PROJECT_NAME}.exe'")    # 在开始菜单中创建快捷链接
set(CPACK_NSIS_MENU_LINKS "${_install_path}\\\\${PROJECT_NAME}.exe" "测试软件2")    # 指定开始菜单中的快捷方式
set(CPACK_NSIS_CREATE_ICONS_EXTRA "CreateShortCut '$DESKTOP\\\\测试软件.lnk' '$INSTDIR\\\\${_install_path}\\\\${PROJECT_NAME}.exe'")    # 在桌面创建快捷链接
set(CPACK_NSIS_MUI_ICON "${CMAKE_CURRENT_SOURCE_DIR}/static\\\\install.ico")       # 指定NSIS安装程序的图标文件(格式要求ico)
set(CPACK_NSIS_UNINSTALL_NAME "Uninstall") # 卸载名称
set(CPACK_NSIS_MUI_UNIICON "${CMAKE_CURRENT_SOURCE_DIR}/static\\\\uninstall.ico")     # 指定NSIS卸载程序的图标文件(格式要求ico)
set(CPACK_NSIS_MUI_HEADERIMAGE "${CMAKE_CURRENT_SOURCE_DIR}/static\\\\icon2.bmp")   # 安装包左上角图标(严格要求的bmp,后来处理了一下图片convert cion.bmp BMP3:cion2.bmp)
set(CPACK_NSIS_PACKAGE_NAME "软件包名称")           # 指定生成的NSIS安装程序的名称。
set(CPACK_NSIS_PACKAGE_VERSION ${PROJECT_VERSION})  # 指定生成的NSIS安装程序的版本号。
set(CPACK_NSIS_PACKAGE_VENDOR "供应商名称")         # 指定生成的NSIS安装程序的供应商名称。
set(CPACK_NSIS_PACKAGE_DESCRIPTION "简单的描述")    # 指定生成的NSIS安装程序的描述。
set(CPACK_NSIS_BRANDING_TEXT "左下角描述")          # 左下角描述
set(CPACK_NSISDISPLAY_NAME "显示名称")              # 指定生成的NSIS安装程序的显示名称。
set(CPACK_NSIS_HELP_LINK "https://www.test.com/help") # 指定生成的NSIS安装程序的帮助链接。
set(CPACK_NSIS_PACKAGE_URL "https://www.test.com")  # 指定生成的NSIS安装程序的URL链接。

include(CPack)

说明

CPack NSIS Generator的配置描述

  1. CPACK_NSIS_INSTALL_ROOT
    指定用户默认安装路径
  2. CPACK_NSIS_MUI_ICON
    指定NSIS安装程序的图标文件(格式要求.ico)
  3. CPACK_NSIS_MUI_UNIICON
    指定NSIS卸载程序的图标文件(格式要求.ico)
  4. CPACK_NSIS_INSTALLER_MUI_ICON_CODE
    允许你指定一个NSIS脚本代码片段,用于设置安装程序的MUI图标,可以使用NSIS的内置函数和命令来设置图标。
  5. CPACK_NSIS_MUI_WELCOMEFINISHPAGE_BITMAP(CMake 3.5 添加)
    指定一个位图图像文件的路径,用于替换NSIS MUI插件默认的欢迎页和完成页的图像。
  6. CPACK_NSIS_MUI_UNWELCOMEFINISHPAGE_BITMAP(CMake 3.5 添加)
    指定一个位图图像文件的路径,用于替换NSIS MUI插件默认的取消欢迎页和完成页的图像。
  7. CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS
    指定一个或多个自定义命令,这些命令将在NSIS安装程序执行预安装命令之前执行。
  8. CPACK_NSIS_EXTRA_INSTALL_COMMANDS
    指定一个或多个自定义命令,这些命令将在NSIS安装程序执行预安装命令之后执行。
  9. CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
    指定一个或多个自定义命令,这些命令将在NSIS安装程序执行卸载命令之后执行。
  10. CPACK_NSIS_COMPRESSOR
    指定NSIS安装程序生成时使用的压缩器。默认情况下,CPack使用NSIS的默认压缩器,即zlib压缩器。参数:zlib、lzma、bzip2
  11. CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
    指定是否在安装之前先执行卸载操作(卸载自己)。默认为OFF,即不启用在安装之前先卸载的功能。
  12. CPACK_NSIS_MODIFY_PATH
    指定是否在安装过程中修改系统的PATH环境变量。默认为ON,即允许修改系统的PATH环境变量。
  13. CPACK_NSIS_DISPLAY_NAME
    指定生成的NSIS安装程序在Windows系统中显示的名称。默认该变量的值为项目的名称。
  14. CPACK_NSIS_PACKAGE_NAME
    指定生成的NSIS安装程序的名称。
  15. CPACK_NSIS_INSTALLED_ICON_NAME
    指定在Windows系统中安装完成后的快捷方式图标的名称。默认情况下,该变量的值为项目的图标文件名。
  16. CPACK_NSIS_HELP_LINK
    指定生成的NSIS安装程序的帮助链接。
  17. CPACK_NSIS_URL_INFO_ABOUT
    指定生成的NSIS安装程序的URL链接。
  18. CPACK_NSIS_CONTACT
    指定生成的NSIS安装程序中的联系信息。
  19. CPACK_NSIS_<compName>_INSTALL_DIRECTORY(CMake 3.7 添加)
    为特定的组件(compName)指定一个自定义的安装目录。默认情况下,该变量的值为空,即使用默认的安装目录。
  20. CPACK_NSIS_CREATE_ICONS_EXTRA
    命令形式创建开始菜单快捷方式
  21. CPACK_NSIS_DELETE_ICONS_EXTRA
    命令形式删除开始菜单快捷方式
  22. CPACK_NSIS_EXECUTABLES_DIRECTORY
    指定在NSIS安装程序中可执行文件的目录,默认为空,即使用默认的可执行文件目录。
  23. CPACK_NSIS_MUI_FINISHPAGE_RUN
    指定在NSIS安装程序的完成页面上显示的一个可执行文件的路径。默认为空,即不会在完成页面上显示任何可执行文件。
  24. CPACK_NSIS_MENU_LINKS
    指定开始菜单中的快捷方式。
  25. CPACK_NSIS_UNINSTALL_NAME(CMake 3.17 添加)
    指定卸载程序名称。 默认值为Uninstall。
  26. CPACK_NSIS_WELCOME_TITLE(CMake 3.17 添加)
    指定欢迎页面头部标题文字
  27. CPACK_NSIS_WELCOME_TITLE_3LINES(CMake 3.17 添加)
    指定NSIS安装程序的欢迎页面标题的三行文本。默认为空,即使用默认的欢迎页面标题。
  28. CPACK_NSIS_FINISH_TITLE(CMake 3.17 添加)
    指定NSIS安装程序的完成页面标题的三行文本
  29. CPACK_NSIS_FINISH_TITLE_3LINES(CMake 3.17 添加)
    指定NSIS安装程序的完成页面标题的三行文本。默认为空,即使用默认的完成页面标题。
  30. CPACK_NSIS_MUI_HEADERIMAGE(CMake 3.17 添加)
    指定NSIS安装程序的左上角图标(严格要求的bmp,后来处理了一下图片convert cion.bmp BMP3:cion2.bmp)
  31. CPACK_NSIS_MANIFEST_DPI_AWARE
    指定NSIS安装程序中应用程序的DPI感知属性。默认为空,即不设置DPI感知属性。参数:"default"、"true"、"false"
  32. CPACK_NSIS_BRANDING_TEXT(CMake 3.20 添加)
    指定NSIS安装程序中左下角标线描述。
  33. CPACK_NSIS_BRANDING_TEXT_TRIM_POSITION(CMake 3.20 添加)
    指定NSIS安装程序中品牌文本的截断位置。默认为空,即不进行品牌文本的截断。参数:"left"、"right"
  34. CPACK_NSIS_EXECUTABLE(CMake 3.21 添加)
    指定NSIS安装程序的可执行文件。默认为空,即使用默认的可执行文件。
  35. CPACK_NSIS_IGNORE_LICENSE_PAGE(CMake 3.22 添加)
    指定NSIS安装程序是否忽略许可协议页面。默认为空,即不忽略许可协议页面。参数:"ON"、"OFF"
  36. CPACK_NSIS_EXECUTABLE_PRE_ARGUMENTS(CMake 3.25 添加)
    指定在NSIS安装程序运行可执行文件之前要添加的额外参数。
  37. CPACK_NSIS_EXECUTABLE_POST_ARGUMENTS
    指定在NSIS安装程序运行可执行文件之后要添加的额外参数。

注意事项

生成

E:\test\testMain\build>cpack.exe CPackConfig.cmake
CPack: Create package using NSIS
CPack: Install projects
CPack: - Install project: testMain []
CPack: Create package
CPack: - package: E:/test/testMain/build/测试软件-1.0.0-win64.exe generated.

最后效果

屏幕截图 2023-06-30 112619.jpg
屏幕截图 2023-06-30 112638.jpg


CMake: 使用install-export和find_package查找并链接到库


摘要

一个库生成后然后find_package来引用。下边的示例代码涉及到

dome代码下载

testLib.zip
GIT项目地址

库导出cmake说明

cmake_minimum_required(VERSION 3.5)
project(testLib VERSION 0.1.1 LANGUAGES C CXX)

set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_INSTALL_PREFIX ${CMAKE_BINARY_DIR}/../install)    # 指定安装目录

OPTION(BUILD_MODULE_test "test" OFF)                # 设置编译子模块
if (NOT BUILD_LIBRARY_TYPE)                         # 判定是否配置生成类型下拉项
    set (BUILD_LIBRARY_TYPE "Static" CACHE STRING "${BUILD_LIBRARY_TYPE_DESCR}" FORCE)  # 设置默认类型为静态库
    SET_PROPERTY(CACHE                              # 配置下拉选项
        BUILD_LIBRARY_TYPE PROPERTY STRINGS Shared Static   # 配置生成选择类型下拉项
    )
endif()

if ("${BUILD_LIBRARY_TYPE}" STREQUAL "Shared")
    set (BUILD_SHARED_LIBS ON)                      # 配置生成动态库(OFF/默认为静态库)
endif()

include_directories(include)                        # 添加头文件路径
file(GLOB FILES_SRC "src/*.cpp")                    # 添加当前目录下的源文件至FILES_SRC

add_library(${PROJECT_NAME} ${FILES_SRC})

ADD_CUSTOM_COMMAND(                                 # 用于将自定义构建规则添加到生成的构建系统
    TARGET ${PROJECT_NAME} POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/config $<TARGET_FILE_DIR:${PROJECT_NAME}>/config   # 复制配置目录到可执行目录下
)

############################## 安装部分 ##############################

TARGET_INCLUDE_DIRECTORIES(                         # 目标头文件搜索路径
    ${PROJECT_NAME} PUBLIC                          
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>  # 指定构建接口头文件路径, 可以add_subdirectory后直接头文件
    $<INSTALL_INTERFACE:include>                    # install会自动引用include头文件
)

SET_TARGET_PROPERTIES(${PROJECT_NAME} PROPERTIES    # 设置目标的属性
    # DEBUG_POSTFIX d                                 # debug声称是添加d后缀
    RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}    # 二进制执行文件目录
    ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}    # 静态库目录
    LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}    # 动态库目录
)

INSTALL(
    TARGETS ${PROJECT_NAME}                         # 安装目标名称
    EXPORT ${PROJECT_NAME}Targets                   # 导出项目名
    PUBLIC_HEADER DESTINATION include               # 指定头文件目录
    RUNTIME DESTINATION "bin/$<$<CONFIG:Release>:Release>$<$<CONFIG:Debug>:Debug>"  # 二进制执行文件目录
    ARCHIVE DESTINATION "lib/$<$<CONFIG:Release>:Release>$<$<CONFIG:Debug>:Debug>"  # 静态库目录
    LIBRARY DESTINATION "lib/$<$<CONFIG:Release>:Release>$<$<CONFIG:Debug>:Debug>"  # 动态库目录
)

INSTALL(
    DIRECTORY                                       # 安装目录
    include DESTINATION ${CMAKE_INSTALL_PREFIX}     # 指定头文件安装目录
)

INSTALL(
    EXPORT ${PROJECT_NAME}Targets                   # 导出项目名
    FILE ${PROJECT_NAME}Targets.cmake               # 生成xxxTargets.cmake文件
    # NAMESPACE Ftest::                               # 添加命名空间
    DESTINATION cmake                               # 指定相对路径cmake目录
)


include (CMakePackageConfigHelpers)
configure_package_config_file (                     # 生成 xxxConfig.cmake文件
    cmake/Config.cmake.in ${PROJECT_NAME}Config.cmake   # 根据.make.in 生成对应Config.cmake文件
    INSTALL_DESTINATION cmake                       # 安装目录
    # PATH_VARS INCLUDE_DIRS LIB_DIR
    # INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}
)

write_basic_package_version_file(                   # 生成 xxxConfigVersion.cmake文件
    ${PROJECT_NAME}ConfigVersion.cmake              # 指定文件名
    VERSION ${PACKAGE_VERSION}                      # 指定版本号
    COMPATIBILITY SameMajorVersion                  # 指定兼容性
)

INSTALL(
    FILES
    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake         # 复制xxxConfig.cmake文件到安装目录的cmake
    ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake  # 复制xxxConfigVersion.cmake文件到安装目录的cmake
    DESTINATION cmake                               # 指定相对路径
)

INSTALL(
    DIRECTORY
    config/                                         # 复制配置文件夹
    DESTINATION static                              # 指定目录
)

引入

直接find_package就可以直接将lib和头文件引入。

find_package(testLib REQUIRED)
target_link_libraries(${PROJECT_NAME} testLib::testLib)

使用

#include <iostream>
#include "testLib.h"

using namespace std;

int main(int, char**){
    std::cout << "Hello, from testMain!\n";
    auto pTestLib = make_shared<testLib>();
    pTestLib->say();
}

最终调用成功!
屏幕截图 2023-06-17 090831.jpg


CMake教程一: 介绍、安装、基本使用


CMake 介绍

CMake 是一种跨平台的免费开源软件工具,用于使用与编译器无关的方法来管理软件的构建过程。
通过编写CMakeLists.txt,可以控制生成的Makefile,从而控制编译过程。CMake自动生成的Makefile不仅可以通过make命令构建项目生成目标文件,还支持安装(make install)、测试安装的程序是否能正确执行(make test,或者ctest)、生成当前平台的安装包(make package)、生成源码包(make package_source)、产生Dashboard显示数据并上传等高级功能,只要在CMakeLists.txt中简单配置,就可以完成很多复杂的功能,包括写测试用例。
如果有嵌套目录,子目录下可以有自己的CMakeLists.txt。
CMake是一个非常强大的编译自动配置工具,支持各种平台,KDE也是用它编译的,感兴趣的可以试用一下。

安装

下载地址:CMake官网下载页面

Windows

下载地址:cmake-3.22.0-rc3-windows-x86_64.msi

linux

下载地址:cmake-3.22.0-rc3-linux-x86_64.tar.gz

基本使用

Windows

运行GUI的cmake界面:

微信图片编辑_20211118220355.jpg

Linux

待添加