updates

.clang-format

@@ -0,0 +1,124 @@
+# A complete list of style options can be found at:
+# https://clang.llvm.org/docs/ClangFormatStyleOptions.html
+#
+# Google C++ Style Guide
+# https://google.github.io/styleguide/cppguide.html
+
+# You can disable formatting of a piece of code like so:
+#
+# int formatted_code;
+# // clang-format off
+#     void    unformatted_code  ;
+# // clang-format on
+# void formatted_code_again;
+#
+
+Language: Cpp
+
+# Basic indentation and spacing rules:
+IndentWidth: 4
+ContinuationIndentWidth: 4
+UseCRLF: false
+Standard: c++20
+UseTab: Never
+MaxEmptyLinesToKeep: 1
+
+AccessModifierOffset: -4
+AlignAfterOpenBracket: AlwaysBreak
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: false
+AlignConsecutiveMacros: true
+AlignEscapedNewlinesLeft: true
+AlignOperands: true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortBlocksOnASingleLine: true
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AllowShortLambdasOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: false
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+
+# Configure each individual brace in BraceWrapping
+BraceWrapping:
+  AfterCaseLabel:        false
+  AfterClass:            true
+  AfterControlStatement: false
+  AfterEnum:             true
+  AfterFunction:         true
+  AfterNamespace:        true
+  AfterObjCDeclaration:  true
+  AfterStruct:           true
+  AfterUnion:            true
+  BeforeCatch:           false
+  BeforeElse:            false
+  IndentBraces:          false
+BreakBeforeBraces: Custom
+
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBinaryOperators: false
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializers: AfterColon
+BreakInheritanceList: AfterColon
+ColumnLimit: 120
+CompactNamespaces: true
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+ExperimentalAutoDetectBinPacking: true
+FixNamespaceComments: true
+IndentCaseLabels: false
+IndentGotoLabels: false
+IndentPPDirectives: BeforeHash
+IndentFunctionDeclarationAfterType: false
+NamespaceIndentation: All
+ObjCSpaceBeforeProtocolList: false
+PenaltyBreakBeforeFirstCallParameter: 10
+PenaltyBreakComment: 60
+PenaltyBreakFirstLessLess: 20
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+SpaceAfterControlStatementKeyword: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpacesInAngles: false
+SpaceInEmptyBlock: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInCStyleCastParentheses: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+
+# int* value instead of int *value
+DerivePointerAlignment: false
+PointerAlignment: Left
+PointerBindsToType: true
+SpaceAroundPointerQualifiers: After
+
+# Prefer "east const", placing `const` after the type: int const instead of const int
+QualifierAlignment: Right
+
+SortIncludes: true
+IncludeBlocks: Regroup
+IncludeCategories:
+  # Headers in <> from specific external libraries.
+  - Regex:      '^<(fmt|gtest|gmock|SDL|spdlog|allegro)(\/)?([A-Za-z0-9.\/-_])+>'
+    Priority:   3
+  - Regex:      '^<fifechan/widgets/.*\.hpp>$'
+    Priority:   4
+  - Regex:      '^<fifechan/.*\.hpp>$'
+    Priority:   5
+  - Regex:      '^<[a-z0-9_]*\.hpp>$'
+    Priority:   6
+  # C++ standard library. These includes are all lowercase.
+  - Regex:      '^<[a-z0-9_]*>$'
+    Priority:   7

.clang-tidy

