【问题标题】:How to call a cmake method from shell script?如何从 shell 脚本调用 cmake 方法?
【发布时间】:2021-06-03 11:45:16
【问题描述】:

我在mytestprogram.cmake 中有一个参数化函数,如下所示:

function(get_output_from_input output input) 
    set(${output} "test" PARENT_SCOPE)
endfunction()

问题:
如何在 shell 脚本中调用 cmake 方法get_output_from_input

我了解到有 -P <source.cmake> 标志,它将 CMake 置于脚本处理模式,我们可以使用它执行任意 CMake 代码,如下所示。

execute_process(COMMAND ${CMAKE_PROGRAM} -P yourscript.cmake)

那么,在这种情况下,我相信从 shell 脚本调用 get_output_from_input 的方式如下所示?

input="some_input"
output=""
execute_process(get_output_from_input(output, input) ${CMAKE_PROGRAM} -P mytestprogram.cmake)
echo $output

但上述技巧不起作用。我运行execute_process 的方式正确吗?

试图找出问题所在,echo $CMAKE_PROGRAM 似乎返回空?这可能是原因吗?我在这里缺少什么打电话给get_output_from_input

环境:
cmake 版本 3.18.2
macOS 卡塔利娜

【问题讨论】:

  • 我更正了get_output_from_input的语法。
  • 显然,如果没有适当的解释器,您将无法运行脚本或其中的一部分。没有 shell 就不能运行 shell 脚本(shbash 等),没有cmake 就不能运行 CMake 脚本。此外,脚本中的所有定义(函数、变量)仅对其解释器可见:您无法在 CMake 之外读取在 CMake 脚本中定义的变量,您无法在 CMake 之外运行在 CMake 脚本中定义的函数。唯一的例外是环境变量,因为它们根本不是脚本变量:环境变量的概念是跨脚本语言共享的。
  • 这很好地解释了我的问题。感谢您解释为什么@Tsyvarev

标签: shell cmake cmake-language cmakelists-options


【解决方案1】:

cmake -P 执行整个脚本,而不是在 CMake 文件中定义的单个函数,因此需要添加一个额外的脚本文件,然后您可以通过cmake -P 执行该脚本文件。通过 cmake -P 执行的脚本的参数需要作为 CMake 变量传递,例如cmake -DINPUT=some_input -P myscript.cmake .

由于您需要在 bash 变量中输出 CMake 脚本,因此 CMake 脚本“mytestscript.cmake”将如下所示:

# make `get_output_from_input` available in current script
# assuming the script file is located next to `mytestprogram.cmake`
include(${CMAKE_CURRENT_LIST_DIR}/mytestprogram.cmake)

get_output_from_input(RESULT "${INPUT}")

message("${RESULT}")

并且shell脚本包含

#!/bin/bash
input="some_input"

# assumes `mytestscript.cmake` is located in the current working directory
output=$(cmake -DINPUT="${input}" -P mytestscript.cmake 2>&1)

# Below statement should print the value of output.
echo $output

关于execute_process:如果您需要从 CMake 脚本中执行另一个进程,而不是从 shell 进程中执行 CMake 脚本,则可以使用它。根据您打算如何处理 CMake 脚本的输出,您可能会使用 execute_process 而不是额外的 bash。

【讨论】:

  • 非常感谢您的浏览。我不需要在环境变量中输出get_output_from_input。我只需要它在 shell 脚本中的一个变量中。
  • include(${CMAKE_CURRENT_LIST_DIR}/mytestprogram.cmake) 要从 shell 脚本中调用吗?
  • 您介意简化一下您的答案吗?我只需要在我的.sh shell 脚本和echo 的变量中输出该cmake 方法的输出。就是这样。
  • 请注意,我不是有意从CMakeLists.txt 致电get_output_from_input。我的意思是,如何从 shell 脚本中调用它。
  • @TheWaterProgrammer include(${CMAKE_CURRENT_LIST_DIR}/mytestprogram.cmake 需要从您打算使用 cmake -P 执行的 CMake 脚本中调用。我现在已经为脚本文件命名,希望它更容易理解。
【解决方案2】:

我认为您所要求的——直接从 CMake 的脚本模式设置 Bash 变量——是不可能的。脚本模式 (-P) 只允许您在没有项目/构建目录的情况下运行 CMake 代码。而execute_processCMake 命令,不是shell 命令,所以从sh/bash 调用它肯定会失败。

你写的 CMake 函数也是错误的。它所做的只是写入一个永远不会被读取并立即被销毁的局部变量。你可能想要set(VAR "VALUE" PARENT_SCOPE)return() 没有意义,应该删除。

如果你explained a bit more about what you were trying to do,也许这个问题可以回答。


下面是 CMake 脚本模式的基本演示:

# ./script.cmake
# Input variable: file
# Output: md5sum of file

cmake_minimum_required(VERSION 3.19)

file(MD5 "${file}" hash)
message("${hash}")

从终端运行它(相当于一个 shell 脚本):

$ ls
my_file.txt  script.cmake
$ cat my_file.txt
Hello, world!
$ cmake -Dfile=my_file.txt -P script.cmake
746308829575e17c3331bbcb00c0898b

【讨论】:

  • 我更正了 .cmake 文件中的语法。感谢您指出。您的意思是不可能从 shell 脚本中调用 .cmake 文件中的函数?
  • 正确,您不能直接从 shell 脚本调用 CMake 函数。但是,您可以按照我在示例中所做的操作,编写一个 CMake 脚本来加载您的函数、调用它并打印结果。
猜你喜欢
  • 2012-03-13
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2012-01-11
  • 2018-01-29
  • 2020-11-12
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多