#include <PTRB.h>

Classes
class	Ptr

struct	RelcPtr

Public Member Functions
	MemoryStream (TUINT32 index, Endianess eEndianess)

	MemoryStream (const MemoryStream &other)

	~MemoryStream ()

TUINT	Tell ()

void	Seek (TUINT newPos)

TUINT32	SetIndex (TUINT32 index)

void	SetExpectedSize (TUINT32 expectedSize)

TUINT32	GetExpectedSize () const

TUINT32	GetIndex () const

TUINT	GetPointerCount () const

TCHAR *	GetBuffer () const

TCHAR *	GetBufferPos () const

TUINT	GetBufferSize () const

TUINT	GetUsedSize () const

TUINT	GetOffset (const void *ptr) const

template<class T>
void	SetCrossPointer (T **outPtr, Ptr< T > ptr)

template<class T>
T *	Write (TUINT offset, const T &value)

void	Write (TUINT offset, TCHAR *value, TINT size)

template<class T>
Ptr< T >	Alloc ()

template<class T>
Ptr< T >	Alloc (TUINT count)

Ptr< TCHAR >	AllocBytes (TUINT Size)

template<class T>
void	WritePointer (T *outPtr, const T ptr)

template<class T>
void	WritePointer (T **outPtr, const Ptr< T > &ptr)

template<class T>
Ptr< T >	Alloc (T **outPtr, TUINT count)

template<class T, TUINT Count = 1>
Ptr< T >	Alloc (T **outPtr)

void	Link ()

void	Unlink ()

std::vector< RelcPtr >::iterator	begin ()

std::vector< RelcPtr >::iterator	end ()

void	GrowBuffer (TUINT requiredSize)

Public Attributes
friend	PTRBSections

friend	PTRBSymbols

friend	PTRBRelocations

Static Public Attributes
static constexpr TUINT	BUFFER_GROW_SIZE = 4096

Detailed Description

Definition at line 56 of file PTRB.h.

Constructor & Destructor Documentation

◆ MemoryStream() [1/2]

PTRBSections::MemoryStream::MemoryStream	(	TUINT32	index,
		Endianess	eEndianess )

inline

Definition at line 140 of file PTRB.h.

        {
            m_Index        = index;
            m_eEndianess   = eEndianess;
            m_Buffer       = TNULL;
            m_BufferPos    = TNULL;
            m_BufferSize   = 0;
            m_ExpectedSize = 0;
            m_PtrList.reserve( 32 );
            GrowBuffer( 0 );
        }

◆ MemoryStream() [2/2]

PTRBSections::MemoryStream::MemoryStream ( const MemoryStream & other )

inline

Definition at line 152 of file PTRB.h.

        {
            TASSERT( other.m_DependentStacks.size() == 0, "Cross pointers are not supported" );
 
            m_Index        = other.m_Index;
            m_eEndianess   = other.m_eEndianess;
            m_Buffer       = TNULL;
            m_BufferSize   = 0;
            m_ExpectedSize = other.m_ExpectedSize;
            Resize( other.m_BufferSize );
            m_BufferPos = m_Buffer + other.GetUsedSize();
            Toshi::TUtil::MemCopy( m_Buffer, other.m_Buffer, other.GetUsedSize() );
 
            m_PtrList.reserve( other.m_PtrList.size() );
            for ( TUINT i = 0; i < other.m_PtrList.size(); i++ )
            {
                m_PtrList.emplace_back(
                    other.m_PtrList[ i ].Offset,
                    other.m_PtrList[ i ].DataPtr,
                    this // TODO: support cross pointers
                );
            }
        }

◆ ~MemoryStream()

PTRBSections::MemoryStream::~MemoryStream ( )

inline

Definition at line 176 of file PTRB.h.

        {
            if ( m_Buffer != TNULL )
            {
                delete[] m_Buffer;
            }
        }

Member Function Documentation

◆ Alloc() [1/4]

template<class T>

PTRBSections::MemoryStream::Ptr< T > PTRBSections::MemoryStream::Alloc ( )

inline

Definition at line 861 of file PTRB.h.

{
    m_BufferPos = TREINTERPRETCAST( TCHAR*, TAlignPointerUp( m_BufferPos ) );
 
    constexpr TUINT TSize = sizeof( T );
    GrowBuffer( GetUsedSize() + TSize );
 
    T* allocated = TREINTERPRETCAST( T*, m_BufferPos );
    m_BufferPos += TSize;
 
    return { this, allocated };
}

