Merge pull request #85 from build-cpp/settings-rename

mrexodia · web-flow · commit ad17890e232e · 2023-01-14T21:14:12.000+01:00
Rename `[settings]` to `[variables]`
diff --git a/docs/cmake-toml.md b/docs/cmake-toml.md
@@ -9,7 +9,8 @@ nav_order: 3
 
 This page is a reference for the options in the `cmake.toml` file. If you think anything is missing or unclear, please [edit this page](https://github.com/build-cpp/cmkr/edit/main/docs/cmake-toml.md) or open an [issue](https://github.com/build-cpp/cmkr/issues).
 
-See the [examples](/examples) section for concrete examples.
+This is a reference page. Check out the [examples](/examples) and the [cmkr topic](https://github.com/topics/cmkr) as well.
+{:.info}
 
 ## CMake configuration
 
@@ -93,6 +94,16 @@ include-before = ["cmake/before-subdir.cmake"]
 include-after = ["cmake/after-subdir.cmake"]
 ```
 
+## Variables
+
+```toml
+[variables]
+MYBOOL = true
+MYSTRING = "hello"
+```
+
+Variables emit a [`set`](https://cmake.org/cmake/help/latest/command/set.html) and can be used to configure subprojects and packages.
+
 ## Vcpkg
 
 ```toml
diff --git a/include/project_parser.hpp b/include/project_parser.hpp
@@ -14,7 +14,7 @@ using Condition = tsl::ordered_map<std::string, T>;
 
 using ConditionVector = Condition<std::vector<std::string>>;
 
-struct Setting {
+struct Variable {
     std::string name;
     std::string comment;
     mpark::variant<bool, std::string> val;
@@ -185,7 +185,7 @@ struct Project {
     Condition<std::string> cmake_after;
     ConditionVector include_before;
     ConditionVector include_after;
-    std::vector<Setting> settings;
+    std::vector<Variable> variables;
     std::vector<Option> options;
     std::vector<Package> packages;
     Vcpkg vcpkg;
diff --git a/src/cmake_generator.cpp b/src/cmake_generator.cpp
@@ -621,10 +621,9 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
         endl();
     }
 
-    // TODO: rename to 'variables'?
-    if (!project.settings.empty()) {
-        comment("Settings");
-        for (const auto &set : project.settings) {
+    if (!project.variables.empty()) {
+        comment("Variables");
+        for (const auto &set : project.variables) {
             std::string set_val;
             if (set.val.index() == 1) {
                 set_val = mpark::get<1>(set.val);
diff --git a/src/project_parser.cpp b/src/project_parser.cpp
@@ -32,14 +32,14 @@ static MsvcRuntimeType parse_msvcRuntimeType(const std::string &name) {
 
 using TomlBasicValue = toml::basic_value<toml::discard_comments, tsl::ordered_map, std::vector>;
 
-static std::string format_key_error(const std::string &error, const toml::key &ky, const TomlBasicValue &value) {
+static std::string format_key_message(const std::string &message, const toml::key &ky, const TomlBasicValue &value) {
     auto loc = value.location();
     auto line_number_str = std::to_string(loc.line());
     auto line_width = line_number_str.length();
     auto line_str = loc.line_str();
 
     std::ostringstream oss;
-    oss << "[error] " << error << '\n';
+    oss << message << "\n";
     oss << " --> " << loc.file_name() << ':' << loc.line() << '\n';
 
     oss << std::string(line_width + 2, ' ') << "|\n";
@@ -57,6 +57,14 @@ static std::string format_key_error(const std::string &error, const toml::key &k
     return oss.str();
 }
 
+static void throw_key_error(const std::string &error, const toml::key &ky, const TomlBasicValue &value) {
+    throw std::runtime_error(format_key_message("[error] " + error, ky, value));
+}
+
+static void print_key_warning(const std::string &message, const toml::key &ky, const TomlBasicValue &value) {
+    puts(format_key_message("[warning] " + message, ky, value).c_str());
+}
+
 class TomlChecker {
     const TomlBasicValue &m_v;
     tsl::ordered_set<toml::key> m_visited;
@@ -133,27 +141,27 @@ class TomlChecker {
             const auto &ky = itr.first;
             if (m_conditionVisited.contains(ky)) {
                 if (!conditions.contains(ky)) {
-                    throw std::runtime_error(format_key_error("Unknown condition '" + ky + "'", ky, itr.second));
+                    throw_key_error("Unknown condition '" + ky + "'", ky, itr.second);
                 }
 
                 for (const auto &jtr : itr.second.as_table()) {
                     if (!m_visited.contains(jtr.first)) {
-                        throw std::runtime_error(format_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second));
+                        throw_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second);
                     }
                 }
             } else if (!m_visited.contains(ky)) {
                 if (itr.second.is_table()) {
                     for (const auto &jtr : itr.second.as_table()) {
                         if (!m_visited.contains(jtr.first)) {
-                            throw std::runtime_error(format_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second));
+                            throw_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second);
                         }
                     }
                 }
-                throw std::runtime_error(format_key_error("Unknown key '" + ky + "'", ky, itr.second));
+                throw_key_error("Unknown key '" + ky + "'", ky, itr.second);
             } else if (ky == "condition") {
                 std::string condition = itr.second.as_string();
                 if (!conditions.contains(condition)) {
-                    throw std::runtime_error(format_key_error("Unknown condition '" + condition + "'", condition, itr.second));
+                    throw_key_error("Unknown condition '" + condition + "'", condition, itr.second);
                 }
             }
         }
@@ -191,7 +199,7 @@ class TomlCheckerRoot {
         if (check_root) {
             for (const auto &itr : m_root.as_table()) {
                 if (!m_visisted.contains(itr.first)) {
-                    throw std::runtime_error(format_key_error("Unknown key '" + itr.first + "'", itr.first, itr.second));
+                    throw_key_error("Unknown key '" + itr.first + "'", itr.first, itr.second);
                 }
             }
         }
@@ -219,7 +227,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
         cmake.required("version", cmake_version);
 
         if (cmake.contains("bin-dir")) {
-            throw std::runtime_error("bin-dir has been renamed to build-dir");
+            throw_key_error("bin-dir has been renamed to build-dir", "bin-dir", cmake.find("bin-dir"));
         }
 
         cmake.optional("build-dir", build_dir);
@@ -297,7 +305,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                     error += "  - " + type_name + "\n";
                 }
                 error.pop_back(); // Remove last newline
-                throw std::runtime_error(format_key_error(error, msvc_runtime, project.find("msvc-runtime")));
+                throw_key_error(error, msvc_runtime, project.find("msvc-runtime"));
             }
         }
     }
@@ -319,11 +327,21 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
         }
     }
 
-    if (checker.contains("settings")) {
+    if (checker.contains("variables")) {
         using set_map = tsl::ordered_map<std::string, TomlBasicValue>;
-        const auto &sets = toml::find<set_map>(toml, "settings");
-        for (const auto &itr : sets) {
-            Setting s;
+        auto vars = toml::find<set_map>(toml, "variables");
+        if (checker.contains("settings")) {
+            print_key_warning("[settings] has been renamed to [variables]", "settings", toml.at("settings"));
+            const auto &sets = toml::find<set_map>(toml, "settings");
+            for (const auto &itr : sets) {
+                if (!vars.insert(itr).second) {
+                    throw_key_error("Key '" + itr.first + "' shadows existing variable", itr.first, itr.second);
+                }
+            }
+        }
+
+        for (const auto &itr : vars) {
+            Variable s;
             s.name = itr.first;
             const auto &value = itr.second;
             if (value.is_boolean()) {
@@ -344,7 +362,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                 setting.optional("cache", s.cache);
                 setting.optional("force", s.force);
             }
-            settings.push_back(s);
+            variables.push_back(s);
         }
     }
 
@@ -454,7 +472,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                 } else if (is_cmake_arg(key)) {
                     // allow passthrough of ExternalProject options
                 } else if (!c.visisted(key)) {
-                    throw std::runtime_error(format_key_error("Unknown key '" + argItr.first + "'", argItr.first, argItr.second));
+                    throw_key_error("Unknown key '" + argItr.first + "'", argItr.first, argItr.second);
                 }
 
                 // Make sure not to emit keys like "condition" in the FetchContent call
@@ -469,7 +487,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
     }
 
     if (checker.contains("bin")) {
-        throw std::runtime_error("[[bin]] has been renamed to [[target]]");
+        throw_key_error("[[bin]] has been renamed to [target.<name>]", "", toml.at("bin"));
     }
 
     auto parse_target = [&](const std::string &name, TomlChecker &t, bool isTemplate) {
@@ -508,7 +526,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                 }
             }
             error.pop_back(); // Remove last newline
-            throw std::runtime_error(format_key_error(error, target.type_name, t.find("type")));
+            throw_key_error(error, target.type_name, t.find("type"));
         }
 
         t.optional("sources", target.sources);
@@ -570,7 +588,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                 } else {
                     report = &t.find(condItr.first).as_table().find("msvc-runtime").value();
                 }
-                throw std::runtime_error(format_key_error(error, condItr.second, *report));
+                throw_key_error(error, condItr.second, *report);
             }
             }
         }
