SBacklinkRef Class Reference

#include <sbacklnk.hpp>

Inheritance diagram for SBacklinkRef:

[legend]Collaboration diagram for SBacklinkRef:

[legend]List of all members.

---

Detailed Description

Reference to a SExpressionBacklink.

For internal use only.

This class is not derived from GenericSReference because it can point to PTheEmptyList which might be of a wrong type

Definition at line 97 of file sbacklnk.hpp.

Public Member Functions
	SBacklinkRef ()
	Default constructor (makes unbound reference).
	SBacklinkRef (SExpressionBacklink *ex)
	Constructor from a plain pointer.
	SBacklinkRef (const SReference &ref)
	Constructor from a SReference with type checking.
	SBacklinkRef (const SBacklinkRef &other)
	Copy constructor.
	~SBacklinkRef ()
	The destructor.
SBacklinkRef &	operator= (SExpressionBacklink *ex)
	Assignment.
SBacklinkRef &	operator= (const SBacklinkRef &other)
	Assignment.
SBacklinkRef &	operator= (const SReference &ref)
	Assignment.
void	InsertAfter (const SReference &ref)
	Insert after the current.
bool	Remove ()
	Remove the current element from the list.
SExpressionBacklink *	GetPtr () const
	Get the pointer to the referenced object.
SExpressionBacklink *	operator-> () const
	Field/method selector.
SBacklinkRef	operator, (const SReference &s)
	Append another element to the list.
SBacklinkRef	Begin () const
	Get the first element of the list.
SBacklinkRef	End () const
	Get the last element of the list.
SBacklinkRef &	operator++ ()
	Move forward.
SBacklinkRef &	operator-- ()
	Move backward.
SBacklinkRef	operator++ (int)
	Move forward.
SBacklinkRef	operator-- (int)
	Move backward.
SReference &	AddAnotherItemToList (const SReference &right)
	Add item to list.
SReference &	ChangeListEnd (const SReference &new_last)
	Make/change dotted list.
SReference	MakeCons (const SReference &right) const
	Make a cons.
SReference &	operator|| (const SReference &t)
	dotted list composing operation
SReference	operator^ (const SReference &t) const
	CONS operation.
bool	operator== (const SReference &other) const
	Equality is just pointer comparision.
bool	operator== (const SExpression *other) const
	Equality is just pointer comparision.
bool	operator!= (const SReference &other) const
	Non-equality is just pointer comparision.
bool	operator!= (const SExpression *other) const
	Non-equality is just pointer comparision.
bool	IsEql (const SReference &other) const
bool	IsEqual (const SReference &other) const
SReference &	Car () const
SReference &	Cdr () const
SReference &	CCar () const
SReference &	CCdr () const
intelib_float_t	GetFloat () const
intelib_integer_t	GetInt () const
const char *	GetString () const
char	GetSingleChar () const
template<class Tp>
Tp *	DynamicCastGetPtr () const
template<class Tp>
Tp *	SimpleCastGetPtr () const
SReference	Clone () const
SReference	CopyList () const
SReference	CopyTree () const
bool	IsEmptyList () const
SExpression &	operator * () const
	Dereference.

---

Constructor & Destructor Documentation

SBacklinkRef::SBacklinkRef (   )

Default constructor (makes unbound reference). Definition at line 106 of file sbacklnk.cpp. References PTheEmptyList. Referenced by operator,().

SBacklinkRef::SBacklinkRef (  SExpressionBacklink *  ex  )

Constructor from a plain pointer. Definition at line 110 of file sbacklnk.cpp.

SBacklinkRef::SBacklinkRef (  const SReference &  ref  )

Constructor from a SReference with type checking. Definition at line 119 of file sbacklnk.cpp.

SBacklinkRef::SBacklinkRef (  const SBacklinkRef &  other  )

Copy constructor. Definition at line 115 of file sbacklnk.cpp.

