---

/mappings/STL/reclstl_search_sequence.h

Go to the documentation of this file.

/* 
 * File:        reclstl_search_sequence.h
 *
 * Purpose:     Contains the basic_search_sequence template class, and ANSI
 *              and Unicode specialisations thereof.
 *
 * Created:     10th September 2003
 * Updated:     4th December 2003
 *
 * Author:      Matthew Wilson, Synesis Software Pty Ltd.
 *
 * License:     (Licensed under the Synesis Software Standard Source License)
 *
 *              Copyright (C) 2002-2003, Synesis Software Pty Ltd.
 *
 *              All rights reserved.
 *
 *              www:        http://www.synesis.com.au/software
 *                          http://www.recls.org/
 *
 *              email:      submissions@recls.org  for submissions
 *                          admin@recls.org        for other enquiries
 *
 *              Redistribution and use in source and binary forms, with or
 *              without modification, are permitted provided that the following
 *              conditions are met:
 *
 *              (i) Redistributions of source code must retain the above
 *              copyright notice and contact information, this list of
 *              conditions and the following disclaimer.
 *
 *              (ii) Any derived versions of this software (howsoever modified)
 *              remain the sole property of Synesis Software.
 *
 *              (iii) Any derived versions of this software (howsoever modified)
 *              remain subject to all these conditions.
 *
 *              (iv) Neither the name of Synesis Software nor the names of any
 *              subdivisions, employees or agents of Synesis Software, nor the
 *              names of any other contributors to this software may be used to
 *              endorse or promote products derived from this software without
 *              specific prior written permission.
 *
 *              This source code is provided by Synesis Software "as is" and any
 *              warranties, whether expressed or implied, including, but not
 *              limited to, the implied warranties of merchantability and
 *              fitness for a particular purpose are disclaimed. In no event
 *              shall the Synesis Software be liable for any direct, indirect,
 *              incidental, special, exemplary, or consequential damages
 *              (including, but not limited to, procurement of substitute goods
 *              or services; loss of use, data, or profits; or business
 *              interruption) however caused and on any theory of liability,
 *              whether in contract, strict liability, or tort (including
 *              negligence or otherwise) arising in any way out of the use of
 *              this software, even if advised of the possibility of such
 *              damage.
 *
 * 


#ifndef RECLS_INCL_H_WINSTL_SEARCH_SEQUENCE
#define RECLS_INCL_H_WINSTL_SEARCH_SEQUENCE

#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
# define RECLS_VER_H_WINSTL_SEARCH_SEQUENCE_MAJOR       1
# define RECLS_VER_H_WINSTL_SEARCH_SEQUENCE_MINOR       4
# define RECLS_VER_H_WINSTL_SEARCH_SEQUENCE_REVISION    4
# define RECLS_VER_H_WINSTL_SEARCH_SEQUENCE_EDIT        18
#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 
 * Includes
 */

#ifndef RECLS_INCL_H_RECLSTL
# include "reclstl.h"
#endif /* !RECLS_INCL_H_RECLSTL */
#ifndef RECLS_INCL_H_RECLS_ASSERT
# include <recls_assert.h>
#endif /* !RECLS_INCL_H_RECLS_ASSERT */
#ifndef _STLSOFT_INCL_H_STLSOFT_ITERATOR
# include <stlsoft_iterator.h>
#endif /* !_STLSOFT_INCL_H_STLSOFT_ITERATOR */

#ifndef _STLSOFT_INCL_H_STLSOFT_PROXY_SEQUENCE
# include <stlsoft_proxy_sequence.h>
#endif /* !_STLSOFT_INCL_H_STLSOFT_PROXY_SEQUENCE */

/* 
 * Namespace
 */

