Add (and fix) tests for draw::Painter

src/framework/CMakeLists.txt

@@ -47,6 +47,7 @@ endif(BUILD_MUSESAMPLER_MODULE)
 
 if (BUILD_UNIT_TESTS)
     add_subdirectory(global/tests)
+    add_subdirectory(draw/tests)
     add_subdirectory(mpe/tests)
     add_subdirectory(ui/tests)
     add_subdirectory(accessibility/tests)

src/framework/draw/internal/qpainterprovider.cpp

@@ -45,6 +45,7 @@ QPainterProvider::QPainterProvider(QPainter* painter, bool ownsPainter)
         m_font = Font::fromQFont(m_painter->font());
         m_pen = Pen::fromQPen(m_painter->pen());
         m_brush = Brush::fromQBrush(m_painter->brush());
+        m_transform = Transform::fromQTransform(m_painter->transform());
     }
 }
 
@@ -173,6 +174,7 @@ void QPainterProvider::restore()
     m_font = Font::fromQFont(m_painter->font());
     m_pen = Pen::fromQPen(m_painter->pen());
     m_brush = Brush::fromQBrush(m_painter->brush());
+    m_transform = Transform::fromQTransform(m_painter->transform());
 }
 
 void QPainterProvider::setTransform(const Transform& transform)

src/framework/draw/internal/qpainterprovider.h

@@ -22,7 +22,7 @@
 #ifndef MU_DRAW_QPAINTERPROVIDER_H
 #define MU_DRAW_QPAINTERPROVIDER_H
 
-#include "ipaintprovider.h"
+#include "../ipaintprovider.h"
 
 class QPainter;
 class QImage;

src/framework/draw/tests/CMakeLists.txt

@@ -0,0 +1,30 @@
+# SPDX-License-Identifier: GPL-3.0-only
+# MuseScore-CLA-applies
+#
+# MuseScore
+# Music Composition & Notation
+#
+# Copyright (C) 2022 MuseScore BVBA and others
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+set(MODULE_TEST draw_tests)
+
+set(MODULE_TEST_SRC
+    ${CMAKE_CURRENT_LIST_DIR}/painter_tests.cpp
+)
+
+set(MODULE_TEST_LINK draw)
+
+include(${PROJECT_SOURCE_DIR}/src/framework/testing/gtest.cmake)
+

src/framework/draw/tests/painter_tests.cpp

