include/EDocBFD/BFDArchive.h

Go to the documentation of this file.

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

   Copyright (C) 2007 Brendon Costa

   This code 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, or (at your option)
   any later version.

   This code 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.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this code; see the file COPYING.  If not, write to
   the Free Software Foundation, 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.

*******************************************************************************/
#ifndef EDOCBFD_BFDARCHIVE_H
#define EDOCBFD_BFDARCHIVE_H

#include "EDoc/ArchiveIFace.h"
#include "EDoc/ManagedFile.h"
#include "EDoc/ManagedFileCleanupIFace.h"

#include <string>

namespace EDocBFD
{
   //===========================================================================
   /** \brief Used to cleanup when usage of an extracted BFD file is complete.
    *
    * This should perform operations such as cleaning up a temporary work 
    * file and merging the temporary files contents back into the BFD archive.
    */
   class ExtractedBFDFile : public EDoc::ManagedFileCleanupIFace
   {
   public:

      //------------------------------------------------------------------------
      /** \brief Create a instance that cleans up the the specified temporary 
       * file.
       *
       * This is used for when opening a BFD file for reading only as the 
       * resulting work file will not need to be re-merged back into the BFD.
       */
      ExtractedBFDFile(std::string temp_file_name_in);

      //------------------------------------------------------------------------
      /** \brief Create a instance that merges the temporary file back into 
       * the BFD before cleaning it up.
       *
       * This is used when a BFD file is being used for writing to.
       */
      ExtractedBFDFile(std::string bfd_file_name_in, 
         std::string temp_file_name_in,
         std::string embedded_file_name_in);

      //------------------------------------------------------------------------
      /** \brief Will perform cleanup upon destruction.
       */
      virtual ~ExtractedBFDFile();
      
      //------------------------------------------------------------------------
      /** \brief True if the contents of the temporary file needs to be 
       * merged back into bfd_file_name upon cleanup
       */
      bool sync;

      //------------------------------------------------------------------------
      /** \brief The name of the BFD archive from which this file was extracted.
       */
      std::string bfd_file_name;

      //------------------------------------------------------------------------
      /** \brief The name of the temporary file that represents this ManagedFile
       * object.
       */
      std::string temp_file_name;

      //------------------------------------------------------------------------
      /** \brief The internal name within the archive to use for writing this 
       * data back to the BFD archive.
       */
      std::string embedded_file_name;

      //------------------------------------------------------------------------
   };

   //===========================================================================
   /** \brief Factory for inserting/extracting files to/from the .edoc section 
    * of a binary file.
    *
    * This uses the GNU libbfd to read and write data to binary files such as 
    * executables, objects and libraries.
    */
   class BFDArchive : public EDoc::ArchiveIFace
   {
   public:

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

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

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

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

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


#endif // EDOCBFD_BFDARCHIVE_H

---