SExpressionFunction Class Reference

#include <lispform.hpp>

Inheritance diagram for SExpressionFunction:

[legend]Collaboration diagram for SExpressionFunction:

[legend]List of all members.

---

Detailed Description

Generic function.

An S-expression which can be applied to a number of arguments what are to be evaluated before the function is actually called. A function is created defining a child class of SExpressionFunction in which the DoApply method is to be specified as the method which performs the evaluation. 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 39 of file lispform.hpp.

Public Member Functions
	SExpressionFunction (int min, int max)
void	Apply (int paramc, const SReference *paramv, IntelibContinuation &cont) const
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
	SExpressionFunction (const IntelibTypeId &id, int min, int max)
virtual	~SExpressionFunction ()
virtual void	DoApply (int paramc, const SReference *paramv, IntelibContinuation &cont) const =0
bool	CanDie ()
	Is it OK to delete the object now?
Protected Attributes
int	min_param
int	max_param

---

Constructor & Destructor Documentation

SExpressionFunction::SExpressionFunction (  int  min, int  max )

Definition at line 44 of file lispform.hpp. References max_param, min_param, and TypeId.

SExpressionFunction::SExpressionFunction (  const IntelibTypeId &  id, int  min, int  max )  [protected]

Definition at line 47 of file lispform.hpp. References max_param, and min_param.

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

Definition at line 49 of file lispform.hpp.

---

Member Function Documentation

void SExpressionFunction::Apply (  int  paramc, const SReference *  paramv, IntelibContinuation &  cont )  const

Definition at line 24 of file lispform.cpp. References DoApply(), max_param, and min_param.

virtual void SExpressionFunction::DoApply (  int  paramc, const SReference *  paramv, IntelibContinuation &  cont )  const [protected, pure virtual]

Implemented in LExpressionLambda, LExpressionUserCFunction, and SchExpressionLambda. Referenced by Apply().

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

int SExpressionFunction::min_param [protected]

Definition at line 41 of file lispform.hpp. Referenced by Apply(), and SExpressionFunction().

int SExpressionFunction::max_param [protected]

Definition at line 41 of file lispform.hpp. Referenced by Apply(), and SExpressionFunction().

IntelibTypeId SExpressionFunction::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 LExpressionLambda, LExpressionUserCFunction, and SchExpressionLambda. Referenced by SExpressionFunction().

---

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

• lispform.hpp
• lispform.cpp

---