Extracted UsbDeviceHandle as interface.

BUG=367094

Review URL: https://codereview.chromium.org/278633003

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@269803 0039d316-1c4b-4281-b951-d872f2087c98

chrome/browser/devtools/device/usb/android_usb_device.cc

@@ -610,7 +610,7 @@ void AndroidUsbDevice::TransferError(UsbTransferStatus status) {
 void AndroidUsbDevice::TerminateIfReleased(
     scoped_refptr<UsbDeviceHandle> usb_handle) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
-  if (usb_handle->device())
+  if (usb_handle->GetDevice())
     return;
   message_loop_->PostTask(FROM_HERE,
                           base::Bind(&AndroidUsbDevice::Terminate, this));

components/usb_service.gypi

@@ -25,7 +25,8 @@
       'usb_service/usb_device_impl.cc',
       'usb_service/usb_device_impl.h',
       'usb_service/usb_device.h',
-      'usb_service/usb_device_handle.cc',
+      'usb_service/usb_device_handle_impl.cc',
+      'usb_service/usb_device_handle_impl.h',
       'usb_service/usb_device_handle.h',
       'usb_service/usb_interface.h',
       'usb_service/usb_interface_impl.cc',

components/usb_service/usb_device_handle.h

@@ -16,24 +16,10 @@
 #include "components/usb_service/usb_service_export.h"
 #include "net/base/io_buffer.h"
 
-struct libusb_device_handle;
-struct libusb_iso_packet_descriptor;
-struct libusb_transfer;
-
-namespace base {
-class MessageLoopProxy;
-}
-
 namespace usb_service {
 
-class UsbContext;
-class UsbConfigDescriptor;
 class UsbDevice;
 
-typedef libusb_device_handle* PlatformUsbDeviceHandle;
-typedef libusb_iso_packet_descriptor* PlatformUsbIsoPacketDescriptor;
-typedef libusb_transfer* PlatformUsbTransferHandle;
-
 enum UsbTransferStatus {
   USB_TRANSFER_COMPLETED = 0,
   USB_TRANSFER_ERROR,
@@ -56,24 +42,23 @@ class USB_SERVICE_EXPORT UsbDeviceHandle
   enum TransferRequestType { STANDARD, CLASS, VENDOR, RESERVED };
   enum TransferRecipient { DEVICE, INTERFACE, ENDPOINT, OTHER };
 
-  scoped_refptr<UsbDevice> device() const;
-  PlatformUsbDeviceHandle handle() const { return handle_; }
+  virtual scoped_refptr<UsbDevice> GetDevice() const = 0;
 
   // Notifies UsbDevice to drop the reference of this object; cancels all the
   // flying transfers.
   // It is possible that the object has no other reference after this call. So
   // if it is called using a raw pointer, it could be invalidated.
   // The platform device handle will be closed when UsbDeviceHandle destructs.
-  virtual void Close();
+  virtual void Close() = 0;
 
   // Device manipulation operations. These methods are blocking and must be
   // called on FILE thread.
-  virtual bool ClaimInterface(const int interface_number);
-  virtual bool ReleaseInterface(const int interface_number);
+  virtual bool ClaimInterface(const int interface_number) = 0;
+  virtual bool ReleaseInterface(const int interface_number) = 0;
   virtual bool SetInterfaceAlternateSetting(const int interface_number,
-                                            const int alternate_setting);
-  virtual bool ResetDevice();
-  virtual bool GetSerial(base::string16* serial);
+                                            const int alternate_setting) = 0;
+  virtual bool ResetDevice() = 0;
+  virtual bool GetSerial(base::string16* serial) = 0;
 
   // Async IO. Can be called on any thread.
   virtual void ControlTransfer(const UsbEndpointDirection direction,
@@ -85,21 +70,21 @@ class USB_SERVICE_EXPORT UsbDeviceHandle
                                net::IOBuffer* buffer,
                                const size_t length,
                                const unsigned int timeout,
-                               const UsbTransferCallback& callback);
+                               const UsbTransferCallback& callback) = 0;
 
   virtual void BulkTransfer(const UsbEndpointDirection direction,
                             const uint8 endpoint,
                             net::IOBuffer* buffer,
                             const size_t length,
                             const unsigned int timeout,
-                            const UsbTransferCallback& callback);
+                            const UsbTransferCallback& callback) = 0;
 
   virtual void InterruptTransfer(const UsbEndpointDirection direction,
                                  const uint8 endpoint,
                                  net::IOBuffer* buffer,
                                  const size_t length,
                                  const unsigned int timeout,
-                                 const UsbTransferCallback& callback);
+                                 const UsbTransferCallback& callback) = 0;
 
   virtual void IsochronousTransfer(const UsbEndpointDirection direction,
                                    const uint8 endpoint,
@@ -108,75 +93,14 @@ class USB_SERVICE_EXPORT UsbDeviceHandle
                                    const unsigned int packets,
                                    const unsigned int packet_length,
                                    const unsigned int timeout,
-                                   const UsbTransferCallback& callback);
+                                   const UsbTransferCallback& callback) = 0;
 
  protected:
   friend class base::RefCountedThreadSafe<UsbDeviceHandle>;
