Implement encoding of arrays of objects
[WebKit-https.git] / Source / WebCore / platform / KeyedCoding.h
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef KeyedCoding_h
27 #define KeyedCoding_h
28
29 #include <wtf/Forward.h>
30
31 namespace WebCore {
32
33 class KeyedEncoder {
34 protected:
35     virtual ~KeyedEncoder() { }
36
37 public:
38     virtual void encodeBytes(const String& key, const uint8_t*, size_t) = 0;
39     virtual void encodeUInt32(const String& key, uint32_t) = 0;
40     virtual void encodeInt32(const String& key, int32_t) = 0;
41     virtual void encodeInt64(const String& key, int64_t) = 0;
42     virtual void encodeFloat(const String& key, float) = 0;
43     virtual void encodeString(const String& key, const String&) = 0;
44
45     template<typename T, typename F>
46     void encodeObject(const String& key, const T& object, F&& function)
47     {
48         beginObject(key);
49         function(*this, object);
50         endObject();
51     }
52
53     template<typename T, typename F>
54     void encodeConditionalObject(const String& key, const T* object, F&& function)
55     {
56         if (!object)
57             return;
58
59         encodeObject(key, *object, std::forward<F>(function));
60     }
61
62     template<typename T, typename F>
63     void encodeObjects(const String& key, T begin, T end, F&& function)
64     {
65         if (begin == end)
66             return;
67
68         beginArray(key);
69         for (T it = begin; it != end; ++it) {
70             beginArrayElement();
71             function(*this, *it);
72             endArrayElement();
73         }
74         endArray();
75     }
76
77 private:
78     virtual void beginObject(const String& key) = 0;
79     virtual void endObject() = 0;
80
81     virtual void beginArray(const String& key) = 0;
82     virtual void beginArrayElement() = 0;
83     virtual void endArrayElement() = 0;
84     virtual void endArray() = 0;
85 };
86
87 } // namespace WebCore
88
89 #endif // KeyedCoding_h