Sofu Namespace Reference

Contains all Sofu-related stuff. More...

Classes
class	Composite
class	Composite::iterator
struct	Exc
	A base class for all exceptions libsofu will throw. More...
struct	Exc_ReadError
	This is thrown when the stream the library reads from becomes unusable because of an error. More...
struct	Exc_UnassignedIterator
struct	Exc_UnexpectedEndOfFile
	This is thrown when the end of file is reached unexpectedly while parsing. More...
struct	Exc_UnsuccessfulRead
	This is thrown when a syntax error occurs while parsing. More...
struct	Exc_WrongListElemType
struct	Exc_WrongPropertyType
	Thrown when trying to access a property with the wrong converter function - value(), list() or composite(). More...
class	List
class	List::iterator
class	Object
	Abstract base class for nodes of the Sofu parse tree. More...
class	Value
	Represents the type "Value" of the Sofu file format. More...
Functions
void	writeFile (Object *object, const string &filename)
	Writes the parse tree to a file.
void	writeStream (Object *object, ostream &file)
	Writes the parse tree to an std::ostream.
void	writeString (Object *object, string &str)
	Writes the parse tree to an std::string.
Composite *	parseFile (const string &filename)
	Parses a file, creating a parse tree.
Composite *	parseStream (istream &file)
	Parses an std::istream, creating a parse tree.

---

Detailed Description

Contains all Sofu-related stuff.

---

Function Documentation

Composite* parseFile (  const string &  filename  )

Parses a file, creating a parse tree. Parameters: filename  The name of the file to be parsed. Returns: The root of the parse tree structure created by parsing the file. See also: parseStream

Composite* parseStream (  istream &  file  )

Parses an std::istream, creating a parse tree. Parameters: file  The istream to read from. Returns: The root of the parse tree structure created by parsing the stream. See also: parseFile

void writeFile (  Object *  object, const string &  filename )

Writes the parse tree to a file. Parameters: object  The root of the parse tree to output. filename  The name of the file to write to. See also: writeStream writeString

void writeStream (  Object *  object, ostream &  file )

Writes the parse tree to an std::ostream. Parameters: object  The root of the parse tree to output. file  The stream to write to. See also: writeFile writeString

void writeString (  Object *  object, string &  str )

Writes the parse tree to an std::string. Parameters: object  The root of the parse tree to output. str  The string to write to. See also: writeFile writeStream

---