◆ Alloc() [2/4]

template<class T, TUINT Count = 1>

PTRBSections::MemoryStream::Ptr< T > PTRBSections::MemoryStream::Alloc ( T ** outPtr )

inline

Definition at line 908 of file PTRB.h.

{
    TASSERT( (TUINT)outPtr >= (TUINT)m_Buffer && (TUINT)outPtr < (TUINT)m_Buffer + (TUINT)m_BufferSize, "Out pointer is out of buffer" );
    m_BufferPos = TREINTERPRETCAST( TCHAR*, TAlignPointerUp( m_BufferPos ) );
 
    constexpr TUINT TSize        = sizeof( T ) * Count;
    TUINT           outPtrOffset = GetOffset( outPtr );
    GrowBuffer( GetUsedSize() + TSize );
 
    T* allocated = TREINTERPRETCAST( T*, m_BufferPos );
    m_BufferPos += TSize;
 
    Write<T*>( outPtrOffset, allocated );
    AddRelocationPtr( outPtrOffset, CONVERTENDIANESS( m_eEndianess, GetOffset( allocated ) ) );
 
    return { this, allocated };
}

◆ Alloc() [3/4]

template<class T>

PTRBSections::MemoryStream::Ptr< T > PTRBSections::MemoryStream::Alloc	(	T **	outPtr,
		TUINT	count )

inline

Definition at line 889 of file PTRB.h.

{
    TASSERT( (TUINT)outPtr >= (TUINT)m_Buffer && (TUINT)outPtr < (TUINT)m_Buffer + (TUINT)m_BufferSize, "Out pointer is out of buffer" );
    m_BufferPos = TREINTERPRETCAST( TCHAR*, TAlignPointerUp( m_BufferPos ) );
 
    const TUINT TSize        = sizeof( T ) * count;
    TUINT       outPtrOffset = GetOffset( outPtr );
    GrowBuffer( GetUsedSize() + TSize );
 
    T* allocated = TREINTERPRETCAST( T*, m_BufferPos );
    m_BufferPos += TSize;
 
    Write<T*>( outPtrOffset, allocated );
    AddRelocationPtr( outPtrOffset, CONVERTENDIANESS( m_eEndianess, GetOffset( allocated ) ) );
 
    return { this, allocated };
}

◆ Alloc() [4/4]

template<class T>

PTRBSections::MemoryStream::Ptr< T > PTRBSections::MemoryStream::Alloc ( TUINT count )

inline

Definition at line 875 of file PTRB.h.

{
    m_BufferPos = TREINTERPRETCAST( TCHAR*, TAlignPointerUp( m_BufferPos ) );
 
    const TUINT TSize = sizeof( T ) * count;
    GrowBuffer( GetUsedSize() + TSize );
 
    T* allocated = TREINTERPRETCAST( T*, m_BufferPos );
    m_BufferPos += TSize;
 
    return { this, allocated };
}

◆ AllocBytes()

PTRBSections::MemoryStream::Ptr< TCHAR > PTRBSections::MemoryStream::AllocBytes ( TUINT Size )

inline

Definition at line 947 of file PTRB.h.

{
    GrowBuffer( GetUsedSize() + Size );
 
    TCHAR* allocated = reinterpret_cast<TCHAR*>( m_BufferPos );
    m_BufferPos += Size;
 
    return { this, allocated };
}

◆ begin()

std::vector< RelcPtr >::iterator PTRBSections::MemoryStream::begin ( )

inline

Definition at line 261 of file PTRB.h.

261{ return m_PtrList.begin(); }

◆ end()

std::vector< RelcPtr >::iterator PTRBSections::MemoryStream::end ( )

inline

Definition at line 262 of file PTRB.h.

262{ return m_PtrList.end(); }

◆ GetBuffer()

TCHAR * PTRBSections::MemoryStream::GetBuffer ( ) const

inline

Definition at line 207 of file PTRB.h.

207{ return m_Buffer; }

◆ GetBufferPos()

TCHAR * PTRBSections::MemoryStream::GetBufferPos ( ) const

inline

Definition at line 209 of file PTRB.h.

209{ return m_BufferPos; }

◆ GetBufferSize()

TUINT PTRBSections::MemoryStream::GetBufferSize ( ) const

inline

Definition at line 211 of file PTRB.h.

211{ return m_BufferSize; }

