Ouroboros::Spec - Ouroboros API specification
This package contains a single global variable, %SPEC that describes API provided by the Ouroboros package. Each key in this hash corresponds to a certain item type described below, and values are all arrayrefs of hashrefs.
%SPEC
$SPEC{const} = [ { name => "..." }, ... ];
A list of supported numeric constants.
Constant name.
Actual C type.
Perl scalar variant used to export the constant value to Perl. One of: "IV" or "UV".
$SPEC{enum} = [ { name => "..." }, ... ];
A list of supported enum values. This is a separate list due to nuance of ExtUtils::Constant implementation.
ExtUtils::Constant
Enum value name.
Actual C name of the enum.
$SPEC{fn} = [ { name => "...", ... }, ... ];
Name of the C function.
Name of the pointer getter in Ouroboros package.
C header declaration.
Return type of the function.
Arrayref containing C types of each of function argument, excluding pTHX argument present by default (but see no_pthx tag below).
pTHX
no_pthx
Additional metadata about the function.
POD string containing additional notes about the item.
When true, indicates that function does not have pTHX as a first argument.
$SPEC{sizeof} => [ { type => "..." }, ... ];
A list of types available via %SIZE_OF hash in Ouroboros package.
Name of the C type.
To install Ouroboros, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Ouroboros
CPAN shell
perl -MCPAN -e shell install Ouroboros
For more information on module installation, please visit the detailed CPAN module installation guide.