OCCT

/*
 Copyright (c) 1999-2020 OPEN CASCADE SAS

 This file is part of Open CASCADE Technology software library.

 This library is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License version 2.1 as published
 by the Free Software Foundation, with special exception defined in the file
 OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 distribution for complete text of the license and disclaimer of any warranty.

 Alternatively, this file may be used under the terms of Open CASCADE
 commercial license or contractual agreement.
*/

#include <StepFile_ReadData.hxx>

#include <Interface_Check.hxx>
#include <TCollection_AsciiString.hxx>

// Constant litterales
namespace TextValue
{
static char SubList[]  = "/* (SUB) */";
static char Scope[]    = "SCOPE";
static char Nil[]      = " ";
static char Sub1[]     = "$1"; /* optimisation ... */
static char Sub2[]     = "$2";
static char ArgType1[] = "(IF#TnEHBx"; /* types arguments (2 1es lettres) */
static char ArgType2[] = ")nlIxdnxix";
static char IdZero[]   = "#0";
} // namespace TextValue

class StepFile_ReadData::Argument
{
public:
  Argument()
      : myNext(nullptr),
        myValue(nullptr),
        myType(Interface_ParamSub)
  {
  }

  ~Argument() = default;

public:
  Argument*           myNext;  //!< Next argument in the list for this record
  char*               myValue; //!< Character value of the argument
  Interface_ParamType myType;  //!< Type of the argument
};

class StepFile_ReadData::Record
{
public:
  Record()
      : myNext(nullptr),
        myFirst(nullptr),
        myLast(nullptr),
        myIdent(nullptr),
        myType(nullptr)
  {
  }

  ~Record() = default;

public:
  Record*   myNext;  //!< Next record in the list
  Argument* myFirst; //!< First argument in the record
  Argument* myLast;  //!< Last argument in the record
  char*     myIdent; //!< Record identifier (Example: "#12345") or scope-end
  char*     myType;  //!< Type of the record
};

class StepFile_ReadData::Scope
{
public:
  // Standard OCCT memory allocation stuff
  DEFINE_STANDARD_ALLOC

public:
  Scope()
      : myPrevious(nullptr),
        myRecord(nullptr)
  {
  }

  ~Scope()
  {
    if (myRecord != nullptr)
    {
      myRecord = nullptr;
    }
  }

public:
  Scope*  myPrevious; //!< Previous scope, to which it will be necessary to return
  Record* myRecord;   //!< Record interrupted by the scope (to resume)
};

class StepFile_ReadData::ErrorsPage
{
public:
  ErrorsPage(const char* theError)
      : myNext(nullptr),
        myError(theError)
  {
  }

  //! Returns point to the next ErrorsPage
  ErrorsPage* NextErrorPage() const { return myNext; }

  //! Sets the next ErrorPage
  void SetNextErrorPage(ErrorsPage* theNextErrorsPage) { myNext = theNextErrorsPage; }

  //! Returns an error message
  const char* ErrorMessage() const { return myError.ToCString(); }

  DEFINE_STANDARD_ALLOC
private:
  ErrorsPage*             myNext;  //!< Chaining of records pages
  TCollection_AsciiString myError; //!< Own error message
};

//=================================================================================================

StepFile_ReadData::StepFile_ReadData()
    : myModePrint(0),
      myNbRec(0),
      myNbHead(0),
      myNbPar(0),
      myYaRec(0),
      myNumSub(0),
      myErrorArg(false),
      myResText(nullptr),
      myCurrType(TextValue::SubList),
      mySubArg(nullptr),
      myTypeArg(Interface_ParamSub),
      myCurrArg(nullptr),
      myFirstRec(nullptr),
      myCurRec(nullptr),
      myLastRec(nullptr),
      myCurScope(nullptr),
      myFirstError(nullptr),
      myCurError(nullptr) {};

//=================================================================================================

