src/third_party/WebKit/Source/modules/geolocation/testing/GeolocationClientMock.h

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  * Copyright (C) 2012 Apple Inc. All Rights Reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef GeolocationClientMock_h
  33 #define GeolocationClientMock_h
  34
  35 #include "heap/Handle.h"
  36 #include "modules/geolocation/GeolocationClient.h"
  37 #include "platform/Timer.h"
  38 #include "wtf/HashSet.h"
  39 #include "wtf/PassRefPtr.h"
  40 #include "wtf/RefPtr.h"
  41 #include "wtf/text/WTFString.h"
  42
  43 namespace WebCore {
  44
  45 class GeolocationController;
  46 class GeolocationPosition;
  47
  48 // Provides a mock object for the geolocation client.
  49 class GeolocationClientMock : public GeolocationClient {
  50 public:
  51     GeolocationClientMock();
  52     virtual ~GeolocationClientMock();
  53
  54     void setController(GeolocationController*);
  55
  56     void setPosition(PassRefPtr<GeolocationPosition>);
  57     void setPositionUnavailableError(const String& errorMessage);
  58     void setPermission(bool allowed);
  59     int numberOfPendingPermissionRequests() const;
  60
  61     // GeolocationClient
  62     virtual void geolocationDestroyed() OVERRIDE;
  63     virtual void startUpdating() OVERRIDE;
  64     virtual void stopUpdating() OVERRIDE;
  65     virtual void setEnableHighAccuracy(bool) OVERRIDE;
  66     virtual GeolocationPosition* lastPosition() OVERRIDE;
  67     virtual void requestPermission(Geolocation*) OVERRIDE;
  68     virtual void cancelPermissionRequest(Geolocation*) OVERRIDE;
  69
  70 private:
  71     void asyncUpdateController();
  72     void controllerTimerFired(Timer<GeolocationClientMock>*);
  73
  74     void asyncUpdatePermission();
  75     void permissionTimerFired(Timer<GeolocationClientMock>*);
  76
  77     void clearError();
  78
  79     GeolocationController* m_controller;
  80     RefPtr<GeolocationPosition> m_lastPosition;
  81     bool m_hasError;
  82     String m_errorMessage;
  83     Timer<GeolocationClientMock> m_controllerTimer;
  84     Timer<GeolocationClientMock> m_permissionTimer;
  85     bool m_isActive;
  86
  87     enum PermissionState {
  88         PermissionStateUnset,
  89         PermissionStateAllowed,
  90         PermissionStateDenied
  91     };
  92
  93     PermissionState m_permissionState;
  94     typedef WillBePersistentHeapHashSet<RefPtrWillBeMember<Geolocation> > GeolocationSet;
  95     GeolocationSet m_pendingPermissions;
  96 };
  97
  98 }
  99
 100 #endif