◆ GetExpectedSize()

TUINT32 PTRBSections::MemoryStream::GetExpectedSize ( ) const

inline

Definition at line 201 of file PTRB.h.

201{ return m_ExpectedSize; }

◆ GetIndex()

TUINT32 PTRBSections::MemoryStream::GetIndex ( ) const

inline

Definition at line 203 of file PTRB.h.

203{ return m_Index; }

◆ GetOffset()

TUINT PTRBSections::MemoryStream::GetOffset ( const void * ptr ) const

inline

Definition at line 215 of file PTRB.h.

        {
            TASSERT( (TUINT)ptr >= (TUINT)m_Buffer && (TUINT)ptr < (TUINT)m_Buffer + m_BufferSize, "Pointer is out of buffer" );
            return (TUINT)ptr - (TUINT)m_Buffer;
        }

◆ GetPointerCount()

TUINT PTRBSections::MemoryStream::GetPointerCount ( ) const

inline

Definition at line 205 of file PTRB.h.

205{ return m_PtrList.size(); }

◆ GetUsedSize()

TUINT PTRBSections::MemoryStream::GetUsedSize ( ) const

inline

Definition at line 213 of file PTRB.h.

213{ return (TUINT)m_BufferPos - (TUINT)m_Buffer; }

◆ GrowBuffer()

void PTRBSections::MemoryStream::GrowBuffer ( TUINT requiredSize )

inline

Definition at line 973 of file PTRB.h.

{
    TUINT newSize = ( ( requiredSize / BUFFER_GROW_SIZE ) + 1 ) * BUFFER_GROW_SIZE;
 
    if ( newSize != m_BufferSize )
    {
        Resize( newSize );
    }
}

◆ Link()

void PTRBSections::MemoryStream::Link ( )

inline

Definition at line 957 of file PTRB.h.

{
    for ( auto& ptr : m_PtrList )
    {
        Write<void*>( ptr.Offset, ptr.DataStack->GetBuffer() + CONVERTENDIANESS( m_eEndianess, ptr.DataPtr ) );
    }
}

◆ Seek()

void PTRBSections::MemoryStream::Seek ( TUINT newPos )

inline

Definition at line 186 of file PTRB.h.

        {
            TASSERT( newPos < m_BufferSize, "Trying to seek out of buffer" );
            m_BufferPos = m_Buffer + newPos;
        }

◆ SetCrossPointer()

template<class T>

void PTRBSections::MemoryStream::SetCrossPointer	(	T **	outPtr,
		Ptr< T >	ptr )

inline

Definition at line 838 of file PTRB.h.

{
    TASSERT( (TUINT)outPtr >= (TUINT)m_Buffer && (TUINT)outPtr < (TUINT)m_Buffer + (TUINT)m_BufferSize, "Out pointer is out of buffer" );
    TASSERT( TNULL != ptr.stack() );
    TASSERT( this != ptr.stack() );
 
    TUINT outPtrOffset = GetOffset( outPtr );
    Write<T*>( outPtrOffset, ptr.get() );
 
    AddRelocationPtr( outPtrOffset, ptr.offset(), ptr.stack() );
 
    // Set current stack as dependent from ptr.stack()
    auto crossStack = ptr.stack();
    auto it         = std::find( crossStack->m_DependentStacks.begin(), crossStack->m_DependentStacks.end(), this );
 
    if ( it == crossStack->m_DependentStacks.end() )
    {
        // Add this stack
        crossStack->m_DependentStacks.push_back( this );
    }
}

◆ SetExpectedSize()

void PTRBSections::MemoryStream::SetExpectedSize ( TUINT32 expectedSize )

inline

Definition at line 199 of file PTRB.h.

199{ m_ExpectedSize = expectedSize; }

◆ SetIndex()

TUINT32 PTRBSections::MemoryStream::SetIndex ( TUINT32 index )

inline

Definition at line 192 of file PTRB.h.

        {
            TUINT32 oldIndex = m_Index;
            m_Index          = index;
            return oldIndex;
        }

◆ Tell()

TUINT PTRBSections::MemoryStream::Tell ( )

inline

Definition at line 184 of file PTRB.h.

184{ return GetUsedSize(); }

◆ Unlink()

void PTRBSections::MemoryStream::Unlink ( )

inline

Definition at line 965 of file PTRB.h.

{
    for ( auto& ptr : m_PtrList )
    {
        Write<void*>( ptr.Offset, (void*)ptr.DataPtr );
    }
}

