(RT #44981) Added VERSION to ::Array, ::Engine, and ::Hash
[dbsrgits/DBM-Deep.git] / lib / DBM / Deep / Array.pm
index 74dad6c..4b8a2cc 100644 (file)
@@ -1,11 +1,11 @@
 package DBM::Deep::Array;
 
-use 5.6.0;
+use 5.006_000;
 
 use strict;
-use warnings;
+use warnings FATAL => 'all';
 
-our $VERSION = '0.99_03';
+our $VERSION = $DBM::Deep::VERSION;
 
 # This is to allow DBM::Deep::Array to handle negative indices on
 # its own. Otherwise, Perl would intercept the call to negative
@@ -20,21 +20,8 @@ sub _get_self {
     eval { local $SIG{'__DIE__'}; tied( @{$_[0]} ) } || $_[0]
 }
 
-sub _repr { shift;[ @_ ] }
+sub _repr { [] }
 
-sub _import {
-    my $self = shift;
-    my ($struct) = @_;
-
-    eval {
-        local $SIG{'__DIE__'};
-        $self->push( @$struct );
-    }; if ($@) {
-        $self->_throw_error("Cannot import: type mismatch");
-    }
-
-    return 1;
-}
 sub TIEARRAY {
     my $class = shift;
     my $args = $class->_get_args( @_ );
@@ -48,10 +35,13 @@ sub FETCH {
     my $self = shift->_get_self;
     my ($key) = @_;
 
-    $self->lock( $self->LOCK_SH );
+    $self->lock_shared;
 
-    my $orig_key;
-    if ( $key =~ /^-?\d+$/ ) {
+    if ( !defined $key ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use an undefined array index." );
+    }
+    elsif ( $key =~ /^-?\d+$/ ) {
         if ( $key < 0 ) {
             $key += $self->FETCHSIZE;
             unless ( $key >= 0 ) {
@@ -59,13 +49,13 @@ sub FETCH {
                 return;
             }
         }
-        $orig_key = $key;
     }
-    else {
-        $orig_key = undef;
+    elsif ( $key ne 'length' ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
     }
 
-    my $rv = $self->SUPER::FETCH( $key, $orig_key );
+    my $rv = $self->SUPER::FETCH( $key );
 
     $self->unlock;
 
@@ -76,11 +66,15 @@ sub STORE {
     my $self = shift->_get_self;
     my ($key, $value) = @_;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
     my $size;
     my $idx_is_numeric;
-    if ( $key =~ /^\-?\d+$/ ) {
+    if ( !defined $key ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use an undefined array index." );
+    }
+    elsif ( $key =~ /^-?\d+$/ ) {
         $idx_is_numeric = 1;
         if ( $key < 0 ) {
             $size = $self->FETCHSIZE;
@@ -90,8 +84,12 @@ sub STORE {
             $key += $size
         }
     }
+    elsif ( $key ne 'length' ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
+    }
 
-    my $rv = $self->SUPER::STORE( $key, $value, ($key eq 'length' ? undef : $key) );
+    my $rv = $self->SUPER::STORE( $key, $value );
 
     if ( $idx_is_numeric ) {
         $size = $self->FETCHSIZE unless defined $size;
@@ -109,9 +107,13 @@ sub EXISTS {
     my $self = shift->_get_self;
     my ($key) = @_;
 
-    $self->lock( $self->LOCK_SH );
+    $self->lock_shared;
 
-    if ( $key =~ /^\-?\d+$/ ) {
+    if ( !defined $key ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use an undefined array index." );
+    }
+    elsif ( $key =~ /^-?\d+$/ ) {
         if ( $key < 0 ) {
             $key += $self->FETCHSIZE;
             unless ( $key >= 0 ) {
@@ -120,6 +122,10 @@ sub EXISTS {
             }
         }
     }
+    elsif ( $key ne 'length' ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
+    }
 
     my $rv = $self->SUPER::EXISTS( $key );
 
@@ -131,11 +137,16 @@ sub EXISTS {
 sub DELETE {
     my $self = shift->_get_self;
     my ($key) = @_;
+    warn "ARRAY::DELETE($self,$key)\n" if DBM::Deep::DEBUG;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
     my $size = $self->FETCHSIZE;
-    if ( $key =~ /^-?\d+$/ ) {
+    if ( !defined $key ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use an undefined array index." );
+    }
+    elsif ( $key =~ /^-?\d+$/ ) {
         if ( $key < 0 ) {
             $key += $size;
             unless ( $key >= 0 ) {
@@ -144,11 +155,15 @@ sub DELETE {
             }
         }
     }
+    elsif ( $key ne 'length' ) {
+        $self->unlock;
+        DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
+    }
 
     my $rv = $self->SUPER::DELETE( $key );
 
     if ($rv && $key == $size - 1) {
-        $self->STORESIZE( $key, ($key eq 'length' ? undef : $key) );
+        $self->STORESIZE( $key );
     }
 
     $self->unlock;
@@ -156,39 +171,38 @@ sub DELETE {
     return $rv;
 }
 
+# Now that we have a real Reference sector, we should store arrayzize there.
+# However, arraysize needs to be transactionally-aware, so a simple location to
+# store it isn't going to work.
 sub FETCHSIZE {
     my $self = shift->_get_self;
 
-    $self->lock( $self->LOCK_SH );
+    $self->lock_shared;
 
-    my $SAVE_FILTER = $self->_fileobj->{filter_fetch_value};
-    $self->_fileobj->{filter_fetch_value} = undef;
+    my $SAVE_FILTER = $self->_engine->storage->{filter_fetch_value};
+    $self->_engine->storage->{filter_fetch_value} = undef;
 
-    my $packed_size = $self->FETCH('length');
+    my $size = $self->FETCH('length') || 0;
 
-    $self->_fileobj->{filter_fetch_value} = $SAVE_FILTER;
+    $self->_engine->storage->{filter_fetch_value} = $SAVE_FILTER;
 
     $self->unlock;
 
-    if ($packed_size) {
-        return int(unpack($self->_engine->{long_pack}, $packed_size));
-    }
-
-    return 0;
+    return $size;
 }
 
 sub STORESIZE {
     my $self = shift->_get_self;
     my ($new_length) = @_;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
-    my $SAVE_FILTER = $self->_fileobj->{filter_store_value};
-    $self->_fileobj->{filter_store_value} = undef;
+    my $SAVE_FILTER = $self->_engine->storage->{filter_store_value};
+    $self->_engine->storage->{filter_store_value} = undef;
 
-    my $result = $self->STORE('length', pack($self->_engine->{long_pack}, $new_length), 'length');
+    my $result = $self->STORE('length', $new_length, 'length');
 
-    $self->_fileobj->{filter_store_value} = $SAVE_FILTER;
+    $self->_engine->storage->{filter_store_value} = $SAVE_FILTER;
 
     $self->unlock;
 
@@ -198,7 +212,7 @@ sub STORESIZE {
 sub POP {
     my $self = shift->_get_self;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
     my $length = $self->FETCHSIZE();
 
@@ -219,7 +233,7 @@ sub POP {
 sub PUSH {
     my $self = shift->_get_self;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
     my $length = $self->FETCHSIZE();
 
@@ -233,44 +247,59 @@ sub PUSH {
     return $length;
 }
 
+# XXX This really needs to be something more direct within the file, not a
+# fetch and re-store. -RobK, 2007-09-20
+sub _move_value {
+    my $self = shift;
+    my ($old_key, $new_key) = @_;
+
+    return $self->_engine->make_reference( $self, $old_key, $new_key );
+}
+
 sub SHIFT {
     my $self = shift->_get_self;
+    warn "SHIFT($self)\n" if DBM::Deep::DEBUG;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
     my $length = $self->FETCHSIZE();
 
-    if ($length) {
-        my $content = $self->FETCH( 0 );
+    if ( !$length ) {
+        $self->unlock;
+        return;
+    }
+
+    my $content = $self->DELETE( 0 );
 
+    # Unless the deletion above has cleared the array ...
+    if ( $length > 1 ) {
         for (my $i = 0; $i < $length - 1; $i++) {
-            $self->STORE( $i, $self->FETCH($i + 1) );
+            $self->_move_value( $i+1, $i );
         }
+
         $self->DELETE( $length - 1 );
+    }
 
-        $self->unlock;
+    $self->unlock;
 
-        return $content;
-    }
-    else {
-        $self->unlock;
-        return;
-    }
+    return $content;
 }
 
 sub UNSHIFT {
     my $self = shift->_get_self;
     my @new_elements = @_;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
     my $length = $self->FETCHSIZE();
     my $new_size = scalar @new_elements;
 
     if ($length) {
         for (my $i = $length - 1; $i >= 0; $i--) {
-            $self->STORE( $i + $new_size, $self->FETCH($i) );
+            $self->_move_value( $i, $i+$new_size );
         }
+
+        $self->STORESIZE( $length + $new_size );
     }
 
     for (my $i = 0; $i < $new_size; $i++) {
@@ -285,7 +314,7 @@ sub UNSHIFT {
 sub SPLICE {
     my $self = shift->_get_self;
 
-    $self->lock( $self->LOCK_EX );
+    $self->lock_exclusive;
 
     my $length = $self->FETCHSIZE();
 
@@ -317,12 +346,13 @@ sub SPLICE {
     if ( $new_size != $splice_length ) {
         if ($new_size > $splice_length) {
             for (my $i = $length - 1; $i >= $offset + $splice_length; $i--) {
-                $self->STORE( $i + ($new_size - $splice_length), $self->FETCH($i) );
+                $self->_move_value( $i, $i + ($new_size - $splice_length) );
             }
+            $self->STORESIZE( $length + $new_size - $splice_length );
         }
         else {
             for (my $i = $offset + $splice_length; $i < $length; $i++) {
-                $self->STORE( $i + ($new_size - $splice_length), $self->FETCH($i) );
+                $self->_move_value( $i, $i + ($new_size - $splice_length) );
             }
             for (my $i = 0; $i < $splice_length - $new_size; $i++) {
                 $self->DELETE( $length - 1 );
@@ -346,14 +376,11 @@ sub SPLICE {
     return wantarray ? @old_elements : $old_elements[-1];
 }
 
-# We don't need to define it, yet.
+# We don't need to populate it, yet.
 # It will be useful, though, when we split out HASH and ARRAY
-sub EXTEND {
-    ##
-    # Perl will call EXTEND() when the array is likely to grow.
-    # We don't care, but include it because it gets called at times.
-    ##
-}
+# Perl will call EXTEND() when the array is likely to grow.
+# We don't care, but include it because it gets called at times.
+sub EXTEND {}
 
 sub _copy_node {
     my $self = shift;
@@ -361,21 +388,17 @@ sub _copy_node {
 
     my $length = $self->length();
     for (my $index = 0; $index < $length; $index++) {
-        my $value = $self->get($index);
-        $self->_copy_value( \$db_temp->[$index], $value );
+        $self->_copy_value( \$db_temp->[$index], $self->get($index) );
     }
 
     return 1;
 }
 
-##
-# Public method aliases
-##
-sub length { (shift)->FETCHSIZE(@_) }
-sub pop { (shift)->POP(@_) }
-sub push { (shift)->PUSH(@_) }
-sub unshift { (shift)->UNSHIFT(@_) }
-sub splice { (shift)->SPLICE(@_) }
+sub length  { (shift)->FETCHSIZE(@_) }
+sub pop     { (shift)->POP(@_)       }
+sub push    { (shift)->PUSH(@_)      }
+sub unshift { (shift)->UNSHIFT(@_)   }
+sub splice  { (shift)->SPLICE(@_)    }
 
 # This must be last otherwise we have to qualify all other calls to shift
 # as calls to CORE::shift