1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_indexeddb_keypath_h__
#define mozilla_dom_indexeddb_keypath_h__
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/Nullable.h"
namespace mozilla {
namespace dom {
class OwningStringOrStringSequence;
namespace indexedDB {
class IndexMetadata;
class Key;
class ObjectStoreMetadata;
class KeyPath
{
// This private constructor is only to be used by IPDL-generated classes.
friend class IndexMetadata;
friend class ObjectStoreMetadata;
KeyPath()
: mType(NONEXISTENT)
{
MOZ_COUNT_CTOR(KeyPath);
}
public:
enum KeyPathType {
NONEXISTENT,
STRING,
ARRAY,
ENDGUARD
};
void SetType(KeyPathType aType);
bool AppendStringWithValidation(const nsAString& aString);
explicit KeyPath(int aDummy)
: mType(NONEXISTENT)
{
MOZ_COUNT_CTOR(KeyPath);
}
KeyPath(const KeyPath& aOther)
{
MOZ_COUNT_CTOR(KeyPath);
*this = aOther;
}
~KeyPath()
{
MOZ_COUNT_DTOR(KeyPath);
}
static nsresult
Parse(const nsAString& aString, KeyPath* aKeyPath);
static nsresult
Parse(const Sequence<nsString>& aStrings, KeyPath* aKeyPath);
static nsresult
Parse(const Nullable<OwningStringOrStringSequence>& aValue, KeyPath* aKeyPath);
nsresult
ExtractKey(JSContext* aCx,
const JS::Value& aValue,
Key& aKey,
bool aCallGetters) const;
nsresult
ExtractKeyAsJSVal(JSContext* aCx, const JS::Value& aValue,
JS::Value* aOutVal) const;
typedef nsresult
(*ExtractOrCreateKeyCallback)(JSContext* aCx, void* aClosure);
nsresult
ExtractOrCreateKey(JSContext* aCx,
const JS::Value& aValue,
Key& aKey,
ExtractOrCreateKeyCallback aCallback,
void* aClosure,
bool aCallGetters) const;
inline bool IsValid() const {
return mType != NONEXISTENT;
}
inline bool IsArray() const {
return mType == ARRAY;
}
inline bool IsString() const {
return mType == STRING;
}
inline bool IsEmpty() const {
return mType == STRING && mStrings[0].IsEmpty();
}
bool operator==(const KeyPath& aOther) const
{
return mType == aOther.mType && mStrings == aOther.mStrings;
}
void SerializeToString(nsAString& aString) const;
static KeyPath DeserializeFromString(const nsAString& aString);
nsresult ToJSVal(JSContext* aCx, JS::MutableHandle<JS::Value> aValue) const;
nsresult ToJSVal(JSContext* aCx, JS::Heap<JS::Value>& aValue) const;
bool IsAllowedForObjectStore(bool aAutoIncrement) const;
KeyPathType mType;
nsTArray<nsString> mStrings;
};
} // namespace indexedDB
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_indexeddb_keypath_h__
|
