This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
A repaired, properly refcounting AV&HV typemap
[perl5.git] / ext / XS-Typemap / Typemap.pm
CommitLineData
ea035a69
JH
1package XS::Typemap;
2
3=head1 NAME
4
5XS::Typemap - module to test the XS typemaps distributed with perl
6
7=head1 SYNOPSIS
8
9 use XS::Typemap;
10
11 $output = T_IV( $input );
12 $output = T_PV( $input );
13 @output = T_ARRAY( @input );
14
15=head1 DESCRIPTION
16
17This module is used to test that the XS typemaps distributed
18with perl are working as advertised. A function is available
19for each typemap definition (eventually). In general each function
20takes a variable, processes it through the OUTPUT typemap and then
21returns it using the INPUT typemap.
22
23A test script can then compare the input and output to make sure they
24are the expected values. When only an input or output function is
25provided the function will be named after the typemap entry and have
26either '_IN' or '_OUT' appended.
27
28All the functions are exported. There is no reason not to do this since
29the entire purpose is for testing Perl. Namespace pollution will be limited
30to the test script.
31
32=cut
33
b58f046e
NC
34use parent qw/ Exporter /;
35require XSLoader;
ea035a69
JH
36
37use vars qw/ $VERSION @EXPORT /;
38
b64f48ff 39$VERSION = '0.06';
ea035a69
JH
40
41@EXPORT = (qw/
42 T_SV
43 T_SVREF
44 T_AVREF
b64f48ff 45 T_AVREF_REFCOUNT_FIXED
ea035a69 46 T_HVREF
b64f48ff 47 T_HVREF_REFCOUNT_FIXED
ea035a69
JH
48 T_CVREF
49 T_SYSRET_fail T_SYSRET_pass
50 T_UV
51 T_IV
52 T_INT
53 T_ENUM
54 T_BOOL
55 T_U_INT
56 T_SHORT
57 T_U_SHORT
58 T_LONG
59 T_U_LONG
60 T_CHAR
61 T_U_CHAR
62 T_FLOAT
63 T_NV
64 T_DOUBLE
65 T_PV
66 T_PTR_IN T_PTR_OUT
67 T_PTRREF_IN T_PTRREF_OUT
68 T_REF_IV_REF
69 T_REF_IV_PTR_IN T_REF_IV_PTR_OUT
70 T_PTROBJ_IN T_PTROBJ_OUT
5abff6f9 71 T_OPAQUE_IN T_OPAQUE_OUT T_OPAQUE_array
aa921f48 72 T_OPAQUEPTR_IN T_OPAQUEPTR_OUT T_OPAQUEPTR_OUT_short
5abff6f9 73 T_OPAQUEPTR_IN_struct T_OPAQUEPTR_OUT_struct
ea035a69
JH
74 T_ARRAY
75 T_STDIO_open T_STDIO_close T_STDIO_print
76 /);
77
b58f046e 78XSLoader::load();
ea035a69
JH
79
80=head1 NOTES
81
82This module is for testing only and should not normally be installed.
83
84=head1 AUTHOR
85
86Tim Jenness E<lt>t.jenness@jach.hawaii.eduE<gt>
87
88Copyright (C) 2001 Tim Jenness All Rights Reserved. This program is
89free software; you can redistribute it and/or modify it under the same
90terms as Perl itself.
91
92=cut
93
94
951;
96