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/page/Page.h"
  30 #include "core/page/PageLifecycleObserver.h"
  31 #include "heap/Handle.h"
  32 #include "modules/geolocation/Geolocation.h"
  33 #include "wtf/HashSet.h"
  34 #include "wtf/Noncopyable.h"
  35 #include "wtf/RefPtr.h"
  36
  37 namespace WebCore {
  38
  39 class GeolocationInspectorAgent;
  40 class GeolocationClient;
  41 class GeolocationError;
  42 class GeolocationPosition;
  43 class Page;
  44
  45 class GeolocationController FINAL : public Supplement<Page>, public PageLifecycleObserver {
  46     WTF_MAKE_NONCOPYABLE(GeolocationController);
  47 public:
  48     virtual ~GeolocationController();
  49
  50     static PassOwnPtr<GeolocationController> create(Page*, GeolocationClient*);
  51
  52     void addObserver(Geolocation*, bool enableHighAccuracy);
  53     void removeObserver(Geolocation*);
  54
  55     void requestPermission(Geolocation*);
  56     void cancelPermissionRequest(Geolocation*);
  57
  58     void positionChanged(GeolocationPosition*);
  59     void errorOccurred(GeolocationError*);
  60
  61     GeolocationPosition* lastPosition();
  62
  63     void setClientForTest(GeolocationClient*);
  64     bool hasClientForTest() { return m_hasClientForTest; }
  65     GeolocationClient* client() { return m_client; }
  66
  67     // Inherited from PageLifecycleObserver.
  68     virtual void pageVisibilityChanged() OVERRIDE;
  69
  70     static const char* supplementName();
  71     static GeolocationController* from(Page* page) { return static_cast<GeolocationController*>(Supplement<Page>::from(page, supplementName())); }
  72
  73 private:
  74     GeolocationController(Page*, GeolocationClient*);
  75
  76     void startUpdatingIfNeeded();
  77     void stopUpdatingIfNeeded();
  78
  79     GeolocationClient* m_client;
  80     bool m_hasClientForTest;
  81
  82     RefPtr<GeolocationPosition> m_lastPosition;
  83     typedef WillBePersistentHeapHashSet<RefPtrWillBeMember<Geolocation> > ObserversSet;
  84     // All observers; both those requesting high accuracy and those not.
  85     ObserversSet m_observers;
  86     ObserversSet m_highAccuracyObservers;
  87     bool m_isClientUpdating;
  88     GeolocationInspectorAgent* m_inspectorAgent;
  89 };
  90
  91 } // namespace WebCore
  92
  93 #endif // GeolocationController_h