giarginfo.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
  2. * GObject introspection: Argument
  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_ARG_INFO (gi_arg_info_get_type ())
  31. /**
  32. * GI_ARG_INFO:
  33. * @info: Info object which is subject to casting.
  34. *
  35. * Casts a [type@GIRepository.ArgInfo] or derived pointer into a
  36. * `(GIArgInfo*)` 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_ARG_INFO(info) (G_TYPE_CHECK_INSTANCE_CAST ((info), GI_TYPE_ARG_INFO, GIArgInfo))
  44. /**
  45. * GI_IS_ARG_INFO:
  46. * @info: an info structure
  47. *
  48. * Checks if @info is a [class@GIRepository.ArgInfo] (or a derived type).
  49. *
  50. * Since: 2.80
  51. */
  52. #define GI_IS_ARG_INFO(info) (G_TYPE_CHECK_INSTANCE_TYPE ((info), GI_TYPE_ARG_INFO))
  53. GI_AVAILABLE_IN_ALL
  54. GIDirection gi_arg_info_get_direction (GIArgInfo *info);
  55. GI_AVAILABLE_IN_ALL
  56. gboolean gi_arg_info_is_return_value (GIArgInfo *info);
  57. GI_AVAILABLE_IN_ALL
  58. gboolean gi_arg_info_is_optional (GIArgInfo *info);
  59. GI_AVAILABLE_IN_ALL
  60. gboolean gi_arg_info_is_caller_allocates (GIArgInfo *info);
  61. GI_AVAILABLE_IN_ALL
  62. gboolean gi_arg_info_may_be_null (GIArgInfo *info);
  63. GI_AVAILABLE_IN_ALL
  64. gboolean gi_arg_info_is_skip (GIArgInfo *info);
  65. GI_AVAILABLE_IN_ALL
  66. GITransfer gi_arg_info_get_ownership_transfer (GIArgInfo *info);
  67. GI_AVAILABLE_IN_ALL
  68. GIScopeType gi_arg_info_get_scope (GIArgInfo *info);
  69. GI_AVAILABLE_IN_ALL
  70. gboolean gi_arg_info_get_closure_index (GIArgInfo *info,
  71. unsigned int *out_closure_index);
  72. GI_AVAILABLE_IN_ALL
  73. gboolean gi_arg_info_get_destroy_index (GIArgInfo *info,
  74. unsigned int *out_destroy_index);
  75. GI_AVAILABLE_IN_ALL
  76. GITypeInfo * gi_arg_info_get_type_info (GIArgInfo *info);
  77. GI_AVAILABLE_IN_ALL
  78. void gi_arg_info_load_type_info (GIArgInfo *info,
  79. GITypeInfo *type);
  80. G_END_DECLS