This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
remove things added to v5.23.0 delta but meant for v5.23.1
[perl5.git] / pod / perldata.pod
... / ...
CommitLineData
1=head1 NAME
2
3perldata - Perl data types
4
5=head1 DESCRIPTION
6
7=head2 Variable names
8X<variable, name> X<variable name> X<data type> X<type>
9
10Perl has three built-in data types: scalars, arrays of scalars, and
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.
17
18Values are usually referred to by name, or through a named reference.
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
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). For a more in-depth discussion
28on identifiers, see L<Identifier parsing>. It's possible to
29substitute for a simple identifier, an expression that produces a reference
30to the value at runtime. This is described in more detail below
31and in L<perlref>.
32X<identifier>
33
34Perl also has its own built-in variables whose names don't follow
35these rules. They have strange names so they don't accidentally
36collide with one of your normal variables. Strings that match
37parenthesized parts of a regular expression are saved under names
38containing only digits after the C<$> (see L<perlop> and L<perlre>).
39In addition, several special variables that provide windows into
40the inner working of Perl have names containing punctuation characters
41and control characters. These are documented in L<perlvar>.
42X<variable, built-in>
43
44Scalar values are always named with '$', even when referring to a
45scalar that is part of an array or a hash. The '$' symbol works
46semantically like the English word "the" in that it indicates a
47single value is expected.
48X<scalar>
49
50 $days # the simple scalar value "days"
51 $days[28] # the 29th element of array @days
52 $days{'Feb'} # the 'Feb' value from hash %days
53 $#days # the last index of array @days
54
55Entire arrays (and slices of arrays and hashes) are denoted by '@',
56which works much as the word "these" or "those" does in English,
57in that it indicates multiple values are expected.
58X<array>
59
60 @days # ($days[0], $days[1],... $days[n])
61 @days[3,4,5] # same as ($days[3],$days[4],$days[5])
62 @days{'a','c'} # same as ($days{'a'},$days{'c'})
63
64Entire hashes are denoted by '%':
65X<hash>
66
67 %days # (key1, val1, key2, val2 ...)
68
69In addition, subroutines are named with an initial '&', though this
70is optional when unambiguous, just as the word "do" is often redundant
71in English. Symbol table entries can be named with an initial '*',
72but you don't really care about that yet (if ever :-).
73
74Every variable type has its own namespace, as do several
75non-variable identifiers. This means that you can, without fear
76of conflict, use the same name for a scalar variable, an array, or
77a hash--or, for that matter, for a filehandle, a directory handle, a
78subroutine name, a format name, or a label. This means that $foo
79and @foo are two different variables. It also means that C<$foo[1]>
80is a part of @foo, not a part of $foo. This may seem a bit weird,
81but that's okay, because it is weird.
82X<namespace>
83
84Because variable references always start with '$', '@', or '%', the
85"reserved" words aren't in fact reserved with respect to variable
86names. They I<are> reserved with respect to labels and filehandles,
87however, which don't have an initial special character. You can't
88have a filehandle named "log", for instance. Hint: you could say
89C<open(LOG,'logfile')> rather than C<open(log,'logfile')>. Using
90uppercase filehandles also improves readability and protects you
91from conflict with future reserved words. Case I<is> significant--"FOO",
92"Foo", and "foo" are all different names. Names that start with a
93letter or underscore may also contain digits and underscores.
94X<identifier, case sensitivity>
95X<case>
96
97It is possible to replace such an alphanumeric name with an expression
98that returns a reference to the appropriate type. For a description
99of this, see L<perlref>.
100
101Names that start with a digit may contain only more digits. Names
102that do not start with a letter, underscore, digit or a caret (i.e.
103a control character) are limited to one character, e.g., C<$%> or
104C<$$>. (Most of these one character names have a predefined
105significance to Perl. For instance, C<$$> is the current process
106id.)
107
108=head2 Identifier parsing
109X<identifiers>
110
111Up until Perl 5.18, the actual rules of what a valid identifier
112was were a bit fuzzy. However, in general, anything defined here should
113work on previous versions of Perl, while the opposite -- edge cases
114that work in previous versions, but aren't defined here -- probably
115won't work on newer versions.
116As an important side note, please note that the following only applies
117to bareword identifiers as found in Perl source code, not identifiers
118introduced through symbolic references, which have much fewer
119restrictions.
120If working under the effect of the C<use utf8;> pragma, the following
121rules apply:
122
123 / (?[ ( \p{Word} & \p{XID_Start} ) + [_] ])
124 (?[ ( \p{Word} & \p{XID_Continue} ) ]) * /x
125
126That is, a "start" character followed by any number of "continue"
127characters. Perl requires every character in an identifier to also
128match C<\w> (this prevents some problematic cases); and Perl
129additionally accepts identfier names beginning with an underscore.
130
131If not under C<use utf8>, the source is treated as ASCII + 128 extra
132controls, and identifiers should match
133
134 / (?aa) (?!\d) \w+ /x
135
136That is, any word character in the ASCII range, as long as the first
137character is not a digit.
138
139There are two package separators in Perl: A double colon (C<::>) and a single
140quote (C<'>). Normal identifiers can start or end with a double colon, and
141can contain several parts delimited by double colons.
142Single quotes have similar rules, but with the exception that they are not
143legal at the end of an identifier: That is, C<$'foo> and C<$foo'bar> are
144legal, but C<$foo'bar'> is not.
145
146Additionally, if the identifier is preceded by a sigil --
147that is, if the identifier is part of a variable name -- it
148may optionally be enclosed in braces.
149
150While you can mix double colons with singles quotes, the quotes must come
151after the colons: C<$::::'foo> and C<$foo::'bar> are legal, but C<$::'::foo>
152and C<$foo'::bar> are not.
153
154Put together, a grammar to match a basic identifier becomes
155
156 /
157 (?(DEFINE)
158 (?<variable>
159 (?&sigil)
160 (?:
161 (?&normal_identifier)
162 | \{ \s* (?&normal_identifier) \s* \}
163 )
164 )
165 (?<normal_identifier>
166 (?: :: )* '?
167 (?&basic_identifier)
168 (?: (?= (?: :: )+ '? | (?: :: )* ' ) (?&normal_identifier) )?
169 (?: :: )*
170 )
171 (?<basic_identifier>
172 # is use utf8 on?
173 (?(?{ (caller(0))[8] & $utf8::hint_bits })
174 (?&Perl_XIDS) (?&Perl_XIDC)*
175 | (?aa) (?!\d) \w+
176 )
177 )
178 (?<sigil> [&*\$\@\%])
179 (?<Perl_XIDS> (?[ ( \p{Word} & \p{XID_Start} ) + [_] ]) )
180 (?<Perl_XIDC> (?[ \p{Word} & \p{XID_Continue} ]) )
181 )
182 /x
183
184Meanwhile, special identifiers don't follow the above rules; For the most
185part, all of the identifiers in this category have a special meaning given
186by Perl. Because they have special parsing rules, these generally can't be
187fully-qualified. They come in four forms:
188
189=over
190
191=item *
192
193A sigil, followed solely by digits matching C<\p{POSIX_Digit}>, like
194C<$0>, C<$1>, or C<$10000>.
195
196=item *
197
198A sigil, followed by either a caret and a single POSIX uppercase letter,
199like C<$^V> or C<$^W>, or a sigil followed by a literal non-space,
200non-C<NUL> control character matching the C<\p{POSIX_Cntrl}> property.
201Due to a historical oddity, if not running under C<use utf8>, the 128
202characters in the C<[0x80-0xff]> range are considered to be controls,
203and may also be used in length-one variables. However, the use of
204non-graphical characters is deprecated as of v5.22, and support for them
205will be removed in a future version of perl. ASCII space characters and
206C<NUL> already aren't allowed, so this means that a single-character
207variable name with that name being any other C0 control C<[0x01-0x1F]>,
208or C<DEL> will generate a deprecated warning. Already, under C<"use
209utf8">, non-ASCII characters must match C<Perl_XIDS>. As of v5.22, when
210not under C<"use utf8"> C1 controls C<[0x80-0x9F]>, NO BREAK SPACE, and
211SOFT HYPHEN (C<SHY>)) generate a deprecated warning.
212
213=item *
214
215Similar to the above, a sigil, followed by bareword text in brackets,
216where the first character is either a caret followed by an uppercase
217letter, like C<${^GLOBAL_PHASE}> or a non-C<NUL>, non-space literal
218control like C<${\7LOBAL_PHASE}>. Like the above, when not under
219C<"use utf8">, the characters in C<[0x80-0xFF]> are considered controls, but as
220of v5.22, the use of any that are non-graphical are deprecated, and as
221of v5.20 the use of any ASCII-range literal control is deprecated.
222Support for these will be removed in a future version of perl.
223
224=item *
225
226A sigil followed by a single character matching the C<\p{POSIX_Punct}>
227property, like C<$!> or C<%+>, except the character C<"{"> doesn't work.
228
229=back
230
231Note that as of Perl 5.20, literal control characters in variable names
232are deprecated; and as of Perl 5.22, any other non-graphic characters
233are also deprecated.
234
235=head2 Context
236X<context> X<scalar context> X<list context>
237
238The interpretation of operations and values in Perl sometimes depends
239on the requirements of the context around the operation or value.
240There are two major contexts: list and scalar. Certain operations
241return list values in contexts wanting a list, and scalar values
242otherwise. If this is true of an operation it will be mentioned in
243the documentation for that operation. In other words, Perl overloads
244certain operations based on whether the expected return value is
245singular or plural. Some words in English work this way, like "fish"
246and "sheep".
247
248In a reciprocal fashion, an operation provides either a scalar or a
249list context to each of its arguments. For example, if you say
250
251 int( <STDIN> )
252
253the integer operation provides scalar context for the <>
254operator, which responds by reading one line from STDIN and passing it
255back to the integer operation, which will then find the integer value
256of that line and return that. If, on the other hand, you say
257
258 sort( <STDIN> )
259
260then the sort operation provides list context for <>, which
261will proceed to read every line available up to the end of file, and
262pass that list of lines back to the sort routine, which will then
263sort those lines and return them as a list to whatever the context
264of the sort was.
265
266Assignment is a little bit special in that it uses its left argument
267to determine the context for the right argument. Assignment to a
268scalar evaluates the right-hand side in scalar context, while
269assignment to an array or hash evaluates the righthand side in list
270context. Assignment to a list (or slice, which is just a list
271anyway) also evaluates the right-hand side in list context.
272
273When you use the C<use warnings> pragma or Perl's B<-w> command-line
274option, you may see warnings
275about useless uses of constants or functions in "void context".
276Void context just means the value has been discarded, such as a
277statement containing only C<"fred";> or C<getpwuid(0);>. It still
278counts as scalar context for functions that care whether or not
279they're being called in list context.
280
281User-defined subroutines may choose to care whether they are being
282called in a void, scalar, or list context. Most subroutines do not
283need to bother, though. That's because both scalars and lists are
284automatically interpolated into lists. See L<perlfunc/wantarray>
285for how you would dynamically discern your function's calling
286context.
287
288=head2 Scalar values
289X<scalar> X<number> X<string> X<reference>
290
291All data in Perl is a scalar, an array of scalars, or a hash of
292scalars. A scalar may contain one single value in any of three
293different flavors: a number, a string, or a reference. In general,
294conversion from one form to another is transparent. Although a
295scalar may not directly hold multiple values, it may contain a
296reference to an array or hash which in turn contains multiple values.
297
298Scalars aren't necessarily one thing or another. There's no place
299to declare a scalar variable to be of type "string", type "number",
300type "reference", or anything else. Because of the automatic
301conversion of scalars, operations that return scalars don't need
302to care (and in fact, cannot care) whether their caller is looking
303for a string, a number, or a reference. Perl is a contextually
304polymorphic language whose scalars can be strings, numbers, or
305references (which includes objects). Although strings and numbers
306are considered pretty much the same thing for nearly all purposes,
307references are strongly-typed, uncastable pointers with builtin
308reference-counting and destructor invocation.
309
310A scalar value is interpreted as FALSE in the Boolean sense
311if it is undefined, the null string or the number 0 (or its
312string equivalent, "0"), and TRUE if it is anything else. The
313Boolean context is just a special kind of scalar context where no
314conversion to a string or a number is ever performed.
315X<boolean> X<bool> X<true> X<false> X<truth>
316
317There are actually two varieties of null strings (sometimes referred
318to as "empty" strings), a defined one and an undefined one. The
319defined version is just a string of length zero, such as C<"">.
320The undefined version is the value that indicates that there is
321no real value for something, such as when there was an error, or
322at end of file, or when you refer to an uninitialized variable or
323element of an array or hash. Although in early versions of Perl,
324an undefined scalar could become defined when first used in a
325place expecting a defined value, this no longer happens except for
326rare cases of autovivification as explained in L<perlref>. You can
327use the defined() operator to determine whether a scalar value is
328defined (this has no meaning on arrays or hashes), and the undef()
329operator to produce an undefined value.
330X<defined> X<undefined> X<undef> X<null> X<string, null>
331
332To find out whether a given string is a valid non-zero number, it's
333sometimes enough to test it against both numeric 0 and also lexical
334"0" (although this will cause noises if warnings are on). That's
335because strings that aren't numbers count as 0, just as they do in B<awk>:
336
337 if ($str == 0 && $str ne "0") {
338 warn "That doesn't look like a number";
339 }
340
341That method may be best because otherwise you won't treat IEEE
342notations like C<NaN> or C<Infinity> properly. At other times, you
343might prefer to determine whether string data can be used numerically
344by calling the POSIX::strtod() function or by inspecting your string
345with a regular expression (as documented in L<perlre>).
346
347 warn "has nondigits" if /\D/;
348 warn "not a natural number" unless /^\d+$/; # rejects -3
349 warn "not an integer" unless /^-?\d+$/; # rejects +3
350 warn "not an integer" unless /^[+-]?\d+$/;
351 warn "not a decimal number" unless /^-?\d+\.?\d*$/; # rejects .2
352 warn "not a decimal number" unless /^-?(?:\d+(?:\.\d*)?|\.\d+)$/;
353 warn "not a C float"
354 unless /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/;
355
356The length of an array is a scalar value. You may find the length
357of array @days by evaluating C<$#days>, as in B<csh>. However, this
358isn't the length of the array; it's the subscript of the last element,
359which is a different value since there is ordinarily a 0th element.
360Assigning to C<$#days> actually changes the length of the array.
361Shortening an array this way destroys intervening values. Lengthening
362an array that was previously shortened does not recover values
363that were in those elements.
364X<$#> X<array, length>
365
366You can also gain some minuscule measure of efficiency by pre-extending
367an array that is going to get big. You can also extend an array
368by assigning to an element that is off the end of the array. You
369can truncate an array down to nothing by assigning the null list
370() to it. The following are equivalent:
371
372 @whatever = ();
373 $#whatever = -1;
374
375If you evaluate an array in scalar context, it returns the length
376of the array. (Note that this is not true of lists, which return
377the last value, like the C comma operator, nor of built-in functions,
378which return whatever they feel like returning.) The following is
379always true:
380X<array, length>
381
382 scalar(@whatever) == $#whatever + 1;
383
384Some programmers choose to use an explicit conversion so as to
385leave nothing to doubt:
386
387 $element_count = scalar(@whatever);
388
389If you evaluate a hash in scalar context, it returns false if the
390hash is empty. If there are any key/value pairs, it returns true;
391more precisely, the value returned is a string consisting of the
392number of used buckets and the number of allocated buckets, separated
393by a slash. This is pretty much useful only to find out whether
394Perl's internal hashing algorithm is performing poorly on your data
395set. For example, you stick 10,000 things in a hash, but evaluating
396%HASH in scalar context reveals C<"1/16">, which means only one out
397of sixteen buckets has been touched, and presumably contains all
39810,000 of your items. This isn't supposed to happen. If a tied hash
399is evaluated in scalar context, the C<SCALAR> method is called (with a
400fallback to C<FIRSTKEY>).
401X<hash, scalar context> X<hash, bucket> X<bucket>
402
403You can preallocate space for a hash by assigning to the keys() function.
404This rounds up the allocated buckets to the next power of two:
405
406 keys(%users) = 1000; # allocate 1024 buckets
407
408=head2 Scalar value constructors
409X<scalar, literal> X<scalar, constant>
410
411Numeric literals are specified in any of the following floating point or
412integer formats:
413
414 12345
415 12345.67
416 .23E-10 # a very small number
417 3.14_15_92 # a very important number
418 4_294_967_296 # underscore for legibility
419 0xff # hex
420 0xdead_beef # more hex
421 0377 # octal (only numbers, begins with 0)
422 0b011011 # binary
423 0x1.999ap-4 # hexadecimal floating point (the 'p' is required)
424
425You are allowed to use underscores (underbars) in numeric literals
426between digits for legibility (but not multiple underscores in a row:
427C<23__500> is not legal; C<23_500> is).
428You could, for example, group binary
429digits by threes (as for a Unix-style mode argument such as 0b110_100_100)
430or by fours (to represent nibbles, as in 0b1010_0110) or in other groups.
431X<number, literal>
432
433String literals are usually delimited by either single or double
434quotes. They work much like quotes in the standard Unix shells:
435double-quoted string literals are subject to backslash and variable
436substitution; single-quoted strings are not (except for C<\'> and
437C<\\>). The usual C-style backslash rules apply for making
438characters such as newline, tab, etc., as well as some more exotic
439forms. See L<perlop/"Quote and Quote-like Operators"> for a list.
440X<string, literal>
441
442Hexadecimal, octal, or binary, representations in string literals
443(e.g. '0xff') are not automatically converted to their integer
444representation. The hex() and oct() functions make these conversions
445for you. See L<perlfunc/hex> and L<perlfunc/oct> for more details.
446
447Hexadecimal floating point can start just like a hexadecimal literal,
448and it can be followed by an optional fractional hexadecimal part,
449but it must be followed by C<p>, an optional sign, and a power of two.
450The format is useful for accurately presenting floating point values,
451avoiding conversions to or from decimal floating point, and therefore
452avoiding possible loss in precision. Notice that while most current
453platforms use the 64-bit IEEE 754 floating point, not all do. Another
454potential source of (low-order) differences are the floating point
455rounding modes, which can differ between CPUs, operating systems,
456and compilers, and which Perl doesn't control.
457
458You can also embed newlines directly in your strings, i.e., they can end
459on a different line than they begin. This is nice, but if you forget
460your trailing quote, the error will not be reported until Perl finds
461another line containing the quote character, which may be much further
462on in the script. Variable substitution inside strings is limited to
463scalar variables, arrays, and array or hash slices. (In other words,
464names beginning with $ or @, followed by an optional bracketed
465expression as a subscript.) The following code segment prints out "The
466price is $Z<>100."
467X<interpolation>
468
469 $Price = '$100'; # not interpolated
470 print "The price is $Price.\n"; # interpolated
471
472There is no double interpolation in Perl, so the C<$100> is left as is.
473
474By default floating point numbers substituted inside strings use the
475dot (".") as the decimal separator. If C<use locale> is in effect,
476and POSIX::setlocale() has been called, the character used for the
477decimal separator is affected by the LC_NUMERIC locale.
478See L<perllocale> and L<POSIX>.
479
480As in some shells, you can enclose the variable name in braces to
481disambiguate it from following alphanumerics (and underscores).
482You must also do
483this when interpolating a variable into a string to separate the
484variable name from a following double-colon or an apostrophe, since
485these would be otherwise treated as a package separator:
486X<interpolation>
487
488 $who = "Larry";
489 print PASSWD "${who}::0:0:Superuser:/:/bin/perl\n";
490 print "We use ${who}speak when ${who}'s here.\n";
491
492Without the braces, Perl would have looked for a $whospeak, a
493C<$who::0>, and a C<$who's> variable. The last two would be the
494$0 and the $s variables in the (presumably) non-existent package
495C<who>.
496
497In fact, a simple identifier within such curlies is forced to be
498a string, and likewise within a hash subscript. Neither need
499quoting. Our earlier example, C<$days{'Feb'}> can be written as
500C<$days{Feb}> and the quotes will be assumed automatically. But
501anything more complicated in the subscript will be interpreted as an
502expression. This means for example that C<$version{2.0}++> is
503equivalent to C<$version{2}++>, not to C<$version{'2.0'}++>.
504
505=head3 Special floating point: infinity (Inf) and not-a-number (NaN)
506
507Floating point values include the special values C<Inf> and C<NaN>,
508for infinity and not-a-number. The infinity can be also negative.
509
510The infinity is the result of certain math operations that overflow
511the floating point range, like 9**9**9. The not-a-number is the
512result when the result is undefined or unrepresentable. Though note
513that you cannot get C<NaN> from some common "undefined" or
514"out-of-range" operations like dividing by zero, or square root of
515a negative number, since Perl generates fatal errors for those.
516
517The infinity and not-a-number have their own special arithmetic rules.
518The general rule is that they are "contagious": C<Inf> plus one is
519C<Inf>, and C<NaN> plus one is C<NaN>. Where things get interesting
520is when you combine infinities and not-a-numbers: C<Inf> minus C<Inf>
521and C<Inf> divided by C<INf> are C<NaN> (while C<Inf> plus C<Inf> is
522C<Inf> and C<Inf> times C<Inf> is C<Inf>). C<NaN> is also curious
523in that it does not equal any number, I<including> itself:
524C<NaN> != C<NaN>.
525
526Perl doesn't understand C<Inf> and C<NaN> as numeric literals, but
527you can have them as strings, and Perl will convert them as needed:
528"Inf" + 1. (You can, however, import them from the POSIX extension;
529C<use POSIX qw(Inf NaN);> and then use them as literals.)
530
531Note that on input (string to number) Perl accepts C<Inf> and C<NaN>
532in many forms. Case is ignored, and the Win32-specific forms like
533C<1.#INF> are understood, but on output the values are normalized to
534C<Inf> and C<NaN>.
535
536=head3 Version Strings
537X<version string> X<vstring> X<v-string>
538
539A literal of the form C<v1.20.300.4000> is parsed as a string composed
540of characters with the specified ordinals. This form, known as
541v-strings, provides an alternative, more readable way to construct
542strings, rather than use the somewhat less readable interpolation form
543C<"\x{1}\x{14}\x{12c}\x{fa0}">. This is useful for representing
544Unicode strings, and for comparing version "numbers" using the string
545comparison operators, C<cmp>, C<gt>, C<lt> etc. If there are two or
546more dots in the literal, the leading C<v> may be omitted.
547
548 print v9786; # prints SMILEY, "\x{263a}"
549 print v102.111.111; # prints "foo"
550 print 102.111.111; # same
551
552Such literals are accepted by both C<require> and C<use> for
553doing a version check. Note that using the v-strings for IPv4
554addresses is not portable unless you also use the
555inet_aton()/inet_ntoa() routines of the Socket package.
556
557Note that since Perl 5.8.1 the single-number v-strings (like C<v65>)
558are not v-strings before the C<< => >> operator (which is usually used
559to separate a hash key from a hash value); instead they are interpreted
560as literal strings ('v65'). They were v-strings from Perl 5.6.0 to
561Perl 5.8.0, but that caused more confusion and breakage than good.
562Multi-number v-strings like C<v65.66> and C<65.66.67> continue to
563be v-strings always.
564
565=head3 Special Literals
566X<special literal> X<__END__> X<__DATA__> X<END> X<DATA>
567X<end> X<data> X<^D> X<^Z>
568
569The special literals __FILE__, __LINE__, and __PACKAGE__
570represent the current filename, line number, and package name at that
571point in your program. __SUB__ gives a reference to the current
572subroutine. They may be used only as separate tokens; they
573will not be interpolated into strings. If there is no current package
574(due to an empty C<package;> directive), __PACKAGE__ is the undefined
575value. (But the empty C<package;> is no longer supported, as of version
5765.10.) Outside of a subroutine, __SUB__ is the undefined value. __SUB__
577is only available in 5.16 or higher, and only with a C<use v5.16> or
578C<use feature "current_sub"> declaration.
579X<__FILE__> X<__LINE__> X<__PACKAGE__> X<__SUB__>
580X<line> X<file> X<package>
581
582The two control characters ^D and ^Z, and the tokens __END__ and __DATA__
583may be used to indicate the logical end of the script before the actual
584end of file. Any following text is ignored.
585
586Text after __DATA__ may be read via the filehandle C<PACKNAME::DATA>,
587where C<PACKNAME> is the package that was current when the __DATA__
588token was encountered. The filehandle is left open pointing to the
589line after __DATA__. The program should C<close DATA> when it is done
590reading from it. (Leaving it open leaks filehandles if the module is
591reloaded for any reason, so it's a safer practice to close it.) For
592compatibility with older scripts written before __DATA__ was
593introduced, __END__ behaves like __DATA__ in the top level script (but
594not in files loaded with C<require> or C<do>) and leaves the remaining
595contents of the file accessible via C<main::DATA>.
596
597See L<SelfLoader> for more description of __DATA__, and
598an example of its use. Note that you cannot read from the DATA
599filehandle in a BEGIN block: the BEGIN block is executed as soon
600as it is seen (during compilation), at which point the corresponding
601__DATA__ (or __END__) token has not yet been seen.
602
603=head3 Barewords
604X<bareword>
605
606A word that has no other interpretation in the grammar will
607be treated as if it were a quoted string. These are known as
608"barewords". As with filehandles and labels, a bareword that consists
609entirely of lowercase letters risks conflict with future reserved
610words, and if you use the C<use warnings> pragma or the B<-w> switch,
611Perl will warn you about any such words. Perl limits barewords (like
612identifiers) to about 250 characters. Future versions of Perl are likely
613to eliminate these arbitrary limitations.
614
615Some people may wish to outlaw barewords entirely. If you
616say
617
618 use strict 'subs';
619
620then any bareword that would NOT be interpreted as a subroutine call
621produces a compile-time error instead. The restriction lasts to the
622end of the enclosing block. An inner block may countermand this
623by saying C<no strict 'subs'>.
624
625=head3 Array Interpolation
626X<array, interpolation> X<interpolation, array> X<$">
627
628Arrays and slices are interpolated into double-quoted strings
629by joining the elements with the delimiter specified in the C<$">
630variable (C<$LIST_SEPARATOR> if "use English;" is specified),
631space by default. The following are equivalent:
632
633 $temp = join($", @ARGV);
634 system "echo $temp";
635
636 system "echo @ARGV";
637
638Within search patterns (which also undergo double-quotish substitution)
639there is an unfortunate ambiguity: Is C</$foo[bar]/> to be interpreted as
640C</${foo}[bar]/> (where C<[bar]> is a character class for the regular
641expression) or as C</${foo[bar]}/> (where C<[bar]> is the subscript to array
642@foo)? If @foo doesn't otherwise exist, then it's obviously a
643character class. If @foo exists, Perl takes a good guess about C<[bar]>,
644and is almost always right. If it does guess wrong, or if you're just
645plain paranoid, you can force the correct interpretation with curly
646braces as above.
647
648If you're looking for the information on how to use here-documents,
649which used to be here, that's been moved to
650L<perlop/Quote and Quote-like Operators>.
651
652=head2 List value constructors
653X<list>
654
655List values are denoted by separating individual values by commas
656(and enclosing the list in parentheses where precedence requires it):
657
658 (LIST)
659
660In a context not requiring a list value, the value of what appears
661to be a list literal is simply the value of the final element, as
662with the C comma operator. For example,
663
664 @foo = ('cc', '-E', $bar);
665
666assigns the entire list value to array @foo, but
667
668 $foo = ('cc', '-E', $bar);
669
670assigns the value of variable $bar to the scalar variable $foo.
671Note that the value of an actual array in scalar context is the
672length of the array; the following assigns the value 3 to $foo:
673
674 @foo = ('cc', '-E', $bar);
675 $foo = @foo; # $foo gets 3
676
677You may have an optional comma before the closing parenthesis of a
678list literal, so that you can say:
679
680 @foo = (
681 1,
682 2,
683 3,
684 );
685
686To use a here-document to assign an array, one line per element,
687you might use an approach like this:
688
689 @sauces = <<End_Lines =~ m/(\S.*\S)/g;
690 normal tomato
691 spicy tomato
692 green chile
693 pesto
694 white wine
695 End_Lines
696
697LISTs do automatic interpolation of sublists. That is, when a LIST is
698evaluated, each element of the list is evaluated in list context, and
699the resulting list value is interpolated into LIST just as if each
700individual element were a member of LIST. Thus arrays and hashes lose their
701identity in a LIST--the list
702
703 (@foo,@bar,&SomeSub,%glarch)
704
705contains all the elements of @foo followed by all the elements of @bar,
706followed by all the elements returned by the subroutine named SomeSub
707called in list context, followed by the key/value pairs of %glarch.
708To make a list reference that does I<NOT> interpolate, see L<perlref>.
709
710The null list is represented by (). Interpolating it in a list
711has no effect. Thus ((),(),()) is equivalent to (). Similarly,
712interpolating an array with no elements is the same as if no
713array had been interpolated at that point.
714
715This interpolation combines with the facts that the opening
716and closing parentheses are optional (except when necessary for
717precedence) and lists may end with an optional comma to mean that
718multiple commas within lists are legal syntax. The list C<1,,3> is a
719concatenation of two lists, C<1,> and C<3>, the first of which ends
720with that optional comma. C<1,,3> is C<(1,),(3)> is C<1,3> (And
721similarly for C<1,,,3> is C<(1,),(,),3> is C<1,3> and so on.) Not that
722we'd advise you to use this obfuscation.
723
724A list value may also be subscripted like a normal array. You must
725put the list in parentheses to avoid ambiguity. For example:
726
727 # Stat returns list value.
728 $time = (stat($file))[8];
729
730 # SYNTAX ERROR HERE.
731 $time = stat($file)[8]; # OOPS, FORGOT PARENTHESES
732
733 # Find a hex digit.
734 $hexdigit = ('a','b','c','d','e','f')[$digit-10];
735
736 # A "reverse comma operator".
737 return (pop(@foo),pop(@foo))[0];
738
739Lists may be assigned to only when each element of the list
740is itself legal to assign to:
741
742 ($a, $b, $c) = (1, 2, 3);
743
744 ($map{'red'}, $map{'blue'}, $map{'green'}) = (0x00f, 0x0f0, 0xf00);
745
746An exception to this is that you may assign to C<undef> in a list.
747This is useful for throwing away some of the return values of a
748function:
749
750 ($dev, $ino, undef, undef, $uid, $gid) = stat($file);
751
752As of Perl 5.22, you can also use C<(undef)x2> instead of C<undef, undef>.
753(You can also do C<($x) x 2>, which is less useful, because it assigns to
754the same variable twice, clobbering the first value assigned.)
755
756List assignment in scalar context returns the number of elements
757produced by the expression on the right side of the assignment:
758
759 $x = (($foo,$bar) = (3,2,1)); # set $x to 3, not 2
760 $x = (($foo,$bar) = f()); # set $x to f()'s return count
761
762This is handy when you want to do a list assignment in a Boolean
763context, because most list functions return a null list when finished,
764which when assigned produces a 0, which is interpreted as FALSE.
765
766It's also the source of a useful idiom for executing a function or
767performing an operation in list context and then counting the number of
768return values, by assigning to an empty list and then using that
769assignment in scalar context. For example, this code:
770
771 $count = () = $string =~ /\d+/g;
772
773will place into $count the number of digit groups found in $string.
774This happens because the pattern match is in list context (since it
775is being assigned to the empty list), and will therefore return a list
776of all matching parts of the string. The list assignment in scalar
777context will translate that into the number of elements (here, the
778number of times the pattern matched) and assign that to $count. Note
779that simply using
780
781 $count = $string =~ /\d+/g;
782
783would not have worked, since a pattern match in scalar context will
784only return true or false, rather than a count of matches.
785
786The final element of a list assignment may be an array or a hash:
787
788 ($a, $b, @rest) = split;
789 my($a, $b, %rest) = @_;
790
791You can actually put an array or hash anywhere in the list, but the first one
792in the list will soak up all the values, and anything after it will become
793undefined. This may be useful in a my() or local().
794
795A hash can be initialized using a literal list holding pairs of
796items to be interpreted as a key and a value:
797
798 # same as map assignment above
799 %map = ('red',0x00f,'blue',0x0f0,'green',0xf00);
800
801While literal lists and named arrays are often interchangeable, that's
802not the case for hashes. Just because you can subscript a list value like
803a normal array does not mean that you can subscript a list value as a
804hash. Likewise, hashes included as parts of other lists (including
805parameters lists and return lists from functions) always flatten out into
806key/value pairs. That's why it's good to use references sometimes.
807
808It is often more readable to use the C<< => >> operator between key/value
809pairs. The C<< => >> operator is mostly just a more visually distinctive
810synonym for a comma, but it also arranges for its left-hand operand to be
811interpreted as a string if it's a bareword that would be a legal simple
812identifier. C<< => >> doesn't quote compound identifiers, that contain
813double colons. This makes it nice for initializing hashes:
814
815 %map = (
816 red => 0x00f,
817 blue => 0x0f0,
818 green => 0xf00,
819 );
820
821or for initializing hash references to be used as records:
822
823 $rec = {
824 witch => 'Mable the Merciless',
825 cat => 'Fluffy the Ferocious',
826 date => '10/31/1776',
827 };
828
829or for using call-by-named-parameter to complicated functions:
830
831 $field = $query->radio_group(
832 name => 'group_name',
833 values => ['eenie','meenie','minie'],
834 default => 'meenie',
835 linebreak => 'true',
836 labels => \%labels
837 );
838
839Note that just because a hash is initialized in that order doesn't
840mean that it comes out in that order. See L<perlfunc/sort> for examples
841of how to arrange for an output ordering.
842
843If a key appears more than once in the initializer list of a hash, the last
844occurrence wins:
845
846 %circle = (
847 center => [5, 10],
848 center => [27, 9],
849 radius => 100,
850 color => [0xDF, 0xFF, 0x00],
851 radius => 54,
852 );
853
854 # same as
855 %circle = (
856 center => [27, 9],
857 color => [0xDF, 0xFF, 0x00],
858 radius => 54,
859 );
860
861This can be used to provide overridable configuration defaults:
862
863 # values in %args take priority over %config_defaults
864 %config = (%config_defaults, %args);
865
866=head2 Subscripts
867
868An array can be accessed one scalar at a
869time by specifying a dollar sign (C<$>), then the
870name of the array (without the leading C<@>), then the subscript inside
871square brackets. For example:
872
873 @myarray = (5, 50, 500, 5000);
874 print "The Third Element is", $myarray[2], "\n";
875
876The array indices start with 0. A negative subscript retrieves its
877value from the end. In our example, C<$myarray[-1]> would have been
8785000, and C<$myarray[-2]> would have been 500.
879
880Hash subscripts are similar, only instead of square brackets curly brackets
881are used. For example:
882
883 %scientists =
884 (
885 "Newton" => "Isaac",
886 "Einstein" => "Albert",
887 "Darwin" => "Charles",
888 "Feynman" => "Richard",
889 );
890
891 print "Darwin's First Name is ", $scientists{"Darwin"}, "\n";
892
893You can also subscript a list to get a single element from it:
894
895 $dir = (getpwnam("daemon"))[7];
896
897=head2 Multi-dimensional array emulation
898
899Multidimensional arrays may be emulated by subscripting a hash with a
900list. The elements of the list are joined with the subscript separator
901(see L<perlvar/$;>).
902
903 $foo{$a,$b,$c}
904
905is equivalent to
906
907 $foo{join($;, $a, $b, $c)}
908
909The default subscript separator is "\034", the same as SUBSEP in B<awk>.
910
911=head2 Slices
912X<slice> X<array, slice> X<hash, slice>
913
914A slice accesses several elements of a list, an array, or a hash
915simultaneously using a list of subscripts. It's more convenient
916than writing out the individual elements as a list of separate
917scalar values.
918
919 ($him, $her) = @folks[0,-1]; # array slice
920 @them = @folks[0 .. 3]; # array slice
921 ($who, $home) = @ENV{"USER", "HOME"}; # hash slice
922 ($uid, $dir) = (getpwnam("daemon"))[2,7]; # list slice
923
924Since you can assign to a list of variables, you can also assign to
925an array or hash slice.
926
927 @days[3..5] = qw/Wed Thu Fri/;
928 @colors{'red','blue','green'}
929 = (0xff0000, 0x0000ff, 0x00ff00);
930 @folks[0, -1] = @folks[-1, 0];
931
932The previous assignments are exactly equivalent to
933
934 ($days[3], $days[4], $days[5]) = qw/Wed Thu Fri/;
935 ($colors{'red'}, $colors{'blue'}, $colors{'green'})
936 = (0xff0000, 0x0000ff, 0x00ff00);
937 ($folks[0], $folks[-1]) = ($folks[-1], $folks[0]);
938
939Since changing a slice changes the original array or hash that it's
940slicing, a C<foreach> construct will alter some--or even all--of the
941values of the array or hash.
942
943 foreach (@array[ 4 .. 10 ]) { s/peter/paul/ }
944
945 foreach (@hash{qw[key1 key2]}) {
946 s/^\s+//; # trim leading whitespace
947 s/\s+$//; # trim trailing whitespace
948 s/(\w+)/\u\L$1/g; # "titlecase" words
949 }
950
951As a special exception, when you slice a list (but not an array or a hash),
952if the list evaluates to empty, then taking a slice of that empty list will
953always yield the empty list in turn. Thus:
954
955 @a = ()[0,1]; # @a has no elements
956 @b = (@a)[0,1]; # @b has no elements
957 @c = (sub{}->())[0,1]; # @c has no elements
958 @d = ('a','b')[0,1]; # @d has two elements
959 @e = (@d)[0,1,8,9]; # @e has four elements
960 @f = (@d)[8,9]; # @f has two elements
961
962This makes it easy to write loops that terminate when a null list
963is returned:
964
965 while ( ($home, $user) = (getpwent)[7,0] ) {
966 printf "%-8s %s\n", $user, $home;
967 }
968
969As noted earlier in this document, the scalar sense of list assignment
970is the number of elements on the right-hand side of the assignment.
971The null list contains no elements, so when the password file is
972exhausted, the result is 0, not 2.
973
974Slices in scalar context return the last item of the slice.
975
976 @a = qw/first second third/;
977 %h = (first => 'A', second => 'B');
978 $t = @a[0, 1]; # $t is now 'second'
979 $u = @h{'first', 'second'}; # $u is now 'B'
980
981If you're confused about why you use an '@' there on a hash slice
982instead of a '%', think of it like this. The type of bracket (square
983or curly) governs whether it's an array or a hash being looked at.
984On the other hand, the leading symbol ('$' or '@') on the array or
985hash indicates whether you are getting back a singular value (a
986scalar) or a plural one (a list).
987
988=head3 Key/Value Hash Slices
989
990Starting in Perl 5.20, a hash slice operation
991with the % symbol is a variant of slice operation
992returning a list of key/value pairs rather than just values:
993
994 %h = (blonk => 2, foo => 3, squink => 5, bar => 8);
995 %subset = %h{'foo', 'bar'}; # key/value hash slice
996 # %subset is now (foo => 3, bar => 8)
997
998However, the result of such a slice cannot be localized, deleted or used
999in assignment. These are otherwise very much consistent with hash slices
1000using the @ symbol.
1001
1002=head3 Index/Value Array Slices
1003
1004Similar to key/value hash slices (and also introduced
1005in Perl 5.20), the % array slice syntax returns a list
1006of index/value pairs:
1007
1008 @a = "a".."z";
1009 @list = %a[3,4,6];
1010 # @list is now (3, "d", 4, "e", 6, "g")
1011
1012=head2 Typeglobs and Filehandles
1013X<typeglob> X<filehandle> X<*>
1014
1015Perl uses an internal type called a I<typeglob> to hold an entire
1016symbol table entry. The type prefix of a typeglob is a C<*>, because
1017it represents all types. This used to be the preferred way to
1018pass arrays and hashes by reference into a function, but now that
1019we have real references, this is seldom needed.
1020
1021The main use of typeglobs in modern Perl is create symbol table aliases.
1022This assignment:
1023
1024 *this = *that;
1025
1026makes $this an alias for $that, @this an alias for @that, %this an alias
1027for %that, &this an alias for &that, etc. Much safer is to use a reference.
1028This:
1029
1030 local *Here::blue = \$There::green;
1031
1032temporarily makes $Here::blue an alias for $There::green, but doesn't
1033make @Here::blue an alias for @There::green, or %Here::blue an alias for
1034%There::green, etc. See L<perlmod/"Symbol Tables"> for more examples
1035of this. Strange though this may seem, this is the basis for the whole
1036module import/export system.
1037
1038Another use for typeglobs is to pass filehandles into a function or
1039to create new filehandles. If you need to use a typeglob to save away
1040a filehandle, do it this way:
1041
1042 $fh = *STDOUT;
1043
1044or perhaps as a real reference, like this:
1045
1046 $fh = \*STDOUT;
1047
1048See L<perlsub> for examples of using these as indirect filehandles
1049in functions.
1050
1051Typeglobs are also a way to create a local filehandle using the local()
1052operator. These last until their block is exited, but may be passed back.
1053For example:
1054
1055 sub newopen {
1056 my $path = shift;
1057 local *FH; # not my!
1058 open (FH, $path) or return undef;
1059 return *FH;
1060 }
1061 $fh = newopen('/etc/passwd');
1062
1063Now that we have the C<*foo{THING}> notation, typeglobs aren't used as much
1064for filehandle manipulations, although they're still needed to pass brand
1065new file and directory handles into or out of functions. That's because
1066C<*HANDLE{IO}> only works if HANDLE has already been used as a handle.
1067In other words, C<*FH> must be used to create new symbol table entries;
1068C<*foo{THING}> cannot. When in doubt, use C<*FH>.
1069
1070All functions that are capable of creating filehandles (open(),
1071opendir(), pipe(), socketpair(), sysopen(), socket(), and accept())
1072automatically create an anonymous filehandle if the handle passed to
1073them is an uninitialized scalar variable. This allows the constructs
1074such as C<open(my $fh, ...)> and C<open(local $fh,...)> to be used to
1075create filehandles that will conveniently be closed automatically when
1076the scope ends, provided there are no other references to them. This
1077largely eliminates the need for typeglobs when opening filehandles
1078that must be passed around, as in the following example:
1079
1080 sub myopen {
1081 open my $fh, "@_"
1082 or die "Can't open '@_': $!";
1083 return $fh;
1084 }
1085
1086 {
1087 my $f = myopen("</etc/motd");
1088 print <$f>;
1089 # $f implicitly closed here
1090 }
1091
1092Note that if an initialized scalar variable is used instead the
1093result is different: C<my $fh='zzz'; open($fh, ...)> is equivalent
1094to C<open( *{'zzz'}, ...)>.
1095C<use strict 'refs'> forbids such practice.
1096
1097Another way to create anonymous filehandles is with the Symbol
1098module or with the IO::Handle module and its ilk. These modules
1099have the advantage of not hiding different types of the same name
1100during the local(). See the bottom of L<perlfunc/open> for an
1101example.
1102
1103=head1 SEE ALSO
1104
1105See L<perlvar> for a description of Perl's built-in variables and
1106a discussion of legal variable names. See L<perlref>, L<perlsub>,
1107and L<perlmod/"Symbol Tables"> for more discussion on typeglobs and
1108the C<*foo{THING}> syntax.