std::ios_base::pword

 

C++

编译器支持

独立和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

输入/输出库

I/O 操纵符

打印函数 (C++23)

C 风格 I/O

缓冲区

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

流

抽象

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

文件 I/O

basic_ifstream

basic_ofstream

basic_fstream

字符串 I/O

basic_istringstream

basic_ostringstream

basic_stringstream

数组 I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同步输出

basic_osyncstream (C++20)

类型

streamoff

streamsize

fpos

错误类别接口

iostream_category (C++11)

io_errc (C++11)

 

std::ios_base

成员函数

ios_base::ios_base

ios_base::~ios_base

ios_base::operator=

格式化

ios_base::flags

ios_base::setf

ios_base::unsetf

ios_base::precision

ios_base::width

本地化

ios_base::imbue

ios_base::getloc

内部可扩展数组

ios_base::xalloc

ios_base::iword

ios_base::pword

杂项

ios_base::register_callback

ios_base::sync_with_stdio

成员类

ios_base::failure

ios_base::Init

成员类型

ios_base::openmode

ios_base::fmtflags

ios_base::iostate

ios_base::seekdir

ios_base::event

ios_base::event_callback

 

void*& pword( int index );

首先，分配或调整私有存储（void* 的动态数组或另一个可索引数据结构）的大小，使其足以让 index 成为有效索引，然后返回对私有存储中索引为 index 的 void* 元素的引用。

该引用可能因对该 ios_base 对象的任何操作（包括另一次调用 pword()）而失效，但存储的值会被保留，因此稍后使用相同的索引从 pword(index) 读取将产生相同的值，直到下次调用 std::basic_ios::copyfmt()。该值可用于任何目的。元素的索引必须通过 xalloc() 获得，否则行为未定义。新元素初始化为空指针。

如果函数失败（可能是由于分配失败导致）并且 *this 是 basic_ios<> 对象或子对象的基类子对象，则调用 std::basic_ios<>::setstate(badbit)，这可能会抛出 std::ios_base::failure。

参数

index

-

元素的索引值

返回值

元素的引用。

异常

设置 badbit 时可能抛出 std::ios_base::failure。

注意

如果 pword 中存储的指针需要管理，则可以使用 register_callback() 来安装在需要时执行深拷贝或释放的处理程序。

示例

使用基类 pword 存储来运行时类型识别派生的流对象。

运行此代码

#include <iostream>
 
template<class CharT, class Traits = std::char_traits<CharT>>
class mystream : public std::basic_ostream<CharT, Traits>
{
public:
    static const int xindex;
 
    mystream(std::basic_ostream<CharT, Traits>& ostr) :
        std::basic_ostream<CharT, Traits>(ostr.rdbuf())
    {
        this->pword(xindex) = this;
    }
 
    void myfn()
    {
        *this << "[special handling for mystream]";
    }
};
 
// Each specialization of mystream obtains a unique index from xalloc()
template<class CharT, class Traits>
const int mystream<CharT, Traits>::xindex = std::ios_base::xalloc();
 
// This I/O manipulator will be able to recognize ostreams that are mystreams
// by looking up the pointer stored in pword
template<class CharT, class Traits>
std::basic_ostream<CharT, Traits>& mymanip(std::basic_ostream<CharT, Traits>& os)
{
    if (os.pword(mystream<CharT, Traits>::xindex) == &os)
        static_cast<mystream<CharT, Traits>&>(os).myfn();
    return os;
}
 
int main()
{
    std::cout << "cout, narrow-character test " << mymanip << '\n';
 
    mystream<char> myout(std::cout);
    myout << "myout, narrow-character test " << mymanip << '\n';
 
    std::wcout << "wcout, wide-character test " << mymanip << '\n';
 
    mystream<wchar_t> mywout(std::wcout);
    mywout << "mywout, wide-character test " << mymanip << '\n';
}

输出

cout, narrow-character test
myout, narrow-character test [special handling for mystream]
wcout, wide-character test
mywout, wide-character test [special handling for mystream]

缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。

DR	应用于	已发布行为	正确行为
LWG 36	C++98	如果引用失效，存储的值可能不 会被保留	存储的值会被保留 直到下次调用 copyfmt()
LWG 41	C++98	该函数本身在失败时设置 badbit， 但 ios_base 不提供这样的接口	badbit 由 basic_ios 设置 （如果 *this 是其基类子对象）

参见

iword	如果必要，调整私有存储的大小，并访问给定索引处的 long 元素 (公共成员函数)
xalloc [静态]	返回一个程序范围唯一的整数，可以安全地用作 pword() 和 iword() 的索引 (公共静态成员函数)