Bump to 0.2.37

Allow disabling default features with vcpkg

.github/workflows/lint.yml

@@ -4,6 +4,8 @@ on: [push, pull_request]
 
 jobs:
   clang-format:
+    # Skip building pull requests from the same repository
+    if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) }}
     runs-on: ubuntu-latest
 
     steps:
@@ -12,7 +14,7 @@ jobs:
 
       - name: clang-format
         id: clang-format
-        uses: DoozyX/clang-format-lint-action@c3b2c943e924028b93a707a5b1b017976ab8d50c # v0.15
+        uses: DoozyX/clang-format-lint-action@c71d0bf4e21876ebec3e5647491186f8797fde31 # v0.18.2
         with:
           exclude: './third_party'
           extensions: 'c,h,cpp,hpp'
@@ -27,6 +29,8 @@ jobs:
           exit 1
 
   editorconfig:
+    # Skip building pull requests from the same repository
+    if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) }}
     runs-on: ubuntu-latest
 
     steps:

CMakeLists.txt

@@ -22,7 +22,7 @@ project(cmkr
 	LANGUAGES
 		CXX
 	VERSION
-		0.2.30
+		0.2.37
 	DESCRIPTION
 		"CMakeLists generator from TOML"
 )
@@ -94,7 +94,6 @@ target_link_libraries(cmkr PRIVATE
 	ghc_filesystem
 	mpark_variant
 	ordered_map
-	nlohmann_json
 )
 
 get_directory_property(CMKR_VS_STARTUP_PROJECT DIRECTORY ${PROJECT_SOURCE_DIR} DEFINITION VS_STARTUP_PROJECT)
@@ -103,7 +102,7 @@ if(NOT CMKR_VS_STARTUP_PROJECT)
 endif()
 
 set(CMKR_TARGET cmkr)
