1/*
2 * Copyright (C) 2011 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 WebIDBKey_h
27#define WebIDBKey_h
28
29#include "WebCommon.h"
30#include "WebIDBTypes.h"
31#include "WebPrivatePtr.h"
32#include "WebString.h"
33#include "WebVector.h"
34
35namespace WebCore { class IDBKey; }
36
37namespace WebKit {
38
39class WebIDBKey {
40public:
41    // Please use one of the factory methods. This is public only to allow WebVector.
42    WebIDBKey() { }
43    ~WebIDBKey() { reset(); }
44
45    WEBKIT_EXPORT static WebIDBKey createArray(const WebVector<WebIDBKey>&);
46    WEBKIT_EXPORT static WebIDBKey createString(const WebString&);
47    WEBKIT_EXPORT static WebIDBKey createDate(double);
48    WEBKIT_EXPORT static WebIDBKey createNumber(double);
49    WEBKIT_EXPORT static WebIDBKey createInvalid();
50    WEBKIT_EXPORT static WebIDBKey createNull();
51
52    WebIDBKey(const WebIDBKey& e) { assign(e); }
53    WebIDBKey& operator=(const WebIDBKey& e)
54    {
55        assign(e);
56        return *this;
57    }
58
59    WEBKIT_EXPORT void assign(const WebIDBKey&);
60    WEBKIT_EXPORT void assignArray(const WebVector<WebIDBKey>&);
61    WEBKIT_EXPORT void assignString(const WebString&);
62    WEBKIT_EXPORT void assignDate(double);
63    WEBKIT_EXPORT void assignNumber(double);
64    WEBKIT_EXPORT void assignInvalid();
65    WEBKIT_EXPORT void assignNull();
66    WEBKIT_EXPORT void reset();
67
68    WEBKIT_EXPORT WebIDBKeyType keyType() const;
69    WEBKIT_EXPORT bool isValid() const;
70    WEBKIT_EXPORT WebVector<WebIDBKey> array() const; // Only valid for ArrayType.
71    WEBKIT_EXPORT WebString string() const; // Only valid for StringType.
72    WEBKIT_EXPORT double date() const; // Only valid for DateType.
73    WEBKIT_EXPORT double number() const; // Only valid for NumberType.
74
75#if WEBKIT_IMPLEMENTATION
76    WebIDBKey(const WTF::PassRefPtr<WebCore::IDBKey>&);
77    WebIDBKey& operator=(const WTF::PassRefPtr<WebCore::IDBKey>&);
78    operator WTF::PassRefPtr<WebCore::IDBKey>() const;
79#endif
80
81private:
82    WebPrivatePtr<WebCore::IDBKey> m_private;
83};
84
85} // namespace WebKit
86
87#endif // WebIDBKey_h
88