mirror of
https://github.com/build-cpp/cmkr
synced 2026-06-08 13:22:55 +00:00
Compare commits
335 Commits
archive_a718dfd6
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 43c72160b5 | |||
| ef3c1a288a | |||
| 26acf23989 | |||
| 15886fc340 | |||
| d5e34b0bcc | |||
| 916ae11cae | |||
| eaa361611a | |||
| 2300612ba9 | |||
| 25f015bc83 | |||
| fc674b4c6b | |||
| 433dbb0500 | |||
| 4772a2b683 | |||
| fb4931df1f | |||
| e96cd30217 | |||
| 2db8d1ee1d | |||
| 645737afd4 | |||
| 98c2e962c0 | |||
| 438feccf0f | |||
| 80cc29b8e1 | |||
| 1a62034a8a | |||
| c12472cd8f | |||
| 228553d43a | |||
| 8f4b376e42 | |||
| fcbf937c49 | |||
| e609c8a48f | |||
| 735898dbac | |||
| f7126b0158 | |||
| b6702714eb | |||
| efa4f716c2 | |||
| 76b7b8e778 | |||
| 501b26ced5 | |||
| 5bc36275ad | |||
| 35c837a181 | |||
| 710dfa4963 | |||
| c49ee6bafe | |||
| 368273bab2 | |||
| ffe08ae60c | |||
| b1249af365 | |||
| ea2ff31b5a | |||
| a32eb66df4 | |||
| 9b85833240 | |||
| ccb3d0b9ef | |||
| 49cdab39bd | |||
| e318139314 | |||
| 0f2a9a55fb | |||
| 38cec2d5d1 | |||
| 3caf593438 | |||
| c94dbd6416 | |||
| a1eaf601c6 | |||
| 10320c8e55 | |||
| 45e12c8d98 | |||
| e12ebc060d | |||
| c6e3fc159f | |||
| dc6f306d9c | |||
| e08bd5a311 | |||
| 068977e2f5 | |||
| 73147747a4 | |||
| a64fa9cc34 | |||
| eb6ccb39ee | |||
| 91dd8ce51f | |||
| efbfca27bd | |||
| 78bcf2acf7 | |||
| 83559cc5d4 | |||
| 5d85cc83e3 | |||
| dea41d80b5 | |||
| b52cf5b241 | |||
| e9480a625f | |||
| 13a7a8788a | |||
| 45ca74099c | |||
| ae3d73896e | |||
| 57042565d1 | |||
| d02ee3ed24 | |||
| 4a15d2ba55 | |||
| 87c0295f93 | |||
| a608e6b778 | |||
| 523f5f4a8a | |||
| 510cf71af5 | |||
| 87d90138b4 | |||
| 50615e0c27 | |||
| 42ed3048b3 | |||
| b0a1d79a42 | |||
| 5882bc082d | |||
| a90b3c6095 | |||
| 0a887c08f8 | |||
| 9f2cfe4083 | |||
| 15ad1dc6a7 | |||
| dabffeaed9 | |||
| 59fe5c38b8 | |||
| dcdc7ac410 | |||
| 88377a8bfb | |||
| 3a9685be82 | |||
| 5576789c18 | |||
| a362978f99 | |||
| a2f33297e4 | |||
| 674c976647 | |||
| 714a666e88 | |||
| d613e433d5 | |||
| 7c828d8740 | |||
| 559f750c89 | |||
| 4b6b72874e | |||
| 6bffa7cc71 | |||
| f415b432ed | |||
| 6c46664336 | |||
| f32aac63aa | |||
| 33d4cc4156 | |||
| 9288c8a87d | |||
| e36eee4420 | |||
| 53820c9f65 | |||
| ff7e4b8f23 | |||
| 1072cb44e2 | |||
| 926fc15fa2 | |||
| e2c929adb0 | |||
| 0dec7ca4d5 | |||
| 45e346b4a3 | |||
| 7165986190 | |||
| be0ef6d615 | |||
| d607b9028c | |||
| 099b14552c | |||
| 771c80a41a | |||
| 58c7de1d60 | |||
| a61e4bb999 | |||
| 47aaeaf8ce | |||
| 62609a0088 | |||
| e0d8a085db | |||
| 56da4144ae | |||
| 9388b3f29d | |||
| 079644cfeb | |||
| a7ca9f04c0 | |||
| 339c2aac94 | |||
| c573c9a76d | |||
| b24a0a2fdc | |||
| 854e8817c4 | |||
| 1c2947b2fc | |||
| 19e61aa1aa | |||
| bfa1e1fe0d | |||
| 56bd78f7ad | |||
| 4362b3547f | |||
| 08204d9847 | |||
| 2202aa8173 | |||
| d3829fb6cd | |||
| 3fb095210a | |||
| 9f99365a25 | |||
| be387141b5 | |||
| 09ded38f70 | |||
| ad90b1ad3e | |||
| 5bfa03d311 | |||
| bdd9d393d6 | |||
| 1deaec2b41 | |||
| cfee3bbc14 | |||
| bcaa60cabe | |||
| 7b1d33395e | |||
| 240fafc102 | |||
| 7a7ddf2699 | |||
| 605a04e72d | |||
| fd7f078127 | |||
| ee0e0d71d9 | |||
| 9d6897b572 | |||
| f8c34e5545 | |||
| e6d783ea20 | |||
| ee7fe38a7b | |||
| 66b2aad843 | |||
| d2e376080a | |||
| 634908c651 | |||
| 33911f3f1b | |||
| e650073bef | |||
| 96e44f7771 | |||
| cb9ad5cdb3 | |||
| c785b540d3 | |||
| 275b73eefa | |||
| ea49a3acb7 | |||
| 257e14c869 | |||
| 7508816fe7 | |||
| 45678bc5bc | |||
| b869e5646f | |||
| a499df84b1 | |||
| 49440f99e0 | |||
| 0c19c3da0c | |||
| 233cadadd0 | |||
| 58a5a935e5 | |||
| e69427bf94 | |||
| bc6359805d | |||
| 8dcc11e349 | |||
| 51dc49e6f1 | |||
| 7d27c28b59 | |||
| ae6bea3b58 | |||
| 5a0eda7abc | |||
| f17923c18b | |||
| ad17890e23 | |||
| c0b98b3ef4 | |||
| 2c6fc569af | |||
| 12ee23a44c | |||
| 82342a6b6f | |||
| 1d95fab0ce | |||
| 44a77329bf | |||
| e68c5fccdc | |||
| e2722d2c09 | |||
| 2627864383 | |||
| 05e21f734a | |||
| 1fd18503cd | |||
| 8b19441d34 | |||
| 2437eb90fe | |||
| 6e4006ec07 | |||
| 697b638723 | |||
| 109c4bc99f | |||
| cad85f0bb1 | |||
| 53c88ceafa | |||
| d2aa15b1c7 | |||
| e6ded077cf | |||
| 3615ccab94 | |||
| 73622aa5ba | |||
| 69d844a152 | |||
| af9a117f50 | |||
| 5fe8220728 | |||
| 28f541cd3c | |||
| 2f3fd7b95e | |||
| 07d99c582d | |||
| 5af2385cc3 | |||
| 981c48dbc5 | |||
| 153bdbe591 | |||
| 97f1c5c1cc | |||
| 5b6d9c3826 | |||
| a90988b81a | |||
| 3a1298f4e8 | |||
| 534f955827 | |||
| ef537ce084 | |||
| 9cdd0f7344 | |||
| e69cf4d2b9 | |||
| e98a906231 | |||
| 9a82f8c796 | |||
| 13255c68cf | |||
| 5768460827 | |||
| 50d4a905b6 | |||
| f957cec2dc | |||
| 232e49e087 | |||
| 7408d42160 | |||
| 1596a8143d | |||
| 9b0f18ee94 | |||
| 887086dc05 | |||
| edc8e1e02e | |||
| 1f6e31e0ef | |||
| 4de1500bb3 | |||
| 85370968f8 | |||
| 06a4c04df6 | |||
| fef2a0215b | |||
| fc74a5e802 | |||
| e48d402e21 | |||
| f6a245618e | |||
| c713606fd4 | |||
| fe9b6587a9 | |||
| a2f8d9e5c9 | |||
| c7925e7110 | |||
| c778a5fe2b | |||
| 16b2cbbb57 | |||
| 2f5c7823be | |||
| a29b6a8aaa | |||
| 5ac8b15c9a | |||
| e7d9faa6bb | |||
| 6f8b07a801 | |||
| e8c6ccb698 | |||
| 539ebc8f4b | |||
| 37ca385673 | |||
| 8ae029dab1 | |||
| fb16cc34b1 | |||
| 47703871e1 | |||
| a8d6b15dcb | |||
| 87b3c7ec6c | |||
| d905be1d13 | |||
| 8d13ccbeaa | |||
| bcbc9d2b20 | |||
| 05324f593b | |||
| 2b7ee72e86 | |||
| 61d5e64d87 | |||
| eed1e38407 | |||
| 61851d2bee | |||
| c0d665095e | |||
| 6c1e388391 | |||
| 04905371b8 | |||
| 5a6ac44fcf | |||
| 9db82dfd05 | |||
| 459ebb14b5 | |||
| 490869b9a2 | |||
| 8ae2754994 | |||
| 18419297f4 | |||
| bdaf5c94e6 | |||
| fa3b7a346c | |||
| df1dbf7953 | |||
| 5951f6930e | |||
| a6d5f1c99b | |||
| dc852b9a2f | |||
| 66621a9818 | |||
| 2cd8ad0f18 | |||
| 084cbd6159 | |||
| b4b0f533a9 | |||
| 0acc9b4e5a | |||
| 61dfb0eb60 | |||
| 3201fd052e | |||
| 83087ff06e | |||
| 88e9241e9f | |||
| eff967277d | |||
| ea01497246 | |||
| 04bf40a5a6 | |||
| 4d14395994 | |||
| 3dd3368e4e | |||
| bb7874a6df | |||
| 91dbf2986e | |||
| 2bcf15c4ed | |||
| 6a825e15a0 | |||
| cc2b984aa5 | |||
| 56a88c41e2 | |||
| 6809e8da41 | |||
| 9f9934e9a5 | |||
| 77f4bf7da0 | |||
| 09c9c28934 | |||
| f02ccc2309 | |||
| 37e9a1f1a0 | |||
| a28e63fddc | |||
| 156fc961ec | |||
| 31cc1c9481 | |||
| 19101cd726 | |||
| 8ebf69da7e | |||
| 1c23469c8c | |||
| 52671dcf5b | |||
| 094bab1b81 | |||
| 0f559bc803 | |||
| 491486075d | |||
| ed84fc0251 | |||
| 8b6780fe1a | |||
| 9ebcb1fb06 | |||
| 7c7144b183 | |||
| 07797988b5 | |||
| 285614e4c2 | |||
| e725b10a9f | |||
| aafaf58c70 | |||
| 87db22f134 | |||
| 416a8365f9 |
+3
-2
@@ -10,9 +10,10 @@ AlignTrailingComments: true
|
|||||||
AllowAllParametersOfDeclarationOnNextLine: true
|
AllowAllParametersOfDeclarationOnNextLine: true
|
||||||
AllowShortBlocksOnASingleLine: false
|
AllowShortBlocksOnASingleLine: false
|
||||||
AllowShortCaseLabelsOnASingleLine: false
|
AllowShortCaseLabelsOnASingleLine: false
|
||||||
AllowShortFunctionsOnASingleLine: true
|
AllowShortFunctionsOnASingleLine: false
|
||||||
AllowShortIfStatementsOnASingleLine: false
|
AllowShortIfStatementsOnASingleLine: false
|
||||||
AllowShortLoopsOnASingleLine: false
|
AllowShortLoopsOnASingleLine: false
|
||||||
|
AllowShortLambdasOnASingleLine: None
|
||||||
AlwaysBreakAfterDefinitionReturnType: None
|
AlwaysBreakAfterDefinitionReturnType: None
|
||||||
AlwaysBreakAfterReturnType: None
|
AlwaysBreakAfterReturnType: None
|
||||||
AlwaysBreakBeforeMultilineStrings: false
|
AlwaysBreakBeforeMultilineStrings: false
|
||||||
@@ -72,7 +73,7 @@ PenaltyExcessCharacter: 1000000
|
|||||||
PenaltyReturnTypeOnItsOwnLine: 60
|
PenaltyReturnTypeOnItsOwnLine: 60
|
||||||
PointerAlignment: Right
|
PointerAlignment: Right
|
||||||
ReflowComments: true
|
ReflowComments: true
|
||||||
SortIncludes: true
|
SortIncludes: false
|
||||||
SortUsingDeclarations: true
|
SortUsingDeclarations: true
|
||||||
SpaceAfterCStyleCast: false
|
SpaceAfterCStyleCast: false
|
||||||
SpaceAfterTemplateKeyword: true
|
SpaceAfterTemplateKeyword: true
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
charset = utf-8
|
||||||
|
|
||||||
|
[*.{c,h,cpp,hpp,toml}]
|
||||||
|
indent_style = space
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[{CMakeLists.txt, *.cmake}]
|
||||||
|
indent_style = tab
|
||||||
|
tab_width = 8
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
# Exclude the third_party folder
|
||||||
|
[/third_party/**]
|
||||||
|
charset = unset
|
||||||
|
end_of_line = unset
|
||||||
|
insert_final_newline = unset
|
||||||
|
trim_trailing_whitespace = unset
|
||||||
|
indent_style = unset
|
||||||
|
indent_size = unset
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
github: [mrexodia]
|
||||||
+25
-14
@@ -1,61 +1,72 @@
|
|||||||
name: CMake
|
name: build
|
||||||
|
|
||||||
on: [push, pull_request]
|
on: [push, pull_request]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
cmake:
|
||||||
# Skip building pull requests from the same repository
|
# Skip building pull requests from the same repository
|
||||||
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != '${{ github.repository }}'
|
if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) }}
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [windows-2016, windows-2019, macos-10.15, ubuntu-16.04, ubuntu-18.04, ubuntu-20.04]
|
os: [windows-2022, macos-latest, ubuntu-22.04]
|
||||||
env:
|
env:
|
||||||
BUILD_TYPE: Release
|
BUILD_TYPE: 'Release'
|
||||||
|
CMAKE_GENERATOR: 'Ninja'
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Visual Studio Development Environment
|
||||||
|
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.1
|
||||||
|
|
||||||
|
- name: Tag cmkr.cmake
|
||||||
|
if: ${{ startsWith(github.ref, 'refs/tags/') }}
|
||||||
|
run: cmake -P "cmake/replace_tag.cmake"
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: |
|
run: |
|
||||||
cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
|
cmake -B build -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DCMAKE_UNITY_BUILD=ON
|
||||||
cmake --build build --config ${{ env.BUILD_TYPE }} --parallel
|
cmake --build build --config ${{ env.BUILD_TYPE }} --parallel
|
||||||
cmake --install build --prefix ./install --config ${{ env.BUILD_TYPE }}
|
cmake --install build --prefix ./install --config ${{ env.BUILD_TYPE }}
|
||||||
|
|
||||||
- name: Check if cmkr was run
|
- name: Check if cmkr was run
|
||||||
run: |
|
run: |
|
||||||
./install/bin/cmkr gen
|
./install/bin/cmkr gen
|
||||||
git diff --exit-code
|
git diff --exit-code -- . ":(exclude)cmake/cmkr.cmake"
|
||||||
|
|
||||||
- name: Test
|
- name: Test
|
||||||
run: |
|
run: |
|
||||||
cd build/tests
|
cd build/tests
|
||||||
ctest -C ${{ env.BUILD_TYPE }}
|
ctest -C ${{ env.BUILD_TYPE }} --verbose
|
||||||
|
|
||||||
- name: Upload artifacts
|
- name: Upload artifacts
|
||||||
uses: actions/upload-artifact@v2
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: ${{ github.event.repository.name }}-${{ matrix.os }}
|
name: ${{ github.event.repository.name }}-${{ matrix.os }}
|
||||||
path: install/bin/*
|
path: install/bin/*
|
||||||
|
|
||||||
- name: Get lowercase OS name
|
- name: Get lowercase OS name
|
||||||
id: osname
|
id: osname
|
||||||
uses: ASzc/change-string-case-action@v1
|
uses: ASzc/change-string-case-action@ccb130a4e483d3e86287289183704dc9bf53e77e # master 2024-04-05
|
||||||
|
if: ${{ startsWith(github.ref, 'refs/tags/') }}
|
||||||
with:
|
with:
|
||||||
string: ${{ runner.os }}
|
string: ${{ runner.os }}
|
||||||
|
|
||||||
- name: Compress artifacts
|
- name: Compress artifacts
|
||||||
uses: papeloto/action-zip@v1
|
uses: vimtor/action-zip@1379ea20d4c5705669ba81fd626dd01b1c738f26 # v1.2
|
||||||
|
if: ${{ startsWith(github.ref, 'refs/tags/') }}
|
||||||
with:
|
with:
|
||||||
files: install/bin/
|
files: install/bin/
|
||||||
dest: ${{ github.event.repository.name }}-${{ steps.osname.outputs.lowercase }}.zip
|
dest: ${{ github.event.repository.name }}-${{ steps.osname.outputs.lowercase }}.zip
|
||||||
|
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
|
||||||
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:
|
with:
|
||||||
prerelease: ${{ !startsWith(github.ref, 'refs/tags/v') || contains(github.ref, '-pre') }}
|
prerelease: ${{ !startsWith(github.ref, 'refs/tags/v') || contains(github.ref, '-pre') }}
|
||||||
files: ${{ github.event.repository.name }}-${{ steps.osname.outputs.lowercase }}.zip
|
files: ${{ github.event.repository.name }}-${{ steps.osname.outputs.lowercase }}.zip
|
||||||
|
generate_release_notes: true
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
name: lint
|
||||||
|
|
||||||
|
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:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: clang-format
|
||||||
|
id: clang-format
|
||||||
|
uses: DoozyX/clang-format-lint-action@c71d0bf4e21876ebec3e5647491186f8797fde31 # v0.18.2
|
||||||
|
with:
|
||||||
|
exclude: './third_party'
|
||||||
|
extensions: 'c,h,cpp,hpp'
|
||||||
|
clangFormatVersion: 15
|
||||||
|
style: file
|
||||||
|
|
||||||
|
- name: clang-format instructions
|
||||||
|
if: ${{ failure() && steps.clang-format.outcome == 'failure' }}
|
||||||
|
run: |
|
||||||
|
# Instructions for fixing the formatting errors
|
||||||
|
echo -e "\n\033[0;31mTo fix the formatting, run:\nclang-format -style=file -i \$(git ls-files \"*.c\" \"*.h\" \"*.cpp\" \"*.hpp\")\033[0m\n"
|
||||||
|
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:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Run editorconfig-checker
|
||||||
|
uses: editorconfig-checker/action-editorconfig-checker@27dd658c2b1282c7f1f4dc242cdf0f6d8af728ab # master 2025-05-30
|
||||||
@@ -9,3 +9,5 @@ build*/
|
|||||||
.idea/
|
.idea/
|
||||||
cmake-build*/
|
cmake-build*/
|
||||||
CMakeLists.txt.user
|
CMakeLists.txt.user
|
||||||
|
.vscode/
|
||||||
|
.DS_Store
|
||||||
Generated
+27
-59
@@ -1,29 +1,20 @@
|
|||||||
# This file is automatically generated from cmake.toml - DO NOT EDIT
|
# This file is automatically generated from cmake.toml - DO NOT EDIT
|
||||||
# See https://github.com/build-cpp/cmkr for more information
|
# See https://github.com/build-cpp/cmkr for more information
|
||||||
|
|
||||||
cmake_minimum_required(VERSION 2.8...3.8)
|
cmake_minimum_required(VERSION 2.8...3.31)
|
||||||
|
|
||||||
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
|
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
|
||||||
message(FATAL_ERROR "In-tree builds are not supported. Run CMake from a separate directory: cmake -B build")
|
message(FATAL_ERROR "In-tree builds are not supported. Run CMake from a separate directory: cmake -B build")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
# Regenerate CMakeLists.txt automatically in the root project
|
|
||||||
set(CMKR_ROOT_PROJECT OFF)
|
set(CMKR_ROOT_PROJECT OFF)
|
||||||
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
|
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
|
||||||
set(CMKR_ROOT_PROJECT ON)
|
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
|
# Enable folder support
|
||||||
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
|
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
|
||||||
endif()
|
|
||||||
|
|
||||||
# Create a configure-time dependency on cmake.toml to improve IDE support
|
# Create a configure-time dependency on cmake.toml to improve IDE support
|
||||||
if(CMKR_ROOT_PROJECT)
|
|
||||||
configure_file(cmake.toml cmake.toml COPYONLY)
|
configure_file(cmake.toml cmake.toml COPYONLY)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
@@ -31,14 +22,15 @@ project(cmkr
|
|||||||
LANGUAGES
|
LANGUAGES
|
||||||
CXX
|
CXX
|
||||||
VERSION
|
VERSION
|
||||||
0.1.4
|
0.2.46
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
"CMakeLists generator from TOML"
|
"CMakeLists generator from TOML"
|
||||||
)
|
)
|
||||||
|
|
||||||
include("cmake/generate_documentation.cmake")
|
include("cmake/generate_documentation.cmake")
|
||||||
|
include("cmake/generate_resources.cmake")
|
||||||
|
|
||||||
# third_party
|
# Subdirectory: third_party
|
||||||
set(CMKR_CMAKE_FOLDER ${CMAKE_FOLDER})
|
set(CMKR_CMAKE_FOLDER ${CMAKE_FOLDER})
|
||||||
if(CMAKE_FOLDER)
|
if(CMAKE_FOLDER)
|
||||||
set(CMAKE_FOLDER "${CMAKE_FOLDER}/third_party")
|
set(CMAKE_FOLDER "${CMAKE_FOLDER}/third_party")
|
||||||
@@ -48,7 +40,7 @@ endif()
|
|||||||
add_subdirectory(third_party)
|
add_subdirectory(third_party)
|
||||||
set(CMAKE_FOLDER ${CMKR_CMAKE_FOLDER})
|
set(CMAKE_FOLDER ${CMKR_CMAKE_FOLDER})
|
||||||
|
|
||||||
# tests
|
# Subdirectory: tests
|
||||||
set(CMKR_CMAKE_FOLDER ${CMAKE_FOLDER})
|
set(CMKR_CMAKE_FOLDER ${CMAKE_FOLDER})
|
||||||
if(CMAKE_FOLDER)
|
if(CMAKE_FOLDER)
|
||||||
set(CMAKE_FOLDER "${CMAKE_FOLDER}/tests")
|
set(CMAKE_FOLDER "${CMAKE_FOLDER}/tests")
|
||||||
@@ -58,63 +50,35 @@ endif()
|
|||||||
add_subdirectory(tests)
|
add_subdirectory(tests)
|
||||||
set(CMAKE_FOLDER ${CMKR_CMAKE_FOLDER})
|
set(CMAKE_FOLDER ${CMKR_CMAKE_FOLDER})
|
||||||
|
|
||||||
|
# Target: cmkr_generate_documentation
|
||||||
|
|
||||||
# Target cmkr_generate_documentation
|
|
||||||
set(CMKR_TARGET cmkr_generate_documentation)
|
|
||||||
set(cmkr_generate_documentation_SOURCES "")
|
|
||||||
|
|
||||||
set(CMKR_SOURCES ${cmkr_generate_documentation_SOURCES})
|
|
||||||
add_library(cmkr_generate_documentation INTERFACE)
|
add_library(cmkr_generate_documentation INTERFACE)
|
||||||
|
|
||||||
if(cmkr_generate_documentation_SOURCES)
|
set(CMKR_TARGET cmkr_generate_documentation)
|
||||||
target_sources(cmkr_generate_documentation INTERFACE ${cmkr_generate_documentation_SOURCES})
|
|
||||||
endif()
|
|
||||||
|
|
||||||
generate_documentation()
|
generate_documentation()
|
||||||
|
|
||||||
unset(CMKR_TARGET)
|
# Target: cmkr
|
||||||
unset(CMKR_SOURCES)
|
set(cmkr_SOURCES
|
||||||
|
cmake.toml
|
||||||
# Target cmkr
|
"cmake/cmkr.cmake"
|
||||||
set(CMKR_TARGET cmkr)
|
"cmake/version.hpp.in"
|
||||||
set(cmkr_SOURCES "")
|
|
||||||
|
|
||||||
list(APPEND cmkr_SOURCES
|
|
||||||
"src/arguments.cpp"
|
|
||||||
"src/build.cpp"
|
|
||||||
"src/cmake_generator.cpp"
|
|
||||||
"src/error.cpp"
|
|
||||||
"src/help.cpp"
|
|
||||||
"src/main.cpp"
|
|
||||||
"src/project_parser.cpp"
|
|
||||||
"include/arguments.hpp"
|
"include/arguments.hpp"
|
||||||
"include/build.hpp"
|
"include/build.hpp"
|
||||||
"include/cmake_generator.hpp"
|
"include/cmake_generator.hpp"
|
||||||
"include/enum_helper.hpp"
|
|
||||||
"include/error.hpp"
|
|
||||||
"include/fs.hpp"
|
"include/fs.hpp"
|
||||||
"include/help.hpp"
|
"include/help.hpp"
|
||||||
"include/literals.hpp"
|
"include/literals.hpp"
|
||||||
"include/project_parser.hpp"
|
"include/project_parser.hpp"
|
||||||
|
"src/arguments.cpp"
|
||||||
|
"src/build.cpp"
|
||||||
|
"src/cmake_generator.cpp"
|
||||||
|
"src/help.cpp"
|
||||||
|
"src/main.cpp"
|
||||||
|
"src/project_parser.cpp"
|
||||||
)
|
)
|
||||||
|
|
||||||
list(APPEND cmkr_SOURCES
|
|
||||||
cmake.toml
|
|
||||||
)
|
|
||||||
|
|
||||||
set(CMKR_SOURCES ${cmkr_SOURCES})
|
|
||||||
add_executable(cmkr)
|
add_executable(cmkr)
|
||||||
|
|
||||||
if(cmkr_SOURCES)
|
target_sources(cmkr PRIVATE ${cmkr_SOURCES})
|
||||||
target_sources(cmkr PRIVATE ${cmkr_SOURCES})
|
|
||||||
endif()
|
|
||||||
|
|
||||||
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()
|
|
||||||
|
|
||||||
source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${cmkr_SOURCES})
|
source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${cmkr_SOURCES})
|
||||||
|
|
||||||
target_compile_features(cmkr PRIVATE
|
target_compile_features(cmkr PRIVATE
|
||||||
@@ -130,11 +94,15 @@ target_link_libraries(cmkr PRIVATE
|
|||||||
ghc_filesystem
|
ghc_filesystem
|
||||||
mpark_variant
|
mpark_variant
|
||||||
ordered_map
|
ordered_map
|
||||||
nlohmann_json
|
|
||||||
)
|
)
|
||||||
|
|
||||||
unset(CMKR_TARGET)
|
get_directory_property(CMKR_VS_STARTUP_PROJECT DIRECTORY ${PROJECT_SOURCE_DIR} DEFINITION VS_STARTUP_PROJECT)
|
||||||
unset(CMKR_SOURCES)
|
if(NOT CMKR_VS_STARTUP_PROJECT)
|
||||||
|
set_property(DIRECTORY ${PROJECT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT cmkr)
|
||||||
|
endif()
|
||||||
|
|
||||||
|
set(CMKR_TARGET cmkr)
|
||||||
|
include("cmake/custom_targets.cmake")
|
||||||
|
|
||||||
install(
|
install(
|
||||||
TARGETS
|
TARGETS
|
||||||
|
|||||||
@@ -1,43 +1,66 @@
|
|||||||
# cmkr
|
# cmkr
|
||||||
|
|
||||||
`cmkr`, pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io). It was originally created by [Mohammed Alyousef](https://github.com/MoAlyousef).
|
[](https://deepwiki.com/build-cpp/cmkr)
|
||||||
|
|
||||||
|
`cmkr`, pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io).
|
||||||
|
|
||||||
`cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example:
|
`cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
name = "cmkr_for_beginners"
|
name = "cmkr_for_beginners"
|
||||||
description = "A minimal cmkr project."
|
|
||||||
|
|
||||||
[target.hello_world]
|
[target.hello_world]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
sources = ["src/main.cpp"]
|
sources = ["src/main.cpp"]
|
||||||
```
|
```
|
||||||
|
|
||||||
`cmkr` can bootstrap itself from CMake and consumers of your project do not need to install anything to work with it.
|
`cmkr` can bootstrap itself and you only need CMake and a C++ compiler to use it.
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
The easiest way to get started is to use the [cmkr_for_beginners](https://github.com/build-cpp/cmkr_for_beginners) template repository. Either open it in [Gitpod](https://gitpod.io/#https://github.com/build-cpp/cmkr_for_beginners), or clone the repository and run:
|
To get started, run the following commands from your project directory:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl https://raw.githubusercontent.com/build-cpp/cmkr/main/cmake/cmkr.cmake -o cmkr.cmake
|
||||||
|
cmake -P cmkr.cmake
|
||||||
|
```
|
||||||
|
|
||||||
|
After the bootstrapping process finishes, customize [`cmake.toml`](https://build-cpp.github.io/cmkr/cmake-toml) for your project and run CMake:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cmake -B build
|
cmake -B build
|
||||||
cmake --build build
|
cmake --build build
|
||||||
```
|
```
|
||||||
|
|
||||||
Alternatively you can check out the [cmkr topic](https://github.com/topics/cmkr), the [build-cpp organization](https://github.com/build-cpp) or the [tests](https://github.com/build-cpp/cmkr/tree/main/tests) for more examples and templates. You can also check out the [documentation](https://build-cpp.github.io/cmkr).
|
Once bootstrapped, `cmkr` does not introduce extra steps to your workflow. After modifying `cmake.toml` you simply build/configure your CMake project and `cmkr` will automatically regenerate `CMakeLists.txt` when necessary.
|
||||||
|
|
||||||
|
<sub>**Note**: The `cmake.toml` project file, generated `CMakeLists.txt` and `cmkr.cmake` bootstrapping script are all intended to be added to source control.</sub>
|
||||||
|
|
||||||
|
In CI environments the `cmkr` bootstrapping process is skipped, so there is no additional overhead in your pipelines.
|
||||||
|
|
||||||
|
## Template repositories
|
||||||
|
|
||||||
|
Another way to get started is to use the [cmkr_for_beginners](https://github.com/build-cpp/cmkr_for_beginners) template repository. Either open it in [Gitpod](https://gitpod.io/#https://github.com/build-cpp/cmkr_for_beginners), or clone the repository and run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cmake -B build
|
||||||
|
cmake --build build
|
||||||
|
```
|
||||||
|
|
||||||
|
Check out the [cmkr topic](https://github.com/topics/cmkr), the [build-cpp organization](https://github.com/build-cpp) or the [tests](https://github.com/build-cpp/cmkr/tree/main/tests) for more examples and templates.
|
||||||
|
|
||||||
## Command line
|
## Command line
|
||||||
|
|
||||||
Optionally you can install `cmkr` in your `PATH` and use it as a utility from the command line:
|
Optionally you can put a [`cmkr` release](https://github.com/build-cpp/cmkr/releases) in your `PATH` and use it as a utility from the command line:
|
||||||
|
|
||||||
```
|
```
|
||||||
Usage: cmkr [arguments]
|
Usage: cmkr [arguments]
|
||||||
arguments:
|
arguments:
|
||||||
init [executable|library|shared|static|interface] Starts a new project in the same directory.
|
init [executable|library|shared|static|interface] Create a project.
|
||||||
gen Generates CMakeLists.txt file.
|
gen Generates CMakeLists.txt file.
|
||||||
build <extra cmake args> Run cmake and build.
|
build <extra cmake args> Run cmake and build.
|
||||||
install Run cmake --install. Needs admin privileges.
|
install Run cmake --install.
|
||||||
clean Clean the build directory.
|
clean Clean the build directory.
|
||||||
help Show help.
|
help Show help.
|
||||||
version Current cmkr version.
|
version Current cmkr version.
|
||||||
@@ -45,8 +68,10 @@ arguments:
|
|||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
- https://github.com/gulrak/filesystem
|
- [gulrak/filesystem](https://github.com/gulrak/filesystem)
|
||||||
- https://github.com/Tessil/ordered-map
|
- [Tessil/ordered-map](https://github.com/Tessil/ordered-map)
|
||||||
- https://github.com/ToruNiina/toml11
|
- [ToruNiina/toml11](https://github.com/ToruNiina/toml11)
|
||||||
- https://github.com/mpark/variant
|
- [mpark/variant](https://github.com/mpark/variant)
|
||||||
- https://www.svgrepo.com/svg/192268/hammer
|
- [SVG Repo Hammer](https://www.svgrepo.com/svg/192268/hammer)
|
||||||
|
- [can1357](https://github.com/can1357) for buying `cmkr.build` ❤️
|
||||||
|
- [JustasMasiulis](https://github.com/JustasMasiulis) for fixing the dark theme ❤️
|
||||||
|
|||||||
+23
-6
@@ -1,13 +1,17 @@
|
|||||||
[cmake]
|
[cmake]
|
||||||
version = "2.8...3.8"
|
version = "2.8...3.31"
|
||||||
|
cmkr-include = false
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "cmkr"
|
name = "cmkr"
|
||||||
version = "0.1.4"
|
version = "0.2.46"
|
||||||
description = "CMakeLists generator from TOML"
|
description = "CMakeLists generator from TOML"
|
||||||
languages = ["CXX"]
|
languages = ["CXX"]
|
||||||
|
include-after = [
|
||||||
|
"cmake/generate_documentation.cmake",
|
||||||
|
"cmake/generate_resources.cmake"
|
||||||
|
]
|
||||||
subdirs = ["third_party", "tests"]
|
subdirs = ["third_party", "tests"]
|
||||||
include-after = ["cmake/generate_documentation.cmake"]
|
|
||||||
|
|
||||||
[target.cmkr_generate_documentation]
|
[target.cmkr_generate_documentation]
|
||||||
type = "interface"
|
type = "interface"
|
||||||
@@ -17,10 +21,23 @@ generate_documentation()
|
|||||||
|
|
||||||
[target.cmkr]
|
[target.cmkr]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
sources = ["src/*.cpp", "include/*.hpp"]
|
sources = [
|
||||||
include-directories = ["include"]
|
"src/*.cpp",
|
||||||
|
"include/*.hpp",
|
||||||
|
"cmake/cmkr.cmake",
|
||||||
|
"cmake/version.hpp.in",
|
||||||
|
]
|
||||||
|
include-directories = [
|
||||||
|
"include",
|
||||||
|
]
|
||||||
compile-features = ["cxx_std_11"]
|
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",
|
||||||
|
]
|
||||||
|
include-after = ["cmake/custom_targets.cmake"]
|
||||||
|
|
||||||
[[install]]
|
[[install]]
|
||||||
targets = ["cmkr"]
|
targets = ["cmkr"]
|
||||||
|
|||||||
Generated
-44
@@ -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})
|
|
||||||
|
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
cmake_minimum_required(VERSION 3.20)
|
||||||
|
|
||||||
|
if(NOT CMAKE_SCRIPT_MODE_FILE)
|
||||||
|
message(FATAL_ERROR "Usage: cmake -P bump_version.cmake [1.2.3]")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if(NOT EXISTS "${CMAKE_SOURCE_DIR}/cmake.toml")
|
||||||
|
message(FATAL_ERROR "Cannot find cmake.toml")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if(NOT EXISTS "${CMAKE_SOURCE_DIR}/cmake/cmkr.cmake")
|
||||||
|
message(FATAL_ERROR "Cannot find cmkr.cmake")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
# Validate branch
|
||||||
|
find_package(Git REQUIRED)
|
||||||
|
execute_process(COMMAND "${GIT_EXECUTABLE}" branch --show-current OUTPUT_VARIABLE GIT_BRANCH)
|
||||||
|
string(STRIP "${GIT_BRANCH}" GIT_BRANCH)
|
||||||
|
if(NOT GIT_BRANCH STREQUAL "main")
|
||||||
|
message(FATAL_ERROR "You need to be on the main branch, you are on: ${GIT_BRANCH}")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
file(READ "${CMAKE_SOURCE_DIR}/cmake.toml" CMAKE_TOML)
|
||||||
|
string(FIND "${CMAKE_TOML}" "[project]" PROJECT_INDEX)
|
||||||
|
string(SUBSTRING "${CMAKE_TOML}" ${PROJECT_INDEX} -1 CMAKE_TOML_PROJECT)
|
||||||
|
set(SEMVER_REGEX "([0-9]+)\\.([0-9]+)\\.([0-9]+)")
|
||||||
|
set(VERSION_REGEX "version = \"${SEMVER_REGEX}\"")
|
||||||
|
if(CMAKE_TOML_PROJECT MATCHES "${VERSION_REGEX}")
|
||||||
|
set(MAJOR "${CMAKE_MATCH_1}")
|
||||||
|
set(MINOR "${CMAKE_MATCH_2}")
|
||||||
|
set(PATCH "${CMAKE_MATCH_3}")
|
||||||
|
set(OLDVERSION "${MAJOR}.${MINOR}.${PATCH}")
|
||||||
|
else()
|
||||||
|
message(FATAL_ERROR "Failed to match semantic version in cmake.toml")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if(CMAKE_ARGV3)
|
||||||
|
if(NOT CMAKE_ARGV3 MATCHES "${SEMVER_REGEX}")
|
||||||
|
message(FATAL_ERROR "Invalid semantic version number '${CMAKE_ARGV3}'")
|
||||||
|
endif()
|
||||||
|
set(NEWVERSION "${CMAKE_ARGV3}")
|
||||||
|
else()
|
||||||
|
math(EXPR NEWPATCH "${PATCH} + 1")
|
||||||
|
set(NEWVERSION "${MAJOR}.${MINOR}.${NEWPATCH}")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
message(STATUS "Version ${OLDVERSION} -> ${NEWVERSION}")
|
||||||
|
|
||||||
|
find_program(CMKR_EXECUTABLE "cmkr" PATHS "${CMAKE_SOURCE_DIR}/build" PATH_SUFFIXES Debug Release RelWithDebInfo MinSizeRel NO_CACHE REQUIRED)
|
||||||
|
message(STATUS "Found cmkr: ${CMKR_EXECUTABLE}")
|
||||||
|
|
||||||
|
# Replace version in cmake.toml
|
||||||
|
string(REPLACE "version = \"${OLDVERSION}\"" "version = \"${NEWVERSION}\"" CMAKE_TOML "${CMAKE_TOML}")
|
||||||
|
file(CONFIGURE
|
||||||
|
OUTPUT "${CMAKE_SOURCE_DIR}/cmake.toml"
|
||||||
|
CONTENT "${CMAKE_TOML}"
|
||||||
|
@ONLY
|
||||||
|
NEWLINE_STYLE LF
|
||||||
|
)
|
||||||
|
|
||||||
|
# Run cmkr gen
|
||||||
|
execute_process(COMMAND "${CMKR_EXECUTABLE}" gen RESULT_VARIABLE CMKR_EXEC_RESULT)
|
||||||
|
if(NOT CMKR_EXEC_RESULT EQUAL 0)
|
||||||
|
message(FATAL_ERROR "cmkr gen failed (exit code ${CMKR_EXEC_RESULT})")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
# Replace version in cmkr.cmake
|
||||||
|
file(READ "${CMAKE_SOURCE_DIR}/cmake/cmkr.cmake" CMKR_CMAKE)
|
||||||
|
string(REGEX REPLACE "CMKR_TAG \"[^\"]+\"" "CMKR_TAG \"v${NEWVERSION}\"" CMKR_CMAKE "${CMKR_CMAKE}")
|
||||||
|
file(CONFIGURE
|
||||||
|
OUTPUT "${CMAKE_SOURCE_DIR}/cmake/cmkr.cmake"
|
||||||
|
CONTENT "${CMKR_CMAKE}"
|
||||||
|
@ONLY
|
||||||
|
NEWLINE_STYLE LF
|
||||||
|
)
|
||||||
|
|
||||||
|
# Print git commands
|
||||||
|
message(STATUS "Git commands to create new version:\ngit commit -a -m \"Bump to ${NEWVERSION}\"\ngit tag v${NEWVERSION}\ngit push origin main v${NEWVERSION}")
|
||||||
@@ -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"]
|
|
||||||
+110
-11
@@ -2,22 +2,34 @@ include_guard()
|
|||||||
|
|
||||||
# Change these defaults to point to your infrastructure if desired
|
# 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_REPO "https://github.com/build-cpp/cmkr" CACHE STRING "cmkr git repository" FORCE)
|
||||||
set(CMKR_TAG "archive_264e4ace" CACHE STRING "cmkr git tag (this needs to be available forever)" FORCE)
|
set(CMKR_TAG "v0.2.46" 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
|
||||||
|
if(CMAKE_SCRIPT_MODE_FILE)
|
||||||
|
set(CMAKE_BINARY_DIR "${CMAKE_BINARY_DIR}/build")
|
||||||
|
set(CMAKE_CURRENT_BINARY_DIR "${CMAKE_BINARY_DIR}")
|
||||||
|
file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}")
|
||||||
|
file(WRITE "${CMAKE_BINARY_DIR}/.gitignore" "# This file is autogenerated by cmkr.\n*\n")
|
||||||
|
endif()
|
||||||
|
|
||||||
# Set these from the command line to customize for development/debugging purposes
|
# Set these from the command line to customize for development/debugging purposes
|
||||||
set(CMKR_EXECUTABLE "" CACHE FILEPATH "cmkr executable")
|
set(CMKR_EXECUTABLE "" CACHE FILEPATH "cmkr executable")
|
||||||
set(CMKR_SKIP_GENERATION OFF CACHE BOOL "skip automatic cmkr generation")
|
set(CMKR_SKIP_GENERATION OFF CACHE BOOL "skip automatic cmkr generation")
|
||||||
|
set(CMKR_BUILD_TYPE "Debug" CACHE STRING "cmkr build configuration")
|
||||||
|
mark_as_advanced(CMKR_REPO CMKR_TAG CMKR_COMMIT_HASH CMKR_EXECUTABLE CMKR_SKIP_GENERATION CMKR_BUILD_TYPE)
|
||||||
|
|
||||||
# Disable cmkr if generation is disabled
|
# Disable cmkr if generation is disabled
|
||||||
if(DEFINED ENV{CI} OR CMKR_SKIP_GENERATION)
|
if(DEFINED ENV{CI} OR CMKR_SKIP_GENERATION OR CMKR_BUILD_SKIP_GENERATION)
|
||||||
message(STATUS "[cmkr] Skipping automatic cmkr generation")
|
message(STATUS "[cmkr] Skipping automatic cmkr generation")
|
||||||
|
unset(CMKR_BUILD_SKIP_GENERATION CACHE)
|
||||||
macro(cmkr)
|
macro(cmkr)
|
||||||
endmacro()
|
endmacro()
|
||||||
return()
|
return()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
# Disable cmkr if no cmake.toml file is found
|
# Disable cmkr if no cmake.toml file is found
|
||||||
if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/cmake.toml")
|
if(NOT CMAKE_SCRIPT_MODE_FILE AND NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/cmake.toml")
|
||||||
message(AUTHOR_WARNING "[cmkr] Not found: ${CMAKE_CURRENT_SOURCE_DIR}/cmake.toml")
|
message(AUTHOR_WARNING "[cmkr] Not found: ${CMAKE_CURRENT_SOURCE_DIR}/cmake.toml")
|
||||||
macro(cmkr)
|
macro(cmkr)
|
||||||
endmacro()
|
endmacro()
|
||||||
@@ -47,18 +59,71 @@ else()
|
|||||||
endif()
|
endif()
|
||||||
|
|
||||||
# Use cached cmkr if found
|
# Use cached cmkr if found
|
||||||
set(CMKR_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/_cmkr_${CMKR_TAG}")
|
if(DEFINED ENV{CMKR_CACHE})
|
||||||
|
set(CMKR_DIRECTORY_PREFIX "$ENV{CMKR_CACHE}")
|
||||||
|
string(REPLACE "\\" "/" CMKR_DIRECTORY_PREFIX "${CMKR_DIRECTORY_PREFIX}")
|
||||||
|
if(CMKR_DIRECTORY_PREFIX MATCHES "^~")
|
||||||
|
if(WIN32)
|
||||||
|
string(REGEX REPLACE "^~" "$ENV{USERPROFILE}" CMKR_DIRECTORY_PREFIX "${CMKR_DIRECTORY_PREFIX}")
|
||||||
|
elseif(UNIX)
|
||||||
|
string(REGEX REPLACE "^~" "$ENV{HOME}" CMKR_DIRECTORY_PREFIX "${CMKR_DIRECTORY_PREFIX}")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
if(NOT CMKR_DIRECTORY_PREFIX MATCHES "\\/$")
|
||||||
|
set(CMKR_DIRECTORY_PREFIX "${CMKR_DIRECTORY_PREFIX}/")
|
||||||
|
endif()
|
||||||
|
# Build in release mode for the cache
|
||||||
|
set(CMKR_BUILD_TYPE "Release")
|
||||||
|
else()
|
||||||
|
set(CMKR_DIRECTORY_PREFIX "${CMAKE_CURRENT_BINARY_DIR}/_cmkr_")
|
||||||
|
endif()
|
||||||
|
set(CMKR_DIRECTORY "${CMKR_DIRECTORY_PREFIX}${CMKR_TAG}")
|
||||||
set(CMKR_CACHED_EXECUTABLE "${CMKR_DIRECTORY}/bin/${CMKR_EXECUTABLE_NAME}")
|
set(CMKR_CACHED_EXECUTABLE "${CMKR_DIRECTORY}/bin/${CMKR_EXECUTABLE_NAME}")
|
||||||
|
|
||||||
if(NOT CMKR_CACHED_EXECUTABLE STREQUAL CMKR_EXECUTABLE AND CMKR_EXECUTABLE MATCHES "^${CMAKE_CURRENT_BINARY_DIR}/_cmkr")
|
# Helper function to check if a string starts with a prefix
|
||||||
message(AUTHOR_WARNING "[cmkr] Upgrading '${CMKR_EXECUTABLE}' to '${CMKR_CACHED_EXECUTABLE}'")
|
# Cannot use MATCHES, see: https://github.com/build-cpp/cmkr/issues/61
|
||||||
unset(CMKR_EXECUTABLE CACHE)
|
function(cmkr_startswith str prefix result)
|
||||||
|
string(LENGTH "${prefix}" prefix_length)
|
||||||
|
string(LENGTH "${str}" str_length)
|
||||||
|
if(prefix_length LESS_EQUAL str_length)
|
||||||
|
string(SUBSTRING "${str}" 0 ${prefix_length} str_prefix)
|
||||||
|
if(prefix STREQUAL str_prefix)
|
||||||
|
set("${result}" ON PARENT_SCOPE)
|
||||||
|
return()
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
set("${result}" OFF PARENT_SCOPE)
|
||||||
|
endfunction()
|
||||||
|
|
||||||
|
# Handle upgrading logic
|
||||||
|
if(CMKR_EXECUTABLE AND NOT CMKR_CACHED_EXECUTABLE STREQUAL CMKR_EXECUTABLE)
|
||||||
|
cmkr_startswith("${CMKR_EXECUTABLE}" "${CMAKE_CURRENT_BINARY_DIR}/_cmkr" CMKR_STARTSWITH_BUILD)
|
||||||
|
cmkr_startswith("${CMKR_EXECUTABLE}" "${CMKR_DIRECTORY_PREFIX}" CMKR_STARTSWITH_CACHE)
|
||||||
|
if(CMKR_STARTSWITH_BUILD)
|
||||||
|
if(DEFINED ENV{CMKR_CACHE})
|
||||||
|
message(AUTHOR_WARNING "[cmkr] Switching to cached cmkr: '${CMKR_CACHED_EXECUTABLE}'")
|
||||||
|
if(EXISTS "${CMKR_CACHED_EXECUTABLE}")
|
||||||
|
set(CMKR_EXECUTABLE "${CMKR_CACHED_EXECUTABLE}" CACHE FILEPATH "Full path to cmkr executable" FORCE)
|
||||||
|
else()
|
||||||
|
unset(CMKR_EXECUTABLE CACHE)
|
||||||
|
endif()
|
||||||
|
else()
|
||||||
|
message(AUTHOR_WARNING "[cmkr] Upgrading '${CMKR_EXECUTABLE}' to '${CMKR_CACHED_EXECUTABLE}'")
|
||||||
|
unset(CMKR_EXECUTABLE CACHE)
|
||||||
|
endif()
|
||||||
|
elseif(DEFINED ENV{CMKR_CACHE} AND CMKR_STARTSWITH_CACHE)
|
||||||
|
message(AUTHOR_WARNING "[cmkr] Upgrading cached '${CMKR_EXECUTABLE}' to '${CMKR_CACHED_EXECUTABLE}'")
|
||||||
|
unset(CMKR_EXECUTABLE CACHE)
|
||||||
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if(CMKR_EXECUTABLE AND EXISTS "${CMKR_EXECUTABLE}")
|
if(CMKR_EXECUTABLE AND EXISTS "${CMKR_EXECUTABLE}")
|
||||||
message(VERBOSE "[cmkr] Found cmkr: '${CMKR_EXECUTABLE}'")
|
message(VERBOSE "[cmkr] Found cmkr: '${CMKR_EXECUTABLE}'")
|
||||||
elseif(CMKR_EXECUTABLE AND NOT CMKR_EXECUTABLE STREQUAL CMKR_CACHED_EXECUTABLE)
|
elseif(CMKR_EXECUTABLE AND NOT CMKR_EXECUTABLE STREQUAL CMKR_CACHED_EXECUTABLE)
|
||||||
message(FATAL_ERROR "[cmkr] '${CMKR_EXECUTABLE}' not found")
|
message(FATAL_ERROR "[cmkr] '${CMKR_EXECUTABLE}' not found")
|
||||||
|
elseif(NOT CMKR_EXECUTABLE AND EXISTS "${CMKR_CACHED_EXECUTABLE}")
|
||||||
|
set(CMKR_EXECUTABLE "${CMKR_CACHED_EXECUTABLE}" CACHE FILEPATH "Full path to cmkr executable" FORCE)
|
||||||
|
message(STATUS "[cmkr] Found cached cmkr: '${CMKR_EXECUTABLE}'")
|
||||||
else()
|
else()
|
||||||
set(CMKR_EXECUTABLE "${CMKR_CACHED_EXECUTABLE}" CACHE FILEPATH "Full path to cmkr executable" FORCE)
|
set(CMKR_EXECUTABLE "${CMKR_CACHED_EXECUTABLE}" CACHE FILEPATH "Full path to cmkr executable" FORCE)
|
||||||
message(VERBOSE "[cmkr] Bootstrapping '${CMKR_EXECUTABLE}'")
|
message(VERBOSE "[cmkr] Bootstrapping '${CMKR_EXECUTABLE}'")
|
||||||
@@ -76,23 +141,34 @@ else()
|
|||||||
${CMKR_REPO}
|
${CMKR_REPO}
|
||||||
"${CMKR_DIRECTORY}"
|
"${CMKR_DIRECTORY}"
|
||||||
)
|
)
|
||||||
message(STATUS "[cmkr] Building cmkr...")
|
if(CMKR_COMMIT_HASH)
|
||||||
|
execute_process(
|
||||||
|
COMMAND "${GIT_EXECUTABLE}" checkout -q "${CMKR_COMMIT_HASH}"
|
||||||
|
RESULT_VARIABLE CMKR_EXEC_RESULT
|
||||||
|
WORKING_DIRECTORY "${CMKR_DIRECTORY}"
|
||||||
|
)
|
||||||
|
if(NOT CMKR_EXEC_RESULT EQUAL 0)
|
||||||
|
message(FATAL_ERROR "Tag '${CMKR_TAG}' hash is not '${CMKR_COMMIT_HASH}'")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
message(STATUS "[cmkr] Building cmkr (using system compiler)...")
|
||||||
cmkr_exec("${CMAKE_COMMAND}"
|
cmkr_exec("${CMAKE_COMMAND}"
|
||||||
--no-warn-unused-cli
|
--no-warn-unused-cli
|
||||||
"${CMKR_DIRECTORY}"
|
"${CMKR_DIRECTORY}"
|
||||||
"-B${CMKR_DIRECTORY}/build"
|
"-B${CMKR_DIRECTORY}/build"
|
||||||
"-DCMAKE_BUILD_TYPE=Release"
|
"-DCMAKE_BUILD_TYPE=${CMKR_BUILD_TYPE}"
|
||||||
|
"-DCMAKE_UNITY_BUILD=ON"
|
||||||
"-DCMAKE_INSTALL_PREFIX=${CMKR_DIRECTORY}"
|
"-DCMAKE_INSTALL_PREFIX=${CMKR_DIRECTORY}"
|
||||||
"-DCMKR_GENERATE_DOCUMENTATION=OFF"
|
"-DCMKR_GENERATE_DOCUMENTATION=OFF"
|
||||||
)
|
)
|
||||||
cmkr_exec("${CMAKE_COMMAND}"
|
cmkr_exec("${CMAKE_COMMAND}"
|
||||||
--build "${CMKR_DIRECTORY}/build"
|
--build "${CMKR_DIRECTORY}/build"
|
||||||
--config Release
|
--config "${CMKR_BUILD_TYPE}"
|
||||||
--parallel
|
--parallel
|
||||||
)
|
)
|
||||||
cmkr_exec("${CMAKE_COMMAND}"
|
cmkr_exec("${CMAKE_COMMAND}"
|
||||||
--install "${CMKR_DIRECTORY}/build"
|
--install "${CMKR_DIRECTORY}/build"
|
||||||
--config Release
|
--config "${CMKR_BUILD_TYPE}"
|
||||||
--prefix "${CMKR_DIRECTORY}"
|
--prefix "${CMKR_DIRECTORY}"
|
||||||
--component cmkr
|
--component cmkr
|
||||||
)
|
)
|
||||||
@@ -109,6 +185,29 @@ if(NOT CMKR_EXEC_RESULT EQUAL 0)
|
|||||||
message(FATAL_ERROR "[cmkr] Failed to get version, try clearing the cache and rebuilding")
|
message(FATAL_ERROR "[cmkr] Failed to get version, try clearing the cache and rebuilding")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
# Use cmkr.cmake as a script
|
||||||
|
if(CMAKE_SCRIPT_MODE_FILE)
|
||||||
|
if(NOT EXISTS "${CMAKE_SOURCE_DIR}/cmake.toml")
|
||||||
|
execute_process(COMMAND "${CMKR_EXECUTABLE}" init
|
||||||
|
RESULT_VARIABLE CMKR_EXEC_RESULT
|
||||||
|
)
|
||||||
|
if(NOT CMKR_EXEC_RESULT EQUAL 0)
|
||||||
|
message(FATAL_ERROR "[cmkr] Failed to bootstrap cmkr project. Please report an issue: https://github.com/build-cpp/cmkr/issues/new")
|
||||||
|
else()
|
||||||
|
message(STATUS "[cmkr] Modify cmake.toml and then configure using: cmake -B build")
|
||||||
|
endif()
|
||||||
|
else()
|
||||||
|
execute_process(COMMAND "${CMKR_EXECUTABLE}" gen
|
||||||
|
RESULT_VARIABLE CMKR_EXEC_RESULT
|
||||||
|
)
|
||||||
|
if(NOT CMKR_EXEC_RESULT EQUAL 0)
|
||||||
|
message(FATAL_ERROR "[cmkr] Failed to generate project.")
|
||||||
|
else()
|
||||||
|
message(STATUS "[cmkr] Configure using: cmake -B build")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
|
||||||
# This is the macro that contains black magic
|
# This is the macro that contains black magic
|
||||||
macro(cmkr)
|
macro(cmkr)
|
||||||
# When this macro is called from the generated file, fake some internal CMake variables
|
# When this macro is called from the generated file, fake some internal CMake variables
|
||||||
|
|||||||
@@ -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()
|
||||||
@@ -1,21 +1,21 @@
|
|||||||
option(CMKR_GENERATE_DOCUMENTATION "Generate cmkr documentation" ${CMKR_ROOT_PROJECT})
|
option(CMKR_GENERATE_DOCUMENTATION "Generate cmkr documentation" ${CMKR_ROOT_PROJECT})
|
||||||
set(CMKR_TESTS "" CACHE INTERNAL "List of test directories in the order declared in tests/cmake.toml")
|
|
||||||
|
|
||||||
if(CMKR_GENERATE_DOCUMENTATION)
|
|
||||||
# Hook the add_test function to capture the tests in the order declared in tests/cmake.toml
|
|
||||||
function(add_test)
|
|
||||||
cmake_parse_arguments(TEST "" "WORKING_DIRECTORY" "" ${ARGN})
|
|
||||||
get_filename_component(TEST_WORKING_DIRECTORY "${TEST_WORKING_DIRECTORY}" NAME)
|
|
||||||
list(APPEND CMKR_TESTS "${TEST_WORKING_DIRECTORY}")
|
|
||||||
set(CMKR_TESTS "${CMKR_TESTS}" CACHE INTERNAL "")
|
|
||||||
_add_test(${test} ${ARGN})
|
|
||||||
endfunction()
|
|
||||||
endif()
|
|
||||||
|
|
||||||
function(generate_documentation)
|
function(generate_documentation)
|
||||||
if(CMKR_GENERATE_DOCUMENTATION)
|
if(CMKR_GENERATE_DOCUMENTATION)
|
||||||
message(STATUS "[cmkr] Generating documentation...")
|
message(STATUS "[cmkr] Generating documentation...")
|
||||||
|
|
||||||
|
# Extract the order of the tests
|
||||||
|
set(CMKR_TESTS "")
|
||||||
|
file(READ "${PROJECT_SOURCE_DIR}/tests/cmake.toml" tests_toml NO_HEX_CONVERSION)
|
||||||
|
string(REGEX MATCHALL "working-directory = \"([^\"]+)\"" tests_match "${tests_toml}")
|
||||||
|
foreach(match ${tests_match})
|
||||||
|
if(match MATCHES "working-directory = \"([^\"]+)\"")
|
||||||
|
list(APPEND CMKR_TESTS "${CMAKE_MATCH_1}")
|
||||||
|
else()
|
||||||
|
message(FATAL_ERROR "This should not happen (wrong regex?)")
|
||||||
|
endif()
|
||||||
|
endforeach()
|
||||||
|
|
||||||
# Delete previously generated examples
|
# Delete previously generated examples
|
||||||
set(example_folder "${PROJECT_SOURCE_DIR}/docs/examples")
|
set(example_folder "${PROJECT_SOURCE_DIR}/docs/examples")
|
||||||
file(GLOB example_files "${example_folder}/*.md")
|
file(GLOB example_files "${example_folder}/*.md")
|
||||||
@@ -46,14 +46,14 @@ function(generate_documentation)
|
|||||||
string(REGEX MATCH "^(\n*(#[^\n]+\n)+\n*)" EXAMPLE_HEADER "${test_contents}")
|
string(REGEX MATCH "^(\n*(#[^\n]+\n)+\n*)" EXAMPLE_HEADER "${test_contents}")
|
||||||
string(LENGTH "${EXAMPLE_HEADER}" header_length)
|
string(LENGTH "${EXAMPLE_HEADER}" header_length)
|
||||||
string(STRIP "${EXAMPLE_HEADER}" EXAMPLE_HEADER)
|
string(STRIP "${EXAMPLE_HEADER}" EXAMPLE_HEADER)
|
||||||
string(REGEX REPLACE "\n# ?" "\n" EXAMPLE_HEADER "\n${EXAMPLE_HEADER}")
|
string(REGEX REPLACE "\n# ?" "\n\n" EXAMPLE_HEADER "\n${EXAMPLE_HEADER}")
|
||||||
string(STRIP "${EXAMPLE_HEADER}" EXAMPLE_HEADER)
|
string(STRIP "${EXAMPLE_HEADER}" EXAMPLE_HEADER)
|
||||||
|
|
||||||
# Extract footer text
|
# Extract footer text
|
||||||
string(REGEX MATCH "(((#[^\n]+)(\n+|$))+)$" EXAMPLE_FOOTER "${test_contents}")
|
string(REGEX MATCH "(((#[^\n]+)(\n+|$))+)$" EXAMPLE_FOOTER "${test_contents}")
|
||||||
string(LENGTH "${EXAMPLE_FOOTER}" footer_length)
|
string(LENGTH "${EXAMPLE_FOOTER}" footer_length)
|
||||||
string(STRIP "${EXAMPLE_FOOTER}" EXAMPLE_FOOTER)
|
string(STRIP "${EXAMPLE_FOOTER}" EXAMPLE_FOOTER)
|
||||||
string(REGEX REPLACE "\n# ?" "\n" EXAMPLE_FOOTER "\n${EXAMPLE_FOOTER}")
|
string(REGEX REPLACE "\n# ?" "\n\n" EXAMPLE_FOOTER "\n${EXAMPLE_FOOTER}")
|
||||||
string(STRIP "${EXAMPLE_FOOTER}" EXAMPLE_FOOTER)
|
string(STRIP "${EXAMPLE_FOOTER}" EXAMPLE_FOOTER)
|
||||||
|
|
||||||
# Extract toml body
|
# Extract toml body
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# 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})
|
||||||
|
get_filename_component(RESOURCE_NAME "${SOURCE}" NAME_WE)
|
||||||
|
set(RESOURCE_HEADER "include/resources/${RESOURCE_NAME}.hpp")
|
||||||
|
|
||||||
|
if(SOURCE MATCHES ".cmake$")
|
||||||
|
# Add configure-time dependency on the source file
|
||||||
|
configure_file("${SOURCE}" "${RESOURCE_HEADER}" COPYONLY)
|
||||||
|
# Generate the actual resource into the header
|
||||||
|
file(READ "${SOURCE}" RESOURCE_CONTENTS)
|
||||||
|
configure_file("${PROJECT_SOURCE_DIR}/cmake/resource.hpp.in" "${RESOURCE_HEADER}" @ONLY)
|
||||||
|
message(STATUS "[cmkr] Generated ${RESOURCE_HEADER}")
|
||||||
|
elseif(SOURCE MATCHES ".in$")
|
||||||
|
configure_file("${SOURCE}" "${RESOURCE_HEADER}" @ONLY)
|
||||||
|
message(STATUS "[cmkr] Generated ${RESOURCE_HEADER}")
|
||||||
|
endif()
|
||||||
|
endforeach()
|
||||||
|
target_include_directories(${target} PUBLIC "${CMAKE_CURRENT_BINARY_DIR}/include")
|
||||||
|
endfunction()
|
||||||
@@ -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
|
||||||
|
)
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
namespace cmkr {
|
||||||
|
namespace resources {
|
||||||
|
|
||||||
|
static const char* @RESOURCE_NAME@ = R"RESOURCE(@RESOURCE_CONTENTS@)RESOURCE";
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#define CMKR_VERSION "@PROJECT_VERSION@"
|
||||||
@@ -1,2 +1,3 @@
|
|||||||
_site/
|
_site/
|
||||||
.jekyll-metadata
|
.jekyll-metadata
|
||||||
|
assets/
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
cmkr.build
|
||||||
@@ -3,6 +3,7 @@ gem "minima", "~> 2.5"
|
|||||||
gem "github-pages", group: :jekyll_plugins
|
gem "github-pages", group: :jekyll_plugins
|
||||||
|
|
||||||
gem "jekyll-remote-theme"
|
gem "jekyll-remote-theme"
|
||||||
|
gem "jekyll-sitemap", "~> 1.4.0"
|
||||||
|
|
||||||
platforms :mingw, :x64_mingw, :mswin, :jruby do
|
platforms :mingw, :x64_mingw, :mswin, :jruby do
|
||||||
gem "tzinfo", "~> 1.2"
|
gem "tzinfo", "~> 1.2"
|
||||||
@@ -11,3 +12,5 @@ end
|
|||||||
|
|
||||||
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
|
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
|
||||||
gem "just-the-docs"
|
gem "just-the-docs"
|
||||||
|
|
||||||
|
gem "webrick", "~> 1.7"
|
||||||
|
|||||||
+4
-1
@@ -262,6 +262,7 @@ GEM
|
|||||||
unf_ext
|
unf_ext
|
||||||
unf_ext (0.0.7.7)
|
unf_ext (0.0.7.7)
|
||||||
unicode-display_width (1.7.0)
|
unicode-display_width (1.7.0)
|
||||||
|
webrick (1.7.0)
|
||||||
zeitwerk (2.4.2)
|
zeitwerk (2.4.2)
|
||||||
|
|
||||||
PLATFORMS
|
PLATFORMS
|
||||||
@@ -270,11 +271,13 @@ PLATFORMS
|
|||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
github-pages
|
github-pages
|
||||||
jekyll-remote-theme
|
jekyll-remote-theme
|
||||||
|
jekyll-sitemap (~> 1.4.0)
|
||||||
just-the-docs
|
just-the-docs
|
||||||
minima (~> 2.5)
|
minima (~> 2.5)
|
||||||
tzinfo (~> 1.2)
|
tzinfo (~> 1.2)
|
||||||
tzinfo-data
|
tzinfo-data
|
||||||
wdm (~> 0.1.1)
|
wdm (~> 0.1.1)
|
||||||
|
webrick (~> 1.7)
|
||||||
|
|
||||||
BUNDLED WITH
|
BUNDLED WITH
|
||||||
2.1.2
|
2.2.26
|
||||||
|
|||||||
+22
-1
@@ -2,6 +2,7 @@ title: cmkr
|
|||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
- jekyll-remote-theme
|
- jekyll-remote-theme
|
||||||
|
- jekyll-sitemap
|
||||||
|
|
||||||
# Automatically deduce dark theme preference https://github.com/pmarsceill/just-the-docs/pull/464
|
# Automatically deduce dark theme preference https://github.com/pmarsceill/just-the-docs/pull/464
|
||||||
remote_theme: build-cpp/just-the-docs@light-switch
|
remote_theme: build-cpp/just-the-docs@light-switch
|
||||||
@@ -9,7 +10,7 @@ search_enabled: true
|
|||||||
color_scheme: light-or-dark
|
color_scheme: light-or-dark
|
||||||
heading_anchors: true
|
heading_anchors: true
|
||||||
aux_links:
|
aux_links:
|
||||||
"cmkr":
|
"GitHub":
|
||||||
- "https://github.com/build-cpp/cmkr"
|
- "https://github.com/build-cpp/cmkr"
|
||||||
aux_links_new_tab: true
|
aux_links_new_tab: true
|
||||||
|
|
||||||
@@ -19,3 +20,23 @@ gh_edit_repository: "https://github.com/build-cpp/cmkr"
|
|||||||
gh_edit_branch: "main"
|
gh_edit_branch: "main"
|
||||||
gh_edit_view_mode: "edit"
|
gh_edit_view_mode: "edit"
|
||||||
gh_edit_source: docs
|
gh_edit_source: docs
|
||||||
|
|
||||||
|
ga_tracking: G-DY172KY7Z9
|
||||||
|
|
||||||
|
production_url : https://cmkr.build
|
||||||
|
footer_content: |
|
||||||
|
<script src="https://giscus.app/client.js"
|
||||||
|
data-repo="build-cpp/cmkr"
|
||||||
|
data-repo-id="MDEwOlJlcG9zaXRvcnkyOTQwMDc3MzY="
|
||||||
|
data-category="Documentation"
|
||||||
|
data-category-id="DIC_kwDOEYYzuM4CTXeA"
|
||||||
|
data-mapping="pathname"
|
||||||
|
data-strict="1"
|
||||||
|
data-reactions-enabled="1"
|
||||||
|
data-emit-metadata="0"
|
||||||
|
data-input-position="top"
|
||||||
|
data-theme="preferred_color_scheme"
|
||||||
|
data-lang="en"
|
||||||
|
crossorigin="anonymous"
|
||||||
|
async>
|
||||||
|
</script>
|
||||||
+143
@@ -0,0 +1,143 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: Basics
|
||||||
|
nav_order: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Basics
|
||||||
|
|
||||||
|
To effectively use cmkr it helps to understand the basic concepts of CMake. This page serves as an introduction to CMake for beginners. Links to the CMake documentation are included for reference.
|
||||||
|
|
||||||
|
## Projects
|
||||||
|
|
||||||
|
A CMake **project** is a collection of targets. In the context of libraries the project usually corresponds to the **package** that other projects can depend on.
|
||||||
|
|
||||||
|
<sub>Visual Studio: a CMake **project** corresponds to a _solution_.</sub>
|
||||||
|
|
||||||
|
## Targets
|
||||||
|
|
||||||
|
The basic unit of CMake is called a **target**. A target (also referred to as [binary target](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#binary-targets) in the CMake documentation) corresponds to an executable or static/dynamic library you can build.
|
||||||
|
|
||||||
|
<sub>Visual Studio: a **target** corresponds to a _project_.</sub>
|
||||||
|
|
||||||
|
Most important target types:
|
||||||
|
|
||||||
|
|Type|Purpose|
|
||||||
|
|-|-|
|
||||||
|
|Executable|Program you run on your computer (`.exe`)|
|
||||||
|
|Static library|Library code _compiled into_ the final executable (`.lib`, `.a`)|
|
||||||
|
|Dynamic library|Library code loaded at runtime (`.dll`, `.so`, `.dylib`)|
|
||||||
|
|Interface|Used for organizational purposes (common flags/includes/libraries)|
|
||||||
|
|
||||||
|
There are also other [pseudo targets](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#pseudo-targets), but they are not important for now.
|
||||||
|
|
||||||
|
## Target Properties
|
||||||
|
|
||||||
|
Targets have a collection of **properties** that describe how the compiler builds them.
|
||||||
|
|
||||||
|
The most commonly-used properties:
|
||||||
|
|
||||||
|
- [_Sources_](https://cmake.org/cmake/help/latest/command/target_sources.html): the `*.cpp` files used to build the target.
|
||||||
|
- [_Include directories_](https://cmake.org/cmake/help/latest/command/target_include_directories.html): Paths to directories the compiler will search when doing `#include`.
|
||||||
|
- [_Compile definitions_](https://cmake.org/cmake/help/latest/command/target_compile_definitions.html): Preprocessor macro definitions used for compilation (`-DMYOPTION`).
|
||||||
|
- [_Compile options_](https://cmake.org/cmake/help/latest/command/target_compile_options.html): Command line flags for the compiler (platform/compiler specific).
|
||||||
|
- [_Compile features_](https://cmake.org/cmake/help/latest/command/target_compile_features.html): C/C++ standard version to build with.
|
||||||
|
- [_Link libraries_](https://cmake.org/cmake/help/latest/command/target_link_libraries.html): The **dependencies** required to build this target.
|
||||||
|
- [_Link options_](https://cmake.org/cmake/help/latest/command/target_link_options.html): Command line flags for the linker (platform/linker specific).
|
||||||
|
|
||||||
|
<sub>See the [CMake documentation](https://cmake.org/cmake/help/latest/manual/cmake-properties.7.html#properties-on-targets) for an exhaustive list of target properties.</sub>
|
||||||
|
|
||||||
|
**Important**: The term **link** has a slightly different meaning in CMake than you might expect. In addition to adding a library to the command line, CMake also (transitively) propagates properties of the target you link to based on their _visibility_.
|
||||||
|
|
||||||
|
You should think of **linking** in CMake as _depending on_.
|
||||||
|
{:.info}
|
||||||
|
|
||||||
|
The propagation of properties depends on their **visibility**:
|
||||||
|
|
||||||
|
- **Private**: properties that are only used when building the target itself.
|
||||||
|
- **Interface**: properties that are used when depending on this target.
|
||||||
|
- **Public**: combination of private and interface.
|
||||||
|
|
||||||
|
In practice you default to **private**, unless consumers of your library _require_ the property to build their target. In that case you use **public**.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
The most intuitive example is with _include directories_. Imagine there are two targets:
|
||||||
|
|
||||||
|
1. `StringUtils`: A library with string utilities.
|
||||||
|
- _Sources_: `StringUtils/src/stringutils.cpp`
|
||||||
|
- _Include directories_: `StringUtils/include`
|
||||||
|
2. `DataProcessor`: An executable that uses functionality from `StringUtils` to process some data.
|
||||||
|
- _Sources_: `DataProcessor/src/main.cpp`
|
||||||
|
- _Link libraries_: `StringUtils`
|
||||||
|
|
||||||
|
The _include directories_ property of `StringUtils` has to be **public**. If it was **private**, the `DataProcessor` target would fail to `#include <stringutils.hpp>` since the _include directories_ property is not propagated.
|
||||||
|
|
||||||
|
The `cmake.toml` for this example would look something like this:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
name = "DataProcessor"
|
||||||
|
|
||||||
|
[target.StringUtils]
|
||||||
|
type = "static"
|
||||||
|
sources = ["StringUtils/src/stringutils.cpp"]
|
||||||
|
headers = ["StringUtils/include/stringutils.hpp"]
|
||||||
|
include-directories = ["StringUtils/include"] # public (default for libraries)
|
||||||
|
|
||||||
|
[target.DataProcessor]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["DataProcessor/src/main.cpp"]
|
||||||
|
link-libraries = ["StringUtils"] # private (default for executables)
|
||||||
|
```
|
||||||
|
|
||||||
|
The generated `CMakeLists.txt` (simplified) looks like this:
|
||||||
|
|
||||||
|
```cmake
|
||||||
|
project(DataProcessor)
|
||||||
|
|
||||||
|
# Target: StringUtils
|
||||||
|
add_library(StringUtils STATIC
|
||||||
|
"StringUtils/include/stringutils.hpp"
|
||||||
|
"StringUtils/src/stringutils.cpp"
|
||||||
|
)
|
||||||
|
target_include_directories(StringUtils PUBLIC
|
||||||
|
"StringUtils/include"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Target: DataProcessor
|
||||||
|
add_executable(DataProcessor
|
||||||
|
"DataProcessor/src/main.cpp"
|
||||||
|
)
|
||||||
|
target_link_libraries(DataProcessor PRIVATE
|
||||||
|
StringUtils
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
## CMake Phases
|
||||||
|
|
||||||
|
CMake works in three phases:
|
||||||
|
1. **Configure**: Execute `CMakeLists.txt` (find dependencies, create targets, OS/compiler-specific conditions, etc).
|
||||||
|
2. **Generate**: Generate build files (propagates target properties and handles [_generator expressions_](https://cmake.org/cmake/help/latest/manual/cmake-generator-expressions.7.html)).
|
||||||
|
3. **Build**: Execute the compiler to produce executables/libraries.
|
||||||
|
|
||||||
|
CMake keeps generated files separate from your source in a **build directory**. You specify a [**generator**](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html) (Visual Studio/Ninja) and [**build type**](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#build-configurations) (Debug/Release) during configuration.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Configure project and generate build files in build directory
|
||||||
|
cmake -B build -DCMAKE_BUILD_TYPE=Release
|
||||||
|
|
||||||
|
# Build the project
|
||||||
|
cmake --build build --config Release
|
||||||
|
```
|
||||||
|
|
||||||
|
We specify both `CMAKE_BUILD_TYPE` and `--config` to be compatible with generators that support multiple configurations at once ((like Visual Studio/Xcode/Ninja Multi-Config).
|
||||||
|
{:.info}
|
||||||
|
|
||||||
|
**Build Types**:
|
||||||
|
- `Debug`: No optimization, debug symbols
|
||||||
|
- `Release`: Full optimization, no debug symbols
|
||||||
|
- `RelWithDebInfo`: Medium optimizations, debug symbols
|
||||||
|
- `MinSizeRel`: Optimize for size, no debug symbols
|
||||||
|
|
||||||
|
**Generators**: CMake auto-detects (Makefiles on Linux/macOS, Visual Studio on Windows), but you can specify explicitly with `-G` during the _configure_ step.
|
||||||
@@ -0,0 +1,345 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: Reference
|
||||||
|
permalink: /cmake-toml/
|
||||||
|
nav_order: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Reference
|
||||||
|
|
||||||
|
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 is a reference page. Check out the [examples](/examples) and the [cmkr topic](https://github.com/topics/cmkr) as well.
|
||||||
|
{:.info}
|
||||||
|
|
||||||
|
## CMake configuration
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[cmake]
|
||||||
|
version = "3.15"
|
||||||
|
cmkr-include = "cmkr.cmake"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Project configuration
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
name = "myproject"
|
||||||
|
version = "1.0.0"
|
||||||
|
description = "Description of the project"
|
||||||
|
languages = ["C", "CXX"]
|
||||||
|
msvc-runtime = "" # dynamic (implicit default), static
|
||||||
|
cmake-before = """
|
||||||
|
message(STATUS "CMake injected before the project() call")
|
||||||
|
"""
|
||||||
|
cmake-after = """
|
||||||
|
message(STATUS "CMake injected after the project() call")
|
||||||
|
"""
|
||||||
|
include-before = ["cmake/before-project.cmake"]
|
||||||
|
include-after = ["cmake/after-project.cmake"]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Languages
|
||||||
|
|
||||||
|
Supported languages are (see [`enable_language`](https://cmake.org/cmake/help/latest/command/enable_language.html) for more information):
|
||||||
|
|
||||||
|
- `C`
|
||||||
|
- `CXX` → C++
|
||||||
|
- `CSharp` → C#
|
||||||
|
- `CUDA`
|
||||||
|
- `OBJC` → Objective-C
|
||||||
|
- `OBJCXX` → Objective-C++
|
||||||
|
- `Fortran`
|
||||||
|
- `HIP`
|
||||||
|
- `ISPC`
|
||||||
|
- `Swift`
|
||||||
|
- `ASM`
|
||||||
|
- `ASM_MASM` → [Microsoft Macro Assembler (MASM)](https://learn.microsoft.com/en-US/cpp/assembler/masm/masm-for-x64-ml64-exe)
|
||||||
|
- `ASM_NASM` → [Netwide Assembler (NASM)](https://www.nasm.us)
|
||||||
|
- `ASM_MARMASM` [Microsoft ARM Assembler](https://learn.microsoft.com/en-us/cpp/assembler/arm/arm-assembler-command-line-reference)
|
||||||
|
- `ASM-ATT`
|
||||||
|
- `Java` (undocumented)
|
||||||
|
- `RC` (undocumented)
|
||||||
|
|
||||||
|
After a language is enabled, adding sources files with the corresponding extension to your target will automatically use the appropriate compiler/assembler for it.
|
||||||
|
|
||||||
|
_Note_: It is generally discouraged to disable the `C` language, unless you are absolutely sure it is not used. Sometimes projects added with `fetch-content` implicitly require it and the error messages can be extremely confusing.
|
||||||
|
|
||||||
|
## Conditions
|
||||||
|
|
||||||
|
You can specify your own named conditions and use them in any `condition` field:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[conditions]
|
||||||
|
ptr64 = "CMAKE_SIZEOF_VOID_P EQUAL 8"
|
||||||
|
ptr32 = "CMAKE_SIZEOF_VOID_P EQUAL 4"
|
||||||
|
```
|
||||||
|
|
||||||
|
This will make the `ptr64` and `ptr32` conditions available with their respective CMake expressions.
|
||||||
|
|
||||||
|
**Note**: condition names can only contain lower-case alphanumeric characters (`[0-9a-z]`) and dashes (`-`).
|
||||||
|
|
||||||
|
You can also prefix most keys with `condition.` to represent a conditional:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[target]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
ptr64.sources = ["src/ptr64_only.cpp"]
|
||||||
|
```
|
||||||
|
|
||||||
|
Instead of a named condition you can also specify a [CMake expression](https://cmake.org/cmake/help/latest/command/if.html#condition-syntax) in quotes. Instances of `$<name>` are replaced with the corresponding condition. For example: `"CONDITIONS_BUILD_TESTS AND $<linux>"` becomes `CONDITIONS_BUILD_TESTS AND (CMAKE_SYSTEM_NAME MATCHES "Linux")` in the final `CMakeLists.txt` file.
|
||||||
|
|
||||||
|
### Predefined conditions
|
||||||
|
|
||||||
|
The following conditions are predefined (you can override them if you desire):
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[conditions]
|
||||||
|
windows = "WIN32"
|
||||||
|
macos = "CMAKE_SYSTEM_NAME MATCHES \"Darwin\""
|
||||||
|
unix = "UNIX"
|
||||||
|
bsd = "CMAKE_SYSTEM_NAME MATCHES \"BSD\""
|
||||||
|
linux = "CMAKE_SYSTEM_NAME MATCHES \"Linux\""
|
||||||
|
gcc = "CMAKE_CXX_COMPILER_ID STREQUAL \"GNU\" OR CMAKE_C_COMPILER_ID STREQUAL \"GNU\""
|
||||||
|
msvc = "MSVC"
|
||||||
|
clang = "(CMAKE_CXX_COMPILER_ID MATCHES \"Clang\" AND NOT CMAKE_CXX_COMPILER_FRONTEND_VARIANT MATCHES \"^MSVC$\") OR (CMAKE_C_COMPILER_ID MATCHES \"Clang\" AND NOT CMAKE_C_COMPILER_FRONTEND_VARIANT MATCHES \"^MSVC$\")"
|
||||||
|
clang-cl = "(CMAKE_CXX_COMPILER_ID MATCHES \"Clang\" AND CMAKE_CXX_COMPILER_FRONTEND_VARIANT MATCHES \"^MSVC$\") OR (CMAKE_C_COMPILER_ID MATCHES \"Clang\" AND CMAKE_C_COMPILER_FRONTEND_VARIANT MATCHES \"^MSVC$\")"
|
||||||
|
clang-any = "CMAKE_CXX_COMPILER_ID MATCHES \"Clang\" OR CMAKE_C_COMPILER_ID MATCHES \"Clang\""
|
||||||
|
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
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[subdir.mysubdir]
|
||||||
|
condition = "mycondition"
|
||||||
|
cmake-before = """
|
||||||
|
message(STATUS "CMake injected before the add_subdirectory() call"
|
||||||
|
"""
|
||||||
|
cmake-after = """
|
||||||
|
message(STATUS "CMake injected after the add_subdirectory() call")
|
||||||
|
"""
|
||||||
|
include-before = ["cmake/before-subdir.cmake"]
|
||||||
|
include-after = ["cmake/after-subdir.cmake"]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[options]
|
||||||
|
MYPROJECT_BUILD_TESTS = false
|
||||||
|
MYPROJECT_SPECIAL_OPTION = { value = true, help = "Docstring for this option." }
|
||||||
|
MYPROJECT_BUILD_EXAMPLES = "root"
|
||||||
|
```
|
||||||
|
|
||||||
|
Options correspond to [CMake cache variables](https://cmake.org/cmake/help/book/mastering-cmake/chapter/CMake%20Cache.html) that can be used to customize your project at configure-time. You can configure with `cmake -DMYPROJECT_BUILD_TESTS=ON` to enable the option. Every option automatically gets a corresponding [condition](#conditions). Additionally, a normalized condition is created based on the `[project].name` (i.e. `MYPROJECT_BUILD_TESTS` becomes `build-tests`).
|
||||||
|
|
||||||
|
The special value `root` can be used to set the option to `true` if the project is compiled as the root project (it will be `false` if someone is including your project via `[fetch-content]` or `[subdir]`).
|
||||||
|
|
||||||
|
## 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
|
||||||
|
[vcpkg]
|
||||||
|
version = "2024.11.16"
|
||||||
|
url = "https://github.com/microsoft/vcpkg/archive/refs/tags/2024.11.16.tar.gz"
|
||||||
|
packages = ["fmt", "zlib"]
|
||||||
|
overlay-ports = ["my-ports"]
|
||||||
|
overlay-triplets = ["my-triplets"]
|
||||||
|
```
|
||||||
|
|
||||||
|
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) or [vcpkg.link](https://vcpkg.link).
|
||||||
|
|
||||||
|
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). The `overlay-triplets` feature allows you to customize triplets and change the default behavior (for example always preferring static libraries on Windows). To specify both in one go you can do `[vcpkg].overlay = "vcpkg-overlay"`.
|
||||||
|
|
||||||
|
For a concrete example of all the features, take a look at the [vcpkg_template](https://github.com/build-cpp/vcpkg_template) repository.
|
||||||
|
|
||||||
|
## Packages
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[find-package.mypackage]
|
||||||
|
condition = "mycondition"
|
||||||
|
version = "1.0"
|
||||||
|
required = true
|
||||||
|
config = true
|
||||||
|
components = ["mycomponent"]
|
||||||
|
```
|
||||||
|
|
||||||
|
## FetchContent
|
||||||
|
|
||||||
|
**Note**: The `[fetch-content]` feature is unpolished and will likely change in a future release.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# Include CMake project from git
|
||||||
|
[fetch-content.gitcontent]
|
||||||
|
condition = "mycondition"
|
||||||
|
git = "https://github.com/myuser/gitcontent"
|
||||||
|
tag = "v0.1"
|
||||||
|
shallow = false # shallow clone (--depth 1)
|
||||||
|
system = false
|
||||||
|
subdir = "" # folder containing CMakeLists.txt
|
||||||
|
|
||||||
|
# Include a CMake project from a URL
|
||||||
|
[fetch-content.urlcontent]
|
||||||
|
condition = "mycondition"
|
||||||
|
url = "https://content-host.com/urlcontent.zip"
|
||||||
|
# Other supported algorithms:
|
||||||
|
# md5, sha1, sha224, sha256, sha384, sha512, sha3_224, sha3_256, sha3_384, sha3_512
|
||||||
|
hash = "SHA1 502a4e25b8b209889c99c7fa0732102682c2e4ff"
|
||||||
|
sha1 = "502a4e25b8b209889c99c7fa0732102682c2e4ff"
|
||||||
|
|
||||||
|
[fetch-content.svncontent]
|
||||||
|
condition = "mycondition"
|
||||||
|
svn = "https://svn-host.com/url"
|
||||||
|
rev = "svn_rev"
|
||||||
|
```
|
||||||
|
|
||||||
|
Table keys that match CMake variable names (`[A-Z_]+`) will be passed to the [`FetchContent_Declare`](https://cmake.org/cmake/help/latest/module/FetchContent.html#command:fetchcontent_declare) command.
|
||||||
|
|
||||||
|
## Targets
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[target.mytarget]
|
||||||
|
condition = "mycondition"
|
||||||
|
alias = "mytarget::mytarget"
|
||||||
|
type = "static" # executable, library, shared (DLL), static, interface, object, custom
|
||||||
|
headers = ["src/mytarget.h"]
|
||||||
|
sources = ["src/mytarget.cpp"]
|
||||||
|
msvc-runtime = "" # dynamic (implicit default), static
|
||||||
|
|
||||||
|
# The keys below match the target_xxx CMake commands
|
||||||
|
# Keys prefixed with private- will get PRIVATE visibility
|
||||||
|
compile-definitions = [""] # preprocessor define (-DFOO)
|
||||||
|
private-compile-definitions = [""]
|
||||||
|
compile-features = [""] # C++ standard version (cxx_std_20)
|
||||||
|
private-compile-features = [""]
|
||||||
|
compile-options = [""] # compiler flags
|
||||||
|
private-compile-options = [""]
|
||||||
|
include-directories = [""] # include paths/directories
|
||||||
|
private-include-directories = [""]
|
||||||
|
link-directories = [""] # library directories
|
||||||
|
private-link-directories = [""]
|
||||||
|
link-libraries = [""] # dependencies
|
||||||
|
private-link-libraries = [""]
|
||||||
|
link-options = [""] # linker flags
|
||||||
|
private-link-options = [""]
|
||||||
|
precompile-headers = [""] # precompiled headers
|
||||||
|
private-precompile-headers = [""]
|
||||||
|
|
||||||
|
cmake-before = """
|
||||||
|
message(STATUS "CMake injected before the target")
|
||||||
|
"""
|
||||||
|
cmake-after = """
|
||||||
|
message(STATUS "CMake injected after the target")
|
||||||
|
"""
|
||||||
|
include-before = "cmake/target-before.cmake"
|
||||||
|
include-after = "cmake/target-after.cmake"
|
||||||
|
|
||||||
|
# See https://cmake.org/cmake/help/latest/manual/cmake-properties.7.html#properties-on-targets for a list of target properties
|
||||||
|
[target.mytarget.properties]
|
||||||
|
CXX_STANDARD = 17
|
||||||
|
CXX_STANDARD_REQUIRED = true
|
||||||
|
FOLDER = "MyFolder"
|
||||||
|
```
|
||||||
|
|
||||||
|
A table mapping the cmkr features to the relevant CMake construct and the relevant documentation pages:
|
||||||
|
|
||||||
|
| cmkr | CMake construct | Description |
|
||||||
|
| ---- | ----- | ----------- |
|
||||||
|
| `alias` | [Alias Libraries](https://cmake.org/cmake/help/latest/command/add_library.html#alias-libraries) | Create an [alias target](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#alias-targets), used for namespacing or clarity. |
|
||||||
|
| `sources` | [`target_sources`](https://cmake.org/cmake/help/latest/command/target_sources.html) | Source files (`PRIVATE` except `interface` targets). |
|
||||||
|
| `headers` | [`target_sources`](https://cmake.org/cmake/help/latest/command/target_sources.html) | For readability (and future packaging). |
|
||||||
|
| `msvc-runtime` | [`MSVC_RUNTIME_LIBRARY`](https://cmake.org/cmake/help/latest/prop_tgt/MSVC_RUNTIME_LIBRARY.html) | The [CMP0091](https://cmake.org/cmake/help/latest/policy/CMP0091.html) policy is set automatically. |
|
||||||
|
| `compile-definitions` | [`target_compile_definitions`](https://cmake.org/cmake/help/latest/command/target_compile_definitions.html) | Adds a macro definition (define, `-DMYMACRO=XXX`). |
|
||||||
|
| `compile-features` | [`target_compile_features`](https://cmake.org/cmake/help/latest/command/target_compile_features.html) | Specifies the C++ standard version (`cxx_std_20`). |
|
||||||
|
| `compile-options` | [`target_compile_options`](https://cmake.org/cmake/help/latest/command/target_compile_options.html) | Adds compiler flags. |
|
||||||
|
| `include-directories` | [`target_include_directories`](https://cmake.org/cmake/help/latest/command/target_include_directories.html) | Adds include directories. |
|
||||||
|
| `link-directories` | [`target_link_directories`](https://cmake.org/cmake/help/latest/command/target_link_directories.html) | Adds library directories. |
|
||||||
|
| `link-libraries` | [`target_link_libraries`](https://cmake.org/cmake/help/latest/command/target_link_libraries.html) | Adds library dependencies. Use `::mylib` to make sure a target exists. |
|
||||||
|
| `link-options` | [`target_link_options`](https://cmake.org/cmake/help/latest/command/target_link_options.html) | Adds linker flags. |
|
||||||
|
| `precompile-headers` | [`target_precompile_headers`](https://cmake.org/cmake/help/latest/command/target_precompile_headers.html) | Specifies precompiled headers. |
|
||||||
|
| `properties` | [`set_target_properties`](https://cmake.org/cmake/help/latest/command/set_target_properties.html) | See [properties on targets](https://cmake.org/cmake/help/latest/manual/cmake-properties.7.html#properties-on-targets) for more information. |
|
||||||
|
|
||||||
|
The default [visibility](/basics) is as follows:
|
||||||
|
|
||||||
|
| Type | Visibility |
|
||||||
|
| ------------ | ----------- |
|
||||||
|
| `executable` | `PRIVATE` |
|
||||||
|
| `library` | `PUBLIC` |
|
||||||
|
| `shared` | `PUBLIC` |
|
||||||
|
| `static` | `PUBLIC` |
|
||||||
|
| `object` | `PUBLIC` |
|
||||||
|
| `interface` | `INTERFACE` |
|
||||||
|
|
||||||
|
## Templates
|
||||||
|
|
||||||
|
To avoid repeating yourself you can create your own target type and use it in your targets:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[template.example]
|
||||||
|
condition = "MYPROJECT_BUILD_EXAMPLES"
|
||||||
|
type = "executable"
|
||||||
|
link-libraries = ["myproject::mylib"]
|
||||||
|
add-function = ""
|
||||||
|
add-arguments = ["myoption"]
|
||||||
|
pass-sources = false
|
||||||
|
|
||||||
|
# Properties from the template are merged with the ones here
|
||||||
|
[target.myexample]
|
||||||
|
type = "example"
|
||||||
|
sources = ["src/myexample.cpp"]
|
||||||
|
```
|
||||||
|
|
||||||
|
The properties declared on a `template` are the same as the ones you use for targets. The only exceptions are:
|
||||||
|
|
||||||
|
- `add-function`: Specifies a custom add function. Projects like [pybind11](https://pybind11.readthedocs.io/en/stable/cmake/index.html#new-findpython-mode) have their own `add_xxx` function, which you can specify here.
|
||||||
|
- `add-arguments`: Arguments to pass to the `add-function` before the list of sources. See [cmake_parse_arguments](https://cmake.org/cmake/help/latest/command/cmake_parse_arguments.html) for more details.
|
||||||
|
- `pass-sources`: Pass sources directly to the add function instead of using `target_sources`.
|
||||||
|
|
||||||
|
## Tests and installation (unfinished)
|
||||||
|
|
||||||
|
**Note**: The `[[test]]` and `[[install]]` are unfinished features and will likely change in a future release.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# You can declare as many as you want like this, but the name has to be unique
|
||||||
|
[[test]]
|
||||||
|
condition = "mycondition"
|
||||||
|
name = "mytest"
|
||||||
|
command = "$<TARGET_FILE:mytest>"
|
||||||
|
arguments = ["arg1", "arg2"]
|
||||||
|
configurations = ["Debug", "Release", "RelWithDebInfo", "MinSizeRelease"]
|
||||||
|
working-directory = "mytest-dir"
|
||||||
|
```
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[[install]]
|
||||||
|
condition = "mycondition"
|
||||||
|
targets = ["mytarget", "mytest"]
|
||||||
|
destination = ["bin"]
|
||||||
|
component = "mycomponent"
|
||||||
|
files = ["content/my.png"]
|
||||||
|
dirs = ["include"]
|
||||||
|
configs = ["Release", "Debug"]
|
||||||
|
optional = false
|
||||||
|
```
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: Command line
|
|
||||||
permalink: /command-line/
|
|
||||||
nav_order: 2
|
|
||||||
---
|
|
||||||
|
|
||||||
## Command line
|
|
||||||
|
|
||||||
Optionally you can install `cmkr` in your `PATH` and use it as a utility from the command line:
|
|
||||||
|
|
||||||
```
|
|
||||||
Usage: cmkr [arguments]
|
|
||||||
arguments:
|
|
||||||
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.
|
|
||||||
```
|
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
# Automatically generated from tests/compile-options/cmake.toml - DO NOT EDIT
|
||||||
|
layout: default
|
||||||
|
title: Compiler flags
|
||||||
|
permalink: /examples/compile-options
|
||||||
|
parent: Examples
|
||||||
|
nav_order: 9
|
||||||
|
---
|
||||||
|
|
||||||
|
# Compiler flags
|
||||||
|
|
||||||
|
Example project that sets compiler flags and preprocessor defines for various platforms.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
name = "compile-options"
|
||||||
|
description = "Compiler flags"
|
||||||
|
|
||||||
|
[target.hello]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
msvc.compile-options = ["/W2"]
|
||||||
|
msvc.compile-definitions = ["PLATFORM=\"msvc\""]
|
||||||
|
gcc.compile-options = ["-Wall"]
|
||||||
|
gcc.compile-definitions = ["PLATFORM=\"gcc\""]
|
||||||
|
clang.compile-options = ["-Wall"]
|
||||||
|
clang.compile-definitions = ["PLATFORM=\"clang\""]
|
||||||
|
```
|
||||||
|
|
||||||
|
The `hello` target uses [conditions](/cmake-toml#conditions) to set different compiler flags and definitions depending on the platform. See the [targets](/cmake-toml/#targets) documentation for other things you can set.
|
||||||
|
|
||||||
|
_Note_: In general you only want to specify flags _required_ to compile your code without errors.
|
||||||
|
|
||||||
|
<sup><sub>This page was automatically generated from [tests/compile-options/cmake.toml](https://github.com/build-cpp/cmkr/tree/main/tests/compile-options/cmake.toml).</sub></sup>
|
||||||
@@ -16,8 +16,9 @@ Downloads [fmt v7.1.3](https://fmt.dev/7.1.3/) from [GitHub](https://github.com)
|
|||||||
name = "fetch-content"
|
name = "fetch-content"
|
||||||
description = "Fetching from git"
|
description = "Fetching from git"
|
||||||
|
|
||||||
[fetch-content]
|
[fetch-content.fmt]
|
||||||
fmt = { git = "https://github.com/fmtlib/fmt", tag = "7.1.3" }
|
git = "https://github.com/fmtlib/fmt"
|
||||||
|
tag = "7.1.3"
|
||||||
|
|
||||||
[target.example]
|
[target.example]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ description = "Header-only library"
|
|||||||
[target.mylib]
|
[target.mylib]
|
||||||
type = "interface"
|
type = "interface"
|
||||||
include-directories = ["include"]
|
include-directories = ["include"]
|
||||||
|
compile-features = ["cxx_std_11"]
|
||||||
|
|
||||||
[target.example]
|
[target.example]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
# Automatically generated from tests/msvc-runtime/cmake.toml - DO NOT EDIT
|
||||||
|
layout: default
|
||||||
|
title: Static MSVC runtime
|
||||||
|
permalink: /examples/msvc-runtime
|
||||||
|
parent: Examples
|
||||||
|
nav_order: 8
|
||||||
|
---
|
||||||
|
|
||||||
|
# Static MSVC runtime
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
name = "msvc-runtime"
|
||||||
|
description = "Static MSVC runtime"
|
||||||
|
msvc-runtime = "static"
|
||||||
|
|
||||||
|
# This target will compile with a static runtime
|
||||||
|
[target.static-runtime]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
|
||||||
|
# This target overrides the [project].msvc-runtime
|
||||||
|
[target.dynamic-runtime]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
msvc-runtime = "dynamic"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<sup><sub>This page was automatically generated from [tests/msvc-runtime/cmake.toml](https://github.com/build-cpp/cmkr/tree/main/tests/msvc-runtime/cmake.toml).</sub></sup>
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
# Automatically generated from tests/objective-c/cmake.toml - DO NOT EDIT
|
||||||
|
layout: default
|
||||||
|
title: Objective-C
|
||||||
|
permalink: /examples/objective-c
|
||||||
|
parent: Examples
|
||||||
|
nav_order: 11
|
||||||
|
---
|
||||||
|
|
||||||
|
# Objective-C
|
||||||
|
|
||||||
|
Add Objective-C sources on Apple platforms:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
name = "objective-c"
|
||||||
|
description = "Objective-C"
|
||||||
|
languages = ["C"]
|
||||||
|
apple.languages = ["OBJC"]
|
||||||
|
|
||||||
|
[target.hello]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.c"]
|
||||||
|
apple.sources = ["src/apple.m"]
|
||||||
|
apple.link-libraries = ["$<LINK_LIBRARY:FRAMEWORK,Foundation>"]
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<sup><sub>This page was automatically generated from [tests/objective-c/cmake.toml](https://github.com/build-cpp/cmkr/tree/main/tests/objective-c/cmake.toml).</sub></sup>
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
# Automatically generated from tests/templates/cmake.toml - DO NOT EDIT
|
||||||
|
layout: default
|
||||||
|
title: Target templates
|
||||||
|
permalink: /examples/templates
|
||||||
|
parent: Examples
|
||||||
|
nav_order: 7
|
||||||
|
---
|
||||||
|
|
||||||
|
# Target templates
|
||||||
|
|
||||||
|
To avoid repeating yourself in targets you can create your own target type (template). All properties of the template are inherited when used as a target type.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
name = "templates"
|
||||||
|
description = "Target templates"
|
||||||
|
|
||||||
|
[template.app]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/templates.cpp"]
|
||||||
|
compile-definitions = ["IS_APP"]
|
||||||
|
# Unlike interface targets you can also inherit properties
|
||||||
|
properties = {
|
||||||
|
CXX_STANDARD = "11",
|
||||||
|
CXX_STANDARD_REQUIRED = true,
|
||||||
|
}
|
||||||
|
|
||||||
|
[target.app-a]
|
||||||
|
type = "app"
|
||||||
|
compile-definitions = ["APP_A"]
|
||||||
|
|
||||||
|
[target.app-b]
|
||||||
|
type = "app"
|
||||||
|
compile-definitions = ["APP_B"]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note**: In most cases you probably want to use an [interface](/examples/interface) target instead.
|
||||||
|
|
||||||
|
<sup><sub>This page was automatically generated from [tests/templates/cmake.toml](https://github.com/build-cpp/cmkr/tree/main/tests/templates/cmake.toml).</sub></sup>
|
||||||
@@ -9,7 +9,7 @@ nav_order: 4
|
|||||||
|
|
||||||
# Dependencies from vcpkg
|
# Dependencies from vcpkg
|
||||||
|
|
||||||
Downloads [fmt v7.1.3](https://fmt.dev/7.1.3/) using [vcpkg](https://vcpkg.io/) and links an `example` target to it:
|
Downloads [fmt v7.1.3](https://fmt.dev/7.1.3/) using [vcpkg](https://github.com/microsoft/vcpkg) and links an `example` target to it:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
@@ -17,13 +17,12 @@ name = "vcpkg"
|
|||||||
description = "Dependencies from vcpkg"
|
description = "Dependencies from vcpkg"
|
||||||
|
|
||||||
# See https://github.com/microsoft/vcpkg/releases for vcpkg versions
|
# See https://github.com/microsoft/vcpkg/releases for vcpkg versions
|
||||||
# See https://vcpkg.io/en/packages.html for available packages
|
# See https://vcpkg.io/en/packages or https://vcpkg.link for available packages
|
||||||
[vcpkg]
|
[vcpkg]
|
||||||
version = "2021.05.12"
|
version = "2024.11.16"
|
||||||
packages = ["fmt"]
|
packages = ["fmt"]
|
||||||
|
|
||||||
[find-package]
|
[find-package.fmt]
|
||||||
fmt = {}
|
|
||||||
|
|
||||||
[target.example]
|
[target.example]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
@@ -33,4 +32,6 @@ link-libraries = ["fmt::fmt"]
|
|||||||
|
|
||||||
The bootstrapping of vcpkg is fully automated and no user interaction is necessary. You can disable vcpkg by setting `CMKR_DISABLE_VCPKG=ON`.
|
The bootstrapping of vcpkg is fully automated and no user interaction is necessary. You can disable vcpkg by setting `CMKR_DISABLE_VCPKG=ON`.
|
||||||
|
|
||||||
|
To specify package features you can use the following syntax: `imgui[docking-experimental,freetype,sdl2-binding,opengl3-binding]`.
|
||||||
|
|
||||||
<sup><sub>This page was automatically generated from [tests/vcpkg/cmake.toml](https://github.com/build-cpp/cmkr/tree/main/tests/vcpkg/cmake.toml).</sub></sup>
|
<sup><sub>This page was automatically generated from [tests/vcpkg/cmake.toml](https://github.com/build-cpp/cmkr/tree/main/tests/vcpkg/cmake.toml).</sub></sup>
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
layout: null
|
||||||
|
permalink: /getting-started/
|
||||||
|
---
|
||||||
|
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="refresh" content="0;url=https://cmkr.build">
|
||||||
|
</head>
|
||||||
|
</html>
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: Getting started
|
|
||||||
permalink: /getting-started/
|
|
||||||
nav_order: 1
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
The easiest way to get started is to use the [cmkr_for_beginners](https://github.com/build-cpp/cmkr_for_beginners) template repository. Either open it in [Gitpod](https://gitpod.io/#https://github.com/build-cpp/cmkr_for_beginners), or clone the repository and run:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
cmake -B build
|
|
||||||
cmake --build build
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively you can check out the [cmkr topic](https://github.com/topics/cmkr) or the [build-cpp organization](https://github.com/build-cpp) for more examples and templates.
|
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
google-site-verification: google13f7c659b54c069f.html
|
||||||
+63
-5
@@ -1,23 +1,81 @@
|
|||||||
---
|
---
|
||||||
layout: home
|
layout: home
|
||||||
title: Index
|
title: Documentation
|
||||||
nav_order: 0
|
nav_order: 0
|
||||||
---
|
---
|
||||||
|
|
||||||
# Index
|
# Documentation
|
||||||
|
|
||||||
`cmkr`, pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io). It was originally created by [Mohammed Alyousef](https://github.com/MoAlyousef).
|
[`cmkr`](https://github.com/build-cpp/cmkr), pronounced "cmaker", is a modern build system based on [CMake](https://cmake.org/) and [TOML](https://toml.io).
|
||||||
|
|
||||||
`cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example:
|
`cmkr` parses `cmake.toml` files and generates a modern, idiomatic `CMakeLists.txt` for you. A minimal example:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
name = "cmkr_for_beginners"
|
name = "cmkr_for_beginners"
|
||||||
description = "A minimal cmkr project."
|
|
||||||
|
|
||||||
[target.hello_world]
|
[target.hello_world]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
sources = ["src/main.cpp"]
|
sources = ["src/main.cpp"]
|
||||||
```
|
```
|
||||||
|
|
||||||
`cmkr` can bootstrap itself from CMake and consumers of your project do not need to install anything to work with it.
|
`cmkr` can bootstrap itself, and you only need CMake and a C++ compiler to use it.
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
To get started, run the following commands from your project directory:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl https://raw.githubusercontent.com/build-cpp/cmkr/main/cmake/cmkr.cmake -o cmkr.cmake
|
||||||
|
cmake -P cmkr.cmake
|
||||||
|
```
|
||||||
|
|
||||||
|
After the bootstrapping process finishes, customize [`cmake.toml`](./cmake-toml) for your project and run CMake:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cmake -B build
|
||||||
|
cmake --build build
|
||||||
|
```
|
||||||
|
|
||||||
|
Once bootstrapped, `cmkr` does not introduce extra steps to your workflow. After modifying `cmake.toml` you simply build/configure your CMake project and `cmkr` will automatically regenerate `CMakeLists.txt` when necessary.
|
||||||
|
|
||||||
|
<sub>**Note**: The `cmake.toml` project file, generated `CMakeLists.txt` and `cmkr.cmake` bootstrapping script are all intended to be added to source control.</sub>
|
||||||
|
|
||||||
|
In CI environments the `cmkr` bootstrapping process is skipped, so there is no additional overhead in your pipelines.
|
||||||
|
|
||||||
|
## Template repositories
|
||||||
|
|
||||||
|
Another way to get started is to use the [cmkr_for_beginners](https://github.com/build-cpp/cmkr_for_beginners) template repository. Either open it in [Gitpod](https://gitpod.io/#https://github.com/build-cpp/cmkr_for_beginners), or clone the repository and run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cmake -B build
|
||||||
|
cmake --build build
|
||||||
|
```
|
||||||
|
|
||||||
|
Check out the [cmkr topic](https://github.com/topics/cmkr), the [build-cpp organization](https://github.com/build-cpp) or the [tests](https://github.com/build-cpp/cmkr/tree/main/tests) for more examples and templates.
|
||||||
|
|
||||||
|
## Command line
|
||||||
|
|
||||||
|
Optionally you can put a [`cmkr` release](https://github.com/build-cpp/cmkr/releases) in your `PATH` and use it as a utility from the command line:
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage: cmkr [arguments]
|
||||||
|
arguments:
|
||||||
|
init [executable|library|shared|static|interface] Create a project.
|
||||||
|
gen Generates CMakeLists.txt file.
|
||||||
|
build <extra cmake args> Run cmake and build.
|
||||||
|
install Run cmake --install.
|
||||||
|
clean Clean the build directory.
|
||||||
|
help Show help.
|
||||||
|
version Current cmkr version.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
|
||||||
|
- [gulrak/filesystem](https://github.com/gulrak/filesystem)
|
||||||
|
- [Tessil/ordered-map](https://github.com/Tessil/ordered-map)
|
||||||
|
- [ToruNiina/toml11](https://github.com/ToruNiina/toml11)
|
||||||
|
- [mpark/variant](https://github.com/mpark/variant)
|
||||||
|
- [SVG Repo Hammer](https://www.svgrepo.com/svg/192268/hammer)
|
||||||
|
- [can1357](https://github.com/can1357) for buying `cmkr.build` ❤️
|
||||||
|
- [JustasMasiulis](https://github.com/JustasMasiulis) for fixing the dark theme ❤️
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: Philosophy
|
||||||
|
nav_order: 2
|
||||||
|
published: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# Philosophy
|
||||||
|
|
||||||
|
## Problem statement
|
||||||
|
|
||||||
|
Similar to writing good C++, writing good CMake is difficult. The main difference is that nobody actually wants to learn CMake. The build system is something that should "just work".
|
||||||
|
|
||||||
|
There have been many attempts at creating new build systems (with varying levels of success). Naturally this causes [competing standards](https://xkcd.com/927/), which is undesirable. CMake is pretty much the de facto standard, and it has seen extensive use in complex software projects.
|
||||||
|
|
||||||
|
One of the main issues of CMake is the turing-complete scripting language you use to describe your projects. As your project gets more complex this can be very helpful, but it also unnecessarily complicates simple projects. There have been discussions about a declarative language on the [CMake issue tracker](https://gitlab.kitware.com/cmake/cmake/-/issues/19891) to solve this problem, but it looks like a "LISP-like" language is seriously being considered...
|
||||||
|
|
||||||
|
## The solution
|
||||||
|
|
||||||
|
The way cmkr (pronounced "cmaker") solves this problem is by using [TOML](https://toml.io/). Below is a minimal `cmake.toml` project:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
name = "cmkr_for_beginners"
|
||||||
|
|
||||||
|
[target.hello_world]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
```
|
||||||
|
|
||||||
|
The key difference between `cmkr` and other build systems is that it _generates_ CMake. This means that your projects are fully compatible with the CMake ecosystem, and you can try it out without having to rewrite your whole build system.
|
||||||
|
|
||||||
|
TODO: link/include more examples? Talk about conditions, packaging (missing)
|
||||||
|
|
||||||
|
### Another layer?!
|
||||||
|
|
||||||
|
A common issue people have with cmkr is that it introduces an additional layer of indirection to your build system. CMake is already a meta-buildsystem, which means you could call cmkr a "meta-meta-buildsystem".
|
||||||
|
|
||||||
|
Presumably the reason for this friction is that additional layers of abstraction introduce additional complexity. Because of this cmkr has been designed to be completely seamless:
|
||||||
|
|
||||||
|
- The user doesn't have to install any additional software to use cmkr. All you need is a semi-recent version of CMake and a C++ compiler.
|
||||||
|
- Modifying `cmake.toml` automatically triggers a regeneration of `CMakeLists.txt`. There is no change to your build process.
|
||||||
|
- The `CMakeLists.txt` is generated to be human-readable. This means you can easily "eject" from cmkr and go back to CMake.
|
||||||
|
|
||||||
|
An additional argument for cmkr is that anecdotally people say it "just works". Because of its simplicity it's also easy to teach, even to people without programming experience.
|
||||||
|
|
||||||
|
There is also precedent in the JavaScript community. Bundlers and translators are the norm there and their developer experience is miles ahead of C++.
|
||||||
|
|
||||||
|
<sub>Not to say the JavaScript ecosystem is without its flaws, but generators does not appear to be one of them</sub>
|
||||||
|
|
||||||
|
### Unsupported features
|
||||||
|
|
||||||
|
Because cmkr is still in early in development there are many missing/unfinished features. It was decided that users can bridge the gap by including CMake at arbitrary locations.
|
||||||
|
|
||||||
|
This has the advantage that it forces complexity in the build system to be self-contained and modular, a problem all too common in projects as they age.
|
||||||
|
|
||||||
|
## Enterprise
|
||||||
|
|
||||||
|
Words like "bootstrapping" and "generating code" might worry engineers working in an enterprise environment, and rightly so. From the beginning it has been a priority to make cmkr suitable for use in big corporations with strict protocols for security and reproducibility.
|
||||||
|
|
||||||
|
### No additional dependencies
|
||||||
|
|
||||||
|
As mentioned above, the only thing you need is a working C++ compiler and a semi-recent version of CMake. It is assumed that you are already building (and executing) C++ projects on your servers, so cmkr does not introduce additional requirements.
|
||||||
|
|
||||||
|
All the logic for downloading and compiling the `cmkr` executable is self-contained in a ~250 line `cmkr.cmake` script. You can easily audit it and see if it's up to your standards.
|
||||||
|
|
||||||
|
### Reproducibility
|
||||||
|
|
||||||
|
Per default the `cmkr.cmake` bootstrapping script contains the exact version of cmkr used to generate your project. As long as the cmkr repository is available you will build the exact same version of cmkr, which will generate the exact same `CMakeLists.txt` file.
|
||||||
|
|
||||||
|
This also means that cmkr can decide to break backwards compatibility without affecting legacy projects. An effort will always be made to maintain backwards compatibility though.
|
||||||
|
|
||||||
|
### Integrity
|
||||||
|
|
||||||
|
As an additional safeguard you can modify `cmkr.cmake` to pin the version tag to a commit hash. This hash is checked to ensure the integrity of the upstream repository.
|
||||||
|
|
||||||
|
### Availability
|
||||||
|
|
||||||
|
You can easily point `cmkr.cmake` to a mirror of the cmkr repository to ensure availability should something catastrophic happen.
|
||||||
|
|
||||||
|
### Not executed in CI
|
||||||
|
|
||||||
|
The final (and key) feature is that the bootstrapping process is never executed in CI environments. This means `cmkr` is only ever executed on your developer's machines and not on your infrastructure.
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
bundle exec just-the-docs rake search:init
|
|
||||||
bundle exec jekyll serve --livereload
|
|
||||||
Regular → Executable
@@ -7,5 +7,3 @@ const char *handle_args(int argc, char **argv);
|
|||||||
|
|
||||||
} // namespace args
|
} // namespace args
|
||||||
} // namespace cmkr
|
} // namespace cmkr
|
||||||
|
|
||||||
const char *cmkr_args_handle_args(int, char **);
|
|
||||||
|
|||||||
@@ -11,9 +11,3 @@ int install();
|
|||||||
|
|
||||||
} // namespace build
|
} // namespace build
|
||||||
} // namespace cmkr
|
} // namespace cmkr
|
||||||
|
|
||||||
int cmkr_build_run(int argc, char **argv);
|
|
||||||
|
|
||||||
int cmkr_build_clean();
|
|
||||||
|
|
||||||
int cmkr_build_install();
|
|
||||||
|
|||||||
@@ -5,13 +5,9 @@
|
|||||||
namespace cmkr {
|
namespace cmkr {
|
||||||
namespace gen {
|
namespace gen {
|
||||||
|
|
||||||
int generate_project(const char *typ);
|
void generate_project(const std::string &type);
|
||||||
|
|
||||||
int generate_cmake(const char *path, const parser::Project *parent_project = nullptr);
|
void generate_cmake(const char *path, const parser::Project *parent_project = nullptr);
|
||||||
|
|
||||||
} // namespace gen
|
} // namespace gen
|
||||||
} // namespace cmkr
|
} // namespace cmkr
|
||||||
|
|
||||||
int cmkr_gen_generate_project(const char *typ);
|
|
||||||
|
|
||||||
int cmkr_gen_generate_cmake(const char *path);
|
|
||||||
|
|||||||
@@ -1,69 +0,0 @@
|
|||||||
// https://codereview.stackexchange.com/a/14315
|
|
||||||
|
|
||||||
#include <algorithm>
|
|
||||||
#include <iostream>
|
|
||||||
#include <sstream>
|
|
||||||
#include <string>
|
|
||||||
|
|
||||||
// This is the type that will hold all the strings.
|
|
||||||
// Each enumeration type will declare its own specialization.
|
|
||||||
// Any enum that does not have a specialization will generate a compiler error
|
|
||||||
// indicating that there is no definition of this variable (as there should be
|
|
||||||
// be no definition of a generic version).
|
|
||||||
template <typename T>
|
|
||||||
struct enumStrings {
|
|
||||||
static char const *data[];
|
|
||||||
};
|
|
||||||
|
|
||||||
// This is a utility type.
|
|
||||||
// Created automatically. Should not be used directly.
|
|
||||||
template <typename T>
|
|
||||||
struct enumRefHolder {
|
|
||||||
T &enumVal;
|
|
||||||
enumRefHolder(T &enumVal) : enumVal(enumVal) {}
|
|
||||||
};
|
|
||||||
template <typename T>
|
|
||||||
struct enumConstRefHolder {
|
|
||||||
T const &enumVal;
|
|
||||||
enumConstRefHolder(T const &enumVal) : enumVal(enumVal) {}
|
|
||||||
};
|
|
||||||
|
|
||||||
// The next two functions do the actual work of reading/writing an
|
|
||||||
// enum as a string.
|
|
||||||
template <typename T>
|
|
||||||
std::ostream &operator<<(std::ostream &str, enumConstRefHolder<T> const &data) {
|
|
||||||
return str << enumStrings<T>::data[data.enumVal];
|
|
||||||
}
|
|
||||||
|
|
||||||
template <typename T>
|
|
||||||
std::istream &operator>>(std::istream &str, enumRefHolder<T> const &data) {
|
|
||||||
std::string value;
|
|
||||||
str >> value;
|
|
||||||
|
|
||||||
// These two can be made easier to read in C++11
|
|
||||||
// using std::begin() and std::end()
|
|
||||||
//
|
|
||||||
static auto begin = std::begin(enumStrings<T>::data);
|
|
||||||
static auto end = std::end(enumStrings<T>::data);
|
|
||||||
|
|
||||||
auto find = std::find(begin, end, value);
|
|
||||||
if (find != end) {
|
|
||||||
data.enumVal = static_cast<T>(std::distance(begin, find));
|
|
||||||
} else {
|
|
||||||
throw std::invalid_argument("");
|
|
||||||
}
|
|
||||||
return str;
|
|
||||||
}
|
|
||||||
|
|
||||||
// This is the public interface:
|
|
||||||
// use the ability of function to deduce their template type without
|
|
||||||
// being explicitly told to create the correct type of enumRefHolder<T>
|
|
||||||
template <typename T>
|
|
||||||
enumConstRefHolder<T> enumToString(T const &e) {
|
|
||||||
return enumConstRefHolder<T>(e);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <typename T>
|
|
||||||
enumRefHolder<T> enumFromString(T &e) {
|
|
||||||
return enumRefHolder<T>(e);
|
|
||||||
}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
#pragma once
|
|
||||||
|
|
||||||
namespace cmkr {
|
|
||||||
namespace error {
|
|
||||||
|
|
||||||
struct Status {
|
|
||||||
enum class Code {
|
|
||||||
Success = 0,
|
|
||||||
RuntimeError,
|
|
||||||
InitError,
|
|
||||||
GenerationError,
|
|
||||||
BuildError,
|
|
||||||
CleanError,
|
|
||||||
InstallError,
|
|
||||||
};
|
|
||||||
Status(Code ec) noexcept;
|
|
||||||
operator int() const noexcept;
|
|
||||||
Code code() const noexcept;
|
|
||||||
|
|
||||||
private:
|
|
||||||
Code ec_ = Code::Success;
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace error
|
|
||||||
} // namespace cmkr
|
|
||||||
|
|
||||||
const char *cmkr_error_status_string(int);
|
|
||||||
+1
-3
@@ -1,8 +1,6 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#if ((defined(_MSVC_LANG) && _MSVC_LANG >= 201703L) || \
|
#if ((defined(_MSVC_LANG) && _MSVC_LANG >= 201703L) || (defined(__cplusplus) && __cplusplus >= 201703L)) && defined(__has_include)
|
||||||
(defined(__cplusplus) && __cplusplus >= 201703L)) && \
|
|
||||||
defined(__has_include)
|
|
||||||
#if __has_include(<filesystem>) && (!defined(__MAC_OS_X_VERSION_MIN_REQUIRED) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 101500)
|
#if __has_include(<filesystem>) && (!defined(__MAC_OS_X_VERSION_MIN_REQUIRED) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 101500)
|
||||||
#define GHC_USE_STD_FS
|
#define GHC_USE_STD_FS
|
||||||
#include <filesystem>
|
#include <filesystem>
|
||||||
|
|||||||
@@ -9,7 +9,3 @@ const char *message() noexcept;
|
|||||||
|
|
||||||
} // namespace help
|
} // namespace help
|
||||||
} // namespace cmkr
|
} // namespace cmkr
|
||||||
|
|
||||||
const char *cmkr_help_version(void);
|
|
||||||
|
|
||||||
const char *cmkr_help_message(void);
|
|
||||||
|
|||||||
+88
-33
@@ -1,45 +1,100 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
static const char *hello_world = &R"lit(
|
static const char *cpp_executable = &R"lit(
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
#include <cstdlib>
|
||||||
|
|
||||||
int %s() {
|
int main() {
|
||||||
std::cout << "Hello World!\n";
|
std::cout << "Hello from cmkr!\n";
|
||||||
return 0;
|
return EXIT_SUCCESS;
|
||||||
}
|
}
|
||||||
)lit"[1]; // skip initial newline
|
)lit"[1]; // skip initial newline
|
||||||
|
|
||||||
static const char *cmake_toml = &R"lit(
|
static const char *cpp_library = &R"lit(
|
||||||
[cmake]
|
#include <@name/@name.hpp>
|
||||||
version = "3.15"
|
|
||||||
# subdirs = []
|
|
||||||
# build-dir = ""
|
|
||||||
# cpp-flags = []
|
|
||||||
# c-flags = []
|
|
||||||
# link-flags = []
|
|
||||||
# generator = ""
|
|
||||||
# arguments = []
|
|
||||||
|
|
||||||
[project]
|
#include <iostream>
|
||||||
name = "%s"
|
|
||||||
version = "0.1.0"
|
|
||||||
|
|
||||||
# [find-package]
|
namespace @name {
|
||||||
|
|
||||||
# [fetch-content]
|
void hello() {
|
||||||
|
std::cout << "Hello from cmkr!\n";
|
||||||
|
}
|
||||||
|
|
||||||
# [options]
|
} // namespace @name
|
||||||
|
)lit"[1]; // skip initial newline
|
||||||
[target.%s]
|
|
||||||
type = "%s"
|
static const char *hpp_library = &R"lit(
|
||||||
sources = ["src/*.cpp"]
|
#pragma once
|
||||||
include-directories = ["include"]
|
|
||||||
# alias = ""
|
namespace @name {
|
||||||
# compile-features = []
|
|
||||||
# compile-definitions = []
|
void hello();
|
||||||
# link-libraries = []
|
|
||||||
|
} // namespace @name
|
||||||
[[install]]
|
)lit"[1]; // skip initial newline
|
||||||
%s = ["%s"]
|
|
||||||
destination = "${CMAKE_INSTALL_PREFIX}/%s"
|
static const char *hpp_interface = &R"lit(
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
namespace @name {
|
||||||
|
|
||||||
|
inline void hello() {
|
||||||
|
std::cout << "Hello from cmkr!\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace @name
|
||||||
|
)lit"[1]; // skip initial newline
|
||||||
|
|
||||||
|
static const char *toml_executable = &R"lit(
|
||||||
|
# Reference: https://build-cpp.github.io/cmkr/cmake-toml
|
||||||
|
[project]
|
||||||
|
name = "@name"
|
||||||
|
|
||||||
|
[target.@name]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/@name/main.cpp"]
|
||||||
|
compile-features = ["cxx_std_11"]
|
||||||
|
)lit"[1]; // skip initial newline
|
||||||
|
|
||||||
|
static const char *toml_library = &R"lit(
|
||||||
|
# Reference: https://build-cpp.github.io/cmkr/cmake-toml
|
||||||
|
[project]
|
||||||
|
name = "@name"
|
||||||
|
|
||||||
|
[target.@name]
|
||||||
|
type = "@type"
|
||||||
|
sources = [
|
||||||
|
"src/@name/@name.cpp",
|
||||||
|
"include/@name/@name.hpp"
|
||||||
|
]
|
||||||
|
include-directories = ["include"]
|
||||||
|
compile-features = ["cxx_std_11"]
|
||||||
|
)lit"[1]; // skip initial newline
|
||||||
|
|
||||||
|
static const char *toml_interface = &R"lit(
|
||||||
|
# Reference: https://build-cpp.github.io/cmkr/cmake-toml
|
||||||
|
[project]
|
||||||
|
name = "@name"
|
||||||
|
|
||||||
|
[target.@name]
|
||||||
|
type = "interface"
|
||||||
|
include-directories = ["include"]
|
||||||
|
compile-features = ["cxx_std_11"]
|
||||||
|
)lit"[1]; // skip initial newline
|
||||||
|
|
||||||
|
static const char *toml_migration = &R"lit(
|
||||||
|
# Reference: https://build-cpp.github.io/cmkr/cmake-toml
|
||||||
|
[project]
|
||||||
|
name = "@name"
|
||||||
|
|
||||||
|
# TODO: define a target for each of your executables/libraries like this:
|
||||||
|
#[target.myexecutable]
|
||||||
|
#type = "executable" # static, shared
|
||||||
|
#sources = ["src/@name/*.cpp", "include/@name/*.hpp"]
|
||||||
|
#include-directories = ["include"]
|
||||||
|
#compile-features = ["cxx_std_11"]
|
||||||
|
#link-libraries = ["target-or-library"]
|
||||||
)lit"[1]; // skip initial newline
|
)lit"[1]; // skip initial newline
|
||||||
|
|||||||
+85
-21
@@ -1,41 +1,62 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include <map>
|
|
||||||
#include <mpark/variant.hpp>
|
|
||||||
#include <stdexcept>
|
|
||||||
#include <string>
|
|
||||||
#include <tsl/ordered_map.h>
|
|
||||||
#include <vector>
|
#include <vector>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
#include <mpark/variant.hpp>
|
||||||
|
#include <tsl/ordered_map.h>
|
||||||
|
#include <tsl/ordered_set.h>
|
||||||
|
|
||||||
namespace cmkr {
|
namespace cmkr {
|
||||||
namespace parser {
|
namespace parser {
|
||||||
|
|
||||||
struct Setting {
|
template <typename T>
|
||||||
|
using Condition = tsl::ordered_map<std::string, T>;
|
||||||
|
|
||||||
|
using ConditionVector = Condition<std::vector<std::string>>;
|
||||||
|
|
||||||
|
struct Variable {
|
||||||
std::string name;
|
std::string name;
|
||||||
std::string comment;
|
std::string help;
|
||||||
mpark::variant<bool, std::string> val;
|
mpark::variant<bool, std::string> value;
|
||||||
bool cache = false;
|
bool cache = false;
|
||||||
bool force = false;
|
bool force = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
struct Option {
|
struct Option {
|
||||||
std::string name;
|
std::string name;
|
||||||
std::string comment;
|
std::string help;
|
||||||
bool val = false;
|
mpark::variant<bool, std::string> value;
|
||||||
};
|
};
|
||||||
|
|
||||||
struct Package {
|
struct Package {
|
||||||
std::string name;
|
std::string name;
|
||||||
|
std::string condition;
|
||||||
std::string version;
|
std::string version;
|
||||||
bool required = true;
|
bool required = true;
|
||||||
bool config = true;
|
bool config = false;
|
||||||
std::vector<std::string> components;
|
std::vector<std::string> components;
|
||||||
};
|
};
|
||||||
|
|
||||||
struct Vcpkg {
|
struct Vcpkg {
|
||||||
std::string version;
|
std::string version;
|
||||||
std::string url;
|
std::string url;
|
||||||
std::vector<std::string> packages;
|
|
||||||
|
struct Package {
|
||||||
|
std::string name;
|
||||||
|
std::vector<std::string> features;
|
||||||
|
bool default_features = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
std::vector<Package> packages;
|
||||||
|
|
||||||
|
// https://github.com/Microsoft/vcpkg-docs/blob/main/vcpkg/users/buildsystems/cmake-integration.md
|
||||||
|
std::vector<std::string> overlay_ports;
|
||||||
|
std::vector<std::string> overlay_triplets;
|
||||||
|
|
||||||
|
bool enabled() const {
|
||||||
|
return !packages.empty();
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
enum TargetType {
|
enum TargetType {
|
||||||
@@ -45,18 +66,18 @@ enum TargetType {
|
|||||||
target_static,
|
target_static,
|
||||||
target_interface,
|
target_interface,
|
||||||
target_custom,
|
target_custom,
|
||||||
|
target_object,
|
||||||
|
target_template,
|
||||||
|
target_last,
|
||||||
};
|
};
|
||||||
|
|
||||||
template <typename T>
|
extern const char *targetTypeNames[target_last];
|
||||||
using Condition = tsl::ordered_map<std::string, T>;
|
|
||||||
|
|
||||||
using ConditionVector = Condition<std::vector<std::string>>;
|
|
||||||
|
|
||||||
struct Target {
|
struct Target {
|
||||||
std::string name;
|
std::string name;
|
||||||
TargetType type = {};
|
TargetType type = target_last;
|
||||||
|
std::string type_name;
|
||||||
|
|
||||||
ConditionVector headers;
|
|
||||||
ConditionVector sources;
|
ConditionVector sources;
|
||||||
|
|
||||||
// https://cmake.org/cmake/help/latest/manual/cmake-commands.7.html#project-commands
|
// https://cmake.org/cmake/help/latest/manual/cmake-commands.7.html#project-commands
|
||||||
@@ -84,6 +105,8 @@ struct Target {
|
|||||||
ConditionVector precompile_headers;
|
ConditionVector precompile_headers;
|
||||||
ConditionVector private_precompile_headers;
|
ConditionVector private_precompile_headers;
|
||||||
|
|
||||||
|
ConditionVector dependencies;
|
||||||
|
|
||||||
std::string condition;
|
std::string condition;
|
||||||
std::string alias;
|
std::string alias;
|
||||||
Condition<tsl::ordered_map<std::string, std::string>> properties;
|
Condition<tsl::ordered_map<std::string, std::string>> properties;
|
||||||
@@ -94,8 +117,16 @@ struct Target {
|
|||||||
ConditionVector include_after;
|
ConditionVector include_after;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
struct Template {
|
||||||
|
Target outline;
|
||||||
|
std::string add_function;
|
||||||
|
std::vector<std::string> add_arguments;
|
||||||
|
bool pass_sources_to_add_function = false;
|
||||||
|
};
|
||||||
|
|
||||||
struct Test {
|
struct Test {
|
||||||
std::string name;
|
std::string name;
|
||||||
|
std::string condition;
|
||||||
std::vector<std::string> configurations;
|
std::vector<std::string> configurations;
|
||||||
std::string working_directory;
|
std::string working_directory;
|
||||||
std::string command;
|
std::string command;
|
||||||
@@ -103,23 +134,50 @@ struct Test {
|
|||||||
};
|
};
|
||||||
|
|
||||||
struct Install {
|
struct Install {
|
||||||
|
std::string condition;
|
||||||
std::vector<std::string> targets;
|
std::vector<std::string> targets;
|
||||||
std::vector<std::string> files;
|
std::vector<std::string> files;
|
||||||
std::vector<std::string> dirs;
|
std::vector<std::string> dirs;
|
||||||
std::vector<std::string> configs;
|
std::vector<std::string> configs;
|
||||||
std::string destination;
|
std::string destination;
|
||||||
|
std::string component;
|
||||||
|
bool optional = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
struct Subdir {
|
struct Subdir {
|
||||||
std::string name;
|
std::string name;
|
||||||
std::string condition;
|
std::string condition;
|
||||||
|
|
||||||
Condition<std::string> cmake_before;
|
Condition<std::string> cmake_before;
|
||||||
Condition<std::string> cmake_after;
|
Condition<std::string> cmake_after;
|
||||||
ConditionVector include_before;
|
ConditionVector include_before;
|
||||||
ConditionVector include_after;
|
ConditionVector include_after;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
struct Content {
|
||||||
|
std::string name;
|
||||||
|
std::string condition;
|
||||||
|
tsl::ordered_map<std::string, std::string> arguments;
|
||||||
|
|
||||||
|
Condition<std::string> cmake_before;
|
||||||
|
Condition<std::string> cmake_after;
|
||||||
|
ConditionVector include_before;
|
||||||
|
ConditionVector include_after;
|
||||||
|
bool system = false;
|
||||||
|
std::string subdir;
|
||||||
|
};
|
||||||
|
|
||||||
|
enum MsvcRuntimeType {
|
||||||
|
msvc_dynamic,
|
||||||
|
msvc_static,
|
||||||
|
msvc_last,
|
||||||
|
};
|
||||||
|
|
||||||
|
extern const char *msvcRuntimeTypeNames[msvc_last];
|
||||||
|
|
||||||
struct Project {
|
struct Project {
|
||||||
|
const Project *parent;
|
||||||
|
|
||||||
// This is the CMake version required to use all cmkr versions.
|
// This is the CMake version required to use all cmkr versions.
|
||||||
std::string cmake_version = "3.15";
|
std::string cmake_version = "3.15";
|
||||||
std::string cmkr_include = "cmkr.cmake";
|
std::string cmkr_include = "cmkr.cmake";
|
||||||
@@ -136,16 +194,19 @@ struct Project {
|
|||||||
std::string project_name;
|
std::string project_name;
|
||||||
std::string project_version;
|
std::string project_version;
|
||||||
std::string project_description;
|
std::string project_description;
|
||||||
std::vector<std::string> project_languages;
|
ConditionVector project_languages;
|
||||||
|
bool project_allow_unknown_languages = false;
|
||||||
|
MsvcRuntimeType project_msvc_runtime = msvc_last;
|
||||||
Condition<std::string> cmake_before;
|
Condition<std::string> cmake_before;
|
||||||
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;
|
||||||
tsl::ordered_map<std::string, std::map<std::string, std::string>> contents;
|
std::vector<Content> contents;
|
||||||
|
std::vector<Template> templates;
|
||||||
std::vector<Target> targets;
|
std::vector<Target> targets;
|
||||||
std::vector<Test> tests;
|
std::vector<Test> tests;
|
||||||
std::vector<Install> installs;
|
std::vector<Install> installs;
|
||||||
@@ -153,6 +214,9 @@ struct Project {
|
|||||||
std::vector<Subdir> subdirs;
|
std::vector<Subdir> subdirs;
|
||||||
|
|
||||||
Project(const Project *parent, const std::string &path, bool build);
|
Project(const Project *parent, const std::string &path, bool build);
|
||||||
|
const Project *root() const;
|
||||||
|
bool cmake_minimum_version(int major, int minor) const;
|
||||||
|
static bool is_condition_name(const std::string &name);
|
||||||
};
|
};
|
||||||
|
|
||||||
bool is_root_path(const std::string &path);
|
bool is_root_path(const std::string &path);
|
||||||
|
|||||||
+8
-23
@@ -2,10 +2,8 @@
|
|||||||
#include "build.hpp"
|
#include "build.hpp"
|
||||||
#include "cmake_generator.hpp"
|
#include "cmake_generator.hpp"
|
||||||
#include "help.hpp"
|
#include "help.hpp"
|
||||||
|
|
||||||
#include "fs.hpp"
|
#include "fs.hpp"
|
||||||
#include <exception>
|
|
||||||
#include <iostream>
|
|
||||||
#include <stdexcept>
|
#include <stdexcept>
|
||||||
#include <string>
|
#include <string>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
@@ -21,9 +19,7 @@ const char *handle_args(int argc, char **argv) {
|
|||||||
throw std::runtime_error(cmkr::help::message());
|
throw std::runtime_error(cmkr::help::message());
|
||||||
std::string main_arg = args[1];
|
std::string main_arg = args[1];
|
||||||
if (main_arg == "gen") {
|
if (main_arg == "gen") {
|
||||||
auto ret = cmkr::gen::generate_cmake(fs::current_path().string().c_str());
|
cmkr::gen::generate_cmake(fs::current_path().string().c_str());
|
||||||
if (ret)
|
|
||||||
return "CMake generation error!";
|
|
||||||
return "CMake generation successful!";
|
return "CMake generation successful!";
|
||||||
} else if (main_arg == "help") {
|
} else if (main_arg == "help") {
|
||||||
return cmkr::help::message();
|
return cmkr::help::message();
|
||||||
@@ -33,24 +29,23 @@ const char *handle_args(int argc, char **argv) {
|
|||||||
std::string type = "executable";
|
std::string type = "executable";
|
||||||
if (args.size() > 2)
|
if (args.size() > 2)
|
||||||
type = args[2];
|
type = args[2];
|
||||||
auto ret = cmkr::gen::generate_project(type.c_str());
|
cmkr::gen::generate_project(type.c_str());
|
||||||
if (ret)
|
cmkr::gen::generate_cmake(fs::current_path().string().c_str());
|
||||||
return "Initialization failure!";
|
|
||||||
return "Directory initialized!";
|
return "Directory initialized!";
|
||||||
} else if (main_arg == "build") {
|
} else if (main_arg == "build") {
|
||||||
auto ret = build::run(argc, argv);
|
auto ret = build::run(argc, argv);
|
||||||
if (ret)
|
if (ret)
|
||||||
return "CMake build error!";
|
throw std::runtime_error("CMake build failed!");
|
||||||
return "CMake run completed!";
|
return "CMake build completed!";
|
||||||
} else if (main_arg == "install") {
|
} else if (main_arg == "install") {
|
||||||
auto ret = build::install();
|
auto ret = build::install();
|
||||||
if (ret)
|
if (ret)
|
||||||
return "CMake install error!";
|
throw std::runtime_error("CMake install failed!");
|
||||||
return "CMake install completed!";
|
return "CMake install completed!";
|
||||||
} else if (main_arg == "clean") {
|
} else if (main_arg == "clean") {
|
||||||
auto ret = build::clean();
|
auto ret = build::clean();
|
||||||
if (ret)
|
if (ret)
|
||||||
return "CMake clean error!";
|
throw std::runtime_error("CMake clean failed!");
|
||||||
return "Cleaned build directory!";
|
return "Cleaned build directory!";
|
||||||
} else {
|
} else {
|
||||||
throw std::runtime_error(cmkr::help::message());
|
throw std::runtime_error(cmkr::help::message());
|
||||||
@@ -58,13 +53,3 @@ const char *handle_args(int argc, char **argv) {
|
|||||||
}
|
}
|
||||||
} // namespace args
|
} // namespace args
|
||||||
} // namespace cmkr
|
} // namespace cmkr
|
||||||
|
|
||||||
const char *cmkr_args_handle_args(int argc, char **argv) {
|
|
||||||
try {
|
|
||||||
return cmkr::args::handle_args(argc, argv);
|
|
||||||
} catch (const std::exception &e) {
|
|
||||||
return e.what();
|
|
||||||
} catch (...) {
|
|
||||||
return "Unknown error!";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
+7
-42
@@ -1,14 +1,10 @@
|
|||||||
#include "build.hpp"
|
#include "build.hpp"
|
||||||
#include "cmake_generator.hpp"
|
#include "cmake_generator.hpp"
|
||||||
#include "error.hpp"
|
|
||||||
#include "project_parser.hpp"
|
#include "project_parser.hpp"
|
||||||
|
|
||||||
#include "fs.hpp"
|
#include "fs.hpp"
|
||||||
|
#include <cstdlib>
|
||||||
#include <sstream>
|
#include <sstream>
|
||||||
#include <stddef.h>
|
|
||||||
#include <stdexcept>
|
|
||||||
#include <stdlib.h>
|
|
||||||
#include <system_error>
|
|
||||||
|
|
||||||
namespace cmkr {
|
namespace cmkr {
|
||||||
namespace build {
|
namespace build {
|
||||||
@@ -17,15 +13,14 @@ int run(int argc, char **argv) {
|
|||||||
parser::Project project(nullptr, ".", true);
|
parser::Project project(nullptr, ".", true);
|
||||||
if (argc > 2) {
|
if (argc > 2) {
|
||||||
for (int i = 2; i < argc; ++i) {
|
for (int i = 2; i < argc; ++i) {
|
||||||
project.build_args.push_back(argv[i]);
|
project.build_args.emplace_back(argv[i]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
std::stringstream ss;
|
std::stringstream ss;
|
||||||
|
|
||||||
if (gen::generate_cmake(fs::current_path().string().c_str()))
|
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 -DCMKR_BUILD_SKIP_GENERATION=ON -B" << project.build_dir << " ";
|
||||||
|
|
||||||
if (!project.generator.empty()) {
|
if (!project.generator.empty()) {
|
||||||
ss << "-G \"" << project.generator << "\" ";
|
ss << "-G \"" << project.generator << "\" ";
|
||||||
@@ -49,13 +44,13 @@ int run(int argc, char **argv) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
int clean() {
|
int clean() {
|
||||||
bool ret = false;
|
bool success = false;
|
||||||
parser::Project project(nullptr, ".", true);
|
parser::Project project(nullptr, ".", true);
|
||||||
if (fs::exists(project.build_dir)) {
|
if (fs::exists(project.build_dir)) {
|
||||||
ret = fs::remove_all(project.build_dir);
|
success = fs::remove_all(project.build_dir);
|
||||||
fs::create_directory(project.build_dir);
|
fs::create_directory(project.build_dir);
|
||||||
}
|
}
|
||||||
return !ret;
|
return success ? EXIT_SUCCESS : EXIT_FAILURE;
|
||||||
}
|
}
|
||||||
|
|
||||||
int install() {
|
int install() {
|
||||||
@@ -65,33 +60,3 @@ int install() {
|
|||||||
}
|
}
|
||||||
} // namespace build
|
} // namespace build
|
||||||
} // namespace cmkr
|
} // namespace cmkr
|
||||||
|
|
||||||
int cmkr_build_run(int argc, char **argv) {
|
|
||||||
try {
|
|
||||||
return cmkr::build::run(argc, argv);
|
|
||||||
} catch (const std::system_error &e) {
|
|
||||||
return e.code().value();
|
|
||||||
} catch (...) {
|
|
||||||
return cmkr::error::Status(cmkr::error::Status::Code::BuildError);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
int cmkr_build_clean(void) {
|
|
||||||
try {
|
|
||||||
return cmkr::build::clean();
|
|
||||||
} catch (const std::system_error &e) {
|
|
||||||
return e.code().value();
|
|
||||||
} catch (...) {
|
|
||||||
return cmkr::error::Status(cmkr::error::Status::Code::CleanError);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
int cmkr_build_install(void) {
|
|
||||||
try {
|
|
||||||
return cmkr::build::install();
|
|
||||||
} catch (const std::system_error &e) {
|
|
||||||
return e.code().value();
|
|
||||||
} catch (...) {
|
|
||||||
return cmkr::error::Status(cmkr::error::Status::Code::InstallError);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+1030
-364
File diff suppressed because it is too large
Load Diff
@@ -1,24 +0,0 @@
|
|||||||
#include "error.hpp"
|
|
||||||
|
|
||||||
#include <assert.h>
|
|
||||||
|
|
||||||
namespace cmkr {
|
|
||||||
namespace error {
|
|
||||||
|
|
||||||
Status::Status(Code ec) noexcept : ec_(ec) {}
|
|
||||||
|
|
||||||
Status::operator int() const noexcept { return static_cast<int>(ec_); }
|
|
||||||
|
|
||||||
Status::Code Status::code() const noexcept { return ec_; }
|
|
||||||
|
|
||||||
} // namespace error
|
|
||||||
} // namespace cmkr
|
|
||||||
|
|
||||||
const char *err_string[] = {
|
|
||||||
"Success", "Runtime error", "Initialization error", "CMake generation error", "Build error",
|
|
||||||
};
|
|
||||||
|
|
||||||
const char *cmkr_error_status(int i) {
|
|
||||||
assert(i >= 0 && i < 5);
|
|
||||||
return err_string[i];
|
|
||||||
}
|
|
||||||
+4
-5
@@ -1,9 +1,12 @@
|
|||||||
#include "help.hpp"
|
#include "help.hpp"
|
||||||
|
#include <resources/version.hpp>
|
||||||
|
|
||||||
namespace cmkr {
|
namespace cmkr {
|
||||||
namespace help {
|
namespace help {
|
||||||
|
|
||||||
const char *version() noexcept { return "cmkr version 0.1.3"; }
|
const char *version() noexcept {
|
||||||
|
return "cmkr version " CMKR_VERSION;
|
||||||
|
}
|
||||||
|
|
||||||
const char *message() noexcept {
|
const char *message() noexcept {
|
||||||
return R"lit(
|
return R"lit(
|
||||||
@@ -20,7 +23,3 @@ arguments:
|
|||||||
}
|
}
|
||||||
} // namespace help
|
} // namespace help
|
||||||
} // namespace cmkr
|
} // namespace cmkr
|
||||||
|
|
||||||
const char *cmkr_help_version(void) { return cmkr::help::version(); }
|
|
||||||
|
|
||||||
const char *cmkr_help_message(void) { return cmkr::help::message(); }
|
|
||||||
+896
-305
File diff suppressed because it is too large
Load Diff
@@ -1,2 +1,4 @@
|
|||||||
# These will be generated by cmkr, so no point in tracking them
|
# These will be generated by cmkr, so no point in tracking them
|
||||||
**/CMakeLists.txt
|
**/CMakeLists.txt
|
||||||
|
**/cmkr.cmake
|
||||||
|
**/vcpkg.json
|
||||||
Generated
+60
-7
@@ -14,7 +14,7 @@ add_test(
|
|||||||
WORKING_DIRECTORY
|
WORKING_DIRECTORY
|
||||||
"${CMAKE_CURRENT_LIST_DIR}/basic"
|
"${CMAKE_CURRENT_LIST_DIR}/basic"
|
||||||
COMMAND
|
COMMAND
|
||||||
$<TARGET_FILE:cmkr>
|
"$<TARGET_FILE:cmkr>"
|
||||||
build
|
build
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ add_test(
|
|||||||
WORKING_DIRECTORY
|
WORKING_DIRECTORY
|
||||||
"${CMAKE_CURRENT_LIST_DIR}/interface"
|
"${CMAKE_CURRENT_LIST_DIR}/interface"
|
||||||
COMMAND
|
COMMAND
|
||||||
$<TARGET_FILE:cmkr>
|
"$<TARGET_FILE:cmkr>"
|
||||||
build
|
build
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ add_test(
|
|||||||
WORKING_DIRECTORY
|
WORKING_DIRECTORY
|
||||||
"${CMAKE_CURRENT_LIST_DIR}/fetch-content"
|
"${CMAKE_CURRENT_LIST_DIR}/fetch-content"
|
||||||
COMMAND
|
COMMAND
|
||||||
$<TARGET_FILE:cmkr>
|
"$<TARGET_FILE:cmkr>"
|
||||||
build
|
build
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ add_test(
|
|||||||
WORKING_DIRECTORY
|
WORKING_DIRECTORY
|
||||||
"${CMAKE_CURRENT_LIST_DIR}/conditions"
|
"${CMAKE_CURRENT_LIST_DIR}/conditions"
|
||||||
COMMAND
|
COMMAND
|
||||||
$<TARGET_FILE:cmkr>
|
"$<TARGET_FILE:cmkr>"
|
||||||
build
|
build
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -54,7 +54,7 @@ add_test(
|
|||||||
WORKING_DIRECTORY
|
WORKING_DIRECTORY
|
||||||
"${CMAKE_CURRENT_LIST_DIR}/vcpkg"
|
"${CMAKE_CURRENT_LIST_DIR}/vcpkg"
|
||||||
COMMAND
|
COMMAND
|
||||||
$<TARGET_FILE:cmkr>
|
"$<TARGET_FILE:cmkr>"
|
||||||
build
|
build
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ add_test(
|
|||||||
WORKING_DIRECTORY
|
WORKING_DIRECTORY
|
||||||
"${CMAKE_CURRENT_LIST_DIR}/cxx-standard"
|
"${CMAKE_CURRENT_LIST_DIR}/cxx-standard"
|
||||||
COMMAND
|
COMMAND
|
||||||
$<TARGET_FILE:cmkr>
|
"$<TARGET_FILE:cmkr>"
|
||||||
build
|
build
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -74,7 +74,60 @@ add_test(
|
|||||||
WORKING_DIRECTORY
|
WORKING_DIRECTORY
|
||||||
"${CMAKE_CURRENT_LIST_DIR}/globbing"
|
"${CMAKE_CURRENT_LIST_DIR}/globbing"
|
||||||
COMMAND
|
COMMAND
|
||||||
$<TARGET_FILE:cmkr>
|
"$<TARGET_FILE:cmkr>"
|
||||||
build
|
build
|
||||||
)
|
)
|
||||||
|
|
||||||
|
add_test(
|
||||||
|
NAME
|
||||||
|
templates
|
||||||
|
WORKING_DIRECTORY
|
||||||
|
"${CMAKE_CURRENT_LIST_DIR}/templates"
|
||||||
|
COMMAND
|
||||||
|
"$<TARGET_FILE:cmkr>"
|
||||||
|
build
|
||||||
|
)
|
||||||
|
|
||||||
|
if(MSVC) # msvc
|
||||||
|
add_test(
|
||||||
|
NAME
|
||||||
|
msvc-runtime
|
||||||
|
WORKING_DIRECTORY
|
||||||
|
"${CMAKE_CURRENT_LIST_DIR}/msvc-runtime"
|
||||||
|
COMMAND
|
||||||
|
"$<TARGET_FILE:cmkr>"
|
||||||
|
build
|
||||||
|
)
|
||||||
|
|
||||||
|
endif()
|
||||||
|
add_test(
|
||||||
|
NAME
|
||||||
|
compile-options
|
||||||
|
WORKING_DIRECTORY
|
||||||
|
"${CMAKE_CURRENT_LIST_DIR}/compile-options"
|
||||||
|
COMMAND
|
||||||
|
"$<TARGET_FILE:cmkr>"
|
||||||
|
build
|
||||||
|
)
|
||||||
|
|
||||||
|
if(WIN32) # windows
|
||||||
|
add_test(
|
||||||
|
NAME
|
||||||
|
relative-paths
|
||||||
|
WORKING_DIRECTORY
|
||||||
|
"${CMAKE_CURRENT_LIST_DIR}/relative-paths"
|
||||||
|
COMMAND
|
||||||
|
"$<TARGET_FILE:cmkr>"
|
||||||
|
build
|
||||||
|
)
|
||||||
|
|
||||||
|
endif()
|
||||||
|
add_test(
|
||||||
|
NAME
|
||||||
|
objective-c
|
||||||
|
WORKING_DIRECTORY
|
||||||
|
"${CMAKE_CURRENT_LIST_DIR}/objective-c"
|
||||||
|
COMMAND
|
||||||
|
"$<TARGET_FILE:cmkr>"
|
||||||
|
build
|
||||||
|
)
|
||||||
|
|||||||
+39
-7
@@ -1,41 +1,73 @@
|
|||||||
[[test]]
|
[[test]]
|
||||||
name = "basic"
|
name = "basic"
|
||||||
command = "$<TARGET_FILE:cmkr>"
|
|
||||||
working-directory = "basic"
|
working-directory = "basic"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
arguments = ["build"]
|
arguments = ["build"]
|
||||||
|
|
||||||
[[test]]
|
[[test]]
|
||||||
name = "interface"
|
name = "interface"
|
||||||
command = "$<TARGET_FILE:cmkr>"
|
|
||||||
working-directory = "interface"
|
working-directory = "interface"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
arguments = ["build"]
|
arguments = ["build"]
|
||||||
|
|
||||||
[[test]]
|
[[test]]
|
||||||
name = "fetch-content"
|
name = "fetch-content"
|
||||||
command = "$<TARGET_FILE:cmkr>"
|
|
||||||
working-directory = "fetch-content"
|
working-directory = "fetch-content"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
arguments = ["build"]
|
arguments = ["build"]
|
||||||
|
|
||||||
[[test]]
|
[[test]]
|
||||||
name = "conditions"
|
name = "conditions"
|
||||||
command = "$<TARGET_FILE:cmkr>"
|
|
||||||
working-directory = "conditions"
|
working-directory = "conditions"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
arguments = ["build"]
|
arguments = ["build"]
|
||||||
|
|
||||||
[[test]]
|
[[test]]
|
||||||
name = "vcpkg"
|
name = "vcpkg"
|
||||||
command = "$<TARGET_FILE:cmkr>"
|
|
||||||
working-directory = "vcpkg"
|
working-directory = "vcpkg"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
arguments = ["build"]
|
arguments = ["build"]
|
||||||
|
|
||||||
[[test]]
|
[[test]]
|
||||||
name = "cxx-standard"
|
name = "cxx-standard"
|
||||||
command = "$<TARGET_FILE:cmkr>"
|
|
||||||
working-directory = "cxx-standard"
|
working-directory = "cxx-standard"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
arguments = ["build"]
|
arguments = ["build"]
|
||||||
|
|
||||||
[[test]]
|
[[test]]
|
||||||
name = "globbing"
|
name = "globbing"
|
||||||
command = "$<TARGET_FILE:cmkr>"
|
|
||||||
working-directory = "globbing"
|
working-directory = "globbing"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
|
arguments = ["build"]
|
||||||
|
|
||||||
|
[[test]]
|
||||||
|
name = "templates"
|
||||||
|
working-directory = "templates"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
|
arguments = ["build"]
|
||||||
|
|
||||||
|
[[test]]
|
||||||
|
condition = "msvc"
|
||||||
|
name = "msvc-runtime"
|
||||||
|
working-directory = "msvc-runtime"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
|
arguments = ["build"]
|
||||||
|
|
||||||
|
[[test]]
|
||||||
|
name = "compile-options"
|
||||||
|
working-directory = "compile-options"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
|
arguments = ["build"]
|
||||||
|
|
||||||
|
[[test]]
|
||||||
|
condition = "windows"
|
||||||
|
name = "relative-paths"
|
||||||
|
working-directory = "relative-paths"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
|
arguments = ["build"]
|
||||||
|
|
||||||
|
[[test]]
|
||||||
|
name = "objective-c"
|
||||||
|
working-directory = "objective-c"
|
||||||
|
command = "$<TARGET_FILE:cmkr>"
|
||||||
arguments = ["build"]
|
arguments = ["build"]
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# Example project that sets compiler flags and preprocessor defines for various platforms.
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "compile-options"
|
||||||
|
description = "Compiler flags"
|
||||||
|
|
||||||
|
[target.hello]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
msvc.compile-options = ["/W2"]
|
||||||
|
msvc.compile-definitions = ["PLATFORM=\"msvc\""]
|
||||||
|
gcc.compile-options = ["-Wall"]
|
||||||
|
gcc.compile-definitions = ["PLATFORM=\"gcc\""]
|
||||||
|
clang.compile-options = ["-Wall"]
|
||||||
|
clang.compile-definitions = ["PLATFORM=\"clang\""]
|
||||||
|
|
||||||
|
# The `hello` target uses [conditions](/cmake-toml#conditions) to set different compiler flags and definitions depending on the platform. See the [targets](/cmake-toml/#targets) documentation for other things you can set.
|
||||||
|
# _Note_: In general you only want to specify flags _required_ to compile your code without errors.
|
||||||
@@ -1,6 +1,5 @@
|
|||||||
#include <cstdio>
|
#include <cstdio>
|
||||||
|
|
||||||
int main()
|
int main() {
|
||||||
{
|
|
||||||
puts("Hello from cmkr!");
|
puts("Hello from cmkr!");
|
||||||
}
|
}
|
||||||
@@ -2,6 +2,9 @@
|
|||||||
name = "conditions"
|
name = "conditions"
|
||||||
cmake-after = "set(CUSTOM ON)"
|
cmake-after = "set(CUSTOM ON)"
|
||||||
|
|
||||||
|
[options]
|
||||||
|
CONDITIONS_BUILD_TESTS = "root"
|
||||||
|
|
||||||
[conditions]
|
[conditions]
|
||||||
custom = "CUSTOM"
|
custom = "CUSTOM"
|
||||||
|
|
||||||
@@ -15,6 +18,8 @@ macos.cmake-after = "message(STATUS macos-after)"
|
|||||||
linux.cmake-after = "message(STATUS linux-after)"
|
linux.cmake-after = "message(STATUS linux-after)"
|
||||||
unix.cmake-after = "message(STATUS unix-after)"
|
unix.cmake-after = "message(STATUS unix-after)"
|
||||||
custom.cmake-after = "message(STATUS custom-after)"
|
custom.cmake-after = "message(STATUS custom-after)"
|
||||||
|
build-tests.cmake-after = "message(STATUS build-tests)"
|
||||||
|
"CONDITIONS_BUILD_TESTS AND $<linux>".cmake-after = "message(STATUS linux-tests)"
|
||||||
|
|
||||||
[target.example.properties]
|
[target.example.properties]
|
||||||
AUTOMOC = false
|
AUTOMOC = false
|
||||||
|
|||||||
@@ -1 +1,2 @@
|
|||||||
int main() { }
|
int main() {
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
#include <Windows.h>
|
#include <Windows.h>
|
||||||
|
|
||||||
void foo() { }
|
void foo() {
|
||||||
|
}
|
||||||
@@ -1,8 +1,7 @@
|
|||||||
#include <cstdio>
|
#include <cstdio>
|
||||||
#include <tuple>
|
#include <tuple>
|
||||||
|
|
||||||
int main()
|
int main() {
|
||||||
{
|
|
||||||
auto tpl = std::make_tuple(1, 2);
|
auto tpl = std::make_tuple(1, 2);
|
||||||
printf("Hello from C++11 %d\n", std::get<0>(tpl));
|
printf("Hello from C++11 %d\n", std::get<0>(tpl));
|
||||||
}
|
}
|
||||||
@@ -4,8 +4,9 @@
|
|||||||
name = "fetch-content"
|
name = "fetch-content"
|
||||||
description = "Fetching from git"
|
description = "Fetching from git"
|
||||||
|
|
||||||
[fetch-content]
|
[fetch-content.fmt]
|
||||||
fmt = { git = "https://github.com/fmtlib/fmt", tag = "7.1.3" }
|
git = "https://github.com/fmtlib/fmt"
|
||||||
|
tag = "7.1.3"
|
||||||
|
|
||||||
[target.example]
|
[target.example]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
#include <fmt/core.h>
|
#include <fmt/core.h>
|
||||||
|
|
||||||
int main()
|
int main() {
|
||||||
{
|
|
||||||
fmt::print("Hello, world!\n");
|
fmt::print("Hello, world!\n");
|
||||||
}
|
}
|
||||||
@@ -2,7 +2,6 @@
|
|||||||
|
|
||||||
#include <string>
|
#include <string>
|
||||||
|
|
||||||
namespace mylib
|
namespace mylib {
|
||||||
{
|
|
||||||
std::string message();
|
std::string message();
|
||||||
}
|
} // namespace mylib
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
#include <mylib/mylib.hpp>
|
#include <mylib/mylib.hpp>
|
||||||
|
|
||||||
std::string mylib::message()
|
std::string mylib::message() {
|
||||||
{
|
|
||||||
return "cmkr is awesome!";
|
return "cmkr is awesome!";
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ description = "Header-only library"
|
|||||||
[target.mylib]
|
[target.mylib]
|
||||||
type = "interface"
|
type = "interface"
|
||||||
include-directories = ["include"]
|
include-directories = ["include"]
|
||||||
|
compile-features = ["cxx_std_11"]
|
||||||
|
|
||||||
[target.example]
|
[target.example]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
namespace mylib
|
namespace mylib {
|
||||||
{
|
static const char *version() {
|
||||||
static const char* version() { return "v1.0"; }
|
return "v1.0";
|
||||||
|
}
|
||||||
} // namespace mylib
|
} // namespace mylib
|
||||||
@@ -2,7 +2,6 @@
|
|||||||
|
|
||||||
#include "mylib/mylib.hpp"
|
#include "mylib/mylib.hpp"
|
||||||
|
|
||||||
int main()
|
int main() {
|
||||||
{
|
printf("mylib version: %s\n", mylib::version());
|
||||||
printf("mylib version: %s\n", mylib::version())
|
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
[project]
|
||||||
|
name = "msvc-runtime"
|
||||||
|
description = "Static MSVC runtime"
|
||||||
|
msvc-runtime = "static"
|
||||||
|
|
||||||
|
# This target will compile with a static runtime
|
||||||
|
[target.static-runtime]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
|
||||||
|
# This target overrides the [project].msvc-runtime
|
||||||
|
[target.dynamic-runtime]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
msvc-runtime = "dynamic"
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
#include <cstdio>
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
puts("Hello from cmkr(msvc-static)!");
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Add Objective-C sources on Apple platforms:
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "objective-c"
|
||||||
|
description = "Objective-C"
|
||||||
|
languages = ["C"]
|
||||||
|
apple.languages = ["OBJC"]
|
||||||
|
|
||||||
|
[target.hello]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.c"]
|
||||||
|
apple.sources = ["src/apple.m"]
|
||||||
|
apple.link-libraries = ["$<LINK_LIBRARY:FRAMEWORK,Foundation>"]
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
#import <Foundation/Foundation.h>
|
||||||
|
|
||||||
|
void platform_specific() {
|
||||||
|
NSFileHandle *stdout = [NSFileHandle fileHandleWithStandardOutput];
|
||||||
|
NSString *message = @"Hello from Objective-C!\n";
|
||||||
|
[stdout writeData:[message dataUsingEncoding:NSUTF8StringEncoding] error:nil];
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
#include <stdio.h>
|
||||||
|
|
||||||
|
#ifdef __APPLE__
|
||||||
|
void platform_specific();
|
||||||
|
#else
|
||||||
|
void platform_specific() {
|
||||||
|
puts("This is not an Apple platform.");
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
platform_specific();
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
[project]
|
||||||
|
name = "relative-paths"
|
||||||
|
|
||||||
|
[target.test-library]
|
||||||
|
type = "static"
|
||||||
|
sources = ["src/library-code.cpp"]
|
||||||
|
|
||||||
|
[target.example]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/main.cpp"]
|
||||||
|
windows.link-libraries = ["libs/test-library-x64-Release.lib"]
|
||||||
Binary file not shown.
@@ -0,0 +1,6 @@
|
|||||||
|
// Created by Anthony Printup on 9/18/2023.
|
||||||
|
#include <cstdio>
|
||||||
|
|
||||||
|
extern "C" void library_function() {
|
||||||
|
std::puts("Hello from library_function!");
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
// Created by Anthony Printup on 9/18/2023.
|
||||||
|
#include <cstdio>
|
||||||
|
|
||||||
|
#ifdef WIN32
|
||||||
|
extern "C" void library_function();
|
||||||
|
#endif
|
||||||
|
int main() {
|
||||||
|
puts("Hello from cmkr(relative-paths)!");
|
||||||
|
#ifdef WIN32
|
||||||
|
library_function();
|
||||||
|
#endif
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# To avoid repeating yourself in targets you can create your own target type (template). All properties of the template are inherited when used as a target type.
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "templates"
|
||||||
|
description = "Target templates"
|
||||||
|
|
||||||
|
[template.app]
|
||||||
|
type = "executable"
|
||||||
|
sources = ["src/templates.cpp"]
|
||||||
|
compile-definitions = ["IS_APP"]
|
||||||
|
# Unlike interface targets you can also inherit properties
|
||||||
|
properties = {
|
||||||
|
CXX_STANDARD = "11",
|
||||||
|
CXX_STANDARD_REQUIRED = true,
|
||||||
|
}
|
||||||
|
|
||||||
|
[target.app-a]
|
||||||
|
type = "app"
|
||||||
|
compile-definitions = ["APP_A"]
|
||||||
|
|
||||||
|
[target.app-b]
|
||||||
|
type = "app"
|
||||||
|
compile-definitions = ["APP_B"]
|
||||||
|
|
||||||
|
# **Note**: In most cases you probably want to use an [interface](/examples/interface) target instead.
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
#include <cstdio>
|
||||||
|
|
||||||
|
#if !defined(IS_APP)
|
||||||
|
#error Something went wrong with the template
|
||||||
|
#endif // IS_APP
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
#if defined(APP_A)
|
||||||
|
puts("Hello from app A!");
|
||||||
|
#elif defined(APP_B)
|
||||||
|
puts("Hello from app B!");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
@@ -1,17 +1,16 @@
|
|||||||
# Downloads [fmt v7.1.3](https://fmt.dev/7.1.3/) using [vcpkg](https://vcpkg.io/) and links an `example` target to it:
|
# Downloads [fmt v7.1.3](https://fmt.dev/7.1.3/) using [vcpkg](https://github.com/microsoft/vcpkg) and links an `example` target to it:
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "vcpkg"
|
name = "vcpkg"
|
||||||
description = "Dependencies from vcpkg"
|
description = "Dependencies from vcpkg"
|
||||||
|
|
||||||
# See https://github.com/microsoft/vcpkg/releases for vcpkg versions
|
# See https://github.com/microsoft/vcpkg/releases for vcpkg versions
|
||||||
# See https://vcpkg.io/en/packages.html for available packages
|
# See https://vcpkg.io/en/packages or https://vcpkg.link for available packages
|
||||||
[vcpkg]
|
[vcpkg]
|
||||||
version = "2021.05.12"
|
version = "2024.11.16"
|
||||||
packages = ["fmt"]
|
packages = ["fmt"]
|
||||||
|
|
||||||
[find-package]
|
[find-package.fmt]
|
||||||
fmt = {}
|
|
||||||
|
|
||||||
[target.example]
|
[target.example]
|
||||||
type = "executable"
|
type = "executable"
|
||||||
@@ -19,3 +18,4 @@ sources = ["src/main.cpp"]
|
|||||||
link-libraries = ["fmt::fmt"]
|
link-libraries = ["fmt::fmt"]
|
||||||
|
|
||||||
# The bootstrapping of vcpkg is fully automated and no user interaction is necessary. You can disable vcpkg by setting `CMKR_DISABLE_VCPKG=ON`.
|
# The bootstrapping of vcpkg is fully automated and no user interaction is necessary. You can disable vcpkg by setting `CMKR_DISABLE_VCPKG=ON`.
|
||||||
|
# To specify package features you can use the following syntax: `imgui[docking-experimental,freetype,sdl2-binding,opengl3-binding]`.
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
#include <fmt/core.h>
|
#include <fmt/core.h>
|
||||||
|
|
||||||
int main()
|
int main() {
|
||||||
{
|
|
||||||
fmt::print("Hello, world!\n");
|
fmt::print("Hello, world!\n");
|
||||||
}
|
}
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"$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",
|
|
||||||
"dependencies": [
|
|
||||||
"fmt"
|
|
||||||
],
|
|
||||||
"description": "Dependencies from vcpkg",
|
|
||||||
"name": "vcpkg",
|
|
||||||
"version-string": ""
|
|
||||||
}
|
|
||||||
Vendored
+3
@@ -0,0 +1,3 @@
|
|||||||
|
# Disable clang-format in this folder
|
||||||
|
DisableFormat: true
|
||||||
|
SortIncludes: Never
|
||||||
+2
-5
@@ -11,12 +11,9 @@ target_compile_definitions(ordered_map INTERFACE NOMINMAX)
|
|||||||
|
|
||||||
# https://github.com/ToruNiina/toml11 (MIT)
|
# https://github.com/ToruNiina/toml11 (MIT)
|
||||||
add_library(toml11 INTERFACE)
|
add_library(toml11 INTERFACE)
|
||||||
target_include_directories(toml11 INTERFACE toml11-3.6.0)
|
target_include_directories(toml11 INTERFACE toml11-3.8.1)
|
||||||
|
target_compile_definitions(toml11 INTERFACE TOML11_USE_UNRELEASED_TOML_FEATURES)
|
||||||
|
|
||||||
# https://github.com/mpark/variant (BSL-1.0)
|
# https://github.com/mpark/variant (BSL-1.0)
|
||||||
add_library(mpark_variant INTERFACE)
|
add_library(mpark_variant INTERFACE)
|
||||||
target_include_directories(mpark_variant INTERFACE variant-1.4.0/include)
|
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)
|
|
||||||
Vendored
-21
@@ -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.
|
|
||||||
-25447
File diff suppressed because it is too large
Load Diff
@@ -25,21 +25,14 @@
|
|||||||
#ifndef TOML_FOR_MODERN_CPP
|
#ifndef TOML_FOR_MODERN_CPP
|
||||||
#define TOML_FOR_MODERN_CPP
|
#define TOML_FOR_MODERN_CPP
|
||||||
|
|
||||||
#ifndef __cplusplus
|
|
||||||
# error "__cplusplus is not defined"
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if __cplusplus < 201103L && _MSC_VER < 1900
|
|
||||||
# error "toml11 requires C++11 or later."
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#define TOML11_VERSION_MAJOR 3
|
#define TOML11_VERSION_MAJOR 3
|
||||||
#define TOML11_VERSION_MINOR 5
|
#define TOML11_VERSION_MINOR 8
|
||||||
#define TOML11_VERSION_PATCH 0
|
#define TOML11_VERSION_PATCH 1
|
||||||
|
|
||||||
#include "toml/parser.hpp"
|
#include "toml/parser.hpp"
|
||||||
#include "toml/literal.hpp"
|
#include "toml/literal.hpp"
|
||||||
#include "toml/serializer.hpp"
|
#include "toml/serializer.hpp"
|
||||||
#include "toml/get.hpp"
|
#include "toml/get.hpp"
|
||||||
|
#include "toml/macros.hpp"
|
||||||
|
|
||||||
#endif// TOML_FOR_MODERN_CPP
|
#endif// TOML_FOR_MODERN_CPP
|
||||||
+45
@@ -17,11 +17,41 @@ namespace color_ansi
|
|||||||
{
|
{
|
||||||
namespace detail
|
namespace detail
|
||||||
{
|
{
|
||||||
|
|
||||||
inline int colorize_index()
|
inline int colorize_index()
|
||||||
{
|
{
|
||||||
static const int index = std::ios_base::xalloc();
|
static const int index = std::ios_base::xalloc();
|
||||||
return index;
|
return index;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Control color mode globally
|
||||||
|
class color_mode
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
inline void enable()
|
||||||
|
{
|
||||||
|
should_color_ = true;
|
||||||
|
}
|
||||||
|
inline void disable()
|
||||||
|
{
|
||||||
|
should_color_ = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
inline bool should_color() const
|
||||||
|
{
|
||||||
|
return should_color_;
|
||||||
|
}
|
||||||
|
|
||||||
|
static color_mode& status()
|
||||||
|
{
|
||||||
|
static color_mode status_;
|
||||||
|
return status_;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
bool should_color_ = false;
|
||||||
|
};
|
||||||
|
|
||||||
} // detail
|
} // detail
|
||||||
|
|
||||||
inline std::ostream& colorize(std::ostream& os)
|
inline std::ostream& colorize(std::ostream& os)
|
||||||
@@ -55,6 +85,21 @@ inline std::ostream& cyan (std::ostream& os)
|
|||||||
{if(os.iword(detail::colorize_index()) == 1) {os << "\033[36m";} return os;}
|
{if(os.iword(detail::colorize_index()) == 1) {os << "\033[36m";} return os;}
|
||||||
inline std::ostream& white (std::ostream& os)
|
inline std::ostream& white (std::ostream& os)
|
||||||
{if(os.iword(detail::colorize_index()) == 1) {os << "\033[37m";} return os;}
|
{if(os.iword(detail::colorize_index()) == 1) {os << "\033[37m";} return os;}
|
||||||
|
|
||||||
|
inline void enable()
|
||||||
|
{
|
||||||
|
return detail::color_mode::status().enable();
|
||||||
|
}
|
||||||
|
inline void disable()
|
||||||
|
{
|
||||||
|
return detail::color_mode::status().disable();
|
||||||
|
}
|
||||||
|
|
||||||
|
inline bool should_color()
|
||||||
|
{
|
||||||
|
return detail::color_mode::status().should_color();
|
||||||
|
}
|
||||||
|
|
||||||
} // color_ansi
|
} // color_ansi
|
||||||
|
|
||||||
// ANSI escape sequence is the only and default colorization method currently
|
// ANSI escape sequence is the only and default colorization method currently
|
||||||
Vendored
+2
-2
@@ -29,7 +29,7 @@ namespace detail
|
|||||||
// to output character as an error message.
|
// to output character as an error message.
|
||||||
inline std::string show_char(const char c)
|
inline std::string show_char(const char c)
|
||||||
{
|
{
|
||||||
// It supress an error that occurs only in Debug mode of MSVC++ on Windows.
|
// It suppresses an error that occurs only in Debug mode of MSVC++ on Windows.
|
||||||
// I'm not completely sure but they check the value of char to be in the
|
// I'm not completely sure but they check the value of char to be in the
|
||||||
// range [0, 256) and some of the COMPLETELY VALID utf-8 character sometimes
|
// range [0, 256) and some of the COMPLETELY VALID utf-8 character sometimes
|
||||||
// has negative value (if char has sign). So here it re-interprets c as
|
// has negative value (if char has sign). So here it re-interprets c as
|
||||||
@@ -154,7 +154,7 @@ struct sequence<Head, Tail...>
|
|||||||
invoke(location& loc)
|
invoke(location& loc)
|
||||||
{
|
{
|
||||||
const auto first = loc.iter();
|
const auto first = loc.iter();
|
||||||
const auto rslt = Head::invoke(loc);
|
auto rslt = Head::invoke(loc);
|
||||||
if(rslt.is_err())
|
if(rslt.is_err())
|
||||||
{
|
{
|
||||||
loc.reset(first);
|
loc.reset(first);
|
||||||
+26
-7
@@ -4,11 +4,18 @@
|
|||||||
#define TOML11_COMMENTS_HPP
|
#define TOML11_COMMENTS_HPP
|
||||||
#include <initializer_list>
|
#include <initializer_list>
|
||||||
#include <iterator>
|
#include <iterator>
|
||||||
|
#include <stdexcept>
|
||||||
#include <string>
|
#include <string>
|
||||||
#include <type_traits>
|
#include <type_traits>
|
||||||
#include <utility>
|
#include <utility>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
|
|
||||||
|
#ifdef TOML11_PRESERVE_COMMENTS_BY_DEFAULT
|
||||||
|
# define TOML11_DEFAULT_COMMENT_STRATEGY ::toml::preserve_comments
|
||||||
|
#else
|
||||||
|
# define TOML11_DEFAULT_COMMENT_STRATEGY ::toml::discard_comments
|
||||||
|
#endif
|
||||||
|
|
||||||
// This file provides mainly two classes, `preserve_comments` and `discard_comments`.
|
// This file provides mainly two classes, `preserve_comments` and `discard_comments`.
|
||||||
// Those two are a container that have the same interface as `std::vector<std::string>`
|
// Those two are a container that have the same interface as `std::vector<std::string>`
|
||||||
// but bahaves in the opposite way. `preserve_comments` is just the same as
|
// but bahaves in the opposite way. `preserve_comments` is just the same as
|
||||||
@@ -339,7 +346,7 @@ operator+(const empty_iterator<T, C>& lhs, typename empty_iterator<T, C>::differ
|
|||||||
//
|
//
|
||||||
// Why this is chose as the default type is because the last version (2.x.y)
|
// Why this is chose as the default type is because the last version (2.x.y)
|
||||||
// does not contain any comments in a value. To minimize the impact on the
|
// does not contain any comments in a value. To minimize the impact on the
|
||||||
// efficiency, this is choosed as a default.
|
// efficiency, this is chosen as a default.
|
||||||
//
|
//
|
||||||
// To reduce the memory footprint, later we can try empty base optimization (EBO).
|
// To reduce the memory footprint, later we can try empty base optimization (EBO).
|
||||||
struct discard_comments
|
struct discard_comments
|
||||||
@@ -418,14 +425,14 @@ struct discard_comments
|
|||||||
// empty, so accessing through operator[], front/back, data causes address
|
// empty, so accessing through operator[], front/back, data causes address
|
||||||
// error.
|
// error.
|
||||||
|
|
||||||
reference operator[](const size_type) noexcept {return *data();}
|
reference operator[](const size_type) noexcept {never_call("toml::discard_comment::operator[]");}
|
||||||
const_reference operator[](const size_type) const noexcept {return *data();}
|
const_reference operator[](const size_type) const noexcept {never_call("toml::discard_comment::operator[]");}
|
||||||
reference at(const size_type) {throw std::out_of_range("toml::discard_comment is always empty.");}
|
reference at(const size_type) {throw std::out_of_range("toml::discard_comment is always empty.");}
|
||||||
const_reference at(const size_type) const {throw std::out_of_range("toml::discard_comment is always empty.");}
|
const_reference at(const size_type) const {throw std::out_of_range("toml::discard_comment is always empty.");}
|
||||||
reference front() noexcept {return *data();}
|
reference front() noexcept {never_call("toml::discard_comment::front");}
|
||||||
const_reference front() const noexcept {return *data();}
|
const_reference front() const noexcept {never_call("toml::discard_comment::front");}
|
||||||
reference back() noexcept {return *data();}
|
reference back() noexcept {never_call("toml::discard_comment::back");}
|
||||||
const_reference back() const noexcept {return *data();}
|
const_reference back() const noexcept {never_call("toml::discard_comment::back");}
|
||||||
|
|
||||||
pointer data() noexcept {return nullptr;}
|
pointer data() noexcept {return nullptr;}
|
||||||
const_pointer data() const noexcept {return nullptr;}
|
const_pointer data() const noexcept {return nullptr;}
|
||||||
@@ -443,6 +450,18 @@ struct discard_comments
|
|||||||
const_reverse_iterator rend() const noexcept {return const_iterator{};}
|
const_reverse_iterator rend() const noexcept {return const_iterator{};}
|
||||||
const_reverse_iterator crbegin() const noexcept {return const_iterator{};}
|
const_reverse_iterator crbegin() const noexcept {return const_iterator{};}
|
||||||
const_reverse_iterator crend() const noexcept {return const_iterator{};}
|
const_reverse_iterator crend() const noexcept {return const_iterator{};}
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
[[noreturn]] static void never_call(const char *const this_function)
|
||||||
|
{
|
||||||
|
#ifdef __has_builtin
|
||||||
|
# if __has_builtin(__builtin_unreachable)
|
||||||
|
__builtin_unreachable();
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
throw std::logic_error{this_function};
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
inline bool operator==(const discard_comments&, const discard_comments&) noexcept {return true;}
|
inline bool operator==(const discard_comments&, const discard_comments&) noexcept {return true;}
|
||||||
+32
-32
@@ -21,22 +21,7 @@ namespace toml
|
|||||||
namespace detail
|
namespace detail
|
||||||
{
|
{
|
||||||
// TODO: find more sophisticated way to handle this
|
// TODO: find more sophisticated way to handle this
|
||||||
#if (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 1) || defined(_XOPEN_SOURCE) || defined(_BSD_SOURCE) || defined(_SVID_SOURCE) || defined(_POSIX_SOURCE)
|
#if defined(_MSC_VER)
|
||||||
inline std::tm localtime_s(const std::time_t* src)
|
|
||||||
{
|
|
||||||
std::tm dst;
|
|
||||||
const auto result = ::localtime_r(src, &dst);
|
|
||||||
if (!result) { throw std::runtime_error("localtime_r failed."); }
|
|
||||||
return dst;
|
|
||||||
}
|
|
||||||
inline std::tm gmtime_s(const std::time_t* src)
|
|
||||||
{
|
|
||||||
std::tm dst;
|
|
||||||
const auto result = ::gmtime_r(src, &dst);
|
|
||||||
if (!result) { throw std::runtime_error("gmtime_r failed."); }
|
|
||||||
return dst;
|
|
||||||
}
|
|
||||||
#elif defined(_MSC_VER)
|
|
||||||
inline std::tm localtime_s(const std::time_t* src)
|
inline std::tm localtime_s(const std::time_t* src)
|
||||||
{
|
{
|
||||||
std::tm dst;
|
std::tm dst;
|
||||||
@@ -51,6 +36,21 @@ inline std::tm gmtime_s(const std::time_t* src)
|
|||||||
if (result) { throw std::runtime_error("gmtime_s failed."); }
|
if (result) { throw std::runtime_error("gmtime_s failed."); }
|
||||||
return dst;
|
return dst;
|
||||||
}
|
}
|
||||||
|
#elif (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 1) || defined(_XOPEN_SOURCE) || defined(_BSD_SOURCE) || defined(_SVID_SOURCE) || defined(_POSIX_SOURCE)
|
||||||
|
inline std::tm localtime_s(const std::time_t* src)
|
||||||
|
{
|
||||||
|
std::tm dst;
|
||||||
|
const auto result = ::localtime_r(src, &dst);
|
||||||
|
if (!result) { throw std::runtime_error("localtime_r failed."); }
|
||||||
|
return dst;
|
||||||
|
}
|
||||||
|
inline std::tm gmtime_s(const std::time_t* src)
|
||||||
|
{
|
||||||
|
std::tm dst;
|
||||||
|
const auto result = ::gmtime_r(src, &dst);
|
||||||
|
if (!result) { throw std::runtime_error("gmtime_r failed."); }
|
||||||
|
return dst;
|
||||||
|
}
|
||||||
#else // fallback. not threadsafe
|
#else // fallback. not threadsafe
|
||||||
inline std::tm localtime_s(const std::time_t* src)
|
inline std::tm localtime_s(const std::time_t* src)
|
||||||
{
|
{
|
||||||
@@ -85,9 +85,9 @@ enum class month_t : std::uint8_t
|
|||||||
|
|
||||||
struct local_date
|
struct local_date
|
||||||
{
|
{
|
||||||
std::int16_t year; // A.D. (like, 2018)
|
std::int16_t year{}; // A.D. (like, 2018)
|
||||||
std::uint8_t month; // [0, 11]
|
std::uint8_t month{}; // [0, 11]
|
||||||
std::uint8_t day; // [1, 31]
|
std::uint8_t day{}; // [1, 31]
|
||||||
|
|
||||||
local_date(int y, month_t m, int d)
|
local_date(int y, month_t m, int d)
|
||||||
: year (static_cast<std::int16_t>(y)),
|
: year (static_cast<std::int16_t>(y)),
|
||||||
@@ -181,12 +181,12 @@ operator<<(std::basic_ostream<charT, traits>& os, const local_date& date)
|
|||||||
|
|
||||||
struct local_time
|
struct local_time
|
||||||
{
|
{
|
||||||
std::uint8_t hour; // [0, 23]
|
std::uint8_t hour{}; // [0, 23]
|
||||||
std::uint8_t minute; // [0, 59]
|
std::uint8_t minute{}; // [0, 59]
|
||||||
std::uint8_t second; // [0, 60]
|
std::uint8_t second{}; // [0, 60]
|
||||||
std::uint16_t millisecond; // [0, 999]
|
std::uint16_t millisecond{}; // [0, 999]
|
||||||
std::uint16_t microsecond; // [0, 999]
|
std::uint16_t microsecond{}; // [0, 999]
|
||||||
std::uint16_t nanosecond; // [0, 999]
|
std::uint16_t nanosecond{}; // [0, 999]
|
||||||
|
|
||||||
local_time(int h, int m, int s,
|
local_time(int h, int m, int s,
|
||||||
int ms = 0, int us = 0, int ns = 0)
|
int ms = 0, int us = 0, int ns = 0)
|
||||||
@@ -297,8 +297,8 @@ operator<<(std::basic_ostream<charT, traits>& os, const local_time& time)
|
|||||||
|
|
||||||
struct time_offset
|
struct time_offset
|
||||||
{
|
{
|
||||||
std::int8_t hour; // [-12, 12]
|
std::int8_t hour{}; // [-12, 12]
|
||||||
std::int8_t minute; // [-59, 59]
|
std::int8_t minute{}; // [-59, 59]
|
||||||
|
|
||||||
time_offset(int h, int m)
|
time_offset(int h, int m)
|
||||||
: hour (static_cast<std::int8_t>(h)),
|
: hour (static_cast<std::int8_t>(h)),
|
||||||
@@ -364,8 +364,8 @@ operator<<(std::basic_ostream<charT, traits>& os, const time_offset& offset)
|
|||||||
|
|
||||||
struct local_datetime
|
struct local_datetime
|
||||||
{
|
{
|
||||||
local_date date;
|
local_date date{};
|
||||||
local_time time;
|
local_time time{};
|
||||||
|
|
||||||
local_datetime(local_date d, local_time t): date(d), time(t) {}
|
local_datetime(local_date d, local_time t): date(d), time(t) {}
|
||||||
|
|
||||||
@@ -478,9 +478,9 @@ operator<<(std::basic_ostream<charT, traits>& os, const local_datetime& dt)
|
|||||||
|
|
||||||
struct offset_datetime
|
struct offset_datetime
|
||||||
{
|
{
|
||||||
local_date date;
|
local_date date{};
|
||||||
local_time time;
|
local_time time{};
|
||||||
time_offset offset;
|
time_offset offset{};
|
||||||
|
|
||||||
offset_datetime(local_date d, local_time t, time_offset o)
|
offset_datetime(local_date d, local_time t, time_offset o)
|
||||||
: date(d), time(t), offset(o)
|
: date(d), time(t), offset(o)
|
||||||
+19
-1
@@ -2,14 +2,32 @@
|
|||||||
// Distributed under the MIT License.
|
// Distributed under the MIT License.
|
||||||
#ifndef TOML11_EXCEPTION_HPP
|
#ifndef TOML11_EXCEPTION_HPP
|
||||||
#define TOML11_EXCEPTION_HPP
|
#define TOML11_EXCEPTION_HPP
|
||||||
#include <stdexcept>
|
|
||||||
|
#include <array>
|
||||||
#include <string>
|
#include <string>
|
||||||
|
#include <stdexcept>
|
||||||
|
|
||||||
|
#include <cstring>
|
||||||
|
|
||||||
#include "source_location.hpp"
|
#include "source_location.hpp"
|
||||||
|
|
||||||
namespace toml
|
namespace toml
|
||||||
{
|
{
|
||||||
|
|
||||||
|
struct file_io_error : public std::runtime_error
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
file_io_error(int errnum, const std::string& msg, const std::string& fname)
|
||||||
|
: std::runtime_error(msg + " \"" + fname + "\": errno = " + std::to_string(errnum)),
|
||||||
|
errno_(errnum)
|
||||||
|
{}
|
||||||
|
|
||||||
|
int get_errno() const noexcept {return errno_;}
|
||||||
|
|
||||||
|
private:
|
||||||
|
int errno_;
|
||||||
|
};
|
||||||
|
|
||||||
struct exception : public std::exception
|
struct exception : public std::exception
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
-1
@@ -2,7 +2,6 @@
|
|||||||
// Distributed under the MIT License.
|
// Distributed under the MIT License.
|
||||||
#ifndef TOML11_FROM_HPP
|
#ifndef TOML11_FROM_HPP
|
||||||
#define TOML11_FROM_HPP
|
#define TOML11_FROM_HPP
|
||||||
#include "traits.hpp"
|
|
||||||
|
|
||||||
namespace toml
|
namespace toml
|
||||||
{
|
{
|
||||||
+101
-13
@@ -140,7 +140,7 @@ get(basic_value<C, M, V>&& v)
|
|||||||
// ============================================================================
|
// ============================================================================
|
||||||
// std::string_view
|
// std::string_view
|
||||||
|
|
||||||
#if __cplusplus >= 201703L
|
#if defined(TOML11_USING_STRING_VIEW) && TOML11_USING_STRING_VIEW>0
|
||||||
template<typename T, typename C,
|
template<typename T, typename C,
|
||||||
template<typename ...> class M, template<typename ...> class V>
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
inline detail::enable_if_t<std::is_same<T, std::string_view>::value, std::string_view>
|
inline detail::enable_if_t<std::is_same<T, std::string_view>::value, std::string_view>
|
||||||
@@ -215,6 +215,7 @@ template<typename T, typename C,
|
|||||||
detail::enable_if_t<detail::conjunction<
|
detail::enable_if_t<detail::conjunction<
|
||||||
detail::is_container<T>, // T is a container
|
detail::is_container<T>, // T is a container
|
||||||
detail::negation<detail::has_push_back_method<T>>, // w/o push_back(...)
|
detail::negation<detail::has_push_back_method<T>>, // w/o push_back(...)
|
||||||
|
detail::negation<detail::has_specialized_from<T>>, // T does not have special conversion
|
||||||
detail::negation< // not toml::array
|
detail::negation< // not toml::array
|
||||||
detail::is_exact_toml_type<T, basic_value<C, M, V>>>
|
detail::is_exact_toml_type<T, basic_value<C, M, V>>>
|
||||||
>::value, T>
|
>::value, T>
|
||||||
@@ -255,19 +256,37 @@ get(const basic_value<C, M, V>&);
|
|||||||
|
|
||||||
// toml::from<T>::from_toml(v)
|
// toml::from<T>::from_toml(v)
|
||||||
template<typename T, typename C,
|
template<typename T, typename C,
|
||||||
template<typename ...> class M, template<typename ...> class V,
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
std::size_t S = sizeof(::toml::from<T>)>
|
detail::enable_if_t<detail::has_specialized_from<T>::value, T>
|
||||||
T get(const basic_value<C, M, V>&);
|
get(const basic_value<C, M, V>&);
|
||||||
|
|
||||||
// T(const toml::value&) and T is not toml::basic_value
|
template<typename T, typename C,
|
||||||
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
|
detail::enable_if_t<detail::has_specialized_from<T>::value, T>
|
||||||
|
get(basic_value<C, M, V>&);
|
||||||
|
|
||||||
|
// T(const toml::value&) and T is not toml::basic_value,
|
||||||
|
// and it does not have `from<T>` nor `from_toml`.
|
||||||
template<typename T, typename C,
|
template<typename T, typename C,
|
||||||
template<typename ...> class M, template<typename ...> class V>
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
detail::enable_if_t<detail::conjunction<
|
detail::enable_if_t<detail::conjunction<
|
||||||
detail::negation<detail::is_basic_value<T>>,
|
detail::negation<detail::is_basic_value<T>>,
|
||||||
std::is_constructible<T, const basic_value<C, M, V>&>
|
std::is_constructible<T, const basic_value<C, M, V>&>,
|
||||||
|
detail::negation<detail::has_from_toml_method<T, C, M, V>>,
|
||||||
|
detail::negation<detail::has_specialized_from<T>>
|
||||||
>::value, T>
|
>::value, T>
|
||||||
get(const basic_value<C, M, V>&);
|
get(const basic_value<C, M, V>&);
|
||||||
|
|
||||||
|
template<typename T, typename C,
|
||||||
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
|
detail::enable_if_t<detail::conjunction<
|
||||||
|
detail::negation<detail::is_basic_value<T>>,
|
||||||
|
std::is_constructible<T, basic_value<C, M, V>&>,
|
||||||
|
detail::negation<detail::has_from_toml_method<T, C, M, V>>,
|
||||||
|
detail::negation<detail::has_specialized_from<T>>
|
||||||
|
>::value, T>
|
||||||
|
get(basic_value<C, M, V>&);
|
||||||
|
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
// array-like types; most likely STL container, like std::vector, etc.
|
// array-like types; most likely STL container, like std::vector, etc.
|
||||||
|
|
||||||
@@ -321,6 +340,7 @@ template<typename T, typename C,
|
|||||||
detail::enable_if_t<detail::conjunction<
|
detail::enable_if_t<detail::conjunction<
|
||||||
detail::is_container<T>, // T is a container
|
detail::is_container<T>, // T is a container
|
||||||
detail::negation<detail::has_push_back_method<T>>, // w/o push_back
|
detail::negation<detail::has_push_back_method<T>>, // w/o push_back
|
||||||
|
detail::negation<detail::has_specialized_from<T>>, // T does not have special conversion
|
||||||
detail::negation< // T is not toml::array
|
detail::negation< // T is not toml::array
|
||||||
detail::is_exact_toml_type<T, basic_value<C, M, V>>>
|
detail::is_exact_toml_type<T, basic_value<C, M, V>>>
|
||||||
>::value, T>
|
>::value, T>
|
||||||
@@ -338,8 +358,10 @@ get(const basic_value<C, M, V>& v)
|
|||||||
{v.location(), "here"}
|
{v.location(), "here"}
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
std::transform(ar.cbegin(), ar.cend(), container.begin(),
|
for(std::size_t i=0; i<ar.size(); ++i)
|
||||||
[](const value& x){return ::toml::get<value_type>(x);});
|
{
|
||||||
|
container[i] = ::toml::get<value_type>(ar[i]);
|
||||||
|
}
|
||||||
return container;
|
return container;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -438,9 +460,16 @@ get(const basic_value<C, M, V>& v)
|
|||||||
return ud;
|
return ud;
|
||||||
}
|
}
|
||||||
template<typename T, typename C,
|
template<typename T, typename C,
|
||||||
template<typename ...> class M, template<typename ...> class V,
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
std::size_t>
|
detail::enable_if_t<detail::has_specialized_from<T>::value, T>
|
||||||
T get(const basic_value<C, M, V>& v)
|
get(const basic_value<C, M, V>& v)
|
||||||
|
{
|
||||||
|
return ::toml::from<T>::from_toml(v);
|
||||||
|
}
|
||||||
|
template<typename T, typename C,
|
||||||
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
|
detail::enable_if_t<detail::has_specialized_from<T>::value, T>
|
||||||
|
get(basic_value<C, M, V>& v)
|
||||||
{
|
{
|
||||||
return ::toml::from<T>::from_toml(v);
|
return ::toml::from<T>::from_toml(v);
|
||||||
}
|
}
|
||||||
@@ -448,14 +477,29 @@ T get(const basic_value<C, M, V>& v)
|
|||||||
template<typename T, typename C,
|
template<typename T, typename C,
|
||||||
template<typename ...> class M, template<typename ...> class V>
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
detail::enable_if_t<detail::conjunction<
|
detail::enable_if_t<detail::conjunction<
|
||||||
detail::negation<detail::is_basic_value<T>>,
|
detail::negation<detail::is_basic_value<T>>, // T is not a toml::value
|
||||||
std::is_constructible<T, const basic_value<C, M, V>&>
|
std::is_constructible<T, const basic_value<C, M, V>&>, // T is constructible from toml::value
|
||||||
|
detail::negation<detail::has_from_toml_method<T, C, M, V>>, // and T does not have T.from_toml(v);
|
||||||
|
detail::negation<detail::has_specialized_from<T>> // and T does not have toml::from<T>{};
|
||||||
>::value, T>
|
>::value, T>
|
||||||
get(const basic_value<C, M, V>& v)
|
get(const basic_value<C, M, V>& v)
|
||||||
{
|
{
|
||||||
return T(v);
|
return T(v);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
template<typename T, typename C,
|
||||||
|
template<typename ...> class M, template<typename ...> class V>
|
||||||
|
detail::enable_if_t<detail::conjunction<
|
||||||
|
detail::negation<detail::is_basic_value<T>>, // T is not a toml::value
|
||||||
|
std::is_constructible<T, basic_value<C, M, V>&>, // T is constructible from toml::value
|
||||||
|
detail::negation<detail::has_from_toml_method<T, C, M, V>>, // and T does not have T.from_toml(v);
|
||||||
|
detail::negation<detail::has_specialized_from<T>> // and T does not have toml::from<T>{};
|
||||||
|
>::value, T>
|
||||||
|
get(basic_value<C, M, V>& v)
|
||||||
|
{
|
||||||
|
return T(v);
|
||||||
|
}
|
||||||
|
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
// find
|
// find
|
||||||
|
|
||||||
@@ -1031,6 +1075,50 @@ find_or(const basic_value<C, M, V>& v, const toml::key& ky, T&& opt)
|
|||||||
return get_or(tab.at(ky), std::forward<T>(opt));
|
return get_or(tab.at(ky), std::forward<T>(opt));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// recursive find-or with type deduction (find_or(value, keys, opt))
|
||||||
|
|
||||||
|
template<typename Value, typename ... Ks,
|
||||||
|
typename detail::enable_if_t<(sizeof...(Ks) > 1), std::nullptr_t> = nullptr>
|
||||||
|
// here we need to add SFINAE in the template parameter to avoid
|
||||||
|
// infinite recursion in type deduction on gcc
|
||||||
|
auto find_or(Value&& v, const toml::key& ky, Ks&& ... keys)
|
||||||
|
-> decltype(find_or(std::forward<Value>(v), ky, detail::last_one(std::forward<Ks>(keys)...)))
|
||||||
|
{
|
||||||
|
if(!v.is_table())
|
||||||
|
{
|
||||||
|
return detail::last_one(std::forward<Ks>(keys)...);
|
||||||
|
}
|
||||||
|
auto&& tab = std::forward<Value>(v).as_table();
|
||||||
|
if(tab.count(ky) == 0)
|
||||||
|
{
|
||||||
|
return detail::last_one(std::forward<Ks>(keys)...);
|
||||||
|
}
|
||||||
|
return find_or(std::forward<decltype(tab)>(tab).at(ky), std::forward<Ks>(keys)...);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// recursive find_or with explicit type specialization, find_or<int>(value, keys...)
|
||||||
|
|
||||||
|
template<typename T, typename Value, typename ... Ks,
|
||||||
|
typename detail::enable_if_t<(sizeof...(Ks) > 1), std::nullptr_t> = nullptr>
|
||||||
|
// here we need to add SFINAE in the template parameter to avoid
|
||||||
|
// infinite recursion in type deduction on gcc
|
||||||
|
auto find_or(Value&& v, const toml::key& ky, Ks&& ... keys)
|
||||||
|
-> decltype(find_or<T>(std::forward<Value>(v), ky, detail::last_one(std::forward<Ks>(keys)...)))
|
||||||
|
{
|
||||||
|
if(!v.is_table())
|
||||||
|
{
|
||||||
|
return detail::last_one(std::forward<Ks>(keys)...);
|
||||||
|
}
|
||||||
|
auto&& tab = std::forward<Value>(v).as_table();
|
||||||
|
if(tab.count(ky) == 0)
|
||||||
|
{
|
||||||
|
return detail::last_one(std::forward<Ks>(keys)...);
|
||||||
|
}
|
||||||
|
return find_or(std::forward<decltype(tab)>(tab).at(ky), std::forward<Ks>(keys)...);
|
||||||
|
}
|
||||||
|
|
||||||
// ============================================================================
|
// ============================================================================
|
||||||
// expect
|
// expect
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user