Add comment API to Target

Author: adazem009

include/scratchcpp/target.h

@@ -14,6 +14,7 @@ class IEngine;
 class Variable;
 class List;
 class Block;
+class Comment;
 class Costume;
 class Sound;
 class TargetPrivate;
@@ -50,6 +51,11 @@ class LIBSCRATCHCPP_EXPORT Target
         int findBlock(const std::string &id) const;
         std::vector<std::shared_ptr<Block>> greenFlagBlocks() const;
 
+        const std::vector<std::shared_ptr<Comment>> &comments() const;
+        int addComment(std::shared_ptr<Comment> comment);
+        std::shared_ptr<Comment> commentAt(int index) const;
+        int findComment(const std::string &id) const;
+
         int costumeIndex() const;
         void setCostumeIndex(int newCostumeIndex);
 
@@ -75,7 +81,7 @@ class LIBSCRATCHCPP_EXPORT Target
         void setEngine(IEngine *engine);
 
     protected:
-        /*! Override this method to set a custom data source for blocks and assets. */
+        /*! Override this method to set a custom data source for blocks, assets, comments, etc. */
         virtual Target *dataSource() const { return nullptr; }
 
     private:

src/scratch/target.cpp

@@ -4,6 +4,7 @@
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
 #include <scratchcpp/block.h>
+#include <scratchcpp/comment.h>
 #include <scratchcpp/iengine.h>
 
 #include "target_p.h"
@@ -199,6 +200,60 @@ std::vector<std::shared_ptr<Block>> Target::greenFlagBlocks() const
     return ret;
 }
 
