DDD_DirectoryTraverser.h

Go to the documentation of this file.

/*! \file DDD_DirectoryTraverser.h
  
  \brief Class for managing traversing a directory and processing all files that match
         an extension

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef DDD_DIRECTORY_TRAVERSER_H
#define DDD_DIRECTORY_TRAVERSER_H

#include "DDD_Include.h"
#include "DDD_LogFacade.h"
#include <string>

class dirent;

namespace disti
{

class DDD_EXPORT DDD_DirectoryTraverser : public DDD_LogFacade
{
protected:
    std::string _fileExtension;   /**< The file extension to search for when traversing.  Must take the form of a 
                                    *  dot followed by a single extension, e.g. ".xyz" or ".xyzLinux"
                                    */

    /** ProcessFile is called whenever a file with a matching extension is found by the traverser
      * Subclasses will provide their own implementation of this method to do whatever processing
      * is needed for each file
      * \param  fileName  The name of the file that was found with the matching extension
      * \return True if the file was successfully processed, false otherwise
      */
    virtual bool ProcessFile(const std::string &fileName)=0;

    /** Helper method used by TraverseDirectory.  Processes the file list from the directory,
      * calling ProcessFile on each file that matched the extension
      * \param  numberOfFilesInDirectory  The number of files that are in the next parameter
      * \param  files  Data stucture containing the list of files in the directory
      */
    void ProcessFiles(int numberOfFilesInDirectory,dirent  **files);
public:

    DDD_DirectoryTraverser(const std::string &fileExtension) :
      _fileExtension(fileExtension)
    {
    }

    /** Searches a directory, then if the directory was readable and has files in it, processes the file list 
      * from the directory
      * \param  pathToTraverse  The directory to Process
      * \return True if the path was successfully searched
      */
    bool TraverseDirectory(const std::string &pathToTraverse);
};

} // end of namespace disti

#endif