SBacklinkRef::~SBacklinkRef (   )

The destructor. Definition at line 131 of file sbacklnk.cpp.

---

Member Function Documentation

SBacklinkRef& SBacklinkRef::operator= (  SExpressionBacklink *  ex  )

Assignment. Definition at line 111 of file sbacklnk.hpp. References SReference::operator=(). Referenced by SExpressionDoubleList::Iterator::SetBegin(), and SExpressionDoubleList::Iterator::SetEnd().

SBacklinkRef& SBacklinkRef::operator= (  const SBacklinkRef &  other  )

Assignment. Definition at line 114 of file sbacklnk.hpp. References SReference::operator=().

SBacklinkRef & SBacklinkRef::operator= (  const SReference &  ref  )

Assignment. Reimplemented from SReference. Definition at line 134 of file sbacklnk.cpp. References SReference::operator=().

void SBacklinkRef::InsertAfter (  const SReference &  ref  )

Insert after the current. For an empty list, creates a list of one element. Else, just calls SExpressionBacklink::InsertAfter(ref) Reimplemented in SExpressionDoubleList::Iterator. Definition at line 154 of file sbacklnk.cpp. References SExpressionBacklink::InsertAfter(), SReference::IsEmptyList(), and PTheEmptyList. Referenced by SExpressionDoubleList::AddToEnd().

bool SBacklinkRef::Remove (   )

Remove the current element from the list. For empty list, returns false; otherwise, tries to remove the current element and to advance backwards. If there's no previous element, advances forwards. If it is impossible as well, becomes EmptyList (this includes the case of removing the last node from a dotted backlinked list). Reimplemented in SExpressionDoubleList::Iterator. Definition at line 163 of file sbacklnk.cpp. References SReference::Cdr(), SExpressionBacklink::DisconnectBack(), SReference::DynamicCastGetPtr(), SReference::IsEmptyList(), SExpressionBacklink::Prev(), and PTheEmptyList. Referenced by SExpressionDoubleList::Iterator::Remove().

SExpressionBacklink * SBacklinkRef::GetPtr (   )  const

Get the pointer to the referenced object. Warning: Please note that the smart pointer SBacklinkRef may be pointing to the EmptyList object instead of an object of the SExpressionBacklink class. GetPtr() will simply return 0 (null pointer) in this case because the address of EmptyList can not be cast to SExpressionBacklink. Reimplemented from SReference. Definition at line 148 of file sbacklnk.cpp. References SReference::GetPtr(), and SReference::IsEmptyList(). Referenced by SExpressionDoubleList::AddToBegin(), SExpressionDoubleList::AddToEnd(), SDoubleListRange::Copy(), SExpressionDoubleList::Iterator::Exhausted(), SExpressionDoubleList::Iterator::IsBegin(), SDoubleListRange::IsEmpty(), SExpressionDoubleList::Iterator::IsEnd(), operator++(), operator,(), operator--(), operator->(), SExpressionDoubleList::Iterator::Remove(), and SExpressionDoubleList::TextRepresentation().

SExpressionBacklink* SBacklinkRef::operator-> (   )  const

Field/method selector. Reimplemented from GenericReference< SExpression >. Definition at line 145 of file sbacklnk.hpp. References GetPtr().

SBacklinkRef SBacklinkRef::operator, (  const SReference &  s  )

Append another element to the list. Reimplemented from SReference. Definition at line 186 of file sbacklnk.cpp. References SExpressionCons::Cdr(), SReference::DynamicCastGetPtr(), SReference::GetPtr(), GetPtr(), SExpressionBacklink::InsertAfter(), SReference::IsEmptyList(), PTheEmptyList, and SBacklinkRef().

SBacklinkRef SBacklinkRef::Begin (   )  const

Get the first element of the list. Definition at line 206 of file sbacklnk.cpp. References SReference::IsEmptyList().

SBacklinkRef SBacklinkRef::End (   )  const

