JSONWriter.h

#pragma once
 
#include <Foundation/Basics.h>
#include <Foundation/Containers/HybridArray.h>
#include <Foundation/IO/Stream.h>
#include <Foundation/Types/Variant.h>
 
class PL_FOUNDATION_DLL plJSONWriter
{
public:
  enum class WhitespaceMode
  {
    All,             
    LessIndentation, 
    NoIndentation,   
    NewlinesOnly,    
    None,            
  };
 
  enum class ArrayMode
  {
    InOneLine,      
    OneLinePerItem, 
  };
 
  plJSONWriter();
 
  virtual ~plJSONWriter();
 
  void SetWhitespaceMode(WhitespaceMode whitespaceMode) { m_WhitespaceMode = whitespaceMode; }
 
  void SetArrayMode(ArrayMode arrayMode) { m_ArrayMode = arrayMode; }
 
  void AddVariableBool(plStringView sName, bool value); // [tested]
 
  void AddVariableInt32(plStringView sName, plInt32 value); // [tested]
 
  void AddVariableUInt32(plStringView sName, plUInt32 value); // [tested]
 
  void AddVariableInt64(plStringView sName, plInt64 value); // [tested]
 
  void AddVariableUInt64(plStringView sName, plUInt64 value); // [tested]
 
  void AddVariableFloat(plStringView sName, float value); // [tested]
 
  void AddVariableDouble(plStringView sName, double value); // [tested]
 
  void AddVariableString(plStringView sName, plStringView value); // [tested]
 
  void AddVariableNULL(plStringView sName); // [tested]
 
  void AddVariableTime(plStringView sName, plTime value); // [tested]
 
  void AddVariableUuid(plStringView sName, plUuid value); // [tested]
 
  void AddVariableAngle(plStringView sName, plAngle value); // [tested]
 
  void AddVariableColor(plStringView sName, const plColor& value); // [tested]
 
  void AddVariableColorGamma(plStringView sName, const plColorGammaUB& value); // [tested]
 
  void AddVariableVec2(plStringView sName, const plVec2& value); // [tested]
 
  void AddVariableVec3(plStringView sName, const plVec3& value); // [tested]
 
  void AddVariableVec4(plStringView sName, const plVec4& value); // [tested]
 
  void AddVariableVec2I32(plStringView sName, const plVec2I32& value); // [tested]
 
  void AddVariableVec3I32(plStringView sName, const plVec3I32& value); // [tested]
 
  void AddVariableVec4I32(plStringView sName, const plVec4I32& value); // [tested]
 
  void AddVariableQuat(plStringView sName, const plQuat& value); // [tested]
 
  void AddVariableMat3(plStringView sName, const plMat3& value); // [tested]
 
  void AddVariableMat4(plStringView sName, const plMat4& value); // [tested]
 
  void AddVariableDataBuffer(plStringView sName, const plDataBuffer& value); // [tested]
 
  void AddVariableVariant(plStringView sName, const plVariant& value); // [tested]
 
 
  virtual void WriteBool(bool value) = 0;
 
  virtual void WriteInt32(plInt32 value) = 0;
 
  virtual void WriteUInt32(plUInt32 value) = 0;
 
  virtual void WriteInt64(plInt64 value) = 0;
 
  virtual void WriteUInt64(plUInt64 value) = 0;
 
  virtual void WriteFloat(float value) = 0;
 
  virtual void WriteDouble(double value) = 0;
 
  virtual void WriteString(plStringView value) = 0;
 
  virtual void WriteNULL() = 0;
 
  virtual void WriteTime(plTime value) = 0;
 
  virtual void WriteColor(const plColor& value) = 0;
 
  virtual void WriteColorGamma(const plColorGammaUB& value) = 0;
 
  virtual void WriteVec2(const plVec2& value) = 0;
 
  virtual void WriteVec3(const plVec3& value) = 0;
 
  virtual void WriteVec4(const plVec4& value) = 0;
 
  virtual void WriteVec2I32(const plVec2I32& value) = 0;
 
  virtual void WriteVec3I32(const plVec3I32& value) = 0;
 
  virtual void WriteVec4I32(const plVec4I32& value) = 0;
 
  virtual void WriteQuat(const plQuat& value) = 0;
 
  virtual void WriteMat3(const plMat3& value) = 0;
 
  virtual void WriteMat4(const plMat4& value) = 0;
 
  virtual void WriteUuid(const plUuid& value) = 0;
 
