Input/Output stream.
More...
#include <iostream.h>
List of all members.
Public Types |
typedef unsigned int | fmtflags |
typedef unsigned char | iostate |
typedef int32_t | off_type |
typedef uint8_t | openmode |
typedef uint32_t | pos_type |
enum | seekdir { beg,
cur,
end
} |
typedef uint32_t | streamsize |
Public Member Functions |
bool | bad () const |
void | clear (iostate state=goodbit) |
bool | eof () const |
bool | fail () const |
char | fill () |
char | fill (char c) |
fmtflags | flags () const |
fmtflags | flags (fmtflags fl) |
ostream & | flush () |
streamsize | gcount () const |
int | get () |
istream & | get (char &ch) |
istream & | get (char *str, streamsize n, char delim= '\n') |
istream & | getline (char *str, streamsize count, char delim= '\n') |
bool | good () const |
istream & | ignore (streamsize n=1, int delim=-1) |
| operator const void * () const |
bool | operator! () const |
ostream & | operator<< (const signed char *arg) |
ostream & | operator<< (uint32_t arg) |
ostream & | operator<< (const void *arg) |
ostream & | operator<< (pgm arg) |
ostream & | operator<< (int32_t arg) |
ostream & | operator<< (unsigned char arg) |
ostream & | operator<< (ostream &(*pf)(ostream &str)) |
ostream & | operator<< (ios_base &(*pf)(ios_base &str)) |
ostream & | operator<< (bool arg) |
ostream & | operator<< (const char *arg) |
ostream & | operator<< (const unsigned char *arg) |
ostream & | operator<< (char arg) |
ostream & | operator<< (signed char arg) |
ostream & | operator<< (double arg) |
ostream & | operator<< (int16_t arg) |
ostream & | operator<< (uint16_t arg) |
istream & | operator>> (signed char *str) |
istream & | operator>> (unsigned char &ch) |
istream & | operator>> (float &arg) |
istream & | operator>> (int16_t &arg) |
istream & | operator>> (double &arg) |
istream & | operator>> (char *str) |
istream & | operator>> (uint32_t &arg) |
istream & | operator>> (unsigned char *str) |
istream & | operator>> (void *&arg) |
istream & | operator>> (signed char &ch) |
istream & | operator>> (bool &arg) |
istream & | operator>> (ios_base &(*pf)(ios_base &str)) |
istream & | operator>> (char &ch) |
istream & | operator>> (int32_t &arg) |
istream & | operator>> (short &arg) |
istream & | operator>> (istream &(*pf)(istream &str)) |
istream & | operator>> (unsigned short &arg) |
istream & | operator>> (ios &(*pf)(ios &str)) |
istream & | operator>> (uint16_t &arg) |
int | peek () |
int | precision (unsigned int n) |
int | precision () const |
ostream & | put (char ch) |
iostate | rdstate () const |
istream & | seekg (off_type off, seekdir way) |
istream & | seekg (pos_type pos) |
ostream & | seekp (pos_type pos) |
ostream & | seekp (off_type off, seekdir way) |
fmtflags | setf (fmtflags fl) |
fmtflags | setf (fmtflags fl, fmtflags mask) |
void | setstate (iostate state) |
void | skipWhite () |
pos_type | tellg () |
pos_type | tellp () |
void | unsetf (fmtflags fl) |
unsigned | width (unsigned n) |
unsigned | width () |
Static Public Attributes |
static const fmtflags | adjustfield = left | right | internal |
static const openmode | app = 0X4 |
static const openmode | ate = 0X8 |
static const iostate | badbit = 0X01 |
static const fmtflags | basefield = dec | hex | oct |
static const openmode | binary = 0X10 |
static const fmtflags | boolalpha = 0x0100 |
static const fmtflags | dec = 0x0008 |
static const iostate | eofbit = 0x02 |
static const iostate | failbit = 0X04 |
static const iostate | goodbit = 0x00 |
static const fmtflags | hex = 0x0010 |
static const openmode | in = 0X20 |
static const fmtflags | internal = 0x0004 |
static const fmtflags | left = 0x0001 |
static const fmtflags | oct = 0x0020 |
static const openmode | out = 0X40 |
static const fmtflags | right = 0x0002 |
static const fmtflags | showbase = 0x0200 |
static const fmtflags | showpoint = 0x0400 |
static const fmtflags | showpos = 0x0800 |
static const fmtflags | skipws = 0x1000 |
static const openmode | trunc = 0X80 |
static const fmtflags | uppercase = 0x4000 |
Protected Member Functions |
uint8_t | flagsToBase () |
Detailed Description
Member Typedef Documentation
typedef for iostate bitmask
type for relative seek offset
typedef for iostream open mode
type for absolute seek position
unsigned size that can represent maximum file size. (violates spec - should be signed)
Member Enumeration Documentation
enumerated type for the direction of relative seeks
- Enumerator:
beg |
seek relative to the beginning of the stream
|
cur |
seek relative to the current stream position
|
end |
seek relative to the end of the stream
|
Member Function Documentation
bool ios::bad |
( |
| ) |
const [inline, inherited] |
- Returns:
- true if bad bit is set else false.
Clear iostate bits.
- Parameters:
-
[in] | state | The flags you want to set after clearing all flags. |
Reimplemented in fstream, and ofstream.
bool ios::eof |
( |
| ) |
const [inline, inherited] |
- Returns:
- true if end of file has been reached else false.
Warning: An empty file returns false before the first read.
Moral: eof() is only useful in combination with fail(), to find out whether EOF was the cause for failure
bool ios::fail |
( |
| ) |
const [inline, inherited] |
- Returns:
- true if any iostate bit other than eof are set else false.
char ios_base::fill |
( |
| ) |
[inline, inherited] |
char ios_base::fill |
( |
char |
c | ) |
[inline, inherited] |
Set fill character
- Parameters:
-
- Returns:
- old fill character
fmtflags ios_base::flags |
( |
| ) |
const [inline, inherited] |
set format flags
- Parameters:
-
- Returns:
- old flags
uint8_t ios_base::flagsToBase |
( |
| ) |
[inline, protected, inherited] |
- Returns:
- current number base
ostream& ostream::flush |
( |
| ) |
[inline, inherited] |
Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.
- Returns:
- A reference to the ostream object.
streamsize istream::gcount |
( |
| ) |
const [inline, inherited] |
- Returns:
- The number of characters extracted by the last unformatted input function.
int istream::get |
( |
| ) |
[inherited] |
Extract a character if one is available.
- Returns:
- The character or -1 if a failure occurs. A failure is indicated by the stream state.
istream & istream::get |
( |
char & |
c | ) |
[inherited] |
Extract a character if one is available.
- Parameters:
-
[out] | c | location to receive the extracted character. |
- Returns:
- always returns *this. A failure is indicated by the stream state.
Extract characters.
- Parameters:
-
[out] | str | Location to receive extracted characters. |
[in] | n | Size of str. |
[in] | delim | Delimiter |
Characters are extracted until extraction fails, n is less than 1, n-1 characters are extracted, or the next character equals delim (delim is not extracted). If no characters are extracted failbit is set. If end-of-file occurs the eofbit is set.
- Returns:
- always returns *this. A failure is indicated by the stream state.
istream & istream::getline |
( |
char * |
str, |
|
|
streamsize |
n, |
|
|
char |
delim = '\n' |
|
) |
| [inherited] |
Extract characters
- Parameters:
-
[out] | str | Location to receive extracted characters. |
[in] | n | Size of str. |
[in] | delim | Delimiter |
Characters are extracted until extraction fails, the next character equals delim (delim is extracted), or n-1 characters are extracted.
The failbit is set if no characters are extracted or n-1 characters are extracted. If end-of-file occurs the eofbit is set.
- Returns:
- always returns *this. A failure is indicated by the stream state.
bool ios::good |
( |
| ) |
const [inline, inherited] |
- Returns:
- True if no iostate flags are set else false.
Extract characters and discard them.
- Parameters:
-
[in] | n | maximum number of characters to ignore. |
[in] | delim | Delimiter. |
Characters are extracted until extraction fails, n characters are extracted, or the next input character equals delim (the delimiter is extracted). If end-of-file occurs the eofbit is set.
Failures are indicated by the state of the stream.
- Returns:
- *this
ios::operator const void * |
( |
| ) |
const [inline, inherited] |
- Returns:
- null pointer if fail() is true.
bool ios::operator! |
( |
| ) |
const [inline, inherited] |
- Returns:
- true if fail() else false.
ostream& ostream::operator<< |
( |
const char * |
arg | ) |
[inline, inherited] |
Output string
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
int32_t |
arg | ) |
[inline, inherited] |
Output signed long
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
uint32_t |
arg | ) |
[inline, inherited] |
Output uint32_t
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
const void * |
arg | ) |
[inline, inherited] |
Output pointer
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
uint16_t |
arg | ) |
[inline, inherited] |
Output unsigned int
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
pgm |
arg | ) |
[inline, inherited] |
Output a string from flash
- Parameters:
-
[in] | arg | pgm struct pointing to string |
- Returns:
- the stream
ostream& ostream::operator<< |
( |
signed char |
arg | ) |
[inline, inherited] |
Output character
- Parameters:
-
[in] | arg | character to output |
- Returns:
- the stream
call manipulator
- Parameters:
-
- Returns:
- the stream
call manipulator
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
bool |
arg | ) |
[inline, inherited] |
Output bool
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
const signed char * |
arg | ) |
[inline, inherited] |
Output string
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
const unsigned char * |
arg | ) |
[inline, inherited] |
Output string
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
char |
arg | ) |
[inline, inherited] |
Output character
- Parameters:
-
[in] | arg | character to output |
- Returns:
- the stream
ostream& ostream::operator<< |
( |
unsigned char |
arg | ) |
[inline, inherited] |
Output character
- Parameters:
-
[in] | arg | character to output |
- Returns:
- the stream
ostream& ostream::operator<< |
( |
double |
arg | ) |
[inline, inherited] |
Output double
- Parameters:
-
- Returns:
- the stream
ostream& ostream::operator<< |
( |
int16_t |
arg | ) |
[inline, inherited] |
Output signed int
- Parameters:
-
- Returns:
- the stream
istream& istream::operator>> |
( |
signed char * |
str | ) |
[inline, inherited] |
Extract a character string
- Parameters:
-
[out] | str | location to store the string. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
unsigned char & |
ch | ) |
[inline, inherited] |
Extract a character
- Parameters:
-
[out] | ch | location to store the character. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
double & |
arg | ) |
[inline, inherited] |
Extract a value of type double.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
char * |
str | ) |
[inline, inherited] |
Extract a character string
- Parameters:
-
[out] | str | location to store the string. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
uint32_t & |
arg | ) |
[inline, inherited] |
Extract a value of type uint32_t.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
float & |
arg | ) |
[inline, inherited] |
Extract a value of type float.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
void *& |
arg | ) |
[inline, inherited] |
Extract a value of type void*.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
signed char & |
ch | ) |
[inline, inherited] |
Extract a character
- Parameters:
-
[out] | ch | location to store the character. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
bool & |
arg | ) |
[inline, inherited] |
Extract a value of type bool.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
call manipulator
- Parameters:
-
- Returns:
- the stream
istream& istream::operator>> |
( |
char & |
ch | ) |
[inline, inherited] |
Extract a character
- Parameters:
-
[out] | ch | location to store the character. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
int32_t & |
arg | ) |
[inline, inherited] |
Extract a value of type int32_t.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
short & |
arg | ) |
[inline, inherited] |
Extract a value of type short.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
call manipulator
- Parameters:
-
- Returns:
- the stream
istream& istream::operator>> |
( |
unsigned char * |
str | ) |
[inline, inherited] |
Extract a character string
- Parameters:
-
[out] | str | location to store the string. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
unsigned short & |
arg | ) |
[inline, inherited] |
Extract a value of type unsigned short.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
ios &(*)(ios &str) |
pf | ) |
[inline, inherited] |
call manipulator
- Parameters:
-
- Returns:
- the stream
istream& istream::operator>> |
( |
int16_t & |
arg | ) |
[inline, inherited] |
Extract a value of type int16_t.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
istream& istream::operator>> |
( |
uint16_t & |
arg | ) |
[inline, inherited] |
Extract a value of type uint16_t.
- Parameters:
-
[out] | arg | location to store the value. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
int istream::peek |
( |
| ) |
[inherited] |
Return the next available character without consuming it.
- Returns:
- The character if the stream state is good else -1;
int ios_base::precision |
( |
unsigned int |
n | ) |
[inline, inherited] |
set precision
- Parameters:
-
- Returns:
- old precision
int ios_base::precision |
( |
| ) |
const [inline, inherited] |
ostream& ostream::put |
( |
char |
ch | ) |
[inline, inherited] |
Puts a character in a stream.
The unformatted output function inserts the element ch. It returns *this.
- Parameters:
-
- Returns:
- A reference to the ostream object.
iostate ios::rdstate |
( |
| ) |
const [inline, inherited] |
- Returns:
- The iostate flags for this file.
Set the stream position.
- Parameters:
-
[in] | off | An offset to move the read pointer relative to way. off is a signed 32-bit int so the offset is limited to +- 2GB. |
[in] | way | One of ios::beg, ios::cur, or ios::end. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
Set the stream position
- Parameters:
-
[in] | pos | The absolute position in which to move the read pointer. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
Set the stream position.
- Parameters:
-
[in] | off | An offset to move the write pointer relative to way. off is a signed 32-bit int so the offset is limited to +- 2GB. |
[in] | way | One of ios::beg, ios::cur, or ios::end. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
Set the stream position
- Parameters:
-
[in] | pos | The absolute position in which to move the write pointer. |
- Returns:
- Is always *this. Failure is indicated by the state of *this.
set format flags
- Parameters:
-
[in] | fl | new flags to be or'ed in |
- Returns:
- old flags
modify format flags
- Parameters:
-
[in] | mask | flags to be removed |
[in] | fl | flags to be set after mask bits have been cleared |
- Returns:
- old flags
void ios::setstate |
( |
iostate |
state | ) |
[inline, inherited] |
Set iostate bits.
- Parameters:
-
void istream::skipWhite |
( |
| ) |
[inherited] |
pos_type istream::tellg |
( |
| ) |
[inline, inherited] |
- Returns:
- the stream position
pos_type ostream::tellp |
( |
| ) |
[inline, inherited] |
- Returns:
- the stream position
void ios_base::unsetf |
( |
fmtflags |
fl | ) |
[inline, inherited] |
clear format flags
- Parameters:
-
[in] | fl | flags to be cleared |
- Returns:
- old flags
unsigned ios_base::width |
( |
| ) |
[inline, inherited] |
unsigned ios_base::width |
( |
unsigned |
n | ) |
[inline, inherited] |
set width
- Parameters:
-
- Returns:
- old width
Member Data Documentation
seek to end before each write
open and seek to end immediately after opening
iostate bad bit for a nonrecoverable error.
perform input and output in binary mode (as opposed to text mode)
use strings true/false for bool
iostate bit for end of file reached
iostate fail bit for nonfatal error
fill between sign/base prefix and number
use prefix 0X for hex and 0 for oct
always show '.' for floating numbers
show + sign for nonnegative numbers
truncate an existing stream when opening
use uppercase letters in number representations
The documentation for this class was generated from the following file: