simgear/misc/sg_dir.hxx

   1
   2 // Written by James Turner, started July 2010.
   3 //
   4 // Copyright (C) 2010  Curtis L. Olson - http://www.flightgear.org/~curt
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Library General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Library General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19 //
  20 // $Id$
  21
  22
  23 #ifndef _SG_DIR_HXX
  24 #define _SG_DIR_HXX
  25
  26 #include <sys/types.h>
  27
  28 #include <simgear/compiler.h>
  29 #include <string>
  30
  31 #include <simgear/math/sg_types.hxx>
  32 #include <simgear/misc/sg_path.hxx>
  33
  34 #ifdef _MSC_VER
  35   typedef int mode_t;
  36 #endif
  37
  38 namespace simgear
  39 {
  40   typedef std::vector<SGPath> PathList;
  41
  42   class Dir
  43   {
  44   public:
  45     static Dir current();
  46
  47     /**
  48      * create a temporary directory, using the supplied name
  49      */
  50     static Dir tempDir(const std::string& templ);
  51
  52     Dir(const SGPath& path);
  53     Dir(const Dir& rel, const SGPath& relPath);
  54
  55     enum FileTypes
  56     {
  57       TYPE_FILE = 1,
  58       TYPE_DIR = 2,
  59       NO_DOT_OR_DOTDOT = 1 << 12,
  60       INCLUDE_HIDDEN = 1 << 13
  61     };
  62
  63     PathList children(int types = 0, const std::string& nameGlob = "") const;
  64
  65     SGPath file(const std::string& name) const;
  66
  67     SGPath path() const
  68         { return _path; }
  69
  70     /**
  71      * create the directory (and any parents as required) with the
  72      * request mode, or return failure
  73      */
  74     bool create(mode_t mode);
  75
  76     /**
  77      * remove the directory.
  78      * If recursive is true, contained files and directories are
  79      * recursively removed
  80      */
  81     bool remove(bool recursive = false);
  82
  83     /**
  84      * Check that the directory at the path exists (and is a directory!)
  85      */
  86     bool exists() const;
  87
  88     /**
  89      * parent directory, if one exists
  90      */
  91     Dir parent() const;
  92   private:
  93     mutable SGPath _path;
  94   };
  95 } // of namespace simgear
  96
  97 #endif // _SG_DIR_HXX
  98
  99