Google

TOP --> CcDoc

class CCcDocPrep

Ccdoc simple pre-processor.

Usage:


 CCcDocPrep pp;
 pp.Define("NT=1");
 pp.Define("FOO");
 pp.UnDefine("SUN");
 pp.Prep("in.cpp","out.cpp");
 
Preprocesses a file.

Author:
Joe Linoff

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

Source:
../../ccdoc/src/ccdocprep.h:38

Constructors Index

CCcDocPrep
[public] Constructor.
~CCcDocPrep
[public] Destructor.


Methods Index

Define
[public] Define a symbol.
FindSym
[public] Find the specified symbol.
GetValue
[public] Get the symbol value.
IsSymDefined
[public] Is the specified symbol defined?
Prep
[public] Pre-process the specified file.
UnDefine
[public] Undefine a symbol.


Constructors

CCcDocPrep

public CCcDocPrep ( ) ;

Constructor.

CCcDocPrep

public ~ CCcDocPrep ( ) ;

Destructor.


Methods

Define

public void Define ( const char * name ,
                     const char * value = 0 ) ;

Define a symbol.

Parameters:
name The name of the symbol.
value The value of the symbol.

UnDefine

public void UnDefine ( const char * name ) ;

Undefine a symbol.

Parameters:
name The name of the symbol.

Prep

public void Prep ( const char * src ,
                   const char * dst ,
                   bool definedByDefaultFlag = false ) ;

Pre-process the specified file.

Parameters:
src The from file.
dst The to file.
definedByDefaultFlag If TRUE, assume that all symbols are defined, otherwise assume that all symbols are undefined.

IsSymDefined

public bool IsSymDefined ( const char * symname ) const ;

Is the specified symbol defined?

Parameters:
symname The symbol name.

Return:
True if it is defined or false otherwise.

GetValue

public long GetValue ( const char * symname ) const ;

Get the symbol value.

Parameters:
symname The symbol name.

Return:
The value of the symbol.

FindSym

public bool FindSym ( bool & global ,
                      long & index ,
                      const char * symname ) const ;

Find the specified symbol.

Parameters:
global Set to true if the sym is in the global list.
index The index in the list.
symname The symbol name.

Return:
True if the symbol was found or false otherwise.

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.