File Coverage

blib/lib/SPVM.pm

Criterion	Covered	Total	%
statement	16	16	100.0
branch	2	2	100.0
condition			n/a
subroutine	6	6	100.0
pod	1	1	100.0
total	25	25	100.0

use 5.008007;
package SPVM;
use strict;
use warnings;

use SPVM::Global;

our $VERSION = "0.989047";

require XSLoader;
XSLoader::load('SPVM', $VERSION);

sub import {
  my ($class, $basic_type_name) = @_;

  my ($file, $line) = (caller)[1, 2];

  if (defined $basic_type_name) {
    SPVM::Global::build_module($basic_type_name, $file, $line);
  }
}

sub api { SPVM::Global::api() }

1;

=encoding utf8

=head1 Name

SPVM - SPVM Language

=head1 Description

SPVM is a statically typed programming language with the syntax of Perl.

SPVM has not yet reached a stable release of version 1.0. For now, L of methods and features will not be kept.

=head1 Usage

A class of SPVM:

  # lib/SPVM/MyMath.spvm
  class MyMath {
C

      my $total = 0;
      for (my $i = 0; $i < @$nums; $i++) {
        $total += $nums->[$i];
      }

      return $total;
    }
  }

Calling a SPVM method from Perl:

  # sum.pl
  use FindBin;
  use lib "$FindBin::Bin/lib";

  use SPVM 'MyMath';

  # Call method
  my $total = SPVM::MyMath->sum([3, 6, 8, 9]);

=head1 Documents

=over 2

=item * L - SPVM Tutorial

=item * L - SPVM Language Specification

=item * L - SPVM Standard Modules

=item * L - Exchange APIs

=item * L - Native Class

=item * L - Native APIs

=item * L - Resource

=item * L - Creating Executable File

=item * L - Creating SPVM Distribution

=item * L - SPVM Performance Benchmarks

=back

=head1 use

  use SPVM;
  use SPVM 'SomeClass';

Loads the L module.

If a class name of SPVM is given as the first argument, the SPVM module is loaded and is bound to a Perl module.

The bound Perl class name is prefixed with C.

Exceptions:

If the SPVM module cannot be loaded, an exception is thrown.

Examples:

  use SPVM 'Int';

  my $int_object = SPVM::Int->new(3);
  my $value = $int_object->value.

=head1 Functions

=head2 api

  my $api = SPVM::api();

Gets the global L object for this Perl interpreter.

=head1 Environment Variables

If an environment variable is an empty string, it is treated as an undefined value.

=head2 SPVM_BUILD_DIR

A directory for files generated by the compiler and linker.

C source codes for precompilation, dynamic link libraries and object files are stored into this directory.

These files are output when attempting to build a module containing methods with the C attribute or the C attribute.

If these files are output and the directory given by the C environment variable does not exist, an exception is thrown.
Examples:

  # bash
  export SPVM_BUILD_DIR=~/.spvm_build

  # csh
  setenv SPVM_BUILD_DIR ~/.spvm_build

=head2 SPVM_CC_DEBUG

If the C environement variable is a true value of Perl, debug messages and messages from the L compiler and linker are printed to stderr.

=head2 SPVM_CC_QUIET

If the C environement variable is a true value of Perl, messages the L compiler and linker are not printed to stderr.

If it is defined and a false value of Perl, the messages are printed.

This setting has a higher priority than the L field of the L module.

=head2 SPVM_CC_FORCE

If the C environement variable is a true value of Perl, the compilation and link by the L compiler and linker are forced.

This setting has a higher priority than the L field of the L module.

=head1 Repository

L

=head1 Author

Yuki Kimoto [e-mail]

=head1 Core Developers

[e-mail]

=head1 Contributors

=over 2

=item * Mohammad S Anwar

=item * akinomyoga

=item * NAGAYASU Shinya

=item * Reini Urban

=item * chromatic

=item * Kazutake Hiramatsu

=item * Yasuaki Omokawa

=item * Suman Khanal

=item * L

=item * L

=item * L

=item * L

=back

=head1 Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License

=cut