src/core/SkValue.h

/*
 * Copyright 2016 Google Inc.
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#ifndef SkValue_DEFINED
#define SkValue_DEFINED

#include "SkTypes.h"
#include <functional>

class SkData;

class SkValue {
public:
    enum Type : uint32_t {
        // 0-255 are reserved for built-in SkValue types.
        Null,
        Byte , S16 , U16 , S32 , U32 , S64 , U64 , F32 , F64 ,
        Bytes, S16s, U16s, S32s, U32s, S64s, U64s, F32s, F64s,
        Array,

        kMaxBuiltin = 0xFF,
        // 256-2147483647 may be used by Skia for public Object types.

        Matrix,

        ArithmeticXfermode,
        DefaultXfermode,
        LerpXfermode,
        PixelXorXfermode,
        ProcCoeffXfermode,

        kMaxPublicObject = 0x7FFFFFFF,
        // 2147483648+ won't be used by Skia.  They're open for
        // client-specific use, testing, etc.
    };

    // Each Object type may define its own namespace of Key values,
    // so there are no pre-defined Keys here.
    //
    // This is just a reminder that they must fit in a uint32_t,
    // and that their namespace is distinct from other uint32_ts (e.g. Type).
    typedef uint32_t Key;

    SkValue();
    SkValue(const SkValue&);
    SkValue(SkValue&&);

    SkValue& operator=(const SkValue&);
    SkValue& operator=(SkValue&&);

    ~SkValue();

    static SkValue FromS32(int32_t);
    static SkValue FromU32(uint32_t);
    static SkValue FromF32(float);
    static SkValue FromBytes(SkData*);
    static SkValue FromU16s(SkData*);
    static SkValue FromU32s(SkData*);
    static SkValue FromF32s(SkData*);
    static SkValue ValueArray();
    static SkValue Object(Type);

    Type type() const { return fType; }

    // These remaining methods may assert they're called on a value of the appropriate type.

    int32_t  s32() const;
    uint32_t u32() const;
    float    f32() const;
    SkData* bytes() const;

    const uint16_t* u16s(int* count) const;
    const uint32_t* u32s(int* count) const;
    const float*    f32s(int* count) const;

    // Object
    void set(Key, SkValue);
    const SkValue* get(Key) const;
    void foreach(std::function<void(Key, const SkValue&)>) const;

    // Array
    size_t length() const;
    const SkValue& at(size_t) const;
    void append(SkValue);

private:
    class Obj;
    class Arr;

    Type fType;
    union {
        int32_t  fS32;
        uint32_t fU32;
        float    fF32;
        SkData*  fBytes;
        Obj*     fObject;
        Arr*     fArray;
    };

    SkValue(Type);
    bool isObject() const { return fType > kMaxBuiltin; }
    bool isData() const {
        return Bytes == fType
            || U16s == fType
            || U32s == fType
            || F32s == fType;
    }
    template <typename T> static SkValue FromT(SkValue::Type, T SkValue::*, T);
    template <typename T> static SkValue FromTs(SkValue::Type, SkData*);
    template <typename T> const T* asTs(SkValue::Type, int*) const;
};

#endif  // SkValue_DEFINED