File Coverage

blib/lib/SPVM/Builder/LibInfo.pm

Criterion	Covered	Total	%
statement	56	72	77.7
branch	13	22	59.0
condition			n/a
subroutine	12	16	75.0
pod	8	8	100.0
total	89	118	75.4

package SPVM::Builder::LibInfo;

use strict;
use warnings;
use Config;
use Carp 'confess';
use File::Basename 'dirname';

use overload bool => sub {1}, '""' => sub { shift->to_string }, fallback => 1;

# Fields
sub name {
  my $self = shift;
  if (@_) {
    $self->{name} = $_[0];
    return $self;
  }
  else {
    return $self->{name};
  }
}

sub file {
  my $self = shift;
  if (@_) {
    $self->{file} = $_[0];
    return $self;
  }
  else {
    return $self->{file};
  }
}

sub is_static {
  my $self = shift;
  if (@_) {
    $self->{is_static} = $_[0];
    return $self;
  }
  else {
    return $self->{is_static};
  }
}

sub is_abs {
  my $self = shift;
  if (@_) {
    $self->{is_abs} = $_[0];
    return $self;
  }
  else {
    return $self->{is_abs};
  }
}

sub static_option_cb {
  my $self = shift;
  if (@_) {
    $self->{static_option_cb} = $_[0];
    return $self;
  }
  else {
    return $self->{static_option_cb};
  }
}

# Class Methods
sub new {
  my $class = shift;

  my $self = {@_};

  bless $self, $class;

  unless (defined $self->is_static) {
    $self->is_static(0);
  }

  unless (defined $self->is_abs) {
    $self->is_abs(0);
  }

  unless (defined $self->static_option_cb) {
    my $default_static_option_cb = sub {
      my ($self, $name) = @_;

      $name = "-Wl,-Bstatic -l$name -Wl,-Bdynamic";

      return $name;
    };
    $self->static_option_cb($default_static_option_cb);
  }

  return $self;
}

# Instance Methods
sub to_arg {
  my ($self) = @_;

  my $link_command_arg;

  if ($self->is_abs) {
    if (defined $self->file) {
      $link_command_arg = $self->file;
    }
    else {
      $link_command_arg = "";
    }
  }
  else {
    my $name = $self->name;
    if ($self->is_static) {
      $link_command_arg = $self->static_option_cb->($self, $name);
    }
    else {
      $link_command_arg = "-l$name";
    }
  }

  return $link_command_arg;
}

sub to_string {
  my ($self) = @_;

  return $self->name;
}

1;

=head1 Name

SPVM::Builder::LibInfo - Library Information

=head1 Description

The SPVM::Builder::LibInfo class has methods to manipulate library information.

=head1 Usage

  my $lib_info = SPVM::Builder::LibInfo->new(%fields);
  my $lib_arg = $lib_info->to_arg;

=head1 Fields

=head2 name

  my $name = $lib_info->name;
  $lib_info->name($name);

Gets and sets the C field.

This field is a library name.

Examples:

  $lib_info->name('z');

  $lib_info->name('png');

=head2 file

  my $file = $lib_info->file;
  $lib_info->file($file);

Gets and sets the C field.

This field is the absolute path of the library file like C, C.

=head2 is_static

  my $is_static = $lib_info->is_static;
  $lib_info->is_static($is_static);

Gets and sets the C field.

If this field is a true value, a static library is linked.

=head2 is_abs

  my $is_abs = $lib_info->is_abs;
  $lib_info->is_abs($is_abs);

Gets and sets the C field.

If this field is a true value, the library is linked by the library name like C<-lfoo>.

Otherwise the library is linked by the absolute path of the library like C.

=head2 static_option_cb

  my $static_option_cb = $lib_info->static_option_cb;
  $lib_info->static_option_cb($static_option_cb);

Gets and sets the C field.

This field is the callback to create a linker option to link a static library.

=head1 Class Methods

=head2 new

  my $lib_info = SPVM::Builder::LibInfo->new(%fields);

Creates a L object with L.

Default Field Values:

If a field is not defined, the field is set to the following default value.

=over 2

=item * L

undef

=item * L

undef

=item * L

0

=item * L

0

=item * L

  sub {
    my ($self, $name) = @_;

    $name = "-Wl,-Bstatic -l$name -Wl,-Bdynamic";

    return $name;
  };

=back

=head1 Instance Methods

=head2 to_arg

  my $link_command_arg = $lib_info->to_arg;

Creates an argument of the link command from the L field and L field, and returns it.

The following ones are examples of the return value.

  -lfoo
  -Wl,-Bstatic -lfoo -Wl,-Bdynamic
  /path/foo.so
  /path/foo.a

=head2 to_string

  my $lib_name = $lib_info->to_string;

Returns the L field.

=head1 Operators

Overloads the following operators.

=head2 bool

  my $bool = !!$lib_info;

Always true.

=head2 stringify

  my $lib_name = "$lib_info";

Alias for the L method.

=head1 Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License