Init
This commit is contained in:
68
cppdraft/syncstream/syncbuf/assign.md
Normal file
68
cppdraft/syncstream/syncbuf/assign.md
Normal file
@@ -0,0 +1,68 @@
|
||||
[syncstream.syncbuf.assign]
|
||||
|
||||
# 31 Input/output library [[input.output]](./#input.output)
|
||||
|
||||
## 31.11 Synchronized output streams [[syncstream]](syncstream#syncbuf.assign)
|
||||
|
||||
### 31.11.2 Class template basic_syncbuf [[syncstream.syncbuf]](syncstream.syncbuf#assign)
|
||||
|
||||
#### 31.11.2.3 Assignment and swap [syncstream.syncbuf.assign]
|
||||
|
||||
[ð](#lib:operator=,basic_syncbuf)
|
||||
|
||||
`basic_syncbuf& operator=(basic_syncbuf&& rhs);
|
||||
`
|
||||
|
||||
[1](#1)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12742)
|
||||
|
||||
*Effects*: Calls emit() then
|
||||
move assigns from rhs[.](#1.sentence-1)
|
||||
|
||||
After the move assignment *this has the observable state it would have had if
|
||||
it had been move constructed from rhs ([[syncstream.syncbuf.cons]](syncstream.syncbuf.cons "31.11.2.2 Construction and destruction"))[.](#1.sentence-2)
|
||||
|
||||
[2](#2)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12750)
|
||||
|
||||
*Postconditions*:
|
||||
|
||||
- [(2.1)](#2.1)
|
||||
|
||||
rhs.get_wrapped() == nullptr is true.
|
||||
|
||||
- [(2.2)](#2.2)
|
||||
|
||||
this->get_allocator() == rhs.get_allocator() is true whenallocator_traits<Allocator>::propagate_on_container_move_assignment::value is true; otherwise, the allocator is unchanged.
|
||||
|
||||
[3](#3)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12763)
|
||||
|
||||
*Returns*: *this[.](#3.sentence-1)
|
||||
|
||||
[4](#4)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12767)
|
||||
|
||||
*Remarks*: This assignment operator disassociates rhs from its wrapped stream buffer,
|
||||
ensuring destruction of rhs produces no output[.](#4.sentence-1)
|
||||
|
||||
[ð](#lib:swap,basic_syncbuf)
|
||||
|
||||
`void swap(basic_syncbuf& other);
|
||||
`
|
||||
|
||||
[5](#5)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12780)
|
||||
|
||||
*Preconditions*: Eitherallocator_traits<Allocator>::propagate_on_container_swap::value is true orthis->get_allocator() == other.get_allocator() is true[.](#5.sentence-1)
|
||||
|
||||
[6](#6)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12789)
|
||||
|
||||
*Effects*: Exchanges the state of *this and other[.](#6.sentence-1)
|
||||
85
cppdraft/syncstream/syncbuf/cons.md
Normal file
85
cppdraft/syncstream/syncbuf/cons.md
Normal file
@@ -0,0 +1,85 @@
|
||||
[syncstream.syncbuf.cons]
|
||||
|
||||
# 31 Input/output library [[input.output]](./#input.output)
|
||||
|
||||
## 31.11 Synchronized output streams [[syncstream]](syncstream#syncbuf.cons)
|
||||
|
||||
### 31.11.2 Class template basic_syncbuf [[syncstream.syncbuf]](syncstream.syncbuf#cons)
|
||||
|
||||
#### 31.11.2.2 Construction and destruction [syncstream.syncbuf.cons]
|
||||
|
||||
[ð](#lib:basic_syncbuf,constructor)
|
||||
|
||||
`basic_syncbuf(streambuf_type* obuf, const Allocator& allocator);
|
||||
`
|
||||
|
||||
[1](#1)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12669)
|
||||
|
||||
*Effects*: Sets *wrapped* to obuf[.](#1.sentence-1)
|
||||
|
||||
[2](#2)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12673)
|
||||
|
||||
*Postconditions*: get_wrapped() == obuf andget_allocator() == allocator are true[.](#2.sentence-1)
|
||||
|
||||
[3](#3)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12678)
|
||||
|
||||
*Throws*: Nothing unless an exception is thrown
|
||||
by the construction of a mutex or
|
||||
by memory allocation[.](#3.sentence-1)
|
||||
|
||||
[4](#4)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12684)
|
||||
|
||||
*Remarks*: A copy of allocator is used
|
||||
to allocate memory for internal buffers
|
||||
holding the associated output[.](#4.sentence-1)
|
||||
|
||||
[ð](#lib:basic_syncbuf,constructor_)
|
||||
|
||||
`basic_syncbuf(basic_syncbuf&& other);
|
||||
`
|
||||
|
||||
[5](#5)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12697)
|
||||
|
||||
*Postconditions*: The value returned by this->get_wrapped() is the value returned by other.get_wrapped() prior to calling this constructor[.](#5.sentence-1)
|
||||
|
||||
Output stored in other prior to calling this constructor
|
||||
will be stored in *this afterwards[.](#5.sentence-2)
|
||||
|
||||
other.pbase() == other.pptr() andother.get_wrapped() == nullptr are true[.](#5.sentence-3)
|
||||
|
||||
[6](#6)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12710)
|
||||
|
||||
*Remarks*: This constructor disassociates other from its wrapped stream buffer,
|
||||
ensuring destruction of other produces no output[.](#6.sentence-1)
|
||||
|
||||
[ð](#lib:basic_syncbuf,destructor)
|
||||
|
||||
`~basic_syncbuf();
|
||||
`
|
||||
|
||||
[7](#7)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12723)
|
||||
|
||||
*Effects*: Calls emit()[.](#7.sentence-1)
|
||||
|
||||
[8](#8)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12727)
|
||||
|
||||
*Throws*: Nothing[.](#8.sentence-1)
|
||||
|
||||
If an exception is thrown from emit(),
|
||||
the destructor catches and ignores that exception[.](#8.sentence-2)
|
||||
101
cppdraft/syncstream/syncbuf/members.md
Normal file
101
cppdraft/syncstream/syncbuf/members.md
Normal file
@@ -0,0 +1,101 @@
|
||||
[syncstream.syncbuf.members]
|
||||
|
||||
# 31 Input/output library [[input.output]](./#input.output)
|
||||
|
||||
## 31.11 Synchronized output streams [[syncstream]](syncstream#syncbuf.members)
|
||||
|
||||
### 31.11.2 Class template basic_syncbuf [[syncstream.syncbuf]](syncstream.syncbuf#members)
|
||||
|
||||
#### 31.11.2.4 Member functions [syncstream.syncbuf.members]
|
||||
|
||||
[ð](#lib:emit,basic_syncbuf)
|
||||
|
||||
`bool emit();
|
||||
`
|
||||
|
||||
[1](#1)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12802)
|
||||
|
||||
*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[.](#1.sentence-1)
|
||||
|
||||
*wrapped*->pubsync() is called
|
||||
if and only if a call was made to sync() since the most recent call to emit(), if any[.](#1.sentence-2)
|
||||
|
||||
[2](#2)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12812)
|
||||
|
||||
*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]](intro.races "6.10.2.2 Data races")),
|
||||
where each emit() call
|
||||
synchronizes with
|
||||
subsequent emit() calls in that total order[.](#2.sentence-1)
|
||||
|
||||
[3](#3)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12822)
|
||||
|
||||
*Postconditions*: On success, the associated output is empty[.](#3.sentence-1)
|
||||
|
||||
[4](#4)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12826)
|
||||
|
||||
*Returns*: true if all of the following conditions hold;
|
||||
otherwise false:
|
||||
|
||||
- [(4.1)](#4.1)
|
||||
|
||||
*wrapped* == nullptr is false[.](#4.1.sentence-1)
|
||||
|
||||
- [(4.2)](#4.2)
|
||||
|
||||
All of the characters in the associated output were successfully transferred[.](#4.2.sentence-1)
|
||||
|
||||
- [(4.3)](#4.3)
|
||||
|
||||
The call to *wrapped*->pubsync() (if any) succeeded[.](#4.3.sentence-1)
|
||||
|
||||
[5](#5)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12836)
|
||||
|
||||
*Remarks*: May call member functions of *wrapped* while holding a lock uniquely associated with *wrapped*[.](#5.sentence-1)
|
||||
|
||||
[ð](#lib:get_wrapped,basic_syncbuf)
|
||||
|
||||
`streambuf_type* get_wrapped() const noexcept;
|
||||
`
|
||||
|
||||
[6](#6)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12848)
|
||||
|
||||
*Returns*: *wrapped*[.](#6.sentence-1)
|
||||
|
||||
[ð](#lib:get_allocator,basic_syncbuf)
|
||||
|
||||
`allocator_type get_allocator() const noexcept;
|
||||
`
|
||||
|
||||
[7](#7)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12859)
|
||||
|
||||
*Returns*: A copy of the allocator that was set in the constructor or assignment operator[.](#7.sentence-1)
|
||||
|
||||
[ð](#lib:set_emit_on_sync,basic_syncbuf)
|
||||
|
||||
`void set_emit_on_sync(bool b) noexcept;
|
||||
`
|
||||
|
||||
[8](#8)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12870)
|
||||
|
||||
*Effects*: *emit-on-sync* = b[.](#8.sentence-1)
|
||||
32
cppdraft/syncstream/syncbuf/overview.md
Normal file
32
cppdraft/syncstream/syncbuf/overview.md
Normal file
@@ -0,0 +1,32 @@
|
||||
[syncstream.syncbuf.overview]
|
||||
|
||||
# 31 Input/output library [[input.output]](./#input.output)
|
||||
|
||||
## 31.11 Synchronized output streams [[syncstream]](syncstream#syncbuf.overview)
|
||||
|
||||
### 31.11.2 Class template basic_syncbuf [[syncstream.syncbuf]](syncstream.syncbuf#overview)
|
||||
|
||||
#### 31.11.2.1 Overview [syncstream.syncbuf.overview]
|
||||
|
||||
[ð](#lib:basic_syncbuf)
|
||||
|
||||
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>; // [[syncstream.syncbuf.cons]](syncstream.syncbuf.cons "31.11.2.2 Construction and destruction"), construction and destruction basic_syncbuf(): basic_syncbuf(nullptr) {}explicit basic_syncbuf(streambuf_type* obuf): basic_syncbuf(obuf, Allocator()) {} basic_syncbuf(streambuf_type*, const Allocator&);
|
||||
basic_syncbuf(basic_syncbuf&&); ~basic_syncbuf(); // [[syncstream.syncbuf.assign]](syncstream.syncbuf.assign "31.11.2.3 Assignment and swap"), assignment and swap basic_syncbuf& operator=(basic_syncbuf&&); void swap(basic_syncbuf&); // [[syncstream.syncbuf.members]](syncstream.syncbuf.members "31.11.2.4 Member functions"), member functionsbool emit();
|
||||
streambuf_type* get_wrapped() const noexcept;
|
||||
allocator_type get_allocator() const noexcept; void set_emit_on_sync(bool) noexcept; protected:// [[syncstream.syncbuf.virtuals]](syncstream.syncbuf.virtuals "31.11.2.5 Overridden virtual functions"), overridden virtual functionsint sync() override; private: streambuf_type* *wrapped*; // *exposition only*bool *emit-on-sync*{}; // *exposition only*};}
|
||||
|
||||
[1](#1)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12649)
|
||||
|
||||
Class template basic_syncbuf stores character data
|
||||
written to it, known as the associated output, into internal
|
||||
buffers allocated using the object's allocator[.](#1.sentence-1)
|
||||
|
||||
The associated output is transferred to the
|
||||
wrapped stream buffer object **wrapped* when emit() is called
|
||||
or when the basic_syncbuf object is destroyed[.](#1.sentence-2)
|
||||
|
||||
Such transfers are atomic with respect to transfers
|
||||
by other basic_syncbuf objects
|
||||
with the same wrapped stream buffer object[.](#1.sentence-3)
|
||||
22
cppdraft/syncstream/syncbuf/special.md
Normal file
22
cppdraft/syncstream/syncbuf/special.md
Normal file
@@ -0,0 +1,22 @@
|
||||
[syncstream.syncbuf.special]
|
||||
|
||||
# 31 Input/output library [[input.output]](./#input.output)
|
||||
|
||||
## 31.11 Synchronized output streams [[syncstream]](syncstream#syncbuf.special)
|
||||
|
||||
### 31.11.2 Class template basic_syncbuf [[syncstream.syncbuf]](syncstream.syncbuf#special)
|
||||
|
||||
#### 31.11.2.6 Specialized algorithms [syncstream.syncbuf.special]
|
||||
|
||||
[ð](#lib:swap,basic_syncbuf)
|
||||
|
||||
`template<class charT, class traits, class Allocator>
|
||||
void swap(basic_syncbuf<charT, traits, Allocator>& a,
|
||||
basic_syncbuf<charT, traits, Allocator>& b);
|
||||
`
|
||||
|
||||
[1](#1)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12908)
|
||||
|
||||
*Effects*: Equivalent to a.swap(b)[.](#1.sentence-1)
|
||||
36
cppdraft/syncstream/syncbuf/virtuals.md
Normal file
36
cppdraft/syncstream/syncbuf/virtuals.md
Normal file
@@ -0,0 +1,36 @@
|
||||
[syncstream.syncbuf.virtuals]
|
||||
|
||||
# 31 Input/output library [[input.output]](./#input.output)
|
||||
|
||||
## 31.11 Synchronized output streams [[syncstream]](syncstream#syncbuf.virtuals)
|
||||
|
||||
### 31.11.2 Class template basic_syncbuf [[syncstream.syncbuf]](syncstream.syncbuf#virtuals)
|
||||
|
||||
#### 31.11.2.5 Overridden virtual functions [syncstream.syncbuf.virtuals]
|
||||
|
||||
[ð](#lib:sync,basic_syncbuf)
|
||||
|
||||
`int sync() override;
|
||||
`
|
||||
|
||||
[1](#1)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12883)
|
||||
|
||||
*Effects*: Records that the wrapped stream buffer is to be flushed[.](#1.sentence-1)
|
||||
|
||||
Then, if *emit-on-sync* is true, calls emit()[.](#1.sentence-2)
|
||||
|
||||
[*Note [1](#note-1)*:
|
||||
|
||||
If *emit-on-sync* is false,
|
||||
the actual flush is delayed until a call to emit()[.](#1.sentence-3)
|
||||
|
||||
â *end note*]
|
||||
|
||||
[2](#2)
|
||||
|
||||
[#](http://github.com/Eelis/draft/tree/9adde4bc1c62ec234483e63ea3b70a59724c745a/source/iostreams.tex#L12892)
|
||||
|
||||
*Returns*: If emit() was called and returned false,
|
||||
returns -1; otherwise 0[.](#2.sentence-1)
|
||||
Reference in New Issue
Block a user