+/*! Returns the list of comments in the code area. */
+const std::vector<std::shared_ptr<Comment>> &Target::comments() const
+{
+    if (Target *source = dataSource())
+        return source->comments();
+
+    return impl->comments;
+}
+
+/*! Adds a comment and returns its index. */
+int Target::addComment(std::shared_ptr<Comment> comment)
+{
+    if (Target *source = dataSource())
+        return source->addComment(comment);
+
+    auto it = std::find(impl->comments.begin(), impl->comments.end(), comment);
+
+    if (it != impl->comments.end())
+        return it - impl->comments.begin();
+
+    impl->comments.push_back(comment);
+    return impl->comments.size() - 1;
+}
+
+/*! Returns the comment at index. */
+std::shared_ptr<Comment> Target::commentAt(int index) const
+{
+    if (Target *source = dataSource())
+        return source->commentAt(index);
+
+    if (index < 0 || index >= impl->comments.size())
+        return nullptr;
+
+    return impl->comments[index];
+}
+
+/*! Returns the index of the comment with the given ID. */
+int Target::findComment(const std::string &id) const
+{
+    if (Target *source = dataSource())
+        return source->findComment(id);
+
+    int i = 0;
+
+    for (auto comment : impl->comments) {
+        if (comment->id() == id)
+            return i;
+
+        i++;
+    }
+
+    return -1;
+}
+
 /*! Returns the index of the current costume. */
 int Target::costumeIndex() const
 {

src/scratch/target_p.h

@@ -15,6 +15,7 @@ class IEngine;
 class Variable;
 class List;
 class Block;
+class Comment;
 
 struct TargetPrivate
 {
@@ -26,6 +27,7 @@ struct TargetPrivate
         std::vector<std::shared_ptr<Variable>> variables;
         std::vector<std::shared_ptr<List>> lists;
         std::vector<std::shared_ptr<Block>> blocks;
+        std::vector<std::shared_ptr<Comment>> comments;
         int costumeIndex = -1;
         std::vector<std::shared_ptr<Costume>> costumes;
         std::vector<std::shared_ptr<Sound>> sounds;

test/scratch_classes/target_test.cpp

@@ -2,6 +2,7 @@
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
 #include <scratchcpp/block.h>
+#include <scratchcpp/comment.h>
 #include <scratchcpp/costume.h>
 #include <scratchcpp/sound.h>
 #include <enginemock.h>
@@ -183,6 +184,89 @@ TEST(TargetTest, Blocks)
     ASSERT_EQ(source.greenFlagBlocks(), std::vector<std::shared_ptr<Block>>({ b1, b4 }));
 }
 
+TEST(TargetTest, Comments)
+{
+    auto c1 = std::make_shared<Comment>("a");
+    auto c2 = std::make_shared<Comment>("b");
+    auto c3 = std::make_shared<Comment>("c");
+    auto c4 = std::make_shared<Comment>("d");
+
+    TargetMock target;
+    EXPECT_CALL(target, dataSource()).Times(17).WillRepeatedly(Return(nullptr));
+
+    ASSERT_EQ(target.addComment(c1), 0);
+    ASSERT_EQ(target.addComment(c2), 1);
+    ASSERT_EQ(target.addComment(c3), 2);
+    ASSERT_EQ(target.addComment(c4), 3);
+    ASSERT_EQ(target.addComment(c2), 1); // add existing block
+
+    ASSERT_EQ(target.comments(), std::vector<std::shared_ptr<Comment>>({ c1, c2, c3, c4 }));
+    ASSERT_EQ(target.commentAt(0), c1);
+    ASSERT_EQ(target.commentAt(1), c2);
+    ASSERT_EQ(target.commentAt(2), c3);
+    ASSERT_EQ(target.commentAt(3), c4);
+    ASSERT_EQ(target.commentAt(4), nullptr);
+    ASSERT_EQ(target.commentAt(-1), nullptr);
+
+    ASSERT_EQ(target.findComment("e"), -1);
+    ASSERT_EQ(target.findComment("a"), 0);
+    ASSERT_EQ(target.findComment("b"), 1);
+    ASSERT_EQ(target.findComment("c"), 2);
+    ASSERT_EQ(target.findComment("d"), 3);
+
+    // Test with custom data source
+    Target source;
+
+    EXPECT_CALL(target, dataSource()).WillOnce(Return(&source));
+
+    ASSERT_TRUE(target.comments().empty());
+
+    TargetMock target2;
+    EXPECT_CALL(target2, dataSource()).Times(17).WillRepeatedly(Return(&source));
+
+    ASSERT_EQ(target2.addComment(c1), 0);
+    ASSERT_EQ(target2.addComment(c2), 1);
+    ASSERT_EQ(target2.addComment(c3), 2);
+    ASSERT_EQ(target2.addComment(c4), 3);
+    ASSERT_EQ(target2.addComment(c2), 1); // add existing block
+
+    ASSERT_EQ(target2.commentAt(0), c1);
+    ASSERT_EQ(target2.commentAt(1), c2);
+    ASSERT_EQ(target2.commentAt(2), c3);
+    ASSERT_EQ(target2.commentAt(3), c4);
+    ASSERT_EQ(target2.commentAt(4), nullptr);
+    ASSERT_EQ(target2.commentAt(-1), nullptr);
+
+    ASSERT_EQ(target2.findComment("e"), -1);
+    ASSERT_EQ(target2.findComment("a"), 0);
+    ASSERT_EQ(target2.findComment("b"), 1);
+    ASSERT_EQ(target2.findComment("c"), 2);
+    ASSERT_EQ(target2.findComment("d"), 3);
+
+    ASSERT_EQ(target2.comments(), source.comments());
+
+    auto c5 = std::make_shared<Comment>("e");
+    ASSERT_EQ(source.addComment(c5), 4);
+
+    EXPECT_CALL(target2, dataSource()).WillOnce(Return(&source));
+    ASSERT_EQ(target2.comments(), source.comments());
+
+    ASSERT_EQ(source.commentAt(0), c1);
+    ASSERT_EQ(source.commentAt(1), c2);
+    ASSERT_EQ(source.commentAt(2), c3);
+    ASSERT_EQ(source.commentAt(3), c4);
+    ASSERT_EQ(source.commentAt(4), c5);
+    ASSERT_EQ(source.commentAt(5), nullptr);
+    ASSERT_EQ(source.commentAt(-1), nullptr);
+
+    ASSERT_EQ(source.findComment("f"), -1);
+    ASSERT_EQ(source.findComment("a"), 0);
+    ASSERT_EQ(source.findComment("b"), 1);
+    ASSERT_EQ(source.findComment("c"), 2);
+    ASSERT_EQ(source.findComment("d"), 3);
+    ASSERT_EQ(source.findComment("e"), 4);
+}
+
 TEST(TargetTest, CostumeIndex)
 {
     Target target;