Implement data_listcontents block

Author: adazem009

src/blocks/listblocks.cpp

@@ -21,6 +21,7 @@ bool ListBlocks::categoryVisible() const
 void ListBlocks::registerBlocks(IEngine *engine)
 {
     // Blocks
+    engine->addCompileFunction(this, "data_listcontents", &compileListContents);
     engine->addCompileFunction(this, "data_addtolist", &compileAddToList);
     engine->addCompileFunction(this, "data_deleteoflist", &compileDeleteFromList);
     engine->addCompileFunction(this, "data_deletealloflist", &compileDeleteAllOfList);
@@ -39,6 +40,14 @@ void ListBlocks::registerBlocks(IEngine *engine)
     engine->addField(this, "LIST", LIST);
 }
 
+void ListBlocks::compileListContents(Compiler *compiler)
+{
+    // NOTE: This block is only used by list monitors
+    // Instead of returning the actual list contents, let's just return the index of the list
+    // and let the renderer read the list using the index
+    compiler->addConstValue(static_cast<size_t>(compiler->listIndex(compiler->field(LIST)->valuePtr())));
+}
+
 void ListBlocks::compileAddToList(Compiler *compiler)
 {
     compiler->addInput(ITEM);

src/blocks/listblocks.h

@@ -29,6 +29,7 @@ class ListBlocks : public IBlockSection
 
         void registerBlocks(IEngine *engine) override;
 
+        static void compileListContents(Compiler *compiler);
         static void compileAddToList(Compiler *compiler);
         static void compileDeleteFromList(Compiler *compiler);
         static void compileDeleteAllOfList(Compiler *compiler);

test/blocks/list_blocks_test.cpp

@@ -94,6 +94,7 @@ TEST_F(ListBlocksTest, CategoryVisible)
 TEST_F(ListBlocksTest, RegisterBlocks)
 {
     // Blocks
+    EXPECT_CALL(m_engineMock, addCompileFunction(m_section.get(), "data_listcontents", &ListBlocks::compileListContents)).Times(1);
     EXPECT_CALL(m_engineMock, addCompileFunction(m_section.get(), "data_addtolist", &ListBlocks::compileAddToList)).Times(1);
     EXPECT_CALL(m_engineMock, addCompileFunction(m_section.get(), "data_deleteoflist", &ListBlocks::compileDeleteFromList)).Times(1);
     EXPECT_CALL(m_engineMock, addCompileFunction(m_section.get(), "data_deletealloflist", &ListBlocks::compileDeleteAllOfList)).Times(1);
@@ -114,6 +115,36 @@ TEST_F(ListBlocksTest, RegisterBlocks)
     m_section->registerBlocks(&m_engineMock);
 }
 
+TEST_F(ListBlocksTest, ListContents)
+{
+    Compiler compiler(&m_engine);
+
+    // [list1]
+    auto list1 = std::make_shared<List>("b", "list1");
+    auto block1 = createListBlock("a", "data_listcontents", list1);
+
+    // [list2]
+    auto list2 = std::make_shared<List>("d", "list2");
+    auto block2 = createListBlock("c", "data_listcontents", list2);
+
+    compiler.init();
+    compiler.setBlock(block1);
+    ListBlocks::compileListContents(&compiler);
+    compiler.setBlock(block2);
+    ListBlocks::compileListContents(&compiler);
+    compiler.end();
+
+    ASSERT_EQ(compiler.bytecode(), std::vector<unsigned int>({ vm::OP_START, vm::OP_CONST, 0, vm::OP_CONST, 1, vm::OP_HALT }));
+    ASSERT_EQ(compiler.constValues(), std::vector<Value>({ 0, 1 }));
+    ASSERT_TRUE(compiler.variables().empty());
+    ASSERT_EQ(
+        compiler.lists(),
+        std::vector<List *>({
+            list1.get(),
+            list2.get(),
+        }));
+}
+
 TEST_F(ListBlocksTest, AddToList)
 {
     Compiler compiler(&m_engine);