C++ 头文件系列(streambuf)

1. 简介

该头文件定义了basic_streambuf模版，从字面上看是作为流缓冲区之用。

2. basic_streambuf模版

The class template basic_stream< charT, traits > serves as an abstract base class for deriving various stream buffers whose objects each control two character sequences:

—— a character input sequence;

—— a character output sequence.

上面这段话（摘自C++14草案）的大概意思是说：basic_streambuf模版的目的是作为各种各样的 派生流缓冲区 的虚基类, 这些流缓冲区控制两个字符序列----一个输入一个输出。

2.1 控制 输入/输出流

streambuf不直接直接控制输入输出流，而是通过两个数组的六个指针来间接控制：

basc_streambuf模版分别为每一个流指针组提供了5个函数。

2.1.1 输入流指针函数

• eback ： 返回输入流的首指针。
• gptr ： 返回输入流的当前指针。
• egptr ： 返回输入流的尾指针。
• gbump ： 将当前指针前进n步。
• setg ： 设置三个输入流指针。

2.1.2 输出流指针函数

• pbase ： 返回输出流的首指针。
• pptr ： 返回输出流的当前指针。
• epptr ： 返回输出流的尾指针。
• pbump ： 将当前指针步进n步。
• setp ： 设置三个输出流指针。

2.2 virtual函数

这些虚函数为protected，旨在为派生的类提供机会来自定义一些共有的行为。 注意，这些虚函数的定义很抽象（作为基类抽象函数），并且在基类中都 定义为空。

2.2.1 本地化

• imbue ： “注入”本地化对象。

2.2.2 缓冲区管理和定位

• setbuf ： 设置缓冲区。
• seekoff、seekpos ： 更改缓冲区中当前字符位置。
• sync ： 同步缓冲区与控制字符流。

2.2.3 输入函数

• showmanyc ： 返回输入字符流中当前大概可获得的字符数。
• xsgetn ： 从输入字符流中获取n个字符。
• underflow ： 从输入字符流获取当前字符，不改变当前位置。（具体作用不是很明白，有待探究）
• uflow ： 从输入字符流获取当前字符，步进当前位置，默认实现为调用underflow()。
• pbackfail ： 将给定字符放回输入字符流。 该函数仅当没有放回位置或者放回的字符与缓冲区中的字符不一致时才被调用，故后缀fail。

2.2.4 输出函数

• xsputn ： 将n个字符写到输出字符流。
• overflow ： 将字符写到输出字符流。

2.3 public函数

2.3.1 本地化

• pubimbue ： 调用虚函数imbue。
• getloc ： 返回当前本地化对象（locale）。

2.3.2 缓冲区管理和定位

• pubsetbuf ：调用虚函数setbuf。
• pubseekoff ： 调用虚函数seekoff。
• pubsync ： 调用虚函数sync。

2.3.3 输入函数

• in_avail ： 如果读取位置可获得，返回当前可获得的字符数；否则，调用虚函数showmanyc。
• snextc ： 步进当前位置，并且返回当前字符。
• sbumpc ： 如果输入流读取位置可获得，获取当前字符，并且步进当前位置； 否则，调用虚函数uflow。
• sgetc ： 如果输入流读取位置可获得，返回当前字符； 否则，调用虚函数underflow。
• sgetn ： 获取n个字符，调用虚函数xsgetn。
• sputbackc ： 放回给定字符，若无法放回则调用虚函数pbackfail。
• sungetc ： 递减当前位置，并返回当前字符。

2.3.4 输出函数

• sputc ： 如果输出流写位置可获得，输出一个字符； 否则，调用虚函数overflow。
• sputn ： 输出n个字符，调用虚函数xsputn。

3 typedefs

• typedef basic_streambuf<char> streambuf;
• typedef basic_streambuf<wchar_t> wstreambuf;