MCBinaryData.hpp

/*
 *  This file is part of the AiBO+ project
 *
 *  Copyright (C) 2005-2016 Csaba Kertész (csaba.kertesz@gmail.com)
 *
 *  AiBO+ 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 of the License, or
 *  (at your option) any later version.
 *
 *  AiBO+ 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 program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
 *
 */

#pragma once

#include <stdint.h>

#include <string>
#include <vector>

#include <boost/serialization/access.hpp>
#include <boost/shared_ptr.hpp>

class QString;

class MCBinaryData;

namespace MC
{
typedef boost::shared_ptr<MCBinaryData> BinaryDataSPtr;
}

class MCBinaryData // -V690 (PVS Studio suppression)
{
  friend class boost::serialization::access;

public:
  MCBinaryData();

  explicit MCBinaryData(int size);

  MCBinaryData(int size, unsigned char value);

  MCBinaryData(const MCBinaryData& other);

  MCBinaryData(MCBinaryData&& other);


  virtual ~MCBinaryData();

  void Allocate(int size);

  void Shrink(int size);

  void Free();

  void Clear();

  bool IsEmpty() const;

  void Set(unsigned char* data, int size);

  void Clone(const MCBinaryData& other);

  MCBinaryData* Clone();

  bool WriteData(MCBinaryData& target, int capacity = -1);

  unsigned int CopyData(MCBinaryData& target, int capacity = -1) const;

  bool LoadFromFile(const std::string& file_name);

#ifndef __AIBO_BUILD__

  bool LoadFromQtResource(const QString& resource_str);
#endif

  bool SaveToFile(const std::string& file_name) const;

  MCBinaryData GenerateMd5Hash() const;

  void AddUChar(unsigned char new_char);

  void AddInt16(int16_t new_int, bool reverse_order = false);

  void AddInt32(int32_t new_int, bool reverse_order = false);

  void AddString(const std::string& str);

  unsigned char GetUChar();

  int16_t GetInt16(bool reverse_order = false);

  int32_t GetInt32(bool reverse_order = false);

  bool ValidateString(unsigned int length, const std::string& additional_chars = "");

  std::string GetString(unsigned int length, const std::string& additional_chars = "");

  unsigned char* GetData() const;

  int GetSize() const;

  const std::vector<unsigned char>& GetVectorData() const;

  int GetPosition() const;

  bool IsPositionAtEnd() const;

  unsigned int GetRemainingCapacity(unsigned int capacity) const;

  void SetPosition(unsigned int position);

  void IncrementPosition(unsigned int position = 1);

  void ResetPosition();

  std::string ToBase64() const;

  void FromBase64(const std::string& base64_str);

  MCBinaryData& operator=(MCBinaryData&& other);

  MCBinaryData& operator=(const MCBinaryData& other);

  bool operator==(const MCBinaryData& other) const;

  bool operator!=(const MCBinaryData& other) const;

private:
  template<class Archive>
  void serialize(Archive& archive, const unsigned int version);

protected:
  std::vector<unsigned char> Data;
  int Size;
  int Position;
};