void StepFile_ReadData::CreateNewText(const char* theNewText, int theLenText)
{
  // Optimization for most frequent entity, CARTESIAN_POINT
  static char aTextOfCarPnt[] = "CARTESIAN_POINT";
  if (strcmp(theNewText, aTextOfCarPnt) == 0)
  {
    myResText = aTextOfCarPnt;
    return;
  }
  //  If error argument exists - prepare size to new text value and old result text
  const int aLength = (myErrorArg) ? theLenText + (int)strlen(myResText) : theLenText;

  char* anOldResText = myResText;

  myResText = static_cast<char*>(myTextAlloc.AllocateOptimal(aLength + 1));

  // If error argument exists - append new text to old result text
  // Else create new result text
  if (myErrorArg)
  {
    strcpy(myResText, anOldResText);
    strcpy(myResText + (int)strlen(anOldResText), theNewText);
    return;
  }
  strcpy(myResText, theNewText);
}

//=================================================================================================

void StepFile_ReadData::RecordNewEntity()
{
  myErrorArg = false; // Reset error argument mod
  AddNewRecord(myCurRec);
  SetTypeArg(Interface_ParamSub);
  mySubArg          = myCurRec->myIdent;
  myCurRec          = myCurRec->myNext;
  myLastRec->myNext = nullptr;
}

//=================================================================================================

void StepFile_ReadData::RecordIdent()
{
  myCurRec = CreateNewRecord();
  GetResultText(&myCurRec->myIdent);
  myCurRec->myNext  = nullptr;
  myCurRec->myFirst = nullptr;
  myCurRec->myLast  = nullptr;
  myYaRec           = 1;
}

//=================================================================================================

void StepFile_ReadData::RecordType()
{
  if (!myYaRec)
  {
    myCurRec          = CreateNewRecord();
    myCurRec->myIdent = TextValue::IdZero;
    myCurRec->myNext  = nullptr;
    myCurRec->myFirst = nullptr;
    myCurRec->myLast  = nullptr;
  }
  GetResultText(&myCurRec->myType);
  myYaRec = myNumSub = 0;
}

//=================================================================================================

void StepFile_ReadData::RecordListStart()
{
  if (myNumSub > 0)
  {
    Record* aSubRec;
    aSubRec = CreateNewRecord();
    switch (myNumSub)
    {
      case 1:
        aSubRec->myIdent = TextValue::Sub1;
        break;
      case 2:
        aSubRec->myIdent = TextValue::Sub2;
        break;
      default: {
        char aBufSub[10];
        if (myNumSub > 9)
        {
          Sprintf(aBufSub, "$%d", myNumSub);
        }
        else
        {
          aBufSub[0] = '$';
          aBufSub[1] = (char)(myNumSub + 48);
          aBufSub[2] = '\0';
        }
        aSubRec->myIdent = RecordNewText(aBufSub);
      }
    }
    aSubRec->myType  = myCurrType;
    myCurrType       = TextValue::SubList;
    aSubRec->myNext  = myCurRec;
    aSubRec->myFirst = nullptr;
    aSubRec->myLast  = nullptr;
    myCurRec         = aSubRec;
  }
  myErrorArg = false; // Reset error arguments mode
  myNumSub++;
}

//=================================================================================================

void StepFile_ReadData::CreateNewArg()
{
  Argument* aNewArg = static_cast<Argument*>(myOtherAlloc.AllocateOptimal(sizeof(Argument)));
  myNbPar++;
  aNewArg->myType = myTypeArg;
  if (myTypeArg == Interface_ParamSub)
  {
    aNewArg->myValue = mySubArg;
  }
  else
  {
    GetResultText(&aNewArg->myValue);
  }

  if (myTypeArg == Interface_ParamMisc)
  {
    myErrorArg = true;
  }

  if (myCurRec->myFirst == nullptr)
  {
    myCurRec->myFirst = aNewArg;
    myCurRec->myLast  = aNewArg;
  }
  else if (myCurRec->myLast == nullptr)
  {
    myCurRec->myFirst->myNext = aNewArg;
    myCurRec->myLast          = aNewArg;
  }
  else
  {
    Argument* aNextArg = myCurRec->myLast;
    aNextArg->myNext   = aNewArg;
    myCurRec->myLast   = aNewArg;
  }
  aNewArg->myNext = nullptr;
}

//=================================================================================================

