APItest.pm revision 7c478bd95313f5f23a4c958a745db2134aa03244
use 5.008;
use strict;
use warnings;
use Carp;
use base qw/ DynaLoader Exporter /;
# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Export everything since these functions are only used by a test script
);
our $VERSION = '0.03';
1;
=head1 NAME
XS::APItest - Test the perl C API
=head1 SYNOPSIS
use XS::APItest;
print_double(4);
=head1 ABSTRACT
This module tests the perl C API. Currently tests that C<printf>
works correctly.
=head1 DESCRIPTION
This module can be used to check that the perl C API is behaving
correctly. This module provides test functions and an associated
test script that verifies the output.
This module is not meant to be installed.
=head2 EXPORT
Exports all the test functions:
=over 4
=item B<print_double>
Test that a double-precision floating point number is formatted
correctly by C<printf>.
print_double( $val );
Output is sent to STDOUT.
=item B<print_long_double>
Test that a C<long double> is formatted correctly by
C<printf>. Takes no arguments - the test value is hard-wired
into the function (as "7").
print_long_double();
Output is sent to STDOUT.
=item B<have_long_double>
Determine whether a C<long double> is supported by Perl. This should
be used to determine whether to test C<print_long_double>.
print_long_double() if have_long_double;
=item B<print_nv>
Test that an C<NV> is formatted correctly by
C<printf>.
print_nv( $val );
Output is sent to STDOUT.
=item B<print_iv>
Test that an C<IV> is formatted correctly by
C<printf>.
print_iv( $val );
Output is sent to STDOUT.
=item B<print_uv>
Test that an C<UV> is formatted correctly by
C<printf>.
print_uv( $val );
Output is sent to STDOUT.
=item B<print_int>
Test that an C<int> is formatted correctly by
C<printf>.
print_int( $val );
Output is sent to STDOUT.
=item B<print_long>
Test that an C<long> is formatted correctly by
C<printf>.
print_long( $val );
Output is sent to STDOUT.
=item B<print_float>
Test that a single-precision floating point number is formatted
correctly by C<printf>.
print_float( $val );
Output is sent to STDOUT.
=back
=head1 SEE ALSO
L<XS::Typemap>, L<perlapi>.
=head1 AUTHORS
Tim Jenness, E<lt>t.jenness@jach.hawaii.eduE<gt>,
Christian Soeller, E<lt>csoelle@mph.auckland.ac.nzE<gt>,
Hugo van der Sanden E<lt>hv@crypt.compulink.co.ukE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2002 Tim Jenness, Christian Soeller, Hugo van der Sanden.
All Rights Reserved.
it under the same terms as Perl itself.
=cut