[gnome-maps/wip/mlundblad/transit-plugin-gtfs-local: 10/16] WIP: Add class representing a stop in a GTFS feed

[Marcus Lundblad <mlundblad src gnome org>]

commit dabbf8fcc1c59200d02f757b3996a0020837d6f3
Author: Marcus Lundblad <ml update uu se>
Date:   Sun Feb 23 14:42:37 2020 +0100

    WIP: Add class representing a stop in a GTFS feed

 lib/maps-gtfs-stop.c | 222 +++++++++++++++++++++++++++++++++++++++++++++++++++
 lib/maps-gtfs-stop.h |  58 ++++++++++++++
 lib/maps.h           |   1 +
 lib/meson.build      |   2 +
 4 files changed, 283 insertions(+)
---
diff --git a/lib/maps-gtfs-stop.c b/lib/maps-gtfs-stop.c
new file mode 100644
index 00000000..b71cebd0
--- /dev/null
+++ b/lib/maps-gtfs-stop.c
@@ -0,0 +1,222 @@
+/*
+ * Copyright (c) 2020 Marcus Lundblad
+ *
+ * GNOME Maps is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * GNOME Maps 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 General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with GNOME Maps; if not, see <http://www.gnu.org/licenses/>
+ *
+ * Author: Marcus Lundblad <ml update uu se>
+ */
+
+#include "maps-gtfs-stop.h"
+#include "maps-enum-types.h"
+
+#include <math.h>
+
+struct _MapsGTFSStop
+{
+  GObject parent_instance;
+};
+
+typedef struct
+{
+  gchar *id;
+  gchar *code;
+  gchar *name;
+  gchar *desc;
+  float lat;
+  float lon;
+  MapsGTFSStopLocationType location_type;
+  gchar *parent_station;
+  GTimeZone *timezone;
+} MapsGTFSStopPrivate;
+
+G_DEFINE_TYPE_WITH_PRIVATE (MapsGTFSStop, maps_gtfs_stop, G_TYPE_OBJECT)
+
+enum {
+  PROP_0,
+  PROP_ID,
+  PROP_CODE,
+  PROP_NAME,
+  PROP_DESC,
+  PROP_LAT,
+  PROP_LON,
+  PROP_LOCATION_TYPE,
+  PROP_PARENT_STATION,
+  PROP_TIMEZONE,
+  N_PROPS
+};
+
+static GParamSpec *properties [N_PROPS];
+
+/**
+ * maps_gtfs_stop_new:
+ *
+ * Create a new #MapsGTFSStop.
+ *
+ * Returns: (transfer full): a newly created #MapsGTFSStop
+ */
+MapsGTFSStop *
+maps_gtfs_stop_new (gchar *id, gchar *code, gchar *name, gchar *desc,
+                    float lat, float lon,
+                    MapsGTFSStopLocationType location_type,
+                    gchar *parent_station, GTimeZone *timezone)
+{
+  MapsGTFSStop *stop = MAPS_GTFS_STOP (g_object_new (MAPS_TYPE_GTFS_STOP, NULL));
+  MapsGTFSStopPrivate *priv = maps_gtfs_stop_get_instance_private (stop);
+
+  priv->id = g_strdup (id);
+  priv->code = g_strdup (code);
+  priv->name = g_strdup (name);
+  priv->desc = g_strdup (desc);
+  priv->lat = lat;
+  priv->lon = lon;
+  priv->location_type = location_type;
+  priv->parent_station = g_strdup (parent_station);
+  priv->timezone = timezone ? g_time_zone_ref (timezone) : NULL;
+
+  return stop;
+}
+
+static void
+maps_gtfs_stop_finalize (GObject *object)
+{
+  MapsGTFSStop *self = (MapsGTFSStop *)object;
+  MapsGTFSStopPrivate *priv = maps_gtfs_stop_get_instance_private (self);
+
+  g_clear_pointer (&priv->id, g_free);
+  g_clear_pointer (&priv->code, g_free);
+  g_clear_pointer (&priv->name, g_free);
+  g_clear_pointer (&priv->desc, g_free);
+  g_clear_pointer (&priv->parent_station, g_free);
+  if (priv->timezone)
+    g_clear_pointer (&priv->timezone, g_time_zone_unref);
+
+  G_OBJECT_CLASS (maps_gtfs_stop_parent_class)->finalize (object);
+}
+
+static void
+maps_gtfs_stop_get_property (GObject    *object,
+                             guint       prop_id,
+                             GValue     *value,
+                             GParamSpec *pspec)
+{
+  MapsGTFSStop *self = MAPS_GTFS_STOP (object);
+  MapsGTFSStopPrivate *priv = maps_gtfs_stop_get_instance_private (self);
+
+  switch (prop_id)
+    {
+    case PROP_ID:
+      g_value_set_string (value, priv->id);
+      break;
+    case PROP_CODE:
+      g_value_set_string (value, priv->code);
+      break;
+    case PROP_NAME:
+      g_value_set_string (value, priv->name);
+      break;
+    case PROP_DESC:
+      g_value_set_string (value, priv->desc);
+      break;
+    case PROP_LAT:
+      g_value_set_float (value, priv->lat);
+      break;
+    case PROP_LON:
+      g_value_set_float (value, priv->lon);
+      break;
+    case PROP_LOCATION_TYPE:
+      g_value_set_enum (value, priv->location_type);
+      break;
+    case PROP_PARENT_STATION:
+      g_value_set_string (value, priv->parent_station);
+      break;
+    case PROP_TIMEZONE:
+      g_value_set_boxed (value, priv->timezone);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+maps_gtfs_stop_class_init (MapsGTFSStopClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->finalize = maps_gtfs_stop_finalize;
+  object_class->get_property = maps_gtfs_stop_get_property;
+
+  properties[PROP_ID] =
+    g_param_spec_string ("id",
+                         "ID", "Unique identifier for stop",
+                         NULL,
+                         G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+  properties[PROP_CODE] =
+    g_param_spec_string ("code",
+                         "Code", "Short text or a number that identifies the location for riders",
+                         NULL,
+                         G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+  properties[PROP_NAME] =
+    g_param_spec_string ("name",
+                         "Name", "Name of the location",
+                         NULL,
+                         G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+  properties[PROP_DESC] =
+    g_param_spec_string ("desc",
+                         "Description", "Description of the location that provides useful, quality 
information",
+                         NULL,
+                         G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+  properties[PROP_LAT] =
+    g_param_spec_float ("lat",
+                        "Latitude", "Latitude of location",
+                        -90, 90, 0,
+                        G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+  properties[PROP_LON] =
+    g_param_spec_float ("lon",
+                        "Longitude", "Longitude of location",
+                        -180, 180, 0,
+                        G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+  properties[PROP_LOCATION_TYPE] =
+    g_param_spec_enum ("location_type",
+                       "Location type", "Type of the location",
+                       MAPS_TYPE_GTFS_STOP_LOCATION_TYPE,
+                       MAPS_GTFS_STOP_STOP,
+                       G_PARAM_READABLE|G_PARAM_STATIC_STRINGS);
+  properties[PROP_ID] =
+    g_param_spec_string ("parent_station",
+                         "Parent station", "Identifier for parent station",
+                         NULL,
+                         G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+  properties[PROP_TIMEZONE] =
+    g_param_spec_boxed ("timezone",
+                        "Timezone", "Local timezone for stop (if different from agency's)",
+                        G_TYPE_TIME_ZONE,
+                        G_PARAM_READABLE|G_PARAM_EXPLICIT_NOTIFY);
+
+  g_object_class_install_properties (object_class, N_PROPS, properties);
+}
+
+static void
+maps_gtfs_stop_init (MapsGTFSStop *self)
+{
+  MapsGTFSStopPrivate *priv = maps_gtfs_stop_get_instance_private (self);
+
+  priv->id = NULL;
+  priv->code = NULL;
+  priv->name = NULL;
+  priv->desc = NULL;
+  priv->lat = 0.0f;
+  priv->lon = 0.0f;
+  priv->location_type = MAPS_GTFS_STOP_STOP;
+  priv->parent_station = NULL;
+  priv->timezone = NULL;
+}
diff --git a/lib/maps-gtfs-stop.h b/lib/maps-gtfs-stop.h
new file mode 100644
index 00000000..fae286a3
--- /dev/null
+++ b/lib/maps-gtfs-stop.h
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2020 Marcus Lundblad
+ *
+ * GNOME Maps is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * GNOME Maps 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 General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with GNOME Maps; if not, see <http://www.gnu.org/licenses/>
+ *
+ * Author: Marcus Lundblad <ml update uu se>
+ */
+
+#pragma once
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+/**
+ * MapsGTFSStopLocationType:
+ * @MAPS_GTFS_STOP_STOP: Stop or platform.
+ * @MAPS_GTFS_STOP_STATION: A physical structure or area that contains one or more platform.
+ * @MAPS_GTFS_STOP_ENTRANCE_EXIT: Entrance or exit to/from a station.
+ * @MAPS_GTFS_STOP_GENERIC_NODE: A location within a station.
+ * @MAPS_GTFS_STOP_BOARDING_AREA: A specific location on a platform, where passengers can board and/or 
alight vehicles.
+ */
+typedef enum
+{
+  MAPS_GTFS_STOP_STOP,
+  MAPS_GTFS_STOP_STATION,
+  MAPS_GTFS_STOP_ENTRANCE_EXIT,
+  MAPS_GTFS_STOP_GENERIC_NODE,
+  MAPS_GTFS_STOP_BOARDING_AREA
+} MapsGTFSStopLocationType;
+
+#define MAPS_TYPE_GTFS_STOP (maps_gtfs_stop_get_type())
+
+G_DECLARE_FINAL_TYPE (MapsGTFSStop, maps_gtfs_stop, MAPS, GTFS_STOP, GObject)
+
+struct _MapsGTFSStopClass
+{
+  GObjectClass parent_class;
+};
+
+MapsGTFSStop *maps_gtfs_stop_new (gchar *id, gchar *code, gchar *name, gchar *desc,
+                                  float lat, float lon,
+                                  MapsGTFSStopLocationType location_type,
+                                  gchar *parent_station, GTimeZone *timezone);
+
+G_END_DECLS
+
diff --git a/lib/maps.h b/lib/maps.h
index a6916d2b..949840a4 100644
--- a/lib/maps.h
+++ b/lib/maps.h
@@ -21,5 +21,6 @@
 #include <glib-object.h>
 #include "maps-contact-store.h"
 #include "maps-contact.h"
+#include "maps-gtfs-stop.h"
 
 #endif
diff --git a/lib/meson.build b/lib/meson.build
index 401325f6..170d43d9 100644
--- a/lib/meson.build
+++ b/lib/meson.build
@@ -5,6 +5,7 @@ headers_private = files(
        'maps-contact-store.h',
        'maps-file-tile-source.h',
        'maps-gtfs-agency.h',
+       'maps-gtfs-stop.h',
        'maps-osm.h',
        'maps-osm-changeset.h',
        'maps-osm-node.h',
@@ -19,6 +20,7 @@ sources = files(
        'maps-contact-store.c',
        'maps-file-tile-source.c',
        'maps-gtfs-agency.c',
+       'maps-gtfs-stop.c',
        'maps-osm.c',
        'maps-osm-changeset.c',
        'maps-osm-node.c',