path: root/e-util/e-tree-table-adapter.c

/*
 * This program 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) version 3.
 *
 * This program 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 the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 *      Chris Toshok <toshok@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#include "e-tree-table-adapter.h"

#include <stdlib.h>
#include <string.h>

#include <glib/gstdio.h>

#include <libxml/tree.h>
#include <libxml/parser.h>

#include <libedataserver/libedataserver.h>

#include "e-marshal.h"
#include "e-table-sorting-utils.h"
#include "e-xml-utils.h"

#define E_TREE_TABLE_ADAPTER_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), E_TYPE_TREE_TABLE_ADAPTER, ETreeTableAdapterPrivate))

#define d(x)

#define INCREMENT_AMOUNT 100

typedef struct {
    ETreePath path;
    guint32 num_visible_children;
    guint32 index;

    guint expanded : 1;
    guint expandable : 1;
    guint expandable_set : 1;
} node_t;

struct _ETreeTableAdapterPrivate {
    ETreeModel *source_model;
    gulong pre_change_handler_id;
    gulong rebuilt_handler_id;
    gulong node_changed_handler_id;
    gulong node_data_changed_handler_id;
    gulong node_inserted_handler_id;
    gulong node_removed_handler_id;

    ETableSortInfo *sort_info;
    gulong sort_info_changed_handler_id;

    ETableHeader *header;

    gint n_map;
    gint n_vals_allocated;
    node_t **map_table;
    GHashTable *nodes;
    GNode *root;

    guint root_visible : 1;
    guint remap_needed : 1;

    gint last_access;

    guint resort_idle_id;

    gint force_expanded_state; /* use this instead of model's default if not 0; <0 ... collapse, >0 ... expand */
};

enum {
    PROP_0,
    PROP_HEADER,
    PROP_SORT_INFO,
    PROP_SOURCE_MODEL
};

enum {
    SORTING_CHANGED,
    LAST_SIGNAL
};

/* Forward Declarations */
static void e_tree_table_adapter_table_model_init
                    (ETableModelInterface *interface);

static guint signals[LAST_SIGNAL];

G_DEFINE_TYPE_WITH_CODE (
    ETreeTableAdapter,
    e_tree_table_adapter,
    G_TYPE_OBJECT,
    G_IMPLEMENT_INTERFACE (
        E_TYPE_TABLE_MODEL,
        e_tree_table_adapter_table_model_init))

static GNode *
lookup_gnode (ETreeTableAdapter *etta,
              ETreePath path)
{
    GNode *gnode;

    if (!path)
        return NULL;

    gnode = g_hash_table_lookup (etta->priv->nodes, path);

    return gnode;
}

static void
resize_map (ETreeTableAdapter *etta,
            gint size)
{
    if (size > etta->priv->n_vals_allocated) {
        etta->priv->n_vals_allocated = MAX (etta->priv->n_vals_allocated + INCREMENT_AMOUNT, size);
        etta->priv->map_table = g_renew (node_t *, etta->priv->map_table, etta->priv->n_vals_allocated);
    }

    etta->priv->n_map = size;
}

static void
move_map_elements (ETreeTableAdapter *etta,
                   gint to,
                   gint from,
                   gint count)
{
    if (count <= 0 || from >= etta->priv->n_map)
        return;
    memmove (etta->priv->map_table + to, etta->priv->map_table + from, count * sizeof (node_t *));
    etta->priv->remap_needed = TRUE;
}

static gint
fill_map (ETreeTableAdapter *etta,
          gint index,
          GNode *gnode)
{
    GNode *p;

    if ((gnode != etta->priv->root) || etta->priv->root_visible)
        etta->priv->map_table[index++] = gnode->data;

    for (p = gnode->children; p; p = p->next)
        index = fill_map (etta, index, p);

    etta->priv->remap_needed = TRUE;
    return index;
}

static void
remap_indices (ETreeTableAdapter *etta)
{
    gint i;
    for (i = 0; i < etta->priv->n_map; i++)
        etta->priv->map_table[i]->index = i;
    etta->priv->remap_needed = FALSE;
}

static node_t *
get_node (ETreeTableAdapter *etta,
          ETreePath path)
{
    GNode *gnode = lookup_gnode (etta, path);

    if (!gnode)
        return NULL;

    return (node_t *) gnode->data;
}

static void
resort_node (ETreeTableAdapter *etta,
             GNode *gnode,
             gboolean recurse)
{
    node_t *node = (node_t *) gnode->data;
    ETreePath *paths, path;
    GNode *prev, *curr;
    gint i, count;
    gboolean sort_needed;

    if (node->num_visible_children == 0)
        return;

    sort_needed = etta->priv->sort_info && e_table_sort_info_sorting_get_count (etta->priv->sort_info) > 0;

    for (i = 0, path = e_tree_model_node_get_first_child (etta->priv->source_model, node->path); path;
         path = e_tree_model_node_get_next (etta->priv->source_model, path), i++);

    count = i;
    if (count <= 1)
        return;

    paths = g_new0 (ETreePath, count);

    for (i = 0, path = e_tree_model_node_get_first_child (etta->priv->source_model, node->path); path;
         path = e_tree_model_node_get_next (etta->priv->source_model, path), i++)
        paths[i] = path;

    if (count > 1 && sort_needed)
        e_table_sorting_utils_tree_sort (etta->priv->source_model, etta->priv->sort_info, etta->priv->header, paths, count);

    prev = NULL;
    for (i = 0; i < count; i++) {
        curr = lookup_gnode (etta, paths[i]);
        if (!curr)
            continue;

        if (prev)
            prev->next = curr;
        else
            gnode->children = curr;

        curr->prev = prev;
        curr->next = NULL;
        prev = curr;
        if (recurse)
            resort_node (etta, curr, recurse);
    }

    g_free (paths);
}

