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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-execpetion.c : exception utils */
/*
*
* Author :
* Bertrand Guiheneuf <Bertrand.Guiheneuf@aful.org>
*
* Copyright 1999, 2000 HelixCode (http://www.helixcode.com) .
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU 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 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
*/
#include <config.h>
#include "camel-exception.h"
/**
* camel_exception_new: allocate a new exception object.
*
* Create and returns a new exception object.
*
*
* Return value: The newly allocated exception object.
**/
CamelException *
camel_exception_new ()
{
CamelException *ex;
ex = g_new (CamelException, 1);
return ex;
}
/**
* camel_exception_clear: Clear an exception
* @exception: the exception object
*
* Clear an exception, that is, set the
* exception ID to CAMEL_EXCEPTION_NONE and
* free the description text.
* If the exception is NULL, this funtion just
* returns.
**/
void
camel_exception_clear (CamelException *exception)
{
if (!exception) return;
/* free the description text */
if (exception->desc)
g_free (exception->desc);
exception->desc = NULL;
/* set the Exception Id to NULL */
exception->id = CAMEL_EXCEPTION_NONE;
}
/**
* camel_exception_free: Free an exception
* @exception: The exception object to free
*
* Free an exception object. If the exception
* is NULL, nothing is done, the routine simply
* returns.
**/
void
camel_exception_free (CamelException *exception)
{
if (!exception) return;
/* free the description text */
if (exception->desc)
g_free (exception->desc);
/* free the exeption itself */
g_free (exception);
}
/**
* camel_exception_set: set an exception
* @ex: exception object
* @id: exception id
* @desc: textual description of the exception
*
* Set the value of an exception. The exception id is
* a unique number representing the exception. The
* textual description is a small text explaining
* what happened and provoked the exception.
*
* When @ex is NULL, nothing is done, this routine
* simply returns.
*
**/
void
camel_exception_set (CamelException *ex,
ExceptionId id,
const char *desc)
{
/* if no exception is given, do nothing */
if (!ex) return;
ex->id = id;
/* remove the previous exception description */
if (ex->desc)
g_free (ex->desc);
ex->desc = g_strdup (desc);
}
/**
* camel_exception_xfer: transfer an exception
* @ex_dst: Destination exception object
* @ex_src: Source exception object
*
* Transfer the content of an exception from
* an exception object to another.
* The destination exception receives the id and
* the description text of the source exception.
**/
void
camel_exception_xfer (CamelException *ex_dst,
CamelException *ex_src)
{
if (ex_dst->desc)
g_free (ex_dst->desc);
ex_dst->id = ex_src->id;
ex_dst->desc = ex_src->desc;
ex_src->desc = NULL;
ex_src->id = CAMEL_EXCEPTION_NONE;
}
/**
* camel_exception_get_id: get the exception id
* @ex: The exception object
*
* Return the id of an exception.
* If @ex is NULL, return CAMEL_EXCEPTION_NONE;
*
* Return value: Exception ID.
**/
ExceptionId
camel_exception_get_id (CamelException *ex)
{
if (ex)
return ex->id;
else
return CAMEL_EXCEPTION_NONE;
}
/**
* camel_exception_get_description: get the description of an exception.
* @ex: The exception object
*
* Return the exception description text.
* If @ex is NULL, return NULL;
*
*
* Return value: Exception description text.
**/
const gchar *
camel_exception_get_description (CamelException *ex)
{
if (ex)
return ex->desc;
else
return NULL;
}
|
