Cari di Perl 
     Perl User Manual
Daftar Isi ☛
(Sebelumnya) Convert .h C header files to . ...A shell to examine installed m ... (Berikutnya)
Utilities

Convert .h C header files to Perl extensions

Daftar Isi

NAME

h2xs - convert .h C header files to Perl extensions

SYNOPSIS

h2xs [OPTIONS ...] [headerfile ... [extra_libraries]]

h2xs -h|-?|--help

DESCRIPTION

h2xs builds a Perl extension from C header files. The extensionwill 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. Ifmodule_name is not supplied then the name of the first header filewill be used, with the first character capitalized.

If the extension might need extra libraries, they should be includedhere. The extension Makefile.PL will take care of checking whetherthe libraries actually exist and how they should be loaded. The extralibraries should be specified in the form -lm -lposix, etc, just as onthe cc command line. By default, the Makefile.PL will search throughthe library path determined by Configure. That path can be augmentedby including arguments of the form -L/another/library/path in theextra-libraries argument.

In spite of its name, h2xs may also be used to create a skeleton purePerl module. See the -X option.

OPTIONS

  • -A, --omit-autoload

    Omit all autoload facilities. This is the same as -c but alsoremoves the use AutoLoader statement from the .pm file.

  • -B, --beta-version

    Use an alpha/beta style version number. Causes version number tobe "0.00_01" unless -v is specified.

  • -C, --omit-changes

    Omits creation of the Changes file, and adds a HISTORY section tothe POD template.

  • -F, --cpp-flags=addflags

    Additional flags to specify to C preprocessor when scanning header forfunction declarations. Writes these options in the generated Makefile.PLtoo.

  • -M, --func-mask=regular expression

    selects functions/macros to process.

  • -O, --overwrite-ok

    Allows a pre-existing extension directory to be overwritten.

  • -P, --omit-pod

    Omit the autogenerated stub POD section.

  • -X, --omit-XS

    Omit the XS portion. Used to generate a skeleton pure Perl module.-c and -f are implicitly enabled.

  • -a, --gen-accessors

    Generate an accessor method for each element of structs and unions. Thegenerated methods are named after the element name; will return the currentvalue of the element if called without additional arguments; and will setthe element to the supplied value (and return the new value) if called withan additional argument. Embedded structures and unions are returned as apointer rather than the complete structure, to facilitate chained calls.

    These methods all apply to the Ptr type for the structure; additionallytwo methods are constructed for the structure type itself, _to_ptrwhich returns a Ptr type pointing to the same structure, and a newmethod to construct and return a new structure, initialised to zeroes.

  • -b, --compat-version=version

    Generates a .pm file which is backwards compatible with the specifiedperl version.

    For versions < 5.6.0, the changes are. - no use of 'our' (uses 'use vars' instead) - no 'use warnings'

    Specifying a compatibility version higher than the version of perl youare using to run h2xs will have no effect. If unspecified h2xs will defaultto compatibility with the version of perl you are using to run h2xs.

  • -c, --omit-constant

    Omit constant() from the .xs file and corresponding specialisedAUTOLOAD from the .pm file.

  • -d, --debugging

    Turn on debugging messages.

  • -e, --omit-enums=[regular expression]

    If regular expression is not given, skip all constants that are defined ina C enumeration. Otherwise skip only those constants that are defined in anenum whose name matches regular expression.

    Since regular expression is optional, make sure that this switch is followedby at least one other switch if you omit regular expression and have somepending arguments such as header-file names. This is ok:

    1.  h2xs -e -n Module::Foo foo.h
      2.

    This is not ok:

    1.  h2xs -n Module::Foo -e foo.h
      2.

    In the latter, foo.h is taken as regular expression.

  • -f, --force

    Allows an extension to be created for a header even if that header isnot found in standard include directories.

  • -g, --global

    Include code for safely storing static data in the .xs file.Extensions that do no make use of static data can ignore this option.

  • -h, -?, --help

    Print the usage, help and version for this h2xs and exit.

  • -k, --omit-const-func

    For function arguments declared as const, omit the const attribute in thegenerated XS code.

  • -m, --gen-tied-var

    Experimental: for each variable declared in the header file(s), declarea perl variable of the same name magically tied to the C variable.

  • -n, --name=module_name

    Specifies a name to be used for the extension, e.g., -n RPC::DCE

  • -o, --opaque-re=regular expression

    Use "opaque" data type for the C types matched by the regularexpression, even if these types are typedef-equivalent to typesfrom typemaps. Should not be used without -x.

    This may be useful since, say, types which are typedef-equivalentto integers may represent OS-related handles, and one may want to workwith these handles in OO-way, as in $handle->do_something().Use -o . if you want to handle all the typedefed types as opaquetypes.

    The type-to-match is whitewashed (except for commas, which have nowhitespace before them, and multiple * which have no whitespacebetween them).

  • -p, --remove-prefix=prefix

    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 removesthe prefix from functions that are autoloaded via the constant()mechanism.

  • -s, --const-subs=sub1,sub2

    Create a perl subroutine for the specified macros rather than autoloadwith the constant() subroutine. These macros are assumed to have areturn type of char *, e.g.,-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid.

  • -t, --default-type=type

    Specify the internal type that the constant() mechanism uses for macros.The default is IV (signed integer). Currently all macros found during theheader scanning process will be assumed to have this type. Future versionsof h2xs may gain the ability to make educated guesses.

  • --use-new-tests

    When --compat-version (-b) is present the generated tests will useTest::More rather than Test which is the default for versions before5.6.2. Test::More will be added to PREREQ_PM in the generatedMakefile.PL.

  • --use-old-tests

    Will force the generation of test code that uses the older Test module.

  • --skip-exporter

    Do not use Exporter and/or export any symbol.

  • --skip-ppport

    Do not use Devel::PPPort: no portability to older version.

  • --skip-autoloader

    Do not use the module AutoLoader; but keep the constant() functionand sub AUTOLOAD for constants.

  • --skip-strict

    Do not use the pragma strict.

  • --skip-warnings

    Do not use the pragma warnings.

  • -v, --version=version

    Specify a version number for this extension. This version number is addedto the templates. The default is 0.01, or 0.00_01 if -B is specified.The version specified should be numeric.

  • -x, --autogen-xsubs

    Automatically generate XSUBs basing on function declarations in theheader file. The package C::Scan should be installed. If thisoption is specified, the name of the header file may look likeNAME1,NAME2. In this case NAME1 is used instead of the specifiedstring, but XSUBs are emitted only for the declarations included fromfile NAME2.

    Note that some types of arguments/return-values for functions mayresult in XSUB-declarations/typemap-entries which needhand-editing. Such may be objects which cannot be converted from/to apointer (like long long), pointers to functions, or arrays. Seealso the section on LIMITATIONS of -x.

