avr-libc
2.0.0
Standard C library for AVR-GCC
|
AVR Libc Home Page |
AVR Libc Development Pages |
||||
Main Page |
User Manual |
Library Reference |
FAQ |
Example Projects |
マクロ | |
#define | stdin (__iob[0]) |
#define | stdout (__iob[1]) |
#define | stderr (__iob[2]) |
#define | EOF (-1) |
#define | fdev_set_udata(stream, u) do { (stream)->udata = u; } while(0) |
#define | fdev_get_udata(stream) ((stream)->udata) |
#define | fdev_setup_stream(stream, put, get, rwflag) |
#define | _FDEV_SETUP_READ __SRD |
#define | _FDEV_SETUP_WRITE __SWR |
#define | _FDEV_SETUP_RW (__SRD|__SWR) |
#define | _FDEV_ERR (-1) |
#define | _FDEV_EOF (-2) |
#define | FDEV_SETUP_STREAM(put, get, rwflag) |
#define | fdev_close() |
#define | putc(__c, __stream) fputc(__c, __stream) |
#define | putchar(__c) fputc(__c, stdout) |
#define | getc(__stream) fgetc(__stream) |
#define | getchar() fgetc(stdin) |
型定義 | |
typedef struct __file | FILE |
関数 | |
int | fclose (FILE *__stream) |
int | vfprintf (FILE *__stream, const char *__fmt, va_list __ap) |
int | vfprintf_P (FILE *__stream, const char *__fmt, va_list __ap) |
int | fputc (int __c, FILE *__stream) |
int | printf (const char *__fmt,...) |
int | printf_P (const char *__fmt,...) |
int | vprintf (const char *__fmt, va_list __ap) |
int | sprintf (char *__s, const char *__fmt,...) |
int | sprintf_P (char *__s, const char *__fmt,...) |
int | snprintf (char *__s, size_t __n, const char *__fmt,...) |
int | snprintf_P (char *__s, size_t __n, const char *__fmt,...) |
int | vsprintf (char *__s, const char *__fmt, va_list ap) |
int | vsprintf_P (char *__s, const char *__fmt, va_list ap) |
int | vsnprintf (char *__s, size_t __n, const char *__fmt, va_list ap) |
int | vsnprintf_P (char *__s, size_t __n, const char *__fmt, va_list ap) |
int | fprintf (FILE *__stream, const char *__fmt,...) |
int | fprintf_P (FILE *__stream, const char *__fmt,...) |
int | fputs (const char *__str, FILE *__stream) |
int | fputs_P (const char *__str, FILE *__stream) |
int | puts (const char *__str) |
int | puts_P (const char *__str) |
size_t | fwrite (const void *__ptr, size_t __size, size_t __nmemb, FILE *__stream) |
int | fgetc (FILE *__stream) |
int | ungetc (int __c, FILE *__stream) |
char * | fgets (char *__str, int __size, FILE *__stream) |
char * | gets (char *__str) |
size_t | fread (void *__ptr, size_t __size, size_t __nmemb, FILE *__stream) |
void | clearerr (FILE *__stream) |
int | feof (FILE *__stream) |
int | ferror (FILE *__stream) |
int | vfscanf (FILE *__stream, const char *__fmt, va_list __ap) |
int | vfscanf_P (FILE *__stream, const char *__fmt, va_list __ap) |
int | fscanf (FILE *__stream, const char *__fmt,...) |
int | fscanf_P (FILE *__stream, const char *__fmt,...) |
int | scanf (const char *__fmt,...) |
int | scanf_P (const char *__fmt,...) |
int | vscanf (const char *__fmt, va_list __ap) |
int | sscanf (const char *__buf, const char *__fmt,...) |
int | sscanf_P (const char *__buf, const char *__fmt,...) |
int | fflush (FILE *stream) |
FILE * | fdevopen (int(*put)(char, FILE *), int(*get)(FILE *)) |
このファイルは、avr-libc
で実装されている標準入出力機能を示しています。ハードウェアに依存する部分のため、標準入出力の限られたサブセットのみ実装されています。利用できる実際のファイル実装はなく、デバイスの入出力のみ実行できます。オペレーティングシステムがないため、アプリケーションが標準入出力を使用できるようにするために、デバイスに関する詳細を提供しなければなりません。
メモリ空間の節約のため、いくつかの機能はまったく実装されていません(たとえば、いくつかのprintf
変換は省略されています)。それでもこの実装の潜在的なユーザに警告しておきます:printf
やscanf
関連の関数は、有名な"Hello, world!"プログラムのようにおそらく単純にみえますが、実際はかなり複雑で、かなりの量のコードスペースを消費する内容を含んでいます。 そして、実行時にフォーマット文字列を解釈するのも速くはないです。可能な限りavr-libcにより提供される予め決められた(ときには標準ではない)変換機能に頼ることで、通常スピードもコードサイズも少なくすることができます。
プログラマにコードサイズと機能のトレードオフできるように、printf関数の核心部であるvfprintf()関数は、リンカオプションを使い異なった実装を選べます。詳しい説明は、vfprintf()のドキュメントを参照してください。同じことがvfscanf()とscanf
関数ファミリーにもあてはまります。
標準ストリームstdin
、stdout
とstderr
が提供されています。しかし、C標準とは違い、avr-libcには適用できるデバイス情報がないため、これらのストリームはアプリケーション起動時に事前に初期化されません。また、avr-libcにはファイルの概念がまったくないため、いくつかのデバイスのストリームに関連づけて使用するfopen()
関数がありません。(注1参照)その代わりに、fdevopen()
関数がデバイスのストリームに関連づけるために提供されています。デバイスは、文字送信、文字受信、もしくはその両方の関数を提供している必要があります。avr-libcの中では、"テキスト"と"バイナリ"ストリームのを識別はありません。文字\n
は、文字通りデバイスのput()
関数へ送信されます。もし、復改(\r
)文字をラインフィードの前に送ることを要求するなら、put()
ルーチンが実装しななければなりません。(注2を参照)
fdevopen()の代わりの手段として、ユーザ提供のFILE構造体を初期化して使うfdev_setup_stream()マクロがあります。
改行文字の中に復改を入れる自動変換をするときは注意してください。改行文字の変換は、バイナリ転送を壊します。もし、バイナリ転送を望むならば、自動変換は実行してはいけません。その代わりに、CR-LFシーケンスの出力目的で、文字列ではっきりと"\r\n"
を使う必要があります。
便宜上、最初に呼び出され、読出しストリームを開くfdevopen()
でできたストリームをstdin
にエイリアスされます。同様に、最初に呼び出され、書込みストリームを開くfdevopen()
でできたストリームをstdout
とstderr
の両方にエイリアスされます。そして、読み書きを意図して両方とも開いたのであれば、3つ全ての標準ストリームは同じとなります。これらのエイリアスは、互いに区別が付かないことを注意してください。そして、ストリームに対してfclose()
を呼び出すと、全てのエイリアスを事実上閉じます。(注3)
fdev_set_udata()を使うことで、ユーザデータをストリームに関連づけることができます。バックエンドのputとget関数は、 fdev_get_udata()を使うことでユーザデータを得られ、適切に振る舞えます。例えば、1つのput関数で2つの異なるUARTと話すことや、putとget関数で呼出しの間で内部状態を保つことができます。
すべてのprintf
とscanf
関数関連には、2種類が用意されています。標準的な名前で、フォーマット文字列がSRAM上にあるものと、もう1つは接尾辞に"_P"が付き、フォーマット文字列がFlash ROM上あるものです。PSTR
マクロ(<avr/pgmspace.h>: プログラム空間ユーティリティで説明)は、これらのフォーマット文字列をとても使いやすくします。
標準では、fdevopen()はmalloc()を必要とします。これは、マイコンの限られた環境下ではしばし望ましくありません。代わりの選択肢として、malloc()なしで完全に動作させる方法が提供されています。
fdev_setup_stream()マクロは、標準入出力の動作のためにユーザー提供のFILEバッファを準備するために提供されています。
この例では、fdev_setup_stream()の関数のようなものではなく、FDEV_SETUP_STREAM()による初期化を使用して、全てのデータ初期化をCのスタートアップ中に行います。
このように初期化されたストリームが不要になったら、fdev_close()マクロを呼び出すして、オブジェクト自体を破棄することができます。ただし、これらのストリームに対してfclose()を呼び出してはいけません。fclose()を呼び出すことはそのものは無害ですが、free()の未定義参照を引き起こし、アプリケーションにmallocモジュールをリンクさせてしまう原因となります。
fopen()
と互換性のあるデバイスの抽象化を実装できたかもしれませんが、文字列解析や、文字列やアプリケーションから提供される追加のテーブル情報を必要としたため、このようなアプローチは採用しませんでした。fdevopen()
に対応した簡単な関数put()
は、次のようになります。fprintf(mystream, ...)
の代わりにprintf()
と書くことで、タイピングを少なくするだけではなく、avr-gccが(固定数のパラメータを取る関数のためのレジスタにそれらを渡すのとは対照的に)スタック上の可変長引数関数の全ての引数の引き渡す必要があるため、stdin
やstdout
を意味する1つのパラメータを少なく渡すことにより、若干の実行時間も節約します。#define _FDEV_EOF (-2) |
デバイスの読込みにおけるEnd-of-File状態のリターンコード
fdevopen()のget関数で使用
#define _FDEV_ERR (-1) |
デバイスの読込みにおけるエラー状態のリターンコード
fdevopen()のget関数で使用
#define _FDEV_SETUP_READ __SRD |
fdev_setup_stream()での、読込み指定
#define _FDEV_SETUP_RW (__SRD|__SWR) |
fdev_setup_stream()での、読み書き指定
#define _FDEV_SETUP_WRITE __SWR |
fdev_setup_stream()での、書込み指定
#define EOF (-1) |
EOF
は、いろいろな標準入出力関数によるエラーの場合に返される値として宣言されています。(現在の)AVRプラットフォームでは、実際のファイルのための抽象概念を持たないため、ここでは、本来の"end of file"の意味はあまりありません。
#define fdev_close | ( | ) |
このマクロは、stream
と関係しているかも知れないライブラリリソースを開放します。ストリームが必要ないならば、アプリケーションがstream
オブジェクト自体を破壊する前に呼び出されなければなりません。
((現在では、このマクロは何もしません。しかし、将来のライブラリのバージョンでは変わるかもしれません。)
#define fdev_get_udata | ( | stream | ) | ((stream)->udata) |
このマクロは、FILEストリームオブジェクトからのユーザ定義データへのポインタを取り出します。
#define fdev_set_udata | ( | stream, | |
u | |||
) | do { (stream)->udata = u; } while(0) |
このマクロは、FILEストリームオブジェクトにユーザ定義データのポインタへ書き込みます。
ユーザーデータは、fdevopen()関数へ提供されたputやget関数内の状態追跡のために有用です。 function.
#define fdev_setup_stream | ( | stream, | |
put, | |||
get, | |||
rwflag | |||
) |
標準入出力ストリームのようなユーザ提供のバッファセットアップ
このマクロは、ユーザが提供するバッファストリームを使用し、fdevopen()により動的に取得されたものと同様に標準入出力操作のために有効なストリームをセットアップします。設定されるバッファは、FILE型でなければいけません。
put
やget
引数は、fdevopen()に渡す必要があるものと全く同じです。
rwflag
引数は、それぞれ_FDEV_SETUP_READ、_FDEV_SETUP_WRITE、または_FDEV_SETUP_RWの読出し、書込み、読み書きを意図するひとつの値です。
#define FDEV_SETUP_STREAM | ( | put, | |
get, | |||
rwflag | |||
) |
ユーザ提供の標準入出力ストリームの初期化処理
このマクロは、fdev_setup_stream()と同じ動作をしますが、FILE型変数の初期化処理として使用されます。
他の引数は、fdev_setup_stream()で説明されたように使用します。
#define getc | ( | __stream | ) | fgetc(__stream) |
getc
マクロは、fgetc()関数とおなじ機能をもつ「高速」なマクロとして使われます。スペース抑制のため、avr-libc
では、単にfgetc
の別名になっています。
#define putc | ( | __c, | |
__stream | |||
) | fputc(__c, __stream) |
putc
マクロは、fputc()関数と同一の機能をもつ「高速」マクロとして使われます。スペース抑制のため、avr-libc
では、単にfputc
の別名になっています。
#define stderr (__iob[2]) |
エラー出力向けのストリーム。特に指定しなければ、stdout
と同じです。
もしstderr
を別のストリームに指定する必要がある場合は、fdevopen()
の結果を前のstderr
を閉じずに明示的に割り当てる必要があります。 (これによりstdout
も閉じられるため)
#define stdin (__iob[0]) |
ストリーム
引数をとらない、単純化された関数の入力ストリームで使用されるストリーム
fdevopen()
を使用して読込み目的で開かれた最初のストリームは、stdin
に割り当てられます。
#define stdout (__iob[1]) |
ストリーム
引数をとらない、単純化された関数の出力ストリームで使用されるストリーム
fdevopen()
を使用して書込み目的で開かれた最初のストリームは、stdin
とstderr
の両方に割り当てられます。
typedef struct __file FILE |
FILE
は、さまざまな標準入出力関数で渡されるあいまいな構造体です。
void clearerr | ( | FILE * | __stream | ) |
Clear the error and end-of-file flags of stream
.
int fclose | ( | FILE * | __stream | ) |
This function closes stream
, and disallows and further IO to and from it.
When using fdevopen() to setup the stream, a call to fclose() is needed in order to free the internal resources allocated.
If the stream has been set up using fdev_setup_stream() or FDEV_SETUP_STREAM(), use fdev_close() instead.
It currently always returns 0 (for success).
This function is a replacement for fopen()
.
It opens a stream for a device where the actual device implementation needs to be provided by the application. If successful, a pointer to the structure for the opened stream is returned. Reasons for a possible failure currently include that neither the put
nor the get
argument have been provided, thus attempting to open a stream with no IO intent at all, or that insufficient dynamic memory is available to establish a new stream.
If the put
function pointer is provided, the stream is opened with write intent. The function passed as put
shall take two arguments, the first a character to write to the device, and the second a pointer to FILE, and shall return 0 if the output was successful, and a nonzero value if the character could not be sent to the device.
If the get
function pointer is provided, the stream is opened with read intent. The function passed as get
shall take a pointer to FILE as its single argument, and return one character from the device, passed as an int
type. If an error occurs when trying to read from the device, it shall return _FDEV_ERR
. If an end-of-file condition was reached while reading from the device, _FDEV_EOF
shall be returned.
If both functions are provided, the stream is opened with read and write intent.
The first stream opened with read intent is assigned to stdin
, and the first one opened with write intent is assigned to both, stdout
and stderr
.
fdevopen() uses calloc() (und thus malloc()) in order to allocate the storage for the new stream.
int feof | ( | FILE * | __stream | ) |
Test the end-of-file flag of stream
. This flag can only be cleared by a call to clearerr().
int ferror | ( | FILE * | __stream | ) |
Test the error flag of stream
. This flag can only be cleared by a call to clearerr().
int fflush | ( | FILE * | stream | ) |
Flush stream
.
This is a null operation provided for source-code compatibility only, as the standard IO implementation currently does not perform any buffering.
int fgetc | ( | FILE * | __stream | ) |
char* fgets | ( | char * | __str, |
int | __size, | ||
FILE * | __stream | ||
) |
Read at most size - 1
bytes from stream
, until a newline character was encountered, and store the characters in the buffer pointed to by str
. Unless an error was encountered while reading, the string will then be terminated with a NUL
character.
If an error was encountered, the function returns NULL and sets the error flag of stream
, which can be tested using ferror(). Otherwise, a pointer to the string will be returned.
int fprintf | ( | FILE * | __stream, |
const char * | __fmt, | ||
... | |||
) |
fprintf
関数は、stream
へフォーマット済み出力を行います。詳細はvfprintf()
を参照ください。
int fputc | ( | int | __c, |
FILE * | __stream | ||
) |
The function fputc
sends the character c
(though given as type int
) to stream
. It returns the character, or EOF
in case an error occurred.
int fputs | ( | const char * | __str, |
FILE * | __stream | ||
) |
ストリームstream
へstr
ポインタが示す文字列を書き込む
成功時に0、エラー時にEOFを返す
size_t fread | ( | void * | __ptr, |
size_t | __size, | ||
size_t | __nmemb, | ||
FILE * | __stream | ||
) |
int fscanf | ( | FILE * | __stream, |
const char * | __fmt, | ||
... | |||
) |
fscanf
関数は、stream
から入力データを読み込み、フォーマット済み入力を実行します。
詳細はvfscanf()を参照ください。
size_t fwrite | ( | const void * | __ptr, |
size_t | __size, | ||
size_t | __nmemb, | ||
FILE * | __stream | ||
) |
Write nmemb
objects, size
bytes each, to stream
. The first byte of the first object is referenced by ptr
.
Returns the number of objects successfully written, i. e. nmemb
unless an output error occured.
char* gets | ( | char * | __str | ) |
Similar to fgets() except that it will operate on stream stdin
, and the trailing newline (if any) will not be stored in the string. It is the caller's responsibility to provide enough storage to hold the characters read.
int printf | ( | const char * | __fmt, |
... | |||
) |
printf
関数は、stdout
ストリームへフォーマット済み出力をする。詳細はvfprintf()
を参照ください。
int printf_P | ( | const char * | __fmt, |
... | |||
) |
プログラムメモリにあるfmt
文字列を使用するprintf()
の類型関数
int puts | ( | const char * | __str | ) |
stdout
へ、str
のポインタが指す文字列を書き、改行文字を書き込む
int puts_P | ( | const char * | __str | ) |
プログラムメモリにあるstr
を使用するputs()の類型関数
int scanf | ( | const char * | __fmt, |
... | |||
) |
scanf
関数は、stdin
からのフォーマット済み入力を処理する。
詳細はvfscanf()を参照ください。
int scanf_P | ( | const char * | __fmt, |
... | |||
) |
プログラムメモリにあるfmt
文字列を使用するscanf()の類型関数
int snprintf | ( | char * | __s, |
size_t | __n, | ||
const char * | __fmt, | ||
... | |||
) |
s
を無限長と仮定せず、n
文字(最後のNUL文字を含む)以下としてs
を変換するsprintf()
のような関数
十分なスペースがあれば、s
に書き込まれた文字数を返します。
int snprintf_P | ( | char * | __s, |
size_t | __n, | ||
const char * | __fmt, | ||
... | |||
) |
プログラムメモリにあるfmt
文字列を使用するsnprintf()
の類型関数
int sprintf | ( | char * | __s, |
const char * | __fmt, | ||
... | |||
) |
s
文字列へフォーマット済み文字を書き込むprintf()
のような関数
int sprintf_P | ( | char * | __s, |
const char * | __fmt, | ||
... | |||
) |
プログラムメモリにあるfmt
文字列を使用するsprintf()
の類型関数
int sscanf | ( | const char * | __buf, |
const char * | __fmt, | ||
... | |||
) |
sscanf
関数は、buf
ポインタのバッファから入力データを読み出しフォーマット済み入力を行う。
詳細はvfscanf()を参照ください。
int sscanf_P | ( | const char * | __buf, |
const char * | __fmt, | ||
... | |||
) |
プログラムメモリにあるfmt
文字列を使用するsscanf()の類型関数
int ungetc | ( | int | __c, |
FILE * | __stream | ||
) |
The ungetc() function pushes the character c
(converted to an unsigned char) back onto the input stream pointed to by stream
. The pushed-back character will be returned by a subsequent read on the stream.
Currently, only a single character can be pushed back onto the stream.
The ungetc() function returns the character pushed back after the conversion, or EOF
if the operation fails. If the value of the argument c
character equals EOF
, the operation will fail and the stream will remain unchanged.
int vfprintf | ( | FILE * | __stream, |
const char * | __fmt, | ||
va_list | __ap | ||
) |
vfprintf
is the central facility of the printf
family of functions. It outputs values to stream
under control of a format string passed in fmt
. The actual values to print are passed as a variable argument list ap
.
vfprintf
returns the number of characters written to stream
, or EOF
in case of an error. Currently, this will only happen if stream
has not been opened with write intent.
The format string is composed of zero or more directives: ordinary characters (not %
), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the %
character. The arguments must properly correspond (after type promotion) with the conversion specifier. After the %
, the following appear in sequence:
#
The value should be converted to an "alternate form". For c, d, i, s, and u conversions, this option has no effect. For o conversions, the precision of the number is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For x and X conversions, a non-zero result has the string `0x' (or `0X' for X conversions) prepended to it. 0
(zero) Zero padding. For all conversions, the converted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion (d, i, o, u, i, x, and X), the 0 flag is ignored. -
A negative field width flag; the converted value is to be left adjusted on the field boundary. The converted value is padded on the right with blanks, rather than on the left with blanks or zeros. A - overrides a 0 if both are given. +
A sign must always be placed before a number produced by a signed conversion. A + overrides a space if both are used. s
conversions.l
or h
length modifier, that specifies that the argument for the d, i, o, u, x, or X conversion is a "long int"
rather than int
. The h
is ignored, as "short int"
is equivalent to int
.The conversion specifiers and their meanings are:
diouxX
The int (or appropriate variant) argument is converted to signed decimal (d and i), unsigned octal (o), unsigned decimal (u), or unsigned hexadecimal (x and X) notation. The letters "abcdef" are used for x conversions; the letters "ABCDEF" are used for X conversions. The precision, if any, gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros.p
The void *
argument is taken as an unsigned integer, and converted similarly as a %#x
command would do.c
The int
argument is converted to an "unsigned char"
, and the resulting character is written.s
The "char *"
argument is expected to be a pointer to an array of character type (pointer to a string). Characters from the array are written up to (but not including) a terminating NUL character; if a precision is specified, no more than the number specified are written. If a precision is given, no null character need be present; if the precision is not specified, or is greater than the size of the array, the array must contain a terminating NUL character.%
A %
is written. No argument is converted. The complete conversion specification is "%%".eE
The double argument is rounded and converted in the format "[-]d.ddde±dd"
where there is one digit before the decimal-point character and the number of digits after it is equal to the precision; if the precision is missing, it is taken as 6; if the precision is zero, no decimal-point character appears. An E conversion uses the letter 'E'
(rather than 'e'
) to introduce the exponent. The exponent always contains two digits; if the value is zero, the exponent is 00.fF
The double argument is rounded and converted to decimal notation in the format "[-]ddd.ddd"
, where the number of digits after the decimal-point character is equal to the precision specification. If the precision is missing, it is taken as 6; if the precision is explicitly zero, no decimal-point character appears. If a decimal point appears, at least one digit appears before it.gG
The double argument is converted in style f
or e
(or F
or E
for G
conversions). The precision specifies the number of significant digits. If the precision is missing, 6 digits are given; if the precision is zero, it is treated as 1. Style e
is used if the exponent from its conversion is less than -4 or greater than or equal to the precision. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if it is followed by at least one digit.S
Similar to the s
format, except the pointer is expected to point to a program-memory (ROM) string instead of a RAM string.In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.
Since the full implementation of all the mentioned features becomes fairly large, three different flavours of vfprintf() can be selected using linker options. The default vfprintf() implements all the mentioned functionality except floating point conversions. A minimized version of vfprintf() is available that only implements the very basic integer and string conversion facilities, but only the #
additional option can be specified using conversion flags (these flags are parsed correctly from the format specification, but then simply ignored). This version can be requested using the following compiler options:
If the full functionality including the floating point conversions is required, the following options should be used:
? will be output and double argument will be skiped. So you output below will not be crashed. For default version the width field and the "pad to left" ( symbol minus ) option will work in this case.hh
length modifier is ignored (char
argument is promouted to int
). More exactly, this realization does not check the number of h
symbols.ll
length modifier will to abort the output, as this realization does not operate long
long
arguments.*
symbol) is not realized and will to abort the output. int vfprintf_P | ( | FILE * | __stream, |
const char * | __fmt, | ||
va_list | __ap | ||
) |
Variant of vfprintf()
that uses a fmt
string that resides in program memory.
int vfscanf | ( | FILE * | stream, |
const char * | fmt, | ||
va_list | ap | ||
) |
Formatted input. This function is the heart of the scanf family of functions.
Characters are read from stream and processed in a way described by fmt. Conversion results will be assigned to the parameters passed via ap.
The format string fmt is scanned for conversion specifications. Anything that doesn't comprise a conversion specification is taken as text that is matched literally against the input. White space in the format string will match any white space in the data (including none), all other characters match only itself. Processing is aborted as soon as the data and format string no longer match, or there is an error or end-of-file condition on stream.
Most conversions skip leading white space before starting the actual conversion.
Conversions are introduced with the character %. Possible options can follow the %:
*
indicating that the conversion should be performed but the conversion result is to be discarded; no parameters will be processed from ap
,h
indicating that the argument is a pointer to short int
(rather than int
),hh
indicating that the argument is a pointer to char
(rather than int
).l
indicating that the argument is a pointer to long int
(rather than int
, for integer type conversions), or a pointer to double
(for floating point conversions),In addition, a maximal field width may be specified as a nonzero positive decimal integer, which will restrict the conversion to at most this many characters from the input stream. This field width is limited to at most 255 characters which is also the default value (except for the c
conversion that defaults to 1).
The following conversion flags are supported:
%
Matches a literal %
character. This is not a conversion.d
Matches an optionally signed decimal integer; the next pointer must be a pointer to int
.i
Matches an optionally signed integer; the next pointer must be a pointer to int
. The integer is read in base 16 if it begins with 0x or 0X, in base 8 if it begins with 0, and in base 10 otherwise. Only characters that correspond to the base are used.o
Matches an octal integer; the next pointer must be a pointer to unsigned int
.u
Matches an optionally signed decimal integer; the next pointer must be a pointer to unsigned int
.x
Matches an optionally signed hexadecimal integer; the next pointer must be a pointer to unsigned int
.f
Matches an optionally signed floating-point number; the next pointer must be a pointer to float
.e, g, F, E, G
Equivalent to f
.s
Matches a sequence of non-white-space characters; the next pointer must be a pointer to char
, and the array must be large enough to accept all the sequence and the terminating NUL
character. The input string stops at white space or at the maximum field width, whichever occurs first.c
Matches a sequence of width count characters (default 1); the next pointer must be a pointer to char
, and there must be enough room for all the characters (no terminating NUL
is added). The usual skip of leading white space is suppressed. To skip white space first, use an explicit space in the format.
[ Matches a nonempty sequence of characters from the specified set of accepted characters; the next pointer must be a pointer to char
, and there must be enough room for all the characters in the string, plus a terminating NUL
character. The usual skip of leading white space is suppressed. The string is to be made up of characters in (or not in) a particular set; the set is defined by the characters between the open bracket
[ character and a close bracket
] character. The set excludes those characters if the first character after the open bracket is a circumflex ^
. To include a close bracket in the set, make it the first character after the open bracket or the circumflex; any other position will end the set. The hyphen character -
is also special; when placed between two other characters, it adds all intervening characters to the set. To include a hyphen, make it the last character before the final close bracket. For instance, [^]0-9-]
means the set of everything except close bracket, zero through nine, and hyphen. The string ends with the appearance of a character not in the (or, with a circumflex, in) set or when the field width runs out. Note that usage of this conversion enlarges the stack expense.p
Matches a pointer value (as printed by p
in printf()); the next pointer must be a pointer to void
.n
Nothing is expected; instead, the number of characters consumed thus far from the input is stored through the next pointer, which must be a pointer to int
. This is not a conversion, although it can be suppressed with the *
flag.
These functions return the number of input items assigned, which can be fewer than provided for, or even zero, in the event of a matching failure. Zero indicates that, while there was input available, no conversions were assigned; typically this is due to an invalid input character, such as an alphabetic character for a d
conversion. The value EOF
is returned if an input failure occurs before any conversion such as an end-of-file occurs. If an error or end-of-file occurs after conversion has begun, the number of conversions which were successfully completed is returned.
By default, all the conversions described above are available except the floating-point conversions and the width is limited to 255 characters. The float-point conversion will be available in the extended version provided by the library libscanf_flt.a
. Also in this case the width is not limited (exactly, it is limited to 65535 characters). To link a program against the extended version, use the following compiler flags in the link stage:
A third version is available for environments that are tight on space. In addition to the restrictions of the standard one, this version implements no %[
specification. This version is provided in the library libscanf_min.a
, and can be requested using the following options in the link stage:
int vfscanf_P | ( | FILE * | __stream, |
const char * | __fmt, | ||
va_list | __ap | ||
) |
プログラムメモリにあるfmt
文字列を使用するvfscanf()の類型関数
int vprintf | ( | const char * | __fmt, |
va_list | __ap | ||
) |
vprintf
関数は、stdout
ストリームにフォーマット済み出力を行い、vfprintf()のように可変引数リストをとります。
詳細はvfprintf()を参照ください。
int vscanf | ( | const char * | __fmt, |
va_list | __ap | ||
) |
int vsnprintf | ( | char * | __s, |
size_t | __n, | ||
const char * | __fmt, | ||
va_list | ap | ||
) |
s
を無限長と仮定せず、n
文字(最後のNUL文字を含む)以下として、s
を変換するvsprintf()
のような関数
十分なスペースがあれば、s
に書き込まれた文字数を返します。
int vsnprintf_P | ( | char * | __s, |
size_t | __n, | ||
const char * | __fmt, | ||
va_list | ap | ||
) |
プログラムメモリにあるfmt
文字列を使用するvsnprintf()
の類型関数
int vsprintf | ( | char * | __s, |
const char * | __fmt, | ||
va_list | ap | ||
) |
引数に可変引数リストをとるsprintf()
のような関数
int vsprintf_P | ( | char * | __s, |
const char * | __fmt, | ||
va_list | ap | ||
) |
プログラムメモリにあるfmt
文字列を使用するvsprintf()
の類型関数