Add a way to register graphics effects

Author: adazem009

include/scratchcpp/scratchconfiguration.h

@@ -13,6 +13,7 @@ namespace libscratchcpp
 class IExtension;
 class IImageFormat;
 class IImageFormatFactory;
+class IGraphicsEffect;
 class ScratchConfigurationPrivate;
 
 /*! \brief The ScratchConfiguration class provides methods for adding custom extensions. */
@@ -41,6 +42,10 @@ class LIBSCRATCHCPP_EXPORT ScratchConfiguration
         static void removeImageFormat(const std::string &name);
         static std::shared_ptr<IImageFormat> createImageFormat(const std::string &name);
 
+        static void registerGraphicsEffect(std::shared_ptr<IGraphicsEffect> effect);
+        static void removeGraphicsEffect(const std::string &name);
+        static IGraphicsEffect *getGraphicsEffect(const std::string &name);
+
     private:
         static const std::vector<std::shared_ptr<IExtension>> getExtensions();
 

src/scratchconfiguration.cpp

@@ -2,6 +2,7 @@
 
 #include <scratchcpp/scratchconfiguration.h>
 #include <scratchcpp/iimageformatfactory.h>
+#include <scratchcpp/igraphicseffect.h>
 #include <iostream>
 
 #include "scratchconfiguration_p.h"
@@ -50,6 +51,32 @@ std::shared_ptr<IImageFormat> ScratchConfiguration::createImageFormat(const std:
         return it->second->createInstance();
 }
 
+/*! Registers the given graphics effect. */
+void ScratchConfiguration::registerGraphicsEffect(std::shared_ptr<IGraphicsEffect> effect)
+{
+    if (!effect)
+        return;
+
+    impl->graphicsEffects[effect->name()] = effect;
+}
+
+/*! Removes the given graphics effect. */
+void ScratchConfiguration::removeGraphicsEffect(const std::string &name)
+{
+    impl->graphicsEffects.erase(name);
+}
+
+/*! Returns the graphics effect with the given name, or nullptr if it isn't registered. */
+IGraphicsEffect *ScratchConfiguration::getGraphicsEffect(const std::string &name)
+{
+    auto it = impl->graphicsEffects.find(name);
+
+    if (it == impl->graphicsEffects.cend())
+        return nullptr;
+    else
+        return it->second.get();
+}
+
 const std::vector<std::shared_ptr<IExtension>> ScratchConfiguration::getExtensions()
 {
     return impl->extensions;

src/scratchconfiguration_p.h

@@ -14,6 +14,7 @@ namespace libscratchcpp
 
 class IExtension;
 class IImageFormatFactory;
+class IGraphicsEffect;
 
 struct ScratchConfigurationPrivate
 {
@@ -22,6 +23,7 @@ struct ScratchConfigurationPrivate
 
         std::vector<std::shared_ptr<IExtension>> extensions = { std::make_shared<StandardBlocks>() };
         std::unordered_map<std::string, std::shared_ptr<IImageFormatFactory>> imageFormats;
+        std::unordered_map<std::string, std::shared_ptr<IGraphicsEffect>> graphicsEffects;
 };
 
 } // namespace libscratchcpp

test/scratchconfiguration/scratchconfiguration_test.cpp

@@ -1,5 +1,6 @@
 #include <scratchcpp/scratchconfiguration.h>
 #include <imageformatfactorymock.h>
+#include <graphicseffectmock.h>
 
 #include "../common.h"
 #include "imageformats/stub/imageformatstub.h"
@@ -80,3 +81,27 @@ TEST_F(ScratchConfigurationTest, ImageFormats)
     testing::Mock::AllowLeak(m_imageFormatMock1.get());
     testing::Mock::AllowLeak(m_imageFormatMock2.get());
 }
+
+TEST_F(ScratchConfigurationTest, GraphicsEffects)
+{
+    auto effect1 = std::make_shared<GraphicsEffectMock>();
+    auto effect2 = std::make_shared<GraphicsEffectMock>();
+
+    EXPECT_CALL(*effect1, name()).WillOnce(Return("effect1"));
+    EXPECT_CALL(*effect2, name()).WillOnce(Return("effect2"));
+    ScratchConfiguration::registerGraphicsEffect(effect1);
+    ScratchConfiguration::registerGraphicsEffect(effect2);
+    auto format1 = std::make_shared<ImageFormatStub>();
+    auto format2 = std::make_shared<ImageFormatStub>();
+
+    ASSERT_EQ(ScratchConfiguration::getGraphicsEffect("effect1"), effect1.get());
+    ASSERT_EQ(ScratchConfiguration::getGraphicsEffect("effect2"), effect2.get());
+    ASSERT_EQ(ScratchConfiguration::getGraphicsEffect("effect3"), nullptr);
+
+    ScratchConfiguration::removeGraphicsEffect("effect2");
+    ASSERT_EQ(ScratchConfiguration::getGraphicsEffect("effect1"), effect1.get());
+    ASSERT_EQ(ScratchConfiguration::getGraphicsEffect("effect2"), nullptr);
+
+    ScratchConfiguration::removeGraphicsEffect("effect1");
+    ASSERT_EQ(ScratchConfiguration::getGraphicsEffect("effect1"), nullptr);
+}