namespace SourceUtilsN

Utilities for dealing with documentaions variables in header files.

User Level:	Default
Library:	SysUtil
Example:	exEndPoint.cc

Methods:

BooleanT CheckDocVar(TextPFileC & buff,StringC var,StringC value,BooleanT force = FALSE)

Check variable exists in hdr file.
if 'force' is true then update variable regardless if is there already or not.

BooleanT CheckDocVar2(TextPFileC & buff,StringC var,StringC subs,StringC value,BooleanT force = FALSE)

Check variable exists in hdr file.
if 'force' is true then update variable regardless if is there already or not.

StringC GetDocValue(TextPFileC & buff,StringC var)

Find a return a documentation value from the buffer.
Returns empty string if not found.

StringC FindLibrary(FilenameC incFile,const DListC<StringC> & dirs,HashARC<StringC,StringC> & hints,BooleanT verbose = false)

Find the library to use for a header file.

DListC<StringC> ListIncludes(FilenameC fn,BooleanT incSystem = true)

List all the include files used by the C++/C source file 'fn'

HSetC<StringC> ListLibraries(FilenameC fn,const DListC<StringC> & dirs,HashARC<StringC,StringC> & hints,BooleanT verbose = false)

List the libraries used by a header file.
Well... create a set actually. The 'hints' table contains a set of mappings between header files an libraries, this can be used for headers from outside the make system. The 'hints' table is also used to cache the mapping between headerfiles and libraries that have already been recovered.

HSetC<StringC> ListLibraries(DListC<StringC> sources,const DListC<StringC> & dirs,HashARC<StringC,StringC> & hints,BooleanT verbose = false)

List the libraries used by aset of source files.
Well... create a set actually. The 'hints' table contains a set of mappings between header files an libraries, this can be used for headers from outside the make system. The 'hints' table is also used to cache the mapping between headerfiles and libraries that have already been recovered.

BooleanT ReadHintsFile(FilenameC fn,HashARC<StringC,StringC> & hints)

Read in hints from a file.
The 'hints' table won't be cleared, but old entries will be overwritten.

BooleanT WriteHintsFile(FilenameC fn,HashARC<StringC,StringC> & hints)

Write hints into a file.

FilenameC FindLibDef(const StringC & name,StringC & projOut)

Find the specified lib def file.
returns an empty string if not found.