mirror of https://github.com/axmolengine/axmol.git
293 lines
10 KiB
C++
293 lines
10 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2013-2017 Chukong Technologies
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
Copyright (c) 2021 Bytedance Inc.
|
|
|
|
https://axmolengine.github.io/
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#ifndef __cocos2d_libs__CCValue__
|
|
#define __cocos2d_libs__CCValue__
|
|
|
|
#include "platform/CCPlatformMacros.h"
|
|
#include "base/ccMacros.h"
|
|
#include <string>
|
|
#include <vector>
|
|
#include <unordered_map>
|
|
|
|
/**
|
|
* @addtogroup base
|
|
* @{
|
|
*/
|
|
|
|
NS_AX_BEGIN
|
|
|
|
class Value;
|
|
|
|
typedef std::vector<Value> ValueVector;
|
|
typedef hlookup::string_map<Value> ValueMap;
|
|
typedef std::unordered_map<int, Value> ValueMapIntKey;
|
|
|
|
AX_DLL extern const ValueVector ValueVectorNull;
|
|
AX_DLL extern const ValueMap ValueMapNull;
|
|
AX_DLL extern const ValueMapIntKey ValueMapIntKeyNull;
|
|
|
|
/*
|
|
* This class is provide as a wrapper of basic types, such as int and bool.
|
|
*/
|
|
class AX_DLL Value
|
|
{
|
|
public:
|
|
/** A predefined Value that has not value. */
|
|
static const Value Null;
|
|
static const std::string EmptyString;
|
|
|
|
/** Default constructor. */
|
|
Value();
|
|
|
|
/** Create a Value by an unsigned char value. */
|
|
explicit Value(unsigned char v);
|
|
|
|
/** Create a Value by an integer value. */
|
|
explicit Value(int v);
|
|
|
|
/** Create a Value by an unsigned value. */
|
|
explicit Value(unsigned int v);
|
|
|
|
/** Create a Value by an integer value. */
|
|
explicit Value(int64_t v);
|
|
|
|
/** Create a Value by an integer value. */
|
|
explicit Value(uint64_t v);
|
|
|
|
/** Create a Value by a float value. */
|
|
explicit Value(float v);
|
|
|
|
/** Create a Value by a double value. */
|
|
explicit Value(double v);
|
|
|
|
/** Create a Value by a bool value. */
|
|
explicit Value(bool v);
|
|
|
|
/** Create a Value by a char pointer. It will copy the chars internally. */
|
|
explicit Value(const char* v);
|
|
|
|
/** Create a Value by a string. */
|
|
explicit Value(std::string_view v);
|
|
|
|
explicit Value(std::string&& v);
|
|
|
|
/** Create a Value by a ValueVector object. */
|
|
explicit Value(const ValueVector& v);
|
|
/** Create a Value by a ValueVector object. It will use std::move internally. */
|
|
explicit Value(ValueVector&& v);
|
|
|
|
/** Create a Value by a ValueMap object. */
|
|
explicit Value(const ValueMap& v);
|
|
/** Create a Value by a ValueMap object. It will use std::move internally. */
|
|
explicit Value(ValueMap&& v);
|
|
|
|
/** Create a Value by a ValueMapIntKey object. */
|
|
explicit Value(const ValueMapIntKey& v);
|
|
/** Create a Value by a ValueMapIntKey object. It will use std::move internally. */
|
|
explicit Value(ValueMapIntKey&& v);
|
|
|
|
/** Create a Value by another Value object. */
|
|
Value(const Value& other);
|
|
/** Create a Value by a Value object. It will use std::move internally. */
|
|
Value(Value&& other);
|
|
|
|
/** Destructor. */
|
|
~Value();
|
|
|
|
/** Assignment operator, assign from Value to Value. */
|
|
Value& operator=(const Value& other);
|
|
/** Assignment operator, assign from Value to Value. It will use std::move internally. */
|
|
Value& operator=(Value&& other);
|
|
|
|
/** Assignment operator, assign from unsigned char to Value. */
|
|
Value& operator=(unsigned char v);
|
|
/** Assignment operator, assign from integer to Value. */
|
|
Value& operator=(int v);
|
|
/** Assignment operator, assign from integer to Value. */
|
|
Value& operator=(unsigned int v);
|
|
/** Assignment operator, assign from integer to Value. */
|
|
Value& operator=(int64_t v);
|
|
/** Assignment operator, assign from integer to Value. */
|
|
Value& operator=(uint64_t v);
|
|
/** Assignment operator, assign from float to Value. */
|
|
Value& operator=(float v);
|
|
/** Assignment operator, assign from double to Value. */
|
|
Value& operator=(double v);
|
|
/** Assignment operator, assign from bool to Value. */
|
|
Value& operator=(bool v);
|
|
/** Assignment operator, assign from char* to Value. */
|
|
Value& operator=(const char* v);
|
|
/** Assignment operator, assign from string to Value. */
|
|
Value& operator=(std::string_view v);
|
|
Value& operator=(std::string&& v);
|
|
|
|
/** Assignment operator, assign from ValueVector to Value. */
|
|
Value& operator=(const ValueVector& v);
|
|
/** Assignment operator, assign from ValueVector to Value. */
|
|
Value& operator=(ValueVector&& v);
|
|
|
|
/** Assignment operator, assign from ValueMap to Value. */
|
|
Value& operator=(const ValueMap& v);
|
|
/** Assignment operator, assign from ValueMap to Value. It will use std::move internally. */
|
|
Value& operator=(ValueMap&& v);
|
|
|
|
/** Assignment operator, assign from ValueMapIntKey to Value. */
|
|
Value& operator=(const ValueMapIntKey& v);
|
|
/** Assignment operator, assign from ValueMapIntKey to Value. It will use std::move internally. */
|
|
Value& operator=(ValueMapIntKey&& v);
|
|
|
|
/** != operator overloading */
|
|
bool operator!=(const Value& v);
|
|
/** != operator overloading */
|
|
bool operator!=(const Value& v) const;
|
|
/** == operator overloading */
|
|
bool operator==(const Value& v);
|
|
/** == operator overloading */
|
|
bool operator==(const Value& v) const;
|
|
|
|
/** Gets as a byte value. Will convert to unsigned char if possible, or will trigger assert error. */
|
|
unsigned char asByte(unsigned char defaultValue = 0) const;
|
|
/** Gets as an integer value. Will convert to integer if possible, or will trigger assert error. */
|
|
int asInt(int defaultValue = 0) const;
|
|
/** Gets as an unsigned value. Will convert to unsigned if possible, or will trigger assert error. */
|
|
unsigned int asUint(unsigned int defaultValue = 0) const;
|
|
/** Gets as an unsigned value. Will convert to unsigned if possible, or will trigger assert error.
|
|
* !!!DEPRECATED, use asUint instead
|
|
*/
|
|
unsigned int asUnsignedInt(unsigned int defaultValue = 0) const { return asUint(defaultValue); }
|
|
/** Gets as an int64_t value. Will convert to integer if possible, or will trigger assert error. */
|
|
int64_t asInt64(int64_t defaultValue = 0) const;
|
|
/** Gets as an uint64_t value. Will convert to unsigned if possible, or will trigger assert error. */
|
|
uint64_t asUint64(uint64_t defaultValue = 0) const;
|
|
/** Gets as a float value. Will convert to float if possible, or will trigger assert error. */
|
|
float asFloat(float defaultValue = 0.0f) const;
|
|
/** Gets as a double value. Will convert to double if possible, or will trigger assert error. */
|
|
double asDouble(double defaultValue = 0.0) const;
|
|
/** Gets as a bool value. Will convert to bool if possible, or will trigger assert error. */
|
|
bool asBool(bool defaultValue = false) const;
|
|
/** to as a string value. Will convert to string if possible, or will trigger assert error. */
|
|
std::string asString() const;
|
|
|
|
/** Gets as a string value reference without conversion, if value type is not string will return ""sv */
|
|
std::string_view asStringRef() const;
|
|
|
|
/** Gets as a ValueVector reference. Will convert to ValueVector if possible, or will trigger assert error. */
|
|
ValueVector& asValueVector();
|
|
/** Gets as a const ValueVector reference. Will convert to ValueVector if possible, or will trigger assert error. */
|
|
const ValueVector& asValueVector() const;
|
|
|
|
/** Gets as a ValueMap reference. Will convert to ValueMap if possible, or will trigger assert error. */
|
|
ValueMap& asValueMap();
|
|
/** Gets as a const ValueMap reference. Will convert to ValueMap if possible, or will trigger assert error. */
|
|
const ValueMap& asValueMap() const;
|
|
|
|
/** Gets as a ValueMapIntKey reference. Will convert to ValueMapIntKey if possible, or will trigger assert error. */
|
|
ValueMapIntKey& asIntKeyMap();
|
|
/** Gets as a const ValueMapIntKey reference. Will convert to ValueMapIntKey if possible, or will trigger assert
|
|
* error. */
|
|
const ValueMapIntKey& asIntKeyMap() const;
|
|
|
|
/**
|
|
* Checks if the Value is null.
|
|
* @return True if the Value is null, false if not.
|
|
*/
|
|
bool isNull() const { return _type == Type::NONE; }
|
|
|
|
/** Value type wrapped by Value. */
|
|
enum class Type : uint32_t
|
|
{
|
|
/// no value is wrapped, an empty Value
|
|
NONE = 0,
|
|
/// wrap integer
|
|
INTEGER,
|
|
/// wrap float
|
|
FLOAT,
|
|
/// wrap double
|
|
DOUBLE,
|
|
/// wrap bool
|
|
BOOLEAN,
|
|
/// wrap string
|
|
STRING,
|
|
/// wrap vector
|
|
VECTOR,
|
|
/// wrap ValueMap
|
|
MAP,
|
|
/// wrap ValueMapIntKey
|
|
INT_KEY_MAP,
|
|
|
|
MASK_UNSIGNED = 1 << 17,
|
|
MASK_64BIT = 1 << 18,
|
|
INT_I32 = INTEGER,
|
|
INT_UI32 = INTEGER | MASK_UNSIGNED,
|
|
INT_I64 = INTEGER | MASK_64BIT,
|
|
INT_UI64 = INTEGER | MASK_64BIT | MASK_UNSIGNED,
|
|
};
|
|
|
|
/** Gets the value type. */
|
|
Type getType() const { return _type; }
|
|
|
|
/** Gets the value type family. */
|
|
Type getTypeFamily() const { return (Type)((uint32_t)_type & 0xFFFFu); }
|
|
|
|
/** Gets the description of the class. */
|
|
std::string getDescription() const;
|
|
|
|
private:
|
|
void clear();
|
|
void reset(Type type);
|
|
|
|
union
|
|
{
|
|
int intVal;
|
|
unsigned int uintVal;
|
|
int64_t int64Val;
|
|
uint64_t uint64Val;
|
|
float floatVal;
|
|
double doubleVal;
|
|
bool boolVal;
|
|
|
|
std::string* strVal;
|
|
ValueVector* vectorVal;
|
|
ValueMap* mapVal;
|
|
ValueMapIntKey* intKeyMapVal;
|
|
} _field;
|
|
|
|
Type _type;
|
|
};
|
|
|
|
inline const ax::Value& optValue(const ValueMap& dictionary, std::string_view key)
|
|
{
|
|
auto iter = dictionary.find(key);
|
|
return iter != dictionary.cend() ? iter->second : ax::Value::Null;
|
|
}
|
|
|
|
/** @} */
|
|
|
|
NS_AX_END
|
|
|
|
#endif /* defined(__cocos2d_libs__CCValue__) */
|