Automatically generate cmkr.cmake when missing

.github/workflows/build.yml

@@ -17,6 +17,10 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v2
 
+    - name: Tag cmkr.cmake
+      if: ${{ startsWith(github.ref, 'refs/tags/') }}
+      run: cmake -P "cmake/replace_tag.cmake"
+
     - name: Build
       run: |
         cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
@@ -26,7 +30,7 @@ jobs:
     - name: Check if cmkr was run
       run: |
         ./install/bin/cmkr gen
-        git diff --exit-code
+        git diff --exit-code -- . ":(exclude)cmake/cmkr.cmake"
 
     - name: Test
       run: |
@@ -53,7 +57,7 @@ jobs:
 
     - name: Release
       uses: softprops/action-gh-release@v1
-      if: ${{ startsWith(github.ref, 'refs/tags/') && (matrix.os == 'windows-2019' || matrix.os == 'macos-10.15' || matrix.os == 'ubuntu-16.04') }}
+      if: ${{ startsWith(github.ref, 'refs/tags/') }}
       with:
         prerelease: ${{ !startsWith(github.ref, 'refs/tags/v') || contains(github.ref, '-pre') }}
         files: ${{ github.event.repository.name }}-${{ steps.osname.outputs.lowercase }}.zip

CMakeLists.txt

@@ -12,12 +12,6 @@ set(CMKR_ROOT_PROJECT OFF)
 if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
 	set(CMKR_ROOT_PROJECT ON)
 
-	# Bootstrap cmkr
-	include(cmkr.cmake OPTIONAL RESULT_VARIABLE CMKR_INCLUDE_RESULT)
-	if(CMKR_INCLUDE_RESULT)
-		cmkr()
-	endif()
-
 	# Enable folder support
 	set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 endif()
@@ -37,6 +31,7 @@ project(cmkr
 )
 
 include("cmake/generate_documentation.cmake")
+include("cmake/generate_resources.cmake")
 
 # third_party
 set(CMKR_CMAKE_FOLDER ${CMAKE_FOLDER})
@@ -97,6 +92,7 @@ list(APPEND cmkr_SOURCES
 	"include/help.hpp"
 	"include/literals.hpp"
 	"include/project_parser.hpp"
+	"cmake/cmkr.cmake"
 )
 
 list(APPEND cmkr_SOURCES
@@ -133,6 +129,8 @@ target_link_libraries(cmkr PRIVATE
 	nlohmann_json
 )
 
+generate_resources(${CMKR_TARGET})
+
 unset(CMKR_TARGET)
 unset(CMKR_SOURCES)
 

cmake.toml

@@ -1,5 +1,6 @@
 [cmake]
 version = "2.8...3.8"
+cmkr-include = false
 
 [project]
 name = "cmkr"
@@ -7,7 +8,10 @@ version = "0.1.4"
 description = "CMakeLists generator from TOML"
 languages = ["CXX"]
 subdirs = ["third_party", "tests"]
-include-after = ["cmake/generate_documentation.cmake"]
+include-after = [
+    "cmake/generate_documentation.cmake",
+    "cmake/generate_resources.cmake"
+]
 
 [target.cmkr_generate_documentation]
 type = "interface"
@@ -17,10 +21,25 @@ generate_documentation()
 
 [target.cmkr]
 type = "executable"
-sources = ["src/*.cpp", "include/*.hpp"]
+sources = [
-include-directories = ["include"]
+    "src/*.cpp",
+    "include/*.hpp",
+    "cmake/cmkr.cmake",
+]
+include-directories = [
+    "include",
+]
 compile-features = ["cxx_std_11"]
-link-libraries = ["toml11", "ghc_filesystem", "mpark_variant", "ordered_map", "nlohmann_json"]
+link-libraries = [
+    "toml11",
+    "ghc_filesystem",
+    "mpark_variant",
+    "ordered_map",
+    "nlohmann_json"
+]
+cmake-after = """
+generate_resources(${CMKR_TARGET})
+"""
 
 [[install]]
 targets = ["cmkr"]

cmake/CMakeLists.txt

@@ -1,44 +0,0 @@
-# This file was generated automatically by cmkr.
-
-cmake_minimum_required(VERSION 3.15)
-
-# Regenerate CMakeLists.txt automatically in the root project
-set(CMKR_ROOT_PROJECT OFF)
-if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-	set(CMKR_ROOT_PROJECT ON)
-
-	# Bootstrap cmkr
-	include(cmkr.cmake OPTIONAL RESULT_VARIABLE CMKR_INCLUDE_RESULT)
-	if(CMKR_INCLUDE_RESULT)
-		cmkr()
-	endif()
-
-	# Enable folder support
-	set_property(GLOBAL PROPERTY USE_FOLDERS ON)
-endif()
-
-# Create a configure-time dependency on cmake.toml to improve IDE support
-if(CMKR_ROOT_PROJECT)
-	configure_file(cmake.toml cmake.toml COPYONLY)
-endif()
-
-project(example
-	VERSION
-		0.1.0
-)
-
-# Target example
-set(example_SOURCES
-	"src/example.cpp"
-	cmake.toml
-)
-
-add_executable(example ${example_SOURCES})
-
-get_directory_property(CMKR_VS_STARTUP_PROJECT DIRECTORY ${PROJECT_SOURCE_DIR} DEFINITION VS_STARTUP_PROJECT)
-if(NOT CMKR_VS_STARTUP_PROJECT)
-	set_property(DIRECTORY ${PROJECT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT example)
-endif()
-
-source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${example_SOURCES})
-

cmake/cmake.toml

@@ -1,12 +0,0 @@
-# This is a minimal example project used for testing the cmkr bootstrapping process
-
-[cmake]
-version = "3.15"
-
-[project]
-name = "example"
-version = "0.1.0"
-
-[target.example]
-type = "executable"
-sources = ["src/example.cpp"]

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 "archive_a718dfd6" CACHE STRING "cmkr git tag (this needs to be available forever)" FORCE)
+set(CMKR_TAG "archive_9e1fa5dc" CACHE STRING "cmkr git tag (this needs to be available forever)" FORCE)
 
 # Set these from the command line to customize for development/debugging purposes
 set(CMKR_EXECUTABLE "" CACHE FILEPATH "cmkr executable")

