Name

SPVM::Document::NativeAPI - SPVM Native APIs

Description

The SPVM native APIs are public APIs that are used in native language sources such as C/C++.

The native APIs are writen in the C language, but the languages that have compatibility of the C language such as <C++>, CUDA/nvcc can call the native APIs.

The native APIs is used when native methods are implemented.

Native APIs

Native APIs have its IDs. These IDs are permanently same for the binary compatibility after the future release v1.0.

  0 class_vars_heap
  1 object_header_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_flag_offset
  7 object_length_offset
  8 api
  9 allocator
 10 new_env_raw
 11 free_env_raw
 12 isa
 13 elem_isa
 14 runtime
 15 get_basic_type_id
 16 get_field_id
 17 get_field_offset
 18 get_class_var_id
 19 get_class_method_id
 20 get_instance_method_id
 21 new_object_raw
 22 new_object
 23 new_byte_array_raw
 24 new_byte_array
 25 new_short_array_raw
 26 new_short_array
 27 new_int_array_raw
 28 new_int_array
 29 new_long_array_raw
 30 new_long_array
 31 new_float_array_raw
 32 new_float_array
 33 new_double_array_raw
 34 new_double_array
 35 new_object_array_raw
 36 new_object_array
 37 new_muldim_array_raw
 38 new_muldim_array
 39 new_mulnum_array_raw
 40 new_mulnum_array
 41 new_string_nolen_raw
 42 new_string_nolen
 43 new_string_raw
 44 new_string
 45 concat_raw
 46 concat
 47 new_stack_trace_raw
 48 new_stack_trace
 49 length
 50 get_elems_byte
 51 get_elems_short
 52 get_elems_int
 53 get_elems_long
 54 get_elems_float
 55 get_elems_double
 56 get_elem_object
 57 set_elem_object
 58 get_field_byte
 59 get_field_short
 60 get_field_int
 61 get_field_long
 62 get_field_float
 63 get_field_double
 64 get_field_object
 65 set_field_byte
 66 set_field_short
 67 set_field_int
 68 set_field_long
 69 set_field_float
 70 set_field_double
 71 set_field_object
 72 get_class_var_byte
 73 get_class_var_short
 74 get_class_var_int
 75 get_class_var_long
 76 get_class_var_float
 77 get_class_var_double
 78 get_class_var_object
 79 set_class_var_byte
 80 set_class_var_short
 81 set_class_var_int
 82 set_class_var_long
 83 set_class_var_float
 84 set_class_var_double
 85 set_class_var_object
 86 get_pointer
 87 set_pointer
 88 call_method_raw
 89 get_exception
 90 set_exception
 91 get_ref_count
 92 inc_ref_count
 93 dec_ref_count
 94 enter_scope
 95 push_mortal
 96 leave_scope
 97 remove_mortal
 98 is_type
 99 is_object_array