-  friend class UsbDeviceImpl;
-
-  // This constructor is called by UsbDevice.
-  UsbDeviceHandle(scoped_refptr<UsbContext> context,
-                  UsbDevice* device,
-                  PlatformUsbDeviceHandle handle,
-                  scoped_refptr<UsbConfigDescriptor> interfaces);
-
-  // This constructor variant is for use in testing only.
-  UsbDeviceHandle();
-  virtual ~UsbDeviceHandle();
-
-  UsbDevice* device_;
-
- private:
-  friend void HandleTransferCompletion(PlatformUsbTransferHandle handle);
-
-  class InterfaceClaimer;
-  struct Transfer;
-
-  // Refresh endpoint_map_ after ClaimInterface, ReleaseInterface and
-  // SetInterfaceAlternateSetting.
-  void RefreshEndpointMap();
-
-  // Look up the claimed interface by endpoint. Return NULL if the interface
-  // of the endpoint is not found.
-  scoped_refptr<InterfaceClaimer> GetClaimedInterfaceForEndpoint(
-      unsigned char endpoint);
-
-  // Submits a transfer and starts tracking it. Retains the buffer and copies
-  // the completion callback until the transfer finishes, whereupon it invokes
-  // the callback then releases the buffer.
-  void SubmitTransfer(PlatformUsbTransferHandle handle,
-                      UsbTransferType transfer_type,
-                      net::IOBuffer* buffer,
-                      const size_t length,
-                      scoped_refptr<base::MessageLoopProxy> message_loop_proxy,
-                      const UsbTransferCallback& callback);
-
-  // Invokes the callbacks associated with a given transfer, and removes it from
-  // the in-flight transfer set.
-  void TransferComplete(PlatformUsbTransferHandle transfer);
-
-  // Informs the object to drop internal references.
-  void InternalClose();
-
-  PlatformUsbDeviceHandle handle_;
-
-  scoped_refptr<UsbConfigDescriptor> interfaces_;
-
-  typedef std::map<int, scoped_refptr<InterfaceClaimer> > ClaimedInterfaceMap;
-  ClaimedInterfaceMap claimed_interfaces_;
-
-  typedef std::map<PlatformUsbTransferHandle, Transfer> TransferMap;
-  TransferMap transfers_;
-
-  // A map from endpoints to interfaces
-  typedef std::map<int, int> EndpointMap;
-  EndpointMap endpoint_map_;
 
-  // Retain the UsbContext so that the platform context will not be destroyed
-  // before this handle.
-  scoped_refptr<UsbContext> context_;
+  UsbDeviceHandle() {};
 
-  base::ThreadChecker thread_checker_;
+  virtual ~UsbDeviceHandle() {};
 
   DISALLOW_COPY_AND_ASSIGN(UsbDeviceHandle);
 };

components/usb_service/usb_device_handle_impl.h

