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