QTest: provide overloads for the qWaitFor* functionsHEADdev

We shouldn't use ints or qint64 for timeouts anymore due to their poor
type safety and lack of expressiveness. Qt has adopted chrono-first:

https://lists.qt-project.org/pipermail/development/2023-January/043563.html

As a drive-by, remove redundant Q_GUI_EXPORT macros in
qtestsupport_gui.cpp and qtestsupport_widgets.cpp.

Amends 55f163382d36ddf908fc2884f2020a1b92340c10.

[ChangeLog][QtTest] Added QDeadlineTimer overloads for the qWaitFor*
functions.

Pick-to: 6.10
Change-Id: Ife74a1e83d430072a104e0ac665a8cde9fd689f1
Reviewed-by: Marc Mutz <[email protected]>

4 files changed, 138 insertions, 17 deletions

diff --git a/src/gui/kernel/qtestsupport_gui.cpp b/src/gui/kernel/qtestsupport_gui.cpp
index ca62798ddfd..dfcea928fd8 100644
--- a/src/gui/kernel/qtestsupport_gui.cpp
+++ b/src/gui/kernel/qtestsupport_gui.cpp
@@ -24,8 +24,19 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \since 5.0
+    \overload
 
-    Returns \c true, if \a window is active within \a timeout milliseconds. Otherwise returns \c false.
+    The \a timeout is in milliseconds.
+*/
+bool QTest::qWaitForWindowActive(QWindow *window, int timeout)
+{
+    return qWaitForWindowActive(window, QDeadlineTimer{timeout, Qt::TimerType::PreciseTimer});
+}
+
+/*!
+    \since 6.10
+
+    Returns \c true, if \a window is active within \a timeout. Otherwise returns \c false.
 
     The method is useful in tests that call QWindow::show() and rely on the window actually being
     active (i.e. being visible and having focus) before proceeding.
@@ -38,7 +49,7 @@ QT_BEGIN_NAMESPACE
 
     \sa qWaitForWindowExposed(), qWaitForWindowFocused(), QWindow::isActive()
 */
