/* -*- 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
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+ /**
+ * SECTION:vikmapsourcedefault
+ * @short_description: the base class implementing most of generic features
+ *
+ * The #VikMapSourceDefault class is the base class implementing most of
+ * generic feature, using properties or reducing complexity of some
+ * functions.
+ */
+
#include "vikmapsourcedefault.h"
#include "vikenumtypes.h"
+#include "download.h"
+
+static void map_source_get_copyright (VikMapSource *self, LatLonBBox bbox, gdouble zoom, void (*fct)(VikViewport*,const gchar*), void *data);
+static const gchar *map_source_get_license (VikMapSource *self);
+static const gchar *map_source_get_license_url (VikMapSource *self);
+static const GdkPixbuf *map_source_get_logo (VikMapSource *self);
-static guint8 map_source_get_uniq_id (VikMapSource *self);
+static guint16 map_source_get_uniq_id (VikMapSource *self);
static const gchar *map_source_get_label (VikMapSource *self);
static guint16 map_source_get_tilesize_x (VikMapSource *self);
static guint16 map_source_get_tilesize_y (VikMapSource *self);
static VikViewportDrawMode map_source_get_drawmode (VikMapSource *self);
+static int _download ( VikMapSource *self, MapCoord *src, const gchar *dest_fn, void *handle );
+static void * _download_handle_init ( VikMapSource *self );
+static void _download_handle_cleanup ( VikMapSource *self, void *handle );
+
typedef struct _VikMapSourceDefaultPrivate VikMapSourceDefaultPrivate;
struct _VikMapSourceDefaultPrivate
{
- guint8 uniq_id;
+ /* legal stuff */
+ gchar *copyright;
+ gchar *license;
+ gchar *license_url;
+ GdkPixbuf *logo;
+
+ guint16 uniq_id;
gchar *label;
guint16 tilesize_x;
guint16 tilesize_y;
PROP_TILESIZE_X,
PROP_TILESIZE_Y,
PROP_DRAWMODE,
+ PROP_COPYRIGHT,
+ PROP_LICENSE,
+ PROP_LICENSE_URL,
};
-G_DEFINE_TYPE_EXTENDED (VikMapSourceDefault, vik_map_source_default, VIK_TYPE_MAP_SOURCE, (GTypeFlags)G_TYPE_FLAG_ABSTRACT,);
+G_DEFINE_ABSTRACT_TYPE (VikMapSourceDefault, vik_map_source_default, VIK_TYPE_MAP_SOURCE);
static void
vik_map_source_default_init (VikMapSourceDefault *object)
VikMapSourceDefaultPrivate *priv = VIK_MAP_SOURCE_DEFAULT_PRIVATE (self);
priv->label = NULL;
+ priv->copyright = NULL;
+ priv->license = NULL;
+ priv->license_url = NULL;
+ priv->logo = NULL;
}
static void
g_free (priv->label);
priv->label = NULL;
+ g_free (priv->copyright);
+ priv->copyright = NULL;
+ g_free (priv->license);
+ priv->license = NULL;
+ g_free (priv->license_url);
+ priv->license_url = NULL;
+ g_free (priv->logo);
+ priv->license_url = NULL;
G_OBJECT_CLASS (vik_map_source_default_parent_class)->finalize (object);
}
priv->uniq_id = g_value_get_uint (value);
break;
- case PROP_LABEL:
+ case PROP_LABEL:
g_free (priv->label);
priv->label = g_strdup(g_value_get_string (value));
break;
priv->drawmode = g_value_get_enum(value);
break;
+ case PROP_COPYRIGHT:
+ g_free (priv->copyright);
+ priv->copyright = g_strdup(g_value_get_string (value));
+ break;
+
+ case PROP_LICENSE:
+ g_free (priv->license);
+ priv->license = g_strdup(g_value_get_string (value));
+ break;
+
+ case PROP_LICENSE_URL:
+ g_free (priv->license_url);
+ priv->license_url = g_strdup(g_value_get_string (value));
+ break;
+
default:
/* We don't have any other property... */
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
g_value_set_enum (value, priv->drawmode);
break;
+ case PROP_COPYRIGHT:
+ g_value_set_string (value, priv->copyright);
+ break;
+
+ case PROP_LICENSE:
+ g_value_set_string (value, priv->license);
+ break;
+
+ case PROP_LICENSE_URL:
+ g_value_set_string (value, priv->license_url);
+ break;
+
default:
/* We don't have any other property... */
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
object_class->get_property = vik_map_source_default_get_property;
/* Overiding methods */
+ parent_class->get_copyright = map_source_get_copyright;
+ parent_class->get_license = map_source_get_license;
+ parent_class->get_license_url = map_source_get_license_url;
+ parent_class->get_logo = map_source_get_logo;
parent_class->get_uniq_id = map_source_get_uniq_id;
parent_class->get_label = map_source_get_label;
parent_class->get_tilesize_x = map_source_get_tilesize_x;
parent_class->get_tilesize_y = map_source_get_tilesize_y;
parent_class->get_drawmode = map_source_get_drawmode;
+ parent_class->download = _download;
+ parent_class->download_handle_init = _download_handle_init;
+ parent_class->download_handle_cleanup = _download_handle_cleanup;
+
+ /* Default implementation of methods */
+ klass->get_uri = NULL;
+ klass->get_hostname = NULL;
+ klass->get_download_options = NULL;
pspec = g_param_spec_uint ("id",
"Id of the tool",
G_PARAM_READWRITE);
g_object_class_install_property(object_class, PROP_DRAWMODE, pspec);
+ pspec = g_param_spec_string ("copyright",
+ "Copyright",
+ "The copyright of the map source",
+ NULL,
+ G_PARAM_READWRITE);
+ g_object_class_install_property (object_class, PROP_COPYRIGHT, pspec);
+
+ pspec = g_param_spec_string ("license",
+ "License",
+ "The license of the map source",
+ NULL,
+ G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+ g_object_class_install_property (object_class, PROP_LICENSE, pspec);
+
+ pspec = g_param_spec_string ("license-url",
+ "License URL",
+ "The URL of the license of the map source",
+ NULL,
+ G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE);
+ g_object_class_install_property (object_class, PROP_LICENSE_URL, pspec);
+
g_type_class_add_private (klass, sizeof (VikMapSourceDefaultPrivate));
object_class->finalize = vik_map_source_default_finalize;
}
-static guint8
+static void
+map_source_get_copyright (VikMapSource *self, LatLonBBox bbox, gdouble zoom, void (*fct)(VikViewport*,const gchar*), void *data)
+{
+ /* Just ignore bbox and zoom level */
+ g_return_if_fail (VIK_IS_MAP_SOURCE_DEFAULT(self));
+
+ g_debug ("%s: %g %g %g %g %g", __FUNCTION__,
+ bbox.south, bbox.north, bbox.east, bbox.west,
+ zoom);
+
+ VikMapSourceDefaultPrivate *priv = VIK_MAP_SOURCE_DEFAULT_PRIVATE(self);
+
+ (*fct) (data, priv->copyright);
+}
+
+static const gchar *
+map_source_get_license (VikMapSource *self)
+{
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT(self), NULL);
+
+ VikMapSourceDefaultPrivate *priv = VIK_MAP_SOURCE_DEFAULT_PRIVATE(self);
+
+ return priv->license;
+}
+
+static const gchar *
+map_source_get_license_url (VikMapSource *self)
+{
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT(self), NULL);
+
+ VikMapSourceDefaultPrivate *priv = VIK_MAP_SOURCE_DEFAULT_PRIVATE(self);
+
+ return priv->license_url;
+}
+
+static const GdkPixbuf *
+map_source_get_logo (VikMapSource *self)
+{
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT(self), NULL);
+
+ VikMapSourceDefaultPrivate *priv = VIK_MAP_SOURCE_DEFAULT_PRIVATE(self);
+
+ return priv->logo;
+}
+
+static guint16
map_source_get_uniq_id (VikMapSource *self)
{
- g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT(self), (guint8)0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT(self), (guint16)0);
VikMapSourceDefaultPrivate *priv = VIK_MAP_SOURCE_DEFAULT_PRIVATE(self);
return priv->drawmode;
}
+
+static int
+_download ( VikMapSource *self, MapCoord *src, const gchar *dest_fn, void *handle )
+{
+ int res;
+ gchar *uri = vik_map_source_default_get_uri(VIK_MAP_SOURCE_DEFAULT(self), src);
+ gchar *host = vik_map_source_default_get_hostname(VIK_MAP_SOURCE_DEFAULT(self));
+ DownloadMapOptions *options = vik_map_source_default_get_download_options(VIK_MAP_SOURCE_DEFAULT(self));
+ res = a_http_download_get_url ( host, uri, dest_fn, options, handle );
+ g_free ( uri );
+ g_free ( host );
+ return res;
+}
+
+static void *
+_download_handle_init ( VikMapSource *self )
+{
+ return a_download_handle_init ();
+}
+
+
+static void
+_download_handle_cleanup ( VikMapSource *self, void *handle )
+{
+ a_download_handle_cleanup ( handle );
+}
+
+gchar *
+vik_map_source_default_get_uri( VikMapSourceDefault *self, MapCoord *src )
+{
+ VikMapSourceDefaultClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT (self), 0);
+ klass = VIK_MAP_SOURCE_DEFAULT_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_uri != NULL, 0);
+
+ return (*klass->get_uri)(self, src);
+}
+
+gchar *
+vik_map_source_default_get_hostname( VikMapSourceDefault *self )
+{
+ VikMapSourceDefaultClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT (self), 0);
+ klass = VIK_MAP_SOURCE_DEFAULT_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_hostname != NULL, 0);
+
+ return (*klass->get_hostname)(self);
+}
+
+DownloadMapOptions *
+vik_map_source_default_get_download_options( VikMapSourceDefault *self )
+{
+ VikMapSourceDefaultClass *klass;
+ g_return_val_if_fail (self != NULL, 0);
+ g_return_val_if_fail (VIK_IS_MAP_SOURCE_DEFAULT (self), 0);
+ klass = VIK_MAP_SOURCE_DEFAULT_GET_CLASS(self);
+
+ g_return_val_if_fail (klass->get_download_options != NULL, 0);
+
+ return (*klass->get_download_options)(self);
+}
projects / andy / viking.git / blobdiff