  virtual void WriteAngle(plAngle value) = 0; // [tested]
 
  virtual void WriteDataBuffer(const plDataBuffer& value) = 0; // [tested]
 
  virtual void WriteVariant(const plVariant& value); // [tested]
 
  virtual void WriteBinaryData(plStringView sDataType, const void* pData, plUInt32 uiBytes, plStringView sValueString = nullptr) = 0;
 
  virtual void BeginVariable(plStringView sName) = 0;
 
  virtual void EndVariable() = 0;
 
  virtual void BeginArray(plStringView sName = nullptr) = 0;
 
  virtual void EndArray() = 0;
 
  virtual void BeginObject(plStringView sName = nullptr) = 0;
 
  virtual void EndObject() = 0;
 
  bool HadWriteError() const;
 
protected:
  WhitespaceMode m_WhitespaceMode = WhitespaceMode::All;
  ArrayMode m_ArrayMode = ArrayMode::InOneLine;
 
  void SetWriteErrorState();
 
private:
  bool m_bHadWriteError = false;
};
 
 
class PL_FOUNDATION_DLL plStandardJSONWriter : public plJSONWriter
{
public:
  plStandardJSONWriter(); // [tested]
 
  ~plStandardJSONWriter(); // [tested]
 
  void SetOutputStream(plStreamWriter* pOutput); // [tested]
 
  virtual void WriteBool(bool value) override; // [tested]
 
  virtual void WriteInt32(plInt32 value) override; // [tested]
 
  virtual void WriteUInt32(plUInt32 value) override; // [tested]
 
  virtual void WriteInt64(plInt64 value) override; // [tested]
 
  virtual void WriteUInt64(plUInt64 value) override; // [tested]
 
  virtual void WriteFloat(float value) override; // [tested]
 
  virtual void WriteDouble(double value) override; // [tested]
 
  virtual void WriteString(plStringView value) override; // [tested]
 
  virtual void WriteNULL() override; // [tested]
 
  virtual void WriteTime(plTime value) override; // [tested]
 
  virtual void WriteColor(const plColor& value) override; // [tested]
 
  virtual void WriteColorGamma(const plColorGammaUB& value) override; // [tested]
 
  virtual void WriteVec2(const plVec2& value) override; // [tested]
 
  virtual void WriteVec3(const plVec3& value) override; // [tested]
 
  virtual void WriteVec4(const plVec4& value) override; // [tested]
 
  virtual void WriteVec2I32(const plVec2I32& value) override; // [tested]
 
  virtual void WriteVec3I32(const plVec3I32& value) override; // [tested]
 
  virtual void WriteVec4I32(const plVec4I32& value) override; // [tested]
 
  virtual void WriteQuat(const plQuat& value) override; // [tested]
 
  virtual void WriteMat3(const plMat3& value) override; // [tested]
 
  virtual void WriteMat4(const plMat4& value) override; // [tested]
 
  virtual void WriteUuid(const plUuid& value) override; // [tested]
 
  virtual void WriteAngle(plAngle value) override; // [tested]
 
  virtual void WriteDataBuffer(const plDataBuffer& value) override; // [tested]
 
  virtual void WriteBinaryData(plStringView sDataType, const void* pData, plUInt32 uiBytes, plStringView sValueString = nullptr) override; // [tested]
 
  virtual void BeginVariable(plStringView sName) override; // [tested]
 
  virtual void EndVariable() override; // [tested]
 
  virtual void BeginArray(plStringView sName = {}) override; // [tested]
 
  virtual void EndArray() override; // [tested]
 
  virtual void BeginObject(plStringView sName = {}) override; // [tested]
 
  virtual void EndObject() override; // [tested]
 
protected:
  void End();
 
  enum State
  {
    Invalid,
    Empty,
    Variable,
    Object,
    NamedObject,
    Array,
    NamedArray,
  };
 
  struct JSONState
  {
    JSONState();
 
    State m_State;
    bool m_bRequireComma;
    bool m_bValueWasWritten;
  };
 
  struct CommaWriter
  {
    CommaWriter(plStandardJSONWriter* pWriter);
    ~CommaWriter();
 
    plStandardJSONWriter* m_pWriter;
  };
 
  void OutputString(plStringView s);
  void OutputEscapedString(plStringView s);
  void OutputIndentation();
 
  plInt32 m_iIndentation;
  plStreamWriter* m_pOutput;
 
  plHybridArray<JSONState, 16> m_StateStack;
};