cmake/generate_resources.cmake

@@ -0,0 +1,21 @@
+# Enumerates the target sources and automatically generates include/resources/${RESOURCE_NAME}.h from all .cmake files
+function(generate_resources target)
+    get_property(TARGET_SOURCES
+        TARGET ${target}
+        PROPERTY SOURCES
+    )
+    foreach(SOURCE ${TARGET_SOURCES})
+        if(SOURCE MATCHES ".cmake$")
+            get_filename_component(RESOURCE_NAME "${SOURCE}" NAME_WE)
+            set(RESOURCE_HEADER "include/resources/${RESOURCE_NAME}.h")
+            configure_file("${SOURCE}" "${CMAKE_CURRENT_BINARY_DIR}/${RESOURCE_HEADER}")
+            file(READ "${CMAKE_CURRENT_BINARY_DIR}/${RESOURCE_HEADER}" RESOURCE_CONTENTS)
+            file(GENERATE
+                OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${RESOURCE_HEADER}"
+                CONTENT "namespace cmkr {\nnamespace resources {\nstatic const char* ${RESOURCE_NAME} = R\"RESOURCE(${RESOURCE_CONTENTS})RESOURCE\";\n}\n}"
+            )
+            message(STATUS "[cmkr] Generated ${RESOURCE_HEADER}")
+        endif()
+    endforeach()
+    target_include_directories(${target} PUBLIC "${CMAKE_CURRENT_BINARY_DIR}/include")
+endfunction()

cmake/replace_tag.cmake