100 get_object_basic_type_id
101 get_object_type_dimension
102 weaken
103 isweak
104 unweaken
105 alloc_memory_block_zero
106 free_memory_block
107 get_memory_blocks_count
108 get_type_name_raw
109 get_type_name
110 new_env
111 free_env
112 memory_blocks_count
113 get_chars
114 die
115 new_object_by_name
116 set_field_byte_by_name
117 set_field_short_by_name
118 set_field_int_by_name
119 set_field_long_by_name
120 set_field_float_by_name
121 set_field_double_by_name
122 set_field_object_by_name
123 get_field_byte_by_name
124 get_field_short_by_name
125 get_field_int_by_name
126 get_field_long_by_name
127 get_field_float_by_name
128 get_field_double_by_name
129 get_field_object_by_name
130 set_class_var_byte_by_name
131 set_class_var_short_by_name
132 set_class_var_int_by_name
133 set_class_var_long_by_name
134 set_class_var_float_by_name
135 set_class_var_double_by_name
136 set_class_var_object_by_name
137 get_class_var_byte_by_name
138 get_class_var_short_by_name
139 get_class_var_int_by_name
140 get_class_var_long_by_name
141 get_class_var_float_by_name
142 get_class_var_double_by_name
143 get_class_var_object_by_name
144 call_class_method_by_name
145 call_instance_method_by_name
146 get_field_string_chars_by_name
147 free_env_prepared
148 dump_raw
149 dump
150 get_instance_method_id_static
151 get_bool_object_value
152 cleanup_global_vars
153 make_read_only
154 is_read_only
155 is_array
156 is_string
157 is_numeric_array
158 is_mulnum_array
159 get_elem_size
160 new_array_proto_raw
161 new_array_proto
162 copy_raw
163 copy
164 shorten
165 has_interface
166 print
167 print_stderr
168 init_env
169 call_init_blocks
170 reserved170
171 new_stack
172 free_stack
173 new_memory_env
174 free_memory_env
175 get_memory_blocks_count_env
176 new_memory_stack
177 free_memory_stack
178 get_memory_blocks_count_stack
179 set_command_info_program_name
180 set_command_info_argv
181 reserved181
182 strerror
183 new_string_array
184 get_args_stack_length
185 set_args_stack_length
186 dumpc
187 new_pointer_object_raw
188 new_pointer_object
189 new_pointer_object_by_name
190 get_elem_string
191 set_elem_string
192 is_class
193 is_pointer_class
194 strerror_string
195 get_basic_type_id_by_name
196 get_field_id_static
197 items
198 call_instance_method_static_by_name
199 get_method_id
200 strerror_nolen
201 strerror_string_nolen
202 get_compile_type_name_raw
203 get_compile_type_name
204 set_command_info_base_time
205 get_spvm_version_string
206 get_spvm_version_number
207 get_version_string
208 get_version_number
209 call_method
210 init_flags
211 get_object_basic_type_name
212 isa_by_name
213 is_type_by_name
214 new_object_array_by_name
215 new_muldim_array_by_name
216 new_mulnum_array_by_name
217 has_interface_by_name

class_vars_heap

void* class_vars_heap;

The pointer to the storage area of the class variables. This is used internally.

object_header_size

void* object_header_size;

The byte size of the object's header. This is used internally.

object_weaken_backref_head_offset

void* object_weaken_backref_head_offset;

The offset to a pointer to the back reference of the weak reference in the object structure. This is used internally.

object_ref_count_offset

void* object_ref_count_offset;

The reference count offset in the object structure. This is used internally.

object_basic_type_id_offset

void* object_basic_type_id_offset;

The offset of basic type ID in object structure. This is used internally.

object_type_dimension_offset

void* object_type_dimension_offset;

The offset of type dimension in object structure. This is used internally.

object_type_category_offset

void* object_type_category_offset;

The 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.

object_flag_offset

void* object_flag_offset;

The offset of flag in object structure. This is used internally.

object_length_offset

void* object_length_offset;

The length offset in the object structure. This is used internally.

api

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;

allocator

void* allocator;

The memory allocator for this environment.

new_env_raw

SPVM_ENV* (*new_env_raw)();

Creates a new raw envriment.

free_env_raw

void (*free_env_raw)(SPVM_ENV* env);

Frees the raw environemt that is created by "new_env_raw".

isa

int32_t (*isa)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t cast_basic_type_id, int32_t cast_type_dimension);

Performs isa operation.

elem_isa

int32_t (*elem_isa)(SPVM_ENV* env, SPVM_VALUE* stack, void* array, void* element);

Checks the runtime type assignability of an array element.

runtime

void* runtime;

A pointer to the runtime information. This is used internally.

get_basic_type_id

int32_t (*get_basic_type_id)(SPVM_ENV* env, SPVM_VALUE* stack, const char* basic_type_name);

Gets 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.

Examples:

int32_t basic_type_id = env->get_basic_type_id(env, "Int");

get_field_id

int32_t (*get_field_id)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* field_name);

Gets the ID of the field given an object and field name. If the field does not exist, a value less than 0 is returned.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");

get_field_offset

