Add comment property to Block

Author: adazem009

include/scratchcpp/block.h

@@ -12,6 +12,7 @@ class IEngine;
 class Target;
 class Input;
 class Field;
+class Comment;
 class InputValue;
 class BlockPrivate;
 
@@ -55,6 +56,11 @@ class LIBSCRATCHCPP_EXPORT Block : public Entity
 
         bool topLevel() const;
 
+        std::shared_ptr<Comment> comment() const;
+        std::string commentId() const;
+        void setComment(std::shared_ptr<Comment> comment);
+        void setCommentId(const std::string &commentId);
+
         void setEngine(IEngine *newEngine);
         IEngine *engine() const;
 

src/scratch/block.cpp

@@ -3,6 +3,7 @@
 #include <scratchcpp/block.h>
 #include <scratchcpp/input.h>
 #include <scratchcpp/field.h>
+#include <scratchcpp/comment.h>
 
 #include "block_p.h"
 
@@ -295,6 +296,36 @@ bool Block::topLevel() const
     return (impl->parentId == "" && !impl->parent);
 }
 
+/*! Returns the comment which is attached to this block. */
+std::shared_ptr<Comment> Block::comment() const
+{
+    return impl->comment;
+}
+
+/*! Returns the ID of the comment which is attached to this block. */
+std::string Block::commentId() const
+{
+    return impl->commentId;
+}
+
+/*! Sets the comment which is attached to this block. */
+void Block::setComment(std::shared_ptr<Comment> comment)
+{
+    impl->comment = comment;
+
+    if (comment)
+        impl->commentId = comment->id();
+    else
+        impl->commentId = "";
+}
+
+/*! Sets the ID of the comment which is attached to this block. */
+void Block::setCommentId(const std::string &commentId)
+{
+    impl->commentId = commentId;
+    impl->comment = nullptr;
+}
+
 /*! Sets the Engine. */
 void Block::setEngine(IEngine *newEngine)
 {

src/scratch/block_p.h

@@ -14,6 +14,7 @@ class IEngine;
 class Target;
 class Input;
 class Field;
+class Comment;
 
 struct BlockPrivate
 {
@@ -31,6 +32,8 @@ struct BlockPrivate
         std::vector<std::shared_ptr<Field>> fields;
         std::unordered_map<int, Field *> fieldMap;
         bool shadow = false;
+        std::string commentId;
+        std::shared_ptr<Comment> comment = nullptr;
         IEngine *engine = nullptr;
         Target *target = nullptr;
         BlockPrototype mutationPrototype;

test/scratch_classes/block_test.cpp

@@ -1,6 +1,7 @@
 #include <scratchcpp/block.h>
 #include <scratchcpp/input.h>
 #include <scratchcpp/field.h>
+#include <scratchcpp/comment.h>
 #include <scratchcpp/target.h>
 #include <scratchcpp/compiler.h>
 #include <enginemock.h>
@@ -193,6 +194,30 @@ TEST_F(BlockTest, TopLevel)
     ASSERT_TRUE(block.topLevel());
 }
 
+TEST_F(BlockTest, Comment)
+{
+    Block block("", "");
+    ASSERT_EQ(block.comment(), nullptr);
+    ASSERT_TRUE(block.commentId().empty());
+
+    block.setCommentId("hello");
+    ASSERT_EQ(block.comment(), nullptr);
+    ASSERT_EQ(block.commentId(), "hello");
+
+    auto comment = std::make_shared<Comment>("abc");
+    block.setComment(comment);
+    ASSERT_EQ(block.comment(), comment);
+    ASSERT_EQ(block.commentId(), "abc");
+
+    block.setCommentId("def");
+    ASSERT_EQ(block.comment(), nullptr);
+    ASSERT_EQ(block.commentId(), "def");
+
+    block.setComment(nullptr);
+    ASSERT_EQ(block.comment(), nullptr);
+    ASSERT_EQ(block.commentId(), "");
+}
+
 TEST_F(BlockTest, Engine)
 {
     Block block("", "");