include/EDocBFD/Section.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_SECTION_H
#define EDOCBFD_SECTION_H

#include "EDoc/stdint.h"
#include "EDoc/utils.h"

#include <bfd.h>
#include <string>

namespace EDocBFD
{
   //===========================================================================
   /** \brief Used to simplify writing/reading to/from bfd sections.
    */
   class Section
   {
   public:

      //------------------------------------------------------------------------
      /** \brief Create an instance for the given section of the bfd.
       */
      Section(bfd* abfd_in, asection* asect_in);

      //------------------------------------------------------------------------
      /** \brief Write a char of data to the section.
       */
      ssize_t Write(unsigned char data);

      //------------------------------------------------------------------------
      /** \brief Write data to the given section.
       */
      ssize_t Write(const void* data, size_t len);

      //------------------------------------------------------------------------
      /** \brief Read data from the section.
       */
      std::string Read(size_t max_size = 0xFFFFFFFF);

      //------------------------------------------------------------------------
      /** \brief Read data from the section.
       */
      std::string ReadEx(size_t max_size = 0xFFFFFFFF);

      //------------------------------------------------------------------------
      /** \brief Read data from the section.
       */
      ssize_t Read(void* sectbuf, size_t max_size);

      //------------------------------------------------------------------------
      /** \brief Read data from the section.
       */
      ssize_t ReadEx(void* sectbuf, size_t max_size);

      //------------------------------------------------------------------------
      /** \brief Return true if at the end of the sections data.
       */
      inline bool IsEof() const
      {
         return file_pos >= sectsize;
      }

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

   private:

      //------------------------------------------------------------------------
      /** \brief The bfd
       */
      bfd* abfd;

      //------------------------------------------------------------------------
      /** \brief The bfds section object.
       */
      asection* asect;

      //------------------------------------------------------------------------
      /** \brief The location of the file pointer in the sections data.
       */
      size_t file_pos;

      //------------------------------------------------------------------------
      /** \brief The total size of the section.
       */
      size_t sectsize;

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

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

}

#endif // EDOCBFD_SECTION_H

---