+// Copyright 2014 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 COMPONENTS_USB_SERVICE_USB_DEVICE_HANDLE_IMPL_H_
+#define COMPONENTS_USB_SERVICE_USB_DEVICE_HANDLE_IMPL_H_
+
+#include <map>
+#include <vector>
+
+#include "base/callback.h"
+#include "base/memory/ref_counted.h"
+#include "base/strings/string16.h"
+#include "base/threading/thread_checker.h"
+#include "components/usb_service/usb_device_handle.h"
+#include "components/usb_service/usb_interface.h"
+#include "net/base/io_buffer.h"
+
+struct libusb_device_handle;
+struct libusb_iso_packet_descriptor;
+struct libusb_transfer;
+
+namespace base {
+class MessageLoopProxy;
+}
+
+namespace usb_service {
+
+class UsbContext;
+class UsbConfigDescriptor;
+class UsbDeviceImpl;
+
+typedef libusb_device_handle* PlatformUsbDeviceHandle;
+typedef libusb_iso_packet_descriptor* PlatformUsbIsoPacketDescriptor;
+typedef libusb_transfer* PlatformUsbTransferHandle;
+
+// UsbDeviceHandle class provides basic I/O related functionalities.
+class UsbDeviceHandleImpl : public UsbDeviceHandle {
+ public:
+  virtual scoped_refptr<UsbDevice> GetDevice() const OVERRIDE;
+  virtual void Close() OVERRIDE;
+  virtual bool ClaimInterface(const int interface_number) OVERRIDE;
+  virtual bool ReleaseInterface(const int interface_number) OVERRIDE;
+  virtual bool SetInterfaceAlternateSetting(
+      const int interface_number,
+      const int alternate_setting) OVERRIDE;
+  virtual bool ResetDevice() OVERRIDE;
+  virtual bool GetSerial(base::string16* serial) OVERRIDE;
+  virtual void ControlTransfer(const UsbEndpointDirection direction,
+                               const TransferRequestType request_type,
+                               const TransferRecipient recipient,
+                               const uint8 request,
+                               const uint16 value,
+                               const uint16 index,
+                               net::IOBuffer* buffer,
+                               const size_t length,
+                               const unsigned int timeout,
+                               const UsbTransferCallback& callback) OVERRIDE;
+
+  virtual void BulkTransfer(const UsbEndpointDirection direction,
+                            const uint8 endpoint,
+                            net::IOBuffer* buffer,
+                            const size_t length,
+                            const unsigned int timeout,
+                            const UsbTransferCallback& callback) OVERRIDE;
+
+  virtual void InterruptTransfer(const UsbEndpointDirection direction,
+                                 const uint8 endpoint,
+                                 net::IOBuffer* buffer,
+                                 const size_t length,
+                                 const unsigned int timeout,
+                                 const UsbTransferCallback& callback) OVERRIDE;
+
+  virtual void IsochronousTransfer(
+      const UsbEndpointDirection direction,
+      const uint8 endpoint,
+      net::IOBuffer* buffer,
+      const size_t length,
+      const unsigned int packets,
+      const unsigned int packet_length,
+      const unsigned int timeout,
+      const UsbTransferCallback& callback) OVERRIDE;
+
+  PlatformUsbDeviceHandle handle() const { return handle_; }
+
+ protected:
+  friend class UsbDeviceImpl;
+
+  // This constructor is called by UsbDevice.
+  UsbDeviceHandleImpl(scoped_refptr<UsbContext> context,
+                      UsbDeviceImpl* device,
+                      PlatformUsbDeviceHandle handle,
+                      scoped_refptr<UsbConfigDescriptor> interfaces);
+
+  virtual ~UsbDeviceHandleImpl();
+
+ private:
+  friend void HandleTransferCompletion(PlatformUsbTransferHandle handle);
+
+  class InterfaceClaimer;
+  struct Transfer;
+
+  // Refresh endpoint_map_ after ClaimInterface, ReleaseInterface and
+  // SetInterfaceAlternateSetting.
+  void RefreshEndpointMap();
+
+  // Look up the claimed interface by endpoint. Return NULL if the interface
+  // of the endpoint is not found.
+  scoped_refptr<InterfaceClaimer> GetClaimedInterfaceForEndpoint(
+      unsigned char endpoint);
+
+  // Submits a transfer and starts tracking it. Retains the buffer and copies
+  // the completion callback until the transfer finishes, whereupon it invokes
+  // the callback then releases the buffer.
+  void SubmitTransfer(PlatformUsbTransferHandle handle,
+                      UsbTransferType transfer_type,
+                      net::IOBuffer* buffer,
+                      const size_t length,
+                      scoped_refptr<base::MessageLoopProxy> message_loop_proxy,
+                      const UsbTransferCallback& callback);
+
+  // Invokes the callbacks associated with a given transfer, and removes it from
+  // the in-flight transfer set.
+  void TransferComplete(PlatformUsbTransferHandle transfer);
+
+  // Informs the object to drop internal references.
+  void InternalClose();
+
+  UsbDeviceImpl* device_;
+
+  PlatformUsbDeviceHandle handle_;
+
+  scoped_refptr<UsbConfigDescriptor> interfaces_;
+
+  typedef std::map<int, scoped_refptr<InterfaceClaimer> > ClaimedInterfaceMap;
+  ClaimedInterfaceMap claimed_interfaces_;
+
+  typedef std::map<PlatformUsbTransferHandle, Transfer> TransferMap;
+  TransferMap transfers_;
+
+  // A map from endpoints to interfaces
+  typedef std::map<int, int> EndpointMap;
+  EndpointMap endpoint_map_;
+
+  // Retain the UsbContext so that the platform context will not be destroyed
+  // before this handle.
+  scoped_refptr<UsbContext> context_;
+
+  base::ThreadChecker thread_checker_;
+
+  DISALLOW_COPY_AND_ASSIGN(UsbDeviceHandleImpl);
+};
+
+}  // namespace usb_service
+
+#endif  // COMPONENTS_USB_SERVICE_USB_DEVICE_HANDLE_IMPL_H_

components/usb_service/usb_device_impl.cc

@@ -8,7 +8,7 @@
 
 #include "base/stl_util.h"
 #include "components/usb_service/usb_context.h"
