wx::xsp::xspp(3) [osx man page]

build::Wx::XSP::XSpp(3) 				User Contributed Perl Documentation				   build::Wx::XSP::XSpp(3)

NAME

       XSpp - XS for C++

SYNOPSIS

       In Foo.xs (all in one line):

	 INCLUDE: perl -S wxperl_xspp --typemap=typemap.xsp
		  Foo.xsp |

OVERVIEW

       XS++ is just a thin layer over plain XS, hence to use it you are supposed to know, at the very least, C++ and XS.

       This means that you will need typemaps for both xsubpp and xsubppp.

TYPEMAPS

       There is nothing special about typemap files (i.e. you can put typemaps directly in your .xsp file), but it is handy to have common
       typemaps in a separate file, to avoid duplication.

	 %typemap{<C++ type>}{simple};

       Just let XS++ that this is a valid type, the type will be passed unchanged to XS code except that any "const" qualifiers will be stripped.

	 %typemap{<C++ type 1>}{parsed}{%<C++ type 2>%};

       When "C++ type 1" is used, replace it with "C++ type 2" in the generated XS code.

	 %typemap{<C++ reference type>}{reference};

       Handle C++ references: the XS variable will be declared as a pointer, and it will be explicitly dereferenced in the function call. If it is
       used in the return value, the function will create copy of the returned value using a copy constructor.

DESCRIPTION

       Anything that does not look like a XS++ directive or a class declaration is passed verbatim to XS. If you want XS++ to ignore code that
       looks like a XS++ directive or class declaration, simply surround it with a raw block delimiter like this:

	 %{
	 XS++ won't interpret this
	 %}

       %code

       See under Classes.

       %file

	 %file{file/path.h};
	 ...
	 %file{file/path2};
	 ...
	 %file{-}

       By default XS++ output goes to standard output; to change this, use the %file directive; use "-" for standard output.

       %module

	 %module{Module__Name};

       Will be used to generate the "MODULE=Module__Name" XS directives.

       %name

	 %name{Perl::Class} class MyClass { ... };
	 %name{Perl::Func} int foo();

       Specifies the perl name under which the C++ class/function will be accessible.

       %typemap

       See TYPEMAPS above.

       Classes

	 %name{My::Class} class MyClass
	 {
	     // can be called in Perl as My::Class->new( ... );
	     MyClass( int arg );
	     // My::Class->newMyClass( ... );
	     %name{newMyClass} MyClass( const char* str, int arg );

	     // standard DESTROY method
	     ~MyClass();

	     int GetInt();
	     void SetValue( int arg = -1 );

	     %name{SetString} void SetValue( const char* string = NULL );

	     // Supply a C<CODE:> or C<CLEANUP:> block for the XS
	     int MyMethod( int a, int b )
		 %code{% RETVAL = a + b; %}
		 %cleanup{% /* do something */ %};
	 };

perl v5.10.0							    2008-01-21						   build::Wx::XSP::XSpp(3)

XSUBPP(1)						 Perl Programmers Reference Guide						 XSUBPP(1)

NAME

       xsubpp - compiler to convert Perl XS code into C code

SYNOPSIS

       xsubpp [-v] [-except] [-s pattern] [-prototypes] [-noversioncheck] [-nolinenumbers] [-nooptimize] [-typemap typemap] [-output filename]...
       file.xs

DESCRIPTION

       This compiler is typically run by the makefiles created by ExtUtils::MakeMaker.

       xsubpp will compile XS code into C code by embedding the constructs necessary to let C functions manipulate Perl values and creates the
       glue necessary to let Perl access those functions.  The compiler uses typemaps to determine how to map C function parameters and variables
       to Perl values.

       The compiler will search for typemap files called typemap.  It will use the following search path to find default typemaps, with the right-
       most typemap taking precedence.

	       ../../../typemap:../../typemap:../typemap:typemap

       It will also use a default typemap installed as "ExtUtils::typemap".

OPTIONS

       Note that the "XSOPT" MakeMaker option may be used to add these options to any makefiles generated by MakeMaker.

       -hiertype
	    Retains '::' in type names so that C++ hierarchical types can be mapped.

       -except
	    Adds exception handling stubs to the C code.

       -typemap typemap
	    Indicates that a user-supplied typemap should take precedence over the default typemaps.  This option may be used multiple times, with
	    the last typemap having the highest precedence.

       -output filename
	    Specifies the name of the output file to generate.	If no file is specified, output will be written to standard output.

       -v   Prints the xsubpp version number to standard output, then exits.

       -prototypes
	    By default xsubpp will not automatically generate prototype code for all xsubs. This flag will enable prototypes.

       -noversioncheck
	    Disables the run time test that determines if the object file (derived from the ".xs" file) and the ".pm" files have the same version
	    number.

       -nolinenumbers
	    Prevents the inclusion of `#line' directives in the output.

       -nooptimize
	    Disables certain optimizations.  The only optimization that is currently affected is the use of targets by the output C code (see
	    perlguts).	This may significantly slow down the generated code, but this is the way xsubpp of 5.005 and earlier operated.

       -noinout
	    Disable recognition of "IN", "OUT_LIST" and "INOUT_LIST" declarations.

       -noargtypes
	    Disable recognition of ANSI-like descriptions of function signature.

       -C++ Currently doesn't do anything at all.  This flag has been a no-op for many versions of perl, at least as far back as perl5.003_07.
	    It's allowed here for backwards compatibility.

ENVIRONMENT

       No environment variables are used.

AUTHOR

       Originally by Larry Wall.  Turned into the "ExtUtils::ParseXS" module by Ken Williams.

MODIFICATION HISTORY

       See the file Changes.

SEE ALSO

       perl(1), perlxs(1), perlxstut(1), ExtUtils::ParseXS

perl v5.8.9							    2009-04-13								 XSUBPP(1)