Add API for top level reporter blocks

Author: adazem009

include/scratchcpp/block.h

@@ -12,6 +12,7 @@ class IEngine;
 class Target;
 class Input;
 class Field;
+class InputValue;
 class BlockPrivate;
 
 /*! \brief The Block class represents a Scratch block. */
@@ -68,6 +69,11 @@ class LIBSCRATCHCPP_EXPORT Block : public Entity
 
         BlockPrototype *mutationPrototype();
 
+        bool isTopLevelReporter() const;
+        void setIsTopLevelReporter(bool isTopLevelReporter);
+
+        InputValue *topLevelReporterInfo();
+
     private:
         spimpl::unique_impl_ptr<BlockPrivate> impl;
 };

src/scratch/block.cpp

@@ -58,6 +58,41 @@ BlockPrototype *Block::mutationPrototype()
     return &impl->mutationPrototype;
 }
 
+/*! Returns true if this is a top level reporter block for a variable or a list. */
+bool Block::isTopLevelReporter() const
+{
+    return impl->isTopLevelReporter;
+}
+
+/*!
+ * Sets whether this block is a top level reporter block for a variable or a list.
+ * \note Setting this to true will allow the use topLevelReporterInfo().
+ */
+void Block::setIsTopLevelReporter(bool isTopLevelReporter)
+{
+    impl->isTopLevelReporter = isTopLevelReporter;
+
+    if (isTopLevelReporter && !impl->topLevelReporterInfo)
+        impl->topLevelReporterInfo = std::make_unique<InputValue>(InputValue::Type::Variable);
+    else if (impl->topLevelReporterInfo) {
+        impl->topLevelReporterInfo.reset();
+        impl->topLevelReporterInfo = nullptr;
+    }
+}
+
+/*!
+ * Returns the information about this top level reporter block (if this is a top level reporter block).
+ * \note This function will return nullptr if this isn't a top level reporter block. Use setIsTopLevelReporter(true)
+ * before using this function.
+ */
+InputValue *Block::topLevelReporterInfo()
+{
+    if (impl->topLevelReporterInfo)
+        return impl->topLevelReporterInfo.get();
+    else
+        return nullptr;
+}
+
 /*! Returns the next block. */
 std::shared_ptr<Block> Block::next() const
 {

src/scratch/block_p.h

@@ -3,6 +3,7 @@
 #pragma once
 
 #include <scratchcpp/blockprototype.h>
+#include <scratchcpp/inputvalue.h>
 
 namespace libscratchcpp
 {
@@ -33,6 +34,8 @@ struct BlockPrivate
         Target *target = nullptr;
         BlockPrototype mutationPrototype;
         bool mutationHasNext = true;
+        bool isTopLevelReporter = false;
+        std::unique_ptr<InputValue> topLevelReporterInfo = nullptr;
 };
 
 } // namespace libscratchcpp

test/scratch_classes/block_test.cpp

@@ -241,3 +241,20 @@ TEST_F(BlockTest, MutationPrototype)
     Block block("", "");
     ASSERT_TRUE(block.mutationPrototype());
 }
+
+TEST_F(BlockTest, TopLevelReporter)
+{
+    Block block("", "");
+    ASSERT_FALSE(block.isTopLevelReporter());
+    ASSERT_EQ(block.topLevelReporterInfo(), nullptr);
+
+    for (int i = 0; i < 2; i++) {
+        block.setIsTopLevelReporter(true);
+        ASSERT_TRUE(block.isTopLevelReporter());
+        ASSERT_TRUE(block.topLevelReporterInfo());
+
+        block.setIsTopLevelReporter(false);
+        ASSERT_FALSE(block.isTopLevelReporter());
+        ASSERT_EQ(block.topLevelReporterInfo(), nullptr);
+    }
+}