include/EDoc/DirectoryArchive.h

Go to the documentation of this file.

/*******************************************************************************

   Copyright (C) 2007 by Brendon Costa

   This library is free software; you can redistribute it and/or modify 
   it under the terms of the "LGPL Like" License defined in the file COPYING 
   that should have been distributed along with this source.

   This library is distributed in the hope that it will be useful, 
   but WITHOUT ANY WARRANTY; without even the implied warranty of 
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

   You should have received a copy of the "LGPL Like" License 
   along with this library; see the file COPYING. if not, it can be 
   obtained from the EDoc++ website: 
   http://edoc.sourceforge.net/license.html

*******************************************************************************/
#ifndef EDOC_DIRECTORYARCHIVE_H
#define EDOC_DIRECTORYARCHIVE_H

#include "EDoc/ArchiveIFace.h"

namespace EDoc
{
   //===========================================================================
   /** \brief Represents an archive of data files within a directory.
    *
    * This is used to provide a consistent method for looking for files 
    * recursivley within a directory. EDoc will treat a directory like a zip 
    * file in that it is a filesystem element that contains a number of files.
    */
   class DirectoryArchive : public ArchiveIFace
   {
   public:

      //------------------------------------------------------------------------
      /** \brief See EDoc::ArchiveIFace::HandlesType()
       */
      virtual bool HandlesType(const ManagedFile& arch_filename);

      //------------------------------------------------------------------------
      /** \brief See EDoc::ArchiveIFace::ReadExtractAll()
       */
      virtual std::list<ManagedFile> ReadExtractAll(const ManagedFile& arch_filename);

      //------------------------------------------------------------------------
      /** \brief See EDoc::ArchiveIFace::WriteOpen()
       */
      virtual ManagedFile WriteOpen(const ManagedFile& arch_filename, 
         std::string item_filename="default.edc");

      //------------------------------------------------------------------------

   };
   //===========================================================================

}


#endif // EDOC_DIRECTORYARCHIVE_H

---