1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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 of the License, or (at your option) any later version.
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.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
24 #include "gasyncresult.h"
25 #include "gsimpleasyncresult.h"
27 #include "gloadableicon.h"
32 * SECTION:gloadableicon
33 * @short_description: Loadable Icons
35 * @see_also: #GIcon, #GThemedIcon
37 * Extends the #GIcon interface and adds the ability to
38 * load icons from streams.
41 static void g_loadable_icon_real_load_async (GLoadableIcon *icon,
43 GCancellable *cancellable,
44 GAsyncReadyCallback callback,
46 static GInputStream *g_loadable_icon_real_load_finish (GLoadableIcon *icon,
51 typedef GLoadableIconIface GLoadableIconInterface;
52 G_DEFINE_INTERFACE(GLoadableIcon, g_loadable_icon, G_TYPE_ICON)
55 g_loadable_icon_default_init (GLoadableIconIface *iface)
57 iface->load_async = g_loadable_icon_real_load_async;
58 iface->load_finish = g_loadable_icon_real_load_finish;
62 * g_loadable_icon_load:
63 * @icon: a #GLoadableIcon.
65 * @type: a location to store the type of the loaded icon, %NULL to ignore.
66 * @cancellable: optional #GCancellable object, %NULL to ignore.
67 * @error: a #GError location to store the error occuring, or %NULL to
70 * Loads a loadable icon. For the asynchronous version of this function,
71 * see g_loadable_icon_load_async().
73 * Returns: a #GInputStream to read the icon from.
76 g_loadable_icon_load (GLoadableIcon *icon,
79 GCancellable *cancellable,
82 GLoadableIconIface *iface;
84 g_return_val_if_fail (G_IS_LOADABLE_ICON (icon), NULL);
86 iface = G_LOADABLE_ICON_GET_IFACE (icon);
88 return (* iface->load) (icon, size, type, cancellable, error);
92 * g_loadable_icon_load_async:
93 * @icon: a #GLoadableIcon.
95 * @cancellable: optional #GCancellable object, %NULL to ignore.
96 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
97 * @user_data: the data to pass to callback function
99 * Loads an icon asynchronously. To finish this function, see
100 * g_loadable_icon_load_finish(). For the synchronous, blocking
101 * version of this function, see g_loadable_icon_load().
104 g_loadable_icon_load_async (GLoadableIcon *icon,
106 GCancellable *cancellable,
107 GAsyncReadyCallback callback,
110 GLoadableIconIface *iface;
112 g_return_if_fail (G_IS_LOADABLE_ICON (icon));
114 iface = G_LOADABLE_ICON_GET_IFACE (icon);
116 (* iface->load_async) (icon, size, cancellable, callback, user_data);
120 * g_loadable_icon_load_finish:
121 * @icon: a #GLoadableIcon.
122 * @res: a #GAsyncResult.
123 * @type: a location to store the type of the loaded icon, %NULL to ignore.
124 * @error: a #GError location to store the error occuring, or %NULL to
127 * Finishes an asynchronous icon load started in g_loadable_icon_load_async().
129 * Returns: a #GInputStream to read the icon from.
132 g_loadable_icon_load_finish (GLoadableIcon *icon,
137 GLoadableIconIface *iface;
139 g_return_val_if_fail (G_IS_LOADABLE_ICON (icon), NULL);
140 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
142 if (G_IS_SIMPLE_ASYNC_RESULT (res))
144 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
145 if (g_simple_async_result_propagate_error (simple, error))
149 iface = G_LOADABLE_ICON_GET_IFACE (icon);
151 return (* iface->load_finish) (icon, res, type, error);
154 /********************************************
155 * Default implementation of async load *
156 ********************************************/
161 GInputStream *stream;
165 load_data_free (LoadData *data)
168 g_object_unref (data->stream);
174 load_async_thread (GSimpleAsyncResult *res,
176 GCancellable *cancellable)
178 GLoadableIconIface *iface;
179 GInputStream *stream;
181 GError *error = NULL;
184 data = g_simple_async_result_get_op_res_gpointer (res);
186 iface = G_LOADABLE_ICON_GET_IFACE (object);
187 stream = iface->load (G_LOADABLE_ICON (object), data->size, &type, cancellable, &error);
191 g_simple_async_result_set_from_error (res, error);
192 g_error_free (error);
196 data->stream = stream;
204 g_loadable_icon_real_load_async (GLoadableIcon *icon,
206 GCancellable *cancellable,
207 GAsyncReadyCallback callback,
210 GSimpleAsyncResult *res;
213 res = g_simple_async_result_new (G_OBJECT (icon), callback, user_data, g_loadable_icon_real_load_async);
214 data = g_new0 (LoadData, 1);
215 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify) load_data_free);
216 g_simple_async_result_run_in_thread (res, load_async_thread, 0, cancellable);
217 g_object_unref (res);
220 static GInputStream *
221 g_loadable_icon_real_load_finish (GLoadableIcon *icon,
226 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
229 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_loadable_icon_real_load_async);
231 data = g_simple_async_result_get_op_res_gpointer (simple);
239 return g_object_ref (data->stream);