OCCT

// Created on: 2001-04-27
// Created by: OCC Team
// Copyright (c) 2001-2014 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 <Message_Msg.hxx>
#include <Message_MsgFile.hxx>
#include <TCollection_AsciiString.hxx>

typedef enum
{
  Msg_IntegerType,
  Msg_RealType,
  Msg_StringType,
  Msg_IndefiniteType
} FormatType;

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

Message_Msg::Message_Msg() = default;

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

Message_Msg::Message_Msg(const Message_Msg& theMsg)
{
  myMessageBody = theMsg.myMessageBody;
  myOriginal    = theMsg.myOriginal;
  for (int i = 1, n = theMsg.mySeqOfFormats.Length(); i <= n; i++)
  {
    mySeqOfFormats.Append(theMsg.mySeqOfFormats.Value(i));
  }
}

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

Message_Msg::Message_Msg(const char* const theMsgCode)
{
  TCollection_AsciiString aKey((char*)theMsgCode);
  Set(Message_MsgFile::Msg(aKey));
}

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

Message_Msg::Message_Msg(const TCollection_ExtendedString& theMsgCode)
{
  Set(Message_MsgFile::Msg(theMsgCode));
}

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

void Message_Msg::Set(const char* const theMsg)
{
  TCollection_AsciiString aMsg((char*)theMsg);
  Set(aMsg);
}

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

void Message_Msg::Set(const TCollection_ExtendedString& theMsg)
{
  myMessageBody = theMsg;

  const char16_t* const anExtString = myMessageBody.ToExtString();
  int                   anMsgLength = myMessageBody.Length();
  for (int i = 0; i < anMsgLength; i++)
  {
    //  Search for '%' character starting a format specification
    if (ToCharacter(anExtString[i]) == '%')
    {
      int  aStart = i++;
      char aChar  = ToCharacter(anExtString[i]);
      //        Check for format '%%'
      if (aChar == '%')
      {
        myMessageBody.Remove(i + 1);
        if (i >= --anMsgLength)
        {
          break;
        }
        aChar = ToCharacter(anExtString[i]);
      }
      //        Skip flags, field width and precision
      while (i < anMsgLength)
      {
        if (aChar == '-' || aChar == '+' || aChar == ' ' || aChar == '#'
            || (aChar >= '0' && aChar <= '9') || aChar == '.')
        {
          i++;
        }
        else
        {
          break;
        }
        aChar = ToCharacter(anExtString[i]);
      }
      if (i >= anMsgLength)
      {
        break;
      }

      FormatType aFormatType;
      if (aChar == 'h' || aChar == 'l')
      {
        aChar = ToCharacter(anExtString[++i]);
      }
      switch (aChar) // detect the type of format spec
      {
        case 'd':
        case 'i':
        case 'o':
        case 'u':
        case 'x':
        case 'X':
          aFormatType = Msg_IntegerType;
          break;
        case 'f':
        case 'e':
        case 'E':
        case 'g':
        case 'G':
          aFormatType = Msg_RealType;
          break;
        case 's':
          aFormatType = Msg_StringType;
          break;
        default:
          continue;
      }
      mySeqOfFormats.Append(int(aFormatType)); // type
      mySeqOfFormats.Append(aStart);           // beginning pos
      mySeqOfFormats.Append(i + 1 - aStart);   // length
    }
  }
  myOriginal = myMessageBody;
}

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

Message_Msg& Message_Msg::Arg(const char* const theString)
{
  // get location and format
  TCollection_AsciiString aFormat;
  int                     aFirst = getFormat(Msg_StringType, aFormat);
  if (!aFirst)
  {
    return *this;
  }

  // print string according to format
  char* sStringBuffer = new char[std::max(static_cast<int>(strlen(theString) + 1), 1024)];
  Sprintf(sStringBuffer, aFormat.ToCString(), theString);
  TCollection_ExtendedString aStr(sStringBuffer, true);
  delete[] sStringBuffer;
  sStringBuffer = nullptr;

  // replace the format placeholder by the actual string
  replaceText(aFirst, aFormat.Length(), aStr);

  return *this;
}

//=======================================================================
// function : Arg (TCollection_ExtendedString)
// purpose  :
// remark   : This type of string is inserted without conversion (i.e. like %s)
//=======================================================================

