Add color() method to extensions

adazem009 · adazem009 · commit e60128884c80 · 2025-01-26T15:37:59.000+01:00
Resolves: #582
diff --git a/include/scratchcpp/iextension.h b/include/scratchcpp/iextension.h
@@ -2,9 +2,7 @@
 
 #pragma once
 
-#include <string>
-
-#include "global.h"
+#include "value_functions.h"
 
 namespace libscratchcpp
 {
@@ -27,6 +25,9 @@ class LIBSCRATCHCPP_EXPORT IExtension
         /*! Returns the description of the extension. */
         virtual std::string description() const = 0;
 
+        /*! Returns the block color of the extension. */
+        virtual Rgb color() const = 0;
+
         /*! Override this method to register blocks. */
         virtual void registerBlocks(IEngine *engine) = 0;
 
diff --git a/src/blocks/controlblocks.cpp b/src/blocks/controlblocks.cpp
@@ -26,6 +26,11 @@ std::string ControlBlocks::description() const
     return name() + " blocks";
 }
 
+Rgb ControlBlocks::color() const
+{
+    return rgb(255, 171, 25);
+}
+
 void ControlBlocks::registerBlocks(IEngine *engine)
 {
     engine->addCompileFunction(this, "control_forever", &compileForever);
diff --git a/src/blocks/controlblocks.h b/src/blocks/controlblocks.h
@@ -12,6 +12,7 @@ class ControlBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 
diff --git a/src/blocks/customblocks.cpp b/src/blocks/customblocks.cpp
@@ -20,6 +20,11 @@ std::string CustomBlocks::description() const
     return name();
 }
 
+Rgb CustomBlocks::color() const
+{
+    return rgb(255, 102, 128);
+}
+
 void CustomBlocks::registerBlocks(IEngine *engine)
 {
     engine->addCompileFunction(this, "procedures_definition", [](Compiler *) -> CompilerValue * { return nullptr; });
diff --git a/src/blocks/customblocks.h b/src/blocks/customblocks.h
@@ -12,6 +12,7 @@ class CustomBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 
diff --git a/src/blocks/eventblocks.cpp b/src/blocks/eventblocks.cpp
@@ -24,6 +24,11 @@ std::string libscratchcpp::EventBlocks::description() const
     return "Event blocks";
 }
 
+Rgb EventBlocks::color() const
+{
+    return rgb(255, 191, 0);
+}
+
 void EventBlocks::registerBlocks(IEngine *engine)
 {
     engine->addCompileFunction(this, "event_whentouchingobject", &compileWhenTouchingObject);
diff --git a/src/blocks/eventblocks.h b/src/blocks/eventblocks.h
@@ -12,6 +12,7 @@ class EventBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 
diff --git a/src/blocks/listblocks.cpp b/src/blocks/listblocks.cpp
@@ -20,6 +20,11 @@ std::string ListBlocks::description() const
     return "List blocks";
 }
 
+Rgb ListBlocks::color() const
+{
+    return rgb(255, 102, 26);
+}
+
 void ListBlocks::registerBlocks(IEngine *engine)
 {
     engine->addCompileFunction(this, "data_addtolist", &compileAddToList);
diff --git a/src/blocks/listblocks.h b/src/blocks/listblocks.h
@@ -14,6 +14,7 @@ class ListBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 
diff --git a/src/blocks/looksblocks.cpp b/src/blocks/looksblocks.cpp
@@ -14,6 +14,11 @@ std::string LooksBlocks::description() const
     return name() + " blocks";
 }
 
+Rgb LooksBlocks::color() const
+{
+    return rgb(153, 102, 255);
+}
+
 void LooksBlocks::registerBlocks(IEngine *engine)
 {
 }
diff --git a/src/blocks/looksblocks.h b/src/blocks/looksblocks.h
@@ -12,6 +12,7 @@ class LooksBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 };
diff --git a/src/blocks/motionblocks.cpp b/src/blocks/motionblocks.cpp
@@ -14,6 +14,11 @@ std::string MotionBlocks::description() const
     return name() + " blocks";
 }
 
+Rgb MotionBlocks::color() const
+{
+    return rgb(76, 151, 255);
+}
+
 void MotionBlocks::registerBlocks(IEngine *engine)
 {
 }
diff --git a/src/blocks/motionblocks.h b/src/blocks/motionblocks.h
@@ -12,6 +12,7 @@ class MotionBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 };
diff --git a/src/blocks/operatorblocks.cpp b/src/blocks/operatorblocks.cpp
@@ -21,6 +21,11 @@ std::string OperatorBlocks::description() const
     return "Operator blocks";
 }
 
