Have Frame::tree() return a reference

Source/core/page/FrameTree.cpp

 /*
  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
  * Copyright (C) 2006 Apple Computer, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
@@ skipping 18 matching lines @@
 #include "wtf/Vector.h"
 #include "wtf/text/CString.h"
 #include "wtf/text/StringBuilder.h"
 
 using std::swap;
 
 namespace WebCore {
 
 FrameTree::~FrameTree()
 {
-    for (Frame* child = firstChild(); child; child = child->tree()->nextSibling())
+    for (Frame* child = firstChild(); child; child = child->tree().nextSibling())
         child->setView(0);
 }
 
 void FrameTree::setName(const AtomicString& name)
 {
     m_name = name;
     if (!parent()) {
         m_uniqueName = name;
         return;
     }
     m_uniqueName = AtomicString(); // Remove our old frame name so it's not considered in uniqueChildName.
-    m_uniqueName = parent()->tree()->uniqueChildName(name);
+    m_uniqueName = parent()->tree().uniqueChildName(name);
 }
 
 Frame* FrameTree::parent() const
 {
     return m_parent;
 }
 
 void FrameTree::appendChild(PassRefPtr<Frame> child)
 {
     ASSERT(child->page() == m_thisFrame->page());
-    child->tree()->m_parent = m_thisFrame;
+    child->tree().m_parent = m_thisFrame;
     Frame* oldLast = m_lastChild;
     m_lastChild = child.get();
 
     if (oldLast) {
-        child->tree()->m_previousSibling = oldLast;
-        oldLast->tree()->m_nextSibling = child;
+        child->tree().m_previousSibling = oldLast;
+        oldLast->tree().m_nextSibling = child;
     } else
         m_firstChild = child;
 
     m_scopedChildCount = invalidCount;
 
-    ASSERT(!m_lastChild->tree()->m_nextSibling);
+    ASSERT(!m_lastChild->tree().m_nextSibling);
 }
 
 void FrameTree::removeChild(Frame* child)
 {
-    child->tree()->m_parent = 0;
+    child->tree().m_parent = 0;
 
     // Slightly tricky way to prevent deleting the child until we are done with it, w/o
     // extra refs. These swaps leave the child in a circular list by itself. Clearing its
     // previous and next will then finally deref it.
 
-    RefPtr<Frame>& newLocationForNext = m_firstChild == child ? m_firstChild : child->tree()->m_previousSibling->tree()->m_nextSibling;
-    Frame*& newLocationForPrevious = m_lastChild == child ? m_lastChild : child->tree()->m_nextSibling->tree()->m_previousSibling;
-    swap(newLocationForNext, child->tree()->m_nextSibling);
+    RefPtr<Frame>& newLocationForNext = m_firstChild == child ? m_firstChild : child->tree().m_previousSibling->tree().m_nextSibling;
+    Frame*& newLocationForPrevious = m_lastChild == child ? m_lastChild : child->tree().m_nextSibling->tree().m_previousSibling;
+    swap(newLocationForNext, child->tree().m_nextSibling);
     // For some inexplicable reason, the following line does not compile without the explicit std:: namespace
-    std::swap(newLocationForPrevious, child->tree()->m_previousSibling);
+    std::swap(newLocationForPrevious, child->tree().m_previousSibling);
 
-    child->tree()->m_previousSibling = 0;
-    child->tree()->m_nextSibling = 0;
+    child->tree().m_previousSibling = 0;
+    child->tree().m_nextSibling = 0;
 
     m_scopedChildCount = invalidCount;
 }
 
 AtomicString FrameTree::uniqueChildName(const AtomicString& requestedName) const
 {
     if (!requestedName.isEmpty() && !child(requestedName) && requestedName != "_blank")
         return requestedName;
 
     // Create a repeatable name for a child about to be added to us. The name must be
     // unique within the frame tree. The string we generate includes a "path" of names
     // from the root frame down to us. For this path to be unique, each set of siblings must
     // contribute a unique name to the path, which can't collide with any HTML-assigned names.
     // We generate this path component by index in the child list along with an unlikely
     // frame name that can't be set in HTML because it collides with comment syntax.
 
     const char framePathPrefix[] = "<!--framePath ";
     const int framePathPrefixLength = 14;
     const int framePathSuffixLength = 3;
 
     // Find the nearest parent that has a frame with a path in it.
     Vector<Frame*, 16> chain;
     Frame* frame;
-    for (frame = m_thisFrame; frame; frame = frame->tree()->parent()) {
-        if (frame->tree()->uniqueName().startsWith(framePathPrefix))
+    for (frame = m_thisFrame; frame; frame = frame->tree().parent()) {
+        if (frame->tree().uniqueName().startsWith(framePathPrefix))
             break;
         chain.append(frame);
     }
     StringBuilder name;
     name.append(framePathPrefix);
     if (frame) {
-        name.append(frame->tree()->uniqueName().string().substring(framePathPrefixLength,
-            frame->tree()->uniqueName().length() - framePathPrefixLength - framePathSuffixLength));
+        name.append(frame->tree().uniqueName().string().substring(framePathPrefixLength,
+            frame->tree().uniqueName().length() - framePathPrefixLength - framePathSuffixLength));
     }
     for (int i = chain.size() - 1; i >= 0; --i) {
         frame = chain[i];
         name.append('/');
-        name.append(frame->tree()->uniqueName());
+        name.append(frame->tree().uniqueName());
     }
 
     name.appendLiteral("/<!--frame");
     name.appendNumber(childCount());
     name.appendLiteral("-->-->");
 
     return name.toAtomicString();
 }
 
 Frame* FrameTree::scopedChild(unsigned index) const
 {
     TreeScope* scope = m_thisFrame->document();
     if (!scope)
         return 0;
 
     unsigned scopedIndex = 0;
-    for (Frame* result = firstChild(); result; result = result->tree()->nextSibling()) {
+    for (Frame* result = firstChild(); result; result = result->tree().nextSibling()) {
         if (result->inScope(scope)) {
             if (scopedIndex == index)
                 return result;
             scopedIndex++;
         }
     }
 
     return 0;
 }
 
 Frame* FrameTree::scopedChild(const AtomicString& name) const
 {
     TreeScope* scope = m_thisFrame->document();
     if (!scope)
         return 0;
 
-    for (Frame* child = firstChild(); child; child = child->tree()->nextSibling())
-        if (child->tree()->uniqueName() == name && child->inScope(scope))
+    for (Frame* child = firstChild(); child; child = child->tree().nextSibling())
+        if (child->tree().uniqueName() == name && child->inScope(scope))
             return child;
     return 0;
 }
 
 inline unsigned FrameTree::scopedChildCount(TreeScope* scope) const
 {
     if (!scope)
         return 0;
 
     unsigned scopedCount = 0;
-    for (Frame* result = firstChild(); result; result = result->tree()->nextSibling()) {
+    for (Frame* result = firstChild(); result; result = result->tree().nextSibling()) {
         if (result->inScope(scope))
             scopedCount++;
     }
 
     return scopedCount;
 }
 
 unsigned FrameTree::scopedChildCount() const
 {
     if (m_scopedChildCount == invalidCount)
         m_scopedChildCount = scopedChildCount(m_thisFrame->document());
     return m_scopedChildCount;
 }
 
 unsigned FrameTree::childCount() const
 {
     unsigned count = 0;
-    for (Frame* result = firstChild(); result; result = result->tree()->nextSibling())
+    for (Frame* result = firstChild(); result; result = result->tree().nextSibling())
         ++count;
     return count;
 }
 
 Frame* FrameTree::child(const AtomicString& name) const
 {
-    for (Frame* child = firstChild(); child; child = child->tree()->nextSibling())
-        if (child->tree()->uniqueName() == name)
+    for (Frame* child = firstChild(); child; child = child->tree().nextSibling())
+        if (child->tree().uniqueName() == name)
             return child;
     return 0;
 }
 
 Frame* FrameTree::find(const AtomicString& name) const
 {
     if (name == "_self" || name == "_current" || name.isEmpty())
         return m_thisFrame;
 
     if (name == "_top")
         return top();
 
     if (name == "_parent")
         return parent() ? parent() : m_thisFrame;
 
     // Since "_blank" should never be any frame's name, the following just amounts to an optimization.
     if (name == "_blank")
         return 0;
 
     // Search subtree starting with this frame first.
-    for (Frame* frame = m_thisFrame; frame; frame = frame->tree()->traverseNext(m_thisFrame))
-        if (frame->tree()->uniqueName() == name)
+    for (Frame* frame = m_thisFrame; frame; frame = frame->tree().traverseNext(m_thisFrame))
+        if (frame->tree().uniqueName() == name)
             return frame;
 
     // Search the entire tree for this page next.
     Page* page = m_thisFrame->page();
 
     // The frame could have been detached from the page, so check it.
     if (!page)
         return 0;
 
-    for (Frame* frame = page->mainFrame(); frame; frame = frame->tree()->traverseNext())
-        if (frame->tree()->uniqueName() == name)
+    for (Frame* frame = page->mainFrame(); frame; frame = frame->tree().traverseNext())
+        if (frame->tree().uniqueName() == name)
             return frame;
 
     // Search the entire tree of each of the other pages in this namespace.
     // FIXME: Is random order OK?
     const HashSet<Page*>& pages = page->group().pages();
     HashSet<Page*>::const_iterator end = pages.end();
     for (HashSet<Page*>::const_iterator it = pages.begin(); it != end; ++it) {
         Page* otherPage = *it;
         if (otherPage != page) {
-            for (Frame* frame = otherPage->mainFrame(); frame; frame = frame->tree()->traverseNext()) {
-                if (frame->tree()->uniqueName() == name)
+            for (Frame* frame = otherPage->mainFrame(); frame; frame = frame->tree().traverseNext()) {
+                if (frame->tree().uniqueName() == name)
                     return frame;
             }
         }
     }
 
     return 0;
 }
 
 bool FrameTree::isDescendantOf(const Frame* ancestor) const
 {
     if (!ancestor)
         return false;
 
     if (m_thisFrame->page() != ancestor->page())
         return false;
 
-    for (Frame* frame = m_thisFrame; frame; frame = frame->tree()->parent())
+    for (Frame* frame = m_thisFrame; frame; frame = frame->tree().parent())
         if (frame == ancestor)
             return true;
     return false;
 }
 
 Frame* FrameTree::traverseNext(const Frame* stayWithin) const
 {
     Frame* child = firstChild();
     if (child) {
-        ASSERT(!stayWithin || child->tree()->isDescendantOf(stayWithin));
+        ASSERT(!stayWithin || child->tree().isDescendantOf(stayWithin));
         return child;
     }
 
     if (m_thisFrame == stayWithin)
         return 0;
 
     Frame* sibling = nextSibling();
     if (sibling) {
-        ASSERT(!stayWithin || sibling->tree()->isDescendantOf(stayWithin));
+        ASSERT(!stayWithin || sibling->tree().isDescendantOf(stayWithin));
         return sibling;
     }
 
     Frame* frame = m_thisFrame;
-    while (!sibling && (!stayWithin || frame->tree()->parent() != stayWithin)) {
-        frame = frame->tree()->parent();
+    while (!sibling && (!stayWithin || frame->tree().parent() != stayWithin)) {
+        frame = frame->tree().parent();
         if (!frame)
             return 0;
-        sibling = frame->tree()->nextSibling();
+        sibling = frame->tree().nextSibling();
     }
 
     if (frame) {
-        ASSERT(!stayWithin || !sibling || sibling->tree()->isDescendantOf(stayWithin));
+        ASSERT(!stayWithin || !sibling || sibling->tree().isDescendantOf(stayWithin));
         return sibling;
     }
 
     return 0;
 }
 
 Frame* FrameTree::traverseNextWithWrap(bool wrap) const
 {
     if (Frame* result = traverseNext())
         return result;
 
     if (wrap)
         return m_thisFrame->page()->mainFrame();
 
     return 0;
 }
 
 Frame* FrameTree::traversePreviousWithWrap(bool wrap) const
 {
     // FIXME: besides the wrap feature, this is just the traversePreviousNode algorithm
 
     if (Frame* prevSibling = previousSibling())
-        return prevSibling->tree()->deepLastChild();
+        return prevSibling->tree().deepLastChild();
     if (Frame* parentFrame = parent())
         return parentFrame;
 
     // no siblings, no parent, self==top
     if (wrap)
         return deepLastChild();
 
     // top view is always the last one in this ordering, so prev is nil without wrap
     return 0;
 }
 
 Frame* FrameTree::deepLastChild() const
 {
     Frame* result = m_thisFrame;
-    for (Frame* last = lastChild(); last; last = last->tree()->lastChild())
+    for (Frame* last = lastChild(); last; last = last->tree().lastChild())
         result = last;
 
     return result;
 }
 
 Frame* FrameTree::top() const
 {
     Frame* frame = m_thisFrame;
-    for (Frame* parent = m_thisFrame; parent; parent = parent->tree()->parent())
+    for (Frame* parent = m_thisFrame; parent; parent = parent->tree().parent())
         frame = parent;
     return frame;
 }
 
 } // namespace WebCore
 
 #ifndef NDEBUG
 
 static void printIndent(int indent)
 {
@@ skipping 13 matching lines @@
     printf("Frame %p %dx%d\n", frame, view ? view->width() : 0, view ? view->height() : 0);
     printIndent(indent);
     printf("  ownerElement=%p\n", frame->ownerElement());
     printIndent(indent);
     printf("  frameView=%p\n", view);
     printIndent(indent);
     printf("  document=%p\n", frame->document());
     printIndent(indent);
     printf("  uri=%s\n\n", frame->document()->documentURI().utf8().data());
 
-    for (WebCore::Frame* child = frame->tree()->firstChild(); child; child = child->tree()->nextSibling())
+    for (WebCore::Frame* child = frame->tree().firstChild(); child; child = child->tree().nextSibling())
         printFrames(child, targetFrame, indent + 1);
 }
 
 void showFrameTree(const WebCore::Frame* frame)
 {
     if (!frame) {
         printf("Null input frame\n");
         return;
     }
 
-    printFrames(frame->tree()->top(), frame, 0);
+    printFrames(frame->tree().top(), frame, 0);
 }
 
 #endif