src/third_party/WebKit/Source/core/dom/TreeWalker.h

   1 /*
   2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
   3  * Copyright (C) 2000 Frederik Holljen (frederik.holljen@hig.no)
   4  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
   5  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
   6  * Copyright (C) 2004, 2008 Apple Inc. All rights reserved.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public License
  19  * along with this library; see the file COPYING.LIB.  If not, write to
  20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  *
  23  */
  24
  25 #ifndef TreeWalker_h
  26 #define TreeWalker_h
  27
  28 #include "bindings/core/v8/ScriptWrappable.h"
  29 #include "core/dom/NodeFilter.h"
  30 #include "core/dom/NodeIteratorBase.h"
  31 #include "platform/heap/Handle.h"
  32 #include "wtf/PassRefPtr.h"
  33 #include "wtf/RefCounted.h"
  34
  35 namespace blink {
  36
  37 class ExceptionState;
  38
  39 class TreeWalker FINAL : public RefCountedWillBeGarbageCollected<TreeWalker>, public ScriptWrappable, public NodeIteratorBase {
  40     DEFINE_WRAPPERTYPEINFO();
  41     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(TreeWalker);
  42 public:
  43     static PassRefPtrWillBeRawPtr<TreeWalker> create(PassRefPtrWillBeRawPtr<Node> rootNode, unsigned whatToShow, PassRefPtrWillBeRawPtr<NodeFilter> filter)
  44     {
  45         return adoptRefWillBeNoop(new TreeWalker(rootNode, whatToShow, filter));
  46     }
  47
  48     Node* currentNode() const { return m_current.get(); }
  49     void setCurrentNode(PassRefPtrWillBeRawPtr<Node>, ExceptionState&);
  50
  51     Node* parentNode(ExceptionState&);
  52     Node* firstChild(ExceptionState&);
  53     Node* lastChild(ExceptionState&);
  54     Node* previousSibling(ExceptionState&);
  55     Node* nextSibling(ExceptionState&);
  56     Node* previousNode(ExceptionState&);
  57     Node* nextNode(ExceptionState&);
  58
  59     void trace(Visitor*);
  60
  61 private:
  62     TreeWalker(PassRefPtrWillBeRawPtr<Node>, unsigned whatToShow, PassRefPtrWillBeRawPtr<NodeFilter>);
  63
  64     Node* setCurrent(PassRefPtrWillBeRawPtr<Node>);
  65
  66     RefPtrWillBeMember<Node> m_current;
  67 };
  68
  69 } // namespace blink
  70
  71 #endif // TreeWalker_h