@@ -626,13 +644,13 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
 
             for (const auto &type_name : targetTypeNames) {
                 if (name == type_name) {
-                    throw std::runtime_error(format_key_error("Reserved template name '" + name + "'", name, itr.second));
+                    throw_key_error("Reserved template name '" + name + "'", name, itr.second);
                 }
             }
 
             for (const auto &tmplate : templates) {
                 if (name == tmplate.outline.name) {
-                    throw std::runtime_error(format_key_error("Template '" + name + "' already defined", name, itr.second));
+                    throw_key_error("Template '" + name + "' already defined", name, itr.second);
                 }
             }
 
@@ -707,7 +725,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                     package.features.emplace_back(feature);
                 }
             } else {
-                throw std::runtime_error("Invalid vcpkg package '" + package_str + "'");
+                throw_key_error("Invalid package name '" + package_str + "'", "packages", p);
             }
             vcpkg.packages.emplace_back(std::move(package));
         }

Original file line number	Diff line number	Diff line change
`@@ -32,14 +32,14 @@ static MsvcRuntimeType parse_msvcRuntimeType(const std::string &name) {`
`32`	`32`
`33`	`33`	`using TomlBasicValue = toml::basic_value<toml::discard_comments, tsl::ordered_map, std::vector>;`
`34`	`34`
`35`		`-static std::string format_key_error(const std::string &error, const toml::key &ky, const TomlBasicValue &value) {`
	`35`	`+static std::string format_key_message(const std::string &message, const toml::key &ky, const TomlBasicValue &value) {`
