CIncludeSearchFilter Class Reference

Declares interface for gathering build unit dependencies from project files into build unit dependency database. More...

#include <depsearch.h>

Inheritance diagram for CIncludeSearchFilter:

Public Member Functions
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...
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...
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...

Protected Attributes
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

Declares interface for gathering build unit dependencies from project files into build unit dependency database.

Constructor & Destructor Documentation

CIncludeSearchFilter::CIncludeSearchFilter

(

void

)

Creates dependency search filter.

CIncludeSearchFilter::CIncludeSearchFilter

(

const CIncludeSearchFilter &

Filter)

Copies dependency search filter from another filter.

Parameters

Filter

another dependency search filter.

CIncludeSearchFilter::~CIncludeSearchFilter

(

void

)

Destroys dependency search filter.

Member Function Documentation

CIncludeSearchFilter::AddIncludeDirectories

(

const CStringList &

Paths)

Adds Paths list of paths to the list of unit lookup directories.

Parameters

Paths

a list of directories.

CIncludeSearchFilter::AddIncludeDirectory

(

const CString &

Path)

Adds Path path to the list of unit lookup directories.

Parameters

Path	a directory path.

CIncludeSearchFilter::AddMacroDefiniton

(

const CString &

Macro)

Adds Macro macro to the list of macros.

Parameters

Macro

name of a macro definition.

CIncludeSearchFilter::AddMacroDefinitons

(

const CStringList &

Macros)

Adds Macros macros to the list of macros.

Parameters

Macros

a list of names of macro definitions.

CIncludeSearchFilter::Assign ( const CIncludeSearchFilter &  Filter)

virtual

Copies filter settings from another filter.

Parameters

Filter

another filter.

CIncludeSearchFilter::Clear ( void  )

virtual

Resets the filter to the initial state.

CIncludeSearchFilter::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 in CCppIncludeSearchFilter.

CIncludeSearchFilter::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 in CCppIncludeSearchFilter.

CIncludeSearchFilter::ResolveIncludePath

(

const CString &

IncludeName)

Resolves a build unit file name into complete file path.

Parameters

IncludeName

a build unit file name.

Returns

file path to the build unit if it is successfully found or an empty string if it can't be found.

CIncludeSearchFilter::Show ( void  )

virtual

Prints filter settings to standard output.

Member Data Documentation

CIncludeSearchFilter::m_DefinedMacros

protected

a list of preprocessor's macro defnitions.

CIncludeSearchFilter::m_IncludeDirectories

protected

a list of directories to look for build units.

---

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

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