Vstup a výstup v jazyce C

Vstup a výstup v jazyce C je v informatice řešen souborem knihovních funkcí ze standardní knihovny jazyka C (libc, glibc a podobně), jejíž prototypy jsou deklarovány v hlavičkovém souboru <stdio.h>. Programovací jazyk C při operacích vstupu a výstupu využívá proudy bytů a nerozlišuje mezi vstupními a výstupními zařízeními, rourami a soubory, přičemž definuje standardní proudy (stdin, stdout a stderr).

Proudy

Na rozdíl od některých dřívějších programovacích jazyků, nemá jazyk C přímou podporu pro přímý přístup k datům souborů. Pro čtení uprostřed souboru musí programátor nejprve vytvořit proud, ve kterém pak pomocí funkce fseek nastaví ukazatel do místa v souboru, ze kterého následně bude číst nebo zapisovat.

Použití proudů pro práci se soubory bylo zpopularizováno operačním systémem UNIX, který byl vyvíjen ve stejné době, jako programovací jazyk C. Celá řada moderních operačních systémů proudy z unixových systémů zdědila stejně, jako je mnoho programovacích jazyků zdědilo z jazyka C (např. PHP). Též do standardních knihoven jazyka C++ se promítají proudy (tzv. iostream).

Otevírání souboru

Soubor je otevírán použitím funkce fopen, která vrací I/O proud. Ten je připojen k danému souboru nebo jinému blokovému zařízení umožňujícímu operace čtení a zápis. V případě, že funkce selže, vrací nulový ukazatel (NULL). Související knihovní funkce freopen vykonává stejnou operaci, avšak nejprve zavře otevřený proud, který je uveden jako doplňující parametr.

I/O proud je definován takto:

FILE *fopen(const char *path, const char *mode);
FILE *freopen(const char *path, const char *mode, FILE *fp);

Funkce fopen je wrapper, který na vyšší úrovni obaluje jednoduché systémové volání open jádra unixového operačního systému. Stejným způsobem jako fopen pracuje i funkce fclose, která poskytuje obálku pro systémové volání jádra close. Struktura FILE jazyka C se velmi často shoduje se souborovými deskriptory používanými v unixových systémech. V POSIXu je definována funkce fdopen, která inicializuje I/O proud z existujícího deskriptoru, přestože deskriptory jsou čistě unixová záležitost a nejsou obsaženy ve standardech jazyka C.

Parametr mode, který využívají funkce fopen nebo freopen, musí být řetězec začínající jednou z následujících sekvencí či jejich kombinací:

mode			popis	ukazatel na
`r`	`rb`		otevření pro čtení	začátku souboru
`w`	`wb`		otevření pro zápis: pokud soubor neexistuje, vytvoří ho; pokud soubor již existuje, vymaže obsah a zapíše data	začátku souboru
`a`	`ab`		připojení dat: nová data jsou zapisována na konec souboru, ke změně existujících dat nedojde (pokud soubor neexistuje, vytvoří ho)	konci souboru
`r+`	`rb+`	`r+b`	otevření pro čtení a zápis	začátku souboru
`w+`	`wb+`	`w+b`	otevření pro čtení a zápis. Vymaže obsah a přepíše soubor.	začátku souboru
`a+`	`ab+`	`a+b`	otevření pro čtení a zápis (pokud soubor existuje, jsou nová data zapisována na konec souboru)	konci souboru

Označení „b“ znamená binární. Standardy jazyka C poskytují dva typy souborů – textové a binární, ačkoli operační systém nemusí být schopen je rozlišovat.

Textový soubor: V režimu textového souboru je text uspořádán v řádcích, jejichž konce jsou označeny znakem nového řádku (zkratka EOL). Unixové systémy označují nový řádek znakem LF, zatímco DOS a Microsoft Windows používají kombinaci CR/LF. Při čtení z textového souboru je obvykle mapována sekvence EOL na znak LF, což slouží ke zjednodušení zpracování v programu. V případě, že je textový soubor zapisován, převádí se před vlastním zápisem EOL automaticky na znaky, které daný operační systém používá.

Binární soubor: V režimu binárního souboru je obsah souboru čten a zapisován operačním systémem bez úprav (obsah je doručen programu bez automatického převodu, tzv. přímý přístup, anglicky raw).

Znak „+“ (režim aktualizace): Když je soubor otevřen v režimu aktualizace (znak „+“ na druhé nebo třetí pozici), může být na daném proudu použito čtení i zápis, avšak je-li po operaci zápisu nemůže být volána funkce čtení bez toho, aby mezi nimi byla volána funkce fflush nebo funkce pro změnu pozice ukazatele (fseek, fsetpos nebo rewind). Stejně tak čtení nemůže být následováno zápisem bez toho, aby mezi nimi byla též volána funkce pro změnu pozice ukazatele.

Automatické vytvoření souboru: Pokud při volání funkce otevření souboru v režimu zápisu nebo připojení za konec souboru požadované jméno neexistuje, pokusí se funkce soubor požadovaného jména vytvořit. Pokud operace selže, vrací se hodnotu NULL.

Uzavření proudu

Funkce fclose pracuje pouze s jedním argumentem, a to s ukazatelem na souborovou strukturu proudu určeného k zavření. Po zavření se uvolní paměť vyhrazená pro strukturu FILE * a vyprázdní se vyrovnávací paměť. Bez opětovného otevření proudu již není práce se souborem možná. Počet otevřených souborů je omezen, proto jestliže se souborem nebudeme již pracovat, měli bychom jej uzavřít. Uzavření souboru je prováděno příkazem:

int fclose(FILE *fp);

