++ed by:
BRDUCH FAYLAND XYF KES SKOLYCHEV
7 non-PAUSE users
Author image Yuki Kimoto

NAME

SPVM::StringList - Dynamic string array

SYNOPSYS

  use SPVM::StringList;
  
  # Create a string list
  my $string_list = SPVM::StringList->new_len(10);

  # Create a string list with array
  my $string_list = SPVM::StringList->new(["abc", "def", "ghi"]);
  
  # Get list length
  my $length = $string_list->length;
  
  # Push string value
  $string_list->push("abc");

  # Pop string value.
  my $string_value = $string_list->pop;

  # Unshift string value.
  $string_list->unshift("abc");
  
  # Shift string value.
  my $string_value = $string_list->shift;
  
  # Set string value.
  $string_list->set(2, "abc");

  # Get string value.
  my $string_value = $string_list->get(2);

  # Insert string value
  $string_list->insert(1, "abc");

  # Remove string value
  my $string_value = $string_list->remove(1);

  # Convert SPVM::StringList to string array.
  my $string_array = $string_list->to_array;

DESCRIPTION

SPVM::StringList is dynamic string array.

STATIC METHODS

new

    sub new : SPVM::StringList ($array : string[])

Create a new SPVM::StringList object with specific string array.

Internally, new array is created, and each element of argument array is copied to internal array.

If array is undef, 0-length internal array is created.

new_len

    sub new_len : SPVM::StringList ($length : int)

Create a new SPVM::StringList object with array length.

INSTANCE METHODS

get

  sub get : string ($self : self, $index : int)

Get the value with index.

length

  sub length : int ()

Get list length.

insert

  sub insert : void ($self : self, $index : int, $value : string)

Insert a element to the specific index.

pop

  sub pop : string ($self : self)

Pops and returns the last value of the list, shortening the array by one element If there are no elements in the list, exception occur.

push

  sub push : void ($self : self, $value : string)

Appending the value to the end of list.

remove

  sub remove : string ($self : self, $index : int)

Remove and return the element which is specified by the index.

resize

  sub resize : void ($self : self, $new_length : int)

Resize this list. If the new length is shorter than the current length, the list is truncated to the new length. If the new length is shorter than the current length, the list is truncated to the new length. If the new length is same as the current length, there is nothing to do. If the new length is longer than the current length, the list grows to the new length, and the values of the added elements are set to undef.

New length must be more than or equals to 0, otherwise a exception occur.

set

  sub set : void ($self : self, $index : int, $value : string)

Set the value with index.

set_array

  sub set_array : void ($self : self, $array : string[])

Set a array. Each elements of the array is copied to the correspoinding index of the array this list has. Note that this copy is address copy. Array must be defined, otherwise a exception occurs.

The length of argument array must be same as the length of current list array, otherwise a exception occures.

shift

  sub shift : string ($self : self)

Shifts the first value of the list off and returns it, shortening the array by 1 and moving everything down. If there are no elements in the list, exception occur.

to_array

  sub to_array : string[] ($self : self)

Convert SPVM::StringList to string array.

unshift

  sub unshift : void ($self : self, $value : string)

Appending the value to the top of list.