From 2e79e48416d679098cf8c650c061368c8553dab6 Mon Sep 17 00:00:00 2001 From: S David <2100425+s-daveb@users.noreply.github.com> Date: Tue, 12 Dec 2023 21:22:17 -0500 Subject: [PATCH] Fork project from template project. This is a combination of 4 commits. 1. First commit after forking template project 2. Write real README.md 3. Remove spurrious text from LICENSE 4. Clarify which version of the MPL this project is covered under --- .gitignore | 7 + CMakeLists.txt | 89 +++++---- LICENSE | 388 +++++++++++++++++++++++++++++++++++++-- README.md | 41 +++-- app/CMakeLists.txt | 14 +- data/.keep | 0 editorconfig/.keep | 0 editorconfig/local.vimrc | 130 +++++++++++++ src/CMakeLists.txt | 27 ++- tests/CMakeLists.txt | 30 ++- tests/runtime-tests.cpp | 2 +- 11 files changed, 636 insertions(+), 92 deletions(-) create mode 100644 data/.keep create mode 100644 editorconfig/.keep create mode 100644 editorconfig/local.vimrc diff --git a/.gitignore b/.gitignore index 569e1c2..4305b94 100644 --- a/.gitignore +++ b/.gitignore @@ -132,3 +132,10 @@ Thumbs.db venv/ env/ +### Manually Entered +vim-debug/ +**/out/bin +**/out/lib +**/out/share +_deps + diff --git a/CMakeLists.txt b/CMakeLists.txt index c7ea882..98e2d12 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,27 +9,31 @@ if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0") cmake_policy(SET CMP0135 NEW) endif() -# When this package is included as a subproject, there's no need to -# build and run the unit-tests. Setting -DENABLE_TESTS to false could -# speed up build time for pacakge maintainers +# Check if this CMakeFile is being built as part of a FetchContent CMake +# dependency download. if (NOT DEFINED PROJECT_NAME) + # When this package is included as a subproject, save some time by skipping + # the unit test build and execution. + # To override this, set -DENABLE_TESTS=true when you call CMake option(ENABLE_TESTS "Build and run unit tests" ON) else() option(ENABLE_TESTS "Build and run unit tests" OFF) endif() +project(Elemental + VERSION 0.0.1 + LANGUAGES C CXX + # Save this for later: + # HOMEPAGE_URL + DESCRIPTION "A simple top-down strategy game" +) + +# Custom CMake Defines / Command-line options option(USE_SYSTEM_CATCH2 "Do not download & compile catch2 library for unit tests" ON ) -project( - VERSION 0.1 - LANGUAGES C CXX - # HOMEPAGE_URL - DESCRIPTION "Description" -) - IF( NOT CMAKE_BUILD_TYPE ) SET( CMAKE_BUILD_TYPE Debug ) ENDIF() @@ -37,11 +41,11 @@ ENDIF() set(CMAKE_C_STANDARD 17) set(CMAKE_CXX_STANDARD 20) -# Disable GNU compiler extensions +# Disable non-portable GNU compiler extensions set(CMAKE_C_EXTENSIONS OFF) set(CMAKE_CXX_EXTENSIONS OFF) -# Search for the code caching compiler wrapper, ccache and enable it +# Check if ccache is installed and enable CMake integration # if found. This will speed up repeated builds. find_program(CCACHE_PATH ccache) if(CCACHE_PATH) @@ -69,23 +73,37 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS On) include(FetchContent) # Initialize pkgconf -#find_package(PkgConfig REQUIRED) +find_package(PkgConfig REQUIRED) # Example: Find SDL2, SDL2_image, and SDL2_gfx using PkgConfig # add IMPORTED_TARGET to enable fancy PkgConfig::SDL2 syntax -#pkg_check_modules(SDL2 REQUIRED IMPORTED_TARGET SDL2) -#pkg_check_modules(SDL2_IMAGE REQUIRED IMPORTED_TARGET SDL2_image) -#pkg_check_modules(SDL2_GFX REQUIRED IMPORTED_TARGET SDL2_gfx) +pkg_check_modules(SDL2 REQUIRED IMPORTED_TARGET SDL2) +pkg_check_modules(SDL2_IMAGE REQUIRED IMPORTED_TARGET SDL2_image) +pkg_check_modules(SDL2_GFX REQUIRED IMPORTED_TARGET SDL2_gfx) +pkg_check_modules(NLOHMANN_JSON "nlohmann_json >= 3.11.2" REQUIRED) -#set(engine_DEP_LIBS -# PkgConfig::SDL2 -# PkgConfig::SDL2_IMAGE -# PkgConfig::SDL2for_GFX -# # if not using PkgConfig:: IMPORTED_TARGET syntax -# ${SDL2_LIBRARIES} -# ${SDL2_IMG_LIBRARIES} -# ${SDL2_GFX_LIBRARIES} -#) +if (SDL2_FOUND) + include_directories(${SDL2_INCLUDE_DIRS}) + link_directories(AFTER ${SDL2_IMG_LIBRARY_DIRS}) +endif() +if (SDL2_IMG_FOUND) + include_directories(${SDL2_IMG_INCLUDE_DIRS}) + link_directories(AFTER ${SDL2_LIBRARY_DIRS}) +endif() +if (SDL2_GFX_FOUND) + include_directories(${SDL2_GFX_INCLUDE_DIRS}) + link_directories(AFTER ${SDL2_GFX_LIBRARY_DIRS}) +endif() +if (NLOHMANN_JSON_FOUND) + include_directories(${NLOHMANN_JSON_INCLUDE_DIRS}) + #add_link_options(${NLOHMANN_JSON_LDFLAGS}) +endif() + +set(SDL2_LINK_DEPS + PkgConfig::SDL2 + PkgConfig::SDL2_IMAGE + PkgConfig::SDL2_GFX +) if (ENABLE_TESTS) if (NOT USE_SYSTEM_CATCH2) @@ -99,6 +117,7 @@ if (ENABLE_TESTS) include_directories(${CATCH2_INCLUDE_DIRS}) link_directories(${CATCH2_LIBRARY_DIRS}) endif() + FetchContent_Declare( FakeIt URL https://github.com/eranpeer/FakeIt/archive/refs/tags/2.4.0.zip @@ -122,19 +141,20 @@ if (ENABLE_TESTS) endif() # Set output directories for build targets -set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/build/lib) -set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/build/lib) -set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/build/bin) +set(OUTPUT_DIR ${CMAKE_BINARY_DIR}/out) +set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${OUTPUT_DIR}/lib) +set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${OUTPUT_DIR}/lib) +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${OUTPUT_DIR}/bin) # Include directories -include_directories(${CMAKE_SOURCE_DIR}/src) +#include_directories(${CMAKE_SOURCE_DIR}/src) include_directories(${CMAKE_SOURCE_DIR}/include) -# Example: Add a target to copy application resource files to the build dir -#add_custom_target(copy_assets -#COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/data ${CMAKE_BINARY_DIR}/artifacts/share/data -# COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/data ${CMAKE_BINARY_DIR}/tests/data - #) +# Add a target to copy application resource files to the build dir +add_custom_target(copy_assets + COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/data ${OUTPUT_DIR}/share/data + COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/data ${CMAKE_BINARY_DIR}/tests/data +) # Add subdirectories add_subdirectory(src) @@ -144,5 +164,4 @@ if(ENABLE_TESTS) add_subdirectory(tests) endif() - # vim: ts=2 sw=2 noet foldmethod=indent : diff --git a/LICENSE b/LICENSE index 2f2b7f3..3ac55e5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,375 @@ -Copyright (c) 2023 Saul D. Beniquez +Copyright © Saul D. Beniquez -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: +Mozilla Public License Version 2.0 +================================== -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +1. Definitions +-------------- -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. +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md index 6a81c1f..11eebd3 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,40 @@ -# C++20 CMake Project Template +# Elemental Game and Custom-built Game Engine -This is a simple C++20 project template using CMake for building and Catch2 v3 along with FakeIt for unit testing. The project is set up to fetch Catch2 and FakeIt using CMake's FetchContent command if they are not found on the system. +Welcome to Elemental Game, a game and custom-built game engine designed for creating simple, top-down strategy games. This README provides an overview of the project, its design principles, goals, and instructions for building and testing. ## Getting Started -### Prerequisites - +### Build Tools - CMake (version 3.21 or higher) - C++20-compatible compiler -- Catch2 installed on your system if you want to speed up compile time + +### Project Structure +- src/: Contains the engine logic, defines a libray target +- apps/: Contains the game source, as well as source for resource editors, all consumers of the engine target +- test/: Contains unit tests + +#### Library Dependencies + +- [Catch2](https://github.com/catchorg/Catch2) v3: Test framework for C++ (can be fetched using FetchContent). +- [FakeIt](https://github.com/eranpeer/FakeIt): Mocking framework for C++ (fetched using FetchContent). +- [SDL2](https://www.libsdl.org/): A cross-platform development library providing low-level access to audio, keyboard, mouse, and display functions. +- [SDL2_Image](https://www.libsdl.org/projects/SDL_image/): An extension library for SDL2, offering support for loading various image file formats. +- [SDL2_Gfx](https://sourceforge.net/projects/sdl2gfx/): A graphics primitive extension library for SDL2, providing additional functionality for efficient graphics rendering. ### Building the Project 1. Clone the repository: ``` - git clone https://github.com/your-username/your-project.git + git clone ``` 2. Navigate to the project directory: ``` - cd your-project + cd elemental-game ``` 3. Configure your build system: ```bash cmake -B debug -G Unix Makefiles # or - cmake -B debug -G Ninja + cmake -B debug -G Ninja # this is faster and more modern ``` 4. Invoke your build system ``` @@ -39,16 +50,8 @@ This is a simple C++20 project template using CMake for building and Catch2 v3 a ``` This will execute the Catch2 test suite. -## Project Structure -- src/: Contains the application logic, defines a libray target -- app/: Contains the application source, consumer of the library target -- test/: Contains unit tests using Catch2 and FakeIt. - -## Dependencies - -- Catch2 v3: Test framework for C++ (can be fetched using FetchContent). -- FakeIt: Mocking framework for C++ (fetched using FetchContent). - ## License -This project is licensed under the MIT License. +This project is licensed under the MPL 2.0 License. +Catch2, which is used for unit-testing is © Catch2 authors, and is licensed under the Boost Software License v1.0 +FakeIt, is also used for unit-testing and is © Eran Pe'er and is licensed under the MIT License diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt index d5d389c..8503f1e 100644 --- a/app/CMakeLists.txt +++ b/app/CMakeLists.txt @@ -1,15 +1,21 @@ -add_executable(app main.cpp) +set(game_SOURCES + main.cpp +) + +add_executable(game + ${game_SOURCES} +) #target_include_directories(app PRIVATE # ${CMAKE_SOURCE_DIR}/src/ #) -target_link_libraries(app PRIVATE - library +target_link_libraries(game PRIVATE + elemental ) # Manually adds a predefined target as a dependency -#add_dependencies(app copy-assets) +add_dependencies(game copy_assets) # vim: ts=2 sw=2 noet foldmethod=indent : diff --git a/data/.keep b/data/.keep new file mode 100644 index 0000000..e69de29 diff --git a/editorconfig/.keep b/editorconfig/.keep new file mode 100644 index 0000000..e69de29 diff --git a/editorconfig/local.vimrc b/editorconfig/local.vimrc new file mode 100644 index 0000000..92de6c1 --- /dev/null +++ b/editorconfig/local.vimrc @@ -0,0 +1,130 @@ + +" editorconfig/local.vimrc +" Copyright © 2023 Saul D. Beniquez @{ +" +" Redistribution and use in source and binary forms, with or without +" modification, are permitted provided that the following conditions are met: +" +" 1. Redistributions of source code must retain the above copyright notice, +" this list of conditions and the following disclaimer. +" +" 2. Redistributions in binary form must reproduce the above copyright notice, +" this list of conditions and the following disclaimer in the documentation +" and/or other materials provided with the distribution. +" +" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” +" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +" POSSIBILITY OF SUCH DAMAGE. @} + +let s:build_dir = 'vim-debug' +let s:build_cores = 2 +let s:make_args = '-C '. s:build_dir . ' -j ' . s:build_cores . ' ctest' + +let s:cmake_path = system('which ' . 'cmake') +let s:ninja_path = system('which ' . 'ninja') + +let s:cmake_generator = 'Unix Makefiles' +if (s:ninja_path != '') + let s:cmake_generator = 'Ninja' +endif + +if (s:cmake_path != '') + let s:cmake_call = s:cmake_path . + \' -B ' . s:build_dir . + \' -D ' . 'CMAKE_BUILD_TYPE=Debug' . + \' -G ' . s:cmake_generator +endif + +let s:make_call = 'make ' . s:make_args +let s:ninja_call = 'ninja ' . s:make_args + +if ! get(s:, 'defined', 0) " -- prevents the function from being redefined after compiling +function! BuildDebug() + let s:defined = 1 + + wall + + if (s:ninja_path != '') + if ( + \ (!filereadable(s:build_dir . '/CMakeCache.txt')) || + \ (!filereadable(s:build_dir . '/build.ninja')) + \ ) + + + exec ':Dispatch ' . s:cmake_call + endif + + set makeprg='ninja' + exec ':Make ' . s:make_args + else + if ( + \ (!filereadable(s:build_dir . '/CMakeCache.txt')) || + \ (!filereadable(s:build_dir . '/Makefile')) + \ ) + exec ':Dispatch ' . s:cmake_call + endif + + if exists(':Make') + exec ':Make ' . s:make_args + cd .. + else + exec 'make ' . s:make_args + vert botright copen + vert resize +100 + endif + endif + +endfunction + +function RunTests() + let s:defined = 1 + if (s:ninja_path != '') + if ( + \ (!filereadable(s:build_dir . '/CMakeCache.txt')) || + \ (!filereadable(s:build_dir . '/build.ninja')) + \ ) + + + exec ':Dispatch ' . s:cmake_call + endif + + set makeprg='ninja' + exec ':Make ' . s:make_args. ' ctest' + else + if ( + \ (!filereadable(s:build_dir . '/CMakeCache.txt')) || + \ (!filereadable(s:build_dir . '/Makefile')) + \ ) + exec ':Dispatch ' . s:cmake_call + endif + + if exists(':Make') + exec ':Make ' . s:make_args . ' ctest' + cd .. + else + exec 'make ' . s:make_args . ' ctest' + vert botright copen + vert resize +100 + endif + endif + +endfunction +endif + +nnoremap bd :call BuildDebug() +nnoremap rt :call RunTests() + +set path+=src +set path+=include +set path+=app + + +" vim: set ts=4 sts=4 noet sw=4 foldmethod=marker foldmarker=@{,@} : diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index e029451..e2e7c0d 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -1,17 +1,26 @@ # Define the library 'engine' -add_library(libraryobj OBJECT +add_library(elementalobj OBJECT library.cpp ) -# Define build targets for 'engine', 'engine-static', and 'engine-test' -add_library(library SHARED $) -add_library(library-static STATIC $) -add_library(library-testing $) +set(ELEMENTAL_LINK_DEPS + SDL2_LINK_TARGETS + # other libraries here +) +# build three different variants of this library +add_library(elemental SHARED $) +add_library(elemental-static STATIC $) +add_library(elemental-testing $) -# Link the SDL dependencies -target_link_libraries(library PUBLIC ${library_dep_libs} ) -target_link_libraries(library-static PUBLIC ${library_dep_libs} ) -target_link_libraries(library-testing PUBLIC ${library_dep_libs}) +# Define a preprocessor flag to enable helper code for unit-testing +# This flag will propagate to programs that link to this library (PUBLIC) +target_compile_definitions(elemental-testing PUBLIC -DUNIT_TEST=1) + +# Link the library dependencies publicly so that that users of this library +# Also get the same dependencies. +target_link_libraries(elemental PUBLIC ${elemental_dep_libs} ) +target_link_libraries(elemental-static PUBLIC ${elemental_dep_libs} ) +target_link_libraries(elemental-testing PUBLIC ${elemental_dep_libs}) # vim: ts=2 sw=2 noet foldmethod=indent : diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 7d5db25..757e6bd 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -1,19 +1,33 @@ # Define the executable 'test-runner' -add_executable(test-runner +set(test-runner_SOURCES runtime-tests.cpp ) +add_executable(test-runner + ${test-runner_SOURCES} +) + +target_compile_definitions(test-runner PRIVATE -DUNIT_TEST=1) + +set(TESTS_LINK_DEPS + Catch2::Catch2WithMain + ${SDL2_LINK_DEPS} + elemental-testing +) + +target_include_directories(test-runner PRIVATE + ${Catch2_INCLUDE_DIRS} + ${CMAKE_SOURCE_DIR}/src/tests + ${CMAKE_SOURCE_DIR}/src/tests/common +) -# Link the 'engine' library and SDL dependencies target_link_libraries(test-runner PRIVATE - library-testing - ${library_dep_libs} - Catch2::Catch2WithMain + ${TESTS_LINK_DEPS} ) # Set output directories for build targets set_target_properties(test-runner PROPERTIES - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/build/tests" + RUNTIME_OUTPUT_DIRECTORY "${OUTPUT_DIR}/tests" ) # extras: catch2 ctest integration. # add catch2's ctest cmake module and register the tests defined by mdml-tests @@ -25,11 +39,11 @@ catch_discover_tests(test-runner) # bonus: add a custom ctest target to the build system, to run tests in the # correct directory add_custom_target(ctest - command ctest -c $configuration --test-dir . --output-on-failure + COMMAND ctest -c $configuration --test-dir . --output-on-failure ) add_dependencies(ctest test-runner - #copy_assets + copy_assets ) # vim: ts=2 sw=2 noet foldmethod=indent : diff --git a/tests/runtime-tests.cpp b/tests/runtime-tests.cpp index f932236..1fd0792 100644 --- a/tests/runtime-tests.cpp +++ b/tests/runtime-tests.cpp @@ -1,5 +1,5 @@ -#include +#include TEST_CASE("Basic Catch2 Testcase") {