1 package DBM::Deep::Array;
6 use warnings FATAL => 'all';
8 our $VERSION = $DBM::Deep::VERSION;
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]
27 my $args = $class->_get_args( @_ );
29 $args->{type} = $class->TYPE_ARRAY;
31 return $class->_init($args);
35 my $self = shift->_get_self;
40 if ( !defined $key ) {
42 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
44 elsif ( $key =~ /^-?\d+$/ ) {
46 $key += $self->FETCHSIZE;
47 unless ( $key >= 0 ) {
53 elsif ( $key ne 'length' ) {
55 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
58 my $rv = $self->SUPER::FETCH( $key );
66 my $self = shift->_get_self;
67 my ($key, $value) = @_;
69 $self->lock_exclusive;
73 if ( !defined $key ) {
75 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
77 elsif ( $key =~ /^-?\d+$/ ) {
80 $size = $self->FETCHSIZE;
81 if ( $key + $size < 0 ) {
82 die( "Modification of non-creatable array value attempted, subscript $key" );
87 elsif ( $key ne 'length' ) {
89 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
92 my $rv = $self->SUPER::STORE( $key, $value );
94 if ( $idx_is_numeric ) {
95 $size = $self->FETCHSIZE unless defined $size;
96 if ( $key >= $size ) {
97 $self->STORESIZE( $key + 1 );
107 my $self = shift->_get_self;
112 if ( !defined $key ) {
114 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
116 elsif ( $key =~ /^-?\d+$/ ) {
118 $key += $self->FETCHSIZE;
119 unless ( $key >= 0 ) {
125 elsif ( $key ne 'length' ) {
127 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
130 my $rv = $self->SUPER::EXISTS( $key );
138 my $self = shift->_get_self;
140 warn "ARRAY::DELETE($self,$key)\n" if DBM::Deep::DEBUG;
142 $self->lock_exclusive;
144 my $size = $self->FETCHSIZE;
145 if ( !defined $key ) {
147 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
149 elsif ( $key =~ /^-?\d+$/ ) {
152 unless ( $key >= 0 ) {
158 elsif ( $key ne 'length' ) {
160 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
163 my $rv = $self->SUPER::DELETE( $key );
165 if ($rv && $key == $size - 1) {
166 $self->STORESIZE( $key );
174 # Now that we have a real Reference sector, we should store arrayzize there.
175 # However, arraysize needs to be transactionally-aware, so a simple location to
176 # store it isn't going to work.
178 my $self = shift->_get_self;
182 my $SAVE_FILTER = $self->_engine->storage->{filter_fetch_value};
183 $self->_engine->storage->{filter_fetch_value} = undef;
185 my $size = $self->FETCH('length') || 0;
187 $self->_engine->storage->{filter_fetch_value} = $SAVE_FILTER;
195 my $self = shift->_get_self;
196 my ($new_length) = @_;
198 $self->lock_exclusive;
200 my $SAVE_FILTER = $self->_engine->storage->{filter_store_value};
201 $self->_engine->storage->{filter_store_value} = undef;
203 my $result = $self->STORE('length', $new_length, 'length');
205 $self->_engine->storage->{filter_store_value} = $SAVE_FILTER;
213 my $self = shift->_get_self;
215 $self->lock_exclusive;
217 my $length = $self->FETCHSIZE();
220 my $content = $self->FETCH( $length - 1 );
221 $self->DELETE( $length - 1 );
234 my $self = shift->_get_self;
236 $self->lock_exclusive;
238 my $length = $self->FETCHSIZE();
240 while (my $content = shift @_) {
241 $self->STORE( $length, $content );
250 # XXX This really needs to be something more direct within the file, not a
251 # fetch and re-store. -RobK, 2007-09-20
254 my ($old_key, $new_key) = @_;
256 return $self->_engine->make_reference( $self, $old_key, $new_key );
260 my $self = shift->_get_self;
261 warn "SHIFT($self)\n" if DBM::Deep::DEBUG;
263 $self->lock_exclusive;
265 my $length = $self->FETCHSIZE();
272 my $content = $self->DELETE( 0 );
274 # Unless the deletion above has cleared the array ...
276 for (my $i = 0; $i < $length - 1; $i++) {
277 $self->_move_value( $i+1, $i );
280 $self->DELETE( $length - 1 );
289 my $self = shift->_get_self;
290 my @new_elements = @_;
292 $self->lock_exclusive;
294 my $length = $self->FETCHSIZE();
295 my $new_size = scalar @new_elements;
298 for (my $i = $length - 1; $i >= 0; $i--) {
299 $self->_move_value( $i, $i+$new_size );
302 $self->STORESIZE( $length + $new_size );
305 for (my $i = 0; $i < $new_size; $i++) {
306 $self->STORE( $i, $new_elements[$i] );
311 return $length + $new_size;
315 my $self = shift->_get_self;
317 $self->lock_exclusive;
319 my $length = $self->FETCHSIZE();
322 # Calculate offset and length of splice
325 $offset = 0 unless defined $offset;
326 if ($offset < 0) { $offset += $length; }
329 if (scalar @_) { $splice_length = shift; }
330 else { $splice_length = $length - $offset; }
331 if ($splice_length < 0) { $splice_length += ($length - $offset); }
334 # Setup array with new elements, and copy out old elements for return
336 my @new_elements = @_;
337 my $new_size = scalar @new_elements;
339 my @old_elements = map {
341 } $offset .. ($offset + $splice_length - 1);
344 # Adjust array length, and shift elements to accomodate new section.
346 if ( $new_size != $splice_length ) {
347 if ($new_size > $splice_length) {
348 for (my $i = $length - 1; $i >= $offset + $splice_length; $i--) {
349 $self->_move_value( $i, $i + ($new_size - $splice_length) );
351 $self->STORESIZE( $length + $new_size - $splice_length );
354 for (my $i = $offset + $splice_length; $i < $length; $i++) {
355 $self->_move_value( $i, $i + ($new_size - $splice_length) );
357 for (my $i = 0; $i < $splice_length - $new_size; $i++) {
358 $self->DELETE( $length - 1 );
365 # Insert new elements into array
367 for (my $i = $offset; $i < $offset + $new_size; $i++) {
368 $self->STORE( $i, shift @new_elements );
374 # Return deleted section, or last element in scalar context.
376 return wantarray ? @old_elements : $old_elements[-1];
379 # We don't need to populate it, yet.
380 # It will be useful, though, when we split out HASH and ARRAY
381 # Perl will call EXTEND() when the array is likely to grow.
382 # We don't care, but include it because it gets called at times.
389 my $length = $self->length();
390 for (my $index = 0; $index < $length; $index++) {
391 $self->_copy_value( \$db_temp->[$index], $self->get($index) );
397 sub length { (shift)->FETCHSIZE(@_) }
398 sub pop { (shift)->POP(@_) }
399 sub push { (shift)->PUSH(@_) }
400 sub unshift { (shift)->UNSHIFT(@_) }
401 sub splice { (shift)->SPLICE(@_) }
403 # This must be last otherwise we have to qualify all other calls to shift
404 # as calls to CORE::shift
405 sub shift { (CORE::shift)->SHIFT(@_) }