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 | |
8 | ||
9 | Perl has three data structures: scalars, arrays of scalars, and | |
10 | associative arrays of scalars, known as "hashes". Normal arrays are | |
11 | indexed by number, starting with 0. (Negative subscripts count from | |
12 | the end.) Hash arrays are indexed by string. | |
13 | ||
b88cefa9 | 14 | Values are usually referred to by name (or through a named reference). |
15 | The first character of the name tells you to what sort of data | |
16 | structure it refers. The rest of the name tells you the particular | |
17 | value to which it refers. Most often, it consists of a single | |
18 | I<identifier>, that is, a string beginning with a letter or underscore, | |
19 | and containing letters, underscores, and digits. In some cases, it | |
20 | may be a chain of identifiers, separated by C<::> (or by C<'>, but | |
21 | that's deprecated); all but the last are interpreted as names of | |
5f05dabc | 22 | packages, to locate the namespace in which to look |
b88cefa9 | 23 | up the final identifier (see L<perlmod/Packages> for details). |
184e9718 | 24 | It's possible to substitute for a simple identifier an expression |
5a964f20 | 25 | that produces a reference to the value at runtime; this is |
b88cefa9 | 26 | described in more detail below, and in L<perlref>. |
27 | ||
28 | There are also special variables whose names don't follow these | |
29 | rules, so that they don't accidentally collide with one of your | |
5a964f20 | 30 | normal variables. Strings that match parenthesized parts of a |
b88cefa9 | 31 | regular expression are saved under names containing only digits after |
32 | the C<$> (see L<perlop> and L<perlre>). In addition, several special | |
5a964f20 | 33 | variables that provide windows into the inner working of Perl have names |
b88cefa9 | 34 | containing punctuation characters (see L<perlvar>). |
35 | ||
a0d0e21e LW |
36 | Scalar values are always named with '$', even when referring to a scalar |
37 | that is part of an array. It works like the English word "the". Thus | |
38 | we have: | |
39 | ||
40 | $days # the simple scalar value "days" | |
41 | $days[28] # the 29th element of array @days | |
42 | $days{'Feb'} # the 'Feb' value from hash %days | |
43 | $#days # the last index of array @days | |
44 | ||
45 | but entire arrays or array slices are denoted by '@', which works much like | |
46 | the word "these" or "those": | |
47 | ||
48 | @days # ($days[0], $days[1],... $days[n]) | |
49 | @days[3,4,5] # same as @days[3..5] | |
50 | @days{'a','c'} # same as ($days{'a'},$days{'c'}) | |
51 | ||
52 | and entire hashes are denoted by '%': | |
53 | ||
54 | %days # (key1, val1, key2, val2 ...) | |
55 | ||
56 | In addition, subroutines are named with an initial '&', though this is | |
57 | optional when it's otherwise unambiguous (just as "do" is often | |
58 | redundant in English). Symbol table entries can be named with an | |
59 | initial '*', but you don't really care about that yet. | |
60 | ||
61 | Every variable type has its own namespace. You can, without fear of | |
62 | conflict, use the same name for a scalar variable, an array, or a hash | |
63 | (or, for that matter, a filehandle, a subroutine name, or a label). | |
64 | This means that $foo and @foo are two different variables. It also | |
748a9306 | 65 | means that C<$foo[1]> is a part of @foo, not a part of $foo. This may |
a0d0e21e LW |
66 | seem a bit weird, but that's okay, because it is weird. |
67 | ||
5f05dabc | 68 | Because variable and array references always start with '$', '@', or '%', |
a0d0e21e LW |
69 | the "reserved" words aren't in fact reserved with respect to variable |
70 | names. (They ARE reserved with respect to labels and filehandles, | |
71 | however, which don't have an initial special character. You can't have | |
72 | a filehandle named "log", for instance. Hint: you could say | |
73 | C<open(LOG,'logfile')> rather than C<open(log,'logfile')>. Using uppercase | |
74 | filehandles also improves readability and protects you from conflict | |
5f05dabc | 75 | with future reserved words.) Case I<IS> significant--"FOO", "Foo", and |
a0d0e21e LW |
76 | "foo" are all different names. Names that start with a letter or |
77 | underscore may also contain digits and underscores. | |
78 | ||
79 | It is possible to replace such an alphanumeric name with an expression | |
80 | that returns a reference to an object of that type. For a description | |
81 | of this, see L<perlref>. | |
82 | ||
5f05dabc | 83 | Names that start with a digit may contain only more digits. Names |
5a964f20 | 84 | that do not start with a letter, underscore, or digit are limited to |
5f05dabc | 85 | one character, e.g., C<$%> or C<$$>. (Most of these one character names |
cb1a09d0 | 86 | have a predefined significance to Perl. For instance, C<$$> is the |
a0d0e21e LW |
87 | current process id.) |
88 | ||
89 | =head2 Context | |
90 | ||
91 | The interpretation of operations and values in Perl sometimes depends | |
92 | on the requirements of the context around the operation or value. | |
93 | There are two major contexts: scalar and list. Certain operations | |
94 | return list values in contexts wanting a list, and scalar values | |
95 | otherwise. (If this is true of an operation it will be mentioned in | |
96 | the documentation for that operation.) In other words, Perl overloads | |
97 | certain operations based on whether the expected return value is | |
98 | singular or plural. (Some words in English work this way, like "fish" | |
99 | and "sheep".) | |
100 | ||
101 | In a reciprocal fashion, an operation provides either a scalar or a | |
102 | list context to each of its arguments. For example, if you say | |
103 | ||
104 | int( <STDIN> ) | |
105 | ||
184e9718 | 106 | the integer operation provides a scalar context for the E<lt>STDINE<gt> |
a0d0e21e LW |
107 | operator, which responds by reading one line from STDIN and passing it |
108 | back to the integer operation, which will then find the integer value | |
109 | of that line and return that. If, on the other hand, you say | |
110 | ||
111 | sort( <STDIN> ) | |
112 | ||
184e9718 | 113 | then the sort operation provides a list context for E<lt>STDINE<gt>, which |
a0d0e21e LW |
114 | will proceed to read every line available up to the end of file, and |
115 | pass that list of lines back to the sort routine, which will then | |
116 | sort those lines and return them as a list to whatever the context | |
117 | of the sort was. | |
118 | ||
119 | Assignment is a little bit special in that it uses its left argument to | |
120 | determine the context for the right argument. Assignment to a scalar | |
121 | evaluates the righthand side in a scalar context, while assignment to | |
122 | an array or array slice evaluates the righthand side in a list | |
123 | context. Assignment to a list also evaluates the righthand side in a | |
124 | list context. | |
125 | ||
126 | User defined subroutines may choose to care whether they are being | |
127 | called in a scalar or list context, but most subroutines do not | |
128 | need to care, because scalars are automatically interpolated into | |
129 | lists. See L<perlfunc/wantarray>. | |
130 | ||
131 | =head2 Scalar values | |
132 | ||
4633a7c4 | 133 | All data in Perl is a scalar or an array of scalars or a hash of scalars. |
a0d0e21e | 134 | Scalar variables may contain various kinds of singular data, such as |
4633a7c4 LW |
135 | numbers, strings, and references. In general, conversion from one form to |
136 | another is transparent. (A scalar may not contain multiple values, but | |
137 | may contain a reference to an array or hash containing multiple values.) | |
5f05dabc | 138 | Because of the automatic conversion of scalars, operations, and functions |
4633a7c4 LW |
139 | that return scalars don't need to care (and, in fact, can't care) whether |
140 | the context is looking for a string or a number. | |
141 | ||
142 | Scalars aren't necessarily one thing or another. There's no place to | |
143 | declare a scalar variable to be of type "string", or of type "number", or | |
144 | type "filehandle", or anything else. Perl is a contextually polymorphic | |
145 | language whose scalars can be strings, numbers, or references (which | |
d28ebecd | 146 | includes objects). While strings and numbers are considered pretty |
b88cefa9 | 147 | much the same thing for nearly all purposes, references are strongly-typed |
54310121 | 148 | uncastable pointers with builtin reference-counting and destructor |
4633a7c4 | 149 | invocation. |
a0d0e21e LW |
150 | |
151 | A scalar value is interpreted as TRUE in the Boolean sense if it is not | |
152 | the null string or the number 0 (or its string equivalent, "0"). The | |
54310121 | 153 | Boolean context is just a special kind of scalar context. |
a0d0e21e LW |
154 | |
155 | There are actually two varieties of null scalars: defined and | |
156 | undefined. Undefined null scalars are returned when there is no real | |
157 | value for something, such as when there was an error, or at end of | |
158 | file, or when you refer to an uninitialized variable or element of an | |
159 | array. An undefined null scalar may become defined the first time you | |
160 | use it as if it were defined, but prior to that you can use the | |
161 | defined() operator to determine whether the value is defined or not. | |
162 | ||
54310121 | 163 | To find out whether a given string is a valid nonzero number, it's usually |
4633a7c4 LW |
164 | enough to test it against both numeric 0 and also lexical "0" (although |
165 | this will cause B<-w> noises). That's because strings that aren't | |
184e9718 | 166 | numbers count as 0, just as they do in B<awk>: |
4633a7c4 LW |
167 | |
168 | if ($str == 0 && $str ne "0") { | |
169 | warn "That doesn't look like a number"; | |
54310121 | 170 | } |
4633a7c4 | 171 | |
cb1a09d0 AD |
172 | That's usually preferable because otherwise you won't treat IEEE notations |
173 | like C<NaN> or C<Infinity> properly. At other times you might prefer to | |
5a964f20 TC |
174 | use the POSIX::strtod function or a regular expression to check whether |
175 | data is numeric. See L<perlre> for details on regular expressions. | |
cb1a09d0 AD |
176 | |
177 | warn "has nondigits" if /\D/; | |
5a964f20 TC |
178 | warn "not a natural number" unless /^\d+$/; # rejects -3 |
179 | warn "not an integer" unless /^-?\d+$/; # rejects +3 | |
180 | warn "not an integer" unless /^[+-]?\d+$/; | |
181 | warn "not a decimal number" unless /^-?\d+\.?\d*$/; # rejects .2 | |
182 | warn "not a decimal number" unless /^-?(?:\d+(?:\.\d*)?|\.\d+)$/; | |
54310121 | 183 | warn "not a C float" |
cb1a09d0 AD |
184 | unless /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/; |
185 | ||
a0d0e21e LW |
186 | The length of an array is a scalar value. You may find the length of |
187 | array @days by evaluating C<$#days>, as in B<csh>. (Actually, it's not | |
5f05dabc | 188 | the length of the array, it's the subscript of the last element, because |
a0d0e21e LW |
189 | there is (ordinarily) a 0th element.) Assigning to C<$#days> changes the |
190 | length of the array. Shortening an array by this method destroys | |
191 | intervening values. Lengthening an array that was previously shortened | |
192 | I<NO LONGER> recovers the values that were in those elements. (It used to | |
b88cefa9 | 193 | in Perl 4, but we had to break this to make sure destructors were |
5a964f20 | 194 | called when expected.) You can also gain some miniscule measure of efficiency by |
4a6725af | 195 | pre-extending an array that is going to get big. (You can also extend |
a0d0e21e LW |
196 | an array by assigning to an element that is off the end of the array.) |
197 | You can truncate an array down to nothing by assigning the null list () | |
198 | to it. The following are equivalent: | |
199 | ||
200 | @whatever = (); | |
3e3baf6d | 201 | $#whatever = -1; |
a0d0e21e LW |
202 | |
203 | If you evaluate a named array in a scalar context, it returns the length of | |
204 | the array. (Note that this is not true of lists, which return the | |
5a964f20 TC |
205 | last value, like the C comma operator, nor of built-in functions, which return |
206 | whatever they feel like returning.) The following is always true: | |
a0d0e21e LW |
207 | |
208 | scalar(@whatever) == $#whatever - $[ + 1; | |
209 | ||
184e9718 | 210 | Version 5 of Perl changed the semantics of C<$[>: files that don't set |
211 | the value of C<$[> no longer need to worry about whether another | |
212 | file changed its value. (In other words, use of C<$[> is deprecated.) | |
5f05dabc | 213 | So in general you can assume that |
a0d0e21e LW |
214 | |
215 | scalar(@whatever) == $#whatever + 1; | |
216 | ||
d28ebecd | 217 | Some programmers choose to use an explicit conversion so nothing's |
4633a7c4 LW |
218 | left to doubt: |
219 | ||
220 | $element_count = scalar(@whatever); | |
221 | ||
5a964f20 | 222 | If you evaluate a hash in a scalar context, it returns a value that is |
a0d0e21e LW |
223 | true if and only if the hash contains any key/value pairs. (If there |
224 | are any key/value pairs, the value returned is a string consisting of | |
225 | the number of used buckets and the number of allocated buckets, separated | |
5f05dabc | 226 | by a slash. This is pretty much useful only to find out whether Perl's |
a0d0e21e LW |
227 | (compiled in) hashing algorithm is performing poorly on your data set. |
228 | For example, you stick 10,000 things in a hash, but evaluating %HASH in | |
229 | scalar context reveals "1/16", which means only one out of sixteen buckets | |
230 | has been touched, and presumably contains all 10,000 of your items. This | |
231 | isn't supposed to happen.) | |
232 | ||
5a964f20 TC |
233 | You can preallocate space for a hash by assigning to the keys() function. |
234 | This rounds up the allocated bucked to the next power of two: | |
235 | ||
236 | keys(%users) = 1000; # allocate 1024 buckets | |
237 | ||
a0d0e21e LW |
238 | =head2 Scalar value constructors |
239 | ||
240 | Numeric literals are specified in any of the customary floating point or | |
241 | integer formats: | |
242 | ||
a0d0e21e LW |
243 | 12345 |
244 | 12345.67 | |
245 | .23E-10 | |
246 | 0xffff # hex | |
247 | 0377 # octal | |
4f19785b | 248 | 0b111000 # binary |
a0d0e21e LW |
249 | 4_294_967_296 # underline for legibility |
250 | ||
55497cff | 251 | String literals are usually delimited by either single or double |
252 | quotes. They work much like shell quotes: double-quoted string | |
253 | literals are subject to backslash and variable substitution; | |
254 | single-quoted strings are not (except for "C<\'>" and "C<\\>"). | |
255 | The usual Unix backslash rules apply for making characters such as | |
256 | newline, tab, etc., as well as some more exotic forms. See | |
b687b08b | 257 | L<perlop/"Quote and Quotelike Operators"> for a list. |
a0d0e21e | 258 | |
68dc0745 | 259 | Octal or hex representations in string literals (e.g. '0xffff') are not |
260 | automatically converted to their integer representation. The hex() and | |
261 | oct() functions make these conversions for you. See L<perlfunc/hex> and | |
262 | L<perlfunc/oct> for more details. | |
263 | ||
5f05dabc | 264 | You can also embed newlines directly in your strings, i.e., they can end |
a0d0e21e LW |
265 | on a different line than they begin. This is nice, but if you forget |
266 | your trailing quote, the error will not be reported until Perl finds | |
267 | another line containing the quote character, which may be much further | |
268 | on in the script. Variable substitution inside strings is limited to | |
269 | scalar variables, arrays, and array slices. (In other words, | |
b88cefa9 | 270 | names beginning with $ or @, followed by an optional bracketed |
a0d0e21e | 271 | expression as a subscript.) The following code segment prints out "The |
184e9718 | 272 | price is $Z<>100." |
a0d0e21e LW |
273 | |
274 | $Price = '$100'; # not interpreted | |
275 | print "The price is $Price.\n"; # interpreted | |
276 | ||
b88cefa9 | 277 | As in some shells, you can put curly brackets around the name to |
748a9306 LW |
278 | delimit it from following alphanumerics. In fact, an identifier |
279 | within such curlies is forced to be a string, as is any single | |
280 | identifier within a hash subscript. Our earlier example, | |
281 | ||
282 | $days{'Feb'} | |
283 | ||
284 | can be written as | |
285 | ||
286 | $days{Feb} | |
287 | ||
288 | and the quotes will be assumed automatically. But anything more complicated | |
289 | in the subscript will be interpreted as an expression. | |
290 | ||
291 | Note that a | |
a0d0e21e | 292 | single-quoted string must be separated from a preceding word by a |
5f05dabc | 293 | space, because single quote is a valid (though deprecated) character in |
b88cefa9 | 294 | a variable name (see L<perlmod/Packages>). |
a0d0e21e | 295 | |
68dc0745 | 296 | Three special literals are __FILE__, __LINE__, and __PACKAGE__, which |
297 | represent the current filename, line number, and package name at that | |
298 | point in your program. They may be used only as separate tokens; they | |
299 | will not be interpolated into strings. If there is no current package | |
5a964f20 | 300 | (due to an empty C<package;> directive), __PACKAGE__ is the undefined value. |
68dc0745 | 301 | |
302 | The tokens __END__ and __DATA__ may be used to indicate the logical end | |
303 | of the script before the actual end of file. Any following text is | |
304 | ignored, but may be read via a DATA filehandle: main::DATA for __END__, | |
305 | or PACKNAME::DATA (where PACKNAME is the current package) for __DATA__. | |
306 | The two control characters ^D and ^Z are synonyms for __END__ (or | |
307 | __DATA__ in a module). See L<SelfLoader> for more description of | |
a00c1fe5 CS |
308 | __DATA__, and an example of its use. Note that you cannot read from the |
309 | DATA filehandle in a BEGIN block: the BEGIN block is executed as soon as | |
310 | it is seen (during compilation), at which point the corresponding | |
311 | __DATA__ (or __END__) token has not yet been seen. | |
a0d0e21e | 312 | |
748a9306 | 313 | A word that has no other interpretation in the grammar will |
a0d0e21e LW |
314 | be treated as if it were a quoted string. These are known as |
315 | "barewords". As with filehandles and labels, a bareword that consists | |
316 | entirely of lowercase letters risks conflict with future reserved | |
317 | words, and if you use the B<-w> switch, Perl will warn you about any | |
318 | such words. Some people may wish to outlaw barewords entirely. If you | |
319 | say | |
320 | ||
321 | use strict 'subs'; | |
322 | ||
323 | then any bareword that would NOT be interpreted as a subroutine call | |
324 | produces a compile-time error instead. The restriction lasts to the | |
54310121 | 325 | end of the enclosing block. An inner block may countermand this |
a0d0e21e LW |
326 | by saying C<no strict 'subs'>. |
327 | ||
328 | Array variables are interpolated into double-quoted strings by joining all | |
329 | the elements of the array with the delimiter specified in the C<$"> | |
184e9718 | 330 | variable (C<$LIST_SEPARATOR> in English), space by default. The following |
4633a7c4 | 331 | are equivalent: |
a0d0e21e LW |
332 | |
333 | $temp = join($",@ARGV); | |
334 | system "echo $temp"; | |
335 | ||
336 | system "echo @ARGV"; | |
337 | ||
338 | Within search patterns (which also undergo double-quotish substitution) | |
339 | there is a bad ambiguity: Is C</$foo[bar]/> to be interpreted as | |
340 | C</${foo}[bar]/> (where C<[bar]> is a character class for the regular | |
341 | expression) or as C</${foo[bar]}/> (where C<[bar]> is the subscript to array | |
342 | @foo)? If @foo doesn't otherwise exist, then it's obviously a | |
343 | character class. If @foo exists, Perl takes a good guess about C<[bar]>, | |
344 | and is almost always right. If it does guess wrong, or if you're just | |
345 | plain paranoid, you can force the correct interpretation with curly | |
346 | brackets as above. | |
347 | ||
55497cff | 348 | A line-oriented form of quoting is based on the shell "here-doc" |
349 | syntax. Following a C<E<lt>E<lt>> you specify a string to terminate | |
350 | the quoted material, and all lines following the current line down to | |
351 | the terminating string are the value of the item. The terminating | |
352 | string may be either an identifier (a word), or some quoted text. If | |
353 | quoted, the type of quotes you use determines the treatment of the | |
354 | text, just as in regular quoting. An unquoted identifier works like | |
355 | double quotes. There must be no space between the C<E<lt>E<lt>> and | |
356 | the identifier. (If you put a space it will be treated as a null | |
3fe9a6f1 | 357 | identifier, which is valid, and matches the first empty line.) The |
55497cff | 358 | terminating string must appear by itself (unquoted and with no |
359 | surrounding whitespace) on the terminating line. | |
a0d0e21e | 360 | |
54310121 | 361 | print <<EOF; |
a0d0e21e LW |
362 | The price is $Price. |
363 | EOF | |
364 | ||
365 | print <<"EOF"; # same as above | |
366 | The price is $Price. | |
367 | EOF | |
368 | ||
a0d0e21e LW |
369 | print <<`EOC`; # execute commands |
370 | echo hi there | |
371 | echo lo there | |
372 | EOC | |
373 | ||
374 | print <<"foo", <<"bar"; # you can stack them | |
375 | I said foo. | |
376 | foo | |
377 | I said bar. | |
378 | bar | |
379 | ||
d28ebecd | 380 | myfunc(<<"THIS", 23, <<'THAT'); |
a0d0e21e LW |
381 | Here's a line |
382 | or two. | |
383 | THIS | |
54310121 | 384 | and here's another. |
a0d0e21e LW |
385 | THAT |
386 | ||
54310121 | 387 | Just don't forget that you have to put a semicolon on the end |
388 | to finish the statement, as Perl doesn't know you're not going to | |
a0d0e21e LW |
389 | try to do this: |
390 | ||
391 | print <<ABC | |
392 | 179231 | |
393 | ABC | |
394 | + 20; | |
395 | ||
396 | ||
397 | =head2 List value constructors | |
398 | ||
399 | List values are denoted by separating individual values by commas | |
400 | (and enclosing the list in parentheses where precedence requires it): | |
401 | ||
402 | (LIST) | |
403 | ||
748a9306 | 404 | In a context not requiring a list value, the value of the list |
a0d0e21e LW |
405 | literal is the value of the final element, as with the C comma operator. |
406 | For example, | |
407 | ||
408 | @foo = ('cc', '-E', $bar); | |
409 | ||
410 | assigns the entire list value to array foo, but | |
411 | ||
412 | $foo = ('cc', '-E', $bar); | |
413 | ||
414 | assigns the value of variable bar to variable foo. Note that the value | |
415 | of an actual array in a scalar context is the length of the array; the | |
54310121 | 416 | following assigns the value 3 to $foo: |
a0d0e21e LW |
417 | |
418 | @foo = ('cc', '-E', $bar); | |
419 | $foo = @foo; # $foo gets 3 | |
420 | ||
54310121 | 421 | You may have an optional comma before the closing parenthesis of a |
a0d0e21e LW |
422 | list literal, so that you can say: |
423 | ||
424 | @foo = ( | |
425 | 1, | |
426 | 2, | |
427 | 3, | |
428 | ); | |
429 | ||
430 | LISTs do automatic interpolation of sublists. That is, when a LIST is | |
431 | evaluated, each element of the list is evaluated in a list context, and | |
432 | the resulting list value is interpolated into LIST just as if each | |
5a964f20 | 433 | individual element were a member of LIST. Thus arrays and hashes lose their |
a0d0e21e LW |
434 | identity in a LIST--the list |
435 | ||
5a964f20 | 436 | (@foo,@bar,&SomeSub,%glarch) |
a0d0e21e LW |
437 | |
438 | contains all the elements of @foo followed by all the elements of @bar, | |
5a964f20 TC |
439 | followed by all the elements returned by the subroutine named SomeSub |
440 | called in a list context, followed by the key/value pairs of %glarch. | |
a0d0e21e LW |
441 | To make a list reference that does I<NOT> interpolate, see L<perlref>. |
442 | ||
443 | The null list is represented by (). Interpolating it in a list | |
444 | has no effect. Thus ((),(),()) is equivalent to (). Similarly, | |
445 | interpolating an array with no elements is the same as if no | |
446 | array had been interpolated at that point. | |
447 | ||
448 | A list value may also be subscripted like a normal array. You must | |
54310121 | 449 | put the list in parentheses to avoid ambiguity. For example: |
a0d0e21e LW |
450 | |
451 | # Stat returns list value. | |
452 | $time = (stat($file))[8]; | |
453 | ||
4633a7c4 | 454 | # SYNTAX ERROR HERE. |
5f05dabc | 455 | $time = stat($file)[8]; # OOPS, FORGOT PARENTHESES |
4633a7c4 | 456 | |
a0d0e21e LW |
457 | # Find a hex digit. |
458 | $hexdigit = ('a','b','c','d','e','f')[$digit-10]; | |
459 | ||
460 | # A "reverse comma operator". | |
461 | return (pop(@foo),pop(@foo))[0]; | |
462 | ||
68dc0745 | 463 | You may assign to C<undef> in a list. This is useful for throwing |
464 | away some of the return values of a function: | |
465 | ||
466 | ($dev, $ino, undef, undef, $uid, $gid) = stat($file); | |
467 | ||
a0d0e21e LW |
468 | Lists may be assigned to if and only if each element of the list |
469 | is legal to assign to: | |
470 | ||
471 | ($a, $b, $c) = (1, 2, 3); | |
472 | ||
473 | ($map{'red'}, $map{'blue'}, $map{'green'}) = (0x00f, 0x0f0, 0xf00); | |
474 | ||
feedc0d7 | 475 | List assignment in a scalar context returns the number of elements |
4633a7c4 LW |
476 | produced by the expression on the right side of the assignment: |
477 | ||
478 | $x = (($foo,$bar) = (3,2,1)); # set $x to 3, not 2 | |
479 | $x = (($foo,$bar) = f()); # set $x to f()'s return count | |
480 | ||
481 | This is very handy when you want to do a list assignment in a Boolean | |
5f05dabc | 482 | context, because most list functions return a null list when finished, |
4633a7c4 LW |
483 | which when assigned produces a 0, which is interpreted as FALSE. |
484 | ||
a0d0e21e LW |
485 | The final element may be an array or a hash: |
486 | ||
487 | ($a, $b, @rest) = split; | |
5a964f20 | 488 | my($a, $b, %rest) = @_; |
a0d0e21e | 489 | |
4633a7c4 | 490 | You can actually put an array or hash anywhere in the list, but the first one |
a0d0e21e LW |
491 | in the list will soak up all the values, and anything after it will get |
492 | a null value. This may be useful in a local() or my(). | |
493 | ||
494 | A hash literal contains pairs of values to be interpreted | |
495 | as a key and a value: | |
496 | ||
497 | # same as map assignment above | |
498 | %map = ('red',0x00f,'blue',0x0f0,'green',0xf00); | |
499 | ||
4633a7c4 LW |
500 | While literal lists and named arrays are usually interchangeable, that's |
501 | not the case for hashes. Just because you can subscript a list value like | |
502 | a normal array does not mean that you can subscript a list value as a | |
503 | hash. Likewise, hashes included as parts of other lists (including | |
504 | parameters lists and return lists from functions) always flatten out into | |
505 | key/value pairs. That's why it's good to use references sometimes. | |
a0d0e21e | 506 | |
4633a7c4 LW |
507 | It is often more readable to use the C<=E<gt>> operator between key/value |
508 | pairs. The C<=E<gt>> operator is mostly just a more visually distinctive | |
b88cefa9 | 509 | synonym for a comma, but it also arranges for its left-hand operand to be |
5a964f20 | 510 | interpreted as a string--if it's a bareword that would be a legal identifier. |
b88cefa9 | 511 | This makes it nice for initializing hashes: |
a0d0e21e | 512 | |
4633a7c4 LW |
513 | %map = ( |
514 | red => 0x00f, | |
515 | blue => 0x0f0, | |
516 | green => 0xf00, | |
517 | ); | |
518 | ||
519 | or for initializing hash references to be used as records: | |
520 | ||
521 | $rec = { | |
522 | witch => 'Mable the Merciless', | |
523 | cat => 'Fluffy the Ferocious', | |
524 | date => '10/31/1776', | |
525 | }; | |
526 | ||
527 | or for using call-by-named-parameter to complicated functions: | |
528 | ||
54310121 | 529 | $field = $query->radio_group( |
4633a7c4 LW |
530 | name => 'group_name', |
531 | values => ['eenie','meenie','minie'], | |
532 | default => 'meenie', | |
533 | linebreak => 'true', | |
534 | labels => \%labels | |
535 | ); | |
cb1a09d0 AD |
536 | |
537 | Note that just because a hash is initialized in that order doesn't | |
538 | mean that it comes out in that order. See L<perlfunc/sort> for examples | |
539 | of how to arrange for an output ordering. | |
540 | ||
5f05dabc | 541 | =head2 Typeglobs and Filehandles |
cb1a09d0 AD |
542 | |
543 | Perl uses an internal type called a I<typeglob> to hold an entire | |
544 | symbol table entry. The type prefix of a typeglob is a C<*>, because | |
54310121 | 545 | it represents all types. This used to be the preferred way to |
cb1a09d0 | 546 | pass arrays and hashes by reference into a function, but now that |
5a964f20 TC |
547 | we have real references, this is seldom needed. |
548 | ||
549 | The main use of typeglobs in modern Perl is create symbol table aliases. | |
550 | This assignment: | |
551 | ||
552 | *this = *that; | |
553 | ||
554 | makes $this an alias for $that, @this an alias for @that, %this an alias | |
555 | for %that, &this an alias for &that, etc. Much safer is to use a reference. | |
556 | This: | |
5f05dabc | 557 | |
5a964f20 TC |
558 | local *Here::blue = \$There::green; |
559 | ||
560 | temporarily makes $Here::blue an alias for $There::green, but doesn't | |
561 | make @Here::blue an alias for @There::green, or %Here::blue an alias for | |
562 | %There::green, etc. See L<perlmod/"Symbol Tables"> for more examples | |
563 | of this. Strange though this may seem, this is the basis for the whole | |
564 | module import/export system. | |
565 | ||
566 | Another use for typeglobs is to to pass filehandles into a function or | |
567 | to create new filehandles. If you need to use a typeglob to save away | |
568 | a filehandle, do it this way: | |
5f05dabc | 569 | |
570 | $fh = *STDOUT; | |
571 | ||
572 | or perhaps as a real reference, like this: | |
573 | ||
574 | $fh = \*STDOUT; | |
575 | ||
5a964f20 TC |
576 | See L<perlsub> for examples of using these as indirect filehandles |
577 | in functions. | |
578 | ||
579 | Typeglobs are also a way to create a local filehandle using the local() | |
580 | operator. These last until their block is exited, but may be passed back. | |
581 | For example: | |
5f05dabc | 582 | |
583 | sub newopen { | |
584 | my $path = shift; | |
585 | local *FH; # not my! | |
5a964f20 | 586 | open (FH, $path) or return undef; |
e05a3a1e | 587 | return *FH; |
5f05dabc | 588 | } |
589 | $fh = newopen('/etc/passwd'); | |
590 | ||
5a964f20 TC |
591 | Now that we have the *foo{THING} notation, typeglobs aren't used as much |
592 | for filehandle manipulations, although they're still needed to pass brand | |
593 | new file and directory handles into or out of functions. That's because | |
594 | *HANDLE{IO} only works if HANDLE has already been used as a handle. | |
595 | In other words, *FH can be used to create new symbol table entries, | |
596 | but *foo{THING} cannot. | |
597 | ||
598 | Another way to create anonymous filehandles is with the IO::Handle | |
599 | module and its ilk. These modules have the advantage of not hiding | |
600 | different types of the same name during the local(). See the bottom of | |
601 | L<perlfunc/open()> for an example. | |
cb1a09d0 | 602 | |
55497cff | 603 | See L<perlref>, L<perlsub>, and L<perlmod/"Symbol Tables"> for more |
5a964f20 | 604 | discussion on typeglobs and the *foo{THING} syntax. |