static void
kill_gnode (GNode *node,
            ETreeTableAdapter *etta)
{
    g_hash_table_remove (etta->priv->nodes, ((node_t *) node->data)->path);

    while (node->children) {
        GNode *next = node->children->next;
        kill_gnode (node->children, etta);
        node->children = next;
    }

    g_free (node->data);
    if (node == etta->priv->root)
        etta->priv->root = NULL;
    g_node_destroy (node);
}

static void
update_child_counts (GNode *gnode,
                     gint delta)
{
    while (gnode) {
        node_t *node = (node_t *) gnode->data;
        node->num_visible_children += delta;
        gnode = gnode->parent;
    }
}

static gint
delete_children (ETreeTableAdapter *etta,
                 GNode *gnode)
{
    node_t *node = (node_t *) gnode->data;
    gint to_remove = node ? node->num_visible_children : 0;

    if (to_remove == 0)
        return 0;

    while (gnode->children) {
        GNode *next = gnode->children->next;
        kill_gnode (gnode->children, etta);
        gnode->children = next;
    }

    return to_remove;
}

static void
delete_node (ETreeTableAdapter *etta,
             ETreePath parent,
             ETreePath path)
{
    gint to_remove = 1;
    gint parent_row = e_tree_table_adapter_row_of_node (etta, parent);
    gint row = e_tree_table_adapter_row_of_node (etta, path);
    GNode *gnode = lookup_gnode (etta, path);
    GNode *parent_gnode = lookup_gnode (etta, parent);

    e_table_model_pre_change (E_TABLE_MODEL (etta));

    if (row == -1) {
        e_table_model_no_change (E_TABLE_MODEL (etta));
        return;
    }

    to_remove += delete_children (etta, gnode);
    kill_gnode (gnode, etta);

    move_map_elements (etta, row, row + to_remove, etta->priv->n_map - row - to_remove);
    resize_map (etta, etta->priv->n_map - to_remove);

    if (parent_gnode != NULL) {
        node_t *parent_node = parent_gnode->data;
        gboolean expandable = e_tree_model_node_is_expandable (etta->priv->source_model, parent);

        update_child_counts (parent_gnode, - to_remove);
        if (parent_node->expandable != expandable) {
            e_table_model_pre_change (E_TABLE_MODEL (etta));
            parent_node->expandable = expandable;
            e_table_model_row_changed (E_TABLE_MODEL (etta), parent_row);
        }

        resort_node (etta, parent_gnode, FALSE);
    }

    e_table_model_rows_deleted (E_TABLE_MODEL (etta), row, to_remove);
}

static GNode *
create_gnode (ETreeTableAdapter *etta,
              ETreePath path)
{
    GNode *gnode;
    node_t *node;

    node = g_new0 (node_t, 1);
    node->path = path;
    node->index = -1;
    node->expanded = etta->priv->force_expanded_state == 0 ? e_tree_model_get_expanded_default (etta->priv->source_model) : etta->priv->force_expanded_state > 0;
    node->expandable = e_tree_model_node_is_expandable (etta->priv->source_model, path);
    node->expandable_set = 1;
    node->num_visible_children = 0;
    gnode = g_node_new (node);
    g_hash_table_insert (etta->priv->nodes, path, gnode);
    return gnode;
}

static gint
insert_children (ETreeTableAdapter *etta,
                 GNode *gnode)
{
    ETreePath path, tmp;
    gint count = 0;
    gint pos = 0;

    path = ((node_t *) gnode->data)->path;
    for (tmp = e_tree_model_node_get_first_child (etta->priv->source_model, path);
         tmp;
         tmp = e_tree_model_node_get_next (etta->priv->source_model, tmp), pos++) {
        GNode *child = create_gnode (etta, tmp);
        node_t *node = (node_t *) child->data;
        if (node->expanded)
            node->num_visible_children = insert_children (etta, child);
        g_node_prepend (gnode, child);
        count += node->num_visible_children + 1;
    }
    g_node_reverse_children (gnode);
    return count;
}

static void
generate_tree (ETreeTableAdapter *etta,
               ETreePath path)
{
    GNode *gnode;
    node_t *node;
    gint size;

    e_table_model_pre_change (E_TABLE_MODEL (etta));

    g_return_if_fail (e_tree_model_node_is_root (etta->priv->source_model, path));

    if (etta->priv->root)
        kill_gnode (etta->priv->root, etta);
    resize_map (etta, 0);

    gnode = create_gnode (etta, path);
    node = (node_t *) gnode->data;
    node->expanded = TRUE;
    node->num_visible_children = insert_children (etta, gnode);
    if (etta->priv->sort_info && e_table_sort_info_sorting_get_count (etta->priv->sort_info) > 0)
        resort_node (etta, gnode, TRUE);

    etta->priv->root = gnode;
    size =  etta->priv->root_visible ? node->num_visible_children + 1 : node->num_visible_children;
    resize_map (etta, size);
    fill_map (etta, 0, gnode);
    e_table_model_changed (E_TABLE_MODEL (etta));
}

