aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-address.c
blob: 392b0a69f98774043b84f36a2462c097e1f93d6a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/*
 *  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);
}

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(IS_CAMEL_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(IS_CAMEL_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(IS_CAMEL_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(IS_CAMEL_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(IS_CAMEL_ADDRESS(dest), -1);
    g_return_val_if_fail(IS_CAMEL_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(IS_CAMEL_ADDRESS(dest), -1);
    g_return_val_if_fail(IS_CAMEL_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(IS_CAMEL_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);
    }
}