mrexodia
/
cmkr
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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

Browse Source 
Rename `[settings]` to `[variables]`
main
Duncan Ogilvie 2 years ago committed by GitHub
parent 1d95fab0ce c0b98b3ef4
commit ad17890e23
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 57 additions and 29 deletions
Show Stats Download Patch File Download Diff File

13
docs/cmake-toml.md
Unescape View File

@ -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). 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 ## CMake configuration
@ -93,6 +94,16 @@ include-before = ["cmake/before-subdir.cmake"]
include-after = ["cmake/after-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 ## Vcpkg
```toml ```toml

4
include/project_parser.hpp
Unescape View File

@ -14,7 +14,7 @@ using Condition = tsl::ordered_map<std::string, T>;
using ConditionVector = Condition<std::vector<std::string>>; using ConditionVector = Condition<std::vector<std::string>>;
struct Setting { struct Variable {
std::string name; std::string name;
std::string comment; std::string comment;
mpark::variant<bool, std::string> val; mpark::variant<bool, std::string> val;
@ -185,7 +185,7 @@ struct Project {
Condition<std::string> cmake_after; Condition<std::string> cmake_after;
ConditionVector include_before; ConditionVector include_before;
ConditionVector include_after; ConditionVector include_after;
std::vector<Setting> settings; std::vector<Variable> variables;
std::vector<Option> options; std::vector<Option> options;
std::vector<Package> packages; std::vector<Package> packages;
Vcpkg vcpkg; Vcpkg vcpkg;

7
src/cmake_generator.cpp
Unescape View File

@ -621,10 +621,9 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
endl(); endl();
} }
// TODO: rename to 'variables'? if (!project.variables.empty()) {
if (!project.settings.empty()) { comment("Variables");
comment("Settings"); for (const auto &set : project.variables) {
for (const auto &set : project.settings) {
std::string set_val; std::string set_val;
if (set.val.index() == 1) { if (set.val.index() == 1) {
set_val = mpark::get<1>(set.val); set_val = mpark::get<1>(set.val);

58
src/project_parser.cpp
Unescape View File

@ -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>; 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 loc = value.location();
auto line_number_str = std::to_string(loc.line()); auto line_number_str = std::to_string(loc.line());
auto line_width = line_number_str.length(); auto line_width = line_number_str.length();
auto line_str = loc.line_str(); auto line_str = loc.line_str();
std::ostringstream oss; std::ostringstream oss;
oss << "[error] " << error << '\n'; oss << message << "\n";
oss << " --> " << loc.file_name() << ':' << loc.line() << '\n'; oss << " --> " << loc.file_name() << ':' << loc.line() << '\n';
oss << std::string(line_width + 2, ' ') << "|\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(); 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 { class TomlChecker {
const TomlBasicValue &m_v; const TomlBasicValue &m_v;
tsl::ordered_set<toml::key> m_visited; tsl::ordered_set<toml::key> m_visited;
@ -133,27 +141,27 @@ class TomlChecker {
const auto &ky = itr.first; const auto &ky = itr.first;
if (m_conditionVisited.contains(ky)) { if (m_conditionVisited.contains(ky)) {
if (!conditions.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()) { for (const auto &jtr : itr.second.as_table()) {
if (!m_visited.contains(jtr.first)) { 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)) { } else if (!m_visited.contains(ky)) {
if (itr.second.is_table()) { if (itr.second.is_table()) {
for (const auto &jtr : itr.second.as_table()) { for (const auto &jtr : itr.second.as_table()) {
if (!m_visited.contains(jtr.first)) { 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") { } else if (ky == "condition") {
std::string condition = itr.second.as_string(); std::string condition = itr.second.as_string();
if (!conditions.contains(condition)) { 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) { if (check_root) {
for (const auto &itr : m_root.as_table()) { for (const auto &itr : m_root.as_table()) {
if (!m_visisted.contains(itr.first)) { 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); cmake.required("version", cmake_version);
if (cmake.contains("bin-dir")) { 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); 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 += " - " + type_name + "\n";
} }
error.pop_back(); // Remove last newline 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>; using set_map = tsl::ordered_map<std::string, TomlBasicValue>;
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"); const auto &sets = toml::find<set_map>(toml, "settings");
for (const auto &itr : sets) { for (const auto &itr : sets) {
Setting s; 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; s.name = itr.first;
const auto &value = itr.second; const auto &value = itr.second;
if (value.is_boolean()) { 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("cache", s.cache);
setting.optional("force", s.force); 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)) { } else if (is_cmake_arg(key)) {
// allow passthrough of ExternalProject options // allow passthrough of ExternalProject options
} else if (!c.visisted(key)) { } 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 // 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")) { 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) { 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 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); t.optional("sources", target.sources);
@ -570,7 +588,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
} else { } else {
report = &t.find(condItr.first).as_table().find("msvc-runtime").value(); 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) { for (const auto &type_name : targetTypeNames) {
if (name == type_name) { 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) { for (const auto &tmplate : templates) {
if (name == tmplate.outline.name) { 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); package.features.emplace_back(feature);
} }
} else { } 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)); vcpkg.packages.emplace_back(std::move(package));
} }

Write Preview
Loading…
Cancel
Save