Main class. More...

Public Member Functions
	Perl (bool do_init=true)
	Default constructor. More...

	Perl (Perl &&to_move)
	Move constructor.

	~Perl ()
	Destructor.

Creating Perl variables
Scalar	newScalar ()
	Create anonymous empty scalar.

Scalar	newNamedScalar (const std::string &name)
	Create empty scalar as `$name`. More...

template<typename ValueT >
Scalar	newScalar (const ValueT &value)
	Create anonymous scalar and set value. More...

template<typename ValueT >
Scalar	newNamedScalar (const std::string &name, const ValueT &value)
	Create scalar as `$name` and set value. More...

Array	newArray ()
	Create anonymous empty array. More...

Array	newArray (IV begin, IV end)
	Create anonymous array fill with integers. More...

Array	newNamedArray (const std::string &name)
	Create empty array as `@name`. More...

Array	newNamedArray (const std::string &name, IV begin, IV end)
	Create array as `@name` array fill with integers. More...

template<typename ValueT >
Array	newArray (const std::vector< ValueT > &values)
	Create anonymous array and fill. More...

template<typename ValueT >
Array	newArray (const std::initializer_list< ValueT > &values)

template<typename ValueT >
Array	newNamedArray (const std::string &name, const std::vector< ValueT > &values)
	Create array as `@name` and fill. More...

template<typename ValueT >
Array	newNamedArray (const std::string &name, const std::initializer_list< ValueT > &values)

Hash	newHash ()
	Create anonymous empty hash. More...

Hash	newNamedHash (const std::string &name)
	Create empty hash as `%name`. More...

template<typename ValueT >
Hash	newHash (const std::unordered_map< std::string, ValueT > &map)
	Create anonymous hash and fill. More...

template<typename ValueT >
Hash	newNamedHash (const std::string &name, const std::unordered_map< std::string, ValueT > &map)
	Create hash as `%name` and fill. More...

Scalar	newObject (const std::string &class_name)
	Create new object. More...

Scalar	newObject (const std::string &class_name, const Scalar &param)
	Create new object. More...

Scalar	newObject (const std::string &class_name, const Array &params)
	Create new object. More...

Getting Perl variables
Scalar	getScalar (const std::string &name)
	Get scalar by name. More...

Array	getArray (const std::string &name)
	Get array by name. More...

Hash	getHash (const std::string &name)
	Get hash by name. More...

Code	getSubroutine (const std::string &name)
	Get subroutine by name. More...

Code	getMethod (const std::string &name)
	Get class method by name. More...

ScalarPtr	getScalarPtr (const std::string &name)
	Place scalar reference in heap. More...

ArrayPtr	getArrayPtr (const std::string &name)
	Place array reference in heap. More...

HashPtr	getHashPtr (const std::string &name)
	Place hash reference in heap. More...

CodePtr	getSubroutinePtr (const std::string &name)
	Place subroutine reference in heap. More...

Call Perl code
template<typename ReturnT = void>
ReturnT	eval (const std::string &code)
	Evaluate string in generic context. More...

template<typename ReturnT , typename ParamT >
ReturnT	call (const std::string &sub_name, const ParamT &param)
	Call subroutine in generic context. More...

template<typename ReturnT = void>
ReturnT	call (const std::string &sub_name)

template<typename ReturnT , typename ParamT >
ReturnT	call (const Code &subroutine, const ParamT &param)

template<typename ReturnT = void>
ReturnT	call (const Code &subroutine)

template<typename ReturnT , typename ParamT >
ReturnT	callMethod (const std::string &sub_name, const Scalar &object, const ParamT &param)
	Call method in generic context. More...

template<typename ReturnT = void>
ReturnT	callMethod (const std::string &sub_name, const Scalar &object)

template<typename ReturnT , typename ParamT >
ReturnT	callMethod (const Code &subroutine, const Scalar &object, const ParamT &param)

template<typename ReturnT = void>
ReturnT	callMethod (const Code &subroutine, const Scalar &object)

C++ callbacks
Perl &	registerVoidToVoid (const std::string &name, priv::Callbacks::VoidToVoidCB function)

Perl &	registerVoidToScalar (const std::string &name, priv::Callbacks::VoidToScalarCB function)

Perl &	registerScalarToVoid (const std::string &name, priv::Callbacks::ScalarToVoidCB function)

Perl &	registerScalarToScalar (const std::string &name, priv::Callbacks::ScalarToScalarCB function)

CV *	registerStatic (const std::string &sub_name, XSUBADDR_t function)

Misc
Perl &	init ()
	Initialize the Perl interpreter. More...

Perl &	lib (const std::string &path)
	Add folder to module search path. More...

Perl &	use (const std::string &name)
	Import a module. More...

Perl &	no (const std::string &name)
	Unload a module. More...

Perl &	require (const std::string &name)
	Load external file. More...

Perl &	setExceptionsEnabled (bool state)
	Enable/disable all exceptions. Default: enabled.

