Define the public interface for content browser SiteInstance. This interface is implemented by th...

content/browser/browsing_instance.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 CONTENT_BROWSER_BROWSING_INSTANCE_H_
 #define CONTENT_BROWSER_BROWSING_INSTANCE_H_
 #pragma once
 
 #include "base/hash_tables.h"
 #include "base/lazy_instance.h"
 #include "base/memory/ref_counted.h"
 #include "content/common/content_export.h"
 
 class GURL;
-class SiteInstance;
+class SiteInstanceImpl;
 
 namespace content {
 class BrowserContext;
+class SiteInstance;
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 //
 // BrowsingInstance class
 //
 // A browsing instance corresponds to the notion of a "unit of related browsing
 // contexts" in the HTML 5 spec.  Intuitively, it represents a collection of
 // tabs and frames that can have script connections to each other.  In that
 // sense, it reflects the user interface, and not the contents of the tabs and
@@ skipping 44 matching lines @@
   // Get the browser context to which this BrowsingInstance belongs.
   content::BrowserContext* browser_context() const { return browser_context_; }
 
   // Returns whether this BrowsingInstance has registered a SiteInstance for
   // the site of the given URL.
   bool HasSiteInstance(const GURL& url);
 
   // Get the SiteInstance responsible for rendering the given URL.  Should
   // create a new one if necessary, but should not create more than one
   // SiteInstance per site.
-  SiteInstance* GetSiteInstanceForURL(const GURL& url);
+  content::SiteInstance* GetSiteInstanceForURL(const GURL& url);
 
   // Adds the given SiteInstance to our map, to ensure that we do not create
   // another SiteInstance for the same site.
-  void RegisterSiteInstance(SiteInstance* site_instance);
+  void RegisterSiteInstance(content::SiteInstance* site_instance);
 
   // Removes the given SiteInstance from our map, after all references to it
   // have been deleted.  This means it is safe to create a new SiteInstance
   // if the user later visits a page from this site, within this
   // BrowsingInstance.
-  void UnregisterSiteInstance(SiteInstance* site_instance);
+  void UnregisterSiteInstance(content::SiteInstance* site_instance);
 
-  friend class SiteInstance;
+  friend class SiteInstanceImpl;
+  friend class content::SiteInstance;
 
   friend class base::RefCounted<BrowsingInstance>;
 
   // Virtual to allow tests to extend it.
   virtual ~BrowsingInstance();
 
  private:
   // Map of site to SiteInstance, to ensure we only have one SiteInstance per
-  typedef base::hash_map<std::string, SiteInstance*> SiteInstanceMap;
+  typedef base::hash_map<std::string, content::SiteInstance*> SiteInstanceMap;
 
   // Map of BrowserContext to SiteInstanceMap, for use in the process-per-site
   // model.
   typedef base::hash_map<content::BrowserContext*, SiteInstanceMap>
       ContextSiteInstanceMap;
 
   // Returns a pointer to the relevant SiteInstanceMap for this object.  If the
   // process-per-site model is in use, or if process-per-site-instance is in
   // use and |url| matches a site for which we always use one process (e.g.,
   // the new tab page), then this returns the SiteInstanceMap for the entire
   // browser context.  If not, this returns the BrowsingInstance's own private
   // SiteInstanceMap.
   SiteInstanceMap* GetSiteInstanceMap(content::BrowserContext* browser_context,
                                       const GURL& url);
 
   // Utility routine which removes the passed SiteInstance from the passed
   // SiteInstanceMap.
   bool RemoveSiteInstanceFromMap(SiteInstanceMap* map, const std::string& site,
-                                 SiteInstance* site_instance);
+                                 content::SiteInstance* site_instance);
 
   // Common browser context to which all SiteInstances in this BrowsingInstance
   // must belong.
   content::BrowserContext* const browser_context_;
 
   // Map of site to SiteInstance, to ensure we only have one SiteInstance per
   // site.  The site string should be the possibly_invalid_spec() of a GURL
-  // obtained with SiteInstance::GetSiteForURL.  Note that this map may not
+  // obtained with SiteInstanceImpl::GetSiteForURL.  Note that this map may not
   // contain every active SiteInstance, because a race exists where two
   // SiteInstances can be assigned to the same site.  This is ok in rare cases.
   // This field is only used if we are not using process-per-site.
   SiteInstanceMap site_instance_map_;
 
   // Global map of BrowserContext to SiteInstanceMap, for process-per-site.
   static base::LazyInstance<
       ContextSiteInstanceMap,
       base::LeakyLazyInstanceTraits<ContextSiteInstanceMap> >
           context_site_instance_map_;
 
   DISALLOW_COPY_AND_ASSIGN(BrowsingInstance);
 };
 
 #endif  // CONTENT_BROWSER_BROWSING_INSTANCE_H_