SkMetaData Class Reference

#include <SkMetaData.h>

Classes
class	Iter
struct	Rec

Public Types
enum	Type {   kS32_Type , kScalar_Type , kPtr_Type , kBool_Type ,   kTypeCount }

Public Member Functions
	SkMetaData ()
	~SkMetaData ()
void	reset ()
bool	findS32 (const char name[], int32_t *value=nullptr) const
bool	findScalar (const char name[], SkScalar *value=nullptr) const
const SkScalar *	findScalars (const char name[], int *count, SkScalar values[]=nullptr) const
bool	findPtr (const char name[], void **value=nullptr) const
bool	findBool (const char name[], bool *value=nullptr) const
bool	hasS32 (const char name[], int32_t value) const
bool	hasScalar (const char name[], SkScalar value) const
bool	hasPtr (const char name[], void *value) const
bool	hasBool (const char name[], bool value) const
void	setS32 (const char name[], int32_t value)
void	setScalar (const char name[], SkScalar value)
SkScalar *	setScalars (const char name[], int count, const SkScalar values[]=nullptr)
void	setPtr (const char name[], void *value)
void	setBool (const char name[], bool value)
bool	removeS32 (const char name[])
bool	removeScalar (const char name[])
bool	removePtr (const char name[])
bool	removeBool (const char name[])
const Rec *	find (const char name[], Type) const
void *	set (const char name[], const void *data, size_t len, Type, int count)
bool	remove (const char name[], Type)
	SkMetaData (const SkMetaData &)=delete
SkMetaData &	operator= (const SkMetaData &)=delete

Public Attributes
Rec *	fRec = nullptr

Friends
class	Iter

Detailed Description

A map from c-string keys to arrays of POD (int32_t, kScalar, void*, or bool) values.

Definition at line 15 of file SkMetaData.h.

Member Enumeration Documentation

Type

enum SkMetaData::Type

Enumerator
kS32_Type
kScalar_Type
kPtr_Type
kBool_Type
kTypeCount

Definition at line 56 of file SkMetaData.h.

              {
        kS32_Type,
        kScalar_Type,
        kPtr_Type,
        kBool_Type,
 
        kTypeCount
    };

Constructor & Destructor Documentation

SkMetaData() [1/2]

SkMetaData::SkMetaData ( )

inline

Definition at line 17 of file SkMetaData.h.

{}

~SkMetaData()

SkMetaData::~SkMetaData ( )

inline

Definition at line 18 of file SkMetaData.h.

{ if (fRec) { this->reset(); } }

SkMetaData() [2/2]

SkMetaData::SkMetaData ( const SkMetaData &  )

delete

Member Function Documentation

find()

const SkMetaData::Rec * SkMetaData::find	(	const char	name[],
		Type	type
	)		const

Definition at line 174 of file SkMetaData.cpp.

                                                                        {
    return this->findWithPrev(name, type).rec;
}

findBool()

bool SkMetaData::findBool	(	const char	name[],
		bool *	value = nullptr
	)		const

Definition at line 149 of file SkMetaData.cpp.

{
    const Rec* rec = this->find(name, kBool_Type);
    if (rec)
    {
        SkASSERT(rec->fDataCount == 1);
        if (value)
            *value = *(const bool*)rec->data();
        return true;
    }
    return false;
}

findPtr()

bool SkMetaData::findPtr	(	const char	name[],
		void **	value = nullptr
	)		const

Definition at line 136 of file SkMetaData.cpp.

                                                            {
    const Rec* rec = this->find(name, kPtr_Type);
    if (rec) {
        SkASSERT(rec->fDataCount == 1);
        void* const* found = (void* const*)rec->data();
        if (ptr) {
            *ptr = *found;
        }
        return true;
    }
    return false;
}

findS32()

bool SkMetaData::findS32	(	const char	name[],
		int32_t *	value = nullptr
	)		const

Definition at line 96 of file SkMetaData.cpp.

{
    const Rec* rec = this->find(name, kS32_Type);
    if (rec)
    {
        SkASSERT(rec->fDataCount == 1);
        if (value)
            *value = *(const int32_t*)rec->data();
        return true;
    }
    return false;
}

findScalar()

bool SkMetaData::findScalar	(	const char	name[],
		SkScalar *	value = nullptr
	)		const

Definition at line 109 of file SkMetaData.cpp.

{
    const Rec* rec = this->find(name, kScalar_Type);
    if (rec)
    {
        SkASSERT(rec->fDataCount == 1);
        if (value)
            *value = *(const SkScalar*)rec->data();
        return true;
    }
    return false;
}

findScalars()

const SkScalar * SkMetaData::findScalars	(	const char	name[],
		int *	count,
		SkScalar	values[] = nullptr
	)		const

Definition at line 122 of file SkMetaData.cpp.

{
    const Rec* rec = this->find(name, kScalar_Type);
    if (rec)
    {
        if (count)
            *count = rec->fDataCount;
        if (values)
            memcpy(values, rec->data(), rec->fDataCount * rec->fDataLen);
        return (const SkScalar*)rec->data();
    }
    return nullptr;
}

hasBool()

bool SkMetaData::hasBool ( const char  name[], bool  value  ) const

inline

Definition at line 40 of file SkMetaData.h.

                                                      {
        bool    v;
        return this->findBool(name, &v) && v == value;
    }

hasPtr()

