This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
flip release & version in win32_uname()
[perl5.git] / pod / perltie.pod
CommitLineData
cb1a09d0
AD
1=head1 NAME
2
3perltie - how to hide an object class in a simple variable
4
5=head1 SYNOPSIS
6
7 tie VARIABLE, CLASSNAME, LIST
8
6fdf61fb 9 $object = tied VARIABLE
10
cb1a09d0
AD
11 untie VARIABLE
12
13=head1 DESCRIPTION
14
15Prior to release 5.0 of Perl, a programmer could use dbmopen()
5f05dabc 16to connect an on-disk database in the standard Unix dbm(3x)
17format magically to a %HASH in their program. However, their Perl was either
cb1a09d0
AD
18built with one particular dbm library or another, but not both, and
19you couldn't extend this mechanism to other packages or types of variables.
20
21Now you can.
22
23The tie() function binds a variable to a class (package) that will provide
24the implementation for access methods for that variable. Once this magic
25has been performed, accessing a tied variable automatically triggers
5a964f20 26method calls in the proper class. The complexity of the class is
cb1a09d0
AD
27hidden behind magic methods calls. The method names are in ALL CAPS,
28which is a convention that Perl uses to indicate that they're called
29implicitly rather than explicitly--just like the BEGIN() and END()
30functions.
31
32In the tie() call, C<VARIABLE> is the name of the variable to be
33enchanted. C<CLASSNAME> is the name of a class implementing objects of
34the correct type. Any additional arguments in the C<LIST> are passed to
35the appropriate constructor method for that class--meaning TIESCALAR(),
5f05dabc 36TIEARRAY(), TIEHASH(), or TIEHANDLE(). (Typically these are arguments
a7adf1f0 37such as might be passed to the dbminit() function of C.) The object
38returned by the "new" method is also returned by the tie() function,
39which would be useful if you wanted to access other methods in
40C<CLASSNAME>. (You don't actually have to return a reference to a right
5f05dabc 41"type" (e.g., HASH or C<CLASSNAME>) so long as it's a properly blessed
a7adf1f0 42object.) You can also retrieve a reference to the underlying object
43using the tied() function.
cb1a09d0
AD
44
45Unlike dbmopen(), the tie() function will not C<use> or C<require> a module
46for you--you need to do that explicitly yourself.
47
48=head2 Tying Scalars
49
50A class implementing a tied scalar should define the following methods:
51TIESCALAR, FETCH, STORE, and possibly DESTROY.
52
53Let's look at each in turn, using as an example a tie class for
54scalars that allows the user to do something like:
55
56 tie $his_speed, 'Nice', getppid();
57 tie $my_speed, 'Nice', $$;
58
59And now whenever either of those variables is accessed, its current
60system priority is retrieved and returned. If those variables are set,
61then the process's priority is changed!
62
5aabfad6 63We'll use Jarkko Hietaniemi <F<jhi@iki.fi>>'s BSD::Resource class (not
64included) to access the PRIO_PROCESS, PRIO_MIN, and PRIO_MAX constants
65from your system, as well as the getpriority() and setpriority() system
66calls. Here's the preamble of the class.
cb1a09d0
AD
67
68 package Nice;
69 use Carp;
70 use BSD::Resource;
71 use strict;
72 $Nice::DEBUG = 0 unless defined $Nice::DEBUG;
73
74=over
75
76=item TIESCALAR classname, LIST
77
78This is the constructor for the class. That means it is
79expected to return a blessed reference to a new scalar
80(probably anonymous) that it's creating. For example:
81
82 sub TIESCALAR {
83 my $class = shift;
84 my $pid = shift || $$; # 0 means me
85
86 if ($pid !~ /^\d+$/) {
6fdf61fb 87 carp "Nice::Tie::Scalar got non-numeric pid $pid" if $^W;
cb1a09d0
AD
88 return undef;
89 }
90
91 unless (kill 0, $pid) { # EPERM or ERSCH, no doubt
6fdf61fb 92 carp "Nice::Tie::Scalar got bad pid $pid: $!" if $^W;
cb1a09d0
AD
93 return undef;
94 }
95
96 return bless \$pid, $class;
97 }
98
99This tie class has chosen to return an error rather than raising an
100exception if its constructor should fail. While this is how dbmopen() works,
101other classes may well not wish to be so forgiving. It checks the global
102variable C<$^W> to see whether to emit a bit of noise anyway.
103
104=item FETCH this
105
106This method will be triggered every time the tied variable is accessed
107(read). It takes no arguments beyond its self reference, which is the
5f05dabc 108object representing the scalar we're dealing with. Because in this case
109we're using just a SCALAR ref for the tied scalar object, a simple $$self
cb1a09d0
AD
110allows the method to get at the real value stored there. In our example
111below, that real value is the process ID to which we've tied our variable.
112
113 sub FETCH {
114 my $self = shift;
115 confess "wrong type" unless ref $self;
116 croak "usage error" if @_;
117 my $nicety;
118 local($!) = 0;
119 $nicety = getpriority(PRIO_PROCESS, $$self);
120 if ($!) { croak "getpriority failed: $!" }
121 return $nicety;
122 }
123
124This time we've decided to blow up (raise an exception) if the renice
125fails--there's no place for us to return an error otherwise, and it's
126probably the right thing to do.
127
128=item STORE this, value
129
130This method will be triggered every time the tied variable is set
131(assigned). Beyond its self reference, it also expects one (and only one)
132argument--the new value the user is trying to assign.
133
134 sub STORE {
135 my $self = shift;
136 confess "wrong type" unless ref $self;
137 my $new_nicety = shift;
138 croak "usage error" if @_;
139
140 if ($new_nicety < PRIO_MIN) {
141 carp sprintf
142 "WARNING: priority %d less than minimum system priority %d",
143 $new_nicety, PRIO_MIN if $^W;
144 $new_nicety = PRIO_MIN;
145 }
146
147 if ($new_nicety > PRIO_MAX) {
148 carp sprintf
149 "WARNING: priority %d greater than maximum system priority %d",
150 $new_nicety, PRIO_MAX if $^W;
151 $new_nicety = PRIO_MAX;
152 }
153
154 unless (defined setpriority(PRIO_PROCESS, $$self, $new_nicety)) {
155 confess "setpriority failed: $!";
156 }
157 return $new_nicety;
158 }
159
160=item DESTROY this
161
162This method will be triggered when the tied variable needs to be destructed.
5f05dabc 163As with other object classes, such a method is seldom necessary, because Perl
cb1a09d0
AD
164deallocates its moribund object's memory for you automatically--this isn't
165C++, you know. We'll use a DESTROY method here for debugging purposes only.
166
167 sub DESTROY {
168 my $self = shift;
169 confess "wrong type" unless ref $self;
170 carp "[ Nice::DESTROY pid $$self ]" if $Nice::DEBUG;
171 }
172
173=back
174
175That's about all there is to it. Actually, it's more than all there
5f05dabc 176is to it, because we've done a few nice things here for the sake
cb1a09d0
AD
177of completeness, robustness, and general aesthetics. Simpler
178TIESCALAR classes are certainly possible.
179
180=head2 Tying Arrays
181
182A class implementing a tied ordinary array should define the following
a60c0954 183methods: TIEARRAY, FETCH, STORE, FETCHSIZE, STORESIZE and perhaps DESTROY.
cb1a09d0 184
a60c0954
NIS
185FETCHSIZE and STORESIZE are used to provide C<$#array> and
186equivalent C<scalar(@array)> access.
187
188The methods POP, PUSH, SHIFT, UNSHIFT, SPLICE are required if the perl
189operator with the corresponding (but lowercase) name is to operate on the
190tied array. The B<Tie::Array> class can be used as a base class to implement
191these in terms of the basic five methods above.
192
193In addition EXTEND will be called when perl would have pre-extended
194allocation in a real array.
195
196This means that tied arrays are now I<complete>. The example below needs
197upgrading to illustrate this. (The documentation in B<Tie::Array> is more
198complete.)
cb1a09d0
AD
199
200For this discussion, we'll implement an array whose indices are fixed at
201its creation. If you try to access anything beyond those bounds, you'll
a60c0954 202take an exception. For example:
cb1a09d0
AD
203
204 require Bounded_Array;
1f57c600 205 tie @ary, 'Bounded_Array', 2;
cb1a09d0
AD
206 $| = 1;
207 for $i (0 .. 10) {
208 print "setting index $i: ";
209 $ary[$i] = 10 * $i;
210 $ary[$i] = 10 * $i;
211 print "value of elt $i now $ary[$i]\n";
212 }
213
214The preamble code for the class is as follows:
215
216 package Bounded_Array;
217 use Carp;
218 use strict;
219
220=over
221
222=item TIEARRAY classname, LIST
223
224This is the constructor for the class. That means it is expected to
225return a blessed reference through which the new array (probably an
226anonymous ARRAY ref) will be accessed.
227
228In our example, just to show you that you don't I<really> have to return an
229ARRAY reference, we'll choose a HASH reference to represent our object.
230A HASH works out well as a generic record type: the C<{BOUND}> field will
03dc9dad 231store the maximum bound allowed, and the C<{ARRAY}> field will hold the
cb1a09d0
AD
232true ARRAY ref. If someone outside the class tries to dereference the
233object returned (doubtless thinking it an ARRAY ref), they'll blow up.
234This just goes to show you that you should respect an object's privacy.
235
236 sub TIEARRAY {
237 my $class = shift;
238 my $bound = shift;
239 confess "usage: tie(\@ary, 'Bounded_Array', max_subscript)"
240 if @_ || $bound =~ /\D/;
241 return bless {
242 BOUND => $bound,
243 ARRAY => [],
244 }, $class;
245 }
246
247=item FETCH this, index
248
249This method will be triggered every time an individual element the tied array
250is accessed (read). It takes one argument beyond its self reference: the
251index whose value we're trying to fetch.
252
253 sub FETCH {
254 my($self,$idx) = @_;
255 if ($idx > $self->{BOUND}) {
256 confess "Array OOB: $idx > $self->{BOUND}";
257 }
258 return $self->{ARRAY}[$idx];
259 }
260
261As you may have noticed, the name of the FETCH method (et al.) is the same
262for all accesses, even though the constructors differ in names (TIESCALAR
263vs TIEARRAY). While in theory you could have the same class servicing
264several tied types, in practice this becomes cumbersome, and it's easiest
5f05dabc 265to keep them at simply one tie type per class.
cb1a09d0
AD
266
267=item STORE this, index, value
268
269This method will be triggered every time an element in the tied array is set
270(written). It takes two arguments beyond its self reference: the index at
271which we're trying to store something and the value we're trying to put
272there. For example:
273
274 sub STORE {
275 my($self, $idx, $value) = @_;
276 print "[STORE $value at $idx]\n" if _debug;
277 if ($idx > $self->{BOUND} ) {
278 confess "Array OOB: $idx > $self->{BOUND}";
279 }
280 return $self->{ARRAY}[$idx] = $value;
281 }
282
283=item DESTROY this
284
285This method will be triggered when the tied variable needs to be destructed.
184e9718 286As with the scalar tie class, this is almost never needed in a
cb1a09d0
AD
287language that does its own garbage collection, so this time we'll
288just leave it out.
289
290=back
291
292The code we presented at the top of the tied array class accesses many
293elements of the array, far more than we've set the bounds to. Therefore,
294it will blow up once they try to access beyond the 2nd element of @ary, as
295the following output demonstrates:
296
297 setting index 0: value of elt 0 now 0
298 setting index 1: value of elt 1 now 10
299 setting index 2: value of elt 2 now 20
300 setting index 3: Array OOB: 3 > 2 at Bounded_Array.pm line 39
301 Bounded_Array::FETCH called at testba line 12
302
303=head2 Tying Hashes
304
aa689395 305As the first Perl data type to be tied (see dbmopen()), hashes have the
306most complete and useful tie() implementation. A class implementing a
307tied hash should define the following methods: TIEHASH is the constructor.
308FETCH and STORE access the key and value pairs. EXISTS reports whether a
309key is present in the hash, and DELETE deletes one. CLEAR empties the
310hash by deleting all the key and value pairs. FIRSTKEY and NEXTKEY
311implement the keys() and each() functions to iterate over all the keys.
312And DESTROY is called when the tied variable is garbage collected.
313
314If this seems like a lot, then feel free to inherit from merely the
315standard Tie::Hash module for most of your methods, redefining only the
316interesting ones. See L<Tie::Hash> for details.
cb1a09d0
AD
317
318Remember that Perl distinguishes between a key not existing in the hash,
319and the key existing in the hash but having a corresponding value of
320C<undef>. The two possibilities can be tested with the C<exists()> and
321C<defined()> functions.
322
323Here's an example of a somewhat interesting tied hash class: it gives you
5f05dabc 324a hash representing a particular user's dot files. You index into the hash
325with the name of the file (minus the dot) and you get back that dot file's
cb1a09d0
AD
326contents. For example:
327
328 use DotFiles;
1f57c600 329 tie %dot, 'DotFiles';
cb1a09d0
AD
330 if ( $dot{profile} =~ /MANPATH/ ||
331 $dot{login} =~ /MANPATH/ ||
332 $dot{cshrc} =~ /MANPATH/ )
333 {
5f05dabc 334 print "you seem to set your MANPATH\n";
cb1a09d0
AD
335 }
336
337Or here's another sample of using our tied class:
338
1f57c600 339 tie %him, 'DotFiles', 'daemon';
cb1a09d0
AD
340 foreach $f ( keys %him ) {
341 printf "daemon dot file %s is size %d\n",
342 $f, length $him{$f};
343 }
344
345In our tied hash DotFiles example, we use a regular
346hash for the object containing several important
347fields, of which only the C<{LIST}> field will be what the
348user thinks of as the real hash.
349
350=over 5
351
352=item USER
353
354whose dot files this object represents
355
356=item HOME
357
5f05dabc 358where those dot files live
cb1a09d0
AD
359
360=item CLOBBER
361
362whether we should try to change or remove those dot files
363
364=item LIST
365
5f05dabc 366the hash of dot file names and content mappings
cb1a09d0
AD
367
368=back
369
370Here's the start of F<Dotfiles.pm>:
371
372 package DotFiles;
373 use Carp;
374 sub whowasi { (caller(1))[3] . '()' }
375 my $DEBUG = 0;
376 sub debug { $DEBUG = @_ ? shift : 1 }
377
5f05dabc 378For our example, we want to be able to emit debugging info to help in tracing
cb1a09d0
AD
379during development. We keep also one convenience function around
380internally to help print out warnings; whowasi() returns the function name
381that calls it.
382
383Here are the methods for the DotFiles tied hash.
384
385=over
386
387=item TIEHASH classname, LIST
388
389This is the constructor for the class. That means it is expected to
390return a blessed reference through which the new object (probably but not
391necessarily an anonymous hash) will be accessed.
392
393Here's the constructor:
394
395 sub TIEHASH {
396 my $self = shift;
397 my $user = shift || $>;
398 my $dotdir = shift || '';
399 croak "usage: @{[&whowasi]} [USER [DOTDIR]]" if @_;
400 $user = getpwuid($user) if $user =~ /^\d+$/;
401 my $dir = (getpwnam($user))[7]
402 || croak "@{[&whowasi]}: no user $user";
403 $dir .= "/$dotdir" if $dotdir;
404
405 my $node = {
406 USER => $user,
407 HOME => $dir,
408 LIST => {},
409 CLOBBER => 0,
410 };
411
412 opendir(DIR, $dir)
413 || croak "@{[&whowasi]}: can't opendir $dir: $!";
414 foreach $dot ( grep /^\./ && -f "$dir/$_", readdir(DIR)) {
415 $dot =~ s/^\.//;
416 $node->{LIST}{$dot} = undef;
417 }
418 closedir DIR;
419 return bless $node, $self;
420 }
421
422It's probably worth mentioning that if you're going to filetest the
423return values out of a readdir, you'd better prepend the directory
5f05dabc 424in question. Otherwise, because we didn't chdir() there, it would
2ae324a7 425have been testing the wrong file.
cb1a09d0
AD
426
427=item FETCH this, key
428
429This method will be triggered every time an element in the tied hash is
430accessed (read). It takes one argument beyond its self reference: the key
431whose value we're trying to fetch.
432
433Here's the fetch for our DotFiles example.
434
435 sub FETCH {
436 carp &whowasi if $DEBUG;
437 my $self = shift;
438 my $dot = shift;
439 my $dir = $self->{HOME};
440 my $file = "$dir/.$dot";
441
442 unless (exists $self->{LIST}->{$dot} || -f $file) {
443 carp "@{[&whowasi]}: no $dot file" if $DEBUG;
444 return undef;
445 }
446
447 if (defined $self->{LIST}->{$dot}) {
448 return $self->{LIST}->{$dot};
449 } else {
450 return $self->{LIST}->{$dot} = `cat $dir/.$dot`;
451 }
452 }
453
454It was easy to write by having it call the Unix cat(1) command, but it
455would probably be more portable to open the file manually (and somewhat
5f05dabc 456more efficient). Of course, because dot files are a Unixy concept, we're
cb1a09d0
AD
457not that concerned.
458
459=item STORE this, key, value
460
461This method will be triggered every time an element in the tied hash is set
462(written). It takes two arguments beyond its self reference: the index at
463which we're trying to store something, and the value we're trying to put
464there.
465
466Here in our DotFiles example, we'll be careful not to let
467them try to overwrite the file unless they've called the clobber()
468method on the original object reference returned by tie().
469
470 sub STORE {
471 carp &whowasi if $DEBUG;
472 my $self = shift;
473 my $dot = shift;
474 my $value = shift;
475 my $file = $self->{HOME} . "/.$dot";
476 my $user = $self->{USER};
477
478 croak "@{[&whowasi]}: $file not clobberable"
479 unless $self->{CLOBBER};
480
481 open(F, "> $file") || croak "can't open $file: $!";
482 print F $value;
483 close(F);
484 }
485
486If they wanted to clobber something, they might say:
487
488 $ob = tie %daemon_dots, 'daemon';
489 $ob->clobber(1);
490 $daemon_dots{signature} = "A true daemon\n";
491
6fdf61fb 492Another way to lay hands on a reference to the underlying object is to
493use the tied() function, so they might alternately have set clobber
494using:
495
496 tie %daemon_dots, 'daemon';
497 tied(%daemon_dots)->clobber(1);
498
499The clobber method is simply:
cb1a09d0
AD
500
501 sub clobber {
502 my $self = shift;
503 $self->{CLOBBER} = @_ ? shift : 1;
504 }
505
506=item DELETE this, key
507
508This method is triggered when we remove an element from the hash,
509typically by using the delete() function. Again, we'll
510be careful to check whether they really want to clobber files.
511
512 sub DELETE {
513 carp &whowasi if $DEBUG;
514
515 my $self = shift;
516 my $dot = shift;
517 my $file = $self->{HOME} . "/.$dot";
518 croak "@{[&whowasi]}: won't remove file $file"
519 unless $self->{CLOBBER};
520 delete $self->{LIST}->{$dot};
1f57c600 521 my $success = unlink($file);
522 carp "@{[&whowasi]}: can't unlink $file: $!" unless $success;
523 $success;
cb1a09d0
AD
524 }
525
1f57c600 526The value returned by DELETE becomes the return value of the call
527to delete(). If you want to emulate the normal behavior of delete(),
528you should return whatever FETCH would have returned for this key.
529In this example, we have chosen instead to return a value which tells
530the caller whether the file was successfully deleted.
531
cb1a09d0
AD
532=item CLEAR this
533
534This method is triggered when the whole hash is to be cleared, usually by
535assigning the empty list to it.
536
5f05dabc 537In our example, that would remove all the user's dot files! It's such a
cb1a09d0
AD
538dangerous thing that they'll have to set CLOBBER to something higher than
5391 to make it happen.
540
541 sub CLEAR {
542 carp &whowasi if $DEBUG;
543 my $self = shift;
5f05dabc 544 croak "@{[&whowasi]}: won't remove all dot files for $self->{USER}"
cb1a09d0
AD
545 unless $self->{CLOBBER} > 1;
546 my $dot;
547 foreach $dot ( keys %{$self->{LIST}}) {
548 $self->DELETE($dot);
549 }
550 }
551
552=item EXISTS this, key
553
554This method is triggered when the user uses the exists() function
555on a particular hash. In our example, we'll look at the C<{LIST}>
556hash element for this:
557
558 sub EXISTS {
559 carp &whowasi if $DEBUG;
560 my $self = shift;
561 my $dot = shift;
562 return exists $self->{LIST}->{$dot};
563 }
564
565=item FIRSTKEY this
566
567This method will be triggered when the user is going
568to iterate through the hash, such as via a keys() or each()
569call.
570
571 sub FIRSTKEY {
572 carp &whowasi if $DEBUG;
573 my $self = shift;
6fdf61fb 574 my $a = keys %{$self->{LIST}}; # reset each() iterator
cb1a09d0
AD
575 each %{$self->{LIST}}
576 }
577
578=item NEXTKEY this, lastkey
579
580This method gets triggered during a keys() or each() iteration. It has a
581second argument which is the last key that had been accessed. This is
582useful if you're carrying about ordering or calling the iterator from more
583than one sequence, or not really storing things in a hash anywhere.
584
5f05dabc 585For our example, we're using a real hash so we'll do just the simple
586thing, but we'll have to go through the LIST field indirectly.
cb1a09d0
AD
587
588 sub NEXTKEY {
589 carp &whowasi if $DEBUG;
590 my $self = shift;
591 return each %{ $self->{LIST} }
592 }
593
594=item DESTROY this
595
596This method is triggered when a tied hash is about to go out of
597scope. You don't really need it unless you're trying to add debugging
598or have auxiliary state to clean up. Here's a very simple function:
599
600 sub DESTROY {
601 carp &whowasi if $DEBUG;
602 }
603
604=back
605
1d2dff63
GS
606Note that functions such as keys() and values() may return huge lists
607when used on large objects, like DBM files. You may prefer to use the
608each() function to iterate over such. Example:
cb1a09d0
AD
609
610 # print out history file offsets
611 use NDBM_File;
1f57c600 612 tie(%HIST, 'NDBM_File', '/usr/lib/news/history', 1, 0);
cb1a09d0
AD
613 while (($key,$val) = each %HIST) {
614 print $key, ' = ', unpack('L',$val), "\n";
615 }
616 untie(%HIST);
617
618=head2 Tying FileHandles
619
184e9718 620This is partially implemented now.
a7adf1f0 621
2ae324a7 622A class implementing a tied filehandle should define the following
1d603a67
GB
623methods: TIEHANDLE, at least one of PRINT, PRINTF, WRITE, READLINE, GETC,
624READ, and possibly CLOSE and DESTROY.
a7adf1f0 625
626It is especially useful when perl is embedded in some other program,
627where output to STDOUT and STDERR may have to be redirected in some
628special way. See nvi and the Apache module for examples.
629
630In our example we're going to create a shouting handle.
631
632 package Shout;
633
634=over
635
636=item TIEHANDLE classname, LIST
637
638This is the constructor for the class. That means it is expected to
184e9718 639return a blessed reference of some sort. The reference can be used to
5f05dabc 640hold some internal information.
a7adf1f0 641
7e1af8bc 642 sub TIEHANDLE { print "<shout>\n"; my $i; bless \$i, shift }
a7adf1f0 643
1d603a67
GB
644=item WRITE this, LIST
645
646This method will be called when the handle is written to via the
647C<syswrite> function.
648
649 sub WRITE {
650 $r = shift;
651 my($buf,$len,$offset) = @_;
652 print "WRITE called, \$buf=$buf, \$len=$len, \$offset=$offset";
653 }
654
a7adf1f0 655=item PRINT this, LIST
656
46fc3d4c 657This method will be triggered every time the tied handle is printed to
658with the C<print()> function.
184e9718 659Beyond its self reference it also expects the list that was passed to
a7adf1f0 660the print function.
661
58f51617
SV
662 sub PRINT { $r = shift; $$r++; print join($,,map(uc($_),@_)),$\ }
663
46fc3d4c 664=item PRINTF this, LIST
665
666This method will be triggered every time the tied handle is printed to
667with the C<printf()> function.
668Beyond its self reference it also expects the format and list that was
669passed to the printf function.
670
671 sub PRINTF {
672 shift;
673 my $fmt = shift;
674 print sprintf($fmt, @_)."\n";
675 }
676
1d603a67 677=item READ this, LIST
2ae324a7 678
679This method will be called when the handle is read from via the C<read>
680or C<sysread> functions.
681
682 sub READ {
889a76e8
GS
683 my $self = shift;
684 my $$bufref = \$_[0];
685 my(undef,$len,$offset) = @_;
686 print "READ called, \$buf=$bufref, \$len=$len, \$offset=$offset";
687 # add to $$bufref, set $len to number of characters read
688 $len;
2ae324a7 689 }
690
58f51617
SV
691=item READLINE this
692
2ae324a7 693This method will be called when the handle is read from via <HANDLE>.
694The method should return undef when there is no more data.
58f51617 695
889a76e8 696 sub READLINE { $r = shift; "READLINE called $$r times\n"; }
a7adf1f0 697
2ae324a7 698=item GETC this
699
700This method will be called when the C<getc> function is called.
701
702 sub GETC { print "Don't GETC, Get Perl"; return "a"; }
703
1d603a67
GB
704=item CLOSE this
705
706This method will be called when the handle is closed via the C<close>
707function.
708
709 sub CLOSE { print "CLOSE called.\n" }
710
a7adf1f0 711=item DESTROY this
712
713As with the other types of ties, this method will be called when the
714tied handle is about to be destroyed. This is useful for debugging and
715possibly cleaning up.
716
717 sub DESTROY { print "</shout>\n" }
718
719=back
720
721Here's how to use our little example:
722
723 tie(*FOO,'Shout');
724 print FOO "hello\n";
725 $a = 4; $b = 6;
726 print FOO $a, " plus ", $b, " equals ", $a + $b, "\n";
58f51617 727 print <FOO>;
cb1a09d0 728
2752eb9f
PM
729=head2 The C<untie> Gotcha
730
731If you intend making use of the object returned from either tie() or
732tied(), and if the tie's target class defines a destructor, there is a
733subtle gotcha you I<must> guard against.
734
735As setup, consider this (admittedly rather contrived) example of a
736tie; all it does is use a file to keep a log of the values assigned to
737a scalar.
738
739 package Remember;
740
741 use strict;
742 use IO::File;
743
744 sub TIESCALAR {
745 my $class = shift;
746 my $filename = shift;
747 my $handle = new IO::File "> $filename"
748 or die "Cannot open $filename: $!\n";
749
750 print $handle "The Start\n";
751 bless {FH => $handle, Value => 0}, $class;
752 }
753
754 sub FETCH {
755 my $self = shift;
756 return $self->{Value};
757 }
758
759 sub STORE {
760 my $self = shift;
761 my $value = shift;
762 my $handle = $self->{FH};
763 print $handle "$value\n";
764 $self->{Value} = $value;
765 }
766
767 sub DESTROY {
768 my $self = shift;
769 my $handle = $self->{FH};
770 print $handle "The End\n";
771 close $handle;
772 }
773
774 1;
775
776Here is an example that makes use of this tie:
777
778 use strict;
779 use Remember;
780
781 my $fred;
782 tie $fred, 'Remember', 'myfile.txt';
783 $fred = 1;
784 $fred = 4;
785 $fred = 5;
786 untie $fred;
787 system "cat myfile.txt";
788
789This is the output when it is executed:
790
791 The Start
792 1
793 4
794 5
795 The End
796
797So far so good. Those of you who have been paying attention will have
798spotted that the tied object hasn't been used so far. So lets add an
799extra method to the Remember class to allow comments to be included in
800the file -- say, something like this:
801
802 sub comment {
803 my $self = shift;
804 my $text = shift;
805 my $handle = $self->{FH};
806 print $handle $text, "\n";
807 }
808
809And here is the previous example modified to use the C<comment> method
810(which requires the tied object):
811
812 use strict;
813 use Remember;
814
815 my ($fred, $x);
816 $x = tie $fred, 'Remember', 'myfile.txt';
817 $fred = 1;
818 $fred = 4;
819 comment $x "changing...";
820 $fred = 5;
821 untie $fred;
822 system "cat myfile.txt";
823
824When this code is executed there is no output. Here's why:
825
826When a variable is tied, it is associated with the object which is the
827return value of the TIESCALAR, TIEARRAY, or TIEHASH function. This
828object normally has only one reference, namely, the implicit reference
829from the tied variable. When untie() is called, that reference is
830destroyed. Then, as in the first example above, the object's
831destructor (DESTROY) is called, which is normal for objects that have
832no more valid references; and thus the file is closed.
833
834In the second example, however, we have stored another reference to
835the tied object in C<$x>. That means that when untie() gets called
836there will still be a valid reference to the object in existence, so
837the destructor is not called at that time, and thus the file is not
838closed. The reason there is no output is because the file buffers
839have not been flushed to disk.
840
841Now that you know what the problem is, what can you do to avoid it?
842Well, the good old C<-w> flag will spot any instances where you call
843untie() and there are still valid references to the tied object. If
844the second script above is run with the C<-w> flag, Perl prints this
845warning message:
846
847 untie attempted while 1 inner references still exist
848
849To get the script to work properly and silence the warning make sure
850there are no valid references to the tied object I<before> untie() is
851called:
852
853 undef $x;
854 untie $fred;
855
cb1a09d0
AD
856=head1 SEE ALSO
857
858See L<DB_File> or L<Config> for some interesting tie() implementations.
859
860=head1 BUGS
861
862Tied arrays are I<incomplete>. They are also distinctly lacking something
863for the C<$#ARRAY> access (which is hard, as it's an lvalue), as well as
864the other obvious array functions, like push(), pop(), shift(), unshift(),
865and splice().
866
c07a80fd 867You cannot easily tie a multilevel data structure (such as a hash of
868hashes) to a dbm file. The first problem is that all but GDBM and
869Berkeley DB have size limitations, but beyond that, you also have problems
870with how references are to be represented on disk. One experimental
5f05dabc 871module that does attempt to address this need partially is the MLDBM
f102b883 872module. Check your nearest CPAN site as described in L<perlmodlib> for
c07a80fd 873source code to MLDBM.
874
cb1a09d0
AD
875=head1 AUTHOR
876
877Tom Christiansen
a7adf1f0 878
46fc3d4c 879TIEHANDLE by Sven Verdoolaege <F<skimo@dns.ufsia.ac.be>> and Doug MacEachern <F<dougm@osf.org>>