Change FrameTree to return Frames instead of LocalFrames.

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,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, write to
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
 
 #include "config.h"
 #include "core/page/FrameTree.h"
 
 #include "core/dom/Document.h"
 #include "core/frame/FrameClient.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/LocalFrame.h"
+#include "core/frame/RemoteFrame.h"
+#include "core/frame/RemoteFrameView.h"
 #include "core/page/Page.h"
 #include "wtf/Vector.h"
 #include "wtf/text/CString.h"
 #include "wtf/text/StringBuilder.h"
 
 using std::swap;
 
 namespace WebCore {
 
 namespace {
 
 const unsigned invalidChildCount = ~0;
 
 } // namespace
 
 FrameTree::FrameTree(Frame* thisFrame)
     : m_thisFrame(thisFrame)
     , m_scopedChildCount(invalidChildCount)
 {
 }
 
 FrameTree::~FrameTree()
 {
     // FIXME: Why is this here? Doesn't this parallel what we already do in ~LocalFrame?
-    for (LocalFrame* child = firstChild(); child; child = child->tree().nextSibling())
-        child->setView(nullptr);
+    for (Frame* child = firstChild(); child; child = child->tree().nextSibling()) {
+        if (child->isLocalFrame())
+            toLocalFrame(child)->setView(nullptr);
+        else if (child->isRemoteFrame())
+            toRemoteFrame(child)->setView(nullptr);
+    }
 }
 
 void FrameTree::setName(const AtomicString& name, const AtomicString& fallbackName)
 {
     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.isEmpty() ? fallbackName : name);
 }
 
-LocalFrame* FrameTree::parent() const
+Frame* FrameTree::parent() const
 {
     if (!m_thisFrame->client())
         return 0;
-    // FIXME: Temporary hack to stage converting locations that really should be Frame.
-    return toLocalFrame(m_thisFrame->client()->parent());
+    return m_thisFrame->client()->parent();
 }
 
-LocalFrame* FrameTree::top() const
+Frame* FrameTree::top() const
 {
     // FIXME: top() should never return null, so here are some hacks to deal
     // with EmptyFrameLoaderClient and cases where the frame is detached
     // already...
     if (!m_thisFrame->client())
-        return toLocalFrame(m_thisFrame);
-    // FIXME: Temporary hack to stage converting locations that really should be Frame.
-    LocalFrame* candidate = toLocalFrame(m_thisFrame->client()->top());
-    return candidate ? candidate : toLocalFrame(m_thisFrame);
+        return m_thisFrame;
+    Frame* candidate = m_thisFrame->client()->top();
+    return candidate ? candidate : m_thisFrame;
 }
 
-LocalFrame* FrameTree::previousSibling() const
+Frame* FrameTree::previousSibling() const
 {
     if (!m_thisFrame->client())
         return 0;
-    // FIXME: Temporary hack to stage converting locations that really should be Frame.
-    return toLocalFrame(m_thisFrame->client()->previousSibling());
+    return m_thisFrame->client()->previousSibling();
 }
 
-LocalFrame* FrameTree::nextSibling() const
+Frame* FrameTree::nextSibling() const
 {
     if (!m_thisFrame->client())
         return 0;
-    // FIXME: Temporary hack to stage converting locations that really should be Frame.
-    return toLocalFrame(m_thisFrame->client()->nextSibling());
+    return m_thisFrame->client()->nextSibling();
 }
 
-LocalFrame* FrameTree::firstChild() const
+Frame* FrameTree::firstChild() const
 {
     if (!m_thisFrame->client())
         return 0;
-    // FIXME: Temporary hack to stage converting locations that really should be Frame.
-    return toLocalFrame(m_thisFrame->client()->firstChild());
+    return m_thisFrame->client()->firstChild();
 }
 
