std::scanf、std::fscanf、std::sscanf
| ヘッダ <cstdio>で定義 |
||
| int scanf( const char* format, ... ); |
(1) | |
| int fscanf( std::FILE* stream, const char* format, ... ); |
(2) | |
| int sscanf( const char* buffer, const char* format, ... ); |
(3) | |
さまざまなソースからデータを読み込み、format に従って解釈し、結果を指定された場所に格納します。
目次 |
[編集] パラメータ
| stream | - | 読み込む入力ファイルストリーム |
| buffer | - | 読み込むヌル終端された文字列へのポインタ |
| format | - | 入力をどのように読み込むかを指定するヌル終端された文字列へのポインタ |
| ... | - | 受け取る引数 |
format 文字列は以下で構成されます。
- 空白文字でないマルチバイト文字（% を除く）：フォーマット文字列中のそのような各文字は、入力ストリームから同一の文字を1つ消費するか、ストリームの次の文字が一致しない場合に、関数の失敗を引き起こします。
- 空白文字：フォーマット文字列中の任意の1つの空白文字は、入力から利用可能な連続するすべての空白文字を消費します（std::isspace をループで呼び出した場合と同じように決定されます）。フォーマット文字列中の "\n"、" "、"\t\t"、またはその他の空白文字の間には、違いがありません。
- 変換指定。各変換指定は次の形式です。
- 先行する % 文字。
- (オプション) 代入抑制文字 *。このオプションが存在する場合、関数は変換の結果を受信引数に代入しません。
- (オプション) 整数（1より大きい）で、最大フィールド幅を指定します。これは、現在の変換指定子によって指定された変換を実行する際に、関数が消費することを許可される最大文字数です。 %s および %[ は、幅が指定されていない場合、バッファオーバーフローを引き起こす可能性があることに注意してください。
- (オプション) 受け取る引数のサイズ、つまり実際の宛先型を指定する 長さ修飾子。これは変換精度とオーバーフロー規則に影響します。デフォルトの宛先型は変換型ごとに異なります（下記の表を参照）。
- 変換フォーマット指定子。
以下のフォーマット指定子が利用可能です
| 変換 指定子 |
説明 | 期待される 引数型 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 長さ修飾子→ | hh
|
h
|
なし | l
|
ll
|
j
|
z
|
t
|
L
| |
| C++11からのみ利用可能→ | はい | はい | はい | はい | はい | |||||
%
|
リテラル
% にマッチします。 |
N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
c
|
文字 または 文字のシーケンス にマッチします。
|
N/A | N/A | char* |
wchar_t* |
N/A | N/A | N/A | N/A | N/A |
s
|
非空白文字のシーケンス（文字列）にマッチします。
| |||||||||
[set ] |
set 文字セットからの空でない文字シーケンスにマッチします。
| |||||||||
d
|
10進整数 にマッチします。
|
signed char* または unsigned char* |
signed short* または unsigned short* |
signed int* または unsigned int* |
signed long* または unsigned long* |
signed long long* または unsigned long long* |
std::intmax_t* または std::uintmax_t* |
N/A | ||
i
|
整数 にマッチします。
| |||||||||
u
|
符号なし 10進整数 にマッチします。
| |||||||||
o
|
符号なし 8進整数 にマッチします。
| |||||||||
xX
|
符号なし 16進整数 にマッチします。
| |||||||||
n
|
これまでに読み取った文字数 を返します。
| |||||||||
a (C++11)A (C++11)eEfF (C++11)gG
|
浮動小数点数 にマッチします。
|
N/A | N/A | float* |
double* |
N/A | N/A | N/A | N/A | long double* |
p
|
ポインタ を定義する実装定義の文字シーケンスにマッチします。
|
N/A | N/A | void** |
N/A | N/A | N/A | N/A | N/A | N/A |
| 注釈 | ||||||||||
|
n 以外のすべての変換指定子について、指定されたフィールド幅を超えず、かつ変換指定子が期待するものと完全に一致するか、または期待されるシーケンスのプレフィックスとなるような、最も長い入力文字シーケンスがストリームから消費されます。この消費されたシーケンスの後の最初の文字は、読み込まれないまま残ります。消費されたシーケンスの長さがゼロであるか、または消費されたシーケンスを上記のように変換できない場合、マッチングエラーが発生します。ただし、ストリームからの入力がエンド・オブ・ファイル、エンコーディングエラー、または読み取りエラーによって妨げられた場合は、入力エラーとなります。 [、c、n 以外のすべての変換指定子は、入力を解析しようとする前に、すべての連続する空白文字（std::isspace を呼び出した場合と同じように決定されます）を消費して破棄します。これらの消費された文字は、指定された最大フィールド幅にはカウントされません。 変換指定子 lc、ls、および l[ は、最初の文字が変換される前にゼロに初期化された std::mbstate_t オブジェクトを使用して、std::mbrtowc を呼び出すのと同じように、マルチバイトからワイド文字への変換を実行します。 変換指定子 s および [ は、一致した文字に加えて常にnull終端文字を格納します。宛先配列のサイズは、指定されたフィールド幅より少なくとも1つ大きい必要があります。 %s または %[ を、宛先配列のサイズを指定せずに使用することは、std::gets と同様に危険です。 固定幅整数型（std::int8_t など）の正しい変換指定子は、ヘッダー <cinttypes> で定義されています（ただし、SCNdMAX、SCNuMAX などは %jd、%ju などと同義です）。 各変換指定子の処理後にはシーケンスポイントが存在します。これにより、複数のフィールドを同じ「シンク」変数に格納することが可能になります。 指数部分に数字がない不完全な浮動小数点値を解析する場合（例えば、変換指定子 %f で "100er" を解析する場合）、シーケンス "100e"（おそらく有効な浮動小数点数の最も長いプレフィックス）が消費され、マッチングエラー（消費されたシーケンスは浮動小数点数に変換できない）が発生し、"r" が残ります。既存の実装の中には、この規則に従わず、"100" のみ消費するようにロールバックし、"er" を残すものがあります（例: glibc バグ 1765）。 変換指定子が不正な場合、動作は未定義です。 | ||||||||||
[編集] 戻り値
正常に代入された受け取る引数の数（最初の受け取る引数が代入される前にマッチングエラーが発生した場合はゼロになる可能性があります）、または最初の受け取る引数が代入される前に発生した入力エラーの場合は EOF。
[編集] 複雑性
保証されません。特に、std::sscanf の一部の実装は O(N) です。ここで、N = std::strlen(buffer) です [1]。パフォーマンスの高い文字列解析については、std::from_chars を参照してください。
[編集] 注記
ほとんどの変換指定子は、まず連続する空白文字をすべて消費するため、以下のようなコードは
std::scanf("%d", &a); std::scanf("%d", &b);
別の行に入力された2つの整数（最初の %d によって残された改行が2番目の %d によって消費される）または、スペースやタブで区切られた同じ行の2つの整数（最初の %d によって残されたスペースやタブが2番目の %d によって消費される）を読み込みます。
先頭の空白文字を消費しない変換指定子（例: %c）は、フォーマット文字列に空白文字を使用することで、先頭の空白文字を消費させることができます。std::scanf("%d", &a); std::scanf(" %c", &c); // ignore the endline after %d, then read a char
std::sscanf の一部の実装では std::strlen が呼び出され、実行時間が文字列全体の長さに比例する点に注意してください。これは、ループ内で std::sscanf を呼び出して文字列の先頭から繰り返し値を解析する場合、コードの実行時間が二次時間になる可能性があることを意味します（例）。
[編集] 例
#include <clocale> #include <cstdio> #include <iostream> int main() { int i, j; float x, y; char str1[10], str2[4]; wchar_t warr[2]; std::setlocale(LC_ALL, "en_US.utf8"); char input[] = "25 54.32E-1 Thompson 56789 0123 56ß水"; // parse as follows: // %d: an integer // %f: a floating-point value // %9s: a string of at most 9 non-whitespace characters // %2d: two-digit integer (digits 5 and 6) // %f: a floating-point value (digits 7, 8, 9) // %*d an integer which isn't stored anywhere // ' ': all consecutive whitespace // %3[0-9]: a string of at most 3 digits (digits 5 and 6) // %2lc: two wide characters, using multibyte to wide conversion const int ret = std::sscanf(input, "%d%f%9s%2d%f%*d %3[0-9]%2lc", &i, &x, str1, &j, &y, str2, warr); std::cout << "Converted " << ret << " fields:\n" "i = " << i << "\n" "x = " << x << "\n" "str1 = " << str1 << "\n" "j = " << j << "\n" "y = " << y << "\n" "str2 = " << str2 << std::hex << "\n" "warr[0] = U+" << (int)warr[0] << "\n" "warr[1] = U+" << (int)warr[1] << '\n'; }
出力
Converted 7 fields: i = 25 x = 5.432 str1 = Thompson j = 56 y = 789 str2 = 56 warr[0] = U+df warr[1] = U+6c34
[編集] 関連項目
| (C++11)(C++11)(C++11) |
stdin、ファイルストリーム、またはバッファから書式付き入力を読み取ります。 可変長引数リストを使用する (関数) |
| ファイルストリームから文字列を取得する (関数) | |
| (C++11) |
stdout、ファイルストリーム、またはバッファにフォーマットされた出力を書き込む (関数) |
| (C++17) |
文字シーケンスを整数値または浮動小数点数値に変換する (関数) |
| C ドキュメント（scanf、fscanf、sscanf）
| |
