ginitable.h 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2009 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. #ifndef __G_INITABLE_H__
  23. #define __G_INITABLE_H__
  24. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25. #error "Only <gio/gio.h> can be included directly."
  26. #endif
  27. #include <gio/giotypes.h>
  28. G_BEGIN_DECLS
  29. #define G_TYPE_INITABLE (g_initable_get_type ())
  30. #define G_INITABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_INITABLE, GInitable))
  31. #define G_IS_INITABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_INITABLE))
  32. #define G_INITABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_INITABLE, GInitableIface))
  33. #define G_TYPE_IS_INITABLE(type) (g_type_is_a ((type), G_TYPE_INITABLE))
  34. typedef struct _GInitableIface GInitableIface;
  35. /**
  36. * GInitableIface:
  37. * @g_iface: The parent interface.
  38. * @init: Initializes the object.
  39. *
  40. * Provides an interface for initializing object such that initialization
  41. * may fail.
  42. *
  43. * Since: 2.22
  44. **/
  45. struct _GInitableIface
  46. {
  47. GTypeInterface g_iface;
  48. /* Virtual Table */
  49. gboolean (* init) (GInitable *initable,
  50. GCancellable *cancellable,
  51. GError **error);
  52. };
  53. GIO_AVAILABLE_IN_ALL
  54. GType g_initable_get_type (void) G_GNUC_CONST;
  55. GIO_AVAILABLE_IN_ALL
  56. gboolean g_initable_init (GInitable *initable,
  57. GCancellable *cancellable,
  58. GError **error);
  59. GIO_AVAILABLE_IN_ALL
  60. gpointer g_initable_new (GType object_type,
  61. GCancellable *cancellable,
  62. GError **error,
  63. const gchar *first_property_name,
  64. ...);
  65. G_GNUC_BEGIN_IGNORE_DEPRECATIONS
  66. GIO_DEPRECATED_IN_2_54_FOR(g_object_new_with_properties and g_initable_init)
  67. gpointer g_initable_newv (GType object_type,
  68. guint n_parameters,
  69. GParameter *parameters,
  70. GCancellable *cancellable,
  71. GError **error);
  72. G_GNUC_END_IGNORE_DEPRECATIONS
  73. GIO_AVAILABLE_IN_ALL
  74. GObject* g_initable_new_valist (GType object_type,
  75. const gchar *first_property_name,
  76. va_list var_args,
  77. GCancellable *cancellable,
  78. GError **error);
  79. G_END_DECLS
  80. #endif /* __G_INITABLE_H__ */