internal::Stack< Allocator > Class Template Reference

A type-unsafe stack for storing different types of data. More...

#include <stack.h>

Public Member Functions
	Stack (Allocator *allocator, size_t stackCapacity)
	~Stack ()
void	Swap (Stack &rhs) RAPIDJSON_NOEXCEPT
void	Clear ()
void	ShrinkToFit ()
template<typename T >
RAPIDJSON_FORCEINLINE void	Reserve (size_t count=1)
template<typename T >
RAPIDJSON_FORCEINLINE T *	Push (size_t count=1)
template<typename T >
RAPIDJSON_FORCEINLINE T *	PushUnsafe (size_t count=1)
template<typename T >
T *	Pop (size_t count)
template<typename T >
T *	Top ()
template<typename T >
const T *	Top () const
template<typename T >
T *	End ()
template<typename T >
const T *	End () const
template<typename T >
T *	Bottom ()
template<typename T >
const T *	Bottom () const
bool	HasAllocator () const
Allocator &	GetAllocator ()
bool	Empty () const
size_t	GetSize () const
size_t	GetCapacity () const

Private Member Functions
template<typename T >
void	Expand (size_t count)
void	Resize (size_t newCapacity)
void	Destroy ()
	Stack (const Stack &)
Stack &	operator= (const Stack &)

Private Attributes
Allocator *	allocator_
Allocator *	ownAllocator_
char *	stack_
char *	stackTop_
char *	stackEnd_
size_t	initialCapacity_

Detailed Description

template<typename Allocator>
class internal::Stack< Allocator >

A type-unsafe stack for storing different types of data.

Template Parameters

Allocator

Allocator for allocating stack memory.

Definition at line 36 of file stack.h.

Constructor & Destructor Documentation

template<typename Allocator>

internal::Stack< Allocator >::Stack ( Allocator *  allocator, size_t  stackCapacity  )

inline

Definition at line 40 of file stack.h.

                                                      : allocator_(allocator), ownAllocator_(0), stack_(0), stackTop_(0), stackEnd_(0), initialCapacity_(stackCapacity) {
    }

template<typename Allocator>

internal::Stack< Allocator >::~Stack ( )

inline

Definition at line 61 of file stack.h.

             {
        Destroy();
    }

template<typename Allocator>

internal::Stack< Allocator >::Stack ( const Stack< Allocator > &  )

private

Member Function Documentation

template<typename Allocator>

template<typename T >

T* internal::Stack< Allocator >::Bottom ( )

inline

Definition at line 162 of file stack.h.

{ return reinterpret_cast<T*>(stack_); }

template<typename Allocator>

template<typename T >

const T* internal::Stack< Allocator >::Bottom ( ) const

inline

Definition at line 165 of file stack.h.

{ return reinterpret_cast<T*>(stack_); }

template<typename Allocator>

void internal::Stack< Allocator >::Clear ( )

inline

Definition at line 98 of file stack.h.

{ stackTop_ = stack_; }

template<typename Allocator>

void internal::Stack< Allocator >::Destroy ( )

inlineprivate

Definition at line 207 of file stack.h.

                   {
        Allocator::Free(stack_);
        RAPIDJSON_DELETE(ownAllocator_); // Only delete if it is owned by the stack
    }

template<typename Allocator>

bool internal::Stack< Allocator >::Empty ( ) const

inline

Definition at line 176 of file stack.h.

{ return stackTop_ == stack_; }

template<typename Allocator>

template<typename T >

T* internal::Stack< Allocator >::End ( )

inline

Definition at line 156 of file stack.h.

{ return reinterpret_cast<T*>(stackTop_); }

template<typename Allocator>

template<typename T >

const T* internal::Stack< Allocator >::End ( ) const

inline

Definition at line 159 of file stack.h.

{ return reinterpret_cast<T*>(stackTop_); }

template<typename Allocator>

template<typename T >

void internal::Stack< Allocator >::Expand ( size_t  count )

inlineprivate

Definition at line 182 of file stack.h.

                              {
        // Only expand the capacity if the current stack exists. Otherwise just create a stack with initial capacity.
        size_t newCapacity;
        if (stack_ == 0) {
            if (!allocator_)
                ownAllocator_ = allocator_ = RAPIDJSON_NEW(Allocator)();
            newCapacity = initialCapacity_;
        } else {
            newCapacity = GetCapacity();
            newCapacity += (newCapacity + 1) / 2;
        }
        size_t newSize = GetSize() + sizeof(T) * count;
        if (newCapacity < newSize)
            newCapacity = newSize;

        Resize(newCapacity);
    }

template<typename Allocator>

Allocator& internal::Stack< Allocator >::GetAllocator ( )

inline

Definition at line 171 of file stack.h.

                              {
        RAPIDJSON_ASSERT(allocator_);
        return *allocator_;
    }

template<typename Allocator>

size_t internal::Stack< Allocator >::GetCapacity ( ) const

inline

Definition at line 178 of file stack.h.

{ return static_cast<size_t>(stackEnd_ - stack_); }

