summaryrefslogtreecommitdiffstats
path: root/dom/xslt/xpath/XPathResult.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/xslt/xpath/XPathResult.h')
-rw-r--r--dom/xslt/xpath/XPathResult.h156
1 files changed, 156 insertions, 0 deletions
diff --git a/dom/xslt/xpath/XPathResult.h b/dom/xslt/xpath/XPathResult.h
new file mode 100644
index 0000000000..e073666a84
--- /dev/null
+++ b/dom/xslt/xpath/XPathResult.h
@@ -0,0 +1,156 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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_XPathResult_h
+#define mozilla_dom_XPathResult_h
+
+#include "nsStubMutationObserver.h"
+#include "nsCOMPtr.h"
+#include "nsCycleCollectionParticipant.h"
+#include "nsIWeakReferenceUtils.h"
+#include "nsTArray.h"
+#include "mozilla/Attributes.h"
+#include "mozilla/ErrorResult.h"
+#include "nsString.h"
+#include "nsWrapperCache.h"
+#include "nsINode.h"
+
+class txAExprResult;
+
+namespace mozilla::dom {
+
+/**
+ * A class for evaluating an XPath expression string
+ */
+class XPathResult final : public nsStubMutationObserver, public nsWrapperCache {
+ ~XPathResult();
+
+ public:
+ explicit XPathResult(nsINode* aParent);
+ XPathResult(const XPathResult& aResult);
+
+ enum {
+ ANY_TYPE = 0U,
+ NUMBER_TYPE = 1U,
+ STRING_TYPE = 2U,
+ BOOLEAN_TYPE = 3U,
+ UNORDERED_NODE_ITERATOR_TYPE = 4U,
+ ORDERED_NODE_ITERATOR_TYPE = 5U,
+ UNORDERED_NODE_SNAPSHOT_TYPE = 6U,
+ ORDERED_NODE_SNAPSHOT_TYPE = 7U,
+ ANY_UNORDERED_NODE_TYPE = 8U,
+ FIRST_ORDERED_NODE_TYPE = 9U
+ };
+
+ // nsISupports interface
+ NS_DECL_CYCLE_COLLECTING_ISUPPORTS
+ NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(XPathResult)
+
+ virtual JSObject* WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) override;
+ nsINode* GetParentObject() const { return mParent; }
+ uint16_t ResultType() const { return mResultType; }
+ double GetNumberValue(ErrorResult& aRv) const {
+ if (mResultType != NUMBER_TYPE) {
+ aRv.ThrowTypeError("Result is not a number");
+ return 0;
+ }
+
+ return mNumberResult;
+ }
+ void GetStringValue(nsAString& aStringValue, ErrorResult& aRv) const {
+ if (mResultType != STRING_TYPE) {
+ aRv.ThrowTypeError("Result is not a string");
+ return;
+ }
+
+ aStringValue = mStringResult;
+ }
+ bool GetBooleanValue(ErrorResult& aRv) const {
+ if (mResultType != BOOLEAN_TYPE) {
+ aRv.ThrowTypeError("Result is not a boolean");
+ return false;
+ }
+
+ return mBooleanResult;
+ }
+ nsINode* GetSingleNodeValue(ErrorResult& aRv) const {
+ if (!isNode()) {
+ aRv.ThrowTypeError("Result is not a node");
+ return nullptr;
+ }
+
+ return mResultNodes.SafeElementAt(0);
+ }
+ bool InvalidIteratorState() const {
+ return isIterator() && mInvalidIteratorState;
+ }
+ uint32_t GetSnapshotLength(ErrorResult& aRv) const {
+ if (!isSnapshot()) {
+ aRv.ThrowTypeError("Result is not a snapshot");
+ return 0;
+ }
+
+ return (uint32_t)mResultNodes.Length();
+ }
+ nsINode* IterateNext(ErrorResult& aRv);
+ nsINode* SnapshotItem(uint32_t aIndex, ErrorResult& aRv) const {
+ if (!isSnapshot()) {
+ aRv.ThrowTypeError("Result is not a snapshot");
+ return nullptr;
+ }
+
+ return mResultNodes.SafeElementAt(aIndex);
+ }
+
+ // nsIMutationObserver interface
+ NS_DECL_NSIMUTATIONOBSERVER_CHARACTERDATACHANGED
+ NS_DECL_NSIMUTATIONOBSERVER_ATTRIBUTECHANGED
+ NS_DECL_NSIMUTATIONOBSERVER_CONTENTAPPENDED
+ NS_DECL_NSIMUTATIONOBSERVER_CONTENTINSERTED
+ NS_DECL_NSIMUTATIONOBSERVER_CONTENTREMOVED
+ NS_DECL_NSIMUTATIONOBSERVER_NODEWILLBEDESTROYED
+
+ void SetExprResult(txAExprResult* aExprResult, uint16_t aResultType,
+ nsINode* aContextNode, ErrorResult& aRv);
+ nsresult GetExprResult(txAExprResult** aExprResult);
+ already_AddRefed<XPathResult> Clone(ErrorResult& aError);
+ void RemoveObserver();
+
+ private:
+ static bool isSnapshot(uint16_t aResultType) {
+ return aResultType == UNORDERED_NODE_SNAPSHOT_TYPE ||
+ aResultType == ORDERED_NODE_SNAPSHOT_TYPE;
+ }
+ static bool isIterator(uint16_t aResultType) {
+ return aResultType == UNORDERED_NODE_ITERATOR_TYPE ||
+ aResultType == ORDERED_NODE_ITERATOR_TYPE;
+ }
+ static bool isNode(uint16_t aResultType) {
+ return aResultType == FIRST_ORDERED_NODE_TYPE ||
+ aResultType == ANY_UNORDERED_NODE_TYPE;
+ }
+ bool isSnapshot() const { return isSnapshot(mResultType); }
+ bool isIterator() const { return isIterator(mResultType); }
+ bool isNode() const { return isNode(mResultType); }
+
+ void Invalidate(const nsIContent* aChangeRoot);
+
+ nsCOMPtr<nsINode> mParent;
+ RefPtr<txAExprResult> mResult;
+ nsTArray<nsCOMPtr<nsINode>> mResultNodes;
+ RefPtr<Document> mDocument;
+ nsWeakPtr mContextNode;
+ uint32_t mCurrentPos;
+ uint16_t mResultType;
+ bool mInvalidIteratorState;
+ bool mBooleanResult;
+ double mNumberResult;
+ nsString mStringResult;
+};
+
+} // namespace mozilla::dom
+
+#endif /* mozilla_dom_XPathResult_h */