Merge pull request #6 from MoAlyousef/develop

Ongoing development

Author: MoAlyousef

.clang-format

@@ -42,7 +42,7 @@ BreakBeforeTernaryOperators: true
 BreakConstructorInitializersBeforeComma: false
 BreakConstructorInitializers: BeforeColon
 BreakStringLiterals: true
-ColumnLimit:     100
+ColumnLimit:     150
 CommentPragmas:  '^ IWYU pragma:'
 CompactNamespaces: false
 ConstructorInitializerAllOnOneLineOrOnePerLine: false

.github/workflows/build.yml

@@ -2,18 +2,23 @@ name: CMake
 
 on: [push, pull_request]
 
-env:
-  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
-  BUILD_TYPE: Release
-
 jobs:
   build:
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
-        os: [windows-latest, macos-10.15, ubuntu-18.04]
-
+        os: [windows-2016, windows-2019, macos-10.15, ubuntu-16.04, ubuntu-18.04, ubuntu-20.04]
+    env:
+      BUILD_TYPE: Release
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/checkout@v2
     - name: Build
-      run: cmake -S. -Bbin -DCMAKE_BUILD_TYPE=$BUILD_TYPE && cmake --build bin --parallel --config $BUILD_TYPE
+      run: |
+        cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
+        cmake --build build --config ${{ env.BUILD_TYPE }} --parallel
+    - name: Test
+      run: |
+        cd build/tests
+        ctest -C ${{ env.BUILD_TYPE }}

.gitignore

@@ -5,4 +5,7 @@ compile_commands.json
 temp.*
 .vs
 .cache
-build*/
+build*/
+.idea/
+cmake-build*/
+CMakeLists.txt.user

CMakeLists.txt

@@ -1,87 +1,125 @@
 # This file was generated automatically by cmkr.
 
-# Regenerate CMakeLists.txt file when necessary
-include(cmkr.cmake OPTIONAL RESULT_VARIABLE CMKR_INCLUDE_RESULT)
+cmake_minimum_required(VERSION 2.8...3.8)
 
-if(CMKR_INCLUDE_RESULT)
-	cmkr()
-endif()
-
-cmake_minimum_required(VERSION 3.15)
-
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
-
-project(cmkr
-	VERSION 0.1.4
-	LANGUAGES C CXX
-	DESCRIPTION "CMakeLists generator from TOML"
-	)
-
-include(FetchContent)
-
-FetchContent_Declare(
-	filesystem
-	GIT_REPOSITORY https://github.com/gulrak/filesystem
-	GIT_SHALLOW ON
-	)
+# 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)
 
-FetchContent_MakeAvailable(filesystem)
+	# Bootstrap cmkr
+	include(cmkr.cmake OPTIONAL RESULT_VARIABLE CMKR_INCLUDE_RESULT)
+	if(CMKR_INCLUDE_RESULT)
+		cmkr()
+	endif()
 
-FetchContent_Declare(
-	mpark_variant
-	URL https://github.com/mpark/variant/archive/v1.4.0.tar.gz
-	)
+	# Enable folder support
+	set_property(GLOBAL PROPERTY USE_FOLDERS ON)
+endif()
 
-FetchContent_MakeAvailable(mpark_variant)
+# Create a configure-time dependency on cmake.toml to improve IDE support
+if(CMKR_ROOT_PROJECT)
+	configure_file(cmake.toml cmake.toml COPYONLY)
+endif()
 
-FetchContent_Declare(
-	toml11
-	GIT_REPOSITORY https://github.com/ToruNiina/toml11
-	GIT_SHALLOW ON
-	)
+# Hack to hide a warning during cmkr bootstrapping on Windows
+if(CMAKE_BUILD_TYPE)
+endif()
 
-FetchContent_MakeAvailable(toml11)
 