bool SkMetaData::hasPtr ( const char  name[], void *  value  ) const

inline

Definition at line 36 of file SkMetaData.h.

                                                      {
        void* v;
        return this->findPtr(name, &v) && v == value;
    }

hasS32()

bool SkMetaData::hasS32 ( const char  name[], int32_t  value  ) const

inline

Definition at line 28 of file SkMetaData.h.

                                                        {
        int32_t v;
        return this->findS32(name, &v) && v == value;
    }

hasScalar()

bool SkMetaData::hasScalar ( const char  name[], SkScalar  value  ) const

inline

Definition at line 32 of file SkMetaData.h.

                                                            {
        SkScalar v;
        return this->findScalar(name, &v) && v == value;
    }

operator=()

SkMetaData & SkMetaData::operator= ( const SkMetaData &  )

delete

remove()

bool SkMetaData::remove	(	const char	name[],
		Type	type
	)

Definition at line 188 of file SkMetaData.cpp.

                                                    {
    FindResult result = this->findWithPrev(name, type);
    if (!result.rec) {
        return false;
    }
    this->remove(result);
    return true;
}

removeBool()

bool SkMetaData::removeBool

(

const char

name[]

)

Definition at line 212 of file SkMetaData.cpp.

{
    return this->remove(name, kBool_Type);
}

removePtr()

bool SkMetaData::removePtr

(

const char

name[]

)

Definition at line 207 of file SkMetaData.cpp.

{
    return this->remove(name, kPtr_Type);
}

removeS32()

bool SkMetaData::removeS32

(

const char

name[]

)

Definition at line 197 of file SkMetaData.cpp.

{
    return this->remove(name, kS32_Type);
}

removeScalar()

bool SkMetaData::removeScalar

(

const char

name[]

)

Definition at line 202 of file SkMetaData.cpp.

{
    return this->remove(name, kScalar_Type);
}

reset()

void SkMetaData::reset

(

)

Definition at line 13 of file SkMetaData.cpp.

{
    Rec* rec = fRec;
    while (rec) {
        Rec* next = rec->fNext;
        Rec::Free(rec);
        rec = next;
    }
    fRec = nullptr;
}

set()

void * SkMetaData::set	(	const char	name[],
		const void *	data,
		size_t	len,
		Type	type,
		int	count
	)

Definition at line 51 of file SkMetaData.cpp.

{
    SkASSERT(name);
    SkASSERT(dataSize);
    SkASSERT(count > 0);
 
    FindResult result = this->findWithPrev(name, type);
 
    Rec* rec;
    bool reuseRec = result.rec &&
                    result.rec->fDataLen == dataSize &&
                    result.rec->fDataCount == count;
    if (reuseRec) {
        rec = result.rec;
    } else {
        size_t len = strlen(name);
        rec = Rec::Alloc(sizeof(Rec) + dataSize * count + len + 1);
        rec->fType = SkToU8(type);
        rec->fDataLen = SkToU8(dataSize);
        rec->fDataCount = SkToU16(count);
 
        memcpy(rec->name(), name, len + 1);
    }
    if (data) {
        memcpy(rec->data(), data, dataSize * count);
    }
 
    if (reuseRec) {
        // Do nothing, reused
    } else if (result.rec) {
        // Had one, but had to create a new one. Invalidates iterators.
        // Delayed removal since name or data may have been in the result.rec.
        this->remove(result);
        if (result.prev) {
            rec->fNext = result.prev->fNext;
            result.prev->fNext = rec;
        }
    } else {
        // Adding a new one, stick it at head.
        rec->fNext = fRec;
        fRec = rec;
    }
    return rec->data();
}

setBool()

void SkMetaData::setBool	(	const char	name[],
		bool	value
	)

Definition at line 46 of file SkMetaData.cpp.

{
    (void)this->set(name, &value, sizeof(bool), kBool_Type, 1);
}

setPtr()

void SkMetaData::setPtr	(	const char	name[],
		void *	value
	)

Definition at line 42 of file SkMetaData.cpp.

                                                    {
    (void)this->set(name, &ptr, sizeof(void*), kPtr_Type, 1);
}

setS32()

void SkMetaData::setS32	(	const char	name[],
		int32_t	value
	)

Definition at line 24 of file SkMetaData.cpp.

{
    (void)this->set(name, &value, sizeof(int32_t), kS32_Type, 1);
}

setScalar()

void SkMetaData::setScalar	(	const char	name[],
		SkScalar	value
	)

Definition at line 29 of file SkMetaData.cpp.

{
    (void)this->set(name, &value, sizeof(SkScalar), kScalar_Type, 1);
}

setScalars()

SkScalar * SkMetaData::setScalars	(	const char	name[],
		int	count,
		const SkScalar	values[] = nullptr
	)

Definition at line 34 of file SkMetaData.cpp.

{
    SkASSERT(count > 0);
    if (count > 0)
        return (SkScalar*)this->set(name, values, sizeof(SkScalar), kScalar_Type, count);
    return nullptr;
}

Friends And Related Function Documentation

Iter

friend class Iter

friend

Definition at line 67 of file SkMetaData.h.

Member Data Documentation

fRec

Rec* SkMetaData::fRec = nullptr

Definition at line 105 of file SkMetaData.h.

---

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

• third_party/skia/tools/SkMetaData.h
• third_party/skia/tools/SkMetaData.cpp