定义于头文件 <streambuf>
template< class CharT, |
类 basic_streambuf
控制字符序列的输入与输出。它包含下列内容并提供到它们的访问:
1) 受控制字符序列,又称为缓冲区,它可含有为输入操作缓冲的输入序列(又称为获取区),和/或为输出操作缓冲的输出序列(又称为放置区)。
2) 关联字符序列,又称作源(对于输入)或池(对于输出)。它可以是通过 OS API 访问的实体(文件、 TCP 接头、串行端口、其他字符设备),或者可以是能转译成字符源或池的对象( std::vector 、数组、字符串字面量)。
I/O 流对象 std::basic_istream 及 std::basic_ostream ,还有所有导出自它们的对象( std::ofstream 、 std::stringstream 等),都完全以 std::basic_streambuf 实现。
成员函数
回放
在输入序列中放回一个字符
std::basic_streambuf<CharT,Traits>::sputbackc
int_type sputbackc( char_type c ); |
放回字符到获取区。
若回放位置在获取区中可用( gptr() > eback() ),而字符 c
等于 gptr() 左一位置的字符(以 Traits::eq(c, gptr()[-1]) 确定),则简单地减少下一位置指针( gptr() )。
否则,调用 pbackfail(Traits::to_int_type(c)) 放回到获取区,或一同修改获取区和可能的关联字符序列。
I/O 流函数 basic_istream::putback 以此函数实现。
参数
c | - | 要回放的字符 |
返回值
若回放位置可用,则返回下一位置指针现在指向的字符,以 Traits::to_int_type(*gptr()) 转换为 int_type
。来自此 streambuf 的下个单字符输入将返回此字符。
若回放位置不可用,则返回 pbackfail() 所返回者,在失败时为 Traits::eof() 。
调用示例
#include <iostream>
#include <sstream>
int main()
{
std::stringstream s("abcdef"); // gptr() 指向 "abcdef" 中的 'a'
std::cout << "Before putback, string holds " << s.str() << '\n';
char c1 = s.get(); // c1 = 'a' , gptr() 现在指向 "abcdef" 中的 'b'
char c2 = s.rdbuf()->sputbackc('z'); // 同 s.putback('z')
// gptr() 现在指向 "zbcdef" 中的 'z'
std::cout << "After putback, string holds " << s.str() << '\n';
char c3 = s.get(); // c3 = 'z' , gptr() 现在指向 "zbcdef" 中的 'b'
char c4 = s.get(); // c4 = 'b' , gptr() 现在指向 "zbcdef" 中的 'c'
std::cout << c1 << c2 << c3 << c4 << '\n';
s.rdbuf()->sputbackc('b'); // gptr() 现在指向 "zbcdef" 中的 'b'
s.rdbuf()->sputbackc('z'); // gptr() 现在指向 "zbcdef" 中的 'z'
int eof = s.rdbuf()->sputbackc('x'); // 无内容能反获取: pbackfail() 失败
if (eof == EOF)
{
std::cout << "No room to putback after 'z'\n";
}
}
输出
回移一位输出序列中的下一位置指针
std::basic_streambuf<CharT,Traits>::sungetc
int_type sungetc(); |
若回放位置在获取区中可用( gptr() > eback() ),则减少下一位置指针( gptr() )并返回它现在指向的字符。
若回放位置不可用,则调用 pbackfail() 以在可能的情况下后备输入序列。
I/O 流函数 basic_istream::unget 以此函数实现。
参数
(无)
返回值
若回放位置可用,则返回下一位置指针现在指向的字符,以 Traits::to_int_type(*gptr()) 转换为 int_type
。来自此 streambuf 的下个单字符输入将返回此字符。
若回放位置不可用,则返回 pbackfail() 所返回者,在失败时为 Traits::eof() 。
调用示例
#include <iostream>
#include <sstream>
int main()
{
std::stringstream s("abcdef"); // gptr() 指向 'a'
char c1 = s.get(); // c = 'a', gptr() 现在指向 'b'
char c2 = s.rdbuf()->sungetc(); // 同 s.unget() : gptr() 又指向 'a'
char c3 = s.get(); // c3 = 'a' , gptr() 现在指向 'b'
char c4 = s.get(); // c4 = 'b' , gptr() 现在指向 'c'
std::cout << c1 << c2 << c3 << c4 << '\n';
s.rdbuf()->sungetc(); // 回到 'b'
s.rdbuf()->sungetc(); // 回到 'a'
int eof = s.rdbuf()->sungetc(); // 无内容可反获取: pbackfail() 失败
if (eof == EOF)
{
std::cout << "Nothing to unget after 'a'\n";
}
}
输出
受保护成员函数
回放
将字符放回输入序列,可能修改输入序列
std::basic_streambuf<CharT,Traits>::pbackfail
protected: |
在下列情况之一时,此受保护虚函数为公开成员函数 sungetc() 和 sputbackc() 所调用(它们继而为 basic_istream::unget 和 basic_istream::putback 所调用):
1) 获取区中无回放位置(以无参数调用 pbackfail()
)。此情形中, pbackfail()
的目的是令获取区后备一个字符,若关联字符序列允许(例如文件支持的 streambuf 可以在提前一个字符的位置,从文件重新加载缓冲区)。
2) 调用方试图回放异于先前取得字符的另一字符(以需要回放的字符调用 pbackfail()
)。此情形中, pbackfail()
的目的是将字符 c
置于获取区中刚好前于 basic_streambuf::gptr() 的位置,以及若可能则修改关联字符序列以反映此更改。这可能涉及如在第一变体中一般的后备获取区。
此函数的默认基类版本不做任何事并于所有情形返回 Traits::eof() 。导出类覆写此函数: basic_stringbuf::pbackfail 、 basic_filebuf::pbackfail 、 strstreambuf::pbackfail ,而且期待用户定义和第三方库流类也覆写此函数。
参数
ch | - | 要回放的字符,或若只请求放弃则为 Traits::eof() |
返回值
失败情况下为 Traits::eof() ,某个不同值指示成功。基类版本始终失败。