Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

KIMOTO / SPVM-0.990049 / lib / SPVM / Document / NativeAPI / Runtime.pm 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

              
=head1 Name
SPVM::Document::NativeAPI::Runtime - Runtime Native APIs
=head1 Description
The runtime native APIs of L<SPVM> are the APIs for SPVM runtimes.
=head1 Usage
  SPVM_API_RUNTIME* api_runtime = env->api->runtime;
   
  int32_t basic_types_length = api_runtime->get_basic_types_length(env->runtime);
=head1 Runtime Native APIs
=head2 get_object_data_offset
C<int32_t (*get_object_data_offset)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns the offset of data area in L<SPVM_OBJECT|SPVM::Document::NativeAPI/"SPVM_OBJECT"> struct.
Elements in an array or fields or a pointer in a pointer class is stored into the data area.
=head2 get_object_ref_count_offset
C<int32_t (*get_object_ref_count_offset)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns the offset of the C<ref_count> field in L<SPVM_OBJECT|SPVM::Document::NativeAPI/"SPVM_OBJECT"> struct.
=head2 get_object_length_offset
C<int32_t (*get_object_length_offset)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns the offset of the C<length> field in L<SPVM_OBJECT|SPVM::Document::NativeAPI/"SPVM_OBJECT"> struct.
=head2 get_basic_type_by_id
C<void* (*get_basic_type_by_id)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, int32_t basic_type_id);>
Searches a L<basic type|SPVM::Document::NativeAPI::BasicType> given the basic type ID I<basic_type_id>.
If it is found, returns it. Otherwise, returns C<NULL>.
=head2 get_basic_type_by_name
C<void* (*get_basic_type_by_name)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, const char* basic_type_name);>
Searches a L<basic type|SPVM::Document::NativeAPI::BasicType> given the basic type name I<basic_type_name>.
If it is found, returns it. Otherwise, returns C<NULL>.
=head2 get_basic_types_length
C<int32_t (*get_basic_types_length)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns the length of the basic types owned by the SPVM runtime I<runtime>.
=head2 build_precompile_class_source
C<void (*build_precompile_class_source)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* string_buffer|SPVM::Document::NativeAPI::StringBuffer>, L<void* basic_type|SPVM::Document::NativeAPI::BasicType>);>
Creates a C source code for methods with the C<precompile> attribute defined in the class given by the its basic type I<basic_type>, and saves it to the string buffer I<string_buffer>.
=head2 build_precompile_method_source
C<void (*build_precompile_method_source)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* string_buffer|SPVM::Document::NativeAPI::StringBuffer>, L<void* method|SPVM::Document::NativeAPI::Method>);>
Creates a C source code for the method I<method>, and saves it to the string buffer I<string_buffer>.
=head2 get_compiler
C<void* (*get_compiler)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns the value of the C<compiler> field. The compiler that build the runtime I<runtime> is stored to this field.
=head2 set_compiler
C<void (*set_compiler)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* compiler|SPVM::Document::NativeAPI::Compiler>);>
Sets I<compiler> to the C<compiler> field.
=head2 get_spvm_stdin
C<FILE* (*get_spvm_stdin)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns L<SPVM's standard input|SPVM::Document::Language::System/"Standard Streams">.
=head2 get_spvm_stdout
C<FILE* (*get_spvm_stdout)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns L<SPVM's standard output|SPVM::Document::Language::System/"Standard Streams">.
=head2 get_spvm_stderr
C<FILE* (*get_spvm_stderr)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>);>
Returns L<SPVM's standard error|SPVM::Document::Language::System/"Standard Streams">.
=head1 Native API IDs
  0 get_object_data_offset
  1 get_object_ref_count_offset
  2 get_object_length_offset
  3 get_basic_type_by_id
  4 get_basic_type_by_name
  5 get_basic_types_length
  6 build_precompile_class_source
  7 build_precompile_method_source
  8 get_compiler
  9 set_compiler
  10 get_spvm_stdin
  11 get_spvm_stdout
  12 get_spvm_stderr
=head1 See Also
=over 2
=item * L<SPVM::Document::NativeAPI>
=item * L<SPVM::Document::NativeAPI::BasicType>
=item * L<SPVM::Document::NativeAPI::Method>
=item * L<SPVM::Document::NativeAPI::StringBuffer>
=item * L<SPVM::Document::NativeAPI::Compiler>
=item * L<SPVM::Document::NativeClass>
=item * L<SPVM::Document>
=back
=head1 Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License