directory.h

Go to the documentation of this file.

#ifndef DIRECTORY_CLASS
#define DIRECTORY_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : directory                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2001-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/contracts.h>
#include <structures/string_array.h>
 
namespace filesystem {
 
 
class directory : public virtual basis::root_object
{
public:
  directory(const basis::astring &path, const char *pattern = "*");
 
  directory(const directory &to_copy);
 
  virtual ~directory();
 
  directory &operator =(const directory &to_copy);
 
  DEFINE_CLASS_NAME("directory");
 
  bool good() const { return _scanned_okay; }
 
  const basis::astring &path() const;
 
  const basis::astring &pattern() const;
 
  static basis::astring absolute_path(const basis::astring &relative_path);
 
  bool reset(const basis::astring &path, const char *pattern = "*");
 
  bool move_up(const char *pattern = "*");
 
  bool move_down(const basis::astring &subdir, const char *pattern = "*");
 
  bool rescan();
 
  const structures::string_array &files() const;
 
  const structures::string_array &directories() const;
 
  // static methods of general directory-related interest.
 
  static basis::astring current();
 
  static bool make_directory(const basis::astring &path);
 
  static bool remove_directory(const basis::astring &path);
 
  static bool recursive_create(const basis::astring &directory_name);
 
private:
  bool _scanned_okay;  
  basis::astring *_path;  
  structures::string_array *_files;  
  structures::string_array *_folders;  
  basis::astring *_pattern;  
};
 
} //namespace.
 
#endif