PUBLIC

DocumentBodyC::DocumentBodyC(const FilenameC &,const StringC &,const DocTreeC &,const StringC &,const StringC &) DocumentBodyC::Foralli(StringC &,bool,bool) DocumentBodyC::Forall(StringC &) DocumentBodyC::IfAny(StringC &) DocumentBodyC::GotoInherit(StringC &) DocumentBodyC::MakeFilenameCmd(StringC &) DocumentBodyC::InsertDocNode(StringC &) DocumentBodyC::AutoLink(StringC &) DocumentBodyC::Exec(StringC &) DocumentBodyC::ForDir(StringC &) DocumentBodyC::Document(ObjectListC &) DocumentBodyC::MakeFilename(ObjectC &,bool) DocumentBodyC::MakeFilename(StringC,ObjectC &,bool) DocumentBodyC::HtmlMethodName(StringC &) DocumentBodyC::GetHtmlTypeName(const DataTypeC &) DocumentBodyC::HtmlTypeName(StringC &) DocumentBodyC::MakeHRef(StringC) DocumentBodyC::Lookup(const StringC &,StringC &) DocumentBodyC::DocTree(void) TemplateComplexBodyC::SetupPresets(const HSetC &) TemplateComplexBodyC::Scan(StringC &) TemplateComplexBodyC::Scan(TextFileC &) TemplateComplexBodyC::Build(StringC &) TemplateComplexBodyC::BuildSub(TextFileC &) TemplateComplexBodyC::Lookup(const StringC &,StringC &) TemplateComplexBodyC::InitCommands(void) TemplateComplexBodyC::Interpret(const StringC &) TemplateComplexBodyC::DoSet(StringC &) TemplateComplexBodyC::DoFor(StringC &) TemplateComplexBodyC::DoIf(StringC &) TemplateComplexBodyC::DoIfSet(StringC &) TemplateComplexBodyC::DoElse(StringC &) TemplateComplexBodyC::DoInclude(StringC &) TemplateComplexBodyC::DoSub(StringC &) TemplateComplexBodyC::DoSubCopy(StringC &) TemplateComplexBodyC::DoSubst(StringC &) TemplateComplexBodyC::DoDefine(StringC &) TemplateComplexBodyC::DoMacro(StringC &,StringC &) TemplateComplexBodyC::DoUpperCase(StringC &) TemplateComplexBodyC::DoLowerCase(StringC &) TemplateComplexBodyC::DoSilent(StringC &) TemplateComplexBodyC::DoErrPrint(StringC &) TemplateComplexBodyC::DoBefore(StringC &) TemplateComplexBodyC::DoAfter(StringC &) TemplateComplexBodyC::HtmlSafe(StringC &) TemplateComplexBodyC::MakeHtml(const StringC &) TemplateComplexBodyC::MakeHtml(const SubStringC &) TemplateComplexBodyC::SetVar(const StringC &,const StringC &) TemplateComplexBodyC::GetVar(const StringC &) TemplateComplexBodyC::SetupCommand(const StringC &,ObjT &,bool (*func)(StringC & arg) ) TemplateComplexBodyC::Output(void) TemplateComplexBodyC::CheckCondition(const SubStringC &) DesciptionGeneratorC::TextFor(char) DesciptionGeneratorC::TextFor(const ObjectC &) DesciptionGeneratorC::TextFor(const StringC &) DesciptionGeneratorC::MethodNameText(const StringC &) RCBodyVC::Save(ostream &) const RCBodyVC::Save(BinOStreamC &) const RCBodyVC::Copy(void) const RCBodyVC::DeepCopy(UIntT) const RCBodyC::References(void) const RCBodyC::Copy(void) const RCBodyC::DeepCopy(UIntT) const RCBodyC::IncRefCounter(void) RCBodyC::DecRefCounter(void)

public TemplateComplexBodyC
public DesciptionGeneratorC

DocumentBodyC(const FilenameC & tmplName,const StringC & outDir,const DocTreeC & docTree = DocTreeC (),const StringC & projName = StringC (),const StringC & projDesc = StringC ())

Default contructor.

bool Foralli(StringC & data,bool ifAny = false,bool inClassScope = false)

Do a forall build.

bool Forall(StringC & data)

Do a forall build.

bool IfAny(StringC & data)

Do a forall build.

bool GotoInherit(StringC & param)

