Jpp 19.3.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
JIO::JBufferedReader Class Reference

Buffered binary input. More...

#include <JBufferedIO.hh>

Inheritance diagram for JIO::JBufferedReader:
JIO::JReader JLANG::JBinaryInput JLANG::JAbstractObjectStatus JIO::JFileStreamReader

Public Member Functions

 JBufferedReader (JReader *__in, const int __size=1048576)
 Constructor.
 
 ~JBufferedReader ()
 Destructor.
 
virtual bool getStatus () const override
 Status of reader.
 
virtual void clear () override
 Clear status of reader.
 
virtual int read (char *zbuf, int n) override
 Read byte array.
 
JReaderoperator>> (JSerialisable &object)
 Read serialisable data object.
 
JReaderoperator>> (bool &value)
 
JReaderoperator>> (char &value)
 
JReaderoperator>> (unsigned char &value)
 
JReaderoperator>> (short &value)
 
JReaderoperator>> (unsigned short &value)
 
JReaderoperator>> (int &value)
 
JReaderoperator>> (unsigned int &value)
 
JReaderoperator>> (long int &value)
 
JReaderoperator>> (unsigned long int &value)
 
JReaderoperator>> (long long int &value)
 
JReaderoperator>> (unsigned long long int &value)
 
JReaderoperator>> (float &value)
 
JReaderoperator>> (double &value)
 
JReaderoperator>> (long double &value)
 
JReaderoperator>> (JLANG::JObjectID &value)
 
JReaderload (JSerialisable &object)
 Read object.
 
template<class T >
JReaderload (T &object)
 Read object.
 
 operator bool () const
 Type conversion operator.
 
bool operator! () const
 Negated status of this object.
 

Protected Member Functions

void reset ()
 Reset.
 

Protected Attributes

JLANG::JSinglePointer< JReaderin
 
char * buffer
 internal buffer
 
int size
 size of internal buffer
 
int pos
 pointer to begin of available data
 
int ls
 pointer to end of available data
 
bool eof
 end of file
 

Private Member Functions

 JBufferedReader (const JBufferedReader &)
 
 JBufferedReader (JBufferedReader &&)
 
JBufferedReaderoperator= (const JBufferedReader &)
 
JBufferedReaderoperator= (JBufferedReader &&)
 

Detailed Description

Buffered binary input.

This class implements the JReader interface.

Definition at line 25 of file JBufferedIO.hh.

Constructor & Destructor Documentation

◆ JBufferedReader() [1/3]

JIO::JBufferedReader::JBufferedReader ( JReader * __in,
const int __size = 1048576 )
inline

Constructor.

Note that this object owns the reader pointed to.

Parameters
__inpointer to reader
__sizesize of internal buffer

Definition at line 36 of file JBufferedIO.hh.

36 :
37 in(__in)
38 {
39 size = std::max(__size, 1024);
40 buffer = new char[size];
41
42 reset();
43 }
char * buffer
internal buffer
JLANG::JSinglePointer< JReader > in
int size
size of internal buffer

◆ ~JBufferedReader()

JIO::JBufferedReader::~JBufferedReader ( )
inline

Destructor.

Definition at line 49 of file JBufferedIO.hh.

50 {
51 delete [] buffer;
52 }

◆ JBufferedReader() [2/3]

JIO::JBufferedReader::JBufferedReader ( const JBufferedReader & )
private

◆ JBufferedReader() [3/3]

JIO::JBufferedReader::JBufferedReader ( JBufferedReader && )
private

Member Function Documentation

◆ getStatus()

virtual bool JIO::JBufferedReader::getStatus ( ) const
inlineoverridevirtual

Status of reader.

Returns
status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 60 of file JBufferedIO.hh.

61 {
62 return in->getStatus() || !eof;
63 }
bool eof
end of file

◆ clear()

virtual void JIO::JBufferedReader::clear ( )
inlineoverridevirtual

Clear status of reader.

Reimplemented from JIO::JReader.

Reimplemented in JIO::JFileStreamReader.

Definition at line 69 of file JBufferedIO.hh.

70 {
71 in->clear();
72 }

◆ read()

virtual int JIO::JBufferedReader::read ( char * zbuf,
int n )
inlineoverridevirtual

Read byte array.

Parameters
zbufpointer to byte array
nnumber of bytes
Returns
number of bytes

Implements JLANG::JBinaryInput.

Definition at line 82 of file JBufferedIO.hh.

83 {
84 for (int i = 0; i != n; ) {
85
86 int m = n - i;
87
88 if (m > ls - pos) {
89
90 memmove(buffer, buffer + pos, ls - pos);
91
92 ls -= pos;
93 pos = 0;
94 ls += in->read(buffer + ls, size - ls);
95
96 if (m > ls) {
97
98 if (ls == 0) {
99
100 eof = true;
101
102 return n - i;
103 }
104
105 m = ls;
106 }
107 }
108
109 memcpy(zbuf + i, buffer + pos, m);
110
111 i += m;
112 pos += m;
113 }
114
115 eof = false;
116
117 return n;
118 }
int ls
pointer to end of available data
int pos
pointer to begin of available data
const int n
Definition JPolint.hh:791

◆ reset()

void JIO::JBufferedReader::reset ( )
inlineprotected

Reset.

Definition at line 124 of file JBufferedIO.hh.

125 {
126 pos = 0;
127 ls = 0;
128 eof = true;
129 }

◆ operator=() [1/2]

JBufferedReader & JIO::JBufferedReader::operator= ( const JBufferedReader & )
private

◆ operator=() [2/2]

JBufferedReader & JIO::JBufferedReader::operator= ( JBufferedReader && )
private