-generate_resources(${CMKR_TARGET})
+include("cmake/custom_targets.cmake")
 
 install(
 	TARGETS

cmake.toml

@@ -4,7 +4,7 @@ cmkr-include = false
 
 [project]
 name = "cmkr"
-version = "0.2.30"
+version = "0.2.37"
 description = "CMakeLists generator from TOML"
 languages = ["CXX"]
 include-after = [
@@ -36,11 +36,8 @@ link-libraries = [
     "ghc_filesystem",
     "mpark_variant",
     "ordered_map",
-    "nlohmann_json",
 ]
-cmake-after = """
-generate_resources(${CMKR_TARGET})
-"""
+include-after = ["cmake/custom_targets.cmake"]
 
 [[install]]
 targets = ["cmkr"]

cmake/cmkr.cmake

@@ -2,7 +2,7 @@ include_guard()
 
 # Change these defaults to point to your infrastructure if desired
 set(CMKR_REPO "https://github.com/build-cpp/cmkr" CACHE STRING "cmkr git repository" FORCE)
-set(CMKR_TAG "v0.2.30" CACHE STRING "cmkr git tag (this needs to be available forever)" FORCE)
+set(CMKR_TAG "v0.2.37" CACHE STRING "cmkr git tag (this needs to be available forever)" FORCE)
 set(CMKR_COMMIT_HASH "" CACHE STRING "cmkr git commit hash (optional)" FORCE)
 
 # To bootstrap/generate a cmkr project: cmake -P cmkr.cmake

cmake/custom_targets.cmake

@@ -0,0 +1,18 @@
+generate_resources(cmkr)
+
+add_custom_target(regenerate-cmake
+        COMMAND "$<TARGET_FILE:cmkr>" gen
+        WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
+)
+
+if(CMAKE_CONFIGURATION_TYPES)
+    add_custom_target(run-tests
+            COMMAND "${CMAKE_CTEST_COMMAND}" -C $<CONFIG>
+            WORKING_DIRECTORY "${PROJECT_BINARY_DIR}/tests"
+    )
+else()
+    add_custom_target(run-tests
+            COMMAND "${CMAKE_CTEST_COMMAND}"
+            WORKING_DIRECTORY "${PROJECT_BINARY_DIR}/tests"
+    )
+endif()

docs/cmake-toml.md

@@ -109,6 +109,13 @@ clang-any = "CMAKE_CXX_COMPILER_ID MATCHES \"Clang\" OR CMAKE_C_COMPILER_ID MATC
 root = "CMKR_ROOT_PROJECT"
 x64 = "CMAKE_SIZEOF_VOID_P EQUAL 8"
 x32 = "CMAKE_SIZEOF_VOID_P EQUAL 4"
+android = "ANDROID"
+apple = "APPLE"
+bsd = "BSD"
+cygwin = "CYGWIN"
+ios = "IOS"
+xcode = "XCODE"
+wince = "WINCE"
 ```
 
 ## Subdirectories
@@ -156,11 +163,14 @@ Variables emit a [`set`](https://cmake.org/cmake/help/latest/command/set.html) a
 version = "2024.03.25"
 url = "https://github.com/microsoft/vcpkg/archive/refs/tags/2024.03.25.tar.gz"
 packages = ["fmt", "zlib"]
+overlay-ports = ["my-ports"]
 ```
 
 The vcpkg `version` will automatically generate the `url` from the [official repository](https://github.com/microsoft/vcpkg/releases). For a custom registry you can specify your own `url` (and omit the `version`). You can browse available packages on [vcpkg.io](https://vcpkg.io/en/packages.html).
 
-To specify package features you can use the following syntax: `imgui[docking-experimental,freetype,sdl2-binding,opengl3-binding]`.
+To specify package features you can use the following syntax: `imgui[docking-experimental,freetype,sdl2-binding,opengl3-binding]`. To disable the [default features](https://learn.microsoft.com/en-us/vcpkg/concepts/default-features) you can do: `cpp-httplib[core,openssl]`
+
+The `overlay-ports` feature allows you to embed vcpkg ports inside your project, without having to fork the main vcpkg registry or creating a custom registry. You can find more information in the relevant [documentation](https://learn.microsoft.com/en-us/vcpkg/concepts/overlay-ports).
 
 ## Packages
 

include/project_parser.hpp

@@ -45,9 +45,11 @@ struct Vcpkg {
     struct Package {
         std::string name;
         std::vector<std::string> features;
+        bool default_features = true;
     };
 
     std::vector<Package> packages;
+    std::vector<std::string> overlay_ports;
 
     bool enabled() const {
         return !packages.empty();
@@ -155,7 +157,7 @@ struct Content {
     Condition<std::string> cmake_after;
     ConditionVector include_before;
     ConditionVector include_after;
-    bool system;
+    bool system = false;
     std::string subdir;
 };
 

src/cmake_generator.cpp

@@ -577,7 +577,7 @@ struct Generator {
             }
             cmd("if", "NOTE: unnamed condition")(RawArg(cmake_condition(condition)));
         } else {
-            cmd("if", condition)(RawArg(found->second));
+            cmd("if", condition)(RawArg(cmake_condition(found->second)));
         }
         return true;
     }
@@ -681,7 +681,10 @@ static std::string vcpkg_escape_identifier(const std::string &name) {
             ch = '-';
         }
 
-        escaped += std::tolower(ch);
+        if (ch >= 'A' && ch <= 'Z') {
+            ch += ('a' - 'A');
+        }
+        escaped += ch;
     }
     if (!vcpkg_valid_identifier(escaped)) {
         throw std::runtime_error("The escaped project name '" + escaped + "' is not usable with [vcpkg]");
@@ -728,24 +731,6 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
     if (is_root_project) {
         cmd("cmake_minimum_required")("VERSION", project.cmake_version).endl();
 
-        if (project.project_msvc_runtime != parser::msvc_last) {
-            comment("Enable support for MSVC_RUNTIME_LIBRARY");
-            cmd("cmake_policy")("SET", "CMP0091", "NEW");
-
-            switch (project.project_msvc_runtime) {
-            case parser::msvc_dynamic:
-                cmd("set")("CMAKE_MSVC_RUNTIME_LIBRARY", "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL");
-                break;
-            case parser::msvc_static:
-                cmd("set")("CMAKE_MSVC_RUNTIME_LIBRARY", "MultiThreaded$<$<CONFIG:Debug>:Debug>");
-                break;
-            default:
-                break;
-            }
-            endl();
-        }
-
-        // clang-format on
         if (!project.allow_in_tree) {
             // clang-format off
             cmd("if")("CMAKE_SOURCE_DIR", "STREQUAL", "CMAKE_BINARY_DIR");
@@ -754,6 +739,11 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
             // clang-format on
         }
 
+        if (project.project_msvc_runtime != parser::msvc_last) {
+            comment("Enable support for MSVC_RUNTIME_LIBRARY");
+            cmd("cmake_policy")("SET", "CMP0091", "NEW").endl();
+        }
+
         cmd("set")("CMKR_ROOT_PROJECT", "OFF");
         // clang-format off
         cmd("if")("CMAKE_CURRENT_SOURCE_DIR", "STREQUAL", "CMAKE_SOURCE_DIR");
@@ -771,7 +761,26 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
             cmd("set_property")("GLOBAL", "PROPERTY", "USE_FOLDERS", "ON").endl();
 
             comment("Create a configure-time dependency on cmake.toml to improve IDE support");
-            cmd("configure_file")("cmake.toml", "cmake.toml", "COPYONLY");
+            if (project.cmake_minimum_version(3, 0)) {
+                cmd("set_property")("DIRECTORY", "APPEND", "PROPERTY", "CMAKE_CONFIGURE_DEPENDS", "cmake.toml");
+            } else {
+                cmd("configure_file")("cmake.toml", "cmake.toml", "COPYONLY");
+            }
+
+            if (project.project_msvc_runtime != parser::msvc_last) {
+                cmd("if")("NOT", "DEFINED", "CMAKE_MSVC_RUNTIME_LIBRARY");
+                switch (project.project_msvc_runtime) {
+                case parser::msvc_dynamic:
+                    cmd("set")("CMAKE_MSVC_RUNTIME_LIBRARY", "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL");
+                    break;
+                case parser::msvc_static:
+                    cmd("set")("CMAKE_MSVC_RUNTIME_LIBRARY", "MultiThreaded$<$<CONFIG:Debug>:Debug>");
+                    break;
+                default:
+                    break;
+                }
+                cmd("endif")().endl();
+            }
         cmd("endif")().endl();
         // clang-format on
 
@@ -780,12 +789,14 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
             create_file(cmkr_include, resources::cmkr);
         }
     } else {
-        // clang-format off
         comment("Create a configure-time dependency on cmake.toml to improve IDE support");
         cmd("if")("CMKR_ROOT_PROJECT");
+        if (project.cmake_minimum_version(3, 0)) {
+            cmd("set_property")("DIRECTORY", "APPEND", "PROPERTY", "CMAKE_CONFIGURE_DEPENDS", "cmake.toml");
+        } else {
             cmd("configure_file")("cmake.toml", "cmake.toml", "COPYONLY");
+        }
         cmd("endif")().endl();
-        // clang-format on
     }
 
     // TODO: remove support and replace with global compile-features
@@ -925,7 +936,7 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
         ofs << R"({
   "$cmkr": "This file is automatically generated from cmake.toml - DO NOT EDIT",
   "$cmkr-url": "https://github.com/build-cpp/cmkr",
-  "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg/master/scripts/vcpkg.schema.json",
+  "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json",
   "dependencies": [
 )";
 
@@ -946,17 +957,20 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
                     throw std::runtime_error("Invalid vcpkg package feature '" + feature + "', name is reserved");
                 }
             }
-            if (features.empty()) {
+            if (features.empty() && package.default_features) {
                 ofs << "    \"" << package.name << '\"';
             } else {
                 ofs << "    {\n";
                 ofs << "      \"name\": \"" << package.name << "\",\n";
+                if (!package.default_features) {
+                    ofs << "      \"default-features\": false,\n";
+                }
                 ofs << "      \"features\": [";
                 for (size_t j = 0; j < features.size(); j++) {
                     const auto &feature = features[j];
                     ofs << '\"' << feature << '\"';
                     if (j + 1 < features.size()) {
-                        ofs << ',';
+                        ofs << ", ";
                     }
                 }
                 ofs << "]\n";
@@ -982,7 +996,29 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
         ofs << "  ],\n";
         ofs << "  \"description\": \"" << escape(project.project_description) << "\",\n";
         ofs << "  \"name\": \"" << escape(vcpkg_escape_identifier(project.project_name)) << "\",\n";
-        ofs << R"(  "version-string": "")" << '\n';
+        ofs << "  \"version-string\": \"none\"";
+        const auto &overlay_ports = project.vcpkg.overlay_ports;
+        if (!overlay_ports.empty()) {
+            ofs << ",\n";
+            // Reference: https://learn.microsoft.com/en-us/vcpkg/reference/vcpkg-json#vcpkg-configuration
+            ofs << "  \"vcpkg-configuration\": {\n";
+            ofs << "    \"overlay-ports\": [\n";
+            for (size_t i = 0; i < overlay_ports.size(); i++) {
+                const auto &directory = overlay_ports[i];
+                if (!fs::is_directory(directory)) {
+                    throw std::runtime_error("[vcpkg].overlay-ports is not a directory: " + directory);
+                }
+                ofs << "      \"" << escape(directory) << "\"";
+                if (i > 0) {
+                    ofs << ",";
+                }
+                ofs << "\n";
+            }
+            ofs << "    ]\n";
+            ofs << "  }\n";
+        } else {
+            ofs << "\n";
+        }
         ofs << "}\n";
     }
 
@@ -1080,6 +1116,9 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
     if (project_languages.empty())
         project_languages = {"C", "CXX"};
 
+    // Reference: https://gitlab.kitware.com/cmake/cmake/-/issues/24340#note_1304703
+    project_languages.push_back("RC");
+
     // All acceptable extensions based off our given languages.
     tsl::ordered_set<std::string> project_extensions;
     for (const auto &language : project_languages) {

src/project_parser.cpp

@@ -274,6 +274,13 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
         conditions["root"] = R"cmake(CMKR_ROOT_PROJECT)cmake";
         conditions["x64"] = R"cmake(CMAKE_SIZEOF_VOID_P EQUAL 8)cmake";
         conditions["x32"] = R"cmake(CMAKE_SIZEOF_VOID_P EQUAL 4)cmake";
+        conditions["android"] = R"cmake(ANDROID)cmake";
+        conditions["apple"] = R"cmake(APPLE)cmake";
+        conditions["bsd"] = R"cmake(BSD)cmake";
+        conditions["cygwin"] = R"cmake(CYGWIN)cmake";
+        conditions["ios"] = R"cmake(IOS)cmake";
+        conditions["xcode"] = R"cmake(XCODE)cmake";
+        conditions["wince"] = R"cmake(WINCE)cmake";
     } else {
         conditions = parent->conditions;
         templates = parent->templates;
@@ -381,7 +388,8 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                 if (ch == '_') {
                     normalized += '-';
                 } else if (ch >= 'A' && ch <= 'Z') {
-                    normalized += std::tolower(ch);
+                    ch += ('a' - 'A');
+                    normalized += ch;
                 } else if (ch == '-' || (ch >= '0' && ch <= '9') || (ch >= 'a' && ch <= 'z')) {
                     normalized += ch;
                 } else {
@@ -431,6 +439,9 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
             }
             options.push_back(o);
 
+            // Add a condition matching the option name
+            conditions.emplace(o.name, o.name);
+
             // Add an implicit condition for the option
             auto ncondition = normalize(o.name);
             if (ncondition.find(nproject_prefix) == 0) {
@@ -532,10 +543,21 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                     key = "URL";
                 } else if (hash_algorithms.contains(key)) {
                     std::string algo;
-                    for (auto c : key) {
-                        algo.push_back(std::toupper(c));
+                    for (auto ch : key) {
+                        if (ch >= 'a' && ch <= 'z') {
+                            ch -= ('a' - 'A');
+                        }
+                        algo.push_back(ch);
                     }
                     key = "URL_HASH";
+                    if (value.empty()) {
+                        throw_key_error("Empty hash value", argItr.first, argItr.second);
+                    }
+                    for (char c : value) {
+                        if (!std::isxdigit(c)) {
+                            throw_key_error("Hash value must be a hex string", argItr.first, argItr.second);
+                        }
+                    }
                     value = algo + "=" + value;
                 } else if (key == "hash") {
                     key = "URL_HASH";
@@ -643,20 +665,16 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                         continue;
                     }
 
-                    // Skip paths that don't contain backwards or forwards slashes
-                    if (library_path.find_first_of(R"(\/)") == std::string::npos) {
-                        continue;
-                    }
-
-                    // Check if the new file path exists, otherwise emit an error
-                    const auto expected_library_file_path = fs::path{path} / library_path;
-                    if (!fs::exists(expected_library_file_path)) {
+                    if (fs::exists(fs::path(path) / library_path)) {
+                        // If the file path is relative, prepend ${CMAKE_CURRENT_SOURCE_DIR}
+                        library_path.insert(0, "${CMAKE_CURRENT_SOURCE_DIR}/");
+                    } else if (library_path.find_first_of(R"(\/)") != std::string::npos) {
+                        // Error if the path contains a directory separator and the file doesn't exist
                         throw std::runtime_error("Attempted to link against a library file that doesn't exist for target \"" + name + "\" in \"" +
                                                  key + "\": " + library_path);
+                    } else {
+                        // NOTE: We cannot check if system libraries exist, so we leave them as-is
                     }
-
-                    // Prepend ${CMAKE_CURRENT_SOURCE_DIR} to the path
-                    library_path.insert(0, "${CMAKE_CURRENT_SOURCE_DIR}/");
                 }
             }
         };
@@ -711,6 +729,8 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                         property_list += list_val.as_string();
                     }
                     target.properties[condition][k] = property_list;
+                } else if (v.is_integer()) {
+                    target.properties[condition][k] = std::to_string(v.as_integer());
                 } else if (v.is_boolean()) {
                     target.properties[condition][k] = v.as_boolean() ? "ON" : "OFF";
                 } else {
@@ -827,13 +847,20 @@ Project::Project(const Project *parent, const std::string &path, bool build) : p
                 std::istringstream feature_stream{features};
                 std::string feature;
                 while (std::getline(feature_stream, feature, ',')) {
-                    package.features.emplace_back(feature);
+                    // Disable default features with package-name[core,feature1]
+                    if (feature == "core") {
+                        package.default_features = false;
+                    } else {
+                        package.features.emplace_back(feature);
+                    }
                 }
             } else {
                 throw_key_error("Invalid package name '" + package_str + "'", "packages", p);
             }
             vcpkg.packages.emplace_back(std::move(package));
         }
