/src/glib/gio/gfileicon.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* GIO - GLib Input, Output and Streaming Library |
2 | | * |
3 | | * Copyright (C) 2006-2007 Red Hat, Inc. |
4 | | * |
5 | | * This library is free software; you can redistribute it and/or |
6 | | * modify it under the terms of the GNU Lesser General Public |
7 | | * License as published by the Free Software Foundation; either |
8 | | * version 2.1 of the License, or (at your option) any later version. |
9 | | * |
10 | | * This library is distributed in the hope that it will be useful, |
11 | | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
13 | | * Lesser General Public License for more details. |
14 | | * |
15 | | * You should have received a copy of the GNU Lesser General |
16 | | * Public License along with this library; if not, see <http://www.gnu.org/licenses/>. |
17 | | * |
18 | | * Author: Alexander Larsson <alexl@redhat.com> |
19 | | */ |
20 | | |
21 | | #include "config.h" |
22 | | |
23 | | #include "gfileicon.h" |
24 | | #include "gfile.h" |
25 | | #include "gicon.h" |
26 | | #include "glibintl.h" |
27 | | #include "gloadableicon.h" |
28 | | #include "ginputstream.h" |
29 | | #include "gtask.h" |
30 | | #include "gioerror.h" |
31 | | |
32 | | |
33 | | /** |
34 | | * SECTION:gfileicon |
35 | | * @short_description: Icons pointing to an image file |
36 | | * @include: gio/gio.h |
37 | | * @see_also: #GIcon, #GLoadableIcon |
38 | | * |
39 | | * #GFileIcon specifies an icon by pointing to an image file |
40 | | * to be used as icon. |
41 | | * |
42 | | **/ |
43 | | |
44 | | static void g_file_icon_icon_iface_init (GIconIface *iface); |
45 | | static void g_file_icon_loadable_icon_iface_init (GLoadableIconIface *iface); |
46 | | static void g_file_icon_load_async (GLoadableIcon *icon, |
47 | | int size, |
48 | | GCancellable *cancellable, |
49 | | GAsyncReadyCallback callback, |
50 | | gpointer user_data); |
51 | | |
52 | | struct _GFileIcon |
53 | | { |
54 | | GObject parent_instance; |
55 | | |
56 | | GFile *file; |
57 | | }; |
58 | | |
59 | | struct _GFileIconClass |
60 | | { |
61 | | GObjectClass parent_class; |
62 | | }; |
63 | | |
64 | | enum |
65 | | { |
66 | | PROP_0, |
67 | | PROP_FILE |
68 | | }; |
69 | | |
70 | | G_DEFINE_TYPE_WITH_CODE (GFileIcon, g_file_icon, G_TYPE_OBJECT, |
71 | | G_IMPLEMENT_INTERFACE (G_TYPE_ICON, |
72 | | g_file_icon_icon_iface_init) |
73 | | G_IMPLEMENT_INTERFACE (G_TYPE_LOADABLE_ICON, |
74 | | g_file_icon_loadable_icon_iface_init)) |
75 | | |
76 | | static void |
77 | | g_file_icon_get_property (GObject *object, |
78 | | guint prop_id, |
79 | | GValue *value, |
80 | | GParamSpec *pspec) |
81 | 0 | { |
82 | 0 | GFileIcon *icon = G_FILE_ICON (object); |
83 | |
|
84 | 0 | switch (prop_id) |
85 | 0 | { |
86 | 0 | case PROP_FILE: |
87 | 0 | g_value_set_object (value, icon->file); |
88 | 0 | break; |
89 | | |
90 | 0 | default: |
91 | 0 | G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); |
92 | 0 | } |
93 | 0 | } |
94 | | |
95 | | static void |
96 | | g_file_icon_set_property (GObject *object, |
97 | | guint prop_id, |
98 | | const GValue *value, |
99 | | GParamSpec *pspec) |
100 | 0 | { |
101 | 0 | GFileIcon *icon = G_FILE_ICON (object); |
102 | |
|
103 | 0 | switch (prop_id) |
104 | 0 | { |
105 | 0 | case PROP_FILE: |
106 | 0 | icon->file = G_FILE (g_value_dup_object (value)); |
107 | 0 | break; |
108 | | |
109 | 0 | default: |
110 | 0 | G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); |
111 | 0 | } |
112 | 0 | } |
113 | | |
114 | | static void |
115 | | g_file_icon_constructed (GObject *object) |
116 | 0 | { |
117 | 0 | #ifndef G_DISABLE_ASSERT |
118 | 0 | GFileIcon *icon = G_FILE_ICON (object); |
119 | 0 | #endif |
120 | |
|
121 | 0 | G_OBJECT_CLASS (g_file_icon_parent_class)->constructed (object); |
122 | | |
123 | | /* Must have be set during construction */ |
124 | 0 | g_assert (icon->file != NULL); |
125 | 0 | } |
126 | | |
127 | | static void |
128 | | g_file_icon_finalize (GObject *object) |
129 | 0 | { |
130 | 0 | GFileIcon *icon; |
131 | |
|
132 | 0 | icon = G_FILE_ICON (object); |
133 | |
|
134 | 0 | if (icon->file) |
135 | 0 | g_object_unref (icon->file); |
136 | |
|
137 | 0 | G_OBJECT_CLASS (g_file_icon_parent_class)->finalize (object); |
138 | 0 | } |
139 | | |
140 | | static void |
141 | | g_file_icon_class_init (GFileIconClass *klass) |
142 | 0 | { |
143 | 0 | GObjectClass *gobject_class = G_OBJECT_CLASS (klass); |
144 | | |
145 | 0 | gobject_class->get_property = g_file_icon_get_property; |
146 | 0 | gobject_class->set_property = g_file_icon_set_property; |
147 | 0 | gobject_class->finalize = g_file_icon_finalize; |
148 | 0 | gobject_class->constructed = g_file_icon_constructed; |
149 | | |
150 | | /** |
151 | | * GFileIcon:file: |
152 | | * |
153 | | * The file containing the icon. |
154 | | */ |
155 | 0 | g_object_class_install_property (gobject_class, PROP_FILE, |
156 | 0 | g_param_spec_object ("file", |
157 | 0 | P_("file"), |
158 | 0 | P_("The file containing the icon"), |
159 | 0 | G_TYPE_FILE, |
160 | 0 | G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK)); |
161 | 0 | } |
162 | | |
163 | | static void |
164 | | g_file_icon_init (GFileIcon *file) |
165 | 0 | { |
166 | 0 | } |
167 | | |
168 | | /** |
169 | | * g_file_icon_new: |
170 | | * @file: a #GFile. |
171 | | * |
172 | | * Creates a new icon for a file. |
173 | | * |
174 | | * Returns: (transfer full) (type GFileIcon): a #GIcon for the given |
175 | | * @file, or %NULL on error. |
176 | | **/ |
177 | | GIcon * |
178 | | g_file_icon_new (GFile *file) |
179 | 0 | { |
180 | 0 | g_return_val_if_fail (G_IS_FILE (file), NULL); |
181 | | |
182 | 0 | return G_ICON (g_object_new (G_TYPE_FILE_ICON, "file", file, NULL)); |
183 | 0 | } |
184 | | |
185 | | /** |
186 | | * g_file_icon_get_file: |
187 | | * @icon: a #GIcon. |
188 | | * |
189 | | * Gets the #GFile associated with the given @icon. |
190 | | * |
191 | | * Returns: (transfer none): a #GFile. |
192 | | **/ |
193 | | GFile * |
194 | | g_file_icon_get_file (GFileIcon *icon) |
195 | 0 | { |
196 | 0 | g_return_val_if_fail (G_IS_FILE_ICON (icon), NULL); |
197 | | |
198 | 0 | return icon->file; |
199 | 0 | } |
200 | | |
201 | | static guint |
202 | | g_file_icon_hash (GIcon *icon) |
203 | 0 | { |
204 | 0 | GFileIcon *file_icon = G_FILE_ICON (icon); |
205 | |
|
206 | 0 | return g_file_hash (file_icon->file); |
207 | 0 | } |
208 | | |
209 | | static gboolean |
210 | | g_file_icon_equal (GIcon *icon1, |
211 | | GIcon *icon2) |
212 | 0 | { |
213 | 0 | GFileIcon *file1 = G_FILE_ICON (icon1); |
214 | 0 | GFileIcon *file2 = G_FILE_ICON (icon2); |
215 | | |
216 | 0 | return g_file_equal (file1->file, file2->file); |
217 | 0 | } |
218 | | |
219 | | static gboolean |
220 | | g_file_icon_to_tokens (GIcon *icon, |
221 | | GPtrArray *tokens, |
222 | | gint *out_version) |
223 | 0 | { |
224 | 0 | GFileIcon *file_icon = G_FILE_ICON (icon); |
225 | |
|
226 | 0 | g_return_val_if_fail (out_version != NULL, FALSE); |
227 | | |
228 | 0 | *out_version = 0; |
229 | |
|
230 | 0 | g_ptr_array_add (tokens, g_file_get_uri (file_icon->file)); |
231 | 0 | return TRUE; |
232 | 0 | } |
233 | | |
234 | | static GIcon * |
235 | | g_file_icon_from_tokens (gchar **tokens, |
236 | | gint num_tokens, |
237 | | gint version, |
238 | | GError **error) |
239 | 0 | { |
240 | 0 | GIcon *icon; |
241 | 0 | GFile *file; |
242 | |
|
243 | 0 | icon = NULL; |
244 | |
|
245 | 0 | if (version != 0) |
246 | 0 | { |
247 | 0 | g_set_error (error, |
248 | 0 | G_IO_ERROR, |
249 | 0 | G_IO_ERROR_INVALID_ARGUMENT, |
250 | 0 | _("Can’t handle version %d of GFileIcon encoding"), |
251 | 0 | version); |
252 | 0 | goto out; |
253 | 0 | } |
254 | | |
255 | 0 | if (num_tokens != 1) |
256 | 0 | { |
257 | 0 | g_set_error_literal (error, |
258 | 0 | G_IO_ERROR, |
259 | 0 | G_IO_ERROR_INVALID_ARGUMENT, |
260 | 0 | _("Malformed input data for GFileIcon")); |
261 | 0 | goto out; |
262 | 0 | } |
263 | | |
264 | 0 | file = g_file_new_for_uri (tokens[0]); |
265 | 0 | icon = g_file_icon_new (file); |
266 | 0 | g_object_unref (file); |
267 | |
|
268 | 0 | out: |
269 | 0 | return icon; |
270 | 0 | } |
271 | | |
272 | | static GVariant * |
273 | | g_file_icon_serialize (GIcon *icon) |
274 | 0 | { |
275 | 0 | GFileIcon *file_icon = G_FILE_ICON (icon); |
276 | |
|
277 | 0 | return g_variant_new ("(sv)", "file", g_variant_new_take_string (g_file_get_uri (file_icon->file))); |
278 | 0 | } |
279 | | |
280 | | static void |
281 | | g_file_icon_icon_iface_init (GIconIface *iface) |
282 | 0 | { |
283 | 0 | iface->hash = g_file_icon_hash; |
284 | 0 | iface->equal = g_file_icon_equal; |
285 | 0 | iface->to_tokens = g_file_icon_to_tokens; |
286 | 0 | iface->from_tokens = g_file_icon_from_tokens; |
287 | 0 | iface->serialize = g_file_icon_serialize; |
288 | 0 | } |
289 | | |
290 | | |
291 | | static GInputStream * |
292 | | g_file_icon_load (GLoadableIcon *icon, |
293 | | int size, |
294 | | char **type, |
295 | | GCancellable *cancellable, |
296 | | GError **error) |
297 | 0 | { |
298 | 0 | GFileInputStream *stream; |
299 | 0 | GFileIcon *file_icon = G_FILE_ICON (icon); |
300 | |
|
301 | 0 | stream = g_file_read (file_icon->file, |
302 | 0 | cancellable, |
303 | 0 | error); |
304 | |
|
305 | 0 | if (stream && type) |
306 | 0 | *type = NULL; |
307 | | |
308 | 0 | return G_INPUT_STREAM (stream); |
309 | 0 | } |
310 | | |
311 | | static void |
312 | | load_async_callback (GObject *source_object, |
313 | | GAsyncResult *res, |
314 | | gpointer user_data) |
315 | 0 | { |
316 | 0 | GFileInputStream *stream; |
317 | 0 | GError *error = NULL; |
318 | 0 | GTask *task = user_data; |
319 | |
|
320 | 0 | stream = g_file_read_finish (G_FILE (source_object), res, &error); |
321 | 0 | if (stream == NULL) |
322 | 0 | g_task_return_error (task, error); |
323 | 0 | else |
324 | 0 | g_task_return_pointer (task, stream, g_object_unref); |
325 | 0 | g_object_unref (task); |
326 | 0 | } |
327 | | |
328 | | static void |
329 | | g_file_icon_load_async (GLoadableIcon *icon, |
330 | | int size, |
331 | | GCancellable *cancellable, |
332 | | GAsyncReadyCallback callback, |
333 | | gpointer user_data) |
334 | 0 | { |
335 | 0 | GFileIcon *file_icon = G_FILE_ICON (icon); |
336 | 0 | GTask *task; |
337 | |
|
338 | 0 | task = g_task_new (icon, cancellable, callback, user_data); |
339 | 0 | g_task_set_source_tag (task, g_file_icon_load_async); |
340 | | |
341 | 0 | g_file_read_async (file_icon->file, 0, |
342 | 0 | cancellable, |
343 | 0 | load_async_callback, task); |
344 | 0 | } |
345 | | |
346 | | static GInputStream * |
347 | | g_file_icon_load_finish (GLoadableIcon *icon, |
348 | | GAsyncResult *res, |
349 | | char **type, |
350 | | GError **error) |
351 | 0 | { |
352 | 0 | g_return_val_if_fail (g_task_is_valid (res, icon), NULL); |
353 | | |
354 | 0 | if (type) |
355 | 0 | *type = NULL; |
356 | | |
357 | 0 | return g_task_propagate_pointer (G_TASK (res), error); |
358 | 0 | } |
359 | | |
360 | | static void |
361 | | g_file_icon_loadable_icon_iface_init (GLoadableIconIface *iface) |
362 | 0 | { |
363 | 0 | iface->load = g_file_icon_load; |
364 | 0 | iface->load_async = g_file_icon_load_async; |
365 | 0 | iface->load_finish = g_file_icon_load_finish; |
366 | 0 | } |