/**************************************************************************** ** ** Copyright (C) 2016 The Qt Company Ltd. ** Copyright (C) 2017 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Giuseppe D'Angelo ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtCore 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$ ** ****************************************************************************/ #ifndef QTHREAD_H #define QTHREAD_H #include #include // For QThread::create. The configure-time test just checks for the availability // of std::future and std::async; for the C++17 codepath we perform some extra // checks here (for std::invoke and C++14 lambdas). #if QT_CONFIG(cxx11_future) # include // for std::async # include // for std::invoke; no guard needed as it's a C++98 header # if defined(__cpp_lib_invoke) && __cpp_lib_invoke >= 201411 \ && defined(__cpp_init_captures) && __cpp_init_captures >= 201304 \ && defined(__cpp_generic_lambdas) && __cpp_generic_lambdas >= 201304 # define QTHREAD_HAS_VARIADIC_CREATE # endif #endif QT_BEGIN_NAMESPACE class QThreadData; class QThreadPrivate; class QAbstractEventDispatcher; class Q_CORE_EXPORT QThread : public QObject { Q_OBJECT public: static Qt::HANDLE currentThreadId() noexcept Q_DECL_PURE_FUNCTION; static QThread *currentThread(); static int idealThreadCount() noexcept; static void yieldCurrentThread(); explicit QThread(QObject *parent = nullptr); ~QThread(); enum Priority { IdlePriority, LowestPriority, LowPriority, NormalPriority, HighPriority, HighestPriority, TimeCriticalPriority, InheritPriority }; void setPriority(Priority priority); Priority priority() const; bool isFinished() const; bool isRunning() const; void requestInterruption(); bool isInterruptionRequested() const; void setStackSize(uint stackSize); uint stackSize() const; void exit(int retcode = 0); QAbstractEventDispatcher *eventDispatcher() const; void setEventDispatcher(QAbstractEventDispatcher *eventDispatcher); bool event(QEvent *event) override; int loopLevel() const; #ifdef Q_CLANG_QDOC template static QThread *create(Function &&f, Args &&... args); template static QThread *create(Function &&f); #else # if QT_CONFIG(cxx11_future) # ifdef QTHREAD_HAS_VARIADIC_CREATE template static QThread *create(Function &&f, Args &&... args); # else template static QThread *create(Function &&f); # endif // QTHREAD_HAS_VARIADIC_CREATE # endif // QT_CONFIG(cxx11_future) #endif // Q_CLANG_QDOC public Q_SLOTS: void start(Priority = InheritPriority); void terminate(); void quit(); public: bool wait(QDeadlineTimer deadline = QDeadlineTimer(QDeadlineTimer::Forever)); // ### Qt6 inline this function bool wait(unsigned long time); static void sleep(unsigned long); static void msleep(unsigned long); static void usleep(unsigned long); Q_SIGNALS: void started(QPrivateSignal); void finished(QPrivateSignal); protected: virtual void run(); int exec(); static void setTerminationEnabled(bool enabled = true); protected: QThread(QThreadPrivate &dd, QObject *parent = nullptr); private: Q_DECLARE_PRIVATE(QThread) #if QT_CONFIG(cxx11_future) static QThread *createThreadImpl(std::future &&future); #endif friend class QCoreApplication; friend class QThreadData; }; #if QT_CONFIG(cxx11_future) #if defined(QTHREAD_HAS_VARIADIC_CREATE) || defined(Q_CLANG_QDOC) // C++17: std::thread's constructor complying call template QThread *QThread::create(Function &&f, Args &&... args) { using DecayedFunction = typename std::decay::type; auto threadFunction = [f = static_cast(std::forward(f))](auto &&... largs) mutable -> void { (void)std::invoke(std::move(f), std::forward(largs)...); }; return createThreadImpl(std::async(std::launch::deferred, std::move(threadFunction), std::forward(args)...)); } #elif defined(__cpp_init_captures) && __cpp_init_captures >= 201304 // C++14: implementation for just one callable template QThread *QThread::create(Function &&f) { using DecayedFunction = typename std::decay::type; auto threadFunction = [f = static_cast(std::forward(f))]() mutable -> void { (void)f(); }; return createThreadImpl(std::async(std::launch::deferred, std::move(threadFunction))); } #else // C++11: same as C++14, but with a workaround for not having generalized lambda captures namespace QtPrivate { template struct Callable { explicit Callable(Function &&f) : m_function(std::forward(f)) { } // Apply the same semantics of a lambda closure type w.r.t. the special // member functions, if possible: delete the copy assignment operator, // bring back all the others as per the RO5 (cf. §8.1.5.1/11 [expr.prim.lambda.closure]) ~Callable() = default; Callable(const Callable &) = default; Callable(Callable &&) = default; Callable &operator=(const Callable &) = delete; Callable &operator=(Callable &&) = default; void operator()() { (void)m_function(); } typename std::decay::type m_function; }; } // namespace QtPrivate template QThread *QThread::create(Function &&f) { return createThreadImpl(std::async(std::launch::deferred, QtPrivate::Callable(std::forward(f)))); } #endif // QTHREAD_HAS_VARIADIC_CREATE #endif // QT_CONFIG(cxx11_future) QT_END_NAMESPACE #endif // QTHREAD_H