glib-2.0/gio/ginitable.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2009 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Alexander Larsson <alexl@redhat.com>
0021  */
0022
0023 #ifndef __G_INITABLE_H__
0024 #define __G_INITABLE_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/giotypes.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_INITABLE            (g_initable_get_type ())
0035 #define G_INITABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_INITABLE, GInitable))
0036 #define G_IS_INITABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_INITABLE))
0037 #define G_INITABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_INITABLE, GInitableIface))
0038 #define G_TYPE_IS_INITABLE(type)   (g_type_is_a ((type), G_TYPE_INITABLE))
0039
0040 typedef struct _GInitableIface GInitableIface;
0041
0042 /**
0043  * GInitableIface:
0044  * @g_iface: The parent interface.
0045  * @init: Initializes the object.
0046  *
0047  * Provides an interface for initializing object such that initialization
0048  * may fail.
0049  *
0050  * Since: 2.22
0051  **/
0052 struct _GInitableIface
0053 {
0054   GTypeInterface g_iface;
0055
0056   /* Virtual Table */
0057
0058   gboolean    (* init) (GInitable    *initable,
0059             GCancellable *cancellable,
0060             GError      **error);
0061 };
0062
0063
0064 GIO_AVAILABLE_IN_ALL
0065 GType    g_initable_get_type   (void) G_GNUC_CONST;
0066
0067 GIO_AVAILABLE_IN_ALL
0068 gboolean g_initable_init       (GInitable     *initable,
0069                 GCancellable  *cancellable,
0070                 GError       **error);
0071
0072 GIO_AVAILABLE_IN_ALL
0073 gpointer g_initable_new        (GType          object_type,
0074                 GCancellable  *cancellable,
0075                 GError       **error,
0076                 const gchar   *first_property_name,
0077                 ...);
0078
0079 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
0080
0081 GIO_DEPRECATED_IN_2_54_FOR(g_object_new_with_properties and g_initable_init)
0082 gpointer g_initable_newv       (GType          object_type,
0083                 guint          n_parameters,
0084                 GParameter    *parameters,
0085                 GCancellable  *cancellable,
0086                 GError       **error);
0087
0088 G_GNUC_END_IGNORE_DEPRECATIONS
0089
0090 GIO_AVAILABLE_IN_ALL
0091 GObject* g_initable_new_valist (GType          object_type,
0092                 const gchar   *first_property_name,
0093                 va_list        var_args,
0094                 GCancellable  *cancellable,
0095                 GError       **error);
0096
0097 G_END_DECLS
0098
0099
0100 #endif /* __G_INITABLE_H__ */