static void
insert_node (ETreeTableAdapter *etta,
             ETreePath parent,
             ETreePath path)
{
    GNode *gnode, *parent_gnode;
    node_t *node, *parent_node;
    gboolean expandable;
    gint size, row;

    e_table_model_pre_change (E_TABLE_MODEL (etta));

    if (get_node (etta, path)) {
        e_table_model_no_change (E_TABLE_MODEL (etta));
        return;
    }

    parent_gnode = lookup_gnode (etta, parent);
    if (!parent_gnode) {
        ETreePath grandparent = e_tree_model_node_get_parent (etta->priv->source_model, parent);
        if (e_tree_model_node_is_root (etta->priv->source_model, parent))
            generate_tree (etta, parent);
        else
            insert_node (etta, grandparent, parent);
        e_table_model_changed (E_TABLE_MODEL (etta));
        return;
    }

    parent_node = (node_t *) parent_gnode->data;

    if (parent_gnode != etta->priv->root) {
        expandable = e_tree_model_node_is_expandable (etta->priv->source_model, parent);
        if (parent_node->expandable != expandable) {
            e_table_model_pre_change (E_TABLE_MODEL (etta));
            parent_node->expandable = expandable;
            parent_node->expandable_set = 1;
            e_table_model_row_changed (E_TABLE_MODEL (etta), parent_node->index);
        }
    }

    if (!e_tree_table_adapter_node_is_expanded (etta, parent)) {
        e_table_model_no_change (E_TABLE_MODEL (etta));
        return;
    }

    gnode = create_gnode (etta, path);
    node = (node_t *) gnode->data;

    if (node->expanded)
        node->num_visible_children = insert_children (etta, gnode);

    g_node_append (parent_gnode, gnode);
    update_child_counts (parent_gnode, node->num_visible_children + 1);
    resort_node (etta, parent_gnode, FALSE);
    resort_node (etta, gnode, TRUE);

    size = node->num_visible_children + 1;
    resize_map (etta, etta->priv->n_map + size);
    if (parent_gnode == etta->priv->root)
        row = 0;
    else {
        gint new_size = parent_node->num_visible_children + 1;
        gint old_size = new_size - size;
        row = parent_node->index;
        move_map_elements (etta, row + new_size, row + old_size, etta->priv->n_map - row - new_size);
    }
    fill_map (etta, row, parent_gnode);
    e_table_model_rows_inserted (
        E_TABLE_MODEL (etta),
        e_tree_table_adapter_row_of_node (etta, path), size);
}

typedef struct {
    GSList *paths;
    gboolean expanded;
} check_expanded_closure;

static gboolean
check_expanded (GNode *gnode,
                gpointer data)
{
    check_expanded_closure *closure = (check_expanded_closure *) data;
    node_t *node = (node_t *) gnode->data;

    if (node->expanded != closure->expanded)
        closure->paths = g_slist_prepend (closure->paths, node->path);

    return FALSE;
}

static void
update_node (ETreeTableAdapter *etta,
             ETreePath path)
{
    check_expanded_closure closure;
    ETreePath parent = e_tree_model_node_get_parent (etta->priv->source_model, path);
    GNode *gnode = lookup_gnode (etta, path);
    GSList *l;

    closure.expanded = e_tree_model_get_expanded_default (etta->priv->source_model);
    closure.paths = NULL;

    if (gnode)
        g_node_traverse (gnode, G_POST_ORDER, G_TRAVERSE_ALL, -1, check_expanded, &closure);

    if (e_tree_model_node_is_root (etta->priv->source_model, path))
        generate_tree (etta, path);
    else {
        delete_node (etta, parent, path);
        insert_node (etta, parent, path);
    }

    for (l = closure.paths; l; l = l->next)
        if (lookup_gnode (etta, l->data))
            e_tree_table_adapter_node_set_expanded (etta, l->data, !closure.expanded);

    g_slist_free (closure.paths);
}

static void
tree_table_adapter_sort_info_changed_cb (ETableSortInfo *sort_info,
                                         ETreeTableAdapter *etta)
{
    if (!etta->priv->root)
        return;

    /* the function is called also internally, with sort_info = NULL,
     * thus skip those in signal emit */
    if (sort_info) {
        gboolean handled = FALSE;

        g_signal_emit (etta, signals[SORTING_CHANGED], 0, &handled);

        if (handled)
            return;
    }

    e_table_model_pre_change (E_TABLE_MODEL (etta));
    resort_node (etta, etta->priv->root, TRUE);
    fill_map (etta, 0, etta->priv->root);
    e_table_model_changed (E_TABLE_MODEL (etta));
}

static void
tree_table_adapter_source_model_pre_change_cb (ETreeModel *source_model,
                                               ETreeTableAdapter *etta)
{
    e_table_model_pre_change (E_TABLE_MODEL (etta));
}

static void
tree_table_adapter_source_model_rebuilt_cb (ETreeModel *source_model,
                                            ETreeTableAdapter *etta)
{
    if (!etta->priv->root)
        return;

    kill_gnode (etta->priv->root, etta);
    etta->priv->root = NULL;

    g_hash_table_remove_all (etta->priv->nodes);
}

static gboolean
tree_table_adapter_resort_model_idle_cb (gpointer user_data)
{
    ETreeTableAdapter *etta;

    etta = E_TREE_TABLE_ADAPTER (user_data);
    tree_table_adapter_sort_info_changed_cb (NULL, etta);
    etta->priv->resort_idle_id = 0;

    return FALSE;
}

