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
36enum IDBKeyPathParseError {
37    IDBKeyPathParseErrorNone,
38    IDBKeyPathParseErrorStart,
39    IDBKeyPathParseErrorIdentifier,
40    IDBKeyPathParseErrorDot,
41};
42
43void IDBParseKeyPath(const String&, Vector<String>&, IDBKeyPathParseError&);
44
45class IDBKeyPath {
46public:
47    IDBKeyPath() : m_type(NullType) { }
48    explicit IDBKeyPath(const String&);
49    explicit IDBKeyPath(const Vector<String>& array);
50
51    enum Type {
52        NullType = 0,
53        StringType,
54        ArrayType
55    };
56
57    Type type() const { return m_type; }
58
59    const Vector<String>& array() const
60    {
61        ASSERT(m_type == ArrayType);
62        return m_array;
63    }
64
65    const String& string() const
66    {
67        ASSERT(m_type == StringType);
68        return m_string;
69    }
70
71    bool isNull() const { return m_type == NullType; }
72    bool isValid() const;
73    bool operator==(const IDBKeyPath& other) const;
74
75private:
76    Type m_type;
77    String m_string;
78    Vector<String> m_array;
79};
80
81} // namespace WebCore
82
83#endif
84
85#endif // IDBKeyPath_h
86