1 package DBM::Deep::Array;
12 eval { tied( @{$_[0]} ) } || $_[0]
17 # Tied array constructor method, called by Perl's tie() function.
20 my $args = $class->_get_args( @_ );
22 $args->{type} = $class->TYPE_ARRAY;
24 return $class->_init($args);
28 my $self = $_[0]->_get_self;
31 $self->lock( $self->LOCK_SH );
33 if ( $key =~ /^-?\d+$/ ) {
35 $key += $self->FETCHSIZE;
36 unless ( $key >= 0 ) {
42 $key = pack($DBM::Deep::LONG_PACK, $key);
45 my $rv = $self->SUPER::FETCH( $key );
53 my $self = shift->_get_self;
54 my ($key, $value) = @_;
56 $self->lock( $self->LOCK_EX );
59 my $size = $self->FETCHSIZE;
62 if ( $key =~ /^-?\d+$/ ) {
67 die( "Modification of non-creatable array value attempted, subscript $orig" );
71 $key = pack($DBM::Deep::LONG_PACK, $key);
74 my $rv = $self->SUPER::STORE( $key, $value );
76 if ( $numeric_idx && $rv == 2 && $orig >= $size ) {
77 $self->STORESIZE( $orig + 1 );
86 my $self = $_[0]->_get_self;
89 $self->lock( $self->LOCK_SH );
91 if ( $key =~ /^-?\d+$/ ) {
93 $key += $self->FETCHSIZE;
94 unless ( $key >= 0 ) {
100 $key = pack($DBM::Deep::LONG_PACK, $key);
103 my $rv = $self->SUPER::EXISTS( $key );
111 my $self = $_[0]->_get_self;
114 my $unpacked_key = $key;
116 $self->lock( $self->LOCK_EX );
118 my $size = $self->FETCHSIZE;
119 if ( $key =~ /^-?\d+$/ ) {
122 unless ( $key >= 0 ) {
128 $key = pack($DBM::Deep::LONG_PACK, $key);
131 my $rv = $self->SUPER::DELETE( $key );
133 if ($rv && $unpacked_key == $size - 1) {
134 $self->STORESIZE( $unpacked_key );
144 # Return the length of the array
146 my $self = shift->_get_self;
148 $self->lock( $self->LOCK_SH );
150 my $SAVE_FILTER = $self->root->{filter_fetch_value};
151 $self->root->{filter_fetch_value} = undef;
153 my $packed_size = $self->FETCH('length');
155 $self->root->{filter_fetch_value} = $SAVE_FILTER;
160 return int(unpack($DBM::Deep::LONG_PACK, $packed_size));
168 # Set the length of the array
170 my $self = $_[0]->_get_self;
171 my $new_length = $_[1];
173 $self->lock( $self->LOCK_EX );
175 my $SAVE_FILTER = $self->root->{filter_store_value};
176 $self->root->{filter_store_value} = undef;
178 my $result = $self->STORE('length', pack($DBM::Deep::LONG_PACK, $new_length));
180 $self->root->{filter_store_value} = $SAVE_FILTER;
189 # Remove and return the last element on the array
191 my $self = $_[0]->_get_self;
193 $self->lock( $self->LOCK_EX );
195 my $length = $self->FETCHSIZE();
198 my $content = $self->FETCH( $length - 1 );
199 $self->DELETE( $length - 1 );
213 # Add new element(s) to the end of the array
215 my $self = shift->_get_self;
217 $self->lock( $self->LOCK_EX );
219 my $length = $self->FETCHSIZE();
221 while (my $content = shift @_) {
222 $self->STORE( $length, $content );
233 # Remove and return first element on the array.
234 # Shift over remaining elements to take up space.
236 my $self = $_[0]->_get_self;
238 $self->lock( $self->LOCK_EX );
240 my $length = $self->FETCHSIZE();
243 my $content = $self->FETCH( 0 );
246 # Shift elements over and remove last one.
248 for (my $i = 0; $i < $length - 1; $i++) {
249 $self->STORE( $i, $self->FETCH($i + 1) );
251 $self->DELETE( $length - 1 );
265 # Insert new element(s) at beginning of array.
266 # Shift over other elements to make space.
268 my $self = shift->_get_self;
269 my @new_elements = @_;
271 $self->lock( $self->LOCK_EX );
273 my $length = $self->FETCHSIZE();
274 my $new_size = scalar @new_elements;
277 for (my $i = $length - 1; $i >= 0; $i--) {
278 $self->STORE( $i + $new_size, $self->FETCH($i) );
282 for (my $i = 0; $i < $new_size; $i++) {
283 $self->STORE( $i, $new_elements[$i] );
288 return $length + $new_size;
293 # Splices section of array with optional new section.
294 # Returns deleted section, or last element deleted in scalar context.
296 my $self = shift->_get_self;
298 $self->lock( $self->LOCK_EX );
300 my $length = $self->FETCHSIZE();
303 # Calculate offset and length of splice
305 my $offset = shift || 0;
306 if ($offset < 0) { $offset += $length; }
309 if (scalar @_) { $splice_length = shift; }
310 else { $splice_length = $length - $offset; }
311 if ($splice_length < 0) { $splice_length += ($length - $offset); }
314 # Setup array with new elements, and copy out old elements for return
316 my @new_elements = @_;
317 my $new_size = scalar @new_elements;
319 my @old_elements = ();
320 for (my $i = $offset; $i < $offset + $splice_length; $i++) {
321 push @old_elements, $self->FETCH( $i );
325 # Adjust array length, and shift elements to accomodate new section.
327 if ( $new_size != $splice_length ) {
328 if ($new_size > $splice_length) {
329 for (my $i = $length - 1; $i >= $offset + $splice_length; $i--) {
330 $self->STORE( $i + ($new_size - $splice_length), $self->FETCH($i) );
334 for (my $i = $offset + $splice_length; $i < $length; $i++) {
335 $self->STORE( $i + ($new_size - $splice_length), $self->FETCH($i) );
337 for (my $i = 0; $i < $splice_length - $new_size; $i++) {
338 $self->DELETE( $length - 1 );
345 # Insert new elements into array
347 for (my $i = $offset; $i < $offset + $new_size; $i++) {
348 $self->STORE( $i, shift @new_elements );
354 # Return deleted section, or last element in scalar context.
356 return wantarray ? @old_elements : $old_elements[-1];
359 #XXX We don't need to define it, yet.
360 #XXX It will be useful, though, when we split out HASH and ARRAY
363 # Perl will call EXTEND() when the array is likely to grow.
364 # We don't care, but include it for compatibility.
369 # Public method aliases
371 *length = *FETCHSIZE;