src/third_party/WebKit/Source/modules/geolocation/GeolocationController.h

   1 /*
   2  * Copyright (C) 2009 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef GeolocationController_h
  27 #define GeolocationController_h
  28
  29 #include "core/frame/LocalFrame.h"
  30 #include "core/page/PageLifecycleObserver.h"
  31 #include "modules/geolocation/Geolocation.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/HashSet.h"
  34 #include "wtf/Noncopyable.h"
  35
  36 namespace blink {
  37
  38 class GeolocationInspectorAgent;
  39 class GeolocationClient;
  40 class GeolocationError;
  41 class GeolocationPosition;
  42
  43 class GeolocationController FINAL : public NoBaseWillBeGarbageCollectedFinalized<GeolocationController>, public WillBeHeapSupplement<LocalFrame>, public PageLifecycleObserver {
  44     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(GeolocationController);
  45     WTF_MAKE_NONCOPYABLE(GeolocationController);
  46 public:
  47     virtual ~GeolocationController();
  48
  49     static PassOwnPtrWillBeRawPtr<GeolocationController> create(LocalFrame&, GeolocationClient*);
  50
  51     void addObserver(Geolocation*, bool enableHighAccuracy);
  52     void removeObserver(Geolocation*);
  53
  54     void requestPermission(Geolocation*);
  55     void cancelPermissionRequest(Geolocation*);
  56
  57     void positionChanged(GeolocationPosition*);
  58     void errorOccurred(GeolocationError*);
  59
  60     GeolocationPosition* lastPosition();
  61
  62     void setClientForTest(GeolocationClient*);
  63     bool hasClientForTest() { return m_hasClientForTest; }
  64     GeolocationClient* client() { return m_client; }
  65
  66     // Inherited from PageLifecycleObserver.
  67     virtual void pageVisibilityChanged() OVERRIDE;
  68
  69     static const char* supplementName();
  70     static GeolocationController* from(LocalFrame* frame) { return static_cast<GeolocationController*>(WillBeHeapSupplement<LocalFrame>::from(frame, supplementName())); }
  71
  72     // Inherited from Supplement.
  73     virtual void trace(Visitor*) OVERRIDE;
  74     virtual void willBeDestroyed() OVERRIDE;
  75     virtual void persistentHostHasBeenDestroyed() OVERRIDE;
  76
  77 private:
  78     GeolocationController(LocalFrame&, GeolocationClient*);
  79
  80     void startUpdatingIfNeeded();
  81     void stopUpdatingIfNeeded();
  82
  83     void detach();
  84
  85     GeolocationClient* m_client;
  86     bool m_hasClientForTest;
  87
  88     PersistentWillBeMember<GeolocationPosition> m_lastPosition;
  89     typedef PersistentHeapHashSetWillBeHeapHashSet<Member<Geolocation> > ObserversSet;
  90     // All observers; both those requesting high accuracy and those not.
  91     ObserversSet m_observers;
  92     ObserversSet m_highAccuracyObservers;
  93     bool m_isClientUpdating;
  94     RawPtrWillBeMember<GeolocationInspectorAgent> m_inspectorAgent;
  95 };
  96
  97 } // namespace blink
  98
  99 #endif // GeolocationController_h