From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

KIMOTO / SPVM-0.990047 / lib / SPVM / Document / NativeAPI / Argument.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

              
=head1 Name
SPVM::Document::NativeAPI::Argument - Argument Native APIs
=head1 Description
The argument native APIs in L<SPVM> are the APIs to get definition information for arguments.
=head1 Usage
  SPVM_API_ARG* api_arg = env->api->arg;
   
  SPVM_API_METHOD* api_method = env->api->method;
   
  void* basic_type = env->get_basic_type(env, stack, "Foo");
   
  void* method = env->api->basic_type->get_method_by_name(env->runtime, basic_type, "get");
   
  void* arg = api_method->get_arg_by_index(env->runtime, method, 0);
   
  void* arg_basic_type = api_arg->get_basic_type(env->runtime, arg);
=head1 Native APIs
=head2 get_name
C<const char* (*get_name)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the name of the argument I<arg>.
=head2 get_index
C<int32_t (*get_index)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the index of the argument I<arg>.
=head2 get_basic_type
C<void* (*get_basic_type)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the L<basic type|SPVM::Document::NativeAPI::BasicType> of the argument I<arg>.
=head2 get_type_dimension
C<int32_t (*get_type_dimension)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the type dimention of the argument I<arg>.
=head2 get_type_flag
C<int32_t (*get_type_flag)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the L<type flag ID|SPVM::Document::NativeAPI/"Type Flag IDs"> of the argument I<arg>.
=head2 get_stack_index
C<int32_t (*get_stack_index)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the stack index of the argument I<arg>. The stack index is the position in a L<runtime stack|SPVM::Document::NativeClass/"Runtime Stack">.
=head2 get_current_method
C<void* (*get_current_method)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the L<method|SPVM::Document::NativeAPI::Method> that owns the argment I<arg>.
=head2 is_optional
C<int32_t (*is_optional)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
If the argument I<arg> is an optional argument, returns 1, otherwise returns 0.
=head2 get_default_value
C<SPVM_VALUE (*get_default_value)(L<void* runtime|SPVM::Document::NativeAPI::Runtime>, L<void* arg|SPVM::Document::NativeAPI::Argument>);>
Returns the default value of the optional argument I<arg>.
=head1 Native API IDs
  0 get_name
  1 get_index
  2 get_basic_type
  3 get_type_dimension
  4 get_type_flag
  5 get_stack_index
  6 get_current_method
  7 is_optional
  8 get_default_value
=head1 See Also
=over 2
=item * L<SPVM::Document::NativeAPI>
=item * L<SPVM::Document::NativeAPI::Method>
=item * L<SPVM::Document::NativeClass>
=item * L<SPVM::Document>
=back
=head1 Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License