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