1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
|
/*
* Copyright (C) 2013-2017 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <functional>
#include <wtf/Deque.h>
#include <wtf/Forward.h>
#include <wtf/TZoneMallocInlines.h>
namespace WebCore {
class SharedBuffer;
class KeyedDecoder {
WTF_MAKE_TZONE_ALLOCATED_INLINE(KeyedDecoder);
public:
WEBCORE_EXPORT static std::unique_ptr<KeyedDecoder> decoder(std::span<const uint8_t> data);
virtual ~KeyedDecoder() = default;
virtual WARN_UNUSED_RETURN bool decodeBytes(const String& key, std::span<const uint8_t>&) = 0;
virtual WARN_UNUSED_RETURN bool decodeBool(const String& key, bool&) = 0;
virtual WARN_UNUSED_RETURN bool decodeUInt32(const String& key, uint32_t&) = 0;
virtual WARN_UNUSED_RETURN bool decodeUInt64(const String& key, uint64_t&) = 0;
virtual WARN_UNUSED_RETURN bool decodeInt32(const String& key, int32_t&) = 0;
virtual WARN_UNUSED_RETURN bool decodeInt64(const String& key, int64_t&) = 0;
virtual WARN_UNUSED_RETURN bool decodeFloat(const String& key, float&) = 0;
virtual WARN_UNUSED_RETURN bool decodeDouble(const String& key, double&) = 0;
virtual WARN_UNUSED_RETURN bool decodeString(const String& key, String&) = 0;
template<typename T> WARN_UNUSED_RETURN
bool decodeBytes(const String& key, Vector<T>& vector)
{
static_assert(sizeof(T) == 1);
std::span<const uint8_t> bytes;
if (!decodeBytes(key, bytes))
return false;
vector = bytes;
return true;
}
template<typename T, typename F> WARN_UNUSED_RETURN
bool decodeEnum(const String& key, T& value, F&& isValidEnumFunction)
{
static_assert(std::is_enum<T>::value, "T must be an enum type");
int64_t intValue;
if (!decodeInt64(key, intValue))
return false;
if (!isValidEnumFunction(static_cast<T>(intValue)))
return false;
value = static_cast<T>(intValue);
return true;
}
template<typename T, typename F> WARN_UNUSED_RETURN
bool decodeObject(const String& key, T& object, F&& function)
{
if (!beginObject(key))
return false;
bool result = function(*this, object);
endObject();
return result;
}
template<typename T, typename F> WARN_UNUSED_RETURN
bool decodeConditionalObject(const String& key, T& object, F&& function)
{
// FIXME: beginObject can return false for two reasons: either the
// key doesn't exist or the key refers to something that isn't an object.
// Because of this, decodeConditionalObject won't distinguish between a
// missing object or a value that isn't an object.
if (!beginObject(key))
return true;
bool result = function(*this, object);
endObject();
return result;
}
template<typename ContainerType, typename F> WARN_UNUSED_RETURN
bool decodeObjects(const String& key, ContainerType& objects, F&& function)
{
if (!beginArray(key))
return false;
bool result = true;
while (beginArrayElement()) {
typename ContainerType::ValueType element;
if (!function(*this, element)) {
result = false;
endArrayElement();
break;
}
objects.append(WTFMove(element));
endArrayElement();
}
endArray();
return result;
}
protected:
KeyedDecoder()
{
}
private:
virtual bool beginObject(const String& key) = 0;
virtual void endObject() = 0;
virtual bool beginArray(const String& key) = 0;
virtual bool beginArrayElement() = 0;
virtual void endArrayElement() = 0;
virtual void endArray() = 0;
};
class KeyedEncoder {
WTF_MAKE_TZONE_ALLOCATED_INLINE(KeyedEncoder);
public:
WEBCORE_EXPORT static std::unique_ptr<KeyedEncoder> encoder();
virtual ~KeyedEncoder() = default;
virtual void encodeBytes(const String& key, std::span<const uint8_t>) = 0;
virtual void encodeBool(const String& key, bool) = 0;
virtual void encodeUInt32(const String& key, uint32_t) = 0;
virtual void encodeUInt64(const String& key, uint64_t) = 0;
virtual void encodeInt32(const String& key, int32_t) = 0;
virtual void encodeInt64(const String& key, int64_t) = 0;
virtual void encodeFloat(const String& key, float) = 0;
virtual void encodeDouble(const String& key, double) = 0;
virtual void encodeString(const String& key, const String&) = 0;
virtual RefPtr<SharedBuffer> finishEncoding() = 0;
template<typename T>
void encodeEnum(const String& key, T value)
{
static_assert(std::is_enum<T>::value, "T must be an enum type");
encodeInt64(key, static_cast<int64_t>(value));
}
template<typename T, typename F>
void encodeObject(const String& key, const T& object, F&& function)
{
beginObject(key);
function(*this, object);
endObject();
}
template<typename T, typename F>
void encodeConditionalObject(const String& key, const T* object, F&& function)
{
if (!object)
return;
encodeObject(key, *object, std::forward<F>(function));
}
template<typename CollectionType, typename F>
void encodeObjects(const String& key, const CollectionType& collection, F&& function)
{
beginArray(key);
for (auto& item : collection) {
beginArrayElement();
function(*this, item);
endArrayElement();
}
endArray();
}
protected:
KeyedEncoder()
{
}
private:
virtual void beginObject(const String& key) = 0;
virtual void endObject() = 0;
virtual void beginArray(const String& key) = 0;
virtual void beginArrayElement() = 0;
virtual void endArrayElement() = 0;
virtual void endArray() = 0;
};
} // namespace WebCore
|