SExpressionLabel Class Reference

#include <sexpress.hpp>

Inheritance diagram for SExpressionLabel:

[legend]Collaboration diagram for SExpressionLabel:

[legend]List of all members.

---

Detailed Description

Label (S-expression whose address is the only thing important).

SExpressionLabel can be used for:

• Scheme-flavor empty list representation
• Scheme-flavor booleans
• CommonLisp-flavor keywords
• etc, that is, it is suggested to be used when there's an S-expression which exists one and only one of it's kind and plays a special role just because it is that one, not because of it's type, state, values etc.

  Besides that, it could be convenient to represent the notion of a

  Lisp Symbol with a class derived from SExpressionLabel.

Definition at line 432 of file sexpress.hpp.

Public Member Functions
	SExpressionLabel (const char *a_name)
virtual SString	TextRepresentation () const
	Text representation of the S-expression.
const char *	GetName () 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 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
	SExpressionLabel (const IntelibTypeId &the_type, const char *a_name)
	~SExpressionLabel ()
bool	CanDie ()
	Is it OK to delete the object now?

---

Constructor & Destructor Documentation

SExpressionLabel::SExpressionLabel (  const IntelibTypeId &  the_type, const char *  a_name )  [protected]

SExpressionLabel::SExpressionLabel (  const char *  a_name  )

SExpressionLabel::~SExpressionLabel (   )  [protected]

Definition at line 364 of file sexpress.cpp.

---

Member Function Documentation

virtual SString SExpressionLabel::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.

const char* SExpressionLabel::GetName (   )  const

Definition at line 440 of file sexpress.hpp. Referenced by SExpressionHashPackage::Import().

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 SExpressionLabel::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 LExpressionSymbol, and SchExpressionSymbol.

---

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

• sexpress.hpp
• sexpress.cpp

---