Merge pull request #350 from scratchcpp/comments

Add comment API

Author: adazem009

CMakeLists.txt

@@ -52,6 +52,7 @@ target_sources(scratchcpp
     include/scratchcpp/iimageformatfactory.h
     include/scratchcpp/rect.h
     include/scratchcpp/igraphicseffect.h
+    include/scratchcpp/comment.h
 )
 
 add_library(zip SHARED

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;
 

include/scratchcpp/comment.h

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+#pragma once
+
+#include "entity.h"
+
+namespace libscratchcpp
+{
+
+class Block;
+class CommentPrivate;
+
+/*! \brief The Comment class represents a comment in the code area. */
+class LIBSCRATCHCPP_EXPORT Comment : public Entity
+{
+    public:
+        Comment(const std::string &id, double x = 0, double y = 0);
+        Comment(const Comment &) = delete;
+
+        const std::string &blockId() const;
+        void setBlockId(const std::string id);
+
+        std::shared_ptr<Block> block() const;
+        void setBlock(std::shared_ptr<Block> block);
+
+        double x() const;
+        void setX(double x);
+
+        double y() const;
+        void setY(double y);
+
+        double width() const;
+        void setWidth(double width);
+
+        double height() const;
+        void setHeight(double height);
+
+        bool minimized() const;
+        void setMinimized(bool minimized);
+
+        const std::string &text() const;
+        void setText(const std::string &text);
+
+    private:
+        spimpl::unique_impl_ptr<CommentPrivate> impl;
+};
+
+} // namespace libscratchcpp

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/engine/internal/engine.cpp

@@ -13,6 +13,7 @@
 #include <scratchcpp/block.h>
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
+#include <scratchcpp/comment.h>
 #include <scratchcpp/costume.h>
 #include <scratchcpp/keyevent.h>
 #include <cassert>
@@ -84,6 +85,14 @@ void Engine::resolveIds()
 
             block->updateInputMap();
             block->updateFieldMap();
+
+            auto comment = getComment(block->commentId());
+            block->setComment(comment);
+
+            if (comment) {
+                comment->setBlock(block);
+                assert(comment->blockId() == block->id());
+            }
         }
     }
 }
@@ -1078,6 +1087,21 @@ std::shared_ptr<Broadcast> Engine::getBroadcast(const std::string &id)
     return nullptr;
 }
 
+// Returns the comment with the given ID.
+std::shared_ptr<Comment> Engine::getComment(const std::string &id)
+{
+    if (id.empty())
+        return nullptr;
+
+    for (auto target : m_targets) {
+        int index = target->findComment(id);
+        if (index != -1)
+            return target->commentAt(index);
+    }
+
+    return nullptr;
+}
+
 // Returns the entity with the given ID. \see IEntity
 std::shared_ptr<Entity> Engine::getEntity(const std::string &id)
 {

src/engine/internal/engine.h

@@ -143,6 +143,7 @@ class Engine : public IEngine
         std::shared_ptr<Variable> getVariable(const std::string &id);
         std::shared_ptr<List> getList(const std::string &id);
         std::shared_ptr<Broadcast> getBroadcast(const std::string &id);
+        std::shared_ptr<Comment> getComment(const std::string &id);
         std::shared_ptr<Entity> getEntity(const std::string &id);
         std::shared_ptr<IBlockSection> blockSection(const std::string &opcode) const;
 

src/internal/scratch3reader.cpp

@@ -8,6 +8,7 @@
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
 #include <scratchcpp/costume.h>
+#include <scratchcpp/comment.h>
 #include <scratchcpp/sound.h>
 #include <scratchcpp/stage.h>
 #include <scratchcpp/sprite.h>
@@ -188,10 +189,37 @@ bool Scratch3Reader::load()
                 READER_STEP(step, "target -> block -> shadow");
                 block->setShadow(blockInfo["shadow"]);
 
+                // comment
+                READER_STEP(step, "target -> block -> comment");
+                if (!blockInfo["comment"].is_null())
+                    block->setCommentId(blockInfo["comment"]);
+
                 target->addBlock(block);
             }
 
-            // TODO: Add comments
+            // comments
+            READER_STEP(step, "target -> comments");
+            auto comments = jsonTarget["comments"];
+            for (json::iterator it = comments.begin(); it != comments.end(); ++it) {
+                auto commentInfo = it.value();
+                READER_STEP(step, "target -> comment -> { id, x, y }");
+                auto comment = std::make_shared<Comment>(it.key(), jsonToValue(commentInfo["x"]).toDouble(), jsonToValue(commentInfo["y"]).toDouble());
+                READER_STEP(step, "target -> comment -> blockId");
+
+                if (!commentInfo["blockId"].is_null())
+                    comment->setBlockId(commentInfo["blockId"]);
+
+                READER_STEP(step, "target -> comment -> width");
+                comment->setWidth(jsonToValue(commentInfo["width"]).toDouble());
+                READER_STEP(step, "target -> comment -> height");
+                comment->setHeight(jsonToValue(commentInfo["height"]).toDouble());
+                READER_STEP(step, "target -> comment -> minimized");
+                comment->setMinimized(commentInfo["minimized"]);
+                READER_STEP(step, "target -> comment -> text");
+                comment->setText(commentInfo["text"]);
+
+                target->addComment(comment);
+            }
 
             // costumes
             READER_STEP(step, "target -> costumes");

src/scratch/CMakeLists.txt

@@ -48,4 +48,7 @@ target_sources(scratchcpp
     keyevent.cpp
     keyevent_p.cpp
     keyevent_p.h
+    comment.cpp
+    comment_p.cpp
+    comment_p.h
 )

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;