diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /dom/base/TreeWalker.h | |
parent | Initial commit. (diff) | |
download | firefox-upstream.tar.xz firefox-upstream.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/base/TreeWalker.h')
-rw-r--r-- | dom/base/TreeWalker.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/dom/base/TreeWalker.h b/dom/base/TreeWalker.h new file mode 100644 index 0000000000..2421e242cc --- /dev/null +++ b/dom/base/TreeWalker.h @@ -0,0 +1,81 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=4 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/. */ + +/* + * Implementation of DOM Traversal's TreeWalker + */ + +#ifndef mozilla_dom_TreeWalker_h +#define mozilla_dom_TreeWalker_h + +#include "nsISupports.h" +#include "nsTraversal.h" +#include "nsCOMPtr.h" +#include "nsTArray.h" +#include "nsCycleCollectionParticipant.h" + +class nsINode; + +namespace mozilla { +namespace dom { + +class TreeWalker final : public nsISupports, public nsTraversal { + virtual ~TreeWalker(); + + public: + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + + TreeWalker(nsINode* aRoot, uint32_t aWhatToShow, NodeFilter* aFilter); + + NS_DECL_CYCLE_COLLECTION_CLASS(TreeWalker) + + // WebIDL API + nsINode* Root() const { return mRoot; } + uint32_t WhatToShow() const { return mWhatToShow; } + NodeFilter* GetFilter() { return mFilter; } + nsINode* CurrentNode() const { return mCurrentNode; } + void SetCurrentNode(nsINode& aNode, ErrorResult& aResult); + // All our traversal methods return strong refs because filtering can + // remove nodes from the tree. + already_AddRefed<nsINode> ParentNode(ErrorResult& aResult); + already_AddRefed<nsINode> FirstChild(ErrorResult& aResult); + already_AddRefed<nsINode> LastChild(ErrorResult& aResult); + already_AddRefed<nsINode> PreviousSibling(ErrorResult& aResult); + already_AddRefed<nsINode> NextSibling(ErrorResult& aResult); + already_AddRefed<nsINode> PreviousNode(ErrorResult& aResult); + already_AddRefed<nsINode> NextNode(ErrorResult& aResult); + + bool WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto, + JS::MutableHandle<JSObject*> aReflector); + + private: + nsCOMPtr<nsINode> mCurrentNode; + + /* + * Implements FirstChild and LastChild which only vary in which direction + * they search. + * @param aReversed Controls whether we search forwards or backwards + * @param aResult Whether we threw or not. + * @returns The desired node. Null if no child is found + */ + already_AddRefed<nsINode> FirstChildInternal(bool aReversed, + ErrorResult& aResult); + + /* + * Implements NextSibling and PreviousSibling which only vary in which + * direction they search. + * @param aReversed Controls whether we search forwards or backwards + * @param aResult Whether we threw or not. + * @returns The desired node. Null if no child is found + */ + already_AddRefed<nsINode> NextSiblingInternal(bool aReversed, + ErrorResult& aResult); +}; + +} // namespace dom +} // namespace mozilla + +#endif // mozilla_dom_TreeWalker_h |