From d65a1a12cdca9b0483ddafe2b3f5fa514263d818 Mon Sep 17 00:00:00 2001
From: Ivan Egorov <me@egori.ch>
Date: Thu, 4 Nov 2021 18:07:37 +0100
Subject: [PATCH] Make sync_wait a proper CPO.

Also match piped API of sync_wait and sync_wait_r.
---
 include/unifex/sync_wait.hpp |  52 +++++++++-----
 test/sync_wait_test.cpp      | 133 +++++++++++++++++++++++++++++++++++
 2 files changed, 168 insertions(+), 17 deletions(-)
 create mode 100644 test/sync_wait_test.cpp

diff --git a/include/unifex/sync_wait.hpp b/include/unifex/sync_wait.hpp
index 7a1092485..657bced88 100644
--- a/include/unifex/sync_wait.hpp
+++ b/include/unifex/sync_wait.hpp
@@ -140,32 +140,23 @@ std::optional<Result> _impl(Sender&& sender) {
 }
 } // namespace _sync_wait
 
-namespace _sync_wait_cpo {
+namespace _sync_wait_r_cpo {
+  template <typename Result>
   struct _fn {
     template(typename Sender)
-      (requires typed_sender<Sender>)
-    auto operator()(Sender&& sender) const
-        -> std::optional<sender_single_value_result_t<remove_cvref_t<Sender>>> {
-      using Result = sender_single_value_result_t<remove_cvref_t<Sender>>;
-      return _sync_wait::_impl<Result>((Sender&&) sender);
+      (requires sender<Sender>)
+    decltype(auto) operator()(Sender&& sender) const {
+      return tag_invoke(_fn{}, (Sender &&) sender);
     }
     constexpr auto operator()() const
-        noexcept(is_nothrow_callable_v<
-          tag_t<bind_back>, _fn>)
-        -> bind_back_result_t<_fn> {
+        noexcept(is_nothrow_callable_v<tag_t<bind_back>, _fn>)
+            -> bind_back_result_t<_fn> {
       return bind_back(*this);
     }
-  };
-} // namespace _sync_wait_cpo
-
-inline constexpr _sync_wait_cpo::_fn sync_wait {};
 
-namespace _sync_wait_r_cpo {
-  template <typename Result>
-  struct _fn {
     template(typename Sender)
       (requires sender<Sender>)
-    decltype(auto) operator()(Sender&& sender) const {
+    friend decltype(auto) tag_invoke(_fn, Sender&& sender) {
       using Result2 = non_void_t<wrap_reference_t<decay_rvalue_t<Result>>>;
       return _sync_wait::_impl<Result2>((Sender&&) sender);
     }
@@ -175,6 +166,33 @@ namespace _sync_wait_r_cpo {
 template <typename Result>
 inline constexpr _sync_wait_r_cpo::_fn<Result> sync_wait_r {};
 
+namespace _sync_wait_cpo {
+struct _fn {
+  template(typename Sender)
+      (requires typed_sender<Sender>)
+          auto operator()(Sender&& sender) const
+      -> std::optional<sender_single_value_result_t<remove_cvref_t<Sender>>> {
+    return tag_invoke(_fn{}, (Sender &&) sender);
+  }
+  constexpr auto operator()() const
+      noexcept(is_nothrow_callable_v<
+               tag_t<bind_back>, _fn>)
+          -> bind_back_result_t<_fn> {
+    return bind_back(*this);
+  }
+
+  template(typename Sender)
+    (requires typed_sender<Sender>)
+  friend auto tag_invoke(_fn, Sender&& sender)
+      -> std::optional<sender_single_value_result_t<remove_cvref_t<Sender>>> {
+    using Result = sender_single_value_result_t<remove_cvref_t<Sender>>;
+    return tag_invoke(tag_t<sync_wait_r<Result>>{}, (Sender&&) sender);
+  }
+};
+} // namespace _sync_wait_cpo
+
+inline constexpr _sync_wait_cpo::_fn sync_wait {};
+
 } // namespace unifex
 
 #include <unifex/detail/epilogue.hpp>
diff --git a/test/sync_wait_test.cpp b/test/sync_wait_test.cpp
new file mode 100644
index 000000000..f0489ebd1
--- /dev/null
+++ b/test/sync_wait_test.cpp
@@ -0,0 +1,133 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * Licensed under the Apache License Version 2.0 with LLVM Exceptions
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *   https://llvm.org/LICENSE.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language go4verning permissions and
+ * limitations under the License.
+ */
+#include <unifex/just.hpp>
+#include <unifex/let_done.hpp>
+#include <unifex/scheduler_concepts.hpp>
+#include <unifex/sequence.hpp>
+#include <unifex/stop_when.hpp>
+#include <unifex/sync_wait.hpp>
+#include <unifex/then.hpp>
+#include <unifex/timed_single_thread_context.hpp>
+
+#include <chrono>
+#include <iostream>
+
+#include <gtest/gtest.h>
+
+using namespace unifex;
+
+template <typename R>
+struct CpoTestSenderOp {
+  void start() noexcept { set_value(std::move(rec), 12); }
+
+  R rec;
+};
+
+struct CpoTestSenderSyncWaitR {
+  template <
+      template <typename...>
+      class Variant,
+      template <typename...>
+      class Tuple>
+  using value_types = Variant<Tuple<int>>;
+
+  template <template <typename...> class Variant>
+  using error_types = Variant<>;
+
+  static constexpr bool sends_done = false;
+
+  friend auto tag_invoke(tag_t<sync_wait_r<int>>, CpoTestSenderSyncWaitR) {
+    return std::make_optional<int>(42);
+  }
+
+  template <typename Receiver>
+  friend auto
+  tag_invoke(tag_t<connect>, CpoTestSenderSyncWaitR, Receiver&& rec) {
+    return CpoTestSenderOp<Receiver>{(Receiver &&) rec};
+  }
+};
+
+struct CpoTestSenderSyncWait {
+  template <
+      template <typename...>
+      class Variant,
+      template <typename...>
+      class Tuple>
+  using value_types = Variant<Tuple<int>>;
+
+  template <template <typename...> class Variant>
+  using error_types = Variant<>;
+
+  static constexpr bool sends_done = false;
+
+  friend auto tag_invoke(tag_t<sync_wait>, CpoTestSenderSyncWait) {
+    return std::make_optional<int>(42);
+  }
+
+  template <typename Receiver>
+  friend auto
+  tag_invoke(tag_t<connect>, CpoTestSenderSyncWait, Receiver&& rec) {
+    return CpoTestSenderOp<Receiver>{(Receiver &&) rec};
+  }
+};
+
+TEST(SyncWait, CpoSyncWaitR) {
+  // CpoTestSenderSyncWaitR redefines `sync_wait_r<int>` and this also affects
+  // `sync_wait`.
+  std::optional<int> i = sync_wait_r<int>(CpoTestSenderSyncWaitR{});
+  ASSERT_TRUE(i.has_value());
+  EXPECT_EQ(*i, 42);
+
+  std::optional<int> j = sync_wait(CpoTestSenderSyncWaitR{});
+  ASSERT_TRUE(j.has_value());
+  EXPECT_EQ(*j, 42);
+}
+
+TEST(SyncWait, CpoSyncWaitRPiped) {
+  // CpoTestSenderSyncWaitR redefines `sync_wait_r<int>` and this also affects
+  // `sync_wait`.
+  std::optional<int> i = CpoTestSenderSyncWaitR{} | sync_wait_r<int>();
+  ASSERT_TRUE(i.has_value());
+  EXPECT_EQ(*i, 42);
+
+  std::optional<int> j = CpoTestSenderSyncWaitR{} | sync_wait();
+  ASSERT_TRUE(j.has_value());
+  EXPECT_EQ(*j, 42);
+}
+
+TEST(SyncWait, CpoSyncWait) {
+  // CpoTestSenderSyncWaitR redefines `sync_wait` and this does not affects
+  // `sync_wait_r<int>` which gets the default behaviour of `sync_wait_r`.
+  std::optional<int> i = sync_wait_r<int>(CpoTestSenderSyncWait{});
+  ASSERT_TRUE(i.has_value());
+  EXPECT_EQ(*i, 12);
+
+  std::optional<int> j = sync_wait(CpoTestSenderSyncWait{});
+  ASSERT_TRUE(j.has_value());
+  EXPECT_EQ(*j, 42);
+}
+
+TEST(SyncWait, CpoSyncWaitPiped) {
+  // CpoTestSenderSyncWaitR redefines `sync_wait` and this does not affects
+  // `sync_wait_r<int>` which gets the default behaviour of `sync_wait_r`.
+  std::optional<int> i = CpoTestSenderSyncWait{} | sync_wait_r<int>();
+  ASSERT_TRUE(i.has_value());
+  EXPECT_EQ(*i, 12);
+
+  std::optional<int> j = CpoTestSenderSyncWait{} | sync_wait();
+  ASSERT_TRUE(j.has_value());
+  EXPECT_EQ(*j, 42);
+}