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