-LocalFrame* FrameTree::lastChild() const
+Frame* FrameTree::lastChild() const
 {
     if (!m_thisFrame->client())
         return 0;
-    // FIXME: Temporary hack to stage converting locations that really should be Frame.
-    return toLocalFrame(m_thisFrame->client()->lastChild());
+    return m_thisFrame->client()->lastChild();
 }
 
 bool FrameTree::uniqueNameExists(const AtomicString& name) const
 {
-    for (LocalFrame* frame = top(); frame; frame = frame->tree().traverseNext()) {
+    for (Frame* frame = top(); frame; frame = frame->tree().traverseNext()) {
         if (frame->tree().uniqueName() == name)
             return true;
     }
     return false;
 }
 
 AtomicString FrameTree::uniqueChildName(const AtomicString& requestedName) const
 {
     if (!requestedName.isEmpty() && !uniqueNameExists(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<LocalFrame*, 16> chain;
-    LocalFrame* frame;
-    for (frame = toLocalFrame(m_thisFrame); frame; frame = frame->tree().parent()) {
+    Vector<Frame*, 16> chain;
+    Frame* frame;
+    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));
     }
     for (int i = chain.size() - 1; i >= 0; --i) {
         frame = chain[i];
         name.append('/');
         name.append(frame->tree().uniqueName());
     }
 
     name.appendLiteral("/<!--frame");
     name.appendNumber(childCount() - 1);
     name.appendLiteral("-->-->");
 
     return name.toAtomicString();
 }
 
-LocalFrame* FrameTree::scopedChild(unsigned index) const
+Frame* FrameTree::scopedChild(unsigned index) const
 {
+    if (!m_thisFrame->isLocalFrame())
+        return 0;
     TreeScope* scope = toLocalFrame(m_thisFrame)->document();
     if (!scope)
         return 0;
 
     unsigned scopedIndex = 0;
-    for (LocalFrame* result = firstChild(); result; result = result->tree().nextSibling()) {
-        if (result->inScope(scope)) {
+    for (Frame* result = firstChild(); result; result = result->tree().nextSibling()) {
+        if (result->isLocalFrame() && toLocalFrame(result)->inScope(scope)) {
             if (scopedIndex == index)
                 return result;
             scopedIndex++;
         }
     }
 
     return 0;
 }
 
-LocalFrame* FrameTree::scopedChild(const AtomicString& name) const
+Frame* FrameTree::scopedChild(const AtomicString& name) const
 {
+    if (!m_thisFrame->isLocalFrame())
+        return 0;
+
     TreeScope* scope = toLocalFrame(m_thisFrame)->document();
     if (!scope)
         return 0;
 
-    for (LocalFrame* child = firstChild(); child; child = child->tree().nextSibling())
-        if (child->tree().name() == name && child->inScope(scope))
+    for (Frame* child = firstChild(); child; child = child->tree().nextSibling())
+        if (child->tree().name() == name && child->isLocalFrame() && toLocalFrame(child)->inScope(scope))
             return child;
     return 0;
 }
 
 inline unsigned FrameTree::scopedChildCount(TreeScope* scope) const
 {
     if (!scope)
         return 0;
 
     unsigned scopedCount = 0;
-    for (LocalFrame* result = firstChild(); result; result = result->tree().nextSibling()) {
-        if (result->inScope(scope))
+    for (Frame* result = firstChild(); result; result = result->tree().nextSibling()) {
+        if (result->isLocalFrame() && toLocalFrame(result)->inScope(scope))
             scopedCount++;
     }
 
     return scopedCount;
 }
 
 unsigned FrameTree::scopedChildCount() const
 {
     if (m_scopedChildCount == invalidChildCount)
         m_scopedChildCount = scopedChildCount(toLocalFrame(m_thisFrame)->document());
     return m_scopedChildCount;
 }
 
 void FrameTree::invalidateScopedChildCount()
 {
     m_scopedChildCount = invalidChildCount;
 }
 
 unsigned FrameTree::childCount() const
 {
     unsigned count = 0;
-    for (LocalFrame* result = firstChild(); result; result = result->tree().nextSibling())
+    for (Frame* result = firstChild(); result; result = result->tree().nextSibling())
         ++count;
     return count;
 }
 
-LocalFrame* FrameTree::child(const AtomicString& name) const
+Frame* FrameTree::child(const AtomicString& name) const
 {
-    for (LocalFrame* child = firstChild(); child; child = child->tree().nextSibling())
+    for (Frame* child = firstChild(); child; child = child->tree().nextSibling())
         if (child->tree().name() == name)
             return child;
     return 0;
 }
 
-LocalFrame* FrameTree::find(const AtomicString& name) const
+Frame* FrameTree::find(const AtomicString& name) const
 {
     if (name == "_self" || name == "_current" || name.isEmpty())
-        return toLocalFrame(m_thisFrame);
+        return m_thisFrame;
 
     if (name == "_top")
         return top();
 
     if (name == "_parent")
-        return parent() ? parent() : toLocalFrame(m_thisFrame);
+        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 (LocalFrame* frame = toLocalFrame(m_thisFrame); frame; frame = frame->tree().traverseNext(toLocalFrame(m_thisFrame)))
+    for (Frame* frame = m_thisFrame; frame; frame = frame->tree().traverseNext(m_thisFrame))
         if (frame->tree().name() == 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 (LocalFrame* frame = page->mainFrame(); frame; frame = frame->tree().traverseNext())
+    for (Frame* frame = page->mainFrame(); frame; frame = frame->tree().traverseNext())
         if (frame->tree().name() == 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::ordinaryPages();
     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 (LocalFrame* frame = otherPage->mainFrame(); frame; frame = frame->tree().traverseNext()) {
+            for (Frame* frame = otherPage->mainFrame(); frame; frame = frame->tree().traverseNext()) {
                 if (frame->tree().name() == name)
                     return frame;
             }
         }
     }
 
     return 0;
 }
 
-bool FrameTree::isDescendantOf(const LocalFrame* ancestor) const
+bool FrameTree::isDescendantOf(const Frame* ancestor) const
 {
     if (!ancestor)
         return false;
 
     if (m_thisFrame->page() != ancestor->page())
         return false;
 
-    for (LocalFrame* frame = toLocalFrame(m_thisFrame); frame; frame = frame->tree().parent())
+    for (Frame* frame = m_thisFrame; frame; frame = frame->tree().parent())
         if (frame == ancestor)
             return true;
     return false;
 }
 
-LocalFrame* FrameTree::traverseNext(const LocalFrame* stayWithin) const
+Frame* FrameTree::traverseNext(const Frame* stayWithin) const
 {
-    LocalFrame* child = firstChild();
+    Frame* child = firstChild();
     if (child) {
         ASSERT(!stayWithin || child->tree().isDescendantOf(stayWithin));
         return child;
     }
 
     if (m_thisFrame == stayWithin)
         return 0;
 
-    LocalFrame* sibling = nextSibling();
+    Frame* sibling = nextSibling();
     if (sibling) {
         ASSERT(!stayWithin || sibling->tree().isDescendantOf(stayWithin));
         return sibling;
     }
 
-    LocalFrame* frame = toLocalFrame(m_thisFrame);
+    Frame* frame = m_thisFrame;
     while (!sibling && (!stayWithin || frame->tree().parent() != stayWithin)) {
         frame = frame->tree().parent();
         if (!frame)
             return 0;
         sibling = frame->tree().nextSibling();
     }
 
     if (frame) {
         ASSERT(!stayWithin || !sibling || sibling->tree().isDescendantOf(stayWithin));
         return sibling;
     }
 
     return 0;
 }
 
-LocalFrame* FrameTree::traverseNextWithWrap(bool wrap) const
+Frame* FrameTree::traverseNextWithWrap(bool wrap) const
 {
-    if (LocalFrame* result = traverseNext())
+    if (Frame* result = traverseNext())
         return result;
 
     if (wrap)
         return m_thisFrame->page()->mainFrame();
 
     return 0;
 }
 
-LocalFrame* FrameTree::traversePreviousWithWrap(bool wrap) const
+Frame* FrameTree::traversePreviousWithWrap(bool wrap) const
 {
     // FIXME: besides the wrap feature, this is just the traversePreviousNode algorithm
 
-    if (LocalFrame* prevSibling = previousSibling())
+    if (Frame* prevSibling = previousSibling())
         return prevSibling->tree().deepLastChild();
-    if (LocalFrame* parentFrame = parent())
+    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;
 }
 
-LocalFrame* FrameTree::deepLastChild() const
+Frame* FrameTree::deepLastChild() const
 {
-    LocalFrame* result = toLocalFrame(m_thisFrame);
-    for (LocalFrame* last = lastChild(); last; last = last->tree().lastChild())
+    Frame* result = m_thisFrame;
+    for (Frame* last = lastChild(); last; last = last->tree().lastChild())
         result = last;
 
     return result;
 }
 
 } // namespace WebCore
 
 #ifndef NDEBUG
 
 static void printIndent(int indent)
 {
     for (int i = 0; i < indent; ++i)
         printf("    ");
 }
 
-static void printFrames(const WebCore::LocalFrame* frame, const WebCore::LocalFrame* targetFrame, int indent)
+static void printFrames(const WebCore::Frame* frame, const WebCore::Frame* targetFrame, int indent)
 {
     if (frame == targetFrame) {
         printf("--> ");
         printIndent(indent - 1);
     } else
         printIndent(indent);
 
-    WebCore::FrameView* view = frame->view();
-    printf("LocalFrame %p %dx%d\n", frame, view ? view->width() : 0, view ? view->height() : 0);
+    WebCore::FrameView* view = frame->isLocalFrame() ? toLocalFrame(frame)->view() : 0;
+    printf("Frame %p %dx%d\n", frame, view ? view->width() : 0, view ? view->height() : 0);
     printIndent(indent);
     printf("  owner=%p\n", frame->owner());
     printIndent(indent);
     printf("  frameView=%p\n", view);
     printIndent(indent);
-    printf("  document=%p\n", frame->document());
+    printf("  document=%p\n", frame->isLocalFrame() ? toLocalFrame(frame)->document() : 0);
     printIndent(indent);
-    printf("  uri=%s\n\n", frame->document()->url().string().utf8().data());
+    printf("  uri=%s\n\n", frame->isLocalFrame() ? toLocalFrame(frame)->document()->url().string().utf8().data() : 0);
 
-    for (WebCore::LocalFrame* 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::LocalFrame* frame)
+void showFrameTree(const WebCore::Frame* frame)
 {
     if (!frame) {
         printf("Null input frame\n");
         return;
     }
 
     printFrames(frame->tree().top(), frame, 0);
 }
 
 #endif