1 package DBM::Deep::Array;
8 our $VERSION = q(1.0004);
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 ) {
51 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
53 elsif ( $key =~ /^-?\d+$/ ) {
55 $key += $self->FETCHSIZE;
56 unless ( $key >= 0 ) {
62 elsif ( $key ne 'length' ) {
64 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
67 my $rv = $self->SUPER::FETCH( $key );
75 my $self = shift->_get_self;
76 my ($key, $value) = @_;
78 $self->lock( $self->LOCK_EX );
82 if ( !defined $key ) {
84 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
86 elsif ( $key =~ /^-?\d+$/ ) {
89 $size = $self->FETCHSIZE;
90 if ( $key + $size < 0 ) {
91 die( "Modification of non-creatable array value attempted, subscript $key" );
96 elsif ( $key ne 'length' ) {
98 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
101 my $rv = $self->SUPER::STORE( $key, $value );
103 if ( $idx_is_numeric ) {
104 $size = $self->FETCHSIZE unless defined $size;
105 if ( $key >= $size ) {
106 $self->STORESIZE( $key + 1 );
116 my $self = shift->_get_self;
119 $self->lock( $self->LOCK_SH );
121 if ( !defined $key ) {
123 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
125 elsif ( $key =~ /^-?\d+$/ ) {
127 $key += $self->FETCHSIZE;
128 unless ( $key >= 0 ) {
134 elsif ( $key ne 'length' ) {
136 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
139 my $rv = $self->SUPER::EXISTS( $key );
147 my $self = shift->_get_self;
150 $self->lock( $self->LOCK_EX );
152 my $size = $self->FETCHSIZE;
153 if ( !defined $key ) {
155 DBM::Deep->_throw_error( "Cannot use an undefined array index." );
157 elsif ( $key =~ /^-?\d+$/ ) {
160 unless ( $key >= 0 ) {
166 elsif ( $key ne 'length' ) {
168 DBM::Deep->_throw_error( "Cannot use '$key' as an array index." );
171 my $rv = $self->SUPER::DELETE( $key );
173 if ($rv && $key == $size - 1) {
174 $self->STORESIZE( $key );
182 # Now that we have a real Reference sector, we should store arrayzize there. However,
183 # arraysize needs to be transactionally-aware, so a simple location to store it isn't
186 my $self = shift->_get_self;
188 $self->lock( $self->LOCK_SH );
190 my $SAVE_FILTER = $self->_storage->{filter_fetch_value};
191 $self->_storage->{filter_fetch_value} = undef;
193 my $size = $self->FETCH('length') || 0;
195 $self->_storage->{filter_fetch_value} = $SAVE_FILTER;
203 my $self = shift->_get_self;
204 my ($new_length) = @_;
206 $self->lock( $self->LOCK_EX );
208 my $SAVE_FILTER = $self->_storage->{filter_store_value};
209 $self->_storage->{filter_store_value} = undef;
211 my $result = $self->STORE('length', $new_length, 'length');
213 $self->_storage->{filter_store_value} = $SAVE_FILTER;
221 my $self = shift->_get_self;
223 $self->lock( $self->LOCK_EX );
225 my $length = $self->FETCHSIZE();
228 my $content = $self->FETCH( $length - 1 );
229 $self->DELETE( $length - 1 );
242 my $self = shift->_get_self;
244 $self->lock( $self->LOCK_EX );
246 my $length = $self->FETCHSIZE();
248 while (my $content = shift @_) {
249 $self->STORE( $length, $content );
258 # XXX This really needs to be something more direct within the file, not a
259 # fetch and re-store. -RobK, 2007-09-20
262 my ($old_key, $new_key) = @_;
264 return $self->_engine->make_reference( $self, $old_key, $new_key );
268 my $self = shift->_get_self;
270 $self->lock( $self->LOCK_EX );
272 my $length = $self->FETCHSIZE();
279 my $content = $self->FETCH( 0 );
281 for (my $i = 0; $i < $length - 1; $i++) {
282 $self->_move_value( $i+1, $i );
284 $self->DELETE( $length - 1 );
292 my $self = shift->_get_self;
293 my @new_elements = @_;
295 $self->lock( $self->LOCK_EX );
297 my $length = $self->FETCHSIZE();
298 my $new_size = scalar @new_elements;
301 for (my $i = $length - 1; $i >= 0; $i--) {
302 $self->_move_value( $i, $i+$new_size );
305 $self->STORESIZE( $length + $new_size );
308 for (my $i = 0; $i < $new_size; $i++) {
309 $self->STORE( $i, $new_elements[$i] );
314 return $length + $new_size;
318 my $self = shift->_get_self;
320 $self->lock( $self->LOCK_EX );
322 my $length = $self->FETCHSIZE();
325 # Calculate offset and length of splice
328 $offset = 0 unless defined $offset;
329 if ($offset < 0) { $offset += $length; }
332 if (scalar @_) { $splice_length = shift; }
333 else { $splice_length = $length - $offset; }
334 if ($splice_length < 0) { $splice_length += ($length - $offset); }
337 # Setup array with new elements, and copy out old elements for return
339 my @new_elements = @_;
340 my $new_size = scalar @new_elements;
342 my @old_elements = map {
344 } $offset .. ($offset + $splice_length - 1);
347 # Adjust array length, and shift elements to accomodate new section.
349 if ( $new_size != $splice_length ) {
350 if ($new_size > $splice_length) {
351 for (my $i = $length - 1; $i >= $offset + $splice_length; $i--) {
352 $self->_move_value( $i, $i + ($new_size - $splice_length) );
354 $self->STORESIZE( $length + $new_size - $splice_length );
357 for (my $i = $offset + $splice_length; $i < $length; $i++) {
358 $self->_move_value( $i, $i + ($new_size - $splice_length) );
360 for (my $i = 0; $i < $splice_length - $new_size; $i++) {
361 $self->DELETE( $length - 1 );
368 # Insert new elements into array
370 for (my $i = $offset; $i < $offset + $new_size; $i++) {
371 $self->STORE( $i, shift @new_elements );
377 # Return deleted section, or last element in scalar context.
379 return wantarray ? @old_elements : $old_elements[-1];
382 # We don't need to populate it, yet.
383 # It will be useful, though, when we split out HASH and ARRAY
386 # Perl will call EXTEND() when the array is likely to grow.
387 # We don't care, but include it because it gets called at times.
395 my $length = $self->length();
396 for (my $index = 0; $index < $length; $index++) {
397 my $value = $self->get($index);
398 $self->_copy_value( \$db_temp->[$index], $value );
405 # Public method aliases
407 sub length { (shift)->FETCHSIZE(@_) }
408 sub pop { (shift)->POP(@_) }
409 sub push { (shift)->PUSH(@_) }
410 sub unshift { (shift)->UNSHIFT(@_) }
411 sub splice { (shift)->SPLICE(@_) }
413 # This must be last otherwise we have to qualify all other calls to shift
414 # as calls to CORE::shift
415 sub shift { (CORE::shift)->SHIFT(@_) }