summaryrefslogtreecommitdiff
path: root/giscanner/girparser.py
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2022-10-29 18:09:23 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2023-01-08 14:50:28 +0000
commite9e3866133275cedcec6b9953adaf88fefcabbf8 (patch)
tree813abc2433ad2d50c23303a6cc0c7b09a8646a92 /giscanner/girparser.py
parent221b006625f2185b5a4d81d544bd0a2acf70ef60 (diff)
downloadgobject-introspection-e9e3866133275cedcec6b9953adaf88fefcabbf8.tar.gz
Add copy and free function annotations for POD types
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
Diffstat (limited to 'giscanner/girparser.py')
-rw-r--r--giscanner/girparser.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/giscanner/girparser.py b/giscanner/girparser.py
index 5fc22899..2f8c5f66 100644
--- a/giscanner/girparser.py
+++ b/giscanner/girparser.py
@@ -462,14 +462,20 @@ class GIRParser(object):
def _parse_record(self, node, anonymous=False):
struct = self._parse_compound(ast.Record, node)
is_gtype_struct_for = node.attrib.get(_glibns('is-gtype-struct-for'))
+ copy_func = node.attrib.get('copy-function')
+ free_func = node.attrib.get('free-function')
if is_gtype_struct_for is not None:
struct.is_gtype_struct_for = self._namespace.type_from_name(is_gtype_struct_for)
+ struct.copy_func = copy_func
+ struct.free_func = free_func
if not anonymous:
self._namespace.append(struct)
return struct
def _parse_union(self, node, anonymous=False):
union = self._parse_compound(ast.Union, node)
+ union.copy_func = node.attrib.get('copy-function')
+ union.free_func = node.attrib.get('free-function')
if not anonymous:
self._namespace.append(union)
return union