path: root/widgets/table/e-table-state.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * e-table-state.c
 * Copyright 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Chris Lahey <clahey@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

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

#include <libxml/parser.h>
#include <libxml/xmlmemory.h>
#include "gal/util/e-util.h"
#include "gal/util/e-xml-utils.h"
#include "e-table-state.h"


#define STATE_VERSION 0.1

static GObjectClass *etst_parent_class;

static void
etst_dispose (GObject *object)
{
    ETableState *etst = E_TABLE_STATE (object);

    if (etst->sort_info) {
        g_object_unref (etst->sort_info);
        etst->sort_info = NULL;
    }

    G_OBJECT_CLASS (etst_parent_class)->dispose (object);
}
    
static void
etst_finalize (GObject *object)
{
    ETableState *etst = E_TABLE_STATE (object);

    if (etst->columns) {
        g_free (etst->columns);
        etst->columns = NULL;
    }

    if (etst->expansions) {
        g_free (etst->expansions);
        etst->expansions = NULL;
    }
    
    G_OBJECT_CLASS (etst_parent_class)->finalize (object);
}

static void
etst_class_init (GObjectClass *klass)
{
    etst_parent_class = g_type_class_peek_parent (klass);
    
    klass->dispose = etst_dispose;
    klass->finalize = etst_finalize;
}

static void
etst_init (ETableState *state)
{
    state->columns = NULL;
    state->expansions = NULL;
    state->sort_info = e_table_sort_info_new();
}

E_MAKE_TYPE(e_table_state, "ETableState", ETableState, etst_class_init, etst_init, G_TYPE_OBJECT)

ETableState *
e_table_state_new (void)
{
    return (ETableState *) g_object_new (E_TABLE_STATE_TYPE, NULL);
}

ETableState *
e_table_state_vanilla (int col_count)
{
    GString *str;
    int i;
    ETableState *res;

    str = g_string_new ("<ETableState>\n");
    for (i = 0; i < col_count; i++)
        g_string_append_printf (str, "  <column source=\"%d\"/>\n", i);
    g_string_append (str, "  <grouping></grouping>\n");
    g_string_append (str, "</ETableState>\n");

    res = e_table_state_new ();
    e_table_state_load_from_string (res, str->str);

    g_string_free (str, TRUE);
    return res;
}

gboolean
e_table_state_load_from_file    (ETableState *state,
                 const char          *filename)
{
    xmlDoc *doc;

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

    doc = xmlParseFile (filename);
    if (doc) {
        xmlNode *node = xmlDocGetRootElement(doc);
        e_table_state_load_from_node(state, node);
        xmlFreeDoc(doc);
        return TRUE;
    }
    return FALSE;
}

void 
e_table_state_load_from_string  (ETableState *state,
                 const char          *xml)
{
    xmlDoc *doc;
    doc = xmlParseMemory ((char *) xml, strlen(xml));
    if (doc) {
        xmlNode *node = xmlDocGetRootElement(doc);
        e_table_state_load_from_node(state, node);
        xmlFreeDoc(doc);
    }
}

typedef struct {
    int column;
    double expansion;
} int_and_double;

void
e_table_state_load_from_node (ETableState *state,
                  const xmlNode *node)
{
    xmlNode *children;
    GList *list = NULL, *iterator;
    gdouble state_version;
    int i;

    state_version = e_xml_get_double_prop_by_name_with_default (
        node, "state-version", STATE_VERSION);

    if (state->sort_info)
        g_object_unref (state->sort_info);

    state->sort_info = NULL;
    children = node->xmlChildrenNode;
    for (; children; children = children->next) {
        if (!strcmp (children->name, "column")) {
            int_and_double *column_info = g_new(int_and_double, 1);

            column_info->column = e_xml_get_integer_prop_by_name(
                children, "source");
            column_info->expansion =
                e_xml_get_double_prop_by_name_with_default(
                    children, "expansion", 1);

            list = g_list_append (list, column_info);
        } else if (state->sort_info == NULL &&
               !strcmp (children->name, "grouping")) {
            state->sort_info = e_table_sort_info_new();
            e_table_sort_info_load_from_node(
                state->sort_info, children, state_version);
        }
    }
    g_free(state->columns);
    g_free(state->expansions);
    state->col_count = g_list_length(list);
    state->columns = g_new(int, state->col_count);
    state->expansions = g_new(double, state->col_count);

    for (iterator = list, i = 0; iterator; i++) {
        int_and_double *column_info = iterator->data;
        
        state->columns [i] = column_info->column;
        state->expansions [i] = column_info->expansion;
        g_free (column_info);
        iterator = g_list_next (iterator);
    }
    g_list_free(list);
}

void
e_table_state_save_to_file      (ETableState *state,
                 const char          *filename)
{
    xmlDoc *doc;
    
    if ((doc = xmlNewDoc ("1.0")) == NULL)
        return;
    
    xmlDocSetRootElement (doc, e_table_state_save_to_node (state, NULL));
    
    e_xml_save_file (filename, doc);
    
    xmlFreeDoc (doc);
}

char *
e_table_state_save_to_string    (ETableState *state)
{
    char *ret_val;
    xmlChar *string;
    int length;
    xmlDoc *doc;

    doc = xmlNewDoc("1.0");
    xmlDocSetRootElement(doc, e_table_state_save_to_node(state, NULL));
    xmlDocDumpMemory(doc, &string, &length);
    xmlFreeDoc(doc);

    ret_val = g_strdup(string);
    xmlFree(string);
    return ret_val;
}

xmlNode *
e_table_state_save_to_node      (ETableState *state,
                 xmlNode     *parent)
{
    int i;
    xmlNode *node;

    if (parent)
        node = xmlNewChild (parent, NULL, "ETableState", NULL);
    else
        node = xmlNewNode (NULL, "ETableState");

    e_xml_set_double_prop_by_name(node, "state-version", STATE_VERSION);

    for (i = 0; i < state->col_count; i++) {
        int column = state->columns[i];
        double expansion = state->expansions[i];
        xmlNode *new_node;

        new_node = xmlNewChild(node, NULL, "column", NULL);
        e_xml_set_integer_prop_by_name (new_node, "source", column);
        if (expansion >= -1)
            e_xml_set_double_prop_by_name(new_node, "expansion", expansion);
    }


    e_table_sort_info_save_to_node(state->sort_info, node);

    return node;
}

/**
 * e_table_state_duplicate:
 * @state: The ETableState to duplicate
 *
 * This creates a copy of the %ETableState @state
 *
 * Returns: The duplicated %ETableState.
 */
ETableState *
e_table_state_duplicate (ETableState *state)
{
    ETableState *new_state;
    char *copy;
    
    g_return_val_if_fail (state != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_STATE (state), NULL);

    new_state = e_table_state_new ();
    copy = e_table_state_save_to_string (state);
    e_table_state_load_from_string (new_state, copy);
    g_free (copy);

    e_table_sort_info_set_can_group
        (new_state->sort_info,
         e_table_sort_info_get_can_group (state->sort_info));

    return new_state;
}