path: root/camel/camel-address.c

/*
 *  Copyright (C) 2000 Helix Code Inc.
 *
 *  Authors: Michael Zucchi <notzed@helixcode.com>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public License
 *  as published by the Free Software Foundation; either version 2 of
 *  the License, or (at your option) any later version.
 *
 *  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 Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include "camel-address.h"


static void camel_address_class_init (CamelAddressClass *klass);
static void camel_address_init       (CamelAddress *obj);
static void camel_address_finalize   (CamelObject *obj);

static CamelObjectClass *camel_address_parent;

static void
camel_address_class_init (CamelAddressClass *klass)
{
    camel_address_parent = camel_type_get_global_classfuncs (camel_object_get_type ());
}

static void
camel_address_init (CamelAddress *obj)
{
    obj->addresses = g_ptr_array_new();
}

static void
camel_address_finalize (CamelObject *obj)
{
    camel_address_remove((CamelAddress *)obj, -1);
    g_ptr_array_free(((CamelAddress *)obj)->addresses, TRUE);
}

CamelType
camel_address_get_type (void)
{
    static CamelType type = CAMEL_INVALID_TYPE;
    
    if (type == CAMEL_INVALID_TYPE) {
        type = camel_type_register (camel_object_get_type (), "CamelAddress",
                        sizeof (CamelAddress),
                        sizeof (CamelAddressClass),
                        (CamelObjectClassInitFunc) camel_address_class_init,
                        NULL,
                        (CamelObjectInitFunc) camel_address_init,
                        (CamelObjectFinalizeFunc) camel_address_finalize);
    }
    
    return type;
}

/**
 * camel_address_new:
 *
 * Create a new CamelAddress object.
 * 
 * Return value: A new CamelAddress widget.
 **/
CamelAddress *
camel_address_new (void)
{
    CamelAddress *new = CAMEL_ADDRESS(camel_object_new(camel_address_get_type()));
    return new;
}

/**
 * camel_address_new_clone:
 * @in: 
 * 
 * Clone an existing address type.
 * 
 * Return value: 
 **/
CamelAddress *
camel_address_new_clone(const CamelAddress *in)
{
    CamelAddress *new = CAMEL_ADDRESS(camel_object_new(CAMEL_OBJECT_GET_TYPE(in)));

    camel_address_cat(new, in);
    return new;
}

/**
 * camel_address_length:
 * @a: 
 * 
 * Return the number of addresses stored in the address @a.
 * 
 * Return value: 
 **/
int
camel_address_length(CamelAddress *a)
{
    return a->addresses->len;
}

/**
 * camel_address_decode:
 * @a: An address.
 * @raw: Raw address description.
 * 
 * Construct a new address from a raw address field.
 * 
 * Return value: Returns the number of addresses found,
 * or -1 if the addresses could not be parsed fully.
 **/
int
camel_address_decode    (CamelAddress *a, const char *raw)
{
    g_return_val_if_fail(CAMEL_IS_ADDRESS(a), -1);

    return CAMEL_ADDRESS_CLASS (CAMEL_OBJECT_GET_CLASS (a))->decode(a, raw);
}

/**
 * camel_address_encode:
 * @a: 
 * 
 * Encode an address in a format suitable for a raw header.
 * 
 * Return value: The encoded address.
 **/
char *
camel_address_encode    (CamelAddress *a)
{
    g_return_val_if_fail(CAMEL_IS_ADDRESS(a), NULL);

    return CAMEL_ADDRESS_CLASS (CAMEL_OBJECT_GET_CLASS (a))->encode(a);
}

/**
 * camel_address_unformat:
 * @a: 
 * @raw: 
 * 
 * Attempt to convert a previously formatted and/or edited
 * address back into internal form.
 * 
 * Return value: -1 if it could not be parsed, or the number
 * of valid addresses found.
 **/
int
camel_address_unformat(CamelAddress *a, const char *raw)
{
    g_return_val_if_fail(CAMEL_IS_ADDRESS(a), -1);

    return CAMEL_ADDRESS_CLASS (CAMEL_OBJECT_GET_CLASS (a))->unformat(a, raw);
}

/**
 * camel_address_format:
 * @a: 
 * 
 * Format an address in a format suitable for display.
 * 
 * Return value: The formatted address.
 **/
char *
camel_address_format    (CamelAddress *a)
{
    if (a == NULL)
        return NULL;

    g_return_val_if_fail(CAMEL_IS_ADDRESS(a), NULL);

    return CAMEL_ADDRESS_CLASS (CAMEL_OBJECT_GET_CLASS (a))->format(a);
}

/**
 * camel_address_cat:
 * @dest: 
 * @source: 
 * 
 * Concatenate one address onto another.  The addresses must
 * be of the same type.
 * 
 * Return value: 
 **/
int
camel_address_cat   (CamelAddress *dest, const CamelAddress *source)
{
    g_return_val_if_fail(CAMEL_IS_ADDRESS(dest), -1);
    g_return_val_if_fail(CAMEL_IS_ADDRESS(source), -1);

    return CAMEL_ADDRESS_CLASS(CAMEL_OBJECT_GET_CLASS(dest))->cat(dest, source);
}

/**
 * camel_address_copy:
 * @dest: 
 * @source: 
 * 
 * Copy an address contents.
 * 
 * Return value: 
 **/
int
camel_address_copy  (CamelAddress *dest, const CamelAddress *source)
{
    g_return_val_if_fail(CAMEL_IS_ADDRESS(dest), -1);
    g_return_val_if_fail(CAMEL_IS_ADDRESS(source), -1);

    camel_address_remove(dest, -1);
    return camel_address_cat(dest, source);
}

/**
 * camel_address_remove:
 * @a: 
 * @index: The address to remove, use -1 to remove all address.
 * 
 * Remove an address by index, or all addresses.
 **/
void
camel_address_remove    (CamelAddress *a, int index)
{
    g_return_if_fail(CAMEL_IS_ADDRESS(a));

    if (index == -1) {
        for (index=a->addresses->len; index>-1; index--)
            CAMEL_ADDRESS_CLASS (CAMEL_OBJECT_GET_CLASS (a))->remove(a, index);
    } else {
        CAMEL_ADDRESS_CLASS (CAMEL_OBJECT_GET_CLASS (a))->remove(a, index);
    }
}