PUBLIC

TextPBuffC::TextPBuffC(void) TextPBuffC::Load(const FilenameC &) TextPBuffC::AppendFile(const FilenameC &) TextPBuffC::Load(istream &) TextPBuffC::Append(istream &) TextPBuffC::SaveAs(const StringC &) TextPBuffC::AppendLine(const StringC &,BooleanT) TextPBuffC::Append(const StringC &,BooleanT) TextPBuffC::Empty(void) TextPBuffC::Dump(ostream &) const TextPBuffC::NoLines(void) const TextPBuffC::IsReadonly(void) const TextPBuffC::SetModified(void) TextPBuffC::Lines(void) TextPBuffC::operator[](IndexT) TextPBuffC::IsModified(void) const TextPBuffC::SetReadonly(BooleanT) 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

TextPBuffC
This is a body class for TextPFileC.
include	"amma/TxtPBuff.hh"
User Level:	Default
Library:	TextProc
Example:	exDPSplit.cc
Section:	Basic Types.Text Text Processing
In Scope:	std

Comments:
You shouldn't use this directly.

public BodyRefCounterC
public TextPFileBaseC

TextPBuffC()

Create a empty text buffer.

BooleanT Load(const FilenameC & Filename)

Try and load a file.

BooleanT AppendFile(const FilenameC & Filename)

Append a file to the end of this one.

BooleanT Load(istream & strm)

Create buffer from stream.

BooleanT Append(istream & strm)

Append contents of a stream to this file.

BooleanT SaveAs(const StringC & Filename)

Try and save this file as another name.

TextPFileBaseC::LineNoT AppendLine(const StringC & text,BooleanT noFinalRet = false)

Append a line of text to file.
returns LineNo or -1 if failed.

TextPFileBaseC::LineNoT Append(const StringC & text,BooleanT noFinalRet = false)

Append a line of text to file.
returns LineNo or -1 if failed.

void Empty()

Empty all contents, set name to noname

void Dump(ostream & strm) const

Dump to stdout.

LineNoT NoLines() const

Return number of lines in buffer.

BooleanT IsReadonly() const

Is readonly ?

void SetModified()

Set renumber flag.

DListC<TextPFileLineC> & Lines()

Access list of lines directly.

StringC & operator[](IndexT x)

Access a line in the file.

BooleanT IsModified() const

Has buffer been modified ?

void SetReadonly(BooleanT newval)

Set readonly flag for file.

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.