`36`	`36`	`auto loc = value.location();`
`37`	`37`	`auto line_number_str = std::to_string(loc.line());`
`38`	`38`	`auto line_width = line_number_str.length();`
`39`	`39`	`auto line_str = loc.line_str();`
`40`	`40`
`41`	`41`	`std::ostringstream oss;`
`42`		`- oss << "[error] " << error << '\n';`
	`42`	`+ oss << message << "\n";`
`43`	`43`	`oss << " --> " << loc.file_name() << ':' << loc.line() << '\n';`
`44`	`44`
`45`	`45`	`oss << std::string(line_width + 2, ' ') << "\|\n";`
`@@ -57,6 +57,14 @@ static std::string format_key_error(const std::string &error, const toml::key &k`
`57`	`57`	`return oss.str();`
`58`	`58`	`}`
`59`	`59`
	`60`	`+static void throw_key_error(const std::string &error, const toml::key &ky, const TomlBasicValue &value) {`
	`61`	`+ throw std::runtime_error(format_key_message("[error] " + error, ky, value));`
	`62`	`+}`
	`63`	`+`
	`64`	`+static void print_key_warning(const std::string &message, const toml::key &ky, const TomlBasicValue &value) {`
	`65`	`+ puts(format_key_message("[warning] " + message, ky, value).c_str());`
	`66`	`+}`
	`67`	`+`
`60`	`68`	`class TomlChecker {`
`61`	`69`	`const TomlBasicValue &m_v;`
`62`	`70`	`tsl::ordered_set<toml::key> m_visited;`
`@@ -133,27 +141,27 @@ class TomlChecker {`
`133`	`141`	`const auto &ky = itr.first;`
`134`	`142`	`if (m_conditionVisited.contains(ky)) {`
`135`	`143`	`if (!conditions.contains(ky)) {`
`136`		`- throw std::runtime_error(format_key_error("Unknown condition '" + ky + "'", ky, itr.second));`
	`144`	`+ throw_key_error("Unknown condition '" + ky + "'", ky, itr.second);`