-set(CMKRLIB_SOURCES
-	src/cmake.cpp
-	src/gen.cpp
-	src/help.cpp
-	src/build.cpp
-	src/error.cpp
-	)
+project(cmkr
+	LANGUAGES
+		CXX
+	VERSION
+		0.1.3
+	DESCRIPTION
+		"CMakeLists generator from TOML"
+)
+
+# third_party
+set(CMKR_CMAKE_FOLDER ${CMAKE_FOLDER})
+if(CMAKE_FOLDER)
+	set(CMAKE_FOLDER "${CMAKE_FOLDER}/third_party")
+else()
+	set(CMAKE_FOLDER third_party)
+endif()
+add_subdirectory(third_party)
+set(CMAKE_FOLDER ${CMKR_CMAKE_FOLDER})
+
+# tests
+set(CMKR_CMAKE_FOLDER ${CMAKE_FOLDER})
+if(CMAKE_FOLDER)
+	set(CMAKE_FOLDER "${CMAKE_FOLDER}/tests")
+else()
+	set(CMAKE_FOLDER tests)
+endif()
+add_subdirectory(tests)
+set(CMAKE_FOLDER ${CMKR_CMAKE_FOLDER})
+
+
+# Target cmkrlib
+set(cmkrlib_SOURCES
+	"src/cmkrlib/args.cpp"
+	"src/cmkrlib/build.cpp"
+	"src/cmkrlib/cmake.cpp"
+	"src/cmkrlib/error.cpp"
+	"src/cmkrlib/gen.cpp"
+	"src/cmkrlib/help.cpp"
+	"src/cmkrlib/cmake.hpp"
+	"src/cmkrlib/enum_helper.hpp"
+	"src/cmkrlib/fs.hpp"
+	"include/args.h"
+	"include/build.h"
+	"include/error.h"
+	"include/gen.h"
+	"include/help.h"
+	"include/literals.h"
+	cmake.toml
+)
+
+add_library(cmkrlib STATIC ${cmkrlib_SOURCES})
+
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${cmkrlib_SOURCES})
 
-add_library(cmkrlib STATIC ${CMKRLIB_SOURCES})
+target_compile_features(cmkrlib PUBLIC
+	cxx_std_11
+)
 
 target_include_directories(cmkrlib PUBLIC
 	include
-	)
+)
 
 target_link_libraries(cmkrlib PUBLIC
-	toml11::toml11
+	toml11
 	ghc_filesystem
 	mpark_variant
-	)
+	ordered_map
+)
 
-target_compile_features(cmkrlib PUBLIC
-	cxx_std_11
-	)
+# Target cmkr
+set(cmkr_SOURCES
+	"src/main.cpp"
+	cmake.toml
+)
+
+add_executable(cmkr ${cmkr_SOURCES})
 
-set(CMKR_SOURCES
-	src/main.cpp
-	src/args.cpp
-	)
+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 cmkr)
+endif()
 
-add_executable(cmkr  ${CMKR_SOURCES})
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${cmkr_SOURCES})
 
-target_link_libraries(cmkr PUBLIC
+target_link_libraries(cmkr PRIVATE
 	cmkrlib
-	)
+)
 
 install(
-	TARGETS cmkr 
-	DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
-	COMPONENT cmkr
-	)
-
-
-
+	TARGETS
+		cmkr
+	DESTINATION
+		"${CMAKE_INSTALL_PREFIX}/bin"
+	COMPONENT
+		cmkr
+)

README.md

@@ -22,9 +22,9 @@ minimum = "3.15"
 name = "app"
 version = "0.1.0"
 
-[[bin]]
+[[target]]
 name = "app"
