SExpression Class Reference

#include <sexpress.hpp>

Inheritance diagram for SExpression:

[legend]Collaboration diagram for SExpression:

[legend]List of all members.

---

Detailed Description

Generic S-expression.

The class represents the most common properties of all possible S-expressions.

Definition at line 162 of file sexpress.hpp.

Public Member Functions
	SExpression (const IntelibTypeId &the_type)
	Constructor.
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
	Identifier for the set of all possible S-expressions.
Protected Member Functions
virtual	~SExpression ()
	The destructor.
bool	CanDie ()
	Is it OK to delete the object now?

---

Constructor & Destructor Documentation

SExpression::SExpression (  const IntelibTypeId &  the_type  )

Constructor. Parameters: the_type  intended for the child classes to pass their (real) type ids

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

The destructor. Note: The destructor is intentionally made protected. This doesn't make much sense for the abstract class, but demonstrates the required practice for all the derived classes. Destructors of all SExpression subclasses MUST be kept protected to ensure that the S-expression objects are only created in the dynamic memory. Definition at line 80 of file sexpress.cpp.

---

Member Function Documentation

const IntelibTypeId& SExpression::TermType (   )  const

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

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]

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]

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]

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

Identifier for the set of all possible S-expressions. Note: It never can be the value of term_type_id because SExpression is an abstract class. SExpression::TypeId is used for unification, to identify the whole world of S-expressions. IntelibTypeId::IsSubtypeOf(SExpression::TypeId) is true for all objects of IntelibTypeId class. Guess why. Reimplemented in SExpressionBacklink, SExpressionDoubleList, SExpressionInt, SExpressionFloat, SExpressionChar, SExpressionString, SExpressionClassicAtom, SExpressionLabel, SExpressionCons, SExpressionHashTable, SExpressionLocation, SExpressionRawBuffer, SExpressionVector, SExpressionWrapper< Data >, SExpressionHashPackage, SExpressionStream, SExpressionStreamFile, SExpressionStreamTextInput, SExpressionSetfAgent, SExpressionFunction, SExpressionForm, LExpressionContext, LExpressionLambda, LExpressionMacro, LExpressionUserCFunction, LExpressionPackage, SExpressionExtvarname, LExpressionSymbol, SchExpressionContext, SchExpressionLambda, SchExpressionPackage, and SchExpressionSymbol. Definition at line 68 of file sexpress.cpp.

---

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

• sexpress.hpp
• sexpress.cpp

---