- NAME
- SYNOPSIS
- ABSTRACT
- DESCRIPTION
  - EXPORT
- KEYWORDS
  - RPN expression syntax
- SEE ALSO
- AUTHORS
- COPYRIGHT AND LICENSE

# NAME

XS::APItest - Test the perl C API

# SYNOPSIS

      use XS::APItest;
      print_double(4);

      use XS::APItest qw(rpn calcrpn);
      $triangle = rpn($n $n 1 + * 2 /);
      calcrpn $triangle { $n $n 1 + * 2 / }

# ABSTRACT

This module tests the perl C API. Also exposes various bit of the perl internals for the use of core test scripts.

# 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.

## EXPORT

Exports all the test functions:

print_double

  Test that a double-precision floating point number is formatted correctly by `printf`.

        print_double( $val );

  Output is sent to STDOUT.

print_long_double

  Test that a `long double` is formatted correctly by `printf`. Takes no arguments - the test value is hard-wired into the function (as "7").

        print_long_double();

  Output is sent to STDOUT.

have_long_double

  Determine whether a `long double` is supported by Perl. This should be used to determine whether to test `print_long_double`.

        print_long_double() if have_long_double;

print_nv

  Test that an `NV` is formatted correctly by `printf`.

        print_nv( $val );

  Output is sent to STDOUT.

print_iv

  Test that an `IV` is formatted correctly by `printf`.

        print_iv( $val );

  Output is sent to STDOUT.

print_uv

  Test that an `UV` is formatted correctly by `printf`.

        print_uv( $val );

  Output is sent to STDOUT.

print_int

  Test that an `int` is formatted correctly by `printf`.

        print_int( $val );

  Output is sent to STDOUT.

print_long

  Test that an `long` is formatted correctly by `printf`.

        print_long( $val );

  Output is sent to STDOUT.

print_float

  Test that a single-precision floating point number is formatted correctly by `printf`.

        print_float( $val );

  Output is sent to STDOUT.

filter

  Installs a source filter that substitutes "e" for "o" (witheut regard fer what it might be medifying).

call_sv, call_pv, call_method

  These exercise the C calls of the same names. Everything after the flags arg is passed as the args to the called function. They return whatever the C function itself pushed onto the stack, plus the return value from the function; for example

          call_sv( sub { @_, 'c' }, G_ARRAY,  'a', 'b');
          # returns 'a', 'b', 'c', 3
          call_sv( sub { @_ },      G_SCALAR, 'a', 'b');
          # returns 'b', 1

eval_sv

  Evaluates the passed SV. Result handling is done the same as for `call_sv()` etc.

eval_pv

  Exercises the C function of the same name in scalar context. Returns the same SV that the C function returns.

require_pv

  Exercises the C function of the same name. Returns nothing.

# KEYWORDS

These are not supplied by default, but must be explicitly imported. They are lexically scoped.

rpn(EXPRESSION)

  This construct is a Perl expression. EXPRESSION must be an RPN arithmetic expression, as described below. The RPN expression is evaluated, and its value is returned as the value of the Perl expression.

calcrpn VARIABLE { EXPRESSION }

  This construct is a complete Perl statement. (No semicolon should follow the closing brace.) VARIABLE must be a Perl scalar `my` variable, and EXPRESSION must be an RPN arithmetic expression as described below. The RPN expression is evaluated, and its value is assigned to the variable.

## RPN expression syntax

Tokens of an RPN expression may be separated by whitespace, but such separation is usually not required. It is required only where unseparated tokens would look like a longer token. For example, `12 34 +` can be written as `12 34+`, but not as `1234 +`.

An RPN expression may be any of:

`1234`

  A sequence of digits is an unsigned decimal literal number.

`$foo`

  An alphanumeric name preceded by dollar sign refers to a Perl scalar variable. Only variables declared with `my` or `state` are supported. If the variable's value is not a native integer, it will be converted to an integer, by Perl's usual mechanisms, at the time it is evaluated.

A B `+`

  Sum of A and B.

A B `-`

  Difference of A and B, the result of subtracting B from A.

A B `*`

  Product of A and B.

A B `/`

  Quotient when A is divided by B, rounded towards zero. Division by zero generates an exception.

A B `%`

  Remainder when A is divided by B with the quotient rounded towards zero. Division by zero generates an exception.

Because the arithmetic operators all have fixed arity and are postfixed, there is no need for operator precedence, nor for a grouping operator to override precedence. This is half of the point of RPN.

An RPN expression can also be interpreted in another way, as a sequence of operations on a stack, one operation per token. A literal or variable token pushes a value onto the stack. A binary operator pulls two items off the stack, performs a calculation with them, and pushes the result back onto the stack. The stack starts out empty, and at the end of the expression there must be exactly one value left on the stack.

# SEE ALSO

XS::Typemap, perlapi.

# AUTHORS

Tim Jenness, <t.jenness@jach.hawaii.edu>, Christian Soeller, <csoelle@mph.auckland.ac.nz>, Hugo van der Sanden <hv@crypt.compulink.co.uk>, Andrew Main (Zefram) <zefram@fysh.org>

# COPYRIGHT AND LICENSE

Copyright (C) 2002,2004 Tim Jenness, Christian Soeller, Hugo van der Sanden. All Rights Reserved.

Copyright (C) 2009 Andrew Main (Zefram) <zefram@fysh.org>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.