#if !defined(RECLS_NO_NAMESPACE)
namespace recls
{

namespace stl
{
#endif /* !RECLS_NO_NAMESPACE */

/* 
 * Forward declarations
 */

#ifndef RECLS_DOCUMENTATION_SKIP_SECTION

template<   typename C
        ,   typename T
        >
class basic_search_sequence_value_type;

template<   typename C
        ,   typename T
        ,   typename V
        >
class basic_search_sequence_const_iterator;

#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 
 * Utility classes
 */

#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
struct rss_shared_handle
{
    hrecls_t        hSrch;
    recls_sint32_t  cRefs;

public:
    explicit rss_shared_handle(hrecls_t h)
        : hSrch(h)
        , cRefs(1)
    {}
    void Release()
    {
        if(--cRefs == 0)
        {
            delete this;
        }
    }
#if defined(__STLSOFT_COMPILER_IS_GCC)
protected:
#else /* ? __STLSOFT_COMPILER_IS_GCC */
private:
#endif /* __STLSOFT_COMPILER_IS_GCC */
    ~rss_shared_handle()
    {
        recls_message_assert("Shared search handle being destroyed with outstanding references!", 0 == cRefs);

        if(NULL != hSrch)
        {
            Recls_SearchClose(hSrch);
        }
    }
};
#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 
 * Classes
 */

template <typename C>
struct reclstl_traits
{
public:
    typedef void            char_type;
    typedef void            *entry_type;

public:
    static hrecls_t         Search(char_type const *searchRoot, char_type const *pattern, recls_uint32_t flags);

    static recls_rc_t       GetDetails(hrecls_t hSrch, entry_type *pinfo);
    static recls_rc_t       GetNextDetails(hrecls_t hSrch, entry_type *pinfo);

    static void             CloseDetails(entry_type fileInfo);
    static entry_type       CopyDetails(entry_type fileInfo);

    static char_type        *str_copy(char_type *, char_type const *);
};

#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
template <>
struct reclstl_traits<recls_char_a_t>
{
public:
    typedef reclstl_traits<recls_char_a_t>      traits_type;
    typedef recls_char_a_t                      char_type;
    typedef recls_info_t                        entry_type;
    typedef recls_strptrs_t                     strptrs_type;
    typedef recls_strptrsptrs_t                 strptrsptrs_type;

    typedef stlsoft::proxy_sequence<    const strptrs_type
                                    ,   string_t
                                    ,   traits_type // Note, this type also serves as the traits type for the STLSoft proxy_sequence
                                    >           directory_parts_type;

    static string_t make_value(strptrs_type const &ptrs)
    {
        return string_t(ptrs.begin, ptrs.end);
    }

public:
    static hrecls_t Search(char_type const *searchRoot, char_type const *pattern, recls_uint32_t flags)
    {
        hrecls_t    hSrch;
        recls_rc_t  rc = Recls_Search(searchRoot, pattern, flags, &hSrch);

        return RECLS_SUCCEEDED(rc) ? hSrch : static_cast<hrecls_t>(NULL);
    }

    static recls_rc_t GetDetails(hrecls_t hSrch, entry_type *pinfo)
    {
        return Recls_GetDetails(hSrch, pinfo);
    }

    static recls_rc_t GetNextDetails(hrecls_t hSrch, entry_type *pinfo)
    {
        return Recls_GetNextDetails(hSrch, pinfo);
    }

    static void CloseDetails(entry_type fileInfo)
    {
        Recls_CloseDetails(fileInfo);
    }
    static entry_type CopyDetails(entry_type fileInfo)
    {
        entry_type  infoCopy;

        return RECLS_SUCCEEDED(Recls_CopyDetails(fileInfo, &infoCopy)) ? infoCopy : static_cast<entry_type>(NULL);
    }

