C/C++ User's Journal 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
Synesis Software 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

recls.stl
[recls]


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.


Classes

class  basic_search_sequence
 Presents an STL-like sequence interface over the items on the file-system. More...
class  basic_search_sequence_value_type
 Value type for the basic_search_sequence. More...
class  basic_search_sequence_const_iterator
 Iterator type for the basic_search_sequence supporting the Input Iterator concept. 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 recls::stl::string_a_t
 string_t The string type to be used in the reclstl (recls::stl) namespace

Functions

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

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

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

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

template<typename C, typename T>
C const * recls::stl::c_str_data (basic_search_sequence_value_type< C, T > const &v)
 c_str_data shim

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

template<typename C, typename T>
size_t recls::stl::c_str_len (basic_search_sequence_value_type< C, T > const &v)
 c_str_len shim

This returns the length of the given value's full path.


Typedef Documentation

typedef std::string string_a_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* recls::stl::c_str_data ( basic_search_sequence_value_type< C, T > const &  v  )  [inline]

c_str_data shim

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

Parameters:
v The basic_search_sequence_value_type instance whose path is to be returned

size_t recls::stl::c_str_len ( basic_search_sequence_value_type< C, T > const &  v  )  [inline]

c_str_len shim

This returns the length of the given value's full path.

Parameters:
v The basic_search_sequence_value_type instance whose path length is to be returned

C const* recls::stl::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 "<a href = "http://www.cuj.com/documents/s=8681/cuj0308wilson/">Generalised String Manipulation: Access Shims and Type-tunnelling</a>", in the August 2003 issue of C/C++ User's Journal.

recls_bool_t recls::stl::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 "<a href = "http://www.cuj.com/documents/s=8681/cuj0308wilson/">Generalised String Manipulation: Access Shims and Type-tunnelling</a>", in the August 2003 issue of C/C++ User's Journal.


recls Library documentation © Synesis Software Pty Ltd, 2001-2006