Revert "show -E in error message when called with -E"
[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
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 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 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 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 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 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 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 58
59 @days # ($days[0], $days[1],... $days[n])
d55a8828 60 @days[3,4,5] # same as ($days[3],$days[4],$days[5])
a0d0e21e 61 @days{'a','c'} # same as ($days{'a'},$days{'c'})
62
d55a8828 63Entire hashes are denoted by '%':
d74e8afc 64X<hash>
a0d0e21e 65
66 %days # (key1, val1, key2, val2 ...)
67
d55a8828 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 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 93X<identifier, case sensitivity>
94X<case>
a0d0e21e 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 98of this, see L<perlref>.
99
5f05dabc 100Names that start with a digit may contain only more digits. Names
9539f610 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 106
107=head2 Context
d74e8afc 108X<context> X<scalar context> X<list context>
a0d0e21e 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 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 117singular or plural. Some words in English work this way, like "fish"
118and "sheep".
a0d0e21e 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 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 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 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 145When you use the C<use warnings> pragma or Perl's B<-w> command-line
146option, you may see warnings
d55a8828 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 159
160=head2 Scalar values
d74e8afc 161X<scalar> X<number> X<string> X<reference>
a0d0e21e 162
d55a8828 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 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 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 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 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 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 207
208 if ($str == 0 && $str ne "0") {
209 warn "That doesn't look like a number";
54310121 210 }
4633a7c4 211
d55a8828 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 217
218 warn "has nondigits" if /\D/;
5a964f20 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 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 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 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 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 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 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 262 scalar(@whatever) == $#whatever + 1;
263
d55a8828 264Some programmers choose to use an explicit conversion so as to
265leave nothing to doubt:
4633a7c4 266
267 $element_count = scalar(@whatever);
268
d55a8828 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 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 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 292integer formats:
293
a0d0e21e 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 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 311quotes. They work much like quotes in the standard Unix shells:
312double-quoted string literals are subject to backslash and variable
19799a22 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 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 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 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 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 347disambiguate it from following alphanumerics (and underscores).
348You must also do
d55a8828 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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,
445Perl will warn you about any
a0d0e21e 446such words. Some people may wish to outlaw barewords entirely. If you
447say
448
449 use strict 'subs';
450
451then any bareword that would NOT be interpreted as a subroutine call
452produces a compile-time error instead. The restriction lasts to the
54310121 453end of the enclosing block. An inner block may countermand this
a0d0e21e 454by saying C<no strict 'subs'>.
455
692ef166 456=head3 Array Joining Delimiter
d74e8afc 457X<array, interpolation> X<interpolation, array> X<$">
692ef166 458
d55a8828 459Arrays and slices are interpolated into double-quoted strings
460by joining the elements with the delimiter specified in the C<$">
692ef166 461variable (C<$LIST_SEPARATOR> if "use English;" is specified),
462space by default. The following are equivalent:
a0d0e21e 463
84f709e7 464 $temp = join($", @ARGV);
a0d0e21e 465 system "echo $temp";
466
467 system "echo @ARGV";
468
469Within search patterns (which also undergo double-quotish substitution)
d55a8828 470there is an unfortunate ambiguity: Is C</$foo[bar]/> to be interpreted as
a0d0e21e 471C</${foo}[bar]/> (where C<[bar]> is a character class for the regular
472expression) or as C</${foo[bar]}/> (where C<[bar]> is the subscript to array
473@foo)? If @foo doesn't otherwise exist, then it's obviously a
474character class. If @foo exists, Perl takes a good guess about C<[bar]>,
475and is almost always right. If it does guess wrong, or if you're just
476plain paranoid, you can force the correct interpretation with curly
d55a8828 477braces as above.
a0d0e21e 478
7e3b091d 479If you're looking for the information on how to use here-documents,
210b36aa 480which used to be here, that's been moved to
481L<perlop/Quote and Quote-like Operators>.
be16fac9 482
a0d0e21e 483=head2 List value constructors
d74e8afc 484X<list>
a0d0e21e 485
486List values are denoted by separating individual values by commas
487(and enclosing the list in parentheses where precedence requires it):
488
489 (LIST)
490
d55a8828 491In a context not requiring a list value, the value of what appears
492to be a list literal is simply the value of the final element, as
493with the C comma operator. For example,
a0d0e21e 494
84f709e7 495 @foo = ('cc', '-E', $bar);
a0d0e21e 496
d55a8828 497assigns the entire list value to array @foo, but
a0d0e21e 498
84f709e7 499 $foo = ('cc', '-E', $bar);
a0d0e21e 500
d55a8828 501assigns the value of variable $bar to the scalar variable $foo.
502Note that the value of an actual array in scalar context is the
503length of the array; the following assigns the value 3 to $foo:
a0d0e21e 504
84f709e7 505 @foo = ('cc', '-E', $bar);
7e3b091d 506 $foo = @foo; # $foo gets 3
a0d0e21e 507
54310121 508You may have an optional comma before the closing parenthesis of a
a0d0e21e 509list literal, so that you can say:
510
84f709e7 511 @foo = (
7e3b091d 512 1,
513 2,
514 3,
a0d0e21e 515 );
516
d55a8828 517To use a here-document to assign an array, one line per element,
518you might use an approach like this:
519
84f709e7 520 @sauces = <<End_Lines =~ m/(\S.*\S)/g;
7e3b091d 521 normal tomato
522 spicy tomato
523 green chile
524 pesto
525 white wine
d55a8828 526 End_Lines
527
a0d0e21e 528LISTs do automatic interpolation of sublists. That is, when a LIST is
d55a8828 529evaluated, each element of the list is evaluated in list context, and
a0d0e21e 530the resulting list value is interpolated into LIST just as if each
5a964f20 531individual element were a member of LIST. Thus arrays and hashes lose their
a0d0e21e 532identity in a LIST--the list
533
5a964f20 534 (@foo,@bar,&SomeSub,%glarch)
a0d0e21e 535
536contains all the elements of @foo followed by all the elements of @bar,
5a964f20 537followed by all the elements returned by the subroutine named SomeSub
d55a8828 538called in list context, followed by the key/value pairs of %glarch.
a0d0e21e 539To make a list reference that does I<NOT> interpolate, see L<perlref>.
540
19799a22 541The null list is represented by (). Interpolating it in a list
a0d0e21e 542has no effect. Thus ((),(),()) is equivalent to (). Similarly,
543interpolating an array with no elements is the same as if no
544array had been interpolated at that point.
545
c2689353 546This interpolation combines with the facts that the opening
ab1f959b 547and closing parentheses are optional (except when necessary for
c2689353 548precedence) and lists may end with an optional comma to mean that
549multiple commas within lists are legal syntax. The list C<1,,3> is a
550concatenation of two lists, C<1,> and C<3>, the first of which ends
551with that optional comma. C<1,,3> is C<(1,),(3)> is C<1,3> (And
552similarly for C<1,,,3> is C<(1,),(,),3> is C<1,3> and so on.) Not that
553we'd advise you to use this obfuscation.
554
a0d0e21e 555A list value may also be subscripted like a normal array. You must
54310121 556put the list in parentheses to avoid ambiguity. For example:
a0d0e21e 557
558 # Stat returns list value.
84f709e7 559 $time = (stat($file))[8];
a0d0e21e 560
4633a7c4 561 # SYNTAX ERROR HERE.
84f709e7 562 $time = stat($file)[8]; # OOPS, FORGOT PARENTHESES
4633a7c4 563
a0d0e21e 564 # Find a hex digit.
84f709e7 565 $hexdigit = ('a','b','c','d','e','f')[$digit-10];
a0d0e21e 566
567 # A "reverse comma operator".
568 return (pop(@foo),pop(@foo))[0];
569
d55a8828 570Lists may be assigned to only when each element of the list
571is itself legal to assign to:
a0d0e21e 572
84f709e7 573 ($a, $b, $c) = (1, 2, 3);
a0d0e21e 574
84f709e7 575 ($map{'red'}, $map{'blue'}, $map{'green'}) = (0x00f, 0x0f0, 0xf00);
a0d0e21e 576
d55a8828 577An exception to this is that you may assign to C<undef> in a list.
578This is useful for throwing away some of the return values of a
579function:
580
84f709e7 581 ($dev, $ino, undef, undef, $uid, $gid) = stat($file);
d55a8828 582
583List assignment in scalar context returns the number of elements
4633a7c4 584produced by the expression on the right side of the assignment:
585
7e3b091d 586 $x = (($foo,$bar) = (3,2,1)); # set $x to 3, not 2
587 $x = (($foo,$bar) = f()); # set $x to f()'s return count
4633a7c4 588
d55a8828 589This is handy when you want to do a list assignment in a Boolean
19799a22 590context, because most list functions return a null list when finished,
4633a7c4 591which when assigned produces a 0, which is interpreted as FALSE.
592
ab1f959b 593It's also the source of a useful idiom for executing a function or
594performing an operation in list context and then counting the number of
595return values, by assigning to an empty list and then using that
596assignment in scalar context. For example, this code:
597
84f709e7 598 $count = () = $string =~ /\d+/g;
ab1f959b 599
600will place into $count the number of digit groups found in $string.
601This happens because the pattern match is in list context (since it
602is being assigned to the empty list), and will therefore return a list
603of all matching parts of the string. The list assignment in scalar
604context will translate that into the number of elements (here, the
605number of times the pattern matched) and assign that to $count. Note
606that simply using
607
84f709e7 608 $count = $string =~ /\d+/g;
ab1f959b 609
610would not have worked, since a pattern match in scalar context will
611only return true or false, rather than a count of matches.
612
613The final element of a list assignment may be an array or a hash:
a0d0e21e 614
84f709e7 615 ($a, $b, @rest) = split;
5a964f20 616 my($a, $b, %rest) = @_;
a0d0e21e 617
4633a7c4 618You can actually put an array or hash anywhere in the list, but the first one
d55a8828 619in the list will soak up all the values, and anything after it will become
620undefined. This may be useful in a my() or local().
a0d0e21e 621
d55a8828 622A hash can be initialized using a literal list holding pairs of
623items to be interpreted as a key and a value:
a0d0e21e 624
625 # same as map assignment above
84f709e7 626 %map = ('red',0x00f,'blue',0x0f0,'green',0xf00);
a0d0e21e 627
d55a8828 628While literal lists and named arrays are often interchangeable, that's
4633a7c4 629not the case for hashes. Just because you can subscript a list value like
630a normal array does not mean that you can subscript a list value as a
631hash. Likewise, hashes included as parts of other lists (including
632parameters lists and return lists from functions) always flatten out into
633key/value pairs. That's why it's good to use references sometimes.
a0d0e21e 634
c47ff5f1 635It is often more readable to use the C<< => >> operator between key/value
636pairs. The C<< => >> operator is mostly just a more visually distinctive
b88cefa9 637synonym for a comma, but it also arranges for its left-hand operand to be
695ff5bd 638interpreted as a string -- if it's a bareword that would be a legal simple
639identifier (C<< => >> doesn't quote compound identifiers, that contain
640double colons). This makes it nice for initializing hashes:
a0d0e21e 641
84f709e7 642 %map = (
7e3b091d 643 red => 0x00f,
644 blue => 0x0f0,
645 green => 0xf00,
4633a7c4 646 );
647
648or for initializing hash references to be used as records:
649
84f709e7 650 $rec = {
7e3b091d 651 witch => 'Mable the Merciless',
652 cat => 'Fluffy the Ferocious',
653 date => '10/31/1776',
4633a7c4 654 };
655
656or for using call-by-named-parameter to complicated functions:
657
84f709e7 658 $field = $query->radio_group(
7e3b091d 659 name => 'group_name',
4633a7c4 660 values => ['eenie','meenie','minie'],
661 default => 'meenie',
662 linebreak => 'true',
84f709e7 663 labels => \%labels
4633a7c4 664 );
cb1a09d0 665
666Note that just because a hash is initialized in that order doesn't
667mean that it comes out in that order. See L<perlfunc/sort> for examples
668of how to arrange for an output ordering.
669
692ef166 670=head2 Subscripts
671
fa11829f 672An array is subscripted by specifying a dollar sign (C<$>), then the
692ef166 673name of the array (without the leading C<@>), then the subscript inside
674square brackets. For example:
675
676 @myarray = (5, 50, 500, 5000);
2adc35dd 677 print "The Third Element is", $myarray[2], "\n";
692ef166 678
679The array indices start with 0. A negative subscript retrieves its
680value from the end. In our example, C<$myarray[-1]> would have been
6815000, and C<$myarray[-2]> would have been 500.
682
683Hash subscripts are similar, only instead of square brackets curly brackets
684are used. For example:
685
686 %scientists =
687 (
688 "Newton" => "Isaac",
689 "Einstein" => "Albert",
690 "Darwin" => "Charles",
691 "Feynman" => "Richard",
692 );
693
694 print "Darwin's First Name is ", $scientists{"Darwin"}, "\n";
695
d55a8828 696=head2 Slices
d74e8afc 697X<slice> X<array, slice> X<hash, slice>
d55a8828 698
56d7751a 699A common way to access an array or a hash is one scalar element at a
700time. You can also subscript a list to get a single element from it.
d55a8828 701
7e3b091d 702 $whoami = $ENV{"USER"}; # one element from the hash
703 $parent = $ISA[0]; # one element from the array
704 $dir = (getpwnam("daemon"))[7]; # likewise, but with list
d55a8828 705
706A slice accesses several elements of a list, an array, or a hash
56d7751a 707simultaneously using a list of subscripts. It's more convenient
708than writing out the individual elements as a list of separate
d55a8828 709scalar values.
710
7e3b091d 711 ($him, $her) = @folks[0,-1]; # array slice
712 @them = @folks[0 .. 3]; # array slice
713 ($who, $home) = @ENV{"USER", "HOME"}; # hash slice
714 ($uid, $dir) = (getpwnam("daemon"))[2,7]; # list slice
d55a8828 715
716Since you can assign to a list of variables, you can also assign to
717an array or hash slice.
718
84f709e7 719 @days[3..5] = qw/Wed Thu Fri/;
d55a8828 720 @colors{'red','blue','green'}
7e3b091d 721 = (0xff0000, 0x0000ff, 0x00ff00);
d55a8828 722 @folks[0, -1] = @folks[-1, 0];
723
724The previous assignments are exactly equivalent to
725
84f709e7 726 ($days[3], $days[4], $days[5]) = qw/Wed Thu Fri/;
727 ($colors{'red'}, $colors{'blue'}, $colors{'green'})
7e3b091d 728 = (0xff0000, 0x0000ff, 0x00ff00);
88fd19e3 729 ($folks[0], $folks[-1]) = ($folks[-1], $folks[0]);
d55a8828 730
731Since changing a slice changes the original array or hash that it's
56d7751a 732slicing, a C<foreach> construct will alter some--or even all--of the
733values of the array or hash.
d55a8828 734
735 foreach (@array[ 4 .. 10 ]) { s/peter/paul/ }
736
00cb5da1 737 foreach (@hash{qw[key1 key2]}) {
7e3b091d 738 s/^\s+//; # trim leading whitespace
739 s/\s+$//; # trim trailing whitespace
740 s/(\w+)/\u\L$1/g; # "titlecase" words
d55a8828 741 }
742
08cd8952 743A slice of an empty list is still an empty list. Thus:
744
84f709e7 745 @a = ()[1,0]; # @a has no elements
746 @b = (@a)[0,1]; # @b has no elements
747 @c = (0,1)[2,3]; # @c has no elements
56d7751a 748
749But:
750
84f709e7 751 @a = (1)[1,0]; # @a has two elements
752 @b = (1,undef)[1,0,2]; # @b has three elements
08cd8952 753
19799a22 754This makes it easy to write loops that terminate when a null list
755is returned:
d55a8828 756
84f709e7 757 while ( ($home, $user) = (getpwent)[7,0]) {
7e3b091d 758 printf "%-8s %s\n", $user, $home;
d55a8828 759 }
760
761As noted earlier in this document, the scalar sense of list assignment
762is the number of elements on the right-hand side of the assignment.
19799a22 763The null list contains no elements, so when the password file is
d55a8828 764exhausted, the result is 0, not 2.
765
766If you're confused about why you use an '@' there on a hash slice
767instead of a '%', think of it like this. The type of bracket (square
768or curly) governs whether it's an array or a hash being looked at.
769On the other hand, the leading symbol ('$' or '@') on the array or
770hash indicates whether you are getting back a singular value (a
771scalar) or a plural one (a list).
772
5f05dabc 773=head2 Typeglobs and Filehandles
d74e8afc 774X<typeglob> X<filehandle> X<*>
cb1a09d0 775
776Perl uses an internal type called a I<typeglob> to hold an entire
777symbol table entry. The type prefix of a typeglob is a C<*>, because
54310121 778it represents all types. This used to be the preferred way to
cb1a09d0 779pass arrays and hashes by reference into a function, but now that
5a964f20 780we have real references, this is seldom needed.
781
782The main use of typeglobs in modern Perl is create symbol table aliases.
783This assignment:
784
785 *this = *that;
786
787makes $this an alias for $that, @this an alias for @that, %this an alias
788for %that, &this an alias for &that, etc. Much safer is to use a reference.
789This:
5f05dabc 790
5a964f20 791 local *Here::blue = \$There::green;
792
793temporarily makes $Here::blue an alias for $There::green, but doesn't
794make @Here::blue an alias for @There::green, or %Here::blue an alias for
795%There::green, etc. See L<perlmod/"Symbol Tables"> for more examples
796of this. Strange though this may seem, this is the basis for the whole
84f709e7 797module import/export system.
5a964f20 798
d55a8828 799Another use for typeglobs is to pass filehandles into a function or
5a964f20 800to create new filehandles. If you need to use a typeglob to save away
801a filehandle, do it this way:
5f05dabc 802
84f709e7 803 $fh = *STDOUT;
5f05dabc 804
805or perhaps as a real reference, like this:
806
84f709e7 807 $fh = \*STDOUT;
5f05dabc 808
5a964f20 809See L<perlsub> for examples of using these as indirect filehandles
810in functions.
811
812Typeglobs are also a way to create a local filehandle using the local()
813operator. These last until their block is exited, but may be passed back.
814For example:
5f05dabc 815
816 sub newopen {
7e3b091d 817 my $path = shift;
818 local *FH; # not my!
819 open (FH, $path) or return undef;
820 return *FH;
5f05dabc 821 }
84f709e7 822 $fh = newopen('/etc/passwd');
5f05dabc 823
d55a8828 824Now that we have the C<*foo{THING}> notation, typeglobs aren't used as much
5a964f20 825for filehandle manipulations, although they're still needed to pass brand
826new file and directory handles into or out of functions. That's because
d55a8828 827C<*HANDLE{IO}> only works if HANDLE has already been used as a handle.
828In other words, C<*FH> must be used to create new symbol table entries;
829C<*foo{THING}> cannot. When in doubt, use C<*FH>.
830
36392fcf 831All functions that are capable of creating filehandles (open(),
832opendir(), pipe(), socketpair(), sysopen(), socket(), and accept())
833automatically create an anonymous filehandle if the handle passed to
834them is an uninitialized scalar variable. This allows the constructs
835such as C<open(my $fh, ...)> and C<open(local $fh,...)> to be used to
836create filehandles that will conveniently be closed automatically when
837the scope ends, provided there are no other references to them. This
838largely eliminates the need for typeglobs when opening filehandles
839that must be passed around, as in the following example:
840
841 sub myopen {
84f709e7 842 open my $fh, "@_"
7e3b091d 843 or die "Can't open '@_': $!";
844 return $fh;
36392fcf 845 }
846
847 {
848 my $f = myopen("</etc/motd");
7e3b091d 849 print <$f>;
850 # $f implicitly closed here
36392fcf 851 }
852
b92795fe 853Note that if an initialized scalar variable is used instead the
854result is different: C<my $fh='zzz'; open($fh, ...)> is equivalent
855to C<open( *{'zzz'}, ...)>.
d83fe814 856C<use strict 'refs'> forbids such practice.
857
d55a8828 858Another way to create anonymous filehandles is with the Symbol
859module or with the IO::Handle module and its ilk. These modules
860have the advantage of not hiding different types of the same name
861during the local(). See the bottom of L<perlfunc/open()> for an
862example.
863
864=head1 SEE ALSO
865
866See L<perlvar> for a description of Perl's built-in variables and
867a discussion of legal variable names. See L<perlref>, L<perlsub>,
868and L<perlmod/"Symbol Tables"> for more discussion on typeglobs and
869the C<*foo{THING}> syntax.