-#include "components/usb_service/usb_device_handle.h"
+#include "components/usb_service/usb_device_handle_impl.h"
 #include "components/usb_service/usb_interface_impl.h"
 #include "content/public/browser/browser_thread.h"
 #include "third_party/libusb/src/libusb/libusb.h"
@@ -98,8 +98,8 @@ scoped_refptr<UsbDeviceHandle> UsbDeviceImpl::Open() {
     scoped_refptr<UsbConfigDescriptor> interfaces = ListInterfaces();
     if (!interfaces)
       return NULL;
-    scoped_refptr<UsbDeviceHandle> device_handle =
-        new UsbDeviceHandle(context_, this, handle, interfaces);
+    scoped_refptr<UsbDeviceHandleImpl> device_handle =
+        new UsbDeviceHandleImpl(context_, this, handle, interfaces);
     handles_.push_back(device_handle);
     return device_handle;
   }
@@ -136,12 +136,8 @@ void UsbDeviceImpl::OnDisconnect() {
   DCHECK(thread_checker_.CalledOnValidThread());
   HandlesVector handles;
   swap(handles, handles_);
-  for (std::vector<scoped_refptr<UsbDeviceHandle> >::iterator it =
-           handles.begin();
-       it != handles.end();
-       ++it) {
+  for (HandlesVector::iterator it = handles.begin(); it != handles.end(); ++it)
     (*it)->InternalClose();
-  }
 }
 
 }  // namespace usb_service

components/usb_service/usb_device_impl.h

@@ -17,7 +17,7 @@ struct libusb_config_descriptor;
 
 namespace usb_service {
 
-class UsbDeviceHandle;
+class UsbDeviceHandleImpl;
 class UsbContext;
 
 typedef libusb_device* PlatformUsbDevice;
@@ -58,7 +58,7 @@ class UsbDeviceImpl : public UsbDevice {
   scoped_refptr<UsbContext> context_;
 
   // Opened handles.
-  typedef std::vector<scoped_refptr<UsbDeviceHandle> > HandlesVector;
+  typedef std::vector<scoped_refptr<UsbDeviceHandleImpl> > HandlesVector;
   HandlesVector handles_;
 
   DISALLOW_COPY_AND_ASSIGN(UsbDeviceImpl);

extensions/browser/api/usb/usb_api.cc

@@ -464,15 +464,15 @@ UsbAsyncApiFunction::GetDeviceHandleOrCompleteWithError(
     return NULL;
   }
 
-  if (!resource->device() || !resource->device()->device()) {
+  if (!resource->device() || !resource->device()->GetDevice()) {
     CompleteWithError(kErrorDisconnect);
     manager_->Remove(extension_->id(), input_device_handle.handle);
     return NULL;
   }
 
-  if (resource->device()->device()->vendor_id() !=
+  if (resource->device()->GetDevice()->vendor_id() !=
           input_device_handle.vendor_id ||
-      resource->device()->device()->product_id() !=
+      resource->device()->GetDevice()->product_id() !=
           input_device_handle.product_id) {
     CompleteWithError(kErrorNoDevice);
     return NULL;
@@ -721,8 +721,8 @@ void UsbOpenDeviceFunction::AsyncWorkStart() {
 
   SetResult(PopulateConnectionHandle(
       manager_->Add(new UsbDeviceResource(extension_->id(), handle_)),
-      handle_->device()->vendor_id(),
-      handle_->device()->product_id()));
+      handle_->GetDevice()->vendor_id(),
+      handle_->GetDevice()->product_id()));
   AsyncWorkCompleted();
 }
 
@@ -745,7 +745,7 @@ void UsbListInterfacesFunction::AsyncWorkStart() {
     return;
 
   scoped_refptr<UsbConfigDescriptor> config =
-      device_handle->device()->ListInterfaces();
+      device_handle->GetDevice()->ListInterfaces();
 
   if (!config) {
     SetError(kErrorCannotListInterfaces);

extensions/browser/api/usb/usb_apitest.cc

@@ -86,10 +86,21 @@ class MockUsbDeviceHandle : public UsbDeviceHandle {
                     const UsbTransferCallback& callback));
 
   MOCK_METHOD0(ResetDevice, bool());
+  MOCK_METHOD1(ClaimInterface, bool(const int interface_number));
+  MOCK_METHOD1(ReleaseInterface, bool(const int interface_number));
+  MOCK_METHOD2(SetInterfaceAlternateSetting,
+               bool(const int interface_number, const int alternate_setting));
+  MOCK_METHOD1(GetSerial, bool(base::string16* serial));
+
+  virtual scoped_refptr<UsbDevice> GetDevice() const OVERRIDE {
+    return device_;
+  }
 
   void set_device(UsbDevice* device) { device_ = device; }
 
  protected:
+  UsbDevice* device_;
+
   virtual ~MockUsbDeviceHandle() {}
 };