std::basic_stringbuf<CharT,Traits,Allocator>::overflow

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

入出力ライブラリ

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::basic_stringbuf

公開メンバ関数

basic_stringbuf::basic_stringbuf

basic_stringbuf::operator= (C++11)

basic_stringbuf::swap (C++11)

basic_stringbuf::str

basic_stringbuf::get_allocator (C++20)

basic_stringbuf::view (C++20)

Protected member functions

basic_stringbuf::underflow

basic_stringbuf::pbackfail

basic_stringbuf::overflow

basic_stringbuf::setbuf

basic_stringbuf::seekoff

basic_stringbuf::seekpos

非メンバ関数

swap(std::basic_stringbuf) (C++11)

Exposition-only member functions

basic_stringbuf::init_buf_ptrs

 

protected: virtual int_type overflow( int_type c = Traits::eof() );

出力文字シーケンスに文字 c を追加します。

もし c がファイルの終端記号 (traits::eq_int_type(c, traits::eof()) = true) であれば、追加する文字はありません。この関数は何もせず、traits::eof() 以外の未規定の値を返します。

それ以外の場合、出力シーケンスに書き込み位置が利用可能であるか、またはこの関数が書き込み位置を正常に利用可能にできる場合、sputc(c) を呼び出し、c を返します。

この関数は、std::stringbuf が出力用に開かれている場合 ((mode & ios_base::out) != 0) に書き込み位置を確保することができます。この場合、バッファ全体に加えて少なくとも1文字以上を格納できるようにバッファを再割り当て（または最初に割り当て）します。std::stringbuf が入力用にも開かれている場合 ((mode & ios_base::in) != 0) は、overflow は新しい書き込み位置の直後を指すように egptr() を移動させることで、取得領域のサイズも増やします。

パラメータ

c

-

出力領域に格納する文字

戻り値

失敗を示す場合は Traits::eof()、文字 c が正常に追加された場合は c、引数として Traits::eof() が指定された場合は Traits::eof() 以外の値。

注釈

この関数は、バッファの内容を関連する文字シーケンスに移動させる典型的な overflow() とは異なります。なぜなら std::basic_stringbuf の場合、バッファと関連するシーケンスは同一であるためです。

例

この例を実行するために使用される実装（例: GCC-4.9）では、overflow() はプット領域を512バイトにオーバーアロケーションします。str() を呼び出しても初期化された4バイトのみが返されますが、次の508回の sputc() 呼び出しでは overflow() の再呼び出しは必要ありません。

このコードを実行

#include <sstream>
#include <iostream>
 
struct mybuf : std::stringbuf
{
    mybuf(const std::string& new_str,
          std::ios_base::openmode which = std::ios_base::in | std::ios_base::out)
        : std::stringbuf(new_str, which) {}
 
    int_type overflow(int_type c = EOF) override
    {
        std::cout << "stringbuf::overflow('" << char(c) << "') called\n"
                  << "Before: size of get area: " << egptr() - eback() << '\n'
                  << "        size of put area: " << epptr() - pbase() << '\n';
 
        int_type ret = std::stringbuf::overflow(c);
 
        std::cout << "After : size of get area: " << egptr() - eback() << '\n'
                  << "        size of put area: " << epptr() - pbase() << '\n';
 
        return ret;
    }
};
 
int main()
{
    std::cout << "read-write stream:\n";
    mybuf sbuf("   "); // read-write stream
    std::iostream stream(&sbuf);
    stream << 1234;
    std::cout << sbuf.str() << '\n';
 
    std::cout << "\nread-only stream:\n";
    mybuf ro_buf("   ", std::ios_base::in); // read-only stream
    std::iostream ro_stream(&ro_buf);
    ro_stream << 1234;
 
    std::cout << "\nwrite-only stream:\n";
    mybuf wr_buf("   ", std::ios_base::out); // write-only stream
    std::iostream wr_stream(&wr_buf);
    wr_stream << 1234;
}

実行結果の例

read-write stream:
stringbuf::overflow('4') called
Before: size of get area: 3
        size of put area: 3
After : size of get area: 4
        size of put area: 512
1234
 
read-only stream:
stringbuf::overflow('1') called
Before: size of get area: 3
        size of put area: 0
After : size of get area: 3
        size of put area: 0
 
write-only stream:
stringbuf::overflow('4') called
Before: size of get area: 0
        size of put area: 3
After : size of get area: 0
        size of put area: 512

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 169	C++98	（再）割り当てられたバッファは追加の1文字しか保持できなかった	より多くの追加文字を許可
LWG 432	C++98	overflow は、std::stringbuf が入力用に開かれている場合、新しい書き込み位置の直後を指すように epptr() を移動させた 入力用に開かれている場合	移動されない

関連項目

overflow [virtual]	関連付けられた出力シーケンスに、配置領域から文字を書き込む (std::basic_streambuf<CharT,Traits> の仮想 protected メンバ関数)
underflow [virtual]	入力シーケンスで利用可能な次の文字を返す (virtual protected member function)