BufferObjectWriter.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2005-12-21 16:43:31 -0600 (Wed, 21 Dec 2005) $
 * Version:       $Revision: 18311 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_BUFFER_OBJECT_WRITER_H
#define _VPR_BUFFER_OBJECT_WRITER_H

#include <vpr/vprConfig.h>
#include <vector>
#include <boost/static_assert.hpp>
#include <boost/concept_check.hpp>

#include <vpr/System.h>
#include <vpr/IO/ObjectWriter.h>

namespace vpr
{

class VPR_CLASS_API BufferObjectWriter : public ObjectWriter
{
public:
   static const unsigned int STRING_LENGTH_SIZE;

   BufferObjectWriter();

   BufferObjectWriter(std::vector<vpr::Uint8>* data,
                      const unsigned int curPos = 0);

   void setCurPos(unsigned int val)
   {
      mCurHeadPos = val;
   }

   unsigned int getCurPos()
   {
      return mCurHeadPos;
   }

   std::vector<vpr::Uint8>* getData()
   {
      return mData;
   }

   virtual vpr::ReturnStatus beginTag(const std::string& tagName)
   {
      boost::ignore_unused_variable_warning(tagName);
      return vpr::ReturnStatus::Succeed;
   }
   
   virtual vpr::ReturnStatus endTag()
   {
      return vpr::ReturnStatus::Succeed;
   }

   virtual vpr::ReturnStatus beginAttribute(const std::string& attributeName)
   {
      boost::ignore_unused_variable_warning(attributeName);
      return vpr::ReturnStatus::Succeed;
   }

   virtual vpr::ReturnStatus endAttribute()
   {
      return vpr::ReturnStatus::Succeed;
   }

   virtual vpr::ReturnStatus writeUint8(vpr::Uint8 val);
   virtual vpr::ReturnStatus writeUint16(vpr::Uint16 val);
   virtual vpr::ReturnStatus writeUint32(vpr::Uint32 val);
   virtual vpr::ReturnStatus writeUint64(vpr::Uint64 val);
   virtual vpr::ReturnStatus writeFloat(float val);
   virtual vpr::ReturnStatus writeDouble(double val);
   virtual vpr::ReturnStatus writeString(std::string val);
   virtual vpr::ReturnStatus writeBool(bool val);

   /* Writes raw data of length \p len. */
   inline vpr::ReturnStatus writeRaw(vpr::Uint8* data,
                                     const unsigned int len = 1);

public:
   std::vector<vpr::Uint8>*   mData;
   unsigned int               mCurHeadPos;
};

inline vpr::ReturnStatus BufferObjectWriter::writeUint8(vpr::Uint8 val)
{
   return writeRaw(&val, 1);
}

inline vpr::ReturnStatus BufferObjectWriter::writeUint16(vpr::Uint16 val)
{
   vpr::Uint16 nw_val = vpr::System::Htons(val);

   return writeRaw((vpr::Uint8*) &nw_val, 2);
}

inline vpr::ReturnStatus BufferObjectWriter::writeUint32(vpr::Uint32 val)
{
   vpr::Uint32 nw_val = vpr::System::Htonl(val);

   return writeRaw((vpr::Uint8*) &nw_val, 4);
}

inline vpr::ReturnStatus BufferObjectWriter::writeUint64(vpr::Uint64 val)
{
   vpr::Uint64 nw_val = vpr::System::Htonll(val);

   return writeRaw((vpr::Uint8*) &nw_val, 8);
}

inline vpr::ReturnStatus BufferObjectWriter::writeFloat(float val)
{
   // We are writing the float as a 4 byte value
   BOOST_STATIC_ASSERT(sizeof(float) == 4);
   vpr::Uint32 nw_val = vpr::System::Htonl(*((vpr::Uint32*) &val));

   return writeRaw((vpr::Uint8*) &nw_val, 4);
}

inline vpr::ReturnStatus BufferObjectWriter::writeDouble(double val)
{
   // We are writing the double as a 8 byte value
   BOOST_STATIC_ASSERT(sizeof(double) == 8);
   vpr::Uint64 nw_val = vpr::System::Htonll(*((vpr::Uint64*) &val));

   return writeRaw((vpr::Uint8*) &nw_val, 8);
}

inline vpr::ReturnStatus BufferObjectWriter::writeString(std::string val)
{
   // Note: If you change this, you need to change STRING_LENGTH_SIZE
   writeUint32(val.size());

   for ( vpr::Uint32 i = 0; i < val.length(); ++i )
   {
      writeRaw((vpr::Uint8*) &val[i], 1);
   }

   return vpr::ReturnStatus::Succeed;
}

inline vpr::ReturnStatus BufferObjectWriter::writeBool(bool val)
{
   // Darwin uses four bytes (!) for bools.
#ifdef VPR_OS_Darwin
   vpr::Uint8 temp = (vpr::Uint8) val;
   return writeRaw((vpr::Uint8*) &temp, 1);
#else
   return writeRaw((vpr::Uint8*) &val, 1);
#endif
}

inline vpr::ReturnStatus BufferObjectWriter::writeRaw(vpr::Uint8* data,
                                                      const unsigned int len)
{
   for ( unsigned int i = 0; i < len; ++i )
   {
      mData->push_back(data[i]);
   }

   mCurHeadPos += len;
   return vpr::ReturnStatus::Succeed;
}

} // namespace vpr

#endif

---