SkAutoMalloc Class Reference

#include <SkAutoMalloc.h>

Inheritance diagram for SkAutoMalloc:

Public Types
enum	OnShrink { kAlloc_OnShrink , kReuse_OnShrink }

Public Member Functions
	SkAutoMalloc (size_t size=0)
void *	reset (size_t size=0, OnShrink shrink=kAlloc_OnShrink)
void *	get ()
const void *	get () const
void *	release ()

Detailed Description

Manage an allocated block of heap memory. This object is the sole manager of the lifetime of the block, so the caller must not call sk_free() or delete on the block, unless release() was called.

Definition at line 25 of file SkAutoMalloc.h.

Member Enumeration Documentation

OnShrink

enum SkAutoMalloc::OnShrink

Passed to reset to specify what happens if the requested size is smaller than the current size (and the current block was dynamically allocated).

Enumerator
kAlloc_OnShrink	If the requested size is smaller than the current size, and the current block is dynamically allocated, free the old block and malloc a new block of the smaller size.
kReuse_OnShrink	If the requested size is smaller than the current size, and the current block is dynamically allocated, just return the old block.

Definition at line 34 of file SkAutoMalloc.h.

                  {
        /**
         *  If the requested size is smaller than the current size, and the
         *  current block is dynamically allocated, free the old block and
         *  malloc a new block of the smaller size.
         */
        kAlloc_OnShrink,
 
        /**
         *  If the requested size is smaller than the current size, and the
         *  current block is dynamically allocated, just return the old
         *  block.
         */
        kReuse_OnShrink
    };

Constructor & Destructor Documentation

SkAutoMalloc()

SkAutoMalloc::SkAutoMalloc ( size_t  size = 0 )

inlineexplicit

Definition at line 27 of file SkAutoMalloc.h.

        : fPtr(size ? sk_malloc_throw(size) : nullptr), fSize(size) {}

Member Function Documentation

get() [1/2]

void * SkAutoMalloc::get ( )

inline

Return the allocated block.

Definition at line 64 of file SkAutoMalloc.h.

{ return fPtr.get(); }

get() [2/2]

const void * SkAutoMalloc::get ( ) const

inline

Definition at line 65 of file SkAutoMalloc.h.

{ return fPtr.get(); }

release()

void * SkAutoMalloc::release ( )

inline

Transfer ownership of the current ptr to the caller, setting the internal reference to null. Note the caller is reponsible for calling sk_free on the returned address.

Definition at line 71 of file SkAutoMalloc.h.

                    {
        fSize = 0;
        return fPtr.release();
    }

reset()

void * SkAutoMalloc::reset ( size_t  size = 0, OnShrink  shrink = kAlloc_OnShrink  )

inline

Reallocates the block to a new size. The ptr may or may not change.

Definition at line 53 of file SkAutoMalloc.h.

                                                                    {
        if (size != fSize && (size > fSize || kReuse_OnShrink != shrink)) {
            fPtr.reset(size ? sk_malloc_throw(size) : nullptr);
            fSize = size;
        }
        return fPtr.get();
    }

---

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

• third_party/skia/src/base/SkAutoMalloc.h