NAME

XSP - XS++ preprocessor

DOCUMENTATION

See XSpp.pod in the wxPerl distribution.

XSP::Parser METHODS

XSP::Parser::new( file => path )

Create a new XS++ parser.

XSP::Parser::parse

Parse the file data; returns true on success, false otherwise, on failure get_errors will return the list of errors.

XSP::Parser::get_data

Returns a list containing the parsed data. Each item of the list is a subclass of XSP::Parser::Thing

XSP::Parser::get_errors

Returns the parsing errors as an array.

XSP::Parser::Thing

Base class for the parser output.

XSP::Parser::Thing::print

Return a string to be output in the final XS file. Every class must override this method.

XSP::Parser::Raw

Contains data that should be output "as is" in the destination file.

XSP::Parser::Raw::rows

Returns an array reference holding the rows to be output in the final file.

XSP::Parser::Class

A class.

XSP::Parser::Class::cpp_name

Returns the C++ name for the class.

XSP::Parser::Class::perl_name

Returns the Perl name for the class.

XSP::Parser::Class::methods

XSP::Parser::Function

A function; this is also a base class for Method.

XSP::Parser::Function::cpp_name

XSP::Parser::Function::perl_name

XSP::Parser::Function::arguments

XSP::Parser::Function::ret_type

XSP::Parser::Function::code

XSP::typemap

XSP::typemap::type

Returns the XSP::Parser::Type that is used for this typemap.

XSP::typemap::cpp_type()

Returns the C++ type to be used for the local variable declaration.

XSP::typemap::input_code( perl_argument_name, cpp_var_name1, ... )

Code to put the contents of the perl_argument (typically ST(x)) into the C++ variable(s).

XSP::typemap::output_code()

XSP::typemap::call_parameter_code( parameter_name )

XSP::typemap::call_function_code( function_call_code, return_variable )