Simple class for directory listing. More...

#include "DirWalker.h"

Collaboration diagram for DirWalker:

Public Member Functions
	DirWalker ()

	~DirWalker ()

const char *	currentFileName ()

bool	OpenDir (const char dir, const char suffix="")
	Opens directory for listing. More...

void	CloseDir ()
	Closes opened directory. More...

bool	NextFile ()
	Iterates over to next file in directory. More...

Protected Attributes
DIR *	mDir

struct dirent *	mFile

std::string	mSuffix

Detailed Description

Simple class for directory listing.

Note: Capt: Even that I don't always like boost, it has a very useful class called FileSystem which does this stuff very crossplatform.

Author: Zhur, Bloody.Rabbit

Definition at line 38 of file DirWalker.h.

Constructor & Destructor Documentation

DirWalker::DirWalker ( )

Definition at line 30 of file DirWalker.cpp.

 : mFind( INVALID_HANDLE_VALUE ),
   mFindData(),
   mValid( false ),
   mFirst( false )
 #else /* !HAVE_WINDOWS_H */
 : mDir( NULL ),
   mFile( NULL ),
   mSuffix()
 #endif /* !HAVE_WINDOWS_H */
 {
 }

DirWalker::~DirWalker ( )

Definition at line 44 of file DirWalker.cpp.

References CloseDir().

 {
     CloseDir();
 }

Here is the call graph for this function:

Member Function Documentation

void DirWalker::CloseDir ( )

Closes opened directory.

Definition at line 84 of file DirWalker.cpp.

References mDir, mFile, and mSuffix.

Referenced by OpenDir(), and ~DirWalker().

 {
 #ifdef HAVE_WINDOWS_H
     if( INVALID_HANDLE_VALUE != mFind )
         ::FindClose( mFind );
 
     mValid = false;
     mFirst = false;
 #else /* !HAVE_WINDOWS_H */
     if( NULL != mDir )
         ::closedir( mDir );
 
     mFile = NULL;
     mSuffix.clear();
 #endif /* !HAVE_WINDOWS_H */
 }

Here is the caller graph for this function:

const char * DirWalker::currentFileName ( )

Returns: Current file name.

Definition at line 49 of file DirWalker.cpp.

References mFile.

Referenced by NextFile().

 {
 #ifdef HAVE_WINDOWS_H
     return mValid ? mFindData.cFileName : NULL;
 #else /* !HAVE_WINDOWS_H */
     return NULL != mFile ? mFile->d_name : NULL;
 #endif /* !HAVE_WINDOWS_H */
 }

Here is the caller graph for this function:

bool DirWalker::NextFile ( )

Iterates over to next file in directory.

Note: This function must be called after OpenDir() before calling currentFileName().

Return values

true	Iteration successful.
false	Iteration failed; most likely there are no more files.

Definition at line 101 of file DirWalker.cpp.

References currentFileName(), mDir, mFile, and mSuffix.

 {
 #ifdef HAVE_WINDOWS_H
     if( INVALID_HANDLE_VALUE == mFind )
         return false;
 
     if( mFirst )
         mFirst = false;
     else
         mValid = ( TRUE == ::FindNextFile( mFind, &mFindData ) );
 
     return mValid;
 #else /* !HAVE_WINDOWS_H */
     if( NULL == mDir )
         return false;
 
     // We need to do the suffix matching here
     while( NULL != ( mFile = ::readdir( mDir ) ) )
     {
         const std::string filename( currentFileName() );
         const size_t pos = filename.rfind( mSuffix );
 
         if( std::string::npos == pos )
             continue;
         else if( filename.length() != ( pos + mSuffix.length() ) )
             continue;
         else
             return true;
     }
 
     return false;
 #endif /* !HAVE_WINDOWS_H */
 }

Here is the call graph for this function:

bool DirWalker::OpenDir	(	const char *	dir,
		const char *	suffix = `""`
	)

Opens directory for listing.

Parameters

[in]	dir	Path to directory; must NOT end with backslash.
[in]	suffix	Only files with this suffix are matched.

Return values

true	Directory opened successfully.

Returns: false Failed to open directory.

Definition at line 58 of file DirWalker.cpp.

References CloseDir(), mDir, mFile, and mSuffix.

 {
     CloseDir();
 
 #ifdef HAVE_WINDOWS_H
     // Let Windows do the suffix matching
     std::string d( dir );
     d += "/*";
     d += suffix;
 
     mFind = ::FindFirstFile( d.c_str(), &mFindData );
     mValid = ( INVALID_HANDLE_VALUE != mFind );
     mFirst = true;
 
     // If no file was found, see if at least
     // the directory was found ...
     return ( mValid ? true : ( ERROR_PATH_NOT_FOUND != ::GetLastError() ) );
 #else /* !HAVE_WINDOWS_H */
     mDir = ::opendir( dir );
     mFile = NULL;
     mSuffix = suffix;
 
     return ( NULL != mDir );
 #endif /* !HAVE_WINDOWS_H */
 }