ossimDirectory.h

Go to the documentation of this file.

//*******************************************************************
// Copyright (C) 2000 ImageLinks Inc. 
//
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
// 
// Author: Garrett Potts
//
// Description: 
//
//*************************************************************************
// $Id: ossimDirectory.h 22656 2014-02-28 17:51:42Z dburken $
#ifndef ossimDirectory_HEADER
#define ossimDirectory_HEADER

#include <ossim/base/ossimFilename.h>

#ifndef _WIN32
class ossimDirectoryData;
#endif

class  OSSIMDLLEXPORT ossimDirectory
{
public:
   
   enum
   {
      OSSIM_DIR_FILES     = 0x0001,       // include files
      OSSIM_DIR_DIRS      = 0x0002,       // include directories
      OSSIM_DIR_HIDDEN    = 0x0004,       // include hidden files
      OSSIM_DIR_DOTDOT    = 0x0008,       // include '.' and '..'
      
      // by default, enumerate everything except '.' and '..'
      OSSIM_DIR_DEFAULT   = OSSIM_DIR_FILES | OSSIM_DIR_DIRS | OSSIM_DIR_HIDDEN
   };


   ossimDirectory();
   
   ossimDirectory(const ossimFilename& dir);
   
   ~ossimDirectory();
   
   bool open(const ossimFilename& dir);
   
   bool isOpened() const;
   
   bool getFirst(ossimFilename &filename,
                 int flags = OSSIM_DIR_DEFAULT);
   
   bool getNext(ossimFilename &filename) const;
   
   void findAllFilesThatMatch(std::vector<ossimFilename>& result,
                              const ossimString& regularExpressionPattern,
                              int flags = OSSIM_DIR_DEFAULT);
   
#if defined (_WIN32)
   void setFlags(int flags) { theFlags = flags; };
   bool fileMatched(ossimFilename &filename) const;
#endif    

   // ESH 07/2008, Trac #234: OSSIM is case sensitive 
   // when using worldfile templates during ingest
   bool findCaseInsensitiveEquivalents( const ossimFilename &filename, 
                                        std::vector<ossimFilename>& result,
                                        bool bExcludeExactMatch = true );
   
   // TODO using scandir() when available later, emulating it otherwise
   
private:
#if defined (_WIN32)
   intptr_t      theData;
   ossimFilename theDirectoryName;
   int           theFlags;
#else
   ossimDirectoryData* theData;
#endif
};

#endif /* #ifndef ossimDirectory_HEADER */