xref: /freebsd/contrib/llvm-project/libcxx/include/coroutine (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1// -*- C++ -*-
2//===----------------------------------------------------------------------===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_COROUTINE
11#define _LIBCPP_COROUTINE
12
13/**
14    coroutine synopsis
15
16namespace std {
17// [coroutine.traits]
18template <class R, class... ArgTypes>
19  struct coroutine_traits;
20// [coroutine.handle]
21template <class Promise = void>
22  struct coroutine_handle;
23// [coroutine.handle.compare]
24constexpr bool operator==(coroutine_handle<> x, coroutine_handle<> y) noexcept;
25constexpr strong_ordering operator<=>(coroutine_handle<> x, coroutine_handle<> y) noexcept;
26// [coroutine.handle.hash]
27template <class T> struct hash;
28template <class P> struct hash<coroutine_handle<P>>;
29// [coroutine.noop]
30struct noop_coroutine_promise;
31template<> struct coroutine_handle<noop_coroutine_promise>;
32using noop_coroutine_handle = coroutine_handle<noop_coroutine_promise>;
33noop_coroutine_handle noop_coroutine() noexcept;
34// [coroutine.trivial.awaitables]
35struct suspend_never;
36struct suspend_always;
37} // namespace std
38
39 */
40
41#include <__assert> // all public C++ headers provide the assertion handler
42#include <__config>
43#include <__coroutine/coroutine_handle.h>
44#include <__coroutine/coroutine_traits.h>
45#include <__coroutine/noop_coroutine_handle.h>
46#include <__coroutine/trivial_awaitables.h>
47#include <version>
48
49// standard-mandated includes
50
51// [coroutine.syn]
52#include <compare>
53
54#ifndef _LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER
55#  pragma GCC system_header
56#endif
57
58#if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
59#  include <iosfwd>
60#  include <type_traits>
61#endif
62
63#endif // _LIBCPP_COROUTINE
64