path: root/filter/filter-element.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 *  Copyright (C) 2000 Ximian Inc.
 *
 *  Authors: Not Zed <notzed@lostzed.mmc.com.au>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; 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 <string.h>
#include <stdlib.h>
#include <gtk/gtktypeutils.h>

#include "filter-element.h"
#include "filter-input.h"
#include "filter-option.h"
#include "filter-code.h"
#include "filter-colour.h"
#include "filter-datespec.h"
#include "filter-int.h"
#include "filter-folder.h"
#include "filter-source.h"
#include "filter-file.h"
#include "filter-label.h"


static gboolean validate (FilterElement *fe);
static int element_eq(FilterElement *fe, FilterElement *cm);
static void xml_create(FilterElement *fe, xmlNodePtr node);
static FilterElement *clone(FilterElement *fe);

static void filter_element_class_init   (FilterElementClass *class);
static void filter_element_init (FilterElement *gspaper);
static void filter_element_finalise (GtkObject *obj);

static GtkObjectClass *parent_class;

enum {
    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

GtkType
filter_element_get_type (void)
{
    static GtkType type = 0;
    
    if (!type) {
        GtkTypeInfo type_info = {
            "FilterElement",
            sizeof(FilterElement),
            sizeof(FilterElementClass),
            (GtkClassInitFunc)filter_element_class_init,
            (GtkObjectInitFunc)filter_element_init,
            (GtkArgSetFunc)NULL,
            (GtkArgGetFunc)NULL
        };
        
        type = gtk_type_unique(gtk_object_get_type (), &type_info);
    }
    
    return type;
}

static void
filter_element_class_init (FilterElementClass *class)
{
    GtkObjectClass *object_class;
    
    object_class = (GtkObjectClass *)class;
    parent_class = gtk_type_class (gtk_object_get_type ());

    object_class->finalize = filter_element_finalise;

    /* override methods */
    class->validate = validate;
    class->eq = element_eq;
    class->xml_create = xml_create;
    class->clone = clone;

    /* signals */

    gtk_object_class_add_signals (object_class, signals, LAST_SIGNAL);
}

static void
filter_element_init (FilterElement *o)
{
    ;
}

static void
filter_element_finalise (GtkObject *obj)
{
    FilterElement *o = (FilterElement *)obj;

    xmlFree(o->name);

        ((GtkObjectClass *)(parent_class))->finalize(obj);
}

/**
 * filter_element_new:
 *
 * Create a new FilterElement object.
 * 
 * Return value: A new #FilterElement object.
 **/
FilterElement *
filter_element_new (void)
{
    FilterElement *o = (FilterElement *)gtk_type_new(filter_element_get_type ());
    return o;
}

gboolean
filter_element_validate (FilterElement *fe)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->validate (fe);
}

int
filter_element_eq(FilterElement *fe, FilterElement *cm)
{
    return ((GtkObject *)fe)->klass == ((GtkObject *)cm)->klass
        && ((FilterElementClass *)((GtkObject *)fe)->klass)->eq(fe, cm);
}

/**
 * filter_element_xml_create:
 * @fe: filter element
 * @node: xml node
 * 
 * Create a new filter element based on an xml definition of
 * that element.
 **/
void
filter_element_xml_create (FilterElement *fe, xmlNodePtr node)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->xml_create(fe, node);
}

/**
 * filter_element_xml_encode:
 * @fe: filter element
 * 
 * Encode the values of a filter element into xml format.
 * 
 * Return value: 
 **/
xmlNodePtr
filter_element_xml_encode (FilterElement *fe)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->xml_encode(fe);
}

/**
 * filter_element_xml_decode:
 * @fe: filter element
 * @node: xml node
 * 
 * Decode the values of a fitler element from xml format.
 * 
 * Return value: 
 **/
int
filter_element_xml_decode (FilterElement *fe, xmlNodePtr node)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->xml_decode(fe, node);
}

/**
 * filter_element_clone:
 * @fe: filter element
 * 
 * Clones the FilterElement @fe.
 * 
 * Return value: 
 **/
FilterElement *
filter_element_clone (FilterElement *fe)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->clone(fe);
}

/**
 * filter_element_get_widget:
 * @fe: filter element
 * @node: xml node
 * 
 * Create a widget to represent this element.
 * 
 * Return value: 
 **/
GtkWidget *
filter_element_get_widget (FilterElement *fe)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->get_widget(fe);
}

/**
 * filter_element_build_code:
 * @fe: filter element
 * @out: output buffer
 * @ff: 
 * 
 * Add the code representing this element to the output string @out.
 **/
void
filter_element_build_code (FilterElement *fe, GString *out, struct _FilterPart *ff)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->build_code(fe, out, ff);
}

/**
 * filter_element_format_sexp:
 * @fe: filter element
 * @out: output buffer
 * 
 * Format the value(s) of this element in a method suitable for the context of
 * sexp where it is used.  Usually as space separated, double-quoted strings.
 **/
