Dir.h

#ifndef DIR_H
#define DIR_H

/** @file */

#include "StdList.h"
#include "StdTime.h"

#if defined(__unix__)

#include <dirent.h>

#endif /* __unix__ */

/** File sorting possibilities for files returned by RDir::read() */

enum TDirSortOrder
{
	EDirSortNone,			/**< No sorting */
	EDirSortNameAscending,	/**< Sort alphabetically in ascending order */
	EDirSortNameDescending,	/**< Sort alphabetically in descending order */
	EDirSortSizeAscending,	/**< Sort from smallest to largest */
	EDirSortSizeDescending,	/**< Sort from largest to smallest */
	EDirSortDateAscending,	/**< Sort from oldest to newest */
	EDirSortDateDescending	/**< Sort from newest to oldest */
};

/* An instance of this class represents a directory or filename and its associated */
/* attributes, such as name etc.  It is filled in by the RDir class */

class TEntry
{
public:

	StdListNode<TEntry>	m_oStdListNode;		/**< Standard list node */
	char				iName[MAX_PATH];	/**< Name of the file */
	char				iLink[MAX_PATH];	/**< Resolved link to the file, if it is a link.  Note: This field is only
												 filled out by Utils::GetFileInfo(), not by methods in RDir */
	TBool				iIsDir;				/**< ETrue if entry is a directory */
	TBool				iIsLink;			/**< ETrue if entry is a link */
	TInt64				iSize;				/**< File size in bytes */
	TUint				iAttributes;		/**< Protection attributes, in Amiga/UNIX/Windows format */
	TTime				iModified;			/**< Time and date of the file */

#ifdef __amigaos__

	struct DateStamp	iPlatformDate;		/**< Date and time in Amiga specific format */

#elif defined(__unix__)

	time_t				iPlatformDate;		/**< Date and time in UNIX specific format */

#else /* ! __unix__ */

	FILETIME			iPlatformDate;		/**< Date and time in Windows specific format */

#endif /* ! __unix__ */

public:

	TEntry();

	TEntry(const TDateTime &a_roDateTime);

	void ClearArchive();

	TBool IsDir() const;

	TBool IsLink() const;

	TBool IsHidden() const;

	TBool IsReadable() const;

	TBool IsWriteable() const;

	TBool IsExecutable() const;

	TBool IsDeleteable() const;

	void Reset();

	void Set(TBool a_bIsDir, TBool a_bIsLink, TInt64 a_iSize, TUint a_uiAttributes, const TDateTime &a_oDateTime);
};

/* An instance of this class represents a number of TEntry classes and is filled */
/* in by the RDir class */

class TEntryArray
{
private:

	StdList<TEntry>		iEntries;	/**< List of entries */

public:

	/* Note that having a destructor in T classes is non standard, but this is required */
	/* to free the iEntries array, and this class is really private to RDir anyway */

	~TEntryArray();

	TEntry *Append(const char *a_pccName);

	static TInt CompareEntries(const TEntry *a_poFirst, const TEntry *a_poSecond, void *a_pvUserData);

	TInt Count() const;

	const TEntry &operator[](TInt a_iIndex) const;

	const TEntry *getHead() const;

	const TEntry *getSucc(const TEntry *a_poEntry) const;

	void Purge();

	void remove(const TEntry *a_poEntry);

	void Sort(enum TDirSortOrder a_eSortOrder);
};

/**
 * Interface for all directory scanning classes.
 * This pure virtual base class defines the interface that all directory scanning classes will adhere to.  Instances
 * of these classes can either be used directly, or obtained from RRemoteFactory::getDirObject().
 */

class RDirObject
{
protected:

	TEntryArray		m_entries;		/**< Array of TEntry classes containing directory and file information */

public:

	virtual TInt open(const char *a_pattern) = 0;

	virtual void close()
	{
		/* Free the contents of the TEntry array in case the RDir class is reused */

		m_entries.Purge();
	}

	virtual TInt read(TEntryArray *&a_entries, enum TDirSortOrder a_sortOrder = EDirSortNone) = 0;
};

/**
 * A class for scanning directories for local directory and file entries.
 * Instances of this class can be used to scan for file information on the local file system.
 */

class RDir : public RDirObject
{
private:

#ifdef __amigaos__

	char			*iPath;			/**< Path to directory being scanned, minus wildcard */
	char			*iPattern;		/**< Pattern to be used for MatchPatternNoCase() */

#ifdef __amigaos4__

	APTR			iContext;		/**< Context used for scanning directory */

#else /* ! __amigaos4__ */

	BPTR			iLock;			/**< Lock on the directory currently being scanned */
	ExAllControl	*iContext;		/**< Control structure used for scanning directory */
	ExAllData		*iCurrent;		/**< Pointer to the file currently being processed */
	ExAllData		*iExAllData;	/**< Buffer used for all file data structures */

#endif /* ! __amigaos4__ */

#elif defined(__unix__)

	char			*iPathBuffer;	/**< Ptr to memory used by iPath and iPattern buffers */
	char			*iPath;			/**< Path to directory being scanned, minus wildcard */
	char			*iPattern;		/**< Pattern to be used for pattern matching in RDir::read() */
	DIR				*iDir;			/**< Pointer to object used for scanning directory */

#else /* ! __unix__ */

	HANDLE			iHandle;		/**< Handle used for scanning directory */

#endif /* ! __unix__ */

	TEntry			iSingleEntry;	/**< If a single entry is being examined, open() will populate this */
	TBool			iSingleEntryOk;	/**< ETrue if the contents of iSingleEntry are valid, else EFalse */

private:

#ifdef WIN32

	TInt AppendDirectoryEntry(WIN32_FIND_DATA *a_poFindData);

#endif /* WIN32 */

public:

	RDir();

	TInt open(const char *a_pccPattern);

	void close();

	TInt read(TEntryArray *&a_rpoEntries, enum TDirSortOrder a_eSortOrder = EDirSortNone);
};

#endif /* ! DIR_H */