◆ operator>>() [1/16]

JReader & JIO::JReader::operator>> ( JSerialisable & object)
inlineinherited

Read serialisable data object.

Parameters
objectserialisable data object
Returns
JReader

Definition at line 81 of file JSerialisable.hh.

82 {
83 return object.read(*this);
84 }

◆ operator>>() [2/16]

JReader & JIO::JReader::operator>> ( bool & value)
inlineinherited

Definition at line 87 of file JSerialisable.hh.

87{ read((char*) &value, sizeof(bool)); return *this; }
virtual int read(char *buffer, const int length)=0
Read byte array.

◆ operator>>() [3/16]

JReader & JIO::JReader::operator>> ( char & value)
inlineinherited

Definition at line 88 of file JSerialisable.hh.

88{ read((char*) &value, sizeof(char)); return *this; }

◆ operator>>() [4/16]

JReader & JIO::JReader::operator>> ( unsigned char & value)
inlineinherited

Definition at line 89 of file JSerialisable.hh.

89{ read((char*) &value, sizeof(unsigned char)); return *this; }

◆ operator>>() [5/16]

JReader & JIO::JReader::operator>> ( short & value)
inlineinherited

Definition at line 90 of file JSerialisable.hh.

90{ read((char*) &value, sizeof(short)); return *this; }

◆ operator>>() [6/16]

JReader & JIO::JReader::operator>> ( unsigned short & value)
inlineinherited

Definition at line 91 of file JSerialisable.hh.

91{ read((char*) &value, sizeof(unsigned short)); return *this; }

◆ operator>>() [7/16]

JReader & JIO::JReader::operator>> ( int & value)
inlineinherited

Definition at line 92 of file JSerialisable.hh.

92{ read((char*) &value, sizeof(int)); return *this; }

◆ operator>>() [8/16]

JReader & JIO::JReader::operator>> ( unsigned int & value)
inlineinherited

Definition at line 93 of file JSerialisable.hh.

93{ read((char*) &value, sizeof(unsigned int)); return *this; }

◆ operator>>() [9/16]

JReader & JIO::JReader::operator>> ( long int & value)
inlineinherited

Definition at line 94 of file JSerialisable.hh.

94{ read((char*) &value, sizeof(long int)); return *this; }

◆ operator>>() [10/16]

JReader & JIO::JReader::operator>> ( unsigned long int & value)
inlineinherited

Definition at line 95 of file JSerialisable.hh.

95{ read((char*) &value, sizeof(unsigned long int)); return *this; }

◆ operator>>() [11/16]

JReader & JIO::JReader::operator>> ( long long int & value)
inlineinherited

Definition at line 96 of file JSerialisable.hh.

96{ read((char*) &value, sizeof(long long int)); return *this; }

◆ operator>>() [12/16]

JReader & JIO::JReader::operator>> ( unsigned long long int & value)
inlineinherited

Definition at line 97 of file JSerialisable.hh.

97{ read((char*) &value, sizeof(unsigned long long int)); return *this; }

◆ operator>>() [13/16]

JReader & JIO::JReader::operator>> ( float & value)
inlineinherited

Definition at line 98 of file JSerialisable.hh.

98{ read((char*) &value, sizeof(float)); return *this; }

◆ operator>>() [14/16]

JReader & JIO::JReader::operator>> ( double & value)
inlineinherited

Definition at line 99 of file JSerialisable.hh.

99{ read((char*) &value, sizeof(double)); return *this; }

◆ operator>>() [15/16]

JReader & JIO::JReader::operator>> ( long double & value)
inlineinherited

Definition at line 100 of file JSerialisable.hh.

100{ read((char*) &value, sizeof(long double)); return *this; }

◆ operator>>() [16/16]

JReader & JIO::JReader::operator>> ( JLANG::JObjectID & value)
inlineinherited

Definition at line 101 of file JSerialisable.hh.

101{ return (*this) >> value.getID(); }
int getID() const
Get identifier.
Definition JObjectID.hh:50

◆ load() [1/2]

JReader & JIO::JReader::load ( JSerialisable & object)
inlineinherited

Read object.

Parameters
objectobject
Returns
this reader

Definition at line 110 of file JSerialisable.hh.

111 {
112 return object.read(*this);
113 }

◆ load() [2/2]

template<class T >
JReader & JIO::JReader::load ( T & object)
inlineinherited

Read object.

Parameters
objectobject
Returns
this reader

Definition at line 123 of file JSerialisable.hh.

124 {
125 return *this >> object;
126 }

◆ operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const
inlineinherited

Type conversion operator.

Returns
status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

34 {
35 return this->getStatus();
36 }
virtual bool getStatus() const =0
Get status of object.

◆ operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const
inlineinherited

Negated status of this object.

Returns
negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

45 {
46 return !(this->getStatus());
47 }

Member Data Documentation

◆ in

JLANG::JSinglePointer<JReader> JIO::JBufferedReader::in
protected

Definition at line 131 of file JBufferedIO.hh.

◆ buffer

char* JIO::JBufferedReader::buffer
protected

internal buffer

Definition at line 133 of file JBufferedIO.hh.

◆ size

int JIO::JBufferedReader::size
protected

size of internal buffer

Definition at line 134 of file JBufferedIO.hh.

◆ pos

int JIO::JBufferedReader::pos
protected

pointer to begin of available data

Definition at line 135 of file JBufferedIO.hh.

◆ ls

int JIO::JBufferedReader::ls
protected

pointer to end of available data

Definition at line 136 of file JBufferedIO.hh.

◆ eof

bool JIO::JBufferedReader::eof
protected

end of file

Definition at line 137 of file JBufferedIO.hh.


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