CCppIncludeSearchFilter Class Reference

Gathers build unit dependencies from C/C++ source files withing project into build unit dependency database. More...

#include <depsearch.h>

Inheritance diagram for CCppIncludeSearchFilter:

Public Member Functions
virtual void	Assign (const CCppIncludeSearchFilter &Filter)
	Copies filter settings from another filter. More...
virtual bool	Execute (const CString &FileName, CStringList &Includes)
	Gathers dependencies to Includes string list starting from FileName file. More...
virtual bool	Execute (const CString &FileName, CDependencyInfo &Dependencies)
	Gathers dependencies to Dependencies database starting from FileName file. More...
	CCppIncludeSearchFilter (void)
	Creates dependency search filter. More...
	CCppIncludeSearchFilter (const CCppIncludeSearchFilter &Filter)
	Copies dependency search filter from another filter. More...
	~CCppIncludeSearchFilter (void)
	Destroys dependency search filter. More...
Public Member Functions inherited from CIncludeSearchFilter
virtual void	Clear (void)
	Resets the filter to the initial state. More...
virtual void	Show (void)
	Prints filter settings to standard output. More...
virtual void	Assign (const CIncludeSearchFilter &Filter)
	Copies filter settings from another filter. More...
void	AddIncludeDirectory (const CString &Path)
	Adds Path path to the list of unit lookup directories. More...
void	AddIncludeDirectories (const CStringList &Paths)
	Adds Paths list of paths to the list of unit lookup directories. More...
void	AddMacroDefiniton (const CString &Macro)
	Adds Macro macro to the list of macros. More...
void	AddMacroDefinitons (const CStringList &Macros)
	Adds Macros macros to the list of macros. More...
CString	ResolveIncludePath (const CString &IncludeName)
	Resolves a build unit file name into complete file path. More...
	CIncludeSearchFilter (void)
	Creates dependency search filter. More...
	CIncludeSearchFilter (const CIncludeSearchFilter &Filter)
	Copies dependency search filter from another filter. More...
	~CIncludeSearchFilter (void)
	Destroys dependency search filter. More...

Additional Inherited Members
Protected Attributes inherited from CIncludeSearchFilter
CStringList	m_IncludeDirectories
	a list of directories to look for build units. More...
CStringList	m_DefinedMacros
	a list of preprocessor's macro defnitions. More...

Detailed Description

Gathers build unit dependencies from C/C++ source files withing project into build unit dependency database.

Constructor & Destructor Documentation

CCppIncludeSearchFilter::CCppIncludeSearchFilter

(

void

)

Creates dependency search filter.

CCppIncludeSearchFilter::CCppIncludeSearchFilter

(

const CCppIncludeSearchFilter &

Filter)

Copies dependency search filter from another filter.

Parameters

Filter

another dependency search filter.

CCppIncludeSearchFilter::~CCppIncludeSearchFilter

(

void

)

Destroys dependency search filter.

Member Function Documentation

CCppIncludeSearchFilter::Assign ( const CCppIncludeSearchFilter &  Filter)

virtual

Copies filter settings from another filter.

Parameters

Filter

another filter.

bool CCppIncludeSearchFilter::Execute ( const CString &  FileName, CStringList &  Includes  )

virtual

Gathers dependencies to Includes string list starting from FileName file.

Deprecated:

Use CIncludeSearchFilter::Execute(const CString& FileName, CDependencyInfo& Dependencies).

Parameters

FileName	a build unit name.
Includes	a list of build unit names.

Returns

true if dependencies were gather from at least one (starting) file, false otherwise.

Reimplemented from CIncludeSearchFilter.

bool CCppIncludeSearchFilter::Execute ( const CString &  FileName, CDependencyInfo &  Dependencies  )

virtual

Gathers dependencies to Dependencies database starting from FileName file.

Parameters

FileName	a build unit name.
Dependencies	a build unit dependency database.

Returns

true if dependencies were gather from at least one (starting) file, false otherwise.

Reimplemented from CIncludeSearchFilter.

---

The documentation for this class was generated from the following files:

• src/depsearch.h
• src/depsearch.cpp
• src/doc/depsearch.dox