generated from cpp-best-practices/cmake_template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 79527f8
Showing
61 changed files
with
4,096 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,98 @@ | ||
AccessModifierOffset: -2 | ||
AlignAfterOpenBracket: DontAlign | ||
AlignConsecutiveAssignments: false | ||
AlignConsecutiveDeclarations: false | ||
AlignEscapedNewlines: Left | ||
AlignOperands: true | ||
AlignTrailingComments: false | ||
AllowAllParametersOfDeclarationOnNextLine: false | ||
AllowShortBlocksOnASingleLine: true | ||
AllowShortCaseLabelsOnASingleLine: false | ||
AllowShortFunctionsOnASingleLine: All | ||
AllowShortIfStatementsOnASingleLine: true | ||
AllowShortLoopsOnASingleLine: true | ||
AlwaysBreakAfterDefinitionReturnType: None | ||
AlwaysBreakAfterReturnType: None | ||
AlwaysBreakBeforeMultilineStrings: true | ||
AlwaysBreakTemplateDeclarations: false | ||
BinPackArguments: false | ||
BinPackParameters: false | ||
BraceWrapping: | ||
AfterClass: true | ||
AfterControlStatement: false | ||
AfterEnum: false | ||
AfterFunction: true | ||
AfterNamespace: false | ||
AfterObjCDeclaration: false | ||
AfterStruct: true | ||
AfterUnion: false | ||
BeforeCatch: false | ||
BeforeElse: false | ||
IndentBraces: false | ||
SplitEmptyFunction: false | ||
SplitEmptyNamespace: true | ||
SplitEmptyRecord: true | ||
BreakAfterJavaFieldAnnotations: true | ||
BreakBeforeBinaryOperators: NonAssignment | ||
BreakBeforeBraces: Custom | ||
BreakBeforeInheritanceComma: true | ||
BreakBeforeTernaryOperators: true | ||
BreakConstructorInitializers: BeforeColon | ||
BreakConstructorInitializersBeforeComma: false | ||
BreakStringLiterals: true | ||
ColumnLimit: 120 | ||
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: ^(<|"(gtest|gmock|isl|json)/) | ||
- Priority: 1 | ||
Regex: .* | ||
IncludeIsMainRegex: (Test)?$ | ||
IndentCaseLabels: false | ||
IndentWidth: 2 | ||
IndentWrappedFunctionNames: true | ||
JavaScriptQuotes: Leave | ||
JavaScriptWrapImports: true | ||
KeepEmptyLinesAtTheStartOfBlocks: true | ||
Language: Cpp | ||
MacroBlockBegin: '' | ||
MacroBlockEnd: '' | ||
MaxEmptyLinesToKeep: 2 | ||
NamespaceIndentation: Inner | ||
ObjCBlockIndentWidth: 7 | ||
ObjCSpaceAfterProperty: true | ||
ObjCSpaceBeforeProtocolList: false | ||
PointerAlignment: Right | ||
ReflowComments: true | ||
SortIncludes: true | ||
SortUsingDeclarations: false | ||
SpaceAfterCStyleCast: false | ||
SpaceAfterTemplateKeyword: false | ||
SpaceBeforeAssignmentOperators: true | ||
SpaceBeforeParens: ControlStatements | ||
SpaceInEmptyParentheses: false | ||
SpacesBeforeTrailingComments: 0 | ||
SpacesInAngles: false | ||
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,30 @@ | ||
--- | ||
Checks: "*, | ||
-abseil-*, | ||
-altera-*, | ||
-android-*, | ||
-fuchsia-*, | ||
-google-*, | ||
-llvm*, | ||
-modernize-use-trailing-return-type, | ||
-zircon-*, | ||
-readability-else-after-return, | ||
-readability-static-accessed-through-instance, | ||
-readability-avoid-const-params-in-decls, | ||
-cppcoreguidelines-non-private-member-variables-in-classes, | ||
-misc-non-private-member-variables-in-classes, | ||
" | ||
WarningsAsErrors: '' | ||
HeaderFilterRegex: '' | ||
FormatStyle: none | ||
|
||
CheckOptions: | ||
- key: readability-identifier-length.IgnoredVariableNames | ||
value: 'x|y|z' | ||
- key: readability-identifier-length.IgnoredParameterNames | ||
value: 'x|y|z' | ||
|
||
|
||
|
||
|
||
|
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,21 @@ | ||
additional_commands: | ||
foo: | ||
flags: | ||
- BAR | ||
- BAZ | ||
kwargs: | ||
DEPENDS: '*' | ||
HEADERS: '*' | ||
SOURCES: '*' | ||
bullet_char: '*' | ||
dangle_parens: false | ||
enum_char: . | ||
line_ending: unix | ||
line_width: 120 | ||
max_pargs_hwrap: 3 | ||
separate_ctrl_name_with_space: false | ||
separate_fn_name_with_space: false | ||
tab_size: 2 | ||
|
||
markup: | ||
enable_markup: false |
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,34 @@ | ||
# Build directories and binary files | ||
build/ | ||
out/ | ||
cmake-build-*/ | ||
|
||
# User spesific settings | ||
CMakeUserPresets.json | ||
|
||
# IDE files | ||
.vs/ | ||
.idea/ | ||
.vscode/ | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/launch.json | ||
!.vscode/extensions.json | ||
*.swp | ||
*~ | ||
_ReSharper* | ||
*.log | ||
|
||
# OS Generated Files | ||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
._* | ||
.Spotlight-V100 | ||
.Trashes | ||
.Trash-* | ||
$RECYCLE.BIN/ | ||
.TemporaryItems | ||
ehthumbs.db | ||
Thumbs.db | ||
Dockerfile |
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,120 @@ | ||
# [Choice] bionic (18.04), focal (20.04) | ||
ARG VARIANT="focal" | ||
FROM ubuntu:${VARIANT} | ||
|
||
# Restate the variant to use it later on in the llvm and cmake installations | ||
ARG VARIANT | ||
|
||
# Install necessary packages available from standard repos | ||
RUN apt-get update -qq && export DEBIAN_FRONTEND=noninteractive && \ | ||
apt-get install -y --no-install-recommends \ | ||
software-properties-common wget apt-utils file zip \ | ||
openssh-client gpg-agent socat rsync \ | ||
make ninja-build git \ | ||
python3 python3-pip | ||
|
||
# Install conan | ||
RUN python3 -m pip install --upgrade pip setuptools && \ | ||
python3 -m pip install conan && \ | ||
conan --version | ||
|
||
# By default, anything you run in Docker is done as superuser. | ||
# Conan runs some install commands as superuser, and will prepend `sudo` to | ||
# these commands, unless `CONAN_SYSREQUIRES_SUDO=0` is in your env variables. | ||
ENV CONAN_SYSREQUIRES_SUDO 0 | ||
# Some packages request that Conan use the system package manager to install | ||
# a few dependencies. This flag allows Conan to proceed with these installations; | ||
# leaving this flag undefined can cause some installation failures. | ||
ENV CONAN_SYSREQUIRES_MODE enabled | ||
|
||
# User-settable versions: | ||
# This Dockerfile should support gcc-[7, 8, 9, 10, 11] and clang-[10, 11, 12, 13] | ||
# Earlier versions of clang will require significant modifications to the IWYU section | ||
ARG GCC_VER="11" | ||
# Add gcc-${GCC_VER} | ||
RUN add-apt-repository -y ppa:ubuntu-toolchain-r/test && \ | ||
apt-get update -qq && export DEBIAN_FRONTEND=noninteractive && \ | ||
apt-get install -y --no-install-recommends \ | ||
gcc-${GCC_VER} g++-${GCC_VER} gdb | ||
|
||
# Set gcc-${GCC_VER} as default gcc | ||
RUN update-alternatives --install /usr/bin/gcc gcc $(which gcc-${GCC_VER}) 100 | ||
RUN update-alternatives --install /usr/bin/g++ g++ $(which g++-${GCC_VER}) 100 | ||
|
||
ARG LLVM_VER="13" | ||
# Add clang-${LLVM_VER} | ||
ARG LLVM_URL="http://apt.llvm.org/${VARIANT}/" | ||
ARG LLVM_PKG="llvm-toolchain-${VARIANT}-${LLVM_VER}" | ||
RUN wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add - 2>/dev/null && \ | ||
add-apt-repository -y "deb ${LLVM_URL} ${LLVM_PKG} main" && \ | ||
apt-get update -qq && export DEBIAN_FRONTEND=noninteractive && \ | ||
apt-get install -y --no-install-recommends \ | ||
clang-${LLVM_VER} lldb-${LLVM_VER} lld-${LLVM_VER} clangd-${LLVM_VER} \ | ||
llvm-${LLVM_VER}-dev libclang-${LLVM_VER}-dev clang-tidy-${LLVM_VER} | ||
|
||
# Set the default clang-tidy, so CMake can find it | ||
RUN update-alternatives --install /usr/bin/clang-tidy clang-tidy $(which clang-tidy-${LLVM_VER}) 1 | ||
|
||
# Set clang-${LLVM_VER} as default clang | ||
RUN update-alternatives --install /usr/bin/clang clang $(which clang-${LLVM_VER}) 100 | ||
RUN update-alternatives --install /usr/bin/clang++ clang++ $(which clang++-${LLVM_VER}) 100 | ||
|
||
# Add current cmake/ccmake, from Kitware | ||
ARG CMAKE_URL="https://apt.kitware.com/ubuntu/" | ||
ARG CMAKE_PKG=${VARIANT} | ||
RUN wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null \ | ||
| gpg --dearmor - | tee /etc/apt/trusted.gpg.d/kitware.gpg >/dev/null && \ | ||
apt-add-repository -y "deb ${CMAKE_URL} ${CMAKE_PKG} main" && \ | ||
apt-get update -qq && export DEBIAN_FRONTEND=noninteractive && \ | ||
apt-get install -y --no-install-recommends cmake cmake-curses-gui | ||
|
||
# Install editors | ||
RUN apt-get update -qq && export DEBIAN_FRONTEND=noninteractive && \ | ||
apt-get install -y --no-install-recommends \ | ||
neovim emacs nano | ||
|
||
# Install optional dependecies | ||
RUN apt-get update -qq && export DEBIAN_FRONTEND=noninteractive && \ | ||
apt-get install -y --no-install-recommends \ | ||
doxygen graphviz ccache cppcheck | ||
|
||
# Install include-what-you-use | ||
ENV IWYU /home/iwyu | ||
ENV IWYU_BUILD ${IWYU}/build | ||
ENV IWYU_SRC ${IWYU}/include-what-you-use | ||
RUN mkdir -p ${IWYU_BUILD} && \ | ||
git clone --branch clang_${LLVM_VER} \ | ||
https://github.com/include-what-you-use/include-what-you-use.git \ | ||
${IWYU_SRC} | ||
RUN CC=clang-${LLVM_VER} CXX=clang++-${LLVM_VER} cmake -S ${IWYU_SRC} \ | ||
-B ${IWYU_BUILD} \ | ||
-G "Unix Makefiles" -DCMAKE_PREFIX_PATH=/usr/lib/llvm-${LLVM_VER} && \ | ||
cmake --build ${IWYU_BUILD} -j && \ | ||
cmake --install ${IWYU_BUILD} | ||
|
||
# Per https://github.com/include-what-you-use/include-what-you-use#how-to-install: | ||
# `You need to copy the Clang include directory to the expected location before | ||
# running (similarly, use include-what-you-use -print-resource-dir to learn | ||
# exactly where IWYU wants the headers).` | ||
RUN mkdir -p $(include-what-you-use -print-resource-dir 2>/dev/null) | ||
RUN ln -s $(readlink -f /usr/lib/clang/${LLVM_VER}/include) \ | ||
$(include-what-you-use -print-resource-dir 2>/dev/null)/include | ||
|
||
## Cleanup cached apt data we don't need anymore | ||
RUN apt-get autoremove -y && apt-get clean && \ | ||
rm -rf /var/lib/apt/lists/* | ||
|
||
# Allow the user to set compiler defaults | ||
ARG USE_CLANG | ||
# if --build-arg USE_CLANG=1, set CC to 'clang' or set to null otherwise. | ||
ENV CC=${USE_CLANG:+"clang"} | ||
ENV CXX=${USE_CLANG:+"clang++"} | ||
# if CC is null, set it to 'gcc' (or leave as is otherwise). | ||
ENV CC=${CC:-"gcc"} | ||
ENV CXX=${CXX:-"g++"} | ||
|
||
# Include project | ||
#ADD . /workspaces/cpp_starter_project | ||
#WORKDIR /workspaces/cpp_starter_project | ||
|
||
CMD ["/bin/bash"] |
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,52 @@ | ||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: | ||
// https://github.com/microsoft/vscode-dev-containers/tree/v0.205.2/containers/cpp | ||
{ | ||
"name": "C++", | ||
"build": { | ||
"dockerfile": "Dockerfile", | ||
// Update 'VARIANT' to pick an Ubuntu OS version. Options: [bionic, focal]. Default: focal | ||
// Update 'GCC_VER' to pick a gcc and g++ version. Options: [7, 8, 9, 10, 11]. Default: 11 | ||
// Update 'LLVM_VER' to pick clang version. Options: [10, 11, 12, 13]. Default: 13 | ||
// Update 'USE_CLANG' to set clang as the default C and C++ compiler. Options: [1, null]. Default null | ||
// "args": { | ||
// "VARIANT": "focal", | ||
// "GCC_VER": "11", | ||
// "LLVM_VER": "13" | ||
// } | ||
}, | ||
"runArgs": [ | ||
"--cap-add=SYS_PTRACE", | ||
"--security-opt", | ||
"seccomp=unconfined" | ||
], | ||
// Set *default* container specific settings.json values on container create. | ||
"settings": { | ||
"cmake.configureOnOpen": true, | ||
"editor.formatOnSave": true | ||
}, | ||
// Add the IDs of extensions you want installed when the container is created. | ||
"extensions": [ | ||
"ms-vscode.cpptools", | ||
"ms-vscode.cmake-tools", | ||
"twxs.cmake", | ||
"ms-vscode.cpptools-themes", | ||
"cschlosser.doxdocgen", | ||
"eamodio.gitlens", | ||
"ms-python.python", | ||
"ms-python.vscode-pylance", | ||
"mutantdino.resourcemonitor" | ||
], | ||
// Use 'forwardPorts' to make a list of ports inside the container available locally. | ||
// "forwardPorts": [], | ||
// Use 'postCreateCommand' to run commands after the container is created. | ||
//"postCreateCommand": "uname -a", | ||
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. | ||
//"remoteUser": "vscode", | ||
"workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/${localWorkspaceFolderBasename},type=bind,consistency=delegated", | ||
"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}", | ||
"features": { | ||
"git": "latest", | ||
"git-lfs": "latest", | ||
"powershell": "latest" | ||
} | ||
} |
Oops, something went wrong.