include/EDoc/ArchiveIFace.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_ARCHIVEIFACE_H
#define EDOC_ARCHIVEIFACE_H

#include "EDoc/ManagedFile.h"

#include <string>
#include <list>

namespace EDoc
{
   //===========================================================================
   /** \brief Standard interface for accessing files inside different types
    * of archives.
    *
    * An archive is considerd a group of one or more files. Current existing
    * archives used for EDoc might include:
    *    - BFD : Binary File Archive with data stored in .EDoc section
    *    - Directory : A directory of files
    *    - Zip : A zip file that may contain .edc files (Currently
    *       un-implemented).
    *    .
    */
   class ArchiveIFace
   {
   public:

      //------------------------------------------------------------------------
      /** \brief Destructor.
       */
      virtual ~ArchiveIFace() {}

      //------------------------------------------------------------------------
      /** \brief Returns true if this factory type can process the given
       * archive.
       */
      virtual bool HandlesType(const ManagedFile& arch_filename) = 0;

      //------------------------------------------------------------------------
      /** \brief Extracts all files from archive and returns a list of
       * ManagedFile object to those extracted files.
       */
      virtual std::list<ManagedFile> ReadExtractAll(const ManagedFile& 
         arch_filename) = 0;

      //------------------------------------------------------------------------
      /** \brief Returns a ManagedFile instance for a file that can be written
       * to in the archive.
       *
       * Many archive formats will return a temporary file that can be written
       * to and will then insert the contents of the temporay file into the
       * archive when the ManagedFile object is destroyed. This is not always
       * the case though for example the DirectoryArchive will just return a
       * reference to a writable file itself.
       */
      virtual ManagedFile WriteOpen(const ManagedFile& arch_filename, 
         std::string item_filename="default.edc") = 0;

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

   };
   //===========================================================================
   typedef std::list<ArchiveIFace*> ArchiveList;

}


#endif // EDOC_ARCHIVEIFACE_H

---