1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
4 * Copyright (C) 2009-2010, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
6 * viking is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * viking is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 * See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
21 * SECTION:vikmapsource
22 * @short_description: the base class to describe map source
24 * The #VikMapSource class is both the interface and the base class
25 * for the hierarchie of map source.
31 #include "vikviewport.h"
35 #include "vikmapsource.h"
37 static void vik_map_source_init (VikMapSource *object);
38 static void vik_map_source_finalize (GObject *object);
39 static void vik_map_source_class_init (VikMapSourceClass *klass);
41 static gboolean _supports_download_only_new (VikMapSource *object);
43 G_DEFINE_ABSTRACT_TYPE (VikMapSource, vik_map_source, G_TYPE_OBJECT);
46 vik_map_source_init (VikMapSource *object)
48 /* TODO: Add initialization code here */
52 vik_map_source_finalize (GObject *object)
54 /* TODO: Add deinitalization code here */
56 G_OBJECT_CLASS (vik_map_source_parent_class)->finalize (object);
60 vik_map_source_class_init (VikMapSourceClass *klass)
62 GObjectClass* object_class = G_OBJECT_CLASS (klass);
64 klass->get_copyright = NULL;
65 klass->get_license = NULL;
66 klass->get_license_url = NULL;
67 klass->get_logo = NULL;
68 klass->get_name = NULL;
69 klass->get_uniq_id = NULL;
70 klass->get_label = NULL;
71 klass->get_tilesize_x = NULL;
72 klass->get_tilesize_y = NULL;
73 klass->get_drawmode = NULL;
74 klass->is_direct_file_access = NULL;
75 klass->is_mbtiles = NULL;
76 klass->supports_download_only_new = _supports_download_only_new;
77 klass->get_zoom_min = NULL;
78 klass->get_zoom_max = NULL;
79 klass->get_lat_min = NULL;
80 klass->get_lat_max = NULL;
81 klass->get_lon_min = NULL;
82 klass->get_lon_max = NULL;
83 klass->coord_to_mapcoord = NULL;
84 klass->mapcoord_to_center_coord = NULL;
85 klass->download = NULL;
86 klass->download_handle_init = NULL;
87 klass->download_handle_cleanup = NULL;
89 object_class->finalize = vik_map_source_finalize;
93 _supports_download_only_new (VikMapSource *self)
95 // Default feature: does not support
100 * vik_map_source_get_copyright:
101 * @self: the VikMapSource of interest.
102 * @bbox: bounding box of interest.
103 * @zoom: the zoom level of interest.
104 * @fct: the callback function to use to return matching copyrights.
105 * @data: the user data to use to call the callbaack function.
107 * Retrieve copyright(s) for the corresponding bounding box and zoom level.
110 vik_map_source_get_copyright (VikMapSource *self, LatLonBBox bbox, gdouble zoom, void (*fct)(VikViewport*,const gchar*), void *data)
112 VikMapSourceClass *klass;
113 g_return_if_fail (self != NULL);
114 g_return_if_fail (VIK_IS_MAP_SOURCE (self));
115 klass = VIK_MAP_SOURCE_GET_CLASS(self);
117 g_return_if_fail (klass->get_copyright != NULL);
119 (*klass->get_copyright)(self, bbox, zoom, fct, data);
123 vik_map_source_get_license (VikMapSource *self)
125 VikMapSourceClass *klass;
126 g_return_val_if_fail (self != NULL, NULL);
127 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
128 klass = VIK_MAP_SOURCE_GET_CLASS(self);
130 g_return_val_if_fail (klass->get_license != NULL, NULL);
132 return (*klass->get_license)(self);
136 vik_map_source_get_license_url (VikMapSource *self)
138 VikMapSourceClass *klass;
139 g_return_val_if_fail (self != NULL, NULL);
140 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
141 klass = VIK_MAP_SOURCE_GET_CLASS(self);
143 g_return_val_if_fail (klass->get_license_url != NULL, NULL);
145 return (*klass->get_license_url)(self);
149 vik_map_source_get_logo (VikMapSource *self)
151 VikMapSourceClass *klass;
152 g_return_val_if_fail (self != NULL, NULL);
153 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
154 klass = VIK_MAP_SOURCE_GET_CLASS(self);
156 g_return_val_if_fail (klass->get_logo != NULL, NULL);
158 return (*klass->get_logo)(self);
162 vik_map_source_get_name (VikMapSource *self)
164 VikMapSourceClass *klass;
165 g_return_val_if_fail (self != NULL, NULL);
166 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
167 klass = VIK_MAP_SOURCE_GET_CLASS(self);
169 g_return_val_if_fail (klass->get_name != NULL, NULL);
171 return (*klass->get_name)(self);
175 vik_map_source_get_uniq_id (VikMapSource *self)
177 VikMapSourceClass *klass;
178 g_return_val_if_fail (self != NULL, (guint16 )0);
179 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), (guint16 )0);
180 klass = VIK_MAP_SOURCE_GET_CLASS(self);
182 g_return_val_if_fail (klass->get_uniq_id != NULL, (guint16 )0);
184 return (*klass->get_uniq_id)(self);
188 vik_map_source_get_label (VikMapSource *self)
190 VikMapSourceClass *klass;
191 g_return_val_if_fail (self != NULL, NULL);
192 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
193 klass = VIK_MAP_SOURCE_GET_CLASS(self);
195 g_return_val_if_fail (klass->get_label != NULL, NULL);
197 return (*klass->get_label)(self);
201 vik_map_source_get_tilesize_x (VikMapSource *self)
203 VikMapSourceClass *klass;
204 g_return_val_if_fail (self != NULL, (guint16 )0);
205 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), (guint16 )0);
206 klass = VIK_MAP_SOURCE_GET_CLASS(self);
208 g_return_val_if_fail (klass->get_tilesize_x != NULL, (guint16 )0);
210 return (*klass->get_tilesize_x)(self);
214 vik_map_source_get_tilesize_y (VikMapSource *self)
216 VikMapSourceClass *klass;
217 g_return_val_if_fail (self != NULL, (guint16 )0);
218 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), (guint16 )0);
219 klass = VIK_MAP_SOURCE_GET_CLASS(self);
221 g_return_val_if_fail (klass->get_tilesize_y != NULL, (guint16 )0);
223 return (*klass->get_tilesize_y)(self);
227 vik_map_source_get_drawmode (VikMapSource *self)
229 VikMapSourceClass *klass;
230 g_return_val_if_fail (self != NULL, (VikViewportDrawMode )0);
231 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), (VikViewportDrawMode )0);
232 klass = VIK_MAP_SOURCE_GET_CLASS(self);
234 g_return_val_if_fail (klass->get_drawmode != NULL, (VikViewportDrawMode )0);
236 return (*klass->get_drawmode)(self);
240 * vik_map_source_is_direct_file_access:
241 * @self: the VikMapSource of interest.
243 * Return true when we can bypass all this download malarky
244 * Treat the files as a pre generated data set in OSM tile server layout: tiledir/%d/%d/%d.png
247 vik_map_source_is_direct_file_access (VikMapSource * self)
249 VikMapSourceClass *klass;
250 g_return_val_if_fail (self != NULL, 0);
251 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
252 klass = VIK_MAP_SOURCE_GET_CLASS(self);
254 g_return_val_if_fail (klass->is_direct_file_access != NULL, 0);
256 return (*klass->is_direct_file_access)(self);
260 * vik_map_source_is_mbtiles:
261 * @self: the VikMapSource of interest.
263 * Return true when the map is in an MB Tiles format.
264 * See http://github.com/mapbox/mbtiles-spec
268 vik_map_source_is_mbtiles (VikMapSource * self)
270 VikMapSourceClass *klass;
271 g_return_val_if_fail (self != NULL, 0);
272 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
273 klass = VIK_MAP_SOURCE_GET_CLASS(self);
275 g_return_val_if_fail (klass->is_mbtiles != NULL, 0);
277 return (*klass->is_mbtiles)(self);
281 * vik_map_source_is_osm_meta_tiles:
282 * @self: the VikMapSource of interest.
284 * Treat the files as a pre generated data set directly by tirex or renderd
285 * tiledir/Z/[xxxxyyyy]/[xxxxyyyy]/[xxxxyyyy]/[xxxxyyyy]/[xxxxyyyy].meta
287 gboolean vik_map_source_is_osm_meta_tiles (VikMapSource * self)
289 VikMapSourceClass *klass;
290 g_return_val_if_fail (self != NULL, 0);
291 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
292 klass = VIK_MAP_SOURCE_GET_CLASS(self);
294 g_return_val_if_fail (klass->is_osm_meta_tiles != NULL, 0);
296 return (*klass->is_osm_meta_tiles)(self);
300 vik_map_source_supports_download_only_new (VikMapSource * self)
302 VikMapSourceClass *klass;
303 g_return_val_if_fail (self != NULL, 0);
304 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
305 klass = VIK_MAP_SOURCE_GET_CLASS(self);
307 g_return_val_if_fail (klass->supports_download_only_new != NULL, 0);
309 return (*klass->supports_download_only_new)(self);
316 vik_map_source_get_zoom_min (VikMapSource * self)
318 VikMapSourceClass *klass;
319 g_return_val_if_fail (self != NULL, 0);
320 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
321 klass = VIK_MAP_SOURCE_GET_CLASS(self);
322 g_return_val_if_fail (klass->get_zoom_min != NULL, 0);
323 return (*klass->get_zoom_min)(self);
330 vik_map_source_get_zoom_max (VikMapSource * self)
332 VikMapSourceClass *klass;
333 g_return_val_if_fail (self != NULL, 18);
334 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 18);
335 klass = VIK_MAP_SOURCE_GET_CLASS(self);
336 g_return_val_if_fail (klass->get_zoom_max != NULL, 18);
337 return (*klass->get_zoom_max)(self);
344 vik_map_source_get_lat_max (VikMapSource * self)
346 VikMapSourceClass *klass;
347 g_return_val_if_fail (self != NULL, 90.0);
348 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 90.0);
349 klass = VIK_MAP_SOURCE_GET_CLASS(self);
350 g_return_val_if_fail (klass->get_lat_max != NULL, 90.0);
351 return (*klass->get_lat_max)(self);
358 vik_map_source_get_lat_min (VikMapSource * self)
360 VikMapSourceClass *klass;
361 g_return_val_if_fail (self != NULL, -90.0);
362 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), -90.0);
363 klass = VIK_MAP_SOURCE_GET_CLASS(self);
364 g_return_val_if_fail (klass->get_lat_min != NULL, -90.0);
365 return (*klass->get_lat_min)(self);
372 vik_map_source_get_lon_max (VikMapSource * self)
374 VikMapSourceClass *klass;
375 g_return_val_if_fail (self != NULL, 180.0);
376 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 180.0);
377 klass = VIK_MAP_SOURCE_GET_CLASS(self);
378 g_return_val_if_fail (klass->get_lon_max != NULL, 180.0);
379 return (*klass->get_lon_max)(self);
386 vik_map_source_get_lon_min (VikMapSource * self)
388 VikMapSourceClass *klass;
389 g_return_val_if_fail (self != NULL, -180.0);
390 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), -180.0);
391 klass = VIK_MAP_SOURCE_GET_CLASS(self);
392 g_return_val_if_fail (klass->get_lon_min != NULL, -180.0);
393 return (*klass->get_lon_min)(self);
397 * vik_map_source_get_file_extension:
398 * @self: the VikMapSource of interest.
400 * Returns the file extension of files held on disk.
401 * Typically .png but may be .jpg or whatever the user defines
405 vik_map_source_get_file_extension (VikMapSource * self)
407 VikMapSourceClass *klass;
408 g_return_val_if_fail (self != NULL, NULL);
409 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), NULL);
410 klass = VIK_MAP_SOURCE_GET_CLASS(self);
412 g_return_val_if_fail (klass->get_file_extension != NULL, NULL);
414 return (*klass->get_file_extension)(self);
418 vik_map_source_coord_to_mapcoord (VikMapSource *self, const VikCoord *src, gdouble xzoom, gdouble yzoom, MapCoord *dest )
420 VikMapSourceClass *klass;
421 g_return_val_if_fail (self != NULL, FALSE);
422 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), FALSE);
423 klass = VIK_MAP_SOURCE_GET_CLASS(self);
425 g_return_val_if_fail (klass->coord_to_mapcoord != NULL, FALSE);
427 return (*klass->coord_to_mapcoord)(self, src, xzoom, yzoom, dest);
431 vik_map_source_mapcoord_to_center_coord (VikMapSource *self, MapCoord *src, VikCoord *dest)
433 VikMapSourceClass *klass;
434 g_return_if_fail (self != NULL);
435 g_return_if_fail (VIK_IS_MAP_SOURCE (self));
436 klass = VIK_MAP_SOURCE_GET_CLASS(self);
438 g_return_if_fail (klass->mapcoord_to_center_coord != NULL);
440 (*klass->mapcoord_to_center_coord)(self, src, dest);
444 * vik_map_source_download:
445 * @self: The VikMapSource of interest.
446 * @src: The map location to download
447 * @dest_fn: The filename to save the result in
448 * @handle: Potential reusable Curl Handle (may be NULL)
450 * Returns: How successful the download was as per the type #DownloadResult_t
453 vik_map_source_download (VikMapSource * self, MapCoord * src, const gchar * dest_fn, void *handle)
455 VikMapSourceClass *klass;
456 g_return_val_if_fail (self != NULL, 0);
457 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
458 klass = VIK_MAP_SOURCE_GET_CLASS(self);
460 g_return_val_if_fail (klass->download != NULL, 0);
462 return (*klass->download)(self, src, dest_fn, handle);
466 vik_map_source_download_handle_init (VikMapSource *self)
468 VikMapSourceClass *klass;
469 g_return_val_if_fail (self != NULL, 0);
470 g_return_val_if_fail (VIK_IS_MAP_SOURCE (self), 0);
471 klass = VIK_MAP_SOURCE_GET_CLASS(self);
473 g_return_val_if_fail (klass->download_handle_init != NULL, 0);
475 return (*klass->download_handle_init)(self);
479 vik_map_source_download_handle_cleanup (VikMapSource * self, void * handle)
481 VikMapSourceClass *klass;
482 g_return_if_fail (self != NULL);
483 g_return_if_fail (VIK_IS_MAP_SOURCE (self));
484 klass = VIK_MAP_SOURCE_GET_CLASS(self);
486 g_return_if_fail (klass->download_handle_cleanup != NULL);
488 (*klass->download_handle_cleanup)(self, handle);