lti::lispStreamHandler Class Reference
[Storable Interface]

The lispStreamHandler class offer an interface for the functor parameters and other classes to read() and write() them in a LISP-like format. More...

#include <ltiLispStreamHandler.h>

Inheritance diagram for lti::lispStreamHandler:

[legend]

Collaboration diagram for lti::lispStreamHandler:

[legend]

List of all members.

Classes
struct	stackElement
	type for each element of the stack More...
Public Member Functions
	lispStreamHandler ()
	lispStreamHandler (std::ostream &aStream)
	lispStreamHandler (std::istream &aStream)
	lispStreamHandler (const char *aStream)
	lispStreamHandler (const lispStreamHandler &other)
virtual	~lispStreamHandler ()
void	use (std::ostream &aStream)
void	use (std::istream &aStream)
void	clear ()
virtual const char *	getTypeName () const
lispStreamHandler &	copy (const lispStreamHandler &other)
lispStreamHandler &	operator= (const lispStreamHandler &other)
virtual ioHandler *	clone () const
virtual bool	writeBegin ()
virtual bool	writeEnd ()
virtual bool	readBegin ()
virtual bool	readEnd ()
virtual bool	writeSymbol (const std::string &data)
virtual bool	readSymbol (std::string &data)
virtual bool	trySymbol (const std::string &data)
virtual bool	writeComment (const std::string &data)
virtual bool	writeComment (const char *data)
virtual bool	tryBegin ()
virtual bool	tryEnd ()
virtual bool	writeSpaces (const int &s=1)
virtual bool	writeEOL ()
virtual bool	writeKeyValueSeparator ()
virtual bool	writeDataSeparator ()
virtual bool	readKeyValueSeparator ()
virtual bool	readDataSeparator ()
virtual bool	eof ()
virtual bool	restoreLevel ()
virtual void	appendContextStatus () const
write members

virtual bool	write (const std::string &data)
virtual bool	write (const char *data)
virtual bool	write (const double &data)
virtual bool	write (const float &data)
virtual bool	write (const int &data)
virtual bool	write (const unsigned int &data)
virtual bool	write (const char &data)
virtual bool	write (const byte &data)
virtual bool	write (const ubyte &data)
virtual bool	write (const bool &data)
virtual bool	write (const long &data)
virtual bool	write (const unsigned long &data)
virtual bool	write (const short &data)
virtual bool	write (const unsigned short &data)
read members

virtual bool	read (std::string &data)
virtual bool	read (double &data)
virtual bool	read (float &data)
virtual bool	read (int &data)
virtual bool	read (unsigned int &data)
virtual bool	read (char &data)
virtual bool	read (byte &data)
virtual bool	read (ubyte &data)
virtual bool	read (bool &data)
virtual bool	read (long &data)
virtual bool	read (unsigned long &data)
virtual bool	read (short &data)
virtual bool	read (unsigned short &data)
Protected Types
enum	eTokenId { BeginToken, EndToken, SymbolToken, StringToken, ErrorToken }
typedef std::map< std::string, std::string >	cacheType
Protected Member Functions
eTokenId	getNextToken (std::string &token, const bool justTry=false)
eTokenId	getNextTokenFromString (std::string &src, std::string::size_type &srcPos, std::string &token, const bool justTry=false)
void	getNextLine (std::string &newline)
bool	commentFilter ()
bool	isTokenDelimiter (const char &c)
bool	completeLevel (std::string &restOfLevel)
Protected Attributes
std::istream *	inStream
std::string	inString
std::string::size_type	inStringPos
std::ostream *	outStream
bool	supressSpaces
bool	tryEOL
std::list< stackElement >	stack
Static Protected Attributes
static const char	openChar
static const char	closeChar
static const char	separator
static const char	commentChar
static const char	stringChar
static const char	quoteChar

Detailed Description

The lispStreamHandler class offer an interface for the functor parameters and other classes to read() and write() them in a LISP-like format.

This is the LTI-lib standard ioHandler.

