Debian Codegraph @

lib/packagekit-glib2/pk-details.c

raw
1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
2 *
3 * Copyright (C) 2009 Richard Hughes <[email protected]>
4 *
5 * Licensed under the GNU Lesser General Public License Version 2.1
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 /**
23 * SECTION:pk-details
24 * @short_description: Details object
25 *
26 * This GObject represents a details from a transaction.
27 * These objects represent single items of data from the transaction, and are
28 * often present in lists (#PkResults) or just refcounted in client programs.
29 */
30
31 #include "config.h"
32
33 #include <glib-object.h>
34
35 #include <packagekit-glib2/pk-details.h>
36 #include <packagekit-glib2/pk-enum-types.h>
37
38 static void pk_details_finalize (GObject *object);
39
40 /**
41 * PkDetailsPrivate:
42 *
43 * Private #PkDetails data
44 **/
45 struct _PkDetailsPrivate
46 {
47 gchar *package_id;
48 gchar *license;
49 PkGroupEnum group;
50 gchar *description;
51 gchar *url;
52 gchar *summary;
53 guint64 size;
54 guint64 download_size;
55 };
56
57 enum {
58 PROP_0,
59 PROP_PACKAGE_ID,
60 PROP_LICENSE,
61 PROP_GROUP,
62 PROP_DESCRIPTION,
63 PROP_URL,
64 PROP_SIZE,
65 PROP_SUMMARY,
66 PROP_DOWNLOAD_SIZE,
67 PROP_LAST
68 };
69
70 G_DEFINE_TYPE_WITH_PRIVATE (PkDetails, pk_details, PK_TYPE_SOURCE)
71 #define GET_PRIVATE(o) (pk_details_get_instance_private (o))
72
73 /**
74 * pk_details_get_package_id:
75 * @details: a #PkDetails instance
76 *
77 * Gets the PackageId for the details object.
78 *
79 * Return value: string value
80 *
81 * Since: 0.8.12
82 **/
83 const gchar *
84 pk_details_get_package_id (PkDetails *details)
85 {
86 PkDetailsPrivate *priv = GET_PRIVATE(details);
87
88 g_return_val_if_fail (details != NULL, NULL);
89
90 return priv->package_id;
91 }
92
93 /**
94 * pk_details_get_license:
95 * @details: a #PkDetails instance
96 *
97 * Gets the license for the details object.
98 *
99 * Return value: string value
100 *
101 * Since: 0.8.12
102 **/
103 const gchar *
104 pk_details_get_license (PkDetails *details)
105 {
106 PkDetailsPrivate *priv = GET_PRIVATE(details);
107
108 g_return_val_if_fail (details != NULL, NULL);
109
110 return priv->license;
111 }
112
113 /**
114 * pk_details_get_group:
115 * @details: a #PkDetails instance
116 *
117 * Gets the group for the details object.
118 *
119 * Return value: string value
120 *
121 * Since: 0.8.12
122 **/
123 PkGroupEnum
124 pk_details_get_group (PkDetails *details)
125 {
126 PkDetailsPrivate *priv = GET_PRIVATE(details);
127
128 g_return_val_if_fail (details != NULL, PK_GROUP_ENUM_UNKNOWN);
129
130 return priv->group;
131 }
132
133 /**
134 * pk_details_get_description:
135 * @details: a #PkDetails instance
136 *
137 * Gets the description for the details object.
138 *
139 * Return value: string value
140 *
141 * Since: 0.8.12
142 **/
143 const gchar *
144 pk_details_get_description (PkDetails *details)
145 {
146 PkDetailsPrivate *priv = GET_PRIVATE(details);
147
148 g_return_val_if_fail (details != NULL, NULL);
149
150 return priv->description;
151 }
152
153 /**
154 * pk_details_get_url:
155 * @details: a #PkDetails instance
156 *
157 * Gets the url for the details object.
158 *
159 * Return value: string value
160 *
161 * Since: 0.8.12
162 **/
163 const gchar *
164 pk_details_get_url (PkDetails *details)
165 {
166 PkDetailsPrivate *priv = GET_PRIVATE(details);
167
168 g_return_val_if_fail (details != NULL, NULL);
169
170 return priv->url;
171 }
172
173 /**
174 * pk_details_get_summary:
175 * @details: a #PkDetails instance
176 *
177 * Gets the summary for the details object.
178 *
179 * Return value: string value
180 *
181 * Since: 0.9.1
182 **/
183 const gchar *
184 pk_details_get_summary (PkDetails *details)
185 {
186 PkDetailsPrivate *priv = GET_PRIVATE(details);
187
188 g_return_val_if_fail (details != NULL, NULL);
189
190 return priv->summary;
191 }
192
193 /**
194 * pk_details_get_size:
195 * @details: a #PkDetails instance
196 *
197 * Gets the size for the details object: for installed packages it will return
198 * the installed size, for the rest the package size.
199 *
200 * Return value: string value
201 *
202 * Since: 0.8.12
203 **/
204 guint64
205 pk_details_get_size (PkDetails *details)
206 {
207 PkDetailsPrivate *priv = GET_PRIVATE(details);
208
209 g_return_val_if_fail (details != NULL, G_MAXUINT64);
210
211 return priv->size;
212 }
213
214 /**
215 * pk_details_get_download_size:
216 * @details: a #PkDetails instance
217 *
218 * Gets the package download size.
219 *
220 * Returns: the package download size, 0 if already downloaded and G_MAXUINT64 when unknown
221 *
222 * Since: 1.2.4
223 **/
224 guint64
225 pk_details_get_download_size (PkDetails *details)
226 {
227 PkDetailsPrivate *priv = GET_PRIVATE(details);
228
229 g_return_val_if_fail (details != NULL, G_MAXUINT64);
230
231 return priv->download_size;
232 }
233
234 /*
235 * pk_details_get_property:
236 **/
237 static void
238 pk_details_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
239 {
240 PkDetails *details = PK_DETAILS (object);
241 PkDetailsPrivate *priv = GET_PRIVATE(details);
242
243 switch (prop_id) {
244 case PROP_PACKAGE_ID:
245 g_value_set_string (value, priv->package_id);
246 break;
247 case PROP_LICENSE:
248 g_value_set_string (value, priv->license);
249 break;
250 case PROP_GROUP:
251 g_value_set_enum (value, priv->group);
252 break;
253 case PROP_DESCRIPTION:
254 g_value_set_string (value, priv->description);
255 break;
256 case PROP_URL:
257 g_value_set_string (value, priv->url);
258 break;
259 case PROP_SIZE:
260 g_value_set_uint64 (value, priv->size);
261 break;
262 case PROP_SUMMARY:
263 g_value_set_string (value, priv->summary);
264 break;
265 case PROP_DOWNLOAD_SIZE:
266 g_value_set_uint64 (value, priv->download_size);
267 break;
268 default:
269 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
270 break;
271 }
272 }
273
274 /*
275 * pk_details_set_property:
276 **/
277 static void
278 pk_details_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
279 {
280 PkDetails *details = PK_DETAILS (object);
281 PkDetailsPrivate *priv = GET_PRIVATE(details);
282
283 switch (prop_id) {
284 case PROP_PACKAGE_ID:
285 g_free (priv->package_id);
286 priv->package_id = g_strdup (g_value_get_string (value));
287 break;
288 case PROP_LICENSE:
289 g_free (priv->license);
290 priv->license = g_strdup (g_value_get_string (value));
291 break;
292 case PROP_GROUP:
293 priv->group = g_value_get_enum (value);
294 break;
295 case PROP_DESCRIPTION:
296 g_free (priv->description);
297 priv->description = g_strdup (g_value_get_string (value));
298 break;
299 case PROP_URL:
300 g_free (priv->url);
301 priv->url = g_strdup (g_value_get_string (value));
302 break;
303 case PROP_SUMMARY:
304 g_free (priv->summary);
305 priv->summary = g_strdup (g_value_get_string (value));
306 break;
307 case PROP_SIZE:
308 priv->size = g_value_get_uint64 (value);
309 break;
310 case PROP_DOWNLOAD_SIZE:
311 priv->download_size = g_value_get_uint64 (value);
312 break;
313 default:
314 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
315 break;
316 }
317 }
318
319 /*
320 * pk_details_class_init:
321 **/
322 static void
323 pk_details_class_init (PkDetailsClass *klass)
324 {
325 GParamSpec *pspec;
326 GObjectClass *object_class = G_OBJECT_CLASS (klass);
327 object_class->finalize = pk_details_finalize;
328 object_class->get_property = pk_details_get_property;
329 object_class->set_property = pk_details_set_property;
330
331 /**
332 * PkDetails:package-id:
333 *
334 * Since: 0.5.4
335 */
336 pspec = g_param_spec_string ("package-id", NULL, NULL,
337 NULL,
338 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
339 g_object_class_install_property (object_class, PROP_PACKAGE_ID, pspec);
340
341 /**
342 * PkDetails:license:
343 *
344 * Since: 0.5.4
345 */
346 pspec = g_param_spec_string ("license", NULL, NULL,
347 NULL,
348 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
349 g_object_class_install_property (object_class, PROP_LICENSE, pspec);
350
351 /**
352 * PkDetails:group:
353 *
354 * Since: 0.5.4
355 */
356 pspec = g_param_spec_enum ("group", NULL, NULL,
357 PK_TYPE_GROUP_ENUM, PK_GROUP_ENUM_UNKNOWN,
358 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
359 g_object_class_install_property (object_class, PROP_GROUP, pspec);
360
361 /**
362 * PkDetails:description:
363 *
364 * Since: 0.5.4
365 */
366 pspec = g_param_spec_string ("description", NULL, NULL,
367 NULL,
368 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
369 g_object_class_install_property (object_class, PROP_DESCRIPTION, pspec);
370
371 /**
372 * PkDetails:url:
373 *
374 * Since: 0.5.4
375 */
376 pspec = g_param_spec_string ("url", NULL, NULL,
377 NULL,
378 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
379 g_object_class_install_property (object_class, PROP_URL, pspec);
380
381 /**
382 * PkDetails:size:
383 *
384 * Since: 0.5.4
385 */
386 pspec = g_param_spec_uint64 ("size", NULL, NULL,
387 0, G_MAXUINT64, 0,
388 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
389 g_object_class_install_property (object_class, PROP_SIZE, pspec);
390
391 /**
392 * PkDetails:summary:
393 *
394 * Since: 0.9.1
395 */
396 pspec = g_param_spec_string ("summary", NULL, NULL,
397 NULL,
398 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
399 g_object_class_install_property (object_class, PROP_SUMMARY, pspec);
400
401 /**
402 * PkDetails:download-size:
403 *
404 * Since: 1.2.4
405 */
406 pspec = g_param_spec_uint64 ("download-size", NULL, NULL,
407 0, G_MAXUINT64, G_MAXUINT64,
408 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
409 g_object_class_install_property (object_class, PROP_DOWNLOAD_SIZE, pspec);
410 }
411
412 /*
413 * pk_details_init:
414 **/
415 static void
416 pk_details_init (PkDetails *details)
417 {
418 PkDetailsPrivate *priv = GET_PRIVATE(details);
419
420 details->priv = priv;
421 priv->download_size = G_MAXUINT64;
422 }
423
424 /*
425 * pk_details_finalize:
426 **/
427 static void
428 pk_details_finalize (GObject *object)
429 {
430 PkDetails *details = PK_DETAILS (object);
431 PkDetailsPrivate *priv = GET_PRIVATE(details);
432
433 g_clear_pointer (&priv->package_id, g_free);
434 g_clear_pointer (&priv->license, g_free);
435 g_clear_pointer (&priv->description, g_free);
436 g_clear_pointer (&priv->url, g_free);
437 g_clear_pointer (&priv->summary, g_free);
438
439 G_OBJECT_CLASS (pk_details_parent_class)->finalize (object);
440 }
441
442 /**
443 * pk_details_new:
444 *
445 * Return value: a new #PkDetails object.
446 *
447 * Since: 0.5.4
448 **/
449 PkDetails *
450 pk_details_new (void)
451 {
452 PkDetails *details;
453 details = g_object_new (PK_TYPE_DETAILS, NULL);
454 return PK_DETAILS (details);
455 }