midori/katze/katze-weblist.c

/*
 Copyright (C) 2008 Christian Dywan <christian@twotoasts.de>

 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.1 of the License, or (at your option) any later version.

 See the file COPYING for the full license text.
*/

#include "katze-weblist.h"

#include "katze-utils.h"

#include <glib/gi18n.h>
#include <string.h>

/**
 * SECTION:midori-weblist
 * @short_description: A versatile object container
 * @see_also: #MidoriWebItem
 *
 * #MidoriWebList is a versatile container for objects with
 * explicit support for #MidoriWebList and #MidoriWebItem children.
 */

struct _MidoriWebList
{
    GObject parent_instance;

    GList* items;
};

G_DEFINE_TYPE (MidoriWebList, midori_web_list, G_TYPE_OBJECT)

enum {
    ADD_ITEM,
    REMOVE_ITEM,

    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL];

static void
midori_web_list_finalize (GObject* object);

static void
_midori_web_list_add_item (MidoriWebList* web_list,
                           GObject*       item)
{
    g_object_ref (item);
    web_list->items = g_list_append (web_list->items, item);
}

static void
_midori_web_list_remove_item (MidoriWebList* web_list,
                              GObject*       item)
{
    web_list->items = g_list_remove (web_list->items, item);
    g_object_unref (item);
}

static void
midori_web_list_class_init (MidoriWebListClass* class)
{
    signals[ADD_ITEM] = g_signal_new (
        "add-item",
        G_TYPE_FROM_CLASS (class),
        (GSignalFlags)(G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION),
        G_STRUCT_OFFSET (MidoriWebListClass, add_item),
        0,
        NULL,
        g_cclosure_marshal_VOID__OBJECT,
        G_TYPE_NONE, 1,
        G_TYPE_OBJECT);

    signals[REMOVE_ITEM] = g_signal_new (
        "remove-item",
        G_TYPE_FROM_CLASS (class),
        (GSignalFlags)(G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION),
        G_STRUCT_OFFSET (MidoriWebListClass, remove_item),
        0,
        NULL,
        g_cclosure_marshal_VOID__OBJECT,
        G_TYPE_NONE, 1,
        G_TYPE_OBJECT);

    class->add_item = _midori_web_list_add_item;
    class->remove_item = _midori_web_list_remove_item;

    GObjectClass* gobject_class = G_OBJECT_CLASS (class);
    gobject_class->finalize = midori_web_list_finalize;
}

static void
midori_web_list_init (MidoriWebList* web_list)
{
    web_list->items = NULL;
}

static void
midori_web_list_finalize (GObject* object)
{
    MidoriWebList* web_list = MIDORI_WEB_LIST (object);
    guint n, i;

    /* Scruffily remove all items, no need for signals */
    n = g_list_length (web_list->items);
    for (i = 0; i < n; i++)
        g_object_unref (g_list_nth_data (web_list->items, i));
    g_list_free (web_list->items);

    G_OBJECT_CLASS (midori_web_list_parent_class)->finalize (object);
}

/**
 * midori_web_list_new:
 *
 * Creates a new #MidoriWebList.
 *
 * Return value: a new #MidoriWebList
 **/
MidoriWebList*
midori_web_list_new (void)
{
    MidoriWebList* web_list = g_object_new (MIDORI_TYPE_WEB_LIST,
                                            NULL);

    return web_list;
}

/**
 * midori_web_list_add_item:
 * @web_list: a #MidoriWebList
 * @item: a #GObject
 *
 * Adds an item to the list.
 **/
void
midori_web_list_add_item (MidoriWebList* web_list,
                          gpointer       item)
{
    g_return_if_fail (MIDORI_IS_WEB_LIST (web_list));
    g_return_if_fail (G_IS_OBJECT (item));

    g_signal_emit (web_list, signals[ADD_ITEM], 0, item);
}