◆ Write() [1/2]

template<class T>

T * PTRBSections::MemoryStream::Write	(	TUINT	offset,
		const T &	value )

inline

Definition at line 225 of file PTRB.h.

        {
            TASSERT( offset >= 0 && offset < m_BufferSize, "Offset is out of buffer" );
            *(T*)( &m_Buffer[ offset ] ) = value;
            return TREINTERPRETCAST( T*, &m_Buffer[ offset ] );
        }

◆ Write() [2/2]

void PTRBSections::MemoryStream::Write	(	TUINT	offset,
		TCHAR *	value,
		TINT	size )

inline

Definition at line 232 of file PTRB.h.

        {
            TASSERT( offset >= 0 && offset < m_BufferSize, "Offset is out of buffer" );
            Toshi::TUtil::MemCopy( &m_Buffer[ offset ], value, size );
        }

◆ WritePointer() [1/2]

template<class T>

void PTRBSections::MemoryStream::WritePointer	(	T **	outPtr,
		const Ptr< T > &	ptr )

inline

Definition at line 938 of file PTRB.h.

{
    TASSERT( (TUINT)outPtr >= (TUINT)m_Buffer && (TUINT)outPtr < (TUINT)m_Buffer + (TUINT)m_BufferSize, "Out pointer is out of buffer" );
 
    TUINT outPtrOffset = GetOffset( outPtr );
    Write<TUINT32>( outPtrOffset, TREINTERPRETCAST( TUINT32, ptr.get() ) );
    AddRelocationPtr( outPtrOffset, CONVERTENDIANESS( m_eEndianess, ptr.offset() ) );
}

◆ WritePointer() [2/2]

template<class T>

void PTRBSections::MemoryStream::WritePointer	(	T **	outPtr,
		const T *	ptr )

inline

Definition at line 927 of file PTRB.h.

{
    TASSERT( (TUINT)outPtr >= (TUINT)m_Buffer && (TUINT)outPtr < (TUINT)m_Buffer + (TUINT)m_BufferSize, "Out pointer is out of buffer" );
    TASSERT( (TUINT)ptr >= (TUINT)m_Buffer && (TUINT)ptr < (TUINT)m_Buffer + (TUINT)m_BufferSize, "Pointer is out of buffer" );
 
    TUINT outPtrOffset = GetOffset( outPtr );
    Write<TUINT32>( outPtrOffset, TREINTERPRETCAST( TUINT32, ptr ) );
    AddRelocationPtr( outPtrOffset, CONVERTENDIANESS( m_eEndianess, GetOffset( ptr ) ) );
}

Member Data Documentation

◆ BUFFER_GROW_SIZE

TUINT PTRBSections::MemoryStream::BUFFER_GROW_SIZE = 4096

staticconstexpr

Definition at line 63 of file PTRB.h.

◆ PTRBRelocations

friend PTRBSections::MemoryStream::PTRBRelocations

Definition at line 61 of file PTRB.h.

◆ PTRBSections

friend PTRBSections::MemoryStream::PTRBSections

Definition at line 59 of file PTRB.h.

◆ PTRBSymbols

friend PTRBSections::MemoryStream::PTRBSymbols

Definition at line 60 of file PTRB.h.

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

D:/_dev/OpenBarnyard/Source/Toshi/Source/Plugins/PTRB.h

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MemoryStream() [1/2]

◆ MemoryStream() [2/2]

◆ ~MemoryStream()

Member Function Documentation

◆ Alloc() [1/4]

◆ Alloc() [2/4]

◆ Alloc() [3/4]

◆ Alloc() [4/4]

◆ AllocBytes()

◆ begin()

◆ end()

◆ GetBuffer()

◆ GetBufferPos()

◆ GetBufferSize()

◆ GetExpectedSize()

◆ GetIndex()

◆ GetOffset()

◆ GetPointerCount()

◆ GetUsedSize()

◆ GrowBuffer()

◆ Link()

◆ Seek()

◆ SetCrossPointer()

◆ SetExpectedSize()

◆ SetIndex()

◆ Tell()

◆ Unlink()

◆ Write() [1/2]

◆ Write() [2/2]

◆ WritePointer() [1/2]

◆ WritePointer() [2/2]

Member Data Documentation

◆ BUFFER_GROW_SIZE

◆ PTRBRelocations

◆ PTRBSections

◆ PTRBSymbols