int32_t (*get_field_offset)(SPVM_ENV* env, SPVM_VALUE* stack, 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.

get_class_var_id

int32_t (*get_class_var_id)(SPVM_ENV* env, SPVM_VALUE* stack, const char* basic_type_name, const char* class_var_name);

Gets the class variable ID given the basic type name, class variable name. If the class variable does not exist, a value less than 0 is returned.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");

get_class_method_id

int32_t (*get_class_method_id)(SPVM_ENV* env, SPVM_VALUE* stack, const char* basic_type_name, const char* method_name);

Gets a class method ID by the basic type name, the method name. If the class method does not exists, a negative value is returned.

This ID is used by "call_method_raw".

Examples:

int32_t method_id = env->get_class_method_id(env, "Foo", "get");

get_instance_method_id

int32_t (*get_instance_method_id)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, const char* method_name);

Gets a instance method ID by the object, the method name. If the instance method does not exist, a negative value is returned.

This ID is used by "call_method_raw".

Examples:

int32_t method_id = env->get_instance_method_id(env, object, "get");

new_object_raw

void* (*new_object_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id);

Creates 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.

new_object

void* (*new_object)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id);

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.

Examples:

int32_t basic_type_id = env->get_basic_type_id(env, "Int");
void* object = env->new_object(env, stack, basic_type_id);

new_byte_array_raw

