NAME

ExtUtils::Typemaps::OpaqueObj - Typemap for storing objects as a string reference

VERSION

version 0.002

SYNOPSIS

In typemap

Foo::Bar	T_OPAQUEOBJ

In your XS:

typedef struct foo_bar* Foo__Bar;

MODULE = Foo::Bar    PACKAGE = Foo::Bar    PREFIX = foobar_

Foo::Bar foobar_new(SV* class, int argument)

int foobar_baz(Foo::Bar self)

DESCRIPTION

ExtUtils::Typemaps::OpaqueObj is an ExtUtils::Typemaps subclass that stores an object inside a string reference. It is particularly suitable for objects whose entire state is helt in the struct (e.g. no pointers, handles, descriptors, …). In such cases the object will serialize and deserialize cleanly, and is safe with regards to thread cloning.

INCLUSION

To use this typemap template you need to include it into your local typemap. The easiest way to do that is to use the typemap script in App::typemap. E.g.

typemap --merge ExtUtils::Typemaps::OpaqueObj

If you author using Dist::Zilla you can use Dist::Zilla::Plugin::Typemap instead.

Alternatively, you can include it at runtime by adding the following to your XS file:

INCLUDE_COMMAND: $^X -MExtUtils::Typemaps::Cmd -e "print embeddable_typemap('OpaqueObj')"

That does require adding a build time dependency on this module.

AUTHOR

Leon Timmermans <fawaka@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 by Leon Timmermans.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.