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

KIMOTO / SPVM-0.990049 / lib / SPVM / Builder / API.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

              
package SPVM::Builder::API;
use strict;
use warnings;
use SPVM::Builder;
sub new {
  my $class = shift;
   
  my $self = {};
   
  my %options = @_;
   
  my $build_dir = $options{build_dir};
   
  my $builder = SPVM::Builder->new(build_dir => $build_dir);
   
  $self->{builder} = $builder;
   
  return bless $self, $class;
}
sub build_dynamic_lib_dist_precompile {
  my ($self, $class_name, $options) = @_;
   
  my $builder = $self->{builder};
   
  $builder->build_dynamic_lib_dist_precompile($class_name, $options);
}
sub build_dynamic_lib_dist_native {
  my ($self, $class_name, $options) = @_;
   
  my $builder = $self->{builder};
   
  $builder->build_dynamic_lib_dist_native($class_name, $options);
}
1;
=head1 Name
SPVM::Builder::API - Builder APIs
=head1 Description
The SPVM::Builder::API class has the public methods to build SPVM native classes and SPVM precompilation classes.
=head1 Usage
   
  my $builder = SPVM::Builder::API->new(
    build_dir => '.spvm_build',
  );
   
  $builder->build_dynamic_lib_dist_precompile('MyClass');
   
  $builder->build_dynamic_lib_dist_native('MyClass');
=head1 Class Methods
=head2 new
  my $builder = SPVM::Builder::API->new(%options);
Creates a new L<SPVM::Builder::API> object, and returns it.
Options:
=over 2
=item * C<build_dir>
A build directory.
=back
=head1 Instance Methods
=head2 build_dynamic_lib_dist_precompile
  $builder->build_dynamic_lib_dist_precompile($class_name)
  $builder->build_dynamic_lib_dist_precompile($class_name, $options)
Generates a dynamic library for a L<native class|SPVM::Document::NativeClass> given by the class name $class_name, and copies it into the C<blib/lib> directory.
A native class must have at least one method with L<native attribute|SPVM::Document::Language::Class/"Method Attributes">.
Options:
$options is a hash reference. This is optional.
=over 2
=item * C<force>
If this option is a true value, the compilation and link are forced.
=back
=head2 build_dynamic_lib_dist_native
  $builder->build_dynamic_lib_dist_native($class_name)
  $builder->build_dynamic_lib_dist_native($class_name, $options)
Generates a dynamic library for a precompilation class $class_name that has C<native> methods, and copies it into the C<blib/lib> directory.
A precompilation class must have at least one method with L<precompile attribute|SPVM::Document::Language::Class/"Method Attributes">.
Options:
$options is a hash reference. This is optional.
=over 2
=item * C<force>
If this option is a true value, the compilation and link are forced.
=back