void* (*new_byte_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

Creates a new byte[] type array by specifying the length.

new_byte_array

void* (*new_byte_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

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.

Examples:

void* byte_array = env->new_byte_array(env, stack, 100);

new_short_array_raw

void* (*new_short_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

Creates a new short[] type array by specifying the length.

new_short_array

void* (*new_short_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

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.

Examples:

void* short_array = env->new_short_array(env, stack, 100);

new_int_array_raw

void* (*new_int_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

Creates a new int[] type array by specifying the length.

new_int_array

void* (*new_int_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

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.

Examples:

void* int_array = env->new_int_array(env, stack, 100);

new_long_array_raw

void* (*new_long_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

Creates a new long[] type array by specifying the length.

new_long_array

void* (*new_long_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

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.

Examples:

void* long_array = env->new_long_array(env, stack, 100);

new_float_array_raw

void* (*new_float_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

Creates a new float[] type array by specifying the length.

new_float_array

void* (*new_float_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

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.

Examples:

void* float_array = env->new_float_array(env, stack, 100);

new_double_array_raw

void* (*new_double_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

Creates a new double[] type array by specifying the length.

new_double_array

void* (*new_double_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t length);

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.

Examples:

void* double_array = env->new_double_array(env, stack, 100);

new_object_array_raw

void* (*new_object_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);

Creates 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.

new_object_array

void* (*new_object_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);

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.

Examples:

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);

new_muldim_array_raw

void* (*new_muldim_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t type_dimension, int32_t length);

Creates a new multi-dimensional array by specifying the basic type ID and the type dimension, 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.

new_muldim_array

void* (*new_muldim_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t type_dimension, int32_t length);

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.

Examples:

// Creates 2-dimensional array - The same as "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);

new_mulnum_array_raw

void* (*new_mulnum_array_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);

Creates 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.

new_mulnum_array

void* (*new_mulnum_array)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t basic_type_id, int32_t length);

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.

Examples:

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);

new_string_nolen_raw

void* (*new_string_nolen_raw)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes);

Creates a new string object by specifying C language char* type value. this value must end with "\0".

new_string_nolen

void* (*new_string_nolen)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes);

The same as new_string_nolen_raw, and push the created object to the mortal stack. Use this function in normal use instead of new_string_nolen_raw.

Examples:

void* str_obj = env->new_string_nolen(env, stack, "Hello World");

new_string_raw

void* (*new_string_raw)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes, int32_t length);

Creates 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.

new_string

void* (*new_string)(SPVM_ENV* env, SPVM_VALUE* stack, const char* bytes, int32_t length);

The same as new_string_raw, and push the created object to the mortal stack. Usually use this function instead of new_string_raw.

Examples:

void* str_obj = env->new_string(env, stack, "Hello \0World", 11);

concat_raw

void* (*concat_raw)(SPVM_ENV* env, SPVM_VALUE* stack, void* string1, void* string2);

Concats two strings.

concat

void* (*concat)(SPVM_ENV* env, SPVM_VALUE* stack, void* string1, void* string2);

The same as concat_raw, and push the created object to the mortal stack. Use this function in normal use instead of concat_raw.

new_stack_trace_raw

void* (*new_stack_trace_raw)(SPVM_ENV* env, SPVM_VALUE* stack, void* exception, int32_t method_id, int32_t line);

Creates 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.

new_stack_trace

void* (*new_stack_trace)(SPVM_ENV* env, SPVM_VALUE* stack, void* exception, int32_t method_id, int32_t line);

The same as "new_stack_trace_raw", and push the created object to the mortal stack.

length

int32_t (*length)(SPVM_ENV*, void* array);

If you specify an array, the length of the array is returned.

Examples:

int32_t length = env->length(env, stack, array);

get_elems_byte

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.

Examples:

int8_t* values = env->get_elems_byte(env, stack, array);
values[3] = 5;

get_elems_short

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.

Examples:

int16_t* values = env->get_elems_short(env, stack, array);
values[3] = 5;

get_elems_int

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.

Examples:

int32_t* values = env->get_elems_int(env, stack, array);
values[3] = 5;

get_elems_long

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.

Examples:

int64_t* values = env->get_elems_long(env, stack, array);
values[3] = 5;

get_elems_float

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.

Examples:

float* values = env->get_elems_float(env, stack, array);
values[3] = 1.5f;

get_elems_double

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.

Examples:

double* values = env->get_elems_double(env, stack, array);
values[3] = 1.5;

get_elem_object

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.

Examples:

void* object = env->get_elem_object(env, stack, array, 3);

set_elem_object

void (*set_elem_object)(SPVM_ENV* env, SPVM_VALUE* stack, void* array, int32_t index, void* object);

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.

Examples:

env->get_elem_object(env, stack, array, 3, object);

get_field_byte

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int8_t field_value = env->get_field_byte(env, stack, object, field_id);

get_field_short

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int16_t field_value = env->get_field_short(env, stack, object, field_id);

get_field_int

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int32_t field_value = env->get_field_int(env, stack, object, field_id);

get_field_long

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int64_t field_value = env->get_field_long(env, stack, object, field_id);

get_field_float

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
float field_value = env->get_field_float(env, stack, object, field_id);

get_field_double

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
double field_value = env->get_field_double(env, stack, object, field_id);

get_field_object

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, object, "x");
void* field_value = env->get_field_object(env, stack, object, field_id);

set_field_byte

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int8_t field_value = 5;
env->set_field_byte(env, stack, object, field_id, field_value);

set_field_short

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int16_t field_value = 5;
env->set_field_short(env, stack, object, field_id, field_value);

set_field_int

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int32_t field_value = 5;
env->set_field_int(env, stack, object, field_id, field_value);

set_field_long

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
int64_t field_value = 5;
env->set_field_long(env, stack, object, field_id, field_value);

set_field_float

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
float field_value = 1.5f;
env->set_field_float(env, stack, object, field_id, field_value);

set_field_double

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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
double field_value = 1.55;
env->set_field_double(env, stack, object, field_id, field_value);

set_field_object

void (*set_field_object)(SPVM_ENV* env, SPVM_VALUE* stack, void* object, int32_t field_id, void* value);

The object and field Specifies 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.

Examples:

int32_t field_id = env->get_field_id(env, object, "x");
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);

get_class_var_byte

int8_t (*get_class_var_byte)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int8_t class_var_value = env->get_class_var_byte(env, stack, object, class_var_id);

get_class_var_short

int16_t (*get_class_var_short)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int16_t class_var_value = env->get_class_var_short(env, stack, object, class_var_id);

get_class_var_int

int32_t (*get_class_var_int)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int32_t class_var_value = env->get_class_var_int(env, stack, object, class_var_id);

get_class_var_long

int64_t (*get_class_var_long)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int64_t class_var_value = env->get_class_var_long(env, stack, object, class_var_id);

get_class_var_float

float (*get_class_var_float)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
float class_var_value = env->get_class_var_float(env, stack, object, class_var_id);

get_class_var_double

double (*get_class_var_double)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
double class_var_value = env->get_class_var_double(env, stack, object, class_var_id);

get_class_var_object

void* (*get_class_var_object)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
void* class_var_value = env->get_class_var_byte(env, stack, object, class_var_id);

set_class_var_byte

void (*set_class_var_byte)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int8_t class_var_value = 5;
env->set_class_var_byte(env, stack, class_var_id, class_var_value);

set_class_var_short

void (*set_class_var_short)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int16_t class_var_value = 5;
env->set_class_var_short(env, stack, class_var_id, class_var_value);

set_class_var_int

void (*set_class_var_int)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int32_t class_var_value = 5;
env->set_class_var_int(env, stack, class_var_id, class_var_value);

set_class_var_long

void (*set_class_var_long)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
int64_t class_var_value = 5;
env->set_class_var_long(env, stack, class_var_id, class_var_value);

set_class_var_float

void (*set_class_var_float)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
float class_var_value = 5;
env->set_class_var_float(env, stack, class_var_id, class_var_value);

set_class_var_double

void (*set_class_var_double)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_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.

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
double class_var_value = 5;
env->set_class_var_double(env, stack, class_var_id, class_var_value);

set_class_var_object

void (*set_class_var_object)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t class_var_id, void* value);

Examples:

int32_t class_var_id = env->get_class_var_id(env, "Foo", "$VAR");
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, class_var_id, class_var_value);

get_pointer

void* (*get_pointer)(SPVM_ENV* env, SPVM_VALUE* stack, void* pointer_object);

Specifies a pointer object and return the C language pointer stored inside the object.

Examples:

strcut tm* tm_ptr = (struct tm*) env->get_pointer(env, stack, tm_obj);

set_pointer

void (*set_pointer)(SPVM_ENV* env, SPVM_VALUE* stack, void* pointer_object, void* pointer);

If you specify a pointer object and a C language pointer, the C language pointer is saved in the internal data of the pointer type object.

call_method_raw

int32_t (*call_method_raw)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t method_id, int32_t args_stack_length);

