Add BlockPrototype class

Author: adazem009

src/scratch/CMakeLists.txt

@@ -5,6 +5,7 @@ target_sources(scratchcpp
     value.cpp
     list.cpp
     block.cpp
+    blockprototype.cpp
     input.cpp
     inputvalue.cpp
     field.cpp
@@ -21,6 +22,7 @@ target_sources(scratchcpp
     value.h
     list.h
     block.h
+    blockprototype.h
     input.h
     inputvalue.h
     field.h

src/scratch/blockprototype.cpp

@@ -0,0 +1,100 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "blockprototype.h"
+
+using namespace libscratchcpp;
+
+/*! Constructs BlockPrototype. */
+BlockPrototype::BlockPrototype()
+{
+}
+
+/*! Constructs BlockPrototype. */
+BlockPrototype::BlockPrototype(const std::string &procCode)
+{
+    setProcCode(procCode);
+}
+
+/*! Returns the name of the custom block, including inputs. */
+const std::string &BlockPrototype::procCode() const
+{
+    return m_procCode;
+}
+
+/*! Sets the name of the custom block, including inputs. */
+void BlockPrototype::setProcCode(const std::string &newProcCode)
+{
+    m_procCode = newProcCode;
+    m_argumentDefaults.clear();
+    m_argumentTypes.clear();
+    bool arg = false;
+
+    for (auto c : m_procCode) {
+        if (c == '%')
+            arg = true;
+        else if (arg) {
+            switch (c) {
+                case 's':
+                    m_argumentDefaults.push_back("");
+                    m_argumentTypes.push_back(ArgType::StringNum);
+                    break;
+
+                case 'b':
+                    m_argumentDefaults.push_back(false);
+                    m_argumentTypes.push_back(ArgType::Bool);
+                    break;
+
+                default:
+                    break;
+            }
+        }
+    }
+}
+
+/*! Returns the list of argument IDs. */
+const std::vector<std::string> &BlockPrototype::argumentIds() const
+{
+    return m_argumentIds;
+}
+
+/*! Sets the list of argument IDs. */
+void BlockPrototype::setArgumentIds(const std::vector<std::string> &newArgumentIds)
+{
+    m_argumentIds = newArgumentIds;
+}
+
+/*! Returns the list of argument names. */
+const std::vector<std::string> &BlockPrototype::argumentNames() const
+{
+    return m_argumentNames;
+}
+
+/*! Sets the list of argument names. */
+void BlockPrototype::setArgumentNames(const std::vector<std::string> &newArgumentNames)
+{
+    m_argumentNames = newArgumentNames;
+}
+
+/*! Returns the list of argument default values. */
+const std::vector<Value> &BlockPrototype::argumentDefaults() const
+{
+    return m_argumentDefaults;
+}
+
+/*! Returns the list of argument types. */
+const std::vector<BlockPrototype::ArgType> &BlockPrototype::argumentTypes() const
+{
+    return m_argumentTypes;
+}
+
+/*! Returns true if the block is set to run without screen refresh. */
+bool BlockPrototype::warp() const
+{
+    return m_warp;
+}
+
+/*! Sets whether to run the block without screen refresh. */
+void BlockPrototype::setWarp(bool newWarp)
+{
+    m_warp = newWarp;
+}

src/scratch/blockprototype.h

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "value.h"
+#include <vector>
+
+namespace libscratchcpp
+{
+
+/*! \brief The BlockPrototype class represents the prototype of a custom block. */
+class LIBSCRATCHCPP_EXPORT BlockPrototype
+{
+    public:
+        enum class ArgType
+        {
+            StringNum,
+            Bool
+        };
+
+        BlockPrototype();
+        BlockPrototype(const std::string &procCode);
+
+        const std::string &procCode() const;
+        void setProcCode(const std::string &newProcCode);
+
+        const std::vector<std::string> &argumentIds() const;
+        void setArgumentIds(const std::vector<std::string> &newArgumentIds);
+
+        const std::vector<std::string> &argumentNames() const;
+        void setArgumentNames(const std::vector<std::string> &newArgumentNames);
+
+        const std::vector<Value> &argumentDefaults() const;
+
+        const std::vector<ArgType> &argumentTypes() const;
+
+        bool warp() const;
+        void setWarp(bool newWarp);
+
+    private:
+        std::string m_procCode;
+        std::vector<std::string> m_argumentIds;
+        std::vector<std::string> m_argumentNames;
+        std::vector<Value> m_argumentDefaults;
+        std::vector<ArgType> m_argumentTypes;
+        bool m_warp = false;
+};
+
+} // namespace libscratchcpp