If the standard functions atof() and operator<< for numbers consider the locale settings (this occurs in MS-VC++ or newer glibc and gcc with Linux), then the read() and write() methods will also be localed. A typical problem with this "feature" is that if you have a file saved with "LANG=C", the decimal point is a point (e.g. 1.532), and when you try to read it in another locale (for example LANG=de_DE.ISO-8859-1), then all numbers with a decimal point won't be readed correctly, because the method will be expecting a decimal comma (e.g. 1,532).

See also the read and write methods for the basic types for more information

Warning:: The given streams must be "ASCII" streams. If they are created with the binary flag, some weird effects can be expected.

Example:

 // the lisp stream formatting object
 lti::lispStreamHandler lsh;

 // Write example:

 // open a stream in text mode
 std::ofstream out("testfile.bin");
 
 // tell the lisp stream handler to use the given stream
 lsh.use(out);

 lti::write(lsh,"anInteger",5);
 lti::write(lsh,"aString","hello world");

 out.close();
 
 // Read example

 // Open a stream in lisp mode
 std::ifstream in("testfile.bin");

 lsh.use(in);
 int i;
 lti::read(lsh,"anInteger",i);

 std::string str;
 lti::read(lsh,"aString",str);

 in.close();

Member Typedef Documentation

typedef std::map<std::string,std::string> lti::lispStreamHandler::cacheType [protected]

type for the cache of each level, where the value for each symbol is stored

Member Enumeration Documentation

enum lti::lispStreamHandler::eTokenId [protected]

Types of tokens.

Enumerator:

BeginToken	Denotes begin of a level.
EndToken	Denotes end of a level.
SymbolToken	Some atomic token.
StringToken	A string token.
ErrorToken	Unrecognized token.

Constructor & Destructor Documentation

lti::lispStreamHandler::lispStreamHandler ( )

default constructor

lti::lispStreamHandler::lispStreamHandler ( std::ostream & aStream )

default constructor

Warning:: The given stream must be an "ASCII" stream. If it is created with the binary flag, some weird effects can be expected.

lti::lispStreamHandler::lispStreamHandler ( std::istream & aStream )

default constructor

Warning:: The given stream must be an "ASCII" stream. If it is created with the binary flag, some weird effects can be expected.

lti::lispStreamHandler::lispStreamHandler ( const char * aStream )

default constructor.

This constructor uses the given string as input, as if read from a stread.

Warning:: Note that the given string is NOT a filename, but a string containing the data "stream". This is useful especially for the JNI (java native interface). You can of course also use the std::ostringstream and std::istringstream with the other constructors or with the method use().

lti::lispStreamHandler::lispStreamHandler ( const lispStreamHandler & other )

copy constructor

virtual lti::lispStreamHandler::~lispStreamHandler ( ) [virtual]

destructor

Member Function Documentation

virtual void lti::lispStreamHandler::appendContextStatus ( ) const [virtual]

Overload of context status information.

This function should help the users to find errors in their files. It just inserts some contextual information into the status string to help localizing wrong data.

It is useful for streams that can be edited by hand, because the users will make errors!

Reimplemented from lti::ioHandler.

void lti::lispStreamHandler::clear ( )

This method resets all internal state variables (for input and output streams as well) in a way that the next operations behave as if this handler were used for the first time.

This allows the use of the same handler instance after reopening a stream. Alternativelly, you can just call the use(std::istream&) or use(std::ostream&) members to clear the input or output state variables only. If you use this method "within" a read/write process, the behaviour will be unpredictable.

virtual ioHandler* lti::lispStreamHandler::clone ( ) const [virtual]

returns a pointer to a clone of this functor.

eTokenId lti::lispStreamHandler::getNextToken	(	std::string &	token,
		const bool	justTry = `false`
	)			`[protected]`

eTokenId lti::lispStreamHandler::getNextTokenFromString	(	std::string &	src,
		std::string::size_type &	srcPos,
		std::string &	token,
		const bool	justTry = `false`
	)			`[protected]`

lti::lispStreamHandler Class Reference [Storable Interface]

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

lti::lispStreamHandler Class Reference
[Storable Interface]