+Rgb OperatorBlocks::color() const
+{
+    return rgb(89, 192, 89);
+}
+
 void OperatorBlocks::registerBlocks(IEngine *engine)
 {
     engine->addCompileFunction(this, "operator_add", &compileAdd);
diff --git a/src/blocks/operatorblocks.h b/src/blocks/operatorblocks.h
@@ -14,6 +14,7 @@ class OperatorBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 
diff --git a/src/blocks/sensingblocks.cpp b/src/blocks/sensingblocks.cpp
@@ -14,6 +14,11 @@ std::string SensingBlocks::description() const
     return name() + " blocks";
 }
 
+Rgb SensingBlocks::color() const
+{
+    return rgb(92, 177, 214);
+}
+
 void SensingBlocks::registerBlocks(IEngine *engine)
 {
 }
diff --git a/src/blocks/sensingblocks.h b/src/blocks/sensingblocks.h
@@ -12,6 +12,7 @@ class SensingBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 };
diff --git a/src/blocks/soundblocks.cpp b/src/blocks/soundblocks.cpp
@@ -14,6 +14,11 @@ std::string SoundBlocks::description() const
     return name() + " blocks";
 }
 
+Rgb SoundBlocks::color() const
+{
+    return rgb(207, 99, 207);
+}
+
 void SoundBlocks::registerBlocks(IEngine *engine)
 {
 }
diff --git a/src/blocks/soundblocks.h b/src/blocks/soundblocks.h
@@ -12,6 +12,7 @@ class SoundBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 };
diff --git a/src/blocks/variableblocks.cpp b/src/blocks/variableblocks.cpp
@@ -21,6 +21,11 @@ std::string VariableBlocks::description() const
     return "Variable blocks";
 }
 
+Rgb VariableBlocks::color() const
+{
+    return rgb(255, 140, 26);
+}
+
 void VariableBlocks::registerBlocks(IEngine *engine)
 {
     engine->addCompileFunction(this, "data_variable", &compileVariable);
diff --git a/src/blocks/variableblocks.h b/src/blocks/variableblocks.h
@@ -12,6 +12,7 @@ class VariableBlocks : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 
diff --git a/test/extensions/testextension.cpp b/test/extensions/testextension.cpp
@@ -14,6 +14,11 @@ std::string TestExtension::description() const
     return "Test extension";
 }
 
+Rgb TestExtension::color() const
+{
+    return rgb(0, 0, 0);
+}
+
 void TestExtension::registerBlocks(IEngine *engine)
 {
     engine->clear();
diff --git a/test/extensions/testextension.h b/test/extensions/testextension.h
@@ -10,6 +10,7 @@ class TestExtension : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
         void onInit(IEngine *engine) override;
diff --git a/test/mocks/extensionmock.h b/test/mocks/extensionmock.h
@@ -10,6 +10,7 @@ class ExtensionMock : public IExtension
     public:
         MOCK_METHOD(std::string, name, (), (const, override));
         MOCK_METHOD(std::string, description, (), (const, override));
+        MOCK_METHOD(Rgb, color, (), (const, override));
 
         MOCK_METHOD(void, registerBlocks, (IEngine *), (override));
         MOCK_METHOD(void, onInit, (IEngine *), (override));
diff --git a/test/scratch_classes/testextension.cpp b/test/scratch_classes/testextension.cpp
@@ -14,6 +14,11 @@ std::string TestExtension::description() const
     return "";
 }
 
+Rgb TestExtension::color() const
+{
+    return rgb(0, 0, 0);
+}
+
 void TestExtension::registerBlocks(IEngine *engine)
 {
 }
diff --git a/test/scratch_classes/testextension.h b/test/scratch_classes/testextension.h
@@ -10,6 +10,7 @@ class TestExtension : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 };
diff --git a/test/scratchconfiguration/extension1.cpp b/test/scratchconfiguration/extension1.cpp
@@ -6,3 +6,8 @@ std::string Extension1::name() const
 {
     return "ext 1";
 }
+
+Rgb Extension1::color() const
+{
+    return rgb(0, 0, 0);
+}
diff --git a/test/scratchconfiguration/extension1.h b/test/scratchconfiguration/extension1.h
@@ -9,6 +9,7 @@ class Extension1 : public ExtensionBase
 {
     public:
         std::string name() const override;
+        Rgb color() const override;
 };
 
 } // namespace libscratchcpp
diff --git a/test/scratchconfiguration/extension2.cpp b/test/scratchconfiguration/extension2.cpp
@@ -6,3 +6,8 @@ std::string Extension2::name() const
 {
     return "ext 2";
 }