EXAMPLES

  1.  # Default behavior, extension is Rusers
    2.  
  2.  h2xs rpcsvc/rusers
    3.  
  3.  
  4.  # Same, but extension is RUSERS
    5.  
  5.  h2xs -n RUSERS rpcsvc/rusers
    6.  
  6.  
  7.  # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
    8.  
  8.  h2xs rpcsvc::rusers
    9.  
  9.  
  10.  # Extension is ONC::RPC.  Still finds <rpcsvc/rusers.h>
    11.  
  11.  h2xs -n ONC::RPC rpcsvc/rusers
    12.  
  12.  
  13.  # Without constant() or AUTOLOAD
    14.  
  14.  h2xs -c rpcsvc/rusers
    15.  
  15.  
  16.  # Creates templates for an extension named RPC
    17.  
  17.  h2xs -cfn RPC
    18.  
  18.  
  19.  # Extension is ONC::RPC.
    20.  
  20.  h2xs -cfn ONC::RPC
    21.  
  21.  
  22.  # Extension is a pure Perl module with no XS code.
    23.  
  23.  h2xs -X My::Module
    24.  
  24.  
  25.  # Extension is Lib::Foo which works at least with Perl5.005_03.
    26.  
  26.  # Constants are created for all #defines and enums h2xs can find
    27.  
  27.  # in foo.h.
    28.  
  28.  h2xs -b 5.5.3 -n Lib::Foo foo.h
    29.  
  29.  
  30.  # Extension is Lib::Foo which works at least with Perl5.005_03.
    31.  
  31.  # Constants are created for all #defines but only for enums
    32.  
  32.  # whose names do not start with 'bar_'.
    33.  
  33.  h2xs -b 5.5.3 -e '^bar_' -n Lib::Foo foo.h
    34.  
  34.  
  35.  # Makefile.PL will look for library -lrpc in
    36.  
  36.  # additional directory /opt/net/lib
    37.  
  37.  h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
    38.  
  38.  
  39.  # Extension is DCE::rgynbase
    40.  
  40.  # prefix "sec_rgy_" is dropped from perl function names
    41.  
  41.  h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
    42.  
  42.  
  43.  # Extension is DCE::rgynbase
    44.  
  44.  # prefix "sec_rgy_" is dropped from perl function names
    45.  
  45.  # subroutines are created for sec_rgy_wildcard_name and
    46.  
  46.  # sec_rgy_wildcard_sid
    47.  
  47.  h2xs -n DCE::rgynbase -p sec_rgy_ \
    48.  
  48.  -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
    49.  
  49.  
  50.  # Make XS without defines in perl.h, but with function declarations
    51.  
  51.  # visible from perl.h. Name of the extension is perl1.
    52.  
  52.  # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
    53.  
  53.  # Extra backslashes below because the string is passed to shell.
    54.  
  54.  # Note that a directory with perl header files would
    55.  
  55.  #  be added automatically to include path.
    56.  
  56.  h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
    57.  
  57.  
  58.  # Same with function declaration in proto.h as visible from perl.h.
    59.  
  59.  h2xs -xAn perl2 perl.h,proto.h
    60.  
  60.  
  61.  # Same but select only functions which match /^av_/
    62.  
  62.  h2xs -M '^av_' -xAn perl2 perl.h,proto.h
    63.  
  63.  
  64.  # Same but treat SV* etc as "opaque" types
    65.  
  65.  h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
    66.

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 whichmakes this functionality accessible in Perl? The example belowassumes that the header files are interface_simple.h andinterface_hairy.h, and you want the perl module be named asExt::Ension. If you need some preprocessor directives and/orlinking with external libraries, see the flags -F, -L and -lin OPTIONS.

  • Find the directory name

    Start with a dummy run of h2xs:

    1.   h2xs -Afn Ext::Ension
      2.

    The only purpose of this step is to create the needed directories, andlet you know the names of these directories. From the output you cansee 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

    Run h2xs, overwriting older autogenerated files:

    1.   h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
      2.

    h2xs looks for header files after changing to the extensiondirectory, so it will find your header files OK.

  • Archive and test

    As usual, run

    1.   cd Ext/Ension
      2.  
    2.   perl Makefile.PL
      3.  
    3.   make dist
      4.  
    4.   make
      5.  
    5.   make test
      6.
  • Hints

    It is important to do make dist as early as possible. This way youcan easily merge(1) your changes to autogenerated files if you decideto 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 inventbetter interfaces than what h2xs could guess.

    Consider this section as a guideline only, some other options of h2xsmay better suit your needs.

