logdiag/liblogdiag/ld-category.c

565 lines
13 KiB
C
Raw Normal View History

/*
2012-08-29 18:44:47 +02:00
* ld-category.c
*
* This file is a part of logdiag.
2017-02-03 23:06:48 +01:00
* Copyright Přemysl Janouch 2010, 2011, 2012
*
* See the file LICENSE for licensing information.
*
*/
#include "liblogdiag.h"
#include "config.h"
/**
2012-08-29 18:44:47 +02:00
* SECTION:ld-category
* @short_description: A category of symbols
2010-09-25 16:14:09 +02:00
* @see_also: #LdSymbol, #LdLibrary
*
2012-08-29 18:44:47 +02:00
* #LdCategory represents a category of #LdSymbol objects.
*/
/*
2012-08-29 18:44:47 +02:00
* LdCategoryPrivate:
* @parent: the parent of this category.
* @name: the name of this category.
2012-08-29 15:46:20 +02:00
* @human_name: the localized human-readable name of this category.
* @symbols: (element-type LdSymbol *): symbols in this category.
2012-08-29 18:44:47 +02:00
* @subcategories: (element-type LdCategory *) children of this category.
*/
2012-08-29 18:44:47 +02:00
struct _LdCategoryPrivate
{
LdCategory *parent;
gchar *name;
gchar *human_name;
GSList *symbols;
GSList *subcategories;
};
enum
{
PROP_0,
PROP_PARENT,
PROP_NAME,
2012-08-29 15:46:20 +02:00
PROP_HUMAN_NAME
};
2012-08-29 18:44:47 +02:00
static void ld_category_get_property (GObject *object, guint property_id,
GValue *value, GParamSpec *pspec);
2012-08-29 18:44:47 +02:00
static void ld_category_set_property (GObject *object, guint property_id,
const GValue *value, GParamSpec *pspec);
2012-08-29 18:44:47 +02:00
static void ld_category_finalize (GObject *gobject);
2012-08-29 18:44:47 +02:00
static void on_category_notify_name (LdCategory *category,
GParamSpec *pspec, gpointer user_data);
2012-08-29 18:44:47 +02:00
G_DEFINE_TYPE (LdCategory, ld_category, G_TYPE_OBJECT);
static void
2012-08-29 18:44:47 +02:00
ld_category_class_init (LdCategoryClass *klass)
{
GObjectClass *object_class;
GParamSpec *pspec;
object_class = G_OBJECT_CLASS (klass);
2012-08-29 18:44:47 +02:00
object_class->get_property = ld_category_get_property;
object_class->set_property = ld_category_set_property;
object_class->finalize = ld_category_finalize;
/**
* LdCategory:parent:
*
* The parent of this symbol category.
*/
pspec = g_param_spec_string ("parent", "Parent",
"The parent of this symbol category.",
"", G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_PARENT, pspec);
/**
2012-08-29 18:44:47 +02:00
* LdCategory:name:
*
* The name of this symbol category.
*/
pspec = g_param_spec_string ("name", "Name",
"The name of this symbol category.",
"", G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_NAME, pspec);
/**
2012-08-29 18:44:47 +02:00
* LdCategory:human-name:
*
* The localized human name of this symbol category.
*/
pspec = g_param_spec_string ("human-name", "Human name",
"The localized human name of this symbol category.",
"", G_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_HUMAN_NAME, pspec);
2012-08-29 21:56:59 +02:00
/**
* LdCategory::symbols-changed:
*
* The list of symbols has changed.
*/
klass->symbols_changed_signal = g_signal_new
("symbols-changed", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST, 0, NULL, NULL,
g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
/**
* LdCategory::children-changed:
*
* The list of subcategory children has changed.
*/
klass->children_changed_signal = g_signal_new
("children-changed", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST, 0, NULL, NULL,
g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
2012-08-29 18:44:47 +02:00
g_type_class_add_private (klass, sizeof (LdCategoryPrivate));
}
static void
2012-08-29 18:44:47 +02:00
ld_category_init (LdCategory *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE
2012-08-29 18:44:47 +02:00
(self, LD_TYPE_CATEGORY, LdCategoryPrivate);
}
static void
2012-08-29 18:44:47 +02:00
ld_category_get_property (GObject *object, guint property_id,
GValue *value, GParamSpec *pspec)
{
2012-08-29 18:44:47 +02:00
LdCategory *self;
2012-08-29 18:44:47 +02:00
self = LD_CATEGORY (object);
switch (property_id)
{
case PROP_NAME:
2012-08-29 18:44:47 +02:00
g_value_set_string (value, ld_category_get_name (self));
break;
case PROP_HUMAN_NAME:
2012-08-29 18:44:47 +02:00
g_value_set_string (value, ld_category_get_human_name (self));
break;
case PROP_PARENT:
g_value_set_object (value, ld_category_get_parent (self));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
}
static void
2012-08-29 18:44:47 +02:00
ld_category_set_property (GObject *object, guint property_id,
const GValue *value, GParamSpec *pspec)
{
2012-08-29 18:44:47 +02:00
LdCategory *self;
2012-08-29 18:44:47 +02:00
self = LD_CATEGORY (object);
switch (property_id)
{
case PROP_NAME:
2012-08-29 18:44:47 +02:00
ld_category_set_name (self, g_value_get_string (value));
break;
case PROP_HUMAN_NAME:
2012-08-29 18:44:47 +02:00
ld_category_set_human_name (self, g_value_get_string (value));
break;
case PROP_PARENT:
ld_category_set_parent (self, g_value_get_object (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
}
static void
2012-08-29 18:44:47 +02:00
uninstall_category_cb (LdCategory *category, LdCategory *self)
{
g_signal_handlers_disconnect_by_func (category,
on_category_notify_name, self);
if (ld_category_get_parent (category) == self)
ld_category_set_parent (category, NULL);
g_object_unref (category);
}
static void
parent_weak_notify (gpointer data, GObject *object)
{
LdCategory *self;
/* In practice this should never happen, for it would mean that
* we have a parent that have us as its child.
*/
self = (LdCategory *) data;
if (self->priv->parent)
{
self->priv->parent = NULL;
g_object_notify (G_OBJECT (self), "parent");
}
}
static void
2012-08-29 18:44:47 +02:00
ld_category_finalize (GObject *gobject)
{
2012-08-29 18:44:47 +02:00
LdCategory *self;
2012-08-29 18:44:47 +02:00
self = LD_CATEGORY (gobject);
if (self->priv->parent)
g_object_weak_unref
(G_OBJECT (self->priv->parent), parent_weak_notify, self);
if (self->priv->name)
g_free (self->priv->name);
if (self->priv->human_name)
g_free (self->priv->human_name);
g_slist_foreach (self->priv->symbols, (GFunc) g_object_unref, NULL);
g_slist_free (self->priv->symbols);
g_slist_foreach (self->priv->subcategories,
(GFunc) uninstall_category_cb, self);
g_slist_free (self->priv->subcategories);
/* Chain up to the parent class. */
2012-08-29 18:44:47 +02:00
G_OBJECT_CLASS (ld_category_parent_class)->finalize (gobject);
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_new:
* @name: the name of the new category.
* @human_name: the localized human name of the new category.
*
* Create an instance.
*/
2012-08-29 18:44:47 +02:00
LdCategory *
ld_category_new (const gchar *name, const gchar *human_name)
{
2012-08-29 18:44:47 +02:00
LdCategory *cat;
g_return_val_if_fail (name != NULL, NULL);
g_return_val_if_fail (human_name != NULL, NULL);
2012-08-29 18:44:47 +02:00
cat = g_object_new (LD_TYPE_CATEGORY, NULL);
cat->priv->name = g_strdup (name);
cat->priv->human_name = g_strdup (human_name);
return cat;
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_set_name:
* @self: an #LdCategory object.
* @name: the new name for this category.
*/
void
2012-08-29 18:44:47 +02:00
ld_category_set_name (LdCategory *self, const gchar *name)
{
2012-08-29 18:44:47 +02:00
g_return_if_fail (LD_IS_CATEGORY (self));
g_return_if_fail (name != NULL);
if (self->priv->name)
g_free (self->priv->name);
self->priv->name = g_strdup (name);
g_object_notify (G_OBJECT (self), "name");
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_get_name:
* @self: an #LdCategory object.
*
* Return the name of this category.
*/
const gchar *
2012-08-29 18:44:47 +02:00
ld_category_get_name (LdCategory *self)
{
2012-08-29 18:44:47 +02:00
g_return_val_if_fail (LD_IS_CATEGORY (self), NULL);
return self->priv->name;
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_set_human_name:
* @self: an #LdCategory object.
* @human_name: the new localized human name for this category.
*/
void
2012-08-29 18:44:47 +02:00
ld_category_set_human_name (LdCategory *self, const gchar *human_name)
{
2012-08-29 18:44:47 +02:00
g_return_if_fail (LD_IS_CATEGORY (self));
g_return_if_fail (human_name != NULL);
if (self->priv->human_name)
g_free (self->priv->human_name);
self->priv->human_name = g_strdup (human_name);
g_object_notify (G_OBJECT (self), "human-name");
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_get_human_name:
* @self: an #LdCategory object.
*
* Return the localized human name of this category.
*/
const gchar *
2012-08-29 18:44:47 +02:00
ld_category_get_human_name (LdCategory *self)
{
2012-08-29 18:44:47 +02:00
g_return_val_if_fail (LD_IS_CATEGORY (self), NULL);
return self->priv->human_name;
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_insert_symbol:
* @self: an #LdCategory object.
* @symbol: the symbol to be inserted.
* @pos: the position at which the symbol will be inserted.
* Negative values will append to the end of list.
*
* Insert a symbol into the category.
*
* Return value: %TRUE if successful (no name collisions).
*/
gboolean
2012-08-29 18:44:47 +02:00
ld_category_insert_symbol (LdCategory *self, LdSymbol *symbol, gint pos)
{
const gchar *name;
const GSList *iter;
2012-08-29 18:44:47 +02:00
g_return_val_if_fail (LD_IS_CATEGORY (self), FALSE);
g_return_val_if_fail (LD_IS_SYMBOL (symbol), FALSE);
/* Check for name collisions. */
name = ld_symbol_get_name (symbol);
for (iter = self->priv->symbols; iter; iter = iter->next)
{
if (!strcmp (name, ld_symbol_get_name (iter->data)))
{
g_warning ("attempted to insert multiple `%s' symbols into"
2012-08-29 18:44:47 +02:00
" category `%s'", name, ld_category_get_name (self));
return FALSE;
}
}
self->priv->symbols = g_slist_insert (self->priv->symbols, symbol, pos);
g_object_ref (symbol);
2012-08-29 21:56:59 +02:00
g_signal_emit (self,
LD_CATEGORY_GET_CLASS (self)->symbols_changed_signal, 0);
return TRUE;
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_remove_symbol:
* @self: an #LdCategory object.
* @symbol: the symbol to be removed.
*
* Removes a symbol from the category.
*/
void
2012-08-29 18:44:47 +02:00
ld_category_remove_symbol (LdCategory *self, LdSymbol *symbol)
{
2012-08-29 20:57:31 +02:00
GSList *link;
2012-08-29 18:44:47 +02:00
g_return_if_fail (LD_IS_CATEGORY (self));
g_return_if_fail (LD_IS_SYMBOL (symbol));
2012-08-29 20:57:31 +02:00
if ((link = g_slist_find (self->priv->symbols, symbol)))
{
2012-08-29 20:57:31 +02:00
self->priv->symbols = g_slist_delete_link (self->priv->symbols, link);
g_object_unref (symbol);
2012-08-29 21:56:59 +02:00
g_signal_emit (self,
LD_CATEGORY_GET_CLASS (self)->symbols_changed_signal, 0);
}
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_get_symbols:
* @self: an #LdCategory object.
*
* Return value: (element-type LdSymbol *): a list of symbols. Do not modify.
*/
const GSList *
2012-08-29 18:44:47 +02:00
ld_category_get_symbols (LdCategory *self)
{
2012-08-29 18:44:47 +02:00
g_return_val_if_fail (LD_IS_CATEGORY (self), NULL);
return self->priv->symbols;
}
/**
* ld_category_set_parent:
* @self: an #LdCategory object.
* @parent: the new parent category.
*
* Set the parent of this category.
*/
void
ld_category_set_parent (LdCategory *self, LdCategory *parent)
{
g_return_if_fail (LD_IS_CATEGORY (self));
g_return_if_fail (parent == NULL || LD_IS_CATEGORY (parent));
if (self->priv->parent)
g_object_weak_unref
(G_OBJECT (self->priv->parent), parent_weak_notify, self);
self->priv->parent = parent;
if (parent)
g_object_weak_ref (G_OBJECT (parent), parent_weak_notify, self);
g_object_notify (G_OBJECT (self), "parent");
}
/**
* ld_category_get_parent:
* @self: an #LdCategory object.
*
* Return value: the parent of this category.
*/
LdCategory *
ld_category_get_parent (LdCategory *self)
{
g_return_val_if_fail (LD_IS_CATEGORY (self), NULL);
return self->priv->parent;
}
2012-09-09 16:39:36 +02:00
/**
* ld_category_get_path:
* @self: an #LdCategory object.
*
* Return value: the path to this category within the library.
*/
gchar *
ld_category_get_path (LdCategory *self)
{
LdCategory *iter;
gchar *path = NULL, *new_path;
g_return_val_if_fail (LD_IS_CATEGORY (self), NULL);
for (iter = self; iter; iter = ld_category_get_parent (iter))
{
const gchar *name;
/* Stop at the root category. */
name = ld_category_get_name (iter);
if (!strcmp (name, LD_LIBRARY_IDENTIFIER_SEPARATOR))
break;
new_path = g_build_path
(LD_LIBRARY_IDENTIFIER_SEPARATOR, name, path, NULL);
g_free (path);
path = new_path;
}
return path;
}
static void
2012-08-29 18:44:47 +02:00
on_category_notify_name (LdCategory *category,
GParamSpec *pspec, gpointer user_data)
{
2012-08-29 18:44:47 +02:00
LdCategory *self;
2012-08-29 18:44:47 +02:00
self = (LdCategory *) user_data;
g_warning ("name of a library subcategory has changed");
/* The easy way of handling it. */
g_object_ref (category);
2012-08-29 18:44:47 +02:00
ld_category_remove_child (self, category);
ld_category_add_child (self, category);
g_object_unref (category);
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_add_child:
* @self: an #LdCategory object.
* @category: the category to be inserted.
*
* Insert a subcategory into the category.
*
* Return value: %TRUE if successful (no name collisions).
*/
gboolean
2012-08-29 18:44:47 +02:00
ld_category_add_child (LdCategory *self, LdCategory *category)
{
const gchar *name;
GSList *iter;
2012-08-29 18:44:47 +02:00
g_return_val_if_fail (LD_IS_CATEGORY (self), FALSE);
g_return_val_if_fail (LD_IS_CATEGORY (category), FALSE);
2012-08-29 18:44:47 +02:00
name = ld_category_get_name (category);
for (iter = self->priv->subcategories; iter; iter = iter->next)
{
gint comp;
2012-08-29 18:44:47 +02:00
comp = g_utf8_collate (name, ld_category_get_name (iter->data));
if (!comp)
{
g_warning ("attempted to insert multiple `%s' subcategories into"
2012-08-29 18:44:47 +02:00
" category `%s'", name, ld_category_get_name (self));
return FALSE;
}
if (comp < 0)
break;
}
g_signal_connect (category, "notify::name",
G_CALLBACK (on_category_notify_name), self);
self->priv->subcategories = g_slist_insert_before
(self->priv->subcategories, iter, category);
ld_category_set_parent (category, self);
g_object_ref (category);
2012-08-29 21:56:59 +02:00
g_signal_emit (self,
LD_CATEGORY_GET_CLASS (self)->children_changed_signal, 0);
return TRUE;
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_remove_child:
* @self: an #LdCategory object.
* @category: the category to be removed.
*
* Removes a subcategory from the category.
*/
void
2012-08-29 18:44:47 +02:00
ld_category_remove_child (LdCategory *self, LdCategory *category)
{
2012-08-29 20:57:31 +02:00
GSList *link;
2012-08-29 18:44:47 +02:00
g_return_if_fail (LD_IS_CATEGORY (self));
g_return_if_fail (LD_IS_CATEGORY (category));
2012-08-29 20:57:31 +02:00
if ((link = g_slist_find (self->priv->subcategories, category)))
{
self->priv->subcategories
2012-08-29 20:57:31 +02:00
= g_slist_delete_link (self->priv->subcategories, link);
uninstall_category_cb (category, self);
2012-08-29 21:56:59 +02:00
g_signal_emit (self,
LD_CATEGORY_GET_CLASS (self)->children_changed_signal, 0);
}
}
/**
2012-08-29 18:44:47 +02:00
* ld_category_get_children:
* @self: an #LdCategory object.
*
2012-08-29 18:44:47 +02:00
* Return value: (element-type LdCategory *):
* a list of subcategories. Do not modify.
*/
const GSList *
2012-08-29 18:44:47 +02:00
ld_category_get_children (LdCategory *self)
{
2012-08-29 18:44:47 +02:00
g_return_val_if_fail (LD_IS_CATEGORY (self), NULL);
return self->priv->subcategories;
}