---

/include/recls/cpp/search.hpp

Go to the documentation of this file.

/* 
 * File:        recls/cpp/search.hpp
 *
 * Purpose:     recls C++ mapping - Search class.
 *
 * Created:     18th August 2003
 * Updated:     15th March 2005
 *
 * Home:        http://recls.org/
 *
 * Copyright 2003-2005, Matthew Wilson and Synesis Software
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer. 
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
 *   any contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 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_RECLS_CPP_HPP_SEARCH
#define RECLS_INCL_RECLS_CPP_HPP_SEARCH

/* File version */
#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
# define RECLS_VER_RECLS_CPP_HPP_SEARCH_MAJOR       2
# define RECLS_VER_RECLS_CPP_HPP_SEARCH_MINOR       2
# define RECLS_VER_RECLS_CPP_HPP_SEARCH_REVISION    1
# define RECLS_VER_RECLS_CPP_HPP_SEARCH_EDIT        7
#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 
 * Includes
 */

#include <recls/cpp/recls.hpp>      // reclspp root header
#include <recls/cpp/fileentry.hpp>  // reclspp::FileEntry
#include <recls_assert.h>           // recls_assert
#include <utility>                  // pair

/* 
 * Namespace
 */

#if !defined(RECLS_NO_NAMESPACE)
namespace recls
{

namespace cpp
{
#endif /* !RECLS_NO_NAMESPACE */

/* 
 * Classes
 */

class Search
{
public:
    typedef Search      class_type;

protected:
    typedef std::pair<hrecls_t, recls_rc_t> ctor_args_type;

    Search(ctor_args_type args);
public:
    virtual ~Search() = 0;

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
protected:
    // This method is needed because there is no way to call a function in the 
    // MIL of a derived class and pass more than one argument to a base ctor
    recls_rc_t          &GetLastError_();

    static FileEntry    make_entry_(recls_info_t info);

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

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

/* 
 * Implementation
 */

inline /* static */ FileEntry   Search::make_entry_(recls_info_t info)
{
    return FileEntry(info);
}


inline Search::Search(Search::ctor_args_type args)
    : m_hSrch(args.first)
    , m_lastError(args.second)
{
    recls_assert(NULL != m_hSrch || RECLS_FAILED(m_lastError));
    recls_assert(NULL == m_hSrch || RECLS_SUCCEEDED(m_lastError));
}

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

inline recls_rc_t Search::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 Search::HasMoreElements() const
{
    return RECLS_SUCCEEDED(m_lastError);
}

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

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

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

inline recls_uint32_t Search::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;
}

inline recls_rc_t &Search::GetLastError_()
{
    return m_lastError;
}

/* 
 * Namespace
 */

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

/* 

#endif /* !RECLS_INCL_RECLS_CPP_HPP_SEARCH */

/* 

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