xref: /openbsd-src/gnu/usr.bin/perl/pod/perlref.pod (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1=head1 NAME
2X<reference> X<pointer> X<data structure> X<structure> X<struct>
3
4perlref - Perl references and nested data structures
5
6=head1 NOTE
7
8This is complete documentation about all aspects of references.
9For a shorter, tutorial introduction to just the essential features,
10see L<perlreftut>.
11
12=head1 DESCRIPTION
13
14Before release 5 of Perl it was difficult to represent complex data
15structures, because all references had to be symbolic--and even then
16it was difficult to refer to a variable instead of a symbol table entry.
17Perl now not only makes it easier to use symbolic references to variables,
18but also lets you have "hard" references to any piece of data or code.
19Any scalar may hold a hard reference.  Because arrays and hashes contain
20scalars, you can now easily build arrays of arrays, arrays of hashes,
21hashes of arrays, arrays of hashes of functions, and so on.
22
23Hard references are smart--they keep track of reference counts for you,
24automatically freeing the thing referred to when its reference count goes
25to zero.  (Reference counts for values in self-referential or
26cyclic data structures may not go to zero without a little help; see
27L</"Circular References"> for a detailed explanation.)
28If that thing happens to be an object, the object is destructed.  See
29L<perlobj> for more about objects.  (In a sense, everything in Perl is an
30object, but we usually reserve the word for references to objects that
31have been officially "blessed" into a class package.)
32
33Symbolic references are names of variables or other objects, just as a
34symbolic link in a Unix filesystem contains merely the name of a file.
35The C<*glob> notation is something of a symbolic reference.  (Symbolic
36references are sometimes called "soft references", but please don't call
37them that; references are confusing enough without useless synonyms.)
38X<reference, symbolic> X<reference, soft>
39X<symbolic reference> X<soft reference>
40
41In contrast, hard references are more like hard links in a Unix file
42system: They are used to access an underlying object without concern for
43what its (other) name is.  When the word "reference" is used without an
44adjective, as in the following paragraph, it is usually talking about a
45hard reference.
46X<reference, hard> X<hard reference>
47
48References are easy to use in Perl.  There is just one overriding
49principle: in general, Perl does no implicit referencing or dereferencing.
50When a scalar is holding a reference, it always behaves as a simple scalar.
51It doesn't magically start being an array or hash or subroutine; you have to
52tell it explicitly to do so, by dereferencing it.
53
54That said, be aware that Perl version 5.14 introduces an exception
55to the rule, for syntactic convenience.  Experimental array and hash container
56function behavior allows array and hash references to be handled by Perl as
57if they had been explicitly syntactically dereferenced.  See
58L<perl5140delta/"Syntactical Enhancements">
59and L<perlfunc> for details.
60
61=head2 Making References
62X<reference, creation> X<referencing>
63
64References can be created in several ways.
65
66=over 4
67
68=item 1.
69X<\> X<backslash>
70
71By using the backslash operator on a variable, subroutine, or value.
72(This works much like the & (address-of) operator in C.)
73This typically creates I<another> reference to a variable, because
74there's already a reference to the variable in the symbol table.  But
75the symbol table reference might go away, and you'll still have the
76reference that the backslash returned.  Here are some examples:
77
78    $scalarref = \$foo;
79    $arrayref  = \@ARGV;
80    $hashref   = \%ENV;
81    $coderef   = \&handler;
82    $globref   = \*foo;
83
84It isn't possible to create a true reference to an IO handle (filehandle
85or dirhandle) using the backslash operator.  The most you can get is a
86reference to a typeglob, which is actually a complete symbol table entry.
87But see the explanation of the C<*foo{THING}> syntax below.  However,
88you can still use type globs and globrefs as though they were IO handles.
89
90=item 2.
91X<array, anonymous> X<[> X<[]> X<square bracket>
92X<bracket, square> X<arrayref> X<array reference> X<reference, array>
93
94A reference to an anonymous array can be created using square
95brackets:
96
97    $arrayref = [1, 2, ['a', 'b', 'c']];
98
99Here we've created a reference to an anonymous array of three elements
100whose final element is itself a reference to another anonymous array of three
101elements.  (The multidimensional syntax described later can be used to
102access this.  For example, after the above, C<< $arrayref->[2][1] >> would have
103the value "b".)
104
105Taking a reference to an enumerated list is not the same
106as using square brackets--instead it's the same as creating
107a list of references!
108
109    @list = (\$a, \@b, \%c);
110    @list = \($a, @b, %c);	# same thing!
111
112As a special case, C<\(@foo)> returns a list of references to the contents
113of C<@foo>, not a reference to C<@foo> itself.  Likewise for C<%foo>,
114except that the key references are to copies (since the keys are just
115strings rather than full-fledged scalars).
116
117=item 3.
118X<hash, anonymous> X<{> X<{}> X<curly bracket>
119X<bracket, curly> X<brace> X<hashref> X<hash reference> X<reference, hash>
120
121A reference to an anonymous hash can be created using curly
122brackets:
123
124    $hashref = {
125	'Adam'  => 'Eve',
126	'Clyde' => 'Bonnie',
127    };
128
129Anonymous hash and array composers like these can be intermixed freely to
130produce as complicated a structure as you want.  The multidimensional
131syntax described below works for these too.  The values above are
132literals, but variables and expressions would work just as well, because
133assignment operators in Perl (even within local() or my()) are executable
134statements, not compile-time declarations.
135
136Because curly brackets (braces) are used for several other things
137including BLOCKs, you may occasionally have to disambiguate braces at the
138beginning of a statement by putting a C<+> or a C<return> in front so
139that Perl realizes the opening brace isn't starting a BLOCK.  The economy and
140mnemonic value of using curlies is deemed worth this occasional extra
141hassle.
142
143For example, if you wanted a function to make a new hash and return a
144reference to it, you have these options:
145
146    sub hashem {        { @_ } }   # silently wrong
147    sub hashem {       +{ @_ } }   # ok
148    sub hashem { return { @_ } }   # ok
149
150On the other hand, if you want the other meaning, you can do this:
151
152    sub showem {        { @_ } }   # ambiguous (currently ok, but may change)
153    sub showem {       {; @_ } }   # ok
154    sub showem { { return @_ } }   # ok
155
156The leading C<+{> and C<{;> always serve to disambiguate
157the expression to mean either the HASH reference, or the BLOCK.
158
159=item 4.
160X<subroutine, anonymous> X<subroutine, reference> X<reference, subroutine>
161X<scope, lexical> X<closure> X<lexical> X<lexical scope>
162
163A reference to an anonymous subroutine can be created by using
164C<sub> without a subname:
165
166    $coderef = sub { print "Boink!\n" };
167
168Note the semicolon.  Except for the code
169inside not being immediately executed, a C<sub {}> is not so much a
170declaration as it is an operator, like C<do{}> or C<eval{}>.  (However, no
171matter how many times you execute that particular line (unless you're in an
172C<eval("...")>), $coderef will still have a reference to the I<same>
173anonymous subroutine.)
174
175Anonymous subroutines act as closures with respect to my() variables,
176that is, variables lexically visible within the current scope.  Closure
177is a notion out of the Lisp world that says if you define an anonymous
178function in a particular lexical context, it pretends to run in that
179context even when it's called outside the context.
180
181In human terms, it's a funny way of passing arguments to a subroutine when
182you define it as well as when you call it.  It's useful for setting up
183little bits of code to run later, such as callbacks.  You can even
184do object-oriented stuff with it, though Perl already provides a different
185mechanism to do that--see L<perlobj>.
186
187You might also think of closure as a way to write a subroutine
188template without using eval().  Here's a small example of how
189closures work:
190
191    sub newprint {
192	my $x = shift;
193	return sub { my $y = shift; print "$x, $y!\n"; };
194    }
195    $h = newprint("Howdy");
196    $g = newprint("Greetings");
197
198    # Time passes...
199
200    &$h("world");
201    &$g("earthlings");
202
203This prints
204
205    Howdy, world!
206    Greetings, earthlings!
207
208Note particularly that $x continues to refer to the value passed
209into newprint() I<despite> "my $x" having gone out of scope by the
210time the anonymous subroutine runs.  That's what a closure is all
211about.
212
213This applies only to lexical variables, by the way.  Dynamic variables
214continue to work as they have always worked.  Closure is not something
215that most Perl programmers need trouble themselves about to begin with.
216
217=item 5.
218X<constructor> X<new>
219
220References are often returned by special subroutines called constructors.  Perl
221objects are just references to a special type of object that happens to know
222which package it's associated with.  Constructors are just special subroutines
223that know how to create that association.  They do so by starting with an
224ordinary reference, and it remains an ordinary reference even while it's also
225being an object.  Constructors are often named C<new()>.  You I<can> call them
226indirectly:
227
228    $objref = new Doggie( Tail => 'short', Ears => 'long' );
229
230But that can produce ambiguous syntax in certain cases, so it's often
231better to use the direct method invocation approach:
232
233    $objref   = Doggie->new(Tail => 'short', Ears => 'long');
234
235    use Term::Cap;
236    $terminal = Term::Cap->Tgetent( { OSPEED => 9600 });
237
238    use Tk;
239    $main    = MainWindow->new();
240    $menubar = $main->Frame(-relief              => "raised",
241                            -borderwidth         => 2)
242
243=item 6.
244X<autovivification>
245
246References of the appropriate type can spring into existence if you
247dereference them in a context that assumes they exist.  Because we haven't
248talked about dereferencing yet, we can't show you any examples yet.
249
250=item 7.
251X<*foo{THING}> X<*>
252
253A reference can be created by using a special syntax, lovingly known as
254the *foo{THING} syntax.  *foo{THING} returns a reference to the THING
255slot in *foo (which is the symbol table entry which holds everything
256known as foo).
257
258    $scalarref = *foo{SCALAR};
259    $arrayref  = *ARGV{ARRAY};
260    $hashref   = *ENV{HASH};
261    $coderef   = *handler{CODE};
262    $ioref     = *STDIN{IO};
263    $globref   = *foo{GLOB};
264    $formatref = *foo{FORMAT};
265    $globname  = *foo{NAME};    # "foo"
266    $pkgname   = *foo{PACKAGE}; # "main"
267
268Most of these are self-explanatory, but C<*foo{IO}>
269deserves special attention.  It returns
270the IO handle, used for file handles (L<perlfunc/open>), sockets
271(L<perlfunc/socket> and L<perlfunc/socketpair>), and directory
272handles (L<perlfunc/opendir>).  For compatibility with previous
273versions of Perl, C<*foo{FILEHANDLE}> is a synonym for C<*foo{IO}>, though it
274is deprecated as of 5.8.0.  If deprecation warnings are in effect, it will warn
275of its use.
276
277C<*foo{THING}> returns undef if that particular THING hasn't been used yet,
278except in the case of scalars.  C<*foo{SCALAR}> returns a reference to an
279anonymous scalar if $foo hasn't been used yet.  This might change in a
280future release.
281
282C<*foo{NAME}> and C<*foo{PACKAGE}> are the exception, in that they return
283strings, rather than references.  These return the package and name of the
284typeglob itself, rather than one that has been assigned to it.  So, after
285C<*foo=*Foo::bar>, C<*foo> will become "*Foo::bar" when used as a string,
286but C<*foo{PACKAGE}> and C<*foo{NAME}> will continue to produce "main" and
287"foo", respectively.
288
289C<*foo{IO}> is an alternative to the C<*HANDLE> mechanism given in
290L<perldata/"Typeglobs and Filehandles"> for passing filehandles
291into or out of subroutines, or storing into larger data structures.
292Its disadvantage is that it won't create a new filehandle for you.
293Its advantage is that you have less risk of clobbering more than
294you want to with a typeglob assignment.  (It still conflates file
295and directory handles, though.)  However, if you assign the incoming
296value to a scalar instead of a typeglob as we do in the examples
297below, there's no risk of that happening.
298
299    splutter(*STDOUT);		# pass the whole glob
300    splutter(*STDOUT{IO});	# pass both file and dir handles
301
302    sub splutter {
303	my $fh = shift;
304	print $fh "her um well a hmmm\n";
305    }
306
307    $rec = get_rec(*STDIN);	# pass the whole glob
308    $rec = get_rec(*STDIN{IO}); # pass both file and dir handles
309
310    sub get_rec {
311	my $fh = shift;
312	return scalar <$fh>;
313    }
314
315=back
316
317=head2 Using References
318X<reference, use> X<dereferencing> X<dereference>
319
320That's it for creating references.  By now you're probably dying to
321know how to use references to get back to your long-lost data.  There
322are several basic methods.
323
324=over 4
325
326=item 1.
327
328Anywhere you'd put an identifier (or chain of identifiers) as part
329of a variable or subroutine name, you can replace the identifier with
330a simple scalar variable containing a reference of the correct type:
331
332    $bar = $$scalarref;
333    push(@$arrayref, $filename);
334    $$arrayref[0] = "January";
335    $$hashref{"KEY"} = "VALUE";
336    &$coderef(1,2,3);
337    print $globref "output\n";
338
339It's important to understand that we are specifically I<not> dereferencing
340C<$arrayref[0]> or C<$hashref{"KEY"}> there.  The dereference of the
341scalar variable happens I<before> it does any key lookups.  Anything more
342complicated than a simple scalar variable must use methods 2 or 3 below.
343However, a "simple scalar" includes an identifier that itself uses method
3441 recursively.  Therefore, the following prints "howdy".
345
346    $refrefref = \\\"howdy";
347    print $$$$refrefref;
348
349=item 2.
350
351Anywhere you'd put an identifier (or chain of identifiers) as part of a
352variable or subroutine name, you can replace the identifier with a
353BLOCK returning a reference of the correct type.  In other words, the
354previous examples could be written like this:
355
356    $bar = ${$scalarref};
357    push(@{$arrayref}, $filename);
358    ${$arrayref}[0] = "January";
359    ${$hashref}{"KEY"} = "VALUE";
360    &{$coderef}(1,2,3);
361    $globref->print("output\n");  # iff IO::Handle is loaded
362
363Admittedly, it's a little silly to use the curlies in this case, but
364the BLOCK can contain any arbitrary expression, in particular,
365subscripted expressions:
366
367    &{ $dispatch{$index} }(1,2,3);	# call correct routine
368
369Because of being able to omit the curlies for the simple case of C<$$x>,
370people often make the mistake of viewing the dereferencing symbols as
371proper operators, and wonder about their precedence.  If they were,
372though, you could use parentheses instead of braces.  That's not the case.
373Consider the difference below; case 0 is a short-hand version of case 1,
374I<not> case 2:
375
376    $$hashref{"KEY"}   = "VALUE";	# CASE 0
377    ${$hashref}{"KEY"} = "VALUE";	# CASE 1
378    ${$hashref{"KEY"}} = "VALUE";	# CASE 2
379    ${$hashref->{"KEY"}} = "VALUE";	# CASE 3
380
381Case 2 is also deceptive in that you're accessing a variable
382called %hashref, not dereferencing through $hashref to the hash
383it's presumably referencing.  That would be case 3.
384
385=item 3.
386
387Subroutine calls and lookups of individual array elements arise often
388enough that it gets cumbersome to use method 2.  As a form of
389syntactic sugar, the examples for method 2 may be written:
390
391    $arrayref->[0] = "January";   # Array element
392    $hashref->{"KEY"} = "VALUE";  # Hash element
393    $coderef->(1,2,3);            # Subroutine call
394
395The left side of the arrow can be any expression returning a reference,
396including a previous dereference.  Note that C<$array[$x]> is I<not> the
397same thing as C<< $array->[$x] >> here:
398
399    $array[$x]->{"foo"}->[0] = "January";
400
401This is one of the cases we mentioned earlier in which references could
402spring into existence when in an lvalue context.  Before this
403statement, C<$array[$x]> may have been undefined.  If so, it's
404automatically defined with a hash reference so that we can look up
405C<{"foo"}> in it.  Likewise C<< $array[$x]->{"foo"} >> will automatically get
406defined with an array reference so that we can look up C<[0]> in it.
407This process is called I<autovivification>.
408
409One more thing here.  The arrow is optional I<between> brackets
410subscripts, so you can shrink the above down to
411
412    $array[$x]{"foo"}[0] = "January";
413
414Which, in the degenerate case of using only ordinary arrays, gives you
415multidimensional arrays just like C's:
416
417    $score[$x][$y][$z] += 42;
418
419Well, okay, not entirely like C's arrays, actually.  C doesn't know how
420to grow its arrays on demand.  Perl does.
421
422=item 4.
423
424If a reference happens to be a reference to an object, then there are
425probably methods to access the things referred to, and you should probably
426stick to those methods unless you're in the class package that defines the
427object's methods.  In other words, be nice, and don't violate the object's
428encapsulation without a very good reason.  Perl does not enforce
429encapsulation.  We are not totalitarians here.  We do expect some basic
430civility though.
431
432=back
433
434Using a string or number as a reference produces a symbolic reference,
435as explained above.  Using a reference as a number produces an
436integer representing its storage location in memory.  The only
437useful thing to be done with this is to compare two references
438numerically to see whether they refer to the same location.
439X<reference, numeric context>
440
441    if ($ref1 == $ref2) {  # cheap numeric compare of references
442	print "refs 1 and 2 refer to the same thing\n";
443    }
444
445Using a reference as a string produces both its referent's type,
446including any package blessing as described in L<perlobj>, as well
447as the numeric address expressed in hex.  The ref() operator returns
448just the type of thing the reference is pointing to, without the
449address.  See L<perlfunc/ref> for details and examples of its use.
450X<reference, string context>
451
452The bless() operator may be used to associate the object a reference
453points to with a package functioning as an object class.  See L<perlobj>.
454
455A typeglob may be dereferenced the same way a reference can, because
456the dereference syntax always indicates the type of reference desired.
457So C<${*foo}> and C<${\$foo}> both indicate the same scalar variable.
458
459Here's a trick for interpolating a subroutine call into a string:
460
461    print "My sub returned @{[mysub(1,2,3)]} that time.\n";
462
463The way it works is that when the C<@{...}> is seen in the double-quoted
464string, it's evaluated as a block.  The block creates a reference to an
465anonymous array containing the results of the call to C<mysub(1,2,3)>.  So
466the whole block returns a reference to an array, which is then
467dereferenced by C<@{...}> and stuck into the double-quoted string. This
468chicanery is also useful for arbitrary expressions:
469
470    print "That yields @{[$n + 5]} widgets\n";
471
472Similarly, an expression that returns a reference to a scalar can be
473dereferenced via C<${...}>. Thus, the above expression may be written
474as:
475
476    print "That yields ${\($n + 5)} widgets\n";
477
478=head2 Circular References
479X<circular reference> X<reference, circular>
480
481It is possible to create a "circular reference" in Perl, which can lead
482to memory leaks. A circular reference occurs when two references
483contain a reference to each other, like this:
484
485    my $foo = {};
486    my $bar = { foo => $foo };
487    $foo->{bar} = $bar;
488
489You can also create a circular reference with a single variable:
490
491    my $foo;
492    $foo = \$foo;
493
494In this case, the reference count for the variables will never reach 0,
495and the references will never be garbage-collected. This can lead to
496memory leaks.
497
498Because objects in Perl are implemented as references, it's possible to
499have circular references with objects as well. Imagine a TreeNode class
500where each node references its parent and child nodes. Any node with a
501parent will be part of a circular reference.
502
503You can break circular references by creating a "weak reference". A
504weak reference does not increment the reference count for a variable,
505which means that the object can go out of scope and be destroyed. You
506can weaken a reference with the C<weaken> function exported by the
507L<Scalar::Util> module.
508
509Here's how we can make the first example safer:
510
511    use Scalar::Util 'weaken';
512
513    my $foo = {};
514    my $bar = { foo => $foo };
515    $foo->{bar} = $bar;
516
517    weaken $foo->{bar};
518
519The reference from C<$foo> to C<$bar> has been weakened. When the
520C<$bar> variable goes out of scope, it will be garbage-collected. The
521next time you look at the value of the C<< $foo->{bar} >> key, it will
522be C<undef>.
523
524This action at a distance can be confusing, so you should be careful
525with your use of weaken. You should weaken the reference in the
526variable that will go out of scope I<first>. That way, the longer-lived
527variable will contain the expected reference until it goes out of
528scope.
529
530=head2 Symbolic references
531X<reference, symbolic> X<reference, soft>
532X<symbolic reference> X<soft reference>
533
534We said that references spring into existence as necessary if they are
535undefined, but we didn't say what happens if a value used as a
536reference is already defined, but I<isn't> a hard reference.  If you
537use it as a reference, it'll be treated as a symbolic
538reference.  That is, the value of the scalar is taken to be the I<name>
539of a variable, rather than a direct link to a (possibly) anonymous
540value.
541
542People frequently expect it to work like this.  So it does.
543
544    $name = "foo";
545    $$name = 1;			# Sets $foo
546    ${$name} = 2;		# Sets $foo
547    ${$name x 2} = 3;		# Sets $foofoo
548    $name->[0] = 4;		# Sets $foo[0]
549    @$name = ();		# Clears @foo
550    &$name();			# Calls &foo()
551    $pack = "THAT";
552    ${"${pack}::$name"} = 5;	# Sets $THAT::foo without eval
553
554This is powerful, and slightly dangerous, in that it's possible
555to intend (with the utmost sincerity) to use a hard reference, and
556accidentally use a symbolic reference instead.  To protect against
557that, you can say
558
559    use strict 'refs';
560
561and then only hard references will be allowed for the rest of the enclosing
562block.  An inner block may countermand that with
563
564    no strict 'refs';
565
566Only package variables (globals, even if localized) are visible to
567symbolic references.  Lexical variables (declared with my()) aren't in
568a symbol table, and thus are invisible to this mechanism.  For example:
569
570    local $value = 10;
571    $ref = "value";
572    {
573	my $value = 20;
574	print $$ref;
575    }
576
577This will still print 10, not 20.  Remember that local() affects package
578variables, which are all "global" to the package.
579
580=head2 Not-so-symbolic references
581
582Brackets around a symbolic reference can simply
583serve to isolate an identifier or variable name from the rest of an
584expression, just as they always have within a string.  For example,
585
586    $push = "pop on ";
587    print "${push}over";
588
589has always meant to print "pop on over", even though push is
590a reserved word.  This is generalized to work the same
591without the enclosing double quotes, so that
592
593    print ${push} . "over";
594
595and even
596
597    print ${ push } . "over";
598
599will have the same effect.  This
600construct is I<not> considered to be a symbolic reference when you're
601using strict refs:
602
603    use strict 'refs';
604    ${ bareword };	# Okay, means $bareword.
605    ${ "bareword" };	# Error, symbolic reference.
606
607Similarly, because of all the subscripting that is done using single words,
608the same rule applies to any bareword that is used for subscripting a hash.
609So now, instead of writing
610
611    $array{ "aaa" }{ "bbb" }{ "ccc" }
612
613you can write just
614
615    $array{ aaa }{ bbb }{ ccc }
616
617and not worry about whether the subscripts are reserved words.  In the
618rare event that you do wish to do something like
619
620    $array{ shift }
621
622you can force interpretation as a reserved word by adding anything that
623makes it more than a bareword:
624
625    $array{ shift() }
626    $array{ +shift }
627    $array{ shift @_ }
628
629The C<use warnings> pragma or the B<-w> switch will warn you if it
630interprets a reserved word as a string.
631But it will no longer warn you about using lowercase words, because the
632string is effectively quoted.
633
634=head2 Pseudo-hashes: Using an array as a hash
635X<pseudo-hash> X<pseudo hash> X<pseudohash>
636
637Pseudo-hashes have been removed from Perl.  The 'fields' pragma
638remains available.
639
640=head2 Function Templates
641X<scope, lexical> X<closure> X<lexical> X<lexical scope>
642X<subroutine, nested> X<sub, nested> X<subroutine, local> X<sub, local>
643
644As explained above, an anonymous function with access to the lexical
645variables visible when that function was compiled, creates a closure.  It
646retains access to those variables even though it doesn't get run until
647later, such as in a signal handler or a Tk callback.
648
649Using a closure as a function template allows us to generate many functions
650that act similarly.  Suppose you wanted functions named after the colors
651that generated HTML font changes for the various colors:
652
653    print "Be ", red("careful"), "with that ", green("light");
654
655The red() and green() functions would be similar.  To create these,
656we'll assign a closure to a typeglob of the name of the function we're
657trying to build.
658
659    @colors = qw(red blue green yellow orange purple violet);
660    for my $name (@colors) {
661        no strict 'refs';	# allow symbol table manipulation
662        *$name = *{uc $name} = sub { "<FONT COLOR='$name'>@_</FONT>" };
663    }
664
665Now all those different functions appear to exist independently.  You can
666call red(), RED(), blue(), BLUE(), green(), etc.  This technique saves on
667both compile time and memory use, and is less error-prone as well, since
668syntax checks happen at compile time.  It's critical that any variables in
669the anonymous subroutine be lexicals in order to create a proper closure.
670That's the reasons for the C<my> on the loop iteration variable.
671
672This is one of the only places where giving a prototype to a closure makes
673much sense.  If you wanted to impose scalar context on the arguments of
674these functions (probably not a wise idea for this particular example),
675you could have written it this way instead:
676
677    *$name = sub ($) { "<FONT COLOR='$name'>$_[0]</FONT>" };
678
679However, since prototype checking happens at compile time, the assignment
680above happens too late to be of much use.  You could address this by
681putting the whole loop of assignments within a BEGIN block, forcing it
682to occur during compilation.
683
684Access to lexicals that change over time--like those in the C<for> loop
685above, basically aliases to elements from the surrounding lexical scopes--
686only works with anonymous subs, not with named subroutines. Generally
687said, named subroutines do not nest properly and should only be declared
688in the main package scope.
689
690This is because named subroutines are created at compile time so their
691lexical variables get assigned to the parent lexicals from the first
692execution of the parent block. If a parent scope is entered a second
693time, its lexicals are created again, while the nested subs still
694reference the old ones.
695
696Anonymous subroutines get to capture each time you execute the C<sub>
697operator, as they are created on the fly. If you are accustomed to using
698nested subroutines in other programming languages with their own private
699variables, you'll have to work at it a bit in Perl.  The intuitive coding
700of this type of thing incurs mysterious warnings about "will not stay
701shared" due to the reasons explained above.
702For example, this won't work:
703
704    sub outer {
705        my $x = $_[0] + 35;
706        sub inner { return $x * 19 }   # WRONG
707        return $x + inner();
708    }
709
710A work-around is the following:
711
712    sub outer {
713        my $x = $_[0] + 35;
714        local *inner = sub { return $x * 19 };
715        return $x + inner();
716    }
717
718Now inner() can only be called from within outer(), because of the
719temporary assignments of the anonymous subroutine. But when it does,
720it has normal access to the lexical variable $x from the scope of
721outer() at the time outer is invoked.
722
723This has the interesting effect of creating a function local to another
724function, something not normally supported in Perl.
725
726=head1 WARNING
727X<reference, string context> X<reference, use as hash key>
728
729You may not (usefully) use a reference as the key to a hash.  It will be
730converted into a string:
731
732    $x{ \$a } = $a;
733
734If you try to dereference the key, it won't do a hard dereference, and
735you won't accomplish what you're attempting.  You might want to do something
736more like
737
738    $r = \@a;
739    $x{ $r } = $r;
740
741And then at least you can use the values(), which will be
742real refs, instead of the keys(), which won't.
743
744The standard Tie::RefHash module provides a convenient workaround to this.
745
746=head1 SEE ALSO
747
748Besides the obvious documents, source code can be instructive.
749Some pathological examples of the use of references can be found
750in the F<t/op/ref.t> regression test in the Perl source directory.
751
752See also L<perldsc> and L<perllol> for how to use references to create
753complex data structures, and L<perlootut> and L<perlobj>
754for how to use them to create objects.
755