stop_token: inplace_stop_callback全メンバ (#1384)

yohhoy · yohhoy · commit c75607bc6745 · 2025-04-07T18:26:15.000+09:00
- stop_callback/op_constructor P2300R10追従
- stop_callback/op_destructor P2300R10追従
diff --git a/reference/stop_token.md b/reference/stop_token.md
@@ -5,7 +5,7 @@
 `<stop_token>`ヘッダは、マルチスレッド処理や非同期処理おける停止要求の状態 `停止状態` を扱うクラスを定義する。
 
 - [`stop_token`](stop_token/stop_token.md), [`stop_source`](stop_token/stop_source.md), [`stop_callback`](stop_token/stop_callback.md)は停止状態を共有所有する。最後に破棄されたオブジェクトが停止状態を自動的に解放する。
-- [`inplace_stop_source`](stop_token/inplace_stop_source.md)は停止状態をメンバとして直接所有する。[`inplace_stop_token`](stop_token/inplace_stop_token.md)と[`inplace_stop_callback`](stop_token/inplace_stop_callback.md.nolink)は停止状態の所有には関与しない。
+- [`inplace_stop_source`](stop_token/inplace_stop_source.md)は停止状態をメンバとして直接所有する。[`inplace_stop_token`](stop_token/inplace_stop_token.md)と[`inplace_stop_callback`](stop_token/inplace_stop_callback.md)は停止状態の所有には関与しない。
 
 
 ## コンセプト
@@ -22,9 +22,9 @@
 | [`stop_callback`](stop_token/stop_callback.md)| [`stop_source`](stop_token/stop_source.md)停止要求に応じて呼び出されるコールバック (class template) | C++20 |
 | [`nostopstate`](stop_token/nostopstate.md)    | 停止状態を扱わない[`stop_source`](stop_token/stop_source.md)構築用タグ (class) | C++20 |
 | [`never_stop_token`](stop_token/never_stop_token.md) | 停止不可能な停止トークン (class) | C++26 |
-| [`inplace_stop_token`](stop_token/inplace_stop_token.md) | [`inplace_stop_source`](stop_token/inplace_stop_source.md)の停止トークン (class) | C++26 |
-| [`inplace_stop_source`](stop_token/inplace_stop_source.md) | 停止状態を直接所有する停止要求インタフェース (class) | C++26 |
-| [`inplace_stop_callback`](stop_token/inplace_stop_callback.md.nolink) | [`inplace_stop_source`](stop_token/inplace_stop_source.md)停止要求に応じて呼び出されるコールバック (class template) | C++26 |
+| [`inplace_stop_token`](stop_token/inplace_stop_token.md)       | [`inplace_stop_source`](stop_token/inplace_stop_source.md)の停止トークン (class) | C++26 |
+| [`inplace_stop_source`](stop_token/inplace_stop_source.md)     | 停止状態を直接所有する停止要求インタフェース (class) | C++26 |
+| [`inplace_stop_callback`](stop_token/inplace_stop_callback.md) | [`inplace_stop_source`](stop_token/inplace_stop_source.md)停止要求に応じて呼び出されるコールバック (class template) | C++26 |
 | [`stop_callback_for_t`](stop_token/stop_callback_for_t.md) | 対応するコールバック型を取得 (alias template) | C++26 |
 
 
diff --git a/reference/stop_token/inplace_stop_callback.md b/reference/stop_token/inplace_stop_callback.md
@@ -0,0 +1,101 @@
+# inplace_stop_callback
+* stop_token[meta header]
+* std[meta namespace]
+* class template[meta id-type]
+* cpp26[meta cpp]
+
+```cpp
+namespace std {
+  template<class CallbackFn>
+  class inplace_stop_callback;
+}
+```
+
+## 概要
+`inplace_stop_callback`クラステンプレートは、停止要求が作成された際に呼び出されるコールバックを表す。
+
+
+## 適格要件
+テンプレート引数`CallbackFn`が[`invocable`](/reference/concepts/invokable.md.nolink)および[`destructible`](/reference/concepts/destructible.md)を満たすこと。
+
+
+## メンバ関数
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|-------|
+| [`(constructor)`](inplace_stop_callback/op_constructor.md)| コンストラクタ | C++26 |
+| [`(destructor)`](inplace_stop_callback/op_destructor.md)  | デストラクタ | C++26 |
+| `operator=(const inplace_stop_callback&) = delete;` | 代入演算子 | C++26 |
+| `operator=(inplace_stop_callback&&) = delete;`      | 代入演算子 | C++26 |
+
+## メンバ型
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|-------|
+| `callback_type` | `CallbackFn` | C++26 |
+
+## 推論補助
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|-------|
+| [`(deduction_guide)`](inplace_stop_callback/op_deduction_guide.md) | クラステンプレートの推論補助 | C++26 |
+
+
+## 例
+```cpp example
+#include <cassert>
+#include <stop_token>
+#include <string>
+
+int main()
+{
+  std::string msg;
+
+  std::inplace_stop_source ss;
+  std::inplace_stop_token st = ss.get_token();
+  std::inplace_stop_callback cb1(st, [&] { msg += "hello"; });
+
+  assert(msg == "");
+
+  ss.request_stop();
+
+  // 停止要求が作成される前に登録されていたコールバック関数は、
+  // 停止要求が作成された際にその中で呼び出される
+  assert(msg == "hello");
+
+  std::inplace_stop_callback cb2(st, [&] { msg += " world"; });
+
+  // 停止要求が作成されたあとに登録されたコールバック関数は、
+  // std::inplace_stop_callback クラスのコンストラクタの中で即座に呼び出される
+  assert(msg == "hello world");
+}
+```
+* std::inplace_stop_callback[color ff0000]
+* std::inplace_stop_token[link inplace_stop_token.md]
+* std::inplace_stop_source[link inplace_stop_source.md]
+* request_stop()[link inplace_stop_source/request_stop.md]
+* get_token()[link inplace_stop_source/get_token.md]
+
+### 出力
+```
+```
+
+## バージョン
+### 言語
+- C++26
+
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+
+## 関連項目
+- [`inplace_stop_token`](inplace_stop_token.md)
+- [`inplace_stop_source`](inplace_stop_source.md)
+
+
+## 参照
+- [P2300R10 `std::execution`](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2300r10.html)
diff --git a/reference/stop_token/inplace_stop_callback/op_constructor.md b/reference/stop_token/inplace_stop_callback/op_constructor.md
@@ -0,0 +1,49 @@
+# コンストラクタ
+* stop_token[meta header]
+* std[meta namespace]
+* inplace_stop_callback[meta class]
+* function[meta id-type]
+* cpp26[meta cpp]
+
+```cpp
+template<class Initializer>
+explicit inplace_stop_callback(inplace_stop_token st, Initializer&& init)
+  noexcept(is_nothrow_constructible_v<CallbackFn, Initializer>);  // (1)
+
+inplace_stop_callback(const inplace_stop_callback&) = delete;  // (2)
+inplace_stop_callback(inplace_stop_callback&&) = delete;       // (3)
+```
+* inplace_stop_token[link ../inplace_stop_token.md]
+* is_nothrow_constructible_v[link /reference/type_traits/is_nothrow_constructible.md]
+
+## 概要
+- (1) : [`inplace_stop_token`](../inplace_stop_token.md)を受け取り、その`inplace_stop_token`が参照する停止状態への停止要求に応じて呼び出されるコールバックを登録する。
+- (2) : コピーコンストラクタ。コピー不可。
+- (3) : ムーブコンストラクタ。ムーブ不可。
+
+
+## テンプレートパラメータ制約
+クラステンプレートのテンプレート引数`CallbackFn`とコンストラクタのテンプレート引数`Initializer`は[`constructible_from`](/reference/concepts/constructible_from.md)`<CallbackFn, Initializer>`制約を満たすこと。
+
+
+## 効果
+説明専用のメンバ変数`callback-fn`を[`std::forward`](/reference/utility/forward.md)`<CallbackFn>(init)`で初期化し、[停止可能コールバック登録](../stoppable_token.md)を実行する。
+
+
+## 例外
+説明専用のメンバ変数`callback-fn`を`init`で初期化する際に例外が発生する場合は、その例外を送出する。
+
+
+## バージョン
+### 言語
+- C++26
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+
+## 参照
+- [P2300R10 `std::execution`](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2300r10.html)
diff --git a/reference/stop_token/inplace_stop_callback/op_deduction_guide.md b/reference/stop_token/inplace_stop_callback/op_deduction_guide.md
@@ -0,0 +1,58 @@
+# 推論補助
+* stop_token[meta header]
+* std[meta namespace]
+* inplace_stop_callback[meta class]
+* cpp26[meta cpp]
+
+```cpp
+namespace std {
+  template <class CallbackFn>
+  inplace_stop_callback(inplace_stop_token, CallbackFn) -> inplace_stop_callback<CallbackFn>;
+}
+```
+* inplace_stop_token[link ../inplace_stop_token.md]
+
+## 概要
+[`inplace_stop_callback`](../inplace_stop_callback.md)クラステンプレートの型推論補助。
+
+## 例
+```cpp example
+#include <stop_token>
+#include <type_traits>
+
+struct X {
+  void operator()() {}
+};
+
+int main()
+{
+  X x;
+  std::inplace_stop_token st;
+  std::inplace_stop_callback cb { st, x };
+
+  static_assert(std::is_same_v<decltype(cb)::callback_type, X>);
+}
+```
+* std::inplace_stop_token[link ../inplace_stop_token.md]
+* std::inplace_stop_callback[link ../inplace_stop_callback.md]
+
+### 出力
+```
+```
+
+
+## バージョン
+### 言語
+- C++26
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+## 関連項目
+- [C++17 クラステンプレートのテンプレート引数推論](/lang/cpp17/type_deduction_for_class_templates.md)
+
+## 参照
+- [P2300R10 `std::execution`](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2300r10.html)
diff --git a/reference/stop_token/inplace_stop_callback/op_destructor.md b/reference/stop_token/inplace_stop_callback/op_destructor.md
@@ -0,0 +1,28 @@
+# デストラクタ
+* stop_token[meta header]
+* std[meta namespace]
+* inplace_stop_callback[meta class]
+* function[meta id-type]
+* cpp26[meta cpp]
+
+```cpp
+~inplace_stop_callback();
+```
+
+## 効果
+[停止可能コールバック登録解除](../stoppable_token.md)を実行する。
+
+
+## バージョン
+### 言語
+- C++26
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+
+## 参照
+- [P2300R10 `std::execution`](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2300r10.html)
diff --git a/reference/stop_token/inplace_stop_source.md b/reference/stop_token/inplace_stop_source.md
@@ -58,7 +58,7 @@ int main()
 ```
 * std::inplace_stop_source[color ff0000]
 * std::inplace_stop_token[link inplace_stop_token.md]
-* std::inplace_stop_callback[link inplace_stop_callback.md.nolink]
+* std::inplace_stop_callback[link inplace_stop_callback.md]
 * stop_requested()[link inplace_stop_token/stop_requested.md]
 * request_stop()[link inplace_stop_source/request_stop.md]
 * get_token()[link inplace_stop_source/get_token.md]
@@ -81,7 +81,7 @@ int main()
 
 ## 関連項目
 - [`inplace_stop_token`](inplace_stop_token.md)
-- [`inplace_stop_callback`](inplace_stop_callback.md.nolink)
+- [`inplace_stop_callback`](inplace_stop_callback.md)
 
 
 ## 参照
diff --git a/reference/stop_token/inplace_stop_token.md b/reference/stop_token/inplace_stop_token.md
@@ -74,7 +74,7 @@ int main()
 
 ## 関連項目
 - [`inplace_stop_source`](inplace_stop_source.md)
-- [`inplace_stop_callback`](inplace_stop_callback.md.nolink)
+- [`inplace_stop_callback`](inplace_stop_callback.md)
 
 
 ## 参照
diff --git a/reference/stop_token/inplace_stop_token/callback_type.md b/reference/stop_token/inplace_stop_token/callback_type.md
@@ -9,7 +9,7 @@
 template<class CallbackFn>
 using callback_type = inplace_stop_callback<CallbackFn>;
 ```
-* inplace_stop_callback[link ../inplace_stop_callback.md.nolink]
+* inplace_stop_callback[link ../inplace_stop_callback.md]
 
 ## 概要
 `inplace_stop_token`に対応するコールバック型。
diff --git a/reference/stop_token/stop_callback.md b/reference/stop_token/stop_callback.md
@@ -14,6 +14,11 @@ namespace std {
 ## 概要
 `stop_callback`クラステンプレートは、停止要求が作成された際に呼び出されるコールバックを表す。
 
+
+## 適格要件
+テンプレート引数`CallbackFn`が[`invocable`](/reference/concepts/invokable.md.nolink)および[`destructible`](/reference/concepts/destructible.md)を満たすこと。
+
+
 ## メンバ関数
 
 | 名前 | 説明 | 対応バージョン |
@@ -35,11 +40,6 @@ namespace std {
 |------|------|-------|
 | [`(deduction_guide)`](stop_callback/op_deduction_guide.md) | クラステンプレートの推論補助 | C++20 |
 
-## 適格要件
-テンプレート引数の`CallbackFn`は[`invocable`](/reference/concepts/invokable.md.nolink)と[`destructible`](/reference/concepts/destructible.md)制約を満たさなければならい。
-
-## 事前条件
-テンプレート引数の`CallbackFn`は[`invocable`](/reference/concepts/invokable.md.nolink)と[`destructible`](/reference/concepts/destructible.md)制約を満たさなければならい。
 
 ## 例
 ```cpp example
@@ -91,3 +91,11 @@ int main()
 - [ICC](/implementation.md#icc): ??
 - [Visual C++](/implementation.md#visual_cpp): ??
 
+
+## 関連項目
+- [`stop_token`](stop_token.md)
+- [`stop_source`](stop_source.md)
+
+
+## 参照
+- [P0660R10 Stop token and joining thread](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0660r10.pdf)
diff --git a/reference/stop_token/stop_callback/op_constructor.md b/reference/stop_token/stop_callback/op_constructor.md
diff --git a/reference/stop_token/stop_callback/op_deduction_guide.md b/reference/stop_token/stop_callback/op_deduction_guide.md
diff --git a/reference/stop_token/stop_callback/op_destructor.md b/reference/stop_token/stop_callback/op_destructor.md
diff --git a/reference/stop_token/stoppable-source.md b/reference/stop_token/stoppable-source.md