`137`	`145`	`}`
`138`	`146`
`139`	`147`	`for (const auto &jtr : itr.second.as_table()) {`
`140`	`148`	`if (!m_visited.contains(jtr.first)) {`
`141`		`- throw std::runtime_error(format_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second));`
	`149`	`+ throw_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second);`
`142`	`150`	`}`
`143`	`151`	`}`
`144`	`152`	`} else if (!m_visited.contains(ky)) {`
`145`	`153`	`if (itr.second.is_table()) {`
`146`	`154`	`for (const auto &jtr : itr.second.as_table()) {`
`147`	`155`	`if (!m_visited.contains(jtr.first)) {`
`148`		`- throw std::runtime_error(format_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second));`
	`156`	`+ throw_key_error("Unknown key '" + jtr.first + "'", jtr.first, jtr.second);`
`149`	`157`	`}`
`150`	`158`	`}`
`151`	`159`	`}`
`152`		`- throw std::runtime_error(format_key_error("Unknown key '" + ky + "'", ky, itr.second));`
	`160`	`+ throw_key_error("Unknown key '" + ky + "'", ky, itr.second);`
`153`	`161`	`} else if (ky == "condition") {`
`154`	`162`	`std::string condition = itr.second.as_string();`
`155`	`163`	`if (!conditions.contains(condition)) {`
`156`		`- throw std::runtime_error(format_key_error("Unknown condition '" + condition + "'", condition, itr.second));`
	`164`	`+ throw_key_error("Unknown condition '" + condition + "'", condition, itr.second);`
`157`	`165`	`}`
`158`	`166`	`}`
`159`	`167`	`}`
`@@ -191,7 +199,7 @@ class TomlCheckerRoot {`
`191`	`199`	`if (check_root) {`
`192`	`200`	`for (const auto &itr : m_root.as_table()) {`
`193`	`201`	`if (!m_visisted.contains(itr.first)) {`
`194`		`- throw std::runtime_error(format_key_error("Unknown key '" + itr.first + "'", itr.first, itr.second));`
	`202`	`+ throw_key_error("Unknown key '" + itr.first + "'", itr.first, itr.second);`
`195`	`203`	`}`
`196`	`204`	`}`
`197`	`205`	`}`
`@@ -219,7 +227,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`219`	`227`	`cmake.required("version", cmake_version);`
`220`	`228`
`221`	`229`	`if (cmake.contains("bin-dir")) {`
`222`		`- throw std::runtime_error("bin-dir has been renamed to build-dir");`
	`230`	`+ throw_key_error("bin-dir has been renamed to build-dir", "bin-dir", cmake.find("bin-dir"));`
`223`	`231`	`}`
`224`	`232`
`225`	`233`	`cmake.optional("build-dir", build_dir);`
`@@ -297,7 +305,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`297`	`305`	`error += " - " + type_name + "\n";`
`298`	`306`	`}`
`299`	`307`	`error.pop_back(); // Remove last newline`
`300`		`- throw std::runtime_error(format_key_error(error, msvc_runtime, project.find("msvc-runtime")));`
	`308`	`+ throw_key_error(error, msvc_runtime, project.find("msvc-runtime"));`