static void
tree_table_adapter_source_model_node_changed_cb (ETreeModel *source_model,
                                                 ETreePath path,
                                                 ETreeTableAdapter *etta)
{
    update_node (etta, path);
    e_table_model_changed (E_TABLE_MODEL (etta));

    /* FIXME: Really it shouldnt be required. But a lot of thread
     * which were supposed to be present in the list is way below
     */
    if (etta->priv->resort_idle_id == 0)
        etta->priv->resort_idle_id = g_idle_add (
            tree_table_adapter_resort_model_idle_cb, etta);
}

static void
tree_table_adapter_source_model_node_data_changed_cb (ETreeModel *source_model,
                                                      ETreePath path,
                                                      ETreeTableAdapter *etta)
{
    gint row = e_tree_table_adapter_row_of_node (etta, path);

    if (row == -1) {
        e_table_model_no_change (E_TABLE_MODEL (etta));
        return;
    }

    e_table_model_row_changed (E_TABLE_MODEL (etta), row);
}

static void
tree_table_adapter_source_model_node_inserted_cb (ETreeModel *etm,
                                                  ETreePath parent,
                                                  ETreePath child,
                                                  ETreeTableAdapter *etta)
{
    if (e_tree_model_node_is_root (etm, child))
        generate_tree (etta, child);
    else
        insert_node (etta, parent, child);

    e_table_model_changed (E_TABLE_MODEL (etta));
}

static void
tree_table_adapter_source_model_node_removed_cb (ETreeModel *etm,
                                                 ETreePath parent,
                                                 ETreePath child,
                                                 gint old_position,
                                                 ETreeTableAdapter *etta)
{
    delete_node (etta, parent, child);
    e_table_model_changed (E_TABLE_MODEL (etta));
}

static void
tree_table_adapter_set_header (ETreeTableAdapter *etta,
                               ETableHeader *header)
{
    if (header == NULL)
        return;

    g_return_if_fail (E_IS_TABLE_HEADER (header));
    g_return_if_fail (etta->priv->header == NULL);

    etta->priv->header = g_object_ref (header);
}

static void
tree_table_adapter_set_source_model (ETreeTableAdapter *etta,
                                     ETreeModel *source_model)
{
    g_return_if_fail (E_IS_TREE_MODEL (source_model));
    g_return_if_fail (etta->priv->source_model == NULL);

    etta->priv->source_model = g_object_ref (source_model);
}

static void
tree_table_adapter_set_property (GObject *object,
                                 guint property_id,
                                 const GValue *value,
                                 GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_HEADER:
            tree_table_adapter_set_header (
                E_TREE_TABLE_ADAPTER (object),
                g_value_get_object (value));
            return;

        case PROP_SORT_INFO:
            e_tree_table_adapter_set_sort_info (
                E_TREE_TABLE_ADAPTER (object),
                g_value_get_object (value));
            return;

        case PROP_SOURCE_MODEL:
            tree_table_adapter_set_source_model (
                E_TREE_TABLE_ADAPTER (object),
                g_value_get_object (value));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
tree_table_adapter_get_property (GObject *object,
                                 guint property_id,
                                 GValue *value,
                                 GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_HEADER:
            g_value_set_object (
                value,
                e_tree_table_adapter_get_header (
                E_TREE_TABLE_ADAPTER (object)));
            return;

        case PROP_SORT_INFO:
            g_value_set_object (
                value,
                e_tree_table_adapter_get_sort_info (
                E_TREE_TABLE_ADAPTER (object)));
            return;

        case PROP_SOURCE_MODEL:
            g_value_set_object (
                value,
                e_tree_table_adapter_get_source_model (
                E_TREE_TABLE_ADAPTER (object)));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
tree_table_adapter_dispose (GObject *object)
{
    ETreeTableAdapterPrivate *priv;

    priv = E_TREE_TABLE_ADAPTER_GET_PRIVATE (object);

    if (priv->pre_change_handler_id > 0) {
        g_signal_handler_disconnect (
            priv->source_model,
            priv->pre_change_handler_id);
        priv->pre_change_handler_id = 0;
    }

    if (priv->rebuilt_handler_id > 0) {
        g_signal_handler_disconnect (
            priv->source_model,
            priv->rebuilt_handler_id);
        priv->rebuilt_handler_id = 0;
    }

    if (priv->node_changed_handler_id > 0) {
        g_signal_handler_disconnect (
            priv->source_model,
            priv->node_changed_handler_id);
        priv->node_changed_handler_id = 0;
    }

    if (priv->node_data_changed_handler_id > 0) {
        g_signal_handler_disconnect (
            priv->source_model,
            priv->node_data_changed_handler_id);
        priv->node_data_changed_handler_id = 0;
    }

    if (priv->node_inserted_handler_id > 0) {
        g_signal_handler_disconnect (
            priv->source_model,
            priv->node_inserted_handler_id);
        priv->node_inserted_handler_id = 0;
    }

    if (priv->node_removed_handler_id > 0) {
        g_signal_handler_disconnect (
            priv->source_model,
            priv->node_removed_handler_id);
        priv->node_removed_handler_id = 0;
    }

    if (priv->sort_info_changed_handler_id > 0) {
        g_signal_handler_disconnect (
            priv->sort_info,
            priv->sort_info_changed_handler_id);
        priv->sort_info_changed_handler_id = 0;
    }

    g_clear_object (&priv->source_model);
    g_clear_object (&priv->sort_info);
    g_clear_object (&priv->header);

    /* Chain up to parent's dispose() method. */
    G_OBJECT_CLASS (e_tree_table_adapter_parent_class)->dispose (object);
}

static void
tree_table_adapter_finalize (GObject *object)
{
    ETreeTableAdapterPrivate *priv;

    priv = E_TREE_TABLE_ADAPTER_GET_PRIVATE (object);

    if (priv->resort_idle_id) {
        g_source_remove (priv->resort_idle_id);
        priv->resort_idle_id = 0;
    }

    if (priv->root) {
        kill_gnode (priv->root, E_TREE_TABLE_ADAPTER (object));
        priv->root = NULL;
    }

    g_hash_table_destroy (priv->nodes);

    g_free (priv->map_table);

    /* Chain up to parent's finalize() method. */
    G_OBJECT_CLASS (e_tree_table_adapter_parent_class)->finalize (object);
}

static void
tree_table_adapter_constructed (GObject *object)
{
    ETreeTableAdapter *etta;
    ETreeModel *source_model;
    ETreePath root;
    gulong handler_id;

    etta = E_TREE_TABLE_ADAPTER (object);

    /* Chain up to parent's constructed() method. */
    G_OBJECT_CLASS (e_tree_table_adapter_parent_class)->
        constructed (object);

    source_model = e_tree_table_adapter_get_source_model (etta);

    root = e_tree_model_get_root (source_model);
    if (root != NULL)
        generate_tree (etta, root);

    handler_id = g_signal_connect (
        source_model, "pre_change",
        G_CALLBACK (tree_table_adapter_source_model_pre_change_cb),
        etta);
    etta->priv->pre_change_handler_id = handler_id;

    handler_id = g_signal_connect (
        source_model, "rebuilt",
        G_CALLBACK (tree_table_adapter_source_model_rebuilt_cb),
        etta);
    etta->priv->rebuilt_handler_id = handler_id;

    handler_id = g_signal_connect (
        source_model, "node_changed",
        G_CALLBACK (tree_table_adapter_source_model_node_changed_cb),
        etta);
    etta->priv->node_changed_handler_id = handler_id;

    handler_id = g_signal_connect (
        source_model, "node_data_changed",
        G_CALLBACK (tree_table_adapter_source_model_node_data_changed_cb),
        etta);
    etta->priv->node_data_changed_handler_id = handler_id;

    handler_id = g_signal_connect (
        source_model, "node_inserted",
        G_CALLBACK (tree_table_adapter_source_model_node_inserted_cb),
        etta);
    etta->priv->node_inserted_handler_id = handler_id;

    handler_id = g_signal_connect (
        source_model, "node_removed",
        G_CALLBACK (tree_table_adapter_source_model_node_removed_cb),
        etta);
    etta->priv->node_removed_handler_id = handler_id;
}

static gint
tree_table_adapter_column_count (ETableModel *etm)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    return e_tree_model_column_count (etta->priv->source_model);
}

static gboolean
tree_table_adapter_has_save_id (ETableModel *etm)
{
    return TRUE;
}

static gchar *
tree_table_adapter_get_save_id (ETableModel *etm,
                                gint row)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    return e_tree_model_get_save_id (
        etta->priv->source_model,
        e_tree_table_adapter_node_at_row (etta, row));
}

