STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - Template Software for the Active Template Library COMSTL - The Standard Template Library meets the Component Object Model .netSTL - Standard Template Library meets the Microsoft.NET Common Language Runtime InetSTL - The Standard Template Library meets WinInet MFCSTL - Template Software for the Microsoft Foundation Classes UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

searchspec_sequence Class Template Reference
[File-System Library (STLSoft)]

Provides multi-pattern functionality over a file-system search sequence class. More...

#include <stlsoft_searchspec_sequence.h>

List of all members.

Public Types

typedef S find_sequence_type
 The underlying find sequence type.

typedef searchspec_sequence<
S > 
class_type
 The current parameterisation of the type.

typedef find_sequence_type::char_type char_type
 The character type.

typedef find_sequence_type::value_type value_type
 The value type.

typedef find_sequence_type::size_type size_type
 The size type.

typedef find_sequence_type::const_reference const_reference
 The non-mutable (const) reference type.


Public Methods

 searchspec_sequence (char_type const *searchSpec, char_type delimiter)
 Creates a search sequence for the given search specification and delimiter.

 searchspec_sequence (char_type const *searchSpec, char_type delimiter, ss_int_t flags)
 Creates a search sequence for the given search specification, delimiter and flags.

 searchspec_sequence (char_type const *rootDir, char_type const *searchSpec, char_type delimiter)
 Creates a search sequence for the given root directory, search specification and delimiter.

 searchspec_sequence (char_type const *rootDir, char_type const *searchSpec, char_type delimiter, ss_int_t flags)
 Creates a search sequence for the given root directory, search specification, delimiter and flags.

const_iterator begin () const
 Begins the iteration.

const_iterator end () const
 Ends the iteration.

ss_bool_t empty () const
 Indicates whether the sequence is empty.


Detailed Description

template<typename S>
class stlsoft::searchspec_sequence< S >

Provides multi-pattern functionality over a file-system search sequence class.


Member Typedef Documentation

typedef find_sequence_type::char_type char_type
 

The character type.

typedef searchspec_sequence<S> class_type
 

The current parameterisation of the type.

typedef find_sequence_type::const_reference const_reference
 

The non-mutable (const) reference type.

typedef S find_sequence_type
 

The underlying find sequence type.

typedef find_sequence_type::size_type size_type
 

The size type.

typedef find_sequence_type::value_type value_type
 

The value type.


Constructor & Destructor Documentation

searchspec_sequence char_type const *    searchSpec,
char_type    delimiter
[inline]
 

Creates a search sequence for the given search specification and delimiter.

Parameters:
searchSpec  The multi-filter search specification, e.g. "*.cpp", "*.d:makefile:*.java"
delimiter  The delimiter to use, e.g. ':'
Note:
Assumes the current directory

searchspec_sequence char_type const *    searchSpec,
char_type    delimiter,
ss_int_t    flags
[inline]
 

Creates a search sequence for the given search specification, delimiter and flags.

Parameters:
searchSpec  The multi-filter search specification, e.g. "*.cpp", "*.d:makefile:*.java"
delimiter  The delimiter to use, e.g. ':'
flags  Flags specific to the underlying sequence
Note:
Assumes the current directory

searchspec_sequence char_type const *    rootDir,
char_type const *    searchSpec,
char_type    delimiter
[inline]
 

Creates a search sequence for the given root directory, search specification and delimiter.

Parameters:
rootDir  The root directory of the search
searchSpec  The multi-filter search specification, e.g. "*.cpp", "*.d:makefile:*.java"
delimiter  The delimiter to use, e.g. ':'

searchspec_sequence char_type const *    rootDir,
char_type const *    searchSpec,
char_type    delimiter,
ss_int_t    flags
[inline]
 

Creates a search sequence for the given root directory, search specification, delimiter and flags.

Parameters:
rootDir  The root directory of the search
searchSpec  The multi-filter search specification, e.g. "*.cpp", "*.d:makefile:*.java"
delimiter  The delimiter to use, e.g. ':'
flags  Flags specific to the underlying sequence


Member Function Documentation

const_iterator begin   const [inline]
 

Begins the iteration.

Returns:
An iterator representing the start of the sequence

ss_bool_t empty   const [inline]
 

Indicates whether the sequence is empty.

const_iterator end   const [inline]
 

Ends the iteration.

Returns:
An iterator representing the end of the sequence


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

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004