CMake语法—环境变量(Environment Variable)

1 定义环境变量

set(ENV{<variable>} [<value>])
  • ENV:环境变量标志性前缀
  • variable:变量名称
  • value:变量值

2 应用环境变量

2.1 代码结构

  • learn_cmake:为根目录
  • build:为CMake配置输出目录(在此例中即生成sln解决方案的地方)
  • cmake_config.bat:执行CMake配置过程的脚本(双击直接运行)
  • CMakeLists.txt:CMake脚本

2.2 示例代码

  1. 示例代码(CMakeLists.txt文件内容)

    cmake_minimum_required(VERSION 3.18)
    
    # 设置工程名称
    set(PROJECT_NAME KAIZEN) # 设置工程版本号
    set(PROJECT_VERSION "1.0.0.10" CACHE STRING "默认版本号") # 工程定义
    project(${PROJECT_NAME}
    LANGUAGES CXX C
    VERSION ${PROJECT_VERSION}
    ) # 打印开始日志
    message(STATUS "\n########## BEGIN_TEST_ENV_VARIABLE") # 判断JAVA_HOME变量是否定义
    if(DEFINED ENV{JAVA_HOME})
    message("JAVA_HOME: $ENV{JAVA_HOME}")
    else()
    message("NOT DEFINED JAVA_HOME VARIABLES")
    endif() # 定义环境变量
    set(ENV{CMAKE_PATH} "F:/cmake") # 判断CMAKE_PATH环境变量是否定义
    if(DEFINED ENV{CMAKE_PATH})
    message("CMAKE_PATH_1: $ENV{CMAKE_PATH}")
    else()
    message("NOT DEFINED CMAKE_PATH VARIABLES")
    endif() # 定义测试函数,在函数中新定义环境变量
    function(test_env_variable)
    # 访问环境变量CMAKE_PATH
    message("CMAKE_PATH_2: $ENV{CMAKE_PATH}") # 函数内定义环境变量
    set(ENV{CMAKE_FUNC} "F:/cmake/dir") # 判断CMAKE_FUNC环境变量是否定义
    if(DEFINED ENV{CMAKE_FUNC})
    message("CMAKE_FUNC_1: $ENV{CMAKE_FUNC}")
    else()
    message("NOT DEFINED CMAKE_FUNC_1 VARIABLES")
    endif()
    endfunction() # 调用函数
    test_env_variable() # 判断CMAKE_FUNC环境变量是否定义
    if(DEFINED ENV{CMAKE_FUNC})
    message("CMAKE_FUNC_2: $ENV{CMAKE_FUNC}")
    else()
    message("NOT DEFINED CMAKE_FUNC_2 VARIABLES")
    endif() # 如果没有参数值
    set(ENV{CMAKE_FUNC}) # 判断CMAKE_FUNC环境变量是否定义
    if(DEFINED ENV{CMAKE_FUNC})
    message("CMAKE_FUNC_3: $ENV{CMAKE_FUNC}")
    else()
    message("NOT DEFINED CMAKE_FUNC_3 VARIABLES")
    endif() # 定义测试宏,在函数中新定义环境变量
    macro(test_env_var)
    # 访问环境变量CMAKE_PATH
    message("CMAKE_PATH_3: $ENV{CMAKE_PATH}") # 宏内定义环境变量
    set(ENV{CMAKE_MACRO} "F:/cmake/macro") # 判断CMAKE_MACRO环境变量是否定义
    if(DEFINED ENV{CMAKE_MACRO})
    message("CMAKE_MACRO_1: $ENV{CMAKE_MACRO}")
    else()
    message("NOT DEFINED CMAKE_MACRO_1 VARIABLES")
    endif()
    endmacro() # 调用宏
    test_env_var() # 判断CMAKE_MACRO环境变量是否定义
    if(DEFINED ENV{CMAKE_MACRO})
    message("CMAKE_MACRO_2: $ENV{CMAKE_MACRO}")
    else()
    message("NOT DEFINED CMAKE_MACRO_2 VARIABLES")
    endif() # 如果多个参数值
    set(ENV{CMAKE_FILE} "F:/cmake/cmake1.txt" "F:/cmake/cmake2.txt") # 判断CMAKE_FILE环境变量是否定义
    if(DEFINED ENV{CMAKE_FILE})
    message("CMAKE_FILE: $ENV{CMAKE_FILE}")
    else()
    message("NOT DEFINED CMAKE_FILE VARIABLES")
    endif() # 打印结束日志
    message(STATUS "########## END_TEST_ENV_VARIABLE\n")
  2. cmake_config.bat

    @echo off
    set currentDir=%~dp0
    set buildDir=%currentDir%
    set cmakeOutputDir=%currentDir%\build
    cmake -S %buildDir% -B %cmakeOutputDir% -G"Visual Studio 16 2019" -T v140 -A x64
    pause

