SExpressionStreamFile Class Reference

#include <sstream.hpp>

Inheritance diagram for SExpressionStreamFile:

[legend]Collaboration diagram for SExpressionStreamFile:

[legend]List of all members.

---

Detailed Description

Stream which encapsulates a FILE* from stdio.h.

Definition at line 89 of file sstream.hpp.

Public Member Functions
	SExpressionStreamFile (FILE *)
virtual int	Getc ()
	read one char like fgetc(3)
virtual int	Ungetc (int c)
	return a char to the input buffer just like ungetc(3)
virtual int	Putc (int c)
	output a single char
virtual int	Puts (char *s)
	output a string
virtual char *	Gets (char *buf, int bufsize)
	read a string just like fgets(3)
virtual int	Seek (long pos)
	perform positioning operation (like lseek(fd, pos, SEEK_SET))
virtual long	Tell ()
	return the current position
virtual int	Close ()
	close the stream
virtual int	Flush ()
	perform flush operation if it is supported
virtual int	Fileno ()
	returns the corresponding file descriptor, or -1 if none
FILE *	GetFile ()
virtual SString	TextRepresentation ()
virtual class SString	TextRepresentation () const =0
	Text representation of the S-expression.
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 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
	SExpressionStreamFile (IntelibTypeId &id, FILE *)
virtual	~SExpressionStreamFile ()
bool	CanDie ()
	Is it OK to delete the object now?

---

Constructor & Destructor Documentation

SExpressionStreamFile::SExpressionStreamFile (  FILE *   )

Definition at line 42 of file sstream.cpp.

SExpressionStreamFile::SExpressionStreamFile (  IntelibTypeId &  id, FILE *  )  [protected]

Definition at line 47 of file sstream.cpp.

SExpressionStreamFile::~SExpressionStreamFile (   )  [protected, virtual]

Definition at line 53 of file sstream.cpp.

---

Member Function Documentation

int SExpressionStreamFile::Getc (   )  [virtual]

read one char like fgetc(3) Implements SExpressionStream. Reimplemented in SExpressionStreamTextInput. Definition at line 56 of file sstream.cpp. Referenced by SExpressionStreamTextInput::Getc().

int SExpressionStreamFile::Ungetc (  int  c  )  [virtual]

return a char to the input buffer just like ungetc(3) Implements SExpressionStream. Reimplemented in SExpressionStreamTextInput. Definition at line 60 of file sstream.cpp. Referenced by SExpressionStreamTextInput::Ungetc().

int SExpressionStreamFile::Putc (  int  c  )  [virtual]

output a single char Implements SExpressionStream. Definition at line 64 of file sstream.cpp.

int SExpressionStreamFile::Puts (  char *  s  )  [virtual]

output a string Implements SExpressionStream. Definition at line 68 of file sstream.cpp.

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

read a string just like fgets(3) Implements SExpressionStream. Reimplemented in SExpressionStreamTextInput. Definition at line 72 of file sstream.cpp. Referenced by SExpressionStreamTextInput::Gets().

int SExpressionStreamFile::Seek (  long  pos  )  [virtual]

perform positioning operation (like lseek(fd, pos, SEEK_SET)) Implements SExpressionStream. Definition at line 76 of file sstream.cpp.

long SExpressionStreamFile::Tell (   )  [virtual]

return the current position Implements SExpressionStream. Definition at line 80 of file sstream.cpp.

int SExpressionStreamFile::Close (   )  [virtual]

close the stream Implements SExpressionStream. Definition at line 88 of file sstream.cpp.

int SExpressionStreamFile::Flush (   )  [virtual]

perform flush operation if it is supported Implements SExpressionStream. Definition at line 84 of file sstream.cpp.

int SExpressionStreamFile::Fileno (   )  [virtual]

returns the corresponding file descriptor, or -1 if none Implements SExpressionStream. Definition at line 94 of file sstream.cpp.

FILE* SExpressionStreamFile::GetFile (   )

Definition at line 112 of file sstream.hpp.

SString SExpressionStream::TextRepresentation (   )  [virtual, inherited]

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

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().

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 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 SExpressionStreamFile::TypeId [static]

The type identifier. Reimplemented from SExpressionStream. Reimplemented in SExpressionStreamTextInput.

---

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

• sstream.hpp
• sstream.cpp

---