Serialization.h

Go to the documentation of this file.

#ifndef INCLUDE_MOLASSEMBLER_SERIALIZATION_H
#define INCLUDE_MOLASSEMBLER_SERIALIZATION_H

#include <cstdint>
#include <vector>
#include <string>
#include <memory>

#include "Molassembler/Export.h"

namespace Scine {
namespace Molassembler {

// Forward-declarations
class Molecule;

class MASM_EXPORT JsonSerialization {
public:
  using BinaryType = std::vector<std::uint8_t>;

  enum class BinaryFormat {
    CBOR,
    BSON,
    MsgPack,
    UBJSON
  };

  static std::string base64Encode(const BinaryType& binary);
  static BinaryType base64Decode(const std::string& base64String);
  static bool base64EqualMolecules(const std::string& stringA, const std::string& stringB,
                                   BinaryFormat binaryFormat = BinaryFormat::CBOR);
  static bool equalDecisionLists(const std::string& listStringA, const std::string& listStringB);

  JsonSerialization(JsonSerialization&& other) noexcept;
  JsonSerialization& operator = (JsonSerialization&& other) noexcept;
  JsonSerialization(const JsonSerialization& other);
  JsonSerialization& operator = (const JsonSerialization& other);
  ~JsonSerialization();

  JsonSerialization() = delete;
  explicit JsonSerialization(const std::string& jsonString);
  explicit JsonSerialization(const Molecule& molecule);
  JsonSerialization(const BinaryType& binary, BinaryFormat format);

  operator std::string() const;
  operator Molecule() const;
  BinaryType toBinary(BinaryFormat format) const;


  JsonSerialization& standardize();

private:
  struct Impl;
  std::unique_ptr<Impl> pImpl_;
  static std::vector<std::tuple<int, int, int, int> > unpackDecisionListString(const std::string& listString);
  static std::tuple<int, int, int, int> canonicalizeDecisionListElement(const std::tuple<int, int, int, int>& decisionListElement);
  static bool equalVersions(const std::vector<unsigned> versionA, const std::vector<unsigned> versionB);
  static std::vector<std::string> splitBase64StringIntoMoleculeStrings(std::string base64String);
  static bool compareMoleculeDecisionList(const std::vector<std::tuple<int, int, int, int>>& listA,
                                          const std::vector<std::tuple<int, int, int, int>>& listB);

};

} // namespace Molassembler
} // namespace Scine

#endif