`301`	`309`	`}`
`302`	`310`	`}`
`303`	`311`	`}`
`@@ -319,11 +327,21 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`319`	`327`	`}`
`320`	`328`	`}`
`321`	`329`
`322`		`- if (checker.contains("settings")) {`
	`330`	`+ if (checker.contains("variables")) {`
`323`	`331`	`using set_map = tsl::ordered_map<std::string, TomlBasicValue>;`
`324`		`- const auto &sets = toml::find<set_map>(toml, "settings");`
`325`		`- for (const auto &itr : sets) {`
`326`		`- Setting s;`
	`332`	`+ auto vars = toml::find<set_map>(toml, "variables");`
	`333`	`+ if (checker.contains("settings")) {`
	`334`	`+ print_key_warning("[settings] has been renamed to [variables]", "settings", toml.at("settings"));`
	`335`	`+ const auto &sets = toml::find<set_map>(toml, "settings");`
	`336`	`+ for (const auto &itr : sets) {`
	`337`	`+ if (!vars.insert(itr).second) {`
	`338`	`+ throw_key_error("Key '" + itr.first + "' shadows existing variable", itr.first, itr.second);`
	`339`	`+ }`
	`340`	`+ }`
	`341`	`+ }`
	`342`	`+`
	`343`	`+ for (const auto &itr : vars) {`
	`344`	`+ Variable s;`
`327`	`345`	`s.name = itr.first;`
`328`	`346`	`const auto &value = itr.second;`
`329`	`347`	`if (value.is_boolean()) {`
`@@ -344,7 +362,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`344`	`362`	`setting.optional("cache", s.cache);`
`345`	`363`	`setting.optional("force", s.force);`
`346`	`364`	`}`
`347`		`- settings.push_back(s);`
	`365`	`+ variables.push_back(s);`
`348`	`366`	`}`
`349`	`367`	`}`
`350`	`368`
`@@ -454,7 +472,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`454`	`472`	`} else if (is_cmake_arg(key)) {`
`455`	`473`	`// allow passthrough of ExternalProject options`
`456`	`474`	`} else if (!c.visisted(key)) {`
`457`		`- throw std::runtime_error(format_key_error("Unknown key '" + argItr.first + "'", argItr.first, argItr.second));`
	`475`	`+ throw_key_error("Unknown key '" + argItr.first + "'", argItr.first, argItr.second);`
`458`	`476`	`}`
`459`	`477`
`460`	`478`	`// Make sure not to emit keys like "condition" in the FetchContent call`
`@@ -469,7 +487,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`469`	`487`	`}`
`470`	`488`
`471`	`489`	`if (checker.contains("bin")) {`
`472`		`- throw std::runtime_error("[[bin]] has been renamed to [[target]]");`
	`490`	`+ throw_key_error("[[bin]] has been renamed to [target.<name>]", "", toml.at("bin"));`
`473`	`491`	`}`
`474`	`492`
`475`	`493`	`auto parse_target = [&](const std::string &name, TomlChecker &t, bool isTemplate) {`
`@@ -508,7 +526,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`508`	`526`	`}`
`509`	`527`	`}`
`510`	`528`	`error.pop_back(); // Remove last newline`
`511`		`- throw std::runtime_error(format_key_error(error, target.type_name, t.find("type")));`
	`529`	`+ throw_key_error(error, target.type_name, t.find("type"));`
`512`	`530`	`}`
`513`	`531`
`514`	`532`	`t.optional("sources", target.sources);`
`@@ -570,7 +588,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`570`	`588`	`} else {`
`571`	`589`	`report = &t.find(condItr.first).as_table().find("msvc-runtime").value();`
`572`	`590`	`}`
`573`		`- throw std::runtime_error(format_key_error(error, condItr.second, *report));`
	`591`	`+ throw_key_error(error, condItr.second, *report);`
`574`	`592`	`}`
`575`	`593`	`}`
`576`	`594`	`}`
`@@ -626,13 +644,13 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`626`	`644`
`627`	`645`	`for (const auto &type_name : targetTypeNames) {`
`628`	`646`	`if (name == type_name) {`
`629`		`- throw std::runtime_error(format_key_error("Reserved template name '" + name + "'", name, itr.second));`
	`647`	`+ throw_key_error("Reserved template name '" + name + "'", name, itr.second);`
`630`	`648`	`}`
`631`	`649`	`}`
`632`	`650`
`633`	`651`	`for (const auto &tmplate : templates) {`
`634`	`652`	`if (name == tmplate.outline.name) {`
`635`		`- throw std::runtime_error(format_key_error("Template '" + name + "' already defined", name, itr.second));`
	`653`	`+ throw_key_error("Template '" + name + "' already defined", name, itr.second);`
`636`	`654`	`}`
`637`	`655`	`}`
`638`	`656`
`@@ -707,7 +725,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p`
`707`	`725`	`package.features.emplace_back(feature);`
`708`	`726`	`}`
`709`	`727`	`} else {`
`710`		`- throw std::runtime_error("Invalid vcpkg package '" + package_str + "'");`
	`728`	`+ throw_key_error("Invalid package name '" + package_str + "'", "packages", p);`
`711`	`729`	`}`
`712`	`730`	`vcpkg.packages.emplace_back(std::move(package));`
`713`	`731`	`}`