---

/Mappings/STL/reclstl_traits.h

Go to the documentation of this file.

/* 
 * File:        reclstl_traits.h
 *
 * Purpose:     Contains character-base traits for the recls::stl mapping.
 *
 * Created:     25th March 2004
 * Updated:     2nd June 2004
 *
 * Author:      Matthew Wilson, Synesis Software Pty Ltd.
 *
 * License:     (Licensed under the Synesis Software Standard Source License)
 *
 *              Copyright (C) 2002-2004, 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_RECLSTL_TRAITS
#define RECLS_INCL_H_RECLSTL_TRAITS

#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
# define RECLS_VER_H_RECLSTL_TRAITS_MAJOR       1
# define RECLS_VER_H_RECLSTL_TRAITS_MINOR       2
# define RECLS_VER_H_RECLSTL_TRAITS_REVISION    1
# define RECLS_VER_H_RECLSTL_TRAITS_EDIT        7
#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 */

/* 
 * Classes
 */

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

public:
#if defined(RECLS_API_FTP)

    static hrecls_t         SearchFtp(char_type const *host, char_type const *username, char_type const *password, char_type const *searchRoot, char_type const *pattern, recls_uint32_t flags);
#endif /* RECLS_API_FTP */

    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

# ifdef RECLS_CHAR_TYPE_IS_CHAR

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:
#if defined(RECLS_API_FTP)
    static hrecls_t SearchFtp(char_type const *host, char_type const *username, char_type const *password, char_type const *searchRoot, char_type const *pattern, recls_uint32_t flags)
    {
        hrecls_t    hSrch;
        recls_rc_t  rc = Recls_SearchFtp(host, username, password, searchRoot, pattern, flags, &hSrch);

        return RECLS_SUCCEEDED(rc) ? hSrch : static_cast<hrecls_t>(NULL);
    }
#endif /* RECLS_API_FTP */

    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);
    }
};

# elif defined(RECLS_CHAR_TYPE_IS_WCHAR)

template <>
struct reclstl_traits<recls_char_w_t>
{
public:
    typedef reclstl_traits<recls_char_w_t>      traits_type;
    typedef recls_char_w_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:
#if defined(RECLS_API_FTP)
    static hrecls_t SearchFtp(char_type const *host, char_type const *username, char_type const *password, char_type const *searchRoot, char_type const *pattern, recls_uint32_t flags)
    {
        hrecls_t    hSrch;
        recls_rc_t  rc = Recls_SearchFtp(host, username, password, searchRoot, pattern, flags, &hSrch);

        return RECLS_SUCCEEDED(rc) ? hSrch : static_cast<hrecls_t>(NULL);
    }
#endif /* RECLS_API_FTP */

    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 wcscpy(dest, src);
    }
};

# else /* character type */

#  error Neither RECLS_CHAR_TYPE_IS_WCHAR nor RECLS_CHAR_TYPE_IS_CHAR are defined

# endif /* character type */


#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 

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

/* 

#endif /* RECLS_INCL_H_RECLSTL_TRAITS */

/* 

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