[syncstream.syncbuf] - C++23 → Trunk

Files changed (1) hide show

tmp/tmpkzxsmvnh/{from.md → to.md} +16 -16

tmp/tmpkzxsmvnh/{from.md → to.md} RENAMED Viewed

@@ -6,13 +6,13 @@
 namespace std {
   template<class charT, class traits = char_traits<charT>, class Allocator = allocator<charT>>
   class basic_syncbuf : public basic_streambuf<charT, traits> {
   public:
     using char_type      = charT;
-    using int_type       = typename traits::int_type;
-    using pos_type       = typename traits::pos_type;
-    using off_type       = typename traits::off_type;
     using traits_type    = traits;
     using allocator_type = Allocator;
     using streambuf_type = basic_streambuf<charT, traits>;
@@ -39,11 +39,11 @@ namespace std {
     // [syncstream.syncbuf.virtuals], overridden virtual functions
     int sync() override;
   private:
     streambuf_type* wrapped;    // exposition only
-    bool emit_on_sync{};        // exposition only
   };
 }
 ```
 Class template `basic_syncbuf` stores character data written to it,
@@ -58,11 +58,11 @@ wrapped stream buffer object.
 ``` cpp
 basic_syncbuf(streambuf_type* obuf, const Allocator& allocator);
 ```
-*Effects:* Sets `wrapped` to `obuf`.
 *Ensures:* `get_wrapped() == obuf` and `get_allocator() == allocator`
 are `true`.
 *Throws:* Nothing unless an exception is thrown by the construction of a
@@ -133,13 +133,13 @@ void swap(basic_syncbuf& other);
 ``` cpp
 bool emit();
 ```
 *Effects:* Atomically transfers the associated output of `*this` to the
-stream buffer `*wrapped`, so that it appears in the output stream as a
-contiguous sequence of characters. `wrapped->pubsync()` is called if and
-only if a call was made to `sync()` since the most recent call to
 `emit()`, if any.
 *Synchronization:* All `emit()` calls transferring characters to the
 same stream buffer object appear to execute in a total order consistent
 with the “happens before” relation [[intro.races]], where each `emit()`
@@ -148,23 +148,23 @@ call synchronizes with subsequent `emit()` calls in that total order.
 *Ensures:* On success, the associated output is empty.
 *Returns:* `true` if all of the following conditions hold; otherwise
 `false`:
-- `wrapped == nullptr` is `false`.
 - All of the characters in the associated output were successfully
   transferred.
-- The call to `wrapped->pubsync()` (if any) succeeded.
-*Remarks:* May call member functions of `wrapped` while holding a lock
-uniquely associated with `wrapped`.
 ``` cpp
 streambuf_type* get_wrapped() const noexcept;
 ```
-*Returns:* `wrapped`.
 ``` cpp
 allocator_type get_allocator() const noexcept;
 ```
@@ -173,22 +173,22 @@ assignment operator.
 ``` cpp
 void set_emit_on_sync(bool b) noexcept;
 ```
-*Effects:* `emit_on_sync = b`.
 #### Overridden virtual functions <a id="syncstream.syncbuf.virtuals">[[syncstream.syncbuf.virtuals]]</a>
 ``` cpp
 int sync() override;
 ```
 *Effects:* Records that the wrapped stream buffer is to be flushed.
-Then, if `emit_on_sync` is `true`, calls `emit()`.
-[*Note 1*: If `emit_on_sync` is `false`, the actual flush is delayed
 until a call to `emit()`. — *end note*]
 *Returns:* If `emit()` was called and returned `false`, returns `-1`;
 otherwise `0`.

 namespace std {
   template<class charT, class traits = char_traits<charT>, class Allocator = allocator<charT>>
   class basic_syncbuf : public basic_streambuf<charT, traits> {
   public:
     using char_type      = charT;
+    using int_type       = traits::int_type;
+    using pos_type       = traits::pos_type;
+    using off_type       = traits::off_type;
     using traits_type    = traits;
     using allocator_type = Allocator;
     using streambuf_type = basic_streambuf<charT, traits>;
     // [syncstream.syncbuf.virtuals], overridden virtual functions
     int sync() override;
   private:
     streambuf_type* wrapped;    // exposition only
+    bool emit-on-sync{};        // exposition only
   };
 }
 ```
 Class template `basic_syncbuf` stores character data written to it,
 ``` cpp
 basic_syncbuf(streambuf_type* obuf, const Allocator& allocator);
 ```
+*Effects:* Sets *wrapped* to `obuf`.
 *Ensures:* `get_wrapped() == obuf` and `get_allocator() == allocator`
 are `true`.
 *Throws:* Nothing unless an exception is thrown by the construction of a
 ``` cpp
 bool emit();
 ```
 *Effects:* Atomically transfers the associated output of `*this` to the
+stream buffer `*`*`wrapped`*, so that it appears in the output stream as
+a contiguous sequence of characters. *`wrapped`*`->pubsync()` is called
+if and only if a call was made to `sync()` since the most recent call to
 `emit()`, if any.
 *Synchronization:* All `emit()` calls transferring characters to the
 same stream buffer object appear to execute in a total order consistent
 with the “happens before” relation [[intro.races]], where each `emit()`
 *Ensures:* On success, the associated output is empty.
 *Returns:* `true` if all of the following conditions hold; otherwise
 `false`:
+- *`wrapped`*` == nullptr` is `false`.
 - All of the characters in the associated output were successfully
   transferred.
+- The call to *`wrapped`*`->pubsync()` (if any) succeeded.
+*Remarks:* May call member functions of *wrapped* while holding a lock
+uniquely associated with *wrapped*.
 ``` cpp
 streambuf_type* get_wrapped() const noexcept;
 ```
+*Returns:* *wrapped*.
 ``` cpp
 allocator_type get_allocator() const noexcept;
 ```
 ``` cpp
 void set_emit_on_sync(bool b) noexcept;
 ```
+*Effects:* *`emit-on-sync`*` = b`.
 #### Overridden virtual functions <a id="syncstream.syncbuf.virtuals">[[syncstream.syncbuf.virtuals]]</a>
 ``` cpp
 int sync() override;
 ```
 *Effects:* Records that the wrapped stream buffer is to be flushed.
+Then, if *emit-on-sync* is `true`, calls `emit()`.
+[*Note 1*: If *emit-on-sync* is `false`, the actual flush is delayed
 until a call to `emit()`. — *end note*]
 *Returns:* If `emit()` was called and returned `false`, returns `-1`;
 otherwise `0`.

Diff to HTML by rtfpessoa