SPVM::Document::NativeAPI - SPVM Native APIs
The SPVM native APIs are public APIs that are used in native language sources such as C/C++.
C/C++
The native APIs are writen in C language, but the languages that have compatibility of C language such as <C++>, CUDA/nvcc can call the native APIs.
C language
CUDA/nvcc
The native APIs is used when native methods are implemented.
Native APIs have its IDs. These IDs are permanently same for the binary compatibility after the future release v1.0.
v1.0
0 class_vars_heap 1 object_header_byte_size 2 object_weaken_backref_head_offset 3 object_ref_count_offset 4 object_basic_type_id_offset 5 object_type_dimension_offset 6 object_type_category_offset 7 object_flag_offset 8 object_length_offset 9 api 10 allocator 11 new_env_raw 12 free_env_raw 13 check_runtime_assignability 14 check_runtime_assignability_array_element 15 runtime 16 reserved16 17 reserved17 18 reserved18 19 reserved19 20 get_basic_type_id 21 get_field_id 22 get_field_offset 23 get_class_var_id 24 get_class_method_id 25 get_instance_method_id 26 new_object_raw 27 new_object 28 new_byte_array_raw 29 new_byte_array 30 new_short_array_raw 31 new_short_array 32 new_int_array_raw 33 new_int_array 34 new_long_array_raw 35 new_long_array 36 new_float_array_raw 37 new_float_array 38 new_double_array_raw 39 new_double_array 40 new_object_array_raw 41 new_object_array 42 new_muldim_array_raw 43 new_muldim_array 44 new_mulnum_array_raw 45 new_mulnum_array 46 new_string_nolen_raw 47 new_string_nolen 48 new_string_raw 49 new_string 50 new_pointer_raw 51 new_pointer 52 concat_raw 53 concat 54 new_stack_trace_raw 55 new_stack_trace 56 length 57 get_elems_byte 58 get_elems_short 59 get_elems_int 60 get_elems_long 61 get_elems_float 62 get_elems_double 63 get_elem_object 64 set_elem_object 65 get_field_byte 66 get_field_short 67 get_field_int 68 get_field_long 69 get_field_float 70 get_field_double 71 get_field_object 72 set_field_byte 73 set_field_short 74 set_field_int 75 set_field_long 76 set_field_float 77 set_field_double 78 set_field_object 79 get_class_var_byte 80 get_class_var_short 81 get_class_var_int 82 get_class_var_long 83 get_class_var_float 84 get_class_var_double 85 get_class_var_object 86 set_class_var_byte 87 set_class_var_short 88 set_class_var_int 89 set_class_var_long 90 set_class_var_float 91 set_class_var_double 92 set_class_var_object 93 get_pointer 94 set_pointer 95 call_spvm_method 96 get_exception 97 set_exception 98 get_ref_count 99 inc_ref_count 100 dec_ref_count 101 enter_scope 102 push_mortal 103 leave_scope 104 remove_mortal 105 is_type 106 is_object_array 107 get_object_basic_type_id 108 get_object_type_dimension 109 weaken 110 isweak 111 unweaken 112 alloc_memory_block_zero 113 free_memory_block 114 get_memory_blocks_count 115 get_type_name_raw 116 get_type_name 117 new_env 118 free_env 119 memory_blocks_count 120 get_chars 121 die 122 new_object_by_name 123 new_pointer_by_name 124 set_field_byte_by_name 125 set_field_short_by_name 126 set_field_int_by_name 127 set_field_long_by_name 128 set_field_float_by_name 129 set_field_double_by_name 130 set_field_object_by_name 131 get_field_byte_by_name 132 get_field_short_by_name 133 get_field_int_by_name 134 get_field_long_by_name 135 get_field_float_by_name 136 get_field_double_by_name 137 get_field_object_by_name 138 set_class_var_byte_by_name 139 set_class_var_short_by_name 140 set_class_var_int_by_name 141 set_class_var_long_by_name 142 set_class_var_float_by_name 143 set_class_var_double_by_name 144 set_class_var_object_by_name 145 get_class_var_byte_by_name 146 get_class_var_short_by_name 147 get_class_var_int_by_name 148 get_class_var_long_by_name 149 get_class_var_float_by_name 150 get_class_var_double_by_name 151 get_class_var_object_by_name 152 call_class_method_by_name 153 call_instance_method_by_name 154 get_field_string_chars_by_name 155 free_env_prepared 156 dump_raw 157 dump 158 call_class_method 159 call_instance_method 160 get_instance_method_id_static 161 get_bool_object_value 162 cleanup_global_vars 163 make_read_only 164 is_read_only 165 is_array 166 is_string 167 is_numeric_array 168 is_mulnum_array 169 get_elem_byte_size 170 new_array_proto_raw 171 new_array_proto 172 copy_raw 173 copy 174 shorten 175 has_interface 176 get_method_id_cache 177 get_field_id_cache 178 get_class_var_id_cache 179 print 180 print_stderr 181 init_env, 182 call_init_blocks
void* class_vars_heap;
the pointer to the storage area of the class variables. This is used internally.
void* object_header_byte_size;
The byte size of the object's header. This is used internally.
void* object_weaken_backref_head_offset;
Offset to a pointer to the back reference of the weak reference in the object structure. This is used internally.
void* object_ref_count_offset;
Reference count offset in the object structure. This is used internally.
void* object_basic_type_id_offset;
Offset of basic type ID in object structure. This is used internally.
void* object_type_dimension_offset;
Offset of type dimension in object structure. This is used internally.
void* object_type_category_offset;
Offset of runtime type category in object structure. This is used internally.
This value is always NULL, because SPVM 0.9511+, this value is any more used.
NULL
void* object_flag_offset;
Offset of flag in object structure. This is used internally.
void* object_length_offset;
The length offset in the object structure. This is used internally.
void* api;
The environment of APIs such as compiler native APIs, precompile native APIs, runtime native APIs, string buffer native APIs, allocator native APIs.
Examples:
// Compiler native APIs void* compiler_api = env->api->compiler; // Precompile native APIs void* precompile_api = env->api->precompile; // Runtime native APIs void* runtime_api = env->api->runtime; // String buffer native APIs void* string_buffer_api = env->api->string_buffer; // Allocator native APIs void* allocator_api = env->api->allocator;
void* allocator;
The memory allocator for this environment.
SPVM_ENV* (*new_env_raw)();
Create a new raw envriment.
void (*free_env_raw)(SPVM_ENV* env);
Free the raw environemt that is created by "new_env_raw".
int32_t (*check_runtime_assignability)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t cast_basic_type_id, int32_t cast_type_dimension, void* object);
Check the runtime type assignability of an object.
int32_t (*check_runtime_assignability_array_element)(SPVM_ENV* env, SPVM_VALUE* stack, void* array, void* element);
Check the runtime type assignability of an array element.
void* runtime;
A pointer to the runtime information. This is used internally.
void* reserved16;
Reserved.
void* reserved17;
void* reserved18;
void* reserved19;
int32_t (*get_basic_type_id)(SPVM_ENV* env, const char* basic_type_name);
Get the ID of the base type given the name of the base type. If it does not exist, a value less than 0 is returned.
int32_t basic_type_id = env->get_basic_type_id(env, "Int");
int32_t (*get_field_id)(SPVM_ENV* env, const char* class_name, const char* field_name, const char* signature);
Get the ID of the field given the class name, field name, and signature. If the field does not exist, a value less than 0 is returned.
The signature is the same as the field type name.
int32_t field_id = env->get_field_id(env, "Foo", "x", "int");
int32_t (*get_field_offset)(SPVM_ENV* env, int32_t field_id);
Gets the offset of the field given the field ID. The field ID must be a valid field ID obtained with the field_id function.
int32_t (*get_class_var_id)(SPVM_ENV* env, const char* class_name, const char* class_var_name, const char* signature);
Get the class variable ID given the class name, class variable name and signature. If the class variable does not exist, a value less than 0 is returned.
The signature is the same as the class variable type name.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "int");
int32_t (*get_class_method_id)(SPVM_ENV* env, const char* class_name, const char* method_name, const char* signature);
Get a class method ID by the class name, the method name, and the method signature. If the class method does not exists, a negative value is returned.
This ID is used by "call_class_method".
The method signature has the following format.
ReturnValueType(ArgumentType1,ArgumentType2,...)
int32_t method_id = env->get_class_method_id(env, "Foo", "get", "int(long,string)");
int32_t (*get_instance_method_id)(SPVM_ENV* env, void* object, const char* method_name, const char* signature);
Get a instance method ID by the object, the method name, and the method signatre. If the instance method does not exist, a negative value is returned.
This ID is used by "call_instance_method".
The method signature has the following format,
int32_t method_id = env->get_instance_method_id(env, object, "get", "int(long,string)");
void* (*new_object_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id);
Create a new object with a basic type ID. The basic type ID must be the correct base type ID return by get_basic_type_id function.
get_basic_type_id
void* (*new_object)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id);
Do the same as new_object_raw, and add the created object to the mortal stack of the environment. Use this function in normal use instead of new_object_raw.
new_object_raw
int32_t basic_type_id = env->get_basic_type_id(env, "Int"); void* object = env->new_object(env, stack, basic_type_id);
void* (*new_byte_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Create a new byte[] type array by specifying the length.
void* (*new_byte_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Do the same as new_byte_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_byte_array_raw.
new_byte_array_raw
void* byte_array = env->new_byte_array(env, stack, 100);
void* (*new_short_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Create a new short[] type array by specifying the length.
void* (*new_short_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Do the same as new_short_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_short_array_raw.
new_short_array_raw
void* short_array = env->new_short_array(env, stack, 100);
void* (*new_int_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Create a new int[] type array by specifying the length.
void* (*new_int_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Do the same as new_int_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_int_array_raw.
new_int_array_raw
void* int_array = env->new_int_array(env, stack, 100);
void* (*new_long_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Create a new long[] type array by specifying the length.
void* (*new_long_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Do the same as new_long_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_long_array_raw.
new_long_array_raw
void* long_array = env->new_long_array(env, stack, 100);
void* (*new_float_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Create a new float[] type array by specifying the length.
void* (*new_float_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Do the same as new_float_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_float_array_raw.
new_float_array_raw
void* float_array = env->new_float_array(env, stack, 100);
void* (*new_double_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Create a new double[] type array by specifying the length.
void* (*new_double_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);
Do the same as new_double_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_double_array_raw.
new_double_array_raw
void* double_array = env->new_double_array(env, stack, 100);
void* (*new_object_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);
Create a new object type array by specifying the basic type ID and the array length. The basic type ID must be the correct basic type ID got by get_basic_type_id function.
void* (*new_object_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);
Do the same as new_object_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_object_array_raw.
new_object_array_raw
int32_t basic_type_id = env->get_basic_type_id(env, "Int"); void* object_array = env->new_object_array(env, stack, basic_type_id, 100);
void* (*new_muldim_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t element_dimension, int32_t length);
Create a new multi dimension array by specifying the basic type ID, the type dimension of the element, and the array length. The basic type ID must be the correct basic type ID got bu get_basic_type_id function. the type dimension of the element must be less than or equals to 255.
Do the same as new_muldim_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_muldim_array_raw.
new_muldim_array_raw
// new Int[][][100] int32_t basic_type_id = env->get_basic_type_id(env, "Int"); void* multi_array = env->new_muldim_array(env, stack, basic_type_id, 2, 100);
void* (*new_mulnum_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);
Create a new multi-numeric array by specifying the basic type ID and the array length. The basic type ID must be the correct basic type ID got by basic_type_id function.
basic_type_id
void* (*new_mulnum_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);
Do the same as new_mulnum_array_raw, and add the created array to the mortal stack of the environment. Use this function in normal use instead of new_mulnum_array_raw.
new_mulnum_array_raw
int32_t basic_type_id = env->get_basic_type_id(env, "Complex_2d"); void* value_array = env->new_mulnum_array(env, stack, basic_type_id, 100);
void* (*new_string_nolen_raw)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes);
Create a new string object by specifying C language char* type value. this value must end with "\0".
void* (*new_string_nolen)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes);
Do the same as new_string_nolen_raw, and add the created string object to the mortal stack of the environment. Use this function in normal use instead of new_string_nolen_raw.
new_string_nolen_raw
void* str_obj = env->new_string_nolen(env, stack, "Hello World");
void* (*new_string_raw)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes, int32_t length);
Create a new string object with the bytes and the length.
If the length of bytes is lower than the specified length or the bytes is NULL, The part that longer than the length of bytes will be filled with \0.
\0
void* (*new_string)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes, int32_t length);
Same as new_string_raw, and add the created string object to the mortal stack of the environment. Usually use this function instead of new_string_raw.
new_string_raw
void* str_obj = env->new_string(env, stack, "Hello \0World", 11);
void* (*new_pointer_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, void* pointer);
Create a pointer type object by specifying a basic type ID and a C language pointer. The basic type ID must be the correct basic type ID got by get_basic_type_id function.
void* (*new_pointer)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, void* pointer);
Do the same as new_pointer_raw, and add the created string object to the mortal stack of the environment. Use this function in normal use instead of new_pointer_raw.
new_pointer_raw
int32_t basic_type_id = env->get_basic_type_id(env, "MyTime"); void* pointer = malloc(sizeof (struct tm)); void* pointer_obj = env->new_pointer(env, stack, basic_type_id, pointer);
void* (*concat_raw)(SPVM_ENV* env, SPVM_VALUE* stack, void* string1, void* string2);
Concat two strings.
void* (*concat)(SPVM_ENV* env, SPVM_VALUE* stack, void* string1, void* string2);
Do the same as concat_raw, and add the created string object to the mortal stack of the environment. Use this function in normal use instead of concat_raw.
concat_raw
void* (*new_stack_trace_raw)(SPVM_ENV* env, SPVM_VALUE* stack, void* exception, int32_t method_id, int32_t line);
Create a string object that represents a stack trace by adding the file and line the method is called to the end of the exception message.
void* (*new_stack_trace)(SPVM_ENV* env, SPVM_VALUE* stack, void* exception, int32_t method_id, int32_t line);
Same as "new_stack_trace_raw", and push the created object to the mortal stack.
int32_t (*length)(SPVM_ENV*, void* array);
If you specify an array, the length of the array is returned.
int32_t length = env->length(env, stack, array);
int8_t* (*get_elems_byte)(SPVM_ENV* env, SPVM_VALUE* stack, void* array);
If you specify a byte[] type array, the pointer at the beginning of the internally stored C language int8_t[] type array is returned.
int8_t* values = env->get_elems_byte(env, stack, array); values[3] = 5;
int16_t* (*get_elems_short)(SPVM_ENV* env, SPVM_VALUE* stack, void* array);
If a short[] type array is specified, the pointer at the beginning of the internally stored C language int16_t[] type array is returned.
int16_t* values = env->get_elems_short(env, stack, array); values[3] = 5;
int32_t* (*get_elems_int)(SPVM_ENV* env, SPVM_VALUE* stack, void* array);
When an int[] type array is specified, the pointer at the beginning of the internally stored C language int32_t[] type array is returned.
int32_t* values = env->get_elems_int(env, stack, array); values[3] = 5;
int64_t* (*get_elems_long)(SPVM_ENV* env, SPVM_VALUE* stack, void* array);
When a long[] type array is specified, the pointer at the beginning of the internally stored C language int64_t[] type array is returned.
int64_t* values = env->get_elems_long(env, stack, array); values[3] = 5;
float* (*get_elems_float)(SPVM_ENV* env, SPVM_VALUE* stack, void* array);
When a float[] type array is specified, the pointer at the beginning of the C language float[] type array internally held is returned.
float* values = env->get_elems_float(env, stack, array); values[3] = 1.5f;
double* (*get_elems_double)(SPVM_ENV* env, SPVM_VALUE* stack, void* array);
If a double[] type array is specified, the pointer at the beginning of the internally stored C double[] type array is returned.
double* values = env->get_elems_double(env, stack, array); values[3] = 1.5;
void* (*get_elem_object)(SPVM_ENV* env, SPVM_VALUE* stack, void* array, int32_t index);
Gets an object of an element given an array of object types and a methodscript. If the element is a weak reference, the weak reference is removed.
void* object = env->get_elem_object(env, stack, array, 3);
void (*set_elem_object)(SPVM_ENV* env, SPVM_VALUE* stack, void* array, int32_t index, void* value);
If you specify an array of object type and methodscript and element objects, the element object is assigned to the corresponding methodscript position. If the element's object has a weak reference, the weak reference is removed. The reference count of the originally assigned object is decremented by 1.
env->get_elem_object(env, stack, array, 3, object);
int8_t (*get_field_byte)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id);
If an object and field ID are specified, the byte field value will be returned as a C language int8_t type value. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "byte"); int8_t field_value = env->get_field_byte(env, stack, object, field_id);
int16_t (*get_field_short)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id);
If you specify the object and field ID, the value of the short type field will be returned as the int16_t type value of C language. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "short"); int16_t field_value = env->get_field_short(env, stack, object, field_id);
int32_t (*get_field_int)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id);
If an object and a field ID are specified, the value of the int type field will be returned as a C language int32_t type value. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "int"); int32_t field_value = env->get_field_int(env, stack, object, field_id);
int64_t (*get_field_long)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id);
If you specify the object and field ID, the value of the long type field will be returned as the value of int64_t type of C language. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "long"); int64_t field_value = env->get_field_long(env, stack, object, field_id);
float (*get_field_float)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id);
If you specify the object and field ID, the value of the float type field will be returned as a C language float type value. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "float"); float field_value = env->get_field_float(env, stack, object, field_id);
double (*get_field_double)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id);
If you specify the object and field ID, the value of the double type field will be returned as a double type value in C language. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "double"); double field_value = env->get_field_double(env, stack, object, field_id);
void* (*get_field_object)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id);
If you specify the object and field ID, the value of the object type field is returned as a void* type value in C language. The field ID must be a valid field ID obtained with the field_id function. If the field is a weak reference, it will be removed.
int32_t field_id = env->get_field_id(env, "Foo", "x", "Int"); void* field_value = env->get_field_object(env, stack, object, field_id);
void (*set_field_byte)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, int8_t value);
If you specify the object and field ID and the value of the field, the value is set to the byte type field. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "byte"); int8_t field_value = 5; env->set_field_byte(env, stack, object, field_id, field_value);
void (*set_field_short)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, int16_t value);
If you specify the object and field ID and the value of the field, the value is set to the short type field. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "short"); int16_t field_value = 5; env->set_field_short(env, stack, object, field_id, field_value);
void (*set_field_int)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, int32_t value);
If you specify the object and field ID and the value of the field, the value is set to the int type field. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "int"); int32_t field_value = 5; env->set_field_int(env, stack, object, field_id, field_value);
void (*set_field_long)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, int64_t value);
If you specify the object and field ID and the value of the field, the value is set to the long type field. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "long"); int64_t field_value = 5; env->set_field_long(env, stack, object, field_id, field_value);
void (*set_field_float)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, float value);
If you specify the object and field ID and the value of the field, the value is set to the float type field. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "float"); float field_value = 1.5f; env->set_field_float(env, stack, object, field_id, field_value);
void (*set_field_double)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, double value);
If you specify the object and field ID and the value of the field, the value is set to the double type field. The field ID must be a valid field ID obtained with the field_id function.
int32_t field_id = env->get_field_id(env, "Foo", "x", "double"); double field_value = 1.55; env->set_field_double(env, stack, object, field_id, field_value);
void (*set_field_object)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, void* value);
Object and field Specify the ID and the value of the field and set the value to the object type field. The field ID must be a valid field ID obtained with the field_id function. After setting, the reference count is incremented by 1. The original value has the reference count decremented by 1.
int32_t field_id = env->get_field_id(env, "Foo", "x", "Int"); int32_t basic_type_id = env->get_basic_type_id(env, "Int"); void* object = env->new_object(env, stack, basic_type_id); env->set_field_object(env, stack, object, field_id, object);
int8_t (*get_class_var_byte)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id);
If an object and a class variable ID are specified, the value of the byte type class variable is returned as a C language int8_t type value. The class variable ID must be a valid class variable ID obtained with the field_id function.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "byte"); int8_t pkgvar_value = env->get_class_var_byte(env, stack, object, pkgvar_id);
int16_t (*get_class_var_short)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id);
If an object and a class variable ID are specified, the value of the short type class variable will be returned as a C language int16_t type value. The class variable ID must be a valid class variable ID obtained with the field_id function.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "short"); int16_t pkgvar_value = env->get_class_var_short(env, stack, object, pkgvar_id);
int32_t (*get_class_var_int)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id);
If an object and a class variable ID are specified, the value of the int type class variable will be returned as a C language int32_t type value. The class variable ID must be a valid class variable ID obtained with the field_id function.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "int"); int32_t pkgvar_value = env->get_class_var_int(env, stack, object, pkgvar_id);
int64_t (*get_class_var_long)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id);
If an object and a class variable ID are specified, the value of the long type class variable will be returned as a C language int64_t type value. The class variable ID must be a valid class variable ID obtained with the field_id function.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "long"); int64_t pkgvar_value = env->get_class_var_long(env, stack, object, pkgvar_id);
float (*get_class_var_float)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id);
If an object and a class variable ID are specified, the value of the float type class variable will be returned as a C language float type value. The class variable ID must be a valid class variable ID obtained with the field_id function.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "float"); float pkgvar_value = env->get_class_var_float(env, stack, object, pkgvar_id);
double (*get_class_var_double)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id);
If you specify an object and a class variable ID, the value of the double type class variable is returned as a C type double type value. The class variable ID must be a valid class variable ID obtained with the field_id function.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "double"); double pkgvar_value = env->get_class_var_double(env, stack, object, pkgvar_id);
void* (*get_class_var_object)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id);
When an object and a class variable ID are specified, the value of the object type class variable is returned as a C language void* type value. The class variable ID must be a valid class variable ID obtained with the field_id function.
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "Int"); void* pkgvar_value = env->get_class_var_byte(env, stack, object, pkgvar_id);
void (*set_class_var_byte)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id, int8_t value);
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "byte"); int8_t pkgvar_value = 5; env->set_class_var_byte(env, stack, pkgvar_id, pkgvar_value);
void (*set_class_var_short)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id, int16_t value);
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "short"); int16_t pkgvar_value = 5; env->set_class_var_short(env, stack, pkgvar_id, pkgvar_value);
void (*set_class_var_int)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id, int32_t value);
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "int"); int32_t pkgvar_value = 5; env->set_class_var_int(env, stack, pkgvar_id, pkgvar_value);
void (*set_class_var_long)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id, int64_t value);
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "long"); int64_t pkgvar_value = 5; env->set_class_var_long(env, stack, pkgvar_id, pkgvar_value);
void (*set_class_var_float)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id, float value);
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "float"); float pkgvar_value = 5; env->set_class_var_float(env, stack, pkgvar_id, pkgvar_value);
void (*set_class_var_double)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id, double value);
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "double"); double pkgvar_value = 5; env->set_class_var_double(env, stack, pkgvar_id, pkgvar_value);
void (*set_class_var_object)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t pkgvar_id, void* value);
int32_t pkgvar_id = env->get_class_var_id(env, "Foo", "$VAR", "Int"); int32_t basic_type_id = env->get_basic_type_id(env, "Int"); void* object = env->new_object(env, stack, basic_type_id); env->set_class_var_object(env, stack, pkgvar_id, pkgvar_value);
void* (*get_pointer)(SPVM_ENV* env, SPVM_VALUE* stack, void* pointer_object);
Specify a pointer type object and return the C language pointer stored inside the object.
strcut tm* tm_ptr = (struct tm*) env->get_pointer(env, stack, tm_obj);
void (*set_pointer)(SPVM_ENV* env, SPVM_VALUE* stack, void* pointer_object, void* pointer);
If you specify a pointer type object and a C language pointer, the C language pointer is saved in the internal data of the pointer type object.
int32_t (*call_spvm_method)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t method_id);
Call a method by specifying the method ID and argument. If an exception occurs in the method, The return value is 1. If not, return 0.
The return value of the method is set to args[0].
void* (*get_exception)(SPVM_ENV* env, SPVM_VALUE* stack);
Get a exception message which type is byte[].
void (*set_exception)(SPVM_ENV* env, SPVM_VALUE* stack, void* exception);
Set a exception message which type is byte[].
int32_t (*get_ref_count)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Get the refernce count of the object.
void (*inc_ref_count)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Specifying an object increments the reference count of the object.
Use this method only if you have a specific reason to use it. Normally, the reference count is managed automatically.
void (*dec_ref_count)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Specifying an object decrements the object's reference count by 1. When the reference count reaches 0, the object is released.
int32_t (*enter_scope)(SPVM_ENV* env, SPVM_VALUE* stack);
Create a new scope and return the scope ID.
int32_t (*push_mortal)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Add an object to the mortal stack.
If this method succeed, return 0.
If this method don't alloc memory for new mortal information, return 1.
void (*leave_scope)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t scope_id);
Specify a scope ID to exit that scope and decrement the object's reference count stored in the mortal stack. Objects with a reference count of 0 are released. The scope ID must be the ID obtained by the enter_scope function.
int32_t (*remove_mortal)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t scope_id, void* remove_object);
Given a scope ID and an object, delete the specified object from the mortal stack.
int32_t (*is_type)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t basic_type_id, int32_t type_dimension);
Given an object and a base type ID and a type dimension, returns a nonzero value if the object matches both the base type ID and the type dimension, and 0 otherwise.
int32_t (*is_object_array)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
If the object is a object array, returns 1, otherwise returns 0.
1
0
If the object is NULL, returns 0.
int32_t (*get_object_basic_type_id)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Gets the base type ID of the object.
int32_t (*get_object_type_dimension)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Gets the dimension of the type of object.
int32_t (*weaken)(SPVM_ENV* env, SPVM_VALUE* stack, void** object_address);
Create weak reference to the object which is specified by object address.
The reference count of the object is decrimented by 1 and weaken flag is added to the object address.
If the reference count is 1, "dec_ref_count" is called to the object.
If object_address is NULL, this method do nothing.
If the object is already weaken, this method do nothing.
This method allocate memory internally to add the back reference from the object to the object address.
This method success return 0.
If failing memory allocation of back reference, return 1.
int32_t (*isweak()SPVM_ENV* env, void** object);
Given the address of an object, returns non-zero if the object is a weak reference, 0 otherwise.
void (*unweaken)(SPVM_ENV* env, SPVM_VALUE* stack, void** object_address);
Specifying the address of the object releases the weak reference to the object.
void* (*alloc_memory_block_zero)(SPVM_ENV* env, int64_t byte_size);
If you specify the size in bytes, the memory block is allocated and the pointer of the allocated memory block is returned. If fail to alloc memory, return NULL. If success, all bits in the memory block are initialized with 0 and the memory block count (memory_blocks_count)is incremented by 1.
void (*free_memory_block)(SPVM_ENV* env, void* block);
If block is not NULL, free the memory and memory blocks count(memory_blocks_count) is decremented by 1.
int32_t (*get_memory_blocks_count)(SPVM_ENV* env);
Returns the current number of memory blocks of thie environment.
The memory block is increased by 1 when an object is created, when the alloc_memory_block_zero function is called, and when a back reference is added by the weaken function.
void* (*get_type_name_raw)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
If you specify an object, a new byte[] type object that stores the type name is returned.
This function does not add objects to the mortal stack, so use type_name for normal use to avoid memory leaks.
void* (*get_type_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
If you specify an object, a new byte[] type object that stores the type name is returned. Add the newly created object to the mortal stack.
SPVM_ENV* (*new_env)(SPVM_ENV* env);
Create a new environment that is ready to call methods.
1. Create a new environment using the "new_env_raw" native API.
2. Set the current compiler to the new enviroment.
3. Initialize the environment using the "init_env" native API
The number of memory blocks is shared with the original execution environment.
If this method can't allocate memory for the new environment, return NULL.
Note that "call_init_blocks" need to be called before calling user methods by yourself.
void (*free_env)(SPVM_ENV* env);
Free an environment that is created by the "new_env" native API.
void* memory_blocks_count;
Unused from v0.9508+. The count of memory blocks is managed in "runtime".
const char* (*get_chars)(SPVM_ENV* env, SPVM_VALUE* stack, void* string_object);
Get characters pointer in the string object.
const char* bytes = env->get_chars(env, stack, string_object);
int32_t (*die)(SPVM_ENV* env, SPVM_VALUE* stack, const char* message, ...);
Create a sprintf formatted message with file name and line number and set it to the exception.
sprintf
Last two arguments are file name and line number.
Return value is always 1;
return env->die(env, stack, "Value must be %d", 3, __FILE__, __LINE__);
void* (*new_object_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as new_object function, but you can specify class name directry.
new_object
If function is succeeded, exception_flag is set to 0. If a exception occurs, exception_flag is set to 1.
exception_flag
int32_t e; void* minimal = env->new_object_by_name(env, stack, "TestCase::Minimal", &e, __FILE__, __LINE__); if (e) { return e; }
void* (*new_pointer_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, void* pointer, int32_t* exception_flag, const char* file, int32_t line);
This is same as new_pointer function, but you can specify class name directry.
new_pointer
int32_t e; void* minimal = env->new_pointer_by_name(env, stack, "TestCase::Pointer", pointer, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_field_byte_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int8_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_field_byte function, but you can specify class name and field name directry.
set_field_byte
int32_t e; env->set_field_byte_by_name(env, stack, object, "TestCase::Simple", "byte_value", 13, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_field_short_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int16_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_field_short function, but you can specify class name and field name directry.
set_field_short
int32_t e; env->set_field_short_by_name(env, stack, object, "TestCase::Simple", "short_value", 13, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_field_int_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_field_int function, but you can specify class name and field name directry.
set_field_int
int32_t e; env->set_field_int_by_name(env, stack, object, "TestCase::Simple", "int_value", 13, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_field_long_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int64_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_field_long function, but you can specify class name and field name directry.
set_field_long
int32_t e; env->set_field_long_by_name(env, stack, object, "TestCase::Simple", "long_value", 13, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_field_float_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, float value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_field_float function, but you can specify class name and field name directry.
set_field_float
int32_t e; env->set_field_float_by_name(env, stack, object, "TestCase::Simple", "float_value", 13, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_field_double_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, double value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_field_double function, but you can specify class name and field name directry.
set_field_double
int32_t e; env->set_field_double_by_name(env, stack, object, "TestCase::Simple", "double_value", 13, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_field_object_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, const char* signature, void* value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_field_object function, but you can specify class name and field name directry.
set_field_object
int32_t e; env->set_field_object_by_name(env, stack, object_simple, "TestCase::Simple", "object_value", "TestCase::Minimal", object_minimal, &e, __FILE__, __LINE__); if (e) { return e; }
int8_t (*get_field_byte_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_field_byte function, but you can specify class name and field name directry.
get_field_byte
If function is succeeded, exception_flag is get to 0. If a exception occurs, exception_flag is get to 1.
int32_t e; int8_t byte_value = env->get_field_byte_by_name(env, stack, object, "TestCase::Simple", "byte_value", &e, __FILE__, __LINE__); if (e) { return e; }
int16_t (*get_field_short_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_field_short function, but you can specify class name and field name directry.
get_field_short
int32_t e; int8_t short_value = env->get_field_short_by_name(env, stack, object, "TestCase::Simple", "short_value", &e, __FILE__, __LINE__); if (e) { return e; }
int32_t (*get_field_int_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_field_int function, but you can specify class name and field name directry.
get_field_int
int32_t e; int8_t int_value = env->get_field_int_by_name(env, stack, object, "TestCase::Simple", "int_value", &e, __FILE__, __LINE__); if (e) { return e; }
int64_t (*get_field_long_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_field_long function, but you can specify class name and field name directry.
get_field_long
int32_t e; int8_t long_value = env->get_field_long_by_name(env, stack, object, "TestCase::Simple", "long_value", &e, __FILE__, __LINE__); if (e) { return e; }
float (*get_field_float_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_field_float function, but you can specify class name and field name directry.
get_field_float
int32_t e; int8_t float_value = env->get_field_float_by_name(env, stack, object, "TestCase::Simple", "float_value", &e, __FILE__, __LINE__); if (e) { return e; }
double (*get_field_double_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_field_double function, but you can specify class name and field name directry.
get_field_double
int32_t e; int8_t double_value = env->get_field_double_by_name(env, stack, object, "TestCase::Simple", "double_value", &e, __FILE__, __LINE__); if (e) { return e; }
void* (*get_field_object_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, const char* signature, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_field_object function, but you can specify class name and field name directry.
get_field_object
int32_t e; void* object_minimal = env->get_field_object_by_name(env, stack, object_simple, "TestCase::Simple", "object_value", "TestCase::Minimal", &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_class_var_byte_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int8_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_class_var_byte function, but you can specify the class name directry.
set_class_var_byte
int32_t e; env->set_class_var_byte_by_name(env, stack, "TestCase::NativeAPI", "$BYTE_VALUE", 15, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_class_var_short_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int16_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_class_var_short function, but you can specify the class name directry.
set_class_var_short
int32_t e; env->set_class_var_short_by_name(env, stack, "TestCase::NativeAPI", "$SHORT_VALUE", 15, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_class_var_int_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int32_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_class_var_int function, but you can specify the class name directry.
set_class_var_int
int32_t e; env->set_class_var_int_by_name(env, stack, "TestCase::NativeAPI", "$INT_VALUE", 15, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_class_var_long_by_name)(SPVM_ENV* env const char* class_name, const char* class_var_name, int64_t value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_class_var_long function, but you can specify the class name directry.
set_class_var_long
int32_t e; env->set_class_var_long_by_name(env, stack, "TestCase::NativeAPI", "$LONG_VALUE", 15, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_class_var_float_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, float value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_class_var_float function, but you can specify the class name directry.
set_class_var_float
int32_t e; env->set_class_var_float_by_name(env, stack, "TestCase::NativeAPI", "$FLOAT_VALUE", 15, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_class_var_double_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, double value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_class_var_double function, but you can specify the class name directry.
set_class_var_double
int32_t e; env->set_class_var_double_by_name(env, stack, "TestCase::NativeAPI", "$DOUBLE_VALUE", 15, &e, __FILE__, __LINE__); if (e) { return e; }
void (*set_class_var_object_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, const char* signature, void* value, int32_t* exception_flag, const char* file, int32_t line);
This is same as set_class_var_object function, but you can specify the class name directry.
set_class_var_object
int32_t e; env->set_class_var_object_by_name(env, stack, "TestCase::NativeAPI", "$MINIMAL_VALUE", "TestCase::Minimal", minimal, &e, __FILE__, __LINE__); if (e) { return e; }
int8_t (*get_class_var_byte_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_class_var_byte function, but you can specify the class name directry.
get_class_var_byte
int32_t e; int8_t value = env->get_class_var_byte_by_name(env, stack, "TestCase::NativeAPI", "$BYTE_VALUE", &e, __FILE__, __LINE__); if (e) { return e; }
int16_t (*get_class_var_short_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_class_var_short function, but you can specify the class name directry.
get_class_var_short
int32_t e; int16_t value = env->get_class_var_short_by_name(env, stack, "TestCase::NativeAPI", "$SHORT_VALUE", &e, __FILE__, __LINE__); if (e) { return e; }
int32_t (*get_class_var_int_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_class_var_int function, but you can specify the class name directry.
get_class_var_int
int64_t (*get_class_var_long_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_class_var_long function, but you can specify the class name directry.
get_class_var_long
int32_t e; int64_t value = env->get_class_var_long_by_name(env, stack, "TestCase::NativeAPI", "$LONG_VALUE", &e, __FILE__, __LINE__); if (e) { return e; }
float (*get_class_var_float_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_class_var_float function, but you can specify the class name directry.
get_class_var_float
int32_t e; float value = env->get_class_var_float_by_name(env, stack, "TestCase::NativeAPI", "$FLOAT_VALUE", &e, __FILE__, __LINE__); if (e) { return e; }
double (*get_class_var_double_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_class_var_double function, but you can specify the class name directry.
get_class_var_double
int32_t e; double value = env->get_class_var_double_by_name(env, stack, "TestCase::NativeAPI", "$DOUBLE_VALUE", &e, __FILE__, __LINE__); if (e) { return e; }
void* (*get_class_var_object_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* class_var_name, const char* signature, int32_t* exception_flag, const char* file, int32_t line);
This is same as get_class_var_object function, but you can specify the class name directry.
get_class_var_object
int32_t e; void* value = env->get_class_var_object_by_name(env, stack, "TestCase::NativeAPI", "$MINIMAL_VALUE", "TestCase::Minimal", &e, __FILE__, __LINE__); if (e) { return e; }
int32_t (*call_class_method_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* class_name, const char* method_name, const char* signature, const char* file, int32_t line);
This is same as call_spvm_method function, but you can specify the class name and sub name directry.
call_spvm_method
int32_t output; { stack[0].ival = 5; int32_t exception_flag = env->call_class_method_by_name(env, stack, "TestCase::NativeAPI", "my_value", "int(int)", __FILE__, __LINE__); if (exception_flag) { return exception_flag; } output = stack[0].ival; }
int32_t (*call_instance_method_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* method_name, const char* signature, const char* file, int32_t line);
const char* (*get_field_string_chars_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* class_name, const char* field_name, int32_t* exception_flag, const char* file, int32_t line);
void (*free_env_prepared)(SPVM_ENV* env);
Free the environment prepared by SPVM_NATIVE_new_env_prepared function.
SPVM_NATIVE_new_env_prepared
void* (*dump_raw)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Get the string which dump the object. The string is the same as the return value of dump operator.
dump
void* (*dump)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Do the same as dump_raw, and add the created string object to the mortal stack of the environment. Use this function in normal use instead of dump_raw.
dump_raw
Alias for "call_spvm_method"
int32_t (*get_instance_method_id_static)(SPVM_ENV* env, const char* class_name, const char* method_name, const char* signature);
Get a instance method ID by the class name, the method name, and the method signature. If the instance method does not exists, a negative value is returned.
int32_t method_id = env->get_instance_method_id_static(env, "Foo", "get", "int(long,string)");
int32_t (*get_bool_object_value)(SPVM_ENV* env, SPVM_VALUE* stack, void* bool_object);
Get the value of a Bool object. If the Bool object is true, return 1, otherwise return 0.
int32_t bool_value = env->get_bool_object_value(env, stack, bool_object);
void (*cleanup_global_vars)(SPVM_ENV* env, SPVM_VALUE* stack);
Cleanup gloval variable, such as class variables and the exception variable.
void (*make_read_only)(SPVM_ENV* env, SPVM_VALUE* stack, void* string)
Make the string read-only.
If the string is read-only, returns 1, otherwise returns 0.
int32_t (*is_array)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
If the object is an array, returns 1, otherwise returns 0.
int32_t (*is_string)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
If the object is a string, returns 1, otherwise returns 0.
int32_t (*is_numeric_array)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
If the object is a numeric array, returns 1, otherwise returns 0.
int32_t (*is_mulnum_array)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
If the object is a multi numeric array, returns 1, otherwise returns 0.
int32_t (*get_elem_byte_size)(SPVM_ENV* env, SPVM_VALUE* stack, void* array);
Get the byte size of the element of the array.
void* (*new_array_proto)(SPVM_ENV* env, SPVM_VALUE* stack, void* array, int32_t length);
Create a new array that have the type of the given array and the given length.
The given array must be the object that is an array type.
If the given array is NULL, returns NULL.
If the given length is lower than 0, returns NULL.
void* (*copy)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);
Copy the object. The type of the object must be a string type, a numeric array, or a multi numeric array.
If the given object is NULL, returns NULL.
void (*shorten)(SPVM_ENV* env, SPVM_VALUE* stack, void* string, int32_t new_length);
Shorten the string with the given length.
If the string is null, does nothing.
If the given length is greater than the length of the string, does nothing.
If the given length is lower than 0, the given length become 0.
The charaters of the after the given length are filled with \0.
int32_t (*has_interface)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t interface_basic_type_id);
Check the type of the object has the interface.
int32_t (*get_method_id_cache)(SPVM_ENV* env, const char* method_cache_name, int32_t method_cache_name_length);
Get the method ID from the method cache name. The method ID is cacahed.
int32_t (*get_field_id_cache)(SPVM_ENV* env, const char* field_cache_name, int32_t field_cache_name_length);
Get the method ID from the field cache name. The field ID is cacahed.
int32_t (*get_class_var_id_cache)(SPVM_ENV* env, const char* class_var_cache_name, int32_t class_var_cache_name_length);
Get the class variable ID from the class variable cache name. The class variable ID is cacahed.
void (*print)(SPVM_ENV* env, SPVM_VALUE* stack, void* string);
Print the characters of the string to stdout.
If the string is NULL, nothing is printed.
void (*print_stderr)(SPVM_ENV* env, SPVM_VALUE* stack, void* string);
Print the characters of the string to stderr.
int32_t (*init_env)(SPVM_ENV* env);
Initialize the environment.
void (*call_init_blocks)(SPVM_ENV* env);
Call INIT blocks.
INIT
SPVM::Document::NativeAPI::Compiler
SPVM::Document::NativeAPI::Precompile
SPVM::Document::NativeAPI::Runtime
SPVM::Document::NativeAPI::StringBuffer
SPVM::Document::NativeAPI::Allocator
0 SPVM_NATIVE_C_BASIC_TYPE_ID_UNKNOWN 1 SPVM_NATIVE_C_BASIC_TYPE_ID_UNDEF 2 SPVM_NATIVE_C_BASIC_TYPE_ID_VOID 3 SPVM_NATIVE_C_BASIC_TYPE_ID_BYTE 4 SPVM_NATIVE_C_BASIC_TYPE_ID_SHORT 5 SPVM_NATIVE_C_BASIC_TYPE_ID_INT 6 SPVM_NATIVE_C_BASIC_TYPE_ID_LONG 7 SPVM_NATIVE_C_BASIC_TYPE_ID_FLOAT 8 SPVM_NATIVE_C_BASIC_TYPE_ID_DOUBLE 9 SPVM_NATIVE_C_BASIC_TYPE_ID_STRING 10 SPVM_NATIVE_C_BASIC_TYPE_ID_ANY_OBJECT 11 SPVM_NATIVE_C_BASIC_TYPE_ID_BYTE_OBJECT 12 SPVM_NATIVE_C_BASIC_TYPE_ID_SHORT_OBJECT 13 SPVM_NATIVE_C_BASIC_TYPE_ID_INT_OBJECT 14 SPVM_NATIVE_C_BASIC_TYPE_ID_LONG_OBJECT 15 SPVM_NATIVE_C_BASIC_TYPE_ID_FLOAT_OBJECT 16 SPVM_NATIVE_C_BASIC_TYPE_ID_DOUBLE_OBJECT 17 SPVM_NATIVE_C_BASIC_TYPE_ID_TYPE_CONVERSION_CONDITINAL_OBJECT
These IDs are permanently same for the binary compatibility after the future release v1.0.
The basic type is unknown.
The basic type ID of undef type.
undef
The basic type ID of void type.
void
The basic type ID of byte type.
byte
The basic type ID of short type.
short
The basic type ID of int type.
int
The basic type ID of long type.
long
The basic type ID of float type.
float
The basic type ID of double type.
double
The basic type ID of string type.
string
The basic type ID of object type.
object
The basic type ID of Byte type.
The basic type ID of Short type.
The basic type ID of Int type.
The basic type ID of Long type.
The basic type ID of Float type.
The basic type ID of Double type.
The basic type ID of BOOL type.
0 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_UNKNOWN 1 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_NOT_FOUND_CLASS 2 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_UNDEF 3 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_VOID 4 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_NUMERIC 5 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_MULNUM 6 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_STRING 7 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_CLASS 8 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_INTERFACE 9 SPVM_NATIVE_C_BASIC_TYPE_CATEGORY_ANY_OBJECT
The basic type category for unknown types.
The basic type category for not found class types.
The basic type category for the undefined type.
The basic type category for the void type.
The basic type category for the numeric types.
The basic type category for the multi-numeric types.
The basic type category for the string type.
The basic type category for the class types.
The basic type category for the interface types.
The basic type category for the any object type.
Examples using SPVM native APIs
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.