Merge pull request OpenEnroth#1356 from captainurist/macos_fixes_409

Moved Geometry to Library

HACKING.md

@@ -122,8 +122,8 @@ Code Organization
 OpenEnroth code is broken up as follows:
 * `thirdparty` – this is where all external libraries go.
 * `Utility` – generic utility classes and functions go here. Utility classes should be domain-independent (e.g. should make sense in a context of some other project) and should depend only on `thirdparty` libraries.
-* `Platform` – our platform abstraction layer on top of SDL. Platform classes should also be reasonably domain-independent and should depend only on `Utility`.
-* `Library` – collection of independent libraries that the engine is built on top of. Code here can depend on `Utility`, `Platform`, and other libraries in `Library`.
+* `Library` – collection of independent libraries that the engine is built on top of. Code here can depend on `Utility` and other libraries in `Library`. However, there should be no cyclical dependencies between libraries here.
+* `Library/Platform` is our platform abstraction layer on top of SDL.
 * The rest of the code is currently pretty tangled with each part depending on each other. This document will be updated once we have some progress there.
 
 Our basic guidelines for code organization are:

src/Application/GameWindowHandler.h

@@ -6,7 +6,7 @@
 #include "Library/Platform/Interface/PlatformEnums.h"
 #include "Library/Platform/Filters/PlatformEventFilter.h"
 #include "Library/Platform/Application/PlatformApplicationAware.h"
