chromeos: Refactor D-Bus client creation for ash and browser processes

chromeos/dbus/dbus_thread_manager.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 CHROMEOS_DBUS_DBUS_THREAD_MANAGER_H_
 #define CHROMEOS_DBUS_DBUS_THREAD_MANAGER_H_
 
 #include <memory>
 #include <string>
 
@@ skipping 12 matching lines @@
 class ObjectPath;
 }  // namespace dbus
 
 namespace chromeos {
 
 // Style Note: Clients are sorted by names.
 class ArcObbMounterClient;
 class CrasAudioClient;
 class CrosDisksClient;
 class CryptohomeClient;
-class DBusClientBundle;
+class DBusClientsBrowser;
+class DBusClientsCommon;
 class DBusThreadManagerSetter;
 class DebugDaemonClient;
 class EasyUnlockClient;
 class GsmSMSClient;
 class ImageBurnerClient;
 class LorgnetteManagerClient;
 class ModemMessagingClient;
 class PermissionBrokerClient;
 class PowerManagerClient;
 class SMSClient;
@@ skipping 20 matching lines @@
 // after the D-Bus thread so the clients don't need to worry if new
 // incoming messages arrive from the D-Bus thread during shutdown of the
 // clients. The UI message loop is not running during the shutdown hence
 // the UI message loop won't post tasks to D-BUS clients during the
 // shutdown. However, to be extra cautious, clients should use
 // WeakPtrFactory when creating callbacks that run on UI thread. See
 // session_manager_client.cc for examples.
 //
 class CHROMEOS_EXPORT DBusThreadManager {
  public:
+  // Processes for which to create and initialize the D-Bus clients.
+  // TODO(jamescook): Move creation of clients into //ash and //chrome/browser.
+  // http://crbug.com/647367
+  enum ProcessMask {
+    PROCESS_ASH = 1 << 0,
+    PROCESS_BROWSER = 1 << 1,
+    PROCESS_ALL = ~0,
+  };
   // Sets the global instance. Must be called before any calls to Get().
   // We explicitly initialize and shut down the global object, rather than
   // making it a Singleton, to ensure clean startup and shutdown.
   // This will initialize real or fake DBusClients depending on command-line
   // arguments and whether this process runs in a ChromeOS environment.
+  // Only D-Bus clients available in the processes in |process_mask| will be
+  // created.
+  static void Initialize(ProcessMask process_mask);
+
+  // Equivalent to Initialize(PROCESS_ALL).
   static void Initialize();
 
   // Returns a DBusThreadManagerSetter instance that allows tests to
   // replace individual D-Bus clients with their own implementations.
   // Also initializes the main DBusThreadManager for testing if necessary.
   static std::unique_ptr<DBusThreadManagerSetter> GetSetterForTesting();
 
   // Returns true if DBusThreadManager has been initialized. Call this to
   // avoid initializing + shutting down DBusThreadManager more than once.
   static bool IsInitialized();
 
   // Destroys the global instance.
   static void Shutdown();
 
   // Gets the global instance. Initialize() must be called first.
   static DBusThreadManager* Get();
 
   // Returns true if |client| is faked.
   bool IsUsingFake(DBusClientType client);
 
   // Returns various D-Bus bus instances, owned by DBusThreadManager.
   dbus::Bus* GetSystemBus();
 
   // All returned objects are owned by DBusThreadManager.  Do not use these
   // pointers after DBusThreadManager has been shut down.
+  // TODO(jamescook): Replace this with calls to FooClient::Get().
+  // http://crbug.com/647367
   ArcObbMounterClient* GetArcObbMounterClient();
   CrasAudioClient* GetCrasAudioClient();
   CrosDisksClient* GetCrosDisksClient();
   CryptohomeClient* GetCryptohomeClient();
   DebugDaemonClient* GetDebugDaemonClient();
   EasyUnlockClient* GetEasyUnlockClient();
   GsmSMSClient* GetGsmSMSClient();
   ImageBurnerClient* GetImageBurnerClient();
   LorgnetteManagerClient* GetLorgnetteManagerClient();
   ModemMessagingClient* GetModemMessagingClient();
   PermissionBrokerClient* GetPermissionBrokerClient();
   PowerManagerClient* GetPowerManagerClient();
   SessionManagerClient* GetSessionManagerClient();
   ShillDeviceClient* GetShillDeviceClient();
   ShillIPConfigClient* GetShillIPConfigClient();
   ShillManagerClient* GetShillManagerClient();
   ShillServiceClient* GetShillServiceClient();
   ShillProfileClient* GetShillProfileClient();
   ShillThirdPartyVpnDriverClient* GetShillThirdPartyVpnDriverClient();
   SMSClient* GetSMSClient();
   SystemClockClient* GetSystemClockClient();
   UpdateEngineClient* GetUpdateEngineClient();
 
  private:
   friend class DBusThreadManagerSetter;
 
-  // Creates a new DBusThreadManager using the DBusClients set in
-  // |client_bundle|.
-  explicit DBusThreadManager(std::unique_ptr<DBusClientBundle> client_bundle);
+  DBusThreadManager(ProcessMask process_mask,
+                    DBusClientTypeMask real_client_mask);
   ~DBusThreadManager();
 
   // Creates a global instance of DBusThreadManager with the real
   // implementations for all clients that are listed in |real_client_mask| and
   // fake implementations for all clients that are not included. Cannot be
   // called more than once.
-  static void CreateGlobalInstance(DBusClientTypeMask real_client_mask);
+  static void CreateGlobalInstance(ProcessMask process_mask,
+                                   DBusClientTypeMask real_client_mask);
 
   // Initialize global thread manager instance with all real dbus client
   // implementations.
-  static void InitializeWithRealClients();
+  static void InitializeWithRealClients(ProcessMask process_mask);
 
   // Initialize global thread manager instance with fake dbus clients.
-  static void InitializeWithFakeClients();
+  static void InitializeWithFakeClients(ProcessMask process_mask);
 
   // Initialize with fake implementations for only certain clients that are
   // not included in the comma-separated |force_real_clients| list.
-  static void InitializeWithPartialFakes(const std::string& force_real_clients);
+  static void InitializeWithPartialFakes(ProcessMask process_mask,
+                                         const std::string& force_real_clients);
 
   // Initializes all currently stored DBusClients with the system bus and
   // performs additional setup.
   void InitializeClients();
 
   std::unique_ptr<base::Thread> dbus_thread_;
   scoped_refptr<dbus::Bus> system_bus_;
-  std::unique_ptr<DBusClientBundle> client_bundle_;
+
+  // Clients used by multiple processes.
+  std::unique_ptr<DBusClientsCommon> clients_common_;
+
+  // Clients used only by the browser process. Null in other processes.
+  std::unique_ptr<DBusClientsBrowser> clients_browser_;
 
   DISALLOW_COPY_AND_ASSIGN(DBusThreadManager);
 };
 
+// TODO(jamescook): Replace these with FooClient::InitializeForTesting().
 class CHROMEOS_EXPORT DBusThreadManagerSetter {
  public:
   ~DBusThreadManagerSetter();
 
   void SetCrasAudioClient(std::unique_ptr<CrasAudioClient> client);
   void SetCrosDisksClient(std::unique_ptr<CrosDisksClient> client);
   void SetCryptohomeClient(std::unique_ptr<CryptohomeClient> client);
   void SetDebugDaemonClient(std::unique_ptr<DebugDaemonClient> client);
-  void SetEasyUnlockClient(std::unique_ptr<EasyUnlockClient> client);
-  void SetLorgnetteManagerClient(
-      std::unique_ptr<LorgnetteManagerClient> client);
   void SetShillDeviceClient(std::unique_ptr<ShillDeviceClient> client);
   void SetShillIPConfigClient(std::unique_ptr<ShillIPConfigClient> client);
   void SetShillManagerClient(std::unique_ptr<ShillManagerClient> client);
   void SetShillServiceClient(std::unique_ptr<ShillServiceClient> client);
   void SetShillProfileClient(std::unique_ptr<ShillProfileClient> client);
   void SetShillThirdPartyVpnDriverClient(
       std::unique_ptr<ShillThirdPartyVpnDriverClient> client);
-  void SetGsmSMSClient(std::unique_ptr<GsmSMSClient> client);
   void SetImageBurnerClient(std::unique_ptr<ImageBurnerClient> client);
-  void SetModemMessagingClient(std::unique_ptr<ModemMessagingClient> client);
   void SetPermissionBrokerClient(
       std::unique_ptr<PermissionBrokerClient> client);
   void SetPowerManagerClient(std::unique_ptr<PowerManagerClient> client);
   void SetSessionManagerClient(std::unique_ptr<SessionManagerClient> client);
-  void SetSMSClient(std::unique_ptr<SMSClient> client);
-  void SetSystemClockClient(std::unique_ptr<SystemClockClient> client);
   void SetUpdateEngineClient(std::unique_ptr<UpdateEngineClient> client);
 
  private:
   friend class DBusThreadManager;
 
   DBusThreadManagerSetter();
 
   DISALLOW_COPY_AND_ASSIGN(DBusThreadManagerSetter);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DBUS_DBUS_THREAD_MANAGER_H_