WebCore/GeolocationService.h

   1 /*
   2  * Copyright (C) 2008 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. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef GeolocationService_h
  27 #define GeolocationService_h
  28
  29 #include <wtf/Noncopyable.h>
  30
  31 namespace WebCore {
  32
  33 class GeolocationService;
  34 class Geoposition;
  35 class PositionError;
  36 class PositionOptions;
  37
  38 class GeolocationServiceClient {
  39 public:
  40     virtual ~GeolocationServiceClient() { }
  41     virtual void geolocationServicePositionChanged(GeolocationService*) { }
  42     virtual void geolocationServiceErrorOccurred(GeolocationService*) { }
  43     virtual void geolocationServiceCachePolicyChanged(GeolocationService*) { }
  44 };
  45
  46 class GeolocationService : public Noncopyable {
  47 public:
  48     static GeolocationService* create(GeolocationServiceClient*);
  49     virtual ~GeolocationService() {}
  50
  51     virtual bool startUpdating(PositionOptions*) { return false; }
  52     virtual void stopUpdating() {}
  53
  54     virtual void suspend() { }
  55     virtual void resume() { }
  56
  57     virtual Geoposition* lastPosition() const { return 0; }
  58     virtual PositionError* lastError() const { return 0; }
  59
  60     virtual void setShouldClearCache(bool) { }
  61     virtual bool shouldClearCache() const { return false; }
  62
  63     void positionChanged();
  64     void errorOccurred();
  65     void cachePolicyChanged();
  66
  67 protected:
  68     GeolocationService(GeolocationServiceClient*);
  69
  70 private:
  71     GeolocationServiceClient* m_geolocationServiceClient;
  72 };
  73
  74 } // namespace WebCore
  75
  76 #endif // GeolocationService_h