| 1 | package SPVM::Native::Env; | ||
| 2 | |||
| 3 | |||
| 4 | |||
| 5 | 1; | ||
| 6 | |||
| 7 | =head1 Name | ||
| 8 | |||
| 9 | SPVM::Native::Env - Runtime Environment | ||
| 10 | |||
| 11 | =head1 Description | ||
| 12 | |||
| 13 | The Native::Env class in L<SPVM> represents an L<runtime environment|SPVM::Document::NativeClass/"Runtime Environment">. | ||
| 14 | |||
| 15 | =head1 Usage | ||
| 16 | |||
| 17 | use Native::Env; | ||
| 18 | |||
| 19 | my $env = $runtime->new_env; | ||
| 20 | |||
| 21 | my $stack = $env->new_stack; | ||
| 22 | |||
| 23 | =head1 Details | ||
| 24 | |||
| 25 | This class is a pointer class. | ||
| 26 | |||
| 27 | Its insntace has the pointer to an object of L<SPVM_ENV|SPVM::Document::NativeClass/"Runtime Environment"> type. | ||
| 28 | |||
| 29 | =head1 Fields | ||
| 30 | |||
| 31 | C<has runtime : ro Native::Runtime;> | ||
| 32 | |||
| 33 | The runtime for this runtime environment. | ||
| 34 | |||
| 35 | =head1 Instance Methods | ||
| 36 | |||
| 37 | =head2 DESTROY | ||
| 38 | |||
| 39 | C<method DESTROY : void ();> | ||
| 40 | |||
| 41 | The destructor. | ||
| 42 | |||
| 43 | =head2 new_stack | ||
| 44 | |||
| 45 | C<method new_stack : L<Native::Stack|SPVM::Native::Stack> ();> | ||
| 46 | |||
| 47 | Builds a call stack and returns it. | ||
| 48 | |||
| 49 | The return type is L<Native::Stack|SPVM::Native::Stack> class. | ||
| 50 | |||
| 51 | =head1 See Also | ||
| 52 | |||
| 53 | =over 2 | ||
| 54 | |||
| 55 | =item * L<Native::Runtime|SPVM::Native::Runtime> | ||
| 56 | |||
| 57 | =item * L<Native::Stack|SPVM::Native::Stack> | ||
| 58 | |||
| 59 | =back | ||
| 60 | |||
| 61 | =head1 Copyright & License | ||
| 62 | |||
| 63 | Copyright (c) 2023 Yuki Kimoto | ||
| 64 | |||
| 65 | MIT License |