OpenDdlParser.h

#pragma once
 
#include <Foundation/Basics.h>
#include <Foundation/Containers/DynamicArray.h>
#include <Foundation/Containers/HybridArray.h>
#include <Foundation/IO/Stream.h>
 
class plLogInterface;
 
enum class plOpenDdlPrimitiveType
{
  Bool,
  Int8,
  Int16,
  Int32,
  Int64,
  UInt8,
  UInt16,
  UInt32,
  UInt64,
  // Half, // Currently not supported
  Float,
  Double,
  String,
  // Ref, // Currently not supported
  // Type // Currently not supported
  Custom
};
 
class PL_FOUNDATION_DLL plOpenDdlParser
{
public:
  plOpenDdlParser();
  virtual ~plOpenDdlParser() = default;
 
  bool HadFatalParsingError() const { return m_bHadFatalParsingError; } // [tested]
 
protected:
  void SetLogInterface(plLogInterface* pLog) { m_pLogInterface = pLog; }
 
  void SetCacheSize(plUInt32 uiSizeInKB);
 
  void SetInputStream(plStreamReader& stream, plUInt32 uiFirstLineOffset = 0); // [tested]
 
  bool ContinueParsing(); // [tested]
 
  plResult ParseAll(); // [tested]
 
  void SkipRestOfObject();
 
  void StopParsing();
 
  void ParsingError(plStringView sMessage, bool bFatal);
 
  plLogInterface* m_pLogInterface;
 
protected:
  virtual void OnParsingError(plStringView sMessage, bool bFatal, plUInt32 uiLine, plUInt32 uiColumn) {}
 
  virtual void OnBeginObject(plStringView sType, plStringView sName, bool bGlobalName) = 0;
 
  virtual void OnEndObject() = 0;
 
  virtual void OnBeginPrimitiveList(plOpenDdlPrimitiveType type, plStringView sName, bool bGlobalName) = 0;
 
  virtual void OnEndPrimitiveList() = 0;
 
  // virtual void OnBeginPrimitiveArrayList(plOpenDdlPrimitiveType type, plUInt32 uiGroupSize) = 0;
  // virtual void OnEndPrimitiveArrayList() = 0;
 
  virtual void OnPrimitiveBool(plUInt32 count, const bool* pData, bool bThisIsAll) = 0;
 
  virtual void OnPrimitiveInt8(plUInt32 count, const plInt8* pData, bool bThisIsAll) = 0;
  virtual void OnPrimitiveInt16(plUInt32 count, const plInt16* pData, bool bThisIsAll) = 0;
  virtual void OnPrimitiveInt32(plUInt32 count, const plInt32* pData, bool bThisIsAll) = 0;
  virtual void OnPrimitiveInt64(plUInt32 count, const plInt64* pData, bool bThisIsAll) = 0;
 
  virtual void OnPrimitiveUInt8(plUInt32 count, const plUInt8* pData, bool bThisIsAll) = 0;
  virtual void OnPrimitiveUInt16(plUInt32 count, const plUInt16* pData, bool bThisIsAll) = 0;
  virtual void OnPrimitiveUInt32(plUInt32 count, const plUInt32* pData, bool bThisIsAll) = 0;
  virtual void OnPrimitiveUInt64(plUInt32 count, const plUInt64* pData, bool bThisIsAll) = 0;
 
  virtual void OnPrimitiveFloat(plUInt32 count, const float* pData, bool bThisIsAll) = 0;
  virtual void OnPrimitiveDouble(plUInt32 count, const double* pData, bool bThisIsAll) = 0;
 
  virtual void OnPrimitiveString(plUInt32 count, const plStringView* pData, bool bThisIsAll) = 0;
 
private:
  enum State
  {
    Finished,
    Idle,
    ReadingBool,
    ReadingInt8,
    ReadingInt16,
    ReadingInt32,
    ReadingInt64,
    ReadingUInt8,
    ReadingUInt16,
    ReadingUInt32,
    ReadingUInt64,
    ReadingFloat,
    ReadingDouble,
    ReadingString,
  };
 
  struct DdlState
  {
    DdlState()
      : m_State(Idle)
    {
    }
    DdlState(State s)
      : m_State(s)
    {
    }
 
    State m_State;
  };
 
  void ReadNextByte();
  bool ReadCharacter();
  bool ReadCharacterSkipComments();
  void SkipWhitespace();
  void ContinueIdle();
  void ReadIdentifier(plUInt8* szString, plUInt32& count);
  void ReadString();
  void ReadWord();
  plUInt64 ReadDecimalLiteral();
  void PurgeCachedPrimitives(bool bThisIsAll);
  bool ContinuePrimitiveList();
  void ContinueString();
  void SkipString();
  void ContinueBool();
  void ContinueInt();
  void ContinueFloat();
 
  void ReadDecimalFloat();
  void ReadHexString();
 
  plHybridArray<DdlState, 32> m_StateStack;
  plStreamReader* m_pInput;
  plDynamicArray<plUInt8> m_Cache;
 
  static constexpr plUInt32 s_uiMaxIdentifierLength = 64;
 
  plUInt8 m_uiCurByte;
  plUInt8 m_uiNextByte;
  plUInt32 m_uiCurLine;
  plUInt32 m_uiCurColumn;
  bool m_bSkippingMode;
  bool m_bHadFatalParsingError;
  plUInt8 m_szIdentifierType[s_uiMaxIdentifierLength];
  plUInt8 m_szIdentifierName[s_uiMaxIdentifierLength];
  plDynamicArray<plUInt8> m_TempString;
  plUInt32 m_uiTempStringLength;
 
  plUInt32 m_uiNumCachedPrimitives;
  bool* m_pBoolCache;
  plInt8* m_pInt8Cache;
  plInt16* m_pInt16Cache;
  plInt32* m_pInt32Cache;
  plInt64* m_pInt64Cache;
  plUInt8* m_pUInt8Cache;
  plUInt16* m_pUInt16Cache;
  plUInt32* m_pUInt32Cache;
  plUInt64* m_pUInt64Cache;
  float* m_pFloatCache;
  double* m_pDoubleCache;
};