Pokud proud neuzavřeme pomocí příkazu, uzavře se sám po ukončení programu. Při úspěšném uzavření souboru vrací funkce hodnotu 0, při selhání vrací EOF.

Čtení z proudu

Pro načtení znaku z proudu se používá funkce fgetc:

int fgetc(FILE *fp);

Když je volání úspěšné, fgetc načte další byte nebo znak z proudu (záleží na tom, zda je soubor binární nebo textový). V případě, že volání úspěšné není fgetc vrací EOF (specifický typ chyby může být určen podle systémového volání ferror nebo feof s ukazatelem na soubor). Standardní makro getc, které je také definováno v <stdio.h>, se chová obdobně jako fgetc. Krom toho může samo o sobě vyhodnocovat opakovaně své argumenty.

Standardní funkce getchar je také definována v <stdio.h>, nepodporuje práci s argumenty a je ekvivalentní k getc(stdin). Pro blokové čtení ze souboru se používá funkce fread(), která načte ze zadaného proudu n položek o určené velikosti a ukládá je do paměti označené ukazatelem. Návratovou hodnotou této funkce je počet skutečně přečtených položek.

Zápis do souboru

Pro zápis do souboru využíváme funkce putc(), fprintf():

int putc(int c, FILE *file);
int fprintf(FILE *file, char *format, …);

U všech funkcí pro zápis do souboru platí, že se pozice ukazatele posune za poslední zapsaný byte v souboru. Pro blokový zápis se využívá funkce fwrite(), která zapíše do proudu n položek načtených z paměti. Tato funkce vrací zpět počet úspěšně zapsaných položek, nikoliv bytů!

Přehled funkcí

Většina vstupně/výstupních funkcí jazyka C je definována v stdio.h (cstdio hlavička v C++).

	Byte znak	Šířka^[zdroj⁠?] znak	Popis
Přístup k souborům	`fopen`		otevře soubor
	`freopen`		otevře jiný soubor v existujícím proudu
	`fflush`		synchronizuje výstupní proud s aktuálním souborem
	`fclose`		uzavře soubor
	`setbuf`		nastaví buffer pro datový proud
	`setvbuf`		nastaví buffer a jeho velikost pro datový proud
	`fwide`		přepne datový proud mezi šírokým znaku a úzkým znakem
Přímý vstup/výstup	`fread`		čte ze souboru
Přímý vstup/výstup	`fwrite`		zapisuje do souboru
Neformátovaný vstup/výstup	`fgetc` `getc`	`fgetwc` `getwc`	čte byte/`wchar_t` z datového proudu
	`fgets`	`fgetws`	čte byte/`wchar_t` řádek z datového proudu
	`fputc` `putc`	`fputwc` `putwc`	zapisuje byte/`wchar_t` do datového proudu
	`fputs`	`fputws`	zapisuje byte/`wchar_t` řetězec do datového proudu
	`getchar`	`getwchar`	čte byte/`wchar_t` ze stdin
	`gets`	N/A	čte řetězec bytů ze stdin (nepoužívá v C99, zastaralé v C11)
	`putchar`	`putwchar`	zapíše byte/`wchar_t` na stdout
	`puts`	N/A	zapíše řetězec bytů na stdout
	`ungetc`	`ungetwc`	vloží byte/`wchar_t` zpět do datového proudu
Formátovaný vstup/výstup	`scanf` `fscanf` `sscanf`	`wscanf` `fwscanf` `swscanf`	čte formátovaný byte/`wchar_t` vstup z stdin, datový proud nebo buffer
	`vscanf` `vfscanf` `vsscanf`	`vwscanf` `vfwscanf` `vswscanf`	čte formátovaný vstup byte/`wchar_t` ze stdin, datového proudu nebo bufferu pomocí proměnného seznamu parametrů
	`printf` `fprintf` `sprintf` `snprintf`	`wprintf` `fwprintf` `swprintf`	tiskne formátovaný byte/`wchar_t` výstup do stdout, datového proudu nebo bufferu
	`vprintf` `vfprintf` `vsprintf` `vsnprintf`	`vwprintf` `vfwprintf` `vswprintf`	tiskne formátovaný byte/`wchar_t` výstup do stdout, datového proudu nebo bufferu pomocí proměnného seznamu parametrů.
	`perror`	N/A	zapíše popis aktuální chyby do stderr
Pozicování v souboru	`ftell`		vrátí aktuální pozici ukazatele v souboru
	`fgetpos`		získá ukazatel pozice v souboru
	`fseek`		přesune ukazatel pozice v souboru na specifické místo v souboru
	`fsetpos`		přesune ukazatel pozice v souboru na specifické místo v souboru
	`rewind`		přesune ukazatel pozice v souboru na začátek souboru
Chyba obsluhy	`clearerr`		smaže chyby
	`feof`		kontrola konce souboru
	`ferror`		kontrola chyby souboru
Operace se soubory	`remove`		odstraní soubor
	`rename`		přejmenuje soubor
	`tmpfile`		vrátí ukazatel do dočasného souboru
	`tmpnam`		vrátí unikátní název souboru

Externí odkazy

stdio.h on Coding Programmer Page / C Library Reference and Examples (en)
http://linux.die.net/man/3/fclose – manuálová stránka pro Linux
http://linux.die.net/man/3/fgetc – manuálová stránka pro Linux
http://linux.die.net/man/3/fopen – manuálová stránka pro Linux
http://linux.die.net/man/3/fputc – manuálová stránka pro Linux
Question 12.1 in the C FAQ: using char to hold getc's return value (anglicky)
Zdrojový kód

V tomto článku byl použit překlad textu z článku C file input/output na anglické Wikipedii.