Merge remote-tracking branch 'origin/dev' into ZAP-73-2-merge

.github/labeler.yml

@@ -0,0 +1,21 @@
+documentation:
+- README.md
+
+enhancement:
+- src/AI/**/*.py
+- src/GUI/**/*.hpp
+- src/GUI/**/*.cpp
+- src/SERVER/**/*.c
+- src/SERVER/**/*.h
+
+cicd:
+- .github/workflows/*.yml
+
+SERVER:
+- src/SERVER/*
+
+AI:
+- src/AI/*
+
+GUI:
+- src/GUI/*

.github/workflows/codeql.yml

@@ -0,0 +1,80 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "dev", main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "dev" ]
+  schedule:
+    - cron: '37 3 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: 'ubuntu-latest'
+    timeout-minutes: 360
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'cpp', 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Build
+      run: |
+        sudo apt install make cmake libsfml-dev python3 pip
+        make
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"
+

.github/workflows/cpp-lint.yml

@@ -0,0 +1,38 @@
+name: C++ Lint
+
+on:
+  push:
+    paths:
+      - 'src/GUI/**.cpp'
+      - 'src/GUI/**.hpp'
+
+jobs:
+  clang-format:
+    runs-on: ubuntu-latest
+    env:
+      workdir: ./src/GUI
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install Deps
+      run: |
+        sudo apt install -y clang-format
+
+    - name: Lint
+      run: |
+        FILES=$(find src -name '*.cpp' -o -name '*.hpp')
+        clang-format --dry-run --Werror -style=file -i $FILES | tee lint-report.log
+      working-directory: ${{ env.workdir }}
+
+    - name: Upload Lint Report
+      uses: actions/upload-artifact@v3
+      with:
+        name: lint-report.log
+        path: src/GUI/lint-report.log
+
+    - name: Is error ?
+      run: |
+        if [ ! -f 'lint-report.log' ]; then exit 0; fi
+        if [ -s 'lint-report.log' ]; then cat 'lint-report.log' && exit 1; fi
+      working-directory: ${{ env.workdir }}

.github/workflows/label.yml

@@ -0,0 +1,18 @@
+# https://github.com/actions/labeler
+
+name: Labeler
+on: [pull_request_target]
+
+jobs:
+  label:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+    - uses: actions/labeler@v4
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+        dot: true

.gitignore

@@ -1004,5 +1004,6 @@ zappy_gui
 zappy_server
 vgcore.*
 *.clang-format
+!src/GUI/.clang-format
 *.vscode/
 *.idea

Makefile

@@ -42,7 +42,9 @@ $(TARGET_server)_clean:
 	$(MAKE) -C $(TARGET_server_DIR) clean
 
 $(TARGET_gui)_clean:
-	if [ -d $(TARGET_gui_DIR)/build ]; then $(RM) -r $(TARGET_gui_DIR)/build; fi
+	if [ -d $(TARGET_gui_DIR)/build ]; then \
+		$(RM) -r $(TARGET_gui_DIR)/build; \
+	fi
 
 $(TARGET_ai)_clean:
 	$(MAKE) -C $(TARGET_ai_DIR) clean

README.md

@@ -82,7 +82,7 @@ dnf install SFML-devel SFML
 # Arch-based
 pacman -S python python-pip
 # Debian-based
-apt install python pip
+apt install python3 pip
 # Fedora
 dnf install python pip
 # Windows: available on microsoft store

src/AI/Makefile

@@ -27,6 +27,7 @@ LOCAL_DEPS	=		local_deps
 CP			?=		cp
 RM			?=		rm -f
 TOEXEC		?=		chmod +x
+CURDIR		=		$(shell pwd)
 
 all: $(TARGET)
 
@@ -38,14 +39,18 @@ $(LOCAL_DEPS)/simple: $(LOCAL_DEPS)/requirements.txt
 	$(MAKE) $(LOCAL_DEPS)/simple-force
 
 $(LOCAL_DEPS)/simple-force: $(LOCAL_DEPS)/requirements.txt
-	pip install --break-system-packages --user piprepo
+	pip install --break-system-packages --user piprepo || \
+		pip install --user piprepo
 	pip download -d ./local_deps -r ./$(LOCAL_DEPS)/requirements.txt
 	piprepo build ./local_deps
 
 $(TARGET):
-	([ ! -d $(LOCAL_DEPS)/simple ] && $(MAKE) $(LOCAL_DEPS)/simple-force) || \
-		true
-	pip install --break-system-packages --user -i ./local_deps/simple .
+	if [ ! -d $(LOCAL_DEPS)/simple ]; then \
+		$(MAKE) $(LOCAL_DEPS)/simple-force; \
+	fi
+	pip install --break-system-packages --user \
+		-i file:$(CURDIR)/local_deps/simple . || \
+		pip install --user -i ./local_deps/simple .
 	$(CP) "$(TARGET).py" "$(TARGET)"
 	$(TOEXEC) "$(TARGET)"
 
@@ -54,7 +59,8 @@ clean:
 	$(RM) -r $(PIP_TARGET).egg-info
 
 fclean: clean
-	pip uninstall --break-system-packages -y $(PIP_TARGET)
+	pip uninstall --break-system-packages -y $(PIP_TARGET) || \
+		pip uninstall -y $(PIP_TARGET)
 	$(RM) $(LOCAL_DEPS)/requirements.txt
 	$(RM) $(TARGET)
 

src/GUI/.clang-format

@@ -0,0 +1,90 @@
+Language: Cpp
+ColumnLimit: '80'
+ReflowComments: true
+AlignAfterOpenBracket: DontAlign
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+IndentWrappedFunctionNames: 'false'
+AccessModifierOffset: 0
+IndentAccessModifiers: true
+BinPackArguments: true
+BinPackParameters: true
+AlignOperands: false
+BreakBeforeBraces: Custom
+
+BraceWrapping:
+    AfterCaseLabel: false
+    AfterControlStatement: false
+    AfterEnum: false
+    AfterFunction: true
+    AfterNamespace: false
+    AfterStruct: false
+    AfterUnion: false
+    AfterExternBlock: true
+    BeforeCatch: false
+    BeforeElse: false
+    IndentBraces: false
+    SplitEmptyFunction: true
+    SplitEmptyRecord: true
+    SplitEmptyNamespace: true
+
+AlwaysBreakAfterReturnType: None
+
+TabWidth: '4'
+UseTab: Never
+IndentPPDirectives: BeforeHash
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+Cpp11BracedListStyle: true
+PointerAlignment: Right
+SpacesInCStyleCastParentheses: false
+SpaceAfterCStyleCast: true
+SpaceAfterLogicalNot: 'false'
+SpaceBeforeAssignmentOperators: 'true'
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: 'false'
+SpacesInAngles: false
+SpacesInParentheses: 'false'
+SpacesInSquareBrackets: 'false'
+SpacesInContainerLiterals: 'false'
+SpaceAfterTemplateKeyword: 'true'
+IndentCaseLabels: 'true'
+NamespaceIndentation: All
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: None
+AllowShortLoopsOnASingleLine: 'false'
+AllowShortBlocksOnASingleLine: 'true'
+AllowShortCaseLabelsOnASingleLine: 'true'
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 1
+AlignConsecutiveMacros: true
+AlignEscapedNewlines: Left
+AlignTrailingComments: true
+BreakStringLiterals: true
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeTernaryOperators: true
+SortIncludes: true
+IncludeBlocks: Preserve
+IncludeCategories:
+IncludeCategories:
+  - Regex:           '^"[[:alnum:]./]+"'       # Any "my_header.h"
+    Priority:        3
+  - Regex:           '<criterion/[a-z]+\.h>'  # Criterion headers
+    Priority:        2
+  - Regex:           '<[[:alnum:]./]+>'        # System/Standard libs
+    Priority:        1
+
+# Sort 'using' declarations
+SortUsingDeclarations: true
+
+BasedOnStyle: LLVM
+AlwaysBreakBeforeMultilineStrings: 'true'
+ContinuationIndentWidth: '0'
+IndentWidth: '4'
+PenaltyBreakAssignment: '0'
+SpaceBeforeCpp11BracedList: 'true'
+SpaceBeforeRangeBasedForLoopColon: 'true'
+
+# To totally disable format
+DisableFormat: 'false'

src/GUI/Dependencies/build-SFML.cmake

@@ -1,6 +1,6 @@
 if (WIN32)
     include(FetchContent)
-    set(SFML_BUILD_AUDIO OFF)
+    set(SFML_BUILD_AUDIO ON)
     set(SFML_BUILD_NETWORK OFF)
     set(SFML_BUILD_DOC OFF)
     set(SFML_BUILD_EXAMPLES OFF)
@@ -15,10 +15,11 @@ if (WIN32)
         sfml-graphics
         sfml-window
         sfml-system
+        sfml-audio
     )
 else()
     find_library(SFML sfml-graphics sfml-window sfml-system)
     target_link_libraries(${PROJECT_NAME} PRIVATE
-        sfml-graphics sfml-window sfml-system
+        sfml-graphics sfml-window sfml-system sfml-audio
     )
 endif()

src/GUI/format.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+set -x
+
+FILES=$(find src -name '*.cpp' -o -name '*.hpp')
+
+clang-format -i -style=file $FILES