#include <T2String.h>

Public Types
using	StringTraits = TStringTraits

using	CharTraits = typename StringTraits::CharTraits

using	CharType = typename StringTraits::CharType

using	UCharType = typename StringTraits::UCharType

Public Member Functions
	TSTATICASSERT (Size > 0)

constexpr	T2FormatString ()

	T2FormatString (const CharType *a_szString)

void	Copy (const CharType *a_szString)

TINT	ParseLine (const CharType a_szString, TINT a_uiSize=-1, TINT a_pStringLength=nullptr, TBOOL a_bTrimStartSpaces=true, TBOOL a_bTrimEndSpaces=true)
	Parses a line from specified buffer and saves it.

void	Format (const CharType *a_szFormat,...)

void	FormatV (const CharType *a_szFormat, va_list a_Args)

void	Append (const CharType *a_szString)

void	Clear ()

TUINT	Length ()

constexpr CharType *	Get ()

constexpr const CharType *	Get () const

constexpr CharType *	Get (TUINT a_uiIndex)

constexpr const CharType *	Get (TUINT a_uiIndex) const

constexpr CharType &	operator[] (TUINT a_uiIndex)

constexpr const CharType &	operator[] (TUINT a_uiIndex) const

Detailed Description

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>
class T2FormatString< Size, TStringTraits >

Definition at line 85 of file T2String.h.

Member Typedef Documentation

◆ CharTraits

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

using T2FormatString< Size, TStringTraits >::CharTraits = typename StringTraits::CharTraits

Definition at line 91 of file T2String.h.

◆ CharType

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

using T2FormatString< Size, TStringTraits >::CharType = typename StringTraits::CharType

Definition at line 92 of file T2String.h.

◆ StringTraits

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

using T2FormatString< Size, TStringTraits >::StringTraits = TStringTraits

Definition at line 90 of file T2String.h.

◆ UCharType

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

using T2FormatString< Size, TStringTraits >::UCharType = typename StringTraits::UCharType

Definition at line 93 of file T2String.h.

Constructor & Destructor Documentation

◆ T2FormatString() [1/2]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

T2FormatString< Size, TStringTraits >::T2FormatString ( )

inlineconstexpr

Definition at line 96 of file T2String.h.

    {
        m_szBuffer[ 0 ] = CharTraits::NullChar;
    }

◆ T2FormatString() [2/2]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

T2FormatString< Size, TStringTraits >::T2FormatString ( const CharType * a_szString )

inline

Definition at line 101 of file T2String.h.

    {
        Copy( a_szString );
    }

Member Function Documentation

◆ Append()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

void T2FormatString< Size, TStringTraits >::Append ( const CharType * a_szString )

inline

Definition at line 189 of file T2String.h.

    {
        StringTraits::Concat( m_szBuffer, a_szString );
    }

◆ Clear()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

void T2FormatString< Size, TStringTraits >::Clear ( )

inline

Definition at line 194 of file T2String.h.

    {
        m_szBuffer[ 0 ] = CharTraits::NullChar;
    }

◆ Copy()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

void T2FormatString< Size, TStringTraits >::Copy ( const CharType * a_szString )

inline

Definition at line 106 of file T2String.h.

    {
        StringTraits::CopySafe( m_szBuffer, a_szString, Size );
    }

◆ Format()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

void T2FormatString< Size, TStringTraits >::Format	(	const CharType *	a_szFormat,
			... )

inline

Definition at line 172 of file T2String.h.

    {
        va_list args;
 
        va_start( args, a_szFormat );
        StringTraits::FormatV( m_szBuffer, Size, a_szFormat, args );
        va_end( args );
 
        m_szBuffer[ Size - 1 ] = CharTraits::NullChar;
    }

◆ FormatV()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

void T2FormatString< Size, TStringTraits >::FormatV	(	const CharType *	a_szFormat,
		va_list	a_Args )

inline

Definition at line 183 of file T2String.h.

    {
        StringTraits::FormatV( m_szBuffer, Size, a_szFormat, a_Args );
        m_szBuffer[ Size - 1 ] = CharTraits::NullChar;
    }

◆ Get() [1/4]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

CharType * T2FormatString< Size, TStringTraits >::Get ( )

inlineconstexpr

Definition at line 204 of file T2String.h.

    {
        return m_szBuffer;
    }

◆ Get() [2/4]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

const CharType * T2FormatString< Size, TStringTraits >::Get ( ) const

