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