gtktexttagtable.c 9.34 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

#include "gtktexttagtable.h"
#include "gtksignal.h"

#include <stdlib.h>

enum {
  TAG_CHANGED,
  TAG_ADDED,
  TAG_REMOVED,
  LAST_SIGNAL
};

enum {
  LAST_ARG
};

18 19 20 21 22 23
static void gtk_text_tag_table_init         (GtkTextTagTable      *table);
static void gtk_text_tag_table_class_init   (GtkTextTagTableClass *klass);
static void gtk_text_tag_table_finalize     (GObject              *object);
static void gtk_text_tag_table_set_property (GObject              *object,
                                             guint                 prop_id,
                                             const GValue         *value,
Tim Janik's avatar
Tim Janik committed
24
                                             GParamSpec           *pspec);
25 26 27
static void gtk_text_tag_table_get_property (GObject              *object,
                                             guint                 prop_id,
                                             GValue               *value,
Tim Janik's avatar
Tim Janik committed
28
                                             GParamSpec           *pspec);
29 30

static GObjectClass *parent_class = NULL;
31 32
static guint signals[LAST_SIGNAL] = { 0 };

33
GType
34 35
gtk_text_tag_table_get_type (void)
{
36
  static GType our_type = 0;
37 38 39

  if (our_type == 0)
    {
40
      static const GTypeInfo our_info =
41 42
      {
        sizeof (GtkTextTagTableClass),
43 44 45 46 47 48 49 50
        (GBaseInitFunc) NULL,
        (GBaseFinalizeFunc) NULL,
        (GClassInitFunc) gtk_text_tag_table_class_init,
        NULL,           /* class_finalize */
        NULL,           /* class_data */
        sizeof (GtkTextTagTable),
        0,              /* n_preallocs */
        (GInstanceInitFunc) gtk_text_tag_table_init
51 52
      };

53 54 55 56
      our_type = g_type_register_static (G_TYPE_OBJECT,
                                         "GtkTextTagTable",
                                         &our_info,
                                         0);
57
    }
58 59 60 61 62 63 64

  return our_type;
}

static void
gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
{
65
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
66

67
  parent_class = g_type_class_peek_parent (klass);
68

69 70 71 72 73
  object_class->set_property = gtk_text_tag_table_set_property;
  object_class->get_property = gtk_text_tag_table_get_property;
  
  object_class->finalize = gtk_text_tag_table_finalize;
  
74
  signals[TAG_CHANGED] =
75 76 77 78 79 80 81 82 83 84
    g_signal_new ("tag_changed",
                  G_OBJECT_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkTextTagTableClass, tag_changed),
                  NULL, NULL,
                  gtk_marshal_VOID__OBJECT_BOOLEAN,
                  G_TYPE_NONE,
                  2,
                  G_TYPE_OBJECT,
                  G_TYPE_BOOLEAN);  
85 86

  signals[TAG_ADDED] =
87 88 89 90 91 92 93 94 95
    g_signal_new ("tag_added",
                  GTK_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkTextTagTableClass, tag_added),
                  NULL, NULL,
                  gtk_marshal_VOID__OBJECT,
                  GTK_TYPE_NONE,
                  1,
                  G_TYPE_OBJECT);
96 97

  signals[TAG_REMOVED] =
98 99 100 101 102 103 104 105 106
    g_signal_new ("tag_removed",                   
                  GTK_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkTextTagTableClass, tag_removed),
                  NULL, NULL,
                  gtk_marshal_VOID__OBJECT,
                  GTK_TYPE_NONE,
                  1,
                  G_TYPE_OBJECT);
107 108 109 110 111
}

void
gtk_text_tag_table_init (GtkTextTagTable *table)
{
112
  table->hash = g_hash_table_new (g_str_hash, g_str_equal);
113 114
}

115 116
/**
 * gtk_text_tag_table_new:
117
 * 
118 119 120 121 122
 * Creates a new #GtkTextTagTable. The table contains no tags by
 * default.
 * 
 * Return value: a new #GtkTextTagTable
 **/