template<typename Allocator>

size_t internal::Stack< Allocator >::GetSize ( ) const

inline

Definition at line 177 of file stack.h.

{ return static_cast<size_t>(stackTop_ - stack_); }

template<typename Allocator>

bool internal::Stack< Allocator >::HasAllocator ( ) const

inline

Definition at line 167 of file stack.h.

                              {
        return allocator_ != 0;
    }

template<typename Allocator>

Stack& internal::Stack< Allocator >::operator= ( const Stack< Allocator > &  )

private

template<typename Allocator>

template<typename T >

T* internal::Stack< Allocator >::Pop ( size_t  count )

inline

Definition at line 137 of file stack.h.

                         {
        RAPIDJSON_ASSERT(GetSize() >= count * sizeof(T));
        stackTop_ -= count * sizeof(T);
        return reinterpret_cast<T*>(stackTop_);
    }

template<typename Allocator>

template<typename T >

RAPIDJSON_FORCEINLINE T* internal::Stack< Allocator >::Push ( size_t  count = 1 )

inline

Definition at line 122 of file stack.h.

                                                    {
        Reserve<T>(count);
        return PushUnsafe<T>(count);
    }

template<typename Allocator>

template<typename T >

RAPIDJSON_FORCEINLINE T* internal::Stack< Allocator >::PushUnsafe ( size_t  count = 1 )

inline

Definition at line 128 of file stack.h.

                                                          {
        RAPIDJSON_ASSERT(stackTop_);
        RAPIDJSON_ASSERT(stackTop_ + sizeof(T) * count <= stackEnd_);
        T* ret = reinterpret_cast<T*>(stackTop_);
        stackTop_ += sizeof(T) * count;
        return ret;
    }

template<typename Allocator>

template<typename T >

RAPIDJSON_FORCEINLINE void internal::Stack< Allocator >::Reserve ( size_t  count = 1 )

inline

Definition at line 115 of file stack.h.

                                                         {
         // Expand the stack if needed
        if (RAPIDJSON_UNLIKELY(stackTop_ + sizeof(T) * count > stackEnd_))
            Expand<T>(count);
    }

template<typename Allocator>

void internal::Stack< Allocator >::Resize ( size_t  newCapacity )

inlineprivate

Definition at line 200 of file stack.h.

                                    {
        const size_t size = GetSize();  // Backup the current size
        stack_ = static_cast<char*>(allocator_->Realloc(stack_, GetCapacity(), newCapacity));
        stackTop_ = stack_ + size;
        stackEnd_ = stack_ + newCapacity;
    }

template<typename Allocator>

void internal::Stack< Allocator >::ShrinkToFit ( )

inline

Definition at line 100 of file stack.h.

                       { 
        if (Empty()) {
            // If the stack is empty, completely deallocate the memory.
            Allocator::Free(stack_); // NOLINT (+clang-analyzer-unix.Malloc)
            stack_ = 0;
            stackTop_ = 0;
            stackEnd_ = 0;
        }
        else
            Resize(GetSize());
    }

template<typename Allocator>

void internal::Stack< Allocator >::Swap ( Stack< Allocator > &  rhs )

inline

Definition at line 89 of file stack.h.

                                             {
        internal::Swap(allocator_, rhs.allocator_);
        internal::Swap(ownAllocator_, rhs.ownAllocator_);
        internal::Swap(stack_, rhs.stack_);
        internal::Swap(stackTop_, rhs.stackTop_);
        internal::Swap(stackEnd_, rhs.stackEnd_);
        internal::Swap(initialCapacity_, rhs.initialCapacity_);
    }

template<typename Allocator>

template<typename T >

T* internal::Stack< Allocator >::Top ( )

inline

Definition at line 144 of file stack.h.

             { 
        RAPIDJSON_ASSERT(GetSize() >= sizeof(T));
        return reinterpret_cast<T*>(stackTop_ - sizeof(T));
    }

template<typename Allocator>

template<typename T >

const T* internal::Stack< Allocator >::Top ( ) const

inline

Definition at line 150 of file stack.h.

                         {
        RAPIDJSON_ASSERT(GetSize() >= sizeof(T));
        return reinterpret_cast<T*>(stackTop_ - sizeof(T));
    }

Member Data Documentation

template<typename Allocator>

Allocator* internal::Stack< Allocator >::allocator_

private

Definition at line 216 of file stack.h.

template<typename Allocator>

size_t internal::Stack< Allocator >::initialCapacity_

private

Definition at line 221 of file stack.h.

template<typename Allocator>

Allocator* internal::Stack< Allocator >::ownAllocator_

private

Definition at line 217 of file stack.h.

template<typename Allocator>

char* internal::Stack< Allocator >::stack_

private

Definition at line 218 of file stack.h.

template<typename Allocator>

char* internal::Stack< Allocator >::stackEnd_

private

Definition at line 220 of file stack.h.

template<typename Allocator>

char* internal::Stack< Allocator >::stackTop_

private

Definition at line 219 of file stack.h.

---

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

• art/rapidjson/internal/stack.h