Merge pull request #333 from scratchcpp/refactor_target_interfaces

Refactor target interfaces

Author: adazem009

include/scratchcpp/ispritehandler.h

@@ -14,17 +14,31 @@ class LIBSCRATCHCPP_EXPORT ISpriteHandler
     public:
         virtual ~ISpriteHandler() { }
 
-        virtual void onSpriteChanged(Sprite *sprite) = 0;
+        /*! Called when the interface is set on a sprite. */
+        virtual void init(Sprite *sprite) = 0;
 
+        /*! Called when the sprite clones. */
         virtual void onCloned(Sprite *clone) = 0;
 
-        virtual void onCostumeChanged(const char *data) = 0;
+        /*! Called when the costume changes. */
+        virtual void onCostumeChanged(Costume *costume) = 0;
 
+        /*! Called when the visibility changes. */
         virtual void onVisibleChanged(bool visible) = 0;
+
+        /*! Called when the X-coordinate changes. */
         virtual void onXChanged(double x) = 0;
+
+        /*! Called when the Y-coordinate changes. */
         virtual void onYChanged(double y) = 0;
+
+        /*! Called when the size changes. */
         virtual void onSizeChanged(double size) = 0;
+
+        /*! Called when the direction changes. */
         virtual void onDirectionChanged(double direction) = 0;
+
+        /*! Called when the rotation style changes. */
         virtual void onRotationStyleChanged(Sprite::RotationStyle rotationStyle) = 0;
 };
 

include/scratchcpp/istagehandler.h

@@ -14,12 +14,19 @@ class LIBSCRATCHCPP_EXPORT IStageHandler
     public:
         virtual ~IStageHandler() { }
 
-        virtual void onStageChanged(Stage *stage) = 0;
+        /*! Called when the interface is set on a stage. */
+        virtual void init(Stage *stage) = 0;
 
-        virtual void onCostumeChanged(const char *data) = 0;
+        /*! Called when the costume changes. */
+        virtual void onCostumeChanged(Costume *costume) = 0;
 
+        /*! Called when the tempo changes. */
         virtual void onTempoChanged(int tempo) = 0;
+
+        /*! Called when the video state changes. */
         virtual void onVideoStateChanged(Stage::VideoState videoState) = 0;
+
+        /*! Called when the video transparency changes. */
         virtual void onVideoTransparencyChanged(int videoTransparency) = 0;
 };
 

include/scratchcpp/stage.h

@@ -29,6 +29,9 @@ class LIBSCRATCHCPP_EXPORT Stage : public Target
         void setInterface(IStageHandler *newInterface);
 
         bool isStage() const override;
+
+        void setCostumeIndex(int newCostumeIndex);
+
         int tempo() const;
         void setTempo(int newTempo);
 

src/scratch/sprite.cpp

@@ -44,7 +44,7 @@ void Sprite::setInterface(ISpriteHandler *newInterface)
 {
     assert(newInterface);
     impl->iface = newInterface;
-    impl->iface->onSpriteChanged(this);
+    impl->iface->init(this);
 }
 
 /*! Creates a clone of the sprite. */
@@ -246,6 +246,9 @@ void Sprite::setCostumeIndex(int newCostumeIndex)
     }
 
     Target::setCostumeIndex(newCostumeIndex);
+
+    if (costume && impl->iface)
+        impl->iface->onCostumeChanged(costume.get());
 }
 
 /*! Returns the direction. */

src/scratch/sprite_p.cpp

@@ -31,12 +31,6 @@ void SpritePrivate::removeClone(Sprite *clone)
     }
 }
 
-void SpritePrivate::setCostumeData(const char *data)
-{
-    if (iface)
-        iface->onCostumeChanged(data);
-}
-
 void SpritePrivate::getBoundingRect(Rect *out) const
 {
     assert(out);

src/scratch/sprite_p.h

@@ -17,7 +17,6 @@ struct SpritePrivate
 
         void removeClone(Sprite *clone);
 
-        void setCostumeData(const char *data);
         void getBoundingRect(Rect *out) const;
         void getFencedPosition(double inX, double inY, double *outX, double *outY) const;
 

src/scratch/stage.cpp

@@ -20,7 +20,7 @@ void Stage::setInterface(IStageHandler *newInterface)
 {
     assert(newInterface);
     impl->iface = newInterface;
-    impl->iface->onStageChanged(this);
+    impl->iface->init(this);
 }
 
 /*! Returns true. */
@@ -29,6 +29,16 @@ bool Stage::isStage() const
     return true;
 }
 
+/*! Overrides Target#setCostumeIndex(). */
+void Stage::setCostumeIndex(int newCostumeIndex)
+{
+    Target::setCostumeIndex(newCostumeIndex);
+    auto costume = costumeAt(newCostumeIndex);
+
+    if (impl->iface)
+        impl->iface->onCostumeChanged(costume.get());
+}
+
 /*! Returns the tempo. */
 int Stage::tempo() const
 {

src/scratch/stage_p.cpp

@@ -9,9 +9,3 @@ using namespace libscratchcpp;
 StagePrivate::StagePrivate()
 {
 }
-
-void StagePrivate::setCostumeData(const char *data)
-{
-    if (iface)
-        iface->onCostumeChanged(data);
-}

src/scratch/stage_p.h

@@ -12,8 +12,6 @@ struct StagePrivate
         StagePrivate();
         StagePrivate(const StagePrivate &) = delete;
 
-        void setCostumeData(const char *data);
-
         IStageHandler *iface = nullptr;
         int tempo = 60;
         Stage::VideoState videoState = Stage::VideoState::Off;

test/mocks/spritehandlermock.h

@@ -8,11 +8,11 @@ using namespace libscratchcpp;
 class SpriteHandlerMock : public ISpriteHandler
 {
     public:
-        MOCK_METHOD(void, onSpriteChanged, (Sprite *), (override));
+        MOCK_METHOD(void, init, (Sprite *), (override));
 
         MOCK_METHOD(void, onCloned, (Sprite *), (override));
 
-        MOCK_METHOD(void, onCostumeChanged, (const char *), (override));
+        MOCK_METHOD(void, onCostumeChanged, (Costume *), (override));
 
         MOCK_METHOD(void, onVisibleChanged, (bool), (override));
         MOCK_METHOD(void, onXChanged, (double), (override));