ios/public/provider/chrome/browser/browser_state/chrome_browser_state.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef IOS_PUBLIC_PROVIDER_CHROME_BROWSER_BROWSER_STATE_CHROME_BROWSER_STATE_H_
   6 #define IOS_PUBLIC_PROVIDER_CHROME_BROWSER_BROWSER_STATE_CHROME_BROWSER_STATE_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/compiler_specific.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "ios/web/public/browser_state.h"
  12
  13 class HostContentSettingsMap;
  14 class PrefService;
  15
  16 namespace base {
  17 class SequencedTaskRunner;
  18 }
  19
  20 namespace web {
  21 class WebUIIOS;
  22 }
  23
  24 namespace ios {
  25
  26 // This class is a Chrome-specific extension of the BrowserState interface.
  27 class ChromeBrowserState : public web::BrowserState {
  28  public:
  29   ~ChromeBrowserState() override {}
  30
  31   // Returns the ChromeBrowserState corresponding to the given BrowserState.
  32   static ChromeBrowserState* FromBrowserState(BrowserState* browser_state);
  33
  34   // Returns the ChromeBrowserState corresponding to the given WebUIIOS.
  35   static ChromeBrowserState* FromWebUIIOS(web::WebUIIOS* web_ui);
  36
  37   // Returns sequenced task runner where browser state dependent I/O
  38   // operations should be performed.
  39   virtual scoped_refptr<base::SequencedTaskRunner> GetIOTaskRunner() = 0;
  40
  41   // Returns the original "recording" ChromeBrowserState. This method returns
  42   // |this| if the ChromeBrowserState is not incognito.
  43   virtual ChromeBrowserState* GetOriginalChromeBrowserState() = 0;
  44
  45   // Returns true if the ChromeBrowserState is off-the-record or if the
  46   // associated off-the-record browser state has been created.
  47   // Calling this method does not create the off-the-record browser state if it
  48   // does not already exist.
  49   virtual bool HasOffTheRecordChromeBrowserState() const = 0;
  50
  51   // Returns the incognito version of this ChromeBrowserState. The returned
  52   // ChromeBrowserState instance is owned by this ChromeBrowserState instance.
  53   // WARNING: This will create the OffTheRecord ChromeBrowserState if it
  54   // doesn't already exist.
  55   virtual ChromeBrowserState* GetOffTheRecordChromeBrowserState() = 0;
  56
  57   // Destroys the OffTheRecord ChromeBrowserState that is associated with this
  58   // ChromeBrowserState, if one exists.
  59   virtual void DestroyOffTheRecordChromeBrowserState() = 0;
  60
  61   // Retrieves a pointer to the PrefService that manages the preferences.
  62   virtual PrefService* GetPrefs() = 0;
  63
  64   // Returns the Hostname <-> Content settings map for the ChromeBrowserState.
  65   virtual HostContentSettingsMap* GetHostContentSettingsMap() = 0;
  66
  67  protected:
  68   ChromeBrowserState() {}
  69
  70  private:
  71   DISALLOW_COPY_AND_ASSIGN(ChromeBrowserState);
  72 };
  73
  74 }  // namespace ios
  75
  76 #endif  // IOS_PUBLIC_PROVIDER_CHROME_BROWSER_BROWSER_STATE_CHROME_BROWSER_STATE_H_