123 124 125 126 127
GtkTextTagTable*
gtk_text_tag_table_new (void)
{
  GtkTextTagTable *table;

128
  table = GTK_TEXT_TAG_TABLE (g_object_new (gtk_text_tag_table_get_type (), NULL));
129

130 131 132
  return table;
}

133 134 135
static void
foreach_unref (GtkTextTag *tag, gpointer data)
{
136 137 138
  /* We don't want to emit the remove signal here; so we just unparent
   * and unref the tag.
   */
139

140
  tag->table = NULL;
141 142 143
  g_object_unref (G_OBJECT (tag));
}

144 145 146 147 148
static void
gtk_text_tag_table_finalize (GObject *object)
{
  GtkTextTagTable *table;

149
  table = GTK_TEXT_TAG_TABLE (object);
150

151
  gtk_text_tag_table_foreach (table, foreach_unref, NULL);
Havoc Pennington's avatar
Havoc Pennington committed
152
  
153
  g_hash_table_destroy (table->hash);
154 155
  g_slist_free (table->anonymous);

156
  (* G_OBJECT_CLASS (parent_class)->finalize) (object);
157 158
}
static void
159 160 161
gtk_text_tag_table_set_property (GObject      *object,
                                 guint         prop_id,
                                 const GValue *value,
Tim Janik's avatar
Tim Janik committed
162
                                 GParamSpec   *pspec)
163 164 165
{
  GtkTextTagTable *table;

166 167
  table = GTK_TEXT_TAG_TABLE (object);

168
  switch (prop_id)
169
    {
170

171
    default:
172
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
173 174 175 176
      break;
    }
}

177

178
static void
179 180 181
gtk_text_tag_table_get_property (GObject      *object,
                                 guint         prop_id,
                                 GValue       *value,
Tim Janik's avatar
Tim Janik committed
182
                                 GParamSpec   *pspec)
183 184 185
{
  GtkTextTagTable *table;

186
  table = GTK_TEXT_TAG_TABLE (object);
187

188
  switch (prop_id)
189 190 191
    {

    default:
192
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
193 194 195 196
      break;
    }
}

197 198 199 200 201 202 203
/**
 * gtk_text_tag_table_add:
 * @table: a #GtkTextTagTable
 * @tag: a #GtkTextTag
 *
 * Add a tag to the table. The tag is assigned the highest priority
 * in the table.
Havoc Pennington's avatar
Havoc Pennington committed
204 205 206
 *
 * @tag must not be in a tag table already, and may not have
 * the same name as an already-added tag.
207
 **/
208
void
209 210
gtk_text_tag_table_add (GtkTextTagTable *table,
                        GtkTextTag      *tag)
211 212
{
  guint size;
213

214 215 216 217
  g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
  g_return_if_fail (GTK_IS_TEXT_TAG (tag));
  g_return_if_fail (tag->table == NULL);

Havoc Pennington's avatar
Havoc Pennington committed
218 219 220 221 222 223 224
  if (tag->name && g_hash_table_lookup (table->hash, tag->name))
    {
      g_warning ("A tag named '%s' is already in the tag table.",
                 tag->name);
      return;
    }
  
225
  g_object_ref (G_OBJECT (tag));
226 227

  if (tag->name)
228
    g_hash_table_insert (table->hash, tag->name, tag);
229 230 231 232 233
  else
    {
      table->anonymous = g_slist_prepend (table->anonymous, tag);
      table->anon_count += 1;
    }
234

235 236 237 238 239
  tag->table = table;

  /* We get the highest tag priority, as the most-recently-added
     tag. Note that we do NOT use gtk_text_tag_set_priority,
     as it assumes the tag is already in the table. */
240
  size = gtk_text_tag_table_get_size (table);
241
  g_assert (size > 0);
242
  tag->priority = size - 1;
243

244
  g_signal_emit (G_OBJECT (table), signals[TAG_ADDED], 0, tag);
245 246
}