Perl &	setWarningsEnabled (bool state)
	Enable/disable all warnings. Default: disabled.

bool	hasError () const
	Check Perl error. More...

std::string	getError () const

Internals
int	getId () const
	Perl object id. More...

PerlInterpreter *	getInterpreter () const
	Raw interpreter.

SV *	getNamedSV (const std::string &name) const
	Get raw scalar by name. More...

AV *	getNamedAV (const std::string &name) const
	Get raw array by name. More...

HV *	getNamedHV (const std::string &name) const
	Get raw hash by name. More...

CV *	getNamedCV (const std::string &name) const
	Get raw subroutine by name. More...

std::string	deparse (const Code &code)
	Convert subroutine to string using B::Deparse.

Perl &	setContext ()
	Set interpreter context. More...

Operators
VariablePtr	operator[] (std::string query)
	Universal operator. More...

Static Public Member Functions
static Perl &	getInstanceById (int perl_id)
	Get Perl instance by object id.

static Perl &	getInstance (PerlInterpreter *_interpreter)
	Get Perl instance by associated interpreter. More...

Detailed Description

Main class.

Definition at line 32 of file perl.hpp.

Constructor & Destructor Documentation

Perl ( bool do_init = true )

Default constructor.

Parameters

do_init Calls init()

Definition at line 14 of file perl.cpp.

Member Function Documentation

Scalar newNamedScalar ( const std::string & name )

Create empty scalar as $name.

Perl equivalent: $scalar = ""

Definition at line 56 of file perl.cpp.

Scalar newScalar ( const ValueT & value )

Create anonymous scalar and set value.

See also: Scalar::setValue()

Definition at line 6 of file perl.hpp.

Scalar newNamedScalar	(	const std::string &	name,
		const ValueT &	value
	)

Create scalar as $name and set value.

Perl equivalent: $scalar = value

See also: Scalar::setValue()

Definition at line 15 of file perl.hpp.

Array newArray ( )

Create anonymous empty array.

Perl equivalent: ()

Definition at line 61 of file perl.cpp.

Array newArray	(	IV	begin,
		IV	end
	)

Create anonymous array fill with integers.

Perl equivalent: (begin .. end)

Definition at line 66 of file perl.cpp.

Array newNamedArray ( const std::string & name )

Create empty array as @name.

Perl equivalent: @array = ()

Definition at line 78 of file perl.cpp.

Array newNamedArray	(	const std::string &	name,
		IV	begin,
		IV	end
	)

Create array as @name array fill with integers.

Perl equivalent: $array = (begin .. end)

Array newArray ( const std::vector< ValueT > & values )

Create anonymous array and fill.

Perl equivalent: (values)

See also: Scalar::setValue()

Definition at line 56 of file perl.hpp.

Array newNamedArray	(	const std::string &	name,
		const std::vector< ValueT > &	values
	)

Create array as @name and fill.

Perl equivalent: $array = (values)

See also: Scalar::setValue()

Definition at line 76 of file perl.hpp.

Hash newHash ( )

Create anonymous empty hash.

Perl equivalent: ()

Definition at line 83 of file perl.cpp.

Hash newNamedHash ( const std::string & name )

Create empty hash as %name.

Perl equivalent: %hash = ()

Definition at line 88 of file perl.cpp.

Hash newHash ( const std::unordered_map< std::string, ValueT > & map )

Create anonymous hash and fill.

Perl equivalent: (key => value)

Definition at line 114 of file perl.hpp.

Hash newNamedHash	(	const std::string &	name,
		const std::unordered_map< std::string, ValueT > &	map
	)

Create hash as %name and fill.

Perl equivalent: %hash = (key => value)

Definition at line 127 of file perl.hpp.

Scalar newObject ( const std::string & class_name )

Create new object.

Perl equivalent: Classname->new()

Definition at line 93 of file perl.cpp.

Scalar newObject	(	const std::string &	class_name,
		const Scalar &	param
	)

Create new object.

Perl equivalent: Classname->new($param)

Definition at line 98 of file perl.cpp.

Scalar newObject	(	const std::string &	class_name,
		const Array &	params
	)

Create new object.

Perl equivalent: Classname->new(@params)

Definition at line 103 of file perl.cpp.

Scalar getScalar ( const std::string & name )

Get scalar by name.

Perl equivalent: $name

Exceptions

PerlException Undefined symbol

Definition at line 110 of file perl.cpp.

Array getArray ( const std::string & name )

Get array by name.

Perl equivalent: @name

Exceptions

PerlException Undefined symbol

Definition at line 115 of file perl.cpp.

Hash getHash ( const std::string & name )

Get hash by name.

Perl equivalent: %name

Exceptions

PerlException Undefined symbol

Definition at line 120 of file perl.cpp.

Code getSubroutine ( const std::string & name )

Get subroutine by name.

Perl equivalent: &name

Exceptions

PerlException Undefined symbol