@@ -0,0 +1,39 @@
+Checks: >
+  -*,
+  bugprone-*,
+  -bugprone-easily-swappable-parameters,
+  -bugprone-narrowing-conversions,
+  clang-diagnostic-*,
+  -clang-analyzer-*,
+  cert-err34-c,
+  cppcoreguidelines-*,
+  cppcoreguidelines-rvalue-reference-param-not-moved,
+  -cppcoreguidelines-owning-memory,
+  -cppcoreguidelines-avoid-non-const-global-variables,
+  -cppcoreguidelines-avoid-magic-numbers,
+  -cppcoreguidelines-narrowing-conversions,
+  -cppcoreguidelines-pro-bounds-constant-array-index,
+  -cppcoreguidelines-non-private-member-variables-in-classes,
+  -cppcoreguidelines-pro-type-union-access,
+  google-explicit-constructor,
+  misc*,
+  -misc-no-recursion,
+  -misc-include-cleaner,
+  -misc-non-private-member-variables-in-classes
+  modernize*,
+  modernize-use-nullptr,
+  -modernize-use-auto,
+  -modernize-use-trailing-return-type,
+  -modernize-use-nodiscard,
+  portability-*,
+  readability-*,
+  -readability-identifier-length,
+  -readability-magic-numbers,
+  -readability-function-cognitive-complexity,
+
+WarningsAsErrors: >
+  clang-analyzer-security.*
+#HeaderFilterRegex: '.*include/fifechan.*\.hpp'
+SystemHeaders: false
+# Use our .clang-format file when applying fixes.
+FormatStyle: file

.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+{
+  "name": "Fife DevBox",
+  "image": "ghcr.io/jakoch/cpp-devbox:bookworm-latest",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        // EditorConfig
+        "EditorConfig.EditorConfig",
+        // Git + Github
+        "GitHub.vscode-pull-request-github",
+        // C++
+        "ms-vscode.cpptools",
+        "ms-vscode.cpptools-extension-pack",
+        "ms-vscode.cpptools-themes",
+        // CMake
+        "ms-vscode.cmake-tools",
+        "twxs.cmake",
+        // Testing
+        "matepek.vscode-catch2-test-adapter",
+        "ms-vscode.test-adapter-converter",
+        "hbenl.vscode-test-explorer"
+      ]
+    }
+  }
+}

.devcontainer/workflows/build-windows.yml

