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 "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 NodeIterator : public RefCounted<NodeIterator>, public Traversal { 38 public: 39 static PassRefPtr<NodeIterator> create(PassRefPtr<Node> rootNode, unsigned whatToShow, PassRefPtr<NodeFilter> filter, bool expandEntityReferences) 40 { 41 return adoptRef(new NodeIterator(rootNode, whatToShow, filter, expandEntityReferences)); 42 } 43 ~NodeIterator(); 44 45 PassRefPtr<Node> nextNode(ScriptState*, ExceptionCode&); 46 PassRefPtr<Node> previousNode(ScriptState*, ExceptionCode&); 47 void detach(); 48 49 Node* referenceNode() const { return m_referenceNode.node.get(); } 50 bool pointerBeforeReferenceNode() const { return m_referenceNode.isPointerBeforeNode; } 51 52 // This function is called before any node is removed from the document tree. 53 void nodeWillBeRemoved(Node*); 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 PassRefPtr<Node> nextNode(ExceptionCode& ec) { return nextNode(scriptStateFromNode(mainThreadNormalWorld(), referenceNode()), ec); } 58 PassRefPtr<Node> previousNode(ExceptionCode& ec) { return previousNode(scriptStateFromNode(mainThreadNormalWorld(), referenceNode()), ec); } 59 60 private: 61 NodeIterator(PassRefPtr<Node>, unsigned whatToShow, PassRefPtr<NodeFilter>, bool expandEntityReferences); 62 63 struct NodePointer { 64 RefPtr<Node> node; 65 bool isPointerBeforeNode; 66 NodePointer(); 67 NodePointer(PassRefPtr<Node>, bool); 68 void clear(); 69 bool moveToNext(Node* root); 70 bool moveToPrevious(Node* root); 71 }; 72 73 void updateForNodeRemoval(Node* nodeToBeRemoved, NodePointer&) const; 74 75 NodePointer m_referenceNode; 76 NodePointer m_candidateNode; 77 bool m_detached; 78 }; 79 80 } // namespace WebCore 81 82 #endif // NodeIterator_h 83
