DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (1aeaa33a64f9)

VCS Links

Line Code
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * 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 NodeIterator
 */

#ifndef mozilla_dom_NodeIterator_h
#define mozilla_dom_NodeIterator_h

#include "nsTraversal.h"
#include "nsCycleCollectionParticipant.h"
#include "nsStubMutationObserver.h"

class nsINode;
class nsIDOMNode;

namespace mozilla {
namespace dom {

class NodeIterator final : public nsStubMutationObserver, public nsTraversal {
 public:
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS

  NodeIterator(nsINode *aRoot, uint32_t aWhatToShow, NodeFilter *aFilter);

  NS_DECL_NSIMUTATIONOBSERVER_CONTENTREMOVED

  NS_DECL_CYCLE_COLLECTION_CLASS(NodeIterator)

  // WebIDL API
  nsINode *Root() const { return mRoot; }
  nsINode *GetReferenceNode() const { return mPointer.mNode; }
  bool PointerBeforeReferenceNode() const { return mPointer.mBeforeNode; }
  uint32_t WhatToShow() const { return mWhatToShow; }
  NodeFilter *GetFilter() { return mFilter; }
  already_AddRefed<nsINode> NextNode(ErrorResult &aResult) {
    return NextOrPrevNode(&NodePointer::MoveToNext, aResult);
  }
  already_AddRefed<nsINode> PreviousNode(ErrorResult &aResult) {
    return NextOrPrevNode(&NodePointer::MoveToPrevious, aResult);
  }
  void Detach();

  bool WrapObject(JSContext *cx, JS::Handle<JSObject *> aGivenProto,
                  JS::MutableHandle<JSObject *> aReflector);

 private:
  virtual ~NodeIterator();

  struct NodePointer {
    NodePointer() : mNode(nullptr) {}
    NodePointer(nsINode *aNode, bool aBeforeNode);

    typedef bool (NodePointer::*MoveToMethodType)(nsINode *);
    bool MoveToNext(nsINode *aRoot);
    bool MoveToPrevious(nsINode *aRoot);

    bool MoveForward(nsINode *aRoot, nsINode *aNode);
    void MoveBackward(nsINode *aParent, nsINode *aNode);

    void AdjustAfterRemoval(nsINode *aRoot, nsINode *aContainer,
                            nsIContent *aChild, nsIContent *aPreviousSibling);

    void Clear() { mNode = nullptr; }

    nsINode *mNode;
    bool mBeforeNode;
  };

  // Have to return a strong ref, because the act of testing the node can
  // remove it from the DOM so we're holding the only ref to it.
  already_AddRefed<nsINode> NextOrPrevNode(NodePointer::MoveToMethodType aMove,
                                           ErrorResult &aResult);

  NodePointer mPointer;
  NodePointer mWorkingPointer;
};

}  // namespace dom

}  // namespace mozilla

#endif  // mozilla_dom_NodeIterator_h