Goto an inherited class.

bool MakeFilenameCmd(StringC & pattern)

Make a filename from a pattern and a full object name.

bool InsertDocNode(StringC & node)

Insert a DocNodeC into the documentation tree.

bool AutoLink(StringC & text)

Automaticly put links in some text.

bool Exec(StringC & text)

Execute a child process.

bool ForDir(StringC & text)

Go through files in a directory.

void Document(ObjectListC & ol)

Document list of files.

FilenameC MakeFilename(ObjectC & obj,bool relative = false)

Makefile name

FilenameC MakeFilename(StringC pattern,ObjectC & obj,bool relative = false)

Make a filename from a pattern and a full object name.

bool HtmlMethodName(StringC & arg)

Make a linked version of the method name.

StringC GetHtmlTypeName(const DataTypeC & tn)

Make a linked version of the method name.

bool HtmlTypeName(StringC & arg)

Make a linked version of the method name.

StringC MakeHRef(StringC name)

Make a string suitable for an href.

bool Lookup(const StringC & varname,StringC & buff)

Lookup variable.
if found put value into 'buff' and return true. otherwise return false.

DocTreeC & DocTree()

Access doc tree.

void SetupPresets(const HSetC<StringC> & nameset)

Setup preset variables.

bool Scan(StringC & templ)

Scan template file for preset variables.
The key, and values are added to the vars list.

bool Scan(TextFileC & templ)

Scan template file for preset variables.
The key, and values are added to the vars list.

bool Build(StringC & fn)

Start build of document.

bool BuildSub(TextFileC & templ)

Start build of document.

bool Lookup(const StringC & varname,StringC & buff)

Lookup variable.
if found put value into 'buff' and return true. otherwise return false.

void InitCommands()

Setup default commands.

StringC Interpret(const StringC & str)

Interpret string 'str' and return the result.

bool DoSet(StringC & txt)

Set variable.

bool DoFor(StringC & txt)

Look over a list.

bool DoIf(StringC & txt)

If condition.

bool DoIfSet(StringC & txt)

If a variable is set.

bool DoElse(StringC & txt)

If a variable is set.

bool DoInclude(StringC & txt)

Include another template file.

bool DoSub(StringC & txt)

Make a sub context.

bool DoSubCopy(StringC & txt)

Make a sub context, copy old context.

bool DoSubst(StringC & txt)

Substution

bool DoDefine(StringC & txt)

Make a sub context, copy old context.

bool DoMacro(StringC & txt,StringC & macro)

Make a sub context, copy old context.

bool DoUpperCase(StringC & txt)

Make all text upper case.

bool DoLowerCase(StringC & txt)

Make all text lower case.

bool DoSilent(StringC & txt)

Make all text lower case.
Redirect output to /dev/null

bool DoErrPrint(StringC & txt)

Print a message to stderr.
Put the text on the stderr.

bool DoBefore(StringC & txt)

Return text before a string.

bool DoAfter(StringC & txt)

Return text after a string.

bool HtmlSafe(StringC & txt)

Make sure text will be taken literally in html.

StringC MakeHtml(const StringC & name)

Make string suitable for use in plain html.

StringC MakeHtml(const SubStringC & name)

Make string suitable for use in plain html.

void SetVar(const StringC & var,const StringC & val)

Set value of a variable.

StringC GetVar(const StringC & var)

Get value of a variable.

void SetupCommand(const StringC & cmd,ObjT & obj,bool (*func)(StringC & arg) )

Setup new command.
NB. Obj is used as a reference, it is assumed to be a derived instance of this class.

OStreamC & Output()

Access current output stream.

bool CheckCondition(const SubStringC & cond)

Check if a condition is met.

StringC TextFor(char let)

Render a character.
Typical used for '<' '>' and the like..

StringC TextFor(const ObjectC & obj)

Render a an object description.

StringC TextFor(const StringC & obj)

Render a string 'as is'.

StringC MethodNameText(const StringC & obj)

Render a method name appropriatly. (e.g. bold.)

bool Save(ostream & out) const

Save to stream 'out'.

bool Save(BinOStreamC & out) const

Save to binary stream 'out'.

RCBodyVC & Copy() const

Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const

Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

UIntT References() const

Access count of handles open to this object.

RCBodyC & Copy() const

Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const

Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()

Increment reference counter.

bool DecRefCounter()

Decrement reference counter.