247 248 249 250 251 252 253 254 255
/**
 * gtk_text_tag_table_lookup:
 * @table: a #GtkTextTagTable 
 * @name: name of a tag
 * 
 * Look up a named tag.
 * 
 * Return value: The tag, or %NULL if none by that name is in the table.
 **/
256
GtkTextTag*
257 258
gtk_text_tag_table_lookup (GtkTextTagTable *table,
                           const gchar     *name)
259
{
260 261 262 263
  g_return_val_if_fail (GTK_IS_TEXT_TAG_TABLE (table), NULL);
  g_return_val_if_fail (name != NULL, NULL);

  return g_hash_table_lookup (table->hash, name);
264 265
}

266 267 268 269 270 271 272 273 274
/**
 * gtk_text_tag_table_remove:
 * @table: a #GtkTextTagTable
 * @tag: a #GtkTextTag
 * 
 * Remove a tag from the table. This will remove the table's
 * reference to the tag, so be careful - the tag will end
 * up destroyed if you don't have a reference to it.
 **/
275
void
276 277
gtk_text_tag_table_remove (GtkTextTagTable *table,
                           GtkTextTag      *tag)
278
{
279
  g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
280
  g_return_if_fail (GTK_IS_TEXT_TAG (tag));
281
  g_return_if_fail (tag->table == table);
282 283 284 285

  /* Set ourselves to the highest priority; this means
     when we're removed, there won't be any gaps in the
     priorities of the tags in the table. */
286
  gtk_text_tag_set_priority (tag, gtk_text_tag_table_get_size (table) - 1);
287

288 289
  tag->table = NULL;

290
  if (tag->name)
291
    g_hash_table_remove (table->hash, tag->name);
292 293 294 295 296
  else
    {
      table->anonymous = g_slist_remove (table->anonymous, tag);
      table->anon_count -= 1;
    }
297

298
  g_signal_emit (G_OBJECT (table), signals[TAG_REMOVED], 0, tag);
299

300
  g_object_unref (G_OBJECT (tag));
301 302
}

303 304 305 306 307 308 309 310 311 312 313
struct ForeachData
{
  GtkTextTagTableForeach func;
  gpointer data;
};

static void
hash_foreach (gpointer key, gpointer value, gpointer data)
{
  struct ForeachData *fd = data;

314
  g_return_if_fail (GTK_IS_TEXT_TAG (value));
315

316 317 318
  (* fd->func) (value, fd->data);
}

319 320 321 322 323 324
static void
list_foreach (gpointer data, gpointer user_data)
{
  struct ForeachData *fd = user_data;

  g_return_if_fail (GTK_IS_TEXT_TAG (data));
325

326 327 328
  (* fd->func) (data, fd->data);
}

329 330 331 332 333 334 335 336 337
/**
 * gtk_text_tag_table_foreach:
 * @table: a #GtkTextTagTable
 * @func: a function to call on each tag
 * @data: user data
 *
 * Calls @func on each tag in @table, with user data @data.
 * 
 **/
338
void
339 340 341
gtk_text_tag_table_foreach (GtkTextTagTable       *table,
                            GtkTextTagTableForeach func,
                            gpointer               data)
342
{
343
  struct ForeachData d;
344 345 346

  g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
  g_return_if_fail (func != NULL);
347

348 349
  d.func = func;
  d.data = data;
350 351

  g_hash_table_foreach (table->hash, hash_foreach, &d);
352
  g_slist_foreach (table->anonymous, list_foreach, &d);
353 354
}

355
/**
356
 * gtk_text_tag_table_get_size:
357 358 359 360 361 362 363
 * @table: a #GtkTextTagTable
 * 
 * Returns the size of the table (number of tags)
 * 
 * Return value: number of tags in @table
 **/
gint
364
gtk_text_tag_table_get_size (GtkTextTagTable *table)
365
{
366
  g_return_val_if_fail (GTK_IS_TEXT_TAG_TABLE (table), 0);
367

368
  return g_hash_table_size (table->hash) + table->anon_count;
369
}