CERT C++: FIO50-CPP

位置付け呼び出しの介在なしでのファイルストリームからの入出力を交互実行しない

このページをすべて展開する

説明

ルール定義

位置付け呼び出しの介在なしでファイルストリームからの入出力を交互実行しないようにします。¹

Polyspace 実装

ルールチェッカーは、"フラッシュまたは位置付け呼び出しなしでのストリームからの入出力の交互実行" をチェックします。

例

すべて展開する

フラッシュまたは位置付け呼び出しなしでのストリームからの入出力の交互実行

問題

"フラッシュまたは位置付け呼び出しなしでのストリームからの入出力の交互実行" は、ファイルストリームにおける入力操作の後に続く出力操作、または出力操作の後に続く入力操作が、操作の間でファイルストリームの再位置付けが行われずに実行される場合に発生します。

リスク

std::fstream() などの関数を使用してファイルストリームを開くと、次の読み取りまたは書き込み操作が行われるファイルストリーム内の位置を追跡するために、std::basic_filebuf オブジェクトが作成されます。このオブジェクトの実装には C FILE* 抽象化が使用されます。C 標準に従って、FILE* ポインターを使用して、ファイルストリームにおける入力操作と出力操作の両方を実行できます。ただし、入力操作の後に出力操作を実行する場合 (またはその逆の場合)、その前に、ファイルストリームでポインターを再位置付けする必要があります。そうしないと、動作が未定義になります。

修正方法

読み取りと書き込みの両方を目的にファイルストリームを開く場合、ファイルストリームにおける読み取り操作と書き込み操作の間で、中間的なストリームの再位置付け操作を実行する必要があります。

ファイルストリームを再位置付けするには、std::fstream<>::seekp()、std::fstream<>::seekg() などのメソッドを使用できます。

例 – 操作の間で再位置付けが行われない、連続する入出力操作

この例では、関数 getSomeLineFromFile() で、入力操作と出力操作の両方に対してファイルストリームオブジェクト file が使用されています。

入力操作は、std::fstream<>::operator<<() メソッドを使用して行われます。
出力操作は、std::getline() メソッドを使用して行われます。

ただし、出力操作と入力操作の間でファイルストリームの再位置付け操作が行われていません。この問題は、関数 getOtherLineFromFile() で std::fstream<>::seekg() メソッドを使用してファイルストリームを再位置付けすることによって修正されます。

#include <fstream>
#include <string>

void getSomeLineFromFile() {
    std::fstream file { "hello.txt" };
    file << "Some line\n" << std::flush; 
    std::string line {};
    std::getline( file, line ); //Noncompliant
}

void getOtherLineFromFile() {
    std::fstream file { "hello.txt" };
    file << "Some line\n" << std::flush; 
    std::string line {};
    file.seekg( 0, std::ios_base::beg );
    std::getline( file, line ); //Compliant
}

チェック情報

グループ: 07.入出力 (FIO)

バージョン履歴

R2019a で導入

すべて展開する

R2024a: チェッカーが C++ 固有のファイルストリーム操作に対応する

欠陥チェッカーが std::basic_filebuf オブジェクトを使用して、操作の間でストリームが再位置付けされない、連続する読み取り操作と書き込み操作を検出するようになりました。std::basic_filebuf オブジェクトは、std::fstream() などの関数を使用してファイルストリームを開くと作成されます。

以前は、このチェッカーは fopen() などの C スタイルの関数を使用したファイル操作のみに対応していました。現在、これらの関数の対応が行われるのはCERT C++:FIO39-C のみです。

参考

SEI CERT-C++ をチェック (-cert-cpp)

トピック

コーディング規約違反のチェックおよびレビュー

外部の Web サイト

FIO50-CPP

¹ This software has been created by MathWorks incorporating portions of: the “SEI CERT-C Website,” © 2017 Carnegie Mellon University, the SEI CERT-C++ Web site © 2017 Carnegie Mellon University, ”SEI CERT C Coding Standard – Rules for Developing safe, Reliable and Secure systems – 2016 Edition,” © 2016 Carnegie Mellon University, and “SEI CERT C++ Coding Standard – Rules for Developing safe, Reliable and Secure systems in C++ – 2016 Edition” © 2016 Carnegie Mellon University, with special permission from its Software Engineering Institute.

ANY MATERIAL OF CARNEGIE MELLON UNIVERSITY AND/OR ITS SOFTWARE ENGINEERING INSTITUTE CONTAINED HEREIN IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.

This software and associated documentation has not been reviewed nor is it endorsed by Carnegie Mellon University or its Software Engineering Institute.