echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cmake-presets: Make generator and binaryDir fields optional

Browse Source 
In v3 of the presets, generator and buildDir can be omitted to fall
back to regular cmake behavior when these values are not explicitly
provided by the user.

Fixes: #21987
This commit is contained in:
friendlyanon 2021-03-26 13:31:43 +01:00
parent 46393e8977
commit 06e6981336
12 changed files with 80 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Help/manual/cmake-presets.7.rst
View File

@ -145,7 +145,9 @@ that may contain the following fields:
An optional string representing the generator to use for the preset. If
``generator`` is not specified, it must be inherited from the
``inherits`` preset (unless this preset is ``hidden``).
``inherits`` preset (unless this preset is ``hidden``). In version ``3``
or above, this field may be omitted to fall back to regular generator
discovery procedure.
Note that for Visual Studio generators, unlike in the command line ``-G``
argument, you cannot include the platform name in the generator name. Use
@ -186,7 +188,8 @@ that may contain the following fields:
This field supports `macro expansion`_. If a relative path is specified,
it is calculated relative to the source directory. If ``binaryDir`` is not
specified, it must be inherited from the ``inherits`` preset (unless this
preset is ``hidden``).
preset is ``hidden``). In version ``3`` or above, this field may be
omitted.
``installDir``

8
Help/manual/presets/schema.json
View File