Call a method by specifying the method ID and the stack length of the 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 stack[0].

get_exception

void* (*get_exception)(SPVM_ENV* env, SPVM_VALUE* stack);

Gets a exception message which type is byte[].

set_exception

void (*set_exception)(SPVM_ENV* env, SPVM_VALUE* stack, void* exception);

Sets a exception message which type is byte[].

get_ref_count

int32_t (*get_ref_count)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);

Gets the refernce count of the object.

inc_ref_count

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.

dec_ref_count

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.

Use this method only if you have a specific reason to use it. Normally, the reference count is managed automatically.

enter_scope

int32_t (*enter_scope)(SPVM_ENV* env, SPVM_VALUE* stack);

Creates a new scope and return the scope ID.

push_mortal

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.

leave_scope

void (*leave_scope)(SPVM_ENV* env, SPVM_VALUE* stack, int32_t scope_id);

Specifies 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.

remove_mortal

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.

is_type

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.

is_object_array

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.

If the object is NULL, returns 0.

get_object_basic_type_id

int32_t (*get_object_basic_type_id)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);

Gets the base type ID of the object.

get_object_type_dimension

int32_t (*get_object_type_dimension)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);

Gets the dimension of the type of object.

weaken

int32_t (*weaken)(SPVM_ENV* env, SPVM_VALUE* stack, void** object_address);

Creates 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.

isweak

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.

unweaken

void (*unweaken)(SPVM_ENV* env, SPVM_VALUE* stack, void** object_address);

Specifying the address of the object releases the weak reference to the object.

alloc_memory_block_zero

void* (*alloc_memory_block_zero)(SPVM_ENV* env, size_t size);

Creates a new memory block that is managed by the environment with the byte size and return the address. If it fails, return NULL.

The count of the memory block that is managed by the environment is incremented by 1.

free_memory_block

void (*free_memory_block)(SPVM_ENV* env, void* block);

Frees the memory block that is managed by the environment.

The count of the memory block that is managed by the environment is decremented by 1.

get_memory_blocks_count

int32_t (*get_memory_blocks_count)(SPVM_ENV* env);

Returns the count of the memory blocks on the environment.

get_type_name_raw

void* (*get_type_name_raw)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);

Gets a new string object that is the type name of the object.

This function does not add the returned object to the mortal stack, so use the get_type_name Native API for normal use to avoid memory leaks.

get_type_name

void* (*get_type_name)(SPVM_ENV* env, SPVM_VALUE* stack, void* object);

