File Coverage

blib/lib/Data/RingBuffer.pm

Criterion	Covered	Total	%
statement	30	30	100.0
branch	18	18	100.0
condition			n/a
subroutine	8	8	100.0
pod	4	4	100.0
total	60	60	100.0

#!/usr/bin/perl
#made by: KorG
# vim: sw=4 ts=4 et cc=79 :

package Data::RingBuffer;

use 5.008;
use strict;
use warnings FATAL => 'all';
use Carp;

our $VERSION = '0.02';
$VERSION =~ tr/_//d;

# Add an element to the buffer
# args: $obj
sub push {
    if ($_[0]->{head} == $_[0]->{size}) {
        croak "Buffer overflow!" if exists $_[0]->{die_overflow};
        shift @{$_[0]->{buf}};
        $_[0]->{tail}-- if $_[0]->{tail} > 0;
    }

    push @{$_[0]->{buf}}, $_[1];

    $_[0]->{head}++ if $_[0]->{head} < $_[0]->{size};

    return $_[1];
}

# Get all elements in the buffer
sub getall {
    return $_[0]->{buf};
}

# Get next element from the buffer
sub get {
    my $rb = $_[0];
    return if $_[0]->{tail} >= $_[0]->{head};
    return $_[0]->{buf}->[$_[0]->{tail}++];
}

# OO ctor
# args: $size, (optional) { %options }
sub new {
    # Parse arguments
    croak "Buffer size not defined" unless defined $_[1];
    croak "Buffer size must be positive" unless $_[1] > 0;

    my %opts;
    if (ref $_[2] eq "HASH") {
        $opts{die_overflow} = undef if $_[2]->{die_overflow};
    }

    bless {
        buf => [],
        size => $_[1],
        head => 0,
        tail => 0,
        %opts,
    }, $_[0];
}

1; # End of Data::RingBuffer

__END__