h2xs builds a Perl extension from C header files. The extension will include functions which can be used to retrieve the value of any #define statement which was in the C header files.
The module_name will be used for the name of the extension. If module_name is not supplied then the name of the first header file will be used, with the first character capitalized.
Omit all autoload facilities. This is the same as -c but also removes the use !AutoLoader? statement from the .pm file.
Omits creation of the Changes file, and adds a HISTORY section to the POD template.
Additional flags to specify to C preprocessor when scanning header for function declarations. Should not be used without -x.
-M regular expression
selects functions/macros to process.
Allows a pre-existing extension directory to be overwritten.
Omit the autogenerated stub POD section.
Omit the XS portion. Used to generate templates for a module which is not XS-based. -c and -f are implicitly enabled.
Generate an accessor method for each element of structs and unions. The generated methods are named after the element name; will return the current value of the element if called without additional arguments; and will set the element to the supplied value (and return the new value) if called with an additional argument. Embedded structures and unions are returned as a pointer rather than the complete structure, to facilitate chained calls.
These methods all apply to the Ptr type for the structure; additionally two methods are constructed for the structure type itself, _to_ptr which returns a Ptr type pointing to the same structure, and a new method to construct and return a new structure, initialised to zeroes.
Omit constant() from the .xs file and corresponding specialised AUTOLOAD from the .pm file.
Turn on debugging messages.
Allows an extension to be created for a header even if that header is not found in standard include directories.
Print the usage, help and version for this h2xs and exit.
For function arguments declared as const, omit the const attribute in the generated XS code.
Experimental: for each variable declared in the header file(s), declare a perl variable of the same name magically tied to the C variable.
Specifies a name to be used for the extension, e.g., -n RPC::DCE
-o regular expression
Use ``opaque'' data type for the C types matched by the regular expression, even if these types are typedef-equivalent to types from typemaps. Should not be used without -x.
This may be useful since, say, types which are typedef-equivalent to integers may represent OS-related handles, and one may want to work with these handles in OO-way, as in $handle-. Use -o . if you want to handle all the typedefed types as opaque types.
The type-to-match is whitewashed (except for commas, which have no whitespace before them, and multiple * which have no whitespace between them).
Specify a prefix which should be removed from the Perl function names, e.g., -p sec_rgy_ This sets up the XS PREFIX keyword and removes the prefix from functions that are autoloaded via the constant() mechanism.
Create a perl subroutine for the specified macros rather than autoload with the constant() subroutine. These macros are assumed to have a return type of char *, e.g., -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid.
Specify a version number for this extension. This version number is added to the templates. The default is 0.01.
Automatically generate XSUBs basing on function declarations in the header file. The package C::Scan should be installed. If this option is specified, the name of the header file may look like NAME1,NAME2. In this case NAME1 is used instead of the specified string, but XSUBs are emitted only for the declarations included from file NAME2 .
Note that some types of arguments/return-values for functions may result in XSUB-declarations/typemap-entries which need hand-editing. Such may be objects which cannot be converted from/to a pointer (like long long), pointers to functions, or arrays. See also the section on LIMITATIONS of -x__
Generates a .pm file which is backwards compatible with the specified perl version.
Extension based on .h and .c files
Suppose that you have some C files implementing some functionality, and the corresponding header files. How to create an extension which makes this functionality accessable in Perl? The example below assumes that the header files are interface_simple.h and interface_hairy.h, and you want the perl module be named as Ext::Ension. If you need some preprocessor directives and/or linking with external libraries, see the flags -F, -L and -l in `` OPTIONS ''.
Find the directory name
The only purpose of this step is to create the needed directories, and let you know the names of these directories. From the output you can see that the directory for the extension is Ext/Ension.
Copy C files
Copy your header files and C files to this directory Ext/Ension.
Create the extension
h2xs looks for header files after changing to the extension directory, so it will find your header files OK .
Archive and test
As usual, run
perl Makefile.PL make dist make make test
It is important to do make dist as early as possible. This way you can easily merge(1) your changes to autogenerated files if you decide to edit your .h files and rerun h2xs.
Do not forget to edit the documentation in the generated .pm file.
Consider the autogenerated files as skeletons only, you may invent better interfaces than what h2xs could guess.
h2xs would not distinguish whether an argument to a C function which is of the form, say, int *, is an input, output, or input/output parameter. In particular, argument declarations of the form
foo(n) int *n should be better rewritten as
foo(n) int if n is an input parameter.
Additionally, h2xs has no facilities to intuit that a function
foo(addr,l) char *addr int l takes a pair of address and length of data at this address, so it is better to rewrite this function as
foo(sv) SV *addr PREINIT: STRLEN len; char *s; CODE: s = SvPV(sv,len); RETVAL = foo(s, len); OUTPUT: RETVAL or alternately