X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/57c1c96a383c89b4ea73ec1084a076e48a39433a..9e90c3a511d4ea403d07522fb41d9f44328ecaa0:/src/mapcache.c

diff --git a/src/mapcache.c b/src/mapcache.c
index 5417ae1a..55b6f1b7 100644
--- a/src/mapcache.c
+++ b/src/mapcache.c
@@ -28,6 +28,9 @@
 #include "globals.h"
 #include "mapcache.h"
 #include "preferences.h"
+#include "vik_compat.h"
+
+#define MC_KEY_SIZE 64
 
 typedef struct _List {
   struct _List *next;
@@ -44,10 +47,16 @@ static guint32 max_cache_size = VIK_CONFIG_MAPCACHE_SIZE * 1024 * 1024;
 
 static GHashTable *cache = NULL;
 
+typedef struct {
+  GdkPixbuf *pixbuf;
+  mapcache_extra_t extra;
+} cache_item_t;
+
 static GMutex *mc_mutex = NULL;
 
 #define HASHKEY_FORMAT_STRING "%d-%d-%d-%d-%d-%d-%d-%.3f-%.3f"
 #define HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA "%d-%d-%d-%d-%d-%d-"
+#define HASHKEY_FORMAT_STRING_TYPE "%d-"
 
 static VikLayerParamScale params_scales[] = {
   /* min, max, step, digits (decimal places) */
@@ -58,29 +67,47 @@ static VikLayerParam prefs[] = {
   { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "mapcache_size", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Map cache memory size (MB):"), VIK_LAYER_WIDGET_HSCALE, params_scales, NULL, NULL, NULL, NULL, NULL },
 };
 
+static void cache_item_free (cache_item_t *ci)
+{
+  g_object_unref ( ci->pixbuf );
+  g_free ( ci );
+}
+
 void a_mapcache_init ()
 {
   VikLayerParamData tmp;
   tmp.u = VIK_CONFIG_MAPCACHE_SIZE;
   a_preferences_register(prefs, tmp, VIKING_PREFERENCES_GROUP_KEY);
 
-  mc_mutex = g_mutex_new();
-  cache = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, g_object_unref );
+  mc_mutex = vik_mutex_new ();
+  cache = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, (GDestroyNotify) cache_item_free );
 }
 
-static void cache_add(gchar *key, GdkPixbuf *pixbuf)
+static void cache_add(gchar *key, GdkPixbuf *pixbuf, mapcache_extra_t extra)
 {
-  if ( g_hash_table_insert ( cache, key, pixbuf ) ) {
+  cache_item_t *ci = g_malloc ( sizeof(cache_item_t) );
+  ci->pixbuf = pixbuf;
+  ci->extra = extra;
+#if !GLIB_CHECK_VERSION(2,26,0)
+  // Only later versions of GLib actually return a value for this function
+  // Annoyingly the documentation doesn't say anything about this interface change :(
+  if ( g_hash_table_insert ( cache, key, ci ) )
+#else
+  g_hash_table_insert ( cache, key, ci );
+#endif
+  {
     cache_size += gdk_pixbuf_get_rowstride(pixbuf) * gdk_pixbuf_get_height(pixbuf);
+    // ATM size of 'extra' data hardly worth trying to count (compared to pixbuf sizes)
+    // Not sure what this 100 represents anyway - probably a guess at an average pixbuf metadata size
     cache_size += 100;
   }
 }
 
 static void cache_remove(const gchar *key)
 {
-  GdkPixbuf *buf = g_hash_table_lookup ( cache, key );
-  if (buf) {
-    cache_size -= gdk_pixbuf_get_rowstride(buf) * gdk_pixbuf_get_height(buf);
+  cache_item_t *ci = g_hash_table_lookup ( cache, key );
+  if (ci && ci->pixbuf) {
+    cache_size -= gdk_pixbuf_get_rowstride(ci->pixbuf) * gdk_pixbuf_get_height(ci->pixbuf);
     cache_size -= 100;
     g_hash_table_remove ( cache, key );
   }
@@ -121,13 +148,13 @@ static void list_add_entry ( gchar *key )
   queue_count++;
 }
 
-void a_mapcache_add ( GdkPixbuf *pixbuf, gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
+void a_mapcache_add ( GdkPixbuf *pixbuf, mapcache_extra_t extra, gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
 {
   guint nn = name ? g_str_hash ( name ) : 0;
-  gchar *key = g_strdup_printf ( HASHKEY_FORMAT_STRING, x, y, z, type, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
+  gchar *key = g_strdup_printf ( HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
 
   g_mutex_lock(mc_mutex);
-  cache_add(key, pixbuf);
+  cache_add(key, pixbuf, extra);
 
   // TODO: that should be done on preference change only...
   max_cache_size = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "mapcache_size")->u * 1024 * 1024;
@@ -156,33 +183,45 @@ void a_mapcache_add ( GdkPixbuf *pixbuf, gint x, gint y, gint z, guint16 type, g
 
 GdkPixbuf *a_mapcache_get ( gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
 {
-  static char key[64];
+  static char key[MC_KEY_SIZE];
+  guint nn = name ? g_str_hash ( name ) : 0;
+  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
+  cache_item_t *ci = g_hash_table_lookup ( cache, key );
+  if ( ci )
+    return ci->pixbuf;
+  else
+    return NULL;
+}
+
+mapcache_extra_t a_mapcache_get_extra ( gint x, gint y, gint z, guint16 type, gint zoom, guint8 alpha, gdouble xshrinkfactor, gdouble yshrinkfactor, const gchar* name )
+{
+  static char key[MC_KEY_SIZE];
   guint nn = name ? g_str_hash ( name ) : 0;
-  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, x, y, z, type, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
-  return g_hash_table_lookup ( cache, key );
+  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING, type, x, y, z, zoom, nn, alpha, xshrinkfactor, yshrinkfactor );
+  cache_item_t *ci = g_hash_table_lookup ( cache, key );
+  if ( ci )
+    return ci->extra;
+  else
+    return (mapcache_extra_t) { 0.0 };
 }
 
 /**
- * Appears this is only used when redownloading tiles (i.e. to invalidate old images)
+ * Common function to remove cache items for keys starting with the specified string
  */
-void a_mapcache_remove_all_shrinkfactors ( gint x, gint y, gint z, guint16 type, gint zoom )
+static void flush_matching ( gchar *str )
 {
-  char key[64];
-  List *loop = queue_tail;
-  List *tmp;
-  gint len;
-
   if ( queue_tail == NULL )
     return;
 
-  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA, x, y, z, type, zoom, 0 );
-  len = strlen(key);
+  List *loop = queue_tail;
+  List *tmp;
+  gint len = strlen(str);
 
   g_mutex_lock(mc_mutex);
-  /* TODO: check logic here */
   do {
     tmp = loop->next;
-    if ( strncmp(tmp->key, key, len) == 0 )
+    if ( tmp ) {
+    if ( strncmp(tmp->key, str, len) == 0 )
     {
       cache_remove(tmp->key);
       if ( tmp == loop ) /* we deleted the last thing in the queue! */
@@ -198,14 +237,26 @@ void a_mapcache_remove_all_shrinkfactors ( gint x, gint y, gint z, guint16 type,
     }
     else
       loop = tmp;
-
+    } else
+      loop = NULL;
   } while ( loop && (loop != queue_tail || tmp == NULL) );
-
   /* loop thru list, looking for the one, compare first whatever chars */
-  cache_remove(key);
+
+  cache_remove(str);
   g_mutex_unlock(mc_mutex);
 }
 
+/**
+ * Appears this is only used when redownloading tiles (i.e. to invalidate old images)
+ */
+void a_mapcache_remove_all_shrinkfactors ( gint x, gint y, gint z, guint16 type, gint zoom, const gchar* name )
+{
+  char key[MC_KEY_SIZE];
+  guint nn = name ? g_str_hash ( name ) : 0;
+  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_NOSHRINK_NOR_ALPHA, type, x, y, z, zoom, nn );
+  flush_matching ( key );
+}
+
 void a_mapcache_flush ()
 {
   List *loop = queue_tail;
@@ -229,11 +280,26 @@ void a_mapcache_flush ()
   g_mutex_unlock(mc_mutex);
 }
 
+/**
+ * a_mapcache_flush_type:
+ *  @type: Specified map type
+ *
+ * Just remove cache items for the specified map type
+ *  i.e. all related xyz+zoom+alpha+etc...
+ */
+void a_mapcache_flush_type ( guint16 type )
+{
+  char key[MC_KEY_SIZE];
+  g_snprintf ( key, sizeof(key), HASHKEY_FORMAT_STRING_TYPE, type );
+  flush_matching ( key );
+}
+
 void a_mapcache_uninit ()
 {
   g_hash_table_destroy ( cache );
   /* free list */
   cache = NULL;
+  vik_mutex_free (mc_mutex);
 }
 
 // Size of mapcache in memory