1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
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
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Author: Alexander Larsson <alexl@redhat.com>
21 */
22
23#ifndef __G_IO_MODULE_H__
24#define __G_IO_MODULE_H__
25
26#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27#error "Only <gio/gio.h> can be included directly."
28#endif
29
30#include <gio/giotypes.h>
31#include <gmodule.h>
32
33G_BEGIN_DECLS
34
35typedef struct _GIOModuleScope GIOModuleScope;
36
37GIO_AVAILABLE_IN_2_30
38GIOModuleScope * g_io_module_scope_new (GIOModuleScopeFlags flags);
39GIO_AVAILABLE_IN_2_30
40void g_io_module_scope_free (GIOModuleScope *scope);
41GIO_AVAILABLE_IN_2_30
42void g_io_module_scope_block (GIOModuleScope *scope,
43 const gchar *basename);
44
45#define G_IO_TYPE_MODULE (g_io_module_get_type ())
46#define G_IO_MODULE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_IO_TYPE_MODULE, GIOModule))
47#define G_IO_MODULE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_IO_TYPE_MODULE, GIOModuleClass))
48#define G_IO_IS_MODULE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_IO_TYPE_MODULE))
49#define G_IO_IS_MODULE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_IO_TYPE_MODULE))
50#define G_IO_MODULE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_IO_TYPE_MODULE, GIOModuleClass))
51
52typedef struct _GIOModuleClass GIOModuleClass;
53
54GIO_AVAILABLE_IN_ALL
55GType g_io_module_get_type (void) G_GNUC_CONST;
56GIO_AVAILABLE_IN_ALL
57GIOModule *g_io_module_new (const gchar *filename);
58
59GIO_AVAILABLE_IN_ALL
60void g_io_modules_scan_all_in_directory (const char *dirname);
61GIO_AVAILABLE_IN_ALL
62GList *g_io_modules_load_all_in_directory (const gchar *dirname);
63
64GIO_AVAILABLE_IN_2_30
65void g_io_modules_scan_all_in_directory_with_scope (const gchar *dirname,
66 GIOModuleScope *scope);
67GIO_AVAILABLE_IN_2_30
68GList *g_io_modules_load_all_in_directory_with_scope (const gchar *dirname,
69 GIOModuleScope *scope);
70
71GIO_AVAILABLE_IN_ALL
72GIOExtensionPoint *g_io_extension_point_register (const char *name);
73GIO_AVAILABLE_IN_ALL
74GIOExtensionPoint *g_io_extension_point_lookup (const char *name);
75GIO_AVAILABLE_IN_ALL
76void g_io_extension_point_set_required_type (GIOExtensionPoint *extension_point,
77 GType type);
78GIO_AVAILABLE_IN_ALL
79GType g_io_extension_point_get_required_type (GIOExtensionPoint *extension_point);
80GIO_AVAILABLE_IN_ALL
81GList *g_io_extension_point_get_extensions (GIOExtensionPoint *extension_point);
82GIO_AVAILABLE_IN_ALL
83GIOExtension * g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
84 const char *name);
85GIO_AVAILABLE_IN_ALL
86GIOExtension * g_io_extension_point_implement (const char *extension_point_name,
87 GType type,
88 const char *extension_name,
89 gint priority);
90
91GIO_AVAILABLE_IN_ALL
92GType g_io_extension_get_type (GIOExtension *extension);
93GIO_AVAILABLE_IN_ALL
94const char * g_io_extension_get_name (GIOExtension *extension);
95GIO_AVAILABLE_IN_ALL
96gint g_io_extension_get_priority (GIOExtension *extension);
97GIO_AVAILABLE_IN_ALL
98GTypeClass* g_io_extension_ref_class (GIOExtension *extension);
99
100
101/* API for the modules to implement.
102 * Note that those functions are not implemented by libgio, they are declared
103 * here to be implemented in modules, that's why it uses G_MODULE_EXPORT
104 * instead of GIO_AVAILABLE_IN_ALL.
105 */
106
107/**
108 * g_io_module_load: (skip)
109 * @module: a #GIOModule.
110 *
111 * Required API for GIO modules to implement.
112 *
113 * This function is run after the module has been loaded into GIO,
114 * to initialize the module. Typically, this function will call
115 * g_io_extension_point_implement().
116 *
117 * Since 2.56, this function should be named `g_io_<modulename>_load`, where
118 * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
119 * everything after the first dot removed, and with `-` replaced with `_`
120 * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
121 * Using the new symbol names avoids name clashes when building modules
122 * statically. The old symbol names continue to be supported, but cannot be used
123 * for static builds.
124 **/
125G_MODULE_EXPORT
126void g_io_module_load (GIOModule *module);
127
128/**
129 * g_io_module_unload: (skip)
130 * @module: a #GIOModule.
131 *
132 * Required API for GIO modules to implement.
133 *
134 * This function is run when the module is being unloaded from GIO,
135 * to finalize the module.
136 *
137 * Since 2.56, this function should be named `g_io_<modulename>_unload`, where
138 * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
139 * everything after the first dot removed, and with `-` replaced with `_`
140 * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
141 * Using the new symbol names avoids name clashes when building modules
142 * statically. The old symbol names continue to be supported, but cannot be used
143 * for static builds.
144 **/
145G_MODULE_EXPORT
146void g_io_module_unload (GIOModule *module);
147
148/**
149 * g_io_module_query:
150 *
151 * Optional API for GIO modules to implement.
152 *
153 * Should return a list of all the extension points that may be
154 * implemented in this module.
155 *
156 * This method will not be called in normal use, however it may be
157 * called when probing existing modules and recording which extension
158 * points that this model is used for. This means we won't have to
159 * load and initialize this module unless its needed.
160 *
161 * If this function is not implemented by the module the module will
162 * always be loaded, initialized and then unloaded on application
163 * startup so that it can register its extension points during init.
164 *
165 * Note that a module need not actually implement all the extension
166 * points that g_io_module_query() returns, since the exact list of
167 * extension may depend on runtime issues. However all extension
168 * points actually implemented must be returned by g_io_module_query()
169 * (if defined).
170 *
171 * When installing a module that implements g_io_module_query() you must
172 * run gio-querymodules in order to build the cache files required for
173 * lazy loading.
174 *
175 * Since 2.56, this function should be named `g_io_<modulename>_query`, where
176 * `modulename` is the plugin’s filename with the `lib` or `libgio` prefix and
177 * everything after the first dot removed, and with `-` replaced with `_`
178 * throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`.
179 * Using the new symbol names avoids name clashes when building modules
180 * statically. The old symbol names continue to be supported, but cannot be used
181 * for static builds.
182 *
183 * Returns: (transfer full): A %NULL-terminated array of strings,
184 * listing the supported extension points of the module. The array
185 * must be suitable for freeing with g_strfreev().
186 *
187 * Since: 2.24
188 **/
189G_MODULE_EXPORT
190char **g_io_module_query (void);
191
192G_END_DECLS
193
194#endif /* __G_IO_MODULE_H__ */
195