PUBLIC

MarkerBodyC::MarkerBodyC(void) MarkerBodyC::MarkerBodyC(const StringC &) ObjectBodyC::Name(void) ObjectBodyC::Name(void) const ObjectBodyC::TypeName(void) const ObjectBodyC::SetName(const StringC &) ObjectBodyC::SetComment(const CommentInfoC &) ObjectBodyC::Comment(void) ObjectBodyC::Comment(void) const ObjectBodyC::SetVar(const StringC &,const StringC &) ObjectBodyC::Var(const StringC &) const ObjectBodyC::IsVar(const StringC &) const ObjectBodyC::Dump(ostream &,int) ObjectBodyC::SetScope(ObjectC &) ObjectBodyC::GetScope(void) ObjectBodyC::UpdateComment(CommentInfoC &) ObjectBodyC::HasParentScope(void) const ObjectBodyC::ParentScope(void) ObjectBodyC::ParentScope(void) const ObjectBodyC::SetParentScope(ScopeBodyC *) ObjectBodyC::PathList(void) const ObjectBodyC::FullPath(void) const ObjectBodyC::ActualPath(void) const ObjectBodyC::StartLineno(void) ObjectBodyC::EndLineno(void) ObjectBodyC::CopyLineNo(const ObjectBodyC &) ObjectBodyC::IncludeLineNo(const ObjectBodyC &) ObjectBodyC::CopyLineNo(const ObjectC &) ObjectBodyC::IncludeLineNo(const ObjectC &) ObjectBodyC::TemplArgList(void) ObjectBodyC::IsTemplate(void) const ObjectBodyC::BaseName(void) const ObjectBodyC::Hash(void) const ObjectBodyC::operator==(const ObjectC &) const ObjectBodyC::FullName(RCHashARC &,DesciptionGeneratorC &,int) const ObjectBodyC::Subst(RCHashARC &) const BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const RefCounterBaseC::Label(void) const

MarkerBodyC
Marker object. like a class, struct, or namespace.
include	"amma/Cxx/Object.hh"
User Level:	Default
Library:	CxxDoc
Example:	exEndPoint.cc
Section:	default.Charles Galambos
In Scope:	CxxParser

Parent Classes:

public ObjectBodyC

MarkerBodyC()

Default constructor.

MarkerBodyC(const StringC & nname)

Constructor.

StringC & Name()

Name of object.

const StringC & Name() const

Name of object.

const char * TypeName() const

Get name of object type.

void SetName(const StringC & nname)

Set name of object.

void SetComment(const CommentInfoC & cinf)

Set comment information.

CommentInfoC & Comment()

Access comment.

const CommentInfoC & Comment() const

Access comment.

void SetVar(const StringC & nm,const StringC & value)

Set variable.

StringC Var(const StringC & nm) const

Get variable.

bool IsVar(const StringC & nm) const

Test if variable is set.

void Dump(ostream & out,int indent = 0)

Dump to 'out' in human readable form.

void SetScope(ObjectC & obj)

Set scope for object.

ObjectC GetScope()

Set scope for object.

void UpdateComment(CommentInfoC & newComment)

Update the comments for the object.

bool HasParentScope() const

Has a parent been set ?

ScopeBodyC & ParentScope()

Access parent.
ONLY valid if HasParent() returns true.

const ScopeBodyC & ParentScope() const

Access parent.
ONLY valid if HasParent() returns true.

void SetParentScope(ScopeBodyC * ns)

Setup parent scope.

ObjectListC PathList() const

: Generate path list to this object.

StringC FullPath() const

Get full path to object.

StringC ActualPath() const

Resolve data refrences correctly.

int & StartLineno()

Starting line of object.

int & EndLineno()

End line of object.

void CopyLineNo(const ObjectBodyC & ob)

Copy line no from object.

void IncludeLineNo(const ObjectBodyC & ob)

Include lines into object.

void CopyLineNo(const ObjectC & ob)

Copy line no from object.

void IncludeLineNo(const ObjectC & ob)

Include lines into object.

ObjectListC & TemplArgList()

Access arg list.

bool IsTemplate() const

Is this a templated object ?

const StringC & BaseName() const

Return base name.

UIntT Hash() const

Hash name.

bool operator==(const ObjectC & ob) const

Is equal ?

StringC FullName(RCHashARC<StringC,ObjectC> & templSub,DesciptionGeneratorC & dg = defaultDescGen,int maxDepth = 30) const

Get full name of object
template args and all.

ObjectC Subst(RCHashARC<StringC,ObjectC> & subst) const

Create a new object with subsituted args.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BooleanT operator==(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT operator!=(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT Save(ostream & out) const

Save to ostream.

void AddReference()

Another reference to the object has been created.

void RemoveReference()

One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const

This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)

This locks the object.

BooleanT IsConst(void) const

Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const

Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const

Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const

Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const

Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const

Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const

Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)

It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const

Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const

Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)

Test user flag.

void UserBitZero(IntT x)

Set bit to zero.

void ReportBRCError(char * Msg)

Report error, used in BRCPtrC.

UIntT Hash() const

Hash on address of object.

LabelT Label() const

Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.