Input Stream. More...

#include <istream.h>

Inherits ios.

Inherited by ibufstream, ifstream, and iostream.

Public Member Functions
	istream ()

istream &	operator>> (istream &(*pf)(istream &str))

istream &	operator>> (ios_base &(*pf)(ios_base &str))

istream &	operator>> (ios &(*pf)(ios &str))

istream &	operator>> (char *str)

istream &	operator>> (char &ch)

istream &	operator>> (signed char *str)

istream &	operator>> (signed char &ch)

istream &	operator>> (unsigned char *str)

istream &	operator>> (unsigned char &ch)

istream &	operator>> (bool &arg)

istream &	operator>> (short &arg)

istream &	operator>> (unsigned short &arg)

istream &	operator>> (int &arg)

istream &	operator>> (unsigned int &arg)

istream &	operator>> (long &arg)

istream &	operator>> (unsigned long &arg)

istream &	operator>> (double &arg)

istream &	operator>> (float &arg)

istream &	operator>> (void *&arg)

streamsize	gcount () const

int	get ()

istream &	get (char &ch)

istream &	get (char *str, streamsize n, char delim='\n')

istream &	getline (char *str, streamsize n, char delim='\n')

istream &	ignore (streamsize n=1, int delim=-1)

int	peek ()

pos_type	tellg ()

istream &	seekg (pos_type pos)

istream &	seekg (off_type off, seekdir way)

void	skipWhite ()

Public Member Functions inherited from ios
	ios ()

	operator const void * () const

bool	operator! () const

	operator bool () const

iostate	rdstate () const

bool	good () const

bool	eof () const

bool	fail () const

bool	bad () const

void	clear (iostate state=goodbit)

void	setstate (iostate state)

Public Member Functions inherited from ios_base
	ios_base ()

char	fill ()

char	fill (char c)

fmtflags	flags () const

fmtflags	flags (fmtflags fl)

int	precision () const

int	precision (unsigned int n)

fmtflags	setf (fmtflags fl)

fmtflags	setf (fmtflags fl, fmtflags mask)

void	unsetf (fmtflags fl)

unsigned	width ()

unsigned	width (unsigned n)

Private Member Functions
void	getBool (bool *b)

void	getChar (char *ch)

bool	getDouble (double *value)

template<typename T >
void	getNumber (T *value)

bool	getNumber (uint32_t posMax, uint32_t negMax, uint32_t *num)

void	getStr (char *str)

int16_t	readSkip ()

Private Attributes
size_t	m_gcount

Additional Inherited Members
Public Types inherited from ios_base
enum	seekdir { beg , cur , end }

typedef unsigned char	iostate

typedef uint32_t	streamsize

typedef uint32_t	pos_type

typedef int32_t	off_type

typedef uint64_t	streamsize

typedef uint64_t	pos_type

typedef int64_t	off_type

typedef unsigned int	fmtflags

typedef uint8_t	openmode

Static Public Attributes inherited from ios_base
static const iostate	goodbit = 0x00

static const iostate	badbit = 0X01

static const iostate	eofbit = 0x02

static const iostate	failbit = 0X04

static const fmtflags	left = 0x0001

static const fmtflags	right = 0x0002

static const fmtflags	internal = 0x0004

static const fmtflags	dec = 0x0008

static const fmtflags	hex = 0x0010

static const fmtflags	oct = 0x0020

static const fmtflags	boolalpha = 0x0100

static const fmtflags	showbase = 0x0200

static const fmtflags	showpoint = 0x0400

static const fmtflags	showpos = 0x0800

static const fmtflags	skipws = 0x1000

static const fmtflags	uppercase = 0x4000

static const fmtflags	adjustfield = left \| right \| internal

static const fmtflags	basefield = dec \| hex \| oct

static const openmode	app = 0X4

static const openmode	ate = 0X8

static const openmode	binary = 0X10

static const openmode	in = 0X20

static const openmode	out = 0X40

static const openmode	trunc = 0X80

Protected Member Functions inherited from ios_base
uint8_t	flagsToBase ()

Detailed Description

Input Stream.

Constructor & Destructor Documentation

◆ istream()

istream::istream ( )

inline

Member Function Documentation

◆ gcount()

streamsize istream::gcount ( ) const

inline

Returns: The number of characters extracted by the last unformatted input function.

◆ get() [1/3]

int istream::get ( )

Extract a character if one is available.

Returns: The character or -1 if a failure occurs. A failure is indicated by the stream state.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

◆ get() [2/3]

istream & istream::get ( char & ch )

Extract a character if one is available.

Parameters

[out] ch location to receive the extracted character.

Returns: always returns *this. A failure is indicated by the stream state.

◆ get() [3/3]

istream & istream::get	(	char *	str,
		streamsize	n,
		char	delim = `'\n'`
	)

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.

◆ getBool()

void istream::getBool ( bool * b )

private

◆ getChar()

void istream::getChar ( char * ch )

private

◆ getDouble()

