SExpressionStream Class Reference

#include <sstream.hpp>

Inheritance diagram for SExpressionStream:

[legend]Collaboration diagram for SExpressionStream:

[legend]List of all members.

---

Detailed Description

Abstract (generic) stream.

This class just provides interface for streams, that is, declares operations common for all existing streams.

Definition at line 39 of file sstream.hpp.

Public Member Functions
	SExpressionStream ()
	The constructor.
virtual SString	TextRepresentation ()
virtual int	Getc ()=0
	read one char like fgetc(3)
virtual int	Ungetc (int c)=0
	return a char to the input buffer just like ungetc(3)
virtual int	Putc (int c)=0
	output a single char
virtual int	Puts (char *s)=0
	output a string
virtual char *	Gets (char *buf, int bufsize)=0
	read a string just like fgets(3)
virtual int	Seek (long pos)=0
	perform positioning operation (like lseek(fd, pos, SEEK_SET))
virtual long	Tell ()=0
	return the current position
virtual int	Close ()=0
	close the stream
virtual int	Flush ()=0
	perform flush operation if it is supported
virtual int	Fileno ()=0
	returns the corresponding file descriptor, or -1 if none
const IntelibTypeId &	TermType () const
	Actual S-expression type.
bool	IsChangeable () const
	Can it be changed during the lifetime of the object?
virtual SExpression *	Clone () const
	Clone a changeable object.
virtual class SString	TextRepresentation () const =0
	Text representation of the S-expression.
virtual bool	SpecificEql (const SExpression *) const
	Are the two objects EQL (while not EQ).
Static Public Attributes
static IntelibTypeId	TypeId
	The type identifier.
Protected Member Functions
	SExpressionStream (IntelibTypeId &id)
	~SExpressionStream ()
bool	CanDie ()
	Is it OK to delete the object now?

---

Constructor & Destructor Documentation

SExpressionStream::SExpressionStream (   )

The constructor. Definition at line 45 of file sstream.hpp. References TypeId.

SExpressionStream::SExpressionStream (  IntelibTypeId &  id  )  [protected]

Definition at line 47 of file sstream.hpp.

SExpressionStream::~SExpressionStream (   )  [protected]

Definition at line 48 of file sstream.hpp.

---

Member Function Documentation

SString SExpressionStream::TextRepresentation (   )  [virtual]

Definition at line 27 of file sstream.cpp. References Fileno().

virtual int SExpressionStream::Getc (   )  [pure virtual]

read one char like fgetc(3) Implemented in SExpressionStreamFile, SExpressionStreamCharbuf, and SExpressionStreamTextInput.

virtual int SExpressionStream::Ungetc (  int  c  )  [pure virtual]

return a char to the input buffer just like ungetc(3) Implemented in SExpressionStreamFile, SExpressionStreamCharbuf, and SExpressionStreamTextInput.

virtual int SExpressionStream::Putc (  int  c  )  [pure virtual]

output a single char Implemented in SExpressionStreamFile, and SExpressionStreamCharbuf.

virtual int SExpressionStream::Puts (  char *  s  )  [pure virtual]

output a string Implemented in SExpressionStreamFile, and SExpressionStreamCharbuf.

virtual char* SExpressionStream::Gets (  char *  buf, int  bufsize )  [pure virtual]

read a string just like fgets(3) Implemented in SExpressionStreamFile, SExpressionStreamCharbuf, and SExpressionStreamTextInput.

virtual int SExpressionStream::Seek (  long  pos  )  [pure virtual]

perform positioning operation (like lseek(fd, pos, SEEK_SET)) Implemented in SExpressionStreamFile, and SExpressionStreamCharbuf.

virtual long SExpressionStream::Tell (   )  [pure virtual]

return the current position Implemented in SExpressionStreamFile, and SExpressionStreamCharbuf.

virtual int SExpressionStream::Close (   )  [pure virtual]

close the stream Implemented in SExpressionStreamFile, and SExpressionStreamCharbuf.

virtual int SExpressionStream::Flush (   )  [pure virtual]

perform flush operation if it is supported Implemented in SExpressionStreamFile, and SExpressionStreamCharbuf.

virtual int SExpressionStream::Fileno (   )  [pure virtual]

returns the corresponding file descriptor, or -1 if none Implemented in SExpressionStreamFile, and SExpressionStreamCharbuf. Referenced by TextRepresentation().

const IntelibTypeId& SExpression::TermType (   )  const [inherited]

Actual S-expression type. Definition at line 195 of file sexpress.hpp. Referenced by SReference::DynamicCastGetPtr(), SchReference::IsEql(), LReference::IsEql(), SReference::SimpleCastGetPtr(), SchReference::TextRepresentation(), and LReference::TextRepresentation().

bool SExpression::IsChangeable (   )  const [inherited]

Can it be changed during the lifetime of the object? Definition at line 198 of file sexpress.hpp. References IntelibTypeId::IsChangeable().

virtual SExpression* SExpression::Clone (   )  const [virtual, inherited]

Clone a changeable object. The method should return the pointer created with new Note: It can (and should) return null pointer for non-changeables Warning: This method will hang your program being called for a looped data structure, including looped lists, a hash table which references a list in which it is a member, etc. If you create a changeable S-expression, you MUST make sure this method duplicates your object in such a way that nothing is shared between the old and new objects, that is, changing the new object can not in any way change the old object. Reimplemented in SExpressionBacklink, SExpressionCons, SExpressionHashTable, SExpressionRawBuffer, and SExpressionVector. Definition at line 214 of file sexpress.hpp.

virtual class SString SExpression::TextRepresentation (   )  const [pure virtual, inherited]

Text representation of the S-expression. Returns the text string which represents the given S-expression as for real Lisp (for example, (25 36 49)) Implemented in SExpressionDoubleList, SExpressionInt, SExpressionFloat, SExpressionChar, SExpressionString, SExpressionClassicAtom, SExpressionLabel, SExpressionCons, SExpressionHashTable, SExpressionLocation, SExpressionRawBuffer, SExpressionVector, SExpressionWrapper< Data >, SExpressionIndirect, SExpressionIndirectAccessor, LExpressionContext, LExpressionLambda, LExpressionMacro, LExpressionUserCFunction, SchExpressionContext, and SchExpressionLambda. Referenced by SExpressionVector::TextRepresentation(), SchReference::TextRepresentation(), and LReference::TextRepresentation().

virtual bool SExpression::SpecificEql (  const SExpression *   )  const [virtual, inherited]

Are the two objects EQL (while not EQ). This function is overriden by those SExpressions able to be EQL while being not EQ. Warning: It is not demanded that this function return true if it's arguments are the same SExpression (that is, they're EQ). It is only called by the EQL predicate implementation when it has been checked that the operands are not the same object. Reimplemented in SExpressionInt, SExpressionFloat, SExpressionChar, and SExpressionString. Definition at line 235 of file sexpress.hpp. Referenced by SchReference::IsEql(), and LReference::IsEql().

bool GarbageSafe::CanDie (   )  [protected, inherited]

Is it OK to delete the object now? Our children have no access to the private attribute RefCount and should never need it except when checking if the destruction is not an error. This solves the problem. Definition at line 53 of file refcount.hpp.

---

Member Data Documentation

IntelibTypeId SExpressionStream::TypeId [static]

The type identifier. Reimplemented from SExpression. Reimplemented in SExpressionStreamFile, and SExpressionStreamTextInput. Referenced by SExpressionStream().

---

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

• sstream.hpp
• sstream.cpp

---