Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
add initial project structure
mostly copied from https://github.com/lefticus/cpp_starter_project and adapted to my needs and taste
- Loading branch information
Showing
16 changed files
with
533 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
AccessModifierOffset: -2 | ||
AlignAfterOpenBracket: DontAlign | ||
AlignConsecutiveAssignments: None | ||
AlignConsecutiveDeclarations: None | ||
AlignEscapedNewlines: Left | ||
AlignOperands: AlignAfterOperator | ||
AlignTrailingComments: true | ||
AllowAllParametersOfDeclarationOnNextLine: false | ||
AllowShortBlocksOnASingleLine: Empty | ||
AllowShortCaseLabelsOnASingleLine: false | ||
AllowShortFunctionsOnASingleLine: Inline | ||
AllowShortIfStatementsOnASingleLine: true | ||
AllowShortLoopsOnASingleLine: true | ||
AlwaysBreakAfterDefinitionReturnType: None | ||
AlwaysBreakAfterReturnType: None | ||
AlwaysBreakBeforeMultilineStrings: true | ||
AlwaysBreakTemplateDeclarations: Yes | ||
BinPackArguments: false | ||
BinPackParameters: false | ||
BraceWrapping: | ||
AfterCaseLabel: false | ||
AfterClass: true | ||
AfterControlStatement: Never | ||
AfterEnum: false | ||
AfterFunction: false | ||
AfterNamespace: false | ||
AfterObjCDeclaration: false | ||
AfterStruct: true | ||
AfterUnion: false | ||
AfterExternBlock: true | ||
BeforeCatch: false | ||
BeforeElse: false | ||
BeforeLambdaBody: false | ||
BeforeWhile: false | ||
IndentBraces: false | ||
SplitEmptyFunction: false | ||
SplitEmptyNamespace: true | ||
SplitEmptyRecord: true | ||
BreakAfterJavaFieldAnnotations: true | ||
BreakBeforeBinaryOperators: NonAssignment | ||
BreakBeforeBraces: Attach | ||
BreakBeforeTernaryOperators: true | ||
BreakConstructorInitializers: BeforeComma | ||
BreakStringLiterals: true | ||
ColumnLimit: 0 | ||
CommentPragmas: '^ IWYU pragma:' | ||
CompactNamespaces: false | ||
ConstructorInitializerAllOnOneLineOrOnePerLine: false | ||
ConstructorInitializerIndentWidth: 2 | ||
ContinuationIndentWidth: 2 | ||
Cpp11BracedListStyle: false | ||
DerivePointerAlignment: false | ||
DisableFormat: false | ||
ExperimentalAutoDetectBinPacking: true | ||
FixNamespaceComments: true | ||
ForEachMacros: | ||
- foreach | ||
- Q_FOREACH | ||
- BOOST_FOREACH | ||
IncludeCategories: | ||
- Priority: 2 | ||
Regex: ^"(llvm|llvm-c|clang|clang-c)/ | ||
- Priority: 3 | ||
Regex: ^(<|"(catch2|gmock|isl|json)/) | ||
- Priority: 1 | ||
Regex: .* | ||
IncludeIsMainRegex: (Test)?$ | ||
IndentCaseLabels: false | ||
IndentWidth: 2 | ||
IndentWrappedFunctionNames: true | ||
JavaScriptQuotes: Leave | ||
JavaScriptWrapImports: true | ||
KeepEmptyLinesAtTheStartOfBlocks: false | ||
Language: Cpp | ||
MacroBlockBegin: '' | ||
MacroBlockEnd: '' | ||
MaxEmptyLinesToKeep: 2 | ||
NamespaceIndentation: None | ||
ObjCBlockIndentWidth: 4 | ||
ObjCSpaceAfterProperty: true | ||
ObjCSpaceBeforeProtocolList: false | ||
PointerAlignment: Right | ||
ReflowComments: true | ||
SortIncludes: CaseInsensitive | ||
SortUsingDeclarations: true | ||
SpaceAfterCStyleCast: false | ||
SpaceAfterTemplateKeyword: true | ||
SpaceBeforeAssignmentOperators: true | ||
SpaceBeforeParens: ControlStatements | ||
SpaceInEmptyParentheses: false | ||
SpacesBeforeTrailingComments: 1 | ||
SpacesInAngles: Never | ||
SpacesInCStyleCastParentheses: false | ||
SpacesInContainerLiterals: true | ||
SpacesInParentheses: false | ||
SpacesInSquareBrackets: false | ||
Standard: c++20 | ||
TabWidth: 8 | ||
UseTab: Never | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
Checks: '*,-fuchsia-*,-google-*,-zircon-*,-abseil-*,-modernize-use-trailing-return-type,-llvm*' | ||
WarningsAsErrors: '' | ||
HeaderFilterRegex: '' | ||
FormatStyle: none |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
cmake_minimum_required(VERSION 3.15) | ||
|
||
project(fix CXX) | ||
include(cmake/StandardProjectSettings.cmake) | ||
include(cmake/PreventInSourceBuilds.cmake) | ||
|
||
# enable cache system | ||
include(cmake/Cache.cmake) | ||
|
||
# enable doxygen | ||
include(cmake/Doxygen.cmake) | ||
enable_doxygen() | ||
|
||
|
||
# standard compiler warnings | ||
include(cmake/CompilerWarnings.cmake) | ||
# Link this 'library' to use the warnings specified in CompilerWarnings.cmake | ||
add_library(project_warnings INTERFACE) | ||
set_project_warnings(project_warnings) | ||
|
||
|
||
# Link this 'library' to set the c++ standard / compile-time options requested | ||
add_library(project_options INTERFACE) | ||
target_compile_features(project_options INTERFACE cxx_std_20) | ||
|
||
if (CMAKE_CXX_COMPILER_ID MATCHES ".*Clang") | ||
option(ENABLE_BUILD_WITH_TIME_TRACE "Enable -ftime-trace to generate time tracing .json files on clang" OFF) | ||
if (ENABLE_BUILD_WITH_TIME_TRACE) | ||
target_compile_options(project_options INTERFACE -ftime-trace) | ||
endif () | ||
endif () | ||
|
||
# sanitizer options if supported by compiler | ||
include(cmake/Sanitizers.cmake) | ||
enable_sanitizers(project_options) | ||
|
||
# allow for static analysis options | ||
include(cmake/StaticAnalyzers.cmake) | ||
|
||
option(ENABLE_TESTING "Enable Test Builds" ON) | ||
|
||
# Set up some extra Conan dependencies based on our needs before loading Conan | ||
set(CONAN_EXTRA_REQUIRES "") | ||
set(CONAN_EXTRA_OPTIONS "") | ||
|
||
include(cmake/Conan.cmake) | ||
run_conan() | ||
|
||
add_subdirectory(src) | ||
|
||
if (ENABLE_TESTING) | ||
enable_testing() | ||
message("Building Tests. Be sure to check out test/constexpr_tests for constexpr testing") | ||
add_subdirectory(test) | ||
endif () | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
This is free and unencumbered software released into the public domain. | ||
|
||
Anyone is free to copy, modify, publish, use, compile, sell, or | ||
distribute this software, either in source code form or as a compiled | ||
binary, for any purpose, commercial or non-commercial, and by any | ||
means. | ||
|
||
In jurisdictions that recognize copyright laws, the author or authors | ||
of this software dedicate any and all copyright interest in the | ||
software to the public domain. We make this dedication for the benefit | ||
of the public at large and to the detriment of our heirs and | ||
successors. We intend this dedication to be an overt act of | ||
relinquishment in perpetuity of all present and future rights to this | ||
software under copyright law. | ||
|
||
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 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. | ||
|
||
For more information, please refer to <https://unlicense.org> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
option(ENABLE_CACHE "Enable cache if available" ON) | ||
if(NOT ENABLE_CACHE) | ||
return() | ||
endif() | ||
|
||
set(CACHE_OPTION | ||
"ccache" | ||
CACHE STRING "Compiler cache to be used") | ||
set(CACHE_OPTION_VALUES "ccache" "sccache") | ||
set_property(CACHE CACHE_OPTION PROPERTY STRINGS ${CACHE_OPTION_VALUES}) | ||
list( | ||
FIND | ||
CACHE_OPTION_VALUES | ||
${CACHE_OPTION} | ||
CACHE_OPTION_INDEX) | ||
|
||
if(${CACHE_OPTION_INDEX} EQUAL -1) | ||
message( | ||
STATUS | ||
"Using custom compiler cache system: '${CACHE_OPTION}', explicitly supported entries are ${CACHE_OPTION_VALUES}") | ||
endif() | ||
|
||
find_program(CACHE_BINARY ${CACHE_OPTION}) | ||
if(CACHE_BINARY) | ||
message(STATUS "${CACHE_OPTION} found and enabled") | ||
set(CMAKE_CXX_COMPILER_LAUNCHER ${CACHE_BINARY}) | ||
else() | ||
message(WARNING "${CACHE_OPTION} is enabled but was not found. Not using it") | ||
endif() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# from here: | ||
# | ||
# https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md | ||
|
||
function(set_project_warnings project_name) | ||
option(WARNINGS_AS_ERRORS "Treat compiler warnings as errors" ON) | ||
|
||
set(MSVC_WARNINGS | ||
/W4 # Baseline reasonable warnings | ||
/w14242 # 'identifier': conversion from 'type1' to 'type1', possible loss of data | ||
/w14254 # 'operator': conversion from 'type1:field_bits' to 'type2:field_bits', possible loss of data | ||
/w14263 # 'function': member function does not override any base class virtual member function | ||
/w14265 # 'classname': class has virtual functions, but destructor is not virtual instances of this class may not | ||
# be destructed correctly | ||
/w14287 # 'operator': unsigned/negative constant mismatch | ||
/we4289 # nonstandard extension used: 'variable': loop control variable declared in the for-loop is used outside | ||
# the for-loop scope | ||
/w14296 # 'operator': expression is always 'boolean_value' | ||
/w14311 # 'variable': pointer truncation from 'type1' to 'type2' | ||
/w14545 # expression before comma evaluates to a function which is missing an argument list | ||
/w14546 # function call before comma missing argument list | ||
/w14547 # 'operator': operator before comma has no effect; expected operator with side-effect | ||
/w14549 # 'operator': operator before comma has no effect; did you intend 'operator'? | ||
/w14555 # expression has no effect; expected expression with side- effect | ||
/w14619 # pragma warning: there is no warning number 'number' | ||
/w14640 # Enable warning on thread un-safe static member initialization | ||
/w14826 # Conversion from 'type1' to 'type_2' is sign-extended. This may cause unexpected runtime behavior. | ||
/w14905 # wide string literal cast to 'LPSTR' | ||
/w14906 # string literal cast to 'LPWSTR' | ||
/w14928 # illegal copy-initialization; more than one user-defined conversion has been implicitly applied | ||
/permissive- # standards conformance mode for MSVC compiler. | ||
) | ||
|
||
set(CLANG_WARNINGS | ||
-Wall | ||
-Wextra # reasonable and standard | ||
-Wshadow # warn the user if a variable declaration shadows one from a parent context | ||
-Wnon-virtual-dtor # warn the user if a class with virtual functions has a non-virtual destructor. This helps | ||
# catch hard to track down memory errors | ||
-Wold-style-cast # warn for c-style casts | ||
-Wcast-align # warn for potential performance problem casts | ||
-Wunused # warn on anything being unused | ||
-Woverloaded-virtual # warn if you overload (not override) a virtual function | ||
-Wpedantic # warn if non-standard C++ is used | ||
-Wconversion # warn on type conversions that may lose data | ||
-Wsign-conversion # warn on sign conversions | ||
-Wnull-dereference # warn if a null dereference is detected | ||
-Wdouble-promotion # warn if float is implicit promoted to double | ||
-Wformat=2 # warn on security issues around functions that format output (ie printf) | ||
) | ||
|
||
if (WARNINGS_AS_ERRORS) | ||
set(CLANG_WARNINGS ${CLANG_WARNINGS} -Werror) | ||
set(MSVC_WARNINGS ${MSVC_WARNINGS} /WX) | ||
endif () | ||
|
||
set(GCC_WARNINGS | ||
${CLANG_WARNINGS} | ||
-Wmisleading-indentation # warn if indentation implies blocks where blocks do not exist | ||
-Wduplicated-cond # warn if if / else chain has duplicated conditions | ||
-Wduplicated-branches # warn if if / else branches have duplicated code | ||
-Wlogical-op # warn about logical operations being used where bitwise were probably wanted | ||
-Wuseless-cast # warn if you perform a cast to the same type | ||
) | ||
|
||
if (MSVC) | ||
set(PROJECT_WARNINGS ${MSVC_WARNINGS}) | ||
elseif (CMAKE_CXX_COMPILER_ID MATCHES ".*Clang") | ||
set(PROJECT_WARNINGS ${CLANG_WARNINGS}) | ||
elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU") | ||
set(PROJECT_WARNINGS ${GCC_WARNINGS}) | ||
else () | ||
message(AUTHOR_WARNING "No compiler warnings set for '${CMAKE_CXX_COMPILER_ID}' compiler.") | ||
endif () | ||
|
||
target_compile_options(${project_name} INTERFACE ${PROJECT_WARNINGS}) | ||
|
||
endfunction() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
macro(run_conan) | ||
# Download automatically, you can also just copy the conan.cmake file | ||
if (NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake") | ||
message(STATUS "Downloading conan.cmake from https://github.com/conan-io/cmake-conan") | ||
file(DOWNLOAD "https://github.com/conan-io/cmake-conan/raw/v0.15/conan.cmake" "${CMAKE_BINARY_DIR}/conan.cmake") | ||
endif () | ||
|
||
include(${CMAKE_BINARY_DIR}/conan.cmake) | ||
|
||
conan_add_remote( | ||
NAME | ||
bincrafters | ||
URL | ||
https://api.bintray.com/conan/bincrafters/public-conan) | ||
|
||
conan_cmake_run( | ||
REQUIRES | ||
${CONAN_EXTRA_REQUIRES} | ||
catch2/2.13.6 | ||
fmt/8.0.1 | ||
OPTIONS | ||
${CONAN_EXTRA_OPTIONS} | ||
BASIC_SETUP | ||
CMAKE_TARGETS # individual targets to link to | ||
BUILD | ||
missing) | ||
endmacro() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
function(enable_doxygen) | ||
option(ENABLE_DOXYGEN "Enable doxygen doc builds of source" OFF) | ||
if (ENABLE_DOXYGEN) | ||
set(DOXYGEN_CALLER_GRAPH YES) | ||
set(DOXYGEN_CALL_GRAPH YES) | ||
set(DOXYGEN_EXTRACT_ALL YES) | ||
find_package(Doxygen REQUIRED dot) | ||
doxygen_add_docs(doxygen-docs ${PROJECT_SOURCE_DIR}) | ||
|
||
endif () | ||
endfunction() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# | ||
# This function will prevent in-source builds | ||
function(AssureOutOfSourceBuilds) | ||
# make sure the user doesn't play dirty with symlinks | ||
get_filename_component(srcdir "${CMAKE_SOURCE_DIR}" REALPATH) | ||
get_filename_component(bindir "${CMAKE_BINARY_DIR}" REALPATH) | ||
|
||
# disallow in-source builds | ||
if ("${srcdir}" STREQUAL "${bindir}") | ||
message("######################################################") | ||
message("Warning: in-source builds are disabled") | ||
message("Please create a separate build directory and run cmake from there") | ||
message("######################################################") | ||
message(FATAL_ERROR "Quitting configuration") | ||
endif () | ||
endfunction() | ||
|
||
assureoutofsourcebuilds() |
Oops, something went wrong.