Fix minor issues about DBusThreadManager.

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 "base/callback.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
@@ skipping 68 matching lines @@
 // 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:
   // 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 stub DBusClients depending on command-line
+  // arguments and whether this process runs in a ChromeOS environment.
   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 scoped_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 stubbed.
-  static bool IsUsingStub(DBusClientBundle::DBusClientType client);
+  bool IsUsingStub(DBusClientBundle::DBusClientType client);
 
   // Returns various D-Bus bus instances, owned by DBusThreadManager.
   dbus::Bus* GetSystemBus();
 
   // All returned objects are owned by DBusThreadManager.  Do not cache these
   // pointers and use them after DBusThreadManager has been shut down.
   BluetoothAdapterClient* GetBluetoothAdapterClient();
   BluetoothAgentManagerClient* GetBluetoothAgentManagerClient();
   BluetoothDeviceClient* GetBluetoothDeviceClient();
   BluetoothGattCharacteristicClient* GetBluetoothGattCharacteristicClient();
@@ skipping 26 matching lines @@
   ShillManagerClient* GetShillManagerClient();
   ShillServiceClient* GetShillServiceClient();
   ShillProfileClient* GetShillProfileClient();
   SMSClient* GetSMSClient();
   SystemClockClient* GetSystemClockClient();
   UpdateEngineClient* GetUpdateEngineClient();
 
  private:
   friend class DBusThreadManagerSetter;
 
-  DBusThreadManager();
+  // Creates a new DBusThreadManager using the DBusClients set in
+  // |client_bundle|.
+  DBusThreadManager(scoped_ptr<DBusClientBundle> client_bundle);

[hashimoto, 2014/09/11 06:50:45]

'explicit' missing?

[pneubeck (no reviews), 2014/09/11 08:08:19]

hm. wasn't catched by presubmit.
Done.

   ~DBusThreadManager();
 
-  // Creates a global instance of DBusThreadManager. Can not be called more
-  // than once.
-  static void CreateGlobalInstance();
+  // Creates a global instance of DBusThreadManager with the real
+  // implementations for all clients that are listed in |unstub_client_mask| and
+  // stub implementations for all clients that are not included. Cannot be
+  // called more than once.
+  static void CreateGlobalInstance(
+      DBusClientBundle::DBusClientTypeMask unstub_client_mask);
 
-  // Initialize global thread manager instance.
-  static void InitializeRegular();
+  // Initialize global thread manager instance with all real dbus client
+  // implementations.
+  static void InitializeWithRealClients();
 
   // Initialize global thread manager instance with stubbed-out dbus clients
   // implementation.
   static void InitializeWithStubs();
 
   // Initialize with stub implementations for only certain clients that are
-  // not included in comma-separated |unstub_clients| list.
+  // not included in the comma-separated |unstub_clients| list.
   static void InitializeWithPartialStub(const std::string& unstub_clients);
 
-  // Constructs all clients and stores them in the respective *_client_ member
-  // variable.
-  void CreateDefaultClients();
-
-  // Constructs all clients and stores them in the respective *_client_ member
-  // variable.
+  // Initializes all currently stored DBusClients with the system bus and
+  // creates a stub network environment.

[hashimoto, 2014/09/11 06:50:45]

This comment is not always true as DBusClientBundle::SetupDefaultEnvironment()
results in no-op on the production environment.
Also, this comment is fragile to changes in the implementation of
DBusClientBundle.

I'd just say something like "... and performs additional setup."

[pneubeck (no reviews), 2014/09/11 08:08:19]

Done.

   void InitializeClients();
 
-  // Bitmask that defines which dbus clients are not stubbed out. Bitmap flags
-  // are defined within DBusClientBundle::DBusClientType enum.
-  static DBusClientBundle::DBusClientTypeMask unstub_client_mask_;
-
   scoped_ptr<base::Thread> dbus_thread_;
   scoped_refptr<dbus::Bus> system_bus_;
   scoped_ptr<DBusClientBundle> client_bundle_;
   scoped_ptr<PowerPolicyController> power_policy_controller_;
 
   DISALLOW_COPY_AND_ASSIGN(DBusThreadManager);
 };
 
 class CHROMEOS_EXPORT DBusThreadManagerSetter {
  public:
@@ skipping 45 matching lines @@
   friend class DBusThreadManager;
 
   DBusThreadManagerSetter();
 
   DISALLOW_COPY_AND_ASSIGN(DBusThreadManagerSetter);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DBUS_DBUS_THREAD_MANAGER_H_