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 NodeIterator_h
     26 #define NodeIterator_h
     27 
     28 #include "bindings/v8/ScriptWrappable.h"
     29 #include "core/dom/NodeFilter.h"
     30 #include "core/dom/Traversal.h"
     31 #include "wtf/PassRefPtr.h"
     32 #include "wtf/RefCounted.h"
     33 
     34 namespace WebCore {
     35 
     36 class ExceptionState;
     37 
     38 class NodeIterator : public ScriptWrappable, public RefCounted<NodeIterator>, public Traversal {
     39 public:
     40     static PassRefPtr<NodeIterator> create(PassRefPtr<Node> rootNode, unsigned whatToShow, PassRefPtr<NodeFilter> filter)
     41     {
     42         return adoptRef(new NodeIterator(rootNode, whatToShow, filter));
     43     }
     44     ~NodeIterator();
     45 
     46     PassRefPtr<Node> nextNode(ScriptState*, ExceptionState&);
     47     PassRefPtr<Node> previousNode(ScriptState*, ExceptionState&);
     48     void detach();
     49 
     50     Node* referenceNode() const { return m_referenceNode.node.get(); }
     51     bool pointerBeforeReferenceNode() const { return m_referenceNode.isPointerBeforeNode; }
     52 
     53     // This function is called before any node is removed from the document tree.
     54     void nodeWillBeRemoved(Node*);
     55 
     56 private:
     57     NodeIterator(PassRefPtr<Node>, unsigned whatToShow, PassRefPtr<NodeFilter>);
     58 
     59     struct NodePointer {
     60         RefPtr<Node> node;
     61         bool isPointerBeforeNode;
     62         NodePointer();
     63         NodePointer(PassRefPtr<Node>, bool);
     64         void clear();
     65         bool moveToNext(Node* root);
     66         bool moveToPrevious(Node* root);
     67     };
     68 
     69     void updateForNodeRemoval(Node* nodeToBeRemoved, NodePointer&) const;
     70 
     71     NodePointer m_referenceNode;
     72     NodePointer m_candidateNode;
     73     bool m_detached;
     74 };
     75 
     76 } // namespace WebCore
     77 
     78 #endif // NodeIterator_h
     79