Updated entity files to use semicolons for property separation

jonjondev · jonjondev · commit 463a0fe2fd75 · 2024-11-30T18:05:19.000+10:00
diff --git a/engine/core/scene/SceneFile.h b/engine/core/scene/SceneFile.h
@@ -29,7 +29,7 @@
 namespace Siege
 {
 // Define constants
-static constexpr const char LINE_SEP = '\n';
+static constexpr const char LINE_SEP = ';';
 static constexpr const char NAME_SEP = ':';
 static constexpr const char* SCENE_FILE_EXT = ".scene";
 static constexpr const char* ENTITY_FILE_EXT = ".entity";
diff --git a/examples/game/assets/scenes/collide.scene/Geometry.2.entity b/examples/game/assets/scenes/collide.scene/Geometry.2.entity
@@ -1,7 +1,7 @@
-Geometry
-POSITION:-0.00,0.00,-6.00
-ROTATION:0.000000
-Z-INDEX:0
-DIMENSIONS:5.00,0.10,5.00
-MODEL_PATH:assets/models/cube/cube.obj
-TEXTURE_PATH:models/cube/cube_1.png
+Geometry;
+POSITION:-0.00,0.00,-6.00;
+ROTATION:0.000000;
+Z-INDEX:0;
+DIMENSIONS:5.00,0.10,5.00;
+MODEL_PATH:assets/models/cube/cube.obj;
+TEXTURE_PATH:models/cube/cube_1.png;
diff --git a/examples/game/assets/scenes/collide.scene/Geometry.3.entity b/examples/game/assets/scenes/collide.scene/Geometry.3.entity
@@ -1,7 +1,7 @@
-Geometry
-POSITION:-6.00,-1.00,-6.00
-ROTATION:0.000000
-Z-INDEX:0
-DIMENSIONS:1.00,1.00,5.00
-MODEL_PATH:assets/models/cube/cube.obj
-TEXTURE_PATH:models/cube/cube_1.png
+Geometry;
+POSITION:-6.00,-1.00,-6.00;
+ROTATION:0.000000;
+Z-INDEX:0;
+DIMENSIONS:1.00,1.00,5.00;
+MODEL_PATH:assets/models/cube/cube.obj;
+TEXTURE_PATH:models/cube/cube_1.png;
diff --git a/examples/game/assets/scenes/collide.scene/Player.1.entity b/examples/game/assets/scenes/collide.scene/Player.1.entity
@@ -1,4 +1,4 @@
-Player
-POSITION:0.00,-3.00,-5.00
-ROTATION:0.000000
-Z-INDEX:0
+Player;
+POSITION:0.00,-3.00,-5.00;
+ROTATION:0.000000;
+Z-INDEX:0;
diff --git a/examples/game/assets/scenes/main.scene/Geometry.2.entity b/examples/game/assets/scenes/main.scene/Geometry.2.entity
@@ -1,7 +1,7 @@
-Geometry
-POSITION:-4.50,0.00,-1.50
-ROTATION:0.000000
-Z-INDEX:0
-DIMENSIONS:2.00,0.10,2.00
-MODEL_PATH:assets/models/cube/cube.obj
-TEXTURE_PATH:models/cube/cube_2.png
+Geometry;
+POSITION:-4.50,0.00,-1.50;
+ROTATION:0.000000;
+Z-INDEX:0;
+DIMENSIONS:2.00,0.10,2.00;
+MODEL_PATH:assets/models/cube/cube.obj;
+TEXTURE_PATH:models/cube/cube_2.png;
diff --git a/examples/game/assets/scenes/main.scene/Geometry.3.entity b/examples/game/assets/scenes/main.scene/Geometry.3.entity
@@ -1,7 +1,7 @@
-Geometry
-POSITION:-6.50,0.00,3.50
-ROTATION:0.000000
-Z-INDEX:0
-DIMENSIONS:2.00,0.10,2.00
-MODEL_PATH:assets/models/cube/cube.obj
-TEXTURE_PATH:models/cube/cube_2.png
+Geometry;
+POSITION:-6.50,0.00,3.50;
+ROTATION:0.000000;
+Z-INDEX:0;
+DIMENSIONS:2.00,0.10,2.00;
+MODEL_PATH:assets/models/cube/cube.obj;
+TEXTURE_PATH:models/cube/cube_2.png;
diff --git a/examples/game/assets/scenes/main.scene/Geometry.4.entity b/examples/game/assets/scenes/main.scene/Geometry.4.entity
@@ -1,7 +1,7 @@
-Geometry
-POSITION:2.50,0.00,1.50
-ROTATION:0.000000
-Z-INDEX:0
-DIMENSIONS:2.00,0.10,2.00
-MODEL_PATH:assets/models/cube/cube.obj
-TEXTURE_PATH:models/cube/cube_2.png
+Geometry;
+POSITION:2.50,0.00,1.50;
+ROTATION:0.000000;
+Z-INDEX:0;
+DIMENSIONS:2.00,0.10,2.00;
+MODEL_PATH:assets/models/cube/cube.obj;
+TEXTURE_PATH:models/cube/cube_2.png;
diff --git a/examples/game/assets/scenes/main.scene/Geometry.5.entity b/examples/game/assets/scenes/main.scene/Geometry.5.entity
@@ -1,7 +1,7 @@
-Geometry
-POSITION:0.50,0.00,-3.50
-ROTATION:0.000000
-Z-INDEX:0
-DIMENSIONS:2.00,0.10,2.00
-MODEL_PATH:assets/models/cube/cube.obj
-TEXTURE_PATH:models/cube/cube_2.png
+Geometry;
+POSITION:0.50,0.00,-3.50;
+ROTATION:0.000000;
+Z-INDEX:0;
+DIMENSIONS:2.00,0.10,2.00;
+MODEL_PATH:assets/models/cube/cube.obj;
+TEXTURE_PATH:models/cube/cube_2.png;
diff --git a/examples/game/assets/scenes/main.scene/Geometry.6.entity b/examples/game/assets/scenes/main.scene/Geometry.6.entity
@@ -1,7 +1,7 @@
-Geometry
-POSITION:7.50,0.00,-0.50
-ROTATION:0.000000
-Z-INDEX:0
-DIMENSIONS:2.00,0.10,2.00
-MODEL_PATH:assets/models/cube/cube.obj
-TEXTURE_PATH:models/cube/cube_2.png
+Geometry;
+POSITION:7.50,0.00,-0.50;
+ROTATION:0.000000;
+Z-INDEX:0;
+DIMENSIONS:2.00,0.10,2.00;
+MODEL_PATH:assets/models/cube/cube.obj;
+TEXTURE_PATH:models/cube/cube_2.png;
diff --git a/examples/game/assets/scenes/main.scene/Player.1.entity b/examples/game/assets/scenes/main.scene/Player.1.entity
@@ -1,4 +1,4 @@
-Player
-POSITION:0.00,-4.00,0.76
-ROTATION:0.000000
-Z-INDEX:0
+Player;
+POSITION:0.00,-4.00,0.76;
+ROTATION:0.000000;
+Z-INDEX:0;
diff --git a/packer/SceneDataPacker.cpp b/packer/SceneDataPacker.cpp
@@ -12,6 +12,7 @@
 #include <utils/FileSystem.h>
 #include <utils/Logging.h>
 
+#include <algorithm>
 #include <fstream>
 
 void* PackSceneFile(const Siege::String& filePath)
@@ -30,6 +31,11 @@ void* PackSceneFile(const Siege::String& filePath)
         return nullptr;
     }
 
