mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-29 08:56:15 +01:00
605fdf7046
Plain Old Data (POD) types with or without a representation in the GType
type system can still have a copy and/or a free function. We should
allow annotating these types with their corresponding functions for
copying their data into a new instance, and freeing their data.
From a language bindings perspective, POD types should have a boxed
GType wrapper around them, so they can use the generic GBoxed API to
copy and free instances; from a documentation perspective, though, it'd
be good to have a way to match a structured type, like a struct or a
union, with its copy and free functions.
In order to do that, we add two new header block annotations:
- (copy-func function_name)
- (free-func function_name)
These annotations work exactly like ref-func and unref-func for typed
instances:
/**
* GdkRGBA: (copy-func gdk_rgba_copy)
* (free-func gdk_rgba_free)
* @red: ...
* @green: ...
* @blue: ...
* @alpha: ...
*
* ...
*/
The function is stored in the GIR data as two new attributes for the
`<record>` and `<union>` elements:
<record name="RGBA"
c:type="GdkRGBA"
copy-function="gdk_rgba_copy"
free-function="gdk_rgba_free"
glib:type-name="GdkRGBA"
glib:get-type="gdk_rgba_get_type"
c:symbol-prefix="gdk_rgba">
The annotations are not mandatory.
See: #14
87 lines
2.5 KiB
C
87 lines
2.5 KiB
C
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
|
|
* GObject introspection: Struct
|
|
*
|
|
* Copyright (C) 2005 Matthias Clasen
|
|
* Copyright (C) 2008,2009 Red Hat, Inc.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef __GISTRUCTINFO_H__
|
|
#define __GISTRUCTINFO_H__
|
|
|
|
#if !defined (__GIREPOSITORY_H_INSIDE__) && !defined (GI_COMPILATION)
|
|
#error "Only <girepository.h> can be included directly."
|
|
#endif
|
|
|
|
#include <gitypes.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* GI_IS_STRUCT_INFO
|
|
* @info: an info structure
|
|
*
|
|
* Checks if @info is a #GIStructInfo.
|
|
*/
|
|
#define GI_IS_STRUCT_INFO(info) \
|
|
(g_base_info_get_type((GIBaseInfo*)info) == GI_INFO_TYPE_STRUCT)
|
|
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
gint g_struct_info_get_n_fields (GIStructInfo *info);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
GIFieldInfo * g_struct_info_get_field (GIStructInfo *info,
|
|
gint n);
|
|
|
|
GI_AVAILABLE_IN_1_46
|
|
GIFieldInfo * g_struct_info_find_field (GIStructInfo *info,
|
|
const gchar *name);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
gint g_struct_info_get_n_methods (GIStructInfo *info);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
GIFunctionInfo * g_struct_info_get_method (GIStructInfo *info,
|
|
gint n);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
GIFunctionInfo * g_struct_info_find_method (GIStructInfo *info,
|
|
const gchar *name);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
gsize g_struct_info_get_size (GIStructInfo *info);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
gsize g_struct_info_get_alignment (GIStructInfo *info);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
gboolean g_struct_info_is_gtype_struct (GIStructInfo *info);
|
|
|
|
GI_AVAILABLE_IN_ALL
|
|
gboolean g_struct_info_is_foreign (GIStructInfo *info);
|
|
|
|
GI_AVAILABLE_IN_1_76
|
|
const char * g_struct_info_get_copy_function (GIStructInfo *info);
|
|
|
|
GI_AVAILABLE_IN_1_76
|
|
const char * g_struct_info_get_free_function (GIStructInfo *info);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GISTRUCTINFO_H__ */
|