FormatStringArgs.h

#pragma once
 
#ifndef PL_INCLUDING_BASICS_H
#  error "Please don't include FormatStringArgs.h directly, but instead include Foundation/Basics.h"
#endif
 
class plStringBuilder;
class plVariant;
class plAngle;
class plRational;
struct plTime;
 
struct plArgI
{
  inline explicit plArgI(plInt64 value, plUInt8 uiWidth = 1, bool bPadWithZeros = false, plUInt8 uiBase = 10)
    : m_Value(value)
    , m_uiWidth(uiWidth)
    , m_bPadWithZeros(bPadWithZeros)
    , m_uiBase(uiBase)
  {
  }
 
  plInt64 m_Value;
  plUInt8 m_uiWidth;
  bool m_bPadWithZeros;
  plUInt8 m_uiBase;
};
 
struct plArgU
{
  inline explicit plArgU(plUInt64 value, plUInt8 uiWidth = 1, bool bPadWithZeros = false, plUInt8 uiBase = 10, bool bUpperCase = false)
    : m_Value(value)
    , m_uiWidth(uiWidth)
    , m_bPadWithZeros(bPadWithZeros)
    , m_bUpperCase(bUpperCase)
    , m_uiBase(uiBase)
  {
  }
 
  plUInt64 m_Value;
  plUInt8 m_uiWidth;
  bool m_bPadWithZeros;
  bool m_bUpperCase;
  plUInt8 m_uiBase;
};
 
struct plArgF
{
  inline explicit plArgF(double value, plInt8 iPrecision = -1, bool bScientific = false, plUInt8 uiWidth = 1, bool bPadWithZeros = false)
    : m_Value(value)
    , m_uiWidth(uiWidth)
    , m_bPadWithZeros(bPadWithZeros)
    , m_bScientific(bScientific)
    , m_iPrecision(iPrecision)
  {
  }
 
  double m_Value;
  plUInt8 m_uiWidth;
  bool m_bPadWithZeros;
  bool m_bScientific;
  plInt8 m_iPrecision;
};
 
struct plArgC
{
  inline explicit plArgC(char value)
    : m_Value(value)
  {
  }
 
  char m_Value;
};
 
struct plArgP
{
  inline explicit plArgP(const void* value)
    : m_Value(value)
  {
  }
 
  const void* m_Value;
};
 
 
struct plArgHumanReadable
{
  inline plArgHumanReadable(const double value, const plUInt64 uiBase, const char* const* const pSuffixes, plUInt32 uiSuffixCount)
    : m_Value(value)
    , m_Base(uiBase)
    , m_Suffixes(pSuffixes)
    , m_SuffixCount(uiSuffixCount)
  {
  }
 
  inline plArgHumanReadable(const plInt64 value, const plUInt64 uiBase, const char* const* const pSuffixes, plUInt32 uiSuffixCount)
    : plArgHumanReadable(static_cast<double>(value), uiBase, pSuffixes, uiSuffixCount)
  {
  }
 
  inline explicit plArgHumanReadable(const double value)
    : plArgHumanReadable(value, 1000u, m_DefaultSuffixes, PL_ARRAY_SIZE(m_DefaultSuffixes))
  {
  }
 
  inline explicit plArgHumanReadable(const plInt64 value)
    : plArgHumanReadable(static_cast<double>(value), 1000u, m_DefaultSuffixes, PL_ARRAY_SIZE(m_DefaultSuffixes))
  {
  }
 
  const double m_Value;
  const plUInt64 m_Base;
  const char* const* const m_Suffixes;
  const char* const m_DefaultSuffixes[6] = {"", "K", "M", "G", "T", "P"};
  const plUInt32 m_SuffixCount;
};
 
struct plArgFileSize : public plArgHumanReadable
{
  inline explicit plArgFileSize(const plUInt64 value)
    : plArgHumanReadable(static_cast<double>(value), 1024u, m_ByteSuffixes, PL_ARRAY_SIZE(m_ByteSuffixes))
  {
  }
 
  const char* const m_ByteSuffixes[6] = {"B", "KB", "MB", "GB", "TB", "PB"};
};
 
struct plArgErrorCode
{
  inline explicit plArgErrorCode(plUInt32 uiErrorCode)
    : m_ErrorCode(uiErrorCode)
  {
  }
 
  plUInt32 m_ErrorCode;
};
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgErrorCode& arg);
 
 
#if PL_ENABLED(PL_PLATFORM_LINUX) || PL_ENABLED(PL_PLATFORM_ANDROID)
struct plArgErrno
{
  inline explicit plArgErrno(plInt32 iErrno)
    : m_iErrno(iErrno)
  {
  }
 
  plInt32 m_iErrno;
};
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgErrno& arg);
#endif
 
struct plArgSensitive
{
  inline explicit plArgSensitive(const plStringView& sSensitiveInfo, const char* szContext = nullptr)
    : m_sSensitiveInfo(sSensitiveInfo)
    , m_szContext(szContext)
  {
  }
 
  const plStringView m_sSensitiveInfo;
  const char* m_szContext;
 
  using BuildStringCallback = plStringView (*)(char*, plUInt32, const plArgSensitive&);
  PL_FOUNDATION_DLL static BuildStringCallback s_BuildStringCB;
 
  PL_FOUNDATION_DLL static plStringView BuildString_SensitiveUserData_Hash(char* szTmp, plUInt32 uiLength, const plArgSensitive& arg);
};
 
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgI& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, plInt64 iArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, plInt32 iArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgU& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, plUInt64 uiArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, plUInt32 uiArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgF& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, double fArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, bool bArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const char* szArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const wchar_t* pArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plStringBuilder& sArg);
PL_FOUNDATION_DLL const plStringView& BuildString(char* szTmp, plUInt32 uiLength, const plStringView& sArg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgC& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgP& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, plResult arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plVariant& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plAngle& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plRational& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgHumanReadable& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plTime& arg);
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgSensitive& arg);
 
 
#if PL_ENABLED(PL_COMPILER_GCC) || PL_ENABLED(PL_COMPILER_CLANG)
 
// on these platforms "long int" is a different type from "long long int"
 
PL_ALWAYS_INLINE plStringView BuildString(char* szTmp, plUInt32 uiLength, long int iArg)
{
  return BuildString(szTmp, uiLength, static_cast<plInt64>(iArg));
}
 
PL_ALWAYS_INLINE plStringView BuildString(char* szTmp, plUInt32 uiLength, unsigned long int uiArg)
{
  return BuildString(szTmp, uiLength, static_cast<plUInt64>(uiArg));
}
 
#endif