@@ -0,0 +1,120 @@
+#
+# .github/workflows/build-windows.yml
+#
+# Copyright 2024 Jens A. Koch.
+# SPDX-License-Identifier: MIT
+# This file is part of fifeengine/fifechan.
+#
+
+name: "Build on Windows"
+
+on:
+ - push
+ - pull_request
+ # You can manually run this workflow.
+ - workflow_dispatch
+
+
+# improve CI concurrency by automatically cancelling outdated jobs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+# ---------------------------------------------------------------------------------------
+
+  build:
+
+# ---------------------------------------------------------------------------------------
+
+    name: ${{ matrix.config.job_name }}
+
+    runs-on: windows-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        shared_libs:
+          - OFF
+          - ON
+        build_type:
+          -"Release
+          #- Debug
+        config:
+        #- { job_name: "Windows VC16 x86", platform: "Win32", generator: "Visual Studio 16 2019" }
+        #- { job_name: "Windows VC16 x64", platform: "x64", generator: "Visual Studio 16 2019" }
+        #- { job_name: "Windows VC17 x86", platform: "Win32", generator: "Visual Studio 17 2022" }
+        #- { job_name: "Windows VC17 x64", platform: "x64", generator: "Visual Studio 17 2022" }
+        #- { job_name: "Windows MinGW x86", platform: "Win32", generator: "MinGW Makefiles" }
+        #- { job_name: "Windows MinGW x64", platform: "x64", generator: "MinGW Makefiles" }
+        #- { job_name: "Windows Ninja x86", platform: "Win32", generator: "Ninja" }
+        - { job_name: "Windows Ninja x64", platform: "x64", generator: "Ninja", triplet: "x64-windows" }
+
+    env:
+      VCPKG_DISABLE_METRICS: 1
+      BUILD_DIR:   ${{github.workspace}}/build
+      INSTALL_DIR: ${{github.workspace}}/install
+
+    defaults:
+      run:
+        shell: cmd
+
+    steps:
+      - name: 🤘 Checkout Code
+        uses: actions/checkout@v4 # https://github.com/actions/checkout
+
+      # https://community.chocolatey.org/packages/ninja
+      - name: 🔽 Install Ninja
+        run: choco install ninja --no-progress
+
+      # https://community.chocolatey.org/packages/cmake
+      - name: 🔽 Install CMake
+        run: choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System' --no-progress
+
+      # WARNING
+      # ENV VCPKG_ROOT is redefined by this action
+      # and set to "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\vcpkg"
+      # instead of "c:\vcpkg", which is important for the pre-installed VCPKG on GHA.
+      - name: 🛠️ Setup Visual Studio Developer Command Prompt
+        uses: ilammy/msvc-dev-cmd@v1 # https://github.com/ilammy/msvc-dev-cmd
+
+      # Redefine location to "c:\vcpkg"
+      - name: 🔽 Define VCPKG_ROOT
+        run: |
+          set VCPKG_ROOT=%VCPKG_INSTALLATION_ROOT%
+          echo VCPKG_ROOT=%VCPKG_ROOT% >> %GITHUB_ENV%
+
+      - name: 🔽 Update VCPKG to latest TAG
+        run: |
+          cd /d "%VCPKG_ROOT%"
+          git fetch --tags
+          for /f "delims=" %%i in ('git describe --tags --abbrev=0') do set LATEST_VCPKG_TAG=%%i
+          git checkout %LATEST_VCPKG_TAG%
+
+      - name: 🔽 Bootstrap + Integrate VCPKG
+        run: |
+          bootstrap-vcpkg.bat
+          vcpkg integrate
+
+      - name: 📁 Create build directory
+        run: |
+          mkdir ${{ env.BUILD_DIR }}
+
+      - name: ✏ CMake ➔ Configure
+        working-directory: ${{env.BUILD_DIR}}
+        run: |
+          cmake                                                   ^
+           -B  ${{ env.BUILD_DIR }}                               ^
+           -G "${{ matrix.config.generator }}"                    ^
+           -A "${{ matrix.config.platform }}"                     ^
+           -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }}     ^
+           -DBUILD_SHARED_LIBS=${{ matrix.shared_libs }}          ^
+           -DCMAKE_INSTALL_PREFIX=${{ env.INSTALL_DIR }}          ^
+           -DVCPKG_TARGET_TRIPLET="${{ matrix.config.triplet }}"  ^
+           -DCMAKE_TOOLCHAIN_FILE=${{ env.VCPKG_ROOT }}/scripts/buildsystems/vcpkg.cmake
+
+      - name: 🛠️ Build
+        working-directory: ${{env.BUILD_DIR}}
+        run: |
+          cmake --build . --config ${{ matrix.config.build_type }}

.editorconfig

@@ -0,0 +1,40 @@
+# This file configures editors using the EditorConfig scheme.
+# https://editorconfig.org/
+
+# Guideline support for "Visual Studio 2022" IDE using extension: "PaulHarrington.EditorGuidelinesPreview"
+# https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelinesPreview
+
+# Editorconfig support for "VSCode" using extension: "editorconfig.editorconfig"
+# https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+
+# "visual studio" specific
+spelling_languages = en-us
+guidelines = 80 dashed, 130
+
+[CMakeLists.txt, *.{cmake}]
+indent_size = 2
+
+[*.{c,cc,cpp,h,hpp,hxx,inl}]
+indent_size = 4
+trim_trailing_whitespace = true
+# "visual studio" specific
+vc_generate_documentation_comments = doxygen_slash_star
+
+[*.{json,yaml,yml}]
+indent_size = 2
+insert_final_newline = false
+
+[*.{md,markdown}]
+indent_size = 4
+trim_trailing_whitespace = false
+
+[*.{clang-format}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,5 @@
+* eol=lf
+*.png binary
+*.xcf binary
+*.bmp binary
+*.exe binary

.github/dependabot.yml

@@ -0,0 +1,18 @@
+# dependabot.yml
+#
+# Dependabot updates dependencies automatically to their latest versions.
+#
+# Docs: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+
+updates:
+  # Enable automatic version updates for Github Actions
+  - package-ecosystem: "github-actions"
+    # Look for `.github/workflows` in the `root` directory
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    ignore:
+      # ignore all updates for "https://github.com/actions/github-script"
+      - dependency-name: "github-script"