---

/mappings/C++/reclspp_filesearch.h

Go to the documentation of this file.

/* 
 * File:        reclspp_filesearch.h
 *
 * Purpose:     recls C++ mapping - FileSearch class.
 *
 * Created:     18th August 2003
 * Updated:     23rd September 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_RECLSPP_FILESEARCH
#define RECLS_INCL_H_RECLSPP_FILESEARCH

/* File version */
#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
# define RECLS_VER_H_RECLSPP_FILESEARCH_MAJOR       1
# define RECLS_VER_H_RECLSPP_FILESEARCH_MINOR       0
# define RECLS_VER_H_RECLSPP_FILESEARCH_REVISION    7
# define RECLS_VER_H_RECLSPP_FILESEARCH_EDIT        7
#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 
 * Includes
 */

#include "reclspp.h"
#include "reclspp_fileentry.h"

/* 
 * Namespace
 */

#if !defined(RECLS_NO_NAMESPACE)
namespace recls
{

namespace cpp
{
#endif /* !RECLS_NO_NAMESPACE */

/* 
 * Classes
 */

class FileSearch
{
public:

public:
    FileSearch(char const *rootDir, char const *pattern, recls_uint32_t flags);
    ~FileSearch();


public:
    recls_rc_t      GetNext();


public:
    recls_bool_t    HasMoreElements() const;
    FileEntry       GetCurrentEntry() const;

    recls_rc_t      GetLastError() const;

    recls_uint32_t  GetNumOutstandingDetails() const;


// Implementation
private:

// Members
private:
    hrecls_t /* const */    m_hSrch;
    mutable recls_rc_t      m_lastError;

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

/* 
 * Implementation
 */

inline FileSearch::FileSearch(char const *rootDir, char const *pattern, recls_uint32_t flags)
    : /* m_hSrch(NULL) // This must not be initialised in the constructor
    , */ m_lastError((m_hSrch = NULL, Recls_Search(rootDir, pattern, flags, &const_cast<hrecls_t&>(m_hSrch))))
{}

inline FileSearch::~FileSearch()
{
    if(NULL != m_hSrch)
    {
        Recls_SearchClose(m_hSrch);
    }
}

inline recls_rc_t FileSearch::GetNext()
{
    recls_assert(NULL != m_hSrch);

    recls_rc_t  rc  =   Recls_GetNext(m_hSrch);

    if(RECLS_FAILED(rc))
    {
        Recls_SearchClose(m_hSrch);
        m_hSrch = NULL;
    }

    m_lastError = rc;

    return rc;
}

inline recls_bool_t FileSearch::HasMoreElements() const
{
    return RECLS_SUCCEEDED(m_lastError);
}

inline FileEntry FileSearch::GetCurrentEntry() const
{
    recls_info_t    info;
    recls_rc_t      rc  =   Recls_GetDetails(m_hSrch, &info);

    return RECLS_SUCCEEDED(m_lastError = rc) ? FileEntry(info) : FileEntry();
}

inline recls_rc_t FileSearch::GetLastError() const
{
    return m_lastError;
}

inline recls_uint32_t FileSearch::GetNumOutstandingDetails() const
{
    recls_uint32_t  cDetails;
    recls_rc_t      rc  =   Recls_OutstandingDetails(m_hSrch, &cDetails);

    if(RECLS_FAILED(m_lastError = rc))
    {
        cDetails = 0;
    }

    return cDetails;
}

/* 
 * Namespace
 */

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

/* 

#endif /* !RECLS_INCL_H_RECLSPP_FILESEARCH */

/* 

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