Get the last element of the list. Definition at line 218 of file sbacklnk.cpp. References SReference::IsEmptyList().

SBacklinkRef & SBacklinkRef::operator++ (   )

Move forward. Definition at line 230 of file sbacklnk.cpp. References SExpressionCons::Cdr(), GetPtr(), and SReference::IsEmptyList().

SBacklinkRef & SBacklinkRef::operator-- (   )

Move backward. Definition at line 236 of file sbacklnk.cpp. References GetPtr(), SReference::IsEmptyList(), and SExpressionBacklink::Prev().

SBacklinkRef SBacklinkRef::operator++ (  int   )

Move forward. Definition at line 242 of file sbacklnk.cpp. References SExpressionCons::Cdr(), GetPtr(), and SReference::IsEmptyList().

SBacklinkRef SBacklinkRef::operator-- (  int   )

Move backward. Definition at line 250 of file sbacklnk.cpp. References GetPtr(), SReference::IsEmptyList(), and SExpressionBacklink::Prev().

SReference& SReference::AddAnotherItemToList (  const SReference &  right  )  [inherited]

Add item to list. For a list, adds another dotted pair to its end. For non-lists, the result is undefined. Referenced by SReference::operator,().

SReference& SReference::ChangeListEnd (  const SReference &  new_last  )  [inherited]

Make/change dotted list. For a proper (non-dotted) list, replaces its terminating () with the given argument, therefore producing a dotted list. for a dotted list, changes it's terminating value (the value which is after the dot) for other types, the result is undefined Referenced by SReference::operator||().

SReference SReference::MakeCons (  const SReference &  right  )  const [inherited]

Make a cons. Produces a cons (dotted pair) using *this as the CAR and the given argument as the CDR Referenced by SReference::operator^().

SReference& SReference::operator|| (  const SReference &  t  )  [inherited]

dotted list composing operation Operator "||" is used to construct dotted lists, like this: ((L| 1, 2, 3) || 4) // (1 2 3 . 4) See also: LListConstructor class Reimplemented in LReference, and SchReference. Definition at line 548 of file sexpress.hpp. References SReference::ChangeListEnd(). Referenced by SchReference::operator||(), and LReference::operator||().

SReference SReference::operator^ (  const SReference &  t  )  const [inherited]

CONS operation. Operator "^" is used to produce conses Definition at line 552 of file sexpress.hpp. References SReference::MakeCons().

bool SReference::operator== (  const SReference &  other  )  const [inherited]

Equality is just pointer comparision. Definition at line 556 of file sexpress.hpp. References SReference::GetPtr().

bool SReference::operator== (  const SExpression *  other  )  const [inherited]

Equality is just pointer comparision. Definition at line 562 of file sexpress.hpp. References SReference::GetPtr().

bool SReference::operator!= (  const SReference &  other  )  const [inherited]

Non-equality is just pointer comparision. Definition at line 559 of file sexpress.hpp. References SReference::GetPtr().

bool SReference::operator!= (  const SExpression *  other  )  const [inherited]

Non-equality is just pointer comparision. Definition at line 565 of file sexpress.hpp. References SReference::GetPtr().

bool SReference::IsEql (  const SReference &  other  )  const [inherited]

Reimplemented in LReference, and SchReference. Referenced by SExprsAreEql().

bool SReference::IsEqual (  const SReference &  other  )  const [inherited]

Reimplemented in LReference, and SchReference. Referenced by SExprsAreEqual().

SReference& SReference::Car (   )  const [inherited]

Referenced by LExpressionMacro::Call(), SDoubleListRange::Copy(), IntelibGenericReader::Get(), RetrieveFunctionObject(), and stack_representation().

SReference& SReference::Cdr (   )  const [inherited]

Referenced by LExpressionMacro::Call(), Remove(), SQueue::RemoveFirst(), RetrieveFunctionObject(), and stack_representation().

SReference& SReference::CCar (   )  const [inherited]

