Merge pull request #182 from scratchcpp/asset_base_class

adazem009 · web-flow · commit 18dc0294d275 · 2023-08-29T15:18:54.000+02:00
Use Entity as the base class of Asset
diff --git a/include/scratchcpp/asset.h b/include/scratchcpp/asset.h
@@ -2,9 +2,8 @@
 
 #pragma once
 
-#include <string>
+#include "entity.h"
 #include "spimpl.h"
-
 #include "global.h"
 
 namespace libscratchcpp
@@ -13,12 +12,13 @@ namespace libscratchcpp
 class AssetPrivate;
 
 /*! \brief The Asset class represents a Scratch asset, for example a Costume or a Sound. */
-class LIBSCRATCHCPP_EXPORT Asset
+class LIBSCRATCHCPP_EXPORT Asset : public Entity
 {
     public:
         Asset(const std::string &name, const std::string &id, const std::string &format);
+        Asset(const Asset &) = delete;
 
-        const std::string &assetId() const;
+        void setId(const std::string &id);
 
         const std::string &name() const;
 
diff --git a/include/scratchcpp/costume.h b/include/scratchcpp/costume.h
@@ -16,6 +16,7 @@ class LIBSCRATCHCPP_EXPORT Costume : public Asset
 {
     public:
         Costume(const std::string &name, const std::string &id, const std::string &format);
+        Costume(const Costume &) = delete;
 
         double bitmapResolution() const;
         void setBitmapResolution(double newBitmapResolution);
diff --git a/include/scratchcpp/sound.h b/include/scratchcpp/sound.h
@@ -16,6 +16,7 @@ class LIBSCRATCHCPP_EXPORT Sound : public Asset
 {
     public:
         Sound(const std::string &name, const std::string &id, const std::string &format);
+        Sound(const Sound &) = delete;
 
         int rate() const;
         void setRate(int newRate);
diff --git a/include/scratchcpp/target.h b/include/scratchcpp/target.h
@@ -51,14 +51,14 @@ class LIBSCRATCHCPP_EXPORT Target
         int currentCostume() const;
         void setCurrentCostume(int newCostume);
 
-        const std::vector<Costume> &costumes() const;
-        int addCostume(const Costume &costume);
-        const Costume &costumeAt(int index) const;
+        const std::vector<std::shared_ptr<Costume>> &costumes() const;
+        int addCostume(std::shared_ptr<Costume> costume);
+        std::shared_ptr<Costume> costumeAt(int index) const;
         int findCostume(const std::string &costumeName) const;
 
-        const std::vector<Sound> &sounds() const;
-        int addSound(const Sound &sound);
-        const Sound &soundAt(int index) const;
+        const std::vector<std::shared_ptr<Sound>> &sounds() const;
+        int addSound(std::shared_ptr<Sound> sound);
+        std::shared_ptr<Sound> soundAt(int index) const;
         int findSound(const std::string &soundName) const;
 
         int layerOrder() const;
diff --git a/src/internal/scratch3reader.cpp b/src/internal/scratch3reader.cpp
@@ -203,14 +203,14 @@ bool Scratch3Reader::load()
             auto costumes = jsonTarget["costumes"];
             for (auto jsonCostume : costumes) {
                 READER_STEP(step, "target -> costume -> { name, assetId, dataFormat }");
-                Costume costume(jsonCostume["name"], jsonCostume["assetId"], jsonCostume["dataFormat"]);
+                auto costume = std::make_shared<Costume>(jsonCostume["name"], jsonCostume["assetId"], jsonCostume["dataFormat"]);
                 READER_STEP(step, "target -> costume -> bitmapResolution");
                 if (jsonCostume.contains("bitmapResolution"))
-                    costume.setBitmapResolution(jsonCostume["bitmapResolution"]);
+                    costume->setBitmapResolution(jsonCostume["bitmapResolution"]);
                 READER_STEP(step, "target -> costume -> rotationCenterX");
-                costume.setRotationCenterX(jsonCostume["rotationCenterX"]);
+                costume->setRotationCenterX(jsonCostume["rotationCenterX"]);
                 READER_STEP(step, "target -> costume -> rotationCenterY");
-                costume.setRotationCenterY(jsonCostume["rotationCenterY"]);
+                costume->setRotationCenterY(jsonCostume["rotationCenterY"]);
                 target->addCostume(costume);
             }
 
@@ -219,11 +219,11 @@ bool Scratch3Reader::load()
             auto sounds = jsonTarget["sounds"];
             for (auto jsonSound : sounds) {
                 READER_STEP(step, "target -> sound -> { name, assetId, dataFormat }");
-                Sound sound(jsonSound["name"], jsonSound["assetId"], jsonSound["dataFormat"]);
+                auto sound = std::make_shared<Sound>(jsonSound["name"], jsonSound["assetId"], jsonSound["dataFormat"]);
                 READER_STEP(step, "target -> sound -> rate");
-                sound.setRate(jsonSound["rate"]);
+                sound->setRate(jsonSound["rate"]);
                 READER_STEP(step, "target -> sound -> sampleCount");
-                sound.setSampleCount(jsonSound["sampleCount"]);
+                sound->setSampleCount(jsonSound["sampleCount"]);
                 target->addSound(sound);
             }
 
diff --git a/src/scratch/asset.cpp b/src/scratch/asset.cpp
@@ -8,14 +8,17 @@ using namespace libscratchcpp;
 
 /*! Constructs Asset. */
 Asset::Asset(const std::string &name, const std::string &id, const std::string &format) :
-    impl(spimpl::make_impl<AssetPrivate>(name, id, format))
+    Entity(id),
+    impl(spimpl::make_impl<AssetPrivate>(name, format))
 {
+    impl->updateFileName(id);
 }
 
-/*! Returns the MD5 hash of the asset file. */
-const std::string &Asset::assetId() const
+/*! Sets the ID (MD5 hash) of the asset file. */
+void Asset::setId(const std::string &id)
 {
-    return impl->assetId;
+    Entity::setId(id);
+    impl->updateFileName(id);
 }
 
 /*! Returns the name of the asset. */
diff --git a/src/scratch/asset_p.cpp b/src/scratch/asset_p.cpp
@@ -4,16 +4,14 @@
 
 using namespace libscratchcpp;
 
-AssetPrivate::AssetPrivate(const std::string &name, const std::string &id, const std::string &format) :
+AssetPrivate::AssetPrivate(const std::string &name, const std::string &format) :
     name(name),
-    assetId(id),
     dataFormat(format)
 {
-    updateFileName();
 }
 
-void AssetPrivate::updateFileName()
+void AssetPrivate::updateFileName(const std::string &id)
 {
-    // NOTE: fileName depends on assetId and dataFormat
-    fileName = assetId + "." + dataFormat;
+    // NOTE: fileName depends on id and dataFormat
+    fileName = id + "." + dataFormat;
 }
diff --git a/src/scratch/asset_p.h b/src/scratch/asset_p.h
@@ -9,11 +9,10 @@ namespace libscratchcpp
 
 struct AssetPrivate
 {
-        AssetPrivate(const std::string &name, const std::string &id, const std::string &format);
+        AssetPrivate(const std::string &name, const std::string &format);
 
-        void updateFileName();
+        void updateFileName(const std::string &id);
 
-        std::string assetId;
         std::string name;
         std::string dataFormat;
         std::string fileName;
diff --git a/src/scratch/target.cpp b/src/scratch/target.cpp
@@ -193,35 +193,25 @@ void Target::setCurrentCostume(int newCostume)
 }
 
 /*! Returns the list of costumes. */
-const std::vector<Costume> &Target::costumes() const
+const std::vector<std::shared_ptr<Costume>> &Target::costumes() const
 {
     return impl->costumes;
 }
 
 /*! Adds a costume and returns its index. */
-int Target::addCostume(const Costume &costume)
+int Target::addCostume(std::shared_ptr<Costume> costume)
 {
-    // TODO: Use shared_ptr for assets
-    /*auto it = std::find(impl->costumes.begin(), impl->costumes.end(), costume);
+    auto it = std::find(impl->costumes.begin(), impl->costumes.end(), costume);
 
-    if (it != impl->blocks.end())
-        return it - impl->blocks.begin();*/
-
-    int i = 0;
-
-    for (const auto &c : impl->costumes) {
-        if (c.name() == costume.name())
-            return i;
-
-        i++;
-    }
+    if (it != impl->costumes.end())
+        return it - impl->costumes.begin();
 
     impl->costumes.push_back(costume);
     return impl->costumes.size() - 1;
 }
 
 /*! Returns the costume at index. */
-const libscratchcpp::Costume &Target::costumeAt(int index) const
+std::shared_ptr<Costume> Target::costumeAt(int index) const
 {
     // TODO: Add range check
     return impl->costumes[index];
@@ -232,42 +222,33 @@ int Target::findCostume(const std::string &costumeName) const
 {
     int i = 0;
     for (auto costume : impl->costumes) {
-        if (costume.name() == costumeName)
+        if (costume->name() == costumeName)
             return i;
         i++;
     }
     return -1;
 }
 
 /*! Returns the list of sounds. */
-const std::vector<Sound> &Target::sounds() const
+const std::vector<std::shared_ptr<Sound>> &Target::sounds() const
 {
     return impl->sounds;
 }
 
 /*! Adds a sound and returns its index. */
-int Target::addSound(const Sound &sound)
+int Target::addSound(std::shared_ptr<Sound> sound)
 {
-    // TODO: Use shared_ptr for assets
-    /*auto it = std::find(impl->sounds.begin(), impl->sounds.end(), sound);
+    auto it = std::find(impl->sounds.begin(), impl->sounds.end(), sound);
 
     if (it != impl->sounds.end())
-        return it - impl->sounds.begin();*/
-
-    int i = 0;
+        return it - impl->sounds.begin();
 
-    for (const auto &s : impl->sounds) {
-        if (s.name() == sound.name())
-            return i;
-
-        i++;
-    }
     impl->sounds.push_back(sound);
     return impl->sounds.size() - 1;
 }
 
 /*! Returns the sound at index. */
-const libscratchcpp::Sound &Target::soundAt(int index) const
+std::shared_ptr<Sound> Target::soundAt(int index) const
 {
     // TODO: Add range check
     return impl->sounds[index];
@@ -278,7 +259,7 @@ int Target::findSound(const std::string &soundName) const
 {
     int i = 0;
     for (auto sound : impl->sounds) {
-        if (sound.name() == soundName)
+        if (sound->name() == soundName)
             return i;
         i++;
     }
diff --git a/src/scratch/target_p.h b/src/scratch/target_p.h
@@ -25,8 +25,8 @@ struct TargetPrivate
         std::vector<std::shared_ptr<List>> lists;
         std::vector<std::shared_ptr<Block>> blocks;
         int currentCostume = 1;
-        std::vector<Costume> costumes;
-        std::vector<Sound> sounds;
+        std::vector<std::shared_ptr<Costume>> costumes;
+        std::vector<std::shared_ptr<Sound>> sounds;
         int layerOrder = 0;
         int volume = 100;
 };
diff --git a/test/assets/asset_test.cpp b/test/assets/asset_test.cpp
@@ -7,8 +7,17 @@ using namespace libscratchcpp;
 TEST(AssetTest, Constructors)
 {
     Asset asset("costume1", "a", "svg");
-    ASSERT_EQ(asset.assetId(), "a");
+    ASSERT_EQ(asset.id(), "a");
     ASSERT_EQ(asset.name(), "costume1");
     ASSERT_EQ(asset.dataFormat(), "svg");
     ASSERT_EQ(asset.md5ext(), "a.svg");
 }
+
+TEST(AssetTest, Id)
+{
+    Asset asset("costume1", "a", "svg");
+
+    asset.setId("b");
+    ASSERT_EQ(asset.id(), "b");
+    ASSERT_EQ(asset.md5ext(), "b.svg");
+}
diff --git a/test/assets/costume_test.cpp b/test/assets/costume_test.cpp
@@ -7,7 +7,7 @@ using namespace libscratchcpp;
 TEST(CostumeTest, Constructors)
 {
     Costume costume("costume1", "a", "svg");
-    ASSERT_EQ(costume.assetId(), "a");
+    ASSERT_EQ(costume.id(), "a");
     ASSERT_EQ(costume.name(), "costume1");
     ASSERT_EQ(costume.dataFormat(), "svg");
     ASSERT_EQ(costume.md5ext(), "a.svg");
diff --git a/test/assets/sound_test.cpp b/test/assets/sound_test.cpp
@@ -7,7 +7,7 @@ using namespace libscratchcpp;
 TEST(SoundTest, Constructors)
 {
     Sound sound("sound1", "a", "svg");
-    ASSERT_EQ(sound.assetId(), "a");
+    ASSERT_EQ(sound.id(), "a");
     ASSERT_EQ(sound.name(), "sound1");
     ASSERT_EQ(sound.dataFormat(), "svg");
     ASSERT_EQ(sound.md5ext(), "a.svg");
diff --git a/test/load_project/load_project_test.cpp b/test/load_project/load_project_test.cpp
@@ -50,10 +50,10 @@ TEST(LoadProjectTest, EmptyProject)
         ASSERT_TRUE(stage->textToSpeechLanguage().empty());
 
         auto backdrop = stage->costumeAt(0);
-        ASSERT_EQ(backdrop.name(), "backdrop1");
-        ASSERT_FALSE(backdrop.assetId().empty());
-        ASSERT_EQ(backdrop.md5ext(), backdrop.assetId() + ".svg");
-        ASSERT_EQ(backdrop.dataFormat(), "svg");
+        ASSERT_EQ(backdrop->name(), "backdrop1");
+        ASSERT_FALSE(backdrop->id().empty());
+        ASSERT_EQ(backdrop->md5ext(), backdrop->id() + ".svg");
+        ASSERT_EQ(backdrop->dataFormat(), "svg");
 
         i++;
     }
@@ -109,10 +109,10 @@ TEST(LoadProjectTest, LoadTestProject)
 
         // Sprite1: sounds
         auto sound = sprite1->soundAt(0);
-        ASSERT_EQ(sound.name(), "Meow");
-        ASSERT_FALSE(sound.assetId().empty());
-        ASSERT_EQ(sound.md5ext(), sound.assetId() + ".wav");
-        ASSERT_EQ(sound.dataFormat(), "wav");
+        ASSERT_EQ(sound->name(), "Meow");
+        ASSERT_FALSE(sound->id().empty());
+        ASSERT_EQ(sound->md5ext(), sound->id() + ".wav");
+        ASSERT_EQ(sound->dataFormat(), "wav");
 
         // Sprite1: variables
         ASSERT_VAR(sprite1, "var2");
@@ -238,10 +238,10 @@ TEST(LoadProjectTest, LoadTestProject)
 
         // Balloon1: sounds
         sound = sprite2->soundAt(0);
-        ASSERT_EQ(sound.name(), "Pop");
-        ASSERT_FALSE(sound.assetId().empty());
-        ASSERT_EQ(sound.md5ext(), sound.assetId() + ".wav");
-        ASSERT_EQ(sound.dataFormat(), "wav");
+        ASSERT_EQ(sound->name(), "Pop");
+        ASSERT_FALSE(sound->id().empty());
+        ASSERT_EQ(sound->md5ext(), sound->id() + ".wav");
+        ASSERT_EQ(sound->dataFormat(), "wav");
 
         // Balloon1: variables
         ASSERT_VAR(sprite2, "var2");
diff --git a/test/scratch_classes/target_test.cpp b/test/scratch_classes/target_test.cpp

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ class LIBSCRATCHCPP_EXPORT Costume : public Asset`
`16`	`16`	`{`
`17`	`17`	`public:`
`18`	`18`	`Costume(const std::string &name, const std::string &id, const std::string &format);`
	`19`	`+ Costume(const Costume &) = delete;`
`19`	`20`
`20`	`21`	`double bitmapResolution() const;`
`21`	`22`	`void setBitmapResolution(double newBitmapResolution);`
Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,17 @@ using namespace libscratchcpp;`
`8`	`8`
`9`	`9`	`/! Constructs Asset. /`
`10`	`10`	`Asset::Asset(const std::string &name, const std::string &id, const std::string &format) :`
`11`		`- impl(spimpl::make_impl<AssetPrivate>(name, id, format))`
	`11`	`+ Entity(id),`
	`12`	`+ impl(spimpl::make_impl<AssetPrivate>(name, format))`
`12`	`13`	`{`
	`14`	`+ impl->updateFileName(id);`
`13`	`15`	`}`
`14`	`16`
`15`		`-/! Returns the MD5 hash of the asset file. /`
`16`		`-const std::string &Asset::assetId() const`
	`17`	`+/! Sets the ID (MD5 hash) of the asset file. /`
	`18`	`+void Asset::setId(const std::string &id)`
`17`	`19`	`{`
`18`		`- return impl->assetId;`
	`20`	`+ Entity::setId(id);`
	`21`	`+ impl->updateFileName(id);`
`19`	`22`	`}`
`20`	`23`
`21`	`24`	`/! Returns the name of the asset. /`
Original file line number	Diff line number	Diff line change
`@@ -4,16 +4,14 @@`
`4`	`4`
`5`	`5`	`using namespace libscratchcpp;`
`6`	`6`
`7`		`-AssetPrivate::AssetPrivate(const std::string &name, const std::string &id, const std::string &format) :`
	`7`	`+AssetPrivate::AssetPrivate(const std::string &name, const std::string &format) :`
`8`	`8`	`name(name),`
`9`		`- assetId(id),`
`10`	`9`	`dataFormat(format)`
`11`	`10`	`{`
`12`		`- updateFileName();`
`13`	`11`	`}`
`14`	`12`
`15`		`-void AssetPrivate::updateFileName()`
	`13`	`+void AssetPrivate::updateFileName(const std::string &id)`
`16`	`14`	`{`
`17`		`- // NOTE: fileName depends on assetId and dataFormat`
`18`		`- fileName = assetId + "." + dataFormat;`
	`15`	`+ // NOTE: fileName depends on id and dataFormat`
	`16`	`+ fileName = id + "." + dataFormat;`
`19`	`17`	`}`