2.3 运行结果

  1. 本地环境

    本地安装VS版本:Visual Studio 2019(2015工具集)

    CMake版本:3.18.2

    F:\learn_cmake
    λ cmake --version
    cmake version 3.18.2 CMake suite maintained and supported by Kitware (kitware.com/cmake).
  2. 输出结果

    -- Selecting Windows SDK version 10.0.18362.0 to target Windows 10.0.17763.
    -- The CXX compiler identification is MSVC 19.0.24245.0
    -- The C compiler identification is MSVC 19.0.24245.0
    -- Detecting CXX compiler ABI info
    -- Detecting CXX compiler ABI info - done
    -- Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio 14.0/VC/bin/amd64/cl.exe - skipped
    -- Detecting CXX compile features
    -- Detecting CXX compile features - done
    -- Detecting C compiler ABI info
    -- Detecting C compiler ABI info - done
    -- Check for working C compiler: C:/Program Files (x86)/Microsoft Visual Studio 14.0/VC/bin/amd64/cl.exe - skipped
    -- Detecting C compile features
    -- Detecting C compile features - done
    --
    ########## BEGIN_TEST_ENV_VARIABLE
    JAVA_HOME: C:\Program Files\Java\jdk1.8.0_201
    CMAKE_PATH_1: F:/cmake
    CMAKE_PATH_2: F:/cmake
    CMAKE_FUNC_1: F:/cmake/dir
    CMAKE_FUNC_2: F:/cmake/dir
    NOT DEFINED CMAKE_FUNC_3 VARIABLES
    CMAKE_PATH_3: F:/cmake
    CMAKE_MACRO_1: F:/cmake/macro
    CMAKE_MACRO_2: F:/cmake/macro
    CMake Warning (dev) at CMakeLists.txt:98 (set):
    Only the first value argument is used when setting an environment variable.
    Argument 'F:/cmake/cmake2.txt' and later are unused.
    This warning is for project developers. Use -Wno-dev to suppress it. CMAKE_FILE: F:/cmake/cmake1.txt
    -- ########## END_TEST_ENV_VARIABLE -- Configuring done
    -- Generating done
    -- Build files have been written to: F:/learn_cmake/build
    请按任意键继续. . .

3 小结

  1. 设定或读取环境变量时,都通过ENV前缀来访问环境变量。

  2. 读取环境变量值时,要在ENV前加$符号;但if判断是否定义时,不用加$符号。

  3. 设定环境变量,此命令只影响当前CMake进程,不影响调用CMake的进程,也不影响整个系统环境。

  4. 设定环境变量时,没有给变量赋值:

    如果有同名环境变量,此命令将清除已存在的同名环境变量;

    如果没有同名环境变量,此命令将被视为无效代码。

    如示例程序中第62行,将清除已存在的环境变量CMAKE_FUNC,这样导致输出结果第21行:NOT DEFINED CMAKE_FUNC_3 VARIABLES

  5. 设定环境变量时,变量值仅有一个。多余的值会被忽略,并且会提示警告信息。

    如示例程序中第98行,变量值为2个,结果第二个值被忽略,且会有CMake Warning打印到输出结果内容中。

  6. 环境变量,不存在作用域的区分。即函数、宏、子目录、包含模块中都一样,只会影响当前CMake进程。

    如示例程序中第52、88行,经过调用函数和宏的测试,其内部可以访问外部的环境变量;在其内部定义的环境变量,在外部也可以正常使用。

    子目录与函数属于同类(有作用域区分),宏和包含模块属于同类(无作用域区分),因此,在此只用测试两种即可说明问题。

