Source/kwsys/Directory.hxx.in

   1 /*=========================================================================
   2
   3   Program:   KWSys - Kitware System Library
   4   Module:    $RCSfile: Directory.hxx.in,v $
   5
   6   Copyright (c) Kitware, Inc., Insight Consortium.  All rights reserved.
   7   See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
   8
   9      This software is distributed WITHOUT ANY WARRANTY; without even
  10      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  11      PURPOSE.  See the above copyright notices for more information.
  12
  13 =========================================================================*/
  14 #ifndef @KWSYS_NAMESPACE@_Directory_hxx
  15 #define @KWSYS_NAMESPACE@_Directory_hxx
  16
  17 #include <@KWSYS_NAMESPACE@/Configure.h>
  18
  19 namespace @KWSYS_NAMESPACE@
  20 {
  21
  22 class DirectoryInternals;
  23
  24 /** \class Directory
  25  * \brief Portable directory/filename traversal.
  26  *
  27  * Directory provides a portable way of finding the names of the files
  28  * in a system directory.
  29  *
  30  * Directory currently works with Windows and Unix operating systems.
  31  */
  32 class @KWSYS_NAMESPACE@_EXPORT Directory
  33 {
  34 public:
  35   Directory();
  36   ~Directory();
  37
  38   /**
  39    * Load the specified directory and load the names of the files
  40    * in that directory. 0 is returned if the directory can not be
  41    * opened, 1 if it is opened.
  42    */
  43   bool Load(const char*);
  44
  45   /**
  46    * Return the number of files in the current directory.
  47    */
  48   unsigned long GetNumberOfFiles() const;
  49
  50   /**
  51    * Return the number of files in the specified directory.
  52    * A higher performance static method.
  53    */
  54   static unsigned long GetNumberOfFilesInDirectory(const char*);
  55
  56   /**
  57    * Return the file at the given index, the indexing is 0 based
  58    */
  59   const char* GetFile(unsigned long) const;
  60
  61   /**
  62    * Return the path to Open'ed directory
  63    */
  64   const char* GetPath() const;
  65
  66   /**
  67    * Clear the internal structure. Used internally at beginning of Load(...)
  68    * to clear the cache.
  69    */
  70   void Clear();
  71
  72 private:
  73   // Private implementation details.
  74   DirectoryInternals* Internal;
  75
  76   Directory(const Directory&);  // Not implemented.
  77   void operator=(const Directory&);  // Not implemented.
  78 }; // End Class: Directory
  79
  80 } // namespace @KWSYS_NAMESPACE@
  81
  82 #endif