Unreviewed, rolling out r199310.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBKeyRange.h
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 IDBKeyRange_h
27 #define IDBKeyRange_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "Dictionary.h"
32 #include "IDBKey.h"
33 #include "ScriptWrappable.h"
34 #include <wtf/RefCounted.h>
35
36 namespace WebCore {
37
38 typedef int ExceptionCode;
39
40 class IDBKeyRange : public ScriptWrappable, public RefCounted<IDBKeyRange> {
41 public:
42     enum LowerBoundType {
43         LowerBoundOpen,
44         LowerBoundClosed
45     };
46     enum UpperBoundType {
47         UpperBoundOpen,
48         UpperBoundClosed
49     };
50
51     static Ref<IDBKeyRange> create(RefPtr<IDBKey>&& lower, RefPtr<IDBKey>&& upper, LowerBoundType lowerType, UpperBoundType upperType)
52     {
53         return adoptRef(*new IDBKeyRange(WTFMove(lower), WTFMove(upper), lowerType, upperType));
54     }
55     static Ref<IDBKeyRange> create(RefPtr<IDBKey>&&);
56     ~IDBKeyRange() { }
57
58     IDBKey* lower() const { return m_lower.get(); }
59     IDBKey* upper() const { return m_upper.get(); }
60
61     Deprecated::ScriptValue lowerValue(ScriptExecutionContext&) const;
62     Deprecated::ScriptValue upperValue(ScriptExecutionContext&) const;
63     bool lowerOpen() const { return m_lowerType == LowerBoundOpen; }
64     bool upperOpen() const { return m_upperType == UpperBoundOpen; }
65
66     static RefPtr<IDBKeyRange> only(RefPtr<IDBKey>&& value, ExceptionCode&);
67     static RefPtr<IDBKeyRange> only(ScriptExecutionContext&, const Deprecated::ScriptValue& key, ExceptionCode&);
68
69     static RefPtr<IDBKeyRange> lowerBound(ScriptExecutionContext& context, const Deprecated::ScriptValue& bound, ExceptionCode& ec) { return lowerBound(context, bound, false, ec); }
70     static RefPtr<IDBKeyRange> lowerBound(ScriptExecutionContext&, const Deprecated::ScriptValue& bound, bool open, ExceptionCode&);
71
72     static RefPtr<IDBKeyRange> upperBound(ScriptExecutionContext& context, const Deprecated::ScriptValue& bound, ExceptionCode& ec) { return upperBound(context, bound, false, ec); }
73     static RefPtr<IDBKeyRange> upperBound(ScriptExecutionContext&, const Deprecated::ScriptValue& bound, bool open, ExceptionCode&);
74
75     static RefPtr<IDBKeyRange> bound(ScriptExecutionContext& context, const Deprecated::ScriptValue& lower, const Deprecated::ScriptValue& upper, ExceptionCode& ec) { return bound(context, lower, upper, false, false, ec); }
76     static RefPtr<IDBKeyRange> bound(ScriptExecutionContext& context, const Deprecated::ScriptValue& lower, const Deprecated::ScriptValue& upper, bool lowerOpen, ExceptionCode& ec) { return bound(context, lower, upper, lowerOpen, false, ec); }
77     static RefPtr<IDBKeyRange> bound(ScriptExecutionContext&, const Deprecated::ScriptValue& lower, const Deprecated::ScriptValue& upper, bool lowerOpen, bool upperOpen, ExceptionCode&);
78
79     WEBCORE_EXPORT bool isOnlyKey() const;
80
81 private:
82     IDBKeyRange(RefPtr<IDBKey>&& lower, RefPtr<IDBKey>&& upper, LowerBoundType lowerType, UpperBoundType upperType);
83
84     RefPtr<IDBKey> m_lower;
85     RefPtr<IDBKey> m_upper;
86     LowerBoundType m_lowerType;
87     UpperBoundType m_upperType;
88 };
89
90 } // namespace WebCore
91
92 #endif
93
94 #endif // IDBKeyRange_h