-type = "exe"
+type = "executable"
 sources = ["src/main.cpp"]
 ```
 
@@ -43,19 +43,19 @@ toml11 = { git = "https://github.com/ToruNiina/toml11" }
 filesystem = { git = "https://github.com/gulrak/filesystem" }
 mpark_variant = { url = "https://github.com/mpark/variant/archive/v1.4.0.tar.gz" }
 
-[[bin]]
+[[target]]
 name = "cmkrlib"
 type = "static"
 sources = ["src/cmake.cpp", "src/gen.cpp", "src/help.cpp", "src/build.cpp", "src/error.cpp"]
-include-dirs = ["include"]
-features = ["cxx_std_11"]
-link-libs = ["toml11::toml11", "ghc_filesystem"]
+include-directories = ["include"]
+compile-features = ["cxx_std_11"]
+link-libraries = ["toml11::toml11", "ghc_filesystem"]
 
-[[bin]]
+[[target]]
 name = "cmkr"
-type = "exe"
+type = "executable"
 sources = ["src/main.cpp", "src/args.cpp"]
-link-libs = ["cmkrlib"]
+link-libraries = ["cmkrlib"]
 
 [[install]]
 targets = ["cmkr"]
@@ -68,7 +68,7 @@ Currently supported fields:
 minimum = "3.15" # required
 description = "" # optional
 subdirs = [] # optional
-bin-dir = "bin" # optional
+build-dir = "build" # optional
 cpp-flags = [] # optional
 c-flags = [] # optional
 link-flags = [] # optional
@@ -97,15 +97,15 @@ toml11 = { git = "https://github.com/ToruNiina/toml11", tag = "v3.5.0" } # optio
 APP_BUILD_STUFF = false # optional
 APP_OTHER_STUFF = { comment = "does other stuff", value = false } # optional
 
-[[bin]] # required, can define several binaries
+[[target]] # required, can define several binaries
 name = "app" # required
-type = "exe" # required (exe || lib || shared || static || interface)
+type = "executable" # required (executable || library || shared || static || interface)
 sources = ["src/*.cpp"] # required, supports globbing
-include-dirs = ["include"] # optional
+include-directories = ["include"] # optional
 alias = "" # optional
-features = [] # optional
-definitions = [] # optional
-link-libs = [] # optional 
+compile-features = [] # optional
+compile-definitions = [] # optional
+link-libraries = [] # optional 
 properties = { PROPERTY1 = "property1", ... } # optional
 
 [[test]] # optional, can define several
@@ -125,13 +125,13 @@ The cmkr executable can be run from the command-line:
 ```
 Usage: cmkr [arguments]
 arguments:
-    init     [exe|lib|shared|static|interface]    Starts a new project in the same directory.
-    gen                                           Generates CMakeLists.txt file.
-    build    <extra cmake args>                   Run cmake and build.
-    install                                       Run cmake --install. Needs admin privileges.
-    clean                                         Clean the build directory.
-    help                                          Show help.
-    version                                       Current cmkr version.
+    init    [executable|library|shared|static|interface] Starts a new project in the same directory.
+    gen                                                  Generates CMakeLists.txt file.
+    build   <extra cmake args>                           Run cmake and build.
+    install                                              Run cmake --install. Needs admin privileges.
+    clean                                                Clean the build directory.
+    help                                                 Show help.
+    version                                              Current cmkr version.
 ```
 The build command invokes cmake and the default build-system on your platform (unless a generator is specified), it also accepts extra cmake build arguments:
 ```
@@ -140,20 +140,20 @@ cmkr build --config Release
 
 ## Binary types
 
-### exe
-Executable binary.
+### executable
+Executable binary. Equivalent to [add_executable(name)](https://cmake.org/cmake/help/latest/command/add_executable.html).
 
-### lib
-Library, can be static or shared depending on the BUILD_SHARED_LIBS variable.
+### library
+Library, can be static or shared depending on the BUILD_SHARED_LIBS variable. Equivalent to [add_library()](https://cmake.org/cmake/help/latest/command/add_library.html).
 
 ### static
-Static library/archive.
+Static library/archive. Equivalent to [add_library(name STATIC)](https://cmake.org/cmake/help/latest/command/add_library.html).
 
 ### shared
-Shared/dynamic library.
+Shared/dynamic library. Equivalent to [add_library(name SHARED)](https://cmake.org/cmake/help/latest/command/add_library.html).
 
 ### interface
-Header-only library.
+Header-only library. Equivalent to [add_library(name INTERFACE)](https://cmake.org/cmake/help/latest/command/add_library.html).
 
 ## Roadmap
 - Support more cmake fields.