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
|
/**
* @file object.h MSNObject API
*
* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _MSN_OBJECT_H_
#define _MSN_OBJECT_H_
#include "imgstore.h"
#include "internal.h"
typedef enum
{
MSN_OBJECT_UNKNOWN = -1, /**< Unknown object */
MSN_OBJECT_RESERVED1 = 1, /**< Reserved */
MSN_OBJECT_EMOTICON = 2, /**< Custom Emoticon */
MSN_OBJECT_USERTILE = 3, /**< UserTile (buddy icon) */
MSN_OBJECT_RESERVED2 = 4, /**< Reserved */
MSN_OBJECT_BACKGROUND = 5 /**< Background */
} MsnObjectType;
typedef struct
{
gboolean local;
char *creator;
int size;
MsnObjectType type;
PurpleStoredImage *img;
char *location;
char *friendly;
char *sha1d;
char *sha1c;
} MsnObject;
/**
* Creates a MsnObject structure.
*
* @return A new MsnObject structure.
*/
MsnObject *msn_object_new(void);
/**
* Creates a MsnObject structure from a string.
*
* @param str The string.
*
* @return The new MsnObject structure.
*/
MsnObject *msn_object_new_from_string(const char *str);
/**
* Destroys an MsnObject structure.
*
* @param obj The object structure.
*/
void msn_object_destroy(MsnObject *obj);
/**
* Outputs a string representation of an MsnObject.
*
* @param obj The object.
*
* @return The string representation. This must be freed.
*/
char *msn_object_to_string(const MsnObject *obj);
/**
* Sets the creator field in a MsnObject.
*
* @param creator The creator value.
*/
void msn_object_set_creator(MsnObject *obj, const char *creator);
/**
* Sets the size field in a MsnObject.
*
* @param size The size value.
*/
void msn_object_set_size(MsnObject *obj, int size);
/**
* Sets the type field in a MsnObject.
*
* @param type The type value.
*/
void msn_object_set_type(MsnObject *obj, MsnObjectType type);
/**
* Sets the location field in a MsnObject.
*
* @param location The location value.
*/
void msn_object_set_location(MsnObject *obj, const char *location);
/**
* Sets the friendly name field in a MsnObject.
*
* @param friendly The friendly name value.
*/
void msn_object_set_friendly(MsnObject *obj, const char *friendly);
/**
* Sets the SHA1D field in a MsnObject.
*
* @param sha1d The sha1d value.
*/
void msn_object_set_sha1d(MsnObject *obj, const char *sha1d);
/**
* Sets the SHA1C field in a MsnObject.
*
* @param sha1c The sha1c value.
*/
void msn_object_set_sha1c(MsnObject *obj, const char *sha1c);
/**
* Associates an image with a MsnObject.
*
* @param obj The object.
* @param img The image to associate.
*/
void msn_object_set_image(MsnObject *obj, PurpleStoredImage *img);
/**
* Returns a MsnObject's creator value.
*
* @param obj The object.
*
* @return The creator value.
*/
const char *msn_object_get_creator(const MsnObject *obj);
/**
* Returns a MsnObject's size value.
*
* @param obj The object.
*
* @return The size value.
*/
int msn_object_get_size(const MsnObject *obj);
/**
* Returns a MsnObject's type.
*
* @param obj The object.
*
* @return The object type.
*/
MsnObjectType msn_object_get_type(const MsnObject *obj);
/**
* Returns a MsnObject's location value.
*
* @param obj The object.
*
* @return The location value.
*/
const char *msn_object_get_location(const MsnObject *obj);
/**
* Returns a MsnObject's friendly name value.
*
* @param obj The object.
*
* @return The friendly name value.
*/
const char *msn_object_get_friendly(const MsnObject *obj);
/**
* Returns a MsnObject's SHA1D value.
*
* @param obj The object.
*
* @return The SHA1D value.
*/
const char *msn_object_get_sha1d(const MsnObject *obj);
/**
* Returns a MsnObject's SHA1C value.
*
* @param obj The object.
*
* @return The SHA1C value.
*/
const char *msn_object_get_sha1c(const MsnObject *obj);
/**
* Returns a MsnObject's SHA1C value if it exists, otherwise SHA1D.
*
* @param obj The object.
*
* @return The SHA1C value.
*/
const char *msn_object_get_sha1(const MsnObject *obj);
/**
* Returns the image associated with the MsnObject.
*
* @param obj The object.
*
* @return The associated image.
*/
PurpleStoredImage *msn_object_get_image(const MsnObject *obj);
void msn_object_set_local(MsnObject *obj);
#endif /* _MSN_OBJECT_H_ */
|
