Google

TOP --> CcDoc

class CCcDocCtf

CcDoc Token Format (CTF) handler.

Author:
Joe Linoff

Version:
$Id: ccdocctf.h,v 1.4 1999/06/12 18:10:33 jdl Exp $

Source:
../../ccdoc/src/ccdocctf.h:29

Constructors Index

CCcDocCtf
[public] Constructor.
~CCcDocCtf
[public] Destructor.


Methods Index

Add
[public] Add a parse tree.
GetXrefNodesByName
[public] Get the list of level 1 parser nodes associated with this name. This is used for cross referencing by name.
Read
[public] Read a CTF file.
Read
[public] Read a CTF file with an exclude list. If the exclude list is not empty then the cross reference information will be ignored because it will be invalid.
SetVerboseFlag
[public] Set the verbose flag.
UpdateNodeId
[public] Used by the callback functions to update a node id.
Walk
[public] Walk through all of the nodes of all of the trees.
WalkRoots
[public] Walk through all of the root nodes of all of the trees.
Write
[public] Write a CTF file.
Xref
[public] Generate the cross reference information.


Constructors

CCcDocCtf

public CCcDocCtf ( ) ;

Constructor.

CCcDocCtf

public ~ CCcDocCtf ( ) ;

Destructor.


Methods

SetVerboseFlag

public void SetVerboseFlag ( bool f ) ;

Set the verbose flag.

Parameters:
f The flag.

Add

public void Add ( CCcDocParserNode * tree ) ;

Add a parse tree.

Parameters:
tree The parse tree.

Read

public void Read ( const char * ctf ) ;

Read a CTF file.

Parameters:
ctf The name of the ctf file.

Read

public void Read ( const char * ctf ,
                   CJdlStringList & excludeList ) ;

Read a CTF file with an exclude list. If the exclude list is not empty then the cross reference information will be ignored because it will be invalid.

Parameters:
ctf The name of the ctf file.
excludeList The list of files to exclude.

Write

public void Write ( const char * ctf ,
                    const char * phase ) ;

Write a CTF file.

Parameters:
ctf The name of the new ctf file.
phase The header in the file that indicates the phase of processing completed.

Walk

public void Walk ( void ( * fct ) ( CCcDocParserNode * node , void * arg ) ,
                   void * arg ) ;

Walk through all of the nodes of all of the trees.

Parameters:
fct The callback function.
arg A user argument.

WalkRoots

public void WalkRoots ( void ( * fct ) ( CCcDocParserNode * node , void * arg ) ,
                        void * arg ) ;

Walk through all of the root nodes of all of the trees.

Parameters:
fct The callback function.
arg A user argument.

Xref

public void Xref ( ) ;

Generate the cross reference information.

GetXrefNodesByName

public CJdlVector < CCcDocParserNode * > * GetXrefNodesByName ( const char * name ) ;

Get the list of level 1 parser nodes associated with this name. This is used for cross referencing by name.

Parameters:
name The name of the node.

Return:
The list of associated nodes or NULL if no nodes are associated with this name.

UpdateNodeId

public void UpdateNodeId ( CCcDocParserNode * node ) ;

Used by the callback functions to update a node id.

Parameters:
node The node.

This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.

Click here to return to the top of the page.