First Commit

3rdparty/kddockwidgets/tests/tst_docks_slow3.cpp

@@ -0,0 +1,333 @@
+/*
+  This file is part of KDDockWidgets.
+
+  SPDX-FileCopyrightText: 2019 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  Author: Sérgio Martins <sergio.martins@kdab.com>
+
+  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
+
+  Contact KDAB at <info@kdab.com> for commercial licensing options.
+*/
+
+// We don't care about performance related checks in the tests
+// clazy:excludeall=ctor-missing-parent-argument,missing-qobject-macro,range-loop,missing-typeinfo,detaching-member,function-args-by-ref,non-pod-global-static,reserve-candidates,qstring-allocations
+
+// A test that was extracted out from tst_docks.cpp as it was too slow
+// By using a separate executable it can be parallelized by ctest.
+
+#include "utils.h"
+#include "simple_test_framework.h"
+#include "Config.h"
+#include "core/LayoutSaver_p.h"
+#include "core/Position_p.h"
+#include "core/WindowBeingDragged_p.h"
+#include "core/layouting/Item_p.h"
+#include "core/ViewFactory.h"
+#include "core/Action.h"
+#include "core/MDILayout.h"
+#include "core/DropArea.h"
+#include "core/MainWindow.h"
+#include "core/DockWidget.h"
+#include "core/DockWidget_p.h"
+#include "core/Separator.h"
+#include "core/TabBar.h"
+#include "core/Stack.h"
+#include "core/SideBar.h"
+#include "core/Platform.h"
+
+using namespace KDDockWidgets;
+using namespace KDDockWidgets::Core;
+using namespace KDDockWidgets::Tests;
+
+KDDW_QCORO_TASK tst_dockWidgetGetsFocusWhenDocked()
+{
+    EnsureTopLevelsDeleted e;
+    KDDockWidgets::Config::self().setFlags(KDDockWidgets::Config::Flag_TitleBarIsFocusable);
+
+    // We drag dw2 onto dw2 and drop it
+
+    auto dw1 = Config::self()
+                   .viewFactory()
+                   ->createDockWidget("1")
+                   ->asDockWidgetController();
+    auto dw2 = Config::self()
+                   .viewFactory()
+                   ->createDockWidget("2")
+                   ->asDockWidgetController();
+    auto le1 = Platform::instance()->tests_createFocusableView({ true });
+    auto le2 = Platform::instance()->tests_createFocusableView({ true });
+    dw1->setGuestView(le1->asWrapper());
+    dw2->setGuestView(le2->asWrapper());
+    dw1->open();
+    dw2->open();
+    EVENT_LOOP(200);
+
+    auto fw1 = dw1->floatingWindow();
+    ObjectGuard<Core::FloatingWindow> fw2 = dw2->floatingWindow();
+
+    // Focus dock widget 1 first
+    CHECK(!dw1->isFocused());
+    dw1->window()->activateWindow();
+    dw2->window()->move(100, 100);
+
+    KDBindings::ScopedConnection con = dw1->d->isFocusedChanged.connect([dw1](bool focused) {
+        CHECK(focused == dw1->isFocused());
+    });
+
+    le1->setFocus(Qt::MouseFocusReason);
+
+    EVENT_LOOP(200);
+    CHECK(dw1->isFocused());
+
+    CHECK(fw1->view()->isActiveWindow());
+    KDDW_CO_AWAIT dragFloatingWindowTo(fw2, fw1->dropArea(), DropLocation_Left);
+    WAIT_FOR_EVENT(fw1, Event::WindowActivate);
+
+    /// We dropped into floating window 1, it should still be active
+    CHECK(fw1->view()->isActiveWindow());
+
+    // DockWidget 2 was dropped, it should now be focused
+    CHECK(!dw1->isFocused());
+    CHECK(dw2->isFocused());
+
+    delete fw1;
+    delete fw2;
+
+    KDDW_TEST_RETURN(true);
+}
+
+KDDW_QCORO_TASK tst_closeShowWhenNoCentralFrame()
+{
+    EnsureTopLevelsDeleted e;
+    // Tests a crash I got when hiding and showing and no central group
+
+    auto m = createMainWindow(Size(800, 500), MainWindowOption_None); // Remove central group
+    ObjectGuard<Core::DockWidget> dock1 =
+        createDockWidget("1", Platform::instance()->tests_createView({ true }));
+    m->addDockWidget(dock1, Location_OnLeft);
+    dock1->close();
+    m->layout()->checkSanity();
+
+    CHECK(!dock1->dptr()->group());
+    CHECK(!KDDW_CO_AWAIT Platform::instance()->tests_waitForDeleted(dock1)); // It was being deleted due to a
+                                                                             // bug
+    CHECK(dock1);
+    dock1->open();
+    m->layout()->checkSanity();
+
+    KDDW_TEST_RETURN(true);
+}
+
+KDDW_QCORO_TASK tst_close()
+{
+    EnsureTopLevelsDeleted e;
+
+    // 1.0 Call QWidget::close() on QDockWidget
+    auto dock1 = createDockWidget("doc1");
+    auto toggleAction = dock1->toggleAction();
+    CHECK(toggleAction->isChecked());
+    CHECK(dock1->isFloating());
+    CHECK(dock1->isVisible());
+    CHECK(dock1->floatingWindow());
+
+    CHECK(dock1->close());
+
+    CHECK(!dock1->isVisible());
+    CHECK(!dock1->window()->controller()->isVisible());
+    CHECK(dock1->window()->equals(dock1->view()));
+    CHECK(!toggleAction->isChecked());
+
+    // 1.1 Reshow with show()
+    dock1->open();
+    auto fw = dock1->floatingWindow();
+    CHECK(fw);
+    CHECK(fw->isVisible());
+    CHECK(toggleAction->isChecked());
+    CHECK(!dock1->view()->isExplicitlyHidden());
+    CHECK(!dock1->view()->isExplicitlyHidden());
+    CHECK(dock1->isVisible());
+    CHECK(dock1->window()->equals(fw->view()));
+    CHECK(toggleAction->isChecked());
+
+    // 1.2 Reshow with toggleAction instead
+    CHECK(dock1->close());
+    CHECK(!toggleAction->isChecked());
+    CHECK(!dock1->isVisible());
+    toggleAction->setChecked(true);
+    CHECK(dock1->isVisible());
+
+    // 1.3 Use hide() instead
+    auto fw1 = dock1->floatingWindow();
+    CHECK(fw1);
+
+    dock1->close();
+
+    CHECK(KDDW_CO_AWAIT Platform::instance()->tests_waitForDeleted(fw1));
+    CHECK(!dock1->isVisible());
+    CHECK(!dock1->window()->controller()->isVisible());
+    CHECK(dock1->window()->equals(dock1->view()));
+    CHECK(!toggleAction->isChecked());
+
+    // 1.4 close a FloatingWindow, via DockWidget::close
+    ObjectGuard<Core::FloatingWindow> window = dock1->dptr()->morphIntoFloatingWindow();
+    ObjectGuard<Core::Group> group1 = dock1->dptr()->group();
+    CHECK(dock1->isVisible());
+    CHECK(dock1->window()->controller()->isVisible());
+    CHECK(group1->isVisible());
+    CHECK(dock1->window()->equals(window->view()));
+
+    CHECK(dock1->close());
+    CHECK(!dock1->dptr()->group());
+    CHECK(KDDW_CO_AWAIT Platform::instance()->tests_waitForDeleted(group1));
+    CHECK(KDDW_CO_AWAIT Platform::instance()->tests_waitForDeleted(window));
+
+    // 1.5 close a FloatingWindow, via FloatingWindow::close
+    dock1->open();
+
+    window = dock1->dptr()->morphIntoFloatingWindow();
+    group1 = dock1->dptr()->group();
+    CHECK(dock1->isVisible());
+    CHECK(dock1->window()->controller()->isVisible());
+    CHECK(group1->isVisible());
+    CHECK(dock1->window()->equals(window->view()));
+
+    CHECK(window->view()->close());
+
+    CHECK(!dock1->dptr()->group());
+    CHECK(KDDW_CO_AWAIT Platform::instance()->tests_waitForDeleted(group1));
+    CHECK(KDDW_CO_AWAIT Platform::instance()->tests_waitForDeleted(window));
+
+    // 1.6 Check if space is reclaimed after closing left dock
+    Core::DockWidget *centralDock;
+    Core::DockWidget *leftDock;
+    Core::DockWidget *rightDock;
+
+    auto mainwindow = createSimpleNestedMainWindow(&centralDock, &leftDock, &rightDock);
+    auto da = mainwindow->dropArea();
+
+    CHECK(da->checkSanity());
+    CHECK_EQ(leftDock->dptr()->group()->view()->x(), 0);
+
+    CHECK_EQ(centralDock->dptr()->group()->view()->x(),
+             leftDock->dptr()->group()->view()->geometry().right() + Item::layoutSpacing + 1);
+    CHECK_EQ(rightDock->dptr()->group()->view()->x(),
+             centralDock->dptr()->group()->view()->geometry().right() + Item::layoutSpacing
+                 + 1);
+    leftDock->close();
+    EVENT_LOOP(250);
+    CHECK_EQ(centralDock->dptr()->group()->view()->x(), 0);
+    CHECK_EQ(rightDock->dptr()->group()->view()->x(),
+             centralDock->dptr()->group()->view()->geometry().right() + Item::layoutSpacing
+                 + 1);
+
+    rightDock->close();
+    EVENT_LOOP(250);
+    Margins margins = mainwindow->centerWidgetMargins();
+    CHECK_EQ(centralDock->dptr()->group()->view()->width(),
+             mainwindow->width() - 0 * 2 - margins.left() - margins.right());
+    delete leftDock;
+    delete rightDock;
+    delete centralDock;
+
+    // 1.9 Close tabbed dock, side docks will maintain their position
+    mainwindow = createSimpleNestedMainWindow(&centralDock, &leftDock, &rightDock);
+    const int leftX = leftDock->dptr()->group()->view()->x();
+    const int rightX = rightDock->dptr()->group()->view()->x();
+
+    centralDock->close();
+
+    CHECK_EQ(leftDock->dptr()->group()->view()->x(), leftX);
+    CHECK_EQ(rightDock->dptr()->group()->view()->x(), rightX);
+    delete leftDock;
+    delete rightDock;
+    delete centralDock;
+    delete dock1;
+
+
+    // 2. Test that closing the single group of a main window doesn't close the main window itself
+    {
+        auto m = createMainWindow(Size(800, 500), MainWindowOption_None); // Remove central group
+        ObjectGuard<MainWindow> mainWindowPtr = m.get();
+        dock1 = createDockWidget("hello");
+        m->addDockWidget(dock1, Location_OnLeft);
+
+        // 2.2 Closing should not close the main window
+        dock1->close();
+        CHECK(mainWindowPtr.data());
+        delete dock1;
+    }
+
+    // 2.1 Test closing the group instead
+    {
+        auto m = createMainWindow(Size(800, 500), MainWindowOption_None); // Remove central group
+        ObjectGuard<MainWindow> mainWindowPtr = m.get();
+        dock1 = createDockWidget("hello");
+        m->addDockWidget(dock1, Location_OnLeft);
+
+        // 2.2 Closing should not close the main window
+        dock1->dptr()->group()->titleBar()->onCloseClicked();
+        CHECK(mainWindowPtr.data());
+        CHECK(mainWindowPtr->isVisible());
+        delete dock1;
+    }
+
+    // 2.2 Repeat, but with a central group
+    {
+        auto m = createMainWindow(Size(800, 500));
+        ObjectGuard<MainWindow> mainWindowPtr = m.get();
+        dock1 = createDockWidget("hello");
+        m->addDockWidget(dock1, Location_OnLeft);
+
+        // 2.2 Closing should not close the main window
+        dock1->dptr()->group()->titleBar()->onCloseClicked();
+        CHECK(mainWindowPtr.data());
+        CHECK(mainWindowPtr->isVisible());
+        delete dock1;
+    }
+
+    KDDW_TEST_RETURN(true);
+}
+
+KDDW_QCORO_TASK tst_positionWhenShown()
+{
+    // Tests that when showing a dockwidget it shows in the same position as before
+    EnsureTopLevelsDeleted e;
+    auto window = createMainWindow();
+    auto dock1 = newDockWidget("1");
+    dock1->open();
+    EVENT_LOOP(1000); // Wait for group to settle
+    const Point desiredPos = Point(100, 100);
+    dock1->view()->window()->setFramePosition(desiredPos);
+    EVENT_LOOP(1000); // Wait for group to settle
+    CHECK_EQ(dock1->view()->window()->framePosition(), desiredPos);
+
+    dock1->close();
+    dock1->open();
+    CHECK_EQ(dock1->view()->window()->framePosition(), desiredPos);
+
+    // Cleanup
+    window->layout()->checkSanity();
+    dock1->destroyLater();
+    CHECK(KDDW_CO_AWAIT Platform::instance()->tests_waitForDeleted(dock1));
+
+    KDDW_TEST_RETURN(true);
+}
+
+KDDW_QCORO_TASK tst_keepLast()
+{
+    // 1 event loop for DelayedDelete. Avoids LSAN warnings.
+    EVENT_LOOP(1);
+    KDDW_TEST_RETURN(true);
+}
+
+static const auto s_tests = std::vector<KDDWTest> {
+#ifndef KDDW_FRONTEND_FLUTTER
+    TEST(tst_dockWidgetGetsFocusWhenDocked),
+    TEST(tst_closeShowWhenNoCentralFrame),
+    TEST(tst_positionWhenShown),
+#endif
+    TEST(tst_close),
+    TEST(tst_keepLast), // Keep this test at the end
+};
+
+#include "tests_main.h"