Mercurial > pidgin
annotate src/value.h @ 10539:5a50946954dd
[gaim-migrate @ 11900]
Merge some changes from oldstatus
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sun, 23 Jan 2005 20:32:07 +0000 |
parents | 5cb55bcad11b |
children | 72a5babfa8b4 |
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 * | |
10477 | 123 * If @a type is GAIM_TYPE_BOXED, the next parameter must be a |
6562 | 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 /** | |
10477 | 139 * Creates a new outgoing GaimValue. If a value is an "outgoing" value |
140 * it means the value can be modified by plugins and scripts. | |
6562 | 141 * |
142 * This function takes a type and, depending on that type, a sub-type | |
143 * or specific type. | |
144 * | |
10477 | 145 * If @a type is GAIM_TYPE_BOXED, the next parameter must be a |
6562 | 146 * string representing the specific type. |
147 * | |
148 * If @a type is GAIM_TYPE_SUBTYPE, the next parameter must be a | |
149 * integer or enum representing the sub-type. | |
150 * | |
151 * If the sub-type or specific type is not set when required, random | |
152 * errors may occur. You have been warned. | |
153 * | |
154 * @param type The type. | |
155 * | |
156 * @return The new value. | |
157 */ | |
158 GaimValue *gaim_value_new_outgoing(GaimType type, ...); | |
159 | |
160 /** | |
161 * Destroys a GaimValue. | |
162 * | |
163 * @param value The value to destroy. | |
164 */ | |
165 void gaim_value_destroy(GaimValue *value); | |
166 | |
167 /** | |
8809
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
168 * Duplicated a GaimValue. |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
169 * |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
170 * @param value The value to duplicate. |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
171 * |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
172 * @return The duplicate value. |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
173 */ |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
174 GaimValue *gaim_value_dup(const GaimValue *value); |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
175 |
fde4101fa183
[gaim-migrate @ 9571]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
176 /** |
6562 | 177 * Returns a value's type. |
178 * | |
10071 | 179 * @param value The value whose type you want. |
180 * | |
6562 | 181 * @return The value's type. |
182 */ | |
183 GaimType gaim_value_get_type(const GaimValue *value); | |
184 | |
185 /** | |
186 * Returns a value's subtype. | |
187 * | |
188 * If the value's type is not GAIM_TYPE_SUBTYPE, this will return 0. | |
189 * Subtypes should never have a subtype of 0. | |
190 * | |
10071 | 191 * @param value The value whose subtype you want. |
192 * | |
6562 | 193 * @return The value's subtype, or 0 if @a type is not GAIM_TYPE_SUBTYPE. |
194 */ | |
195 unsigned int gaim_value_get_subtype(const GaimValue *value); | |
196 | |
197 /** | |
198 * Returns a value's specific type. | |
199 * | |
200 * If the value's type is not GAIM_TYPE_BOXED, this will return @c NULL. | |
201 * | |
10071 | 202 * @param value The value whose specific type you want. |
203 * | |
6562 | 204 * @return The value's specific type, or @a NULL if not GAIM_TYPE_BOXED. |
205 */ | |
206 const char *gaim_value_get_specific_type(const GaimValue *value); | |
207 | |
208 /** | |
209 * Returns whether or not the value is an outgoing value. | |
210 * | |
211 * @param value The value. | |
212 * | |
213 * @return TRUE if the value is outgoing, or FALSE otherwise. | |
214 */ | |
215 gboolean gaim_value_is_outgoing(const GaimValue *value); | |
216 | |
217 /** | |
218 * Sets the value's character data. | |
219 * | |
220 * @param value The value. | |
221 * @param data The character data. | |
222 */ | |
223 void gaim_value_set_char(GaimValue *value, char data); | |
224 | |
225 /** | |
226 * Sets the value's unsigned character data. | |
227 * | |
228 * @param value The value. | |
229 * @param data The unsigned character data. | |
230 */ | |
231 void gaim_value_set_uchar(GaimValue *value, unsigned char data); | |
232 | |
233 /** | |
234 * Sets the value's boolean data. | |
235 * | |
236 * @param value The value. | |
237 * @param data The boolean data. | |
238 */ | |
239 void gaim_value_set_boolean(GaimValue *value, gboolean data); | |
240 | |
241 /** | |
242 * Sets the value's short integer data. | |
243 * | |
244 * @param value The value. | |
245 * @param data The short integer data. | |
246 */ | |
247 void gaim_value_set_short(GaimValue *value, short data); | |
248 | |
249 /** | |
250 * Sets the value's unsigned short integer data. | |
251 * | |
252 * @param value The value. | |
253 * @param data The unsigned short integer data. | |
254 */ | |
255 void gaim_value_set_ushort(GaimValue *value, unsigned short data); | |
256 | |
257 /** | |
258 * Sets the value's integer data. | |
259 * | |
260 * @param value The value. | |
261 * @param data The integer data. | |
262 */ | |
263 void gaim_value_set_int(GaimValue *value, int data); | |
264 | |
265 /** | |
266 * Sets the value's unsigned integer data. | |
267 * | |
268 * @param value The value. | |
269 * @param data The unsigned integer data. | |
270 */ | |
271 void gaim_value_set_uint(GaimValue *value, unsigned int data); | |
272 | |
273 /** | |
274 * Sets the value's long integer data. | |
275 * | |
276 * @param value The value. | |
277 * @param data The long integer data. | |
278 */ | |
279 void gaim_value_set_long(GaimValue *value, long data); | |
280 | |
281 /** | |
282 * Sets the value's unsigned long integer data. | |
283 * | |
284 * @param value The value. | |
285 * @param data The unsigned long integer data. | |
286 */ | |
287 void gaim_value_set_ulong(GaimValue *value, unsigned long data); | |
288 | |
289 /** | |
290 * Sets the value's 64-bit integer data. | |
291 * | |
292 * @param value The value. | |
293 * @param data The 64-bit integer data. | |
294 */ | |
295 void gaim_value_set_int64(GaimValue *value, gint64 data); | |
296 | |
297 /** | |
298 * Sets the value's unsigned 64-bit integer data. | |
299 * | |
300 * @param value The value. | |
301 * @param data The unsigned 64-bit integer data. | |
302 */ | |
303 void gaim_value_set_uint64(GaimValue *value, guint64 data); | |
304 | |
305 /** | |
306 * Sets the value's string data. | |
307 * | |
308 * @param value The value. | |
309 * @param data The string data. | |
310 */ | |
311 void gaim_value_set_string(GaimValue *value, const char *data); | |
312 | |
313 /** | |
314 * Sets the value's object data. | |
315 * | |
316 * @param value The value. | |
317 * @param data The object data. | |
318 */ | |
319 void gaim_value_set_object(GaimValue *value, void *data); | |
320 | |
321 /** | |
322 * Sets the value's pointer data. | |
323 * | |
324 * @param value The value. | |
325 * @param data The pointer data. | |
326 */ | |
327 void gaim_value_set_pointer(GaimValue *value, void *data); | |
328 | |
329 /** | |
330 * Sets the value's enum data. | |
331 * | |
332 * @param value The value. | |
333 * @param data The enum data. | |
334 */ | |
335 void gaim_value_set_enum(GaimValue *value, int data); | |
336 | |
337 /** | |
338 * Sets the value's boxed data. | |
339 * | |
340 * @param value The value. | |
341 * @param data The boxed data. | |
342 */ | |
343 void gaim_value_set_boxed(GaimValue *value, void *data); | |
344 | |
345 /** | |
346 * Returns the value's character data. | |
347 * | |
348 * @param value The value. | |
349 * | |
350 * @return The character data. | |
351 */ | |
352 char gaim_value_get_char(const GaimValue *value); | |
353 | |
354 /** | |
355 * Returns the value's unsigned character data. | |
356 * | |
357 * @param value The value. | |
358 * | |
359 * @return The unsigned character data. | |
360 */ | |
361 unsigned char gaim_value_get_uchar(const GaimValue *value); | |
362 | |
363 /** | |
364 * Returns the value's boolean data. | |
365 * | |
366 * @param value The value. | |
367 * | |
368 * @return The boolean data. | |
369 */ | |
370 gboolean gaim_value_get_boolean(const GaimValue *value); | |
371 | |
372 /** | |
373 * Returns the value's short integer data. | |
374 * | |
375 * @param value The value. | |
376 * | |
377 * @return The short integer data. | |
378 */ | |
379 short gaim_value_get_short(const GaimValue *value); | |
380 | |
381 /** | |
382 * Returns the value's unsigned short integer data. | |
383 * | |
384 * @param value The value. | |
385 * | |
386 * @return The unsigned short integer data. | |
387 */ | |
388 unsigned short gaim_value_get_ushort(const GaimValue *value); | |
389 | |
390 /** | |
391 * Returns the value's integer data. | |
392 * | |
393 * @param value The value. | |
394 * | |
395 * @return The integer data. | |
396 */ | |
397 int gaim_value_get_int(const GaimValue *value); | |
398 | |
399 /** | |
400 * Returns the value's unsigned integer data. | |
401 * | |
402 * @param value The value. | |
403 * | |
404 * @return The unsigned integer data. | |
405 */ | |
406 unsigned int gaim_value_get_uint(const GaimValue *value); | |
407 | |
408 /** | |
409 * Returns the value's long integer data. | |
410 * | |
411 * @param value The value. | |
412 * | |
413 * @return The long integer data. | |
414 */ | |
415 long gaim_value_get_long(const GaimValue *value); | |
416 | |
417 /** | |
418 * Returns the value's unsigned long integer data. | |
419 * | |
420 * @param value The value. | |
421 * | |
422 * @return The unsigned long integer data. | |
423 */ | |
424 unsigned long gaim_value_get_ulong(const GaimValue *value); | |
425 | |
426 /** | |
427 * Returns the value's 64-bit integer data. | |
428 * | |
429 * @param value The value. | |
430 * | |
431 * @return The 64-bit integer data. | |
432 */ | |
433 gint64 gaim_value_get_int64(const GaimValue *value); | |
434 | |
435 /** | |
436 * Returns the value's unsigned 64-bit integer data. | |
437 * | |
438 * @param value The value. | |
439 * | |
440 * @return The unsigned 64-bit integer data. | |
441 */ | |
442 guint64 gaim_value_get_uint64(const GaimValue *value); | |
443 | |
444 /** | |
445 * Returns the value's string data. | |
446 * | |
447 * @param value The value. | |
448 * | |
449 * @return The string data. | |
450 */ | |
451 const char *gaim_value_get_string(const GaimValue *value); | |
452 | |
453 /** | |
454 * Returns the value's object data. | |
455 * | |
456 * @param value The value. | |
457 * | |
458 * @return The object data. | |
459 */ | |
460 void *gaim_value_get_object(const GaimValue *value); | |
461 | |
462 /** | |
463 * Returns the value's pointer data. | |
464 * | |
465 * @param value The value. | |
466 * | |
467 * @return The pointer data. | |
468 */ | |
469 void *gaim_value_get_pointer(const GaimValue *value); | |
470 | |
471 /** | |
472 * Returns the value's enum data. | |
473 * | |
474 * @param value The value. | |
475 * | |
476 * @return The enum data. | |
477 */ | |
478 int gaim_value_get_enum(const GaimValue *value); | |
479 | |
480 /** | |
481 * Returns the value's boxed data. | |
482 * | |
483 * @param value The value. | |
484 * | |
485 * @return The boxed data. | |
486 */ | |
487 void *gaim_value_get_boxed(const GaimValue *value); | |
488 | |
6563
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
489 #ifdef __cplusplus |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
490 } |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
491 #endif |
122cb375be2d
[gaim-migrate @ 7085]
Christian Hammond <chipx86@chipx86.com>
parents:
6562
diff
changeset
|
492 |
6562 | 493 #endif /* _GAIM_VALUE_H_ */ |