    static char_type *str_copy(char_type *dest, char_type const *src)
    {
        return strcpy(dest, src);
    }
};
#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

// class basic_search_sequence
template<   typename C
#ifdef __STLSOFT_CF_TEMPLATE_CLASS_DEFAULT_CLASS_ARGUMENT_SUPPORT
        ,   typename T = reclstl_traits<C>
#else
        ,   typename T /* = reclstl_traits<C> */
#endif /* __STLSOFT_CF_TEMPLATE_CLASS_DEFAULT_CLASS_ARGUMENT_SUPPORT */
        >
class basic_search_sequence
{
public:
    typedef C                                                       char_type;
    typedef T                                                       traits_type;
    typedef basic_search_sequence<C, T>                             class_type;
    typedef basic_search_sequence_value_type<C, T>                  value_type;
    typedef basic_search_sequence_const_iterator<C, T, value_type>  const_iterator;
    typedef value_type                                              &reference;
    typedef value_type const                                        &const_reference;
    typedef ss_typename_type_k traits_type::entry_type              entry_type;
    typedef size_t                                                  size_type;

public:
    basic_search_sequence(char_type const *pattern, recls_uint32_t flags);
    basic_search_sequence(char_type const *directory, char_type const *pattern, recls_uint32_t flags);

public:
    const_iterator  begin() const;
    const_iterator  end() const;

public:
    size_type           size() const;
    recls_bool_t        empty() const;
    static size_type    max_size();

private:

private:
    friend class basic_search_sequence_value_type<C, T>;
    friend class basic_search_sequence_const_iterator<C, T, value_type>;

        static char_type const  *copy_or_null_(char_type *dest, char_type const *src);

        char_type const *const  m_directory;
        char_type const *const  m_pattern;

    char_type                           m_directory_[RECLS_PATH_MAX + 1];
    char_type                           m_pattern_[RECLS_PATH_MAX + 1];
    recls_uint32_t                      m_flags;

// Not to be implemented
private:
    basic_search_sequence(class_type const &);
    basic_search_sequence const &operator =(class_type const &);
};

/* 
 * Typedefs for commonly encountered types
 */

typedef basic_search_sequence<recls_char_a_t, reclstl_traits<recls_char_a_t> >      search_sequence_a;
typedef basic_search_sequence<recls_char_w_t, reclstl_traits<recls_char_w_t> >      search_sequence_w;

/* 

// class basic_search_sequence_value_type
template<   typename C
        ,   typename T
        >
class basic_search_sequence_value_type
{
public:
    typedef C                                                       char_type;
    typedef T                                                       traits_type;
    typedef basic_search_sequence_value_type<C, T>                  class_type;
    typedef ss_typename_type_k traits_type::entry_type              entry_type;
    typedef ss_typename_type_k traits_type::directory_parts_type    directory_parts_type;

public:
    basic_search_sequence_value_type();
    basic_search_sequence_value_type(class_type const &rhs);
private:
    basic_search_sequence_value_type(entry_type info)
        : m_info(info)
    {}
public:
    ~basic_search_sequence_value_type();

    class_type &operator =(class_type const &rhs);

public:
    string_t                get_path() const;
#ifdef RECLS_PLATFORM_API_WIN32
    char_type               get_drive() const;
#endif /* RECLS_PLATFORM_API_WIN32 */
    string_t                get_directory() const;
    string_t                get_directory_path() const;
    directory_parts_type    get_directory_parts() const;
    string_t                get_file() const;
    string_t                get_short_file() const;
    string_t                get_filename() const;
    string_t                get_fileext() const;

    recls_time_t            get_creation_time() const;
    recls_time_t            get_modification_time() const;
    recls_time_t            get_last_access_time() const;
    recls_time_t            get_last_status_change_time() const;

    recls_filesize_t        get_size() const;

    recls_bool_t            is_readonly() const;
    recls_bool_t            is_directory() const;
    recls_bool_t            is_link() const;

    char_type const         *c_str() const;

    entry_type const        &get_entry() const;

// Members
private:
    friend class basic_search_sequence_const_iterator<C, T, class_type>;

