1/*
2 * Copyright (C) 2010 Google 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef IDBKeyPath_h
27#define IDBKeyPath_h
28
29#if ENABLE(INDEXED_DATABASE)
30
31#include <wtf/Vector.h>
32#include <wtf/text/WTFString.h>
33
34namespace WebCore {
35
36class KeyedDecoder;
37class KeyedEncoder;
38
39enum IDBKeyPathParseError {
40    IDBKeyPathParseErrorNone,
41    IDBKeyPathParseErrorStart,
42    IDBKeyPathParseErrorIdentifier,
43    IDBKeyPathParseErrorDot,
44};
45
46void IDBParseKeyPath(const String&, Vector<String>&, IDBKeyPathParseError&);
47
48class IDBKeyPath {
49public:
50    IDBKeyPath() : m_type(NullType) { }
51    explicit IDBKeyPath(const String&);
52    explicit IDBKeyPath(const Vector<String>& array);
53
54    enum Type {
55        NullType = 0,
56        StringType,
57        ArrayType
58    };
59
60    Type type() const { return m_type; }
61
62    const Vector<String>& array() const
63    {
64        ASSERT(m_type == ArrayType);
65        return m_array;
66    }
67
68    const String& string() const
69    {
70        ASSERT(m_type == StringType);
71        return m_string;
72    }
73
74    bool isNull() const { return m_type == NullType; }
75    bool isValid() const;
76    bool operator==(const IDBKeyPath& other) const;
77
78    IDBKeyPath isolatedCopy() const;
79
80    void encode(KeyedEncoder&) const;
81    static bool decode(KeyedDecoder&, IDBKeyPath&);
82
83private:
84    Type m_type;
85    String m_string;
86    Vector<String> m_array;
87};
88
89} // namespace WebCore
90
91#endif
92
93#endif // IDBKeyPath_h
94