This class manages the package tree and generates the nifty drawing of the package tree.

Nodes with the name "[NULL]" will be ignored which means that you can use the pkg name "[NULL]" for a file that defines packages.

This class is used as follows:

 // Generate a tree that looks like this:
 //   [ROOT] +--> A1 +--> A1B1
 //          |
 //          +--> A2 +--> A2B1
 //                  |
 //                  +--> A2B2
 CCcDocPhase3PkgTree* root = new  CCcDocPhase3PkgTree("[ROOT]",0);
 CCcDocPhase3PkgTree* A1   = new CCcDocPhase3PkgTree("A1",root);
 CCcDocPhase3PkgTree* A2   = new CCcDocPhase3PkgTree("A2",root);
 CCcDocPhase3PkgTree* A1B1 = new CCcDocPhase3PkgTree("A1B1",A1);
 CCcDocPhase3PkgTree* A2B1 = new CCcDocPhase3PkgTree("A2B1",A2);
 CCcDocPhase3PkgTree* A2B2 = new CCcDocPhase3PkgTree("A2B2",A2);
 root->Compile();
 root->Write(stdout,false); // don't print anchors

public CCcDocPhase3PkgTree ( const char * name ,
                             CCcDocPhase3PkgTree * parent ) ;

Constructor.

public ~ CCcDocPhase3PkgTree ( ) ;

Destructor.

public void Compile ( ulong level = 0 ,
                      ulong phase = 0 ) ;

Compile the tree.

Compilation must be completed prior to any write operations.

There are three compilation phases:

• Phase 0: Initialize the max level indicator.
• Phase 1: Order the child nodes and set the preliminary column widths.
• Phase 2: Fix the column widths to guarantee that we get the max.

public void Write ( FILE * fp = stderr ,
                    bool anchorFlag = true ,
                    const char * prefix = 0 ) ;

Write the tree out to a file.

public void WritePath ( FILE * fp = stderr ,
                        bool anchorFlag = true ,
                        bool anchorLastFlag = true ,
                        const char * prefix = 0 ) ;

Write out the path of the current node. This is a simple, straightline representation of the hierarchy associated with the node.

public CCcDocPhase3PkgTree * Find ( const char * name ) const ;

Find a child node with the specified name.

Return:

The child node or NULL if the child node does not exist.

public CCcDocPhase3PkgTree * GetParent ( ) const ;

Get the parent node.

Return:

The parent node or NULL if this is the top node.

public const char * GetName ( ) const ;

Get the name of this node.

Return:

The node name.

public void GetPath ( CJdlString & path ) const ;

Get the hierachical name of this node. Each level hierarchy is separated by a ".".

Return:

The hierachical node name.

public bool IsNull ( ) const ;

Is this a NULL package? A NULL package is one whose name is "[NULL]". They exist to allow documentation developers to create package documentation in a separate "documentation only" file. The contents of these files are used but the files are not associated with any package in the system.

Return:

True if this is NULL package or false otherwise.

public void Dump ( FILE * fp = stderr ,
                   const char * prefix = 0 ,
                   ulong level = 0 ) ;

Dump the contents of the tree for debugging.

public void SetRef ( const char * ref ) ;

Set the external reference. If this is not set, the reference is generated automatically from the tree path.

public void WriteAnchor ( FILE * fp ,
                          bool indexFlag = true ) ;

Write out the HTML anchor statement. Use the external reference if it was set.