Add API for dropdown menus

Author: adazem009

include/scratchcpp/input.h

@@ -45,6 +45,9 @@ class LIBSCRATCHCPP_EXPORT Input
         void setValueBlock(std::shared_ptr<Block> block);
         void setValueBlockId(const std::string &id);
 
+        bool pointsToDropdownMenu() const;
+        std::string selectedMenuItem() const;
+
     private:
         spimpl::unique_impl_ptr<InputPrivate> impl;
 };

src/scratch/input.cpp

@@ -2,6 +2,7 @@
 
 #include <iostream>
 #include <scratchcpp/input.h>
+#include <scratchcpp/field.h>
 #include <scratchcpp/variable.h>
 #include <scratchcpp/block.h>
 
@@ -94,3 +95,35 @@ void Input::setValueBlockId(const std::string &id)
     impl->primaryValue.setValueBlock(nullptr);
     impl->primaryValue.setValueBlockId(id);
 }
+
+/*!
+ * Returns true if the input points to a dropdown menu.\n
+ * (if type() == Type::Shadow and valueBlock() points to a block with a single field which does not point to an entity)
+ */
+bool Input::pointsToDropdownMenu() const
+{
+    auto block = valueBlock();
+
+    if ((impl->type != Type::Shadow) || !block)
+        return false;
+
+    const auto &fields = block->fields();
+
+    if (fields.size() != 1)
+        return false;
+
+    auto field = fields[0];
+    return (field && !field->valuePtr() && (field->valueId() == ""));
+}
+
+/*!
+ * Returns the selected item in the dropdown menu.\n
+ * Works only pointsToDropdownMenu() is true.
+ */
+std::string Input::selectedMenuItem() const
+{
+    if (!pointsToDropdownMenu())
+        return "";
+
+    return valueBlock()->fieldAt(0)->value().toString();
+}

test/scratch_classes/input_test.cpp

@@ -1,6 +1,8 @@
 #include <scratchcpp/input.h>
 #include <scratchcpp/inputvalue.h>
+#include <scratchcpp/field.h>
 #include <scratchcpp/block.h>
+#include <scratchcpp/variable.h>
 
 #include "../common.h"
 
@@ -64,3 +66,75 @@ TEST(InputTest, ValueBlock)
     ASSERT_EQ(input.valueBlock(), nullptr);
     ASSERT_EQ(input.valueBlockId(), "");
 }
+
+TEST(InputTest, SelectedMenuItem)
+{
+    // Test with Shadow type
+    Input input1("", Input::Type::Shadow);
+    ASSERT_FALSE(input1.pointsToDropdownMenu());
+    ASSERT_TRUE(input1.selectedMenuItem().empty());
+
+    auto block1 = std::make_shared<Block>("abc", "");
+    input1.setValueBlock(block1);
+    ASSERT_FALSE(input1.pointsToDropdownMenu());
+    ASSERT_TRUE(input1.selectedMenuItem().empty());
+
+    auto field1 = std::make_shared<Field>("OPTION1", "");
+    block1->addField(field1);
+    ASSERT_TRUE(input1.pointsToDropdownMenu());
+    ASSERT_TRUE(input1.selectedMenuItem().empty());
+
+    auto field2 = std::make_shared<Field>("OPTION2", "something");
+    block1->addField(field2);
+    ASSERT_FALSE(input1.pointsToDropdownMenu());
+    ASSERT_TRUE(input1.selectedMenuItem().empty());
+
+    auto block2 = std::make_shared<Block>("def", "");
+    input1.setValueBlock(block2);
+
+    field1 = std::make_shared<Field>("OPTION1", "something");
+    block2->addField(field1);
+    ASSERT_TRUE(input1.pointsToDropdownMenu());
+    ASSERT_EQ(input1.selectedMenuItem(), "something");
+
+    auto variable = std::make_shared<Variable>("", "");
+    field1->setValuePtr(variable);
+    ASSERT_FALSE(input1.pointsToDropdownMenu());
+    ASSERT_TRUE(input1.selectedMenuItem().empty());
+
+    field1->setValuePtr(nullptr);
+    ASSERT_TRUE(input1.pointsToDropdownMenu());
+    ASSERT_EQ(input1.selectedMenuItem(), "something");
+
+    field2 = std::make_shared<Field>("OPTION2", "hello");
+    block2->addField(field2);
+    ASSERT_FALSE(input1.pointsToDropdownMenu());
+    ASSERT_TRUE(input1.selectedMenuItem().empty());
+
+    // Test with NoShadow type
+    Input input2("", Input::Type::NoShadow);
+    ASSERT_FALSE(input2.pointsToDropdownMenu());
+    ASSERT_TRUE(input2.selectedMenuItem().empty());
+
+    auto block3 = std::make_shared<Block>("ghi", "");
+    input2.setValueBlock(block3);
+    ASSERT_FALSE(input2.pointsToDropdownMenu());
+    ASSERT_TRUE(input2.selectedMenuItem().empty());
+
+    block3->addField(field1);
+    ASSERT_FALSE(input2.pointsToDropdownMenu());
+    ASSERT_TRUE(input2.selectedMenuItem().empty());
+
+    // Test with ObscuredShadow type
+    Input input3("", Input::Type::ObscuredShadow);
+    ASSERT_FALSE(input3.pointsToDropdownMenu());
+    ASSERT_TRUE(input3.selectedMenuItem().empty());
+
+    input3.setValueBlock(block3);
+    ASSERT_FALSE(input3.pointsToDropdownMenu());
+    ASSERT_TRUE(input3.selectedMenuItem().empty());
+
+    block3->addField(field1);
+    ASSERT_FALSE(input3.pointsToDropdownMenu());
+    ASSERT_TRUE(input3.selectedMenuItem().empty());
+}