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 G_WANT
22 apitest_exception mycroak strtab
23 my_cxt_getint my_cxt_getsv my_cxt_setint my_cxt_setsv
24 sv_setsv_cow_hashkey_core sv_setsv_cow_hashkey_notcore
25 rmagical_cast rmagical_flags
29 our $VERSION = '0.15';
31 use vars '$WARNINGS_ON_BOOTSTRAP';
32 use vars map "\$${_}_called_PP", qw(BEGIN UNITCHECK CHECK INIT END);
35 # This is arguably a hack, but it disposes of the UNITCHECK block without
36 # needing to preprocess the source code
38 eval 'sub UNITCHECK (&) {}; 1' or die $@;
42 # Do these here to verify that XS code and Perl code get called at the same
48 $UNITCHECK_called_PP++;
51 # Need $W false by default, as some tests run under -w, and under -w we
52 # can get warnings about "Too late to run CHECK" block (and INIT block)
65 if ($WARNINGS_ON_BOOTSTRAP) {
66 bootstrap XS::APItest $VERSION;
68 # More CHECK and INIT blocks that could warn:
70 bootstrap XS::APItest $VERSION;
78 XS::APItest - Test the perl C API
87 This module tests the perl C API. Currently tests that C<printf>
92 This module can be used to check that the perl C API is behaving
93 correctly. This module provides test functions and an associated
94 test script that verifies the output.
96 This module is not meant to be installed.
100 Exports all the test functions:
104 =item B<print_double>
106 Test that a double-precision floating point number is formatted
107 correctly by C<printf>.
109 print_double( $val );
111 Output is sent to STDOUT.
113 =item B<print_long_double>
115 Test that a C<long double> is formatted correctly by
116 C<printf>. Takes no arguments - the test value is hard-wired
117 into the function (as "7").
121 Output is sent to STDOUT.
123 =item B<have_long_double>
125 Determine whether a C<long double> is supported by Perl. This should
126 be used to determine whether to test C<print_long_double>.
128 print_long_double() if have_long_double;
132 Test that an C<NV> is formatted correctly by
137 Output is sent to STDOUT.
141 Test that an C<IV> is formatted correctly by
146 Output is sent to STDOUT.
150 Test that an C<UV> is formatted correctly by
155 Output is sent to STDOUT.
159 Test that an C<int> is formatted correctly by
164 Output is sent to STDOUT.
168 Test that an C<long> is formatted correctly by
173 Output is sent to STDOUT.
177 Test that a single-precision floating point number is formatted
178 correctly by C<printf>.
182 Output is sent to STDOUT.
184 =item B<call_sv>, B<call_pv>, B<call_method>
186 These exercise the C calls of the same names. Everything after the flags
187 arg is passed as the the args to the called function. They return whatever
188 the C function itself pushed onto the stack, plus the return value from
189 the function; for example
191 call_sv( sub { @_, 'c' }, G_ARRAY, 'a', 'b'); # returns 'a', 'b', 'c', 3
192 call_sv( sub { @_ }, G_SCALAR, 'a', 'b'); # returns 'b', 1
196 Evaluates the passed SV. Result handling is done the same as for
201 Exercises the C function of the same name in scalar context. Returns the
202 same SV that the C function returns.
206 Exercises the C function of the same name. Returns nothing.
212 L<XS::Typemap>, L<perlapi>.
216 Tim Jenness, E<lt>t.jenness@jach.hawaii.eduE<gt>,
217 Christian Soeller, E<lt>csoelle@mph.auckland.ac.nzE<gt>,
218 Hugo van der Sanden E<lt>hv@crypt.compulink.co.ukE<gt>
220 =head1 COPYRIGHT AND LICENSE
222 Copyright (C) 2002,2004 Tim Jenness, Christian Soeller, Hugo van der Sanden.
225 This library is free software; you can redistribute it and/or modify
226 it under the same terms as Perl itself.