1 package DBM::Deep::Array;
8 our $VERSION = q(1.0006);
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;
38 $self->lock( $self->LOCK_SH );
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( $self->LOCK_EX );
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;
110 $self->lock( $self->LOCK_SH );
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;
141 $self->lock( $self->LOCK_EX );
143 my $size = $self->FETCHSIZE;
144 if ( !defined $key ) {
146 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
148 elsif ( $key =~ /^-?\d+$/ ) {
151 unless ( $key >= 0 ) {
157 elsif ( $key ne 'length' ) {
159 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
162 my $rv = $self->SUPER::DELETE( $key );
164 if ($rv && $key == $size - 1) {
165 $self->STORESIZE( $key );
173 # Now that we have a real Reference sector, we should store arrayzize there. However,
174 # arraysize needs to be transactionally-aware, so a simple location to store it isn't
177 my $self = shift->_get_self;
179 $self->lock( $self->LOCK_SH );
181 my $SAVE_FILTER = $self->_storage->{filter_fetch_value};
182 $self->_storage->{filter_fetch_value} = undef;
184 my $size = $self->FETCH('length') || 0;
186 $self->_storage->{filter_fetch_value} = $SAVE_FILTER;
194 my $self = shift->_get_self;
195 my ($new_length) = @_;
197 $self->lock( $self->LOCK_EX );
199 my $SAVE_FILTER = $self->_storage->{filter_store_value};
200 $self->_storage->{filter_store_value} = undef;
202 my $result = $self->STORE('length', $new_length, 'length');
204 $self->_storage->{filter_store_value} = $SAVE_FILTER;
212 my $self = shift->_get_self;
214 $self->lock( $self->LOCK_EX );
216 my $length = $self->FETCHSIZE();
219 my $content = $self->FETCH( $length - 1 );
220 $self->DELETE( $length - 1 );
233 my $self = shift->_get_self;
235 $self->lock( $self->LOCK_EX );
237 my $length = $self->FETCHSIZE();
239 while (my $content = shift @_) {
240 $self->STORE( $length, $content );
249 # XXX This really needs to be something more direct within the file, not a
250 # fetch and re-store. -RobK, 2007-09-20
253 my ($old_key, $new_key) = @_;
255 return $self->_engine->make_reference( $self, $old_key, $new_key );
259 my $self = shift->_get_self;
261 $self->lock( $self->LOCK_EX );
263 my $length = $self->FETCHSIZE();
270 my $content = $self->FETCH( 0 );
272 for (my $i = 0; $i < $length - 1; $i++) {
273 $self->_move_value( $i+1, $i );
275 $self->DELETE( $length - 1 );
283 my $self = shift->_get_self;
284 my @new_elements = @_;
286 $self->lock( $self->LOCK_EX );
288 my $length = $self->FETCHSIZE();
289 my $new_size = scalar @new_elements;
292 for (my $i = $length - 1; $i >= 0; $i--) {
293 $self->_move_value( $i, $i+$new_size );
296 $self->STORESIZE( $length + $new_size );
299 for (my $i = 0; $i < $new_size; $i++) {
300 $self->STORE( $i, $new_elements[$i] );
305 return $length + $new_size;
309 my $self = shift->_get_self;
311 $self->lock( $self->LOCK_EX );
313 my $length = $self->FETCHSIZE();
316 # Calculate offset and length of splice
319 $offset = 0 unless defined $offset;
320 if ($offset < 0) { $offset += $length; }
323 if (scalar @_) { $splice_length = shift; }
324 else { $splice_length = $length - $offset; }
325 if ($splice_length < 0) { $splice_length += ($length - $offset); }
328 # Setup array with new elements, and copy out old elements for return
330 my @new_elements = @_;
331 my $new_size = scalar @new_elements;
333 my @old_elements = map {
335 } $offset .. ($offset + $splice_length - 1);
338 # Adjust array length, and shift elements to accomodate new section.
340 if ( $new_size != $splice_length ) {
341 if ($new_size > $splice_length) {
342 for (my $i = $length - 1; $i >= $offset + $splice_length; $i--) {
343 $self->_move_value( $i, $i + ($new_size - $splice_length) );
345 $self->STORESIZE( $length + $new_size - $splice_length );
348 for (my $i = $offset + $splice_length; $i < $length; $i++) {
349 $self->_move_value( $i, $i + ($new_size - $splice_length) );
351 for (my $i = 0; $i < $splice_length - $new_size; $i++) {
352 $self->DELETE( $length - 1 );
359 # Insert new elements into array
361 for (my $i = $offset; $i < $offset + $new_size; $i++) {
362 $self->STORE( $i, shift @new_elements );
368 # Return deleted section, or last element in scalar context.
370 return wantarray ? @old_elements : $old_elements[-1];
373 # We don't need to populate it, yet.
374 # It will be useful, though, when we split out HASH and ARRAY
377 # Perl will call EXTEND() when the array is likely to grow.
378 # We don't care, but include it because it gets called at times.
386 my $length = $self->length();
387 for (my $index = 0; $index < $length; $index++) {
388 my $value = $self->get($index);
389 $self->_copy_value( \$db_temp->[$index], $value );
396 # Public method aliases
398 sub length { (shift)->FETCHSIZE(@_) }
399 sub pop { (shift)->POP(@_) }
400 sub push { (shift)->PUSH(@_) }
401 sub unshift { (shift)->UNSHIFT(@_) }
402 sub splice { (shift)->SPLICE(@_) }
404 # This must be last otherwise we have to qualify all other calls to shift
405 # as calls to CORE::shift
406 sub shift { (CORE::shift)->SHIFT(@_) }