The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Module-Starter-XSimple-v0.0.2
River stage zero No dependents
2 ++
/ Module::Starter::XSimple

NAME

Module::Starter::XSimple - Create XS modules with Module::Starter

VERSION

This document describes Module::Starter::XSimple version v0.0.2

DESCRIPTION

Replacement class for Module::Starter::Simple.

Can be used in two ways:

  • Using the commandline

    Pass as an override class to the module-starter script:

      module-starter --module=[modulename] \
  --class=Module::Starter::XSimple

  • Using a config file

    Create a .module-starter/config file with at least the following:

        author:  your name
    email:   your_address@example.com
    builder: Module::Build
    plugins: Module::Starter::XSimple

    At present, M::S::XSimple only supports Module::Build, because the XS and associated files locations are different between Module::Build and ExtUtils::ModuleMaker.

All methods are replacements or additions to the methods provided by Module::Starter::Simple.

Build_PL_guts

Creates the custom Build.PL file for the generated module.

create_modules

Creates the .PM, .XS, and typemap files for each requested module. Calls the following three subs:

module_guts

Generates the .PM file from skeleton code.

xsmodule_guts

Generates the .XS file from skeleton code.

typemap_guts

Generates the typemap file from skeleton code.

module_path_create

Replacement sub for M::S::Simple routine; permits the caller to set the file extension when creating non .PM files.

rtname

Generate the special e-mail address to use when reporting bugs via rt.cpan.org.

t_guts

Add additional test files.

DEPENDENCIES

  Devel::PPPort
  Module::Starter
  Test::More
  version

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-module-starter-xsimple@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

John Peacock <jpeacock@cpan.org>

LICENCE AND COPYRIGHT

Copyright (c) 2005,2012 John Peacock <jpeacock@cpan.org>. All rights reserved.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.