1 /* 2 * Copyright (C) 2006 Apple Computer, Inc. 3 * 4 * This library is free software; you can redistribute it and/or 5 * modify it under the terms of the GNU Library General Public 6 * License as published by the Free Software Foundation; either 7 * version 2 of the License, or (at your option) any later version. 8 * 9 * This library is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 * Library General Public License for more details. 13 * 14 * You should have received a copy of the GNU Library General Public License 15 * along with this library; see the file COPYING.LIB. If not, write to 16 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 17 * Boston, MA 02110-1301, USA. 18 */ 19 20 #ifndef FrameTree_h 21 #define FrameTree_h 22 23 #include "wtf/text/AtomicString.h" 24 25 namespace WebCore { 26 27 class Frame; 28 class TreeScope; 29 30 class FrameTree { 31 WTF_MAKE_NONCOPYABLE(FrameTree); 32 public: 33 const static unsigned invalidCount = static_cast<unsigned>(-1); 34 35 FrameTree(Frame* thisFrame, Frame* parentFrame) 36 : m_thisFrame(thisFrame) 37 , m_parent(parentFrame) 38 , m_previousSibling(0) 39 , m_lastChild(0) 40 , m_scopedChildCount(invalidCount) 41 { 42 } 43 44 ~FrameTree(); 45 46 const AtomicString& name() const { return m_name; } 47 const AtomicString& uniqueName() const { return m_uniqueName; } 48 void setName(const AtomicString&); 49 Frame* parent() const; 50 void setParent(Frame* parent) { m_parent = parent; } 51 52 Frame* nextSibling() const { return m_nextSibling.get(); } 53 Frame* previousSibling() const { return m_previousSibling; } 54 Frame* firstChild() const { return m_firstChild.get(); } 55 Frame* lastChild() const { return m_lastChild; } 56 57 bool isDescendantOf(const Frame* ancestor) const; 58 Frame* traverseNext(const Frame* stayWithin = 0) const; 59 Frame* traverseNextWithWrap(bool) const; 60 Frame* traversePreviousWithWrap(bool) const; 61 62 void appendChild(PassRefPtr<Frame>); 63 void detachFromParent() { m_parent = 0; } 64 void removeChild(Frame*); 65 66 Frame* child(const AtomicString& name) const; 67 Frame* find(const AtomicString& name) const; 68 unsigned childCount() const; 69 70 Frame* top() const; 71 72 Frame* scopedChild(unsigned index) const; 73 Frame* scopedChild(const AtomicString& name) const; 74 unsigned scopedChildCount() const; 75 76 private: 77 Frame* deepLastChild() const; 78 AtomicString uniqueChildName(const AtomicString& requestedName) const; 79 unsigned scopedChildCount(TreeScope*) const; 80 81 Frame* m_thisFrame; 82 83 Frame* m_parent; 84 AtomicString m_name; // The actual frame name (may be empty). 85 AtomicString m_uniqueName; 86 87 // FIXME: use ListRefPtr? 88 RefPtr<Frame> m_nextSibling; 89 Frame* m_previousSibling; 90 RefPtr<Frame> m_firstChild; 91 Frame* m_lastChild; 92 mutable unsigned m_scopedChildCount; 93 }; 94 95 } // namespace WebCore 96 97 #ifndef NDEBUG 98 // Outside the WebCore namespace for ease of invocation from gdb. 99 void showFrameTree(const WebCore::Frame*); 100 #endif 101 102 #endif // FrameTree_h 103