+
+        v.optional("overlay-ports", vcpkg.overlay_ports);
     }
 
     checker.check(conditions, true);
@@ -866,9 +893,8 @@ bool Project::cmake_minimum_version(int major, int minor) const {
 }
 
 bool Project::is_condition_name(const std::string &name) {
-    auto is_named_condition = true;
     for (auto ch : name) {
-        if (!(ch == '-' || (ch >= '0' && ch <= '9') || (ch >= 'a' && ch <= 'z'))) {
+        if (!std::isalnum(ch) && ch != '-' && ch != '_') {
             return false;
         }
     }

third_party/CMakeLists.txt

@@ -16,7 +16,3 @@ target_include_directories(toml11 INTERFACE toml11-3.6.0)
 # https://github.com/mpark/variant (BSL-1.0)
 add_library(mpark_variant INTERFACE)
 target_include_directories(mpark_variant INTERFACE variant-1.4.0/include)
-
-# https://github.com/nlohmann/json (MIT)
-add_library(nlohmann_json INTERFACE)
-target_include_directories(nlohmann_json INTERFACE nlohmann-3.9.1/include)

third_party/nlohmann-3.9.1/LICENSE

@@ -1,21 +0,0 @@
-MIT License 
-
-Copyright (c) 2013-2021 Niels Lohmann
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.