Add a BeforeDestroyFrame notification method to WebViewDelegate

webkit/glue/webframe_impl.cc

 /*
  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 123 matching lines @@
 #include "base/string_util.h"
 #include "net/base/net_errors.h"
 #include "skia/ext/bitmap_platform_device.h"
 #include "skia/ext/platform_canvas.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebConsoleMessage.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebFindOptions.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebRect.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebScriptSource.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebSize.h"
 #include "webkit/glue/alt_error_page_resource_fetcher.h"
+#include "webkit/glue/chrome_client_impl.h"
 #include "webkit/glue/dom_operations.h"
 #include "webkit/glue/dom_operations_private.h"
 #include "webkit/glue/feed.h"
 #include "webkit/glue/glue_serialize.h"
 #include "webkit/glue/glue_util.h"
 #include "webkit/glue/webappcachecontext.h"
 #include "webkit/glue/webdatasource_impl.h"
 #include "webkit/glue/weberror_impl.h"
 #include "webkit/glue/webframe_impl.h"
 #include "webkit/glue/webhistoryitem_impl.h"
@@ skipping 220 matching lines @@
   StatsCounter(kWebFrameActiveCount).Decrement();
   live_object_count_--;
 
   CancelPendingScopingEffort();
   ClearPasswordListeners();
 }
 
 // WebFrame -------------------------------------------------------------------
 
 void WebFrameImpl::InitMainFrame(WebViewImpl* webview_impl) {
-  webview_impl_ = webview_impl;
-
   RefPtr<Frame> frame =
-      Frame::create(webview_impl_->page(), 0, &frame_loader_client_);
+      Frame::create(webview_impl->page(), 0, &frame_loader_client_);
   frame_ = frame.get();
 
   // Add reference on behalf of FrameLoader.  See comments in
   // WebFrameLoaderClient::frameLoaderDestroyed for more info.
   AddRef();
 
   // We must call init() after frame_ is assigned because it is referenced
   // during init().
   frame_->init();
 
@@ skipping 72 matching lines @@
     RefPtr<HistoryItem> current_item = frame_->loader()->currentHistoryItem();
 
     // If there is no current_item, which happens when we are navigating in
     // session history after a crash, we need to manufacture one otherwise
     // WebKit hoarks. This is probably the wrong thing to do, but it seems to
     // work.
     if (!current_item) {
       current_item = HistoryItem::create();
       current_item->setLastVisitWasFailure(true);
       frame_->loader()->setCurrentHistoryItem(current_item);
-      webview_impl_->SetCurrentHistoryItem(current_item.get());
+      GetWebViewImpl()->SetCurrentHistoryItem(current_item.get());
     }
 
     frame_->loader()->goToItem(request_impl->history_item().get(),
                                WebCore::FrameLoadTypeIndexedBackForward);
   } else if (resource_request.cachePolicy() == ReloadIgnoringCacheData) {
     frame_->loader()->reload();
   } else {
     frame_->loader()->load(resource_request, false);
   }
 
@@ skipping 132 matching lines @@
   }
 
   return feedlist;
 }
 
 bool WebFrameImpl::GetPreviousHistoryState(std::string* history_state) const {
   // We use the previous item here because documentState (filled-out forms)
   // only get saved to history when it becomes the previous item.  The caller
   // is expected to query the history state after a navigation occurs, after
   // the desired history item has become the previous entry.
-  RefPtr<HistoryItem> item = webview_impl_->GetPreviousHistoryItem();
+  RefPtr<HistoryItem> item = GetWebViewImpl()->GetPreviousHistoryItem();
   if (!item)
     return false;
 
   static StatsCounterTimer history_timer("GetHistoryTimer");
   StatsScope<StatsCounterTimer> history_scope(history_timer);
 
   webkit_glue::HistoryItemToString(item, history_state);
   return true;
 }
 
@@ skipping 180 matching lines @@
 }
 
 bool WebFrameImpl::GetInViewSourceMode() const {
   if (frame_)
     return frame_->inViewSourceMode();
 
   return false;
 }
 
 WebView* WebFrameImpl::GetView() const {
-  return webview_impl_;
+  return GetWebViewImpl();
 }
 
 std::string WebFrameImpl::GetSecurityOrigin() const {
   if (frame_) {
     if (frame_->document())
       return webkit_glue::StringToStdString(
           frame_->document()->securityOrigin()->toString());
   }
   return "null";
 }
@@ skipping 220 matching lines @@
 
     // Erase all previous tickmarks and highlighting.
     InvalidateArea(INVALIDATE_ALL);
   }
 
   return found;
 }
 
 int WebFrameImpl::OrdinalOfFirstMatchForFrame(WebFrameImpl* frame) const {
   int ordinal = 0;
+  WebViewImpl* web_view = GetWebViewImpl();
   WebFrameImpl* const main_frame_impl =
     static_cast<WebFrameImpl*>(GetView()->GetMainFrame());
   // Iterate from the main frame up to (but not including) |frame| and
   // add up the number of matches found so far.
   for (WebFrameImpl* it = main_frame_impl;
        it != frame;
        it = static_cast<WebFrameImpl*>(
-           webview_impl_->GetNextFrameAfter(it, true))) {
+           web_view->GetNextFrameAfter(it, true))) {
     if (it->last_match_count_ > 0)
       ordinal += it->last_match_count_;
   }
 
   return ordinal;
 }
 
 bool WebFrameImpl::ShouldScopeMatches(const string16& search_text) {
   // Don't scope if we can't find a frame or if the frame is not visible.
   // The user may have closed the tab/application, so abort.
@@ skipping 426 matching lines @@
   DCHECK(page);
 
   DCHECK(page->mainFrame() != NULL);
 
   bool is_main_frame = frame_ == page->mainFrame();
   if (is_main_frame && frame_->view())
     frame_->view()->setParentVisible(false);
 
   frame_->setView(0);
 
+  WebViewImpl* web_view = GetWebViewImpl();
+
   WebCore::FrameView* view;
   if (is_main_frame) {
-    IntSize size = webkit_glue::WebSizeToIntSize(webview_impl_->size());
+    IntSize size = webkit_glue::WebSizeToIntSize(web_view->size());
     view = new FrameView(frame_, size);
   } else {
     view = new FrameView(frame_);
   }
 
   frame_->setView(view);
 
-  if (webview_impl_->GetIsTransparent())
+  if (web_view->GetIsTransparent())
     view->setTransparent(true);
 
   // TODO(darin): The Mac code has a comment about this possibly being
   // unnecessary.  See installInFrame in WebCoreFrameBridge.mm
   if (frame_->ownerRenderer())
     frame_->ownerRenderer()->setWidget(view);
 
   if (HTMLFrameOwnerElement* owner = frame_->ownerElement()) {
     view->setCanHaveScrollbars(
         owner->scrollingMode() != WebCore::ScrollbarAlwaysOff);
   }
 
   if (is_main_frame)
     view->setParentVisible(true);
 
   // FrameViews are created with a refcount of 1 so it needs releasing after we
   // assign it to a RefPtr.
   view->deref();
 }
 
 // static
 WebFrameImpl* WebFrameImpl::FromFrame(WebCore::Frame* frame) {
   return static_cast<WebFrameLoaderClient*>(
       frame->loader()->client())->webframe();
 }
 
+WebViewImpl* WebFrameImpl::GetWebViewImpl() const {
+  if (!frame_ || !frame_->page())
+    return NULL;
+
+  // There are cases where a Frame may outlive its associated Page.  Get the
+  // WebViewImpl by accessing it indirectly through the Frame's Page so that we
+  // don't have to worry about cleaning up the WebFrameImpl -> WebViewImpl
+  // pointer. WebCore already clears the Frame's Page pointer when the Page is
+  // destroyed by the WebViewImpl.
+  return static_cast<ChromeClientImpl*>(
+      frame_->page()->chrome()->client())->webview();
+}
+
 // WebFrame --------------------------------------------------------------------
 
 void WebFrameImpl::Layout() {
   // layout this frame
   FrameView* view = frame_->view();
   if (view)
     view->layout();
 
   // recursively layout child frames
   Frame* child = frame_->tree()->firstChild();
@@ skipping 59 matching lines @@
   return true;
 }
 
 bool WebFrameImpl::IsLoading() {
   // I'm assuming this does what we want.
   return frame_->loader()->isLoading();
 }
 
 void WebFrameImpl::Closing() {
   alt_error_page_fetcher_.reset();
-  webview_impl_ = NULL;
   frame_ = NULL;
 }
 
 void WebFrameImpl::DidReceiveData(DocumentLoader* loader,
                                   const char* data, int length) {
   // Set the text encoding.  This calls begin() for us.  It is safe to call
   // this multiple times (Mac does: page/mac/WebCoreFrameBridge.mm).
   bool user_chosen = true;
   String encoding = frame_->loader()->documentLoader()->overrideEncoding();
   if (encoding.isNull()) {
     user_chosen = false;
     encoding = loader->response().textEncodingName();
   }
   frame_->loader()->setEncoding(encoding, user_chosen);
 
   // NOTE: mac only does this if there is a document
   frame_->loader()->addData(data, length);
 
   // It's possible that we get a DNS failure followed by a second load that
   // succeeds before we hear back from the alternate error page server.  In
   // that case, cancel the alt error page download.
   alt_error_page_fetcher_.reset();
 }
 
 void WebFrameImpl::DidFail(const ResourceError& error, bool was_provisional) {
   // Make sure we never show errors in view source mode.
   SetInViewSourceMode(false);
 
-  WebViewDelegate* delegate = webview_impl_->delegate();
+  WebViewImpl* web_view = GetWebViewImpl();
+  WebViewDelegate* delegate = web_view->delegate();
   if (delegate) {
     WebErrorImpl web_error(error);
     if (was_provisional) {
-      delegate->DidFailProvisionalLoadWithError(webview_impl_, web_error,
-                                                this);
+      delegate->DidFailProvisionalLoadWithError(web_view, web_error, this);
     } else {
-      delegate->DidFailLoadWithError(webview_impl_, web_error, this);
+      delegate->DidFailLoadWithError(web_view, web_error, this);
     }
   }
 }
 
 void WebFrameImpl::LoadAlternateHTMLErrorPage(const WebRequest* request,
                                               const WebError& error,
                                               const GURL& error_page_url,
                                               bool replace,
                                               const GURL& fake_url) {
   // Load alternate HTML in place of the previous request.  We create a copy of
   // the original request so we can replace its URL with a dummy URL.  That
   // prevents other web content from the same origin as the failed URL to
   // script the error page.
   scoped_ptr<WebRequest> failed_request(request->Clone());
   failed_request->SetURL(fake_url);
 
   LoadAlternateHTMLString(failed_request.get(), std::string(),
                           error.GetFailedURL(), replace);
 
   WebErrorImpl weberror_impl(error);
   alt_error_page_fetcher_.reset(
-      new AltErrorPageResourceFetcher(webview_impl_, weberror_impl, this,
+      new AltErrorPageResourceFetcher(GetWebViewImpl(), weberror_impl, this,
                                       error_page_url));
 }
 
 void WebFrameImpl::ExecuteScript(const WebScriptSource& source) {
   frame_->loader()->executeScript(
       WebCore::ScriptSourceCode(
           webkit_glue::WebStringToString(source.code),
           webkit_glue::WebURLToKURL(source.url),
           source.startLine));
 }
@@ skipping 54 matching lines @@
   scoped_refptr<WebFrameImpl> webframe = new WebFrameImpl();
 
   // Add an extra ref on behalf of the Frame/FrameLoader, which references the
   // WebFrame via the FrameLoaderClient interface. See the comment at the top
   // of this file for more info.
   webframe->AddRef();
 
   RefPtr<Frame> child_frame = Frame::create(
       frame_->page(), owner_element, &webframe->frame_loader_client_);
   webframe->frame_ = child_frame.get();
-  webframe->webview_impl_ = webview_impl_;
 
   child_frame->tree()->setName(request.frameName());
 
   frame_->tree()->appendChild(child_frame);
 
   // Frame::init() can trigger onload event in the parent frame,
   // which may detach this frame and trigger a null-pointer access
   // in FrameTree::removeChild. Move init() after appendChild call
   // so that webframe->frame_ is in the tree before triggering
   // onload event handler.
@@ skipping 177 matching lines @@
   return password_listeners_.get(input_element);
 }
 
 void WebFrameImpl::ClearPasswordListeners() {
   for (PasswordListenerMap::iterator iter = password_listeners_.begin();
        iter != password_listeners_.end(); ++iter) {
     delete iter->second;
   }
   password_listeners_.clear();
 }