inlineconstexpr

Definition at line 209 of file T2String.h.

    {
        return m_szBuffer;
    }

◆ Get() [3/4]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

CharType * T2FormatString< Size, TStringTraits >::Get ( TUINT a_uiIndex )

inlineconstexpr

Definition at line 214 of file T2String.h.

    {
        TASSERT( a_uiIndex < Size );
        return &m_szBuffer[ a_uiIndex ];
    }

◆ Get() [4/4]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

const CharType * T2FormatString< Size, TStringTraits >::Get ( TUINT a_uiIndex ) const

inlineconstexpr

Definition at line 220 of file T2String.h.

    {
        TASSERT( a_uiIndex < Size );
        return &m_szBuffer[ a_uiIndex ];
    }

◆ Length()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

TUINT T2FormatString< Size, TStringTraits >::Length ( )

inline

Definition at line 199 of file T2String.h.

    {
        return StringTraits::Length( m_szBuffer );
    }

◆ operator[]() [1/2]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

CharType & T2FormatString< Size, TStringTraits >::operator[] ( TUINT a_uiIndex )

inlineconstexpr

Definition at line 226 of file T2String.h.

    {
        return *Get( a_uiIndex );
    }

◆ operator[]() [2/2]

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

const CharType & T2FormatString< Size, TStringTraits >::operator[] ( TUINT a_uiIndex ) const

inlineconstexpr

Definition at line 231 of file T2String.h.

    {
        return *Get( a_uiIndex );
    }

◆ ParseLine()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

TINT T2FormatString< Size, TStringTraits >::ParseLine	(	const CharType *	a_szString,
		TINT	a_uiSize = -1,
		TINT *	a_pStringLength = nullptr,
		TBOOL	a_bTrimStartSpaces = true,
		TBOOL	a_bTrimEndSpaces = true )

inline

Parses a line from specified buffer and saves it.

Parameters

a_szString	buffer to parse buffer
a_uiSize	size of the a_szString buffer
a_pStringLength	if not TNULL, string length is saved there
a_bTrimSpaces	if TTRUE, removes spaces at the start and at the end

Returns: number of characters to skip in the buffer

Definition at line 119 of file T2String.h.

    {
        TINT  uiPos        = 0;
        TINT  uiStringPos  = 0;
        TBOOL bTextStarted = TFALSE;
 
        if ( a_uiSize == -1 )
            a_uiSize = INT_MAX;
 
        while ( uiPos < Size && uiStringPos < a_uiSize && a_szString[ uiStringPos ] != '\0' )
        {
            if ( a_szString[ uiStringPos ] != '\n' )
            {
                // Trim spaced at the start of the string
                if ( !bTextStarted && a_bTrimStartSpaces )
                {
                    bTextStarted = !CharTraits::IsSpace( (UCharType)a_szString[ uiStringPos ] );
 
                    if ( !bTextStarted )
                    {
                        uiStringPos++;
                        continue;
                    }
                }
 
                m_szBuffer[ uiPos++ ] = a_szString[ uiStringPos++ ];
            }
            else
            {
                break;
            }
        }
 
        uiPos -= 1;
 
        if ( a_bTrimEndSpaces )
        {
            while ( uiPos >= 0 && m_szBuffer[ uiPos ] != '\n' && CharTraits::IsSpace( (UCharType)m_szBuffer[ uiPos ] ) )
            {
                uiPos--;
            }
        }
 
        m_szBuffer[ uiPos + 1 ] = CharTraits::NullChar;
 
        if ( a_pStringLength )
        {
            *a_pStringLength = uiPos + 1;
        }
 
        return uiStringPos + 1;
    }

◆ TSTATICASSERT()

template<TSIZE Size, typename TStringTraits = T2StringTraits<TCHAR>>

T2FormatString< Size, TStringTraits >::TSTATICASSERT	(	Size	,
		0	)

The documentation for this class was generated from the following file:

D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/T2String.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ CharTraits

◆ CharType

◆ StringTraits

◆ UCharType

Constructor & Destructor Documentation

◆ T2FormatString() [1/2]

◆ T2FormatString() [2/2]

Member Function Documentation

◆ Append()

◆ Clear()

◆ Copy()

◆ Format()

◆ FormatV()

◆ Get() [1/4]

◆ Get() [2/4]

◆ Get() [3/4]

◆ Get() [4/4]

◆ Length()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ ParseLine()

◆ TSTATICASSERT()