add widgets and tests

Author: lexxmark

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "qt-async-lib/widgets/QtWaitingSpinner"]
+	path = qt-async-lib/widgets/QtWaitingSpinner
+	url = https://github.com/lexxmark/QtWaitingSpinner.git

demo/MainWindow.cpp

@@ -3,7 +3,9 @@
 #include <QDesktopWidget>
 #include <thread>
 #include "widgets/AsyncWidget.h"
+#include "widgets/AsyncWidgetProgressSpinner.h"
 #include "values/AsyncValueObtain.h"
+#include "widgets/QtWaitingSpinner/waitingspinnerwidget.h"
 
 MainWindow::MainWindow(QWidget *parent) :
     QMainWindow(parent),
@@ -14,9 +16,21 @@ MainWindow::MainWindow(QWidget *parent) :
     move(QApplication::desktop()->availableGeometry().center() - rect().center());
 
     auto valueWidget = new AsyncWidgetFn<QString>(ui->widget);
+
     valueWidget->createValueWidget = [](QString& value, QWidget* parent) {
         return AsyncWidgetProxy::createLabel(value, parent);
     };
+
+    valueWidget->createProgressWidget = [this](AsyncProgress& progress, QWidget* parent)->QWidget* {
+        switch (m_progressWidgetMode) {
+        case PROGRESS_MODE::SPINNER_LINES:
+            return new AsyncWidgetProgressSpinner(progress, parent);
+
+        default:
+            return new AsyncWidgetProgressBar(progress, parent);
+        }
+    };
+
     valueWidget->setValue(&m_value);
 
     ui->widget->setContentWidget(valueWidget);
@@ -70,6 +84,7 @@ void MainWindow::on_startBttn_clicked()
 
         QString val = "Loaded value is 42";
         value.emplaceValue(std::move(val));
+
     }, "Loading...", ASYNC_CAN_REQUEST_STOP::YES);
 }
 
@@ -80,3 +95,13 @@ void MainWindow::on_stopBttn_clicked()
         progress.requestStop();
     });
 }
+
+void MainWindow::on_radioButtonProgressBar_clicked()
+{
+    m_progressWidgetMode = PROGRESS_MODE::PROGRESS_BAR;
+}
+
+void MainWindow::on_radioButtonSpinnerLines_clicked()
+{
+    m_progressWidgetMode = PROGRESS_MODE::SPINNER_LINES;
+}

demo/MainWindow.h

@@ -10,7 +10,6 @@ class MainWindow;
 
 using AsyncQString = AsyncValue<QString>;
 
-
 class MainWindow : public QMainWindow
 {
     Q_OBJECT
@@ -27,10 +26,20 @@ private slots:
 
     void on_stopBttn_clicked();
 
+    void on_radioButtonProgressBar_clicked();
+
+    void on_radioButtonSpinnerLines_clicked();
+
 private:
     Ui::MainWindow *ui;
 
     AsyncQString m_value;
+
+    enum class PROGRESS_MODE
+    {
+        PROGRESS_BAR,
+        SPINNER_LINES,
+    } m_progressWidgetMode = PROGRESS_MODE::PROGRESS_BAR;
 };
 
 #endif // MAINWINDOW_H

demo/MainWindow.ui

@@ -92,6 +92,52 @@
         </property>
        </widget>
       </item>
+      <item>
+       <widget class="QGroupBox" name="groupBox">
+        <property name="title">
+         <string>Progress UI</string>
+        </property>
+        <layout class="QVBoxLayout" name="verticalLayout_2">
+         <item>
+          <widget class="QRadioButton" name="radioButtonProgressBar">
+           <property name="text">
+            <string>Progress Bar</string>
+           </property>
+           <property name="checked">
+            <bool>true</bool>
+           </property>
+          </widget>
+         </item>
+         <item>
+          <widget class="QRadioButton" name="radioButtonSpinnerLines">
+           <property name="text">
+            <string>Spinner Lines</string>
+           </property>
+          </widget>
+         </item>
+         <item>
+          <widget class="QRadioButton" name="radioButtonSpinnerDots">
+           <property name="enabled">
+            <bool>false</bool>
+           </property>
+           <property name="text">
+            <string>Spinner Dots</string>
+           </property>
+          </widget>
+         </item>
+         <item>
+          <widget class="QRadioButton" name="radioButtonFlyDots">
+           <property name="enabled">
+            <bool>false</bool>
+           </property>
+           <property name="text">
+            <string>Flying Dots</string>
+           </property>
+          </widget>
+         </item>
+        </layout>
+       </widget>
+      </item>
       <item>
        <spacer name="verticalSpacer">
         <property name="orientation">