void StepFile_ReadData::CreateErrorArg()
{

  // If already exists - update text value
  if (!myErrorArg)
  {
    SetTypeArg(Interface_ParamMisc);
    CreateNewArg();
    myErrorArg = true;
    return;
  }

  Argument* aCurrArg = myCurRec->myLast;
  GetResultText(&aCurrArg->myValue);
}

//=================================================================================================

void StepFile_ReadData::AddNewScope()
{
  Scope*  aNewScope;
  Record* aRecord;
  aNewScope             = new (myOtherAlloc.AllocateOptimal(sizeof(Scope))) Scope;
  aNewScope->myRecord   = myCurRec;
  aNewScope->myPrevious = myCurScope;
  myCurScope            = aNewScope;
  aRecord               = CreateNewRecord();
  aRecord->myIdent      = TextValue::Scope;
  aRecord->myType       = TextValue::Nil;
  aRecord->myFirst      = nullptr;
  aRecord->myLast       = nullptr;
  AddNewRecord(aRecord);
}

//=================================================================================================

void StepFile_ReadData::FinalOfScope()
{
  Scope*  anOldScope;
  Record* aRecord;
  if (myCurScope == nullptr)
  {
    return;
  }

  aRecord          = CreateNewRecord();
  aRecord->myIdent = TextValue::Scope;
  aRecord->myType  = TextValue::Nil;
  aRecord->myFirst = nullptr;
  aRecord->myLast  = nullptr;

  if (mySubArg[0] == '$')
  {
    if (myModePrint > 0)
    {
      Printf("Export List : (List in Record n0 %d) -- ", myNbRec);
      PrintRecord(myLastRec);
    }
    myCurRec  = aRecord;
    myTypeArg = Interface_ParamSub;
    CreateNewArg();
  }

  AddNewRecord(aRecord);

  myCurRec   = myCurScope->myRecord;
  myYaRec    = 1;
  anOldScope = myCurScope;
  myCurScope = anOldScope->myPrevious;
}

//=================================================================================================

void StepFile_ReadData::ClearRecorder(const int theMode)
{
  if (theMode & 1)
  {
    myCurrType = nullptr;
    mySubArg   = nullptr;
    myCurrArg  = nullptr;
    myFirstRec = nullptr;
    myCurRec   = nullptr;
    myLastRec  = nullptr;
    myCurScope = nullptr;
    myOtherAlloc.Reset(true);
  }
  if (theMode & 2)
  {
    myResText = nullptr;
    myTextAlloc.Reset(true);
  }
}

//=================================================================================================

bool StepFile_ReadData::GetArgDescription(Interface_ParamType* theType, char** theValue)
{
  if (myCurrArg == nullptr)
  {
    return false;
  }
  *theType  = myCurrArg->myType;
  *theValue = myCurrArg->myValue;
  myCurrArg = myCurrArg->myNext;
  return true;
}

//=================================================================================================

void StepFile_ReadData::GetFileNbR(int* theNbHead, int* theNbRec, int* theNbPage)
{
  myCurRec   = myFirstRec;
  *theNbHead = myNbHead;
  *theNbRec  = myNbRec;
  *theNbPage = myNbPar;
}

//=================================================================================================

bool StepFile_ReadData::GetRecordDescription(char** theIdent, char** theType, int* theNbArg)
{
  if (myCurRec == nullptr)
  {
    return false;
  }
  *theIdent = myCurRec->myIdent;
  *theType  = myCurRec->myType;
  *theNbArg = (myCurRec->myFirst != nullptr);
  myCurrArg = myCurRec->myFirst;
  return true;
}

//=================================================================================================

void StepFile_ReadData::RecordTypeText()
{
  GetResultText(&myCurrType);
}

//=================================================================================================

void StepFile_ReadData::NextRecord()
{
  myCurRec = myCurRec->myNext;
}

//=================================================================================================

void StepFile_ReadData::PrintCurrentRecord()
{
  PrintRecord(myCurRec);
}

//=================================================================================================

void StepFile_ReadData::PrepareNewArg()
{
  myErrorArg = false;
}

//=================================================================================================