static gint
tree_table_adapter_row_count (ETableModel *etm)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    return etta->priv->n_map;
}

static gpointer
tree_table_adapter_value_at (ETableModel *etm,
                             gint col,
                             gint row)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    switch (col) {
    case -1:
        if (row == -1)
            return NULL;
        return e_tree_table_adapter_node_at_row (etta, row);
    case -2:
        return etta->priv->source_model;
    case -3:
        return etta;
    default:
        return e_tree_model_value_at (
            etta->priv->source_model,
            e_tree_table_adapter_node_at_row (etta, row), col);
    }
}

static void
tree_table_adapter_set_value_at (ETableModel *etm,
                                 gint col,
                                 gint row,
                                 gconstpointer val)
{
    g_warn_if_reached ();
}

static gboolean
tree_table_adapter_is_cell_editable (ETableModel *etm,
                                     gint col,
                                     gint row)
{
    return FALSE;
}

static void
tree_table_adapter_append_row (ETableModel *etm,
                               ETableModel *source,
                               gint row)
{
}

static gpointer
tree_table_adapter_duplicate_value (ETableModel *etm,
                                    gint col,
                                    gconstpointer value)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    return e_tree_model_duplicate_value (etta->priv->source_model, col, value);
}

static void
tree_table_adapter_free_value (ETableModel *etm,
                               gint col,
                               gpointer value)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    e_tree_model_free_value (etta->priv->source_model, col, value);
}

static gpointer
tree_table_adapter_initialize_value (ETableModel *etm,
                                     gint col)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    return e_tree_model_initialize_value (etta->priv->source_model, col);
}

static gboolean
tree_table_adapter_value_is_empty (ETableModel *etm,
                                   gint col,
                                   gconstpointer value)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    return e_tree_model_value_is_empty (etta->priv->source_model, col, value);
}

static gchar *
tree_table_adapter_value_to_string (ETableModel *etm,
                                    gint col,
                                    gconstpointer value)
{
    ETreeTableAdapter *etta = (ETreeTableAdapter *) etm;

    return e_tree_model_value_to_string (etta->priv->source_model, col, value);
}

