This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add valgrind testing target.
[perl5.git] / pod / perldata.pod
1 =head1 NAME
2
3 perldata - Perl data types
4
5 =head1 DESCRIPTION
6
7 =head2 Variable names
8
9 Perl has three built-in data types: scalars, arrays of scalars, and
10 associative arrays of scalars, known as "hashes".  A scalar is a 
11 single string (of any size, limited only by the available memory),
12 number, or a reference to something (which will be discussed
13 in L<perlref>).  Normal arrays are ordered lists of scalars indexed
14 by number, starting with 0.  Hashes are unordered collections of scalar 
15 values indexed by their associated string key.
16
17 Values are usually referred to by name, or through a named reference.
18 The first character of the name tells you to what sort of data
19 structure it refers.  The rest of the name tells you the particular
20 value to which it refers.  Usually this name is a single I<identifier>,
21 that is, a string beginning with a letter or underscore, and
22 containing letters, underscores, and digits.  In some cases, it may
23 be a chain of identifiers, separated by C<::> (or by the slightly
24 archaic C<'>); all but the last are interpreted as names of packages,
25 to locate the namespace in which to look up the final identifier
26 (see L<perlmod/Packages> for details).  It's possible to substitute
27 for a simple identifier, an expression that produces a reference
28 to the value at runtime.   This is described in more detail below
29 and in L<perlref>.
30
31 Perl also has its own built-in variables whose names don't follow
32 these rules.  They have strange names so they don't accidentally
33 collide with one of your normal variables.  Strings that match
34 parenthesized parts of a regular expression are saved under names
35 containing only digits after the C<$> (see L<perlop> and L<perlre>).
36 In addition, several special variables that provide windows into
37 the inner working of Perl have names containing punctuation characters
38 and control characters.  These are documented in L<perlvar>.
39
40 Scalar values are always named with '$', even when referring to a
41 scalar that is part of an array or a hash.  The '$' symbol works
42 semantically like the English word "the" in that it indicates a
43 single value is expected.
44
45     $days               # the simple scalar value "days"
46     $days[28]           # the 29th element of array @days
47     $days{'Feb'}        # the 'Feb' value from hash %days
48     $#days              # the last index of array @days
49
50 Entire arrays (and slices of arrays and hashes) are denoted by '@',
51 which works much like the word "these" or "those" does in English,
52 in that it indicates multiple values are expected.
53
54     @days               # ($days[0], $days[1],... $days[n])
55     @days[3,4,5]        # same as ($days[3],$days[4],$days[5])
56     @days{'a','c'}      # same as ($days{'a'},$days{'c'})
57
58 Entire hashes are denoted by '%':
59
60     %days               # (key1, val1, key2, val2 ...)
61
62 In addition, subroutines are named with an initial '&', though this
63 is optional when unambiguous, just as the word "do" is often redundant
64 in English.  Symbol table entries can be named with an initial '*',
65 but you don't really care about that yet (if ever :-).
66
67 Every variable type has its own namespace, as do several
68 non-variable identifiers.  This means that you can, without fear
69 of conflict, use the same name for a scalar variable, an array, or
70 a hash--or, for that matter, for a filehandle, a directory handle, a
71 subroutine name, a format name, or a label.  This means that $foo
72 and @foo are two different variables.  It also means that C<$foo[1]>
73 is a part of @foo, not a part of $foo.  This may seem a bit weird,
74 but that's okay, because it is weird.
75
76 Because variable references always start with '$', '@', or '%', the
77 "reserved" words aren't in fact reserved with respect to variable
78 names.  They I<are> reserved with respect to labels and filehandles,
79 however, which don't have an initial special character.  You can't
80 have a filehandle named "log", for instance.  Hint: you could say
81 C<open(LOG,'logfile')> rather than C<open(log,'logfile')>.  Using
82 uppercase filehandles also improves readability and protects you
83 from conflict with future reserved words.  Case I<is> significant--"FOO",
84 "Foo", and "foo" are all different names.  Names that start with a
85 letter or underscore may also contain digits and underscores.
86
87 It is possible to replace such an alphanumeric name with an expression
88 that returns a reference to the appropriate type.  For a description
89 of this, see L<perlref>.
90
91 Names that start with a digit may contain only more digits.  Names
92 that do not start with a letter, underscore, digit or a caret (i.e.
93 a control character) are limited to one character, e.g.,  C<$%> or
94 C<$$>.  (Most of these one character names have a predefined
95 significance to Perl.  For instance, C<$$> is the current process
96 id.)
97
98 =head2 Context
99
100 The interpretation of operations and values in Perl sometimes depends
101 on the requirements of the context around the operation or value.
102 There are two major contexts: list and scalar.  Certain operations
103 return list values in contexts wanting a list, and scalar values
104 otherwise.  If this is true of an operation it will be mentioned in
105 the documentation for that operation.  In other words, Perl overloads
106 certain operations based on whether the expected return value is
107 singular or plural.  Some words in English work this way, like "fish"
108 and "sheep".
109
110 In a reciprocal fashion, an operation provides either a scalar or a
111 list context to each of its arguments.  For example, if you say
112
113     int( <STDIN> )
114
115 the integer operation provides scalar context for the <>
116 operator, which responds by reading one line from STDIN and passing it
117 back to the integer operation, which will then find the integer value
118 of that line and return that.  If, on the other hand, you say
119
120     sort( <STDIN> )
121
122 then the sort operation provides list context for <>, which
123 will proceed to read every line available up to the end of file, and
124 pass that list of lines back to the sort routine, which will then
125 sort those lines and return them as a list to whatever the context
126 of the sort was.
127
128 Assignment is a little bit special in that it uses its left argument
129 to determine the context for the right argument.  Assignment to a
130 scalar evaluates the right-hand side in scalar context, while
131 assignment to an array or hash evaluates the righthand side in list
132 context.  Assignment to a list (or slice, which is just a list
133 anyway) also evaluates the righthand side in list context.
134
135 When you use the C<use warnings> pragma or Perl's B<-w> command-line 
136 option, you may see warnings
137 about useless uses of constants or functions in "void context".
138 Void context just means the value has been discarded, such as a
139 statement containing only C<"fred";> or C<getpwuid(0);>.  It still
140 counts as scalar context for functions that care whether or not
141 they're being called in list context.
142
143 User-defined subroutines may choose to care whether they are being
144 called in a void, scalar, or list context.  Most subroutines do not
145 need to bother, though.  That's because both scalars and lists are
146 automatically interpolated into lists.  See L<perlfunc/wantarray>
147 for how you would dynamically discern your function's calling
148 context.
149
150 =head2 Scalar values
151
152 All data in Perl is a scalar, an array of scalars, or a hash of
153 scalars.  A scalar may contain one single value in any of three
154 different flavors: a number, a string, or a reference.  In general,
155 conversion from one form to another is transparent.  Although a
156 scalar may not directly hold multiple values, it may contain a
157 reference to an array or hash which in turn contains multiple values.
158
159 Scalars aren't necessarily one thing or another.  There's no place
160 to declare a scalar variable to be of type "string", type "number",
161 type "reference", or anything else.  Because of the automatic
162 conversion of scalars, operations that return scalars don't need
163 to care (and in fact, cannot care) whether their caller is looking
164 for a string, a number, or a reference.  Perl is a contextually
165 polymorphic language whose scalars can be strings, numbers, or
166 references (which includes objects).  Although strings and numbers
167 are considered pretty much the same thing for nearly all purposes,
168 references are strongly-typed, uncastable pointers with builtin
169 reference-counting and destructor invocation.
170
171 A scalar value is interpreted as TRUE in the Boolean sense if it is not
172 the null string or the number 0 (or its string equivalent, "0").  The
173 Boolean context is just a special kind of scalar context where no 
174 conversion to a string or a number is ever performed.
175
176 There are actually two varieties of null strings (sometimes referred
177 to as "empty" strings), a defined one and an undefined one.  The
178 defined version is just a string of length zero, such as C<"">.
179 The undefined version is the value that indicates that there is
180 no real value for something, such as when there was an error, or
181 at end of file, or when you refer to an uninitialized variable or
182 element of an array or hash.  Although in early versions of Perl,
183 an undefined scalar could become defined when first used in a
184 place expecting a defined value, this no longer happens except for
185 rare cases of autovivification as explained in L<perlref>.  You can
186 use the defined() operator to determine whether a scalar value is
187 defined (this has no meaning on arrays or hashes), and the undef()
188 operator to produce an undefined value.
189
190 To find out whether a given string is a valid non-zero number, it's
191 sometimes enough to test it against both numeric 0 and also lexical
192 "0" (although this will cause noises if warnings are on).  That's 
193 because strings that aren't numbers count as 0, just as they do in B<awk>:
194
195     if ($str == 0 && $str ne "0")  {
196         warn "That doesn't look like a number";
197     }
198
199 That method may be best because otherwise you won't treat IEEE
200 notations like C<NaN> or C<Infinity> properly.  At other times, you
201 might prefer to determine whether string data can be used numerically
202 by calling the POSIX::strtod() function or by inspecting your string
203 with a regular expression (as documented in L<perlre>).
204
205     warn "has nondigits"        if     /\D/;
206     warn "not a natural number" unless /^\d+$/;             # rejects -3
207     warn "not an integer"       unless /^-?\d+$/;           # rejects +3
208     warn "not an integer"       unless /^[+-]?\d+$/;
209     warn "not a decimal number" unless /^-?\d+\.?\d*$/;     # rejects .2
210     warn "not a decimal number" unless /^-?(?:\d+(?:\.\d*)?|\.\d+)$/;
211     warn "not a C float"
212         unless /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/;
213
214 The length of an array is a scalar value.  You may find the length
215 of array @days by evaluating C<$#days>, as in B<csh>.  However, this
216 isn't the length of the array; it's the subscript of the last element,
217 which is a different value since there is ordinarily a 0th element.
218 Assigning to C<$#days> actually changes the length of the array.
219 Shortening an array this way destroys intervening values.  Lengthening
220 an array that was previously shortened does not recover values
221 that were in those elements.  (It used to do so in Perl 4, but we
222 had to break this to make sure destructors were called when expected.)
223
224 You can also gain some minuscule measure of efficiency by pre-extending
225 an array that is going to get big.  You can also extend an array
226 by assigning to an element that is off the end of the array.  You
227 can truncate an array down to nothing by assigning the null list
228 () to it.  The following are equivalent:
229
230     @whatever = ();
231     $#whatever = -1;
232
233 If you evaluate an array in scalar context, it returns the length
234 of the array.  (Note that this is not true of lists, which return
235 the last value, like the C comma operator, nor of built-in functions,
236 which return whatever they feel like returning.)  The following is
237 always true:
238
239     scalar(@whatever) == $#whatever - $[ + 1;
240
241 Version 5 of Perl changed the semantics of C<$[>: files that don't set
242 the value of C<$[> no longer need to worry about whether another
243 file changed its value.  (In other words, use of C<$[> is deprecated.)
244 So in general you can assume that
245
246     scalar(@whatever) == $#whatever + 1;
247
248 Some programmers choose to use an explicit conversion so as to 
249 leave nothing to doubt:
250
251     $element_count = scalar(@whatever);
252
253 If you evaluate a hash in scalar context, it returns false if the
254 hash is empty.  If there are any key/value pairs, it returns true;
255 more precisely, the value returned is a string consisting of the
256 number of used buckets and the number of allocated buckets, separated
257 by a slash.  This is pretty much useful only to find out whether
258 Perl's internal hashing algorithm is performing poorly on your data
259 set.  For example, you stick 10,000 things in a hash, but evaluating
260 %HASH in scalar context reveals C<"1/16">, which means only one out
261 of sixteen buckets has been touched, and presumably contains all
262 10,000 of your items.  This isn't supposed to happen.  If a tied hash
263 is evaluated in scalar context, a fatal error will result, since this
264 bucket usage information is currently not available for tied hashes.
265
266 You can preallocate space for a hash by assigning to the keys() function.
267 This rounds up the allocated buckets to the next power of two:
268
269     keys(%users) = 1000;                # allocate 1024 buckets
270
271 =head2 Scalar value constructors
272
273 Numeric literals are specified in any of the following floating point or
274 integer formats:
275
276     12345
277     12345.67
278     .23E-10             # a very small number
279     3.14_15_92          # a very important number
280     4_294_967_296       # underscore for legibility
281     0xff                # hex
282     0xdead_beef         # more hex   
283     0377                # octal
284     0b011011            # binary
285
286 You are allowed to use underscores (underbars) in numeric literals
287 between digits for legibility.  You could, for example, group binary
288 digits by threes (as for a Unix-style mode argument such as 0b110_100_100)
289 or by fours (to represent nibbles, as in 0b1010_0110) or in other groups.
290
291 String literals are usually delimited by either single or double
292 quotes.  They work much like quotes in the standard Unix shells:
293 double-quoted string literals are subject to backslash and variable
294 substitution; single-quoted strings are not (except for C<\'> and
295 C<\\>).  The usual C-style backslash rules apply for making
296 characters such as newline, tab, etc., as well as some more exotic
297 forms.  See L<perlop/"Quote and Quote-like Operators"> for a list.
298
299 Hexadecimal, octal, or binary, representations in string literals
300 (e.g. '0xff') are not automatically converted to their integer
301 representation.  The hex() and oct() functions make these conversions
302 for you.  See L<perlfunc/hex> and L<perlfunc/oct> for more details.
303
304 You can also embed newlines directly in your strings, i.e., they can end
305 on a different line than they begin.  This is nice, but if you forget
306 your trailing quote, the error will not be reported until Perl finds
307 another line containing the quote character, which may be much further
308 on in the script.  Variable substitution inside strings is limited to
309 scalar variables, arrays, and array or hash slices.  (In other words,
310 names beginning with $ or @, followed by an optional bracketed
311 expression as a subscript.)  The following code segment prints out "The
312 price is $Z<>100."
313
314     $Price = '$100';    # not interpolated
315     print "The price is $Price.\n";     # interpolated
316
317 There is no double interpolation in Perl, so the C<$100> is left as is.
318
319 As in some shells, you can enclose the variable name in braces to
320 disambiguate it from following alphanumerics (and underscores).
321 You must also do
322 this when interpolating a variable into a string to separate the
323 variable name from a following double-colon or an apostrophe, since
324 these would be otherwise treated as a package separator:
325
326     $who = "Larry";
327     print PASSWD "${who}::0:0:Superuser:/:/bin/perl\n";
328     print "We use ${who}speak when ${who}'s here.\n";
329
330 Without the braces, Perl would have looked for a $whospeak, a
331 C<$who::0>, and a C<$who's> variable.  The last two would be the
332 $0 and the $s variables in the (presumably) non-existent package
333 C<who>.
334
335 In fact, an identifier within such curlies is forced to be a string,
336 as is any simple identifier within a hash subscript.  Neither need
337 quoting.  Our earlier example, C<$days{'Feb'}> can be written as
338 C<$days{Feb}> and the quotes will be assumed automatically.  But
339 anything more complicated in the subscript will be interpreted as
340 an expression.
341
342 =head3 Version Strings
343
344 B<Note:> Version Strings (v-strings) have been deprecated.  They will
345 be removed in some future release after Perl 5.8.1.  The marginal
346 benefits of v-strings were greatly outweighed by the potential for
347 Surprise and Confusion.
348
349 A literal of the form C<v1.20.300.4000> is parsed as a string composed
350 of characters with the specified ordinals.  This form, known as
351 v-strings, provides an alternative, more readable way to construct
352 strings, rather than use the somewhat less readable interpolation form
353 C<"\x{1}\x{14}\x{12c}\x{fa0}">.  This is useful for representing
354 Unicode strings, and for comparing version "numbers" using the string
355 comparison operators, C<cmp>, C<gt>, C<lt> etc.  If there are two or
356 more dots in the literal, the leading C<v> may be omitted.
357
358     print v9786;              # prints UTF-8 encoded SMILEY, "\x{263a}"
359     print v102.111.111;       # prints "foo"
360     print 102.111.111;        # same
361
362 Such literals are accepted by both C<require> and C<use> for
363 doing a version check.  The C<$^V> special variable also contains the
364 running Perl interpreter's version in this form.  See L<perlvar/$^V>.
365 Note that using the v-strings for IPv4 addresses is not portable unless
366 you also use the inet_aton()/inet_ntoa() routines of the Socket package.
367
368 Note that since Perl 5.8.1 the single-number v-strings (like C<v65>)
369 are not v-strings before the C<< => >> operator (which is usually used
370 to separate a hash key from a hash value), instead they are interpreted
371 as literal strings ('v65').  They were v-strings from Perl 5.6.0 to
372 Perl 5.8.0, but that caused more confusion and breakage than good.
373 Multi-number v-strings like C<v65.66> and C<65.66.67> continue to
374 be v-strings always.
375
376 =head3 Special Literals
377
378 The special literals __FILE__, __LINE__, and __PACKAGE__
379 represent the current filename, line number, and package name at that
380 point in your program.  They may be used only as separate tokens; they
381 will not be interpolated into strings.  If there is no current package
382 (due to an empty C<package;> directive), __PACKAGE__ is the undefined
383 value.
384
385 The two control characters ^D and ^Z, and the tokens __END__ and __DATA__
386 may be used to indicate the logical end of the script before the actual
387 end of file.  Any following text is ignored.
388
389 Text after __DATA__ but may be read via the filehandle C<PACKNAME::DATA>,
390 where C<PACKNAME> is the package that was current when the __DATA__
391 token was encountered.  The filehandle is left open pointing to the
392 contents after __DATA__.  It is the program's responsibility to
393 C<close DATA> when it is done reading from it.  For compatibility with
394 older scripts written before __DATA__ was introduced, __END__ behaves
395 like __DATA__ in the toplevel script (but not in files loaded with
396 C<require> or C<do>) and leaves the remaining contents of the
397 file accessible via C<main::DATA>.
398
399 See L<SelfLoader> for more description of __DATA__, and
400 an example of its use.  Note that you cannot read from the DATA
401 filehandle in a BEGIN block: the BEGIN block is executed as soon
402 as it is seen (during compilation), at which point the corresponding
403 __DATA__ (or __END__) token has not yet been seen.
404
405 =head3 Barewords
406
407 A word that has no other interpretation in the grammar will
408 be treated as if it were a quoted string.  These are known as
409 "barewords".  As with filehandles and labels, a bareword that consists
410 entirely of lowercase letters risks conflict with future reserved
411 words, and if you use the C<use warnings> pragma or the B<-w> switch, 
412 Perl will warn you about any
413 such words.  Some people may wish to outlaw barewords entirely.  If you
414 say
415
416     use strict 'subs';
417
418 then any bareword that would NOT be interpreted as a subroutine call
419 produces a compile-time error instead.  The restriction lasts to the
420 end of the enclosing block.  An inner block may countermand this
421 by saying C<no strict 'subs'>.
422
423 =head3 Array Joining Delimiter
424
425 Arrays and slices are interpolated into double-quoted strings
426 by joining the elements with the delimiter specified in the C<$">
427 variable (C<$LIST_SEPARATOR> if "use English;" is specified), 
428 space by default.  The following are equivalent:
429
430     $temp = join($", @ARGV);
431     system "echo $temp";
432
433     system "echo @ARGV";
434
435 Within search patterns (which also undergo double-quotish substitution)
436 there is an unfortunate ambiguity:  Is C</$foo[bar]/> to be interpreted as
437 C</${foo}[bar]/> (where C<[bar]> is a character class for the regular
438 expression) or as C</${foo[bar]}/> (where C<[bar]> is the subscript to array
439 @foo)?  If @foo doesn't otherwise exist, then it's obviously a
440 character class.  If @foo exists, Perl takes a good guess about C<[bar]>,
441 and is almost always right.  If it does guess wrong, or if you're just
442 plain paranoid, you can force the correct interpretation with curly
443 braces as above.
444
445 If you're looking for the information on how to use here-documents,
446 which used to be here, that's been moved to
447 L<perlop/Quote and Quote-like Operators>.
448
449 =head2 List value constructors
450
451 List values are denoted by separating individual values by commas
452 (and enclosing the list in parentheses where precedence requires it):
453
454     (LIST)
455
456 In a context not requiring a list value, the value of what appears
457 to be a list literal is simply the value of the final element, as
458 with the C comma operator.  For example,
459
460     @foo = ('cc', '-E', $bar);
461
462 assigns the entire list value to array @foo, but
463
464     $foo = ('cc', '-E', $bar);
465
466 assigns the value of variable $bar to the scalar variable $foo.
467 Note that the value of an actual array in scalar context is the
468 length of the array; the following assigns the value 3 to $foo:
469
470     @foo = ('cc', '-E', $bar);
471     $foo = @foo;                # $foo gets 3
472
473 You may have an optional comma before the closing parenthesis of a
474 list literal, so that you can say:
475
476     @foo = (
477         1,
478         2,
479         3,
480     );
481
482 To use a here-document to assign an array, one line per element,
483 you might use an approach like this:
484
485     @sauces = <<End_Lines =~ m/(\S.*\S)/g;
486         normal tomato
487         spicy tomato
488         green chile
489         pesto
490         white wine
491     End_Lines
492
493 LISTs do automatic interpolation of sublists.  That is, when a LIST is
494 evaluated, each element of the list is evaluated in list context, and
495 the resulting list value is interpolated into LIST just as if each
496 individual element were a member of LIST.  Thus arrays and hashes lose their
497 identity in a LIST--the list
498
499     (@foo,@bar,&SomeSub,%glarch)
500
501 contains all the elements of @foo followed by all the elements of @bar,
502 followed by all the elements returned by the subroutine named SomeSub 
503 called in list context, followed by the key/value pairs of %glarch.
504 To make a list reference that does I<NOT> interpolate, see L<perlref>.
505
506 The null list is represented by ().  Interpolating it in a list
507 has no effect.  Thus ((),(),()) is equivalent to ().  Similarly,
508 interpolating an array with no elements is the same as if no
509 array had been interpolated at that point.
510
511 This interpolation combines with the facts that the opening
512 and closing parentheses are optional (except when necessary for
513 precedence) and lists may end with an optional comma to mean that
514 multiple commas within lists are legal syntax. The list C<1,,3> is a
515 concatenation of two lists, C<1,> and C<3>, the first of which ends
516 with that optional comma.  C<1,,3> is C<(1,),(3)> is C<1,3> (And
517 similarly for C<1,,,3> is C<(1,),(,),3> is C<1,3> and so on.)  Not that
518 we'd advise you to use this obfuscation.
519
520 A list value may also be subscripted like a normal array.  You must
521 put the list in parentheses to avoid ambiguity.  For example:
522
523     # Stat returns list value.
524     $time = (stat($file))[8];
525
526     # SYNTAX ERROR HERE.
527     $time = stat($file)[8];  # OOPS, FORGOT PARENTHESES
528
529     # Find a hex digit.
530     $hexdigit = ('a','b','c','d','e','f')[$digit-10];
531
532     # A "reverse comma operator".
533     return (pop(@foo),pop(@foo))[0];
534
535 Lists may be assigned to only when each element of the list
536 is itself legal to assign to:
537
538     ($a, $b, $c) = (1, 2, 3);
539
540     ($map{'red'}, $map{'blue'}, $map{'green'}) = (0x00f, 0x0f0, 0xf00);
541
542 An exception to this is that you may assign to C<undef> in a list.
543 This is useful for throwing away some of the return values of a
544 function:
545
546     ($dev, $ino, undef, undef, $uid, $gid) = stat($file);
547
548 List assignment in scalar context returns the number of elements
549 produced by the expression on the right side of the assignment:
550
551     $x = (($foo,$bar) = (3,2,1));       # set $x to 3, not 2
552     $x = (($foo,$bar) = f());           # set $x to f()'s return count
553
554 This is handy when you want to do a list assignment in a Boolean
555 context, because most list functions return a null list when finished,
556 which when assigned produces a 0, which is interpreted as FALSE.
557
558 It's also the source of a useful idiom for executing a function or
559 performing an operation in list context and then counting the number of
560 return values, by assigning to an empty list and then using that
561 assignment in scalar context. For example, this code:
562
563     $count = () = $string =~ /\d+/g;
564
565 will place into $count the number of digit groups found in $string.
566 This happens because the pattern match is in list context (since it
567 is being assigned to the empty list), and will therefore return a list
568 of all matching parts of the string. The list assignment in scalar
569 context will translate that into the number of elements (here, the
570 number of times the pattern matched) and assign that to $count. Note
571 that simply using
572
573     $count = $string =~ /\d+/g;
574
575 would not have worked, since a pattern match in scalar context will
576 only return true or false, rather than a count of matches.
577
578 The final element of a list assignment may be an array or a hash:
579
580     ($a, $b, @rest) = split;
581     my($a, $b, %rest) = @_;
582
583 You can actually put an array or hash anywhere in the list, but the first one
584 in the list will soak up all the values, and anything after it will become
585 undefined.  This may be useful in a my() or local().
586
587 A hash can be initialized using a literal list holding pairs of
588 items to be interpreted as a key and a value:
589
590     # same as map assignment above
591     %map = ('red',0x00f,'blue',0x0f0,'green',0xf00);
592
593 While literal lists and named arrays are often interchangeable, that's
594 not the case for hashes.  Just because you can subscript a list value like
595 a normal array does not mean that you can subscript a list value as a
596 hash.  Likewise, hashes included as parts of other lists (including
597 parameters lists and return lists from functions) always flatten out into
598 key/value pairs.  That's why it's good to use references sometimes.
599
600 It is often more readable to use the C<< => >> operator between key/value
601 pairs.  The C<< => >> operator is mostly just a more visually distinctive
602 synonym for a comma, but it also arranges for its left-hand operand to be
603 interpreted as a string -- if it's a bareword that would be a legal simple
604 identifier (C<< => >> doesn't quote compound identifiers, that contain
605 double colons). This makes it nice for initializing hashes:
606
607     %map = (
608                  red   => 0x00f,
609                  blue  => 0x0f0,
610                  green => 0xf00,
611    );
612
613 or for initializing hash references to be used as records:
614
615     $rec = {
616                 witch => 'Mable the Merciless',
617                 cat   => 'Fluffy the Ferocious',
618                 date  => '10/31/1776',
619     };
620
621 or for using call-by-named-parameter to complicated functions:
622
623    $field = $query->radio_group(
624                name      => 'group_name',
625                values    => ['eenie','meenie','minie'],
626                default   => 'meenie',
627                linebreak => 'true',
628                labels    => \%labels
629    );
630
631 Note that just because a hash is initialized in that order doesn't
632 mean that it comes out in that order.  See L<perlfunc/sort> for examples
633 of how to arrange for an output ordering.
634
635 =head2 Subscripts
636
637 An array is subscripted by specifying a dollary sign (C<$>), then the
638 name of the array (without the leading C<@>), then the subscript inside
639 square brackets.  For example:
640
641     @myarray = (5, 50, 500, 5000);
642     print "Element Number 2 is", $myarray[2], "\n";
643
644 The array indices start with 0. A negative subscript retrieves its 
645 value from the end.  In our example, C<$myarray[-1]> would have been 
646 5000, and C<$myarray[-2]> would have been 500.
647
648 Hash subscripts are similar, only instead of square brackets curly brackets
649 are used. For example:
650
651     %scientists = 
652     (
653         "Newton" => "Isaac",
654         "Einstein" => "Albert",
655         "Darwin" => "Charles",
656         "Feynman" => "Richard",
657     );
658
659     print "Darwin's First Name is ", $scientists{"Darwin"}, "\n";
660
661 =head2 Slices
662
663 A common way to access an array or a hash is one scalar element at a
664 time.  You can also subscript a list to get a single element from it.
665
666     $whoami = $ENV{"USER"};             # one element from the hash
667     $parent = $ISA[0];                  # one element from the array
668     $dir    = (getpwnam("daemon"))[7];  # likewise, but with list
669
670 A slice accesses several elements of a list, an array, or a hash
671 simultaneously using a list of subscripts.  It's more convenient
672 than writing out the individual elements as a list of separate
673 scalar values.
674
675     ($him, $her)   = @folks[0,-1];              # array slice
676     @them          = @folks[0 .. 3];            # array slice
677     ($who, $home)  = @ENV{"USER", "HOME"};      # hash slice
678     ($uid, $dir)   = (getpwnam("daemon"))[2,7]; # list slice
679
680 Since you can assign to a list of variables, you can also assign to
681 an array or hash slice.
682
683     @days[3..5]    = qw/Wed Thu Fri/;
684     @colors{'red','blue','green'} 
685                    = (0xff0000, 0x0000ff, 0x00ff00);
686     @folks[0, -1]  = @folks[-1, 0];
687
688 The previous assignments are exactly equivalent to
689
690     ($days[3], $days[4], $days[5]) = qw/Wed Thu Fri/;
691     ($colors{'red'}, $colors{'blue'}, $colors{'green'})
692                    = (0xff0000, 0x0000ff, 0x00ff00);
693     ($folks[0], $folks[-1]) = ($folks[-1], $folks[0]);
694
695 Since changing a slice changes the original array or hash that it's
696 slicing, a C<foreach> construct will alter some--or even all--of the
697 values of the array or hash.
698
699     foreach (@array[ 4 .. 10 ]) { s/peter/paul/ } 
700
701     foreach (@hash{qw[key1 key2]}) {
702         s/^\s+//;           # trim leading whitespace
703         s/\s+$//;           # trim trailing whitespace
704         s/(\w+)/\u\L$1/g;   # "titlecase" words
705     }
706
707 A slice of an empty list is still an empty list.  Thus:
708
709     @a = ()[1,0];           # @a has no elements
710     @b = (@a)[0,1];         # @b has no elements
711     @c = (0,1)[2,3];        # @c has no elements
712
713 But:
714
715     @a = (1)[1,0];          # @a has two elements
716     @b = (1,undef)[1,0,2];  # @b has three elements
717
718 This makes it easy to write loops that terminate when a null list
719 is returned:
720
721     while ( ($home, $user) = (getpwent)[7,0]) {
722         printf "%-8s %s\n", $user, $home;
723     }
724
725 As noted earlier in this document, the scalar sense of list assignment
726 is the number of elements on the right-hand side of the assignment.
727 The null list contains no elements, so when the password file is
728 exhausted, the result is 0, not 2.
729
730 If you're confused about why you use an '@' there on a hash slice
731 instead of a '%', think of it like this.  The type of bracket (square
732 or curly) governs whether it's an array or a hash being looked at.
733 On the other hand, the leading symbol ('$' or '@') on the array or
734 hash indicates whether you are getting back a singular value (a
735 scalar) or a plural one (a list).
736
737 =head2 Typeglobs and Filehandles
738
739 Perl uses an internal type called a I<typeglob> to hold an entire
740 symbol table entry.  The type prefix of a typeglob is a C<*>, because
741 it represents all types.  This used to be the preferred way to
742 pass arrays and hashes by reference into a function, but now that
743 we have real references, this is seldom needed.  
744
745 The main use of typeglobs in modern Perl is create symbol table aliases.
746 This assignment:
747
748     *this = *that;
749
750 makes $this an alias for $that, @this an alias for @that, %this an alias
751 for %that, &this an alias for &that, etc.  Much safer is to use a reference.
752 This:
753
754     local *Here::blue = \$There::green;
755
756 temporarily makes $Here::blue an alias for $There::green, but doesn't
757 make @Here::blue an alias for @There::green, or %Here::blue an alias for
758 %There::green, etc.  See L<perlmod/"Symbol Tables"> for more examples
759 of this.  Strange though this may seem, this is the basis for the whole
760 module import/export system.
761
762 Another use for typeglobs is to pass filehandles into a function or
763 to create new filehandles.  If you need to use a typeglob to save away
764 a filehandle, do it this way:
765
766     $fh = *STDOUT;
767
768 or perhaps as a real reference, like this:
769
770     $fh = \*STDOUT;
771
772 See L<perlsub> for examples of using these as indirect filehandles
773 in functions.
774
775 Typeglobs are also a way to create a local filehandle using the local()
776 operator.  These last until their block is exited, but may be passed back.
777 For example:
778
779     sub newopen {
780         my $path = shift;
781         local  *FH;  # not my!
782         open   (FH, $path)          or  return undef;
783         return *FH;
784     }
785     $fh = newopen('/etc/passwd');
786
787 Now that we have the C<*foo{THING}> notation, typeglobs aren't used as much
788 for filehandle manipulations, although they're still needed to pass brand
789 new file and directory handles into or out of functions. That's because
790 C<*HANDLE{IO}> only works if HANDLE has already been used as a handle.
791 In other words, C<*FH> must be used to create new symbol table entries;
792 C<*foo{THING}> cannot.  When in doubt, use C<*FH>.
793
794 All functions that are capable of creating filehandles (open(),
795 opendir(), pipe(), socketpair(), sysopen(), socket(), and accept())
796 automatically create an anonymous filehandle if the handle passed to
797 them is an uninitialized scalar variable. This allows the constructs
798 such as C<open(my $fh, ...)> and C<open(local $fh,...)> to be used to
799 create filehandles that will conveniently be closed automatically when
800 the scope ends, provided there are no other references to them. This
801 largely eliminates the need for typeglobs when opening filehandles
802 that must be passed around, as in the following example:
803
804     sub myopen {
805         open my $fh, "@_"
806              or die "Can't open '@_': $!";
807         return $fh;
808     }
809
810     {
811         my $f = myopen("</etc/motd");
812         print <$f>;
813         # $f implicitly closed here
814     }
815
816 Note that if an initialized scalar variable is used instead the
817 result is different: C<my $fh='zzz'; open($fh, ...)> is equivalent
818 to C<open( *{'zzz'}, ...)>.
819 C<use strict 'refs'> forbids such practice.
820
821 Another way to create anonymous filehandles is with the Symbol
822 module or with the IO::Handle module and its ilk.  These modules
823 have the advantage of not hiding different types of the same name
824 during the local().  See the bottom of L<perlfunc/open()> for an
825 example.
826
827 =head1 SEE ALSO
828
829 See L<perlvar> for a description of Perl's built-in variables and
830 a discussion of legal variable names.  See L<perlref>, L<perlsub>,
831 and L<perlmod/"Symbol Tables"> for more discussion on typeglobs and
832 the C<*foo{THING}> syntax.