1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5
6 #ifndef mozilla_dom_XPathResult_h
7 #define mozilla_dom_XPathResult_h
8
9 #include "nsStubMutationObserver.h"
10 #include "nsCOMPtr.h"
11 #include "nsCycleCollectionParticipant.h"
12 #include "nsIWeakReferenceUtils.h"
13 #include "nsTArray.h"
14 #include "mozilla/Attributes.h"
15 #include "mozilla/ErrorResult.h"
16 #include "nsString.h"
17 #include "nsWrapperCache.h"
18 #include "nsINode.h"
19
20 class txAExprResult;
21
22 // {662f2c9a-c7cd-4cab-9349-e733df5a838c}
23 #define NS_IXPATHRESULT_IID \
24 { \
25 0x662f2c9a, 0xc7cd, 0x4cab, { \
26 0x93, 0x49, 0xe7, 0x33, 0xdf, 0x5a, 0x83, 0x8c \
27 } \
28 }
29
30 class nsIXPathResult : public nsISupports {
31 public:
32 NS_DECLARE_STATIC_IID_ACCESSOR(NS_IXPATHRESULT_IID)
33 virtual void SetExprResult(txAExprResult* aExprResult, uint16_t aResultType,
34 nsINode* aContextNode,
35 mozilla::ErrorResult& aRv) = 0;
36 virtual nsresult GetExprResult(txAExprResult** aExprResult) = 0;
37 virtual nsresult Clone(nsIXPathResult** aResult) = 0;
38 };
39
NS_DEFINE_STATIC_IID_ACCESSOR(nsIXPathResult,NS_IXPATHRESULT_IID)40 NS_DEFINE_STATIC_IID_ACCESSOR(nsIXPathResult, NS_IXPATHRESULT_IID)
41
42 namespace mozilla {
43 namespace dom {
44
45 /**
46 * A class for evaluating an XPath expression string
47 */
48 class XPathResult final : public nsIXPathResult,
49 public nsStubMutationObserver,
50 public nsWrapperCache {
51 ~XPathResult();
52
53 public:
54 explicit XPathResult(nsINode* aParent);
55 XPathResult(const XPathResult& aResult);
56
57 enum {
58 ANY_TYPE = 0U,
59 NUMBER_TYPE = 1U,
60 STRING_TYPE = 2U,
61 BOOLEAN_TYPE = 3U,
62 UNORDERED_NODE_ITERATOR_TYPE = 4U,
63 ORDERED_NODE_ITERATOR_TYPE = 5U,
64 UNORDERED_NODE_SNAPSHOT_TYPE = 6U,
65 ORDERED_NODE_SNAPSHOT_TYPE = 7U,
66 ANY_UNORDERED_NODE_TYPE = 8U,
67 FIRST_ORDERED_NODE_TYPE = 9U
68 };
69
70 // nsISupports interface
71 NS_DECL_CYCLE_COLLECTING_ISUPPORTS
72 NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_AMBIGUOUS(XPathResult,
73 nsIXPathResult)
74
75 static XPathResult* FromSupports(nsISupports* aSupports) {
76 return static_cast<XPathResult*>(static_cast<nsIXPathResult*>(aSupports));
77 }
78
79 virtual JSObject* WrapObject(JSContext* aCx,
80 JS::Handle<JSObject*> aGivenProto) override;
81 nsINode* GetParentObject() const { return mParent; }
82 uint16_t ResultType() const { return mResultType; }
83 double GetNumberValue(ErrorResult& aRv) const {
84 if (mResultType != NUMBER_TYPE) {
85 aRv.ThrowTypeError("Result is not a number");
86 return 0;
87 }
88
89 return mNumberResult;
90 }
91 void GetStringValue(nsAString& aStringValue, ErrorResult& aRv) const {
92 if (mResultType != STRING_TYPE) {
93 aRv.ThrowTypeError("Result is not a string");
94 return;
95 }
96
97 aStringValue = mStringResult;
98 }
99 bool GetBooleanValue(ErrorResult& aRv) const {
100 if (mResultType != BOOLEAN_TYPE) {
101 aRv.ThrowTypeError("Result is not a boolean");
102 return false;
103 }
104
105 return mBooleanResult;
106 }
107 nsINode* GetSingleNodeValue(ErrorResult& aRv) const {
108 if (!isNode()) {
109 aRv.ThrowTypeError("Result is not a node");
110 return nullptr;
111 }
112
113 return mResultNodes.SafeElementAt(0);
114 }
115 bool InvalidIteratorState() const {
116 return isIterator() && mInvalidIteratorState;
117 }
118 uint32_t GetSnapshotLength(ErrorResult& aRv) const {
119 if (!isSnapshot()) {
120 aRv.ThrowTypeError("Result is not a snapshot");
121 return 0;
122 }
123
124 return (uint32_t)mResultNodes.Length();
125 }
126 nsINode* IterateNext(ErrorResult& aRv);
127 nsINode* SnapshotItem(uint32_t aIndex, ErrorResult& aRv) const {
128 if (!isSnapshot()) {
129 aRv.ThrowTypeError("Result is not a snapshot");
130 return nullptr;
131 }
132
133 return mResultNodes.SafeElementAt(aIndex);
134 }
135
136 // nsIMutationObserver interface
137 NS_DECL_NSIMUTATIONOBSERVER_CHARACTERDATACHANGED
138 NS_DECL_NSIMUTATIONOBSERVER_ATTRIBUTECHANGED
139 NS_DECL_NSIMUTATIONOBSERVER_CONTENTAPPENDED
140 NS_DECL_NSIMUTATIONOBSERVER_CONTENTINSERTED
141 NS_DECL_NSIMUTATIONOBSERVER_CONTENTREMOVED
142 NS_DECL_NSIMUTATIONOBSERVER_NODEWILLBEDESTROYED
143
144 void SetExprResult(txAExprResult* aExprResult, uint16_t aResultType,
145 nsINode* aContextNode, ErrorResult& aRv) override;
146 nsresult GetExprResult(txAExprResult** aExprResult) override;
147 nsresult Clone(nsIXPathResult** aResult) override;
148 void RemoveObserver();
149
150 private:
151 static bool isSnapshot(uint16_t aResultType) {
152 return aResultType == UNORDERED_NODE_SNAPSHOT_TYPE ||
153 aResultType == ORDERED_NODE_SNAPSHOT_TYPE;
154 }
155 static bool isIterator(uint16_t aResultType) {
156 return aResultType == UNORDERED_NODE_ITERATOR_TYPE ||
157 aResultType == ORDERED_NODE_ITERATOR_TYPE;
158 }
159 static bool isNode(uint16_t aResultType) {
160 return aResultType == FIRST_ORDERED_NODE_TYPE ||
161 aResultType == ANY_UNORDERED_NODE_TYPE;
162 }
163 bool isSnapshot() const { return isSnapshot(mResultType); }
164 bool isIterator() const { return isIterator(mResultType); }
165 bool isNode() const { return isNode(mResultType); }
166
167 void Invalidate(const nsIContent* aChangeRoot);
168
169 nsCOMPtr<nsINode> mParent;
170 RefPtr<txAExprResult> mResult;
171 nsTArray<nsCOMPtr<nsINode>> mResultNodes;
172 RefPtr<Document> mDocument;
173 nsWeakPtr mContextNode;
174 uint32_t mCurrentPos;
175 uint16_t mResultType;
176 bool mInvalidIteratorState;
177 bool mBooleanResult;
178 double mNumberResult;
179 nsString mStringResult;
180 };
181
182 } // namespace dom
183 } // namespace mozilla
184
185 #endif /* mozilla_dom_XPathResult_h */
186