Swiften/Base/SafeByteArray.h

/*
 * Copyright (c) 2011 Remko Tronçon
 * Licensed under the GNU General Public License v3.
 * See Documentation/Licenses/GPLv3.txt for more information.
 */

#pragma once

#include <vector>

#include <Swiften/Base/API.h>
#include <Swiften/Base/SafeAllocator.h>
#include <Swiften/Base/ByteArray.h>
#include <boost/smart_ptr/make_shared.hpp>

namespace Swift {
  typedef std::vector<unsigned char, SafeAllocator<unsigned char> > SafeByteArray;

  inline SafeByteArray createSafeByteArray(const ByteArray& a) {
    return SafeByteArray(a.begin(), a.end());
  }

  SWIFTEN_API SafeByteArray createSafeByteArray(const char* c);

  inline SafeByteArray createSafeByteArray(const std::string& s) {
    return SafeByteArray(s.begin(), s.end());
  }

  inline boost::shared_ptr<SafeByteArray> createSafeByteArrayRef(const std::string& s) {
    return boost::make_shared<SafeByteArray>(s.begin(), s.end());
  }

  inline SafeByteArray createSafeByteArray(char c) {
    return SafeByteArray(1, c);
  }

  inline SafeByteArray createSafeByteArray(const char* c, size_t n) {
    return SafeByteArray(c, c + n);
  }

  inline boost::shared_ptr<SafeByteArray> createSafeByteArrayRef(const char* c, size_t n) {
    return boost::make_shared<SafeByteArray>(c, c + n);
  }

  inline SafeByteArray createSafeByteArray(const unsigned char* c, size_t n) {
    return SafeByteArray(c, c + n);
  }

  inline boost::shared_ptr<SafeByteArray> createSafeByteArrayRef(const unsigned char* c, size_t n) {
    return boost::make_shared<SafeByteArray>(c, c + n);
  }

  /* WARNING! This breaks the safety of the data in the safe byte array.
   * Do not use in modes that require data safety. */
  inline std::string safeByteArrayToString(const SafeByteArray& b) {
    return byteArrayToString(ByteArray(b.begin(), b.end()));
  }
}