bool istream::getDouble ( double * value )

private

◆ getline()

istream & istream::getline	(	char *	str,
		streamsize	n,
		char	delim = `'\n'`
	)

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.

◆ getNumber() [1/2]

template<typename T >

void istream::getNumber ( T * value )

private

◆ getNumber() [2/2]

bool istream::getNumber	(	uint32_t	posMax,
		uint32_t	negMax,
		uint32_t *	num
	)

private

◆ getStr()

void istream::getStr ( char * str )

private

◆ ignore()

istream & istream::ignore	(	streamsize	n = `1`,
		int	delim = `-1`
	)

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

◆ operator>>() [1/19]

istream & istream::operator>> ( bool & arg )

inline

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.

◆ operator>>() [2/19]

istream & istream::operator>> ( char & ch )

inline

Extract a character

Parameters

[out] ch location to store the character.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [3/19]

istream & istream::operator>> ( char * str )

inline

Extract a character string

Parameters

[out] str location to store the string.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [4/19]

istream & istream::operator>> ( double & arg )

inline

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.

◆ operator>>() [5/19]

istream & istream::operator>> ( float & arg )

inline

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.

◆ operator>>() [6/19]

istream & istream::operator>> ( int & arg )

inline

Extract a value of type int.

Parameters

[out] arg location to store the value.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [7/19]

istream & istream::operator>> ( ios &(*)(ios &str) pf )

inline

call manipulator

Parameters

[in] pf function to call

Returns: the stream

◆ operator>>() [8/19]

istream & istream::operator>> ( ios_base &(*)(ios_base &str) pf )

inline

call manipulator

Parameters

[in] pf function to call

Returns: the stream

◆ operator>>() [9/19]

istream & istream::operator>> ( istream &(*)(istream &str) pf )

inline

call manipulator

Parameters

[in] pf function to call

Returns: the stream

◆ operator>>() [10/19]

istream & istream::operator>> ( long & arg )

inline

Extract a value of type long.

Parameters

[out] arg location to store the value.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [11/19]

istream & istream::operator>> ( short & arg )

inline

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.

◆ operator>>() [12/19]

istream & istream::operator>> ( signed char & ch )

inline

Extract a character

Parameters

[out] ch location to store the character.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [13/19]

istream & istream::operator>> ( signed char * str )

inline

Extract a character string

Parameters

[out] str location to store the string.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [14/19]

istream & istream::operator>> ( unsigned char & ch )

inline

Extract a character

Parameters

[out] ch location to store the character.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [15/19]

istream & istream::operator>> ( unsigned char * str )

inline

Extract a character string

Parameters

[out] str location to store the string.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [16/19]

istream & istream::operator>> ( unsigned int & arg )

inline

Extract a value of type unsigned int.

Parameters

[out] arg location to store the value.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [17/19]

istream & istream::operator>> ( unsigned long & arg )

inline

Extract a value of type unsigned long.

Parameters

[out] arg location to store the value.

Returns: Is always *this. Failure is indicated by the state of *this.

◆ operator>>() [18/19]

istream & istream::operator>> ( unsigned short & arg )

inline

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.

◆ operator>>() [19/19]

istream & istream::operator>> ( void *& arg )

inline

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.

◆ peek()

int istream::peek ( )

Return the next available character without consuming it.

Returns: The character if the stream state is good else -1;

◆ readSkip()

int16_t istream::readSkip ( )

private

◆ seekg() [1/2]

istream & istream::seekg	(	off_type	off,
		seekdir	way
	)

inline

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.

◆ seekg() [2/2]

istream & istream::seekg ( pos_type pos )

inline

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.

◆ skipWhite()

void istream::skipWhite ( )

used to implement ws()

◆ tellg()

pos_type istream::tellg ( )

inline

Returns: the stream position

Member Data Documentation

◆ m_gcount

size_t istream::m_gcount

private

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ istream()

Member Function Documentation

◆ gcount()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getBool()

◆ getChar()

◆ getDouble()

◆ getline()

◆ getNumber() [1/2]

◆ getNumber() [2/2]

◆ getStr()

◆ ignore()

◆ operator>>() [1/19]

◆ operator>>() [2/19]

◆ operator>>() [3/19]

◆ operator>>() [4/19]

◆ operator>>() [5/19]

◆ operator>>() [6/19]

◆ operator>>() [7/19]

◆ operator>>() [8/19]

◆ operator>>() [9/19]

◆ operator>>() [10/19]

◆ operator>>() [11/19]

◆ operator>>() [12/19]

◆ operator>>() [13/19]

◆ operator>>() [14/19]

◆ operator>>() [15/19]

◆ operator>>() [16/19]

◆ operator>>() [17/19]

◆ operator>>() [18/19]

◆ operator>>() [19/19]

◆ peek()

◆ readSkip()

◆ seekg() [1/2]

◆ seekg() [2/2]

◆ skipWhite()

◆ tellg()

Member Data Documentation

◆ m_gcount