void StepFile_ReadData::FinalOfHead()
{
  myNbHead = myNbRec;
}

//=================================================================================================

void StepFile_ReadData::SetTypeArg(const Interface_ParamType theArgType)
{
  myTypeArg = theArgType;
}

//=================================================================================================

void StepFile_ReadData::SetModePrint(const int theMode)
{
  myModePrint = theMode;
}

//=================================================================================================

int StepFile_ReadData::GetModePrint() const
{
  return myModePrint;
}

//=================================================================================================

int StepFile_ReadData::GetNbRecord() const
{
  return myNbRec;
}

//=================================================================================================

void StepFile_ReadData::AddError(const char* theErrorMessage)
{
  if (myFirstError == nullptr)
  {
    myFirstError =
      new (myOtherAlloc.AllocateOptimal(sizeof(ErrorsPage))) ErrorsPage(theErrorMessage);
    myCurError = myFirstError;
  }
  else
  {
    myCurError->SetNextErrorPage(new (myOtherAlloc.AllocateOptimal(sizeof(ErrorsPage)))
                                   ErrorsPage(theErrorMessage));
    myCurError = myCurError->NextErrorPage();
  }
}

//=================================================================================================

bool StepFile_ReadData::ErrorHandle(const occ::handle<Interface_Check>& theCheck) const
{
  if (myFirstError != nullptr)
  {
    ErrorsPage* aCurrent = myFirstError;
    while (aCurrent != nullptr)
    {
      theCheck->AddFail(aCurrent->ErrorMessage(), "Undefined Parsing");
      aCurrent = aCurrent->NextErrorPage();
    }
  }
  return myFirstError == nullptr;
}

//=================================================================================================

const char* StepFile_ReadData::GetLastError() const
{
  return myCurError != nullptr ? myCurError->ErrorMessage() : nullptr;
}

//=================================================================================================

char* StepFile_ReadData::RecordNewText(char* theText)
{
  char* aSavResText;
  char* aNewText;
  aSavResText = myResText;
  CreateNewText(theText, (int)strlen(theText));
  aNewText  = myResText;
  myResText = aSavResText;
  return aNewText;
}

//=================================================================================================

void StepFile_ReadData::GetResultText(char** theText)
{
  *theText = myResText;
}

//=================================================================================================

void StepFile_ReadData::AddNewRecord(Record* theNewRecord)
{
  myNbRec++;
  if (myFirstRec == nullptr)
  {
    myFirstRec = theNewRecord;
  }
  if (myLastRec != nullptr)
  {
    myLastRec->myNext = theNewRecord;
  }
  myLastRec = theNewRecord;
}

//=================================================================================================

StepFile_ReadData::Record* StepFile_ReadData::CreateNewRecord()
{
  return static_cast<Record*>(myOtherAlloc.AllocateOptimal(sizeof(Record)));
}

//=================================================================================================

void StepFile_ReadData::PrintRecord(Record* theRecord)
{
  int aNumArg  = 0;
  int aNumLen  = 0;
  int anArgLen = 0;
  if (theRecord == nullptr)
  {
    Printf("Not defined\n");
    return;
  }
  Printf("Ident : %s  Type : %s  Nb.Arg.s : %s\n",
         theRecord->myIdent,
         theRecord->myType,
         (theRecord->myFirst ? theRecord->myFirst->myValue : ""));
  if (myModePrint < 2)
  {
    return;
  }
  myCurrArg = theRecord->myFirst;
  while (myCurrArg != nullptr)
  {
    aNumArg++;
    anArgLen = (int)strlen(myCurrArg->myValue) + 18;
    aNumLen += anArgLen;
    if (aNumLen > 132)
    {
      Printf("\n");
      aNumLen = anArgLen;
    }
    Printf("  - Arg.%d[%c%c] : %s",
           aNumArg,
           TextValue::ArgType1[myCurrArg->myType],
           TextValue::ArgType2[myCurrArg->myType],
           myCurrArg->myValue);
    myCurrArg = myCurrArg->myNext;
  }
  if (anArgLen > 0)
  {
    Printf("\n");
  }
}