src/chrome/browser/history/history_service_factory.h

   1 // Copyright (c) 2012 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 CHROME_BROWSER_HISTORY_HISTORY_SERVICE_FACTORY_H_
   6 #define CHROME_BROWSER_HISTORY_HISTORY_SERVICE_FACTORY_H_
   7
   8 #include "base/memory/singleton.h"
   9 #include "chrome/browser/profiles/profile.h"
  10 #include "components/keyed_service/content/browser_context_keyed_service_factory.h"
  11
  12 class HistoryService;
  13
  14 // Singleton that owns all HistoryService and associates them with
  15 // Profiles.
  16 class HistoryServiceFactory : public BrowserContextKeyedServiceFactory {
  17  public:
  18   static HistoryService* GetForProfile(
  19       Profile* profile, Profile::ServiceAccessType sat);
  20
  21   static HistoryService* GetForProfileIfExists(
  22       Profile* profile, Profile::ServiceAccessType sat);
  23
  24   static HistoryService* GetForProfileWithoutCreating(
  25       Profile* profile);
  26
  27   static HistoryServiceFactory* GetInstance();
  28
  29   // In the testing profile, we often clear the history before making a new
  30   // one. This takes care of that work. It should only be used in tests.
  31   // Note: This does not do any cleanup; it only destroys the service. The
  32   // calling test is expected to do the cleanup before calling this function.
  33   static void ShutdownForProfile(Profile* profile);
  34
  35  private:
  36   friend struct DefaultSingletonTraits<HistoryServiceFactory>;
  37
  38   HistoryServiceFactory();
  39   ~HistoryServiceFactory() override;
  40
  41   // BrowserContextKeyedServiceFactory:
  42   KeyedService* BuildServiceInstanceFor(
  43       content::BrowserContext* context) const override;
  44   content::BrowserContext* GetBrowserContextToUse(
  45       content::BrowserContext* context) const override;
  46   bool ServiceIsNULLWhileTesting() const override;
  47 };
  48
  49 #endif  // CHROME_BROWSER_HISTORY_HISTORY_SERVICE_FACTORY_H_