static void
e_tree_table_adapter_class_init (ETreeTableAdapterClass *class)
{
    GObjectClass *object_class;

    g_type_class_add_private (class, sizeof (ETreeTableAdapterPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->set_property = tree_table_adapter_set_property;
    object_class->get_property = tree_table_adapter_get_property;
    object_class->dispose = tree_table_adapter_dispose;
    object_class->finalize = tree_table_adapter_finalize;
    object_class->constructed = tree_table_adapter_constructed;

    g_object_class_install_property (
        object_class,
        PROP_HEADER,
        g_param_spec_object (
            "header",
            "Header",
            NULL,
            E_TYPE_TABLE_HEADER,
            G_PARAM_READWRITE |
            G_PARAM_CONSTRUCT_ONLY |
            G_PARAM_STATIC_STRINGS));

    g_object_class_install_property (
        object_class,
        PROP_SORT_INFO,
        g_param_spec_object (
            "sort-info",
            "Sort Info",
            NULL,
            E_TYPE_TABLE_SORT_INFO,
            G_PARAM_READWRITE |
            G_PARAM_CONSTRUCT |
            G_PARAM_STATIC_STRINGS));

    g_object_class_install_property (
        object_class,
        PROP_SOURCE_MODEL,
        g_param_spec_object (
            "source-model",
            "Source Model",
            NULL,
            E_TYPE_TREE_MODEL,
            G_PARAM_READWRITE |
            G_PARAM_CONSTRUCT_ONLY |
            G_PARAM_STATIC_STRINGS));

    signals[SORTING_CHANGED] = g_signal_new (
        "sorting_changed",
        G_OBJECT_CLASS_TYPE (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (ETreeTableAdapterClass, sorting_changed),
        NULL, NULL,
        e_marshal_BOOLEAN__NONE,
        G_TYPE_BOOLEAN, 0,
        G_TYPE_NONE);
}

static void
e_tree_table_adapter_table_model_init (ETableModelInterface *interface)
{
    interface->column_count = tree_table_adapter_column_count;
    interface->row_count = tree_table_adapter_row_count;
    interface->append_row = tree_table_adapter_append_row;

    interface->value_at = tree_table_adapter_value_at;
    interface->set_value_at = tree_table_adapter_set_value_at;
    interface->is_cell_editable = tree_table_adapter_is_cell_editable;

    interface->has_save_id = tree_table_adapter_has_save_id;
    interface->get_save_id = tree_table_adapter_get_save_id;

    interface->duplicate_value = tree_table_adapter_duplicate_value;
    interface->free_value = tree_table_adapter_free_value;
    interface->initialize_value = tree_table_adapter_initialize_value;
    interface->value_is_empty = tree_table_adapter_value_is_empty;
    interface->value_to_string = tree_table_adapter_value_to_string;
}

static void
e_tree_table_adapter_init (ETreeTableAdapter *etta)
{
    etta->priv = E_TREE_TABLE_ADAPTER_GET_PRIVATE (etta);

    etta->priv->nodes = g_hash_table_new (NULL, NULL);

    etta->priv->root_visible = TRUE;
    etta->priv->remap_needed = TRUE;
}

ETableModel *
e_tree_table_adapter_new (ETreeModel *source_model,
                          ETableSortInfo *sort_info,
                          ETableHeader *header)
{
    g_return_val_if_fail (E_IS_TREE_MODEL (source_model), NULL);

    if (sort_info != NULL)
        g_return_val_if_fail (E_IS_TABLE_SORT_INFO (sort_info), NULL);

    if (header != NULL)
        g_return_val_if_fail (E_IS_TABLE_HEADER (header), NULL);

    return g_object_new (
        E_TYPE_TREE_TABLE_ADAPTER,
        "source-model", source_model,
        "sort-info", sort_info,
        "header", header,
        NULL);
}

ETableHeader *
e_tree_table_adapter_get_header (ETreeTableAdapter *etta)
{
    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), NULL);

    return etta->priv->header;
}

ETableSortInfo *
e_tree_table_adapter_get_sort_info (ETreeTableAdapter *etta)
{
    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), NULL);

    return etta->priv->sort_info;
}

void
e_tree_table_adapter_set_sort_info (ETreeTableAdapter *etta,
                                    ETableSortInfo *sort_info)
{
    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    if (sort_info != NULL) {
        g_return_if_fail (E_IS_TABLE_SORT_INFO (sort_info));
        g_object_ref (sort_info);
    }

    if (etta->priv->sort_info != NULL) {
        g_signal_handler_disconnect (
            etta->priv->sort_info,
            etta->priv->sort_info_changed_handler_id);
        etta->priv->sort_info_changed_handler_id = 0;

        g_clear_object (&etta->priv->sort_info);
    }

    etta->priv->sort_info = sort_info;

    if (etta->priv->sort_info != NULL) {
        gulong handler_id;

        handler_id = g_signal_connect (
            etta->priv->sort_info, "sort_info_changed",
            G_CALLBACK (tree_table_adapter_sort_info_changed_cb),
            etta);
        etta->priv->sort_info_changed_handler_id = handler_id;
    }

    g_object_notify (G_OBJECT (etta), "sort-info");

    if (etta->priv->root == NULL)
        return;

    e_table_model_pre_change (E_TABLE_MODEL (etta));
    resort_node (etta, etta->priv->root, TRUE);
    fill_map (etta, 0, etta->priv->root);
    e_table_model_changed (E_TABLE_MODEL (etta));
}

ETreeModel *
e_tree_table_adapter_get_source_model (ETreeTableAdapter *etta)
{
    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), NULL);

    return etta->priv->source_model;
}

typedef struct {
    xmlNode *root;
    gboolean expanded_default;
    ETreeModel *model;
} TreeAndRoot;

