feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
f6d71d61d7baaf661d6c1ecb753d8ceeb6f70f49
qt-creator/src/libs/utils/futuresynchronizer.cpp

86 lines
2.3 KiB
C++
Raw Normal View History

Introduce Utils::FutureSynchronizer The API is nearly the same as QFutureSynchronizer. The differences are: 1. We don't make this class a template class, however, we are leaving some template methods, like addFuture(). For the scope of future synchronizing there is no need for QFuture<T> API, the QFuture<void> is sufficient. 2. Renamed cancelOnWait() getter to isCancelOnWait() in order to conform more to Qt API naming rules. 3. Removed futures() getter and provided isEmpty() instead. 4. Removed c'tor that takes a future and setFuture(). These 2 methods were superfluous and may easily be substituted with other methods from the existing API. The additional feature is about flushing finished futures. This can be done on demand by a call to flushFinishedFutures(), or is done automatically on every call to addFuture(). Change-Id: I6a323c9481eeeea9235e6b6e3048cef02873da08 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-05-11 16:53:03 +02:00
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "futuresynchronizer.h"
/*! \class Utils::FutureSynchronizer
\brief The FutureSynchronizer is an enhanced version of QFutureSynchronizer.
*/
namespace Utils {
FutureSynchronizer::~FutureSynchronizer()
{
waitForFinished();
}
bool FutureSynchronizer::isEmpty() const
{
return m_futures.isEmpty();
}
void FutureSynchronizer::waitForFinished()
{
Use Utils::FutureSynchronizer in IosSimulatorToolHandlerPrivate Add a new method: void FutureSynchronizer::cancelAllFutures(). Change-Id: I5a4e1ea3230ac3c0ce9d3f26b751b2c05fe3dfd4 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-05-12 15:58:39 +02:00
if (m_cancelOnWait)
cancelAllFutures();
Introduce Utils::FutureSynchronizer The API is nearly the same as QFutureSynchronizer. The differences are: 1. We don't make this class a template class, however, we are leaving some template methods, like addFuture(). For the scope of future synchronizing there is no need for QFuture<T> API, the QFuture<void> is sufficient. 2. Renamed cancelOnWait() getter to isCancelOnWait() in order to conform more to Qt API naming rules. 3. Removed futures() getter and provided isEmpty() instead. 4. Removed c'tor that takes a future and setFuture(). These 2 methods were superfluous and may easily be substituted with other methods from the existing API. The additional feature is about flushing finished futures. This can be done on demand by a call to flushFinishedFutures(), or is done automatically on every call to addFuture(). Change-Id: I6a323c9481eeeea9235e6b6e3048cef02873da08 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-05-11 16:53:03 +02:00
for (QFuture<void> &future : m_futures)
future.waitForFinished();
clearFutures();
}
Use Utils::FutureSynchronizer in IosSimulatorToolHandlerPrivate Add a new method: void FutureSynchronizer::cancelAllFutures(). Change-Id: I5a4e1ea3230ac3c0ce9d3f26b751b2c05fe3dfd4 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-05-12 15:58:39 +02:00
void FutureSynchronizer::cancelAllFutures()
{
for (QFuture<void> &future : m_futures)
future.cancel();
}
Introduce Utils::FutureSynchronizer The API is nearly the same as QFutureSynchronizer. The differences are: 1. We don't make this class a template class, however, we are leaving some template methods, like addFuture(). For the scope of future synchronizing there is no need for QFuture<T> API, the QFuture<void> is sufficient. 2. Renamed cancelOnWait() getter to isCancelOnWait() in order to conform more to Qt API naming rules. 3. Removed futures() getter and provided isEmpty() instead. 4. Removed c'tor that takes a future and setFuture(). These 2 methods were superfluous and may easily be substituted with other methods from the existing API. The additional feature is about flushing finished futures. This can be done on demand by a call to flushFinishedFutures(), or is done automatically on every call to addFuture(). Change-Id: I6a323c9481eeeea9235e6b6e3048cef02873da08 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-05-11 16:53:03 +02:00
void FutureSynchronizer::clearFutures()
{
m_futures.clear();
}
void FutureSynchronizer::setCancelOnWait(bool enabled)
{
m_cancelOnWait = enabled;
}
bool FutureSynchronizer::isCancelOnWait() const
{
return m_cancelOnWait;
}
void FutureSynchronizer::flushFinishedFutures()
{
QList<QFuture<void>> newFutures;
for (const QFuture<void> &future : qAsConst(m_futures)) {
if (!future.isFinished())
newFutures.append(future);
}
m_futures = newFutures;
}
} // namespace Utils
Copy Permalink