include/EDocBFD/bfd_utils.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_BFD_UTILS_H
#define EDOCBFD_BFD_UTILS_H

#include <list>
#include <string>
#include "EDoc/Persistence.h"
#include "EDoc/ManagedFile.h"
#include <bfd.h>

namespace EDocBFD
{
   //===========================================================================
   /** \brief Must be called before using any bfd related functions.
    */
   void InitialiseBFD();

   //===========================================================================
   /** \brief Opens the given file using bfd.
    */
   struct bfd* OpenBFDFile(std::string filename);

   //===========================================================================
   /** \brief Reads the contens of a binary file and extracts all relevant EDoc
    * information from them if there is any.
    */
   void ProcessReadBFD(std::list<EDoc::ManagedFile>& input_files, 
      struct bfd* abfd, const EDoc::ManagedFile& filename);

   //===========================================================================
   /** \brief Returns a list of temporary files that have been populated with
    * the contents of an EDoc section.
    */
   std::list<EDoc::ManagedFile> HandleEDocSection(bfd* abfd, asection* asect,
      const EDoc::ManagedFile& arch);

   //===========================================================================
   /** \brief Embeds the contents of the given file into the given section of a
    * binary file.
    */
   void EmbedFileInBinary(const std::string& file_to_embed, 
      const std::string embedded_name,
      const std::string& binary_file, 
      std::string section);

   //===========================================================================
}

#endif // EDOCBFD_BFD_UTILS_H

---