Gets a new string object that is the type name of the object.

new_env

SPVM_ENV* (*new_env)(SPVM_ENV* env);

Creates 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 cannnot allocate memory for the new environment, return NULL.

Note that "call_init_blocks" need to be called before calling user methods by yourself.

free_env

void (*free_env)(SPVM_ENV* env);

Frees an environment that is created by the "new_env" native API.

memory_blocks_count

void* memory_blocks_count;

Unused from v0.9508+. The count of memory blocks is managed in "runtime".

get_chars

const char* (*get_chars)(SPVM_ENV* env, SPVM_VALUE* stack, void* string_object);

Gets characters in the string object.

Examples:

const char* bytes = env->get_chars(env, stack, string_object);

die

int32_t (*die)(SPVM_ENV* env, SPVM_VALUE* stack, const char* message, ...);

Creates a sprintf formatted message with file name and line number and set it to the exception.

Last three arguments are the function name, the file name, and the line number.

Returns value is the basic type id of the Error class.

Examples:

return env->die(env, stack, "Value must be %d", 3, __func__, __FILE__, __LINE__);

new_object_by_name

void* (*new_object_by_name)(SPVM_ENV* env, SPVM_VALUE* stack, const char* basic_type_name, int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as new_object function, but you can specify basic type name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
void* minimal = env->new_object_by_name(env, stack, "TestCase::Minimal", &e, __func__, __FILE__, __LINE__);
if (e) { return e; }

set_field_byte_by_name

void (*set_field_byte_by_name)(SPVM_ENV* env, SPVM_VALUE* stack,
  void* object, const char* field_name, int8_t value,
  int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as set_field_byte function, but you can specify field name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
env->set_field_byte_by_name(env, stack, object, "byte_value", 13, &e, __func__, __FILE__, __LINE__);
if (e) { return e; }

set_field_short_by_name

void (*set_field_short_by_name)(SPVM_ENV* env, SPVM_VALUE* stack,
  void* object, const char* field_name, int16_t value,
  int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as set_field_short function, but you can specify field name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
env->set_field_short_by_name(env, stack, object, "short_value", 13, &e, __func__, __FILE__, __LINE__);
if (e) { return e; }

set_field_int_by_name

void (*set_field_int_by_name)(SPVM_ENV* env, SPVM_VALUE* stack,
  void* object, const char* field_name, int32_t value,
  int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as set_field_int function, but you can specify field name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
env->set_field_int_by_name(env, stack, object, "int_value", 13, &e, __func__, __FILE__, __LINE__);
if (e) { return e; }

set_field_long_by_name

void (*set_field_long_by_name)(SPVM_ENV* env, SPVM_VALUE* stack,
  void* object, const char* field_name, int64_t value,
  int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as set_field_long function, but you can specify field name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
env->set_field_long_by_name(env, stack, object, "long_value", 13, &e, __func__, __FILE__, __LINE__);
if (e) { return e; }

set_field_float_by_name

void (*set_field_float_by_name)(SPVM_ENV* env, SPVM_VALUE* stack,
  void* object, const char* field_name, float value,
  int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as set_field_float function, but you can specify field name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
env->set_field_float_by_name(env, stack, object, "float_value", 13, &e, __func__, __FILE__, __LINE__);
if (e) { return e; }

set_field_double_by_name

void (*set_field_double_by_name)(SPVM_ENV* env, SPVM_VALUE* stack,
  void* object, const char* field_name, double value,
  int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as set_field_double function, but you can specify field name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
env->set_field_double_by_name(env, stack, object, "double_value", 13, &e, __func__, __FILE__, __LINE__);
if (e) { return e; }

set_field_object_by_name

void (*set_field_object_by_name)(SPVM_ENV* env, SPVM_VALUE* stack,
  void* object, const char* field_name, void* value,
  int32_t* error, const char* func_name, const char* file, int32_t line);

This is same as set_field_object function, but you can specify field name directly.

If function is succeeded, error is set to 0. If a exception occurs, error is set to 1.

Examples:

int32_t e;
env->set_field_object_by_name(env, stack, object_simple, "object_value", object_minimal, &e, __func__, __FILE__, __LINE__);
if (e) { return e; }