demo/main.cpp

@@ -1,9 +1,22 @@
 #include "MainWindow.h"
 #include <QApplication>
+#include <widgets/AsyncWidgetError.h>
+
+static QString asyncStyleSheet = R"(
+    AsyncWidgetError,
+    AsyncWidgetProgressBar,
+    AsyncWidgetProgressSpinner,
+    QLabel#AsyncLabel {
+        background: white;
+        border: 1px solid black;
+    }
+)";
 
 int main(int argc, char *argv[])
 {
     QApplication a(argc, argv);
+
+    a.setStyleSheet(asyncStyleSheet);
     MainWindow w;
     w.show();
 

qt-async-lib/Config.h

@@ -0,0 +1,26 @@
+/*
+   Copyright (c) 2018 Alex Zhondin <lexxmark.dev@gmail.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+#ifndef ASYNC_CONFIG_H
+#define ASYNC_CONFIG_H
+
+#if !defined(QT_NO_DEBUG)
+    #define ASYNC_TRACK_DEADLOCK
+#endif
+
+#define ASYNC_PROGRESS_WIDGET_UPDATE_TIMEOUT 200
+
+#endif // ASYNC_CONFIG_H

qt-async-lib/qt-async-lib.pro

@@ -12,7 +12,9 @@ SOURCES += \
     values/AsyncValueBase.cpp \
     widgets/AsyncWidgetProxy.cpp \
     widgets/AsyncWidgetError.cpp \
-    widgets/AsyncWidgetProgress.cpp
+    widgets/QtWaitingSpinner/waitingspinnerwidget.cpp \
+    widgets/AsyncWidgetProgressBar.cpp \
+    widgets/AsyncWidgetProgressSpinner.cpp
 
 HEADERS += \
     values/AsyncValueBase.h \
@@ -25,6 +27,9 @@ HEADERS += \
     widgets/AsyncWidgetBase.h \
     widgets/AsyncWidget.h \
     widgets/AsyncWidgetError.h \
-    widgets/AsyncWidgetProgress.h
+    widgets/QtWaitingSpinner/waitingspinnerwidget.h \
+    Config.h \
+    widgets/AsyncWidgetProgressBar.h \
+    widgets/AsyncWidgetProgressSpinner.h
 
 DEFINES += QT_DEPRECATED_WARNINGS

qt-async-lib/values/AsyncValueBase.h

@@ -21,6 +21,7 @@
 #include <QMutex>
 #include <QReadWriteLock>
 #include <QWaitCondition>
+#include <QThread>
 
 enum class ASYNC_VALUE_STATE
 {
@@ -43,6 +44,14 @@ class AsyncValueBase : public QObject
 
     void emitStateChanged()
     {
+#if defined(ASYNC_TRACK_DEADLOCK)
+        Q_ASSERT(!m_emitThread && "This function is not reenterant");
+        m_emitThread = QThread::currentThread();
+        auto atExit = makeAtExitOp([this]{
+            m_emitThread = nullptr;
+        });
+#endif
+
         emit stateChanged(m_state);
     }
 
@@ -59,6 +68,10 @@ class AsyncValueBase : public QObject
     };
     Waiter* m_waiter = nullptr;
 
+#if defined(ASYNC_TRACK_DEADLOCK)
+    QThread* m_emitThread = nullptr;
+#endif
+
     template <typename AtExit>
     struct AtExitOp
     {

qt-async-lib/values/AsyncValueTemplate.h

@@ -56,6 +56,10 @@ class AsyncValueTemplate : public AsyncValueBase
 
     void moveValue(std::unique_ptr<ValueType> value)
     {
+#if defined(ASYNC_TRACK_DEADLOCK)
+        Q_ASSERT(m_emitThread != QThread::currentThread() && "Changing async value from emitted state changed signal is forbidden. Deadlock will happen.");
+#endif
+
         Content oldContent;
 
         QMutexLocker writeLocker(&m_writeLock);
@@ -89,6 +93,10 @@ class AsyncValueTemplate : public AsyncValueBase
 
     void moveError(std::unique_ptr<ErrorType> error)
     {
+#if defined(ASYNC_TRACK_DEADLOCK)
+        Q_ASSERT(m_emitThread != QThread::currentThread() && "Changing async value from emitted state changed signal is forbidden. Deadlock will happen.");
+#endif
+
         Content oldContent;
 
         QMutexLocker writeLocker(&m_writeLock);
@@ -115,6 +123,10 @@ class AsyncValueTemplate : public AsyncValueBase
 
     ProgressType* startProgressMove(std::unique_ptr<ProgressType> progress)
     {
+#if defined(ASYNC_TRACK_DEADLOCK)
+        Q_ASSERT(m_emitThread != QThread::currentThread() && "Changing async value from emitted state changed signal is forbidden. Deadlock will happen.");
+#endif
+
         Content oldContent;
 
         QMutexLocker writeLocker(&m_writeLock);

qt-async-lib/widgets/AsyncWidget.h

@@ -21,7 +21,7 @@
 #include "values/AsyncValue.h"
 #include "AsyncWidgetBase.h"
 #include "AsyncWidgetError.h"
-#include "AsyncWidgetProgress.h"
+#include "AsyncWidgetProgressBar.h"
 
 template <typename ValueType>
 class AsyncWidget : public AsyncWidgetBase<AsyncValue<ValueType>>
@@ -42,7 +42,7 @@ class AsyncWidget : public AsyncWidgetBase<AsyncValue<ValueType>>
 
     QWidget* createProgressWidgetImpl(AsyncProgress& progress, QWidget* parent) override
     {
-        return new AsyncWidgetProgress(progress, parent);
+        return new AsyncWidgetProgressBar(progress, parent);
     }
 };
 

qt-async-lib/widgets/AsyncWidgetError.cpp

@@ -20,14 +20,7 @@ AsyncWidgetError::AsyncWidgetError(const AsyncError& error, QWidget* parent)
     : QLabel(parent),
       m_error(error)
 {
-    setAutoFillBackground(true);
-    setFrameStyle(QFrame::Panel | QFrame::Plain);
-    setLineWidth(1);
     setWordWrap(true);
-    auto _palette = palette();
-    _palette.setColor(QPalette::Normal, QPalette::Window, Qt::white);
-    setPalette(_palette);
     setAlignment(Qt::AlignCenter);
-
     setText(m_error.text());
 }

qt-async-lib/widgets/AsyncWidgetProgress.cpp renamed to qt-async-lib/widgets/AsyncWidgetProgressBar.cpp

@@ -14,7 +14,8 @@
    limitations under the License.
 */
 
-#include "AsyncWidgetProgress.h"
+#include "AsyncWidgetProgressBar.h"
+#include "../Config.h"
 #include <QLabel>
 #include <QProgressBar>
 #include <QPushButton>
@@ -23,17 +24,10 @@
 #include <QTimer>
 #include <QTimeLine>
 
-AsyncWidgetProgress::AsyncWidgetProgress(AsyncProgress& progress, QWidget* parent)
+AsyncWidgetProgressBar::AsyncWidgetProgressBar(AsyncProgress& progress, QWidget* parent)
     : QFrame(parent),
       m_progress(progress)
 {
-    setAutoFillBackground(true);
-    setFrameStyle(QFrame::Panel | QFrame::Plain);
-    setLineWidth(1);
-    auto _palette = palette();
-    _palette.setColor(QPalette::Normal, QPalette::Window, Qt::white);
-    setPalette(_palette);
-
     auto layout = new QVBoxLayout(this);
     layout->setSpacing(6);
     layout->setContentsMargins(11, 11, 11, 11);
@@ -72,7 +66,7 @@ AsyncWidgetProgress::AsyncWidgetProgress(AsyncProgress& progress, QWidget* paren
                 m_stop = new QPushButton(this);
                 m_stop->setText("Stop");
                 subLayout->addWidget(m_stop);
-                QObject::connect(m_stop, &QPushButton::clicked, this, &AsyncWidgetProgress::onStopClicked);
+                QObject::connect(m_stop, &QPushButton::clicked, this, &AsyncWidgetProgressBar::onStopClicked);
             }
 
             layout->addLayout(subLayout);
@@ -86,18 +80,18 @@ AsyncWidgetProgress::AsyncWidgetProgress(AsyncProgress& progress, QWidget* paren
     }
 
     auto timer = new QTimer(this);
-    connect(timer, &QTimer::timeout, this, &AsyncWidgetProgress::update);
-    timer->start(200);
+    connect(timer, &QTimer::timeout, this, &AsyncWidgetProgressBar::updateContent);
+    timer->start(ASYNC_PROGRESS_WIDGET_UPDATE_TIMEOUT);
 
-    update();
+    updateContent();
 }
 
-void AsyncWidgetProgress::onStopClicked(bool /*checked*/)
+void AsyncWidgetProgressBar::onStopClicked(bool /*checked*/)
 {
     m_progress.requestStop();
 }
 
-void AsyncWidgetProgress::update()
+void AsyncWidgetProgressBar::updateContent()
 {
     if (m_progress.isStopRequested())
         m_message->setText(m_progress.message()+"(Stopping...)");