SExpressionForm Class Reference

#include <lispform.hpp>

Inheritance diagram for SExpressionForm:

[legend]Collaboration diagram for SExpressionForm:

[legend]List of all members.

---

Detailed Description

Generic special form.

An object which represents a special form (or a special syntax). Most implementations do not represent such forms with any S-expressions; the InteLib implementation does. A form is created defining a child class of SExpressionForm in which the Call method must be defined. If text representations are enabled, then the TextRepresentation method is to be specified as well as it is left pure virtual by this class.

Definition at line 68 of file lispform.hpp.

Public Member Functions
	SExpressionForm ()
virtual void	Call (const SReference &formtail, IntelibContinuation &cont) const =0
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
	SExpressionForm (const IntelibTypeId &id)
virtual	~SExpressionForm ()
bool	CanDie ()
	Is it OK to delete the object now?

---

Constructor & Destructor Documentation

SExpressionForm::SExpressionForm (   )

Definition at line 71 of file lispform.hpp. References TypeId.

SExpressionForm::SExpressionForm (  const IntelibTypeId &  id  )  [protected]

Definition at line 73 of file lispform.hpp.

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

Definition at line 74 of file lispform.hpp.

---

Member Function Documentation

virtual void SExpressionForm::Call (  const SReference &  formtail, IntelibContinuation &  cont )  const [pure virtual]

Implemented in SExpressionIndirectAccessor, and LExpressionMacro.

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 SExpressionForm::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 from SExpression. Reimplemented in LExpressionMacro. Referenced by SExpressionForm().

---

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

• lispform.hpp
• lispform.cpp

---