C/C++ User's Journal Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model InetSTL - where the Standard Template Library meets the Internet 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  

recls.stl
[recls]

The recls STL mapping. More...

Compounds

class  basic_root_sequence
 Presents an STL-like sequence interface over the items on the file-system. More...

class  basic_search_sequence
 Presents an STL-like sequence interface over the items on the file-system. More...

class  basic_search_sequence_const_iterator
 Iterator type for the basic_search_sequence supporting the Input Iterator concept. More...

class  basic_search_sequence_value_type
 Value type for the basic_search_sequence. More...

struct  reclstl_traits
 A traits class to provide character-encoding specific mappings from the recls C API to the recls.stl mapping". More...


Typedefs

typedef std::string string_t
 string_t The string type to be used in the reclstl (recls::stl) namespace


Functions

template<typename C, typename T, typename A> recls_bool_t is_empty (basic_root_sequence< C, T, A > const &s)
 is_empty shim

template<typename C, typename T> recls_bool_t is_empty (basic_search_sequence< C, T > const &s)
 is_empty shim

template<typename C, typename T> C const * c_str_ptr (basic_search_sequence_value_type< C, T > const &v)
 c_str_ptr shim


Detailed Description

The recls STL mapping.

This mapping contains the classes - basic_search_sequence, basic_search_sequence_const_iterator and basic_search_sequence_value_type - which provide an STL-like sequence, range and value with which a given recursive search can be conducted, and whose results can be manipulated in an STL-compliant fashion.


Typedef Documentation

typedef std::string string_t
 

string_t The string type to be used in the reclstl (recls::stl) namespace

Note:
By default string_t is defined to be std::string, but this can be overridden by specifying RECLS_STL_STRING_HEADER, e.g. "mystring.h", and also defining RECLS_STL_STRING_T, e.g. "my_string" which will be typedef'd to string_t


Function Documentation

C const* c_str_ptr basic_search_sequence_value_type< C, T > const &    v [inline]
 

c_str_ptr shim

This returns a non-null null-terminated C-string of the given value's full path.

Parameters:
v  The basic_search_sequence_value_type instance whose path is to be returned
Note:
This fits the STLSoft shims concept, described in this Synesis Software White Paper, and featured in the article "Generalised String Manipulation: Access Shims and Type-tunnelling", in the August 2003 issue of C/C++ User's Journal.

recls_bool_t is_empty basic_search_sequence< C, T > const &    s [inline]
 

is_empty shim

This returns a non-zero value if the given sequence is empty.

Parameters:
s  The sequence whose state is to be tested
Note:
This fits the STLSoft shims concept, described in this Synesis Software White Paper, and featured in the article "Generalised String Manipulation: Access Shims and Type-tunnelling", in the August 2003 issue of C/C++ User's Journal.

recls_bool_t is_empty basic_root_sequence< C, T, A > const &    s [inline]
 

is_empty shim

This returns a non-zero value if the given sequence is empty.

Parameters:
s  The sequence whose state is to be tested
Note:
This fits the STLSoft shims concept, described in this Synesis Software White Paper, and featured in the article "Generalised String Manipulation: Access Shims and Type-tunnelling", in the August 2003 issue of C/C++ User's Journal.

recls Library documentation Synesis Software Pty Ltd, 2001-2004