1 package DBM::Deep::Array;
8 our $VERSION = q(1.0002);
10 # This is to allow DBM::Deep::Array to handle negative indices on
11 # its own. Otherwise, Perl would intercept the call to negative
12 # indices for us. This was causing bugs for negative index handling.
13 our $NEGATIVE_INDICES = 1;
20 eval { local $SIG{'__DIE__'}; tied( @{$_[0]} ) } || $_[0]
23 sub _repr { shift;[ @_ ] }
29 $self->push( @$struct );
36 my $args = $class->_get_args( @_ );
38 $args->{type} = $class->TYPE_ARRAY;
40 return $class->_init($args);
44 my $self = shift->_get_self;
47 $self->lock( $self->LOCK_SH );
49 if ( !defined $key ) {
50 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
52 elsif ( $key =~ /^-?\d+$/ ) {
54 $key += $self->FETCHSIZE;
55 unless ( $key >= 0 ) {
61 elsif ( $key ne 'length' ) {
63 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
66 my $rv = $self->SUPER::FETCH( $key );
74 my $self = shift->_get_self;
75 my ($key, $value) = @_;
77 $self->lock( $self->LOCK_EX );
81 if ( !defined $key ) {
82 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
84 elsif ( $key =~ /^-?\d+$/ ) {
87 $size = $self->FETCHSIZE;
88 if ( $key + $size < 0 ) {
89 die( "Modification of non-creatable array value attempted, subscript $key" );
94 elsif ( $key ne 'length' ) {
96 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
99 my $rv = $self->SUPER::STORE( $key, $value );
101 if ( $idx_is_numeric ) {
102 $size = $self->FETCHSIZE unless defined $size;
103 if ( $key >= $size ) {
104 $self->STORESIZE( $key + 1 );
114 my $self = shift->_get_self;
117 $self->lock( $self->LOCK_SH );
119 if ( !defined $key ) {
120 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
122 elsif ( $key =~ /^-?\d+$/ ) {
124 $key += $self->FETCHSIZE;
125 unless ( $key >= 0 ) {
131 elsif ( $key ne 'length' ) {
133 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
136 my $rv = $self->SUPER::EXISTS( $key );
144 my $self = shift->_get_self;
147 $self->lock( $self->LOCK_EX );
149 my $size = $self->FETCHSIZE;
150 if ( !defined $key ) {
151 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
153 elsif ( $key =~ /^-?\d+$/ ) {
156 unless ( $key >= 0 ) {
162 elsif ( $key ne 'length' ) {
164 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
167 my $rv = $self->SUPER::DELETE( $key );
169 if ($rv && $key == $size - 1) {
170 $self->STORESIZE( $key );
178 # Now that we have a real Reference sector, we should store arrayzize there. However,
179 # arraysize needs to be transactionally-aware, so a simple location to store it isn't
182 my $self = shift->_get_self;
184 $self->lock( $self->LOCK_SH );
186 my $SAVE_FILTER = $self->_storage->{filter_fetch_value};
187 $self->_storage->{filter_fetch_value} = undef;
189 my $size = $self->FETCH('length') || 0;
191 $self->_storage->{filter_fetch_value} = $SAVE_FILTER;
199 my $self = shift->_get_self;
200 my ($new_length) = @_;
202 $self->lock( $self->LOCK_EX );
204 my $SAVE_FILTER = $self->_storage->{filter_store_value};
205 $self->_storage->{filter_store_value} = undef;
207 my $result = $self->STORE('length', $new_length, 'length');
209 $self->_storage->{filter_store_value} = $SAVE_FILTER;
217 my $self = shift->_get_self;
219 $self->lock( $self->LOCK_EX );
221 my $length = $self->FETCHSIZE();
224 my $content = $self->FETCH( $length - 1 );
225 $self->DELETE( $length - 1 );
238 my $self = shift->_get_self;
240 $self->lock( $self->LOCK_EX );
242 my $length = $self->FETCHSIZE();
244 while (my $content = shift @_) {
245 $self->STORE( $length, $content );
254 # XXX This really needs to be something more direct within the file, not a
255 # fetch and re-store. -RobK, 2007-09-20
258 my ($old_key, $new_key) = @_;
260 my $val = $self->FETCH( $old_key );
261 if ( eval { local $SIG{'__DIE__'}; $val->isa( 'DBM::Deep::Hash' ) } ) {
262 $self->STORE( $new_key, { %$val } );
264 elsif ( eval { local $SIG{'__DIE__'}; $val->isa( 'DBM::Deep::Array' ) } ) {
265 $self->STORE( $new_key, [ @$val ] );
268 $self->STORE( $new_key, $val );
273 my $self = shift->_get_self;
275 $self->lock( $self->LOCK_EX );
277 my $length = $self->FETCHSIZE();
280 my $content = $self->FETCH( 0 );
282 for (my $i = 0; $i < $length - 1; $i++) {
283 $self->_move_value( $i+1, $i );
285 $self->DELETE( $length - 1 );
298 my $self = shift->_get_self;
299 my @new_elements = @_;
301 $self->lock( $self->LOCK_EX );
303 my $length = $self->FETCHSIZE();
304 my $new_size = scalar @new_elements;
307 for (my $i = $length - 1; $i >= 0; $i--) {
308 $self->_move_value( $i, $i+$new_size );
312 for (my $i = 0; $i < $new_size; $i++) {
313 $self->STORE( $i, $new_elements[$i] );
318 return $length + $new_size;
322 my $self = shift->_get_self;
324 $self->lock( $self->LOCK_EX );
326 my $length = $self->FETCHSIZE();
329 # Calculate offset and length of splice
332 $offset = 0 unless defined $offset;
333 if ($offset < 0) { $offset += $length; }
336 if (scalar @_) { $splice_length = shift; }
337 else { $splice_length = $length - $offset; }
338 if ($splice_length < 0) { $splice_length += ($length - $offset); }
341 # Setup array with new elements, and copy out old elements for return
343 my @new_elements = @_;
344 my $new_size = scalar @new_elements;
346 my @old_elements = map {
348 } $offset .. ($offset + $splice_length - 1);
351 # Adjust array length, and shift elements to accomodate new section.
353 if ( $new_size != $splice_length ) {
354 if ($new_size > $splice_length) {
355 for (my $i = $length - 1; $i >= $offset + $splice_length; $i--) {
356 $self->_move_value( $i, $i + ($new_size - $splice_length) );
360 for (my $i = $offset + $splice_length; $i < $length; $i++) {
361 $self->_move_value( $i, $i + ($new_size - $splice_length) );
363 for (my $i = 0; $i < $splice_length - $new_size; $i++) {
364 $self->DELETE( $length - 1 );
371 # Insert new elements into array
373 for (my $i = $offset; $i < $offset + $new_size; $i++) {
374 $self->STORE( $i, shift @new_elements );
380 # Return deleted section, or last element in scalar context.
382 return wantarray ? @old_elements : $old_elements[-1];
385 # We don't need to populate it, yet.
386 # It will be useful, though, when we split out HASH and ARRAY
389 # Perl will call EXTEND() when the array is likely to grow.
390 # We don't care, but include it because it gets called at times.
398 my $length = $self->length();
399 for (my $index = 0; $index < $length; $index++) {
400 my $value = $self->get($index);
401 $self->_copy_value( \$db_temp->[$index], $value );
408 # Public method aliases
410 sub length { (shift)->FETCHSIZE(@_) }
411 sub pop { (shift)->POP(@_) }
412 sub push { (shift)->PUSH(@_) }
413 sub unshift { (shift)->UNSHIFT(@_) }
414 sub splice { (shift)->SPLICE(@_) }
416 # This must be last otherwise we have to qualify all other calls to shift
417 # as calls to CORE::shift
418 sub shift { (CORE::shift)->SHIFT(@_) }