/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
/*
* viking
- * Copyright (C) Guilhem Bonnefille 2009 <guilhem.bonnefille@gmail.com>
+ * Copyright (C) 2009-2010, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
*
* viking is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+
+ /**
+ * SECTION:vikmapsource
+ * @short_description: the base class to describe map source
+ *
+ * The #VikMapSource class is both the interface and the base class
+ * for the hierarchie of map source.
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "vikviewport.h"
#include "vikcoord.h"
#include "mapcoord.h"
-
+#include "download.h"
#include "vikmapsource.h"
static void vik_map_source_init (VikMapSource *object);
static void vik_map_source_finalize (GObject *object);
static void vik_map_source_class_init (VikMapSourceClass *klass);
-G_DEFINE_TYPE_EXTENDED (VikMapSource, vik_map_source, G_TYPE_OBJECT, (GTypeFlags)G_TYPE_FLAG_ABSTRACT,);
+static gboolean _supports_download_only_new (VikMapSource *object);
+
+G_DEFINE_ABSTRACT_TYPE (VikMapSource, vik_map_source, G_TYPE_OBJECT);
static void
vik_map_source_init (VikMapSource *object)
{
GObjectClass* object_class = G_OBJECT_CLASS (klass);
+ klass->get_copyright = NULL;
+ klass->get_license = NULL;
+ klass->get_license_url = NULL;
+ klass->get_logo = NULL;
+ klass->get_name = NULL;
klass->get_uniq_id = NULL;
klass->get_label = NULL;
klass->get_tilesize_x = NULL;
klass->get_tilesize_y = NULL;
klass->get_drawmode = NULL;
+ klass->is_direct_file_access = NULL;
+ klass->is_mbtiles = NULL;
+ klass->supports_download_only_new = _supports_download_only_new;
+ klass->get_zoom_min = NULL;
+ klass->get_zoom_max = NULL;
+ klass->get_lat_min = NULL;
+ klass->get_lat_max = NULL;
+ klass->get_lon_min = NULL;
+ klass->get_lon_max = NULL;
klass->coord_to_mapcoord = NULL;
klass->mapcoord_to_center_coord = NULL;
klass->download = NULL;
+ klass->download_handle_init = NULL;
+ klass->download_handle_cleanup = NULL;
object_class->finalize = vik_map_source_finalize;
}
+gboolean
+_supports_download_only_new (VikMapSource *self)
+{
+ // Default feature: does not support
+ return FALSE;
+}
-guint8
+/**
+ * vik_map_source_get_copyright:
+ * @self: the VikMapSource of interest.
+ * @bbox: bounding box of interest.
+ * @zoom: the zoom level of interest.
+ * @fct: the callback function to use to return matching copyrights.
+ * @data: the user data to use to call the callbaack function.
+ *
+ * Retrieve copyright(s) for the corresponding bounding box and zoom level.
+ */
+void
+vik_map_source_get_copyright (VikMapSource *self, LatLonBBox bbox, gdouble zoom, void (*fct)(VikViewport*,const gchar*), void *data)
+{
+ VikMapSourceClass *klass;
+ g_return_if_fail (self != NULL);
+ g_return_if_fail (VIK_IS_MAP_SOURCE (self));
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_if_fail (klass->get_copyright != NULL);
+
+ (*klass->get_copyright)(self, bbox, zoom, fct, data);
+}
+
+const gchar *
+vik_map_source_get_license (VikMapSource *self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, NULL);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_license != NULL, NULL);
+
+ return (*klass->get_license)(self);
+}
+
+const gchar *
+vik_map_source_get_license_url (VikMapSource *self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, NULL);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_license_url != NULL, NULL);
+
+ return (*klass->get_license_url)(self);
+}
+
+const GdkPixbuf *
+vik_map_source_get_logo (VikMapSource *self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, NULL);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_logo != NULL, NULL);
+
+ return (*klass->get_logo)(self);
+}
+
+const gchar *
+vik_map_source_get_name (VikMapSource *self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, NULL);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_name != NULL, NULL);
+
+ return (*klass->get_name)(self);
+}
+
+guint16
vik_map_source_get_uniq_id (VikMapSource *self)
{
VikMapSourceClass *klass;
- g_return_val_if_fail (self != NULL, (guint8 )0);
- g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), (guint8 )0);
+ g_return_val_if_fail (self != NULL, (guint16 )0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), (guint16 )0);
klass = VIK_MAP_SOURCE_GET_CLASS(self);
- g_return_val_if_fail (klass->get_uniq_id != NULL, (guint8 )0);
+ g_return_val_if_fail (klass->get_uniq_id != NULL, (guint16 )0);
return (*klass->get_uniq_id)(self);
}
return (*klass->get_drawmode)(self);
}
+/**
+ * vik_map_source_is_direct_file_access:
+ * @self: the VikMapSource of interest.
+ *
+ * Return true when we can bypass all this download malarky
+ * Treat the files as a pre generated data set in OSM tile server layout: tiledir/%d/%d/%d.png
+ */
+gboolean
+vik_map_source_is_direct_file_access (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->is_direct_file_access != NULL, 0);
+
+ return (*klass->is_direct_file_access)(self);
+}
+
+/**
+ * vik_map_source_is_mbtiles:
+ * @self: the VikMapSource of interest.
+ *
+ * Return true when the map is in an MB Tiles format.
+ * See http://github.com/mapbox/mbtiles-spec
+ * (Read Only ATM)
+ */
+gboolean
+vik_map_source_is_mbtiles (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->is_mbtiles != NULL, 0);
+
+ return (*klass->is_mbtiles)(self);
+}
+
+/**
+ * vik_map_source_is_osm_meta_tiles:
+ * @self: the VikMapSource of interest.
+ *
+ * Treat the files as a pre generated data set directly by tirex or renderd
+ * tiledir/Z/[xxxxyyyy]/[xxxxyyyy]/[xxxxyyyy]/[xxxxyyyy]/[xxxxyyyy].meta
+ */
+gboolean vik_map_source_is_osm_meta_tiles (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->is_osm_meta_tiles != NULL, 0);
+
+ return (*klass->is_osm_meta_tiles)(self);
+}
+
+gboolean
+vik_map_source_supports_download_only_new (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->supports_download_only_new != NULL, 0);
+
+ return (*klass->supports_download_only_new)(self);
+}
+
+/**
+ *
+ */
+guint8
+vik_map_source_get_zoom_min (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+ g_return_val_if_fail (klass->get_zoom_min != NULL, 0);
+ return (*klass->get_zoom_min)(self);
+}
+
+/**
+ *
+ */
+guint8
+vik_map_source_get_zoom_max (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 18);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 18);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+ g_return_val_if_fail (klass->get_zoom_max != NULL, 18);
+ return (*klass->get_zoom_max)(self);
+}
+
+/**
+ *
+ */
+gdouble
+vik_map_source_get_lat_max (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 90.0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 90.0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+ g_return_val_if_fail (klass->get_lat_max != NULL, 90.0);
+ return (*klass->get_lat_max)(self);
+}
+
+/**
+ *
+ */
+gdouble
+vik_map_source_get_lat_min (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, -90.0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), -90.0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+ g_return_val_if_fail (klass->get_lat_min != NULL, -90.0);
+ return (*klass->get_lat_min)(self);
+}
+
+/**
+ *
+ */
+gdouble
+vik_map_source_get_lon_max (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 180.0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 180.0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+ g_return_val_if_fail (klass->get_lon_max != NULL, 180.0);
+ return (*klass->get_lon_max)(self);
+}
+
+/**
+ *
+ */
+gdouble
+vik_map_source_get_lon_min (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, -180.0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), -180.0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+ g_return_val_if_fail (klass->get_lon_min != NULL, -180.0);
+ return (*klass->get_lon_min)(self);
+}
+
+/**
+ * vik_map_source_get_file_extension:
+ * @self: the VikMapSource of interest.
+ *
+ * Returns the file extension of files held on disk.
+ * Typically .png but may be .jpg or whatever the user defines
+ *
+ */
+const gchar *
+vik_map_source_get_file_extension (VikMapSource * self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, NULL);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_file_extension != NULL, NULL);
+
+ return (*klass->get_file_extension)(self);
+}
+
gboolean
vik_map_source_coord_to_mapcoord (VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
{
g_return_if_fail (klass->mapcoord_to_center_coord != NULL);
- return (*klass->mapcoord_to_center_coord)(self, src, dest);
+ (*klass->mapcoord_to_center_coord)(self, src, dest);
}
-int
-vik_map_source_download (VikMapSource * self, MapCoord * src, const gchar * dest_fn)
+/**
+ * vik_map_source_download:
+ * @self: The VikMapSource of interest.
+ * @src: The map location to download
+ * @dest_fn: The filename to save the result in
+ * @handle: Potential reusable Curl Handle (may be NULL)
+ *
+ * Returns: How successful the download was as per the type #DownloadResult_t
+ */
+DownloadResult_t
+vik_map_source_download (VikMapSource * self, MapCoord * src, const gchar * dest_fn, void *handle)
{
VikMapSourceClass *klass;
g_return_val_if_fail (self != NULL, 0);
g_return_val_if_fail (klass->download != NULL, 0);
- return (*klass->download)(self, src, dest_fn);
+ return (*klass->download)(self, src, dest_fn, handle);
+}
+
+void *
+vik_map_source_download_handle_init (VikMapSource *self)
+{
+ VikMapSourceClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->download_handle_init != NULL, 0);
+
+ return (*klass->download_handle_init)(self);
+}
+
+void
+vik_map_source_download_handle_cleanup (VikMapSource * self, void * handle)
+{
+ VikMapSourceClass *klass;
+ g_return_if_fail (self != NULL);
+ g_return_if_fail (VIK_IS_MAP_SOURCE (self));
+ klass = VIK_MAP_SOURCE_GET_CLASS(self);
+
+ g_return_if_fail (klass->download_handle_cleanup != NULL);
+
+ (*klass->download_handle_cleanup)(self, handle);
}
projects / andy / viking.git / blobdiff