-Q_GUI_EXPORT bool QTest::qWaitForWindowActive(QWindow *window, int timeout)
+bool QTest::qWaitForWindowActive(QWindow *window, QDeadlineTimer timeout)
 {
     if (Q_UNLIKELY(!QGuiApplicationPrivate::platformIntegration()->hasCapability(QPlatformIntegration::WindowActivation))) {
         qWarning() << "qWaitForWindowActive was called on a platform that doesn't support window"
@@ -52,6 +63,17 @@ Q_GUI_EXPORT bool QTest::qWaitForWindowActive(QWindow *window, int timeout)
 }
 
 /*!
+    \since 6.10
+    \overload
+
+    This function uses the default timeout of 5 seconds.
+*/
+bool QTest::qWaitForWindowActive(QWindow *window)
+{
+    return qWaitForWindowActive(window, Internal::defaultTryTimeout);
+}
+
+/*!
     \since 6.7
 
     Returns \c true, if \a window is the focus window within \a timeout. Otherwise returns \c false.
@@ -73,9 +95,31 @@ Q_GUI_EXPORT bool QTest::qWaitForWindowFocused(QWindow *window, QDeadlineTimer t
 }
 
 /*!
+    \since 6.10
+    \overload
+
+    This function uses the default timeout of 5 seconds.
+*/
+bool QTest::qWaitForWindowFocused(QWindow *window)
+{
+    return qWaitForWindowFocused(window, Internal::defaultTryTimeout);
+}
+
+/*!
     \since 5.0
+    \overload
+
+    The \a timeout is in milliseconds.
+*/
+bool QTest::qWaitForWindowExposed(QWindow *window, int timeout)
+{
+    return qWaitForWindowExposed(window, std::chrono::milliseconds(timeout));
+}
 
-    Returns \c true, if \a window is exposed within \a timeout milliseconds. Otherwise returns \c false.
+/*!
+    \since 6.10
+
+    Returns \c true, if \a window is exposed within \a timeout. Otherwise returns \c false.
 
     The method is useful in tests that call QWindow::show() and rely on the window actually being
     being visible before proceeding.
@@ -86,11 +130,22 @@ Q_GUI_EXPORT bool QTest::qWaitForWindowFocused(QWindow *window, QDeadlineTimer t
 
     \sa qWaitForWindowActive(), QWindow::isExposed()
 */
-Q_GUI_EXPORT bool QTest::qWaitForWindowExposed(QWindow *window, int timeout)
+bool QTest::qWaitForWindowExposed(QWindow *window, QDeadlineTimer timeout)
 {
     return QTest::qWaitFor([&]() { return window->isExposed(); }, timeout);
 }
 
+/*!
+    \since 6.10
+    \overload
+
+    This function uses the default timeout of 5 seconds.
+*/
+bool QTest::qWaitForWindowExposed(QWindow *window)
+{
+    return qWaitForWindowExposed(window, Internal::defaultTryTimeout);
+}
+
 namespace QTest {
 
 QTouchEventSequence::~QTouchEventSequence()
diff --git a/src/gui/kernel/qtestsupport_gui.h b/src/gui/kernel/qtestsupport_gui.h
index 951d9df1c7c..39278c2f034 100644
--- a/src/gui/kernel/qtestsupport_gui.h
+++ b/src/gui/kernel/qtestsupport_gui.h
@@ -23,12 +23,16 @@ Q_GUI_EXPORT bool qt_handleTouchEventv2(QWindow *w, const QPointingDevice *devic
 
 namespace QTest {
 
-[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowActive(QWindow *window,
-    int timeout = static_cast<int>(Internal::defaultTryTimeout.count()));
-[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowFocused(QWindow *window,
-    QDeadlineTimer timeout = Internal::defaultTryTimeout);
-[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowExposed(QWindow *window,
-    int timeout = static_cast<int>(Internal::defaultTryTimeout.count()));
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowActive(QWindow *window, int timeout);
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowActive(QWindow *window, QDeadlineTimer timeout);
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowActive(QWindow *window);
+
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowFocused(QWindow *window, QDeadlineTimer timeout);
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowFocused(QWindow *window);
+
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowExposed(QWindow *window, int timeout);
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowExposed(QWindow *window, QDeadlineTimer timeout);
+[[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowExposed(QWindow *window);
 
 Q_GUI_EXPORT QPointingDevice * createTouchDevice(QInputDevice::DeviceType devType = QInputDevice::DeviceType::TouchScreen,
                                                  QInputDevice::Capabilities caps = QInputDevice::Capability::Position);
diff --git a/src/widgets/kernel/qtestsupport_widgets.cpp b/src/widgets/kernel/qtestsupport_widgets.cpp
index 5a7200e58aa..ce40ba8c6dd 100644
--- a/src/widgets/kernel/qtestsupport_widgets.cpp
+++ b/src/widgets/kernel/qtestsupport_widgets.cpp
@@ -31,6 +31,17 @@ static bool qWaitForWidgetWindow(QWidget *w, Predicate predicate, QDeadlineTimer
 
 /*!
     \since 5.0
+    \overload
+
+    The \a timeout is in milliseconds.
+*/
+bool QTest::qWaitForWindowActive(QWidget *widget, int timeout)
+{
+    return qWaitForWindowActive(widget, QDeadlineTimer{timeout, Qt::TimerType::PreciseTimer});
+}
+
+/*!
+    \since 6.10
 
     Returns \c true if \a widget is active within \a timeout milliseconds. Otherwise returns \c false.
 
@@ -45,7 +56,7 @@ static bool qWaitForWidgetWindow(QWidget *w, Predicate predicate, QDeadlineTimer
 
     \sa qWaitForWindowExposed(), QWidget::isActiveWindow()
 */
-Q_WIDGETS_EXPORT bool QTest::qWaitForWindowActive(QWidget *widget, int timeout)
+bool QTest::qWaitForWindowActive(QWidget *widget, QDeadlineTimer timeout)
 {
     if (Q_UNLIKELY(!QGuiApplicationPrivate::platformIntegration()->hasCapability(QPlatformIntegration::WindowActivation))) {
         qWarning() << "qWaitForWindowActive was called on a platform that doesn't support window"
@@ -57,9 +68,19 @@ Q_WIDGETS_EXPORT bool QTest::qWaitForWindowActive(QWidget *widget, int timeout)
     }
     return qWaitForWidgetWindow(widget,
                                 [&](QWindow *window) { return window->isActive(); },
-                                QDeadlineTimer{timeout, Qt::TimerType::PreciseTimer});
+                                timeout);
 }
 
+/*!
+    \since 6.10
+    \overload
+
+    This function uses the default timeout of 5 seconds.
+*/
+bool QTest::qWaitForWindowActive(QWidget *widget)
+{
+    return qWaitForWindowActive(widget, Internal::defaultTryTimeout);
+}
 
 /*!
     \since 6.7
@@ -86,7 +107,30 @@ Q_WIDGETS_EXPORT bool QTest::qWaitForWindowFocused(QWidget *widget, QDeadlineTim
 }
 
 /*!
+    \since 6.10
+    \overload
+
+    This function uses the default timeout of 5 seconds.
+*/
+bool QTest::qWaitForWindowFocused(QWidget *widget)
+{
+    return qWaitForWindowFocused(widget, Internal::defaultTryTimeout);
+}
+
+/*!
     \since 5.0
+    \overload
+
+    The \a timeout is in milliseconds.
+*/
+bool QTest::qWaitForWindowExposed(QWidget *widget, int timeout)
+{
+    return qWaitForWindowExposed(widget, std::chrono::milliseconds(timeout));
+}
+
+
+/*!
+    \since 6.10
 
     Returns \c true if \a widget is exposed within \a timeout milliseconds. Otherwise returns \c false.
 
@@ -99,11 +143,22 @@ Q_WIDGETS_EXPORT bool QTest::qWaitForWindowFocused(QWidget *widget, QDeadlineTim
 
     \sa qWaitForWindowActive(), QWidget::isVisible(), QWindow::isExposed()
 */
-Q_WIDGETS_EXPORT bool QTest::qWaitForWindowExposed(QWidget *widget, int timeout)
+bool QTest::qWaitForWindowExposed(QWidget *widget, QDeadlineTimer timeout)
 {
     return qWaitForWidgetWindow(widget,
                                 [&](QWindow *window) { return window->isExposed(); },
-                                QDeadlineTimer{timeout, Qt::TimerType::PreciseTimer});
+                                timeout);
+}
+
+/*!
+    \since 6.10
+    \overload
+
+    This function uses the default timeout of 5 seconds.
+*/
+bool QTest::qWaitForWindowExposed(QWidget *widget)
+{
+    return qWaitForWindowExposed(widget, Internal::defaultTryTimeout);
 }
 
 namespace QTest {
diff --git a/src/widgets/kernel/qtestsupport_widgets.h b/src/widgets/kernel/qtestsupport_widgets.h
index b49e68db651..4b5e5ff7772 100644
--- a/src/widgets/kernel/qtestsupport_widgets.h
+++ b/src/widgets/kernel/qtestsupport_widgets.h
@@ -14,9 +14,16 @@ class QWidget;
 
 namespace QTest {
 
-[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowActive(QWidget *widget, int timeout = 5000);
-[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowFocused(QWidget *widget, QDeadlineTimer timeout = std::chrono::seconds{5});
-[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowExposed(QWidget *widget, int timeout = 5000);
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowActive(QWidget *widget, int timeout);
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowActive(QWidget *widget, QDeadlineTimer timeout);
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowActive(QWidget *widget);
+
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowFocused(QWidget *widget, QDeadlineTimer timeout);
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowFocused(QWidget *widget);
+
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowExposed(QWidget *widget, int timeout);
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowExposed(QWidget *widget, QDeadlineTimer timeout);
+[[nodiscard]] Q_WIDGETS_EXPORT bool qWaitForWindowExposed(QWidget *widget);
 
 class Q_WIDGETS_EXPORT QTouchEventWidgetSequence : public QTouchEventSequence
 {