void
filter_element_format_sexp (FilterElement *fe, GString *out)
{
    return ((FilterElementClass *)((GtkObject *)fe)->klass)->format_sexp(fe, out);
}

/**
 * filter_element_new_type_name:
 * @type: filter element type
 * 
 * Create a new filter element based on its type name.
 * 
 * Return value: 
 **/
FilterElement *
filter_element_new_type_name (const char *type)
{
    if (type == NULL)
        return NULL;

    if (!strcmp (type, "string")) {
        return (FilterElement *)filter_input_new ();
    } else if (!strcmp (type, "folder")) {
        return (FilterElement *)filter_folder_new ();
    } else if (!strcmp (type, "address")) {
        /* FIXME: temporary ... need real address type */
        return (FilterElement *)filter_input_new_type_name (type);
    } else if (!strcmp (type, "code")) {
        return (FilterElement *)filter_code_new ();
    } else if (!strcmp (type, "colour")) {
        return (FilterElement *)filter_colour_new ();
    } else if (!strcmp (type, "optionlist") || !strcmp (type, "system-flag")) {
        return (FilterElement *)filter_option_new ();
    } else if (!strcmp (type, "datespec")) {
        return (FilterElement *)filter_datespec_new ();
    } else if (!strcmp (type, "score")) {
        return (FilterElement *)filter_int_new_type("score", -3, 3);
    } else if (!strcmp (type, "integer")) {
        return (FilterElement *)filter_int_new ();
    } else if (!strcmp (type, "regex")) {
        return (FilterElement *)filter_input_new_type_name (type);
    } else if (!strcmp (type, "source")) {
                return (FilterElement *)filter_source_new ();
    } else if (!strcmp (type, "command")) {
        return (FilterElement *) filter_file_new_type_name (type);
    } else if (!strcmp (type, "file")) {
        return (FilterElement *) filter_file_new_type_name (type);
    } else if (!strcmp (type, "label")) {
        return (FilterElement *) filter_label_new ();
    } else {
        g_warning("Unknown filter type '%s'", type);
        return 0;
    }
}

void
filter_element_set_data (FilterElement *fe, gpointer data)
{
    fe->data = data;
}

/* default implementations */
static gboolean
validate (FilterElement *fe)
{
    return TRUE;
}

static int
element_eq(FilterElement *fe, FilterElement *cm)
{
    return ((fe->name && cm->name && strcmp(fe->name, cm->name) == 0)
        || (fe->name == NULL && cm->name == NULL));
}

static void
xml_create (FilterElement *fe, xmlNodePtr node)
{
    fe->name = xmlGetProp (node, "name");
}

static FilterElement *
clone (FilterElement *fe)
{
    xmlNodePtr node;
    FilterElement *new;

    new = (FilterElement *)gtk_type_new (GTK_OBJECT (fe)->klass->type);
    node = filter_element_xml_encode (fe);
    filter_element_xml_decode (new, node);
    xmlFreeNodeList (node);
    
    return new;
}

/* only copies the value, not the name/type */
void
filter_element_copy_value(FilterElement *de, FilterElement *se)
{
    /* bit of a hack, but saves having to do the same in each type ? */

    if (IS_FILTER_INPUT(se)) {
        if (IS_FILTER_INPUT(de)) {
            if (((FilterInput *)se)->values)
                filter_input_set_value((FilterInput*)de, ((FilterInput *)se)->values->data);
        } else if (IS_FILTER_INT(de)) {
            ((FilterInt *)de)->val = atoi((char *) ((FilterInput *)se)->values->data);
        }
    } else if (IS_FILTER_FOLDER(se)) {
        if (IS_FILTER_FOLDER(de)) {
            filter_folder_set_value((FilterFolder *)de, ((FilterFolder *)se)->uri);
        }
    } else if (IS_FILTER_COLOUR(se)) {
        if (IS_FILTER_COLOUR(de)) {
            FilterColour *s = (FilterColour *)se, *d = (FilterColour *)de;

            d->r = s->r;
            d->g = s->g;
            d->b = s->b;
            d->a = s->a;
        }
    } else if (IS_FILTER_DATESPEC(se)) {
        if (IS_FILTER_DATESPEC(de)) {
            FilterDatespec *s = (FilterDatespec *)se, *d = (FilterDatespec *)de;

            d->type = s->type;
            d->value = s->value;
        }
    } else if (IS_FILTER_INT(se)) {
        if (IS_FILTER_INT(de)) {
            FilterInt *s = (FilterInt *)se, *d = (FilterInt *)de;

            d->val = s->val;
        } else if (IS_FILTER_INPUT(de)) {
            FilterInt *s = (FilterInt *)se;
            FilterInput *d = (FilterInput *)de;
            char *v;

            v = g_strdup_printf("%d", s->val);
            filter_input_set_value(d, v);
            g_free(v);
        }
    } else if (IS_FILTER_OPTION(se)) {
        if (IS_FILTER_OPTION(de)) {
            FilterOption *s = (FilterOption *)se, *d = (FilterOption *)de;

            if (s->current)
                filter_option_set_current(d, s->current->value);
        }
    }
}