ENVIRONMENT

No environment variables are used.

AUTHOR

Larry Wall and others

SEE ALSO

perl, perlxstut, ExtUtils::MakeMaker, and AutoLoader.

DIAGNOSTICS

The usual warnings if it cannot read or write the files involved.

LIMITATIONS of -x

h2xs would not distinguish whether an argument to a C functionwhich is of the form, say, int *, is an input, output, orinput/output parameter. In particular, argument declarations of theform

  1.  int
    2.  
  2.  foo(n)
    3.  
  3. int *n
    4.

should be better rewritten as

  1.  int
    2.  
  2.  foo(n)
    3.  
  3. int &n
    4.

if n is an input parameter.

Additionally, h2xs has no facilities to intuit that a function

  1.    int
    2.  
  2.    foo(addr,l)
    3.  
  3. char *addr
    4.  
  4. int   l
    5.

takes a pair of address and length of data at this address, so it is betterto rewrite this function as

  1.  int
    2.  
  2.  foo(sv)
    3.  
  3.  SV *addr
    4.  
  4. PREINIT:
    5.  
  5.  STRLEN len;
    6.  
  6.  char *s;
    7.  
  7. CODE:
    8.  
  8.  s = SvPV(sv,len);
    9.  
  9.  RETVAL = foo(s, len);
    10.  
  10. OUTPUT:
    11.  
  11.  RETVAL
    12.

or alternately

  1.  static int
    2.  
  2.  my_foo(SV *sv)
    3.  
  3.  {
    4.  
  4. STRLEN len;
    5.  
  5. char *s = SvPV(sv,len);
    6.  
  6.  
  7. return foo(s, len);
    8.  
  8.  }
    9.  
  9.  
  10.  MODULE = fooPACKAGE = fooPREFIX = my_
    11.  
  11.  
  12.  int
    13.  
  13.  foo(sv)
    14.  
  14. SV *sv
    15.

See perlxs and perlxstut for additional details.

Page index
 
Source : perldoc.perl.org - Official documentation for the Perl programming language
Site maintained by Jon Allen (JJ)     See the project page for more details
Documentation maintained by the Perl 5 Porters
(Sebelumnya) Convert .h C header files to . ...A shell to examine installed m ... (Berikutnya)