static void
save_expanded_state_func (gpointer keyp,
                          gpointer value,
                          gpointer data)
{
    ETreePath path = keyp;
    node_t *node = ((GNode *) value)->data;
    TreeAndRoot *tar = data;
    xmlNode *xmlnode;

    if (node->expanded != tar->expanded_default) {
        gchar *save_id = e_tree_model_get_save_id (tar->model, path);
        xmlnode = xmlNewChild (tar->root, NULL, (const guchar *)"node", NULL);
        e_xml_set_string_prop_by_name (xmlnode, (const guchar *)"id", save_id);
        g_free (save_id);
    }
}

xmlDoc *
e_tree_table_adapter_save_expanded_state_xml (ETreeTableAdapter *etta)
{
    TreeAndRoot tar;
    xmlDocPtr doc;
    xmlNode *root;

    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), NULL);

    doc = xmlNewDoc ((const guchar *)"1.0");
    root = xmlNewDocNode (doc, NULL, (const guchar *)"expanded_state", NULL);
    xmlDocSetRootElement (doc, root);

    tar.model = etta->priv->source_model;
    tar.root = root;
    tar.expanded_default = e_tree_model_get_expanded_default (etta->priv->source_model);

    e_xml_set_integer_prop_by_name (root, (const guchar *)"vers", 2);
    e_xml_set_bool_prop_by_name (root, (const guchar *)"default", tar.expanded_default);

    g_hash_table_foreach (etta->priv->nodes, save_expanded_state_func, &tar);

    return doc;
}

void
e_tree_table_adapter_save_expanded_state (ETreeTableAdapter *etta,
                                          const gchar *filename)
{
    xmlDoc *doc;

    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    doc = e_tree_table_adapter_save_expanded_state_xml (etta);
    if (doc) {
        e_xml_save_file (filename, doc);
        xmlFreeDoc (doc);
    }
}

static xmlDoc *
open_file (ETreeTableAdapter *etta,
           const gchar *filename)
{
    xmlDoc *doc;
    xmlNode *root;
    gint vers;
    gboolean model_default, saved_default;

    if (!g_file_test (filename, G_FILE_TEST_EXISTS))
        return NULL;

#ifdef G_OS_WIN32
    {
        gchar *locale_filename = g_win32_locale_filename_from_utf8 (filename);
        doc = xmlParseFile (locale_filename);
        g_free (locale_filename);
    }
#else
    doc = xmlParseFile (filename);
#endif

    if (!doc)
        return NULL;

    root = xmlDocGetRootElement (doc);
    if (root == NULL || strcmp ((gchar *) root->name, "expanded_state")) {
        xmlFreeDoc (doc);
        return NULL;
    }

    vers = e_xml_get_integer_prop_by_name_with_default (root, (const guchar *)"vers", 0);
    if (vers > 2) {
        xmlFreeDoc (doc);
        return NULL;
    }
    model_default = e_tree_model_get_expanded_default (etta->priv->source_model);
    saved_default = e_xml_get_bool_prop_by_name_with_default (root, (const guchar *)"default", !model_default);
    if (saved_default != model_default) {
        xmlFreeDoc (doc);
        return NULL;
    }

    return doc;
}

/* state: <0 ... collapse;  0 ... use default; >0 ... expand */
void
e_tree_table_adapter_force_expanded_state (ETreeTableAdapter *etta,
                                           gint state)
{
    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    etta->priv->force_expanded_state = state;
}

void
e_tree_table_adapter_load_expanded_state_xml (ETreeTableAdapter *etta,
                                              xmlDoc *doc)
{
    xmlNode *root, *child;
    gboolean model_default;
    gboolean file_default = FALSE;

    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));
    g_return_if_fail (doc != NULL);

    root = xmlDocGetRootElement (doc);

    e_table_model_pre_change (E_TABLE_MODEL (etta));

    model_default = e_tree_model_get_expanded_default (etta->priv->source_model);

    if (!strcmp ((gchar *) root->name, "expanded_state")) {
        gchar *state;

        state = e_xml_get_string_prop_by_name_with_default (root, (const guchar *)"default", "");

        if (state[0] == 't')
            file_default = TRUE;
        else
            file_default = FALSE; /* Even unspecified we'll consider as false */

        g_free (state);
    }

    /* Incase the default is changed, lets forget the changes and stick to default */

    if (file_default != model_default) {
        xmlFreeDoc (doc);
        return;
    }

    for (child = root->xmlChildrenNode; child; child = child->next) {
        gchar *id;
        ETreePath path;

        if (strcmp ((gchar *) child->name, "node")) {
            d (g_warning ("unknown node '%s' in %s", child->name, filename));
            continue;
        }

        id = e_xml_get_string_prop_by_name_with_default (child, (const guchar *)"id", "");

        if (!strcmp (id, "")) {
            g_free (id);
            continue;
        }

        path = e_tree_model_get_node_by_id (etta->priv->source_model, id);
        if (path)
            e_tree_table_adapter_node_set_expanded (etta, path, !model_default);

        g_free (id);
    }

    e_table_model_changed (E_TABLE_MODEL (etta));
}

void
e_tree_table_adapter_load_expanded_state (ETreeTableAdapter *etta,
                                          const gchar *filename)
{
    xmlDoc *doc;

    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    doc = open_file (etta, filename);
    if (!doc)
        return;

    e_tree_table_adapter_load_expanded_state_xml  (etta, doc);

    xmlFreeDoc (doc);
}

