Update Gears wifi data providers to Chrome style & APIs....

chrome/browser/geolocation/wifi_data_provider_win.h

-// Copyright 2008, Google Inc.
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are met:
-//
-//  1. Redistributions of source code must retain the above copyright notice,
-//     this list of conditions and the following disclaimer.
-//  2. Redistributions in binary form must reproduce the above copyright notice,
-//     this list of conditions and the following disclaimer in the documentation
-//     and/or other materials provided with the distribution.
-//  3. Neither the name of Google Inc. nor the names of its contributors may be
-//     used to endorse or promote products derived from this software without
-//     specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+// Copyright (c) 2010 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 GEARS_GEOLOCATION_WIFI_DATA_PROVIDER_WIN32_H__
-#define GEARS_GEOLOCATION_WIFI_DATA_PROVIDER_WIN32_H__
+#ifndef CHROME_BROWSER_GEOLOCATION_WIFI_DATA_PROVIDER_WIN_H_
+#define CHROME_BROWSER_GEOLOCATION_WIFI_DATA_PROVIDER_WIN_H_
 
-#include <vector>
-#include "gears/base/common/common.h"
-#include "gears/base/common/thread.h"
-#include "gears/geolocation/device_data_provider.h"
-#include "gears/geolocation/wlanapi.h"
+#include "base/task.h"
+#include "base/thread.h"
+#include "chrome/browser/geolocation/device_data_provider.h"
+
+class PollingPolicyInterface;
 
 class Win32WifiDataProvider
     : public WifiDataProviderImplBase,
-      public Thread {
+      private base::Thread {
  public:
+  // Interface to abstract the low level data OS library call, and to allow
+  // mocking (hence public).
+  class WlanApiInterface {
+   public:
+    virtual ~WlanApiInterface() {}
+    // Gets wifi data for all visible access points.
+    virtual bool GetAccessPointData(WifiData::AccessPointDataSet *data) = 0;
+  };
+
   Win32WifiDataProvider();
   virtual ~Win32WifiDataProvider();
 
+  // Takes ownership of wlan_api. Must be called before Start().
+  void inject_mock_wlan_api(WlanApiInterface* wlan_api);
+
+  // Takes ownership of polic. Must be called before Start().
+  void inject_mock_polling_policy(PollingPolicyInterface* policy);
+
   // WifiDataProviderImplBase implementation
+  virtual bool StartDataProvider();
   virtual bool GetData(WifiData *data);
 
  private:
   // Thread implementation
-  virtual void Run();
+  virtual void Init();
+  // Called just after the message loop ends
+  virtual void CleanUp();
 
-  // WLAN methods
-  // Loads the required functions from the DLL.
-  void GetWLANFunctions(HINSTANCE wlan_library);
-  // Gets wifi data for all visible access points.
-  bool GetAccessPointDataWLAN(WifiData::AccessPointDataSet *data);
-  int GetInterfaceDataWLAN(HANDLE wlan_handle,
-                           const GUID &interface_id,
-                           WifiData::AccessPointDataSet *data);
+  // Task which run in the child thread.
+  void DoWifiScanTask();
 
-  // NDIS methods.
-  bool GetInterfacesNDIS();
-  bool GetAccessPointDataNDIS(WifiData::AccessPointDataSet *data);
-  bool GetInterfaceDataNDIS(HANDLE adapter_handle,
-                            WifiData::AccessPointDataSet *data);
-
-  // Function pointers for WLAN
-  WlanOpenHandleFunction WlanOpenHandle_function_;
-  WlanEnumInterfacesFunction WlanEnumInterfaces_function_;
-  WlanGetNetworkBssListFunction WlanGetNetworkBssList_function_;
-  WlanFreeMemoryFunction WlanFreeMemory_function_;
-  WlanCloseHandleFunction WlanCloseHandle_function_;
-
-  // NDIS variables.
-  std::vector<std::string16> interface_service_names_;
-  int oid_buffer_size_;
+  // Will schedule a scan; i.e. enqueue DoWifiScanTask deferred task.
+  void ScheduleNextScan();
 
   WifiData wifi_data_;
-  Mutex data_mutex_;
-  // Events signalled to shut down the thread that polls for wifi data.
-  Event stop_event_;
+  Lock data_mutex_;
 
   // Whether we've successfully completed a scan for WiFi data (or the polling
   // thread has terminated early).
   bool is_first_scan_complete_;
 
-  DISALLOW_EVIL_CONSTRUCTORS(Win32WifiDataProvider);
+  // Underlying OS wifi API.
+  scoped_ptr<WlanApiInterface> wlan_api_;
+
+  // Controls the polling update interval.
+  scoped_ptr<PollingPolicyInterface> polling_policy_;
+
+  // Holder for the tasks which run on the thread; takes care of cleanup.
+  ScopedRunnableMethodFactory<Win32WifiDataProvider> task_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(Win32WifiDataProvider);
 };
 
-#endif  // GEARS_GEOLOCATION_WIFI_DATA_PROVIDER_WIN32_H__
+#endif  // CHROME_BROWSER_GEOLOCATION_WIFI_DATA_PROVIDER_WIN_H_