MAN page from Fedora 8 perl-ExtUtils-Constant-0.17-30.n0i.51.fc8.i386.rpm
Section: Perl Programmers Reference Guide (3pm)
ExtUtils::Constant - generate XS code to import C header constants
use ExtUtils::Constant qw (WriteConstants); WriteConstants( NAME => 'Foo', NAMES => [qw(FOO BAR BAZ)], ); # Generates wrapper code to make the values of the constants FOO BAR BAZ # available to perl
ExtUtils::Constant facilitates generating C and XS
wrapper code to allowperl modules to AUTOLOAD
constants defined in C library header files.It is principally used by the "h2xs"
utility, on which this code is based.It doesn't contain the routines to scan header files to extract theseconstants.
Generally one only needs to call the "WriteConstants"
function, and then
in the C section of "Foo.xs"
in the XS section of "Foo.xs".
For greater flexibility use "constant_types()", "C_constant" and"XS_constant", with which "WriteConstants" is implemented.
Currently this module understands the following types. h2xs may only knowa subset. The sizes of the numeric types are chosen by the "Configure"script at compile time.
- signed integer, at least 32 bits.
- unsigned integer, the same size as IV
- floating point type, probably "double", possibly "long double"
- NUL terminated string, length will be determined with "strlen"
- A fixed length thing, given as a [pointer, length] pair. If you know thelength of a string at compile time you may use this instead of PV
- A mortal SV.
- Truth. ("PL_sv_yes") The value is not needed (and ignored).
- Defined Falsehood. ("PL_sv_no") The value is not needed (and ignored).
- "undef". The value of the macro is not needed.
- A function returning a single scalar with "#define" definitions for theconstants used internally between the generated C and XS functions.
- XS_constant PACKAGE, TYPES, SUBNAME, C_SUBNAME
- A function to generate the XS code to implement the perl subroutinePACKAGE::constant used by PACKAGE::AUTOLOAD to load constants.This XS code is a wrapper around a C subroutine usually generated by"C_constant", and usually named "constant".
TYPES should be given either as a comma separated list of types that theC subroutine "constant" will generate or as a reference to a hash. It shouldbe the same list of types as "C_constant" was given.[Otherwise "XS_constant" and "C_constant" may have different ideas aboutthe number of parameters passed to the C function "constant"]
You can call the perl visible subroutine something other than "constant" ifyou give the parameter SUBNAME. The C subroutine it calls defaults tothe name of the perl visible subroutine, unless you give the parameterC_SUBNAME.
- autoload PACKAGE, VERSION, AUTOLOADER
- A function to generate the AUTOLOAD subroutine for the module PACKAGEVERSION is the perl version the code should be backwards compatible with.It defaults to the version of perl running the subroutine. If AUTOLOADERis true, the AUTOLOAD subroutine falls back on AutoLoader::AUTOLOAD for allnames that the constant() routine doesn't recognise.
- WriteMakefileSnippet ATTRIBUTE => VALUE [, ...]
A function to generate perl code for Makefile.PL that will regeneratethe constant subroutines. Parameters are named as passed to "WriteConstants",with the addition of "INDENT" to specify the number of leading spaces(default 2).
Currently only "INDENT", "NAME", "DEFAULT_TYPE", "NAMES", "C_FILE" and"XS_FILE" are recognised.
- WriteConstants ATTRIBUTE => VALUE [, ...]
- Writes a file of C code and a file of XS code which you should "#include"and "INCLUDE" in the C and XS sections respectively of your module's XScode. You probably want to do this in your "Makefile.PL", so that you caneasily edit the list of constants without touching the rest of your module.The attributes supported are
- Name of the module. This must be specified
- The default type for the constants. If not specified "IV" is assumed.
- The names of the constants are grouped by length. Generate child subroutinesfor each group with this number or more names in.
- An array of constants' names, either scalars containing names, or hashrefsas detailed in ``C_constant''.
- The name of the file to write containing the C code. The default is"const-c.inc". The "-" in the name ensures that the file can't bemistaken for anything related to a legitimate perl package name, andnot naming the file ".c" avoids having to override Makefile.PL's".xs" to ".c" rules.
- The name of the file to write containing the XS code. The default is"const-xs.inc".
- The perl visible name of the XS subroutine generated which will return theconstants. The default is "constant".
- The name of the C subroutine generated which will return the constants.The default is SUBNAME. Child subroutines have "_" and the namelength appended, so constants with 10 character names would be in"constant_10" with the default XS_SUBNAME.
Nicholas Clark <nickAATTccl4.org> based on the code in "h2xs"
by Larry Wall andothers
This document was created byman2html,using the manual pages.