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, 153 # but may change) 154 sub showem { {; @_ } } # ok 155 sub showem { { return @_ } } # ok 156 157The leading C<+{> and C<{;> always serve to disambiguate 158the expression to mean either the HASH reference, or the BLOCK. 159 160=item 4. 161X<subroutine, anonymous> X<subroutine, reference> X<reference, subroutine> 162X<scope, lexical> X<closure> X<lexical> X<lexical scope> 163 164A reference to an anonymous subroutine can be created by using 165C<sub> without a subname: 166 167 $coderef = sub { print "Boink!\n" }; 168 169Note the semicolon. Except for the code 170inside not being immediately executed, a C<sub {}> is not so much a 171declaration as it is an operator, like C<do{}> or C<eval{}>. (However, no 172matter how many times you execute that particular line (unless you're in an 173C<eval("...")>), $coderef will still have a reference to the I<same> 174anonymous subroutine.) 175 176Anonymous subroutines act as closures with respect to my() variables, 177that is, variables lexically visible within the current scope. Closure 178is a notion out of the Lisp world that says if you define an anonymous 179function in a particular lexical context, it pretends to run in that 180context even when it's called outside the context. 181 182In human terms, it's a funny way of passing arguments to a subroutine when 183you define it as well as when you call it. It's useful for setting up 184little bits of code to run later, such as callbacks. You can even 185do object-oriented stuff with it, though Perl already provides a different 186mechanism to do that--see L<perlobj>. 187 188You might also think of closure as a way to write a subroutine 189template without using eval(). Here's a small example of how 190closures work: 191 192 sub newprint { 193 my $x = shift; 194 return sub { my $y = shift; print "$x, $y!\n"; }; 195 } 196 $h = newprint("Howdy"); 197 $g = newprint("Greetings"); 198 199 # Time passes... 200 201 &$h("world"); 202 &$g("earthlings"); 203 204This prints 205 206 Howdy, world! 207 Greetings, earthlings! 208 209Note particularly that $x continues to refer to the value passed 210into newprint() I<despite> "my $x" having gone out of scope by the 211time the anonymous subroutine runs. That's what a closure is all 212about. 213 214This applies only to lexical variables, by the way. Dynamic variables 215continue to work as they have always worked. Closure is not something 216that most Perl programmers need trouble themselves about to begin with. 217 218=item 5. 219X<constructor> X<new> 220 221References are often returned by special subroutines called constructors. Perl 222objects are just references to a special type of object that happens to know 223which package it's associated with. Constructors are just special subroutines 224that know how to create that association. They do so by starting with an 225ordinary reference, and it remains an ordinary reference even while it's also 226being an object. Constructors are often named C<new()>. You I<can> call them 227indirectly: 228 229 $objref = new Doggie( Tail => 'short', Ears => 'long' ); 230 231But that can produce ambiguous syntax in certain cases, so it's often 232better to use the direct method invocation approach: 233 234 $objref = Doggie->new(Tail => 'short', Ears => 'long'); 235 236 use Term::Cap; 237 $terminal = Term::Cap->Tgetent( { OSPEED => 9600 }); 238 239 use Tk; 240 $main = MainWindow->new(); 241 $menubar = $main->Frame(-relief => "raised", 242 -borderwidth => 2) 243 244=item 6. 245X<autovivification> 246 247References of the appropriate type can spring into existence if you 248dereference them in a context that assumes they exist. Because we haven't 249talked about dereferencing yet, we can't show you any examples yet. 250 251=item 7. 252X<*foo{THING}> X<*> 253 254A reference can be created by using a special syntax, lovingly known as 255the *foo{THING} syntax. *foo{THING} returns a reference to the THING 256slot in *foo (which is the symbol table entry which holds everything 257known as foo). 258 259 $scalarref = *foo{SCALAR}; 260 $arrayref = *ARGV{ARRAY}; 261 $hashref = *ENV{HASH}; 262 $coderef = *handler{CODE}; 263 $ioref = *STDIN{IO}; 264 $globref = *foo{GLOB}; 265 $formatref = *foo{FORMAT}; 266 $globname = *foo{NAME}; # "foo" 267 $pkgname = *foo{PACKAGE}; # "main" 268 269Most of these are self-explanatory, but C<*foo{IO}> 270deserves special attention. It returns 271the IO handle, used for file handles (L<perlfunc/open>), sockets 272(L<perlfunc/socket> and L<perlfunc/socketpair>), and directory 273handles (L<perlfunc/opendir>). For compatibility with previous 274versions of Perl, C<*foo{FILEHANDLE}> is a synonym for C<*foo{IO}>, though it 275is deprecated as of 5.8.0. If deprecation warnings are in effect, it will warn 276of its use. 277 278C<*foo{THING}> returns undef if that particular THING hasn't been used yet, 279except in the case of scalars. C<*foo{SCALAR}> returns a reference to an 280anonymous scalar if $foo hasn't been used yet. This might change in a 281future release. 282 283C<*foo{NAME}> and C<*foo{PACKAGE}> are the exception, in that they return 284strings, rather than references. These return the package and name of the 285typeglob itself, rather than one that has been assigned to it. So, after 286C<*foo=*Foo::bar>, C<*foo> will become "*Foo::bar" when used as a string, 287but C<*foo{PACKAGE}> and C<*foo{NAME}> will continue to produce "main" and 288"foo", respectively. 289 290C<*foo{IO}> is an alternative to the C<*HANDLE> mechanism given in 291L<perldata/"Typeglobs and Filehandles"> for passing filehandles 292into or out of subroutines, or storing into larger data structures. 293Its disadvantage is that it won't create a new filehandle for you. 294Its advantage is that you have less risk of clobbering more than 295you want to with a typeglob assignment. (It still conflates file 296and directory handles, though.) However, if you assign the incoming 297value to a scalar instead of a typeglob as we do in the examples 298below, there's no risk of that happening. 299 300 splutter(*STDOUT); # pass the whole glob 301 splutter(*STDOUT{IO}); # pass both file and dir handles 302 303 sub splutter { 304 my $fh = shift; 305 print $fh "her um well a hmmm\n"; 306 } 307 308 $rec = get_rec(*STDIN); # pass the whole glob 309 $rec = get_rec(*STDIN{IO}); # pass both file and dir handles 310 311 sub get_rec { 312 my $fh = shift; 313 return scalar <$fh>; 314 } 315 316=back 317 318=head2 Using References 319X<reference, use> X<dereferencing> X<dereference> 320 321That's it for creating references. By now you're probably dying to 322know how to use references to get back to your long-lost data. There 323are several basic methods. 324 325=over 4 326 327=item 1. 328 329Anywhere you'd put an identifier (or chain of identifiers) as part 330of a variable or subroutine name, you can replace the identifier with 331a simple scalar variable containing a reference of the correct type: 332 333 $bar = $$scalarref; 334 push(@$arrayref, $filename); 335 $$arrayref[0] = "January"; 336 $$hashref{"KEY"} = "VALUE"; 337 &$coderef(1,2,3); 338 print $globref "output\n"; 339 340It's important to understand that we are specifically I<not> dereferencing 341C<$arrayref[0]> or C<$hashref{"KEY"}> there. The dereference of the 342scalar variable happens I<before> it does any key lookups. Anything more 343complicated than a simple scalar variable must use methods 2 or 3 below. 344However, a "simple scalar" includes an identifier that itself uses method 3451 recursively. Therefore, the following prints "howdy". 346 347 $refrefref = \\\"howdy"; 348 print $$$$refrefref; 349 350=item 2. 351 352Anywhere you'd put an identifier (or chain of identifiers) as part of a 353variable or subroutine name, you can replace the identifier with a 354BLOCK returning a reference of the correct type. In other words, the 355previous examples could be written like this: 356 357 $bar = ${$scalarref}; 358 push(@{$arrayref}, $filename); 359 ${$arrayref}[0] = "January"; 360 ${$hashref}{"KEY"} = "VALUE"; 361 &{$coderef}(1,2,3); 362 $globref->print("output\n"); # iff IO::Handle is loaded 363 364Admittedly, it's a little silly to use the curlies in this case, but 365the BLOCK can contain any arbitrary expression, in particular, 366subscripted expressions: 367 368 &{ $dispatch{$index} }(1,2,3); # call correct routine 369 370Because of being able to omit the curlies for the simple case of C<$$x>, 371people often make the mistake of viewing the dereferencing symbols as 372proper operators, and wonder about their precedence. If they were, 373though, you could use parentheses instead of braces. That's not the case. 374Consider the difference below; case 0 is a short-hand version of case 1, 375I<not> case 2: 376 377 $$hashref{"KEY"} = "VALUE"; # CASE 0 378 ${$hashref}{"KEY"} = "VALUE"; # CASE 1 379 ${$hashref{"KEY"}} = "VALUE"; # CASE 2 380 ${$hashref->{"KEY"}} = "VALUE"; # CASE 3 381 382Case 2 is also deceptive in that you're accessing a variable 383called %hashref, not dereferencing through $hashref to the hash 384it's presumably referencing. That would be case 3. 385 386=item 3. 387 388Subroutine calls and lookups of individual array elements arise often 389enough that it gets cumbersome to use method 2. As a form of 390syntactic sugar, the examples for method 2 may be written: 391 392 $arrayref->[0] = "January"; # Array element 393 $hashref->{"KEY"} = "VALUE"; # Hash element 394 $coderef->(1,2,3); # Subroutine call 395 396The left side of the arrow can be any expression returning a reference, 397including a previous dereference. Note that C<$array[$x]> is I<not> the 398same thing as C<< $array->[$x] >> here: 399 400 $array[$x]->{"foo"}->[0] = "January"; 401 402This is one of the cases we mentioned earlier in which references could 403spring into existence when in an lvalue context. Before this 404statement, C<$array[$x]> may have been undefined. If so, it's 405automatically defined with a hash reference so that we can look up 406C<{"foo"}> in it. Likewise C<< $array[$x]->{"foo"} >> will automatically get 407defined with an array reference so that we can look up C<[0]> in it. 408This process is called I<autovivification>. 409 410One more thing here. The arrow is optional I<between> brackets 411subscripts, so you can shrink the above down to 412 413 $array[$x]{"foo"}[0] = "January"; 414 415Which, in the degenerate case of using only ordinary arrays, gives you 416multidimensional arrays just like C's: 417 418 $score[$x][$y][$z] += 42; 419 420Well, okay, not entirely like C's arrays, actually. C doesn't know how 421to grow its arrays on demand. Perl does. 422 423=item 4. 424 425If a reference happens to be a reference to an object, then there are 426probably methods to access the things referred to, and you should probably 427stick to those methods unless you're in the class package that defines the 428object's methods. In other words, be nice, and don't violate the object's 429encapsulation without a very good reason. Perl does not enforce 430encapsulation. We are not totalitarians here. We do expect some basic 431civility though. 432 433=back 434 435Using a string or number as a reference produces a symbolic reference, 436as explained above. Using a reference as a number produces an 437integer representing its storage location in memory. The only 438useful thing to be done with this is to compare two references 439numerically to see whether they refer to the same location. 440X<reference, numeric context> 441 442 if ($ref1 == $ref2) { # cheap numeric compare of references 443 print "refs 1 and 2 refer to the same thing\n"; 444 } 445 446Using a reference as a string produces both its referent's type, 447including any package blessing as described in L<perlobj>, as well 448as the numeric address expressed in hex. The ref() operator returns 449just the type of thing the reference is pointing to, without the 450address. See L<perlfunc/ref> for details and examples of its use. 451X<reference, string context> 452 453The bless() operator may be used to associate the object a reference 454points to with a package functioning as an object class. See L<perlobj>. 455 456A typeglob may be dereferenced the same way a reference can, because 457the dereference syntax always indicates the type of reference desired. 458So C<${*foo}> and C<${\$foo}> both indicate the same scalar variable. 459 460Here's a trick for interpolating a subroutine call into a string: 461 462 print "My sub returned @{[mysub(1,2,3)]} that time.\n"; 463 464The way it works is that when the C<@{...}> is seen in the double-quoted 465string, it's evaluated as a block. The block creates a reference to an 466anonymous array containing the results of the call to C<mysub(1,2,3)>. So 467the whole block returns a reference to an array, which is then 468dereferenced by C<@{...}> and stuck into the double-quoted string. This 469chicanery is also useful for arbitrary expressions: 470 471 print "That yields @{[$n + 5]} widgets\n"; 472 473Similarly, an expression that returns a reference to a scalar can be 474dereferenced via C<${...}>. Thus, the above expression may be written 475as: 476 477 print "That yields ${\($n + 5)} widgets\n"; 478 479=head2 Circular References 480X<circular reference> X<reference, circular> 481 482It is possible to create a "circular reference" in Perl, which can lead 483to memory leaks. A circular reference occurs when two references 484contain a reference to each other, like this: 485 486 my $foo = {}; 487 my $bar = { foo => $foo }; 488 $foo->{bar} = $bar; 489 490You can also create a circular reference with a single variable: 491 492 my $foo; 493 $foo = \$foo; 494 495In this case, the reference count for the variables will never reach 0, 496and the references will never be garbage-collected. This can lead to 497memory leaks. 498 499Because objects in Perl are implemented as references, it's possible to 500have circular references with objects as well. Imagine a TreeNode class 501where each node references its parent and child nodes. Any node with a 502parent will be part of a circular reference. 503 504You can break circular references by creating a "weak reference". A 505weak reference does not increment the reference count for a variable, 506which means that the object can go out of scope and be destroyed. You 507can weaken a reference with the C<weaken> function exported by the 508L<Scalar::Util> module. 509 510Here's how we can make the first example safer: 511 512 use Scalar::Util 'weaken'; 513 514 my $foo = {}; 515 my $bar = { foo => $foo }; 516 $foo->{bar} = $bar; 517 518 weaken $foo->{bar}; 519 520The reference from C<$foo> to C<$bar> has been weakened. When the 521C<$bar> variable goes out of scope, it will be garbage-collected. The 522next time you look at the value of the C<< $foo->{bar} >> key, it will 523be C<undef>. 524 525This action at a distance can be confusing, so you should be careful 526with your use of weaken. You should weaken the reference in the 527variable that will go out of scope I<first>. That way, the longer-lived 528variable will contain the expected reference until it goes out of 529scope. 530 531=head2 Symbolic references 532X<reference, symbolic> X<reference, soft> 533X<symbolic reference> X<soft reference> 534 535We said that references spring into existence as necessary if they are 536undefined, but we didn't say what happens if a value used as a 537reference is already defined, but I<isn't> a hard reference. If you 538use it as a reference, it'll be treated as a symbolic 539reference. That is, the value of the scalar is taken to be the I<name> 540of a variable, rather than a direct link to a (possibly) anonymous 541value. 542 543People frequently expect it to work like this. So it does. 544 545 $name = "foo"; 546 $$name = 1; # Sets $foo 547 ${$name} = 2; # Sets $foo 548 ${$name x 2} = 3; # Sets $foofoo 549 $name->[0] = 4; # Sets $foo[0] 550 @$name = (); # Clears @foo 551 &$name(); # Calls &foo() 552 $pack = "THAT"; 553 ${"${pack}::$name"} = 5; # Sets $THAT::foo without eval 554 555This is powerful, and slightly dangerous, in that it's possible 556to intend (with the utmost sincerity) to use a hard reference, and 557accidentally use a symbolic reference instead. To protect against 558that, you can say 559 560 use strict 'refs'; 561 562and then only hard references will be allowed for the rest of the enclosing 563block. An inner block may countermand that with 564 565 no strict 'refs'; 566 567Only package variables (globals, even if localized) are visible to 568symbolic references. Lexical variables (declared with my()) aren't in 569a symbol table, and thus are invisible to this mechanism. For example: 570 571 local $value = 10; 572 $ref = "value"; 573 { 574 my $value = 20; 575 print $$ref; 576 } 577 578This will still print 10, not 20. Remember that local() affects package 579variables, which are all "global" to the package. 580 581=head2 Not-so-symbolic references 582 583Brackets around a symbolic reference can simply 584serve to isolate an identifier or variable name from the rest of an 585expression, just as they always have within a string. For example, 586 587 $push = "pop on "; 588 print "${push}over"; 589 590has always meant to print "pop on over", even though push is 591a reserved word. This is generalized to work the same 592without the enclosing double quotes, so that 593 594 print ${push} . "over"; 595 596and even 597 598 print ${ push } . "over"; 599 600will have the same effect. This 601construct is I<not> considered to be a symbolic reference when you're 602using strict refs: 603 604 use strict 'refs'; 605 ${ bareword }; # Okay, means $bareword. 606 ${ "bareword" }; # Error, symbolic reference. 607 608Similarly, because of all the subscripting that is done using single words, 609the same rule applies to any bareword that is used for subscripting a hash. 610So now, instead of writing 611 612 $array{ "aaa" }{ "bbb" }{ "ccc" } 613 614you can write just 615 616 $array{ aaa }{ bbb }{ ccc } 617 618and not worry about whether the subscripts are reserved words. In the 619rare event that you do wish to do something like 620 621 $array{ shift } 622 623you can force interpretation as a reserved word by adding anything that 624makes it more than a bareword: 625 626 $array{ shift() } 627 $array{ +shift } 628 $array{ shift @_ } 629 630The C<use warnings> pragma or the B<-w> switch will warn you if it 631interprets a reserved word as a string. 632But it will no longer warn you about using lowercase words, because the 633string is effectively quoted. 634 635=head2 Pseudo-hashes: Using an array as a hash 636X<pseudo-hash> X<pseudo hash> X<pseudohash> 637 638Pseudo-hashes have been removed from Perl. The 'fields' pragma 639remains available. 640 641=head2 Function Templates 642X<scope, lexical> X<closure> X<lexical> X<lexical scope> 643X<subroutine, nested> X<sub, nested> X<subroutine, local> X<sub, local> 644 645As explained above, an anonymous function with access to the lexical 646variables visible when that function was compiled, creates a closure. It 647retains access to those variables even though it doesn't get run until 648later, such as in a signal handler or a Tk callback. 649 650Using a closure as a function template allows us to generate many functions 651that act similarly. Suppose you wanted functions named after the colors 652that generated HTML font changes for the various colors: 653 654 print "Be ", red("careful"), "with that ", green("light"); 655 656The red() and green() functions would be similar. To create these, 657we'll assign a closure to a typeglob of the name of the function we're 658trying to build. 659 660 @colors = qw(red blue green yellow orange purple violet); 661 for my $name (@colors) { 662 no strict 'refs'; # allow symbol table manipulation 663 *$name = *{uc $name} = sub { "<FONT COLOR='$name'>@_</FONT>" }; 664 } 665 666Now all those different functions appear to exist independently. You can 667call red(), RED(), blue(), BLUE(), green(), etc. This technique saves on 668both compile time and memory use, and is less error-prone as well, since 669syntax checks happen at compile time. It's critical that any variables in 670the anonymous subroutine be lexicals in order to create a proper closure. 671That's the reasons for the C<my> on the loop iteration variable. 672 673This is one of the only places where giving a prototype to a closure makes 674much sense. If you wanted to impose scalar context on the arguments of 675these functions (probably not a wise idea for this particular example), 676you could have written it this way instead: 677 678 *$name = sub ($) { "<FONT COLOR='$name'>$_[0]</FONT>" }; 679 680However, since prototype checking happens at compile time, the assignment 681above happens too late to be of much use. You could address this by 682putting the whole loop of assignments within a BEGIN block, forcing it 683to occur during compilation. 684 685Access to lexicals that change over time--like those in the C<for> loop 686above, basically aliases to elements from the surrounding lexical scopes-- 687only works with anonymous subs, not with named subroutines. Generally 688said, named subroutines do not nest properly and should only be declared 689in the main package scope. 690 691This is because named subroutines are created at compile time so their 692lexical variables get assigned to the parent lexicals from the first 693execution of the parent block. If a parent scope is entered a second 694time, its lexicals are created again, while the nested subs still 695reference the old ones. 696 697Anonymous subroutines get to capture each time you execute the C<sub> 698operator, as they are created on the fly. If you are accustomed to using 699nested subroutines in other programming languages with their own private 700variables, you'll have to work at it a bit in Perl. The intuitive coding 701of this type of thing incurs mysterious warnings about "will not stay 702shared" due to the reasons explained above. 703For example, this won't work: 704 705 sub outer { 706 my $x = $_[0] + 35; 707 sub inner { return $x * 19 } # WRONG 708 return $x + inner(); 709 } 710 711A work-around is the following: 712 713 sub outer { 714 my $x = $_[0] + 35; 715 local *inner = sub { return $x * 19 }; 716 return $x + inner(); 717 } 718 719Now inner() can only be called from within outer(), because of the 720temporary assignments of the anonymous subroutine. But when it does, 721it has normal access to the lexical variable $x from the scope of 722outer() at the time outer is invoked. 723 724This has the interesting effect of creating a function local to another 725function, something not normally supported in Perl. 726 727=head1 WARNING 728X<reference, string context> X<reference, use as hash key> 729 730You may not (usefully) use a reference as the key to a hash. It will be 731converted into a string: 732 733 $x{ \$a } = $a; 734 735If you try to dereference the key, it won't do a hard dereference, and 736you won't accomplish what you're attempting. You might want to do something 737more like 738 739 $r = \@a; 740 $x{ $r } = $r; 741 742And then at least you can use the values(), which will be 743real refs, instead of the keys(), which won't. 744 745The standard Tie::RefHash module provides a convenient workaround to this. 746 747=head1 Postfix Dereference Syntax 748 749Beginning in v5.20.0, a postfix syntax for using references is 750available. It behaves as described in L</Using References>, but instead 751of a prefixed sigil, a postfixed sigil-and-star is used. 752 753For example: 754 755 $r = \@a; 756 @b = $r->@*; # equivalent to @$r or @{ $r } 757 758 $r = [ 1, [ 2, 3 ], 4 ]; 759 $r->[1]->@*; # equivalent to @{ $r->[1] } 760 761This syntax must be enabled with C<use feature 'postderef'>. It is 762experimental, and will warn by default unless C<no warnings 763'experimental::postderef'> is in effect. 764 765Postfix dereference should work in all circumstances where block 766(circumfix) dereference worked, and should be entirely equivalent. This 767syntax allows dereferencing to be written and read entirely 768left-to-right. The following equivalencies are defined: 769 770 $sref->$*; # same as ${ $sref } 771 $aref->@*; # same as @{ $aref } 772 $aref->$#*; # same as $#{ $aref } 773 $href->%*; # same as %{ $href } 774 $cref->&*; # same as &{ $cref } 775 $gref->**; # same as *{ $gref } 776 777Note especially that C<< $cref->&* >> is I<not> equivalent to C<< 778$cref->() >>, and can serve different purposes. 779 780Glob elements can be extracted through the postfix dereferencing feature: 781 782 $gref->*{SCALAR}; # same as *{ $gref }{SCALAR} 783 784Postfix array and scalar dereferencing I<can> be used in interpolating 785strings (double quotes or the C<qq> operator), but only if the 786additional C<postderef_qq> feature is enabled. 787 788=head2 Postfix Reference Slicing 789 790Value slices of arrays and hashes may also be taken with postfix 791dereferencing notation, with the following equivalencies: 792 793 $aref->@[ ... ]; # same as @$aref[ ... ] 794 $href->@{ ... }; # same as @$href{ ... } 795 796Postfix key/value pair slicing, added in 5.20.0 and documented in 797L<the KeyE<sol>Value Hash Slices section of perldata|perldata/"Key/Value Hash 798Slices">, also behaves as expected: 799 800 $aref->%[ ... ]; # same as %$aref[ ... ] 801 $href->%{ ... }; # same as %$href{ ... } 802 803As with postfix array, postfix value slice dereferencing I<can> be used 804in interpolating strings (double quotes or the C<qq> operator), but only 805if the additional C<postderef_qq> L<feature> is enabled. 806 807=head1 SEE ALSO 808 809Besides the obvious documents, source code can be instructive. 810Some pathological examples of the use of references can be found 811in the F<t/op/ref.t> regression test in the Perl source directory. 812 813See also L<perldsc> and L<perllol> for how to use references to create 814complex data structures, and L<perlootut> and L<perlobj> 815for how to use them to create objects. 816