Message_Msg& Message_Msg::Arg(const TCollection_ExtendedString& theString)
{
  // get location and format
  TCollection_AsciiString aFormat;
  int                     aFirst = getFormat(Msg_StringType, aFormat);
  if (!aFirst)
  {
    return *this;
  }

  // replace the format placeholder by the actual string
  replaceText(aFirst, aFormat.Length(), theString);

  return *this;
}

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

Message_Msg& Message_Msg::Arg(const int theValue)
{
  // get location and format
  TCollection_AsciiString aFormat;
  int                     aFirst = getFormat(Msg_IntegerType, aFormat);
  if (!aFirst)
  {
    return *this;
  }

  // print string according to format
  char sStringBuffer[64];
  Sprintf(sStringBuffer, aFormat.ToCString(), theValue);
  TCollection_ExtendedString aStr(sStringBuffer);

  // replace the format placeholder by the actual string
  replaceText(aFirst, aFormat.Length(), aStr);

  return *this;
}

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

Message_Msg& Message_Msg::Arg(const double theValue)
{
  // get location and format
  TCollection_AsciiString aFormat;
  int                     aFirst = getFormat(Msg_RealType, aFormat);
  if (!aFirst)
  {
    return *this;
  }

  // print string according to format
  char sStringBuffer[64];
  Sprintf(sStringBuffer, aFormat.ToCString(), theValue);
  TCollection_ExtendedString aStr(sStringBuffer);

  // replace the format placeholder by the actual string
  replaceText(aFirst, aFormat.Length(), aStr);

  return *this;
}

//=======================================================================
// function : Get
// purpose  : used when the message is dispatched in Message_Messenger
//=======================================================================

const TCollection_ExtendedString& Message_Msg::Get()
{
  // remove all non-initialised format specifications
  int                                     i, anIncrement = 0;
  static const TCollection_ExtendedString anUnknown("UNKNOWN");
  for (i = 1; i < mySeqOfFormats.Length(); i += 3)
  {
    TCollection_ExtendedString aRightPart =
      myMessageBody.Split(mySeqOfFormats(i + 1) + anIncrement);
    aRightPart.Remove(1, mySeqOfFormats(i + 2));
    myMessageBody += anUnknown;
    myMessageBody += aRightPart;
    anIncrement += (anUnknown.Length() - mySeqOfFormats(i + 2));
  }
  return myMessageBody;
}

//=======================================================================
// function : getFormat
// purpose  : Find placeholder in the string where to put next value of
//           specified type, return its starting position in the string
//           and relevant format string (located at that position).
//           The information on returned placeholder is deleted immediately,
//           so it will not be found further
//           If failed (no placeholder with relevant type found), returns 0
//=======================================================================

int Message_Msg::getFormat(const int theType, TCollection_AsciiString& theFormat)
{
  for (int i = 1; i <= mySeqOfFormats.Length(); i += 3)
  {
    if (mySeqOfFormats(i) == theType)
    {
      // Extract format
      int aFirst = mySeqOfFormats(i + 1);
      int aLen   = mySeqOfFormats(i + 2);
      theFormat  = TCollection_AsciiString(aLen, ' ');
      for (int j = 1; j <= aLen; j++)
      {
        if (IsAnAscii(myMessageBody.Value(aFirst + j)))
        {
          theFormat.SetValue(j, (char)myMessageBody.Value(aFirst + j));
        }
      }
      // delete information on this placeholder
      mySeqOfFormats.Remove(i, i + 2);
      // return start position
      return aFirst + 1;
    }
  }
  return 0;
}

//=======================================================================
// function : replaceText
// purpose  : Replace format text in myMessageBody (theNb chars from theFirst)
//           by string theStr
//=======================================================================

void Message_Msg::replaceText(const int                         theFirst,
                              const int                         theNb,
                              const TCollection_ExtendedString& theStr)
{
  myMessageBody.Remove(theFirst, theNb);
  myMessageBody.Insert(theFirst, theStr);

  // update information on remaining format placeholders
  int anIncrement = theStr.Length() - theNb;
  if (!anIncrement)
  {
    return;
  }
  for (int i = 1; i <= mySeqOfFormats.Length(); i += 3)
  {
    if (mySeqOfFormats(i + 1) > theFirst)
    {
      mySeqOfFormats(i + 1) += anIncrement;
    }
  }
}