CONTENTS

• NAME
• SYNOPSIS
• DESCRIPTION
• METHODS
  • new
  • file
  • add_typemap
  • add_inputmap
  • add_outputmap
  • add_string
  • remove_typemap
  • remove_inputmap
  • remove_inputmap
  • get_typemap
  • get_inputmap
  • get_outputmap
  • write
  • as_string
  • as_embedded_typemap
  • merge
  • is_empty
  • list_mapped_ctypes
  • _get_typemap_hash
  • _get_inputmap_hash
  • _get_outputmap_hash
  • _get_prototype_hash
  • clone
  • tidy_type
• CAVEATS
• SEE ALSO
• AUTHOR
• COPYRIGHT & LICENSE

#NAME

ExtUtils::Typemaps - Read/Write/Modify Perl/XS typemap files

#SYNOPSIS

# 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);

#DESCRIPTION

This module can read, modify, create and write Perl XS typemap files. If you don't know what a typemap is, please confer the perlxstut and perlxs manuals.

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.

#METHODS