Difference between revisions of "cpp/io"
(more hierarchical organization, rewording) |
m (→See also: +Filesystem library) |
||
(33 intermediate revisions by 19 users not shown) | |||
Line 1: | Line 1: | ||
{{title|Input/output library}} | {{title|Input/output library}} | ||
− | {{cpp/io/ | + | {{cpp/io/navbar}} |
− | C++ includes | + | C++ includes the following input/output libraries: an [[enwiki:Object-oriented_programming|OOP-style]] [[#Stream-based I/O|stream-based I/O]] library{{rev inl|since=c++23|, [[#Print functions (since C++23)|print-based family]] of functions}}, and the standard set of [[#C-style I/O|C-style I/O]] functions. |
===Stream-based I/O=== | ===Stream-based I/O=== | ||
− | |||
The stream-based input/output library is organized around abstract input/output devices. These abstract devices allow the same code to handle input/output to files, memory streams, or custom adaptor devices that perform arbitrary operations (e.g. compression) on the fly. | The stream-based input/output library is organized around abstract input/output devices. These abstract devices allow the same code to handle input/output to files, memory streams, or custom adaptor devices that perform arbitrary operations (e.g. compression) on the fly. | ||
− | Most of the classes are templated, so they can be adapted to any basic character type. Separate typedefs are provided for the most common basic character types ({{c|char}} and {{c|wchar_t}}). | + | Most of the classes are templated, so they can be adapted to any basic character type. Separate typedefs are provided for the most common basic character types ({{c/core|char}} and {{c/core|wchar_t}}). The classes are organized into the following hierarchy: |
− | {{inheritance diagram | + | {{inheritance diagram/std-io-complete}} |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | }} | + | |
− | {{ | + | {{dsc begin}} |
− | {{ | + | {{dsc h2|Abstraction}} |
− | {{ | + | {{dsc header|ios}} |
− | {{ | + | {{dsc inc|cpp/io/dsc ios_base}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_ios}} |
− | {{ | + | {{dsc header|streambuf}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_streambuf}} |
− | {{ | + | {{dsc header|ostream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_ostream}} |
− | {{ | + | {{dsc header|istream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_istream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_iostream}} |
− | {{ | + | {{dsc h2|File I/O implementation}} |
− | {{ | + | {{dsc header|fstream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_filebuf}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_ifstream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_ofstream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_fstream}} |
− | {{ | + | {{dsc h2|String I/O implementation}} |
− | {{ | + | {{dsc header|sstream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_stringbuf}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_istringstream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_ostringstream}} |
− | {{ | + | {{dsc inc|cpp/io/dsc basic_stringstream}} |
+ | {{dsc h2|Array I/O implementations}} | ||
+ | {{dsc header|spanstream}} | ||
+ | {{dsc inc|cpp/io/dsc basic_spanbuf}} | ||
+ | {{dsc inc|cpp/io/dsc basic_ispanstream}} | ||
+ | {{dsc inc|cpp/io/dsc basic_ospanstream}} | ||
+ | {{dsc inc|cpp/io/dsc basic_spanstream}} | ||
+ | {{dsc header|strstream}} | ||
+ | {{dsc inc|cpp/io/dsc strstreambuf}} | ||
+ | {{dsc inc|cpp/io/dsc istrstream}} | ||
+ | {{dsc inc|cpp/io/dsc ostrstream}} | ||
+ | {{dsc inc|cpp/io/dsc strstream}} | ||
+ | {{dsc h2|Synchronized output}} | ||
+ | {{dsc header|syncstream}} | ||
+ | {{dsc inc|cpp/io/dsc basic_syncbuf}} | ||
+ | {{dsc inc|cpp/io/dsc basic_osyncstream}} | ||
+ | {{dsc end}} | ||
====Typedefs==== | ====Typedefs==== | ||
+ | The following typedefs for common character types are provided in namespace {{tt|std}}: | ||
+ | {{dsc begin}} | ||
+ | {{dsc hitem|Type|Definition}} | ||
+ | {{dsc header|ios}} | ||
+ | {{dsc|{{lc|std::ios}}|{{co|std::basic_ios<char>}}}} | ||
+ | {{dsc|{{lc|std::wios}}|{{co|std::basic_ios<wchar_t>}}}} | ||
+ | {{dsc header|streambuf}} | ||
+ | {{dsc|{{lc|std::streambuf}}|{{co|std::basic_streambuf<char>}}}} | ||
+ | {{dsc|{{lc|std::wstreambuf}}|{{co|std::basic_streambuf<wchar_t>}}}} | ||
+ | {{dsc header|istream}} | ||
+ | {{dsc|{{lc|std::istream}}|{{co|std::basic_istream<char>}}}} | ||
+ | {{dsc|{{lc|std::wistream}}|{{co|std::basic_istream<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::iostream}}|{{co|std::basic_iostream<char>}}}} | ||
+ | {{dsc|{{lc|std::wiostream}}|{{co|std::basic_iostream<wchar_t>}}}} | ||
+ | {{dsc header|ostream}} | ||
+ | {{dsc|{{lc|std::ostream}}|{{co|std::basic_ostream<char>}}}} | ||
+ | {{dsc|{{lc|std::wostream}}|{{co|std::basic_ostream<wchar_t>}}}} | ||
+ | {{dsc header|fstream}} | ||
+ | {{dsc|{{lc|std::filebuf}}|{{co|std::basic_filebuf<char>}}}} | ||
+ | {{dsc|{{lc|std::wfilebuf}}|{{co|std::basic_filebuf<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::ifstream}}|{{co|std::basic_ifstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wifstream}}|{{co|std::basic_ifstream<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::ofstream}}|{{co|std::basic_ofstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wofstream}}|{{co|std::basic_ofstream<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::fstream}}|{{co|std::basic_fstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wfstream}}|{{co|std::basic_fstream<wchar_t>}}}} | ||
+ | {{dsc header|sstream}} | ||
+ | {{dsc|{{lc|std::stringbuf}}|{{co|std::basic_stringbuf<char>}}}} | ||
+ | {{dsc|{{lc|std::wstringbuf}}|{{co|std::basic_stringbuf<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::istringstream}}|{{co|std::basic_istringstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wistringstream}}|{{co|std::basic_istringstream<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::ostringstream}}|{{co|std::basic_ostringstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wostringstream}}|{{co|std::basic_ostringstream<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::stringstream}}|{{co|std::basic_stringstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wstringstream}}|{{co|std::basic_stringstream<wchar_t>}}}} | ||
+ | {{dsc header|spanstream}} | ||
+ | {{dsc|{{lc|std::spanbuf}} {{mark c++23}}|{{co|std::basic_spanbuf<char>}}}} | ||
+ | {{dsc|{{lc|std::wspanbuf}} {{mark c++23}}|{{co|std::basic_spanbuf<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::ispanstream}} {{mark c++23}}|{{co|std::basic_ispanstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wispanstream}} {{mark c++23}}|{{co|std::basic_ispanstream<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::ospanstream}} {{mark c++23}}|{{co|std::basic_ospanstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wospanstream}} {{mark c++23}}|{{co|std::basic_ospanstream<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::spanstream}} {{mark c++23}}|{{co|std::basic_spanstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wspanstream}} {{mark c++23}}|{{co|std::basic_spanstream<wchar_t>}}}} | ||
+ | {{dsc header|syncstream}} | ||
+ | {{dsc|{{lc|std::syncbuf}} {{mark c++20}}|{{co|std::basic_syncbuf<char>}}}} | ||
+ | {{dsc|{{lc|std::wsyncbuf}} {{mark c++20}}|{{co|std::basic_syncbuf<wchar_t>}}}} | ||
+ | {{dsc|{{lc|std::osyncstream}} {{mark c++20}}|{{co|std::basic_osyncstream<char>}}}} | ||
+ | {{dsc|{{lc|std::wosyncstream}} {{mark c++20}}|{{co|std::basic_osyncstream<wchar_t>}}}} | ||
+ | {{dsc end}} | ||
− | + | ====Predefined standard stream objects==== | |
+ | {{dsc begin}} | ||
+ | {{dsc header|iostream}} | ||
+ | {{dsc inc|cpp/io/dsc cin}} | ||
+ | {{dsc inc|cpp/io/dsc cout}} | ||
+ | {{dsc inc|cpp/io/dsc cerr}} | ||
+ | {{dsc inc|cpp/io/dsc clog}} | ||
+ | {{dsc end}} | ||
− | + | ===={{rl|manip|I/O Manipulators}}==== | |
− | + | The stream-based I/O library uses {{rl|manip|I/O manipulators}} (e.g. {{lc|std::boolalpha}}, {{lc|std::hex}}, etc.) to control how streams behave. | |
− | + | ||
− | + | ====Types==== | |
− | + | The following auxiliary types are defined: | |
− | + | {{dsc begin}} | |
− | + | {{dsc header|ios}} | |
− | + | {{dsc inc|cpp/io/dsc streamoff}} | |
− | + | {{dsc inc|cpp/io/dsc streamsize}} | |
+ | {{dsc inc|cpp/io/dsc fpos}} | ||
+ | {{dsc end}} | ||
− | typedef | + | The following typedef names for {{c/core|std::fpos<std::mbstate_t>}} are provided: |
− | + | {{dsc begin}} | |
− | + | {{dsc header|iosfwd}} | |
− | + | {{dsc hitem|Type|Definition}} | |
− | + | {{dsc|{{tt|std::streampos}}|{{c/core|std::fpos<std::char_traits<char>::state_type>}}}} | |
− | + | {{dsc|{{tt|std::wstreampos}}|{{c/core|std::fpos<std::char_traits<wchar_t>::state_type>}}}} | |
+ | {{dsc|{{tt|std::u8streampos}} {{mark c++20}}|{{c/core|std::fpos<std::char_traits<char8_t>::state_type>}}}} | ||
+ | {{dsc|{{tt|std::u16streampos}} {{mark c++11}}|{{c/core|std::fpos<std::char_traits<char16_t>::state_type>}}}} | ||
+ | {{dsc|{{tt|std::u32streampos}} {{mark c++11}}|{{c/core|std::fpos<std::char_traits<char32_t>::state_type>}}}} | ||
+ | {{dsc end}} | ||
− | + | ====Error category interface==== | |
− | + | {{dsc begin}} | |
− | + | {{dsc header|ios}} | |
− | + | {{dsc inc|cpp/io/dsc io_errc}} | |
− | + | {{dsc inc|cpp/io/dsc iostream_category}} | |
− | + | {{dsc end}} | |
− | + | {{anchor|Print functions}} | |
− | + | ===Print functions {{mark since c++23}}=== | |
− | + | The Unicode-aware print-family functions that perform formatted I/O on text that is already formatted. They bring all the performance benefits of {{lc|std::format}}, are locale-independent by default, reduce global state, avoid allocating a temporary {{lc|std::string}} object and calling {{c|operator<<}}, and in general make formatting more efficient compared to [[#Stream-based I/O|iostreams]] and [[#C-style I/O|stdio]]. | |
− | + | ||
− | + | ||
− | + | ||
− | </ | + | |
− | + | The following print-like functions are provided: | |
− | + | {{dsc begin}} | |
− | + | {{dsc header|print}} | |
− | + | {{dsc inc|cpp/io/dsc print}} | |
− | + | {{dsc inc|cpp/io/dsc println}} | |
− | + | {{dsc inc|cpp/io/dsc vprint_unicode}} | |
− | + | {{dsc inc|cpp/io/dsc vprint_nonunicode}} | |
− | + | {{dsc sep}} | |
− | + | {{dsc header|ostream}} | |
− | + | {{dsc inc|cpp/io/basic_ostream/dsc print}} | |
− | + | {{dsc inc|cpp/io/basic_ostream/dsc println}} | |
− | + | {{dsc end}} | |
− | + | ||
− | + | ||
− | The | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | {{ | + | |
− | {{ | + | |
− | {{ | + | |
− | {{ | + | |
− | {{ | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | {{ | + | |
− | {{ | + | |
− | + | ||
− | {{ | + | |
− | {{ | + | |
− | {{ | + | |
− | + | ||
− | {{ | + | |
− | === | + | ==={{rl|c|C-style I/O}}=== |
+ | C++ also includes the {{rl|c|input/output functions defined by C}}, such as {{lc|std::fopen}}, {{lc|std::getc}}, etc. | ||
− | + | ===See also=== | |
+ | {{dsc begin}} | ||
+ | {{dsc|[[cpp/filesystem|Filesystem library]] {{mark since c++17}}}} | ||
+ | {{dsc end}} | ||
− | + | {{langlinks|ar|de|es|fr|it|ja|pl|pt|ru|zh}} | |
− | + | ||
− | + | ||
− | + | ||
− | + |
Latest revision as of 07:56, 9 June 2024
C++ includes the following input/output libraries: an OOP-style stream-based I/O library, print-based family of functions(since C++23), and the standard set of C-style I/O functions.
Contents |
[edit] Stream-based I/O
The stream-based input/output library is organized around abstract input/output devices. These abstract devices allow the same code to handle input/output to files, memory streams, or custom adaptor devices that perform arbitrary operations (e.g. compression) on the fly.
Most of the classes are templated, so they can be adapted to any basic character type. Separate typedefs are provided for the most common basic character types (char and wchar_t). The classes are organized into the following hierarchy:
Inheritance diagram
Abstraction | |
Defined in header
<ios> | |
manages formatting flags and input/output exceptions (class) | |
manages an arbitrary stream buffer (class template) | |
Defined in header
<streambuf> | |
abstracts a raw device (class template) | |
Defined in header
<ostream> | |
wraps a given abstract device (std::basic_streambuf) and provides high-level output interface (class template) | |
Defined in header
<istream> | |
wraps a given abstract device (std::basic_streambuf) and provides high-level input interface (class template) | |
wraps a given abstract device (std::basic_streambuf) and provides high-level input/output interface (class template) | |
File I/O implementation | |
Defined in header
<fstream> | |
implements raw file device (class template) | |
implements high-level file stream input operations (class template) | |
implements high-level file stream output operations (class template) | |
implements high-level file stream input/output operations (class template) | |
String I/O implementation | |
Defined in header
<sstream> | |
implements raw string device (class template) | |
implements high-level string stream input operations (class template) | |
implements high-level string stream output operations (class template) | |
implements high-level string stream input/output operations (class template) | |
Array I/O implementations | |
Defined in header
<spanstream> | |
(C++23) |
implements raw fixed character buffer device (class template) |
(C++23) |
implements fixed character buffer input operations (class template) |
(C++23) |
implements fixed character buffer output operations (class template) |
(C++23) |
implements fixed character buffer input/output operations (class template) |
Defined in header
<strstream> | |
(deprecated in C++98)(removed in C++26) |
implements raw character array device (class) |
(deprecated in C++98)(removed in C++26) |
implements character array input operations (class) |
(deprecated in C++98)(removed in C++26) |
implements character array output operations (class) |
(deprecated in C++98)(removed in C++26) |
implements character array input/output operations (class) |
Synchronized output | |
Defined in header
<syncstream> | |
(C++20) |
synchronized output device wrapper (class template) |
(C++20) |
synchronized output stream wrapper (class template) |
[edit] Typedefs
The following typedefs for common character types are provided in namespace std
:
[edit] Predefined standard stream objects
Defined in header
<iostream> | |
reads from the standard C input stream stdin (global object) | |
writes to the standard C output stream stdout (global object) | |
writes to the standard C error stream stderr, unbuffered (global object) | |
writes to the standard C error stream stderr (global object) |
[edit] I/O Manipulators
The stream-based I/O library uses I/O manipulators (e.g. std::boolalpha, std::hex, etc.) to control how streams behave.
[edit] Types
The following auxiliary types are defined:
Defined in header
<ios> | |
represents relative file/stream position (offset from fpos), sufficient to represent any file size (typedef) | |
represents the number of characters transferred in an I/O operation or the size of an I/O buffer (typedef) | |
represents absolute position in a stream or a file (class template) |
The following typedef names for std::fpos<std::mbstate_t> are provided:
Defined in header
<iosfwd> | |
Type | Definition |
std::streampos
|
std::fpos<std::char_traits<char>::state_type> |
std::wstreampos
|
std::fpos<std::char_traits<wchar_t>::state_type> |
std::u8streampos (C++20)
|
std::fpos<std::char_traits<char8_t>::state_type> |
std::u16streampos (C++11)
|
std::fpos<std::char_traits<char16_t>::state_type> |
std::u32streampos (C++11)
|
std::fpos<std::char_traits<char32_t>::state_type> |
[edit] Error category interface
Defined in header
<ios> | |
(C++11) |
the IO stream error codes (enum) |
(C++11) |
identifies the iostream error category (function) |
[edit] Print functions (since C++23)
The Unicode-aware print-family functions that perform formatted I/O on text that is already formatted. They bring all the performance benefits of std::format, are locale-independent by default, reduce global state, avoid allocating a temporary std::string object and calling operator<<, and in general make formatting more efficient compared to iostreams and stdio.
The following print-like functions are provided:
Defined in header
<print> | |
(C++23) |
prints to stdout or a file stream using formatted representation of the arguments (function template) |
(C++23) |
same as std::print except that each print is terminated by additional new line (function template) |
prints to Unicode capable stdout or a file stream using type-erased argument representation (function) | |
prints to stdout or a file stream using type-erased argument representation (function) | |
Defined in header
<ostream> | |
(C++23) |
outputs formatted representation of the arguments (function template) |
(C++23) |
outputs formatted representation of the arguments with appended '\n' (function template) |
[edit] C-style I/O
C++ also includes the input/output functions defined by C, such as std::fopen, std::getc, etc.
[edit] See also
Filesystem library (since C++17) |