Add Comment class

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/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

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/comment.cpp

@@ -0,0 +1,117 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+#include <scratchcpp/comment.h>
+#include <scratchcpp/block.h>
+
+#include "comment_p.h"
+
+using namespace libscratchcpp;
+
+/*! Constructs Comment at the given position in the code area. */
+Comment::Comment(const std::string &id, double x, double y) :
+    Entity(id),
+    impl(spimpl::make_unique_impl<CommentPrivate>(x, y))
+{
+}
+
+/*! Returns the ID of the block the comment is attached to. */
+const std::string &Comment::blockId() const
+{
+    return impl->blockId;
+}
+
+/*! Sets the ID of the block the comment is attached to. */
+void Comment::setBlockId(const std::string id)
+{
+    impl->blockId = id;
+    impl->block = nullptr;
+}
+
+/*! Returns the block the comment is attached to. */
+std::shared_ptr<Block> Comment::block() const
+{
+    return impl->block;
+}
+
+/*! Sets the block the comment is attached to. */
+void Comment::setBlock(std::shared_ptr<Block> block)
+{
+    impl->block = block;
+
+    if (block)
+        impl->blockId = block->id();
+    else
+        impl->blockId = "";
+}
+
+/*! Returns the x-coordinate of the comment in the code area. */
+double Comment::x() const
+{
+    return impl->x;
+}
+
+/*! Sets the x-coordinate of the comment in the code area. */
+void Comment::setX(double x)
+{
+    impl->x = x;
+}
+
+/*! Returns the y-coordinate of the comment in the code area. */
+double Comment::y() const
+{
+    return impl->y;
+}
+
+/*! Sets the x-coordinate of the comment in the code area. */
+void Comment::setY(double y)
+{
+    impl->y = y;
+}
+
+/*! Returns the width. */
+double Comment::width() const
+{
+    return impl->width;
+}
+
+/*! Sets the width. */
+void Comment::setWidth(double width)
+{
+    impl->width = width;
+}
+
+/*! Returns the height. */
+double Comment::height() const
+{
+    return impl->height;
+}
+
+/*! Sets the height. */
+void Comment::setHeight(double height)
+{
+    impl->height = height;
+}
+
+/*! Returns true if the comment is collapsed and false otherwise. */
+bool Comment::minimized() const
+{
+    return impl->minimized;
+}
+
+/*! Sets whether the comment is collapsed. */
+void Comment::setMinimized(bool minimized)
+{
+    impl->minimized = minimized;
+}
+
+/*! Returns the text. */
+const std::string &Comment::text() const
+{
+    return impl->text;
+}
+
+/*! Sets the text. */
+void Comment::setText(const std::string &text)
+{
+    impl->text = text;
+}

src/scratch/comment_p.cpp

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+#include "comment_p.h"
+
+using namespace libscratchcpp;
+
+CommentPrivate::CommentPrivate(double x, double y) :
+    x(x),
+    y(y)
+{
+}

src/scratch/comment_p.h

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+#pragma once
+
+#include <string>
+#include <memory>
+
+namespace libscratchcpp
+{
+
+class Block;
+
+struct CommentPrivate
+{
+        CommentPrivate(double x, double y);
+        CommentPrivate(const CommentPrivate &) = delete;
+
+        std::string blockId;
+        std::shared_ptr<Block> block;
+        double x = 0;
+        double y = 0;
+        double width = 200;
+        double height = 200;
+        bool minimized = false;
+        std::string text;
+};
+
+} // namespace libscratchcpp

test/scratch_classes/CMakeLists.txt

@@ -203,3 +203,17 @@ target_link_libraries(
 )
 
 gtest_discover_tests(keyevent_test)
+
+# comment_test
+add_executable(
+  comment_test
+  comment_test.cpp
+)
+
+target_link_libraries(
+  comment_test
+  GTest::gtest_main
+  scratchcpp
+)
+
+gtest_discover_tests(comment_test)

test/scratch_classes/comment_test.cpp

@@ -0,0 +1,100 @@
+#include <scratchcpp/comment.h>
+#include <scratchcpp/block.h>
+
+#include "../common.h"
+
+using namespace libscratchcpp;
+
+TEST(CommentTest, Constructors)
+{
+    {
+        Comment comment("abc");
+        ASSERT_EQ(comment.id(), "abc");
+        ASSERT_EQ(comment.x(), 0);
+        ASSERT_EQ(comment.y(), 0);
+    }
+
+    {
+        Comment comment("def", 46.09, -64.12);
+        ASSERT_EQ(comment.id(), "def");
+        ASSERT_EQ(comment.x(), 46.09);
+        ASSERT_EQ(comment.y(), -64.12);
+    }
+}
+
+TEST(CommentTest, Block)
+{
+    Comment comment("a");
+    ASSERT_EQ(comment.block(), nullptr);
+    ASSERT_TRUE(comment.blockId().empty());
+
+    auto block = std::make_shared<Block>("abc", "");
+    comment.setBlock(block);
+    ASSERT_EQ(comment.block(), block);
+    ASSERT_EQ(comment.blockId(), "abc");
+
+    comment.setBlock(nullptr);
+    ASSERT_EQ(comment.block(), nullptr);
+    ASSERT_TRUE(comment.blockId().empty());
+
+    comment.setBlockId("hello");
+    ASSERT_EQ(comment.blockId(), "hello");
+    ASSERT_EQ(comment.block(), nullptr);
+}
+
+TEST(CommentTest, X)
+{
+    Comment comment("a");
+    ASSERT_EQ(comment.x(), 0);
+
+    comment.setX(-76.29);
+    ASSERT_EQ(comment.x(), -76.29);
+}
+
+TEST(CommentTest, Y)
+{
+    Comment comment("a");
+    ASSERT_EQ(comment.y(), 0);
+
+    comment.setY(38.16);
+    ASSERT_EQ(comment.y(), 38.16);
+}
+
+TEST(CommentTest, Width)
+{
+    Comment comment("a");
+    ASSERT_EQ(comment.width(), 200);
+
+    comment.setWidth(64.49);
+    ASSERT_EQ(comment.width(), 64.49);
+}
+
+TEST(CommentTest, Height)
+{
+    Comment comment("a");
+    ASSERT_EQ(comment.height(), 200);
+
+    comment.setHeight(-89.65);
+    ASSERT_EQ(comment.height(), -89.65);
+}
+
+TEST(CommentTest, Minimized)
+{
+    Comment comment("a");
+    ASSERT_FALSE(comment.minimized());
+
+    comment.setMinimized(true);
+    ASSERT_TRUE(comment.minimized());
+
+    comment.setMinimized(false);
+    ASSERT_FALSE(comment.minimized());
+}
+
+TEST(CommentTest, Text)
+{
+    Comment comment("a");
+    ASSERT_TRUE(comment.text().empty());
+
+    comment.setText("Hello, world!");
+    ASSERT_EQ(comment.text(), "Hello, world!");
+}