void
e_tree_table_adapter_root_node_set_visible (ETreeTableAdapter *etta,
                                            gboolean visible)
{
    gint size;

    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    if (etta->priv->root_visible == visible)
        return;

    e_table_model_pre_change (E_TABLE_MODEL (etta));

    etta->priv->root_visible = visible;
    if (!visible) {
        ETreePath root = e_tree_model_get_root (etta->priv->source_model);
        if (root)
            e_tree_table_adapter_node_set_expanded (etta, root, TRUE);
    }
    size = (visible ? 1 : 0) + (etta->priv->root ? ((node_t *) etta->priv->root->data)->num_visible_children : 0);
    resize_map (etta, size);
    if (etta->priv->root)
        fill_map (etta, 0, etta->priv->root);
    e_table_model_changed (E_TABLE_MODEL (etta));
}

void
e_tree_table_adapter_node_set_expanded (ETreeTableAdapter *etta,
                                        ETreePath path,
                                        gboolean expanded)
{
    GNode *gnode;
    node_t *node;
    gint row;

    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    gnode = lookup_gnode (etta, path);

    if (!expanded && (!gnode || (e_tree_model_node_is_root (etta->priv->source_model, path) && !etta->priv->root_visible)))
        return;

    if (!gnode && expanded) {
        ETreePath parent = e_tree_model_node_get_parent (etta->priv->source_model, path);
        g_return_if_fail (parent != NULL);
        e_tree_table_adapter_node_set_expanded (etta, parent, expanded);
        gnode = lookup_gnode (etta, path);
    }
    g_return_if_fail (gnode != NULL);

    node = (node_t *) gnode->data;

    if (expanded == node->expanded)
        return;

    node->expanded = expanded;

    row = e_tree_table_adapter_row_of_node (etta, path);
    if (row == -1)
        return;

    e_table_model_pre_change (E_TABLE_MODEL (etta));
    e_table_model_pre_change (E_TABLE_MODEL (etta));
    e_table_model_row_changed (E_TABLE_MODEL (etta), row);

    if (expanded) {
        gint num_children = insert_children (etta, gnode);
        update_child_counts (gnode, num_children);
        if (etta->priv->sort_info && e_table_sort_info_sorting_get_count (etta->priv->sort_info) > 0)
            resort_node (etta, gnode, TRUE);
        resize_map (etta, etta->priv->n_map + num_children);
        move_map_elements (etta, row + 1 + num_children, row + 1, etta->priv->n_map - row - 1 - num_children);
        fill_map (etta, row, gnode);
        if (num_children != 0) {
            e_table_model_rows_inserted (E_TABLE_MODEL (etta), row + 1, num_children);
        } else
            e_table_model_no_change (E_TABLE_MODEL (etta));
    } else {
        gint num_children = delete_children (etta, gnode);
        if (num_children == 0) {
            e_table_model_no_change (E_TABLE_MODEL (etta));
            return;
        }
        move_map_elements (etta, row + 1, row + 1 + num_children, etta->priv->n_map - row - 1 - num_children);
        update_child_counts (gnode, - num_children);
        resize_map (etta, etta->priv->n_map - num_children);
        e_table_model_rows_deleted (E_TABLE_MODEL (etta), row + 1, num_children);
    }
}

void
e_tree_table_adapter_node_set_expanded_recurse (ETreeTableAdapter *etta,
                                                ETreePath path,
                                                gboolean expanded)
{
    ETreePath children;

    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    e_tree_table_adapter_node_set_expanded (etta, path, expanded);

    for (children = e_tree_model_node_get_first_child (etta->priv->source_model, path);
         children;
         children = e_tree_model_node_get_next (etta->priv->source_model, children)) {
        e_tree_table_adapter_node_set_expanded_recurse (etta, children, expanded);
    }
}

ETreePath
e_tree_table_adapter_node_at_row (ETreeTableAdapter *etta,
                                  gint row)
{
    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), NULL);

    if (row == -1 && etta->priv->n_map > 0)
        row = etta->priv->n_map - 1;
    else if (row < 0 || row >= etta->priv->n_map)
        return NULL;

    return etta->priv->map_table[row]->path;
}

gint
e_tree_table_adapter_row_of_node (ETreeTableAdapter *etta,
                                  ETreePath path)
{
    node_t *node;

    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), -1);

    node = get_node (etta, path);
    if (node == NULL)
        return -1;

    if (etta->priv->remap_needed)
        remap_indices (etta);

    return node->index;
}

gboolean
e_tree_table_adapter_root_node_is_visible (ETreeTableAdapter *etta)
{
    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), FALSE);

    return etta->priv->root_visible;
}

void
e_tree_table_adapter_show_node (ETreeTableAdapter *etta,
                                ETreePath path)
{
    ETreePath parent;

    g_return_if_fail (E_IS_TREE_TABLE_ADAPTER (etta));

    parent = e_tree_model_node_get_parent (etta->priv->source_model, path);

    while (parent) {
        e_tree_table_adapter_node_set_expanded (etta, parent, TRUE);
        parent = e_tree_model_node_get_parent (etta->priv->source_model, parent);
    }
}

gboolean
e_tree_table_adapter_node_is_expanded (ETreeTableAdapter *etta,
                                       ETreePath path)
{
    node_t *node;

    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), FALSE);

    node = get_node (etta, path);
    if (!e_tree_model_node_is_expandable (etta->priv->source_model, path) || !node)
        return FALSE;

    return node->expanded;
}

ETreePath
e_tree_table_adapter_node_get_next (ETreeTableAdapter *etta,
                                    ETreePath path)
{
    GNode *node;

    g_return_val_if_fail (E_IS_TREE_TABLE_ADAPTER (etta), NULL);

    node = lookup_gnode (etta, path);

    if (node && node->next)
        return ((node_t *) node->next->data)->path;

    return NULL;
}