Updated version number to 0.99_01 to reflect dev path to 1.00
[dbsrgits/DBM-Deep.git] / lib / DBM / Deep / Array.pm
index 4cb8919..4c24806 100644 (file)
@@ -1,15 +1,19 @@
 package DBM::Deep::Array;
 
-$NEGATIVE_INDICES = 1;
-
 use strict;
 
+# This is to allow DBM::Deep::Array to handle negative indices on
+# its own. Otherwise, Perl would intercept the call to negative
+# indices for us. This was causing bugs for negative index handling.
+use vars qw( $NEGATIVE_INDICES );
+$NEGATIVE_INDICES = 1;
+
 use base 'DBM::Deep';
 
 use Scalar::Util ();
 
 sub _get_self {
-    eval { tied( @{$_[0]} ) } || $_[0]
+    eval { local $SIG{'__DIE__'}; tied( @{$_[0]} ) } || $_[0]
 }
 
 sub TIEARRAY {
@@ -17,22 +21,7 @@ sub TIEARRAY {
 # Tied array constructor method, called by Perl's tie() function.
 ##
     my $class = shift;
-    my $args;
-    if (scalar(@_) > 1) {
-        if ( @_ % 2 ) {
-            $class->_throw_error( "Odd number of parameters to TIEARRAY" );
-        }
-        $args = {@_};
-    }
-       elsif ( my $type = Scalar::Util::reftype($_[0]) ) {
-        if ( $type ne 'HASH' ) {
-            $class->_throw_error( "Not a hashref in TIEARRAY" );
-        }
-        $args = $_[0];
-    }
-       else {
-        $args = { file => shift };
-    }
+    my $args = $class->_get_args( @_ );
        
        $args->{type} = $class->TYPE_ARRAY;
        
@@ -43,32 +32,45 @@ sub FETCH {
     my $self = $_[0]->_get_self;
     my $key = $_[1];
 
+       $self->lock( $self->LOCK_SH );
+       
     if ( $key =~ /^-?\d+$/ ) {
         if ( $key < 0 ) {
             $key += $self->FETCHSIZE;
-            return unless $key >= 0;
+            unless ( $key >= 0 ) {
+                $self->unlock;
+                return;
+            }
         }
 
         $key = pack($DBM::Deep::LONG_PACK, $key);
     }
 
-    return $self->SUPER::FETCH( $key );
+    my $rv = $self->SUPER::FETCH( $key );
+
+    $self->unlock;
+
+    return $rv;
 }
 
 sub STORE {
     my $self = shift->_get_self;
     my ($key, $value) = @_;
 
-    my $unpacked_key = $key;
-    my $size = $self->FETCHSIZE;
+    $self->lock( $self->LOCK_EX );
+
+    my $orig = $key;
 
+    my $size;
     my $numeric_idx;
-    if ( $key =~ /^-?\d+$/ ) {
+    if ( $key =~ /^\-?\d+$/ ) {
         $numeric_idx = 1;
         if ( $key < 0 ) {
+            $size = $self->FETCHSIZE;
             $key += $size;
-            #XXX What to do here?
-#            return unless $key >= 0;
+            if ( $key < 0 ) {
+                die( "Modification of non-creatable array value attempted, subscript $orig" );
+            }
         }
 
         $key = pack($DBM::Deep::LONG_PACK, $key);
@@ -76,10 +78,72 @@ sub STORE {
 
     my $rv = $self->SUPER::STORE( $key, $value );
 
-    if ( $numeric_idx && $rv == 2 && $unpacked_key >= $size ) {
-        $self->STORESIZE( $unpacked_key + 1 );
+    if ( $numeric_idx && $rv == 2 ) {
+        $size = $self->FETCHSIZE unless defined $size;
+        if ( $orig >= $size ) {
+            $self->STORESIZE( $orig + 1 );
+        }
     }
 
+    $self->unlock;
+
+    return $rv;
+}
+
+sub EXISTS {
+    my $self = $_[0]->_get_self;
+    my $key = $_[1];
+
+       $self->lock( $self->LOCK_SH );
+
+    if ( $key =~ /^\-?\d+$/ ) {
+        if ( $key < 0 ) {
+            $key += $self->FETCHSIZE;
+            unless ( $key >= 0 ) {
+                $self->unlock;
+                return;
+            }
+        }
+
+        $key = pack($DBM::Deep::LONG_PACK, $key);
+    }
+
+    my $rv = $self->SUPER::EXISTS( $key );
+
+    $self->unlock;
+
+    return $rv;
+}
+
+sub DELETE {
+    my $self = $_[0]->_get_self;
+    my $key = $_[1];
+
+    my $unpacked_key = $key;
+
+    $self->lock( $self->LOCK_EX );
+
+    my $size = $self->FETCHSIZE;
+    if ( $key =~ /^-?\d+$/ ) {
+        if ( $key < 0 ) {
+            $key += $size;
+            unless ( $key >= 0 ) {
+                $self->unlock;
+                return;
+            }
+        }
+
+        $key = pack($DBM::Deep::LONG_PACK, $key);
+    }
+
+    my $rv = $self->SUPER::DELETE( $key );
+
+       if ($rv && $unpacked_key == $size - 1) {
+               $self->STORESIZE( $unpacked_key );
+       }
+
+    $self->unlock;
+
     return $rv;
 }
 
@@ -87,15 +151,19 @@ sub FETCHSIZE {
        ##
        # Return the length of the array
        ##
-    my $self = $_[0]->_get_self;
-       
-       my $SAVE_FILTER = $self->root->{filter_fetch_value};
-       $self->root->{filter_fetch_value} = undef;
+    my $self = shift->_get_self;
+
+    $self->lock( $self->LOCK_SH );
+
+       my $SAVE_FILTER = $self->_root->{filter_fetch_value};
+       $self->_root->{filter_fetch_value} = undef;
        
        my $packed_size = $self->FETCH('length');
        
-       $self->root->{filter_fetch_value} = $SAVE_FILTER;
+       $self->_root->{filter_fetch_value} = $SAVE_FILTER;
        
+    $self->unlock;
+
        if ($packed_size) {
         return int(unpack($DBM::Deep::LONG_PACK, $packed_size));
     }
@@ -110,13 +178,17 @@ sub STORESIZE {
     my $self = $_[0]->_get_self;
        my $new_length = $_[1];
        
-       my $SAVE_FILTER = $self->root->{filter_store_value};
-       $self->root->{filter_store_value} = undef;
+    $self->lock( $self->LOCK_EX );
+
+       my $SAVE_FILTER = $self->_root->{filter_store_value};
+       $self->_root->{filter_store_value} = undef;
        
        my $result = $self->STORE('length', pack($DBM::Deep::LONG_PACK, $new_length));
        
-       $self->root->{filter_store_value} = $SAVE_FILTER;
+       $self->_root->{filter_store_value} = $SAVE_FILTER;
        
+    $self->unlock;
+
        return $result;
 }
 
@@ -125,14 +197,21 @@ sub POP {
        # Remove and return the last element on the array
        ##
     my $self = $_[0]->_get_self;
+
+    $self->lock( $self->LOCK_EX );
+
        my $length = $self->FETCHSIZE();
        
        if ($length) {
                my $content = $self->FETCH( $length - 1 );
                $self->DELETE( $length - 1 );
+
+        $self->unlock;
+
                return $content;
        }
        else {
+        $self->unlock;
                return;
        }
 }
@@ -142,13 +221,18 @@ sub PUSH {
        # Add new element(s) to the end of the array
        ##
     my $self = shift->_get_self;
-       my $length = $self->FETCHSIZE();
        
+    $self->lock( $self->LOCK_EX );
+
+       my $length = $self->FETCHSIZE();
+
        while (my $content = shift @_) {
                $self->STORE( $length, $content );
                $length++;
        }
 
+    $self->unlock;
+
     return $length;
 }
 
@@ -158,6 +242,9 @@ sub SHIFT {
        # Shift over remaining elements to take up space.
        ##
     my $self = $_[0]->_get_self;
+
+    $self->lock( $self->LOCK_EX );
+
        my $length = $self->FETCHSIZE();
        
        if ($length) {
@@ -170,10 +257,13 @@ sub SHIFT {
                        $self->STORE( $i, $self->FETCH($i + 1) );
                }
                $self->DELETE( $length - 1 );
+
+        $self->unlock;
                
                return $content;
        }
        else {
+        $self->unlock;
                return;
        }
 }
@@ -185,6 +275,9 @@ sub UNSHIFT {
        ##
     my $self = shift->_get_self;
        my @new_elements = @_;
+
+    $self->lock( $self->LOCK_EX );
+
        my $length = $self->FETCHSIZE();
        my $new_size = scalar @new_elements;
        
@@ -198,6 +291,8 @@ sub UNSHIFT {
                $self->STORE( $i, $new_elements[$i] );
        }
 
+    $self->unlock;
+
     return $length + $new_size;
 }
 
@@ -207,12 +302,16 @@ sub SPLICE {
        # Returns deleted section, or last element deleted in scalar context.
        ##
     my $self = shift->_get_self;
+
+    $self->lock( $self->LOCK_EX );
+
        my $length = $self->FETCHSIZE();
        
        ##
        # Calculate offset and length of splice
        ##
-       my $offset = shift || 0;
+       my $offset = shift;
+    $offset = 0 unless defined $offset;
        if ($offset < 0) { $offset += $length; }
        
        my $splice_length;
@@ -226,10 +325,9 @@ sub SPLICE {
        my @new_elements = @_;
        my $new_size = scalar @new_elements;
        
-       my @old_elements = ();
-       for (my $i = $offset; $i < $offset + $splice_length; $i++) {
-               push @old_elements, $self->FETCH( $i );
-       }
+    my @old_elements = map {
+        $self->FETCH( $_ )
+    } $offset .. ($offset + $splice_length - 1);
        
        ##
        # Adjust array length, and shift elements to accomodate new section.
@@ -258,13 +356,15 @@ sub SPLICE {
                $self->STORE( $i, shift @new_elements );
        }
        
+    $self->unlock;
+
        ##
        # Return deleted section, or last element in scalar context.
        ##
        return wantarray ? @old_elements : $old_elements[-1];
 }
 
-#XXX We don't need to define it.
+#XXX We don't need to define it, yet.
 #XXX It will be useful, though, when we split out HASH and ARRAY
 #sub EXTEND {
        ##