Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-19 19:43:23 +08:00
Code Issues Projects Releases Wiki Activity

Ninja: Add COMMENT to custom command and target descriptions

Browse Source 
Fixes: #15461
This commit is contained in:
Ben Boeckel
2024-05-01 17:31:35 -04:00
committed by Brad King
parent 30fb5b1b22
commit 0122e02293
3 changed files with 40 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
Source/cmNinjaUtilityTargetGenerator.cxx
View File

@@ -5,6 +5,7 @@
#include <algorithm> #include <algorithm>
#include <array> #include <array>
#include <iterator> #include <iterator>
#include <memory>
#include <set> #include <set>
#include <string> #include <string>
#include <utility> #include <utility>
@@ -13,6 +14,7 @@
#include "cmCustomCommand.h" #include "cmCustomCommand.h"
#include "cmCustomCommandGenerator.h" #include "cmCustomCommandGenerator.h"
#include "cmGeneratedFileStream.h" #include "cmGeneratedFileStream.h"
#include "cmGeneratorExpression.h"
#include "cmGeneratorTarget.h" #include "cmGeneratorTarget.h"
#include "cmGlobalNinjaGenerator.h" #include "cmGlobalNinjaGenerator.h"
#include "cmLocalNinjaGenerator.h" #include "cmLocalNinjaGenerator.h"
@@ -76,6 +78,8 @@ void cmNinjaUtilityTargetGenerator::WriteUtilBuildStatements(
cmGlobalNinjaGenerator::CCOutputs util_outputs(gg); cmGlobalNinjaGenerator::CCOutputs util_outputs(gg);
util_outputs.ExplicitOuts.emplace_back(utilCommandName); util_outputs.ExplicitOuts.emplace_back(utilCommandName);
std::string commandDesc;
cmGeneratorExpression ge(*this->GetLocalGenerator()->GetCMakeInstance());
bool uses_terminal = false; bool uses_terminal = false;
{ {
std::array<std::vector<cmCustomCommand> const*, 2> const cmdLists = { std::array<std::vector<cmCustomCommand> const*, 2> const cmdLists = {
@@ -87,6 +91,13 @@ void cmNinjaUtilityTargetGenerator::WriteUtilBuildStatements(
cmCustomCommandGenerator ccg(ci, fileConfig, lg); cmCustomCommandGenerator ccg(ci, fileConfig, lg);
lg->AppendCustomCommandDeps(ccg, deps, fileConfig); lg->AppendCustomCommandDeps(ccg, deps, fileConfig);
lg->AppendCustomCommandLines(ccg, commands); lg->AppendCustomCommandLines(ccg, commands);
if (ci.GetComment()) {
if (!commandDesc.empty()) {
commandDesc += "; ";
}
auto cge = ge.Parse(ci.GetComment());
commandDesc += cge->Evaluate(this->GetLocalGenerator(), config);
}
util_outputs.Add(ccg.GetByproducts()); util_outputs.Add(ccg.GetByproducts());
if (ci.GetUsesTerminal()) { if (ci.GetUsesTerminal()) {
uses_terminal = true; uses_terminal = true;
@@ -144,6 +155,8 @@ void cmNinjaUtilityTargetGenerator::WriteUtilBuildStatements(
cmValue echoStr = genTarget->GetProperty("EchoString"); cmValue echoStr = genTarget->GetProperty("EchoString");
if (echoStr) { if (echoStr) {
desc = *echoStr; desc = *echoStr;
} else if (!commandDesc.empty()) {
desc = commandDesc;
} else { } else {
desc = "Running utility command for " + this->GetTargetName(); desc = "Running utility command for " + this->GetTargetName();
} }

12
Tests/RunCMake/Ninja/CustomCommandTargetComments.cmake Normal file
View File

@@ -0,0 +1,12 @@
enable_language(C)
add_executable(hello hello.c)
add_custom_command(TARGET hello PRE_BUILD
COMMENT "pre-build: $<1:genex>"
COMMAND "${CMAKE_COMMAND}" -E echo "$<TARGET_FILE:hello>")
add_custom_command(TARGET hello PRE_LINK
COMMENT "pre-link: $<1:genex>"
COMMAND "${CMAKE_COMMAND}" -E echo "$<TARGET_FILE:hello>")
add_custom_command(TARGET hello POST_BUILD
COMMENT "post-build: $<1:genex>"
COMMAND "${CMAKE_COMMAND}" -E echo "$<TARGET_FILE:hello>")

15
Tests/RunCMake/Ninja/RunCMakeTest.cmake
View File

@@ -389,6 +389,21 @@ function (run_ChangeBuildType)
endfunction() endfunction()
run_ChangeBuildType() run_ChangeBuildType()
function (run_CustomCommandTargetComments)
set(RunCMake_TEST_BINARY_DIR ${RunCMake_BINARY_DIR}/CustomCommandTargetComments-build)
run_cmake(CustomCommandTargetComments)
unset(RunCMake_TEST_OPTIONS)
run_ninja("${RunCMake_TEST_BINARY_DIR}" ${maybe_w_dupbuild_err})
if (NOT ninja_stdout MATCHES [[pre-build: genex; pre-link: genex; Linking C executable hello(\.exe)?; post-build: genex]])
string(REPLACE "\n" "\n " ninja_stdout "${ninja_stdout}")
message(SEND_ERROR
"Custom command comments are not part of the description:\n"
" ${ninja_stdout}"
)
endif ()
endfunction()
run_CustomCommandTargetComments()
function(run_QtAutoMocSkipPch) function(run_QtAutoMocSkipPch)
set(QtX Qt${CMake_TEST_Qt_version}) set(QtX Qt${CMake_TEST_Qt_version})
if(CMake_TEST_${QtX}Core_Version VERSION_GREATER_EQUAL 5.15.0) if(CMake_TEST_${QtX}Core_Version VERSION_GREATER_EQUAL 5.15.0)