diff options
Diffstat (limited to 'src/concurrent/qtconcurrentrun.h')
| -rw-r--r-- | src/concurrent/qtconcurrentrun.h | 211 |
1 files changed, 36 insertions, 175 deletions
diff --git a/src/concurrent/qtconcurrentrun.h b/src/concurrent/qtconcurrentrun.h index 5804393e25..cbc750de84 100644 --- a/src/concurrent/qtconcurrentrun.h +++ b/src/concurrent/qtconcurrentrun.h @@ -1,55 +1,23 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtConcurrent module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** 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 Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** 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-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QTCONCURRENT_RUN_H #define QTCONCURRENT_RUN_H +#if 0 +#pragma qt_class(QtConcurrentRun) +#endif + #include <QtConcurrent/qtconcurrentcompilertest.h> -#if !defined(QT_NO_CONCURRENT) || defined(Q_CLANG_QDOC) +#if !defined(QT_NO_CONCURRENT) || defined(Q_QDOC) #include <QtConcurrent/qtconcurrentrunbase.h> #include <QtConcurrent/qtconcurrentstoredfunctioncall.h> QT_BEGIN_NAMESPACE -#ifdef Q_CLANG_QDOC +#ifdef Q_QDOC typedef int Function; @@ -61,172 +29,65 @@ namespace QtConcurrent { template <typename T> QFuture<T> run(QThreadPool *pool, Function function, ...); - template <typename T> - QFuture<T> runWithPromise(Function function, ...); - - template <typename T> - QFuture<T> runWithPromise(QThreadPool *pool, Function function, ...); - } // namespace QtConcurrent #else namespace QtConcurrent { -// Note: It's a copy taken from qfuture_impl.h with some specialization added -// TODO: Get rid of the code repetition and unify this for both purposes, see QTBUG-83331 -template<typename...> -struct ArgsType; - -template<typename Arg, typename... Args> -struct ArgsType<Arg, Args...> -{ - using PromiseType = void; - static const bool IsPromise = false; -}; - -// Note: this specialization was added -template<typename Arg, typename... Args> -struct ArgsType<QPromise<Arg> &, Args...> -{ - using PromiseType = Arg; - static const bool IsPromise = true; -}; - -template<> -struct ArgsType<> -{ - using PromiseType = void; - static const bool IsPromise = false; -}; - -template<typename F> -struct ArgResolver : ArgResolver<decltype(&std::decay_t<F>::operator())> -{ -}; - -// Note: this specialization was added, see callableObjectWithState() test in qtconcurrentrun -template<typename F> -struct ArgResolver<std::reference_wrapper<F>> : ArgResolver<decltype(&std::decay_t<F>::operator())> -{ -}; - -template<typename R, typename... Args> -struct ArgResolver<R(Args...)> : public ArgsType<Args...> -{ -}; - -template<typename R, typename... Args> -struct ArgResolver<R (*)(Args...)> : public ArgsType<Args...> -{ -}; - -// Note: this specialization was added, see light() test in qtconcurrentrun -template<typename R, typename... Args> -struct ArgResolver<R (*&)(Args...)> : public ArgsType<Args...> -{ -}; - -// Note: this specialization was added, see light() test in qtconcurrentrun -template<typename R, typename... Args> -struct ArgResolver<R (* const)(Args...)> : public ArgsType<Args...> -{ -}; - -template<typename R, typename... Args> -struct ArgResolver<R (&)(Args...)> : public ArgsType<Args...> -{ -}; - -template<typename Class, typename R, typename... Args> -struct ArgResolver<R (Class::*)(Args...)> : public ArgsType<Args...> -{ -}; - -template<typename Class, typename R, typename... Args> -struct ArgResolver<R (Class::*)(Args...) noexcept> : public ArgsType<Args...> -{ -}; - -template<typename Class, typename R, typename... Args> -struct ArgResolver<R (Class::*)(Args...) const> : public ArgsType<Args...> -{ -}; - -template<typename Class, typename R, typename... Args> -struct ArgResolver<R (Class::*)(Args...) const noexcept> : public ArgsType<Args...> -{ -}; +#define QTCONCURRENT_RUN_NODISCARD \ + Q_NODISCARD_X("Use QThreadPool::start(Callable&&) if you don't need the returned QFuture") -// Note: this specialization was added, see crefFunction() test in qtconcurrentrun -template<typename Class, typename R, typename... Args> -struct ArgResolver<R (Class::* const)(Args...) const> : public ArgsType<Args...> -{ -}; - -template<typename Class, typename R, typename... Args> -struct ArgResolver<R (Class::* const)(Args...) const noexcept> : public ArgsType<Args...> +template <class Function, class ...Args> +QTCONCURRENT_RUN_NODISCARD +auto run(QThreadPool *pool, Function &&f, Args &&...args) { -}; + DecayedTuple<Function, Args...> tuple { std::forward<Function>(f), + std::forward<Args>(args)... }; + return TaskResolver<std::decay_t<Function>, std::decay_t<Args>...>::run( + std::move(tuple), TaskStartParameters { pool }); +} template <class Function, class ...Args> -[[nodiscard]] -auto run(QThreadPool *pool, Function &&f, Args &&...args) +QTCONCURRENT_RUN_NODISCARD +auto run(QThreadPool *pool, std::reference_wrapper<const Function> &&functionWrapper, + Args &&...args) { - return (new StoredFunctionCall<Function, Args...>( - std::forward<Function>(f), std::forward<Args>(args)...))->start(pool); + return run(pool, std::forward<const Function>(functionWrapper.get()), + std::forward<Args>(args)...); } template <class Function, class ...Args> -[[nodiscard]] +QTCONCURRENT_RUN_NODISCARD auto run(Function &&f, Args &&...args) { - return run(QThreadPool::globalInstance(), std::forward<Function>(f), std::forward<Args>(args)...); + return run(QThreadPool::globalInstance(), std::forward<Function>(f), + std::forward<Args>(args)...); } +// overload with a Promise Type hint, takes thread pool template <class PromiseType, class Function, class ...Args> -[[nodiscard]] -auto runWithPromise(QThreadPool *pool, Function &&f, Args &&...args) +QTCONCURRENT_RUN_NODISCARD +auto run(QThreadPool *pool, Function &&f, Args &&...args) { return (new StoredFunctionCallWithPromise<Function, PromiseType, Args...>( std::forward<Function>(f), std::forward<Args>(args)...))->start(pool); } -template <class Function, class ...Args> -[[nodiscard]] -auto runWithPromise(QThreadPool *pool, Function &&f, Args &&...args) -{ - static_assert(ArgResolver<Function>::IsPromise, "The first argument of passed callable object isn't a QPromise<T> & type."); - using PromiseType = typename ArgResolver<Function>::PromiseType; - return runWithPromise<PromiseType>(pool, std::forward<Function>(f), std::forward<Args>(args)...); -} - -template <class Function, class ...Args> -[[nodiscard]] -auto runWithPromise(QThreadPool *pool, std::reference_wrapper<const Function> &&functionWrapper, Args &&...args) -{ - static_assert(ArgResolver<const Function>::IsPromise, "The first argument of passed callable object isn't a QPromise<T> & type."); - using PromiseType = typename ArgResolver<const Function>::PromiseType; - return runWithPromise<PromiseType>(pool, std::forward<const Function>(functionWrapper.get()), std::forward<Args>(args)...); -} - +// overload with a Promise Type hint, uses global thread pool template <class PromiseType, class Function, class ...Args> -[[nodiscard]] -auto runWithPromise(Function &&f, Args &&...args) +QTCONCURRENT_RUN_NODISCARD +auto run(Function &&f, Args &&...args) { - return runWithPromise<PromiseType>(QThreadPool::globalInstance(), std::forward<Function>(f), std::forward<Args>(args)...); + return run<PromiseType>(QThreadPool::globalInstance(), std::forward<Function>(f), + std::forward<Args>(args)...); } -template <class Function, class ...Args> -[[nodiscard]] -auto runWithPromise(Function &&f, Args &&...args) -{ - return runWithPromise(QThreadPool::globalInstance(), std::forward<Function>(f), std::forward<Args>(args)...); -} +#undef QTCONCURRENT_RUN_NODISCARD } //namespace QtConcurrent -#endif // Q_CLANG_QDOC +#endif // Q_QDOC QT_END_NAMESPACE |