The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

KIMOTO / SPVM-0.989032 / lib / SPVM / Document / NativeAPI / ClassVariable.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

              
=head1 Name
SPVM::Document::NativeAPI::ClassVariable - Class Variable Native APIs
=head1 Description
The class variable native APIs of L<SPVM> are the APIs to manipulate information of class variables.
=head1 Usage
  SPVM_API_CLASS_VAR* api_class_var = env->api->class_var;
   
  const char* class_var_name = api_class_var->get_name(runtime, class_var);
The C<class_var> is got by the L<get_class_var_by_index|SPVM::Document::NativeAPI::BasicType/"get_class_var_by_index"> and the L<get_class_var_by_name|SPVM::Document::NativeAPI::BasicType/"get_class_var_by_name"> basic type native API.
=head1 Native APIs
=head2 get_name
  const char* (*get_name)(void* runtime, void* class_var);
Returns the name of the class variable.
The C<runtime> argument is a L<runtime|SPVM::Document::NativeAPI::Runtime> object.
The C<class_var> argument is a L<class_var|SPVM::Document::NativeAPI::ClassVariable> object.
=head2 get_index
  int32_t (*get_index)(void* runtime, void* class_var);
Returns the index of the class variable.
The C<runtime> argument is a L<runtime|SPVM::Document::NativeAPI::Runtime> object.
The C<class_var> argument is a L<class_var|SPVM::Document::NativeAPI::ClassVar> object.
=head2 get_basic_type
  void* (*get_basic_type)(void* runtime, void* class_var);
Returns the L<basic type|SPVM::Document::NativeAPI::BasicType> of the class variable.
The C<runtime> argument is a L<runtime|SPVM::Document::NativeAPI::Runtime> object.
The C<class_var> argument is a L<class_var|SPVM::Document::NativeAPI::ClassVariable> object.
=head2 get_type_dimension
  int32_t (*get_type_dimension)(void* runtime, void* class_var);
Returns the type dimension of the class variable.
The C<runtime> argument is a L<runtime|SPVM::Document::NativeAPI::Runtime> object.
The C<class_var> argument is a L<class_var|SPVM::Document::NativeAPI::ClassVariable> object.
=head2 get_type_flag
  int32_t (*get_type_flag)(void* runtime, void* class_var);
Returns the type flag of the class variable.
The C<runtime> argument is a L<runtime|SPVM::Document::NativeAPI::Runtime> object.
The C<class_var> argument is a L<class_var|SPVM::Document::NativeAPI::ClassVariable> object.
=head2 get_current_basic_type
  void* (*get_current_basic_type)(void* runtime, void* class_var);
Returns the current L<basic type|SPVM::Document::NativeAPI::BasicType> of the class variable.
The C<runtime> argument is a L<runtime|SPVM::Document::NativeAPI::Runtime> object.
The C<class_var> argument is a L<class_var|SPVM::Document::NativeAPI::ClassVariable> object.
=head1 Native API IDs
  0 get_name
  1 get_index
  2 get_basic_type
  3 get_type_dimension
  4 get_type_flag
  5 get_current_basic_type
=head1 Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License