xref: /llvm-project/libcxx/include/__cxx03/__stop_token/stop_source.h (revision ce7771902dc50d900de639d499a60486b83f70e0)
1e78f53d1SNikolas Klauser // -*- C++ -*-
2e78f53d1SNikolas Klauser //===----------------------------------------------------------------------===//
3e78f53d1SNikolas Klauser //
4e78f53d1SNikolas Klauser // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5e78f53d1SNikolas Klauser // See https://llvm.org/LICENSE.txt for license information.
6e78f53d1SNikolas Klauser // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7e78f53d1SNikolas Klauser //
8e78f53d1SNikolas Klauser //===----------------------------------------------------------------------===//
9e78f53d1SNikolas Klauser 
10*ce777190SNikolas Klauser #ifndef _LIBCPP___CXX03___STOP_TOKEN_STOP_SOURCE_H
11*ce777190SNikolas Klauser #define _LIBCPP___CXX03___STOP_TOKEN_STOP_SOURCE_H
12e78f53d1SNikolas Klauser 
1373fbae83SNikolas Klauser #include <__cxx03/__config>
1473fbae83SNikolas Klauser #include <__cxx03/__stop_token/intrusive_shared_ptr.h>
1573fbae83SNikolas Klauser #include <__cxx03/__stop_token/stop_state.h>
1673fbae83SNikolas Klauser #include <__cxx03/__stop_token/stop_token.h>
1773fbae83SNikolas Klauser #include <__cxx03/__utility/move.h>
18e78f53d1SNikolas Klauser 
19e78f53d1SNikolas Klauser #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
20e78f53d1SNikolas Klauser #  pragma GCC system_header
21e78f53d1SNikolas Klauser #endif
22e78f53d1SNikolas Klauser 
23e78f53d1SNikolas Klauser _LIBCPP_BEGIN_NAMESPACE_STD
24e78f53d1SNikolas Klauser 
25e78f53d1SNikolas Klauser #if _LIBCPP_STD_VER >= 20 && !defined(_LIBCPP_HAS_NO_EXPERIMENTAL_STOP_TOKEN) && !defined(_LIBCPP_HAS_NO_THREADS)
26e78f53d1SNikolas Klauser 
27e78f53d1SNikolas Klauser struct nostopstate_t {
28e78f53d1SNikolas Klauser   explicit nostopstate_t() = default;
29e78f53d1SNikolas Klauser };
30e78f53d1SNikolas Klauser 
31e78f53d1SNikolas Klauser inline constexpr nostopstate_t nostopstate{};
32e78f53d1SNikolas Klauser 
33e78f53d1SNikolas Klauser class _LIBCPP_AVAILABILITY_SYNC stop_source {
34e78f53d1SNikolas Klauser public:
35e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI stop_source() : __state_(new __stop_state()) { __state_->__increment_stop_source_counter(); }
36e78f53d1SNikolas Klauser 
37e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI explicit stop_source(nostopstate_t) noexcept : __state_(nullptr) {}
38e78f53d1SNikolas Klauser 
39e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI stop_source(const stop_source& __other) noexcept : __state_(__other.__state_) {
40e78f53d1SNikolas Klauser     if (__state_) {
41e78f53d1SNikolas Klauser       __state_->__increment_stop_source_counter();
42e78f53d1SNikolas Klauser     }
43e78f53d1SNikolas Klauser   }
44e78f53d1SNikolas Klauser 
45e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI stop_source(stop_source&& __other) noexcept = default;
46e78f53d1SNikolas Klauser 
47e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI stop_source& operator=(const stop_source& __other) noexcept {
48e78f53d1SNikolas Klauser     // increment `__other` first so that we don't hit 0 in case of self-assignment
49e78f53d1SNikolas Klauser     if (__other.__state_) {
50e78f53d1SNikolas Klauser       __other.__state_->__increment_stop_source_counter();
51e78f53d1SNikolas Klauser     }
52e78f53d1SNikolas Klauser     if (__state_) {
53e78f53d1SNikolas Klauser       __state_->__decrement_stop_source_counter();
54e78f53d1SNikolas Klauser     }
55e78f53d1SNikolas Klauser     __state_ = __other.__state_;
56e78f53d1SNikolas Klauser     return *this;
57e78f53d1SNikolas Klauser   }
58e78f53d1SNikolas Klauser 
59e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI stop_source& operator=(stop_source&&) noexcept = default;
60e78f53d1SNikolas Klauser 
61e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI ~stop_source() {
62e78f53d1SNikolas Klauser     if (__state_) {
63e78f53d1SNikolas Klauser       __state_->__decrement_stop_source_counter();
64e78f53d1SNikolas Klauser     }
65e78f53d1SNikolas Klauser   }
66e78f53d1SNikolas Klauser 
67e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI void swap(stop_source& __other) noexcept { __state_.swap(__other.__state_); }
68e78f53d1SNikolas Klauser 
69e78f53d1SNikolas Klauser   [[nodiscard]] _LIBCPP_HIDE_FROM_ABI stop_token get_token() const noexcept { return stop_token(__state_); }
70e78f53d1SNikolas Klauser 
71e78f53d1SNikolas Klauser   [[nodiscard]] _LIBCPP_HIDE_FROM_ABI bool stop_possible() const noexcept { return __state_ != nullptr; }
72e78f53d1SNikolas Klauser 
73e78f53d1SNikolas Klauser   [[nodiscard]] _LIBCPP_HIDE_FROM_ABI bool stop_requested() const noexcept {
74e78f53d1SNikolas Klauser     return __state_ != nullptr && __state_->__stop_requested();
75e78f53d1SNikolas Klauser   }
76e78f53d1SNikolas Klauser 
77e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI bool request_stop() noexcept { return __state_ && __state_->__request_stop(); }
78e78f53d1SNikolas Klauser 
79e78f53d1SNikolas Klauser   [[nodiscard]] _LIBCPP_HIDE_FROM_ABI friend bool operator==(const stop_source&, const stop_source&) noexcept = default;
80e78f53d1SNikolas Klauser 
81e78f53d1SNikolas Klauser   _LIBCPP_HIDE_FROM_ABI friend void swap(stop_source& __lhs, stop_source& __rhs) noexcept { __lhs.swap(__rhs); }
82e78f53d1SNikolas Klauser 
83e78f53d1SNikolas Klauser private:
84e78f53d1SNikolas Klauser   __intrusive_shared_ptr<__stop_state> __state_;
85e78f53d1SNikolas Klauser };
86e78f53d1SNikolas Klauser 
87e78f53d1SNikolas Klauser #endif // _LIBCPP_STD_VER >= 20
88e78f53d1SNikolas Klauser 
89e78f53d1SNikolas Klauser _LIBCPP_END_NAMESPACE_STD
90e78f53d1SNikolas Klauser 
91*ce777190SNikolas Klauser #endif // _LIBCPP___CXX03___STOP_TOKEN_STOP_SOURCE_H
92