src/common/stringtable.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2001 Hiroyuki Yamamoto
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include <glib.h>
  21 #include <string.h>
  22
  23 #include "stringtable.h"
  24 #include "utils.h"
  25
  26 /* alfons - hashed string table (I wasn't content with GStringChunk;
  27  * can't recall why :-) */
  28
  29 #if 0
  30 #define XXX_DEBUG \
  31         debug_print
  32 #else
  33 #define XXX_DEBUG \
  34         if (0) debug_print
  35 #endif
  36
  37 typedef struct StringEntry_ {
  38         gint    ref_count;
  39         gchar  *string;
  40 } StringEntry;
  41
  42 static StringEntry *string_entry_new(const gchar *str)
  43 {
  44         StringEntry *entry;
  45
  46         entry = g_new0(StringEntry, 1);
  47         entry->ref_count = 1;
  48         entry->string = g_strdup(str);
  49         return entry;
  50 }
  51
  52 static void string_entry_free(StringEntry *entry)
  53 {
  54         g_return_if_fail(entry != NULL);
  55
  56         g_free(entry->string);
  57         g_free(entry);
  58 }
  59
  60 StringTable *string_table_new(void)
  61 {
  62         StringTable *strtable;
  63
  64         strtable = g_new0(StringTable, 1);
  65         g_return_val_if_fail(strtable != NULL, NULL);
  66         strtable->hash_table = g_hash_table_new(g_str_hash, g_str_equal);
  67         g_return_val_if_fail(strtable->hash_table, NULL);
  68         return strtable;
  69 }
  70
  71 gchar *string_table_lookup_string(StringTable *table, gchar *str)
  72 {
  73         StringEntry *entry = g_hash_table_lookup(table->hash_table,
  74                                                  (gconstpointer)str);
  75         if (!entry) {
  76                 return NULL;
  77         } else {
  78                 return entry->string;
  79         }
  80 }
  81
  82 gchar *string_table_insert_string(StringTable *table, gchar *str)
  83 {
  84         gchar *key = NULL;
  85         StringEntry *entry = NULL;
  86
  87         if (g_hash_table_lookup_extended
  88                 (table->hash_table, str, (gpointer *)&key, (gpointer *)&entry)) {
  89                 entry->ref_count++;
  90                 XXX_DEBUG ("ref++ for %s (%d)\n", entry->string, entry->ref_count);
  91         } else {
  92                 entry = string_entry_new(str);
  93                 XXX_DEBUG ("inserting %s\n", str);
  94                 /* insert entry->string instead of str, since it can be
  95                  * invalid pointer after this. */
  96                 g_hash_table_insert(table->hash_table, entry->string, entry);
  97         }
  98
  99         return entry->string;
 100 }
 101
 102 void string_table_free_string(StringTable *table, gchar *str)
 103 {
 104         StringEntry *entry;
 105
 106         entry = g_hash_table_lookup(table->hash_table, str);
 107
 108         if (entry) {
 109                 entry->ref_count--;
 110                 if (entry->ref_count <= 0) {
 111                         XXX_DEBUG ("refcount of string %s dropped to zero\n", entry->string);
 112                         g_hash_table_remove(table->hash_table, str);
 113                         string_entry_free(entry);
 114                 } else {
 115                         XXX_DEBUG ("ref-- for %s (%d)\n", entry->string, entry->ref_count);
 116                 }
 117         }
 118 }
 119
 120 static gboolean string_table_remove_for_each_fn(gchar *key, StringEntry *entry,
 121                                                 gpointer user_data)
 122 {
 123         g_return_val_if_fail(key != NULL, TRUE);
 124         g_return_val_if_fail(entry != NULL, TRUE);
 125
 126         string_entry_free(entry);
 127
 128         return TRUE;
 129 }
 130
 131 void string_table_free(StringTable *table)
 132 {
 133         g_return_if_fail(table != NULL);
 134         g_return_if_fail(table->hash_table != NULL);
 135
 136         g_hash_table_foreach_remove(table->hash_table,
 137                                     (GHRFunc)string_table_remove_for_each_fn,
 138                                     NULL);
 139         g_hash_table_destroy(table->hash_table);
 140         g_free(table);
 141 }
 142
 143 static void string_table_stats_for_each_fn(gchar *key, StringEntry *entry,
 144                                            guint *totals)
 145 {
 146         if (entry->ref_count > 1) {
 147                 *totals += strlen(key) * (entry->ref_count - 1);
 148         }
 149 }
 150
 151 void string_table_get_stats(StringTable *table)
 152 {
 153         guint totals = 0;
 154
 155         g_hash_table_foreach(table->hash_table,
 156                              (GHFunc)string_table_stats_for_each_fn, &totals);
 157         XXX_DEBUG ("TOTAL UNSPILLED %d (%dK)\n", totals, totals / 1024);
 158 }