    entry_type  m_info;
};

// class basic_search_sequence_const_iterator
template<   typename C
        ,   typename T
        ,   typename V
        >
class basic_search_sequence_const_iterator
    : public stlsoft_ns_qual(iterator_base)<stlsoft_ns_qual_std(input_iterator_tag), V, ptrdiff_t, void, V>
{
public:
    typedef C                                               char_type;
    typedef T                                               traits_type;
    typedef V                                               value_type;
    typedef basic_search_sequence_const_iterator<C, T, V>   class_type;
    typedef ss_typename_type_k traits_type::entry_type      entry_type;
private:
    typedef basic_search_sequence<C, T>                     sequence_type;

private:
    explicit basic_search_sequence_const_iterator(hrecls_t hSrch)
        : m_handle(new rss_shared_handle(hSrch))
    {}
public:
    basic_search_sequence_const_iterator();
    basic_search_sequence_const_iterator(class_type const &rhs);
    ~basic_search_sequence_const_iterator();

public:
    class_type &operator ++();
    void operator ++(int);
    const value_type operator *() const;
    recls_bool_t operator ==(class_type const &rhs) const;
    recls_bool_t operator !=(class_type const &rhs) const;

// Members
private:
    friend class basic_search_sequence<C, T>;

    rss_shared_handle   *m_handle;

// Not to be implemented
private:
    basic_search_sequence_const_iterator &operator =(class_type const &rhs);
};

// Shims

template <typename C, typename T>
inline recls_bool_t is_empty(basic_search_sequence<C, T> const &s)
{
    return s.empty();
}

template <typename C, typename T>
#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
inline ss_typename_type_k basic_search_sequence_value_type<C, T>::char_type const *c_str_ptr(basic_search_sequence_value_type<C, T> const &v)
#else
inline C const *c_str_ptr(basic_search_sequence_value_type<C, T> const &v)
#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */
{
    return v.c_str();
}

// Implementation

#ifndef RECLS_DOCUMENTATION_SKIP_SECTION

// basic_search_sequence

template <typename C, typename T>
inline /* static */ typename basic_search_sequence<C, T>::char_type const *basic_search_sequence<C, T>::copy_or_null_(typename basic_search_sequence<C, T>::char_type *dest, typename basic_search_sequence<C, T>::char_type const *src)
{
        return (NULL == src) ? NULL : traits_type::str_copy(dest, src);
}


// Construction
template <typename C, typename T>
inline basic_search_sequence<C, T>::basic_search_sequence(char_type const *pattern, recls_uint32_t flags)
    : m_flags(flags)
        , m_directory(copy_or_null_(m_directory_, ""))
        , m_pattern(copy_or_null_(m_pattern_, pattern))
{}

template <typename C, typename T>
inline basic_search_sequence<C, T>::basic_search_sequence(char_type const *directory, char_type const *pattern, recls_uint32_t flags)
    : m_flags(flags)
        , m_directory(copy_or_null_(m_directory_, directory))
        , m_pattern(copy_or_null_(m_pattern_, pattern))
{}

// Iteration
template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence<C, T>::const_iterator basic_search_sequence<C, T>::begin() const
{
    return const_iterator(traits_type::Search(m_directory, m_pattern, m_flags));
}

template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence<C, T>::const_iterator basic_search_sequence<C, T>::end() const
{
    return const_iterator();
}

// State
template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence<C, T>::size_type basic_search_sequence<C, T>::size() const
{
    const_iterator  b   =   begin();
    const_iterator  e   =   end();
    size_type       c   =   0;

    for(; b != e; ++b)
    {
        ++c;
    }

    return c;
}

template <typename C, typename T>
inline recls_bool_t basic_search_sequence<C, T>::empty() const
{
    return begin() == end();
}

template <typename C, typename T>
inline /* static */ ss_typename_type_k basic_search_sequence<C, T>::size_type basic_search_sequence<C, T>::max_size()
{
    return static_cast<size_type>(-1);
}

// basic_search_sequence_value_type

template <typename C, typename T>
inline basic_search_sequence_value_type<C, T>::basic_search_sequence_value_type()
    : m_info(NULL)
{}

template <typename C, typename T>
inline basic_search_sequence_value_type<C, T>::basic_search_sequence_value_type(ss_typename_type_k basic_search_sequence_value_type<C, T>::class_type const &rhs)
    : m_info(traits_type::CopyDetails(rhs.m_info))
{}

template <typename C, typename T>
inline basic_search_sequence_value_type<C, T>::~basic_search_sequence_value_type()
{
    if(NULL != m_info)
    {
        traits_type::CloseDetails(m_info);
    }
}

template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence_value_type<C, T>::class_type &basic_search_sequence_value_type<C, T>::operator =(ss_typename_type_k basic_search_sequence_value_type<C, T>::class_type const &rhs)
{
    if(NULL != m_info)
    {
        traits_type::CloseDetails(m_info);
    }

    m_info = traits_type::CopyDetails(rhs.m_info);

    return *this;
}

template <typename C, typename T>
inline string_t basic_search_sequence_value_type<C, T>::get_path() const
{
    recls_assert(NULL != m_info);

    return string_t(m_info->path.begin, m_info->path.end);
}

#ifdef RECLS_PLATFORM_API_WIN32
template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence_value_type<C, T>::char_type basic_search_sequence_value_type<C, T>::get_drive() const
{
    char_type   chDrive;

    return (Recls_GetDriveProperty(m_info, &chDrive), chDrive);
}
#endif /* RECLS_PLATFORM_API_WIN32 */

template <typename C, typename T>
inline string_t basic_search_sequence_value_type<C, T>::get_directory() const
{
    recls_assert(NULL != m_info);

    return string_t(m_info->directory.begin, m_info->directory.end);
}

template <typename C, typename T>
inline string_t basic_search_sequence_value_type<C, T>::get_directory_path() const
{
    recls_assert(NULL != m_info);

    return string_t(m_info->path.begin, m_info->directory.end);
}

template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence_value_type<C, T>::directory_parts_type basic_search_sequence_value_type<C, T>::get_directory_parts() const
{
    recls_assert(NULL != m_info);

    return directory_parts_type(m_info->directoryParts.begin, m_info->directoryParts.end);
}

template <typename C, typename T>
inline string_t basic_search_sequence_value_type<C, T>::get_file() const
{
    recls_assert(NULL != m_info);

    return string_t(m_info->fileName.begin, m_info->fileExt.end);
}

#if 0
template <typename C, typename T>
inline string_t basic_search_sequence_value_type<C, T>::get_short_file() const
{
    return m_info.cAlternateFileName[0] != '\0' ? m_info.cAlternateFileName : m_info.cFileName;
}
#endif /* 0 */

template <typename C, typename T>
inline string_t basic_search_sequence_value_type<C, T>::get_filename() const
{
    recls_assert(NULL != m_info);

    return string_t(m_info->fileName.begin, m_info->fileName.end);
}

template <typename C, typename T>
inline string_t basic_search_sequence_value_type<C, T>::get_fileext() const
{
    recls_assert(NULL != m_info);

    return string_t(m_info->fileExt.begin, m_info->fileExt.end);
}

template <typename C, typename T>
inline recls_time_t basic_search_sequence_value_type<C, T>::get_creation_time() const
{
    recls_assert(NULL != m_info);

    return Recls_GetCreationTime(m_info);
}

template <typename C, typename T>
inline recls_time_t basic_search_sequence_value_type<C, T>::get_modification_time() const
{
    recls_assert(NULL != m_info);

    return Recls_GetModificationTime(m_info);
}

template <typename C, typename T>
inline recls_time_t basic_search_sequence_value_type<C, T>::get_last_access_time() const
{
    recls_assert(NULL != m_info);

    return Recls_GetLastAccessTime(m_info);
}

template <typename C, typename T>
inline recls_time_t basic_search_sequence_value_type<C, T>::get_last_status_change_time() const
{
    recls_assert(NULL != m_info);

    return Recls_GetLastStatusChangeTime(m_info);
}

template <typename C, typename T>
inline recls_filesize_t basic_search_sequence_value_type<C, T>::get_size() const
{
    recls_assert(NULL != m_info);

    return m_info->size;
}

template <typename C, typename T>
inline recls_bool_t basic_search_sequence_value_type<C, T>::is_readonly() const
{
    recls_assert(NULL != m_info);

    return Recls_IsFileReadOnly(m_info);
}

template <typename C, typename T>
inline recls_bool_t basic_search_sequence_value_type<C, T>::is_directory() const
{
    recls_assert(NULL != m_info);

    return Recls_IsFileDirectory(m_info);
}

template <typename C, typename T>
inline recls_bool_t basic_search_sequence_value_type<C, T>::is_link() const
{
    recls_assert(NULL != m_info);

    return Recls_IsFileLink(m_info);
}

template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence_value_type<C, T>::char_type const * basic_search_sequence_value_type<C, T>::c_str() const
{
    recls_assert(NULL != m_info);

    return m_info->path.begin;
}

template <typename C, typename T>
inline ss_typename_type_k basic_search_sequence_value_type<C, T>::entry_type const &basic_search_sequence_value_type<C, T>::get_entry() const
{
    return m_info;
}

// basic_search_sequence_const_iterator

template <typename C, typename T, typename V>
inline basic_search_sequence_const_iterator<C, T, V>::basic_search_sequence_const_iterator()
    : m_handle(NULL)
{}

template <typename C, typename T, typename V>
inline basic_search_sequence_const_iterator<C, T, V>::basic_search_sequence_const_iterator(class_type const &rhs)
    : m_handle(rhs.m_handle)
{
    if(NULL != m_handle)
    {
        ++m_handle->cRefs;
    }
}

template <typename C, typename T, typename V>
inline ss_typename_type_k basic_search_sequence_const_iterator<C, T, V>::class_type &basic_search_sequence_const_iterator<C, T, V>::operator =(typename basic_search_sequence_const_iterator<C, T, V>::class_type const &rhs)
{
    if(NULL != m_handle)
    {
        m_handle->Release();
    }

    m_handle =   rhs.m_handle;

    if(NULL != m_handle)
    {
        ++m_handle->cRefs;
    }

    return *this;
}

template <typename C, typename T, typename V>
inline basic_search_sequence_const_iterator<C, T, V>::~basic_search_sequence_const_iterator()
{
    if(NULL != m_handle)
    {
        m_handle->Release();
    }
}

template <typename C, typename T, typename V>
inline ss_typename_type_k basic_search_sequence_const_iterator<C, T, V>::class_type &basic_search_sequence_const_iterator<C, T, V>::operator ++()
{
    recls_message_assert("Attempting to increment invalid iterator", NULL != m_handle);

    if(RECLS_FAILED(Recls_GetNext(m_handle->hSrch)))
    {
        m_handle->Release();

        m_handle = NULL;
    }

    return *this;
}

template <typename C, typename T, typename V>
inline void basic_search_sequence_const_iterator<C, T, V>::operator ++(int)
{
    operator ++();
}

template <typename C, typename T, typename V>
inline const ss_typename_type_k basic_search_sequence_const_iterator<C, T, V>::value_type basic_search_sequence_const_iterator<C, T, V>::operator *() const
{
    entry_type  info;

    recls_message_assert("Attempting to dereference invalid iterator", NULL != m_handle);

    if( m_handle->hSrch != NULL &&
        RECLS_SUCCEEDED(traits_type::GetDetails(m_handle->hSrch, &info)))
    {
        return value_type(info);
    }
    else
    {
        recls_message_assert("Dereferencing end()-valued iterator", 0);

        return value_type();
    }
}

template <typename C, typename T, typename V>
inline recls_bool_t basic_search_sequence_const_iterator<C, T, V>::operator ==(class_type const &rhs) const
{
    return (m_handle == NULL) && (rhs.m_handle == NULL);
}

template <typename C, typename T, typename V>
inline recls_bool_t basic_search_sequence_const_iterator<C, T, V>::operator !=(class_type const &rhs) const
{
    return ! operator ==(rhs);
}

#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 

#if !defined(RECLS_NO_NAMESPACE)
} /* namespace stl */
} /* namespace recls */
#endif /* !RECLS_NO_NAMESPACE */

/* 

#endif /* RECLS_INCL_H_WINSTL_SEARCH_SEQUENCE */

/* 

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