• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #include "bindings/v8/Dictionary.h"
30 #include "bindings/v8/ScriptWrappable.h"
31 #include "modules/indexeddb/IDBKey.h"
32 #include "wtf/PassRefPtr.h"
33 #include "wtf/RefCounted.h"
34 
35 namespace WebCore {
36 
37 class ExceptionState;
38 
39 class IDBKeyRange : public ScriptWrappable, public RefCounted<IDBKeyRange> {
40 public:
41     enum LowerBoundType {
42         LowerBoundOpen,
43         LowerBoundClosed
44     };
45     enum UpperBoundType {
46         UpperBoundOpen,
47         UpperBoundClosed
48     };
49 
create(PassRefPtr<IDBKey> lower,PassRefPtr<IDBKey> upper,LowerBoundType lowerType,UpperBoundType upperType)50     static PassRefPtr<IDBKeyRange> create(PassRefPtr<IDBKey> lower, PassRefPtr<IDBKey> upper, LowerBoundType lowerType, UpperBoundType upperType)
51     {
52         return adoptRef(new IDBKeyRange(lower, upper, lowerType, upperType));
53     }
54     // Null if the script value is null or undefined, the range if it is one, otherwise tries to convert to a key and throws if it fails.
55     static PassRefPtr<IDBKeyRange> fromScriptValue(ExecutionContext*, const ScriptValue&, ExceptionState&);
56 
~IDBKeyRange()57     ~IDBKeyRange() { }
58 
59     // Implement the IDBKeyRange IDL
lower()60     PassRefPtr<IDBKey> lower() const { return m_lower; }
upper()61     PassRefPtr<IDBKey> upper() const { return m_upper; }
62 
63     ScriptValue lowerValue(ExecutionContext*) const;
64     ScriptValue upperValue(ExecutionContext*) const;
lowerOpen()65     bool lowerOpen() const { return m_lowerType == LowerBoundOpen; }
upperOpen()66     bool upperOpen() const { return m_upperType == UpperBoundOpen; }
67 
68     static PassRefPtr<IDBKeyRange> only(ExecutionContext*, const ScriptValue& key, ExceptionState&);
69     static PassRefPtr<IDBKeyRange> lowerBound(ExecutionContext*, const ScriptValue& bound, bool open, ExceptionState&);
70     static PassRefPtr<IDBKeyRange> upperBound(ExecutionContext*, const ScriptValue& bound, bool open, ExceptionState&);
71     static PassRefPtr<IDBKeyRange> bound(ExecutionContext*, const ScriptValue& lower, const ScriptValue& upper, bool lowerOpen, bool upperOpen, ExceptionState&);
72 
73     static PassRefPtr<IDBKeyRange> only(PassRefPtr<IDBKey> value, ExceptionState&);
74 
75 private:
76     IDBKeyRange(PassRefPtr<IDBKey> lower, PassRefPtr<IDBKey> upper, LowerBoundType lowerType, UpperBoundType upperType);
77 
78     RefPtr<IDBKey> m_lower;
79     RefPtr<IDBKey> m_upper;
80     LowerBoundType m_lowerType;
81     UpperBoundType m_upperType;
82 };
83 
84 } // namespace WebCore
85 
86 #endif // IDBKeyRange_h
87