+    std::string str(bodyString);
+    str.erase(std::remove(str.begin(), str.end(), '\n'), str.cend());
+    str.erase(std::remove(str.begin(), str.end(), '\r'), str.cend());
+    bodyString = str.c_str();
+
     uint32_t fileSize = bodyString.Size() + 1;
     char data[fileSize];
     memcpy(data, bodyString.Str(), fileSize);
diff --git a/tests/core/test_SceneFile.cpp b/tests/core/test_SceneFile.cpp
@@ -104,11 +104,11 @@ UTEST_F(test_SceneFile, SerialiseEntityToString)
     TestEntity1 e1;
     String sceneData;
     ASSERT_TRUE(SceneFile::SerialiseToString(&e1, sceneData));
-    ASSERT_STREQ("TestEntity1\n"
-                 "POSITION:0.00,0.00,0.00\n"
-                 "ROTATION:0.000000\n"
-                 "Z-INDEX:0\n"
-                 "CUSTOM_DATA:this is some custom data\n",
+    ASSERT_STREQ("TestEntity1;"
+                 "POSITION:0.00,0.00,0.00;"
+                 "ROTATION:0.000000;"
+                 "Z-INDEX:0;"
+                 "CUSTOM_DATA:this is some custom data;",
                  sceneData.Str());
 
     // Modifying its fields should result in the same transforms being applied
@@ -117,11 +117,11 @@ UTEST_F(test_SceneFile, SerialiseEntityToString)
     e1.SetRotation({0.f, 25.f, 0.f});
     e1.SetZIndex(-3);
     ASSERT_TRUE(SceneFile::SerialiseToString(&e1, sceneData));
-    ASSERT_STREQ("TestEntity1\n"
-                 "POSITION:1.00,2.00,3.00\n"
-                 "ROTATION:25.000000\n"
-                 "Z-INDEX:-3\n"
-                 "CUSTOM_DATA:this is some custom data\n",
+    ASSERT_STREQ("TestEntity1;"
+                 "POSITION:1.00,2.00,3.00;"
+                 "ROTATION:25.000000;"
+                 "Z-INDEX:-3;"
+                 "CUSTOM_DATA:this is some custom data;",
                  sceneData.Str());
 }
 
@@ -131,10 +131,10 @@ UTEST_F(test_SceneFile, SerialiseEntityToStringWithoutSerialiser)
     TestEntity3 e3;
     String sceneData;
     ASSERT_TRUE(SceneFile::SerialiseToString(&e3, sceneData));
-    ASSERT_STREQ("TestEntity3\n"
-                 "POSITION:0.00,0.00,0.00\n"
-                 "ROTATION:0.000000\n"
-                 "Z-INDEX:0\n",
+    ASSERT_STREQ("TestEntity3;"
+                 "POSITION:0.00,0.00,0.00;"
+                 "ROTATION:0.000000;"
+                 "Z-INDEX:0;",
                  sceneData.Str());
 }
 
@@ -158,21 +158,21 @@ UTEST_F(test_SceneFile, DeserialiseEntityFromStringNoData)
 UTEST_F(test_SceneFile, DeserialiseEntityFromStringGarbageData)
 {
     // When deserialising a scene with bad data it should not instantiate any entities
-    String fileData = "TesPOSITIOTA\n"
-                      "this is some custom data\n"
-                      "T some custom data\n";
+    String fileData = "TesPOSITIOTA;"
+                      "this is some custom data;"
+                      "T some custom data;";
     Entity* e1 = SceneFile::DeserialiseFromString(fileData);
     ASSERT_FALSE(e1);
 }
 
 UTEST_F(test_SceneFile, DeserialiseEntityFromString)
 {
     // When deserialising a scene with a single entity it should deserialise correctly
-    String fileData = "TestEntity1\n"
-                      "POSITION:1.00,2.00,3.00\n"
-                      "ROTATION:25.000000\n"
-                      "Z-INDEX:-3\n"
-                      "CUSTOM_DATA:this is some custom data\n";
+    String fileData = "TestEntity1;"
+                      "POSITION:1.00,2.00,3.00;"
+                      "ROTATION:25.000000;"
+                      "Z-INDEX:-3;"
+                      "CUSTOM_DATA:this is some custom data;";
     Entity* e1 = SceneFile::DeserialiseFromString(fileData);
     ASSERT_TRUE(e1);
     ASSERT_TRUE(dynamic_cast<TestEntity1*>(e1));
@@ -191,11 +191,11 @@ UTEST_F(test_SceneFile, DeserialiseEntityFromString)
     delete e1;
 
     // It should retain its custom data
-    fileData = "TestEntity2\n"
-               "POSITION:0.00,0.00,0.00\n"
-               "ROTATION:0.000000\n"
-               "Z-INDEX:0\n"
-               "CUSTOM_DATA:this is some other custom data\n";
+    fileData = "TestEntity2;"
+               "POSITION:0.00,0.00,0.00;"
+               "ROTATION:0.000000;"
+               "Z-INDEX:0;"
+               "CUSTOM_DATA:this is some other custom data;";
     Entity* e2 = SceneFile::DeserialiseFromString(fileData);
     ASSERT_TRUE(e2);
     auto* e2Cast = dynamic_cast<TestEntity2*>(e2);
@@ -208,23 +208,23 @@ UTEST_F(test_SceneFile, DeserialiseEntityFromString)
 UTEST_F(test_SceneFile, DeserialiseEntityFromStringWithoutDeserialiser)
 {
     // When deserialising entities that do not define a deserialiser, it should do nothing
-    String fileData = "TestEntity3\n"
-                      "POSITION:0.00,0.00,0.00\n"
-                      "ROTATION:0.000000\n"
-                      "Z-INDEX:0\n"
-                      "CUSTOM_DATA:this is some other custom data\n";
+    String fileData = "TestEntity3;"
+                      "POSITION:0.00,0.00,0.00;"
+                      "ROTATION:0.000000;"
+                      "Z-INDEX:0;"
+                      "CUSTOM_DATA:this is some other custom data;";
     Entity* e1 = SceneFile::DeserialiseFromString(fileData);
     ASSERT_FALSE(e1);
 }
 
 UTEST_F(test_SceneFile, DeserialiseEntityFromStringWithoutInterface)
 {
     // Entities that do not define a serialisation interface should not deserialise
-    String fileData = "Entity\n"
-                      "POSITION:0.00,0.00,0.00\n"
-                      "ROTATION:0.000000\n"
-                      "Z-INDEX:0\n"
-                      "CUSTOM_DATA:this is some other custom data\n";
+    String fileData = "Entity;"
+                      "POSITION:0.00,0.00,0.00;"
+                      "ROTATION:0.000000;"
+                      "Z-INDEX:0;"
+                      "CUSTOM_DATA:this is some other custom data;";
     Entity* e1 = SceneFile::DeserialiseFromString(fileData);
     ASSERT_FALSE(e1);
 }
diff --git a/tests/data/scene1.scene/TestEntity.1.entity b/tests/data/scene1.scene/TestEntity.1.entity
@@ -1,4 +1,5 @@
-TestEntity
-POSITION:0.000000,0.000000,0.000000
-ROTATION:0.000000
-Z-INDEX:0
+TestEntity;
+POSITION:0.000000,0.000000,0.000000;
+ROTATION:0.000000;
+Z-INDEX:0;
+
diff --git a/tests/data/scene1.scene/TestEntity.2.entity b/tests/data/scene1.scene/TestEntity.2.entity
@@ -1,4 +1,4 @@
-TestEntity
-POSITION:0.000000,0.000000,0.000000
-ROTATION:0.000000
-Z-INDEX:0
+TestEntity;
+POSITION:0.000000,0.000000,0.000000;
+ROTATION:0.000000;
+Z-INDEX:0;
diff --git a/tests/data/scene1.scene/TestEntity.3.entity b/tests/data/scene1.scene/TestEntity.3.entity
@@ -1,4 +1,4 @@
-TestEntity
-POSITION:0.000000,0.000000,0.000000
-ROTATION:0.000000
-Z-INDEX:0
+TestEntity;
+POSITION:0.000000,0.000000,0.000000;
+ROTATION:0.000000;
+Z-INDEX:0;
diff --git a/tests/data/scene2.scene/TestEntity.1.entity b/tests/data/scene2.scene/TestEntity.1.entity
@@ -1,4 +1,4 @@
-TestEntity
-POSITION:0.000000,0.000000,0.000000
-ROTATION:0.000000
-Z-INDEX:0
+TestEntity;
+POSITION:0.000000,0.000000,0.000000;
+ROTATION:0.000000;
+Z-INDEX:0;
diff --git a/tests/resources/test_ResourceSystem.cpp b/tests/resources/test_ResourceSystem.cpp
@@ -55,8 +55,8 @@ UTEST_F(test_ResourceSystem, ReadAllPackedEntries)
 
     const PackFile::Header& header = packFile->GetHeader();
     ASSERT_STREQ("pck", header.magic.string);
-    ASSERT_EQ(259385, header.bodySize);
-    ASSERT_EQ(259228, header.tocOffset);
+    ASSERT_EQ(259384, header.bodySize);
+    ASSERT_EQ(259227, header.tocOffset);
 
     std::vector<String> packedFilepaths {"data/scene2.scene",
                                          "data/scene1.scene",
@@ -175,17 +175,21 @@ UTEST_F(test_ResourceSystem, LoadSceneData)
     ResourceSystem& resourceSystem = ResourceSystem::GetInstance();
     PackFile* packFile = resourceSystem.GetPackFile();
 
-    const char* expectedSceneData = "TestEntity\n"
-                                    "POSITION:0.000000,0.000000,0.000000\n"
-                                    "ROTATION:0.000000\n"
-                                    "Z-INDEX:0\n"
-                                    "|TestEntity\n"
-                                    "POSITION:0.000000,0.000000,0.000000\n"
-                                    "ROTATION:0.000000\n"
-                                    "Z-INDEX:0|TestEntity\n"
-                                    "POSITION:0.000000,0.000000,0.000000\n"
-                                    "ROTATION:0.000000\n"
-                                    "Z-INDEX:0\n|";
+    const char* expectedSceneData = "TestEntity;"
+                                    "POSITION:0.000000,0.000000,0.000000;"
+                                    "ROTATION:0.000000;"
+                                    "Z-INDEX:0;"
+                                    "|"
+                                    "TestEntity;"
+                                    "POSITION:0.000000,0.000000,0.000000;"
+                                    "ROTATION:0.000000;"
+                                    "Z-INDEX:0;"
+                                    "|"
+                                    "TestEntity;"
+                                    "POSITION:0.000000,0.000000,0.000000;"
+                                    "ROTATION:0.000000;"
+                                    "Z-INDEX:0;"
+                                    "|";
 
     SceneData* data = packFile->FindData<SceneData>("data/scene1.scene");
     ASSERT_TRUE(data);

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`namespace Siege`
`30`	`30`	`{`
`31`	`31`	`// Define constants`
`32`		`-static constexpr const char LINE_SEP = '\n';`
	`32`	`+static constexpr const char LINE_SEP = ';';`
`33`	`33`	`static constexpr const char NAME_SEP = ':';`
`34`	`34`	`static constexpr const char* SCENE_FILE_EXT = ".scene";`
`35`	`35`	`static constexpr const char* ENTITY_FILE_EXT = ".entity";`