File Coverage

blib/lib/SPVM/Builder/Util/API.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	6	66.6
pod	3	3	100.0
total	17	21	80.9

package SPVM::Builder::Util::API;

use strict;
use warnings;
use SPVM::Builder::Util;

sub create_make_rule_native { SPVM::Builder::Util::create_make_rule_native(@_) }

sub create_make_rule_precompile { SPVM::Builder::Util::create_make_rule_precompile(@_) }

sub create_default_config { SPVM::Builder::Util::create_default_config(@_) }

1;

=head1 Name

SPVM::Builder::Util::API - Defining Public Functions of SPVM::Builder::Util

=head1 Description

The SPVM::Builder::Util::API class defines the public functions of the L class.

=head1 Usage

  my $native_make_rule = SPVM::Builder::Util::API::create_make_rule_native('Foo');

  my $precompile_make_rule = SPVM::Builder::Util::API::create_make_rule_precompile('Foo');

=head1 Functions

=head2 create_make_rule_native

  my $make_rule = SPVM::Builder::Util::API::create_make_rule_native($basic_type_name);

Creates a rule written by C commands to generate a dynamic library for the class $basic_type_name that contains native methods, and returns the rule.

Examples:

  # Makefile.PL
  sub MY::postamble {

    my $make_rule = '';

    # Native compile make rule
    $make_rule .= SPVM::Builder::Util::API::create_make_rule_native('Foo');

    return $make_rule;
  }

=head2 create_make_rule_precompile

  my $make_rule = SPVM::Builder::Util::API::create_make_rule_precompile($basic_type_name);

Creates a rule written by C commands to generate a dynamic library for the class $basic_type_name that contains precompiled methods, and returns the rule.

Examples:

  # Makefile.PL
  sub MY::postamble {

    my $make_rule = '';

    # Precompile make rule
    $make_rule .= SPVM::Builder::Util::API::create_make_rule_precompile('Foo');

    return $make_rule;
  }

=head2 create_default_config

  my $config = SPVM::Builder::Util::API::create_default_config();

Creates a default config, and returns it. The config is a L object.

The current implementation is the following one.

  my $config = SPVM::Builder::Config->new_gnu99(file_optional => 1);

=head1 Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License