Glob Class Reference

Collect file names matching a pattern. More...

#include <cc/Glob>

Inheritance diagram for Glob:

Public Types
using	Item = String
	Item type.
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.

Public Member Functions
	Glob ()=default
	Create a null globbing pattern.
	Glob (const String &text)
	Create a new globbing pattern from a regular expression text.
bool	read (Out< String > path)
	Get the next matching path.
List< String >	explain () const
	Return a textual representation of the compiled pattern expression
String	text () const
	The regular expression text this pattern was created from.
SourceIterator< Glob >	begin ()
	Iteration start.
SourceIterator< Glob >	end ()
	Iteration end.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
int	useCount () const
	Reference count.
template<class T>
bool	is () const
	Check if this object is of type T.
template<class T>
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.

Additional Inherited Members
Protected Member Functions inherited from Object
template<class T>
T	weak () const
template<class T>
void	initOnce ()
	Create the object state when called the first time.
template<class T>
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Object
template<class T>
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T>
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Collect file names matching a pattern.

See also

DirWalk

Exceptions

TextError

Member Typedef Documentation

Item

using Item = String

Item type.

Constructor & Destructor Documentation

Glob() [1/2]

Glob ( )

default

Create a null globbing pattern.

Glob() [2/2]

Glob ( const String & text )

explicit

Create a new globbing pattern from a regular expression text.

Member Function Documentation

read()

bool read

(

Out< String >

path

)

Get the next matching path.

Parameters

path	Returns the next path

Returns

True if another matching path could be read

explain()

List< String > explain

(

)

const

Return a textual representation of the compiled pattern expression

text()

String text

(

)

const

The regular expression text this pattern was created from.

begin()

SourceIterator< Glob > begin

(

)

Iteration start.

end()

SourceIterator< Glob > end

(

)

Iteration end.