=head2 Tying Scalars
A class implementing a tied scalar should define the following methods:
-TIESCALAR, FETCH, STORE, and possibly DESTROY.
+TIESCALAR, FETCH, STORE, and possibly UNTIE and/or DESTROY.
Let's look at each in turn, using as an example a tie class for
scalars that allows the user to do something like:
return $new_nicety;
}
+=item UNTIE this
+
+This method will be triggered when the C<untie> occurs. This can be useful
+if the class needs to know when no further calls will be made. (Except DESTROY
+of course.) See below for more details.
+
=item DESTROY this
This method will be triggered when the tied variable needs to be destructed.
=head2 Tying Arrays
A class implementing a tied ordinary array should define the following
-methods: TIEARRAY, FETCH, STORE, FETCHSIZE, STORESIZE and perhaps DESTROY.
+methods: TIEARRAY, FETCH, STORE, FETCHSIZE, STORESIZE and perhaps UNTIE and/or DESTROY.
FETCHSIZE and STORESIZE are used to provide C<$#array> and
equivalent C<scalar(@array)> access.
methods above. The default implementations of DELETE and EXISTS in
B<Tie::Array> simply C<croak>.
-In addition EXTEND will be called when perl would have pre-extended
+In addition EXTEND will be called when perl would have pre-extended
allocation in a real array.
This means that tied arrays are now I<complete>. The example below needs
return $self->{ARRAY}[$idx];
}
-If a negative array index is used to read from an array, the index
+If a negative array index is used to read from an array, the index
will be translated to a positive one internally by calling FETCHSIZE
-before being passed to FETCH.
-
+before being passed to FETCH.
+
As you may have noticed, the name of the FETCH method (et al.) is the same
for all accesses, even though the constructors differ in names (TIESCALAR
vs TIEARRAY). While in theory you could have the same class servicing
}
return $self->{ARRAY}[$idx] = $value;
}
-
-Negative indexes are treated the same as with FETCH.
+
+Negative indexes are treated the same as with FETCH.
+
+=item UNTIE this
+
+Will be called when C<untie> happens. (See below.)
=item DESTROY this
reports whether a key is present in the hash, and DELETE deletes one.
CLEAR empties the hash by deleting all the key and value pairs. FIRSTKEY
and NEXTKEY implement the keys() and each() functions to iterate over all
-the keys. And DESTROY is called when the tied variable is garbage
-collected.
+the keys. UNTIE is called when C<untie> happens, and DESTROY is called when
+the tied variable is garbage collected.
If this seems like a lot, then feel free to inherit from merely the
standard Tie::Hash module for most of your methods, redefining only the
return each %{ $self->{LIST} }
}
+=item UNTIE this
+
+This is called when C<untie> occurs.
+
=item DESTROY this
This method is triggered when a tied hash is about to go out of
A class implementing a tied filehandle should define the following
methods: TIEHANDLE, at least one of PRINT, PRINTF, WRITE, READLINE, GETC,
-READ, and possibly CLOSE and DESTROY. The class can also provide: BINMODE,
+READ, and possibly CLOSE, UNTIE and DESTROY. The class can also provide: BINMODE,
OPEN, EOF, FILENO, SEEK, TELL - if the corresponding perl operators are
used on the handle.
sub CLOSE { print "CLOSE called.\n" }
+=item UNTIE this
+
+As with the other types of ties, this method will be called when C<untie> happens.
+It may be appropriate to "auto CLOSE" when this occurs.
+
=item DESTROY this
As with the other types of ties, this method will be called when the
print FOO $a, " plus ", $b, " equals ", $a + $b, "\n";
print <FOO>;
+=head2 UNTIE this
+
+You can define for all tie types an UNTIE method that will be called
+at untie().
+
=head2 The C<untie> Gotcha
If you intend making use of the object returned from either tie() or
have not been flushed to disk.
Now that you know what the problem is, what can you do to avoid it?
-Well, the good old C<-w> flag will spot any instances where you call
+Prior to the introduction of the optional UNTIE method the only way
+was the good old C<-w> flag. Which will spot any instances where you call
untie() and there are still valid references to the tied object. If
the second script above this near the top C<use warnings 'untie'>
or was run with the C<-w> flag, Perl prints this
undef $x;
untie $fred;
+Now that UNTIE exists the class designer can decide which parts of the
+class functionality are really associated with C<untie> and which with
+the object being destroyed. What makes sense for a given class depends
+on whether the inner references are being kept so that non-tie-related
+methods can be called on the object. But in most cases it probably makes
+sense to move the functionality that would have been in DESTROY to the UNTIE
+method.
+
+If the UNTIE method exists then the warning above does not occur. Instead the
+UNTIE method is passed the count of "extra" references and can issue its own
+warning if appropriate. e.g. to replicate the no UNTIE case this method can
+be used:
+
+ sub UNTIE
+ {
+ my ($obj,$count) = @_;
+ carp "untie attempted while $count inner references still exist" if $count;
+ }
+
=head1 SEE ALSO
See L<DB_File> or L<Config> for some interesting tie() implementations.
Tom Christiansen
TIEHANDLE by Sven Verdoolaege <F<skimo@dns.ufsia.ac.be>> and Doug MacEachern <F<dougm@osf.org>>
+
+UNTIE by Nick Ing-Simmons <F<nick@ing-simmons.net>>
+
projects / p5sagit/p5-mst-13.2.git / blobdiff