Add TextBubble class

Author: adazem009

CMakeLists.txt

@@ -55,6 +55,7 @@ target_sources(scratchcpp
     include/scratchcpp/target.h
     include/scratchcpp/stage.h
     include/scratchcpp/sprite.h
+    include/scratchcpp/textbubble.h
     include/scratchcpp/itimer.h
     include/scratchcpp/keyevent.h
     include/scratchcpp/rect.h

include/scratchcpp/textbubble.h

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "drawable.h"
+#include "signal.h"
+
+namespace libscratchcpp
+{
+
+class TextBubblePrivate;
+
+/*! \brief The TextBubble class represents a text bubble created using say or think block. */
+class TextBubble : public Drawable
+{
+    public:
+        enum class Type
+        {
+            Say,
+            Think
+        };
+
+        TextBubble();
+        TextBubble(const TextBubble &) = delete;
+
+        Type type() const;
+        virtual void setType(Type type);
+        sigslot::signal<Type> &typeChanged() const;
+
+        const std::string &text() const;
+        virtual void setText(const std::string &text);
+        sigslot::signal<const std::string &> &textChanged() const;
+
+    private:
+        spimpl::unique_impl_ptr<TextBubblePrivate> impl;
+};
+
+} // namespace libscratchcpp

src/scratch/CMakeLists.txt

@@ -44,6 +44,9 @@ target_sources(scratchcpp
     sprite.cpp
     sprite_p.cpp
     sprite_p.h
+    textbubble.cpp
+    textbubble_p.cpp
+    textbubble_p.h
     broadcast.cpp
     broadcast_p.cpp
     broadcast_p.h

src/scratch/textbubble.cpp

@@ -0,0 +1,73 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <scratchcpp/textbubble.h>
+#include <scratchcpp/value.h>
+
+#include "textbubble_p.h"
+
+using namespace libscratchcpp;
+
+TextBubble::TextBubble() :
+    Drawable(),
+    impl(spimpl::make_unique_impl<TextBubblePrivate>())
+{
+}
+
+/*! Returns the type of the TextBubble (say or think). */
+TextBubble::Type TextBubble::type() const
+{
+    return impl->type;
+}
+
+/*! Sets the type of the TextBubble (say or think). */
+void TextBubble::setType(Type type)
+{
+    impl->type = type;
+    impl->typeChanged(type);
+}
+
+/*! Emits when the type changes. */
+sigslot::signal<TextBubble::Type> &TextBubble::typeChanged() const
+{
+    return impl->typeChanged;
+}
+
+/*!
+ * Returns the text of the TextBubble.
+ * \note If the text is an empty string, the TextBubble is supposed to be hidden.
+ */
+const std::string &TextBubble::text() const
+{
+    return impl->text;
+}
+
+/*!
+ * Sets the text of the TextBubble.
+ * \note If the text is an empty string, the TextBubble is supposed to be hidden.
+ */
+void TextBubble::setText(const std::string &text)
+{
+    // https://github.com/scratchfoundation/scratch-vm/blob/7313ce5199f8a3da7850085d0f7f6a3ca2c89bf6/src/blocks/scratch3_looks.js#L251-L257
+    const Value v(text);
+    std::string converted = text;
+
+    // Non-integers should be rounded to 2 decimal places (no more, no less), unless they're small enough that rounding would display them as 0.00.
+    if (v.isValidNumber()) {
+        const double num = v.toDouble();
+
+        if (std::abs(num) >= 0.01 && (v % 1).toDouble() != 0)
+            converted = Value(std::round(num * 100) / 100).toString();
+    }
+
+    // Limit the length of the string
+    size_t limit = 330;
+    impl->text = converted.substr(0, limit);
+
+    impl->textChanged(impl->text);
+}
+
+/*! Emits when the text changes. */
+sigslot::signal<const std::string &> &TextBubble::textChanged() const
+{
+    return impl->textChanged;
+}

src/scratch/textbubble_p.cpp

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "textbubble_p.h"
+
+using namespace libscratchcpp;

src/scratch/textbubble_p.h

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <scratchcpp/textbubble.h>
+
+namespace libscratchcpp
+{
+
+struct TextBubblePrivate
+{
+        TextBubble::Type type = TextBubble::Type::Say;
+        std::string text;
+        mutable sigslot::signal<TextBubble::Type> typeChanged;
+        mutable sigslot::signal<const std::string &> textChanged;
+};
+
+} // namespace libscratchcpp

test/scratch_classes/CMakeLists.txt

@@ -88,6 +88,20 @@ target_link_libraries(
 
 gtest_discover_tests(target_test)
 
+# textbubble_test
+add_executable(
+  textbubble_test
+  textbubble_test.cpp
+)
+
+target_link_libraries(
+  textbubble_test
+  GTest::gtest_main
+  scratchcpp
+)
+
+gtest_discover_tests(textbubble_test)
+
 # value_test
 add_executable(
   value_test

test/scratch_classes/textbubble_test.cpp

@@ -0,0 +1,80 @@
+#include <scratchcpp/textbubble.h>
+
+#include "../common.h"
+
+using namespace libscratchcpp;
+
+TEST(TextBubbleTest, BubbleType)
+{
+    TextBubble bubble;
+    ASSERT_EQ(bubble.type(), TextBubble::Type::Say);
+
+    bubble.setType(TextBubble::Type::Think);
+    ASSERT_EQ(bubble.type(), TextBubble::Type::Think);
+
+    bubble.setType(TextBubble::Type::Say);
+    ASSERT_EQ(bubble.type(), TextBubble::Type::Say);
+}
+
+TEST(TextBubbleTest, BubbleText)
+{
+    TextBubble bubble;
+    ASSERT_TRUE(bubble.text().empty());
+
+    bubble.setText("hello");
+    ASSERT_EQ(bubble.text(), "hello");
+
+    bubble.setText("world");
+    ASSERT_EQ(bubble.text(), "world");
+
+    // longstr.length = 384, should be limited to 330 in bubble text
+    std::string longstr =
+        "EY8OUNzAqwgh7NRGk5TzCP3dkAhJy9TX"
+        "Y9mqKElPjdQpKddYqjyCwUk2hx6YgVZV"
+        "6BOdmZGxDMs8Hjv8W9G6j4gTxAWdOkzs"
+        "8Ih80xzEDbvLilWsDwoB6FxH2kVVI4xs"
+        "IXOETNQ6QMsCKLWc5XjHk2BS9nYvDGpJ"
+        "uEmp9zIzFGT1kRSrOlU3ZwnN1YtvqFx"
+        "3hkWVNtJ71dQ0PJHhOVQPUy19V01SPu3"
+        "KIIS2wdSUVAc4RYMzepSveghzWbdcizy"
+        "Tm1KKAj4svu9YoL8b9vsolG8gKunvKO7"
+        "MurRKSeUbECELnJEKV6683xCq7RvmjAu"
+        "2djZ54apiQc1lTixWns5GoG0SVNuFzHl"
+        "q97qUiqiMecjVFM51YVif7c1Stip52Hl";
+
+    bubble.setText(longstr);
+    ASSERT_EQ(bubble.text().length(), 330);
+    ASSERT_EQ(bubble.text(), longstr.substr(0, 330));
+
+    // Integers should be left unchanged
+    bubble.setText("8");
+    ASSERT_EQ(bubble.text(), "8");
+
+    bubble.setText("-52");
+    ASSERT_EQ(bubble.text(), "-52");
+
+    bubble.setText("0");
+    ASSERT_EQ(bubble.text(), "0");
+
+    // Non-integers should be rounded to 2 decimal places (no more, no less), unless they're small enough that rounding would display them as 0.00 (#478)
+    bubble.setText("8.324");
+    ASSERT_EQ(bubble.text(), "8.32");
+
+    bubble.setText("-52.576");
+    ASSERT_EQ(bubble.text(), "-52.58");
+
+    bubble.setText("3.5");
+    ASSERT_EQ(bubble.text(), "3.5");
+
+    bubble.setText("0.015");
+    ASSERT_EQ(bubble.text(), "0.02");
+
+    bubble.setText("-0.015");
+    ASSERT_EQ(bubble.text(), "-0.02");
+
+    bubble.setText("0.005");
+    ASSERT_EQ(bubble.text(), "0.005");
+
+    bubble.setText("-0.005");
+    ASSERT_EQ(bubble.text(), "-0.005");
+}