SReference& SReference::CCdr (   )  const [inherited]

intelib_float_t SReference::GetFloat (   )  const [inherited]

Referenced by SExpressionIndirectTemplate< Tt >::Setf().

intelib_integer_t SReference::GetInt (   )  const [inherited]

Referenced by SExpressionIndirectTemplate< Tt >::Setf().

const char* SReference::GetString (   )  const [inherited]

Referenced by SExpressionIndirectTemplate< Tt >::Setf().

char SReference::GetSingleChar (   )  const [inherited]

template<class Tp> Tp * SReference::DynamicCastGetPtr (   )  const [inherited]

Definition at line 687 of file sexpress.hpp. References SReference::GetPtr(), IntelibTypeId::IsSubtypeOf(), and SExpression::TermType(). Referenced by LispLambdaBody::DoAnalyseLambdaList(), SExpressionBacklink::InsertAfter(), operator,(), pretty_print(), IntelibGenericReader::Read(), Remove(), SExpressionBacklink::RemoveNext(), RetrieveFunctionObject(), SQueue::SQueue(), and SExpressionBacklink::~SExpressionBacklink().

template<class Tp> Tp * SReference::SimpleCastGetPtr (   )  const [inherited]

Definition at line 695 of file sexpress.hpp. References SReference::GetPtr(), and SExpression::TermType().

SReference SReference::Clone (   )  const [inherited]

Referenced by SExpressionVector::Clone(), and SExpressionHashTable::Clone().

SReference SReference::CopyList (   )  const [inherited]

SReference SReference::CopyTree (   )  const [inherited]

bool SReference::IsEmptyList (   )  const [inherited]

Referenced by Begin(), LExpressionMacro::Call(), SExpressionBacklink::ConnectBack(), SDoubleListRange::Copy(), End(), SExpressionDoubleList::Exclude(), SDoubleListRange::Exhausted(), SExpressionDoubleList::Iterator::Exhausted(), SDoubleListRange::GetLast(), GetPtr(), InsertAfter(), SExpressionDoubleList::InsertListAfter(), SExpressionDoubleList::Iterator::IsBegin(), SQueue::IsEmpty(), SExpressionDoubleList::Iterator::IsEnd(), operator++(), operator,(), SDoubleListRange::RightEndMover::operator--(), SDoubleListRange::LeftEndMover::operator--(), operator--(), pretty_print(), SExpressionDoubleList::Iterator::Remove(), Remove(), SExpressionBacklink::RemoveNext(), SQueue::SQueue(), stack_representation(), SchReference::TextRepresentation(), LReference::TextRepresentation(), and SExpressionBacklink::~SExpressionBacklink().

SExpression & GenericReference< SExpression >::operator * (   )  const [inherited]

Dereference. Reimplemented in GenericSReference< Tp, X_wrongtype >, GenericSReference< SExpressionStream, IntelibX_not_a_stream >, GenericSReference< SchExpressionContext, IntelibX_scheme_not_a_context >, GenericSReference< SExpressionWrapper< Data >, IntelibX_wrong_expression_type >, GenericSReference< LExpressionSymbol, IntelibX_lisp_not_a_symbol >, GenericSReference< SExpressionDoubleList, IntelibX_not_a_doublelist >, GenericSReference< SExpressionString, IntelibX_not_a_string >, GenericSReference< SExpressionHashPackage, IntelibX_not_a_package >, GenericSReference< SExpressionVector, IntelibX_not_a_vector >, GenericSReference< SExpressionHashTable, IntelibX_not_a_hash_table >, GenericSReference< SchExpressionSymbol, IntelibX_scheme_not_a_symbol >, and GenericSReference< LExpressionContext, IntelibX_lisp_not_a_context >. Definition at line 179 of file refcount.hpp. References GenericReference< Tp >::GetPtr().

---

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

• sbacklnk.hpp
• sbacklnk.cpp

---