Definition at line 125 of file perl.cpp.

Code getMethod ( const std::string & name )

Get class method by name.

Perl equivalent: &Na::me

Definition at line 130 of file perl.cpp.

ScalarPtr getScalarPtr ( const std::string & name )

Place scalar reference in heap.

See also: Pointer

Exceptions

PerlException Undefined symbol

Definition at line 135 of file perl.cpp.

ArrayPtr getArrayPtr ( const std::string & name )

Place array reference in heap.

See also: Pointer

Exceptions

PerlException Undefined symbol

Definition at line 140 of file perl.cpp.

HashPtr getHashPtr ( const std::string & name )

Place hash reference in heap.

See also: Pointer

Exceptions

PerlException Undefined symbol

Definition at line 145 of file perl.cpp.

CodePtr getSubroutinePtr ( const std::string & name )

Place subroutine reference in heap.

See also: Pointer

Exceptions

PerlException Undefined symbol

Definition at line 150 of file perl.cpp.

ReturnT eval ( const std::string & code )

Evaluate string in generic context.

Template Parameters

ReturnT

void (default)
Scalar
Array

Example: eval("code") // eval("code")
Scalar result = eval<Scalar>("code") // $result = eval("code")
Array result = eval<Array>("code") // @result = eval("code")

Exceptions

PerlException Syntax error or die()

ReturnT call	(	const std::string &	sub_name,
		const ParamT &	param
	)

Call subroutine in generic context.

Template Parameters

ReturnT	void (default) Scalar Array
ParamT	Scalar Array

Example: call("sub_name"); // sub_name()
call("sub_name", Scalar); // sub_name($param)
call("sub_name", Array); // sub_name(@params)
Scalar result = call<Scalar>("sub_name"); // $result = sub_name()
Scalar result = call<Scalar, Scalar>("sub_name", Scalar); // $result = sub_name($param)
Scalar result = call<Scalar, Array> ("sub_name", Array); // $result = sub_name(@params)
Array result = call<Array>("sub_name"); // $result = sub_name()
Array result = call<Array, Scalar>("sub_name", Scalar); // $result = sub_name($param)
Array result = call<Array, Array>("sub_name", Array); // $result = sub_name(@params)

Exceptions

PerlException	Undefined subroutine
PerlException	Syntax error or die()

ReturnT callMethod	(	const std::string &	sub_name,
		const Scalar &	object,
		const ParamT &	param
	)

Call method in generic context.

See also: call()

Exceptions

PerlException	Undefined subroutine
PerlException	Syntax error or die()

Perl & init ( )

Initialize the Perl interpreter.

Exceptions

PerlException Initialization error

Definition at line 157 of file perl.cpp.

Perl & lib ( const std::string & path )

Add folder to module search path.

Perl equivalent: use lib 'path'

Definition at line 187 of file perl.cpp.

Perl & use ( const std::string & name )

Import a module.

Perl equivalent: use Module

Exceptions

PerlException Syntax error or die()

Definition at line 193 of file perl.cpp.

Perl & no ( const std::string & name )

Unload a module.

Perl equivalent: no Module

Definition at line 212 of file perl.cpp.

Perl & require ( const std::string & name )

Load external file.

Perl equivalent: require Module
require 'file.pl'

Exceptions

PerlException Syntax error or die()

Definition at line 218 of file perl.cpp.

bool hasError ( ) const

Check Perl error.

Perl equivalent: $@

Definition at line 247 of file perl.cpp.

int getId ( ) const

Perl object id.

Starts from 0

Definition at line 298 of file perl.cpp.

SV * getNamedSV ( const std::string & name ) const

Get raw scalar by name.

Exceptions

PerlException Undefined symbol

Definition at line 308 of file perl.cpp.

AV * getNamedAV ( const std::string & name ) const

Get raw array by name.

Exceptions

PerlException Undefined symbol

Definition at line 313 of file perl.cpp.

HV * getNamedHV ( const std::string & name ) const

Get raw hash by name.

Exceptions

PerlException Undefined symbol

Definition at line 318 of file perl.cpp.

CV * getNamedCV ( const std::string & name ) const

Get raw subroutine by name.

Exceptions

PerlException Undefined symbol

Definition at line 323 of file perl.cpp.

Perl & setContext ( )

Set interpreter context.

If something segfaults, try place it before

Definition at line 351 of file perl.cpp.

VariablePtr operator[] ( std::string query )

Universal operator.

Example: ScalarPtr var = perl["$name"];
ArrayPtr var = perl["@name"];
HashPtr var = perl["%name"];
CodePtr var = perl["&name"];

Exceptions

PerlException Undefined symbol

Definition at line 381 of file perl.cpp.

Perl & getInstance ( PerlInterpreter * _interpreter )

static

Get Perl instance by associated interpreter.

Useful in XS

Definition at line 362 of file perl.cpp.

The documentation for this class was generated from the following files:

include/yobaperl/perl.hpp
src/perl.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation