Initial version of GResource
[platform/upstream/glib.git] / gio / gresource.h
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 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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  */
22
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
26
27 #ifndef __G_RESOURCE_H__
28 #define __G_RESOURCE_H__
29
30 #include <gio/giotypes.h>
31
32 G_BEGIN_DECLS
33
34 /**
35  * G_TYPE_RESOURCE:
36  *
37  * The #GType for #GResource.
38  */
39 #define G_TYPE_RESOURCE (g_resource_get_type ())
40
41
42 /**
43  * G_RESOURCE_ERROR:
44  *
45  * Error domain for #GResource. Errors in this domain will be from the
46  * #GResourceError enumeration. See #GError for more information on
47  * error domains.
48  */
49 #define G_RESOURCE_ERROR (g_resource_error_quark ())
50 GQuark g_resource_error_quark (void);
51
52 GType         g_resource_get_type            (void) G_GNUC_CONST;
53 GResource *   g_resource_new_from_data       (GBytes                *data,
54                                               GError               **error);
55 GResource *   g_resource_ref                 (GResource             *resource);
56 void          g_resource_unref               (GResource             *resource);
57 GResource *   g_resource_load                (const gchar           *filename,
58                                               GError               **error);
59 GInputStream *g_resource_open_stream         (GResource             *resource,
60                                               const char            *path,
61                                               GResourceLookupFlags   lookup_flags,
62                                               GError               **error);
63 GBytes *      g_resource_lookup_data         (GResource             *resource,
64                                               const char            *path,
65                                               GResourceLookupFlags   lookup_flags,
66                                               GError               **error);
67 char **       g_resource_enumerate_children  (GResource             *resource,
68                                               const char            *path,
69                                               GResourceLookupFlags   lookup_flags,
70                                               GError               **error);
71 gboolean      g_resource_get_info            (GResource             *resource,
72                                               const char            *path,
73                                               GResourceLookupFlags   lookup_flags,
74                                               gsize                 *size,
75                                               guint32               *flags,
76                                               GError               **error);
77
78 void          g_resources_register           (GResource             *resource);
79 void          g_resources_unregister         (GResource             *resource);
80 GInputStream *g_resources_open_stream        (const char            *path,
81                                               GResourceLookupFlags   lookup_flags,
82                                               GError               **error);
83 GBytes *      g_resources_lookup_data        (const char            *path,
84                                               GResourceLookupFlags   lookup_flags,
85                                               GError               **error);
86 char **       g_resources_enumerate_children (const char            *path,
87                                               GResourceLookupFlags   lookup_flags,
88                                               GError               **error);
89 gboolean      g_resources_get_info           (const char            *path,
90                                               GResourceLookupFlags   lookup_flags,
91                                               gsize                 *size,
92                                               guint32               *flags,
93                                               GError               **error);
94
95
96 G_END_DECLS
97
98 #endif /* __G_RESOURCE_H__ */