Home | History | Annotate | Download | only in dom
      1 /*
      2  * Copyright (C) 1999 Lars Knoll (knoll (at) kde.org)
      3  * Copyright (C) 2000 Frederik Holljen (frederik.holljen (at) hig.no)
      4  * Copyright (C) 2001 Peter Kelly (pmk (at) post.com)
      5  * Copyright (C) 2006 Samuel Weinig (sam.weinig (at) 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 "NodeFilter.h"
     29 #include "Traversal.h"
     30 #include <wtf/PassRefPtr.h>
     31 #include <wtf/RefCounted.h>
     32 
     33 namespace WebCore {
     34 
     35     typedef int ExceptionCode;
     36 
     37     class TreeWalker : public RefCounted<TreeWalker>, public Traversal {
     38     public:
     39         static PassRefPtr<TreeWalker> create(PassRefPtr<Node> rootNode, unsigned whatToShow, PassRefPtr<NodeFilter> filter, bool expandEntityReferences)
     40         {
     41             return adoptRef(new TreeWalker(rootNode, whatToShow, filter, expandEntityReferences));
     42         }
     43 
     44         Node* currentNode() const { return m_current.get(); }
     45         void setCurrentNode(PassRefPtr<Node>, ExceptionCode&);
     46 
     47         Node* parentNode(ScriptState*);
     48         Node* firstChild(ScriptState*);
     49         Node* lastChild(ScriptState*);
     50         Node* previousSibling(ScriptState*);
     51         Node* nextSibling(ScriptState*);
     52         Node* previousNode(ScriptState*);
     53         Node* nextNode(ScriptState*);
     54 
     55         // Do not call these functions. They are just scaffolding to support the Objective-C bindings.
     56         // They operate in the main thread normal world, and they swallow JS exceptions.
     57         Node* parentNode() { return parentNode(scriptStateFromNode(mainThreadNormalWorld(), m_current.get())); }
     58         Node* firstChild() { return firstChild(scriptStateFromNode(mainThreadNormalWorld(), m_current.get())); }
     59         Node* lastChild() { return lastChild(scriptStateFromNode(mainThreadNormalWorld(), m_current.get())); }
     60         Node* previousSibling() { return previousSibling(scriptStateFromNode(mainThreadNormalWorld(), m_current.get())); }
     61         Node* nextSibling() { return nextSibling(scriptStateFromNode(mainThreadNormalWorld(), m_current.get())); }
     62         Node* previousNode() { return previousNode(scriptStateFromNode(mainThreadNormalWorld(), m_current.get())); }
     63         Node* nextNode() { return nextNode(scriptStateFromNode(mainThreadNormalWorld(), 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
     76