File: gitypeinfo.h

package info (click to toggle)
gobject-introspection 1.84.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 72,336 kB
  • sloc: ansic: 562,269; python: 23,692; xml: 16,240; yacc: 1,711; perl: 1,624; sh: 1,139; lex: 510; cpp: 487; makefile: 182; javascript: 15; lisp: 1
file content (148 lines) | stat: -rw-r--r-- 4,948 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
 * GObject introspection: Type
 *
 * Copyright (C) 2005 Matthias Clasen
 * Copyright (C) 2008,2009 Red Hat, Inc.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#pragma once

#if !defined (__GIREPOSITORY_H_INSIDE__) && !defined (GI_COMPILATION)
#error "Only <girepository.h> can be included directly."
#endif

#include <girepository/gitypes.h>

G_BEGIN_DECLS

#define GI_TYPE_TYPE_INFO (gi_type_info_get_type ())

/**
 * GI_TYPE_INFO:
 * @info: Info object which is subject to casting.
 *
 * Casts a [type@GIRepository.TypeInfo] or derived pointer into a
 * `(GITypeInfo*)` pointer.
 *
 * Depending on the current debugging level, this function may invoke
 * certain runtime checks to identify invalid casts.
 *
 * Since: 2.80
 */
#define GI_TYPE_INFO(info) (G_TYPE_CHECK_INSTANCE_CAST ((info), GI_TYPE_TYPE_INFO, GITypeInfo))

/**
 * GI_IS_TYPE_INFO:
 * @info: an info structure
 *
 * Checks if @info is a [alias@GIRepository.TypeInfo] (or a derived type).
 *
 * Since: 2.80
 */
#define GI_IS_TYPE_INFO(info) (G_TYPE_CHECK_INSTANCE_TYPE ((info), GI_TYPE_TYPE_INFO))

/**
 * GI_TYPE_TAG_IS_BASIC:
 * @tag: a type tag
 *
 * Checks if @tag is a basic type.
 *
 * Since: 2.80
 */
#define GI_TYPE_TAG_IS_BASIC(tag) ((tag) < GI_TYPE_TAG_ARRAY || (tag) == GI_TYPE_TAG_UNICHAR)

/**
 * GI_TYPE_TAG_IS_NUMERIC:
 * @tag: a type tag
 *
 * Checks if @tag is a numeric type. That is, integer or floating point.
 *
 * Since: 2.80
 */
#define GI_TYPE_TAG_IS_NUMERIC(tag) ((tag) >= GI_TYPE_TAG_INT8 && (tag) <= GI_TYPE_TAG_DOUBLE)

/**
 * GI_TYPE_TAG_IS_CONTAINER:
 * @tag: a type tag
 *
 * Checks if @tag is a container type. That is, a type which may have a nonnull
 * return from [method@GIRepository.TypeInfo.get_param_type].
 *
 * Since: 2.80
 */
 #define GI_TYPE_TAG_IS_CONTAINER(tag) ((tag) == GI_TYPE_TAG_ARRAY || \
    ((tag) >= GI_TYPE_TAG_GLIST && (tag) <= GI_TYPE_TAG_GHASH))

GI_AVAILABLE_IN_ALL
const char *           gi_type_tag_to_string            (GITypeTag   type);

GI_AVAILABLE_IN_ALL
const char *           gi_info_type_to_string           (GIInfoType  type);


GI_AVAILABLE_IN_ALL
gboolean               gi_type_info_is_pointer          (GITypeInfo *info);

GI_AVAILABLE_IN_ALL
GITypeTag              gi_type_info_get_tag             (GITypeInfo *info);

GI_AVAILABLE_IN_ALL
GITypeInfo *           gi_type_info_get_param_type      (GITypeInfo  *info,
                                                         unsigned int n);

GI_AVAILABLE_IN_ALL
GIBaseInfo *           gi_type_info_get_interface       (GITypeInfo *info);

GI_AVAILABLE_IN_ALL
gboolean               gi_type_info_get_array_length_index (GITypeInfo   *info,
                                                            unsigned int *out_length_index);

GI_AVAILABLE_IN_ALL
gboolean               gi_type_info_get_array_fixed_size (GITypeInfo *info,
                                                          size_t     *out_size);

GI_AVAILABLE_IN_ALL
gboolean               gi_type_info_is_zero_terminated  (GITypeInfo *info);

GI_AVAILABLE_IN_ALL
GIArrayType            gi_type_info_get_array_type      (GITypeInfo *info);

GI_AVAILABLE_IN_ALL
GITypeTag              gi_type_info_get_storage_type    (GITypeInfo *info);

GI_AVAILABLE_IN_ALL
void                   gi_type_info_argument_from_hash_pointer (GITypeInfo *info,
                                                                void       *hash_pointer,
                                                                GIArgument *arg);

GI_AVAILABLE_IN_ALL
void *                 gi_type_info_hash_pointer_from_argument (GITypeInfo *info,
                                                                GIArgument *arg);

GI_AVAILABLE_IN_ALL
void                   gi_type_tag_argument_from_hash_pointer (GITypeTag   storage_type,
                                                               void       *hash_pointer,
                                                               GIArgument *arg);

GI_AVAILABLE_IN_ALL
void *                 gi_type_tag_hash_pointer_from_argument (GITypeTag   storage_type,
                                                               GIArgument *arg);

G_END_DECLS