Target: Add variableData() method

Author: adazem009

include/scratchcpp/target.h

@@ -12,6 +12,7 @@ namespace libscratchcpp
 {
 
 class Variable;
+struct ValueData;
 class List;
 class Block;
 class Comment;
@@ -28,7 +29,7 @@ class LIBSCRATCHCPP_EXPORT Target : public Drawable
     public:
         Target();
         Target(const Target &) = delete;
-        virtual ~Target() { }
+        virtual ~Target();
 
         bool isTarget() const override final;
 
@@ -44,6 +45,8 @@ class LIBSCRATCHCPP_EXPORT Target : public Drawable
         int findVariable(const std::string &variableName) const;
         int findVariableById(const std::string &id) const;
 
+        ValueData **variableData();
+
         const std::vector<std::shared_ptr<List>> &lists() const;
         int addList(std::shared_ptr<List> list);
         std::shared_ptr<List> listAt(int index) const;

src/scratch/target.cpp

@@ -29,6 +29,13 @@ Target::Target() :
 {
 }
 
+/*! Destroys Target. */
+Target::~Target()
+{
+    if (impl->variableData)
+        free(impl->variableData);
+}
+
 /*! Returns true. */
 bool Target::isTarget() const
 {
@@ -66,6 +73,7 @@ int Target::addVariable(std::shared_ptr<Variable> variable)
         return it - impl->variables.begin();
 
     impl->variables.push_back(variable);
+    impl->variableDataDirty = true;
     variable->setTarget(this);
 
     return impl->variables.size() - 1;
@@ -102,6 +110,31 @@ int Target::findVariableById(const std::string &id) const
         return it - impl->variables.begin();
 }
 
+/*! Returns an array of raw variable data pointers (for optimized variable access). */
+ValueData **Target::variableData()
+{
+    if (impl->variableDataDirty) {
+        const size_t len = impl->variables.size();
+
+        if (len == 0) {
+            impl->variableDataDirty = false;
+            return nullptr;
+        }
+
+        if (impl->variableData)
+            impl->variableData = (ValueData **)realloc(impl->variableData, len * sizeof(ValueData *));
+        else
+            impl->variableData = (ValueData **)malloc(len * sizeof(ValueData *));
+
+        for (size_t i = 0; i < len; i++)
+            impl->variableData[i] = &impl->variables[i]->valuePtr()->data();
+
+        impl->variableDataDirty = false;
+    }
+
+    return impl->variableData;
+}
+
 /*! Returns the list of Scratch lists. */
 const std::vector<std::shared_ptr<List>> &Target::lists() const
 {

src/scratch/target_p.h

@@ -28,6 +28,8 @@ struct TargetPrivate
 
         std::string name;
         std::vector<std::shared_ptr<Variable>> variables;
+        bool variableDataDirty = true;
+        ValueData **variableData = nullptr;
         std::vector<std::shared_ptr<List>> lists;
         std::vector<std::shared_ptr<Block>> blocks;
         std::vector<std::shared_ptr<Comment>> comments;

test/scratch_classes/target_test.cpp

@@ -75,10 +75,19 @@ TEST(TargetTest, Variables)
     auto v3 = std::make_shared<Variable>("c", "var3");
 
     Target target;
+    ASSERT_EQ(target.variableData(), nullptr);
     ASSERT_EQ(target.addVariable(v1), 0);
+    ASSERT_TRUE(target.variableData());
+    ASSERT_EQ(target.variableData()[0], &v1->value().data());
     ASSERT_EQ(target.addVariable(v2), 1);
     ASSERT_EQ(target.addVariable(v3), 2);
+    ASSERT_EQ(target.variableData()[0], &v1->value().data());
+    ASSERT_EQ(target.variableData()[1], &v2->value().data());
+    ASSERT_EQ(target.variableData()[2], &v3->value().data());
     ASSERT_EQ(target.addVariable(v2), 1); // add existing variable
+    ASSERT_EQ(target.variableData()[0], &v1->value().data());
+    ASSERT_EQ(target.variableData()[1], &v2->value().data());
+    ASSERT_EQ(target.variableData()[2], &v3->value().data());
 
     ASSERT_EQ(v1->target(), &target);
     ASSERT_EQ(v2->target(), &target);