+/* GTK - The GIMP Toolkit
+ * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
+ * file for a list of people on the GTK+ Team. See the ChangeLog
+ * files for a list of changes. These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+#include "config.h"
#include "gtktexttagtable.h"
-#include "gtksignal.h"
+
+#include "gtkbuildable.h"
+#include "gtktexttagprivate.h"
+#include "gtkmarshalers.h"
+#include "gtktextbuffer.h" /* just for the lame notify_will_remove_tag hack */
+#include "gtkintl.h"
#include <stdlib.h>
+
+/**
+ * SECTION:gtktexttagtable
+ * @Short_description: Collection of tags that can be used together
+ * @Title: GtkTextTagTable
+ *
+ * You may wish to begin by reading the <link linkend="TextWidget">text widget
+ * conceptual overview</link> which gives an overview of all the objects and
+ * data types related to the text widget and how they work together.
+ *
+ * <refsect2 id="GtkTextTagTable-BUILDER-UI">
+ * <title>GtkTextTagTables as GtkBuildable</title>
+ * <para>
+ * The GtkTextTagTable implementation of the GtkBuildable interface
+ * supports adding tags by specifying "tag" as the "type"
+ * attribute of a <child> element.
+ *
+ * <example>
+ * <title>A UI definition fragment specifying tags</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkTextTagTable">
+ * <child type="tag">
+ * <object class="GtkTextTag"/>
+ * </child>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </para>
+ * </refsect2>
+ */
+
+struct _GtkTextTagTablePrivate
+{
+ GHashTable *hash;
+ GSList *anonymous;
+ GSList *buffers;
+
+ gint anon_count;
+};
+
+
enum {
TAG_CHANGED,
TAG_ADDED,
LAST_ARG
};
-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_destroy (GtkObject *object);
-static void gtk_text_tag_table_finalize (GObject *object);
-static void gtk_text_tag_table_set_arg (GtkObject *object, GtkArg *arg, guint arg_id);
-static void gtk_text_tag_table_get_arg (GtkObject *object, GtkArg *arg, guint arg_id);
+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,
+ GParamSpec *pspec);
+static void gtk_text_tag_table_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
+
+static void gtk_text_tag_table_buildable_interface_init (GtkBuildableIface *iface);
+static void gtk_text_tag_table_buildable_add_child (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ GObject *child,
+ const gchar *type);
-static GtkObjectClass *parent_class = NULL;
static guint signals[LAST_SIGNAL] = { 0 };
-GtkType
-gtk_text_tag_table_get_type (void)
-{
- static GtkType our_type = 0;
-
- if (our_type == 0)
- {
- static const GtkTypeInfo our_info =
- {
- "GtkTextTagTable",
- sizeof (GtkTextTagTable),
- sizeof (GtkTextTagTableClass),
- (GtkClassInitFunc) gtk_text_tag_table_class_init,
- (GtkObjectInitFunc) gtk_text_tag_table_init,
- /* reserved_1 */ NULL,
- /* reserved_2 */ NULL,
- (GtkClassInitFunc) NULL
- };
-
- our_type = gtk_type_unique (GTK_TYPE_OBJECT, &our_info);
- }
-
- return our_type;
-}
+G_DEFINE_TYPE_WITH_CODE (GtkTextTagTable, gtk_text_tag_table, G_TYPE_OBJECT,
+ G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
+ gtk_text_tag_table_buildable_interface_init))
static void
gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
{
- GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
- GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
+ GObjectClass *object_class = G_OBJECT_CLASS (klass);
- parent_class = gtk_type_class (GTK_TYPE_OBJECT);
+ object_class->set_property = gtk_text_tag_table_set_property;
+ object_class->get_property = gtk_text_tag_table_get_property;
- signals[TAG_CHANGED] =
- gtk_signal_new ("tag_changed",
- GTK_RUN_LAST,
- GTK_CLASS_TYPE (object_class),
- GTK_SIGNAL_OFFSET (GtkTextTagTableClass, tag_changed),
- gtk_marshal_VOID__POINTER_INT,
- GTK_TYPE_NONE,
- 2,
- GTK_TYPE_OBJECT,
- GTK_TYPE_BOOL);
+ object_class->finalize = gtk_text_tag_table_finalize;
+ /**
+ * GtkTextTagTable::tag-changed:
+ * @texttagtable: the object which received the signal.
+ * @tag: the changed tag.
+ * @size_changed: whether the size has been changed.
+ */
+ signals[TAG_CHANGED] =
+ g_signal_new (I_("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,
+ GTK_TYPE_TEXT_TAG,
+ G_TYPE_BOOLEAN);
+
+ /**
+ * GtkTextTagTable::tag-added:
+ * @texttagtable: the object which received the signal.
+ * @tag: the added tag.
+ */
signals[TAG_ADDED] =
- gtk_signal_new ("tag_added",
- GTK_RUN_LAST,
- GTK_CLASS_TYPE (object_class),
- GTK_SIGNAL_OFFSET (GtkTextTagTableClass, tag_added),
- gtk_marshal_VOID__POINTER,
- GTK_TYPE_NONE,
- 1,
- GTK_TYPE_OBJECT);
-
+ g_signal_new (I_("tag-added"),
+ G_OBJECT_CLASS_TYPE (object_class),
+ G_SIGNAL_RUN_LAST,
+ G_STRUCT_OFFSET (GtkTextTagTableClass, tag_added),
+ NULL, NULL,
+ _gtk_marshal_VOID__OBJECT,
+ G_TYPE_NONE,
+ 1,
+ GTK_TYPE_TEXT_TAG);
+
+ /**
+ * GtkTextTagTable::tag-removed:
+ * @texttagtable: the object which received the signal.
+ * @tag: the removed tag.
+ */
signals[TAG_REMOVED] =
- gtk_signal_new ("tag_removed",
- GTK_RUN_LAST,
- GTK_CLASS_TYPE (object_class),
- GTK_SIGNAL_OFFSET (GtkTextTagTableClass, tag_removed),
- gtk_marshal_VOID__POINTER,
- GTK_TYPE_NONE,
- 1,
- GTK_TYPE_OBJECT);
-
-
- gtk_object_class_add_signals (object_class, signals, LAST_SIGNAL);
-
- object_class->set_arg = gtk_text_tag_table_set_arg;
- object_class->get_arg = gtk_text_tag_table_get_arg;
-
- object_class->destroy = gtk_text_tag_table_destroy;
- gobject_class->finalize = gtk_text_tag_table_finalize;
+ g_signal_new (I_("tag-removed"),
+ G_OBJECT_CLASS_TYPE (object_class),
+ G_SIGNAL_RUN_LAST,
+ G_STRUCT_OFFSET (GtkTextTagTableClass, tag_removed),
+ NULL, NULL,
+ _gtk_marshal_VOID__OBJECT,
+ G_TYPE_NONE,
+ 1,
+ GTK_TYPE_TEXT_TAG);
+
+ g_type_class_add_private (klass, sizeof (GtkTextTagTablePrivate));
}
-void
+static void
gtk_text_tag_table_init (GtkTextTagTable *table)
{
- table->hash = g_hash_table_new(g_str_hash, g_str_equal);
-}
+ GtkTextTagTablePrivate *priv;
-GtkTextTagTable*
-gtk_text_tag_table_new (void)
-{
- GtkTextTagTable *table;
+ table->priv = G_TYPE_INSTANCE_GET_PRIVATE (table,
+ GTK_TYPE_TEXT_TAG_TABLE,
+ GtkTextTagTablePrivate);
+ priv = table->priv;
- table = GTK_TEXT_TAG_TABLE (gtk_type_new (gtk_text_tag_table_get_type ()));
-
- return table;
+ priv->hash = g_hash_table_new (g_str_hash, g_str_equal);
}
-static void
-gtk_text_tag_table_destroy (GtkObject *object)
+/**
+ * gtk_text_tag_table_new:
+ *
+ * Creates a new #GtkTextTagTable. The table contains no tags by
+ * default.
+ *
+ * Return value: a new #GtkTextTagTable
+ **/
+GtkTextTagTable*
+gtk_text_tag_table_new (void)
{
GtkTextTagTable *table;
- table = GTK_TEXT_TAG_TABLE(object);
+ table = g_object_new (GTK_TYPE_TEXT_TAG_TABLE, NULL);
- (* GTK_OBJECT_CLASS(parent_class)->destroy) (object);
+ return table;
}
static void
foreach_unref (GtkTextTag *tag, gpointer data)
{
+ GtkTextTagTable *table = GTK_TEXT_TAG_TABLE (tag->priv->table);
+ GtkTextTagTablePrivate *priv = table->priv;
+ GSList *tmp;
+
/* We don't want to emit the remove signal here; so we just unparent
* and unref the tag.
*/
+
+ tmp = priv->buffers;
+ while (tmp != NULL)
+ {
+ _gtk_text_buffer_notify_will_remove_tag (GTK_TEXT_BUFFER (tmp->data),
+ tag);
+
+ tmp = tmp->next;
+ }
- tag->table = NULL;
- g_object_unref (G_OBJECT (tag));
+ tag->priv->table = NULL;
+ g_object_unref (tag);
}
static void
gtk_text_tag_table_finalize (GObject *object)
{
- GtkTextTagTable *table;
-
- table = GTK_TEXT_TAG_TABLE(object);
+ GtkTextTagTable *table = GTK_TEXT_TAG_TABLE (object);
+ GtkTextTagTablePrivate *priv = table->priv;
gtk_text_tag_table_foreach (table, foreach_unref, NULL);
-
- g_hash_table_destroy (table->hash);
- g_slist_free (table->anonymous);
- (* G_OBJECT_CLASS(parent_class)->finalize) (object);
-}
+ g_hash_table_destroy (priv->hash);
+ g_slist_free (priv->anonymous);
+
+ g_slist_free (priv->buffers);
+ G_OBJECT_CLASS (gtk_text_tag_table_parent_class)->finalize (object);
+}
static void
-gtk_text_tag_table_set_arg (GtkObject *object, GtkArg *arg, guint arg_id)
+gtk_text_tag_table_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
{
- GtkTextTagTable *table;
-
- table = GTK_TEXT_TAG_TABLE(object);
-
- switch (arg_id)
+ switch (prop_id)
{
-
+
default:
- g_assert_not_reached();
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
+
static void
-gtk_text_tag_table_get_arg (GtkObject *object, GtkArg *arg, guint arg_id)
+gtk_text_tag_table_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- GtkTextTagTable *table;
-
- table = GTK_TEXT_TAG_TABLE(object);
-
- switch (arg_id)
+ switch (prop_id)
{
default:
- arg->type = GTK_TYPE_INVALID;
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
+static void
+gtk_text_tag_table_buildable_interface_init (GtkBuildableIface *iface)
+{
+ iface->add_child = gtk_text_tag_table_buildable_add_child;
+}
+
+static void
+gtk_text_tag_table_buildable_add_child (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ GObject *child,
+ const gchar *type)
+{
+ if (type && strcmp (type, "tag") == 0)
+ gtk_text_tag_table_add (GTK_TEXT_TAG_TABLE (buildable),
+ GTK_TEXT_TAG (child));
+}
+
+/**
+ * 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.
+ *
+ * @tag must not be in a tag table already, and may not have
+ * the same name as an already-added tag.
+ **/
void
-gtk_text_tag_table_add(GtkTextTagTable *table, GtkTextTag *tag)
+gtk_text_tag_table_add (GtkTextTagTable *table,
+ GtkTextTag *tag)
{
+ GtkTextTagTablePrivate *priv;
guint size;
-
- g_return_if_fail(GTK_IS_TEXT_TAG_TABLE (table));
- g_return_if_fail(GTK_IS_TEXT_TAG (tag));
- g_return_if_fail(tag->name == NULL ||
- g_hash_table_lookup(table->hash, tag->name) == NULL);
- g_return_if_fail(tag->table == NULL);
- gtk_object_ref(GTK_OBJECT(tag));
- gtk_object_sink(GTK_OBJECT(tag));
+ g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
+ g_return_if_fail (GTK_IS_TEXT_TAG (tag));
+ g_return_if_fail (tag->priv->table == NULL);
+
+ priv = table->priv;
- if (tag->name)
- g_hash_table_insert(table->hash, tag->name, tag);
- else
+ if (tag->priv->name && g_hash_table_lookup (priv->hash, tag->priv->name))
{
- table->anonymous = g_slist_prepend (table->anonymous, tag);
- table->anon_count += 1;
+ g_warning ("A tag named '%s' is already in the tag table.",
+ tag->priv->name);
+ return;
}
- tag->table = table;
+ g_object_ref (tag);
+
+ if (tag->priv->name)
+ g_hash_table_insert (priv->hash, tag->priv->name, tag);
+ else
+ {
+ priv->anonymous = g_slist_prepend (priv->anonymous, tag);
+ priv->anon_count += 1;
+ }
+
+ tag->priv->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. */
- size = gtk_text_tag_table_size(table);
- g_assert(size > 0);
- tag->priority = size - 1;
-
- gtk_signal_emit(GTK_OBJECT(table), signals[TAG_ADDED], tag);
+ size = gtk_text_tag_table_get_size (table);
+ g_assert (size > 0);
+ tag->priv->priority = size - 1;
+
+ g_signal_emit (table, signals[TAG_ADDED], 0, tag);
}
+/**
+ * gtk_text_tag_table_lookup:
+ * @table: a #GtkTextTagTable
+ * @name: name of a tag
+ *
+ * Look up a named tag.
+ *
+ * Return value: (transfer none): The tag, or %NULL if none by that name is in the table.
+ **/
GtkTextTag*
-gtk_text_tag_table_lookup(GtkTextTagTable *table, const gchar *name)
+gtk_text_tag_table_lookup (GtkTextTagTable *table,
+ const gchar *name)
{
- 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);
+ GtkTextTagTablePrivate *priv;
+
+ g_return_val_if_fail (GTK_IS_TEXT_TAG_TABLE (table), NULL);
+ g_return_val_if_fail (name != NULL, NULL);
+
+ priv = table->priv;
+
+ return g_hash_table_lookup (priv->hash, name);
}
+/**
+ * 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.
+ **/
void
-gtk_text_tag_table_remove(GtkTextTagTable *table, GtkTextTag *tag)
+gtk_text_tag_table_remove (GtkTextTagTable *table,
+ GtkTextTag *tag)
{
- g_return_if_fail (GTK_IS_TEXT_TAG_TABLE(table));
+ GtkTextTagTablePrivate *priv;
+ GSList *tmp;
+
+ 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 == table);
+ g_return_if_fail (tag->priv->table == table);
+
+ priv = table->priv;
+ /* Our little bad hack to be sure buffers don't still have the tag
+ * applied to text in the buffer
+ */
+ tmp = priv->buffers;
+ while (tmp != NULL)
+ {
+ _gtk_text_buffer_notify_will_remove_tag (GTK_TEXT_BUFFER (tmp->data),
+ tag);
+
+ tmp = tmp->next;
+ }
+
/* 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. */
- gtk_text_tag_set_priority(tag, gtk_text_tag_table_size(table) - 1);
-
- tag->table = NULL;
+ gtk_text_tag_set_priority (tag, gtk_text_tag_table_get_size (table) - 1);
+
+ tag->priv->table = NULL;
- if (tag->name)
- g_hash_table_remove(table->hash, tag->name);
+ if (tag->priv->name)
+ g_hash_table_remove (priv->hash, tag->priv->name);
else
{
- table->anonymous = g_slist_remove (table->anonymous, tag);
- table->anon_count -= 1;
+ priv->anonymous = g_slist_remove (priv->anonymous, tag);
+ priv->anon_count -= 1;
}
-
- gtk_signal_emit(GTK_OBJECT(table), signals[TAG_REMOVED], tag);
- gtk_object_unref(GTK_OBJECT(tag));
+ g_signal_emit (table, signals[TAG_REMOVED], 0, tag);
+
+ g_object_unref (tag);
}
struct ForeachData
struct ForeachData *fd = data;
g_return_if_fail (GTK_IS_TEXT_TAG (value));
-
+
(* fd->func) (value, fd->data);
}
struct ForeachData *fd = user_data;
g_return_if_fail (GTK_IS_TEXT_TAG (data));
-
+
(* fd->func) (data, fd->data);
}
+/**
+ * gtk_text_tag_table_foreach:
+ * @table: a #GtkTextTagTable
+ * @func: (scope call): a function to call on each tag
+ * @data: user data
+ *
+ * Calls @func on each tag in @table, with user data @data.
+ * Note that the table may not be modified while iterating
+ * over it (you can't add/remove tags).
+ **/
void
-gtk_text_tag_table_foreach(GtkTextTagTable *table,
- GtkTextTagTableForeach func,
- gpointer data)
+gtk_text_tag_table_foreach (GtkTextTagTable *table,
+ GtkTextTagTableForeach func,
+ gpointer data)
{
+ GtkTextTagTablePrivate *priv;
struct ForeachData d;
-
- g_return_if_fail(GTK_IS_TEXT_TAG_TABLE(table));
- g_return_if_fail(func != NULL);
+
+ g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
+ g_return_if_fail (func != NULL);
+
+ priv = table->priv;
d.func = func;
d.data = data;
-
- g_hash_table_foreach(table->hash, hash_foreach, &d);
- g_slist_foreach (table->anonymous, list_foreach, &d);
+
+ g_hash_table_foreach (priv->hash, hash_foreach, &d);
+ g_slist_foreach (priv->anonymous, list_foreach, &d);
}
-guint
-gtk_text_tag_table_size(GtkTextTagTable *table)
+/**
+ * gtk_text_tag_table_get_size:
+ * @table: a #GtkTextTagTable
+ *
+ * Returns the size of the table (number of tags)
+ *
+ * Return value: number of tags in @table
+ **/
+gint
+gtk_text_tag_table_get_size (GtkTextTagTable *table)
{
- g_return_val_if_fail(GTK_IS_TEXT_TAG_TABLE(table), 0);
+ GtkTextTagTablePrivate *priv;
+
+ g_return_val_if_fail (GTK_IS_TEXT_TAG_TABLE (table), 0);
+
+ priv = table->priv;
+
+ return g_hash_table_size (priv->hash) + priv->anon_count;
+}
+
+void
+_gtk_text_tag_table_add_buffer (GtkTextTagTable *table,
+ gpointer buffer)
+{
+ GtkTextTagTablePrivate *priv = table->priv;
+
+ priv->buffers = g_slist_prepend (priv->buffers, buffer);
+}
+
+static void
+foreach_remove_tag (GtkTextTag *tag, gpointer data)
+{
+ GtkTextBuffer *buffer;
+
+ buffer = GTK_TEXT_BUFFER (data);
+
+ _gtk_text_buffer_notify_will_remove_tag (buffer, tag);
+}
+
+void
+_gtk_text_tag_table_remove_buffer (GtkTextTagTable *table,
+ gpointer buffer)
+{
+ GtkTextTagTablePrivate *priv = table->priv;
+
+ gtk_text_tag_table_foreach (table, foreach_remove_tag, buffer);
- return g_hash_table_size(table->hash) + table->anon_count;
+ priv->buffers = g_slist_remove (priv->buffers, buffer);
}