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 "ios/web/public/browser_state.h"
  11
  12 class PrefService;
  13
  14 namespace ios {
  15
  16 // This class is a Chrome-specific extension of the BrowserState interface.
  17 class ChromeBrowserState : public web::BrowserState {
  18  public:
  19   ~ChromeBrowserState() override {}
  20
  21   // Returns the ChromeBrowserState corresponding to the given BrowserState.
  22   static ChromeBrowserState* FromBrowserState(BrowserState* browser_state);
  23
  24   // Returns the original "recording" ChromeBrowserState. This method returns
  25   // |this| if the ChromeBrowserState is not incognito.
  26   virtual ChromeBrowserState* GetOriginalChromeBrowserState() = 0;
  27
  28   // Returns the incognito version of this ChromeBrowserState. The returned
  29   // ChromeBrowserState instance is owned by this ChromeBrowserState instance.
  30   // WARNING: This will create the OffTheRecord ChromeBrowserState if it
  31   // doesn't already exist.
  32   virtual ChromeBrowserState* GetOffTheRecordChromeBrowserState() = 0;
  33
  34   // Destroys the OffTheRecord ChromeBrowserState that is associated with this
  35   // ChromeBrowserState, if one exists.
  36   virtual void DestroyOffTheRecordChromeBrowserState() = 0;
  37
  38   // Retrieves a pointer to the PrefService that manages the preferences.
  39   virtual PrefService* GetPrefs() = 0;
  40
  41  protected:
  42   ChromeBrowserState() {}
  43
  44  private:
  45   DISALLOW_COPY_AND_ASSIGN(ChromeBrowserState);
  46 };
  47
  48 }  // namespace ios
  49
  50 #endif  // IOS_PUBLIC_PROVIDER_CHROME_BROWSER_BROWSER_STATE_CHROME_BROWSER_STATE_H_