# read/create file
my $typemap = ExtUtils::Typemaps->new(file => 'typemap');
# alternatively create an in-memory typemap
# $typemap = ExtUtils::Typemaps->new();
# alternatively create an in-memory typemap by parsing a string
# $typemap = ExtUtils::Typemaps->new(string => $sometypemap);
# add a mapping
$typemap->add_typemap(ctype => 'NV', xstype => 'T_NV');
$typemap->add_inputmap(
xstype => 'T_NV', code => '$var = ($type)SvNV($arg);'
);
$typemap->add_outputmap(
xstype => 'T_NV', code => 'sv_setnv($arg, (NV)$var);'
);
$typemap->add_string(string => $typemapstring);
# will be parsed and merged
# remove a mapping (same for remove_typemap and remove_outputmap...)
$typemap->remove_inputmap(xstype => 'SomeType');
# save a typemap to a file
$typemap->write(file => 'anotherfile.map');
# merge the other typemap into this one
$typemap->merge(typemap => $another_typemap);
The module is not entirely round-trip safe: For example it currently simply strips all comments. The order of entries in the maps is, however, preserved.
We check for duplicate entries in the typemap, but do not check for missing "TYPEMAP" entries for "INPUTMAP" or "OUTPUTMAP" entries since these might be hidden in a different typemap.
Alternatively, if the "string" parameter is given, the supplied string will be parsed instead of a file.
Required named arguments: The "ctype" (e.g. "ctype => 'double'") and the "xstype" (e.g. "xstype => 'T_NV'").
Optional named arguments: "replace => 1" forces removal/replacement of existing "TYPEMAP" entries of the same "ctype". "skip => 1" triggers a ``first come first serve'' logic by which new entries that conflict with existing entries are silently ignored.
As an alternative to the named parameters usage, you may pass in an "ExtUtils::Typemaps::Type" object as first argument, a copy of which will be added to the typemap. In that case, only the "replace" or "skip" named parameters may be used after the object. Example:
$map->add_typemap($type_obj, replace => 1);
Required named arguments: The "xstype" (e.g. "xstype => 'T_NV'") and the "code" to associate with it for input.
Optional named arguments: "replace => 1" forces removal/replacement of existing "INPUT" entries of the same "xstype". "skip => 1" triggers a ``first come first serve'' logic by which new entries that conflict with existing entries are silently ignored.
As an alternative to the named parameters usage, you may pass in an "ExtUtils::Typemaps::InputMap" object as first argument, a copy of which will be added to the typemap. In that case, only the "replace" or "skip" named parameters may be used after the object. Example:
$map->add_inputmap($type_obj, replace => 1);
Required named argument: "string" to specify the string to parse.
Required named argument: "ctype" to specify the entry to remove from the typemap.
Alternatively, you may pass a single "ExtUtils::Typemaps::Type" object.
Required named argument: "xstype" to specify the entry to remove from the typemap.
Alternatively, you may pass a single "ExtUtils::Typemaps::InputMap" object.
Required named argument: "xstype" to specify the entry to remove from the typemap.
Alternatively, you may pass a single "ExtUtils::Typemaps::OutputMap" object.
Mandatory named arguments: The "ctype" of the entry.
Returns the "ExtUtils::Typemaps::Type" object for the entry if found.
Mandatory named arguments: The "xstype" of the entry or the "ctype" of the typemap that can be used to find the "xstype". To wit, the following pieces of code are equivalent:
my $type = $typemap->get_typemap(ctype => $ctype) my $input_map = $typemap->get_inputmap(xstype => $type->xstype); my $input_map = $typemap->get_inputmap(ctype => $ctype);
Returns the "ExtUtils::Typemaps::InputMap" object for the entry if found.
Mandatory named arguments: The "xstype" of the entry or the "ctype" of the typemap that can be used to resolve the "xstype". (See above for an example.)
Returns the "ExtUtils::Typemaps::InputMap" object for the entry if found.
TYPEMAP: <<END_OF_TYPEMAP ... typemap here (see as_string) ... END_OF_TYPEMAP
The method takes care not to use a HERE-doc end marker that appears in the typemap string itself.
Mandatory named arguments: Either "typemap => $another_typemap_obj" or "file => $path_to_typemap_file" but not both.
Optional arguments: "replace => 1" to force replacement of existing typemap entries without warning or "skip => 1" to skip entries that exist already in the typemap.
{
'char **' => 'T_PACKEDARRAY',
'bool_t' => 'T_IV',
'AV *' => 'T_AVREF',
'InputStream' => 'T_IN',
'double' => 'T_DOUBLE',
# ...
}
This is documented because it is used by "ExtUtils::ParseXS", but it's not intended for general consumption. May be removed at any time.
{
'T_CALLBACK' => ' $var = make_perl_cb_$type($arg)
',
'T_OUT' => ' $var = IoOFP(sv_2io($arg))
',
'T_REF_IV_PTR' => ' if (sv_isa($arg, \\"${ntype}\\")) {
# ...
}
This is documented because it is used by "ExtUtils::ParseXS", but it's not intended for general consumption. May be removed at any time.
{
'T_CALLBACK' => ' sv_setpvn($arg, $var.context.value().chp(),
$var.context.value().size());
',
'T_OUT' => ' {
GV *gv = (GV *)sv_newmortal();
gv_init_pvn(gv, gv_stashpvs("$Package",1),
"__ANONIO__",10,0);
if ( do_open(gv, "+>&", 3, FALSE, 0, 0, $var) )
sv_setsv(
$arg,
sv_bless(newRV((SV*)gv), gv_stashpv("$Package",1))
);
else
$arg = &PL_sv_undef;
}
',
# ...
}
This is documented because it is used by "ExtUtils::ParseXS", but it's not intended for general consumption. May be removed at any time.
{
'char **' => '$',
'bool_t' => '$',
'AV *' => '$',
'InputStream' => '$',
'double' => '$',
# ...
}
This is documented because it is used by "ExtUtils::ParseXS", but it's not intended for general consumption. May be removed at any time.
Takes named parameters: If "shallow" is true, the clone will share the actual individual type/input/outputmap objects, but not share their storage. Use with caution. Without "shallow", the clone will be fully independent.
$halfway_canonical_type = tidy_type($ctype);
Moved from "ExtUtils::ParseXS".
For details on typemaps: perlxstut, perlxs.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.