diriterator.h

/*
 *  Copyright (c) 2003-2008    National Research Council
 *
 *  All rights reserved.
 *
 *  This material is confidential and proprietary information of
 *  National Research Council Canada ("Confidential Information").
 *  This Confidential Information may only be used and reproduced
 *  in accordance with the terms of the license agreement.
 *
 */

#ifndef __INCLUDED__SCOPIRA_TOOL_DIRITERATOR_HPP__
#define __INCLUDED__SCOPIRA_TOOL_DIRITERATOR_HPP__

#include <scopira/tool/platform.h>
#include <scopira/tool/export.h>

#ifdef PLATFORM_win32
#include <windows.h>
#else
#include <dirent.h>
#endif

#include <string>

// THIS FILE HAS BEEN FULLY DOCUMENTED

namespace scopira
{
  namespace tool
  {
    class dir_iterator;
  }
}

class scopira::tool::dir_iterator
{
  private:
    bool dm_failed;                  // currently failed?
#ifdef PLATFORM_win32
    HANDLE dm_dir;
    WIN32_FIND_DATA dm_dirdata;
    bool dm_haveprime;
#else
    DIR *dm_dir;                     // DIR handle
#endif

  public:
    SCOPIRA_EXPORT dir_iterator(void);
    SCOPIRA_EXPORT ~dir_iterator();

    bool failed(void) const { return dm_failed; }

    SCOPIRA_EXPORT bool open(const std::string& dirname);
    SCOPIRA_EXPORT void close(void);

    SCOPIRA_EXPORT bool next(std::string& out);
};

#endif