/**
 * midori_web_list_add_item:
 * @web_list: a #MidoriWebList
 * @item: a #GObject
 *
 * Removes an item from the list.
 **/
void
midori_web_list_remove_item (MidoriWebList* web_list,
                             gpointer       item)
{
    g_return_if_fail (MIDORI_IS_WEB_LIST (web_list));
    g_return_if_fail (G_IS_OBJECT (item));

    g_signal_emit (web_list, signals[REMOVE_ITEM], 0, item);
}

/**
 * midori_web_list_get_nth_item:
 * @web_list: a #MidoriWebList
 * @n: an index in the list
 *
 * Retrieves the item in @web_list at the position @n.
 *
 * Return value: an item, or %NULL
 **/
gpointer
midori_web_list_get_nth_item (MidoriWebList* web_list,
                              guint          n)
{
    g_return_val_if_fail (MIDORI_IS_WEB_LIST (web_list), NULL);

    return g_list_nth_data (web_list->items, n);
}

/**
 * midori_web_list_is_empty:
 * @web_list: a #MidoriWebList
 *
 * Determines if @web_list is empty.
 *
 * Return value: an item, or %NULL
 **/
gboolean
midori_web_list_is_empty (MidoriWebList* web_list)
{
    g_return_val_if_fail (MIDORI_IS_WEB_LIST (web_list), TRUE);

    return !g_list_nth_data (web_list->items, 0);
}

/**
 * midori_web_list_get_item_position:
 * @web_list: a #MidoriWebList
 * @item: an item in the list
 *
 * Retrieves the index of the item in @web_list.
 *
 * Return value: an item, or -1
 **/
gint
midori_web_list_get_item_index (MidoriWebList* web_list,
                                gpointer       item)
{
    g_return_val_if_fail (MIDORI_IS_WEB_LIST (web_list), -1);
    g_return_val_if_fail (G_IS_OBJECT (item), -1);

    return g_list_index (web_list->items, item);
}

/**
 * midori_web_list_find_token:
 * @web_list: a #MidoriWebList
 * @token: a token string
 *
 * Looks up an item in the list which has the specified token.
 *
 * Supported is #MidoriWebItem.
 *
 * Note that @token is by definition unique to one item.
 *
 * Return value: an item, or %NULL
 **/
gpointer
midori_web_list_find_token (MidoriWebList* web_list,
                            const gchar*   token)
{
    guint n, i;
    GObject* item;
    MidoriWebItem* web_item;

    g_return_val_if_fail (MIDORI_IS_WEB_LIST (web_list), NULL);

    n = g_list_length (web_list->items);
    for (i = 0; i < n; i++)
    {
        item = (GObject*)g_list_nth_data (web_list->items, i);
        if (!MIDORI_IS_WEB_ITEM (item))
            continue;
        web_item = (MidoriWebItem*)item;
        if (!strcmp (midori_web_item_get_token (web_item), token))
            return item;
    }
    return NULL;
}

/**
 * midori_web_list_get_length:
 * @web_list: a #MidoriWebList
 *
 * Retrieves the number of items in @web_list.
 *
 * Return value: the length of the list
 **/
guint
midori_web_list_get_length (MidoriWebList* web_list)
{
    g_return_val_if_fail (MIDORI_IS_WEB_LIST (web_list), 0);

    return g_list_length (web_list->items);
}

/**
 * midori_web_list_clear:
 * @web_list: a #MidoriWebList
 *
 * Deletes all items currently contained in @web_list.
 **/
void
midori_web_list_clear (MidoriWebList* web_list)
{
    guint n;
    guint i;
    GObject* item;

    g_return_if_fail (MIDORI_IS_WEB_LIST (web_list));

    n = g_list_length (web_list->items);
    for (i = 0; i < n; i++)
    {
        if ((item = g_list_nth_data (web_list->items, i)))
            midori_web_list_remove_item (web_list, item);
    }
    g_list_free (web_list->items);
    web_list->items = NULL;
}