SExpressionLocation Class Reference

#include <slocatn.hpp>

Inheritance diagram for SExpressionLocation:

[legend]Collaboration diagram for SExpressionLocation:

[legend]List of all members.

---

Detailed Description

assignable location

The class keeps a pointer to an existing SReference object. To make sure it will exist as long as the SExpressionLocation exists, the object also keeps an SReference to the structure which contains the pointed SReference. For example, if you wish to keep a pointer to a car part of a cons, you should also pass a reference to that cons.

Definition at line 40 of file slocatn.hpp.

Public Member Functions
	SExpressionLocation (const SReference &superstruct, SReference *location)
	The constructor.
void	Assign (const SReference &value) const
	Assign the given value to the location.
virtual class SString	TextRepresentation () const
	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
	~SExpressionLocation ()
bool	CanDie ()
	Is it OK to delete the object now?

---

Constructor & Destructor Documentation

SExpressionLocation::SExpressionLocation (  const SReference &  superstruct, SReference *  location )

The constructor. Parameters: superstruct  is a reference to the data structure which contains the location, e.g., to the cons if the location is its car or cdr, to the symbol if the location is the symbol's dynamic value slot, to the hash table in case the location is a pointer to its slot, etc location  is the location to be kept as the object Definition at line 23 of file slocatn.cpp.

SExpressionLocation::~SExpressionLocation (   )  [protected]

Definition at line 27 of file slocatn.cpp.

---

Member Function Documentation

void SExpressionLocation::Assign (  const SReference &  value  )  const

Assign the given value to the location. Definition at line 62 of file slocatn.hpp.

SString SExpressionLocation::TextRepresentation (   )  const [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)) Implements SExpression. Definition at line 31 of file slocatn.cpp.

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

The type identifier. Reimplemented from SExpression.

---

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

• slocatn.hpp
• slocatn.cpp

---