Merge remote-tracking branch 'upstream/main' into makeStub

Author: nonorze-VOXX

.clang-tidy

@@ -1,4 +1,4 @@
-Checks: '-*,
+WarningsAsErrors: '-*,
         bugprone-*,-bugprone-easily-swappable-parameters,
         readability-*,-readability-convert-member-functions-to-static,-readability-redundant-access-specifiers,-readability-magic-numbers,
         modernize-*,-modernize-use-trailing-return-type,-modernize-use-nodiscard'

.github/docs/Code-Styles-and-Guidelines.md

@@ -0,0 +1,132 @@
+# Code Styles and Guidelines
+
+## General
+
+* Use UTF-8 encoding
+* Windows should use CRLF line breaks, MacOS and Linux(Unix-like OSes) should use LF line breaks
+* Use `enum class` over `enum`
+    https://stackoverflow.com/questions/18335861/why-is-enum-class-preferred-over-plain-enum
+    https://www.geeksforgeeks.org/enum-classes-in-c-and-their-advantage-over-enum-datatype/
+* Line break at EOF
+    https://stackoverflow.com/questions/729692/why-should-text-files-end-with-a-newline
+    Force it in VSCode
+    https://stackoverflow.com/questions/44704968/visual-studio-code-insert-newline-at-the-end-of-files
+* Write portable code by following C++ standards and avoid using `#pragma` directives
+* Add line breaks wherever it makes sense
+* Use primary operators instead of alternative  ones([ref](https://en.cppreference.com/w/cpp/language/operator_alternative))
+
+## Includes
+
+Use `#ifndef` for include guards instead of `#pragma once`
+
+Include guard format: `<NAMESPACE>_<FILENAME>_<FILE_EXTENSION>` 
+
+E.g.: Include guard for `GameObject.hpp` should be `GAME_OBJECT_HPP` 
+
+Internal header should use `""` and external headers should use `<>`
+
+Unless specified, included headers should be the following order:
+
+1. definition header(if needed)
+2. system header
+3. external header
+4. internal header
+
+Different categories are separated with line breaks. If headers are in the same category, headers for the same libraries should be grouped together and be in alphabetical order
+
+E.g. includes for `Player.cpp` should be
+
+```cpp=
+#include "Player.hpp"
+
+#include <string>
+#include <vector>
+
+#include <spdlog/spdlog.h>
+
+#include "Math/Vector2.hpp"
+
+// ...
+```
+
+See also: https://clangd.llvm.org/guides/include-cleaner
+
+## Class
+
+Member functions and variables declaration should be in the following order, access specifiers should be in the order of `public` -> `protected` -> `private`. Static members should be declared above normal members.
+
+1. Functions
+    1. Constructor
+        1. Default
+        2. Parameterized
+        3. Copy
+        4. Move
+    2. Destructor
+    3. Operator overload
+        1. Copy assignment
+        2. Move assignment
+    4. Getter
+    5. Setter
+    6. Other
+2. Variables
+
+Follow C++ rule of three/five/zero
+    https://en.cppreference.com/w/cpp/language/rule_of_three
+
+## File Types
+
+C source file: `.c`
+C header file: `.h`
+C++ source file: `.cpp`
+C++ header file: `.hpp`
+
+Vertex Shader: `.vert`
+Fragment Shader: `.frag`
+
+## File and Folder Naming
+
+Source and header files should be `PascalCase` if it defines a class or struct, otherwise it should be `snake_case`
+
+Top level folders should only consist of a single word and be `lowercase` (e.g. `src/`, `include/`, `lib/`)
+
+Source and header file folders should be `PascalCase` and be the same name as its namespace
+
+E.g.: `include/Math/Vector2.hpp` should be:
+
+```cpp=
+#ifndef MATH_VECTOR2_HPP
+#define MATH_VECTOR2_HPP
+
+namespace Math {
+class Vector2 {
+public:
+    Vector2();
+
+}
+}
+
+#endif
+
+```
+
+## Variable Naming Convention
+
+Lower items override higher items if rules collide
+
+|                     | Case         | Prefix | Suffix |
+| ------------------- | ------------ | ------ | ------ |
+| Namespace           | `PascalCase` |        |        |
+| Class               | `PascalCase` |        |        |
+| Class member        | `PascalCase` | `m_`   |        |
+| Static class member | `PascalCase` | `s_`   |        |
+| Struct              | `PascalCase` |        |        |
+| Struct member       | `camelCase`  |        |        |
+| Enum                | `PascalCase` |        |        |
+| Enum element        | `UPPER_CASE` |        |        |
+| Function/Method     | `camelCase`  |        |        |
+| Parameter           | `camelCase`  |        |        |
+| Variable            | `camelCase`  |        |        |
+| Type Alias/Typedef  | `PascalCase` |        |        |
+| Global constant     | `UPPER_CASE` |        |        |
+| Macro               | `UPPER_CASE` |        |        |
+| Template parameter  | `UPPER_CASE` |        |        |

.github/workflows/build.yml

@@ -33,6 +33,12 @@ jobs:
         with:
           submodules: recursive
 
+      - name: Check Format
+        if: matrix.os == 'ubuntu-latest' && matrix.compiler == 'clang'
+        run: |
+          find src/ include/ test/ assets/shaders/ -name "*.*" -print0 | \
+            xargs -0 clang-format --dry-run --Werror --ferror-limit=15
+
       - name: Building Project
         if: matrix.os == 'ubuntu-latest'
         env:
@@ -42,6 +48,12 @@ jobs:
           cmake -B build -G "Ninja" -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
           cmake --build build
 
+      - name: Run Linter
+        if: matrix.os == 'ubuntu-latest' && matrix.compiler == 'clang'
+        run: |
+          find src/ include/ test/ -name "*.*" -print0 | \
+            xargs -0 run-clang-tidy true -p build
+
       - name: Building Project
         if: matrix.os == 'windows-latest'
         run: |

CMakeLists.txt

@@ -42,9 +42,9 @@ set(SRC_FILES
     ${SRC_DIR}/Util/Text.cpp
     ${SRC_DIR}/Util/TransformUtils.cpp
     ${SRC_DIR}/Util/GameObject.cpp
+    ${SRC_DIR}/Util/Root.cpp
 
     ${SRC_DIR}/App.cpp
-    ${SRC_DIR}/Triangle.cpp
     ${SRC_DIR}/Giraffe.cpp
 )
 set(INCLUDE_DIR ${CMAKE_SOURCE_DIR}/include)
@@ -72,10 +72,10 @@ set(INCLUDE_FILES
     ${INCLUDE_DIR}/Util/Text.hpp
     ${INCLUDE_DIR}/Util/Transform.hpp
     ${INCLUDE_DIR}/Util/TransformUtils.hpp
-    ${INCLUDE_DIR}Util/GameObject.hpp
+    ${INCLUDE_DIR}/Util/GameObject.hpp
+    ${INCLUDE_DIR}/Util/Root.hpp
 
     ${INCLUDE_DIR}/App.hpp
-    ${INCLUDE_DIR}/Triangle.hpp
     ${INCLUDE_DIR}/Giraffe.hpp
     ${INCLUDE_DIR}/config.hpp
 )

CONTRIBUTING.md

@@ -0,0 +1 @@
+- [Code Styles and Guidelines](./.github/docs/Code-Styles-and-Guidelines.md)

include/App.hpp

@@ -4,7 +4,6 @@
 #include "pch.hpp" // IWYU pragma: export
 
 #include "Giraffe.hpp"
-#include "Triangle.hpp"
 
 class App {
 public:
@@ -23,8 +22,7 @@ class App {
 private:
     State m_CurrentState = State::START;
 
-    Triangle m_Triangle;
-    std::shared_ptr<Giraffe> m_Giraffe= std::make_shared<Giraffe>();
+    std::shared_ptr<Giraffe> m_Giraffe = std::make_shared<Giraffe>();
 };
 
 #endif

include/Triangle.hpp

@@ -13,11 +13,13 @@ class GameObject {
     GameObject() = default;
 
     GameObject(std::unique_ptr<Core::Drawable> drawable, const float zIndex,
+               const bool visible = true,
                const std::vector<std::shared_ptr<GameObject>> &children =
                    std::vector<std::shared_ptr<GameObject>>())
         : m_Drawable(std::move(drawable)),
           m_Children(children),
-          m_ZIndex(zIndex) {}
+          m_ZIndex(zIndex),
+          m_Visible(visible) {}
 
     GameObject(const GameObject &other) = delete;
 
@@ -33,17 +35,19 @@ class GameObject {
         return m_Drawable->GetSize() * m_Transform.scale;
     };
 
-    std::vector<std::shared_ptr<GameObject>> &GetChildren() {
+    Transform GetTransform() const { return m_Transform; }
+    const std::vector<std::shared_ptr<GameObject>> &GetChildren() const {
         return m_Children;
     }
 
     void SetZIndex(float index) { m_ZIndex = index; }
-
     void SetDrawable(std::unique_ptr<Core::Drawable> drawable) {
         m_Drawable = std::move(drawable);
     }
 
-    void AppendChild(std::shared_ptr<GameObject> child) {
+    void SetVisible(bool visible) { m_Visible = visible; }
+
+    void AddChild(std::shared_ptr<GameObject> child) {
         m_Children.push_back(std::move(child));
     }
 
@@ -61,6 +65,7 @@ class GameObject {
     std::vector<std::shared_ptr<GameObject>> m_Children;
 
     float m_ZIndex;
+    bool m_Visible = true;
 };
 } // namespace Util
 #endif

include/Util/GameObject.hpp

@@ -0,0 +1,26 @@
+#ifndef UTIL_ROOT_HPP
+#define UTIL_ROOT_HPP
+
+#include <memory>
+#include <vector>
+
+#include "Util/GameObject.hpp"
+
+class App;
+
+namespace Util {
+class Root final {
+public:
+    Root(const std::vector<std::shared_ptr<GameObject>> &children = {});
+
+    void AddChild(std::shared_ptr<GameObject> child);
+    void AddChildren(const std::vector<std::shared_ptr<GameObject>> &children);
+
+    void Update();
+
+private:
+    std::vector<std::shared_ptr<GameObject>> m_Children;
+};
+} // namespace Util
+
+#endif

include/Util/Root.hpp

@@ -17,13 +17,12 @@ void App::Start() {
                                             "Giraffe");
     gf->SetZIndex(m_Giraffe->GetZIndex() - 1);
     gf->Start();
-    m_Giraffe->AppendChild(gf);
+    m_Giraffe->AddChild(gf);
 
     m_CurrentState = State::UPDATE;
 }
 
 void App::Update() {
-    auto cursorPos = Util::Input::GetCursorPosition();
     if (Util::Input::IsLButtonPressed()) {
         LOG_DEBUG("Left button pressed");
     }