Debian Codegraph @

lib/packagekit-glib2/pk-distro-upgrade.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-distro-upgrade
24 * @short_description: DistroUpgrade object
25 *
26 * This GObject represents a distro_upgrade 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-distro-upgrade.h>
36 #include <packagekit-glib2/pk-enum.h>
37 #include <packagekit-glib2/pk-enum-types.h>
38
39 static void pk_distro_upgrade_finalize (GObject *object);
40
41 /**
42 * PkDistroUpgradePrivate:
43 *
44 * Private #PkDistroUpgrade data
45 **/
46 struct _PkDistroUpgradePrivate
47 {
48 PkDistroUpgradeEnum state;
49 gchar *name;
50 gchar *summary;
51 };
52
53 enum {
54 PROP_0,
55 PROP_STATE,
56 PROP_NAME, /* FIXME: should be "ID" */
57 PROP_SUMMARY,
58 PROP_LAST
59 };
60
61 G_DEFINE_TYPE_WITH_PRIVATE (PkDistroUpgrade, pk_distro_upgrade, PK_TYPE_SOURCE)
62 #define GET_PRIVATE(o) (pk_distro_upgrade_get_instance_private (o))
63
64 /**
65 * pk_distro_upgrade_get_id:
66 * @distro_upgrade: a valid #PkDistroUpgrade object.
67 *
68 * Gets the distribution identifier.
69 * You use this value to call UpgradeSystem.
70 *
71 * Return value: the distro-id, e.g. "fedora-14"
72 *
73 * Since: 0.6.11
74 **/
75 const gchar *
76 pk_distro_upgrade_get_id (PkDistroUpgrade *distro_upgrade)
77 {
78 PkDistroUpgradePrivate *priv = GET_PRIVATE(distro_upgrade);
79
80 g_return_val_if_fail (PK_IS_DISTRO_UPGRADE (distro_upgrade), NULL);
81
82 return priv->name;
83 }
84
85 /**
86 * pk_distro_upgrade_get_summary:
87 * @distro_upgrade: a valid #PkDistroUpgrade object.
88 *
89 * Gets the description of the distribution upgrade.
90 *
91 * Return value: the printable name, e.g. "Fedora 14"
92 *
93 * Since: 0.6.11
94 **/
95 const gchar *
96 pk_distro_upgrade_get_summary (PkDistroUpgrade *distro_upgrade)
97 {
98 PkDistroUpgradePrivate *priv = GET_PRIVATE(distro_upgrade);
99
100 g_return_val_if_fail (PK_IS_DISTRO_UPGRADE (distro_upgrade), NULL);
101
102 return priv->summary;
103 }
104
105 /**
106 * pk_distro_upgrade_get_state:
107 * @distro_upgrade: a valid #PkDistroUpgrade object.
108 *
109 * Gets the status of the distribution upgrade.
110 *
111 * Return value: the printable name, e.g. %PK_DISTRO_UPGRADE_ENUM_UNSTABLE
112 *
113 * Since: 0.6.11
114 **/
115 PkDistroUpgradeEnum
116 pk_distro_upgrade_get_state (PkDistroUpgrade *distro_upgrade)
117 {
118 PkDistroUpgradePrivate *priv = GET_PRIVATE(distro_upgrade);
119
120 g_return_val_if_fail (PK_IS_DISTRO_UPGRADE (distro_upgrade), PK_DISTRO_UPGRADE_ENUM_UNKNOWN);
121
122 return priv->state;
123 }
124
125
126 /*
127 * pk_distro_upgrade_get_property:
128 **/
129 static void
130 pk_distro_upgrade_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
131 {
132 PkDistroUpgrade *distro_upgrade = PK_DISTRO_UPGRADE (object);
133 PkDistroUpgradePrivate *priv = GET_PRIVATE(distro_upgrade);
134
135 switch (prop_id) {
136 case PROP_STATE:
137 g_value_set_enum (value, priv->state);
138 break;
139 case PROP_NAME:
140 g_value_set_string (value, priv->name);
141 break;
142 case PROP_SUMMARY:
143 g_value_set_string (value, priv->summary);
144 break;
145 default:
146 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
147 break;
148 }
149 }
150
151 /*
152 * pk_distro_upgrade_set_property:
153 **/
154 static void
155 pk_distro_upgrade_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
156 {
157 PkDistroUpgrade *distro_upgrade = PK_DISTRO_UPGRADE (object);
158 PkDistroUpgradePrivate *priv = GET_PRIVATE(distro_upgrade);
159
160 switch (prop_id) {
161 case PROP_STATE:
162 priv->state = g_value_get_enum (value);
163 break;
164 case PROP_NAME:
165 g_free (priv->name);
166 priv->name = g_value_dup_string (value);
167 break;
168 case PROP_SUMMARY:
169 g_free (priv->summary);
170 priv->summary = g_value_dup_string (value);
171 break;
172 default:
173 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
174 break;
175 }
176 }
177
178 /*
179 * pk_distro_upgrade_class_init:
180 **/
181 static void
182 pk_distro_upgrade_class_init (PkDistroUpgradeClass *klass)
183 {
184 GParamSpec *pspec;
185 GObjectClass *object_class = G_OBJECT_CLASS (klass);
186 object_class->finalize = pk_distro_upgrade_finalize;
187 object_class->get_property = pk_distro_upgrade_get_property;
188 object_class->set_property = pk_distro_upgrade_set_property;
189
190 /**
191 * PkDistroUpgrade:state:
192 *
193 * Since: 0.5.4
194 */
195 pspec = g_param_spec_enum ("state", NULL, NULL,
196 PK_TYPE_DISTRO_UPGRADE_ENUM, PK_DISTRO_UPGRADE_ENUM_UNKNOWN,
197 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
198 g_object_class_install_property (object_class, PROP_STATE, pspec);
199
200 /**
201 * PkDistroUpgrade:name:
202 *
203 * Since: 0.5.4
204 */
205 pspec = g_param_spec_string ("name", NULL, NULL,
206 NULL,
207 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
208 g_object_class_install_property (object_class, PROP_NAME, pspec);
209
210 /**
211 * PkDistroUpgrade:summary:
212 *
213 * Since: 0.5.4
214 */
215 pspec = g_param_spec_string ("summary", NULL, NULL,
216 NULL,
217 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
218 g_object_class_install_property (object_class, PROP_SUMMARY, pspec);
219 }
220
221 /*
222 * pk_distro_upgrade_init:
223 **/
224 static void
225 pk_distro_upgrade_init (PkDistroUpgrade *distro_upgrade)
226 {
227 distro_upgrade->priv = GET_PRIVATE(distro_upgrade);
228 }
229
230 /*
231 * pk_distro_upgrade_finalize:
232 **/
233 static void
234 pk_distro_upgrade_finalize (GObject *object)
235 {
236 PkDistroUpgrade *distro_upgrade = PK_DISTRO_UPGRADE (object);
237 PkDistroUpgradePrivate *priv = GET_PRIVATE(distro_upgrade);
238
239 g_clear_pointer (&priv->name, g_free);
240 g_clear_pointer (&priv->summary, g_free);
241
242 G_OBJECT_CLASS (pk_distro_upgrade_parent_class)->finalize (object);
243 }
244
245 /**
246 * pk_distro_upgrade_new:
247 *
248 * Return value: a new #PkDistroUpgrade object.
249 *
250 * Since: 0.5.4
251 **/
252 PkDistroUpgrade *
253 pk_distro_upgrade_new (void)
254 {
255 PkDistroUpgrade *distro_upgrade;
256 distro_upgrade = g_object_new (PK_TYPE_DISTRO_UPGRADE, NULL);
257 return PK_DISTRO_UPGRADE (distro_upgrade);
258 }