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