gicallableinfo.h 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
  2. * GObject introspection: Callable
  3. *
  4. * Copyright (C) 2005 Matthias Clasen
  5. * Copyright (C) 2008,2009 Red Hat, Inc.
  6. *
  7. * SPDX-License-Identifier: LGPL-2.1-or-later
  8. *
  9. * This library is free software; you can redistribute it and/or
  10. * modify it under the terms of the GNU Lesser General Public
  11. * License as published by the Free Software Foundation; either
  12. * version 2 of the License, or (at your option) any later version.
  13. *
  14. * This library is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17. * Lesser General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Lesser General Public
  20. * License along with this library; if not, write to the
  21. * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22. * Boston, MA 02111-1307, USA.
  23. */
  24. #pragma once
  25. #if !defined (__GIREPOSITORY_H_INSIDE__) && !defined (GI_COMPILATION)
  26. #error "Only <girepository.h> can be included directly."
  27. #endif
  28. #include <girepository/gitypes.h>
  29. G_BEGIN_DECLS
  30. #define GI_TYPE_CALLABLE_INFO (gi_callable_info_get_type ())
  31. /**
  32. * GI_CALLABLE_INFO:
  33. * @info: Info object which is subject to casting.
  34. *
  35. * Casts a [type@GIRepository.CallableInfo] or derived pointer into a
  36. * `(GICallableInfo*)` pointer.
  37. *
  38. * Depending on the current debugging level, this function may invoke
  39. * certain runtime checks to identify invalid casts.
  40. *
  41. * Since: 2.80
  42. */
  43. #define GI_CALLABLE_INFO(info) (G_TYPE_CHECK_INSTANCE_CAST ((info), GI_TYPE_CALLABLE_INFO, GICallableInfo))
  44. /**
  45. * GI_IS_CALLABLE_INFO:
  46. * @info: an info structure
  47. *
  48. * Checks if @info is a [class@GIRepository.CallableInfo] or derived from it.
  49. *
  50. * Since: 2.80
  51. */
  52. #define GI_IS_CALLABLE_INFO(info) (G_TYPE_CHECK_INSTANCE_TYPE ((info), GI_TYPE_CALLABLE_INFO))
  53. GI_AVAILABLE_IN_ALL
  54. gboolean gi_callable_info_is_method (GICallableInfo *info);
  55. GI_AVAILABLE_IN_ALL
  56. gboolean gi_callable_info_can_throw_gerror (GICallableInfo *info);
  57. GI_AVAILABLE_IN_ALL
  58. GITypeInfo * gi_callable_info_get_return_type (GICallableInfo *info);
  59. GI_AVAILABLE_IN_ALL
  60. void gi_callable_info_load_return_type (GICallableInfo *info,
  61. GITypeInfo *type);
  62. GI_AVAILABLE_IN_ALL
  63. const char * gi_callable_info_get_return_attribute (GICallableInfo *info,
  64. const char *name);
  65. GI_AVAILABLE_IN_ALL
  66. gboolean gi_callable_info_iterate_return_attributes (GICallableInfo *info,
  67. GIAttributeIter *iterator,
  68. const char **name,
  69. const char **value);
  70. GI_AVAILABLE_IN_ALL
  71. GITransfer gi_callable_info_get_caller_owns (GICallableInfo *info);
  72. GI_AVAILABLE_IN_ALL
  73. gboolean gi_callable_info_may_return_null (GICallableInfo *info);
  74. GI_AVAILABLE_IN_ALL
  75. gboolean gi_callable_info_skip_return (GICallableInfo *info);
  76. GI_AVAILABLE_IN_ALL
  77. unsigned int gi_callable_info_get_n_args (GICallableInfo *info);
  78. GI_AVAILABLE_IN_ALL
  79. GIArgInfo * gi_callable_info_get_arg (GICallableInfo *info,
  80. unsigned int n);
  81. GI_AVAILABLE_IN_ALL
  82. void gi_callable_info_load_arg (GICallableInfo *info,
  83. unsigned int n,
  84. GIArgInfo *arg);
  85. GI_AVAILABLE_IN_ALL
  86. gboolean gi_callable_info_invoke (GICallableInfo *info,
  87. void *function,
  88. const GIArgument *in_args,
  89. size_t n_in_args,
  90. GIArgument *out_args,
  91. size_t n_out_args,
  92. GIArgument *return_value,
  93. GError **error);
  94. GI_AVAILABLE_IN_ALL
  95. GITransfer gi_callable_info_get_instance_ownership_transfer (GICallableInfo *info);
  96. G_END_DECLS