cbp2make
Makefile generation tool for Code::Blocks IDE
Public Member Functions | Protected Attributes | List of all members
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:
CCppIncludeSearchFilter

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() [1/2]

CIncludeSearchFilter::CIncludeSearchFilter ( void  )

Creates dependency search filter.

◆ CIncludeSearchFilter() [2/2]

CIncludeSearchFilter::CIncludeSearchFilter ( const CIncludeSearchFilter Filter)

Copies dependency search filter from another filter.

Parameters
Filteranother dependency search filter.

◆ ~CIncludeSearchFilter()

CIncludeSearchFilter::~CIncludeSearchFilter ( void  )

Destroys dependency search filter.

Member Function Documentation

◆ AddIncludeDirectories()

CIncludeSearchFilter::AddIncludeDirectories ( const CStringList Paths)

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

Parameters
Pathsa list of directories.

◆ AddIncludeDirectory()

CIncludeSearchFilter::AddIncludeDirectory ( const CString Path)

Adds Path path to the list of unit lookup directories.

Parameters
Patha directory path.

◆ AddMacroDefiniton()

CIncludeSearchFilter::AddMacroDefiniton ( const CString Macro)

Adds Macro macro to the list of macros.

Parameters
Macroname of a macro definition.

◆ AddMacroDefinitons()

CIncludeSearchFilter::AddMacroDefinitons ( const CStringList Macros)

Adds Macros macros to the list of macros.

Parameters
Macrosa list of names of macro definitions.

◆ Assign()

CIncludeSearchFilter::Assign ( const CIncludeSearchFilter Filter)
virtual

Copies filter settings from another filter.

Parameters
Filteranother filter.

◆ Clear()

CIncludeSearchFilter::Clear ( void  )
virtual

Resets the filter to the initial state.

◆ Execute() [1/2]

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
FileNamea build unit name.
Includesa list of build unit names.
Returns
true if dependencies were gather from at least one (starting) file, false otherwise.

Reimplemented in CCppIncludeSearchFilter.

◆ Execute() [2/2]

CIncludeSearchFilter::Execute ( const CString FileName,
CDependencyInfo Dependencies 
)
virtual

Gathers dependencies to Dependencies database starting from FileName file.

Parameters
FileNamea build unit name.
Dependenciesa build unit dependency database.
Returns
true if dependencies were gather from at least one (starting) file, false otherwise.

Reimplemented in CCppIncludeSearchFilter.

◆ ResolveIncludePath()

CIncludeSearchFilter::ResolveIncludePath ( const CString IncludeName)

Resolves a build unit file name into complete file path.

Parameters
IncludeNamea 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.

◆ Show()

CIncludeSearchFilter::Show ( void  )
virtual

Prints filter settings to standard output.

Member Data Documentation

◆ m_DefinedMacros

CIncludeSearchFilter::m_DefinedMacros
protected

a list of preprocessor's macro defnitions.

◆ m_IncludeDirectories

CIncludeSearchFilter::m_IncludeDirectories
protected

a list of directories to look for build units.


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