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 explicit FrameTree(Frame* thisFrame); 34 ~FrameTree(); 35 36 const AtomicString& name() const { return m_name; } 37 const AtomicString& uniqueName() const { return m_uniqueName; } 38 // If |name| is not empty, |fallbackName| is ignored. Otherwise, 39 // |fallbackName| is used as a source of uniqueName. 40 void setName(const AtomicString& name, const AtomicString& fallbackName = nullAtom); 41 42 Frame* parent() const; 43 Frame* top() const; 44 Frame* previousSibling() const; 45 Frame* nextSibling() const; 46 Frame* firstChild() const; 47 Frame* lastChild() const; 48 49 bool isDescendantOf(const Frame* ancestor) const; 50 Frame* traversePreviousWithWrap(bool) const; 51 Frame* traverseNext(const Frame* stayWithin = 0) const; 52 Frame* traverseNextWithWrap(bool) const; 53 54 Frame* child(const AtomicString& name) const; 55 Frame* find(const AtomicString& name) const; 56 unsigned childCount() const; 57 58 Frame* scopedChild(unsigned index) const; 59 Frame* scopedChild(const AtomicString& name) const; 60 unsigned scopedChildCount() const; 61 void invalidateScopedChildCount(); 62 63 private: 64 Frame* deepLastChild() const; 65 AtomicString uniqueChildName(const AtomicString& requestedName) const; 66 bool uniqueNameExists(const AtomicString& name) const; 67 unsigned scopedChildCount(TreeScope*) const; 68 69 Frame* m_thisFrame; 70 71 AtomicString m_name; // The actual frame name (may be empty). 72 AtomicString m_uniqueName; 73 74 mutable unsigned m_scopedChildCount; 75 }; 76 77 } // namespace WebCore 78 79 #ifndef NDEBUG 80 // Outside the WebCore namespace for ease of invocation from gdb. 81 void showFrameTree(const WebCore::Frame*); 82 #endif 83 84 #endif // FrameTree_h 85
