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 "modules/geolocation/GeolocationClient.h"
36#include "platform/Timer.h"
37#include "platform/heap/Handle.h"
38#include "wtf/HashSet.h"
39#include "wtf/text/WTFString.h"
40
41namespace blink {
42
43class GeolocationController;
44class GeolocationPosition;
45
46// Provides a mock object for the geolocation client.
47class GeolocationClientMock : public GeolocationClient {
48public:
49    GeolocationClientMock();
50    virtual ~GeolocationClientMock();
51
52    void setPosition(GeolocationPosition*);
53    void setPositionUnavailableError(const String& errorMessage);
54    void setPermission(bool allowed);
55    int numberOfPendingPermissionRequests() const;
56
57    // GeolocationClient
58    virtual void startUpdating() OVERRIDE;
59    virtual void stopUpdating() OVERRIDE;
60    virtual void setEnableHighAccuracy(bool) OVERRIDE;
61    virtual GeolocationPosition* lastPosition() OVERRIDE;
62    virtual void requestPermission(Geolocation*) OVERRIDE;
63    virtual void cancelPermissionRequest(Geolocation*) OVERRIDE;
64    void controllerForTestAdded(GeolocationController*) OVERRIDE;
65    void controllerForTestRemoved(GeolocationController*) OVERRIDE;
66
67    virtual void trace(Visitor*) OVERRIDE;
68
69private:
70    void asyncUpdateController();
71    void controllerTimerFired(Timer<GeolocationClientMock>*);
72
73    void asyncUpdatePermission();
74    void permissionTimerFired(Timer<GeolocationClientMock>*);
75
76    void clearError();
77
78    typedef WillBeHeapHashSet<RawPtrWillBeWeakMember<GeolocationController> > GeolocationControllers;
79    GeolocationControllers m_controllers;
80
81    PersistentWillBeMember<GeolocationPosition> m_lastPosition;
82    bool m_hasError;
83    String m_errorMessage;
84    Timer<GeolocationClientMock> m_controllerTimer;
85    Timer<GeolocationClientMock> m_permissionTimer;
86    bool m_isActive;
87
88    enum PermissionState {
89        PermissionStateUnset,
90        PermissionStateAllowed,
91        PermissionStateDenied
92    };
93
94    PermissionState m_permissionState;
95
96    typedef PersistentHeapHashSetWillBeHeapHashSet<Member<Geolocation> > GeolocationSet;
97    GeolocationSet m_pendingPermissions;
98};
99
100}
101
102#endif
103