Mercurial > pidgin
annotate src/value.h @ 9600:b7d851a6a098
[gaim-migrate @ 10443]
removed gaimrc.c
committer: Tailor Script <tailor@pidgin.im>
author | Herman Bloggs <hermanator12002@yahoo.com> |
---|---|
date | Mon, 26 Jul 2004 21:43:33 +0000 |
parents | 48c6552be372 |
children | af06746954de |
rev | line source |
---|---|
6562 | 1 /** |
2 * @file value.h Value wrapper API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
8046 | 7 * Gaim is the legal property of its developers, whose names are too numerous |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
6562 | 10 * |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GAIM_VALUE_H_ | |
26 #define _GAIM_VALUE_H_ | |
27 | |
6565
cb00e9647033
[gaim-migrate @ 7087]
Christian Hammond <chipx86@chipx86.com>
parents:
6563
diff
changeset
|
28 #include <glib.h> |
cb00e9647033
[gaim-migrate @ 7087]
Christian Hammond <chipx86@chipx86.com>
parents:
6563
diff
changeset
|
29 |
6562 | 30 /** |
31 * Specific value types. | |
32 */ | |
33 typedef enum | |
34 { | |
35 GAIM_TYPE_UNKNOWN = 0, /**< Unknown type. */ | |
36 GAIM_TYPE_SUBTYPE, /**< Subtype. */ | |
37 GAIM_TYPE_CHAR, /**< Character. */ | |
38 GAIM_TYPE_UCHAR, /**< Unsigned character. */ | |
39 GAIM_TYPE_BOOLEAN, /**< Boolean. */ | |
40 GAIM_TYPE_SHORT, /**< Short integer. */ | |
41 GAIM_TYPE_USHORT, /**< Unsigned short integer. */ | |
42 GAIM_TYPE_INT, /**< Integer. */ | |
43 GAIM_TYPE_UINT, /**< Unsigned integer. */ | |
44 GAIM_TYPE_LONG, /**< Long integer. */ | |
45 GAIM_TYPE_ULONG, /**< Unsigned long integer. */ | |
46 GAIM_TYPE_INT64, /**< 64-bit integer. */ | |
47 GAIM_TYPE_UINT64, /**< 64-bit unsigned integer. */ | |
48 GAIM_TYPE_STRING, /**< String. */ | |
49 GAIM_TYPE_OBJECT, /**< Object pointer. */ | |
50 GAIM_TYPE_POINTER, /**< Generic pointer. */ | |
51 GAIM_TYPE_ENUM, /**< Enum. */ | |
52 GAIM_TYPE_BOXED /**< Boxed pointer with specific type. */ | |
53 | |
54 } GaimType; | |
55 | |
56 /** | |
6563
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
57 * Gaim-specific subtype values. |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
58 */ |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
59 typedef enum |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
60 { |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
61 GAIM_SUBTYPE_UNKNOWN = 0, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
62 GAIM_SUBTYPE_ACCOUNT, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
63 GAIM_SUBTYPE_BLIST, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
64 GAIM_SUBTYPE_BLIST_BUDDY, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
65 GAIM_SUBTYPE_BLIST_GROUP, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
66 GAIM_SUBTYPE_BLIST_CHAT, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
67 GAIM_SUBTYPE_CONNECTION, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
68 GAIM_SUBTYPE_CONVERSATION, |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
69 GAIM_SUBTYPE_CONV_WINDOW, |
8817 | 70 GAIM_SUBTYPE_PLUGIN, |
71 GAIM_SUBTYPE_BLIST_NODE | |
6563
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
72 |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
73 } GaimSubType; |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
74 |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
75 /** |
6562 | 76 * A wrapper for a type, subtype, and specific type of value. |
77 */ | |
78 typedef struct | |
79 { | |
80 GaimType type; | |
81 unsigned short flags; | |
82 | |
83 union | |
84 { | |
85 char char_data; | |
86 unsigned char uchar_data; | |
87 gboolean boolean_data; | |
88 short short_data; | |
89 unsigned short ushort_data; | |
90 int int_data; | |
91 unsigned int uint_data; | |
92 long long_data; | |
93 unsigned long ulong_data; | |
94 gint64 int64_data; | |
95 guint64 uint64_data; | |
96 char *string_data; | |
97 void *object_data; | |
98 void *pointer_data; | |
99 int enum_data; | |
100 void *boxed_data; | |
101 | |
102 } data; | |
103 | |
104 union | |
105 { | |
106 unsigned int subtype; | |
107 char *specific_type; | |
108 | |
109 } u; | |
110 | |
111 } GaimValue; | |
112 | |
6563
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
113 #ifdef __cplusplus |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
114 extern "C" { |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
115 #endif |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
116 |
6562 | 117 /** |
118 * Creates a new GaimValue. | |
119 * | |
120 * This function takes a type and, depending on that type, a sub-type | |
121 * or specific type. | |
122 * | |
123 * If @a type is GAIM_TYPE_POINTER, the next parameter must be a | |
124 * string representing the specific type. | |
125 * | |
126 * If @a type is GAIM_TYPE_SUBTYPE, the next parameter must be a | |
127 * integer or enum representing the sub-type. | |
128 * | |
129 * If the subtype or specific type is not set when required, random | |
130 * errors may occur. You have been warned. | |
131 * | |
132 * @param type The type. | |
133 * | |
134 * @return The new value. | |
135 */ | |
136 GaimValue *gaim_value_new(GaimType type, ...); | |
137 | |
138 /** | |
139 * Creates a new outgoing GaimValue. | |
140 * | |
141 * This function takes a type and, depending on that type, a sub-type | |
142 * or specific type. | |
143 * | |
144 * If @a type is GAIM_TYPE_POINTER, the next parameter must be a | |
145 * string representing the specific type. | |
146 * | |
147 * If @a type is GAIM_TYPE_SUBTYPE, the next parameter must be a | |
148 * integer or enum representing the sub-type. | |
149 * | |
150 * If the sub-type or specific type is not set when required, random | |
151 * errors may occur. You have been warned. | |
152 * | |
153 * @param type The type. | |
154 * | |
155 * @return The new value. | |
156 */ | |
157 GaimValue *gaim_value_new_outgoing(GaimType type, ...); | |
158 | |
159 /** | |
160 * Destroys a GaimValue. | |
161 * | |
162 * @param value The value to destroy. | |
163 */ | |
164 void gaim_value_destroy(GaimValue *value); | |
165 | |
166 /** | |
8809
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
167 * Duplicated a GaimValue. |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
168 * |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
169 * @param value The value to duplicate. |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
170 * |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
171 * @return The duplicate value. |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
172 */ |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
173 GaimValue *gaim_value_dup(const GaimValue *value); |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
174 |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
175 /** |
6562 | 176 * Returns a value's type. |
177 * | |
178 * @return The value's type. | |
179 */ | |
180 GaimType gaim_value_get_type(const GaimValue *value); | |
181 | |
182 /** | |
183 * Returns a value's subtype. | |
184 * | |
185 * If the value's type is not GAIM_TYPE_SUBTYPE, this will return 0. | |
186 * Subtypes should never have a subtype of 0. | |
187 * | |
188 * @return The value's subtype, or 0 if @a type is not GAIM_TYPE_SUBTYPE. | |
189 */ | |
190 unsigned int gaim_value_get_subtype(const GaimValue *value); | |
191 | |
192 /** | |
193 * Returns a value's specific type. | |
194 * | |
195 * If the value's type is not GAIM_TYPE_BOXED, this will return @c NULL. | |
196 * | |
197 * @return The value's specific type, or @a NULL if not GAIM_TYPE_BOXED. | |
198 */ | |
199 const char *gaim_value_get_specific_type(const GaimValue *value); | |
200 | |
201 /** | |
202 * Returns whether or not the value is an outgoing value. | |
203 * | |
204 * @param value The value. | |
205 * | |
206 * @return TRUE if the value is outgoing, or FALSE otherwise. | |
207 */ | |
208 gboolean gaim_value_is_outgoing(const GaimValue *value); | |
209 | |
210 /** | |
211 * Sets the value's character data. | |
212 * | |
213 * @param value The value. | |
214 * @param data The character data. | |
215 */ | |
216 void gaim_value_set_char(GaimValue *value, char data); | |
217 | |
218 /** | |
219 * Sets the value's unsigned character data. | |
220 * | |
221 * @param value The value. | |
222 * @param data The unsigned character data. | |
223 */ | |
224 void gaim_value_set_uchar(GaimValue *value, unsigned char data); | |
225 | |
226 /** | |
227 * Sets the value's boolean data. | |
228 * | |
229 * @param value The value. | |
230 * @param data The boolean data. | |
231 */ | |
232 void gaim_value_set_boolean(GaimValue *value, gboolean data); | |
233 | |
234 /** | |
235 * Sets the value's short integer data. | |
236 * | |
237 * @param value The value. | |
238 * @param data The short integer data. | |
239 */ | |
240 void gaim_value_set_short(GaimValue *value, short data); | |
241 | |
242 /** | |
243 * Sets the value's unsigned short integer data. | |
244 * | |
245 * @param value The value. | |
246 * @param data The unsigned short integer data. | |
247 */ | |
248 void gaim_value_set_ushort(GaimValue *value, unsigned short data); | |
249 | |
250 /** | |
251 * Sets the value's integer data. | |
252 * | |
253 * @param value The value. | |
254 * @param data The integer data. | |
255 */ | |
256 void gaim_value_set_int(GaimValue *value, int data); | |
257 | |
258 /** | |
259 * Sets the value's unsigned integer data. | |
260 * | |
261 * @param value The value. | |
262 * @param data The unsigned integer data. | |
263 */ | |
264 void gaim_value_set_uint(GaimValue *value, unsigned int data); | |
265 | |
266 /** | |
267 * Sets the value's long integer data. | |
268 * | |
269 * @param value The value. | |
270 * @param data The long integer data. | |
271 */ | |
272 void gaim_value_set_long(GaimValue *value, long data); | |
273 | |
274 /** | |
275 * Sets the value's unsigned long integer data. | |
276 * | |
277 * @param value The value. | |
278 * @param data The unsigned long integer data. | |
279 */ | |
280 void gaim_value_set_ulong(GaimValue *value, unsigned long data); | |
281 | |
282 /** | |
283 * Sets the value's 64-bit integer data. | |
284 * | |
285 * @param value The value. | |
286 * @param data The 64-bit integer data. | |
287 */ | |
288 void gaim_value_set_int64(GaimValue *value, gint64 data); | |
289 | |
290 /** | |
291 * Sets the value's unsigned 64-bit integer data. | |
292 * | |
293 * @param value The value. | |
294 * @param data The unsigned 64-bit integer data. | |
295 */ | |
296 void gaim_value_set_uint64(GaimValue *value, guint64 data); | |
297 | |
298 /** | |
299 * Sets the value's string data. | |
300 * | |
301 * @param value The value. | |
302 * @param data The string data. | |
303 */ | |
304 void gaim_value_set_string(GaimValue *value, const char *data); | |
305 | |
306 /** | |
307 * Sets the value's object data. | |
308 * | |
309 * @param value The value. | |
310 * @param data The object data. | |
311 */ | |
312 void gaim_value_set_object(GaimValue *value, void *data); | |
313 | |
314 /** | |
315 * Sets the value's pointer data. | |
316 * | |
317 * @param value The value. | |
318 * @param data The pointer data. | |
319 */ | |
320 void gaim_value_set_pointer(GaimValue *value, void *data); | |
321 | |
322 /** | |
323 * Sets the value's enum data. | |
324 * | |
325 * @param value The value. | |
326 * @param data The enum data. | |
327 */ | |
328 void gaim_value_set_enum(GaimValue *value, int data); | |
329 | |
330 /** | |
331 * Sets the value's boxed data. | |
332 * | |
333 * @param value The value. | |
334 * @param data The boxed data. | |
335 */ | |
336 void gaim_value_set_boxed(GaimValue *value, void *data); | |
337 | |
338 /** | |
339 * Returns the value's character data. | |
340 * | |
341 * @param value The value. | |
342 * | |
343 * @return The character data. | |
344 */ | |
345 char gaim_value_get_char(const GaimValue *value); | |
346 | |
347 /** | |
348 * Returns the value's unsigned character data. | |
349 * | |
350 * @param value The value. | |
351 * | |
352 * @return The unsigned character data. | |
353 */ | |
354 unsigned char gaim_value_get_uchar(const GaimValue *value); | |
355 | |
356 /** | |
357 * Returns the value's boolean data. | |
358 * | |
359 * @param value The value. | |
360 * | |
361 * @return The boolean data. | |
362 */ | |
363 gboolean gaim_value_get_boolean(const GaimValue *value); | |
364 | |
365 /** | |
366 * Returns the value's short integer data. | |
367 * | |
368 * @param value The value. | |
369 * | |
370 * @return The short integer data. | |
371 */ | |
372 short gaim_value_get_short(const GaimValue *value); | |
373 | |
374 /** | |
375 * Returns the value's unsigned short integer data. | |
376 * | |
377 * @param value The value. | |
378 * | |
379 * @return The unsigned short integer data. | |
380 */ | |
381 unsigned short gaim_value_get_ushort(const GaimValue *value); | |
382 | |
383 /** | |
384 * Returns the value's integer data. | |
385 * | |
386 * @param value The value. | |
387 * | |
388 * @return The integer data. | |
389 */ | |
390 int gaim_value_get_int(const GaimValue *value); | |
391 | |
392 /** | |
393 * Returns the value's unsigned integer data. | |
394 * | |
395 * @param value The value. | |
396 * | |
397 * @return The unsigned integer data. | |
398 */ | |
399 unsigned int gaim_value_get_uint(const GaimValue *value); | |
400 | |
401 /** | |
402 * Returns the value's long integer data. | |
403 * | |
404 * @param value The value. | |
405 * | |
406 * @return The long integer data. | |
407 */ | |
408 long gaim_value_get_long(const GaimValue *value); | |
409 | |
410 /** | |
411 * Returns the value's unsigned long integer data. | |
412 * | |
413 * @param value The value. | |
414 * | |
415 * @return The unsigned long integer data. | |
416 */ | |
417 unsigned long gaim_value_get_ulong(const GaimValue *value); | |
418 | |
419 /** | |
420 * Returns the value's 64-bit integer data. | |
421 * | |
422 * @param value The value. | |
423 * | |
424 * @return The 64-bit integer data. | |
425 */ | |
426 gint64 gaim_value_get_int64(const GaimValue *value); | |
427 | |
428 /** | |
429 * Returns the value's unsigned 64-bit integer data. | |
430 * | |
431 * @param value The value. | |
432 * | |
433 * @return The unsigned 64-bit integer data. | |
434 */ | |
435 guint64 gaim_value_get_uint64(const GaimValue *value); | |
436 | |
437 /** | |
438 * Returns the value's string data. | |
439 * | |
440 * @param value The value. | |
441 * | |
442 * @return The string data. | |
443 */ | |
444 const char *gaim_value_get_string(const GaimValue *value); | |
445 | |
446 /** | |
447 * Returns the value's object data. | |
448 * | |
449 * @param value The value. | |
450 * | |
451 * @return The object data. | |
452 */ | |
453 void *gaim_value_get_object(const GaimValue *value); | |
454 | |
455 /** | |
456 * Returns the value's pointer data. | |
457 * | |
458 * @param value The value. | |
459 * | |
460 * @return The pointer data. | |
461 */ | |
462 void *gaim_value_get_pointer(const GaimValue *value); | |
463 | |
464 /** | |
465 * Returns the value's enum data. | |
466 * | |
467 * @param value The value. | |
468 * | |
469 * @return The enum data. | |
470 */ | |
471 int gaim_value_get_enum(const GaimValue *value); | |
472 | |
473 /** | |
474 * Returns the value's boxed data. | |
475 * | |
476 * @param value The value. | |
477 * | |
478 * @return The boxed data. | |
479 */ | |
480 void *gaim_value_get_boxed(const GaimValue *value); | |
481 | |
6563
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
482 #ifdef __cplusplus |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
483 } |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
484 #endif |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
485 |
6562 | 486 #endif /* _GAIM_VALUE_H_ */ |