SPVM::Document::ExchangeAPI - SPVM Exchange API
SPVM Exchange API is APIs to convert Perl data structures to/from SPVM data structures, and call SPVM Method from Perl.
If you load SVPM module from Perl, use the following syntax.
use SPVM 'Foo';
Suppose the following SPVM/Foo.spvm is placed on a module search path.
SPVM/Foo.spvm
# SPVM/Foo.spvm class Foo { static method sum : int ($x1 : int, $x2 : int) { return $x1 + $x2; } }
If you load SPVM Foo::Bar module, do the following.
Foo::Bar
use SPVM 'Foo::Bar';
Suppose the following SPVM/Foo/Bar.spvm is placed on a module search path.
SPVM/Foo/Bar.spvm
# SPVM/Foo/Bar.spvm class Foo::Bar { static method sum : int ($x1 : int, $x2 : int) { return $x1 + $x2; } }
use SPVM MODULE_NAME compile the SPVM module and the dependent modules.
use SPVM MODULE_NAME
Note that at this point a SPVM runtime has not yet been created.
A default SPVM runtime is created the first time you call a method of SPVM module or call a function or method of the Exchange API.
The method of SPVM module can be called from Perl directory.
Let's call SPVM class method from Perl.
use SPVM 'Foo'; my $total = SPVM::Foo->sum(1, 2);
The definition of Foo module is the following.
Foo
If the number of arguments does not match the number of arguments of the SPVM method, an exception occurs.
The Perl values of the arguments are converted to the SPVM values by the rule of argument convertion.
If the type is non-conforming, an exception occurs.
The SPVM return value is converted to a Perl return value by the rule of return value convertion.
The SPVM exception is converted to a Perl exception.
Let's call SPVM instance method from Perl.
use SPVM 'Foo'; my $foo = SPVM::Foo->new; my $total = $foo->sum(1, 2);
# SPVM/Foo.spvm class Foo { static method new : Foo () { return new Foo; } method sum : int ($x1 : int, $x2 : int) ( return $x1 + $x2; } }
Perl arguments are converted to SPVM arguments in the following rules.
If the count of given arguments is less than the count of the arguments of the method, an exception occurs.
If the count of given arguments is more than the count of the arguments of the method, an exception occurs.
If the SPVM argument type is byte, Perl scalar is converted to SPVM byte value using SvIV of perlapi
byte
The conversion logic is
(int8_t)SvIV(perl_scalar)
Example:
# SPVM method definition class My { static method foo : void ($value : byte) { ... } } # Perl SPVM::My->foo(12);
If the SPVM argument type is short, Perl scalar is converted to SPVM short value using SvIV of perlapi
short
(int16_t)SvIV(perl_scalar)
# SPVM method definition class My { static method foo : void ($value : short) { ... } } # Perl SPVM::My->foo(12);
If the SPVM argument type is int, Perl scalar is converted to SPVM int value using SvIV of perlapi
int
(int32_t)SvIV(perl_scalar)
# SPVM method definition class My { static method foo : void ($value : int) { ... } } # Perl SPVM::My->foo(12);
If the SPVM argument type is long, Perl scalar is converted to SPVM long value using SvIV of perlapi
long
(int64_t)SvIV(perl_scalar)
# SPVM method definition class My { static method foo : void ($value : long) { ... } } # Perl SPVM::My->foo(12);
If the SPVM argument type is float, Perl scalar is converted to SPVM float value using SvNV of perlapi
float
(float)SvNV(perl_scalar)
# SPVM method definition class My { static method foo : void ($value : float) { ... } } # Perl SPVM::My->foo(1.2);
If the SPVM argument type is double, Perl scalar is converted to SPVM double value using SvNV of perlapi
double
(double)SvNV(perl_scalar)
# SPVM method definition class My { static method foo : void ($value : double) { ... } } # Perl SPVM::My->foo(1.2);
If the SPVM argument type is string, the given Perl scalar is converted by the following rules.
string
If any of the following rules does not match, an exception occurs.
If the SPVM argument type is string, the given Perl non-ref scalar is converted to SPVM::BlessedObject::String object.
The given non-ref scalar value is assumed to a Perl decoded string, and is converted to UTF-8 bytes.
If the given non-ref scalar value is Perl undef, it is converted to Perl undef.
undef
And the following "Perl SPVM::BlessedObject::String to SPVM String" conversion is contined.
# SPVM method definition class My { static method foo : void ($value : string) { ... } } # Perl SPVM::My->foo("あいう");
No conversion occurs.
Perl can have SPVM string itself as SPVM::BlessedObject::String object. This object is created by such as "new_string", "new_string_from_bin", or got as a return value of SPVM method.
If the given value is Perl undef, it is converted to SPVM undef
# SPVM method definition class My { static method foo : void ($value : string) { ... } } # Perl my $string = SPVM::new_string("あいう"); SPVM::My->foo($string);
Perl can have SPVM class object itself as a object which inherits SPVM::BlessedObject::Class. This object is created by a contructor such as SPVM::Int->new, SPVM::MyClass->new.
If the given value is Perl undef, it is converted to SPVM undef.
If class name is different, an exception occurs.
# SPVM method definition class My { static method foo : void ($value : SPVM::Int) { ... } } # Perl my $value = SPVM::Int->new(5); SPVM::My->foo($value);
Perl can have SPVM object itself as a SPVM::BlessedObject object. This object is created by a contructor or functions of exchange API such as SPVM::Int->new, SPVM::MyClass->new, SPVM::new_int_array.
# SPVM method definition class My { static method foo : void ($value : object) { ... } } # Perl my $value = SPVM::Int->new(5); SPVM::My->foo($value);
A Perl array reference is converted to a SPVM array by the following rules.
If the SPVM argument type is byte[], the Perl array reference is converted to SPVM array which type is byte[]. Each element is converted to byte value by the rule of Perl scalar to SPVM byte. Perl undef is coverted to SPVM undef.
byte[]
# SPVM method definition class My { static method foo : void ($values : byte[]) { ... } } # Perl SPVM::My->foo([1, 2, 3]);
If the SPVM argument type is short[], the Perl array reference is converted to SPVM array which type is short[]. Each element is converted to short value by the rule of Perl Scalar to SPVM short. Perl undef is coverted to SPVM undef.
short[]
# SPVM method definition class My { static method foo : void ($values : short[]) { ... } } # Perl SPVM::My->foo([1, 2, 3]);
If the SPVM argument type is int[], the Perl array reference is converted to SPVM array which type is int[]. Each element is converted to int value by the rule of Perl scalar to SPVM int. Perl undef is coverted to SPVM undef.
int[]
# SPVM method definition class My { static method foo : void ($values : int[]) { ... } } # Perl SPVM::My->foo([1, 2, 3]);
If the SPVM argument type is long[], the Perl array reference is converted to SPVM array which type is long[]. Each element is converted to long value by the rule of Perl scalar to SPVM long. Perl undef is coverted to SPVM undef.
long[]
# SPVM method definition class My { static method foo : void ($values : long[]) { ... } } # Perl SPVM::My->foo([1, 2, 3]);
If the SPVM argument type is float[], the Perl array reference is converted to SPVM array which type is float[]. Each element is converted to float value by the rule of Perl scalar to SPVM float. Perl undef is coverted to SPVM undef.
float[]
# SPVM method definition class My { static method foo : void ($values : float[]) { ... } } # Perl SPVM::My->foo([1.2, 2.3, 3.4]);
If the SPVM argument type is double[], the Perl array reference is converted to SPVM array which type is double[]. Each element is converted to double value by the rule of Perl scalar to SPVM double. Perl undef is coverted to SPVM undef.
double[]
# SPVM method definition class My { static method foo : void ($values : double[]) { ... } } # Perl SPVM::My->foo([1.2, 2.3, 3.4]);
If the SPVM argument type is string[], the Perl array reference is converted to SPVM array which type is string[]. Each element is converted to string value by the rule of Perl scalar to SPVM string. Perl undef is coverted to SPVM undef.
string[]
# SPVM method definition class My { static method foo : void ($values : string[]) { ... } } # Perl SPVM::My->foo(["あい", "うえ", "お"]);
If the SPVM argument type is a array of multi-numeric type, the given Perl array reference is converted to SPVM multi-numeric array which element type is multi-numeric type. Each element which is a hash reference is converted to multi-numeric type by the rule of Perl hash reference to SPVM multi-numeric type. Perl undef is coverted to SPVM undef.
# SPVM method definition class My { static method foo : void ($values : Complex_2d[]) { ... } } # Perl SPVM::My->foo([{re => 1.2, im => 2.3}, {re => 3.4, im => 4.5}]);
Perl can have SPVM array itself as SPVM::BlessedObject::Array object. This object is created by such as "new_byte_array", "new_short_array", "new_int_array", "new_long_array", "new_float_array", "new_double_array", or got as a return value of SPVM method.
# SPVM method definition class My { static method foo : void ($values : int[]) { ... } } # Perl my $array = SPVM::new_int_array([1, 2, 3]); SPVM::My->foo($array);
If the SPVM argument type is a multi-numeric type, the given argument is converted by the following rules.
If the argument type is a multi-numeric byte type, the given argument is hash reference is converted to the value of SPVM multi-numeric byte type. If the given argument is different from a hash reference, an exception occurs. Each field is converted to byte value by the rule of Perl scalar to SPVM byte.
If a filed is missing, an exception occurs.
# SPVM multi-numeric type and method definition class MyPoint_2b { has x : byte; has y : byte; } class My { static method foo : void ($value : MyPoint_2b); } # Perl SPVM::My->foo({x => 1, y => 2});
If the argument type is a multi-numeric short type, the given argument is hash reference is converted to the value of SPVM multi-numeric short type. If the given argument is different from a hash reference, an exception occurs. Each field is converted to short value by the rule of Perl scalar to SPVM short.
# SPVM multi-numeric type and method definition class MyPoint_2s { has x : short; has y : short; } class My { static method foo : void ($value : MyPoint_2s); } # Perl SPVM::My->foo({x => 1, y => 2});
If the argument type is a multi-numeric int type, the given argument is hash reference is converted to the value of SPVM multi-numeric int type. If the given argument is different from a hash reference, an exception occurs. Each field is converted to int value by the rule of Perl scalar to SPVM int.
# SPVM multi-numeric type and method definition class MyPoint_2i { has x : int; has y : int; } class My { static method foo : void ($value : MyPoint_2i); } # Perl SPVM::My->foo({x => 1, y => 2});
If the argument type is a multi-numeric long type, the given argument is hash reference is converted to the value of SPVM multi-numeric long type. If the given argument is different from a hash reference, an exception occurs. Each field is converted to long value by the rule of Perl scalar to SPVM long.
# SPVM multi-numeric type and method definition class MyPoint_2l { has x : long; has y : long; } class My { static method foo : void ($value : MyPoint_2l); } # Perl SPVM::My->foo({x => 1, y => 2});
If the argument type is a multi-numeric float type, the given argument is hash reference is converted to the value of SPVM multi-numeric float type. If the given argument is different from a hash reference, an exception occurs. Each field is converted to float value by the rule of Perl scalar to SPVM float.
# SPVM multi-numeric type and method definition class MyPoint_2f { has x : float; has y : float; } class My { static method foo : void ($value : MyPoint_2f); } # Perl SPVM::My->foo({x => 1.2, y => 2.3});
If the argument type is a multi-numeric double type, the given argument is hash reference is converted to the value of SPVM multi-numeric double type. If the given argument is different from a hash reference, an exception occurs. Each field is converted to double value by the rule of Perl scalar to SPVM double.
# SPVM multi-numeric type and method definition class MyPoint_2d { has x : double; has y : double; } class My { static method foo : void ($value : MyPoint_2d); } # Perl SPVM::My->foo({x => 1.2, y => 2.3});
If the SPVM argument type is numeric reference type, the given Perl reference is converted to SPVM numeric reference type in the following rules.
If the SPVM argument type is byte reference type, the given Perl reference is converted to SPVM byte reference type.
The given value must be a scalar reference which referenced value is non-ref scalar. Otherwise an exception will occur.
The given value is converted to byte value by the rule of Perl scalar to SPVM byte and return value is converted to Perl scalar by the rule of SPVM byte to Perl Scalar
# SPVM method definition class My { static method foo : void ($value : byte*); } # Perl my $value = 23; SPVM::My->foo(\$value);
If the SPVM argument type is short reference type, the given Perl reference is converted to SPVM short reference type.
The given value is converted to short value by the rule of Perl scalar to SPVM short and return value is converted to Perl scalar by the rule of SPVM short to Perl Scalar
# SPVM method definition class My { static method foo : void ($value : short*); } # Perl my $value = 23; SPVM::My->foo(\$value);
If the SPVM argument type is int reference type, the given Perl reference is converted to SPVM int reference type.
The given value is converted to int value by the rule of Perl scalar to SPVM int and return value is converted to Perl scalar by the rule of SPVM int to Perl Scalar
# SPVM method definition class My { static method foo : void ($value : int*); } # Perl my $value = 23; SPVM::My->foo(\$value);
If the SPVM argument type is long reference type, the given Perl reference is converted to SPVM long reference type.
The given value is converted to long value by the rule of Perl scalar to SPVM long and return value is converted to Perl scalar by the rule of SPVM long to Perl Scalar
# SPVM method definition class My { static method foo : void ($value : long*); } # Perl my $value = 23; SPVM::My->foo(\$value);
If the SPVM argument type is float reference type, the given Perl reference is converted to SPVM float reference type.
The given value is converted to float value by the rule of Perl scalar to SPVM float and return value is converted to Perl scalar by the rule of SPVM float to Perl Scalar
# SPVM method definition class My { static method foo : void ($value : float*); } # Perl my $value = 23.5; SPVM::My->foo(\$value);
If the SPVM argument type is double reference type, the given Perl reference is converted to SPVM double reference type.
The given value is converted to double value by the rule of Perl scalar to SPVM double and return value is converted to Perl scalar by the rule of SPVM double to Perl Scalar
# SPVM method definition class My { static method foo : void ($value : double*); } # Perl my $value = 23.5; SPVM::My->foo(\$value);
If the SPVM argument type is multi-numeric reference type, the given Perl reference is converted by the following rules.
If the SPVM argument type is multi-numeric byte reference type, the given Perl reference is converted to SPVM multi-numeric byte reference type.
The given reference must be a scalar reference of hash reference. Otherwise an exception will occur.
The each field of the hash of the given argument is converted to byte value by the rule of Perl scalar to SPVM byte and the each filed of the return value is converted to Perl scalar by the rule of SPVM byte to Perl Scalar
If a field is missing, an exception occurs.
# SPVM multi-numeric type and method definition class MyPoint_2b { has x : byte; has y : byte; } class My { static method foo : void ($value : MyPoint_2b); } # Perl my $value = {x => 1, y => 2}; SPVM::My->foo(\$value);
If the SPVM argument type is multi-numeric short reference type, the given Perl reference is converted to SPVM multi-numeric short reference type.
The each field of the hash of the given argument is converted to short value by the rule of Perl scalar to SPVM short and the each filed of the return value is converted to Perl scalar by the rule of SPVM short to Perl Scalar
# SPVM multi-numeric type and method definition class MyPoint_2s { has x : short; has y : short; } class My { static method foo : void ($value : MyPoint_2s); } # Perl my $value = {x => 1, y => 2}; SPVM::My->foo(\$value);
If the SPVM argument type is multi-numeric int reference type, the given Perl reference is converted to SPVM multi-numeric int reference type.
The each field of the hash of the given argument is converted to int value by the rule of Perl scalar to SPVM int and the each filed of the return value is converted to Perl scalar by the rule of SPVM int to Perl Scalar
# SPVM multi-numeric type and method definition class MyPoint_2i { has x : int; has y : int; } class My { static method foo : void ($value : MyPoint_2i); } # Perl my $value = {x => 1, y => 2}; SPVM::My->foo(\$value);
If the SPVM argument type is multi-numeric long reference type, the given Perl reference is converted to SPVM multi-numeric long reference type.
The each field of the hash of the given argument is converted to long value by the rule of Perl scalar to SPVM long and the each filed of the return value is converted to Perl scalar by the rule of SPVM long to Perl Scalar
# SPVM multi-numeric type and method definition class MyPoint_2l { has x : long; has y : long; } class My { static method foo : void ($value : MyPoint_2l); } # Perl my $value = {x => 1, y => 2}; SPVM::My->foo(\$value);
If the SPVM argument type is multi-numeric float reference type, the given Perl reference is converted to SPVM multi-numeric float reference type.
The each field of the hash of the given argument is converted to float value by the rule of Perl scalar to SPVM float and the each filed of the return value is converted to Perl scalar by the rule of SPVM float to Perl Scalar
# SPVM multi-numeric type and method definition class MyPoint_2f { has x : float; has y : float; } class My { static method foo : void ($value : MyPoint_2f); } # Perl my $value = {x => 1,2, y => 2.3}; SPVM::My->foo(\$value);
If the SPVM argument type is multi-numeric double reference type, the given Perl reference is converted to SPVM multi-numeric double reference type.
The each field of the hash of the given argument is converted to double value by the rule of Perl scalar to SPVM double and the each filed of the return value is converted to Perl scalar by the rule of SPVM double to Perl Scalar
# SPVM multi-numeric type and method definition class MyPoint_2d { has x : double; has y : double; } class My { static method foo : void ($value : MyPoint_2d); } # Perl my $value = {x => 1.2, y => 2.3}; SPVM::My->foo(\$value);
a SPVM return value is converted to a Perl value by the following rules.
SPVM void return value is converted to Perl undef. This is only for specification and has no meaning.
SPVM byte value(same type as int8_t of C language) is converted to Perl scalar by newSViv function of perlapi.
int8_t spvm_byte_value = VALUE; SV* perl_scalar = newSViv(spvm_byte_value);
SPVM short value(same type as int16_t of C language) is converted to Perl scalar by newSViv function of perlapi.
int16_t spvm_short_value = VALUE; SV* perl_scalar = newSViv(spvm_short_value);
SPVM int value(same type as int32_t of C language) is converted to Perl scalar by newSViv function of perlapi.
int32_t spvm_int_value = VALUE; SV* perl_scalar = newSViv(spvm_int_value);
SPVM long value(same type as int64_t of C language) is converted to Perl scalar by newSViv function of perlapi.
int64_t spvm_long_value = VALUE; SV* perl_scalar = newSViv(spvm_long_value);
SPVM float value(same type as float of C language) is converted to Perl scalar by newSVnv function of perlapi.
float spvm_float_value = VALUE; SV* perl_scalar = newSVnv(spvm_float_value);
SPVM double value(same type as double of C language) is converted to Perl scalar by newSVnv function of perlapi.
double spvm_double_value = VALUE; SV* perl_scalar = newSVnv(spvm_double_value);
SPVM String is converted to a Perl decoded string. If SPVM undef is returned, it is converted to Perl undef.
a SPVM object(not contain array) is converted to a Perl object which class name is same as SPVM class name and inherits SPVM::BlessedObject::Class.
SPVM multi-numeric value is converted to Perl hash reference which keys is the field names of multi-numeric type. The rules of number convertions of the field of multi-numeric value is same as above the numeric convertions(byte, short, int, long, float, double).
a SPVM array is converted to a Perl SPVM::BlessedObject::Array object. If SPVM return value is undef, it is converted to Perl undef.
a SPVM object is converted to a Perl object which class name is same as SPVM class name and inherits SPVM::BlessedObject::Class.
Funtions which create SPVM datas and convert SVPM datas to/from Perl data.
my $spvm_nums = SPVM::new_byte_array([1, 2, 3]);
Convert a Perl array reference to a SPVM byte[] array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
If the first argument is a undef value, the return value is a undef value.
my $spvm_nums = SPVM::new_byte_array_len([1, 2, 3]);
Create a new SPVM byte[] array with length. The values of elements is zeros. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
The lenght must be greater than or equal to zero. Otherwise an exception will occur.
my $perl_binary = pack('c3', 97, 98, 99); my $spvm_byte_array = SPVM::new_byte_array_from_bin($perl_binary);
Convert a Perl Binary Data to SPVM byte[] object. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
Thg Perl binary data is interpreted as 8-bit signed integers. The created array length is automatically calcurated from the Perl binary data.
If the first argument is undef, undef is returned.
You can use simple ascii codes as Perl binary data.
my $perl_binary ="abc"; my $spvm_byte_array = SPVM::new_byte_array_from_bin($perl_binary);
or UTF-8 bytes.
use utf8; my $perl_binary = encode('UTF-8', "あいう"); my $spvm_string = SPVM::new_string_from_bin($perl_binary);
use utf8; my $spvm_byte_array = SPVM::new_byte_array_from_string("あいう");
Convert a decoded string to SPVM byte[] value using utf8::encode. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $spvm_nums = SPVM::new_short_array([1, 2, 3]);
Convert a Perl array reference to a SPVM short[] array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $spvm_nums = SPVM::new_short_array_len($length);
Create a new a SPVM short[] array with length. The values of elements is zeros. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $perl_binary = pack('c3', 97, 98, 99); my $spvm_short_array = SPVM::new_short_array_from_bin($perl_binary);
Convert a Perl Binary Data to SPVM short[] object. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
Thg Perl binary data is interpreted as 16-bit signed integers. The created array length is automatically calcurated from the Perl binary data.
my $spvm_nums = SPVM::new_int_array([1, 2, 3]);
Convert a Perl array reference to a SPVM int[] array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $spvm_nums = SPVM::new_int_array_len($length);
Create a new a SPVM int[] array with length. The values of elements is zeros. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $perl_binary = pack('l3', 97, 98, 99); my $spvm_int_array = SPVM::new_int_array_from_bin($perl_binary);
Convert a Perl Binary Data to SPVM int[] object. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $spvm_nums = SPVM::new_long_array([1, 2, 3]);
Convert a Perl array reference to a SPVM long[] array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $spvm_nums = SPVM::new_long_array_len($length);
Create a new a SPVM long[] array with length. The values of elements is zeros. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $perl_binary = pack('q3', 97, 98, 99); my $spvm_long_array = SPVM::new_long_array_from_bin($perl_binary);
Convert a Perl Binary Data to SPVM long[] object. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
Thg Perl binary data is longerpreted as 8-bit signed longegers. The created array length is automatically calcurated from the Perl binary data.
my $spvm_nums = SPVM::new_float_array([1.2, 2.5, 3.3]);
Convert a Perl array reference to a SPVM float[] array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $spvm_nums = SPVM::new_float_array_len($length);
Create a new a SPVM float[] array with length. The values of elements is zeros. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $perl_binary = pack('f3', 0.5, 1.5, 2.5); my $spvm_float_array = SPVM::new_float_array_from_bin($perl_binary);
Convert a Perl Binary Data to SPVM float[] object. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
Thg Perl binary data is floaterpreted as 8-bit signed floategers. The created array length is automatically calcurated from the Perl binary data.
my $spvm_nums = SPVM::new_double_array([1.2, 2.5, 3.3]);
Convert a Perl array reference to a SPVM double[] array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $spvm_nums = SPVM::new_double_array_len($length);
Create a new a SPVM double[] array with length. The values of elements is zeros. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
my $perl_binary = pack('f3', 0.5, 1.5, 2.5); my $spvm_double_array = SPVM::new_double_array_from_bin($perl_binary);
Convert a Perl Binary Data to SPVM double[] object. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
Thg Perl binary data is doubleerpreted as 8-bit signed doubleegers. The created array length is automatically calcurated from the Perl binary data.
use utf8; my $spvm_string = SPVM::new_string("あいう");
Convert a Perl string to a SPVM string.
If the argument is undef, undef is returned.
my $perl_binary = pack('c3', 97, 98, 99); my $spvm_string = SPVM::new_string_from_bin($perl_binary);
Convert a Perl Binary Data to SPVM string object. Return value is SPVM::BlessedObject::String object which wraps the SPVM string.
Thg Perl binary data is interpreted as 8-bit signed integers. The string length is automatically calcurated from the Perl binary data.
my $binary ="abc"; my $spvm_string = SPVM::new_string_from_bin($perl_binary);
my $byte_array = SPVM::new_any_object_array( [SPVM::Byte->new(1), SPVM::Byte>new(2), SPVM::Byte->new(3)] );
The alias for the following code using "new_object_array".
my $spvm_array = SPVM::new_object_array('object[]', $perl_array_ref);
my $byte_array = SPVM::new_object_array( "SPVM::Byte[]", [SPVM::Byte->new(1), SPVM::Byte>new(2), SPVM::Byte->new(3)] );
Convert a Perl array reference to a SPVM object array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
The first argument is a SPVM array type name. If the type is non-existent, an exception occurs.
The second argument is a Perl array reference. Each element must be valid value or undef. Otherwise an exception will occur.
Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
You can also create multidimensional array.
my $object1 = SPVM::new_int_array([1, 2, 3]); my $object2 = SPVM::new_int_array([4, 5, 6]); my $objects = SPVM::new_object_array("int[][]",[$object1, $object2]);
Convert a Perl array references to SPVM multi-numeric array.
my $perl_values = [ {x => 0, y => 1, z => 2}, {x => 3, y => 4, z => 5}, {x => 6, y => 7, z => 8}, ]; my $spvm_mulnum_array = SPVM::new_mulnum_array("TestCase::Point_3i[]", $perl_values);
The second argument is a Perl array of hash references. Each hash reference must be contain all fields of the multi-numeric value. Otherwise an exception will occur.
Examples:
# new_mulnum_array - byte { my $values = [ {x => 0, y => 1, z => 2}, {x => 3, y => 4, z => 5}, {x => 6, y => 7, z => 8}, ]; my $spvm_mulnum_array = SPVM::new_mulnum_array("TestCase::Point_3b[]", $values); } # new_mulnum_array - short { my $values = [ {x => 0, y => 1, z => 2}, {x => 3, y => 4, z => 5}, {x => 6, y => 7, z => 8}, ]; my $spvm_mulnum_array = SPVM::new_mulnum_array("TestCase::Point_3s[]",$values); } # new_mulnum_array - int { my $values = [ {x => 0, y => 1, z => 2}, {x => 3, y => 4, z => 5}, {x => 6, y => 7, z => 8}, ]; my $spvm_mulnum_array = SPVM::new_mulnum_array("TestCase::Point_3i[],$values); } # new_mulnum_array - long { my $values = [ {x => 0, y => 1, z => 2}, {x => 3, y => 4, z => 5}, {x => 6, y => 7, z => 8}, ]; my $spvm_mulnum_array = SPVM::new_mulnum_array("TestCase::Point_3l[]", $values); } # new_mulnum_array - float { my $values = [ {x => 0, y => 1, z => 2}, {x => 3, y => 4, z => 5}, {x => 6, y => 7, z => 8}, ]; my $spvm_mulnum_array = SPVM::new_mulnum_array("TestCase::Point_3f[]",$values); } # new_mulnum_array - double { my $values = [ {x => 0, y => 1, z => 2}, {x => 3, y => 4, z => 5}, {x => 6, y => 7, z => 8}, ]; my $spvm_mulnum_array = SPVM::new_mulnum_array("TestCase::Point_3d[],"$values); ok(SPVM::TestCase::ExchangeAPI-spvm_new_mulnum_array_double($spvm_mulnum_array)); my $out_values = $spvm_mulnum_array->to_elems; is_deeply($out_values, $values); }
my $binary = pack('l9', ($INT_MIN, 1, 2), (3, 4, 5), (6, 7, 8)); my $spvm_mulnum_array = SPVM::new_mulnum_array_from_bin("TestCase::Point_3i[]", $binary);
Convert Perl a binary data to SPVM Multi Numeric Array. Return value is SPVM::BlessedObject::Array object which wraps the SPVM array.
The first argument is a multi-numeric array type of SPVM.
The second argument is the Perl packed binary data. The length of the created array is calcurated automatically.
# new_mulnum_array_from_bin - byte { my $binary = pack('c9', (0, 1, 2), (3, 4, 5), (6, 7, 8)); my $spvm_mulnum_array = SPVM::new_mulnum_array_from_bin("TestCase::Point_3b[]", $binary); } # new_mulnum_array_from_bin - short { my $binary = pack('s9', (0, 1, 2), (3, 4, 5), (6, 7, 8);; my $spvm_mulnum_array = SPVM::new_mulnum_array_from_bin("TestCase::Point_3s[]", $binary); } # new_mulnum_array_from_bin - int { my $binary = pack('l9', (0, 1, 2), (3, 4, 5), (6, 7, 8)); my $spvm_mulnum_array = SPVM::new_mulnum_array_from_bin("TestCase::Point_3i[]", $binary); } # new_mulnum_array_from_bin - long { my $binary = pack('q9', (0, 1, 2), (3, 4, 5), (6, 7, 8)); my $spvm_mulnum_array = SPVM::new_mulnum_array_from_bin("TestCase::Point_3l[]", $binary); } # new_mulnum_array_from_bin - float { my $binary = pack('f9', (0, 1, 2), (3, 4, 5), (6, 7, 8)); my $spvm_mulnum_array = SPVM::new_mulnum_array_from_bin("TestCase::Point_3f[]", $binary); } # new_mulnum_array_from_bin - double { my $binary = pack('d9', (0, 1, 2), (3, 4, 5), (6, 7, 8)); my $spvm_mulnum_array = SPVM::new_mulnum_array_from_bin("TestCase::Point_3d[]", $binary); }
my $exception = SPVM::get_exception();
Get the exception of the SPVM runtime environment as SPVM::BlessedObject::String object.
Set a SPVM exception of the SPVM runtime environment.
The argument must be a SPVM::BlessedObject::String object, a decoded string or undef. Otherwise an exception will occur.
SPVM::set_exception(SPVM::new_string("abc")); SPVM::set_exception("abc"); SPVM::set_exception(undef);
my $count = SPVM::get_memory_blocks_count();
Get the count of created memory blocks. SPVM runtime create a memory block on the heap when a object is created or new week reference is created.
You can check the memory leaks by this method.
# First Memory Blocks Count my $start_memory_blocks_count = SPVM::get_memory_blocks_count(); # Processing # ... # Last Memory Blocks Count my $end_memory_blocks_count = SPVM::get_memory_blocks_count(); unless ($end_memory_blocks_count == $start_memory_blocks_count) { die"Memroy leak"; }
To install SPVM, copy and paste the appropriate command in to your terminal.
cpanm
cpanm SPVM
CPAN shell
perl -MCPAN -e shell install SPVM
For more information on module installation, please visit the detailed CPAN module installation guide.