8 use base qw/ DynaLoader Exporter /;
10 # Items to export into callers namespace by default. Note: do not export
11 # names by default without a very good reason. Use EXPORT_OK instead.
12 # Do not simply export all your public functions/methods/constants.
14 # Export everything since these functions are only used by a test script
15 our @EXPORT = qw( print_double print_int print_long
16 print_float print_long_double have_long_double print_flush
17 mpushp mpushn mpushi mpushu
18 mxpushp mxpushn mxpushi mxpushu
19 call_sv call_pv call_method eval_sv eval_pv require_pv
20 G_SCALAR G_ARRAY G_VOID G_DISCARD G_EVAL G_NOARGS
21 G_KEEPERR G_NODEBUG G_METHOD
22 exception mycroak strtab
23 my_cxt_getint my_cxt_getsv my_cxt_setint my_cxt_setsv
33 sub G_KEEPERR() { 16 }
34 sub G_NODEBUG() { 32 }
37 our $VERSION = '0.09';
39 bootstrap XS::APItest $VERSION;
46 XS::APItest - Test the perl C API
55 This module tests the perl C API. Currently tests that C<printf>
60 This module can be used to check that the perl C API is behaving
61 correctly. This module provides test functions and an associated
62 test script that verifies the output.
64 This module is not meant to be installed.
68 Exports all the test functions:
74 Test that a double-precision floating point number is formatted
75 correctly by C<printf>.
79 Output is sent to STDOUT.
81 =item B<print_long_double>
83 Test that a C<long double> is formatted correctly by
84 C<printf>. Takes no arguments - the test value is hard-wired
85 into the function (as "7").
89 Output is sent to STDOUT.
91 =item B<have_long_double>
93 Determine whether a C<long double> is supported by Perl. This should
94 be used to determine whether to test C<print_long_double>.
96 print_long_double() if have_long_double;
100 Test that an C<NV> is formatted correctly by
105 Output is sent to STDOUT.
109 Test that an C<IV> is formatted correctly by
114 Output is sent to STDOUT.
118 Test that an C<UV> is formatted correctly by
123 Output is sent to STDOUT.
127 Test that an C<int> is formatted correctly by
132 Output is sent to STDOUT.
136 Test that an C<long> is formatted correctly by
141 Output is sent to STDOUT.
145 Test that a single-precision floating point number is formatted
146 correctly by C<printf>.
150 Output is sent to STDOUT.
152 =item B<call_sv>, B<call_pv>, B<call_method>
154 These exercise the C calls of the same names. Everything after the flags
155 arg is passed as the the args to the called function. They return whatever
156 the C function itself pushed onto the stack, plus the return value from
157 the function; for example
159 call_sv( sub { @_, 'c' }, G_ARRAY, 'a', 'b'); # returns 'a', 'b', 'c', 3
160 call_sv( sub { @_ }, G_SCALAR, 'a', 'b'); # returns 'b', 1
164 Evaluates the passed SV. Result handling is done the same as for
169 Exercises the C function of the same name in scalar context. Returns the
170 same SV that the C function returns.
174 Exercises the C function of the same name. Returns nothing.
180 L<XS::Typemap>, L<perlapi>.
184 Tim Jenness, E<lt>t.jenness@jach.hawaii.eduE<gt>,
185 Christian Soeller, E<lt>csoelle@mph.auckland.ac.nzE<gt>,
186 Hugo van der Sanden E<lt>hv@crypt.compulink.co.ukE<gt>
188 =head1 COPYRIGHT AND LICENSE
190 Copyright (C) 2002,2004 Tim Jenness, Christian Soeller, Hugo van der Sanden.
193 This library is free software; you can redistribute it and/or modify
194 it under the same terms as Perl itself.