Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

SExpressionSetfAgent Class Reference

#include <conteval.hpp>

Inheritance diagram for SExpressionSetfAgent:

Inheritance graph
[legend]
Collaboration diagram for SExpressionSetfAgent:

Collaboration graph
[legend]
List of all members.

Detailed Description

Setf agent.

This class is used in case the thing we return should allow SETF on it but it is not a reference to an existing SReference, so that SETF is something else than just an assignment.

Warning:
This is rarely used; if in doubt, you probably don't need it.
Note:
One of the obvious usage cases is an assignment to a C++ global variable accessible via #&varname from Lisp/Scheme and via F&varname from Lisp-like code within C++.

Definition at line 46 of file conteval.hpp.

Public Member Functions

 SExpressionSetfAgent ()
virtual void Setf (const SReference &val)=0
const IntelibTypeIdTermType () const
 Actual S-expression type.
bool IsChangeable () const
 Can it be changed during the lifetime of the object?
virtual SExpressionClone () 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 ~SExpressionSetfAgent ()
bool CanDie ()
 Is it OK to delete the object now?


Constructor & Destructor Documentation

SExpressionSetfAgent::SExpressionSetfAgent  ) 
 

Definition at line 50 of file conteval.hpp.

References TypeId.

virtual SExpressionSetfAgent::~SExpressionSetfAgent  )  [protected, virtual]
 

Definition at line 54 of file conteval.hpp.


Member Function Documentation

virtual void SExpressionSetfAgent::Setf const SReference val  )  [pure virtual]
 

Implemented in SExpressionIndirect, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, SExpressionIndirectTemplate< Tt >, and SExpressionIndirectTemplate< Tt >.

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 SExpressionSetfAgent::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.

Referenced by SExpressionSetfAgent().


The documentation for this class was generated from the following files:
Generated on Tue Dec 18 00:41:28 2007 for InteLib by  doxygen 1.4.1