alib::files::FileExpressions::Filter Class Reference

Description:

Implementation of abstract class FFilter which uses run-time compiled and evaluated expressions to determine the inclusion of files or directories. Instances of this type can be created with outer classes' method SPFileFilter CreateFilter(const String&)  and, for example, be attached to fields FileFilter, DirectoryFilterPreRecursion and DirectoryFilterPostRecursion of class ScanParameters.

Availability

This class is available only if the module ALib Expressions is included in the ALib Build.

Definition at line 166 of file fileexpressions.inl.

Inheritance diagram for alib::files::FileExpressions::Filter:

Public Method Index:
virtual bool	Includes (const File &node, const system::PathString &parentPath) override
Public Method Index: inherited from alib::files::FFilter
virtual	~FFilter ()=default
	Destructor.

Protected Field Index:
Expression	expression
	The compiled expression.
FileExpressions &	fex
FileExpressions::FexScope	scope
	The scope used with this filter.

Protected Method Index:
	Filter (FileExpressions &pFex, const String &expressionString)

Field Details:

expression

Expression alib::files::FileExpressions::Filter::expression

protected

The compiled expression.

Definition at line 177 of file fileexpressions.inl.

fex

FileExpressions& alib::files::FileExpressions::Filter::fex

protected

A reference to the instance that this filter uses.

Definition at line 174 of file fileexpressions.inl.

scope

FileExpressions::FexScope alib::files::FileExpressions::Filter::scope

protected

The scope used with this filter.

Definition at line 176 of file fileexpressions.inl.

Constructor(s) / Destructor Details:

Filter()

alib::files::FileExpressions::Filter::Filter ( FileExpressions & pFex, const String & expressionString )

protected

Protected constructor. Compiles the given expression. To create an instance of this class, use SPFileFilter CreateFilter(const String&) .

Parameters

pFex	The expression compiler to use.
expressionString	The expression string.

Definition at line 243 of file fileexpressions.cpp.

Method Details:

Includes()

virtual bool alib::files::FileExpressions::Filter::Includes ( const File & node, const system::PathString & parentPath )

inlineoverridevirtual

The filter method.

Parameters

node	The node in the file-tree to examine.
parentPath	The absolute path to the parent directory that the file resides in.

Returns

The result determines, whether the given file or directory has passed the filter or not. Consequently, true means "passed" and false means "filtered out".

Implements alib::files::FFilter.

Definition at line 196 of file fileexpressions.inl.

---

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

• fileexpressions.inl
• fileexpressions.cpp