@@ -0,0 +1,27 @@
+cmake_minimum_required(VERSION 3.20)
+
+find_package(Git REQUIRED)
+
+execute_process(COMMAND
+    "${GIT_EXECUTABLE}" name-rev --tags --name-only HEAD
+    OUTPUT_VARIABLE GIT_TAG
+)
+
+string(FIND "${GIT_TAG}" "\n" NEWLINE_POS)
+string(SUBSTRING "${GIT_TAG}" 0 ${NEWLINE_POS} GIT_TAG)
+string(STRIP "${GIT_TAG}" GIT_TAG)
+
+if("${GIT_TAG}" STREQUAL "")
+    message(FATAL_ERROR "Failed to retrieve git tag!")
+endif()
+
+message(STATUS "CMKR_TAG: '${GIT_TAG}'")
+
+file(READ "cmake/cmkr.cmake" CMKR_CMAKE)
+string(REGEX REPLACE "CMKR_TAG \"[^\"]+\"" "CMKR_TAG \"${GIT_TAG}\"" CMKR_CMAKE "${CMKR_CMAKE}")
+file(CONFIGURE
+    OUTPUT "cmake/cmkr.cmake"
+    CONTENT "${CMKR_CMAKE}"
+    @ONLY
+    NEWLINE_STYLE LF
+)

cmake/src/example.cpp

@@ -1,6 +0,0 @@
-#include <cstdio>
-
-int main()
-{
-    puts("Hello from cmkr!");
-}

src/build.cpp

@@ -25,7 +25,7 @@ int run(int argc, char **argv) {
     if (gen::generate_cmake(fs::current_path().string().c_str()))
         throw std::runtime_error("CMake generation failure!");
 
-    ss << "cmake -S. -B" << project.build_dir << " ";
+    ss << "cmake -S. -DCMKR_SKIP_GENERATION=ON -B" << project.build_dir << " ";
 
     if (!project.generator.empty()) {
         ss << "-G \"" << project.generator << "\" ";

src/cmake_generator.cpp

@@ -1,6 +1,7 @@
 #include "cmake_generator.hpp"
 #include "error.hpp"
 #include "literals.hpp"
+#include <resources/cmkr.h>
 
 #include "fs.hpp"
 #include <cassert>
@@ -478,16 +479,28 @@ int generate_cmake(const char *path, const parser::Project *parent_project) {
         cmd("if")("CMAKE_CURRENT_SOURCE_DIR", "STREQUAL", "CMAKE_SOURCE_DIR");
             cmd("set")("CMKR_ROOT_PROJECT", "ON").endl();
 
+            if (!project.cmkr_include.empty()) {
                 comment("Bootstrap cmkr");
                 cmd("include")(project.cmkr_include, "OPTIONAL", "RESULT_VARIABLE", "CMKR_INCLUDE_RESULT");
                 cmd("if")("CMKR_INCLUDE_RESULT");
                     cmd("cmkr")();
                 cmd("endif")().endl();
+            }
 
             comment("Enable folder support");
             cmd("set_property")("GLOBAL", "PROPERTY", "USE_FOLDERS", "ON");
         cmd("endif")().endl();
         // clang-format on
+
+        fs::path cmkr_include(project.cmkr_include);
+        if (!project.cmkr_include.empty() && !fs::exists(cmkr_include) && cmkr_include.is_relative()) {
+            fs::create_directories(cmkr_include.parent_path());
+            std::ofstream ofs(cmkr_include.string(), std::ios::binary);
+            if (!ofs) {
+                throw std::runtime_error("Failed to create " + project.cmkr_include);
+            }
+            ofs.write(resources::cmkr, strlen(resources::cmkr));
+        }
     }
 
     // clang-format off

src/project_parser.cpp

@@ -85,7 +85,15 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         if (toml.contains("cmake")) {
             const auto &cmake = toml::find(toml, "cmake");
             cmake_version = toml::find(cmake, "version").as_string();
-            get_optional(cmake, "cmkr-include", cmkr_include);
+            if (cmake.contains("cmkr-include")) {
+                const auto &cmkr_include_kv = toml::find(cmake, "cmkr-include");
+                if (cmkr_include_kv.is_string()) {
+                    cmkr_include = cmkr_include_kv.as_string();
+                } else {
+                    // Allow disabling this feature with cmkr-include = false
+                    cmkr_include = "";
+                }
+            }
             get_optional(cmake, "cpp-flags", cppflags);
             get_optional(cmake, "c-flags", cflags);
             get_optional(cmake, "link-flags", linkflags);

tests/.gitignore

@@ -1,2 +1,3 @@
 # These will be generated by cmkr, so no point in tracking them
 **/CMakeLists.txt
+**/cmkr.cmake