+
+Rgb Extension2::color() const
+{
+    return rgb(0, 0, 0);
+}
diff --git a/test/scratchconfiguration/extension2.h b/test/scratchconfiguration/extension2.h
@@ -9,6 +9,7 @@ class Extension2 : public ExtensionBase
 {
     public:
         std::string name() const override;
+        Rgb color() const override;
 };
 
 } // namespace libscratchcpp
diff --git a/test/scratchconfiguration/extension3.cpp b/test/scratchconfiguration/extension3.cpp
@@ -6,3 +6,8 @@ std::string Extension3::name() const
 {
     return "ext 3";
 }
+
+Rgb Extension3::color() const
+{
+    return rgb(0, 0, 0);
+}
diff --git a/test/scratchconfiguration/extension3.h b/test/scratchconfiguration/extension3.h
@@ -9,6 +9,7 @@ class Extension3 : public ExtensionBase
 {
     public:
         std::string name() const override;
+        Rgb color() const override;
 };
 
 } // namespace libscratchcpp
diff --git a/test/test_api/testextension.cpp b/test/test_api/testextension.cpp
@@ -21,6 +21,11 @@ std::string TestExtension::description() const
     return "";
 }
 
+Rgb TestExtension::color() const
+{
+    return rgb(0, 0, 0);
+}
+
 void TestExtension::registerBlocks(IEngine *engine)
 {
     engine->addCompileFunction(this, "test_simple", &compileSimple);
diff --git a/test/test_api/testextension.h b/test/test_api/testextension.h
@@ -10,6 +10,7 @@ class TestExtension : public IExtension
     public:
         std::string name() const override;
         std::string description() const override;
+        Rgb color() const override;
 
         void registerBlocks(IEngine *engine) override;
 

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,11 @@ std::string ControlBlocks::description() const`
`26`	`26`	`return name() + " blocks";`
`27`	`27`	`}`
`28`	`28`
	`29`	`+Rgb ControlBlocks::color() const`
	`30`	`+{`
	`31`	`+ return rgb(255, 171, 25);`
	`32`	`+}`
	`33`	`+`
`29`	`34`	`void ControlBlocks::registerBlocks(IEngine *engine)`
`30`	`35`	`{`
`31`	`36`	`engine->addCompileFunction(this, "control_forever", &compileForever);`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,11 @@ std::string CustomBlocks::description() const`
`20`	`20`	`return name();`
`21`	`21`	`}`
`22`	`22`
	`23`	`+Rgb CustomBlocks::color() const`
	`24`	`+{`
	`25`	`+ return rgb(255, 102, 128);`
	`26`	`+}`
	`27`	`+`
`23`	`28`	`void CustomBlocks::registerBlocks(IEngine *engine)`
`24`	`29`	`{`
`25`	`30`	`engine->addCompileFunction(this, "procedures_definition", [](Compiler ) -> CompilerValue { return nullptr; });`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,11 @@ std::string libscratchcpp::EventBlocks::description() const`
`24`	`24`	`return "Event blocks";`
`25`	`25`	`}`
`26`	`26`
	`27`	`+Rgb EventBlocks::color() const`
	`28`	`+{`
	`29`	`+ return rgb(255, 191, 0);`
	`30`	`+}`
	`31`	`+`
`27`	`32`	`void EventBlocks::registerBlocks(IEngine *engine)`
`28`	`33`	`{`
`29`	`34`	`engine->addCompileFunction(this, "event_whentouchingobject", &compileWhenTouchingObject);`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,11 @@ std::string ListBlocks::description() const`
`20`	`20`	`return "List blocks";`
`21`	`21`	`}`
`22`	`22`
	`23`	`+Rgb ListBlocks::color() const`
	`24`	`+{`
	`25`	`+ return rgb(255, 102, 26);`
	`26`	`+}`
	`27`	`+`
`23`	`28`	`void ListBlocks::registerBlocks(IEngine *engine)`
`24`	`29`	`{`
`25`	`30`	`engine->addCompileFunction(this, "data_addtolist", &compileAddToList);`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,11 @@ std::string LooksBlocks::description() const`
`14`	`14`	`return name() + " blocks";`
`15`	`15`	`}`
`16`	`16`
	`17`	`+Rgb LooksBlocks::color() const`
	`18`	`+{`
	`19`	`+ return rgb(153, 102, 255);`
	`20`	`+}`
	`21`	`+`
`17`	`22`	`void LooksBlocks::registerBlocks(IEngine *engine)`
`18`	`23`	`{`
`19`	`24`	`}`