-#include "Utility/Geometry/Size.h"
+#include "Library/Geometry/Size.h"
 
 namespace Io {
 class Mouse;

src/Arcomage/Arcomage.h

@@ -4,8 +4,8 @@
 
 #include "Engine/Graphics/FrameLimiter.h"
 
-#include "Utility/Geometry/Point.h"
-#include "Utility/Geometry/Rect.h"
+#include "Library/Geometry/Point.h"
+#include "Library/Geometry/Rect.h"
 
 #include "Library/Platform/Interface/PlatformEnums.h"
 

src/Engine/AttackList.h

@@ -6,7 +6,7 @@
 #include "Engine/Objects/ActorEnums.h"
 #include "Engine/Pid.h"
 
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
 
 struct AttackDescription {
     Pid pid;

src/Engine/Graphics/BSPModel.h

@@ -4,8 +4,8 @@
 #include <vector>
 #include <string>
 
-#include "Utility/Geometry/Plane.h"
-#include "Utility/Geometry/BBox.h"
+#include "Library/Geometry/Plane.h"
+#include "Library/Geometry/BBox.h"
 
 #include "FaceEnums.h"
 

src/Engine/Graphics/BspRenderer.h

@@ -2,10 +2,10 @@
 
 #include <array>
 
-#include "Utility/Geometry/Plane.h"
-
 #include "Engine/Graphics/Camera.h"
 
+#include "Library/Geometry/Plane.h"
+
 struct BspRenderer_ViewportNode {
     int uSectorID = 0;  // sector that this node shows
     int uFaceID = 0;

src/Engine/Graphics/Camera.h

@@ -6,7 +6,7 @@
 
 #include "Engine/Graphics/RenderEntities.h"
 
-#include "Utility/Geometry/Plane.h"
+#include "Library/Geometry/Plane.h"
 
 struct Camera3D {
     void ViewTransform(int x, int y, int z, int *transformed_x, int *transformed_y, int *transformed_z);

src/Engine/Graphics/ClippingFunctions.h

@@ -1,9 +1,10 @@
 #pragma once
 
-#include "Utility/Geometry/Plane.h"
-
 #include "Engine/Graphics/RenderEntities.h"
 
+#include "Library/Geometry/Plane.h"
+#include "Library/Geometry/Vec.h"
+
 struct VertexBuffer {
     std::array<RenderVertexSoft, 64> pVertices = {{}};
     int uNumVertices;

src/Engine/Graphics/Collisions.h

@@ -2,8 +2,8 @@
 
 #include "Engine/Pid.h"
 
-#include "Utility/Geometry/Vec.h"
-#include "Utility/Geometry/BBox.h"
+#include "Library/Geometry/Vec.h"
+#include "Library/Geometry/BBox.h"
 
 struct BLVFace;
 class Actor;

src/Engine/Graphics/IRender.h

@@ -9,8 +9,7 @@
 #include "Library/Image/Image.h"
 #include "Library/Color/Color.h"
 #include "Library/Color/ColorTable.h"
-
-#include "Utility/Geometry/Rect.h"
+#include "Library/Geometry/Rect.h"
 
 #include "TextureRenderId.h"
 #include "RenderEntities.h"

src/Engine/Graphics/Image.h

@@ -3,12 +3,12 @@
 #include <string>
 #include <memory>
 
-#include "Utility/Geometry/Size.h"
-#include "Utility/Types.h"
-
+#include "Library/Geometry/Size.h"
 #include "Library/Image/Image.h"
 #include "Library/Image/Palette.h"
 
+#include "Utility/Types.h"
+
 #include "TextureRenderId.h"
 
 class ImageLoader;

src/Engine/Graphics/Level/Decoration.h

@@ -3,7 +3,8 @@
 #include <vector>
 #include <cstdint>
 
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
+
 #include "Utility/Flags.h"
 
 enum class LevelDecorationFlag : uint16_t {

src/Engine/Graphics/LightsStack.h

@@ -3,8 +3,7 @@
 #include <array>
 
 #include "Library/Color/Color.h"
-
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
 
 struct StationaryLight {
     Vec3f vPosition {};

src/Engine/Graphics/OpenGL/RenderOpenGL.cpp

@@ -46,8 +46,8 @@
 #include "Library/Image/ImageFunctions.h"
 #include "Library/Color/Colorf.h"
 #include "Library/Logger/Logger.h"
+#include "Library/Geometry/Size.h"
 
-#include "Utility/Geometry/Size.h"
 #include "Utility/Format.h"
 #include "Utility/Memory/MemSet.h"
 

src/Engine/Graphics/PortalFunctions.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include "Utility/Geometry/Vec.h"
-#include "Utility/Geometry/Plane.h"
+#include "Library/Geometry/Vec.h"
+#include "Library/Geometry/Plane.h"
 
 struct stru10 {
     stru10();

src/Engine/Graphics/RenderEntities.h

@@ -6,8 +6,7 @@
 #include "Engine/Pid.h"
 
 #include "Library/Color/Color.h"
-
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
 
 class Sprite;
 class SpriteFrame;

src/Engine/Graphics/Vis.h

@@ -1,12 +1,13 @@
 #pragma once
 
-#include "Utility/Flags.h"
-#include "Utility/Geometry/Plane.h"
-
 #include "Engine/Graphics/RenderEntities.h"
 #include "Engine/Objects/ActorEnums.h"
 #include "Engine/Pid.h"
 
+#include "Library/Geometry/Plane.h"
+
+#include "Utility/Flags.h"
+
 class BSPModel;
 struct ODMFace;
 struct BLVFace;

src/Engine/Graphics/Weather.h

@@ -2,7 +2,7 @@
 
 #include <array>
 
-#include "Utility/Geometry/Point.h"
+#include "Library/Geometry/Point.h"
 
 class Weather {
  public:

src/Engine/Objects/Actor.h

@@ -9,7 +9,8 @@
 #include "Engine/Objects/CombinedSkillValue.h"
 #include "Engine/Pid.h"
 
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
+
 #include "Utility/IndexedArray.h"
 
 #include "ActorEnums.h"

src/Engine/Objects/Character.h

@@ -21,8 +21,8 @@
 #include "GUI/GUIEnums.h"
 
 #include "Library/Color/Color.h"
+#include "Library/Geometry/Vec.h"
 
-#include "Utility/Geometry/Vec.h"
 #include "Utility/IndexedArray.h"
 #include "Utility/IndexedBitset.h"
 

src/Engine/Objects/Chest.h

@@ -7,7 +7,8 @@
 #include "Engine/Objects/Items.h"
 #include "Engine/Pid.h"
 
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
+
 #include "Utility/Memory/Blob.h"
 
 #include "ChestEnums.h"

src/Engine/Objects/SpriteObject.h

@@ -9,8 +9,7 @@
 #include "Engine/Pid.h"
 
 #include "Library/Color/Color.h"
-
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
 
 class SpriteFrame;
 

src/Engine/Snapshots/EntitySnapshots.h

@@ -2,9 +2,9 @@
 
 #include <array>
 
-#include "Utility/Geometry/Vec.h"
-#include "Utility/Geometry/Plane.h"
-#include "Utility/Geometry/BBox.h" // TODO(captainurist): Don't depend on BBox binary layout.
+#include "Library/Geometry/Vec.h"
+#include "Library/Geometry/Plane.h"
+#include "Library/Geometry/BBox.h" // TODO(captainurist): Don't depend on BBox binary layout.
 
 #include "Library/Binary/BinarySerialization.h"
 

src/Engine/SpawnPoint.h

@@ -4,7 +4,7 @@
 #include "Engine/Objects/ItemEnums.h"
 #include "Engine/Pid.h"
 
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
 
 struct SpawnPoint {
     Vec3i vPosition;

src/Engine/TeleportPoint.h

@@ -2,7 +2,7 @@
 
 #include <string>
 
-#include "Utility/Geometry/Vec.h"
+#include "Library/Geometry/Vec.h"
 
 /**
  * Describes target teleportation point of the party.

src/Engine/mm7_data.h

@@ -17,9 +17,9 @@
 #include "GUI/GUIDialogues.h"
 
 #include "Library/Color/Color.h"
+#include "Library/Geometry/Vec.h"
 
 #include "Utility/IndexedArray.h"
-#include "Utility/Geometry/Vec.h"
 
 class GUIButton;
 class Actor;

src/GUI/GUIFont.h

@@ -7,8 +7,7 @@
 
 #include "Library/Color/Color.h"
 #include "Library/Image/Palette.h"
-
-#include "Utility/Geometry/Point.h"
+#include "Library/Geometry/Point.h"
 
 struct GUICharMetric {
     int32_t uLeftSpacing;

src/GUI/GUIWindow.h

@@ -19,11 +19,10 @@
 #include "Io/KeyboardInputHandler.h"
 
 #include "Library/Platform/Interface/PlatformEnums.h"
-
 #include "Library/Color/ColorTable.h"
+#include "Library/Geometry/Size.h"
+#include "Library/Geometry/Point.h"
 
-#include "Utility/Geometry/Size.h"
-#include "Utility/Geometry/Point.h"
 #include "Utility/IndexedArray.h"
 
 namespace Io {

src/GUI/UI/Books/TownPortalBook.cpp

@@ -11,7 +11,6 @@
 #include "Engine/Spells/Spells.h"
 #include "Engine/MapInfo.h"
 
-#include "GUI/GUIFont.h"
 #include "GUI/UI/Books/TownPortalBook.h"
 #include "GUI/UI/UIStatusBar.h"
 #include "GUI/UI/UIGame.h"
@@ -20,7 +19,7 @@
 
 #include "Io/Mouse.h"
 
-#include "Utility/Geometry/Rect.h"
+#include "Library/Geometry/Rect.h"
 
 struct TownPortalData {
     Vec3i pos;

src/GUI/UI/NPCTopics.h

@@ -4,13 +4,14 @@
 #include <string>
 #include <vector>
 
-#include "Utility/Geometry/Vec.h"
 #include "Engine/Tables/AwardTable.h"
 #include "Engine/Tables/NPCTable.h"
 #include "Engine/Objects/CharacterEnums.h"
 #include "GUI/GUIDialogues.h"
 #include "GUI/UI/UIHouseEnums.h"
 
+#include "Library/Geometry/Vec.h"
+
 std::string npcDialogueOptionString(DIALOGUE_TYPE topic, NPCData *npcData);
 
 std::vector<DIALOGUE_TYPE> prepareScriptedNPCDialogueTopics(NPCData *npcData);

src/Io/Mouse.h

@@ -6,7 +6,7 @@
 #include "Engine/Objects/ItemEnums.h"
 #include "Engine/Pid.h"
 
-#include "Utility/Geometry/Point.h"
+#include "Library/Geometry/Point.h"
 
 class GraphicsImage;
 

src/Library/CMakeLists.txt

@@ -6,6 +6,7 @@ add_subdirectory(Cli)
 add_subdirectory(Color)
 add_subdirectory(Compression)
 add_subdirectory(Config)
+add_subdirectory(Geometry)
 add_subdirectory(Image)
 add_subdirectory(Json)
 add_subdirectory(Lod)

src/Library/Geometry/CMakeLists.txt

@@ -0,0 +1,16 @@
+cmake_minimum_required(VERSION 3.24 FATAL_ERROR)
+
+set(LIBRARY_GEOMETRY_SOURCES)
+
+set(LIBRARY_GEOMETRY_HEADERS
+        BBox.h
+        Margins.h
+        Plane.h
+        Point.h
+        Rect.h
+        Size.h
+        Vec.h)
+
+add_library(library_geometry INTERFACE ${LIBRARY_GEOMETRY_SOURCES} ${LIBRARY_GEOMETRY_HEADERS})
+target_link_libraries(library_geometry INTERFACE utility)
+target_check_style(library_geometry)

src/Library/Image/CMakeLists.txt

@@ -11,5 +11,5 @@ set(LIBRARY_IMAGE_HEADERS
         PCX.h)
 
 add_library(library_image STATIC ${LIBRARY_IMAGE_SOURCES} ${LIBRARY_IMAGE_HEADERS})
-target_link_libraries(library_image PUBLIC library_color utility)
+target_link_libraries(library_image PUBLIC library_color library_geometry utility)
 target_check_style(library_image)

src/Library/Image/Image.h

@@ -8,7 +8,8 @@
 #include <utility>
 
 #include "Library/Color/Color.h"
-#include "Utility/Geometry/Size.h"
+#include "Library/Geometry/Size.h"
+
 #include "Utility/Memory/FreeDeleter.h"
 #include "Utility/Types.h"
 

src/Library/Platform/Interface/CMakeLists.txt

@@ -16,4 +16,4 @@ set(LIBRARY_PLATFORM_INTERFACE_HEADERS
 
 add_library(library_platform_interface STATIC ${LIBRARY_PLATFORM_INTERFACE_SOURCES} ${LIBRARY_PLATFORM_INTERFACE_HEADERS})
 target_check_style(library_platform_interface)
-target_link_libraries(library_platform_interface PUBLIC utility library_logger)
+target_link_libraries(library_platform_interface PUBLIC utility library_logger library_geometry)