location: Update from geocode-glib

2 files changed, 584 insertions, 0 deletions

diff --git a/src/geocode-location.c b/src/geocode-location.c
new file mode 100644
index 0000000..44817d3
--- /dev/null
+++ b/src/geocode-location.c
@@ -0,0 +1,451 @@
+/*
+   Copyright (C) 2012 Bastien Nocera
+
+   The Gnome Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Library General Public License as
+   published by the Free Software Foundation; either version 2 of the
+   License, or (at your option) any later version.
+
+   The Gnome Library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Library General Public License for more details.
+
+   You should have received a copy of the GNU Library General Public
+   License along with the Gnome Library; see the file COPYING.LIB.  If not,
+   write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301  USA.
+
+   Authors: Bastien Nocera <hadess@hadess.net>
+            Zeeshan Ali (Khattak) <zeeshanak@gnome.org>
+
+ */
+
+#include <math.h>
+#include "geocode-location.h"
+
+#define EARTH_RADIUS_KM 6372.795
+
+/**
+ * SECTION:geocode-location
+ * @short_description: Geocode location object
+ * @include: geocode-glib/geocode-glib.h
+ *
+ * The #GeocodeLocation instance represents a location on earth, with an
+ * optional description.
+ **/
+
+struct _GeocodeLocationPrivate {
+        gdouble longitude;
+        gdouble latitude;
+        gdouble accuracy;
+        guint64 timestamp;
+        char   *description;
+};
+
+enum {
+        PROP_0,
+
+        PROP_LATITUDE,
+        PROP_LONGITUDE,
+        PROP_ACCURACY,
+        PROP_DESCRIPTION,
+        PROP_TIMESTAMP
+};
+
+G_DEFINE_TYPE (GeocodeLocation, geocode_location, G_TYPE_OBJECT)
+
+static void
+geocode_location_get_property (GObject    *object,
+                               guint       property_id,
+                               GValue     *value,
+                               GParamSpec *pspec)
+{
+        GeocodeLocation *location = GEOCODE_LOCATION (object);
+
+        switch (property_id) {
+        case PROP_DESCRIPTION:
+                g_value_set_string (value,
+                                    geocode_location_get_description (location));
+                break;
+
+        case PROP_LATITUDE:
+                g_value_set_double (value,
+                                    geocode_location_get_latitude (location));
+                break;
+
+        case PROP_LONGITUDE:
+                g_value_set_double (value,
+                                    geocode_location_get_longitude (location));
+                break;
+
+        case PROP_ACCURACY:
+                g_value_set_double (value,
+                                    geocode_location_get_accuracy (location));
+                break;
+
+        case PROP_TIMESTAMP:
+                g_value_set_uint64 (value,
+                                    geocode_location_get_timestamp (location));
+                break;
+
+        default:
+                /* We don't have any other property... */
+                G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+                break;
+        }
+}
+
+static void
+geocode_location_set_latitude (GeocodeLocation *loc,
+                               gdouble          latitude)
+{
+        g_return_if_fail (latitude >= -90.0 && latitude <= 90.0);
+
+        loc->priv->latitude = latitude;
+}
+
+static void
+geocode_location_set_longitude (GeocodeLocation *loc,
+                                gdouble          longitude)
+{
+        g_return_if_fail (longitude >= -180.0 && longitude <= 180.0);
+
+        loc->priv->longitude = longitude;
+}
+
+static void
+geocode_location_set_accuracy (GeocodeLocation *loc,
+                               gdouble          accuracy)
+{
+        g_return_if_fail (accuracy >= GEOCODE_LOCATION_ACCURACY_UNKNOWN);
+
+        loc->priv->accuracy = accuracy;
+}
+
+static void
+geocode_location_set_property(GObject      *object,
+                              guint         property_id,
+                              const GValue *value,
+                              GParamSpec   *pspec)
+{
+        GeocodeLocation *location = GEOCODE_LOCATION (object);
+
+        switch (property_id) {
+        case PROP_DESCRIPTION:
+                geocode_location_set_description (location,
+                                                  g_value_get_string (value));
+                break;
+
+        case PROP_LATITUDE:
+                geocode_location_set_latitude (location,
+                                               g_value_get_double (value));
+                break;
+
+        case PROP_LONGITUDE:
+                geocode_location_set_longitude (location,
+                                                g_value_get_double (value));
+                break;
+
+        case PROP_ACCURACY:
+                geocode_location_set_accuracy (location,
+                                                g_value_get_double (value));
+                break;
+
+        default:
+                /* We don't have any other property... */
+                G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+                break;
+        }
+}
+
+static void
+geocode_location_finalize (GObject *glocation)
+{
+        GeocodeLocation *location = (GeocodeLocation *) glocation;
+
+        g_clear_pointer (&location->priv->description, g_free);
+
+        G_OBJECT_CLASS (geocode_location_parent_class)->finalize (glocation);
+}
+
+static void
+geocode_location_class_init (GeocodeLocationClass *klass)
+{
+        GObjectClass *glocation_class = G_OBJECT_CLASS (klass);
+        GParamSpec *pspec;
+
+        glocation_class->finalize = geocode_location_finalize;
+        glocation_class->get_property = geocode_location_get_property;
+        glocation_class->set_property = geocode_location_set_property;
+
+        g_type_class_add_private (klass, sizeof (GeocodeLocationPrivate));
+
+        /**
+         * GeocodeLocation:description:
+         *
+         * The description of this location.
+         */
+        pspec = g_param_spec_string ("description",
+                                     "Description",
+                                     "Description of this location",
+                                     NULL,
+                                     G_PARAM_READWRITE |
+                                     G_PARAM_STATIC_STRINGS);
+        g_object_class_install_property (glocation_class, PROP_DESCRIPTION, pspec);
+
+        /**
+         * GeocodeLocation:latitude:
+         *
+         * The latitude of this location in degrees.
+         */
+        pspec = g_param_spec_double ("latitude",
+                                     "Latitude",
+                                     "The latitude of this location in degrees",
+                                     -90.0,
+                                     90.0,
+                                     0.0,
+                                     G_PARAM_READWRITE |
+                                     G_PARAM_STATIC_STRINGS);
+        g_object_class_install_property (glocation_class, PROP_LATITUDE, pspec);
+
+        /**
+         * GeocodeLocation:longitude:
+         *
+         * The longitude of this location in degrees.
+         */
+        pspec = g_param_spec_double ("longitude",
+                                     "Longitude",
+                                     "The longitude of this location in degrees",
+                                     -180.0,
+                                     180.0,
+                                     0.0,
+                                     G_PARAM_READWRITE |
+                                     G_PARAM_STATIC_STRINGS);
+        g_object_class_install_property (glocation_class, PROP_LONGITUDE, pspec);
+
+        /**
+         * GeocodeLocation:accuracy:
+         *
+         * The accuracy of this location in meters.
+         */
+        pspec = g_param_spec_double ("accuracy",
+                                     "Accuracy",
+                                     "The accuracy of this location in meters",
+                                     GEOCODE_LOCATION_ACCURACY_UNKNOWN,
+                                     G_MAXDOUBLE,
+                                     GEOCODE_LOCATION_ACCURACY_UNKNOWN,
+                                     G_PARAM_READWRITE |
+                                     G_PARAM_STATIC_STRINGS);
+        g_object_class_install_property (glocation_class, PROP_ACCURACY, pspec);
+
+        /**
+         * GeocodeLocation:timestamp:
+         *
+         * A timestamp in seconds since
+         * <ulink url="http://en.wikipedia.org/wiki/Unix_epoch">Epoch</ulink>.
+         */
+        pspec = g_param_spec_uint64 ("timestamp",
+                                     "Timestamp",
+                                     "The timestamp of this location "
+                                     "in seconds since Epoch",
+                                     0,
+                                     G_MAXINT64,
+                                     0,
+                                     G_PARAM_READABLE |
+                                     G_PARAM_STATIC_STRINGS);
+        g_object_class_install_property (glocation_class, PROP_TIMESTAMP, pspec);
+}
+
+static void
+geocode_location_init (GeocodeLocation *location)
+{
+        GTimeVal tv;
+
+        location->priv = G_TYPE_INSTANCE_GET_PRIVATE ((location),
+                                                      GEOCODE_TYPE_LOCATION,
+                                                      GeocodeLocationPrivate);
+
+        g_get_current_time (&tv);
+        location->priv->timestamp = tv.tv_sec;
+}
+
+/**
+ * geocode_location_new:
+ * @latitude: a valid latitude
+ * @longitude: a valid longitude
+ * @accuracy: accuracy of location in meters
+ *
+ * Creates a new #GeocodeLocation object.
+ *
+ * Returns: a new #GeocodeLocation object. Use g_object_unref() when done.
+ **/
+GeocodeLocation *
+geocode_location_new (gdouble latitude,
+                      gdouble longitude,
+                      gdouble accuracy)
+{
+        return g_object_new (GEOCODE_TYPE_LOCATION,
+                             "latitude", latitude,
+                             "longitude", longitude,
+                             "accuracy", accuracy,
+                             NULL);
+}
+
+/**
+ * geocode_location_new_with_description:
+ * @latitude: a valid latitude
+ * @longitude: a valid longitude
+ * @accuracy: accuracy of location in meters
+ * @description: a description for the location
+ *
+ * Creates a new #GeocodeLocation object.
+ *
+ * Returns: a new #GeocodeLocation object. Use g_object_unref() when done.
+ **/
+GeocodeLocation *
+geocode_location_new_with_description (gdouble     latitude,
+                                       gdouble     longitude,
+                                       gdouble     accuracy,
+                                       const char *description)
+{
+        return g_object_new (GEOCODE_TYPE_LOCATION,
+                             "latitude", latitude,
+                             "longitude", longitude,
+                             "accuracy", accuracy,
+                             "description", description,
+                             NULL);
+}
+
+/**
+ * geocode_location_set_description:
+ * @loc: a #GeocodeLocation
+ * @description: a description for the location
+ *
+ * Sets the description of @loc to @description.
+ **/
+void
+geocode_location_set_description (GeocodeLocation *loc,
+                                  const char      *description)
+{
+        g_return_if_fail (GEOCODE_IS_LOCATION (loc));
+
+        g_free (loc->priv->description);
+        loc->priv->description = g_strdup (description);
+}
+
+/**
+ * geocode_location_get_description:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the description of location @loc.
+ *
+ * Returns: The description of location @loc.
+ **/
+const char *
+geocode_location_get_description (GeocodeLocation *loc)
+{
+        g_return_val_if_fail (GEOCODE_IS_LOCATION (loc), NULL);
+
+        return loc->priv->description;
+}
+
+/**
+ * geocode_location_get_latitude:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the latitude of location @loc.
+ *
+ * Returns: The latitude of location @loc.
+ **/
+gdouble
+geocode_location_get_latitude (GeocodeLocation *loc)
+{
+        g_return_val_if_fail (GEOCODE_IS_LOCATION (loc), 0.0);
+
+        return loc->priv->latitude;
+}
+
+/**
+ * geocode_location_get_longitude:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the longitude of location @loc.
+ *
+ * Returns: The longitude of location @loc.
+ **/
+gdouble
+geocode_location_get_longitude (GeocodeLocation *loc)
+{
+        g_return_val_if_fail (GEOCODE_IS_LOCATION (loc), 0.0);
+
+        return loc->priv->longitude;
+}
+
+/**
+ * geocode_location_get_accuracy:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the accuracy (in meters) of location @loc.
+ *
+ * Returns: The accuracy of location @loc.
+ **/
+gdouble
+geocode_location_get_accuracy (GeocodeLocation *loc)
+{
+        g_return_val_if_fail (GEOCODE_IS_LOCATION (loc),
+                              GEOCODE_LOCATION_ACCURACY_UNKNOWN);
+
+        return loc->priv->accuracy;
+}
+
+/**
+ * geocode_location_get_timestamp:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the timestamp (in seconds since Epoc) of location @loc.
+ *
+ * Returns: The timestamp of location @loc.
+ **/
+guint64
+geocode_location_get_timestamp (GeocodeLocation *loc)
+{
+        g_return_val_if_fail (GEOCODE_IS_LOCATION (loc), -1);
+
+        return loc->priv->timestamp;
+}
+
+/**
+ * geocode_location_get_distance_from:
+ * @loca: a #GeocodeLocation
+ * @locb: a #GeocodeLocation
+ *
+ * Calculates the distance in km, along the curvature of the Earth,
+ * between 2 locations. Note that altitude changes are not
+ * taken into account.
+ *
+ * Returns: a distance in km.
+ **/
+double
+geocode_location_get_distance_from (GeocodeLocation *loca,
+                                    GeocodeLocation *locb)
+{
+        gdouble dlat, dlon, lat1, lat2;
+        gdouble a, c;
+
+        g_return_val_if_fail (GEOCODE_IS_LOCATION (loca), 0.0);
+        g_return_val_if_fail (GEOCODE_IS_LOCATION (locb), 0.0);
+
+        /* Algorithm from:
+         * http://www.movable-type.co.uk/scripts/latlong.html */
+
+        dlat = (locb->priv->latitude - loca->priv->latitude) * M_PI / 180.0;
+        dlon = (locb->priv->longitude - loca->priv->longitude) * M_PI / 180.0;
+        lat1 = loca->priv->latitude * M_PI / 180.0;
+        lat2 = locb->priv->latitude * M_PI / 180.0;
+
+        a = sin (dlat / 2) * sin (dlat / 2) +
+            sin (dlon / 2) * sin (dlon / 2) * cos (lat1) * cos (lat2);
+        c = 2 * atan2 (sqrt (a), sqrt (1-a));
+        return EARTH_RADIUS_KM * c;
+}
diff --git a/src/geocode-location.h b/src/geocode-location.h
new file mode 100644
index 0000000..6e1e8bf
--- /dev/null
+++ b/src/geocode-location.h
@@ -0,0 +1,133 @@
+/*
+   Copyright (C) 2012 Bastien Nocera
+
+   The Gnome Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Library General Public License as
+   published by the Free Software Foundation; either version 2 of the
+   License, or (at your option) any later version.
+
+   The Gnome Library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Library General Public License for more details.
+
+   You should have received a copy of the GNU Library General Public
+   License along with the Gnome Library; see the file COPYING.LIB.  If not,
+   write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301  USA.
+
+   Authors: Bastien Nocera <hadess@hadess.net>
+            Zeeshan Ali (Khattak) <zeeshanak@gnome.org>
+
+ */
+
+#ifndef GEOCODE_LOCATION_H
+#define GEOCODE_LOCATION_H
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+GType geocode_location_get_type (void) G_GNUC_CONST;
+
+#define GEOCODE_TYPE_LOCATION                  (geocode_location_get_type ())
+#define GEOCODE_LOCATION(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEOCODE_TYPE_LOCATION, GeocodeLocation))
+#define GEOCODE_IS_LOCATION(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEOCODE_TYPE_LOCATION))
+#define GEOCODE_LOCATION_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GEOCODE_TYPE_LOCATION, GeocodeLocationClass))
+#define GEOCODE_IS_LOCATION_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GEOCODE_TYPE_LOCATION))
+#define GEOCODE_LOCATION_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GEOCODE_TYPE_LOCATION, GeocodeLocationClass))
+
+typedef struct _GeocodeLocation        GeocodeLocation;
+typedef struct _GeocodeLocationClass   GeocodeLocationClass;
+typedef struct _GeocodeLocationPrivate GeocodeLocationPrivate;
+
+/**
+ * GeocodeLocation:
+ *
+ * All the fields in the #GeocodeLocation structure are private and should never be accessed directly.
+**/
+struct _GeocodeLocation {
+        /* <private> */
+        GObject parent_instance;
+        GeocodeLocationPrivate *priv;
+};
+
+/**
+ * GeocodeLocationClass:
+ *
+ * All the fields in the #GeocodeLocationClass structure are private and should never be accessed directly.
+**/
+struct _GeocodeLocationClass {
+        /* <private> */
+        GObjectClass parent_class;
+};
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_UNKNOWN:
+ *
+ * Constant representing unknown accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_UNKNOWN -1
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_STREET:
+ *
+ * Constant representing street-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_STREET 1000 /* 1 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_CITY:
+ *
+ * Constant representing city-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_CITY 15000 /* 15 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_REGION:
+ *
+ * Constant representing region-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_REGION 50000 /* 50 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_COUNTRY:
+ *
+ * Constant representing country-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_COUNTRY 300000 /* 300 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_CONTINENT:
+ *
+ * Constant representing continent-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_CONTINENT 3000000 /* 3000 km */
+
+#define GEOCODE_TYPE_LOCATION (geocode_location_get_type ())
+
+GeocodeLocation *geocode_location_new (gdouble latitude,
+                                       gdouble longitude,
+                                       gdouble accuracy);
+
+GeocodeLocation *geocode_location_new_with_description (gdouble     latitude,
+                                                        gdouble     longitude,
+                                                        gdouble     accuracy,
+                                                        const char *description);
+
+double geocode_location_get_distance_from              (GeocodeLocation *loca,
+                                                        GeocodeLocation *locb);
+
+void geocode_location_set_description                  (GeocodeLocation *loc,
+                                                        const char      *description);
+
+const char *geocode_location_get_description           (GeocodeLocation *loc);
+
+gdouble geocode_location_get_latitude                  (GeocodeLocation *loc);
+gdouble geocode_location_get_longitude                 (GeocodeLocation *loc);
+gdouble geocode_location_get_accuracy                  (GeocodeLocation *loc);
+guint64 geocode_location_get_timestamp                 (GeocodeLocation *loc);
+
+G_END_DECLS
+
+#endif /* GEOCODE_LOCATION_H */