Initial commit

Author: adityavaishampayan

.gitignore

@@ -0,0 +1,36 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+*.x
+
+# Build directory
+build/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "external/doctest"]
+path = external/doctest
+url = https://github.com/onqtam/doctest.git

.travis.yml

@@ -0,0 +1,50 @@
+language: cpp
+dist: xenial
+notifications:
+ email: false
+
+# Define builds on mulitple OS/compiler combinations. 
+# Feel free to add/remove entries from this list.
+matrix:
+ include:
+ - os: linux
+ addons:
+ apt:
+ sources:
+ - ubuntu-toolchain-r-test
+ packages:
+ - lcov
+ - g++-7
+ env:
+ - MATRIX_EVAL="CXX_COMPILER=g++-7; sudo update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-7 90"
+
+ - os: osx
+ osx_image: xcode10.1
+ addons:
+ homebrew:
+ packages:
+ - lcov
+ env:
+ - MATRIX_EVAL="CXX_COMPILER=clang++"
+ 
+
+before_install:
+ - eval "${MATRIX_EVAL}"
+ - PARENTDIR=$(pwd)
+ - mkdir $PARENTDIR/build
+
+install: 
+ - cd $PARENTDIR/build
+ - cmake $PARENTDIR -DCMAKE_BUILD_TYPE=Coverage -DCMAKE_CXX_COMPILER=$CXX_COMPILER
+ - make
+
+script:
+ - make coverage
+
+after_success:
+ - cd $PARENTDIR/build
+ - lcov --list coverage_out.info.cleaned # Show test report in travis log.
+ # Install coverals gem for uploading coverage to coveralls.
+ - gem install coveralls-lcov
+ - coveralls-lcov coverage_out.info.cleaned # uploads to coveralls
+ - bash <(curl -s https://codecov.io/bash) -f coverage_out.info.cleaned || echo "Codecov did not collect coverage reports"

CMakeLists.txt

@@ -0,0 +1,81 @@
+# This file specifies how the project should be built, using CMake.
+# If you are unfamiliar with CMake, don't worry about all the details.
+# The sections you might want to edit are marked as such, and 
+# the comments should hopefully make most of it clear.
+#
+# For many purposes, you may not need to change anything about this file.
+
+cmake_minimum_required(VERSION 3.8.2)
+
+# Set project name, version and laguages here. (change as needed)
+# Version numbers are available by including "exampleConfig.h" in 
+# the source. See exampleConfig.h.in for some more details.
+project(CPP_BOILERPLATE VERSION 1.2.3.4 LANGUAGES CXX)
+
+
+# Options: Things you can set via commandline options to cmake (e.g. -DENABLE_LTO=[ON|OFF])
+option(ENABLE_WARNINGS_SETTINGS "Allow target_set_warnings to add flags and defines.
+ Set this to OFF if you want to provide your own warning parameters." ON)
+option(ENABLE_LTO "Enable link time optimization" ON)
+option(ENABLE_DOCTESTS "Include tests in the library. Setting this to OFF will remove all doctest related code.
+ Tests in tests/*.cpp will still be enabled." ON)
+
+# Include stuff. No change needed.
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
+include(ConfigSafeGuards)
+include(Colors)
+include(CTest)
+include(Doctest)
+include(Documentation)
+include(LTO)
+include(Misc)
+include(Warnings)
+
+# Check for LTO support.
+find_lto(CXX)
+
+# --------------------------------------------------------------------------------
+# Locate files (change as needed).
+# --------------------------------------------------------------------------------
+set(SOURCES # All .cpp files in src/
+ src/example.cpp
+)
+set(TESTFILES # All .cpp files in tests/
+ tests/main.cpp
+)
+set(LIBRARY_NAME engine) # Default name for the library built from src/*.cpp (change if you wish)
+
+# --------------------------------------------------------------------------------
+# Build! (Change as needed)
+# --------------------------------------------------------------------------------
+# Compile all sources into a library.
+add_library(${LIBRARY_NAME} OBJECT ${SOURCES})
+
+# Lib needs its header files, and users of the library must also see these (PUBLIC). (No change needed)
+target_include_directories(${LIBRARY_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
+
+# There's also (probably) doctests within the library, so we need to see this as well.
+target_link_libraries(${LIBRARY_NAME} PUBLIC doctest)
+
+# Set the compile options you want (change as needed).
+target_set_warnings(${LIBRARY_NAME} ENABLE ALL AS_ERROR ALL DISABLE Annoying)
+# target_compile_options(${LIBRARY_NAME} ... ) # For setting manually.
+
+# Add an executable for the file app/main.cpp.
+# If you add more executables, copy these lines accordingly.
+add_executable(main app/main.cpp) # Name of exec. and location of file.
+target_link_libraries(main PRIVATE ${LIBRARY_NAME}) # Link the executable to library (if it uses it).
+target_set_warnings(main ENABLE ALL AS_ERROR ALL DISABLE Annoying) # Set warnings (if needed).
+target_enable_lto(main optimized) # enable link-time-optimization if available for non-debug configurations
+
+# Set the properties you require, e.g. what C++ standard to use. Here applied to library and main (change as needed).
+set_target_properties(
+ ${LIBRARY_NAME} main 
+ PROPERTIES 
+ CXX_STANDARD 17 
+ CXX_STANDARD_REQUIRED YES 
+ CXX_EXTENSIONS NO
+)
+
+# Set up tests (see tests/CMakeLists.txt).
+add_subdirectory(tests)