cmCMakePresetsGraphReadJSON.cxx 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780
  1. /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. file Copyright.txt or https://cmake.org/licensing for details. */
  3. #include <algorithm>
  4. #include <fstream>
  5. #include <functional>
  6. #include <map>
  7. #include <string>
  8. #include <unordered_set>
  9. #include <utility>
  10. #include <vector>
  11. #include <cm/memory>
  12. #include <cm/optional>
  13. #include <cmext/string_view>
  14. #include <cm3p/json/value.h>
  15. #include "cmCMakePresetsErrors.h"
  16. #include "cmCMakePresetsGraph.h"
  17. #include "cmCMakePresetsGraphInternal.h"
  18. #include "cmJSONHelpers.h"
  19. #include "cmJSONState.h"
  20. #include "cmStringAlgorithms.h"
  21. #include "cmSystemTools.h"
  22. #include "cmVersion.h"
  23. namespace {
  24. using CacheVariable = cmCMakePresetsGraph::CacheVariable;
  25. using ConfigurePreset = cmCMakePresetsGraph::ConfigurePreset;
  26. using BuildPreset = cmCMakePresetsGraph::BuildPreset;
  27. using TestPreset = cmCMakePresetsGraph::TestPreset;
  28. using PackagePreset = cmCMakePresetsGraph::PackagePreset;
  29. using WorkflowPreset = cmCMakePresetsGraph::WorkflowPreset;
  30. using ArchToolsetStrategy = cmCMakePresetsGraph::ArchToolsetStrategy;
  31. using JSONHelperBuilder = cmJSONHelperBuilder;
  32. using ExpandMacroResult = cmCMakePresetsGraphInternal::ExpandMacroResult;
  33. using MacroExpander = cmCMakePresetsGraphInternal::MacroExpander;
  34. using MacroExpanderVector = cmCMakePresetsGraphInternal::MacroExpanderVector;
  35. using cmCMakePresetsGraphInternal::BaseMacroExpander;
  36. using cmCMakePresetsGraphInternal::ExpandMacros;
  37. constexpr int MIN_VERSION = 1;
  38. constexpr int MAX_VERSION = 10;
  39. struct CMakeVersion
  40. {
  41. unsigned int Major = 0;
  42. unsigned int Minor = 0;
  43. unsigned int Patch = 0;
  44. };
  45. struct RootPresets
  46. {
  47. CMakeVersion CMakeMinimumRequired;
  48. std::vector<ConfigurePreset> ConfigurePresets;
  49. std::vector<BuildPreset> BuildPresets;
  50. std::vector<TestPreset> TestPresets;
  51. std::vector<PackagePreset> PackagePresets;
  52. std::vector<WorkflowPreset> WorkflowPresets;
  53. std::vector<std::string> Include;
  54. };
  55. std::unique_ptr<cmCMakePresetsGraphInternal::NotCondition> InvertCondition(
  56. std::unique_ptr<cmCMakePresetsGraph::Condition> condition)
  57. {
  58. auto retval = cm::make_unique<cmCMakePresetsGraphInternal::NotCondition>();
  59. retval->SubCondition = std::move(condition);
  60. return retval;
  61. }
  62. auto const ConditionStringHelper = JSONHelperBuilder::String();
  63. auto const ConditionBoolHelper = JSONHelperBuilder::Bool();
  64. auto const ConditionStringListHelper = JSONHelperBuilder::Vector<std::string>(
  65. cmCMakePresetsErrors::INVALID_CONDITION, ConditionStringHelper);
  66. auto const ConstConditionHelper =
  67. JSONHelperBuilder::Object<cmCMakePresetsGraphInternal::ConstCondition>(
  68. cmCMakePresetsErrors::INVALID_CONDITION_OBJECT, false)
  69. .Bind<std::string>("type"_s, nullptr, ConditionStringHelper, true)
  70. .Bind("value"_s, &cmCMakePresetsGraphInternal::ConstCondition::Value,
  71. ConditionBoolHelper, true);
  72. auto const EqualsConditionHelper =
  73. JSONHelperBuilder::Object<cmCMakePresetsGraphInternal::EqualsCondition>(
  74. cmCMakePresetsErrors::INVALID_CONDITION_OBJECT, false)
  75. .Bind<std::string>("type"_s, nullptr, ConditionStringHelper, true)
  76. .Bind("lhs"_s, &cmCMakePresetsGraphInternal::EqualsCondition::Lhs,
  77. ConditionStringHelper, true)
  78. .Bind("rhs"_s, &cmCMakePresetsGraphInternal::EqualsCondition::Rhs,
  79. ConditionStringHelper, true);
  80. auto const InListConditionHelper =
  81. JSONHelperBuilder::Object<cmCMakePresetsGraphInternal::InListCondition>(
  82. cmCMakePresetsErrors::INVALID_CONDITION_OBJECT, false)
  83. .Bind<std::string>("type"_s, nullptr, ConditionStringHelper, true)
  84. .Bind("string"_s, &cmCMakePresetsGraphInternal::InListCondition::String,
  85. ConditionStringHelper, true)
  86. .Bind("list"_s, &cmCMakePresetsGraphInternal::InListCondition::List,
  87. ConditionStringListHelper, true);
  88. auto const MatchesConditionHelper =
  89. JSONHelperBuilder::Object<cmCMakePresetsGraphInternal::MatchesCondition>(
  90. cmCMakePresetsErrors::INVALID_CONDITION_OBJECT, false)
  91. .Bind<std::string>("type"_s, nullptr, ConditionStringHelper, true)
  92. .Bind("string"_s, &cmCMakePresetsGraphInternal::MatchesCondition::String,
  93. ConditionStringHelper, true)
  94. .Bind("regex"_s, &cmCMakePresetsGraphInternal::MatchesCondition::Regex,
  95. ConditionStringHelper, true);
  96. bool SubConditionHelper(std::unique_ptr<cmCMakePresetsGraph::Condition>& out,
  97. const Json::Value* value, cmJSONState* state);
  98. auto const ListConditionVectorHelper =
  99. JSONHelperBuilder::Vector<std::unique_ptr<cmCMakePresetsGraph::Condition>>(
  100. cmCMakePresetsErrors::INVALID_CONDITION, SubConditionHelper);
  101. auto const AnyAllOfConditionHelper =
  102. JSONHelperBuilder::Object<cmCMakePresetsGraphInternal::AnyAllOfCondition>(
  103. cmCMakePresetsErrors::INVALID_CONDITION_OBJECT, false)
  104. .Bind<std::string>("type"_s, nullptr, ConditionStringHelper, true)
  105. .Bind("conditions"_s,
  106. &cmCMakePresetsGraphInternal::AnyAllOfCondition::Conditions,
  107. ListConditionVectorHelper);
  108. auto const NotConditionHelper =
  109. JSONHelperBuilder::Object<cmCMakePresetsGraphInternal::NotCondition>(
  110. cmCMakePresetsErrors::INVALID_CONDITION_OBJECT, false)
  111. .Bind<std::string>("type"_s, nullptr, ConditionStringHelper, true)
  112. .Bind("condition"_s,
  113. &cmCMakePresetsGraphInternal::NotCondition::SubCondition,
  114. SubConditionHelper);
  115. bool ConditionHelper(std::unique_ptr<cmCMakePresetsGraph::Condition>& out,
  116. const Json::Value* value, cmJSONState* state)
  117. {
  118. if (!value) {
  119. out.reset();
  120. return true;
  121. }
  122. if (value->isBool()) {
  123. auto c = cm::make_unique<cmCMakePresetsGraphInternal::ConstCondition>();
  124. c->Value = value->asBool();
  125. out = std::move(c);
  126. return true;
  127. }
  128. if (value->isNull()) {
  129. out = cm::make_unique<cmCMakePresetsGraphInternal::NullCondition>();
  130. return true;
  131. }
  132. if (value->isObject()) {
  133. if (!value->isMember("type")) {
  134. cmCMakePresetsErrors::INVALID_CONDITION(value, state);
  135. return false;
  136. }
  137. if (!(*value)["type"].isString()) {
  138. cmCMakePresetsErrors::INVALID_CONDITION(value, state);
  139. return false;
  140. }
  141. auto type = (*value)["type"].asString();
  142. if (type == "const") {
  143. auto c = cm::make_unique<cmCMakePresetsGraphInternal::ConstCondition>();
  144. CHECK_OK(ConstConditionHelper(*c, value, state));
  145. out = std::move(c);
  146. return true;
  147. }
  148. if (type == "equals" || type == "notEquals") {
  149. auto c = cm::make_unique<cmCMakePresetsGraphInternal::EqualsCondition>();
  150. CHECK_OK(EqualsConditionHelper(*c, value, state));
  151. out = std::move(c);
  152. if (type == "notEquals") {
  153. out = InvertCondition(std::move(out));
  154. }
  155. return true;
  156. }
  157. if (type == "inList" || type == "notInList") {
  158. auto c = cm::make_unique<cmCMakePresetsGraphInternal::InListCondition>();
  159. CHECK_OK(InListConditionHelper(*c, value, state));
  160. out = std::move(c);
  161. if (type == "notInList") {
  162. out = InvertCondition(std::move(out));
  163. }
  164. return true;
  165. }
  166. if (type == "matches" || type == "notMatches") {
  167. auto c =
  168. cm::make_unique<cmCMakePresetsGraphInternal::MatchesCondition>();
  169. CHECK_OK(MatchesConditionHelper(*c, value, state));
  170. out = std::move(c);
  171. if (type == "notMatches") {
  172. out = InvertCondition(std::move(out));
  173. }
  174. return true;
  175. }
  176. if (type == "anyOf" || type == "allOf") {
  177. auto c =
  178. cm::make_unique<cmCMakePresetsGraphInternal::AnyAllOfCondition>();
  179. c->StopValue = (type == "anyOf");
  180. CHECK_OK(AnyAllOfConditionHelper(*c, value, state));
  181. out = std::move(c);
  182. return true;
  183. }
  184. if (type == "not") {
  185. auto c = cm::make_unique<cmCMakePresetsGraphInternal::NotCondition>();
  186. CHECK_OK(NotConditionHelper(*c, value, state));
  187. out = std::move(c);
  188. return true;
  189. }
  190. }
  191. cmCMakePresetsErrors::INVALID_CONDITION(value, state);
  192. return false;
  193. }
  194. bool SubConditionHelper(std::unique_ptr<cmCMakePresetsGraph::Condition>& out,
  195. const Json::Value* value, cmJSONState* state)
  196. {
  197. std::unique_ptr<cmCMakePresetsGraph::Condition> ptr;
  198. auto result = ConditionHelper(ptr, value, state);
  199. if (ptr && ptr->IsNull()) {
  200. cmCMakePresetsErrors::INVALID_CONDITION(value, state);
  201. return false;
  202. }
  203. out = std::move(ptr);
  204. return result;
  205. }
  206. bool EnvironmentHelper(cm::optional<std::string>& out,
  207. const Json::Value* value, cmJSONState* state)
  208. {
  209. if (!value || value->isNull()) {
  210. out = cm::nullopt;
  211. return true;
  212. }
  213. if (value->isString()) {
  214. out = value->asString();
  215. return true;
  216. }
  217. cmCMakePresetsErrors::INVALID_PRESET(value, state);
  218. return false;
  219. }
  220. auto const VersionIntHelper =
  221. JSONHelperBuilder::Int(cmCMakePresetsErrors::INVALID_VERSION);
  222. auto const VersionHelper = JSONHelperBuilder::Required<int>(
  223. cmCMakePresetsErrors::NO_VERSION, VersionIntHelper);
  224. auto const RootVersionHelper =
  225. JSONHelperBuilder::Object<int>(cmCMakePresetsErrors::INVALID_ROOT_OBJECT)
  226. .Bind("version"_s, VersionHelper, false);
  227. auto const CMakeVersionUIntHelper =
  228. JSONHelperBuilder::UInt(cmCMakePresetsErrors::INVALID_VERSION);
  229. auto const CMakeVersionHelper =
  230. JSONHelperBuilder::Object<CMakeVersion>(JsonErrors::INVALID_NAMED_OBJECT_KEY,
  231. false)
  232. .Bind("major"_s, &CMakeVersion::Major, CMakeVersionUIntHelper, false)
  233. .Bind("minor"_s, &CMakeVersion::Minor, CMakeVersionUIntHelper, false)
  234. .Bind("patch"_s, &CMakeVersion::Patch, CMakeVersionUIntHelper, false);
  235. auto const IncludeHelper =
  236. JSONHelperBuilder::String(cmCMakePresetsErrors::INVALID_INCLUDE);
  237. auto const IncludeVectorHelper = JSONHelperBuilder::Vector<std::string>(
  238. cmCMakePresetsErrors::INVALID_INCLUDE, IncludeHelper);
  239. auto const RootPresetsHelper =
  240. JSONHelperBuilder::Object<RootPresets>(
  241. cmCMakePresetsErrors::INVALID_ROOT_OBJECT, false)
  242. .Bind<int>("version"_s, nullptr, VersionHelper)
  243. .Bind("configurePresets"_s, &RootPresets::ConfigurePresets,
  244. cmCMakePresetsGraphInternal::ConfigurePresetsHelper, false)
  245. .Bind("buildPresets"_s, &RootPresets::BuildPresets,
  246. cmCMakePresetsGraphInternal::BuildPresetsHelper, false)
  247. .Bind("testPresets"_s, &RootPresets::TestPresets,
  248. cmCMakePresetsGraphInternal::TestPresetsHelper, false)
  249. .Bind("packagePresets"_s, &RootPresets::PackagePresets,
  250. cmCMakePresetsGraphInternal::PackagePresetsHelper, false)
  251. .Bind("workflowPresets"_s, &RootPresets::WorkflowPresets,
  252. cmCMakePresetsGraphInternal::WorkflowPresetsHelper, false)
  253. .Bind("cmakeMinimumRequired"_s, &RootPresets::CMakeMinimumRequired,
  254. CMakeVersionHelper, false)
  255. .Bind("include"_s, &RootPresets::Include, IncludeVectorHelper, false)
  256. .Bind<std::nullptr_t>("vendor"_s, nullptr,
  257. cmCMakePresetsGraphInternal::VendorHelper(
  258. cmCMakePresetsErrors::INVALID_ROOT),
  259. false)
  260. .Bind<std::nullptr_t>("$schema"_s, nullptr,
  261. cmCMakePresetsGraphInternal::SchemaHelper(), false);
  262. class EnvironmentMacroExpander : public MacroExpander
  263. {
  264. public:
  265. ExpandMacroResult operator()(const std::string& macroNamespace,
  266. const std::string& macroName,
  267. std::string& macroOut,
  268. int /*version*/) const override
  269. {
  270. if (macroNamespace == "penv") {
  271. if (macroName.empty()) {
  272. return ExpandMacroResult::Error;
  273. }
  274. if (cm::optional<std::string> value =
  275. cmSystemTools::GetEnvVar(macroName)) {
  276. macroOut += *value;
  277. }
  278. return ExpandMacroResult::Ok;
  279. }
  280. return ExpandMacroResult::Ignore;
  281. }
  282. };
  283. }
  284. namespace cmCMakePresetsGraphInternal {
  285. bool PresetStringHelper(std::string& out, const Json::Value* value,
  286. cmJSONState* state)
  287. {
  288. static auto const helper = JSONHelperBuilder::String();
  289. return helper(out, value, state);
  290. }
  291. bool PresetNameHelper(std::string& out, const Json::Value* value,
  292. cmJSONState* state)
  293. {
  294. if (!value || !value->isString() || value->asString().empty()) {
  295. cmCMakePresetsErrors::INVALID_PRESET_NAME(value, state);
  296. return false;
  297. }
  298. out = value->asString();
  299. return true;
  300. }
  301. bool PresetVectorStringHelper(std::vector<std::string>& out,
  302. const Json::Value* value, cmJSONState* state)
  303. {
  304. static auto const helper = JSONHelperBuilder::Vector<std::string>(
  305. cmCMakePresetsErrors::INVALID_PRESET,
  306. cmCMakePresetsGraphInternal::PresetStringHelper);
  307. return helper(out, value, state);
  308. }
  309. bool PresetBoolHelper(bool& out, const Json::Value* value, cmJSONState* state)
  310. {
  311. static auto const helper = JSONHelperBuilder::Bool();
  312. return helper(out, value, state);
  313. }
  314. bool PresetOptionalBoolHelper(cm::optional<bool>& out,
  315. const Json::Value* value, cmJSONState* state)
  316. {
  317. static auto const helper =
  318. JSONHelperBuilder::Optional<bool>(PresetBoolHelper);
  319. return helper(out, value, state);
  320. }
  321. bool PresetIntHelper(int& out, const Json::Value* value, cmJSONState* state)
  322. {
  323. static auto const helper = JSONHelperBuilder::Int();
  324. return helper(out, value, state);
  325. }
  326. bool PresetOptionalIntHelper(cm::optional<int>& out, const Json::Value* value,
  327. cmJSONState* state)
  328. {
  329. static auto const helper = JSONHelperBuilder::Optional<int>(PresetIntHelper);
  330. return helper(out, value, state);
  331. }
  332. bool PresetVectorIntHelper(std::vector<int>& out, const Json::Value* value,
  333. cmJSONState* state)
  334. {
  335. static auto const helper = JSONHelperBuilder::Vector<int>(
  336. cmCMakePresetsErrors::INVALID_PRESET, PresetIntHelper);
  337. return helper(out, value, state);
  338. }
  339. cmJSONHelper<std::nullptr_t> VendorHelper(const ErrorGenerator& error)
  340. {
  341. return [error](std::nullptr_t& /*out*/, const Json::Value* value,
  342. cmJSONState* state) -> bool {
  343. if (!value) {
  344. return true;
  345. }
  346. if (!value->isObject()) {
  347. error(value, state);
  348. return false;
  349. }
  350. return true;
  351. };
  352. }
  353. bool PresetConditionHelper(
  354. std::shared_ptr<cmCMakePresetsGraph::Condition>& out,
  355. const Json::Value* value, cmJSONState* state)
  356. {
  357. std::unique_ptr<cmCMakePresetsGraph::Condition> ptr;
  358. auto result = ConditionHelper(ptr, value, state);
  359. out = std::move(ptr);
  360. return result;
  361. }
  362. bool PresetVectorOneOrMoreStringHelper(std::vector<std::string>& out,
  363. const Json::Value* value,
  364. cmJSONState* state)
  365. {
  366. out.clear();
  367. if (!value) {
  368. return true;
  369. }
  370. if (value->isString()) {
  371. out.push_back(value->asString());
  372. return true;
  373. }
  374. return PresetVectorStringHelper(out, value, state);
  375. }
  376. bool EnvironmentMapHelper(
  377. std::map<std::string, cm::optional<std::string>>& out,
  378. const Json::Value* value, cmJSONState* state)
  379. {
  380. static auto const helper = JSONHelperBuilder::Map<cm::optional<std::string>>(
  381. cmCMakePresetsErrors::INVALID_PRESET, EnvironmentHelper);
  382. return helper(out, value, state);
  383. }
  384. cmJSONHelper<std::nullptr_t> SchemaHelper()
  385. {
  386. return [](std::nullptr_t&, const Json::Value*, cmJSONState*) -> bool {
  387. return true;
  388. };
  389. }
  390. }
  391. bool cmCMakePresetsGraph::ReadJSONFile(const std::string& filename,
  392. RootType rootType,
  393. ReadReason readReason,
  394. std::vector<File*>& inProgressFiles,
  395. File*& file, std::string& errMsg)
  396. {
  397. bool result;
  398. for (auto const& f : this->Files) {
  399. if (cmSystemTools::SameFile(filename, f->Filename)) {
  400. file = f.get();
  401. auto fileIt =
  402. std::find(inProgressFiles.begin(), inProgressFiles.end(), file);
  403. if (fileIt != inProgressFiles.end()) {
  404. cmCMakePresetsErrors::CYCLIC_INCLUDE(filename, &this->parseState);
  405. return false;
  406. }
  407. return true;
  408. }
  409. }
  410. Json::Value root;
  411. this->parseState = cmJSONState(filename, &root);
  412. if (!this->parseState.errors.empty()) {
  413. return false;
  414. }
  415. int v = 0;
  416. if ((result = RootVersionHelper(v, &root, &parseState)) != true) {
  417. return result;
  418. }
  419. if (v < MIN_VERSION || v > MAX_VERSION) {
  420. cmCMakePresetsErrors::UNRECOGNIZED_VERSION(&root["version"],
  421. &this->parseState);
  422. return false;
  423. }
  424. // Support for build and test presets added in version 2.
  425. if (v < 2) {
  426. if (root.isMember("buildPresets")) {
  427. cmCMakePresetsErrors::BUILD_TEST_PRESETS_UNSUPPORTED(
  428. &root["buildPresets"], &this->parseState);
  429. return false;
  430. }
  431. if (root.isMember("testPresets")) {
  432. cmCMakePresetsErrors::BUILD_TEST_PRESETS_UNSUPPORTED(
  433. &root["testPresets"], &this->parseState);
  434. return false;
  435. }
  436. }
  437. // Support for package presets added in version 6.
  438. if (v < 6 && root.isMember("packagePresets")) {
  439. cmCMakePresetsErrors::PACKAGE_PRESETS_UNSUPPORTED(&root["packagePresets"],
  440. &this->parseState);
  441. return false;
  442. }
  443. // Support for workflow presets added in version 6.
  444. if (v < 6 && root.isMember("workflowPresets")) {
  445. cmCMakePresetsErrors::WORKFLOW_PRESETS_UNSUPPORTED(
  446. &root["workflowPresets"], &this->parseState);
  447. return false;
  448. }
  449. // Support for include added in version 4.
  450. if (v < 4 && root.isMember("include")) {
  451. cmCMakePresetsErrors::INCLUDE_UNSUPPORTED(&root["include"],
  452. &this->parseState);
  453. return false;
  454. }
  455. // Support for $schema added in version 8.
  456. if (v < 8 && root.isMember("$schema")) {
  457. cmCMakePresetsErrors::SCHEMA_UNSUPPORTED(&this->parseState);
  458. return false;
  459. }
  460. // Support for $comment added in version 10.
  461. this->parseState.allowComments = (v >= 10);
  462. RootPresets presets;
  463. if ((result = RootPresetsHelper(presets, &root, &parseState)) != true) {
  464. return result;
  465. }
  466. unsigned int currentMajor = cmVersion::GetMajorVersion();
  467. unsigned int currentMinor = cmVersion::GetMinorVersion();
  468. unsigned int currentPatch = cmVersion::GetPatchVersion();
  469. auto const& required = presets.CMakeMinimumRequired;
  470. if (required.Major > currentMajor) {
  471. ErrorGenerator error = cmCMakePresetsErrors::UNRECOGNIZED_CMAKE_VERSION(
  472. "major", currentMajor, required.Major);
  473. error(&root["cmakeMinimumRequired"]["major"], &this->parseState);
  474. return false;
  475. }
  476. if (required.Major == currentMajor) {
  477. if (required.Minor > currentMinor) {
  478. ErrorGenerator error = cmCMakePresetsErrors::UNRECOGNIZED_CMAKE_VERSION(
  479. "minor", currentMinor, required.Minor);
  480. error(&root["cmakeMinimumRequired"]["minor"], &this->parseState);
  481. return false;
  482. }
  483. if (required.Minor == currentMinor && required.Patch > currentPatch) {
  484. ErrorGenerator error = cmCMakePresetsErrors::UNRECOGNIZED_CMAKE_VERSION(
  485. "patch", currentPatch, required.Patch);
  486. error(&root["cmakeMinimumRequired"]["patch"], &this->parseState);
  487. return false;
  488. }
  489. }
  490. auto filePtr = cm::make_unique<File>();
  491. file = filePtr.get();
  492. this->Files.emplace_back(std::move(filePtr));
  493. inProgressFiles.emplace_back(file);
  494. file->Filename = filename;
  495. file->Version = v;
  496. file->ReachableFiles.insert(file);
  497. for (auto& preset : presets.ConfigurePresets) {
  498. preset.OriginFile = file;
  499. if (preset.Name.empty()) {
  500. // No error, already handled by PresetNameHelper
  501. return false;
  502. }
  503. PresetPair<ConfigurePreset> presetPair;
  504. presetPair.Unexpanded = preset;
  505. presetPair.Expanded = cm::nullopt;
  506. if (!this->ConfigurePresets.emplace(preset.Name, presetPair).second) {
  507. cmCMakePresetsErrors::DUPLICATE_PRESETS(preset.Name, &this->parseState);
  508. return false;
  509. }
  510. // Support for installDir presets added in version 3.
  511. if (v < 3 && !preset.InstallDir.empty()) {
  512. cmCMakePresetsErrors::INSTALL_PREFIX_UNSUPPORTED(&root["installDir"],
  513. &this->parseState);
  514. return false;
  515. }
  516. // Support for conditions added in version 3.
  517. if (v < 3 && preset.ConditionEvaluator) {
  518. cmCMakePresetsErrors::CONDITION_UNSUPPORTED(&this->parseState);
  519. return false;
  520. }
  521. // Support for toolchainFile presets added in version 3.
  522. if (v < 3 && !preset.ToolchainFile.empty()) {
  523. cmCMakePresetsErrors::TOOLCHAIN_FILE_UNSUPPORTED(&this->parseState);
  524. return false;
  525. }
  526. // Support for trace presets added in version 7.
  527. if (v < 7 &&
  528. (preset.TraceMode.has_value() || preset.TraceFormat.has_value() ||
  529. !preset.TraceRedirect.empty() || !preset.TraceSource.empty())) {
  530. cmCMakePresetsErrors::TRACE_UNSUPPORTED(&this->parseState);
  531. return false;
  532. }
  533. this->ConfigurePresetOrder.push_back(preset.Name);
  534. }
  535. for (auto& preset : presets.BuildPresets) {
  536. preset.OriginFile = file;
  537. if (preset.Name.empty()) {
  538. // No error, already handled by PresetNameHelper
  539. return false;
  540. }
  541. PresetPair<BuildPreset> presetPair;
  542. presetPair.Unexpanded = preset;
  543. presetPair.Expanded = cm::nullopt;
  544. if (!this->BuildPresets.emplace(preset.Name, presetPair).second) {
  545. cmCMakePresetsErrors::DUPLICATE_PRESETS(preset.Name, &this->parseState);
  546. return false;
  547. }
  548. // Support for conditions added in version 3.
  549. if (v < 3 && preset.ConditionEvaluator) {
  550. cmCMakePresetsErrors::CONDITION_UNSUPPORTED(&this->parseState);
  551. return false;
  552. }
  553. this->BuildPresetOrder.push_back(preset.Name);
  554. }
  555. for (auto& preset : presets.TestPresets) {
  556. preset.OriginFile = file;
  557. if (preset.Name.empty()) {
  558. // No error, already handled by PresetNameHelper
  559. return false;
  560. }
  561. PresetPair<TestPreset> presetPair;
  562. presetPair.Unexpanded = preset;
  563. presetPair.Expanded = cm::nullopt;
  564. if (!this->TestPresets.emplace(preset.Name, presetPair).second) {
  565. cmCMakePresetsErrors::DUPLICATE_PRESETS(preset.Name, &this->parseState);
  566. return false;
  567. }
  568. // Support for conditions added in version 3.
  569. if (v < 3 && preset.ConditionEvaluator) {
  570. cmCMakePresetsErrors::CONDITION_UNSUPPORTED(&this->parseState);
  571. return false;
  572. }
  573. // Support for TestOutputTruncation added in version 5.
  574. if (v < 5 && preset.Output && preset.Output->TestOutputTruncation) {
  575. cmCMakePresetsErrors::TEST_OUTPUT_TRUNCATION_UNSUPPORTED(
  576. &this->parseState);
  577. return false;
  578. }
  579. // Support for outputJUnitFile added in version 6.
  580. if (v < 6 && preset.Output && !preset.Output->OutputJUnitFile.empty()) {
  581. cmCMakePresetsErrors::CTEST_JUNIT_UNSUPPORTED(&this->parseState);
  582. return false;
  583. }
  584. this->TestPresetOrder.push_back(preset.Name);
  585. }
  586. for (auto& preset : presets.PackagePresets) {
  587. preset.OriginFile = file;
  588. if (preset.Name.empty()) {
  589. // No error, already handled by PresetNameHelper
  590. return false;
  591. }
  592. PresetPair<PackagePreset> presetPair;
  593. presetPair.Unexpanded = preset;
  594. presetPair.Expanded = cm::nullopt;
  595. if (!this->PackagePresets.emplace(preset.Name, presetPair).second) {
  596. cmCMakePresetsErrors::DUPLICATE_PRESETS(preset.Name, &this->parseState);
  597. return false;
  598. }
  599. // Support for conditions added in version 3, but this requires version 5
  600. // already, so no action needed.
  601. this->PackagePresetOrder.push_back(preset.Name);
  602. }
  603. for (auto& preset : presets.WorkflowPresets) {
  604. preset.OriginFile = file;
  605. if (preset.Name.empty()) {
  606. // No error, already handled by PresetNameHelper
  607. return false;
  608. }
  609. PresetPair<WorkflowPreset> presetPair;
  610. presetPair.Unexpanded = preset;
  611. presetPair.Expanded = cm::nullopt;
  612. if (!this->WorkflowPresets.emplace(preset.Name, presetPair).second) {
  613. cmCMakePresetsErrors::DUPLICATE_PRESETS(preset.Name, &this->parseState);
  614. return false;
  615. }
  616. // Support for conditions added in version 3, but this requires version 6
  617. // already, so no action needed.
  618. this->WorkflowPresetOrder.push_back(preset.Name);
  619. }
  620. auto const includeFile = [this, &inProgressFiles,
  621. file](const std::string& include,
  622. RootType rootType2, ReadReason readReason2,
  623. std::string& FailureMessage) -> bool {
  624. bool r;
  625. File* includedFile;
  626. if ((r =
  627. this->ReadJSONFile(include, rootType2, readReason2, inProgressFiles,
  628. includedFile, FailureMessage)) != true) {
  629. return r;
  630. }
  631. file->ReachableFiles.insert(includedFile->ReachableFiles.begin(),
  632. includedFile->ReachableFiles.end());
  633. return true;
  634. };
  635. MacroExpanderVector macroExpanders{};
  636. if (v >= 9) {
  637. macroExpanders.push_back(
  638. cm::make_unique<BaseMacroExpander>(*this, filename));
  639. }
  640. macroExpanders.push_back(cm::make_unique<EnvironmentMacroExpander>());
  641. for (Json::ArrayIndex i = 0; i < presets.Include.size(); ++i) {
  642. auto include = presets.Include[i];
  643. // Support for macro expansion in includes added in version 7
  644. if (v >= 7) {
  645. if (ExpandMacros(include, macroExpanders, v) != ExpandMacroResult::Ok) {
  646. cmCMakePresetsErrors::INVALID_INCLUDE(&root["include"][i],
  647. &this->parseState);
  648. return false;
  649. }
  650. }
  651. if (!cmSystemTools::FileIsFullPath(include)) {
  652. auto directory = cmSystemTools::GetFilenamePath(filename);
  653. include = cmStrCat(directory, '/', include);
  654. }
  655. if ((result = includeFile(include, rootType, ReadReason::Included,
  656. errMsg)) != true) {
  657. return result;
  658. }
  659. }
  660. if (rootType == RootType::User && readReason == ReadReason::Root) {
  661. auto cmakePresetsFilename = GetFilename(this->SourceDir);
  662. if (cmSystemTools::FileExists(cmakePresetsFilename)) {
  663. if ((result = includeFile(cmakePresetsFilename, RootType::Project,
  664. ReadReason::Root, errMsg)) != true) {
  665. return result;
  666. }
  667. }
  668. }
  669. inProgressFiles.pop_back();
  670. return true;
  671. }