//%2006////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; Symantec Corporation; The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_Dir_h
#define Pegasus_Dir_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/String.h>
#include <Pegasus/Common/InternalException.h>
#include <Pegasus/Common/Linkage.h>
#include <Pegasus/Common/AutoPtr.h>

#if defined(PEGASUS_PLATFORM_SOLARIS_SPARC_GNU)
# include <sys/param.h>
# include <dirent.h>
#endif
#ifdef PEGASUS_OS_ZOS
# include <dirent.h>
#endif

PEGASUS_NAMESPACE_BEGIN

#if defined(PEGASUS_OS_TYPE_WINDOWS)
# include <io.h>
 typedef struct
 {
# if _MSC_VER < 1300
    long file;
# else
    intptr_t file;
# endif
    struct _finddata_t findData;
 } DirRep;
#elif defined(PEGASUS_OS_TYPE_UNIX) || defined (PEGASUS_OS_VMS)
# if defined(PEGASUS_OS_SOLARIS)
#  include <sys/param.h>
# endif /* if defined(PEGASUS_OS_SOLARIS) */

# include <dirent.h>

# define PEGASUS_HAS_READDIR_R

 struct DirRep
 {
    DIR* dir;
# ifdef PEGASUS_OS_OS400
    struct dirent_lg* entry;
# else /* ifdef PEGASUS_OS_OS400 */
    struct dirent* entry;
# endif /* ifdef PEGASUS_OS_OS400 */
# ifdef PEGASUS_HAS_READDIR_R
#  ifdef PEGASUS_OS_OS400
     struct dirent_lg buffer;
#  else /* ifdef PEGASUS_OS_OS400 */
#   ifdef PEGASUS_OS_SOLARIS
private:
        char buf[sizeof(dirent) + MAXNAMELEN];
public:
        struct dirent &buffer;
        inline DirRep()
                : buffer(*reinterpret_cast<struct dirent *>(buf))
        { }
#   else /* ifdef PEGASUS_OS_SOLARIS */
    struct dirent buffer;
#   endif /* ifdef PEGASUS_OS_SOLARIS */
#  endif /* ifdef PEGASUS_OS_OS400 */
# endif /* ifdef PEGASUS_HAS_READDIR_R */
};
#endif /* elif defined(PEGASUS_OS_TYPE_UNIX) || defined (PEGASUS_OS_VMS) */

/** The Dir class provides a platform independent way of iterating the
    files in a directory.
*/
class PEGASUS_COMMON_LINKAGE Dir
{
public:

    /** Starts this iterator class on the given path.
        @param String path is the path to the target directory
        @return
        @exception throws CannotOpenDirectory if invalid directory.

        <pre>
        char* path = "."
        try
        {
           for (Dir dir(path); dir.more(); dir.next())
           {
               cout << "name: " << dir.getName() << endl;
           }
        }
        catch (CannotOpenDirectory&)
        {
           // Error!
        }
        </pre>
    */
    Dir(const String& path);

    /** Release any iterator resources. */
    ~Dir();

    /** Return true if there are more file names to iterator. */
    Boolean more() const { return _more; }


    /** Returns the current file name. */
    const char* getName() const;

    /** Advance to next file in directory. */
    void next();

private:

    Boolean _more;
    Boolean _isValid;
    String _path;
    DirRep _dirRep;
};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_Dir_h */