chrome/browser/profiles/profile_dependency_manager.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_PROFILES_PROFILE_DEPENDENCY_MANAGER_H_
   6 #define CHROME_BROWSER_PROFILES_PROFILE_DEPENDENCY_MANAGER_H_
   7
   8 #include <map>
   9 #include <vector>
  10
  11 #include "base/memory/singleton.h"
  12
  13 #ifndef NDEBUG
  14 #include <set>
  15 #include <string>
  16 #endif
  17
  18 class Profile;
  19 class ProfileKeyedBaseFactory;
  20
  21 // A singleton that listens for profile destruction notifications and
  22 // rebroadcasts them to each ProfileKeyedBaseFactory in a safe order based
  23 // on the stated dependencies by each service.
  24 class ProfileDependencyManager {
  25  public:
  26   // Adds/Removes a component from our list of live components. Removing will
  27   // also remove live dependency links.
  28   void AddComponent(ProfileKeyedBaseFactory* component);
  29   void RemoveComponent(ProfileKeyedBaseFactory* component);
  30
  31   // Adds a dependency between two factories.
  32   void AddEdge(ProfileKeyedBaseFactory* depended,
  33                ProfileKeyedBaseFactory* dependee);
  34
  35   // Called by each Profile to alert us of its creation. Several services want
  36   // to be started when a profile is created. Testing configuration is also
  37   // done at this time. (If you want your ProfileKeyedService to be started
  38   // with the Profile, override ProfileKeyedBaseFactory::
  39   // ServiceIsCreatedWithProfile() to return true.)
  40   void CreateProfileServices(Profile* profile, bool is_testing_profile);
  41
  42   // Called by each Profile to alert us that we should destroy services
  43   // associated with it.
  44   //
  45   // Why not use the existing PROFILE_DESTROYED notification?
  46   //
  47   // - Because we need to do everything here after the application has handled
  48   //   being notified about PROFILE_DESTROYED.
  49   // - Because this class is a singleton and Singletons can't rely on
  50   //   NotificationService in unit tests because NotificationService is
  51   //   replaced in many tests.
  52   void DestroyProfileServices(Profile* profile);
  53
  54 #ifndef NDEBUG
  55   // Debugging assertion called as part of GetServiceForProfile in debug
  56   // mode. This will NOTREACHED() whenever the user is trying to access a stale
  57   // Profile*.
  58   void AssertProfileWasntDestroyed(Profile* profile);
  59 #endif
  60
  61   static ProfileDependencyManager* GetInstance();
  62
  63  private:
  64   friend class ProfileDependencyManagerUnittests;
  65   friend struct DefaultSingletonTraits<ProfileDependencyManager>;
  66
  67   typedef std::multimap<ProfileKeyedBaseFactory*,
  68                         ProfileKeyedBaseFactory*> EdgeMap;
  69
  70   ProfileDependencyManager();
  71   virtual ~ProfileDependencyManager();
  72
  73   // Ensures that all the factories have been created before building the
  74   // dependency graph.
  75   void AssertFactoriesBuilt();
  76
  77   // Using the dependency graph defined in |edges_|, fills |destruction_order_|
  78   // so that Observe() can notify each ProfileKeyedBaseFactory in order.
  79   void BuildDestructionOrder(Profile* profile);
  80
  81 #ifndef NDEBUG
  82   // Creates a dot file with our dependency information.
  83   std::string DumpGraphvizDependency();
  84 #endif
  85
  86   std::vector<ProfileKeyedBaseFactory*> all_components_;
  87
  88   EdgeMap edges_;
  89
  90   std::vector<ProfileKeyedBaseFactory*> destruction_order_;
  91
  92   // Whether AssertFactoriesBuilt has been done.
  93   bool built_factories_;
  94
  95 #ifndef NDEBUG
  96   // A list of profile objects that have gone through the Shutdown()
  97   // phase. These pointers are most likely invalid, but we keep track of their
  98   // locations in memory so we can nicely assert if we're asked to do anything
  99   // with them.
 100   std::set<Profile*> dead_profile_pointers_;
 101 #endif
 102 };
 103
 104 #endif  // CHROME_BROWSER_PROFILES_PROFILE_DEPENDENCY_MANAGER_H_