@ -79,6 +79,14 @@
"type": "object",
"description": "A configure preset object.",
"properties": {
"binaryDir": {
"type": "string",
"description": "An optional string representing the path to the output binary directory. This field supports macro expansion. If a relative path is specified, it is calculated relative to the source directory. If binaryDir is not specified, the path is calculated using regular methods."
},
"generator": {
"type": "string",
"description": "An optional string representing the generator to use for the preset. If generator is not specified, the normal generator discovery procedure is used. Note that for Visual Studio generators, unlike in the command line -G argument, you cannot include the platform name in the generator name. Use the architecture field instead."
},
"installDir": {
"type": "string",
"description": "An optional string representing the path to the output binary directory. This field supports macro expansion. If a relative path is specified, it is calculated relative to the source directory. If binaryDir is not specified, it must be inherited from the inherits preset (unless this preset is hidden)."

5
Help/release/dev/cmake-presets-optional-generator-and-binarydir.rst Normal file
View File

@ -0,0 +1,5 @@
cmake-presets-optional-generator-and-binarydir
----------------------------------------------
* :manual:`cmake-presets(7)` now support omitting the ``generator`` and
``binaryDir`` fields.

2
Source/QtDialog/QCMake.cxx
View File

@ -160,7 +160,7 @@ void QCMake::setPreset(const QString& name, bool setBinary)
auto const& expandedPreset =
this->CMakePresetsFile.ConfigurePresets[presetName].Expanded;
if (expandedPreset) {
if (setBinary) {
if (setBinary && !expandedPreset->BinaryDir.empty()) {
QString binaryDir =
QString::fromLocal8Bit(expandedPreset->BinaryDir.data());
this->setBinaryDirectory(binaryDir);

38
Source/cmCMakePresetsFile.cxx
View File

@ -78,7 +78,7 @@ void InheritVector(std::vector<T>& child, const std::vector<T>& parent)
template <class T>
ReadFileResult VisitPreset(
T& preset, std::map<std::string, cmCMakePresetsFile::PresetPair<T>>& presets,
std::map<std::string, CycleStatus> cycleStatus)
std::map<std::string, CycleStatus> cycleStatus, int version)
{
switch (cycleStatus[preset.Name]) {
case CycleStatus::InProgress:
@ -108,7 +108,7 @@ ReadFileResult VisitPreset(
return ReadFileResult::USER_PRESET_INHERITANCE;
}
auto result = VisitPreset(parentPreset, presets, cycleStatus);
auto result = VisitPreset(parentPreset, presets, cycleStatus, version);
if (result != ReadFileResult::READ_OK) {
return result;
}
@ -128,7 +128,7 @@ ReadFileResult VisitPreset(
preset.ConditionEvaluator.reset();
}
CHECK_OK(preset.VisitPresetAfterInherit())
CHECK_OK(preset.VisitPresetAfterInherit(version))
cycleStatus[preset.Name] = CycleStatus::Verified;
return ReadFileResult::READ_OK;
@ -136,7 +136,8 @@ ReadFileResult VisitPreset(
template <class T>
ReadFileResult ComputePresetInheritance(
std::map<std::string, cmCMakePresetsFile::PresetPair<T>>& presets)
std::map<std::string, cmCMakePresetsFile::PresetPair<T>>& presets,
const cmCMakePresetsFile& file)
{
std::map<std::string, CycleStatus> cycleStatus;
for (auto const& it : presets) {
@ -144,7 +145,9 @@ ReadFileResult ComputePresetInheritance(
}
for (auto& it : presets) {
auto result = VisitPreset<T>(it.second.Unexpanded, presets, cycleStatus);
auto& preset = it.second.Unexpanded;
auto result =
VisitPreset<T>(preset, presets, cycleStatus, file.GetVersion(preset));
if (result != ReadFileResult::READ_OK) {
return result;
}
@ -667,16 +670,19 @@ cmCMakePresetsFile::ConfigurePreset::VisitPresetBeforeInherit()
}
cmCMakePresetsFile::ReadFileResult
cmCMakePresetsFile::ConfigurePreset::VisitPresetAfterInherit()
cmCMakePresetsFile::ConfigurePreset::VisitPresetAfterInherit(int version)
{
auto& preset = *this;
if (!preset.Hidden) {
if (preset.Generator.empty()) {
return ReadFileResult::INVALID_PRESET;
}
if (preset.BinaryDir.empty()) {
return ReadFileResult::INVALID_PRESET;
if (version < 3) {
if (preset.Generator.empty()) {
return ReadFileResult::INVALID_PRESET;
}
if (preset.BinaryDir.empty()) {
return ReadFileResult::INVALID_PRESET;
}
}
if (preset.WarnDev == false && preset.ErrorDev == true) {
return ReadFileResult::INVALID_PRESET;
}
@ -712,7 +718,7 @@ cmCMakePresetsFile::BuildPreset::VisitPresetInherit(
}
cmCMakePresetsFile::ReadFileResult
cmCMakePresetsFile::BuildPreset::VisitPresetAfterInherit()
cmCMakePresetsFile::BuildPreset::VisitPresetAfterInherit(int /* version */)
{
auto& preset = *this;
if (!preset.Hidden && preset.ConfigurePreset.empty()) {
@ -822,7 +828,7 @@ cmCMakePresetsFile::TestPreset::VisitPresetInherit(
}
cmCMakePresetsFile::ReadFileResult
cmCMakePresetsFile::TestPreset::VisitPresetAfterInherit()
cmCMakePresetsFile::TestPreset::VisitPresetAfterInherit(int /* version */)
{
auto& preset = *this;
if (!preset.Hidden && preset.ConfigurePreset.empty()) {
@ -883,9 +889,9 @@ cmCMakePresetsFile::ReadProjectPresetsInternal(bool allowNoFiles)
: ReadFileResult::FILE_NOT_FOUND;
}
CHECK_OK(ComputePresetInheritance(this->ConfigurePresets))
CHECK_OK(ComputePresetInheritance(this->BuildPresets))
CHECK_OK(ComputePresetInheritance(this->TestPresets))
CHECK_OK(ComputePresetInheritance(this->ConfigurePresets, *this))
CHECK_OK(ComputePresetInheritance(this->BuildPresets, *this))
CHECK_OK(ComputePresetInheritance(this->TestPresets, *this))
for (auto& it : this->ConfigurePresets) {
if (!ExpandMacros(*this, it.second.Unexpanded, it.second.Expanded)) {

8
Source/cmCMakePresetsFile.h
View File

@ -89,7 +89,7 @@ public:
return ReadFileResult::READ_OK;
}
virtual ReadFileResult VisitPresetAfterInherit()
virtual ReadFileResult VisitPresetAfterInherit(int /* version */)
{
return ReadFileResult::READ_OK;
}
@ -132,7 +132,7 @@ public:
ReadFileResult VisitPresetInherit(const Preset& parent) override;
ReadFileResult VisitPresetBeforeInherit() override;
ReadFileResult VisitPresetAfterInherit() override;
ReadFileResult VisitPresetAfterInherit(int version) override;
};
class BuildPreset : public Preset
@ -158,7 +158,7 @@ public:
std::vector<std::string> NativeToolOptions;
ReadFileResult VisitPresetInherit(const Preset& parent) override;
ReadFileResult VisitPresetAfterInherit() override;
ReadFileResult VisitPresetAfterInherit(int /* version */) override;
};
class TestPreset : public Preset
@ -285,7 +285,7 @@ public:
cm::optional<ExecutionOptions> Execution;
ReadFileResult VisitPresetInherit(const Preset& parent) override;
ReadFileResult VisitPresetAfterInherit() override;
ReadFileResult VisitPresetAfterInherit(int /* version */) override;
};
template <class T>

9
Source/cmake.cxx
View File

@ -1223,10 +1223,11 @@ void cmake::SetArgs(const std::vector<std::string>& args)
return;
}
if (!this->State->IsCacheLoaded() && !haveBArg) {
if (!this->State->IsCacheLoaded() && !haveBArg &&
!expandedPreset->BinaryDir.empty()) {
this->SetHomeOutputDirectory(expandedPreset->BinaryDir);
}
if (!this->GlobalGenerator) {
if (!this->GlobalGenerator && !expandedPreset->Generator.empty()) {
if (!this->CreateAndSetGlobalGenerator(expandedPreset->Generator,
false)) {
return;
@ -3203,7 +3204,9 @@ int cmake::Build(int jobs, std::string dir, std::vector<std::string> targets,
return 1;
}
dir = expandedConfigurePreset->BinaryDir;
if (!expandedConfigurePreset->BinaryDir.empty()) {
dir = expandedConfigurePreset->BinaryDir;
}
this->UnprocessedPresetEnvironment = expandedPreset->Environment;
this->ProcessPresetEnvironment();

3
Tests/RunCMake/CMakePresets/OptionalBinaryDirField.cmake Normal file
View File

@ -0,0 +1,3 @@
include(${CMAKE_CURRENT_LIST_DIR}/TestVariable.cmake)
test_variable(CMAKE_BINARY_DIR "" "${CMAKE_SOURCE_DIR}/build")

9
Tests/RunCMake/CMakePresets/OptionalBinaryDirField.json.in Normal file
View File

@ -0,0 +1,9 @@
{
"version": 3,
"configurePresets": [
{
"name": "OptionalBinaryDirField",
"generator": "@RunCMake_GENERATOR@"
}
]
}

3
Tests/RunCMake/CMakePresets/OptionalGeneratorField.cmake Normal file
View File

@ -0,0 +1,3 @@
include(${CMAKE_CURRENT_LIST_DIR}/TestVariable.cmake)
test_variable(CMAKE_GENERATOR "" "${RunCMake_GENERATOR}")

9
Tests/RunCMake/CMakePresets/OptionalGeneratorField.json.in Normal file
View File

@ -0,0 +1,9 @@
{
"version": 3,
"configurePresets": [
{
"name": "OptionalGeneratorField",
"binaryDir": "${sourceDir}/build"
}
]
}

5
Tests/RunCMake/CMakePresets/RunCMakeTest.cmake
View File

@ -275,6 +275,11 @@ set(CMakePresets_FILE "${RunCMake_SOURCE_DIR}/Conditions.json.in")
run_cmake_presets(ListConditions --list-presets)
run_cmake_presets(SimpleTrue)
run_cmake_presets(SimpleFalse)
unset(CMakePresets_FILE)
# Test optional generator and buildDir fields
run_cmake_presets(OptionalBinaryDirField -B "${RunCMake_BINARY_DIR}/OptionalBinaryDirField/build")
run_cmake_presets(OptionalGeneratorField -G "${RunCMake_GENERATOR}")
# Test the example from the documentation
file(READ "${RunCMake_SOURCE_DIR}/../../../Help/manual/presets/example.json" _example)