WebCore/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 "JSDOMBinding.h"
  29 #include "NodeFilter.h"
  30 #include "Traversal.h"
  31 #include <wtf/PassRefPtr.h>
  32 #include <wtf/RefCounted.h>
  33
  34 namespace WebCore {
  35
  36     typedef int ExceptionCode;
  37
  38     class TreeWalker : public RefCounted<TreeWalker>, public Traversal {
  39     public:
  40         static PassRefPtr<TreeWalker> create(PassRefPtr<Node> rootNode, unsigned whatToShow, PassRefPtr<NodeFilter> filter, bool expandEntityReferences)
  41         {
  42             return adoptRef(new TreeWalker(rootNode, whatToShow, filter, expandEntityReferences));
  43         }
  44
  45         Node* currentNode() const { return m_current.get(); }
  46         void setCurrentNode(PassRefPtr<Node>, ExceptionCode&);
  47
  48         Node* parentNode(ScriptState*);
  49         Node* firstChild(ScriptState*);
  50         Node* lastChild(ScriptState*);
  51         Node* previousSibling(ScriptState*);
  52         Node* nextSibling(ScriptState*);
  53         Node* previousNode(ScriptState*);
  54         Node* nextNode(ScriptState*);
  55
  56         // For non-JS bindings. Silently ignores the JavaScript exception if any.
  57         Node* parentNode() { return parentNode(scriptStateFromNode(m_current.get())); }
  58         Node* firstChild() { return firstChild(scriptStateFromNode(m_current.get())); }
  59         Node* lastChild() { return lastChild(scriptStateFromNode(m_current.get())); }
  60         Node* previousSibling() { return previousSibling(scriptStateFromNode(m_current.get())); }
  61         Node* nextSibling() { return nextSibling(scriptStateFromNode(m_current.get())); }
  62         Node* previousNode() { return previousNode(scriptStateFromNode(m_current.get())); }
  63         Node* nextNode() { return nextNode(scriptStateFromNode(m_current.get())); }
  64
  65     private:
  66         TreeWalker(PassRefPtr<Node>, unsigned whatToShow, PassRefPtr<NodeFilter>, bool expandEntityReferences);
  67
  68         Node* setCurrent(PassRefPtr<Node>);
  69
  70         RefPtr<Node> m_current;
  71     };
  72
  73 } // namespace WebCore
  74
  75 #endif // TreeWalker_h