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

66 lines
1.3 KiB
C++
Raw Normal View History

Use SPDX license identifiers Replace the current license disclaimer in files by a SPDX-License-Identifier. Task-number: QTBUG-67283 Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-19 15:59:36 +02:00
// Copyright (C) 2021 The Qt Company Ltd.
Remove GPL-3.0+ from license identifiers Since we also license under GPL-3.0 WITH Qt-GPL-exception-1.0, this applies only to a hypothetical newer version of GPL, that doesn't exist yet. If such a version emerges, we can still decide to relicense... While at it, replace (deprecated) GPL-3.0 with more explicit GPL-3.0-only Change was done by running find . -type f -exec perl -pi -e "s/LicenseRef-Qt-Commercial OR GPL-3.0\+ OR GPL-3.0 WITH Qt-GPL-exception-1.0/LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0/g" {} \; Change-Id: I5097e6ce8d10233993ee30d7e25120e2659eb10b Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-12-21 10:12:09 +01:00
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
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
#include "futuresynchronizer.h"
Doc: Add "\inmodule QtCreator" to \class and \namespace docs To get rid of QDoc warnings. Change-Id: Idd39b7ae4327798c376f424c94d6617bcaee2258 Reviewed-by: hjk <hjk@qt.io>
2023-05-22 14:38:47 +02:00
/*!
\class Utils::FutureSynchronizer
\inmodule QtCreator
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
\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;
Port from qAsConst() to std::as_const() We've been requiring C++17 since Qt 6.0, and our qAsConst use finally starts to bother us (QTBUG-99313), so time to port away from it now. Since qAsConst has exactly the same semantics as std::as_const (down to rvalue treatment, constexpr'ness and noexcept'ness), there's really nothing more to it than a global search-and-replace. Task-number: QTBUG-99313 Change-Id: I88edd91395849574436299b8badda21bb93bea39 Reviewed-by: hjk <hjk@qt.io>
2022-10-07 14:46:06 +02:00
for (const QFuture<void> &future : std::as_const(m_futures)) {
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
if (!future.isFinished())
newFutures.append(future);
}
m_futures = newFutures;
}
} // namespace Utils
Copy Permalink