CMake语法—环境变量(Environment Variable)的更多相关文章

  1. ABAP Netweaver和Cloud Foundry上的环境变量Environment Variable

    Netweaver 更准确的说应该是系统变量:结构体sy 设一个断点,调试器里看这些字段的值就能知道每个字段是用来做什么的. sy-dbsys sy-sysid sy-opsys sy-saprl s ...

  2. CMake语法—普通变量与函数(Normal Variable And Function)

    目录 CMake语法-普通变量与函数(Normal Variable And Function) 1 CMake普通变量与函数示例 1.1 CMakeLists.txt 1.2 执行CMake配置脚本 ...

  3. CMake语法—普通变量与子目录(Normal Variable And Subdirectory)

    目录 CMake语法-普通变量与子目录(Normal Variable And Subdirectory) 1 CMake普通变量与子目录示例 1.1 代码目录结构 1.2 父目录CMakeLists ...

  4. CMake语法—普通变量与包含、宏(Normal Variable And Include、Macro)

    目录 CMake语法-普通变量与包含.宏(Normal Variable And Include.Macro) 1 CMake普通变量与包含.宏示例 1.1 代码目录结构 1.2 根目录CMakeLi ...

  5. CMake语法—缓存变量(Cache Variable)

    目录 CMake语法-缓存变量(Cache Variable) 1 CMake缓存变量 2 定义缓存变量 2.1 定义格式 2.2 定义示例代码 2.3 运行结果 2.4 小结 3 CMakeCach ...

  6. postman 用环境变量Environment实现多服务器版本

    现存问题 在测试API期间,往往存在多种环境,对应IP地址(或域名也不同) 比如: Prod: http://116.62.25.57/ucows 用于开发完成发布到生产环境 Dev: http:// ...

  7. [Elixir004]通过环境变量(Environment Variables)来管理config

    在elixir的config中我们有时会使用的到一些不想暴露出来的配置项,常用的作法是如Phoenix #config/prod.exs use Mix.Config ... # Finally im ...

  8. Cmake设置环境变量

    references: http://stackoverflow.com/questions/21047399/cmake-set-environment-variables-from-a-scrip ...

  9. CentOS中环境变量和配置文件

    什么是环境变量 bash shell用一个叫做 环境变量(environment variable) 的特性来存储有关shell会话和工作环境的信息.即允许在内存中存储数据,使得在程序或shell中运 ...

随机推荐

  1. ACwing02.01背包问题

    有\(N\)件物品和一个容量是\(V\)的背包.每件物品只能使用一次. 第\(i\)件物品的体积是\(v_i\),价值是\(w_i\). 求解将哪些物品装入背包,可使这些物品的总体积不超过背包容量,且 ...

  2. protoc格式生成java文件

    下载protoc.exe 地址:https://yvioo.lanzoui.com/i12opqs7q9g 下载好之后 ,把protoc文件和exe放在一个文件夹内 用记事本打开protoc,删掉包路 ...

  3. JAVA结合WebSocket实现简单客服聊天功能

    说明:该示例只简单的实现了客服聊天功能. 1.聊天记录没有保存到数据库中,一旦服务重启,消息记录将会没有,如果需要保存到数据库中,可以扩展 2.页面样式用的网上模板,样式可以自己进行修改 3.只能由用 ...

  4. Java容器源码学习--ArrayList源码分析

    ArrayList实现了List接口,它的底层数据结构是数组,因此获取容器中任意元素值的时间复杂度为O(1),新增或删除元素的时间复杂度为O(N).每一个ArrayList实例都有一个capacity ...

  5. Windows串口之解决包含setupapi.h还提示找不到符号报错

    关于 本文演示环境: win10 1909 + VS2017 1. 错误信息 明明已经添加了头文件setupapi.h 和 库 setupapi.lib, 却还是提示报错,报错信息: 1>C:\ ...

  6. 使用.NET 6开发TodoList应用(8)——实现全局异常处理

    系列导航 使用.NET 6开发TodoList应用文章索引 需求 因为在项目中,会有各种各样的领域异常或系统异常被抛出来,那么在Controller里就需要进行完整的try-catch捕获,并根据是否 ...

  7. 【LeetCode】604. Design Compressed String Iterator 解题报告(C++)

    作者: 负雪明烛 id: fuxuemingzhu 个人博客:http://fuxuemingzhu.cn/ 目录 题目描述 题目大意 解题方法 维护当前字符和次数 日期 题目地址:https://l ...

  8. 【LeetCode】268. Missing Number 解题报告(Java & Python)

    作者: 负雪明烛 id: fuxuemingzhu 个人博客: http://fuxuemingzhu.cn/ 目录 题目描述 题目大意 解题方法 求和 异或 日期 题目地址:https://leet ...

  9. 【LeetCode】565. Array Nesting 解题报告(Python & C++)

    作者: 负雪明烛 id: fuxuemingzhu 个人博客: http://fuxuemingzhu.cn/ 目录 题目描述 题目大意 解题方法 日期 题目地址:https://leetcode.c ...

  10. 另一个角度看元宇宙与RPA:人工世界、平行员工与RPA

    另一个角度看元宇宙与RPA:人工世界.平行员工与RPA 从元宇宙到平行员工,人工世界推动的虚实分工利好RPA 机器人是铁打营盘人类是流水兵,未来元宇宙的虚实分工RPA机会巨大 文/王吉伟 元宇宙是平行 ...