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

1 files changed, 12 insertions, 0 deletions

diff --git a/giscanner/ast.py b/giscanner/ast.py
index dac326cb..bbfbe267 100644
--- a/giscanner/ast.py
+++ b/giscanner/ast.py
@@ -1127,6 +1127,12 @@ class Record(Compound):
         # If non-None, this record defines the FooClass C structure
         # for some Foo GObject (or similar for GInterface)
         self.is_gtype_struct_for = None
+        # If non-None, this record has a copy function for heap
+        # allocated instances
+        self.copy_func = None
+        # If non-None, this record has a free function for heap
+        # allocated instances
+        self.free_func = None
 
 
 class Union(Compound):
@@ -1145,6 +1151,12 @@ class Union(Compound):
                           c_symbol_prefix=c_symbol_prefix,
                           disguised=disguised,
                           tag_name=tag_name)
+        # If non-None, this union has a copy function for heap
+        # allocated instances
+        self.copy_func = None
+        # If non-None, this union has a free function for heap
+        # allocated instances
+        self.free_func = None
 
 
 class Boxed(Node, Registered):