@@ -0,0 +1,158 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-CLA-applies
+ *
+ * MuseScore
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2022 MuseScore BVBA and others
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+#include <gtest/gtest.h>
+
+#include <QPainter>
+#include <QImage>
+
+#include "draw/painter.h"
+
+#include "draw/internal/qpainterprovider.h"
+
+using namespace mu;
+using namespace mu::draw;
+
+class Draw_PainterTests : public ::testing::Test
+{
+public:
+};
+
+static QPainter* getUnderlyingQPainter(const Painter* painter)
+{
+    return dynamic_cast<QPainterProvider*>(painter->provider().get())->qpainter();
+}
+
+TEST_F(Draw_PainterTests, Painter_FromNewQPainter)
+{
+    //! GIVEN New QPainter
+    QImage pd(100, 100, QImage::Format_ARGB32_Premultiplied);
+    QPainter qp(&pd);
+
+    //! DO Create Painter from it
+    Painter painter(&qp, "test");
+
+    //! CHECK
+    EXPECT_EQ(getUnderlyingQPainter(&painter), &qp);
+
+    EXPECT_EQ(painter.worldTransform(), Transform());
+    EXPECT_EQ(painter.provider()->transform(), Transform());
+
+    //! DO Modify Painter
+    painter.setWorldTransform(Transform(1, 2, 3, 4, 5, 6));
+
+    //! CHECK The changes should have been propagated to QPainter
+    EXPECT_EQ(painter.worldTransform(), Transform(1, 2, 3, 4, 5, 6));
+    EXPECT_EQ(qp.transform(), QTransform(1, 2, 3, 4, 5, 6));
+}
+
+TEST_F(Draw_PainterTests, Painter_FromExistingQPainter)
+{
+    //! GIVEN QPainter that is already modified
+    QImage pd(100, 100, QImage::Format_ARGB32_Premultiplied);
+    QPainter qp(&pd);
+    qp.setTransform(QTransform(1, 2, 3, 4, 5, 6));
+
+    //! DO Create Painter from it
+    Painter painter(&qp, "test");
+
+    //! CHECK
+    EXPECT_EQ(getUnderlyingQPainter(&painter), &qp);
+
+    //! CHECK Painter should have inherited these changes
+    EXPECT_EQ(painter.worldTransform(), Transform(1, 2, 3, 4, 5, 6));
+    EXPECT_EQ(painter.provider()->transform(), Transform(1, 2, 3, 4, 5, 6));
+
+    //! DO Modify Painter
+    painter.setWorldTransform(Transform(4, 5, 6, 7, 8, 9));
+
+    //! CHECK The changes should have been propagated to QPainter
+    EXPECT_EQ(painter.worldTransform(), Transform(4, 5, 6, 7, 8, 9));
+    EXPECT_EQ(painter.provider()->transform(), Transform(4, 5, 6, 7, 8, 9));
+}
+
+TEST_F(Draw_PainterTests, Painter_ViewportAndWindow)
+{
+    //! GIVEN Painter
+    QImage pd(100, 100, QImage::Format_ARGB32_Premultiplied);
+    QPainter qp(&pd);
+    Painter painter(&qp, "test");
+
+    //! DO Set viewport and window
+    painter.setWindow(RectF(0.0, 0.0, 4.0, 4.0));
+    painter.setViewport(RectF(0.0, 0.0, 2.0, 1.0));
+
+    //! CHECK The transformation of the QPainter should be updated accordingly
+    Transform expectedViewTransform(0.5, 0.0, 0.0, 0.25, 0.0, 0.0);
+    EXPECT_EQ(painter.provider()->transform(), expectedViewTransform);
+
+    //! GIVEN Transform
+    Transform worldTransform(1, 2, 3, 4, 5, 6);
+
+    //! DO Modify the world transform too
+    painter.setWorldTransform(worldTransform);
+
+    //! CHECK The transformation of the QPainter should be updated accordingly
+    EXPECT_EQ(painter.provider()->transform(), worldTransform * expectedViewTransform);
+}
+
+TEST_F(Draw_PainterTests, Painter_SaveRestore)
+{
+    //! GIVEN Painter
+    QImage pd(100, 100, QImage::Format_ARGB32_Premultiplied);
+    QPainter qp(&pd);
+    Painter painter(&qp, "test");
+
+    //! DO Set properties
+    painter.setWindow(RectF(0.0, 0.0, 4.0, 4.0));
+    painter.setViewport(RectF(0.0, 0.0, 2.0, 1.0));
+
+    Transform worldTransform(1, 2, 3, 4, 5, 6);
+    painter.setWorldTransform(worldTransform);
+
+    //! CHECK Properties should be set correctly
+    Transform expectedViewTransform(0.5, 0.0, 0.0, 0.25, 0.0, 0.0);
+    EXPECT_EQ(painter.provider()->transform(), worldTransform * expectedViewTransform);
+
+    //! DO Save
+    painter.save();
+
+    //! DO Set new properties
+    painter.setWindow(RectF(0.0, 0.0, 16.0, 15.0));
+    painter.setViewport(RectF(0.0, 0.0, 4.0, 3.0));
+
+    Transform newWorldTransform(1, 2, 3, 4, 5, 6);
+    painter.setWorldTransform(newWorldTransform);
+
+    //! CHECK Properties should be set correctly
+    Transform newExpectedViewTransform(0.25, 0.0, 0.0, 0.2, 0.0, 0.0);
+    EXPECT_EQ(painter.provider()->transform(), newWorldTransform * newExpectedViewTransform);
+
+    //! DO Restore
+    painter.restore();
+
+    //! CHECK Properties should be restored correctly
+    EXPECT_EQ(painter.window(), RectF(0.0, 0.0, 4.0, 4.0));
+    EXPECT_EQ(painter.viewport(), RectF(0.0, 0.0, 2.0, 1.0));
+    EXPECT_EQ(painter.worldTransform(), worldTransform);
+
+    EXPECT_EQ(painter.provider()->transform(), worldTransform * expectedViewTransform);
+}