Handle interface to prerenders.

chrome/browser/prerender/prerender_contents.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_PRERENDER_PRERENDER_CONTENTS_H_
 #define CHROME_BROWSER_PRERENDER_PRERENDER_CONTENTS_H_
 #pragma once
 
 #include <list>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
 #include "base/time.h"
 #include "base/values.h"
 #include "chrome/browser/prerender/prerender_final_status.h"
+#include "chrome/browser/prerender/prerender_handle.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/common/referrer.h"
 #include "ui/gfx/size.h"
 
 class Profile;
 class TabContents;
 struct FaviconURL;
 
@@ skipping 60 matching lines @@
     // we record in MatchComplete but not Match.
     MATCH_COMPLETE_REPLACEMENT,
     // A prerender that is a MatchComplete dummy, early in the process of being
     // created. This prerender should not fail. Record for MatchComplete, but
     // not Match.
     MATCH_COMPLETE_REPLACEMENT_PENDING,
   };
 
   virtual ~PrerenderContents();
 
-  bool Init();
+  bool Init(WeakPrerenderHandle prerender);

[dominich, 2012/06/18 15:32:44]

PrerenderHandle* or const PrerenderHandle& or base::WeakPtr<PrerenderHandle>. I
don't know what a WeakPrerenderHandle is and explicit typing makes me happier.

 
   static Factory* CreateFactory();
 
   // Start rendering the contents in the prerendered state. If
   // |is_control_group| is true, this will go through some of the mechanics of
   // starting a prerender, without actually creating the RenderView.
   // |creator_child_id| is the id of the child process that caused the prerender
   // to be created, and is needed so that the prerendered URLs can be sent to it
   // so render-initiated navigations will swap in the prerendered page. |size|
   // indicates the rectangular dimensions that the prerendered page should be.
@@ skipping 40 matching lines @@
   // contents are destroyed.
   void set_final_status(FinalStatus final_status);
   FinalStatus final_status() const { return final_status_; }
 
   Origin origin() const { return origin_; }
   uint8 experiment_id() const { return experiment_id_; }
 
   base::TimeTicks load_start_time() const { return load_start_time_; }
 
   // Indicates whether this prerendered page can be used for the provided
-  // URL, i.e. whether there is a match. |matching_url| is optional and will be
-  // set to the URL that is found as a match if it is provided.
-  // TODO(gavinp,mmenke): Rework matching to be based on both the URL
-  // and the session WebStorage.
-  bool MatchesURL(const GURL& url, GURL* matching_url) const;
+  // |url| and |session_storage_namespace|.
+  bool Matches(
+      const GURL& url,
+      const content::SessionStorageNamespace* session_storage_namespace) const;
 
   void OnJSOutOfMemory();
   bool ShouldSuppressDialogs();
 
   // content::WebContentsObserver implementation.
   virtual void DidStopLoading() OVERRIDE;
   virtual void DidStartProvisionalLoadForFrame(
       int64 frame_id,
       bool is_main_frame,
       const GURL& validated_url,
@@ skipping 35 matching lines @@
   void CommitHistory(TabContents* tab);
 
   base::Value* GetAsValue() const;
 
   // Returns whether a pending cross-site navigation is happening.
   // This could happen with renderer-issued navigations, such as a
   // MouseEvent being dispatched by a link to a website installed as an app.
   bool IsCrossSiteNavigationPending() const;
 
   // Adds a pending prerender to the list.
-  virtual void AddPendingPrerender(const GURL& url,
-                                   const content::Referrer& referrer,
-                                   const gfx::Size& size);
+  virtual PrerenderHandle AddPendingPrerender(const GURL& url,

[dominich, 2012/06/18 15:32:44]

so this will copy the PrerenderHandle on return? That is surprising.

[gavinp, 2012/06/18 16:40:48]

The PrerenderHandle is a machine word in size.

+                                              const content::Referrer& referrer,
+                                              const gfx::Size& size);
 
   // Returns true if |url| corresponds to a pending prerender.
   bool IsPendingEntry(const GURL& url) const;
 
   // Reissues any pending prerender requests from the prerendered page.  Also
   // clears the list of pending requests.
   void StartPendingPrerenders();
 
  protected:
   PrerenderContents(PrerenderManager* prerender_manager,
@@ skipping 42 matching lines @@
 
   // Returns the ProcessMetrics for the render process, if it exists.
   base::ProcessMetrics* MaybeGetProcessMetrics();
 
   // The prerender manager owning this object.
   PrerenderManager* prerender_manager_;
 
   // The prerender tracker tracking prerenders.
   PrerenderTracker* prerender_tracker_;
 
+  WeakPrerenderHandle prerender_;
+
   // The URL being prerendered.
   GURL prerender_url_;
 
   // The referrer.
   content::Referrer referrer_;
 
   // The profile being used
   Profile* profile_;
 
   // Information about the title and URL of the page that this class as a
@@ skipping 64 matching lines @@
 
   // The size of the WebView from the launching page.
   gfx::Size size_;
 
   DISALLOW_COPY_AND_ASSIGN(PrerenderContents);
 };
 
 }  // namespace prerender
 
 #endif  // CHROME_BROWSER_PRERENDER_PRERENDER_CONTENTS_H_