Added prerendering to omnibox.

chrome/browser/prerender/prerender_manager.h

 // Copyright (c) 2011 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_MANAGER_H_
 #define CHROME_BROWSER_PRERENDER_PRERENDER_MANAGER_H_
 #pragma once
 
 #include <list>
 #include <map>
 #include <vector>
 
 #include "base/hash_tables.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/scoped_vector.h"
 #include "base/memory/weak_ptr.h"
 #include "base/task.h"
 #include "base/threading/non_thread_safe.h"
 #include "base/time.h"
 #include "base/timer.h"
 #include "chrome/browser/prerender/prerender_contents.h"
+#include "chrome/browser/prerender/prerender_origin.h"
 #include "googleurl/src/gurl.h"
 
 class Profile;
 class TabContents;
 
 #if defined(COMPILER_GCC)
 
 namespace __gnu_cxx {
 template <>
 struct hash<TabContents*> {
@@ skipping 12 matching lines @@
 
 // Adds either a preload or a pending preload to the PrerenderManager.
 // Must be called on the UI thread.
 void HandleTag(
     const base::WeakPtr<PrerenderManager>& prerender_manager,
     int render_process_id,
     int render_view_id,
     const GURL& url,
     const GURL& referrer);
 
-void DestroyPreloadForRenderView(
+void DestroyPrerenderForRenderView(
     const base::WeakPtr<PrerenderManager>& prerender_manager_weak_ptr,
     int child_id,
     int route_id,
     FinalStatus final_status);
 
 // PrerenderManager is responsible for initiating and keeping prerendered
 // views of webpages. All methods must be called on the UI thread unless
 // indicated otherwise.
 class PrerenderManager : public base::SupportsWeakPtr<PrerenderManager>,
                          public base::NonThreadSafe {
@@ skipping 14 matching lines @@
     CLEAR_PRERENDER_CONTENTS = 0x1 << 0,
     CLEAR_PRERENDER_HISTORY = 0x1 << 1,
     CLEAR_MAX = 0x1 << 2
   };
 
   // Owned by a Profile object for the lifetime of the profile.
   PrerenderManager(Profile* profile, PrerenderTracker* prerender_tracker);
 
   virtual ~PrerenderManager();
 
-  // Preloads |url| if valid.  |child_route_id_pair| identifies the
+  // Starts a prerender for |url| if valid. |child_route_id_pair| identifies the
   // RenderViewHost that the prerender request came from and is used to
   // set the initial window size of the RenderViewHost used for prerendering.
   // Returns true if the URL was added, false if it was not.
   // If |child_route_id_pair| itself is prerendering, adds the preloads as
-  // a pending preload.
-  bool AddPreload(
+  // a pending preload. |origin| enumerates the source of the prerender for
+  // data-tracking purposes.
+  bool AddPrerenderFromPage(
+      Origin origin,
       const std::pair<int, int>& child_route_id_pair,
       const GURL& url,
       const GURL& referrer);
 
-  // Destroy all preloads for the given child route id pair and assign a final
+  // Starts a prerender for |url| if valid. As the prerender request is coming
+  // from a source without a RenderViewHost (ie, the omnibox) we don't have a
+  // child or route id, or a referrer. This method uses sensible values for
+  // those.
+  bool AddPrerender(Origin origin, const GURL& url);
+
+  // Destroy all prerenders for the given child route id pair and assign a final
   // status to them.
-  virtual void DestroyPreloadForChildRouteIdPair(
+  virtual void DestroyPrerenderForChildRouteIdPair(
       const std::pair<int, int>& child_route_id_pair,
       FinalStatus final_status);
 
   // For a given TabContents that wants to navigate to the URL supplied,
-  // determines whether a preloaded version of the URL can be used,
+  // determines whether a prerendered version of the URL can be used,
   // and substitutes the prerendered RVH into the TabContents.  Returns
   // whether or not a prerendered RVH could be used or not.
-  bool MaybeUsePreloadedPage(TabContents* tab_contents,
-                             const GURL& url,
-                             bool has_opener_set);
+  bool MaybeUsePrerenderedPage(TabContents* tab_contents,
+                               const GURL& url,
+                               bool has_opener_set);
 
   // Moves a PrerenderContents to the pending delete list from the list of
   // active prerenders when prerendering should be cancelled.
   void MoveEntryToPendingDelete(PrerenderContents* entry);
 
   // Checks if the PrerenderContents has been added to the pending delete list.
   bool IsPendingDelete(PrerenderContents* entry) const;
 
   // Retrieves the PrerenderContents object for the specified URL, if it
   // has been prerendered.  The caller will then have ownership of the
@@ skipping 110 matching lines @@
   friend class base::RefCountedThreadSafe<PrerenderManager>;
 
   struct PrerenderContentsData;
   struct NavigationRecord;
 
   class OnCloseTabContentsDeleter;
 
   // Adds a pending preload issued by the prerendering RenderView identified by
   // |child_route_id_pair|.  If and when that prerendering RenderView is used,
   // the specified prerender will start.
-  void AddPendingPreload(const std::pair<int, int>& child_route_id_pair,
-                         const GURL& url,
-                         const GURL& referrer);
+  void AddPendingPrerender(Origin origin,
+                           const std::pair<int, int>& child_route_id_pair,
+                           const GURL& url,
+                           const GURL& referrer);
 
   // Starts scheduling periodic cleanups.
   void StartSchedulingPeriodicCleanups();
   // Stops scheduling periodic cleanups if they're no longer needed.
   void MaybeStopSchedulingPeriodicCleanups();
 
   // Deletes stale and cancelled prerendered PrerenderContents, as well as
   // TabContents that have been replaced by prerendered TabContents.
   // Also identifies and kills PrerenderContents that use too much
   // resources.
   void PeriodicCleanup();
 
   // Posts a task to call PeriodicCleanup.  Results in quicker destruction of
   // objects.  If |this| is deleted before the task is run, the task will
   // automatically be cancelled.
   void PostCleanupTask();
 
   bool IsPrerenderElementFresh(const base::Time start) const;
   void DeleteOldEntries();
   virtual base::Time GetCurrentTime() const;
   virtual base::TimeTicks GetCurrentTimeTicks() const;
-  virtual PrerenderContents* CreatePrerenderContents(
-      const GURL& url,
-      const GURL& referrer);
+  virtual PrerenderContents* CreatePrerenderContents(const GURL& url,
+                                                     const GURL& referrer,
+                                                     Origin origin);
 
   // Deletes any PrerenderContents that have been added to the pending delete
   // list.
   void DeletePendingDeleteEntries();
 
   // Finds the specified PrerenderContents and returns it, if it exists.
   // Returns NULL otherwise.  Unlike GetEntry, the PrerenderManager maintains
   // ownership of the PrerenderContents.
   PrerenderContents* FindEntry(const GURL& url);
 
   // Returns the iterator to the PrerenderContentsData entry that is being
   // prerendered from the given child route id pair.
   std::list<PrerenderContentsData>::iterator
       FindPrerenderContentsForChildRouteIdPair(
           const std::pair<int, int>& child_route_id_pair);
 
   // Returns whether the PrerenderManager is currently within the prerender
   // window - effectively, up to 30 seconds after a prerender tag has been
   // observed.
   bool WithinWindow() const;
 
   // Called when removing a preload to ensure we clean up any pending preloads
   // that might remain in the map.
-  void RemovePendingPreload(PrerenderContents* entry);
+  void RemovePendingPrerender(PrerenderContents* entry);
 
   bool DoesRateLimitAllowPrerender() const;
 
   // Deletes old TabContents that have been replaced by prerendered ones.  This
   // is needed because they're replaced in a callback from the old TabContents,
   // so cannot immediately be deleted.
   void DeleteOldTabContents();
 
   // Cleans up old NavigationRecord's.
   void CleanUpOldNavigations();
@@ skipping 80 matching lines @@
   ScopedVector<OnCloseTabContentsDeleter> on_close_tab_contents_deleters_;
 
   scoped_ptr<PrerenderHistory> prerender_history_;
 
   DISALLOW_COPY_AND_ASSIGN(PrerenderManager);
 };
 
 }  // namespace prerender
 
 #endif  // CHROME_BROWSER_PRERENDER_PRERENDER_MANAGER_H_